Once you have an api user and a token, you can begin making requests to the service.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"9513785","collectionId":"e7921f56-3360-46fd-9a3b-00310fac80cc","publishedId":"SW7Z38LY","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2022-01-12T14:48:48.000Z"},"item":[{"name":"List Couriers","id":"e44031cd-7805-49d5-b81c-0868af6540cb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"api-user","value":"{{api-user}}","description":"get from {{api_url}}/controlpanel/apiusers , in the list of users, the name field goes here
get from {{api_url}}/controlpanel/apiusers , click on view tokens and create a token. The token name is not used
This call lists all the couriers. For all courier-specific rqeuests, like 'register-auth-rules' and 'create-label', you'll be using a 'key' as returned in the JSON here.
\n","urlObject":{"path":["api","couriers","v1","list-couriers"],"host":["{{api_url}}"],"query":[],"variable":[]}},"response":[{"id":"0e60f509-d07c-4354-9090-4e21e885efe6","name":"List Couriers","originalRequest":{"method":"GET","header":[{"key":"api-user","value":"{{api-user}}","description":"get from {{api_url}}/controlpanel/apiusers","type":"text"},{"key":"api-token","value":"{{api-token}}","description":"get from {{api_url}}/controlpanel/apiusers","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{api_url}}/api/couriers/v1/list-couriers"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 18 Nov 2019 16:05:22 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/7.2.24"},{"key":"X-Xdebug-Profile-Filename","value":"/tmp/cachegrind.out.2142"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"537b2f56ad17dc4b-LHR"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"couriers\": [\n {\n \"key\": \"DHL\",\n \"name\": \"DHL\",\n \"logo\": \"\",\n \"status\": \"beta\"\n },\n {\n \"key\": \"DPD\",\n \"name\": \"DPD\",\n \"logo\": \"\",\n \"status\": \"beta\"\n },\n {\n \"key\": \"Fedex\",\n \"name\": \"Fedex\",\n \"logo\": \"\",\n \"status\": \"beta\"\n },\n {\n \"key\": \"Hermes\",\n \"name\": \"hermes\",\n \"logo\": \"\",\n \"status\": \"beta\"\n },\n {\n \"key\": \"RoyalMail\",\n \"name\": \"Royal Mail\",\n \"logo\": \"\",\n \"status\": \"beta\"\n },\n {\n \"key\": \"UKMail\",\n \"name\": \"UK Mail\",\n \"logo\": \"\",\n \"status\": \"beta\"\n }\n ],\n \"errors\": []\n}"}],"_postman_id":"e44031cd-7805-49d5-b81c-0868af6540cb"},{"name":"Get Auth Rules","id":"29cc6606-5941-49ef-90e1-dc575a7c2f2b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"api-user","value":"{{api-user}}","description":"get from {{api_url}}/controlpanel/apiusers , in the list of users, the name field goes here
get from {{api_url}}/controlpanel/apiusers , click on view tokens and create a token. The token name is not used
Each courier has unique auth rules to register before you can create labels with them. Before registering auth, make sure you have the correct details and are submitting the required fields.
\n","urlObject":{"path":["api","couriers","v1","DHL","register-auth-rules"],"host":["{{api_url}}"],"query":[],"variable":[]}},"response":[{"id":"b41d859a-cce2-42bf-87f8-f1670f11dd20","name":"Get Auth Rules","originalRequest":{"method":"GET","header":[{"key":"api-user","value":"{{api-user}}","description":"get from {{api_url}}/controlpanel/apiusers","type":"text"},{"key":"api-token","value":"{{api-token}}","description":"get from {{api_url}}/controlpanel/apiusers","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{api_url}}/api/couriers/v1/DHL/register-auth-rules"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 18 Nov 2019 16:54:01 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/7.2.24"},{"key":"X-Xdebug-Profile-Filename","value":"/tmp/cachegrind.out.26596"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"537b76bc390cbc54-LHR"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"site_id\": \"required|string\",\n \"password\": \"required|string\",\n \"account_number\": \"required|string\"\n}"}],"_postman_id":"29cc6606-5941-49ef-90e1-dc575a7c2f2b"},{"name":"Register Auth","id":"f44cdf6b-7a6a-4c63-aaea-29524dbd6182","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"api-user","value":"{{api-user}}","description":"get from {{api_url}}/controlpanel/apiusers , in the list of users, the name field goes here
get from {{api_url}}/controlpanel/apiusers , click on view tokens and create a token. The token name is not used
Using DHL as an example, the 'register-auth-rules' request told us that site_id, password and account_number are required. This is how you submit those to register those auth details.
\nPlease note: auth_company is optional. Whatever auth_company you register with must match the auth_company you send through with your 'create-label' requests
\n","urlObject":{"path":["api","couriers","v1","DHL","register-auth"],"host":["{{api_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"f44cdf6b-7a6a-4c63-aaea-29524dbd6182"},{"name":"Update Auth","id":"e5216b58-5fbd-4e9c-81b5-2a5b04a96652","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"api-user","value":"{{api-user}}","description":"get from {{api_url}}/controlpanel/apiusers , in the list of users, the name field goes here
get from {{api_url}}/controlpanel/apiusers , click on view tokens and create a token. The token name is not used
The update-auth endpoint has the same structure as register-auth -- send this request to update details of the auth.
get from {{api_url}}/controlpanel/apiusers , in the list of users, the name field goes here
get from {{api_url}}/controlpanel/apiusers , click on view tokens and create a token. The token name is not used
Once you've registered to DHL, you can begin submitting create-label requests. Each courier has different requirements for the \"courier\" section of the JSON, but most of the details will be shared by the majority of couriers. View the courier-specific differences here.
\nYou'll notice a \"label_format\" option in the shipment JSON. We support 'pdf', 'png' and 'zpl'. If you pass in 'png', the response will include a \"pngs\" key, which will be an array of base64-encoded pngs. If you pass in 'zpl', the response will include a \"zpl\" key, which will be a zpl string looking something like \"^XA^FO50,50^GFA,120200...\".
Parcels and items include some length and weight measurements. All length measurements should be in cm, and all weight in kg.
\nWhen it comes to specifying the item weight and value fields, those are for the total weight and value for that item. For example, if you have an item with a quantity of 2 and a unit weight of 3, you would put 6 in the item 'weight' field.
The \"ship_from\".\"tax_id\" field should be filled with a VAT number in most cases.
Please note: the auth_company field must match the company you registered with.
\n","urlObject":{"path":["api","couriers","v1","DHL","create-label"],"host":["{{api_url}}"],"query":[],"variable":[]}},"response":[{"id":"180d3f2a-caf5-446d-92c6-a53ecc7d08d0","name":"Create Label","originalRequest":{"method":"POST","header":[{"key":"api-user","value":"{{api-user}}","description":"get from {{api_url}}/controlpanel/apiusers","type":"text"},{"key":"api-token","value":"{{api-token}}","description":"get from {{api_url}}/controlpanel/apiusers","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"testing\": false,\r\n\t\"auth_company\": \"company\",\r\n\t\"shipment\": {\r\n\t \"label_size\": \"6x4\",\r\n\t \"label_format\": \"pdf\",\r\n\t \"generate_commercial_invoice\": false,\r\n\t \"generate_packing_slip\": false,\r\n\t\r\n\t \"courier\" : {\r\n\t \"global_product_code\" : \"U\",\r\n\t \"local_product_code\" : \"U\",\r\n \"friendly_service_name\" : \"DHL U\"\r\n\t },\r\n\r\n \"extra_details\" : {\r\n \"channel_order_id\" : 22\r\n },\r\n\t\r\n\t \"collection_date\": \"2019-11-18T16:30:49.054Z\",\r\n\t \"reference\": \"my reference\",\r\n\t\t\"reference_2\" : \"my second reference\",\r\n \"order_id\": \"1234\",\r\n\t \"delivery_instructions\": \"Leave on the porch\",\r\n \"parcel_description\": \"test items\",\r\n \"shipping_charge\" : 2.42,\r\n\t\r\n\t \"ship_from\": {\r\n\t \"name\": \"MN\",\r\n\t \"phone\": \"01377337164\",\r\n\t \"email\": \"foo@foo.com\",\r\n\t \"company_name\": \"Fake Company\",\r\n\t \"address_1\": \"unit 76\",\r\n\t \"address_2\": \"warfield road\",\r\n\t \"address_3\": \"\",\r\n\t \"city\": \"Driffield\",\r\n\t \"postcode\": \"YO25 9DJ\",\r\n\t \"county\": \"\",\r\n\t \"country_iso\": \"GB\",\r\n\t \"company_id\": \"911-70-1234\",\r\n\t \"tax_id\": \"911-70-1234\",\r\n \"eori_id\": \"911-70-1234-000\",\r\n \"ioss_number\" : \"IM2760000711\"\r\n\t },\r\n\t\r\n\t \"ship_to\": {\r\n\t \"name\": \"Laura Maura\",\r\n\t \"phone\": \"466546346546\",\r\n\t \"email\": \"support@buyer.com\",\r\n\t \"company_name\": \"\",\r\n\t \"address_1\": \"Ekeredsvaegen 132\",\r\n\t \"address_2\": \"\",\r\n\t \"address_3\": \"\",\r\n\t \"city\": \"Lerum\",\r\n\t \"county\": \"\",\r\n\t \"postcode\": \"443 50\",\r\n\t \"country_iso\": \"SE\",\r\n \"company_id\": \"911-70-1234\",\r\n\t \"tax_id\": \"911-70-1234\",\r\n \"eori_id\": \"911-70-1234-000\",\r\n \"ioss_number\" : \"IM2760000711\"\r\n\t },\r\n\t \"parcels\": [\r\n\t {\r\n\t \"dim_width\": 50,\r\n\t \"dim_height\": 80,\r\n\t \"dim_length\": 40,\r\n\t \"dim_unit\": \"cm\",\r\n\t\r\n\t \"items\": [\r\n\t {\r\n\t \"description\": \"Test Item One\",\r\n\t \"origin_country\": \"GB\",\r\n\t \"quantity\": 1,\r\n\t \"value\": 20,\r\n\t \"value_currency\": \"GBP\",\r\n\t \"weight\": 0.6,\r\n\t \"weight_unit\": \"kg\",\r\n\t \"sku\": \"TEST0001\",\r\n\t \"hs_code\": \"12345\"\r\n\t }, {\r\n\t \"description\": \"Test Item One\",\r\n\t \"origin_country\": \"GB\",\r\n\t \"quantity\": 1,\r\n\t \"value\": 5,\r\n\t \"value_currency\": \"GBP\",\r\n\t \"weight\": 0.4,\r\n\t \"weight_unit\": \"kg\",\r\n\t \"sku\": \"TEST0001\",\r\n\t \"hs_code\": \"12345\"\r\n\t }]\r\n\t }\r\n\t ]\r\n\t},\r\n\t\"format_address_default\" : true,\r\n\t\"request_id\": 123456789\r\n}"},"url":"{{api_url}}/api/couriers/v1/DHL/create-label"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"uri\": \"http://vault.ecloud.co.uk/courierapi/1571116369_lowcost_bhrtt.pdf?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=HSEOVCX3IWRFNRTAZQT6%2F20191885%2Feu-west-2%2Fs3%2Faws4_request&X-Amz-Date=20191119T093984Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Signature=4626b1ffc529e9a8471229860fc6f72c184d0c8d81c179c60e59cf0ecd44fea8\",\n \"key\": \"1571116369_lowcost_bhrtt.pdf\",\n \"type\": \"PDF\",\n \"request_id\": \"1574156346168\",\n \"tracking_codes\": [\n \"JD0002249184029999\"\n ]\n}"}],"_postman_id":"dbc1364b-b122-44e1-9680-e923b3b7103a"},{"name":"Create Label with Parcel Weights","id":"11c8a85a-2a33-42ed-9cd6-61695064058c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"get from {{api_url}}/controlpanel/apiusers , in the list of users, the name field goes here
get from {{api_url}}/controlpanel/apiusers , click on view tokens and create a token. The token name is not used
As an alternative to definining the 'weight' property on each item in a parcel, you may define the 'weight' on just the parcel object. If you do this, all item.weight fields will be ignored.
Note: you can optionally supply a \"packaging_weight\" as well.
\n","urlObject":{"path":["api","couriers","v1","DHL","create-label"],"host":["{{api_url}}"],"query":[],"variable":[]}},"response":[{"id":"848f61da-4a17-4c18-87cb-03f6a8c412a0","name":"Create Label","originalRequest":{"method":"POST","header":[{"key":"api-user","value":"{{api-user}}","description":"get from {{api_url}}/controlpanel/apiusers","type":"text"},{"key":"api-token","value":"{{api-token}}","description":"get from {{api_url}}/controlpanel/apiusers","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"testing\": false,\r\n\t\"auth_company\": \"company\",\r\n\t\"shipment\": {\r\n\t \"label_size\": \"6x4\",\r\n\t \"label_format\": \"pdf\",\r\n\t \"generate_commercial_invoice\": false,\r\n\t \"generate_packing_slip\": false,\r\n\t\r\n\t \"courier\" : {\r\n\t \"global_product_code\" : \"U\",\r\n\t \"local_product_code\" : \"U\",\r\n \"friendly_service_name\" : \"DHL U\"\r\n\t },\r\n\t\r\n\t \"collection_date\": \"2019-11-18T16:30:49.054Z\",\r\n\t \"reference\": \"my reference\",\r\n\t\t\"reference_2\" : \"my second reference\",\r\n\t \"delivery_instructions\": \"Leave on the porch\",\r\n\t\r\n\t \"ship_from\": {\r\n\t \"name\": \"MN\",\r\n\t \"phone\": \"01377337164\",\r\n\t \"email\": \"foo@foo.com\",\r\n\t \"company_name\": \"Fake Company\",\r\n\t \"address_1\": \"unit 76\",\r\n\t \"address_2\": \"warfield road\",\r\n\t \"address_3\": \"\",\r\n\t \"city\": \"Driffield\",\r\n\t \"postcode\": \"YO25 9DJ\",\r\n\t \"county\": \"\",\r\n\t \"country_iso\": \"GB\",\r\n\t \"company_id\": \"911-70-1234\",\r\n\t \"tax_id\": \"911-70-1234\",\r\n \"eori_id\": \"911-70-1234-000\",\r\n \"ioss_number\" : \"IM2760000711\"\r\n\t },\r\n\t\r\n\t \"ship_to\": {\r\n\t \"name\": \"Laura Maura\",\r\n\t \"phone\": \"466546346546\",\r\n\t \"email\": \"support@buyer.com\",\r\n\t \"company_name\": \"\",\r\n\t \"address_1\": \"Ekeredsvaegen 132\",\r\n\t \"address_2\": \"\",\r\n\t \"address_3\": \"\",\r\n\t \"city\": \"Lerum\",\r\n\t \"county\": \"\",\r\n\t \"postcode\": \"443 50\",\r\n\t \"country_iso\": \"SE\"\r\n\t },\r\n\t \"parcels\": [\r\n\t {\r\n\t \"dim_width\": 50,\r\n\t \"dim_height\": 80,\r\n\t \"dim_length\": 40,\r\n\t \"dim_unit\": \"cm\",\r\n \"weight\" : 8.2,\r\n \"weight_unit\": \"kg\",\r\n \"packaging_weight\" : 0.2,\r\n \r\n\t \"items\": [\r\n\t {\r\n\t \"description\": \"Test Item One\",\r\n\t \"origin_country\": \"GB\",\r\n\t \"quantity\": 1,\r\n\t \"value\": 20,\r\n\t \"value_currency\": \"GBP\",\r\n\t \"sku\": \"TEST0001\",\r\n\t \"hs_code\": \"12345\"\r\n\t }, {\r\n\t \"description\": \"Test Item One\",\r\n\t \"origin_country\": \"GB\",\r\n\t \"quantity\": 1,\r\n\t \"value\": 5,\r\n\t \"value_currency\": \"GBP\",\r\n\t \"sku\": \"TEST0001\",\r\n\t \"hs_code\": \"12345\"\r\n\t }]\r\n\t }\r\n\t ]\r\n\t},\r\n\t\"format_address_default\" : true,\r\n\t\"request_id\": 123456789\r\n}"},"url":"{{api_url}}/api/couriers/v1/DHL/create-label"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"uri\": \"http://vault.ecloud.co.uk/courierapi/1571116369_lowcost_bhrtt.pdf?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=HSEOVCX3IWRFNRTAZQT6%2F20191885%2Feu-west-2%2Fs3%2Faws4_request&X-Amz-Date=20191119T093984Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Signature=4626b1ffc529e9a8471229860fc6f72c184d0c8d81c179c60e59cf0ecd44fea8\",\n \"key\": \"1571116369_lowcost_bhrtt.pdf\",\n \"type\": \"PDF\",\n \"request_id\": \"1574156346168\",\n \"tracking_codes\": [\n \"JD0002249184029999\"\n ]\n}"}],"_postman_id":"11c8a85a-2a33-42ed-9cd6-61695064058c"},{"name":"Create Label with Presets","id":"120bbd63-0607-4304-9ed6-a3ce73a6c5d7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"get from {{api_url}}/controlpanel/apiusers , in the list of users, the name field goes here
get from {{api_url}}/controlpanel/apiusers , click on view tokens and create a token. The token name is not used
You can use presets to autofill the 'courier' section of your shipment json. Visit the url {{api_url}}/courier-service-presets//DHL and choose an API User to view the DHL presets. Create a new preset with a name, a dc_service_id and a json value.
\nFor example, set the name to 'Basic Preset' and the dc_service_id to 'basic', and set the JSON like so:
\n{\n \"global_product_code\" : \"U\",\n \"local_product_code\" : \"U\"\n}\nand then, in your shipment json, instead of the 'courier' section you would put \"dc_service_id\" : \"basic\" to have the courier section autofilled with the above values.
For some use cases, you may want to override or add to a preset at the time of request -- you may do that by sill using the 'courier' section of the json.
\nFor example, if a preset has json {\"service\": \"2\", \"international\" : true} and your shipment has \"courier\": {\"service\": \"fast_light\", \"hs_code\" : \"1234\"}, our system would get the preset, and then paste over it any values found in your \"courier\" json, so it would end up as {\"service\": \"fast_light\", \"international\" : true, \"hs_code\" : \"1234\"}.
get from {{api_url}}/controlpanel/apiusers , in the list of users, the name field goes here
get from {{api_url}}/controlpanel/apiusers , click on view tokens and create a token. The token name is not used
If you've signed up for our Billing Api, you can make create-label requests that also trigger our system to get the Billing information for the same shipment.
\nAdd this bit of data to your shipment json:
\n \"billing\": {\n \"customer_dc_id\" : \"102\",\n \"service_code\" : \"302\",\n \"order_id\" : \"374692834\",\n \"token\" : \"tcm78\"\n }\nYour response will have something resembling the following json added on:
\n ...\n \"billing\": {\n \"shipping\": [\n 2.67,\n 2.67\n ],\n \"picking\": 2,\n \"parcel_rules\": [\n [],\n []\n ],\n \"total\": 7.34\n }\n ...\nget from {{api_url}}/controlpanel/apiusers , in the list of users, the name field goes here
get from {{api_url}}/controlpanel/apiusers , click on view tokens and create a token. The token name is not used
If you need a commercial invoice as well as the label, add this bit of data to your shipment json:
\n ...\n \"generate_commercial_invoice\": true,\n \"commercial_invoice_details\" : {\n \"vat_number\" : \"123456\",\n \"eori_number\" : \"99999999\",\n \"company_number\": \"8462\",\n \"signature\" : {\n \"name\" : \"Matthew Dunne\",\n \"position\": \"CEO\",\n \"img_url\" : \"https://www.yoursite.com/images/your-signature.png\"\n }\n }\n ...\n\nYour response will have something resembling the following json added on:
\n ...\n \"commercial_invoice\" : {\n \"url\": \"http://vault.ecloud.co.uk/courierapi/ZAsbF4u5rghI7ymuFMBi.pdf?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&Signature=957a4f836af6b847eb9399b5ce8f202ea615f2351170e078349a37ce02de15dc\",\n \"key\": \"ZAsbF4u5rghI7ymuFMBi.pdf\"\n }\n ...\n\nWe also support the ability to automatically generate a commercial invoice for couriers that do not support digital customs: instead of `\"generate_commercial_invoice\": true`, use the setting `\"automatic_commercial_invoice\" : true`
\n","urlObject":{"path":["api","couriers","v1","DHL","create-label"],"host":["{{api_url}}"],"query":[],"variable":[]}},"response":[{"id":"97d211b3-af67-4e9f-8a41-0aba766a4f63","name":"Create Label","originalRequest":{"method":"POST","header":[{"key":"api-user","value":"{{api-user}}","description":"get from {{api_url}}/controlpanel/apiusers","type":"text"},{"key":"api-token","value":"{{api-token}}","description":"get from {{api_url}}/controlpanel/apiusers","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"testing\":\t\t\tfalse,\r\n\t\"auth_company\":\t\t\"company\",\r\n\t\"shipment\": {\r\n\t \"label_size\": \"6x4\",\r\n\t \"label_format\": \"pdf\",\r\n\t \"generate_packing_slip\": false,\r\n\t \"generate_commercial_invoice\": true,\r\n\t\r\n\t \"dc_service_id\" : \"basic\",\r\n\t\r\n\t \"collection_date\": \"2019-11-18T16:30:49.054Z\",\r\n\t \"reference\": \"my reference\",\r\n\t \"delivery_instructions\": \"Leave on the porch\",\r\n\t\r\n\t \"ship_from\": {\r\n\t \"name\": \"MN\",\r\n\t \"phone\": \"01377337164\",\r\n\t \"email\": \"foo@foo.com\",\r\n\t \"company_name\": \"Fake Company\",\r\n\t \"address_1\": \"unit 76\",\r\n\t \"address_2\": \"warfield road\",\r\n\t \"address_3\": \"\",\r\n\t \"city\": \"Driffield\",\r\n\t \"postcode\": \"YO25 9DJ\",\r\n\t \"county\": \"\",\r\n\t \"country_iso\": \"GB\",\r\n\t \"company_id\": \"911-70-1234\",\r\n\t \"tax_id\": \"911-70-1234\",\r\n \"eori_id\": \"911-70-1234-000\"\r\n\t },\r\n\t\r\n\t \"ship_to\": {\r\n\t \"name\": \"Laura Maura\",\r\n\t \"phone\": \"466546346546\",\r\n\t \"email\": \"support@buyer.com\",\r\n\t \"company_name\": \"\",\r\n\t \"address_1\": \"Ekeredsvaegen 132\",\r\n\t \"address_2\": \"\",\r\n\t \"address_3\": \"\",\r\n\t \"city\": \"Lerum\",\r\n\t \"county\": \"\",\r\n\t \"postcode\": \"443 50\",\r\n\t \"country_iso\": \"SE\",\r\n \"company_id\": \"911-70-1234\",\r\n\t \"tax_id\": \"911-70-1234\",\r\n \"eori_id\": \"911-70-1234-000\",\r\n \"ioss_number\" : \"IM2760000711\"\r\n\t },\r\n\t \"parcels\": [\r\n\t {\r\n\t \"dim_width\": 50,\r\n\t \"dim_height\": 80,\r\n\t \"dim_length\": 40,\r\n\t \"dim_unit\": \"cm\",\r\n\t\r\n\t \"items\": [\r\n\t {\r\n\t \"description\": \"Test Item One\",\r\n\t \"origin_country\": \"GB\",\r\n\t \"quantity\": 1,\r\n\t \"value\": 20,\r\n\t \"value_currency\": \"GBP\",\r\n\t \"weight\": 0.6,\r\n\t \"weight_unit\": \"kg\",\r\n\t \"sku\": \"TEST0001\",\r\n\t \"hs_code\": \"12345\"\r\n\t }, {\r\n\t \"description\": \"Test Item One\",\r\n\t \"origin_country\": \"GB\",\r\n\t \"quantity\": 1,\r\n\t \"value\": 5,\r\n\t \"value_currency\": \"GBP\",\r\n\t \"weight\": 0.4,\r\n\t \"weight_unit\": \"kg\",\r\n\t \"sku\": \"TEST0001\",\r\n\t \"hs_code\": \"12345\"\r\n\t }]\r\n\t }\r\n\t ],\r\n\t \"commercial_invoice_details\" : {\r\n\t \"vat_number\" : \"123456\",\r\n\t \"eori_number\" : \"99999999\",\r\n\t \"company_number\": \"8462\",\r\n\t \"signature\" : {\r\n\t \"name\" : \"Matthew Dunne\",\r\n\t \"position\": \"CEO\",\r\n\t \"img_url\" : \"https://www.yoursite.com/images/your-signature.png\"\r\n\t }\r\n\t }\r\n\t},\r\n\t\"format_address_default\" : true,\r\n\t\"request_id\": 123456789\r\n}"},"url":"{{api_url}}/api/couriers/v1/DHL/create-label"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"uri\": \"http://vault.ecloud.co.uk/courierapi/pdf_test_1576669529_whovy_merged.pdf?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=HSEOVCX3IWRFNRTAZBR7%2F20191218%2Feu-west-2%2Fs3%2Faws4_request&X-Amz-Date=20191218T114529Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Signature=eca52362846e77742d4e03c4db4e5e4bcd3bef7928f135f32ca7bd7401e973e8\",\r\n \"key\": \"pdf_test_1576669529_whovy_merged.pdf\",\r\n \"type\": \"PDF\",\r\n \"request_id\": \"1576669481129\",\r\n \"tracking_codes\": [\r\n \"1576669529\",\r\n \"1576669529\"\r\n ],\r\n \"commercial_invoice\" : {\r\n \"url\": \"http://vault.ecloud.co.uk/courierapi/ZAsbF4u5rghI7ymuFMBi.pdf?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&Signature=957a4f836af6b847eb9399b5ce8f2983ea6A5f2351120e0734349a37ce01dd15ec\",\r\n \"key\": \"ZAsbF4u5rghI7ymuFMBi.pdf\"\r\n }\r\n}"}],"_postman_id":"2c6ffcbf-d55d-4162-8c9c-4049bee14257"},{"name":"Create Label with Gift Note","id":"ae8918cb-1c08-4f3f-bd2f-5a9309e490a9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"get from {{api_url}}/controlpanel/apiusers , in the list of users, the name field goes here
get from {{api_url}}/controlpanel/apiusers , click on view tokens and create a token. The token name is not used
If want to add a Gift Note to the printed label, add this bit of data to your shipment json:
\n ...\n \"gift_note\" : {\n \"note\" : \"Thank you for the memories of yesterday, for the happiness today, and the promise of all tomorrows! Happy Anniversary!\",\n \"img_src\" : \"https://branding.despatchcloud.com/assets/Despatch-Cloud-Blue.png\"\n }\n ...\nget from {{api_url}}/controlpanel/apiusers , in the list of users, the name field goes here
get from {{api_url}}/controlpanel/apiusers , click on view tokens and create a token. The token name is not used
For all the happy memories
\"\r\n },\r\n\t\t\r\n\t \"dc_service_id\" : \"basic\",\r\n\t\r\n\t \"collection_date\": \"2019-11-18T16:30:49.054Z\",\r\n\t \"reference\": \"my reference\",\r\n\t \"delivery_instructions\": \"Leave on the porch\",\r\n\t\r\n\t \"ship_from\": {\r\n\t \"name\": \"MN\",\r\n\t \"phone\": \"01377337164\",\r\n\t \"email\": \"foo@foo.com\",\r\n\t \"company_name\": \"Fake Company\",\r\n\t \"address_1\": \"unit 76\",\r\n\t \"address_2\": \"warfield road\",\r\n\t \"address_3\": \"\",\r\n\t \"city\": \"Driffield\",\r\n\t \"postcode\": \"YO25 9DJ\",\r\n\t \"county\": \"\",\r\n\t \"country_iso\": \"GB\",\r\n\t \"company_id\": \"911-70-1234\",\r\n\t \"tax_id\": \"911-70-1234\",\r\n \"eori_id\": \"911-70-1234-000\"\r\n\t },\r\n\t\r\n\t \"ship_to\": {\r\n\t \"name\": \"Laura Maura\",\r\n\t \"phone\": \"466546346546\",\r\n\t \"email\": \"support@buyer.com\",\r\n\t \"company_name\": \"\",\r\n\t \"address_1\": \"Ekeredsvaegen 132\",\r\n\t \"address_2\": \"\",\r\n\t \"address_3\": \"\",\r\n\t \"city\": \"Lerum\",\r\n\t \"county\": \"\",\r\n\t \"postcode\": \"443 50\",\r\n\t \"country_iso\": \"SE\"\r\n\t },\r\n\t \"parcels\": [\r\n\t {\r\n\t \"dim_width\": 50,\r\n\t \"dim_height\": 80,\r\n\t \"dim_length\": 40,\r\n\t \"dim_unit\": \"cm\",\r\n\t\r\n\t \"items\": [\r\n\t {\r\n\t \"description\": \"Test Item One\",\r\n\t \"origin_country\": \"GB\",\r\n\t \"quantity\": 1,\r\n\t \"value\": 20,\r\n\t \"value_currency\": \"GBP\",\r\n\t \"weight\": 0.6,\r\n\t \"weight_unit\": \"kg\",\r\n\t \"sku\": \"TEST0001\",\r\n\t \"hs_code\": \"12345\"\r\n\t }, {\r\n\t \"description\": \"Test Item One\",\r\n\t \"origin_country\": \"GB\",\r\n\t \"quantity\": 1,\r\n\t \"value\": 5,\r\n\t \"value_currency\": \"GBP\",\r\n\t \"weight\": 0.4,\r\n\t \"weight_unit\": \"kg\",\r\n\t \"sku\": \"TEST0001\",\r\n\t \"hs_code\": \"12345\"\r\n\t }]\r\n\t }\r\n\t ]\r\n\t},\r\n\t\"format_address_default\" : true,\r\n\t\"request_id\": 123456789\r\n}"},"url":"{{api_url}}/api/couriers/v1/DHL/create-label","description":"If want to add an HTML Note to the printed label, add this bit of data to your shipment json:
\n ...\n \"html_note\" : {\n \"html\" : \"<h1 class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'>Thank you!</h1><p class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'>For all the happy memories</p>\"\n },\n ...\n\nYou can also add the above json into the json for a preset, or into the courier-specifics preset, `\"courier\": {\"html_note\": { ... }}`.
\n","urlObject":{"path":["api","couriers","v1","DHL","create-label"],"host":["{{api_url}}"],"query":[],"variable":[]}},"response":[{"id":"f6d9dbbf-afb6-4e32-a4f1-befd95ac20a5","name":"Create Label","originalRequest":{"method":"POST","header":[{"key":"api-user","value":"{{api-user}}","description":"get from {{api_url}}/controlpanel/apiusers","type":"text"},{"key":"api-token","value":"{{api-token}}","description":"get from {{api_url}}/controlpanel/apiusers","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"testing\":\t\t\tfalse,\r\n\t\"auth_company\":\t\t\"company\",\r\n\t\"shipment\": {\r\n\t \"label_size\": \"6x4\",\r\n\t \"label_format\": \"pdf\",\r\n\t \"generate_invoice\": false,\r\n\t \"generate_packing_slip\": false,\r\n\t\t\"generate_commercial_invoice\": false,\r\n \"html_note\" : {\r\n \"html\" : \"For all the happy memories
\"\r\n },\r\n\t\t\r\n\t \"dc_service_id\" : \"basic\",\r\n\t\r\n\t \"collection_date\": \"2019-11-18T16:30:49.054Z\",\r\n\t \"reference\": \"my reference\",\r\n\t \"delivery_instructions\": \"Leave on the porch\",\r\n\t\r\n\t \"ship_from\": {\r\n\t \"name\": \"MN\",\r\n\t \"phone\": \"01377337164\",\r\n\t \"email\": \"foo@foo.com\",\r\n\t \"company_name\": \"Fake Company\",\r\n\t \"address_1\": \"unit 76\",\r\n\t \"address_2\": \"warfield road\",\r\n\t \"address_3\": \"\",\r\n\t \"city\": \"Driffield\",\r\n\t \"postcode\": \"YO25 9DJ\",\r\n\t \"county\": \"\",\r\n\t \"country_iso\": \"GB\",\r\n\t \"company_id\": \"911-70-1234\",\r\n\t \"tax_id\": \"911-70-1234\",\r\n \"eori_id\": \"911-70-1234-000\"\r\n\t },\r\n\t\r\n\t \"ship_to\": {\r\n\t \"name\": \"Laura Maura\",\r\n\t \"phone\": \"466546346546\",\r\n\t \"email\": \"support@buyer.com\",\r\n\t \"company_name\": \"\",\r\n\t \"address_1\": \"Ekeredsvaegen 132\",\r\n\t \"address_2\": \"\",\r\n\t \"address_3\": \"\",\r\n\t \"city\": \"Lerum\",\r\n\t \"county\": \"\",\r\n\t \"postcode\": \"443 50\",\r\n\t \"country_iso\": \"SE\"\r\n\t },\r\n\t \"parcels\": [\r\n\t {\r\n\t \"dim_width\": 50,\r\n\t \"dim_height\": 80,\r\n\t \"dim_length\": 40,\r\n\t \"dim_unit\": \"cm\",\r\n\t\r\n\t \"items\": [\r\n\t {\r\n\t \"description\": \"Test Item One\",\r\n\t \"origin_country\": \"GB\",\r\n\t \"quantity\": 1,\r\n\t \"value\": 20,\r\n\t \"value_currency\": \"GBP\",\r\n\t \"weight\": 0.6,\r\n\t \"weight_unit\": \"kg\",\r\n\t \"sku\": \"TEST0001\",\r\n\t \"hs_code\": \"12345\"\r\n\t }, {\r\n\t \"description\": \"Test Item One\",\r\n\t \"origin_country\": \"GB\",\r\n\t \"quantity\": 1,\r\n\t \"value\": 5,\r\n\t \"value_currency\": \"GBP\",\r\n\t \"weight\": 0.4,\r\n\t \"weight_unit\": \"kg\",\r\n\t \"sku\": \"TEST0001\",\r\n\t \"hs_code\": \"12345\"\r\n\t }]\r\n\t }\r\n\t ]\r\n\t},\r\n\t\"format_address_default\" : true,\r\n\t\"request_id\": 123456789\r\n}"},"url":"{{api_url}}/api/couriers/v1/DHL/create-label"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"uri\": \"http://vault.ecloud.co.uk/courierapi/pdf_test_1576669529_whovy_merged.pdf?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=HSEOVCX3IWRFNRTAZBR7%2F20191218%2Feu-west-2%2Fs3%2Faws4_request&X-Amz-Date=20191218T114529Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Signature=eca52362846e77742d4e03c4db4e5e4bcd3bef7928f135f32ca7bd7401e973e8\",\r\n \"key\": \"pdf_test_1576669529_whovy_merged.pdf\",\r\n \"type\": \"PDF\",\r\n \"request_id\": \"1576669481129\",\r\n \"tracking_codes\": [\r\n \"1576669529\",\r\n \"1576669529\"\r\n ]\r\n}"}],"_postman_id":"f82df165-f1e8-47e1-b8aa-929098e95c22"},{"name":"Create Label with Packing Slip","id":"dbc9d82a-ee46-48f3-aec5-379c7439a430","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"get from {{api_url}}/controlpanel/apiusers , in the list of users, the name field goes here
get from {{api_url}}/controlpanel/apiusers , click on view tokens and create a token. The token name is not used
If want to add a Packing Slip to the printed label, add this bit of data to your shipment json:
\n ...\n \"generate_packing_slip\": true,\n ...\n\nThe packing slip supports an optional field in the \"items\" array: \"extended_description\". Use this field if you want to have longer descriptions printed on the packing slip.
get from {{api_url}}/controlpanel/apiusers , in the list of users, the name field goes here
get from {{api_url}}/controlpanel/apiusers , click on view tokens and create a token. The token name is not used
If want a custom packing slip, add this bit of data to your shipment json:
\n ...\n \"generate_packing_slip\": true,\n \"packing_slip_template\": \"<smarty template>\"\n ...\n\nThe smarty template should be an html string, as in the example requests, in which you have access to a $shipment variable, which is the shipment you submitted to create-label, and an $items variable, which you can loop over and which contains all the items (from all the submitted parcels).
Smarty documented here: https://www.smarty.net/docs/en/
\n","urlObject":{"path":["api","couriers","v1","DHL","create-label"],"host":["{{api_url}}"],"query":[],"variable":[]}},"response":[{"id":"2ffd2557-290b-4304-8505-e1abe3dfead0","name":"Create Label","originalRequest":{"method":"POST","header":[{"key":"api-user","value":"{{api-user}}","description":"get from {{api_url}}/controlpanel/apiusers","type":"text"},{"key":"api-token","value":"{{api-token}}","description":"get from {{api_url}}/controlpanel/apiusers","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"testing\": false,\r\n\t\"auth_company\": \"company\",\r\n\t\"shipment\": {\r\n\t \"label_size\": \"6x4\",\r\n\t \"label_format\": \"pdf\",\r\n \r\n\t \"generate_packing_slip\": true,\r\n \"packing_slip_custom_template\": \"get from {{api_url}}/controlpanel/apiusers , in the list of users, the name field goes here
get from {{api_url}}/controlpanel/apiusers , click on view tokens and create a token. The token name is not used
If you need to see the raw responses from the courier requests, add this to your shipment json:
\n ...\n \"return_raw_responses\" : true\n ...\nYour response will have something resembling the following json added on:
\n ...\n \"raw_responses\" : [\n \"<raw response 1>\",\n \"<raw response 2>\"\n ]\n ...\nget from {{api_url}}/controlpanel/apiusers , in the list of users, the name field goes here
get from {{api_url}}/controlpanel/apiusers , click on view tokens and create a token. The token name is not used
To get some shipment data sent to a webhook url, add this bit of data to your shipment json:
\n ...\n \"shipment_webhook\" : {\n \"url\" : \"https://mywebsite.com/shipment-webhook\",\n \"headers\" : {\"auth-token\": \"DhdiEDxE\"}\n },\n ...\nWe will send a post request to the provided URL, with the headers provided and the following JSON format:
\n{\"shipment\":{\"id\":184,\"created_at\":\"2020-06-02 17:34:03\",\"updated_at\":\"2020-06-02 17:34:03\",\"friendly_service_name\":\"DHL 24H Service\",\"ship_to_postcode\":\"YO25 6GN\",\"ship_to_name\":\"Recipient Name\",\"ship_to_email\":\"support@buyer.com\",\"ship_to_company_name\":\"The Receiving Company\",\"ship_to_country_iso\":\"GB\",\"reference\":\"mynewcustomreference\",\"collection_date\":\"2020-06-02 17:33:40\",\"courier\":\"DHL\",\"api_user_id\":2,\"user_id\":1,\"courier_auth_id\":205,\"sku_list\":\"EXPICKLIST,TEST0002,EXPICKLIST,TEST0002\",\"http_response_code\":200,\"cancelled\":0,\"request_log_id\":4056,\"duplicate_of\":null,\"create_label_parcels\":[{\"id\":180,\"created_at\":\"2020-06-02 17:34:03\",\"updated_at\":\"2020-06-02 17:34:03\",\"api_user_id\":2,\"user_id\":1,\"create_label_shipment_id\":184,\"sku_list\":\"EXPICKLIST,TEST0002\",\"tracking_code\":\"TP-0205128\",\"width\":20,\"length\":40,\"height\":40,\"weight\":1,\"value\":25,\"parcel_number\":1},{\"id\":181,\"created_at\":\"2020-06-02 17:34:03\",\"updated_at\":\"2020-06-02 17:34:03\",\"api_user_id\":2,\"user_id\":1,\"create_label_shipment_id\":184,\"sku_list\":\"EXPICKLIST,TEST0002\",\"tracking_code\":\"TP-0205128\",\"width\":20,\"length\":40,\"height\":40,\"weight\":1,\"value\":25,\"parcel_number\":2}]}}\nget from {{api_url}}/controlpanel/apiusers , in the list of users, the name field goes here
get from {{api_url}}/controlpanel/apiusers , click on view tokens and create a token. The token name is not used
If you specify \"return\" json in your create-label request, it will trigger an additional create-label request using the details you specify in the json, while swapping the ship_from and ship_to addresses.
The main json fields are courier, auth_company and dc_service_id - use these to dictate which courier, which registered auth, and which preset you would like to use for the return request.
You may also specify no_merge to avoid merging the returns label into the main label, which it does by default.
The response to this type of request is like a normal create-label request, with an extra element, the \"return\" element. The \"return\" element generally has all the same things you would find in a normal create-label response, such as tracking_codes and uri. uri is the url to your returns label.
get from {{api_url}}/controlpanel/apiusers , in the list of users, the name field goes here
get from {{api_url}}/controlpanel/apiusers , click on view tokens and create a token. The token name is not used
We support what3words information being submitted for the ship_to address for some couriers. Please see the example request for where to submit the \"what3words\" field. The couriers currenctly supported are:
APGGlobal, BJS, DHLParcelUKCloud, and GFS.
\n","urlObject":{"path":["api","couriers","v1","BJS","create-label"],"host":["{{api_url}}"],"query":[],"variable":[]}},"response":[{"id":"cdff48d3-4572-494c-8aa9-39fcbe24ece5","name":"Create Label with What3words","originalRequest":{"method":"POST","header":[{"description":"get from {{api_url}}/controlpanel/apiusers , in the list of users, the `name` field goes here","key":"api-user","type":"text","value":"{{api-user}}"},{"description":"get from {{api_url}}/controlpanel/apiusers , click on `view tokens` and create a token. The token `name` is not used","key":"api-token","type":"text","value":"{{api-token}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"testing\": false,\r\n \"auth_company\": \"company\",\r\n \"shipment\": {\r\n \"label_size\": \"6x4\",\r\n \"label_format\": \"pdf\",\r\n \"generate_commercial_invoice\": false,\r\n \"generate_packing_slip\": false,\r\n\r\n \"courier\" : {\r\n \"friendly_service_name\": \"DHL 24H Service\",\r\n \"global_product_code\" : \"U\",\r\n \"local_product_code\" : \"U\"\r\n },\r\n \r\n \"collection_date\": \"2019-11-18T16:30:49.054Z\",\r\n \"reference\": \"my reference\",\r\n \"delivery_instructions\": \"Leave on the porch\",\r\n \r\n \"ship_from\": {\r\n \"name\": \"MN\",\r\n \"phone\": \"01377337164\",\r\n \"email\": \"foo@foo.com\",\r\n \"company_name\": \"Fake Company\",\r\n \"address_1\": \"unit 76\",\r\n \"address_2\": \"warfield road\",\r\n \"address_3\": \"\",\r\n \"city\": \"Driffield\",\r\n \"postcode\": \"YO25 9DJ\",\r\n \"county\": \"\",\r\n \"country_iso\": \"GB\",\r\n \"company_id\": \"911-70-1234\",\r\n \"tax_id\": \"911-70-1234\",\r\n \"eori_id\": \"911-70-1234-000\"\r\n },\r\n \r\n \"ship_to\": {\r\n \"name\": \"Laura Maura\",\r\n \"phone\": \"466546346546\",\r\n \"email\": \"support@buyer.com\",\r\n \"company_name\": \"\",\r\n \"address_1\": \"Ekeredsvaegen 132\",\r\n \"address_2\": \"\",\r\n \"address_3\": \"\",\r\n \"city\": \"Lerum\",\r\n \"county\": \"\",\r\n \"postcode\": \"443 50\",\r\n \"country_iso\": \"SE\",\r\n \"what3words\": \"activates.goggles.elevator\"\r\n },\r\n \"parcels\": [\r\n {\r\n \"dim_width\": 20,\r\n \"dim_height\": 40,\r\n \"dim_length\": 40,\r\n \"dim_unit\": \"cm\",\r\n\r\n \"items\": [\r\n {\r\n \"description\": \"Test Item One\",\r\n \"origin_country\": \"GB\",\r\n \"quantity\": 2,\r\n \"value\": 20,\r\n \"value_currency\": \"GBP\",\r\n \"weight\": 0.6,\r\n \"weight_unit\": \"kg\",\r\n \"sku\": \"EXPICKLIST\",\r\n \"hs_code\": \"12345\"\r\n }, {\r\n \"description\": \"Test Item Two\",\r\n \"origin_country\": \"GB\",\r\n \"quantity\": 1,\r\n \"value\": 5,\r\n \"value_currency\": \"GBP\",\r\n \"weight\": 0.4,\r\n \"weight_unit\": \"kg\",\r\n \"sku\": \"TEST0002\",\r\n \"hs_code\": \"12345\"\r\n }]\r\n },\r\n {\r\n \"dim_width\": 20,\r\n \"dim_height\": 40,\r\n \"dim_length\": 40,\r\n \"dim_unit\": \"cm\",\r\n\r\n \"items\": [\r\n {\r\n \"description\": \"Test Item One\",\r\n \"origin_country\": \"GB\",\r\n \"quantity\": 2,\r\n \"value\": 20,\r\n \"value_currency\": \"GBP\",\r\n \"weight\": 0.6,\r\n \"weight_unit\": \"kg\",\r\n \"sku\": \"EXPICKLIST\",\r\n \"hs_code\": \"12345\"\r\n }, {\r\n \"description\": \"Test Item Two\",\r\n \"origin_country\": \"GB\",\r\n \"quantity\": 1,\r\n \"value\": 5,\r\n \"value_currency\": \"GBP\",\r\n \"weight\": 0.4,\r\n \"weight_unit\": \"kg\",\r\n \"sku\": \"TEST0002\",\r\n \"hs_code\": \"12345\"\r\n }]\r\n }\r\n ]\r\n },\r\n \"format_address_default\" : true,\r\n \"request_id\": 123456789\r\n}"},"url":"{{api_url}}/api/couriers/v1/BJS/create-label"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"0c4678d7-0774-43ed-906c-d90ba27d80cf"},{"name":"Create Label with Anansi Insurance","id":"1549fb52-a170-4485-877b-277372cd2687","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"get from {{api_url}}/controlpanel/apiusers , in the list of users, the name field goes here
get from {{api_url}}/controlpanel/apiusers , click on view tokens and create a token. The token name is not used
If you have an Anansi plugin set up for your api user, you can trigger Anansi insurance on a specific shipment by using the plugin_use_anansi setting.
It can be sent either inside the shipment object directly, or inside the courier section, as in the example. You can also add it as a custom field inside a preset.
If it's set in both places - on the shipment and the courier object - then it uses the value on the shipment, and not in courier object.
\nIf you also use the option plugin_validate_anansi, which is similarly able to be set in the shipment and courier objects, Shipping will first call Anansi's Validate endpoint with the shipment information. If any of the parcels are uninsurable due to the Validate request, the create-label request will fail.
get from {{api_url}}/controlpanel/apiusers , in the list of users, the name field goes here
get from {{api_url}}/controlpanel/apiusers , click on view tokens and create a token. The token name is not used
We offer the Bulk (or Batch) api for people who want to send in a bunch of create-label requests at once and have those labels webhooked back one-by-one, or optionally webhooked back all in one merged file.
\nThe Bulk request takes 3 base parameters in the JSON: requests, which is an array of normal create-label json requests, but with the \"courier\" field added, webhook, which is where you define the URL we want to post the labels back to, and merge, which defaults to false and defines if you want one webhook per label or one webhook with all the labels merged.
In the \"requests\" array, the \"courier\" field is the only added field from a normal create-label request json. This needs to match what you would normally put in the URL for the courier, eg DHLParcelUK or AmazonShipping. Everything else inside each request object should be what you would normally put in a normal create-label request.
This Bulk api only works with webhooks, so if you don't define your webhook url, you won't get anything back! We post each label to the url you've defined in webhook, with the optional headers you define in \"headers\".
If you set \"merge\": true, then rather than posting each individual label as it completes, we'll wait for all labels to complete, and then merge them and post the merged pdfs to the webhook. Please note that \"merge\": true webhooks receive a different structure of response from \"merge\": false.
If \"merge\" is true, you may also use the \"collection_sheet\" option, \"collection_sheet\": true, which will append a conslidated list of items and locations to the front of your merged pdf.
get from {{api_url}}/controlpanel/apiusers , in the list of users, the name field goes here
get from {{api_url}}/controlpanel/apiusers , click on view tokens and create a token. The token name is not used
If \"merge\" is true, you may use the \"collection_sheet\" option, \"collection_sheet\": true, which will append a conslidated list of items and locations to the front of your merged pdf.
get from {{api_url}}/controlpanel/apiusers , in the list of users, the name field goes here
get from {{api_url}}/controlpanel/apiusers , click on view tokens and create a token. The token name is not used
Our SmartShipping system allows you to create settings to automatically choose a courier and a preset based on criteria you set up. Just submit the shipment to us and we'll choose the highest priority matching SmartShipping rule to send your parcel with.
\nIf you want to use only a particular smart-shipping group, put the \"smart_shipping_group\" field in your shipment json.
You may also specify the rule name you want to use with the field \"smart_shipping_name\".
The Shipping Charge and Requested Shipping Service parameters on the UI apply to the \"shipping_charge\" and \"requested_shipping_service\" fields in the shipment json, respectively.
If you want to test out which rule would run for a particular shipment, pass in \"return_rule\" : true at the root of your request object, outside of the \"shipment\" object.
If you set an \"auth_company\" in your smart-shipping request, it will override any \"auth_company\" that would have otherwise been set by the Smart Shipping rule.
When you set Split Parcels to true on your Smart Shipping Group, it will split any multi-parcel shipment into individual shipments and run smart-shipping on each one and then merge the results.
\n","urlObject":{"path":["api","couriers","v1","smart-shipping","create-label"],"host":["{{api_url}}"],"query":[],"variable":[]}},"response":[{"id":"cb49ab95-b78c-49b3-bafc-1f44ea68a5b2","name":"SmartShipping Create Label","originalRequest":{"method":"POST","header":[{"description":"get from {{api_url}}/controlpanel/apiusers , in the list of users, the `name` field goes here","key":"api-user","type":"text","value":"{{api-user}}"},{"description":"get from {{api_url}}/controlpanel/apiusers , click on `view tokens` and create a token. The token `name` is not used","key":"api-token","type":"text","value":"{{api-token}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n\t\"shipment\": {\r\n\t \"label_size\": \"6x4\",\r\n\t \"label_format\": \"pdf\",\r\n\t \"generate_commercial_invoice\": false,\r\n\t \"generate_packing_slip\": false,\r\n\t\r\n\t \"collection_date\": \"2019-11-18T16:30:49.054Z\",\r\n\t \"reference\": \"my reference\",\r\n\t \"delivery_instructions\": \"Leave on the porch\",\r\n\r\n \"smart_shipping_group\" : \"group1\",\r\n \"shipping_charge\" : 2.50,\r\n \"requested_shipping_service\" : \"FAST\",\r\n\t\r\n\t\r\n\t \"ship_from\": {\r\n\t \"name\": \"MN\",\r\n\t \"phone\": \"01377337164\",\r\n\t \"email\": \"foo@foo.com\",\r\n\t \"company_name\": \"Fake Company\",\r\n\t \"address_1\": \"unit 76\",\r\n\t \"address_2\": \"warfield road\",\r\n\t \"address_3\": \"\",\r\n\t \"city\": \"Driffield\",\r\n\t \"postcode\": \"YO25 9DJ\",\r\n\t \"county\": \"\",\r\n\t \"country_iso\": \"GB\",\r\n\t \"company_id\": \"911-70-1234\",\r\n\t \"tax_id\": \"911-70-1234\",\r\n \"eori_id\": \"911-70-1234-000\",\r\n \"ioss_number\" : \"IM2760000711\"\r\n\t },\r\n\t\r\n\t \"ship_to\": {\r\n\t \"name\": \"Laura Maura\",\r\n\t \"phone\": \"466546346546\",\r\n\t \"email\": \"support@buyer.com\",\r\n\t \"company_name\": \"\",\r\n\t \"address_1\": \"Ekeredsvaegen 132\",\r\n\t \"address_2\": \"\",\r\n\t \"address_3\": \"\",\r\n \"address_keywords\": \"\",\r\n\t \"city\": \"Lerum\",\r\n\t \"county\": \"\",\r\n\t \"postcode\": \"443 50\",\r\n\t \"country_iso\": \"SE\"\r\n\t },\r\n\t \"parcels\": [\r\n {\r\n \"dim_width\": 20,\r\n \"dim_height\": 40,\r\n \"dim_length\": 40,\r\n \"dim_unit\": \"cm\",\r\n\r\n \"items\": [\r\n {\r\n \"description\": \"Test Item One\",\r\n \"origin_country\": \"GB\",\r\n \"quantity\": 2,\r\n \"value\": 20,\r\n \"value_currency\": \"GBP\",\r\n \"weight\": 0.6,\r\n \"weight_unit\": \"kg\",\r\n \"sku\": \"EXPICKLIST\",\r\n \"hs_code\": \"12345\"\r\n }, {\r\n \"description\": \"Test Item Two\",\r\n \"origin_country\": \"GB\",\r\n \"quantity\": 1,\r\n \"value\": 5,\r\n \"value_currency\": \"GBP\",\r\n \"weight\": 0.4,\r\n \"weight_unit\": \"kg\",\r\n \"sku\": \"TEST0002\",\r\n \"hs_code\": \"12345\"\r\n }]\r\n },\r\n {\r\n \"dim_width\": 20,\r\n \"dim_height\": 40,\r\n \"dim_length\": 40,\r\n \"dim_unit\": \"cm\",\r\n\r\n \"items\": [\r\n {\r\n \"description\": \"Test Item One\",\r\n \"origin_country\": \"GB\",\r\n \"quantity\": 2,\r\n \"value\": 20,\r\n \"value_currency\": \"GBP\",\r\n \"weight\": 0.6,\r\n \"weight_unit\": \"kg\",\r\n \"sku\": \"EXPICKLIST\",\r\n \"hs_code\": \"12345\"\r\n }, {\r\n \"description\": \"Test Item Two\",\r\n \"origin_country\": \"GB\",\r\n \"quantity\": 1,\r\n \"value\": 5,\r\n \"value_currency\": \"GBP\",\r\n \"weight\": 0.4,\r\n \"weight_unit\": \"kg\",\r\n \"sku\": \"TEST0002\",\r\n \"hs_code\": \"12345\"\r\n }]\r\n }\r\n ]\r\n\t},\r\n\t\"format_address_default\" : true,\r\n\t\"request_id\": 123456789\r\n}"},"url":"{{api_url}}/api/couriers/v1/smart-shipping/create-label"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"uri\": \"http://vault.ecloud.co.uk/courierapi/1571116369_lowcost_bhrtt.pdf?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=HSEOVCX3IWRFNRTAZQT6%2F20191885%2Feu-west-2%2Fs3%2Faws4_request&X-Amz-Date=20191119T093984Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Signature=4626b1ffc529e9a8471229860fc6f72c184d0c8d81c179c60e59cf0ecd44fea8\",\r\n \"key\": \"1571116369_lowcost_bhrtt.pdf\",\r\n \"type\": \"PDF\",\r\n \"request_id\": \"1574156346168\",\r\n \"tracking_codes\": [\r\n \"JD0002249184029999\"\r\n ]\r\n}"}],"_postman_id":"869eba2b-a557-4283-b06d-8fd6ae60ac2e"},{"name":"Get Price","id":"502ef9f1-d9a2-4a49-bb4a-d4ed8a2fd399","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"api-user","value":"{{api-user}}","description":"get from {{api_url}}/controlpanel/apiusers , in the list of users, the name field goes here
get from {{api_url}}/controlpanel/apiusers , click on view tokens and create a token. The token name is not used
Once you've registered to DHL, you can begin submitting create-label requests. Each courier has different requirements for the \"courier\" section of the JSON, but most of the details will be shared by the majority of couriers. View the courier-specific differences here.
\nYou'll notice a \"label_format\" option in the shipment JSON. We support 'pdf', 'png' and 'zpl'. If you pass in 'png', the response will include a \"pngs\" key, which will be an array of base64-encoded pngs. If you pass in 'zpl', the response will include a \"zpl\" key, which will be a zpl string looking something like \"^XA^FO50,50^GFA,120200...\".
Parcels and items include some length and weight measurements. All length measurements should be in cm, and all weight in kg.
\nWhen it comes to specifying the item weight and value fields, those are for the total weight and value for that item. For example, if you have an item with a quantity of 2 and a unit weight of 3, you would put 6 in the item 'weight' field.
The \"ship_from\".\"tax_id\" field should be filled with a VAT number in most cases.
Please note: the auth_company field must match the company you registered with.
\n","urlObject":{"path":["api","couriers","v1","CitySprint","get-price"],"host":["{{api_url}}"],"query":[],"variable":[]}},"response":[{"id":"7ae86e8d-3234-4088-a13e-9cbfa217ea39","name":"Get Price from CitySprint","originalRequest":{"method":"POST","header":[{"key":"api-user","value":"{{api-user}}","description":"get from {{api_url}}/controlpanel/apiusers","type":"text"},{"key":"api-token","value":"{{api-token}}","description":"get from {{api_url}}/controlpanel/apiusers","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"testing\": false,\r\n \"auth_company\": \"company\",\r\n \"shipment\": {\r\n \"label_size\": \"6x4\",\r\n \"label_format\": \"pdf\",\r\n \"generate_invoice\": false,\r\n \"generate_packing_slip\": false,\r\n \r\n \"courier\" : {\r\n \"vehicle_type\": \"V\"\r\n },\r\n \r\n \"collection_date\": \"2019-11-18T16:30:49.054Z\",\r\n \"reference\": \"my reference\",\r\n \"reference_2\" : \"my second reference\",\r\n \"order_id\": \"1234\",\r\n \"delivery_instructions\": \"Leave on the porch\",\r\n \"parcel_description\": \"test items\",\r\n \"shipping_charge\" : 2.42,\r\n \r\n \"ship_from\": {\r\n \"name\": \"MN\",\r\n \"phone\": \"01377337164\",\r\n \"email\": \"foo@foo.com\",\r\n \"company_name\": \"Fake Company\",\r\n \"address_1\": \"unit 76\",\r\n \"address_2\": \"warfield road\",\r\n \"address_3\": \"\",\r\n \"city\": \"Driffield\",\r\n \"postcode\": \"YO25 9DJ\",\r\n \"county\": \"\",\r\n \"country_iso\": \"GB\",\r\n \"company_id\": \"911-70-1234\",\r\n \"tax_id\": \"911-70-1234\",\r\n \"eori_id\": \"911-70-1234-000\",\r\n \"ioss_number\" : \"IM2760000711\"\r\n },\r\n \r\n \"ship_to\": {\r\n \"name\": \"Laura Maura\",\r\n \"phone\": \"466546346546\",\r\n \"email\": \"support@buyer.com\",\r\n \"company_name\": \"\",\r\n \"address_1\": \"Ekeredsvaegen 132\",\r\n \"address_2\": \"\",\r\n \"address_3\": \"\",\r\n \"city\": \"Lerum\",\r\n \"county\": \"\",\r\n \"postcode\": \"443 50\",\r\n \"country_iso\": \"SE\",\r\n \"company_id\": \"911-70-1234\",\r\n \"tax_id\": \"911-70-1234\",\r\n \"eori_id\": \"911-70-1234-000\",\r\n \"ioss_number\" : \"IM2760000711\"\r\n },\r\n \"parcels\": [\r\n {\r\n \"dim_width\": 50,\r\n \"dim_height\": 80,\r\n \"dim_length\": 40,\r\n \"dim_unit\": \"cm\",\r\n \r\n \"items\": [\r\n {\r\n \"description\": \"Test Item One\",\r\n \"origin_country\": \"GB\",\r\n \"quantity\": 1,\r\n \"value\": 20,\r\n \"value_currency\": \"GBP\",\r\n \"weight\": 0.6,\r\n \"weight_unit\": \"kg\",\r\n \"sku\": \"TEST0001\",\r\n \"hs_code\": \"12345\"\r\n }, {\r\n \"description\": \"Test Item One\",\r\n \"origin_country\": \"GB\",\r\n \"quantity\": 1,\r\n \"value\": 5,\r\n \"value_currency\": \"GBP\",\r\n \"weight\": 0.4,\r\n \"weight_unit\": \"kg\",\r\n \"sku\": \"TEST0001\",\r\n \"hs_code\": \"12345\"\r\n }]\r\n }\r\n ]\r\n },\r\n \"format_address_default\" : true,\r\n \"request_id\": 123456789\r\n}"},"url":"{{api_url}}/api/couriers/v1/CitySprint/get-price"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"base_price\": 9.95,\n \"fuel_price\": 1.49,\n \"surcharge_price\": 2.29,\n \"total_price\": 13.73\n}"}],"_postman_id":"502ef9f1-d9a2-4a49-bb4a-d4ed8a2fd399"},{"name":"Get Tracking","id":"08e88932-0640-4da0-a2ec-4077868262ec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"get from {{api_url}}/controlpanel/apiusers , in the list of users, the name field goes here
get from {{api_url}}/controlpanel/apiusers , click on view tokens and create a token. The token name is not used
After creating a label, you may use this service to get tracking information.
\nEach create-label response includes two fields: tracking_request_id and tracking_request_hash. Send these to the 'get-tracking' endpoint to get a history of tracking for your shipment parcels.
get from {{api_url}}/controlpanel/apiusers , in the list of users, the name field goes here
get from {{api_url}}/controlpanel/apiusers , click on view tokens and create a token. The token name is not used
Queue Tracking is almost EXACTLY like a create-label request, with some exceptions that match it's unique purpose.
\nWhile create-label is used to request a label, and then creates a shipment record on our system, this queue-tracking request skips the process of creating a label and only creates a shipment record on our system, which is ready for us to start tracking.
\nThis allows you to submit a shipment to us for a label that was created outside of our system, but still use our system for the 'get-tracking' api.
\nThere are a few differences in what we expect compared to a create-label shipment, but first I'll detail what's the same. We expect the same 'testing' and 'auth_company' fields as you would submit with create-label, and we also expect the 'shipment' json.
The differences are, we don't expect the 'courier' section of the shipment json, and we don't use the 'ship_from' address. We still expect 'ship_to', and for some couriers we need the 'ship_to.postcode' field in order to offer tracking functionality.
Instead of a 'parcels' array, here we expect a 'tracking_codes' array. Additionally, for some couriers we expect a 'courier_specifics' section that has additional information required to track -- at the moment, only one courier requires this, AmazonShipping. I'll show how that would be handled in the example.
get from {{api_url}}/controlpanel/apiusers , in the list of users, the name field goes here
get from {{api_url}}/controlpanel/apiusers , click on view tokens and create a token. The token name is not used
Use this api to mark a shipment as cancelled on our system, as viewable on the 'shipments' page.
\nUse the \"cancel_label\" : true option to send the correct cancel-label request to the actual courier, if applicable.
Not all couriers support actually cancelling a label - if you've sent a request to cancel a label via this api to such a courier, the info field of the response json will notify you with the message \"cancelLabel not supported for this courier; the shipment was marked as cancelled on our system but the courier may still need to be notified\"
You can specify \"dc_request_id\" instead of \"reference\".
get from {{api_url}}/controlpanel/apiusers , in the list of users, the name field goes here
get from {{api_url}}/controlpanel/apiusers , click on view tokens and create a token. The token name is not used
Use this api to mark a shipments as cancelled on our system in bulk.
\nEach object in the \"requests\" array must be what you would send to the mark-shipment-cancelled endpoints. The results will be webhooked back to the url you specify in \"webhook\" upon completion.
Use the \"cancel_label\" : true option to send the correct cancel-label request to the actual courier, if applicable.
Not all couriers support actually cancelling a label - if you've sent a request to cancel a label via this api to such a courier, the info field of the response json will notify you with the message \"cancelLabel not supported for this courier; the shipment was marked as cancelled on our system but the courier may still need to be notified\"
get from {{api_url}}/controlpanel/apiusers , in the list of users, the name field goes here
get from {{api_url}}/controlpanel/apiusers , click on view tokens and create a token. The token name is not used
After creating a label, many of our couriers offer a 'create-manifest' functionality. Each one, however, may require different parameters.
\nRoyalMail doesn't require any parameters apart from 'testing' and 'auth_company', as appropriate.
\n","urlObject":{"path":["api","couriers","v1","RoyalMail","create-manifest"],"host":["{{api_url}}"],"query":[],"variable":[]}},"response":[{"id":"269c3a35-4224-433e-8eb4-59b285b6100f","name":"CreateManifest","originalRequest":{"method":"POST","header":[{"key":"api-user","value":"{{api-user}}","description":"get from {{api_url}}/controlpanel/apiusers","type":"text"},{"key":"api-token","value":"{{api-token}}","description":"get from {{api_url}}/controlpanel/apiusers","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"testing\":\t\t\tfalse,\r\n\t\"auth_company\":\t\t\"company\"\r\n}"},"url":"{{api_url}}/api/couriers/v1/RoyalMail/create-manifest"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n\t\"uri\":\t\t\t\"http://vault.ecloud.co.uk/courierapi/23423423epqry.pdf?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=HSEOVCX3IWRFNRTAZBR7%2F20200213%2Feu-west-2%2Fs3%2Faws4_request&X-Amz-Date=20200213T130119Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Signature=14f5d66e99885fa079e3f2fd07c8b654sd6f84c68ee712aa6ed6f8e\",\r\n\t\"key\":\t\t\"23423423epqry.pdf\"\r\n}"}],"_postman_id":"9648ca2a-d9e9-42b6-af9a-e9a7c8217528"},{"name":"Get Pickup Locations","id":"c9cad327-21e7-4b14-aef9-b7b7728471c1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"get from {{api_url}}/controlpanel/apiusers , in the list of users, the name field goes here
get from {{api_url}}/controlpanel/apiusers , click on view tokens and create a token. The token name is not used
Some couriers support shipments where the end customer can pick up their parcel from a pickup location. Right now, those couriers are: DPD, HermesCorporate and UPS.
\nWe'll use DPD here as an example.
\nIn order to submit the request to DPD to set up such a pickup shipment to our create-label endpoint, you will first need to have a pickup_location to submit. That's what this request is for.
\nThis request expects json similar to the create-label request in terms of \"testing\" and \"auth_company\", but instead of a \"shipment\" you submit an \"address\", which should look identical to what you would normally put in the \"ship_to\" section of a create-label request. Different couriers may require different sections of this to function properly -- for example, DPD only uses the country_iso and postcode fields, but other couriers may behave differently.
Once you get the response back, which should be a list of pickup locations, you can take one of these pickup locations in the case of DPD and put it inside the \"courier\" section of the request json. So you would have, in your create-label request, a section of json that looks like this:
\"courier\": {\n \"network_code\": \"2^91\",\n \"pickup_location\" : {\n \"address\": {\n \"countryCode\": \"GB\",\n \"county\": \"West Midlands\",\n \"locality\": \"Birmingham\",\n \"organisation\": \"DPD\",\n \"postcode\": \"B69 4BF\",\n \"property\": \"Hub 3\",\n \"street\": \"A Street\",\n \"town\": \"Oldbury\"\n },\n \"allowRemotePickup\": true,\n \"pickupLocationCode\": \"GB14478\"\n }\n },\nThe above example is very DPD-specific, each courier will behave slightly differently in regards to these pickup apis. Please contact us for advice if there are any unanswered questions.
\n","urlObject":{"path":["api","couriers","v1","DPD","get-pickup-locations"],"host":["{{api_url}}"],"query":[],"variable":[]}},"response":[{"id":"923e855f-7ae0-4813-a71b-0093a40639e7","name":"Get Pickup Locations","originalRequest":{"method":"POST","header":[{"key":"api-user","value":"{{api-user}}","description":"get from {{api_url}}/controlpanel/apiusers","type":"text"},{"key":"api-token","value":"{{api-token}}","description":"get from {{api_url}}/controlpanel/apiusers","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"testing\": true,\r\n \"auth_company\" : \"YTC\",\r\n \"address\" : {\r\n \"name\": \"Nate Matty\",\r\n \"phone\": \"07841552355\",\r\n \"email\": \"n.matty@ymail.com\",\r\n \"company_name\": \"Nate Matty\",\r\n \"address_1\": \"Roebuck Lane\",\r\n \"address_2\": \"\",\r\n \"address_3\": \"\",\r\n \"city\": \"Birmingham\",\r\n \"county\": \"\",\r\n \"postcode\": \"B66 1BY\",\r\n \"country_iso\": \"GB\"\r\n }\r\n}"},"url":"{{api_url}}/api/couriers/v1/DPD/get-pickup-locations"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"[\n {\n \"pickupLocation\": {\n \"pickupLocationCode\": \"GB17223\",\n \"address\": {\n \"organisation\": \"Oldbury Express\",\n \"property\": \"\",\n \"street\": \"Unit10-1 West Cross Shopping Centre\",\n \"locality\": \"\",\n \"town\": \"Smethwick\",\n \"county\": \"\",\n \"postcode\": \"B66 1JG\",\n \"countryCode\": \"GB\"\n },\n \"pickupLocationType\": \"200\",\n \"addressPoint\": {\n \"latitude\": 52.502155,\n \"longitude\": -1.990345\n },\n \"languageSpoken\": \"en\",\n \"disabledAccess\": false,\n \"parkingAvailable\": false,\n \"geoServiceCode\": [\n \"100\",\n \"200\",\n \"201\",\n \"203\",\n \"306\"\n ],\n \"pickupLocationDirections\": \"\",\n \"pickupLocationAvailability\": {\n \"pickupLocationActiveStart\": \"2020-10-13\",\n \"pickupLocationActiveEnd\": \"n/a\",\n \"pickupLocationDeliveryStart\": \"n/a\",\n \"pickupLocationDeliveryClosed\": \"n/a\",\n \"pickupLocationOpeningExceptions\": \"\",\n \"pickupLocationOpenWindow\": [\n {\n \"pickupLocationOpenWindowStartTime\": \"07:00\",\n \"pickupLocationOpenWindowEndTime\": \"12:00\",\n \"pickupLocationOpenWindowDay\": 1\n },\n {\n \"pickupLocationOpenWindowStartTime\": \"12:00\",\n \"pickupLocationOpenWindowEndTime\": \"23:00\",\n \"pickupLocationOpenWindowDay\": 1\n },\n {\n \"pickupLocationOpenWindowStartTime\": \"07:00\",\n \"pickupLocationOpenWindowEndTime\": \"12:00\",\n \"pickupLocationOpenWindowDay\": 2\n },\n {\n \"pickupLocationOpenWindowStartTime\": \"12:00\",\n \"pickupLocationOpenWindowEndTime\": \"23:00\",\n \"pickupLocationOpenWindowDay\": 2\n },\n {\n \"pickupLocationOpenWindowStartTime\": \"07:00\",\n \"pickupLocationOpenWindowEndTime\": \"12:00\",\n \"pickupLocationOpenWindowDay\": 3\n },\n {\n \"pickupLocationOpenWindowStartTime\": \"12:00\",\n \"pickupLocationOpenWindowEndTime\": \"23:00\",\n \"pickupLocationOpenWindowDay\": 3\n },\n {\n \"pickupLocationOpenWindowStartTime\": \"07:00\",\n \"pickupLocationOpenWindowEndTime\": \"12:00\",\n \"pickupLocationOpenWindowDay\": 4\n },\n {\n \"pickupLocationOpenWindowStartTime\": \"12:00\",\n \"pickupLocationOpenWindowEndTime\": \"23:00\",\n \"pickupLocationOpenWindowDay\": 4\n },\n {\n \"pickupLocationOpenWindowStartTime\": \"07:00\",\n \"pickupLocationOpenWindowEndTime\": \"12:00\",\n \"pickupLocationOpenWindowDay\": 5\n },\n {\n \"pickupLocationOpenWindowStartTime\": \"12:00\",\n \"pickupLocationOpenWindowEndTime\": \"23:00\",\n \"pickupLocationOpenWindowDay\": 5\n },\n {\n \"pickupLocationOpenWindowStartTime\": \"07:00\",\n \"pickupLocationOpenWindowEndTime\": \"12:00\",\n \"pickupLocationOpenWindowDay\": 6\n },\n {\n \"pickupLocationOpenWindowStartTime\": \"12:00\",\n \"pickupLocationOpenWindowEndTime\": \"23:00\",\n \"pickupLocationOpenWindowDay\": 6\n },\n {\n \"pickupLocationOpenWindowStartTime\": \"07:00\",\n \"pickupLocationOpenWindowEndTime\": \"12:00\",\n \"pickupLocationOpenWindowDay\": 7\n },\n {\n \"pickupLocationOpenWindowStartTime\": \"12:00\",\n \"pickupLocationOpenWindowEndTime\": \"23:00\",\n \"pickupLocationOpenWindowDay\": 7\n }\n ],\n \"pickupLocationDownTime\": []\n },\n \"openLate\": true,\n \"openSaturday\": true,\n \"openSunday\": true,\n \"shortName\": \"Oldbury Express\",\n \"pickupLocationImageUrl\": null,\n \"pickupLocationLogoUrl\": null,\n \"pickupLocationDriverWindow\": [\n {\n \"pickupLocationDriverWindowStartTime\": \"08:00\",\n \"pickupLocationDriverWindowEndTime\": \"21:00\",\n \"pickupLocationDriverWindowDay\": 1\n },\n {\n \"pickupLocationDriverWindowStartTime\": \"08:00\",\n \"pickupLocationDriverWindowEndTime\": \"21:00\",\n \"pickupLocationDriverWindowDay\": 2\n },\n {\n \"pickupLocationDriverWindowStartTime\": \"08:00\",\n \"pickupLocationDriverWindowEndTime\": \"21:00\",\n \"pickupLocationDriverWindowDay\": 3\n },\n {\n \"pickupLocationDriverWindowStartTime\": \"08:00\",\n \"pickupLocationDriverWindowEndTime\": \"21:00\",\n \"pickupLocationDriverWindowDay\": 4\n },\n {\n \"pickupLocationDriverWindowStartTime\": \"08:00\",\n \"pickupLocationDriverWindowEndTime\": \"21:00\",\n \"pickupLocationDriverWindowDay\": 5\n },\n {\n \"pickupLocationDriverWindowStartTime\": \"08:00\",\n \"pickupLocationDriverWindowEndTime\": \"21:00\",\n \"pickupLocationDriverWindowDay\": 6\n },\n {\n \"pickupLocationDriverWindowStartTime\": \"08:00\",\n \"pickupLocationDriverWindowEndTime\": \"21:00\",\n \"pickupLocationDriverWindowDay\": 7\n }\n ],\n \"preventSameDayNotAtHome\": \"N\",\n \"paypointLocation\": \"77232\",\n \"depotCode\": \"0059\",\n \"depotDescription\": \"Dudley Port\"\n },\n \"distance\": 0.5591486296073641,\n \"addressPoint\": {\n \"latitude\": 52.505581,\n \"longitude\": -1.978301\n }\n }\n]"}],"_postman_id":"c9cad327-21e7-4b14-aef9-b7b7728471c1"},{"name":"Create Collection","id":"647f00ad-dc92-4439-abd1-7f98a1896575","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"get from {{api_url}}/controlpanel/apiusers , in the list of users, the name field goes here
get from {{api_url}}/controlpanel/apiusers , click on view tokens and create a token. The token name is not used
If you wish to book a collection, different couriers will require different things. We’ve followed a\nsimilar schema to the create-label endpoint, but instead of a shipment object, we use\ncollection .
To find out which couriers support collections, you can see collection_supported as a value\nunder the /list-couriers endpoint. Certain couriers will allow different specifics which can be\nspecified within the courier object. If a courier requires a certain key and value, the API will error\nstating that a value for that key is required. If a value is submitted but is not required for the\ncourier to book a collection, the API will respond saying the specify value has been ignored and the\nvalue has been inherited elsewhere. If a courier requires you to submit which shipments are part of\nthe collection, these can be specified as an array within tracking_codes.
get from {{api_url}}/controlpanel/apiusers , in the list of users, the name field goes here
get from {{api_url}}/controlpanel/apiusers , click on view tokens and create a token. The token name is not used
If a courier supports cancelling of collections, you can simply supply the collection_id from the\ncreate-collection response. In UPS’s case, the collection_id is what UPS refer to as a PRN.\nSimply submitting this value as collection_id under the collection object will result in the\ncancellation of the collection.
get from {{api_url}}/controlpanel/apiusers , in the list of users, the name field goes here
get from {{api_url}}/controlpanel/apiusers , click on view tokens and create a token. The token name is not used
Use this call to delete any registered auths. Much like the create-label call, or any other call that relies on a registered auth, this call depends on the testing and auth_company fields matching the registered auth to work as expected.
get from {{api_url}}/controlpanel/apiusers , in the list of users, the name field goes here
get from {{api_url}}/controlpanel/apiusers , click on view tokens and create a token. The token name is not used
Each courier has unique auth rules to register before you can create labels with them. Before registering auth, make sure you have the correct details and are submitting the required fields.
\n","urlObject":{"path":["api","couriers","v1","DPD","presets"],"host":["{{api_url}}"],"query":[],"variable":[]}},"response":[{"id":"83cf8a90-df4b-41db-bb5e-a38f29defea7","name":"Get Courier Presets","originalRequest":{"method":"GET","header":[{"description":"get from {{api_url}}/controlpanel/apiusers","key":"api-user","type":"text","value":"{{api-user}}"},{"description":"get from {{api_url}}/controlpanel/apiusers","key":"api-token","type":"text","value":"{{api-token}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"url":"{{api_url}}/api/couriers/v1/DPD/presets"},"status":"No api-key or api-token set in header","code":401,"_postman_previewlanguage":"html","header":[{"key":"Date","value":"Tue, 26 Nov 2019 17:45:06 GMT"},{"key":"Content-Type","value":"text/html; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/7.2.24"},{"key":"X-Xdebug-Profile-Filename","value":"/tmp/cachegrind.out.10129"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"53bdac840b846a89-LHR"}],"cookie":[],"responseTime":null,"body":"{\n \"user_presets\":[{\"id\":4,\"created_at\":null,\"updated_at\":\"2019-11-22 16:34:31\",\"dc_service_id\":\"dc_dpd_1\",\"api_user_id\":2,\"courier\":\"DPD\",\"json\":\"{\\\"network_code\\\":\\\"1^10\\\"}\",\"name\":\"DC DPD 1\"},{\"id\":17,\"created_at\":\"2019-11-22 17:37:42\",\"updated_at\":\"2019-11-22 17:37:42\",\"dc_service_id\":\"e\",\"api_user_id\":2,\"courier\":\"DPD\",\"json\":\"{\\\"network_code\\\":\\\"2^12\\\"}\",\"name\":\"DC DPD 1\"}],\n \"system_presets\":[{\"id\":1,\"created_at\":null,\"updated_at\":\"2019-11-22 14:46:00\",\"dc_service_id\":\"dc_dpd_1\",\"api_user_id\":null,\"courier\":\"DPD\",\"json\":\"{\\\"network_code\\\":\\\"1^12\\\"}\",\"name\":\"\"},{\"id\":9,\"created_at\":\"2019-11-22 16:35:33\",\"updated_at\":\"2019-11-22 16:35:33\",\"dc_service_id\":\"ducky\",\"api_user_id\":null,\"courier\":\"DPD\",\"json\":\"{\\\"network_code\\\":\\\"1^15\\\"}\"\",\"name\":\"Ducky\"}]\n }"}],"_postman_id":"559c6780-5551-4e11-b12f-83ab853476f1"},{"name":"Get Courier Specifics","id":"66bfa99c-51d3-44d4-85c5-9479187cec1a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"get from {{api_url}}/controlpanel/apiusers , in the list of users, the name field goes here
get from {{api_url}}/controlpanel/apiusers , click on view tokens and create a token. The token name is not used
Each courier has unique specific fields that are either required or optional to put in the 'courier' section of the 'shipment' JSON when you post a create-label request. Use this request to get the details for those fields.
\n","urlObject":{"path":["api","couriers","v1","AmazonShipping","courier-specifics"],"host":["{{api_url}}"],"query":[],"variable":[]}},"response":[{"id":"7f82f344-642b-477f-8dc1-a71784cbd4bc","name":"Get Courier Specifics","originalRequest":{"method":"GET","header":[{"description":"get from {{api_url}}/controlpanel/apiusers , in the list of users, the `name` field goes here","key":"api-user","type":"text","value":"{{api-user}}"},{"description":"get from {{api_url}}/controlpanel/apiusers , click on `view tokens` and create a token. The token `name` is not used","key":"api-token","type":"text","value":"{{api-token}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"url":"{{api_url}}/api/couriers/v1/AmazonShipping/courier-specifics"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\"required\":[{\"name\":\"service_code\",\"type\":\"string\",\"description\":\"Example: \\\"SWA-UK-PRIME-PREM\\\"\"}],\"optional\":[{\"name\":\"business_type\",\"type\":\"string\",\"description\":\"defaults to \\\"B2C\\\", alternative is \\\"B2B\\\"\"},{\"name\":\"shipping_purpose\",\"type\":\"string\",\"description\":\"defaults to \\\"SALE\\\"\"}]}"}],"_postman_id":"66bfa99c-51d3-44d4-85c5-9479187cec1a"},{"name":"List Registered Couriers","id":"f73c2068-aeba-476c-ab4b-e099fecbf9ef","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"get from {{api_url}}/controlpanel/apiusers , in the list of users, the name field goes here
get from {{api_url}}/controlpanel/apiusers , click on view tokens and create a token. The token name is not used
Use this request to get a list of all of the couriers you've registered with.
\n","urlObject":{"path":["api","couriers","v1","list-registered-couriers"],"host":["{{api_url}}"],"query":[],"variable":[]}},"response":[{"id":"8572f8c3-51d4-4a5c-b7be-ec606c2f5e54","name":"List Registered Couriers","originalRequest":{"method":"GET","header":[{"description":"get from {{api_url}}/controlpanel/apiusers , in the list of users, the `name` field goes here","key":"api-user","type":"text","value":"{{api-user}}"},{"description":"get from {{api_url}}/controlpanel/apiusers , click on `view tokens` and create a token. The token `name` is not used","key":"api-token","type":"text","value":"{{api-token}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"url":"{{api_url}}/api/couriers/v1/list-registered-couriers"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"[{\"courier\":\"APC\",\"testing\":true,\"auth_company\":\"wildlife\",\"auth_details\":{\"email\":\"sales@wildlife.co.uk\",\"password\":\"twentyone22\"}}]"}],"_postman_id":"f73c2068-aeba-476c-ab4b-e099fecbf9ef"},{"name":"Renew Label","id":"a15e054e-51fa-447e-80d4-16a885dec964","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{api_url}}/api/pdfs/renew?key={pdf_key}","description":"When you make a 'create-label' call, our system returns a uri and a key. The uri is usually only valid for 1 hour, but you can use the key with this api to get a renewed uri link.
\n","urlObject":{"path":["api","pdfs","renew"],"host":["{{api_url}}"],"query":[{"key":"key","value":"{pdf_key}"}],"variable":[]}},"response":[{"id":"bba138e0-39b8-4ab4-8983-a15dd2009092","name":"Renew Label","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{api_url}}/api/pdfs/renew?key=pdf_test_1585930176_bfxuc_1.pdf","host":["{{api_url}}"],"path":["api","pdfs","renew"],"query":[{"key":"key","value":"pdf_test_1585930176_bfxuc_1.pdf"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"key\": \"pdf_test_1585930176_bfxuc_1.pdf\",\r\n \"uri\": \"http://vault.ecloud.co.uk/courierapi/pdf_test_1585930176_bfxuc_1.pdf?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=HSEOVCX3IWRFNRTAZBR7%2F20200413%2Feu-west-2%2Fs3%2Faws4_request&X-Amz-Date=20200413T083648Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Signature=8a6161d690a3b9a38d6826472f2da34b5493df443b7518282d8d44b789cced37\"\r\n}"}],"_postman_id":"a15e054e-51fa-447e-80d4-16a885dec964"},{"name":"Get Shipments","id":"fadcf28a-240a-4d95-b469-5d8f8f56bf36","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{api_url}}/api/shipments.json","description":"You can get the shipments json from our system with this call. It supports a few different types of filters.
\n/api/shipments.json?startDateFilter=2020-05-15&endDateFilter=2020-06-01\n/api/shipments.json?startDateFilter=2020-05-28 15:00:00&endDateFilter=2020-05-28 16:00:00\n/api/shipments.json?startDateFilter=2020-05-28T15:00:00&endDateFilter=2020-05-28T16:00:00\n/api/shipments.json?page=2\n/api/shipments.json?dc_request_id=4029\n/api/shipments.json?reference=xx\nThe api returns a max of 50 results -- use the page query string to get the next page of results.
To use a date filter, you must provide BOTH the startDateFilter and endDateFilter
get from {{api_url}}/controlpanel/apiusers , in the list of users, the name field goes here
get from {{api_url}}/controlpanel/apiusers , click on view tokens and create a token. The token name is not used
Pass in the dc_request_id of a previously generated label to get a commercial invoice for it.
\n","urlObject":{"path":["api","commercial-invoice","{{dc_request_id}}"],"host":["{{api_url}}"],"query":[],"variable":[]}},"response":[{"id":"dd3dfa5d-4eec-49ad-9212-bae098fdac76","name":"Generate Commercial Invoice","originalRequest":{"method":"GET","header":[{"description":"get from {{api_url}}/controlpanel/apiusers","key":"api-user","type":"text","value":"{{api-user}}"},{"description":"get from {{api_url}}/controlpanel/apiusers","key":"api-token","type":"text","value":"{{api-token}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"url":"{{api_url}}/api/commercial-invoice/{{dc_request_id}}"},"status":"No api-key or api-token set in header","code":401,"_postman_previewlanguage":"html","header":[{"key":"Date","value":"Tue, 26 Nov 2019 17:45:06 GMT"},{"key":"Content-Type","value":"text/html; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/7.2.24"},{"key":"X-Xdebug-Profile-Filename","value":"/tmp/cachegrind.out.10129"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"53bdac840b846a89-LHR"}],"cookie":[],"responseTime":null,"body":"{\n \"url\": \"https://storageserversam.s3.eu-west-2.amazonaws.com/courierapi/m3EepeRPXuwQkwRxTFQc.pdf?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2GR3ABGL2AFT4WNM%2F20240111%2Feu-west-2%2Fs3%2Faws4_request&X-Amz-Date=20240111T120048Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Signature=cc4af2725b98c8fe8ed488f4ac5cf8a66c01eb766b4adf7a6a3b7a2720110b01\",\n \"key\": \"m3EepeRPXuwQkwRxTFQc.pdf\"\n}"}],"_postman_id":"4446e283-9228-4c78-92c7-0aa8680f3501"},{"name":"Generate a Packing Slip for Prior Label","id":"e06f73cf-df27-40db-8416-74631f0caf11","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"api-user","value":"{{api-user}}","description":"get from {{api_url}}/controlpanel/apiusers , in the list of users, the name field goes here
get from {{api_url}}/controlpanel/apiusers , click on view tokens and create a token. The token name is not used
Pass in the dc_request_id of a previously generated label to get a packing slip for it.
\n","urlObject":{"path":["api","packing-slip","{{dc_request_id}}"],"host":["{{api_url}"],"query":[],"variable":[]}},"response":[{"id":"4c3e2508-07ff-405c-97be-2f4b5c4ec93f","name":"Generate Packing Slip","originalRequest":{"method":"GET","header":[{"description":"get from {{api_url}}/controlpanel/apiusers","key":"api-user","type":"text","value":"{{api-user}}"},{"description":"get from {{api_url}}/controlpanel/apiusers","key":"api-token","type":"text","value":"{{api-token}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"url":"{{api_url}/api/packing-slip/{{dc_request_id}}"},"status":"No api-key or api-token set in header","code":401,"_postman_previewlanguage":"html","header":[{"key":"Date","value":"Tue, 26 Nov 2019 17:45:06 GMT"},{"key":"Content-Type","value":"text/html; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/7.2.24"},{"key":"X-Xdebug-Profile-Filename","value":"/tmp/cachegrind.out.10129"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"53bdac840b846a89-LHR"}],"cookie":[],"responseTime":null,"body":"{\n \"url\": \"https://storageserversam.s3.eu-west-2.amazonaws.com/courierapi/kbpcYN7bw7niMkXjxM9y.pdf?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2GR3ABGL2AFT4WNM%2F20240111%2Feu-west-2%2Fs3%2Faws4_request&X-Amz-Date=20240111T120114Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Signature=f0fffc47a152093d3969fc5f98a34e32aad1790b7ee156f93ec097d3f4cca2f3\",\n \"key\": \"kbpcYN7bw7niMkXjxM9y.pdf\"\n}"}],"_postman_id":"e06f73cf-df27-40db-8416-74631f0caf11"},{"name":"Create a New Api User","id":"db221c68-2ceb-49d7-b837-30fdfcb740e5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"api-user","value":"{{api-user}}","description":"get from {{api_url}}/controlpanel/apiusers , in the list of users, the name field goes here
get from {{api_url}}/controlpanel/apiusers , click on view tokens and create a token. The token name is not used
This post request creates a new API User with the specified name and optional key -- if key is not provided, we will generate one for you and return it in the response json.
The API User created will belong to the same User account as the API User that created it.
\nIn addition, you can specify which api user group to put it in using the optional api_user_group_name parameter.
get from {{api_url}}/controlpanel/apiusers , in the list of users, the name field goes here
get from {{api_url}}/controlpanel/apiusers , click on view tokens and create a token. The token name is not used
This post request triggers Courier API to register a tracking event of Packed against any shipment that's currently in 'Booked' status.
\n","urlObject":{"path":["api","couriers","v1","mark-shipment-packed"],"host":["{{api_url}}"],"query":[],"variable":[]}},"response":[{"id":"0211ea5e-324d-4149-be66-87a158a64ece","name":"Create a Packed Tracking Event","originalRequest":{"method":"POST","header":[{"key":"api-user","value":"{{api-user}}","description":"get from {{api_url}}/controlpanel/apiusers","type":"text"},{"key":"api-token","value":"{{api-token}}","description":"get from {{api_url}}/controlpanel/apiusers","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"reference\" : \"your_shipment_reference_here\"\r\n}"},"url":"{{api_url}}/api/couriers/v1/mark-shipment-packed"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 18 Nov 2019 16:05:22 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/7.2.24"},{"key":"X-Xdebug-Profile-Filename","value":"/tmp/cachegrind.out.2142"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"537b2f56ad17dc4b-LHR"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true\n}"}],"_postman_id":"606973cc-1c04-425b-9158-d870fb50eaf2"},{"name":"Billing - Low Cost Routing","id":"846b8dbe-6f43-4c83-9ae6-2be5f6d19547","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"api-user","value":"{{api-user}}","description":"get from {{api_url}}/controlpanel/apiusers , in the list of users, the name field goes here
get from {{api_url}}/controlpanel/apiusers , click on view tokens and create a token. The token name is not used
This route is for getting the lowest-cost routing option from billing api.
\nPlease note the \"billing\" section of the json, which is required to
get from {{api_url}}/controlpanel/apiusers , in the list of users, the name field goes here
get from {{api_url}}/controlpanel/apiusers , click on view tokens and create a token. The token name is not used
This LIST route is the same as the LCR route above, except instead of returning a single low-cost result, it returns all available options for the shipment according to Billing API.
\n","urlObject":{"path":["couriers","v1","billing-quote","list"],"host":["{{api_url}}"],"query":[],"variable":[]}},"response":[{"id":"9fad7e9a-816c-4564-a704-1bff3ec89339","name":"List Routing","originalRequest":{"method":"POST","header":[{"key":"api-user","value":"{{api-user}}","description":"get from {{api_url}}/controlpanel/apiusers","type":"text"},{"key":"api-token","value":"{{api-token}}","description":"get from {{api_url}}/controlpanel/apiusers","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"testing\": false,\r\n \"auth_company\": \"company\",\r\n \"shipment\": {\r\n \"label_size\": \"6x4\",\r\n \"label_format\": \"pdf\",\r\n \"generate_invoice\": false,\r\n \"generate_packing_slip\": false,\r\n\r\n \"billing\": {\r\n \"token\": \"dZiPH88beDgfZSLG\",\r\n \"customer_dc_id\": \"103\"\r\n },\r\n\r\n \"extra_details\" : {\r\n \"channel_order_id\" : 22\r\n },\r\n \r\n \"collection_date\": \"2019-11-18T16:30:49.054Z\",\r\n \"reference\": \"my reference\",\r\n \"reference_2\" : \"my second reference\",\r\n \"order_id\": \"1234\",\r\n \"delivery_instructions\": \"Leave on the porch\",\r\n \"parcel_description\": \"test items\",\r\n \"shipping_charge\" : 2.42,\r\n \r\n \"ship_from\": {\r\n \"name\": \"MN\",\r\n \"phone\": \"01377337164\",\r\n \"email\": \"foo@foo.com\",\r\n \"company_name\": \"Fake Company\",\r\n \"address_1\": \"unit 76\",\r\n \"address_2\": \"warfield road\",\r\n \"address_3\": \"\",\r\n \"city\": \"Driffield\",\r\n \"postcode\": \"YO25 9DJ\",\r\n \"county\": \"\",\r\n \"country_iso\": \"GB\",\r\n \"company_id\": \"911-70-1234\",\r\n \"tax_id\": \"911-70-1234\",\r\n \"eori_id\": \"911-70-1234-000\",\r\n \"ioss_number\" : \"IM2760000711\"\r\n },\r\n \r\n \"ship_to\": {\r\n \"name\": \"Laura Maura\",\r\n \"phone\": \"466546346546\",\r\n \"email\": \"support@buyer.com\",\r\n \"company_name\": \"\",\r\n \"address_1\": \"Ekeredsvaegen 132\",\r\n \"address_2\": \"\",\r\n \"address_3\": \"\",\r\n \"city\": \"Lerum\",\r\n \"county\": \"\",\r\n \"postcode\": \"443 50\",\r\n \"country_iso\": \"SE\",\r\n \"company_id\": \"911-70-1234\",\r\n \"tax_id\": \"911-70-1234\",\r\n \"eori_id\": \"911-70-1234-000\",\r\n \"ioss_number\" : \"IM2760000711\"\r\n },\r\n \"parcels\": [\r\n {\r\n \"dim_width\": 50,\r\n \"dim_height\": 80,\r\n \"dim_length\": 40,\r\n \"dim_unit\": \"cm\",\r\n \r\n \"items\": [\r\n {\r\n \"description\": \"Test Item One\",\r\n \"origin_country\": \"GB\",\r\n \"quantity\": 1,\r\n \"value\": 20,\r\n \"value_currency\": \"GBP\",\r\n \"weight\": 0.6,\r\n \"weight_unit\": \"kg\",\r\n \"sku\": \"TEST0001\",\r\n \"hs_code\": \"12345\"\r\n }, {\r\n \"description\": \"Test Item One\",\r\n \"origin_country\": \"GB\",\r\n \"quantity\": 1,\r\n \"value\": 5,\r\n \"value_currency\": \"GBP\",\r\n \"weight\": 0.4,\r\n \"weight_unit\": \"kg\",\r\n \"sku\": \"TEST0001\",\r\n \"hs_code\": \"12345\"\r\n }]\r\n }\r\n ]\r\n },\r\n \"format_address_default\" : true,\r\n \"request_id\": 123456789\r\n}"},"url":"{{api_url}}/couriers/v1/billing-quote/list"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"[\n {\n \"service_code\": \"101\",\n \"service_name\": \"Saturday Special\",\n \"price\": {\n \"shipping\": [\n 3,\n 3,\n 3,\n 3\n ],\n \"picking\": 2.2,\n \"parcel_rules\": [\n [\n {\n \"rule\": \"ExtraCharge\",\n \"charge\": 5\n }\n ],\n [\n {\n \"rule\": \"ExtraCharge\",\n \"charge\": 4\n }\n ],\n [\n {\n \"rule\": \"ExtraCharge\",\n \"charge\": 4\n }\n ],\n [\n {\n \"rule\": \"ExtraCharge\",\n \"charge\": 4\n }\n ]\n ],\n \"packaging_charges\": [],\n \"total\": 31.2\n }\n },\n {\n \"service_code\": \"302\",\n \"service_name\": \"Fedex next day\",\n \"price\": {\n \"shipping\": [\n 4.13,\n 4.13,\n 4.13,\n 4.13\n ],\n \"picking\": 2.2,\n \"parcel_rules\": [\n [\n {\n \"rule\": \"ExtraCharge\",\n \"charge\": 5\n },\n {\n \"rule\": \"Sam Ross\",\n \"charge\": 1.5\n },\n {\n \"rule\": \"Collection Cost\",\n \"charge\": 1.75\n }\n ],\n [\n {\n \"rule\": \"ExtraCharge\",\n \"charge\": 4\n },\n {\n \"rule\": \"Sam Ross\",\n \"charge\": 1.5\n }\n ],\n [\n {\n \"rule\": \"ExtraCharge\",\n \"charge\": 4\n },\n {\n \"rule\": \"Sam Ross\",\n \"charge\": 1.5\n }\n ],\n [\n {\n \"rule\": \"ExtraCharge\",\n \"charge\": 4\n },\n {\n \"rule\": \"Sam Ross\",\n \"charge\": 1.5\n }\n ]\n ],\n \"packaging_charges\": [],\n \"total\": 43.47\n }\n }\n]"}],"_postman_id":"2dac74dc-6fc4-437b-afdd-bd0a35a45fcc"},{"name":"Webhook - shipment.created","id":"6b8975ac-d4d3-4b39-bb8b-e77662de2d21","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"event_type\": \"shipment.created\",\r\n \"request\": { \r\n \"shipment\": {\r\n \"courier\": {\r\n \"service_identifier\": \"RFBBTFgg\"\r\n },\r\n \"parcels\": [\r\n {\r\n \"items\": [\r\n {\r\n \"sku\": \"DEFAULT0001\",\r\n \"value\": 1,\r\n \"weight\": \"0.250\",\r\n \"hs_code\": \"3926\",\r\n \"location\": \"b1 warehouse 2\",\r\n \"quantity\": 1,\r\n \"description\": \"Default Item\",\r\n \"weight_unit\": \"kg\",\r\n \"origin_country\": \"GB\",\r\n \"value_currency\": \"GBP\",\r\n \"_original_value\": \"1.00\"\r\n }\r\n ],\r\n \"dim_unit\": \"cm\",\r\n \"dim_width\": 10,\r\n \"dim_height\": 22.2,\r\n \"dim_length\": 11,\r\n \"_summed_item_weights\": 0.25,\r\n \"_summed_total_weight\": 0.25\r\n },\r\n {\r\n \"items\": [\r\n {\r\n \"sku\": \"DEFAULT0002\",\r\n \"value\": 1,\r\n \"weight\": \"3\",\r\n \"hs_code\": \"3926\",\r\n \"location\": \"b1 warehouse 2\",\r\n \"quantity\": 1,\r\n \"description\": \"Default Item 2\",\r\n \"weight_unit\": \"kg\",\r\n \"origin_country\": \"GB\",\r\n \"value_currency\": \"GBP\",\r\n \"_original_value\": \"1.00\"\r\n }\r\n ],\r\n \"dim_unit\": \"cm\",\r\n \"dim_width\": 15,\r\n \"dim_height\": 20,\r\n \"dim_length\": 11,\r\n \"_summed_item_weights\": 3,\r\n \"_summed_total_weight\": 3\r\n }\r\n ],\r\n \"ship_to\": {\r\n \"city\": \"Driffield\",\r\n \"name\": \"John Doe\",\r\n \"email\": \"test@example.com\",\r\n \"phone\": \"01234567890\",\r\n \"county\": \"East Yorkshire\",\r\n \"country\": \"UNITED KINGDOM\",\r\n \"postcode\": \"YO25 9DJ\",\r\n \"address_1\": \"Despatch Cloud Ltd\",\r\n \"address_2\": \"Unit 76\",\r\n \"address_3\": \"Warfield Road\",\r\n \"country_iso\": \"GB\",\r\n \"company_name\": \"Demo Company Ltd\"\r\n },\r\n \"reference\": \"sam test ref1\",\r\n \"ship_from\": {\r\n \"city\": \"Driffield\",\r\n \"name\": \"Michael N\",\r\n \"email\": \"michael@n.com\",\r\n \"phone\": \"01234567890\",\r\n \"county\": null,\r\n \"tax_id\": null,\r\n \"country\": \"UNITED KINGDOM\",\r\n \"postcode\": \"PR6 9FJ\",\r\n \"address_1\": \"Despatch Cloud Ltd\",\r\n \"address_2\": \"Unit 76 Warfield Road\",\r\n \"address_3\": \"\",\r\n \"company_id\": null,\r\n \"country_iso\": \"GB\",\r\n \"company_name\": \"Food Angles Ltd\"\r\n },\r\n \"label_size\": \"6x4\",\r\n \"reference_2\": \"sam test ref2\",\r\n \"label_format\": \"pdf\",\r\n \"collection_date\": \"2021-05-13T10:07:29.756Z\",\r\n \"generate_invoice\": false,\r\n \"shipment_webhook\": {\r\n \"url\": \"https://courierservices.saasc.uk/api/shipments/test.json\",\r\n \"headers\": {\r\n \"api-user\": \"sam\",\r\n \"api-token\": \"cdeikmnuvyz\"\r\n }\r\n },\r\n \"_summed_item_weights\": 3.25,\r\n \"_summed_total_weight\": 3.25,\r\n \"delivery_instructions\": null,\r\n \"generate_packing_slip\": false\r\n },\r\n \"request_id\": 1620900450881,\r\n \"format_address_default\": true\r\n },\r\n \"response\": \"{\\\"type\\\":\\\"PDF\\\",\\\"request_id\\\":\\\"1617275662\\\",\\\"tracking_codes\\\":[\\\"000000000\\\",\\\"000000000\\\"],\\\"tracking_urls\\\":[\\\"https:\\\\/\\\\/despatchcloud.com\\\\/\\\"],\\\"uri\\\":\\\"https:\\\\/\\\\/storageserversam.s3.eu-west-2.amazonaws.com\\\\/courierapi\\\\/pdf_test_VM2tS2FUtf4wkP3nUH1i_merged.pdf?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2GR3ABGLZ7WMXLKV%2F20210401%2Feu-west-2%2Fs3%2Faws4_request&X-Amz-Date=20210401T111422Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Signature=595069af01b89707c6a625e6691e7a425d6de8929a8b06e84f308f5675b84d02\\\",\\\"key\\\":\\\"pdf_test_VM2tS2FUtf4wkP3nUH1i_merged.pdf\\\",\\\"dc_request_id\\\":24653059,\\\"tracking_request_id\\\":24653059,\\\"tracking_request_hash\\\":835838523}\",\r\n \"shipment\": {\r\n \"id\": 9348017,\r\n \"courier\": \"Test\",\r\n \"user_id\": 1,\r\n \"order_id\": null,\r\n \"sku_list\": \"DEFAULT0001,DEFAULT0002\",\r\n \"cancelled\": 0,\r\n \"label_key\": \"pdf_test_VM2tS2FUtf4wkP3nUH1i_merged.pdf\",\r\n \"reference\": \"sam test ref1\",\r\n \"created_at\": \"2021-05-13 11:07:31\",\r\n \"updated_at\": \"2021-05-13 11:07:32\",\r\n \"api_user_id\": 9,\r\n \"reference_2\": \"sam test ref2\",\r\n \"account_name\": null,\r\n \"order_alt_id\": null,\r\n \"parcel_count\": 2,\r\n \"ship_to_name\": \"John Doe\",\r\n \"webhook_sent\": 1,\r\n \"ship_to_email\": \"test@example.com\",\r\n \"account_number\": null,\r\n \"request_log_id\": 20863273,\r\n \"collection_date\": \"2021-05-13T10:07:29.000000Z\",\r\n \"courier_auth_id\": 36,\r\n \"request_shipment\": \"{\\\"label_size\\\":\\\"6x4\\\",\\\"label_format\\\":\\\"pdf\\\",\\\"generate_invoice\\\":false,\\\"generate_packing_slip\\\":false,\\\"courier\\\":{\\\"service_identifier\\\":\\\"RFBBTFgg\\\"},\\\"collection_date\\\":\\\"2021-05-13T10:07:29.756Z\\\",\\\"reference\\\":\\\"sam test ref1\\\",\\\"reference_2\\\":\\\"sam test ref2\\\",\\\"delivery_instructions\\\":null,\\\"ship_from\\\":{\\\"name\\\":\\\"Michael N\\\",\\\"phone\\\":\\\"01234567890\\\",\\\"email\\\":\\\"michael@n.com\\\",\\\"company_name\\\":\\\"Food Angles Ltd\\\",\\\"address_1\\\":\\\"Despatch Cloud Ltd\\\",\\\"address_2\\\":\\\"Unit 76 Warfield Road\\\",\\\"address_3\\\":\\\"\\\",\\\"city\\\":\\\"Driffield\\\",\\\"postcode\\\":\\\"PR6 9FJ\\\",\\\"county\\\":null,\\\"country_iso\\\":\\\"GB\\\",\\\"company_id\\\":null,\\\"tax_id\\\":null,\\\"country\\\":\\\"UNITED KINGDOM\\\"},\\\"ship_to\\\":{\\\"name\\\":\\\"John Doe\\\",\\\"phone\\\":\\\"01234567890\\\",\\\"email\\\":\\\"test@example.com\\\",\\\"company_name\\\":\\\"Demo Company Ltd\\\",\\\"address_1\\\":\\\"Despatch Cloud Ltd\\\",\\\"address_2\\\":\\\"Unit 76\\\",\\\"address_3\\\":\\\"Warfield Road\\\",\\\"city\\\":\\\"Driffield\\\",\\\"county\\\":\\\"East Yorkshire\\\",\\\"postcode\\\":\\\"YO25 9DJ\\\",\\\"country_iso\\\":\\\"GB\\\",\\\"country\\\":\\\"UNITED KINGDOM\\\"},\\\"shipment_webhook\\\":{\\\"url\\\":\\\"https:\\\\/\\\\/courierservices.saasc.uk\\\\/api\\\\/shipments\\\\/test.json\\\",\\\"headers\\\":{\\\"api-user\\\":\\\"sam\\\",\\\"api-token\\\":\\\"cdeikmnuvyz\\\"}},\\\"parcels\\\":[{\\\"dim_length\\\":11,\\\"dim_width\\\":10,\\\"dim_height\\\":22.2,\\\"dim_unit\\\":\\\"cm\\\",\\\"items\\\":[{\\\"description\\\":\\\"Default Item\\\",\\\"origin_country\\\":\\\"GB\\\",\\\"quantity\\\":1,\\\"value\\\":1,\\\"value_currency\\\":\\\"GBP\\\",\\\"weight\\\":\\\"0.250\\\",\\\"weight_unit\\\":\\\"kg\\\",\\\"sku\\\":\\\"DEFAULT0001\\\",\\\"hs_code\\\":\\\"3926\\\",\\\"location\\\":\\\"b1 warehouse 2\\\",\\\"_original_value\\\":\\\"1.00\\\"}],\\\"_summed_item_weights\\\":0.25,\\\"_summed_total_weight\\\":0.25},{\\\"dim_length\\\":11,\\\"dim_width\\\":15,\\\"dim_height\\\":20,\\\"dim_unit\\\":\\\"cm\\\",\\\"items\\\":[{\\\"description\\\":\\\"Default Item 2\\\",\\\"origin_country\\\":\\\"GB\\\",\\\"quantity\\\":1,\\\"value\\\":1,\\\"value_currency\\\":\\\"GBP\\\",\\\"weight\\\":\\\"3\\\",\\\"weight_unit\\\":\\\"kg\\\",\\\"sku\\\":\\\"DEFAULT0002\\\",\\\"hs_code\\\":\\\"3926\\\",\\\"location\\\":\\\"b1 warehouse 2\\\",\\\"_original_value\\\":\\\"1.00\\\"}],\\\"_summed_item_weights\\\":3,\\\"_summed_total_weight\\\":3}],\\\"_summed_item_weights\\\":3.25,\\\"_summed_total_weight\\\":3.25}\",\r\n \"ship_to_postcode\": \"YO25 9DJ\",\r\n \"http_response_code\": 200,\r\n \"ship_to_country_iso\": \"GB\",\r\n \"create_label_parcels\": [\r\n {\r\n \"id\": 9247601,\r\n \"value\": 0.01,\r\n \"width\": 33,\r\n \"height\": 5,\r\n \"length\": 24,\r\n \"weight\": 2,\r\n \"user_id\": 36,\r\n \"sku_list\": \"EXPICKLIST\",\r\n \"created_at\": \"2021-02-14 16:51:35\",\r\n \"item_count\": 1,\r\n \"line_count\": 1,\r\n \"updated_at\": \"2021-02-14 16:52:08\",\r\n \"api_user_id\": 495,\r\n \"parcel_number\": 1,\r\n \"tracking_code\": \"H00RYA0000480209\",\r\n \"tracking_status_code\": 1,\r\n \"tracking_delivered_date\": null,\r\n \"create_label_shipment_id\": 9348017,\r\n \"tracking_delivery_is_late\": 0\r\n },\r\n {\r\n \"id\": 9325919,\r\n \"value\": 1,\r\n \"width\": 10,\r\n \"height\": 22.2,\r\n \"length\": 11,\r\n \"weight\": 0.25,\r\n \"user_id\": 1,\r\n \"sku_list\": \"DEFAULT0001\",\r\n \"created_at\": \"2021-05-13 11:07:31\",\r\n \"item_count\": 1,\r\n \"line_count\": 1,\r\n \"updated_at\": \"2021-05-13 11:07:31\",\r\n \"api_user_id\": 9,\r\n \"parcel_number\": 1,\r\n \"tracking_code\": \"000000000\",\r\n \"tracking_status_code\": null,\r\n \"tracking_delivered_date\": null,\r\n \"create_label_shipment_id\": 9348017,\r\n \"tracking_delivery_is_late\": 0\r\n },\r\n {\r\n \"id\": 9325920,\r\n \"value\": 1,\r\n \"width\": 15,\r\n \"height\": 20,\r\n \"length\": 11,\r\n \"weight\": 3,\r\n \"user_id\": 1,\r\n \"sku_list\": \"DEFAULT0002\",\r\n \"created_at\": \"2021-05-13 11:07:31\",\r\n \"item_count\": 1,\r\n \"line_count\": 1,\r\n \"updated_at\": \"2021-05-13 11:07:31\",\r\n \"api_user_id\": 9,\r\n \"parcel_number\": 2,\r\n \"tracking_code\": \"000000000\",\r\n \"tracking_status_code\": null,\r\n \"tracking_delivered_date\": null,\r\n \"create_label_shipment_id\": 9348017,\r\n \"tracking_delivery_is_late\": 0\r\n }\r\n ],\r\n \"ship_to_company_name\": \"Demo Company Ltd\",\r\n \"webhook_responsecode\": null,\r\n \"friendly_service_name\": \"Service Name Not Specified\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"Your webhook endpoint","urlObject":{"host":["Your webhook endpoint"],"query":[],"variable":[]}},"response":[],"_postman_id":"6b8975ac-d4d3-4b39-bb8b-e77662de2d21"},{"name":"Webhook - shipment.tracked","id":"409b43b0-1e50-4972-b486-4d41e668756b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"event_type\": \"shipment.tracked\",\r\n \"shipment\": {\r\n \"id\": 9348016,\r\n \"courier\": \"Test\",\r\n \"user_id\": 1,\r\n \"order_id\": null,\r\n \"sku_list\": \"DEFAULT0001,DEFAULT0002\",\r\n \"cancelled\": 1,\r\n \"label_key\": \"example.pdf\",\r\n \"lead_time\": null,\r\n \"reference\": \"Demo Ref\",\r\n \"created_at\": \"2021-05-13 10:45:18\",\r\n \"updated_at\": \"2021-05-13 10:51:39\",\r\n \"api_user_id\": 1,\r\n \"reference_2\": \"Demo Ref 2\",\r\n \"account_name\": null,\r\n \"duplicate_of\": null,\r\n \"order_alt_id\": null,\r\n \"parcel_count\": 1,\r\n \"ship_to_name\": \"John Doe\",\r\n \"webhook_sent\": 1,\r\n \"ship_to_email\": \"test@example.com\",\r\n \"account_number\": null,\r\n \"request_log_id\": 20863270,\r\n \"collection_date\": \"2021-05-13 10:45:17\",\r\n \"courier_auth_id\": 36,\r\n \"request_shipment\": \"{\\\"label_size\\\":\\\"6x4\\\",\\\"label_format\\\":\\\"pdf\\\",\\n \\\"generate_invoice\\\":false,\\\"generate_packing_slip\\\":false,\\n \\\"courier\\\":{\\\"service_identifier\\\":\\\"RFBBTFgg\\\"},\\\"collection_date\\\":\\\"2021-05-13T09:45:17.594Z\\\",\\n \\\"reference\\\":\\\"sam test ref1\\\",\\\"reference_2\\\":\\\"sam test ref2\\\",\\\"delivery_instructions\\\":null,\\n \\\"ship_from\\\":{\\\"name\\\":\\\"Michael N\\\",\\\"phone\\\":\\\"01234567890\\\",\\\"email\\\":\\\"michael@n.com\\\",\\n \\\"company_name\\\":\\\"Food Angles Ltd\\\",\\\"address_1\\\":\\\"Despatch Cloud Ltd\\\",\\n \\\"address_2\\\":\\\"Unit 76 Warfield Road\\\",\\\"address_3\\\":\\\"\\\",\\\"city\\\":\\\"Driffield\\\",\\n \\\"postcode\\\":\\\"PR6 9FJ\\\",\\\"county\\\":null,\\\"country_iso\\\":\\\"GB\\\",\\\"company_id\\\":null,\\n \\\"tax_id\\\":null,\\\"country\\\":\\\"UNITED KINGDOM\\\"},\\\"ship_to\\\":{\\\"name\\\":\\\"John Doe\\\",\\\"phone\\\":\\\"01234567890\\\",\\n \\\"email\\\":\\\"test@example.com\\\",\\\"company_name\\\":\\\"Demo Company Ltd\\\",\\\"address_1\\\":\\\"Despatch Cloud Ltd\\\",\\n \\\"address_2\\\":\\\"Unit 76\\\",\\\"address_3\\\":\\\"Warfield Road\\\",\\\"city\\\":\\\"Driffield\\\",\\\"county\\\":\\\"East Yorkshire\\\",\\n \\\"postcode\\\":\\\"YO25 9DJ\\\",\\\"country_iso\\\":\\\"GB\\\",\\\"country\\\":\\\"UNITED KINGDOM\\\"},\\n \\\"shipment_webhook\\\":{\\\"url\\\":\\\"https:\\\\/\\\\/courierservices.saasc.uk\\\\/api\\\\/shipments\\\\/test.json\\\",\\n \\\"headers\\\":{\\\"api-user\\\":\\\"sam\\\",\\\"api-token\\\":\\\"cdeikmnuvyz\\\"}},\\\"parcels\\\":[{\\\"dim_length\\\":11,\\n \\\"dim_width\\\":10,\\\"dim_height\\\":22.2,\\\"dim_unit\\\":\\\"cm\\\",\\n \\\"items\\\":[{\\\"description\\\":\\\"Default Item\\\",\\\"origin_country\\\":\\\"GB\\\",\\\"quantity\\\":1,\\n \\\"value\\\":1,\\\"value_currency\\\":\\\"GBP\\\",\\\"weight\\\":\\\"0.250\\\",\\\"weight_unit\\\":\\\"kg\\\",\\n \\\"sku\\\":\\\"DEFAULT0001\\\",\\\"hs_code\\\":\\\"3926\\\",\\\"location\\\":\\\"b1 warehouse 2\\\",\\\"_original_value\\\":\\\"1.00\\\"}]\\n ,\\\"_summed_item_weights\\\":0.25,\\\"_summed_total_weight\\\":0.25},\\n {\\\"dim_length\\\":11,\\\"dim_width\\\":15,\\\"dim_height\\\":20,\\\"dim_unit\\\":\\\"cm\\\",\\n \\\"items\\\":[{\\\"description\\\":\\\"Default Item 2\\\",\\\"origin_country\\\":\\\"GB\\\",\\\"quantity\\\":1,\\n \\\"value\\\":1,\\\"value_currency\\\":\\\"GBP\\\",\\\"weight\\\":\\\"3\\\",\\\"weight_unit\\\":\\\"kg\\\",\\\"sku\\\":\\\"DEFAULT0002\\\",\\n \\\"hs_code\\\":\\\"3926\\\",\\\"location\\\":\\\"b1 warehouse 2\\\",\\\"_original_value\\\":\\\"1.00\\\"}],\\n \\\"_summed_item_weights\\\":3,\\n \\\"_summed_total_weight\\\":3}],\\\"_summed_item_weights\\\":3.25,\\\"_summed_total_weight\\\":3.25}\",\r\n \"ship_to_postcode\": \"YO25 9DJ\",\r\n \"has_failed_attempt\": 0,\r\n \"http_response_code\": 200,\r\n \"ship_to_country_iso\": \"GB\",\r\n \"create_label_parcels\": [\r\n {\r\n \"id\": 9247600,\r\n \"value\": 0.01,\r\n \"width\": 33,\r\n \"height\": 5,\r\n \"length\": 24,\r\n \"weight\": 2,\r\n \"user_id\": 26,\r\n \"sku_list\": \"EXPICKLIST\",\r\n \"created_at\": \"2021-02-14 16:51:35\",\r\n \"item_count\": 1,\r\n \"line_count\": 1,\r\n \"updated_at\": \"2021-02-14 22:53:12\",\r\n \"api_user_id\": 198,\r\n \"parcel_number\": 1,\r\n \"tracking_code\": \"H00RYA0000480209\",\r\n \"tracking_status_code\": 4,\r\n \"tracking_delivered_date\": null,\r\n \"create_label_shipment_id\": 9348016,\r\n \"tracking_delivery_is_late\": 0\r\n },\r\n {\r\n \"id\": 9325917,\r\n \"value\": 1,\r\n \"width\": 10,\r\n \"height\": 22.2,\r\n \"length\": 11,\r\n \"weight\": 0.25,\r\n \"user_id\": 1,\r\n \"sku_list\": \"DEFAULT0001\",\r\n \"created_at\": \"2021-05-13 10:45:18\",\r\n \"item_count\": 1,\r\n \"line_count\": 1,\r\n \"updated_at\": \"2021-05-13 10:45:18\",\r\n \"api_user_id\": 9,\r\n \"parcel_number\": 1,\r\n \"tracking_code\": \"000000000\",\r\n \"tracking_status_code\": null,\r\n \"tracking_delivered_date\": null,\r\n \"create_label_shipment_id\": 9348016,\r\n \"tracking_delivery_is_late\": 0\r\n },\r\n {\r\n \"id\": 9325918,\r\n \"value\": 1,\r\n \"width\": 15,\r\n \"height\": 20,\r\n \"length\": 11,\r\n \"weight\": 3,\r\n \"user_id\": 1,\r\n \"sku_list\": \"DEFAULT0002\",\r\n \"created_at\": \"2021-05-13 10:45:18\",\r\n \"item_count\": 1,\r\n \"line_count\": 1,\r\n \"updated_at\": \"2021-05-13 10:45:18\",\r\n \"api_user_id\": 9,\r\n \"parcel_number\": 2,\r\n \"tracking_code\": \"000000000\",\r\n \"tracking_status_code\": null,\r\n \"tracking_delivered_date\": null,\r\n \"create_label_shipment_id\": 9348016,\r\n \"tracking_delivery_is_late\": 0\r\n }\r\n ],\r\n \"created_at_formatted\": \"2021-05-13\",\r\n \"ship_to_company_name\": \"Demo Company Ltd\",\r\n \"tracking_status_code\": 1,\r\n \"webhook_responsecode\": null,\r\n \"friendly_service_name\": \"Service Name Not Specified\",\r\n \"tracking_delivered_date\": null,\r\n \"tracking_request_log_id\": null,\r\n \"response_courier_specifics\": null,\r\n \"tracking_expected_delivery_date\": \"2021-04-20T22:59:59.000000Z\"\r\n },\r\n \"tracking_update\": {\r\n \"parcels\": [\r\n {\r\n \"tracking_code\": \"JJD0002247242048686\",\r\n \"tracking_events\": [\r\n {\r\n \"update_id\": 17507248,\r\n \"status_code\": 1,\r\n \"update_date\": \"2021-04-04T07:16:02.000000Z\",\r\n \"status_description\": \"The parcel has been booked with the courier.\"\r\n },\r\n {\r\n \"update_id\": 17643214,\r\n \"status_code\": 1,\r\n \"update_date\": \"0021-04-04T16:59:00.000000Z\",\r\n \"status_description\": \"In transit to Yodel\"\r\n },\r\n {\r\n \"update_id\": 17643216,\r\n \"status_code\": 1,\r\n \"update_date\": \"0021-04-04T00:00:00.000000Z\",\r\n \"status_description\": \"Your parcel will be with us soon\"\r\n }\r\n ]\r\n }\r\n ],\r\n \"shipment_id\": 9348016,\r\n \"received_date\": \"2021-04-04T07:15:16.000000Z\",\r\n \"delivered_date\": null,\r\n \"collection_date\": \"2021-04-05T07:15:13.000000Z\",\r\n \"expected_delivery\": \"2021-04-20T22:59:59.000000Z\",\r\n \"address_information\": {\r\n \"id\": 1227293,\r\n \"ced\": \"Sevenoaks North & Darent Valley\",\r\n \"lsoa\": \"Sevenoaks 005D\",\r\n \"msoa\": \"Sevenoaks 005\",\r\n \"nuts\": \"West Kent\",\r\n \"codes\": {\r\n \"ccg\": \"E38000237\",\r\n \"ced\": \"E58000729\",\r\n \"lau2\": \"E05005016\",\r\n \"lsoa\": \"E01024434\",\r\n \"msoa\": \"E02005091\",\r\n \"nuts\": \"UKJ46\",\r\n \"ccg_id\": \"91Q\",\r\n \"parish\": \"E04004996\",\r\n \"admin_ward\": \"E05005016\",\r\n \"admin_county\": \"E10000016\",\r\n \"admin_district\": \"E07000111\",\r\n \"parliamentary_constituency\": \"E14000918\"\r\n },\r\n \"nhs_ha\": \"South East Coast\",\r\n \"parish\": \"Horton Kirby and South Darenth\",\r\n \"region\": \"South East\",\r\n \"country\": \"England\",\r\n \"quality\": 1,\r\n \"eastings\": \"556374\",\r\n \"latitude\": \"51.406131\",\r\n \"postcode\": \"DA4 9JP\",\r\n \"longitude\": \"0.246871\",\r\n \"northings\": \"169851\",\r\n \"admin_ward\": \"Farningham, Horton Kirby and South Darenth\",\r\n \"created_at\": \"2021-03-29T12:17:46.000000Z\",\r\n \"fetched_at\": \"2021-04-05T05:40:27.000000Z\",\r\n \"updated_at\": \"2021-04-05T05:40:27.000000Z\",\r\n \"admin_county\": \"Kent\",\r\n \"admin_district\": \"Sevenoaks\",\r\n \"primary_care_trust\": \"West Kent\",\r\n \"european_electoral_region\": \"South East\",\r\n \"parliamentary_constituency\": \"Sevenoaks\"\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"Your webhook endpoint","description":"shipment.tracking_status_code will be a number. These are the possible values:
Booked = 1\nCollected = 2\nAtHub = 3\nInTransit = 4\nOutForDelivery = 5\nFailedAttempt = 6\nDelivered = 7\nOnHold = 8\nAddressIssue = 9\nReturnedToSender = 10\nTrackingExpired = 11\nCancelled = 12\nAwaitingCustomerCollection = 13\n