TABLE OF CONTENTS
Create a label
Carrier Labels are created by using the POST labels method.
Parameters
[1] When creating a stand-alone return label, the recipient parameters need to be filled in with the sender of the return shipment, since 7S will automatically switch the address at the point of label creation.
Format
The format of the result label file. Supported values are: 'pdf', 'zpl', 'zpl300'. The 'zpl' option returns a 203 DPI ZPL, while 'zpl300' returns a 300 DPI ZPL file. The recommended format is zpl.
Order ID
The order should be created via API before generating a label.
Order Object
With this order object, an order containing all order information can be created during the label creation process. When we perform request validation we will check:
- If order_id is defined and valid, we will accept this value and accept the request. Else,
- If order_id is not defined, then we will check if the order_id is defined under the order object and has valid fields. If yes accept the request and take the value from here, else
- If none of them are defined or invalid we will throw a validation exception as it is today.
Carrier
The carrier parameter contains a pair of carrier name and country. These values are predefined. You can receive them via GET carrier API request. Learn more here: Available Carriers
Recipient Email
This field is required for last-mile carriers and also to enable the Notifications and Claims service.
Recipient Phone
Typically, this field is not mandatory. Depending on the selected carrier services, this might be relevant.
Sender Address
Senders address fields are not mandatory, by default this data is stored in the configuration on Seven Senders side.
Return Parcel
The field may contain one of the following options:
- 'outbound' - to generate an outbound label.
- 'return' - to generate a return label only.
- 'both' - both outbound and matching return labels are generated. The response will contain an array in this case.
Cash on delivery (COD)
If set to true, fields cod_value (amount) and cod_currency (currency code) fields become mandatory.
Pickup/Drop-off Point (PUDO)
In the case of delivery to a PUDO (pick up - drop off) point, it depends on the carrier whether the full collection point addresses + pudo_id or just the PUDO ID needs to be provided.
For certain carriers, we have to possibility to automatically select the nearest PUDO point based on the provided address parameters. For more information, please refer to the table below:
Carrier | Required PUDO parameters | ||
Full collection point address required | PUDO ID required | PUDO "auto-select" available | |
Post Nord | NO | YES | YES |
Bring | YES | YES | NO |
Mondial Relay | NO | YES | YES |
Royal Mail | YES | NO | NO |
Inpost | NO | YES | NO |
SEUR | NO | YES | YES |
Post NL | NO | YES | YES |
BRT | NO | YES | NO |
Dangerous Goods Labels
When using Dangeorus Goods Services, certain carriers require supplementary details regarding the SKUs and the nature of the dangerous goods. In these instances, the following parameters must be provided.
Parameter | Mandatory | Type | Example | Description |
---|---|---|---|---|
parcel | yes | object | ||
parcel.description | no | string | 'B2C Parcel' | description of the parcel |
parcel.skus | yes | array with object | ||
parcel.skus. arrival_country_description | yes | string | 'silicone case for mobile phone' | SKU description |
parcel.skus.qty | yes | number | 3 | quantity of SKUs in the parcel |
parcel.skus. total_net_weight | C | float | 3.4 | total net weight of all SKUS in the parcel |
parcel.skus.total_gross_weight | C | float | ||
parcel.skus.dangerous_goods | yes | array with object | ||
skus.dangerous_goods. un_number | yes | string | '2037' | UN Numbers standartize the identification of dangerous goods |
skus.dangerous_goods. technical_name | depends on the carrier | string | 'liquid silicone polymer' | When a UN number like "UN1993, Flammable liquid, n.o.s." is used, the technical name (e.g., "Toluene and Benzene mixture") |
skus.dangerous_goods. hazard_class | depends on the carrier | string | '2.2' | Hazard Class determines the primary risk associated with the substance |
skus.dangerous_goods. additional_hazard_id | depends on the carrier | string | 'B4' | Subsidiary hazards are often indicated by subsidiary risk labels and can influence handling, stowage, and emergency response procedures. |
skus.dangerous_goods. packing_group | depends on the carrier | string | 'III' | The Packing Group determines the type and performance level of packaging required for safe transport. |
skus.dangerous_goods. packing_instruction_code | depends on the carrier | string | 'P1965_ SECTION _IA' | Packing Instructions specify authorized packaging types (e.g., drums, boxes, IBCs) and any additional packaging requirements based on the UN Number and Packing Group. |
skus.dangerous_goods. flash_point | depends on the carrier | string | '-20' | Flash point is a key property for classifying flammable liquids and determining appropriate handling, storage, and transport precautions. |
skus.dangerous_goods. tunnel_code | no | string | '(E)' | This code (e.g., B/D, C, E) must be considered by drivers and shippers to ensure they do not enter tunnels where the transport of their specific dangerous goods is prohibited. |
skus.dangerous_goods. liqiud_volume | depends on the carrier | object | ||
skus.dangerous_goods. liqiud_volume.unit | depends on the carrier | string | 'FL_OZ' | The unit of the quantity of a liquid dangerous good being transported. Liters (L) or milliliters (mL). |
skus.dangerous_goods. liqiud_volume.value | depends on the carrier | float | 3.0 | The quantity of a liquid dangerous good being transported, typically measured in liters (L) or |
If a label is required for a DG shipment, these parameters (depending on the carrier) must be transferred to the Seven Senders API. These parameters are added to the parameters described above.
Download a label
Once a label was requested, you can download it using GET label-download method with label ID as a parameter received after the label creation. The method with return a file in PDF or ZPL format.
Delete label
In case a label is no longer needed you can use the Delete Label request with a label ID as parameter. This method will delete the label and automatically delete the shipment behind the label.
Zalando SLA calculation via Analytics
To visualise Zalando SLAs via Analytics, the delivery country for the order must be included in the order tags. To achieve this, please use the order tag outlined in the 'Create a Label' section and enter the relevant order data as follows:
"order_tags": { "7S_destination:": "pl" }, |
The tag name is always '7S_Destination' and the value should be the ISO 2 country code.
Tag name | Example | Description |
---|---|---|
7S_destination | 'pl' | ISO2 Country Code of the order destination |
The complete order tag would look like this - example:
{ "order_id": "1234567", "order_url": "https://www.example.com", "order_date": "2022-07-14T08:36:53.353Z", "boarding_complete": true, "language": "en", "order_tags": { "7S_destination": "pl", "tag2": "value2" }, "promised_delivery_date": "2022-07-14T08:47:48.787Z" } |