Skip to main content
GET
Get Location Occupancy

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.

occupancy_id
integer<int64>
required

The id of the LocationOccupancy.

Query Parameters

fields:location
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,
tags,
lot,
product,
rack,
slot_type
fields: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,
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,
manufacturer_part_number,
unit_level,
external_id,
barcodes,
goods_type,
is_available,
is_visible,
weight,
dimensions,
volume,
inventory,
export,
regulated_goods,
packaging,
custom_fields
fields:slot_type
enum<string>[]

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

Available options:
basic,
all,
name,
is_pickable,
sort_order,
patterns,
is_fixed_capacity,
slot_dimensions,
weight_capacity,
trigger_doi_days,
target_doi_days,
created_at,
updated_at
fields:warehouse
enum<string>[]

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

Available options:
basic,
all,
id,
name,
is_active,
abbreviation

Response

A dictionary with a resource property that contains the LocationOccupancy object.

resource
LocationOccupancy · object

An interval during which one location held inventory of one merchant's product. An interval opens when the location becomes occupied and closes when it becomes empty. A location that is emptied and refilled within 60 seconds (inclusive) with the same merchant, product and slot type keeps one interval, and the gap counts in duration_seconds. An interval is split (closed and reopened at the same instant) when the location's slot type changes while occupied. Closed intervals never change.

The merchant, product, SKU, location label, slot type name and temporary flag are snapshots taken when the interval opened, so they survive later changes or deletion of the location, product or merchant. All times are UTC with millisecond precision.

included
object

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

meta
object

Additional metadata pertaining to the response.