Support Portal

Welcome
Login

1.3. Create and download label

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

formatNostring | choice ('pdf', 'zpl', 'zpl300')'pdf'The expected label format

carrier

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_noNostring'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_countryNostring"DE"Sender's country in ISO2 format.

sender_phone
No

string | phone

'+49000000000'Sender' phone number

 

sender_emailNostring | 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_numberYesstring'Order Reference 1234'Unique reference number per parcel (shown on the outbound label)
reference_number_2Nostring"ref654321"The second reference number that can represent additional shipment or order data from your system. Can be both unique or not.
reference_number2Nostring
Please leave it empty, as it will be overwritten by data from "reference_number_2". 
local_deliveryNobooleanfalseIndicates whether the package is for the special same day or next day delivery service operated by Seven Senders. Please contact us in case you would like to start using it. 
goods_valueNonumber10.5The shipment value. Accepting numbers with 2 decimals. 
goods_value_currencyNostringEURThe currency of the shipment value. Accepting 3 letter currency codes.
warehouseNo
string | choice List of all warehouses defined inside your account"warehouse1"
The warehouse name defined inside your account. Important: The provided warehouse name needs to be identical to the one(s) defined in your Seven Senders portal account. 
warhouse_addressNo
string"Kochhannstr.38 10247 Berlin"Warehouse full address. Do not use line breaks. 
shipment_tagNoJSON{ "tag1": "value1", "tag2": "value2" }Tags/Properties to allow you to segment your shiop
carrier_serviceYesstring'standard'field to indicate carrier services. Please set it to 'standard' if not other option advised by Seven Senders
codYesbooleanfalseThe indicator of cash on delivery payment to be collected via this shipment
cod_valueNofloat13.65COD 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    Nostring'EUR'The currency in which COD value has to be collected
collection_point_name1NostringRoyal MailAddress parameter to specify the naming of a specific carrier "PickUpPoint" location    
collection_point_name2NostringPost Office LtdAddress parameter to specify the naming of a specific carrier "PickUpPoint" location    

collection_point_name3

NostringSheffield South Delivery OfficeAddress parameter to specify the naming of a specific carrier "PickUpPoint" location    

collection_point_membership_id

Nostring12345678Carrier specific parameter (e.g. DHL DE)

collection_point_street

NostringWoodseats Rd

Address parameter to specify "PickUpPoint" street

collection_point_house_ no

Nostring61Address parameter to specify "PickUpPoint" house number (can also be provided in collection_point_street)

collection_point_country

NostringGBAddress parameter to specify "PickUpPoint" country

collection_point_zip

Nostring
S80 PG
Address parameter to specify "PickUpPoint" zip code

collection_point_city

Nostring
Sheffield
Address parameter to specify "PickUpPoint" city

dimensions

NoJSON{
"height": 50,
"length": 40,
"width": 30
}
Parcel dimensions in cm

carrier_service_id

No*stringUUIDThis parameter is only required for specific carriers:
  • If the carrier in scope only supports one delivery service, then the "carrier_service_id": needs to be sent with null, since we have configured a default
  • If the carrier in scope supports N delivery services, then the required service needs to be specified by providing the "carrier_service_id" (will be provided by our integration team)

service_parameters

NoJSON{
"destination": "string", "speed": "string", "service_group": "string", "enhancements": ["string"]
}

This parameter is currently not in use, please provide as null


pudo_id

Nostring'1000001'The ID of a PUDO point selected by the 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 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 (if not "auto-select")
YES
Bring
YES
YES
NO
Mondial Relay
NO
YES (if not "auto-select")
YES
Royal Mail 
YES
NO
NO
Inpost
NO
YES
NO



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.





Did you find it helpful? Yes No