xclade
Admin APIInventory items

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.

GET
/admin/inventory-items/{id}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

The inventory item's ID.

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.

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/string"
{
  "inventory_item": {
    "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"
}

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.

List Inventory Levels

Retrieve a list of inventory levels associated with an inventory item. The inventory levels can be filtered by fields like `location_id`. The inventory levels can also be paginated.