Requires
write_productaccess scope. More access scope
The Batch Delete Procurement Items API removes multiple items from a specific procurement order. This enables users to manage procurement orders efficiently by allowing bulk deletion of items.This API is especially useful for:
- Cleaning up procurement orders by removing irrelevant or incorrect items.
- Simplifying procurement order management by enabling bulk deletion.
- Reducing manual efforts required to delete items one by one.
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 |
|---|---|---|---|---|
| id | string | Yes | "382451985837728044" | The unique identifier of the procurement record. |
Body Parameters
| Parameter | Type | Required | Example | Description |
|---|---|---|---|---|
| procurement_item_ids | array | Yes | ["987654321"] | An array of IDs of procurement items to delete. |
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 |
|---|---|---|---|
errors | Array | ["invalid procurement_id"] | A list of errors encountered during the request processing. |
| Field | Type | Example | Description |
|---|---|---|---|
error | Array | "error": "store is not active" | Indicates an error encountered during the process. |
Request Examples
curl --request DELETE \
--url https://{shopdomain}.myshoplaza.com/openapi/2022-01/procurements/{id}/items \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {access_token}' \
--data '{
"procurement_item_ids": [
"123456789",
"987654321"
]
}'
Success Response Example
{}
Error Response Example
{
"errors": [
"invalid procurement_id"
]
}
{
"error": "Supplier not found"}
}
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). | Bad Request |
| Unauthorized | The request is missing valid authentication credentials or the credentials provided are invalid. | Unauthorized | |
Invalid or empty procurement_id | missing required procurement_id or procurement_id with incorrect UUID types | { "errors": [ "invalid procurement_id"]} | |
| 422 | Duplicated procurement_item_id | API request contains multiple entries with the same procurement item id | |
Invalid or empty procurement_item_id | missing required procurement_item_id or procurement_item_id with incorrect UUID types | { "errors": ["The procurement cannot be operated" ] } |