🔒

Requires write_product access 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 used for managing procurement workflows and tracking item status upon receipt.This API is especially useful for:

1. Recording quantities of items received and rejected during the procurement process.
2. Providing reasons for rejected items to ensure transparency in procurement workflows.
3. Tracking and updating the state of procurement items for better inventory management.

Note: The operation is scoped to a specific shop, identified by its unique domain prefix (shopdomain), ensuring all updates are applied to the correct store.

Public Request Parameters

Public Response Parameters

Error and Errors Clarification:

Added explanation that the error and errors fields are currently dependent on the API implementation, with plans for future unification.

Request Parameters

Path Parameters

Body Parameters

Response Explanation

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.

Request Examples

curl -X PATCH https://{shopdomain}.myshoplaza.com/openapi/2022-01/procurement/{id}/receive \
-H "Authorization: Bearer <ACCESS_TOKEN>" \
-H "Content-Type: application/json" \
-d '{
  "items": [
    {
      "procurement_item_id": "382453603865993516",
      "received_quantity": 5,
      "rejected_quantity": 2,
      "rejected_reason": "Damaged during shipping"
    }
  ]
}'

Success Response Example

{}

Error Response Example

{
  "errors": [
    "Procurement not found"
  ]
}
}

{
  "error": "Supplier not found"}
}

Error Details