Ir para o conteúdo

Solicitação de Coleta

POST http://dominiotransportadora.com.br/api/v1/coleta/

Disparo de dados para como ordem de coleta.

A Transportadora pode preparar um webservice para receber as solicitações de coleta do Embarcador.

A Frete Rápido irá disparar o conjunto de dados abaixo, através de uma requisição.

This is a alt text.

Envio:

Parâmetros do corpo da requisição:

Nome
Descrição Formato / Exemplo Informado
identificador Identificador fornecido pela transportadora String Opcional
id_frete Identificador único de cada cotação/frete na Frete Rápido. Através deste é possível obter e relacionar todos os outros dados. String de 13 caracteres *
token Token de integração String de 32 caracteres *
token_oferta Identificador da cotação realizada antes do frete ter sido contratado String *
numero_pedido Número do pedido na loja String Opcional
data_pedido Data de criação do pedido na loja Datetime (YYYY-MM-DD HH:mm:ss) Opcional
data_faturamento Data de faturamento do pedido na loja Datetime (YYYY-MM-DD HH:mm:ss) Opcional
forma_pagamento Forma de pagamento do pedido String Opcional
canal Canal utilizado no momento da cotação/simulação String Opcional
obs_cliente Observação(texto livre) do cliente sobre o pedido String Opcional
servico Serviço informado na cotação de frete String *
valor_pedido Valor total do pedido Numérico(float) Opcional
remetente Objeto com dados de endereço do remetente / origem da carga Objeto em json *
 cnpj CNPJ do remetente da carga String de 14 caracteres sem formatação *
 inscricao_estadual Inscrição Estadual do remetente da carga String *
 razao_social Razão Social do remetente da carga String *
 endereco Objeto em json *
  cep CEP do remetente String *
  rua Logradouro do remetente String *
  numero Número do local do remetente String *
  bairro Bairro do remetente String *
  complemento Complemento do endereço (se houver) String Opcional
  cidade Cidade do remetente String *
  estado Estado do remetente (exemplo: SP) String *
destinatario Objeto com dados de endereço do destinatário da carga Objeto em json *
 cnpj_cpf CNPJ ou CPF do destinatário da carga. Você pode validar se é Pessoa Física ou Jurídica pela quantidade de caracteres. String de 11 ou 14 caracteres sem formatação *
 inscricao_estadual Inscrição Estadual do destinatário da carga String Se Pessoa Jurídica
 nome Nome ou Razão Social do destinatário da carga String *
 email E-mail do destinatário da carga String Opcional
 telefone Telefone do destinatário da carga String Opcional
 endereco Objeto em json *
  cep CEP do destinatário String *
  rua Logradouro do destinatário String *
  numero Número do local do destinatário String *
  bairro Bairro do destinatário String *
  complemento Complemento do endereço (se houver) String Opcional
  cidade Cidade do destinatário String *
  estado Estado do destinatário (exemplo: ES) String *
expedidor Objeto com dados de endereço do expedidor da carga (se houver) Objeto em json Se houver expedidor
 cnpj CNPJ do expedidor da carga String de 14 caracteres sem formatação Se houver expedidor
 inscricao_estadual Inscrição Estadual do expedidor da carga String Se houver expedidor
 razao_social Razão Social do expedidor da carga String Se houver expedidor
 endereco Objeto em json Se houver expedidor
  cep CEP do expedidor / retirada da carga String Se houver expedidor
  rua Logradouro do expedidor String Se houver expedidor
  numero Número do local do expedidor String Se houver expedidor
  bairro Bairro do expedidor String Se houver expedidor
  complemento Complemento do endereço (se houver) String Opcional
  cidade Cidade do expedidor String Se houver expedidor
  estado Estado do expedidor (exemplo: MG) String Se houver expedidor
