Sale Depletion Order
The Sale Depletion Order API allows the user to access a list of sale order information.
Security
jwt-bearer-token
apiKey | API Key |
|---|---|
Name | Authorization |
In | header |
Endpoint
GET /sale-depletion-order
Summary
Get the sale orders list.
Request Parameters
In | Field Name | Type | Required | Description |
|---|---|---|---|---|
header |
| string | Yes | The identifier (ID) of the company who owns the document. |
query |
| string | No | |
query |
| number | No | The maximum documents to return. For example, if |
query |
| number | No | The documents to skip before returning. For example, if |
query |
| string | No | |
query |
| string | No |
Responses
Code | Description | Schema |
|---|---|---|
200 | Success | |
400 | Bad request, for more information look at body error | |
401 | Unauthorized error | |
403 | Forbidden error | |
404 | Not Found | |
422 | Unprocessable error | |
500 | Internal Server Error |
Data Models
sale_depletion_order_get_response_1
Field Name | Type | Description |
|---|---|---|
| ||
| number | |
| number | |
| number | |
| number |
sale_depletion_order_get_response_1_items
Field Name | Type | Required | Description |
|---|---|---|---|
| string | Yes | The sales order identifier identifier (ID) |
| string | No | The sale order event ID |
| string | Yes | The sale order site ID |
| string | Yes | The sale order ID in the database |
| string | Yes | The type of transaction |
| string | Yes | The sale order type is Online Ordering |
| string | Yes | The sale order type is Venue Inventory |
| string | Yes | The sale order number in Online Ordering |
| string | Yes | The sale order status |
| date/time | Yes | The order closed time from the point of sale (POS) device |
| date/time | Yes | The business date when the order was created from the POS device |
| boolean | Yes | The flag which indicates whether the order is sent to Venue Inventory after the event or not. If it is |
| Yes | The sale information of this order | |
| number | Yes | The total payment tips of this order |
| number | Yes | The total discount of this order |
| number | Yes | The total miscellaneous amounts of this order. The fee type is surcharge and donation. |
| number | Yes | The total price of this order |
| number | Yes | The total tax of this order |
| number | Yes | The total tips of this order, which include payment tips and add tips |
| date/time | No | The time the order receipt was created |
| date/time | No | The date of creation |
| string | Yes | The |
| date/time | Yes | The data of the updated record |
| string | Yes | The |
| boolean | No | The flag which indicates whether the order is valid or deleted. If |
sale_depletion_order_get_response_1_items_items
Field Name | Type | Description |
|---|---|---|
| object | The sale depletion order inventory items definition |