Type aliases
Static AccountTransaction
Account
Transaction: { amount: Money ; orderNo: string ; timestamp: any ; typeCode: string } & {}
Defined in renderedTemplates/pricing/giftCertificates/giftCertificates.ts:48
Static AsyncCreated
AsyncCreated: {}
Defined in renderedTemplates/pricing/giftCertificates/giftCertificates.ts:92
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/giftCertificates/giftCertificates.ts:297
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/giftCertificates/giftCertificates.ts:188
Static BoolQuery
BoolQuery: { must?: Array < any > ; mustNot?: Array < any > ; should?: Array < any > } & {}
Defined in renderedTemplates/pricing/giftCertificates/giftCertificates.ts:250
Static ChangeControlled
ChangeControlled: { createdBy?: string ; creationDate?: any ; lastModifiedBy?: string ; modificationDate?: any } & {}
Defined in renderedTemplates/pricing/giftCertificates/giftCertificates.ts:69
Static ChangeControlledDataType
ChangeControlledDataType: { createdBy?: string ; creationDate?: any ; lastModifiedBy?: string ; modificationDate?: any } & {}
Defined in renderedTemplates/pricing/giftCertificates/giftCertificates.ts:108
Static ClosedObject
ClosedObject: {} & {}
Defined in renderedTemplates/pricing/giftCertificates/giftCertificates.ts:171
Static DateConditionalRequest
DateConditionalRequest: {}
Defined in renderedTemplates/pricing/giftCertificates/giftCertificates.ts:86
Static DateRangeFilter
DateRangeFilter: {}
Defined in renderedTemplates/pricing/giftCertificates/giftCertificates.ts:76
Static DatetimeRangeFilter
DatetimeRangeFilter: {}
Defined in renderedTemplates/pricing/giftCertificates/giftCertificates.ts:106
Static Error
Error: { detail?: string ; instance?: string ; title?: string ; type: string } & {}
Defined in renderedTemplates/pricing/giftCertificates/giftCertificates.ts:115
Static ErrorResponse
ErrorResponse: { detail?: string ; instance?: string ; title?: string ; type: string } & {}
Defined in renderedTemplates/pricing/giftCertificates/giftCertificates.ts:62
Static EtagConditionalRequest
EtagConditionalRequest: {}
Defined in renderedTemplates/pricing/giftCertificates/giftCertificates.ts:90
Static EtagResponse
EtagResponse: {}
Defined in renderedTemplates/pricing/giftCertificates/giftCertificates.ts:78
Static Filter
Defined in renderedTemplates/pricing/giftCertificates/giftCertificates.ts:269
Static FilteredQuery
FilteredQuery: { filter: any ; query: any } & {}
Defined in renderedTemplates/pricing/giftCertificates/giftCertificates.ts:205
Static GiftCertificate
Gift
Certificate: { amount?: Money ; balance?: Money ; creationDate?: any ; description?: string ; enabled?: boolean ; lastModified?: any ; maskedGiftCertificateCode?: string ; merchantId?: string ; message?: string ; orderNo?: string ; recipientEmail?: string ; recipientName?: string ; senderName?: string ; status?: string ; transactions?: Array < AccountTransaction > } & {}
Defined in renderedTemplates/pricing/giftCertificates/giftCertificates.ts:21
Static GiftCertificateAmountOutOfRangeException
GiftCertificateAmountOutOfRangeException: {}
Defined in renderedTemplates/pricing/giftCertificates/giftCertificates.ts:332
Static GiftCertificateCreateMerchantIdNotUniqueException
GiftCertificateCreateMerchantIdNotUniqueException: {}
Defined in renderedTemplates/pricing/giftCertificates/giftCertificates.ts:326
Static GiftCertificateNotFound
GiftCertificateNotFound: {}
Defined in renderedTemplates/pricing/giftCertificates/giftCertificates.ts:328
Static GiftCertificateSearchResult
Gift
CertificateSearchResult: { hits: Array < GiftCertificate > ; limit: number ; offset: any ; query: any ; sorts?: Array < Sort > ; total: any } & {}
Defined in renderedTemplates/pricing/giftCertificates/giftCertificates.ts:39
Static GiftCertificates
Gift
Certificates: { data?: Array < GiftCertificate > ; limit: number ; offset: any ; total?: number } & {}
Defined in renderedTemplates/pricing/giftCertificates/giftCertificates.ts:55
Static IntegerRangeFilter
IntegerRangeFilter: {}
Defined in renderedTemplates/pricing/giftCertificates/giftCertificates.ts:80
Static InvalidGiftCertificateException
InvalidGiftCertificateException: {}
Defined in renderedTemplates/pricing/giftCertificates/giftCertificates.ts:340
Static InvalidGiftCertificateStatus
InvalidGiftCertificateStatus: {}
Defined in renderedTemplates/pricing/giftCertificates/giftCertificates.ts:338
Static InvalidRecipientEmail
InvalidRecipientEmail: {}
Defined in renderedTemplates/pricing/giftCertificates/giftCertificates.ts:334
Static L10nString
L10nString: {} & {}
Defined in renderedTemplates/pricing/giftCertificates/giftCertificates.ts:294
Static LocalizedString
LocalizedString: {} & {}
Defined in renderedTemplates/pricing/giftCertificates/giftCertificates.ts:159
Static MalformedQuery
MalformedQuery: {}
Defined in renderedTemplates/pricing/giftCertificates/giftCertificates.ts:330
Static MatchAllQuery
MatchAllQuery: {} & {}
Defined in renderedTemplates/pricing/giftCertificates/giftCertificates.ts:202
Static Money
Money: { currencyMnemonic: string ; value: number } & {}
Defined in renderedTemplates/pricing/giftCertificates/giftCertificates.ts:16
Static MoneyMnemonic
MoneyMnemonic: { currencyMnemonic?: string ; value?: number } & {}
Defined in renderedTemplates/pricing/giftCertificates/giftCertificates.ts:289
Static NestedQuery
NestedQuery: { path: string ; query: any ; scoreMode?: string } & {}
Defined in renderedTemplates/pricing/giftCertificates/giftCertificates.ts:263
Static NoPropertiesAllowed
NoPropertiesAllowed: {}
Defined in renderedTemplates/pricing/giftCertificates/giftCertificates.ts:183
Static NumericRangeFilter
NumericRangeFilter: {}
Defined in renderedTemplates/pricing/giftCertificates/giftCertificates.ts:104
Static OffsetPaginated
OffsetPaginated: {}
Defined in renderedTemplates/pricing/giftCertificates/giftCertificates.ts:98
Static OpenObject
OpenObject: {} & {}
Defined in renderedTemplates/pricing/giftCertificates/giftCertificates.ts:174
Static PaginatedSearchResult
Paginated
SearchResult: { hits?: Array < object > ; limit: number ; offset: any ; query: any ; sorts?: Array < Sort > ; total: any } & {}
Defined in renderedTemplates/pricing/giftCertificates/giftCertificates.ts:162
Static PaginatedSearchResultBase
Paginated
SearchResultBase: { hits?: Array < object > ; limit: number ; offset: any ; query: any ; sorts?: Array < Sort > ; total: any } & {}
Defined in renderedTemplates/pricing/giftCertificates/giftCertificates.ts:193
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/giftCertificates/giftCertificates.ts:136
Static PropertyValueDefinition
Property
ValueDefinition: { description: L10nString ; displayValue: L10nString ; id: string ; position?: number ; value: string }
Defined in renderedTemplates/pricing/giftCertificates/giftCertificates.ts:319
Type declaration
id: string
Optional position?: number
value: string
Static Query
Defined in renderedTemplates/pricing/giftCertificates/giftCertificates.ts:214
Static QueryFilter
QueryFilter: { query: any } & {}
Defined in renderedTemplates/pricing/giftCertificates/giftCertificates.ts:210
Static QueryParamsLimit
QueryParamsLimit: {}
Defined in renderedTemplates/pricing/giftCertificates/giftCertificates.ts:177
Static QueryParamsOffset
QueryParamsOffset: {}
Defined in renderedTemplates/pricing/giftCertificates/giftCertificates.ts:179
Static Range2Filter
Range2Filter: { filterMode?: string ; fromField: string ; fromInclusive?: boolean ; fromValue?: any ; toField: string ; toInclusive?: boolean ; toValue?: any } & {}
Defined in renderedTemplates/pricing/giftCertificates/giftCertificates.ts:240
Static RangeFilter
RangeFilter: {}
Defined in renderedTemplates/pricing/giftCertificates/giftCertificates.ts:100
Static RateLimited
RateLimited: {}
Defined in renderedTemplates/pricing/giftCertificates/giftCertificates.ts:94
Static RateLimited2
RateLimited2: {}
Defined in renderedTemplates/pricing/giftCertificates/giftCertificates.ts:96
Static RateLimited3
RateLimited3: {}
Defined in renderedTemplates/pricing/giftCertificates/giftCertificates.ts:82
Static RateLimited4
RateLimited4: {}
Defined in renderedTemplates/pricing/giftCertificates/giftCertificates.ts:102
Static RateLimited5
RateLimited5: {}
Defined in renderedTemplates/pricing/giftCertificates/giftCertificates.ts:88
Static SearchRequest
Search
Request: { limit?: number ; offset?: any ; query: any ; sorts?: Array < Sort > } & {}
Defined in renderedTemplates/pricing/giftCertificates/giftCertificates.ts:129
Static SearchRequestBase
Search
RequestBase: { limit?: number ; offset?: any ; query: any ; sorts?: Array < Sort > } & {}
Defined in renderedTemplates/pricing/giftCertificates/giftCertificates.ts:282
Static SimpleSearchResult
SimpleSearchResult: { hits?: Array < object > ; limit: number ; offset: any ; total: any } & {}
Defined in renderedTemplates/pricing/giftCertificates/giftCertificates.ts:122
Static SimpleSearchResultBase
SimpleSearchResultBase: { hits?: Array < object > ; limit: number ; offset: any ; total: any } & {}
Defined in renderedTemplates/pricing/giftCertificates/giftCertificates.ts:256
Static SiteSpecific
SiteSpecific: {}
Defined in renderedTemplates/pricing/giftCertificates/giftCertificates.ts:181
Static Sort
Sort: { field: string ; sortOrder?: string } & {}
Defined in renderedTemplates/pricing/giftCertificates/giftCertificates.ts:277
Static SpecifiedPropertiesAllowed
SpecifiedPropertiesAllowed: {} & {}
Defined in renderedTemplates/pricing/giftCertificates/giftCertificates.ts:185
Static SyncCreated
SyncCreated: {}
Defined in renderedTemplates/pricing/giftCertificates/giftCertificates.ts:84
Static TermFilter
TermFilter: { field: string ; operator: string ; values?: Array < any > } & {}
Defined in renderedTemplates/pricing/giftCertificates/giftCertificates.ts:229
Static TermQuery
TermQuery: { fields: Array < string > ; operator: string ; values?: Array < any > } & {}
Defined in renderedTemplates/pricing/giftCertificates/giftCertificates.ts:223
Static TextQuery
TextQuery: { fields: Array < string > ; searchPhrase: string } & {}
Defined in renderedTemplates/pricing/giftCertificates/giftCertificates.ts:235
Static UnqueryableField
UnqueryableField: {}
Defined in renderedTemplates/pricing/giftCertificates/giftCertificates.ts:336
Gift Certificates
Manage your gift certificates.
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.24import { 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 giftCertificatesClient = new Pricing.GiftCertificates(clientConfig);
Last Updated: