Skip to main content

Inventory Location Balance

Version: 1.0

An inventory item represents the physical goods available to be shipped to a customer. It holds essential information about the physical good, including its SKU and whether its inventory is tracked.

You can use the location id with variant id to query the inventory locations resources to retrieve inventory information.

Authenticated access scopes: com.read_inventories, com.write_inventories

What you can do with Inventory Locations​

The Haravan API lets you do the following with the Inventory Locations resource.

Properties​

id : number

"id": 1206854680

The ID of the inventory item.

loc_id : number

"loc_id": 963414

product_id : number

"product_id": 1028183686

The ID of the product.

variant_id : number

"variant_id": 1064240649

The ID of the product variant.

qty_onhand : number

"qty_onhand": 0

The quantity of inventory items.

qty_commited : number

"qty_commited": 7

The quantity of inventory items ordered.

qty_incoming : number

"qty_incoming": 1

The quantity of inventory items ordered.

qty_available : number

"qty_available": 5

The quantity of inventory items available for sale.

updated_at : string

"updated_at": "2021-05-13T07:29:20.808Z"

The date and time (ISO 8601 format) when the inventory item was last updated.

Retrieves a list of inventory items​

GET
https://apis.haravan.com/com/inventory_locations.json?location_ids={location_ids}&variant_ids={variant_ids}

Retrieves a list of inventory items.

Parameters​

limit

Limit of the result.(default: 250, maximum: 250)

location_ids

Filter result by the comma-separated list of location ids. (maximum: 50)

vatiant_ids

Filter result by the comma-separated list of variant ids. (maximum: 50)

updated_at_min

Show inventory locations updated at or after date.

since_id

Show inventory locations after the specified ID.

order

Sort result by order id or order update_at order=id or order=updated_at.

direction

Sort result by the order direction=asc or direction=desc.

Retrieves a list of inventory items.

  • GET https://apis.haravan.com/com/inventory_locations.json?location_ids=1007284,963414&variant_ids=1061514767,1064240649
Details
HTTP/1.1 200 OK
{
    "inventory_locations": [
        {
            "id": 1003098484,
            "loc_id": 1007284,
            "product_id": 1028183686,
            "variant_id": 1064240649,
            "qty_onhand": 0,
            "qty_commited": 0,
            "qty_incoming": 0,
            "qty_available": 0,
            "updated_at": "2021-08-04T08:32:02.01Z"
        },
        {
            "id": 1006907070,
            "loc_id": 1007284,
            "product_id": 1028183686,
            "variant_id": 1061514767,
            "qty_onhand": 15,
            "qty_commited": 0,
            "qty_incoming": 1,
            "qty_available": 15,
            "updated_at": "2021-07-30T06:05:24.332Z"
        },
        {
            "id": 1003226632,
            "loc_id": 963414,
            "product_id": 1028183686,
            "variant_id": 1064240649,
            "qty_onhand": 0,
            "qty_commited": 7,
            "qty_incoming": 0,
            "qty_available": -7,
            "updated_at": "2021-07-08T01:47:17.612Z"
        },
        {
            "id": 1007549786,
            "loc_id": 963414,
            "product_id": 1028183686,
            "variant_id": 1061514767,
            "qty_onhand": -3,
            "qty_commited": 12,
            "qty_incoming": 0,
            "qty_available": -15,
            "updated_at": "2021-07-08T01:47:17.6Z"
        }
    ]
}