Sitoo API Reference
This is the reference pages for the Sitoo API containing information on all endpoints and their usage.
The Cash Registers endpoints are used to get information on the POS-instances used in the system, including the Z-reports generated by each POS.
Categories are used to structure products in the POS and can be used for filtering. The categories can be ordered in a tree structure if needed. A product can belong to multiple categories.
Dashboard Custom Metrics
Custom Metrics for Dashboards is used to integrate external data in Sitoo Dashboards.
The endpoints handle all use-cases for gift cards such as creating, validating, redeeming and refilling. The endpoints can also be used to integrate e-commerce gift cards with one-point of truth.
Use Influencer Codes to promote your campaigns via a network of influencers. An influencer code is used to activate one or more campaigns in Sitoo POS.
Influencer Vouchers is used to handle the actual use of your influencer vouchers.
Manufacturers (Brands) are used to group products in the POS. They can also be used to filter products in the POS.
Orders endpoints are used for handling all transactions in the system. Also used to add e-commerce orders for validated refunds in store, bookings/reservations and pick-up-in-store functionality.
Use price lists to manage the prices for your products. Price lists can be locked to a specific store or campaign.
Product Groups (VAT)
Product Groups are used to group products, mainly for bookkeeping purposes. The product groups also have the setting for the VAT percentage, used for a product.
Product Images & Files
Assign images and files to products.
This interface is used for handling product variants, e.g. Sizes. All product variants are also accessible via the Products endpoints, but with restricted fields available.
The endpoints are used for adding, updating and deleting basic products.
Go to Products endpoints. For more specifice use of products, please refer to:
- Product Variants
- Product Images & Files
- Stock handling: Warehouses and Warehouse Transactions
- Pricing: Price Lists
- Campaigns: Vouchers
Resources is used for handling images and other files. The resources are shared for all sites in a Sitoo system.
Collection of reason codes for warehouse transactions, actions and other events used in the POS to distinguish different usages.
Endpoints for handling settings and rules for applying sales taxes. Not to be confused with VAT which is handled in Product Groups (VAT)
Endpoints for handling shipments of items to and from stores/warehouses.
A site represents an instance of a store/sales-channel. Note! It is recommended to use
eshopid (integer) instead
siteid (uniqueidentifier) to refer to a site in Sitoo API.
Set up stores for your business.
The endpoints are used to handle campaigns in a Sitoo system. There are 4 groups of vouchers: Order/Cart, Product, Package and Pricelist which together cover most of the use-cases for campaign handling.
Endpoints for handling users. Users are shared for all sites in a Sitoo system.
Warehouses batches are used to handle a session on the server for updating warehouse items. Closing a warehouse batch will create a warehouse transaction with the changes to the stock in it.
Warehouse transactions are the events that operate on warehouseitems.
The endpoints handle common use-cases for warehouses. Stock levels can be directly modified for Virtual warehouses, but for FIFO-warehouses, stock needs to be handled using Warehouse Transactions or Warehouse Batches. Warehouses can be connected (belong) to a store.