Vendors

Returns one vendor.

Requires ViewPurchaseOrders. id may be the numeric id or the syncId. Sends a weak ETag.

get/api/v1/vendors/{id}

Request

  • Base URL: https://app.flexonthejob.com
  • URL: https://app.flexonthejob.com/api/v1/vendors/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Numeric id or SyncId. Example: 7.

Response

The vendor.

idinteger

Numeric id, usable in /api/v1/vendors/{id} and as a purchase order's vendorId. Example: 7.

syncIdstring uuid

Stable cross-device id; also the pagination cursor.

namestring

Vendor name, unique in the organization. Example: Acme Supply.

descriptionstring nullable

Free-text notes about the vendor; null when not recorded.

contactNamestring nullable

Main contact's name; null when not recorded. Example: Dana Ruiz.

contactEmailstring nullable

Main contact's email; null when not recorded. Example: orders@acme.example.

contactPhonestring nullable

Main contact's phone, as typed; null when not recorded. Example: 555-0100.

websitestring nullable

Vendor website; null when not recorded. Example: https://acme.example.

defaultShippingCompanystring nullable

Carrier the vendor usually ships with; null when not recorded. Example: UPS.

isActiveboolean

False for a deactivated vendor: kept for history, not offered on new orders and refused as a new order's vendorId.

createdAtstring date-time

UTC creation time (ISO-8601).

updatedAtstring date-time

UTC last modification time (ISO-8601).

Changes

No recorded changes to this operation across all 1 revision of this API.