Support Portal

Welcome
Login

1.1. Create order

TABLE OF CONTENTS

The Order resource represents a shop order and contains only necessary data for tracking and delivery. It includes your internal order ID, the date-time, and the website of its creation.

Please use POST orders method to create a new order.

Parameters

Parameter

Mandatory

Type

Example

Description

order_id

Yes

string

"123456000"

The order reference inside your system, the unique identifier

order_url

Recommended

string

"https://www.example.com"

The full URL of the website where the order was submitted. It should contain "https://" . Needs to be exactly identical with the URL used for services Notifications & Tracking Pages to work properly.

order_date

Yes

datetime

"

2023-08-08T05:41:14+00:00 OR 
2023-08-08T05:41:14Z

"

The date/time when the order was created inside your system. We accept timezone in UTC with Z or time offset (The time zone offset is always +00:00 or Z). If you don't provide us timestamp, then we'll take Default value:  current timestamp

boarding_complete

No

boolean

[true or false]

false

The flag indicating that all shipments of the order got created.

language

Recommended

string

"en"

The language that a customer has used to submit the order. We recommend you provide this value so that the customer could receive a notification or open a tracking page in his preferred language (Premium or Professional Service Bundle).

order_tags 

No

JSON

{"tag1": "value1", "tag2": "value2"}

Tags/Properties to allow you to segment your orders

promised_delivery_date

Recommended

datetime

"

2023-08-11T08:00:00+00:00

"


The delivery date/time you’ve promised the customer

Please note: 

"promised_delivery_date" is mandatory if "local_delivery" parameter is true.

Order URL

The order URL field points to the website where the order has been created. Together with the language, this data is used in Notifications and Tracking pages and also Analytics.

Order Date

The timestamp of the order creation, is used in tracking events.

Boarding complete

If you have multiple shipments in the order, create the order with boarding_complete = false first. After all the shipments got created via API, please execute PUT orders command with boarding_complete: true to complete the order.


Language

ISO Code

Czech
cs
Danish
da
Dutch
nl
English
en
Finish
fi
French
fr
German
de
Hungarian
hu
Italianit
Polish
pl
Portuguese
pt
Romanian
ro
Solvak
sk
Spanish
es
Swedish
sv
Norwegian
no


Promised delivery date

The promised_delivery_date field is essential information being used as input to calculate various KPI within Seven Senders Analytics. Therefore, we highly advise you to provide this information with acceptable accuracy.

Other Order Operations


Note: the order_id field is used as a unique identifier to get, update or delete an order.



 


Did you find it helpful? Yes No