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
Log In
API Reference
Log In
v1.0
Guides
API Reference
Report
Getting Started
Getting Started
Sales
Customer
List a customer's store credit transactions
get
Fulfillment
Create a fulfillment
post
Update a fulfillment
put
Generate a pick list
get
Update a fulfillment's shipment
put
Get a fulfillment
get
Close a fulfillment
get
Mark a fulfillment as closed
get
Mark a fulfillment as in progress
get
Mark a fulfillment as Integrated Refund
get
Return a fulfillment
post
Ship a fulfillment
post
List fulfillments
get
Gift Card
Create a gift card
post
Extend a gift card
put
Get a gift card
get
List gift cards
get
Gift Card Reason
Create a gift card reason
post
Update a gift card reason
put
Delete a gift card reason
del
Get a gift card reason
get
List gift card reasons
get
Payment
Create a payment
post
Get a payment
get
List payments
get
Create payments in bulk
post
Product
Get unfulfilled quantity for an item
get
Sale
Create a sale
post
Set a sale's customer
get
Email a receipt
post
Set a sale's employee
get
Get a sale
get
List a sale's payments
get
Add payments to a sale
post
List sales
get
Create sales in bulk
post
Get units sold for an item
get
Get units sold for an item in a store
get
Get units sold for an item from a warehouse
get
Sale Line
List sale lines
get
Sales Budget
Get the sales budget
get
Update the sales budget
put
Shipment
Create a shipment
post
Update a shipment
put
Get a shipment
get
Mark a shipment as arrived
get
Cancel a shipment
get
Ship a shipment
get
List shipments
get
List shipment lines
get
Store Credit
Adjust store credit
post
Store Credit Reason
Create a store credit reason
post
Update a store credit reason
put
Delete a store credit reason
del
Get a store credit reason
get
List store credit reasons
get
Warehouse
List items awaiting fulfillment in a warehouse
get
Get unfulfilled quantity for an item in a warehouse
get
Customer
Customer
Create a customer
post
Update a customer
put
Delete a customer
del
Get a customer
get
Bulk delete customers
del
List customers
get
Bulk create or update customers
post
Loyalty
Get loyalty program settings
get
Update loyalty program settings
put
Adjust a customer's loyalty points
post
Recalculate loyalty
get
Get total loyalty points
get
Opt a customer in to loyalty
get
Opt a customer out of loyalty
get
Extend a customer's loyalty tier
get
Product
Item
Get an item by barcode
get
List items
get
Price
Update a price
put
Delete a price
del
Get a price
get
Bulk delete prices
del
List prices
get
Bulk create or update prices
post
List deleted prices
get
Product
Create a product
post
Update a product
put
Delete a product
del
Get a product
get
Add an item to a product
post
Update a product's item
put
Get a product's item
get
Get an item's current price
get
List a product's items
get
Bulk delete products
del
List products
get
Bulk create or update products
post
List deleted products
get
Export products
get
List deleted items
get
List product types
get
List product vendors
get
Promotion
Create a promotion
post
Update a promotion
put
Delete a promotion
del
Get a promotion
get
List promotions
get
Quick Product Buy
Create a quick product buy
post
Inventory
Box
Create a box
post
Update a box
put
Delete a box
del
Get a box
get
List boxes
get
Inventory
Adjust stock
post
Create a stock location
post
Update a stock location
put
Delete a stock location
del
Get a stock location
get
List a warehouse's stock locations
get
Move stock
post
Move all stock between locations
get
Set stock on hand
post
Minimum Stock Quantity
Update minimum stock quantities
put
Get minimum stock for a product
get
Get minimum stock for an item
get
Get minimum stock for a warehouse
get
Get minimum stock for a product in a warehouse
get
Get minimum stock for an item in a warehouse
get
Product
Get a product's stock
get
Get a product's total stock
get
Get an item's stock
get
Get an item's total stock
get
Get an item's stock at a location
get
List a product's stock movements
get
List an item's stock movements
get
List an item's stock movements at a location
get
Purchase Order
Create a purchase order
post
Update a purchase order
put
Get a purchase order
get
Cancel a purchase order
get
Complete a purchase order
get
Mark a purchase order matched
get
Ship a purchase order
get
List purchase orders
get
Replenishment
Create a replenishment rule
post
Update a replenishment rule
put
Get a replenishment rule
get
Run a replenishment rule
get
Delete a replenishment rule
del
List replenishment rules
get
Shipping Cost
Create a shipping cost
post
Update a shipping cost
put
Delete a shipping cost
del
List shipping costs
get
Stock Adjustment Reason
Create a stock adjustment reason
post
Update a stock adjustment reason
put
Delete a stock adjustment reason
del
Get a stock adjustment reason
get
List stock adjustment reasons
get
Stocktake
Create a stocktake
post
Delete a stocktake
del
Get a stocktake
get
Add counts to a stocktake
put
Complete a stocktake
get
Get a stocktake's variance
get
List completed stocktakes
get
List in-progress stocktakes
get
List open stocktakes
get
Transfer
Create a transfer
post
Update a transfer
put
Get a transfer
get
Cancel a transfer
get
Receive a transfer
get
List transfers
get
Warehouse
Create a warehouse
post
Update a warehouse
put
Delete a warehouse
del
Get a warehouse
get
Get an item's in-transit stock
get
Get a warehouse's stock
get
Get a warehouse's total stock
get
Get a product's stock in a warehouse
get
Get a product's total stock in a warehouse
get
Get an item's stock in a warehouse
get
Get an item's total stock in a warehouse
get
Get an item's stock at a warehouse location
get
List a warehouse's stock movements
get
List a product's stock movements in a warehouse
get
List an item's stock movements in a warehouse
get
List an item's stock movements at a warehouse location
get
List warehouses
get
Accounts
Account
Create an account
post
Delete an account
del
Get an account
get
Update an account
put
Get an account's opening balance
get
Get an account's statement balance
get
Get an account's system balance
get
List accounts
get
Get general ledger dates
get
Update general ledger dates
put
AP Invoice
Create an AP invoice
post
Update an AP invoice
put
Bulk approve AP invoices
get
Bulk cancel AP invoices
get
Bulk pay AP invoices
post
List AP invoice payments
get
Get an AP invoice
get
Approve an AP invoice
get
Cancel an AP invoice
get
Delete an AP invoice
del
List AP invoices
get
AR Invoice
Create an AR invoice
post
Update an AR invoice
put
Bulk approve AR invoices
get
Get an AR invoice
get
Approve an AR invoice
get
Cancel an AR invoice
get
Mark an AR invoice as paid
get
Delete an AR invoice
del
List AR invoices
get
Asset Write Off Reason
Create an asset write-off reason
post
Update an asset write-off reason
put
Delete an asset write-off reason
del
Get an asset write-off reason
get
List asset write-off reasons
get
Bank Statement
List bank statements
get
Bank Transaction
Match a bank transaction
put
Transfer between bank accounts
get
Delete a bank transaction
del
List bank transactions
get
Import bank transactions
post
Reconcile bank transactions
post
Cloud Print
Disconnect the cloud print account
del
Get the cloud print account
get
Connect a cloud print account
post
Update the cloud print account
put
Cost
Set an item cost
post
Bulk set item costs
post
Cost Centre
Create a cost centre
post
Update a cost centre
put
Get a cost centre
get
Delete a cost centre
del
List cost centres
get
Cost History
List cost history
get
Fixed Asset
Create a fixed asset
post
Update a fixed asset
put
Run depreciation
get
Calculate depreciation
get
Depreciate a fixed asset
get
Reverse a depreciation
get
List depreciations
get
Create a fixed asset type
post
Update a fixed asset type
put
Delete a fixed asset type
del
Get a fixed asset type
get
List fixed asset types
get
Get a fixed asset
get
Mark a fixed asset active
get
Mark a fixed asset disposed
get
Mark a fixed asset sold
get
List fixed assets
get
Journal
Create a journal
post
Get a journal
get
Reverse a journal
get
List journals
get
List journal entries
get
Count journal entries
get
Export journal entries
get
Payment Method
Create a payment method
post
Update a payment method
put
Delete a payment method
del
Get a payment method
get
List payment methods
get
Product
List an item's cost history
get
Supplier
Create a supplier
post
Update a supplier
put
Delete a supplier
del
Get a supplier
get
List suppliers
get
Tax Rate
Create a tax rate
post
Update a tax rate
put
Get a tax rate
get
Delete a tax rate
del
List tax rates
get
Employee
Sales Staff
List POS staff
get
Create a POS staff member
post
Update a POS staff member
put
List terminated POS staff
get
Get a POS staff member
get
Reinstate a POS staff member
get
Terminate a POS staff member
get
Unlinked Return
Allow unlinked returns
get
Deny unlinked returns
get
Reports
Log
List log entries
get
Create a log entry
post
Get a log entry
get
Report
Create a report
post
Update a report
put
Export a report
post
Run a report
post
Delete a report
del
Get a report
get
List reports
get
Glue
Glue
List Glue jobs
get
Create a Glue job
post
Update a Glue job
put
Delete a Glue error
del
Get a Glue error
get
List Glue errors
get
Delete a Glue job
del
Get a Glue job
get
Admin
Calendar
Create a calendar year
post
Get a calendar day
get
Delete a calendar year
del
Get a calendar year
get
Get a calendar month
get
Get a calendar quarter
get
Get a calendar week
get
Carrier
Create a carrier
post
Update a carrier
put
Delete a carrier
del
Get a carrier
get
List carriers
get
Cloud Print
Get the cloud print client
get
Send a print job
post
List cloud printers
get
Discount Reason
Create a discount reason
post
Update a discount reason
put
Delete a discount reason
del
Get a discount reason
get
List discount reasons
get
Email Template
Create an email template
post
Update an email template
put
Get an email template
get
Reset an email template
get
Delete an email template
del
List email templates
get
File
Upload a file
post
My Company
Get your company settings
get
Update your company settings
put
Update a number counter
post
List number counters
get
Delete a private data value
del
Get a private data value
get
Save a private data value
post
Print Template
Create a print template
post
Update a print template
put
Get a print template
get
Render a print template
post
Reset a print template
get
Delete a print template
del
List print templates
get
Return Reason
Create a return reason
post
Update a return reason
put
Delete a return reason
del
Get a return reason
get
List return reasons
get
Store
Create a store
post
Update a store
put
Delete a store
del
Get a store
get
List stores
get
Powered by
Copy Page
Report
Updated 8 days ago
Get a log entry
Create a report
Did this page help you?
Yes
No
Updated 8 days ago
Get a log entry
Create a report
Did this page help you?
Yes
No
