For AI agents: the docs index is at https://docs.smoothretail.com/llms.txt. Append .md to any documentation page URL to get its markdown version.

Jump to Content

Guides API Reference

v1.0

API Reference

v1.0Guides API Reference

Getting Started

Getting Started

Sales

Customer
- List a customer's store credit transactionsget
Fulfillment
Gift Card
Gift Card Reason
Payment
Product
- Get unfulfilled quantity for an itemget
Sale
Sale Line
- List sale linesget
Sales Budget
- Get the sales budgetget
- Update the sales budgetput
Shipment
Store Credit
- Adjust store creditpost
Store Credit Reason
Warehouse
- List items awaiting fulfillment in a warehouseget
- Get unfulfilled quantity for an item in a warehouseget

Customer

Customer
Loyalty

Product

Item
- Get an item by barcodeget
- List itemsget
Price
Product
Promotion
Quick Product Buy
- Create a quick product buypost

Inventory

Box
Inventory
Minimum Stock Quantity
Product
Purchase Order
Replenishment
Shipping Cost
Stock Adjustment Reason
Stocktake
Transfer
Warehouse

Accounts

Account
AP Invoice
AR Invoice
Asset Write Off Reason
Bank Statement
- List bank statementsget
Bank Transaction
Cloud Print
Cost
- Set an item costpost
- Bulk set item costspost
Cost Centre
Cost History
- List cost historyget
Fixed Asset
Journal
Payment Method
Product
- List an item's cost historyget
Supplier
Tax Rate

Employee

Sales Staff
Unlinked Return
- Allow unlinked returnsget
- Deny unlinked returnsget

Reports

Log
Report

Glue

Glue

Admin

Calendar
Carrier
Cloud Print
Discount Reason
Email Template
File
- Upload a filepost
My Company
Print Template
Return Reason
Store

Powered by

Promotion

Updated 8 days ago

List product vendors

Create a promotion

Did this page help you?

Updated 8 days ago

List product vendors

Create a promotion

Did this page help you?