Skip to main content
GET
/
v1
/
inventory
/
warehouses
/
{id}
/
locations
List all Locations
curl --request GET \
  --url https://{base_url_domain}/api/global/v1/inventory/warehouses/{id}/locations \
  --header 'Authorization: Bearer <token>'
{
  "collection": [
    {
      "type": "Location",
      "id": 42,
      "label": "A4-55-C3",
      "priority": 10,
      "qty_putaway": 10,
      "qty_unreserved": 20,
      "qty_reserved": 4,
      "qty_on_hand": 34,
      "qty_locked": 4,
      "is_temp": false,
      "is_pickable": true,
      "is_type_auto": true,
      "created_at": "2021-11-17T14:32:44Z",
      "updated_at": "2021-11-17T14:32:44Z",
      "last_cyclecount_at": "2021-11-17T14:32:44Z",
      "lot": {
        "type": "Lot",
        "id": 54
      },
      "product": {
        "type": "Product",
        "id": 123
      },
      "rack": {
        "type": "Rack",
        "id": 123
      },
      "location_type": {
        "type": "LocationType",
        "id": 54
      }
    }
  ],
  "included": {
    "LocationType": [
      {
        "type": "LocationType",
        "id": 54,
        "name": "Pickable Pallets",
        "is_pickable": false
      }
    ],
    "Lot": [
      {
        "type": "Lot",
        "id": 54
      }
    ],
    "LotType": [
      {
        "type": "LotType",
        "id": 4,
        "name": "MixFulfillment-Extract-Choose-FEFO",
        "allow_mixing_locations": true,
        "allow_mixing_fulfillment": true,
        "lot_number_input": "text",
        "lot_number_example": "AB190405G",
        "lot_number_pattern": "^([A-Z]{2}-[0-9]+)$",
        "lot_number_replacement": "$2$1",
        "expiration_date": "lot_number_date",
        "burn_order": "fefo",
        "created_at": "2017-07-21T17:32:28Z",
        "updated_at": "2017-07-21T17:39:43Z"
      }
    ],
    "Merchant": [
      {
        "type": "Merchant",
        "id": 4,
        "code": "acme_inc",
        "name": "ACME Inc.",
        "status": "active",
        "created_at": "2017-07-21T17:32:28Z",
        "updated_at": "2017-07-21T17:39:43Z",
        "brands": [
          {
            "type": "Brand",
            "id": 4
          }
        ],
        "default_brand": {
          "type": "Brand",
          "id": 4
        }
      }
    ],
    "PackagingContainer": [
      {
        "type": "PackagingContainer",
        "id": 123,
        "container_options": {
          "barcodes": "956623520-4",
          "weight": {
            "value": 20,
            "unit": "lb"
          },
          "dimensions": {
            "length": 8,
            "width": 6,
            "height": 4,
            "unit": "in"
          },
          "volume": {
            "value": 300,
            "unit": "in^3"
          },
          "manage_stock": true,
          "associated_products": [
            {
              "type": "Product",
              "id": 3
            }
          ],
          "allow_for_brands": [
            {
              "type": "Merchant",
              "id": 4
            }
          ],
          "disallow_for_brands": [
            {
              "type": "Merchant",
              "id": 4
            }
          ],
          "billing_amount": {
            "amount": 99,
            "currency": "USD"
          },
          "allow_for_warehouses": [
            {
              "type": "Warehouse",
              "id": 123
            }
          ],
          "allow_for_shipping_methods": [
            "<string>"
          ],
          "satisfies_overbox": true,
          "use_for_bin_packing": "yes",
          "weight_capacity": {
            "value": 20,
            "unit": "lb"
          },
          "container_style": "rigid_box",
          "packaging_handling_surcharge": true
        },
        "sku": "SKU-1AD",
        "name": "Test Product",
        "is_enabled": true,
        "merchant": {
          "type": "Merchant",
          "id": 4
        },
        "created_at": "2017-07-21T17:32:28Z",
        "updated_at": "2017-07-21T17:39:43Z"
      }
    ],
    "PackagingDataCollection": [
      {
        "sku": "SKU-1AD",
        "name": "Test Product",
        "is_enabled": true,
        "merchant": {
          "type": "Merchant",
          "id": 4
        },
        "created_at": "2017-07-21T17:32:28Z",
        "updated_at": "2017-07-21T17:39:43Z",
        "type": "PackagingDataCollection",
        "id": 123,
        "data_collection_options": {
          "associated_products": [
            {
              "type": "Product",
              "id": 3
            }
          ],
          "allow_for_brands": [
            {
              "type": "Merchant",
              "id": 4
            }
          ],
          "disallow_for_brands": [
            {
              "type": "Merchant",
              "id": 4
            }
          ],
          "billing_amount": {
            "amount": 99,
            "currency": "USD"
          },
          "allow_for_shipping_methods": [
            "<string>"
          ],
          "apply_to_goods_type": "any",
          "never_apply_to_goods_type": "NORMAL",
          "apply_only_above_weight": {
            "value": 20,
            "unit": "lb"
          },
          "one_per": "order",
          "require_scan_timing": "after_product_scan|on_full",
          "disable_confirm_button": true,
          "require_packaging_type": "overbox",
          "apply_unless_container_meets_hazmat": true,
          "apply_to_multi_sku_package": true,
          "collect_data_pattern": "<string>",
          "apply_to_region": "<string>",
          "is_collected_data_unique": true
        }
      }
    ],
    "PackagingInfill": [
      {
        "type": "PackagingInfill",
        "id": 123,
        "infill_options": {
          "barcodes": "956623520-4",
          "weight": {
            "value": 20,
            "unit": "lb"
          },
          "manage_stock": true,
          "associated_products": [
            {
              "type": "Product",
              "id": 3
            }
          ],
          "allow_for_brands": [
            {
              "type": "Merchant",
              "id": 4
            }
          ],
          "disallow_for_brands": [
            {
              "type": "Merchant",
              "id": 4
            }
          ],
          "billing_amount": {
            "amount": 99,
            "currency": "USD"
          },
          "disable_confirm_button": true,
          "apply_unless_container_meets_hazmat": true,
          "is_confirmation_required": true,
          "infill_horizontal": {
            "value": 12,
            "unit": "in"
          },
          "infill_vertical": {
            "value": 12,
            "unit": "in"
          },
          "infill_priority": 123
        },
        "sku": "SKU-1AD",
        "name": "Test Product",
        "is_enabled": true,
        "merchant": {
          "type": "Merchant",
          "id": 4
        },
        "created_at": "2017-07-21T17:32:28Z",
        "updated_at": "2017-07-21T17:39:43Z"
      }
    ],
    "PackagingInstruction": [
      {
        "type": "PackagingInstruction",
        "id": 123,
        "instruction_options": {
          "barcodes": "956623520-4",
          "associated_products": [
            {
              "type": "Product",
              "id": 3
            }
          ],
          "allow_for_brands": [
            {
              "type": "Merchant",
              "id": 4
            }
          ],
          "disallow_for_brands": [
            {
              "type": "Merchant",
              "id": 4
            }
          ],
          "billing_amount": {
            "amount": 99,
            "currency": "USD"
          },
          "allow_for_shipping_methods": [
            "<string>"
          ],
          "apply_to_goods_type": "any",
          "never_apply_to_goods_type": "NORMAL",
          "apply_only_above_weight": {
            "value": 20,
            "unit": "lb"
          },
          "one_per": "order",
          "require_scan_timing": "after_product_scan|on_full",
          "disable_confirm_button": true,
          "require_packaging_type": "overbox",
          "apply_to_region": "<string>",
          "apply_unless_container_meets_hazmat": true,
          "apply_to_multi_sku_package": true
        },
        "sku": "SKU-1AD",
        "name": "Test Product",
        "is_enabled": true,
        "merchant": {
          "type": "Merchant",
          "id": 4
        },
        "created_at": "2017-07-21T17:32:28Z",
        "updated_at": "2017-07-21T17:39:43Z"
      }
    ],
    "PackagingSupplies": [
      {
        "type": "PackagingSupplies",
        "id": 123,
        "supplies_options": {
          "barcodes": "956623520-4",
          "weight": {
            "value": 20,
            "unit": "lb"
          },
          "manage_stock": true,
          "associated_products": [
            {
              "type": "Product",
              "id": 3
            }
          ],
          "allow_for_brands": [
            {
              "type": "Merchant",
              "id": 4
            }
          ],
          "disallow_for_brands": [
            {
              "type": "Merchant",
              "id": 4
            }
          ],
          "billing_amount": {
            "amount": 99,
            "currency": "USD"
          },
          "allow_for_warehouses": [
            {
              "type": "Warehouse",
              "id": 123
            }
          ],
          "allow_for_shipping_methods": [
            "<string>"
          ],
          "packaging_handling_surcharge": true,
          "apply_to_goods_type": "any",
          "never_apply_to_goods_type": "NORMAL",
          "apply_only_above_weight": {
            "value": 20,
            "unit": "lb"
          },
          "one_per": "order",
          "require_scan_timing": "after_product_scan|on_full",
          "disable_confirm_button": true,
          "require_packaging_type": "overbox",
          "apply_to_region": "<string>",
          "apply_unless_container_meets_hazmat": true,
          "apply_to_multi_sku_package": true
        },
        "sku": "SKU-1AD",
        "name": "Test Product",
        "is_enabled": true,
        "merchant": {
          "type": "Merchant",
          "id": 4
        },
        "created_at": "2017-07-21T17:32:28Z",
        "updated_at": "2017-07-21T17:39:43Z"
      }
    ],
    "Product": [
      {
        "type": "Product",
        "id": 123,
        "vendor_sku": "Vendor-SKU-1AD2",
        "external_id": "11-993-9048",
        "barcodes": [
          "956623520-4",
          "O-VS-Oregano-p3"
        ],
        "goods_type": "NORMAL",
        "is_available": true,
        "is_visible": true,
        "lot_type": {
          "type": "LotType",
          "id": 4
        },
        "weight": {
          "value": 20,
          "unit": "lb"
        },
        "dimensions": {
          "length": 8,
          "width": 6,
          "height": 4,
          "unit": "in"
        },
        "volume": {
          "value": 300,
          "unit": "in^3"
        },
        "inventory": {
          "backorders": true,
          "dynamic_allocation": true,
          "virtual_inventory": "optimistic"
        },
        "export": {
          "description": "Plastic children's toy with steel weights and ball bearings",
          "customs_value": {
            "amount": 99,
            "currency": "USD"
          },
          "country_of_manufacture": "TW",
          "hs_base_code": "8518.30",
          "hs_country_extension": [
            {
              "country_id": "TW",
              "extension": "002"
            },
            {
              "country_id": "US",
              "extension": "011"
            }
          ]
        },
        "regulated_goods": {
          "regulation": {
            "type": "Regulation",
            "id": 123
          },
          "technical_name": "Hydro Polymer Acetylene Coating",
          "additional_information": "Flamable Liquid",
          "net_weight": {
            "value": 20,
            "unit": "lb"
          },
          "container_type": "Plastic Box",
          "container_meets_hazmat_specs": true,
          "regulation_units": 5
        },
        "packaging": {
          "require_packaging": true,
          "require_weight_check": true,
          "require_confirmation_per_item": true,
          "unit_quantity": 1,
          "bulk_quantity": 10,
          "max_per_package": 15,
          "is_ship_separately": true,
          "ship_separately_tag": "PVC",
          "can_tip": true,
          "can_contain_other_items": true,
          "is_handling_surcharge": true
        },
        "custom_fields": [
          {
            "code": "color",
            "value": 13,
            "label": "Red and Black"
          },
          {
            "code": "cost_of_goods",
            "value": 41.32
          },
          {
            "code": "allow_mailer",
            "value": true
          }
        ],
        "sku": "SKU-1AD",
        "name": "Test Product",
        "is_enabled": true,
        "merchant": {
          "type": "Merchant",
          "id": 4
        },
        "created_at": "2017-07-21T17:32:28Z",
        "updated_at": "2017-07-21T17:39:43Z"
      }
    ],
    "Rack": [
      {
        "type": "Rack",
        "id": 54
      }
    ],
    "Warehouse": [
      {
        "type": "Warehouse",
        "id": 3,
        "name": "East Coast 1",
        "is_active": true
      }
    ]
  },
  "has_more": true,
  "next": "<string>",
  "previous": "<string>",
  "meta": {
    "processing_time": 0.2525252525,
    "cursor_start": 123,
    "cursor_end": 123,
    "count": 123
  }
}

