Creates a warehouse.

POST /inventory/warehouses

Group: Inventory › Warehouses · Operation ID: createWarehouse

The response is only the created warehouse's id. Read the record with GET inventory/warehouses/:id when you need its stored state. Use POST inventory/warehouses/bulk to create several at once.

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.
Idempotency-Key header string no An opaque caller-chosen string (1-255 characters) that makes this request safe to retry. Repeating the same key with an identical request body replays the original response instead of re-executing - but only once that original request succeeded; a failed attempt re-executes on retry. Repeating the key with a different body is answered with 422. A key still in flight is answered with 409 - as is a key whose original request was interrupted before it finished, for a few minutes afterwards, until that attempt is presumed dead. A completed response stays replayable for 24 hours. The key is scoped to the caller, not to the action: reusing it for a different action is answered with 409 or 422 rather than treated independently. On read actions this header is ignored. On write actions that cannot offer the guarantee it is answered with 400 IDEMPOTENCY_NOT_SUPPORTED rather than silently ignored.

Request body

Required, application/json: createWarehouseInput.

Field Type Required Description
locationCode string yes The location code of the warehouse, for example 'WH-01'. Required. It must be unique within the tenant.
name string yes The site name of the warehouse, for example 'Rotterdam Distribution Center'. Required.
entityId string yes The unique identifier for the legal entity that owns this warehouse. Required. An unknown identifier fails the call with ENTITY_NOT_FOUND. See id on GET base/entities.
inventoryLocationType string, one of "WAREHOUSE", "STORE", "VIRTUAL_QC", "VIRTUAL_RECEIVING", "VIRTUAL_SHIPPING", "EXTERNAL_3PL", "EXTERNAL_CONSIGNMENT" yes The kind of location. Required.
isActive boolean no Whether the warehouse can be selected on new inventory documents. Defaults to true. Set it to false to stage a warehouse before it goes into use.
isPrimaryReceiving boolean no Whether this is the entity's primary receiving warehouse, where open purchase-order on-order quantity is attributed for replenishment. Defaults to false. At most one warehouse per entity is meant to be the primary receiving warehouse. It is not enforced, and setting it on a second warehouse is accepted.
warehouseTypeId string no The unique identifier for the warehouse type, which limits the document types the warehouse allows. Omit to allow every document type. An unknown identifier fails the call with WAREHOUSE_TYPE_NOT_FOUND. There is no endpoint for it.
addressLine1 string no The first address line: street number and name, or PO box.
addressLine2 string no The second address line: apartment, suite, unit, building or floor.
city string no The city or locality.
stateProvince string no The state, province or region.
postalCode string no The postal or ZIP code.
countryCode string no The country of the address. Format ISO 3166-1 alpha-2, for example 'NL'. It is not validated against the ISO list.
region string no A free-text business region grouping, independent of country and state.

Example:

{
  "locationCode": "WH-01",
  "name": "Rotterdam Distribution Centre",
  "entityId": "3f9c1e28-7b45-4d60-a913-5e07c286bd41",
  "inventoryLocationType": "WAREHOUSE",
  "isActive": true,
  "isPrimaryReceiving": true,
  "warehouseTypeId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "addressLine1": "Waalhaven 12",
  "addressLine2": "<addressLine2>",
  "city": "Rotterdam",
  "stateProvince": "<stateProvince>",
  "postalCode": "3087 BM",
  "countryCode": "NL",
  "region": "Benelux"
}

Response

200 Success

Under data (createWarehouseOutput):

Field Type Required Description
id string yes The unique identifier for the created warehouse.

Response headers

Errors

Code Status
DUPLICATE_LOCATION_CODE 400
ENTITY_NOT_FOUND 400
WAREHOUSE_TYPE_NOT_FOUND 400
IDEMPOTENCY_KEY_CONFLICT 409
IDEMPOTENCY_PAYLOAD_MISMATCH 422

Statuses