UPS Overview

Please find the documentation for the UPS 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_key
Base 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 {'userid': 'User ID', 'password': 'Password', 'account_number': 'Account Number', 'access_license_number': 'Access License Number', 'invoice_number': 'Invoice Number', 'invoice_date': 'Invoice Date', 'invoice_amount': 'Invoice Amount', 'control_id': 'Control ID', 'domain': 'Domain', 'qr_userid': 'QR User ID', 'qr_password': 'QR Password', 'customer_id': 'Customer ID', 'customer_guid': 'Customer GUID'}
access_license_number string Access License Number Access License Number
account_number string Account Number required Account Number
control_id string Control ID Control ID
customer_guid string Customer GUID Customer GUID
customer_id string Customer ID Customer ID
domain string Domain Domain
invoice_amount string Invoice Amount Invoice Amount
invoice_date string Invoice Date Invoice Date
invoice_number string Invoice Number Invoice Number
password string Password Password
qr_password string QR Password QR Password
qr_userid string QR User ID QR User ID
userid string User ID User ID
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 KM BG BE MO BB PE LU MM RU SY ZW BZ KP AE KZ HU BS CN JE NL AL LC GQ DO ES IT AW NZ KG EE GL PN PA AF BI LV MF KR AS SG LY GY EC ST PH GS LI GP KW PW GR BY NR CL BF WF AX BN NU PM CM DM MZ MT FM QA AD CU TV VE GD KE TC SD MC TJ TR CI TK MA ZM JP SR BH LB MV DE EH RE UA CC MW FI WS BO EG GG TZ NA AZ CV LK KI TD MP AQ TG IS LR VA CD GB ML BJ PT JO SE SX VU ER HN MS RS JM RW SH AO VC BD PL VI CA BT CG AI HT KH LA FJ SK IM IL MD KY BQ LS AG AM PG HR BM TF GT GW PF MG IO TN RO TL TO VN UZ FK SC CK CZ NP VG MQ YE GU GF TT SA SS CF DJ MN MY UG FR MU ET PS BR HM SJ MR SV KN IE MK UM GM SL HK LT MH FO BA IN YT BL BW SO US GI NF GN ZA GH BV AR TW UY SI CR TH CO CY TM CW GE OM NI DK IQ PK SB MX PR ID NC SZ NE PY SN AU AT GA SM ME NG CH CX DZ IR NO 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 ups
country string required KM BG BE MO BB PE LU MM RU SY ZW BZ KP AE KZ HU BS CN JE NL AL LC GQ NO DO ES IT AW NZ KG EE GL PN PA AF BI LV MF KR AS SG LY GY EC ST PH GS LI GP KW PW GR BY NR CL BF WF AX BN NU PM CM DM MT MZ FM QA AD CU TV VE GD KE TC SD MC TJ TR CI TK MA ZM JP SR BH LB MV DE EH RE UA CC MW FI WS BO EG GG TZ NA AZ CV LK KI TD MP AQ TG IS LR VA CD GB ML BJ PT JO SE SX VU ER HN MS RS JM RW SH AO VC BD PL VI CA BT CG AI HT KH LA FJ SK IM IL MD KY BQ LS AG AM PG HR BM TF GT GW PF MG IO TN RO TL TO VN UZ FK SC CK CZ NP VG MQ YE GU GF TT SA SS CF DJ MN MY UG FR MU ET PS BR HM SJ MR SV KN IE MK UM GM SL HK LT MH FO BA IN YT BL BW SO US GI NF GN ZA BV AR TW UY SI CR TH CO CY TM CW GE OM NI DK IQ PK SB MX PR ID NC SZ NE PY SN AU AT GA SM ME NG CH CX DZ IR GH US
defaults object
currency string BIF UAH USD HTG AUD MGA PHP JMD JOD KYD DZD KPW MYR DJF INR NPR CUP ILS LRD BSD TTD ZWD ANG CHF FJD MZN KGS GHS KES RSD FKP IDR VUV XAF SPL BND PYG MMK UYU LBP TND MDL ZMW SVC LSL WST KZT SHP THB TVD XOF SOS UGX HRK LAK BBD CNY BYN KMF CDF COP NIO GIP KRW GMD MRU PKR TZS BRL LKR MWK NOK NGN SRD MXN CUC XCD DOP BTN CVE SCR MAD LYD MNT QAR OMR RUB ETB HUF MUR AED EGP AZN DKK GEL NZD PAB CLP SLL TOP AMD XPF YER PGK BOB SYP BMD TRY JEP IQD AOA CAD TWD GTQ KWD ALL HKD BHD AFN SBD TMT RWF NAD SZL SAR JPY TJS BDT ISK SGD IMP BGN AWG VEF PLN PEN HNL IRR STN MKD SEK CRC XDR GYD GNF VND BAM MVR SDG UZS ARS GGP BWP GBP KHR BZD ERN MOP ZAR RON EUR CZK
dim_units string Dimension units of the packages, inches or centimeters IN CM IN
label_type string Label Type EPL EPL__4X6 EPL__4X8 ZPL ZPL__4X6 ZPL__4X8 SPL SPL__4X6 SPL__4X8 GIF PDF qrcode PNG PDF
packaging_type string Packaging Type your_packaging ups_letter tube pak ups_express_box ups_25kg_box ups_10kg_box pallet small_express_box medium_express_box large_express_box flats parcels bpm first_class priority machinables irregulars parcel_post bpm_parcel media_mail bpm_flat standard_flat your_packaging
service string Service Type ups_next_day_air ups_second_day_air ups_ground ups_express ups_expedited ups_standard ups_three_day_select ups_next_day_air_saver ups_next_day_air_early ups_express_plus ups_second_day_air_am ups_saver ups_access_point_economy ups_first_class_mail ups_priority_mail ups_expedited_mail_innovations ups_priority_mail_innovations ups_economy_mail_innovations ups_today_standard ups_today_dedicated_courier ups_today_intercity ups_today_express ups_today_express_saver ups_worldwide_economy_ddu ups_worldwide_economy_ddp ups_worldwide_express_freight ups_surepost_lt_1lb ups_surepost standard_flats parcel_select_lightweight_irreg parcel_select bpm_parcels bpm_flats media_mail marketing_parcels ups_next_day_air
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 ups 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 {'userid': 'User ID', 'password': 'Password', 'account_number': 'Account Number', 'access_license_number': 'Access License Number', 'invoice_number': 'Invoice Number', 'invoice_date': 'Invoice Date', 'invoice_amount': 'Invoice Amount', 'control_id': 'Control ID', 'domain': 'Domain', 'qr_userid': 'QR User ID', 'qr_password': 'QR Password', 'customer_id': 'Customer ID', 'customer_guid': 'Customer GUID'}
access_license_number string Access License Number Access License Number
account_number string Account Number required Account Number
control_id string Control ID Control ID
customer_guid string Customer GUID Customer GUID
customer_id string Customer ID Customer ID
domain string Domain Domain
invoice_amount string Invoice Amount Invoice Amount
invoice_date string Invoice Date Invoice Date
invoice_number string Invoice Number Invoice Number
password string Password Password
qr_password string QR Password QR Password
qr_userid string QR User ID QR User ID
userid string User ID User ID
carrier string Carrier slug required ups
country string required KM BG BE MO BB PE LU MM RU SY ZW BZ KP AE KZ HU BS CN JE NL AL LC GQ NO DO ES IT AW NZ KG EE GL PN PA AF BI LV MF KR AS SG LY GY EC ST PH GS LI GP KW PW GR BY NR CL BF WF AX BN NU PM CM DM MT MZ FM QA AD CU TV VE GD KE TC SD MC TJ TR CI TK MA ZM JP SR BH LB MV DE EH RE UA CC MW FI WS BO EG GG TZ NA AZ CV LK KI TD MP AQ TG IS LR VA CD GB ML BJ PT JO SE SX VU ER HN MS RS JM RW SH AO VC BD PL VI CA BT CG AI HT KH LA FJ SK IM IL MD KY BQ LS AG AM PG HR BM TF GT GW PF MG IO TN RO TL TO VN UZ FK SC CK CZ NP VG MQ YE GU GF TT SA SS CF DJ MN MY UG FR MU ET PS BR HM SJ MR SV KN IE MK UM GM SL HK LT MH FO BA IN YT BL BW SO US GI NF GN ZA BV AR TW UY SI CR TH CO CY TM CW GE OM NI DK IQ PK SB MX PR ID NC SZ NE PY SN AU AT GA SM ME NG CH CX DZ IR GH US
defaults object required
currency string BIF UAH USD HTG AUD MGA PHP JMD JOD KYD DZD KPW MYR DJF INR NPR CUP ILS LRD BSD TTD ZWD ANG CHF FJD MZN KGS GHS KES RSD FKP IDR VUV XAF SPL BND PYG MMK UYU LBP TND MDL ZMW SVC LSL WST KZT SHP THB TVD XOF SOS UGX HRK LAK BBD CNY BYN KMF CDF COP NIO GIP KRW GMD MRU PKR TZS BRL LKR MWK NOK NGN SRD MXN CUC XCD DOP BTN CVE SCR MAD LYD MNT QAR OMR RUB ETB HUF MUR AED EGP AZN DKK GEL NZD PAB CLP SLL TOP AMD XPF YER PGK BOB SYP BMD TRY JEP IQD AOA CAD TWD GTQ KWD ALL HKD BHD AFN SBD TMT RWF NAD SZL SAR JPY TJS BDT ISK SGD IMP BGN AWG VEF PLN PEN HNL IRR STN MKD SEK CRC XDR GYD GNF VND BAM MVR SDG UZS ARS GGP BWP GBP KHR BZD ERN MOP ZAR RON EUR CZK
dim_units string Dimension units of the packages, inches or centimeters IN CM IN
label_type string Label Type EPL EPL__4X6 EPL__4X8 ZPL ZPL__4X6 ZPL__4X8 SPL SPL__4X6 SPL__4X8 GIF PDF qrcode PNG PDF
packaging_type string Packaging Type your_packaging ups_letter tube pak ups_express_box ups_25kg_box ups_10kg_box pallet small_express_box medium_express_box large_express_box flats parcels bpm first_class priority machinables irregulars parcel_post bpm_parcel media_mail bpm_flat standard_flat your_packaging
service string Service Type ups_next_day_air ups_second_day_air ups_ground ups_express ups_expedited ups_standard ups_three_day_select ups_next_day_air_saver ups_next_day_air_early ups_express_plus ups_second_day_air_am ups_saver ups_access_point_economy ups_first_class_mail ups_priority_mail ups_expedited_mail_innovations ups_priority_mail_innovations ups_economy_mail_innovations ups_today_standard ups_today_dedicated_courier ups_today_intercity ups_today_express ups_today_express_saver ups_worldwide_economy_ddu ups_worldwide_economy_ddp ups_worldwide_express_freight ups_surepost_lt_1lb ups_surepost standard_flats parcel_select_lightweight_irreg parcel_select bpm_parcels bpm_flats media_mail marketing_parcels ups_next_day_air
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 ups 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 unexpected_exception schema_validation_error schema_field_required master_test_shipping_account_not_found shipping_account_wrong_carrier missing_api_key shipping_account_not_found wrong_api_key master_test_shipping_account_not_found
detail string This field can contain additional information about the error. This field is not meant to be shown to the end-user required
message object Error message required Master shipping account for fedex in US does not exist
Example Request / Response
  1. {
  2.     "shipping_account": {
  3.         "name": "Test",
  4.         "carrier": "ups",
  5.         "auth": {
  6.             "userid": "User ID",
  7.             "password": "Password",
  8.             "account_number": "Account Number",
  9.             "access_license_number": "Access License Number",
  10.             "invoice_number": "Invoice Number",
  11.             "invoice_date": "Invoice Date",
  12.             "invoice_amount": "Invoice Amount",
  13.             "control_id": "Control ID",
  14.             "domain": "Domain",
  15.             "qr_userid": "QR User ID",
  16.             "qr_password": "QR Password",
  17.             "customer_id": "Customer ID",
  18.             "customer_guid": "Customer GUID"
  19.         },
  20.         "billing_address": {
  21.             "city": "London",
  22.             "state": "",
  23.             "postal_code": "EC1R 4UG",
  24.             "name": "Test User",
  25.             "phone": "01222 555 555",
  26.             "country": "GB",
  27.             "company": "Zenkraft User",
  28.             "email": "testexample@gmail.com",
  29.             "street1": "1 Hardwick Street"
  30.         },
  31.         "country": "US",
  32.         "test" : true
  33.     }
  34. }
                curl --request POST \
