Pular para o conteúdo principal

Minuta de Despacho Eletrônica

Modelo na Plataforma

Sigla: MIN DESP

Descrição: Minuta de Despacho Eletrônica

Modelo Via API

Type: 30

Este modelo extrai informações-chave de um Minuta de Despacho Eletrônica (MIN DESP).

O processo de extração é assíncrono e consiste em dois passos principais:

  1. Enviar o documento para a fila de processamento.
  2. Consultar o resultado após a conclusão do processamento.

Passo 1: Enviar o Documento para Processamento​

Para iniciar a extração, envie uma requisição POST para o endpoint abaixo.

POST URL Ambiente/documents/upload

Headers​

IdentificadorValor
Content-Typemultipart/form-data
IDEXA-API-KEYsua_api_key

Payload (Corpo da Requisição)​

A requisição deve conter os seguintes parâmetros obrigatórios:

ParâmetroDescriçaoTipo
filesO arquivo do documento a ser processado.File
typeCódigo interno do modelo. Use 30 para MINUTA.Integer

Os parâmetros a seguir são opcionais:

ParâmetroDescriçaoTipo
pagesDefine páginas específicas para análise (ex: "1,2,5-10").String
externalIdId externo para seu controle (não pode repetir).String

Exemplos de Requisição​

curl -X POST "URL_BASE/documents/upload" \
-H "IDEXA-API-KEY: sua_api_key" \
-H "Content-Type: multipart/form-data" \
-F "files=@/path/to/seu/documento.pdf" \
-F "type=30" \
-F "externalId=pedido-cliente-123"

Resposta Imediata (Status 200)​

A resposta confirma o recebimento. Guarde o id para consultar o resultado no próximo passo.

{
"id": "95893394-337c-429c-a63e-1b8210de47d2",
"externalId": "pedido-cliente-123",
"type": 30,
"status": 0,
"statusDesc": "RECEIVED",
"createdAt": "2026-01-07T14:38:50.045Z",
"updatedAt": "2026-01-07T14:38:50.045Z"
}
Processamento Assíncrono

A extração de dados pode levar alguns segundos. Por isso, a API funciona de forma assíncrona. Após enviar o documento, aguarde um momento e então use o id retornado para consultar o resultado final. Para ser notificado automaticamente, considere utilizar nossos Webhooks.

Passo 2: Consultar o Resultado​

Use o id do documento para fazer uma requisição GET e buscar o resultado completo da extração.

GET URL Ambiente/documents/[id]

Resposta Final (Status 200)​

Quando o status for 1 (FINISHED), o objeto data conterá os campos extraídos.

Exemplo de Resposta Completa
{
"id": "95893394-337c-429c-a63e-1b8210de47d2",
"externalId": "pedido-cliente-123",
"type": 30,
"data": {
"freight": {
"taker": "FULANO DA SILVA",
"id_number": "xx.xxx.xxx/xxxx-xx",
"gollog_number": "00000000000"
},
"description": {
"payment": "CARTÃO",
"service": "URGENTE",
"origin_airport": "BSB",
"pick_up_airport": "BSB",
"tipe_of_delivery": "RETIRADA"
},
"product_data": {
"receipt": "xxxxx-xxxx",
"volume_n": "xx",
"main_product": "PRODUTO",
"total_weight": "xx",
"dangerous_product": "SIM"
},
"senders_data": {
"city": "Uberaba",
"email": "xxxxxxx@xxxx.xx",
"sender": "FULANO DA SILVA",
"address": "Rua A",
"id_number": "xxx.xxx.xxx-xx",
"phone_number": "(xx)xxxxxxxxx"
},
"internal_data": {
"issued_by": "FULANO DA SILVA",
"air_waybill": "xxxxxxxxxxx",
"receipt_date": "xx/xx/xxxx"
},
"insurance_data": {
"policy_n": "xxxxxxxxxxx",
"insurance_type": "PROPRIO",
"insurance_company": "XXX SECURITY"
},
"receivers_data": {
"city": "Uberaba",
"address": "Rua A",
"receiver": "FULANO DA SILVA",
"id_number": "xxx.xxx.xxx-xx"
},
"authorization_data": {
"place_date": "xx/xx/xxxx",
"accountable": "FULANO DA SILVA",
"boarding_authorization": "SIM"
}
},
"processTime": 8.123,
"status": 1,
"statusDesc": "FINISHED",
"createdAt": "2026-01-07T14:38:50.045Z",
"updatedAt": "2026-01-07T14:38:58.168Z"
}

Dicionário de Dados: Minuta de Despacho Eletrônica​

Estes são os campos retornados dentro do objeto data.

CampoTipoDescriçãoExemplo
freight.takerStringtaker"FULANO DA SILVA"
freight.idNumberStringid_number"xx.xxx.xxx/xxxx-xx"
freight.gollogNumberStringgollog_number"00000000000"
description.paymentStringpayment"CARTÃO"
description.serviceStringservice"URGENTE"
description.originAirportStringorigin_airport"BSB"
description.pickUpAirportStringpick_up_airport"BSB"
description.tipeOfDeliveryStringtipe_of_delivery"RETIRADA"
productData.receiptStringreceipt"xxxxx-xxxx"
productData.volumeNStringvolume_n"xx"
productData.mainProductStringmain_product"PRODUTO"
productData.totalWeightStringtotal_weight"xx"
productData.dangerousProductStringdangerous_product"SIM"
sendersData.cityStringcity"Uberaba"
sendersData.emailStringemail"xxxxxxx@xxxx.xx"
sendersData.senderStringsender"FULANO DA SILVA"
sendersData.addressStringaddress"Rua A"
sendersData.idNumberStringid_number"xxx.xxx.xxx-xx"
sendersData.phoneNumberStringphone_number"(xx)xxxxxxxxx"
internalData.issuedByStringissued_by"FULANO DA SILVA"
internalData.airWaybillStringair_waybill"xxxxxxxxxxx"
internalData.receiptDateStringreceipt_date"xx/xx/xxxx"
insuranceData.policyNStringpolicy_n"xxxxxxxxxxx"
insuranceData.insuranceTypeStringinsurance_type"PROPRIO"
insuranceData.insuranceCompanyStringinsurance_company"XXX SECURITY"
receiversData.cityStringcity"Uberaba"
receiversData.addressStringaddress"Rua A"
receiversData.receiverStringreceiver"FULANO DA SILVA"
receiversData.idNumberStringid_number"xxx.xxx.xxx-xx"
authorizationData.placeDateStringplace_date"xx/xx/xxxx"
authorizationData.accountableStringaccountable"FULANO DA SILVA"
authorizationData.boardingAuthorizationStringboarding_authorization"SIM"