Sign in

v1

latestOpenAPI 3.0.02026-07-266521,3121.2 MB
ProcessedOrders

GetReturnsExchanges

Use this call to get a basic list of returns, exchanges and resends for an order. <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

get/api/ProcessedOrders/GetReturnsExchanges

Query parameters

pkOrderIdstring uuid

The order id to get the returns for

Response

OK

pkReturnIdinteger

Return ID

RowType'UNKNOWN' | 'RETURN' | 'RETURNREFUND' | 'EXCHANGE' | 'RESEND' | 'RETURNBOOKING' | 'EXCHANGEBOOKING'

return type (e.g. EXCHANGE)

ReturnReferencestring

Return reference

fkOrderIdstring uuid

Order ID

fkOrderItemRowIdstring uuid

Order item record row ID

OrderItemBatchIdinteger

Order item batch id

nOrderIdinteger

Linnworks order number

SKUstring

Product SKU

ItemTitlestring

Product title

BatchNumberstring

Batch number

Reasonstring

Return reason

ChannelReasonstring

Return reason set on a channel

ChannelReasonSecstring

Secondary return reason on a channel

Categorystring

Category

ReturnQtyinteger

Returned quantity

fkReturnLocationIdstring uuid

Return location ID

Scrappedboolean

If returned item was scrapped

ScrapQtyinteger

Scrapped quantity

LastStatestring

Last state

LastDatestring date-time

Last date

Completedboolean

If return is completed

fkNewOrderIdstring uuid

New order ID for return

fkNewOrderItemRowIdstring uuid

New order item record row ID

fkNewStockItemIdstring uuid

New stock item ID

NewQtyinteger

New return quantity

NewOrderIdinteger

New order ID

NewOrderCancelledboolean

If new order were cancelled

NewSKUstring

new product SKU

NewItemTitlestring

New product title

NewOrderProcessedOnstring date-time

When new order was processed

AdditionalCostnumber double

Additional costs involved

fkRefundRowIdstring uuid

Refund record row ID

RefundedAmountnumber double

Amount refunded

PendingRefundnumber double

Refund pending

ReturnDatestring date-time

Return date

Example response

[
  {
    "fkOrderId": "00000000-0000-0000-0000-000000000000",
    "fkOrderItemRowId": "00000000-0000-0000-0000-000000000000",
    "fkReturnLocationId": "00000000-0000-0000-0000-000000000000",
    "fkNewOrderId": "00000000-0000-0000-0000-000000000000",
    "fkNewOrderItemRowId": "00000000-0000-0000-0000-000000000000",
    "fkNewStockItemId": "00000000-0000-0000-0000-000000000000",
    "fkRefundRowId": "00000000-0000-0000-0000-000000000000"
  }
]