--url https://api.zenkraft.com/shippingaccount \
--header 'content-type: application/json' \
--header 'zkkey: XXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
    "shipping_account": {
        "name": "Test",
        "carrier": "ups",
        "auth": {
            "userid": "User ID",
            "password": "Password",
            "account_number": "Account Number",
            "access_license_number": "Access License Number",
            "invoice_number": "Invoice Number",
            "invoice_date": "Invoice Date",
            "invoice_amount": "Invoice Amount",
            "control_id": "Control ID",
            "domain": "Domain",
            "qr_userid": "QR User ID",
            "qr_password": "QR Password",
            "customer_id": "Customer ID",
            "customer_guid": "Customer GUID"
        },
        "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": "ups",
        "auth": {
            "userid": "User ID",
            "password": "Password",
            "account_number": "Account Number",
            "access_license_number": "Access License Number",
            "invoice_number": "Invoice Number",
            "invoice_date": "Invoice Date",
            "invoice_amount": "Invoice Amount",
            "control_id": "Control ID",
            "domain": "Domain",
            "qr_userid": "QR User ID",
            "qr_password": "QR Password",
            "customer_id": "Customer ID",
            "customer_guid": "Customer GUID"
        },
        "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())
            
                
            
  1. {
  2.     "shipping_account": {
  3.         "name": "My FedEx test account",
  4.         "carrier": "ups",
  5.         "country": "US",
  6.         "auth": {
  7.             "userid": "User ID",
  8.             "password": "Password",
  9.             "account_number": "Account Number",
  10.             "access_license_number": "Access License Number",
  11.             "invoice_number": "Invoice Number",
  12.             "invoice_date": "Invoice Date",
  13.             "invoice_amount": "Invoice Amount",
  14.             "control_id": "Control ID",
  15.             "domain": "Domain",
  16.             "qr_userid": "QR User ID",
  17.             "qr_password": "QR Password",
  18.             "customer_id": "Customer ID",
  19.             "customer_guid": "Customer GUID"
  20.         },
  21.         "test": false,
  22.         "id": "567293923024"
  23.     }
  24. }

/ship POST

The shipping endpoint is used to book shipments with UPS. 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 ups
currency string BIF UAH USD HTG AUD MGA PHP JMD JOD KYD DZD KPW MYR DJF INR NPR CUP ILS LRD BSD TTD ZWD ANG CHF FJD MZN KGS GHS KES RSD FKP IDR VUV XAF SPL BND PYG MMK UYU LBP TND MDL ZMW SVC LSL WST KZT SHP THB TVD XOF SOS UGX HRK LAK BBD CNY BYN KMF CDF COP NIO GIP KRW GMD MRU PKR TZS BRL LKR MWK NOK NGN SRD MXN CUC XCD DOP BTN CVE SCR MAD LYD MNT QAR OMR RUB ETB HUF MUR AED EGP AZN DKK GEL NZD PAB CLP SLL TOP AMD XPF YER PGK BOB SYP BMD TRY JEP IQD AOA CAD TWD GTQ KWD ALL HKD BHD AFN SBD TMT RWF NAD SZL SAR JPY TJS BDT ISK SGD IMP BGN AWG VEF PLN PEN HNL IRR STN MKD SEK CRC XDR GYD GNF VND BAM MVR SDG UZS ARS GGP BWP GBP KHR BZD ERN MOP ZAR RON EUR CZK
debug boolean calls with debug=true will be logged
dim_units string Dimension units of the packages, inches or centimeters required IN CM IN
documents array
document string document content
document_type string file format of the document pdf
id string uploaded document ID
include_base64_label boolean If this is enabled, base64 label is returned
label_size string 4X6 4X8 4X6
label_type string the label format of the shipping labels required EPL EPL__4X6 EPL__4X8 ZPL ZPL__4X6 ZPL__4X8 SPL SPL__4X6 SPL__4X8 GIF PDF qrcode PNG PDF
notifications array
type string type of the notification needed return_notification qv_in_transit_notification qv_ship_notification qv_exception_notification qv_delivery_notification alternate_delivery_location_notification uap_shipper_notification label_delivery return_notification
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 KM BG BE MO BB PE LU MM RU SY ZW BZ KP AE KZ HU BS CN JE NL AL LC GQ NO DO ES IT AW NZ KG EE GL PN PA AF BI LV MF KR AS SG LY GY EC ST PH GS LI GP KW PW GR BY NR CL BF WF AX BN NU PM CM DM MT MZ FM QA AD CU TV VE GD KE TC SD MC TJ TR CI TK MA ZM JP SR BH LB MV DE EH RE UA CC MW FI WS BO EG GG TZ NA AZ CV LK KI TD MP AQ TG IS LR VA CD GB ML BJ PT JO SE SX VU ER HN MS RS JM RW SH AO VC BD PL VI CA BT CG AI HT KH LA FJ SK IM IL MD KY BQ LS AG AM PG HR BM TF GT GW PF MG IO TN RO TL TO VN UZ FK SC CK CZ NP VG MQ YE GU GF TT SA SS CF DJ MN MY UG FR MU ET PS BR HM SJ MR SV KN IE MK UM GM SL HK LT MH FO BA IN YT BL BW SO US GI NF GN ZA BV AR TW UY SI CR TH CO CY TM CW GE OM NI DK IQ PK SB MX PR ID NC SZ NE PY SN AU AT GA SM ME NG CH CX DZ IR GH 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 KM BG BE MO BB PE LU MM RU SY ZW BZ KP AE KZ HU BS CN JE NL AL LC GQ NO DO ES IT AW NZ KG EE GL PN PA AF BI LV MF KR AS SG LY GY EC ST PH GS LI GP KW PW GR BY NR CL BF WF AX BN NU PM CM DM MT MZ FM QA AD CU TV VE GD KE TC SD MC TJ TR CI TK MA ZM JP SR BH LB MV DE EH RE UA CC MW FI WS BO EG GG TZ NA AZ CV LK KI TD MP AQ TG IS LR VA CD GB ML BJ PT JO SE SX VU ER HN MS RS JM RW SH AO VC BD PL VI CA BT CG AI HT KH LA FJ SK IM IL MD KY BQ LS AG AM PG HR BM TF GT GW PF MG IO TN RO TL TO VN UZ FK SC CK CZ NP VG MQ YE GU GF TT SA SS CF DJ MN MY UG FR MU ET PS BR HM SJ MR SV KN IE MK UM GM SL HK LT MH FO BA IN YT BL BW SO US GI NF GN ZA BV AR TW UY SI CR TH CO CY TM CW GE OM NI DK IQ PK SB MX PR ID NC SZ NE PY SN AU AT GA SM ME NG CH CX DZ IR GH 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 ups_next_day_air ups_second_day_air ups_ground ups_express ups_expedited ups_standard ups_three_day_select ups_next_day_air_saver ups_next_day_air_early ups_express_plus ups_second_day_air_am ups_saver ups_access_point_economy ups_first_class_mail ups_priority_mail ups_expedited_mail_innovations ups_priority_mail_innovations ups_economy_mail_innovations ups_today_standard ups_today_dedicated_courier ups_today_intercity ups_today_express ups_today_express_saver ups_worldwide_economy_ddu ups_worldwide_economy_ddp ups_worldwide_express_freight ups_surepost_lt_1lb ups_surepost standard_flats parcel_select_lightweight_irreg parcel_select bpm_parcels bpm_flats media_mail marketing_parcels ups_next_day_air
ship_date string shipping date 2021-06-07
shipping_account string Shipping account number required 5190163571408896
special_services array alternate_delivery_address goods_not_in_free_circulation mi_label_cn22 saturday_delivery saturday_pickup cod access_point_cod deliver_to_addressee_only direct_delivery_only cn22_form premium_care_form additional_document return_of_documents delivery_confirmation import_control commercial_invoice_removal ups_carbon_neutral sdl_shipment exchange_forward dropoff_at_ups_facility hold_for_pickup diagnostic_specimens alcoholic_beverages perishables plants seeds special_exceptions tobacco no_transit_times list_rates paperless_trade include_qr mi_rate [alternate_delivery_address ]
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_number which can be used to track the shipments in the track endpoint
  • label for each package which needs to be printed and attached to the shipment
Field Possible Values Example
shipment object
context object this object can contain custom data returned by the carrier
costs object Additional information about packages
base_charge number gross amount 100
discounts number the cost of discounts applied 0
net_charge number net amount 80
surcharges number additional fees 0
taxes number the cost of taxes 20
id string shipment ID 1f02d12868a54ed88b6cb4dafaad325d
label_size string 4X6 4X8 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 alternate_delivery_address goods_not_in_free_circulation mi_label_cn22 saturday_delivery saturday_pickup cod access_point_cod deliver_to_addressee_only direct_delivery_only cn22_form premium_care_form additional_document return_of_documents delivery_confirmation import_control commercial_invoice_removal ups_carbon_neutral sdl_shipment exchange_forward dropoff_at_ups_facility hold_for_pickup diagnostic_specimens alcoholic_beverages perishables plants seeds special_exceptions tobacco no_transit_times list_rates paperless_trade include_qr mi_rate [alternate_delivery_address ]
tracking_number string Tracking number of shipment 567293923024


Error Response
Field Possible Values Example
error object
code string Standardized error code required unexpected_exception schema_validation_error carrier_label_generation_failed schema_field_required carrier_shipment_generation_failed ship_date_past carrier_authentication carrier_failed_connection carrier_throttling carrier_unsupported_method invalid_phone_number carrier_exception shipping_account_wrong_carrier carrier_http_exception missing_api_key shipping_account_not_found wrong_api_key carrier_timeout 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
UPS Next Day Air ups_next_day_air ➞ 01
UPS Second Day Air ups_second_day_air ➞ 02
UPS Ground ups_ground ➞ 03
UPS Express ups_express ➞ 07
UPS Expedited ups_expedited ➞ 08
UPS Standard ups_standard ➞ 11
UPS Three Day Select ups_three_day_select ➞ 12
UPS Next Day Air Saver ups_next_day_air_saver ➞ 13
UPS Next Day Air Early ups_next_day_air_early ➞ 14
UPS Express Plus ups_express_plus ➞ 54
UPS 2nd Day Air A.M. ups_second_day_air_am ➞ 59
UPS Saver ups_saver ➞ 65
UPS Access PointTM Economy ups_access_point_economy ➞ 70
UPS First Class Mail ups_first_class_mail ➞ M2
UPS Priority Mail ups_priority_mail ➞ M3
UPS Expedited MaiI Innovations ups_expedited_mail_innovations ➞ M4
UPS Priority Mail Innovations ups_priority_mail_innovations ➞ M5
UPS Economy Mail Innovations ups_economy_mail_innovations ➞ M6
UPS Today Standard ups_today_standard ➞ 82
UPS Today Dedicated Courier ups_today_dedicated_courier ➞ 83
UPS Today Intercity ups_today_intercity ➞ 84
UPS Today Express ups_today_express ➞ 85
UPS Today Express Saver ups_today_express_saver ➞ 86
UPS Worldwide Economy DDU ups_worldwide_economy_ddu ➞ 17 international
UPS Worldwide Economy DDP ups_worldwide_economy_ddp ➞ 72 international
UPS Worldwide Express Freight ups_worldwide_express_freight ➞ 96
UPS SurePost Less than 1LB ups_surepost_lt_1lb ➞ 92
UPS SurePost ups_surepost ➞ 93
Standard Flats standard_flats ➞ 1
Parcel Select Lightweight Irreg parcel_select_lightweight_irreg ➞ 4
Parcel Select parcel_select ➞ 5
BPM Parcels bpm_parcels ➞ 6
BPM Flats bpm_flats ➞ 18
Media Mail media_mail ➞ 19
Marketing Parcels marketing_parcels ➞ 20
Show more

Packaging Types
Name API value Domestic / international
Your Packaging your_packaging ➞
UPS Letter ups_letter ➞
Tube tube ➞
PAK pak ➞
UPS Express Box ups_express_box ➞
UPS 25KG Box ups_25kg_box ➞
UPS 10KG Box ups_10kg_box ➞
Pallet pallet ➞
Small Express Box small_express_box ➞
Medium Express Box medium_express_box ➞
Large Express Box large_express_box ➞
Flats flats ➞
Parcels parcels ➞
BPM bpm ➞
First Class first_class ➞
Priority priority ➞
Machinables machinables ➞
Irregulars irregulars ➞
Parcel Post parcel_post ➞
BPM Parcel bpm_parcel ➞
Media Mail media_mail ➞
BPM Flat bpm_flat ➞
Standard Flat standard_flat ➞

Billing Fields
Name API value Domestic / international
Shipping Payment Type shipping_payment_type
Billing Account Number billing_account_number
Billing Account Postal Code bill_to_postcode
Billing Account Country Code bill_to_country_code

Special Services
Name API value Code
Alternate Delivery Address alternate_delivery_address alternate_delivery_address
Goods Not In Free Circulation goods_not_in_free_circulation goods_not_in_free_circulation
MILabelCN22 mi_label_cn22 mi_label_cn22
SaturdayDelivery saturday_delivery saturday_delivery
Saturday Pickup saturday_pickup saturday_pickup
COD cod COD
Access Point COD access_point_cod AccessPointCOD
Deliver To Addressee Only Indicator deliver_to_addressee_only deliver_to_addressee_only
Direct Delivery Only Indicator direct_delivery_only direct_delivery_only
CN22 Form cn22_form CN22Form
UPS Premium Care Form premium_care_form UPSPremiumCareForm
Additional Document Indicator additional_document additional_document
Return Of Documents return_of_documents return_of_documents
Delivery Confirmation delivery_confirmation DeliveryConfirmation
Import Control import_control import_control
Commercial Invoice Removal Indicator commercial_invoice_removal CommercialInvoiceRemovalIndicator
UPS carbon neutral Indicator ups_carbon_neutral UPScarbonneutralIndicator
SDL Shipment Indicator sdl_shipment SDLShipmentIndicator
Exchange Forward Indicator exchange_forward ExchangeForwardIndicator
Dropoff At UPS Facility Indicator dropoff_at_ups_facility DropoffAtUPSFacilityIndicator
Hold For Pickup Indicator hold_for_pickup HoldForPickupIndicator
Diagnostic Specimens Indicator diagnostic_specimens DiagnosticSpecimensIndicator
Alcoholic Beverages Indicator alcoholic_beverages AlcoholicBeveragesIndicator
Perishables Indicator perishables PerishablesIndicator
Plants Indicator plants PlantsIndicator
Seeds Indicator seeds SeedsIndicator
Special Exceptions Indicator special_exceptions SpecialExceptionsIndicator
Tobacco Indicator tobacco TobaccoIndicator
No Transit Times no_transit_times NoTransitTime
Request List Rates list_rates 53
Paperless Trade paperless_trade paperless_trade
Include QR include_qr include_qr
MI Rate mi_rate mi_rate

Package Special Services
Name API value Code
Delivery Confirmation delivery_confirmation DeliveryConfirmation
COD cod COD
Access Point COD access_point_cod AccessPointCOD
Verbal Confirmation verbal_confirmation VerbalConfirmation
Shipper Release Indicator shipper_release ShipperReleaseIndicator
Large Package Indicator large_package large_package
Additional Handling additional_handling additional_handling
HazMat haz_mat HazMat
Dry Ice dry_ice DryIce
UPS Premium Care Indicator ups_premium_care UPSPremiumCareIndicator
Proactive Indicator proactive ProactiveIndicator
Refrigeration Indicator refrigeration RefrigerationIndicator

Custom Fields
Name API value Possible Values Required
Location ID location_id False
Description description False
Description description False
Package Type package_type False
Return Service Code return_service_code print_and_mail, return_service_attempt, return_service, electronic_return_label, print_return_label, exchange_print_return_label, pack_and_collect_1_1, pack_and_collect_1_2, pack_and_collect_1_3, pack_and_collect_1_4, pack_and_collect_1_5, pack_and_collect_3_1, pack_and_collect_3_2, pack_and_collect_3_3, pack_and_collect_3_4, pack_and_collect_3_5 False
Movement Reference Number movement_reference_number False
Sub Classification sub_classification irregular, machineable False
Cost Center cost_center False
Cost Center Barcode Indicator cost_center_barcode False
PackageID package_id False
Package ID Barcode Indicator package_id_barcode False
Irregular Indicator irregular_indicator balloon, oversize, not_applicable False
Invoice Line Total Currency Code ilt_currency_code False
Invoice Line Total Monetary Value ilt_monetary_value False
EPRA Release Code epra_release_code False
Clinical Trials ID clinical_trials_id False
Tax ID Type Code tax_id_type_code ein, dns, fgn False
Shipment Indication Type Code shipment_indication_type_code D2R, R2R False
HazMat Package Information haz_mat_package_information all_packed_in_one, over_packed, q_value False
HazMat Package QValue haz_mat_package_q_value False
USPS Endorsement usps_endorsement return_service_requested, forwarding_service_requested, address_service_requested, change_service_requested, no_service_selected False

Customs
Name API value Possible Values Node Required
Description description customs_item True
DocumentsOnly documents_only shipment False
Invoice Number invoice_number shipment False
Invoice Date invoice_date shipment False
Purchase Order Number po_number shipment False
Terms Of Shipment terms_of_shipment cost_and_freight, cost_insurance_and_freight, carriage_and_insurance_paid, carriage_paid_to, delivered_at_frontier, delivered_duty_paid, delivered_duty_unpaid, delivered_ex_quay, delivered_ex_ship, ex_works, free_alongside_ship, free_carrier, free_on_board shipment False
Reason For Export reason_for_export shipment False
Comments comments shipment False
Declaration Statement declaration_statement shipment False
Export Date export_date shipment False
Exporting Carrier exporting_carrier shipment False
Quantity quantity customs_item True
Value value customs_item True
Commodity Code commodity_code customs_item False
Manufacture Country Code manufacture_country_code customs_item True
Importer Type importer_type sender, recipient shipment False

References
Name API value Code
Reference 1 reference_1
Accounts Receivable Customer Account accounts_receivable_customer_account AJ
Appropriation Number appropriation_number AT
Bill of Lading Number bill_of_lading_number BM
Collect on Delivery (COD) Number collect_on_delivery_cod_number 9V
Dealer Order Number dealer_order_number ON
Department Number department_number DP
Food and Drug Administration (FDA) Product Code food_and_drug_administration_fda_product_code 3Q
Invoice Number invoice_number IK
Manifest Key Number manifest_key_number MK
Model Number model_number MJ
Part Number part_number PM
Production Code production_code PC
Purchase Order Number purchase_order_number PO
Purchase Request Number purchase_request_number RQ
Return Authorization Number return_authorization_number RZ
Salesperson Number salesperson_number SA
Serial Number serial_number SE
Store Number store_number ST
Transaction Reference Number transaction_reference_number TN
Return Label barcode TN
Example Request / Response
  1. {
  2.     "shipment": {
  3.         "carrier": "ups",
  4.         "currency": "GBP",
  5.         "debug": true,
  6.         "dim_units": "CM",
  7.         "include_base64_label": true,
  8.         "label_type": "EPL",
  9.         "packages": [
  10.             {
  11.                 "height": 1,
  12.                 "length": 1,
  13.                 "value": 1,
  14.                 "weight": 1,
  15.                 "width": 1,
  16.                 "special_services": [
  17.                     "delivery_confirmation"
  18.                 ]
  19.             }
  20.         ],
  21.         "packaging": "your_packaging",
  22.         "recipient": {
  23.             "city": "london",
  24.             "company": "Zenkraft User",
  25.             "country": "GB",
  26.             "email": "testexample@gmail.com",
  27.             "name": "Test User",
  28.             "phone": "01222 555 555",
  29.             "postal_code": "EC1R 4UG",
  30.             "state": "",
  31.             "street1": "1 Hardwick Street"
  32.         },
  33.         "sender": {
  34.             "city": "Bath",
  35.             "company": "TestCompany",
  36.             "country": "GB",
  37.             "email": "uk@testing.com",
  38.             "name": "TestCompany Name",
  39.             "phone": "",
  40.             "postal_code": "EC2R 6PJ",
  41.             "street1": "30 Moorgate"
  42.         },
  43.         "service": "ups_next_day_air",
  44.         "ship_date": "2025-03-31",
  45.         "shipping_account": "811195730",
  46.         "test": true,
  47.         "type": "outbound",
  48.         "weight_units": "KG",
  49.         "customs_items": [
  50.             {
  51.                 "description": "Description",
  52.                 "quantity": 1,
  53.                 "value": 10.1,
  54.                 "commodity_code": "Commodity Code",
  55.                 "manufacture_country_code": "Manufacture Country Code"
  56.             }
  57.         ],
  58.         "documents_only": false,
  59.         "invoice_number": "Invoice Number",
  60.         "invoice_date": "2025-03-31",
  61.         "po_number": "Purchase Order Number",
  62.         "terms_of_shipment": "cost_and_freight",
  63.         "reason_for_export": "Reason For Export",
  64.         "comments": "Comments",
  65.         "declaration_statement": "Declaration Statement",
  66.         "export_date": "2025-03-31",
  67.         "exporting_carrier": "Exporting Carrier",
  68.         "importer_type": "sender",
  69.         "notifications": [
  70.             {
  71.                 "type": "return_notification",
  72.                 "value": "return_notification"
  73.             },
  74.             {
  75.                 "type": "qv_in_transit_notification",
  76.                 "value": "qv_in_transit_notification"
  77.             },
  78.             {
  79.                 "type": "qv_ship_notification",
  80.                 "value": "qv_ship_notification"
  81.             },
  82.             {
  83.                 "type": "qv_exception_notification",
  84.                 "value": "qv_exception_notification"
  85.             },
  86.             {
  87.                 "type": "qv_delivery_notification",
  88.                 "value": "qv_delivery_notification"
  89.             },
  90.             {
  91.                 "type": "alternate_delivery_location_notification",
  92.                 "value": "alternate_delivery_location_notification"
  93.             },
  94.             {
  95.                 "type": "uap_shipper_notification",
  96.                 "value": "uap_shipper_notification"
  97.             },
  98.             {
  99.                 "type": "label_delivery",
  100.                 "value": "label_delivery"
  101.             }
  102.         ],
  103.         "references": [
  104.             {
  105.                 "type": "reference_1",
  106.                 "value": "Reference 1"
  107.             },
  108.             {
  109.                 "type": "accounts_receivable_customer_account",
  110.                 "value": "Accounts Receivable Customer Account"
  111.             },
  112.             {
  113.                 "type": "appropriation_number",
  114.                 "value": "Appropriation Number"
  115.             },
  116.             {
  117.                 "type": "bill_of_lading_number",
  118.                 "value": "Bill of Lading Number"
  119.             },
  120.             {
  121.                 "type": "collect_on_delivery_cod_number",
  122.                 "value": "Collect on Delivery (COD) Number"
  123.             },
  124.             {
  125.                 "type": "dealer_order_number",
  126.                 "value": "Dealer Order Number"
  127.             },
  128.             {
  129.                 "type": "department_number",
  130.                 "value": "Department Number"
  131.             },
  132.             {
  133.                 "type": "food_and_drug_administration_fda_product_code",
  134.                 "value": "Food and Drug Administration (FDA) Product Code"
  135.             },
  136.             {
  137.                 "type": "invoice_number",
  138.                 "value": "Invoice Number"
  139.             },
  140.             {
  141.                 "type": "manifest_key_number",
  142.                 "value": "Manifest Key Number"
  143.             },
  144.             {
  145.                 "type": "model_number",
  146.                 "value": "Model Number"
  147.             },
  148.             {
  149.                 "type": "part_number",
  150.                 "value": "Part Number"
  151.             },
  152.             {
  153.                 "type": "production_code",
  154.                 "value": "Production Code"
  155.             },
  156.             {
  157.                 "type": "purchase_order_number",
  158.                 "value": "Purchase Order Number"
  159.             },
  160.             {
  161.                 "type": "purchase_request_number",
  162.                 "value": "Purchase Request Number"
  163.             },
  164.             {
  165.                 "type": "return_authorization_number",
  166.                 "value": "Return Authorization Number"
  167.             },
  168.             {
  169.                 "type": "salesperson_number",
  170.                 "value": "Salesperson Number"
  171.             },
  172.             {
  173.                 "type": "serial_number",
  174.                 "value": "Serial Number"
  175.             },
  176.             {
  177.                 "type": "store_number",
  178.                 "value": "Store Number"
  179.             },
  180.             {
  181.                 "type": "transaction_reference_number",
  182.                 "value": "Transaction Reference Number"
  183.             },
  184.             {
  185.                 "type": "barcode",
  186.                 "value": "Return Label"
  187.             }
  188.         ],
  189.         "label_size": "4X6",
  190.         "special_services": [
  191.             "alternate_delivery_address"
  192.         ]
  193.     }
  194. }
                curl --request POST \
--url https://api.zenkraft.com/ship \
--header 'content-type: application/json' \
--header 'zkkey: XXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
    "shipment": {
        "carrier": "ups",
        "currency": "GBP",
        "debug": true,
        "dim_units": "CM",
        "include_base64_label": true,
        "label_type": "EPL",
        "packages": [
            {
                "height": 1,
                "length": 1,
                "value": 1,
                "weight": 1,
                "width": 1,
                "special_services": [
                    "delivery_confirmation"
                ]
            }
        ],
        "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"
        },
        "sender": {
            "city": "Bath",
            "company": "TestCompany",
            "country": "GB",
            "email": "uk@testing.com",
            "name": "TestCompany Name",
            "phone": "",
            "postal_code": "EC2R 6PJ",
            "street1": "30 Moorgate"
        },
        "service": "ups_next_day_air",
        "ship_date": "2025-03-31",
        "shipping_account": "811195730",
        "test": true,
        "type": "outbound",
        "weight_units": "KG",
        "customs_items": [
            {
                "description": "Description",
                "quantity": 1,
                "value": 10.1,
                "commodity_code": "Commodity Code",
                "manufacture_country_code": "Manufacture Country Code"
            }
        ],
        "documents_only": false,
        "invoice_number": "Invoice Number",
        "invoice_date": "2025-03-31",
        "po_number": "Purchase Order Number",
        "terms_of_shipment": "cost_and_freight",
        "reason_for_export": "Reason For Export",
        "comments": "Comments",
        "declaration_statement": "Declaration Statement",
        "export_date": "2025-03-31",
        "exporting_carrier": "Exporting Carrier",
        "importer_type": "sender",
        "notifications": [
            {
                "type": "return_notification",
                "value": "return_notification"
            },
            {
                "type": "qv_in_transit_notification",
                "value": "qv_in_transit_notification"
            },
            {
                "type": "qv_ship_notification",
                "value": "qv_ship_notification"
            },
            {
                "type": "qv_exception_notification",
                "value": "qv_exception_notification"
            },
            {
                "type": "qv_delivery_notification",
                "value": "qv_delivery_notification"
            },
            {
                "type": "alternate_delivery_location_notification",
                "value": "alternate_delivery_location_notification"
            },
            {
                "type": "uap_shipper_notification",
                "value": "uap_shipper_notification"
            },
            {
                "type": "label_delivery",
                "value": "label_delivery"
            }
        ],
        "references": [
            {
                "type": "reference_1",
                "value": "Reference 1"
            },
            {
                "type": "accounts_receivable_customer_account",
                "value": "Accounts Receivable Customer Account"
            },
            {
                "type": "appropriation_number",
                "value": "Appropriation Number"
            },
            {
                "type": "bill_of_lading_number",
                "value": "Bill of Lading Number"
            },
            {
                "type": "collect_on_delivery_cod_number",
                "value": "Collect on Delivery (COD) Number"
            },
            {
                "type": "dealer_order_number",
                "value": "Dealer Order Number"
            },
            {
                "type": "department_number",
                "value": "Department Number"
            },
            {
                "type": "food_and_drug_administration_fda_product_code",
                "value": "Food and Drug Administration (FDA) Product Code"
            },
            {
                "type": "invoice_number",
                "value": "Invoice Number"
            },
            {
                "type": "manifest_key_number",
                "value": "Manifest Key Number"
            },
            {
                "type": "model_number",
                "value": "Model Number"
            },
            {
                "type": "part_number",
                "value": "Part Number"
            },
            {
                "type": "production_code",
                "value": "Production Code"
            },
            {
                "type": "purchase_order_number",
                "value": "Purchase Order Number"
            },
            {
                "type": "purchase_request_number",
                "value": "Purchase Request Number"
            },
            {
                "type": "return_authorization_number",
                "value": "Return Authorization Number"
            },
            {
                "type": "salesperson_number",
                "value": "Salesperson Number"
            },
            {
                "type": "serial_number",
                "value": "Serial Number"
            },
            {
                "type": "store_number",
                "value": "Store Number"
            },
            {
                "type": "transaction_reference_number",
                "value": "Transaction Reference Number"
            },
            {
                "type": "barcode",
                "value": "Return Label"
            }
        ],
        "label_size": "4X6",
        "special_services": [
            "alternate_delivery_address"
        ]
    }
}'
            

