Overview

The Zenkraft API is designed to be as standardized across all carriers as possible. The basic structure of each request is the same, with carrier-specific fields typically nested within special services.



OpenAPI 3 Specification

This API is also available in a machine-readable form as a OpenAPI 3 document

  • Basic authentication using a JWT token

  • RESTful using HTTP Verbs

  • JSON requests and responses


Test Tracking Numbers

The tracking numbers can be used below for testing purposes:

  • TEST100000001 - information sent to carrier
  • TEST100000002 - picked up
  • TEST100000003 - in transit
  • TEST100000004 - out for delivery
  • TEST100000005 - delivered
  • TEST100000006 - exception


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.

The following example includes all of the request parameters that Zenkraft supports. To see the required and optional parameters for a specific carrier, select from the Choose Carrier dropdown in the menu.

POST Request Parameters
Field Possible Values Example
shipping_account object required
auth object Carrier credentials which are specific to each carrier {'account_number': 'XXXXXXXX', 'meter_number': 'XXXXXXXX', 'key': 'XXXXXXXXXXXXXXXXXXXXXXXX', 'password': 'XXXXXXXXXXXXXXXXXXXXXXXX'}
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 BH CK NI RS CX SV GA LC FO SG BN IL NU PS OM PA KY GN BR IN SN ME MQ BZ LK TD NZ CA ES DO GE VU AD PK VC CC AU JO JP BQ KM IS JE GH UG CN MF UZ BF ML SY SO IQ NO BD MC MT QA SS MV MW MY MS CY BW FK TV VG PH AL ET HU CI NP TW GW MZ VI BY LY GL AI FM MK CR ZW AX SC DK KN CW AW BM DM CL ZM LT GU RO AO GF GP GT CD CZ LB BV DJ HN LV FJ KR MN SM SR TG CF AM LS AF HT RE HK SB TO SD AR KH GM RU NF WS AQ CU GY MP MG NA MA GD ER IO IR PN ST MO CV HM IT BS TK VE SL GS BI NE UA UY BJ PY KI CM NL TH EG SH PF US LR PM GB HR SK SX LI BL GR NC NG BE GG JM PL MH WF TF MX TZ VA AS YT ZA TL UM SZ AE AG FI MU TJ KZ VN MR DZ IE IM KE TC KW SJ PG BB PE AZ BO ID LA MD TM EE KP PR SE RW BT SA MM TN TT PT AT GI SI CG GQ CH DE YE KG EH LU TR EC CO BG FR PW BA NR US
email string the email address of the recipient jrogers@example.com
name string the name of the recipient required Jack O'Rogers
phone string the phone number of the recipient (336) 222-7000
postal_code string the postal code / zip number of the recipient. Specific format depends on the country 27215
state string the state of the recipient NC
street1 string the first line of the street address of the recipient required 525 S. ZENKRAFT Ave
street2 string the second line of the street address of the recipient suite 120
street3 string the third line of the street address of the recipient suite 120
carrier string Carrier slug required fedex
country string required BH CK CX NI RS SV GA LC FO SG BN ZA IL NU PS OM PA KY GN BR IN SN ME MQ BZ LK TD NZ CA ES DO GE VU AD PK VC CC AU JO JP BQ KM IS JE GH UG CN MF UZ BF ML SY SO IQ NO BD MC MT QA SS MV MW MY MS CY BW FK TV VG PH AL ET HU CI NP TW GW MZ VI BY LY GL AI FM MK CR ZW SC DK KN CW AW BM DM CL ZM LT GU RO AO GF GP GT CD CZ LB BV DJ HN LV FJ KR MN SM SR TG CF AM LS AF HT RE HK SB TO SD AR KH GM RU NF WS AQ CU GY MP MG NA MA GD ER IO IR PN ST MO CV HM IT BS TK VE SL GS BI NE UA UY BJ PY KI CM NL TH EG SH PF US LR PM GB HR SK SX LI BL GR NC NG BE GG JM PL MH WF TF MX TZ VA AS YT TL UM SZ AE AG FI MU TJ KZ VN MR DZ IE IM KE TC KW SJ PG BB PE AZ BO ID LA MD TM EE KP PR NR SE RW BT SA MM TN TT PT AT GI SI CG GQ CH DE YE KG EH LU TR EC CO BG FR PW BA AX US
defaults object
currency string AOA ZMW BIF SDG CHF KYD MWK VEF TTD XCD BHD HKD PLN ANG AFN KZT SEK SYP GGP BBD GNF CRC DKK MDL UAH SPL ZWD VND BYN RWF STN GBP MZN BDT SCR SVC GMD EGP KES AZN MXN HNL XOF PYG PEN KGS SLL UZS MVR JMD HRK BRL OMR PGK UGX CUC DOP EUR FJD ERN MGA NIO QAR TJS BTN LRD SGD MUR SBD TND IDR CVE CNY GYD CZK IQD BGN XAF SHP BND NPR MMK MNT AWG INR LYD MRU KPW THB AMD LAK UYU COP LBP CUP BOB SOS ALL KMF AUD IMP USD MOP TMT RON NOK ISK LSL BSD ZAR TVD RUB RSD PAB ETB ILS KHR HUF GHS TOP SRD YER NAD GIP JEP PHP BMD NGN CDF LKR GEL TZS MYR CAD HTG DZD VUV BAM CLP IRR MAD SAR TWD JOD TRY KRW FKP GTQ DJF KWD XPF BZD XDR PKR WST JPY AED ARS MKD BWP SZL NZD
dim_units string Dimension units of the packages, inches or centimeters CM IN IN
label_type string Label Type PDF
packaging_type string Packaging Type your_packaging
service string Service Type domestic_standard
weight_units string Weight units of the packages, pounds or kilograms KG LB LB
location_id string Location ID 0d349ee54a8c4d0dbc61b1a3ac1ab1f4
name string Account name My FedEx test account
parent_shipping_account string Shipping account key to link this account to. This is useful when you want to create a sub-account
test boolean If you specify test flag and omit `auth` key, we'll try to create a shipping account with our test credentials for the carrier/country combination specified


Successful Response
Field Possible Values Example
shipping_account object
auth object Carrier credentials which are specific to each carrier {'account_number': 'XXXXXXXX', 'meter_number': 'XXXXXXXX', 'key': 'XXXXXXXXXXXXXXXXXXXXXXXX', 'password': 'XXXXXXXXXXXXXXXXXXXXXXXX'}
carrier string Carrier slug required fedex
country string required BH CK CX NI RS SV GA LC FO SG BN ZA IL NU PS OM PA KY GN BR IN SN ME MQ BZ LK TD NZ CA ES DO GE VU AD PK VC CC AU JO JP BQ KM IS JE GH UG CN MF UZ BF ML SY SO IQ NO BD MC MT QA SS MV MW MY MS CY BW FK TV VG PH AL ET HU CI NP TW GW MZ VI BY LY GL AI FM MK CR ZW SC DK KN CW AW BM DM CL ZM LT GU RO AO GF GP GT CD CZ LB BV DJ HN LV FJ KR MN SM SR TG CF AM LS AF HT RE HK SB TO SD AR KH GM RU NF WS AQ CU GY MP MG NA MA GD ER IO IR PN ST MO CV HM IT BS TK VE SL GS BI NE UA UY BJ PY KI CM NL TH EG SH PF US LR PM GB HR SK SX LI BL GR NC NG BE GG JM PL MH WF TF MX TZ VA AS YT TL UM SZ AE AG FI MU TJ KZ VN MR DZ IE IM KE TC KW SJ PG BB PE AZ BO ID LA MD TM EE KP PR NR SE RW BT SA MM TN TT PT AT GI SI CG GQ CH DE YE KG EH LU TR EC CO BG FR PW BA AX US
defaults object required
currency string AOA ZMW BIF SDG CHF KYD MWK VEF TTD XCD BHD HKD PLN ANG AFN KZT SEK SYP GGP BBD GNF CRC DKK MDL UAH SPL ZWD VND BYN RWF STN GBP MZN BDT SCR SVC GMD EGP KES AZN MXN HNL XOF PYG PEN KGS SLL UZS MVR JMD HRK BRL OMR PGK UGX CUC DOP EUR FJD ERN MGA NIO QAR TJS BTN LRD SGD MUR SBD TND IDR CVE CNY GYD CZK IQD BGN XAF SHP BND NPR MMK MNT AWG INR LYD MRU KPW THB AMD LAK UYU COP LBP CUP BOB SOS ALL KMF AUD IMP USD MOP TMT RON NOK ISK LSL BSD ZAR TVD RUB RSD PAB ETB ILS KHR HUF GHS TOP SRD YER NAD GIP JEP PHP BMD NGN CDF LKR GEL TZS MYR CAD HTG DZD VUV BAM CLP IRR MAD SAR TWD JOD TRY KRW FKP GTQ DJF KWD XPF BZD XDR PKR WST JPY AED ARS MKD BWP SZL NZD
dim_units string Dimension units of the packages, inches or centimeters CM IN IN
label_type string Label Type PDF
packaging_type string Packaging Type your_packaging
service string Service Type domestic_standard
weight_units string Weight units of the packages, pounds or kilograms KG LB LB
id string Shipping account number required 5190163571408896
location_id string Location ID 0d349ee54a8c4d0dbc61b1a3ac1ab1f4
name string Account name My FedEx test account
parent_shipping_account string Shipping account key to link this account to. This is useful when you want to create a sub-account
test boolean If you specify test flag and omit `auth` key, we'll try to create a shipping account with our test credentials for the carrier/country combination specified


Error Response
Field Possible Values Example
error object
code string Standardized error code required wrong_api_key shipping_account_not_found unexpected_exception shipping_account_wrong_carrier schema_field_required schema_validation_error master_test_shipping_account_not_found missing_api_key master_test_shipping_account_not_found
detail string This field can contain additional information about the error. This field is not meant to be shown to the end-user required
message object Error message required Master shipping account for fedex in US does not exist
Example Request / Response
  1. {
  2.     "shipping_account": {
  3.         "name": "Test",
  4.         "carrier": "fedex",
  5.         "country": "US",
  6.         "test" : true
  7.     }
  8. }
                curl --request POST \
--url https://api.zenkraft.com/shippingaccount \
--header 'content-type: application/json' \
--header 'zkkey: XXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
    "shipping_account": {
        "name": "Test",
        "carrier": "fedex",
        "country": "US",
        "test" : true
    }
}'
            

import requests

headers = {
"zkkey": "XXXXXXXXXXXXXXXXXXXXXXX"
}

payload = {
    "shipping_account": {
        "name": "Test",
        "carrier": "fedex",
        "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": "fedex",
  5.         "country": "US",
  6.         
  7.         "test": false,
  8.         "id": "567293923024"
  9.     }
  10. }

/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).

The following example includes all of the request parameters that Zenkraft supports. To see the required and optional parameters for a specific carrier, select from the Choose Carrier dropdown in the menu.

POST Request Parameters
Field Possible Values Example
shipment object Definition of the shipment payload required
carrier string the carrier name required fedex
currency string AOA ZMW BIF SDG CHF KYD MWK VEF TTD XCD BHD HKD PLN ANG AFN KZT SEK SYP GGP BBD GNF CRC DKK MDL UAH SPL ZWD VND BYN RWF STN GBP MZN BDT SCR SVC GMD EGP KES AZN MXN HNL XOF PYG PEN KGS SLL UZS MVR JMD HRK BRL OMR PGK UGX CUC DOP EUR FJD ERN MGA NIO QAR TJS BTN LRD SGD MUR SBD TND IDR CVE CNY GYD CZK IQD BGN XAF SHP BND NPR MMK MNT AWG INR LYD MRU KPW THB AMD LAK UYU COP LBP CUP BOB SOS ALL KMF AUD IMP USD MOP TMT RON NOK ISK LSL BSD ZAR TVD RUB RSD PAB ETB ILS KHR HUF GHS TOP SRD YER NAD GIP JEP PHP BMD NGN CDF LKR GEL TZS MYR CAD HTG DZD VUV BAM CLP IRR MAD SAR TWD JOD TRY KRW FKP GTQ DJF KWD XPF BZD XDR PKR WST JPY AED ARS MKD BWP SZL NZD
debug boolean calls with debug=true will be logged
dim_units string Dimension units of the packages, inches or centimeters required CM IN IN
packages array required
height number height of the package according to units specified under dim_units 5
length number length of the package according to units specified under dim_units. ususally the length needs to be the largest of length, width, height 11
value number value of the package according to currency specified 25
weight number weight of the package according to units specified under weight_units 4.2
width number width of the package according to units specified under dim_units 8.5
packaging string the packaging type required your_packaging your_packaging
recipient object required
city string the city of the recipient Burlington
company string the company name of the recipient Burlington Textiles Corp of America
country string required BH CK NI RS CX SV GA LC FO SG BN IL NU PS OM PA KY GN BR IN SN ME MQ BZ LK TD NZ CA ES DO GE VU AD PK VC CC AU JO JP BQ KM IS JE GH UG CN MF UZ BF ML SY SO IQ NO BD MC MT QA SS MV MW MY MS CY BW FK TV VG PH AL ET HU CI NP TW GW MZ VI BY LY GL AI FM MK CR ZW SC DK KN CW AW BM DM CL ZM LT GU RO AO GF GP GT CD CZ LB BV DJ HN LV FJ KR MN SM SR TG CF AM LS AF HT RE HK SB TO SD AR KH GM RU NF WS AQ CU GY MP MG NA MA GD ER IO IR PN ST MO CV HM IT BS TK VE SL GS BI NE UA UY BJ PY KI CM NL TH EG SH PF US LR PM GB HR SK SX LI BL GR NC NG BE GG JM PL MH WF TF MX TZ VA AS YT ZA TL UM SZ AE AG FI MU TJ KZ VN MR DZ IE IM KE TC KW SJ PG BB PE AZ BO ID LA MD TM EE KP PR SE NR RW BT SA MM TN TT PT AT GI SI CG GQ CH DE YE KG EH LU TR EC CO BG FR PW BA AX 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 BH CK NI RS CX SV GA LC FO SG BN IL NU PS OM PA KY GN BR IN SN ME MQ BZ LK TD NZ CA ES DO GE VU AD PK VC CC AU JO JP BQ KM IS JE GH UG CN MF UZ BF ML SY SO IQ NO BD MC MT QA SS MV MW MY MS CY BW FK TV VG PH AL ET HU CI NP TW GW MZ VI BY LY GL AI FM MK CR ZW SC DK KN CW AW BM DM CL ZM LT GU RO AO GF GP GT CD CZ LB BV DJ HN LV FJ KR MN SM SR TG CF AM LS AF HT RE HK SB TO SD AR KH GM RU NF WS AQ CU GY MP MG NA MA GD ER IO IR PN ST MO CV HM IT BS TK VE SL GS BI NE UA UY BJ PY KI CM NL TH EG SH PF US LR PM GB HR SK SX LI BL GR NC NG BE GG JM PL MH WF TF MX TZ VA AS YT ZA TL UM SZ AE AG FI MU TJ KZ VN MR DZ IE IM KE TC KW SJ PG BB PE AZ BO ID LA MD TM EE KP PR SE NR RW BT SA MM TN TT PT AT GI SI CG GQ CH DE YE KG EH LU TR EC CO BG FR PW BA AX US
email string the email address of the recipient jrogers@example.com
name string the name of the recipient Jack O'Rogers
phone string the phone number of the recipient (336) 222-7000
postal_code string the postal code / zip number of the recipient. Specific format depends on the country 27215
state string the state of the recipient NC
street1 string the first line of the street address of the recipient 525 S. ZENKRAFT Ave
street2 string the second line of the street address of the recipient suite 120
street3 string the third line of the street address of the recipient suite 120
service string if you specify the service type, you'll get rates only for this service fedex_ground
ship_date string shipping date 2021-06-07
shipping_account string Shipping account number required 5190163571408896
special_services array [saturday_delivery ]
test boolean calls created with test = true will be directed to the carrier test servers
type string outbound or return shipments return outbound outbound
weight_units string Weight units of the packages, pounds or kilograms required KG LB LB


