get https://{shopdomain}.myshoplaza.com/openapi/2022-01/center/stock_adjust_orders
Requires
read_inventoryaccess scope.More access scope
The Stock Adjust Order List API retrieves a paginated list of stock adjustment orders, including detailed information about the order type, status, and associated warehouse details.
This enables users to:
- Monitor inventory adjustments across warehouses.
- Track adjustments made for specific reasons, such as damage or product recall.
- Generate reports for inventory audits and management.
Request Parameters
Public Request Parameters
Query Parameters
| Field | Type | Description | Example |
|---|---|---|---|
page | int32 | Page number. | 1 |
limit | string | Limit per page. | 20 |
Response Explanation
Public Response Parameters
Success Response
| Field | Type | Description | Example |
|---|---|---|---|
list | array of objects | List of stock adjust orders. | |
list.id | string | Stock adjust order ID. | 403803876811904971 |
list.stock_adjust_no | string | Stock adjust order number. | AD2024071908001 |
list.stock_adjust_type | AdjustType | Stock adjust type. | 0 |
list.location_id | string | Warehouse ID. | 34285709337585374 |
list.location_name | string | Warehouse name. | #E10003 |
list.stock_adjust_status | StockAdjustStatus | Stock adjust order status. | 1 |
list.stock_adjust_at | string | Inventory adjustment time. | 2024-07-19T06:52:27Z |
list.created_at | string | Stock adjust order creation time. | 2024-07-19T06:52:27Z |
list.note | string | Note related to the stock adjustment order. | "" |
count | int | Total number of stock adjust orders. | 36 |
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 |