import requests

headers = {
"zkkey": "XXXXXXXXXXXXXXXXXXXXXXX"
}

payload = {
    "shipment": {
        "carrier": "ups",
        "currency": "GBP",
        "debug": true,
        "dim_units": "CM",
        "include_base64_label": true,
        "label_type": "EPL",
        "packages": [
            {
                "height": 1,
                "length": 1,
                "value": 1,
                "weight": 1,
                "width": 1,
                "special_services": [
                    "delivery_confirmation"
                ]
            }
        ],
        "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"
        },
        "sender": {
            "city": "Bath",
            "company": "TestCompany",
            "country": "GB",
            "email": "uk@testing.com",
            "name": "TestCompany Name",
            "phone": "",
            "postal_code": "EC2R 6PJ",
            "street1": "30 Moorgate"
        },
        "service": "ups_next_day_air",
        "ship_date": "2025-03-31",
        "shipping_account": "811195730",
        "test": true,
        "type": "outbound",
        "weight_units": "KG",
        "customs_items": [
            {
                "description": "Description",
                "quantity": 1,
                "value": 10.1,
                "commodity_code": "Commodity Code",
                "manufacture_country_code": "Manufacture Country Code"
            }
        ],
        "documents_only": false,
        "invoice_number": "Invoice Number",
        "invoice_date": "2025-03-31",
        "po_number": "Purchase Order Number",
        "terms_of_shipment": "cost_and_freight",
        "reason_for_export": "Reason For Export",
        "comments": "Comments",
        "declaration_statement": "Declaration Statement",
        "export_date": "2025-03-31",
        "exporting_carrier": "Exporting Carrier",
        "importer_type": "sender",
        "notifications": [
            {
                "type": "return_notification",
                "value": "return_notification"
            },
            {
                "type": "qv_in_transit_notification",
                "value": "qv_in_transit_notification"
            },
            {
                "type": "qv_ship_notification",
                "value": "qv_ship_notification"
            },
            {
                "type": "qv_exception_notification",
                "value": "qv_exception_notification"
            },
            {
                "type": "qv_delivery_notification",
                "value": "qv_delivery_notification"
            },
            {
                "type": "alternate_delivery_location_notification",
                "value": "alternate_delivery_location_notification"
            },
            {
                "type": "uap_shipper_notification",
                "value": "uap_shipper_notification"
            },
            {
                "type": "label_delivery",
                "value": "label_delivery"
            }
        ],
        "references": [
            {
                "type": "reference_1",
                "value": "Reference 1"
            },
            {
                "type": "accounts_receivable_customer_account",
                "value": "Accounts Receivable Customer Account"
            },
            {
                "type": "appropriation_number",
                "value": "Appropriation Number"
            },
            {
                "type": "bill_of_lading_number",
                "value": "Bill of Lading Number"
            },
            {
                "type": "collect_on_delivery_cod_number",
                "value": "Collect on Delivery (COD) Number"
            },
            {
                "type": "dealer_order_number",
                "value": "Dealer Order Number"
            },
            {
                "type": "department_number",
                "value": "Department Number"
            },
            {
                "type": "food_and_drug_administration_fda_product_code",
                "value": "Food and Drug Administration (FDA) Product Code"
            },
            {
                "type": "invoice_number",
                "value": "Invoice Number"
            },
            {
                "type": "manifest_key_number",
                "value": "Manifest Key Number"
            },
            {
                "type": "model_number",
                "value": "Model Number"
            },
            {
                "type": "part_number",
                "value": "Part Number"
            },
            {
                "type": "production_code",
                "value": "Production Code"
            },
            {
                "type": "purchase_order_number",
                "value": "Purchase Order Number"
            },
            {
                "type": "purchase_request_number",
                "value": "Purchase Request Number"
            },
            {
                "type": "return_authorization_number",
                "value": "Return Authorization Number"
            },
            {
                "type": "salesperson_number",
                "value": "Salesperson Number"
            },
            {
                "type": "serial_number",
                "value": "Serial Number"
            },
            {
                "type": "store_number",
                "value": "Store Number"
            },
            {
                "type": "transaction_reference_number",
                "value": "Transaction Reference Number"
            },
            {
                "type": "barcode",
                "value": "Return Label"
            }
        ],
        "label_size": "4X6",
        "special_services": [
            "alternate_delivery_address"
        ]
    }
}
url = "https://api.zenkraft.com/ship"

response = requests.request(url=url, method='POST', json=payload, headers=headers)

