API Reference
  1. CARRIER INTEGRATION

Receive events

If you are not familiar with a webhook, it is nothing more than a POST request in which the body is a JSON, that comes from our system (Abbiamo) to your system. In this page, you will understand our warnings and recommendations about this matter.

If you haven't yet, please get our Postman/Insomnia collections to make your work easier while developing and testing

📘

Webhook registration required

In order to receive the webhooks (events) registered in this session, you must have 2 URLs registered. They can be different URLs or the same:

  • Delivery Request URL
  • Cancellation Request URL

👍

Request authorization supported and recommended

In these webhooks (events), it is possible to send a header "Authorization" in order to keep the endpoint safe. So please, let us know about which token we should use in each event.

🚧

Make sure to properly listen to the Cancellation event

Sometimes, setbacks may happen and the costumer might need to cancel the request. Please make sure that you have properly developed a reliable system to listen to those cancellation events. That could avoid issues regarding courier allocation or any other undesirable setback.

If you have doubts on this matter, please get in touch with Abbiamo team to mitigate them.

🚧

Abbiamo Timeout System

Please read carefully about our timeout system below

Timeout System

Aiming to deliver the best experience possible to our costumers, we have a Timeout System that will automatically CANCEL the delivery request after a default time of 30 minutes if it is not CONFIRMED by the carrier's system.

To avoid this scenario, you have to process and confirm the delivery as soon as possible, using Confirm Delivery. Please keep in mind that we will notify you via WEBHOOK in case of the delivery request has timed out and that this default time of 30 minutes is configurable.

Collection
To make it easier to try the endpoints we made a collection Abbiamo API for Carrier Integrations that can be run in Postman. The guide to use a collection can be found in the Collections section. If you have already read the section or are familiar with importing collections to Postman you can copy the URL in the button below:
Get JSON file

❗️

In case of error in the request

If the DELIVERY_REQUEST event is not successful you should send a response with the error as a string value inside an object with the key abbiamo_error therefore we can mirror it in our dashboard to warn the seller about the issue. Example:

{
  "abbiamo_error": "customer phone must be valid"
}