The Order (Task) Inventories object is included in some webhook callbacks.
About the Order Inventories Object
The task_inventories
object provides detailed information about inventory items associated with an order, including unique inventory IDs, item quantities, dimensions, and attributes, allowing for flexible management and updates through Bringg's API and webhooks. This object can be sent to Bringg as part of the Create Order (Task) endpoint and can be included in any flexible webhook, enabling you to stay updated on the inventory associated with your orders.
Best Practices
- Before sending inventory details to Bringg, ensure that each inventory item has a unique ID to allow for precise tracking and handling. This lets Bringg know that you are referring to a specific instance of an item when sending updates. To set up a unique inventory ID in Bringg:
- In Bringg, go to Settings > Merchant Configuration.
- Select a parameter from the drop-down field next to Unique Inventory ID.
- Select Update to save your changes.
- Send distinct products with quantities to indicate multiple items, rather than including multiple line items with the same ID.
- Determine which level of your inventory hierarchy the driver needs to be able to scan and act on. You can add multiple levels of inventory (we recommend up to three) by embedding another
inventory
object within the first, including thescan_string
at the top level. For example, you can include a top-level item such as acrate
with a barcode for the driver to scan. Then, if an issue arises with an item within the crate, such as a missingbag of chips
, the driver can interact on that inventory level to reject the specific item.
Order Inventories Details
<ObjectsAboutCustomAttributes />
Parameter | Description |
---|---|
| The ID of the driver action required for this inventory item. |
| Indicates whether the driver must check the customer's ID before completing the delivery, for example, when the order includes alcohol. |
| The ID of this item in your external systems. |
| This field can be used to send custom attributes to Bringg using the JSON format of field and value. |
| The URL of an externally-hosted image of this item. |
| The handling units value can be sent as an integer or double.
|
| The height of this item. |
| The URL of an image of this item. |
| An object detailing changes made to the inventory, including the change type, result, and reasons. Learn more about the Inventory Change Details Object. |
| The length of this item. |
| The name of the item. |
| A note added to this inventory item. |
| Indicates whether the item is intended for pickup or dropoff. |
| The item price. |
| The original item quantity included in the the order. |
| The scan code associated with this item. |
| An array of services associated with this item, as configured with your Bringg representative, using Bringg's IDs. |
| An array of services associated with this item, as configured with your Bringg representative, using your external system's IDs. |
| The weight of this item. |
| The width of this item. |
Response and Webhook Data
Parameter | Description |
---|---|
| The date and time this item was created. |
| The date and time this item was deleted. |
| Bringg's ID for this item. |
| This object details the changes when an inventory item is rejected. When there are no rejections to report, the object is returned as an empty array. Included parameters: |
| The ID of this item in Bringg. |
| The ID of the company. The merchant_id may be |
| The original item quantity included in the the order. |
| When there is a hierarchical relationship between inventory items, this is the ID of the parent item to which this item belongs. |
| The number of items picked up by the driver. |
| The resulting item quantity delivered or collected after rejections. |
| The number of items rejected by the customer or driver. |
| If a scan code is associated with this item, this indicates whether the item was scanned. |
| If the task inventory item originated from another order, this is the ID of that other order. |
| Bringg's ID for the associated order. |
| The date and time when this item was last updated. |
Examples
"task_inventories": [
{
"id": 334343988,
"quantity": 1,
"scanned": false,
"original_quantity": 5,
"rejected_quantity": 4,
"external_id": "2145",
"name": "Icebox Fridge 32'",
"inventory_change_details": [
{
"change_type": 2,
"before": "0",
"after": "4",
"inventory_change": {
"reason_to_change_inventory_id": 421,
"reason_to_change_inventory": {
"reason": "Item is damaged"
}
}
}
]
}
]
"task_inventories": [
{
"id": 334343988,
"quantity": 5,
"scanned": false,
"original_quantity": 5,
"rejected_quantity": 0,
"external_id": "2145",
"name": "Icebox Fridge 32'",
"inventory_change_details": []
}
]