Update a warehouse

Operation ID: updateWarehouse

Group: Inventory › Warehouses

Open in the interactive reference

PATCH /inventory/warehouses/{id}

Retry-safe: A write that accepts Idempotency-Key: repeating a request with the same key replays the stored answer instead of executing twice.

Updates a warehouse with the fields you send. A field you leave out keeps its current value.

Use the warehouse's id, not its locationCode.

To clear warehouseTypeId, send null.

Changes a warehouse's code, name, kind, address, status, isPrimaryReceiving, legal entity, or warehouse type. A warehouse that already has inventory transactions can't be moved to another legal entity, and the request fails with a validation error.

The response is only the warehouse's id. To see the updated warehouse, use GET inventory/warehouses/:id.

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.
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.
id path string yes The unique identifier of the warehouse you want to update.

Request body

Required, application/json: updateWarehouseInput.

Field Type Required Description
locationCode string no The location code of the warehouse, for example 'WH-01'. It must stay unique within the tenant. Reusing the warehouse's own current code is not a collision.
name string no The site name of the warehouse.
entityId string no The unique identifier for the legal entity that owns this warehouse. See id on GET base/entities. A warehouse that already has inventory transactions cannot be moved to another entity: the platform refuses it and the call fails with a validation error.
inventoryLocationType any no The kind of location. One of: "WAREHOUSE", "STORE", "VIRTUAL_QC", "VIRTUAL_RECEIVING", "VIRTUAL_SHIPPING", "EXTERNAL_3PL", "EXTERNAL_CONSIGNMENT".
isActive boolean no Whether the warehouse can be selected on new inventory documents. Set it to false to retire the warehouse without deleting it: its stock, transactions and bins keep pointing at it and new documents cannot select it. Example: false.
isPrimaryReceiving boolean no Whether this is the entity's primary receiving warehouse. At most one warehouse per entity is meant to be the primary receiving warehouse. It is not enforced.
warehouseTypeId string | null no The unique identifier for the warehouse type, which limits the document types the warehouse allows. Pass null to clear it, which lets the warehouse allow every document type again. 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. 
{
  "locationCode": "<locationCode>",
  "name": "<name>",
  "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "inventoryLocationType": "WAREHOUSE",
  "isActive": false,
  "isPrimaryReceiving": true,
  "warehouseTypeId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "addressLine1": "<addressLine1>",
  "addressLine2": "<addressLine2>",
  "city": "<city>",
  "stateProvince": "<stateProvince>",
  "postalCode": "<postalCode>",
  "countryCode": "<countryCode>",
  "region": "<region>"
}

Response

200 Success

Under data (updateWarehouseOutput):

Field Type Required Description
id string yes The unique identifier for the warehouse. Example: "e1d84c07-5b39-4a26-9f70-2c8b613ad495". 
{
  "data": {
    "id": "e1d84c07-5b39-4a26-9f70-2c8b613ad495"
  },
  "diagnostics": [
    {
      "code": "<code>",
      "message": "<message>",
      "severity": "error",
      "path": [
        "<path>"
      ],
      "details": "<details>"
    }
  ]
}

Response headers

Errors

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

Statuses