Pular para o conteúdo principal

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çãoURL Exemplo
POST{{url_base}}/GetSellerInfo
Exemplohttp://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"GetSellerInfo"

Parâmetros de Entrada​

ParâmetroTipoObrigatórioDescrição
SellerNoString(25)NãoCódigo externo do vendedor
UserPhoneString(16)NãoTelefone do usuário para identificação do vendedor
UserCellPhoneString(16)NãoCelular do usuário para identificação do vendedor
Observação
  • Ao menos um dos parâmetros deve ser informado: SellerNo, UserPhone ou UserCellPhone

Retorno​

ParâmetroTipoObrigatórioDescrição
WebServiceReturnWebServiceReturnSimInformações padrão de resposta do WebService na execução do método
SellerGetSellerInfoDataSimObjeto contendo as informações do vendedor

📝 Objeto GetSellerInfoData​

O objeto GetSellerInfoData representa as informações do vendedor.

Parâmetros de Retorno​

ParâmetroTipoObrigatórioDescrição
SellerCodeIntegerSimCódigo interno do vendedor
SellerNoString(25)SimCódigo externo do vendedor
BranchNoString(25)SimCódigo externo da filial
CorporateNameString(40)SimNome do vendedor
BusinessNameString(40)SimNome fantasia do vendedor
ShortNameString(15)NãoNome reduzido do vendedor
PhoneString(15)NãoNúmero de telefone
EmailString(200)NãoE-mail
CellPhoneString(15)NãoNúmero de celular
FoundationDateDataNãoData de nascimento
RegisterDateDataHoraNãoData de cadastro
AddressAddressInfoNãoObjeto que contém as informações do endereço do vendedor
FederalRegisterNoString(14)NãoCNPJ (Pessoa Jurídica) ou CPF (Pessoa Física)
StateRegisterNoString(20)NãoInscrição estadual (Pessoa Jurídica) ou RG (Pessoa Física)
PersonTypePersonTypeSimEnumerador com os possíveis valores para o Tipo de pessoa: ptCompany (Pessoa Jurídica) ou ptPerson (Pessoa Física)
IsInactiveBooleanSimFlag que indica que o vendedor está inativo
CommissionFloatNãoPercentual de comissão do vendedor
InternalCodeNoString(25)NãoCódigo de integração do vendedor
SupervisorCodeIntegerNãoCódigo interno do supervisor
SupervisorNameString(40)NãoNome 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ódigoMensagem
GSL‑001Parâmetro Código Externo do Vendedor (SellerNo) informado não existe!