API de Solicitação de Logística Reversa - Descrição dos Atributos

De SGPWEB
Edição feita às 14h02min de 26 de setembro de 2019 por Desenvolvimento01 (disc | contribs)

Ir para: navegação, pesquisa
   "codigo_administrativo": Código Administrativo do cliente | Numérico(8) | (Obrigatório)
   "codigo_servico": Código do serviço fornecido pelos Correios, conforme definido em contrato | Numérico(5) | (Obrigatório)
   "cartao": Número do cartão de postagem do cliente que será usado para a cobrança das taxas do serviço realizado. Será utilizado para faturamento de todos os pedidos | Numérico(10) | (Obrigatório)
   "destinatario": Object
       "destinatario.nome": Nome do Cliente ou Razão Social | Caractere(60) | (Obrigatório)
       "destinatario.logradouro": Logradouro do cliente | Caractere(72) | (Obrigatório)
       "destinatario.numero": Número do endereço do cliente. Caso não possua preencher com "S/N" | Caractere(8) | (Obrigatório)
       "destinatario.complemento": Complemento do endereço do cliente | Caractere(30) | (Opcional)
       "destinatario.bairro": Bairro | Caractere(50) | (Opcional)
       "destinatario.referencia": Uma referência do local de entrega | Caractere(60) | (Opcional)
       "destinatario.cidade": Cidade | Caractere(36) | (Obrigatório)
       "destinatario.uf": Sigla do Estado | Caractere(2) | (Obrigatório)
       "destinatario.cep": CEP de destino | Caractere(8) | (Obrigatório)
       "destinatario.ddd": Código de área do telefone | Caractere(3) | (Opcional)
       "destinatario.telefone": Telefone do cliente | Caractere(12) | (Opcional)
       "destinatario.email": Este campo não é obrigatório, mas é importante para que o cliente receba informações sobre seus pedidos | Caractere(72) | (Opcional)
   "coleta_solicitada": Object
       "coleta_solicitada.tipo": Indica se a solicitação é de coleta domiciliária ou uma autorização de postagem | Caractere(2) | (Obrigatório)
           * A = Autorização de Postagem;
           * CA = Coleta domiciliar. Caso não exista coleta domiciliar na localidade, o sistema dos Correios transforma automaticamente o pedido em 
                  uma autorização de postagem;
           * C = Coleta domiciliária. Caso não exista a coleta no local indicado (CEP), o sistema dos Correios não processa a solicitação.
       "coleta_solicitada.numero": Número da Autorização de Postagem (e-ticket). Deve ser deixado em branco quando o cliente não possui range de e-ticket. Caso o cliente possua uma reserva de faixa numérica (range) de e-ticket, informar o código do e-ticket do range com o digito verificador Numérico(15) | (Opcional)
       "coleta_solicitada.id_cliente": Campo chave que identifica cada solicitação do cliente. Poderá ser informado por exemplo o número da NF, OS, etc, desde que não se repita em mais de uma solicitação | Caractere(30) | (Opcional)
       "coleta_solicitada.ag": Preencher com a data da coleta ou com a quantidade de dias de validade da autorização de postagem | 
           * Coleta domiciliar: Informar a data para agendamento da coleta. Se informada a data de agendamento da coleta, o pedido fica retido no 
                                sistema e a primeira tentativa de coleta só poderá ser realizada na data solicitada. Se não for informada a data, o 
                                sistema assume a data do 1º dia útil após o processamento. O sistema aceita apenas datas com mais de cinco dias 
                                corridos a partir da data de processamento do pedido | Data DD/MM/YYYY | (Opcional);
           * Autorização de Postagem: Indica a quantidade de dias de validade da autorização. A validade deve ser de no mínimo 1 e no máximo 90 dias 
                                      corridos. Se não for informada, a validade da autorização será de 10 (dez) dias corridos a partir da data do 
                                      processamento do pedido | Numérico(2) Entre 1 e 90 dias.
       "coleta_solicitada.cartao": Número do cartão de postagem para ser usado no faturamento dos serviço utilizados. Caso seja informado, o conteúdo do atributo <cartao> do cabeçalho será ignorado | Numérico(10) | (Opcional)
       "coleta_solicitada.valor_declarado": Valor declarado dos objetos da coleta. Exemplo: 1020.70 | Numérico(9.2) | (Opcional)
       "coleta_solicitada.servico_adicional": Caso a encomenda a ser postada possua formato não maquinável, ou seja, diferente do formato quadrado ou retangular, informar o código: 007 - “OF” Outros Formatos | Caractere(20) | (Opcional)
       "coleta_solicitada.descricao": Descrição / instruções para coleta | Caractere(255) | (Opcional)
       "coleta_solicitada.ar": Indica se é para solicitar Aviso de Recebimento para as encomendas cadastradas. Disponível apenas para pedidos de Autorização de Postagem.
           * O valores permitidos são:
               0 - Não solicita Aviso de Recebimento;
               1 - Solicita Aviso de Recebimento.
       "coleta_solicitada.cklist": Indica que serão impressas vias de checklist | Valor fixo | (Opcional)
       "coleta_solicitada.documentos": Obrigatório informar se o tipo do check list for documento | Lista de códigos. Será fornecido pela ECT | (Opcional)
       "coleta_solicitada.remetente": Object
           "coleta_solicitada.remetente.identificacao": Número do CNPJ ou CPF do remetente | Caractere(14) | (Opcional)
           "coleta_solicitada.remetente.nome": Nome do remetente | Caractere(60) | (Obrigatório)
           "coleta_solicitada.remetente.logradouro": Logradouro do remetente | Caractere(72) | (Obrigatório)
           "coleta_solicitada.remetente.numero": Número do endereço do remetente. Caso não possua, preencher com "S/N" | Caractere(8) | (Obrigatório)
           "coleta_solicitada.remetente.complemento": Complemento do endereço | Caractere(30) | (Opcional)
           "coleta_solicitada.remetente.bairro": Bairro do remetente | Caractere(80) | (Opcional)
           "coleta_solicitada.remetente.cidade": Cidade do remetente | Caractere(40) | (Obrigatório)
           "coleta_solicitada.remetente.uf": UF do remetente | Caractere(2) | (Obrigatório)
           "coleta_solicitada.remetente.cep": CEP do remetente | Caractere(8)  | (Obrigatório)
           "coleta_solicitada.remetente.referencia": Uma referência do endereço do remetente | Caractere(60) | (Opcional)
           "coleta_solicitada.remetente.ddd": Código do DDD do remetente | Caractere(2) | (Obrigatório)
           "coleta_solicitada.remetente.telefone": Número do telefone do remetente. Este campo é obrigatório. É importante para que os Correios entre em contato com o remetente em casos de insucesso na coleta | Caractere(18) | (Obrigatório)
           "coleta_solicitada.remetente.email": E-mail do remetente. O remetente receberá informação da coleta ou orientações para a postagem | Caractere(72) | (Obrigatório)
           "coleta_solicitada.remetente.celular": Número do telefone celular do remetente | Caractere(9) | (Opcional)
           "coleta_solicitada.remetente.ddd_celular": Código do DDD do celular do remetente | Caractere(2) | (Opcional)
           "coleta_solicitada.remetente.sms": Caso deseja receber SMS dos status do objeto. Preencher com 1 para Sim ou 0 para Não. Caso seja preenchido com 1, o remetente receberá um SMS com informações do e-ticket ou das etapas da coleta | Booleano | (Opcional)
       "coleta_solicitada.embalagens": Contém os blocos de tags que são utilizadas para solicitação de produtos junto com a coleta. O contrato do cliente deve ser habilitado previamente para usar essa tag | Array | (Opcional)
           "coleta_solicitada.embalagens[index].codigo": Código do produto/embalagem. Fornecido pelos Correios | Numérico (9)
           "coleta_solicitada.embalagens[index].tipo": Código do tipo de produto. Fornecido pelos Correios | Numérico (1)
           "coleta_solicitada.embalagens[index].qtd": Quantidade de produtos do tipo fornecido. Permitido no máximo 10 embalagens por solicitação | Numérico(2) Só aceita número de 1 a 10 | 
           
       "coleta_solicitada.objetos_coleta": Array
           "coleta_solicitada.objetos_coleta.desc": Descrição do objeto que será coletado, para controle do cliente. Obs: O conteúdo preenchido neste campo ficará disponível para consulta no detalhamento do pedido do sistema e também será impresso no certificado de postagem da coleta | Caractere(255) | (Opcional)
           "coleta_solicitada.objetos_coleta.entrega": Número do objeto para os pedidos de coleta simultânea. O contrato deve aceitar pedidos de coleta simultânea | Caractere(13) | (Opcional)
           "coleta_solicitada.objetos_coleta.num": Número do objeto quando existe uma faixa numérica reservada para o cliente. Esta opção ainda não é utilizada | Caractere(13) | (Opcional)
           "coleta_solicitada.objetos_coleta.id": Campo para livre utilização pelo cliente. Exemplo: Número da nota fiscal | Obs:O conteúdo preenchido neste campo será impresso no rótulo e serve apenas para controle das solicitações pelo cliente. Por exemplo, pode ser preenchido com o código de uma ordem de serviço, o número de um protocolo de atendimento feito pelo call center ou o número da nota fiscal | Caractere(30) | (Opcional)