REST API v2.15

Stores

Handle stores.

Get Stores

Endpoint

GET sites/{siteid}/stores

Parameters

start

The index of the item to start fromDefault: 0

num

The number of items returnedDefault: 10

fields

Comma separated list of fields to return. Use this to query only the fields you are using. Default is all fields in store.

HTTP Response Status

200

OK. Returns data (see below).

400

Bad Request. Invalid syntax, missing required argument or invalid request.

401

Unauthorized. Authorization failed.

404

Resource not found. The url is invalid.

429

Too Many Requests.

500

Internal Server Error.

Returns

Returns an envelope with items of type store.

Example

Request

GET https://api.mysitoo.com/v2/accounts/1500/sites/1/stores.json?num=2&fields=storeid,storetype,name,address,city,usetype_movein,usetype_moveout

Response

{ "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 } ] }

Add Store

Endpoint

POST sites/{siteid}/stores

Request body

See store for fields.
Required fields:
storetypename

HTTP Response Status

200

OK. Returns data (see below).

400

Bad Request. Invalid syntax, missing required argument or invalid request.

401

Unauthorized. Authorization failed.

404

Resource not found. The url is invalid.

429

Too Many Requests.

500

Internal Server Error.

Returns

Returns storeid if successful.

Example

Request

POST https://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

3

Get Store

Endpoint

GET sites/{siteid}/stores/{storeid}

HTTP Response Status

200

OK. Returns data (see below).

400

Bad Request. Invalid syntax, missing required argument or invalid request.

401

Unauthorized. Authorization failed.

404

Resource not found. The url is invalid.

429

Too Many Requests.

500

Internal Server Error.

Returns

Returns an item of type store.

Example

Request

GET https://api.mysitoo.com/v2/accounts/1500/sites/1/stores/3.json

Response

{ "storeid": 3, "storetype": 20, "name": "Outlet Store", "externalid": "OUTLET-1", "externalgroupid": "NA", "address": "", "address2": "", "zip": "", "city": "", "state": "NY", "countryid": "us", "latitude": null, "longitude": null, "usetype_movein": 10, "usetype_moveout": 20, "usetype_manualin": null, "usetype_manualout": null, "usetype_shipmentin": null, "usetype_shipmentout": null }

Update Store

Endpoint

PUT sites/{siteid}/stores/{storeid}

Request body

See store for fields.

HTTP Response Status

200

OK. Returns data (see below).

400

Bad Request. Invalid syntax, missing required argument or invalid request.

401

Unauthorized. Authorization failed.

404

Resource not found. The url is invalid.

429

Too Many Requests.

500

Internal Server Error.

Returns

Returns true if successful.

Example

Request

PUT https://api.mysitoo.com/v2/accounts/1500/sites/1/stores/3.json { "address": "Main Street", "city": "New York" }

Response

true

Delete Store

Endpoint

DELETE sites/{siteid}/stores/{storeid}

HTTP Response Status

200

OK. Returns data (see below).

400

Bad Request. Invalid syntax, missing required argument or invalid request.

401

Unauthorized. Authorization failed.

404

Resource not found. The url is invalid.

429

Too Many Requests.

500

Internal Server Error.

Returns

Returns true if successful.

Example

Request

DELETE https://api.mysitoo.com/v2/accounts/1500/sites/1/stores/3.json

Response

true