Batch Update Procurement Items

🔒

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:

  1. Updating multiple procurement items' transfer quantities at once.
  2. Streamlining procurement item management in large datasets.
  3. 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 NameTypeRequiredParameter LocationParameter ValueDescription
Access-TokenStringYesHeaderBx-_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-TypeStringYesHeaderapplication
/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 NameTypeMandatoryParameter LocationExample ValueDescription
errorStringNoResponse 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" }.
errorsArrayNoResponse Body{ "errors"["inventory not found"] }A list of errors that occurred during the request processing. Example: { "errors": [ "No Context" ] }.
Request-IdStringYesHeaderBx-_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

ParameterTypeRequiredExampleDescription
procurement_idstringYes"382451985837728044"The unique identifier of the procurement record.

Body Parameters

ParameterTypeRequiredExampleDescription
itemsarrayYesSee belowThe array of items to be added to the procurement record.
items.product_idstringYes"382453603865993516"The unique identifier of the product.
items.variant_idstringNo"5723299f-238a-4491-8b42-a187462e748a"The unique identifier of the product variant.
items.transfer_quantityintegerYes100The 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.

FieldTypeExampleDescription
errorArray"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 CodeMessagePossible ReasonExample Response
400Bad RequestInvalid input format or request structure (e.g., missing required fields or incorrect data types).invalid
UnauthorizedThe request is missing valid authentication credentials or the credentials provided are invalid.Unauthorized
Language
Credentials
Header
URL
Click Try It! to start a request and see the response here!