PDV (v1)

Erros comuns e instruções para tratá-los nas rotas PDV v1

Sistema de bonificação inativo

Quando, qualquer rota, retornar:

Response

{
  "status": "false",
  "message": "Sistema de bonificação Inativo. Contate o suporte do CRM Bônus.",
  "data": {
    "msg": "Erro"
  }
}

Não se trata de um 5xx, mas sim do status desta loja na CRMBonus.

Instrução

Entre em contato com o nosso Suporte e informe que gostaria de conferir o status desta loja para continuar com o seu desenvolvimento.

---

POST /api_inicio

• Referência da rota: /pages/api_inicio

Código	Mensagem	Descrição	Instrução
403	"O usuário está bloqueado pela marca!"	Indica que o usuário está em blocklist	Este usuário foi bloqueado pela marca. Não é possível bonificá-lo
200	"CPF do Cliente Inválido"	Indica que o CPF informado na requisição não é válido	Certifique-se que o CPF do usuário atende o formato 00000000000
200	"Cód. Loja Inválido"	Indica que o valor informado no parâmetro cod_loja é inválido	Certifique-se que o parâmetro está preenchido e com o ID da loja (int)
200	"Nome do Cliente Inválido"	Indica que o valor informado no parâmetro customer_name é inválido	Certifique-se que o parâmetro está preenchido e com uma string
200	"Celular do Cliente Inválido"	Indica que o valor informado no parâmetro customer_cel é inválido	Certifique-se que o parâmetro está preenchido e com uma string
200	"E-mail do Cliente Inválido"	Indica que o valor informado no parâmetro customer_email é inválido	Certifique-se que o parâmetro está preenchido e com uma string
200	"CPF do Cliente Inválido"	Indica que o valor informado no parâmetro customer_cpf é inválido	Certifique-se que o parâmetro está preenchido e com uma string

POST /api_validar_pin

• Referência da rota: /pages/api_validar_pin

Código	Mensagem	Descrição	Instrução
200	"Cliente Inválido"	Indica que o usuário não é válido	Certifique-se que o parâmetro está preenchido e com o ID do usuário (int)
200	"Loja Inválida"	Indica que o ID da Loja é inválido	Certifique-se que o parâmetro está preenchido e com o ID da loja (int)
200	"PIN Inválido"	Indica que o parâmetro na requisição está incorreto.	Certifique-se que o parâmetro está preenchido e com o PIN (string). Importante: Não significa que o PIN está incorreto, mas que o parâmetro na requisição está incorreto.

POST /pages/api_reenviar_pin

• Referência da rota: /pages/api_reenviar_pin

Código	Mensagem	Descrição	Instrução
200	"Loja Inválida"	Indica que o ID da Loja é inválido	Certifique-se que o parâmetro está preenchido e com o ID da loja (int)
200	"Cliente Inválido"	Indica que o usuário não é válido	Certifique-se que o parâmetro está preenchido e com o ID do usuário (int)

POST /api_bonus_disponivel

• Referência da rota: /pages/api_bonus_disponivel

Código	Mensagem	Descrição	Instrução
200	"Cliente em Conflito. Reveja os parametros de entrada ou o header."	Indica conflito de informações de Loja	Certifique-se que o codintegracao (header) pertence a loja_id informada no body.
200	"Celular 55 {número} nao encontrado na base. Favor repetir o processo."	Indica número de telefone do consumidor não encontrado	Certifique-se que o celular do consumidor esteja em base64 e que o valor encodado cumpra o formato DDD+número. Esta mensagem de erro é exibida sempre que o número de telefone encodado acompanha DDI.
200	"Total Bruto Inválido."	Indica parâmetro informado incorretamente	Certifique-se que o parâmetro valor_bruto foi informado na requisição.

POST /api_finaliza_compra

• Referência da rota: /api_finaliza_compra

Código	Mensagem	Descrição	Instrução
200	"Campanha em Conflito. Reveja os parametros de entrada."	Indica conflito de informações de Loja	Certifique-se que o id informado no parâmetro campanha_id pertence a loja_id informada no body.
200	"Restrição de Horario inválido."	Indica valor inválido ou parâmetro ausente	Certifique-se que o booleano restricao_horario foi informado no body da requisição
200	"Bonus utilizado maior do que o saldo. Reveja os parametros de entrada."	Indica valor acima do permitido	Certifique-se que o valor informado no parâmetro bonus_resgatado seja =< ao saldo_bonus da /api_bonus_disponivel
200	"Valores divergentes: verifique os parâmetros 'valor_bruto', 'total_card' e 'total_partner'."	Indica valores divergentes	A soma dos valores dos parâmetros total_card e total_partner não pode ser maior que o valor_bruto. Exemplo: valor_bruto: 3 → total_card: 2 → total_partner: 1 = sucesso ✅ valor_bruto: 3 → total_card: 2 → total_partner: 2 = falha ❌

POST /api_vendas_totais

• Referência da rota: /api_vendas_totais

Código	Mensagem	Descrição	Instrução
200	"Venda Duplicada."	Indica que esta venda já foi registrada	Certifique-se que o valor informado no parâmetro nr_pedido seja único e nunca antes utilizado.
200	"Informar Venda Liquida"	Informa ausência de parâmetro	Certifique-se que o parâmetro total_venda_liquida é informado no body
200	"Informar o Nome da Vendedor"	Informa ausência de parâmetro	Certifique-se que o parâmetro nome_vendedor é informado no body

POST /api_cancelar_bonus

• Referência da rota: /api_cancelar_bonus

Código	Mensagem	Descrição	Instrução
200	"Bonus não encontrado"	Indica bônus ID não encontrado	Certifique-se o valor informado em bonus_id está correto
200	"O bonus não pertence a loja informada."	Indica conflito de informações	Certifique-se que o valor informado em bonus_id pertence à loja_id correta
200	"O Bonus não está apto para ser cancelado."	Indica impossibilidade de cancelamento	Verifique se o bônus está dentro do período válido para utilização (não vencido e fora do período mínimo de cancelamento).