Sign in

v1

latestOpenAPI 3.0.02026-07-266521,3121.2 MB
ReturnsRefunds

CreateRMABooking

Creates an RMA booking in the system <b>Permissions Required: </b> GlobalPermissions.OrderBook.ReturnsRefunds.ReturnsExchanges.CreateReturnsExchangesNode <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/CreateRMABooking

Request body

Example request

{
  "request": {
    "OrderId": "00000000-0000-0000-0000-000000000000",
    "ReturnItems": [
      {
        "OrderItemRowId": "00000000-0000-0000-0000-000000000000",
        "ReturnLocation": "00000000-0000-0000-0000-000000000000",
        "RefundRowId": "00000000-0000-0000-0000-000000000000"
      }
    ],
    "ExchangeItems": [
      {
        "ExchangeStockItemId": "00000000-0000-0000-0000-000000000000",
        "DespatchLocationId": "00000000-0000-0000-0000-000000000000",
        "OrderItemRowId": "00000000-0000-0000-0000-000000000000",
        "ReturnLocation": "00000000-0000-0000-0000-000000000000",
        "RefundRowId": "00000000-0000-0000-0000-000000000000"
      }
    ],
    "ResendItems": [
      {
        "DespatchLocationId": "00000000-0000-0000-0000-000000000000",
        "OrderItemRowId": "00000000-0000-0000-0000-000000000000",
        "ReturnLocation": "00000000-0000-0000-0000-000000000000",
        "RefundRowId": "00000000-0000-0000-0000-000000000000"
      }
    ]
  }
}

Response

OK

RMAHeaderIdinteger

An identifier for the RMA request header being worked with. Newly created RMA headers will have this field populated as part of the "Create" request

Errorsstring[]

Any global validation errors are included in this collection, along with a concatenation of any errors found in an individual item

Infostring[]

Any global validation information is included in this collection, along with a concatenation of any information found in an individual item

Example response

{
  "Items": [
    {
      "NewOrderId": "00000000-0000-0000-0000-000000000000",
      "ExchangeStockItemId": "00000000-0000-0000-0000-000000000000",
      "DespatchLocationId": "00000000-0000-0000-0000-000000000000",
      "OrderItemRowId": "00000000-0000-0000-0000-000000000000",
      "ReturnLocation": "00000000-0000-0000-0000-000000000000",
      "RefundRowId": "00000000-0000-0000-0000-000000000000"
    }
  ]
}