Step 1. Retrieve Ready Buyer Initiated Returns & Expand Adjustment Info


When to Use

  • To retrieve new Buyer Initiated Returns that are ready for review/action, and import any returns that were auto-approved and are now in a ReadyForReturn status.
  • This request will display the order level or item-level adjustment information where the RequestStatus defined exists.

Resource URL / Endpoint

Order Level: GET https://api.channeladvisor.com/v1/Orders?$filter=Adjustments/Any (c:c/RequestStatus eq 'NewRma') or Adjustments/Any (c:c/RequestStatus eq 'ReadyForReturn')&$expand=Adjustments
Item Level: GET https://api.channeladvisor.com/v1/OrderItems?$filter=Adjustments/Any (c:c/RequestStatus eq 'NewRma') or Adjustments/Any (c:c/RequestStatus eq 'ReadyForReturn')&$expand=Adjustments

Important and/or Required Parameters

PropertyRequiredNote
$filter=Adjustments/AnyRequiredDefines the filtering action on the Adjustments collection, allowing for Any value to be searched.
(c:c/RequestStatus eq 'NewRma')RequiredDefines the property and specific value this property requires to meet the filter setting.
orRequiredDefines the operator to allow for filtering to an additional property.
Adjustments/AnyRequiredDefines the location of the Collection this data exists in.
(c:c/RequestStatus eq 'ReadyForReturn')RequiredDefines the property and specific value this property requires to meet the filter setting.
$expand=AdjustmentsRequiredDefines the expansion of the Adjustments to view the adjustment data.
Item Level Example Request
GET https://api.channeladvisor.com/v1/OrderItems?access_token=xxxxxxxxxx&$filter=Adjustments/Any (c:c/RequestStatus eq 'NewRma') or Adjustments/Any (c:c/RequestStatus eq 'ReadyForReturn')&$expand=Adjustments
Item Level Example Response (Success)
200 OK
{
  "@odata.context": "https://api.channeladvisor.com/v1/$metadata#OrderItems",
  "value": [
    {
      "ID": 24863311,
      "ProfileID": 12345678,
      "OrderID": 27204669,
      "ProductID": 28884846,
      "SiteOrderItemID": "",
      "SiteListingID": "360516735305",
      "Sku": "3555868drumset",
      "Title": "5 PC Complete Adult Drum Set with Cymbals Full Size Black",
      "Quantity": 2,
      "UnitPrice": 179.95,
      "TaxPrice": 0,
      "ShippingPrice": 0,
      "ShippingTaxPrice": 0,
      "RecyclingFee": 0,
      "GiftMessage": null,
      "GiftNotes": null,
      "GiftPrice": 0,
      "GiftTaxPrice": 0,
      "IsBundle": false,
      "ItemURL": "http://cgi.ebay.com/ws/eBayISAPI.dll?ViewItem&item=360516735305",
      "Adjustments": [
        {
          "ID": 157570,
          "ProfileID": 12345678,
          "OrderID": 27204669,
          "OrderItemID": 24863311,
          "Quantity": 2,
          "IsRestock": false,
          "Reason": "CustomerReturnedItem",
          "ItemAdjustment": 323.9,
          "TaxAdjustment": 0,
          "ShippingAdjustment": null,
          "ShippingTaxAdjustment": null,
          "GiftWrapAdjustment": null,
          "GiftWrapTaxAdjustment": null,
          "RecyclingFeeAdjustment": null,
          "Type": "Refund",
          "SellerAdjustmentID": null,
          "PublicNotes": null,
          "Comment": null,
          "CreatedDateUtc": "2016-09-20T06:52:57.3766667Z",
          "RequestStatus": "NewRma",
          "RestockStatus": null,
          "RmaNumber": null,
          "ReturnShippingFee": 8,
          "RestockingFee": 6,
          "ReturnTrackingNumberOrUrl": "321654987654321",
          "ReturnShippingMethod": "Marketplace Express"
        }
      ]
    },
    {
		// Omitted additional orders to save space
    }
  ],
  "@odata.nextLink": "https://api.channeladvisor.com/v1/OrderItems?$filter=Adjustments%2FAny%20%28c%3Ac%2FRequestStatus%20eq%20%27NewRma%27%29&$expand=Adjustments&access_token=xxxxxxxxxx&$skip=20"
}