Support Portal

Welcome
Login

Orders

This endpoint allow you to manage you orders inside your Seven Senders account.

Endpoint

https://api.sevensenders.com/v2/docs.html#/Order/postOrderCollection

Headers

Parameter
Mandatory

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

Methods

DELETE

Filters

Parameter
Mandatory
Type
Default Value
Description
filters[language]NO
string-
What is the language of the customer for this order or the language for the shop_order_url defined
filters[shop_order_date_from]YES
date: dd.mm.yyyy hh:mm:ss-
Date range when the order was created inside your system (inclusive)
filters[shop_order_date_to]YES
date: dd.mm.yyyy hh:mm:ss-
Date range when the order was created inside your system (inclusive)
filters[shop_order_url]NO
string-
From which website the order come from

Status codes

Status codeDescription
204No content. Successfully deleted
400Bad Request. Verify your parameters
401Unauthorized
404Not found

Request

Curl example

curl -X "DELETE" -d "shop_order_date_from=2017-08-10T05:45:00+0000&shop_order_date_to=2017-09-10T05:45:00+0000" -H "Accept:\ application/json" -H "Content-type:\ application/x-www-form-urlencoded" -H "API-KEY:\ <API-KEY>" http://api.sevensenders.com/v2/orders.json

Response

Response headers

204 success
status: 204
date: Wed, 30 Aug 2017 07:31:43 GMT
cache-control: no-cache, private
server: nginx

GET

Filters

Parameter
Mandatory
Type
Default Value
Description
limitNO
number20
How many orders to return
offsetNO
number-
Offset from which to start listing orders
order_byNO
array of fields-
Order by fields
shop_order_idNO
string-
The order reference inside your system
idNO
number-
Order id inside Seven Senders system
shop_order_dateNO
date: dd.mm.yyyy hh:mm:ss-
Date when the order was created inside your system

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/orders.json?limit=20

Response

The API will respond with an array of orders, each element inside the array has the following properties

Field
Type
Example
Description
idnumber123456789Order id inside Seven Senders system
shop_order_idstring"order123456"The order reference inside your system
shop_order_urlurl"https://www.7s.com"From which website the order come from
shop_order_datedate: dd.mm.yyyy hh:mm:ss"2017-08-10T05:45:00+0000"Date when the order was created inside your system
boarding_completebooleantrueAre all shipments for the order been imported inside your Seven Senders account ?
shipmentsarray of shipment objectSee shipment object
List of all shipments linked to the order
states_historyarray of state objectSee state object
List of all past state of the order
statestring"completed"The current state of the order
languagestring"en"What is the language of the customer for this order or the language for the shop_order_url defined
order_tagsarray of tag objectSee tag object
List of tags that add more context to the order
promised_delivery_datedate: dd.mm.yyyy hh:mm:ss"2017-08-19T05:45:00+0000"At which date did you promise the customer to deliver his/her order
tracking_page_urlurl"https://hasselhoff.tracking.7senders.com/#/order/order123456"Deprecated - Tracking Page url where the customer can see his/her order/shipment

Order object

Field
Type
Example
Description
idnumber123456789Order id inside Seven Senders system
shop_order_idstring"order123456"The order reference inside your system
shop_order_urlurl"https://www.7s.com"From which website the order come from
shop_order_datedate: dd.mm.yyyy hh:mm:ss"2017-08-10T05:45:00+0000"Date when the order was created inside your system
minimum_numbers_of_shipmentsnumber1The expected number of shipments for this order
boarding_completebooleanfalseAre all shipments for the order been imported inside your Seven Senders account ?
shipmentsarray of shipment objectSee shipment object
List of all shipments linked to the order
states_historyarray of state objectSee state object
List of all past state of the order
order_tagsarray of tag objectSee tag object
List of all tags for the order
promised_delivery_datedate: dd.mm.yyyy hh:mm:ss"2017-08-19T05:45:00+0000"At which date did you promise the customer to deliver his/her order
languagestring"de"What is the language of the customer for this order or the language for the shop_order_url defined
daysFromStatusChangednumber3Number of days from the last status change

Shipment object

Field
Type
Example
Description
shop_order_idstring"order123456"The order reference inside your system
carrier_servicestring"standard"The service level provided by the carrier
warehouse_addressstring"Kochhannstrasse 38 10249 Berlin"Your warehouse address
idnumber987654321The shipment id inside Seven Senders system
tracking_codestring"trackingNumber123"The tracking number given by the carrier for the shipment
customer_first_namestring"David"Customer first name
customer_last_namestring"Hasselhoff"Customer last name
customer_namestring"David Hasselhoff"Fusion of the customer first and last name
customer_emailemail address"david.hasselhoff@sevensenders.com"Customer email address
customer_addressstring"Schwedter Str. 36 A"Customer address
customer_address_zip_codestring"10435"Customer ZIP code
customer_address_citystring"Berlin"Customer city
customer_phonestring"+4917680102975"Customer phone number
return_parcelbooleanfalseIs this shipment a return or not ?
pickup_point_selectedbooleanfalseIs the customer address a pick point address ?
weightnumber1.12Shipment weight in kg
planned_pickup_datetimedate: 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
commentstring"There are many children out there that wish to meet me."Customer comment regarding the shipment delivery
carrierobjectCarrier object
Information regarding the carrier responsible for delivering the shipment
carrier.namestring"dhl"Carrier name
carrier.countryobjectCountry object
Carrier country information
carrier.country.namestring"Germany"Country name
carrier.country.iso2string"de"Country ISO 2 code
customer_address_countryobjectCustomer address country object
Country information for the customer address
customer_address_country.namestring"Germany"Country name
customer_address_country.iso2string"de"Country ISO 2 code
warehouseobjectWarehouse object
Warehouse information that handled the shipment
warehouse.namestring"warehouse"Warehouse name
warehouse.countryobjectCountry object
Warehouse country information
warehouse.country.namestring"Germany"Country name
warehouse.country.iso2string"de"Country ISO 2 code
reference_numberstring"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_companystring"Seven Senders"Customer company name for the delivery
shipment_status_historyarray of status objectSee status object
List of all past status of the shipment

State object

Field
Type
Example
Description
idnumber102030456Id for the state change
orderobjectSee order object
Order information
namestring"shipped"State name
datetimedate: dd.mm.yyyy hh:mm:ss"2017-08-19T15:47:00+0000"Date and time when the order state changed
locationstring"Kochhannstrasse 38 10249 Berlin"Where did the order state changed

Status object

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

Tag object

Field
Type
Example
Description
namestring"tag1"Tag name
contentstring"VIP"Tag content

Response

Response to a GET orders call

[
    {
        "id": 4262108,
        "shop_order_id": "1",
        "shop_order_url": "https://www.7s.com",
        "shop_order_date": "2017-08-10T05:45:00+0000",
        "boarding_complete": true,
        "shipments": [
            {
                "shop_order_id": "1",
                "carrier_service": "standard",
                "warehouse_address": "Kochhannstrasse 38 10249 Berlin",
                "id": 4401379,
                "tracking_code": "trackingCode1",
                "customer_first_name": "David",
                "customer_last_name": "Hasselhoff",
                "customer_name": "David Hasselhoff",
                "customer_email": "david.hasselhoff@sevensenders.com",
                "customer_address": "Hohenschönhauser 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,
                "planned_pickup_datetime": "2017-08-19T15: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": null
                },
                "shipment_tag": [],
                "reference_number": null,
                "customer_company": null,
                "shipment_status_history": [
                    {
                        "date_time": "2017-08-16T09:01:00+0000",
                        "name": "Delivered",
                        "location": ""
                    },
                    {
                        "date_time": "2017-08-19T15:47:00+0000",
                        "name": "Pickup",
                        "location": ""
                    }
                ]
            }
        ],
        "states_history": [
            {
                "id": 10970506,
                "order": null,
                "name": "shipped",
                "datetime": "2017-08-19T15:47:00+0000",
                "location": null
            },
            {
                "id": 10970567,
                "order": null,
                "name": "completed",
                "datetime": "2017-08-16T09:01:00+0000",
                "location": null
            },
            {
                "id": 10970463,
                "order": null,
                "name": "new",
                "datetime": "2017-08-10T05:45:00+0000",
                "location": null
            }
        ],
        "state": "completed",
        "language": "en",
        "order_tags": [
            {
                "name": "tag1",
                "content": "Baywatch"
            }
        ],
        "promised_delivery_date": "2017-08-19T05:45:00+0000",
        "tracking_page_url": "https://jfourna.tracking.7senders.com/#/order/1"
    },
    {
        "id": 4262110,
        "shop_order_id": "2",
        "shop_order_url": "https://www.7s.com",
        "shop_order_date": "2017-08-10T05:45:00+0000",
        "boarding_complete": true,
        "shipments": [
            {
                "shop_order_id": "2",
                "carrier_service": "standard",
                "warehouse_address": "Kochhannstrasse 38 10249 Berlin",
                "id": 4401381,
                "tracking_code": "trackingCode2",
                "customer_first_name": "David",
                "customer_last_name": "Hasselhoff",
                "customer_name": "David Hasselhoff",
                "customer_email": "david.hasselhoff@sevensenders.com",
                "customer_address": "Hohenschönhauser 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,
                "planned_pickup_datetime": "2017-08-19T15: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": null
                },
                "shipment_tag": [],
                "reference_number": null,
                "customer_company": null,
                "shipment_status_history": [
                    {
                        "date_time": "2017-08-16T09:01:00+0000",
                        "name": "Delivered",
                        "location": ""
                    },
                    {
                        "date_time": "2017-08-19T15:47:00+0000",
                        "name": "Pickup",
                        "location": ""
                    }
                ]
            }
        ],
        "states_history": [
            {
                "id": 10970515,
                "order": null,
                "name": "shipped",
                "datetime": "2017-08-19T15:47:00+0000",
                "location": null
            },
            {
                "id": 10970574,
                "order": null,
                "name": "completed",
                "datetime": "2017-08-16T09:01:00+0000",
                "location": null
            },
            {
                "id": 10970474,
                "order": null,
                "name": "new",
                "datetime": "2017-08-10T05:45:00+0000",
                "location": null
            }
        ],
        "state": "completed",
        "language": "de",
        "order_tags": [
            {
                "name": "tag1",
                "content": "Baywatch"
            }
        ],
        "promised_delivery_date": "2017-08-19T05:45:00+0000",
        "tracking_page_url": "https://hasselhoff.tracking.7senders.com/#/order/2"
    },
    {
        "id": 4318018,
        "shop_order_id": "3",
        "shop_order_url": "https://www.7s.com",
        "shop_order_date": "2017-08-10T05:45:00+0000",
        "boarding_complete": false,
        "shipments": [],
        "states_history": [
            {
                "id": 11135091,
                "order": null,
                "name": "new",
                "datetime": "2017-08-10T05:45:00+0000",
                "location": null
            }
        ],
        "state": "new",
        "language": "de",
        "order_tags": [
            {
                "name": "tag1",
                "content": "Baywatch"
            }
        ],
        "promised_delivery_date": "2017-08-19T05:45:00+0000",
        "tracking_page_url": "https://hasselhoff.tracking.7senders.com/#/order/3"
    }
]

POST

Parameters

Parameter
Mandatory
Type
Example
Description
boarding_completeNO
boolean0Are all shipments for the order been imported inside your Seven Senders account ?
languageRECOMMENDED
string
"en"What is the language of the customer for this order or the language for the shop_order_url defined
If you want to send mails/sms notifications to your customer, we recommend that you provide this information on each order
The reason is that a notification can only be send if the shop_order_url and the Language are defined on the order.
order_tagsNO
objectSee tag part
Tags/Properties to allow you to segment your orders
promised_delivery_dateRECOMMENDED
date: dd.mm.yyyy hh:mm:ss"2017-08-15T16:53:07+01:00"At which date did you promise the customer to deliver his/her order
shop_order_dateYES
date: dd.mm.yyyy hh:mm:ss"2017-08-15T16:53:07+01:00"Date when the order was created inside your system
shop_order_idYES
string"order123456"The order reference inside your system
shop_order_urlRECOMMENDED
url"https://www.7s.com"From which website the order come from

Request

Curl example

curl -X "POST" -d "shop_order_id=123456789&shop_order_date=2017-08-15T16:53:07+01:00&order_tags={\"product\":+\"nikeAir\",+\"price\":+100}&shop_order_url=https://www.7s.com&amp;boarding_complete=0&amp;language=en&amp;promised_delivery_date=2017-08-20T16:53:07+01:00" -H "Accept:\ application/json" -H "Content-type:\ application/x-www-form-urlencoded" -H "API-KEY:\ <API-KEY>" http://api.sevensenders.com/v2/orders.json

Response

Response headers

201 success
status: 201
date: Wed, 30 Aug 2017 07:27:25 GMT
cache-control: no-cache, private
server: nginx
location: /v2/orders/4417096
content-type: application/json