Support Portal

Welcome
Login
  1. Solution home
  2. Shop Integration [phasing-out]
  3. API Version 2.0

Shipments/:id

This endpoint allow you to manage a given shipment inside your Seven Senders account.

Endpoint

https://api.sevensenders.com/v2/docs.html#/Shipment/getShipmentItem

https://api.sevensenders.com/v2/docs.html#/Shipment/putShipmentItem

https://api.sevensenders.com/v2/docs.html#/Shipment/deleteShipmentItem

Headers

Parameter
Mandatory
Description
API-KEY
YES
Your authorization key to access Seven Senders API

Methods

DELETE

Status codes

Status
Description
204
No content. Successfully deleted
401
Unauthorized
404
Not found

Request

Curl example

curl -X "DELETE" -H "Accept:\ application/json" -H "Content-type:\ application/x-www-form-urlencoded" -H "API-KEY:\ <API-KEY>" http://api.sevensenders.com/v2/shipments/123456789.json

Response

Curl example

204 success
status: 204
date: Wed, 31 Aug 2017 08:24:53 GMT
cache-control: no-cache, private
server: nginx

GET

Request

Curl example

curl -X "GET" -H "Accept:\ application/json" -H "Content-type:\ application/x-www-form-urlencoded" -H "API-KEY:\ <API-KEY>" http://api.sevensenders.com/v2/shipments/123456789.json

Response

Field
Type
Example
Description
shop_order_id
string
"order123456"
The order reference inside your system
carrier_service
string
"standard"
The service level provided by the carrier
warehouse_address
string
"Kochhannstrasse 38 10249 Berlin"
Your warehouse address
id
number
987654321
The shipment id inside Seven Senders system
tracking_code
string
"trackingNumber123"
The tracking number given by the carrier for the shipment
customer_first_name
string
"David"
Customer first name
customer_last_name
string
"Hasselhoff"
Customer last name
customer_name
string
"David Hasselhoff"
Fusion of the customer first and last name
customer_email
email address
"david.hasselhoff@sevensenders.com"
Customer email address
customer_address
string
"Schwedter Str. 36 A"
Customer address
customer_address_zip_code
string
"10435"
Customer ZIP code
customer_address_city
string
"Berlin"
Customer city
customer_phone
string
"+4917680102975"
Customer phone number
return_parcel
boolean
false
Is this shipment a return or not ?
pickup_point_selected
boolean
false
Is the customer address a pick point address ?
weight
number
1.12
Shipment weight in kg
planned_pickup_datetime
date:
dd.mm.yyyy hh:mm:ss
"2017-08-19T15:47:00+0000"
The date and time when the carrier is supposed to pick up the shipment at your warehouse
comment
string
"There are many children out there that wish to meet me."
Customer comment regarding the shipment delivery
carrier
object
Carrier object
1
2
3
4
5
6
7
"carrier": {  
    "name": "dhl",  
    "country": {   
         "name": "Germany",    
        "iso2": "de"  
    }
}
Information regarding the carrier responsible for delivering the shipment
carrier.name
string
"dhl"
Carrier name
carrier.country
object
Country object
1
2
3
4
"country": {  
    "name": "Germany",  "
    iso2": "de"
}
Carrier country information
carrier.country.name
string
"Germany"
Country name
carrier.country.iso2
string
"de"
Country ISO 2 code
customer_address_country
object
Customer address country object
1
2
3
4
"country": {  
    "name": "Germany",  
    "iso2": "de"
}
Country information for the customer address
customer_address_country.name
string
"Germany"
Country name
customer_address_country.iso2
string
"de"
Country ISO 2 code
warehouse
object
Warehouse object
1
2
3
4
5
6
7
"warehouse": {  
    "name": "warehouse",  
    "country": {    
        "name": "Germany",    
        "iso2": "de"  
    }
}
Warehouse information that handled the shipment
warehouse.name
string
"warehouse"
Warehouse name
warehouse.country
object
Country object
1
2
3
4
"country": {  
    "name": "Germany",  
    "iso2": "de"
}
Warehouse country information
warehouse.country.name
string
"Germany"
Country name
warehouse.country.iso2
string
"de"
Country ISO 2 code
shipment_tag
array of tag object
See tag object
List of all tags for the shipment
reference_number
string
"referenceNumber123456"
Reference number for the shipment. This information is used when the carrier doesn't provide a tracking number at the beginning (like BRT carrier in Italy).
It is normally your internal reference for this shipment inside your IT system.
customer_company
string
"Seven Senders"
Customer company name for the delivery
shipment_status_history
array of status object
See status object
List of all past status of the shipment

Status object

Field
Type
Example
Description
name
string
"Delivered"
Status name
location
string
"Kochhannstrasse 38 10249 Berlin"
Where did the shipment status changed
date_time
date:
dd.mm.yyyy hh:mm:ss
"2017-08-16T09:01:00+0000"
Date and time when the shipment status changed

Tag object

Field
Type
Example
Description
name
string
"tag1"
Tag name
content
string
"VIP"
Tag content

