Introduction
Guides
API Reference
SPI CRM v2
SPI CRM v1
SPI Events
SPI Gift Card
SPI Payment
SPI Product Recommendations
SPI Product Search
Journals v3
Purchase Prices v3
Shipments v3

Products

Batch Add Products

post /sites/{siteid}/products

This functions allows multiple items to be sent at once, like in the example below. For each item sent in an array a response is returned.

PARAMETERS
siteid
integer
path
REQUIRED
REQUEST BODY
array
product
posthttps://api.mysitoo.com/v2/accounts/1500/sites/1/products.json
[
  {
    "sku": "Q100",
    "title": "Box",
    "moneyprice": "99.00"
  },
  {
    "sku": "Q101",
    "title": "Box Deluxe",
    "moneyprice": "129.00"
  }
]
RESPONSE JSON
[
  {
    "statuscode": 200,
    "return": 28
  },
  {
    "statuscode": 200,
    "return": 29
  }
]
HTTP Status Code Summary
200Returns productid or a batch envelope if multiple products were added
400Bad Request. Invalid syntax, missing required argument or invalid request.
401Unauthorized. Authorization failed.
404Resource not found. The url is invalid.
429Too Many Requests.
500Internal Server Error.

Get Products

get /sites/{siteid}/products

Get collection of product. Note! Only request fields that you need since some fields are calculated and can result in unnecessary lengthy operations.

PARAMETERS
siteid
integer
path
REQUIRED
sku
array (string)
query

Filter on SKU, use comma as separator for multiple values.

productid
array (integer)
query

Filter on product ID, use comma as separator for multiple values.

includeinactive
boolean
query

Include products that are not active in POS or Webshop.

Default: false
datelastmodified
integer
query

Include products that have been modified after the timestamp provided.

start
integer
query

The index of the item to start from.

Default: 0
num
integer
query

The number of items returned.

Default: 10
fields
array (string)
query

Comma separated list of fields to return. Use this to query only the fields you are using. See product for all fields.

Default: [ "productid", "sku", "datemodified", "active", "activepos", "vatid", "manufacturerid", "stockcountenable", "stockallowbackorder", "barcode", "moneyprice", "moneyfinalprice" ]
Example: /sites/{siteid}/products?fields=productid,sku
Returns

Returns an envelope with items of type product.

product
gethttps://api.mysitoo.com/v2/accounts/1500/sites/1/products.json?start=2&num=5&fields=productid,sku,title,moneyprice
RESPONSE JSON
{
  "totalcount": 18,
  "items": [
    {
      "productid": 12,
      "sku": "10038-1",
      "moneyprice": "10392.00",
      "title": "Sofa Grand III"
    },
    {
      "productid": 13,
      "sku": "10038-5",
      "moneyprice": "10392.00",
      "title": "Kitchen Table"
    },
    {
      "productid": 14,
      "sku": "10038-2",
      "moneyprice": "10392.00",
      "title": "Sofa Cosy"
    },
    {
      "productid": 15,
      "sku": "83537-0",
      "moneyprice": "7592.00",
      "title": "Sofa Stressless"
    },
    {
      "productid": 16,
      "sku": "83428-0",
      "moneyprice": "6392.00",
      "title": "Sofa Modern"
    }
  ]
}
HTTP Status Code Summary
200Returns an envelope with items of type product.
400Bad Request. Invalid syntax, missing required argument or invalid request.
401Unauthorized. Authorization failed.
404Resource not found. The url is invalid.
429Too Many Requests.
500Internal Server Error.

Batch Update Products

put /sites/{siteid}/products

Send an array of object. Either the productid or sku must be provided as identifier field for each item. If both are provided, the productid will have precedence over sku.

PARAMETERS
siteid
integer
path
REQUIRED
REQUEST BODY
array
product
puthttps://api.mysitoo.com/v2/accounts/1500/sites/1/products.json
[
  {
    "productid": 12,
    "descriptionshort": "New Design"
  },
  {
    "productid": 13,
    "descriptionshort": "New Design"
  }
]
RESPONSE JSON
[
  {
    "statuscode": 200,
    "return": true
  },
  {
    "statuscode": 200,
    "return": true
  }
]
HTTP Status Code Summary
200Returns true or a batch envelope if multiple products were updated
400Bad Request. Invalid syntax, missing required argument or invalid request.
401Unauthorized. Authorization failed.
404Resource not found. The url is invalid.
429Too Many Requests.
500Internal Server Error.

Batch Delete Products

delete /sites/{siteid}/products

See product for fields.Required fields:productid

PARAMETERS
siteid
integer
path
REQUIRED
REQUEST BODY
array
deletehttps://api.mysitoo.com/v2/accounts/1500/sites/1/products.json
[
  {
    "productid": 18
  },
  {
    "productid": 19
  }
]
RESPONSE JSON
[
  {
    "statuscode": 200,
    "return": true
  },
  {
    "statuscode": 200,
    "return": true
  }
]
HTTP Status Code Summary
200Returns true or a batch envelope if multiple products were deleted
400Bad Request. Invalid syntax, missing required argument or invalid request.
401Unauthorized. Authorization failed.
404Resource not found. The url is invalid.
429Too Many Requests.
500Internal Server Error.

