GetCustomerContinuationInput
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
Input parameters for querying customers using continuation-token-based pagination. Supports filtering by merchant, creation/modification time ranges, and active/deleted status.
Values
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Fields
| Field | Type | Description | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
merchantId
required |
string (uuid) | Gets or sets an optional merchant identifier to filter customers by their owning merchant.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||
filter
required |
FilterGroup FilterGroup | Gets or sets the filter group containing advanced filter expressions.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||
Fields of FilterGroup:
This body has no documented fields. | ||||||||||||||||||
maxResultCount
required |
integer (int32) | Gets or sets the maximum number of results to return per page.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||
continuationToken
required |
string | Gets or sets the continuation token from a previous query for retrieving the next page.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||
sorting
required |
SortDescriptor SortDescriptor | Gets or sets the sort descriptor controlling result ordering.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||
Fields of SortDescriptor: This body has no documented fields. | ||||||||||||||||||
maxCreationTime
required |
string (date-time) | Gets or sets the upper bound for filtering by creation time.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||
minCreationTime
required |
string (date-time) | Gets or sets the lower bound for filtering by creation time.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||
maxModificationTime
required |
string (date-time) | Gets or sets the upper bound for filtering by last modification time.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||
maxModifitionTime
required |
string (date-time) | Deprecated misspelled alias of `maxModificationTime`.
nullabledeprecated
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||
minModificationTime
required |
string (date-time) | Gets or sets the lower bound for filtering by last modification time.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||
minModifitionTime
required |
string (date-time) | Deprecated misspelled alias of `minModificationTime`.
nullabledeprecated
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||
includeDeleted
required |
boolean | Gets or sets a value indicating whether soft-deleted customers should be included in results.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||
includeInactive
required |
boolean | Gets or sets a value indicating whether inactive customers should be included in results.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||
includeApproxTotalCount
required |
boolean | Set to false to skip the approximate total count query and receive a null count;
omit the value or set it to true to receive the count as before.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||
This model has no documented fields.