Returns the warehouse with the given identifier.

GET /inventory/warehouses/{id}

Group: Inventory › Warehouses · Operation ID: getWarehouse

The response has the same fields as GET inventory/warehouses and POST inventory/warehouses/search. The owning entity and the warehouse type are each returned as both an identifier and a name. To look a warehouse up by its code instead of its id, filter the collection GET inventory/warehouses on locationCode.

Open in the interactive reference

Parameters

Name In Type Required Description
Api-Version header "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 for the warehouse to return.

Response

200 Success

Under data (getWarehouseOutput):

Field Type Required Description
id string yes The unique identifier for the warehouse.
locationCode string yes The location code of the warehouse, for example 'WH-01'. It is unique within the tenant.
entityId string yes The unique identifier for the legal entity that owns this warehouse. See id on GET base/entities.
entityName string no The name of the legal entity that owns this warehouse.
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'.
inventoryLocationType string, one of "WAREHOUSE", "STORE", "VIRTUAL_QC", "VIRTUAL_RECEIVING", "VIRTUAL_SHIPPING", "EXTERNAL_3PL", "EXTERNAL_CONSIGNMENT" yes The kind of location.
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.
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.
addressLine1 string no The first address line: street number and name, or PO box. Absent when unset.
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.
stateProvince string no The state, province or region. Absent when unset.
postalCode string no The postal or ZIP code. Absent when unset.
countryCode string no The country of the address. Format ISO 3166-1 alpha-2, for example 'NL'. Absent when unset.
region string no A free-text business region grouping, independent of country and state. Absent when unset.
lastModifiedDate string (date-time) no The date and time the warehouse record last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.

Errors

Code Status
NOT_FOUND 400

Statuses