Sign in

v1

latestOpenAPI 3.0.02026-07-266521,3121.2 MB
ProcessedOrders

GetReturnOrderInfo

Use this call to get basic information about a processed order (e.g. source, subsource, address) as seen on the Returns/Refunds screens. <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/GetReturnOrderInfo

Query parameters

pkOrderIdstring uuid

The id of the order.

includeRefundLinkboolean

Is a refund link required (not available for all channels).

Response

OK

pkOrderIdstring uuid

Order ID

nOrderIdinteger

Linnworks order number

Sourcestring

ChannelName/Source (e.g. EBAY)

SubSourcestring

Subsource (e.g. EBAY1)

PostalServiceNamestring

Postal service name (e.g. Next day delivery)

cShippingAddressstring

Shipping address

cCurrencystring

Currency

dReceivedDatestring date-time

Order received date. When order was downloaded from the channel

dProcessedOnstring date-time

When order was processed

fTotalChargenumber double

OrdOrder total charge

RefundLinkstring

Link to order refund

Example response

{
  "pkOrderId": "00000000-0000-0000-0000-000000000000"
}