Manual de integração via WebService Manda Bem


1. Pré - Requisitos

Para consumir o webservice do Manda Bem o usuário deve possuir credenciais de acesso, que combinadas vão permitir o acesso aos métodos da Plataforma: As credenciais serão fornecidas pela Plataforma Manda Bem.

2. Métodos

2.1. Consulta aos valores de Frete

Descrição:
Método responsável obtenção dos valores de Frete na Plataforma Manda Bem

Método de HTTP:
POST

Endpoint:
https://mandabem.com.br/ws/valor_envio

Parametros:
  1. plataforma_id (ID de conexão enviada pelo Manda Bem)
  2. plataforma_chave (Chave de conexão enviada pelo Manda Bem)
  3. cep_origem (8 caracteres, apenas números)
  4. cep_destino (8 caracteres, apenas números)
  5. valor_seguro (Opcional, formato 0.00)
  6. servico (Tipo de serviço PAC, SEDEX ou PACMINI)
  7. peso (formato em kg)
  8. altura (formato em cm)
  9. largura (formato em cm)
  10. comprimento (formato em cm)
EX: var=abc&var=abc&var...

* Observação: Os parâmetros aceitos para PACMINI são:
• Peso máximo: 300g.
• Dimensões mínimas: 1cm (A) x 11cm (L) x 16cm (C).
• Dimensões máximas: 4cm (A) x 16cm (L) x 24cm (C).

2.2. Geração do Envio

Descrição:
Método responsável pela geração do envio na plataforma Manda Bem

Método de HTTP:
POST

Endpoint:
https://mandabem.com.br/ws/gerar_envio

Parametros:
  1. plataforma_id (ID de conexão enviada pelo Manda Bem)
  2. plataforma_chave (Chave de conexão enviada pelo Manda Bem)
  3. forma_envio (PAC, SEDEX ou PACMINI)
  4. destinatario (Nome do Destinatário, máx 40 caracters)
  5. cep (Somente números, 8 caracters)
  6. logradouro (Logradouro do endereço, máx 60 caracters)
  7. numero (Número do endereço, máx 6 caracters)
  8. complemento (Opcional, Complemento do endereço, máx 30 caracters)
  9. cidade (Cidade do endereço, máx 40 caracters)
  10. bairro (Bairro do endereço, máx 60 caracters)
  11. estado (UF do estado, 2 caracters)
  12. peso (Peso em Kilos)
  13. altura (formato em cm)
  14. largura (formato em cm)
  15. comprimento (formato em cm)
  16. cpf_destinatario (Opcional, Apenas números, 11 caracters)
  17. valor_seguro (Opcional, formato 0.00)
  18. ref_id (Opcional, número de refencia da loja)
  19. integration (Refere-se ao nome da integração que será associada ao envio, máx 20 caracteres)
  20. email (Opcional, email do destinatário)
  21. cep_origem (Opcional, caso não informado será usado o CEP de cadastro da loja)
  22. chave_nf (Opcional, chave da Nota Fiscal Eletrônica, 44 dígitos)
  23. produtos (nome,quantidade,preco )
    (Opcional, Lista de Produtos a serem adicionados à Declaração de Conteúdo .)
    Exemplo:
    produtos[0] = [
    'nome' => 'Produto teste 1',
    'quantidade' => 2,
    'preco' => 20.00
    ]
    produtos[1] = [
    'nome' => 'Produto teste 2',
    'quantidade' => 3,
    'preco' => 60.00
    ]

Retorno:
{
"resultado": {
"sucesso": "true",
"mensagem": "Envio numero 123456 gerado com sucesso",
"envio_id": 123456
}
}

3. Busca de informações do envio (Postagem)

Descrição:
Método responsável pela busca de informações da postagem, incluindo o código de rastreio e o status da postagem.

Método de HTTP:
POST

Endpoint:
https://mandabem.com.br/ws/envio

Parametros:
  1. plataforma_id (ID de conexão enviada pelo Manda Bem)
  2. plataforma_chave (Chave de conexão enviada pelo Manda Bem)
  3. id (ID do envio gerado anteriormente, Opcional quando "ref_id" for informado)
  4. ref_id (ID de referência do pedido informado na geração do envio, Opcional quando "id" for informado)
  5. etiqueta_correios (Etiqueta gerada. Padrão AA123456789BR (Apenas Correios) Opcional quando "id" ou "ref_id" for informado)

Retorno {
"resultado": {
"sucesso": "true",
"dados": {
"envio_id": "123456",
"etiqueta": "OK000000000BR",
"status": "Objeto postado",
"destinatario": "Maria Silva",
"logradouro": "Rua Das Flores",
"numero": "100",
"complemento": "casa",
"bairro": "Centro",
"cep": "12345678",
"cidade": "São Paulo",
"estado": "SP"
}
}
}

4. Retorno de Dados

A resposta sempre será retornada no formato JSON. Existem 3 casos possíveis de retorno de dados.

5. Tratamento de Erros

Os erros abaixo são os mais comuns e são bem simples de tratá-los.
#Id Erro Tratamento
1 "plataforma_id ou plataforma_chave não especificados." Você não enviou os parâmetros de plataforma_id ou da plataforma_chave. Envie os parâmetro e seus valores.
2 "plataforma_id ou plataforma_chave incorretas."; Suas credenciais não batem com as registradas para você em nosso sistema. Verifique suas credenciais.
3 "tipoTransacao não definido."; Você não enviou o parâmetro do tipoTransacao com valor “consultaValorFrete”. Envie o parâmetro
4 "erro": "Cep de destino/envio: XXXXXX inválido" Verifique os Ceps enviados.
5 Outros tipo de erro Verifique a mensagem. Podem ser erros de formatação de parâmetros ou de indisponibilidade de envio em Sedex ou Pac.