volumes Array com um ou mais objetos dos volumes informados Array em json *
Objeto com as características do volume informado Objeto em json *
 tipo Tipo do volume informado (vide tabela de tipos de volumes) Numérico (inteiro) *
 descricao Descrição do volume concatenada com a descrição do produto informado String Opcional
 sku SKU do produto informado String Opcional
 altura Altura do volume unitário em metros Numérico (float) *
 largura Largura do volume unitário em metros Numérico (float) *
 comprimento Comprimento do volume unitário em metros Numérico (float) *
 quantidade Quantidade de volumes iguais e do mesmo tipo Numérico (inteiro) *
 peso_real Peso total (em Kg) dos volumes informados. Exemplo: 6 volumes com 0.5 Kg cada, o valor informado será de 3 Kg Numérico (float) *
 valor Valor total do conjunto de volumes informados. Exemplo: 6 volumes custando R$20,00 cada, então o valor informado será R$120,00 Numérico (float) *
metadados Array de objetos contendo chave e valor com as informações adicionais da contratação Array de objeto JSON contendo até 64 itens Opcional
 chave Nome do atributo de informação extra da solicitação de coleta, que são informadas pelo embarcador, deve ser nome único para chave String de até 255 caracteres Se houver metadados
 valor Corresponde ao valor do atributo da chave informada. String Se houver metadados
nfe Objeto com as informações da NF-e Objeto em json Opcional
 numero Número da NF String Se houver NF
 serie Série da NF String Se houver NF
 chave_acesso Chave da NF String Se houver NF
 quantidade_volumes Quantidade de Volumes da NF String Condicionalmente
 valor Valor da NF Numérico (float) Se houver NF
 valor_itens Valor dos itens na NF Numérico (float) Condicionalmente
 data_emissao Data de emissão NF DateTime ("YYYY-MM-DD hh:mm:ss") Condicionalmente
data_coleta Data de coleta informada pelo Embarcador Date ("YYYY-MM-DD") Opcional
tipo_cobranca String com o tipo de cobrança do frete CIF ou FOB *
transportadora Objeto com as informações da Transportadora Objeto em json *
 cnpj CNPJ da Transportadora String *
 valor_cotado Valor Cotado String *

* Informados sempre

Exemplo de envio:

    {
        "identificador":"",
        "id_frete": "",
        "token": "",
        "token_oferta":"",
        "numero_pedido": "",
        "data_pedido": "",
        "data_faturamento": "",
        "forma_pagamento": "",
        "canal": "",
        "obs_cliente": "",
        "tipo_cobranca": "",
        "transportadora": {
            "cnpj": "",
            "valor_cotado": ""
        },
        "servico": "",
        "valor_pedido": 123.45,
        "data_coleta": null,
        "remetente": {
            "cnpj": "",
            "inscricao_estadual": "",
            "razao_social": "",
            "endereco": {
                "cep": "",
                "bairro": "",
                "rua": "",
                "numero": "",
                "complemento": "",
                "cidade": "",
                "estado": ""
            }
        },
        "destinatario": {
            "cnpj_cpf": "",
            "inscricao_estadual": "",
            "nome": "",
            "email": "",
            "telefone": "",
            "endereco": {
                "cep": "",
                "bairro": "",
                "rua": "",
                "numero": "",
                "complemento": "",
                "cidade":"",
                "estado":""
            }
        },
        "expedidor": {
            "cnpj": "",
            "inscricao_estadual": "",
            "razao_social": "",
            "endereco": {
                "cep": "",
                "bairro": "",
                "rua": "",
                "numero": "",
                "complemento": "",
                "cidade":"",
                "estado":""
            }
        },
        "volumes": [
            {
                "tipo": 0,
                "sku": "",
                "descricao": "",
                "quantidade": 0,
                "altura": 0.00,
                "largura": 0.00,
                "comprimento": 0.00,
                "peso_real": 0.00,
                "valor": 0.00
            },
            {
                "tipo": 0,
                "sku": "",
                "descricao": "",
                "quantidade": 0,
                "altura": 0.00,
                "largura": 0.00,
                "comprimento": 0.00,
                "peso_real": 0.00,
                "valor": 0.00
            }
        ],
        "metadados": [
            {
                "chave": "",
                "valor": ""
            }
        ],
        "nfe": {
            "numero": "",
            "serie": "",
            "chave_acesso": "",
            "quantidade_volumes": "",
            "valor": 0.00,
            "valor_itens": 0.00,
            "data_emissao": ""
        }
    }
Resposta:

  • Se a requisição obtiver sucesso, deve ser retornado o código de resposta HTTP 200. Senão, pode ser retornado uma mensagem de erro para que possamos investigar.
Voltar ao topo