snapcasterDevelopers

    API reference · Types

    OrderAdditionOfferShippingUpgrade

    The shipping option this addition would UPGRADE the parcel to, or null when it rides the one already paid for. All purchased additions share the original parcel: there is never a second shipment. The upgrade becomes the order’s effective option and tracking requirement only when the payment succeeds, and the historical shipping charges are not rewritten - each stays on the payment that collected it. The amount is money.shipping_cents.

    Type: object or null

    Example

    Generated Schema example: Generated OrderAdditionOfferShippingUpgrade
    {
  "method": "string",
  "is_tracked": true
}

    Fields

    method string required

    The upgraded option’s label, in the wording an order’s shipping method uses.

    is_tracked boolean required

    Whether the upgraded option requires tracking when the order is marked shipped.

    Used by