Module assignments

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.

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.

archived: Determines if this promotion is archived. This attribute is allowed to be updated when using the Open Commerce API to update multiple promotions at once.

assignmentInformation: Information about the assignments and assignment schedules of this promotion.

creationDate: Returns the value of attribute 'creationDate'.

currencyCode: The ISO 4217 mnemonic code of the currency this promotion is restricted to. If not populated, then there is no currency restriction on the promotion.

• Max Length: 3

disableGloballyExcluded: Determines if this promotion ignores the global product exclusions for promotions.

enabled: Determines if this promotion is enabled. This attribute is allowed to be updated when using the Open Commerce API to update multiple promotions at once.

exclusivity: Determines if the promotion can be combined with other promotions of the same promotion class or if it cannot be combined with any other promotions. This attribute is allowed to be updated when using the Open Commerce API to update multiple promotions at once.

id: The ID for the promotion.

lastModified: Returns the value of attribute 'lastModified'.

name: The user supplied name of this promotion, which can be localized.

promotionClass: The class of the promotion. If the promotion class is modified, then the promotion rule and all of its values, such as whether or not to disable global product exclusions, are reset.

tags: Returns the list of tags assigned to this promotion. If used to set the tags on a promotion, the promotion will only have the tags passed in the input. Any existing tags are removed.

abtestDescription:

abtestId:

enabled:

schedule:

segmentDescription:

segmentId:

abtestId: If there is only one assignment, and that assignment is an A/B test segment, the ID of the A/B test the segment belongs to. Otherwise, empty.

abtestSegmentId: If there is only one assignment, and that assignment is an A/B test segment, the ID of the A/B test segment. Otherwise, empty.

active: True if the individual assignment or the multiple assignments are currently active.

activeAbtestAssignments: A list of currently active A/B tests this is assigned to.

activeCampaignAssignments: A list of currently active campaigns this is assigned to.

campaignId: If there is only one assignment, and that assignment is a campaign, the ID of the campaign. Otherwise, empty.

enabled:

endDate: The end date of the container of the assignment (a Campaign or ABTest). If scheduleType is scheduleType : "multiple" or scheduleType : "none", then then result is null. Also, a null date returns null.

schedule: The schedule of the assignment (a Campaign or ABTest). If scheduleType is scheduleType : "multiple" or scheduleType : "none", then then result is null.

scheduleType: If there is only one active assignment, or no active assignments and one upcoming assignment, this is that type of assignment (scheduleType : "campaign" or scheduleType : "abtest"). If there are no assignments, it is scheduleType : "none", otherwise, scheduleType : "multiple".

startDate: The start date of the container of the assignment (a Campaign or ABTest). If scheduleType is scheduleType : "multiple" or scheduleType : "none", then then result is null. Also, a null date returns null.

upcomingAbtestAssignments: A list of upcoming A/B tests this is assigned to.

upcomingCampaignAssignments: A list of upcoming campaigns this is assigned to.

campaign: The campaign.

campaignId: The ID of the campaign.

• Min Length: 1
• Max Length: 256

coupons: The sorted array of assigned coupon IDs.

customerGroups: The sorted array of assigned customer groups.

description: The description of the promotion campaign assignment.

• Max Length: 4000

enabled: True if the assignment resource is enabled.

promotion: The promotion.

promotionId: The ID of the promotion.

• Min Length: 1
• Max Length: 256

rank: The rank of promotion campaign assignment.

schedule: The schedule of the assignment resource.

sourceCodeGroups: The sorted array of assigned source code groups.

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, 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.

dayOfWeek: The days of week for recurrence.

timeOfDay: The time of the day for recurrence.

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.

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.

tagId: The ID of the tag.

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.