Endpoint Reference
Business API v1 resources, required scopes, paging behavior and supported filters.
Resources
| Resource | Method | Route | Scope | Request model | Purpose |
|---|---|---|---|---|---|
| Stores | GET | /api/v1/companies/{companyId}/stores | stores.read | No paging | Store/warehouse identity, location, contact, area/rent, active/transaction and store-type flags. |
| Items | GET | /api/v1/companies/{companyId}/items | items.read | Paged | Item/barcode/style/theme, merchandise hierarchy, supplier/brand, state/online, retail/cost and purchase/display dates. |
| Suppliers | GET | /api/v1/companies/{companyId}/suppliers | purchases.read | Paged | Supplier identity and VAT registration/account information. |
| Sales | GET | /api/v1/companies/{companyId}/sales | sales.read | Paged + date range | Sales/returns, line pricing/discounts, signed net/gross/COGS metrics, salesperson, customer/loyalty and promotion references. |
| Purchases | GET | /api/v1/companies/{companyId}/purchases | purchases.read | Paged + date range | Purchases/returns, supplier invoice/VAT, currency, local/landed cost, landed expense and document values. |
| Inventory | GET | /api/v1/companies/{companyId}/inventory | inventory.read | Paged | Store/item on-hand quantity, unit cost, stock value, current retail and retail value. |
| Inventory movements | GET | /api/v1/companies/{companyId}/inventory/movements | inventory.read | Paged + date range | Normalized purchase/sale/return/transfer/adjustment/depreciation movements with signed quantity/value. |
| Transfers | GET | /api/v1/companies/{companyId}/transfers | transfers.read | Paged + date range | Transfer documents, from/to store, line quantity, source/destination movements, cost/retail and document totals. |
| Stock adjustments | GET | /api/v1/companies/{companyId}/stock-adjustments | adjustments.read | Paged + date range | Signed inventory adjustments with cost/retail values and document totals. |
| Stock depreciations | GET | /api/v1/companies/{companyId}/stock-depreciations | adjustments.read | Paged + date range | Depreciation/write-off lines with negative stock movement and cost totals. |
| Markdowns | GET | /api/v1/companies/{companyId}/markdowns | promotions.read | Paged + date range | Markdown policy/item mapping with original/markdown price, amount and percentage. |
| Promotions | GET | /api/v1/companies/{companyId}/promotions | promotions.read | Paged + date range | Promotion definitions, type, buy/get controls, flags, cashback settings and validity. |
| Promotion stores | GET | /api/v1/companies/{companyId}/promotions/{promotionId}/stores | promotions.read | Paged | Stores assigned to a promotion. |
| Promotion items | GET | /api/v1/companies/{companyId}/promotions/{promotionId}/items | promotions.read | Paged | Eligible/reward items and optional special price. |
| Promotion client categories | GET | /api/v1/companies/{companyId}/promotions/{promotionId}/client-categories | promotions.read | Paged | Client categories assigned to a promotion. |
| Promotion tiers | GET | /api/v1/companies/{companyId}/promotions/{promotionId}/tiers | promotions.read | Paged | Amount thresholds and reward values. |
| Promotion cashback stores | GET | /api/v1/companies/{companyId}/promotions/{promotionId}/cashback-stores | promotions.read | Paged | Stores where promotion cashback can be redeemed. |
| Discount coupon events | GET | /api/v1/companies/{companyId}/discount-coupon-events | promotions.read | Paged | Coupon-event metadata, percentage, expiry and eligibility flags. Raw coupon codes are not exposed. |
| Discount coupon stores | GET | /api/v1/companies/{companyId}/discount-coupon-events/{couponEventId}/stores | promotions.read | Paged | Stores assigned to a discount-coupon event. |
Common paging parameters
All endpoints marked Paged support page and pageSize in addition to the filters below. Default page size is 200; maximum is 1000.
Supported filters
| Resource | Query filters |
|---|---|
| Items | itemId, barcode, style, supplierId, brandId, categoryId, subcategoryId, itemState, isOnline |
| Suppliers | supplierId, search, vatRegistered |
| Sales | fromDate, toDate, storeId, transactionType, invoiceNo, itemId, itemType, salespersonId, customerId, loyaltyCustomerId, promotionId, markdownId, couponEventId, isReturn, isDiscounted, isItemDiscounted, isInvoiceDiscounted |
| Purchases | fromDate, toDate, purchaseCenterId, receivingStoreId, transactionType, documentState, supplierId, purchaseNo, supplierInvoiceNo, itemId, statisticalPeriodId |
| Inventory | storeId, itemId, isMainStore, isOnlineStore, isDamageStore, isActive, nonZeroOnly |
| Inventory movements | fromDate, toDate, movementType, transactionType, storeId, relatedStoreId, documentCenterId, documentNo, lineNo, itemId |
| Transfers | fromDate, toDate, fromStoreId, toStoreId, transferNo, lineNo, itemId, statisticalPeriodId, supplierId |
| Stock adjustments | fromDate, toDate, storeId, adjustmentNo, lineNo, itemId |
| Stock depreciations | fromDate, toDate, storeId, depreciationNo, lineNo, itemId |
| Markdowns | fromDate, toDate, markdownId, statisticalPeriodId, itemId, returnToFullPrice |
| Promotions | fromDate, toDate, promotionId, promotionType, allStores, allClientCategories, allItems |
| Promotion stores | storeId |
| Promotion items | itemId, rewardItemId, hasSpecialPrice |
| Promotion client categories | clientCategoryId |
| Promotion tiers | No resource-specific filters. |
| Promotion cashback stores | storeId |
| Discount coupon events | couponEventId, expiryFrom, expiryTo, isSingleCode, applyOnDiscountedItems, requiresStarCard, allStores |
| Discount coupon stores | storeId |
Important response fields
| Resource | Important fields |
|---|---|
| Stores | storeId, storeName, locationId, locationName, areaSqm, monthlyRent, isActive, transactionsEnabled, isMainStore, isOnlineStore, isDamageStore, vcountEnabled. |
| Items | itemId, barcode/style/theme/name, merchandise hierarchy, supplier/brand, season/period, state/online, originalPrice, currentPrice, averageLocalCost, last purchase and first-display fields. |
| Sales | Transaction/store/invoice/line/item, salespersonId/salespersonName, customerId, loyaltyCustomerId, promotion/markdown/coupon references, discount fields, signed netQuantity, grossSalesAmount, netSalesAmount, cogsAmount. |
| Purchases | Purchase center/store/document/supplier, supplier invoice/VAT, period/shipment/currency, quantity/price, signed foreign/local/landed cost, landedExpenseAmount, document totals and documentDiscountEarned. |
| Inventory | onHandQty, unitCost, stockValue, currentRetailPrice, retailValue plus store flags. |
| Inventory movements | movementType, transaction/store/related-store/document/line/item, signed movementQty, unitCost, stockValueMovement. |
| Transfers | From/to store, transfer/document/item references, transferQty, sourceMovementQty, destinationMovementQty, cost/retail and document totals. |
| Adjustments / Depreciation | Store/document/line/item, signed movement quantity and cost/retail totals; notes where available. |
| Markdowns / Promotions | Policy identity/date range, markdown prices/percent, promotion type/rules, eligible stores/items/categories/tiers/cashback stores and coupon-event metadata. |