Receipt
Was this helpful?
Was this helpful?
Receipt
Get Receipt Details
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
Delete a receipt
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
List settlements for a receipt
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
Get settlement details
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
Delete a settlement
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
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 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", 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.
Search for an order receipt on an order with a specific ordernumber. This is an exact lookup
Search for an order receipt with a specific voucherumber. This is an exact lookup
Search for order receipts containing the products. These must be SKUs and is an exact lookup.
General fuzzy search.
Example response
Create new receipt on order
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a Store.
^[A-Za-z0-9-_]+^[A-Za-z0-9-_]+Example response
Update a receipt
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
Create new settlement
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