Sitoo API Reference

This is the reference pages for the Sitoo API containing information on all endpoints and their usage.

Cash Registers

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.

Go to Cash Registers endpoints

Categories

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.

Go to Categories endpoints

Dashboard Custom Metrics

Custom Metrics for Dashboards is used to integrate external data in Sitoo Dashboards.

Go to Dashboard Custom Metrics endpoints

Gift Cards

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.

Go to Gift Cards endpoints

Influencer Codes

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.

Go to Influencer Codes endpoints

Influencer Vouchers

Influencer Vouchers is used to handle the actual use of your influencer vouchers.

Go to Influencer Vouchers endpoints

Manufacturers

Manufacturers (Brands) are used to group products in the POS. They can also be used to filter products in the POS.

Go to Manufacturers endpoints

Orders

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.

Go to Orders endpoints

Price Lists

Use price lists to manage the prices for your products. Price lists can be locked to a specific store or campaign.

Go to Price Lists endpoints

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.

Go to Product Groups (VAT) endpoints

Product Images & Files

Assign images and files to products.

Go to Product Images & Files endpoints

Product Variants

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.

Go to Product Variants endpoints

Products

The endpoints are used for adding, updating and deleting basic products.

Go to Products endpoints. For more specifice use of products, please refer to:

Resources

Resources is used for handling images and other files. The resources are shared for all sites in a Sitoo system.

Go to Resources endpoints

Reason Codes

Collection of reason codes for warehouse transactions, actions and other events used in the POS to distinguish different usages.

Go to Reason Codes endpoints

Sales Taxes

Endpoints for handling settings and rules for applying sales taxes. Not to be confused with VAT which is handled in Product Groups (VAT)

Go to Sales Taxes endpoints

Shipments

Endpoints for handling shipments of items to and from stores/warehouses.

Go to Shipments endpoints

Sites

A site represents an instance of a store/sales-channel. Note! It is recommended to use eshopid (integer) instead of siteid (uniqueidentifier) to refer to a site in Sitoo API.

Go to Sites endpoints

Stores

Set up stores for your business.

Go to Stores endpoints

Vouchers

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.

Go to Vouchers endpoints

Users

Endpoints for handling users. Users are shared for all sites in a Sitoo system.

Go to Users endpoints

Warehouse Batches

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.

Go to Warehouse Batches endpoints

Warehouse Transactions

Warehouse transactions are the events that operate on warehouseitems.

Go to Warehouse Transactions endpoints

Warehouses

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.

Go to Warehouses endpoints