Orders

Get Adjustments

get/v1/Orders({ID})/Adjustments

Request

  • Base URL: https://api.channeladvisor.com
  • URL: https://api.channeladvisor.com/v1/Orders({ID})/Adjustments
  • Auth: OAuth 2 (authorization code, authorization URL https://api.channeladvisor.com/oauth2/authorize, token URL https://api.channeladvisor.com/oauth2/token; implicit, authorization URL https://api.channeladvisor.com/oauth2/authorize, scopes: orders, inventory) and HTTP bearer

Path parameters

IDnumber required

The unique identifier of Order

Query parameters

$topnumber

Show only the first n items

$skipnumber

Skip the first n items

$filterstring

Filter items by property values

$countboolean

Include count of items

$selectstring[]

Select properties to be returned

$orderbystring[]

Order items by property values

$expandstring[]

Expand related entities

Response

Success

@odata.countnumber nullable
@odata.nextLinkstring nullable

Example response

{
  "value": [
    {
      "CreatedSource": "Channel",
      "LastUpdatedSource": "Channel",
      "ReturnSellerComment": "string",
      "ReturnDistributionCenterID": 0,
      "ReturnDistributionCenterCode": "string",
      "BuyerReturnComment": "string",
      "ID": 0,
      "ProfileID": 0,
      "OrderID": 0,
      "IsRestock": true,
      "Reason": "GeneralAdjustment",
      "ItemAdjustment": 0,
      "TaxAdjustment": 0,
      "ShippingAdjustment": 0,
      "ShippingTaxAdjustment": 0,
      "GiftWrapAdjustment": 0,
      "GiftWrapTaxAdjustment": 0,
      "RecyclingFeeAdjustment": 0,
      "Type": "Refund",
      "SellerAdjustmentID": "string",
      "SiteAdjustmentID": "string",
      "SiteRefundDateUtc": "0001-01-01T00:00:00.0000000+00:00",
      "AdjustmentTransactionID": "string",
      "PublicNotes": "string",
      "Comment": "string",
      "CreatedDateUtc": "0001-01-01T00:00:00.0000000+00:00",
      "RequestStatus": "SubmittedNotProcessed",
      "RestockStatus": "SubmittedNotProcessed",
      "RmaNumber": "string",
      "ReturnShippingFee": 0,
      "RestockingFee": 0,
      "ReturnTrackingNumberOrUrl": "string",
      "ReturnShippingMethod": "string",
      "ReturnShippingCost": 0,
      "ReturnRejectionReason": "IneligibleForReturn",
      "LastUpdatedDateUtc": "0001-01-01T00:00:00.0000000+00:00",
      "IsRma": true,
      "Order": {
        "@odata.type": "ChannelAdvisor.RestApi.V1.Models.Order"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.