ServiceLevelBetterTrucksEnum
{
"enum": [
"better_trucks_same_day",
"better_trucks_next_day"
],
"type": "string",
"description": "|Token | Service name|\n|:---|:---|\n| better_trucks_same_day | Same Day|\n| better_trucks_next_day | Next Day|\n"
}
ServiceLevelCDLEnum
{
"enum": [
"cdl_next_day"
],
"type": "string",
"description": "|Token | Service name|\n|:---|:---|\n| cdl_next_day | Next Day|\n"
}
ServiceLevelCanadaPostEnum
{
"enum": [
"canada_post_regular_parcel",
"canada_post_expedited_parcel",
"canada_post_priority",
"canada_post_xpresspost",
"canada_post_xpresspost_international",
"canada_post_xpresspost_usa",
"canada_post_expedited_parcel_usa",
"canada_post_tracked_packet_usa",
"canada_post_small_packet_usa_air",
"canada_post_tracked_packet_international",
"canada_post_small_packet_international_air"
],
"type": "string",
"description": "|Token | Service name|\n|:---|:---|\n| canada_post_regular_parcel | Regular Parcel|\n| canada_post_expedited_parcel | Expedited Parcel|\n| canada_post_priority | Priority|\n| canada_post_xpresspost | Xpresspost|\n| canada_post_xpresspost_international | Xpresspost International|\n| canada_post_xpresspost_usa | Xpresspost USA|\n| canada_post_expedited_parcel_usa | Expedited Parcel USA|\n| canada_post_tracked_packet_usa | Tracked Packet USA|\n| canada_post_small_packet_usa_air | Small Packet USA Air|\n| canada_post_tracked_packet_international | Tracked Packet International|\n| canada_post_small_packet_international_air | Small Package International Air|\n"
}
ServiceLevelChronopostEnum
{
"enum": [
"chronopost_13",
"chronopost_10",
"chronopost_18",
"chronopost_relais_fr",
"chronopost_classic",
"chronopost_express"
],
"type": "string",
"description": "|Token | Service name|\n|:---|:---|\n| chronopost_13 | Chrono 13|\n| chronopost_10 | Chrono 10|\n| chronopost_18| Chrono 18|\n| chronopost_relais_fr | Chrono Point Relais|\n| chronopost_classic | Chrono Classic International|\n| chronopost_express | Chrono Express International|\n"
}
ServiceLevelColissimoEnum
{
"enum": [
"colissimo_home",
"colissimo_pick_up_point",
"colissimo_return_mainland_france"
],
"type": "string",
"description": "|Token | Service name|\n|:---|:---|\n| colissimo_home | Domicile|\n| colissimo_pick_up_point | Point Retrait|\n| colissimo_return_mainland_france | Retour France|\n"
}
ServiceLevelCorreosEspanaEnum
{
"enum": [
"correos_standard_home",
"correos_premium_home"
],
"type": "string",
"description": "|Token | Service name|\n|:---|:---|\n| correos_standard_home| Paquete Estándar|\n| correos_premium_home | Paquete Premium|\n"
}
ServiceLevelCouriersPleaseEnum
{
"enum": [
"couriersplease_domestic_priority_auth_to_leave",
"couriersplease_domestic_priority_sign_required",
"couriersplease_gold_domestic_auth_to_leave",
"couriersplease_gold_domestic_sign_required",
"couriersplease_off_peak_auth_to_leave",
"couriersplease_off_peak_sign_required",
"couriersplease_parcel_auth_to_leave",
"couriersplease_parcel_sign_required",
"couriersplease_road_express",
"couriersplease_satchel_auth_to_leave",
"couriersplease_satchel_sign_required"
],
"type": "string",
"description": "|Token | Service name|\n|:---|:---|\n| couriersplease_domestic_priority_auth_to_leave | Domestic Priority - Authority To Leave/POPPoints|\n| couriersplease_domestic_priority_sign_required | Domestic Priority - Signature Required|\n| couriersplease_gold_domestic_auth_to_leave | Gold Domestic - Authority To Leave/POPPoints|\n| couriersplease_gold_domestic_sign_required | Gold Domestic - Signature Required|\n| couriersplease_off_peak_auth_to_leave | Off Peak - Authority To Leave/POPPoints|\n| couriersplease_off_peak_sign_required | Off Peak - Signature Required|\n| couriersplease_parcel_auth_to_leave | Parcel - Authority To Leave|\n| couriersplease_parcel_sign_required | Parcel - Signature Required|\n| couriersplease_road_express | Road Express|\n| couriersplease_satchel_auth_to_leave | Satchel - Authority To Leave|\n| couriersplease_satchel_sign_required | Satchel - Signature Required|\n"
}
ServiceLevelDHLExpressEnum
{
"enum": [
"dhl_express_domestic_express_doc",
"dhl_express_economy_select_doc",
"dhl_express_worldwide_nondoc",
"dhl_express_worldwide_doc",
"dhl_express_worldwide",
"dhl_express_worldwide_eu_doc",
"dhl_express_break_bulk_express_doc",
"dhl_express_express_9_00_nondoc",
"dhl_express_economy_select_nondoc",
"dhl_express_break_bulk_economy_doc",
"dhl_express_express_9_00_doc",
"dhl_express_express_10_30_doc",
"dhl_express_express_10_30_nondoc",
"dhl_express_express_12_00_doc",
"dhl_express_europack_nondoc",
"dhl_express_express_envelope_doc",
"dhl_express_express_12_00_nondoc",
"dhl_express_express_12_doc",
"dhl_express_worldwide_b2c_doc",
"dhl_express_worldwide_b2c_nondoc",
"dhl_express_medical_express",
"dhl_express_express_easy_nondoc"
],
"type": "string",
"description": "|Token | Service name|\n|:---|:---|\n| dhl_express_domestic_express_doc | Domestic Express Doc|\n| dhl_express_economy_select_doc | Economy Select Doc|\n| dhl_express_worldwide_nondoc | Express Worldwide Nondoc|\n| dhl_express_worldwide_doc | Express Worldwide Doc|\n| dhl_express_worldwide | Worldwide|\n| dhl_express_worldwide_eu_doc | Express Worldwide EU Doc|\n| dhl_express_break_bulk_express_doc | Break Bulk Express Doc|\n| dhl_express_express_9_00_nondoc | Express 9:00 NonDoc|\n| dhl_express_economy_select_nondoc | Economy Select NonDoc|\n| dhl_express_break_bulk_economy_doc | Break Bulk Economy Doc|\n| dhl_express_express_9_00_doc | Express 9:00 Doc|\n| dhl_express_express_10_30_doc | Express 10:30 Doc|\n| dhl_express_express_10_30_nondoc | Express 10:30 NonDoc|\n| dhl_express_express_12_00_doc | Express 12:00 Doc|\n| dhl_express_europack_nondoc | Europack NonDoc|\n| dhl_express_express_envelope_doc | Express Envelope Doc|\n| dhl_express_express_12_00_nondoc | Express 12:00 NonDoc|\n| dhl_express_express_12_doc | Domestic Express 12:00|\n| dhl_express_worldwide_b2c_doc | Express Worldwide (B2C) Doc|\n| dhl_express_worldwide_b2c_nondoc | Express Worldwide (B2C) NonDoc|\n| dhl_express_medical_express | Medical Express|\n| dhl_express_express_easy_nondoc | Express Easy NonDoc|\n"
}
ServiceLevelDHLGermanyEnum
{
"enum": [
"dhl_germany_europaket",
"dhl_germany_paket",
"dhl_germany_paket_connect",
"dhl_germany_paket_international",
"dhl_germany_paket_priority",
"dhl_germany_paket_sameday"
],
"type": "string",
"description": "|Token | Service name|\n|:---|:---|\n| dhl_germany_europaket | DHL Germany Europaket|\n| dhl_germany_paket | DHL Germany Paket|\n| dhl_germany_paket_connect | DHL Germany Paket Connect|\n| dhl_germany_paket_international | DHL Germany Paket International|\n| dhl_germany_paket_priority | DHL Germany Paket Priority|\n| dhl_germany_paket_sameday | DHL Germany Paket Sameday|\n"
}
ServiceLevelDHLeCommerceEnum
{
"enum": [
"dhl_ecommerce_marketing_parcel_expedited",
"dhl_ecommerce_globalmail_business_ipa",
"dhl_ecommerce_parcel_international_direct",
"dhl_ecommerce_parcels_expedited_max",
"dhl_ecommerce_bpm_ground",
"dhl_ecommerce_priority_expedited",
"dhl_ecommerce_globalmail_packet_ipa",
"dhl_ecommerce_globalmail_packet_isal",
"dhl_ecommerce_easy_return_plus",
"dhl_ecommerce_marketing_parcel_ground",
"dhl_ecommerce_first_class_parcel_expedited",
"dhl_ecommerce_globalmail_business_priority",
"dhl_ecommerce_parcels_expedited",
"dhl_ecommerce_globalmail_business_isal",
"dhl_ecommerce_parcel_plus_expedited_max",
"dhl_ecommerce_globalmail_packet_plus",
"dhl_ecommerce_parcels_ground",
"dhl_ecommerce_expedited",
"dhl_ecommerce_parcel_plus_ground",
"dhl_ecommerce_parcel_international_standard",
"dhl_ecommerce_bpm_expedited",
"dhl_ecommerce_parcel_international_expedited",
"dhl_ecommerce_globalmail_packet_priority",
"dhl_ecommerce_easy_return_light",
"dhl_ecommerce_parcel_plus_expedited",
"dhl_ecommerce_globalmail_business_standard",
"dhl_ecommerce_ground",
"dhl_ecommerce_globalmail_packet_standard"
],
"type": "string",
"description": "|Token | Service name|\n|:---|:---|\n| dhl_ecommerce_marketing_parcel_expedited | Marketing Parcel Expedited|\n| dhl_ecommerce_globalmail_business_ipa | GlobalMail Business IPA|\n| dhl_ecommerce_parcel_international_direct | Parcel International Direct|\n| dhl_ecommerce_parcels_expedited_max | Parcels Expedited Max|\n| dhl_ecommerce_bpm_ground | Bounded Printed Matter Ground|\n| dhl_ecommerce_priority_expedited | Priority Expedited|\n| dhl_ecommerce_globalmail_packet_ipa | GlobalMail Packet IPA|\n| dhl_ecommerce_globalmail_packet_isal | GlobalMail Packet ISAL|\n| dhl_ecommerce_easy_return_plus | Easy Return Plus|\n| dhl_ecommerce_marketing_parcel_ground | Marketing Parcel Ground|\n| dhl_ecommerce_first_class_parcel_expedited | First Class Parcel Expedited|\n| dhl_ecommerce_globalmail_business_priority | GlobalMail Business Priority|\n| dhl_ecommerce_parcels_expedited | Parcels Expedited|\n| dhl_ecommerce_globalmail_business_isal | GlobalMail Business ISAL|\n| dhl_ecommerce_parcel_plus_expedited_max | Parcel Plus Expedited Max|\n| dhl_ecommerce_globalmail_packet_plus | GlobalMail Packet Plus|\n| dhl_ecommerce_parcels_ground | Parcels Ground|\n| dhl_ecommerce_expedited | Expedited|\n| dhl_ecommerce_parcel_plus_ground | Parcel Plus Ground|\n| dhl_ecommerce_parcel_international_standard | Parcel International Standard|\n| dhl_ecommerce_bpm_expedited | Bounded Printed Matter Expedited|\n| dhl_ecommerce_parcel_international_expedited | Parcel International Expedited|\n| dhl_ecommerce_globalmail_packet_priority | GlobalMail Packet Priority|\n| dhl_ecommerce_easy_return_light | Easy Return Light|\n| dhl_ecommerce_parcel_plus_expedited | Parcel Plus Expedited|\n| dhl_ecommerce_globalmail_business_standard | GlobalMail Packet Standard|\n| dhl_ecommerce_ground | Ground|\n| dhl_ecommerce_globalmail_packet_standard | GlobalMail Business Standard|\n"
}
ServiceLevelDPDDEEnum
{
"enum": [
"dpd_de_classic"
],
"type": "string",
"description": "|Token | Service name|\n|:---|:---|\n| dpd_de_classic | DPD Classic|\n"
}
ServiceLevelDPDUKEnum
{
"enum": [
"dpd_uk_ship_to_shop",
"dpd_uk_1030",
"dpd_uk_1200",
"dpd_uk_saturday",
"dpd_uk_saturday_1030",
"dpd_uk_saturday_1200",
"dpd_uk_sunday",
"dpd_uk_sunday_1030",
"dpd_uk_sunday_1200",
"dpd_uk_next_day",
"dpd_uk_two_day",
"dpd_uk_classic",
"dpd_uk_air_classic",
"dpd_uk_air_express",
"dpd_uk_direct",
"dpd_uk_direct_tracked_mail",
"dpd_uk_pickup_returns"
],
"type": "string",
"description": "|Token | Service name|\n|:---|:---|\n| dpd_uk_ship_to_shop | Ship to shop|\n| dpd_uk_1030 | Door to door 10.30 next day|\n| dpd_uk_1200 | Door to door 12.00 next day|\n| dpd_uk_saturday | Saturday Delivery|\n| dpd_uk_saturday_1030 | Saturday Delivery 10.30|\n| dpd_uk_saturday_1200 | Saturday Delivery 12.00|\n| dpd_uk_sunday | Sunday Delivery|\n| dpd_uk_sunday_1030 | Sunday Delivery 10.30|\n| dpd_uk_sunday_1200 | Sunday Delivery 12.00|\n| dpd_uk_next_day | Next day|\n| dpd_uk_two_day | Two day|\n| dpd_uk_classic | DPD Classic|\n| dpd_uk_air_classic | DPD Air Classic|\n| dpd_uk_air_express | DPD Air Express|\n| dpd_uk_direct | DPD Direct|\n| dpd_uk_direct_tracked_mail| DPD Tracked Mail|\n| dpd_uk_pickup_returns | Pickup Returns|\n"
}
ServiceLevelDeutschePostEnum
{
"enum": [
"deutsche_post_postkarte",
"deutsche_post_standardbrief",
"deutsche_post_kompaktbrief",
"deutsche_post_grossbrief",
"deutsche_post_maxibrief",
"deutsche_post_maxibrief_plus",
"deutsche_post_warenpost_international_xs",
"deutsche_post_warenpost_international_s",
"deutsche_post_warenpost_international_m",
"deutsche_post_warenpost_international_l"
],
"type": "string",
"description": "|Token | Service name|\n|:---|:---|\n| deutsche_post_postkarte | Postkarte|\n| deutsche_post_standardbrief | Standardbrief|\n| deutsche_post_kompaktbrief | Kompaktbrief|\n| deutsche_post_grossbrief | Grossbrief|\n| deutsche_post_maxibrief | Maxibrief|\n| deutsche_post_maxibrief_plus | Maxibrief Plus|\n| deutsche_post_warenpost_international_xs | Warenpost International XS|\n| deutsche_post_warenpost_international_s | Warenpost International S|\n| deutsche_post_warenpost_international_m | Warenpost International M|\n| deutsche_post_warenpost_international_l | Warenpost International L|\n"
}
ServiceLevelEnumSet
{
"oneOf": [
{
"$ref": "#/components/schemas/ServiceLevelUSPSEnum"
},
{
"$ref": "#/components/schemas/ServiceLevelFedExEnum"
},
{
"$ref": "#/components/schemas/ServiceLevelUPSEnum"
},
{
"$ref": "#/components/schemas/ServiceLevelAirterraEnum"
},
{
"$ref": "#/components/schemas/ServiceLevelAPCPostalEnum"
},
{
"$ref": "#/components/schemas/ServiceLevelAsendiaEnum"
},
{
"$ref": "#/components/schemas/ServiceLevelAustraliaPostEnum"
},
{
"$ref": "#/components/schemas/ServiceLevelAxleHireEnum"
},
{
"$ref": "#/components/schemas/ServiceLevelAPGEnum"
},
{
"$ref": "#/components/schemas/ServiceLevelBetterTrucksEnum"
},
{
"$ref": "#/components/schemas/ServiceLevelCanadaPostEnum"
},
{
"$ref": "#/components/schemas/ServiceLevelCDLEnum"
},
{
"$ref": "#/components/schemas/ServiceLevelChronopostEnum"
},
{
"$ref": "#/components/schemas/ServiceLevelCouriersPleaseEnum"
},
{
"$ref": "#/components/schemas/ServiceLevelCorreosEspanaEnum"
},
{
"$ref": "#/components/schemas/ServiceLevelColissimoEnum"
},
{
"$ref": "#/components/schemas/ServiceLevelPurolatorEnum"
},
{
"$ref": "#/components/schemas/ServiceLevelDHLExpressEnum"
},
{
"$ref": "#/components/schemas/ServiceLevelDHLeCommerceEnum"
},
{
"$ref": "#/components/schemas/ServiceLevelDHLGermanyEnum"
},
{
"$ref": "#/components/schemas/ServiceLevelDPDDEEnum"
},
{
"$ref": "#/components/schemas/ServiceLevelDPDUKEnum"
},
{
"$ref": "#/components/schemas/ServiceLevelDeutschePostEnum"
},
{
"$ref": "#/components/schemas/ServiceLevelAramexAustraliaEnum"
},
{
"$ref": "#/components/schemas/ServiceLevelGlobegisticsEnum"
},
{
"$ref": "#/components/schemas/ServiceLevelGLSUSEnum"
},
{
"$ref": "#/components/schemas/ServiceLevelLSOEnum"
},
{
"$ref": "#/components/schemas/ServiceLevelMondialRelayEnum"
},
{
"$ref": "#/components/schemas/ServiceLevelMaergoEnum"
},
{
"$ref": "#/components/schemas/ServiceLevelParcelforceEnum"
},
{
"$ref": "#/components/schemas/ServiceLevelPostItalianeEnum"
},
{
"$ref": "#/components/schemas/ServiceLevelePostGlobalEnum"
},
{
"$ref": "#/components/schemas/ServiceLevelRoyalMailEnum"
},
{
"$ref": "#/components/schemas/ServiceLevelSendleEnum"
},
{
"$ref": "#/components/schemas/ServiceLevelOnTracEnum"
},
{
"$ref": "#/components/schemas/ServiceLevelLasershipEnum"
},
{
"$ref": "#/components/schemas/ServiceLevelEvriUKEnum"
},
{
"$ref": "#/components/schemas/ServiceLevelUDSEnum"
},
{
"$ref": "#/components/schemas/ServiceLevelVehoEnum"
},
{
"$ref": "#/components/schemas/ServiceLevelSwyftEnum"
}
],
"x-speakeasy-include": true
}
ServiceLevelEvriUKEnum
{
"enum": [
"hermes_uk_courier_service",
"hermes_uk_parcelshop_dropoff",
"hermes_uk_parcelshop_dropoff_nextday",
"hermes_uk_postable",
"hermes_uk_postable_nextday"
],
"type": "string",
"description": "|Token | Service name|\n|:---|:---|\n| hermes_uk_courier_service | Courier Collection|\n| hermes_uk_parcelshop_dropoff | ParcelShop Drop-Off|\n| hermes_uk_parcelshop_dropoff_nextday | ParcelShop Drop-Off Next Day|\n| hermes_uk_postable | Postable|\n| hermes_uk_postable_nextday | Postable Next Day|\n"
}
ServiceLevelFedExEnum
{
"enum": [
"fedex_ground",
"fedex_home_delivery",
"fedex_smart_post",
"fedex_ground_economy",
"fedex_2_day",
"fedex_2_day_am",
"fedex_express_saver",
"fedex_standard_overnight",
"fedex_priority_overnight",
"fedex_first_overnight",
"fedex_freight_priority",
"fedex_next_day_freight",
"fedex_freight_economy",
"fedex_first_freight",
"fedex_international_economy",
"fedex_international_priority",
"fedex_international_first",
"fedex_europe_first_international_priority",
"fedex_international_connect_plus",
"international_economy_freight",
"international_priority_freight"
],
"type": "string",
"description": "|Token | Service name|\n|:---|:---|\n| fedex_ground | FedEx Ground®|\n| fedex_home_delivery | FedEx Home Delivery®|\n| fedex_ground_economy | FedEx Ground® Economy|\n| fedex_2_day | FedEx 2Day®|\n| fedex_2_day_am | FedEx 2Day® A.M.|\n| fedex_express_saver | FedEx Express Saver®|\n| fedex_standard_overnight | FedEx Standard Overnight®|\n| fedex_priority_overnight | FedEx Priority Overnight®|\n| fedex_first_overnight | FedEx First Overnight®|\n| fedex_freight_priority | FedEx Freight® Priority|\n| fedex_next_day_freight | FedEx Next Day Freight|\n| fedex_freight_economy | FedEx Freight® Economy|\n| fedex_first_freight | FedEx First Freight|\n| fedex_international_economy | FedEx International Economy®|\n| fedex_international_priority | FedEx International Priority®|\n| fedex_international_first | FedEx International First®|\n| fedex_europe_first_international_priority | FedEx International First®|\n| fedex_international_connect_plus | FedEx International Connect Plus|\n| international_economy_freight | FedEx International Economy® Freight|\n| international_priority_freight | FedEx International Priority® Freight|\n"
}
ServiceLevelGLSUSEnum
{
"enum": [
"gls_us_cps",
"gls_us_eps",
"gls_us_ess",
"gls_us_nps",
"gls_us_pds",
"gls_us_sds"
],
"type": "string",
"description": "|Token | Service name|\n|:---|:---|\n| gls_us_cps | GSO Ground|\n| gls_us_eps | Early Priority Overnight|\n| gls_us_ess | Early Saturday Delivery|\n| gls_us_nps | Noon Priority Overnight|\n| gls_us_pds | Priority Overnight|\n| gls_us_sds | Saturday Delivery|\n"
}
ServiceLevelGlobegisticsEnum
{
"enum": [
"globegistics_priority_mail_express_international",
"globegistics_priority_mail_international",
"globegistics_priority_mail_express_international_pds",
"globegistics_priority_mail_international_pds",
"globegistics_epacket",
"globegistics_ecom_tracked_ddp",
"globegistics_ecom_packet_ddp",
"globegistics_ecom_priority_mail_international_ddp",
"globegistics_ecom_priority_mail_express_international_ddp",
"globegistics_ecom_extra",
"globegistics_ecom_international_priority_airmail",
"globegistics_ecom_international_surface_airlift"
],
"type": "string",
"description": "|Token | Service name|\n|:---|:---|\n| globegistics_priority_mail_express_international | Globegistics Priority Mail Express International|\n| globegistics_priority_mail_international | Globegistics Priority Mail International|\n| globegistics_priority_mail_express_international_pds | Globegistics Priority Mail Express International PreSort Drop Ship|\n| globegistics_priority_mail_international_pds | Globegistics Priority Mail International PreSort Drop Ship|\n| globegistics_epacket | Globegistics ePacket|\n| globegistics_ecom_tracked_ddp | Globegistics eCom Tracked DDP|\n| globegistics_ecom_packet_ddp | Globegistics eCom Packet DDP|\n| globegistics_ecom_priority_mail_international_ddp | Globegistics eCom Priority Mail International DDP|\n| globegistics_ecom_priority_mail_express_international_ddp | Globegistics eCom Priority Mail Express International DDP|\n| globegistics_ecom_extra | Globegistics eCom Extra|\n| globegistics_ecom_international_priority_airmail | Globegistics eCom International Priority Airmail|\n| globegistics_ecom_international_surface_airlift | Globegistics eCom International Surface Air Lift|\n"
}
ServiceLevelLSOEnum
{
"enum": [
"lso_ground",
"lso_economy_next_day",
"lso_saturday_delivery",
"lso_2nd_day",
"lso_priority_next_day",
"lso_early_overnight"
],
"type": "string",
"description": "|Token | Service name|\n|:---|:---|\n| lso_ground | Ground|\n| lso_economy_next_day | Economy Next Day|\n| lso_saturday_delivery | Saturday Delivery|\n| lso_2nd_day | 2nd Day|\n| lso_priority_next_day | Priority Next Day|\n| lso_early_overnight | Early Overnight|\n"
}
ServiceLevelLasershipEnum
{
"enum": [
"lasership_routed_delivery"
],
"type": "string",
"description": "|Token | Service name|\n|:---|:---|\n| lasership_routed_delivery | Routed Delivery|\n"
}
ServiceLevelMaergoEnum
{
"enum": [
"x_delivery_expedited"
],
"type": "string",
"description": "|Token | Service name|\n|:---|:---|\n| x_delivery_expedited | Expedited|\n"
}
ServiceLevelMondialRelayEnum
{
"enum": [
"mondial_relay_pointrelais"
],
"type": "string",
"description": "|Token | Service name|\n|:---|:---|\n| mondial_relay_pointrelais | Point Relais|\n"
}
ServiceLevelOnTracEnum
{
"enum": [
"ontrac_ground",
"ontrac_sunrise_gold",
"ontrac_sunrise"
],
"type": "string",
"description": "|Token | Service name|\n|:---|:---|\n| ontrac_ground | Ground|\n| ontrac_sunrise_gold | Sunrise Gold|\n| ontrac_sunrise | Sunrise|\n"
}
ServiceLevelParcelforceEnum
{
"enum": [
"parcelforce_express48",
"parcelforce_express24",
"parcelforce_expressam"
],
"type": "string",
"description": "|Token | Service name|\n|:---|:---|\n| parcelforce_express48 | Express 48|\n| parcelforce_express24 | Express 24|\n| parcelforce_expressam | Express AM|\n"
}
ServiceLevelPostItalianeEnum
{
"enum": [
"poste_italiane_delivery_business_express"
],
"type": "string",
"description": "|Token | Service name|\n|:---|:---|\n| poste_italiane_delivery_business_express | Poste Delivery Business Express|\n"
}
ServiceLevelPurolatorEnum
{
"enum": [
"purolator_ground",
"purolator_ground9_am",
"purolator_ground1030_am",
"purolator_ground_distribution",
"purolator_ground_evening",
"purolator_ground_us",
"purolator_express",
"purolator_express9_am",
"purolator_express1030_am",
"purolator_express_evening",
"purolator_express_us",
"purolator_express_us9_am",
"purolator_express_us1030_am",
"purolator_express_us1200",
"purolator_express_international",
"purolator_express_international9_am",
"purolator_express_international1030_am",
"purolator_express_international1200"
],
"type": "string",
"description": "|Token | Service name|\n|:---|:---|\n| purolator_ground | Ground|\n| purolator_ground9_am | Ground 9am|\n| purolator_ground1030_am | Ground 10:30am|\n| purolator_ground_distribution | Ground Distribution|\n| purolator_ground_evening | Ground Evening|\n| purolator_ground_us | Ground US|\n| purolator_express | Express|\n| purolator_express9_am | Express 9am|\n| purolator_express1030_am | Express 10am|\n| purolator_express_evening | Express Evening|\n| purolator_express_us | Express US|\n| purolator_express_us9_am | Express US 9am|\n| purolator_express_us1030_am | Express US 10:30am|\n| purolator_express_us1200 | Express US 12pm|\n| purolator_express_international | Express International|\n| purolator_express_international9_am | Express International 9am|\n| purolator_express_international1030_am | Express International 10:30am|\n| purolator_express_international1200 | Express International 12pm|\n"
}
ServiceLevelRoyalMailEnum
{
"enum": [
"royal_mail_tracked_letter_boxable_24_no_signature",
"royal_mail_tracked_letter_boxable_48_no_signature",
"royal_mail_tracked_24_returns",
"royal_mail_tracked_48_returns",
"royal_mail_special_delivery_guaranteed_1pm",
"royal_mail_special_delivery_guaranteed_9am",
"royal_mail_24",
"royal_mail_48",
"royal_mail_signed_for_first_class",
"royal_mail_signed_for_second_class",
"royal_mail_standard_first_class",
"royal_mail_standard_second_class",
"royal_mail_tracked_24_no_signature",
"royal_mail_tracked_48_no_signature",
"royal_mail_intl_bus_mail_lrg_ltr_zone_sort_pri",
"royal_mail_intl_bus_parcels_tracked_zone_sort",
"royal_mail_intl_bus_parcels_tracked_country_priced",
"royal_mail_intl_bus_parcels_tracked_signed_zone_srt",
"royal_mail_24_flat_rate",
"royal_mail_48_flat_rate"
],
"type": "string",
"description": "|Token | Service name|\n|:---|:---|\n| royal_mail_tracked_letter_boxable_24_no_signature | Royal Mail Tracked Letter-Boxable 24 No Signature|\n| royal_mail_tracked_letter_boxable_48_no_signature | Royal Mail Tracked Letter-Boxable 48 No Signature|\n| royal_mail_tracked_24_returns | Royal Mail Tracked Returns 24|\n| royal_mail_tracked_48_returns | Royal Mail Tracked Returns 48|\n| royal_mail_special_delivery_guaranteed_1pm | Special Delivery Guaranteed by 1pm\n| royal_mail_special_delivery_guaranteed_9am | Special Delivery Guaranteed by 9am\n| royal_mail_24 | RoyalMail 24\n| royal_mail_48 | RoyalMail 48\n| royal_mail_signed_for_first_class | Signed for First Class\n| royal_mail_signed_for_second_class | Signed for Second Class\n| royal_mail_standard_first_class | Standard First Class\n| royal_mail_standard_second_class | Standard Second Class\n| royal_mail_tracked_24_no_signature | Royal Mail Tracked 24 No Signature\n| royal_mail_tracked_48_no_signature | Royal Mail Ttacked 48 No Signature\n| royal_mail_intl_bus_mail_lrg_ltr_zone_sort_pri | International Business Mail Large Letter Zone Sort Priority\n| royal_mail_intl_bus_parcels_tracked_zone_sort | International Business Parcels Tracked Zone Sort\n| royal_mail_intl_bus_parcels_tracked_country_priced | International Business Parcels Tracked Country Priced\n| royal_mail_intl_bus_parcels_tracked_signed_zone_srt | International Business Parcels & Signed Zone Sort\n| royal_mail_24_flat_rate | Royal Mail 24 Parcel Flat Rate\n| royal_mail_48_flat_rate | Royal Mail 48 Parcel Flat Rate\n"
}
ServiceLevelSendleEnum
{
"enum": [
"sendle_parcel"
],
"type": "string",
"description": "|Token | Service name|\n|:---|:---|\n| sendle_parcel | Sendle Parcel|\n"
}
ServiceLevelSwyftEnum
{
"enum": [
"same_day",
"next_day"
],
"type": "string",
"description": "|Token | Service name|\n|:---|:---|\n| same_day | Next Day|\n| next_day | Next Day|\n"
}
ServiceLevelUDSEnum
{
"enum": [
"uds_next_day"
],
"type": "string",
"description": "|Token | Service name|\n|:---|:---|\n| uds_next_day | Next Day|\n"
}
ServiceLevelUPSEnum
{
"enum": [
"ups_standard",
"ups_ground",
"ups_saver",
"ups_3_day_select",
"ups_second_day_air",
"ups_second_day_air_am",
"ups_next_day_air",
"ups_next_day_air_saver",
"ups_next_day_air_early_am",
"ups_mail_innovations_bpm_flat",
"ups_mail_innovations_bpm_parcel",
"ups_mail_innovations_irregular",
"ups_mail_innovations_media_mail",
"ups_mail_innovations_parcel",
"ups_mail_innovations_standard_flat",
"ups_surepost",
"ups_surepost_bound_printed_matter",
"ups_surepost_lightweight",
"ups_surepost_media",
"ups_express",
"ups_express_1200",
"ups_express_plus",
"ups_expedited",
"ups_express_early",
"ups_access_point_economy"
],
"type": "string",
"description": "|Token | Service name|\n|:---|:---|\n| ups_standard | Standard℠|\n| ups_ground | Ground|\n| ups_saver | Saver®|\n| ups_3_day_select | 3 Day Select®|\n| ups_second_day_air | 2nd Day Air®|\n| ups_second_day_air_am | 2nd Day Air® A.M.|\n| ups_next_day_air | Next Day Air®|\n| ups_next_day_air_saver | Next Day Air Saver®|\n| ups_next_day_air_early_am | Next Day Air® Early|\n| ups_mail_innovations_bpm_flat | Mail Innovations BPM Flat |\n| ups_mail_innovations_bpm_parcel | Mail Innovations BPM Parcel |\n| ups_mail_innovations_irregular | Mail Innovations Irregular |\n| ups_mail_innovations_media_mail | Mail Innovations Media Mail |\n| ups_mail_innovations_parcel | Mail Innovations Parcel |\n| ups_mail_innovations_standard_flat | Mail Innovations Standard Flat |\n| ups_surepost | Surepost|\n| ups_surepost_bound_printed_matter | SurePost® Bound Printed Matter|\n| ups_surepost_lightweight | Surepost Lightweight|\n| ups_surepost_media | SurePost® Media|\n| ups_express | Express®|\n| ups_express_1200 | Express 12:00|\n| ups_express_plus | Express Plus®|\n| ups_expedited | Expedited®|\n| ups_express_early | Express® Early|\n| ups_access_point_economy | Access Point™ Economy|\n"
}
ServiceLevelUSPSEnum
{
"enum": [
"usps_priority",
"usps_priority_express",
"usps_media_mail",
"usps_priority_mail_international",
"usps_priority_mail_express_international",
"usps_first_class_package_international_service",
"usps_ground_advantage"
],
"type": "string",
"description": "|Token | Service name|\n|:---|:---|\n| usps_priority | Priority Mail|\n| usps_priority_express | Priority Mail Express|\n| usps_media_mail | Media Mail, only for existing Shippo customers with grandfathered Media Mail option.|\n| usps_priority_mail_international | Priority Mail International|\n| usps_priority_mail_express_international | Priority Mail Express International|\n| usps_first_class_package_international_service | First Class Package International|\n| usps_ground_advantage | Ground Advantage |\n"
}
ServiceLevelVehoEnum
{
"enum": [
"veho_next_day"
],
"type": "string",
"description": "|Token | Service name|\n|:---|:---|\n| veho_next_day | Veho Next Day |\n"
}
ServiceLevelePostGlobalEnum
{
"enum": [
"rr_donnelley_domestic_economy_parcel",
"rr_donnelley_domestic_priority_parcel",
"rr_donnelley_domestic_parcel_bpm",
"rr_donnelley_priority_domestic_priority_parcel_bpm",
"rr_donnelley_priority_parcel_delcon",
"rr_donnelley_priority_parcel_nondelcon",
"rr_donnelley_economy_parcel",
"rr_donnelley_ipa",
"rr_donnelley_courier",
"rr_donnelley_isal",
"rr_donnelley_epacket",
"rr_donnelley_pmi",
"rr_donnelley_emi"
],
"type": "string",
"description": "|Token | Service name|\n|:---|:---|\n| rr_donnelley_domestic_economy_parcel | Domestic Economy Parcel|\n| rr_donnelley_domestic_priority_parcel | Domestic Priority Parcel |\n| rr_donnelley_domestic_parcel_bpm | Domestic Parcel BPM|\n| rr_donnelley_priority_domestic_priority_parcel_bpm | Domestic Priority Parcel BPM|\n| rr_donnelley_priority_parcel_delcon | International Priority Parcel DelCon|\n| rr_donnelley_priority_parcel_nondelcon | International Priority Parcel NonDelcon|\n| rr_donnelley_economy_parcel | Economy Parcel Service |\n| rr_donnelley_ipa | International Priority Airmail (IPA)|\n| rr_donnelley_courier | International Courier|\n| rr_donnelley_isal | International Surface Air Lift (ISAL)|\n| rr_donnelley_epacket | e-Packet|\n| rr_donnelley_pmi | Priority Mail International|\n| rr_donnelley_emi | Express Mail International|\n"
}
Shipment
{
"allOf": [
{
"$ref": "#/components/schemas/ShipmentBase"
},
{
"required": [
"address_to",
"address_from",
"parcels",
"object_created",
"object_updated",
"object_id",
"object_owner",
"status",
"rates",
"carrier_accounts",
"messages",
"metadata"
],
"properties": {
"test": {
"type": "boolean",
"description": "Indicates whether the object has been created in test mode."
},
"rates": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Rate"
},
"description": "An array with all available rates. If <code>async</code> has been set to <code>false</code> in the request,\nthis will be populated with all available rates in the response. Otherwise rates will be created\nasynchronously and this array will initially be empty."
},
"status": {
"enum": [
"ERROR",
"QUEUED",
"SUCCESS",
"STATUS"
],
"type": "string",
"example": "SUCCESS",
"description": "`Waiting` shipments have been successfully submitted but not yet been processed. \n`Queued` shipments are currently being processed. \n`Success` shipments have been processed successfully, meaning that rate generation has concluded. \n`Error` does not occur currently and is reserved for future use."
},
"parcels": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Parcel"
},
"description": "List of Parcel objects to be shipped."
},
"messages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"text": {
"type": "string",
"example": "RatedShipmentWarning: User Id and Shipper Number combination is not qualified to receive negotiated rates."
},
"source": {
"type": "string",
"example": "UPS"
}
}
},
"description": "An array containing elements of the following schema:<br>`code` (string): an identifier for the corresponding message\n(not always available)<br>`message` (string): a publishable message containing further information."
},
"object_id": {
"type": "string",
"example": "adcfdddf8ec64b84ad22772bce3ea37a",
"description": "Unique identifier of the given Shipment object."
},
"address_to": {
"$ref": "#/components/schemas/Address"
},
"address_from": {
"$ref": "#/components/schemas/Address"
},
"object_owner": {
"type": "string",
"example": "pp@gmail.com",
"description": "Username of the user who created the Shipment object."
},
"address_return": {
"$ref": "#/components/schemas/Address"
},
"object_created": {
"type": "string",
"format": "date-time",
"description": "Date and time of Shipment creation."
},
"object_updated": {
"type": "string",
"format": "date-time",
"description": "Date and time of last Shipment update."
},
"carrier_accounts": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of object_ids of the carrier account objects to be used for getting shipping rates for this shipment. \nIf no carrier account object_ids are set in this field, Shippo will attempt to generate rates using all the \ncarrier accounts that have the `active` field set."
}
},
"description": "Shipment represents the parcel as retrieved from the database"
}
]
}
ShipmentBase
{
"type": "object",
"properties": {
"extra": {
"$ref": "#/components/schemas/ShipmentExtra"
},
"metadata": {
"type": "string",
"example": "Customer ID 123456",
"description": "A string of up to 100 characters that can be filled with any additional information you want to attach to the object."
},
"shipment_date": {
"type": "string",
"example": "2021-03-22T12:00:00Z",
"description": "Date the shipment will be tendered to the carrier. Must be in the format `2014-01-18T00:35:03.463Z`. \nDefaults to current date and time if no value is provided. Please note that some carriers require this value to\nbe in the future, on a working day, or similar."
},
"customs_declaration": {
"type": "string",
"example": "adcfdddf8ec64b84ad22772bce3ea37a",
"description": "ID of the Customs Declarations object for an international shipment."
}
}
}
ShipmentCreateRequest
{
"allOf": [
{
"$ref": "#/components/schemas/ShipmentBase"
},
{
"required": [
"address_to",
"address_from",
"parcels"
],
"properties": {
"async": {
"type": "boolean"
},
"parcels": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/ParcelCreateRequest"
},
{
"type": "string",
"description": "<a href=\"#tag/Parcel\">Parcel</a> `object_id` of a previously created parcel."
}
]
}
},
"address_to": {
"oneOf": [
{
"$ref": "#/components/schemas/AddressCreateRequest"
},
{
"type": "string",
"description": "<a href=\"#tag/Addresses\">Address</a> `object_id` of a previously created address."
}
]
},
"address_from": {
"oneOf": [
{
"$ref": "#/components/schemas/AddressCreateRequest"
},
{
"type": "string",
"description": "<a href=\"#tag/Addresses\">Address</a> `object_id` of a previously created address."
}
]
},
"address_return": {
"oneOf": [
{
"$ref": "#/components/schemas/AddressCreateRequest"
},
{
"type": "string",
"description": "<a href=\"#tag/Addresses\">Address</a> `object_id` of a previously created address."
}
]
},
"carrier_accounts": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"065a4a8c10d24a34ab932163a1b87f52",
"73f706f4bdb94b54a337563840ce52b0"
],
"description": "List of <a href=\"#tag/Carrier-Accounts/\">Carrier Accounts</a> `object_id`s used to filter \nthe returned rates. If set, only rates from these carriers will be returned."
}
}
}
]
}
ShipmentExtra
{
"type": "object",
"properties": {
"COD": {
"$ref": "#/components/schemas/COD"
},
"alcohol": {
"$ref": "#/components/schemas/Alcohol"
},
"billing": {
"$ref": "#/components/schemas/Billing"
},
"dry_ice": {
"$ref": "#/components/schemas/DryIce"
},
"premium": {
"type": "boolean",
"description": "Add premium service to a shipment (DHL Germany international shipments only)."
},
"insurance": {
"$ref": "#/components/schemas/Insurance"
},
"is_return": {
"type": "boolean",
"description": "This field specifies if it is a scan-based return shipment. See the <a href=\"https://docs.goshippo.com/docs/shipments/returns/\">Create a return shipment</a> section for more details."
},
"po_number": {
"$ref": "#/components/schemas/PoNumber"
},
"rma_number": {
"$ref": "#/components/schemas/RmaNumber"
},
"dept_number": {
"$ref": "#/components/schemas/DepartmentNumber"
},
"reference_1": {
"type": "string",
"description": "Optional text to be printed on the shipping label if supported by carrier. Up to 50 characters."
},
"reference_2": {
"type": "string",
"description": "Optional text to be printed on the shipping label if supported by carrier. Up to 50 characters. For DHL eCommerce, this field can be used for billing reference."
},
"carbon_neutral": {
"type": "boolean",
"description": "Request carbon offsets by passing true (UPS only)."
},
"carrier_hub_id": {
"type": "string",
"description": "Identifies the carrier injection site."
},
"container_type": {
"type": "string",
"description": "Specify container type."
},
"invoice_number": {
"$ref": "#/components/schemas/InvoiceNumber"
},
"customer_branch": {
"type": "string",
"description": "Specify customer branch (Lasership only)."
},
"dangerous_goods": {
"$ref": "#/components/schemas/DangerousGoodsObject"
},
"lasership_attrs": {
"enum": [
"TwoPersonDelivery",
"Explosive",
"Alcohol",
"Hazmat",
"ControlledSubstance",
"Refrigerated",
"DryIce",
"Perishable",
"NoRTS"
],
"type": "string",
"description": "Specify Lasership Attributes (Lasership only). Multiple options accepted."
},
"qr_code_requested": {
"type": "boolean",
"description": "Request a QR code for a given transaction when creating a shipping label (USPS domestic and Evri UK only)."
},
"saturday_delivery": {
"type": "boolean",
"description": "Marks shipment as to be delivered on a Saturday."
},
"authority_to_leave": {
"type": "boolean",
"description": "Request `true` to give carrier permission to leave the parcel in a safe place if no one answers the \ndoor (where supported). When set to `false`, if no one is available to receive the item, the parcel \nwill not be left (*surcharges may be applicable)."
},
"critical_pull_time": {
"type": "string",
"description": "Carrier arrival time to pickup packages from the fulfillment center. \nUTC format: `%Y-%m-%dT%H:%M:%SZ`"
},
"customer_reference": {
"$ref": "#/components/schemas/CustomerReference"
},
"fulfillment_center": {
"type": "string",
"description": "The fulfilment center where the package originates from."
},
"return_service_type": {
"enum": [
"PRINT_AND_MAIL",
"ATTEMPT_1",
"ATTEMPT_3",
"ELECTRONIC_LABEL"
],
"type": "string",
"description": "Request additional return option for return shipments (UPS only)."
},
"dangerous_goods_code": {
"enum": [
"01",
"02",
"03",
"04",
"05",
"06",
"07",
"08",
"09"
],
"type": "string",
"description": "Dangerous Goods Code (DHL eCommerce only). See <a href=\"https://api-legacy.dhlecs.com/docs/v2/appendix.html#dangerous-goods\">Category Codes</a>"
},
"request_retail_rates": {
"type": "boolean",
"description": "Returns retail rates instead of account-based rates (UPS and FedEx only)."
},
"ancillary_endorsement": {
"enum": [
"FORWARDING_SERVICE_REQUESTED",
"RETURN_SERVICE_REQUESTED"
],
"type": "string",
"description": "Specify an ancillary service endorsement to provide the USPS with instructions on how to handle undeliverable-as-addressed pieces (DHL eCommerce only)."
},
"delivery_instructions": {
"type": "string",
"description": "Specify delivery instructions. Up to 500 characters. (FedEx and OnTrac only)."
},
"signature_confirmation": {
"enum": [
"STANDARD",
"ADULT",
"CERTIFIED",
"INDIRECT",
"CARRIER_CONFIRMATION"
],
"type": "string",
"description": "Request standard or adult signature confirmation. You can alternatively request Certified Mail (USPS only) \nor Indirect signature (FedEx only) or Carrier Confirmation (Deutsche Post only)."
},
"carrier_hub_travel_time": {
"type": "integer",
"description": "Travel time in hours from fulfillment center to carrier injection site."
},
"lasership_declared_value": {
"type": "string",
"description": "Declared value (Lasership only). Defaults to `50.00`."
},
"bypass_address_validation": {
"type": "boolean",
"description": "Bypasses address validation (USPS, UPS, & LaserShip only)."
},
"preferred_delivery_timeframe": {
"enum": [
"10001200",
"12001400",
"14001600",
"16001800",
"18002000",
"19002100"
],
"type": "string",
"description": "Required for DHL Germany Paket Sameday. Designates a desired timeframe for delivery. Format is `HHMMHHMM`"
}
},
"description": "An object holding optional extra services to be requested."
}
ShipmentPaginatedList
{
"allOf": [
{
"$ref": "#/components/schemas/PaginatedList"
},
{
"properties": {
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Shipment"
}
}
}
}
]
}
ShippoAccount
{
"type": "object",
"required": [
"first_name",
"last_name",
"email",
"company_name"
],
"properties": {
"email": {
"type": "string",
"example": "hippo@shippo.com"
},
"last_name": {
"type": "string",
"example": "Meister"
},
"object_id": {
"type": "string",
"example": "adcfdddf8ec64b84ad22772bce3ea37a"
},
"first_name": {
"type": "string",
"example": "Shippo"
},
"company_name": {
"type": "string",
"example": "Acme"
},
"object_created": {
"type": "string",
"format": "date-time"
},
"object_updated": {
"type": "string",
"format": "date-time"
}
}
}
ShippoAccountPaginatedList
{
"allOf": [
{
"$ref": "#/components/schemas/PaginatedList"
},
{
"properties": {
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ShippoAccount"
}
}
}
}
]
}
ShippoAccountUpdateRequest
{
"type": "object",
"title": "ShippoAccountUpdateRequest represents the fields of a shippo account before saving it to the db.",
"required": [
"first_name",
"last_name",
"email",
"company_name"
],
"properties": {
"email": {
"type": "string",
"example": "hippo@shippo.com"
},
"last_name": {
"type": "string",
"example": "Meister"
},
"first_name": {
"type": "string",
"example": "Shippo"
},
"company_name": {
"type": "string",
"example": "Acme"
}
}
}
Track
{
"type": "object",
"required": [
"carrier",
"tracking_number",
"address_from",
"servicelevel",
"tracking_history",
"messages"
],
"properties": {
"eta": {
"type": "string",
"format": "date-time",
"description": "The estimated time of arrival according to the carrier, this might be updated by carriers during the life of the shipment."
},
"carrier": {
"type": "string",
"example": "usps",
"description": "Name of the carrier of the shipment to track. See <a href=\"#tag/Carriers\">Carriers</a>."
},
"messages": {
"type": "array",
"items": {
"type": "string"
}
},
"metadata": {
"type": "string",
"example": "Order 000123",
"description": "A string of up to 100 characters that can be filled with any additional information you want to attach to the object."
},
"address_to": {
"$ref": "#/components/schemas/TrackingStatusLocationBase"
},
"transaction": {
"type": "string",
"description": "The <code>object_id</code> of the transaction associated with this tracking object. \nThis field is visible only to the object owner of the transaction."
},
"address_from": {
"$ref": "#/components/schemas/TrackingStatusLocationBase"
},
"original_eta": {
"type": "string",
"format": "date-time",
"example": "2021-07-23T00:00:00Z",
"description": "The estimated time of arrival according to the carrier at the time the shipment first entered the system."
},
"servicelevel": {
"$ref": "#/components/schemas/ServiceLevel"
},
"tracking_number": {
"type": "string",
"example": "9205590164917312751089",
"description": "Tracking number to track."
},
"tracking_status": {
"$ref": "#/components/schemas/TrackingStatus"
},
"tracking_history": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TrackingStatus"
},
"description": "A list of tracking events, following the same structure as <code>tracking_status</code>. \nIt contains a full history of all tracking statuses, starting with the earlier tracking event first."
}
}
}
TrackingStatus
{
"type": "object",
"required": [
"object_created",
"object_updated",
"object_id",
"status",
"status_details",
"status_date",
"location"
],
"properties": {
"status": {
"$ref": "#/components/schemas/TrackingStatusEnum"
},
"location": {
"$ref": "#/components/schemas/TrackingStatusLocationBase"
},
"object_id": {
"type": "string"
},
"substatus": {
"$ref": "#/components/schemas/TrackingStatusSubstatus"
},
"status_date": {
"type": "string",
"format": "date-time",
"example": "2016-07-23T00:00:00Z",
"description": "Date and time when the carrier scanned this tracking event. This is displayed in UTC."
},
"object_created": {
"type": "string",
"format": "date-time"
},
"object_updated": {
"type": "string",
"format": "date-time"
},
"status_details": {
"type": "string",
"example": "Your shipment has been delivered at the destination mailbox.",
"description": "The human-readable description of the status."
}
},
"description": "The latest tracking information of this shipment."
}
TrackingStatusEnum
{
"enum": [
"UNKNOWN",
"PRE_TRANSIT",
"TRANSIT",
"DELIVERED",
"RETURNED",
"FAILURE"
],
"type": "string",
"example": "DELIVERED",
"description": "Indicates the high level status of the shipment."
}
TrackingStatusLocationBase
{
"type": "object",
"properties": {
"zip": {
"type": "string",
"example": "89101"
},
"city": {
"type": "string",
"example": "Las Vegas"
},
"state": {
"type": "string",
"example": "NV"
},
"country": {
"type": "string",
"example": "US"
}
}
}
TrackingStatusSubstatus
{
"type": "object",
"required": [
"code",
"text",
"action_required"
],
"properties": {
"code": {
"type": "string",
"example": "information_received",
"description": "A code that represents the substatus of the shipment. See the <a href=\"https://docs.goshippo.com/docs/tracking/tracking/#event-definitions\">Event Definitions</a> for more information."
},
"text": {
"type": "string",
"example": "Information about the package received.",
"description": "A human-readable description of the substatus. See the <a href=\"https://docs.goshippo.com/docs/tracking/tracking/#event-definitions\">Event Definitions</a> for more information."
},
"action_required": {
"type": "boolean",
"description": "Indicates whether the substatus requires action from the shipper or recipient to complete delivery."
}
},
"description": "A finer-grained classification of the tracking event."
}
TracksRequest
{
"type": "object",
"required": [
"carrier",
"tracking_number"
],
"properties": {
"carrier": {
"type": "string",
"example": "usps",
"description": "Name of the carrier of the shipment to track."
},
"metadata": {
"type": "string",
"example": "Order 000123",
"description": "A string of up to 100 characters that can be filled with any additional information you want to attach to the object."
},
"tracking_number": {
"type": "string",
"example": "9205590164917312751089",
"description": "Tracking number to track."
}
}
}
Transaction
{
"type": "object",
"properties": {
"eta": {
"type": "string",
"description": "The estimated time of arrival according to the carrier."
},
"rate": {
"type": "string",
"example": "ec9f0d3adc9441449c85d315f0997fd5",
"description": "ID of the Rate object for which a Label has to be obtained. \nPlease note that only rates that are not older than 7 days can be purchased in order to ensure up-to-date pricing."
},
"test": {
"type": "boolean",
"description": "Indicates whether the object has been created in test mode."
},
"status": {
"$ref": "#/components/schemas/TransactionStatusEnum"
},
"messages": {
"type": "array",
"items": {
"type": "object"
},
"example": [],
"description": "An array containing elements of the following schema:<br>\n`code` (string): an identifier for the corresponding message (not always available)<br>\n`message` (string): a publishable message containing further information."
},
"metadata": {
"type": "string",
"description": "A string of up to 100 characters that can be filled with any additional information you want to \nattach to the object."
},
"label_url": {
"type": "string",
"example": "https://shippo-delivery.s3.amazonaws.com/70ae8117ee1749e393f249d5b77c45e0.pdf?Signature=vDw1ltcyGveVR1OQoUDdzC43BY8%3D&Expires=1437093830&AWSAccessKeyId=AKIAJTHP3LLFMYAWALIA",
"description": "A URL pointing directly to the label in the format you've set in your settings. \nA value will only be returned if the Transactions has been processed successfully."
},
"object_id": {
"type": "string",
"example": "915d94940ea54c3a80cbfa328722f5a1",
"description": "Unique identifier of the given Transaction object."
},
"qr_code_url": {
"type": "string",
"example": "https://shippo-delivery.s3.amazonaws.com/96_qr_code.pdf?Signature=PEdWrp0mFWAGwJp7FW3b%2FeA2eyY%3D&Expires=1385930652&AWSAccessKeyId=AKIAJTHP3LLFMYAWALIA",
"description": "A URL pointing directly to the QR code in PNG format. \nA value will only be returned if requested using qr_code_requested flag and the carrier provides such an option."
},
"object_owner": {
"type": "string",
"example": "shippotle@shippo.com",
"description": "Username of the user who created the Transaction object."
},
"object_state": {
"$ref": "#/components/schemas/ObjectStateEnum"
},
"object_created": {
"type": "string",
"format": "date-time",
"description": "Date and time of Transaction creation."
},
"object_updated": {
"type": "string",
"format": "date-time",
"description": "Date and time of last Transaction update."
},
"label_file_type": {
"$ref": "#/components/schemas/LabelFileTypeEnum"
},
"tracking_number": {
"type": "string",
"example": "9499907123456123456781",
"description": "The carrier-specific tracking number that can be used to track the Shipment. \nA value will only be returned if the Rate is for a trackable Shipment and if the Transactions has been processed successfully."
},
"tracking_status": {
"$ref": "#/components/schemas/TrackingStatusEnum"
},
"tracking_url_provider": {
"type": "string",
"example": "https://tools.usps.com/go/TrackConfirmAction_input?origTrackNum=9499907123456123456781",
"description": "A link to track this item on the carrier-provided tracking website. \nA value will only be returned if tracking is available and the carrier provides such a service."
},
"commercial_invoice_url": {
"type": "string",
"description": "A URL pointing to the commercial invoice as a 8.5x11 inch PDF file. \nA value will only be returned if the Transactions has been processed successfully and if the shipment is international."
}
}
}
TransactionCreateRequest
{
"type": "object",
"required": [
"rate"
],
"properties": {
"rate": {
"type": "string",
"example": "ec9f0d3adc9441449c85d315f0997fd5"
},
"async": {
"type": "boolean",
"example": false
},
"metadata": {
"type": "string",
"example": "Order ID #12345"
},
"label_file_type": {
"$ref": "#/components/schemas/LabelFileTypeEnum"
}
}
}