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.
zkkey : your_api_keyBase URL
https://api.zenkraft.com
/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 | HU AO MA CU BQ MO CX EG TV BN TJ PK AR BF MK PR MM AL DE ZA GT BJ GW LC TN RE MT IE LU KY RU UG AZ CA ZM GN GH IN PT UA TL CH CC NA JM GB KE MN NP PA CN HK GA MC AQ BT LR SM UZ AG MW EH ML AX BO KM NC PE EE MF KW BR TD BG NL MR DZ TW VN SA ST JO VE IQ MV MU SX SZ CF GI MP GU AS KR PL RW SV BH VU RO VA YT CM TZ JE GD EC AE FR DJ UM HN JP ME PG SS HT VG HM GG BZ ZW NU IM PW LB VI HR WF MY LS TG MX MZ IL SG CO PH MG GP IS CG CR SJ UY NF BA BM GF CW TR SH WS TF OM ES SK AW YE NO BI PN GQ SL GL PM TO FM KG AM BS AT MQ GM KI SN SO KP FO CY DK CL GE IO KH RS VC NZ BY LK PS LA TM PY KZ BE IT MD NG BB GS NR CZ ER BL TH SY BV AU FI FK SR CK DM DO SC PF FJ CI SD US NE AF AD LT BD LY CD IR KN LI TT MS TC MH ID CV AI QA GY GR BW ET LV SE TK SI NI SB |
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 | HU AO MA BQ CU MO CX EG TV BN PK AR BF MK MM PR TJ AL DE ZA GT BJ GW LC TN RE MT IE LU KY RU UG AZ CA ZM GN GH IN PT UA TL CH CC NA JM GB KE MN NP PA CN HK GA MC AQ BT LR SM UZ AG MW EH ML AX BO KM NC PE EE MF KW BR TD BG MR NL DZ TW VN SA ST JO VE IQ MV MU SX SZ NI CF GI MP GU AS KR PL RW SV BH VU RO VA YT CM TZ JE GD EC AE FR DJ UM HN JP ME PG SS HT VG HM GG BZ ZW NU IM PW LB VI HR WF MY LS TG MX MZ IL SG CO PH MG GP IS CG CR SJ UY NF BA BM GF CW TR SH WS TF OM ES SK AW YE NO BI PN GQ SL GL PM TO FM KG AM BS AT MQ GM KI SN SO KP FO CY DK GE IO KH RS VC NZ BY LK PS LA TM PY KZ BE IT MD NG BB GS NR CZ ER BL TH SY BV AU FI FK SR CK DM DO SC PF FJ CI SD US NE AF AD LT BD LY CD IR KN LI TT MS TC MH ID CV AI QA GY GR BW ET LV SE TK SI CL SB |
US |
| defaults object | |
|
| currency string | BND JPY MKD LRD SEK AFN TOP CZK GYD MDL ISK TND SGD ARS VUV ILS KGS TWD SRD LSL IDR BYN DKK FJD NZD BTN SCR DOP PAB KZT TJS CUC BMD PHP SOS BSD GHS RSD TRY BHD XDR SLL MNT USD EGP OMR BAM RON HRK MMK SVC BIF JOD CNY LAK MUR LYD NIO YER ZMW KMF FKP MZN SPL GMD CUP GGP AOA HUF JMD ETB UZS HKD SHP CAD VEF XPF RWF KPW ALL RUB BOB SZL MAD MVR NOK AZN CVE GEL MYR ANG NGN MWK UGX LKR BDT KRW MXN HNL MRU AED PGK SBD AUD PLN PKR CRC AWG SYP ERN IMP GBP NAD TTD LBP XCD NPR CLP KHR CDF THB SAR UAH KES GNF IRR GIP CHF TZS IQD KWD BGN PEN UYU JEP MGA BWP GTQ VND EUR PYG TVD ZWD TMT DJF XAF STN WST BRL HTG BBD KYD SDG XOF ZAR QAR BZD DZD INR AMD MOP COP |
|
| dim_units string Dimension units of the packages, inches or centimeters | CM IN |
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 ZPL ZPL__STOCK_4X6 ZPL__STOCK_4X6.75_LEADING_DOC_TAB ZPL__STOCK_4X6.75_TRAILING_DOC_TAB ZPL__STOCK_4X8 ZPL__STOCK_4X9_LEADING_DOC_TAB ZPL__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_transborder_distribution |
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 | HU AO MA BQ CU MO CX EG TV BN PK AR BF MK MM PR TJ AL DE ZA GT BJ GW LC TN RE MT IE LU KY RU UG AZ CA ZM GN GH IN PT UA TL CH CC NA JM GB KE MN NP PA CN HK GA MC AQ BT LR SM UZ AG MW EH ML AX BO KM NC PE EE MF KW BR TD BG MR NL DZ TW VN SA ST JO VE IQ MV MU SX SZ NI CF GI MP GU AS KR PL RW SV BH VU RO VA YT CM TZ JE GD EC AE FR DJ UM HN JP ME PG SS HT VG HM GG BZ ZW NU IM PW LB VI HR WF MY LS TG MX MZ IL SG CO PH MG GP IS CG CR SJ UY NF BA BM GF CW TR SH WS TF OM ES SK AW YE NO BI PN GQ SL GL PM TO FM KG AM BS AT MQ GM KI SN SO KP FO CY DK GE IO KH RS VC NZ BY LK PS LA TM PY KZ BE IT MD NG BB GS NR CZ ER BL TH SY BV AU FI FK SR CK DM DO SC PF FJ CI SD US NE AF AD LT BD LY CD IR KN LI TT MS TC MH ID CV AI QA GY GR BW ET LV SE TK SI CL SB |
US |
| defaults object required | |
|
| currency string | BND JPY MKD LRD SEK AFN TOP CZK GYD MDL ISK TND SGD ARS VUV ILS KGS TWD SRD LSL IDR BYN DKK FJD NZD BTN SCR DOP PAB KZT TJS CUC BMD PHP SOS BSD GHS RSD TRY BHD XDR SLL MNT USD EGP OMR BAM RON HRK MMK SVC BIF JOD CNY LAK MUR LYD NIO YER ZMW KMF FKP MZN SPL GMD CUP GGP AOA HUF JMD ETB UZS HKD SHP CAD VEF XPF RWF KPW ALL RUB BOB SZL MAD MVR NOK AZN CVE GEL MYR ANG NGN MWK UGX LKR BDT KRW MXN HNL MRU AED PGK SBD AUD PLN PKR CRC AWG SYP ERN IMP GBP NAD TTD LBP XCD NPR CLP KHR CDF THB SAR UAH KES GNF IRR GIP CHF TZS IQD KWD BGN PEN UYU JEP MGA BWP GTQ VND EUR PYG TVD ZWD TMT DJF XAF STN WST BRL HTG BBD KYD SDG XOF ZAR QAR BZD DZD INR AMD MOP COP |
|
| dim_units string Dimension units of the packages, inches or centimeters | CM IN |
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 ZPL ZPL__STOCK_4X6 ZPL__STOCK_4X6.75_LEADING_DOC_TAB ZPL__STOCK_4X6.75_TRAILING_DOC_TAB ZPL__STOCK_4X8 ZPL__STOCK_4X9_LEADING_DOC_TAB ZPL__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_transborder_distribution |
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 | master_test_shipping_account_not_found shipping_account_wrong_carrier missing_api_key schema_validation_error wrong_api_key schema_field_required unexpected_exception shipping_account_not_found |
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 |
Example Request / Response
{
"shipping_account": {
"name": "Test",
"carrier": "fedex",
"auth": {
"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"
},
"billing_address": {
"city": "London",
"state": "",
"postal_code": "EC1R 4UG",
"name": "Test User",
"phone": "01222 555 555",
"country": "GB",
"company": "Zenkraft User",
"email": "testexample@gmail.com",
"street1": "1 Hardwick Street"
},
"country": "US",
"test" : true
}
}
curl --request POST \
--url https://api.zenkraft.com/shippingaccount \
--header 'content-type: application/json' \
--header 'zkkey: XXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
"shipping_account": {
"name": "Test",
"carrier": "fedex",
"auth": {
"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"
},
"billing_address": {
"city": "London",
"state": "",
"postal_code": "EC1R 4UG",
"name": "Test User",
"phone": "01222 555 555",
"country": "GB",
"company": "Zenkraft User",
"email": "testexample@gmail.com",
"street1": "1 Hardwick Street"
},
"country": "US",
"test" : true
}
}'
import requests
headers = {
"zkkey": "XXXXXXXXXXXXXXXXXXXXXXX"
}
payload = {
"shipping_account": {
"name": "Test",
"carrier": "fedex",
"auth": {
"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"
},
"billing_address": {
"city": "London",
"state": "",
"postal_code": "EC1R 4UG",
"name": "Test User",
"phone": "01222 555 555",
"country": "GB",
"company": "Zenkraft User",
"email": "testexample@gmail.com",
"street1": "1 Hardwick Street"
},
"country": "US",
"test" : true
}
}
url = "https://api.zenkraft.com/shippingaccount"
response = requests.request(url=url, method='POST', json=payload, headers=headers)
print(response.json())
{
"shipping_account": {
"name": "My FedEx test account",
"carrier": "fedex",
"country": "US",
"auth": {
"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"
},
"test": false,
"id": "567293923024"
}
}
/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 | BND JPY MKD LRD SEK AFN TOP CZK GYD MDL ISK TND SGD ARS VUV ILS KGS TWD SRD LSL IDR BYN DKK FJD NZD BTN SCR DOP PAB KZT TJS CUC BMD PHP SOS BSD GHS RSD TRY BHD XDR SLL MNT USD EGP OMR BAM RON HRK MMK SVC BIF JOD CNY LAK MUR LYD NIO YER ZMW KMF FKP MZN SPL GMD CUP GGP AOA HUF JMD ETB UZS HKD SHP CAD VEF XPF RWF KPW ALL RUB BOB SZL MAD MVR NOK AZN CVE GEL MYR ANG NGN MWK UGX LKR BDT KRW MXN HNL MRU AED PGK SBD AUD PLN PKR CRC AWG SYP ERN IMP GBP NAD TTD LBP XCD NPR CLP KHR CDF THB SAR UAH KES GNF IRR GIP CHF TZS IQD KWD BGN PEN UYU JEP MGA BWP GTQ VND EUR PYG TVD ZWD TMT DJF XAF STN WST BRL HTG BBD KYD SDG XOF ZAR QAR BZD DZD INR AMD MOP COP |
|
| debug boolean calls with debug=true will be logged | |
|
| dim_units string Dimension units of the packages, inches or centimeters required | CM IN |
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 | STOCK_4X6 PAPER_7X4.75 STOCK_4X9_LEADING_DOC_TAB STOCK_4X6.75_TRAILING_DOC_TAB PAPER_4X6 PAPER_8.5X11_TOP_HALF_LABEL STOCK_4X9_TRAILING_DOC_TAB PAPER_4X8 STOCK_4X8 PAPER_4X9 STOCK_4X6.75_LEADING_DOC_TAB PAPER_8.5X11_BOTTOM_HALF_LABEL |
STOCK_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 ZPL ZPL__STOCK_4X6 ZPL__STOCK_4X6.75_LEADING_DOC_TAB ZPL__STOCK_4X6.75_TRAILING_DOC_TAB ZPL__STOCK_4X8 ZPL__STOCK_4X9_LEADING_DOC_TAB ZPL__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 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 | HU AO MA BQ CU MO CX EG TV BN PK TJ AR BF MK PR MM AL DE ZA GT BJ GW LC TN RE MT IE LU KY RU UG AZ CA ZM GN GH IN PT UA TL CH CC NA JM GB KE MN NP PA CN HK GA MC AQ BT LR SM UZ AG MW EH ML AX BO KM NC PE EE MF KW BR TD BG MR NL DZ TW VN SA ST JO VE IQ MV MU SX SZ NI CF GI MP GU AS KR PL RW SV BH VU RO VA YT CM TZ JE GD EC AE FR DJ UM HN JP ME PG SS HT VG HM GG BZ ZW NU IM PW LB VI HR WF MY LS TG MX MZ IL SG CO PH MG GP IS CG CR SJ UY NF BA BM GF CW TR SH WS TF OM ES SK AW YE NO BI PN GQ SL GL PM TO FM KG AM BS AT MQ GM KI SN SO KP FO CY DK GE IO KH RS VC NZ BY LK PS LA TM PY KZ BE IT MD NG BB GS NR CZ ER BL TH SY BV AU FI FK SR CK DM DO SC PF FJ CI SD US NE AF AD LT BD LY CD IR KN LI TT MS TC MH ID CV AI QA GY GR BW ET LV SE TK SI CL SB |
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 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 | HU AO MA BQ CU MO CX EG TV BN PK TJ AR BF MK PR MM AL DE ZA GT BJ GW LC TN RE MT IE LU KY RU UG AZ CA ZM GN GH IN PT UA TL CH CC NA JM GB KE MN NP PA CN HK GA MC AQ BT LR SM UZ AG MW EH ML AX BO KM NC PE EE MF KW BR TD BG MR NL DZ TW VN SA ST JO VE IQ MV MU SX SZ NI CF GI MP GU AS KR PL RW SV BH VU RO VA YT CM TZ JE GD EC AE FR DJ UM HN JP ME PG SS HT VG HM GG BZ ZW NU IM PW LB VI HR WF MY LS TG MX MZ IL SG CO PH MG GP IS CG CR SJ UY NF BA BM GF CW TR SH WS TF OM ES SK AW YE NO BI PN GQ SL GL PM TO FM KG AM BS AT MQ GM KI SN SO KP FO CY DK GE IO KH RS VC NZ BY LK PS LA TM PY KZ BE IT MD NG BB GS NR CZ ER BL TH SY BV AU FI FK SR CK DM DO SC PF FJ CI SD US NE AF AD LT BD LY CD IR KN LI TT MS TC MH ID CV AI QA GY GR BW ET LV SE TK SI CL SB |
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_transborder_distribution |
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 fedex_one_rate |
[saturday_delivery ] |
| test boolean calls created with test = true will be directed to the carrier test servers | |
|
| type string outbound or return shipments | outbound return |
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_numberwhich can be used to track the shipments in the track endpointlabelfor 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 | STOCK_4X6 PAPER_7X4.75 STOCK_4X9_LEADING_DOC_TAB STOCK_4X6.75_TRAILING_DOC_TAB PAPER_4X6 PAPER_8.5X11_TOP_HALF_LABEL STOCK_4X9_TRAILING_DOC_TAB PAPER_4X8 STOCK_4X8 PAPER_4X9 STOCK_4X6.75_LEADING_DOC_TAB PAPER_8.5X11_BOTTOM_HALF_LABEL |
STOCK_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 fedex_one_rate |
[saturday_delivery ] |
| tracking_number string Tracking number of shipment | 567293923024 |
Error Response
| Field | Possible Values | Example |
|---|---|---|
| error object | |
|
| code string Standardized error code required | ship_date_past carrier_authentication shipping_account_wrong_carrier missing_api_key carrier_failed_connection carrier_shipment_generation_failed schema_validation_error carrier_http_exception wrong_api_key schema_field_required carrier_label_generation_failed invalid_phone_number carrier_throttling unexpected_exception shipping_account_not_found carrier_timeout carrier_unsupported_method carrier_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. |
Service Types
| Name | API value | Code | Domestic / international |
|---|---|---|---|
| FedEx 1 Day Freight | fedex_1_day_freight âžž | FEDEX_1_DAY_FREIGHT | |
| FedEx 2 Day | fedex_2_day âžž | FEDEX_2_DAY | |
| FedEx 2 Day AM | fedex_2_day_am âžž | FEDEX_2_DAY_AM | |
| FedEx 2 Day Freight | fedex_2_day_freight âžž | FEDEX_2_DAY_FREIGHT | |
| FedEx 3 Day Freight | fedex_3_day_freight âžž | FEDEX_3_DAY_FREIGHT | |
| FedEx Express Saver | fedex_express_saver âžž | FEDEX_EXPRESS_SAVER | |
| FedEx First Freight | fedex_first_freight âžž | FEDEX_FIRST_FREIGHT | |
| FedEx Freight Economy | fedex_freight_economy âžž | FEDEX_FREIGHT_ECONOMY | |
| FedEx Freight Priority | fedex_freight_priority âžž | FEDEX_FREIGHT_PRIORITY | |
| FedEx Ground | fedex_ground âžž | FEDEX_GROUND | |
| FedEx First Overnight | fedex_first_overnight âžž | FIRST_OVERNIGHT | |
| FedEx Ground Home Delivery | fedex_ground_home_delivery âžž | GROUND_HOME_DELIVERY | |
| FedEx Priority Overnight | fedex_priority_overnight âžž | PRIORITY_OVERNIGHT | |
| FedEx Smart Post Media MAil | fedex_smart_post_media_mail âžž | SMART_POST_MEDIA_MAIL | |
| FedEx Smart Post Parcel Select | fedex_smart_post_parcel_select âžž | SMART_POST_PARCEL_SELECT | |
| FedEx Smart Post Presorted Bound Printed Matter | fedex_smart_post_presorted_bound_printed_matter âžž | SMART_POST_PRESORTED_BOUND_PRINTED_MATTER | |
| FedEx Smart Post Presorted Standard | fedex_smart_post_presorted_standard âžž | SMART_POST_PRESORTED_STANDARD | |
| FedEx Smart Post Parcel Return | fedex_smart_post_parcel_return âžž | SMART_POST_PARCEL_RETURN | |
| FedEx Standard Overnight | fedex_standard_overnight âžž | STANDARD_OVERNIGHT | |
| FedEx Europe First International Priority | fedex_europe_first_international_priority âžž | EUROPE_FIRST_INTERNATIONAL_PRIORITY | |
| FedEx International Economy | fedex_international_economy âžž | INTERNATIONAL_ECONOMY | |
| FedEx International Economy Freight | fedex_international_economy_freight âžž | INTERNATIONAL_ECONOMY_FREIGHT | |
| FedEx International First | fedex_international_first âžž | INTERNATIONAL_FIRST | |
| FedEx International Priority | fedex_international_priority âžž | FEDEX_INTERNATIONAL_PRIORITY | |
| FedEx International Priority Express | fedex_international_priority_express âžž | FEDEX_INTERNATIONAL_PRIORITY_EXPRESS | |
| FedEx International Priority Freight | fedex_international_priority_freight âžž | INTERNATIONAL_PRIORITY_FREIGHT | |
| FedEx Next Day Early Morning | fedex_next_day_early_morning âžž | FEDEX_NEXT_DAY_EARLY_MORNING | |
| FedEx Next Day Mid Morning | fedex_next_day_mid_morning âžž | FEDEX_NEXT_DAY_MID_MORNING | |
| FedEx Next Day Afternoon | fedex_next_day_afternoon âžž | FEDEX_NEXT_DAY_AFTERNOON | |
| FedEx Next Day End of Day | fedex_next_day_end_of_day âžž | FEDEX_NEXT_DAY_END_OF_DAY | |
| FedEx Economy | fedex_distance_deferred âžž | FEDEX_DISTANCE_DEFERRED | |
| FedEx Next Day Freight | fedex_next_day_freight âžž | FEDEX_NEXT_DAY_FREIGHT | |
| FedEx Regional Economy | fedex_regional_economy âžž | FEDEX_REGIONAL_ECONOMY | |
| FedEx International Connect Plus | fedex_international_connect_plus âžž | FEDEX_INTERNATIONAL_CONNECT_PLUS | |
| FedEx First | fedex_first âžž | FEDEX_FIRST | |
| FedEx Priority | fedex_priority âžž | FEDEX_PRIORITY | |
| FedEx Priority Express | fedex_priority_express âžž | FEDEX_PRIORITY_EXPRESS | |
| FedEx International Priority | international_priority âžž | INTERNATIONAL_PRIORITY | |
| FedEx International Express | international_express âžž | INTERNATIONAL_EXPRESS | |
| FedEx Transborder Distribution | fedex_transborder_distribution âžž | TRANSBORDER_DISTRIBUTION | |
| 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 |
| OneRate | fedex_one_rate | FEDEX_ONE_RATE |
Package Special Services
| Name | API value | Code |
|---|---|---|
| Adult Signature Required | adult_signature_required | SIGNATURE_OPTION |
| Direct Signature Required | direct_signature_required | DIRECT_SIGNATURE_REQUIRED |
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 |
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 | |
| Insurance cost | insurance_cost | shipment | False | |
| Declaration Statement | declaration_statement | shipment | False | |
| Broker Name | broker_name | shipment | False | |
| Broker Phone Number | broker_phone | shipment | False | |
| Broker Company | broker_company | shipment | False | |
| Importer Type | importer_type | sender, recipient | 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 |
Address Fields
| Name | API value | Possible Values | Node | Required |
|---|---|---|---|---|
| Residential | residential | False | ||
| Location Type | location_type | front, none, rear, side | False |
Example Request / Response
{
"shipment": {
"carrier": "fedex",
"currency": "GBP",
"debug": true,
"dim_units": "CM",
"include_base64_label": true,
"label_type": "PDF",
"packages": [
{
"height": 1,
"length": 1,
"value": 1,
"weight": 1,
"width": 1,
"special_services": [
"adult_signature_required"
]
}
],
"packaging": "your_packaging",
"recipient": {
"city": "london",
"company": "Zenkraft User",
"country": "GB",
"email": "testexample@gmail.com",
"name": "Test User",
"phone": "01222 555 555",
"postal_code": "EC1R 4UG",
"state": "",
"street1": "1 Hardwick Street",
"residential": false,
"location_type": "front"
},
"sender": {
"city": "Bath",
"company": "TestCompany",
"country": "GB",
"email": "uk@testing.com",
"name": "TestCompany Name",
"phone": "",
"postal_code": "EC2R 6PJ",
"street1": "30 Moorgate",
"residential": false,
"location_type": "front"
},
"service": "fedex_1_day_freight",
"ship_date": "2025-01-21",
"shipping_account": "811195730",
"test": true,
"type": "outbound",
"weight_units": "KG",
"customs_items": [
{
"description": "Description",
"manufacture_country_code": "Manufacture Country Code",
"weight": 10.1,
"weight_unit": "KG",
"quantity": 1,
"quantity_unit": "uom",
"value": 10.1,
"harmonized_code": "Harmonized Code"
}
],
"terms_of_trade": "cost_and_freight",
"terms_of_payment": "Terms Of Payment",
"insurance_cost": 1,
"declaration_statement": "Declaration Statement",
"broker_name": "Broker Name",
"broker_phone": "Broker Phone Number",
"broker_company": "Broker Company",
"importer_type": "sender",
"references": [
{
"type": "ref",
"value": "Customer Reference"
},
{
"type": "customer_reference",
"value": "Customer Reference"
},
{
"type": "reference",
"value": "Customer Reference"
},
{
"type": "department_number",
"value": "Department Number"
},
{
"type": "invoice_number",
"value": "Invoice Number"
},
{
"type": "p_o_number",
"value": "P O Number"
},
{
"type": "rma_number",
"value": "RMA Number"
}
],
"label_size": "STOCK_4X6",
"special_services": [
"saturday_delivery"
]
}
}
curl --request POST \
--url https://api.zenkraft.com/ship \
--header 'content-type: application/json' \
--header 'zkkey: XXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
"shipment": {
"carrier": "fedex",
"currency": "GBP",
"debug": true,
"dim_units": "CM",
"include_base64_label": true,
"label_type": "PDF",
"packages": [
{
"height": 1,
"length": 1,
"value": 1,
"weight": 1,
"width": 1,
"special_services": [
"adult_signature_required"
]
}
],
"packaging": "your_packaging",
"recipient": {
"city": "london",
"company": "Zenkraft User",
"country": "GB",
"email": "testexample@gmail.com",
"name": "Test User",
"phone": "01222 555 555",
"postal_code": "EC1R 4UG",
"state": "",
"street1": "1 Hardwick Street",
"residential": false,
"location_type": "front"
},
"sender": {
"city": "Bath",
"company": "TestCompany",
"country": "GB",
"email": "uk@testing.com",
"name": "TestCompany Name",
"phone": "",
"postal_code": "EC2R 6PJ",
"street1": "30 Moorgate",
"residential": false,
"location_type": "front"
},
"service": "fedex_1_day_freight",
"ship_date": "2025-01-21",
"shipping_account": "811195730",
"test": true,
"type": "outbound",
"weight_units": "KG",
"customs_items": [
{
"description": "Description",
"manufacture_country_code": "Manufacture Country Code",
"weight": 10.1,
"weight_unit": "KG",
"quantity": 1,
"quantity_unit": "uom",
"value": 10.1,
"harmonized_code": "Harmonized Code"
}
],
"terms_of_trade": "cost_and_freight",
"terms_of_payment": "Terms Of Payment",
"insurance_cost": 1,
"declaration_statement": "Declaration Statement",
"broker_name": "Broker Name",
"broker_phone": "Broker Phone Number",
"broker_company": "Broker Company",
"importer_type": "sender",
"references": [
{
"type": "ref",
"value": "Customer Reference"
},
{
"type": "customer_reference",
"value": "Customer Reference"
},
{
"type": "reference",
"value": "Customer Reference"
},
{
"type": "department_number",
"value": "Department Number"
},
{
"type": "invoice_number",
"value": "Invoice Number"
},
{
"type": "p_o_number",
"value": "P O Number"
},
{
"type": "rma_number",
"value": "RMA Number"
}
],
"label_size": "STOCK_4X6",
"special_services": [
"saturday_delivery"
]
}
}'
import requests
headers = {
"zkkey": "XXXXXXXXXXXXXXXXXXXXXXX"
}
payload = {
"shipment": {
"carrier": "fedex",
"currency": "GBP",
"debug": true,
"dim_units": "CM",
"include_base64_label": true,
"label_type": "PDF",
"packages": [
{
"height": 1,
"length": 1,
"value": 1,
"weight": 1,
"width": 1,
"special_services": [
"adult_signature_required"
]
}
],
"packaging": "your_packaging",
"recipient": {
"city": "london",
"company": "Zenkraft User",
"country": "GB",
"email": "testexample@gmail.com",
"name": "Test User",
"phone": "01222 555 555",
"postal_code": "EC1R 4UG",
"state": "",
"street1": "1 Hardwick Street",
"residential": false,
"location_type": "front"
},
"sender": {
"city": "Bath",
"company": "TestCompany",
"country": "GB",
"email": "uk@testing.com",
"name": "TestCompany Name",
"phone": "",
"postal_code": "EC2R 6PJ",
"street1": "30 Moorgate",
"residential": false,
"location_type": "front"
},
"service": "fedex_1_day_freight",
"ship_date": "2025-01-21",
"shipping_account": "811195730",
"test": true,
"type": "outbound",
"weight_units": "KG",
"customs_items": [
{
"description": "Description",
"manufacture_country_code": "Manufacture Country Code",
"weight": 10.1,
"weight_unit": "KG",
"quantity": 1,
"quantity_unit": "uom",
"value": 10.1,
"harmonized_code": "Harmonized Code"
}
],
"terms_of_trade": "cost_and_freight",
"terms_of_payment": "Terms Of Payment",
"insurance_cost": 1,
"declaration_statement": "Declaration Statement",
"broker_name": "Broker Name",
"broker_phone": "Broker Phone Number",
"broker_company": "Broker Company",
"importer_type": "sender",
"references": [
{
"type": "ref",
"value": "Customer Reference"
},
{
"type": "customer_reference",
"value": "Customer Reference"
},
{
"type": "reference",
"value": "Customer Reference"
},
{
"type": "department_number",
"value": "Department Number"
},
{
"type": "invoice_number",
"value": "Invoice Number"
},
{
"type": "p_o_number",
"value": "P O Number"
},
{
"type": "rma_number",
"value": "RMA Number"
}
],
"label_size": "STOCK_4X6",
"special_services": [
"saturday_delivery"
]
}
}
url = "https://api.zenkraft.com/ship"
response = requests.request(url=url, method='POST', json=payload, headers=headers)
print(response.json())
{
"shipment": {
"carrier": "fedex",
"shipping_account": "5190163571408896",
"test": true,
"debug": false,
"ship_date": "2025-01-21",
"type": "outbound",
"service": "fedex_1_day_freight",
"special_services": [
"saturday_delivery"
],
"packaging": "your_packaging",
"dim_units": "IN",
"weight_units": "LB",
"currency": "USD",
"sender": {
"name": "Jack O'Rogers",
"company": "Burlington Textiles Corp of America",
"street1": "525 S. ZENKRAFT Ave",
"street2": "suite 120",
"email": "jrogers@example.com",
"phone": "(336) 222-7000",
"city": "Burlington",
"state": "NC",
"postal_code": "27215",
"country": "US"
},
"recipient": {
"name": "Jack O'Rogers",
"company": "Burlington Textiles Corp of America",
"street1": "525 S. ZENKRAFT Ave",
"street2": "suite 120",
"email": "jrogers@example.com",
"phone": "(336) 222-7000",
"city": "Burlington",
"state": "NC",
"postal_code": "27215",
"country": "US"
},
"packages": [
{
"weight": 4.2,
"value": 25,
"length": 11,
"width": 8.5,
"height": 5,
"tracking_number": "567293923024",
"label": "string"
}
],
"label_type": "PDF",
"include_base64_label": false,
"references": [
{
"type": "customer_reference",
"value": "ABC-000123"
}
],
"notifications": [
{
"type": "email",
"value": "notification1@example.com"
}
],
"costs": {
"base_charge": 100,
"net_charge": 80,
"taxes": 20,
"surcharges": 0,
"discounts": 0
},
"id": "1f02d12868a54ed88b6cb4dafaad325d",
"tracking_number": "567293923024",
"shipping_documents": [{
"description": "Commercial Invoice",
"document_type": "PDF",
"document": "string"
}],
"context": {}
}
}
/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 ZPL ZPL__STOCK_4X6 ZPL__STOCK_4X6.75_LEADING_DOC_TAB ZPL__STOCK_4X6.75_TRAILING_DOC_TAB ZPL__STOCK_4X8 ZPL__STOCK_4X9_LEADING_DOC_TAB ZPL__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_authentication shipping_account_wrong_carrier missing_api_key carrier_failed_connection schema_validation_error carrier_http_exception wrong_api_key schema_field_required carrier_label_generation_failed carrier_no_shipment_found carrier_throttling unexpected_exception shipping_account_not_found carrier_timeout carrier_unsupported_method carrier_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 | DHL Global Forwarding API: Your shipment was rejected due to an unpaid invoice on your previous shipment. Contact DHL support to resolve the issue. |
Example Request / Response
https://api.zenkraft.com/ship/b87ff34556ec4dba9e724963216d2dd7
curl --request GET \
--url https://api.zenkraft.com/ship/b87ff34556ec4dba9e724963216d2dd7 \
--header 'content-type: application/json' \
--header 'zkkey: XXXXXXXXXXXXXXXXXXXXXXX'
import requests
headers = {
"zkkey": "XXXXXXXXXXXXXXXXXXXXXXX"
}
payload = None
url = "https://api.zenkraft.com/ship/b87ff34556ec4dba9e724963216d2dd7"
response = requests.request(url=url, method='GET', json=payload, headers=headers)
print(response.json())
{
"shipment": {
"carrier": "fedex",
"shipping_account": "5190163571408896",
"test": true,
"debug": false,
"ship_date": "2025-01-21",
"type": "outbound",
"service": "fedex_1_day_freight",
"special_services": [
"saturday_delivery"
],
"packaging": "your_packaging",
"dim_units": "IN",
"weight_units": "LB",
"currency": "USD",
"sender": {
"name": "Jack O'Rogers",
"company": "Burlington Textiles Corp of America",
"street1": "525 S. ZENKRAFT Ave",
"street2": "suite 120",
"email": "jrogers@example.com",
"phone": "(336) 222-7000",
"city": "Burlington",
"state": "NC",
"postal_code": "27215",
"country": "US"
},
"recipient": {
"name": "Jack O'Rogers",
"company": "Burlington Textiles Corp of America",
"street1": "525 S. ZENKRAFT Ave",
"street2": "suite 120",
"email": "jrogers@example.com",
"phone": "(336) 222-7000",
"city": "Burlington",
"state": "NC",
"postal_code": "27215",
"country": "US"
},
"packages": [
{
"weight": 4.2,
"value": 25,
"length": 11,
"width": 8.5,
"height": 5,
"tracking_number": "567293923024",
"label": "string"
}
],
"label_type": "PDF",
"include_base64_label": false,
"references": [
{
"type": "customer_reference",
"value": "ABC-000123"
}
],
"notifications": [
{
"type": "email",
"value": "notification1@example.com"
}
],
"costs": {
"base_charge": 100,
"net_charge": 80,
"taxes": 20,
"surcharges": 0,
"discounts": 0
},
"id": "1f02d12868a54ed88b6cb4dafaad325d",
"tracking_number": "567293923024",
"shipping_documents": [{
"description": "Commercial Invoice",
"document_type": "PDF",
"document": "string"
}],
"context": {}
}
}
/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 | BND JPY MKD LRD SEK AFN TOP CZK GYD MDL ISK TND SGD ARS VUV ILS KGS TWD SRD LSL IDR BYN DKK FJD NZD BTN SCR DOP PAB KZT TJS CUC BMD PHP SOS BSD GHS RSD TRY BHD XDR SLL MNT USD EGP OMR BAM RON HRK MMK SVC BIF JOD CNY LAK MUR LYD NIO YER ZMW KMF FKP MZN SPL GMD CUP GGP AOA HUF JMD ETB UZS HKD SHP CAD VEF XPF RWF KPW ALL RUB BOB SZL MAD MVR NOK AZN CVE GEL MYR ANG NGN MWK UGX LKR BDT KRW MXN HNL MRU AED PGK SBD AUD PLN PKR CRC AWG SYP ERN IMP GBP NAD TTD LBP XCD NPR CLP KHR CDF THB SAR UAH KES GNF IRR GIP CHF TZS IQD KWD BGN PEN UYU JEP MGA BWP GTQ VND EUR PYG TVD ZWD TMT DJF XAF STN WST BRL HTG BBD KYD SDG XOF ZAR QAR BZD DZD INR AMD MOP COP |
|
| debug boolean calls with debug=true will be logged | |
|
| dim_units string Dimension units of the packages, inches or centimeters required | CM IN |
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 required | |
|
| city string the city of the recipient | Burlington |
|
| company string the company name of the recipient | Burlington Textiles Corp of America |
|
| country string required | HU AO MA BQ CU MO CX EG TV BN PK TJ AR BF MK PR MM AL DE ZA GT BJ GW LC TN RE MT IE LU KY RU UG AZ CA ZM GN GH IN PT UA TL CH CC NA JM GB KE MN NP PA CN HK GA MC AQ BT LR SM UZ AG MW EH ML AX BO KM NC PE EE MF KW BR TD BG MR NL DZ TW VN SA ST JO VE IQ MV MU SX SZ NI CF GI MP GU AS KR PL RW SV BH VU RO VA YT CM TZ JE GD EC AE FR DJ UM HN JP ME PG SS HT VG HM GG BZ ZW NU IM PW LB VI HR WF MY LS TG MX MZ IL SG CO PH MG GP IS CG CR SJ UY NF BA BM GF CW TR SH WS TF OM ES SK AW YE NO BI PN GQ SL GL PM TO FM KG AM BS AT MQ GM KI SN SO KP FO CY DK GE IO KH RS VC NZ BY LK PS LA TM PY KZ BE IT MD NG BB GS NR CZ ER BL TH SY BV AU FI FK SR CK DM DO SC PF FJ CI SD US NE AF AD LT BD LY CD IR KN LI TT MS TC MH ID CV AI QA GY GR BW ET LV SE TK SI CL SB |
US |
| email string the email address of the recipient | jrogers@example.com |
|
| name string the name of the recipient | 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 | 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 required | |
|
| city string the city of the recipient | Burlington |
|
| company string the company name of the recipient | Burlington Textiles Corp of America |
|
| country string required | HU AO MA BQ CU MO CX EG TV BN PK TJ AR BF MK PR MM AL DE ZA GT BJ GW LC TN RE MT IE LU KY RU UG AZ CA ZM GN GH IN PT UA TL CH CC NA JM GB KE MN NP PA CN HK GA MC AQ BT LR SM UZ AG MW EH ML AX BO KM NC PE EE MF KW BR TD BG MR NL DZ TW VN SA ST JO VE IQ MV MU SX SZ NI CF GI MP GU AS KR PL RW SV BH VU RO VA YT CM TZ JE GD EC AE FR DJ UM HN JP ME PG SS HT VG HM GG BZ ZW NU IM PW LB VI HR WF MY LS TG MX MZ IL SG CO PH MG GP IS CG CR SJ UY NF BA BM GF CW TR SH WS TF OM ES SK AW YE NO BI PN GQ SL GL PM TO FM KG AM BS AT MQ GM KI SN SO KP FO CY DK GE IO KH RS VC NZ BY LK PS LA TM PY KZ BE IT MD NG BB GS NR CZ ER BL TH SY BV AU FI FK SR CK DM DO SC PF FJ CI SD US NE AF AD LT BD LY CD IR KN LI TT MS TC MH ID CV AI QA GY GR BW ET LV SE TK SI CL SB |
US |
| email string the email address of the recipient | jrogers@example.com |
|
| name string the name of the recipient | 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 | 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_transborder_distribution |
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 fedex_one_rate |
[saturday_delivery ] |
| test boolean calls created with test = true will be directed to the carrier test servers | |
|
| type string outbound or return shipments | outbound return |
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_transborder_distribution |
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 | ship_date_past carrier_authentication shipping_account_wrong_carrier missing_api_key carrier_failed_connection schema_validation_error carrier_http_exception wrong_api_key schema_field_required carrier_throttling unexpected_exception shipping_account_not_found carrier_timeout carrier_unsupported_method carrier_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. |
Example Request / Response
{
"shipment": {
"carrier": "fedex",
"currency": "GBP",
"debug": true,
"dim_units": "CM",
"include_base64_label": true,
"label_type": "PDF",
"packages": [
{
"height": 1,
"length": 1,
"value": 1,
"weight": 1,
"width": 1,
"special_services": [
"adult_signature_required"
]
}
],
"packaging": "your_packaging",
"recipient": {
"city": "london",
"company": "Zenkraft User",
"country": "GB",
"email": "testexample@gmail.com",
"name": "Test User",
"phone": "01222 555 555",
"postal_code": "EC1R 4UG",
"state": "",
"street1": "1 Hardwick Street",
"residential": false,
"location_type": "front"
},
"sender": {
"city": "Bath",
"company": "TestCompany",
"country": "GB",
"email": "uk@testing.com",
"name": "TestCompany Name",
"phone": "",
"postal_code": "EC2R 6PJ",
"street1": "30 Moorgate",
"residential": false,
"location_type": "front"
},
"service": "fedex_1_day_freight",
"ship_date": "2025-01-21",
"shipping_account": "811195730",
"test": true,
"type": "outbound",
"weight_units": "KG",
"customs_items": [
{
"description": "Description",
"manufacture_country_code": "Manufacture Country Code",
"weight": 10.1,
"weight_unit": "KG",
"quantity": 1,
"quantity_unit": "uom",
"value": 10.1,
"harmonized_code": "Harmonized Code"
}
],
"terms_of_trade": "cost_and_freight",
"terms_of_payment": "Terms Of Payment",
"insurance_cost": 1,
"declaration_statement": "Declaration Statement",
"broker_name": "Broker Name",
"broker_phone": "Broker Phone Number",
"broker_company": "Broker Company",
"importer_type": "sender",
"references": [
{
"type": "ref",
"value": "Customer Reference"
},
{
"type": "customer_reference",
"value": "Customer Reference"
},
{
"type": "reference",
"value": "Customer Reference"
},
{
"type": "department_number",
"value": "Department Number"
},
{
"type": "invoice_number",
"value": "Invoice Number"
},
{
"type": "p_o_number",
"value": "P O Number"
},
{
"type": "rma_number",
"value": "RMA Number"
}
],
"label_size": "STOCK_4X6",
"special_services": [
"saturday_delivery"
]
}
}
curl --request POST \
--url https://api.zenkraft.com/rate \
--header 'content-type: application/json' \
--header 'zkkey: XXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
"shipment": {
"carrier": "fedex",
"currency": "GBP",
"debug": true,
"dim_units": "CM",
"include_base64_label": true,
"label_type": "PDF",
"packages": [
{
"height": 1,
"length": 1,
"value": 1,
"weight": 1,
"width": 1,
"special_services": [
"adult_signature_required"
]
}
],
"packaging": "your_packaging",
"recipient": {
"city": "london",
"company": "Zenkraft User",
"country": "GB",
"email": "testexample@gmail.com",
"name": "Test User",
"phone": "01222 555 555",
"postal_code": "EC1R 4UG",
"state": "",
"street1": "1 Hardwick Street",
"residential": false,
"location_type": "front"
},
"sender": {
"city": "Bath",
"company": "TestCompany",
"country": "GB",
"email": "uk@testing.com",
"name": "TestCompany Name",
"phone": "",
"postal_code": "EC2R 6PJ",
"street1": "30 Moorgate",
"residential": false,
"location_type": "front"
},
"service": "fedex_1_day_freight",
"ship_date": "2025-01-21",
"shipping_account": "811195730",
"test": true,
"type": "outbound",
"weight_units": "KG",
"customs_items": [
{
"description": "Description",
"manufacture_country_code": "Manufacture Country Code",
"weight": 10.1,
"weight_unit": "KG",
"quantity": 1,
"quantity_unit": "uom",
"value": 10.1,
"harmonized_code": "Harmonized Code"
}
],
"terms_of_trade": "cost_and_freight",
"terms_of_payment": "Terms Of Payment",
"insurance_cost": 1,
"declaration_statement": "Declaration Statement",
"broker_name": "Broker Name",
"broker_phone": "Broker Phone Number",
"broker_company": "Broker Company",
"importer_type": "sender",
"references": [
{
"type": "ref",
"value": "Customer Reference"
},
{
"type": "customer_reference",
"value": "Customer Reference"
},
{
"type": "reference",
"value": "Customer Reference"
},
{
"type": "department_number",
"value": "Department Number"
},
{
"type": "invoice_number",
"value": "Invoice Number"
},
{
"type": "p_o_number",
"value": "P O Number"
},
{
"type": "rma_number",
"value": "RMA Number"
}
],
"label_size": "STOCK_4X6",
"special_services": [
"saturday_delivery"
]
}
}'
import requests
headers = {
"zkkey": "XXXXXXXXXXXXXXXXXXXXXXX"
}
payload = {
"shipment": {
"carrier": "fedex",
"currency": "GBP",
"debug": true,
"dim_units": "CM",
"include_base64_label": true,
"label_type": "PDF",
"packages": [
{
"height": 1,
"length": 1,
"value": 1,
"weight": 1,
"width": 1,
"special_services": [
"adult_signature_required"
]
}
],
"packaging": "your_packaging",
"recipient": {
"city": "london",
"company": "Zenkraft User",
"country": "GB",
"email": "testexample@gmail.com",
"name": "Test User",
"phone": "01222 555 555",
"postal_code": "EC1R 4UG",
"state": "",
"street1": "1 Hardwick Street",
"residential": false,
"location_type": "front"
},
"sender": {
"city": "Bath",
"company": "TestCompany",
"country": "GB",
"email": "uk@testing.com",
"name": "TestCompany Name",
"phone": "",
"postal_code": "EC2R 6PJ",
"street1": "30 Moorgate",
"residential": false,
"location_type": "front"
},
"service": "fedex_1_day_freight",
"ship_date": "2025-01-21",
"shipping_account": "811195730",
"test": true,
"type": "outbound",
"weight_units": "KG",
"customs_items": [
{
"description": "Description",
"manufacture_country_code": "Manufacture Country Code",
"weight": 10.1,
"weight_unit": "KG",
"quantity": 1,
"quantity_unit": "uom",
"value": 10.1,
"harmonized_code": "Harmonized Code"
}
],
"terms_of_trade": "cost_and_freight",
"terms_of_payment": "Terms Of Payment",
"insurance_cost": 1,
"declaration_statement": "Declaration Statement",
"broker_name": "Broker Name",
"broker_phone": "Broker Phone Number",
"broker_company": "Broker Company",
"importer_type": "sender",
"references": [
{
"type": "ref",
"value": "Customer Reference"
},
{
"type": "customer_reference",
"value": "Customer Reference"
},
{
"type": "reference",
"value": "Customer Reference"
},
{
"type": "department_number",
"value": "Department Number"
},
{
"type": "invoice_number",
"value": "Invoice Number"
},
{
"type": "p_o_number",
"value": "P O Number"
},
{
"type": "rma_number",
"value": "RMA Number"
}
],
"label_size": "STOCK_4X6",
"special_services": [
"saturday_delivery"
]
}
}
url = "https://api.zenkraft.com/rate"
response = requests.request(url=url, method='POST', json=payload, headers=headers)
print(response.json())
/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 | zh_Hans es_MX shi_Latn_MA so_SO xog_UG bn_BD fr_CG ar_QA ur_PK bm_ML am_ET so_ET ru_RU si_LK ha_Latn_NG uk_UA eu_ES en_BE de_AT bo_CN pa_Arab_PK en_MU ar_EG ar_SA kl_GL khq_ML ms_MY ja_JP en_IL de_LI guz_KE luo_KE be_BY nd_ZW yue_Hant_HK fi_FI en_BZ kn_IN en_AS ar_BH es_NI ha_Latn_GH hu_HU en_GB vun_TZ en_CA ar_LY et_EE kw_GB rof_TZ de_CH fr_BF uz_Arab kam_KE ar_SY pt_MZ fr_RW es_PE en_HK saq_KE pt_PT fr_BI en_VI ro_RO sr_Cyrl rm_CH es_CL bn_IN fr_CH de_BE sg_CF ta_LK ur_IN sr_Cyrl_ME haw_US ak_GH fr_RE sv_FI fr_TG cs_CZ en_NZ az_Latn ta_IN om_ET es_HN shi_Tfng sr_Latn_RS bo_IN vi_VN ca_ES mg_MG pa_Arab hi_IN km_KH ti_ET to_TO uz_Arab_AF uz_Cyrl uz_Latn_UZ nl_NL en_ZW ar_KW shi_Tfng_MA hy_AM th_TH ar_OM nl_BE bez_TZ fo_FO fr_BE fr_SN kde_TZ en_PK tr_TR tzm_Latn_MA sl_SI zh_Hant en_TT ga_IE es_AR seh_MZ fr_LU es_GQ fr_KM ko_KR gl_ES es_BO mfe_MU teo_KE yo_NG fr_GA ar_TN cy_GB ee_GH ha_Latn_NE pt_BR ps_AF fr_GQ bs_BA zh_Hans_HK en_AU ff_SN zh_Hant_TW es_DO zh_Hans_SG fr_ML en_MP fr_MC fr_NE kea_CV sr_Cyrl_BA uz_Latn ms_BN ebu_KE is_IS gv_GB rw_RW en_IN jmc_TZ es_GT el_GR ar_AE ar_JO az_Cyrl naq_NA es_SV es_PY my_MM dav_KE kab_DZ it_IT ro_MD af_NA tzm_Latn gsw_CH fr_MF ki_KE kk_Cyrl_KZ mk_MK sr_Latn_BA fr_BL en_IE az_Latn_AZ fr_CD es_CR en_GU kln_KE ii_CN en_NA es_US en_US ses_ML teo_UG it_CH az_Cyrl_AZ de_DE fr_TD ka_GE es_UY ar_IQ es_ES mas_KE fr_MQ en_ZA bem_ZM fr_BJ gu_IN el_CY sw_KE en_MT es_EC pt_GW mr_IN zh_Hant_MO so_DJ cgg_UG sw_TZ da_DK nb_NO fr_MG luy_KE pa_Guru_IN mer_KE es_419 ar_YE kk_Cyrl ml_IN fa_IR mt_MT rwk_TZ as_IN fr_FR om_KE es_PA fr_GN shi_Latn fr_CI fr_CA ig_NG lv_LV pa_Guru so_KE sn_ZW ar_SD en_BW en_UM nyn_UG sr_Cyrl_RS ha_Latn sr_Latn es_CO ne_IN uz_Cyrl_UZ ar_MA zh_Hant_HK or_IN chr_US en_SG ne_NP he_IL zh_Hans_CN hr_HR sr_Latn_ME zh_Hans_MO en_JM es_PR nn_NO id_ID lag_TZ en_MH pl_PL ru_UA ar_LB en_PH mas_TZ fr_CM fil_PH fa_AF te_IN lg_UG fr_GP kok_IN lt_LT bg_BG es_VE sk_SK sv_SE asa_TZ sq_AL ar_DZ fr_DJ zu_ZA ti_ER af_ZA ee_TG fr_CF de_LU ru_MD |
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 | CREATION_PENDING CREATED PICKED_UP IN_TRANSIT OUT_FOR_DELIVERY DRIVER_ASSIGNED CHECKED_IN 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 | zh_Hans es_MX shi_Latn_MA so_SO xog_UG bn_BD fr_CG ar_QA ur_PK bm_ML am_ET ru_RU so_ET si_LK ha_Latn_NG uk_UA eu_ES en_BE de_AT bo_CN pa_Arab_PK en_MU ar_EG ar_SA kl_GL khq_ML ms_MY ja_JP en_IL de_LI guz_KE luo_KE be_BY nd_ZW yue_Hant_HK fi_FI en_BZ kn_IN en_AS ar_BH es_NI ha_Latn_GH hu_HU en_GB vun_TZ en_CA ar_LY et_EE kw_GB rof_TZ de_CH fr_BF uz_Arab kam_KE ar_SY pt_MZ fr_RW es_PE en_HK saq_KE pt_PT fr_BI en_VI ro_RO sr_Cyrl rm_CH es_CL bn_IN fr_CH de_BE sg_CF ta_LK ur_IN sr_Cyrl_ME haw_US ak_GH fr_RE sv_FI fr_TG cs_CZ en_NZ az_Latn ta_IN om_ET es_HN shi_Tfng sr_Latn_RS bo_IN vi_VN ca_ES mg_MG pa_Arab hi_IN km_KH ti_ET to_TO uz_Arab_AF uz_Cyrl uz_Latn_UZ nl_NL en_ZW ar_KW shi_Tfng_MA hy_AM th_TH ar_OM nl_BE bez_TZ fo_FO fr_BE fr_SN kde_TZ en_PK tr_TR tzm_Latn_MA sl_SI zh_Hant en_TT ga_IE es_AR seh_MZ fr_LU es_GQ fr_KM ko_KR gl_ES es_BO mfe_MU teo_KE yo_NG fr_GA ar_TN cy_GB ee_GH ha_Latn_NE pt_BR ps_AF fr_GQ bs_BA zh_Hans_HK en_AU ff_SN zh_Hant_TW es_DO zh_Hans_SG fr_ML en_MP fr_MC fr_NE kea_CV sr_Cyrl_BA uz_Latn ms_BN ebu_KE is_IS gv_GB rw_RW en_IN jmc_TZ es_GT el_GR ar_AE ar_JO az_Cyrl naq_NA es_SV es_PY my_MM dav_KE kab_DZ it_IT ro_MD af_NA tzm_Latn gsw_CH fr_MF ki_KE kk_Cyrl_KZ mk_MK sr_Latn_BA fr_BL en_IE az_Latn_AZ fr_CD es_CR en_GU kln_KE ii_CN en_NA es_US en_US ses_ML teo_UG it_CH az_Cyrl_AZ de_DE fr_TD ka_GE es_UY ar_IQ es_ES mas_KE fr_MQ en_ZA bem_ZM fr_BJ gu_IN el_CY sw_KE en_MT es_EC pt_GW mr_IN zh_Hant_MO so_DJ cgg_UG sw_TZ da_DK nb_NO fr_MG luy_KE pa_Guru_IN mer_KE es_419 ar_YE kk_Cyrl ml_IN fa_IR mt_MT rwk_TZ as_IN fr_FR om_KE es_PA fr_GN shi_Latn fr_CI fr_CA ig_NG lv_LV pa_Guru so_KE sn_ZW ar_SD en_BW en_UM nyn_UG sr_Cyrl_RS ha_Latn sr_Latn es_CO ne_IN uz_Cyrl_UZ ar_MA zh_Hant_HK or_IN chr_US en_SG ne_NP he_IL zh_Hans_CN hr_HR sr_Latn_ME zh_Hans_MO en_JM es_PR nn_NO id_ID lag_TZ en_MH pl_PL ru_UA ar_LB en_PH mas_TZ fr_CM fil_PH fa_AF te_IN lg_UG fr_GP kok_IN lt_LT bg_BG es_VE sk_SK sv_SE asa_TZ sq_AL ar_DZ fr_DJ zu_ZA ti_ER af_ZA ee_TG fr_CF de_LU ru_MD |
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 | CREATION_PENDING CREATED PICKED_UP IN_TRANSIT OUT_FOR_DELIVERY DRIVER_ASSIGNED CHECKED_IN DELIVERED SHIPMENT_VOIDED EXCEPTION |
DELIVERED |
Error Response
| Field | Possible Values | Example |
|---|---|---|
| error object | |
|
| code string Standardized error code required | carrier_authentication shipping_account_wrong_carrier missing_api_key carrier_failed_connection schema_validation_error carrier_http_exception wrong_api_key schema_field_required carrier_no_shipment_found carrier_throttling unexpected_exception shipping_account_not_found carrier_timeout carrier_unsupported_method carrier_exception |
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 |
Example Request / Response
{
"track": {
"test":false,
"carrier": "fedex",
"shipping_account": 00000000000000,
"tracking_number": "1Z7881280399212000"
}
}
curl --request POST \
--url https://api.zenkraft.com/track \
--header 'content-type: application/json' \
--header 'zkkey: XXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
"track": {
"test":false,
"carrier": "fedex",
"shipping_account": 00000000000000,
"tracking_number": "1Z7881280399212000"
}
}'
import requests
headers = {
"zkkey": "XXXXXXXXXXXXXXXXXXXXXXX"
}
payload = {
"track": {
"test":false,
"carrier": "fedex",
"shipping_account": 00000000000000,
"tracking_number": "1Z7881280399212000"
}
}
url = "https://api.zenkraft.com/track"
response = requests.request(url=url, method='POST', json=payload, headers=headers)
print(response.json())
{
"carrier": "fedex",
"delivered": true,
"estimated_delivery": "2021-06-07T00:00:00.000Z",
"delivery_date": "2021-06-07T00:00:00.000Z",
"tracking_number": "567293923024",
"status": "Delivered to a mailbox",
"tracking_stage": "DELIVERED",
"checkpoints": [
{
"description": "Delivered to a mailbox",
"status": "Delivered to a mailbox",
"tracking_stage": "DELIVERED",
"time": "2021-06-07T10:46:07.000+1000"
}
]
}
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.
Example Request / Response
[
{
"track": {
"test":false,
"carrier": "fedex",
"shipping_account": 00000000000000,
"tracking_number": "1Z7881280399212000"
}
},
{
"track": {
"test":false,
"carrier": "fedex",
"shipping_account": 00000000000000,
"tracking_number": "1Z7881280399212000"
}
}
]
curl --request POST \
--url https://api.zenkraft.com/track \
--header 'content-type: application/json' \
--header 'zkkey: XXXXXXXXXXXXXXXXXXXXXXX' \
--data '[
{
"track": {
"test":false,
"carrier": "fedex",
"shipping_account": 00000000000000,
"tracking_number": "1Z7881280399212000"
}
},
{
"track": {
"test":false,
"carrier": "fedex",
"shipping_account": 00000000000000,
"tracking_number": "1Z7881280399212000"
}
}
]'
import requests
headers = {
"zkkey": "XXXXXXXXXXXXXXXXXXXXXXX"
}
payload = [
{
"track": {
"test":false,
"carrier": "fedex",
"shipping_account": 00000000000000,
"tracking_number": "1Z7881280399212000"
}
},
{
"track": {
"test":false,
"carrier": "fedex",
"shipping_account": 00000000000000,
"tracking_number": "1Z7881280399212000"
}
}
]
url = "https://api.zenkraft.com/track"
response = requests.request(url=url, method='POST', json=payload, headers=headers)
print(response.json())
[
{
"carrier": "fedex",
"delivered": true,
"estimated_delivery": "2021-06-07T00:00:00.000Z",
"delivery_date": "2021-06-07T00:00:00.000Z",
"tracking_number": "567293923024",
"status": "Delivered to a mailbox",
"tracking_stage": "DELIVERED",
"checkpoints": [
{
"description": "Delivered to a mailbox",
"status": "Delivered to a mailbox",
"tracking_stage": "DELIVERED",
"time": "2021-06-07T10:46:07.000+1000"
}
]
},
{
"carrier": "fedex",
"delivered": true,
"estimated_delivery": "2021-06-07T00:00:00.000Z",
"delivery_date": "2021-06-07T00:00:00.000Z",
"tracking_number": "567293923024",
"status": "Delivered to a mailbox",
"tracking_stage": "DELIVERED",
"checkpoints": [
{
"description": "Delivered to a mailbox",
"status": "Delivered to a mailbox",
"tracking_stage": "DELIVERED",
"time": "2021-06-07T10:46:07.000+1000"
}
]
}
]
/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 | zh_Hans es_MX shi_Latn_MA so_SO xog_UG bn_BD fr_CG ar_QA ur_PK bm_ML so_ET am_ET ru_RU si_LK ha_Latn_NG uk_UA eu_ES en_BE de_AT bo_CN pa_Arab_PK en_MU ar_EG ar_SA kl_GL khq_ML ms_MY ja_JP en_IL de_LI guz_KE luo_KE be_BY nd_ZW yue_Hant_HK fi_FI en_BZ kn_IN en_AS ar_BH es_NI ha_Latn_GH hu_HU en_GB vun_TZ en_CA ar_LY et_EE kw_GB rof_TZ de_CH fr_BF uz_Arab kam_KE ar_SY pt_MZ fr_RW es_PE en_HK saq_KE pt_PT fr_BI en_VI ro_RO sr_Cyrl rm_CH es_CL fr_CH bn_IN de_BE sg_CF ur_IN ta_LK sr_Cyrl_ME haw_US ak_GH fr_RE sv_FI fr_TG cs_CZ en_NZ az_Latn ta_IN om_ET es_HN shi_Tfng sr_Latn_RS bo_IN vi_VN ca_ES mg_MG pa_Arab hi_IN km_KH ti_ET to_TO uz_Arab_AF uz_Cyrl uz_Latn_UZ nl_NL en_ZW ar_KW shi_Tfng_MA hy_AM th_TH ar_OM nl_BE bez_TZ fo_FO fr_BE fr_SN kde_TZ en_PK tr_TR tzm_Latn_MA sl_SI zh_Hant en_TT ga_IE es_AR seh_MZ fr_LU es_GQ fr_KM ko_KR gl_ES es_BO mfe_MU teo_KE yo_NG fr_GA ar_TN cy_GB ee_GH ha_Latn_NE pt_BR ps_AF fr_GQ bs_BA zh_Hans_HK en_AU ff_SN zh_Hant_TW es_DO zh_Hans_SG fr_ML en_MP fr_MC fr_NE kea_CV sr_Cyrl_BA uz_Latn ms_BN ebu_KE is_IS gv_GB rw_RW en_IN jmc_TZ es_GT el_GR ar_AE ar_JO az_Cyrl naq_NA es_SV es_PY my_MM dav_KE kab_DZ it_IT ro_MD af_NA tzm_Latn gsw_CH fr_MF ki_KE kk_Cyrl_KZ mk_MK sr_Latn_BA fr_BL en_IE az_Latn_AZ fr_CD es_CR en_GU kln_KE ii_CN en_NA es_US en_US ses_ML teo_UG it_CH az_Cyrl_AZ de_DE fr_TD ka_GE es_UY ar_IQ es_ES mas_KE fr_MQ en_ZA bem_ZM fr_BJ gu_IN el_CY sw_KE en_MT es_EC pt_GW mr_IN zh_Hant_MO so_DJ cgg_UG sw_TZ da_DK nb_NO fr_MG luy_KE pa_Guru_IN mer_KE es_419 ar_YE kk_Cyrl ml_IN fa_IR mt_MT rwk_TZ as_IN fr_FR om_KE es_PA fr_GN shi_Latn fr_CI fr_CA ig_NG lv_LV pa_Guru so_KE sn_ZW ar_SD en_BW en_UM nyn_UG sr_Cyrl_RS ha_Latn sr_Latn es_CO ne_IN uz_Cyrl_UZ ar_MA zh_Hant_HK or_IN chr_US en_SG ne_NP he_IL zh_Hans_CN hr_HR sr_Latn_ME zh_Hans_MO en_JM es_PR nn_NO id_ID lag_TZ en_MH pl_PL ru_UA ar_LB en_PH mas_TZ fr_CM fil_PH fa_AF te_IN lg_UG fr_GP kok_IN lt_LT bg_BG es_VE sk_SK sv_SE asa_TZ sq_AL ar_DZ fr_DJ zu_ZA ti_ER af_ZA ee_TG fr_CF de_LU ru_MD |
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_authentication shipping_account_wrong_carrier missing_api_key carrier_failed_connection schema_validation_error carrier_http_exception wrong_api_key schema_field_required carrier_no_shipment_found carrier_throttling unexpected_exception shipping_account_not_found carrier_timeout carrier_unsupported_method carrier_exception |
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 |
Example Request / Response
{
"cancel": {
"shipping_account": "00000000000000",
"carrier": "ups",
"tracking_number": "1Z168R020399800319"
}
}
curl --request POST \
--url https://api.zenkraft.com/cancel \
--header 'content-type: application/json' \
--header 'zkkey: XXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
"cancel": {
"shipping_account": "00000000000000",
"carrier": "ups",
"tracking_number": "1Z168R020399800319"
}
}'
import requests
headers = {
"zkkey": "XXXXXXXXXXXXXXXXXXXXXXX"
}
payload = {
"cancel": {
"shipping_account": "00000000000000",
"carrier": "ups",
"tracking_number": "1Z168R020399800319"
}
}
url = "https://api.zenkraft.com/cancel"
response = requests.request(url=url, method='POST', json=payload, headers=headers)
print(response.json())
/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 | BND JPY MKD LRD SEK AFN TOP CZK GYD MDL ISK TND SGD ARS VUV ILS KGS TWD SRD LSL IDR BYN DKK FJD NZD BTN SCR DOP PAB KZT TJS CUC BMD PHP SOS BSD GHS RSD TRY BHD XDR SLL MNT USD EGP OMR BAM RON HRK MMK SVC BIF JOD CNY LAK MUR LYD NIO YER ZMW KMF FKP MZN SPL GMD CUP GGP AOA HUF JMD ETB UZS HKD SHP CAD VEF XPF RWF KPW ALL RUB BOB SZL MAD MVR NOK AZN CVE GEL MYR ANG NGN MWK UGX LKR BDT KRW MXN HNL MRU AED PGK SBD AUD PLN PKR CRC AWG SYP ERN IMP GBP NAD TTD LBP XCD NPR CLP KHR CDF THB SAR UAH KES GNF IRR GIP CHF TZS IQD KWD BGN PEN UYU JEP MGA BWP GTQ VND EUR PYG TVD ZWD TMT DJF XAF STN WST BRL HTG BBD KYD SDG XOF ZAR QAR BZD DZD INR AMD MOP COP |
|
| debug boolean calls with debug=true will be logged | |
|
| description string | |
|
| dim_units string Dimension units of the packages, inches or centimeters required | CM IN |
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 | HU AO MA BQ CU MO CX EG TV BN PK TJ AR BF MK PR MM AL DE ZA GT BJ GW LC TN RE MT IE LU KY RU UG AZ CA ZM GN GH IN PT UA TL CH CC NA JM GB KE MN NP PA CN HK GA MC AQ BT LR SM UZ AG MW EH ML AX BO KM NC PE EE MF KW BR TD BG MR NL DZ TW VN SA ST JO VE IQ MV MU SX SZ NI CF GI MP GU AS KR PL RW SV BH VU RO VA YT CM TZ JE GD EC AE FR DJ UM HN JP ME PG SS HT VG HM GG BZ ZW NU IM PW LB VI HR WF MY LS TG MX MZ IL SG CO PH MG GP IS CG CR SJ UY NF BA BM GF CW TR SH WS TF OM ES SK AW YE NO BI PN GQ SL GL PM TO FM KG AM BS AT MQ GM KI SN SO KP FO CY DK GE IO KH RS VC NZ BY LK PS LA TM PY KZ BE IT MD NG BB GS NR CZ ER BL TH SY BV AU FI FK SR CK DM DO SC PF FJ CI SD US NE AF AD LT BD LY CD IR KN LI TT MS TC MH ID CV AI QA GY GR BW ET LV SE TK SI CL SB |
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 | |
|
| 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 | HU AO MA CU BQ MO CX EG TV BN TJ PK AR BF MK PR MM AL DE ZA GT BJ GW LC TN RE MT IE LU KY RU UG AZ CA ZM GN GH IN PT UA TL CH CC NA JM GB KE MN NP PA CN HK GA MC AQ BT LR SM UZ AG MW EH ML AX BO KM NC PE EE MF KW BR TD BG NL MR DZ TW VN SA ST JO VE IQ MV MU SX SZ CF GI MP GU AS KR PL RW SV BH VU RO VA YT CM TZ JE GD EC AE FR DJ UM HN JP ME PG SS HT VG HM GG BZ ZW NU IM PW LB VI HR WF MY LS TG MX MZ IL SG CO PH MG GP IS CG CR SJ UY NF BA BM GF CW TR SH WS TF OM ES SK AW YE NO BI PN GQ SL GL PM TO FM KG AM BS AT MQ GM KI SN SO KP FO CY DK CL GE IO KH RS VC NZ BY LK PS LA TM PY KZ BE IT MD NG BB GS NR CZ ER BL TH SY BV AU FI FK SR CK DM DO SC PF FJ CI SD US NE AF AD LT BD LY CD IR KN LI TT MS TC MH ID CV AI QA GY GR BW ET LV SE TK SI NI SB |
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_transborder_distribution |
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 | BND JPY MKD LRD SEK AFN TOP CZK GYD MDL ISK TND SGD ARS VUV ILS KGS TWD SRD LSL IDR BYN DKK FJD NZD BTN SCR DOP PAB KZT TJS CUC BMD PHP SOS BSD GHS RSD TRY BHD XDR SLL MNT USD EGP OMR BAM RON HRK MMK SVC BIF JOD CNY LAK MUR LYD NIO YER ZMW KMF FKP MZN SPL GMD CUP GGP AOA HUF JMD ETB UZS HKD SHP CAD VEF XPF RWF KPW ALL RUB BOB SZL MAD MVR NOK AZN CVE GEL MYR ANG NGN MWK UGX LKR BDT KRW MXN HNL MRU AED PGK SBD AUD PLN PKR CRC AWG SYP ERN IMP GBP NAD TTD LBP XCD NPR CLP KHR CDF THB SAR UAH KES GNF IRR GIP CHF TZS IQD KWD BGN PEN UYU JEP MGA BWP GTQ VND EUR PYG TVD ZWD TMT DJF XAF STN WST BRL HTG BBD KYD SDG XOF ZAR QAR BZD DZD INR AMD MOP COP |
|
| debug boolean calls with debug=true will be logged | |
|
| description string | |
|
| dim_units string Dimension units of the packages, inches or centimeters required | CM IN |
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 | HU AO MA CU BQ MO CX EG TV BN TJ PK AR BF MK PR MM AL DE ZA GT BJ GW LC TN RE MT IE LU KY RU UG AZ CA ZM GN GH IN PT UA TL CH CC NA JM GB KE MN NP PA CN HK GA MC AQ BT LR SM UZ AG MW EH ML AX BO KM NC PE EE MF KW BR TD BG NL MR DZ TW VN SA ST JO VE IQ MV MU SX SZ CF GI MP GU AS KR PL RW SV BH VU RO VA YT CM TZ JE GD EC AE FR DJ UM HN JP ME PG SS HT VG HM GG BZ ZW NU IM PW LB VI HR WF MY LS TG MX MZ IL SG CO PH MG GP IS CG CR SJ UY NF BA BM GF CW TR SH WS TF OM ES SK AW YE NO BI PN GQ SL GL PM TO FM KG AM BS AT MQ GM KI SN SO KP FO CY DK CL GE IO KH RS VC NZ BY LK PS LA TM PY KZ BE IT MD NG BB GS NR CZ ER BL TH SY BV AU FI FK SR CK DM DO SC PF FJ CI SD US NE AF AD LT BD LY CD IR KN LI TT MS TC MH ID CV AI QA GY GR BW ET LV SE TK SI NI SB |
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 | |
|
| 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 | HU AO MA BQ CU MO CX EG TV BN PK TJ AR BF MK PR MM AL DE ZA GT BJ GW LC TN RE MT IE LU KY RU UG AZ CA ZM GN GH IN PT UA TL CH CC NA JM GB KE MN NP PA CN HK GA MC AQ BT LR SM UZ AG MW EH ML AX BO KM NC PE EE MF KW BR TD BG MR NL DZ TW VN SA ST JO VE IQ MV MU SX SZ NI CF GI MP GU AS KR PL RW SV BH VU RO VA YT CM TZ JE GD EC AE FR DJ UM HN JP ME PG SS HT VG HM GG BZ ZW NU IM PW LB VI HR WF MY LS TG MX MZ IL SG CO PH MG GP IS CG CR SJ UY NF BA BM GF CW TR SH WS TF OM ES SK AW YE NO BI PN GQ SL GL PM TO FM KG AM BS AT MQ GM KI SN SO KP FO CY DK GE IO KH RS VC NZ BY LK PS LA TM PY KZ BE IT MD NG BB GS NR CZ ER BL TH SY BV AU FI FK SR CK DM DO SC PF FJ CI SD US NE AF AD LT BD LY CD IR KN LI TT MS TC MH ID CV AI QA GY GR BW ET LV SE TK SI CL SB |
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_transborder_distribution |
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 | ship_date_past carrier_authentication shipping_account_wrong_carrier missing_api_key carrier_failed_connection schema_validation_error carrier_http_exception wrong_api_key schema_field_required invalid_phone_number carrier_throttling unexpected_exception shipping_account_not_found carrier_timeout carrier_unsupported_method carrier_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. |
Example Request / Response
{
"pickup": {
"carrier": "fedex",
"debug": true,
"dim_units": "IN",
"location": {
"city": "San Francisco",
"company": "Test Company",
"country": "US",
"email": "test@example.com",
"location_type": "business",
"name": "Test Name",
"phone": "+1 201-333-4444",
"postal_code": "94105",
"state": "NJ",
"street1": "1 Market Street"
},
"shipments": [
{
"packages": [
{
"quantity": 1,
"weight": 3
}
],
"recipient": {
"country": "US"
},
"service": "express_worldwide_p"
}
],
"shipping_account": 197299590,
"test": true,
"time": {
"ready_time": "09:45",
"close_time": "16:45",
"date": "2021-05-20"
},
"weight_units": "LB"
}
}
curl --request POST \
--url https://api.zenkraft.com/pickup \
--header 'content-type: application/json' \
--header 'zkkey: XXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
"pickup": {
"carrier": "fedex",
"debug": true,
"dim_units": "IN",
"location": {
"city": "San Francisco",
"company": "Test Company",
"country": "US",
"email": "test@example.com",
"location_type": "business",
"name": "Test Name",
"phone": "+1 201-333-4444",
"postal_code": "94105",
"state": "NJ",
"street1": "1 Market Street"
},
"shipments": [
{
"packages": [
{
"quantity": 1,
"weight": 3
}
],
"recipient": {
"country": "US"
},
"service": "express_worldwide_p"
}
],
"shipping_account": 197299590,
"test": true,
"time": {
"ready_time": "09:45",
"close_time": "16:45",
"date": "2021-05-20"
},
"weight_units": "LB"
}
}'
import requests
headers = {
"zkkey": "XXXXXXXXXXXXXXXXXXXXXXX"
}
payload = {
"pickup": {
"carrier": "fedex",
"debug": true,
"dim_units": "IN",
"location": {
"city": "San Francisco",
"company": "Test Company",
"country": "US",
"email": "test@example.com",
"location_type": "business",
"name": "Test Name",
"phone": "+1 201-333-4444",
"postal_code": "94105",
"state": "NJ",
"street1": "1 Market Street"
},
"shipments": [
{
"packages": [
{
"quantity": 1,
"weight": 3
}
],
"recipient": {
"country": "US"
},
"service": "express_worldwide_p"
}
],
"shipping_account": 197299590,
"test": true,
"time": {
"ready_time": "09:45",
"close_time": "16:45",
"date": "2021-05-20"
},
"weight_units": "LB"
}
}
url = "https://api.zenkraft.com/pickup"
response = requests.request(url=url, method='POST', json=payload, headers=headers)
print(response.json())
{
"pickup": {
"confirmation_number": "123456789",
"id": "cf8a402288034fd9941dc1efe22b0680",
"carrier": "fedex",
"shipping_account": "5190163571408896",
"test": true,
"debug": false,
"description": "string",
"currency": "USD",
"dim_units": "IN",
"weight_units": "LB",
"location": {
"name": "Jack O'Rogers",
"company": "Burlington Textiles Corp of America",
"street1": "525 S. ZENKRAFT Ave",
"street2": "suite 120",
"email": "jrogers@example.com",
"phone": "(336) 222-7000",
"city": "Burlington",
"state": "NC",
"postal_code": "27215",
"country": "US",
"location_type": "front"
},
"shipments": [
{
"recipient": {
"name": "Jack O'Rogers",
"company": "Burlington Textiles Corp of America",
"street1": "525 S. ZENKRAFT Ave",
"street2": "suite 120",
"email": "jrogers@example.com",
"phone": "(336) 222-7000",
"city": "Burlington",
"state": "NC",
"postal_code": "27215",
"country": "US"
},
"packages": [
{
"weight": 4.2,
"value": 25,
"length": 11,
"width": 8.5,
"height": 5
}
],
"service": "fedex_ground"
}
],
"time": {
"close_time": "19:00",
"ready_time": "12:30",
"date": "2021-06-07"
}
}
}
/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.
Example Request / Response
{
"cancel": {
"carrier": "fedex",
"debug": true,
"dim_units": "IN",
"location": {
"city": "San Francisco",
"company": "Test Company",
"country": "US",
"email": "test@example.com",
"location_type": "business",
"name": "Test Name",
"phone": "+1 201-333-4444",
"postal_code": "94105",
"state": "NJ",
"street1": "1 Market Street"
},
"shipments": [
{
"packages": [
{
"quantity": 1,
"weight": 3
}
],
"recipient": {
"country": "US"
},
"service": "express_worldwide_p"
}
],
"shipping_account": 197299590,
"test": true,
"time": {
"ready_time": "09:45",
"close_time": "16:45",
"date": "2021-05-20"
},
"weight_units": "LB"
}
}
curl --request POST \
--url https://api.zenkraft.com/pickup \
--header 'content-type: application/json' \
--header 'zkkey: XXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
"cancel": {
"carrier": "fedex",
"debug": true,
"dim_units": "IN",
"location": {
"city": "San Francisco",
"company": "Test Company",
"country": "US",
"email": "test@example.com",
"location_type": "business",
"name": "Test Name",
"phone": "+1 201-333-4444",
"postal_code": "94105",
"state": "NJ",
"street1": "1 Market Street"
},
"shipments": [
{
"packages": [
{
"quantity": 1,
"weight": 3
}
],
"recipient": {
"country": "US"
},
"service": "express_worldwide_p"
}
],
"shipping_account": 197299590,
"test": true,
"time": {
"ready_time": "09:45",
"close_time": "16:45",
"date": "2021-05-20"
},
"weight_units": "LB"
}
}'
import requests
headers = {
"zkkey": "XXXXXXXXXXXXXXXXXXXXXXX"
}
payload = {
"cancel": {
"carrier": "fedex",
"debug": true,
"dim_units": "IN",
"location": {
"city": "San Francisco",
"company": "Test Company",
"country": "US",
"email": "test@example.com",
"location_type": "business",
"name": "Test Name",
"phone": "+1 201-333-4444",
"postal_code": "94105",
"state": "NJ",
"street1": "1 Market Street"
},
"shipments": [
{
"packages": [
{
"quantity": 1,
"weight": 3
}
],
"recipient": {
"country": "US"
},
"service": "express_worldwide_p"
}
],
"shipping_account": 197299590,
"test": true,
"time": {
"ready_time": "09:45",
"close_time": "16:45",
"date": "2021-05-20"
},
"weight_units": "LB"
}
}
url = "https://api.zenkraft.com/pickup"
response = requests.request(url=url, method='POST', json=payload, headers=headers)
print(response.json())
/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 | HU AO MA CU BQ MO CX EG TV BN TJ PK AR BF MK PR MM AL DE ZA GT BJ GW LC TN RE MT IE LU KY RU UG AZ CA ZM GN GH IN PT UA TL CH CC NA JM GB KE MN NP PA CN HK GA MC AQ BT LR SM UZ AG MW EH ML AX BO KM NC PE EE MF KW BR TD BG NL MR DZ TW VN SA ST JO VE IQ MV MU SX SZ CF GI MP GU AS KR PL RW SV BH VU RO VA YT CM TZ JE GD EC AE FR DJ UM HN JP ME PG SS HT VG HM GG BZ ZW NU IM PW LB VI HR WF MY LS TG MX MZ IL SG CO PH MG GP IS CG CR SJ UY NF BA BM GF CW TR SH WS TF OM ES SK AW YE NO BI PN GQ SL GL PM TO FM KG AM BS AT MQ GM KI SN SO KP FO CY DK CL GE IO KH RS VC NZ BY LK PS LA TM PY KZ BE IT MD NG BB GS NR CZ ER BL TH SY BV AU FI FK SR CK DM DO SC PF FJ CI SD US NE AF AD LT BD LY CD IR KN LI TT MS TC MH ID CV AI QA GY GR BW ET LV SE TK SI NI SB |
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_authentication shipping_account_wrong_carrier missing_api_key carrier_failed_connection schema_validation_error carrier_http_exception wrong_api_key schema_field_required carrier_throttling unexpected_exception shipping_account_not_found carrier_timeout carrier_unsupported_method carrier_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 string Error message required | FedEx API: Postal code specified is not in the correct format |
Example Request / Response
{
"dopu": {
"carrier": "fedex",
"location": {
"city": "San Diego",
"country": "US",
"postal_code": "92131",
"state": "CA",
"street1": "1 Market Street"
},
"shipping_account": "673603996",
"test": true
}
}
curl --request POST \
--url https://api.zenkraft.com/dopu \
--header 'content-type: application/json' \
--header 'zkkey: XXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
"dopu": {
"carrier": "fedex",
"location": {
"city": "San Diego",
"country": "US",
"postal_code": "92131",
"state": "CA",
"street1": "1 Market Street"
},
"shipping_account": "673603996",
"test": true
}
}'
import requests
headers = {
"zkkey": "XXXXXXXXXXXXXXXXXXXXXXX"
}
payload = {
"dopu": {
"carrier": "fedex",
"location": {
"city": "San Diego",
"country": "US",
"postal_code": "92131",
"state": "CA",
"street1": "1 Market Street"
},
"shipping_account": "673603996",
"test": true
}
}
url = "https://api.zenkraft.com/dopu"
response = requests.request(url=url, method='POST', json=payload, headers=headers)
print(response.json())
{
"locations": [
{
"location_type": "post_office",
"distance": 1.3,
"distance_units": "km",
"location_name": "United States Postal Service",
"location_code": "A4415567",
"city": "Burlington",
"street1": "405 Maple Ave",
"state": "NC",
"postal_code": "27215",
"country": "US",
"lng": "36.089788917096016",
"lat": "-79.43575121732864"
}
]
}
/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 | BND JPY MKD LRD SEK AFN TOP CZK GYD MDL ISK TND SGD ARS VUV ILS KGS TWD SRD LSL IDR BYN DKK FJD NZD BTN SCR DOP PAB KZT TJS CUC BMD PHP SOS BSD GHS RSD TRY BHD XDR SLL MNT USD EGP OMR BAM RON HRK MMK SVC BIF JOD CNY LAK MUR LYD NIO YER ZMW KMF FKP MZN SPL GMD CUP GGP AOA HUF JMD ETB UZS HKD SHP CAD VEF XPF RWF KPW ALL RUB BOB SZL MAD MVR NOK AZN CVE GEL MYR ANG NGN MWK UGX LKR BDT KRW MXN HNL MRU AED PGK SBD AUD PLN PKR CRC AWG SYP ERN IMP GBP NAD TTD LBP XCD NPR CLP KHR CDF THB SAR UAH KES GNF IRR GIP CHF TZS IQD KWD BGN PEN UYU JEP MGA BWP GTQ VND EUR PYG TVD ZWD TMT DJF XAF STN WST BRL HTG BBD KYD SDG XOF ZAR QAR BZD DZD INR AMD MOP COP |
|
| debug boolean calls with debug=true will be logged | |
|
| description string | |
|
| dim_units string Dimension units of the packages, inches or centimeters required | CM IN |
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 | HU AO MA CU BQ MO CX EG TV BN TJ PK AR BF MK PR MM AL DE ZA GT BJ GW LC TN RE MT IE LU KY RU UG AZ CA ZM GN GH IN PT UA TL CH CC NA JM GB KE MN NP PA CN HK GA MC AQ BT LR SM UZ AG MW EH ML AX BO KM NC PE EE MF KW BR TD BG NL MR DZ TW VN SA ST JO VE IQ MV MU SX SZ CF GI MP GU AS KR PL RW SV BH VU RO VA YT CM TZ JE GD EC AE FR DJ UM HN JP ME PG SS HT VG HM GG BZ ZW NU IM PW LB VI HR WF MY LS TG MX MZ IL SG CO PH MG GP IS CG CR SJ UY NF BA BM GF CW TR SH WS TF OM ES SK AW YE NO BI PN GQ SL GL PM TO FM KG AM BS AT MQ GM KI SN SO KP FO CY DK CL GE IO KH RS VC NZ BY LK PS LA TM PY KZ BE IT MD NG BB GS NR CZ ER BL TH SY BV AU FI FK SR CK DM DO SC PF FJ CI SD US NE AF AD LT BD LY CD IR KN LI TT MS TC MH ID CV AI QA GY GR BW ET LV SE TK SI NI SB |
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 | |
|
| 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 | HU AO MA BQ CU MO CX EG TV BN PK TJ AR BF MK PR MM AL DE ZA GT BJ GW LC TN RE MT IE LU KY RU UG AZ CA ZM GN GH IN PT UA TL CH CC NA JM GB KE MN NP PA CN HK GA MC AQ BT LR SM UZ AG MW EH ML AX BO KM NC PE EE MF KW BR TD BG MR NL DZ TW VN SA ST JO VE IQ MV MU SX SZ NI CF GI MP GU AS KR PL RW SV BH VU RO VA YT CM TZ JE GD EC AE FR DJ UM HN JP ME PG SS HT VG HM GG BZ ZW NU IM PW LB VI HR WF MY LS TG MX MZ IL SG CO PH MG GP IS CG CR SJ UY NF BA BM GF CW TR SH WS TF OM ES SK AW YE NO BI PN GQ SL GL PM TO FM KG AM BS AT MQ GM KI SN SO KP FO CY DK GE IO KH RS VC NZ BY LK PS LA TM PY KZ BE IT MD NG BB GS NR CZ ER BL TH SY BV AU FI FK SR CK DM DO SC PF FJ CI SD US NE AF AD LT BD LY CD IR KN LI TT MS TC MH ID CV AI QA GY GR BW ET LV SE TK SI CL SB |
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_transborder_distribution |
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 | CM IN |
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_exception carrier_authentication missing_api_key shipping_account_wrong_carrier carrier_failed_connection schema_validation_error carrier_http_exception wrong_api_key schema_field_required invalid_phone_number carrier_throttling unexpected_exception shipping_account_not_found carrier_unsupported_method carrier_timeout ship_date_past |
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. |
Example Request / Response
{
"pickup_availability": {
"carrier": "fedex",
"debug": true,
"dim_units": "IN",
"location": {
"city": "San Francisco",
"company": "Test Company",
"country": "US",
"email": "test@example.com",
"location_type": "business",
"name": "Test Name",
"phone": "+1 201-333-4444",
"postal_code": "94105",
"state": "NJ",
"street1": "1 Market Street"
},
"shipments": [
{
"packages": [
{
"quantity": 1,
"weight": 3
}
],
"service": "fedex_1_day_freight"
}
],
"shipping_account": 197299590,
"test": true,
"weight_units": "LB",
"start_date": "2025-01-21",
"end_date": "2025-01-21"
}
}
curl --request POST \
--url https://api.zenkraft.com/pickup/availability \
--header 'content-type: application/json' \
--header 'zkkey: XXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
"pickup_availability": {
"carrier": "fedex",
"debug": true,
"dim_units": "IN",
"location": {
"city": "San Francisco",
"company": "Test Company",
"country": "US",
"email": "test@example.com",
"location_type": "business",
"name": "Test Name",
"phone": "+1 201-333-4444",
"postal_code": "94105",
"state": "NJ",
"street1": "1 Market Street"
},
"shipments": [
{
"packages": [
{
"quantity": 1,
"weight": 3
}
],
"service": "fedex_1_day_freight"
}
],
"shipping_account": 197299590,
"test": true,
"weight_units": "LB",
"start_date": "2025-01-21",
"end_date": "2025-01-21"
}
}'
import requests
headers = {
"zkkey": "XXXXXXXXXXXXXXXXXXXXXXX"
}
payload = {
"pickup_availability": {
"carrier": "fedex",
"debug": true,
"dim_units": "IN",
"location": {
"city": "San Francisco",
"company": "Test Company",
"country": "US",
"email": "test@example.com",
"location_type": "business",
"name": "Test Name",
"phone": "+1 201-333-4444",
"postal_code": "94105",
"state": "NJ",
"street1": "1 Market Street"
},
"shipments": [
{
"packages": [
{
"quantity": 1,
"weight": 3
}
],
"service": "fedex_1_day_freight"
}
],
"shipping_account": 197299590,
"test": true,
"weight_units": "LB",
"start_date": "2025-01-21",
"end_date": "2025-01-21"
}
}
url = "https://api.zenkraft.com/pickup/availability"
response = requests.request(url=url, method='POST', json=payload, headers=headers)
print(response.json())
{
"pickup_availability": {
"carrier": "fedex",
"debug": true,
"dim_units": "IN",
"location": {
"city": "San Francisco",
"company": "Test Company",
"country": "US",
"email": "test@example.com",
"location_type": "business",
"name": "Test Name",
"phone": "+1 201-333-4444",
"postal_code": "94105",
"state": "NJ",
"street1": "1 Market Street"
},
"shipments": [
{
"packages": [
{
"quantity": 1,
"weight": 3
}
],
"service": "fedex_1_day_freight"
}
],
"shipping_account": 197299590,
"test": true,
"weight_units": "LB",
"start_date": "2025-01-21",
"end_date": "2025-01-21",
"dates": [
{
"date" : "2021-06-30",
"earliest": "09:00",
"latest": "18:00"
},
{
"date" : "2021-07-01",
"earliest": "09:00",
"latest": "18:00"
},
{
"date" : "2021-07-02",
"earliest": "09:00",
"latest": "15:00"
}
]
}
}
/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.checked_in shipment.picked_up return.exception shipment.created shipment.in_transit return.shipment_voided return.creation_pending return.in_transit return.delivered shipment.delivered shipment.out_for_delivery return.created shipment.shipment_voided return.out_for_delivery return.checked_in return.picked_up return.driver_assigned shipment.exception shipment.creation_pending shipment.driver_assigned |
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 | checkpoint stage |
|
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.checked_in shipment.picked_up return.exception shipment.created shipment.in_transit return.shipment_voided return.creation_pending return.in_transit return.delivered shipment.delivered shipment.out_for_delivery return.created shipment.shipment_voided return.out_for_delivery return.checked_in return.picked_up return.driver_assigned shipment.exception shipment.creation_pending shipment.driver_assigned |
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 | checkpoint stage |
|
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 |
Example Request / Response
{
"webhook": {
"name": "Test Webhook",
"description": "Send delivery notifications",
"events": ["shipment.out_for_delivery", "shipment.delivered"],
"callback": "https://webhook.site/f263f99d-e822-4185-9ff8-f56789bc78c6",
"debug": false,
"api_version": "v1",
"format": "json",
"headers": [
{
"name": "Authorization",
"value": "api_key"
}
],
"shipping_account_id": 123,
"trigger_mode": "checkpoint"
}
}
curl --request POST \
--url https://api.zenkraft.com/webhook \
--header 'content-type: application/json' \
--header 'zkkey: XXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
"webhook": {
"name": "Test Webhook",
"description": "Send delivery notifications",
"events": ["shipment.out_for_delivery", "shipment.delivered"],
"callback": "https://webhook.site/f263f99d-e822-4185-9ff8-f56789bc78c6",
"debug": false,
"api_version": "v1",
"format": "json",
"headers": [
{
"name": "Authorization",
"value": "api_key"
}
],
"shipping_account_id": 123,
"trigger_mode": "checkpoint"
}
}'
import requests
headers = {
"zkkey": "XXXXXXXXXXXXXXXXXXXXXXX"
}
payload = {
"webhook": {
"name": "Test Webhook",
"description": "Send delivery notifications",
"events": ["shipment.out_for_delivery", "shipment.delivered"],
"callback": "https://webhook.site/f263f99d-e822-4185-9ff8-f56789bc78c6",
"debug": false,
"api_version": "v1",
"format": "json",
"headers": [
{
"name": "Authorization",
"value": "api_key"
}
],
"shipping_account_id": 123,
"trigger_mode": "checkpoint"
}
}
url = "https://api.zenkraft.com/webhook"
response = requests.request(url=url, method='POST', json=payload, headers=headers)
print(response.json())
{
"webhook": {
"name": "Test Webhook",
"description": "Send delivery notifications",
"events": ["shipment.out_for_delivery", "shipment.delivered"],
"callback": "https://webhook.site/f263f99d-e822-4185-9ff8-f56789bc78c6",
"debug": false,
"api_version": "v1",
"format": "json",
"id": "484fe753dcda47a1b817456f3a10e38e",
"headers": [
{
"name": "Authorization",
"value": "api_key"
}
],
"shipping_account_id": 123,
"trigger_mode": "checkpoint"
}
}
/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.checked_in shipment.picked_up return.exception shipment.created shipment.in_transit return.shipment_voided return.creation_pending return.in_transit return.delivered shipment.delivered shipment.out_for_delivery return.created shipment.shipment_voided return.out_for_delivery return.checked_in return.picked_up return.driver_assigned shipment.exception shipment.creation_pending shipment.driver_assigned |
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 | checkpoint stage |
|
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 |
Example Request / Response
https://api.zenkraft.com/webhook
curl --request GET \
--url https://api.zenkraft.com/webhook \
--header 'content-type: application/json' \
--header 'zkkey: XXXXXXXXXXXXXXXXXXXXXXX'
import requests
headers = {
"zkkey": "XXXXXXXXXXXXXXXXXXXXXXX"
}
payload = None
url = "https://api.zenkraft.com/webhook"
response = requests.request(url=url, method='GET', json=payload, headers=headers)
print(response.json())
{
"webhooks": [
{
"name": "Test Webhook",
"description": "Send delivery notifications",
"debug": false,
"api_version": "v1",
"format": "json",
"events": [
"shipment.delivered"
],
"callback": "https://webhook.site/3a788dd3-bd7c-44a8-bae0-297e3b68b508",
"headers": [
{
"name": "Authorization",
"value": "api_key"
}
],
"shipping_account_id": 123,
"trigger_mode": "checkpoint",
"id": "484fe753dcda47a1b817456f3a10e38e"
}
]
}
/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.checked_in shipment.picked_up return.exception shipment.created shipment.in_transit return.shipment_voided return.creation_pending return.in_transit return.delivered shipment.delivered shipment.out_for_delivery return.created shipment.shipment_voided return.out_for_delivery return.checked_in return.picked_up return.driver_assigned shipment.exception shipment.creation_pending shipment.driver_assigned |
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 | checkpoint stage |
|
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.checked_in shipment.picked_up return.exception shipment.created shipment.in_transit return.shipment_voided return.creation_pending return.in_transit return.delivered shipment.delivered shipment.out_for_delivery return.created shipment.shipment_voided return.out_for_delivery return.checked_in return.picked_up return.driver_assigned shipment.exception shipment.creation_pending shipment.driver_assigned |
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 | checkpoint stage |
|
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_wrong_carrier missing_api_key webhook_not_found schema_validation_error wrong_api_key schema_field_required unexpected_exception 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 string Error message required | No webhook exists with that ID |
Example Request / Response
{
"webhook": {
"name": "Test Webhook",
"description": "Send delivery notifications",
"events": ["shipment.out_for_delivery", "shipment.delivered"],
"callback": "https://webhook.site/f263f99d-e822-4185-9ff8-f56789bc78c6",
"debug": false,
"api_version": "v1",
"format": "json",
"headers": [
{
"name": "Authorization",
"value": "api_key"
}
],
"shipping_account_id": 123,
"trigger_mode": "checkpoint"
}
}
curl --request PUT \
--url https://api.zenkraft.com/webhook \
--header 'content-type: application/json' \
--header 'zkkey: XXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
"webhook": {
"name": "Test Webhook",
"description": "Send delivery notifications",
"events": ["shipment.out_for_delivery", "shipment.delivered"],
"callback": "https://webhook.site/f263f99d-e822-4185-9ff8-f56789bc78c6",
"debug": false,
"api_version": "v1",
"format": "json",
"headers": [
{
"name": "Authorization",
"value": "api_key"
}
],
"shipping_account_id": 123,
"trigger_mode": "checkpoint"
}
}'
import requests
headers = {
"zkkey": "XXXXXXXXXXXXXXXXXXXXXXX"
}
payload = None
url = "{
"webhook": {
"name": "Test Webhook",
"description": "Send delivery notifications",
"events": ["shipment.out_for_delivery", "shipment.delivered"],
"callback": "https://webhook.site/f263f99d-e822-4185-9ff8-f56789bc78c6",
"debug": false,
"api_version": "v1",
"format": "json",
"headers": [
{
"name": "Authorization",
"value": "api_key"
}
],
"shipping_account_id": 123,
"trigger_mode": "checkpoint"
}
}"
response = requests.request(url=url, method='PUT', json=payload, headers=headers)
print(response.json())
{
"webhook": {
"name": "Test Webhook",
"description": "Send delivery notifications",
"events": ["shipment.out_for_delivery", "shipment.delivered"],
"callback": "https://webhook.site/f263f99d-e822-4185-9ff8-f56789bc78c6",
"debug": false,
"api_version": "v1",
"format": "json",
"id": "484fe753dcda47a1b817456f3a10e38e",
"headers": [
{
"name": "Authorization",
"value": "api_key"
}
],
"shipping_account_id": 123,
"trigger_mode": "checkpoint"
}
}
/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_wrong_carrier missing_api_key webhook_not_found schema_validation_error wrong_api_key schema_field_required unexpected_exception 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 string Error message required | No webhook exists with that ID |
Example Request / Response
https://api.zenkraft.com/webhook/7acd186c4bad4197ad36b918eff71c03
curl --request GET \
--url https://api.zenkraft.com/webhook/7acd186c4bad4197ad36b918eff71c03 \
--header 'content-type: application/json' \
--header 'zkkey: XXXXXXXXXXXXXXXXXXXXXXX'
import requests
headers = {
"zkkey": "XXXXXXXXXXXXXXXXXXXXXXX"
}
payload = None
url = "https://api.zenkraft.com/webhook/7acd186c4bad4197ad36b918eff71c03"
response = requests.request(url=url, method='GET', json=payload, headers=headers)
print(response.json())
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_base
| Field | Type | Required | Min Length | Max Length |
| name | string | - | 35 | |
| company | string | - | 35 | |
| street1 | string | - | 50 | |
| street2 | string | - | 50 | |
| street3 | string | - | 50 | |
| string | - | 100 | ||
| phone | string | - | 35 | |
| city | string | - | 50 | |
| state | string | - | 35 | |
| postal_code | string | - | 15 | |
| country | string | - | - |
location
| Field | Type | Required | Min Length | Max Length |
| name | string | True | - | 35 |
| company | string | - | 35 | |
| street1 | string | True | - | 50 |
| street2 | string | - | 50 | |
| street3 | string | - | 50 | |
| string | - | 100 | ||
| phone | string | - | 35 | |
| city | string | True | - | 50 |
| state | string | - | 35 | |
| postal_code | string | - | 15 | |
| country | string | True | - | - |
location_rate
| Field | Type | Required | Min Length | Max Length |
| name | string | - | 35 | |
| company | string | - | 35 | |
| street1 | string | - | 50 | |
| street2 | string | - | 50 | |
| street3 | string | - | 50 | |
| string | - | 100 | ||
| phone | string | - | 35 | |
| city | string | - | 50 | |
| state | string | - | 35 | |
| postal_code | string | - | 15 | |
| 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 |
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 | - | - | |
| 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 | - | - | |
| packages | array | True | - | - |
| label_type | string | True | - | - |
| label_size | string | - | - | |
| include_base64_label | boolean | - | - | |
| references | array | - | - | |
| notifications | array | - | - | |
| sender | object | True | - | - |
| recipient | object | True | - | - |
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 | - | - | |
| packages | array | True | - | - |
| sender | object | True | - | - |
| recipient | object | 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 | - | 50 |
| street2 | string | - | 50 | |
| street3 | string | - | 50 | |
| string | True | - | 100 | |
| phone | string | True | - | 35 |
| city | string | True | - | 50 |
| state | string | True | - | 35 |
| postal_code | string | True | - | 15 |
| 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 | - | 50 |
| street2 | string | - | 50 | |
| street3 | string | - | 50 | |
| string | True | - | 100 | |
| phone | string | True | - | 35 |
| city | string | True | - | 50 |
| state | string | True | - | 35 |
| postal_code | string | True | - | 15 |
| 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 | - | - |
| client_id | string | - | - | |
| client_secret | string | - | - |
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 | - | - |