API Docs
Customers need to quickly change and add carriers without incurring costly and
restrictive technical debt. Every carrier has different integration methods, requiring
a new development project for every new or updated carrier. This workload compounds as
you expand globally and work with a larger number of carriers.
The Zenkraft API integrates directly with shipping carriers such as
FedEx, UPS, and
DHL through a single platform. Integrate with Zenkraft’s
developer-friendly API and let Zenkraft handle the complexities of global carrier
integration.
This page includes examples of the Zenkraft API’s structure and parameters. Select a
carrier from the dropdown list in the navigation menu to access API reference
documentation listing their required and accepted parameters.
FedEx Overview
Please find the documentation for the FedEx below.
Supported Methods
Shipping Account ✔ Ship ✔ Rate ✔ Track ✔ Cancel ✔ Pickup ✔ Dopu ✔ Pickup_availability ✔ Webhook ✔Authentication
The Zenkraft API uses a bearer token to authenticate. If you do not have one, please contact support.
Base URL
/shippingaccount POST
The /shippingaccount endpoint enables you to use your carrier account credentials to create a Shipping Acccount ID in the Zenkraft system. This is used for all future API calls listed below.
POST Request Parameters
Field | Possible Values | Example |
---|---|---|
shipping_account object required |
|
|
auth object Carrier credentials which are specific to each carrier | {'meter_number': 'Meter Number', 'key': 'Key', 'password': 'Password', 'account_number': 'Account Number', 'hub_id': 'Hub ID', 'client_id': 'Client ID', 'client_secret': 'Client secret', 'fulfillment_email': 'Fulfillment email', 'fulfillment_password': 'Fulfillment password'} |
|
account_number string Account Number required | Account Number |
|
client_id string Client ID | Client ID |
|
client_secret string Client secret | Client secret |
|
fulfillment_email string Fulfillment email | Fulfillment email |
|
fulfillment_password string Fulfillment password | Fulfillment password |
|
hub_id string Hub ID | Hub ID |
|
key string Key | Key |
|
meter_number string Meter Number | Meter Number |
|
password string Password | Password |
|
billing_address object |
|
|
city string the city of the recipient required | Burlington |
|
company string the company name of the recipient | Burlington Textiles Corp of America |
|
country string required | HK ZM DE LA PS SC LY BV TW ZA VN SA PG BG MM TZ TF IS US MV GU MP RS EC MU GL PA SV PR KH MH OM AG SH WF ZW TN JM AU MR SE MZ ST CI UA RU VI NO SI SJ BB WS AS SZ SD AZ GS ML ES DM AT BL AF MY PK TV NA SK BF SL FI TM BN GA AL SO FR DK TH PE CU GI GW TT GY HT TO SN MC SG GP TG TR LT CO BS IO CR AI DJ HM RE BH AX TK NZ VA ET BD TC BJ FO NL KR VE TJ EH BR EE CZ LI TL LV SM TD VU JO GT HU UM BE RW RO NR AQ BT NG CL KG MQ MT PL SS KN GQ PM HN BA IR CK PY PH YE IM CA LB CM ER IQ LC QA AR AO AE KZ CF FJ KE LS CN GB CD CY IN CH BO GG NC KW PW BM MX CW UG CG GE IL MS BI UY HR MN GH CV VG GM IE JP MF AW FM ME JE NE SB BY NI BQ KY MA KM AD DZ CX DO MO YT SR MW AM EG KI MD NF UZ VC LU BZ ID PT LR GD SY GF MG MK SX BW PN FK GR GN NU LK PF KP NP IT CC |
US |
email string the email address of the recipient | jrogers@example.com |
|
name string the name of the recipient required | Jack O'Rogers |
|
phone string the phone number of the recipient | (336) 222-7000 |
|
postal_code string the postal code / zip number of the recipient. Specific format depends on the country | 27215 |
|
state string the state of the recipient | NC |
|
street1 string the first line of the street address of the recipient required | 525 S. ZENKRAFT Ave |
|
street2 string the second line of the street address of the recipient | suite 120 |
|
street3 string the third line of the street address of the recipient | suite 120 |
|
carrier string Carrier slug required | fedex |
|
country string required | HK ZM DE LA PS SC LY BV TW ZA VN SA PG BG MM TZ TF IS US MV GU MP RS EC MU GL PA SV PR KH MH OM AG SH WF ZW TN JM AU MR SE MZ ST CI UA RU VI NO SI SJ BB WS AS SZ SD AZ GS ML ES DM AT BL AF MY PK TV NA SK BF SL FI TM BN GA AL SO FR DK TH PE CU GI GW TT GY HT TO SN MC SG GP TG TR LT CO BS IO CR AI DJ HM RE BH AX TK NZ VA ET BD TC BJ FO NL KR VE TJ EH BR EE CZ LI TL LV SM TD VU JO GT HU UM BE RW RO NR AQ BT NG CL KG MQ MT PL SS KN GQ PM HN BA IR CK PY PH YE IM CA LB CM ER IQ LC QA AR AO AE KZ CF FJ KE LS CN GB CD CY IN CH BO GG NC KW PW BM MX CW UG CG GE IL MS BI UY HR MN GH CV VG GM IE JP MF AW FM ME JE NE SB BY NI BQ KY MA KM AD DZ CX DO MO YT SR MW AM EG KI MD NF UZ VC LU BZ ID PT LR GD SY GF MG MK SX BW PN FK GR GN NU LK PF KP NP IT CC |
US |
defaults object |
|
|
currency string | GNF KZT AED HUF GTQ FKP GMD CHF SZL BWP TND BAM TOP CZK INR HTG GHS ZMW CDF SPL AOA KYD XAF TTD GIP MRU UGX IRR MXN BZD GGP MGA NOK PAB PHP RON RUB LKR CUC BOB BTN KGS MUR EUR AUD ZWD BIF SEK USD AWG KWD XOF SLL BYN PKR XPF BHD TZS SCR OMR MWK MVR VND GEL BGN DKK CUP SOS RSD PEN SDG NAD SVC HKD STN LRD JOD SYP TMT BSD GBP NGN ANG ARS AFN TWD NIO WST TRY ALL JEP LYD MKD BND ZAR SAR PGK NPR DJF NZD TJS HRK AMD MZN UYU BMD PYG CAD SGD CLP KRW BRL ILS JPY YER KHR MYR CRC QAR DZD COP MAD LBP VUV XDR VEF UAH ISK MDL BDT SRD CVE HNL XCD MMK GYD IMP LAK TVD KES AZN DOP ETB PLN THB FJD KMF IQD SBD UZS MOP BBD IDR KPW SHP CNY ERN MNT EGP LSL JMD RWF |
|
dim_units string Dimension units of the packages, inches or centimeters | IN CM |
IN |
label_type string Label Type | PDF PDF__PAPER_4X6 PDF__PAPER_4X8 PDF__PAPER_4X9 PDF__PAPER_7X4.75 PDF__PAPER_8.5X11_BOTTOM_HALF_LABEL PDF__PAPER_8.5X11_TOP_HALF_LABEL PNG PNG__PAPER_4X6 PNG__PAPER_4X8 PNG__PAPER_4X9 PNG__PAPER_7X4.75 PNG__PAPER_8.5X11_BOTTOM_HALF_LABEL PNG__PAPER_8.5X11_TOP_HALF_LABEL EPL2 EPL2__STOCK_4X6 EPL2__STOCK_4X6.75_TRAILING_DOC_TAB EPL2__STOCK_4X8 EPL2__STOCK_4X9_LEADING_DOC_TAB EPL2__STOCK_4X9_TRAILING_DOC_TAB ZPLII ZPLII__STOCK_4X6 ZPLII__STOCK_4X6.75_LEADING_DOC_TAB ZPLII__STOCK_4X6.75_TRAILING_DOC_TAB ZPLII__STOCK_4X8 ZPLII__STOCK_4X9_LEADING_DOC_TAB ZPLII__STOCK_4X9_TRAILING_DOC_TAB |
PDF |
packaging_type string Packaging Type | fedex_10kg_box fedex_25kg_box fedex_box fedex_envelope fedex_pak fedex_tube your_packaging |
fedex_10kg_box |
service string Service Type | fedex_1_day_freight fedex_2_day fedex_2_day_am fedex_2_day_freight fedex_3_day_freight fedex_express_saver fedex_first_freight fedex_freight_economy fedex_freight_priority fedex_ground fedex_first_overnight fedex_ground_home_delivery fedex_priority_overnight fedex_smart_post_media_mail fedex_smart_post_parcel_select fedex_smart_post_presorted_bound_printed_matter fedex_smart_post_presorted_standard fedex_smart_post_parcel_return fedex_standard_overnight fedex_europe_first_international_priority fedex_international_economy fedex_international_economy_freight fedex_international_first fedex_international_priority fedex_international_priority_express fedex_international_priority_freight fedex_next_day_early_morning fedex_next_day_mid_morning fedex_next_day_afternoon fedex_next_day_end_of_day fedex_distance_deferred fedex_next_day_freight fedex_regional_economy fedex_international_connect_plus fedex_first fedex_priority fedex_priority_express international_priority international_express |
fedex_1_day_freight |
weight_units string Weight units of the packages, pounds or kilograms | KG LB |
LB |
location_id string Location ID | 0d349ee54a8c4d0dbc61b1a3ac1ab1f4 |
|
name string Account name | My fedex test account |
|
parent_shipping_account string Shipping account key to link this account to. This is useful when you want to create a sub-account |
|
|
test boolean If you specify test flag and omit `auth` key, we'll try to create a shipping account with our test credentials for the carrier/country combination specified |
|
Successful Response
Field | Possible Values | Example |
---|---|---|
shipping_account object |
|
|
auth object Carrier credentials which are specific to each carrier | {'meter_number': 'Meter Number', 'key': 'Key', 'password': 'Password', 'account_number': 'Account Number', 'hub_id': 'Hub ID', 'client_id': 'Client ID', 'client_secret': 'Client secret', 'fulfillment_email': 'Fulfillment email', 'fulfillment_password': 'Fulfillment password'} |
|
account_number string Account Number required | Account Number |
|
client_id string Client ID | Client ID |
|
client_secret string Client secret | Client secret |
|
fulfillment_email string Fulfillment email | Fulfillment email |
|
fulfillment_password string Fulfillment password | Fulfillment password |
|
hub_id string Hub ID | Hub ID |
|
key string Key | Key |
|
meter_number string Meter Number | Meter Number |
|
password string Password | Password |
|
carrier string Carrier slug required | fedex |
|
country string required | HK ZM DE LA PS SC LY BV TW ZA VN SA PG BG MM TZ TF IS US MV GU MP RS EC MU GL PA SV PR KH MH OM AG SH WF ZW TN JM AU MR SE MZ ST CI UA RU VI NO SI SJ BB WS AS SZ SD AZ GS ML ES DM AT BL AF MY PK TV NA SK BF SL FI TM BN GA AL SO FR DK TH PE CU GI GW TT GY HT TO SN MC SG GP TG TR LT CO BS IO CR AI DJ HM RE BH AX TK NZ VA ET BD TC BJ FO NL KR VE TJ EH BR EE CZ LI TL LV SM TD VU JO GT HU UM BE RW RO NR AQ BT NG CL KG MQ MT PL SS KN GQ PM HN BA IR CK PY PH YE IM CA LB CM ER IQ LC QA AR AO AE KZ CF FJ KE LS CN GB CD CY IN CH BO GG NC KW PW BM MX CW UG CG GE IL MS BI UY HR MN GH CV VG GM IE JP MF AW FM ME JE NE SB BY NI BQ KY MA KM AD DZ CX DO MO YT SR MW AM EG KI MD NF UZ VC LU BZ ID PT LR GD SY GF MG MK SX BW PN FK GR GN NU LK PF KP NP IT CC |
US |
defaults object required |
|
|
currency string | GNF KZT AED HUF GTQ FKP GMD CHF SZL BWP TND BAM TOP CZK INR HTG GHS ZMW CDF SPL AOA KYD XAF TTD GIP MRU UGX IRR MXN BZD GGP MGA NOK PAB PHP RON RUB LKR CUC BOB BTN KGS MUR EUR AUD ZWD BIF SEK USD AWG KWD XOF SLL BYN PKR XPF BHD TZS SCR OMR MWK MVR VND GEL BGN DKK CUP SOS RSD PEN SDG NAD SVC HKD STN LRD JOD SYP TMT BSD GBP NGN ANG ARS AFN TWD NIO WST TRY ALL JEP LYD MKD BND ZAR SAR PGK NPR DJF NZD TJS HRK AMD MZN UYU BMD PYG CAD SGD CLP KRW BRL ILS JPY YER KHR MYR CRC QAR DZD COP MAD LBP VUV XDR VEF UAH ISK MDL BDT SRD CVE HNL XCD MMK GYD IMP LAK TVD KES AZN DOP ETB PLN THB FJD KMF IQD SBD UZS MOP BBD IDR KPW SHP CNY ERN MNT EGP LSL JMD RWF |
|
dim_units string Dimension units of the packages, inches or centimeters | IN CM |
IN |
label_type string Label Type | PDF PDF__PAPER_4X6 PDF__PAPER_4X8 PDF__PAPER_4X9 PDF__PAPER_7X4.75 PDF__PAPER_8.5X11_BOTTOM_HALF_LABEL PDF__PAPER_8.5X11_TOP_HALF_LABEL PNG PNG__PAPER_4X6 PNG__PAPER_4X8 PNG__PAPER_4X9 PNG__PAPER_7X4.75 PNG__PAPER_8.5X11_BOTTOM_HALF_LABEL PNG__PAPER_8.5X11_TOP_HALF_LABEL EPL2 EPL2__STOCK_4X6 EPL2__STOCK_4X6.75_TRAILING_DOC_TAB EPL2__STOCK_4X8 EPL2__STOCK_4X9_LEADING_DOC_TAB EPL2__STOCK_4X9_TRAILING_DOC_TAB ZPLII ZPLII__STOCK_4X6 ZPLII__STOCK_4X6.75_LEADING_DOC_TAB ZPLII__STOCK_4X6.75_TRAILING_DOC_TAB ZPLII__STOCK_4X8 ZPLII__STOCK_4X9_LEADING_DOC_TAB ZPLII__STOCK_4X9_TRAILING_DOC_TAB |
PDF |
packaging_type string Packaging Type | fedex_10kg_box fedex_25kg_box fedex_box fedex_envelope fedex_pak fedex_tube your_packaging |
fedex_10kg_box |
service string Service Type | fedex_1_day_freight fedex_2_day fedex_2_day_am fedex_2_day_freight fedex_3_day_freight fedex_express_saver fedex_first_freight fedex_freight_economy fedex_freight_priority fedex_ground fedex_first_overnight fedex_ground_home_delivery fedex_priority_overnight fedex_smart_post_media_mail fedex_smart_post_parcel_select fedex_smart_post_presorted_bound_printed_matter fedex_smart_post_presorted_standard fedex_smart_post_parcel_return fedex_standard_overnight fedex_europe_first_international_priority fedex_international_economy fedex_international_economy_freight fedex_international_first fedex_international_priority fedex_international_priority_express fedex_international_priority_freight fedex_next_day_early_morning fedex_next_day_mid_morning fedex_next_day_afternoon fedex_next_day_end_of_day fedex_distance_deferred fedex_next_day_freight fedex_regional_economy fedex_international_connect_plus fedex_first fedex_priority fedex_priority_express international_priority international_express |
fedex_1_day_freight |
weight_units string Weight units of the packages, pounds or kilograms | KG LB |
LB |
id string Shipping account number required | 5190163571408896 |
|
location_id string Location ID | 0d349ee54a8c4d0dbc61b1a3ac1ab1f4 |
|
name string Account name | My fedex test account |
|
parent_shipping_account string Shipping account key to link this account to. This is useful when you want to create a sub-account |
|
|
test boolean If you specify test flag and omit `auth` key, we'll try to create a shipping account with our test credentials for the carrier/country combination specified |
|
Error Response
Field | Possible Values | Example |
---|---|---|
error object |
|
|
code string Standardized error code required | shipping_account_not_found unexpected_exception master_test_shipping_account_not_found schema_field_required shipping_account_wrong_carrier schema_validation_error wrong_api_key missing_api_key |
master_test_shipping_account_not_found |
detail string This field can contain additional information about the error. This field is not meant to be shown to the end-user required |
|
|
message object Error message required | Master shipping account for fedex in US does not exist |
/ship POST
The shipping endpoint is used to book shipments with FedEx. It will return a shipping label and tracking number in the response.
POST Request Parameters
Field | Possible Values | Example |
---|---|---|
shipment object Definition of the shipment payload required |
|
|
carrier string the carrier name required | fedex |
|
currency string | GNF KZT AED HUF GTQ FKP GMD CHF SZL BWP TND BAM TOP CZK INR HTG GHS ZMW CDF SPL AOA KYD XAF TTD GIP MRU UGX IRR MXN BZD GGP MGA NOK PAB PHP RON RUB LKR CUC BOB BTN KGS MUR EUR AUD ZWD BIF SEK USD AWG KWD XOF SLL BYN PKR XPF BHD TZS SCR OMR MWK MVR VND GEL BGN DKK CUP SOS RSD PEN SDG NAD SVC HKD STN LRD JOD SYP TMT BSD GBP NGN ANG ARS AFN TWD NIO WST TRY ALL JEP LYD MKD BND ZAR SAR PGK NPR DJF NZD TJS HRK AMD MZN UYU BMD PYG CAD SGD CLP KRW BRL ILS JPY YER KHR MYR CRC QAR DZD COP MAD LBP VUV XDR VEF UAH ISK MDL BDT SRD CVE HNL XCD MMK GYD IMP LAK TVD KES AZN DOP ETB PLN THB FJD KMF IQD SBD UZS MOP BBD IDR KPW SHP CNY ERN MNT EGP LSL JMD RWF |
|
debug boolean calls with debug=true will be logged |
|
|
dim_units string Dimension units of the packages, inches or centimeters required | IN CM |
IN |
documents array |
|
|
document string document content |
|
|
document_type string file format of the document | pdf |
|
id string uploaded document ID |
|
|
include_base64_label boolean If this is enabled, base64 label is returned |
|
|
label_size string | PAPER_4X6 PAPER_4X8 STOCK_4X8 PAPER_8.5X11_BOTTOM_HALF_LABEL PAPER_7X4.75 STOCK_4X6.75_LEADING_DOC_TAB STOCK_4X6 PAPER_8.5X11_TOP_HALF_LABEL STOCK_4X9_TRAILING_DOC_TAB STOCK_4X9_LEADING_DOC_TAB PAPER_4X9 STOCK_4X6.75_TRAILING_DOC_TAB |
PAPER_4X6 |
label_type string the label format of the shipping labels required | PDF PDF__PAPER_4X6 PDF__PAPER_4X8 PDF__PAPER_4X9 PDF__PAPER_7X4.75 PDF__PAPER_8.5X11_BOTTOM_HALF_LABEL PDF__PAPER_8.5X11_TOP_HALF_LABEL PNG PNG__PAPER_4X6 PNG__PAPER_4X8 PNG__PAPER_4X9 PNG__PAPER_7X4.75 PNG__PAPER_8.5X11_BOTTOM_HALF_LABEL PNG__PAPER_8.5X11_TOP_HALF_LABEL EPL2 EPL2__STOCK_4X6 EPL2__STOCK_4X6.75_TRAILING_DOC_TAB EPL2__STOCK_4X8 EPL2__STOCK_4X9_LEADING_DOC_TAB EPL2__STOCK_4X9_TRAILING_DOC_TAB ZPLII ZPLII__STOCK_4X6 ZPLII__STOCK_4X6.75_LEADING_DOC_TAB ZPLII__STOCK_4X6.75_TRAILING_DOC_TAB ZPLII__STOCK_4X8 ZPLII__STOCK_4X9_LEADING_DOC_TAB ZPLII__STOCK_4X9_TRAILING_DOC_TAB |
PDF |
notifications array |
|
|
type string type of the notification needed | email sms |
email |
value string value of the notification | notification1@example.com |
|
packages array required |
|
|
height number height of the package according to units specified under dim_units | 5 |
|
length number length of the package according to units specified under dim_units. ususally the length needs to be the largest of length, width, height | 11 |
|
value number value of the package according to currency specified | 25 |
|
weight number weight of the package according to units specified under weight_units | 4.2 |
|
width number width of the package according to units specified under dim_units | 8.5 |
|
packaging string the packaging type required | your_packaging |
your_packaging |
recipient object Recipient of shiment required |
|
|
city string the city of the recipient required | Burlington |
|
company string the company name of the recipient | Burlington Textiles Corp of America |
|
country string required | HK DE LA PS SC LY BV TW ZA VN SA PG BG TZ MM US TF IS MV GU MP RS EC MU GL PA SV PR KH MH OM AG SH WF ZW TN JM AU MR SE MZ ST CI UA RU VI NO SI SJ BB WS AS SD AZ GS ML ES DM AT BL AF MY PK TV NA SL SK BF FI TM BN GA AL SO FR DK TH CU GI GW TT GY HT TO SN MC TR GP TG LT CO BS IO CR AI DJ HM RE BH AX TK NZ VA ET BD TC BJ FO NL KR VE TJ EH BR EE CZ LI TL LV SM TD VU JO GT HU UM BE RW RO NR AQ BT NG CL KG MQ MT PL SS KN GQ PM HN BA IR CK PY PH YE IM CA LB CM ER IQ LC QA AR AO AE SZ ZM SG KZ CF FJ KE LS PW CN GB CD CY IN CH BO GG NC KW BM MX CW UG CG GE IL MS BI UY HR MN GH CV VG GM IE JP NE AW FM ME JE SB BY NI BQ KY MA KM AD DZ CX DO MO YT SR MW AM EG KI MD NF UZ VC NP LU BZ ID PT LR GD SY GF MG MK SX BW PN FK GR CC GN NU LK PF KP PE IT MF |
US |
email string the email address of the recipient | jrogers@example.com |
|
name string the name of the recipient required | Jack O'Rogers |
|
phone string the phone number of the recipient | (336) 222-7000 |
|
postal_code string the postal code / zip number of the recipient. Specific format depends on the country | 27215 |
|
state string the state of the recipient | NC |
|
street1 string the first line of the street address of the recipient required | 525 S. ZENKRAFT Ave |
|
street2 string the second line of the street address of the recipient | suite 120 |
|
street3 string the third line of the street address of the recipient | suite 120 |
|
references array |
|
|
type string type of reference | customer_reference |
|
value string value of the reference | ABC-000123 |
|
sender object Sender of shiment required |
|
|
city string the city of the recipient required | Burlington |
|
company string the company name of the recipient | Burlington Textiles Corp of America |
|
country string required | HK DE LA PS SC LY BV TW ZA VN SA PG BG TZ MM US TF IS MV GU MP RS EC MU GL PA SV PR KH MH OM AG SH WF ZW TN JM AU MR SE MZ ST CI UA RU VI NO SI SJ BB WS AS SD AZ GS ML ES DM AT BL AF MY PK TV NA SL SK BF FI TM BN GA AL SO FR DK TH CU GI GW TT GY HT TO SN MC TR GP TG LT CO BS IO CR AI DJ HM RE BH AX TK NZ VA ET BD TC BJ FO NL KR VE TJ EH BR EE CZ LI TL LV SM TD VU JO GT HU UM BE RW RO NR AQ BT NG CL KG MQ MT PL SS KN GQ PM HN BA IR CK PY PH YE IM CA LB CM ER IQ LC QA AR AO AE SZ ZM SG KZ CF FJ KE LS PW CN GB CD CY IN CH BO GG NC KW BM MX CW UG CG GE IL MS BI UY HR MN GH CV VG GM IE JP NE AW FM ME JE SB BY NI BQ KY MA KM AD DZ CX DO MO YT SR MW AM EG KI MD NF UZ VC NP LU BZ ID PT LR GD SY GF MG MK SX BW PN FK GR CC GN NU LK PF KP PE IT MF |
US |
email string the email address of the recipient | jrogers@example.com |
|
name string the name of the recipient required | Jack O'Rogers |
|
phone string the phone number of the recipient | (336) 222-7000 |
|
postal_code string the postal code / zip number of the recipient. Specific format depends on the country | 27215 |
|
state string the state of the recipient | NC |
|
street1 string the first line of the street address of the recipient required | 525 S. ZENKRAFT Ave |
|
street2 string the second line of the street address of the recipient | suite 120 |
|
street3 string the third line of the street address of the recipient | suite 120 |
|
service string the service type required | fedex_1_day_freight fedex_2_day fedex_2_day_am fedex_2_day_freight fedex_3_day_freight fedex_express_saver fedex_first_freight fedex_freight_economy fedex_freight_priority fedex_ground fedex_first_overnight fedex_ground_home_delivery fedex_priority_overnight fedex_smart_post_media_mail fedex_smart_post_parcel_select fedex_smart_post_presorted_bound_printed_matter fedex_smart_post_presorted_standard fedex_smart_post_parcel_return fedex_standard_overnight fedex_europe_first_international_priority fedex_international_economy fedex_international_economy_freight fedex_international_first fedex_international_priority fedex_international_priority_express fedex_international_priority_freight fedex_next_day_early_morning fedex_next_day_mid_morning fedex_next_day_afternoon fedex_next_day_end_of_day fedex_distance_deferred fedex_next_day_freight fedex_regional_economy fedex_international_connect_plus fedex_first fedex_priority fedex_priority_express international_priority international_express |
fedex_1_day_freight |
ship_date string shipping date | 2021-06-07 |
|
shipping_account string Shipping account number required | 5190163571408896 |
|
special_services array | saturday_delivery no_freight_rate list_rates paperless_trade include_qr |
[saturday_delivery ] |
test boolean calls created with test = true will be directed to the carrier test servers |
|
|
type string outbound or return shipments | return outbound |
outbound |
weight_units string Weight units of the packages, pounds or kilograms required | KG LB |
LB |
Successful Response
Most important parts of the response:tracking_number
which can be used to track the shipments in the track endpointlabel
for each package which needs to be printed and attached to the shipment
Field | Possible Values | Example |
---|---|---|
shipment object |
|
|
context object this object can contain custom data returned by the carrier |
|
|
costs object Additional information about packages |
|
|
base_charge number gross amount | 100 |
|
discounts number the cost of discounts applied | 0 |
|
net_charge number net amount | 80 |
|
surcharges number additional fees | 0 |
|
taxes number the cost of taxes | 20 |
|
id string shipment ID | 1f02d12868a54ed88b6cb4dafaad325d |
|
label_size string | PAPER_4X6 PAPER_4X8 STOCK_4X8 PAPER_8.5X11_BOTTOM_HALF_LABEL PAPER_7X4.75 STOCK_4X6.75_LEADING_DOC_TAB STOCK_4X6 PAPER_8.5X11_TOP_HALF_LABEL STOCK_4X9_TRAILING_DOC_TAB STOCK_4X9_LEADING_DOC_TAB PAPER_4X9 STOCK_4X6.75_TRAILING_DOC_TAB |
PAPER_4X6 |
packages array |
|
|
height number height of the package according to units specified under dim_units | 5 |
|
label string base64 label if you specify include_base64_label flag in your request or an URL to the generated label |
|
|
length number length of the package according to units specified under dim_units. ususally the length needs to be the largest of length, width, height | 11 |
|
tracking_number string Tracking number of shipment | 567293923024 |
|
value number value of the package according to currency specified | 25 |
|
weight number weight of the package according to units specified under weight_units | 4.2 |
|
width number width of the package according to units specified under dim_units | 8.5 |
|
shipping_documents object Additional information about packages |
|
|
description string description of this customs item required | Commercial Invoice |
|
document string base64 document contents required |
|
|
document_type string file format of the document required | PDF |
|
special_services object | saturday_delivery no_freight_rate list_rates paperless_trade include_qr |
[saturday_delivery ] |
tracking_number string Tracking number of shipment | 567293923024 |
Error Response
Field | Possible Values | Example |
---|---|---|
error object |
|
|
code string Standardized error code required | carrier_unsupported_method shipping_account_not_found carrier_label_generation_failed carrier_timeout unexpected_exception carrier_failed_connection ship_date_past invalid_phone_number carrier_exception schema_field_required carrier_http_exception carrier_throttling carrier_shipment_generation_failed shipping_account_wrong_carrier schema_validation_error carrier_authentication wrong_api_key missing_api_key |
carrier_exception |
detail string This field can contain additional information about the error. This field is not meant to be shown to the end-user required |
|
|
message object Error message required | FedEx API: The origin country code XX could not be found. Please check the country code. |
Service Types
Name | API value | Domestic / international |
---|---|---|
FedEx 1 Day Freight | fedex_1_day_freight âžž | |
FedEx 2 Day | fedex_2_day âžž | |
FedEx 2 Day AM | fedex_2_day_am âžž | |
FedEx 2 Day Freight | fedex_2_day_freight âžž | |
FedEx 3 Day Freight | fedex_3_day_freight âžž | |
FedEx Express Saver | fedex_express_saver âžž | |
FedEx First Freight | fedex_first_freight âžž | |
FedEx Freight Economy | fedex_freight_economy âžž | |
FedEx Freight Priority | fedex_freight_priority âžž | |
FedEx Ground | fedex_ground âžž | |
FedEx First Overnight | fedex_first_overnight âžž | |
FedEx Ground Home Delivery | fedex_ground_home_delivery âžž | |
FedEx Priority Overnight | fedex_priority_overnight âžž | |
FedEx Smart Post Media MAil | fedex_smart_post_media_mail âžž | |
FedEx Smart Post Parcel Select | fedex_smart_post_parcel_select âžž | |
FedEx Smart Post Presorted Bound Printed Matter | fedex_smart_post_presorted_bound_printed_matter âžž | |
FedEx Smart Post Presorted Standard | fedex_smart_post_presorted_standard âžž | |
FedEx Smart Post Parcel Return | fedex_smart_post_parcel_return âžž | |
FedEx Standard Overnight | fedex_standard_overnight âžž | |
FedEx Europe First International Priority | fedex_europe_first_international_priority âžž | |
FedEx International Economy | fedex_international_economy âžž | |
FedEx International Economy Freight | fedex_international_economy_freight âžž | |
FedEx International First | fedex_international_first âžž | |
FedEx International Priority | fedex_international_priority âžž | |
FedEx International Priority Express | fedex_international_priority_express âžž | |
FedEx International Priority Freight | fedex_international_priority_freight âžž | |
FedEx Next Day Early Morning | fedex_next_day_early_morning âžž | |
FedEx Next Day Mid Morning | fedex_next_day_mid_morning âžž | |
FedEx Next Day Afternoon | fedex_next_day_afternoon âžž | |
FedEx Next Day End of Day | fedex_next_day_end_of_day âžž | |
FedEx Economy | fedex_distance_deferred âžž | |
FedEx Next Day Freight | fedex_next_day_freight âžž | |
FedEx Regional Economy | fedex_regional_economy âžž | |
FedEx International Connect Plus | fedex_international_connect_plus âžž | |
FedEx First | fedex_first âžž | |
FedEx Priority | fedex_priority âžž | |
FedEx Priority Express | fedex_priority_express âžž | |
FedEx International Priority | international_priority âžž | |
FedEx International Express | international_express âžž | |
Show more |
Packaging Types
Name | API value | Domestic / international |
---|---|---|
FedEx 10KG Box | fedex_10kg_box âžž | |
FedEx 25KG Box | fedex_25kg_box âžž | |
FedEx Box | fedex_box âžž | |
FedEx Envelope | fedex_envelope âžž | |
FedEx PAK | fedex_pak âžž | |
FedEx Tube | fedex_tube âžž | |
Your Packaging | your_packaging âžž |
Billing Fields
Name | API value | Domestic / international |
---|---|---|
Shipping Payment Type | shipping_payment_type | |
Billing Account Number | billing_account_number | |
Duty Payment Type | duty_payment_type | |
Duty Account Number | duty_account_number | |
Bill To City | bill_to_city | |
Bill To Address Line | bill_to_address_line | |
Bill To State | bill_to_state | |
Bill To Country | bill_to_country | |
Bill To Company Name | bill_to_company_name | |
Bill To Contact Name | bill_to_contact_name | |
Bill To Postcode | bill_to_post_code | |
Bill To Phone Number | bill_to_phone_number |
Special Services
Name | API value | Code |
---|---|---|
Saturday Delivery | saturday_delivery | SATURDAY_DELIVERY |
Ignore freight rates | no_freight_rate | NO_FREIGHT |
Request List Rates | list_rates | LIST |
Paperless Trade | paperless_trade | ELECTRONIC_TRADE_DOCUMENTS |
Include QR | include_qr | IncludeQr |
Custom Fields
Name | API value | Possible Values | Required |
---|---|---|---|
Drop Off Type | drop_off_type | regular_pickup, drop_box, station, REQUEST_COURIER, business_service_center | False |
Non Standard Packaging | non_standard_packaging | False | |
Insurance cost | insurance_cost | False | |
Declaration Statement | declaration_statement | False | |
Broker Name | broker_name | False | |
Broker Phone Number | broker_phone | False | |
Broker Company | broker_company | False | |
Importer Type | importer_type | sender, recipient | False |
Customs
Name | API value | Possible Values | Node | Required |
---|---|---|---|---|
Description | description | customs_item | True | |
Manufacture Country Code | manufacture_country_code | customs_item | True | |
Weight | weight | customs_item | True | |
Weight Unit | weight_unit | KG, LB | customs_item | True |
Quantity | quantity | customs_item | True | |
Quantity Unit | quantity_unit | uom, box, 2gm, 2m, 2m3, 3m3, m3, dpr, doz, 2no, pcs, gm, grs, KG, l, m, 3gm, 3l, x, no, 2kg, prs, 2l, LB, cm2, 2m2, 3m2, m2, 4m2, 3m, cm, cone, ct, ea, lbs, rill, roll, set, tu, yds | customs_item | True |
Value | value | customs_item | True | |
Harmonized Code | harmonized_code | customs_item | False | |
Terms Of Trade | terms_of_trade | cost_and_freight, cost_insurance_and_freight, carriage_and_insurance_paid, carriage_paid_to, delivered_duty_paid, delivered_duty_unpaid, ex_works, free_carrier, free_on_board | shipment | False |
Terms Of Payment | terms_of_payment | shipment | False |
References
Name | API value | Code |
---|---|---|
Customer Reference | ref | CUSTOMER_REFERENCE |
Customer Reference | customer_reference | CUSTOMER_REFERENCE |
Customer Reference | reference | CUSTOMER_REFERENCE |
Department Number | department_number | DEPARTMENT_NUMBER |
Invoice Number | invoice_number | INVOICE_NUMBER |
P O Number | p_o_number | P_O_NUMBER |
RMA Number | rma_number | RMA_ASSOCIATION |
/ship GET
This endpoint allows you to retrieve previously created shipments
GET Request Parameters
Field | Possible Values | Example |
---|---|---|
shipment_id object ID of the previously created shipment returned from POST on /ship required |
|
Successful Response
Field | Possible Values | Example |
---|---|---|
shipment object |
|
|
carrier string the carrier name | fedex |
|
created string when was this object created | 2021-06-02T07:22:43.000 |
|
id string shipment ID | 1f02d12868a54ed88b6cb4dafaad325d |
|
label string base64 label |
|
|
label_type string the label format of the shipping labels | PDF PDF__PAPER_4X6 PDF__PAPER_4X8 PDF__PAPER_4X9 PDF__PAPER_7X4.75 PDF__PAPER_8.5X11_BOTTOM_HALF_LABEL PDF__PAPER_8.5X11_TOP_HALF_LABEL PNG PNG__PAPER_4X6 PNG__PAPER_4X8 PNG__PAPER_4X9 PNG__PAPER_7X4.75 PNG__PAPER_8.5X11_BOTTOM_HALF_LABEL PNG__PAPER_8.5X11_TOP_HALF_LABEL EPL2 EPL2__STOCK_4X6 EPL2__STOCK_4X6.75_TRAILING_DOC_TAB EPL2__STOCK_4X8 EPL2__STOCK_4X9_LEADING_DOC_TAB EPL2__STOCK_4X9_TRAILING_DOC_TAB ZPLII ZPLII__STOCK_4X6 ZPLII__STOCK_4X6.75_LEADING_DOC_TAB ZPLII__STOCK_4X6.75_TRAILING_DOC_TAB ZPLII__STOCK_4X8 ZPLII__STOCK_4X9_LEADING_DOC_TAB ZPLII__STOCK_4X9_TRAILING_DOC_TAB |
PDF |
shipping_account string Shipping account number | 5190163571408896 |
|
status string Standardized shipment status | pending success |
success |
tracking_number string Tracking number of shipment | 567293923024 |
|
updated string when was this object updated | 2021-06-02T13:10:02.000 |
Error Response
Field | Possible Values | Example |
---|---|---|
error object |
|
|
code string Standardized error code required | carrier_unsupported_method shipping_account_not_found carrier_label_generation_failed carrier_timeout unexpected_exception carrier_failed_connection carrier_no_shipment_found carrier_exception schema_field_required carrier_http_exception carrier_throttling shipping_account_wrong_carrier schema_validation_error carrier_authentication wrong_api_key missing_api_key |
carrier_exception |
detail string This field can contain additional information about the error. This field is not meant to be shown to the end-user required |
|
|
message object Error message required | DHL Global Forwarding API: Your shipment was rejected due to an unpaid invoice on your previous shipment. Contact DHL support to resolve the issue. |
/rate POST
The rating endpoint is used to return estimated costs & time in transit data from the carrier. Zenkraft normalize this data across carriers providing a standardized date and cost format from the carriers (where the functionality is supported).
POST Request Parameters
Field | Possible Values | Example |
---|---|---|
shipment object Definition of the shipment payload required |
|
|
carrier string the carrier name required | fedex |
|
currency string | GNF KZT AED HUF GTQ GMD FKP CHF SZL BWP TND BAM TOP CZK INR HTG GHS ZMW CDF SPL AOA KYD XAF TTD GIP MRU UGX IRR MXN BZD GGP MGA NOK PAB PHP RON RUB LKR CUC BOB BTN KGS MUR EUR AUD ZWD BIF SEK USD AWG KWD XOF SLL BYN PKR XPF BHD TZS SCR OMR MWK MVR VND GEL BGN DKK CUP SOS RSD PEN SDG NAD SVC HKD STN LRD JOD SYP TMT BSD GBP NGN ANG ARS AFN TWD NIO WST TRY ALL JEP LYD MKD BND ZAR SAR PGK NPR DJF NZD TJS HRK AMD MZN UYU BMD PYG CAD SGD CLP KRW BRL ILS JPY YER KHR MYR CRC QAR DZD COP MAD LBP VUV XDR VEF UAH ISK MDL BDT SRD CVE HNL XCD MMK GYD IMP LAK TVD KES AZN DOP ETB PLN THB FJD KMF IQD SBD UZS MOP BBD IDR KPW SHP CNY ERN MNT EGP LSL JMD RWF |
|
debug boolean calls with debug=true will be logged |
|
|
dim_units string Dimension units of the packages, inches or centimeters required | IN CM |
IN |
packages array required |
|
|
height number height of the package according to units specified under dim_units | 5 |
|
length number length of the package according to units specified under dim_units. ususally the length needs to be the largest of length, width, height | 11 |
|
value number value of the package according to currency specified | 25 |
|
weight number weight of the package according to units specified under weight_units | 4.2 |
|
width number width of the package according to units specified under dim_units | 8.5 |
|
packaging string the packaging type required | your_packaging |
your_packaging |
recipient object Recipient of shiment required |
|
|
city string the city of the recipient required | Burlington |
|
company string the company name of the recipient | Burlington Textiles Corp of America |
|
country string required | HK DE LA PS SC LY BV TW ZA VN SA PG BG MM TZ TF US IS MV GU MP RS EC MU GL PA SV PR KH MH OM AG SH WF ZW TN JM AU MR SE MZ ST CI UA RU VI NO SI SJ BB WS AS SD AZ GS ML ES DM AT BL AF MY PK TV NA SK SL BF FI TM BN GA AL SO FR DK TH PE CU GI GW TT GY HT TO SN MC TR GP TG LT CO BS IO CR AI DJ HM RE BH AX TK NZ VA ET BD TC BJ FO NL KR VE TJ EH BR EE CZ LI TL LV SM TD VU JO GT HU UM BE RW RO AQ BT NG CL KG MQ MT PL SS KN GQ PM HN BA IR CK PY PH YE IM CA LB CM ER IQ LC QA AR AO AE SZ ZM SG KZ CF FJ KE LS PW CN GB CD CY IN CH BO GG NC KW BM MX CW UG CG GE IL MS BI UY HR MN GH CV VG GM IE JP NE AW FM ME JE SB MF BY NI BQ KY MA KM AD DZ CX DO MO YT SR MW AM EG KI MD NF UZ VC NP LU BZ ID PT LR GD SY GF MG MK SX BW PN FK GR GN NU LK PF KP NR IT CC |
US |
email string the email address of the recipient | jrogers@example.com |
|
name string the name of the recipient required | Jack O'Rogers |
|
phone string the phone number of the recipient | (336) 222-7000 |
|
postal_code string the postal code / zip number of the recipient. Specific format depends on the country | 27215 |
|
state string the state of the recipient | NC |
|
street1 string the first line of the street address of the recipient required | 525 S. ZENKRAFT Ave |
|
street2 string the second line of the street address of the recipient | suite 120 |
|
street3 string the third line of the street address of the recipient | suite 120 |
|
sender object Sender of shiment required |
|
|
city string the city of the recipient required | Burlington |
|
company string the company name of the recipient | Burlington Textiles Corp of America |
|
country string required | HK DE LA PS SC LY BV TW ZA VN SA PG BG MM TZ TF US IS MV GU MP RS EC MU GL PA SV PR KH MH OM AG SH WF ZW TN JM AU MR SE MZ ST CI UA RU VI NO SI SJ BB WS AS SD AZ GS ML ES DM AT BL AF MY PK TV NA SK SL BF FI TM BN GA AL SO FR DK TH PE CU GI GW TT GY HT TO SN MC TR GP TG LT CO BS IO CR AI DJ HM RE BH AX TK NZ VA ET BD TC BJ FO NL KR VE TJ EH BR EE CZ LI TL LV SM TD VU JO GT HU UM BE RW RO AQ BT NG CL KG MQ MT PL SS KN GQ PM HN BA IR CK PY PH YE IM CA LB CM ER IQ LC QA AR AO AE SZ ZM SG KZ CF FJ KE LS PW CN GB CD CY IN CH BO GG NC KW BM MX CW UG CG GE IL MS BI UY HR MN GH CV VG GM IE JP NE AW FM ME JE SB MF BY NI BQ KY MA KM AD DZ CX DO MO YT SR MW AM EG KI MD NF UZ VC NP LU BZ ID PT LR GD SY GF MG MK SX BW PN FK GR GN NU LK PF KP NR IT CC |
US |
email string the email address of the recipient | jrogers@example.com |
|
name string the name of the recipient required | Jack O'Rogers |
|
phone string the phone number of the recipient | (336) 222-7000 |
|
postal_code string the postal code / zip number of the recipient. Specific format depends on the country | 27215 |
|
state string the state of the recipient | NC |
|
street1 string the first line of the street address of the recipient required | 525 S. ZENKRAFT Ave |
|
street2 string the second line of the street address of the recipient | suite 120 |
|
street3 string the third line of the street address of the recipient | suite 120 |
|
service string if you specify the service type, you'll get rates only for this service | fedex_1_day_freight fedex_2_day fedex_2_day_am fedex_2_day_freight fedex_3_day_freight fedex_express_saver fedex_first_freight fedex_freight_economy fedex_freight_priority fedex_ground fedex_first_overnight fedex_ground_home_delivery fedex_priority_overnight fedex_smart_post_media_mail fedex_smart_post_parcel_select fedex_smart_post_presorted_bound_printed_matter fedex_smart_post_presorted_standard fedex_smart_post_parcel_return fedex_standard_overnight fedex_europe_first_international_priority fedex_international_economy fedex_international_economy_freight fedex_international_first fedex_international_priority fedex_international_priority_express fedex_international_priority_freight fedex_next_day_early_morning fedex_next_day_mid_morning fedex_next_day_afternoon fedex_next_day_end_of_day fedex_distance_deferred fedex_next_day_freight fedex_regional_economy fedex_international_connect_plus fedex_first fedex_priority fedex_priority_express international_priority international_express |
fedex_1_day_freight |
ship_date string shipping date | 2021-06-07 |
|
shipping_account string Shipping account number required | 5190163571408896 |
|
special_services array | saturday_delivery no_freight_rate list_rates paperless_trade include_qr |
[saturday_delivery ] |
test boolean calls created with test = true will be directed to the carrier test servers |
|
|
type string outbound or return shipments | return outbound |
outbound |
weight_units string Weight units of the packages, pounds or kilograms required | KG LB |
LB |
Successful Response
Field | Possible Values | Example |
---|---|---|
rates array |
|
|
currency string | USD AED AFN ALL AMD ANG AOA ARS AUD AWG AZN BAM BBD BDT BGN BHD BIF BMD BND BOB BRL BSD BTN BWP BYN BZD CAD CDF CHF CLP CNY COP CRC CUC CUP CVE CZK DJF DKK DOP DZD EGP ERN ETB EUR FJD FKP GBP GEL GGP GHS GIP GMD GNF GTQ GYD HKD HNL HRK HTG HUF IDR ILS IMP INR IQD IRR ISK JEP JMD JOD JPY KES KGS KHR KMF KPW KRW KWD KYD KZT LAK LBP LKR LRD LSL LYD MAD MDL MGA MKD MMK MNT MOP MRU MUR MVR MWK MXN MYR MZN NAD NGN NIO NOK NPR NZD OMR PAB PEN PGK PHP PKR PLN PYG QAR RON RSD RUB RWF SAR SBD SCR SDG SEK SGD SHP SLL SOS SPL SRD STN SVC SYP SZL THB TJS TMT TND TOP TRY TTD TVD TWD TZS UAH UGX UYU UZS VEF VND VUV WST XAF XCD XDR XOF XPF YER ZAR ZMW ZWD |
|
delivery_day string Day of the week of the delivery. This field is optional depending on the carrier | Mon |
|
estimated_date string Number of days to ship. This field is optional depending on the carrier | 2021-06-04 |
|
service_name string carrier supplied name of this service | FedEx Freight |
|
service_type string service slug which can be used when selecting a service in /ship | fedex_1_day_freight fedex_2_day fedex_2_day_am fedex_2_day_freight fedex_3_day_freight fedex_express_saver fedex_first_freight fedex_freight_economy fedex_freight_priority fedex_ground fedex_first_overnight fedex_ground_home_delivery fedex_priority_overnight fedex_smart_post_media_mail fedex_smart_post_parcel_select fedex_smart_post_presorted_bound_printed_matter fedex_smart_post_presorted_standard fedex_smart_post_parcel_return fedex_standard_overnight fedex_europe_first_international_priority fedex_international_economy fedex_international_economy_freight fedex_international_first fedex_international_priority fedex_international_priority_express fedex_international_priority_freight fedex_next_day_early_morning fedex_next_day_mid_morning fedex_next_day_afternoon fedex_next_day_end_of_day fedex_distance_deferred fedex_next_day_freight fedex_regional_economy fedex_international_connect_plus fedex_first fedex_priority fedex_priority_express international_priority international_express |
fedex_1_day_freight |
total_cost string total estimated price for this shipment | 192.16 |
|
transit_days integer Number of days to ship. This field is optional depending on the carrier | 3 |
Error Response
Field | Possible Values | Example |
---|---|---|
error object |
|
|
code string Standardized error code required | carrier_unsupported_method shipping_account_not_found carrier_timeout unexpected_exception carrier_failed_connection ship_date_past carrier_exception schema_field_required carrier_http_exception carrier_throttling shipping_account_wrong_carrier schema_validation_error carrier_authentication wrong_api_key missing_api_key |
carrier_exception |
detail string This field can contain additional information about the error. This field is not meant to be shown to the end-user required |
|
|
message object Error message required | FedEx API: The origin country code XX could not be found. Please check the country code. |
/track POST
The track endpoint is used to track shipment status as it's being delivered.
POST Request Parameters
Field | Possible Values | Example |
---|---|---|
track object required |
|
|
carrier string the carrier name required | fedex |
|
checkpoints boolean whether to include checkpoint events in the response or not |
|
|
debug boolean calls with debug=true will be logged |
|
|
locale string language used in the checkpoint response. Not all carriers support different languages | ar_TN my_MM tr_TR uz_Arab_AF bs_BA ebu_KE ee_TG es_PY en_AS ne_NP es_AR es_BO hr_HR lv_LV teo_UG da_DK en_PH ur_IN mas_TZ en_ZA lag_TZ zh_Hans_CN pl_PL ar_OM khq_ML ar_YE en_UM en_JM es_GT id_ID kab_DZ ro_MD ru_MD kln_KE lt_LT kk_Cyrl fa_AF te_IN ru_RU fr_ML ar_AE fi_FI en_BW es_EC et_EE fr_KM sn_ZW ps_AF ar_LY dav_KE kam_KE ii_CN fr_MF az_Latn en_VI kok_IN fr_CG luo_KE sr_Latn_BA fr_CH gu_IN es_SV ro_RO fa_IR ca_ES sr_Latn_ME en_IE ar_IQ en_MU fr_DJ fr_FR sr_Cyrl_ME fr_GQ fr_RW sr_Cyrl_BA es_PE ta_IN cy_GB mr_IN bn_IN gl_ES ne_IN bo_CN om_KE ha_Latn_NG bez_TZ fr_MC vi_VN ko_KR kea_CV ki_KE es_HN ti_ET xog_UG en_MP ee_GH gv_GB gsw_CH haw_US saq_KE sr_Latn_RS bn_BD en_BZ ar_LB es_PA fr_CF nb_NO en_TT zh_Hans_HK nl_BE lg_UG fr_GA fr_LU ti_ER el_GR so_KE de_BE it_IT fr_GP sr_Cyrl_RS kw_GB fr_TG pt_MZ ru_UA mk_MK es_GQ en_AU uz_Latn shi_Latn_MA shi_Tfng en_SG ar_BH ur_PK es_MX uz_Latn_UZ en_GU de_CH en_NZ ha_Latn mg_MG nd_ZW bm_ML pt_BR rwk_TZ es_CO es_UY th_TH ar_JO pt_PT en_GB fr_CA hy_AM sv_FI it_CH zh_Hant en_MT rm_CH es_PR en_US ha_Latn_NE de_DE cs_CZ om_ET zh_Hans_MO cgg_UG ar_DZ asa_TZ fr_NE es_419 yo_NG pt_GW fr_BL ar_SD fr_MQ rw_RW en_NA kn_IN jmc_TZ fr_BF nyn_UG ses_ML pa_Arab vun_TZ en_ZW rof_TZ sk_SK es_CR sw_KE ar_MA az_Latn_AZ to_TO ak_GH naq_NA de_LU es_ES af_NA mas_KE en_IN pa_Arab_PK so_SO es_NI sq_AL ja_JP sr_Cyrl zh_Hant_MO de_LI fr_CM so_DJ zh_Hant_TW sl_SI so_ET fr_BI kde_TZ ar_EG fr_CD sr_Latn luy_KE fil_PH de_AT yue_Hant_HK or_IN as_IN uz_Arab nn_NO am_ET km_KH teo_KE en_BE uz_Cyrl_UZ hu_HU eu_ES ms_MY fo_FO mfe_MU fr_CI tzm_Latn fr_MG ga_IE sg_CF bg_BG az_Cyrl_AZ fr_TD zh_Hant_HK ka_GE ms_BN bem_ZM shi_Tfng_MA ig_NG en_MH ar_KW tzm_Latn_MA ar_QA seh_MZ fr_GN sw_TZ mer_KE zu_ZA be_BY he_IL ha_Latn_GH es_US uz_Cyrl ar_SA fr_BE uk_UA ar_SY si_LK bo_IN kk_Cyrl_KZ ml_IN zh_Hans chr_US sv_SE es_DO es_VE en_IL pa_Guru_IN af_ZA en_CA en_PK hi_IN es_CL zh_Hans_SG ff_SN mt_MT ta_LK el_CY en_HK shi_Latn nl_NL fr_BJ is_IS guz_KE fr_RE pa_Guru fr_SN kl_GL az_Cyrl |
en_US |
refresh boolean whether to force calling live carrier API. By default, we might return a fresh result from the cache |
|
|
shipping_account string Shipping account number required | 5190163571408896 |
|
test boolean calls created with test = true will be directed to the carrier test servers |
|
|
tracking_number string Tracking number of shipment required | 567293923024 |
|
webhooks boolean whether to allow webhook functionality for this shipment |
|
Successful Response
Field | Possible Values | Example |
---|---|---|
carrier string the carrier name | fedex |
|
checkpoints array |
|
|
description string | Delivered to a mailbox |
|
status string the most recent important status description | Delivered to a mailbox |
|
time string | 2021-06-07T10:46:07.000+1000 |
|
tracking_stage string the most recent important status standardized shipment stage | CREATED PICKED_UP IN_TRANSIT OUT_FOR_DELIVERY DELIVERED SHIPMENT_VOIDED EXCEPTION |
DELIVERED |
delivered boolean whether the shipment was successfully delivered |
|
|
delivery_date string delivery date of this shipment | 2021-06-07T00:00:00.000Z |
|
estimated_delivery string estimated delivery date of this shipment | 2021-06-07T00:00:00.000Z |
|
locale string locale used in the checkpoint response. Not all carriers support different languages | ar_TN my_MM tr_TR uz_Arab_AF bs_BA ebu_KE ee_TG es_PY en_AS ne_NP es_AR es_BO hr_HR lv_LV teo_UG da_DK en_PH ur_IN mas_TZ en_ZA lag_TZ zh_Hans_CN pl_PL ar_OM khq_ML ar_YE en_UM en_JM es_GT id_ID kab_DZ ro_MD ru_MD kln_KE lt_LT kk_Cyrl fa_AF te_IN ru_RU fr_ML ar_AE fi_FI en_BW es_EC et_EE fr_KM sn_ZW ps_AF ar_LY ii_CN kam_KE dav_KE fr_MF az_Latn en_VI kok_IN fr_CG luo_KE fa_IR fr_CH gu_IN sr_Latn_BA ro_RO es_SV ca_ES ur_PK sr_Latn_ME en_IE ar_IQ en_MU fr_DJ fr_FR sr_Cyrl_ME fr_GQ fr_RW sr_Cyrl_BA es_PE ta_IN cy_GB mr_IN bn_IN gl_ES ne_IN bo_CN om_KE ha_Latn_NG bez_TZ fr_MC vi_VN ko_KR kea_CV ki_KE es_HN ti_ET xog_UG en_MP ee_GH gv_GB gsw_CH haw_US saq_KE sr_Latn_RS bn_BD en_BZ ar_LB es_PA fr_CF nb_NO en_TT zh_Hans_HK nl_BE lg_UG fr_GA fr_LU ti_ER el_GR so_KE de_BE it_IT fr_GP sr_Cyrl_RS kw_GB fr_TG pt_MZ ru_UA mk_MK es_GQ en_AU uz_Latn shi_Latn_MA shi_Tfng uz_Latn_UZ en_SG ar_BH en_GU de_CH en_NZ ha_Latn mg_MG mfe_MU nd_ZW bm_ML pt_BR rwk_TZ es_CO es_UY th_TH ar_JO pt_PT en_GB fr_CA hy_AM sv_FI it_CH zh_Hant en_MT rm_CH es_PR en_US ha_Latn_NE de_DE cs_CZ om_ET es_MX zh_Hans_MO cgg_UG ar_DZ asa_TZ fr_NE es_419 yo_NG pt_GW fr_BL ar_SD fr_MQ rw_RW en_NA kn_IN jmc_TZ fr_BF nyn_UG ses_ML pa_Arab vun_TZ en_ZW rof_TZ sk_SK es_CR sw_KE ar_MA az_Latn_AZ to_TO ak_GH naq_NA de_LU es_ES af_NA mas_KE en_IN pa_Arab_PK so_SO es_NI sq_AL ja_JP sr_Cyrl zh_Hant_MO de_LI fr_CM so_DJ zh_Hant_TW sl_SI so_ET fr_BI kde_TZ ar_EG fr_CD sr_Latn luy_KE fil_PH de_AT yue_Hant_HK or_IN as_IN uz_Arab nn_NO am_ET km_KH teo_KE en_BE uz_Cyrl_UZ hu_HU eu_ES ms_MY fo_FO fr_CI tzm_Latn fr_MG ga_IE sg_CF bg_BG az_Cyrl_AZ fr_TD zh_Hant_HK ka_GE ms_BN bem_ZM shi_Tfng_MA ig_NG en_MH ar_KW tzm_Latn_MA ar_QA seh_MZ fr_GN sw_TZ mer_KE zu_ZA be_BY he_IL ha_Latn_GH es_US uz_Cyrl ar_SA fr_BE uk_UA ar_SY si_LK bo_IN kk_Cyrl_KZ ml_IN zh_Hans chr_US sv_SE es_DO es_VE en_IL pa_Guru_IN af_ZA en_CA en_PK hi_IN es_CL zh_Hans_SG ff_SN mt_MT ta_LK el_CY en_HK shi_Latn nl_NL fr_BJ is_IS guz_KE fr_RE pa_Guru fr_SN kl_GL az_Cyrl |
en_US |
status string the most recent important status description | Delivered to a mailbox |
|
tracking_number string Tracking number of shipment | 567293923024 |
|
tracking_stage string the most recent important status standardized shipment stage | CREATED PICKED_UP IN_TRANSIT OUT_FOR_DELIVERY DELIVERED SHIPMENT_VOIDED EXCEPTION |
DELIVERED |
Error Response
Field | Possible Values | Example |
---|---|---|
error object |
|
|
code string Standardized error code required | carrier_unsupported_method shipping_account_not_found carrier_timeout unexpected_exception carrier_failed_connection carrier_no_shipment_found carrier_exception schema_field_required carrier_http_exception carrier_throttling shipping_account_wrong_carrier schema_validation_error carrier_authentication wrong_api_key missing_api_key |
carrier_no_shipment_found |
detail string This field can contain additional information about the error. This field is not meant to be shown to the end-user required |
|
|
message object Error message required | FedEx API: No shipment found with tracking number: 567293923024 |
Available Languages
FedEx supports returning tracking responses in a number of languages:
Name | API value |
---|---|
Spanish | es_US |
French (Canadian) | fr_CA |
Batch tracking
You can pass several track objects into your API request to get results.
Request and response details are the same and can be checked here.
/cancel POST
The cancel endpoint allows you to cancel shipments with the carrier.
POST Request Parameters
Field | Possible Values | Example |
---|---|---|
cancel object required |
|
|
carrier string the carrier name required | fedex |
|
checkpoints boolean whether to include checkpoint events in the response or not |
|
|
debug boolean calls with debug=true will be logged |
|
|
locale string language used in the checkpoint response. Not all carriers support different languages | ar_TN my_MM tr_TR uz_Arab_AF bs_BA ebu_KE ee_TG es_PY en_AS ne_NP es_AR es_BO hr_HR lv_LV teo_UG da_DK en_PH ur_IN mas_TZ en_ZA lag_TZ zh_Hans_CN pl_PL ar_OM khq_ML ar_YE en_UM en_JM es_GT id_ID kab_DZ ro_MD ru_MD kln_KE lt_LT kk_Cyrl fa_AF te_IN ru_RU fr_ML ar_AE fi_FI en_BW es_EC et_EE fr_KM sn_ZW ps_AF ar_LY dav_KE kam_KE fr_MF az_Latn en_VI kok_IN fr_CG luo_KE sr_Latn_BA fr_CH gu_IN es_SV ro_RO ca_ES sr_Latn_ME en_IE ar_IQ en_MU fr_DJ fr_FR sr_Cyrl_ME fr_GQ fr_RW sr_Cyrl_BA es_PE ta_IN cy_GB mr_IN bn_IN gl_ES ne_IN bo_CN om_KE ha_Latn_NG bez_TZ fr_MC vi_VN ko_KR kea_CV ki_KE es_HN ti_ET xog_UG en_MP ee_GH gv_GB gsw_CH haw_US saq_KE sr_Latn_RS bn_BD en_BZ ar_LB es_PA fr_CF nb_NO en_TT zh_Hans_HK nl_BE lg_UG fr_GA fr_LU ti_ER el_GR so_KE de_BE it_IT fr_GP sr_Cyrl_RS kw_GB fr_TG pt_MZ ru_UA mk_MK es_GQ en_AU uz_Latn shi_Latn_MA shi_Tfng en_SG ar_BH ur_PK es_MX uz_Latn_UZ en_GU de_CH en_NZ ha_Latn mg_MG nd_ZW bm_ML pt_BR rwk_TZ es_CO es_UY th_TH ar_JO pt_PT en_GB fr_CA hy_AM sv_FI it_CH zh_Hant en_MT rm_CH es_PR en_US ha_Latn_NE de_DE cs_CZ om_ET zh_Hans_MO cgg_UG ar_DZ asa_TZ fr_NE es_419 yo_NG pt_GW fr_BL ar_SD fr_MQ rw_RW en_NA kn_IN jmc_TZ kl_GL fr_BF nyn_UG ses_ML pa_Arab vun_TZ en_ZW rof_TZ sk_SK es_CR sw_KE ar_MA az_Latn_AZ to_TO ak_GH naq_NA de_LU es_ES af_NA mas_KE en_IN pa_Arab_PK so_SO es_NI sq_AL ja_JP sr_Cyrl zh_Hant_MO de_LI fr_CM so_DJ zh_Hant_TW sl_SI so_ET fr_BI kde_TZ ar_EG fr_CD sr_Latn luy_KE fil_PH de_AT yue_Hant_HK or_IN as_IN uz_Arab nn_NO am_ET km_KH teo_KE en_BE uz_Cyrl_UZ hu_HU eu_ES ms_MY fo_FO mfe_MU fr_CI tzm_Latn fr_MG ga_IE sg_CF bg_BG az_Cyrl_AZ fr_TD zh_Hant_HK ka_GE ms_BN bem_ZM fr_RE shi_Tfng_MA ig_NG en_MH ar_KW tzm_Latn_MA ar_QA seh_MZ fr_GN sw_TZ mer_KE zu_ZA be_BY he_IL ha_Latn_GH es_US uz_Cyrl ar_SA fr_BE uk_UA ar_SY si_LK bo_IN kk_Cyrl_KZ ml_IN zh_Hans chr_US sv_SE es_DO es_VE en_IL pa_Guru_IN af_ZA en_CA en_PK hi_IN es_CL zh_Hans_SG ff_SN mt_MT ta_LK el_CY en_HK shi_Latn nl_NL fr_BJ is_IS guz_KE fa_IR pa_Guru fr_SN ii_CN az_Cyrl |
en_US |
refresh boolean whether to force calling live carrier API. By default, we might return a fresh result from the cache |
|
|
shipping_account string Shipping account number required | 5190163571408896 |
|
test boolean calls created with test = true will be directed to the carrier test servers |
|
|
tracking_number string Tracking number of shipment required | 567293923024 |
|
webhooks boolean whether to allow webhook functionality for this shipment |
|
Successful Response
Field | Possible Values | Example |
---|---|---|
success object |
|
|
message string Message describing the action was performed successfully | Success! |
Error Response
Field | Possible Values | Example |
---|---|---|
error object |
|
|
code string Standardized error code required | carrier_unsupported_method shipping_account_not_found carrier_timeout unexpected_exception carrier_failed_connection carrier_no_shipment_found carrier_exception schema_field_required carrier_http_exception carrier_throttling shipping_account_wrong_carrier schema_validation_error carrier_authentication wrong_api_key missing_api_key |
carrier_no_shipment_found |
detail string This field can contain additional information about the error. This field is not meant to be shown to the end-user required |
|
|
message object Error message required | FedEx API: No shipment found with tracking number: 567293923024 |
/pickup POST
The pickup endpoint allows you to schedule pickups for one or more shipments.
POST Request Parameters
Field | Possible Values | Example |
---|---|---|
pickup object required |
|
|
carrier string the carrier name required | fedex |
|
currency string | GNF KZT AED HUF GTQ FKP GMD CHF SZL BWP TND BAM TOP CZK INR HTG GHS ZMW CDF SPL AOA KYD XAF TTD GIP MRU UGX IRR MXN BZD GGP MGA NOK PAB PHP RON RUB LKR CUC BOB BTN KGS MUR EUR AUD ZWD BIF SEK USD AWG KWD XOF SLL BYN PKR XPF BHD TZS SCR OMR MWK MVR VND GEL BGN DKK CUP SOS RSD PEN SDG NAD SVC HKD STN LRD JOD SYP TMT BSD GBP NGN ANG ARS AFN TWD NIO WST TRY ALL JEP LYD MKD BND ZAR SAR PGK NPR DJF NZD TJS HRK AMD MZN UYU BMD PYG CAD SGD CLP KRW BRL ILS JPY YER KHR MYR CRC QAR DZD COP MAD LBP VUV XDR VEF UAH ISK MDL BDT SRD CVE HNL XCD MMK GYD IMP LAK TVD KES AZN DOP ETB PLN THB FJD KMF IQD SBD UZS MOP BBD IDR KPW SHP CNY ERN MNT EGP LSL JMD RWF |
|
debug boolean calls with debug=true will be logged |
|
|
description string |
|
|
dim_units string Dimension units of the packages, inches or centimeters required | IN CM |
IN |
location object required |
|
|
city string the city of the recipient required | Burlington |
|
company string the company name of the recipient | Burlington Textiles Corp of America |
|
country string required | HK DE LA PS SC LY BV TW ZA VN SA PG BG TZ MM US TF IS MV GU MP RS EC MU GL PA SV PR KH MH OM AG SH WF ZW TN JM AU MR SE MZ ST CI UA RU VI NO SI SJ BB WS AS SD AZ GS ML ES DM AT BL AF MY PK TV NA SL SK BF FI TM BN GA AL SO FR DK TH CU GI GW TT GY HT TO SN MC TR GP TG LT CO BS IO CR AI DJ HM RE BH AX TK NZ VA ET BD TC BJ FO NL KR VE TJ EH BR EE CZ LI TL LV SM TD VU JO GT HU UM BE RW RO NR AQ BT NG CL KG MQ MT PL SS KN GQ PM HN BA IR CK PY PH YE IM CA LB CM ER IQ LC QA AR AO AE SZ ZM SG KZ CF FJ KE LS PW CN GB CD CY IN CH BO GG NC KW BM MX CW UG CG GE IL MS BI UY HR MN GH CV VG GM IE JP NE AW FM ME JE SB BY NI BQ KY MA KM AD DZ CX DO MO YT SR MW AM EG KI MD NF UZ VC NP LU BZ ID PT LR GD SY GF MG MK SX BW PN FK GR CC GN NU LK PF KP PE IT MF |
US |
email string the email address of the recipient | jrogers@example.com |
|
location_type string description of the pickup location required | front |
|
name string the name of the recipient required | Jack O'Rogers |
|
phone string the phone number of the recipient required | (336) 222-7000 |
|
postal_code string the postal code / zip number of the recipient. Specific format depends on the country | 27215 |
|
state string the state of the recipient | NC |
|
street1 string the first line of the street address of the recipient required | 525 S. ZENKRAFT Ave |
|
street2 string the second line of the street address of the recipient | suite 120 |
|
street3 string the third line of the street address of the recipient | suite 120 |
|
shipments array required |
|
|
packages array required |
|
|
height number height of the package according to units specified under dim_units | 5 |
|
length number length of the package according to units specified under dim_units. ususally the length needs to be the largest of length, width, height | 11 |
|
value number value of the package according to currency specified | 25 |
|
weight number weight of the package according to units specified under weight_units | 4.2 |
|
width number width of the package according to units specified under dim_units | 8.5 |
|
recipient object Recipient of shiment |
|
|
city string the city of the recipient required | Burlington |
|
company string the company name of the recipient | Burlington Textiles Corp of America |
|
country string required | HK DE LA PS SC LY BV TW ZA VN SA PG BG TZ MM US TF IS MV GU MP RS EC MU GL PA SV PR KH MH OM AG SH WF ZW TN JM AU MR SE MZ ST CI UA RU VI NO SI SJ BB WS AS SD AZ GS ML ES DM AT BL AF MY PK TV NA SL SK BF FI TM BN GA AL SO FR DK TH CU GI GW TT GY HT TO SN MC TR GP TG LT CO BS IO CR AI DJ HM RE BH AX TK NZ VA ET BD TC BJ FO NL KR VE TJ EH BR EE CZ LI TL LV SM TD VU JO GT HU UM BE RW RO NR AQ BT NG CL KG MQ MT PL SS KN GQ PM HN BA IR CK PY PH YE IM CA LB CM ER IQ LC QA AR AO AE SZ ZM SG KZ CF FJ KE LS PW CN GB CD CY IN CH BO GG NC KW BM MX CW UG CG GE IL MS BI UY HR MN GH CV VG GM IE JP NE AW FM ME JE SB BY NI BQ KY MA KM AD DZ CX DO MO YT SR MW AM EG KI MD NF UZ VC NP LU BZ ID PT LR GD SY GF MG MK SX BW PN FK GR CC GN NU LK PF KP PE IT MF |
US |
email string the email address of the recipient | jrogers@example.com |
|
name string the name of the recipient required | Jack O'Rogers |
|
phone string the phone number of the recipient | (336) 222-7000 |
|
postal_code string the postal code / zip number of the recipient. Specific format depends on the country | 27215 |
|
state string the state of the recipient | NC |
|
street1 string the first line of the street address of the recipient required | 525 S. ZENKRAFT Ave |
|
street2 string the second line of the street address of the recipient | suite 120 |
|
street3 string the third line of the street address of the recipient | suite 120 |
|
service string the service type | fedex_1_day_freight fedex_2_day fedex_2_day_am fedex_2_day_freight fedex_3_day_freight fedex_express_saver fedex_first_freight fedex_freight_economy fedex_freight_priority fedex_ground fedex_first_overnight fedex_ground_home_delivery fedex_priority_overnight fedex_smart_post_media_mail fedex_smart_post_parcel_select fedex_smart_post_presorted_bound_printed_matter fedex_smart_post_presorted_standard fedex_smart_post_parcel_return fedex_standard_overnight fedex_europe_first_international_priority fedex_international_economy fedex_international_economy_freight fedex_international_first fedex_international_priority fedex_international_priority_express fedex_international_priority_freight fedex_next_day_early_morning fedex_next_day_mid_morning fedex_next_day_afternoon fedex_next_day_end_of_day fedex_distance_deferred fedex_next_day_freight fedex_regional_economy fedex_international_connect_plus fedex_first fedex_priority fedex_priority_express international_priority international_express |
fedex_1_day_freight |
shipping_account string Shipping account number required | 5190163571408896 |
|
test boolean calls created with test = true will be directed to the carrier test servers |
|
|
time object the date and time you want to create the pickup for. required |
|
|
close_time string end of pickup time required | 19:00 |
|
date string the date you want to create pickup for. required | 2021-06-07 |
|
ready_time string start of pickup time required | 12:30 |
|
weight_units string Weight units of the packages, pounds or kilograms required | KG LB |
LB |
Successful Response
Field | Possible Values | Example |
---|---|---|
pickup object |
|
|
carrier string the carrier name required | fedex |
|
confirmation_number string reference number of this pickup. It can be used to cancel the pickup if the carrier allows it | 123456789 |
|
currency string | GNF KZT AED HUF GTQ GMD FKP CHF SZL BWP TND BAM TOP CZK INR HTG GHS ZMW CDF SPL AOA KYD XAF TTD GIP MRU UGX IRR MXN BZD GGP MGA NOK PAB PHP RON RUB LKR CUC BOB BTN KGS MUR EUR AUD ZWD BIF SEK USD AWG KWD XOF SLL BYN PKR XPF BHD TZS SCR OMR MWK MVR VND GEL BGN DKK CUP SOS RSD PEN SDG NAD SVC HKD STN LRD JOD SYP TMT BSD GBP NGN ANG ARS AFN TWD NIO WST TRY ALL JEP LYD MKD BND ZAR SAR PGK NPR DJF NZD TJS HRK AMD MZN UYU BMD PYG CAD SGD CLP KRW BRL ILS JPY YER KHR MYR CRC QAR DZD COP MAD LBP VUV XDR VEF UAH ISK MDL BDT SRD CVE HNL XCD MMK GYD IMP LAK TVD KES AZN DOP ETB PLN THB FJD KMF IQD SBD UZS MOP BBD IDR KPW SHP CNY ERN MNT EGP LSL JMD RWF |
|
debug boolean calls with debug=true will be logged |
|
|
description string |
|
|
dim_units string Dimension units of the packages, inches or centimeters required | IN CM |
IN |
id string internal pickup ID | cf8a402288034fd9941dc1efe22b0680 |
|
location object required |
|
|
city string the city of the recipient required | Burlington |
|
company string the company name of the recipient | Burlington Textiles Corp of America |
|
country string required | HK DE LA PS SC LY BV TW ZA VN SA PG BG MM TZ TF US IS MV GU MP RS EC MU GL PA SV PR KH MH OM AG SH WF ZW TN JM AU MR SE MZ ST CI UA RU VI NO SI SJ BB WS AS SD AZ GS ML ES DM AT BL AF MY PK TV NA SK SL BF FI TM BN GA AL SO FR DK TH PE CU GI GW TT GY HT TO SN MC TR GP TG LT CO BS IO CR AI DJ HM RE BH AX TK NZ VA ET BD TC BJ FO NL KR VE TJ EH BR EE CZ LI TL LV SM TD VU JO GT HU UM BE RW RO AQ BT NG CL KG MQ MT PL SS KN GQ PM HN BA IR CK PY PH YE IM CA LB CM ER IQ LC QA AR AO AE SZ ZM SG KZ CF FJ KE LS PW CN GB CD CY IN CH BO GG NC KW BM MX CW UG CG GE IL MS BI UY HR MN GH CV VG GM IE JP NE AW FM ME JE SB MF BY NI BQ KY MA KM AD DZ CX DO MO YT SR MW AM EG KI MD NF UZ VC NP LU BZ ID PT LR GD SY GF MG MK SX BW PN FK GR GN NU LK PF KP NR IT CC |
US |
email string the email address of the recipient | jrogers@example.com |
|
location_type string description of the pickup location required | front |
|
name string the name of the recipient required | Jack O'Rogers |
|
phone string the phone number of the recipient required | (336) 222-7000 |
|
postal_code string the postal code / zip number of the recipient. Specific format depends on the country | 27215 |
|
state string the state of the recipient | NC |
|
street1 string the first line of the street address of the recipient required | 525 S. ZENKRAFT Ave |
|
street2 string the second line of the street address of the recipient | suite 120 |
|
street3 string the third line of the street address of the recipient | suite 120 |
|
shipments array required |
|
|
packages array required |
|
|
height number height of the package according to units specified under dim_units | 5 |
|
length number length of the package according to units specified under dim_units. ususally the length needs to be the largest of length, width, height | 11 |
|
value number value of the package according to currency specified | 25 |
|
weight number weight of the package according to units specified under weight_units | 4.2 |
|
width number width of the package according to units specified under dim_units | 8.5 |
|
recipient object Recipient of shiment |
|
|
city string the city of the recipient required | Burlington |
|
company string the company name of the recipient | Burlington Textiles Corp of America |
|
country string required | HK DE LA PS SC LY BV TW ZA VN SA PG BG MM TZ TF US IS MV GU MP RS EC MU GL PA SV PR KH MH OM AG SH WF ZW TN JM AU MR SE MZ ST CI UA RU VI NO SI SJ BB WS AS SD AZ GS ML ES DM AT BL AF MY PK TV NA SK SL BF FI TM BN GA AL SO FR DK TH PE CU GI GW TT GY HT TO SN MC TR GP TG LT CO BS IO CR AI DJ HM RE BH AX TK NZ VA ET BD TC BJ FO NL KR VE TJ EH BR EE CZ LI TL LV SM TD VU JO GT HU UM BE RW RO AQ BT NG CL KG MQ MT PL SS KN GQ PM HN BA IR CK PY PH YE IM CA LB CM ER IQ LC QA AR AO AE SZ ZM SG KZ CF FJ KE LS PW CN GB CD CY IN CH BO GG NC KW BM MX CW UG CG GE IL MS BI UY HR MN GH CV VG GM IE JP NE AW FM ME JE SB MF BY NI BQ KY MA KM AD DZ CX DO MO YT SR MW AM EG KI MD NF UZ VC NP LU BZ ID PT LR GD SY GF MG MK SX BW PN FK GR GN NU LK PF KP NR IT CC |
US |
email string the email address of the recipient | jrogers@example.com |
|
name string the name of the recipient required | Jack O'Rogers |
|
phone string the phone number of the recipient | (336) 222-7000 |
|
postal_code string the postal code / zip number of the recipient. Specific format depends on the country | 27215 |
|
state string the state of the recipient | NC |
|
street1 string the first line of the street address of the recipient required | 525 S. ZENKRAFT Ave |
|
street2 string the second line of the street address of the recipient | suite 120 |
|
street3 string the third line of the street address of the recipient | suite 120 |
|
service string the service type | fedex_1_day_freight fedex_2_day fedex_2_day_am fedex_2_day_freight fedex_3_day_freight fedex_express_saver fedex_first_freight fedex_freight_economy fedex_freight_priority fedex_ground fedex_first_overnight fedex_ground_home_delivery fedex_priority_overnight fedex_smart_post_media_mail fedex_smart_post_parcel_select fedex_smart_post_presorted_bound_printed_matter fedex_smart_post_presorted_standard fedex_smart_post_parcel_return fedex_standard_overnight fedex_europe_first_international_priority fedex_international_economy fedex_international_economy_freight fedex_international_first fedex_international_priority fedex_international_priority_express fedex_international_priority_freight fedex_next_day_early_morning fedex_next_day_mid_morning fedex_next_day_afternoon fedex_next_day_end_of_day fedex_distance_deferred fedex_next_day_freight fedex_regional_economy fedex_international_connect_plus fedex_first fedex_priority fedex_priority_express international_priority international_express |
fedex_1_day_freight |
shipping_account string Shipping account number required | 5190163571408896 |
|
test boolean calls created with test = true will be directed to the carrier test servers |
|
|
time object the date and time you want to create the pickup for. required |
|
|
close_time string end of pickup time required | 19:00 |
|
date string the date you want to create pickup for. required | 2021-06-07 |
|
ready_time string start of pickup time required | 12:30 |
|
weight_units string Weight units of the packages, pounds or kilograms required | KG LB |
LB |
Error Response
Field | Possible Values | Example |
---|---|---|
error object |
|
|
code string Standardized error code required | carrier_unsupported_method shipping_account_not_found carrier_timeout unexpected_exception carrier_failed_connection ship_date_past invalid_phone_number carrier_exception schema_field_required carrier_http_exception carrier_throttling shipping_account_wrong_carrier schema_validation_error carrier_authentication wrong_api_key missing_api_key |
carrier_exception |
detail string This field can contain additional information about the error. This field is not meant to be shown to the end-user required |
|
|
message object Error message required | FedEx API: The origin country code XX could not be found. Please check the country code. |
/pickup cancel POST
You can also cancel pickups. All you need to do is to replace the request payload root node name with 'cancel'. Other request parameters are the same as here.
/dopu POST
The dopu endpoint is used to retrieve the list of possible drop off locations nearby.
POST Request Parameters
Field | Possible Values | Example |
---|---|---|
dopu object required |
|
|
carrier string the carrier name required | fedex |
|
debug boolean calls with debug=true will be logged |
|
|
location object required |
|
|
city string the city of the recipient required | Burlington |
|
company string the company name of the recipient | Burlington Textiles Corp of America |
|
country string required | HK ZM DE LA PS SC LY BV TW ZA VN SA PG BG MM TZ TF IS US MV GU MP RS EC MU GL PA SV PR KH MH OM AG SH WF ZW TN JM AU MR SE MZ ST CI UA RU VI NO SI SJ BB WS AS SZ SD AZ GS ML ES DM AT BL AF MY PK TV NA SK BF SL FI TM BN GA AL SO FR DK TH PE CU GI GW TT GY HT TO SN MC SG GP TG TR LT CO BS IO CR AI DJ HM RE BH AX TK NZ VA ET BD TC BJ FO NL KR VE TJ EH BR EE CZ LI TL LV SM TD VU JO GT HU UM BE RW RO NR AQ BT NG CL KG MQ MT PL SS KN GQ PM HN BA IR CK PY PH YE IM CA LB CM ER IQ LC QA AR AO AE KZ CF FJ KE LS CN GB CD CY IN CH BO GG NC KW PW BM MX CW UG CG GE IL MS BI UY HR MN GH CV VG GM IE JP MF AW FM ME JE NE SB BY NI BQ KY MA KM AD DZ CX DO MO YT SR MW AM EG KI MD NF UZ VC LU BZ ID PT LR GD SY GF MG MK SX BW PN FK GR GN NU LK PF KP NP IT CC |
US |
email string the email address of the recipient | jrogers@example.com |
|
name string the name of the recipient required | Jack O'Rogers |
|
phone string the phone number of the recipient | (336) 222-7000 |
|
postal_code string the postal code / zip number of the recipient. Specific format depends on the country | 27215 |
|
state string the state of the recipient | NC |
|
street1 string the first line of the street address of the recipient required | 525 S. ZENKRAFT Ave |
|
street2 string the second line of the street address of the recipient | suite 120 |
|
street3 string the third line of the street address of the recipient | suite 120 |
|
shipping_account string Shipping account number required | 5190163571408896 |
|
test boolean calls created with test = true will be directed to the carrier test servers |
|
Successful Response
Field | Possible Values | Example |
---|---|---|
locations array |
|
|
city string | Burlington |
|
country string | AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW |
US |
distance number how far is it from the location described in the request to this pickup location | 1.3 |
|
distance_units string | km |
|
lat string latitude | -79.43575121732864 |
|
lng string longitude | 36.089788917096016 |
|
location_code string carrier assigned location ID | A4415567 |
|
location_name string name of the business/post office | United States Postal Service |
|
location_type string the type of this pickup location | post_office |
|
postal_code string | 27215 |
|
state string | NC |
|
street1 string | 405 Maple Ave |
Error Response
Field | Possible Values | Example |
---|---|---|
error object |
|
|
code string Standardized error code required | carrier_unsupported_method shipping_account_not_found carrier_timeout unexpected_exception carrier_failed_connection carrier_exception schema_field_required carrier_http_exception carrier_throttling shipping_account_wrong_carrier schema_validation_error carrier_authentication wrong_api_key missing_api_key |
carrier_exception |
detail string This field can contain additional information about the error. This field is not meant to be shown to the end-user required |
|
|
message string Error message required | FedEx API: Postal code specified is not in the correct format |
/pickup/availability POST
Find the time slots between the start_date
and the end_date
during which the carrier can pick up the specified shipments.
POST Request Parameters
Field | Possible Values | Example |
---|---|---|
pickup_availability object required |
|
|
carrier string the carrier name required | fedex |
|
close_time string Reserved for future use | 2021-06-04 |
|
currency string | GNF KZT AED HUF GTQ GMD FKP CHF SZL BWP TND BAM TOP CZK INR HTG GHS ZMW CDF SPL AOA KYD XAF TTD GIP MRU UGX IRR MXN BZD GGP MGA NOK PAB PHP RON RUB LKR CUC BOB BTN KGS MUR EUR AUD ZWD BIF SEK USD AWG KWD XOF SLL BYN PKR XPF BHD TZS SCR OMR MWK MVR VND GEL BGN DKK CUP SOS RSD PEN SDG NAD SVC HKD STN LRD JOD SYP TMT BSD GBP NGN ANG ARS AFN TWD NIO WST TRY ALL JEP LYD MKD BND ZAR SAR PGK NPR DJF NZD TJS HRK AMD MZN UYU BMD PYG CAD SGD CLP KRW BRL ILS JPY YER KHR MYR CRC QAR DZD COP MAD LBP VUV XDR VEF UAH ISK MDL BDT SRD CVE HNL XCD MMK GYD IMP LAK TVD KES AZN DOP ETB PLN THB FJD KMF IQD SBD UZS MOP BBD IDR KPW SHP CNY ERN MNT EGP LSL JMD RWF |
|
debug boolean calls with debug=true will be logged |
|
|
description string |
|
|
dim_units string Dimension units of the packages, inches or centimeters required | IN CM |
IN |
end_date string End of the range of dates to check required | 2021-06-04 |
|
location object required |
|
|
city string the city of the recipient required | Burlington |
|
company string the company name of the recipient | Burlington Textiles Corp of America |
|
country string required | HK DE LA PS SC LY BV TW ZA VN SA PG BG MM TZ TF US IS MV GU MP RS EC MU GL PA SV PR KH MH OM AG SH WF ZW TN JM AU MR SE MZ ST CI UA RU VI NO SI SJ BB WS AS SD AZ GS ML ES DM AT BL AF MY PK TV NA SK SL BF FI TM BN GA AL SO FR DK TH PE CU GI GW TT GY HT TO SN MC TR GP TG LT CO BS IO CR AI DJ HM RE BH AX TK NZ VA ET BD TC BJ FO NL KR VE TJ EH BR EE CZ LI TL LV SM TD VU JO GT HU UM BE RW RO AQ BT NG CL KG MQ MT PL SS KN GQ PM HN BA IR CK PY PH YE IM CA LB CM ER IQ LC QA AR AO AE SZ ZM SG KZ CF FJ KE LS PW CN GB CD CY IN CH BO GG NC KW BM MX CW UG CG GE IL MS BI UY HR MN GH CV VG GM IE JP NE AW FM ME JE SB MF BY NI BQ KY MA KM AD DZ CX DO MO YT SR MW AM EG KI MD NF UZ VC NP LU BZ ID PT LR GD SY GF MG MK SX BW PN FK GR GN NU LK PF KP NR IT CC |
US |
email string the email address of the recipient | jrogers@example.com |
|
location_type string description of the pickup location required | front |
|
name string the name of the recipient required | Jack O'Rogers |
|
phone string the phone number of the recipient required | (336) 222-7000 |
|
postal_code string the postal code / zip number of the recipient. Specific format depends on the country | 27215 |
|
state string the state of the recipient | NC |
|
street1 string the first line of the street address of the recipient required | 525 S. ZENKRAFT Ave |
|
street2 string the second line of the street address of the recipient | suite 120 |
|
street3 string the third line of the street address of the recipient | suite 120 |
|
ready_time string Reserved for future use | 2021-06-04 |
|
shipments array required |
|
|
packages array required |
|
|
height number height of the package according to units specified under dim_units | 5 |
|
length number length of the package according to units specified under dim_units. ususally the length needs to be the largest of length, width, height | 11 |
|
value number value of the package according to currency specified | 25 |
|
weight number weight of the package according to units specified under weight_units | 4.2 |
|
width number width of the package according to units specified under dim_units | 8.5 |
|
recipient object Recipient of shiment |
|
|
city string the city of the recipient required | Burlington |
|
company string the company name of the recipient | Burlington Textiles Corp of America |
|
country string required | HK DE LA PS SC LY BV TW ZA VN SA PG BG MM TZ TF US IS MV GU MP RS EC MU GL PA SV PR KH MH OM AG SH WF ZW TN JM AU MR SE MZ ST CI UA RU VI NO SI SJ BB WS AS SD AZ GS ML ES DM AT BL AF MY PK TV NA SK SL BF FI TM BN GA AL SO FR DK TH PE CU GI GW TT GY HT TO SN MC TR GP TG LT CO BS IO CR AI DJ HM RE BH AX TK NZ VA ET BD TC BJ FO NL KR VE TJ EH BR EE CZ LI TL LV SM TD VU JO GT HU UM BE RW RO AQ BT NG CL KG MQ MT PL SS KN GQ PM HN BA IR CK PY PH YE IM CA LB CM ER IQ LC QA AR AO AE SZ ZM SG KZ CF FJ KE LS PW CN GB CD CY IN CH BO GG NC KW BM MX CW UG CG GE IL MS BI UY HR MN GH CV VG GM IE JP NE AW FM ME JE SB MF BY NI BQ KY MA KM AD DZ CX DO MO YT SR MW AM EG KI MD NF UZ VC NP LU BZ ID PT LR GD SY GF MG MK SX BW PN FK GR GN NU LK PF KP NR IT CC |
US |
email string the email address of the recipient | jrogers@example.com |
|
name string the name of the recipient required | Jack O'Rogers |
|
phone string the phone number of the recipient | (336) 222-7000 |
|
postal_code string the postal code / zip number of the recipient. Specific format depends on the country | 27215 |
|
state string the state of the recipient | NC |
|
street1 string the first line of the street address of the recipient required | 525 S. ZENKRAFT Ave |
|
street2 string the second line of the street address of the recipient | suite 120 |
|
street3 string the third line of the street address of the recipient | suite 120 |
|
service string the service type | fedex_1_day_freight fedex_2_day fedex_2_day_am fedex_2_day_freight fedex_3_day_freight fedex_express_saver fedex_first_freight fedex_freight_economy fedex_freight_priority fedex_ground fedex_first_overnight fedex_ground_home_delivery fedex_priority_overnight fedex_smart_post_media_mail fedex_smart_post_parcel_select fedex_smart_post_presorted_bound_printed_matter fedex_smart_post_presorted_standard fedex_smart_post_parcel_return fedex_standard_overnight fedex_europe_first_international_priority fedex_international_economy fedex_international_economy_freight fedex_international_first fedex_international_priority fedex_international_priority_express fedex_international_priority_freight fedex_next_day_early_morning fedex_next_day_mid_morning fedex_next_day_afternoon fedex_next_day_end_of_day fedex_distance_deferred fedex_next_day_freight fedex_regional_economy fedex_international_connect_plus fedex_first fedex_priority fedex_priority_express international_priority international_express |
fedex_1_day_freight |
shipping_account string Shipping account number required | 5190163571408896 |
|
start_date string Start of the range of dates to check required | 2021-06-04 |
|
test boolean calls created with test = true will be directed to the carrier test servers |
|
|
weight_units string Weight units of the packages, pounds or kilograms required | KG LB |
LB |
Successful Response
Field | Possible Values | Example |
---|---|---|
pickup_availability object |
|
|
carrier string the carrier name required | fedex |
|
dates array |
|
|
date string Pickup date | 2021-06-04 |
|
earliest string The earliest time the shipments can be picked up | 09:00 |
|
latest string The latest time the shipments can be picked up | 18:00 |
|
debug boolean calls with debug=true will be logged |
|
|
dim_units string Dimension units of the packages, inches or centimeters | IN CM |
IN |
shipping_account string Shipping account number required | 5190163571408896 |
|
test boolean calls created with test = true will be directed to the carrier test servers |
|
|
weight_units string Weight units of the packages, pounds or kilograms | KG LB |
LB |
Error Response
Field | Possible Values | Example |
---|---|---|
error object |
|
|
code string Standardized error code required | carrier_unsupported_method shipping_account_not_found carrier_timeout missing_api_key unexpected_exception carrier_failed_connection ship_date_past invalid_phone_number carrier_exception schema_field_required carrier_throttling shipping_account_wrong_carrier schema_validation_error carrier_authentication wrong_api_key carrier_http_exception |
carrier_exception |
detail string This field can contain additional information about the error. This field is not meant to be shown to the end-user required |
|
|
message object Error message required | FedEx API: The origin country code XX could not be found. Please check the country code. |
/webhook POST
Webhooks provide you with a real-time view of your shipments.
1. Create a webhook configuration
In order to start using webhooks, you need to create a webhook configuration. You can find an example payload on the right side.
2. Receive a webhook
Now we will start sending tracking event updates as POST requests to your chosen address. The request will be formatted the same way as our track response
3. Verify a webhook
Webhooks can be verified by calculating a digital signature.
Each webhook request includes a base64-encoded X-Zenkraft-Hmac-SHA256
header, which is generated using your API key along with the data sent in the request.
Once you verify this signature, you can be sure the request came from us and you can continue your processing.
4. Response to a webhook
Your endpoint acknowledges that it received data by sending a 200 response. Any response outside of 200-range is considered an error. On our side, we have set a 5 second timeout. Any errors will be retried in a staggered manner over the course of the day.
Testing a Webhook
To test a webhook, run a local server or use a publicly available service such as Beeceptor. If you decide to run a server locally, then you need to make it publicly available using a service such as Pagekite or ngrok. The following URLs can't be endpoints for a webhook:
- Localhost
- Any URL ending in the word "internal"
- Domains like www.example.com
- Zenkraft domains such as api.zenkraft.com
POST Request Parameters
Field | Possible Values | Example |
---|---|---|
webhook object required |
|
|
api_version string The webhook version. Used for future compatibility | v1 |
|
callback string URL of the receiving endpoint required | https://webhook.site/3a788dd3-bd7c-44a8-bae0-297e3b68b508 |
|
debug boolean calls with debug=true will be logged |
|
|
description string Webhook description |
|
|
events array Events to receive. If left empty, it's assumed you want to receive all the events | shipment.delivered return.delivered shipment.out_for_delivery shipment.picked_up shipment.shipment_voided return.picked_up return.in_transit return.exception return.out_for_delivery return.created shipment.created shipment.in_transit return.shipment_voided shipment.exception |
shipment.delivered |
format string Currently only JSON is supported. Used for future compatibility | json |
|
headers array Headers that will be sent to the webhook callback. |
|
|
name string | Authorization |
|
value string | api_key |
|
name string Webhook name |
|
|
shipping_account_id integer | 123 |
|
trigger_mode string | stage checkpoint |
|
Successful Response
Field | Possible Values | Example |
---|---|---|
webhook object |
|
|
api_version string The webhook version. Used for future compatibility | v1 |
|
callback string URL of the receiving endpoint required | https://webhook.site/3a788dd3-bd7c-44a8-bae0-297e3b68b508 |
|
debug boolean calls with debug=true will be logged |
|
|
description string Webhook description |
|
|
events array Events to receive. If left empty, it's assumed you want to receive all the events | shipment.delivered return.delivered shipment.out_for_delivery shipment.picked_up shipment.shipment_voided return.picked_up return.in_transit return.exception return.out_for_delivery return.created shipment.created shipment.in_transit return.shipment_voided shipment.exception |
shipment.delivered |
format string Currently only JSON is supported. Used for future compatibility | json |
|
headers array Headers that will be sent to the webhook callback. |
|
|
name string | Authorization |
|
value string | api_key |
|
id string ID of the subscription | 484fe753dcda47a1b817456f3a10e38e |
|
name string Webhook name |
|
|
shipping_account_id integer | 123 |
|
trigger_mode string | stage checkpoint |
|
Error Response
Field | Possible Values | Example |
---|---|---|
error object |
|
|
code string Standardized error code required | missing_api_key wrong_api_key shipping_account_not_found shipping_account_wrong_carrier schema_validation_error schema_field_required unexpected_exception |
|
detail string This field can contain additional information about the error. This field is not meant to be shown to the end-user required |
|
|
message string Error message required | Missing zkkey HTTP header containing your Zenkraft API key |
/webhook GET
This endpoint allows you to retrieve previously created webhooks.
Successful Response
Field | Possible Values | Example |
---|---|---|
webhooks array |
|
|
api_version string The webhook version. Used for future compatibility | v1 |
|
callback string URL of the receiving endpoint | https://webhook.site/3a788dd3-bd7c-44a8-bae0-297e3b68b508 |
|
debug boolean calls with debug=true will be logged |
|
|
description string Webhook description |
|
|
events array Events to receive. If left empty, it's assumed you want to receive all the events | shipment.delivered return.delivered shipment.out_for_delivery shipment.picked_up shipment.shipment_voided return.picked_up return.in_transit return.exception return.out_for_delivery return.created shipment.created shipment.in_transit return.shipment_voided shipment.exception |
shipment.delivered |
format string Currently only JSON is supported. Used for future compatibility | json |
|
headers array Headers that will be sent to the webhook callback. |
|
|
name string | Authorization |
|
value string | api_key |
|
id string ID of the subscription | 484fe753dcda47a1b817456f3a10e38e |
|
name string Webhook name |
|
|
shipping_account_id integer | 123 |
|
trigger_mode string | stage checkpoint |
|
Error Response
Field | Possible Values | Example |
---|---|---|
error object |
|
|
code string Standardized error code required | missing_api_key wrong_api_key shipping_account_not_found shipping_account_wrong_carrier schema_validation_error schema_field_required unexpected_exception |
|
detail string This field can contain additional information about the error. This field is not meant to be shown to the end-user required |
|
|
message string Error message required | Missing zkkey HTTP header containing your Zenkraft API key |
/webhook/{webhook_id} PUT
This endpoint allows you to put the webhook.
PUT Request Parameters
Field | Possible Values | Example |
---|---|---|
webhook object |
|
|
api_version string The webhook version. Used for future compatibility | v1 |
|
callback string URL of the receiving endpoint required | https://webhook.site/3a788dd3-bd7c-44a8-bae0-297e3b68b508 |
|
debug boolean calls with debug=true will be logged |
|
|
description string Webhook description |
|
|
events array Events to receive. If left empty, it's assumed you want to receive all the events | shipment.delivered return.delivered shipment.out_for_delivery shipment.picked_up shipment.shipment_voided return.picked_up return.in_transit return.exception return.out_for_delivery return.created shipment.created shipment.in_transit return.shipment_voided shipment.exception |
shipment.delivered |
format string Currently only JSON is supported. Used for future compatibility | json |
|
headers array Headers that will be sent to the webhook callback. |
|
|
name string | Authorization |
|
value string | api_key |
|
name string Webhook name |
|
|
shipping_account_id integer | 123 |
|
trigger_mode string | stage checkpoint |
|
Successful Response
Field | Possible Values | Example |
---|---|---|
webhook object |
|
|
api_version string The webhook version. Used for future compatibility | v1 |
|
callback string URL of the receiving endpoint required | https://webhook.site/3a788dd3-bd7c-44a8-bae0-297e3b68b508 |
|
debug boolean calls with debug=true will be logged |
|
|
description string Webhook description |
|
|
events array Events to receive. If left empty, it's assumed you want to receive all the events | shipment.delivered return.delivered shipment.out_for_delivery shipment.picked_up shipment.shipment_voided return.picked_up return.in_transit return.exception return.out_for_delivery return.created shipment.created shipment.in_transit return.shipment_voided shipment.exception |
shipment.delivered |
format string Currently only JSON is supported. Used for future compatibility | json |
|
headers array Headers that will be sent to the webhook callback. |
|
|
name string | Authorization |
|
value string | api_key |
|
id string ID of the subscription | 484fe753dcda47a1b817456f3a10e38e |
|
name string Webhook name |
|
|
shipping_account_id integer | 123 |
|
trigger_mode string | stage checkpoint |
|
Error Response
Field | Possible Values | Example |
---|---|---|
error object |
|
|
code string Standardized error code. If the code equals `carrier_large_manifest` you might retrieve manifest_id from the error detail required | shipping_account_not_found unexpected_exception webhook_not_found schema_field_required shipping_account_wrong_carrier schema_validation_error wrong_api_key missing_api_key |
|
detail string This field can contain additional information about the error. This field is not meant to be shown to the end-user required |
|
|
message string Error message required | No webhook exists with that ID |
/webhook/{webhook_id} DELETE
This endpoint allows you to delete the specific webhook.
DELETE Request Parameters
Field | Possible Values | Example |
---|---|---|
webhook_id object ID of the previously created webhook returned from POST on /webhook required |
|
Successful Response
Field | Possible Values | Example |
---|---|---|
success object required |
|
|
message string Message describing the action was performed successfully | Success! |
Error Response
Field | Possible Values | Example |
---|---|---|
error object |
|
|
code string Standardized error code. If the code equals `carrier_large_manifest` you might retrieve manifest_id from the error detail required | shipping_account_not_found unexpected_exception webhook_not_found schema_field_required shipping_account_wrong_carrier schema_validation_error wrong_api_key missing_api_key |
|
detail string This field can contain additional information about the error. This field is not meant to be shown to the end-user required |
|
|
message string Error message required | No webhook exists with that ID |
Object References
currencies
Field | Type | Required | Min Length | Max Length |
locale
requested locale
Field | Type | Required | Min Length | Max Length |
countries
Field | Type | Required | Min Length | Max Length |
location
Field | Type | Required | Min Length | Max Length |
name | string | True | - | 35 |
company | string | - | 35 | |
street1 | string | True | - | 35 |
street2 | string | - | 35 | |
street3 | string | - | 35 | |
string | - | - | ||
phone | string | 10 | 15 | |
city | string | True | - | 35 |
state | string | - | 35 | |
postal_code | string | - | 20 | |
country | string | True | - | - |
packages
We need to know the size and dimensions of your packages.
Field | Type | Required | Min Length | Max Length |
weight | number | True | - | - |
value | number | - | - | |
length | number | - | - | |
width | number | - | - | |
height | number | - | - |
references
For carriers that allow you to add reference information to your shipment.
Field | Type | Required | Min Length | Max Length |
type | string | True | - | - |
value | string | True | - | - |
tracking_number
Tracking number of shipment
Field | Type | Required | Min Length | Max Length |
reference_number
some carriers allow you to track either by the tracking number or the reference number
Field | Type | Required | Min Length | Max Length |
confirmation_number
reference number of this pickup. It can be used to cancel the pickup if the carrier allows it
Field | Type | Required | Min Length | Max Length |
shipping_account
Shipping account number
Field | Type | Required | Min Length | Max Length |
special_services
Specific special services (e.g. COD or a Required Signature) depend on a carrier, so go through our documentation to find which those are
Field | Type | Required | Min Length | Max Length |
notifications
For carriers that allow you to set email/sms for notifications to your shippers.
Field | Type | Required | Min Length | Max Length |
type | string | True | - | - |
value | string | True | - | - |
customs_items
Additional information about packages
Field | Type | Required | Min Length | Max Length |
description | string | True | - | - |
quantity | integer | True | - | - |
value | number | True | - | - |
weight | number | True | - | - |
costs
Additional information about packages
Field | Type | Required | Min Length | Max Length |
base_charge | number | - | - | |
net_charge | number | - | - | |
taxes | number | - | - | |
surcharges | number | - | - | |
discounts | number | - | - |
shipping_documents
Additional information about packages
Field | Type | Required | Min Length | Max Length |
description | string | True | - | - |
document_type | string | True | - | - |
document | string | True | - | - |
carrier
the carrier name
Field | Type | Required | Min Length | Max Length |
status
the most recent important status description
Field | Type | Required | Min Length | Max Length |
tracking_stage
the most recent important status standardized shipment stage
Field | Type | Required | Min Length | Max Length |
label_type
the label format of the shipping labels
Field | Type | Required | Min Length | Max Length |
label_size
the shipping labels size
Field | Type | Required | Min Length | Max Length |
service
the service type
Field | Type | Required | Min Length | Max Length |
recipient
Recipient of shiment
Field | Type | Required | Min Length | Max Length |
name | string | True | - | 35 |
company | string | - | 35 | |
street1 | string | True | - | 35 |
street2 | string | - | 35 | |
street3 | string | - | 35 | |
string | - | - | ||
phone | string | 10 | 15 | |
city | string | True | - | 35 |
state | string | - | 35 | |
postal_code | string | - | 20 | |
country | string | True | - | - |
dim_units
Dimension units of the packages, inches or centimeters
Field | Type | Required | Min Length | Max Length |
weight_units
Weight units of the packages, pounds or kilograms
Field | Type | Required | Min Length | Max Length |
created
when was this object created
Field | Type | Required | Min Length | Max Length |
updated
when was this object updated
Field | Type | Required | Min Length | Max Length |
debug
calls with debug=true will be logged
Field | Type | Required | Min Length | Max Length |
base_shipment
Definition of the shipment payload
Field | Type | Required | Min Length | Max Length |
carrier | string | True | - | - |
shipping_account | string | True | - | - |
test | boolean | - | - | |
debug | boolean | - | - | |
ship_date | string | - | - | |
type | string | - | - | |
service | string | - | - | |
special_services | array | - | - | |
packaging | string | True | - | - |
dim_units | string | True | - | - |
weight_units | string | True | - | - |
currency | string | - | - | |
sender | object | True | - | - |
recipient | object | True | - | - |
packages | array | True | - | - |
shipment
Definition of the shipment payload
Field | Type | Required | Min Length | Max Length |
carrier | string | True | - | - |
shipping_account | string | True | - | - |
test | boolean | - | - | |
debug | boolean | - | - | |
ship_date | string | - | - | |
type | string | - | - | |
service | string | True | - | - |
special_services | array | - | - | |
packaging | string | True | - | - |
dim_units | string | True | - | - |
weight_units | string | True | - | - |
currency | string | - | - | |
sender | object | True | - | - |
recipient | object | True | - | - |
packages | array | True | - | - |
label_type | string | True | - | - |
label_size | string | - | - | |
include_base64_label | boolean | - | - | |
references | array | - | - | |
notifications | array | - | - |
shipment_id
shipment ID
Field | Type | Required | Min Length | Max Length |
shipment_status
Standardized shipment status
Field | Type | Required | Min Length | Max Length |
ship_response
Field | Type | Required | Min Length | Max Length |
shipment | True | - | - |
_shipment_status_response
Field | Type | Required | Min Length | Max Length |
shipment | True | - | - |
shipment_status_pending_response
Field | Type | Required | Min Length | Max Length |
shipment | True | - | - |
shipment_status_success_response
Field | Type | Required | Min Length | Max Length |
shipment | True | - | - |
rate
Definition of the shipment payload
Field | Type | Required | Min Length | Max Length |
carrier | string | True | - | - |
shipping_account | string | True | - | - |
test | boolean | - | - | |
debug | boolean | - | - | |
ship_date | string | - | - | |
type | string | - | - | |
service | string | - | - | |
special_services | array | - | - | |
packaging | string | True | - | - |
dim_units | string | True | - | - |
weight_units | string | True | - | - |
currency | string | - | - | |
sender | object | True | - | - |
recipient | object | True | - | - |
packages | array | True | - | - |
rate_response
Field | Type | Required | Min Length | Max Length |
rates | array | True | - | - |
pickup_response
Field | Type | Required | Min Length | Max Length |
pickup | object | True | - | - |
cancel_pickup_response
Field | Type | Required | Min Length | Max Length |
cancel | object | True | - | - |
pickup_availability_response
Field | Type | Required | Min Length | Max Length |
pickup_availability | object | True | - | - |
cancel_pickup
Field | Type | Required | Min Length | Max Length |
carrier | string | True | - | - |
shipping_account | string | True | - | - |
test | boolean | - | - | |
debug | boolean | - | - | |
confirmation_number | string | True | - | - |
_pickup
Field | Type | Required | Min Length | Max Length |
carrier | string | True | - | - |
shipping_account | string | True | - | - |
test | boolean | - | - | |
debug | boolean | - | - | |
description | string | - | - | |
currency | string | - | - | |
dim_units | string | True | - | - |
weight_units | string | True | - | - |
location | object | True | - | - |
shipments | array | True | - | - |
time | object | True | - | - |
__pickup
Field | Type | Required | Min Length | Max Length |
carrier | string | True | - | - |
shipping_account | string | True | - | - |
test | boolean | - | - | |
debug | boolean | - | - | |
description | string | - | - | |
currency | string | - | - | |
dim_units | string | True | - | - |
weight_units | string | True | - | - |
location | object | True | - | - |
shipments | array | True | - | - |
__track
Field | Type | Required | Min Length | Max Length |
carrier | string | True | - | - |
shipping_account | string | True | - | - |
test | boolean | - | - | |
debug | boolean | - | - | |
checkpoints | boolean | - | - | |
refresh | boolean | - | - | |
webhooks | boolean | - | - | |
locale | string | - | - |
track_by_tracking_number
Field | Type | Required | Min Length | Max Length |
carrier | string | True | - | - |
shipping_account | string | True | - | - |
test | boolean | - | - | |
debug | boolean | - | - | |
checkpoints | boolean | - | - | |
refresh | boolean | - | - | |
webhooks | boolean | - | - | |
locale | string | - | - | |
tracking_number | string | True | - | - |
track_by_reference_number
Field | Type | Required | Min Length | Max Length |
carrier | string | True | - | - |
shipping_account | string | True | - | - |
test | boolean | - | - | |
debug | boolean | - | - | |
checkpoints | boolean | - | - | |
refresh | boolean | - | - | |
webhooks | boolean | - | - | |
locale | string | - | - | |
reference_number | string | True | - | - |
track
Field | Type | Required | Min Length | Max Length |
carrier | string | True | - | - |
shipping_account | string | True | - | - |
test | boolean | - | - | |
debug | boolean | - | - | |
checkpoints | boolean | - | - | |
refresh | boolean | - | - | |
webhooks | boolean | - | - | |
locale | string | - | - | |
tracking_number | string | True | - | - |
estimated_delivery
estimated delivery date of this shipment
Field | Type | Required | Min Length | Max Length |
track_response
Field | Type | Required | Min Length | Max Length |
carrier | string | - | - | |
delivered | boolean | - | - | |
estimated_delivery | string | - | - | |
delivery_date | string | - | - | |
tracking_number | string | - | - | |
status | string | - | - | |
tracking_stage | string | - | - | |
locale | string | - | - | |
checkpoints | array | - | - |
manifest_id
carrier ID of this manifest which can be used in GET on /manifest/<manifest_id>
Field | Type | Required | Min Length | Max Length |
manifest_post_response
Field | Type | Required | Min Length | Max Length |
manifest | True | - | - |
manifest_get_response
Field | Type | Required | Min Length | Max Length |
manifest | True | - | - |
manifest_list_response
Field | Type | Required | Min Length | Max Length |
manifests | array | True | - | - |
webhook
Field | Type | Required | Min Length | Max Length |
name | string | - | - | |
description | string | - | - | |
debug | boolean | - | - | |
api_version | string | - | - | |
format | string | - | - | |
events | array | - | - | |
callback | string | True | - | - |
headers | array | - | - | |
shipping_account_id | integer | - | - | |
trigger_mode | string | - | - |
webhook_list_response
Field | Type | Required | Min Length | Max Length |
webhooks | array | True | - | - |
webhook_id
ID of the subscription
Field | Type | Required | Min Length | Max Length |
_webhook_response
Field | Type | Required | Min Length | Max Length |
name | string | - | - | |
description | string | - | - | |
debug | boolean | - | - | |
api_version | string | - | - | |
format | string | - | - | |
events | array | - | - | |
callback | string | True | - | - |
headers | array | - | - | |
shipping_account_id | integer | - | - | |
trigger_mode | string | - | - | |
id | string | - | - |
webhook_response
Field | Type | Required | Min Length | Max Length |
webhook | object | - | - |
dopu
Field | Type | Required | Min Length | Max Length |
carrier | string | True | - | - |
shipping_account | string | True | - | - |
test | boolean | - | - | |
debug | boolean | - | - | |
location | object | True | - | - |
dopu_response
Field | Type | Required | Min Length | Max Length |
locations | array | True | - | - |
shippingaccount_response
Carrier credentials
Field | Type | Required | Min Length | Max Length |
shipping_account | object | True | - | - |
error
Field | Type | Required | Min Length | Max Length |
error | object | True | - | - |
ship_error
Field | Type | Required | Min Length | Max Length |
error | object | True | - | - |
shipment_status_error
Field | Type | Required | Min Length | Max Length |
error | object | True | - | - |
rate_error
Field | Type | Required | Min Length | Max Length |
error | object | True | - | - |
shippingaccount_error
Field | Type | Required | Min Length | Max Length |
error | object | True | - | - |
track_error
Field | Type | Required | Min Length | Max Length |
error | object | True | - | - |
dopu_error
Field | Type | Required | Min Length | Max Length |
error | object | True | - | - |
pickup_error
Field | Type | Required | Min Length | Max Length |
error | object | True | - | - |
pickup_availability_error
Field | Type | Required | Min Length | Max Length |
error | object | True | - | - |
manifest_error
Field | Type | Required | Min Length | Max Length |
error | object | True | - | - |
webhook_error
Field | Type | Required | Min Length | Max Length |
error | object | True | - | - |
location_error
Field | Type | Required | Min Length | Max Length |
error | object | True | - | - |
successful_response
Field | Type | Required | Min Length | Max Length |
success | object | True | - | - |
UserBase
Field | Type | Required | Min Length | Max Length |
name | string | True | - | - |
string | True | - | - |
UserDetails
Field | Type | Required | Min Length | Max Length |
total_1_day | integer | True | - | - |
total_7_days | integer | True | - | - |
total_28_days | integer | True | - | - |
api_key | string | True | - | - |
user_token | string | True | - | - |
company | string | True | - | - |
created | string | True | - | - |
mfa | boolean | True | - | - |
User
Field | Type | Required | Min Length | Max Length |
name | string | True | - | - |
string | True | - | - | |
total_1_day | integer | True | - | - |
total_7_days | integer | True | - | - |
total_28_days | integer | True | - | - |
api_key | string | True | - | - |
user_token | string | True | - | - |
company | string | True | - | - |
created | string | True | - | - |
mfa | boolean | True | - | - |
log_item
Field | Type | Required | Min Length | Max Length |
id | string | - | - | |
created | string | - | - | |
status_code | number | - | - | |
url | string | - | - | |
ip_address | string | - | - |
LogDetails
Field | Type | Required | Min Length | Max Length |
id | string | - | - | |
created | string | - | - | |
status_code | number | - | - | |
url | string | - | - | |
ip_address | string | - | - | |
http_method | string | True | - | - |
user_agent | string | True | - | - |
content_type | string | True | - | - |
request | object | True | - | - |
response | object | True | - | - |
ShipmentCheckpoint
Field | Type | Required | Min Length | Max Length |
time | string | True | - | - |
status | string | True | - | - |
description | string | True | - | - |
ShipmentItem
Field | Type | Required | Min Length | Max Length |
id | string | True | - | - |
tracking_number | string | True | - | - |
reference_number | string | True | - | - |
carrier | string | True | - | - |
status | string | True | - | - |
created | string | True | - | - |
is_return | boolean | True | - | - |
ShipmentDetails
Field | Type | Required | Min Length | Max Length |
id | string | True | - | - |
tracking_number | string | True | - | - |
reference_number | string | True | - | - |
carrier | string | True | - | - |
status | string | True | - | - |
created | string | True | - | - |
is_return | boolean | True | - | - |
shipping_account_id | integer | True | - | - |
updated | string | True | - | - |
estimated_delivery | string | True | - | - |
checkpoints | array | True | - | - |
LocationBase
Field | Type | Required | Min Length | Max Length |
name | string | True | - | 35 |
company | string | True | - | 35 |
street1 | string | True | - | 35 |
street2 | string | - | 35 | |
street3 | string | - | 35 | |
string | True | - | - | |
phone | string | True | 10 | 15 |
city | string | True | - | 35 |
state | string | True | - | 35 |
postal_code | string | True | - | 20 |
country | string | True | - | - |
type | string | True | - | - |
timezone | string | - | - | |
cutoff_hours | integer | - | - | |
cutoff_minutes | integer | - | - |
Location
Field | Type | Required | Min Length | Max Length |
name | string | True | - | 35 |
company | string | True | - | 35 |
street1 | string | True | - | 35 |
street2 | string | - | 35 | |
street3 | string | - | 35 | |
string | True | - | - | |
phone | string | True | 10 | 15 |
city | string | True | - | 35 |
state | string | True | - | 35 |
postal_code | string | True | - | 20 |
country | string | True | - | - |
type | string | True | - | - |
timezone | string | - | - | |
cutoff_hours | integer | - | - | |
cutoff_minutes | integer | - | - | |
id | string | True | - | - |
updated | string | - | - |
return_method_type
Field | Type | Required | Min Length | Max Length |
return_line
Field | Type | Required | Min Length | Max Length |
quantity | integer | True | - | - |
value | number | True | - | - |
weight | number | True | - | - |
product_name | string | True | - | - |
line_id | string | True | - | - |
hs_code | string | True | - | - |
sku | string | True | - | - |
country_of_manufacture | string | True | - | - |
reasons | array | True | - | - |
operational_hours
Field | Type | Required | Min Length | Max Length |
open | string | True | - | - |
close | string | True | - | - |
return_cost
Field | Type | Required | Min Length | Max Length |
carrier_charge | number | True | - | - |
customer_charge | number | True | - | - |
ReturnMethodBase
Field | Type | Required | Min Length | Max Length |
position | integer | True | - | - |
method_name | string | True | 1 | 50 |
display_name | string | True | 1 | 50 |
type | string | True | - | - |
shipping_account_id | integer | True | - | - |
location_id | string | True | - | - |
sf_shipping_preference_id | string | - | - | |
service_type | string | True | - | - |
return_charge | string | True | - | - |
filters | array | True | - | - |
ReturnMethodCountryFilter
Field | Type | Required | Min Length | Max Length |
field | string | True | - | - |
operator | string | True | - | - |
value | string | True | - | - |
ReturnMethodNumberFilter
Field | Type | Required | Min Length | Max Length |
field | string | True | - | - |
operator | string | True | - | - |
value | string | True | - | - |
ReturnMethodCustomFilter
Field | Type | Required | Min Length | Max Length |
field | string | True | - | - |
operator | string | True | - | - |
name | string | True | - | 50 |
value | string | True | - | - |
ReturnMethod
Field | Type | Required | Min Length | Max Length |
position | integer | True | - | - |
method_name | string | True | 1 | 50 |
display_name | string | True | 1 | 50 |
type | string | True | - | - |
shipping_account_id | integer | True | - | - |
location_id | string | True | - | - |
sf_shipping_preference_id | string | - | - | |
service_type | string | True | - | - |
return_charge | string | True | - | - |
filters | array | True | - | - |
id | string | True | - | - |
ReturnMethodShortDetails
Field | Type | Required | Min Length | Max Length |
id | string | True | - | - |
carrier | string | True | - | - |
carrier_logo | string | True | - | - |
carrier_name | string | True | - | - |
method_name | string | True | - | - |
type | string | True | - | - |
return_pickup
Field | Type | Required | Min Length | Max Length |
id | string | True | - | - |
confirmation_number | string | True | - | - |
reference_number | string | True | - | - |
return_shipment
Field | Type | Required | Min Length | Max Length |
id | string | True | - | - |
tracking_number | string | True | - | - |
reference_number | string | True | - | - |
status | string | True | - | - |
label | string | True | - | - |
ReturnItem
Field | Type | Required | Min Length | Max Length |
id | string | True | - | - |
customer_id | string | True | - | - |
order_id | string | - | - | |
created | string | True | - | - |
return_lines | array | True | - | - |
return_method | object | True | - | - |
pickup | object | - | - | |
shipment | object | True | - | - |
custom | array | - | - |
return_method_error
Field | Type | Required | Min Length | Max Length |
error | object | True | - | - |
ShipmentEvent
Field | Type | Required | Min Length | Max Length |
carrier | string | True | - | - |
tracking_number | string | True | - | - |
from_country | string | True | - | - |
to_country | string | True | - | - |
service | string | True | - | - |
is_outbound | boolean | True | - | - |
total_costs | number | True | - | - |
currency | string | True | - | - |
created | string | True | - | - |
FtpConnectedAccountCredentials
Field | Type | Required | Min Length | Max Length |
ftp_username | string | True | - | - |
ftp_password | string | True | - | - |
FtpConnectedAccount
Field | Type | Required | Min Length | Max Length |
ftp_username | string | True | - | - |
ftp_password | string | True | - | - |
shipping_account_id | integer | True | - | - |
name | string | True | - | - |
service | integer | True | - | - |
QuantumViewConnectedAccount
Field | Type | Required | Min Length | Max Length |
shipping_account_id | integer | True | - | - |
name | string | True | - | - |
service | integer | True | - | - |
ShopifyConnectedAccount
Field | Type | Required | Min Length | Max Length |
shop_url | string | True | - | - |
shipping_account | array | True | - | - |
name | string | True | - | - |
service | integer | True | - | - |
custom_context
Custom context attached to the return
Field | Type | Required | Min Length | Max Length |
NewstoreConnectedAccount
Field | Type | Required | Min Length | Max Length |
shipping_account_id | string | True | - | - |
shipping_account_key | integer | True | - | - |
name | string | True | - | - |
service | integer | True | - | - |
SalesforceCore
Field | Type | Required | Min Length | Max Length |
service | integer | True | - | - |
environment | string | True | - | - |
custom_domain | string | True | - | - |
SalesforceCommerceCloud
Field | Type | Required | Min Length | Max Length |
url | string | True | - | - |
service | integer | True | - | - |
ConnectedAccountBase
Field | Type | Required | Min Length | Max Length |
id | string | True | - | - |
status | string | True | - | - |
ItemConnectedAccount
Field | Type | Required | Min Length | Max Length |
id | string | True | - | - |
status | string | True | - | - |
ftp_username | string | True | - | - |
ftp_password | string | True | - | - |
shipping_account_id | integer | True | - | - |
name | string | True | - | - |
service | integer | True | - | - |
CreateConnectedAccount
Field | Type | Required | Min Length | Max Length |
id | string | True | - | - |
status | string | True | - | - |
ftp_username | string | True | - | - |
ftp_password | string | True | - | - |
shipping_account_id | integer | True | - | - |
name | string | True | - | - |
service | integer | True | - | - |
UpdateConnectedAccount
Field | Type | Required | Min Length | Max Length |
id | string | True | - | - |
status | string | True | - | - |
ftp_username | string | True | - | - |
ftp_password | string | True | - | - |
shipping_account_id | integer | True | - | - |
name | string | True | - | - |
service | integer | True | - | - |
connected_account_error
Field | Type | Required | Min Length | Max Length |
error | object | True | - | - |