Parameter

Mandatory

Type

Example

Description

order_id 

Yes

String

'order123456'

The order reference inside your system.

Alternatively, you can provide us an unique Id 

carrier:

carrier: {name: 'dhl', country: 'DE'}

carrier.name

Yes

String

'Seven Senders'

carrier_name refers to carrier used for creating the respective label. A list of supported combinations of carrier_name and carrier_country is provided in table below.

carrier.country

Yes

String

'DE'

Please always provide here the country of the injection hub. 

Use ISO 3166-1 alpha-2

recipient_first_name 

Yes

String

'David'

Customer’s first name

recipient_last_name 

Yes

String

'Hasselhoff'

Customer’s last name

recipient_email 

Yes

String

'[email protected]'

Email address to send notifications to your customer. Will be provided to carrier if filled.

Without this information, no mail notification can be send. 

recipient_street

Yes

String

'Schwedter Str.'

Customer’s street. Do not use line breaks. 

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. Use ISO 3166-1 alpha-2

recipient_phone 

No (see Description)

phone:

Use + for the country code (see example)

'+4915224565981'

Customer’s phone number. 

In general this field is not mandatory. For some carrier services this might be relevant. Will be clarified during implementation.

recipient_company_name 

No

String

'Seven Senders'

Customer’s company name if he/she choose to be delivered at his/her company. 

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. Use ISO 3166-1 alpha-2 

sender_phone 

No

phone:

Use + for the country code (see example)

'+4917621253654'

Sender's phone number 

sender_email 

No

Email

'[email protected]'

Sender’s email address

return_parcel 

No

string

'outbound'

Indicates if return label is requested. Supported values:

'outbound' --> only the outbound lablel is provided

'return' --> only the return label is provided

'both' --> outbound and matching return label are provided. Response will contain array in this case

weight 

Yes

float

1.12

Shipment weight in kg (including packaging)