Authorizations

ā€‹
Authorization
string
header
required

Generate a JWT access token through a Custom Global Integration and provide it with each request in the Authorization header prefixed with "Bearer" and then a single space.

Path Parameters

ā€‹
id
integer<int32>
required

The id of the referenced Warehouse.

Query Parameters

ā€‹
fields
enum<string>[]

Specify additional fields of the Location object to be included in the response.

Available options:
basic,
all,
label,
priority,
qty_on_hand,
qty_putaway,
qty_unreserved,
qty_reserved,
qty_locked,
is_temp,
is_pickable,
is_type_auto,
created_at,
updated_at,
last_cyclecount_at,
lot,
product,
rack,
location_type
ā€‹
fields:lot
enum<string>[]

Specify additional fields of the Lot object to be included in the response.

Available options:
basic,
all,
id,
lot_number,
origination_date,
expiration_date,
is_expired,
is_active,
lot_number_input,
expiration_input,
sort_value,
days_until_expiration,
sort_direction,
group_value,
created_at,
updated_at,
created_by,
lot_type,
product
ā€‹
fields:lot.lot_type
enum<string>[]

Specify additional fields of the LotType object (via Lot) to be included in the response. See the selecting fields page for more information. Specify additional fields of the LotType object to be included in the response.

Available options:
basic,
all,
allow_mixing_locations,
allow_mixing_fulfillment,
lot_number_example,
lot_number_replacement,
expiration_date_pattern,
expiration_date_delta,
created_at,
updated_at
ā€‹
fields:lot.product
enum<string>[]

