SearchCustomersResponse

November 20, 2019 ยท View on GitHub

Description

Defines the fields that are included in the response body of a request to the SearchCustomers endpoint. One of errors or customers is present in a given response (never both).

Properties

NameTypeDescriptionNotes
errorsList<Error>Any errors that occurred during the request.[optional]
customersList<Customer>An array of `Customer` objects that match a query.[optional]
cursorStringA pagination cursor that can be used during subsequent calls to SearchCustomers to retrieve the next set of results associated with the original query. Pagination cursors are only present when a request succeeds and additional results are available. See the Pagination guide for more information.[optional]