Create Order Return

post/v3/orderreturn

Request

Query parameters

idinteger required

Order Id

echoboolean
includeCustomerMatchesboolean

Request body

merchantIdinteger required
totalAmountnumber float required
balancenumber float required
lineItemCountinteger required

Response

201

idinteger
merchantIdinteger
orderIdinteger
createdstring
modifiedstring
totalAmountstring
lineItemCountinteger
balancestring
lineItemsobject[]
shippingLineItemsobject[]
discountsobject[]
taxesobject[]
adjustmentAmountstring

Example response

{
  "id": 2099,
  "merchantId": 516167953,
  "orderId": 351121,
  "created": "2022-02-18T16:37:59.027Z",
  "modified": "2022-02-18T16:37:59.34Z",
  "totalAmount": "0.69",
  "lineItemCount": 1,
  "balance": "0.69",
  "payments": [
    {
      "created": "2022-02-18T16:37:58.840518Z",
      "paymentToken": "P58v4Ynah6CSJ0nL1HGnBhxS7pIAlB54",
      "originalId": 86440677,
      "id": 86440682,
      "merchantId": 516167953,
      "batchId": 10000000270668,
      "tenderType": "Card",
      "currency": "USD",
      "amount": "0.69",
      "cardAccount": {
        "cardType": "Visa",
        "entryMode": "Keyed",
        "last4": "1111",
        "token": "P58v4Ynah6CSJ0nL1HGnBhxS7pIAlB54",
        "expiryMonth": "08",
        "expiryYear": "23"
      },
      "authCode": "PPSd01",
      "status": "Approved",
      "customerMatches": [
        {
          "id": 10000000822479,
          "name": "API Test",
          "created": "2021-11-08T13:15:28.993",
          "modified": "2022-02-08T19:31:22.07",
          "loyaltyStatus": "Enrolled",
          "loyaltyEnrolled": "2021-11-08T13:15:28.993Z"
        }
      ],
      "settledAmount": "0",
      "settledCurrency": "USD",
      "authMessage": "Approved or completed successfully",
      "reference": "204916004743",
      "invoice": "1013",
      "customerName": "API Test",
      "type": "Return",
      "source": "Order"
    }
  ],
  "adjustmentAmount": "0"
}

Changes

No recorded changes to this operation across all 1 revision of this API.