Order
Was this helpful?
Was this helpful?
Order
Get order by order uid
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to an Order.
^[A-Za-z0-9-_]+Use invoiceAddress only if an order has a different invoice than orderAddress.
Example response
List all orders.
The query parameter orderStatus can not be used in combination with orderOrderState, orderSettleState or orderDeliveryState.
Reference to a Store.
^[A-Za-z0-9-_]+Reference to a tenant.
^[A-Za-z0-9-_]+Reference to an OrderStatus.
Reference to the OrderType.
External reference to a orderUid.
External reference to a voucher id.
Reference to a Customer uid.
^[A-Za-z0-9-_]+Reference to a specific page in a result set.
The number of items per page in a result set.
Defines which field the resource list is sorted by.
| ENUM | Description |
|---|---|
| ASC | Sort in ascending order |
| DESC | Sort in descending order |
Reference to a list of OrderStates.
Reference to an OrderSettleState.
Reference to an OrderDeliveryState.
Reference to a handling uid.
Reference to an HandlingState. Use with orderHandlingUid
Filter by settled at from a specific date
Filter by settled at to a specific date
Filter by created at from a specific date
Filter by created at to a specific date
Reference to a till uid.
^[A-Za-z0-9-_]+Reference to a tenantUserUid.
Example response
Get order details. This will return a complete order object.
Reference to a Store.
^[A-Za-z0-9-_]+Reference to an Order.
^[A-Za-z0-9-_]+Reference to a tenant.
^[A-Za-z0-9-_]+Use invoiceAddress only if an order has a different invoice than orderAddress.
Example response
Delete an order.
Reference to a Store.
^[A-Za-z0-9-_]+Reference to an Order.
^[A-Za-z0-9-_]+Reference to a tenant.
^[A-Za-z0-9-_]+No Content
No Content
Get available payment methods for an order
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a Store.
^[A-Za-z0-9-_]+Reference to an Order.
^[A-Za-z0-9-_]+Example response
Delete an item on an order.
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a Store.
^[A-Za-z0-9-_]+Reference to an Order.
^[A-Za-z0-9-_]+Reference to an order item on an order.
^[A-Za-z0-9-_]+Use invoiceAddress only if an order has a different invoice than orderAddress.
Example response
List addons for order item
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a Store.
^[A-Za-z0-9-_]+Reference to an Order.
^[A-Za-z0-9-_]+Reference to an order item on an order.
^[A-Za-z0-9-_]+Reference to a productLinkType.
Example response
List additional notes, or comments, on orders.
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a Store.
^[A-Za-z0-9-_]+Reference to an Order.
^[A-Za-z0-9-_]+Reference to a specific page in a result set.
The number of items per page in a result set.
Defines which field the resource list is sorted by.
| ENUM | Description |
|---|---|
| ASC | Sort in ascending order |
| DESC | Sort in descending order |
Example response
Delete order additional notes
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a Store.
^[A-Za-z0-9-_]+Reference to an Order.
^[A-Za-z0-9-_]+Reference to an orderAdditionalNote
^[A-Za-z0-9-_]+No Content
No Content
Create a new order.
Reference to a Store.
^[A-Za-z0-9-_]+Reference to a tenant.
^[A-Za-z0-9-_]+Use invoiceAddress only if an order has a different invoice than orderAddress.
Example response
Import new order from extern source. Complete order with lines and possibly settlements. sellerDisplayName can be set if an integrationToken is used. If no integrationToken and sellerDisplayName is set, an error is returned.
Reference to a Store.
^[A-Za-z0-9-_]+Reference to a tenant.
^[A-Za-z0-9-_]+Schema for creating a complete order in one request.
^[A-Za-z0-9-_]*^[A-Za-z0-9-_]*Create a new settlement from external source
| ENUM | Description |
|---|---|
| SUM | Print as a part of orderlines. |
| SEPARATE | Print as a separate field. |
^[A-Za-z0-9-_]+Use invoiceAddress only if an order has a different invoice than orderAddress.
Example response
The field orderStatuses can not be used in combination with orderStates, settleStates or deliveryStates.
Reference to a Store.
^[A-Za-z0-9-_]+Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a specific page in a result set.
The number of items per page in a result set.
Defines which field the resource list is sorted by.
| ENUM | Description |
|---|---|
| ASC | Sort in ascending order |
| DESC | Sort in descending order |
Search for orders.
Only one of the keys in the search object will be used in a search.
If more than one key is supplied the keys will be used in the priorty of how they appear in the object. Example: query will be used first if it is supplied, if it is not supplied the customer key will be used, and so on.
An empty string will be ignored, and handeled as if the key did not exist in the payload.
Fuzzy search means that it will try to find words that contains the query string that is supplied. Example: If you search for "Ol" you will get "Olsen", "Olstad", "Bolset", "Ormebol", etc ..
Search for orders containting this customer. The customer can be specific by firstname, lastname, phonenumber or email. This is a fuzzy search.
^[A-Za-z0-9-_]+Search for an order with a specific ordernumber. This is an exact lookup
Search for orders containing the product. This must be a SKU and is an exact lookup.
General query string. Use to search for orders where the server decided the query conditions. This is a fuzzy search.
| ENUM | Description |
|---|---|
| OPEN | Order is open and beeing edited by someone |
| PARKED | Order is parked |
| CANCELED | Order is canceled/deleted |
| COMPLETE | Order is complete |
| ENUM | Description |
|---|---|
| NOT_STARTED | Settlement not started |
| IN_PROGRESS | Settlement is in progress and the order cannot be changed |
| COMPLETE | Settlement is complete |
Reference to an array of deliveryStates.
Reference to a list of orderStatuses.
Reference to a list of orderTypes
Example response
Set reservationType on order items to be reserved on a warehouse or a purchaseorder.
Reference to a tenant.
^[A-Za-z0-9-_]+The uid must be warehouseUid if the reservationType is WAREHOUSE and purchaseOrderItemUid if it is PURCHASEORDER
^[A-Za-z0-9-_]+A list of all the orders with order items that should be marked as ready for delivery
No Content
No Content
Optionally narrow down the search to order in given stores and organizatons.
The field orderStatuses can not be used in combination with the fields orderStates, settleStates or deliveryStates.
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a specific page in a result set.
The number of items per page in a result set.
Defines which field the resource list is sorted by.
| ENUM | Description |
|---|---|
| ASC | Sort in ascending order |
| DESC | Sort in descending order |
Search for orders in all stores on tenant.
An empty string will be ignored, and handled as if the key did not exist in the payload.
Fuzzy search means that it will try to find words that contains the query string that is supplied. The search is case-insensitive. Example: If you search for "Ol" you will get "Olsen", "Olstad", "Bolset", "Ormebol", kolstad@example.com, etc ..
Search for orders containting this customer. The customer can be specific by firstname, lastname, phonenumber or email. This is a fuzzy search.
^[A-Za-z0-9-_]+Search for an order with a specific ordernumber. This is an exact lookup
Search for an order with a specific externalOrderNumber. This is an exact lookup
Search for an order with a specific externalVouchermber. This is an exact lookup
Search for orders containing the product. This must be a SKU and is an exact lookup.
Reference to a list of orderStates.
Reference to a list of settleStates.
Reference to an array of deliveryStates.
Reference to a list of orderStatuses.
Reference to a list of orderTypes
General fuzzy search.
Example response
Order Operations
Reference to a Store.
^[A-Za-z0-9-_]+Reference to an Order.
^[A-Za-z0-9-_]+Reference to a tenant.
^[A-Za-z0-9-_]+| ENUM | Description |
|---|---|
| RECALCULATE_SETTLEMENTS | Do a sum of settlements on order and calculate the settle_state on order |
| RECALCULATE_COSTPRICES | Retreive updated costprices on the order linse of an order. Can only be done when order state = PARKED |
Use invoiceAddress only if an order has a different invoice than orderAddress.
Example response
Update order details.
Order details can only be updated when orderState = OPEN and settleState != COMPLETE
Exception:
externalOrderNumber and externalVoucherNumber can be changed when orderState = COMPLETE
Reference to a Store.
^[A-Za-z0-9-_]+Reference to an Order.
^[A-Za-z0-9-_]+Reference to a tenant.
^[A-Za-z0-9-_]+^[A-Za-z0-9-_]*^[A-Za-z0-9-_]*^[A-Za-z0-9-_]+Note visible on the receipt.
| ENUM | Description |
|---|---|
| SUM | Print as a part of orderlines. |
| SEPARATE | Print as a separate field. |
Use invoiceAddress only if an order has a different invoice than orderAddress.
Example response
Creates a new item on an order.
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a Store.
^[A-Za-z0-9-_]+Reference to an Order.
^[A-Za-z0-9-_]+External reference to order line
Used to calculate itemDiscountAmount.
OrderItemLinkSchema
^[A-Za-z0-9-_]+Set this to true to only resevere the stock from the warehouse when the order is settled.
false^[A-Za-z0-9-_]+Product SKU
^[A-Za-z0-9-_]*^[A-Za-z0-9-_]*^[A-Za-z0-9-_]*Use invoiceAddress only if an order has a different invoice than orderAddress.
Example response
Update details for an item on an order. Partial updates are allowed. Order item details can only be updated when order.orderState = OPEN and order.settleState != COMPLETE
Exception:
externalId can be changed when orderState = COMPLETE
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a Store.
^[A-Za-z0-9-_]+Reference to an Order.
^[A-Za-z0-9-_]+Reference to an order item on an order.
^[A-Za-z0-9-_]+External reference to order line
Used to calculate itemDiscountAmount.
Set this to true to only resevere the stock from the warehouse when the order is settled.
^[A-Za-z0-9-_]*^[A-Za-z0-9-_]*^[A-Za-z0-9-_]*Use invoiceAddress only if an order has a different invoice than orderAddress.
Example response
Print order Content and form is decided by type. orderItemUids is omitted when type is RECEIPT
Reference to a Store.
^[A-Za-z0-9-_]+Reference to an Order.
^[A-Za-z0-9-_]+Reference to a tenant.
^[A-Za-z0-9-_]+| ENUM | Description |
|---|---|
| RECEIPT | Print sales receipt |
| EXCHANGENOTE | Print exchange note |
| GIFTCARD | Print giftcard barcode |
| PICKUP | Print a pickup label/note |
The printer to send the print to
^[A-Za-z0-9-_]+Only valid for type EXCHANGENOTE. Sets a date that the exchange note is valid until. If not set, exchangeNoteValidUntil is calculated from the store's exchangeNoteValidDays setting. Stored on all orderItemUids in request, usually only one item.
No Content
Create an order pdf. Content and form is decided by type.
Reference to a Store.
^[A-Za-z0-9-_]+Reference to an Order.
^[A-Za-z0-9-_]+Reference to a tenant.
^[A-Za-z0-9-_]+| ENUM | Description |
|---|---|
| RECEIPT | Make pdf file from sales receipt |
Send order content by email.
Content and form is decided by type. orderItemUids is omitted when type is RECEIPT
Reference to a Store.
^[A-Za-z0-9-_]+Reference to an Order.
^[A-Za-z0-9-_]+Reference to a tenant.
^[A-Za-z0-9-_]+| ENUM | Description |
|---|---|
| RECEIPT | Send sales receipt as email |
| GIFTCARD | Send giftcard as email |
No Content
Set status on an order. Limited to Open and Parked.
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a Store.
^[A-Za-z0-9-_]+Reference to an Order.
^[A-Za-z0-9-_]+| ENUM | Description |
|---|---|
| OPEN | Set order in state open, to be able to edit it. |
| PARKED | Set order in state parked. |
Use invoiceAddress only if an order has a different invoice than orderAddress.
Example response
Create additional notes, or comments, on orders. Define wether a notification is to be sent to the customer. The notification may be on email or SMS or both.
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a Store.
^[A-Za-z0-9-_]+Reference to an Order.
^[A-Za-z0-9-_]+^[A-Za-z0-9-_]*Example response