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.

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

Retrieves products at a specific store location.

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

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

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

ModelsExpand Collapse

LocationListLocationsResponse object { id, counter, created_on, 7 more }

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

id: number

Internal location identifier.

formatint64

counter: number

Number of products counted at this location.

formatint32

created_on: string

Date and time the location was created.

formatdate-time

location_order: number

Order in which the location appears in walking sequences.

formatint32

customer_orders: optional array of string

Customer orders associated with this location.

default_stock_pool: optional string

Name of the default stock pool for this location.

location_code: optional string

Code identifying the location within the store.

quantity: optional number

Total stock quantity at this location.

formatdouble

stock: optional array of object { customer_order_line_number, customer_order_number, customer_order_shipment_line_number, 14 more }

Per-product stock breakdown at this location.

customer_order_line_number: optional number

Customer order line number.

formatint32

customer_order_number: optional string

Associated customer order number.

customer_order_shipment_line_number: optional number

Customer order shipment line number.

formatint32

customer_order_shipment_number: optional string

Customer order shipment number.

mostlikelypool1: optional number

Most likely quantity in stock pool 1.

formatdouble

mostlikelypool10: optional number

Most likely quantity in stock pool 10.

formatdouble

mostlikelypool2: optional number

Most likely quantity in stock pool 2.

formatdouble

mostlikelypool3: optional number

Most likely quantity in stock pool 3.

formatdouble

mostlikelypool4: optional number

Most likely quantity in stock pool 4.

formatdouble

mostlikelypool5: optional number

Most likely quantity in stock pool 5.

formatdouble

mostlikelypool6: optional number

Most likely quantity in stock pool 6.

formatdouble

mostlikelypool7: optional number

Most likely quantity in stock pool 7.

formatdouble

mostlikelypool8: optional number

Most likely quantity in stock pool 8.

formatdouble

mostlikelypool9: optional number

Most likely quantity in stock pool 9.

formatdouble

product_description: optional string

Product description.

product_number: optional string

Product number.

quantity: optional number

Live total quantity at this location.

formatdouble

tags: optional array of string

Tags applied to the location.

LocationListLocationProductsResponse object { barcode, customer_order_line_number, customer_order_number, 6 more }

Represents a product found at a specific store location.

barcode: optional string

Product barcode.

customer_order_line_number: optional number

Customer order line number.

formatint64

customer_order_number: optional string

Associated customer order number.

customer_order_shipment_line_number: optional number

Customer order shipment line number.

formatint32

customer_order_shipment_number: optional string

Customer order shipment number.

image_url: optional string

URL of the product image.

product_description: optional string

Product description.

product_number: optional string

Product number.

quantity: optional number

Current stock quantity at this location.

formatdouble

LocationListLocationsProductsResponse object { barcode, customer_order_line_number, customer_order_number, 6 more }

Represents a product found at a specific store location.

barcode: optional string

Product barcode.

customer_order_line_number: optional number

Customer order line number.

formatint64

customer_order_number: optional string

Associated customer order number.

customer_order_shipment_line_number: optional number

Customer order shipment line number.

formatint32

customer_order_shipment_number: optional string

Customer order shipment number.

image_url: optional string

URL of the product image.

product_description: optional string

Product description.

product_number: optional string

Product number.

quantity: optional number

Current stock quantity at this location.

formatdouble