print(response.json())
            
                
            
  1. {
  2.   "shipment": {
  3.     "carrier": "ups",
  4.     "shipping_account": "5190163571408896",
  5.     "test": true,
  6.     "debug": false,
  7.     "ship_date": "2025-03-31",
  8.     "type": "outbound",
  9.     "service": "ups_next_day_air",
  10.     "special_services": [
  11.       "saturday_delivery"
  12.     ],
  13.     "packaging": "your_packaging",
  14.     "dim_units": "IN",
  15.     "weight_units": "LB",
  16.     "currency": "USD",
  17.     "sender": {
  18.       "name": "Jack O'Rogers",
  19.       "company": "Burlington Textiles Corp of America",
  20.       "street1": "525 S. ZENKRAFT Ave",
  21.       "street2": "suite 120",
  22.       "email": "jrogers@example.com",
  23.       "phone": "(336) 222-7000",
  24.       "city": "Burlington",
  25.       "state": "NC",
  26.       "postal_code": "27215",
  27.       "country": "US"
  28.     },
  29.     "recipient": {
  30.       "name": "Jack O'Rogers",
  31.       "company": "Burlington Textiles Corp of America",
  32.       "street1": "525 S. ZENKRAFT Ave",
  33.       "street2": "suite 120",
  34.       "email": "jrogers@example.com",
  35.       "phone": "(336) 222-7000",
  36.       "city": "Burlington",
  37.       "state": "NC",
  38.       "postal_code": "27215",
  39.       "country": "US"
  40.     },
  41.     "packages": [
  42.       {
  43.         "weight": 4.2,
  44.         "value": 25,
  45.         "length": 11,
  46.         "width": 8.5,
  47.         "height": 5,
  48.         "tracking_number": "567293923024",
  49.         "label": "string"
  50.       }
  51.     ],
  52.     "label_type": "PDF",
  53.     "include_base64_label": false,
  54.     "references": [
  55.       {
  56.         "type": "customer_reference",
  57.         "value": "ABC-000123"
  58.       }
  59.     ],
  60.     "notifications": [
  61.       {
  62.         "type": "email",
  63.         "value": "notification1@example.com"
  64.       }
  65.     ],
  66.     "costs": {
  67.       "base_charge": 100,
  68.       "net_charge": 80,
  69.       "taxes": 20,
  70.       "surcharges": 0,
  71.       "discounts": 0
  72.     },
  73.     "id": "1f02d12868a54ed88b6cb4dafaad325d",
  74.     "tracking_number": "567293923024",
  75.     "shipping_documents": [{
  76.       "description": "Commercial Invoice",
  77.       "document_type": "PDF",
  78.       "document": "string"
  79.     }],
  80.     "context": {}
  81.   }
  82. }

/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 ups
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 EPL EPL__4X6 EPL__4X8 ZPL ZPL__4X6 ZPL__4X8 SPL SPL__4X6 SPL__4X8 GIF PDF qrcode PNG PDF
shipping_account string Shipping account number 5190163571408896
status string Standardized shipment status success pending 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 unexpected_exception schema_validation_error carrier_label_generation_failed carrier_no_shipment_found schema_field_required carrier_authentication carrier_failed_connection carrier_throttling carrier_unsupported_method carrier_exception shipping_account_wrong_carrier carrier_http_exception missing_api_key shipping_account_not_found wrong_api_key carrier_timeout 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
  1. 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())
            
                
            
  1. {
  2.   "shipment": {
  3.     "carrier": "ups",
  4.     "shipping_account": "5190163571408896",
  5.     "test": true,
  6.     "debug": false,
  7.     "ship_date": "2025-03-31",
  8.     "type": "outbound",
  9.     "service": "ups_next_day_air",
  10.     "special_services": [
  11.       "saturday_delivery"
  12.     ],
  13.     "packaging": "your_packaging",
  14.     "dim_units": "IN",
  15.     "weight_units": "LB",
  16.     "currency": "USD",
  17.     "sender": {
  18.       "name": "Jack O'Rogers",
  19.       "company": "Burlington Textiles Corp of America",
  20.       "street1": "525 S. ZENKRAFT Ave",
  21.       "street2": "suite 120",
  22.       "email": "jrogers@example.com",
  23.       "phone": "(336) 222-7000",
  24.       "city": "Burlington",
  25.       "state": "NC",
  26.       "postal_code": "27215",
  27.       "country": "US"
  28.     },
  29.     "recipient": {
  30.       "name": "Jack O'Rogers",
  31.       "company": "Burlington Textiles Corp of America",
  32.       "street1": "525 S. ZENKRAFT Ave",
  33.       "street2": "suite 120",
  34.       "email": "jrogers@example.com",
  35.       "phone": "(336) 222-7000",
  36.       "city": "Burlington",
  37.       "state": "NC",
  38.       "postal_code": "27215",
  39.       "country": "US"
  40.     },
  41.     "packages": [
  42.       {
  43.         "weight": 4.2,
  44.         "value": 25,
  45.         "length": 11,
  46.         "width": 8.5,
  47.         "height": 5,
  48.         "tracking_number": "567293923024",
  49.         "label": "string"
  50.       }
  51.     ],
  52.     "label_type": "PDF",
  53.     "include_base64_label": false,
  54.     "references": [
  55.       {
  56.         "type": "customer_reference",
  57.         "value": "ABC-000123"
  58.       }
  59.     ],
  60.     "notifications": [
  61.       {
  62.         "type": "email",
  63.         "value": "notification1@example.com"
  64.       }
  65.     ],
  66.     "costs": {
  67.       "base_charge": 100,
  68.       "net_charge": 80,
  69.       "taxes": 20,
  70.       "surcharges": 0,
  71.       "discounts": 0
  72.     },
  73.     "id": "1f02d12868a54ed88b6cb4dafaad325d",
  74.     "tracking_number": "567293923024",
  75.     "shipping_documents": [{
  76.       "description": "Commercial Invoice",
  77.       "document_type": "PDF",
  78.       "document": "string"
  79.     }],
  80.     "context": {}
  81.   }
  82. }

/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 ups
currency string BIF UAH USD HTG AUD MGA PHP JMD JOD KYD DZD KPW MYR DJF INR NPR CUP ILS LRD BSD TTD ZWD ANG CHF FJD MZN KGS GHS KES RSD FKP IDR VUV XAF SPL BND PYG MMK UYU LBP TND MDL ZMW SVC LSL WST KZT SHP THB TVD XOF SOS UGX HRK LAK BBD CNY BYN KMF CDF COP NIO GIP KRW GMD MRU PKR TZS BRL LKR MWK NOK NGN SRD MXN CUC XCD DOP BTN CVE SCR MAD LYD MNT QAR OMR RUB ETB HUF MUR AED EGP AZN DKK GEL NZD PAB CLP SLL TOP AMD XPF YER PGK BOB SYP BMD TRY JEP IQD AOA CAD TWD GTQ KWD ALL HKD BHD AFN SBD TMT RWF NAD SZL SAR JPY TJS BDT ISK SGD IMP BGN AWG VEF PLN PEN HNL IRR STN MKD SEK CRC XDR GYD GNF VND BAM MVR SDG UZS ARS GGP BWP GBP KHR BZD ERN MOP ZAR RON EUR CZK
debug boolean calls with debug=true will be logged
dim_units string Dimension units of the packages, inches or centimeters required IN CM IN
packages array required
height number height of the package according to units specified under dim_units 5
length number length of the package according to units specified under dim_units. ususally the length needs to be the largest of length, width, height 11
value number value of the package according to currency specified 25
weight number weight of the package according to units specified under weight_units 4.2
width number width of the package according to units specified under dim_units 8.5
packaging string the packaging type required your_packaging your_packaging
recipient object 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 KM BG BE MO BB PE LU MM RU SY ZW BZ KP AE KZ HU BS CN JE NL AL LC GQ NO DO ES IT AW NZ KG EE GL PN PA AF BI LV MF KR AS SG LY GY EC ST PH GS LI GP KW PW GR BY NR CL BF WF AX BN NU PM CM DM MT MZ FM QA AD CU TV VE GD KE TC SD MC TJ TR CI TK MA ZM JP SR BH LB MV DE EH RE UA CC MW FI WS BO EG GG TZ NA AZ CV LK KI TD MP AQ TG IS LR VA CD GB ML BJ PT JO SE SX VU ER HN MS RS JM RW SH AO VC BD PL VI CA BT CG AI HT KH LA FJ SK IM IL MD KY BQ LS AG AM PG HR BM TF GT GW PF MG IO TN RO TL TO VN UZ FK SC CK CZ NP VG MQ YE GU GF TT SA SS CF DJ MN MY UG FR MU ET PS BR HM SJ MR SV KN IE MK UM GM SL HK LT MH FO BA IN YT BL BW SO US GI NF GN ZA BV AR TW UY SI CR TH CO CY TM CW GE OM NI DK IQ PK SB MX PR ID NC SZ NE PY SN AU AT GA SM ME NG CH CX DZ IR GH 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 KM BG BE MO BB PE LU MM RU SY ZW BZ KP AE KZ HU BS CN JE NL AL LC GQ NO DO ES IT AW NZ KG EE GL PN PA AF BI LV MF KR AS SG LY GY EC ST PH GS LI GP KW PW GR BY NR CL BF WF AX BN NU PM CM DM MT MZ FM QA AD CU TV VE GD KE TC SD MC TJ TR CI TK MA ZM JP SR BH LB MV DE EH RE UA CC MW FI WS BO EG GG TZ NA AZ CV LK KI TD MP AQ TG IS LR VA CD GB ML BJ PT JO SE SX VU ER HN MS RS JM RW SH AO VC BD PL VI CA BT CG AI HT KH LA FJ SK IM IL MD KY BQ LS AG AM PG HR BM TF GT GW PF MG IO TN RO TL TO VN UZ FK SC CK CZ NP VG MQ YE GU GF TT SA SS CF DJ MN MY UG FR MU ET PS BR HM SJ MR SV KN IE MK UM GM SL HK LT MH FO BA IN YT BL BW SO US GI NF GN ZA BV AR TW UY SI CR TH CO CY TM CW GE OM NI DK IQ PK SB MX PR ID NC SZ NE PY SN AU AT GA SM ME NG CH CX DZ IR GH 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 ups_next_day_air ups_second_day_air ups_ground ups_express ups_expedited ups_standard ups_three_day_select ups_next_day_air_saver ups_next_day_air_early ups_express_plus ups_second_day_air_am ups_saver ups_access_point_economy ups_first_class_mail ups_priority_mail ups_expedited_mail_innovations ups_priority_mail_innovations ups_economy_mail_innovations ups_today_standard ups_today_dedicated_courier ups_today_intercity ups_today_express ups_today_express_saver ups_worldwide_economy_ddu ups_worldwide_economy_ddp ups_worldwide_express_freight ups_surepost_lt_1lb ups_surepost standard_flats parcel_select_lightweight_irreg parcel_select bpm_parcels bpm_flats media_mail marketing_parcels ups_next_day_air
ship_date string shipping date 2021-06-07
shipping_account string Shipping account number required 5190163571408896
special_services array alternate_delivery_address goods_not_in_free_circulation mi_label_cn22 saturday_delivery saturday_pickup cod access_point_cod deliver_to_addressee_only direct_delivery_only cn22_form premium_care_form additional_document return_of_documents delivery_confirmation import_control commercial_invoice_removal ups_carbon_neutral sdl_shipment exchange_forward dropoff_at_ups_facility hold_for_pickup diagnostic_specimens alcoholic_beverages perishables plants seeds special_exceptions tobacco no_transit_times list_rates paperless_trade include_qr mi_rate [alternate_delivery_address ]
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 ups_next_day_air ups_second_day_air ups_ground ups_express ups_expedited ups_standard ups_three_day_select ups_next_day_air_saver ups_next_day_air_early ups_express_plus ups_second_day_air_am ups_saver ups_access_point_economy ups_first_class_mail ups_priority_mail ups_expedited_mail_innovations ups_priority_mail_innovations ups_economy_mail_innovations ups_today_standard ups_today_dedicated_courier ups_today_intercity ups_today_express ups_today_express_saver ups_worldwide_economy_ddu ups_worldwide_economy_ddp ups_worldwide_express_freight ups_surepost_lt_1lb ups_surepost standard_flats parcel_select_lightweight_irreg parcel_select bpm_parcels bpm_flats media_mail marketing_parcels ups_next_day_air
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 unexpected_exception schema_validation_error schema_field_required ship_date_past carrier_authentication carrier_failed_connection carrier_throttling carrier_unsupported_method carrier_exception shipping_account_wrong_carrier carrier_http_exception missing_api_key shipping_account_not_found wrong_api_key carrier_timeout 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
  1. {
  2.     "shipment": {
  3.         "carrier": "ups",
  4.         "currency": "GBP",
  5.         "debug": true,
  6.         "dim_units": "CM",
  7.         "include_base64_label": true,
  8.         "label_type": "EPL",
  9.         "packages": [
  10.             {
  11.                 "height": 1,
  12.                 "length": 1,
  13.                 "value": 1,
  14.                 "weight": 1,
  15.                 "width": 1,
  16.                 "special_services": [
  17.                     "delivery_confirmation"
  18.                 ]
  19.             }
  20.         ],
  21.         "packaging": "your_packaging",
  22.         "recipient": {
  23.             "city": "london",
  24.             "company": "Zenkraft User",
  25.             "country": "GB",
  26.             "email": "testexample@gmail.com",
  27.             "name": "Test User",
  28.             "phone": "01222 555 555",
  29.             "postal_code": "EC1R 4UG",
  30.             "state": "",
  31.             "street1": "1 Hardwick Street"
  32.         },
  33.         "sender": {
  34.             "city": "Bath",
  35.             "company": "TestCompany",
  36.             "country": "GB",
  37.             "email": "uk@testing.com",
  38.             "name": "TestCompany Name",
  39.             "phone": "",
  40.             "postal_code": "EC2R 6PJ",
  41.             "street1": "30 Moorgate"
  42.         },
  43.         "service": "ups_next_day_air",
  44.         "ship_date": "2025-03-31",
  45.         "shipping_account": "811195730",
  46.         "test": true,
  47.         "type": "outbound",
  48.         "weight_units": "KG",
  49.         "customs_items": [
  50.             {
  51.                 "description": "Description",
  52.                 "quantity": 1,
  53.                 "value": 10.1,
  54.                 "commodity_code": "Commodity Code",
  55.                 "manufacture_country_code": "Manufacture Country Code"
  56.             }
  57.         ],
  58.         "documents_only": false,
  59.         "invoice_number": "Invoice Number",
  60.         "invoice_date": "2025-03-31",
  61.         "po_number": "Purchase Order Number",
  62.         "terms_of_shipment": "cost_and_freight",
  63.         "reason_for_export": "Reason For Export",
  64.         "comments": "Comments",
  65.         "declaration_statement": "Declaration Statement",
  66.         "export_date": "2025-03-31",
  67.         "exporting_carrier": "Exporting Carrier",
  68.         "importer_type": "sender",
  69.         "notifications": [
  70.             {
  71.                 "type": "return_notification",
  72.                 "value": "return_notification"
  73.             },
  74.             {
  75.                 "type": "qv_in_transit_notification",
  76.                 "value": "qv_in_transit_notification"
  77.             },
  78.             {
  79.                 "type": "qv_ship_notification",
  80.                 "value": "qv_ship_notification"
  81.             },
  82.             {
  83.                 "type": "qv_exception_notification",
  84.                 "value": "qv_exception_notification"
  85.             },
  86.             {
  87.                 "type": "qv_delivery_notification",
  88.                 "value": "qv_delivery_notification"
  89.             },
  90.             {
  91.                 "type": "alternate_delivery_location_notification",
  92.                 "value": "alternate_delivery_location_notification"
  93.             },
  94.             {
  95.                 "type": "uap_shipper_notification",
  96.                 "value": "uap_shipper_notification"
  97.             },
  98.             {
  99.                 "type": "label_delivery",
  100.                 "value": "label_delivery"
  101.             }
  102.         ],
  103.         "references": [
  104.             {
  105.                 "type": "reference_1",
  106.                 "value": "Reference 1"
  107.             },
  108.             {
  109.                 "type": "accounts_receivable_customer_account",
  110.                 "value": "Accounts Receivable Customer Account"
  111.             },
  112.             {
  113.                 "type": "appropriation_number",
  114.                 "value": "Appropriation Number"
  115.             },
  116.             {
  117.                 "type": "bill_of_lading_number",
  118.                 "value": "Bill of Lading Number"
  119.             },
  120.             {
  121.                 "type": "collect_on_delivery_cod_number",
  122.                 "value": "Collect on Delivery (COD) Number"
  123.             },
  124.             {
  125.                 "type": "dealer_order_number",
  126.                 "value": "Dealer Order Number"
  127.             },
  128.             {
  129.                 "type": "department_number",
  130.                 "value": "Department Number"
  131.             },
  132.             {
  133.                 "type": "food_and_drug_administration_fda_product_code",
  134.                 "value": "Food and Drug Administration (FDA) Product Code"
  135.             },
  136.             {
  137.                 "type": "invoice_number",
  138.                 "value": "Invoice Number"
  139.             },
  140.             {
  141.                 "type": "manifest_key_number",
  142.                 "value": "Manifest Key Number"
  143.             },
  144.             {
  145.                 "type": "model_number",
  146.                 "value": "Model Number"
  147.             },
  148.             {
  149.                 "type": "part_number",
  150.                 "value": "Part Number"
  151.             },
  152.             {
  153.                 "type": "production_code",
  154.                 "value": "Production Code"
  155.             },
  156.             {
  157.                 "type": "purchase_order_number",
  158.                 "value": "Purchase Order Number"
  159.             },
  160.             {
  161.                 "type": "purchase_request_number",
  162.                 "value": "Purchase Request Number"
  163.             },
  164.             {
  165.                 "type": "return_authorization_number",
  166.                 "value": "Return Authorization Number"
  167.             },
  168.             {
  169.                 "type": "salesperson_number",
  170.                 "value": "Salesperson Number"
  171.             },
  172.             {
  173.                 "type": "serial_number",
  174.                 "value": "Serial Number"
  175.             },
  176.             {
  177.                 "type": "store_number",
  178.                 "value": "Store Number"
  179.             },
  180.             {
  181.                 "type": "transaction_reference_number",
  182.                 "value": "Transaction Reference Number"
  183.             },
  184.             {
  185.                 "type": "barcode",
  186.                 "value": "Return Label"
  187.             }
  188.         ],
  189.         "label_size": "4X6",
  190.         "special_services": [
  191.             "alternate_delivery_address"
  192.         ]
  193.     }
  194. }
                curl --request POST \
