Order
Order
Get order by order uid
Access token recevied after user login with a deviceToken
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to an Order.
^[A-Za-z0-9-_]+Example response
Example response
List all orders.
The query parameter orderStatus can not be used in combination with orderOrderState, orderSettleState or orderDeliveryState.
Access token recevied after user login with a deviceToken
Reference to a Store.
^[A-Za-z0-9-_]+Reference to a tenant.
^[A-Za-z0-9-_]+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 handling uid.
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
Example response
Create a new order.
Access token recevied after user login with a deviceToken
Reference to a Store.
^[A-Za-z0-9-_]+Reference to a tenant.
^[A-Za-z0-9-_]+Example response
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.
Use "orderDate" instead
^[A-Za-z0-9-_]*^[A-Za-z0-9-_]*Internal note, not visible on the receipt.
| ENUM | Description |
|---|---|
| SUM | Print as a part of orderlines. |
| SEPARATE | Print as a separate field. |
^[A-Za-z0-9-_]+Example response
Example response
The field orderStatuses can not be used in combination with orderStates, settleStates or deliveryStates.
Access token recevied after user login with a deviceToken
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.
Search for order containing one of the specified payment methods.
If true, returns orders with orderlines that has either reservationType='REQUEST_PURCHASEORDER' or has a link to a purchaseOrder item
When true, the search returns only orders that include at least one order line with a reservation (reservedQuantity <> 0). When omitted or false, reservation state does not affect the results.
Example response
Example response
Set reservationType on order items to be reserved on a warehouse or a purchaseorder. Use PURCHASE_ORDER_CONFIRMED to mark order items as 'Purchase order created in external system'
Access token recevied after user login with a deviceToken
Reference to a tenant.
^[A-Za-z0-9-_]+If reservationType == WAREHOUSE, uid must have a value pointing to a legal warehouseUid. If reservationType == PURCHASE, uid must have a value pointing to a legal purchase order.
The uid must be warehouseUid if the reservationType is WAREHOUSE, purchaseOrderItemUid if it is PURCHASEORDER and receivementItemUid if it is PURCHASEORDER_CONFIRMED
^[A-Za-z0-9-_]+No Content
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.
Access token recevied after user login with a deviceToken
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", [email protected], 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.
General fuzzy search.
Search for order containing one of the specified payment methods.
If true, returns orders with orderlines that has either reservationType='REQUEST_PURCHASEORDER' or has a link to a purchaseOrder item
When true, the search returns only orders that include at least one order line with a reservation (reservedQuantity <> 0). When omitted or false, reservation state does not affect the results.
Example response
Example response
Get order details. This will return a complete order object.
Access token recevied after user login with a deviceToken
Reference to a Store.
^[A-Za-z0-9-_]+Reference to an Order.
^[A-Za-z0-9-_]+Reference to a tenant.
^[A-Za-z0-9-_]+Example response
Example response
Order Operations
Access token recevied after user login with a deviceToken
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 |
Example response
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
Access token recevied after user login with a deviceToken
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.
Internal note, not visible on the receipt.
| ENUM | Description |
|---|---|
| SUM | Print as a part of orderlines. |
| SEPARATE | Print as a separate field. |
Example response
Example response
Delete an order.
Access token recevied after user login with a deviceToken
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
No content
Creates a new item on an order.
Access token recevied after user login with a deviceToken
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.
^[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-_]*When a product has orderSpecificCost=true: Can set costPrice on the orderItem If itemCostPrice is set and orderSpecificCost=false for the product, an error is returned
When a product has orderSpecificName=true: Can set productName on the orderItem If itemCostPrice is set and orderSpecificName=false for the product, an error is returned
Example response
Example response
Get available payment methods for an order
Get available payment methods for an order
Access token recevied after user login with a deviceToken
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
Example response
Get status for a customer consent on an order
Get status for a customer consent on an order
Access token recevied after user login with a deviceToken
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 orderConsent type
Example response
Example response
Ask customer for a consent on an order
Ask customer for a consent on an order
Access token recevied after user login with a deviceToken
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a Store.
^[A-Za-z0-9-_]+Reference to an Order.
^[A-Za-z0-9-_]+No Content
No Content
No content
Update order item details
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
Access token recevied after user login with a deviceToken
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-_]*When a product has orderSpecificCost=true: Can set costPrice on the orderItem If itemCostPrice is set and orderSpecificCost=false for the product, an error is returned
When a product has orderSpecificName=true: Can set productName on the orderItem If itemCostPrice is set and orderSpecificName=false for the product, an error is returned
Example response
Example response
Delete order item
Delete an item on an order.
Access token recevied after user login with a deviceToken
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-_]+Example response
Example response
List addons for order item
List addons for order item
Access token recevied after user login with a deviceToken
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-_]+| ENUM | Description |
|---|---|
| INSURANCE | Insurance products allowed to be added to the product |
| ALTERNATIVE | Alternative products if the main product is not available |
| ACCESSORY | Accessory products for the main product |
| SPARE_PART | Spare part that can be used to repair the product |
| SERVICE | Service products. |
| FREIGHT_SERVICE | Freight service products. |
| AUTO_ADD | The products will be auto added to the order and can not be removed without removing the main product. |
Example response
Example response
Print order Content and form is decided by type. orderItemUids is omitted when type is RECEIPT
Access token recevied after user login with a deviceToken
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.
Created
Bad Request
No content
Create an order pdf. Content and form is decided by type.
Access token recevied after user login with a deviceToken
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 |
Based on the Accept header the response will be base64 json encoded or a raw file. application/octet-stream will return a binary file application/json will return a json with the file content base64 encoded.
Bad Request
Send order content by email.
Content and form is decided by type. orderItemUids is omitted when type is RECEIPT
Access token recevied after user login with a deviceToken
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 |
Created
Bad Request
No content
Set status on an order. Limited to Open and Parked.
Access token recevied after user login with a deviceToken
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. |
| CONFIRMED | Set order in state confirmed. |
Example response
Example response
List order additional notes
List additional notes, or comments, on orders.
Access token recevied after user login with a deviceToken
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
Example response
Create order additional notes
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.
Access token recevied after user login with a deviceToken
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
Example response
Delete order additional notes
Delete order additional notes
Access token recevied after user login with a deviceToken
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
No content
Last updated