Manufacturers

Batch Add Manufacturers

post /sites/{siteid}/manufacturers
PARAMETERS
siteid
integer
path
REQUIRED
REQUEST BODY
posthttps://api.mysitoo.com/v2/accounts/1500/sites/1/manufacturers.json
[
{
"name": "Sitoo",
"url1": "http://www.sitoo.com"
},
{
"name": "Example Inc.",
"url1": "http://www.example.com"
}
]
RESPONSE JSON
[
{
"statuscode": 200,
"return": 5
},
{
"statuscode": 200,
"return": 6
}
]
HTTP Status Code Summary
200Returns manufacturerid or a batch envelope if multiple manufacturers 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 Manufacturers

get /sites/{siteid}/manufacturers
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 manufacturer.

Example: /sites/{siteid}/manufacturers?fields=externalcompanyid,name
RETURNS

Returns an envelope with items of type manufacturer.

gethttps://api.mysitoo.com/v2/accounts/1500/sites/1/manufacturers.json?num=2
RESPONSE JSON
{
"totalcount": 2,
"items": [
{
"externalcompanyid": 1,
"name": "Cornerstone",
"description": "Furniture manufacturer",
"address": "12 Main Street",
"zip": "10310",
"city": "Townsville",
"state": "FL",
"countryid": "us",
"phone": "",
"email": "sales@sitoo.com",
"url1": "http://www.sitoo.com",
"url2": "www.sitoo.com"
},
{
"externalcompanyid": 3,
"name": "Knoxville",
"description": "Sofa manufacturer",
"address": "12 Main Street",
"zip": "10310",
"city": "Townsville",
"state": "FL",
"countryid": "us",
"phone": "",
"email": "sales@sitoo.com",
"url1": "http://www.sitoo.com",
"url2": "www.sitoo.com"
}
]
}
HTTP Status Code Summary
200Returns an envelope with items of type manufacturer.
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 Manufacturers

put /sites/{siteid}/manufacturers

Note that manufacturerid is named externalcompanyid in the manufacturer object.

PARAMETERS
siteid
integer
path
REQUIRED
REQUEST BODY
puthttps://api.mysitoo.com/v2/accounts/1500/sites/1/manufacturers.json
[
{
"externalcompanyid": 1,
"name": "Sitoo"
},
{
"externalcompanyid": 3,
"name": "Example Inc."
}
]
RESPONSE JSON
[
{
"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 Manufacturers

delete /sites/{siteid}/manufacturers
PARAMETERS
siteid
integer
path
REQUIRED
REQUEST BODY
array
deletehttps://api.mysitoo.com/v2/accounts/1500/sites/1/manufacturers.json
[
{
"externalcompanyid": 3
}
]
RESPONSE JSON
[
{
"statuscode": 200,
"return": true
}
]
HTTP Status Code Summary
200Returns true or a batch envelope if multiple manufacturers 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 Manufacturer

get /sites/{siteid}/manufacturers/{externalcompanyid}

Note that manufacturerid is named externalcompanyid in the manufacturer object.

PARAMETERS
siteid
integer
path
REQUIRED
externalcompanyid
integer
path
REQUIRED
RETURNS

Returns an item of type manufacturer.

gethttps://api.mysitoo.com/v2/accounts/1500/sites/1/manufacturers/1.json
RESPONSE JSON
{
"externalcompanyid": 1,
"name": "Sitoo",
"description": "Furniture manufacturer",
"address": "12 Main Street",
"zip": "10310",
"city": "Townsville",
"state": "FL",
"countryid": "us",
"phone": "",
"email": "sales@sitoo.com",
"url1": "http://www.sitoo.com",
"url2": "www.sitoo.com"
}
HTTP Status Code Summary
200Returns an item of type manufacturer.
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 Manufacturer

put /sites/{siteid}/manufacturers/{externalcompanyid}

Note that manufacturerid is named externalcompanyid in the manufacturer object.

PARAMETERS
siteid
integer
path
REQUIRED
externalcompanyid
integer
path
REQUIRED
REQUEST BODY
puthttps://api.mysitoo.com/v2/accounts/1500/sites/1/manufacturers/5.json
{
"description": "Updated description for manufacturer"
}
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 Manufacturer

delete /sites/{siteid}/manufacturers/{externalcompanyid}

Note that manufacturerid is named externalcompanyid in the manufacturer object.

PARAMETERS
siteid
integer
path
REQUIRED
externalcompanyid
integer
path
REQUIRED
deletehttps://api.mysitoo.com/v2/accounts/1500/sites/1/manufacturers/5.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

manufacturer
object

Manufacturer or brand.

PROPERTIES
externalcompanyid
integer
READ ONLY

Manufacturer ID.

name
string
REQUIRED

Name of manufacturer.

description
string

Description.

address
string

Address.

zip
string

Zip.

city
string

City.

state
string

State / Region.

countryid
string

Country ID (2-letter ISO 3166).

phone
string

Phone.

email
string

Email.

url1
string

Home Page url.

url2
string

External link url.