snapcasterDevelopers

    API reference · Types

    OrderAddressVerification

    The post-order address verification verdict on the customer snapshot, and the suggested address when one differs from it. Always present; pending until a verdict lands. On order.created it is always pending: the check runs after the order is placed, and a retried event stays byte-identical. A landed verdict reaches you through GET /orders (the order reappears with a new updated_at) (STABLE).

    Type: object

    Example

    Schema example: from the GET /orders response
    {
  "status": "pending",
  "suggested_address": null
}

    Fields

    status string required

    The verification status of the customer shipping address. pending until a verdict lands (a fresh order always reads pending); verified / verified_unit mean deliverable; missing_unit / unit_unconfirmed / not_found are address problems worth a look before shipping; failed means the check itself could not run and says nothing about the address. Closed vocabulary, extended additively (STABLE).

    Constraints: allowed values: pending, verified, verified_unit, missing_unit, unit_unconfirmed, not_found, failed Example pending

    suggested_address OrderWebhookShippingAddress or null required

    The standardized address the verification suggests, present only when a verdict landed with a suggestion that differs from the customer snapshot; null otherwise. Advisory: the seller decides where to ship, and that decision is ship_to (STABLE).

    Show child fieldsHide child fields
    suggested_address.line1 string required

    The street address.

    suggested_address.line2 string or null required

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

    suggested_address.city string required

    The city in the shipping address.

    suggested_address.province string required

    The Canadian province or territory in the delivery address.

    suggested_address.postal_code string required

    The Canadian postal code in the delivery address.

    suggested_address.country string required

    ISO 3166-1 alpha-2 country code.

    Used by