Requires
write_product
access scope. More access scope
The Batch Update Procurement Items API allows bulk updating of procurement item quantities in a specified procurement. This API is useful for efficiently managing procurement item updates in bulk.This API is especially useful for:
- Updating multiple procurement items' transfer quantities at once.
- Streamlining procurement item management in large datasets.
- Ensuring consistency in procurement records during bulk updates.
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
Parameter Name | Type | Required | Parameter Location | Parameter Value | Description |
---|---|---|---|---|---|
Access-Token | String | Yes | Header | Bx-_5aV eXNwl-4AB98s5xLV yg0fNzGf MuTpqtlBA | Used to authenticate API requests. Obtain an access token from the Access Token Guide. Pass it in the Authorization header for every request. |
Content-Type | String | Yes | Header | application /json | Indicates the media type of the request body. It tells the server how to parse the request and the client how to interpret the response. For more details, visit Content-Type. |
Public Response Parameters
Parameter Name | Type | Mandatory | Parameter Location | Example Value | Description |
---|---|---|---|---|---|
error | String | No | Response Body | { "error": "store is not active" } | Indicates an error encountered during the process. This field typically appears when the Access Token is missing or invalid. Example: { "error": "store is not active" } . |
errors | Array | No | Response Body | { "errors"["inventory not found"] } | A list of errors that occurred during the request processing. Example: { "errors": [ "No Context" ] } . |
Request-Id | String | Yes | Header | Bx-_5aV eXNwl-4AB98s5xLV yg0fNzGf MuTpqtlBA | A unique identifier for each request. It helps in identifying and debugging specific requests. |
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
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
procurement_id | string | Yes | "382451985837728044" | The unique identifier of the procurement record. |
Body Parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
items | array | Yes | See below | The array of items to be added to the procurement record. |
items.product_id | string | Yes | "382453603865993516" | The unique identifier of the product. |
items.variant_id | string | No | "5723299f-238a-4491-8b42-a187462e748a" | The unique identifier of the product variant. |
items.transfer_quantity | integer | Yes | 100 | The quantity of the item to be transferred. |
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.
Field | Type | Example | Description |
---|---|---|---|
error | Array | "error": "store is not active" | Indicates an error encountered during the process. |
Request Examples
curl --request PATCH \
--url https://{shopdomain}.myshoplaza.com/openapi/2022-01/procurments/{id}/items \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {access_token}' \
--data '{
"items": [
{
"procurement_item_id": "123456789",
"transfer_quantity": 10
},
{
"procurement_item_id": "987654321",
"transfer_quantity": 5
}
]
}'
Success Response Example
{}
Error Response Example
{
"error": "store is not active"
}
Error Details
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). | invalid |
Unauthorized | The request is missing valid authentication credentials or the credentials provided are invalid. | Unauthorized |