Sign in
ProcessedOrders

GetReturnItemsInfo

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. <b>Rate limit: </b><span style="background-color:#0272d9;color:white;padding:4px 8px;text-align:center;border-radius:5px; font-size: small;"><b>250</b></span> / minute

get/api/ProcessedOrders/GetReturnItemsInfo

Query parameters

pkOrderIdstring uuid

The order id to get the returns for

Response

OK

OrderIdstring uuid

Order Id [Guid]

fkOrderItemRowIdstring uuid

Order item record row ID

ParentRowIdstring uuid

Parent record row ID

ReturnableQtyinteger

Returnable quantity

OrderQtyinteger

Order quantity

ReturnedQtyinteger

Returned quantity

SKUstring

Product SKU

ItemTitlestring

Product title

UnitValuenumber double

Item value

TaxRatenumber double

Tax rate

TaxCostInclusiveboolean

Indicates whether the UnitValue specified includes or exludes tax.

Currencystring

Currency

IsCompositeParentboolean

If item is composite parent

IsPartialCompositeReturnboolean

If return is a part of composite item

ParentRatiointeger
pkStockItemIdstring uuid

Stock item ID

ResentQtyinteger

resend quantity

fkRefundRowIdstring uuid

Refund Row Id

Example response

[
  {
    "Batches": [
      {
        "OrderId": "00000000-0000-0000-0000-000000000000",
        "fkOrderItemRowId": "00000000-0000-0000-0000-000000000000",
        "ParentRowId": "00000000-0000-0000-0000-000000000000",
        "pkStockItemId": "00000000-0000-0000-0000-000000000000",
        "fkRefundRowId": "00000000-0000-0000-0000-000000000000"
      }
    ],
    "OrderId": "00000000-0000-0000-0000-000000000000",
    "fkOrderItemRowId": "00000000-0000-0000-0000-000000000000",
    "ParentRowId": "00000000-0000-0000-0000-000000000000",
    "pkStockItemId": "00000000-0000-0000-0000-000000000000",
    "fkRefundRowId": "00000000-0000-0000-0000-000000000000"
  }
]

Changes