Retrieve Bundle Order with Components


When to Use / Important Bundle Component Considerations

  • To only request orders where bundle component and requested fulfillment data will be displayed in the response.
  • ChannelAdvisor will display the total number of component items based on how many bundle SKUs are purchased in the order.
    • For Example: Bundle SKU "Pencil-Pack" has two SKUs: "Pencil2" which will include Qty 5 pencils and  "PencilCase" which includes Qty 1 pencil case.
    • If a buyer orders 5 "Pencil-Pack" SKUs, then the order will reflect 5 (multiplied by) each component item in the component data of the order: 25 pencils and 5 pencil cases.

Resource URL / Endpoint

GET https://api.channeladvisor.com/v1/Orders?$expand=Items($expand=BundleComponents),Fulfillments
GET https://api.channeladvisor.com/v1/Orders(OrderID)?$expand=Items($expand=BundleComponents),Fulfillments
GET https://api.channeladvisor.com/v1/Orders?$filter=ProfileID eq ProfileID&$expand=Items($expand=BundleComponents),Fulfillments

Important and/or Required Parameters

PropertyRequiredNote
ProfileIDConditionalInclude in URL. Required if need to only retrieve orders from a single profile when authorized for multiple profiles.
The ChannelAdvisor generated unique identifier for the Profile.
Replace value with numeric integer representing the ID.
OrderIDConditionalInclude in URL. Required to retrieve a specific order.
The ChannelAdvisor generated unique identifier for the Order.
When specifying the Order ID, the Profile ID is not needed since the Order ID will be unique across all profiles.
$expand=RequiredInclude in URL. Defines the expansion method for the response.
Items($expand=BundleComponents)RequiredInclude in URL. Defines expansion of the Items collection and BundleComponents collection within the Item.
FulfillmentsRequiredInclude in URL. Defines expansion of the Fulfillments collection and the Items collection within the Fulfillment.
Example Request
GET https://api.channeladvisor.com/v1/Orders(592192)?access_token=xxxxxxxxxx&$expand=Items(BundleComponents),Fulfillments
Example Result (Success)
200 OK
{
  "@odata.context": "https://api.channeladvisor.com/v1/$metadata#Orders/$entity",
  "ID": 592192,
  "ProfileID": 12345678,
  "SiteID": 640,
  "SiteName": "Amazon Seller Central - US",
  "SiteOrderID": "116-4830149-6746640",
  "SecondarySiteOrderID": null,
  "SellerOrderID": null,
  "CheckoutSourceID": null,
  "CreatedDateUtc": "2016-10-03T20:00:03Z",
  "ImportDateUtc": "2016-10-03T20:07:22.773Z",
  "PublicNotes": null,
  "PrivateNotes": "",
  "SpecialInstructions": "",
  "TotalPrice": 1341.08,
  "TotalTaxPrice": 75.91,
  "TotalShippingPrice": 0,
  "TotalShippingTaxPrice": 0,
  "TotalInsurancePrice": 0,
  "TotalGiftOptionPrice": 0,
  "TotalGiftOptionTaxPrice": 0,
  "AdditionalCostOrDiscount": 0,
  "EstimatedShipDateUtc": "2016-10-12T06:59:59Z",
  "DeliverByDateUtc": null,
  "ResellerID": null,
  "FlagID": 0,
  "FlagDescription": null,
  "OrderTags": null,
  "DistributionCenterTypeRollup": "SellerManaged",
  "CheckoutStatus": "Completed",
  "PaymentStatus": "Cleared",
  "ShippingStatus": "Unshipped",
  "CheckoutDateUtc": "2016-10-10T17:52:31.5766667Z",
  "PaymentDateUtc": "2016-10-03T20:00:03Z",
  "ShippingDateUtc": null,
  "BuyerUserId": "ra0yrbtvpcv61fz@marketplace.amazon.com",
  "BuyerEmailAddress": "ra0yrbtvpcv61fz@marketplace.amazon.com",
  "BuyerEmailOptIn": false,
  "OrderTaxType": "NoTax",
  "ShippingTaxType": "NoTax",
  "GiftOptionsTaxType": "NoTax",
  "PaymentMethod": "Amazon",
  "PaymentTransactionID": null,
  "PaymentPaypalAccountID": null,
  "PaymentCreditCardLast4": "",
  "PaymentMerchantReferenceNumber": null,
  "ShippingTitle": null,
  "ShippingFirstName": "John",
  "ShippingLastName": "Doe",
  "ShippingSuffix": null,
  "ShippingCompanyName": "",
  "ShippingCompanyJobTitle": null,
  "ShippingDaytimePhone": "1234567890",
  "ShippingEveningPhone": null,
  "ShippingAddressLine1": "426 Wellspring Dr",
  "ShippingAddressLine2": "",
  "ShippingCity": "NORCROSS",
  "ShippingStateOrProvince": "GA",
  "ShippingPostalCode": "30093-2969",
  "ShippingCountry": "US",
  "BillingTitle": "",
  "BillingFirstName": "John",
  "BillingLastName": "Doe",
  "BillingSuffix": "",
  "BillingCompanyName": "",
  "BillingCompanyJobTitle": "",
  "BillingDaytimePhone": "1234567890",
  "BillingEveningPhone": "",
  "BillingAddressLine1": "426 Wellspring Dr",
  "BillingAddressLine2": "",
  "BillingCity": "NORCROSS",
  "BillingStateOrProvince": "GA",
  "BillingPostalCode": "30093-2969",
  "BillingCountry": "US",
  "PromotionCode": null,
  "PromotionAmount": 0,
  "Items": [
	{
	  "ID": 525529,
	  "ProfileID": 12345678,
	  "OrderID": 592192,
	  "ProductID": 2152403,
	  "SiteOrderItemID": "01960343741018",
	  "SiteListingID": "32664640",
	  "Sku": "1-4649-1",
	  "Title": "Commercial Bed Bug Kit",
	  "Quantity": 1,
	  "UnitPrice": 331.83,
	  "TaxPrice": 19.91,
	  "ShippingPrice": 0,
	  "ShippingTaxPrice": 0,
	  "RecyclingFee": 0,
	  "GiftMessage": null,
	  "GiftNotes": null,
	  "GiftPrice": 0,
	  "GiftTaxPrice": 0,
	  "IsBundle": true,
	  "ItemURL": "",
	  "BundleComponents": [
		{
		  "OrderID": 592192,
		  "OrderItemID": 525529,
		  "ProductID": 2140041,
		  "ProfileID": 12345678,
		  "BundleProductID": 2152403,
		  "Sku": "4649",
		  "BundleSku": "1-4649-1",
		  "Title": "",
		  "Quantity": 1
		},
		{
		  "OrderID": 592192,
		  "OrderItemID": 525529,
		  "ProductID": 2147259,
		  "ProfileID": 12345678,
		  "BundleProductID": 2152403,
		  "Sku": "0D",
		  "BundleSku": "1-4649-1",
		  "Title": "Safety Pamphlet",
		  "Quantity": 1
		}
	  ]
	},
	{
	  "ID": 525530,
	  "ProfileID": 12345678,
	  "OrderID": 592192,
	  "ProductID": 2147884,
	  "SiteOrderItemID": "50394998882554",
	  "SiteListingID": "32664641",
	  "Sku": "4-100-2",
	  "Title": "BORACARE (Pack of 4)",
	  "Quantity": 2,
	  "UnitPrice": 466.67,
	  "TaxPrice": 56,
	  "ShippingPrice": 0,
	  "ShippingTaxPrice": 0,
	  "RecyclingFee": 0,
	  "GiftMessage": null,
	  "GiftNotes": null,
	  "GiftPrice": 0,
	  "GiftTaxPrice": 0,
	  "IsBundle": true,
	  "ItemURL": "",
	  "BundleComponents": [
		{
		  "OrderID": 592192,
		  "OrderItemID": 525530,
		  "ProductID": 2147256,
		  "ProfileID": 12345678,
		  "BundleProductID": 2147884,
		  "Sku": "0A",
		  "BundleSku": "4-100-2",
		  "Title": "Safety Pamphlet",
		  "Quantity": 4
		},
		{
		  "OrderID": 592192,
		  "OrderItemID": 525530,
		  "ProductID": 2147294,
		  "ProfileID": 12345678,
		  "BundleProductID": 2147884,
		  "Sku": "100",
		  "BundleSku": "4-100-2",
		  "Title": "BORACARE",
		  "Quantity": 8
		}
	  ]
	}
  ],
  "Fulfillments": [
	{
	  "ID": 501854,
	  "ProfileID": 12345678,
	  "OrderID": 592192,
	  "CreatedDateUtc": "2016-10-10T18:37:20.66Z",
	  "UpdatedDateUtc": "2016-10-10T18:37:20.4466667Z",
	  "Type": "Ship",
	  "DeliveryStatus": "NoChange",
	  "TrackingNumber": null,
	  "ShippingCarrier": "Amazon Merchants@",
	  "ShippingClass": "Standard",
	  "DistributionCenterID": 0,
	  "ShippedDateUtc": null,
	  "SellerFulfillmentID": null
	}
  ]
}