Module coupons

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.

couponId: The ID of the coupon.

• Min Length: 1
• Max Length: 256

creationDate: Returns the value of attribute 'creationDate'.

description: The description of the coupon.

• Max Length: 4000

enabled: A flag indicating whether the coupon is enabled.

exportedCodeCount: The number of coupon codes attached to the coupon that have been issued (read only).

lastModified: Returns the value of attribute 'lastModified'.

redemptionCount: The number of times the coupon has been redeemed (read only). The count is updated once per hour.

redemptionLimits: The redemption limit per coupon code.

singleCode: Single coupon code, only valid for Single Code type.

• Min Length: 1
• Max Length: 256

systemCodesConfig: The configuration of system coupon codes, including prefix and number of codes.

totalCodesCount: The total number of coupon codes associated with this coupon (read only). The count is updated once per hour.

type: The type of coupon code.

code: The code used to redeem the coupon.

issued: Flag indicating if the coupon code has been issued.

redemptionCount: The count of the number of redemptions associated with the code.

code: The coupon code to redeem.

customerEmail: The customer email to use on the redemption.

orderNo: The order number to use on the redemption. In case the coupon was redeemed externally and no order number is associated, use a reference id or custom string to identify the source of the redemption.

data: The collection of coupon codes.

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.

codes: The list of coupon codes to add or delete.

code: The coupon code that was redeemed.

couponId: The coupon id that was redeemed.

creationDate: Date when the redemption was created.

customerEmail: The customer email that was used to redeem it.

orderNo: The order number where the redemption occurred.

viewOrderUrl: A URL able to access the order.

hits: The array of coupon redemption 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.

hits: The sorted array of coupon 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.

codePrefix: The code prefix for system-generated coupon codes.

numberOfCodes: The number of system coupon codes that can be issued.

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: The limit on the number of times a coupon can be redeemed for a specified redemption time period.

redemptionTimeFrame: The redemption time period.

limitPerCode: The redemption limit per code.

limitPerCustomer: The redemption limit per customer.

limitPerTimeFrame: The redemption limit per time frame.

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.