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

Warehouses

Add Warehouse

post /sites/{siteid}/warehouses.json
PARAMETERS
siteid
integer
path
REQUIRED
REQUEST BODY
object
warehouse
posthttps://api.mysitoo.com/v2/accounts/1500/sites/1/warehouses.json
{
  "usetype": 40,
  "currencycode": "USD",
  "name": "Reclaims"
}
RESPONSE JSON
4
HTTP Status Code Summary
200Returns warehouseid
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 Warehouses

get /sites/{siteid}/warehouses.json
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 warehouse.

Example: /sites/{siteid}/warehouses.json?fields=warehouseid,name,storeid,sellable
Returns

Returns an envelope with items of type warehouse.

warehouse
gethttps://api.mysitoo.com/v2/accounts/1500/sites/1/warehouses.json?num=2&fields=warehouseid,warehousetype,usetype,storeid,sellable,name,externalid
RESPONSE JSON
{
  "totalcount": 3,
  "items": [
    {
      "warehouseid": 1,
      "warehousetype": 10,
      "usetype": 10,
      "storeid": 1,
      "sellable": true,
      "name": "Warehouse 1",
      "externalid": null
    },
    {
      "warehouseid": 2,
      "warehousetype": 10,
      "usetype": 10,
      "storeid": null,
      "sellable": true,
      "name": "Warehouse 2",
      "externalid": null
    }
  ]
}
HTTP Status Code Summary
200Returns an envelope with items of type warehouse.
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 Warehouse

get /sites/{siteid}/warehouses/{warehouseid}.json
PARAMETERS
siteid
integer
path
REQUIRED
warehouseid
integer
path
REQUIRED
Returns

Returns an item of type warehouse.

warehouse
gethttps://api.mysitoo.com/v2/accounts/1500/sites/1/warehouses/4.json
RESPONSE JSON
{
  "warehouseid": 4,
  "warehousetype": 10,
  "usetype": 40,
  "storeid": null,
  "sellable": true,
  "currencycode": "USD",
  "name": "Reclaims",
  "address": "",
  "address2": "",
  "zip": "",
  "city": "",
  "state": "",
  "countryid": null,
  "externalid": ""
}
HTTP Status Code Summary
200Returns an item of type warehouse.
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 Warehouse

put /sites/{siteid}/warehouses/{warehouseid}.json
PARAMETERS
siteid
integer
path
REQUIRED
warehouseid
integer
path
REQUIRED
REQUEST BODY
object
warehouse
puthttps://api.mysitoo.com/v2/accounts/1500/sites/1/warehouses/4.json
{
  "name": "Demo",
  "usetype": 20
}
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 Warehouse

delete /sites/{siteid}/warehouses/{warehouseid}.json
PARAMETERS
siteid
integer
path
REQUIRED
warehouseid
integer
path
REQUIRED
deletehttps://api.mysitoo.com/v2/accounts/1500/sites/1/warehouses/4.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 Warehouse Items

get /sites/{siteid}/warehouses/{warehouseid}/warehouseitems.json
PARAMETERS
siteid
integer
path
REQUIRED
warehouseid
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
datelastmodifiedfrom
integer
query

Filter on warehouseitems with datelastmodified starting from the timestamp provided

datelastmodifiedto
integer
query

Filter on warehouseitems with datelastmodified ending before the timestamp provided

sku
array (string)
query

Filter on SKU, use comma as separator for multiple values

Example: /sites/{siteid}/warehouses/{warehouseid}/warehouseitems.json?sku=123456,23456
sort
string
query

Sort the result.

Available values:
  • warehouseitemid
  • -warehouseitemid
  • sku
  • -sku
  • binlocation
  • -binlocation
  • decimalthreshold
  • -decimalthreshold
  • decimaltotal
  • -decimaltotal
  • decimalreserved
  • -decimalreserved
  • decimalavailable
  • -decimalavailable
  • moneytotal
  • -moneytotal
  • datelastmodified
  • -datelastmodified
  • datelaststocktaking
  • -datelaststocktaking
Default: "warehouseitemid"
fields
array (string)
query

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

Default: [ "warehouseitemid", "sku", "binlocation", "decimalthreshold", "decimaltotal", "moneytotal", "datelastmodified", "datelaststocktaking" ]
Example: /sites/{siteid}/warehouses/{warehouseid}/warehouseitems.json?fields=sku,decimaltotal,datelastmodified
Returns

