Share via


CollectionProperties interface

The collection details

Properties

allSubscriptions

Indicating whether all subscriptions are selected (=true) or not (=false).

appliedRules

Gets list of collection rules

approveAllItems

Indicating whether all items are approved for this collection (=true) or not (=false).

approveAllItemsModifiedAt

Gets the modified date of all items approved.

claim

Gets or sets the association with Commercial's Billing Account.

collectionId

Gets collection Id.

collectionName

Gets or sets collection name.

enabled

Indicating whether the collection is enabled or disabled.

numberOfOffers

Gets the number of offers associated with the collection.

subscriptionsList

Gets or sets subscription ids list. Empty list indicates all subscriptions are selected, null indicates no update is done, explicit list indicates the explicit selected subscriptions. On insert, null is considered as bad request

Property Details

allSubscriptions

Indicating whether all subscriptions are selected (=true) or not (=false).

allSubscriptions?: boolean

Property Value

boolean

appliedRules

Gets list of collection rules

appliedRules?: Rule[]

Property Value

Rule[]

approveAllItems

Indicating whether all items are approved for this collection (=true) or not (=false).

approveAllItems?: boolean

Property Value

boolean

approveAllItemsModifiedAt

Gets the modified date of all items approved.

approveAllItemsModifiedAt?: Date

Property Value

Date

claim

Gets or sets the association with Commercial's Billing Account.

claim?: string

Property Value

string

collectionId

Gets collection Id.

collectionId?: string

Property Value

string

collectionName

Gets or sets collection name.

collectionName?: string

Property Value

string

enabled

Indicating whether the collection is enabled or disabled.

enabled?: boolean

Property Value

boolean

numberOfOffers

Gets the number of offers associated with the collection.

numberOfOffers?: number

Property Value

number

subscriptionsList

Gets or sets subscription ids list. Empty list indicates all subscriptions are selected, null indicates no update is done, explicit list indicates the explicit selected subscriptions. On insert, null is considered as bad request

subscriptionsList?: string[]

Property Value

string[]