> ## 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 all Warehouses > Returns a list of `Warehouse` objects. Please see [Warehouses](https://help.shipstream.io/article/ny45i1gqf2-warehouses) in our user documentation for more information. ## OpenAPI ````yaml GET /v1/inventory/warehouses 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/warehouses: get: tags: - Warehouses summary: List all Warehouses description: >- Returns a list of `Warehouse` objects. Please see [Warehouses](https://help.shipstream.io/article/ny45i1gqf2-warehouses) in our user documentation for more information. operationId: getWarehouses parameters: - $ref: '#/components/parameters/Inventory_API_v1_warehouse-fields' - 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: - `id` - `name` - `is_active` - `abbreviation` examples: Active only: summary: Only active warehouses. value: - is_active:true Name starts with "East": summary: Only warehouses with the name starting with "East" value: - name{start:"East"} - name: sort in: query required: false schema: type: string description: >- The default sort order is **descending** by primary key (`sort=-id`). Using the [sorting syntax](/global-api/sorting-syntax), the following fields are available for sorting: - `id` - `name` - `abbreviation` - $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` `Warehouse` objects. If no warehouses are found the array will be empty. content: application/json: schema: type: object properties: collection: type: array description: A list of `Warehouse` objects. items: $ref: '#/components/schemas/Inventory_API_v1_Warehouse' 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_warehouse-fields: name: fields in: query required: false description: >- Specify additional fields of the `Warehouse` 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_warehouse-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_Warehouse: title: Warehouse type: object description: >- A `Warehouse` represents a physical location from which you can store inventory and perform operations independently of other warehouses. properties: type: type: string enum: - Warehouse readOnly: true description: >- This is a read-only property that describes the type of object in the response body. id: type: integer format: int32 example: 3 readOnly: true description: >- The internal `id` property used as a path parameter in a resource lookup. name: type: string example: East Coast 1 maxLength: 255 description: The display name for the `Warehouse`. abbreviation: type: string maxLength: 10 nullable: true example: EC1 description: >- A short abbreviation for the `Warehouse`, up to 10 characters. Recommended to be fewer than 6 characters.\ `Optional Field` is_active: type: boolean example: true description: >- This flag determines if the `Warehouse` is active and viable for fulfillment. required: - type - id additionalProperties: false 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_warehouse-fields-enum: title: Warehouse description: >- Specify additional fields of the `Warehouse` object to be included in the response. type: array items: type: string enum: - basic - all - id - name - is_active - abbreviation 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. ````