Get Product

get /sites/{siteid}/products/{productid}
PARAMETERS
siteid
integer
path
REQUIRED
productid
integer
path
REQUIRED
Returns

Returns an item of type product.

product
gethttps://api.mysitoo.com/v2/accounts/1500/sites/1/products/21.json
RESPONSE JSON
{
  "productid": 21,
  "sku": "54051-1",
  "skumanufacturer": "",
  "descriptionshort": "",
  "description": "",
  "descriptionhtml": "",
  "deliverystatus": "",
  "moneyprice": "59.00",
  "moneypriceorg": "59.00",
  "moneypricein": "8.00",
  "unitlabel": "",
  "allowdecimals": false,
  "deliveryinfo": "",
  "externalinputtitle": "",
  "offerisenabled": false,
  "moneyofferprice": "0.00",
  "offertitle": "",
  "offerdatestart": null,
  "offerdateend": null,
  "active": true,
  "activepos": true,
  "vatid": 2,
  "deliveryclassid": 1,
  "defaultcategoryid": 49,
  "categories": [
    19,
    49,
    59
  ],
  "manufacturerid": null,
  "manufacturerurl": "",
  "custom1": "",
  "custom2": "",
  "custom3": "",
  "custom4": "",
  "custom5": "",
  "stockcountenable": true,
  "stockallowbackorder": true,
  "variantparentid": 21,
  "barcode": null,
  "barcodealiases": [],
  "similar": [
    13
  ],
  "related": [
    12,
    14,
    15,
    16
  ],
  "accessories": [],
  "offerisactive": false,
  "moneyfinalprice": "59.00",
  "vatvalue": 25,
  "productgrouptype": 10,
  "pricelisthasvolume": false,
  "variant": [
    {
      "name": "Color",
      "value": "Red"
    },
    {
      "name": "Pattern",
      "value": "Striped"
    }
  ],
  "friendly": "blanket-red-striped",
  "seo_title": "Blanket",
  "seo_keywords": "",
  "seo_description": "",
  "title": "Blanket Red Striped",
  "datecreated": 1373026247,
  "datemodified": 1373026433
}
HTTP Status Code Summary
200Returns an item of type product.
400Bad Request. Invalid syntax, missing required argument or invalid request.
401Unauthorized. Authorization failed.
404Resource not found. The url is invalid.
429Too Many Requests.
500Internal Server Error.

Update Product

put /sites/{siteid}/products/{productid}
PARAMETERS
siteid
integer
path
REQUIRED
productid
integer
path
REQUIRED
REQUEST BODY
object
product
puthttps://api.mysitoo.com/v2/accounts/1500/sites/1/products/21.json
{
  "title": "Blanket Red Striped"
}
RESPONSE JSON
true
HTTP Status Code Summary
200Returns true
400Bad Request. Invalid syntax, missing required argument or invalid request.
401Unauthorized. Authorization failed.
404Resource not found. The url is invalid.
429Too Many Requests.
500Internal Server Error.

Delete Product

delete /sites/{siteid}/products/{productid}
PARAMETERS
siteid
integer
path
REQUIRED
productid
integer
path
REQUIRED
deletehttps://api.mysitoo.com/v2/accounts/1500/sites/1/products/24.json
RESPONSE JSON
true
HTTP Status Code Summary
200Returns true
400Bad Request. Invalid syntax, missing required argument or invalid request.
401Unauthorized. Authorization failed.
404Resource not found. The url is invalid.
429Too Many Requests.
500Internal Server Error.

Objects

money
string

Pattern: ^[-+]?[0-9]+\.[0-9]{2}$
Example: "123.00"

product
object

The main product object. Note that stock values are retrieved using the warehouse endpoints.

PROPERTIES
productid
integer
READ ONLY

The unique internal product ID. It is unique over all sites in the system. The productid is read-only and automatically generated when adding new products. It is then used as the identifier field for update/delete endpoints.

sku
string
REQUIRED

Stock Keeping Unit (ie. the article number). Should only contain [A-Za-z0-9_+-/]. The sku is a required field for adding new products and needs to be unique within a site.

skumanufacturer
string

The Stock Keeping Unit (SKU) for the manufacturer.

Default: ""
descriptionshort
string

A short description, typically used in product lists etc.

Default: ""
description
string

The main description of the product.

Default: ""
descriptionhtml
string
DEPRECATED

An extra description field for adding custom html such as embedded videos etc.

Default: ""
deliverystatus
string
DEPRECATED

Delivery status.

Default: ""
moneyprice
money

Price of the product. If this field is used for setting price on a product, the price will be set for the "Default" price list. It is recommended to use the Price Lists endpoints for setting product prices instead.

Default: "0.00"
moneypriceorg
money

Suggested Retail Price (SRP)

Default: "0.00"
moneypricein
money

Purchase price which can be used to help calculate profit on products. (Always excluding VAT)

