Recursos da API (ERP Loja)
Formulários
Criação, consulta e cancelamento de formulários de coleta.
Formulários permitem solicitar dados estruturados durante uma operação ou como uma ordem independente.
Criar formulário
POST /smarttef/commands/erp/form/create{
"order_type": "NRM",
"form_name": "cadastro-cliente",
"extras": {
"CNPJ": "12612554000131"
},
"form": [
{
"field": "Email",
"type": "EMAIL",
"needed": true
}
]
}| Campo | Obrigatório | Descrição |
|---|---|---|
order_type | Não | NRM ou CRD_UNICO. |
form_name | Não | Nome de referência do formulário. |
extras | Não | Dados complementares enviados pelo ERP. |
form[].field | Sim | Nome do campo exibido. |
form[].type | Não | TEXTO, NUMBER, DATA, CPF, CNPJ, CEP ou EMAIL. |
form[].needed | Não | Define se o campo é obrigatório. |
Regras de formulário
| Tema | Regra |
|---|---|
| Direcionamento | Para CRD_UNICO, envie apenas user_id ou apenas serial_pos. |
| Campos obrigatórios | Se algum item do formulário tiver needed: true, o preenchimento obrigatório deve ser considerado no fluxo do POS. |
| Formulário obrigatório | Quando a operação exigir preenchimento obrigatório, informe ao menos um campo com needed: true. |
| Duplicidade | form_name não deve ser reutilizado enquanto houver formulário pendente ou processando para a mesma loja. |
| Conclusão | Campos obrigatórios devem retornar preenchidos como string não vazia. |
Consultar formulário
POST /smarttef/pooling/erp/form/get{
"form_identifier": "01970d18-aac3-7ff4-ba76-78e785409d09"
}Cancelar formulário pendente
POST /smarttef/commands/erp/form/status/cancelar{
"form_identifier": "01970d18-aac3-7ff4-ba76-78e785409d09"
}O cancelamento só se aplica a formulários ainda pendentes. Depois que o preenchimento estiver em processamento, acompanhe o resultado pela consulta.