Vendedores
O endpoint PostAddSeller é responsável pelo cadastro de um novo vendedor no sistema MIMS e pode ser visualizado na tela CAD054.
Como cadastrar um vendedor
Request HTTP Post
| Tipo da Requisição | URL Exemplo |
|---|---|
| POST | {{url_base}}/PostAddSeller |
| Exemplo | http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"PostAddSeller" |
Parâmetros de Entrada
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| SellerNo | String(25) | Sim | Código externo do vendedor |
| CorporateName | String(40) | Sim | Nome do vendedor |
| BusinessName | String(40) | Sim | Nome fantasia do vendedor |
| ShortName | String(15) | Não | Nome reduzido do vendedor |
| Address | AddressInfo | Sim | Objeto que contém as informações do endereço do vendedor |
| Phone | String(15) | Não | Número de telefone |
| String(200) | Não | ||
| FoundationDate | Data | Não | Data de nascimento |
| RegisterDate | DataHora | Não | Data de cadastro |
| FederalRegisterNo | String(14) | Sim | CNPJ (Pessoa Jurídica) ou CPF (Pessoa Física) |
| StateRegisterNo | String(20) | Sim | Inscrição estadual (Pessoa Jurídica) ou RG (Pessoa Física) |
| PersonType | PersonType | Sim | Enumerador com os possíveis valores para o Tipo de pessoa: ptCompany (Pessoa Jurídica) ou ptPerson (Pessoa Física) |
| Commission | Float | Não | Percentual de comissão do vendedor |
| InternalCodeNo | String(25) | Não | Código de Integração do Vendedor |
| IsInactive | Boolean | Não | Flag que indica que o vendedor está inativo |
| OverwriteIfExists | Boolean | Não | Flag que indica que os dados devem ser sobrescritos caso o registro já exista |
Observação
- A obrigatoriedade do parâmetro
Addressé definida por configuração. Por padrão, esse parâmetro é obrigatório. Para alterar esse comportamento, consulte o consultor responsável. - O valor informado no parâmetro
FederalRegisterNodeve respeitar o tamanho conforme o tipo de pessoa especificado no parâmetroPersonType:- 14 caracteres quando
PersonType = ptCompany(corresponde ao CNPJ) - 11 caracteres quando
PersonType = ptPerson(corresponde ao CPF)
- 14 caracteres quando
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 |
| SellerCode | Integer | Sim | Código interno do vendedor gerado no sistema MIMS |
Exemplo de Request
curl --location 'http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"PostAddSeller"' \
--header 'Content-Type: application/json' \
--data '{
"SellerNo": "VND12345",
"CorporateName": "Vendedor Exemplo LTDA",
"BusinessName": "Vendedor Exemplo",
"ShortName": "VendEx",
"Address": {
"AddressType": "Rua",
"Address": "Rua Exemplo",
"Number": "100",
"District": "Centro",
"ZIPCode": "01000000",
"City": "Cidade Exemplo",
"State": "São Paulo",
"StateInitials": "SP",
"Country": "Brasil"
},
"Phone": "11999990000",
"Email": "vendedor@example.com",
"FoundationDate": "2022-01-01",
"RegisterDate": "2022-01-15T14:30:00",
"FederalRegisterNo": "12345678000190",
"StateRegisterNo": "123456789",
"PersonType": "ptCompany",
"Commission": 5.5,
"InternalCodeNo": "INT123",
"IsInactive": false,
"OverwriteIfExists": true
}'
Exemplo de Response
{
"WebServiceReturn": {
"Status": "wrsSuccess",
"ErrorCode": "",
"Message": "",
"Actor": "",
"ReturnQuestion": null
},
"SellerCode": 789
}
🐞 Possíveis Erros
| Código | Mensagem |
|---|---|
| ASL‑001 | Parâmetro Código Externo do Vendedor (SellerNo) informado já existe! |