Successful Response
Field Possible Values Example
rates array
currency string USD AED AFN ALL AMD ANG AOA ARS AUD AWG AZN BAM BBD BDT BGN BHD BIF BMD BND BOB BRL BSD BTN BWP BYN BZD CAD CDF CHF CLP CNY COP CRC CUC CUP CVE CZK DJF DKK DOP DZD EGP ERN ETB EUR FJD FKP GBP GEL GGP GHS GIP GMD GNF GTQ GYD HKD HNL HRK HTG HUF IDR ILS IMP INR IQD IRR ISK JEP JMD JOD JPY KES KGS KHR KMF KPW KRW KWD KYD KZT LAK LBP LKR LRD LSL LYD MAD MDL MGA MKD MMK MNT MOP MRU MUR MVR MWK MXN MYR MZN NAD NGN NIO NOK NPR NZD OMR PAB PEN PGK PHP PKR PLN PYG QAR RON RSD RUB RWF SAR SBD SCR SDG SEK SGD SHP SLL SOS SPL SRD STN SVC SYP SZL THB TJS TMT TND TOP TRY TTD TVD TWD TZS UAH UGX UYU UZS VEF VND VUV WST XAF XCD XDR XOF XPF YER ZAR ZMW ZWD
delivery_day string Day of the week of the delivery. This field is optional depending on the carrier Mon
estimated_date string Number of days to ship. This field is optional depending on the carrier 2021-06-04
service_name string carrier supplied name of this service FedEx Freight
service_type string service slug which can be used when selecting a service in /ship fedex_ground
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 wrong_api_key shipping_account_not_found carrier_timeout carrier_throttling ship_date_past unexpected_exception shipping_account_wrong_carrier carrier_failed_connection carrier_http_exception schema_field_required schema_validation_error missing_api_key carrier_exception carrier_unsupported_method carrier_authentication 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": "fedex",
  4.         "currency": "GBP",
  5.         "debug": true,
  6.         "dim_units": "CM",
  7.         "include_base64_label": true,
  8.         "label_type": "PDF",
  9.         "packages": [
  10.             {
  11.                 "height": 1,
  12.                 "length": 1,
  13.                 "value": 1,
  14.                 "weight": 1,
  15.                 "width": 1
  16.             }
  17.         ],
  18.         "packaging": "your_packaging",
  19.         "recipient": {
  20.             "city": "london",
  21.             "company": "Zenkraft User",
  22.             "country": "GB",
  23.             "email": "testexample@gmail.com",
  24.             "name": "Test User",
  25.             "phone": "01222 555 555",
  26.             "postal_code": "EC1R 4UG",
  27.             "state": "",
  28.             "street1": "1 Hardwick Street"
  29.         },
  30.         "sender": {
  31.             "city": "Bath",
  32.             "company": "TestCompany",
  33.             "country": "GB",
  34.             "email": "uk@testing.com",
  35.             "name": "TestCompany Name",
  36.             "phone": "",
  37.             "postal_code": "EC2R 6PJ",
  38.             "street1": "30 Moorgate"
  39.         },
  40.         "service": "economy",
  41.         "ship_date": "2025-03-27",
  42.         "shipping_account": "811195730",
  43.         "test": true,
  44.         "type": "outbound",
  45.         "weight_units": "KG"
  46.     }
  47. }
                curl --request POST \
--url https://api.zenkraft.com/rate \
--header 'content-type: application/json' \
--header 'zkkey: XXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
    "shipment": {
        "carrier": "fedex",
        "currency": "GBP",
        "debug": true,
        "dim_units": "CM",
        "include_base64_label": true,
        "label_type": "PDF",
        "packages": [
            {
                "height": 1,
                "length": 1,
                "value": 1,
                "weight": 1,
                "width": 1
            }
        ],
        "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": "economy",
        "ship_date": "2025-03-27",
        "shipping_account": "811195730",
        "test": true,
        "type": "outbound",
        "weight_units": "KG"
    }
}'
            

import requests

headers = {
"zkkey": "XXXXXXXXXXXXXXXXXXXXXXX"
}

payload = {
    "shipment": {
        "carrier": "fedex",
        "currency": "GBP",
        "debug": true,
        "dim_units": "CM",
        "include_base64_label": true,
        "label_type": "PDF",
        "packages": [
            {
                "height": 1,
                "length": 1,
                "value": 1,
                "weight": 1,
                "width": 1
            }
        ],
        "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": "economy",
        "ship_date": "2025-03-27",
        "shipping_account": "811195730",
        "test": true,
        "type": "outbound",
        "weight_units": "KG"
    }
}
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": "economy",
  7.       "total_cost": "192.16",
  8.       "estimated_date": "2025-03-27",
  9.       "delivery_day": "Mon",
  10.       "transit_days": 3
  11.     }
  12.   ]
  13. }

/ship POST

The shipping endpoint is used to book shipments with . It will return a shipping label and tracking number in the response.

The following example includes all of the request parameters that Zenkraft supports. To see the required and optional parameters for a specific carrier, select from the Choose Carrier dropdown in the menu.

POST Request Parameters
Field Possible Values Example
shipment object Definition of the shipment payload required
carrier string the carrier name required fedex
currency string AOA ZMW BIF SDG CHF KYD MWK VEF TTD XCD BHD HKD PLN ANG AFN KZT SEK SYP GGP BBD GNF CRC DKK MDL UAH SPL ZWD VND BYN RWF STN GBP MZN BDT SCR SVC GMD EGP KES AZN MXN HNL XOF PYG PEN KGS SLL UZS MVR JMD HRK BRL OMR PGK UGX CUC DOP EUR FJD ERN MGA NIO QAR TJS BTN LRD SGD MUR SBD TND IDR CVE CNY GYD CZK IQD BGN XAF SHP BND NPR MMK MNT AWG INR LYD MRU KPW THB AMD LAK UYU COP LBP CUP BOB SOS ALL KMF AUD IMP USD MOP TMT RON NOK ISK LSL BSD ZAR TVD RUB RSD PAB ETB ILS KHR HUF GHS TOP SRD YER NAD GIP JEP PHP BMD NGN CDF LKR GEL TZS MYR CAD HTG DZD VUV BAM CLP IRR MAD SAR TWD JOD TRY KRW FKP GTQ DJF KWD XPF BZD XDR PKR WST JPY AED ARS MKD BWP SZL NZD
debug boolean calls with debug=true will be logged
dim_units string Dimension units of the packages, inches or centimeters required CM IN IN
documents array
document string document content
document_type string file format of the document pdf
id string uploaded document ID
include_base64_label boolean If this is enabled, base64 label is returned
label_size string the shipping labels size 4x6
label_type string the label format of the shipping labels required PDF JPG PNG ZPL GIF PDF
notifications array
type string type of the notification needed email sms email
value string value of the notification notification1@example.com
packages array required
height number height of the package according to units specified under dim_units 5
length number length of the package according to units specified under dim_units. ususally the length needs to be the largest of length, width, height 11
value number value of the package according to currency specified 25
weight number weight of the package according to units specified under weight_units 4.2
width number width of the package according to units specified under dim_units 8.5
packaging string the packaging type required your_packaging your_packaging
recipient object required
city string the city of the recipient required Burlington
company string the company name of the recipient Burlington Textiles Corp of America
country string required BH CK NI RS CX SV GA LC FO SG BN IL NU PS OM PA KY GN BR IN SN ME MQ BZ LK TD NZ CA ES DO GE VU AD PK VC CC AU JO JP BQ KM IS JE GH UG CN MF UZ BF ML SY SO IQ NO BD MC MT QA SS MV MW MY MS CY BW FK TV VG PH AL ET HU CI NP TW GW MZ VI BY LY GL AI FM MK CR ZW SC DK KN CW AW BM DM CL ZM LT GU RO AO GF GP GT CD CZ LB BV DJ HN LV FJ KR MN SM SR TG CF AM LS AF HT RE HK SB TO SD AR KH GM RU NF WS AQ CU GY MP MG NA MA GD ER IO IR PN ST MO CV HM IT BS TK VE SL GS BI NE UA UY BJ PY KI CM NL TH EG SH PF US LR PM GB HR SK SX LI BL GR NC NG BE GG JM PL MH WF TF MX TZ VA AS YT ZA TL UM SZ AE AG FI MU TJ KZ VN MR DZ IE IM KE TC KW SJ PG BB PE AZ BO ID LA MD TM EE KP PR SE NR RW BT SA MM TN TT PT AT GI SI CG GQ CH DE YE KG EH LU TR EC CO BG FR PW BA AX 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 BH CK NI RS CX SV GA LC FO SG BN IL NU PS OM PA KY GN BR IN SN ME MQ BZ LK TD NZ CA ES DO GE VU AD PK VC CC AU JO JP BQ KM IS JE GH UG CN MF UZ BF ML SY SO IQ NO BD MC MT QA SS MV MW MY MS CY BW FK TV VG PH AL ET HU CI NP TW GW MZ VI BY LY GL AI FM MK CR ZW SC DK KN CW AW BM DM CL ZM LT GU RO AO GF GP GT CD CZ LB BV DJ HN LV FJ KR MN SM SR TG CF AM LS AF HT RE HK SB TO SD AR KH GM RU NF WS AQ CU GY MP MG NA MA GD ER IO IR PN ST MO CV HM IT BS TK VE SL GS BI NE UA UY BJ PY KI CM NL TH EG SH PF US LR PM GB HR SK SX LI BL GR NC NG BE GG JM PL MH WF TF MX TZ VA AS YT ZA TL UM SZ AE AG FI MU TJ KZ VN MR DZ IE IM KE TC KW SJ PG BB PE AZ BO ID LA MD TM EE KP PR SE NR RW BT SA MM TN TT PT AT GI SI CG GQ CH DE YE KG EH LU TR EC CO BG FR PW BA AX US
email string the email address of the recipient jrogers@example.com
name string the name of the recipient required Jack O'Rogers
phone string the phone number of the recipient (336) 222-7000
postal_code string the postal code / zip number of the recipient. Specific format depends on the country 27215
state string the state of the recipient NC
street1 string the first line of the street address of the recipient required 525 S. ZENKRAFT Ave
street2 string the second line of the street address of the recipient suite 120
street3 string the third line of the street address of the recipient suite 120
service string the service type required fedex_ground
ship_date string shipping date 2021-06-07
shipping_account string Shipping account number required 5190163571408896
special_services array [saturday_delivery ]
test boolean calls created with test = true will be directed to the carrier test servers
type string outbound or return shipments return outbound outbound
weight_units string Weight units of the packages, pounds or kilograms required KG LB LB


Successful Response
Most important parts of the response:
  • tracking_number which can be used to track the shipments in the track 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
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
tracking_number string Tracking number of shipment 567293923024


Error Response
Field Possible Values Example
error object
code string Standardized error code required wrong_api_key invalid_phone_number shipping_account_not_found carrier_timeout carrier_throttling carrier_shipment_generation_failed ship_date_past unexpected_exception shipping_account_wrong_carrier carrier_failed_connection carrier_label_generation_failed carrier_http_exception schema_field_required schema_validation_error missing_api_key carrier_exception carrier_unsupported_method carrier_authentication 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": "fedex",
  4.         "currency": "GBP",
  5.         "debug": true,
  6.         "dim_units": "CM",
  7.         "include_base64_label": true,
  8.         "label_type": "PDF",
  9.         "packages": [
  10.             {
  11.                 "height": 1,
  12.                 "length": 1,
  13.                 "value": 1,
  14.                 "weight": 1,
  15.                 "width": 1
  16.             }
  17.         ],
  18.         "packaging": "your_packaging",
  19.         "recipient": {
  20.             "city": "london",
  21.             "company": "Zenkraft User",
  22.             "country": "GB",
  23.             "email": "testexample@gmail.com",
  24.             "name": "Test User",
  25.             "phone": "01222 555 555",
  26.             "postal_code": "EC1R 4UG",
  27.             "state": "",
  28.             "street1": "1 Hardwick Street"
  29.         },
  30.         "sender": {
  31.             "city": "Bath",
  32.             "company": "TestCompany",
  33.             "country": "GB",
  34.             "email": "uk@testing.com",
  35.             "name": "TestCompany Name",
  36.             "phone": "",
  37.             "postal_code": "EC2R 6PJ",
  38.             "street1": "30 Moorgate"
  39.         },
  40.         "service": "economy",
  41.         "ship_date": "2025-03-27",
  42.         "shipping_account": "811195730",
  43.         "test": true,
  44.         "type": "outbound",
  45.         "weight_units": "KG"
  46.     }
  47. }
                curl --request POST \
