Interface ProductPriceExternalDiscountSetMessage

Generated after a successful Set Discounted Embedded 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: string

Date and time (UTC) the Message was generated.

createdBy?: CreatedBy

Present on resources created after 1 February 2019 except for events not tracked.

discounted?: DiscountedPrice

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

id: string

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

lastModifiedAt: string

Value of createdAt.

lastModifiedBy?: LastModifiedBy

Value of createdBy.

priceId: string

Unique identifier of the Price.

resource: Reference

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

resourceUserProvidedIdentifiers?: UserProvidedIdentifiers

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

resourceVersion: number

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

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.

sku?: string

SKU of the Product Variant for which Discount was set.

staged: boolean

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

type: "ProductPriceExternalDiscountSet"
variantId: number

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

variantKey?: string

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

version: number

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

Generated using TypeDoc