Support Portal

Welcome
Login

1. Create order (Standard Bundle)

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://"

order_date

Yes

datetime

"2017-08-15T11:03:15.275Z"

The date/time when the order was created inside your system. 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.

order_tags 

No

JSON

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

Tags/Properties to allow you to segment your orders

promised_delivery_date

Recommended

datetime

"2017-08-15T16:53:07+01:00"

The delivery date/time you’ve promised the customer.

Order URL

The order_url field points to the website where the order has been created. 

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

bg; cs; da; de; el; en; es; et; fi; fr; ga; hr; hu; it; lt; lv; mt; pl; pt; ro; ru; sk; sl; sv; uk


Promised delivery date

The promised_delivery_date field is essential information being used as input to control carrier performance.


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