Seller Information

The GetSellerInfo endpoint returns seller information in the MIMS system.

---

How to query seller information

HTTP POST Request

Request Type	Example URL
POST	{{url_base}}/GetSellerInfo
Example	http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"GetSellerInfo"

Input Parameters

Parameter	Type	Required	Description
SellerNo	String(25)	No	External code of the seller
UserPhone	String(16)	No	User phone for seller identification
UserCellPhone	String(16)	No	User cell phone for seller identification

Note

• At least one of the parameters must be provided: SellerNo, UserPhone or UserCellPhone

---

Return

Parameter	Type	Required	Description
WebServiceReturn	WebServiceReturn	Yes	Standard WebService response information in method execution
Seller	GetSellerInfoData	Yes	Object containing seller information

📝 GetSellerInfoData Object

The GetSellerInfoData object represents seller information.

Return Parameters

Parameter	Type	Required	Description
SellerCode	Integer	Yes	Internal seller code
SellerNo	String(25)	Yes	External seller code
BranchNo	String(25)	Yes	External branch code
CorporateName	String(40)	Yes	Seller name
BusinessName	String(40)	Yes	Trade name of the seller
ShortName	String(15)	No	Short name of the seller
Phone	String(15)	No	Phone number
Email	String(200)	No	Email
CellPhone	String(15)	No	Cell phone number
FoundationDate	Data	No	Birth date
RegisterDate	DataHora	No	Registration date
Address	AddressInfo	No	Object containing the seller address information
FederalRegisterNo	String(14)	No	CNPJ (Legal Entity) or CPF (Individual)
StateRegisterNo	String(20)	No	State registration (Legal Entity) or ID (Individual)
PersonType	PersonType	Yes	Enumerator with possible values for Person Type: ptCompany (Legal Entity) or ptPerson (Individual)
IsInactive	Boolean	Yes	Flag indicating that the seller is inactive
Commission	Float	No	Seller commission percentage
InternalCodeNo	String(25)	No	Seller integration code
SupervisorCode	Integer	No	Internal supervisor code
SupervisorName	String(40)	No	Supervisor name

---

Request Example

curl --location 'http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"GetSellerInfo"' \
--header 'Content-Type: application/json' \
--data '{
    "SellerNo": "VND12345"
}'

---

Response Example

{
    "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"
    }
}

---

🐞 Possible Errors

Code	Message
GSL‑001	The provided External Seller Code parameter (SellerNo) does not exist!

---