Guides Carrier Notifications

It is possible to let the carrier send notifications. Based upon the carrier and the reciever this can be a push notification in their app and / or an email.

This feature will be available after the 1st of november 2022

Setup

To prohibit the carrier from sending any push notifications to the recipient, no longer send the email in the delivery.address object. (see opt-out example)

To allow these notifications add an email to the address object in the deliveries object. Please make sure it is a valid email address

Example of opt-in

{
  "deliveries": [
    {
      "address": {
        "company_name": "",
        "first_name": "Friso",
        "last_name": "Speulman",
        "street": "Fortuinweg",
        "house_number": 17,
        "addition": "",
        "postal_code": "9113 PR",
        "city": "Dokkum",
        "country": "NL",
        "email": "api@probo.local"
      }
    }
  ],
  "products": [
    "..."
  ]
}

Example of opt-out

{
  "deliveries": [
    {
      "address": {
        "company_name": "",
        "first_name": "Friso",
        "last_name": "Speulman",
        "street": "Fortuinweg",
        "house_number": 17,
        "addition": "",
        "postal_code": "9113 PR",
        "city": "Dokkum",
        "country": "NL"
      }
    }
  ],
  "products": [
    "..."
  ]
}