Specify additional fields of the Product object (via Lot) to be included in the response. See the selecting fields page for more information. Specify additional fields of the Product or Packaging* object to be included in the response.

Available options:
basic,
all,
created_at,
updated_at,
container_options,
supplies_options,
data_collection_options,
instruction_options,
infill_options,
vendor_sku,
external_id,
barcodes,
goods_type,
is_available,
is_visible,
weight,
dimensions,
volume,
inventory,
export,
regulated_goods,
packaging,
custom_fields
ā€‹
fields:product
enum<string>[]

Specify additional fields of the Product or Packaging* object to be included in the response.

Available options:
basic,
all,
created_at,
updated_at,
container_options,
supplies_options,
data_collection_options,
instruction_options,
infill_options,
vendor_sku,
external_id,
barcodes,
goods_type,
is_available,
is_visible,
weight,
dimensions,
volume,
inventory,
export,
regulated_goods,
packaging,
custom_fields
ā€‹
fields:product.merchant
enum<string>[]

Specify additional fields of the Merchant object to be included in the response. See the selecting fields page for more information.

Available options:
basic,
all,
code,
name,
status,
created_at,
updated_at,
brands,
default_brand
ā€‹
fields:rack
enum<string>[]

Specify additional fields of the Rack object to be included in the response.

