Skip to main content
POST
Create a shelf location

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

A sales floor location to record for a product at a store.

aisle
string
required

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

Maximum string length: 120
store_id
string
required

Store that owns this product.

Pattern: ^[0-9]+$
store_product_id
string
required

Store product to place.

Pattern: ^[0-9]+$
is_primary
boolean

Whether this is the primary (home) location. The first shelf location created for a product becomes primary regardless.

section
string | null

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

Maximum string length: 120
shelf
integer | null

Shelf level within the section.

Required range: x >= 0

Response

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.

id
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.