-
Notifications
You must be signed in to change notification settings - Fork 36
Vendor Search
Search for vendors.
-
auth_uid (required) INTEGER - The ID for your API key.
-
auth_key (required) STRING - The API key.
-
auth_expiration (required) INTEGER - Unique ID tied to your key; changes if you reset your key.
-
sort_by (optional) STRING - The sort pattern for the returned results: 'newest', 'oldest'
-
page (optional) INTEGER - The page to return.
-
page_size (optional) INTEGER - The number of results on each page.
-
search_email (optional) STRING - Search a wildcard match on an email address.
-
search_name (optional) STRING - Search a wildcard match on a name ( including first, last, and company name ).
-
search_number (optional) STRING - Search a wildcard match on a phone or fax number.
-
search_and (optional) BOOLEAN - Require all provided fields to match.
-
vendors ARRAY - An array of Beans_Vendor.
-
total_results INTEGER - Total number of results.
-
sort_by STRING - The sort method used in the returned results.
-
pages INTEGER - The total number of pages of results.
-
page INTEGER - The currently returned page index.