Available options:
all,
id,
name,
location_pattern,
picking_order,
warehouse
ā€‹
fields:rack.warehouse
enum<string>[]

Specify additional fields of the Warehouse object (via Rack) to be included in the response. See the selecting fields page for more information. Specify additional fields of the Warehouse object to be included in the response.

Available options:
all
ā€‹
fields:location_type
enum<string>[]

Specify additional fields of the LocationType object to be included in the response.

Available options:
basic,
all,
name,
is_pickable,
created_at,
updated_at
ā€‹
filter
string[]

Using the filtering syntax, you may filter the results using the following fields:

  • id
  • label
  • created_at
  • updated_at
  • qty_putaway
  • qty_unreserved
  • qty_reserved
ā€‹
sort
string

The default sort order is descending by primary key (sort=-id). The following fields are available for sorting:

  • id
  • label
ā€‹
count
integer

If specified as 1, the meta.count property of the response will be present and populated with the total count of items matching the query before any paging is applied. This is not included by default to improve performance in some edge cases and is not required to perform paging using the next property of the response. See paging parameters for more information.

Required range: 0 <= x <= 1
ā€‹
cursor_end
integer

A cursor for use in pagination which defines the last id of the next page of results, non-inclusive. See paging parameters for more information on paging.

ā€‹
cursor_start
integer

A cursor for use in pagination which defines the starting id of the next page of results. See paging parameters for more information on paging.

ā€‹
limit
integer
default:100

A limit on the number of objects to be returned.

Required range: 1 <= x <= 1000
Example:

100

Response

A dictionary with a collection property that contains a list of up to limit Location objects matching the query.

ā€‹
collection
Location Ā· object[]

A list of Location objects.

ā€‹
included
object

Lists of referenced objects included by specifying optional fields. See the selecting fields page for more information.

ā€‹
has_more
boolean

True if the collection has more items on the next page. Use the "next" link to retrieve the next page of results.

ā€‹
next
string | null

The resource path for the next page of results if any are expected.

ā€‹
previous
string | null

The resource path for the previous page of results if any are expected.

ā€‹
meta
object

Additional metadata pertaining to the response.