--url https://api.zenkraft.com/ship \
--header 'content-type: application/json' \
--header 'zkkey: XXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
    "shipment": {
        "carrier": "fedex",
        "currency": "GBP",
        "debug": true,
        "dim_units": "CM",
        "include_base64_label": true,
        "label_type": "PDF",
        "packages": [
            {
                "height": 1,
                "length": 1,
                "value": 1,
                "weight": 1,
                "width": 1
            }
        ],
        "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": "economy",
        "ship_date": "2025-03-27",
        "shipping_account": "811195730",
        "test": true,
        "type": "outbound",
        "weight_units": "KG"
    }
}'
            

import requests

headers = {
"zkkey": "XXXXXXXXXXXXXXXXXXXXXXX"
}

payload = {
    "shipment": {
        "carrier": "fedex",
        "currency": "GBP",
        "debug": true,
        "dim_units": "CM",
        "include_base64_label": true,
        "label_type": "PDF",
        "packages": [
            {
                "height": 1,
                "length": 1,
                "value": 1,
                "weight": 1,
                "width": 1
            }
        ],
        "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": "economy",
        "ship_date": "2025-03-27",
        "shipping_account": "811195730",
        "test": true,
        "type": "outbound",
        "weight_units": "KG"
    }
}
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": "fedex",
  4.     "shipping_account": "5190163571408896",
  5.     "test": true,
  6.     "debug": false,
  7.     "ship_date": "2025-03-27",
  8.     "type": "outbound",
  9.     "service": "economy",
  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 fedex
created string when was this object created 2021-06-02T07:22:43.000
id string shipment ID 1f02d12868a54ed88b6cb4dafaad325d
label string base64 label
label_type string the label format of the shipping labels PDF JPG PNG ZPL GIF PDF
shipping_account string Shipping account number 5190163571408896
status string Standardized shipment status pending success success
tracking_number string Tracking number of shipment 567293923024
updated string when was this object updated 2021-06-02T13:10:02.000


Error Response
Field Possible Values Example
error object
code string Standardized error code required wrong_api_key carrier_no_shipment_found shipping_account_not_found carrier_timeout carrier_throttling unexpected_exception shipping_account_wrong_carrier carrier_failed_connection carrier_label_generation_failed carrier_http_exception schema_field_required schema_validation_error missing_api_key carrier_exception carrier_unsupported_method carrier_authentication 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": "fedex",
  4.     "shipping_account": "5190163571408896",
  5.     "test": true,
  6.     "debug": false,
  7.     "ship_date": "2025-03-27",
  8.     "type": "outbound",
  9.     "service": "economy",
  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. }

/track POST

The track endpoint is used to track shipment status as it's being delivered.

The following example includes all of the request parameters that Zenkraft supports. To see the required and optional parameters for a specific carrier, select from the Choose Carrier dropdown in the menu.

POST Request Parameters
Field Possible Values Example
track object required
carrier string the carrier name required fedex
checkpoints boolean whether to include checkpoint events in the response or not
debug boolean calls with debug=true will be logged
locale string language used in the checkpoint response. Not all carriers support different languages fr_RW uz_Cyrl_UZ fr_MF my_MM lv_LV en_MH kk_Cyrl_KZ en_MU mk_MK mg_MG es_PR ms_BN ta_IN ha_Latn_GH az_Latn ru_RU ar_YE rw_RW ur_IN en_AS sq_AL fr_FR fr_RE de_LI naq_NA ps_AF es_419 gsw_CH bo_CN fa_IR ti_ER sv_SE lag_TZ en_ZW fr_GP en_AU en_MT fi_FI sr_Cyrl_RS ne_IN kl_GL pt_BR pa_Guru kn_IN ar_BH sg_CF hy_AM zh_Hant_MO nn_NO uz_Arab_AF fr_BJ hr_HR ko_KR uz_Latn cgg_UG et_EE ml_IN en_JM es_US az_Cyrl kam_KE es_AR en_NA om_ET ha_Latn_NE ro_MD en_TT sr_Latn_RS gv_GB so_SO bem_ZM zh_Hans fa_AF fr_GA pl_PL tzm_Latn_MA pt_PT fr_BF en_CA mfe_MU he_IL luo_KE nd_ZW bn_IN fr_GN es_MX asa_TZ fil_PH khq_ML el_GR ja_JP es_GT es_PY shi_Latn_MA eu_ES nl_NL zh_Hans_SG nl_BE it_IT en_BW uz_Cyrl es_PA ar_MA teo_KE ar_KW to_TO ar_JO ki_KE sr_Latn_BA saq_KE sr_Cyrl es_PE teo_UG luy_KE ses_ML ga_IE rwk_TZ af_NA en_GB de_LU guz_KE kk_Cyrl hi_IN da_DK lt_LT sr_Cyrl_BA yo_NG kw_GB az_Cyrl_AZ en_PH is_IS nyn_UG haw_US shi_Tfng_MA it_CH kde_TZ ar_IQ de_AT es_BO uk_UA sr_Cyrl_ME fr_ML sk_SK sw_TZ shi_Latn zh_Hant_HK ta_LK dav_KE ti_ET cs_CZ so_DJ chr_US fr_CD fr_DJ fr_GQ el_CY xog_UG de_DE sw_KE fr_CM fr_BE ne_NP rof_TZ ig_NG bez_TZ en_SG pa_Arab_PK pa_Guru_IN vi_VN ar_SY ha_Latn_NG mer_KE pa_Arab gl_ES ar_LB fr_TD pt_GW es_EC ar_SD yue_Hant_HK fr_TG am_ET ee_GH mr_IN zu_ZA en_BE es_VE tzm_Latn fr_BI fr_MQ fr_MG ar_OM sr_Latn_ME en_IN as_IN mas_TZ tr_TR hu_HU ar_LY ca_ES fo_FO de_BE bm_ML bn_BD si_LK zh_Hant seh_MZ es_ES vun_TZ en_ZA ee_TG af_ZA zh_Hans_CN bg_BG es_DO ar_QA ff_SN es_GQ mas_KE de_CH fr_MC uz_Arab zh_Hans_MO en_BZ en_GU kok_IN ru_MD or_IN fr_KM sr_Latn es_HN so_KE th_TH ur_PK fr_SN uz_Latn_UZ fr_CA fr_CH lg_UG ka_GE gu_IN om_KE id_ID es_CL sv_FI en_UM en_NZ sl_SI fr_BL es_SV bo_IN km_KH jmc_TZ en_MP sn_ZW nb_NO so_ET rm_CH kea_CV ru_UA es_CO en_IL en_IE en_VI ar_AE fr_NE fr_CF bs_BA ar_SA zh_Hans_HK ar_EG en_US ms_MY ebu_KE ro_RO es_UY be_BY fr_CG fr_LU es_CR cy_GB es_NI fr_CI mt_MT ar_TN en_HK ii_CN ak_GH az_Latn_AZ te_IN en_PK ar_DZ pt_MZ kab_DZ shi_Tfng zh_Hant_TW kln_KE ha_Latn en_US
refresh boolean whether to force calling live carrier API. By default, we might return a fresh result from the cache
shipping_account string Shipping account number required 5190163571408896
test boolean calls created with test = true will be directed to the carrier test servers
tracking_number string Tracking number of shipment required 567293923024
webhooks boolean whether to allow webhook functionality for this shipment


Successful Response
Field Possible Values Example
carrier string the carrier name fedex
checkpoints array
description string Delivered to a mailbox
status string the most recent important status description Delivered to a mailbox
time string 2021-06-07T10:46:07.000+1000
tracking_stage string the most recent important status standardized shipment stage CREATION_PENDING CREATED PICKED_UP IN_TRANSIT OUT_FOR_DELIVERY DRIVER_ASSIGNED CHECKED_IN DELIVERED SHIPMENT_VOIDED EXCEPTION DELIVERED
delivered boolean whether the shipment was successfully delivered
delivery_date string delivery date of this shipment 2021-06-07T00:00:00.000Z
estimated_delivery string estimated delivery date of this shipment 2021-06-07T00:00:00.000Z
locale string locale used in the checkpoint response. Not all carriers support different languages fr_RW uz_Cyrl_UZ fr_MF my_MM lv_LV en_MH kk_Cyrl_KZ en_MU mk_MK mg_MG es_PR ms_BN ta_IN ha_Latn_GH az_Latn ru_RU ar_YE rw_RW ur_IN en_AS sq_AL fr_FR fr_RE de_LI naq_NA ps_AF es_419 gsw_CH bo_CN fa_IR ti_ER sv_SE lag_TZ en_ZW fr_GP en_AU en_MT fi_FI sr_Cyrl_RS ne_IN kl_GL pt_BR pa_Guru kn_IN ar_BH sg_CF hy_AM zh_Hant_MO nn_NO uz_Arab_AF fr_BJ hr_HR ko_KR uz_Latn cgg_UG et_EE ml_IN en_JM es_US az_Cyrl kam_KE es_AR bo_IN en_NA om_ET ha_Latn_NE ro_MD en_TT sr_Latn_RS gv_GB so_SO bem_ZM zh_Hans fa_AF fr_GA pl_PL tzm_Latn_MA pt_PT fr_BF en_CA mfe_MU he_IL luo_KE nd_ZW bn_IN fr_GN es_MX asa_TZ fil_PH khq_ML el_GR ja_JP es_GT es_PY shi_Latn_MA eu_ES nl_NL zh_Hans_SG nl_BE it_IT es_SV en_BW uz_Cyrl es_PA ar_MA teo_KE ar_KW to_TO ar_JO ki_KE sr_Latn_BA saq_KE sr_Cyrl es_PE teo_UG luy_KE ses_ML ga_IE rwk_TZ af_NA en_GB de_LU guz_KE kk_Cyrl hi_IN da_DK lt_LT sr_Cyrl_BA yo_NG kw_GB az_Cyrl_AZ en_PH is_IS nyn_UG haw_US shi_Tfng_MA it_CH kde_TZ ar_IQ de_AT es_BO uk_UA sr_Cyrl_ME fr_ML sk_SK sw_TZ shi_Latn zh_Hant_HK ta_LK dav_KE ti_ET cs_CZ so_DJ chr_US fr_CD fr_DJ fr_GQ el_CY xog_UG de_DE sw_KE fr_CM fr_BE ne_NP rof_TZ ig_NG bez_TZ en_SG pa_Arab_PK pa_Guru_IN vi_VN ar_SY ha_Latn_NG mer_KE pa_Arab gl_ES ar_LB fr_TD pt_GW es_EC ar_SD yue_Hant_HK fr_TG am_ET ee_GH mr_IN zu_ZA en_BE es_VE tzm_Latn fr_BI fr_MQ fr_MG ar_OM sr_Latn_ME en_IN as_IN mas_TZ tr_TR hu_HU ar_LY ca_ES fo_FO de_BE bm_ML bn_BD si_LK zh_Hant seh_MZ es_ES vun_TZ en_ZA ee_TG af_ZA zh_Hans_CN bg_BG es_DO ar_QA ff_SN es_GQ mas_KE de_CH fr_MC uz_Arab zh_Hans_MO en_BZ en_GU kok_IN ru_MD or_IN fr_KM sr_Latn es_HN so_KE th_TH ur_PK fr_SN uz_Latn_UZ fr_CA fr_CH lg_UG ka_GE gu_IN om_KE id_ID es_CL sv_FI en_UM en_NZ sl_SI fr_BL km_KH jmc_TZ en_MP sn_ZW nb_NO so_ET rm_CH kea_CV ru_UA es_CO en_IL en_IE en_VI ar_AE fr_NE fr_CF bs_BA ar_SA zh_Hans_HK ar_EG en_US ms_MY ebu_KE ro_RO es_UY be_BY fr_CG fr_LU es_CR cy_GB es_NI fr_CI mt_MT ar_TN en_HK ii_CN ak_GH az_Latn_AZ te_IN en_PK ar_DZ pt_MZ kab_DZ shi_Tfng zh_Hant_TW kln_KE ha_Latn 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 wrong_api_key carrier_no_shipment_found shipping_account_not_found carrier_timeout carrier_throttling unexpected_exception shipping_account_wrong_carrier carrier_failed_connection carrier_http_exception schema_field_required schema_validation_error missing_api_key carrier_exception carrier_unsupported_method carrier_authentication 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.     "track": {
  3.       "test":false,
  4.       "carrier": "fedex",
  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": "fedex",
      "shipping_account": 00000000000000,
      "tracking_number": "1Z7881280399212000"
    }
}'
            

import requests

headers = {
"zkkey": "XXXXXXXXXXXXXXXXXXXXXXX"
}

payload = {
    "track": {
      "test":false,
      "carrier": "fedex",
      "shipping_account": 00000000000000,
      "tracking_number": "1Z7881280399212000"
    }
}
url = "https://api.zenkraft.com/track"

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

print(response.json())
            
                
            
  1. {
  2.   "carrier": "fedex",
  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": "fedex",
  6.       "shipping_account": 00000000000000,
  7.       "tracking_number": "1Z7881280399212000"
  8.     }
  9.   },
  10.   {
  11.     "track": {
  12.       "test":false,
  13.       "carrier": "fedex",
  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": "fedex",
      "shipping_account": 00000000000000,
      "tracking_number": "1Z7881280399212000"
    }
  },
  {
    "track": {
      "test":false,
      "carrier": "fedex",
      "shipping_account": 00000000000000,
      "tracking_number": "1Z7881280399212000"
    }
  }
]'
            

import requests

headers = {
"zkkey": "XXXXXXXXXXXXXXXXXXXXXXX"
}

payload = [
  {
    "track": {
      "test":false,
      "carrier": "fedex",
      "shipping_account": 00000000000000,
      "tracking_number": "1Z7881280399212000"
    }
  },
  {
    "track": {
      "test":false,
      "carrier": "fedex",
      "shipping_account": 00000000000000,
      "tracking_number": "1Z7881280399212000"
    }
  }
]
url = "https://api.zenkraft.com/track"

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

