Ir para o conteúdo

Consulta de Subembarcadores

GET https://freterapido.com/api/external/embarcador/v1/sub-shippers?token=[seu_token]&page=[numero_da_pagina]

Serão retornados os dados cadastrais dos subembarcadores.

Envio:

Parâmetros da URL:

Nome Descrição Formato / Exemplo Obrigatório
token Token de integração String *
page Número da página a ser consultada Número(inteiro) Opcional

*Obrigatório

Resposta:

  • Se a requisição obtiver sucesso, será retornado o código de resposta HTTP 200, juntamente com os dados do frete consultado.
Nome
 Descrição Formato / Exemplo Retornado
total Número total de resultados de subembarcadores encontrados. Número Inteiro Sempre
per_page Número total de resultados por página. Número(inteiro) Sempre
last_page Quantidade de páginas encontradas. Número(inteiro) Sempre
current_page Número da página apresentada. Número(inteiro) Sempre
data Array de objetos contendo dados cadastrais do subembarcador Array de objetos JSON Sempre
 id_conta ID de cadastro da Frete Rápido Número(inteiro) Sempre
 cnpj CNPJ do Subembarcador Numérico(inteiro) Sempre
 razão_social Razão Social do Subembarcador String Sempre
 nome_fantasia Nome Fantasia do Subembarcador String Sempre
 endereco Objeto com os dados de endereço do Subembarcador Objeto em json Sempre
  cep CEP do Subembarcador String com formatação Sempre
  rua Logradouro do Subembarcador String Sempre
  numero Número do local do Subembarcador String Sempre
  bairro Bairro do Subembarcador String Sempre
  complemento Complemento do endereço (se houver) String Eventual
  cidade Cidade do Subembarcador String Sempre
  estado Estado do Subembarcador String Sempre

Exemplo: 

    {
    "total": 0,
    "per_page": 20,
    "last_page": 1,
    "current_page": 1,
    "data": [
        {
            "id_conta": 0000,
            "cnpj": 00000000000000,
            "razao_social": "",
            "nome_fantasia": "",
            "endereco": {
                "cep": "00006660",
                "rua": "",
                "numero": "000",
                "bairro": "",
                "complemento": "",
                "cidade": "",
                "estado": ""
            }
        }
    ]
}

Erro:

Voltar ao topo