curl --request GET \
--url https://{base_url_domain}/api/global/v1/inventory/warehouses/{id}/locationsByLabel/{label} \
--header 'Authorization: Bearer <token>'
{
"resource": {
"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.",
"is_active": true,
"is_deleted": false,
"sort_order": 5,
"created_at": "2017-07-21T17:32:28Z",
"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
}
]
}
}
Returns a single Location
object specified by the warehouse id
and location label
path parameters.
curl --request GET \
--url https://{base_url_domain}/api/global/v1/inventory/warehouses/{id}/locationsByLabel/{label} \
--header 'Authorization: Bearer <token>'
{
"resource": {
"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.",
"is_active": true,
"is_deleted": false,
"sort_order": 5,
"created_at": "2017-07-21T17:32:28Z",
"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
}
]
}
}
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.
The id
of the referenced Warehouse
.
The location's human-readable label and barcode value (without barcode prefix). Be sure to url-encode the the value to avoid special characters being interpreted as not part of the label.
Specify additional fields of the Location
object to be included in the response. See the selecting fields page for more information.
Show child attributes
Specify additional fields of the Lot
object to be included in the response. See the selecting fields page for more information.
Show child attributes
Specify additional fields of the Product
or Packaging*
object to be included in the response. See the selecting fields page for more information.
Show child attributes
Specify additional fields of the Rack
object to be included in the response. See the selecting fields page for more information.
Show child attributes
Specify additional fields of the LocationType
object to be included in the response. See the selecting fields page for more information.
Show child attributes
OK
The response is of type object
.