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

Stores

Add Store

post /sites/{siteid}/stores
PARAMETERS
siteid
integer
path
REQUIRED
REQUEST BODY
object
Store
posthttps://api.mysitoo.com/v2/accounts/1500/sites/1/stores.json
{
  "storetype": 20,
  "name": "Outlet Store",
  "externalid": "OUTLET-1",
  "externalgroupid": "NA",
  "state": "NY",
  "countryid": "us",
  "usetype_movein": 10,
  "usetype_moveout": 20
}
RESPONSE JSON
3
HTTP Status Code Summary
200Returns storeid
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 Stores

get /sites/{siteid}/stores
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 store.

Example: /sites/{siteid}/stores?fields=storeid,name
Returns

Returns an envelope with items of type store.

Store
gethttps://api.mysitoo.com/v2/accounts/1500/sites/1/stores.json?num=2&fields=storeid,storetype,name,address,city,usetype_movein,usetype_moveout
RESPONSE JSON
{
  "totalcount": 2,
  "items": [
    {
      "storeid": 1,
      "storetype": 10,
      "name": "Concept Store",
      "address": "240 W Broadway",
      "city": "New York",
      "usetype_movein": 10,
      "usetype_moveout": 20
    },
    {
      "storeid": 2,
      "storetype": 30,
      "name": "Pop-Up Store",
      "address": "",
      "city": "",
      "usetype_movein": null,
      "usetype_moveout": null
    }
  ]
}
HTTP Status Code Summary
200Returns an envelope with items of type store.
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 Store

get /sites/{siteid}/stores/{storeid}
PARAMETERS
siteid
integer
path
REQUIRED
storeid
integer
path
REQUIRED
Returns

Returns an item of type store.

Store
gethttps://api.mysitoo.com/v2/accounts/1500/sites/1/stores/3.json
RESPONSE JSON
{
  "storeid": 3,
  "storetype": 20,
  "name": "Outlet Store",
  "externalid": "OUTLET-1",
  "externalgroupid": "NA",
  "phone": null,
  "email": null,
  "address": "",
  "address2": "",
  "zip": "",
  "city": "",
  "state": "NY",
  "countryid": "us",
  "latitude": null,
  "longitude": null,
  "nearby_stores": [],
  "usetype_movein": 10,
  "usetype_moveout": 20,
  "usetype_manualin": null,
  "usetype_manualout": null,
  "usetype_shipmentin": null,
  "usetype_shipmentout": null,
  "tags": [],
  "additional_data": null
}
HTTP Status Code Summary
200Returns an item of type store.
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 Store

put /sites/{siteid}/stores/{storeid}
PARAMETERS
siteid
integer
path
REQUIRED
storeid
integer
path
REQUIRED
REQUEST BODY
object
Store
puthttps://api.mysitoo.com/v2/accounts/1500/sites/1/stores/3.json
{
  "address": "Main Street",
  "city": "New York"
}
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 Store

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

Objects

Store
object

The store object in Sitoo

PROPERTIES
storeid
integer
READ ONLY

Unique ID of store in Sitoo.

eshopid
integer
nullable

Eshop ID that store belongs to.

storetype
StoreType
REQUIRED

The type of the store

name
string
REQUIRED

The name of the store

externalid
string

External ID for the store (or null). Used as store identifier in other Sitoo services.

externalgroupid
string

External Grouping ID for the store (or null).

phone
string

Phone number for the store (or null).

email
string

Email for the store (or null).

address
string

Address for the store.

address2
string

Address 2 for the store.

zip
string

Zip for the store.

city
string

City for the store.

state
string

State for the store.

countryid
string

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

latitude
string

Latitude in decimal degrees for location of store (or null).

longitude
string

Longitude in decimal degrees for location of store (or null).

nearby_stores
array
(integer)

Array of storeid (integer) for nearby stores to this store.

usetype_movein
WarehouseUseType

Default warehouse usetype for transfers of type Move In (or null).

usetype_moveout
WarehouseUseType

Default warehouse usetype for transfers of type Move Out (or null).

usetype_manualin
WarehouseUseType

Default warehouse usetype for transfers of type Manual In (or null).

usetype_manualout
WarehouseUseType

Default warehouse usetype for transfers of type Manual Out (or null).

usetype_shipmentin
WarehouseUseType

Default warehouse usetype for transfers of type Shipment In (or null).

usetype_shipmentout
WarehouseUseType

Default warehouse usetype for transfers of type Shipment Out (or null).

tags
array
(string)

Array of tags for store.

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

Additional data for this store. The properties below are a summary of defined properties that may be used by Sitoo or external integrations. Other properties are also allowed as long as their values are of type string.

<*>
string
Custom properties are allowed if the value is of type string.

StoreType
integer

  • 10 Store
  • 20 Outlet
  • 30 PopUp
  • 40 Mobile
  • 50 Online

WarehouseUseType
integer

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