Site Logo

🎉 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.

Yodel from ShipStation

Yodel from ShipStation offers domestic drop-off services to ShipStation API accounts based on the UK.

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

ShipStation API also allows you to connect your own existing Yodel account and Yodel Out of Home account. The requirements and service details are different than those for Yodel from ShipStation. For details about connecting and using your own Yodel account with ShipStation API, see our Yodel Guide and Yodel Out of Home guide.

Requirements

carrier_name: yodel_walleted

  • A ShipStation API account based in the UK.
  • ShipStation Carriers must be activated for the account and have a positive account balance to create labels. See our Using ShipStation Carriers page for details about activating in your account.
  • All shipments must originate from an address in the United Kingdom.
  • Both weight and dimensions are required for all shipments.
  • Recipient email address is required.
  • Parcels cannot exceed the max weight of 10kgs or max length of 120cm

Rates

Yodel from ShipStation supports rate shopping with ShipStation API.

Service Details

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

ServiceAPI Code
Yodel - Print at Homeyodel_direct_service
Yodel - Print at Storeyodel_direct_print_at_store
Yodel Send - Print at Homeyodel_send_print_at_home
Yodel Send - Print at Storeyodel_send_print_at_store

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):

  • description
  • quantity
  • value (this object also requires the value.currency and value.amount properties)

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

Return Services

Yodel from ShipStation does not currently support return services.

Packages

The following carrier package types are available for Yodel from ShipStation services:

NameAPI Code
Parcelyodel_parcel_2

Adding Shipment Insurance

Yodel from ShipStation does not support adding carrier insurance to shipments created with ShipStation API. However, Yodel does include £50.00 loss coverage by default.

If you need to file a claim for a Yodel from ShipStation shipment, please contact our support team for assistance within 14 days of the parcel ship date.

Label Support

  • Label sizes: 4" x 6"
  • Label formats: PDF

Label Reference Fields

Yodel from ShipStation does not support adding custom label messages.

Multi-Package Labels

The Yodel - Print at Home and Yodel - Print at Store services support multi-package shipments.

Label Branding

Yodel from ShipStation does not support label branding.

Voiding Labels

Yodel from ShipStation supports voiding labels with ShipStation API. Voiding must be done before a label is scanned by Yodal.

Paperless Labels

Both Yodel Print at Store services support creating paperless/QR code labels.

See our Paperless Labels page for details about creating paperless labels with ShipStation API.

Delivery Confirmation

Confirmation TypeAPI CodeDescription
NonenoneNo confirmation requested.
Alert emaildeliveryDelivery confirmation requested and will be confirmed via an alert email.

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

Advanced Options

Yodel from ShipStation 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

Yodel from ShipStation does not require manifesting your shipments.

Scheduling Pickups

Yodel from ShipStation does not support scheduling pickups. All services are drop-off services.

Service Points (PUDO)

Yodel from ShipStation supports shipping to service points.

See our Intro to Service Points for more details about how to use service points with ShipStation API.

Tracking

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