snapcasterDevelopers

    API reference · Types

    OrderShipTo

    Where the order ships: the newest seller address correction if one exists, otherwise the customer snapshot. Always present. Print from this block, not from customer. On order.created it always equals the snapshot; a later correction reaches you through GET /orders (the order reappears with a new updated_at), never by changing that event’s bytes (STABLE).

    Type: object

    Example

    Schema example: from the GET /orders response
    {
  "name": "Alex Morgan",
  "shipping_address": {
    "line1": "123 Sandbox Avenue",
    "line2": "Unit 4",
    "city": "Toronto",
    "province": "ON",
    "postal_code": "M5V 2T6",
    "country": "CA"
  }
}

    Fields

    name string required

    The recipient name to print on the label.

    Example Alex Morgan

    shipping_address OrderWebhookShippingAddress or null required

    The six-field §6.1 address to print on the label. null only for an order minted without a shipping address (an operator-seeded or legacy row), which checkout never produces.

    Show child fieldsHide child fields
    shipping_address.line1 string required

    The street address.

    Example 123 Sandbox Avenue

    shipping_address.line2 string or null required

    The unit, suite, or second address line, if supplied.

    Example Unit 4

    shipping_address.city string required

    The city in the shipping address.

    Example Toronto

    shipping_address.province string required

    The Canadian province or territory in the delivery address.

    Example ON

    shipping_address.postal_code string required

    The Canadian postal code in the delivery address.

    Example M5V 2T6

    shipping_address.country string required

    ISO 3166-1 alpha-2 country code.

    Example CA

    Used by