print(response.json())
            
                
            
  1. [
  2.   {
  3.     "carrier": "fedex",
  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": "fedex",
  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.

The following example includes all of the request parameters that Zenkraft supports. To see the required and optional parameters for a specific carrier, select from the Choose Carrier dropdown in the menu.

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

Find the time slots between the start_date and the end_date during which the carrier can pick up the specified shipments.

The following example includes all of the request parameters that Zenkraft supports. To see the required and optional parameters for a specific carrier, select from the Choose Carrier dropdown in the menu.

POST Request Parameters
Field Possible Values Example
pickup_availability object required
carrier string the carrier name required fedex
close_time string Reserved for future use 2021-06-04
currency string AOA ZMW BIF SDG CHF KYD MWK VEF TTD XCD BHD HKD PLN ANG AFN KZT SEK SYP GGP BBD GNF CRC DKK MDL UAH SPL ZWD VND BYN RWF STN GBP MZN BDT SCR SVC GMD EGP KES AZN MXN HNL XOF PYG PEN KGS SLL UZS MVR JMD HRK BRL OMR PGK UGX CUC DOP EUR FJD ERN MGA NIO QAR TJS BTN LRD SGD MUR SBD TND IDR CVE CNY GYD CZK IQD BGN XAF SHP BND NPR MMK MNT AWG INR LYD MRU KPW THB AMD LAK UYU COP LBP CUP BOB SOS ALL KMF AUD IMP USD MOP TMT RON NOK ISK LSL BSD ZAR TVD RUB RSD PAB ETB ILS KHR HUF GHS TOP SRD YER NAD GIP JEP PHP BMD NGN CDF LKR GEL TZS MYR CAD HTG DZD VUV BAM CLP IRR MAD SAR TWD JOD TRY KRW FKP GTQ DJF KWD XPF BZD XDR PKR WST JPY AED ARS MKD BWP SZL NZD
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 BH CK NI RS CX SV GA LC FO SG BN IL NU PS OM PA KY GN BR IN SN ME MQ BZ LK TD NZ CA ES DO GE VU AD PK VC CC AU JO JP BQ KM IS JE GH UG CN MF UZ BF ML SY SO IQ NO BD MC MT QA SS MV MW MY MS CY BW FK TV VG PH AL ET HU CI NP TW GW MZ VI BY LY GL AI FM MK CR ZW AX SC DK KN CW AW BM DM CL ZM LT GU RO AO GF GP GT CD CZ LB BV DJ HN LV FJ KR MN SM SR TG CF AM LS AF HT RE HK SB TO SD AR KH GM RU NF WS AQ CU GY MP MG NA MA GD ER IO IR PN ST MO CV HM IT BS TK VE SL GS BI NE UA UY BJ PY KI CM NL TH EG SH PF US LR PM GB HR SK SX LI BL GR NC NG BE GG JM PL MH WF TF MX TZ VA AS YT ZA TL UM SZ AE AG FI MU TJ KZ VN MR DZ IE IM KE TC KW SJ PG BB PE AZ BO ID LA MD TM EE KP PR SE RW BT SA MM TN TT PT AT GI SI CG GQ CH DE YE KG EH LU TR EC CO BG FR PW BA NR 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 BH CK NI RS CX SV GA LC FO SG BN IL NU PS OM PA KY GN BR IN SN ME MQ BZ LK TD NZ CA ES DO GE VU AD PK VC CC AU JO JP BQ KM IS JE GH UG CN MF UZ BF ML SY SO IQ NO BD MC MT QA SS MV MW MY MS CY BW FK TV VG PH AL ET HU CI NP TW GW MZ VI BY LY GL AI FM MK CR ZW SC DK KN CW AW BM DM CL ZM LT GU RO AO GF GP GT CD CZ LB BV DJ HN LV FJ KR MN SM SR TG CF AM LS AF HT RE HK SB TO SD AR KH GM RU NF WS AQ CU GY MP MG NA MA GD ER IO IR PN ST MO CV HM IT BS TK VE SL GS BI NE UA UY BJ PY KI CM NL TH EG SH PF US LR PM GB HR SK SX LI BL GR NC NG BE GG JM PL MH WF TF MX TZ VA AS YT ZA TL UM SZ AE AG FI MU TJ KZ VN MR DZ IE IM KE TC KW SJ PG BB PE AZ BO ID LA MD TM EE KP PR SE NR RW BT SA MM TN TT PT AT GI SI CG GQ CH DE YE KG EH LU TR EC CO BG FR PW BA AX US
email string the email address of the recipient jrogers@example.com
name string the name of the recipient required Jack O'Rogers
phone string the phone number of the recipient (336) 222-7000
postal_code string the postal code / zip number of the recipient. Specific format depends on the country 27215
state string the state of the recipient NC
street1 string the first line of the street address of the recipient required 525 S. ZENKRAFT Ave
street2 string the second line of the street address of the recipient suite 120
street3 string the third line of the street address of the recipient suite 120
service string the service type fedex_ground
shipping_account string Shipping account number required 5190163571408896
start_date string Start of the range of dates to check required 2021-06-04
test boolean calls created with test = true will be directed to the carrier test servers
weight_units string Weight units of the packages, pounds or kilograms required KG LB LB


Successful Response
Field Possible Values Example
pickup_availability object
carrier string the carrier name required fedex
dates array
date string Pickup date 2021-06-04
earliest string The earliest time the shipments can be picked up 09:00
latest string The latest time the shipments can be picked up 18:00
debug boolean calls with debug=true will be logged
dim_units string Dimension units of the packages, inches or centimeters CM IN IN
shipping_account string Shipping account number required 5190163571408896
test boolean calls created with test = true will be directed to the carrier test servers
weight_units string Weight units of the packages, pounds or kilograms KG LB LB


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

import requests

headers = {
"zkkey": "XXXXXXXXXXXXXXXXXXXXXXX"
}

payload = {
    "pickup_availability": {
        "carrier": "fedex",
        "debug": true,
        "dim_units": "IN",
        "location": {
            "city": "San Francisco",
            "company": "Test Company",
            "country": "US",
            "email": "test@example.com",
            "location_type": "business",
            "name": "Test Name",
            "phone": "+1 201-333-4444",
            "postal_code": "94105",
            "state": "NJ",
            "street1": "1 Market Street"
        },
        "shipments": [
            {
                "packages": [
                    {
                        "quantity": 1,
                        "weight": 3
                    }
                ],
                "service": "economy"
            }
        ],
        "shipping_account": 197299590,
        "test": true,
        "weight_units": "LB",
        "start_date": "2025-03-27",
        "end_date": "2025-03-27"
    }
}
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": "fedex",
  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": "economy"
  27.             }
  28.         ],
  29.         "shipping_account": 197299590,
  30.         "test": true,
  31.         "weight_units": "LB",
  32.         "start_date": "2025-03-27",
  33.         "end_date": "2025-03-27",
  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. }

/pickup POST

The pickup endpoint allows you to schedule pickups for one or more shipments.

The following example includes all of the request parameters that Zenkraft supports. To see the required and optional parameters for a specific carrier, select from the Choose Carrier dropdown in the menu.

POST Request Parameters
Field Possible Values Example
pickup object required
carrier string the carrier name required fedex
currency string AOA ZMW BIF SDG CHF KYD MWK VEF TTD XCD BHD HKD PLN ANG AFN KZT SEK SYP GGP BBD GNF CRC DKK MDL UAH SPL ZWD VND BYN RWF STN GBP MZN BDT SCR SVC GMD EGP KES AZN MXN HNL XOF PYG PEN KGS SLL UZS MVR JMD HRK BRL OMR PGK UGX CUC DOP EUR FJD ERN MGA NIO QAR TJS BTN LRD SGD MUR SBD TND IDR CVE CNY GYD CZK IQD BGN XAF SHP BND NPR MMK MNT AWG INR LYD MRU KPW THB AMD LAK UYU COP LBP CUP BOB SOS ALL KMF AUD IMP USD MOP TMT RON NOK ISK LSL BSD ZAR TVD RUB RSD PAB ETB ILS KHR HUF GHS TOP SRD YER NAD GIP JEP PHP BMD NGN CDF LKR GEL TZS MYR CAD HTG DZD VUV BAM CLP IRR MAD SAR TWD JOD TRY KRW FKP GTQ DJF KWD XPF BZD XDR PKR WST JPY AED ARS MKD BWP SZL NZD
debug boolean calls with debug=true will be logged
description string
dim_units string Dimension units of the packages, inches or centimeters required CM IN IN
location object required
city string the city of the recipient required Burlington
company string the company name of the recipient Burlington Textiles Corp of America
country string required BH CK NI RS CX SV GA LC FO SG BN IL NU PS OM PA KY GN BR IN SN ME MQ BZ LK TD NZ CA ES DO GE VU AD PK VC CC AU JO JP BQ KM IS JE GH UG CN MF UZ BF ML SY SO IQ NO BD MC MT QA SS MV MW MY MS CY BW FK TV VG PH AL ET HU CI NP TW GW MZ VI BY LY GL AI FM MK CR ZW SC DK KN CW AW BM DM CL ZM LT GU RO AO GF GP GT CD CZ LB BV DJ HN LV FJ KR MN SM SR TG CF AM LS AF HT RE HK SB TO SD AR KH GM RU NF WS AQ CU GY MP MG NA MA GD ER IO IR PN ST MO CV HM IT BS TK VE SL GS BI NE UA UY BJ PY KI CM NL TH EG SH PF US LR PM GB HR SK SX LI BL GR NC NG BE GG JM PL MH WF TF MX TZ VA AS YT ZA TL UM SZ AE AG FI MU TJ KZ VN MR DZ IE IM KE TC KW SJ PG BB PE AZ BO ID LA MD TM EE KP PR SE NR RW BT SA MM TN TT PT AT GI SI CG GQ CH DE YE KG EH LU TR EC CO BG FR PW BA AX 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 BH CK NI RS CX SV GA LC FO SG BN IL NU PS OM PA KY GN BR IN SN ME MQ BZ LK TD NZ CA ES DO GE VU AD PK VC CC AU JO JP BQ KM IS JE GH UG CN MF UZ BF ML SY SO IQ NO BD MC MT QA SS MV MW MY MS CY BW FK TV VG PH AL ET HU CI NP TW GW MZ VI BY LY GL AI FM MK CR ZW AX SC DK KN CW AW BM DM CL ZM LT GU RO AO GF GP GT CD CZ LB BV DJ HN LV FJ KR MN SM SR TG CF AM LS AF HT RE HK SB TO SD AR KH GM RU NF WS AQ CU GY MP MG NA MA GD ER IO IR PN ST MO CV HM IT BS TK VE SL GS BI NE UA UY BJ PY KI CM NL TH EG SH PF US LR PM GB HR SK SX LI BL GR NC NG BE GG JM PL MH WF TF MX TZ VA AS YT ZA TL UM SZ AE AG FI MU TJ KZ VN MR DZ IE IM KE TC KW SJ PG BB PE AZ BO ID LA MD TM EE KP PR SE RW BT SA MM TN TT PT AT GI SI CG GQ CH DE YE KG EH LU TR EC CO BG FR PW BA NR US
email string the email address of the recipient jrogers@example.com
name string the name of the recipient required Jack O'Rogers
phone string the phone number of the recipient (336) 222-7000
postal_code string the postal code / zip number of the recipient. Specific format depends on the country 27215
state string the state of the recipient NC
street1 string the first line of the street address of the recipient required 525 S. ZENKRAFT Ave
street2 string the second line of the street address of the recipient suite 120
street3 string the third line of the street address of the recipient suite 120
service string the service type fedex_ground
shipping_account string Shipping account number required 5190163571408896
test boolean calls created with test = true will be directed to the carrier test servers
time object the date and time you want to create the pickup for. required
close_time string end of pickup time required 19:00
date string the date you want to create pickup for. required 2021-06-07
ready_time string start of pickup time required 12:30
weight_units string Weight units of the packages, pounds or kilograms required KG LB LB


Successful Response
Field Possible Values Example
pickup object
carrier string the carrier name required fedex
confirmation_number string reference number of this pickup. It can be used to cancel the pickup if the carrier allows it 123456789
currency string AOA ZMW BIF SDG CHF KYD MWK VEF TTD XCD BHD HKD PLN ANG AFN KZT SEK SYP GGP BBD GNF CRC DKK MDL UAH SPL ZWD VND BYN RWF STN GBP MZN BDT SCR SVC GMD EGP KES AZN MXN HNL XOF PYG PEN KGS SLL UZS MVR JMD HRK BRL OMR PGK UGX CUC DOP EUR FJD ERN MGA NIO QAR TJS BTN LRD SGD MUR SBD TND IDR CVE CNY GYD CZK IQD BGN XAF SHP BND NPR MMK MNT AWG INR LYD MRU KPW THB AMD LAK UYU COP LBP CUP BOB SOS ALL KMF AUD IMP USD MOP TMT RON NOK ISK LSL BSD ZAR TVD RUB RSD PAB ETB ILS KHR HUF GHS TOP SRD YER NAD GIP JEP PHP BMD NGN CDF LKR GEL TZS MYR CAD HTG DZD VUV BAM CLP IRR MAD SAR TWD JOD TRY KRW FKP GTQ DJF KWD XPF BZD XDR PKR WST JPY AED ARS MKD BWP SZL NZD
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 BH CK NI RS CX SV GA LC FO SG BN IL NU PS OM PA KY GN BR IN SN ME MQ BZ LK TD NZ CA ES DO GE VU AD PK VC CC AU JO JP BQ KM IS JE GH UG CN MF UZ BF ML SY SO IQ NO BD MC MT QA SS MV MW MY MS CY BW FK TV VG PH AL ET HU CI NP TW GW MZ VI BY LY GL AI FM MK CR ZW AX SC DK KN CW AW BM DM CL ZM LT GU RO AO GF GP GT CD CZ LB BV DJ HN LV FJ KR MN SM SR TG CF AM LS AF HT RE HK SB TO SD AR KH GM RU NF WS AQ CU GY MP MG NA MA GD ER IO IR PN ST MO CV HM IT BS TK VE SL GS BI NE UA UY BJ PY KI CM NL TH EG SH PF US LR PM GB HR SK SX LI BL GR NC NG BE GG JM PL MH WF TF MX TZ VA AS YT ZA TL UM SZ AE AG FI MU TJ KZ VN MR DZ IE IM KE TC KW SJ PG BB PE AZ BO ID LA MD TM EE KP PR SE RW BT SA MM TN TT PT AT GI SI CG GQ CH DE YE KG EH LU TR EC CO BG FR PW BA NR 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 BH CK NI RS CX SV GA LC FO SG BN IL NU PS OM PA KY GN BR IN SN ME MQ BZ LK TD NZ CA ES DO GE VU AD PK VC CC AU JO JP BQ KM IS JE GH UG CN MF UZ BF ML SY SO IQ NO BD MC MT QA SS MV MW MY MS CY BW FK TV VG PH AL ET HU CI NP TW GW MZ VI BY LY GL AI FM MK CR ZW SC DK KN CW AW BM DM CL ZM LT GU RO AO GF GP GT CD CZ LB BV DJ HN LV FJ KR MN SM SR TG CF AM LS AF HT RE HK SB TO SD AR KH GM RU NF WS AQ CU GY MP MG NA MA GD ER IO IR PN ST MO CV HM IT BS TK VE SL GS BI NE UA UY BJ PY KI CM NL TH EG SH PF US LR PM GB HR SK SX LI BL GR NC NG BE GG JM PL MH WF TF MX TZ VA AS YT ZA TL UM SZ AE AG FI MU TJ KZ VN MR DZ IE IM KE TC KW SJ PG BB PE AZ BO ID LA MD TM EE KP PR SE NR RW BT SA MM TN TT PT AT GI SI CG GQ CH DE YE KG EH LU TR EC CO BG FR PW BA AX US
email string the email address of the recipient jrogers@example.com
name string the name of the recipient required Jack O'Rogers
phone string the phone number of the recipient (336) 222-7000
postal_code string the postal code / zip number of the recipient. Specific format depends on the country 27215
state string the state of the recipient NC
street1 string the first line of the street address of the recipient required 525 S. ZENKRAFT Ave
street2 string the second line of the street address of the recipient suite 120
street3 string the third line of the street address of the recipient suite 120
service string the service type fedex_ground
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 wrong_api_key invalid_phone_number shipping_account_not_found carrier_timeout carrier_throttling ship_date_past unexpected_exception shipping_account_wrong_carrier carrier_failed_connection carrier_http_exception schema_field_required schema_validation_error missing_api_key carrier_exception carrier_unsupported_method carrier_authentication 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": "fedex",
  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": "fedex",
        "debug": true,
        "dim_units": "IN",
        "location": {
            "city": "San Francisco",
            "company": "Test Company",
            "country": "US",
            "email": "test@example.com",
            "location_type": "business",
            "name": "Test Name",
            "phone": "+1 201-333-4444",
            "postal_code": "94105",
            "state": "NJ",
            "street1": "1 Market Street"
        },
        "shipments": [
            {
                "packages": [
                    {
                        "quantity": 1,
                        "weight": 3
                    }
                ],
                "recipient": {
                    "country": "US"
                },
                "service": "express_worldwide_p"
            }
        ],
        "shipping_account": 197299590,
        "test": true,
        "time": {
            "ready_time": "09:45",
            "close_time": "16:45",
            "date": "2021-05-20"
        },
        "weight_units": "LB"
    }
}'
            

