Yodel

Yodel offers domestic and international shipping services for shipments originating in Great Britain.

This guide provides developers with the details needed to build Yodel shipping capabilities into your ShipStation API workflows.

ShipStation API also allows you to connect a Yodel Out of Home account or use the Yodel services included with ShipStation API. The requirements and service details are different than those for a Yodel account. For details about using Yodel from ShipStation, see our Yodel from ShipStation Guide. For details about using Yodel Out of Home services, see our Yodel Out of Home Guide.

Requirements

Shipping Requirements

Connect Account

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

For instructions on connecting Yodel via the ShipStation API dashboard, go to our Yodel help article.

Connect via Endpoint

carrier_name: yodel

POST /v1/connections/carriers/:carrier_name

Sample request:

Copy

HTTPcURLJavaScriptNodeJSPHPPythonRubyC#JavaGoSwiftObjective-CPowerShell

1
2
3
4
5
6
7
8
9
10
11
POST /v1/connections/carriers/yodel HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__
Content-Type: application/json
{
  "nickname": "Test Yodel Account",
  "user_id": "your_user_id_here",
  "account_id": "your_account_id_here",
  "password": "your_password_here"
}

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

Rates

Yodel does not send estimated rates to ShipStation API. Your Yodel account contact can provide you with the details about your contracted rates.

Service Details

Available Yodel 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

Next day, Two-day Services:

Next Day Services:

International Services

Please note: Channel Isles services require additional customs data.

Shipping to Northern Ireland

Yodel will not support the B2B movement type for shipping from Great Britain to Northern Ireland, in accordance with the Windsor Framework. For B2B shipments to NI, you should use a carrier that supports this movement type.

If adding the b2b value to the windsor_framework_details property, you will receive an error. Supported values for Yodel are b2c and c2c only.

For all other shipments to Northern Ireland, Yodel will require the following data to be provided for each product in the shipment (to be included in the packages.products array of objects):

Yodel also recommends providing the harmonized_tariff_code property as well, though this is not required.

Return Services

Return services are not supported for this carrier.

Packages

The following carrier package types are available for Yodel services:

Adding Shipment Insurance

Yodel does not support adding carrier insurance to shipments created with ShipStation API. Contact your Yodel representative for information about Yodel's default loss/damage coverage policies.

Label Support

All Yodal services have a 40-character maximum for the name field and a 30-character maximum for each address_line field (address lines 1-4).

Label Reference Fields

Yodel does not support adding custom label messages.

Multi-Package Labels

Yodel supports creating multi-package shipments with most services.

Label Branding

Yodel does not support label branding.

Voiding Labels

Yodel supports voiding labels with ShipStation API.

Paperless Labels

Yodel does not support creating paperless labels.

Customs Declarations

Customs declarations are required for shipments to the Channel Islands and Northern Ireland. You can download these forms from the forms_download object in the label response.

Delivery Confirmation

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

Advanced Options

Yodel does not currenty 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

Yodel automatically manifests all shipments. There is no need to create them manually through ShipStation API.

Scheduling Pickups

Yodel does not support scheduling pickups using ShipStation API.

Service Points (PUDO)

Yodel supports shipping to service points.

Tracking

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

Disconnecting Your Yodel Account

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