API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Locations

Retrieves locations for a specific store.

locations.list_locations(strstore_number, LocationListLocationsParams**kwargs) -> SyncCursorPage[LocationListLocationsResponse]

GET/api/v2/public/stores/{store_number}/locations

Retrieves products at a specific store location.

locations.list_location_products(strlocation_code, LocationListLocationProductsParams**kwargs) -> SyncCursorPage[LocationListLocationProductsResponse]

GET/api/v2/public/stores/{store_number}/locations/{location_code}/products

Retrieves products across one or more locations resolved by location code or jsonTag.

locations.list_locations_products(strstore_number, LocationListLocationsProductsParams**kwargs) -> SyncCursorPage[LocationListLocationsProductsResponse]

GET/api/v2/public/stores/{store_number}/locations/products

ModelsExpand Collapse

class LocationListLocationsResponse: …

Represents a location within a store, including stock and product data.

id: int

Internal location identifier.

formatint64

counter: int

Number of products counted at this location.

formatint32

created_on: datetime

Date and time the location was created.

formatdate-time

location_order: int

Order in which the location appears in walking sequences.

formatint32

customer_orders: Optional[List[str]]

Customer orders associated with this location.

default_stock_pool: Optional[str]

Name of the default stock pool for this location.

location_code: Optional[str]

Code identifying the location within the store.

quantity: Optional[float]

Total stock quantity at this location.

formatdouble

stock: Optional[List[Stock]]

Per-product stock breakdown at this location.

customer_order_line_number: Optional[int]

Customer order line number.

formatint32

customer_order_number: Optional[str]

Associated customer order number.

customer_order_shipment_line_number: Optional[int]

Customer order shipment line number.

formatint32

customer_order_shipment_number: Optional[str]

Customer order shipment number.

mostlikelypool1: Optional[float]

Most likely quantity in stock pool 1.

formatdouble

mostlikelypool10: Optional[float]

Most likely quantity in stock pool 10.

formatdouble

mostlikelypool2: Optional[float]

Most likely quantity in stock pool 2.

formatdouble

mostlikelypool3: Optional[float]

Most likely quantity in stock pool 3.

formatdouble

mostlikelypool4: Optional[float]

Most likely quantity in stock pool 4.

formatdouble

mostlikelypool5: Optional[float]

Most likely quantity in stock pool 5.

formatdouble

mostlikelypool6: Optional[float]

Most likely quantity in stock pool 6.

formatdouble

mostlikelypool7: Optional[float]

Most likely quantity in stock pool 7.

formatdouble

mostlikelypool8: Optional[float]

Most likely quantity in stock pool 8.

formatdouble

mostlikelypool9: Optional[float]

Most likely quantity in stock pool 9.

formatdouble

product_description: Optional[str]

Product description.

product_number: Optional[str]

Product number.

quantity: Optional[float]

Live total quantity at this location.

formatdouble

tags: Optional[List[str]]

Tags applied to the location.

class LocationListLocationProductsResponse: …

Represents a product found at a specific store location.

barcode: Optional[str]

Product barcode.

customer_order_line_number: Optional[int]

Customer order line number.

formatint64

customer_order_number: Optional[str]

Associated customer order number.

customer_order_shipment_line_number: Optional[int]

Customer order shipment line number.

formatint32

customer_order_shipment_number: Optional[str]

Customer order shipment number.

image_url: Optional[str]

URL of the product image.

product_description: Optional[str]

Product description.

product_number: Optional[str]

Product number.

quantity: Optional[float]

Current stock quantity at this location.

formatdouble

class LocationListLocationsProductsResponse: …

Represents a product found at a specific store location.

barcode: Optional[str]

Product barcode.

customer_order_line_number: Optional[int]

Customer order line number.

formatint64

customer_order_number: Optional[str]

Associated customer order number.

customer_order_shipment_line_number: Optional[int]

Customer order shipment line number.

formatint32

customer_order_shipment_number: Optional[str]

Customer order shipment number.

image_url: Optional[str]

URL of the product image.

product_description: Optional[str]

Product description.

product_number: Optional[str]

Product number.

quantity: Optional[float]

Current stock quantity at this location.

formatdouble