get https://{shopdomain}.myshoplaza.com/openapi/2022-01/center/drawer_counts
Requires
read_dataaccess scope.
The List Draw Count API retrieves records of draw counts based on the specified filters.
This enables users to:
- Track drawer open and close events.
- Analyze drawer usage within specific time periods.
- Retrieve event data for audit or reporting purposes.
Request Parameters
Public Request Parameters
Query Parameters
| Field | Type | Description | Example |
|---|---|---|---|
action | string | Event type, including open or close. | open |
start_time | string | Filter draw count records created at or before this date. | 2016-01-18T23:41:00Z |
end_time | string | Filter draw count records created at or after this date. | 2016-01-18T23:41:00Z |
page | string | Page number. | 1 |
page_size | string | Limit of records per page. | 20 |
Response Explanation
Public Response Parameters
Error Response
Error responses in the API can be represented using two different fields: errors and error. Both fields provide details about issues encountered during request processing. Below is an explanation of the fields with their respective examples and descriptions.
| Field | Type | Example | Description |
|---|---|---|---|
error | String | "page not found" | Indicates an error encountered during the process |
Error Detail
| Status Code | Message | Possible Reason | Example Response |
|---|---|---|---|
| 400 | Bad Request | Invalid input format or request structure (e.g., missing required fields or incorrect data types). | Bad Request |
| Unauthorized | The request is missing valid authentication credentials or the credentials provided are invalid. | Unauthorized | |
| 404 | Not found | Script's ID is empty or not provided | "record not found" |
| 401 | Unauthorized | Only open data for specific stores.Please contact us if necessary. | "The shop has no permission." |