Opções / Métodos de Entrega
GET https://freterapido.com/api/external/embarcador/v1/shipping-options?token=[seu_token]
Permite consultar todas as opções de entrega disponíveis de um embarcador, basta informar o token de integração.
Envio:
Parâmetros da URL:
| Nome | Descrição | Formato / Exemplo | Obrigatório |
|---|---|---|---|
| token | Token de integração | String de 32 caracteres | * |
| *Obrigatório |
Resposta:
- Se a requisição obtiver sucesso, será retornado o código de resposta HTTP 200, juntamente com um array contendo as opções de entrega disponíveis.
| Nome | Descrição | Formato / Exemplo | Retornado |
|---|---|---|---|
| cnpj | CNPJ da transportadora | String numérica de 14 caracteres | Sempre |
| razao_social | Razão social da transportadora | String | Eventualmente |
| nome_fantasia | Nome fantasia da transportadora | String | Eventualmente |
| inscricao_estadual | Inscrição estadual da transportadora | String | Eventualmente |
| registro_antt | Registro da ANTT da transportadora | String | Eventualmente |
| opcoes_entrega | Lista de opções de entrega em operação | Array | Eventualmente |
| hash | Identificador único do método de entrega | String | Eventualmente |
| cnpj_ponto_coleta | CNPJ do ponto de coleta / expedidor | String numérica de 14 caracteres | Eventualmente |
| versao | Versão da tabela de importação | String | Eventualmente |
| tipo | Tipo da carga: 1 = Fracionada; 2 = Lotação | Inteiro | Eventualmente |
| tipo_destinatario | Tipo do destinatário: 1 = Pessoa Física; 2 = Pessoa jurídica; 3 = Ambos | Inteiro | Eventualmente |
| validade_oferta | Prazo de validade das ofertas, em dias | Inteiro | Eventualmente |
| validade | Data de expiração do método de evio | Data / Hora: YYYY-MM-DD hh:mm:ss | Eventualmente |
| pais | País de abrangência | String | Eventualmente |
| servico | Descrição do serviço de entrega | String | Sempre |
| codigo_servico | Código do serviço de entrega | String | Eventualmente |
| cep_origem | CEP de origem das mercadorias | String numérica | Eventualmente |
| reversa | Indica se a transportadora atua com operação reversa | Booleano | Eventualmente |
| observacao | Observação livre acerca do método de envio | String | Eventualmente |
| tipos_carga | Array com os tipos de carga aceitos para transporte | Array | Eventualmente |
| codigo | Código do tipo de carga | Inteiro | Sempre |
| tipo_carga | Descrição do tipo de carga | String | Sempre |
Exemplo de resposta:
[
{
"cnpj": "",
"razao_social": "",
"nome_fantasia": "",
"inscricao_estadual": "",
"registro_antt": "",
"opcoes_entrega": [
{
"hash": "",
"cnpj_ponto_coleta": "",
"versao": "",
"tipo":0,
"tipo_destinatario": 0,
"validade_oferta": 0,
"validade": "",
"pais": "",
"codigo_servico": null,
"descricao_servico": "",
"cep_origem": "",
"reversa": false,
"observacao": "",
"tipos_carga": [
{
"codigo": 0,
"tipo_carga": ""
},
{
"codigo": 0,
"tipo_carga": ""
},
{
"codigo": 0,
"tipo_carga": ""
},
{
"codigo": 0,
"tipo_carga": ""
},
{
"codigo": 0,
"tipo_carga": ""
},
{
"codigo": 0,
"tipo_carga": ""
}
]
},
{
"hash": "",
"cnpj_ponto_coleta": "",
"versao": "",
"tipo": 0,
"tipo_destinatario": 0,
"validade_oferta": 0,
"validade": "",
"pais": "",
"codigo_servico": null,
"descricao_servico": "",
"cep_origem": "",
"reversa": false,
"observacao": "",
"tipos_carga": [
{
"codigo": 0,
"tipo_carga": ""
},
{
"codigo": 0,
"tipo_carga": ""
},
{
"codigo": 0,
"tipo_carga": ""
},
{
"codigo": 0,
"tipo_carga": ""
}
]
}
]
},
{
"cnpj": "",
"razao_social": "",
"nome_fantasia": "",
"inscricao_estadual": "",
"registro_antt": "",
"opcoes_entrega": [
{
"hash": "",
"cnpj_ponto_coleta": "",
"versao": "",
"tipo": 0,
"tipo_destinatario": 0,
"validade_oferta": 0,
"validade": "",
"pais": "",
"codigo_servico": "",
"descricao_servico": "",
"cep_origem": "",
"reversa": false,
"observacao": "",
"tipos_carga": [
{
"codigo": 0,
"tipo_carga": ""
},
{
"codigo": 0,
"tipo_carga": ""
},
{
"codigo": 0,
"tipo_carga": ""
},
{
"codigo": 0,
"tipo_carga": ""
},
{
"codigo": 0,
"tipo_carga": ""
},
{
"codigo": 0,
"tipo_carga": ""
}
]
},
{
"hash": "",
"cnpj_ponto_coleta": "",
"versao": "",
"tipo": 0,
"tipo_destinatario": 0,
"validade_oferta": 0,
"validade": "",
"pais": "",
"codigo_servico": "",
"descricao_servico": "",
"cep_origem": "",
"reversa": false,
"observacao": "",
"tipos_carga": [
{
"codigo": 0,
"tipo_carga": ""
},
{
"codigo": 0,
"tipo_carga": ""
},
{
"codigo": 0,
"tipo_carga": ""
},
{
"codigo": 0,
"tipo_carga": ""
},
{
"codigo": 0,
"tipo_carga": ""
}
]
},
{
"hash": "",
"cnpj_ponto_coleta": "",
"versao": "",
"tipo": 0,
"tipo_destinatario": 0,
"validade_oferta": 0,
"validade": "",
"pais": "",
"codigo_servico": "",
"descricao_servico": "",
"cep_origem": "",
"reversa": false,
"observacao": "",
"tipos_carga": [
{
"codigo": 0,
"tipo_carga": ""
},
{
"codigo": 0,
"tipo_carga": ""
},
{
"codigo": 0,
"tipo_carga": ""
},
{
"codigo": 0,
"tipo_carga": ""
}
]
}
]
},
{
"cnpj": "",
"razao_social": "",
"nome_fantasia": "",
"inscricao_estadual": "",
"registro_antt": "",
"opcoes_entrega": [
{
"hash": "",
"cnpj_ponto_coleta": "",
"versao": "",
"tipo": 0,
"tipo_destinatario": 0,
"validade_oferta": 0,
"validade": "",
"pais": "",
"codigo_servico": null,
"descricao_servico": "",
"cep_origem": "",
"reversa": false,
"observacao": "",
"tipos_carga": [
{
"codigo": 0,
"tipo_carga": ""
},
{
"codigo": 0,
"tipo_carga": ""
}
]
},
{
"hash": "",
"cnpj_ponto_coleta": "",
"versao": "",
"tipo": 0,
"tipo_destinatario": 0,
"validade_oferta": 0,
"validade": "",
"pais": "",
"codigo_servico": null,
"descricao_servico": "",
"cep_origem": "",
"reversa": false,
"observacao": "",
"tipos_carga": [
{
"codigo": 0,
"tipo_carga": ""
},
{
"codigo": 0,
"tipo_carga": ""
}
]
}
]
}
]
Erro:
- Em caso de erro, será retornado o código estabelecido na lista de códigos desta API.