API Documentation

Beans_Vendor_Address_Shipping_Search

Search for vendor shipping addresses.


Parameters

auth_uid INTEGER The ID for your API key.
auth_key STRING The API key.
auth_expiration INTEGER Unique ID tied to your key; changes if you reset your key.
sort_by STRING The sort pattern for the returned results: 'newest', 'oldest'
page INTEGER The page to return.
page_size INTEGER The number of results on each page.
search_keywords STRING A generic query string to filter addresses by all fields.

Returns

addresses ARRAY An array of Beans_Vendor_Address_Shipping.
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.