v1

latestOpenAPI 3.0.12026-07-26381328555.2 KB
CustomerAccount

Get Account Attributes

Retrieves a collection of account attributes according to any specified filter criteria and sort options.

get/commerce/customer/accounts/{accountId}/attributes

Path parameters

accountIdinteger required

Unique identifier of the customer account whose notes you want to retrieve.

Query parameters

startIndexinteger

Used to page results from a query. Indicates the zero-based offset in the complete result set where the returned entities begin. For example, with a PageSize of 25, to get the 51st through the 75th items, startIndex=3. The default value is 0. Optional.

pageSizeinteger

Used to page results from a query. Indicates the maximum number of entities to return from a query. The default value is 20 and the maximum value is 200. Optional.

sortBystring

The element to sort the results by and the order in which the results appear. Either ascending (a-z) or descending (z-a) order. Optional.

filterstring

A set of filter expressions representing the search parameters for a query: eq=equals, ne=not equals, gt=greater than, lt = less than or equals, gt = greater than or equals, lt = less than or equals, sw = starts with, or cont = contains. Optional.

userIdstring
responseFieldsstring

limits which fields are returned in the response body

Response

OK

pageCountinteger
pageSizeinteger
startIndexinteger
totalCountinteger