input CreateLocationsBulkInput

Fields

FieldTypeDescription
warehouse_idString!

Public API warehouse ID. Use this when passing or filtering by a warehouse; warehouse fields are display values or nested objects.

zoneString

Zone for these locations.

location_type_idString

Public API location type ID that identifies the related record. At most one of location_type_id or location_type may be set.

location_typeString

Location type name, resolved for the authenticated account. At most one of location_type_id or location_type may be set.

segments[LocationNameSegmentInput]

Describes location names as a cartesian product of segments, joined by separator. Segments are combined in the given order, with the last segment varying fastest. A segment with a single resulting value (a literal, a one-item values list, or a one-number range) produces a constant value for that position, which is how a bare name like "Damaged Inventory" is expressed: one segment, one literal value. Exactly one of segments or names must be set. The total number of names generated (the product of each segment's size) must be between 1 and 1300.

names[String]

Explicit list of location names to create. Exactly one of segments or names must be set. Must contain between 1 and 1300 unique names.

separatorString

Separator joining segments. Ignored when names is used.

pickableBoolean

Whether inventory in these locations can be picked for fulfillment.

sellableBoolean

Whether inventory in these locations counts toward sellable availability.

stagingBoolean

Sets the locations as a staging area for wholesale orders. Requires wholesale feature to be enabled for your account.

is_cartBoolean

Whether these locations are carts. Also covers transfer-cart locations - the internal model distinguishes transfer from staging carts, but this field controls both.

pick_priorityInt

Pick priority as a numeric value, shared by all created locations.

dimensionsDimensionsInput

Package or item dimensions shared by all created locations. Length, width, and height are in inches unless account or carrier configuration specifies another unit.

temperatureString

Temperature for these locations.

Referenced By

Example

{
  "warehouse_id": "V2FyZWhvdXNlOjEyMzQ=",
  "zone": "\"A\". Defaults to the same zone new locations get when zone is omitted from location_create.",
  "location_type_id": "TG9jYXRpb25UeXBlOjEyMzQ=",
  "location_type": "Bin",
  "segments": [[{literal: "A"}, {from: 1, to: 30, padding: 2}, {values: ["A", "B", "C", "D", "E"]}, {from: 1, to: 8, padding: 2}] with separator "-" generates "A-01-A-01" through "A-30-E-08".],
  "names": ["RSC 01", "RSC 02", "Receiving - 1"],
  "separator": "-",
  "pickable": true,
  "sellable": true,
  "staging": true,
  "is_cart": true,
  "pick_priority": 1,
  "dimensions": {length: 12.5, width: 8.0, height: 4.0},
  "temperature": "ambient"
}