Pular para o conteúdo principal

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

Parâmetros de Entrada​

ParâmetroTipoObrigatórioDescrição
SellerNoString(25)SimCódigo externo do vendedor
CorporateNameString(40)SimNome do vendedor
BusinessNameString(40)SimNome fantasia do vendedor
ShortNameString(15)NãoNome reduzido do vendedor
AddressAddressInfoSimObjeto que contém as informações do endereço do vendedor
PhoneString(15)NãoNúmero de telefone
EmailString(200)NãoE-mail
FoundationDateDataNãoData de nascimento
RegisterDateDataHoraNãoData de cadastro
FederalRegisterNoString(14)SimCNPJ (Pessoa Jurídica) ou CPF (Pessoa Física)
StateRegisterNoString(20)SimInscriçã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)
CommissionFloatNãoPercentual de comissão do vendedor
InternalCodeNoString(25)NãoCódigo de Integração do Vendedor
IsInactiveBooleanNãoFlag que indica que o vendedor está inativo
OverwriteIfExistsBooleanNãoFlag 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 FederalRegisterNo deve respeitar o tamanho conforme o tipo de pessoa especificado no parâmetro PersonType:
    • 14 caracteres quando PersonType = ptCompany (corresponde ao CNPJ)
    • 11 caracteres quando PersonType = ptPerson (corresponde ao CPF)

Retorno​

ParâmetroTipoObrigatórioDescrição
WebServiceReturnWebServiceReturnSimInformações padrão de resposta do WebService na execução do método
SellerCodeIntegerSimCó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ódigoMensagem
ASL‑001Parâmetro Código Externo do Vendedor (SellerNo) informado já existe!