Skip to main content

Recipient Information

It represents basic information of the final recipient. This information is used to contact the recipient in case there are problems locating the recipient during delivery. This information is not persisted in the system, and is deleted once the shipment's life cycle ends.

Fields​

FieldData typeRequiredDefault
fullNameStringSi
phoneStringSi
emailStringNo

Fields description​

fullName​

Name of the final recipient. Ideally it should be enough information to locate the recipient if necessary.

Example:

    John Doe

phone​

Contact phone number of the final recipient. Ideally it should be enough information to locate the recipient if necessary.

Example:

    5511112222
    +525511112222
    +52 5511112222
    +52 55 11112222

email​

Contact email of the final recipient. Ideally it should be enough information to locate the recipient if necessary.

Example:

    john.doe@gmail.com

Examples:​

Example in JSON format that makes use of all the fields

{
  "fullName": "John Doe",
  "phone": "5511112222",
  "email": "john.doe@gmail.com"
}

Example in JSON format that makes use of only the required fields

{
  "fullName": "John Doe",
  "phone": "5511112222"
}