Pular para o conteúdo principal

Informações do Pedido de Venda

O endpoint GetSalesOrderInfo retorna as informações de um determinado pedido de venda no sistema MIMS.


Como buscar informações de um pedido de venda

Request HTTP Post

Tipo da RequisiçãoURL Exemplo
POST{{url_base}}/GetSalesOrderInfo
Exemplohttp://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"GetSalesOrderInfo"

Parâmetros de Entrada

ParâmetroTipoObrigatórioDescrição
SalesOrderNoString(25)SimCódigo externo do pedido de venda
BranchNoString(25)SimCódigo externo da filial

Retorno

ParâmetroTipoObrigatórioDescrição
WebServiceReturnWebServiceReturnSimInformações padrão de resposta do WebService na execução do método
SalesOrderInfoGetSalesOrderInfoDataSimObjeto contendo os dados do pedido de venda

📝 Objeto GetSalesOrderInfoData

O objeto GetSalesOrderInfoData representa um pedido de venda.

Parâmetros de Retorno

ParâmetroTipoObrigatórioDescrição
CustomerNoString(25)SimCódigo externo do cliente
CustomerAuxiliaryNoString(25)NãoCódigo externo auxiliar do cliente
SellerNoString(25)SimCódigo externo do vendedor
SalesOrderDateDataHoraSimData do pedido
DeliveryDateDataHoraSimData de entrega
RegisterDateDataHoraSimData de digitação do pedido
FreightTypeFreightTypeSimEnumerador com os possíveis valores para o tipo de frete: ftShipper (CIF) ou ftRemittee (FOB)
DeliveryAddressAddressInfoNãoObjeto que contém as informações do endereço de entrega do pedido
BillingAddressAddressInfoNãoObjeto que contém as informações do endereço de cobrança do pedido
NotesString(2000)NãoObservações do pedido de venda
ItemListGetSalesOrderItemInfoListSimLista de todos os itens do pedido de venda

📝 Objeto GetSalesOrderItemInfo

O objeto GetSalesOrderItemInfo representa um item do pedido de venda.

Parâmetros de Retorno

ParâmetroTipoObrigatórioDescrição
ItemNoString(25)NãoCódigo externo do item do pedido de venda
ProductNoString(25)SimCódigo externo do produto
UnitValueFloatNãoValor unitário
PackageQtyIntegerNãoQuantidade de pacotes das caixas pedidas
QtyIntegerNãoQuantidade de caixas pedidas
WeightFloatNãoPeso pedido
TotalValueFloatNãoValor total
ShelflifeLimitBeginDateDataHoraNãoData inicial para restrição da data de produção
ShelflifeLimitFinalDateDataHoraNãoData final para restrição da data de produção

Exemplo de Request

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

Exemplo de Response

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

🐞 Possíveis Erros

CódigoMensagem
GSO‑001O "SalesOrderNo" informado não existe!