🔒

Requires write_product access scope. More access scope

The Batch Create Procurement Items API allows the bulk addition of procurement items to a procurement record. This API is useful for adding multiple products and their variants in a single request to streamline the procurement process.This API is especially useful for:

1. Adding multiple items to a procurement record in a single operation.
2. Managing procurement workflows with large datasets.
3. Reducing manual input for procurement item creation.

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

{
  "fail_items": []
}

Error Response Example

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

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

Error Details