API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Store Products

Retrieves a paged list of store products with stock, optionally including locations.

GET/api/v2/public/storeproducts/stock

Retrieves stock for a single product at a store, optionally including locations.

GET/api/v2/public/stores/{store_number}/products/{product_number}/stock

Retrieves aggregate surrounding stock for a product across nearby stores/warehouses.

GET/api/v2/public/stores/{store_number}/storeproducts/{product_number}/surrounding

Updates store product properties (min/max, prices, forecast, attention codes, replenishment, etc.) for one or more products at a store.

PUT/api/v2/public/stores/{store_number}/storeproducts

Create Store Products

POST/api/v2/public/stores/{store_number}/storeproducts

ModelsExpand Collapse

StoreProductListStoreProductsStockResponse object { id, is_replenishment, is_stock, 52 more }

Store product entry returned by the public store products list endpoint, with stock and optional location breakdown.

id: number

formatint64

is_replenishment: boolean

is_stock: boolean

most_likely_quantity: number

formatdouble

adjusted_order_level: optional number

formatdouble

attention_codes: optional string

average_array: optional string

barcode: optional string

category_code: optional string

category_name: optional string

category_order: optional number

formatint32

delivery_datetimes: optional array of string

demand_until_delivery: optional number

formatdouble

forecast: optional number

formatdouble

forecast_array: optional string

group_code: optional string

history_array: optional string

last_counted_datetime: optional string

formatdate-time

last_expiry_datetime: optional string

formatdate-time

last_expiry_updatedby: optional string

last_loss_updatedby: optional string

last_minmax_updatedby: optional string

last_receipt_updatedby: optional string

max: optional number

formatint32

min: optional number

formatint32

most_likely_datetime: optional string

formatdate-time

most_likely_pool_1: optional number

formatdouble

most_likely_pool_10: optional number

formatdouble

most_likely_pool_2: optional number

formatdouble

most_likely_pool_3: optional number

formatdouble

most_likely_pool_4: optional number

formatdouble

most_likely_pool_5: optional number

formatdouble

most_likely_pool_6: optional number

formatdouble

most_likely_pool_7: optional number

formatdouble

most_likely_pool_8: optional number

formatdouble

most_likely_pool_9: optional number

formatdouble

next_delivery_datetime: optional string

formatdate-time

next_ordering_datetime: optional string

formatdate-time

order_level: optional number

formatdouble

ordering_datetimes: optional array of string

original_max: optional number

formatint32

original_min: optional number

formatint32

price: optional number

formatdouble

product_description: optional string

product_number: optional string

promotion_week: optional string

purchase_unit_name: optional string

purchase_unit_quantity: optional number

formatdouble

referral_product: optional string

smallest_item_quantity: optional number

formatdouble

smallest_product_number: optional string

store_locations: optional array of object { quantity, carrier_code, default_stock_pool, 12 more }

quantity: number

formatdouble

carrier_code: optional string

default_stock_pool: optional string

stock_pool_1: optional number

formatdouble

stock_pool_10: optional number

formatdouble

stock_pool_2: optional number

formatdouble

stock_pool_3: optional number

formatdouble

stock_pool_4: optional number

formatdouble

stock_pool_5: optional number

formatdouble

stock_pool_6: optional number

formatdouble

stock_pool_7: optional number

formatdouble

stock_pool_8: optional number

formatdouble

stock_pool_9: optional number

formatdouble

store_location_code: optional string

tags: optional array of string

store_number: optional string

storeproduct_attention_codes: optional string

validate_expiry_datetime: optional string

formatdate-time

StoreProductRetrieveStoreProductStockResponse object { products }

Wrapper containing a list of store product stock entries.

products: optional array of object { most_likely_stock, delivery_datetimes, next_delivery_datetime, 15 more }

The list of products with stock data.

most_likely_stock: number

formatdouble

delivery_datetimes: optional array of string

next_delivery_datetime: optional string

formatdate-time

next_ordering_datetime: optional string

formatdate-time

ordering_datetimes: optional array of string

product_number: optional string

stock_pool_1: optional number

formatdouble

stock_pool_10: optional number

formatdouble

stock_pool_2: optional number

formatdouble

stock_pool_3: optional number

formatdouble

stock_pool_4: optional number

formatdouble

stock_pool_5: optional number

formatdouble

stock_pool_6: optional number

formatdouble

stock_pool_7: optional number

formatdouble

stock_pool_8: optional number

formatdouble

stock_pool_9: optional number

formatdouble

store_locations: optional array of object { quantity, carrier_code, default_stock_pool, 12 more }

quantity: number

formatdouble

carrier_code: optional string

default_stock_pool: optional string

stock_pool_1: optional number

formatdouble

stock_pool_10: optional number

formatdouble

stock_pool_2: optional number

formatdouble

stock_pool_3: optional number

formatdouble

stock_pool_4: optional number

formatdouble

stock_pool_5: optional number

formatdouble

stock_pool_6: optional number

formatdouble

stock_pool_7: optional number

formatdouble

stock_pool_8: optional number

formatdouble

stock_pool_9: optional number

formatdouble

store_location_code: optional string

tags: optional array of string

store_number: optional string

StoreProductRetrieveStoreProductSurroundingResponse = array of object { is_warehouse, most_likely_quantity, area_description, 13 more }

is_warehouse: boolean

most_likely_quantity: number

formatdouble

area_description: optional string

area_id: optional string

most_likely_pool_1: optional number

formatdouble

most_likely_pool_10: optional number

formatdouble

most_likely_pool_2: optional number

formatdouble

most_likely_pool_3: optional number

formatdouble

most_likely_pool_4: optional number

formatdouble

most_likely_pool_5: optional number

formatdouble

most_likely_pool_6: optional number

formatdouble

most_likely_pool_7: optional number

formatdouble

most_likely_pool_8: optional number

formatdouble

most_likely_pool_9: optional number

formatdouble

store_name: optional string

store_number: optional string

StoreProductUpdateStoreProductsResponse object { success, data, message }

Standard success response returned by mutation endpoints.

success: boolean

Indicates whether the operation completed successfully.

data: optional string

Optional data payload returned by the operation.

message: optional string

Human-readable message describing the result.