> ## Documentation Index > Fetch the complete documentation index at: https://docs.shipstream.io/llms.txt > Use this file to discover all available pages before exploring further. # List total inventory levels > Returns a list of `TotalLevel` objects showing aggregated inventory quantities across all warehouses for each product. This endpoint provides a system-wide view of inventory, combining quantities from all warehouses where products are stocked. ## OpenAPI ````yaml GET /v1/inventory/levels/total openapi: 3.0.3 info: title: ShipStream version: '1.0' license: name: Commercial (Copyright 2025 - All Rights Reserved) url: https://shipstream.io contact: name: ShipStream Support email: help@shipstream.io termsOfService: https://shipstream.io/legal/api-terms/ servers: - url: https://{base_url_domain}/api/global description: Direct API Url variables: base_url_domain: default: example.shipstream.app description: >- The fully qualified domain name for your ShipStream WMS instance. This is either a custom domain, or a subdomain of shipstream.app, and will be the same as the domain name for the page which you use to login to ShipStream WMS. security: - ShipStream_bearerAuth: [] tags: - name: Warehouses x-displayName: Warehouses - name: Products x-displayName: Products - name: Locations x-displayName: Locations - name: Levels x-displayName: Levels - name: HoldReasons x-displayName: HoldReasons - name: Holds x-displayName: Holds - name: Deliveries description: Every thing about a Delivery Receiving x-displayName: Deliveries - name: Shipments x-displayName: Shipments - name: Orders x-displayName: Orders - name: Retailers x-displayName: Retailers - name: Users x-displayName: Users - name: User Roles x-displayName: User Roles - name: Merchants x-displayName: Merchants - name: Healthcheck x-displayName: Healthcheck paths: /v1/inventory/levels/total: get: tags: - Levels summary: List total inventory levels description: >- Returns a list of `TotalLevel` objects showing aggregated inventory quantities across all warehouses for each product. This endpoint provides a system-wide view of inventory, combining quantities from all warehouses where products are stocked. operationId: getTotalLevels parameters: - name: filter in: query schema: type: array items: type: string required: false style: form explode: true allowReserved: true description: >- Using the [filtering syntax](/global-api/filtering-syntax), you may filter the results using the following fields: **Product Fields:** - `id` - Product entity ID (alias for `product_id`) - `product_id` - Product entity ID - `sku` - Product SKU - `product_name` - Product name - `product_type` - Product type (normal, packaging, containers, supplies, infill) - `product_created_at` - Product creation date - `product_updated_at` - Product last update date - `merchant_id` - Merchant/website ID - `vendor_sku` - Vendor SKU - `external_id` - External product ID - `barcode` - Product barcode - `goods_type` - Goods classification - `is_enabled` - Product enabled status (default: true) - `is_available` - Product availability status - `is_visible` - Product visibility status **Inventory Fields:** - `updated_at` - Inventory last updated timestamp - `qty_allocated` - Quantity allocated for orders - `qty_backordered` - Quantity backordered - `qty_reserved` - Quantity reserved for picking - `qty_picked` - Quantity picked but not packed - `qty_expected` - Quantity expected from deliveries - `qty_processed` - Quantity processed from deliveries - `qty_putaway` - Quantity waiting to be put away - `qty_available` - Quantity available for allocation - `qty_held` - Quantity placed on hold (quarantined, damaged, expired, etc.) - `qty_on_hand` - Total physical quantity on hand - `qty_advertised` - Quantity advertised to customers examples: Products with inventory: summary: Only products with on-hand inventory value: - qty_on_hand{gt:0} Recently updated: summary: Inventory updated in last 24 hours value: - updated_at{from:"2025-08-27T00:00:00Z"} Specific merchant and SKU pattern: summary: Filter by merchant and SKU pattern value: - merchant_id:2 - sku{start:"ABC"} - name: sort in: query required: false schema: type: string description: >- The default sort order is **descending** by `updated_at` (`sort=-updated_at`). Using the [sorting syntax](/global-api/sorting-syntax), the following fields are available for sorting: - `product_id` - `sku` - `updated_at` - name: fields in: query required: false description: >- Specify additional fields of the `TotalLevel` object to be included in the response. explode: false schema: type: string enum: - all - product - warehouse - qty_allocated - qty_backordered - qty_reserved - qty_picked - qty_expected - qty_processed - qty_putaway - qty_available - qty_held - qty_on_hand - qty_advertised - updated_at - $ref: '#/components/parameters/Inventory_API_v1_fields-product' - $ref: '#/components/parameters/Inventory_API_v1_count' - $ref: '#/components/parameters/Inventory_API_v1_cursor_end' - $ref: '#/components/parameters/Inventory_API_v1_cursor_start' - $ref: '#/components/parameters/Inventory_API_v1_limit' responses: '200': description: >- A dictionary with a `collection` property that contains an array of up to `limit` `TotalLevel` objects. If no inventory levels are found the array will be empty. content: application/json: schema: type: object properties: collection: type: array description: A list of `TotalLevel` objects. items: $ref: '#/components/schemas/Inventory_API_v1_TotalLevel' included: type: object description: >- Lists of referenced objects included by specifying optional fields. See the [selecting fields](/global-api/selecting-fields) page for more information. properties: Product: type: array items: $ref: '#/components/schemas/Inventory_API_v1_Product' has_more: $ref: '#/components/schemas/Inventory_API_v1_has_more' next: $ref: '#/components/schemas/Inventory_API_v1_next' previous: $ref: '#/components/schemas/Inventory_API_v1_previous' meta: $ref: '#/components/schemas/Inventory_API_v1_meta' '400': $ref: '#/components/responses/Inventory_API_v1_400-bad-request' '422': $ref: '#/components/responses/Inventory_API_v1_422-unprocessable' '500': $ref: '#/components/responses/Inventory_API_v1_500-internal-server-error' components: parameters: Inventory_API_v1_fields-product: name: fields:product in: query required: false description: >- Specify additional fields of the `Product` or `Packaging*` object to be included in the response. See the [selecting fields](/global-api/selecting-fields) page for more information. explode: false schema: $ref: '#/components/schemas/Inventory_API_v1_product-packaging-fields-enum' Inventory_API_v1_count: name: count in: query description: >- If specified as `1`, the `meta.count` property of the response will be present and populated with the total count of items matching the query before any paging is applied. This is not included by default to improve performance in some edge cases and is not required to perform paging using the `next` property of the response. See [paging parameters](/global-api/paging-parameters) for more information. style: form schema: type: integer minimum: 0 maximum: 1 Inventory_API_v1_cursor_end: name: cursor_end in: query description: >- A cursor for use in pagination which defines the last `id` of the next page of results, non-inclusive. See [paging parameters](/global-api/paging-parameters) for more information on paging. schema: type: integer style: form Inventory_API_v1_cursor_start: name: cursor_start in: query description: >- A cursor for use in pagination which defines the starting `id` of the next page of results. See [paging parameters](/global-api/paging-parameters) for more information on paging. schema: type: integer style: form Inventory_API_v1_limit: name: limit in: query description: A limit on the number of objects to be returned. style: form schema: type: integer example: 100 default: 100 minimum: 1 maximum: 1000 schemas: Inventory_API_v1_TotalLevel: title: TotalLevel allOf: - type: object properties: type: type: string enum: - TotalLevel description: Resource type identifier product: allOf: - description: Reference to the product - $ref: '#/components/schemas/Inventory_API_v1_StockableProductRef' qty_backordered: type: number format: float description: Quantity backordered example: 5 required: - type - product - qty_backordered - $ref: '#/components/schemas/Inventory_API_v1_Levels' description: >- Total inventory levels aggregated across all warehouses for a specific product. This provides a system-wide view of inventory quantities, combining data from all warehouses where the product is stocked. example: type: TotalLevel product: type: Product id: 5 sku: ABC123 qty_allocated: 15 qty_backordered: 0 qty_reserved: 7 qty_picked: 2 qty_expected: 100 qty_processed: 0 qty_putaway: 50 qty_available: 166 qty_on_hand: 230 qty_advertised: 195 updated_at: '2025-08-28T10:30:00Z' Inventory_API_v1_Product: title: Product description: A Product contains information about a sellable item. allOf: - type: object properties: type: type: string enum: - Product description: This property describes the type of object in the response body. id: type: integer description: >- The internal, read-only, `id` property used as a path parameter in a resource lookup. readOnly: true vendor_sku: type: string description: >- For informational use only. Displayed during delivery processing to help match products.\ `Optional Field` nullable: true example: Vendor-SKU-1AD2 external_id: type: string nullable: true example: 11-993-9048 description: May be used for external product sync. barcodes: anyOf: - type: array items: type: string nullable: true example: - 956623520-4 - O-VS-Oregano-p3 - type: string nullable: true example: 956623520-4 description: A comma separated list of unique packaging feature barcodes. goods_type: type: string enum: - NORMAL - ORM_D - LIMITED_QUANTITIES_COMMODITIES - HAZMAT description: >- This defines the regulations, if any, assigned to a `Product`. - `NORMAL` Not Regulated - `ORM_D` ORM-D - `LIMITED_QUANTITIES_COMMODITIES` Limited Quantities: Consumer Commodity - `HAZMAT` Regulated is_available: type: boolean enum: - true - false default: true description: This flag must be `true` to allow the `Product` to be ordered. is_visible: type: boolean enum: - true - false default: true description: >- This flag must be `true` to show the `Product` in the inventory feed. lot_type: allOf: - $ref: '#/components/schemas/Inventory_API_v1_LotTypeRef' - description: >- This `LotType` determines how a `Product` should be "burned" and whether lots with dissimilar data can be "mixed".\ `Optional Field` weight: allOf: - $ref: '#/components/schemas/Inventory_API_v1_Weight' - description: >- This object defines the weight of the `Product` in imperial or metric units.\ `Optional Field` dimensions: allOf: - $ref: '#/components/schemas/Inventory_API_v1_Dimensions' - description: >- This object defines the length, width, and height of the `Product` in imperial or metric units.\ `Optional Field` volume: allOf: - $ref: '#/components/schemas/Inventory_API_v1_Volume' - description: >- This object defines the cubic size of the `Product` in imperial or metric units.\ `Optional Field` inventory: allOf: - $ref: '#/components/schemas/Inventory_API_v1_Inventory' - description: >- This object describes how the `Product` Stock is defined, such as real config values, or Virtual Inventory, and how to handle Backorders.\ `Optional Field` export: allOf: - $ref: '#/components/schemas/Inventory_API_v1_Export' - description: >- This object contains fields for describing and codifying an internationally exportable `Product`.\ `Optional Field` regulated_goods: allOf: - $ref: '#/components/schemas/Inventory_API_v1_RegulatedGoods' - description: >- This object only applies a `Product` using the "Regulated" Goods Type, and describes the `Regulation` and container specifications for the `Product`.\ `Optional Field` packaging: allOf: - $ref: '#/components/schemas/Inventory_API_v1_Packaging' - description: >- This object defines how the shipping container/box for the `Product` is to be processed and whether there are any special instructions during packing.\ `Optional Field` custom_fields: allOf: - $ref: '#/components/schemas/Inventory_API_v1_custom_fields' - description: >- This will set any Product Attributes, pre-defined by the user, for the `Product`.\ `Optional Field` - $ref: '#/components/schemas/Inventory_API_v1_AbstractProduct' Inventory_API_v1_has_more: type: boolean description: |- True if the collection has more items on the next page. Use the "next" link to retrieve the next page of results. Inventory_API_v1_next: type: string nullable: true description: The resource path for the next page of results if any are expected. Inventory_API_v1_previous: type: string nullable: true description: The resource path for the previous page of results if any are expected. Inventory_API_v1_meta: type: object properties: processing_time: type: number description: Total time in which request is processed and response is sent back. example: 0.2525252525 cursor_start: type: integer description: >- A cursor for use in pagination which defines the starting `id` of the next page of results. See [paging parameters](/global-api/paging-parameters) for more information on paging. nullable: true cursor_end: type: integer description: >- A cursor for use in pagination which defines the last `id` of the next page of results, non-inclusive. See [paging parameters](/global-api/paging-parameters) for more information on paging. nullable: true count: type: integer description: >- The total number of items matching the query before applying paging parameters. This field is only present if the query parameter `count=1` is present in the request. description: Additional metadata pertaining to the response. Inventory_API_v1_product-packaging-fields-enum: title: Product Or Packaging description: >- Specify additional fields of the `Product` or `Packaging*` object to be included in the response. type: array items: type: string enum: - basic - all - created_at - updated_at - container_options - supplies_options - data_collection_options - instruction_options - infill_options - vendor_sku - external_id - barcodes - goods_type - is_available - is_visible - weight - dimensions - volume - inventory - export - regulated_goods - packaging - custom_fields Inventory_API_v1_StockableProductRef: title: StockableProductRef type: object description: A reference to a `Product` or stockable packaging type object by `id`. properties: type: type: string description: >- This is a read-only property that describes the type of object in the response body. enum: - Product - PackagingContainer - PackagingInfill - PackagingSupplies id: type: integer description: >- The internal, read-only, `id` property used as a path parameter in a resource lookup. format: int32 required: - type - id nullable: true additionalProperties: false Inventory_API_v1_Levels: title: Levels type: object description: Base inventory quantity fields shared by all inventory level types. properties: qty_allocated: type: number format: float description: Quantity allocated for orders example: 10.5 qty_reserved: type: number format: float description: Quantity reserved for picking example: 15.25 qty_picked: type: number format: float description: Quantity picked but not packed example: 8 qty_expected: type: number format: float description: Quantity expected from deliveries example: 100 qty_processed: type: number format: float description: Quantity processed from deliveries but not put-away example: 75.5 qty_putaway: type: number format: float description: Quantity waiting to be put away example: 25 qty_available: type: number format: float description: Quantity available for allocation example: 150.75 qty_held: type: number format: float description: > Quantity placed on hold (e.g. quarantined, damaged, expired). Excluded from `qty_advertised` and unavailable for allocation, but still counted in `qty_on_hand` because it is physically present in the warehouse. example: 12 qty_on_hand: type: number format: float description: Total physical quantity on hand example: 200 qty_advertised: type: integer nullable: true description: Quantity advertised to customers example: 180 updated_at: type: string format: date-time description: When inventory was last updated example: '2025-08-28T10:30:00Z' required: - qty_allocated - qty_reserved - qty_picked - qty_expected - qty_processed - qty_putaway - qty_available - qty_held - qty_on_hand - updated_at Inventory_API_v1_LotTypeRef: title: LotTypeRef description: LotType type: object properties: type: type: string enum: - LotType description: This property describes the type of object in the response body. id: type: integer format: int64 description: >- The internal `id` property used as a path parameter in a resource lookup. example: 4 required: - type - id nullable: true additionalProperties: false Inventory_API_v1_Weight: title: Weight type: object nullable: true properties: value: type: number description: >- The weight quantity defined as a floating point value of up to 4 decimal places. format: float example: 20 unit: $ref: '#/components/schemas/Inventory_API_v1_WeightUnit' Inventory_API_v1_Dimensions: title: Dimensions type: object nullable: true properties: length: type: number description: >- This distance value is usually assigned to the longest side of the object and is defined as a floating-point number up to 4 decimal places. format: float example: 8 width: type: number description: >- This value describes the horizontal distance of the subject defined as a floating-point number up to 4 decimal places. format: float example: 6 height: type: number description: >- This value describes the vertical distance of the subject defined as a floating-point number up to 4 decimal places. format: float example: 4 unit: $ref: '#/components/schemas/Inventory_API_v1_LengthUnit' Inventory_API_v1_Volume: title: Volume type: object nullable: true properties: value: type: number description: >- This value describes the cubic size of the subject as a floating-point number up to 4 decimal places. format: float example: 300 unit: $ref: '#/components/schemas/Inventory_API_v1_VolumeUnit' Inventory_API_v1_Inventory: title: Inventory type: object description: Product Inventory information properties: backorders: description: >- This determines if `Product` that is no longer in stock may be backordered or whether or not to use ShipStream's scoped configurations. anyOf: - type: boolean example: true - type: string enum: - use_config dynamic_allocation: description: >- This will allow the `Product` to source from inventory in other warehouses in real-time if enabled, and can be set to use ShipStream's scoped configurations. anyOf: - type: boolean example: true - type: string enum: - use_config virtual_inventory: type: string description: >- This is the method used to predict an esitmate of inventory available when kitting from the `Product`. enum: - none - optimistic - realistic - pessimistic example: optimistic Inventory_API_v1_Export: title: Export type: object description: Product Export and Custom information properties: description: type: string description: >- This is used to describe in detail the `Product` for international shipping and customs regulations. nullable: true example: Plastic children's toy with steel weights and ball bearings customs_value: allOf: - $ref: '#/components/schemas/Inventory_API_v1_Monetary' - description: >- The value of the products the purpose of calculating duties and taxes in the destination country. country_of_manufacture: type: string nullable: true description: 2 letters Country ISO Code example: TW hs_base_code: type: string description: >- This is the Harmonized System Code (HS Code); a standardized numerical method of classifying traded products. These are 6 digit codes in the format \#\#\#.\#\# which are associated with a standard HS Code Description. nullable: true example: '8518.30' hs_country_extension: $ref: '#/components/schemas/Inventory_API_v1_country_extension' Inventory_API_v1_RegulatedGoods: title: RegulatedGoods type: object description: Product Regulation Information properties: regulation: $ref: '#/components/schemas/Inventory_API_v1_RegulationRef' technical_name: type: string nullable: true description: Must match against Regulation's Technical Name Pattern if specified. example: Hydro Polymer Acetylene Coating additional_information: type: string nullable: true description: >- Must match against Regulation's Additional Regulatory Information Pattern if specified. example: Flamable Liquid net_weight: $ref: '#/components/schemas/Inventory_API_v1_Weight' container_type: $ref: '#/components/schemas/Inventory_API_v1_container_type' container_meets_hazmat_specs: type: boolean description: >- This flag indicates that the `RegulatedGoods` container is sufficient for a regulated (HAZMAT) product. example: true regulation_units: type: number description: >- These units are arbitrary and should be relative to the Regulation's Pickup Weight Limit. E.g. it could be in pounds, kilowatt/hours, etc. format: float example: 5 Inventory_API_v1_Packaging: title: Packaging type: object description: Product Packaging information properties: require_packaging: allOf: - $ref: '#/components/schemas/Inventory_API_v1_boolean' - description: >- If Yes, packaging will require a Box with "Satisfies Overbox: Yes". require_weight_check: allOf: - $ref: '#/components/schemas/Inventory_API_v1_boolean' - description: >- If Yes, the associated product will require the use of a scale to verify that the package's weight falls within the expected amount. If this is set to No, this step will be skipped by the packer. require_confirmation_per_item: allOf: - $ref: '#/components/schemas/Inventory_API_v1_boolean' - description: >- If Yes, Packaging Products with "One Scan Per: Item" will require a scan for each item packed rather than just one for the first item in a package. unit_quantity: type: integer example: 1 nullable: true description: >- Number of individually packaged items contained therein for purposes of special packaging features. bulk_quantity: type: integer nullable: true example: 10 description: >- Prefer to split into packages when necessary using multiples of this amount. max_per_package: type: integer nullable: true example: 15 description: >- The maximum quantity of this product to ever include in the same package. Multiply by "Unit Quantity" to achieve common units between other products with the same "Ship Separate Tag" value. is_ship_separately: allOf: - $ref: '#/components/schemas/Inventory_API_v1_boolean' - description: >- This item cannot ship in the same package as other items (unless they have the same "Ship Separate Tag"). ship_separately_tag: type: string nullable: true description: >- Applies only if "Ship Separate" is "Yes". Assign the same tag to treat similar products as interchangeable with respect to the "Ship Separate" and "Max Per Package" attribute. example: PVC can_tip: allOf: - $ref: '#/components/schemas/Inventory_API_v1_boolean' - description: >- If Yes, the item is allowed to be rotated vertically when packed. can_contain_other_items: allOf: - $ref: '#/components/schemas/Inventory_API_v1_boolean' - description: >- If Yes then other smaller items are allowed to be placed within this larger item. This is useful when the item is hollow or is a bin/bucket. is_handling_surcharge: allOf: - $ref: '#/components/schemas/Inventory_API_v1_boolean' - description: >- The Packaging Surcharge is applicable when shipped without an Overbox. Inventory_API_v1_custom_fields: type: array description: Custom field values as an array of code/value pairs. items: type: object properties: code: type: string description: The custom field code/identifier. value: description: The field value (type depends on field configuration). label: type: string description: For select fields, the display label of the selected option. options: type: object description: For multiselect fields, a map of option IDs to labels. additionalProperties: type: string required: - code example: - code: color value: 13 label: Red and Black - code: cost_of_goods value: 41.32 - code: allow_mailer value: true Inventory_API_v1_AbstractProduct: type: object properties: sku: type: string description: >- The Stock Keeping Unit (SKU) is a unique identifier for the `Product`. example: SKU-1AD name: type: string description: This is displayed as a short, descriptive title for the `Product`. example: Test Product is_enabled: type: boolean description: Disabled products are effectively deleted. enum: - true - false default: true merchant: allOf: - $ref: '#/components/schemas/Inventory_API_v1_MerchantRef' - description: The `Merchant` to which the product belongs. created_at: $ref: '#/components/schemas/Inventory_API_v1_created_at-optional' updated_at: $ref: '#/components/schemas/Inventory_API_v1_updated_at-optional' Inventory_API_v1_WeightUnit: type: string description: This can be an imperial or metric unit for weight. enum: - lb - oz - kg - g Inventory_API_v1_LengthUnit: type: string description: The imperical or metric unit of measurement. enum: - in - mm - cm - m Inventory_API_v1_VolumeUnit: type: string description: The imperical or metric unit of measurement as a cubic value. enum: - in^3 - mm^3 - cm^3 - m^3 Inventory_API_v1_Monetary: title: Monetary type: object nullable: true properties: amount: type: number description: This is the monetary value.. format: float example: 99 currency: type: string description: An ISO 3166-1 alpha-3 currency code. example: USD Inventory_API_v1_country_extension: type: array nullable: true items: type: object properties: country_id: type: string description: This is the two-digit ISO (Alpha-2) country code. extension: type: string description: >- This is the Schedule C Country Code; a 4 digit code that identifies a country. example: - country_id: TW extension: '002' - country_id: US extension: '011' Inventory_API_v1_RegulationRef: title: Regulation type: object description: A reference to a `Regulation` by `id`. properties: type: type: string enum: - Regulation description: This property describes the type of object in the response body. id: type: integer description: >- The internal `id` property used as a path parameter in a resource lookup. required: - type - id nullable: true additionalProperties: false Inventory_API_v1_container_type: type: string nullable: true description: >- The Overpack Container Type can be a combination of material and container type such as Aluminum Box, Steel Drum, or a combination of a material and container type from these two lists: - `Material:` Aluminum, Fiberboard, Glass, Plywood, Plastic, Steel, Wood - `Container:` Bag, Bottle, Box, Bucket, Cylinder, Drum, Jerrican, Pail example: Plastic Box Inventory_API_v1_boolean: type: boolean enum: - true - false example: true Inventory_API_v1_MerchantRef: title: MerchantRef type: object description: Reference a `Merchant` by `id`. properties: type: type: string enum: - Merchant id: type: integer format: int32 example: 4 description: >- The internal `id` property used as a path parameter in a resource lookup. required: - type - id additionalProperties: false Inventory_API_v1_created_at-optional: type: string format: date-time description: >- The date and time the object was created in RFC 3339 section 5.6 notation.\ `Optional Field` example: '2017-07-21T17:32:28Z' nullable: true readOnly: true Inventory_API_v1_updated_at-optional: type: string format: date-time description: >- The date and time the object was last updated in RFC 3339 section 5.6 notation. example: '2017-07-21T17:39:43Z' nullable: true readOnly: true responses: Inventory_API_v1_400-bad-request: description: >- The request was invalid. The client must change the request. See the response body for more details. content: application/json: schema: type: object properties: errors: type: array items: type: object properties: type: type: string description: The error type code. enum: - parser - parameters - openapi message: type: string description: An English sentence describing the error type. details: type: array description: >- An array of objects describing which keys are responsible for the error and detailed messages describing why they are not valid. items: type: object properties: key: type: string description: The path to the key which relates to the error. message: type: string description: >- An English sentence describing the details of the error. additionalProperties: false additionalProperties: false minItems: 1 additionalProperties: false example: errors: - type: parameters message: The supplied parameters are invalid. details: - key: hold_until_date message: The date must be in the future. Inventory_API_v1_422-unprocessable: description: >- There was an error processing the request. See the response body for more details. content: application/json: schema: type: object properties: errors: type: array items: type: object properties: type: type: string description: The error type code. enum: - application - unable_to_process message: type: string description: An English sentence describing the error type. details: type: array description: >- An array of objects describing which keys are responsible for the error and detailed messages describing why they are not valid. items: type: object properties: key: type: string description: The path to the key which relates to the error. message: type: string description: >- An English sentence describing the details of the error. additionalProperties: false additionalProperties: false minItems: 1 additionalProperties: false example: errors: - type: unable_to_process message: The supplied parameters are invalid. details: - key: hold_until_date message: The date must be in the future. Inventory_API_v1_500-internal-server-error: description: >- Internal Server Error - Something wrong happened at server side. Contact server administrator for more details. securitySchemes: ShipStream_bearerAuth: type: http scheme: bearer bearerFormat: JWT description: >- Generate a JWT access token through a Custom Global Integration and provide it with each request in the `Authorization` header prefixed with "Bearer" and then a single space. ````