import requests

headers = {
"zkkey": "XXXXXXXXXXXXXXXXXXXXXXX"
}

payload = {
    "pickup": {
        "carrier": "fedex",
        "debug": true,
        "dim_units": "IN",
        "location": {
            "city": "San Francisco",
            "company": "Test Company",
            "country": "US",
            "email": "test@example.com",
            "location_type": "business",
            "name": "Test Name",
            "phone": "+1 201-333-4444",
            "postal_code": "94105",
            "state": "NJ",
            "street1": "1 Market Street"
        },
        "shipments": [
            {
                "packages": [
                    {
                        "quantity": 1,
                        "weight": 3
                    }
                ],
                "recipient": {
                    "country": "US"
                },
                "service": "express_worldwide_p"
            }
        ],
        "shipping_account": 197299590,
        "test": true,
        "time": {
            "ready_time": "09:45",
            "close_time": "16:45",
            "date": "2021-05-20"
        },
        "weight_units": "LB"
    }
}
url = "https://api.zenkraft.com/pickup"

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

print(response.json())
            
                
            
  1. {
  2.   "pickup": {
  3.     "confirmation_number": "123456789",
  4.     "id": "cf8a402288034fd9941dc1efe22b0680",
  5.     "carrier": "fedex",
  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. }

/dopu POST

The dopu endpoint is used to retrieve the list of possible drop off locations nearby.

The following example includes all of the request parameters that Zenkraft supports. To see the required and optional parameters for a specific carrier, select from the Choose Carrier dropdown in the menu.

POST Request Parameters
Field Possible Values Example
dopu object required
carrier string the carrier name required fedex
debug boolean calls with debug=true will be logged
location object required
city string the city of the recipient required Burlington
company string the company name of the recipient Burlington Textiles Corp of America
country string required BH CK NI RS CX SV GA LC FO SG BN IL NU PS OM PA KY GN BR IN SN ME MQ BZ LK TD NZ CA ES DO GE VU AD PK VC CC AU JO JP BQ KM IS JE GH UG CN MF UZ BF ML SY SO IQ NO BD MC MT QA SS MV MW MY MS CY BW FK TV VG PH AL ET HU CI NP TW GW MZ VI BY LY GL AI FM MK CR ZW AX SC DK KN CW AW BM DM CL ZM LT GU RO AO GF GP GT CD CZ LB BV DJ HN LV FJ KR MN SM SR TG CF AM LS AF HT RE HK SB TO SD AR KH GM RU NF WS AQ CU GY MP MG NA MA GD ER IO IR PN ST MO CV HM IT BS TK VE SL GS BI NE UA UY BJ PY KI CM NL TH EG SH PF US LR PM GB HR SK SX LI BL GR NC NG BE GG JM PL MH WF TF MX TZ VA AS YT ZA TL UM SZ AE AG FI MU TJ KZ VN MR DZ IE IM KE TC KW SJ PG BB PE AZ BO ID LA MD TM EE KP PR SE RW BT SA MM TN TT PT AT GI SI CG GQ CH DE YE KG EH LU TR EC CO BG FR PW BA NR 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 wrong_api_key shipping_account_not_found carrier_timeout carrier_throttling unexpected_exception shipping_account_wrong_carrier carrier_failed_connection carrier_http_exception schema_field_required schema_validation_error missing_api_key carrier_exception carrier_unsupported_method carrier_authentication 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": "fedex",
  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": "fedex",
        "location": {
            "city": "San Diego",
            "country": "US",
            "postal_code": "92131",
            "state": "CA",
            "street1": "1 Market Street"
        },
        "shipping_account": "673603996",
        "test": true
    }
}'
            

import requests

headers = {
"zkkey": "XXXXXXXXXXXXXXXXXXXXXXX"
}

payload = {
    "dopu": {
        "carrier": "fedex",
        "location": {
            "city": "San Diego",
            "country": "US",
            "postal_code": "92131",
            "state": "CA",
            "street1": "1 Market Street"
        },
        "shipping_account": "673603996",
        "test": true
    }
}
url = "https://api.zenkraft.com/dopu"

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

print(response.json())
            
                
            
  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. }

/manifest POST

Manifesting allows you to notify the carrier that your shipments are ready for shipping/pickup.

The following example includes all of the request parameters that Zenkraft supports. To see the required and optional parameters for a specific carrier, select from the Choose Carrier dropdown in the menu.

POST Request Parameters
Field Possible Values Example
manifest object required
carrier string the carrier name required fedex
debug boolean calls with debug=true will be logged
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
manifest object
costs object Additional information about packages
base_charge number gross amount 100
discounts number the cost of discounts applied
net_charge number net amount 80
surcharges number additional fees
taxes number the cost of taxes 20
id string carrier ID of this manifest which can be used in GET on /manifest/<manifest_id> 963681622636173689
shipping_documents object Additional information about packages
description string description of this customs item required Manifest
document string base64 document contents required
document_type string file format of the document required PDF


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 carrier_large_manifest wrong_api_key shipping_account_not_found carrier_timeout carrier_throttling unexpected_exception shipping_account_wrong_carrier carrier_failed_connection carrier_http_exception schema_field_required schema_validation_error missing_api_key carrier_exception carrier_unsupported_method carrier_authentication carrier_large_manifest
detail string This field can contain additional information about the error. This field is not meant to be shown to the end-user required 963681622636173689
message string Error message required The manifest is too large and it's going to take around 15 to generate. Retry again later please
Example Request / Response
  1. {
  2.     "manifest": {
  3.         "carrier": "fedex",
  4.         "debug": true,
  5.         "shipping_account": 40910738,
  6.         "test": true,
  7.         "tracking_numbers": [
  8.             "33GKB500127801000961509",
  9.             "111JD575508301000961502",
  10.             "111JD575511501000961500"
  11.         ]
  12.     }
  13. }
                curl --request POST \
--url https://api.zenkraft.com/manifest \
--header 'content-type: application/json' \
--header 'zkkey: XXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
    "manifest": {
        "carrier": "fedex",
        "debug": true,
        "shipping_account": 40910738,
        "test": true,
        "tracking_numbers": [
            "33GKB500127801000961509",
            "111JD575508301000961502",
            "111JD575511501000961500"
        ]
    }
}'
            

import requests

headers = {
"zkkey": "XXXXXXXXXXXXXXXXXXXXXXX"
}

payload = {
    "manifest": {
        "carrier": "fedex",
        "debug": true,
        "shipping_account": 40910738,
        "test": true,
        "tracking_numbers": [
            "33GKB500127801000961509",
            "111JD575508301000961502",
            "111JD575511501000961500"
        ]
    }
}
url = "https://api.zenkraft.com/manifest"

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

print(response.json())
            
                
            
  1. {
  2.   "manifest": {
  3.     "id": "963681622636173689",
  4.     "shipping_documents": [{
  5.       "description": "Manifest",
  6.       "document_type": "PDF",
  7.       "document": "string"
  8.     }],
  9.     "costs": {
  10.       "base_charge": 100,
  11.       "net_charge": 80,
  12.       "taxes": 20,
  13.       "surcharges": 0,
  14.       "discounts": 0
  15.     }
  16.   }
  17. }

/manifest GET

This endpoint allows you to retrieve previously created manifests.

Successful Response
Field Possible Values Example
manifests array
carrier string the carrier name fedex
created string when was this object created 2021-06-02T07:22:43.000
id string carrier ID of this manifest which can be used in GET on /manifest/<manifest_id> 963681622636173689
shipping_account string Shipping account number 5190163571408896


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/manifest
                curl --request GET \
--url https://api.zenkraft.com/manifest \
--header 'content-type: application/json' \
--header 'zkkey: XXXXXXXXXXXXXXXXXXXXXXX'
            

import requests

headers = {
"zkkey": "XXXXXXXXXXXXXXXXXXXXXXX"
}

payload = None
url = "https://api.zenkraft.com/manifest"

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

print(response.json())
            
                
            
  1. {
  2.   "manifests": [
  3.     {
  4.       "carrier": "fedex",
  5.       "created": "2021-06-02T07:22:43.000",
  6.       "id": "963681622636173689",
  7.       "shipping_account": "5190163571408896"
  8.     }
  9.   ]
  10. }

/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

The following example includes all of the request parameters that Zenkraft supports. To see the required and optional parameters for a specific carrier, select from the Choose Carrier dropdown in the menu.

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 return.creation_pending shipment.shipment_voided shipment.driver_assigned return.delivered shipment.checked_in shipment.creation_pending shipment.out_for_delivery return.picked_up return.created return.in_transit shipment.in_transit return.shipment_voided return.out_for_delivery shipment.delivered shipment.exception return.driver_assigned return.exception return.checked_in shipment.created shipment.picked_up shipment.delivered
format string Currently only JSON is supported. Used for future compatibility json
headers array Headers that will be sent to the webhook callback.
name string Authorization
value string api_key
name string Webhook name
shipping_account_id integer 123
trigger_mode string stage checkpoint


Successful Response
Field Possible Values Example
webhook object
api_version string The webhook version. Used for future compatibility v1
callback string URL of the receiving endpoint required https://webhook.site/3a788dd3-bd7c-44a8-bae0-297e3b68b508
debug boolean calls with debug=true will be logged
description string Webhook description
events array Events to receive. If left empty, it's assumed you want to receive all the events return.creation_pending shipment.shipment_voided shipment.driver_assigned return.delivered shipment.checked_in shipment.creation_pending shipment.out_for_delivery return.picked_up return.created return.in_transit shipment.in_transit return.shipment_voided return.out_for_delivery shipment.delivered shipment.exception return.driver_assigned return.exception return.checked_in shipment.created shipment.picked_up shipment.delivered
format string Currently only JSON is supported. Used for future compatibility json
headers array Headers that will be sent to the webhook callback.
name string Authorization
value string api_key
id string ID of the subscription 484fe753dcda47a1b817456f3a10e38e
name string Webhook name
shipping_account_id integer 123
trigger_mode string stage checkpoint


Error Response
Field Possible Values Example
error object
code string Standardized error code required missing_api_key wrong_api_key shipping_account_not_found shipping_account_wrong_carrier schema_validation_error schema_field_required unexpected_exception
detail string This field can contain additional information about the error. This field is not meant to be shown to the end-user required
message string Error message required Missing zkkey HTTP header containing your Zenkraft API key
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 return.creation_pending shipment.shipment_voided shipment.driver_assigned return.delivered shipment.checked_in shipment.creation_pending shipment.out_for_delivery return.picked_up return.created return.in_transit shipment.in_transit return.shipment_voided return.out_for_delivery shipment.delivered shipment.exception return.driver_assigned return.exception return.checked_in shipment.created shipment.picked_up shipment.delivered
format string Currently only JSON is supported. Used for future compatibility json
headers array Headers that will be sent to the webhook callback.
name string Authorization
value string api_key
id string ID of the subscription 484fe753dcda47a1b817456f3a10e38e
name string Webhook name
shipping_account_id integer 123
trigger_mode string stage checkpoint


Error Response
Field Possible Values Example
error object
code string Standardized error code required missing_api_key wrong_api_key shipping_account_not_found shipping_account_wrong_carrier schema_validation_error schema_field_required unexpected_exception
detail string This field can contain additional information about the error. This field is not meant to be shown to the end-user required
message string Error message required Missing zkkey HTTP header containing your Zenkraft API key
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 return.creation_pending shipment.shipment_voided shipment.driver_assigned return.delivered shipment.checked_in shipment.creation_pending shipment.out_for_delivery return.picked_up return.created return.in_transit shipment.in_transit return.shipment_voided return.out_for_delivery shipment.delivered shipment.exception return.driver_assigned return.exception return.checked_in shipment.created shipment.picked_up shipment.delivered
format string Currently only JSON is supported. Used for future compatibility json
headers array Headers that will be sent to the webhook callback.
name string Authorization
value string api_key
name string Webhook name
shipping_account_id integer 123
trigger_mode string stage checkpoint


