get https://{shopdomain}.myshoplaza.com/openapi/2022-01/center/procurements
Requires
read_inventoryaccess scope.
The Procurement List API retrieves a paginated list of procurement orders with detailed information. It supports filters based on state, creation time, update time, and specific order IDs.
This API is especially useful for:
- Fetching procurement orders for inventory tracking and management.
- Filtering procurement data for specific time ranges or statuses.
- Integrating procurement information into external inventory systems or applications.
Request Parameters
Public Request Parameters
Query Parameters
| Field | Type | Description | Required | Example |
|---|---|---|---|---|
state | string | Status of the procurement order. | Yes | "1" |
created_at_min | string | Filter procurement orders created at or after a specific date. | Yes | "2016-01-18T23:41:00Z" |
created_at_max | string | Filter procurement orders created at or before a specific date. | Yes | "2016-01-18T23:41:00Z" |
updated_at_min | string | Filter procurement orders updated at or after a specific date. | Yes | "2016-01-18T23:41:00Z" |
updated_at_max | string | Filter procurement orders updated at or before a specific date. | Yes | "2016-01-18T23:41:00Z" |
page | string | Page number for paginated results. | Yes | "1" |
limit | string | Number of records per page (limit per page). | Yes | "10" |
ids | string | Comma-separated list of procurement order IDs to fetch specific records. | Yes | "3955443440488797681,3955443440488797682" |
Response Explanation
Public Response Parameters
Success Response
| Field | Type | Description | Example |
|---|---|---|---|
count | int32 | Total number of procurement orders returned in the response. | 1 |
procurements | array | List of procurement order objects. | Array of objects |
procurements[].id | int64 | The unique identifier of the procurement order. | 3955443440488797700 |
procurements[].procurement_sn | string | Serial number of the procurement order. | "0000034" |
procurements[].source_id | int64 | ID of the source associated with the procurement order. | 385324614988721200 |
procurements[].location_id | int64 | Location ID associated with the procurement order. | 329986727237187850 |
procurements[].note | string | Notes associated with the procurement order. | "" |
procurements[].state | string | Current state of the procurement order. | "1" |
procurements[].pending_quantity | int32 | Quantity of items pending procurement. | 0 |
procurements[].received_quantity | int32 | Quantity of items received. | 0 |
procurements[].rejected_quantity | int32 | Quantity of items rejected. | 0 |
procurements[].transfer_quantity | int32 | Quantity of items transferred. | 1 |
procurements[].created_by | string | Email address of the user who created the procurement order. | "[email protected]" |
procurements[].created_at | string | Timestamp indicating when the procurement order was created. | "2024-06-26T11:52:00Z" |
procurements[].updated_at | string | Timestamp indicating when the procurement order was last updated. | "2024-06-26T11:52:00Z" |
procurements[].source_type | int32 | Type of the source related to the procurement order. | 1 |
procurements[].procurement_no | string | Procurement order number. | "20240626" |
procurements[].supplier_name | string | Name of the supplier. | "222222" |
procurements[].tracking_number | string | Tracking number associated with the procurement order. | "" |
procurements[].estimated_delivery_time | string | Estimated delivery time for the procurement. | "" |
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 |