Skip to content

Vendors

Customers of the supplier (called vendors, accounts or customers in the Orderwerks apps). A vendor carries its billing and shipping addresses, price group, payment terms and integration identifiers.

Operations

List customers

Request

Returns the supplier's customers (vendors) as a paged list of supplier-to-customer connections; the customer record is under Vendor on each row. Requires supplier-level access.

Supports delta sync: pass the returned serverTimestamp back as lastUpdatedAt to receive only customers changed since then.

Security
(ApiKey and ApiSecret) or (UserGuid and UserToken and SupplierGuid)
Query
limitinteger, [ 1 .. 100 ]

Number of rows per page.

Default:25
offsetinteger, >= 0

Zero-based page number. The server skips offset * limit rows.

Default:0
lastUpdatedAtstring

Delta-sync cursor. Pass the serverTimestamp returned by the previous call to receive only rows created, updated or soft-deleted since then (deleted rows carry deleted_at). Accepts ISO-8601 (2026-09-01T14:00:00.000Z) or YYYY-MM-DD HH:mm:ss (treated as UTC). The server re-fetches a 60-second overlap window to absorb clock skew. An unparsable value returns 400 with code: INVALID_DELTA_CURSOR.

Example:lastUpdatedAt=2026-09-01T14:00:00.000Z
namestring

Filter by customer name (contains match).

categorystring

Filter by customer category.

state_licensestring

Filter by state license number.

filter_inactivestring

Exclude inactive customers.

Enum:"true""false"
filterInactivestring

Alias of filter_inactive.

Enum:"true""false"
order_bystring

Column to sort by (for example name).

order_dirstring
Enum:"asc""desc"
nameGuidOnlystring

Return only id, guid and name for each customer (faster for pickers).

Enum:"true""false"
curl -i -X GET \
  'https://docs.orderwerks.com/_mock/openapi/vendors?limit=25&offset=0&lastUpdatedAt=2026-09-01T14%3A00%3A00.000Z&name=string&category=string&state_license=string&filter_inactive=true&filterInactive=true&order_by=string&order_dir=asc&nameGuidOnly=true' \
  -H 'x-apiKey: YOUR_API_KEY_HERE' \
  -H 'x-apiSecret: YOUR_API_KEY_HERE'

Responses

A page of customers.

Bodyapplication/json
supplierVendorTokensArray of objects(VendorConnection)required
totalVendorsintegerrequired

Total matching customers across all pages.

salesPeopleAssignedArray of objects

Sales rep assignments for the customers on this page.

serverTimestampstring, (date-time)

Pass back as lastUpdatedAt on the next call for delta sync.

Response
{
  "supplierVendorTokens": [
    {
      "id": 0,
      "guid": "ee6a7af7-650d-499b-8e32-58a52ffdb7bc",
      "supplier_id": 0,
      "vendor_id": 0,
      "parent_vendor_id": 0,
      "catalog_id": 0,
      "price_group_id": 0,
      "hide_pricing": true,
      "price_discount_one": 0,
      "price_discount_two": 0,
      "is_master": true,
      "route_id": 0,
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "deleted_at": "2019-08-24T14:15:22Z",
      "Vendor": { … },
      "Price_Group": { … }
    }
  ],
  "totalVendors": 0,
  "salesPeopleAssigned": [
    {
      "id": 0,
      "vendor_id": 0,
      "user_id": 0,
      "User": { … }
    }
  ],
  "serverTimestamp": "2019-08-24T14:15:22Z"
}