Schema

Address

Address can be either a standard address or a service point (relay point). Use 'address' for home delivery or 'servicePoint' for relay point delivery.

Fields

  • idstring, nullable
  • namestringrequired
  • phonestringrequired
  • emailstring (email)required
  • addressobject
    Standard address for home delivery. Required if servicePoint is not provided.
  • address.addressLine1stringrequired
  • address.addressLine2string, nullable
  • address.citystringrequired
  • address.postcodestringrequired
  • address.countryCodestringrequired
  • servicePointobject
    Service point (relay point) for pickup delivery. Required if address is not provided. Use with a carrierServiceId that supports service points.
  • servicePoint.idstringrequired
    The service point ID from the carrier (e.g., Sendcloud service point ID)
  • servicePoint.countrystringrequired
    ISO 2-letter country code of the service point
Example
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "Jean Dupont",
  "phone": "+33612345678",
  "email": "[email protected]",
  "address": {
    "addressLine1": "10 rue de la République",
    "addressLine2": "Appartement 123",
    "city": "Paris",
    "postcode": "75001",
    "countryCode": "FR"
  },
  "servicePoint": {
    "id": "12624766",
    "country": "LU"
  }
}