Home

Sitoo REST API v1.2

Sitoo REST API makes it easy for developers to add, update, delete or view resources in Sitoo Commerce. Using the REST standard also makes the API easy and intuitive to use.

To get started read the Quick Start.

Base URL: https://api.sitoo.com/accounts/{accountid}/. Use the base url as a prefix to the resources below.

Systems

Collection of systems.

Resource Description
GET systems Get a collection of systems. See sdbsystem for fields.
GET systems/{systemid} Get a system.

Sites

Collection of sites.

Resource Description
GET systems/{systemid}/sites Get a collection of sites. See sdbsite for fields.
GET systems/{systemid}/sites/{siteid} Get a site.

Products

Collection of products for a site.

Resource Description
GET systems/{systemid}/sites/{siteid}/products Get a collection of products.
POST systems/{systemid}/sites/{siteid}/products Add a product. See sdbproduct for fields.
GET systems/{systemid}/sites/{siteid}/products/{productid} Get a product.
PUT systems/{systemid}/sites/{siteid}/products/{productid} Update fields for a product. See sdbproduct for fields.
DELETE systems/{systemid}/sites/{siteid}/products/{productid} Delete a product.

Product Images

Collection of images for a product.

Resource Description
GET systems/{systemid}/sites/{siteid}/products/{productid}/images Get a collection of images for a product. See sdbresource for fields.
POST systems/{systemid}/sites/{siteid}/products/{productid}/images Add an image to a product. The only field that can be set is resourceid. Optionally you can add an image using the field "filedata" which needs to be a base64-encoded string.
GET systems/{systemid}/sites/{siteid}/products/{productid}/images/{imageid} Get an image for a product. The imageid is index of the image among this product's images.
PUT systems/{systemid}/sites/{siteid}/products/{productid}/images/{imageid} Update an image at a specific index for a product. The imageid is index of the image among this product's images. The only field that can be set is resourceid. Optionally you can add an image using the field "filedata" which needs to be a base64-encoded string.
DELETE systems/{systemid}/sites/{siteid}/products/{productid}/images/{imageid} Delete an image at a specific index for a product. The imageid is index of the image among this product's images.

Product Files

Collection of files for a product.

Resource Description
GET systems/{systemid}/sites/{siteid}/products/{productid}/files Get a collection of files for a product. See sdbresource for fields.
POST systems/{systemid}/sites/{siteid}/products/{productid}/files Add an file to a product. The only field that can be set is resourceid. Optionally you can add an file using the field "filedata" which needs to be a base64-encoded string.
GET systems/{systemid}/sites/{siteid}/products/{productid}/files/{fileid} Get an file for a product. The fileid is index of the file among this product's files.
PUT systems/{systemid}/sites/{siteid}/products/{productid}/files/{fileid} Update an file at a specific index for a product. The fileid is index of the file among this product's files. The only field that can be set is resourceid. Optionally you can add an file using the field "filedata" which needs to be a base64-encoded string.
DELETE systems/{systemid}/sites/{siteid}/products/{productid}/files/{fileid} Delete an file at a specific index for a product. The fileid is index of the file among this product's files.

Product Variants

Collection of variants for a product.

Resource Description
GET systems/{systemid}/sites/{siteid}/products/{productid}/productvariants Get a sdbproductvariants object which contains all variants for the product.
PUT systems/{systemid}/sites/{siteid}/products/{productid}/productvariants Sets the variants for a product.

Price Lists

Collection of price lists for a site.

Resource Description
GET systems/{systemid}/sites/{siteid}/pricelists Get a collection of price lists.
POST systems/{systemid}/sites/{siteid}/pricelists Add a price list. See sdbpricelist for fields.
GET systems/{systemid}/sites/{siteid}/pricelists/{pricelistid} Get a price list.
PUT systems/{systemid}/sites/{siteid}/pricelists/{pricelistid} Update fields for a price list. See sdbpricelist for fields.
DELETE systems/{systemid}/sites/{siteid}/pricelists/{pricelistid} Delete a price list.

Manufacturers

Collection of manufacturers for a site.

Resource Description
GET systems/{systemid}/sites/{siteid}/manufacturers Get a collection of manufacturers.
POST systems/{systemid}/sites/{siteid}/manufacturers Add a manufacturer. See sdbmanufacturer for fields.
GET systems/{systemid}/sites/{siteid}/manufacturers/{manufacturerid} Get a manufacturer.
PUT systems/{systemid}/sites/{siteid}/manufacturers/{manufacturerid} Update fields for a manufacturer. See sdbmanufacturer for fields.
DELETE systems/{systemid}/sites/{siteid}/manufacturers/{manufacturerid} Delete a manufacturer.

