HomeAPI Reference14. Order Object Definitions

14. Order Object Definitions

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

GET Orders

GET Order

PUT Order

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.

Edit this page
Last updated: 
Contributors Peter-MyParcel