Back

Search

Search

Methods

Inventory

OrderPrintStatus
Orders

ShippingService

ProcessedOrders /GetReturnItemsInfo

Allows 250 calls per minute

Response: List<OrderItemReturnInfo>



Use this call to get a list of all items on an order, including return quantities and resend quantities. The information can be used to calculate how many items has already been returned.

Parameters

NameTypeDescription
pkOrderIdGuidThe order id to get the returns for

Example Request

The following request format is required for this method.

Endpoint URL

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

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=6f831fda-fd38-4f08-9e35-f2d22ee6689f

Response

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

[
  {
    "ChildItems": [
      {
      }
    ],
    "Batches": null,
    "OrderId": "00000000-0000-0000-0000-000000000000",
    "fkOrderItemRowId": "5e1ba812-8a27-4f9d-bf5b-e8bc243ff1fc",
    "ParentRowId": "fb472989-12c1-4082-b99e-3afc575b0ceb",
    "ReturnableQty": 0,
    "OrderQty": 3,
    "ReturnedQty": 4,
    "SKU": "sample string 5",
    "ItemTitle": "sample string 6",
    "UnitValue": 7.1,
    "TaxRate": 8.1,
    "TaxCostInclusive": true,
    "Currency": "sample string 10",
    "IsCompositeParent": true,
    "IsPartialCompositeReturn": true,
    "ParentRatio": 13,
    "pkStockItemId": "62ba00d2-3225-42a2-8d9f-d0b2c5157c5b",
    "ResentQty": 14,
    "fkRefundRowId": "916dfb95-d848-4dbc-acbf-68cb4f94270a"
  }
]