Sortable list of all customers.
Sorting
The following fields can be sorted using the sortby
query string parameter:
FirstName
LastName
Company
BillingAddress.City
BillingAddress.State
BillingAddress.Zip
BillingAddress.Country
ShippingAddress.City
ShippingAddress.State
ShippingAddress.Zip
ShippingAddress.Country
If sortby
is omitted, by default customers are returned sorted by creation date, with the most recently created customers appearing first.
Lite Response Format
If the lite
query string parameter is set to true
, the response will contain only the following basic customer information fields:
FirstName
LastName
Email
Company
Phone
Id
This format is useful when returning large lists and in applications such as mobile where bandwidth is at a premium.
Number of Items
The PagingDetails.TotalItems
property returns the total number of items to be returned.