HELP CENTERSTATUSDISCORD
API Reference

API Remota de Frete

DOCUMENTAÇÃO API REMOTA DE FRETE v0.1b CONVERTIZE

Bem vindo a documentação do protocolo de frete Convertize.

Para se integrar com nosso protocolo de pagamento você deverá desenvolver uma Web API (REST) seguindo todas as informações deste protocolo.

Exemplo: {BASE_URL}/{OPERATION_URI}

{BASE_URL} => URL base que aponta para sua WebAPI

{OPERATION_URI} => Endpoint específico chamados pelo protocolo de frete Convertize

I - Authentication

Nosso sistema envia 2 headers de validação que é possível customizar via ambiente administrativo da Convertize, segue exemplo abaixo:

X-CONVERTIZE-APPKEY: APPKEY

X-CONVERTIZE-APPTOKEN: APPTOKEN

II - Cotação

URL: {BASE_URL}/calculate/

📘

**obs: o endpoint /calculate/ não pode ser alterado.

Ex: http://frete-teste-api.herokuapp.com/calculate/

Request Headers:

{
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-CONVERTIZE-APPTOKEN": "", // Convertize APPTOKEN
    "X-CONVERTIZE-APPKEY": "" // Convertize APPKEY
}

Request Body:

{
  "zipcode": "14015130", // CEP de Envio
  "amount": "190.00000", // Valor do carrinho
  "items": [{ // array[] de itens do carrinho
    "weight": "5.300", // peso em kg
    "ean_13": "0123456789012", // ean13
    "height": "100.000", // altura
    "width": "0.349", // largura
    "depth": "0.410", // profundidade
    "reference_code": null, // Código de referência do SKU
    "id": 2, // Convertize SKU id
    "quantity": 1, // Quantidade
    "modals": null // Modal de entrega 
 },{
  "weight": "6.350", // peso em kg
  "ean_13": "978020137962", // ean13
  "height": "71.000", // altura
  "width": "0.500", // largura
  "depth": "0.250", // profundidade
  "reference_code": "123", // Código de referência do SKU
  "id": 1, // Convertize SKU id
  "quantity": 1, // Quantidade
  "modals": null // Modal de entrega 
 }]
}

Response Body:

{
  "services": [ //[] array de envio de serviços disponíveis
    {
      "price": 5.90, // Preço Promocional
      "original_price": 5.90, // Preço original
      "delivery_time": 4, // Prazo de Entrega
      "original_delivery_time": 4, // Prazo de Entrega original
      "label": "Motoboy", // Label, é exibido ao cliente
      "service": "MOTOBOY", // Nome do serviço
      "choice_auto": false, // Escolha automática, padrão é false
      "pickups": [ // array[] com os ID Convertize dos pontos de retirada
        31
      ],
      "pickup_store": false, // Retirar na loja, vendadeiro ou falso
      "time_format": "d", // Formato do prazo, (d)dias ou (h)horas
      "scheduled_deliveries_times": null //Horários de entregas agendadas
    },
    {
      "price": 0.0, // Preço Promocional
      "original_price": 0.0, // Preço original
      "delivery_time": 2, // Prazo de Entrega
      "original_delivery_time": 2, // Prazo de Entrega original
      "label": "Clique e Retire", // Label, é exibido ao cliente
      "service": "CLICK_RETIRE", // Nome do serviço
      "choice_auto": false, // Escolha automática, padrão é false
      "pickups": [ // array[] com os ID Convertize dos pontos de retirada
        2,
        3,
        4
      ],
      "pickup_store": true, // Retirar na loja, vendadeiro ou falso
      "time_format": "h", // Formato do prazo, (d)dias ou (h)horas
      "scheduled_deliveries_times": null // Horários de entregas agendadas
    }
  ]
}

Simulação na loja