Typescript SDK Type Docs
    Preparing search index...

    Interface SetParcelMeasurementsChange

    Change triggered by the following update actions:

    - [SetParcelMeasurements](ctp:api:type:OrderSetParcelMeasurementsAction) on Orders.
- [SetParcelMeasurements](ctp:api:type:StagedOrderSetParcelMeasurementsAction) on Staged Orders.
    interface SetParcelMeasurementsChange {
        change: string;
        nextValue: ParcelMeasurements;
        parcel: ParcelChangeValue;
        previousValue: ParcelMeasurements;
        type: "SetParcelMeasurementsChange";
    }

    Hierarchy (View Summary)

    Index

    Properties

    change nextValue parcel previousValue type

    Properties

    change: string

    Change type on a resource that is similar to the update action it relates to, where possible. It is not a unique identifier for the data structure, for example, the setDescription change can occur with a localized and non-localized representation.

    [Records](ctp:history:type:Record) can be filtered by this value using the `changes` query parameter.
    nextValue: ParcelMeasurements

    Value after the change.

    parcel: ParcelChangeValue

    Information about the updated Parcel.

    previousValue: ParcelMeasurements

    Value before the change.

    type: "SetParcelMeasurementsChange"

    Unique discriminator value to reliably deserialize the data type.

    Settings

    Member Visibility

    On This Page

    Properties