🎉ShipEngine is becoming ShipStation API🎉

Over the next few months you'll notice the ShipEngine website, documentation portal, and dashboard being rebranded as ShipStation API. For our ShipEngine customers, you don't need to take any action or change any of your integrations in any way. All endpoints will remain the same and continue to function as they always have.

To learn more about what's coming, review our [New ShipStation API page](/content/docs/new-shipstation-api/index.html).

# Whistl

[Whistl](https://www.whistl.co.uk/) 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 ShipStation API workflows.

## Requirements

| Property | Type | Required? | Description |
| --- | --- | --- | --- |
| `nickname` | _string_ | **required** | This is a nickname for you to identify the carrier account in ShipStation API. |
| `password` | _string_ | **required** | Your Whistl account password |
| `account` | _string_ | **required** | Your Whistl account number |
| `department` | _string_ | **required** | Your Whistl account department number |
| `tracking_api_key` | _string_ | **required** | Your Whistl 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 ShipStation API Dashboard.

For instructions on connecting Whistl via the ShipStation API dashboard, go to our [Whistl help article](https://help.shipengine.com/hc/en-us/articles/9823967711771).

### Connect via Endpoint

`carrier_name`: `whistl`

**POST /v1/connections/carriers/:carrier_name**

Sample request:

```
POST /v1/connections/carriers/whistl HTTP/1.1

{
  "nickname": "My Whistl Account nickname",
  "password": "pa55word",
  "account": "1234567",
  "department": "89101112",
  "tracking_api_key": "your_tracking_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 ShipStation API. 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](/content/docs/reference/list-carrier-services/index.html) 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](/content/docs/shippig/carrier-packaging/index.html) 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](/content/docs/shipping/insurance/index.html) for details on adding shipment insurance with ShipStation API.

## 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](/content/docs/labels/messages/index.html).

### Multi-Package Labels

Whistl supports creating [multi-package shipments](/content/docs/shipping/multi-package/index.html).

### Label Branding

Whistl does not support [label branding](/content/docs/labels/branding/index.html).

### Voiding Labels

Whistl does not support [voiding labels](/content/docs/labels/voiding/index.html) with ShipStation API.

### Paperless Labels

Whistl does not support [paperless labels](/content/docs/labels/paperless/index.html).

### 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](/content/docs/shipping/delivery-confirmation/index.html) for more details about using the `confirmation` property.

## Advanced Options

Whistl does not currently support any [advanced options](/content/docs/carriers/advanced-options/index.html).

To ensure you always have the most up-to-date information about a carrier's advanced options, use the [list carrier options call](/content/docs/reference/list-carrier-options/index.html).

## Manifests

Whistl does not require [manifesting](/content/docs/shipping/manifests/index.html) your shipments.

## Scheduling Pickups

Whistl does not support [scheduling pickups](/content/docs/shipping/pickups/index.html) using ShipStation API.

## Service Points (PUDO)

Whistl does not support shipping to [service points](/content/docs/pick-up-drop-off/pudo-intro/index.html).

## Tracking

ShipStation API's integration with Whistl supports receiving tracking updates. Review our ​ [Track a Package guides​](/content/docs/tracking/index.html) ​ for details on tracking with the ShipStation API.

## Disconnecting Your Whistl Account

See the Disconnect section in our [Delete a Carrier page](/content/docs/reference/carriers/delete-carrier/index.html) for the process of deleting or disconnecting a carrier from ShipStation API.

> **NOTE:**
>
> If you disconnect a carrier account and reconnect it, the account will have a new `carrier_id` in ShipStation API.