Back to Aligni.com

GET /api/v2/:api_token/manufacturer
List manufacturers.

Retrieve the list of all manufacturers. Note that each record is abbreviated. You will need to retrieve a specific record for full details.

Examples

# request
curl -H 'Accept: application/xml' -H 'Content-Type: application/xml' \
https://demo.aligni.com/api/v2/oid3vLgynoy_Yl1gZkrgkLEq3J/manufacturer

# response
<?xml version="1.0" encoding="UTF-8"?>
<manufacturers>
  <manufacturer>
    <id>175</id>
    <name>Alpha Wire Company</name>
    <short_name>AWC</short_name>
    <created_at>2016-06-28T03:59:09-05:00</created_at>
    <updated_at>2016-06-28T03:59:09-05:00</updated_at>
  </manufacturer>
  ...
</manufacturers>

Params

Param name Description
api_token
required

Your API token.


Value: Must be a String

GET /api/v2/:api_token/manufacturer/:id
Show a manufacturer.

Retrieve one particular manufacturer by its id.

Examples

# request
curl -H 'Accept: application/xml' -H 'Content-Type: application/xml' \
https://demo.aligni.com/api/v2/oid3vLgynoy_Yl1gZkrgkLEq3J/manufacturer/175

# response
<?xml version="1.0" encoding="UTF-8"?>
<manufacturer>
  <id>175</id>
  <name>Alpha Wire Company</name>
  <short_name>AWC</short_name>
  <website>www.alphawire.com</website>
  <address1>711 Lidgerwood Ave</address1>
  <address2/>
  <address3/>
  <city>Elizabeth</city>
  <state>NJ</state>
  <postcode>07207-07111</postcode>
  <country>USA</country>
  <phone1>908.925.8000</phone1>
  <phone2>908.925.6923 (fax)</phone2>
  <phone3></phone3>
  <vendors>
    <vendor>
      <id>40</id>
    </vendor>
  </vendors>
</manufacturer>

Params

Param name Description
api_token
required

Your API token.


Value: Must be a String
id
required

Value: Must be a number.

POST /api/v2/:api_token/manufacturer
Create a new manufacturer.

Also see show action for detailed XML manufacturer response example.

Create a new manufacturer.

Examples

# request
curl -X POST -H 'Accept: application/xml' -H 'Content-Type: application/xml' -d "
<manufacturer>
  <name>Aligni Inc.</name>
  <website>aligni.com</website>
</manufacturer>" \
https://demo.aligni.com/api/v2/oid3vLgynoy_Yl1gZkrgkLEq3J/manufacturer

# response (for detailed manufacturer XML see show action)
<manufacturer>
  ...
</manufacturer>

Params

Param name Description
api_token
required

Your API token.


Value: Must be a String

PUT /api/v2/:api_token/manufacturer/:id
Update a manufacturer.

Also see show action for detailed XML manufacturer response example.

Updates a manufacturer record.

Examples

# request
curl -X PUT -H 'Accept: application/xml' -H 'Content-Type: application/xml' -d "
<manufacturer>
  <name>Alpha Wire Company Inc.</name>
</manufacturer>" \
https://demo.aligni.com/api/v2/oid3vLgynoy_Yl1gZkrgkLEq3J/manufacturer/175

# response (for detailed manufacturer XML see show action)
<manufacturer>
  ...
</manufacturer>

Params

Param name Description
api_token
required

Your API token.


Value: Must be a String
id
required

Value: Must be a number.

DELETE /api/v2/:api_token/manufacturer/:id
Delete a manufacturer.

Delete a manufacturer by its id.

Examples

# request
curl -X DELETE -H 'Accept: application/xml' -H 'Content-Type: application/xml' \
https://demo.aligni.com/api/v2/oid3vLgynoy_Yl1gZkrgkLEq3J/manufacturer/175

# no response

Params

Param name Description
api_token
required

Your API token.


Value: Must be a String
id
required

Value: Must be a number.