Interface OrderShippingAddressSetMessage

Generated after a successful Set Shipping Address update action.

interface OrderShippingAddressSetMessage {
    address?: Address;
    createdAt: string;
    createdBy?: CreatedBy;
    id: string;
    lastModifiedAt: string;
    lastModifiedBy?: LastModifiedBy;
    oldAddress?: Address;
    resource: Reference;
    resourceUserProvidedIdentifiers?: UserProvidedIdentifiers;
    resourceVersion: number;
    sequenceNumber: number;
    type: "OrderShippingAddressSet";
    version: number;
}

Hierarchy (View Summary)

Properties

address? createdAt createdBy? id lastModifiedAt lastModifiedBy? oldAddress? resource resourceUserProvidedIdentifiers? resourceVersion sequenceNumber type version

Properties

Optional Readonlyaddress

address?: Address

Shipping address on the Order after the Set Shipping Address update action.

ReadonlycreatedAt

createdAt: string

Date and time (UTC) the Message was generated.

Optional ReadonlycreatedBy

createdBy?: CreatedBy

IDs and references that created the Message.

Readonlyid

id: string

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

ReadonlylastModifiedAt

lastModifiedAt: string

Value of createdAt.

Optional ReadonlylastModifiedBy

lastModifiedBy?: LastModifiedBy

IDs and references that last modified the Message.

Optional ReadonlyoldAddress

oldAddress?: Address

Shipping address on the Order before the Set Shipping Address update action.

Readonlyresource

resource: Reference

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

Optional ReadonlyresourceUserProvidedIdentifiers

resourceUserProvidedIdentifiers?: UserProvidedIdentifiers

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

ReadonlyresourceVersion

resourceVersion: number

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

ReadonlysequenceNumber

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.

Readonlytype

type: "OrderShippingAddressSet"

Message Type of the Message.

Readonlyversion

version: number

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

Settings

Member Visibility

On This Page

Properties