Interface ProductPriceExternalDiscountSetMessage

Generated after a successful Set Discounted Price update action.

interface ProductPriceExternalDiscountSetMessage {
    createdAt: string;
    createdBy?: CreatedBy;
    discounted?: DiscountedPrice;
    id: string;
    lastModifiedAt: string;
    lastModifiedBy?: LastModifiedBy;
    priceId: string;
    resource: Reference;
    resourceUserProvidedIdentifiers?: UserProvidedIdentifiers;
    resourceVersion: number;
    sequenceNumber: number;
    sku?: string;
    staged: boolean;
    type: "ProductPriceExternalDiscountSet";
    variantId: number;
    variantKey?: string;
    version: number;
}

Properties

createdAt createdBy? discounted? id lastModifiedAt lastModifiedBy? priceId resource resourceUserProvidedIdentifiers? resourceVersion sequenceNumber sku? staged type variantId variantKey? version

Properties

Readonly createdAt

createdAt: string

Date and time (UTC) the Message was generated.

Optional Readonly createdBy

createdBy?: CreatedBy

IDs and references that created the Message.

Optional Readonly discounted

discounted?: DiscountedPrice

Discounted Price for the Product Variant for which Discount was set.

Readonly id

id: string

Unique identifier of the Message. Can be used to track which Messages have been processed.

Readonly lastModifiedAt

lastModifiedAt: string

Value of createdAt.

Optional Readonly lastModifiedBy

lastModifiedBy?: LastModifiedBy

IDs and references that last modified the Message.

Readonly priceId

priceId: string

Unique identifier of the Price.

Readonly resource

resource: Reference

Reference to the resource on which the change or action was performed.

Optional Readonly resourceUserProvidedIdentifiers

resourceUserProvidedIdentifiers?: UserProvidedIdentifiers

User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

Readonly resourceVersion

resourceVersion: number

Version of the resource on which the change or action was performed.

Readonly sequenceNumber

sequenceNumber: number

Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

Optional Readonly sku

sku?: string

SKU of the Product Variant for which Discount was set.

Readonly staged

staged: boolean

Whether the update was only applied to the staged Product Projection.

Readonly type

type: "ProductPriceExternalDiscountSet"

Readonly variantId

variantId: number

Unique identifier of the Product Variant for which the Discount was set.

Optional Readonly variantKey

variantKey?: string

Key of the Product Variant for which the Discount was set.

Readonly version

version: number

Version of a resource. In case of Messages, this is always 1.

Settings

Member Visibility

Theme

On This Page

createdAtcreatedBydiscountedidlastModifiedAtlastModifiedBypriceIdresourceresourceUserProvidedIdentifiersresourceVersionsequenceNumberskustagedtypevariantIdvariantKeyversion