Vendors

A vendor record represents a supplier — a company you purchase inventory from.

The Vendor Object

{
  "shortID": "ACME-FASTENERS",
  "name": "Acme Fasteners Inc",
  "address1": "456 Supply Blvd",
  "address2": "",
  "city": "Chicago",
  "state": "IL",
  "zip": "60601",
  "country": "US",
  "phone": "555-0200",
  "fax": "555-0201",
  "email": "sales@acmefasteners.example.com",
  "contact": "Mark Brennan",
  "active": true,
  "created": "2021-06-10T07:45:00",
  "modified": "2024-08-19T13:10:00"
}

Field	Type	Description
`shortID`	string	Unique vendor identifier
`name`	string	Vendor name
`address1`	string	Primary address line
`address2`	string	Secondary address line
`city`	string	City
`state`	string	State or province
`zip`	string	Postal code
`country`	string	Country code
`phone`	string	Phone number
`fax`	string	Fax number
`email`	string	Email address
`contact`	string	Primary contact name
`active`	boolean	`false` when discontinued
`created`	datetime	Record creation timestamp
`modified`	datetime	Last modified timestamp

List Vendors

GET /Vendor/All

Returns all vendors with standard pagination parameters.

{
  "value": [
    {
      "shortID": "ACME-FASTENERS",
      "name": "Acme Fasteners Inc",
      "address1": "456 Supply Blvd",
      "address2": "",
      "city": "Chicago",
      "state": "IL",
      "zip": "60601",
      "country": "US",
      "phone": "555-0200",
      "fax": "555-0201",
      "email": "sales@acmefasteners.example.com",
      "contact": "Mark Brennan",
      "active": true,
      "created": "2021-06-10T07:45:00",
      "modified": "2024-08-19T13:10:00"
    },
    {
      "shortID": "GREATLAKES-SUPPLY",
      "name": "Great Lakes Supply Co",
      "address1": "200 Lakeshore Dr",
      "address2": "",
      "city": "Milwaukee",
      "state": "WI",
      "zip": "53202",
      "country": "US",
      "phone": "555-0300",
      "fax": "",
      "email": "orders@greatlakes.example.com",
      "contact": "Lisa Vogel",
      "active": true,
      "created": "2020-03-22T09:00:00",
      "modified": "2025-02-10T08:30:00"
    }
  ],
  "totalCount": 31,
  "page": 1,
  "pageSize": 25,
  "pageCount": 2,
  "hasMore": true
}

Get a Vendor

GET /Vendor/{id}

Returns 404 if the vendor does not exist.

GET /Vendor/ACME-FASTENERS

{
  "shortID": "ACME-FASTENERS",
  "name": "Acme Fasteners Inc",
  "address1": "456 Supply Blvd",
  "address2": "",
  "city": "Chicago",
  "state": "IL",
  "zip": "60601",
  "country": "US",
  "phone": "555-0200",
  "fax": "555-0201",
  "email": "sales@acmefasteners.example.com",
  "contact": "Mark Brennan",
  "active": true,
  "created": "2021-06-10T07:45:00",
  "modified": "2024-08-19T13:10:00"
}

Create or Update a Vendor

POST /Vendor

Upserts a vendor. If shortID matches an existing record it is updated; otherwise a new record is created.

Request

{
  "shortID": "ACME-FASTENERS",
  "name": "Acme Fasteners Inc",
  "address1": "456 Supply Blvd",
  "address2": "",
  "city": "Chicago",
  "state": "IL",
  "zip": "60601",
  "country": "US",
  "phone": "555-0200",
  "fax": "555-0201",
  "email": "sales@acmefasteners.example.com",
  "contact": "Mark Brennan"
}

Field	Type	Required	Description
`shortID`	string	Yes	Unique identifier. Used to match existing records on upsert.
`name`	string	No	Vendor name
`address1`	string	No	Primary address line
`address2`	string	No	Secondary address line
`city`	string	No	City
`state`	string	No	State or province
`zip`	string	No	Postal code
`country`	string	No	Country code
`phone`	string	No	Phone number
`fax`	string	No	Fax number
`email`	string	No	Email address
`contact`	string	No	Primary contact name

Response

{
  "shortID": "ACME-FASTENERS",
  "name": "Acme Fasteners Inc",
  "address1": "456 Supply Blvd",
  "address2": "",
  "city": "Chicago",
  "state": "IL",
  "zip": "60601",
  "country": "US",
  "phone": "555-0200",
  "fax": "555-0201",
  "email": "sales@acmefasteners.example.com",
  "contact": "Mark Brennan",
  "active": true,
  "created": "2021-06-10T07:45:00",
  "modified": "2025-05-31T10:00:00"
}

Discontinue a Vendor

DELETE /Vendor/{id}

Marks the vendor as discontinued. Historical purchase order records are preserved. Returns 204 on success.

DELETE /Vendor/ACME-FASTENERS

Permissions

Action	Permission
List / Get	Suppliers List (SecurityID 19)
Create / Update / Discontinue	Create/Modify Supplier (SecurityID 20)