Push Notifications

Contents

Important:
  • For security in push tracking, OAuth will be used.
  • Please check the required fields that must be sent according to the specified event.

Request

Shipments

The shipment notifications must be sent to this endpoint:

POST 'https://api.mercadolibre.com/shipments/{shipmentId}/notifications' \ --header 'Authorization: Bearer {accessToken}'

Handling Units

The HU notifications must be sent to this endpoint:

POST 'https://api.mercadolibre.com/tracking/{id}/notifications' \ --header 'Authorization: Bearer {accessToken}'

Response

Successful

If the notification was received successfully, the POST returns status OK.

{
  "status": OK
}

Failed (400 FAILED)

If the HTTP error code is type 4XX, it should not be reattempted (as there is some problem with the request).

{
  "message": "User must have a valid scope",
  "error": "invalid_scopes",
  "status": 403,
  "cause": null,
  "internal_cause": [ ]
}

Error (500 ERROR)

If the HTTP error code is type 5XX, it must be reattempted using some backoff mechanism with at least three retries.

{
  "message": "Internal error server",
  "error": "internal_error_server",
  "status": 500,
  "cause": null,
  "internal_cause": [ ]
}

Test Notifications

To send a test notification, it will be necessary:

  • Valid credentials (access token) to the stage environment.
  • Notification mappings validated and created in the stage environment.
  • Shipment created with a "test" tag.

The shipment test notifications must be sent to this endpoint:

POST 'https://api.mercadolibre.com/stage/shipments/{shipmentId}/notifications' \
--header 'Authorization: Bearer {accessToken}'
Note:
  • To create a test shipment, please contact the Integrations or Tracking team.