--url https://api.zenkraft.com/rate \
--header 'content-type: application/json' \
--header 'zkkey: XXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
    "shipment": {
        "carrier": "ups",
        "currency": "GBP",
        "debug": true,
        "dim_units": "CM",
        "include_base64_label": true,
        "label_type": "EPL",
        "packages": [
            {
                "height": 1,
                "length": 1,
                "value": 1,
                "weight": 1,
                "width": 1,
                "special_services": [
                    "delivery_confirmation"
                ]
            }
        ],
        "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"
        },
        "sender": {
            "city": "Bath",
            "company": "TestCompany",
            "country": "GB",
            "email": "uk@testing.com",
            "name": "TestCompany Name",
            "phone": "",
            "postal_code": "EC2R 6PJ",
            "street1": "30 Moorgate"
        },
        "service": "ups_next_day_air",
        "ship_date": "2025-03-31",
        "shipping_account": "811195730",
        "test": true,
        "type": "outbound",
        "weight_units": "KG",
        "customs_items": [
            {
                "description": "Description",
                "quantity": 1,
                "value": 10.1,
                "commodity_code": "Commodity Code",
                "manufacture_country_code": "Manufacture Country Code"
            }
        ],
        "documents_only": false,
        "invoice_number": "Invoice Number",
        "invoice_date": "2025-03-31",
        "po_number": "Purchase Order Number",
        "terms_of_shipment": "cost_and_freight",
        "reason_for_export": "Reason For Export",
        "comments": "Comments",
        "declaration_statement": "Declaration Statement",
        "export_date": "2025-03-31",
        "exporting_carrier": "Exporting Carrier",
        "importer_type": "sender",
        "notifications": [
            {
                "type": "return_notification",
                "value": "return_notification"
            },
            {
                "type": "qv_in_transit_notification",
                "value": "qv_in_transit_notification"
            },
            {
                "type": "qv_ship_notification",
                "value": "qv_ship_notification"
            },
            {
                "type": "qv_exception_notification",
                "value": "qv_exception_notification"
            },
            {
                "type": "qv_delivery_notification",
                "value": "qv_delivery_notification"
            },
            {
                "type": "alternate_delivery_location_notification",
                "value": "alternate_delivery_location_notification"
            },
            {
                "type": "uap_shipper_notification",
                "value": "uap_shipper_notification"
            },
            {
                "type": "label_delivery",
                "value": "label_delivery"
            }
        ],
        "references": [
            {
                "type": "reference_1",
                "value": "Reference 1"
            },
            {
                "type": "accounts_receivable_customer_account",
                "value": "Accounts Receivable Customer Account"
            },
            {
                "type": "appropriation_number",
                "value": "Appropriation Number"
            },
            {
                "type": "bill_of_lading_number",
                "value": "Bill of Lading Number"
            },
            {
                "type": "collect_on_delivery_cod_number",
                "value": "Collect on Delivery (COD) Number"
            },
            {
                "type": "dealer_order_number",
                "value": "Dealer Order Number"
            },
            {
                "type": "department_number",
                "value": "Department Number"
            },
            {
                "type": "food_and_drug_administration_fda_product_code",
                "value": "Food and Drug Administration (FDA) Product Code"
            },
            {
                "type": "invoice_number",
                "value": "Invoice Number"
            },
            {
                "type": "manifest_key_number",
                "value": "Manifest Key Number"
            },
            {
                "type": "model_number",
                "value": "Model Number"
            },
            {
                "type": "part_number",
                "value": "Part Number"
            },
            {
                "type": "production_code",
                "value": "Production Code"
            },
            {
                "type": "purchase_order_number",
                "value": "Purchase Order Number"
            },
            {
                "type": "purchase_request_number",
                "value": "Purchase Request Number"
            },
            {
                "type": "return_authorization_number",
                "value": "Return Authorization Number"
            },
            {
                "type": "salesperson_number",
                "value": "Salesperson Number"
            },
            {
                "type": "serial_number",
                "value": "Serial Number"
            },
            {
                "type": "store_number",
                "value": "Store Number"
            },
            {
                "type": "transaction_reference_number",
                "value": "Transaction Reference Number"
            },
            {
                "type": "barcode",
                "value": "Return Label"
            }
        ],
        "label_size": "4X6",
        "special_services": [
            "alternate_delivery_address"
        ]
    }
}'
            

import requests

headers = {
"zkkey": "XXXXXXXXXXXXXXXXXXXXXXX"
}

payload = {
    "shipment": {
        "carrier": "ups",
        "currency": "GBP",
        "debug": true,
        "dim_units": "CM",
        "include_base64_label": true,
        "label_type": "EPL",
        "packages": [
            {
                "height": 1,
                "length": 1,
                "value": 1,
                "weight": 1,
                "width": 1,
                "special_services": [
                    "delivery_confirmation"
                ]
            }
        ],
        "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"
        },
        "sender": {
            "city": "Bath",
            "company": "TestCompany",
            "country": "GB",
            "email": "uk@testing.com",
            "name": "TestCompany Name",
            "phone": "",
            "postal_code": "EC2R 6PJ",
            "street1": "30 Moorgate"
        },
        "service": "ups_next_day_air",
        "ship_date": "2025-03-31",
        "shipping_account": "811195730",
        "test": true,
        "type": "outbound",
        "weight_units": "KG",
        "customs_items": [
            {
                "description": "Description",
                "quantity": 1,
                "value": 10.1,
                "commodity_code": "Commodity Code",
                "manufacture_country_code": "Manufacture Country Code"
            }
        ],
        "documents_only": false,
        "invoice_number": "Invoice Number",
        "invoice_date": "2025-03-31",
        "po_number": "Purchase Order Number",
        "terms_of_shipment": "cost_and_freight",
        "reason_for_export": "Reason For Export",
        "comments": "Comments",
        "declaration_statement": "Declaration Statement",
        "export_date": "2025-03-31",
        "exporting_carrier": "Exporting Carrier",
        "importer_type": "sender",
        "notifications": [
            {
                "type": "return_notification",
                "value": "return_notification"
            },
            {
                "type": "qv_in_transit_notification",
                "value": "qv_in_transit_notification"
            },
            {
                "type": "qv_ship_notification",
                "value": "qv_ship_notification"
            },
            {
                "type": "qv_exception_notification",
                "value": "qv_exception_notification"
            },
            {
                "type": "qv_delivery_notification",
                "value": "qv_delivery_notification"
            },
            {
                "type": "alternate_delivery_location_notification",
                "value": "alternate_delivery_location_notification"
            },
            {
                "type": "uap_shipper_notification",
                "value": "uap_shipper_notification"
            },
            {
                "type": "label_delivery",
                "value": "label_delivery"
            }
        ],
        "references": [
            {
                "type": "reference_1",
                "value": "Reference 1"
            },
            {
                "type": "accounts_receivable_customer_account",
                "value": "Accounts Receivable Customer Account"
            },
            {
                "type": "appropriation_number",
                "value": "Appropriation Number"
            },
            {
                "type": "bill_of_lading_number",
                "value": "Bill of Lading Number"
            },
            {
                "type": "collect_on_delivery_cod_number",
                "value": "Collect on Delivery (COD) Number"
            },
            {
                "type": "dealer_order_number",
                "value": "Dealer Order Number"
            },
            {
                "type": "department_number",
                "value": "Department Number"
            },
            {
                "type": "food_and_drug_administration_fda_product_code",
                "value": "Food and Drug Administration (FDA) Product Code"
            },
            {
                "type": "invoice_number",
                "value": "Invoice Number"
            },
            {
                "type": "manifest_key_number",
                "value": "Manifest Key Number"
            },
            {
                "type": "model_number",
                "value": "Model Number"
            },
            {
                "type": "part_number",
                "value": "Part Number"
            },
            {
                "type": "production_code",
                "value": "Production Code"
            },
            {
                "type": "purchase_order_number",
                "value": "Purchase Order Number"
            },
            {
                "type": "purchase_request_number",
                "value": "Purchase Request Number"
            },
            {
                "type": "return_authorization_number",
                "value": "Return Authorization Number"
            },
            {
                "type": "salesperson_number",
                "value": "Salesperson Number"
            },
            {
                "type": "serial_number",
                "value": "Serial Number"
            },
            {
                "type": "store_number",
                "value": "Store Number"
            },
            {
                "type": "transaction_reference_number",
                "value": "Transaction Reference Number"
            },
            {
                "type": "barcode",
                "value": "Return Label"
            }
        ],
        "label_size": "4X6",
        "special_services": [
            "alternate_delivery_address"
        ]
    }
}
url = "https://api.zenkraft.com/rate"

response = requests.request(url=url, method='POST', json=payload, headers=headers)

print(response.json())
            
                
            
  1. {
  2.   "rates": [
  3.     {
  4.       "currency": "USD",
  5.       "service_name": "Express",
  6.       "service_type": "ups_next_day_air",
  7.       "total_cost": "192.16",
  8.       "estimated_date": "2025-03-31",
  9.       "delivery_day": "Mon",
  10.       "transit_days": 3
  11.     }
  12.   ]
  13. }

/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 ups
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 es_MX fr_RE si_LK es_BO so_SO vun_TZ es_VE ha_Latn_GH kde_TZ es_UY mer_KE ti_ET en_IL mfe_MU es_GT uz_Latn_UZ luo_KE en_ZW ee_TG uz_Latn et_EE sr_Latn_RS pt_PT kab_DZ nl_BE fr_SN teo_KE uz_Cyrl bo_CN mas_TZ be_BY jmc_TZ en_BZ en_CA zh_Hans_CN fr_BI km_KH uk_UA ar_LB en_US so_DJ ar_SD th_TH bn_IN kam_KE zh_Hans_HK lg_UG ki_KE sl_SI en_PH pt_MZ es_ES en_NA az_Latn_AZ ii_CN shi_Latn gl_ES gu_IN ar_YE uz_Arab_AF zh_Hant_MO lt_LT fr_MG en_TT fr_DJ ga_IE nb_NO gv_GB uz_Cyrl_UZ en_MH en_PK is_IS seh_MZ es_EC de_LI ses_ML pa_Arab fr_MC lv_LV ps_AF ja_JP es_PR pa_Arab_PK chr_US en_UM sr_Cyrl_BA af_ZA ne_IN my_MM fi_FI en_SG pa_Guru ru_UA fr_KM az_Cyrl_AZ ro_MD fr_CD tzm_Latn fr_CF sr_Cyrl ar_SA rw_RW sr_Latn_BA asa_TZ yue_Hant_HK zh_Hant fr_CH ff_SN ar_SY en_GU de_CH el_CY ha_Latn_NG ko_KR gsw_CH ar_TN fr_MF kn_IN bez_TZ naq_NA te_IN ebu_KE cgg_UG ru_MD ar_QA bm_ML es_PE es_HN en_BE fa_IR so_ET ar_LY guz_KE bn_BD ar_AE es_CL es_GQ fr_TG ee_GH kl_GL hi_IN it_CH sr_Cyrl_RS fr_CA sv_SE ne_NP en_ZA es_419 fa_AF pl_PL en_AS luy_KE mk_MK pa_Guru_IN ar_MA zh_Hant_TW fr_GQ en_JM ti_ER es_DO sw_KE yo_NG fr_BL zh_Hans_MO bo_IN sr_Latn_ME ro_RO ms_MY en_NZ fr_MQ fr_GN fil_PH fr_BE kk_Cyrl mg_MG fo_FO mas_KE nn_NO pt_GW vi_VN zh_Hans_SG as_IN rof_TZ es_AR fr_TD shi_Tfng_MA el_GR da_DK de_BE fr_BJ ak_GH fr_GA fr_LU kk_Cyrl_KZ sk_SK tr_TR en_BW ta_IN ar_DZ cs_CZ kok_IN lag_TZ rwk_TZ fr_CI nyn_UG es_NI es_PY ar_KW am_ET en_MT en_VI ig_NG ar_BH kea_CV es_PA teo_UG haw_US sq_AL sv_FI ur_PK it_IT ar_EG fr_RW af_NA mr_IN ru_RU so_KE fr_GP fr_CM kw_GB dav_KE ta_LK en_GB es_SV hu_HU de_AT de_LU pt_BR az_Latn tzm_Latn_MA zh_Hans zh_Hant_HK en_IE en_MP fr_BF sr_Cyrl_ME es_CO ur_IN xog_UG cy_GB uz_Arab id_ID az_Cyrl bs_BA ms_BN en_HK es_CR hr_HR fr_CG hy_AM he_IL en_IN kln_KE ka_GE ha_Latn de_DE sw_TZ mt_MT or_IN rm_CH sr_Latn shi_Tfng om_ET om_KE sg_CF eu_ES bg_BG fr_FR shi_Latn_MA nd_ZW ar_IQ en_MU ha_Latn_NE ml_IN to_TO en_AU ar_JO bem_ZM fr_NE sn_ZW zu_ZA ca_ES fr_ML ar_OM es_US saq_KE khq_ML nl_NL 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 ups
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 es_MX fr_RE si_LK es_BO so_SO vun_TZ es_VE ha_Latn_GH kde_TZ es_UY mer_KE ti_ET en_IL mfe_MU es_GT uz_Latn_UZ luo_KE en_ZW ee_TG uz_Latn et_EE sr_Latn_RS pt_PT kab_DZ nl_BE fr_SN teo_KE uz_Cyrl bo_CN mas_TZ be_BY jmc_TZ en_BZ en_CA zh_Hans_CN fr_BI km_KH uk_UA ar_LB en_US so_DJ ar_SD th_TH bn_IN kam_KE zh_Hans_HK lg_UG ki_KE sl_SI en_PH pt_MZ es_ES en_NA az_Latn_AZ ii_CN shi_Latn gl_ES gu_IN ar_YE uz_Arab_AF zh_Hant_MO lt_LT fr_MG en_TT fr_DJ ga_IE gv_GB nb_NO uz_Cyrl_UZ sr_Cyrl_BA en_MH en_PK is_IS seh_MZ es_EC de_LI ses_ML pa_Arab fr_MC lv_LV ps_AF ja_JP es_PR pa_Arab_PK chr_US en_UM af_ZA ne_IN my_MM fi_FI en_SG pa_Guru ru_UA fr_KM az_Cyrl_AZ ro_MD fr_CD tzm_Latn fr_CF sr_Cyrl ar_SA rw_RW sr_Latn_BA asa_TZ yue_Hant_HK zh_Hant fr_CH ff_SN ar_SY en_GU de_CH el_CY ha_Latn_NG ko_KR gsw_CH ar_TN fr_MF kn_IN bez_TZ naq_NA te_IN ebu_KE cgg_UG ru_MD ar_QA bm_ML es_PE es_HN en_BE fa_IR so_ET ar_LY guz_KE bn_BD ar_AE es_CL es_GQ fr_TG ee_GH kl_GL hi_IN it_CH sr_Cyrl_RS fr_CA sv_SE ne_NP en_ZA es_419 fa_AF pl_PL en_AS luy_KE mk_MK pa_Guru_IN ar_MA zh_Hant_TW fr_GQ en_JM ti_ER es_DO sw_KE yo_NG fr_BL zh_Hans_MO bo_IN sr_Latn_ME ro_RO ms_MY en_NZ fr_MQ fr_GN fil_PH fr_BE kk_Cyrl mg_MG fo_FO mas_KE nn_NO pt_GW vi_VN zh_Hans_SG as_IN rof_TZ es_AR fr_TD shi_Tfng_MA el_GR da_DK de_BE fr_BJ ak_GH fr_GA fr_LU kk_Cyrl_KZ sk_SK tr_TR en_BW ta_IN ar_DZ cs_CZ kok_IN lag_TZ rwk_TZ fr_CI nyn_UG es_NI es_PY ar_KW am_ET en_MT en_VI ig_NG ar_BH kea_CV es_PA teo_UG haw_US sq_AL sv_FI ur_PK it_IT ar_EG fr_RW af_NA mr_IN ru_RU so_KE fr_GP fr_CM kw_GB dav_KE ta_LK en_GB es_SV hu_HU de_AT de_LU pt_BR az_Latn tzm_Latn_MA zh_Hans zh_Hant_HK en_IE en_MP fr_BF sr_Cyrl_ME es_CO ur_IN xog_UG cy_GB uz_Arab id_ID az_Cyrl bs_BA ms_BN en_HK es_CR hr_HR fr_CG hy_AM he_IL en_IN kln_KE ka_GE ha_Latn de_DE sw_TZ mt_MT or_IN rm_CH sr_Latn shi_Tfng om_ET om_KE sg_CF eu_ES bg_BG fr_FR shi_Latn_MA nd_ZW ar_IQ en_MU ha_Latn_NE ml_IN to_TO en_AU ar_JO bem_ZM fr_NE sn_ZW zu_ZA ca_ES fr_ML ar_OM es_US saq_KE khq_ML nl_NL 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 unexpected_exception schema_validation_error carrier_no_shipment_found schema_field_required carrier_authentication carrier_failed_connection carrier_throttling carrier_unsupported_method carrier_exception shipping_account_wrong_carrier carrier_http_exception missing_api_key shipping_account_not_found wrong_api_key carrier_timeout 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

UPS supports returning tracking responses in a number of languages:

Name API value
Bulgarian bg_BG
Czech cs_CZ
Danish da_DK
German de_DE
Greek el_GR
English (United Kingdom) en_GB
English (United States) en_US
Spanish es_ES
Estonian et_EE
Finnish fi_FI
French fr_FR
Hebrew he_IL
Hungarian hu_HU
Italian it_IT
Japanese ja_JP
Korean ko_KR
Lithuanian lt_LT
Latvian lv_LV
Dutch nl_NL
Norwegian no_NO
Polish pl_PL
Portuguese pt_PT
Romanian ro_RO
Russian ru_RU
Slovak sk_SK
Swedish sv_SE
Turkish tr_TR
Vietnamese vi_VN
Chinese zh_CN
Show more
Example Request / Response
  1. {
  2.     "track": {
  3.       "test":false,
  4.       "carrier": "ups",
  5.       "shipping_account": 00000000000000,
  6.       "tracking_number": "1Z7881280399212000"
  7.     }
  8. }
                curl --request POST \
--url https://api.zenkraft.com/track \
--header 'content-type: application/json' \
--header 'zkkey: XXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
    "track": {
      "test":false,
      "carrier": "ups",
      "shipping_account": 00000000000000,
      "tracking_number": "1Z7881280399212000"
    }
}'
            

import requests

headers = {
"zkkey": "XXXXXXXXXXXXXXXXXXXXXXX"
}

