Inventory

Endpoint for retrieving your inventory — items that have been received and are currently stored at your warehouse.

GET/api/v1/inventory

List inventory orders

Retrieve a paginated list of your inventory orders, including check-in details, locations, trackings, damages, and tags.

Query parameters

Name
offset
Type
integer
Description
Pagination offset. Defaults to 0.
Name
limit
Type
integer
Description
Maximum number of records to return. Defaults to 200. Pass -1 for all records.
Name
sort_key
Type
string
Description
Field to sort by. Defaults to created_at.
Name
sort_order
Type
string
Description
Sort direction: asc or desc. Defaults to desc.
Name
fulfillment_types
Type
array
Description
Filter by fulfillment type: fba, fbm, manual, two-step, wfs, shopify.
Name
location
Type
string
Description
Filter by warehouse location. Supports partial match.
Name
has_damage
Type
boolean
Description
When true, only return orders with unresolved damages.

Request

GET

/api/v1/inventory

curl -G https://api.example.com/api/v1/inventory \
  -H "Authorization: ApiKey {your-api-key}" \
  -H "X-Warehouse-Id: {warehouse_id}" \
  -d limit=50 \
  -d offset=0 \
  -d sort_order=desc

Response

{
  "status": "success",
  "message": "Fetched orders.",
  "data": {
    "orders": [
      {
        "order_id": "64c65048-b335-4921-b09d-68d4142d5655",
        "date": "03/25/2025",
        "retailer": "Amazon",
        "order_number": "ORD-001",
        "item_name": "Widget A",
        "color": "Blue",
        "brand_sku": "WA-BLU-M",
        "size": "Medium",
        "quantity": 10,
        "asin": "B08N5WRWNW",
        "amazon_sku": "WA-BLU-M-FBA",
        "unit_cost": 12.50,
        "list_price": 24.99,
        "fulfillment_type": "fba",
        "sold_as": "individual",
        "units_per_pack": 1,
        "quantity_received": 10,
        "quantity_remaining": 8,
        "quantity_shipped": 2,
        "quantity_removed": 0,
        "quantity_damaged": 0,
        "is_damaged": false,
        "unit_status": "fully_received",
        "status": "inventory",
        "client_notes": null,
        "admin_notes": null,
        "check_ins": [
          {
            "check_in_id": "a1b2c3d4-...",
            "quantity_checked_in": 10,
            "created_at": "2025-03-26T09:15:00Z",
            "locations": [
              { "location": "A-1-2", "quantity_stored": 10 }
            ]
          }
        ],
        "locations": [
          { "location": "A-1-2", "quantity_stored": 10 }
        ],
        "trackings": [
          {
            "tracking_number": "1Z999AA10123456784",
            "carrier": "UPS",
            "tracking_status": "delivered"
          }
        ],
        "damages": [],
        "image_urls": [],
        "tags": [
          { "tag": "priority", "value": "high" }
        ],
        "barcode_id": null,
        "upc": null
      }
    ],
    "results": {
      "total": 85,
      "limit": 50,
      "offset": 0
    },
    "fba_shipment_frequency": 7
  }
}