The shelf location object - Vori Help Center

{
  "id": "<string>",
  "aisle": "<string>",
  "banner_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "created_by_user_id": "<string>",
  "is_primary": true,
  "section": "<string>",
  "shelf": 123,
  "store_id": "<string>",
  "store_product_id": "<string>",
  "updated_at": "2023-11-07T05:31:56Z"
}

A shelf location records where a product sits on the sales floor: its aisle, section, and shelf. These are the Shelf Locations listed under Locations on a product’s details page in Back Office. A product can have several, and one of them is its primary location. In the API, shelf locations are the store-product-placements resource.

A shelf location for a product: where it sits on the sales floor — its aisle, section, and shelf — and whether that is the primary location for the product.

string

required

Unique identifier for the record.

aisle

string

required

Aisle identifier (e.g. "1", "1A", "Produce").

banner_id

string

required

Banner the shelf location belongs to.

created_at

string<date-time>

required

When the record was created.

created_by_user_id

string | null

required

User who created this shelf location; null when an API client created it.

is_primary

boolean

required

Whether this is the primary (home) location for the product.

section

string | null

required

Bay/section within the aisle (e.g. "Bay 3", "Left").

shelf

integer | null

required

Shelf level within the section.

store_id

string

required

Store the shelf location belongs to.

store_product_id

string

required

Store product placed at this location.

updated_at

string<date-time>

required

When the record was last changed.