payload = {
    "track": {
      "test":false,
      "carrier": "ups",
      "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())
            
                
            
  1. {
  2.   "carrier": "ups",
  3.   "delivered": true,
  4.   "estimated_delivery": "2021-06-07T00:00:00.000Z",
  5.   "delivery_date": "2021-06-07T00:00:00.000Z",
  6.   "tracking_number": "567293923024",
  7.   "status": "Delivered to a mailbox",
  8.   "tracking_stage": "DELIVERED",
  9.   "checkpoints": [
  10.     {
  11.       "description": "Delivered to a mailbox",
  12.       "status": "Delivered to a mailbox",
  13.       "tracking_stage": "DELIVERED",
  14.       "time": "2021-06-07T10:46:07.000+1000"
  15.     }
  16.   ]
  17. }

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
  1. [
  2.   {
  3.     "track": {
  4.       "test":false,
  5.       "carrier": "ups",
  6.       "shipping_account": 00000000000000,
  7.       "tracking_number": "1Z7881280399212000"
  8.     }
  9.   },
  10.   {
  11.     "track": {
  12.       "test":false,
  13.       "carrier": "ups",
  14.       "shipping_account": 00000000000000,
  15.       "tracking_number": "1Z7881280399212000"
  16.     }
  17.   }
  18. ]
                curl --request POST \
--url https://api.zenkraft.com/track \
--header 'content-type: application/json' \
--header 'zkkey: XXXXXXXXXXXXXXXXXXXXXXX' \
--data '[
  {
    "track": {
      "test":false,
      "carrier": "ups",
      "shipping_account": 00000000000000,
      "tracking_number": "1Z7881280399212000"
    }
  },
  {
    "track": {
      "test":false,
      "carrier": "ups",
      "shipping_account": 00000000000000,
      "tracking_number": "1Z7881280399212000"
    }
  }
]'
            

import requests

headers = {
"zkkey": "XXXXXXXXXXXXXXXXXXXXXXX"
}

payload = [
  {
    "track": {
      "test":false,
      "carrier": "ups",
      "shipping_account": 00000000000000,
      "tracking_number": "1Z7881280399212000"
    }
  },
  {
    "track": {
      "test":false,
      "carrier": "ups",
      "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())
            
                
            
  1. [
  2.   {
  3.     "carrier": "ups",
  4.     "delivered": true,
  5.     "estimated_delivery": "2021-06-07T00:00:00.000Z",
  6.     "delivery_date": "2021-06-07T00:00:00.000Z",
  7.     "tracking_number": "567293923024",
  8.     "status": "Delivered to a mailbox",
  9.     "tracking_stage": "DELIVERED",
  10.     "checkpoints": [
  11.       {
  12.         "description": "Delivered to a mailbox",
  13.         "status": "Delivered to a mailbox",
  14.         "tracking_stage": "DELIVERED",
  15.         "time": "2021-06-07T10:46:07.000+1000"
  16.       }
  17.     ]
  18.   },
  19.   {
  20.     "carrier": "ups",
  21.     "delivered": true,
  22.     "estimated_delivery": "2021-06-07T00:00:00.000Z",
  23.     "delivery_date": "2021-06-07T00:00:00.000Z",
  24.     "tracking_number": "567293923024",
  25.     "status": "Delivered to a mailbox",
  26.     "tracking_stage": "DELIVERED",
  27.     "checkpoints": [
  28.       {
  29.         "description": "Delivered to a mailbox",
  30.         "status": "Delivered to a mailbox",
  31.         "tracking_stage": "DELIVERED",
  32.         "time": "2021-06-07T10:46:07.000+1000"
  33.       }
  34.     ]
  35.   }
  36. ]

/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 ups
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 es_MX si_LK fr_RE es_BO so_SO vun_TZ es_VE ha_Latn_GH kde_TZ es_UY mer_KE ti_ET en_IL mfe_MU es_GT uz_Latn_UZ luo_KE en_ZW ee_TG uz_Latn et_EE sr_Latn_RS pt_PT kab_DZ nl_BE fr_SN teo_KE uz_Cyrl bo_CN mas_TZ be_BY jmc_TZ en_BZ en_CA zh_Hans_CN fr_BI km_KH uk_UA ar_LB en_US so_DJ ar_SD th_TH bn_IN kam_KE zh_Hans_HK lg_UG ki_KE sl_SI en_PH pt_MZ es_ES en_NA az_Latn_AZ ii_CN shi_Latn gl_ES gu_IN ar_YE uz_Arab_AF zh_Hant_MO lt_LT fr_MG en_TT fr_DJ nb_NO ga_IE gv_GB uz_Cyrl_UZ en_MH en_PK is_IS seh_MZ es_EC de_LI ses_ML pa_Arab fr_MC lv_LV ps_AF ja_JP es_PR pa_Arab_PK chr_US en_UM sr_Cyrl_BA af_ZA ne_IN my_MM fi_FI en_SG pa_Guru ru_UA fr_KM az_Cyrl_AZ ro_MD fr_CD tzm_Latn fr_CF sr_Cyrl ar_SA rw_RW sr_Latn_BA asa_TZ yue_Hant_HK zh_Hant fr_CH ff_SN ar_SY en_GU de_CH el_CY ha_Latn_NG ko_KR gsw_CH ar_TN fr_MF kn_IN bez_TZ naq_NA te_IN ebu_KE cgg_UG ru_MD ar_QA bm_ML es_PE es_HN en_BE fa_IR so_ET ar_LY guz_KE bn_BD ar_AE es_CL es_GQ fr_TG ee_GH kl_GL hi_IN it_CH sr_Cyrl_RS fr_CA sv_SE ne_NP en_ZA es_419 fa_AF pl_PL en_AS luy_KE mk_MK pa_Guru_IN ar_MA zh_Hant_TW fr_GQ en_JM ti_ER es_DO sw_KE yo_NG fr_BL zh_Hans_MO bo_IN sr_Latn_ME ro_RO ms_MY en_NZ fr_MQ fr_GN fil_PH fr_BE kk_Cyrl mg_MG fo_FO mas_KE nn_NO pt_GW vi_VN zh_Hans_SG as_IN rof_TZ es_AR fr_TD shi_Tfng_MA el_GR da_DK de_BE fr_BJ ak_GH fr_GA fr_LU kk_Cyrl_KZ sk_SK tr_TR en_BW ta_IN ar_DZ cs_CZ kok_IN lag_TZ rwk_TZ fr_CI nyn_UG es_NI es_PY ar_KW am_ET en_MT en_VI ig_NG ar_BH kea_CV es_PA teo_UG haw_US sq_AL sv_FI ur_PK it_IT ar_EG fr_RW af_NA mr_IN ru_RU so_KE fr_GP fr_CM kw_GB dav_KE ta_LK en_GB es_SV hu_HU de_AT de_LU pt_BR az_Latn tzm_Latn_MA zh_Hans zh_Hant_HK en_IE en_MP fr_BF sr_Cyrl_ME es_CO ur_IN xog_UG cy_GB uz_Arab id_ID az_Cyrl bs_BA ms_BN en_HK es_CR hr_HR fr_CG hy_AM he_IL en_IN kln_KE ka_GE ha_Latn de_DE sw_TZ mt_MT or_IN rm_CH sr_Latn shi_Tfng om_ET om_KE sg_CF eu_ES bg_BG fr_FR shi_Latn_MA nl_NL nd_ZW ar_IQ en_MU ha_Latn_NE ml_IN to_TO en_AU ar_JO bem_ZM fr_NE sn_ZW zu_ZA ca_ES ar_OM es_US saq_KE khq_ML fr_ML 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 unexpected_exception schema_validation_error carrier_no_shipment_found schema_field_required carrier_authentication carrier_failed_connection carrier_throttling carrier_unsupported_method carrier_exception shipping_account_wrong_carrier carrier_http_exception missing_api_key shipping_account_not_found wrong_api_key carrier_timeout 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
  1. {
  2.     "cancel": {
  3.         "shipping_account": "00000000000000",
  4.         "carrier": "ups",
  5.         "tracking_number": "1Z168R020399800319"
  6.     }
  7. }
                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())
            
                
            
  1. {
  2.   "success": {
  3.     "message": "The shipment has been canceled successfully"
  4.   }
  5. }

/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 ups
currency string BIF UAH USD HTG AUD MGA PHP JMD JOD KYD DZD KPW MYR DJF INR NPR CUP ILS LRD BSD TTD ZWD ANG CHF FJD MZN KGS GHS KES RSD FKP IDR VUV XAF SPL BND PYG MMK UYU LBP TND MDL ZMW SVC LSL WST KZT SHP THB TVD XOF SOS UGX HRK LAK BBD CNY BYN KMF CDF COP NIO GIP KRW GMD MRU PKR TZS BRL LKR MWK NOK NGN SRD MXN CUC XCD DOP BTN CVE SCR MAD LYD MNT QAR OMR RUB ETB HUF MUR AED EGP AZN DKK GEL NZD PAB CLP SLL TOP AMD XPF YER PGK BOB SYP BMD TRY JEP IQD AOA CAD TWD GTQ KWD ALL HKD BHD AFN SBD TMT RWF NAD SZL SAR JPY TJS BDT ISK SGD IMP BGN AWG VEF PLN PEN HNL IRR STN MKD SEK CRC XDR GYD GNF VND BAM MVR SDG UZS ARS GGP BWP GBP KHR BZD ERN MOP ZAR RON EUR CZK
debug boolean calls with debug=true will be logged
description string
dim_units string Dimension units of the packages, inches or centimeters required IN CM IN
location object required
city string the city of the recipient required Burlington
company string the company name of the recipient Burlington Textiles Corp of America
country string required KM BG BE MO BB PE LU MM RU SY ZW BZ KP AE KZ HU BS CN JE NL AL LC GQ NO DO ES IT AW NZ KG EE GL PN PA AF BI LV MF KR AS SG LY GY EC ST PH GS LI GP KW PW GR BY NR CL BF WF AX BN NU PM CM DM MT MZ FM QA AD CU TV VE GD KE TC SD MC TJ TR CI TK MA ZM JP SR BH LB MV DE EH RE UA CC MW FI WS BO EG GG TZ NA AZ CV LK KI TD MP AQ TG IS LR VA CD GB ML BJ PT JO SE SX VU ER HN MS RS JM RW SH AO VC BD PL VI CA BT CG AI HT KH LA FJ SK IM IL MD KY BQ LS AG AM PG HR BM TF GT GW PF MG IO TN RO TL TO VN UZ FK SC CK CZ NP VG MQ YE GU GF TT SA SS CF DJ MN MY UG FR MU ET PS BR HM SJ MR SV KN IE MK UM GM SL HK LT MH FO BA IN YT BL BW SO US GI NF GN ZA BV AR TW UY SI CR TH CO CY TM CW GE OM NI DK IQ PK SB MX PR ID NC SZ NE PY SN AU AT GA SM ME NG CH CX DZ IR GH 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 KM BG BE MO BB PE LU MM RU SY ZW BZ KP AE KZ HU BS CN JE NL AL LC GQ DO ES IT AW NZ KG EE GL PN PA AF BI LV MF KR AS SG LY GY EC ST PH GS LI GP KW PW GR BY NR CL BF WF AX BN NU PM CM DM MZ MT FM QA AD CU TV VE GD KE TC SD MC TJ TR CI TK MA ZM JP SR BH LB MV DE EH RE UA CC MW FI WS BO EG GG TZ NA AZ CV LK KI TD MP AQ TG IS LR VA CD GB ML BJ PT JO SE SX VU ER HN MS RS JM RW SH AO VC BD PL VI CA BT CG AI HT KH LA FJ SK IM IL MD KY BQ LS AG AM PG HR BM TF GT GW PF MG IO TN RO TL TO VN UZ FK SC CK CZ NP VG MQ YE GU GF TT SA SS CF DJ MN MY UG FR MU ET PS BR HM SJ MR SV KN IE MK UM GM SL HK LT MH FO BA IN YT BL BW SO US GI NF GN ZA GH BV AR TW UY SI CR TH CO CY TM CW GE OM NI DK IQ PK SB MX PR ID NC SZ NE PY SN AU AT GA SM ME NG CH CX DZ IR NO 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 ups_next_day_air ups_second_day_air ups_ground ups_express ups_expedited ups_standard ups_three_day_select ups_next_day_air_saver ups_next_day_air_early ups_express_plus ups_second_day_air_am ups_saver ups_access_point_economy ups_first_class_mail ups_priority_mail ups_expedited_mail_innovations ups_priority_mail_innovations ups_economy_mail_innovations ups_today_standard ups_today_dedicated_courier ups_today_intercity ups_today_express ups_today_express_saver ups_worldwide_economy_ddu ups_worldwide_economy_ddp ups_worldwide_express_freight ups_surepost_lt_1lb ups_surepost standard_flats parcel_select_lightweight_irreg parcel_select bpm_parcels bpm_flats media_mail marketing_parcels ups_next_day_air
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 ups
confirmation_number string reference number of this pickup. It can be used to cancel the pickup if the carrier allows it 123456789
currency string BIF UAH USD HTG MGA AUD PHP JMD JOD KYD DZD KPW MYR DJF INR NPR CUP ILS LRD BSD TTD ZWD ANG CHF FJD MZN KGS GHS KES RSD FKP IDR VUV XAF SPL BND PYG MMK UYU LBP TND MDL ZMW SVC LSL WST KZT SHP THB TVD XOF SOS UGX HRK LAK BBD CNY BYN KMF CDF COP NIO GIP KRW GMD MRU PKR TZS BRL LKR MWK NOK NGN SRD MXN CUC XCD DOP BTN CVE SCR MAD LYD MNT QAR OMR RUB ETB HUF MUR AED EGP AZN DKK GEL NZD PAB CLP SLL TOP AMD XPF YER PGK BOB SYP BMD TRY JEP IQD AOA CAD TWD GTQ KWD ALL HKD BHD AFN SBD TMT RWF NAD SZL SAR JPY TJS BDT ISK SGD IMP BGN AWG VEF PLN PEN HNL IRR STN MKD SEK CRC XDR GYD GNF VND BAM MVR SDG UZS ARS GGP BWP GBP KHR BZD ERN MOP ZAR RON EUR CZK
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 KM BG BE MO BB PE LU MM RU SY ZW BZ KP AE KZ HU BS CN JE NL AL LC GQ DO ES IT AW NZ KG EE GL PN PA AF BI LV MF KR AS SG LY GY EC ST PH GS LI GP KW PW GR BY NR CL BF WF AX BN NU PM CM DM MZ MT FM QA AD CU TV VE GD KE TC SD MC TJ TR CI TK MA ZM JP SR BH LB MV DE EH RE UA CC MW FI WS BO EG GG TZ NA AZ CV LK KI TD MP AQ TG IS LR VA CD GB ML BJ PT JO SE SX VU ER HN MS RS JM RW SH AO VC BD PL VI CA BT CG AI HT KH LA FJ SK IM IL MD KY BQ LS AG AM PG HR BM TF GT GW PF MG IO TN RO TL TO VN UZ FK SC CK CZ NP VG MQ YE GU GF TT SA SS CF DJ MN MY UG FR MU ET PS BR HM SJ MR SV KN IE MK UM GM SL HK LT MH FO BA IN YT BL BW SO US GI NF GN ZA GH BV AR TW UY SI CR TH CO CY TM CW GE OM NI DK IQ PK SB MX PR ID NC SZ NE PY SN AU AT GA SM ME NG CH CX DZ IR NO 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 KM BG BE MO BB PE LU MM RU SY ZW BZ KP AE KZ HU BS CN JE NL AL LC GQ NO DO ES IT AW NZ KG EE GL PN PA AF BI LV MF KR AS SG LY GY EC ST PH GS LI GP KW PW GR BY NR CL BF WF AX BN NU PM CM DM MT MZ FM QA AD CU TV VE GD KE TC SD MC TJ TR CI TK MA ZM JP SR BH LB MV DE EH RE UA CC MW FI WS BO EG GG TZ NA AZ CV LK KI TD MP AQ TG IS LR VA CD GB ML BJ PT JO SE SX VU ER HN MS RS JM RW SH AO VC BD PL VI CA BT CG AI HT KH LA FJ SK IM IL MD KY BQ LS AG AM PG HR BM TF GT GW PF MG IO TN RO TL TO VN UZ FK SC CK CZ NP VG MQ YE GU GF TT SA SS CF DJ MN MY UG FR MU ET PS BR HM SJ MR SV KN IE MK UM GM SL HK LT MH FO BA IN YT BL BW SO US GI NF GN ZA BV AR TW UY SI CR TH CO CY TM CW GE OM NI DK IQ PK SB MX PR ID NC SZ NE PY SN AU AT GA SM ME NG CH CX DZ IR GH 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 ups_next_day_air ups_second_day_air ups_ground ups_express ups_expedited ups_standard ups_three_day_select ups_next_day_air_saver ups_next_day_air_early ups_express_plus ups_second_day_air_am ups_saver ups_access_point_economy ups_first_class_mail ups_priority_mail ups_expedited_mail_innovations ups_priority_mail_innovations ups_economy_mail_innovations ups_today_standard ups_today_dedicated_courier ups_today_intercity ups_today_express ups_today_express_saver ups_worldwide_economy_ddu ups_worldwide_economy_ddp ups_worldwide_express_freight ups_surepost_lt_1lb ups_surepost standard_flats parcel_select_lightweight_irreg parcel_select bpm_parcels bpm_flats media_mail marketing_parcels ups_next_day_air
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 unexpected_exception schema_validation_error schema_field_required ship_date_past carrier_authentication carrier_failed_connection carrier_throttling carrier_unsupported_method invalid_phone_number carrier_exception shipping_account_wrong_carrier carrier_http_exception missing_api_key shipping_account_not_found wrong_api_key carrier_timeout 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
  1. {
  2.     "pickup": {
  3.         "carrier": "ups",
  4.         "debug": true,
  5.         "dim_units": "IN",
  6.         "location": {
  7.             "city": "San Francisco",
  8.             "company": "Test Company",
  9.             "country": "US",
  10.             "email": "test@example.com",
  11.             "location_type": "business",
  12.             "name": "Test Name",
  13.             "phone": "+1 201-333-4444",
  14.             "postal_code": "94105",
  15.             "state": "NJ",
  16.             "street1": "1 Market Street"
  17.         },
  18.         "shipments": [
  19.             {
  20.                 "packages": [
  21.                     {
  22.                         "quantity": 1,
  23.                         "weight": 3
  24.                     }
  25.                 ],
  26.                 "recipient": {
  27.                     "country": "US"
  28.                 },
  29.                 "service": "express_worldwide_p"
  30.             }
  31.         ],
  32.         "shipping_account": 197299590,
  33.         "test": true,
  34.         "time": {
  35.             "ready_time": "09:45",
  36.             "close_time": "16:45",
  37.             "date": "2021-05-20"
  38.         },
  39.         "weight_units": "LB"
  40.     }
  41. }
                curl --request POST \
--url https://api.zenkraft.com/pickup \
--header 'content-type: application/json' \
--header 'zkkey: XXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
    "pickup": {
        "carrier": "ups",
        "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": "ups",
        "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())
            
                
            
  1. {
  2.   "pickup": {
  3.     "confirmation_number": "123456789",
  4.     "id": "cf8a402288034fd9941dc1efe22b0680",
  5.     "carrier": "ups",
  6.     "shipping_account": "5190163571408896",
  7.     "test": true,
  8.     "debug": false,
  9.     "description": "string",
  10.     "currency": "USD",
  11.     "dim_units": "IN",
  12.     "weight_units": "LB",
  13.     "location": {
  14.       "name": "Jack O'Rogers",
  15.       "company": "Burlington Textiles Corp of America",
  16.       "street1": "525 S. ZENKRAFT Ave",
  17.       "street2": "suite 120",
  18.       "email": "jrogers@example.com",
  19.       "phone": "(336) 222-7000",
  20.       "city": "Burlington",
  21.       "state": "NC",
  22.       "postal_code": "27215",
  23.       "country": "US",
  24.       "location_type": "front"
  25.     },
  26.     "shipments": [
  27.       {
  28.         "recipient": {
  29.           "name": "Jack O'Rogers",
  30.           "company": "Burlington Textiles Corp of America",
  31.           "street1": "525 S. ZENKRAFT Ave",
  32.           "street2": "suite 120",
  33.           "email": "jrogers@example.com",
  34.           "phone": "(336) 222-7000",
  35.           "city": "Burlington",
  36.           "state": "NC",
  37.           "postal_code": "27215",
  38.           "country": "US"
  39.         },
  40.         "packages": [
  41.           {
  42.             "weight": 4.2,
  43.             "value": 25,
  44.             "length": 11,
  45.             "width": 8.5,
  46.             "height": 5
  47.           }
  48.         ],
  49.         "service": "fedex_ground"
  50.       }
  51.     ],
  52.     "time": {
  53.       "close_time": "19:00",
  54.       "ready_time": "12:30",
  55.       "date": "2021-06-07"
  56.     }
  57.   }
  58. }
/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
  1. {
  2.     "cancel": {
  3.         "carrier": "ups",
  4.         "debug": true,
  5.         "dim_units": "IN",
  6.         "location": {
  7.             "city": "San Francisco",
  8.             "company": "Test Company",
  9.             "country": "US",
  10.             "email": "test@example.com",
  11.             "location_type": "business",
  12.             "name": "Test Name",
  13.             "phone": "+1 201-333-4444",
  14.             "postal_code": "94105",
  15.             "state": "NJ",
  16.             "street1": "1 Market Street"
  17.         },
  18.         "shipments": [
  19.             {
  20.                 "packages": [
  21.                     {
  22.                         "quantity": 1,
  23.                         "weight": 3
  24.                     }
  25.                 ],
  26.                 "recipient": {
  27.                     "country": "US"
  28.                 },
  29.                 "service": "express_worldwide_p"
  30.             }
  31.         ],
  32.         "shipping_account": 197299590,
  33.         "test": true,
  34.         "time": {
  35.             "ready_time": "09:45",
  36.             "close_time": "16:45",
  37.             "date": "2021-05-20"
  38.         },
  39.         "weight_units": "LB"
  40.     }
  41. }
                curl --request POST \
--url https://api.zenkraft.com/pickup \
--header 'content-type: application/json' \
--header 'zkkey: XXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
    "cancel": {
        "carrier": "ups",
        "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": "ups",
        "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())
            
                
            
  1. {
  2.     "cancel": {
  3.         "confirmation_number": "123456789",
  4.         "id": "cf8a402288034fd9941dc1efe22b0680",
  5.         "carrier": "ups",
  6.         "shipping_account": "5190163571408896",
  7.         "test": true,
  8.         "debug": false,
  9.     }
  10. }

/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 ups
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 KM BG BE MO BB PE LU MM RU SY ZW BZ KP AE KZ HU BS CN JE NL AL LC GQ DO ES IT AW NZ KG EE GL PN PA AF BI LV MF KR AS SG LY GY EC ST PH GS LI GP KW PW GR BY NR CL BF WF AX BN NU PM CM DM MZ MT FM QA AD CU TV VE GD KE TC SD MC TJ TR CI TK MA ZM JP SR BH LB MV DE EH RE UA CC MW FI WS BO EG GG TZ NA AZ CV LK KI TD MP AQ TG IS LR VA CD GB ML BJ PT JO SE SX VU ER HN MS RS JM RW SH AO VC BD PL VI CA BT CG AI HT KH LA FJ SK IM IL MD KY BQ LS AG AM PG HR BM TF GT GW PF MG IO TN RO TL TO VN UZ FK SC CK CZ NP VG MQ YE GU GF TT SA SS CF DJ MN MY UG FR MU ET PS BR HM SJ MR SV KN IE MK UM GM SL HK LT MH FO BA IN YT BL BW SO US GI NF GN ZA GH BV AR TW UY SI CR TH CO CY TM CW GE OM NI DK IQ PK SB MX PR ID NC SZ NE PY SN AU AT GA SM ME NG CH CX DZ IR NO 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 unexpected_exception schema_validation_error schema_field_required carrier_authentication carrier_failed_connection carrier_throttling carrier_unsupported_method carrier_exception shipping_account_wrong_carrier carrier_http_exception missing_api_key shipping_account_not_found wrong_api_key carrier_timeout 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
  1. {
  2.     "dopu": {
  3.         "carrier": "ups",
  4.         "location": {
  5.             "city": "San Diego",
  6.             "country": "US",
  7.             "postal_code": "92131",
  8.             "state": "CA",
  9.             "street1": "1 Market Street"
  10.         },
  11.         "shipping_account": "673603996",
  12.         "test": true
  13.     }
  14. }
                curl --request POST \
--url https://api.zenkraft.com/dopu \
--header 'content-type: application/json' \
--header 'zkkey: XXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
    "dopu": {
        "carrier": "ups",
        "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": "ups",
        "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())
            
                
            
  1. {
  2.   "locations": [
  3.     {
  4.       "location_type": "post_office",
  5.       "distance": 1.3,
  6.       "distance_units": "km",
  7.       "location_name": "United States Postal Service",
  8.       "location_code": "A4415567",
  9.       "city": "Burlington",
  10.       "street1": "405 Maple Ave",
  11.       "state": "NC",
  12.       "postal_code": "27215",
  13.       "country": "US",
  14.       "lng": "36.089788917096016",
  15.       "lat": "-79.43575121732864"
  16.     }
  17.   ]
  18. }

/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 ups
close_time string Reserved for future use 2021-06-04
currency string BIF UAH USD HTG MGA AUD PHP JMD JOD KYD DZD KPW MYR DJF INR NPR CUP ILS LRD BSD TTD ZWD ANG CHF FJD MZN KGS GHS KES RSD FKP IDR VUV XAF SPL BND PYG MMK UYU LBP TND MDL ZMW SVC LSL WST KZT SHP THB TVD XOF SOS UGX HRK LAK BBD CNY BYN KMF CDF COP NIO GIP KRW GMD MRU PKR TZS BRL LKR MWK NOK NGN SRD MXN CUC XCD DOP BTN CVE SCR MAD LYD MNT QAR OMR RUB ETB HUF MUR AED EGP AZN DKK GEL NZD PAB CLP SLL TOP AMD XPF YER PGK BOB SYP BMD TRY JEP IQD AOA CAD TWD GTQ KWD ALL HKD BHD AFN SBD TMT RWF NAD SZL SAR JPY TJS BDT ISK SGD IMP BGN AWG VEF PLN PEN HNL IRR STN MKD SEK CRC XDR GYD GNF VND BAM MVR SDG UZS ARS GGP BWP GBP KHR BZD ERN MOP ZAR RON EUR CZK
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 KM BG BE MO BB PE LU MM RU SY ZW BZ KP AE KZ HU BS CN JE NL AL LC GQ DO ES IT AW NZ KG EE GL PN PA AF BI LV MF KR AS SG LY GY EC ST PH GS LI GP KW PW GR BY NR CL BF WF AX BN NU PM CM DM MZ MT FM QA AD CU TV VE GD KE TC SD MC TJ TR CI TK MA ZM JP SR BH LB MV DE EH RE UA CC MW FI WS BO EG GG TZ NA AZ CV LK KI TD MP AQ TG IS LR VA CD GB ML BJ PT JO SE SX VU ER HN MS RS JM RW SH AO VC BD PL VI CA BT CG AI HT KH LA FJ SK IM IL MD KY BQ LS AG AM PG HR BM TF GT GW PF MG IO TN RO TL TO VN UZ FK SC CK CZ NP VG MQ YE GU GF TT SA SS CF DJ MN MY UG FR MU ET PS BR HM SJ MR SV KN IE MK UM GM SL HK LT MH FO BA IN YT BL BW SO US GI NF GN ZA GH BV AR TW UY SI CR TH CO CY TM CW GE OM NI DK IQ PK SB MX PR ID NC SZ NE PY SN AU AT GA SM ME NG CH CX DZ IR NO 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 KM BG BE MO BB PE LU MM RU SY ZW BZ KP AE KZ HU BS CN JE NL AL LC GQ NO DO ES IT AW NZ KG EE GL PN PA AF BI LV MF KR AS SG LY GY EC ST PH GS LI GP KW PW GR BY NR CL BF WF AX BN NU PM CM DM MT MZ FM QA AD CU TV VE GD KE TC SD MC TJ TR CI TK MA ZM JP SR BH LB MV DE EH RE UA CC MW FI WS BO EG GG TZ NA AZ CV LK KI TD MP AQ TG IS LR VA CD GB ML BJ PT JO SE SX VU ER HN MS RS JM RW SH AO VC BD PL VI CA BT CG AI HT KH LA FJ SK IM IL MD KY BQ LS AG AM PG HR BM TF GT GW PF MG IO TN RO TL TO VN UZ FK SC CK CZ NP VG MQ YE GU GF TT SA SS CF DJ MN MY UG FR MU ET PS BR HM SJ MR SV KN IE MK UM GM SL HK LT MH FO BA IN YT BL BW SO US GI NF GN ZA BV AR TW UY SI CR TH CO CY TM CW GE OM NI DK IQ PK SB MX PR ID NC SZ NE PY SN AU AT GA SM ME NG CH CX DZ IR GH 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 ups_next_day_air ups_second_day_air ups_ground ups_express ups_expedited ups_standard ups_three_day_select ups_next_day_air_saver ups_next_day_air_early ups_express_plus ups_second_day_air_am ups_saver ups_access_point_economy ups_first_class_mail ups_priority_mail ups_expedited_mail_innovations ups_priority_mail_innovations ups_economy_mail_innovations ups_today_standard ups_today_dedicated_courier ups_today_intercity ups_today_express ups_today_express_saver ups_worldwide_economy_ddu ups_worldwide_economy_ddp ups_worldwide_express_freight ups_surepost_lt_1lb ups_surepost standard_flats parcel_select_lightweight_irreg parcel_select bpm_parcels bpm_flats media_mail marketing_parcels ups_next_day_air
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 ups
dates array
date string Pickup date 2021-06-04
earliest string The earliest time the shipments can be picked up 09:00
latest string The latest time the shipments can be picked up 18:00
debug boolean calls with debug=true will be logged
dim_units string Dimension units of the packages, inches or centimeters IN CM IN
shipping_account string Shipping account number required 5190163571408896
test boolean calls created with test = true will be directed to the carrier test servers
weight_units string Weight units of the packages, pounds or kilograms KG LB LB


Error Response
Field Possible Values Example
error object
code string Standardized error code required unexpected_exception schema_validation_error schema_field_required carrier_authentication carrier_failed_connection carrier_throttling carrier_unsupported_method invalid_phone_number carrier_exception shipping_account_wrong_carrier carrier_http_exception shipping_account_not_found missing_api_key ship_date_past wrong_api_key carrier_timeout 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
  1. {
  2.     "pickup_availability": {
  3.         "carrier": "ups",
  4.         "debug": true,
  5.         "dim_units": "IN",
  6.         "location": {
  7.             "city": "San Francisco",
  8.             "company": "Test Company",
  9.             "country": "US",
  10.             "email": "test@example.com",
  11.             "location_type": "business",
  12.             "name": "Test Name",
  13.             "phone": "+1 201-333-4444",
  14.             "postal_code": "94105",
  15.             "state": "NJ",
  16.             "street1": "1 Market Street"
  17.         },
  18.         "shipments": [
  19.             {
  20.                 "packages": [
  21.                     {
  22.                         "quantity": 1,
  23.                         "weight": 3
  24.                     }
  25.                 ],
  26.                 "service": "ups_next_day_air"
  27.             }
  28.         ],
  29.         "shipping_account": 197299590,
  30.         "test": true,
  31.         "weight_units": "LB",
  32.         "start_date": "2025-03-31",
  33.         "end_date": "2025-03-31"
  34.     }
  35. }
                curl --request POST \
--url https://api.zenkraft.com/pickup/availability \
--header 'content-type: application/json' \
--header 'zkkey: XXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
    "pickup_availability": {
        "carrier": "ups",
        "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": "ups_next_day_air"
            }
        ],
        "shipping_account": 197299590,
        "test": true,
        "weight_units": "LB",
        "start_date": "2025-03-31",
        "end_date": "2025-03-31"
    }
}'
            

import requests

headers = {
"zkkey": "XXXXXXXXXXXXXXXXXXXXXXX"
}

payload = {
    "pickup_availability": {
        "carrier": "ups",
        "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": "ups_next_day_air"
            }
        ],
        "shipping_account": 197299590,
        "test": true,
        "weight_units": "LB",
        "start_date": "2025-03-31",
        "end_date": "2025-03-31"
    }
}
url = "https://api.zenkraft.com/pickup/availability"

response = requests.request(url=url, method='POST', json=payload, headers=headers)

print(response.json())
            
                
            
  1. {
  2.     "pickup_availability": {
  3.         "carrier": "ups",
  4.         "debug": true,
  5.         "dim_units": "IN",
  6.         "location": {
  7.             "city": "San Francisco",
  8.             "company": "Test Company",
  9.             "country": "US",
  10.             "email": "test@example.com",
  11.             "location_type": "business",
  12.             "name": "Test Name",
  13.             "phone": "+1 201-333-4444",
  14.             "postal_code": "94105",
  15.             "state": "NJ",
  16.             "street1": "1 Market Street"
  17.         },
  18.         "shipments": [
  19.             {
  20.                 "packages": [
  21.                     {
  22.                         "quantity": 1,
  23.                         "weight": 3
  24.                     }
  25.                 ],
  26.                 "service": "ups_next_day_air"
  27.             }
  28.         ],
  29.         "shipping_account": 197299590,
  30.         "test": true,
  31.         "weight_units": "LB",
  32.         "start_date": "2025-03-31",
  33.         "end_date": "2025-03-31",
  34.         "dates": [
  35.             {
  36.                 "date" : "2021-06-30",
  37.                 "earliest": "09:00",
  38.                 "latest": "18:00"
  39.             },
  40.             {
  41.                 "date" : "2021-07-01",
  42.                 "earliest": "09:00",
  43.                 "latest": "18:00"
  44.             },
  45.             {
  46.                 "date" : "2021-07-02",
  47.                 "earliest": "09:00",
  48.                 "latest": "15:00"
  49.             }
  50.         ]
  51.     }
  52. }

/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.picked_up return.picked_up return.created shipment.exception return.creation_pending return.checked_in shipment.driver_assigned return.driver_assigned return.exception shipment.checked_in return.shipment_voided return.delivered shipment.out_for_delivery shipment.in_transit shipment.shipment_voided return.out_for_delivery return.in_transit shipment.created shipment.creation_pending shipment.delivered 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.picked_up return.picked_up return.created shipment.exception return.creation_pending return.checked_in shipment.driver_assigned return.driver_assigned return.exception shipment.checked_in return.shipment_voided return.delivered shipment.out_for_delivery shipment.in_transit shipment.shipment_voided return.out_for_delivery return.in_transit shipment.created shipment.creation_pending shipment.delivered 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
  1. {
  2.     "webhook": {
  3.         "name": "Test Webhook",
  4.         "description": "Send delivery notifications",
  5.         "events": ["shipment.out_for_delivery", "shipment.delivered"],
  6.         "callback": "https://webhook.site/f263f99d-e822-4185-9ff8-f56789bc78c6",
  7.         "debug": false,
  8.         "api_version": "v1",
  9.         "format": "json",
  10.         "headers": [
  11.           {
  12.             "name": "Authorization",
  13.             "value": "api_key"
  14.           }
  15.         ],
  16.         "shipping_account_id": 123,
  17.         "trigger_mode": "checkpoint"
  18.     }
  19. }
                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())
            
                
            
  1. {
  2.   "webhook": {
  3.     "name": "Test Webhook",
  4.     "description": "Send delivery notifications",
  5.     "events": ["shipment.out_for_delivery", "shipment.delivered"],
  6.     "callback": "https://webhook.site/f263f99d-e822-4185-9ff8-f56789bc78c6",
  7.     "debug": false,
  8.     "api_version": "v1",
  9.     "format": "json",
  10.     "id": "484fe753dcda47a1b817456f3a10e38e",
  11.     "headers": [
  12.       {
  13.         "name": "Authorization",
  14.         "value": "api_key"
  15.       }
  16.     ],
  17.     "shipping_account_id": 123,
  18.     "trigger_mode": "checkpoint"
  19.   }
  20. }