Categories

Collection of categories for a site.

Resource Description
GET systems/{systemid}/sites/{siteid}/categories Get a collection of categories.
POST systems/{systemid}/sites/{siteid}/categories Add a category. See sdbcategory for fields.
GET systems/{systemid}/sites/{siteid}/categories/{categoryid} Get a category.
PUT systems/{systemid}/sites/{siteid}/categories/{categoryid} Update fields for a category. See sdbcategory for fields.
DELETE systems/{systemid}/sites/{siteid}/categories/{categoryid} Delete a category.

Contacts

Collection of contacts.

Resource Description
GET systems/{systemid}/sites/{siteid}/contacts Get a collection of contacts.
POST systems/{systemid}/sites/{siteid}/contacts Add a contact. See sdbuser for fields. Email is required.
GET systems/{systemid}/sites/{siteid}/contacts/{contactid} Get a contact.
PUT systems/{systemid}/sites/{siteid}/contacts/{contactid} Update fields for a contact. See sdbuser for fields.
DELETE systems/{systemid}/sites/{siteid}/contacts/{contactid} Delete a contact.

Orders

Collection of orders for a site.

Resource Description
GET systems/{systemid}/sites/{siteid}/orders Get a collection of orders. See sdborder for fields.
GET systems/{systemid}/sites/{siteid}/orders/{orderid} Get an order.
GET systems/{systemid}/sites/{siteid}/orders/{orderid}/orderitems Get a collection of order items. See sdborderitem for fields.
GET systems/{systemid}/sites/{siteid}/orders/{orderid}/orderlogitems Get a collection of order log items.
POST systems/{systemid}/sites/{siteid}/orders/{orderid}/orderlogitems Add an order log item. See sdborderlogitem for fields. orderlogtypeid is required and must be 1000 (App Event).

Payment Types

Collection of payment types.

Resource Description
GET systems/{systemid}/sites/{siteid}/paymenttypes Get a collection of payment types.
POST systems/{systemid}/sites/{siteid}/paymenttypes Add a payment type. See sdbpaymenttype for fields.
GET systems/{systemid}/sites/{siteid}/paymenttypes/{paymenttypeid} Get a payment type.
PUT systems/{systemid}/sites/{siteid}/paymenttypes/{paymenttypeid} Update fields for a payment type. See sdbpaymenttype for fields.
DELETE systems/{systemid}/sites/{siteid}/paymenttypes/{paymenttypeid} Delete a payment type.

Delivery Types

Collection of delivery types.

Resource Description
GET systems/{systemid}/sites/{siteid}/deliverytypes Get a collection of delivery types.
POST systems/{systemid}/sites/{siteid}/deliverytypes Add a delivery type. See sdbdeliverytype for fields.
GET systems/{systemid}/sites/{siteid}/deliverytypes/{deliverytypeid} Get a delivery type.
PUT systems/{systemid}/sites/{siteid}/deliverytypes/{deliverytypeid} Update fields for a delivery type. See sdbdeliverytype for fields.
DELETE systems/{systemid}/sites/{siteid}/deliverytypes/{deliverytypeid} Delete a delivery type.

Sales taxes

Collection of salex tax items.

Resource Description
GET systems/{systemid}/sites/{siteid}/salestaxes Get a collection of sales taxes.
POST systems/{systemid}/sites/{siteid}/salestaxes Add a sales tax item. See sdbsalestax for fields.
GET systems/{systemid}/sites/{siteid}/salestaxes/{salestaxid} Get a sales tax item.
PUT systems/{systemid}/sites/{siteid}/salestaxes/{salestaxid} Update fields for a sales tax item. See sdbsalestax for fields.
DELETE systems/{systemid}/sites/{siteid}/salestaxes/{salestaxid} Delete a sales tax item.

Files

Collection of files for a system

Resource Description
GET systems/{systemid}/sites/{siteid}/files Get a collection of files for the site. See sdbresource for fields.

Objects

Resource Description
sdbcategory Category
sdbdeliverytype Delivery Type
sdborder Order
sdborderitem Order Item
sdborderlogitem Order Log Item
sdbmanufacturer Manufacturer
sdbpaymenttype Payment Type
sdbpricelist Price List
sdbproduct Product
sdbproductvariant Product Variant
sdbproductvariantgroup Product Variant Group
sdbproductvariants Product Variants
sdbresource Image/File (Resource)
sdbsalestax Sales Tax
sdbsite Site
sdbsystem System
sdbuser User
Copyright 2012-2013 Sitoo. All rights Reserved. | www.sitoo.com