Informações do Pedido de Devolução

O endpoint GetReturnOrderInfo retorna as informações de um determinado pedido de devolução no sistema MIMS.

---

Como buscar informações de um Pedido de Devolução

Request HTTP POST

Tipo da Requisição	URL Exemplo
POST	{{url_base}}/GetReturnOrderInfo
Exemplo	http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"GetReturnOrderInfo"

Parâmetros de Entrada

Parâmetro	Tipo	Obrigatório	Descrição
ReturnOrderNo	String(25)	Sim	Código externo do pedido de devolução
BranchNo	String(25)	Sim	Código externo da filial

---

Retorno

Parâmetro	Tipo	Obrigatório	Descrição
WebServiceReturn	WebServiceReturn	Sim	Informações padrão de resposta do WebService na execução do método
ReturnOrderInfo	GetReturnOrderInfoData	Sim	Objeto contendo os dados do pedido de devolução

📝 Objeto GetReturnOrderInfoData

O objeto GetReturnOrderInfoData representa um pedido de devolução.

Parâmetros de Retorno

Parâmetro	Tipo	Obrigatório	Descrição
ReturnOrderNo	String(25)	Sim	Código externo do pedido de devolução
SalesOrderNo	String(25)	Sim	Código externo do pedido de venda
BranchNo	String(25)	Sim	Código externo da filial
ReturnOrderReasonNo	String(25)	Sim	Código externo do motivo da devolução
ReturnOrderDate	DataHora	Sim	Data do pedido de devolução
ReturnOrderCloseDate	DataHora	Sim	Data de fechamento do pedido de devolução
ReturnOrderType	ReturnOrderType	Sim	Enumerador com os possíveis valores para o Tipo da devolução: rtPartial (Parcial), rtTotal (Total) ou rtLeftovers (Sobras na Carga)
ReturnOrderStatus	String(2)	Sim	Status do pedido de devolução
Notes	String(2000)	Sim	Observações do pedido de devolução
DestinationQty	Integer	Sim	Quantidade de Caixas Destinadas
ItemList	GetReturnOrderItemInfoList	Sim	Lista de todos os itens dos pedidos de devolução

📝 Objeto GetReturnOrderItemInfoList

O objeto GetReturnOrderItemInfoList representa um item do pedido de devolução.

Parâmetros de Retorno

Parâmetro	Tipo	Obrigatório	Descrição
ItemNo	String(25)	Sim	Código externo do item do pedido de devolução
ProductNo	String(25)	Sim	Código externo do produto
Qty	Integer	Sim	Quantidade de caixas programadas para devolução
Weight	Float	Sim	Peso devolvido das caixas programadas
ReturnedQty	Integer	Sim	Quantidade de caixas lidas (identificadas)
ReturnedWeight	Float	Sim	Peso de caixas lidas (identificadas)
ReturnRealQty	Integer	Sim	Quantidade real de caixas devolvidas
ReturnRealWeight	Float	Sim	Peso real devolvido
DispatchedQty	Integer	Sim	Quantidade de caixas entregues
DispatchedWeight	Float	Sim	Quantidade de caixas esperadas
DeliveredQty	Integer	Sim	Quantidade entregue
DeliveredWeight	Float	Sim	Peso entregue
OperationValue	Float	Sim	Valor unitário do produto
ReturnTotalValue	Float	Sim	Valor total devolvido
DispatchedTotalValue	Float	Sim	Valor total esperado
AdjustedQty	Integer	Sim	Quantidade de caixas ajustadas
AdjustedReasonNo	String(25)	Sim	Código externo do motivo do ajuste
AdjustedReasonFactor	Integer	Sim	Fator do motivo do ajuste
AdjustedReasonNotes	String(2000)	Sim	Observações do motivo do ajuste
ShrinkPercentage	Float	Sim	Percentual de quebra
ShrinkTotalValue	Float	Sim	Valor total da quebra
ShrinkWeight	Float	Sim	Peso da quebra

---

Exemplo de Request

curl --location 'http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"GetReturnOrderInfo"' \
--header 'Content-Type: application/json' \
--data '{
    "BranchNo": "0102",
    "ReturnOrderNo": "2406145"
}'

---

Exemplo de Response

{
  "WebServiceReturn": {
    "Status": "wrsSuccess",
    "ErrorCode": "",
    "Message": "",
    "Actor": "",
    "ReturnQuestion": null
  },
  "ReturnOrderInfo": {
    "ReturnOrderNo": "RET123",
    "SalesOrderNo": "SO456",
    "BranchNo": "BR001",
    "ReturnOrderDate": "2025-02-07T14:30:00Z",
    "ReturnOrderCloseDate": "2025-02-10T12:00:00Z",
    "ReturnOrderReasonNo": "REAS001",
    "ReturnOrderType": "rtPartial",
    "ReturnOrderStatus": "T",
    "Notes": "Devolução por defeito no produto.",
    "DestinationQty": 10,
    "ItemList": [
      {
        "ItemNo": "ITEM001",
        "ProductNo": "PROD001",
        "Qty": 5,
        "Weight": 10.0,
        "ReturnedQty": 5,
        "ReturnedWeight": 10.0,
        "ReturnRealQty": 5,
        "ReturnRealWeight": 10.0,
        "DispatchedQty": 5,
        "DispatchedWeight": 10.0,
        "DeliveredQty": 5,
        "DeliveredWeight": 10.0,
        "OperationValue": 25.50,
        "ReturnTotalValue": 127.50,
        "DispatchedTotalValue": 127.50,
        "AdjustedQty": 0,
        "AdjustedReasonNo": "",
        "AdjustedReasonFactor": 0,
        "AdjustedReasonNotes": "",
        "ShrinkPercentage": 0.0,
        "ShrinkTotalValue": 0.0,
        "ShrinkWeight": 0.0
      }
    ]
  }
}

---

🐞 Possíveis Erros

Código	Mensagem
GRO‑001	O "ReturnOrderNo" ([valor enviado na requisição]) informado não existe na filial "BranchNo" ([valor enviado na requisição]) informada

---