TABLE OF CONTENTS
Create a label
Carrier Labels are created by using the POST labels method.
Parameters
Parameter | Mandatory | Type | Example | Description |
|---|---|---|---|---|
order_id | Yes | string | '123456000001' | The ID of related existing order |
| format | No | string | choice ('pdf', 'zpl', 'zpl300') | 'pdf' | The expected label format |
Yes | JSON | { "name": "dhl", "country": "DE" } | Selected carrier/country to ship the parcel. | |
recipient_first_name | Yes | string | 'David' | Customer’s first name |
recipient_last_name | Yes | string | 'Hasselhoff' | Customer’s last name |
recipient_email | Yes | string | 'mail@example.com' | Customer's email address |
recipient_street | Yes | string | 'Schwedter Str.' | Customer’s street. Do not use line breaks |
| recipient_house_no | No | string | '36A' | Separate field for house number of customer sending address. |
recipient_zip | Yes | string | '10435' | Customer’s ZIP code |
recipient_city | Yes | string | 'Berlin' | Customer’s city |
recipient_country | Yes | string | 'DE' | Customer’s country in ISO2 format |
recipient_phone | No | string | phone | '+49000000000' | Customer’s phone number |
recipient_company_name | No | string | 'Seven Senders' | Customer’s company name |
recipient_address_details | ||||
sender_first_name | No | string | 'Peter' | Sender’s first name |
sender_last_name | No | string | 'Lustig' | Sender’s last name |
sender_company_name | No | string | 'ABC GmbH' | Sender’s company |
sender_street | No | string | 'Keplerstr.' | Sender’s street |
sender_house_no | No | string | '47B' | Sender’s house number |
sender_zip | No | string | '68165' | Sender’s ZIP code |
sender_city | No | string | 'Mannheim' | Sender’s city |
| sender_country | No | string | "DE" | Sender's country in ISO2 format. |
sender_phone | No | string | phone | '+49000000000' | Sender' phone number
|
| sender_email | No | string | email | 'p.lustig@abcd.de' | Sender's email address |
return_parcel | No | string | choice (outbound, return, both)
| 'outbound' | The field shows whether a return label or a combination is requested |
weight | Yes | float | 1.12 | Shipment weight in kg (including packaging) |
| reference_number | No | string | 'Order Reference 1234' | Reference information as shown on the outbound label |
| carrier_service | Yes | string | 'standard' | field to indicate carrier services. Please set it to 'standard' if not other option advised by Seven Senders |
| cod | Yes | boolean | false | The indicator of cash on delivery payment to be collected via this shipment |
| cod_value | No | float | 13.65 | COD value to be collected by carrier on parcel delivery. In case field 'cod' is set to true, this field must be filled with a value >0 |
| cod_currency | No | string | 'EUR' | The currency in which COD value has to be collected |
| collection_point_name1 | No | string | ||
| collection_point_name2 | No | string | ||
collection_point_name3 | No | string | ||
collection_point_membership_id | No | string | ||
collection_point_street | No | string | ||
collection_point_house_ no | No | string | ||
collection_point_country | No | string | ||
collection_point_zip | No | string | ||
collection_point_city | No | string | ||
dimensions | No | JSON | { "height": 50, "length": 40, "width": 30 } | Parcel dimensions in cm |
carrier_service_id | No* | string | This field is required for some carriers, like Royal Mail | |
service_parameters | No | JSON | { "destination": "string", "speed": "string", "service_group": "string", "enhancements": ["string"] } | |
pudo_id | No | string | '1000001' | The ID of a PUDO point selected by customer |
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.
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 case of delivery to PUDO (pick up - drop off) point, the pudo_id field should contain the ID of a PUDO point selected by the customer. Otherwise, the system will choose the nearest PUDO point.
Download a label
Once a label was requested, you can download it using GET label-download method with label ID as parameter received after the label creation. The method with return a file in PDF or ZPL format.