Sales Order Information

The GetSalesOrderInfo endpoint returns information about a specific sales order in the MIMS system.

---

How to get sales order information

HTTP POST Request

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

Input Parameters

Parameter	Type	Required	Description
SalesOrderNo	String(25)	Yes	External code of the sales order
BranchNo	String(25)	Yes	External code of the branch

---

Return

Parameter	Type	Required	Description
WebServiceReturn	WebServiceReturn	Yes	Standard WebService response information in method execution
SalesOrderInfo	GetSalesOrderInfoData	Yes	Object containing the sales order data

📝 GetSalesOrderInfoData Object

The GetSalesOrderInfoData object represents a sales order.

Return Parameters

Parameter	Type	Required	Description
CustomerNo	String(25)	Yes	External code of the customer
CustomerAuxiliaryNo	String(25)	No	Auxiliary external code of the customer
SellerNo	String(25)	Yes	External code of the seller
SalesOrderDate	DataHora	Yes	Order date
DeliveryDate	DataHora	Yes	Delivery date
RegisterDate	DataHora	Yes	Order entry date
FreightType	FreightType	Yes	Enumerator with possible values for freight type: ftShipper (CIF) or ftRemittee (FOB)
DeliveryAddress	AddressInfo	No	Object containing the delivery address information of the order
BillingAddress	AddressInfo	No	Object containing the billing address information of the order
Notes	String(2000)	No	Sales order notes
ItemList	GetSalesOrderItemInfoList	Yes	List of all sales order items

📝 GetSalesOrderItemInfo Object

The GetSalesOrderItemInfo object represents a sales order item.

Return Parameters

Parameter	Type	Required	Description
ItemNo	String(25)	No	External code of the sales order item
ProductNo	String(25)	Yes	External code of the product
UnitValue	Float	No	Unit value
PackageQty	Integer	No	Quantity of packages of boxes ordered
Qty	Integer	No	Quantity of boxes ordered
Weight	Float	No	Ordered weight
TotalValue	Float	No	Total value
ShelflifeLimitBeginDate	DataHora	No	Initial date for production date restriction
ShelflifeLimitFinalDate	DataHora	No	Final date for production date restriction

---

Request Example

{
  "SalesOrderNo": "SO12345",
  "BranchNo": "BR001"
}

---

Response Example

{
    "WebServiceReturn": {
        "Status": "wrsSuccess",
        "ErrorCode": "",
        "Message": "",
        "Actor": "",
        "ReturnQuestion": null
    },
    "SalesOrderInfo": {
        "CustomerNo": "03960",
        "CustomerAuxiliaryNo": "01",
        "CustomerCorporateName": "CLIENTE TESTE",
        "CustomerCode": 5987,
        "DeliveryAddress": {
            "AddressType": "",
            "Address": "RO ADHEMAR PEREIRA DE BARROS, SN",
            "Number": "",
            "District": "JARDIM BELA VISTA",
            "ZIPCode": "13804060",
            "City": "",
            "CityNo": "",
            "State": "",
            "StateInitials": "",
            "Country": "",
            "SubLogisticRegionNo": "",
            "PersonAdressNo": ""
        },
        "BillingAddress": {
            "AddressType": "",
            "Address": "RO ADHEMAR PEREIRA DE BARROS, SN",
            "Number": "",
            "District": "JARDIM BELA VISTA",
            "ZIPCode": "13804060",
            "City": "",
            "CityNo": "",
            "State": "",
            "StateInitials": "",
            "Country": "",
            "SubLogisticRegionNo": "",
            "PersonAdressNo": ""
        },
        "SellerNo": "0001",
        "SalesOrderDate": "2025-10-23",
        "RegisterDate": "2025-10-28T11:48:12.000Z",
        "DeliveryDate": "2026-02-28",
        "LoadNo": "",
        "FreightType": "ftShipper",
        "Notes": "Obs padrão do pedido",
        "PriceTableNo": "21",
        "PromotionalPriceTableNo": "21",
        "SalesOrderStatus": "AB",
        "ItemList": null
    }
}

---

🐞 Possible Errors

Code	Message
GSO‑001	The informed "SalesOrderNo" does not exist!

---