Bulk create warehouses

Operation ID: bulkCreateWarehouses

Group: Inventory › Warehouses

Open in the interactive reference

POST /inventory/warehouses/bulk

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

Creates multiple warehouses in one request. If any warehouse can't be created, none are. 'index' on an error is that warehouse's position in the request, counting from zero.

The response has the id of each created warehouse, in the order you sent them. To create one warehouse, use POST inventory/warehouses.

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.

Request body

Required, application/json: bulkCreateWarehousesInput.

Field Type Required Description
warehouses array<object> yes The warehouses to create. If any entry is invalid, nothing is created and the whole call fails. Example: [{"locationCode":"WH-01","name":"Rotterdam Distribution Centre","entityId":"3f9c1e28-7b45-4d60-a913-5e07c286bd41","inventoryLocationType":"WAREHOUSE","countryCode":"NL"},{"locationCode":"WH-02","name":"Antwerp Overflow","entityId":"3f9c1e28-7b45-4d60-a913-5e07c286bd41","inventoryLocationType":"WAREHOUSE","countryCode":"BE"}].
warehouses[].locationCode string yes The location code of the warehouse, for example 'WH-01'. Required. It must be unique within the tenant and within this request.
warehouses[].name string yes The site name of the warehouse, for example 'Rotterdam Distribution Center'. Required.
warehouses[].entityId string yes The unique identifier for the legal entity that owns this warehouse. Required. An unknown identifier fails the whole call with ENTITY_NOT_FOUND, which names this entry's index. See id on GET base/entities.
warehouses[].inventoryLocationType any yes The kind of location. Required. One of: "WAREHOUSE", "STORE", "VIRTUAL_QC", "VIRTUAL_RECEIVING", "VIRTUAL_SHIPPING", "EXTERNAL_3PL", "EXTERNAL_CONSIGNMENT".
warehouses[].isActive boolean no Whether the warehouse can be selected on new inventory documents. Defaults to true.
warehouses[].isPrimaryReceiving boolean no Whether this is the entity's primary receiving warehouse. Defaults to false. At most one warehouse per entity is meant to be the primary receiving warehouse. It is not enforced, and a request setting it on several is accepted.
warehouses[].warehouseTypeId string no The unique identifier for the warehouse type, which limits the document types the warehouse allows. Omit to allow every document type. There is no endpoint for it.
warehouses[].addressLine1 string no The first address line: street number and name, or PO box.
warehouses[].addressLine2 string no The second address line: apartment, suite, unit, building or floor.
warehouses[].city string no The city or locality.
warehouses[].stateProvince string no The state, province or region.
warehouses[].postalCode string no The postal or ZIP code.
warehouses[].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.
warehouses[].region string no A free-text business region grouping, independent of country and state. 
{
  "warehouses": [
    {
      "locationCode": "WH-01",
      "name": "Rotterdam Distribution Centre",
      "entityId": "3f9c1e28-7b45-4d60-a913-5e07c286bd41",
      "inventoryLocationType": "WAREHOUSE",
      "countryCode": "NL"
    },
    {
      "locationCode": "WH-02",
      "name": "Antwerp Overflow",
      "entityId": "3f9c1e28-7b45-4d60-a913-5e07c286bd41",
      "inventoryLocationType": "WAREHOUSE",
      "countryCode": "BE"
    }
  ]
}

Response

200 Success

Under data (bulkCreateWarehousesOutput):

Field Type Required Description
created array<object> yes The created warehouses, in the same order as the input. Match entries to inputs by index. Example: [{"id":"e1d84c07-5b39-4a26-9f70-2c8b613ad495"},{"id":"b5390f6a-1c72-4e84-9a03-8f2d61c74e59"}].
created[].id string yes The unique identifier for the created warehouse. 
{
  "data": {
    "created": [
      {
        "id": "e1d84c07-5b39-4a26-9f70-2c8b613ad495"
      },
      {
        "id": "b5390f6a-1c72-4e84-9a03-8f2d61c74e59"
      }
    ]
  },
  "diagnostics": [
    {
      "code": "<code>",
      "message": "<message>",
      "severity": "error",
      "path": [
        "<path>"
      ],
      "details": "<details>"
    }
  ]
}

Response headers

Errors

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

Statuses