Support Portal

Creating a Carrier Label

Content

API Key Authorization

The credentials for the API consist of a access-key, a string provided by Seven Senders. Before starting using the API, you need to request a JWT token by applying the POST/token operation containing your access-key. The JWT token should then be used inside the 'Authorization' header for every further request. Format: Authorization: Bearer YOUR_TOKEN.

Workflow

  1. Create a label via post/label endpoint
  2. Response contains
    • Tracking number
    • URL to label file
    • carrier

Remarks

If you request outbound and return label in same request, response contains array with all information

Create a Label

Carrier Labels are created by using the POST operation of the 'label' endpoint (Post/labels).

Parameters

Parameters

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

'd.hasselhoff@sevensenders.com'

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_house_nonoString'36A'Seperate 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. 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

'p.lustig@abcb.de'

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)        

reference_number
no
string
'Order Reference 1234'
Reference information as shown on the outbound label
is_express
no
Boolean
'false'
field for upcoming additional services. Currently not in use
carrier_serviceyesString'standard'field to indicate carrier services. Please set it to 'standard' if not other option advised by Seven Senders
codyesBoolean'false'
indicates, if COD payment shall be collected via this shipment. If set to 'true' fields 'cod_value' and 'cod_currency' become mandatory
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'
currency in which COD value has to be collected

Remarks

If Sender information can be transferred to the label depends on the single implementation.

Usually its already fixed with label implementation. We'll approach you in case these fields need to be filled.

Available Carriers

The table below contains the currently available carriers (subject to change). All currently available carrier are applicable by applying the GET/carriers operation.

In case you're missing a carrier/country combination please approach us.

Country
Carrier
ATpostat, dpd
BEbpost, dpd, mondialrelay
CHswisspost, dpd
DEdhl, dgls, hermes, dpd
DKpostnord
ESceleritas, seur
FIpostnord
FRcolissimo, dpd, mondialrelay, gls
GBroyalmail, hermes
ITbrt
LUdhl, dpd
NLpostnl
NOpostnord
PLdpd
SEpostnord