Default: "0.00"
unitlabel
string

Unit label (eg. "pcs", "kg"). Default is an empty string.

Default: ""
allowdecimals
boolean

Set this if the product can be purchased with fractional quantity.

Default: false
deliveryinfo
string

Delivery information that can be provided to the customer after the purchase.

Default: ""
externalinputtitle
string
DEPRECATED

External input title is a text that the customer can add to the product in the cart (eg. for a t-shirt it could be an optional custom text).

Default: ""
offerisenabled
boolean
DEPRECATED

Turn on or off the offer mechanism. (Deprecated, use price lists instead)

Default: false
moneyofferprice
money
DEPRECATED

If the product is in offer mode, the offerprice will be used instead of the price. The product is in offer mode if enabled and within the offer date period. (Deprecated, use price lists instead)

Default: "0.00"
offertitle
string
DEPRECATED

Title of offer (eg. "Summer Campaign"). (Deprecated, use price lists instead)

Default: ""
offerdatestart
timestamp
DEPRECATED

Start date of offer. If null then no start boundary is set. (Deprecated, use price lists instead)

offerdateend
timestamp
DEPRECATED

End date of offer. The last day the offer is still active. If null then no end boundary is set. To turn off date check for offers just set offerdatestart and offerdateend to null. (Deprecated, use price lists instead)

active
boolean
DEPRECATED

If false, the product is not shown in in the Webshop.

Default: true
activepos
boolean

If false, the product is not shown in in the POS.

Default: true
vatid
integer

The reference to which Product Group the product belongs to. The Product Group also determines VAT. See productgroup for more information.

Default: 2
deliveryclassid
integer
DEPRECATED

The reference to the delivery class ID. The ID is used when calculating the shipping price.

Default: 1
defaultcategoryid
integer
nullable

Default category for the product. If set to a category then the value will also be added to categories. If set to null, then the previous value will be removed from categories.

categories
array
(integer)

Array of category ID:s that the product belongs to.

Default: []
manufacturerid
integer
nullable

The reference to the manufacturer.

manufacturerurl
string

Manufacturer's url for the product.

Default: ""
custom1
string

Custom field 1.

Default: ""
custom2
string

Custom field 2.

Default: ""
custom3
string

Custom field 3.

Default: ""
custom4
string

Custom field 4.

Default: ""
custom5
string

Custom field 5.

Default: ""
stockcountenable
boolean

Turns on/off stock handling for the product.

Default: true
stockallowbackorder
boolean
DEPRECATED

Decides if a product can be backorder listed. If not, it is not displayed when out of stock.

Default: true
variantparentid
integer
nullable
READ ONLY

If null then it is a single product, otherwise it is a variant. Variantparentid refers to the owning parent's productid. The product which has a self reference (ie. the variantparentid is same as the produtid) is the main variant (ie. the owner).

barcode
string
nullable

Barcode for the product.

barcodealiases
array
(string)

Barcode aliases for the product. Used if multiple barcodes exist for product.

Default: []
similar
array
(integer)

Array of product ID:s for products that are similar to this one. (Only applicable to regular products and main product variants)

Default: []
related
array
(integer)

Array of product ID:s for products that are related to this one. (Only applicable to regular products and main product variants)

Default: []
accessories
array
(integer)

Array of product ID:s for products that are accessories to this one. (Only applicable to regular products and main product variants)

Default: []
offerisactive
boolean
READ ONLY
DEPRECATED

Indicates if the product is in offer mode or not.

moneyfinalprice
money
READ ONLY
DEPRECATED

The final price of the product. If in offer mode then the final price is offerprice else price. (Deprecated, use price lists instead)

vatvalue
number
READ ONLY

The VAT in percentage.

productgrouptype
productgrouptype
READ ONLY

The product group type.

pricelisthasvolume
boolean
READ ONLY
DEPRECATED

True if product has volume pricing. (Deprecated, use price lists instead)

variant
array
(object)
READ ONLY

Array of variant items.

Example: "[ { "name": "Size", "value": "Medium" } ]"
PROPERTIES
name
string
value
string
customattributes
object

Map of attribute values for the product. The keys must exist as ID of attributes defined. The value type is defined by the attribute. The limit of string values is 128 characters.

<*>
object
friendly
string
DEPRECATED

Friendly name. Absolute url = site url + friendly.

Default: ""
seo_title
string
DEPRECATED

Used for the html title element. If empty the title field will be used instead.

Default: ""
seo_keywords
string
DEPRECATED

Meta keywords.

Default: ""
seo_description
string
DEPRECATED

Meta description.

Default: ""
title
string

Title of product (ie. Product Name).

Default: ""
datecreated
timestamp
READ ONLY

Timestamp when the product was created.

datemodified
timestamp
READ ONLY

Timestamp when the product was last modified.

productgrouptype
integer

  • 10 Product
  • 20 Service
  • 30 Gift Card

timestamp
integer

Number of seconds since the Unix Epoch.

Copyright © 2024 Sitoo AB. All rights reserved.