Type aliases
Static AsyncCreated
AsyncCreated: {}
Defined in renderedTemplates/pricing/assignments/assignments.ts:144
Static AttributeDefinition
Attribute
Definition: { defaultValue?: PropertyValueDefinition ; description: L10nString ; id?: string ; key?: boolean ; localizable?: boolean ; mandatory?: boolean ; max?: number ; min?: number ; minLength?: number ; multiValueType?: boolean ; name: L10nString ; possibleValues?: Array < PropertyValueDefinition > ; regularExpression?: string ; scale?: number ; searchable?: boolean ; siteSpecific?: boolean ; system?: boolean ; type: string ; unit?: L10nString ; visible?: boolean }
Defined in renderedTemplates/pricing/assignments/assignments.ts:354
Type declaration
Optional id?: string
Optional key?: boolean
Optional localizable?: boolean
Optional mandatory?: boolean
Optional max?: number
Optional min?: number
Optional minLength?: number
Optional multiValueType?: boolean
Optional regularExpression?: string
Optional scale?: number
Optional searchable?: boolean
Optional siteSpecific?: boolean
Optional system?: boolean
type: string
Optional visible?: boolean
Static BoolFilter
BoolFilter: { filters?: Array < any > ; operator: string } & {}
Defined in renderedTemplates/pricing/assignments/assignments.ts:245
Static BoolQuery
BoolQuery: { must?: Array < any > ; mustNot?: Array < any > ; should?: Array < any > } & {}
Defined in renderedTemplates/pricing/assignments/assignments.ts:307
Static Campaign
Campaign: { campaignId: string ; coupons?: Array < string > ; creationDate?: any ; customerGroups?: Array < string > ; description?: string ; enabled?: boolean ; endDate?: any ; lastModified?: any ; sourceCodeGroups?: Array < string > ; startDate?: any } & {}
Defined in renderedTemplates/pricing/assignments/assignments.ts:21
Static ChangeControlled
ChangeControlled: { createdBy?: string ; creationDate?: any ; lastModifiedBy?: string ; modificationDate?: any } & {}
Defined in renderedTemplates/pricing/assignments/assignments.ts:121
Static ChangeControlledDataType
ChangeControlledDataType: { createdBy?: string ; creationDate?: any ; lastModifiedBy?: string ; modificationDate?: any } & {}
Defined in renderedTemplates/pricing/assignments/assignments.ts:160
Static ClosedObject
ClosedObject: {} & {}
Defined in renderedTemplates/pricing/assignments/assignments.ts:228
Static DateConditionalRequest
DateConditionalRequest: {}
Defined in renderedTemplates/pricing/assignments/assignments.ts:138
Static DateRangeFilter
DateRangeFilter: {}
Defined in renderedTemplates/pricing/assignments/assignments.ts:128
Static DatetimeRangeFilter
DatetimeRangeFilter: {}
Defined in renderedTemplates/pricing/assignments/assignments.ts:158
Static Error
Error: { detail?: string ; instance?: string ; title?: string ; type: string } & {}
Defined in renderedTemplates/pricing/assignments/assignments.ts:167
Static ErrorResponse
ErrorResponse: { detail?: string ; instance?: string ; title?: string ; type: string } & {}
Defined in renderedTemplates/pricing/assignments/assignments.ts:114
Static EtagConditionalRequest
EtagConditionalRequest: {}
Defined in renderedTemplates/pricing/assignments/assignments.ts:142
Static EtagResponse
EtagResponse: {}
Defined in renderedTemplates/pricing/assignments/assignments.ts:130
Static Filter
Defined in renderedTemplates/pricing/assignments/assignments.ts:326
Static FilteredQuery
FilteredQuery: { filter: any ; query: any } & {}
Defined in renderedTemplates/pricing/assignments/assignments.ts:262
Static IntegerRangeFilter
IntegerRangeFilter: {}
Defined in renderedTemplates/pricing/assignments/assignments.ts:132
Static L10nString
L10nString: {} & {}
Defined in renderedTemplates/pricing/assignments/assignments.ts:351
Static LocalizedString
LocalizedString: {} & {}
Defined in renderedTemplates/pricing/assignments/assignments.ts:216
Static MatchAllQuery
MatchAllQuery: {} & {}
Defined in renderedTemplates/pricing/assignments/assignments.ts:259
Static Money
Money: { currencyMnemonic?: string ; value?: number } & {}
Defined in renderedTemplates/pricing/assignments/assignments.ts:174
Static MoneyMnemonic
MoneyMnemonic: { currencyMnemonic?: string ; value?: number } & {}
Defined in renderedTemplates/pricing/assignments/assignments.ts:346
Static NestedQuery
NestedQuery: { path: string ; query: any ; scoreMode?: string } & {}
Defined in renderedTemplates/pricing/assignments/assignments.ts:320
Static NoPropertiesAllowed
NoPropertiesAllowed: {}
Defined in renderedTemplates/pricing/assignments/assignments.ts:240
Static NumericRangeFilter
NumericRangeFilter: {}
Defined in renderedTemplates/pricing/assignments/assignments.ts:156
Static OffsetPaginated
OffsetPaginated: {}
Defined in renderedTemplates/pricing/assignments/assignments.ts:150
Static OpenObject
OpenObject: {} & {}
Defined in renderedTemplates/pricing/assignments/assignments.ts:231
Static PaginatedSearchResult
Paginated
SearchResult: { hits?: Array < object > ; limit: number ; offset: any ; query: any ; sorts?: Array < Sort > ; total: any } & {}
Defined in renderedTemplates/pricing/assignments/assignments.ts:219
Static PaginatedSearchResultBase
Paginated
SearchResultBase: { hits?: Array < object > ; limit: number ; offset: any ; query: any ; sorts?: Array < Sort > ; total: any } & {}
Defined in renderedTemplates/pricing/assignments/assignments.ts:250
Static Promotion
Promotion
: { archived
?: boolean ; assignmentInformation
?: PromotionAssignmentInformation ; creationDate
?: any ; currencyCode
?: string ; disableGloballyExcluded
?: boolean ; enabled
?: boolean ; exclusivity
: string ; id
: string ; lastModified
?: any ; name
?: {} & {} ; promotionClass
?: string ; tags
?: Array < Tag > } & {}
Defined in renderedTemplates/pricing/assignments/assignments.ts:52
Static PromotionAbtestGroupAssignment
Promotion
AbtestGroupAssignment: { abtestDescription: string ; abtestId: string ; enabled: boolean ; schedule: Schedule ; segmentDescription: string ; segmentId: string } & {}
Defined in renderedTemplates/pricing/assignments/assignments.ts:105
Static PromotionAssignmentInformation
Defined in renderedTemplates/pricing/assignments/assignments.ts:69
Static PromotionCampaignAssignment
Promotion
CampaignAssignment: { campaign: Campaign ; campaignId: string ; coupons: Array < string > ; customerGroups: Array < string > ; description: string ; enabled: boolean ; promotion: Promotion ; promotionId: string ; rank: number ; schedule: Schedule ; sourceCodeGroups: Array < string > } & {}
Defined in renderedTemplates/pricing/assignments/assignments.ts:34
Static PromotionCampaignAssignmentSearchResult
Promotion
CampaignAssignmentSearchResult: { hits: Array < PromotionCampaignAssignment > ; limit: number ; offset: any ; query: any ; sorts?: Array < Sort > ; total: any } & {}
Defined in renderedTemplates/pricing/assignments/assignments.ts:91
Static PropertyDefinition
Property
Definition: { defaultValue?: PropertyValueDefinition ; description: L10nString ; id?: string ; key?: boolean ; localizable?: boolean ; mandatory?: boolean ; max?: number ; min?: number ; minLength?: number ; multiValueType?: boolean ; name: L10nString ; possibleValues?: Array < PropertyValueDefinition > ; regularExpression?: string ; scale?: number ; searchable?: boolean ; siteSpecific?: boolean ; system?: boolean ; type: string ; unit?: L10nString ; visible?: boolean } & {}
Defined in renderedTemplates/pricing/assignments/assignments.ts:193
Static PropertyValueDefinition
Property
ValueDefinition: { description: L10nString ; displayValue: L10nString ; id: string ; position?: number ; value: string }
Defined in renderedTemplates/pricing/assignments/assignments.ts:376
Type declaration
id: string
Optional position?: number
value: string
Static Query
Defined in renderedTemplates/pricing/assignments/assignments.ts:271
Static QueryFilter
QueryFilter: { query: any } & {}
Defined in renderedTemplates/pricing/assignments/assignments.ts:267
Static QueryParamsLimit
QueryParamsLimit: {}
Defined in renderedTemplates/pricing/assignments/assignments.ts:234
Static QueryParamsOffset
QueryParamsOffset: {}
Defined in renderedTemplates/pricing/assignments/assignments.ts:236
Static Range2Filter
Range2Filter: { filterMode?: string ; fromField: string ; fromInclusive?: boolean ; fromValue?: any ; toField: string ; toInclusive?: boolean ; toValue?: any } & {}
Defined in renderedTemplates/pricing/assignments/assignments.ts:297
Static RangeFilter
RangeFilter: {}
Defined in renderedTemplates/pricing/assignments/assignments.ts:152
Static RateLimited
RateLimited: {}
Defined in renderedTemplates/pricing/assignments/assignments.ts:146
Static RateLimited2
RateLimited2: {}
Defined in renderedTemplates/pricing/assignments/assignments.ts:148
Static RateLimited3
RateLimited3: {}
Defined in renderedTemplates/pricing/assignments/assignments.ts:134
Static RateLimited4
RateLimited4: {}
Defined in renderedTemplates/pricing/assignments/assignments.ts:154
Static RateLimited5
RateLimited5: {}
Defined in renderedTemplates/pricing/assignments/assignments.ts:140
Static Recurrence
Recurrence
: { dayOfWeek
: Array < string > ; timeOfDay
: TimeOfDay } & {}
Defined in renderedTemplates/pricing/assignments/assignments.ts:100
Static Schedule
Schedule
: { endDate
: any ; recurrence
: Recurrence ; startDate
: any } & {}
Defined in renderedTemplates/pricing/assignments/assignments.ts:85
Static SearchRequest
Search
Request: { limit?: number ; offset?: any ; query: any ; sorts?: Array < Sort > } & {}
Defined in renderedTemplates/pricing/assignments/assignments.ts:186
Static SearchRequestBase
Search
RequestBase: { limit?: number ; offset?: any ; query: any ; sorts?: Array < Sort > } & {}
Defined in renderedTemplates/pricing/assignments/assignments.ts:339
Static SimpleSearchResult
SimpleSearchResult: { hits?: Array < object > ; limit: number ; offset: any ; total: any } & {}
Defined in renderedTemplates/pricing/assignments/assignments.ts:179
Static SimpleSearchResultBase
SimpleSearchResultBase: { hits?: Array < object > ; limit: number ; offset: any ; total: any } & {}
Defined in renderedTemplates/pricing/assignments/assignments.ts:313
Static SiteSpecific
SiteSpecific: {}
Defined in renderedTemplates/pricing/assignments/assignments.ts:238
Static Sort
Sort: { field: string ; sortOrder?: string } & {}
Defined in renderedTemplates/pricing/assignments/assignments.ts:334
Static SpecifiedPropertiesAllowed
SpecifiedPropertiesAllowed: {} & {}
Defined in renderedTemplates/pricing/assignments/assignments.ts:242
Static SyncCreated
SyncCreated: {}
Defined in renderedTemplates/pricing/assignments/assignments.ts:136
Static Tag
Tag: { tagId: string } & {}
Defined in renderedTemplates/pricing/assignments/assignments.ts:48
Static TermFilter
TermFilter: { field: string ; operator: string ; values?: Array < any > } & {}
Defined in renderedTemplates/pricing/assignments/assignments.ts:286
Static TermQuery
TermQuery: { fields: Array < string > ; operator: string ; values?: Array < any > } & {}
Defined in renderedTemplates/pricing/assignments/assignments.ts:280
Static TextQuery
TextQuery: { fields: Array < string > ; searchPhrase: string } & {}
Defined in renderedTemplates/pricing/assignments/assignments.ts:292
Static TimeOfDay
TimeOfDay: { timeFrom: string ; timeTo: string } & {}
Defined in renderedTemplates/pricing/assignments/assignments.ts:16
Assignments
Search for promotions associated with campaigns.
For instructions on how to retrieve access token for admin APIs: https://developer.salesforce.com/docs/commerce/commerce-api/guide/authorization-for-admin-apis.html
Example with admin auth
API Version: 1.0.20import { Pricing, ClientConfig } from "commerce-sdk"; // or const { Pricing, ClientConfig } = require("commerce-sdk"); const clientConfig: ClientConfig = { parameters: { clientId: "XXXXXX", organizationId: "XXXX", shortCode: "XXX", siteId: "XX" } }; token = { access_token: 'INSERT_ACCESS_TOKEN_HERE' }; clientConfig.headers['authorization'] = `Bearer ${token.access_token}`; const assignmentsClient = new Pricing.Assignments(clientConfig);
Last Updated: