# Get Inventory

## List All Inventory

### 📌 Description

This endpoint retrieves a list of all inventory items stored in the fulfilment centre under your account. Clients can filter the results using query parameters such as SKU or product ID.

### 🔹 Use Cases

- Checking stock levels before placing new orders. 
 - Filtering inventory to track specific products. 
 - Verifying stock availability for customer fulfilment.

Endpoint: GET /api/fulfilment/inventory
Version: 1.0.0
Security: OAuth2

## Query parameters:

  - `limit` (integer)
    Maximum number of items to return per page (1-100)

  - `page` (integer)
    Page number to return (starts at 1)

  - `sku` (string)
    Filter inventory by product SKU

  - `product_name` (string)
    Filter inventory by product name

  - `sort` (string)
    Field to sort results by

  - `sort_desc` (boolean)
    Sort in descending order if true

## Response 200 fields (application/json):

  - `inventory` (array, required)

  - `inventory.available` (integer)

  - `inventory.cost` (string)

  - `inventory.created_at` (string)

  - `inventory.expiry_groups` (array)

  - `inventory.expiry_groups.expiry_date` (string, required)

  - `inventory.expiry_groups.quantity` (integer, required)

  - `inventory.inbound_state` (string)

  - `inventory.product` (object)

  - `inventory.product.availability_status` (integer)

  - `inventory.product.barcode` (string)

  - `inventory.product.cost_price` (number)

  - `inventory.product.country_code_of_origin` (string)

  - `inventory.product.currency` (string)
    Enum: "AED", "SAR"

  - `inventory.product.description` (string)

  - `inventory.product.dimensions` (object)

  - `inventory.product.harmonized_system_code` (string)

  - `inventory.product.id` (string)

  - `inventory.product.image` (string)

  - `inventory.product.inventory_tracked` (boolean)

  - `inventory.product.name` (string)

  - `inventory.product.partner_product_id` (string)

  - `inventory.product.platform_price` (number)

  - `inventory.product.requires_shipping` (boolean)

  - `inventory.product.retail_price` (number)

  - `inventory.product.selling_price` (number)

  - `inventory.product.sku` (string)

  - `inventory.product.status` (string)
    Enum: "active", "archived", "draft"

  - `inventory.product.total_sales` (number)

  - `inventory.product.track_expiry` (boolean)

  - `inventory.product.type` (string)

  - `inventory.product.updated_at` (string)

  - `inventory.product.vendor` (string)

  - `inventory.product.weight` (number)

  - `inventory.product.weight_unit` (string)

  - `inventory.product_id` (string)

  - `inventory.tracked` (boolean)

  - `pagination` (object, required)

  - `pagination.next` (object)

  - `pagination.next.limit` (integer, required)

  - `pagination.next.page` (integer, required)

  - `pagination.next.sort` (string, required)

  - `pagination.next.sort_desc` (boolean, required)

  - `pagination.next_url` (string)

  - `pagination.prev` (object)

  - `pagination.prev_url` (string)

  - `pagination.total` (integer, required)

## Response default fields (application/json):

  - `code` (string)
    Error code
    Example: "not_found"

  - `details` (object)
    Error details

  - `message` (string)
    Error message