Module campaigns

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

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

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.

campaignId: The ID of the campaign.

• Min Length: 1
• Max Length: 256

coupons: The array of assigned coupon IDs, not sorted.

creationDate: Returns the value of attribute 'creationDate'.

customerGroups: The array of assigned customer groups, not sorted.

description: The description of the campaign.

• Max Length: 4000

enabled: The enabled flag for campaign.

endDate: The date the scenario ends.

lastModified: Returns the value of attribute 'lastModified'.

sourceCodeGroups: The array of assigned source code groups, not sorted.

startDate: The date the scenario begins.

campaignId: The ID of the campaign.

• Min Length: 1
• Max Length: 256

siteId: The identifier of the site that a request is being made in the context of. Attributes might have site specific values, and some objects may only be assigned to specific sites

• Min Length: 1
• Max Length: 32

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

hits: The sorted array of campaign 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. The limit with its constraints (minimum, maximum, default) is defined by the request parameter limit of the endpoint returning this schema.

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. The limit with its constraints (minimum, maximum, default) is defined by the request parameter limit of the endpoint returning this schema.

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. The limit with its constraints (minimum, maximum, default) is defined by the request parameter limit of the endpoint returning this schema.

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.

campaign: The campaign.

campaignId: The ID of the campaign.

• Min Length: 1
• Max Length: 256

coupons: The sorted array of assigned coupon IDs.

couponsBased: Whether the coupons qualifier participates in the assignment's qualification rule. When true, the assigned coupons gate the promotion (combined with campaign-level coupons). When omitted, defaults to true if a non-empty coupons array is supplied, otherwise false.

customerGroups: The sorted array of assigned customer groups.

customerGroupsBased: Whether the customer-groups qualifier participates in the assignment's qualification rule. When true, the assigned customer groups gate the promotion (combined with campaign-level customer groups). When omitted, defaults to true if a non-empty customerGroups array is supplied, otherwise false.

enabled: Read-only. True if the assigned promotion is enabled. Derived from the promotion's enabled state; cannot be set on the assignment. Use the Promotions API to change it.

promotionId: The ID of the promotion. Use the Promotions API to fetch the full promotion.

• Min Length: 1
• Max Length: 256

rank: The rank of promotion campaign assignment.

requiredQualifier:

schedule: The schedule of the assignment resource.

sourceCodeBased: Whether the source-code-groups qualifier participates in the assignment's qualification rule. When true, the assigned source-code groups gate the promotion (combined with campaign-level source-code groups). When omitted, defaults to true if a non-empty sourceCodeGroups array is supplied, otherwise false.

sourceCodeGroups: The sorted array of assigned source code groups.

campaignId: The ID of the campaign.

• Min Length: 1
• Max Length: 256

promotionId: The ID of the promotion.

• Min Length: 1
• Max Length: 256

siteId: The identifier of the site that a request is being made in the context of. Attributes might have site specific values, and some objects may only be assigned to specific sites

• Min Length: 1
• Max Length: 32

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

campaignId: The ID of the campaign. If supplied, must equal the campaignId path parameter.

• Min Length: 1
• Max Length: 256

coupons: The sorted array of assigned coupon IDs.

couponsBased: Whether the coupons qualifier participates in the assignment's qualification rule. When true, the assigned coupons gate the promotion (combined with campaign-level coupons). When omitted, defaults to true if a non-empty coupons array is supplied, otherwise false.

customerGroups: The sorted array of assigned customer groups.

customerGroupsBased: Whether the customer-groups qualifier participates in the assignment's qualification rule. When true, the assigned customer groups gate the promotion (combined with campaign-level customer groups). When omitted, defaults to true if a non-empty customerGroups array is supplied, otherwise false.

promotionId: The ID of the promotion. If supplied, must equal the promotionId path parameter.

• Min Length: 1
• Max Length: 256

rank: The rank of promotion campaign assignment.

requiredQualifier:

schedule: The schedule of the assignment resource.

sourceCodeBased: Whether the source-code-groups qualifier participates in the assignment's qualification rule. When true, the assigned source-code groups gate the promotion (combined with campaign-level source-code groups). When omitted, defaults to true if a non-empty sourceCodeGroups array is supplied, otherwise false.

sourceCodeGroups: The sorted array of assigned source code groups.

data: The array of promotion campaign assignments, ordered by rank ascending. Can be empty.

limit: Maximum records to retrieve per request. The limit with its constraints (minimum, maximum, default) is defined by the request parameter limit of the endpoint returning this schema.

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.

campaignId: The ID of the campaign. If supplied, must equal the campaignId path parameter.

• Min Length: 1
• Max Length: 256

coupons: The sorted array of assigned coupon IDs.

couponsBased: Whether the coupons qualifier participates in the assignment's qualification rule. When true, the assigned coupons gate the promotion (combined with campaign-level coupons). When omitted, defaults to true if a non-empty coupons array is supplied, otherwise false.

customerGroups: The sorted array of assigned customer groups.

customerGroupsBased: Whether the customer-groups qualifier participates in the assignment's qualification rule. When true, the assigned customer groups gate the promotion (combined with campaign-level customer groups). When omitted, defaults to true if a non-empty customerGroups array is supplied, otherwise false.

promotionId: The ID of the promotion. If supplied, must equal the promotionId path parameter.

• Min Length: 1
• Max Length: 256

rank: The rank of promotion campaign assignment.

requiredQualifier:

schedule: The schedule of the assignment resource. Send schedule null to clear the assignment-level schedule.

sourceCodeBased: Whether the source-code-groups qualifier participates in the assignment's qualification rule. When true, the assigned source-code groups gate the promotion (combined with campaign-level source-code groups). When omitted, defaults to true if a non-empty sourceCodeGroups array is supplied, otherwise false.

sourceCodeGroups: The sorted array of assigned source code groups.

promotionId: The ID of the promotion.

• Min Length: 1
• Max Length: 256

siteId: The identifier of the site that a request is being made in the context of. Attributes might have site specific values, and some objects may only be assigned to specific sites

• Min Length: 1
• Max Length: 32

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

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.

dayOfWeek: The days of week for recurrence.

timeOfDay: The time of the day for recurrence.

limit: Maximum records to retrieve per request. The limit with its constraints (minimum, maximum, default) is defined by the request parameter limit of the endpoint returning this schema.

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.

endDate: The date to end of validity. ISO8601 date time format: yyyy-MM-dd'T'HH:mm:ssZ.

recurrence: The recurrence of the schedule by day of week and time of day. Not all schedules support a recurrence.

startDate: The date to start validity. ISO8601 date time format: yyyy-MM-dd'T'HH:mm:ssZ.

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.

timeFrom: The time to start from. Time format: HH:mm:ss. Seconds are ignored and set to 0.

timeTo: The time to end on. Time format: HH:mm:ss. Seconds are ignored and set to 0.