Each courier has slightly different requirements for the create-label request. View these samples to see the differences
\nPlease note: in the parcels > items section of the shipment json, you'll see each item has a weight and value. Weights are always in kilograms and values in pounds. Additionally, our API expects the TOTAL weight and TOTAL value of that product line. For example if you're passing through an item with a unit-weight of 2kg and a quantity of 3, please pass through 6 in the weight field.
The \"collection_date\" field in the JSON is required for every api. You may pass through any string that can be parsed by PHPs strtotime function. ISO8601 will always succeed, for example \"2019-11-19T09:28:04.760Z\". Use this link to test if your date string will be parsed correctly.
The response, if successful, will be json with \"uri\", \"key\", \"request_id\" and \"tracking_codes\". The uri is a download link to the generated pdf. The \"key\" should be saved in case you later need to re-generate that pdf, as the original pdf link is only available for 1 hour. \"tracking_codes\" is an array of strings that identify each consigment or parcel, as appropriate.
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
When registering to this courier, the username and password fields can be anything you want.
The TEST courier doesn't support any \"courier\" specific options. You may register to this courier and use it to get an example of the responses you'll get back.
\nFor example, I've shown what happens when you pass a \"label_format\" option of \"png\" through: most of the response is identical, but a \"pngs\" array comes back as well with base64 encoded pngs.
\n","urlObject":{"path":["api","couriers","v1","Test","create-label"],"host":["{{api_url}}"],"query":[],"variable":[]}},"response":[{"id":"4b5b9c9a-d72b-42b5-94c5-1c2521562ea0","name":"Test","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\"auth_company\": \"company\",\r\n \"request_id\": \"piocm5241li2dfj\",\r\n \"format_address_default\" : true,\r\n \"shipment\" : {\r\n \"label_size\": \"6x4\",\r\n \"label_format\": \"png\",\r\n \"generate_commercial_invoice\": false,\r\n \"generate_packing_slip\": false,\r\n\r\n \"courier\" : {},\r\n\r\n \"collection_date\": \"2019-11-19T09:28:04.760Z\",\r\n \"reference\": \"my custom reference\",\r\n \"delivery_instructions\": \"Leave on the porch\",\r\n \"ship_from\": {\r\n \"name\": \"Sir Foo\",\r\n \"phone\": \"2125551234\",\r\n \"email\": \"foo@foo.com\",\r\n \"company_name\": \"Foo Store\",\r\n \"address_1\": \"255 New town\",\r\n \"address_2\": \"Wow Avenue\",\r\n \"address_3\": \"\",\r\n \"city\": \"Belleville\",\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 \"ship_to\": {\r\n \"name\": \"Recipient Name\",\r\n \"phone\": \"30201231234\",\r\n \"email\": \"support@buyer.com\",\r\n \"company_name\": \"The Receiving Company\",\r\n \"address_1\": \"77 Street Street\",\r\n \"address_2\": \"\",\r\n \"address_3\": \"\",\r\n \"city\": \"New City\",\r\n \"county\": \"\",\r\n \"postcode\": \"YO25 6MM\",\r\n \"country_iso\": \"GB\"\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\": 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 \"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\": 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}"},"url":"{{api_url}}/api/couriers/v1/TEST/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 \"JD0002249184029998\",\n \"JD0002249184029999\"\n ],\n \"pngs\": [\n\t\"iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNkYAAAAAYAAjCB0C8AAAAASUVORK5CYII=\",\n\t\"iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNkYAAAAAYAAjCB0C8AAAAASUVORK5CYII=\"\n ]\n}"}],"_postman_id":"1f39ea3e-f95b-4f2a-8a1c-d58de5fc6099"},{"name":"AltLogic","id":"3125d9ae-e738-4f2e-8100-a69189bc0923","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"api-user","value":"{{api-user}}","type":"text"},{"key":"api-token","value":"{{api-token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"auth_company\": \"company\",\r\n \"request_id\": \"piocm5241li2dfj\",\r\n \"format_address_default\" : true,\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 \"valid_services\": \"\",\r\n \"service_map\": \"{ \\\"Nominated Day: 7am-9pm Delivery\\\": \\\"07:00 - 21:00\\\", \\\"Nominated Day: 8am-12pm Delivery\\\": \\\"08:00 - 12:00\\\", \\\"Nominated Day: 12pm-4pm Delivery\\\": \\\"12:00 - 16:00\\\", \\\"Nominated Day: 8am-12pm Special Delivery\\\": \\\"08:00 - 12:00\\\", \\\"Nominated Day: 9am-12pm Delivery\\\": \\\"09:00 - 12:00\\\", \\\"Nominated Day: 10am-1pm Delivery\\\": \\\"10:00 - 13:00\\\", \\\"Nominated Day: 8am-10am Delivery\\\": \\\"08:00 - 10:00\\\", \\\"Nominated Day: 9am-11am Delivery\\\": \\\"09:00 - 11:00\\\", \\\"Nominated Day: 10am-12pm Delivery\\\": \\\"10:00 - 12:00\\\", \\\"Nominated Day: 11am-1pm Delivery\\\": \\\"11:00 - 13:00\\\", \\\"Nominated Day: 12pm-2pm Delivery\\\": \\\"12:00 - 14:00\\\", \\\"Nominated Day: 1pm-3pm Delivery\\\": \\\"13:00 - 15:00\\\" }\",\r\n \"requested_shipping_service\": \"Nominated Day: 8am-12pm Delivery\"\r\n },\r\n\r\n \"collection_date\": \"2022-04-22T18:00:00\",\r\n \"reference\": \"my custom reference\",\r\n \"delivery_instructions\": \"Leave on the porch\",\r\n \"ship_from\": {\r\n \"name\": \"Sir Foo\",\r\n \"phone\": \"2125551234\",\r\n \"email\": \"foo@foo.com\",\r\n \"company_name\": \"Foo Store\",\r\n \"address_1\": \"255 New town\",\r\n \"address_2\": \"Wow Avenue\",\r\n \"address_3\": \"\",\r\n \"city\": \"Belleville\",\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 },\r\n \"ship_to\": {\r\n \"name\": \"Recipient Name\",\r\n \"phone\": \"30201231234\",\r\n \"email\": \"support@buyer.com\",\r\n \"company_name\": \"The Receiving Company\",\r\n \"address_1\": \"77 Street Street\",\r\n \"address_2\": \"\",\r\n \"address_3\": \"\",\r\n \"city\": \"New City\",\r\n \"county\": \"\",\r\n \"postcode\": \"YO25 6MM\",\r\n \"country_iso\": \"GB\"\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\": 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 \"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\": 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}"},"url":"{{api_url}}/api/couriers/v1/AltLogic/create-label","description":"This courier has no required courier specifics.
\nThe following courier specifics are optional:
\n\"valid_services\": (string) comma-separated list of allowable values for requested_shipping_service\n\"service_map\": (string) a JSON object, where each key is a possible requested_shipping_service, and the value will be sent as the requested_service\n\"requested_shipping_service\": (string) the shipping service being requested - use this field or shipment.requested_shipping_service to specify the service\n\"collection_date\": (string) a datestring to replace the shipment collection_date. \"tomorrow\" or \"+2 days\" are valid strings\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
The following settings are OPTIONAL to pass through in the \"courier\" section of the json:
\n\"service_code\": (string) If you already know the service code, you can book a shipment without retrieving quoted services. Example: \"SWA-UK-PRIME-PREM\"\n\"rate_id\": (string) If you have retrieved a list of quoted services, you can pass through the rate_id.\n\"is_hazmat\": (boolean) If you're sending dangerous goods, set this to true.\n\"service_selection\": (string) defaults to null, may be \"cheapest\" or \"preference\". see \"service_preference\" option\n\"service_preference\": (string) only used if \"service_selection\" is set to \"preference\", must be a comma separated list of Service Codes.\n\"get_services\": (boolean) If you wish to request a list of quoted services based on your specified shipment.\n\"seller_display_name\": (string) Use this to set the sellerDisplayName for Amazon shipping. If this field is set to true, it will automatically use the ship_from.company_name field as the display name. If it is instead set as a string value, it will use that value.\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
The following settings are REQUIRED to pass through in the \"courier\" section of the json:
\n\"service_code\" : Example: \"SWA-UK-PRIME-PREM\"\nThe following settings are OPTIONAL to pass through in the \"courier\" section of the json:
\n\"business_type\" : (string) defaults to \"B2C\", alternative is \"B2B\"\n\"shipping_purpose\" : (string) defaults to \"SALE\"\nAbove, I've desribed the basic way to interact with the api, but AmazonShipping provides an alternate way to interact with the api: rather than immediately submitting the service_code, you can make a request to get the available services for a shipment, choose which one you want, and then submit another later request with the necessary information to actually produce the label.
To get a list of services available for a particular shipment, do a normal create-label request but in the courier section of the json, don't put a service_code, put \"get_services\": true. This will return to you some json that looks like this:
{\n \"shipmentId\": \"12966142057532\",\n \"eligibleServiceOfferings\": [\n {\n \"shippingService\": {\n \"serviceCode\": \"SWA-UK-PRIME-PREM\"\n },\n \"containerRatesMap\": {\n \"d876a8b7-a306-b686-0f83-5a357b4becea\": {\n \"totalCharge\": {\n \"unit\": \"GBP\",\n \"value\": 4.76\n },\n \"billedWeight\": {\n \"unit\": \"kg\",\n \"value\": 1\n }\n }\n },\n \"rate\": {\n \"totalCharge\": {\n \"unit\": \"GBP\",\n \"value\": 4.76\n },\n \"billedWeight\": {\n \"unit\": \"kg\",\n \"value\": 1\n }\n },\n \"promise\": {\n \"receiveWindow\": {\n \"start\": 1507924283000,\n \"end\": 1507924283000\n },\n \"deliveryWindow\": {\n \"start\": 1508010683000,\n \"end\": 1508010683000\n }\n },\n \"serviceOfferingToken\": \"e1b7cf2d1516d8c5343a087e10a5a2261ff36b83bdb5a91c6ce51b19586ed9861507200580943\",\n \"expirationTime\": 1574784147017\n },\n {\n \"shippingService\": {\n \"serviceCode\": \"SWA-UK-ECON\"\n },\n \"containerRatesMap\": {\n \"d876a8b7-a306-b686-0f83-5a357b4becea\": {\n \"totalCharge\": {\n \"unit\": \"GBP\",\n \"value\": 3.72\n },\n \"billedWeight\": {\n \"unit\": \"kg\",\n \"value\": 1\n }\n }\n },\n \"rate\": {\n \"totalCharge\": {\n \"unit\": \"GBP\",\n \"value\": 3.72\n },\n \"billedWeight\": {\n \"unit\": \"kg\",\n \"value\": 1\n }\n },\n \"promise\": {\n \"receiveWindow\": {\n \"start\": 1507924283000,\n \"end\": 1507938683000\n },\n \"deliveryWindow\": {\n \"start\": 1508356283000,\n \"end\": 1508356283000\n }\n },\n \"serviceOfferingToken\": \"e9305a93989acce639f625842b64708f9daaf73bb87cc0cbf11f31f3c944b9761507200580943\",\n \"expirationTime\": 1574784147017\n }\n ]\n}\nChoose which service you want, and then send through another create-label request with the shipmentId and the serviceOfferingToken of your choosing, in the 'courier' section of the json, like this:
\"courier\" : {\n \"shipment_id\": \"57605703160653\",\n \"service_token\": \"e1b7cf2d1516d8c5343a087e10a5a2261ff36b83bdb5a91c6ce51b19586ed9861507200580943\"\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
The following settings are REQUIRED to pass through in the \"courier\" section of the json:
\n\"amazon_order_id\" : (string) the order id from Amazon\n\"delivery_experience\" : (string) example \"DeliveryConfirmationWithSignature\", other options are \"DeliveryConfirmationWithAdultSignature\", \"DeliveryConfirmationWithoutSignature\", \"NoTracking\"\nThe following settings are OPTIONAL to pass through in the \"courier\" section of the json:
\n\"get_services\" : (boolean) setting this to true will not produce a label, and instead return you a list of valid services for the provided shipment. Results will include service_id, carrier_name and service_name\n\"service_id\" : (string) provide this, or carrier_name and service_name, to actually complete the shipment and get a label back\n\"carrier_name\" : (string) provide this with service_name, or provide service_id, to actually complete the shipment and get a label back\n\"service_name\" : (string) provide this with carrier_name, or provide service_id, to actually complete the shipment and get a label back\n\"service_selection\" : (string) defaults to null, may be \"cheapest\" or \"preference\". see \"service_preference\" option\n\"service_preference\" : (string) only used if \"service_selection\" is set to \"preference\", must be a comma separated list of Service IDs\n\"carrier_pick_up\" : (boolean) Defaults to true. If you don't wish for the carrier to collect, then please specify false.\n\"service_array\" : (string) A comma-separated list of service ids, to be used in conjunction with delivery_experience_array. Both lists must have the same number of elements.\n\"delivery_experience_array\" : (string) A comma-separated list of delivery experiences, to be used in conjunction with service_array. Both lists must have the same number of elements.\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
The following settings are REQUIRED to pass through in the \"courier\" section of the json:
\n\"courier_service\" : we pass this through to APC as the ProductCode. Example: \"LP16\"\nThe following settings are OPTIONAL to pass through in the \"courier\" section of the json:
\n\"collection_ready_at\" : (string) defaults to \"22:00\"\n\"collection_closed_at\" : (string) defaults to \"23:00\"\n\"goods_description\" : (string) defaults to \"any\"\n\"fragile\" : (boolean) defaults to false\n\"security\": (boolean) defaults to false\n\"insurance_liability\": (boolean) defaults to false\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
This courier supports what3words in the ship_to address.
The following settings are REQUIRED to pass through in the \"courier\" section of the json:
\n\"service_code\": (string) ePacket, ePacketPlus, eParcelPremium, eParcelExpedited, eParcelExpress, eParcelPremiumPUDO, eParcelExpressPUDO, eReturnDO, eReturnPU\n\nThe following settings are OPTIONAL to pass through in the \"courier\" section of the json:
\n\"trade_terms\": (string) \"DDP\" or \"DDU\", defaults to \"DDU\"\n\"parcel_description\": (string) Customs safe description of goods within the parcel. Example: \"Clothing\", \"phone accessories\"\n\"car_cod_amount\": (string) Amount to collect at door for this shipment. Used in conjunction with AdditionalService \"COD\"\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
The following settings are REQUIRED to pass through in the \"courier\" section of the json:
\n\"priority_code\" : (string) Defaults to \"\" - Examples are \"DIARY\", \"24HR\"\n\nThe following settings are OPTIONAL to pass through in the \"courier\" section of the json:
\n\"delivery_window\" : (string) Example: \"2\" - 2 days from collection date.\n\"product_type\" : (string) It is used to determine the Product Category. If you did not enter the {item > description} field as \"Product Category\", you should fill in this field.\n\"supplier_identifier\" : (string) optional, overrides the auth supplier_identifier, string of length 2 eg \"00\"\n\"supplier_code\" : (string) optional, overrides the auth supplier_code, string of length 4 eg \"ABCD\"\n\"return_destination_code\" : (string) optional, overrides the auth return_destination_code\n\"route_type\" : (string) Default \"CORE\"\n\"nominated_flag\" : (boolean) Default false, when please set as true, delivery date is mandatory\n\"brand_code\" : (string) Brand code for the multi brand clients\n\"room_of_choice\" : (string) Set to \"Y\" for the receiver to specify room of choice on delivery.\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
The following settings are REQUIRED to pass through in the \"courier\" section of the json:
\n\"service_code\" : Example: \"INTL\"\nThe following settings are OPTIONAL to pass through in the \"courier\" section of the json:
\n\"customs_payment_method\" : defaults to \"DDU\", alternative is \"DAP\"\n\"country_of_origin\" : country of origin for items in the parcel, defaults to \"GBP\"\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
The following settings are REQUIRED to pass through in the \"courier\" section of the json:
\n\"delivery_service_id\" : (string) Delivery Service ID, for example \"5947\" or \"2064\"\nThe following settings are OPTIONAL to pass through in the \"courier\" section of the json:
\n\"is_urgent\" : (number) Default 0, 1 to indicate it’s an urgent order\n\"type\" : (string) Consignment Type, Default \"AGENT_DIRECT\", options are \"LOCAL\", \"DIRECT\", \"RETURN\", \"AGENT_DIRECT\".\n\"neighbour_instruction\" : (string) Notice to neighbour\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
This courier supports what3words in the ship_to address.
There are no required fields for BJS; all settings are optional. They can be passed through in the \"courier\" section of the json:
\n\"delivery_window\": (string) Example: \"2\" - 2 days from collection date.'\n\"released\": (boolean) Released determines if the order is ready for BJS to process. Default value false'\n\"express_required\": (boolean) Example: \"True\" or \"False\" - If `True`, processes order for next available delivery date on `Released`\n\"service_type\": (string) Applicable values: `Sat`,`Sun`,`Weekend`,`Standard`,` NULL` - uses `AccountNumber` default if not specified, may be chargeable.\n\"timed_service\": ('string') Applicable values: `All Day`, `Business Hours`, `AM`, `PM`, `Evening`, `NULL` - uses `AccountNumber` default if not specified, may be chargeable.\n\"service_level\": (string) Applicable values: `1 Man`, `1.5 Man`, `2 Man`, `NULL` - uses `AccountNumber` defaults if not specified, may be chargeable.\n\"delivery_point\": (string) Applicable values: `Hallway`, `Room Of Choice`, `NULL` - uses `AccountNumber` default if not specified.\n'unpack_items': (string) Applicable values: `Yes`,`No`,`NULL` - uses `AccountNumber` default if not specified.\n\"take_packaging_away\": (string) Applicable values: `Yes`,`No`,`NULL` - uses `AccountNumber` default if not specified.\n\"assemble\": (string) Applicable values: `Yes`,`No`,`NULL` - uses `AccountNumber` default if not specified.\n\"disassemble\": (string) Applicable values: `Yes`,`No`,`NULL` - uses `AccountNumber` default if not specified.\n\"order_type\": (string) Applicable values: `Return`,`Supplier Collection`,`Standard`, not required for standard orders.\n\"status_note\": (string) Applicable values: `NULL`, String - Status note visible to admin teams only.\n\"packaging_type\": (string) Applicable Values: `Boxes`, `Bulk`, `Cases`, `Pallets` - Packaging type, required for Ireland/EU addresses.\n\"account_number\": (string) Defaults to the account_number set in the auth\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
The following settings are REQUIRED to pass through in the \"courier\" section of the json:
\n\"service_code\" : Examples: \"TRACKED\", \"EXPRESS\", \"ECONOMY\"\nThe following settings are OPTIONAL to pass through in the \"courier\" section of the json:
\n\"contents_description\" : (string) defaults to \"GENERAL GOODS\"\n\"get_services\" : (boolean) defaults to false, if true returns a list of available services for your account\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
These courier specifics are REQUIRED:
\n\"product_code\": (string) examples: \"01\", \"86\"\n\"service\": (string) Day of delivery. Possible values : \"0\" => Normal, \"1\" => Delivery on Monday (for national product codes only), \"6\" => Delivery on Saturday (for national product codes only)\n\nThese courier specifics are OPTIONAL:
\n\"parcel_type\": (string) Possible values : \"MAR\" => Goods, \"DOC\" => Document, defaults to \"MAR\"\n\"pudo\": (object) pudo object as returned from get-pickup-locations\n\"carrier\": (string) Type of carrier in the case of a shipment to CHINA Express: \"0\" => LINEX | \"1\" => SF For other products than Express leave the value empty.\n\"insured_value\": (number) Insured value. It in cents of euros e.g. 8920 (= €89.20)\n\"cod_value\": (number) Express Return payment value in Euros. Cash on delivery value e.g. 1250 (= €12.50)\n\"customs_value\": (number) Declared value for customs. This field is necessary when transporting goods internationally. Absence in this case can lead to the shipment being blocked in customs\n\"ship_hour\": (number) Shipment hour. Shipment generation hour (current hour), must be located between 0 and 23\n\"sub_account\": (string) Sub-account number\n\"shipper_pre_alert\": (number) Defaults \"0\". Pre-alert type (MAS). \"0\" => no pre-alert, \"11\" => sender tracking subscription\n\"recipient_pre_alert\": (number) Defaults \"0\". Pre-alert type (MAS). \"0\" => no pre-alert, \"22\" => pre-alert for the recipient via e-mail\n\"mode_retour\": (string) Defaults \"2\". Indicates if the label must be sent by e-mail. \"1\" => the label will be returned by e-mail to the senders e-mail address. \"2\" => the label will not be returned by e-mail to the senders e-mail address. \"3\" => the label can be printed on an automated postal machine in the post office.\n\"as\": (string) The as tag for these parcels.\n\"is_return\": (boolean) Indicates if the parcel is being returned to the sending company.\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
There are no required settings for ColisPriveFR.
\nThe following settings are OPTIONAL to pass through in the \"courier\" section of the json:
\n\"is_return\" : (boolean) Defaults to false. Indicates the reverse shipping.\n\"pod\" : (boolean) Defaults to false. Set as true if POD is needed.\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
The following settings are REQUIRED to pass through in the \"courier\" section of the json:
\n\"service_code\" : Examples: \"TRACKED\", \"EXPRESS\", \"ECONOMY\"\nThe following settings are OPTIONAL to pass through in the \"courier\" section of the json:
\n\"contents_description\" : (string) defaults to \"GENERAL GOODS\"\n\"get_services\" : (boolean) defaults to false, if true returns a list of available services for your account\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
There are no REQUIRED settings in the \"courier\" section of the json.
\nThe following settings are OPTIONAL to pass through in the \"courier\" section of the json:
\n\"contact_strategy\" : (string) Defaults to \"E\". Customer’s contact preference. \"E\" = Via e-mail only, \"ES\" = Via both e-mail and SMS text\n\"service_code\" : (boolean) The code of the service you want to use. The default \"service_code\" value will be set in the courier credentials.\n\"depot_name\" : (string) The short name of the depot. The default \"depot_name\" value will be set in the courier credentials.\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
The following settings are REQUIRED to pass through in the \"courier\" section of the json:
\n\"service_code\" : \"ST\": standard for the product / at home, \"LS\": in a selected branch, \"OR\": in the reference branch of the addressee, \"CP\": CityPaq\n\"product_code\" : Shipping product code. Example: \"S0132\"\n\nThe following settings are OPTIONAL to pass through in the \"courier\" section of the json:
\n\"payment_status\" : (string) \"FP\": Postage paid, \"FM\": Machine franking, \"ES\": Cash, \"ON\": Online payment. Defaults to \"FP\"\n\"shipment_type\" : (boolean) Mandatory for international shipments. Type of shipment:- \"1\": Documents, - \"2\": Goods (default), - \"3\": Gifts, - \"4\": Commercial Samples, - \"5\": Returned Goods, - \"6\": Other, - \"7\": Dangerous goods\n\"insurance_amount\" : (string) Amount in Euros for Insurance.\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
The following settings are OPTIONAL to pass through in the \"courier\" section of the json:
\n\"service_level\" : (string) Example: \"CRTS Assembly Service\". This adds an \"ASSEMBLY\" item row to the submitted CSV.\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
The following settings are REQUIRED to pass through in the \"courier\" section of the json:
\n\"service_code\": (string) Service Code. Possible values: \"09\" => CSM eCom, \"11\" => CSM eCom Express, \"21\" => CSM 9, \"22\" => CSM 10.30, \"23\" => CSM 12, \"24\" => CSM 24 (Next Day deliveries), \"25\" => CSM Express, \"26\" => CSM Economy, \"80\" => Saturday, \"81\" => Saturday 12:00, \"82\" => Saturday 10:30, \"83\" => Sunday, \"84\" => Sunday 12:00\n\nThe following settings are OPTIONAL to pass through in the \"courier\" section of the json:
\n\"parcel_type\": (string) Defaults to \"P\". Possible values: \"P\" => Package, \"E\" => Envelope, \"H\" => DHL Paket. Note: If \"E\" is specified then one only one parcel can be sent with the consignment request.\n\"duties_paid_by_shipper\": (boolean) Defaults to false. Designates whether any duties and taxes should be paid for by the shipper.\n\"reason_for_export\": (string)0 Defaults to \"sale\". Other options: \"gift\", \"item for repair\" etc. Please use for dutiable shipments.\n\"signature_name\": (string) Use this field when dutiable_contents is true. If left blank, defaults to \"ship_from.name\"\n\"use_item_description\": (boolean) If this is true, and shipment_description is blank, we will send the first item description as the shipment description\n\"shipment_description\": (string) Description of the contents of this shipment\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
The following settings are REQUIRED to pass through in the \"courier\" section of the json:
\n\"courier\" : Example: \"AmazonShipping\"\n\"service_id\" : Example: \"Fast Saturday\"\nThe following settings are OPTIONAL to pass through in the \"courier\" section of the json:
\n\"auth_company\" : please contact Deliver 360 for further questions about this field\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
The following settings are REQUIRED to pass through in the \"courier\" section of the json:
\n\"parcel_service_type\" : Parcel Service Type; Possible values : \"1\", \"2\", \"3\"\nThe following settings are OPTIONAL to pass through in the \"courier\" section of the json:
\n\"parcel_insured\" : (boolean) defaults to false\n\"parcel_cod\" : (string) defaults to false\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
The following settings are REQUIRED to pass through in the \"courier\" section of the json:
\n\"order_id\" : (string) example: \"387983742\"\n\"shipping_service_id\" (string|number) example: 328\nThe following settings are OPTIONAL to pass through in the \"courier\" section of the json:
\n\"payment_currency\" : (string) defaults to \"GBP\"\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
The following settings are REQUIRED to pass through in the \"courier\" section of the json:
\n\"product\" : options are \"GPP \"GMP\", \"GMM\", \"GMR\", \"GPT\"\n\"service_level\" : options are \"STANDARD\", \"PRIORITY\", \"REGISTERED\"\n\"hs_code\" : (string) the hs code of the products in the parcel\nThe following settings are OPTIONAL to pass through in the \"courier\" section of the json:
\n\"new_order\" : (boolean) defaults to false, used to indicate that this shipment and the following ones should go on a separate order than the previous shipments\n\"currency\" : (string) defaults to \"GBP\"\n\"shipment_naturetype\" : (string) defaults to \"SALE_GOODS\"\n\"content_description\" : (string) defaults to \"GOODS\"\n\"security\": (boolean) defaults to false\n\"content_origin\": (boolean) defaults to \"GB\"\n\"consolidate_items\": (boolean) defaults to false. if true, we combine all item info for items with matching hs_codes\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
The following settings are REQUIRED to pass through in the \"courier\" section of the json:
\n\"service\" : \"EPS\" for YODEL WORLD PACKET, \"EPL\" for YODEL WORLD PARCEL\"\nThe following settings are OPTIONAL to pass through in the \"courier\" section of the json:
\n\"label_option\" : (string) defaults to \"System\", alternative is \"FinalMile\"\n\"display_id\" : (string) if entered, barcode will be printed on the label\n\"invoice_number\" : (string) defaults to null\n\"customs_duty\" : (string) defaults to \"DDU\", alternative is \"DDP\"\n\"description\" : (string) defaults to \"GOODS\"\n\"declaration_type\" : (string) defaults to \"SaleOfGoods\", alts: CommercialSample, Documents, Gift, ReturnedGoods\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
The following settings are REQUIRED to pass through in the \"courier\" section of the json:
\n\"global_product_code\" : Example: \"U\"\n\"local_product_code\" : Example: \"U\"\n\nThe following settings are OPTIONAL to pass through in the \"courier\" section of the json:
\n\"currency\" : (string) defaults to \"GBP\"\n\"shipper_ein\" : (string) defaults to \"\"\n\"terms_of_trade\" : (string) defaults to \"DAP\"\n\"duty_payment_type\" : (string) Duty payee. Applicable values are \"S\" (Sender) or \"R\" (Recipient) Default is R.\n\"contents\" : (string) defaults to \"General Goods\"\n\"is_insured\": (boolean) defaults to false\n\"insurance_value\": (number) Defaults to the summed value of submitted items\n\"insurance_currency\": (string) Defaults to GBP.\n\"dangerous_goods\": (boolean) defaults to false\n\"export_reason\": (string) defaults to \"sale\"\n\"export_reason_type\": (string) Defaults to \"permanent\", some other options are \"temporary\", \"return\", \"gift\". Please consult DHL documentation for full list.\n\"place_of_incoterm\": (string) Name of port of departure, shipment or destination as required under the applicable delivery term. Can set to \"ship_to\" or \"ship_from\" to use city and country values from those addresses.\n\"shipment_type\": (string) Options are \"personal\" or \"commercial\". Defaults to \"commercial\".\n\"pickup_requested\": (boolean) Defalts to false.\n\"all_documents\": (boolean) Defaults to false. If true, it the customs image will come in the same pdf as the main labels.\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
Please note: this courier requires you to call the create-manifest function at the end of each day. Please contact us for any questions.
There are no REQUIRED sections in the \"courier\" section of the json.
\nThe following settings are OPTIONAL to pass through in the \"courier\" section of the json:
\n\"distribution_center\" : (string) Defaults to option in registered auth, or \"GBLHR1\"\n\"product_id\" : (string) Default : \"PLT\", other options are \"PLY\", \"PKY\", \"PIY\", \"PID\"\n\"service\" : (string) Options are \"DELCON\", \"SIGCON\"\n\"service_endorsement\" : (string) Options are Address Service Requested => \"1\", Forwarding Service Requested => \"2\", Change Service Requested => \"3\", Return Service Requested => \"4\"\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
The following settings are REQUIRED to pass through in the \"courier\" section of the json:
\n\"service_key\" : Example: 220\n\nThe following settings are OPTIONAL to pass through in the \"courier\" section of the json:
\n\"account\" : (string) pass in the accountNumber, or use \"Domestic\", \"International\", or \"EURoad\"\n\"extended_cover\" : (number) defaults to 0. Integer is per thousand. Eg if specified as 4, this will cover for 4000 GBP\n\"earliest_time\" : (string) defaults to \"11:00\", please provide time in same format\n\"latest_time\" : (string) defaults to \"17:30\", please provide time in same format\n\"book_collection\" : (boolean) defaults to true, put false to create the label without a collection\n\"closed_for_lunch\" : (boolean) defaults to false\n\"collection_special_instructions\" : (string) special instructions for the driver to pickup from your collection location\n\"secure_location\" : (string) secure location to leave delivery with customer\n\"pre_delivery_notification_type\" : (string) defaults to \"phone\", may also be \"email\" or \"none\"\n\"exchange_on_delivery\" : (boolean) defaults to false\n\"book_in\" : (boolean) defaults to false\n\"full_customs_declaration\" : (boolean) defaults to false. if true, provide details for full customs declaration - this is required for some services\n\"customs_invoice_number\" : (string) required if full_customs_declaration is true\n\"customs_invoice_date\" : (string) required if full_customs_declaration is true, DateString format\n\"customs_country_of_origin\" : (string) defaults to \"GBR\", only if full_customs_declaration is true\n\"customs_shipping_charges\" : (number) defaults to 0, only if full_customs_declaration is true\n\"customs_reason_for_export\" : (string) defaults to \"commercial sale\", only if full_customs_declaration is true\n\"customs_terms_of_delivery\" : (string) defaults to \"DAP\", alternative is \"DDP\", only if full_customs_declaration is true\n\"allow_weekend_collection\" : (boolean) defaults to false, this needs to be agreed with your account manager otherwise requests will fail\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
The following settings are REQUIRED to pass through in the \"courier\" section of the json:
\n\"ordered_product\" : Identifies the DHL Parcel UK 3 digit service code that is to be applied to the shipment. Example: 210\n\nThe following settings are OPTIONAL to pass through in the \"courier\" section of the json:
\n\"drop_off_type\": (string) Specify how shipments will be handed over to DHL. Defaults to PICKUP, PICKUP is for a driver pickup from your account address. Must be \"PICKUP\", \"DROPOFF\", or \"DEPOT\"\n\"account_address\": (string) Should the shipment be collected from the pickupAccount address? If false then shipment will be collected from the supplied pickupAddress which then becomes mandatory. Must be true or false default true\n\"recipient_type\": (string) Type of recipient being delivered to. defaults to \"business\" if ship_to company_name is set.\n\"address_type\": (string) Type of address being delivered to. defaults to \"doorstep\", alternative is \"servicePoint\" \n\"service_point_address\": (string) To be used with address_type servicePoint\n\"location_type\": (string) If addressType is servicePoint, then address type of service point. Defaults: \"Parcel Shop\" \n\"extended_liability_units\": (string) For consignments delivered in the UK, the number of additional extended liability cover units required. Defaults: 0\n\"label_required\": (string) Indicates whether the pickup driver needs to print and apply labels to the parcel at pickup. Not for pickup at accountAddress. Must be true or false\n\"duties_paid\": (string) DDP or DAP, defaults to DAP\n\"ioss_shipment\": (boolean) set this to true if the service requires IOSS. if not set, this is automatically calculated based on if the shipment is going to EU.\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
The following settings are REQUIRED to pass through in the \"courier\" section of the json:
\n\"ordered_product\" : Identifies the DHL Parcel UK 3 digit service code that is to be applied to the shipment. Example: 210\n\nThe following settings are OPTIONAL to pass through in the \"courier\" section of the json:
\n\"drop_off_type\": (string) Specify how shipments will be handed over to DHL. Defaults to PICKUP, PICKUP is for a driver pickup from your account address. Must be \"PICKUP\", \"DROPOFF\", or \"DEPOT\"\n\"account_address\": (string) Should the shipment be collected from the pickupAccount address? If false then shipment will be collected from the supplied pickupAddress which then becomes mandatory. Must be true or false default true\n\"recipient_type\": (string) Type of recipient being delivered to. defaults to \"business\" if ship_to company_name is set.\n\"address_type\": (string) Type of address being delivered to. defaults to \"doorstep\", alternative is \"servicePoint\" \n\"service_point_address\": (string) To be used with address_type servicePoint\n\"location_type\": (string) If addressType is servicePoint, then address type of service point. Defaults: \"Parcel Shop\" \n\"extended_liability_units\": (string) For consignments delivered in the UK, the number of additional extended liability cover units required. Defaults: 0\n\"label_required\": (string) Indicates whether the pickup driver needs to print and apply labels to the parcel at pickup. Not for pickup at accountAddress. Must be true or false\n\"duties_paid\": (string) DDP or DAP, defaults to DAP\n\"ioss_shipment\": (boolean) set this to true if the service requires IOSS. if not set, this is automatically calculated based on if the shipment is going to EU.\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
The following settings are REQUIRED to pass through in the \"courier\" section of the json:
\n\"service\" : Services: \"AH\", \"PR\", \"09\", \"12\", \"DW\", \"EK\", \"PI\", \"CP\" or \"CM\"\n\nThe following settings are OPTIONAL to pass through in the \"courier\" section of the json:
\n\"label_type\" : (string) Specifies the type of label. Use \"LP\", \"BLP\", \"LBLP\", \"ZBLP\" or \"ZBLP\". Default to \"LP\"\n\"piece_type\" : (string) Possible values: \"ENVELOPE\", \"PACKAGE\", \"PALLET\". Defaults to \"PACKAGE\"\n\"address_type\" : (string) Recipient address type, use \"B\" or \"C\", Defaults to \"B\" if a ship_to.company_name is specified, otherwise defaults to \"C\"\n\"is_packstation\" : (boolean) Delivery to DHL Parcelstation, defaults to false\n\"is_postfiliale\" : (boolean) Delivery to DHL Parcelshop, defaults to false\n\"postnummer\" : (string) Customer number - required only for DE with deliveries to parcel lockers\n\"payer_type\" : (string) Use \"SHIPPER\" or \"USER\". Defaults to \"SHIPPER\"\n\"account_number\": (string) Payer’s customer number.\n\"delivery_evening\": (boolean) Selection of the Evening Delivery service, defaults to false\n\"delivery_on_saturday\": (boolean) Selection of the Saturday Delivery service, defaults to false\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
The following settings are OPTIONAL to pass through in the \"courier\" section of the json:
\n\"parcel_type\" : (string) Defaults to \"SMALL\"\n\"options\" : (string) comma-separated list of options, eg \"DOOR,EVE\"\n\"inco_terms\" : (string) CFR, CIF, CIP, CPT, DAP, DAT, DDP, DDU, DDX, EXW, FCA, FOB; DDX means ‘DDP VAT Excl.’ EXW not applicable for UK exports. For Parcel Connect only DDU applicable to UK.\n\"return_label\" : (boolean) defaults to false\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
The following settings are OPTIONAL to pass through in the \"courier\" section of the json:
\n\"parcel_type\" : (string) Defaults to \"SMALL\"\n\"options\" : (string) comma-separated list of options, eg \"DOOR,EVE\"\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
The are no REQUIRED settings for DHLWarenpost.
\nThe following settings are OPTIONAL to pass through in the \"courier\" section of the json:
\n\"account_number\" : (string) DHL account number (14 digits)\n\"product\" : (string) Defaults : \"V01PAK\" => DHL PAKET, \"V53WPAK\" => DHL PAKET International, \"V54EPAK\" => DHL Europaket, \"V62WP\" => DHL Warenpost\n\"endorsement_type\" : (string) Required for shipments with product DHL Paket International: \"V53WPAK\". Possible values: \"IMMEDIATE\", \"ABANDONMENT\"\n\"cash_on_delivery\" : (string) Service Cash on delivery. Money amount to be collected. Required if COD is chosen.\n\"additional_insurance\" : (string) Insure shipment with higher than standard amount.\n\"preferred_day\" : (string) Service preferred day\n\"preferred_location\" : (string) Service preferred location\n\"preferred_time\" : (string) Service preferred time\n\"is_premium\" : (boolean) Defaults: false, it for fast and safe delivery of international shipments.\n\"visual_check_age\" : (boolean) Defaults: null, Visual Check Age is used to specify the minimum age of the recipient. The following types are allowed: \"A16\" or \"A18\".'\n\"cost_centre\" : (string) Name of a cost center. Appears on shipment label.\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
The following settings are REQUIRED to pass through in the \"courier\" section of the json:
\n\"network_code\" : Example: \"1^12\"\n\nThe following settings are OPTIONAL to pass through in the \"courier\" section of the json:
\n\"customs_value\" : (number|string) defaults to \"\"\n\"parcel_description\" : (string) defaults to \"\"\n\"liability_value\" : (number) defaults to null\n\"liability\" : (boolean) defaults to false\n\"reason_for_export\" : (string) defaults to \"01\", 01=Sale | 02=Return/Replacement | 03=Gift\n\"trade_terms\" : (string) defaults to \"DAP\", use \"DT1\" for DDP\n\"pickup_location\" : (array) pickup location array as returned from get-pickup-locations\n\"apply_min_weight\" : (boolean) defaults to false. if true and your total shipment weight comes out to less than 0.1kg, we set the weight to 0.1kg\n\"invoice_type\" : (number) defaults to 2, Commercial Invoice. Other option is 1, Pro Forma Invoice\n\"disable_notifications\" : (boolean) if true, notificationDetails are not sent to DPD\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
The following settings are REQUIRED to pass through in the \"courier\" section of the json:
\n\"parcel_type\": (string) Possible fixed values: DPD for DPD (Default), PT for prime time, B2C for B2C, 2S for parcel shop delivery.\n\nThe following settings are OPTIONAL to pass through in the \"courier\" section of the json:
\n\"is_return\": (boolean) Defaults to false. Indicates the reverse shipping.\n\"customer_number\": (string) Your customers customer number. When using parceltype \"2S\", the parcelshop-ID is passed in this field.\n\"product2_hv\": (string) Value between 520,01 and 15.000 EUR Value of goods in 100th of the currency (e.g. „61750“ for 617,50 €)\n\"product2_asg\": (string) Place to deposit parcel\n\"product2_id\": (string) Place to deposit parcel\n\"product2_id16\": (string) Place to deposit parcel\n\"product2_id18\": (string) Place to deposit parcel\n\"product2_abt\": (string) Department delivery. Possible values: Depart, ent\n\"product2_aviso\": (string) Mobile phone number and/or Email Mobile phone number in international format e.g..: +4369912345678\n\"product4_wp\": (string) Value between 520,01 and 15.000 EUR Value of goods in 100th of the currency (e.g. „81750“ for 817,50 €)\n\"product6_predict\": (string) Mobile phone number and/or Email Mobile phone number in international format e.g..: +436991234567\n\"product6_aviso\": (string) Mobile phone number and/or Email Mobile phone number in international format e.g..: +436991234567\n\"dfu\": (string) Mobile phone number and/or Email Mobile phone number in international format e.g..: +436991234567\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
The following settings are REQUIRED to pass through in the \"courier\" section of the json:
\n\"product\" : (string) Example: \"CL\", \"E12\", \"IE2\", \"MAIL\"\nThe following settings are OPTIONAL to pass through in the \"courier\" section of the json:
\n\"sending_depot\" : (string) defaults to the Login depot, Example: \"0163\"\n\"saturday\" : (boolean) defaults to false\n\"guarantee\" : (boolean) defaults to false\n\"customs_terms\" : (string) defaults to \"01\" which is DAP. send \"02\" for DDP\n\"parcel_class\" : (string) supply this for C2C shipments. Possible values are \"WEB_PSH_XS_PAYED\", \"WEB_PSH_S_PAYED\", \"WEB_PSH_M_PAYED\", \"WEB_PSH_L_PAYED\", \"WEB_PSH_XL_PAYED\".\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
The following settings are REQUIRED to pass through in the \"courier\" section of the json:
\n\"service_type\": (string) Values : \"1\" => 1 Man, \"2\" => 2 Man, \"3\" => 3 Man\n\nThe following settings are OPTIONAL to pass through in the \"courier\" section of the json:
\n\"extra_services\": (string) Using: \"A\" or \"A,T,W\" etc. Values: \"A\" => Assembly, \"T\" => Trade, \"W\" => Wet installation, \"D\" => Item disposal, \"AM\" => Delivery between 0700 - 1200 (AM), \"PM\" => Delivery between 1200 - 2000 (PM). \"B10\" => Delivery between 0700 - 1000, \"A6\" => Delivery between 1800 - 2000, \"DR\" => Remove door to fit in product, \"PP\" => Plug and play TV, \"DS\" => Swapping of appliance door, \"DV\" => Reverse orientation of applicant door, \"PR\" => Prime service, \"TL\" => Tail Lift, \"TC\" => TV Collect, \"SA\", Sofa Assembly, \"EX\" => Exchange, \"UB\" => Unbox & Tidy, \"TLA\" => Trade Label, \"WD\" => Wet Dis & Install, \"DA\" => Disassembly, \"CA\" => Complex Assembly, \"CDA\" => Complex Disassembly, \"BDA\" => Basic Disassembly, \"IN\" => Install, \"DC\" => Disconnect, \"FS\" => Wet Install + Disconnect + Disposal\n\"delivery_date\": (string) Delivery Date\n\"stock_depot\": (string) Used if Panther are stocking this line e.g. Panther Crick\n\"is_return\": (boolean) Set as true for return shipments.\n\"order_type\": (string) Order Type\n\"pre12\": (boolean) Set as true, for services due before 12:00\n\"inco_term\": (string) Terms/IncoTerms code\n\"shipment_mode\": (string) Shipment Mode. Defaults \"Road\"\n\"export_reason\": (string) Reason for export\n\"certifications\": (string) Certifications (e.g. SPS, fumigation, veterinary)\n\"min_book_days\": (number) If no date provided, this setting controls the first available day that auto-booking can offer e.g. today + 8 days\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
The following settings are REQUIRED to pass through in the \"courier\" section of the json:
\n\"network_code\" : Example: \"1^12\"\nThe following settings are OPTIONAL to pass through in the \"courier\" section of the json:
\n\"customs_value\" : (number|string) defaults to \"\"\n\"parcel_description\" : (string) defaults to \"\"\n\"liability_value\" : (number) defaults to null\n\"liability\" : (boolean) defaults to false\n\"reason_for_export\" : (string) defaults to \"01\", 01=Sale | 02=Return/Replacement | 03=Gift\n\"trade_terms\" : (string) defaults to \"DAP\", use \"DT1\" for DDP\n\"pickup_location\" : (array) pickup location array as returned from get-pickup-locations\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
The following settings are REQUIRED to pass through in the \"courier\" section of the json:
\n\"product\" : (string) Possible values are: \"CL\" => DPD CLASSIC, \"E830\" => DPD 8:30, \"E10\" => DPD 10:00, \"E12\" => DPD 12:00, \"E18\" => DPD 18:00, \"IE2\" => DPD EXPRESS, \"PL\" => DPD PARCELLetter, \"PL+\" => DPD PARCELLetterPlus, \"MAIL\" => DPD International Mail\n\nThe following settings are OPTIONAL to pass through in the \"courier\" section of the json:
\n\"is_return\" : (boolean) Defines if parcel is a return parcel. The return parcel must always be next in order to the corresponding outbound parcel. Default value is false\n\"depot\" : (string) Sending depot for consignment, ordering depot for collection request, customers depot for pickup information or creating/sending depot for dangerous goods. 4 alphanumeric places, including leading zeros, e.g. \"0163\"\n\"saturday_delivery\" : (boolean) Defines if saturday delivery is demanded. Only selectable for product \"E12\". Default value is false\n\"sku_in_ref\" : (boolean) Appends the SKU to the end of the reference to create the customerReferenceNumber1 field for each parcel\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
There are no REQUIRED settings.
\nThe following settings are OPTIONAL to pass through in the courier section of the json (note: it's advised to either pass the first three, or the next two, to get a label back):
\n\"service_code_id\" : example \"3052\"\n\"delivery_method_id\" : example \"4806\"\n\"time_slot_id\" : example \"1000\"\n\"service_level\" : (string) example \"3\"\n\"service_type\" : (string) example \"4\"\n\"service_description\" : (string) Example: \"Signature Next Day\", using this will automatically find the right details for the matching service\n\"get_services\" : (boolean) defaults to false, if true, the response will be an array of available services for the provided shipment\n\"parcel_description\" : (boolean) defaults to \"Boxes\"\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
These courier specific options are REQUIRED:
\n\"service_code\": (string) service_code as returned from get-services. Example: \"LS\", \"MS\", \"MSPre1\"\n\"package_type_code\": (string) Code representing the package type. To get the whole list, send this call with the get_package_type_code field set to true. Example: \"BX\", \"PCH\", \"LN\"\n\nThese courier specific options are OPTIONAL:
\n\"address_book_entry_key\": (string) Required field for return requests. First send a request with get_return_addresses set to true, then please fill this field with the addressBookEntryKey in the returned data.\n\"cover_value\": (number) The value of the additional Transit Liability cover required in the local currency (UK £, IE €)\n\"dont_downgrade_service\": (boolean) If true then requests with premium services that are not available will be rejected as invalid, rather than being downgraded to the next available service level\n\"get_package_type_codes\": (string) Set true to get package type codes\n\"get_return_addresses\": (boolean) Set true to get return addresses\n\"customs_movement_type\" : (string) Enumeration value for the transaction / movementtype: \"B2B\" or \"B2C\"\n\"customs_goods_value\" : (string) Commercial value of the goods\n\"customs_goods_value_currency\" : (string) currency code that the GoodsValue property represents: \"EUR\" or \"GBP\"\n\"customs_contents\" : (string) A detailed and accurate description of the goods. Vague descriptions are more likely to be delayed clearing customs\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
The following settings are REQUIRED to pass through in the \"courier\" section of the json:
\n\"service_code\" : (string) ON – Overnight, 3D – 3Day, 930 – Overnight 9:30, AM – Overnight pre noon, SAT – Saturday, S93 – Saturday 9:30\n\"content_description_id\" : (string) 1 = CartonKG, 2 = Kilos, 3 = Length, 4 = LengthGreaterThan3Metres, 5 = IDW, 6 = Pallet, 7 = Nightpak\nThe following settings are OPTIONAL
\n\"delivery_account_number\" : (string) Delivery Account Number\n\"label_account_name\" : (string) Label Account Name\n\"generate_reference\" : (boolean) defaults to false, generates a random reference -- use this if the reference you send is greater than 10 characters\n\"book_in\" : (boolean) defaults to true, sets the BookInFlag on the GetLabels request\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
The following settings are REQUIRED to pass through in the \"courier\" section of the json:
\n\"service_code\" : (string) \"1\", \"3\", \"9\", \"13\", \"15\", \"17\" and \"31\" values for Domestic shipments. \"7\", \"19\" and \"77\" values for International shipments.\n\"product_code\" : (string) \"2\", \"18\", \"48\", \"86\" and \"88\" values for Domestic shipments. \"48\", \"70\", \"104\", \"108\", \"114\", \"116\", \"122\" and \"77\" values for International shipments.\n\nThe following settings are OPTIONAL to pass through in the \"courier\" section of the json:
\n\"account_number\" : (string) Account number to payer. Default Account Number is inherited from registered auth if this is not specified.\n\"charges\" : (string) Default \"P\", Shipment charges \"P\" => payed (sender pays the shipment/collection); \"D\" => due (Consignee pays the shipment/collection)\n\"security\" : (boolean) Default false. Flag that activates control book (true / false)\n\"pod\" : (string) Default \"S\". Flag that activates Proof Of Delivery (\"I\" => Inmediato / \"S\" => Seur)\n\"dconsig\" : (boolean) Default false. Flag that activates delivery order to the holder (true / false)\n\"ddid\" : (boolean) Default false. Flag that activates order to deliver to the holder requesting an id (true / false)\n\"dsat\" : (boolean) Default false. Flag that activates delivery on Saturday (true / false)\n\"change\" : (boolean) Default false. Flag that activates order to generate an additional shipment linked for return (true / false)\n\"taric\" : (string) Id code of the products that are exported or imported\n\"adu_outkey\" : (string) Default \"P\". for customs management at origin. \"P\" => payed (sender pays the management); \"D\" => due (Consignee pays the management)\n\"adu_inkey\" : (string) Default \"P\". for customs management at origin. \"P\" => payed (sender pays the management); \"D\" => due (Consignee pays the management)\n\"incoterms\" : (string) Default \"DDP\". \"DAP\" => (Delivered at Place) Taxes and customs expenses at destination are paid by the recipient \"DDP\" => (Delivered Duty Paid) A DDP operation establishes that the seller pays all expenses until leaving the merchandise at the agreed point in the country of destination. The buyer does not perform any process. Import customs charges are borne by the seller\n\"customs_goods_type\" : (string) Default \"C\". \"C\" => Commercial \"N\" => Non-commercial, \"D\" => Documents\n\"declared_value\" : (number) Declared value\n\"insured_value\" : (number) Insured value\n\"cod_value\" : (number) Cod value\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
There are no REQUIRED courier-specifics
\nThe following settings are OPTIONAL
\n\"service_code\" : (string) If applicable, you can specify a service code.\n\"parcel_description\" : (string) A description for the goods in the shipment.\n\"trade_terms\" : (string) Defaults to \"DDU\". Other applicable value is \"DDP\".\n\"create_parcel\" : (boolean) Defaults to false. If true, uses the Exelot parcels/parcel api\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
The following settings are REQUIRED
\n\"service_description\" : (string) Example: \"Pallet Force Premium UK\"\nThe following settings are OPTIONAL
\n\"freight_class\" : (string) example \"300\"\n\"stacking_allowed\" : (boolean) null by default\n\"accessorials\" : (string) send through in format `category1:scope1,category2:scope2,...` \"consignee_open_time\" : (string) defaults to \"07:00\"\n\"consignee_close_time\" : (string) defaults to \"19:00\"\n\"shipper_open_time\" : (string) defaults to \"07:00\"\n\"shipper_close_time\" : (string) defaults to \"19:00\"\n\"shipper_ein\" : (string) required for some international services\n\"shipper_po_number\" : (string) if not supplied, defaults to shipment reference\n\"special_instructions\": (string) defaults to null\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
There are not required settings for ExpectDistribution.
\nThe following settings are OPTIONAL to pass through in the \"courier\" section of the json:
\n\"job_type\" : (string) example: \"Delivery\"\n\"service_level_code\" : (string) Example: \"B\" for 48 Hour service\n\"goods_description\" : (string) Defaults to first item description or \"GENERAL GOODS\"\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
Hermes only supports individual shipments: the 'parcels' array must have only 1 element.
\nThere are no REQUIRED elements in the \"courier\" section of the json.
\nThe following settings are OPTIONAL to pass through in the \"courier\" section of the json:
\n\"address_validation_required\" : (boolean) defaults to false\n\"item_description\" : (string) defaults to \"ANY\"\n\"origin_of_parcel\" : (string) defaults to \"GB\"\n\"country_of_origin\" : (string) defaults to \"GB\"\n\"next_day\": (boolean) defaults to false\n\"signature_required\": (boolean) defaults to false\n\"is_return\": (boolean) use true if the label is a customer return\n\"qr_code\": (boolean) to be used with is_return, if you want a qr code for print-in-store instead of a normal label\n\"qr_use_returned_address\": (boolean) if is_return and qr_code set, use this code to use the address returned from Hermes api as the DeliveryAddress\n\"catalogue\": (boolean) Set to true if the parcel is a catalogue or postable\n\"customer_alert_type\": (number) 1 for email, 2 for sms\n\"parcel_shop_id\": (string) if supplied, uses the ParcelShop service. example: \"001027\"\n\"parcel_shop_country\": (string) supply this with parcel_shop_id. example: \"DE\"\n\"is_c2c\": (boolean) Set to true for c2c shipment\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
There are now required courier-specifics for FastDespatchLogistics
\nThe following courier specifics are OPTIONAL
\n\"use_one_time_password\" : (boolean) defaults to false\n\"needs_collection\" : (boolean) defaults to false\n\"age_restricted\" : (boolean) defaults to false\n\"contains_liquid\" : (boolean) defaults to false\n\"fragile\" : (boolean) defaults to false\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
The following settings are REQUIRED to pass through in the \"courier\" section of the json:
\n\"service_id\": (string) service_id as returned from get-services. Ex: \"Fastway|UY - Local Parcel UY\"\n\"warehouse_id\": (string) warehouse_id as returned from get-pickup-locations (identifier). Ex: \"Company|London Warehouse\"\n\"shipping_method\": (string) The shipping method to be used in Scurri for the consignment which can be used with the Scurri rules engine. Ex: \"uk_next_day\"\n\nThe following settings are OPTIONAL to pass through in the \"courier\" section of the json:
\n\"override_sender_data\": (boolean) Defaults to false. If true, ship_from data is sent to override the default sender.\n\"carrier\": (string) Defaults to \"Fastway\". The carrier this consignment is to be shipped with.\n\"reason_for_export\": (string) Defaults to \"merchandise\". Possible values: \"sample\", \"documents\", \"gift\", \"returns\", \"personal\", \"other\"\n\"incoterm\": (string) The trade term associated with the shipment. Ex: \"DDP\"\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
The following settings are REQUIRED to pass through in the \"courier\" section of the json:
\n\"service_code\" : example \"FEDEX_NEXT_DAY_END_OF_DAY\"\nThe following settings are OPTIONAL to pass through in the \"courier\" section of the json:
\n\"packaging_type\" : (string) defaults to \"YOUR PACKAGING\"\n\"duty_payee\" : (string) defaults to \"RECIPIENT\"\n\"signature\" : (string) defaults to \"SERVICE_DEFAULT\", other options are \"ADULT\",\"DIRECT\",\"INDIRECT\",\"NO_SIGNATURE_REQUIRED\"\n\"saturday_delivery\" : (boolean) defaults to false\n\"smartpost_indicia\" : (string) Only useful if service_code is \"SMART_POST\". Defaults to \"PARCEL_SELECT\"\n\"smartpost_ancilliary_endorsement\" : (string) Only useful if service_code is \"SMART_POST\". Defaults to null\n\"smartpost_hub_id\" : (string) Required if service_code is \"SMART_POST\". A 4-digit numerical value to identify the SmartPost hub to use.\n\"smartpost_customer_manifest_id\" : (string) Only useful if service_code is \"SMART_POST\". Defaults to null\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
The following settings are REQUIRED to pass through in the \"courier\" section of the json:
\n\"courier\" : Example: \"AmazonShipping\"\n\"service_id\" : Example: \"Fast Saturday\"\nThe following settings are OPTIONAL to pass through in the \"courier\" section of the json:
\n\"auth_company\" : please contact FloStream for further questions about this field\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
There are not required settings for Furdeco.
\nThe following settings are OPTIONAL to pass through in the \"courier\" section of the json:
\n\"retailer_name\" : (string) The name of the retailer for this label\n\"trading_name\" : (string) The trading name of the sender\n\"product_action_type\" : (string) Default: \"Delivery\", Other option is \"Collect\"\n\"timed_service\" : (string) Options are \"All Day\", \"Business House\", \"AM\", \"PM\"\n\"service_type\" : (string) Options are \"Standard\", \"Supplier Collection\"\n\"service_level\" : (string) Options are \"1 Man\", \"2 Man\"\n\"delivery_point\" : (string) Options are \"Room Of Choice\", \"Hallway\"\n\"unpack_items\" : (number) Options are 0 or 1\n\"take_packaging_away\" : (number) Options are 0 or 1\n\"assemble\" : (number) Options are 0 or 1\n\"disassemble\" : (number) Options are 0 or 1\n\"collect_disposal\" : (number) Options are 0 or 1\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
The following settings are REQUIRED to pass through in the \"courier\" section of the json:
\n\"contract_no\" : Example: \"0777\"\n\"carrier\" : Example: \"DPD\"\n\"service_code\" : Example: \"19\"\nThe following settings are OPTIONAL to pass through in the \"courier\" section of the json:
\n\"dropoff\" : defaults to \"REGULAR_PICKUP\"\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
The following settings are REQUIRED to pass through in the \"courier\" section of the json
\n\"product\" : (string) Options are \"PARCEL\", \"EXPRESS\" or \"FREIGHT\". Default: \"PARCEL\"\n\nThe following settings are OPTIONAL to pass through in the \"courier\" section of the json:
\n\"incoterm_code\" : (string) Incoterm for this shipment. Represented by 2 digits\n\"identifier\" : (string) Person who started the parcel creation\n\"alt_delivery\" : (boolean) Alternative delivery activation\n\"shipment_service\" : (string) You can define services that should apply to your shipment as specified in the GLS DE documentation.\n\"shipment_unit_service\" : (array) You can define services that should apply to your parcels as specified in the GLS DE documentation.\n\"invoice_number\" : (string) Number of related shipment of invoice\n\"invoice_date\" : (string) Date of related shipment of invoice\n\"is_export_declaration_requested\" : (boolean) Set to true if you request GLS to do the export customs declaration (always requires GLS eDeclarationService). Set to false if declaration is not needed at all. Set to false and insert export declaration MRN (transit MRN if declaration is done by your own).\n\"export_declaration_numbers\" : (string) Comma-separated list of export declaration numbers if export customs declaration has already been made by customer. Example \"A,B,C\". Mandatory depends on field \"isExportDeclarationRequested\". Leave field empty if export declaration is not needed.\n\"transit_MRNs\" : (string) Comma-separated list of MRNs of according T-papers in case of transit procedure. Mandatory if field \"is_export_declaration_requested\" is true.\n\"region_of_origin\" : (string) For example: \"01\", Region of origin based on german customs code convention, 01=Schleswig-Holstein 02=Hamburg 03=Niedersachsen 04=Bremen 05=Nordrhein-Westfalen 06=Hessen 07=Rheinland-Pfalz 08=Baden-Württemberg 09=Bayern 10=Saarland 11=Berlin 12=Brandenburg 13=Mecklenburg-Vorpommern 14=Sachsen 15=Sachsen-Anhalt 16=Thüringen 99=Ausländischer Ursprung\n\"ship_from_phone_country_prefix\" : (string) Phone number international country prefix\n\"ship_to_phone_country_prefix\" : (string) Phone number international country prefix\n\"shipment_service_category\": (string) You can define services that should apply to your shipment as specified in the GLS DE documentation. You can check the \"Nod N3\" field in the documentation. Examples: \"Service\", \"ShopDelivery\"\n\"shipment_service_additional_attribute\": (string) If your service requires additional information as specified in the GLS DE documentation, you can define the title of this information. You can check the \"Attributes\" field in the documentation. Examples: \"ParcelShopID\", \"PickupDate\"\n\"shipment_service_additional_value\": (string) If your service requires additional information as specified in the GLS DE documentation, you can define the value of this information. You can check the \"Values\" field in the documentation. Example: \"YYYY-MM-DD\"\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
The following settings are REQUIRED to pass through in the \"courier\" section of the json
\n\"product\" : (string) Options are \"PARCEL\", \"EXPRESS\" or \"FREIGHT\". Default: \"PARCEL\"\n\nThe following settings are OPTIONAL to pass through in the \"courier\" section of the json:
\n\"incoterm_code\" : (string) Incoterm for this shipment. Represented by 2 digits\n\"identifier\" : (string) Person who started the parcel creation\n\"alt_delivery\" : (boolean) Alternative delivery activation\n\"shipment_service\" : (string) You can define services that should apply to your shipment as specified in the GLS DE documentation.\n\"shipment_unit_service\" : (array) You can define services that should apply to your parcels as specified in the GLS DE documentation.\n\"invoice_number\" : (string) Number of related shipment of invoice\n\"invoice_date\" : (string) Date of related shipment of invoice\n\"is_export_declaration_requested\" : (boolean) Set to true if you request GLS to do the export customs declaration (always requires GLS eDeclarationService). Set to false if declaration is not needed at all. Set to false and insert export declaration MRN (transit MRN if declaration is done by your own).\n\"export_declaration_numbers\" : (string) Comma-separated list of export declaration numbers if export customs declaration has already been made by customer. Example \"A,B,C\". Mandatory depends on field \"isExportDeclarationRequested\". Leave field empty if export declaration is not needed.\n\"transit_MRNs\" : (string) Comma-separated list of MRNs of according T-papers in case of transit procedure. Mandatory if field \"is_export_declaration_requested\" is true.\n\"region_of_origin\" : (string) For example: \"01\", Region of origin based on german customs code convention, 01=Schleswig-Holstein 02=Hamburg 03=Niedersachsen 04=Bremen 05=Nordrhein-Westfalen 06=Hessen 07=Rheinland-Pfalz 08=Baden-Württemberg 09=Bayern 10=Saarland 11=Berlin 12=Brandenburg 13=Mecklenburg-Vorpommern 14=Sachsen 15=Sachsen-Anhalt 16=Thüringen 99=Ausländischer Ursprung\n\"ship_from_phone_country_prefix\" : (string) Phone number international country prefix\n\"ship_to_phone_country_prefix\" : (string) Phone number international country prefix\n\"shipment_service_category\": (string) You can define services that should apply to your shipment as specified in the GLS DE documentation. You can check the \"Nod N3\" field in the documentation. Examples: \"Service\", \"ShopDelivery\"\n\"shipment_service_additional_attribute\": (string) If your service requires additional information as specified in the GLS DE documentation, you can define the title of this information. You can check the \"Attributes\" field in the documentation. Examples: \"ParcelShopID\", \"PickupDate\"\n\"shipment_service_additional_value\": (string) If your service requires additional information as specified in the GLS DE documentation, you can define the value of this information. You can check the \"Values\" field in the documentation. Example: \"YYYY-MM-DD\"\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
The following settings are REQUIRED to pass through in the \"courier\" section of the json
\n\"service\" : (string) Service number, 1=Courier, 37=Economy, 74=EuroBusinessParcel. Consult GLS for the full list.\n\"schedule\": (string) Schedule number, also known as \"service time frame\". Examples: 3=BusinessParcel, 2=14:00Service, 18=EconomyParcel. Consult GLS for the full list.\n\nThe following settings are OPTIONAL to pass through in the \"courier\" section of the json:
\n\"postage_type\" : (string) Defaults to \"P\" for Paid, other option is \"D\" for collection on delivery\n\"cod_amount\" : (number) Refund amount, COD: cash on delivery (when post_type=P)\n\"unique_references\" : (boolean) if set to true, we will add 2 random characters to your reference and order_id to meet GLS's unique reference requirements\n\"incoterm\" : (string) Example values: \"18\" for DDP, \"20\" for DAP. Consult GLS for the full list.\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
The following settings are REQUIRED to pass through in the \"courier\" section of the json:
\n\"ship_type\" : (string) Should be selected as Parcel \"P\" or Freight \"F\" shipment. The maximum weight of a parcel is 32kg. For freight, the unit type must be specified.\n\nThe following settings are OPTIONAL to pass through in the \"courier\" section of the json:
\n\"unit_type\" : (string) Only relevant if Freight service type is used. Defaults to \"CO\", other options are \"LG\", \"MP\", \"BP\", \"XL\", \"PL\", \"RL\".\n\"express_service\" : (string) Default \"None\", \"T9\" Delivery before 09:00 on weekdays, \"T12\" Delivery before 12:00 on weekdays, \"T17\" Delivery before 17:00 on weekdays, \"S9\" Delivery before 09:00 on Saturday, \"S12\" Delivery before 12:00 on Saturday, \"S17\" Delivery before 17:00 on Saturday\n\"return_service\" : (boolean) Determines if the shipment is a return service\n\"delivery_shop_id\" : (string) Id that identifies the delivery store\n\"delivery_plus\" : (boolean) Determines if the shipment requires delivery plus service\n\"saturday_service\" : (boolean) Determines if the shipment requires saturday service\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
Hermes only supports individual shipments: the 'parcels' array must have only 1 element.
\nThere are no REQUIRED elements in the \"courier\" section of the json.
\nThe following settings are OPTIONAL to pass through in the \"courier\" section of the json:
\n\"item_description\" : (string) defaults to \"ANY\"\n\"compensation_required_pounds\" : (number) defaults to 0\n\"signature_required\" : (boolean) defaults to false\n\"delivery_safe_place\": (string) defaults to \"\"\n\"next_day\": (boolean) defaults to false\n\"parcel_type\": (string) defaults to \"STANDARD\", alternative is \"POSTABLE\"\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
Hermes only supports individual shipments: the 'parcels' array must have only 1 element.
\nThere are no REQUIRED elements in the \"courier\" section of the json.
\nThe following settings are OPTIONAL to pass through in the \"courier\" section of the json:
\n\"address_validation_required\" : (boolean) defaults to false\n\"item_description\" : (string) defaults to \"ANY\"\n\"origin_of_parcel\" : (string) defaults to \"GB\"\n\"country_of_origin\" : (string) defaults to \"GB\"\n\"next_day\": (boolean) defaults to false\n\"signature_required\": (boolean) defaults to false\n\"is_return\": (boolean) use true if the label is a customer return\n\"qr_code\": (boolean) to be used with is_return, if you want a qr code for print-in-store instead of a normal label\n\"qr_use_returned_address\": (boolean) if is_return and qr_code set, use this code to use the address returned from Hermes api as the DeliveryAddress\n\"catalogue\": (boolean) Set to true if the parcel is a catalogue or postable\n\"customer_alert_type\": (number) 1 for email, 2 for sms\n\"parcel_shop_id\": (string) if supplied, uses the ParcelShop service. example: \"001027\"\n\"parcel_shop_country\": (string) supply this with parcel_shop_id. example: \"DE\"\n\"is_c2c\": (boolean) Set to true for c2c shipment\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
There are no REQUIRED elements in the \"courier\" section of the json.
\nThe following settings are OPTIONAL to pass through in the \"courier\" section of the json:
\n\"shipping_class\" : (string) Determines the method of shipment. Defaults to \"Next-Day\", other options are \"Same-Day\", \"Next-Day\", \"2-Days\".\n\"fragile\" : (boolean) Either true for fragile or false for not fragile. Defaults to false\n\"sender_chosen_delivery_date\" : (string) This is only required if the delivery date is not supposed to be asap\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
The following settings are REQUIRED to pass through in the \"courier\" section of the json:
\n\"courier\" : Example: \"AmazonShipping\"\n\"service_id\" : Example: \"Fast Saturday\"\nThe following settings are OPTIONAL to pass through in the \"courier\" section of the json:
\n\"auth_company\" : please contact Hub Europe for further questions about this field\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
No courier-specific settings required for this courier.
\n","urlObject":{"path":["api","couriers","v1","HubEuropeExpress","create-label"],"host":["{{api_url}}"],"query":[],"variable":[]}},"response":[{"id":"f512f757-df01-46b8-ba05-07f1a86211a1","name":"HubEuropeExpress","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\"auth_company\":\t\t\"company\",\r\n \"request_id\": \"piocm5241li2dfj\",\r\n \"format_address_default\" : true,\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 \"collection_date\": \"2019-11-19T09:28:04.760Z\",\r\n \"reference\": \"my custom reference\",\r\n \"delivery_instructions\": \"Leave on the porch\",\r\n \"ship_from\": {\r\n \"name\": \"Sir Foo\",\r\n \"phone\": \"2125551234\",\r\n \"email\": \"foo@foo.com\",\r\n \"company_name\": \"Foo Store\",\r\n \"address_1\": \"255 New town\",\r\n \"address_2\": \"Wow Avenue\",\r\n \"address_3\": \"\",\r\n \"city\": \"Belleville\",\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 },\r\n \"ship_to\": {\r\n\t \"name\": \"Recipient Name\",\r\n\t \"phone\": \"30201231234\",\r\n\t \"email\": \"support@buyer.com\",\r\n\t \"company_name\": \"The Receiving Company\",\r\n\t \"address_1\": \"77 Street Street\",\r\n\t \"address_2\": \"\",\r\n\t \"address_3\": \"\",\r\n\t \"city\": \"New City\",\r\n\t \"county\": \"\",\r\n\t \"postcode\": \"YO25 6NN\",\r\n\t \"country_iso\": \"GB\",\r\n \"tax_id\": \"123-456-78\"\r\n\t },\r\n \"parcels\": [\r\n\t {\r\n\t \"dim_width\": 20,\r\n\t \"dim_height\": 40,\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 }\r\n}"},"url":"{{api_url}}/api/couriers/v1/HubEuropeExpress/create-label"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n\t\"type\":\"PDF\",\n\t\"request_id\":\"1589992569674\",\n\t\"tracking_codes\": [\n \"HX14280\"\n ],\n \"tracking_urls\": [\n \"http://hubeurope.com/portal/?method=tracking&consign_note=HX14280\"\n ],\n\t\"uri\":\"http://vault.ecloud.co.uk/courierapi/transglobal_label_1519892111_SOExc.pdf?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=HSEOVCX3IWRFNRTAZBR7%2F20200520%2Feu-west-2%2Fs3%2Faws4_request&X-Amz-Date=20200520T163542Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Signature=9f9da417f6faab541810ac592ec1be5c8ddf572e6e7fb77e0ab7c85454c3cd25\",\"key\":\"transglobal_label_1519892111_SOExc.pdf\",\n\t\"dc_request_id\":3949\n}"}],"_postman_id":"c3df7819-53bc-4ce8-8e5c-709bd7fd9986"},{"name":"ImpactExpress","id":"601e7756-7109-488d-94de-f0a0830ec4af","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
The following settings are REQUIRED to pass through in the \"courier\" section of the json:
\n\"courier\" : Example: \"AmazonShipping\"\n\"service_id\" : Example: \"Fast Saturday\"\nThe following settings are OPTIONAL to pass through in the \"courier\" section of the json:
\n\"auth_company\" : please contact ImpactExpress for further questions about this field\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
The following settings are REQUIRED to pass through in the \"courier\" section of the json:
\n\"size\" : Example : \"A\" -> (Small) 8 CM X 38 CM X 64 CM , \"B\" -> (Medium) 19 CM X 38 CM X 64 CM , \"C\" -> (Large) 41 CM X 38 CM X 64 CM\n\"parcel_type\" : possible values: \"A2L\",\"L2A\" -- \"A2L\" -> Address to Locker Label , \"L2A\" -> Locker to Address Label\nThe following settings are OPTIONAL to pass through in the \"courier\" section of the json:
\n\"service_type\" : Defaults to \"2DAY\", Acceptable values: \"NDAY\": Next Day Delivery Service, \"2DAY\": 48 Hours Delivery Service\n\"target_machine_id\" : The ID/Name of the parcel machine from where the parcel will be delivered by courier/collected by recipient, defaults to \"ADDRESS\"\n\"receiver_address_building_no\" : If your parcel_type choice is L2A, you must fill in this field\n\"sender_address_building_no\" : If your parcel_type choice is L2A, you must fill in this field\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
The following settings are REQUIRED to pass through in the \"courier\" section of the json:
\n\"ship_method\" : Example: \"LGINTSTDU\"\n\nThe following settings are OPTIONAL to pass through in the \"courier\" section of the json:
\n\"insurance_freight\" : (number) defaults to 0\n\"vendor_info\" : (boolean) if true, we send the VendorInformation fields up to Landmark\n\"ship_options\" : (string) provide in format `name1:value1,name2:value2`\n\"final_mile_label\" : (boolean) Set to true for a final mile carrier label\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
The following settings are REQUIRED to pass through in the \"courier\" section of the json:
\n\"shipping_type\" : Example: 900\nThere are no optional courier settings
\n","urlObject":{"path":["api","couriers","v1","LowCostParcels","create-label"],"host":["{{api_url}}"],"query":[],"variable":[]}},"response":[{"id":"63b8350e-79b1-4ab2-b9be-a46c5f29a813","name":"LowCostParcels","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\"auth_company\":\t\t\"company\",\r\n \"request_id\": \"piocm5241li2dfj\",\r\n \"format_address_default\" : true,\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 \"shipping_type\" : 900\r\n },\r\n\r\n \"collection_date\": \"2019-11-19T09:28:04.760Z\",\r\n \"reference\": \"my custom reference\",\r\n \"delivery_instructions\": \"Leave on the porch\",\r\n \"ship_from\": {\r\n \"name\": \"Sir Foo\",\r\n \"phone\": \"2125551234\",\r\n \"email\": \"foo@foo.com\",\r\n \"company_name\": \"Foo Store\",\r\n \"address_1\": \"255 New town\",\r\n \"address_2\": \"Wow Avenue\",\r\n \"address_3\": \"\",\r\n \"city\": \"Belleville\",\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 },\r\n \"ship_to\": {\r\n \"name\": \"Recipient Name\",\r\n \"phone\": \"30201231234\",\r\n \"email\": \"support@buyer.com\",\r\n \"company_name\": \"The Receiving Company\",\r\n \"address_1\": \"77 Street Street\",\r\n \"address_2\": \"\",\r\n \"address_3\": \"\",\r\n \"city\": \"New City\",\r\n \"county\": \"\",\r\n \"postcode\": \"YO25 6MM\",\r\n \"country_iso\": \"GB\"\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\": 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 \"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\": 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}"},"url":"{{api_url}}/api/couriers/v1/LowCostParcels/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":"75c5266c-eafd-4b99-9049-289584fe63c6"},{"name":"MHIAnnounce","id":"b90c8397-1163-41fe-9b0c-d42c2cbef280","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
The following settings are REQUIRED to pass through in the \"courier\" section of the json:
\n\"service\" : (string) Example: \"Tracked DDP\"\n\nThe following settings are OPTIONAL to pass through in the \"courier\" section of the json:
\n\"temp_password\" : (string) Used for two factor authentication – not necessarily implemented between application to application.\n\"validate_only\" : (boolean) Setting to false will validate the address and save it. Setting to true will validate the addresses legitimateness and will not save. Default : false\n\"address_cleaning\" : (number) Default 0. This specifies the level of address validation that will be applied. The values can be: 0 => No address Validation is performed 1 => Basic Validation: Returns Warnings/Recommendations to changes in address but still saves address to database so the address could be incorrect 5 => Returns Warnings/Recommendations to changes in address but does not save to database. This can be used for validation purposes before label generation.\n\"import_session_id\" : (number) Recommended to create an import Shipment ID to use as a container for a batch of items announced. Default : 0\n\"content_type\" : (string) \"Printed Matter\": Matter such as books, magazines, letters – predominately made from paper. \"Non Printed Matter\": Anything else. Default : \"Non Printed Matter\"\n\"route_charge_id\" : (number) Only available for accounts that can produce final mile labels. Id of the Route Charge which will be used to calculate which service will be used for this shipment.\n\"consignment_type\" : (string) This will be used to specify which consignment type gets selected on the CN22 label for this Shipment. Examples: \"Sale of Goods\", \"Gift\", \"Sample\", \"Returned Goods\", \"Documents\", \"Other\" Default: \"Sale of Goods”\"\n\"online_selling_platform\" : (string) Online selling platform can be the seller’s own website or a marketplace.\n\"cpc_code\" : (string) CPC code is made up of 7 characters; it shows the customs regime which goods are being entered into or removed from. Example : \"31 51 A53\". Condition: A default for this field can be set up on your client profile; however, if a value is sent on this field it will override the default. If there is no value on this field and no default available, then an error will be returned.\n\"export_license_number\" : (string) Export License number is applicable to only certain products. If it is applicable, then consignor should provide it to avoid custom delays\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
The following settings are REQUIRED to pass through in the \"courier\" section of the json:
\n\"courier\" : Example: \"AmazonShipping\"\n\"service_id\" : Example: \"Fast Saturday\"\nThe following settings are OPTIONAL to pass through in the \"courier\" section of the json:
\n\"auth_company\" : please contact NowFulfilment for further questions about this field\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
The following settings are REQUIRED to pass through in the \"courier\" section of the json:
\n\"service_code\" : Example: \"SDDP\"\n\nThe following settings are OPTIONAL to pass through in the \"courier\" section of the json:
\n\"service_supplier\" : (string) defaults to empty string, \"\"\n\"service_route\" : (string) defaults to empty string, \"\"\n\"shipment_description\" : (string) defaults to \"General Goods\"\n\"non_dox\" : (boolean) defaults to true, indicates if the shipment is documents or non-documents\n\"ddp\" : (boolean) defaults to false\n\"pallet\" : (boolean) defaults to false\n\"close_time\" : (string) Time the collection location closes, defaults to \"17:00\"\n\"next_business_day\" : (boolean) Defaults to true. If true, it pushes the ReadyByDate to the next business day.\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
The following settings are REQUIRED to pass through in the \"courier\" section of the json:
\n\"service_code\" : (string) Shipping service that will be used for the shipment. Possible values: 001, 055, 10, 101, 12, 18, 201, 301, 32, 7, 8, 9, 901, 902, 903, 904\n\nThe following settings are OPTIONAL to pass through in the \"courier\" section of the json:
\n\"confirmation\" : (string) Specifies the type of approval required for the shipment to be delivered.Possible values: Online, Delivery, Signature, Adult, Verbal\n\"non_delivery\" : (string) Option for what to do if a shipment cannot be delivered. Possible values: \"return\" or \"abandon\"\n\"saturday_delivery\" : (boolean) Indicates whether or not the package should be delivered on a Saturday.\n\"contains_alcohol\" : (boolean) Indicates whether the package contains alcohol or not.\n\"package_code\" : (string) Leave blank unless agreed with ODS\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
The following settings are REQUIRED to pass through in the \"courier\" section of the json:
\n\"service\" : (string) Example: \"YO48\"\n\nThe following settings are OPTIONAL to pass through in the \"courier\" section of the json:
\n\"terms\" : (string) defaults to \"DDU\", other option is \"DDP\"\n\"cod_amount\" : (number) defaults to null\n\"cod_currency\" : (string) defaults to null\n\"dangerous_goods\" : (boolean) defaults to false\n\"country_of_origin\" : (string) defaults to \"GB\"\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
The following settings are REQUIRED to pass through in the \"courier\" section of the json:
\n\"service_type\" : (string) courier service code, eg \"NFA\"\n\"delivery_window_in_days\" : (number) Example: 2 - This would mean delivery is in 2 working days after collection.\nThe following settings are OPTIONAL to pass through in the \"courier\" section of the json:
\n\"gdpr_consent\" : (boolean) defaults to false\n\"delivery_start_time\" : (string) defaults to \"08:00:00\"\n\"delivery_end_time\" : (string) defaults to \"20:00:00\"\n\"failover_courier\" : (string) specify this to use a different courier for unsupported regions. example: \"DPD\"\n\"failover_courier_auth_company\" : (string) to be used with the failover_courier option, based on your registered auth\n\"failover_courier_dc_service_id\" : (string) to be used with the failover_courier option, this selects the preset to use with the failover courier\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
The following settings are REQUIRED to pass through in the \"courier\" section of the json:
\n\"service_name\" : (string) Name of Service required. Options are \"A\", \"B\", \"C\" or \"D\"\n\"insurance_code\" : (string) Please contact Palletforce for further information. Max 8 character\n\nThe following settings are OPTIONAL to pass through in the \"courier\" section of the json:
\n\"surcharges\": (string) The Manifest file will contain surcharge types for consignments. Options are \"AM\", \"BI\", \"BW\", \"CD\", \"EB\", \"SA\", \"TA\"\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
The following settings are REQUIRED to pass through in the \"courier\" section of the json:
\n\"service_code\": (string) for example, \"B\"\n\"service_surcharge\": (string) for example, \"B\"\n\nThe following settings are OPTIONAL to pass through in the \"courier\" section of the json:
\n\"service_type\": (string) Defaults to \"delivery\", other options are \"collection\" and \"thirdparty\"\n\"collection_service_type\": (string) Defaults to \"Collection\", only if collection_service_code is specified\n\"collection_service_code\": (string) Service Code for Collection service type\n\"collection_service_surcharge\": (string) Surcharge Code for Collection service type\n\"consignment_type\": (string) Defaults to \"D\" => Delivery, other options are \"C\" => Collection and \"3\" => Third party\n\"consignment_number\": (string)\n\"pallet_type\": (string) possible values: \"LP\", \"FP\", \"HP\", \"QP\", \"MQP\" - we calculate automatically if not provided\n\"delivery_date\": (string) must be provided in DateTime format, for example \"2020-12-31T12:00:00\"\n\"pallet\": (string) A code for identifying a specific pallet, Ex: FY8491753\n\"hand_ball\": (boolean) defaults to true\n\"tail_lift\": (boolean) defaults to false\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
The following settings are REQUIRED to pass through in the \"courier\" section of the json:
\n\"service\": (string) A valid service code for this customer. Example: \"ND\"\n\"item_type\": (string) Item Types: \"FULL\", \"HALF\", \"QUARTER\", \"OVERSIZE\". For multi-parcel requests, may be a comma-separated list: \"FULL,FULL,HALF\"\n\nThe following settings are OPTIONAL to pass through in the \"courier\" section of the json:
\n\"consignment_type\": (number) Collection: 1, Delivery: 2, Collection And Delivery: 3. Default: 2\n\"consignment_number\": (string) This is typically the reference that a customer will see on the consignments documentation such as labels and invoices.\n\"surcharges\": (string) Surcharges can either relate to an additional time constraint required when delivering the consignment or they could simply be an additional instruction or flag on the job. Examples: AM, LF\n\"customer_paperwork_required\": (boolea Delivery paperwork can be requested by customers through the customer portal, whether it\\'s physical or electronic. Depot can set it as mandatory, optional, or enforce values with warnings for user input. Default: falsen)\n\"unit_code\": (string) Must be a valid unit code for your customer. Default: \"K\"\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
There are no REQUIRED specifics
\nThe following settings are OPTIONAL
\n\"network\" : (string) Default: \"UK\", Other options are \"BE\", \"ES\", \"RO\", \"FT\"\n\"consignment_type\" : (string) Default: Delivery => \"2\", Other options are Collection => \"1\" , Both => \"3\"\n\"delivery_service\" : (string) Options are Premium Service => \"A\", Book-In Service => \"B\" Economy Service => \"B\", \"Saturday Mornings\" => \"C\" Specific Time => \"D\", Specific Time & Specific Day => \"E\", Morning => \"F\", Specific Day => \"H\", Morning, Specific Day => \"L\", Before Specific Time => \"O\". Applicable for consignment type \"2\" and \"3\".\n\"collection_service\" : (string) Options are Premium Service => \"A\", Economy Service => \"B\". Applicable for consignment type \"1\" and \"3\".\n\"consignment_number\" : (string) Consignment number. Maximum length 12 characters.\n\"delivery_due_date\" : (string) If the consignment requires a delivery and the Delivery Service is \"Date Specific\" then set this date to the required delivery date.\n\"input_period\" : (string) Default Day => \"D\" other option N => \"N\"\n\"security\" : (boolean) Options true or false. Not available in UK.\n\"pallet_type\" : (string) Default \"STANDARD\" other option is \"EURO\"\n\"pallet_size_type\" : (string) Default \"Full\" other options are \"Half\", \"Quarter\"\n\"pallet_size_types\" : (string) Comma-separated string to specify different size types for multiple parcels, eg \"Half,Quarter,Half,Half,Full\". If you supply this argument, the number of sizes must match the number of submitted parcels\n\"customer_account\" : (string) Customer account code.\n\"customer_reference\" : (string) Customer reference number.\n\"tail_lift_col\" : (boolean) Tail lift for collection required: true or false. Default false.\n\"tail_lift_del\" : (boolean) Tail lift for delivery required: true or false. Default false.\n\"restricted_access_col\" : (boolean) Restricted access in collection area: true or false. Default false.\n\"restricted_access_del\" : (boolean) Restricted access in delivery area: true or false. Default false.\n\"book_in_req\" : (boolean) Required when delivery service selected \"Book-In\": true or false. Default false.\n\"own_job\" : (boolean) Set to true if a consignment is being collected and delivered by the same depot as originator (Depot’s only)\n\"col_post_area\" : (string) Post area to be used for the collection. Required in twine when a collection is requested.\n\"del_post_area\" : (string) Post area to be used for the delivery. Required in twine when a delivery is requested.\n\"hub\" : (string) Depot’s only. Trunking hub - auto assigned if blank.\n\"customer_price\" : (string) Depot’s only. To override the customer price. Please supply 0 if using a Customer login\n\"curn\" : (string) Field can be used in-addition to the Consignment No. When reading consignments via web services, this reference number can be used instead of the Pall-Ex Consignment Barcode’s or numbers.\n\"lq\" : (boolean) Options true or false. Are limited quantity goods included in this consignment?. Default false\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
The following settings are REQUIRED to pass through in the \"courier\" section of the json:
\n\"service_type\": (string) Values : \"1\" => 1 Man, \"2\" => 2 Man, \"3\" => 3 Man\n\nThe following settings are OPTIONAL to pass through in the \"courier\" section of the json:
\n\"extra_services\": (string) Using: \"A\" or \"A,T,W\" etc. Values: \"A\" => Assembly, \"T\" => Trade, \"W\" => Wet installation, \"D\" => Item disposal, \"AM\" => Delivery between 0700 - 1200 (AM), \"PM\" => Delivery between 1200 - 2000 (PM). \"B10\" => Delivery between 0700 - 1000, \"A6\" => Delivery between 1800 - 2000, \"DR\" => Remove door to fit in product, \"PP\" => Plug and play TV, \"DS\" => Swapping of appliance door, \"DV\" => Reverse orientation of applicant door, \"PR\" => Prime service, \"TL\" => Tail Lift, \"TC\" => TV Collect, \"SA\", Sofa Assembly, \"EX\" => Exchange, \"UB\" => Unbox & Tidy, \"TLA\" => Trade Label, \"WD\" => Wet Dis & Install, \"DA\" => Disassembly, \"CA\" => Complex Assembly, \"CDA\" => Complex Disassembly, \"BDA\" => Basic Disassembly, \"IN\" => Install, \"DC\" => Disconnect, \"FS\" => Wet Install + Disconnect + Disposal\n\"delivery_date\": (string) Delivery Date\n\"lead_time\": (number) An alternative to the delivery_date setting, will set deliverydate as this many business days after the date of request\n\"stock_depot\": (string) Used if Panther are stocking this line e.g. Panther Crick\n\"is_return\": (boolean) Set as true for return shipments.\n\"order_type\": (string) Order Type\n\"pre12\": (boolean) Set as true, for services due before 12:00\n\"inco_term\": (string) Terms/IncoTerms code\n\"shipment_mode\": (string) Shipment Mode. Defaults \"Road\"\n\"export_reason\": (string) Reason for export\n\"certifications\": (string) Certifications (e.g. SPS, fumigation, veterinary)\n\"min_book_days\": (number) If no date provided, this setting controls the first available day that auto-booking can offer e.g. today + 8 days\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
The following settings are REQUIRED to pass through in the \"courier\" section of the json:
\n\"service_code\": (string) for example, \"B\"\n\"service_surcharge\": (string) for example, \"B\"\n\nThe following settings are OPTIONAL to pass through in the \"courier\" section of the json:
\n\"service_type\": (string) Defaults to \"delivery\", other options are \"collection\" and \"thirdparty\"\n\"collection_service_type\": (string) Defaults to \"Collection\", only if collection_service_code is specified\n\"collection_service_code\": (string) Service Code for Collection service type\n\"collection_service_surcharge\": (string) Surcharge Code for Collection service type\n\"consignment_type\": (string) Defaults to \"D\" => Delivery, other options are \"C\" => Collection and \"3\" => Third party\n\"consignment_number\": (string)\n\"pallet_type\": (string) possible values: \"LP\", \"FP\", \"HP\", \"QP\", \"MQP\" - we calculate automatically if not provided\n\"delivery_date\": (string) must be provided in DateTime format, for example \"2020-12-31T12:00:00\"\n\"pallet\": (string) A code for identifying a specific pallet, Ex: FY8491753\n\"hand_ball\": (boolean) defaults to true\n\"tail_lift\": (boolean) defaults to false\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
The following settings are REQUIRED to pass through in the \"courier\" section of the json:
\n\"service_code\" : Examples: \"SUP\", \"express9\"\nThe following settings are OPTIONAL to pass through in the \"courier\" section of the json:
\n\"saturday_delivery_required\": (boolean) defaults to false\n\"department_id\": (string) defaults to \"1\"\n\"shipment_type\": (string) defaults to \"DELIVERY\"\n\"purpose_of_shipment\": (string) defaults to \"\"\n\"country_of_manufacture\": (string) defaults to \"GB\"\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
You must send service_id and service_provider_id and service_customer_uid, OR send service_preference_list_id, OR send both of service_provider_name and service_name:
\"service_id\": Example \"251\"\n\"service_provider_id\": Example \"10\"\n\"service_customer_uid\": Example \"5351\"\n\"service_preference_list_id\" : Example: \"229\"\n\"service_provider_name\" : Example: \"YODEL\",\n\"service_name\" : Example: \"EXPRESS 24 TR\"\nThe following settings are OPTIONAL to pass through in the \"courier\" section of the json:
\n\"collection_ready_time\" : (string) defaults to \"12:00:00\"\n\"location_close_time\" : (string) defaults to \"16:00:00\"\n\"contents_description\" : (string) defaults to \"General Goods\"\n\"country_of_origin\" : (string) Defaults to \"GB\", only relevant for international order\n\"hs_tariff_number\" : (string) Defaults to \"\", only relevant for international orders\n\"terms_of_trade\" : (string) Defaults to \"DutiesAndTaxesUnpaid\", alternative is \"DutiesAndTaxesPaid\", only relevant for international orders\n\"category_of_item\" : (string) Defaults to \"General Goods\", only relevant for international orders\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
The following settings are REQUIRED to pass through in the \"courier\" section of the json:
\n\"product_code\" : (string) defines which PostNL service to use, example \"2928\"\nThe following settings are OPTIONAL to pass through in the \"courier\" section of the json:
\n\"customer_code\" : (string) overrides the default customer_code set in the auth\n\"barcode_type\" : (string) calculates based on product_code if not supplied, possible values are 3S,LA,UE,RI,S10\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
The following settings are OPTIONAL to pass through in the \"courier\" section of the json:
\n\"logo_url\": (string) url to a logo image, jpg or png (default template only)\n\"title_text\": (string) text to display at the top of the label (default template only)\n\"template_id\": (string) defaults to \"default\"\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
There are no required courier-specifics.
\nThe following settings are OPTIONAL to pass through in the \"courier\" section of the json:
\n\"custom_text\": (string) An optional, short string (255 characters maximum) supplied by the platform/shipper. This string will appear on the shipping label. Uses include identifying the shipment to the end-customer, or including a note for warehouse operations.\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
The following settings are REQUIRED to pass through in the \"courier\" section of the json:
\n\"posting_location\" : (string)\n\"service_level\" : (string)\n\"service_format\" : (string)\n\"service_code\" : (string)\n\nThe following settings are OPTIONAL to pass through in the \"courier\" section of the json:
\n\"safe_place\" : (string) defaults to \"\"\n\"service_enhancement_code\" : (string) defaults to \"\", may be a single code eg \"13\" or a comma-separated list with no spaces, eg \"13,14\"\n\"shipper_dept_code\" : (string) defaults to \"\"\n\"goods_description\" : (string) defaults to \"General Goods\"\n\"terms_of_trade\" : (string) Defaults to \"DAP\". Other values: DDU, DDP, and DAT\n\"item_coo\" : (string) defaults to \"GB\"\n\"qr_code\" : (boolean) defaults to false - use if you wish to generate QR code to generate label at Royal Mail DO.\n\"quoted_landed_cost\" : (number) The total cost quoted to the end customer for delivering the shipment.\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
The following settings are REQUIRED to pass through in the \"courier\" section of the json:
\n\"service_code\" : (string) Example: \"CRL48\"\nThe following settings are OPTIONAL to pass through in the \"courier\" section of the json:
\n\"parcel_identifier\" : (string) Valid values are: \"undefined\", \"letter\", \"largeLetter\", \"smallParcel\", \"mediumParcel\", \"parcel\", \"documents\"\n\"email_notification\" : (boolean) Send email notifications to recipient - Default: false\n\"text_notification\" : (boolean) Send SMS notifications to recipient - Default: false\n\"saturday_delivery_guarantee\" : (boolean) Shipment guarantee of Saturday delivery - Default: false\n\"signature_required\" : (boolean) Obtain signature on delivery - Default: false\n\"is_ddp\" : (boolean) Is the shipment Delivery Duty Paid - Default: false\n\"is_local_collect\" : (boolean) Shipment is collected locally - Default: false\n\"safe_place\" : (string) Defaults to \"\"\n\"department_code\" : (string) Defaults to \"\"\n\"include_returns_label\" : (boolean) Defaults to false\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
The following settings are REQUIRED to pass through in the \"courier\" section of the json:
\n\"posting_location\" : (string)\n\"service_level\" : (string)\n\"service_format\" : (string)\n\"service_code\" : (string)\nThe following settings are OPTIONAL to pass through in the \"courier\" section of the json:
\n\"safe_place\" : (string) defaults to \"\"\n\"service_enhancement_code\" : (string) defaults to \"\"\n\"shipper_dept_code\" : (string) defaults to \"\"\n\"goods_description\" : (string) defaults to \"General Goods\"\n\"item_coo\" : (string) defaults to \"GB\"\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
The following settings are REQUIRED to pass through in the \"courier\" section of the json:
\n\"service\" : (string) Options are \"BOXB\" and \"Boxberry\"\nThe following settings are OPTIONAL to pass through in the \"courier\" section of the json:
\n\"customs_duty\" : (string) defaults to \"DDU\" and other option is \"DDP\"\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
SecuredMail only supports individual shipments: the 'parcels' array must have only 1 element.
\nThere are no required settings for the \"courier\" section
\nThe following settings are OPTIONAL to pass through in the \"courier\" section of the json:
\n\"service_code\" : (string) defaults to null, passed through as CarrierServiceCode\n\"delivery_time\" : (string) eg \"Next Day Before 12\"\n\"product_description\" : (string) defaults to \"Miscellaneous Items\"\n\"ddp\" : (boolean) defaults to false. Indicates the shipper will be paying any applicable duties. Only applicable to international items. \n\"documents_only\" : (boolean) defaults to false\n\"insurance_value\" : (number) defaults to 0\n\"proof_of_delivery\" : (boolean) defaults to false\n\"saturday_delivery\" : (boolean) defaults to false\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
The following settings are REQUIRED to pass through in the \"courier\" section of the json:
\n\"service_code\" : (string) \"1\", \"3\", \"9\", \"13\", \"15\", \"17\" and \"31\" values for Domestic shipments. \"7\", \"19\" and \"77\" values for International shipments.\n\"product_code\" : (string) \"2\", \"18\", \"48\", \"86\" and \"88\" values for Domestic shipments. \"48\", \"70\", \"104\", \"108\", \"114\", \"116\", \"122\" and \"77\" values for International shipments.\n\nThe following settings are OPTIONAL to pass through in the \"courier\" section of the json:
\n\"account_number\" : (string) Account number to payer. Default Account Number is inherited from registered auth if this is not specified.\n\"charges\" : (string) Default \"P\", Shipment charges \"P\" => payed (sender pays the shipment/collection); \"D\" => due (Consignee pays the shipment/collection)\n\"security\" : (boolean) Default false. Flag that activates control book (true / false)\n\"pod\" : (string) Default \"S\". Flag that activates Proof Of Delivery (\"I\" => Inmediato / \"S\" => Seur)\n\"dconsig\" : (boolean) Default false. Flag that activates delivery order to the holder (true / false)\n\"ddid\" : (boolean) Default false. Flag that activates order to deliver to the holder requesting an id (true / false)\n\"dsat\" : (boolean) Default false. Flag that activates delivery on Saturday (true / false)\n\"change\" : (boolean) Default false. Flag that activates order to generate an additional shipment linked for return (true / false)\n\"taric\" : (string) Id code of the products that are exported or imported\n\"adu_outkey\" : (string) Default \"P\". for customs management at origin. \"P\" => payed (sender pays the management); \"D\" => due (Consignee pays the management)\n\"adu_inkey\" : (string) Default \"P\". for customs management at origin. \"P\" => payed (sender pays the management); \"D\" => due (Consignee pays the management)\n\"incoterms\" : (string) Default \"DDP\". \"DAP\" => (Delivered at Place) Taxes and customs expenses at destination are paid by the recipient \"DDP\" => (Delivered Duty Paid) A DDP operation establishes that the seller pays all expenses until leaving the merchandise at the agreed point in the country of destination. The buyer does not perform any process. Import customs charges are borne by the seller\n\"customs_goods_type\" : (string) Default \"C\". \"C\" => Commercial \"N\" => Non-commercial, \"D\" => Documents\n\"declared_value\" : (number) Declared value\n\"insured_value\" : (number) Insured value\n\"cod_value\" : (number) Cod value\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
The following settings are REQUIRED to pass through in the \"courier\" section of the json:
\n\"package_type\" : (string) Possible values: SMALL, MEDIUM, LARGE, XL, XXL\n\nThe following settings are OPTIONAL to pass through in the \"courier\" section of the json:
\n\"has_return\" : (boolean) Defaults to false. Whether the carrier needs to go back to pickup point at the end\n\"time_window_start\" : (string) Defaults to today 9am. Start of the preferred time window for this destination\n\"time_window_end\" : (string) Defaults to today 6pm. End of the preferred time window for this destination\n\"pickup_location_comment\" : (string) Pickup location comment\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
The following settings are REQUIRED to pass through in the \"courier\" section of the json:
\n\"service_type_name\": (string) Service type code\n\nThe following settings are OPTIONAL to pass through in the \"courier\" section of the json:
\n\"third_party_token\": (string) Account Token for third party integration.\n\"ship_from_passport_number\": (string) Sender's passport number if KYC is required.\n\"ship_to_passport_number\": (string) Recipient's passport number if KYC is required.\n\"insurance_value\": (number) Insurance value.\n\"insurance_currency_code\": (string) Insurance currency in ISO 4217 3-Letter code.\n\"shipment_term\": (string) Insurance currency in ISO 4217 3-Letter code.\n\"book_pick_up\": (boolean) Book a pickup. Example: \"True\" or \"False\", Default: \"False\"\n\"cod_amount\": (number) COD value.\n\"cod_currency_code\": (string) COD currency in ISO 4217 3-Letter code.\n\"bag\": (string) Number of bag. Default: 0\n\"notes\": (string) Shipment notes.\n\"origin_loc_code\": (string) Origin location in International Air Transport Association (IATA) code.\n\"bag_number\": (string) Bag reference number in which shipment is placed.\n\"reason_export\": (string) Reason for export.\n\"dest_taxes\": (number) Destination tax value.\n\"security\": (number) Security value.\n\"surcharge\": (number) Surcharge value.\n\"incoterms\": (string) Package incoterms. Options : \"CIF\", \"CFR\", \"FOB\"\n\"clearance_reference\": (string) Import Export Code.\n\"delivery_agent_code\": (string) Delivery Agent Code.\n\"delivery_route_code\": (string) Delivery Route Code.\n\"cpc_code\": (string) CPC Code.\n\"ate_number\": (string) ATE Number.\n\"product_url\": (string) Product URL\n\"duty_value\": (number) Duty Value\n\"duty_currency_code\": (string) Duty Currency Code\n\"total_gst_value\": (number) GST Value\n\"total_gst_currency_code\": (string) Duty Currency Code\n\"freight_cost\": (number) Freight Value\n\"freight_cost_currency_code\": (string) Freight Currency Code\n\"business_type\": (string) Business Type. Options : \"B2C\", \"B2B\", \"C2C\"\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
There are no required settings
\nThe following settings are OPTIONAL to pass through in the \"courier\" section of the json:
\n\"service_code\" : (string) to make a shipment, either this or service_id are required\n\"service_id\" : (string) to make a shipment, either this or service_code are required\n\"shop_id\" : (string) if not provided, uses account default shop. use list_shops to get a list of account shop ids\n\"list_shops\" : (boolean) defaults to false, if true, the response will be a list of shops. Use response to fill in shop_id optional setting\n\"list_all_services\" : (boolean) defaults to false, if true, the response is a list of all services for this account\n\"list_shipment_services\" : (boolean) defaults to false, if true, the response is a list of valid services for the supplied shipment\nNote: \"generate_packing_slip\": true is not supported with this courier.
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 following settings are REQUIRED to pass through in the \"courier\" section of the json:
\n\"service_code\" : (string) service_code as returned from get-services. Example: \"TRCK\", \"EXPRESS\" etc.\n\nThe following settings are OPTIONAL to pass through in the \"courier\" section of the json:
\n\"display_id\" : (string) Field that can be used for an internal reference. Will also generate a 2nd barcode on the label if populated.\n\"pudo_id\" : (string) to make a shipment, either this or service_code are required\n\"customs_duty\" : (string) Defaults to \"DDU\". Possible values: \"DDU\", \"DDP\"\n\"declaration_type\" : (string) Defaults to \"SaleOfGoods\". Possible values: \"SaleOfGoods\", \"Documents\", \"Gift\", \"ReturnedGoods\" and \"CommercialSample\"\n\"shipment_description\" : (string) Description of the contents of this shipment\n\"dangerous_goods\" : (boolean) Accepted values: true, false\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
The following settings are REQUIRED to pass through in the \"courier\" section of the json:
\n\"service_id\" : (string) possible values are \"SLG001\" to \"SLG007\"\n\nThe following settings are OPTIONAL to pass through in the \"courier\" section of the json:
\n\"category\" : (string) Category of the package. Possible values: \"commercial_goods\", \"returned_goods\"\n\"incoterm\" : (string) Trade terms. Possible values: \"DDP\" or \"DDU\". Defaults to \"DDU\".\n\"customer_id_reference\" : (string) Customer id reference, should be unique\n\"display_id\" : (string) Used to display additional text/references on the label\n\"delivery_date\" : (string) Delivery Date.\n\"dangerous_goods\" : (boolean) Default false. Set as true if the goods are dangerous.\n\"pudo_id\" : (string) Destination based service. PUDO ID provided by our PUDO API result. Only required if delivery to a PUDO location. Note: Parcel Point Service must be selected\n\"rgr_number\" : (string) Returned goods relief number\n\"parcel_description\" : (string) Description of the parcel contents\n\"non_delivery_instruction\" : (string) None delivery instructions\n\"pod_signature_required\" : (boolean) Default false. Set as true if POD is needed.\n\"cod_amount\" : (string) Cash on delivery value, total amount to be collected on delivery, check with your account manager before using this service\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
The following settings are REQUIRED to pass through in the \"courier\" section of the json:
\n\"package_type\" : (string) Example: \"small\", allows multiple package types like [\"small\", \"medium\"]\nThe following settings are OPTIONAL to pass through in the \"courier\" section of the json:
\n\"assignment_code\" : (string) Accounting reference number\n\"package_description\" : (string) Description about the package\n\"package_comment\" : (string) Comments about the package\n\"end_customer_time_window_start\" : (boolean) A datetime indicating the start of the delivery window\n\"end_customer_time_window_end\" : (boolean) A datetime indicating the end of the delivery window\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
The following settings are REQUIRED to pass through in the \"courier\" section of the json:
\n\"pallet_type\": (string) Possible values \"QTR\", \"HALF\", \"FULL\", \"HALFOS\", \"FULLOS\", \"OOG\", \"MTB\", \"SOS\", \"OOG3\", \"OOG4\", \"OOG5\", \"OOG6\", \"OOG7\", \"OOG8\", \"OOG9\", \"OOG10\", \"EUQTR\", \"EUHALF\", \"EUFULL\", \"CARTON\"\n\nThe following settings are OPTIONAL to pass through in the \"courier\" section of the json:
\n\"collection_service\": (string) Collection service display name (usually \"ND\" or \"NDTL\"). Defaults \"ND\"\n\"collection_depot_number\": (string) TPN number of collection depot\n\"collection_request\": (boolean) Request depot is different to collection depot (true or false)\n\"delivery_service\": (string) Delivery service display name (e.g. ND). Defaults \"ND\"\n\"delivery_depot_number\": (string) TPN number of delivery depot\n\"depot_reference\": (string) Reference provided by depot\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
The following settings are REQUIRED to pass through in the \"courier\" section of the json:
\n\"service_code\" : Example: \"S\"\nNote: the request will fail if the ship_to or ship_from phone numbers are less than 11 characters long
\nThe following settings are OPTIONAL to pass through in the \"courier\" section of the json:
\n\"collection_instructions\" : (string) defaults to \"\"\n\"goods_description\" : (string) defaults to \"GOODS\"\n\"consolidate_parcels\" : (boolean) defaults to false, if true it requests multiple labels for a single consignment request\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
The following settings are REQUIRED to pass through in the \"courier\" section of the json:
\n\"courier\" : Example: \"AmazonShipping\"\n\"service_id\" : Example: \"Fast Saturday\"\nThe following settings are OPTIONAL to pass through in the \"courier\" section of the json:
\n\"auth_company\" : please contact TVP for further questions about this field\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
There are no REQUIRED settings for TransforceBE.
\nThe following settings are OPTIONAL to pass through in the \"courier\" section of the json:
\n\"handle\" : (string) defaults to \"drop\", can also be \"pickup\", \"retour\" for Return labels\n\"service_time\" : (number) defaults to null\n\"delivery_window_in_days\" : (number) defaults to 1, used to calculate how long after collection the delivery will be scheduled - eg 1 means delivery 1 day after collection, 0 means same day\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
There are no REQUIRED settings for TransGlobal. However, to get a label back you must provide one of service_id or service_name
The following settings are OPTIONAL to pass through in the \"courier\" section of the json:
\n\"get_quote\" : (boolean) defaults to false, response is the service options rather than a label\n\"service_id\" : (string) use this or service_name to specify a service\n\"service_name\" : (string) use this or service_id to specify a service\n\"collection_option_id\" : (number) defaults to 1, other option is 0. set this to 0 to get a label without scheduling a collection\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
There are no REQUIRED settings for TrunkrsNL.
\nThe following settings are OPTIONAL to pass through in the \"courier\" section of the json:
\n\"service\" : (string) defaults to \"SAME_DAY\", other options are \"SAME_DAY_FOOD\", \"SAME_DAY_FROZEN_FOOD\"\n\"time_slot_id\" : (number) If no time slot id provided, they will find the first open time slot\n\"no_neighbour_delivery\" : (boolean) Dont deliver at neighbours (extra costs are involved).\n\"no_signature\" : (boolean) Accept unsigned delivery.\n\"deliver_in_mail_box\" : (boolean) Can be delivered to the mailbox.\n\"max_delivery_attempts\" : (number) Max number of delivery attempts (may not exceed 3). Default \"3\"\n\"max_time_outside_freezer\" : (boolean) Max cummalative time (in hours) the shipment can be outside of the freezer before it needs to be returned. Must be between 10 and 30. Default \"15\".\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
Please note this about Tuffnells: it is expected that you do a create-manifest request at the end of every day. If you do not manifest, Tuffnells will not receive your shipment data.
The following settings are REQUIRED to pass through in the \"courier\" section of the json:
\n\"service\" : Example: \"P1\"\nThe following settings are OPTIONAL to pass through in the \"courier\" section of the json:
\n\"consignment_ref\" : (string) max 9 characters. if not specified, we will choose one for you\n\"surcharge\" : (string) example \"BN\"\n\"package_type\" : (string) defaults to \"CAR\", can also be ROL, DRU, PLT, DP\n\"goods_description\" : (string) defaults to \"GENERAL GOODS\"\n\"taillift_required_collection\" : (boolean) defaults to false\n\"taillift_required_delivery\" : (boolean) defaults to false\n\"leave_unattended\" : (string) defaults to null, other options are \"C/L\", \"NEI\" or \"PHO\"\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
The following settings are REQUIRED to pass through in the \"courier\" section of the json:
\n\"courier_service\" : Example: \"1\"\nThe following settings are OPTIONAL to pass through in the \"courier\" section of the json:
\n\"alt_ref\" : (string) defaults to \"\"\n\"confirmation_of_delivery\": (boolean) defaults to false\n\"exchange_on_delivery\": (boolean) defaults to false\n\"extended_cover_required\": (boolean) defaults to false\n\"extended_cover\": (number) defaults to 0\n\"signature_optional\": (boolean) defaults to true\n\"cod_amount\": (number) defaults to 0\n\"book_in\": (boolean) defaults to false\n\"long_length\": (boolean) defaults to false\n\"shipment_type\": (string) defaults to \"Domestic\", possible values \"Domestic\" \"International\" \"Packet\"\n\"account\": (string) if passed in, overrides registered auth account number\n\"earliest_time\": (datetime string) defaults to TODAY at 11am\n\"latest_time\": (datetime string) defaults to TODAY at 17:30\n\"cutoff\": (string) defaults to \"17:30\", used to push shipment to next day if current time is later than cutoff\n\"closed_for_lunch\": (boolean) defaults to false\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
There are no REQUIRED settings for UPN.
\nThe following settings are OPTIONAL to pass through in the \"courier\" section of the json:
\n\"main_service\" : (string) Default Standard => \"6\", other option is Priority => \"5\"\n\"premium_service\" : (string) Options are No additional service => \"0\", Before 10 => \"1\", AM Delivery => \"2\", Timed => \"7\", Saturday Timed => \"10\", Saturday Before 10 => \"11\", Saturday AM => \"12\"\n\"extra_service\" : (string) Default No extra service => \"0\", other options are Book-In => \"8\", \"Booked\" => \"9\", \"Out of Hours\" => \"13\"\n\"pallet_type\" : (string) Default Full => \"F\", other options are Euro => \"E\", \"Half\" => \"H\", Quarter => \"Q\" Micro => \"M\"\n\"pallet_size\" : (string) Default Normal => \"N\", other options are Oversize => \"O\", Out of Gauge 2 => \"2\", Out of Gauge 3 => \"3\"\n\"consignment_number\" : (string) Consignment number\n\"package_type\" : (string) examples: \"1A\", \"1B\", \"1D\" \n\"tail_lift\" : (string) Default \"0\", Enter \"1\" if tail lift is required.\n\"pwk_mode\" : (string) Default \"0\" (No customers own paperwork) other option is \"1\" (Customers own paperwork will be provided electronically)\n\"short_desc\" : (string) A short description of the goods on the pallet(s).\n\"delivery_date_time\" : (string) This is an optional field and only needs to be completed if the Booked or any of the Timed services are selected. If the Booked service is used, only the date will be used.\n\"goods_value\" : (string) The re-sale value of the goods on the consignment.\n\"mrn\" : (string) This is the Master Reference Number and is returned by HMRC once a customs declaration has been processed. This field should not be required for the majority of consignments.\n\"cmr_ref\" : (string) The CMR Reference for the consignment.\n\"vat_code\" : (string) Possible values: \"S\", \"M\", \"L\", \"Z\"\n\"inco_terms\" : (string) Possible values: \"EXW\", \"FCA\", \"CPT\", \"CIP\", \"DAT\", \"DAP\", \"DDP\", \"FAS\", \"FOB\", \"CFR\", \"CIF\", \"DAF\", \"DDU\", \"DEQ\", \"DES\", \"DUP\", \"XXX\"\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
The following settings are REQUIRED to pass through in the \"courier\" section of the json:
\n\"service_code\" : Example: \"11\"\n\nThe following settings are OPTIONAL to pass through in the \"courier\" section of the json:
\n\"service_description\" : (string) Example: \"Standard\"\n\"signature_required\" : (string) 1 = Delivery Signature, 2 = Delivery Signature Adult Only - Leave blank if signature is not required (default)\n\"saturday_delivery\" : (boolean) Defaults to false\n\"alcoholic_beverages_indicator\" : (boolean) Defaults to false\n\"terms_of_shipment\" : (string) Defaults to \"DDU\", other options include \"DDP\", \"DAF\", etc.\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
The following settings are REQUIRED to pass through in the \"courier\" section of the json:
\n\"service_code\" : Example: \"11\"\n\nThe following settings are OPTIONAL to pass through in the \"courier\" section of the json:
\n\"service_description\" : (string) Example: \"Standard\"\n\"signature_required\" : (string) 1 = Delivery Signature, 2 = Delivery Signature Adult Only - Leave blank if signature is not required (default)\n\"saturday_delivery\" : (boolean) Defaults to false\n\"alcoholic_beverages_indicator\" : (boolean) Defaults to false\n\"terms_of_shipment\" : (string) Defaults to \"DDU\", other options include \"DDP\", \"DAF\", etc.\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
No REQUIRED fields
\nNo OPTIONAL fields
\n","urlObject":{"path":["api","couriers","v1","UrbIt","create-label"],"host":["{{api_url}}"],"query":[],"variable":[]}},"response":[{"id":"82b85a58-f4dd-443a-9cec-193f40d2176a","name":"UrbIt","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\"auth_company\":\t\t\"company\",\r\n \"request_id\": \"piocm5241li2dfj\",\r\n \"format_address_default\" : true,\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 \"collection_date\": \"2019-11-19T09:28:04.760Z\",\r\n \"reference\": \"my custom reference\",\r\n \"delivery_instructions\": \"Leave on the porch\",\r\n \"ship_from\": {\r\n \"name\": \"Sir Foo\",\r\n \"phone\": \"2125551234\",\r\n \"email\": \"foo@foo.com\",\r\n \"company_name\": \"Foo Store\",\r\n \"address_1\": \"255 New town\",\r\n \"address_2\": \"Wow Avenue\",\r\n \"address_3\": \"\",\r\n \"city\": \"Belleville\",\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 },\r\n \"ship_to\": {\r\n \"name\": \"test test\",\r\n \"phone\": \"7377455180\",\r\n \"email\": \"test@test.com\",\r\n \"company_name\": \"Urb-it\",\r\n \"address_1\": \"66 Old Compton St\",\r\n \"address_2\": \"\",\r\n \"address_3\": \"\",\r\n \"city\": \"London\",\r\n \"district\": \"Paris\",\r\n \"county\": \"Paris\",\r\n \"postcode\": \"W1D 4UH\",\r\n \"country_iso\": \"FR\"\r\n },\r\n \"parcels\": [\r\n\t {\r\n\t \"dim_width\": 20,\r\n\t \"dim_height\": 40,\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 \"dim_width\": 20,\r\n\t \"dim_height\": 40,\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 }\r\n}"},"url":"{{api_url}}/api/couriers/v1/UrbIt/create-label"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n\t\"type\":\"PDF\",\n\t\"request_id\":\"1589992569674\",\n\t\"tracking_codes\":[\"15500999004133\"],\n\t\"tracking_urls\":[\"https://tracking.justshoutgfs.com/ConsLink.asp?ConsNumber=15500999004133\"],\n\t\"uri\":\"http://vault.ecloud.co.uk/courierapi/transglobal_label_1519892111_SOExc.pdf?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=HSEOVCX3IWRFNRTAZBR7%2F20200520%2Feu-west-2%2Fs3%2Faws4_request&X-Amz-Date=20200520T163542Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Signature=9f9da417f6faab541810ac592ec1be5c8ddf572e6e7fb77e0ab7c85454c3cd25\",\"key\":\"transglobal_label_1519892111_SOExc.pdf\",\n\t\"dc_request_id\":3949\n}"}],"_postman_id":"307b14c0-5a83-4eed-86ea-c2f5122c25e8"},{"name":"InternationalBridgeUSPS","id":"c5f20128-8a1b-40ad-9514-2600fbdf5c5c","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
The following settings are REQUIRED to pass through in the \"courier\" section of the json:
\n\"mail_class\" : Defaults to Priority. One of Priority, Express, FirstClass, ParcelSelect, ParcelSelectLightweight, LibraryMail, MediaMail, BoundPrintedMatter, FirstClassInternational, PriorityInternational, PriorityExpressInternational.\n\nThe following settings are OPTIONAL to pass through in the \"courier\" section of the json:
\n\"is_return\" : (boolean) Defaults to false. Indicates a return shipment.\n\"shape\" : (string) Defaults to Parcel. One of Parcel, Flat, FlatRateEnvelope, LegalFlatRateEnvelope, PaddedFlatRateEnvelope, SmallFlatRateBox, MediumFlatRateBox, LargeFlatRateBox, RegionalRateBoxA, RegionalRateBoxB. The following shapes are valid only for PMOD: Sack, FullTrayBox, HalfTrayBox, FlatTubBox, ExtendedManagedMail (aka EMMTray)\n\"pricing\" : (string) One of Retail, CommercialBase, CommercialPlus, Custom.\n\"services\" : (string) One of OpenAndDistribute, Fragile, Perishable, LiveAnimal, HazMat, CrematedRemains, Certified, Restricted, Adult, COD, SignatureConfirmation, Insurance, Registered, ReturnReceipt, ReturnReceiptElectronic, ReturnReceiptMerchandise, HoldForPickup.\n\"presort_level\" : (string) Presort level. Required for Library Mail, Media Mail, Parcel Select Destination Entry and Parcel Select Lightweight. One of None, 5-Digit, 3-Digit, SCF, NDC, MixedNDC, DDU, Basic.\n\"entry_facility\" : (string) Required for Parcel Select Destination Entry and Parcel Select Lightweight. One of None, DNDC, DSCF, DDU.\n\"softpack\" : (boolean) Boolean softpack indicator. Applies ONLY to Priority Mail cubic\n\"gde_origin_country_code\" : (string) example: \"GB\"\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
The following settings are REQUIRED to pass through in the \"courier\" section of the json:
\n\"service_preference_list_id\" : Example: \"229\"\nThe following settings are OPTIONAL to pass through in the \"courier\" section of the json:
\n\"collection_ready_time\" : (string) defaults to \"12:00:00\"\n\"location_close_time\" : (string) defaults to \"16:00:00\"\n\"contents_description\" : (string) defaults to \"General Goods\"\n\"country_of_origin\" : (string) Defaults to \"GB\", only relevant for international order\n\"hs_tariff_number\" : (string) Defaults to \"\", only relevant for international orders\n\"terms_of_trade\" : (string) Defaults to \"DutiesAndTaxesUnpaid\", alternative is \"DutiesAndTaxesPaid\", only relevant for international orders\n\"category_of_item\" : (string) Defaults to \"General Goods\", only relevant for international orders\n\"collection_address_type\" : (string) Defaults to \"Business\"\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
The following settings are REQUIRED to pass through in the \"courier\" section of the json:
\n\"service_code\" : \"ST\": standard for the product / at home, \"LS\": in a selected branch, \"OR\": in the reference branch of the addressee, \"CP\": CityPaq\n\"product_code\" : Shipping product code. Example: \"S0132\"\n\nThe following settings are OPTIONAL to pass through in the \"courier\" section of the json:
\n\"payment_status\" : (string) \"FP\": Postage paid, \"FM\": Machine franking, \"ES\": Cash, \"ON\": Online payment. Defaults to \"FP\"\n\"shipment_type\" : (boolean) Mandatory for international shipments. Type of shipment:- \"1\": Documents, - \"2\": Goods (default), - \"3\": Gifts, - \"4\": Commercial Samples, - \"5\": Returned Goods, - \"6\": Other, - \"7\": Dangerous goods\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
The following settings are REQUIRED to pass through in the \"courier\" section of the json:
\n\"tariff_code\" : Example: \"HDN\", this is specific to your account\nThe following settings are OPTIONAL to pass through in the \"courier\" section of the json:
\n\"contents_description\" : (string) defaults to \"GENERAL GOODS\"\n\"best_service\" : (string) defaults to \"0\"\n\"collection_time\" : (string) defaults to \"16:00:00\"\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
The following settings are REQUIRED to pass through in the \"courier\" section of the json:
\n\"service_code\" : (string) Example: \"2VN\"\nThe following settings are OPTIONAL to pass through in the \"courier\" section of the json:
\n\"export_reason\" : (string) defaults to \"Sales\", alternatives are \"Gift\", \"Sample\", \"Personal\"\n\"leave_safe\" : (string) \"Front Porch\",\"Back Porch\",\"Shed\",\"Garage\",\"Greenhouse\",\"Outbuilding\",\"Conservatory\",\"Neighbour\"\nIn addition, with YodelLink you have the capacity to specify a return_address - you may do this either in the courier section of the json, or as a sibling in the json to the ship_from and ship_to addresses, in the same format.
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 following settings are REQUIRED to pass through in the \"courier\" section of the json:
\n\"service_code\" : (string) Shipping Method Code, example: \"EUWTR\"\nThe following settings are OPTIONAL to pass through in the \"courier\" section of the json:
\n\"order_number\" : (string) Customer order number\n\"application_type\" : (number) Declaration type, used to print CN22, 1: Gift, 2: Sample, 3: Documents, 4: Others\n\"return_option\" : (number) Whether to return, whether the package is returned when no one signs, 1: return, 0: not returned\n\"tariff_prepay\" : (number) Tariff prepaid service fee, 1: participation in tariff prepayment, 0: no participation in tariff prepayment, default 0\n\"insurance_option\" : (number) Parcel type of insurance, 0: non-insurance, 1: piece, 2: proportion, default 0\n\"coverage\" : (number) The maximum amount of insurance, with RMB as the unit\n\"sensitive_type_id\" : (number) The type of special goods in the package - inquire with the courier for details\n