Site Logo

Yodel Out of Home Guide

Yodel Out of Home offers domestic shipping services, including Pickup/Dropoff (PUDO) services, for shipments originating in Great Britain.

This guide provides developers an overview of shipping services that Yodel Out of Home offers and the service codes that you will use to create Yodel Out of Home shipments.

Connect Your Account

ShipEngine API allows you to connect your Yodel Out of Home account programmatically without logging in to the ShipEngine API dashboard. This is useful if you have wrapped a custom UI around the ShipEngine API toolset and want to add or disconnect existing carrier accounts without exposing your end users to the API dashboard.

These APIs can be used in parallel with the ShipEngine Partner APIs to programmatically create new ShipEngine users, and then connect existing Yodel Out of Home accounts all via the API without logging into a dashboard. Together these APIs empower you to completely white-label the ShipEngine experience for your end users.

Continue below for instructions on how to programatically connect Yodel Out of Home using the ShipEngine API.

For instructions on connecting Yodel Out of Home via the ShipEngine dashboard, go to our Yodel Out of Home help article.

Yodel Out of Home Account Information Model

PropertyDescriptionType
api_keyAPI Keystring, required
client_passwordClient Passwordstring, required
client_idClient User IDstring, required
client_nameClient Namestring

Example POST Call

POST /v1/connections/carriers/yodel_collect_plus_c2c

1
2
3
4
5
6
7
8
9
10
11
POST /v1/connections/carriers/yodel_collect_plus_c2c HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__
Content-Type: application/json
{
"client_id": "ID1234"
"client_password": "123456789",
"api_key": "abcxyz123456",
"client_name": "Example Corp.",
}

Example POST Response

Your account will now appear in your carriers list with an assigned carrier_id that you will specify when creating Yodel Out of Home shipments.

1
2
3
{
"carrier-id": "se-1234567"
}

Yodel Out of Home Service Details

Yodel Out of Home provides both domestic Pickup/Dropoff (PUDO) services as well as domestic non-PUDO services.

PUDO Services

ServiceService API Code
Yodel Out of Home B2Shop - Extra Large Parcel [Print at Home]store_to_store_xl_print_home
Yodel Out of Home B2Shop - Extra Large Parcel [Print in Store]store_to_store_xl_print_store
Yodel Out of Home B2Shop - Large Parcel [Print at Home]store_to_store_lg_print_home
Yodel Out of Home B2Shop - Large Parcel [Print in Store]store_to_store_lg_print_store
Yodel Out of Home B2Shop - Medium Parcel [Print at Home]store_to_store_md_print_home
Yodel Out of Home B2Shop - Medium Parcel [Print in Store]store_to_store_md_print_store
Yodel Out of Home B2Shop - Small Parcel [Print at Home]store_to_store_sm_print_home
Yodel Out of Home B2Shop - Small Parcel [Print in Store]store_to_store_sm_print_store

Non-PUDO Services

ServiceService API Code
Store to Home - Extra Large Parcel [Print at Home]store_to_home_xl_print_home
Store to Home - Extra Large Parcel [Print in Store]store_to_home_xl_print_store
Store to Home - Large Parcel [Print at Home]store_to_home_lg_print_home
Store to Home - Large Parcel [Print in Store]store_to_home_lg_print_store
Store to Home Medium Parcel [Print at Home]store_to_home_med_print_home
Store to Home Medium Parcel [Print at Store]store_to_home_med_print_store
Store to Home Small Parcel [Print at Home]store_to_home_sm_print_home
Store to Home Small Parcel [Print at Store]store_to_home_sm_print_store

Package Types

NameAPI CodePackage Attributes
Packageyodel_collect_plus_c2c_packageDomestic

To ensure you always have the most up-to-date information, use the List Carrier Advanced Options call.

Return Services

Return services are not supported for this carrier.

Additional Carrier Details

  • All Yodel Out of Home services support both multi-package shipments and tracking.
  • Yodel Out of Home does not support sending rates to ShipEngine.
  • Yodel Out of Home services do not support adding messages to labels.

You are now ready to create shipments using Yodel Out of Home via ShipEngine!