3.3. ORDERS
3.3
Orders
These resources are used to retrieve and manipulate orders in the shop. Orders are currently mostly read-only. Some order parameters may be changed to update the state of the order among a few other things. The order resources support the synchronization procedure described in section 2.8.
3.3.1
Order Collection
URI: Actions: Content-Type: GET Parameters:
/_ _API_ _/order Retrieve(GET) text/xml synced, changed_at_or_after, changed_after, mark_as_synced, view, order_state
Query parameters
Name changed_at_or_after changed_after synced mark_as_synced view
Values datetime datetime yes,no yes,no short,long
order_state
Description As defined in section 2.8.1. As defined in section 2.8.1. As defined in section 2.8.2. As defined in section 2.8.2. If specified as “long” then a complete “Order” object is sent for each order. Only list orders having the specified state. Order states are described below.
Object description
The collection provides a list of abbreviated Order objects: Name OrderNo ErpOrderNo
Type str str
Mode read read
Customer
str
read
32
Description The order number. The order number in the shop owners ERP system, if such a system is used. Is not used in the shop but may be used to link orders in the shop to orders in the ERP. A reference to the customer that has made this order. The “href” attribute references the customer object itself. The element contains the customer number (CustomerNo) for the customer as an extra aid.
—