Successful Response
Field Possible Values Example
webhook object
api_version string The webhook version. Used for future compatibility v1
callback string URL of the receiving endpoint required https://webhook.site/3a788dd3-bd7c-44a8-bae0-297e3b68b508
debug boolean calls with debug=true will be logged
description string Webhook description
events array Events to receive. If left empty, it's assumed you want to receive all the events return.creation_pending shipment.shipment_voided shipment.driver_assigned return.delivered shipment.checked_in shipment.creation_pending shipment.out_for_delivery return.picked_up return.created return.in_transit shipment.in_transit return.shipment_voided return.out_for_delivery shipment.delivered shipment.exception return.driver_assigned return.exception return.checked_in shipment.created shipment.picked_up shipment.delivered
format string Currently only JSON is supported. Used for future compatibility json
headers array Headers that will be sent to the webhook callback.
name string Authorization
value string api_key
id string ID of the subscription 484fe753dcda47a1b817456f3a10e38e
name string Webhook name
shipping_account_id integer 123
trigger_mode string stage checkpoint


Error Response
Field Possible Values Example
error object
code string Standardized error code. If the code equals `carrier_large_manifest` you might retrieve manifest_id from the error detail required wrong_api_key shipping_account_not_found unexpected_exception shipping_account_wrong_carrier schema_field_required schema_validation_error missing_api_key webhook_not_found
detail string This field can contain additional information about the error. This field is not meant to be shown to the end-user required
message string Error message required No webhook exists with that ID
Example Request / Response
  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 wrong_api_key shipping_account_not_found unexpected_exception shipping_account_wrong_carrier schema_field_required schema_validation_error missing_api_key webhook_not_found
detail string This field can contain additional information about the error. This field is not meant to be shown to the end-user required
message string Error message required No webhook exists with that ID
Example Request / Response
  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. }

/returns POST

These endpoints allow you to handle shipment returns. You need to have Return Methods set up in your admin interface in order to see the return methods in the response. Once you have the response, you need to identify the return option you want to use (e.g. dropoff at a specific location), and find its id (under return_methods->options->id). This id is sent in the follow up confirm request

The following example includes all of the request parameters that Zenkraft supports. To see the required and optional parameters for a specific carrier, select from the Choose Carrier dropdown in the menu.

POST Request Parameters
Field Possible Values Example
return_methods object required
custom array Custom context attached to the return
name string Name of the custom field refunded
value object The value of the custom field - can be any type of object true
customer_id string 123456
debug boolean
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 BH CK CX NI RS SV GA LC FO SG BN ZA IL NU PS OM PA KY GN BR IN SN ME MQ BZ LK TD NZ CA ES DO GE VU AD PK VC CC AU JO JP BQ KM IS JE GH UG CN MF UZ BF ML SY SO IQ NO BD MC MT QA SS MV MW MY MS CY BW FK TV VG PH AL ET HU CI NP TW GW MZ VI BY LY GL AI FM MK CR ZW SC DK KN CW AW BM DM CL ZM LT GU RO AO GF GP GT CD CZ LB BV DJ HN LV FJ KR MN SM SR TG CF AM LS AF HT RE HK SB TO SD AR KH GM RU NF WS AQ CU GY MP MG NA MA GD ER IO IR PN ST MO CV HM IT BS TK VE SL GS BI NE UA UY BJ PY KI CM NL TH EG SH PF US LR PM GB HR SK SX LI BL GR NC NG BE GG JM PL MH WF TF MX TZ VA AS YT TL UM SZ AE AG FI MU TJ KZ VN MR DZ IE IM KE TC KW SJ PG BB PE AZ BO ID LA MD TM EE KP PR NR SE RW BT SA MM TN TT PT AT GI SI CG GQ CH DE YE KG EH LU TR EC CO BG FR PW BA AX 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
return_lines array required
country_of_manufacture 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
hs_code string 444.333.2222
line_id string LINE-1234567890
product_name string Shoes
quantity integer quantity of this item in the package 1
reasons array
name string size
reasons object
name string required where
value string required toe
value string too_small
sku string SKU-123455666
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
test boolean


Successful Response
Field Possible Values Example
return_lines array
country_of_manufacture 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
hs_code string 444.333.2222
line_id string LINE-1234567890
product_name string Shoes
quantity integer quantity of this item in the package 1
reasons array
name string size
reasons object
name string required where
value string required toe
value string too_small
sku string SKU-123455666
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


Error Response
Example Request / Response
  1. {
  2.   "return_methods": {
  3.     "test": true,
  4.     "debug": true,
  5.     "customer_id": "123456",
  6.     "location": {
  7.       "name": "Jack O'Rogers",
  8.       "company": "Burlington Textiles Corp of America",
  9.       "street1": "525 S. ZENKRAFT Ave",
  10.       "street2": "suite 120",
  11.       "email": "jrogers@example.com",
  12.       "phone": "(336) 222-7000",
  13.       "city": "Burlington",
  14.       "state": "NC",
  15.       "postal_code": "27415",
  16.       "country": "US"
  17.     },
  18.     "references": [
  19.       {
  20.         "type": "customer_reference",
  21.         "value": "ABC-000123"
  22.       }
  23.     ],
  24.     "return_lines": [
  25.       {
  26.         "quantity": 1,
  27.         "value": 25,
  28.         "weight": 4.2,
  29.         "product_name": "Shoes",
  30.         "line_id": "LINE-1234567890",
  31.         "hs_code": "444.333.2222",
  32.         "sku": "SKU-123455666",
  33.         "country_of_manufacture": "US",
  34.         "reasons": [
  35.           {
  36.             "name": "wrong_size",
  37.             "value": "Wrong Size",
  38.             "reasons": {
  39.               "name": "to_small",
  40.               "value": "Too Small"
  41.             }
  42.           }
  43.         ]
  44.       }
  45.     ]
  46.   }
  47. }
                curl --request POST \
--url https://api.zenkraft.com/returns \
--header 'content-type: application/json' \
--header 'zkkey: XXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
  "return_methods": {
    "test": true,
    "debug": true,
    "customer_id": "123456",
    "location": {
      "name": "Jack O'Rogers",
      "company": "Burlington Textiles Corp of America",
      "street1": "525 S. ZENKRAFT Ave",
      "street2": "suite 120",
      "email": "jrogers@example.com",
      "phone": "(336) 222-7000",
      "city": "Burlington",
      "state": "NC",
      "postal_code": "27415",
      "country": "US"
    },
    "references": [
      {
        "type": "customer_reference",
        "value": "ABC-000123"
      }
    ],
    "return_lines": [
      {
        "quantity": 1,
        "value": 25,
        "weight": 4.2,
        "product_name": "Shoes",
        "line_id": "LINE-1234567890",
        "hs_code": "444.333.2222",
        "sku": "SKU-123455666",
        "country_of_manufacture": "US",
        "reasons": [
          {
            "name": "wrong_size",
            "value": "Wrong Size",
            "reasons": {
              "name": "to_small",
              "value": "Too Small"
            }
          }
        ]
      }
    ]
  }
}'
            

import requests

headers = {
"zkkey": "XXXXXXXXXXXXXXXXXXXXXXX"
}

payload = {
  "return_methods": {
    "test": true,
    "debug": true,
    "customer_id": "123456",
    "location": {
      "name": "Jack O'Rogers",
      "company": "Burlington Textiles Corp of America",
      "street1": "525 S. ZENKRAFT Ave",
      "street2": "suite 120",
      "email": "jrogers@example.com",
      "phone": "(336) 222-7000",
      "city": "Burlington",
      "state": "NC",
      "postal_code": "27415",
      "country": "US"
    },
    "references": [
      {
        "type": "customer_reference",
        "value": "ABC-000123"
      }
    ],
    "return_lines": [
      {
        "quantity": 1,
        "value": 25,
        "weight": 4.2,
        "product_name": "Shoes",
        "line_id": "LINE-1234567890",
        "hs_code": "444.333.2222",
        "sku": "SKU-123455666",
        "country_of_manufacture": "US",
        "reasons": [
          {
            "name": "wrong_size",
            "value": "Wrong Size",
            "reasons": {
              "name": "to_small",
              "value": "Too Small"
            }
          }
        ]
      }
    ]
  }
}
url = "https://api.zenkraft.com/returns"

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

print(response.json())
            
                
            
  1. {
  2.   "return_lines": [
  3.     {
  4.       "quantity": 1,
  5.       "value": 25,
  6.       "weight": 4.2,
  7.       "product_name": "Shoes",
  8.       "line_id": "LINE-1234567890",
  9.       "hs_code": "444.333.2222",
  10.       "sku": "SKU-123455666",
  11.       "country_of_manufacture": "US",
  12.       "reasons": [
  13.         {
  14.           "name": "wrong_size",
  15.           "value": "Wrong Size",
  16.           "reasons": {
  17.             "name": "to_small",
  18.             "value": "Too Small"
  19.           }
  20.         }
  21.       ]
  22.     }
  23.   ],
  24.   "return_methods": [
  25.     {
  26.       "id": "f936964c2a7745dc8e0f2d055efabd50",
  27.       "carrier": "fedex",
  28.       "carrier_logo": "https://test-cdn.zenkraft.com/static/images/carriers/fedex.png",
  29.       "carrier_name": "FedEx",
  30.       "method_name": "FedEx Drop Off",
  31.       "type": "drop_off",
  32.       "options": [
  33.         {
  34.           "city": "Livingston",
  35.           "country": "US",
  36.           "distance": 0.62,
  37.           "id": "500bd31de3204d11b549df947ac1f695_1",
  38.           "lat": "40.794128",
  39.           "lng": "-74.314625",
  40.           "location_id": "ANFCV",
  41.           "location_name": "FedEx OnSite",
  42.           "operational_hours": {
  43.             "MON": {
  44.               "open": "08:00",
  45.               "close": "22:00"
  46.             },
  47.             "TUE": {
  48.               "open": "08:00",
  49.               "close": "22:00"
  50.             },
  51.             "WED": {
  52.               "open": "08:00",
  53.               "close": "22:00"
  54.             },
  55.             "THU": {
  56.               "open": "08:00",
  57.               "close": "22:00"
  58.             },
  59.             "FRI": {
  60.               "open": "08:00",
  61.               "close": "22:00"
  62.             },
  63.             "SAT": {
  64.               "open": "08:00",
  65.               "close": "22:00"
  66.             },
  67.             "SUN": {
  68.               "open": "08:00",
  69.               "close": "22:00"
  70.             }
  71.           },
  72.           "postal_code": "7039",
  73.           "state": "NJ",
  74.           "street1": "45 S Livingston Ave"
  75.         }
  76.       ]
  77.     }
  78.   ]
  79. }


/returns GET

This endpoint allows you to retrieve previously created returns

GET Request Parameters
Field Possible Values Example
start_date object Start date filter
end_date object End date filter
search object Filter by tracking, reference and confirmation numbers of related shipment or pickup objects
return_method object Tracking number filter
customer_id object Customer ID filter
order_id object Order ID filter
status object Shipment status filter
custom object Custom pair filter
page object Page number
pageSize object Return items amount per page


Successful Response
Field Possible Values Example
returns array
created string when was this object created 2021-06-02T07:22:43.000
custom array Custom context attached to the return
name string Name of the custom field refunded
value object The value of the custom field - can be any type of object true
customer_id string 123456
id string 2ff7047526e64a10a3e952680aca7e81
pickup object
confirmation_number string reference number of this pickup. It can be used to cancel the pickup if the carrier allows it required 123456789
id string required 7acd186c4bad4197ad36b918eff71c03
reference_number string some carriers allow you to track either by the tracking number or the reference number required 567293923024
return_method object
carrier string required fedex
carrier_logo string required https://test-cdn.zenkraft.com/static/images/carriers/fedex.png
carrier_name string required FedEx
cost object required
carrier_charge number required 4.99
customer_charge number required 4.99
id string required f936964c2a7745dc8e0f2d055efabd50
method_name string required FedEx Drop Off
return_charge number required 4.99
type string required pickup drop_off drop_off
shipment object
id string required 7acd186c4bad4197ad36b918eff71c03
reference_number string some carriers allow you to track either by the tracking number or the reference number required 567293923024
status string the most recent important status description required Delivered to a mailbox
tracking_number string Tracking number of shipment required 567293923024
Example Request / Response
  1. https://api.zenkraft.com/returns
                curl --request GET \
--url https://api.zenkraft.com/returns \
--header 'content-type: application/json' \
--header 'zkkey: XXXXXXXXXXXXXXXXXXXXXXX'
            

import requests

headers = {
"zkkey": "XXXXXXXXXXXXXXXXXXXXXXX"
}

payload = None
url = "https://api.zenkraft.com/returns"

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

print(response.json())
            
                
            
  1. [
  2.   {
  3.     "id": "2ff7047526e64a10a3e952680aca7e81",
  4.     "customer_id": "123456",
  5.     "created": "2021-06-02T07:22:43.000",
  6.     "return_method": {
  7.       "id": "f936964c2a7745dc8e0f2d055efabd50",
  8.       "carrier": "fedex",
  9.       "carrier_logo": "https://test-cdn.zenkraft.com/static/images/carriers/fedex.png",
  10.       "carrier_name": "FedEx",
  11.       "method_name": "FedEx Drop Off",
  12.       "type": "drop_off",
  13.       "cost": {
  14.         "carrier_charge": 4.99,
  15.         "customer_charge": 4.99
  16.       },
  17.       "return_charge": 4.99
  18.     },
  19.     "pickup": {
  20.       "id": "7acd186c4bad4197ad36b918eff71c03",
  21.       "confirmation_number": "123456789",
  22.       "reference_number": "567293923024"
  23.     },
  24.     "shipment": {
  25.       "id": "7acd186c4bad4197ad36b918eff71c03",
  26.       "tracking_number": "567293923024",
  27.       "reference_number": "567293923024",
  28.       "status": "Delivered to a mailbox"
  29.     }
  30.   }
  31. ]


/returns/{return_id} GET

This endpoint allows you to retrieve specific return details.

GET Request Parameters
Field Possible Values Example
return_id object return ID required


