🔒
Requires write_inventory access scope. More access scope

The Batch Update Procurement Items API allows users to add bulk addition of procurement items to a procurement record.

This API is especially useful for:

Request Parameters

📘
Public Request Parameters

Parameter	Type	Required	Description	Example
`procurement_id`	string	Yes	Unique identifier of the procurement record	`"proc_123456789"`

Parameter	Type	Required	Description	Example
`items`	array of objects	Yes	Collection of items to create	-
`items.product_id`	string	Yes	Unique identifier of the product	`"prod_123456"`
`items.variant_id`	string	Yes	Unique identifier of the product variant	`"var_789012"`
`items.transfer_quantity`	int32	Yes	Initial transfer quantity (must be ≥1)	`50`

Response Explanation

📘
Public Response Parameters

Parameter	Type	Example	Description
`code`	string	`"200"`	HTTP status code
`message`	string	`"Items created successfully"`	Operation result message
`data.created_items`	array of objects	-	Successfully added items
`data.created_items.procurement_item_id`	string	`"item_987654"`	New item ID
`data.created_items.product_id`	string	`"prod_123456"`	Product reference
`data.created_items.variant_id`	string	`"var_789012"`	Variant reference
`data.created_items.transfer_quantity`	int32	`50`	Initial quantity
`data.created_items.created_at`	string	`"2025-06-24T17:00:00Z"`	Creation timestamp
`data.fail_items`	array of objects	-	Failed creation attempts
`data.fail_items.product_id`	string	`"prod_999999"`	Failed product ID
`data.fail_items.variant_id`	string	`"var_888888"`	Failed variant ID
`data.fail_items.transfer_quantity`	int32	`0`	Failed quantity
`data.fail_items.error`	string	`"Invalid product variant"`	Failure reason

Field	Type	Example	Description
`code`	string	`InvalidParameter`	Error http message
`message`	string	``	Error message