Notificaciones Push

Contenidos

Cuando suceda un evento para un contenedor o envío (ingreso a un centro logístico, retenido, dañado, etc.), el servicio del correo deberá informar mediante una notificación push.

Formato Request

Se enviará un mensaje con la siguiente estructura:

POST https://api.mercadolibre.com/tracking/{id}/notifications \ --header 'x-access-token':{accessToken}

Los atributos del body se explican en la siguiente tabla:

{
    "code": string,
    "carrier_code": string,
    "type": string,
    "payload": {
      "flight": {
        "number": string,
        "awb": string,
        "estimated_departure_time": date,
        "estimated_arrival_time": date,
        "operator": string,
        "origin": string,
        "destination": string,
        "pilot": string,
      },
      "reprogrammed_flight": {
        "number": string,
        "estimated_departure_time": date,
        "estimated_arrival_time": date,
        "operator": string,
        "origin": string,
        "destination": string,
        "pilot": string,
      },
      "date": date,
      "comment": string,
      "location": {
          "zip_code": string,
          "country_id": string,
          "state_name": string,
          "city_name": string,
          "neighborhood_name": string,
          "facility": string,
          "geolocation": {
              "geolocation_type": string,
              "latitude": bigdecimal,
              "longitude": bigdecimal
          }
      },
    }
}

Formato Response

Si la notificación fue recibida correctamente, el POST devuelve status OK.

Ejemplos

Request:

{
  "type": "handling_unit",
  "code": "AP-0401",
  "carrier_code": "123",
  "payload": {
      "flight": {
          "number": "456",
          "estimated_departure_time": "2021-01-27T16:12:28.397843Z",
          "origin": "GRU",
          "destination": "GIG"
      },
      "date": "2021-01-27T16:12:28.397843Z",
      "comment": "Entregado a aerolinea",
      "location": {
          "facility": "GRU",
          "state_name": "São Poulo",
          "city_name": "Guarulhos",
          "geolocation": {
              "geolocation_type": "ROOFTOP",
              "latitude": -23,5000,
              "longitude": -46,6166
          }
      }
  }
}

Response:

Satisfactioria

{
    "status": OK
}

Errores

Si ocurre algún error, la API devuelve HTTP status distinto de OK (200) . Si el código de error HTTP es del tipo 4XX no se debe reintentar (ya que hay algún problema con el request). Si por el contrario, es 5XX, se debe reintentar utilizando algún mecanismo de backoff con al menos tres reintentos.

Failed (400 FAILED)

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

Error (500 ERROR)

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