Pedido de Devolução

Descrição

Inlcusão de um novo pedido de devolução no sistema MIMS e pode ser consultado através da EXP027.

Processo Completo para execução deste método consiste na sequência abaixo:

AddSalerOrder (Criar um pedido de venda)

AddLoad (Criar uma carga, vincular esse pedido de venda criado)

AddReturnOrder (Criar um pedido de devolução)

AddReturnOrderLoad(Criar uma carga de devolução, vincular esse pedido de devolução criado)

---

Request HTTP Post

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

---

Parâmetros de Entrada

Nome	Tipo	Obrigatório	Comentários
ReturnOrderNo	String(25)	Sim	Código externo do pedido de devolução
SalesOrderNo	String(25)	Sim	Código externo do pedido de venda associado
BranchNo	String(25)	Sim	Código externo da filial
ReturnOrderDate	DataHora	Sim	Data do pedido de devolução
RegisterDate	DataHora	Sim	Data de digitação do pedido de devolução
ReturnOrderReasonNo	String(25)	Não	Código externo do motivo da devolução
ReturnOrderType	ReturnOrderType	Sim	Tipo da devolução: P = rtPartial (Parcial), T = rtTotal (Total)
Notes	String(2000)	Não	Observações do pedido de devolução
ItemList	AddReturnOrderItemList	Sim	Lista de itens do pedido de devolução

---

Retorno

Nome	Tipo	Obrigatório	Comentários
WebServiceReturn	WebServiceReturn	Sim	Informações padrão de resposta do webservice
ReturnOrderCode	Integer	Sim	Código interno do pedido de devolução gerado no MIMS

---

Objeto: AddReturnOrderItemList

Descrição: Representa um item do pedido de devolução.

Propriedades

Nome	Tipo	Obrigatório	Comentários
ItemNo	String(25)	Não	Código externo do item do pedido de devolução
SalesOrderItemNo	String(25)	Não	Código externo do item do pedido de venda
ProductNo	String(25)	Sim	Código externo do produto
UnitValue	Float	Não	Valor unitário
Qty	Integer	Não	Quantidade de caixas devolvidas
Weight	Float	Não	Peso devolvido
TotalValue	Float	Não	Valor total

---

Exemplo de Request

POST http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/PostAddReturnOrder
Content-Type: application/json

{
  "ReturnOrderNo": "RET123",
  "SalesOrderNo": "SO456",
  "BranchNo": "BR001",
  "ReturnOrderDate": "2025-02-07T14:30:00Z",
  "RegisterDate": "2025-02-07T15:00:00Z",
  "ReturnOrderReasonNo": "REAS001",
  "ReturnOrderType": "rtPartial",
  "Notes": "Devolução por defeito no produto.",
  "ItemList": [
    {
      "ProductNo": "PROD001",
      "UnitValue": 25.50,
      "Qty": 5,
      "Weight": 10.0,
      "TotalValue": 127.50
    }
  ]
}

---

Exemplo de Response

{
  WebServiceReturn: {
    Success: true,
    Message: "Pedido de devolução criado com sucesso."
  },
  ReturnOrderCode: 789
}

---

Notas de Dev

• Certifique-se de que ReturnOrderDate e RegisterDate estejam no formato ISO 8601 (ex.: 2025-02-07T14:30:00Z).
• O campo ReturnOrderType aceita apenas rtPartial (parcial) ou rtTotal (total). Use o valor correto conforme o tipo de devolução.
• Se ItemList contiver itens com SalesOrderItemNo, certifique-se de que estejam associados ao SalesOrderNo informado.

---

Exclusão Pedido de Devolução

Descrição

Esse endpoint executa a exclusão de um pedido de devolução no sistema MIMS.

---

Request HTTP Post

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

Parâmetros de Entrada

Parâmetro	Tipo	Obrigatório	Descrição
ReturnOrderNo	String(25)	Sim	Código Externo do Pedido de Devolução. Exemplo: "RET98765"
ErrorIfNotFound	Boolean	Não	Retorna erro caso o pedido informado não exista no banco de dados. Exemplo: true

---

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.

---

Exemplo de Request

curl --location --request POST '{{url_base}}/PostDeleteReturnOrder' \
--header 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{
    "ReturnOrderNo": "RET98765",
    "ErrorIfNotFound": true
}'

---

Exemplo de Response

{
    "WebServiceReturn": {
        "Status": "wrsSuccess",
        "ErrorCode": "",
        "Message": "",
        "Actor": "",
        "ReturnQuestion": null
    }
}