Bulk Update Inventory Attributes
The Bulk Update Inventory Attributes API allows you to update the inventory attributes of one or more inventory objects.
- Inventory in a Received or Located IBLPN and inventory in an Active Location may be modified.
- Inventory history adjustment records will be written for each successfully modified inventory record.
- At least one attribute must be provided in the request to indicate a change.
- Inventory cannot be or have been allocated.
URL
POST .../wms/lgfapi/v10/entity/inventory/bulk_update_inventory_attributes
This API is supported in JSON format.
Behavior
- An empty string is a valid value and indicates removal of the attribute.
- Attributes not included in the request will retain their existing values.
- Commit frequency determines how updates are applied:
0: Roll back on the first error.1: Commit per object.
Request Parameters
- The parameters section identifies the inventory records.
- The options section specifies the target attributes.
| Parameter Name | Type | Required | Default | Description |
| id | String | Conditional | — | Unique ID of a single inventory record. |
| id__in | Array | Conditional | — | Array of inventory IDs (bulk update). |
| invn_attr_a–o | String | Conditional | — | Attribute values A through O. At least one must be provided. |
| commit_frequency | Integer | No | 1 | 0 = rollback on first error, 1 = commit per object. |
Request Body - Bulk Update Inventory Attributes
{
"parameters": {
"id__in": ["107692", "107693"]
},
"options": {
"invn_attr_a": "Attr A",
"invn_attr_b": "Attr B",
"invn_attr_c": "Attr C",
"invn_attr_d": "Attr D",
"commit_frequency": 1
}
}
Sample Response
{
"success": true,
"response": {
"message": "Inventory attributes successfully updated",
"records_updated": 2
}
}