Successful Response
Field Possible Values Example
created string when was this object created required 2021-06-02T07:22:43.000
custom array Custom context attached to the return
name string Name of the custom field refunded
value object The value of the custom field - can be any type of object true
customer_id string required CUST-99sa6
id string required 7acd186c4bad4197ad36b918eff71c03
order_id string ORD-568
pickup object
confirmation_number string reference number of this pickup. It can be used to cancel the pickup if the carrier allows it required 123456789
id string required 7acd186c4bad4197ad36b918eff71c03
reference_number string some carriers allow you to track either by the tracking number or the reference number required 567293923024
return_lines array required
country_of_manufacture 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
hs_code string 444.333.2222
line_id string LINE-1234567890
product_name string Shoes
quantity integer quantity of this item in the package 1
reasons array
name string size
reasons object
name string required where
value string required toe
value string too_small
sku string SKU-123455666
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
return_method object required
carrier string required fedex
carrier_logo string required https://test-cdn.zenkraft.com/static/images/carriers/fedex.png
carrier_name string required FedEx
cost object required
carrier_charge number required 4.99
customer_charge number required 4.99
id string required f936964c2a7745dc8e0f2d055efabd50
method_name string required FedEx Drop Off
return_charge number required 4.99
type string required pickup drop_off drop_off
shipment object required
id string required
label string base64 label required
reference_number string some carriers allow you to track either by the tracking number or the reference number required 567293923024
status string the most recent important status description required Delivered to a mailbox
tracking_number string Tracking number of shipment required 567293923024
Example Request / Response
  1. https://api.zenkraft.com/returns/7acd186c4bad4197ad36b918eff71c03
                curl --request GET \
--url https://api.zenkraft.com/returns/7acd186c4bad4197ad36b918eff71c03 \
--header 'content-type: application/json' \
--header 'zkkey: XXXXXXXXXXXXXXXXXXXXXXX'
            

import requests

headers = {
"zkkey": "XXXXXXXXXXXXXXXXXXXXXXX"
}

payload = None
url = "https://api.zenkraft.com/returns/7acd186c4bad4197ad36b918eff71c03"

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

print(response.json())
            
                
            
  1. {
  2.   "id": "7acd186c4bad4197ad36b918eff71c03",
  3.   "customer_id": "123456",
  4.   "created": "2021-06-02T07:22:43.000",
  5.   "return_lines": [
  6.     {
  7.       "quantity": 1,
  8.       "value": 25,
  9.       "weight": 4.2,
  10.       "product_name": "Shoes",
  11.       "line_id": "LINE-1234567890",
  12.       "hs_code": "444.333.2222",
  13.       "sku": "SKU-123455666",
  14.       "country_of_manufacture": "US",
  15.       "reasons": [
  16.         {
  17.           "name": "wrong_size",
  18.           "value": "Wrong Size",
  19.           "reasons": {
  20.             "name": "to_small",
  21.             "value": "Too Small"
  22.           }
  23.         }
  24.       ]
  25.     }
  26.   ],
  27.   "return_method": {
  28.     "id": "f936964c2a7745dc8e0f2d055efabd50",
  29.     "carrier": "fedex",
  30.     "carrier_logo": "https://test-cdn.zenkraft.com/static/images/carriers/fedex.png",
  31.     "carrier_name": "FedEx",
  32.     "method_name": "FedEx Drop Off",
  33.     "type": "drop_off",
  34.     "cost": {
  35.       "carrier_charge": 4.99,
  36.       "customer_charge": 4.99
  37.     },
  38.     "return_charge": 4.99
  39.   },
  40.   "pickup": {
  41.     "id": "7acd186c4bad4197ad36b918eff71c03",
  42.     "confirmation_number": "123456789",
  43.     "reference_number": "567293923024"
  44.   },
  45.   "shipment": {
  46.     "id": "f936964c2s77a2342af055efabd79",
  47.     "tracking_number": "567293923024",
  48.     "reference_number": "567293923024",
  49.     "status": "Delivered to a mailbox",
  50.     "label": "label base64"
  51.   }
  52. }


/returns/{return_id} PATCH

This endpoint allows you to update some specific return details.
If you pass 'SHIPMENT_VOIDED' shipment status to the request payload, shipment and pickup will be cancelled.

PATCH Request Parameters
Field Possible Values Example
custom array Custom context attached to the return
name string Name of the custom field refunded
value object The value of the custom field - can be any type of object true
shipment object
status string the most recent important status description Delivered to a mailbox


Successful Response
Field Possible Values Example
created string when was this object created required 2021-06-02T07:22:43.000
custom array Custom context attached to the return
name string Name of the custom field refunded
value object The value of the custom field - can be any type of object true
customer_id string required CUST-99sa6
id string required 7acd186c4bad4197ad36b918eff71c03
order_id string ORD-568
pickup object
confirmation_number string reference number of this pickup. It can be used to cancel the pickup if the carrier allows it required 123456789
id string required 7acd186c4bad4197ad36b918eff71c03
reference_number string some carriers allow you to track either by the tracking number or the reference number required 567293923024
return_lines array required
country_of_manufacture 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
hs_code string 444.333.2222
line_id string LINE-1234567890
product_name string Shoes
quantity integer quantity of this item in the package 1
reasons array
name string size
reasons object
name string required where
value string required toe
value string too_small
sku string SKU-123455666
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
return_method object required
carrier string required fedex
carrier_logo string required https://test-cdn.zenkraft.com/static/images/carriers/fedex.png
carrier_name string required FedEx
cost object required
carrier_charge number required 4.99
customer_charge number required 4.99
id string required f936964c2a7745dc8e0f2d055efabd50
method_name string required FedEx Drop Off
return_charge number required 4.99
type string required pickup drop_off drop_off
shipment object required
id string required
label string base64 label required
reference_number string some carriers allow you to track either by the tracking number or the reference number required 567293923024
status string the most recent important status description required Delivered to a mailbox
tracking_number string Tracking number of shipment required 567293923024
Example Request / Response
  1. {
  2.   "custom": [
  3.     {
  4.       "name": "refunded",
  5.       "value": true
  6.     }
  7.   ],
  8.   "shipment": {
  9.     "status": "IN_TRANSIT"
  10.   }
  11. }
                curl --request PATCH \
--url https://api.zenkraft.com/returns \
--header 'content-type: application/json' \
--header 'zkkey: XXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
  "custom": [
    {
      "name": "refunded",
      "value": true
    }
  ],
  "shipment": {
    "status": "IN_TRANSIT"
  }
}'
            

import requests

headers = {
"zkkey": "XXXXXXXXXXXXXXXXXXXXXXX"
}

payload = None
url = "{
  "custom": [
    {
      "name": "refunded",
      "value": true
    }
  ],
  "shipment": {
    "status": "IN_TRANSIT"
  }
}"

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

print(response.json())
            
                
            
  1. {
  2.   "id": "7acd186c4bad4197ad36b918eff71c03",
  3.   "customer_id": "123456",
  4.   "created": "2021-06-02T07:22:43.000",
  5.   "return_lines": [
  6.     {
  7.       "quantity": 1,
  8.       "value": 25,
  9.       "weight": 4.2,
  10.       "product_name": "Shoes",
  11.       "line_id": "LINE-1234567890",
  12.       "hs_code": "444.333.2222",
  13.       "sku": "SKU-123455666",
  14.       "country_of_manufacture": "US",
  15.       "reasons": [
  16.         {
  17.           "name": "wrong_size",
  18.           "value": "Wrong Size",
  19.           "reasons": {
  20.             "name": "to_small",
  21.             "value": "Too Small"
  22.           }
  23.         }
  24.       ]
  25.     }
  26.   ],
  27.   "return_method": {
  28.     "id": "f936964c2a7745dc8e0f2d055efabd50",
  29.     "carrier": "fedex",
  30.     "carrier_logo": "https://test-cdn.zenkraft.com/static/images/carriers/fedex.png",
  31.     "carrier_name": "FedEx",
  32.     "method_name": "FedEx Drop Off",
  33.     "type": "drop_off",
  34.     "cost": {
  35.       "carrier_charge": 4.99,
  36.       "customer_charge": 4.99
  37.     },
  38.     "return_charge": 4.99
  39.   },
  40.   "pickup": {
  41.     "id": "7acd186c4bad4197ad36b918eff71c03",
  42.     "confirmation_number": "123456789",
  43.     "reference_number": "567293923024"
  44.   },
  45.   "shipment": {
  46.     "id": "f936964c2s77a2342af055efabd79",
  47.     "tracking_number": "567293923024",
  48.     "reference_number": "567293923024",
  49.     "status": "Delivered to a mailbox",
  50.     "label": "label base64"
  51.   }
  52. }


/returns/{return_id} DELETE

This endpoint allows you to cancel and delete the specific return.

DELETE Request Parameters
Field Possible Values Example
return_id object return ID required


Successful Response
Field Possible Values Example
success object required
message string Message describing the action was performed successfully Success!
Example Request / Response
  1. https://api.zenkraft.com/returns/7acd186c4bad4197ad36b918eff71c03
                curl --request GET \
--url https://api.zenkraft.com/returns/7acd186c4bad4197ad36b918eff71c03 \
--header 'content-type: application/json' \
--header 'zkkey: XXXXXXXXXXXXXXXXXXXXXXX'
            

import requests

headers = {
"zkkey": "XXXXXXXXXXXXXXXXXXXXXXX"
}

payload = None
url = "https://api.zenkraft.com/returns/7acd186c4bad4197ad36b918eff71c03"

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

print(response.json())
            
                
            
  1. {
  2.   "success": {
  3.     "message": "Success!"
  4.   }
  5. }


/returns/confirm POST

This endpoint allows you to confirm returns creation.

POST Request Parameters
Field Possible Values Example
return_methods array 7acd186c4bad4197ad36b918eff71c03


Successful Response
Field Possible Values Example
returns array
created string when was this object created 2021-06-02T07:22:43.000
custom array Custom context attached to the return
name string Name of the custom field refunded
value object The value of the custom field - can be any type of object true
customer_id string CUST-99sa6
id string 7acd186c4bad4197ad36b918eff71c03
order_id string ORD-568
pickup object
confirmation_number string reference number of this pickup. It can be used to cancel the pickup if the carrier allows it required 123456789
id string required 7acd186c4bad4197ad36b918eff71c03
reference_number string some carriers allow you to track either by the tracking number or the reference number required 567293923024
return_lines array
country_of_manufacture 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
hs_code string 444.333.2222
line_id string LINE-1234567890
product_name string Shoes
quantity integer quantity of this item in the package 1
reasons array
name string size
reasons object
name string required where
value string required toe
value string too_small
sku string SKU-123455666
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
return_method object
carrier string required fedex
carrier_logo string required https://test-cdn.zenkraft.com/static/images/carriers/fedex.png
carrier_name string required FedEx
cost object required
carrier_charge number required 4.99
customer_charge number required 4.99
id string required f936964c2a7745dc8e0f2d055efabd50
method_name string required FedEx Drop Off
return_charge number required 4.99
type string required pickup drop_off drop_off
shipment object
id string required
label string base64 label required
reference_number string some carriers allow you to track either by the tracking number or the reference number required 567293923024
status string the most recent important status description required Delivered to a mailbox
tracking_number string Tracking number of shipment required 567293923024
Example Request / Response
  1. {
  2.   "return_methods": [
  3.     "7acd186c4bad4197ad36b918eff71c03"
  4.   ]
  5. }
                curl --request POST \
--url https://api.zenkraft.com/returns \
--header 'content-type: application/json' \
--header 'zkkey: XXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
  "return_methods": [
    "7acd186c4bad4197ad36b918eff71c03"
  ]
}'
            

import requests

headers = {
"zkkey": "XXXXXXXXXXXXXXXXXXXXXXX"
}

payload = {
  "return_methods": [
    "7acd186c4bad4197ad36b918eff71c03"
  ]
}
url = "https://api.zenkraft.com/returns"

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

print(response.json())
            
                
            
  1. [
  2.   {
  3.     "id": "7acd186c4bad4197ad36b918eff71c03",
  4.     "customer_id": "123456",
  5.     "created": "2021-06-02T07:22:43.000",
  6.     "return_lines": [
  7.       {
  8.         "quantity": 1,
  9.         "value": 25,
  10.         "weight": 4.2,
  11.         "product_name": "Shoes",
  12.         "line_id": "LINE-1234567890",
  13.         "hs_code": "444.333.2222",
  14.         "sku": "SKU-123455666",
  15.         "country_of_manufacture": "US",
  16.         "reasons": [
  17.           {
  18.             "name": "wrong_size",
  19.             "value": "Wrong Size",
  20.             "reasons": {
  21.               "name": "to_small",
  22.               "value": "Too Small"
  23.             }
  24.           }
  25.         ]
  26.       }
  27.     ],
  28.     "return_method": {
  29.       "id": "f936964c2a7745dc8e0f2d055efabd50",
  30.       "carrier": "fedex",
  31.       "carrier_logo": "https://test-cdn.zenkraft.com/static/images/carriers/fedex.png",
  32.       "carrier_name": "FedEx",
  33.       "method_name": "FedEx Drop Off",
  34.       "type": "drop_off",
  35.       "cost": {
  36.         "carrier_charge": 4.99,
  37.         "customer_charge": 4.99
  38.       },
  39.       "return_charge": 4.99
  40.     },
  41.     "pickup": {
  42.       "id": "7acd186c4bad4197ad36b918eff71c03",
  43.       "confirmation_number": "123456789",
  44.       "reference_number": "567293923024"
  45.     },
  46.     "shipment": {
  47.       "id": "string",
  48.       "tracking_number": "567293923024",
  49.       "reference_number": "567293923024",
  50.       "status": "Delivered to a mailbox",
  51.       "label": "string"
  52.     }
  53.   }
  54. ]

/return_methods POST

These endpoints allow you to handle shipment return methods.

The following example includes all of the request parameters that Zenkraft supports. To see the required and optional parameters for a specific carrier, select from the Choose Carrier dropdown in the menu.

