Manufacturers

Batch Add Manufacturers

post /sites/{siteid}/manufacturers

siteid

integer

path

REQUIRED

array

[
  {
    "name": "Sitoo",
    "url1": "http://www.sitoo.com"
  },
  {
    "name": "Example Inc.",
    "url1": "http://www.example.com"
  }
]

[
  {
    "statuscode": 200,
    "return": 5
  },
  {
    "statuscode": 200,
    "return": 6
  }
]

HTTP Status Code Summary
200	Returns manufacturerid or a batch envelope if multiple manufacturers were added
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.

Get Manufacturers

get /sites/{siteid}/manufacturers

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 an envelope with items of type manufacturer.

manufacturer

{
  "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
200	Returns an envelope with items of type manufacturer.
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.

Batch Update Manufacturers

put /sites/{siteid}/manufacturers

Note that manufacturerid is named externalcompanyid in the manufacturer object.

siteid

integer

path

REQUIRED

array

manufacturer

[
  {
    "externalcompanyid": 1,
    "name": "Sitoo"
  },
  {
    "externalcompanyid": 3,
    "name": "Example Inc."
  }
]

[
  {
    "statuscode": 200,
    "return": true
  },
  {
    "statuscode": 200,
    "return": true
  }
]

HTTP Status Code Summary
200	Returns true
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.

Batch Delete Manufacturers

delete /sites/{siteid}/manufacturers

siteid

integer

path

REQUIRED

array

[
  {
    "externalcompanyid": 3
  }
]

[
  {
    "statuscode": 200,
    "return": true
  }
]

HTTP Status Code Summary
200	Returns true or a batch envelope if multiple manufacturers were deleted
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.

Get Manufacturer

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

Note that manufacturerid is named externalcompanyid in the manufacturer object.

siteid

integer

path

REQUIRED

externalcompanyid

integer

path

REQUIRED

Returns an item of type manufacturer.

manufacturer

{
  "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
200	Returns an item of type manufacturer.
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.

Update Manufacturer

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

Note that manufacturerid is named externalcompanyid in the manufacturer object.

siteid

integer

path

REQUIRED

externalcompanyid

integer

path

REQUIRED

object

manufacturer

{
  "description": "Updated description for manufacturer"
}

true

HTTP Status Code Summary
200	Returns true
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.

Delete Manufacturer

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

Note that manufacturerid is named externalcompanyid in the manufacturer object.

siteid

integer

path

REQUIRED

externalcompanyid

integer

path

REQUIRED

true

HTTP Status Code Summary
200	Returns true
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.

Objects

manufacturer
object

Manufacturer or brand.

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.

string

Email.

url1

string

Home Page url.

url2

string

External link url.

Manufacturers

Batch Add Manufacturers

Get Manufacturers

Batch Update Manufacturers

Batch Delete Manufacturers

Get Manufacturer

Update Manufacturer

Delete Manufacturer

Objects

manufacturerobject

manufacturer
object