OrderItems

Get Order

get/v1/OrderItems({ID})/Order

Request

  • Base URL: https://api.channeladvisor.com
  • URL: https://api.channeladvisor.com/v1/OrderItems({ID})/Order
  • 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 OrderItem

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": [
    {
      "ID": 0,
      "ProfileID": 0,
      "SiteID": 0,
      "SiteName": "string",
      "UserDataPresent": 0,
      "UserDataRemovalDateUTC": "0001-01-01T00:00:00.0000000+00:00",
      "SiteAccountID": 0,
      "SiteOrderID": "string",
      "SecondarySiteOrderID": "string",
      "SellerOrderID": "string",
      "CheckoutSourceID": 0,
      "Currency": "string",
      "CreatedDateUtc": "0001-01-01T00:00:00.0000000+00:00",
      "ImportDateUtc": "0001-01-01T00:00:00.0000000+00:00",
      "UpdatedDateUtc": "0001-01-01T00:00:00.0000000+00:00",
      "PublicNotes": "string",
      "PrivateNotes": "string",
      "SpecialInstructions": "string",
      "TotalPrice": 0,
      "TotalTaxPrice": 0,
      "TotalShippingPrice": 0,
      "TotalShippingTaxPrice": 0,
      "TotalInsurancePrice": 0,
      "TotalGiftOptionPrice": 0,
      "TotalGiftOptionTaxPrice": 0,
      "AdditionalCostOrDiscount": 0,
      "EstimatedShipDateUtc": "0001-01-01T00:00:00.0000000+00:00",
      "DeliverByDateUtc": "0001-01-01T00:00:00.0000000+00:00",
      "RequestedShippingCarrier": "string",
      "RequestedShippingClass": "string",
      "ResellerID": "string",
      "FlagID": 0,
      "FlagDescription": "string",
      "OrderTags": "string",
      "DistributionCenterTypeRollup": "SellerManaged",
      "CheckoutStatus": "NotVisited",
      "PaymentStatus": "NotYetSubmitted",
      "ShippingStatus": "Unshipped",
      "CheckoutDateUtc": "0001-01-01T00:00:00.0000000+00:00",
      "PaymentDateUtc": "0001-01-01T00:00:00.0000000+00:00",
      "ShippingDateUtc": "0001-01-01T00:00:00.0000000+00:00",
      "BuyerUserId": "string",
      "BuyerEmailAddress": "string",
      "BuyerEmailOptIn": true,
      "OrderTaxType": "NoTax",
      "ShippingTaxType": "NoTax",
      "GiftOptionsTaxType": "NoTax",
      "PaymentMethod": "string",
      "PaymentTransactionID": "string",
      "PaymentPaypalAccountID": "string",
      "PaymentCreditCardLast4": "string",
      "PaymentMerchantReferenceNumber": "string",
      "ShippingTitle": "string",
      "ShippingFirstName": "string",
      "ShippingLastName": "string",
      "ShippingSuffix": "string",
      "ShippingCompanyName": "string",
      "ShippingCompanyJobTitle": "string",
      "ShippingDaytimePhone": "string",
      "ShippingEveningPhone": "string",
      "ShippingAddressLine1": "string",
      "ShippingAddressLine2": "string",
      "ShippingCity": "string",
      "ShippingStateOrProvince": "string",
      "ShippingStateOrProvinceName": "string",
      "ShippingPostalCode": "string",
      "ShippingCountry": "string",
      "BillingTitle": "string",
      "BillingFirstName": "string",
      "BillingLastName": "string",
      "BillingSuffix": "string",
      "BillingCompanyName": "string",
      "BillingCompanyJobTitle": "string",
      "BillingDaytimePhone": "string",
      "BillingEveningPhone": "string",
      "BillingAddressLine1": "string",
      "BillingAddressLine2": "string",
      "BillingCity": "string",
      "BillingStateOrProvince": "string",
      "BillingStateOrProvinceName": "string",
      "BillingPostalCode": "string",
      "BillingCountry": "string",
      "PromotionCode": "string",
      "PromotionAmount": 0,
      "ShippingAddressType": "Undefined",
      "ShippingBusinessHours": [
        {
          "@odata.type": "ChannelAdvisor.RestApi.V1.Models.ShippingBusinessHour"
        }
      ],
      "Items": [
        {
          "@odata.type": "ChannelAdvisor.RestApi.V1.Models.OrderItem"
        }
      ],
      "Fulfillments": [
        {
          "@odata.type": "ChannelAdvisor.RestApi.V1.Models.Fulfillment"
        }
      ],
      "Adjustments": [
        {
          "@odata.type": "ChannelAdvisor.RestApi.V1.Models.OrderAdjustment"
        }
      ],
      "CustomFields": [
        {
          "@odata.type": "ChannelAdvisor.RestApi.V1.Models.CustomField"
        }
      ],
      "OrderAttributes": [
        {
          "@odata.type": "ChannelAdvisor.RestApi.V1.Models.OrderAttributeValue"
        }
      ],
      "Tags": [
        {
          "@odata.type": "ChannelAdvisor.RestApi.V1.Models.Tag"
        }
      ],
      "Exports": [
        {
          "@odata.type": "ChannelAdvisor.RestApi.V1.Models.ExportStatus"
        }
      ],
      "ChannelDocuments": [
        {
          "@odata.type": "ChannelAdvisor.RestApi.V1.Models.ChannelDocument"
        }
      ]
    }
  ]
}

Changes

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