OrderItems

Get Order Items

get/v1/OrderItems

Request

  • Base URL: https://api.channeladvisor.com
  • URL: https://api.channeladvisor.com/v1/OrderItems
  • 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

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

$orderbystring[]

Order items by property values

$selectstring[]

Select properties to be returned

$expandstring[]

Expand related entities

Response

Retrieved collection

@odata.countnumber nullable
@odata.nextLinkstring nullable

Example response

{
  "value": [
    {
      "ID": 0,
      "ProfileID": 0,
      "OrderID": 0,
      "ProductID": 0,
      "SiteOrderItemID": "string",
      "SellerOrderItemID": "string",
      "SiteListingID": "string",
      "Sku": "string",
      "Title": "string",
      "Quantity": 0,
      "UnitPrice": 0,
      "TaxPrice": 0,
      "ShippingPrice": 0,
      "ShippingTaxPrice": 0,
      "RecyclingFee": 0,
      "UnitEstimatedShippingCost": 0,
      "GiftMessage": "string",
      "GiftNotes": "string",
      "GiftPrice": 0,
      "GiftTaxPrice": 0,
      "IsBundle": true,
      "ItemURL": "string",
      "HarmonizedCode": "string",
      "ReferenceSku": "string",
      "ReferenceProductID": 0,
      "Order": {
        "@odata.type": "ChannelAdvisor.RestApi.V1.Models.Order"
      },
      "BundleComponents": [
        {
          "@odata.type": "ChannelAdvisor.RestApi.V1.Models.OrderItemBundleComponent"
        }
      ],
      "FulfillmentItems": [
        {
          "@odata.type": "ChannelAdvisor.RestApi.V1.Models.FulfillmentItem"
        }
      ],
      "Promotions": [
        {
          "@odata.type": "ChannelAdvisor.RestApi.V1.Models.Promotion"
        }
      ],
      "Adjustments": [
        {
          "@odata.type": "ChannelAdvisor.RestApi.V1.Models.OrderItemAdjustment"
        }
      ],
      "OrderItemAttributes": [
        {
          "@odata.type": "ChannelAdvisor.RestApi.V1.Models.OrderItemAttributeValue"
        }
      ]
    }
  ]
}

Changes

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