Simulate Return

Simulates the return creation for a given customer order and line item.

POST

Body

Arguments

stringrequired

Purchase order identifier for the order being used in the return simulation.

numberrequired

Line number of an item within the order to return.

numberrequired

Quantity of units being returned for the specified order line.

stringrequired

Reason for initiating the return.

Field selectionChoose which fields should be included in the response. Learn more

string

Comma-separated response fields to include.

Try this request

Request

curl --request POST \
  --url "https://connect.mindcloud.co/v2/universal/apps/walmart/actions/simulate-return/run" \
  --header "Authorization: Bearer $MINDCLOUD_API_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
  "version": "0.0.105",
  "arguments": {
    "purchaseOrderId": "",
    "returnReason": ""
  }
}'

{
  "success": true,
  "data": [
    {
      "customerEmailId": "[email protected]",
      "customerName": {
        "firstName": "Ava",
        "lastName": "Chen"
      },
      "customerOrderId": "string",
      "purchaseOrderId": "string",
      "refundMode": "string",
      "replacementCustomerOrderId": "string",
      "returnByDate": "2026-05-07T12:00:00.000Z",
      "returnChannel": {
        "channelName": "string"
      },
      "returnLineGroups[]": {
        "groupNo": 1,
        "returnExpectedFlag": true
      },
      "returnOrderDate": "2026-05-07T12:00:00.000Z",
      "returnOrderId": "string",
      "returnOrderLines[]": {
        "cancellableQty": 1,
        "charges[]": {
          "chargeCategory": "string",
          "chargeName": "string",
          "chargePerUnit": {
            "currencyAmount": 1,
            "currencyUnit": "string"
          },
          "excessCharge": {
            "currencyAmount": 1,
            "currencyUnit": "string"
          },
          "isBillable": true,
          "isDiscount": true,
          "references[]": {
            "name": "Ava Chen",
            "value": "string"
          },
          "tax[]": {
            "excessTax": {
              "currencyAmount": 1,
              "currencyUnit": "string"
            },
            "taxName": "string",
            "taxPerUnit": {
              "currencyAmount": 1,
              "currencyUnit": "string"
            }
          }
        },
        "chargeTotals[]": {
          "name": "Ava Chen",
          "value": {
            "currencyAmount": 1,
            "currencyUnit": "string"
          }
        },
        "currentDeliveryStatus": "string",
        "currentRefundStatus": "string",
        "currentTrackingStatuses[]": {
          "currentRefundStatus": "string",
          "quantity": {
            "measurementValue": 1,
            "unitOfMeasure": "string"
          },
          "status": "string",
          "statusTime": "2026-05-07T12:00:00.000Z"
        },
        "exceptionItemType": "string",
        "isFastReplacement": true,
        "isKeepIt": true,
        "isReturnForException": true,
        "item": {
          "condition": "string",
          "itemWeight": {
            "measurementValue": 1,
            "unitOfMeasure": "string"
          },
          "productName": "string",
          "sku": "string"
        },
        "lastItem": true,
        "purchaseOrderId": "string",
        "purchaseOrderLineNumber": 1,
        "quantity": {
          "measurementValue": 1,
          "unitOfMeasure": "string"
        },
        "rechargeableQty": 1,
        "rechargeReason": "string",
        "refundChannels[]": {
          "quantity": {
            "measurementValue": 1,
            "unitOfMeasure": "string"
          },
          "refundChannelName": "string"
        },
        "refundCoveredBy": "string",
        "refundedQty": 1,
        "returnCancellationReason": "string",
        "returnDescription": "string",
        "returnExpectedFlag": true,
        "returnOrderLineNumber": 1,
        "returnReason": "string",
        "returnTrackingDetail[]": {
          "eventDescription": "string",
          "eventTag": "string",
          "eventTime": "2026-05-07T12:00:00.000Z",
          "references[]": {
            "name": "Ava Chen",
            "value": "string"
          },
          "sequenceNo": 1
        },
        "salesOrderLineNumber": 1,
        "sellerOrderId": "string",
        "status": "string",
        "statusTime": "2026-05-07T12:00:00.000Z",
        "unitPrice": {
          "currencyAmount": 1,
          "currencyUnit": "string"
        }
      },
      "returnType": "string",
      "totalRefundAmount": {
        "currencyAmount": 1,
        "currencyUnit": "string"
      }
    }
  ],
  "meta": {}
}

Every app you connect,one REST pattern

Call any app with one REST pattern. MindCloud handles each provider's auth, request shape, and responses for you.

Learn what the Universal API is

One REST patternUse the same request structure across apps like Slack, HubSpot, Salesforce, and thousands more.

Managed connectionsSend a MindCloud connection ID instead of handling provider tokens, refresh logic, and credential storage yourself.

Action-level docsEach action page shows the exact endpoint, required arguments, optional controls, and response behavior for that app version.