-
Notifications
You must be signed in to change notification settings - Fork 36
Customer Address Search
Search for customer addresses.
-
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_customer_id (optional) INTEGER - Limit the search to a specific Beans_Customer.
-
addresses ARRAY - An array of Beans_Customer_Address.
-
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.