Sign in

v1

latestOpenAPI 3.0.02026-07-266521,3121.2 MB
ReturnsRefunds

UpdateRefund

Updates an existing refund in the system. Requires create and delete permissions <b>Permissions Required: </b> GlobalPermissions.OrderBook.ReturnsRefunds.Refunds.CreateRefundsNode <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/UpdateRefund

Request body

Example request

{
  "request": {
    "OrderId": "00000000-0000-0000-0000-000000000000",
    "RefundLines": [
      {
        "RefundRowId": "00000000-0000-0000-0000-000000000000"
      }
    ]
  }
}

Response

OK

RefundHeaderIdinteger

The unique identifier for the refund header.

RefundReferencestring

An automatically generated string to help identify the refund

CannotRefundReason'None' | 'NotImplemented' | 'DisabledInConfig' | 'MissingOrderInLinnworks' | 'OpenOrderInLinnworks' | 'OrderIsFullyRefundedInLinnworks' | 'NoNewRefundsSpecified' | 'NoUpdatedRefundsSpecified' | 'MultipleReferences' | 'SubStatusTagNotInTheSystem' | 'SubStatusTagIsNotActionable' | 'MultipleSubStatusTags' | 'RefundNotInSystem' | 'Other'

If the validation has failed at any stage, this field identifies the cause of the failure

Errorsstring[]

Any global validation errors are added to this list, as well as any errors from the RefundLines collection

Example response

{
  "RefundLines": [
    {
      "RefundRowId": "00000000-0000-0000-0000-000000000000",
      "RefundedItem": {
        "OrderItemRowId": "00000000-0000-0000-0000-000000000000"
      },
      "Errors": [
        {
          "RefundRowId": "00000000-0000-0000-0000-000000000000"
        }
      ]
    }
  ]
}