Ir para o conteúdo

Logística Reversa Correios

POST https://freterapido.com/api/external/embarcador/v1/correios/reversa

Método que permite gerar Logística Reversa dos Correios.

Com essa API será gerado um código de postagem reversa com os Correios, com base na origem e destino informados através de uma requisição.

Observações:

  • Considerar que a entidade remetente é o consumidor que deseja retornar o produto à você.
  • Considerar que a entidade destinatário é a unidade em que objeto deverá retornar.

Envio:

Parâmetros do corpo da requisição:

Nome Descrição Formato / Exemplo Obrigatório
token Token de integração String *
servico Serviço de Logística Reversa que deseja gerar a postagem.
Exemplo: 04677 para PAC ou 04170 para SEDEX		 String *
quantidade_itens Quantidade de itens solicitados na reversa têm que ser entre 1 e 10 quantidades Inteiro Opcional
notificar_remetente Se deseja notificar o remente na reversa Boolean Opcional
coleta_domiciliaria Se a reversa será com coleta domiciliária ou não Boolean Opcional
data_coleta_domiciliaria Se for informado a coleta domiciliária, informar a data Datetime (YYYY-MM-DD) Se houver coleta domiciliaria
prazo_postagem Prazo de postagem tem que ser maior que 4 e menor que 60 dias Inteiro Opcional
referencia Referência da solicitação (Exemplo: número do pedido, ID Frete Rápido, etc...). Não pode-se repetir, até 30 caracteres. String *
remetente Objeto com dados do remetente/origem da reversa Objeto em json *
 email Endereço de e-mail do remetente da reversa String *
 referencia Referência do logradouro String Opcional
 cpf_cnpj CPF ou CNPJ do remetente da reversa String Numérica de 14 caracteres sem formatação *
 nome Nome do remetente do objeto String *
 cep CEP do remetente String Numérica de 8 caracteres sem formatação *
 logradouro Logradouro do remetente String *
 numero Número de endereço do remetente String *
 cidade Cidade de origem da reversa String *
 bairro Bairro do remetente String *
 complemento Complemento do endereço (se houver) String Opcional
 uf UF do estado de origem String *
destinatario Objeto com dados do recebedor/destino da reversa Objeto em json *
 email Endereço de e-mail do destinatário da reversa String *
 referencia Referência do logradouro String Opcional
 nome Nome do destinatário do objeto String *
 cep CEP do destinatário String Numérica de 8 caracteres sem formatação *
 logradouro Logradouro do destinatário da reversa String *
 numero Número de endereço do destinatário String *
 cidade Cidade de destino da reversa String *
 bairro Bairro do destinatário String *
 complemento Complemento do destinatário (se houver) String Opcional
 uf UF do estado de destino String *

* Obrigatório

Exemplo de requisição:

        {
            "token": "",
            "servico": "",
            "referencia": "",
            "quantidade_itens":0,
            "notificar_remetente":false,
            "aviso_recebimento": false,
            "coleta_domiciliaria": false,
            "data_coleta_domiciliaria": "",
            "prazo_postagem":0, 
            "remetente": {
                "nome": "",
                "logradouro": "",
                "numero": "",
                "complemento": "",
                "referencia": "",
                "cidade": "",
                "bairro": "",
                "uf": "",
                "cep": "",
                "email": "",
                "cpf_cnpj": ""
            },
            "destinatario": {
                "nome": "",
                "logradouro": "",
                "numero": "",
                "complemento": "",
                "referencia": "",
                "cidade": "",
                "uf": "",
                "cep": "",
                "bairro": "",
                "email": ""
            }
        }
Resposta:

  • Se a requisição obtiver sucesso, será retornado o código de resposta HTTP 200, juntamente com os dados da tabela abaixo:
Nome Descrição Formato / Exemplo Retornado
tipo Tipo da solicitação (retorno dos Correios) String Sempre
numero_coleta Número da coleta (retorno dos Correios) String Sempre
quantidade_itens Quantidade de itens solicitados na reversa Inteiro Sempre
referencia Referência do pedido passado na solicitação String Sempre
prazo Data limite para postagem da Logística Reversa nos Correios (retorno dos Correios) String Sempre
data_solicitacao Data da solicitação da Logística Reversa nos Correios (retorno dos Correios) String Sempre
hora_solicitacao Hora da solicitação da Logística Reversa nos Correios (retorno dos Correios) String Sempre

Exemplo de resposta:

   {
      "tipo": "",
      "numero_coleta": "",
      "quantidade_itens": 1,
      "referencia": "",
      "prazo": "0000-00-00 00:00:00",
      "data_solicitacao": "",
      "hora_solicitacao": ""
    }
Voltar ao topo