Response

Response to a GET shipments/:id call

{
  "shop_order_id": "4",
  "carrier_service": "standard",
  "warehouse_address": "Kochhannstrasse 38 10249 Berlin",
  "id": 4799704,
  "tracking_code": "4",
  "customer_first_name": "David",
  "customer_last_name": "Hasselhoff",
  "customer_name": "David Hasselhoff",
  "customer_email": "d.hasselhoff@sevensenders.com",
  "customer_address": "Hohensch\u00f6nhauser Str. 22 10369 Berlin",
  "customer_address_zip_code": "10369",
  "customer_address_city": null,
  "customer_phone": "+4917680102975",
  "return_parcel": false,
  "pickup_point_selected": false,
  "weight": 1.12,
  "planned_pickup_datetime": "2017-09-10T15:47:00+0000",
  "comment": "Please be careful!",
  "carrier":
  {
    "name": "dhl",
    "country":
    {
      "name": "Germany",
      "iso2": "de"
    }
  },
  "customer_address_country":
  {
    "name": "Germany",
    "iso2": "de"
  },
  "warehouse":
  {
    "name": "warehouse",
    "country":
    {
      "name": "Germany",
      "iso2": "de"
    }
  },
  "shipment_tag": [],
  "reference_number": null,
  "customer_company": null,
  "shipment_status_history": []
}

PATCH

Parameters

Field
Mandatory
Type
Example
Description
shop_order_id
NO
string
"order123456"
The order reference inside your system
carrier_service
NO
choice:
"standard"
"express"
"other"
"standard"
The service level provided by the carrier
warehouse_address
NO
string
"Kochhannstrasse 38 10249 Berlin"
Your warehouse address
id
NO
number
987654321
The shipment id inside Seven Senders system
tracking_code
NO
string
"trackingNumber123"
The tracking number given by the carrier for the shipment
customer_first_name
NO
string
"David"
Customer first name
customer_last_name
NO
string
"Hasselhoff"
Customer last name
customer_name
NO
string
"David Hasselhoff"
Fusion of the customer first and last name
customer_email
NO
email address
"david.hasselhoff@sevensenders.com"
Customer email address
customer_address
NO
string
"Schwedter Str. 36 A"
Customer address
customer_company
NO
string
"Seven Senders"
Customer company name for the delivery
customer_address_zip_code
NO
string
"10435"
Customer ZIP code
customer_address_city
NO
string
"Berlin"
Customer city
customer_phone
NO
string
"+4917680102975"
Customer phone number
return_parcel
NO
boolean
false
Is this shipment a return or not ?
pickup_point_selected
NO
boolean
false
Is the customer address a pick point address ?
weight
NO
number
1.12
Shipment weight in kg
planned_pickup_datetime
NO
date:
dd.mm.yyyy hh:mm:ss
"2017-08-19T15:47:00+0000"
The date and time when the carrier is supposed to pick up the shipment at your warehouse
comment
NO
string
"There are many children out there that wish to meet me."
Customer comment regarding the shipment delivery
carrier
NO
string
"dhl"
Carrier name
carrier_country
NO
string
"de"
Carrier country
customer_address_country
NO
string
"Germany"
Customer address country
warehouse
NO
string
"warehouse"
Warehouse name
reference_number
NO
string
"referenceNumber123456"
Reference number for the shipment. This information is used when the carrier doesn't provide a tracking number at the beginning (like BRT carrier in Italy).
It is normally your internal reference for this shipment inside your IT system.

Carriers by country available

Country
Carriers
at
postat, dpd, ups, dhl
be
bpost, dpd, kiala, mondialrelay, ups, dhl
ch
swisspost, dpd, ups, dhl
cz
ceskaposta, dpd, ups
de
dhl, deutschepost, gls, ups, hermes, dpd, tnt
dk
postnord, ups, dhl, dpd
es
correos, seur, asm, mrw, ups, dhl
fi
posti, postnord, ups, dhl, dpd
fr
colissimo, chronopost, tnt, dpd, mondialrelay, colisprive, gls, dhl, ups
gb
royalmail, yodel, parcelforce, hermes, dpd, dhl
it
brt, tnt, gls, ups, dhl
lu
dhl, ups, kiala, dpd
nl
postnl, kiala, dpd, mondialrelay, tnt, ups, dhl
no
postnord, ups, dhl, dpd
pl
dpd, gls, ups, dhl
se
postnord, ups, dhl
sk
ceskaposta, dpd, ups, dhl

Request

Curl example

curl -X "PATCH" -d "shop_order_id=123456789&boarding_complete=1" -H "Accept:\ application/json" -H "Content-type:\ application/x-www-form-urlencoded" -H "API-KEY:\ <API-KEY>" http://api.sevensenders.com/v2/shipments/123456789.json

Response

Curl example

204 success
status: 204
date: Wed, 31 Aug 2017 08:24:53 GMT
cache-control: no-cache, private
server: nginx


Did you find it helpful? Yes No