Saltar al contenido principal

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 SolicitudURL Ejemplo
POST{{url_base}}/PostAddSeller
Ejemplohttp://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"PostAddSeller"

Parámetros de Entrada​

ParámetroTipoObligatorioDescripción
SellerNoString(25)SíCódigo externo del vendedor
CorporateNameString(40)SíNombre del vendedor
BusinessNameString(40)SíNombre de fantasía del vendedor
ShortNameString(15)NoNombre reducido del vendedor
AddressAddressInfoSíObjeto que contiene las informaciones de dirección del vendedor
PhoneString(15)NoNúmero de teléfono
EmailString(200)NoCorreo electrónico
FoundationDateDataNoFecha de nacimiento
RegisterDateDataHoraNoFecha de registro
FederalRegisterNoString(14)SíCNPJ (Persona Jurídica) o CPF (Persona Física)
StateRegisterNoString(20)SíInscripción estatal (Persona Jurídica) o RG (Persona Física)
PersonTypePersonTypeSíEnumerador con los posibles valores para Tipo de Persona: ptCompany (Persona Jurídica) o ptPerson (Persona Física)
CommissionFloatNoPorcentaje de comisión del vendedor
InternalCodeNoString(25)NoCódigo de Integración del Vendedor
IsInactiveBooleanNoFlag que indica que el vendedor está inactivo
OverwriteIfExistsBooleanNoFlag que indica que los datos deben ser sobrescritos si el registro ya existe
Nota
  • La obligatoriedad del parámetro Address se 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 FederalRegisterNo debe respetar el tamaño según el tipo de persona especificado en el parámetro PersonType:
    • 14 caracteres cuando PersonType = ptCompany (corresponde al CNPJ)
    • 11 caracteres cuando PersonType = ptPerson (corresponde al CPF)

Retorno​

ParámetroTipoObligatorioDescripción
WebServiceReturnWebServiceReturnSíInformaciones estándar de respuesta del WebService en la ejecución del método
SellerCodeIntegerSí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ódigoMensaje
ASL‑001El parámetro Código Externo de Vendedor (SellerNo) informado ya existe!