Demand API
Method: POST
Resource: /api/v1/order/enqueue
Identification
To create or update a product, add the API access key and Entity ID outside the payload part of the JSON.
access_key (required)
Generate an API Access key at System > Users. Be sure the user has enough rights to create a product.
entity_id (required)
After creating an entity, the Entity ID is visible at System > Settings.
Payload
reference (required)
Source order reference. Must be unique.
source_id (required)
Source id. If orders are send from multiple sources this is the identifier to split webhook calls. As an example you could add a code like webshop1, amazon, ebay,
status
0 - New
1 - Process
8 - Hold
9 - Cancel
type (required)
0 - normal order
1 - POS order
flag_partial
0 - ship complete
1 - ship any allocated stock
2 - ship any allocated stock once and switch back to complete after first shipment
priority
If not added, an order will receive priority: 0. A higher number will process an order with higher priority. Can also be a negative number to lower the priority. This way you could give priority to orders based on a shipping method, region, customer, etc.
cod_amount
Used for webhook filters to be sure the order is send with a COD shipping method and no partial shipment is possible.
currency (required)
For example USD, EUR, GBP
delivery_at
Process order at this date
created_at
order creation date.
Format: Y-m-d H:i:s (2020-04-22 13:34:28)
customer_id
Source customer id. Used to allocate from future stock reservation.
options
The order options part is used to add specific orderdata for features like consignment and POS processing. Also used to forward customer specific data to webhooks.
shipping_
required: firstname, lastname, street, housenumber, postcode, city, country
not required: company, housenumber_ext, region, phone, email, method
Available for update untill the order changed to state shipped.
billing_
firstname, lastname, street, housenumber, postcode, city, country, company, housenumber_ext, region, phone, email
Available for update untill the order changed to state shipped.
items
sku
if the product SKU does not exists, it will be auto created.
description
product description
weight
product weight
reference
order item source reference
unit_price
netto unit price, can be used for webhook forwarding to reporting
qty
total item quantity to deliver
custom options (optional)
order item custom options to trigger production
allocation_type (optional)
1: reservation
2: direct
3:kit
cost (optional)
if allocation type is set to direct it's possible to overrule the supplier product price with the cost
packing additional labels
if the order contains additional labels, a print button will be available on the packing page to print the labels.