v1

latestOpenAPI 3.1.02026-07-2622098.6 KB

Rastrear pedido por NFe

get/api/v1/shipments/track/{nfeKey}

Path parameters

nfeKeystring required

chaveNfestring required

Response

200

codigostring

numero_pedidostring

{"stackTrail":"paths:/api/v1/shipments/track/{nfeKey}:get:responses:200:content:application/json:schema:items:properties:volumes","oasType":"schema","type":"unknown"}

destinatariostring

situacaostring

{"stackTrail":"paths:/api/v1/shipments/track/{nfeKey}:get:responses:200:content:application/json:schema:items:properties:conhecimento","oasType":"schema","type":"unknown"}

fk_clienteinteger

fk_tomador_servicointeger

url_comprovantestring

url_rastreamentostring

servicostring

remetentestring

pagadorstring

{"stackTrail":"paths:/api/v1/shipments/track/{nfeKey}:get:responses:200:content:application/json:schema:items:properties:recebedor","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/api/v1/shipments/track/{nfeKey}:get:responses:200:content:application/json:schema:items:properties:recebedor_documento","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/api/v1/shipments/track/{nfeKey}:get:responses:200:content:application/json:schema:items:properties:recebedor_parentesco","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/api/v1/shipments/track/{nfeKey}:get:responses:200:content:application/json:schema:items:properties:ar_postagem","oasType":"schema","type":"unknown"}

tipo_pedidostring

chavestring

{"stackTrail":"paths:/api/v1/shipments/track/{nfeKey}:get:responses:200:content:application/json:schema:items:properties:arquivo_processado","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/api/v1/shipments/track/{nfeKey}:get:responses:200:content:application/json:schema:items:properties:cte_retorno_error","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/api/v1/shipments/track/{nfeKey}:get:responses:200:content:application/json:schema:items:properties:qtde_tentativas_cte","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/api/v1/shipments/track/{nfeKey}:get:responses:200:content:application/json:schema:items:properties:contrato","oasType":"schema","type":"unknown"}

canal_vendastring

{"stackTrail":"paths:/api/v1/shipments/track/{nfeKey}:get:responses:200:content:application/json:schema:items:properties:canal_distribuicao","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/api/v1/shipments/track/{nfeKey}:get:responses:200:content:application/json:schema:items:properties:periodo_entrega","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/api/v1/shipments/track/{nfeKey}:get:responses:200:content:application/json:schema:items:properties:rota","oasType":"schema","type":"unknown"}

valor_total_fretenumber

{"stackTrail":"paths:/api/v1/shipments/track/{nfeKey}:get:responses:200:content:application/json:schema:items:properties:base_destino","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/api/v1/shipments/track/{nfeKey}:get:responses:200:content:application/json:schema:items:properties:sub_produto","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/api/v1/shipments/track/{nfeKey}:get:responses:200:content:application/json:schema:items:properties:numero_cliente","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/api/v1/shipments/track/{nfeKey}:get:responses:200:content:application/json:schema:items:properties:pedido_3","oasType":"schema","type":"unknown"}

no_prazoboolean

data_previstastring

data_prevista_originalstring

{"stackTrail":"paths:/api/v1/shipments/track/{nfeKey}:get:responses:200:content:application/json:schema:items:properties:data_final","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/api/v1/shipments/track/{nfeKey}:get:responses:200:content:application/json:schema:items:properties:fk_tipo_remessa","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/api/v1/shipments/track/{nfeKey}:get:responses:200:content:application/json:schema:items:properties:fk_remessa_vinculada","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/api/v1/shipments/track/{nfeKey}:get:responses:200:content:application/json:schema:items:properties:fk_destinatario","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/api/v1/shipments/track/{nfeKey}:get:responses:200:content:application/json:schema:items:properties:fk_servico","oasType":"schema","type":"unknown"}

cepstring

{"stackTrail":"paths:/api/v1/shipments/track/{nfeKey}:get:responses:200:content:application/json:schema:items:properties:fk_ultima_ocorrencia","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/api/v1/shipments/track/{nfeKey}:get:responses:200:content:application/json:schema:items:properties:fk_situacao","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/api/v1/shipments/track/{nfeKey}:get:responses:200:content:application/json:schema:items:properties:fk_etiqueta_termica","oasType":"schema","type":"unknown"}

data_clientestring

{"stackTrail":"paths:/api/v1/shipments/track/{nfeKey}:get:responses:200:content:application/json:schema:items:properties:data_coleta","oasType":"schema","type":"unknown"}

data_cadastrostring

{"stackTrail":"paths:/api/v1/shipments/track/{nfeKey}:get:responses:200:content:application/json:schema:items:properties:data_envio_cte","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/api/v1/shipments/track/{nfeKey}:get:responses:200:content:application/json:schema:items:properties:chave_cte_anterior","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/api/v1/shipments/track/{nfeKey}:get:responses:200:content:application/json:schema:items:properties:frete_peso_documento_anterior","oasType":"schema","type":"unknown"}

edicaostring

{"stackTrail":"paths:/api/v1/shipments/track/{nfeKey}:get:responses:200:content:application/json:schema:items:properties:observacao","oasType":"schema","type":"unknown"}

ultima_ocorrenciastring

{"stackTrail":"paths:/api/v1/shipments/track/{nfeKey}:get:responses:200:content:application/json:schema:items:properties:lote_processamento","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/api/v1/shipments/track/{nfeKey}:get:responses:200:content:application/json:schema:items:properties:url_logo","oasType":"schema","type":"unknown"}

