Retrieve a warehouse

Operation ID: getWarehouse

Group: Inventory › Warehouses

Open in the interactive reference

GET /inventory/warehouses/{id}

Read-only: Reads and returns; changes nothing.

Retrieves a warehouse. Use the warehouse's id, not its locationCode.

The response includes the warehouse's address, its owning legal entity, and its warehouse type. The legal entity and the warehouse type each come back as both an id and a name.

The fields are the same as on GET inventory/warehouses and POST inventory/warehouses/search. To look a warehouse up by its location code, filter GET inventory/warehouses on locationCode.

Parameters

Name In Type Required Description
Api-Version header string · v1 yes The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version v1.
id path string yes The unique identifier of the warehouse you want to retrieve.

Response

200 Success

Under data (getWarehouseOutput):

Field Type Required Description
id string yes The unique identifier for the warehouse. Example: "e1d84c07-5b39-4a26-9f70-2c8b613ad495".
locationCode string yes The location code of the warehouse, for example 'WH-01'. It is unique within the tenant. Example: "WH-01".
entityId string yes The unique identifier for the legal entity that owns this warehouse. See id on GET base/entities. Example: "81e8beb1-1415-4012-9012-8138580f43dc".
entityName string no The name of the legal entity that owns this warehouse. Example: "Acme GmbH".
warehouseTypeId string no The unique identifier for the warehouse type, which limits the document types the warehouse allows. Absent when the warehouse allows every type. There is no endpoint for it.
warehouseTypeName string no The name of the warehouse type. Absent when the warehouse allows every document type.
name string yes The site name of the warehouse, for example 'Rotterdam Distribution Center'. Example: "Rotterdam Distribution Centre".
inventoryLocationType any yes The kind of location. One of: "WAREHOUSE", "STORE", "VIRTUAL_QC", "VIRTUAL_RECEIVING", "VIRTUAL_SHIPPING", "EXTERNAL_3PL", "EXTERNAL_CONSIGNMENT". Example: "WAREHOUSE".
isActive boolean yes Whether the warehouse can be selected on new inventory documents. When false, existing stock and history keep pointing at it and new documents cannot select it. Example: true.
isPrimaryReceiving boolean no Whether this is the entity's primary receiving warehouse. Open purchase-order on-order quantity for the entity is attributed here for replenishment. At most one warehouse per entity is the primary receiving warehouse. Example: true.
addressLine1 string no The first address line: street number and name, or PO box. Absent when unset. Example: "Waalhaven 12".
addressLine2 string no The second address line: apartment, suite, unit, building or floor. Absent when unset.
city string no The city or locality. Absent when unset. Example: "Rotterdam".
stateProvince string no The state, province or region. Absent when unset.
postalCode string no The postal or ZIP code. Absent when unset. Example: "3087 BM".
countryCode string no The country of the address. Format ISO 3166-1 alpha-2, for example 'NL'. Absent when unset. Example: "NL".
region string no A free-text business region grouping, independent of country and state. Absent when unset. Example: "Benelux".
lastModifiedDate date-time no The date and time the warehouse record last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ. Example: "2026-05-12T09:30:00.000Z". 
{
  "data": {
    "id": "e1d84c07-5b39-4a26-9f70-2c8b613ad495",
    "locationCode": "WH-01",
    "entityId": "81e8beb1-1415-4012-9012-8138580f43dc",
    "entityName": "Acme GmbH",
    "warehouseTypeId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "warehouseTypeName": "<warehouseTypeName>",
    "name": "Rotterdam Distribution Centre",
    "inventoryLocationType": "WAREHOUSE",
    "isActive": true,
    "isPrimaryReceiving": true,
    "addressLine1": "Waalhaven 12",
    "addressLine2": "<addressLine2>",
    "city": "Rotterdam",
    "stateProvince": "<stateProvince>",
    "postalCode": "3087 BM",
    "countryCode": "NL",
    "region": "Benelux",
    "lastModifiedDate": "2026-05-12T09:30:00.000Z"
  },
  "diagnostics": [
    {
      "code": "<code>",
      "message": "<message>",
      "severity": "error",
      "path": [
        "<path>"
      ],
      "details": "<details>"
    }
  ]
}

Errors

Code Status
NOT_FOUND 400

Statuses