Returns an envelope with items of type warehouseitem for a warehouse.

warehouseitem
gethttps://api.mysitoo.com/v2/accounts/1500/sites/1/warehouses/1/warehouseitems.json?num=2&fields=warehouseitemid,sku,binlocation,decimalthreshold,decimaltotal,moneytotal,datelastmodified,datelaststocktaking,decimalreserved,decimalavailable
RESPONSE JSON
{
  "totalcount": 14,
  "items": [
    {
      "warehouseitemid": 1,
      "sku": "10038-3",
      "binlocation": "",
      "decimalthreshold": "3.000",
      "decimaltotal": "5.000",
      "moneytotal": "19600.00",
      "datelastmodified": 1462874148,
      "datelaststocktaking": 1462874148,
      "decimalreserved": "0.000",
      "decimalavailable": "5.000"
    },
    {
      "warehouseitemid": 2,
      "sku": "10038-4",
      "binlocation": "",
      "decimalthreshold": "3.000",
      "decimaltotal": "5.000",
      "moneytotal": "19600.00",
      "datelastmodified": 1462874148,
      "datelaststocktaking": 1462874148,
      "decimalreserved": "0.000",
      "decimalavailable": "5.000"
    }
  ]
}
HTTP Status Code Summary
200Returns an envelope with items of type warehouseitem for a warehouse.
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 Warehouse Items

put /sites/{siteid}/warehouses/{warehouseid}/warehouseitems.json
PARAMETERS
siteid
integer
path
REQUIRED
warehouseid
integer
path
REQUIRED
REQUEST BODY
array
warehouseitem
puthttps://api.mysitoo.com/v2/accounts/1500/sites/1/warehouses/1/warehouseitems.json
[
  {
    "sku": "10038-1",
    "binlocation": "I3:S4",
    "decimalthreshold": "10.000"
  },
  {
    "sku": "10038-2",
    "binlocation": "I3:S5",
    "decimalthreshold": "3.000"
  }
]
RESPONSE JSON
[
  {
    "statuscode": 200,
    "return": 3
  },
  {
    "statuscode": 200,
    "return": 5
  }
]
HTTP Status Code Summary
200Returns a batch envelope with warehouseitemid for the warehouseitems set.
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"

timestamp
integer

Number of seconds since the Unix Epoch.

warehouse
object

A location for stockenabled goods.

PROPERTIES
warehouseid
integer
READ ONLY

The unique ID of the warehouse.

warehousetype
warehousetype

Type of warehouse.

usetype
warehouseusetype
REQUIRED

Use type for warehouse.

storeid
integer

The ID of the store that the warehouse belongs to or null if not connected to a store.

sellable
boolean

Determines if the warehouse contains sellable stock.

currencycode
string
REQUIRED

The currency code used for the warehouse (3-letter ISO 4217).

name
string
REQUIRED

The name of the warehouse.

address
string

Address for the warehouse.

address2
string

Address 2 for the warehouse.

zip
string

Zip for the warehouse.

city
string

City for the warehouse.

state
string

State for the warehouse.

countryid
string

Country ID for the warehouse (2-letter ISO 3166).

externalid
string

External ID for the warehouse.

warehouseitem
object

Contains the current state of a product's stock count and stock value. Also has the bin location within the warehouse and the reordering threshold.

PROPERTIES
warehouseitemid
integer
READ ONLY

The unique ID of the warehouseitem.

sku
string
REQUIRED

The SKU for this stock item.

binlocation
string

Bin location for the stock for this warehouse.

decimalthreshold
string

Threshold for ordering new stock.

decimaltotal
string

Current stock level for this warehouseitem. (Read Only if not warehousetype Virtual)

moneytotal
money

Current stock value for this warehouseitem. (Read Only if not warehousetype Virtual)

datelastmodified
timestamp
READ ONLY

The last date this warehouseitem has been part of a transaction.

datelaststocktaking
timestamp
READ ONLY

The last date this warehouseitem has been part of a stocktaking transaction.

decimalreserved
string
READ ONLY

Reserved stock level for this warehouseitem.

decimalavailable
string
READ ONLY

Available stock level for this warehouseitem.

warehousetype
integer

  • 10 FIFO
  • 20 Virtual

warehouseusetype
integer

  • 10 Front
  • 20 Back
  • 30 Demo
  • 40 Reclaim
  • 50 External
Copyright © 2024 Sitoo AB. All rights reserved.