API Reference
Libraries
API Overview
Categories
Retrieves a filtered list of categories.
GET/api/v2/public/categories
Creates or updates categories.
POST/api/v2/public/categories
Stores
Retrieves a paginated list of stores.
GET/api/v2/public/stores
Creates or updates stores.
POST/api/v2/public/stores
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
Reason Codes
Retrieves a list of reason codes, optionally filtered by search text.
GET/api/v2/public/reasoncodes
Create or update public v2 reason codes
POST/api/v2/public/reasoncodes
Store Product Logs
Retrieves a paginated list of store product log entries.
GET/api/v2/public/products/stock/storeproductlogs
Creates store product log entries for a specific store.
POST/api/v2/public/stores/{store_number}/products/stock/storeproductlogs
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
Counting Lines
Submits external counting lines from an external counting integration.
POST/api/v2/public/externalcountinglines
Products
Creates or updates products in bulk.
POST/api/v2/public/products
Retrieves a paginated list of products.
GET/api/v2/public/products
Deletes products by product numbers.
DELETE/api/v2/public/products
Updates a product attribute value across all products matching the old value.
PUT/api/v2/public/products/attributes
Creates or updates product prices.
POST/api/v2/public/products/prices
Creates or updates discount prices for products.
POST/api/v2/public/products/discountprices
Creates or updates submitted product free fields. Existing keys not included in the request are unchanged.
POST/api/v2/public/products/freefields
Movement
Moves product stock between locations within a store.
Deprecated
POST/api/v2/public/stores/{store_number}/storeproductlocation/movement
Deliveries
Retrieves a paginated list of delivery orders.
GET/api/v2/public/orders/deliveries
Creates delivery orders for a specific store.
POST/api/v2/public/stores/{store_number}/orders/deliveries
Creates delivery orders across multiple stores.
POST/api/v2/public/orders/deliveries
Receipts
Retrieves a paginated list of receipt orders with receipt lines.
GET/api/v2/public/orders/receipts
Retrieves a paginated list of receipt orders for a specific store.
GET/api/v2/public/stores/{store_number}/orders/receipts
Product Lists
Creates a new product list for a store, optionally including initial line items.
POST/api/v2/public/stores/{store_number}/productlists
Retrieves a paginated list of product lists for a specific store, optionally including line items.
GET/api/v2/public/stores/{store_number}/productlists
Deletes a product list by id, optionally archiving it or removing only its header.
DELETE/api/v2/public/stores/{store_number}/productlists
Adds or updates lines on an existing product list.
POST/api/v2/public/stores/{store_number}/productlists/{id}
Product List Types
Retrieves all active product list types for the tenant.
GET/api/v2/public/productlisttypes
Creates a new product list type.
POST/api/v2/public/productlisttypes
Soft-deletes (archives) a product list type by id.
DELETE/api/v2/public/productlisttypes/{id}
Suppliers
List Suppliers
GET/api/v2/public/suppliers
Movement Assignments
Reopen Movement Assignment
PUT/api/v2/public/stores/{store_number}/movementassignment/reopen
Replenishment Advice Lines History
Delete Replenishment Advice Lines History
DELETE/api/v2/public/replenishmentadvicelineshistory