Module customers

filters: A list of filters that are logically combined by an operator.

operator: The logical operator that is used to combine the filters.

must: List of queries to be evaluated as an AND operator.

mustNot: List of queries to be evaluated as a NOT operator.

should: List of queries to be evaluated as an OR operator.

enabled: A flag indicating whether the customer is enabled and can log in.

locked: A flag indicating whether the customer account is locked.

login: The login of the customer.

• Max Length: 256

passwordQuestion: The password question.

• Max Length: 256

birthday: The customer's birthday.

companyName: The customer's company name.

• Max Length: 256

creationDate: Returns the value of attribute 'creationDate'.

credentials:

customerId: The customer's ID. Both registered and guest customers have a customer ID.

• Max Length: 28

customerNo: The customer's number.

• Max Length: 100

email: The customer's email address.

• Max Length: 256

fax: The customer's fax number. The length is restricted to 32 characters.

• Max Length: 32

firstName: The customer's first name.

• Max Length: 256

gender: The customer's gender.

jobTitle: The customer's job title.

• Max Length: 256

lastLoginTime: The last login time of the customer.

lastModified: Returns the value of attribute 'lastModified'.

lastName: The customer's last name.

• Max Length: 256

lastVisitTime: The last visit time of the customer.

phoneBusiness: The customer's business phone number.

• Max Length: 32

phoneHome: The customer's home phone number.

• Max Length: 32

phoneMobile: The customer's mobile phone number.

• Max Length: 32

preferredLocale: The customer's preferred locale.

• Max Length: 5

previousLoginTime: The time when the customer previously logged in.

previousVisitTime: The time when the customer previously visited the store.

primaryAddress:

salutation: The customer's salutation.

• Max Length: 256

secondName: The customer's second name.

• Max Length: 256

suffix: The customer's suffix (for example, "Jr." or "Sr.").

• Max Length: 256

title: The customer's title (for example, "Mrs" or "Mr").

• Max Length: 256

address1: The customer's first address.

• Max Length: 256

address2: The customer's second address value.

• Max Length: 256

addressId: The customer address ID.

• Max Length: 256

city: The customer's city.

• Max Length: 256

companyName: The customer's company name.

• Max Length: 256

countryCode: The customer's two-character country code per ISO 3166-1 alpha-2.

• Max Length: 2

creationDate: Returns the value of attribute 'creationDate'.

etag: The generated eTag representing the state of the customer address.

firstName: The customer's first name.

• Max Length: 256

fullName: The concatenation of the customer's first, middle, last names, and suffix.

• Max Length: 1027

jobTitle: The customer's job title.

• Max Length: 256

lastModified: Returns the value of attribute 'lastModified'.

lastName: The customer's last name.

• Max Length: 256

phone: The customer's phone number.

• Max Length: 32

postBox: The customer's post box.

• Max Length: 256

postalCode: The customer's postal code.

• Max Length: 256

salutation: The customer's salutation.

• Max Length: 256

secondName: The customer's second name.

• Max Length: 256

stateCode: The customer's state.

• Max Length: 256

suffix: The customer's suffix.

• Max Length: 256

suite: The customer's suite.

• Max Length: 32

title: The customer's title.

• Max Length: 256

data: The array of customer address documents.

offset: The zero-based index of the first hit/data to include in the result.

limit: Maximum records to retrieve per request, not to exceed the maximum defined. A limit must be at least 1 so at least one record is returned (if any match the criteria).

total: The total number of hits that match the search's criteria. This can be greater than the number of results returned as search results are pagenated.

creationDate: The date the customer group was created.

description: Customer Group description.

• Max Length: 4000

id: Customer Group id.

• Max Length: 256

inDeletion: Boolean to indicate if the customer group is marked for deletion.

memberCount: Number of members in the customer group

rule:

type: Customer Group Type.

description: Customer Group Rule description. Describing its conditions in natural language.

hits: The sorted array of search hits. Can be empty.

query:

sorts: The sorting that was applied to the result.

offset: The zero-based index of the first hit/data to include in the result.

limit: Maximum records to retrieve per request, not to exceed the maximum defined. A limit must be at least 1 so at least one record is returned (if any match the criteria).

total: The total number of hits that match the search's criteria. This can be greater than the number of results returned as search results are pagenated.

data: List of found customers.

relevance: The hit's relevance score.

