Sign in

v1

latestOpenAPI 3.0.02026-07-266521,3121.2 MB
ReturnsRefunds

GetRefundLinesByHeaderId

Returns a refund, given its header ID <b>Permissions Required: </b> GlobalPermissions.OrderBook.ReturnsRefunds.Refunds.ViewRefundsNode <b>Rate limit: </b><span style="background-color:#0272d9;color:white;padding:4px 8px;text-align:center;border-radius:5px; font-size: small;"><b>150</b></span> / minute

post/api/ReturnsRefunds/GetRefundLinesByHeaderId

Request body

Example request

{
  "request": {
    "OrderId": "00000000-0000-0000-0000-000000000000"
  }
}

Response

OK

RefundHeaderIdinteger

The unique identifier for the loaded refund

Example response

{
  "RefundLines": [
    {
      "RefundRowId": "00000000-0000-0000-0000-000000000000",
      "RefundedItem": {
        "OrderItemRowId": "00000000-0000-0000-0000-000000000000"
      },
      "Errors": [
        {
          "RefundRowId": "00000000-0000-0000-0000-000000000000"
        }
      ]
    }
  ],
  "RefundOptions": {
    "ItemizedRefundReasons": [
      {
        "ItemId": "00000000-0000-0000-0000-000000000000"
      }
    ],
    "Order": {
      "OrderId": "00000000-0000-0000-0000-000000000000",
      "FulfilmentLocationId": "00000000-0000-0000-0000-000000000000"
    },
    "RefundHeader": {
      "RefundLines": [
        {
          "RefundRowId": "00000000-0000-0000-0000-000000000000",
          "RefundedItem": {
            "OrderItemRowId": "00000000-0000-0000-0000-000000000000"
          },
          "Errors": [
            {
              "RefundRowId": "00000000-0000-0000-0000-000000000000"
            }
          ]
        }
      ],
      "OrderId": "00000000-0000-0000-0000-000000000000"
    },
    "AllExistingRefunds": [
      {
        "RefundRowId": "00000000-0000-0000-0000-000000000000",
        "RefundedItem": {
          "OrderItemRowId": "00000000-0000-0000-0000-000000000000"
        },
        "Errors": [
          {
            "RefundRowId": "00000000-0000-0000-0000-000000000000"
          }
        ]
      }
    ]
  }
}