Vendedores
El endpoint PostAddSeller es responsable de registrar un nuevo vendedor en el sistema MIMS y puede ser visualizado en la pantalla CAD054.
Cómo registrar un vendedor
HTTP POST Request
| Tipo de Solicitud | URL Ejemplo |
|---|---|
| POST | {{url_base}}/PostAddSeller |
| Ejemplo | http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"PostAddSeller" |
Parámetros de Entrada
| Parámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| SellerNo | String(25) | Sí | Código externo del vendedor |
| CorporateName | String(40) | Sí | Nombre del vendedor |
| BusinessName | String(40) | Sí | Nombre de fantasía del vendedor |
| ShortName | String(15) | No | Nombre reducido del vendedor |
| Address | AddressInfo | Sí | Objeto que contiene las informaciones de dirección del vendedor |
| Phone | String(15) | No | Número de teléfono |
| String(200) | No | Correo electrónico | |
| FoundationDate | Data | No | Fecha de nacimiento |
| RegisterDate | DataHora | No | Fecha de registro |
| FederalRegisterNo | String(14) | Sí | CNPJ (Persona Jurídica) o CPF (Persona Física) |
| StateRegisterNo | String(20) | Sí | Inscripción estatal (Persona Jurídica) o RG (Persona Física) |
| PersonType | PersonType | Sí | Enumerador con los posibles valores para Tipo de Persona: ptCompany (Persona Jurídica) o ptPerson (Persona Física) |
| Commission | Float | No | Porcentaje de comisión del vendedor |
| InternalCodeNo | String(25) | No | Código de Integración del Vendedor |
| IsInactive | Boolean | No | Flag que indica que el vendedor está inactivo |
| OverwriteIfExists | Boolean | No | Flag que indica que los datos deben ser sobrescritos si el registro ya existe |
Nota
- La obligatoriedad del parámetro
Addressse define por configuración. Por defecto, este parámetro es obligatorio. Para cambiar este comportamiento, consulte al consultor responsable. - El valor proporcionado en el parámetro
FederalRegisterNodebe respetar el tamaño según el tipo de persona especificado en el parámetroPersonType:- 14 caracteres cuando
PersonType = ptCompany(corresponde al CNPJ) - 11 caracteres cuando
PersonType = ptPerson(corresponde al CPF)
- 14 caracteres cuando
Retorno
| Parámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| WebServiceReturn | WebServiceReturn | Sí | Informaciones estándar de respuesta del WebService en la ejecución del método |
| SellerCode | Integer | Sí | Código interno del vendedor generado en el sistema MIMS |
Ejemplo de Request
curl --location 'http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"PostAddSeller"' \
--header 'Content-Type: application/json' \
--data '{
"SellerNo": "VND12345",
"CorporateName": "Vendedor Ejemplo LTDA",
"BusinessName": "Vendedor Ejemplo",
"ShortName": "VendEx",
"Address": {
"AddressType": "Calle",
"Address": "Calle Ejemplo",
"Number": "100",
"District": "Centro",
"ZIPCode": "01000000",
"City": "Ciudad Ejemplo",
"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
}'
Ejemplo de Response
{
"WebServiceReturn": {
"Status": "wrsSuccess",
"ErrorCode": "",
"Message": "",
"Actor": "",
"ReturnQuestion": null
},
"SellerCode": 789
}
🐞 Posibles Errores
| Código | Mensaje |
|---|---|
| ASL‑001 | El parámetro Código Externo de Vendedor (SellerNo) informado ya existe! |