↑
Tracking

Generar un enlace de seguimiento

Para generar un enlace de seguimiento es necesario realizar una solicitud a la API utilizando el método POST al siguiente endpoint:

Crear un pedido y generar el enlace de seguimiento

Parámetros obligatorios

  • description – Descripción.
  • status – Objeto con datos sobre el estado del pedido.
    • value – Valores posibles: ["PREPARING", "ON_THE_WAY", "DONE", "NOT_DONE", "CANCELLED"].
    • label – Texto personalizado que se mostrará en la página de seguimiento.
  • destination – Objeto que contiene los datos de la ubicación de destino.
    • road – (Opcional) Nombre de la calle de destino.
    • number – (Opcional) Número del destino.
    • city – (Opcional) Ciudad de destino.
    • zipCode – (Opcional) Código postal del destino.
    • state – (Opcional) Objeto que contiene datos sobre el estado de la ubicación de destino.
      • code – Siglas del Estado.
      • name – Nombre del Estado.
    • mainLocation – Objeto que contiene las coordenadas del destino.
      • lat – Coordenada de latitud en grados decimales.
      • lon – Coordenada de latitud en grados decimales.

Ejemplo con parámetros obligatorios

{
    "description": "Product Test",
    "status": {
        "value": "PREPARING",
        "label": "Estamos preparando o seu pedido"
    },
    "destination": {
        "mainLocation": {
            "lat": -22.72725697031394,
            "lon": -47.636846753567944
        }
    }
}

Parámetros opcionales

  • companyName – Nombre de la empresa.
  • number – Número de pedido.
  • theme – Tema que se utilizará para personalizar la página de seguimiento. Si no, se aplicará el tema de white-label.
  • estimatedArrival – Entrega estimada. Formato: "yyyy-MM-ddTHH:mm:ss". Ejemplo: "2022-11-22T10:00:00"
  • totalValue – Objeto que contiene el valor total del pedido.
    • value – Número entero que representa el valor total del pedido.
    • currency – Tipo de moneda. Para Real, utilice BRL
  • origin – Objeto que contiene los datos del lugar de origen.
    • road – (Opcional) Nombre de la calle del lugar de origen.
    • number – (Opcional) Número del lugar de origen.
    • city – (Opcional) Ciudad del lugar de origen.
    • zipCode – (Opcional) Código postal del lugar de origen.
    • state – (Opcional) Objeto que contiene datos sobre el lugar de origen.
      • code – Siglas del Estado.
      • name – Nombre del Estado.
    • mainLocation – Objeto que contiene las coordenadas del lugar de origen.
      • lat – Coordenada de latitud en grados decimales.
      • lon – Coordenada de latitud en grados decimales.
  • driver – Objeto que contiene los datos del conductor
    • name – (Opcional) Nombre del conductor
    • image – (Opcional) URL de la foto del conductor que se mostrará en el sitio web
    • currentLocation – Objeto con las coordenadas iniciales del conductor.
      • lat – Coordenada de latitud en grados decimales.
      • lon – Coordenada de longitud en grados decimales.

Nota: Si el estado del pedido es ON_THE_WAY, el parámetro driver se convierte en obligatorio.

Ejemplo con parámetros opcionales

{
  "number": "1232132132143438",
  "description": "Product Test",
  "estimatedArrival": "2022-11-22T10:00:00",
  "companyName": "Maplink",
  "totalValue": {
    "value": 23.12,
    "currency": "BRL"
  },
  "status": {
    "value": "ON_THE_WAY",
    "label": "Pedido em trânsito"
  },
  "origin": {
    "road": "Alameda Campinas",
    "number": "579",
    "city": "São Paulo",
    "zipCode": "01419001",
    "state": {
      "code": "SP",
      "name": "São Paulo"
    },
    "mainLocation": {
      "lat": -22.7342864,
      "lon": -47.6480644
    }
  },
  "destination": {
    "road": "R. Menina Rosana",
    "number": "70",
    "city": "Itajaí",
    "zipCode": "88304250",
    "state": {
      "code": "SC",
      "name": "Santa Catarina"
    },
    "mainLocation": {
      "lat": -22.72725697031394,
      "lon": -47.636846753567944
    }
  },
  "driver": {
    "name": "Maplink BR",
    "image": "https://example.com",
    "currentLocation": {
      "lat": -23.564515,
      "lon": -46.652681
    }
  },
  "theme": "DEFAULT"
}

Ejemplo de respuesta

La respuesta tendrá la siguiente estructura:

{
    "id": "63a1b72fd2b7520ade692253",
    "url": "https://tracking.maplink.global/eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJjIjoicUJQRVJzWXBHdUJwOWtzeEExRUduY0lZbFZNOFVMZWUiLCJpZCI6IjYzYTFiNzJmZDJiNzUyMGFkZTY5MjI1MyIsImlhdCI6MTY3MTU0MjU3NX0.NzncB9t_1ShqnlbbS3O3gGt8E0_rloxKrMrmVDwcnQU"
}

Dónde:

  • id – ID de referencia de la orden;
  • url – Enlace a la página de seguimiento.

Página de seguimiento

La plantilla de página de seguimiento de white-label se puede ver a continuación:

Consultar pedido

Para consultar el pedido, basta con enviar una solicitud con el método GET al siguiente endpoint: https://api.maplink.global/tracking/v1/orders/{{trackingId}}

Donde el término {{trackingId}} debe ser sustituido por el ID de la solicitud a consultar.

Los pedidos y los enlaces de seguimiento pueden consultarse durante un periodo de 7 días.

Borrar orden

Para eliminar un pedido, basta con enviar una solicitud con el método DELETE al siguiente endpoint:

https://api.maplink.global/tracking/v1/orders/{{trackingId}}

Donde el término {{trackingId}} debe ser sustituido por el ID de la orden a eliminar.