Interface ProductTailoringCreatedMessage

Generated after a successful Create Product Tailoring or Create Product Tailoring in Store request.

interface ProductTailoringCreatedMessage {
    createdAt: string;
    createdBy?: CreatedBy;
    description?: LocalizedString;
    id: string;
    key?: string;
    lastModifiedAt: string;
    lastModifiedBy?: LastModifiedBy;
    name?: LocalizedString;
    product: ProductReference;
    productKey?: string;
    published: boolean;
    resource: Reference;
    resourceUserProvidedIdentifiers?: UserProvidedIdentifiers;
    resourceVersion: number;
    sequenceNumber: number;
    slug?: LocalizedString;
    store: StoreKeyReference;
    type: "ProductTailoringCreated";
    version: number;
}

Properties

createdAt createdBy? description? id key? lastModifiedAt lastModifiedBy? name? product productKey? published resource resourceUserProvidedIdentifiers? resourceVersion sequenceNumber slug? store type 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 description

description?: LocalizedString

The description of the Product Tailoring at the time of creation.

Readonly id

id: string

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

Optional Readonly key

key?: string

User-defined unique identifier of the Product Tailoring.

Readonly lastModifiedAt

lastModifiedAt: string

Value of createdAt.

Optional Readonly lastModifiedBy

lastModifiedBy?: LastModifiedBy

IDs and references that last modified the Message.

Optional Readonly name

name?: LocalizedString

The name of the Product Tailoring at the time of creation.

Readonly product

product: ProductReference

Reference to the Product the Product Tailoring belongs to.

Optional Readonly productKey

productKey?: string

User-defined unique identifier of the Product this Product Tailoring belongs to.

Readonly published

published: boolean

true if the ProductTailoring is published.

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 slug

slug?: LocalizedString

The slug of the Product Tailoring at the time of creation.

Readonly store

store: StoreKeyReference

The Store to which the Product Tailoring belongs.

Readonly type

type: "ProductTailoringCreated"

Readonly version

version: number

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

Settings

Member Visibility

Theme

On This Page

createdAtcreatedBydescriptionidkeylastModifiedAtlastModifiedBynameproductproductKeypublishedresourceresourceUserProvidedIdentifiersresourceVersionsequenceNumberslugstoretypeversion