API Docs
Customers need to quickly change and add carriers without incurring costly and
restrictive technical debt. Every carrier has different integration methods, requiring
a new development project for every new or updated carrier. This workload compounds as
you expand globally and work with a larger number of carriers.
The Zenkraft API integrates directly with shipping carriers such as
FedEx, UPS, and
DHL through a single platform. Integrate with Zenkraft’s
developer-friendly API and let Zenkraft handle the complexities of global carrier
integration.
This page includes examples of the Zenkraft API’s structure and parameters. Select a
carrier from the dropdown list in the navigation menu to access API reference
documentation listing their required and accepted parameters.
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.
Base URL
/shippingaccount POST
The /shippingaccount endpoint enables you to use your carrier account credentials to create a Shipping Acccount ID in the Zenkraft system. This is used for all future API calls listed below.
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 | BB SK BH SR YT CA TM ZM TO AW IQ QA PS GG GR PR PT SG MQ TH IL BM CL AX BD LT IT BG MZ IR NE NR OM RO BQ CF US AR GW TZ CD GS AM PM PF SB PA LS LK ZW DK FR KR JM LY ZA BV NA DE GY HM CO NZ TR LI ME HT MT GI UG CR BO CN MX CC PH BY JE KW JP WF NP SE AU CK GT TN BI MD PN BA SO PG TL MS VU GD KG GF KN MN KM MF GB CY BS UA SH VI CG TT GQ LR BT LU CX GM BE DO EC EE SM FK KI GU BJ SA AF MY PE GL TV SJ WS YE MR AT AD MO EH CH ET AG LV SD SL NI TW SV KH AZ IN HU TD BR ML UY IM ST FO CZ SZ GN GA NF SI KP KE NC NL SN VA AI RW AE KZ MK MP ID AO PW MA RS AL TF IS HN HR DM DJ NO PY MW BZ NG IE PL VG CW MG LC SY RU BN AS GE GP MU GH VN CU BF LB MC CM IO BW JO KY RE SS MM BL VC SX MV FM HK LA CV FI EG FJ SC AQ DZ TG CI VE ES MH UM ER TK NU TC TJ PK UZ |
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 | BB SK BH SR YT CA TM ZM TO AW IQ QA PS GG GR PR PT SG MQ TH IL BM CL AX BD LT IT BG MZ IR NE NR OM RO BQ CF US AR GW TZ CD GS AM PM PF SB PA LS LK ZW DK FR KR JM LY ZA BV NA DE GY HM CO NZ TR LI ME HT MT GI UG CR BO CN MX CC PH BY JE KW JP WF NP SE AU CK GT TN BI MD PN BA SO PG TL MS VU GD KG GF KN MN KM MF GB CY BS UA SH VI CG TT GQ LR BT LU CX GM BE DO EC EE SM FK KI GU BJ SA AF MY PE GL TV SJ WS YE MR AT AD MO EH CH ET AG LV SD SL NI TW SV KH AZ IN HU TD BR ML UY IM ST FO CZ SZ GN GA NF SI KP KE NC NL SN VA AI RW AE KZ MK MP ID AO PW MA RS AL TF IS HN HR DM DJ NO PY MW BZ NG IE PL VG CW MG LC SY RU BN AS GE GP MU GH VN CU BF LB MC CM IO BW JO KY RE SS MM BL VC SX MV FM HK LA CV FI EG FJ SC AQ DZ TG CI VE ES MH UM ER TK NU TC TJ PK UZ |
US |
defaults object |
|
|
currency string | ANG BAM HKD SZL TMT ARS XPF FJD ZMW PYG TWD QAR COP KES NOK MNT MDL KZT KRW STN RUB MWK KGS GBP GYD INR SVC RSD BSD HTG SLL MYR LSL DOP TJS SBD ALL EUR TOP AED XOF IDR MUR MXN MGA BWP YER CVE NAD SOS IMP VND AOA JEP SCR ERN ETB LAK SAR FKP CLP SGD BBD UZS LYD UYU CZK GNF NPR ZAR WST BGN KHR UAH HUF SHP SRD CAD PGK UGX HRK USD SPL PKR GEL LBP BMD GHS MZN MKD TND SYP BYN XCD IQD XDR IRR ISK EGP ILS TVD CDF MRU PEN SDG OMR MVR PLN SEK BND CNY RON TRY MMK NGN LKR LRD BZD JOD AMD CUP KWD BDT KYD TTD TZS MAD NZD KMF JMD PHP DKK AFN RWF DJF CUC AZN GTQ BIF AWG MOP VUV XAF THB PAB CHF KPW GGP GIP BTN HNL JPY GMD BHD CRC BOB ZWD DZD VEF NIO AUD BRL |
|
dim_units string Dimension units of the packages, inches or centimeters | IN CM |
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 | BB SK BH SR YT CA TM ZM TO AW IQ QA PS GG GR PR PT SG MQ TH IL BM CL AX BD LT IT BG MZ IR NE NR OM RO BQ CF US AR GW TZ CD GS AM PM PF SB PA LS LK ZW DK FR KR JM LY ZA BV NA DE GY HM CO NZ TR LI ME HT MT GI UG CR BO CN MX CC PH BY JE KW JP WF NP SE AU CK GT TN BI MD PN BA SO PG TL MS VU GD KG GF KN MN KM MF GB CY BS UA SH VI CG TT GQ LR BT LU CX GM BE DO EC EE SM FK KI GU BJ SA AF MY PE GL TV SJ WS YE MR AT AD MO EH CH ET AG LV SD SL NI TW SV KH AZ IN HU TD BR ML UY IM ST FO CZ SZ GN GA NF SI KP KE NC NL SN VA AI RW AE KZ MK MP ID AO PW MA RS AL TF IS HN HR DM DJ NO PY MW BZ NG IE PL VG CW MG LC SY RU BN AS GE GP MU GH VN CU BF LB MC CM IO BW JO KY RE SS MM BL VC SX MV FM HK LA CV FI EG FJ SC AQ DZ TG CI VE ES MH UM ER TK NU TC TJ PK UZ |
US |
defaults object required |
|
|
currency string | ANG BAM HKD SZL TMT ARS XPF FJD ZMW PYG TWD QAR COP KES NOK MNT MDL KZT KRW STN RUB MWK KGS GBP GYD INR SVC RSD BSD HTG SLL MYR LSL DOP TJS SBD ALL EUR TOP AED XOF IDR MUR MXN MGA BWP YER CVE NAD SOS IMP VND AOA JEP SCR ERN ETB LAK SAR FKP CLP SGD BBD UZS LYD UYU CZK GNF NPR ZAR WST BGN KHR UAH HUF SHP SRD CAD PGK UGX HRK USD SPL PKR GEL LBP BMD GHS MZN MKD TND SYP BYN XCD IQD XDR IRR ISK EGP ILS TVD CDF MRU PEN SDG OMR MVR PLN SEK BND CNY RON TRY MMK NGN LKR LRD BZD JOD AMD CUP KWD BDT KYD TTD TZS MAD NZD KMF JMD PHP DKK AFN RWF DJF CUC AZN GTQ BIF AWG MOP VUV XAF THB PAB CHF KPW GGP GIP BTN HNL JPY GMD BHD CRC BOB ZWD DZD VEF NIO AUD BRL |
|
dim_units string Dimension units of the packages, inches or centimeters | IN CM |
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 | unexpected_exception master_test_shipping_account_not_found shipping_account_not_found shipping_account_wrong_carrier missing_api_key schema_validation_error schema_field_required wrong_api_key |
master_test_shipping_account_not_found |
detail string This field can contain additional information about the error. This field is not meant to be shown to the end-user required |
|
|
message object Error message required | Master shipping account for fedex in US does not exist |
/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 | ANG BAM HKD SZL TMT ARS XPF FJD ZMW PYG TWD QAR NOK COP KES MNT MDL KZT KRW STN RUB MWK KGS GBP GYD INR SVC RSD BSD HTG SLL MYR LSL DOP TJS SBD ALL TOP EUR AED XOF IDR MUR MXN MGA BWP YER CVE NAD SOS IMP VND AOA JEP SCR ERN ETB LAK SAR FKP CLP SGD BBD UZS LYD UYU CZK GNF NPR ZAR WST BGN KHR UAH HUF SHP SRD CAD PGK UGX HRK USD SPL PKR GEL LBP BMD GHS MZN MKD TND SYP BYN XCD IQD XDR IRR ISK EGP ILS TVD CDF MRU PEN SDG OMR MVR PLN SEK BND CNY RON TRY MMK NGN LKR LRD BZD JOD AMD CUP KWD BDT KYD TTD TZS MAD NZD KMF JMD PHP DKK AFN RWF DJF CUC AZN GTQ BIF AWG MOP VUV XAF THB PAB CHF KPW GGP GIP BTN HNL JPY GMD BHD CRC BOB ZWD DZD VEF NIO AUD BRL |
|
debug boolean calls with debug=true will be logged |
|
|
dim_units string Dimension units of the packages, inches or centimeters required | IN CM |
IN |
packages array required |
|
|
height number height of the package according to units specified under dim_units | 5 |
|
length number length of the package according to units specified under dim_units. ususally the length needs to be the largest of length, width, height | 11 |
|
value number value of the package according to currency specified | 25 |
|
weight number weight of the package according to units specified under weight_units | 4.2 |
|
width number width of the package according to units specified under dim_units | 8.5 |
|
packaging string the packaging type required | your_packaging |
your_packaging |
recipient object Recipient of shiment required |
|
|
city string the city of the recipient required | Burlington |
|
company string the company name of the recipient | Burlington Textiles Corp of America |
|
country string required | BB SK BH SR YT CA TM ZM TO AW IQ QA PS GG GR PR PT SG MQ TH IL BM CL AX BD LT IT BG MZ IR NE NR OM RO BQ CF US AR GW TZ CD GS AM PM PF SB PA LS LK ZW DK FR KR JM LY ZA BV NA DE HM GY CO TR NZ LI ME HT MT GI UG CR BO CN MX CC PH BY JE KW JP WF NP SE AU CK GT TN BI MD PN BA SO PG TL MS VU GD KG GF KN MN KM MF GB CY BS UA SH VI CG TT GQ LR BT LU CX GM BE DO EC EE SM FK KI GU BJ SA AF MY PE GL TV SJ WS YE MR AT AD MO EH CH ET AG LV SD SL NI TW SV KH AZ IN HU TD BR ML UY IM ST FO CZ SZ GN GA NF SI KP KE NC NL SN VA AI RW AE KZ MK MP ID AO PW MA RS AL TF IS HN HR DM DJ NO PY MW BZ NG IE PL VG CW MG LC SY RU BN AS GE GP MU GH VN CU BF LB MC CM IO BW JO KY RE SS MM BL VC SX MV FM HK LA CV FI EG FJ SC AQ DZ TG CI VE ES MH UM ER TK NU TC TJ PK UZ |
US |
email string the email address of the recipient | jrogers@example.com |
|
name string the name of the recipient required | Jack O'Rogers |
|
phone string the phone number of the recipient | (336) 222-7000 |
|
postal_code string the postal code / zip number of the recipient. Specific format depends on the country | 27215 |
|
state string the state of the recipient | NC |
|
street1 string the first line of the street address of the recipient required | 525 S. ZENKRAFT Ave |
|
street2 string the second line of the street address of the recipient | suite 120 |
|
street3 string the third line of the street address of the recipient | suite 120 |
|
sender object Sender of shiment required |
|
|
city string the city of the recipient required | Burlington |
|
company string the company name of the recipient | Burlington Textiles Corp of America |
|
country string required | BB SK BH SR YT CA TM ZM TO AW IQ QA PS GG GR PR PT SG MQ TH IL BM CL AX BD LT IT BG MZ IR NE NR OM RO BQ CF US AR GW TZ CD GS AM PM PF SB PA LS LK ZW DK FR KR JM LY ZA BV NA DE HM GY CO TR NZ LI ME HT MT GI UG CR BO CN MX CC PH BY JE KW JP WF NP SE AU CK GT TN BI MD PN BA SO PG TL MS VU GD KG GF KN MN KM MF GB CY BS UA SH VI CG TT GQ LR BT LU CX GM BE DO EC EE SM FK KI GU BJ SA AF MY PE GL TV SJ WS YE MR AT AD MO EH CH ET AG LV SD SL NI TW SV KH AZ IN HU TD BR ML UY IM ST FO CZ SZ GN GA NF SI KP KE NC NL SN VA AI RW AE KZ MK MP ID AO PW MA RS AL TF IS HN HR DM DJ NO PY MW BZ NG IE PL VG CW MG LC SY RU BN AS GE GP MU GH VN CU BF LB MC CM IO BW JO KY RE SS MM BL VC SX MV FM HK LA CV FI EG FJ SC AQ DZ TG CI VE ES MH UM ER TK NU TC TJ PK UZ |
US |
email string the email address of the recipient | jrogers@example.com |
|
name string the name of the recipient required | Jack O'Rogers |
|
phone string the phone number of the recipient | (336) 222-7000 |
|
postal_code string the postal code / zip number of the recipient. Specific format depends on the country | 27215 |
|
state string the state of the recipient | NC |
|
street1 string the first line of the street address of the recipient required | 525 S. ZENKRAFT Ave |
|
street2 string the second line of the street address of the recipient | suite 120 |
|
street3 string the third line of the street address of the recipient | suite 120 |
|
service string if you specify the service type, you'll get rates only for this service | fedex_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 | unexpected_exception carrier_authentication carrier_failed_connection carrier_timeout shipping_account_not_found carrier_unsupported_method shipping_account_wrong_carrier missing_api_key schema_validation_error carrier_throttling carrier_http_exception carrier_exception schema_field_required wrong_api_key ship_date_past |
carrier_exception |
detail string This field can contain additional information about the error. This field is not meant to be shown to the end-user required |
|
|
message object Error message required | FedEx API: The origin country code XX could not be found. Please check the country code. |
/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 | ANG BAM HKD SZL TMT ARS XPF FJD ZMW PYG TWD QAR NOK KES COP MNT MDL KZT KRW STN RUB MWK KGS GBP GYD INR SVC RSD BSD HTG SLL MYR LSL DOP TJS SBD ALL EUR TOP AED XOF IDR MUR MXN MGA BWP YER CVE NAD SOS IMP VND AOA JEP SCR ERN ETB LAK SAR FKP CLP SGD BBD UZS LYD UYU CZK GNF NPR ZAR WST BGN KHR UAH HUF SHP SRD CAD PGK UGX HRK USD SPL PKR GEL LBP BMD GHS MZN MKD TND SYP BYN XCD IQD XDR IRR ISK EGP ILS TVD CDF MRU PEN SDG OMR MVR PLN SEK BND CNY RON TRY MMK NGN LKR LRD BZD JOD AMD CUP KWD BDT KYD TTD TZS MAD NZD KMF JMD PHP DKK AFN RWF DJF CUC AZN GTQ BIF AWG MOP VUV XAF THB PAB CHF KPW GGP GIP BTN HNL JPY GMD BHD CRC BOB ZWD DZD VEF NIO AUD BRL |
|
debug boolean calls with debug=true will be logged |
|
|
dim_units string Dimension units of the packages, inches or centimeters required | IN CM |
IN |
documents array |
|
|
document string document content |
|
|
document_type string file format of the document | pdf |
|
id string uploaded document ID |
|
|
include_base64_label boolean If this is enabled, base64 label is returned |
|
|
label_size string the shipping labels size | 4x6 |
|
label_type string the label format of the shipping labels required | GIF PDF ZPL PNG JPG |
PDF |
notifications array |
|
|
type string type of the notification needed | email sms |
email |
value string value of the notification | notification1@example.com |
|
packages array required |
|
|
height number height of the package according to units specified under dim_units | 5 |
|
length number length of the package according to units specified under dim_units. ususally the length needs to be the largest of length, width, height | 11 |
|
value number value of the package according to currency specified | 25 |
|
weight number weight of the package according to units specified under weight_units | 4.2 |
|
width number width of the package according to units specified under dim_units | 8.5 |
|
packaging string the packaging type required | your_packaging |
your_packaging |
recipient object Recipient of shiment required |
|
|
city string the city of the recipient required | Burlington |
|
company string the company name of the recipient | Burlington Textiles Corp of America |
|
country string required | BB SK BH SR YT CA TM ZM TO AW IQ QA PS GG GR PR PT SG MQ TH IL BM CL AX BD LT IT BG MZ IR NE NR OM RO BQ CF US AR GW TZ CD GS AM PM PF SB PA LS LK ZW DK FR KR JM LY ZA BV NA DE HM GY CO NZ TR ME LI HT MT GI UG CR BO CN MX CC PH BY JE KW JP WF NP SE AU CK GT TN BI MD PN BA SO PG TL MS VU GD KG GF KN MN KM MF GB CY BS UA SH VI CG TT GQ LR BT LU CX GM BE DO EC EE SM FK KI GU BJ SA AF MY PE GL TV SJ WS YE MR AT AD MO EH CH ET AG LV SD SL NI TW SV KH AZ IN HU TD BR ML UY IM ST FO CZ SZ GN GA NF SI KP KE NC NL SN VA AI RW AE KZ MK MP ID AO PW MA RS AL TF IS HN HR DM DJ NO PY MW BZ NG IE PL VG CW MG LC SY RU BN AS GE GP MU GH VN CU BF LB MC CM IO BW JO KY RE SS MM BL VC SX MV FM HK LA CV FI EG FJ SC AQ DZ TG CI VE ES MH UM ER TK NU TC TJ PK UZ |
US |
email string the email address of the recipient | jrogers@example.com |
|
name string the name of the recipient required | Jack O'Rogers |
|
phone string the phone number of the recipient | (336) 222-7000 |
|
postal_code string the postal code / zip number of the recipient. Specific format depends on the country | 27215 |
|
state string the state of the recipient | NC |
|
street1 string the first line of the street address of the recipient required | 525 S. ZENKRAFT Ave |
|
street2 string the second line of the street address of the recipient | suite 120 |
|
street3 string the third line of the street address of the recipient | suite 120 |
|
references array |
|
|
type string type of reference | customer_reference |
|
value string value of the reference | ABC-000123 |
|
sender object Sender of shiment required |
|
|
city string the city of the recipient required | Burlington |
|
company string the company name of the recipient | Burlington Textiles Corp of America |
|
country string required | BB SK BH SR YT CA TM ZM TO AW IQ QA PS GG GR PR PT SG MQ TH IL BM CL AX BD LT IT BG MZ IR NE NR OM RO BQ CF US AR GW TZ CD GS AM PM PF SB PA LS LK ZW DK FR KR JM LY ZA BV NA DE HM GY CO NZ TR ME LI HT MT GI UG CR BO CN MX CC PH BY JE KW JP WF NP SE AU CK GT TN BI MD PN BA SO PG TL MS VU GD KG GF KN MN KM MF GB CY BS UA SH VI CG TT GQ LR BT LU CX GM BE DO EC EE SM FK KI GU BJ SA AF MY PE GL TV SJ WS YE MR AT AD MO EH CH ET AG LV SD SL NI TW SV KH AZ IN HU TD BR ML UY IM ST FO CZ SZ GN GA NF SI KP KE NC NL SN VA AI RW AE KZ MK MP ID AO PW MA RS AL TF IS HN HR DM DJ NO PY MW BZ NG IE PL VG CW MG LC SY RU BN AS GE GP MU GH VN CU BF LB MC CM IO BW JO KY RE SS MM BL VC SX MV FM HK LA CV FI EG FJ SC AQ DZ TG CI VE ES MH UM ER TK NU TC TJ PK UZ |
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 endpointlabel
for each package which needs to be printed and attached to the shipment
Field | Possible Values | Example |
---|---|---|
shipment object |
|
|
context object this object can contain custom data returned by the carrier |
|
|
costs object Additional information about packages |
|
|
base_charge number gross amount | 100 |
|
discounts number the cost of discounts applied | 0 |
|
net_charge number net amount | 80 |
|
surcharges number additional fees | 0 |
|
taxes number the cost of taxes | 20 |
|
id string shipment ID | 1f02d12868a54ed88b6cb4dafaad325d |
|
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 | unexpected_exception carrier_authentication carrier_label_generation_failed carrier_failed_connection carrier_timeout shipping_account_not_found carrier_unsupported_method shipping_account_wrong_carrier missing_api_key schema_validation_error invalid_phone_number carrier_throttling carrier_http_exception carrier_exception schema_field_required carrier_shipment_generation_failed wrong_api_key ship_date_past |
carrier_exception |
detail string This field can contain additional information about the error. This field is not meant to be shown to the end-user required |
|
|
message object Error message required | FedEx API: The origin country code XX could not be found. Please check the country code. |
/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 | GIF PDF ZPL PNG JPG |
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 | unexpected_exception carrier_authentication carrier_label_generation_failed carrier_failed_connection carrier_timeout shipping_account_not_found carrier_unsupported_method shipping_account_wrong_carrier missing_api_key schema_validation_error carrier_throttling carrier_http_exception carrier_exception schema_field_required wrong_api_key carrier_no_shipment_found |
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. |
/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 | es_PA he_IL luy_KE az_Latn ru_RU en_AU zh_Hans guz_KE uz_Cyrl_UZ am_ET ha_Latn_NE ja_JP or_IN pt_BR si_LK es_DO ti_ET de_CH nl_NL naq_NA bg_BG el_GR ar_MA fr_LU en_BE ee_TG kam_KE ki_KE pl_PL sr_Latn_BA ee_GH zh_Hans_HK ms_BN ps_AF ff_SN id_ID ar_LY kok_IN ne_NP ar_YE mer_KE es_HN fil_PH fr_ML fr_CG sw_TZ shi_Latn_MA ko_KR uk_UA fo_FO kw_GB az_Cyrl fr_MF es_GT en_IL om_ET af_ZA mas_KE dav_KE sw_KE de_BE pa_Guru ar_JO luo_KE uz_Cyrl az_Latn_AZ kk_Cyrl es_VE th_TH my_MM haw_US sr_Latn_ME uz_Arab_AF fr_CM nn_NO ar_KW ca_ES en_TT rw_RW sr_Latn pt_MZ ar_LB zh_Hans_MO bs_BA sg_CF ru_MD hi_IN de_DE es_AR bm_ML ii_CN fr_RW ne_IN pa_Arab_PK lt_LT es_BO en_IE en_ZA es_UY fr_TD lg_UG ur_IN as_IN en_JM es_PY es_CR fr_NE it_IT ta_IN ur_PK es_CO zh_Hant fr_CH nb_NO da_DK ml_IN km_KH sn_ZW ar_BH fr_CD mk_MK ro_RO kea_CV es_US to_TO fr_KM mfe_MU en_GU sv_SE fr_RE so_SO es_ES bez_TZ ig_NG ar_IQ kn_IN az_Cyrl_AZ uz_Arab en_BZ ti_ER en_GB ha_Latn nd_ZW en_CA nyn_UG kde_TZ kk_Cyrl_KZ en_PK rm_CH jmc_TZ en_HK ar_SD hu_HU sr_Cyrl_ME es_419 hr_HR fi_FI pa_Guru_IN ta_LK en_MU de_LU en_BW cgg_UG bn_BD khq_ML et_EE shi_Latn zu_ZA fr_BJ mr_IN ar_OM ka_GE en_IN lv_LV ro_MD de_AT cy_GB asa_TZ en_NA fr_CF fr_BL it_CH mg_MG fr_BE mt_MT fr_BI pt_GW pa_Arab ses_ML sk_SK be_BY en_PH sr_Latn_RS en_MP de_LI ha_Latn_GH bo_IN sr_Cyrl bem_ZM en_NZ te_IN zh_Hant_TW so_DJ ak_GH af_NA zh_Hans_CN ga_IE so_KE fr_MG sl_SI en_SG en_MT fr_FR rof_TZ es_GQ vun_TZ sq_AL zh_Hant_HK es_MX fr_TG cs_CZ fa_AF ms_MY chr_US hy_AM shi_Tfng el_CY vi_VN saq_KE ar_SY en_VI kl_GL sv_FI yo_NG fr_SN es_CL bn_IN fr_MC kab_DZ xog_UG rwk_TZ pt_PT zh_Hant_MO gsw_CH gv_GB ar_QA ebu_KE ar_TN eu_ES fr_GN en_US fa_IR es_PR en_ZW ar_EG en_AS en_MH fr_GA es_NI es_SV fr_DJ ha_Latn_NG es_EC fr_GP sr_Cyrl_RS tzm_Latn ar_SA fr_CA uz_Latn fr_GQ tr_TR fr_BF es_PE tzm_Latn_MA ar_DZ uz_Latn_UZ teo_UG en_UM bo_CN mas_TZ ru_UA fr_CI yue_Hant_HK ar_AE sr_Cyrl_BA om_KE so_ET seh_MZ gl_ES is_IS fr_MQ lag_TZ kln_KE teo_KE nl_BE shi_Tfng_MA zh_Hans_SG gu_IN |
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 | es_PA uz_Cyrl_UZ he_IL luy_KE az_Latn ru_RU en_AU zh_Hans guz_KE am_ET ha_Latn_NE ja_JP or_IN pt_BR si_LK es_DO te_IN ti_ET de_CH nl_NL naq_NA bg_BG el_GR ar_MA fr_LU en_BE ee_TG kam_KE ki_KE pl_PL sr_Latn_BA ee_GH zh_Hans_HK ms_BN ps_AF ff_SN id_ID ar_LY kok_IN ne_NP ar_YE mer_KE es_HN fil_PH fr_ML fr_CG sw_TZ shi_Latn_MA ko_KR uk_UA fo_FO kw_GB az_Cyrl fr_MF es_GT en_IL om_ET af_ZA mas_KE dav_KE sw_KE de_BE pa_Guru ar_JO luo_KE uz_Cyrl az_Latn_AZ kk_Cyrl es_VE th_TH my_MM haw_US sr_Latn_ME uz_Arab_AF fr_CM nn_NO ar_KW ca_ES en_TT rw_RW sr_Latn pt_MZ ar_LB zh_Hans_MO bs_BA sg_CF ru_MD hi_IN de_DE es_AR bm_ML ii_CN fr_RW ne_IN pa_Arab_PK lt_LT es_BO en_IE en_ZA es_UY fr_TD lg_UG ur_IN as_IN en_JM es_PY es_CR fr_NE it_IT ta_IN ur_PK es_CO zh_Hant fr_CH nb_NO da_DK ml_IN km_KH sn_ZW ar_BH fr_CD mk_MK ro_RO kea_CV es_US to_TO fr_KM mfe_MU en_GU sv_SE fr_RE so_SO es_ES bez_TZ ig_NG ar_IQ kn_IN az_Cyrl_AZ uz_Arab en_BZ ti_ER en_GB ha_Latn nd_ZW en_CA nyn_UG kde_TZ kk_Cyrl_KZ en_PK rm_CH jmc_TZ en_HK ar_SD hu_HU sr_Cyrl_ME es_419 hr_HR fi_FI pa_Guru_IN ta_LK en_MU de_LU en_BW cgg_UG bn_BD khq_ML et_EE shi_Latn zu_ZA nl_BE fr_BJ mr_IN ar_OM ka_GE en_IN lv_LV ro_MD de_AT cy_GB asa_TZ fr_CF fr_BL it_CH mg_MG fr_BE mt_MT fr_BI pt_GW pa_Arab ses_ML sk_SK be_BY en_PH sr_Latn_RS en_MP de_LI ha_Latn_GH bo_IN sr_Cyrl bem_ZM en_NZ zh_Hant_TW so_DJ ak_GH af_NA zh_Hans_CN ga_IE so_KE fr_MG sl_SI en_SG en_MT fr_FR rof_TZ es_GQ vun_TZ sq_AL zh_Hant_HK es_MX fr_TG cs_CZ fa_AF ms_MY chr_US hy_AM shi_Tfng el_CY vi_VN saq_KE ar_SY en_VI kl_GL sv_FI yo_NG fr_SN es_CL bn_IN fr_MC kab_DZ xog_UG rwk_TZ pt_PT zh_Hant_MO gsw_CH gv_GB ar_QA ebu_KE ar_TN eu_ES fr_GN en_US fa_IR es_PR en_ZW ar_EG en_AS en_MH fr_GA es_NI es_SV fr_DJ ha_Latn_NG es_EC fr_GP sr_Cyrl_RS tzm_Latn ar_SA fr_CA uz_Latn fr_GQ tr_TR fr_BF es_PE tzm_Latn_MA ar_DZ uz_Latn_UZ teo_UG en_UM bo_CN mas_TZ ru_UA fr_CI yue_Hant_HK ar_AE sr_Cyrl_BA om_KE so_ET seh_MZ gl_ES is_IS fr_MQ lag_TZ kln_KE teo_KE en_NA shi_Tfng_MA zh_Hans_SG gu_IN |
en_US |
status string the most recent important status description | Delivered to a mailbox |
|
tracking_number string Tracking number of shipment | 567293923024 |
|
tracking_stage string the most recent important status standardized shipment stage | CREATION_PENDING CREATED PICKED_UP IN_TRANSIT OUT_FOR_DELIVERY DRIVER_ASSIGNED CHECKED_IN DELIVERED SHIPMENT_VOIDED EXCEPTION |
DELIVERED |
Error Response
Field | Possible Values | Example |
---|---|---|
error object |
|
|
code string Standardized error code required | unexpected_exception carrier_authentication carrier_failed_connection carrier_timeout shipping_account_not_found carrier_unsupported_method shipping_account_wrong_carrier missing_api_key schema_validation_error carrier_throttling carrier_http_exception carrier_exception schema_field_required wrong_api_key carrier_no_shipment_found |
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 |
Batch tracking
You can pass several track objects into your API request to get results.
Request and response details are the same and can be checked here.
/cancel POST
The cancel endpoint allows you to cancel shipments with the carrier.
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 | es_PA he_IL luy_KE az_Latn ru_RU en_AU zh_Hans guz_KE uz_Cyrl_UZ am_ET ha_Latn_NE ja_JP or_IN pt_BR si_LK es_DO ti_ET de_CH nl_NL naq_NA bg_BG ar_MA fr_LU en_BE ee_TG kam_KE ki_KE pl_PL sr_Latn_BA ee_GH zh_Hans_HK ms_BN ps_AF ff_SN id_ID ar_LY kok_IN ne_NP ar_YE mer_KE es_HN fil_PH fr_ML fr_CG sw_TZ shi_Latn_MA ko_KR uk_UA fo_FO kw_GB az_Cyrl fr_MF es_GT en_IL om_ET af_ZA mas_KE dav_KE sw_KE de_BE pa_Guru ar_JO luo_KE uz_Cyrl az_Latn_AZ kk_Cyrl es_VE th_TH my_MM uz_Arab_AF sr_Latn_ME haw_US fr_CM nn_NO ar_KW ca_ES en_TT rw_RW sr_Latn pt_MZ ar_LB zh_Hans_MO bs_BA sg_CF ru_MD hi_IN de_DE es_AR bm_ML ii_CN fr_RW ne_IN pa_Arab_PK lt_LT es_BO en_IE en_ZA es_UY fr_TD lg_UG ur_IN as_IN en_JM es_PY es_CR fr_NE it_IT ta_IN ur_PK es_CO zh_Hant fr_CH nb_NO da_DK ml_IN km_KH sn_ZW ar_BH fr_CD mk_MK ro_RO kea_CV es_US to_TO fr_KM mfe_MU en_GU sv_SE fr_RE so_SO es_ES bez_TZ ig_NG ar_IQ kn_IN az_Cyrl_AZ uz_Arab en_BZ ti_ER en_GB ha_Latn nd_ZW en_CA nyn_UG kde_TZ kk_Cyrl_KZ en_PK rm_CH jmc_TZ en_HK ar_SD hu_HU sr_Cyrl_ME es_419 hr_HR fi_FI pa_Guru_IN ta_LK en_MU de_LU en_BW cgg_UG bn_BD khq_ML et_EE shi_Latn zu_ZA nl_BE fr_BJ mr_IN ar_OM ka_GE en_IN lv_LV ro_MD de_AT cy_GB asa_TZ en_NA fr_CF fr_BL it_CH mg_MG fr_BE mt_MT fr_BI pt_GW pa_Arab ses_ML sk_SK be_BY en_PH sr_Latn_RS en_MP de_LI ha_Latn_GH bo_IN sr_Cyrl bem_ZM en_NZ te_IN zh_Hant_TW so_DJ ak_GH af_NA zh_Hans_CN ga_IE so_KE fr_MG sl_SI en_SG en_MT fr_FR rof_TZ es_GQ vun_TZ sq_AL zh_Hant_HK es_MX fr_TG cs_CZ fa_AF ms_MY chr_US hy_AM shi_Tfng el_CY vi_VN saq_KE ar_SY en_VI kl_GL sv_FI yo_NG fr_SN es_CL bn_IN fr_MC kab_DZ xog_UG rwk_TZ pt_PT zh_Hant_MO gsw_CH gv_GB ar_QA ebu_KE ar_TN eu_ES fr_GN en_US fa_IR es_PR en_ZW ar_EG en_AS en_MH fr_GA es_NI es_SV fr_DJ ha_Latn_NG es_EC fr_GP sr_Cyrl_RS tzm_Latn ar_SA fr_CA uz_Latn fr_GQ tr_TR fr_BF es_PE tzm_Latn_MA ar_DZ uz_Latn_UZ teo_UG en_UM bo_CN mas_TZ ru_UA fr_CI yue_Hant_HK ar_AE sr_Cyrl_BA om_KE so_ET seh_MZ gl_ES is_IS fr_MQ lag_TZ kln_KE teo_KE el_GR shi_Tfng_MA zh_Hans_SG gu_IN |
en_US |
refresh boolean whether to force calling live carrier API. By default, we might return a fresh result from the cache |
|
|
shipping_account string Shipping account number required | 5190163571408896 |
|
test boolean calls created with test = true will be directed to the carrier test servers |
|
|
tracking_number string Tracking number of shipment required | 567293923024 |
|
webhooks boolean whether to allow webhook functionality for this shipment |
|
Successful Response
Field | Possible Values | Example |
---|---|---|
success object |
|
|
message string Message describing the action was performed successfully | Success! |
Error Response
Field | Possible Values | Example |
---|---|---|
error object |
|
|
code string Standardized error code required | unexpected_exception carrier_authentication carrier_failed_connection carrier_timeout shipping_account_not_found carrier_unsupported_method shipping_account_wrong_carrier missing_api_key schema_validation_error carrier_throttling carrier_http_exception carrier_exception schema_field_required wrong_api_key carrier_no_shipment_found |
carrier_no_shipment_found |
detail string This field can contain additional information about the error. This field is not meant to be shown to the end-user required |
|
|
message object Error message required | FedEx API: No shipment found with tracking number: 567293923024 |
/pickup/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 | ANG BAM HKD SZL TMT ARS XPF FJD ZMW PYG TWD QAR NOK COP KES MNT MDL KZT KRW STN RUB MWK KGS GBP GYD INR SVC RSD BSD HTG SLL MYR LSL DOP TJS SBD ALL TOP EUR AED XOF IDR MUR MXN MGA BWP YER CVE NAD SOS IMP VND AOA JEP SCR ERN ETB LAK SAR FKP CLP SGD BBD UZS LYD UYU CZK GNF NPR ZAR WST BGN KHR UAH HUF SHP SRD CAD PGK UGX HRK USD SPL PKR GEL LBP BMD GHS MZN MKD TND SYP BYN XCD IQD XDR IRR ISK EGP ILS TVD CDF MRU PEN SDG OMR MVR PLN SEK BND CNY RON TRY MMK NGN LKR LRD BZD JOD AMD CUP KWD BDT KYD TTD TZS MAD NZD KMF JMD PHP DKK AFN RWF DJF CUC AZN GTQ BIF AWG MOP VUV XAF THB PAB CHF KPW GGP GIP BTN HNL JPY GMD BHD CRC BOB ZWD DZD VEF NIO AUD BRL |
|
debug boolean calls with debug=true will be logged |
|
|
description string |
|
|
dim_units string Dimension units of the packages, inches or centimeters required | IN CM |
IN |
end_date string End of the range of dates to check required | 2021-06-04 |
|
location object required |
|
|
city string the city of the recipient required | Burlington |
|
company string the company name of the recipient | Burlington Textiles Corp of America |
|
country string required | BB SK BH SR YT CA TM ZM TO AW IQ QA PS GG GR PR PT SG MQ TH IL BM CL AX BD LT IT BG MZ IR NE NR OM RO BQ CF US AR GW TZ CD GS AM PM PF SB PA LS LK ZW DK FR KR JM LY ZA BV NA DE HM GY CO TR NZ LI ME HT MT GI UG CR BO CN MX CC PH BY JE KW JP WF NP SE AU CK GT TN BI MD PN BA SO PG TL MS VU GD KG GF KN MN KM MF GB CY BS UA SH VI CG TT GQ LR BT LU CX GM BE DO EC EE SM FK KI GU BJ SA AF MY PE GL TV SJ WS YE MR AT AD MO EH CH ET AG LV SD SL NI TW SV KH AZ IN HU TD BR ML UY IM ST FO CZ SZ GN GA NF SI KP KE NC NL SN VA AI RW AE KZ MK MP ID AO PW MA RS AL TF IS HN HR DM DJ NO PY MW BZ NG IE PL VG CW MG LC SY RU BN AS GE GP MU GH VN CU BF LB MC CM IO BW JO KY RE SS MM BL VC SX MV FM HK LA CV FI EG FJ SC AQ DZ TG CI VE ES MH UM ER TK NU TC TJ PK UZ |
US |
email string the email address of the recipient | jrogers@example.com |
|
location_type string description of the pickup location required | front |
|
name string the name of the recipient required | Jack O'Rogers |
|
phone string the phone number of the recipient required | (336) 222-7000 |
|
postal_code string the postal code / zip number of the recipient. Specific format depends on the country | 27215 |
|
state string the state of the recipient | NC |
|
street1 string the first line of the street address of the recipient required | 525 S. ZENKRAFT Ave |
|
street2 string the second line of the street address of the recipient | suite 120 |
|
street3 string the third line of the street address of the recipient | suite 120 |
|
ready_time string Reserved for future use | 2021-06-04 |
|
shipments array required |
|
|
packages array required |
|
|
height number height of the package according to units specified under dim_units | 5 |
|
length number length of the package according to units specified under dim_units. ususally the length needs to be the largest of length, width, height | 11 |
|
value number value of the package according to currency specified | 25 |
|
weight number weight of the package according to units specified under weight_units | 4.2 |
|
width number width of the package according to units specified under dim_units | 8.5 |
|
recipient object Recipient of shiment |
|
|
city string the city of the recipient required | Burlington |
|
company string the company name of the recipient | Burlington Textiles Corp of America |
|
country string required | BB SK BH SR YT CA TM ZM TO AW IQ QA PS GG GR PR PT SG MQ TH IL BM CL AX BD LT IT BG MZ IR NE NR OM RO BQ CF US AR GW TZ CD GS AM PM PF SB PA LS LK ZW DK FR KR JM LY ZA BV NA DE HM GY CO TR NZ LI ME HT MT GI UG CR BO CN MX CC PH BY JE KW JP WF NP SE AU CK GT TN BI MD PN BA SO PG TL MS VU GD KG GF KN MN KM MF GB CY BS UA SH VI CG TT GQ LR BT LU CX GM BE DO EC EE SM FK KI GU BJ SA AF MY PE GL TV SJ WS YE MR AT AD MO EH CH ET AG LV SD SL NI TW SV KH AZ IN HU TD BR ML UY IM ST FO CZ SZ GN GA NF SI KP KE NC NL SN VA AI RW AE KZ MK MP ID AO PW MA RS AL TF IS HN HR DM DJ NO PY MW BZ NG IE PL VG CW MG LC SY RU BN AS GE GP MU GH VN CU BF LB MC CM IO BW JO KY RE SS MM BL VC SX MV FM HK LA CV FI EG FJ SC AQ DZ TG CI VE ES MH UM ER TK NU TC TJ PK UZ |
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 | IN CM |
IN |
shipping_account string Shipping account number required | 5190163571408896 |
|
test boolean calls created with test = true will be directed to the carrier test servers |
|
|
weight_units string Weight units of the packages, pounds or kilograms | KG LB |
LB |
Error Response
Field | Possible Values | Example |
---|---|---|
error object |
|
|
code string Standardized error code required | carrier_authentication unexpected_exception carrier_failed_connection carrier_timeout shipping_account_not_found carrier_unsupported_method shipping_account_wrong_carrier missing_api_key schema_validation_error invalid_phone_number carrier_throttling carrier_http_exception carrier_exception schema_field_required wrong_api_key ship_date_past |
carrier_exception |
detail string This field can contain additional information about the error. This field is not meant to be shown to the end-user required |
|
|
message object Error message required | FedEx API: The origin country code XX could not be found. Please check the country code. |
/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 | ANG BAM HKD SZL TMT ARS XPF FJD ZMW PYG TWD QAR NOK KES COP MNT MDL KZT KRW STN RUB MWK KGS GBP GYD INR SVC RSD BSD HTG SLL MYR LSL DOP TJS SBD ALL EUR TOP AED XOF IDR MUR MXN MGA BWP YER CVE NAD SOS IMP VND AOA JEP SCR ERN ETB LAK SAR FKP CLP SGD BBD UZS LYD UYU CZK GNF NPR ZAR WST BGN KHR UAH HUF SHP SRD CAD PGK UGX HRK USD SPL PKR GEL LBP BMD GHS MZN MKD TND SYP BYN XCD IQD XDR IRR ISK EGP ILS TVD CDF MRU PEN SDG OMR MVR PLN SEK BND CNY RON TRY MMK NGN LKR LRD BZD JOD AMD CUP KWD BDT KYD TTD TZS MAD NZD KMF JMD PHP DKK AFN RWF DJF CUC AZN GTQ BIF AWG MOP VUV XAF THB PAB CHF KPW GGP GIP BTN HNL JPY GMD BHD CRC BOB ZWD DZD VEF NIO AUD BRL |
|
debug boolean calls with debug=true will be logged |
|
|
description string |
|
|
dim_units string Dimension units of the packages, inches or centimeters required | IN CM |
IN |
location object required |
|
|
city string the city of the recipient required | Burlington |
|
company string the company name of the recipient | Burlington Textiles Corp of America |
|
country string required | BB SK BH SR YT CA TM ZM TO AW IQ QA PS GG GR PR PT SG MQ TH IL BM CL AX BD LT IT BG MZ IR NE NR OM RO BQ CF US AR GW TZ CD GS AM PM PF SB PA LS LK ZW DK FR KR JM LY ZA BV NA DE HM GY CO NZ TR ME LI HT MT GI UG CR BO CN MX CC PH BY JE KW JP WF NP SE AU CK GT TN BI MD PN BA SO PG TL MS VU GD KG GF KN MN KM MF GB CY BS UA SH VI CG TT GQ LR BT LU CX GM BE DO EC EE SM FK KI GU BJ SA AF MY PE GL TV SJ WS YE MR AT AD MO EH CH ET AG LV SD SL NI TW SV KH AZ IN HU TD BR ML UY IM ST FO CZ SZ GN GA NF SI KP KE NC NL SN VA AI RW AE KZ MK MP ID AO PW MA RS AL TF IS HN HR DM DJ NO PY MW BZ NG IE PL VG CW MG LC SY RU BN AS GE GP MU GH VN CU BF LB MC CM IO BW JO KY RE SS MM BL VC SX MV FM HK LA CV FI EG FJ SC AQ DZ TG CI VE ES MH UM ER TK NU TC TJ PK UZ |
US |
email string the email address of the recipient | jrogers@example.com |
|
location_type string description of the pickup location required | front |
|
name string the name of the recipient required | Jack O'Rogers |
|
phone string the phone number of the recipient required | (336) 222-7000 |
|
postal_code string the postal code / zip number of the recipient. Specific format depends on the country | 27215 |
|
state string the state of the recipient | NC |
|
street1 string the first line of the street address of the recipient required | 525 S. ZENKRAFT Ave |
|
street2 string the second line of the street address of the recipient | suite 120 |
|
street3 string the third line of the street address of the recipient | suite 120 |
|
shipments array required |
|
|
packages array required |
|
|
height number height of the package according to units specified under dim_units | 5 |
|
length number length of the package according to units specified under dim_units. ususally the length needs to be the largest of length, width, height | 11 |
|
value number value of the package according to currency specified | 25 |
|
weight number weight of the package according to units specified under weight_units | 4.2 |
|
width number width of the package according to units specified under dim_units | 8.5 |
|
recipient object Recipient of shiment |
|
|
city string the city of the recipient required | Burlington |
|
company string the company name of the recipient | Burlington Textiles Corp of America |
|
country string required | BB SK BH SR YT CA TM ZM TO AW IQ QA PS GG GR PR PT SG MQ TH IL BM CL AX BD LT IT BG MZ IR NE NR OM RO BQ CF US AR GW TZ CD GS AM PM PF SB PA LS LK ZW DK FR KR JM LY ZA BV NA DE HM GY CO NZ TR ME LI HT MT GI UG CR BO CN MX CC PH BY JE KW JP WF NP SE AU CK GT TN BI MD PN BA SO PG TL MS VU GD KG GF KN MN KM MF GB CY BS UA SH VI CG TT GQ LR BT LU CX GM BE DO EC EE SM FK KI GU BJ SA AF MY PE GL TV SJ WS YE MR AT AD MO EH CH ET AG LV SD SL NI TW SV KH AZ IN HU TD BR ML UY IM ST FO CZ SZ GN GA NF SI KP KE NC NL SN VA AI RW AE KZ MK MP ID AO PW MA RS AL TF IS HN HR DM DJ NO PY MW BZ NG IE PL VG CW MG LC SY RU BN AS GE GP MU GH VN CU BF LB MC CM IO BW JO KY RE SS MM BL VC SX MV FM HK LA CV FI EG FJ SC AQ DZ TG CI VE ES MH UM ER TK NU TC TJ PK UZ |
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 | ANG BAM HKD SZL TMT ARS XPF FJD ZMW PYG TWD QAR NOK KES COP MNT MDL KZT KRW STN RUB MWK KGS GBP GYD INR SVC RSD BSD HTG SLL MYR LSL DOP TJS SBD ALL TOP EUR AED XOF IDR MUR MXN MGA BWP YER CVE NAD SOS IMP VND AOA JEP SCR ERN ETB LAK SAR FKP CLP SGD BBD UZS LYD UYU CZK GNF NPR ZAR WST BGN KHR UAH HUF SHP SRD CAD PGK UGX HRK USD SPL PKR GEL LBP BMD GHS MZN MKD TND SYP BYN XCD IQD XDR IRR ISK EGP ILS TVD CDF MRU PEN SDG OMR MVR PLN SEK BND CNY RON TRY MMK NGN LKR LRD BZD JOD AMD CUP KWD BDT KYD TTD TZS MAD NZD KMF JMD PHP DKK AFN RWF DJF CUC AZN GTQ BIF AWG MOP VUV XAF THB PAB CHF KPW GGP GIP BTN HNL JPY GMD BHD CRC BOB ZWD DZD VEF NIO AUD BRL |
|
debug boolean calls with debug=true will be logged |
|
|
description string |
|
|
dim_units string Dimension units of the packages, inches or centimeters required | IN CM |
IN |
id string internal pickup ID | cf8a402288034fd9941dc1efe22b0680 |
|
location object required |
|
|
city string the city of the recipient required | Burlington |
|
company string the company name of the recipient | Burlington Textiles Corp of America |
|
country string required | BB SK BH SR YT CA TM ZM TO AW IQ QA PS GG GR PR PT SG MQ TH IL BM CL AX BD LT IT BG MZ IR NE NR OM RO BQ CF US AR GW TZ CD GS AM PM PF SB PA LS LK ZW DK FR KR JM LY ZA BV NA DE HM GY CO NZ TR LI ME HT MT GI UG CR BO CN MX CC PH BY JE KW JP WF NP SE AU CK GT TN BI MD PN BA SO PG TL MS VU GD KG GF KN MN KM MF GB CY BS UA SH VI CG TT GQ LR BT LU CX GM BE DO EC EE SM FK KI GU BJ SA AF MY PE GL TV SJ WS YE MR AT AD MO EH CH ET AG LV SD SL NI TW SV KH AZ IN HU TD BR ML UY IM ST FO CZ SZ GN GA NF SI KP KE NC NL SN VA AI RW AE KZ MK MP ID AO PW MA RS AL TF IS HN HR DM DJ NO PY MW BZ NG IE PL VG CW MG LC SY RU BN AS GE GP MU GH VN CU BF LB MC CM IO BW JO KY RE SS MM BL VC SX MV FM HK LA CV FI EG FJ SC AQ DZ TG CI VE ES MH UM ER TK NU TC TJ PK UZ |
US |
email string the email address of the recipient | jrogers@example.com |
|
location_type string description of the pickup location required | front |
|
name string the name of the recipient required | Jack O'Rogers |
|
phone string the phone number of the recipient required | (336) 222-7000 |
|
postal_code string the postal code / zip number of the recipient. Specific format depends on the country | 27215 |
|
state string the state of the recipient | NC |
|
street1 string the first line of the street address of the recipient required | 525 S. ZENKRAFT Ave |
|
street2 string the second line of the street address of the recipient | suite 120 |
|
street3 string the third line of the street address of the recipient | suite 120 |
|
shipments array required |
|
|
packages array required |
|
|
height number height of the package according to units specified under dim_units | 5 |
|
length number length of the package according to units specified under dim_units. ususally the length needs to be the largest of length, width, height | 11 |
|
value number value of the package according to currency specified | 25 |
|
weight number weight of the package according to units specified under weight_units | 4.2 |
|
width number width of the package according to units specified under dim_units | 8.5 |
|
recipient object Recipient of shiment |
|
|
city string the city of the recipient required | Burlington |
|
company string the company name of the recipient | Burlington Textiles Corp of America |
|
country string required | BB SK BH SR YT CA TM ZM TO AW IQ QA PS GG GR PR PT SG MQ TH IL BM CL AX BD LT IT BG MZ IR NE NR OM RO BQ CF US AR GW TZ CD GS AM PM PF SB PA LS LK ZW DK FR KR JM LY ZA BV NA DE HM GY CO NZ TR LI ME HT MT GI UG CR BO CN MX CC PH BY JE KW JP WF NP SE AU CK GT TN BI MD PN BA SO PG TL MS VU GD KG GF KN MN KM MF GB CY BS UA SH VI CG TT GQ LR BT LU CX GM BE DO EC EE SM FK KI GU BJ SA AF MY PE GL TV SJ WS YE MR AT AD MO EH CH ET AG LV SD SL NI TW SV KH AZ IN HU TD BR ML UY IM ST FO CZ SZ GN GA NF SI KP KE NC NL SN VA AI RW AE KZ MK MP ID AO PW MA RS AL TF IS HN HR DM DJ NO PY MW BZ NG IE PL VG CW MG LC SY RU BN AS GE GP MU GH VN CU BF LB MC CM IO BW JO KY RE SS MM BL VC SX MV FM HK LA CV FI EG FJ SC AQ DZ TG CI VE ES MH UM ER TK NU TC TJ PK UZ |
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 | unexpected_exception carrier_authentication carrier_failed_connection carrier_timeout shipping_account_not_found carrier_unsupported_method shipping_account_wrong_carrier missing_api_key schema_validation_error invalid_phone_number carrier_throttling carrier_http_exception carrier_exception schema_field_required wrong_api_key ship_date_past |
carrier_exception |
detail string This field can contain additional information about the error. This field is not meant to be shown to the end-user required |
|
|
message object Error message required | FedEx API: The origin country code XX could not be found. Please check the country code. |
/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 | BB SK BH SR YT CA TM ZM TO AW IQ QA PS GG GR PR PT SG MQ TH IL BM CL AX BD LT IT BG MZ IR NE NR OM RO BQ CF US AR GW TZ CD GS AM PM PF SB PA LS LK ZW DK FR KR JM LY ZA BV NA DE GY HM CO NZ TR LI ME HT MT GI UG CR BO CN MX CC PH BY JE KW JP WF NP SE AU CK GT TN BI MD PN BA SO PG TL MS VU GD KG GF KN MN KM MF GB CY BS UA SH VI CG TT GQ LR BT LU CX GM BE DO EC EE SM FK KI GU BJ SA AF MY PE GL TV SJ WS YE MR AT AD MO EH CH ET AG LV SD SL NI TW SV KH AZ IN HU TD BR ML UY IM ST FO CZ SZ GN GA NF SI KP KE NC NL SN VA AI RW AE KZ MK MP ID AO PW MA RS AL TF IS HN HR DM DJ NO PY MW BZ NG IE PL VG CW MG LC SY RU BN AS GE GP MU GH VN CU BF LB MC CM IO BW JO KY RE SS MM BL VC SX MV FM HK LA CV FI EG FJ SC AQ DZ TG CI VE ES MH UM ER TK NU TC TJ PK UZ |
US |
email string the email address of the recipient | jrogers@example.com |
|
name string the name of the recipient required | Jack O'Rogers |
|
phone string the phone number of the recipient | (336) 222-7000 |
|
postal_code string the postal code / zip number of the recipient. Specific format depends on the country | 27215 |
|
state string the state of the recipient | NC |
|
street1 string the first line of the street address of the recipient required | 525 S. ZENKRAFT Ave |
|
street2 string the second line of the street address of the recipient | suite 120 |
|
street3 string the third line of the street address of the recipient | suite 120 |
|
shipping_account string Shipping account number required | 5190163571408896 |
|
test boolean calls created with test = true will be directed to the carrier test servers |
|
Successful Response
Field | Possible Values | Example |
---|---|---|
locations array |
|
|
city string | Burlington |
|
country string | AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW |
US |
distance number how far is it from the location described in the request to this pickup location | 1.3 |
|
distance_units string | km |
|
lat string latitude | -79.43575121732864 |
|
lng string longitude | 36.089788917096016 |
|
location_code string carrier assigned location ID | A4415567 |
|
location_name string name of the business/post office | United States Postal Service |
|
location_type string the type of this pickup location | post_office |
|
postal_code string | 27215 |
|
state string | NC |
|
street1 string | 405 Maple Ave |
Error Response
Field | Possible Values | Example |
---|---|---|
error object |
|
|
code string Standardized error code required | unexpected_exception carrier_authentication carrier_failed_connection carrier_timeout shipping_account_not_found carrier_unsupported_method shipping_account_wrong_carrier missing_api_key schema_validation_error carrier_throttling carrier_http_exception carrier_exception schema_field_required wrong_api_key |
carrier_exception |
detail string This field can contain additional information about the error. This field is not meant to be shown to the end-user required |
|
|
message string Error message required | FedEx API: Postal code specified is not in the correct format |
/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 | unexpected_exception carrier_authentication carrier_failed_connection carrier_timeout shipping_account_not_found carrier_unsupported_method shipping_account_wrong_carrier missing_api_key schema_validation_error carrier_throttling carrier_http_exception carrier_exception schema_field_required wrong_api_key carrier_large_manifest |
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 |
/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 |
/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.in_transit shipment.shipment_voided shipment.out_for_delivery return.checked_in shipment.exception return.picked_up shipment.created return.exception return.creation_pending shipment.creation_pending return.created return.delivered shipment.picked_up return.out_for_delivery shipment.checked_in shipment.in_transit return.driver_assigned shipment.delivered return.shipment_voided shipment.driver_assigned |
shipment.delivered |
format string Currently only JSON is supported. Used for future compatibility | json |
|
headers array Headers that will be sent to the webhook callback. |
|
|
name string | Authorization |
|
value string | api_key |
|
name string Webhook name |
|
|
shipping_account_id integer | 123 |
|
trigger_mode string | 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.in_transit shipment.shipment_voided shipment.out_for_delivery return.checked_in shipment.exception return.picked_up shipment.created return.exception return.creation_pending shipment.creation_pending return.created return.delivered shipment.picked_up return.out_for_delivery shipment.checked_in shipment.in_transit return.driver_assigned shipment.delivered return.shipment_voided shipment.driver_assigned |
shipment.delivered |
format string Currently only JSON is supported. Used for future compatibility | json |
|
headers array Headers that will be sent to the webhook callback. |
|
|
name string | Authorization |
|
value string | api_key |
|
id string ID of the subscription | 484fe753dcda47a1b817456f3a10e38e |
|
name string Webhook name |
|
|
shipping_account_id integer | 123 |
|
trigger_mode string | stage checkpoint |
|
Error Response
Field | Possible Values | Example |
---|---|---|
error object |
|
|
code string Standardized error code required | missing_api_key wrong_api_key shipping_account_not_found shipping_account_wrong_carrier schema_validation_error schema_field_required unexpected_exception |
|
detail string This field can contain additional information about the error. This field is not meant to be shown to the end-user required |
|
|
message string Error message required | Missing zkkey HTTP header containing your Zenkraft API key |
/webhook GET
This endpoint allows you to retrieve previously created webhooks.
Successful Response
Field | Possible Values | Example |
---|---|---|
webhooks array |
|
|
api_version string The webhook version. Used for future compatibility | v1 |
|
callback string URL of the receiving endpoint | https://webhook.site/3a788dd3-bd7c-44a8-bae0-297e3b68b508 |
|
debug boolean calls with debug=true will be logged |
|
|
description string Webhook description |
|
|
events array Events to receive. If left empty, it's assumed you want to receive all the events | return.in_transit shipment.shipment_voided shipment.out_for_delivery return.checked_in shipment.exception return.picked_up shipment.created return.exception return.creation_pending shipment.creation_pending return.created return.delivered shipment.picked_up return.out_for_delivery shipment.checked_in shipment.in_transit return.driver_assigned shipment.delivered return.shipment_voided shipment.driver_assigned |
shipment.delivered |
format string Currently only JSON is supported. Used for future compatibility | json |
|
headers array Headers that will be sent to the webhook callback. |
|
|
name string | Authorization |
|
value string | api_key |
|
id string ID of the subscription | 484fe753dcda47a1b817456f3a10e38e |
|
name string Webhook name |
|
|
shipping_account_id integer | 123 |
|
trigger_mode string | stage checkpoint |
|
Error Response
Field | Possible Values | Example |
---|---|---|
error object |
|
|
code string Standardized error code required | missing_api_key wrong_api_key shipping_account_not_found shipping_account_wrong_carrier schema_validation_error schema_field_required unexpected_exception |
|
detail string This field can contain additional information about the error. This field is not meant to be shown to the end-user required |
|
|
message string Error message required | Missing zkkey HTTP header containing your Zenkraft API key |
/webhook/{webhook_id} PUT
This endpoint allows you to put the webhook.
PUT Request Parameters
Field | Possible Values | Example |
---|---|---|
webhook object |
|
|
api_version string The webhook version. Used for future compatibility | v1 |
|
callback string URL of the receiving endpoint required | https://webhook.site/3a788dd3-bd7c-44a8-bae0-297e3b68b508 |
|
debug boolean calls with debug=true will be logged |
|
|
description string Webhook description |
|
|
events array Events to receive. If left empty, it's assumed you want to receive all the events | return.in_transit shipment.shipment_voided shipment.out_for_delivery return.checked_in shipment.exception return.picked_up shipment.created return.exception return.creation_pending shipment.creation_pending return.created return.delivered shipment.picked_up return.out_for_delivery shipment.checked_in shipment.in_transit return.driver_assigned shipment.delivered return.shipment_voided shipment.driver_assigned |
shipment.delivered |
format string Currently only JSON is supported. Used for future compatibility | json |
|
headers array Headers that will be sent to the webhook callback. |
|
|
name string | Authorization |
|
value string | api_key |
|
name string Webhook name |
|
|
shipping_account_id integer | 123 |
|
trigger_mode string | 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.in_transit shipment.shipment_voided shipment.out_for_delivery return.checked_in shipment.exception return.picked_up shipment.created return.exception return.creation_pending shipment.creation_pending return.created return.delivered shipment.picked_up return.out_for_delivery shipment.checked_in shipment.in_transit return.driver_assigned shipment.delivered return.shipment_voided shipment.driver_assigned |
shipment.delivered |
format string Currently only JSON is supported. Used for future compatibility | json |
|
headers array Headers that will be sent to the webhook callback. |
|
|
name string | Authorization |
|
value string | api_key |
|
id string ID of the subscription | 484fe753dcda47a1b817456f3a10e38e |
|
name string Webhook name |
|
|
shipping_account_id integer | 123 |
|
trigger_mode string | 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 | unexpected_exception webhook_not_found shipping_account_not_found shipping_account_wrong_carrier missing_api_key schema_validation_error schema_field_required wrong_api_key |
|
detail string This field can contain additional information about the error. This field is not meant to be shown to the end-user required |
|
|
message string Error message required | No webhook exists with that ID |
/webhook/{webhook_id} DELETE
This endpoint allows you to delete the specific webhook.
DELETE Request Parameters
Field | Possible Values | Example |
---|---|---|
webhook_id object ID of the previously created webhook returned from POST on /webhook required |
|
Successful Response
Field | Possible Values | Example |
---|---|---|
success object required |
|
|
message string Message describing the action was performed successfully | Success! |
Error Response
Field | Possible Values | Example |
---|---|---|
error object |
|
|
code string Standardized error code. If the code equals `carrier_large_manifest` you might retrieve manifest_id from the error detail required | unexpected_exception webhook_not_found shipping_account_not_found shipping_account_wrong_carrier missing_api_key schema_validation_error schema_field_required wrong_api_key |
|
detail string This field can contain additional information about the error. This field is not meant to be shown to the end-user required |
|
|
message string Error message required | No webhook exists with that ID |
/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 | 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 |
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
/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 | drop_off pickup |
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 |
/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 | drop_off pickup |
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 |
/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 | drop_off pickup |
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 |
/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! |
/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 | drop_off pickup |
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 |
/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 | not_equals in not_in equals |
|
value string | BB SK BH SR YT CA TM ZM TO AW IQ QA PS GG GR PR PT SG MQ TH IL BM CL AX BD LT IT BG MZ IR NE NR OM RO BQ CF US AR GW TZ CD GS AM PM PF SB PA LS LK ZW DK FR KR JM LY ZA BV NA DE HM GY TR CO NZ ME LI HT MT GI UG CR BO CN MX CC PH BY JE KW JP WF NP SE AU CK GT TN BI MD PN BA SO PG TL MS VU GD KG GF KN MN KM MF GB CY BS UA SH VI CG TT GQ LR BT LU CX GM BE DO EC EE SM FK KI GU BJ SA AF MY PE GL TV SJ WS YE MR AT AD MO EH CH ET AG LV SD SL NI TW SV KH AZ IN HU TD BR ML UY IM ST FO CZ SZ GN GA NF SI KP KE NC NL SN VA AI RW AE KZ MK MP ID AO PW MA RS AL TF IS HN HR DM DJ NO PY MW BZ NG IE PL VG CW MG LC SY RU BN AS GE GP MU GH VN CU BF LB MC CM IO BW JO KY RE SS MM BL VC SX MV FM HK LA CV FI EG FJ SC AQ DZ TG CI VE ES MH UM ER TK NU TC TJ PK UZ |
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 | not_equals in not_in equals |
|
value string | BB SK BH SR YT CA TM ZM TO AW IQ QA PS GG GR PR PT SG MQ TH IL BM CL AX BD LT IT BG MZ IR NE NR OM RO BQ CF US AR GW TZ CD GS AM PM PF SB PA LS LK ZW DK FR KR JM LY ZA BV NA DE HM GY CO TR NZ LI ME HT MT GI UG CR BO CN MX CC PH BY JE KW JP WF NP SE AU CK GT TN BI MD PN BA SO PG TL MS VU GD KG GF KN MN KM MF GB CY BS UA SH VI CG TT GQ LR BT LU CX GM BE DO EC EE SM FK KI GU BJ SA AF MY PE GL TV SJ WS YE MR AT AD MO EH CH ET AG LV SD SL NI TW SV KH AZ IN HU TD BR ML UY IM ST FO CZ SZ GN GA NF SI KP KE NC NL SN VA AI RW AE KZ MK MP ID AO PW MA RS AL TF IS HN HR DM DJ NO PY MW BZ NG IE PL VG CW MG LC SY RU BN AS GE GP MU GH VN CU BF LB MC CM IO BW JO KY RE SS MM BL VC SX MV FM HK LA CV FI EG FJ SC AQ DZ TG CI VE ES MH UM ER TK NU TC TJ PK UZ |
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 | drop_off pickup |
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 |
/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 | not_equals in not_in equals |
|
value string | BB SK BH SR YT CA TM ZM TO AW IQ QA PS GG GR PR PT SG MQ TH IL BM CL AX BD LT IT BG MZ IR NE NR OM RO BQ CF US AR GW TZ CD GS AM PM PF SB PA LS LK ZW DK FR KR JM LY ZA BV NA DE HM GY CO TR NZ LI ME HT MT GI UG CR BO CN MX CC PH BY JE KW JP WF NP SE AU CK GT TN BI MD PN BA SO PG TL MS VU GD KG GF KN MN KM MF GB CY BS UA SH VI CG TT GQ LR BT LU CX GM BE DO EC EE SM FK KI GU BJ SA AF MY PE GL TV SJ WS YE MR AT AD MO EH CH ET AG LV SD SL NI TW SV KH AZ IN HU TD BR ML UY IM ST FO CZ SZ GN GA NF SI KP KE NC NL SN VA AI RW AE KZ MK MP ID AO PW MA RS AL TF IS HN HR DM DJ NO PY MW BZ NG IE PL VG CW MG LC SY RU BN AS GE GP MU GH VN CU BF LB MC CM IO BW JO KY RE SS MM BL VC SX MV FM HK LA CV FI EG FJ SC AQ DZ TG CI VE ES MH UM ER TK NU TC TJ PK UZ |
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 | drop_off pickup |
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 |
Object References
currencies
Field | Type | Required | Min Length | Max Length |
locale
requested locale
Field | Type | Required | Min Length | Max Length |
countries
Field | Type | Required | Min Length | Max Length |
location
Field | Type | Required | Min Length | Max Length |
name | string | True | - | 35 |
company | string | - | 35 | |
street1 | string | True | - | 35 |
street2 | string | - | 35 | |
street3 | string | - | 35 | |
string | - | - | ||
phone | string | 10 | 15 | |
city | string | True | - | 35 |
state | string | - | 35 | |
postal_code | string | - | 20 | |
country | string | True | - | - |
packages
We need to know the size and dimensions of your packages.
Field | Type | Required | Min Length | Max Length |
weight | number | True | - | - |
value | number | - | - | |
length | number | - | - | |
width | number | - | - | |
height | number | - | - |
references
For carriers that allow you to add reference information to your shipment.
Field | Type | Required | Min Length | Max Length |
type | string | True | - | - |
value | string | True | - | - |
tracking_number
Tracking number of shipment
Field | Type | Required | Min Length | Max Length |
reference_number
some carriers allow you to track either by the tracking number or the reference number
Field | Type | Required | Min Length | Max Length |
confirmation_number
reference number of this pickup. It can be used to cancel the pickup if the carrier allows it
Field | Type | Required | Min Length | Max Length |
shipping_account
Shipping account number
Field | Type | Required | Min Length | Max Length |
special_services
Specific special services (e.g. COD or a Required Signature) depend on a carrier, so go through our documentation to find which those are
Field | Type | Required | Min Length | Max Length |
notifications
For carriers that allow you to set email/sms for notifications to your shippers.
Field | Type | Required | Min Length | Max Length |
type | string | True | - | - |
value | string | True | - | - |
customs_items
Additional information about packages
Field | Type | Required | Min Length | Max Length |
description | string | True | - | - |
quantity | integer | True | - | - |
value | number | True | - | - |
weight | number | True | - | - |
costs
Additional information about packages
Field | Type | Required | Min Length | Max Length |
base_charge | number | - | - | |
net_charge | number | - | - | |
taxes | number | - | - | |
surcharges | number | - | - | |
discounts | number | - | - |
shipping_documents
Additional information about packages
Field | Type | Required | Min Length | Max Length |
description | string | True | - | - |
document_type | string | True | - | - |
document | string | True | - | - |
carrier
the carrier name
Field | Type | Required | Min Length | Max Length |
status
the most recent important status description
Field | Type | Required | Min Length | Max Length |
tracking_stage
the most recent important status standardized shipment stage
Field | Type | Required | Min Length | Max Length |
label_type
the label format of the shipping labels
Field | Type | Required | Min Length | Max Length |
label_size
the shipping labels size
Field | Type | Required | Min Length | Max Length |
service
the service type
Field | Type | Required | Min Length | Max Length |
recipient
Recipient of shiment
Field | Type | Required | Min Length | Max Length |
name | string | True | - | 35 |
company | string | - | 35 | |
street1 | string | True | - | 35 |
street2 | string | - | 35 | |
street3 | string | - | 35 | |
string | - | - | ||
phone | string | 10 | 15 | |
city | string | True | - | 35 |
state | string | - | 35 | |
postal_code | string | - | 20 | |
country | string | True | - | - |
dim_units
Dimension units of the packages, inches or centimeters
Field | Type | Required | Min Length | Max Length |
weight_units
Weight units of the packages, pounds or kilograms
Field | Type | Required | Min Length | Max Length |
created
when was this object created
Field | Type | Required | Min Length | Max Length |
updated
when was this object updated
Field | Type | Required | Min Length | Max Length |
debug
calls with debug=true will be logged
Field | Type | Required | Min Length | Max Length |
base_shipment
Definition of the shipment payload
Field | Type | Required | Min Length | Max Length |
carrier | string | True | - | - |
shipping_account | string | True | - | - |
test | boolean | - | - | |
debug | boolean | - | - | |
ship_date | string | - | - | |
type | string | - | - | |
service | string | - | - | |
special_services | array | - | - | |
packaging | string | True | - | - |
dim_units | string | True | - | - |
weight_units | string | True | - | - |
currency | string | - | - | |
sender | object | True | - | - |
recipient | object | True | - | - |
packages | array | True | - | - |
shipment
Definition of the shipment payload
Field | Type | Required | Min Length | Max Length |
carrier | string | True | - | - |
shipping_account | string | True | - | - |
test | boolean | - | - | |
debug | boolean | - | - | |
ship_date | string | - | - | |
type | string | - | - | |
service | string | True | - | - |
special_services | array | - | - | |
packaging | string | True | - | - |
dim_units | string | True | - | - |
weight_units | string | True | - | - |
currency | string | - | - | |
sender | object | True | - | - |
recipient | object | True | - | - |
packages | array | True | - | - |
label_type | string | True | - | - |
label_size | string | - | - | |
include_base64_label | boolean | - | - | |
references | array | - | - | |
notifications | array | - | - |
shipment_id
shipment ID
Field | Type | Required | Min Length | Max Length |
shipment_status
Standardized shipment status
Field | Type | Required | Min Length | Max Length |
ship_response
Field | Type | Required | Min Length | Max Length |
shipment | True | - | - |
_shipment_status_response
Field | Type | Required | Min Length | Max Length |
shipment | True | - | - |
shipment_status_pending_response
Field | Type | Required | Min Length | Max Length |
shipment | True | - | - |
shipment_status_success_response
Field | Type | Required | Min Length | Max Length |
shipment | True | - | - |
rate
Definition of the shipment payload
Field | Type | Required | Min Length | Max Length |
carrier | string | True | - | - |
shipping_account | string | True | - | - |
test | boolean | - | - | |
debug | boolean | - | - | |
ship_date | string | - | - | |
type | string | - | - | |
service | string | - | - | |
special_services | array | - | - | |
packaging | string | True | - | - |
dim_units | string | True | - | - |
weight_units | string | True | - | - |
currency | string | - | - | |
sender | object | True | - | - |
recipient | object | True | - | - |
packages | array | True | - | - |
rate_response
Field | Type | Required | Min Length | Max Length |
rates | array | True | - | - |
pickup_response
Field | Type | Required | Min Length | Max Length |
pickup | object | True | - | - |
cancel_pickup_response
Field | Type | Required | Min Length | Max Length |
cancel | object | True | - | - |
pickup_availability_response
Field | Type | Required | Min Length | Max Length |
pickup_availability | object | True | - | - |
cancel_pickup
Field | Type | Required | Min Length | Max Length |
carrier | string | True | - | - |
shipping_account | string | True | - | - |
test | boolean | - | - | |
debug | boolean | - | - | |
confirmation_number | string | True | - | - |
_pickup
Field | Type | Required | Min Length | Max Length |
carrier | string | True | - | - |
shipping_account | string | True | - | - |
test | boolean | - | - | |
debug | boolean | - | - | |
description | string | - | - | |
currency | string | - | - | |
dim_units | string | True | - | - |
weight_units | string | True | - | - |
location | object | True | - | - |
shipments | array | True | - | - |
time | object | True | - | - |
__pickup
Field | Type | Required | Min Length | Max Length |
carrier | string | True | - | - |
shipping_account | string | True | - | - |
test | boolean | - | - | |
debug | boolean | - | - | |
description | string | - | - | |
currency | string | - | - | |
dim_units | string | True | - | - |
weight_units | string | True | - | - |
location | object | True | - | - |
shipments | array | True | - | - |
__track
Field | Type | Required | Min Length | Max Length |
carrier | string | True | - | - |
shipping_account | string | True | - | - |
test | boolean | - | - | |
debug | boolean | - | - | |
checkpoints | boolean | - | - | |
refresh | boolean | - | - | |
webhooks | boolean | - | - | |
locale | string | - | - |
track_by_tracking_number
Field | Type | Required | Min Length | Max Length |
carrier | string | True | - | - |
shipping_account | string | True | - | - |
test | boolean | - | - | |
debug | boolean | - | - | |
checkpoints | boolean | - | - | |
refresh | boolean | - | - | |
webhooks | boolean | - | - | |
locale | string | - | - | |
tracking_number | string | True | - | - |
track_by_reference_number
Field | Type | Required | Min Length | Max Length |
carrier | string | True | - | - |
shipping_account | string | True | - | - |
test | boolean | - | - | |
debug | boolean | - | - | |
checkpoints | boolean | - | - | |
refresh | boolean | - | - | |
webhooks | boolean | - | - | |
locale | string | - | - | |
reference_number | string | True | - | - |
track
Field | Type | Required | Min Length | Max Length |
carrier | string | True | - | - |
shipping_account | string | True | - | - |
test | boolean | - | - | |
debug | boolean | - | - | |
checkpoints | boolean | - | - | |
refresh | boolean | - | - | |
webhooks | boolean | - | - | |
locale | string | - | - | |
tracking_number | string | True | - | - |
estimated_delivery
estimated delivery date of this shipment
Field | Type | Required | Min Length | Max Length |
track_response
Field | Type | Required | Min Length | Max Length |
carrier | string | - | - | |
delivered | boolean | - | - | |
estimated_delivery | string | - | - | |
delivery_date | string | - | - | |
tracking_number | string | - | - | |
status | string | - | - | |
tracking_stage | string | - | - | |
locale | string | - | - | |
checkpoints | array | - | - |
manifest_id
carrier ID of this manifest which can be used in GET on /manifest/<manifest_id>
Field | Type | Required | Min Length | Max Length |
manifest_post_response
Field | Type | Required | Min Length | Max Length |
manifest | True | - | - |
manifest_get_response
Field | Type | Required | Min Length | Max Length |
manifest | True | - | - |
manifest_list_response
Field | Type | Required | Min Length | Max Length |
manifests | array | True | - | - |
webhook
Field | Type | Required | Min Length | Max Length |
name | string | - | - | |
description | string | - | - | |
debug | boolean | - | - | |
api_version | string | - | - | |
format | string | - | - | |
events | array | - | - | |
callback | string | True | - | - |
headers | array | - | - | |
shipping_account_id | integer | - | - | |
trigger_mode | string | - | - |
webhook_list_response
Field | Type | Required | Min Length | Max Length |
webhooks | array | True | - | - |
webhook_id
ID of the subscription
Field | Type | Required | Min Length | Max Length |
_webhook_response
Field | Type | Required | Min Length | Max Length |
name | string | - | - | |
description | string | - | - | |
debug | boolean | - | - | |
api_version | string | - | - | |
format | string | - | - | |
events | array | - | - | |
callback | string | True | - | - |
headers | array | - | - | |
shipping_account_id | integer | - | - | |
trigger_mode | string | - | - | |
id | string | - | - |
webhook_response
Field | Type | Required | Min Length | Max Length |
webhook | object | - | - |
dopu
Field | Type | Required | Min Length | Max Length |
carrier | string | True | - | - |
shipping_account | string | True | - | - |
test | boolean | - | - | |
debug | boolean | - | - | |
location | object | True | - | - |
dopu_response
Field | Type | Required | Min Length | Max Length |
locations | array | True | - | - |
shippingaccount_response
Carrier credentials
Field | Type | Required | Min Length | Max Length |
shipping_account | object | True | - | - |
error
Field | Type | Required | Min Length | Max Length |
error | object | True | - | - |
ship_error
Field | Type | Required | Min Length | Max Length |
error | object | True | - | - |
shipment_status_error
Field | Type | Required | Min Length | Max Length |
error | object | True | - | - |
rate_error
Field | Type | Required | Min Length | Max Length |
error | object | True | - | - |
shippingaccount_error
Field | Type | Required | Min Length | Max Length |
error | object | True | - | - |
track_error
Field | Type | Required | Min Length | Max Length |
error | object | True | - | - |
dopu_error
Field | Type | Required | Min Length | Max Length |
error | object | True | - | - |
pickup_error
Field | Type | Required | Min Length | Max Length |
error | object | True | - | - |
pickup_availability_error
Field | Type | Required | Min Length | Max Length |
error | object | True | - | - |
manifest_error
Field | Type | Required | Min Length | Max Length |
error | object | True | - | - |
webhook_error
Field | Type | Required | Min Length | Max Length |
error | object | True | - | - |
location_error
Field | Type | Required | Min Length | Max Length |
error | object | True | - | - |
successful_response
Field | Type | Required | Min Length | Max Length |
success | object | True | - | - |
UserBase
Field | Type | Required | Min Length | Max Length |
name | string | True | - | - |
string | True | - | - |
UserDetails
Field | Type | Required | Min Length | Max Length |
total_1_day | integer | True | - | - |
total_7_days | integer | True | - | - |
total_28_days | integer | True | - | - |
api_key | string | True | - | - |
user_token | string | True | - | - |
company | string | True | - | - |
created | string | True | - | - |
mfa | boolean | True | - | - |
User
Field | Type | Required | Min Length | Max Length |
name | string | True | - | - |
string | True | - | - | |
total_1_day | integer | True | - | - |
total_7_days | integer | True | - | - |
total_28_days | integer | True | - | - |
api_key | string | True | - | - |
user_token | string | True | - | - |
company | string | True | - | - |
created | string | True | - | - |
mfa | boolean | True | - | - |
log_item
Field | Type | Required | Min Length | Max Length |
id | string | - | - | |
created | string | - | - | |
status_code | number | - | - | |
url | string | - | - | |
ip_address | string | - | - |
LogDetails
Field | Type | Required | Min Length | Max Length |
id | string | - | - | |
created | string | - | - | |
status_code | number | - | - | |
url | string | - | - | |
ip_address | string | - | - | |
http_method | string | True | - | - |
user_agent | string | True | - | - |
content_type | string | True | - | - |
request | object | True | - | - |
response | object | True | - | - |
ShipmentCheckpoint
Field | Type | Required | Min Length | Max Length |
time | string | True | - | - |
status | string | True | - | - |
description | string | True | - | - |
ShipmentItem
Field | Type | Required | Min Length | Max Length |
id | string | True | - | - |
tracking_number | string | True | - | - |
reference_number | string | True | - | - |
carrier | string | True | - | - |
status | string | True | - | - |
created | string | True | - | - |
is_return | boolean | True | - | - |
ShipmentDetails
Field | Type | Required | Min Length | Max Length |
id | string | True | - | - |
tracking_number | string | True | - | - |
reference_number | string | True | - | - |
carrier | string | True | - | - |
status | string | True | - | - |
created | string | True | - | - |
is_return | boolean | True | - | - |
shipping_account_id | integer | True | - | - |
updated | string | True | - | - |
estimated_delivery | string | True | - | - |
checkpoints | array | True | - | - |
LocationBase
Field | Type | Required | Min Length | Max Length |
name | string | True | - | 35 |
company | string | True | - | 35 |
street1 | string | True | - | 35 |
street2 | string | - | 35 | |
street3 | string | - | 35 | |
string | True | - | - | |
phone | string | True | 10 | 15 |
city | string | True | - | 35 |
state | string | True | - | 35 |
postal_code | string | True | - | 20 |
country | string | True | - | - |
type | string | True | - | - |
timezone | string | - | - | |
cutoff_hours | integer | - | - | |
cutoff_minutes | integer | - | - |
Location
Field | Type | Required | Min Length | Max Length |
name | string | True | - | 35 |
company | string | True | - | 35 |
street1 | string | True | - | 35 |
street2 | string | - | 35 | |
street3 | string | - | 35 | |
string | True | - | - | |
phone | string | True | 10 | 15 |
city | string | True | - | 35 |
state | string | True | - | 35 |
postal_code | string | True | - | 20 |
country | string | True | - | - |
type | string | True | - | - |
timezone | string | - | - | |
cutoff_hours | integer | - | - | |
cutoff_minutes | integer | - | - | |
id | string | True | - | - |
updated | string | - | - |
return_method_type
Field | Type | Required | Min Length | Max Length |
return_line
Field | Type | Required | Min Length | Max Length |
quantity | integer | True | - | - |
value | number | True | - | - |
weight | number | True | - | - |
product_name | string | True | - | - |
line_id | string | True | - | - |
hs_code | string | True | - | - |
sku | string | True | - | - |
country_of_manufacture | string | True | - | - |
reasons | array | True | - | - |
operational_hours
Field | Type | Required | Min Length | Max Length |
open | string | True | - | - |
close | string | True | - | - |
return_cost
Field | Type | Required | Min Length | Max Length |
carrier_charge | number | True | - | - |
customer_charge | number | True | - | - |
ReturnMethodBase
Field | Type | Required | Min Length | Max Length |
position | integer | True | - | - |
method_name | string | True | 1 | 50 |
display_name | string | True | 1 | 50 |
type | string | True | - | - |
shipping_account_id | integer | True | - | - |
location_id | string | True | - | - |
sf_shipping_preference_id | string | - | - | |
service_type | string | True | - | - |
return_charge | string | True | - | - |
filters | array | True | - | - |
ReturnMethodCountryFilter
Field | Type | Required | Min Length | Max Length |
field | string | True | - | - |
operator | string | True | - | - |
value | string | True | - | - |
ReturnMethodNumberFilter
Field | Type | Required | Min Length | Max Length |
field | string | True | - | - |
operator | string | True | - | - |
value | string | True | - | - |
ReturnMethodCustomFilter
Field | Type | Required | Min Length | Max Length |
field | string | True | - | - |
operator | string | True | - | - |
name | string | True | - | 50 |
value | string | True | - | - |
ReturnMethod
Field | Type | Required | Min Length | Max Length |
position | integer | True | - | - |
method_name | string | True | 1 | 50 |
display_name | string | True | 1 | 50 |
type | string | True | - | - |
shipping_account_id | integer | True | - | - |
location_id | string | True | - | - |
sf_shipping_preference_id | string | - | - | |
service_type | string | True | - | - |
return_charge | string | True | - | - |
filters | array | True | - | - |
id | string | True | - | - |
ReturnMethodShortDetails
Field | Type | Required | Min Length | Max Length |
id | string | True | - | - |
carrier | string | True | - | - |
carrier_logo | string | True | - | - |
carrier_name | string | True | - | - |
method_name | string | True | - | - |
type | string | True | - | - |
return_pickup
Field | Type | Required | Min Length | Max Length |
id | string | True | - | - |
confirmation_number | string | True | - | - |
reference_number | string | True | - | - |
return_shipment
Field | Type | Required | Min Length | Max Length |
id | string | True | - | - |
tracking_number | string | True | - | - |
reference_number | string | True | - | - |
status | string | True | - | - |
label | string | True | - | - |
ReturnItem
Field | Type | Required | Min Length | Max Length |
id | string | True | - | - |
customer_id | string | True | - | - |
order_id | string | - | - | |
created | string | True | - | - |
return_lines | array | True | - | - |
return_method | object | True | - | - |
pickup | object | - | - | |
shipment | object | True | - | - |
custom | array | - | - |
return_method_error
Field | Type | Required | Min Length | Max Length |
error | object | True | - | - |
ShipmentEvent
Field | Type | Required | Min Length | Max Length |
carrier | string | True | - | - |
tracking_number | string | True | - | - |
from_country | string | True | - | - |
to_country | string | True | - | - |
service | string | True | - | - |
is_outbound | boolean | True | - | - |
total_costs | number | True | - | - |
currency | string | True | - | - |
created | string | True | - | - |
FtpConnectedAccountCredentials
Field | Type | Required | Min Length | Max Length |
ftp_username | string | True | - | - |
ftp_password | string | True | - | - |
FtpConnectedAccount
Field | Type | Required | Min Length | Max Length |
ftp_username | string | True | - | - |
ftp_password | string | True | - | - |
shipping_account_id | integer | True | - | - |
name | string | True | - | - |
service | integer | True | - | - |
QuantumViewConnectedAccount
Field | Type | Required | Min Length | Max Length |
shipping_account_id | integer | True | - | - |
name | string | True | - | - |
service | integer | True | - | - |
ShopifyConnectedAccount
Field | Type | Required | Min Length | Max Length |
shop_url | string | True | - | - |
shipping_account | array | True | - | - |
name | string | True | - | - |
service | integer | True | - | - |
custom_context
Custom context attached to the return
Field | Type | Required | Min Length | Max Length |
NewstoreConnectedAccount
Field | Type | Required | Min Length | Max Length |
shipping_account_id | string | True | - | - |
shipping_account_key | integer | True | - | - |
name | string | True | - | - |
service | integer | True | - | - |
SalesforceCore
Field | Type | Required | Min Length | Max Length |
service | integer | True | - | - |
environment | string | True | - | - |
custom_domain | string | True | - | - |
SalesforceCommerceCloud
Field | Type | Required | Min Length | Max Length |
url | string | True | - | - |
service | integer | True | - | - |
ConnectedAccountBase
Field | Type | Required | Min Length | Max Length |
id | string | True | - | - |
status | string | True | - | - |
ItemConnectedAccount
Field | Type | Required | Min Length | Max Length |
id | string | True | - | - |
status | string | True | - | - |
ftp_username | string | True | - | - |
ftp_password | string | True | - | - |
shipping_account_id | integer | True | - | - |
name | string | True | - | - |
service | integer | True | - | - |
CreateConnectedAccount
Field | Type | Required | Min Length | Max Length |
id | string | True | - | - |
status | string | True | - | - |
ftp_username | string | True | - | - |
ftp_password | string | True | - | - |
shipping_account_id | integer | True | - | - |
name | string | True | - | - |
service | integer | True | - | - |
UpdateConnectedAccount
Field | Type | Required | Min Length | Max Length |
id | string | True | - | - |
status | string | True | - | - |
ftp_username | string | True | - | - |
ftp_password | string | True | - | - |
shipping_account_id | integer | True | - | - |
name | string | True | - | - |
service | integer | True | - | - |
connected_account_error
Field | Type | Required | Min Length | Max Length |
error | object | True | - | - |