Interface DeliveryAddedMessage

Generated after a successful Add Delivery update action.

interface DeliveryAddedMessage {
    createdAt: string;
    createdBy?: CreatedBy;
    delivery: Delivery;
    id: string;
    lastModifiedAt: string;
    lastModifiedBy?: LastModifiedBy;
    resource: Reference;
    resourceUserProvidedIdentifiers?: UserProvidedIdentifiers;
    resourceVersion: number;
    sequenceNumber: number;
    shippingKey?: string;
    type: "DeliveryAdded";
    version: number;
}

Properties

createdAt createdBy? delivery id lastModifiedAt lastModifiedBy? resource resourceUserProvidedIdentifiers? resourceVersion sequenceNumber shippingKey? 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.

Readonly delivery

delivery: Delivery

Delivery that was added to the Order. The Delivery in the Message body does not contain Parcels if those were part of the initial Add Delivery update action. In that case, the update action produces an additional Parcel Added To Delivery Message containing information about the Parcels.

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 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 shippingKey

shippingKey?: string

User-defined unique identifier of the Shipping Method in a Cart with Multiple ShippingMode.

Readonly type

type: "DeliveryAdded"

Readonly version

version: number

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

Settings

Member Visibility

Theme

On This Page

createdAtcreatedBydeliveryidlastModifiedAtlastModifiedByresourceresourceUserProvidedIdentifiersresourceVersionsequenceNumbershippingKeytypeversion