get https://{shopdomain}.myshoplaza.com/openapi/2022-01/center/procurements/
Requires
inventoryaccess scope.
The Procurement Order Detail API retrieves detailed information about a specific procurement order using its unique procurement_id. This API provides comprehensive data on the procurement, including its status, quantities, associated logistics, and timestamps.
This API is especially useful for:
- Viewing detailed information about a specific procurement order.
- Tracking the status and quantities of items in a procurement order.
- Managing logistics and other operational details.
Request Parameters
Public Request Parameters
Path Parameters
| Field | Type | Description | Required | Example |
|---|---|---|---|---|
procurement_id | string | Unique identifier of the procurement order. | Yes | "385070142252984200" |
Response Explanation
Public Response Parameters
Success Response
| Field | Type | Description | Example |
|---|---|---|---|
id | int64 | Unique identifier of the procurement order. | 385070142252984200 |
procurement_sn | string | Serial number of the procurement order. | "0000022" |
source_id | int64 | ID of the source associated with the procurement order. | 339974638274034100 |
location_id | int64 | Location ID associated with the procurement order. | 333849256890743900 |
note | string | Notes associated with the procurement order. | "" |
state | string | Current state of the procurement order. | "3" |
pending_quantity | int32 | Quantity of items pending procurement. | 0 |
received_quantity | int32 | Quantity of items received. | 10 |
rejected_quantity | int32 | Quantity of items rejected. | 0 |
transfer_quantity | int32 | Quantity of items transferred. | 10 |
created_by | string | Email address of the user who created the procurement order. | "[email protected]" |
created_at | string | Timestamp indicating when the procurement order was created. | "2024-05-30T07:54:40Z" |
updated_at | string | Timestamp indicating when the procurement order was last updated. | "2024-05-30T07:55:03Z" |
source_type | int32 | Type of the source related to the procurement order. | 1 |
procurement_no | string | Procurement order number. | "20240530" |
tracking_number | string | Tracking number associated with the procurement order. | "" |
estimated_delivery_time | string | Estimated delivery time for the procurement. | "" |
logistics_name | string | Name of the logistics provider. | "" |
logistics_contact | string | Contact information of the logistics provider. | "" |
logistics_address | string | Address of the logistics provider. | "" |
received_times | string | Timestamp indicating when the procurement was received. | "2024-05-30T07:55:03Z" |
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
| ErrorCode | Description | Possible Reasons |
|---|---|---|
| 400 - Bad Request | The request is invalid. | 1. Invalid query parameters. 2. Missing required fields. |
| 404 - Not Found | Resource not found. | 1. The specified procurement order does not exist. |
| 500 - StatusInternalServerError | Internal server error. | 1. Aborted. 2. Unauthenticated. 3. DeadlineExceeded. 4. Response message parsing error. |