Openapi
Return on hand, reserved, held, incoming, and available quantities for every variant at every location.
sb-auth-token<token>Supabase browser session cookie. Supabase may split larger session values into chunked cookies like sb-auth-token.0.
organizationId*stringuuidoffset*stringlimit*stringq?stringlocationId?stringuuidproductId?stringuuidvariantId?stringuuidReturns stock levels per variant and location.
application/jsondata*array<>pagination*curl -X GET 'https://app.localhost/api/v1/organizations/123/inventory/stock-levels?offset=example&limit=example&q=example&locationId=123&productId=123&variantId=123e4567-e89b-12d3-a456-426614174000'{ "data": [ { "available": 0, "held": 0, "incoming": 0, "location": { "active": true, "code": "string", "createdAt": "2019-08-24T14:15:22Z", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "kind": "warehouse", "legalEntityId": "41192155-f2be-4dd0-9ea4-e32ad94824f7", "name": "string", "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9", "updatedAt": "2019-08-24T14:15:22Z" }, "locationId": "1a5515a3-ba81-4a42-aee7-ad9ffc090a54", "onHand": 0, "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9", "product": { "brand": { "createdAt": "2019-08-24T14:15:22Z", "description": "string", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "logoUrl": "http://example.com", "name": "string", "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9", "slug": "string", "updatedAt": "2019-08-24T14:15:22Z", "website": "string" }, "categories": [ { "createdAt": "2019-08-24T14:15:22Z", "description": "string", "icon": "string", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9", "parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43", "position": 0, "slug": "string", "updatedAt": "2019-08-24T14:15:22Z" } ], "categoryIds": [ "7a99018c-b68f-4d32-be08-29a0cbea434a" ], "currency": "string", "defaultSellingPriceCents": -99999999999999, "ean": "string", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "images": [ { "altText": "string", "createdAt": "2019-08-24T14:15:22Z", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9", "position": 0, "productId": "dcd53ddb-8104-4e48-8cc0-5df1088c6113", "updatedAt": "2019-08-24T14:15:22Z", "url": "http://example.com" } ], "manufacturer": "string", "manufacturerPartNumber": "string", "name": "string", "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9", "sku": "string", "slug": "string", "status": "active", "suppliers": [ { "createdAt": "2019-08-24T14:15:22Z", "currency": "string", "externalId": "string", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "isActive": true, "isPreferred": true, "leadTimeDays": 0, "minOrderQuantity": 0, "orderCode": "string", "orderMultiple": 0, "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9", "productId": "dcd53ddb-8104-4e48-8cc0-5df1088c6113", "supplier": { "billingEmail": "string", "btw": "string", "code": "string", "createdAt": "2019-08-24T14:15:22Z", "currency": "string", "defaultInventoryLocationId": "39ba1a59-f7f9-4e8f-a32f-270329b3f772", "defaultLeadTimeDays": 0, "externalId": "string", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "kvk": "string", "name": "string", "notes": "string", "orderingEmail": "string", "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9", "source": "string", "status": "active", "supplierStatus": "approved", "supplierTermsId": "2464d198-821c-4918-87ed-4a65c02d890c", "updatedAt": "2019-08-24T14:15:22Z", "website": "string" }, "supplierId": "e01eb4c4-8eb9-4fb7-b625-61f58c6148db", "supplierSku": "string", "unitCostCents": -99999999999999, "updatedAt": "2019-08-24T14:15:22Z" } ], "tags": [ { "color": "string", "createdAt": "2019-08-24T14:15:22Z", "description": "string", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "kind": "task", "name": "string", "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9", "position": 0, "slug": "string", "updatedAt": "2019-08-24T14:15:22Z" } ], "unitOfMeasure": "string", "updatedAt": "2019-08-24T14:15:22Z", "vatPercentage": 0, "stockStatus": "not_tracked" }, "productId": "dcd53ddb-8104-4e48-8cc0-5df1088c6113", "reorderPoint": 0, "reserved": 0, "variantId": "d53feca7-c65b-4741-aca7-827a42d686bf" } ], "pagination": { "hasMore": true, "limit": 1, "offset": 0, "total": 0, "totalIsEstimate": true }}