Interface ParcelMeasurementsUpdatedMessage

Generated after a successful Set Parcel Measurements update action.

interface ParcelMeasurementsUpdatedMessage {
    createdAt: string;
    createdBy?: CreatedBy;
    deliveryId: string;
    id: string;
    lastModifiedAt: string;
    lastModifiedBy?: LastModifiedBy;
    measurements?: ParcelMeasurements;
    parcelId: string;
    resource: Reference;
    resourceUserProvidedIdentifiers?: UserProvidedIdentifiers;
    resourceVersion: number;
    sequenceNumber: number;
    shippingKey?: string;
    type: "ParcelMeasurementsUpdated";
    version: number;
}

Properties

createdAt createdBy? deliveryId id lastModifiedAt lastModifiedBy? measurements? parcelId 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

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

Readonly deliveryId

deliveryId: string

Unique identifier of the Delivery.

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

Value of createdBy.

Optional Readonly measurements

measurements?: ParcelMeasurements

The Parcel Measurements that were set on the Parcel.

Readonly parcelId

parcelId: string

Unique identifier of the Parcel.

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 Multi ShippingMode.

Readonly type

type: "ParcelMeasurementsUpdated"

Readonly version

version: number

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

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc