Receipt
Receipt
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 order receipts 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.
Search for an order receipt on an order with a specific ordernumber. This is an exact lookup
Deprecated: Use voucherNumbers instead.
Search for multiple order receipts by voucher numbers. This is an exact lookup
Search for order receipts containing the products. These must be SKUs and is an exact lookup.
Search for order receipts containing one of the specified payment methods.
General fuzzy search.
When this is set to true, only unpaid receipts/invoices will be in the response.
Example response
Example response
Create new receipt on 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-_]+^[A-Za-z0-9-_]+Example response
Example response
Get Receipt Details
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 a Receipt.
^[A-Za-z0-9-_]+Example response
Example response
Update a receipt
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 a Receipt.
^[A-Za-z0-9-_]+Example response
Example response
Delete a receipt
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 a Receipt.
^[A-Za-z0-9-_]+No Content
No Content
No content
List settlements for a receipt
List settlements for a receipt
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 a Receipt.
^[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 new settlement
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 a Receipt.
^[A-Za-z0-9-_]+Create a new settlement
in cents, e.g. 1,50 as 150
External reference for the settlement
^[A-Za-z0-9-_]+Example response
Example response
Print receipt
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 a Receipt.
^[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
No Content
No content
Get settlement details
Get settlement details
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 a Receipt.
^[A-Za-z0-9-_]+Reference to a settlement on an order.
^[A-Za-z0-9-_]+Check external payment gateways and fetch status
Include display messages in the response
Example response
Example response
Delete a settlement
Delete a settlement
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 a Receipt.
^[A-Za-z0-9-_]+Reference to a settlement on an order.
^[A-Za-z0-9-_]+Force Delete on a settlement
No Content
No Content
No content
Check the status for an EHF invoice.
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 a Receipt.
^[A-Za-z0-9-_]+Example response
Example response
An EHF invoice is normally sent automatically upon order settlement completion, but here you can try an send it again if it failed the first time. If sending succeeds, the status is also checked.
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 a Receipt.
^[A-Za-z0-9-_]+Example response
Example response
Send receipt by email
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 a Receipt.
^[A-Za-z0-9-_]+ReceiptEmailSchema
| ENUM | Description |
|---|---|
| RECEIPT | Send sales receipt as email |
No Content
No Content
No content
Last updated