OrderShippingAddress

A postal address an order ships to.

  • city
    Type: string
    required

    City.

  • countryCode
    Type: string
    required

    Destination country as a two-letter ISO 3166-1 alpha-2 code.

  • line1
    Type: string
    required

    Street address, first line.

  • line2
    Type: string nullable
    required

    Street address, second line. null when unused.

  • phone
    Type: string nullable
    required

    Contact phone. null when not provided.

  • postalCode
    Type: string
    required

    Postal or ZIP code.

  • recipientName
    Type: string
    required

    Name the parcel is addressed to.

  • state
    Type: string nullable
    required

    State or province. null when unused.

Examples
{
  "recipientName": "Marie Dubois",
  "line1": "14 Rue des Lilas",
  "line2": null,
  "city": "Lyon",
  "state": null,
  "postalCode": "69003",
  "countryCode": "FR",
  "phone": null
}