patch
https://{subdomain}.myshoplaza.com/openapi/2025-06/procurements//receive
Processes the receipt of procurement items by updating their quantities (received and rejected) and recording any rejection reasons.
Requireswrite_inventoryaccess scope. More access scope
The Receive Procurement API processes the receipt of procurement items by updating their quantities (received and rejected) and recording any rejection reasons.
This API is especially useful for:
- Recording actual received inventory quantities
- Maintaining accurate procurement status tracking
Request Parameters
Public Request Parameters
Path Parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
procurement_id | string | Yes | Unique identifier of the procurement | "proc_123456789" |
Body Parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
items | array of objects | Yes | Items to update with receipt details | - |
items.procurement_item_id | string | Yes | Unique item identifier | "item_987654" |
items.received_quantity | int32 | Yes | Quantity accepted (must be ≥0) | 45 |
items.rejected_quantity | int32 | Yes | Quantity rejected (must be ≥0) | 5 |
items.rejected_reason | string | No | Reason for rejection | "Damaged packaging" |
Response Explanation
Public Response Parameters
Successful Response
| Parameter | Type | Example | Description |
|---|---|---|---|
code | string | "success" | Status code of the API response |
message | string | "Order retrieved successfully" | Descriptive message about the response |
data | - |
Error Response
| Field | Type | Example | Description |
|---|---|---|---|
code | string | InvalidParameter | Error http message |
message | string | `` | Error message |