Ir para o conteúdo

Consulta de Conhecimento de Transporte

GET https://freterapido.com/api/external/embarcador/v2/quote/cte/? start_date=[data_inicio]&end_date=[data_fim]&page=[pagina]&status[status]&token=[seu_token]

Método que permite consultar os componentes de um conhecimento de transporte vinculado à uma nota fiscal, dentro de um período e status especificado.

OBS: Considere a utlização de Webhooks disponíveis para uma melhor experiência de obtenção dos dados do CTE.

Serão retornado os dados disponíveis sobre o conhecimento de transporte paginado. Basta informar o token de integração, intervalo desejado de início e fim, a página, e o status do CT-e conforme a estrutura abaixo.

Envio:

Parâmetros da URL:

Nome Descrição Formato / Exemplo Obrigatório
token Token de integração String de 32 caracteres *
start_date Data inicial do período Datetime (YYYY-MM-DD hh:mm) *
end_date Data final do período Datetime (YYYY-MM-DD hh:mm) *
page Página desejada na consulta, caso não informe, por padrão será retornado a primeira página Inteiro Opcional
status Status do CT-e vinculado ao módulo de auditoria de frete (0 - "em processamento", 1 - "com divergência", 2 - "em negociação", 3 - "pre liberado", 4 - "liberado", 5 - "rejeitado") Inteiro Opcional
* Dados obrigatórios

Resposta:

  • Se a requisição obtiver sucesso, será retornado o código de resposta HTTP 200, juntamente com um array dos dados do conhecimento de transporte consultado naquele período escolhido.
Nome Descrição Formato / Exemplo Obrigatório
next_page Próxima página, null se não houver mais registros Inteiro *
current_page Página atual Inteiro *
data Array com os dados do CT-e paginado Array *
 access_key Chave de acesso do CT-e String de 44 caracteres *
 serie Série do CT-e String Númerica Opcional
 number Número do CT-e String Númerica Opcional
 value Valor total do frete (CT-e) String Númerica Opcional
 freight_value Valor total do frete String Númerica Opcional
 gross_weight Peso bruto da mercadoria String Númerica Opcional
 cubed_weight Peso cubado aferido String Númerica Opcional
 operation_type Código do tipo de operação String Opcional
 created_at Data e hora que recebemos o CT-e DateTime ("YYYY-MM-DD hh:mm:ss") *
 issue_date Data e hora de emissão do Conhecimento pela transportadora DateTime ("YYYY-MM-DD hh:mm:ss") Opcional
 consignee_register_number CNPJ do consignatário String de 14 caracteres Opcional
 issuer_register_number CNPJ do emissor do Conhecimento String de 14 caracteres Opcional
 invoice_issuer_register_number CNPJ do emissor da Nota Fiscal String de 14 caracteres Opcional
 taxed_weight Peso considerado no cálculo String Númerica Opcional
 type Tipo de frete String (C or F) Opcional
 basis_calculation_icms Base ICMS utilizado String Númerica Opcional
 percentage_icms Alíquota ICMS String Númerica Opcional
 value_icms ICMS calculado String Númerica Opcional
 quantity_volumes Quantidade de volumes Inteiro Opcional
 freight_value_volume_weight Valor frete peso String Númerica Opcional
 collection_value Valor da taxa de coleta String Númerica Opcional
 reshipment_value Valor da taxa de despacho String Númerica Opcional
 additional_value Outras taxas extras String Númerica Opcional
 difal_rate_origin Alíquota DIFAL de origem String Númerica Opcional
 difal_rate_destination Alíquota DIFAL de origem String Númerica Opcional
 difal_icms_origin Percentual DIFAL origem String Númerica Opcional
 difal_icms_destination Percentual DIFAL destino String Númerica Opcional
 advalorem Ad Valorem String Númerica Opcional
 ademe Valor da taxa de ADEME String Númerica Opcional
 sec_cat Valor taxa SEC/CAT String Númerica Opcional
 itr Valor taxa ITR String Númerica Opcional
 trt Valor do TRT String Númerica Opcional
 tas Valor do TAS String Númerica Opcional
 suframa Valor da taxa de SUFRAMA String Númerica Opcional
 value_iss Valor da taxa de ISS String Númerica Opcional
 basis_calculation_iss Base de cálculo do ISS String Númerica Opcional
 percentage_iss Percentual do ISS String Númerica Opcional
 gris Valor do GRIS String Númerica Opcional
 income_tax Imposto renda String Númerica Opcional
 cubage Cubagem da mercadoria String Númerica Opcional
 tax_substitution Se tem ou não substituição tributária Inteiro Opcional
 cfop Código de CFOP Inteiro Opcional
 transport_type Código do tipo de transporte String (vide códigos anexos) Opcional
 processing Data e hora do processamento do EDI na Transportadora DateTime ("YYYY-MM-DD hh:mm:ss") Opcional
 protocol Número do Protocolo do CT-e na SEFAZ String Opcional
 status Informa se o CT-e está pendente, aprovado ou rejeitado no módulo de auditoria. Caso o CT-e não esteja presente no módulo retornará como NULL. String *
 order_number Número do pedido na loja String Opcional
 freight_id Identificador do frete contratado na Frete Rápido. String de 13 caracteres *
 invoices Array com um ou mais objetos de NF-e anexados ao frete Array Opcional
  access_key Chave de acesso da nota fiscal String numérica Opcional
  number Número da nota fiscal String numérica Opcional
  serie Número de serie da nota fiscal String Opcional
 file_type Tipo do arquivo (XML, TXT) String Opcional
 action Evento referente a operação de transporte ( 'I' , 'A' , 'E' ) String Opcional
 hire_id ID da Contratação Inteiro Opcional
 tracking_code Código de rastreio String Opcional
 shipping_cost_invoice Valor do custo de envio na Nota Fiscal String numérica Opcional
 total_invoice_value Valor total nota fiscal String numérica Opcional
 toll_value Valor taxa de pedágio String numérica Opcional
 clearance_value Valor taxa de despacho String numérica Opcional
 consignee_corporate_name Nome do consignatário String Opcional
 hired_carrier_corporate_name Nome da transportadora contratada String Opcional
 hired_carrier_register_number CNPJ da transportadora contratada String Opcional
 hired_shipper_corporate_name Nome do Embarcador que realizou a contratação String Opcional
 hired_shipper_register_number CNPJ do Embarcador que realizou a contratação String Opcional
 issuer_corporate_name Nome do emissor do Conhecimento String Opcional
 status_log Histórico geral do CT-e JSON Opcional
 webhook_sent_at Data e hora do disparo do Webhook DateTime ("YYYY-MM-DD hh:mm:ss") Opcional
 webhook_response Código de resposta do Webhook (200,400,500) String Opcional
 code Código de negociação do CT-e via e-mail String Opcional

