Support Portal

Welcome
Login

3. Create and download label (Standard Bundle)

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

order Yes*JSON

{

"order_id": "1234567",

"order_url": "https://www.example.com",

"order_date": "2022-07-14T08:36:53.353Z",

"boarding_complete": true,

"language": "en",

"order_tags": {

  "tag1": "value1",

  "tag2": "value2"

},

"promised_delivery_date": "2022-07-14T08:47:48.787Z"

}

With this order object, an order containing all order information can be created during the label creation process.

Please note: 

"promised_delivery_date" is mandatory if "local_delivery" parameter is true.


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 [1]

recipient_last_name 

Yes

string

'Hasselhoff'

Customer’s last name [1]

recipient_email 

Yes

string

'mail@example.com'

Customer's email address [1]

recipient_street

Yes

string

'Schwedter Str.'

Customer’s street. Do not use line breaks [1]

recipient_house_noNostring'36A'A separate field for house number of customer sending address [1]

recipient_zip 

Yes

string

'10435'

Customer’s ZIP code [1]

recipient_city 

Yes

string

'Berlin'

Customer’s city [1]

recipient_country 

Yes

string

'DE'

Customer’s country in ISO2 format [1]

recipient_phone 

No

string | phone

'+49000000000'

Customer’s phone number [1]

recipient_company_name 

No

string

'Seven Senders'

Customer’s company name[1]

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_numberNostring'Order Reference 1234'Reference information as 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. 
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.
 

If true, "promised_delivery_date" parameter for the order must be provided.

goods_valueNoNumber10.5The shipment value. Accepting numbers with 2 decimals. 
goods_value_currencyNoStringEURThe currency of the shipment value. Accepting 3 letter currency codes. 
warehouseNostring | 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. 
warehouse_addressNostring"Kochhannstr 38. 10247 Berlin"Warehouse full address. Do not use line breaks. 
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
cod_referenceNostring'12345'Reference for shipments which are delivered with service cash on delivery.
collection_point_name1Nostring

collection_point_name2Nostring

collection_point_name3

Nostring

collection_point_membership_id

Nostring

collection_point_street

Nostring

collection_point_house_ no

Nostring

collection_point_country

Nostring

collection_point_zip

Nostring

collection_point_city

Nostring

dimensions

NoJSON{
"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

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

pudo_id

Nostring'1000001'The ID of a PUDO point selected by customer
shipment_tagNoJSON{ "tag1": "value2", "tag2": "value2" }Tags/Properties to allow you to segment your shipments. 

[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. You can provide either order_id or order object. 

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 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) 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.


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.



TABLE OF CONTENTS


Did you find it helpful? Yes No