Whistl

Whistl offers domestic and international shipping services for shipments originating in the UK, Jersey, and Georgia.

This guide provides developers with the details needed to build Whistl shipping capabilities into your ShipEngine workflows.

Requirements

Property	Type	Required?	Description
`nickname`	string	required	This is a nickname for you to identify the carrier account in ShipEngine.
`password`	string	required	Your Whistl account password
`account`	string	required	Your Whistl account number
`department`	string	required	Your Whistle account department number
`tracking_api_key`	string	required	Your Whistle account tracking API key

Connect Account

You can connect a Whistl account using the POST method to the /v1/connections/carriers/ endpoint, or via the ShipEngine Dashboard.

For instructions on connecting Whistl via the ShipEngine dashboard, go to our Whistl help article.

Connect via Endpoint

carrier_name: whistl

POST /v1/connections/carriers/:carrier_name

Sample request:

1
2
3
4
5
6
7
8
9
10
11
12
POST /v1/connections/carriers/whistl HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__
Content-Type: application/json
{
  "nickname": "My Whistl Account nickname",
  "password": "pa55word",
  "account: "1234567",
  "department": "89101112",
  "training_api_key": "your_training_api_key"
}

A successful connection will return a response with the carrier_id, which you'll use for any requests for this account going forward.

Rates

Whistl does not send rates to ShipEngine. Contact your Whistl account manager for details about your contracted rates.

Service Details

Available Whistl services are provided below. Please note that carriers may update their available services at any time. To ensure you are always using valid services, you can use the list carrier services endpoint at any time.

Domestic Services

Service	API Code
Insight Large Letter	`whistl_insight_large_letter_domestic`
Insight Packet	`whistl_insight_packet_domestic`

International Services

Service	API Code
Insight Large Letter	`whistl_insight_large_letter_international`
Insight Packet	`whistl_insight_packet_international`

Return Services

Whistl does not support creating return labels.

Packages

The following carrier package types are available for Whistl services:

Name	API Code	Package Attributes
Parcel	`whistl_package`	Domestic, International

Adding Shipment Insurance

Whistl supports adding carrier insurance to your shipments. Review the Parcel Insurance page for details on adding shipment insurance with ShipEngine.

Label Support

Label sizes: 4" x 6", 4" x 8"
Label formats: PDF, PNG, ZPL

Label Reference Fields

Whistl does not support adding custom label messages.

Multi-Package Labels

Whistl supports creating multi-package shipments.

Label Branding

Whistl does not support label branding.

Voiding Labels

Whistl does not support voiding labels with ShipEngine.

Paperless Labels

Whistl does not support paperless labels.

Customs Declarations

Customs declarations are printed directly onto the label instead of a separate document to download.

Delivery Confirmation

Confirmation Type	API Code	Description
No confirmation required	`none`	No confirmation required for delivery.

See our Delivery Confirmation page for more details about using the confirmation property.

Advanced Options

Whistl does not currently support any advanced options.

To ensure you always have the most up-to-date information about a carrier's advanced options, use the list carrier options call.

Manifests

Whistle does not require manifesting your shipments.

Scheduling Pickups

Whistl does not support scheduling pickups using ShipEngine.

Service Points (PUDO)

Whistl does not support shipping to service points.

Tracking

ShipEngine's integration with Whistl supports receiving tracking updates. Review our Track a Package guides for details on tracking with the ShipEngine API.

Disconnecting Your Whistl Account

See the Disconnect section in our Delete a Carrier page for the process of deleting or disconnecting a carrier from ShipEngine.