Saltar al contenido principal

Integración con API de Flete

Disponibilizamos para los sellers que la consulta de flete sea realizada a través de gateways de flete. Esto posibilita que los socios logísticos desarrollen la integración con el ANYMARKET

Cuando esta implementación está habilitada, el ANYMARKET comenzará a realizar llamadas a la URL del socio de flete, y si la API de flete responde en un tiempo hábil (hasta 250ms), el ANYMARKET enviará esos datos al Marketplace.

¿Qué necesita desarrollar el integrador?​

Flujo: Consulta de Flete​

Cuando su integración está habilitada con ANYMARKET, y hay una consulta de flete en el Marketplace, realizaremos una llamada POST al endpoint informado en los parámetros del sistema, enviando como cuerpo de la solicitud un JSON en el siguiente formato:

[POST] http://endereco.frete.com.br
{
  "zipCode" : "87100000",
  "marketplace": "Mercado Livre",
  "products" : [
    {
      "sku" : "A1512",
      "height" : 10,
      "width" : 20,
      "weight" : 20,
      "length" : 20,
      "amount" : 1,
      "value" : 149.90,
      "originZipCode" : null
    },
    {
      "sku" : "B1510",
      "height" : 20,
      "width" : 35,
      "weight" : 35,
      "length" : 10,
      "amount" : 2,
      "value" : 299.90,
      "originZipCode" : "87100000",
      "metadata": {
        "idInMarketplace" : "MLB1039413643",
        "official_store_id" : "224"
      }
    }
  ]
}

Los tipos de flete aceptados por ANYMARKET son NORMAL y EXPRESSA. Como respuesta, ANYMARKET espera un JSON en el siguiente formato:

Ejemplo de respuesta
{
  "items" : [
    {
      "serviceName" : "Transporte Terrestre",
      "carrierName" : "Seller Transporte",
      "deliveryTime" : 12,
      "price" : 23.99,
      "freightType" : "NORMAL"
    },
    {
      "serviceName" : "SEDEX",
      "carrierName" : "Seller Transporte",
      "deliveryTime" : 6,
      "price" : 35.90,
      "freightType" : "EXPRESSA"
    }
  ]
}

Debe retornarse únicamente un registro por cada combinación Transportadora x Tipo de Flete. Es decir, no debe retornarse dos registros para la misma transportadora con el tipo de flete NORMAL, por ejemplo.

La imagen a continuación presenta cómo se realiza el flujo de consulta de flete, desde la llamada del marketplace hasta el retorno del resultado.

apifrete.png

aviso

¡Atención!​

En caso de que se retorne un array vacío en el JSON de respuesta, ANYMARKET verificará si existe algún valor de flete configurado dentro del propio sistema; si lo hay, retornaremos al marketplace el valor configurado en el sistema; de lo contrario, se retornará que para esa determinada cotización realizada no existe flete disponible para efectuar la entrega.

Flujo: Creación de Colecta​

ANYMARKET posee la funcionalidad de notificación de eventos: cuando ocurre un evento, por ejemplo cuando el estado del pedido es modificado, notificaremos su aplicación.

Para recibir las notificaciones de ANYMARKET, es necesario que su aplicación acepte solicitudes POST en formato JSON. Las notificaciones serán enviadas en el siguiente formato:

{
  "type" : "ORDER",
    "content" : {
    "id":"10",
    "oi":"99999."
  }
}

Tras ser notificado, es necesario que su aplicación realice un GET del pedido en ANYMARKET para absorber toda la información de la venta.

¿Cómo habilitar la integración?​

Para habilitar la consulta de flete por API, el seller debe acceder a la pantalla de parámetros de ANYMARKET, seleccionar la opción de cálculo de flete por API e informar la URL de la API tal como se ilustra en la imagen a continuación.

parametro frete.png

Para habilitar la notificación de pedidos, el seller debe acceder a la pantalla de parámetros de ANYMARKET, ir al menú "Callbacks" e informar el Callback del socio logístico, tal como se ilustra a continuación:

55.png