v1
latestOpenAPI 3.1.02026-07-24290162.6 KBCompra de fretes
Pagamento de envios (Checkout)
post/api/v2/me/shipment/checkout
Headers
Acceptstring required
Content-Typestring required
Authorizationstring required
User-Agentstring required
É obrigatório que seja adicionado o cabeçalho HTTP User-Agent com o nome da sua aplicação junto a um email de contato/suporte.
Request body
Response
200
Example response
{
"purchase": {
"id": "f1261eb6-fa71-4cae-8267-7d332b42da4d",
"protocol": "PUR-20220326201",
"total": 25.35,
"discount": 5.71,
"status": "paid",
"paid_at": "2022-03-29 21:15:53",
"created_at": "2022-03-29 21:15:53",
"updated_at": "2022-03-29 21:15:53",
"transactions": [
{
"id": "8ff6e5b5-92bb-44a6-85f1-576d15c9cb58",
"protocol": "TRN-20220357400",
"value": 25.35,
"type": "debit",
"status": "authorized",
"description": "Pagamento de envios (PUR-20220326201)",
"authorized_at": "2022-03-29 21:15:53",
"created_at": "2022-03-29 21:15:53",
"reason": {
"id": 7,
"label": "Pagamento de envios"
}
}
],
"orders": [
{
"id": "d345836e-061b-490a-b01e-6f7daa2def65",
"protocol": "ORD-20220395511",
"service_id": 3,
"agency_id": 40,
"quote": 25.35,
"price": 25.35,
"discount": 5.71,
"delivery_min": 5,
"delivery_max": 6,
"status": "released",
"insurance_value": 50,
"format": "box",
"billed_weight": 3.5,
"paid_at": "2022-03-29 21:15:53",
"created_at": "2022-03-29 20:24:10",
"updated_at": "2022-03-29 21:15:53",
"from": {
"name": "Teste ME",
"phone": "5598105050",
"email": "melhorenvio@teste.com",
"document": "16571478358",
"company_document": "04517623000197",
"state_register": "563025255115",
"postal_code": "7110000",
"address": "Rua Teste",
"location_number": "100",
"complement": "CASA",
"district": "Bairro Teste",
"city": "Guarulhos",
"state_abbr": "SP",
"country_id": "BR",
"note": "observação"
},
"to": {
"name": "Melhor Envio Teste",
"phone": "1999999999",
"email": "melhorenvio@teste.com",
"document": "73646548010",
"company_document": "89794131000100",
"state_register": "123456",
"postal_code": "26210000",
"address": "Avenida Marechal Floriano Peixoto",
"location_number": "123",
"complement": "Ap 2",
"district": "Centro",
"city": "Nova Iguacu",
"state_abbr": "RJ",
"country_id": "BR",
"note": "observação"
},
"service": {
"id": 3,
"name": ".Package",
"status": "available",
"type": "normal",
"range": "interstate",
"restrictions": "{\"insurance_value\":{\"min\":0,\"max\":29900},\"formats\":{\"box\":{\"weight\":{\"min\":0.001,\"max\":120},\"width\":{\"min\":1,\"max\":105},\"height\":{\"min\":1,\"max\":100},\"length\":{\"min\":1,\"max\":181},\"sum\":386}}}",
"requirements": "[\"names\",\"phones\",\"addresses\",\"documents\",\"invoice\"]",
"optionals": "[\"AR\",\"VD\"]",
"company": {
"id": 2,
"name": "Jadlog",
"status": "available",
"picture": "/images/shipping-companies/jadlog.png"
}
},
"agency": {
"id": 40,
"company_id": 2,
"name": "CO LIMEIRA 01",
"initials": "CO-LMR-01",
"code": "1008530",
"status": "available",
"company_name": "KRONOS CARGO LTDA ME",
"email": "kronos.lmr@jadlog.com.br",
"created_at": "2017-09-11 17:47:14",
"updated_at": "2017-10-19 16:47:33",
"address": {
"id": 40,
"label": "Agência JadLog",
"postal_code": "13485208",
"address": "Rua Jose Malaman 77",
"district": "Jardim Residencial Granja Machado",
"latitude": -22.5501559,
"longitude": -47.3830416,
"created_at": "2017-09-11 17:47:14",
"updated_at": "2017-10-19 16:47:33",
"city": {
"id": 5010,
"city": "Limeira",
"state": {
"id": 25,
"state": "São Paulo",
"state_abbr": "SP",
"country": {
"id": "BR",
"country": "Brazil"
}
}
}
},
"phone": {
"id": 40,
"label": "Agência JadLog",
"phone": "1934433954",
"type": "fixed",
"country_id": "BR",
"created_at": "2017-09-11 17:47:14",
"updated_at": "2017-09-11 17:47:14"
}
},
"invoice": {
"model": "55",
"number": "9248",
"serie": "1",
"key": "31190307586261000184550010000092481404848162",
"issued_at": "2019-03-01 00:00:00"
},
"products": [
{
"name": "Papel adesivo para etiquetas 1",
"quantity": 3,
"unitary_value": 100
}
]
}
]
}
}