v1

latestOpenAPI 3.0.02026-07-266521,3121.2 MB

ReturnsRefunds

GetProcessedOrAckedErrorRefundHeaders

Returns a paged list of processed or acknowledged error refund headers Permissions Required: GlobalPermissions.OrderBook.ReturnsRefunds.Refunds.ViewRefundsNode Rate limit: 150 / minute

post/api/ReturnsRefunds/GetProcessedOrAckedErrorRefundHeaders

Request body

Response

Pageinteger

The page number returned

TotalHeadersinteger

A count of the total number of refund headers matching the filter set by the request

HeadersPerPageinteger

A count of the number of refund headers returned per page

Example response

{
  "RefundHeaders": [
    {
      "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"
    }
  ]
}