14.A Order Object Definition
14.A.1 Overview
The Order object.
uuid
Data type: uuid
Required: n/a.
Order id.
fulfilment_partner_identifier
Data type: integer
Required: n/a.
For future usage.
external_identifier
Data type: string
Required: n/a.
This identifier can contain the id from the external integration provider
order_date
Data type: timestamp
Required: n/a.
The order date.
language
Data type: string
Required: n/a.
For future usage.
account_id
Data type: integer
Required: n/a.
The account id.
shop_id
Data type: integer
Required: n/a.
The shop id.
type
Data type: string
Required: n/a.
For future usage.
price
Data type: integer
Required: n/a.
The total price of the order.
vat
Data type: integer
Required: n/a.
The total vat price of the order.
price_after_vat
Data type: integer
Required: n/a.
The total price including vat of the order.
status
Data type: order_status
Required: n/a.
The status of the order.
invoice_address
Data type: Address
Required: n/a.
The invoice address of the order.
shipment
Data type: Shipment
Required: yes.
The shipment information for the order.
order_lines
Datatype: array of Order lines
Required: yes.
The order lines of the order.
order_shipments
Data type: Order Shipment
Required: yes.
The actual shipments for the order.
14.A.2 Examples
POST Order
{
"data": {
"orders": [
{
"fulfilment_partner_identifier": null,
"external_identifier": "blab44la",
"order_date": "2021-05-18 10:00:00",
"invoice_address": null,
"language": "NL",
"account_id": 1,
"shop_id": 1,
"type": "consumer",
"price": 24,
"vat": 33,
"price_after_vat": 2345,
"shipment": {
"recipient": {
"cc": "NL",
"street": "Antareslaan",
"person": "F Bakker",
"city": "Hoofddorp",
"postal_code": "2132 JE",
"number": "31"
},
"pickup": null,
"options": {
"large_format": 1,
"package_type": 1
},
"physical_properties": {
"weight": 1000,
"height": 50,
"width": 60,
"length": 70
},
"customs_declaration": null,
"carrier": 1
},
"order_lines": [
{
"quantity": 10,
"price": 22,
"vat": 11,
"price_after_vat": 33,
"product": {
"sku": "1",
"name": "xx"
},
"instructions": null,
"shippable": true
},
{
"quantity": 10,
"price": 22,
"vat": 11,
"price_after_vat": 33,
"product": {
"sku": "2245",
"name": "te22st"
},
"instructions": null,
"shippable": true
}
]
}
]
}
}
GET Orders
{
"data": {
"orders": [
{
"uuid": "1105e2d0-4e80-4465-8c17-d942b7eda3ba",
"fulfilment_partner_identifier": null,
"external_identifier": "9S7x1sUTRsvHFfIm",
"order_date": "2022-01-14 00:00:00",
"invoice_address": {
"city": "Hoofddorp",
"postal_code": "2132 JE",
"number": "31"
},
"language": "NL",
"account_id": 1,
"shop_id": 1,
"type": "consumer",
"price": 100,
"vat": 10,
"price_after_vat": 110,
"status": "partially_processed",
"shipment": {
"recipient": {
"city": "Hoofddorp",
"postal_code": "2132 JE",
"number": "31"
},
"pickup": null,
"drop_off_point": null,
"options": {
"large_format": 1,
"package_type": 1
},
"physical_properties": null,
"customs_declaration": null,
"carrier": 1
},
"order_lines": [
{
"uuid": "ad6e791e-ccc1-40b4-a2e2-69365e01c880",
"quantity": 1,
"price": 150,
"vat": 30,
"price_after_vat": 180,
"product": {
"sku": "1234abcd",
"name": "My Product"
},
"instructions": {
"wrapping_instructions": "beautiful"
},
"shippable": true
},
{
"uuid": "25eff7fa-589b-43f0-afed-0c4c4e5954de",
"quantity": 10,
"price": 150,
"vat": 30,
"price_after_vat": 180,
"product": {
"ean": "5555",
"external_identifier": "9999abcd",
"name": "New Product"
},
"instructions": {
"wrapping_instructions": "beautiful"
},
"shippable": true
}
],
"order_shipments": [
{
"uuid": "28d2cd97-1686-4400-bba4-91f337bdfd13",
"external_shipment_identifier": "3SMYPA123456",
"shipment_id": 1,
"shipment": [],
"shipped_items": [
{
"quantity": 1,
"order_line_identifier": "ad6e791e-ccc1-40b4-a2e2-69365e01c880"
}
]
},
{
"uuid": "fcb4d0b7-ce88-4c5b-a5a8-9294b7e02a84",
"external_shipment_identifier": "3SMYPA12345",
"shipment_id": 2,
"shipment": [],
"shipped_items": []
}
],
"created_at": "2022-01-14 16:15:56",
"updated_at": "2022-01-14 16:15:56"
},
{
"uuid": "59a285d7-7321-4d2e-b4b1-7f5dd5869609",
"fulfilment_partner_identifier": null,
"external_identifier": "blab44la",
"order_date": "2021-05-18 10:00:00",
"invoice_address": null,
"language": "NL",
"account_id": 1,
"shop_id": 1,
"type": "consumer",
"price": 24,
"vat": 33,
"price_after_vat": 2345,
"status": "open",
"shipment": {
"recipient": {
"cc": "NL",
"street": "Antareslaan",
"person": "F Bakker",
"city": "Hoofddorp",
"postal_code": "2132 JE",
"number": "31"
},
"pickup": null,
"drop_off_point": null,
"options": {
"large_format": 1,
"package_type": 1
},
"physical_properties": {
"weight": 1000,
"height": 50,
"width": 60,
"length": 70
},
"customs_declaration": null,
"carrier": 1
},
"order_lines": [
{
"uuid": "7b6a852b-a508-4676-864a-8816cbbbbe2e",
"quantity": 10,
"price": 22,
"vat": 11,
"price_after_vat": 33,
"product": {
"sku": "1",
"name": "xx"
},
"instructions": null,
"shippable": true
},
{
"uuid": "3613a39f-c516-4aa1-9a4b-63c465077662",
"quantity": 10,
"price": 22,
"vat": 11,
"price_after_vat": 33,
"product": {
"sku": "2245",
"name": "te22st"
},
"instructions": null,
"shippable": true
}
],
"order_shipments": [],
"created_at": "2022-01-20 14:22:47",
"updated_at": "2022-01-20 14:22:48"
}
],
"page": 1,
"size": 10,
"results": 2
}
}
GET Order
{
"data": {
"orders": [
{
"uuid": "59a285d7-7321-4d2e-b4b1-7f5dd5869609",
"fulfilment_partner_identifier": null,
"external_identifier": "blab44la",
"order_date": "2021-05-18 10:00:00",
"invoice_address": null,
"language": "NL",
"account_id": 1,
"shop_id": 1,
"type": "consumer",
"price": 24,
"vat": 33,
"price_after_vat": 2345,
"status": "open",
"shipment": {
"recipient": {
"cc": "NL",
"street": "Antareslaan",
"person": "F Bakker",
"city": "Hoofddorp",
"postal_code": "2132 JE",
"number": "31"
},
"pickup": null,
"drop_off_point": null,
"options": {
"large_format": 1,
"package_type": 1
},
"physical_properties": {
"weight": 1000,
"height": 50,
"width": 60,
"length": 70
},
"customs_declaration": null,
"carrier": 1
},
"order_lines": [
{
"uuid": "7b6a852b-a508-4676-864a-8816cbbbbe2e",
"quantity": 10,
"price": 22,
"vat": 11,
"price_after_vat": 33,
"product": {
"sku": "1",
"name": "xx"
},
"instructions": null,
"shippable": true
},
{
"uuid": "3613a39f-c516-4aa1-9a4b-63c465077662",
"quantity": 10,
"price": 22,
"vat": 11,
"price_after_vat": 33,
"product": {
"sku": "2245",
"name": "te22st"
},
"instructions": null,
"shippable": true
}
],
"order_shipments": [],
"created_at": "2022-01-20 14:22:47",
"updated_at": "2022-01-20 14:22:48"
}
]
}
}
PUT Order
{
"data": {
"orders": [
{
"uuid": "59a285d7-7321-4d2e-b4b1-7f5dd5869609",
"fulfilment_partner_identifier": null,
"external_identifier": "blab44la",
"order_date": "2021-05-18 10:00:00",
"invoice_address": null,
"language": "NL",
"account_id": 1,
"shop_id": 1,
"type": "consumer",
"price": 24,
"vat": 33,
"price_after_vat": 2345,
"shipment": {
"recipient": {
"cc": "NL",
"street": "Antareslaan",
"person": "F Bakker",
"city": "Hoofddorp",
"postal_code": "2132 JE",
"number": "31"
},
"pickup": null,
"drop_off_point": null,
"options": {
"large_format": 1,
"package_type": 1
},
"physical_properties": {
"weight": 1000,
"height": 50,
"width": 60,
"length": 70
},
"customs_declaration": null,
"carrier": 1
},
"order_lines": [
{
"uuid": "7b6a852b-a508-4676-864a-8816cbbbbe2e",
"quantity": 10,
"price": 22,
"vat": 11,
"price_after_vat": 33,
"product": {
"sku": "1",
"name": "xx"
},
"instructions": null,
"shippable": true
},
{
"uuid": "3613a39f-c516-4aa1-9a4b-63c465077662",
"quantity": 10,
"price": 22,
"vat": 11,
"price_after_vat": 33,
"product": {
"sku": "2245",
"name": "te22st"
},
"instructions": null,
"shippable": true
}
]
}
]
}
}
order_shipments
14.B Order line Object Definition
14.B.1 Overview
The Order line object.
uuid
Data type: uuid
Required: n/a.
Order line id.
quantity
Data type: integer
Required: yes.
Quantity of products in the order line.
price
Data type: integer
Required: n/a.
The total price of the order line.
vat
Data type: integer
Required: n/a.
The total vat price of the order line.
price_after_vat
Data type: integer
Required: n/a.
The total price including vat of the order line.
instructions
Data type: string
Required: n/a.
For future usage.
shippable
Data type: boolean
Required: n/a.
Indication of the order line can be shipped. I.e. in case of a digital product this is false.
product
Data type: Product
Required: yes
The product of the order line.
14.C Product Object Definition
14.C.1 Overview
The Product object.
sku
Data type: string
Required: n/a.
The stock keeping unit of the product.
ean
Data type: string
Required: n/a.
The European Article Number of the product.
external_identifier
Data type: string
Required: n/a.
The id of the product from the external integration.
name
Data type: string
Required: yes.
The name of the product.
description
Data type: string
Required: n/a.
The description of the product.
width
Data type: integer
Required: n/a.
The width of the product.
length
Data type: integer
Required: n/a.
The length of the product.
weight
Data type: integer
Required: n/a.
The weight of the product.
account_id
Data type: integer
Required: n/a.
The account id for which the product is created.
shop_id
Data type: integer
Required: n/a.
The shop id for which the product is created.
created
Data type: timestamp
Required: n/a.
Date of creation.
updated
Data type: timestamp
Required: n/a.
Date of modification.
14.D Order Shipment Definition
14.D.1 Overview
uuid
Data type: uuid
Required: n/a.
The id of the order shipment.
external_shipment_identifier
Data type: string
Required: n/a.
The reference to the shipment for the order shipment. Usually the barcode of the shipment.
shipment_id
Data type: integer
Required: n/a.
The id of the shipment for the order shipment.
shipment
Data type: Shipment
Required: n/a.
The actual shipment for the order shipment.
shipped_items
Data type: array of Shipped Items
14.E Shipment Items Definition
14.E.1 Overview
quantity
Data type: integer
Required: n/a.
The quantity of items in the order shipment.
order_line_identifier
Data type: uuid
Required: n/a.
Reference to the order line in the order shipment.