--- updatedAt: 2026-05-29T09:20:09.000Z agentTools: projectIndex: https://developer.katanamrp.com/llms.txt --- # List current inventory Returns a list for current inventory. The inventory is returned in sorted order, with the oldest locations appearing first. # OpenAPI definition ```json { "openapi": "3.0.0", "info": { "title": "RESOURCES", "version": "1.0.0", "description": "public api" }, "servers": [ { "url": "https://api.katanamrp.com/v1" } ], "security": [ { "bearerAuth": [] } ], "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer" } } }, "paths": { "/inventory": { "get": { "summary": "List current inventory", "tags": [ "Inventory" ], "description": "Returns a list for current inventory. The inventory is returned in sorted order,\n with the oldest locations appearing first.", "operationId": "getAllInventoryPoint", "parameters": [ { "name": "location_id", "required": false, "description": "Filters inventories by a valid location id", "schema": { "type": "integer" }, "in": "query" }, { "name": "variant_id", "required": false, "description": "Filters inventories by valid variant ids", "schema": { "type": "array", "items": { "type": "integer" } }, "in": "query" }, { "name": "include_archived", "required": false, "description": "Includes archived inventories", "schema": { "type": "boolean" }, "in": "query" }, { "name": "extend", "required": false, "description": "Array of objects that need to be added to the response", "schema": { "type": "array", "items": { "type": "string", "enum": [ "variant", "location" ] } }, "in": "query" }, { "name": "limit", "required": false, "description": "Used for pagination (default is 50)", "schema": { "type": "string" }, "in": "query" }, { "name": "page", "required": false, "description": "Used for pagination (default is 1)", "schema": { "type": "string" }, "in": "query" } ], "responses": { "200": { "description": "List all inventories", "headers": { "X-Pagination": { "description": "Pagination metadata", "schema": { "type": "object", "properties": { "total_records": { "type": "number" }, "total_pages": { "type": "number" }, "offset": { "type": "number" }, "page": { "type": "number" }, "first_page": { "type": "boolean" }, "last_page": { "type": "boolean" } } } }, "X-Ratelimit-Limit": { "description": "Number of requests available for this application.", "schema": { "type": "number" } }, "X-Ratelimit-Remaining": { "description": "Number of requests remaining in quota.", "schema": { "type": "number" } }, "X-Ratelimit-Reset": { "description": "The timestamp when the quota will reset.", "schema": { "type": "number" } } }, "content": { "application/json": { "example": { "data": [ { "variant_id": 1, "location_id": 1, "reorder_point": "5.00000", "average_cost": "10.0000000000", "value_in_stock": "70.0000000000", "quantity_in_stock": "7.00000", "quantity_committed": "0.00000", "quantity_expected": "100.00000", "quantity_missing_or_excess": "102.00000", "quantity_potential": "200.00000", "variant": { "id": 1, "sku": "EM", "sales_price": 40, "product_id": 1, "purchase_price": 0, "product_or_material_name": "New Product", "type": "product", "created_at": "2020-10-23T10:37:05.085Z", "updated_at": "2020-10-23T10:37:05.085Z", "internal_barcode": "0316", "registered_barcode": "0785223088", "supplier_item_codes": [ "978-0785223085", "0785223088" ], "config_attributes": [ { "config_name": "Type", "config_value": "Standard" } ] }, "location": { "id": 1, "name": "Main location", "legal_name": "Amazon", "address_id": 1, "address": { "id": 1, "city": "New York", "country": "United States", "line_1": "10 East 20th Example St", "line_2": "", "state": "New York", "zip": "10000" }, "is_primary": true, "sales_allowed": true, "manufacturing_allowed": true, "created_at": "2020-10-23T10:37:05.085Z", "updated_at": "2020-10-23T10:37:05.085Z" } } ] } } } }, "401": { "description": "Make sure you've entered your API token correctly.", "headers": { "X-Ratelimit-Limit": { "description": "Number of requests available for this application.", "schema": { "type": "number" } }, "X-Ratelimit-Remaining": { "description": "Number of requests remaining in quota.", "schema": { "type": "number" } }, "X-Ratelimit-Reset": { "description": "The timestamp when the quota will reset.", "schema": { "type": "number" } } }, "content": { "application/json": { "example": { "statusCode": 401, "name": "UnauthorizedError", "message": "Unauthorized" } } } }, "429": { "description": "The rate limit has been reached. Please try again later.", "headers": { "X-Ratelimit-Limit": { "description": "Number of requests available for this application.", "schema": { "type": "number" } }, "X-Ratelimit-Remaining": { "description": "Number of requests remaining in quota.", "schema": { "type": "number" } }, "X-Ratelimit-Reset": { "description": "The timestamp when the quota will reset.", "schema": { "type": "number" } } }, "content": { "application/json": { "example": { "statusCode": 429, "name": "TooManyRequests", "message": "Too Many Requests" } } } }, "500": { "description": "The server encountered an error. If this persists, please contact support", "headers": { "X-Ratelimit-Limit": { "description": "Number of requests available for this application.", "schema": { "type": "number" } }, "X-Ratelimit-Remaining": { "description": "Number of requests remaining in quota.", "schema": { "type": "number" } }, "X-Ratelimit-Reset": { "description": "The timestamp when the quota will reset.", "schema": { "type": "number" } } }, "content": { "application/json": { "example": { "statusCode": 500, "name": "InternalServerError", "message": "Internal Server Error" } } } } } } } }, "x-explorer-enabled": false, "x-samples-enabled": true, "x-samples-languages": [ "curl", "node", "go", "ruby", "python", "php" ], "x-headers": [ { "key": "Authorization", "value": "Bearer " } ] } ```