/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.picked_up return.picked_up return.created shipment.exception return.creation_pending return.checked_in shipment.driver_assigned return.driver_assigned return.exception shipment.checked_in return.shipment_voided return.delivered shipment.out_for_delivery shipment.in_transit shipment.shipment_voided return.out_for_delivery return.in_transit shipment.created shipment.creation_pending shipment.delivered 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
  1. 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())
            
                
            
  1. {
  2.   "webhooks": [
  3.     {
  4.       "name": "Test Webhook",
  5.       "description": "Send delivery notifications",
  6.       "debug": false,
  7.       "api_version": "v1",
  8.       "format": "json",
  9.       "events": [
  10.         "shipment.delivered"
  11.       ],
  12.       "callback": "https://webhook.site/3a788dd3-bd7c-44a8-bae0-297e3b68b508",
  13.       "headers": [
  14.         {
  15.           "name": "Authorization",
  16.           "value": "api_key"
  17.         }
  18.       ],
  19.       "shipping_account_id": 123,
  20.       "trigger_mode": "checkpoint",
  21.       "id": "484fe753dcda47a1b817456f3a10e38e"
  22.     }
  23.   ]
  24. }


/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.picked_up return.picked_up return.created shipment.exception return.creation_pending return.checked_in shipment.driver_assigned return.driver_assigned return.exception shipment.checked_in return.shipment_voided return.delivered shipment.out_for_delivery shipment.in_transit shipment.shipment_voided return.out_for_delivery return.in_transit shipment.created shipment.creation_pending shipment.delivered 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.picked_up return.picked_up return.created shipment.exception return.creation_pending return.checked_in shipment.driver_assigned return.driver_assigned return.exception shipment.checked_in return.shipment_voided return.delivered shipment.out_for_delivery shipment.in_transit shipment.shipment_voided return.out_for_delivery return.in_transit shipment.created shipment.creation_pending shipment.delivered 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 unexpected_exception schema_validation_error schema_field_required webhook_not_found shipping_account_wrong_carrier missing_api_key shipping_account_not_found wrong_api_key
detail string This field can contain additional information about the error. This field is not meant to be shown to the end-user required
message string Error message required No webhook exists with that ID
Example Request / Response
  1. {
  2.     "webhook": {
  3.         "name": "Test Webhook",
  4.         "description": "Send delivery notifications",
  5.         "events": ["shipment.out_for_delivery", "shipment.delivered"],
  6.         "callback": "https://webhook.site/f263f99d-e822-4185-9ff8-f56789bc78c6",
  7.         "debug": false,
  8.         "api_version": "v1",
  9.         "format": "json",
  10.         "headers": [
  11.           {
  12.             "name": "Authorization",
  13.             "value": "api_key"
  14.           }
  15.         ],
  16.         "shipping_account_id": 123,
  17.         "trigger_mode": "checkpoint"
  18.     }
  19. }
                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())
            
                
            
  1. {
  2.   "webhook": {
  3.     "name": "Test Webhook",
  4.     "description": "Send delivery notifications",
  5.     "events": ["shipment.out_for_delivery", "shipment.delivered"],
  6.     "callback": "https://webhook.site/f263f99d-e822-4185-9ff8-f56789bc78c6",
  7.     "debug": false,
  8.     "api_version": "v1",
  9.     "format": "json",
  10.     "id": "484fe753dcda47a1b817456f3a10e38e",
  11.     "headers": [
  12.       {
  13.         "name": "Authorization",
  14.         "value": "api_key"
  15.       }
  16.     ],
  17.     "shipping_account_id": 123,
  18.     "trigger_mode": "checkpoint"
  19.   }
  20. }


/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 unexpected_exception schema_validation_error schema_field_required webhook_not_found shipping_account_wrong_carrier missing_api_key shipping_account_not_found wrong_api_key
detail string This field can contain additional information about the error. This field is not meant to be shown to the end-user required
message string Error message required No webhook exists with that ID
Example Request / Response
  1. 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())
            
                
            
  1. {
  2.   "success": {
  3.     "message": "Success!"
  4.   }
  5. }

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
email 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
email 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
email 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 - -
email 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 - -
email 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
email 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
email 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 - -