Support Portal

Delivery Service (Minimum Requirement)

This section deals with the minimum requirements for connecting to Seven Senders API when using our Delivery Service.

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.

In General - Workflows

The minimum information to be provided when using the Seven Senders Delivery service is data related to the single shipment. Therefore, only the POST/shipment operation needs to be applied (see the next section). 

Create a Shipment

Shipments are created by using the POST operation of the 'shipment' endpoint (POST/shipment). 

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

tracking_code 

Yes

String

"tracking123456789"

The shipment tracking number given by the carrier.


Mandatory! 

reference_number 

No

String

"ref123456"

The reference_number represents your internal reference for this shipment inside your IT system.

carrier:

carrier: {carrier_name: “dhl”, carrier_country: “DE”}

carrier.carrier_name

Yes

choice:

See the list of choice below


"dhl"


Selected carrier to ship the parcel.


carrier.carrier_country

Yes

choice:

See the list of choice below


“DE”

Country where the parcel is handed over to selected carrier / scanned for the first time by the selected carrier.


carrier_service 

No

choice:

"standard"

"express"

"other"

"express"


Service / Product / Tariff used by the carrier

recipient_first_name 

Yes

String

“David”

Customer’s first name

recipient_last_name 

Yes

String

“Hasselhoff”

Customer’s last name

recipient_email 

Yes

Email

"d.hasselhoff@sevensenders.com"


Customer’s email address Send email notifications to you customer through Sendwise

Without this information, no mail notification can be send. 


In case you’re only using our delivery product, you can provide a “default” email-address (e.g. cs@yourcompany.de)

recipient_address 

Yes

String

"Schwedter str. 36A"


Customer’s address. Do not use line breaks. 


If a DHL “Packstation” has been chosen, please state “Packstation” and number (e.g “Packstation 123”)

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

phone:

Use + for the country code (see example)

"+4915224565981"


Customer’s phone number. 

recipient_company_name 

No

String

“Seven Senders”

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


return_parcel 

No

boolean

[true or false]

“false”


Indicates whether the shipment is a return from the customer

pickup_point_selected 

No

boolean

[true or false]

“false”

Is the customer address a pickup point (i.e postal shop, retail shop etc) ?

weight 

Yes

number

1.12

Shipment weight in KG (including packaging)

planned_pickup_datetime 

Yes

date:

yyyy-mm-ddThh:mm:ss+nnnn


"2017-08-19T15:47:00+0000"


Date and time agreed with Seven Senders to pick-up the shipment at your warehouse.

comment 

No

String

“Please be careful”

Comment regarding this shipment left by the customer or for your internal usage

warehouse_address 

Yes

String

"Kochhannstr. 38 10247 Berlin"


Warehouse full address. Do not use line breaks.

warehouse 

Yes

Choice:

List of all warehouse

defined inside your account


"warehouse"


This value is static per warehouse you ship from and will be provided by Seven Senders during implementation. 

shipment_tag 

No

object


{"sku":"nikeAir2017"}


Tags/Properties to allow you to segment your shipments

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.

Country
Carrier
ATpostat, dpd, ups, dhl
BEbpost, dpd, kiala, mondialrelay, ups, dhl
CHswisspost, dpd, ups, dhl
CZceskaposta, dpd, ups
DEdhl, deutschepost, gls, ups, hermes, dpd, tnt
DKpostnord, ups, dhl, dpd
EScorreos, seur,seur_international,asm, mrw, ups, dhl
FIposti, postnord, ups, dhl, dpd
FRcolissimo, chronopost, tnt, dpd, mondialrelay, colisprive, gls, dhl, ups
GBroyalmail, yodel, parcelforce, hermes, dpd, dhl
ITbrt, tnt, gls, ups, dhl, nexive, posteitaliane, SDA posteitaliane
LUdhl, ups, kiala, dpd
NLpostnl, kiala, dpd, mondialrelay, tnt, ups, dhl
NOpostnord, ups, dhl, dpd
PLdpd, gls, ups, dhl, poczta polska
SEpostnord, ups, dhl
SKceskaposta, dpd, ups, dhl

Definition of carrier and carrier_country in case of cross border shipments

Defining the carrier and carrier_country in case of cross border shipments depends on the “set-up”. There are three scenarios (see picture below).

1. Scenario: Using the Seven Senders Delivery (direct injection) service

The carrier and carrier_country provided should be the carrier which is in charge for the 'last mile'.

  • Shipping from: Germany (given it is the warehouse location) 
  • Shipping to: France
  • Carrier: Seven Senders and Colissimo

In this example the carrier is 'Colissimo' and the carrier_country 'fr'.

2. Scenario: Shipping with Carriers (own contracts)

The carrier and carrier_country should be defined as the one you’re handing the parcel to in the first place.

  • Shipping from: Germany (given it is the warehouse location)
  • Shipping to: France
  • Carrier: DHL DE and DHL FR

In this scenario, the carrier is 'DHL' and the carrier_country 'de'.

3. Scenario: Shipping with Carriers (own contracts) + self-organized Direct Injection

The carrier and carrier_country is the one that is in charge for the 'last mile'.

  • Shipping from: Germany (given it is the warehouse location)

  • Shipping to: France

  • Carrier: Freight Forwarding Company XYZ and DHL FR

In this scenario, the carrier is 'DHL' and the carrier_country 'fr'.