Back

Search

Search

Methods

Inventory

OrderPrintStatus
Orders

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.

Get

Endpoint URL

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

GET https://eu-ext.linnworks.net/api/ProcessedOrders/GetReturnOrderInfo?pkOrderId=4ed1558f-1f7e-4d1c-a0af-21ef2ee8589a&includeRefundLink=true

Headers

Connection: keep-alive
Accept: application/json
Accept-Encoding: gzip, deflate
Authorization: INSERT_YOUR_TOKEN_HERE

Post

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=4ed1558f-1f7e-4d1c-a0af-21ef2ee8589a&includeRefundLink=true

Response

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

{
  "pkOrderId": "7f7cf0a3-3817-40e1-8fe6-77355ba866ed",
  "nOrderId": 2,
  "Source": "sample string 3",
  "SubSource": "sample string 4",
  "PostalServiceName": "sample string 5",
  "cShippingAddress": "sample string 6",
  "cCurrency": "sample string 7",
  "dReceivedDate": "2022-01-13T12:45:46.619172+00:00",
  "dProcessedOn": "2022-01-13T12:45:46.619172+00:00",
  "fTotalCharge": 10.1,
  "RefundLink": "sample string 11"
}