Back

Search

Search

Methods

Inventory

OrderPrintStatus
Orders

ShippingService

ProcessedOrders /GetReturnOrderInfo

Allows 150 calls per minute

Response: ReturnOrderHeader



Use this call to get basic information about a processed order (e.g. source, subsource, address) as seen on the Returns/Refunds screens.

Parameters

NameTypeDescription
pkOrderIdGuidThe id of the order.
includeRefundLinkBooleanIs a refund link required (not available for all channels).

Example Request

The following request format is required for this method.

Endpoint URL

POST https://eu-ext.linnworks.net/api/ProcessedOrders/GetReturnOrderInfo

Headers

Connection: keep-alive
Accept: application/json
Content-Type: application/x-www-form-urlencoded; charset=UTF-8
Accept-Encoding: gzip, deflate
Authorization: INSERT_YOUR_TOKEN_HERE

Request Body

This is an example of the request structure. Results will vary depending on your data.

pkOrderId=4059deb0-9948-4683-8952-69b89ccc3e99&includeRefundLink=true

Response

This is an example of the response JSON. Results will vary depending on your data.

{
  "pkOrderId": "a65b4461-b904-4217-b719-b41b301bc4c4",
  "nOrderId": 2,
  "Source": "sample string 3",
  "SubSource": "sample string 4",
  "PostalServiceName": "sample string 5",
  "cShippingAddress": "sample string 6",
  "cCurrency": "sample string 7",
  "dReceivedDate": "2021-07-29T09:24:42.2822303+01:00",
  "dProcessedOn": "2021-07-29T09:24:42.2822303+01:00",
  "fTotalCharge": 10.1,
  "RefundLink": "sample string 11"
}