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.

Request Parameters

Public Request Parameters

📘

Public Request Parameters

Path Parameters

ParameterTypeRequiredExampleDescription
procurement_idstringYes"38245198 5837728044"The unique identifier of the procurement record.

Body Parameters

ParameterTypeRequiredExampleDescription
itemsarrayYesSee belowThe array of items to be added to the procurement record.
items.
product_id
stringYes"382453603 865993516"The unique identifier of the product.
items.
variant_id
stringNo"5723299f-2 38a-4491-8b42-a187462e748a"The unique identifier of the product variant.
items.
transfer_quantity
integerYes100The quantity of the item to be transferred.

Response Explanation

Public Response Parameters

📘

Public Response Parameters

Success Response

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.

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

API Structure Overview

Language
Credentials
Header
URL
Click Try It! to start a request and see the response here!