DOCUMENTAÇÃO API REMOTA DE FRETE
5 min
Criado por Willian Borges em 13/10/2021 09:25
Atualizado por Willian Borges em 17/03/2022 17:53
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", // Shipping zipcode
"amount": "190.00000", // cart amount
"items": [{ // array[] of cart items
"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, // SKU reference_code, like ERP id
"id": 2, // Convertize SKU id
"quantity": 1 // Order Quantity
},{
"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", // SKU reference_code, like ERP id
"id": 1, // Convertize SKU id
"quantity": 1 // Order Quantity
}]
}
|
| |
Response Body:
|
{
"services": [ //[] array of shipping available services
{
"price": 5.90, // price with promotions
"original_price": 5.90, // real price
"delivery_time": 4, // delivery time with handler time
"original_delivery_time": 4, // real delivery time
"label": "Motoboy - Grátis - Até 1 dia útil", // Label
"service": "MOTOBOY", // Service Name
"pickups": [ // array[] with Convertize pickups store IDs
31
],
"scheduled_deliveries_times": null // not documented but have
},
{
"price": 0.0, // price with promotions
"original_price": 0.0, // real price
"delivery_time": 2, // delivery time with handler time
"original_delivery_time": 2, // real delivery time
"label": "Clique e Retire - Grátis - Até 2h", // Label
"service": "CLICK_RETIRE", // Service Name
"pickups": [ // array[] with Convertize pickups store IDs
2,
3,
4,
],
"scheduled_deliveries_times": null // not documented but have
}
]
}
|