qtde_chamadosinteger

qtde_instrucoesinteger

{"stackTrail":"paths:/api/v1/shipments/track/{nfeKey}:get:responses:200:content:application/json:schema:items:properties:data_prevista_rastreamento_externo","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/api/v1/shipments/track/{nfeKey}:get:responses:200:content:application/json:schema:items:properties:romaneio","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/api/v1/shipments/track/{nfeKey}:get:responses:200:content:application/json:schema:items:properties:chave_cte","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/api/v1/shipments/track/{nfeKey}:get:responses:200:content:application/json:schema:items:properties:cte_recibo","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/api/v1/shipments/track/{nfeKey}:get:responses:200:content:application/json:schema:items:properties:cte_retorno","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/api/v1/shipments/track/{nfeKey}:get:responses:200:content:application/json:schema:items:properties:serie_conhecimento","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/api/v1/shipments/track/{nfeKey}:get:responses:200:content:application/json:schema:items:properties:cte_protocolo_autorizacao","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/api/v1/shipments/track/{nfeKey}:get:responses:200:content:application/json:schema:items:properties:data_averbacao","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/api/v1/shipments/track/{nfeKey}:get:responses:200:content:application/json:schema:items:properties:retorno_averbacao","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/api/v1/shipments/track/{nfeKey}:get:responses:200:content:application/json:schema:items:properties:comprovante_entrega_digitalizado","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/api/v1/shipments/track/{nfeKey}:get:responses:200:content:application/json:schema:items:properties:rastreamento_externo_colocar_dados_base","oasType":"schema","type":"unknown"}

empresastring

{"stackTrail":"paths:/api/v1/shipments/track/{nfeKey}:get:responses:200:content:application/json:schema:items:properties:ddd_telefone_1_principal","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/api/v1/shipments/track/{nfeKey}:get:responses:200:content:application/json:schema:items:properties:telefone_1_principal","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/api/v1/shipments/track/{nfeKey}:get:responses:200:content:application/json:schema:items:properties:telefone_2_principal","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/api/v1/shipments/track/{nfeKey}:get:responses:200:content:application/json:schema:items:properties:site_empresa","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/api/v1/shipments/track/{nfeKey}:get:responses:200:content:application/json:schema:items:properties:contato_empresa","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/api/v1/shipments/track/{nfeKey}:get:responses:200:content:application/json:schema:items:properties:email_empresa","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/api/v1/shipments/track/{nfeKey}:get:responses:200:content:application/json:schema:items:properties:fornecedor_ddd_telefone_1","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/api/v1/shipments/track/{nfeKey}:get:responses:200:content:application/json:schema:items:properties:fornecedor_telefone_1","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/api/v1/shipments/track/{nfeKey}:get:responses:200:content:application/json:schema:items:properties:fornecedor_telefone_2","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/api/v1/shipments/track/{nfeKey}:get:responses:200:content:application/json:schema:items:properties:fornecedor_email","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/api/v1/shipments/track/{nfeKey}:get:responses:200:content:application/json:schema:items:properties:codigo_operacao_fiscal","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/api/v1/shipments/track/{nfeKey}:get:responses:200:content:application/json:schema:items:properties:peso_taxado","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/api/v1/shipments/track/{nfeKey}:get:responses:200:content:application/json:schema:items:properties:peso_transportadora","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/api/v1/shipments/track/{nfeKey}:get:responses:200:content:application/json:schema:items:properties:peso_cubado","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/api/v1/shipments/track/{nfeKey}:get:responses:200:content:application/json:schema:items:properties:peso_real","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/api/v1/shipments/track/{nfeKey}:get:responses:200:content:application/json:schema:items:properties:apolice_seguro","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/api/v1/shipments/track/{nfeKey}:get:responses:200:content:application/json:schema:items:properties:numero_plp","oasType":"schema","type":"unknown"}

mostrar_localidade_rastreamentoboolean

abrir_chamado_rastreamentoboolean

tratando_insucessoboolean

cidade_destinostring

estado_destinostring

Example response

[
  {
    "codigo": "123456",
    "numero_pedido": "78910",
    "destinatario": "Cliente Exemplo",
    "situacao": "Entregue",
    "fk_cliente": 101,
    "fk_tomador_servico": 101,
    "url_comprovante": "https://app.logmanager.com.br/tracking/123456",
    "url_rastreamento": "https://app.logmanager.com.br/tracking/123456",
    "servico": "Serviço Exemplo",
    "remetente": "Empresa Exemplo",
    "pagador": "Empresa Exemplo",
    "tipo_pedido": "Entegra",
    "chave": "35180701234567000189550010001234567891234567",
    "canal_venda": "Marketplace Exemplo",
    "valor_total_frete": 120.5,
    "no_prazo": true,
    "data_prevista": "2023-09-30T00:00:00.000000Z",
    "data_prevista_original": "2023-09-30T00:00:00.000000Z",
    "cep": "12345000",
    "data_cliente": "2023-08-01T00:00:00.000000Z",
    "data_cadastro": "2023-08-01T00:00:00.000000Z",
    "edicao": "2023-08-01T00:00:00.000000Z",
    "ultima_ocorrencia": "2023-08-01T00:00:00.000000Z",
    "empresa": "Transportadora Exemplo",
    "cidade_destino": "Cidade Exemplo",
    "estado_destino": "EX"
  }
]