POST Request Parameters
Field Possible Values Example
return_method object required
display_name string required Free Returns
filters array required
field string return_from_country
operator string equals not_in not_equals in
value string BH CK NI RS CX SV GA LC FO SG BN IL NU PS OM PA KY GN BR IN SN ME MQ BZ LK TD NZ CA ES DO GE VU AD PK VC CC AU JO JP BQ KM IS JE GH UG CN MF UZ BF ML SY SO IQ NO BD MC MT QA SS MV MW MY MS CY BW FK TV VG PH AL ET HU CI NP TW GW MZ VI BY LY GL AI FM MK CR ZW AX SC DK KN CW AW BM DM CL ZM LT GU RO AO GF GP GT CD CZ LB BV DJ HN LV FJ KR MN SM SR TG CF AM LS AF HT RE HK SB TO SD AR KH GM RU NF WS AQ CU GY MP MG NA MA GD ER IO IR PN ST MO CV HM IT BS TK VE SL GS BI NE UA UY BJ PY KI CM NL TH EG SH PF US LR PM GB HR SK SX LI BL GR NC NG BE GG JM PL MH WF TF MX TZ VA AS YT ZA TL UM SZ AE AG FI MU TJ KZ VN MR DZ IE IM KE TC KW SJ PG BB PE AZ BO ID LA MD TM EE KP PR SE RW BT SA MM TN TT PT AT GI SI CG GQ CH DE YE KG EH LU TR EC CO BG FR PW BA NR US
location_id string required ed813903af74445398e59aec69a955ff
method_name string required DHL Ground Services
position integer Return method position, it must be more than -1. required 0
return_charge string required 10.05
service_type string required FedEx 2 Day
sf_shipping_preference_id string ed813903af74445398e59aec69a955ff
shipping_account_id integer required 123
type string required drop_off pickup drop_off


Successful Response
Field Possible Values Example
return_method object
display_name string required Free Returns
filters array required
field string return_from_country
operator string equals in not_in not_equals
value string BH CK NI RS CX SV GA LC FO SG BN IL NU PS OM PA KY GN BR IN SN ME MQ BZ LK TD NZ CA ES DO GE VU AD PK VC CC AU JO JP BQ KM IS JE GH UG CN MF UZ BF ML SY SO IQ NO BD MC MT QA SS MV MW MY MS CY BW FK TV VG PH AL ET HU CI NP TW GW MZ VI BY LY GL AI FM MK CR ZW SC DK KN CW AW BM DM CL ZM LT GU RO AO GF GP GT CD CZ LB BV DJ HN LV FJ KR MN SM SR TG CF AM LS AF HT RE HK SB TO SD AR KH GM RU NF WS AQ CU GY MP MG NA MA GD ER IO IR PN ST MO CV HM IT BS TK VE SL GS BI NE UA UY BJ PY KI CM NL TH EG SH PF US LR PM GB HR SK SX LI BL GR NC NG BE GG JM PL MH WF TF MX TZ VA AS YT ZA TL UM SZ AE AG FI MU TJ KZ VN MR DZ IE IM KE TC KW SJ PG BB PE AZ BO ID LA MD TM EE KP PR SE NR RW BT SA MM TN TT PT AT GI SI CG GQ CH DE YE KG EH LU TR EC CO BG FR PW BA AX US
id string required
location_id string required ed813903af74445398e59aec69a955ff
method_name string required DHL Ground Services
position integer Return method position, it must be more than -1. required
return_charge string required 10.05
service_type string required FedEx 2 Day
sf_shipping_preference_id string ed813903af74445398e59aec69a955ff
shipping_account_id integer required 123
type string required pickup drop_off drop_off


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.   "return_method": {
  3.     "position": 0,
  4.     "method_name": "DHL Ground Services",
  5.     "display_name": "Free Returns",
  6.     "type": "drop_off",
  7.     "shipping_account_id": 123,
  8.     "location_id": "ed813903af74445398e59aec69a955ff",
  9.     "service_type": "FedEx 2 Day",
  10.     "return_charge": "10.05",
  11.     "filters": [
  12.       {
  13.         "field": "return_from_country",
  14.         "operator": "equals",
  15.         "value": "US"
  16.       },
  17.       {
  18.         "field": "total_value",
  19.         "operator": "equals",
  20.         "value": "50"
  21.       }
  22.     ]
  23.   }
  24. }
                curl --request POST \
--url https://api.zenkraft.com/return/methods \
--header 'content-type: application/json' \
--header 'zkkey: XXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
  "return_method": {
    "position": 0,
    "method_name": "DHL Ground Services",
    "display_name": "Free Returns",
    "type": "drop_off",
    "shipping_account_id": 123,
    "location_id": "ed813903af74445398e59aec69a955ff",
    "service_type": "FedEx 2 Day",
    "return_charge": "10.05",
    "filters": [
      {
        "field": "return_from_country",
        "operator": "equals",
        "value": "US"
      },
      {
        "field": "total_value",
        "operator": "equals",
        "value": "50"
      }
    ]
  }
}'
            

import requests

headers = {
"zkkey": "XXXXXXXXXXXXXXXXXXXXXXX"
}

payload = {
  "return_method": {
    "position": 0,
    "method_name": "DHL Ground Services",
    "display_name": "Free Returns",
    "type": "drop_off",
    "shipping_account_id": 123,
    "location_id": "ed813903af74445398e59aec69a955ff",
    "service_type": "FedEx 2 Day",
    "return_charge": "10.05",
    "filters": [
      {
        "field": "return_from_country",
        "operator": "equals",
        "value": "US"
      },
      {
        "field": "total_value",
        "operator": "equals",
        "value": "50"
      }
    ]
  }
}
url = "https://api.zenkraft.com/return/methods"

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

print(response.json())
            
                
            
  1. {
  2.   "return_method": {
  3.     "position": 0,
  4.     "method_name": "DHL Ground Services",
  5.     "display_name": "Free Returns",
  6.     "type": "drop_off",
  7.     "shipping_account_id": 123,
  8.     "location_id": "ed813903af74445398e59aec69a955ff",
  9.     "service_type": "FedEx 2 Day",
  10.     "return_charge": "10.05",
  11.     "filters": [
  12.       {
  13.         "field": "return_from_country",
  14.         "operator": "equals",
  15.         "value": "US"
  16.       },
  17.       {
  18.         "field": "total_value",
  19.         "operator": "equals",
  20.         "value": "50"
  21.       }
  22.     ],
  23.     "id": "string"
  24.   }
  25. }


/return_methods GET

This endpoint allows you to retrieve previously created return methods.

Successful Response
Field Possible Values Example
return_methods array
display_name string Free Returns
filters array
field string return_from_country
operator string equals in not_in not_equals
value string BH CK NI RS CX SV GA LC FO SG BN IL NU PS OM PA KY GN BR IN SN ME MQ BZ LK TD NZ CA ES DO GE VU AD PK VC CC AU JO JP BQ KM IS JE GH UG CN MF UZ BF ML SY SO IQ NO BD MC MT QA SS MV MW MY MS CY BW FK TV VG PH AL ET HU CI NP TW GW MZ VI BY LY GL AI FM MK CR ZW SC DK KN CW AW BM DM CL ZM LT GU RO AO GF GP GT CD CZ LB BV DJ HN LV FJ KR MN SM SR TG CF AM LS AF HT RE HK SB TO SD AR KH GM RU NF WS AQ CU GY MP MG NA MA GD ER IO IR PN ST MO CV HM IT BS TK VE SL GS BI NE UA UY BJ PY KI CM NL TH EG SH PF US LR PM GB HR SK SX LI BL GR NC NG BE GG JM PL MH WF TF MX TZ VA AS YT ZA TL UM SZ AE AG FI MU TJ KZ VN MR DZ IE IM KE TC KW SJ PG BB PE AZ BO ID LA MD TM EE KP PR SE NR RW BT SA MM TN TT PT AT GI SI CG GQ CH DE YE KG EH LU TR EC CO BG FR PW BA AX US
id string
location_id string ed813903af74445398e59aec69a955ff
method_name string DHL Ground Services
position integer Return method position, it must be more than -1.
return_charge string 10.05
service_type string FedEx 2 Day
sf_shipping_preference_id string ed813903af74445398e59aec69a955ff
shipping_account_id integer 123
type string pickup drop_off drop_off


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/return_methods
                curl --request GET \
--url https://api.zenkraft.com/return_methods \
--header 'content-type: application/json' \
--header 'zkkey: XXXXXXXXXXXXXXXXXXXXXXX'
            

import requests

headers = {
"zkkey": "XXXXXXXXXXXXXXXXXXXXXXX"
}

payload = None
url = "https://api.zenkraft.com/return_methods"

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

print(response.json())
            
                
            
  1. {
  2.   "return_methods": [
  3.     {
  4.       "position": 0,
  5.       "method_name": "DHL Ground Services",
  6.       "display_name": "Free Returns",
  7.       "type": "drop_off",
  8.       "shipping_account_id": 123,
  9.       "location_id": "ed813903af74445398e59aec69a955ff",
  10.       "service_type": "FedEx 2 Day",
  11.       "return_charge": "10.05",
  12.       "filters": [
  13.         {
  14.           "field": "return_from_country",
  15.           "operator": "equals",
  16.           "value": "US"
  17.         },
  18.         {
  19.           "field": "total_value",
  20.           "operator": "equals",
  21.           "value": "50"
  22.         }
  23.       ],
  24.       "id": "string"
  25.     }
  26.   ]
  27. }

/validate_address POST

You can use /validate_address to automatically fix the address before you try to create the label. The request always validates the address and optionally you can set validate_phone and validate_email to also validate the phone number and the email respectively.

POST Request Parameters
Field Possible Values Example
validate object required
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 BH CK CX NI RS SV GA LC FO SG BN ZA IL NU PS OM PA KY GN BR IN SN ME MQ BZ LK TD NZ CA ES DO GE VU AD PK VC CC AU JO JP BQ KM IS JE GH UG CN MF UZ BF ML SY SO IQ NO BD MC MT QA SS MV MW MY MS CY BW FK TV VG PH AL ET HU CI NP TW GW MZ VI BY LY GL AI FM MK CR ZW SC DK KN CW AW BM DM CL ZM LT GU RO AO GF GP GT CD CZ LB BV DJ HN LV FJ KR MN SM SR TG CF AM LS AF HT RE HK SB TO SD AR KH GM RU NF WS AQ CU GY MP MG NA MA GD ER IO IR PN ST MO CV HM IT BS TK VE SL GS BI NE UA UY BJ PY KI CM NL TH EG SH PF US LR PM GB HR SK SX LI BL GR NC NG BE GG JM PL MH WF TF MX TZ VA AS YT TL UM SZ AE AG FI MU TJ KZ VN MR DZ IE IM KE TC KW SJ PG BB PE AZ BO ID LA MD TM EE KP PR NR SE RW BT SA MM TN TT PT AT GI SI CG GQ CH DE YE KG EH LU TR EC CO BG FR PW BA AX 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
debug boolean
validate_email boolean
validate_phone boolean


Successful Response
Field Possible Values Example
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 BH CK CX NI RS SV GA LC FO SG BN ZA IL NU PS OM PA KY GN BR IN SN ME MQ BZ LK TD NZ CA ES DO GE VU AD PK VC CC AU JO JP BQ KM IS JE GH UG CN MF UZ BF ML SY SO IQ NO BD MC MT QA SS MV MW MY MS CY BW FK TV VG PH AL ET HU CI NP TW GW MZ VI BY LY GL AI FM MK CR ZW SC DK KN CW AW BM DM CL ZM LT GU RO AO GF GP GT CD CZ LB BV DJ HN LV FJ KR MN SM SR TG CF AM LS AF HT RE HK SB TO SD AR KH GM RU NF WS AQ CU GY MP MG NA MA GD ER IO IR PN ST MO CV HM IT BS TK VE SL GS BI NE UA UY BJ PY KI CM NL TH EG SH PF US LR PM GB HR SK SX LI BL GR NC NG BE GG JM PL MH WF TF MX TZ VA AS YT TL UM SZ AE AG FI MU TJ KZ VN MR DZ IE IM KE TC KW SJ PG BB PE AZ BO ID LA MD TM EE KP PR NR SE RW BT SA MM TN TT PT AT GI SI CG GQ CH DE YE KG EH LU TR EC CO BG FR PW BA AX 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
fixed boolean


Error Response
Field Possible Values Example
error object
code string Standardized error code. required connected_account_not_found wrong_api_key shipping_account_not_found unexpected_exception shipping_account_wrong_carrier schema_field_required schema_validation_error missing_api_key
detail string This field can contain additional information about the error. This field is not meant to be shown to the end-user required
message string Error message required No connected account exists with that ID
Example Request / Response
  1. {
  2.     "validate": {
  3.         "debug": true,
  4.         "address": {
  5.             "city": "West Hollywood",
  6.             "company": "Fresh Corn Grill",
  7.             "country": "US",
  8.             "state": "CA",
  9.             "email": "test@test.yesyesghse",
  10.             "name": "Dio",
  11.             "phone": "+4367764842356",
  12.             "postal_code": "1002",
  13.             "street1": "8714 Santa Monica Blvd, West Hollywood"
  14.         },
  15.         "validate_phone": false,
  16.         "validate_email": false
  17.     }
  18. }
                curl --request POST \
--url https://api.zenkraft.com/validate/address \
--header 'content-type: application/json' \
--header 'zkkey: XXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
    "validate": {
        "debug": true,
        "address": {
            "city": "West Hollywood",
            "company": "Fresh Corn Grill",
            "country": "US",
            "state": "CA",
            "email": "test@test.yesyesghse",
            "name": "Dio",
            "phone": "+4367764842356",
            "postal_code": "1002",
            "street1": "8714 Santa Monica Blvd, West Hollywood"
        },
        "validate_phone": false,
        "validate_email": false
    }
}'
            

import requests

headers = {
"zkkey": "XXXXXXXXXXXXXXXXXXXXXXX"
}

payload = {
    "validate": {
        "debug": true,
        "address": {
            "city": "West Hollywood",
            "company": "Fresh Corn Grill",
            "country": "US",
            "state": "CA",
            "email": "test@test.yesyesghse",
            "name": "Dio",
            "phone": "+4367764842356",
            "postal_code": "1002",
            "street1": "8714 Santa Monica Blvd, West Hollywood"
        },
        "validate_phone": false,
        "validate_email": false
    }
}
url = "https://api.zenkraft.com/validate/address"

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

print(response.json())
            
                
            
  1. {
  2.     "address": {
  3.         "city": "West Hollywood",
  4.         "company": "Fresh Corn Grill",
  5.         "country": "US",
  6.         "email": "test@test.yesyesghse",
  7.         "name": "Dio",
  8.         "phone": "+4367764842356",
  9.         "postal_code": "90069",
  10.         "residential": false,
  11.         "state": "CA",
  12.         "street1": "8714 Santa Monica Blvd"
  13.     },
  14.     "fixed": true
  15. }

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