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

Price Lists

Add Price List

post /sites/{siteid}/pricelists

Note! The total number of price lists allowed is limited to 100.

PARAMETERS
siteid
integer
path
REQUIRED
REQUEST BODY
object
pricelist
posthttps://api.mysitoo.com/v2/accounts/1500/sites/1/pricelists.json
{
  "pricelistname": "Resellers"
}
RESPONSE JSON
3
HTTP Status Code Summary
200Returns pricelistid
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 Price Lists

get /sites/{siteid}/pricelists
PARAMETERS
siteid
integer
path
REQUIRED
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. Default is all fields in pricelist.

Example: /sites/{siteid}/pricelists?fields=pricelistid,pricelistname,tags
Returns

Returns an envelope with items of type pricelist.

pricelist
gethttps://api.mysitoo.com/v2/accounts/1500/sites/1/pricelists.json?num=2
RESPONSE JSON
{
  "totalcount": 2,
  "items": [
    {
      "pricelistid": 1,
      "pricelistname": "Default Price List",
      "pricelistdescription": "",
      "active": true,
      "externalid": null,
      "currencycode": "USD",
      "tags": []
    },
    {
      "pricelistid": 2,
      "pricelistname": "Secondary Price List",
      "pricelistdescription": "",
      "active": true,
      "externalid": null,
      "currencycode": "USD",
      "tags": []
    }
  ]
}
HTTP Status Code Summary
200Returns an envelope with items of type pricelist.
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 Price List

get /sites/{siteid}/pricelists/{pricelistid}
PARAMETERS
siteid
integer
path
REQUIRED
pricelistid
integer
path
REQUIRED
Returns

Returns an item of type pricelist.

pricelist
gethttps://api.mysitoo.com/v2/accounts/1500/sites/1/pricelists/3.json
RESPONSE JSON
{
  "pricelistid": 3,
  "pricelistname": "Resellers",
  "pricelistdescription": "",
  "active": true,
  "externalid": null,
  "currencycode": "USD",
  "tags": []
}
HTTP Status Code Summary
200Returns an item of type pricelist.
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 Price List

put /sites/{siteid}/pricelists/{pricelistid}
PARAMETERS
siteid
integer
path
REQUIRED
pricelistid
integer
path
REQUIRED
REQUEST BODY
object
pricelist
puthttps://api.mysitoo.com/v2/accounts/1500/sites/1/pricelists/3.json
{
  "pricelistdescription": "Pricelist for Resellers"
}
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 Price List

delete /sites/{siteid}/pricelists/{pricelistid}
PARAMETERS
siteid
integer
path
REQUIRED
pricelistid
integer
path
REQUIRED
deletehttps://api.mysitoo.com/v2/accounts/1500/sites/1/pricelists/3.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.

Get Price Lists Items

get /sites/{siteid}/pricelists/{pricelistid}/pricelistitems
PARAMETERS
siteid
integer
path
REQUIRED
pricelistid
integer
path
REQUIRED
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 pricelistitem for all fields.

Default: [ "sku", "moneyprice" ]
Example: /sites/{siteid}/pricelists/{pricelistid}/pricelistitems?fields=sku,moneyprice
Returns

Returns an envelope with items of type pricelistitem for a pricelist, ordered by productid.

pricelistitem
gethttps://api.mysitoo.com/v2/accounts/1500/sites/1/pricelists/2/pricelistitems.json?num=2&fields=sku,moneyprice,moneypricevolume
RESPONSE JSON
{
  "totalcount": 3,
  "items": [
    {
      "moneyprice": "795.00",
      "moneypricevolume": null,
      "sku": "36305-1"
    },
    {
      "moneyprice": "895.00",
      "moneypricevolume": [
        {
          "levelstart": 2,
          "moneyprice": "849.00"
        },
        {
          "levelstart": 4,
          "moneyprice": "749.00"
        }
      ],
      "sku": "36401-1"
    }
  ]
}
HTTP Status Code Summary
200Returns an envelope with items of type pricelistitem for a pricelist, ordered by productid.
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 Set Price List Items

put /sites/{siteid}/pricelists/{pricelistid}/pricelistitems
PARAMETERS
siteid
integer
path
REQUIRED
pricelistid
integer
path
REQUIRED
REQUEST BODY
array
pricelistitem
puthttps://api.mysitoo.com/v2/accounts/1500/sites/1/pricelists/2/pricelistitems.json
[
  {
    "sku": "36305-1",
    "moneyprice": "795.00"
  },
  {
    "sku": "36401-1",
    "moneyprice": "895.00",
    "moneypricevolume": [
      {
        "levelstart": 2,
        "moneyprice": "849.00"
      },
      {
        "levelstart": 4,
        "moneyprice": "749.00"
      }
    ]
  },
  {
    "sku": "36522-3",
    "moneyprice": "849.00",
    "moneypricevolume": [
      {
        "levelstart": 4,
        "moneyprice": "729.00"
      }
    ]
  }
]
RESPONSE JSON
[
  {
    "statuscode": 200,
    "return": true
  },
  {
    "statuscode": 200,
    "return": true
  },
  {
    "statuscode": 200,
    "return": 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.

Batch Delete Price List Items

delete /sites/{siteid}/pricelists/{pricelistid}/pricelistitems
PARAMETERS
siteid
integer
path
REQUIRED
pricelistid
integer
path
REQUIRED
REQUEST BODY
array
deletehttps://api.mysitoo.com/v2/accounts/1500/sites/1/pricelists/2/pricelistitems.json
[
  {
    "sku": "36305-1"
  },
  {
    "sku": "36401-1"
  },
  {
    "sku": "36522-3"
  }
]
RESPONSE JSON
[
  {
    "statuscode": 200,
    "return": true
  },
  {
    "statuscode": 200,
    "return": true
  },
  {
    "statuscode": 200,
    "return": true
  }
]
HTTP Status Code Summary
200Returns true or a batch envelope if array of objects was provided
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"

pricelist
object

Use price lists to set different prices for products.

PROPERTIES
pricelistid
integer
READ ONLY

Price list ID (default pricelist has ID 1 on all systems).

pricelistname
string
REQUIRED

Price list name.

pricelistdescription
string

Price list description.

active
boolean

If true, the price list is active.

externalid
string

External ID of price list (if applicable, otherwise null).

currencycode
string

Currency of the price list (ISO 4217, alpha-3 uppercased).

tags
array
(string)

The tags for this price list. Tags can be used to only apply the pricelist for certain stores or campaigns.

Pattern: ^[A-Z0-9_-]{1,16}$

pricelistitem
object

Price list item for a pricelist

PROPERTIES
productid
integer

Product ID for the price list item.

moneyprice
money
REQUIRED

The price for the product.

moneypricevolume
array
(volumepricelevel)

Volume pricing for the price list item. Array of volumepricelevel.

sku
string

SKU for the price list item.

volumepricelevel
object

Volume price level of a pricelistitem

PROPERTIES
levelstart
integer

The quantity threshold to activate this price.

moneyprice
money

The price of the product at this quantity.

Copyright © 2024 Sitoo AB. All rights reserved.