Skip to content
HeyX API

Create Inventory Location

POST /public-api/publicapi.v1.Inventory/CreateInventoryLocation

Requires inventory write access and inventory_location:create. Creates an active, non-default location. Discover existing location IDs through SearchInventoryLocations.

{ "name": "Receiving bay", "code": "RECV-01", "type": "staging" }

Name must be nonblank and at most 200 characters; code is optional, maximum 200. Type is warehouse (default), bin, vehicle, staging, returns, or other. Optional parentId is a workspace inventory location UUID. Returns location. These IDs are not customer location data-field IDs used by work orders.

This is not idempotent. There is no public location update/archive/default-setting operation in this batch. Do not blindly retry creation after a timeout.

Generated Reference
POST /public-api/publicapi.v1.Inventory/CreateInventoryLocation

Creates an active, non-default location. Not idempotent.

Request CreateInventoryLocationRequest
Response CreateInventoryLocationResponse

CreateInventoryLocationRequest

Field Type Description
name string
code string
type string Empty defaults to warehouse.
parent_id optional string

CreateInventoryLocationResponse

Field Type
location InventoryLocation

Related Types

InventoryLocation

Field Type
id string
name string
code string
type string
parent_id string
is_active bool
HeyX API