Docs
Management API
Items

Items

Get Inventory at Locations

GET /inventory/items

Request

Return a list of inventory and inventory settings for all items in all locations.

Authentication

  • X-Auth-Token in header
    required

Parameters

  • store_hash in path - string

example

Response

Request has been successfully processed.

Body

object | application/json
  • data
    array[object]

  • meta
    object

example

Get Inventory at a Location

GET /inventory/locations/{location_id}/items

Request

Return a list of inventory and inventory settings for all items in a location.

Authentication

  • X-Auth-Token in header
    required

Parameters

  • store_hash in path - string

example

Response

Request has been successfully processed.

Body

object | application/json
  • data
    array[object]

  • meta
    object

example

Update Inventory Settings for a Location

PUT /inventory/locations/{location_id}/items

Request

Update inventory settings for items at a location.

Authentication

  • X-Auth-Token in header
    required

Parameters

  • store_hash in path - string

Body

object | application/json
  • settings
    array[object]
    required

example

Response

Request has been successfully processed.

Body

object | application/json
  • transaction_id
    string

    Unique identifier of performed action.

Did you find what you were looking for?