Informações do Vendedor
O endpoint GetSellerInfo retorna as informações de um vendedor no sistema MIMS.
Como consultar informações de um vendedor
Request HTTP POST
| Tipo da Requisição | URL Exemplo |
|---|---|
| POST | {{url_base}}/GetSellerInfo |
| Exemplo | http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"GetSellerInfo" |
Parâmetros de Entrada
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| SellerNo | String(25) | Não | Código externo do vendedor |
| UserPhone | String(16) | Não | Telefone do usuário para identificação do vendedor |
| UserCellPhone | String(16) | Não | Celular do usuário para identificação do vendedor |
Observação
- Ao menos um dos parâmetros deve ser informado:
SellerNo,UserPhoneouUserCellPhone
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 |
| Seller | GetSellerInfoData | Sim | Objeto contendo as informações do vendedor |
📝 Objeto GetSellerInfoData
O objeto GetSellerInfoData representa as informações do vendedor.
Parâmetros de Retorno
Parâmetro Tipo Obrigatório Descrição SellerCode Integer Sim Código interno do vendedor SellerNo String(25) Sim Código externo do vendedor BranchNo String(25) Sim Código externo da filial CorporateName String(40) Sim Nome do vendedor BusinessName String(40) Sim Nome fantasia do vendedor ShortName String(15) Não Nome reduzido do vendedor Phone String(15) Não Número de telefone String(200) Não CellPhone String(15) Não Número de celular FoundationDate Data Não Data de nascimento RegisterDate DataHora Não Data de cadastro Address AddressInfo Não Objeto que contém as informações do endereço do vendedor FederalRegisterNo String(14) Não CNPJ (Pessoa Jurídica) ou CPF (Pessoa Física) StateRegisterNo String(20) Não 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) ouptPerson(Pessoa Física)IsInactive Boolean Sim Flag que indica que o vendedor está inativo Commission Float Não Percentual de comissão do vendedor InternalCodeNo String(25) Não Código de integração do vendedor SupervisorCode Integer Não Código interno do supervisor SupervisorName String(40) Não Nome do supervisor
Exemplo de Request
curl --location 'http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"GetSellerInfo"' \
--header 'Content-Type: application/json' \
--data '{
"SellerNo": "VND12345"
}'
Exemplo de Response
{
"WebServiceReturn": {
"Status": "wrsSuccess",
"ErrorCode": "",
"Message": "",
"Actor": "",
"ReturnQuestion": null
},
"Seller": {
"SellerCode": 789,
"SellerNo": "VND12345",
"BranchNo": "FIL001",
"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",
"CellPhone": "11988880000",
"FoundationDate": "2022-01-01",
"RegisterDate": "2022-01-15T14:30:00",
"FederalRegisterNo": "12345678000190",
"StateRegisterNo": "123456789",
"PersonType": "ptCompany",
"IsInactive": false,
"Commission": 5.5,
"InternalCodeNo": "INT123",
"SupervisorCode": 456,
"SupervisorName": "Supervisor Exemplo"
}
}
🐞 Possíveis Erros
| Código | Mensagem |
|---|---|
| GSL‑001 | Parâmetro Código Externo do Vendedor (SellerNo) informado não existe! |