xclade
Admin APIInventory items

List Inventory Items

Retrieve a list of inventory items. The inventory items can be filtered by fields such as `id`. The inventory items can also be sorted or paginated.

GET
/admin/inventory-items

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

fields?string

Comma-separated fields that should be included in the returned data. if a field is prefixed with + it will be added to the default fields, using - will remove it from the default fields. without prefix it will replace the entire default fields.

offset?number

The number of items to skip when retrieving a list.

limit?number

Limit the number of items returned in the list.

order?string

The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with -.

q?string

The inventory item's q.

id?id|
sku?sku|
origin_country?origin_country|
mid_code?mid_code|
hs_code?hs_code|
material?material|
requires_shipping?boolean

The inventory item's requires shipping.

weight?unknown

Filter the inventory item's weight.

length?unknown

Filter the inventory item's length.

height?unknown

Filter by the inventory item's height.

width?unknown

Filter by the inventory item's width.

location_levels?

Filter by the inventory item's associated location IDs.

$and?

Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.

$or?

Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.

with_deleted?boolean

Whether to include deleted records in the result.

Response Body

application/json

application/json

text/plain

application/json

application/json

application/json

application/json

curl -X GET "https://{tenant}.api.myxclade.com/admin/inventory-items"
{
  "limit": 0,
  "offset": 0,
  "count": 0,
  "inventory_items": [
    {
      "id": "string",
      "sku": "string",
      "origin_country": "string",
      "hs_code": "string",
      "requires_shipping": true,
      "mid_code": "string",
      "material": "string",
      "weight": 0,
      "length": 0,
      "height": 0,
      "width": 0,
      "title": "string",
      "description": "string",
      "thumbnail": "string",
      "metadata": {},
      "location_levels": [
        {
          "id": "string",
          "created_at": "2019-08-24T14:15:22Z",
          "updated_at": "2019-08-24T14:15:22Z",
          "deleted_at": "2019-08-24T14:15:22Z",
          "inventory_item_id": "string",
          "location_id": "string",
          "stocked_quantity": 0,
          "reserved_quantity": 0,
          "incoming_quantity": 0,
          "metadata": {},
          "inventory_item": {},
          "available_quantity": 0
        }
      ]
    }
  ]
}

{
  "message": "Discount must be set to dynamic",
  "type": "not_allowed"
}

"Unauthorized"
{
  "message": "Entity with id 1 was not found",
  "type": "not_found"
}
{
  "code": "unknown_error",
  "message": "The request conflicted with another request. You may retry the request with the provided Idempotency-Key.",
  "type": "QueryRunnerAlreadyReleasedError"
}
{
  "code": "invalid_request_error",
  "message": "Discount with code TEST already exists.",
  "type": "duplicate_error"
}

{
  "code": "api_error",
  "message": "An error occured while hashing password",
  "type": "database_error"
}

Remove Inventory Level of Inventory Item

Remove the inventory level of an inventory item. If the inventory level has reserved quantity greater than `0`, an error is thrown.

Get a Inventory Item

Retrieve a inventory item by its ID. You can expand the inventory item's relations or select the fields that should be returned.