Vendors
Changed onThis request gets information such as VendorIDs, Vendor Names, etc.
This call returns a "meta" object containing URLs that can be used to get data related to a vendor.
This call will also return an image array of objects that have a file name and a link you can use to download that image. All links are only valid for 15 minutes, a new call will generate a new link.
Note: this endpoint supports pagination. Please refer to the Pagination section for more information.
Return data description
| Property | Description |
|---|---|
| meta | URLs that can be used to retrieve data related to the vendor. |
| vendorID | The unique ID of the vendor. |
| name | The vendor's name. |
| The vendor's email address. | |
| phone | The vendor's phone number. |
| contact | The vendor's primary contact. |
| address | The vendor's address. |
| locationID | The ID of the location associated with the vendor. |
| startedOn | The date the vendor was created as a UNIX timestamp. |
| lastEdited | The date the vendor was last edited as a UNIX timestamp. |
| image | An array of image objects containing a file name and a temporary download link. |
Request
- Base URL{{server}}:{{port}}
- AuthHTTP basic
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
This parameter is used to only get specific Vendors. This parameter expects a comma delimited list of Vendor IDs.
This parameter is used to only get Vendors at a specific group of Locations. This parameter accepts a comma delimited list of Location IDs.
This parameter is used to only get specific vendor by name. This parameter expects a string full name of a vendor or partial name with the wildcard %.
This parameter is used to only get Vendors that were last edited after the unix timestamp passed into the start parameter. For example, all Vendors that were last edited after April 18th, 2018.
This parameter is used to only get Vendors that were last edited before the unix timestamp passed into the end parameter.
This parameter is a cursor that selects what vendorID you want to start receiving results at. e.g. passing 137 here will only get you vendors with an id greater than 137.
This parameter is a result limiter. The default is set to return no more than 100 results at one time. Maximum allowed value is 1000.
This parameter is used to paginate results based on the limit. Refer to Pagination section for more information.
Response
Vendors
Changes
- warning
for the
queryrequest parameterlimit, the max was set to1000.00 - warning
for the
queryrequest parameterlimit, the min was set to1.00 - info
added the non-success response with the status
- warning