Grupo de Cliente

---

Cadastro de Grupo de Cliente

O endpoint PostAddCustomerGroup é responsável pelo cadastro de um novo Grupo de Cliente no sistema MIMS. Esse cadastro pode ser visualizado na tela CAD028.

---

Como cadastrar um grupo de cliente

Request HTTP Post

Tipo da Requisição	URL Exemplo
POST	{{url_base}}/PostAddCustomerGroup
Exemplo	http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"PostAddCustomerGroup"

Parâmetros de Entrada

Parâmetro	Tipo	Obrigatório	Descrição
CustomerGroupNo	String(25)	Sim	Código externo do grupo de cliente
Name	String(40)	Sim	Descrição do grupo de cliente
OverwriteIfExists	Boolean	Não	Flag que indica que os dados devem ser sobrescritos caso o registro já exista

---

Retorno

Parâmetro	Tipo	Obrigatório	Descrição
WebServiceReturn	WebServiceReturn	Sim	Informações padrão de resposta do WebService na execução do método
CustomerGroupCode	Integer	Sim	Código interno do Grupo de Cliente gerado no sistema MIMS

---

Exemplo de Request

curl --location 'http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"PostAddCustomerGroup"' \
--header 'Content-Type: application/json' \
--data '{
    "CustomerGroupNo": "CG001",
    "Name": "Clientes Varejo",
    "OverwriteIfExists": true
}'

---

Exemplo de Response

{
    "WebServiceReturn": {
        "Status": "wrsSuccess",
        "ErrorCode": "",
        "Message": "",
        "Actor": "",
        "ReturnQuestion": null
    },
    "CustomerGroupCode": 4
}

---

🐞 Possíveis Erros

Código	Mensagem
ACG‑001	Parâmetro Código Externo do Grupo de Cliente (CustomerGroupNo) informado já existe!

Exclusão de Grupo de Cliente

O endpoint PostDeleteCustomerGroup é responsável por executar a exclusão de um Grupo de Cliente no sistema MIMS.

---

Como excluir um grupo de cliente

Request HTTP Post

Tipo da Requisição	URL Exemplo
POST	{{url_base}}/PostDeleteCustomerGroup
Exemplo	http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"PostDeleteCustomerGroup"

Parâmetros de Entrada

Parâmetro	Tipo	Obrigatório	Descrição
CustomerGroupNo	String(25)	Sim	Código externo do grupo de cliente
ErrorIfNotFound	Boolean	Não	Retorna erro caso o grupo de cliente informado não exista no banco de dados

---

Retorno

Parâmetro	Tipo	Obrigatório	Descrição
WebServiceReturn	WebServiceReturn	Sim	Informações padrão de resposta do WebService na execução do método

---

Exemplo de Request

curl --location 'http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"PostDeleteCustomerGroup"' \
--header 'Content-Type: application/json' \
--data '{
    "CustomerGroupNo": "CG001",
    "ErrorIfNotFound": false
}'

---

Exemplo de Response

{
    "WebServiceReturn": {
        "Status": "wrsSuccess",
        "ErrorCode": "",
        "Message": "",
        "Actor": "",
        "ReturnQuestion": null
    }
}

---

🐞 Possíveis Erros

Código	Mensagem
DCG‑001	O grupo de cliente informado pertence a um cliente, portanto não pode ser deletado!
DCG‑002	Parâmetro Código Externo do Grupo de Cliente (CustomerGroupNo) informado não foi encontrado!

---