*Dados Obrigatórios

Exemplo: 

{
    "current_page": 1,
    "next_page": null,
    "data": [
        {
            "file_type": "",
            "status": "",
            "number": "",
            "serie": "",
            "access_key": "",
            "action": "",
            "issue_date": "",
            "hire_id": 1,
            "tracking_code": "",
            "transport_type": "",
            "type": "",
            "value": "",
            "freight_value": "",
            "shipping_cost_invoice": "",
            "total_invoice_value": "",
            "basis_calculation_icms": "",
            "percentage_icms": "",
            "value_icms": "",
            "difal_icms_origin": "",
            "difal_icms_destination": null,
            "difal_rate_origin": null,
            "difal_rate_destination": null,
            "basis_calculation_iss": null,
            "percentage_iss": null,
            "value_iss": null,
            "advalorem": null,
            "freight_value_volume_weight": null,
            "gross_weight": null,
            "cubage": null,
            "cubed_weight": null,
            "tax_substitution": null,
            "taxed_weight": null,
            "tas": null,
            "toll_value": null,
            "itr": null,
            "reshipment_value": null,
            "additional_value": null,
            "ademe": null,
            "sec_cat": null,
            "clearance_value": null,
            "collection_value": null,
            "gris": null,
            "income_tax": null,
            "suframa": null,
            "trt": null,
            "cfop": null,
            "new_cte_id": null,
            "quantity_volumes": null,
            "consignee_corporate_name": null,
            "consignee_register_number": null,
            "hired_carrier_corporate_name": null,
            "hired_carrier_register_number": null,
            "hired_shipper_corporate_name": null,
            "hired_shipper_register_number": null,
            "invoice_access_key": null,
            "invoice_issuer_register_number": null,
            "invoice_number": null,
            "invoice_serie": null,
            "issuer_corporate_name": null,
            "issuer_register_number": null,
            "operation_type": null,
            "processing": null,
            "protocol": null,
            "status_log": null,
            "webhook_sent_at": "",
            "webhook_response": "",
            "code": null,
            "created_at": "",
            "order_number": null,
            "freight_id": "",
            "invoices": [
                {
                    "access_key": "",
                    "number": "",
                    "serie": ""
                }
            ]
        }
    ]
}
Voltar ao topo