hits: The sorted array of search hits. Can be empty.

query:

sorts: The sorting that was applied to the result.

offset: The zero-based index of the first hit/data to include in the result.

limit: Maximum records to retrieve per request, not to exceed the maximum defined. A limit must be at least 1 so at least one record is returned (if any match the criteria).

total: The total number of hits that match the search's criteria. This can be greater than the number of results returned as search results are pagenated.

title: A short, human-readable summary of the problem type. It will not change from occurrence to occurrence of the problem, except for purposes of localization

• Max Length: 256

type: A URI reference [RFC3986] that identifies the problem type. This specification encourages that, when dereferenced, it provide human-readable documentation for the problem type (e.g., using HTML [W3C.REC-html5-20141028]). When this member is not present, its value is assumed to be "about:blank". It accepts relative URIs; this means that they must be resolved relative to the document's base URI, as per [RFC3986], Section 5.

• Max Length: 2048

detail: A human-readable explanation specific to this occurrence of the problem.

instance: A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced. It accepts relative URIs; this means that they must be resolved relative to the document's base URI, as per [RFC3986], Section 5.

• Max Length: 2048

boolFilter:

queryFilter:

range2Filter:

rangeFilter:

termFilter:

filter:

query:

path: The path to the nested document.

• Max Length: 2048

query:

scoreMode: Indicates how scores for matching child objects affect the root parent document’s relevance score.

offset: The zero-based index of the first hit/data to include in the result.

limit: Maximum records to retrieve per request, not to exceed the maximum defined. A limit must be at least 1 so at least one record is returned (if any match the criteria).

total: The total number of hits that match the search's criteria. This can be greater than the number of results returned as search results are pagenated.

query:

sorts: The sorting that was applied to the result.

hits: The sorted array of search hits. Can be empty.

offset: The zero-based index of the first hit/data to include in the result.

limit: Maximum records to retrieve per request, not to exceed the maximum defined. A limit must be at least 1 so at least one record is returned (if any match the criteria).

total: The total number of hits that match the search's criteria. This can be greater than the number of results returned as search results are pagenated.

boolQuery:

filteredQuery:

matchAllQuery: Matches all documents (namespace and document type). This query comes in handy if you just want to filter a search result or really do not have any constraints.

nestedQuery:

termQuery:

textQuery:

query:

filterMode: Compare mode: overlap, containing, or contained.

fromField: The field name of the field that starts the first range.

• Max Length: 260

fromInclusive: A flag indicating if the lower bound of the second range is inclusive. To make the lower bound exclusive, set to false.

fromValue: The lower bound of the second range. If not specified, the range is open-ended with respect to the lower bound. You can't leave both the lower and upper bounds open-ended.

toField: The field name of the field that ends the first range.

• Max Length: 260

toInclusive: A flag indicating if the upper bound of the second range is inclusive. To make the lower bound exclusive, set to false.

toValue: The upper bound of the second range. If not specified, the range is open-ended with respect to the upper bound. You can't leave both the upper and lower bounds open-ended.

field: The search field.

• Max Length: 260

from:

fromInclusive: A flag indicating if the lower bound of the range is inclusive. To make the lower bound exclusive, set to false.

to:

toInclusive: A flag indicating if the upper bound of the range is inclusive. To make the upper bound exclusive, set to false.

limit: Maximum records to retrieve per request, not to exceed the maximum defined. A limit must be at least 1 so at least one record is returned (if any match the criteria).

total: The total number of hits that match the search's criteria. This can be greater than the number of results returned as search results are pagenated.

limit: Maximum records to retrieve per request, not to exceed 200.

query:

sorts: The list of sort clauses configured for the search request. Sort clauses are optional. See the description of the search endpoint for details on the default sorting behavior that is used when explicit sorts are not passed.

offset: The zero-based index of the first hit/data to include in the result.

field: The name of the field to sort on.

• Max Length: 256

sortOrder: The sort order to be applied when sorting. When omitted, the default sort order (asc) is used.

field: The filter field.

• Max Length: 260

operator: The operator used to compare the field's values with the given values.

values: The filter values.

fields: The document fields that the values are matched against, combined with the operator.

operator: Returns the operator to use for the term query.

values: The values that the fields are compared against, combined with the operator.

fields: The document fields that the search phrase matches against.

searchPhrase: A search phrase, which can include multiple terms separated by spaces.