Related Order Entities

This page contains a view of related Order entities, entity relationships, when a property is populated, and who supplies the data for the property.

The following order entities are indirectly-related, but have no direct relationship to other entities, and are only included in the Order Entities page.

  • ShipOrderRequest
  • ShipOrderRequestItem
  • AmazonVATInvoiceDocument
  • NotSuppliedAmazonVATInvoiceDocument

How to Read This Page

Actual values provided by marketplace will vary, therefore code to expect the field type as we have defined it.

  • See this page on Marketplace-Specific Order Responses to get an idea of what format these properties will be populated with.
  • Note: the Order examples are limited to expanding Items and Fulfillments Only, as these have the most variable field data.

Important Note: when a field is Always Populated = "No" or "Conditional No",  expect a null or "" (blank) value, but cases where Data Source contains "Marketplace", a value may be provided.

  • The only exception to this design will be when viewing a Pending Order.

Complete Order Entity Table

Property NameParent Entity NameType (Max Length)Always PopulatedData SourceDescription
ID n/ainteger (32 bit)YesChannelAdvisorUniquely identifies the order within the ChannelAdvisor account (note: this is not the marketplace Order ID).
ProfileID n/ainteger (32 bit)YesChannelAdvisorIdentifies the ChannelAdvisor account.
SiteID n/ainteger (32 bit)YesChannelAdvisorIdentifies the origin of the order, such as a marketplace. See list of potential values on the Order Site ID & Site Name Values page.
SiteNamen/astring (50)YesChannelAdvisorName of the origin marketplace or webstore of the order. The default value is 'Checkout Direct'.
UserDataPresentn/abyteYesChannelAdvisorDefault is 1 at initial import of order data. Set to 0 when user data has been removed. Specific marketplaces ask that user data be removed after a certain time frame.
UserDataRemovalDateUTCn/aDateTimeOffsetNoChannelAdvisorThe date the user data was removed.
SiteAccountIDn/ainteger (32 bit)NoChannelAdvisorIdentifies the seller account on the marketplace or webstore. The list of marketplace accounts can be retrieved from the Profiles endpoint. May be null.
SiteOrderIDn/astring (125)YesMarketplaceOrder identifier provided by the origin of the order. This is usually the marketplace Order ID.
SecondarySiteOrderIDn/astring (700)NoMarketplaceSecondary identifier provided by the origin of the order. This is a secondary marketplace-generated Order ID. Will not be populated most of the time.
SellerOrderIDn/astring (25)NoSellerIdentifier provided by the seller in PATCH/PUT or if seller creates an order.
CheckoutSourceIDn/abyteNoMarketplace Identifies the checkout system used to place the order.
Currencyn/astring (3)YesChannelAdvisor or MarketplaceIdentifies the currency used in the order transaction
ImportDateUtcn/aDateTimeOffsetYesChannelAdvisorTimestamp when the order was imported into ChannelAdvisor.
CreatedDateUtcn/aDateTimeOffsetYesMarketplaceTimestamp when the order was created at the origin of the order.
LastUpdatedDateUtcn/aDateTimeOffsetYesChannelAdvisorTimestamp when the order was last updated. Refer to Last Updated Date Utc for more context.
PublicNotesn/astring (4,000)NoMarketplace Notes from the seller which may be included in a printed invoice or packing slip.
PrivateNotesn/astring (4,000)No Marketplace Notes from the seller which cannot be included in a printed invoice or packing slip.
SpecialInstructionsn/astringNoMarketplaceNotes provided by the buyer, usually pertaining to shipping instructions.
TotalPricen/adecimalYesMarketplaceTotal price paid by the buyer.
TotalTaxPricen/adecimalNoMarketplaceSubtotal of all tax costs, including shipping, and gift taxes.
TotalShippingPricen/adecimalNoMarketplaceSubtotal of all shipping costs.
Does not include exclusive tax.
Does not include shipping item-level shipping promotions. 
TotalShippingTaxPricen/adecimalNoMarketplaceSubtotal of all shipping tax costs.
TotalInsurancePricen/adecimalNoMarketplaceSubtotal of all insurance costs.
TotalGiftOptionPricen/adecimalNoMarketplaceSubtotal of all gift option costs. Does not include exclusive tax.
TotalGiftOptionTaxPricen/adecimalNoMarketplaceSubtotal of all gift option tax costs.
AdditionalCostOrDiscountn/adecimalNoMarketplaceMiscellaneous cost modification which may be positive to indicate a cost or negative to indicate a discount.
EstimatedShipDateUtcn/aDateTimeOffsetNoMarketplaceTimestamp estimating when the order will be fulfilled.
DeliverByDateUtcn/aDateTimeOffsetNoMarketplaceTimestamp indicating the deadline for fulfilling the order.
RequestedShippingCarriern/astring (50)NoMarketplaceOriginal requested shipping carrier provided by the origin of the order.
RequestedShippingClassn/astring (50)NoMarketplaceOriginal requested shipping class provided by the origin of the order.
ResellerIDn/astring (255)NoMarketplaceIdentifier for a reseller agency.
FlagIDn/aenumNoSellerIdentifies the flag type, if any.
FlagDescriptionn/astring (80)NoSellerDescribes the flag.
CheckoutStatusn/aenumYesMarketplaceIndicates the progress of the order through the checkout process.
PaymentStatusn/aenumYesMarketplaceIndicates the progress of the payment.
ShippingStatusn/aenumYesMarketplaceIndicates the progress of the fulfillment on the order.
CheckoutDateUtcn/aDateTimeOffsetYesMarketplaceTimestamp indicating the latest update to CheckoutStatus.
PaymentDateUtcn/aDateTimeOffsetYesMarketplaceTimestamp indicating the latest update to PaymentStatus.
ShippingDateUtcn/aDateTimeOffsetYesChannelAdvisor or MarketplaceTimestamp indicating the latest update to ShippingStatus.
BuyerUserIdn/astring (255)NoMarketplaceThe UserID of the buyer
BuyerEmailAddressn/astring (255)YesMarketplaceThe email address of the buyer.
BuyerEmailOptInn/abooleanYesMarketplaceIndicates if the buyer wishes to opt in for marketing emails.
OrderTaxTypen/aenumYesChannelAdvisorThe type of tax applied to the item costs.
ShippingTaxTypen/aenumYesChannelAdvisorThe type of tax applied to the shipping costs.
GiftOptionsTaxTypen/aenumYesChannelAdvisorThe type of tax applied to the gift option costs.
PaymentMethodn/astring (50)YesMarketplaceThe type of payment submitted by the buyer.
PaymentTransactionIDn/astring (255)NoMarketplaceThe TransactionID of the payment.
PaymentPaypalAccountIDn/astring (255)NoMarketplaceThe PayPal AccountID of the buyer.
PaymentCreditCardLast4n/astring (4)NoMarketplaceThe last four digits of the credit card number.
PaymentMerchantReferenceNumbern/astring (50)NoMarketplaceThe reference number of the payment.
ShippingTitlen/astring (20)NoMarketplaceThe shipping recipient's title.
ShippingFirstNamen/astring (50)NoMarketplaceThe shipping recipient's first name.
ShippingLastNamen/astring (50)NoMarketplaceThe shipping recipient's last name.
ShippingSuffixn/astring (20)NoMarketplaceThe shipping recipient's name suffix.
ShippingCompanyNamen/astring (50)NoMarketplaceThe shipping recipient's company name.
ShippingCompanyJobTitlen/astring (50)NoMarketplaceThe shipping recipient's job title.
ShippingDaytimePhonen/astring (40)NoMarketplaceThe shipping recipient's daytime phone number.
ShippingEveningPhonen/astring (40)NoMarketplaceThe shipping recipient's evening phone number.
ShippingAddressLine1n/astring (75)NoMarketplaceThe first line of the shipping address.
ShippingAddressLine2n/astring (75)NoMarketplaceThe second line of the shipping address.
ShippingCityn/astring (100)NoMarketplaceThe city of the shipping address.
ShippingStateOrProvincen/astring (100)NoMarketplaceThe region of the shipping address.
ShippingStateOrProvinceNamen/astring (255)NoMarketplaceThe full name of the shipping address region
ShippingPostalCoden/astring (15)NoMarketplaceThe postal code of the shipping address.
ShippingCountryn/astring (10)NoMarketplaceThe country of the shipping address. ISO format.
Required if ShippingStateOrProvince is provided.  
BillingTitlen/astring (20)NoMarketplaceThe payer's title.
BillingFirstNamen/astring (50)NoMarketplaceThe payer's first name.
BillingLastNamen/astring (50)NoMarketplaceThe payer's last name.
BillingSuffixn/astring (20)NoMarketplaceThe payer's name suffix.
BillingCompanyNamen/astring (50)NoMarketplaceThe payer's company name.
BillingCompanyJobTitlen/astring (50)NoMarketplaceThe payer's job title.
BillingDaytimePhonen/astring (40)NoMarketplaceThe payer's daytime phone.
BillingEveningPhonen/astring (40)NoMarketplaceThe payer's evening phone.
BillingAddressLine1n/astring (100)NoMarketplaceThe first line of the billing address.
BillingAddressLine2n/astring (100)NoMarketplaceThe second line of the billing address.
BillingCityn/astring (100)NoMarketplaceThe city of the billing address.
BillingStateOrProvincen/astring (100)NoMarketplaceThe region of the billing address.
BillingStateOrProvinceNamen/astring (255)NoMarketplaceThe full name of the billing address region
BillingPostalCoden/astring (15)NoMarketplaceThe postal code of the billing address.
BillingCountryn/astring (10)NoMarketplaceThe country of the billing address. ISO format.
Required if BillingStateOrProvince is provided. 
PromotionCoden/astring (20)NoMarketplaceThe order-level promotional discount code.
PromotionAmountn/adecimalNoMarketplaceThe order-level discount amount.
OrderTagsn/astring (300)NoChannelAdvisorComma-delimited list of all tags applied to the order.
See potential values and descriptions 
DistributionCenterTypeRollupn/aenumYesChannelAdvisorThe type of distrbution center.
Items (Collection)OrderOrderItem[]YesMarketplaceThe purchased items.
Fulfillments (Collection)OrderFulfillment[]YesMarketplaceThe fulfilled items.
Adjustments (Collection)OrderOrderAdjustment[]NoSeller or MarketplaceThe cancellations and refunds on the order.
CustomFields (Collection)OrderCustomField[]NoChannelAdvisorAdditional information pertaining to the order.
IDItemsinteger (32 bit)YesChannelAdvisorUniquely identifies the order item within the ChannelAdvisor account.
ProfileIDItemsinteger (32 bit)YesChannelAdvisorIdentifies the ChannelAdvisor account.
OrderIDItemsinteger (32 bit)YesChannelAdvisorUniquely identifies the order within the ChannelAdvisor account.
ProductIDItemsinteger (32 bit)YesChannelAdvisorUniquely identifies the product within the ChannelAdvisor account.
SiteOrderItemIDItemsstring (50)NoMarketplaceOrder item identifier provided by the origin of the order.
SiteListingIDItemsstring (50)NoMarketplaceListing identifier provided by the origin of the order.
SellerOrderItemIDItemsstring (50)NoSellerOrder item identifier provided by the seller.
SkuItemsstring (50)YesMarketplaceProduct identifier provided by the seller.
TitleItemsstring (120)YesMarketplaceTitle of the order item.
QuantityItemsinteger (32 bit)YesMarketplaceThe number of units purchased.
UnitPriceItemsdecimalYesMarketplaceThe cost per unit.
TaxPriceItemsdecimalNoMarketplaceThe tax cost for all quantity.
ShippingPriceItemsdecimalNoMarketplaceThe shipping cost for all quantity.
ShippingTaxPriceItemsdecimalNoMarketplaceThe shipping tax cost for all quantity.
RecyclingFeeItemsdecimalNoMarketplaceThe recycling and waste fee for all quantity.
UnitEstimatedShippingCostItemsdecimalNoChannelAdvisorThe estimated unit cost of shipping.
GiftMessageItemsstring (500)NoMarketplaceThe message to accompany gift wrapping.
GiftNotesItemsstring (40)NoMarketplaceDescription of the gift wrapping.
GiftPriceItemsdecimalNoMarketplaceThe gift wrapping cost for all quantity.
GiftTaxPriceItemsdecimalNoMarketplaceThe gift wrapping tax cost for all quantity.
IsBundleItemsbooleanNoMarketplaceIndicates if the order item is a bundle.
ItemURLItemsstring (256)NoMarketplaceThe URL of the order item on the origin website.
HarmonizedCodeItemsstring (20)NoMarketplace or ChannelAdvisorThe harmonized code of the order item
Promotions (Collection)ItemsPromotion[]ConditionalMarketplaceCollection name always exists. Sub-properties only exist when Promotion exists.
Discounts applied to the costs of the order item.
FulfillmentItems (Collection)ItemsFulfillmentItem[]YesChannelAdvisorThe fulfilled items corresponding to the purchased order item.
BundleComponents (Collection)ItemsOrderItemBundleComponents[]ConditionalChannelAdvisorCollection name always exists. Sub-properties only exist when item ordered is Bundle or Bundle SKU.
The component items, if the order item is a bundle.
Adjustments (Collection)ItemsOrderItemAdjustment[]ConditionalMarketplace or SellerCollection name always exists. Sub-properties only exist when an Adjustment exists.
When an adjustment exists. Cancellations and refunds on the order item.
IDFulfillmentsinteger (32 bit)YesChannelAdvisorUniquely identifies the fulfillment within the ChannelAdvisor account.
ProfileIDFulfillmentsinteger (32 bit)YesChannelAdvisorUniquely identifies the ChannelAdvisor account.
OrderIDFulfillmentsinteger (32 bit)YesChannelAdvisorUniquely identifies the order within the ChannelAdvisor account.
CreatedDateUtcFulfillmentsDateTimeOffsetYesChannelAdvisorTimestamp when the fulfillment was created.
UpdatedDateUtcFulfillmentsDateTimeOffsetYesChannelAdvisorTimestamp when the fulfillment was last updated.
TypeFulfillmentsenumYesChannelAdvisorIndicates how the items will be fulfilled.
DeliveryStatusFulfillmentsenumYesChannelAdvisorIndicates the progress of the fulfillment.
TrackingNumberFulfillmentsstring (50)NoSellerProvided by a shipping carrier to track the progress of a shipment.
Note: Many marketplaces require this data, and require it to be valid to consider the order fulfilled.
ReturnTrackingNumberFulfillmentsstring (50)NoSellerProvided by a shipping carrier to track the progress of a return shipment.
Note: Many marketplaces require this data while marking the order/item as shipped, and require it to be valid to consider the order fulfilled.
ShippingCarrierFulfillmentsstring (50)NoMarketplaceIdentifies the shipping carrier or agent of delivery.
ShippingClassFulfillmentsstring (50)NoMarketplaceIdentifies the class of shipment or delivery.
DistributionCenterIDFulfillmentsinteger (32 bit)YesChannelAdvisorIdentifies the distribution center from which the fulfillment will originate.
ExternalFulfillmentCenterCodeFulfillmentsstringConditionalMarketplaceIdentifies the distribution center code generated by the marketplace. Does not apply to all marketplaces, and does not apply to Multi-Channel FBA (Fulfillment by Amazon)
ExternalFulfillmentStatusFulfillmentsenumConditionalChannelAdvisorIdentifies status of communication to external fulfillment partner
ExternalFulfillmentNumberFulfillmentsstring (50)NoChannelAdvisorIdentifies the fulfillment number as provided by the external fulfillment partner
ExternalFulfillmentReferenceNumberFulfillmentsstring (50)NoChannelAdvisorIdentifies the fulfillment reference number as provided by the external fulfillment partner
ShippingCostFulfillmentsdecimalNoChannelAdvisor or SellerThe amount paid by the seller for shipping services, minus tax and insurance
InsuranceCostFulfillmentsdecimalNoChannelAdvisor or SellerThe amount paid by the seller for shipment insurance
TaxCostFulfillmentsdecimalNoChannelAdvisor or SellerThe amount paid by the seller for taxes on shipping services
ShippedDateUtcFulfillmentsDateTimeOffsetNoSellerTimestamp when the fulfillment was sent.
SellerFulfillmentIDFulfillmentsstring (50)NoSellerIdentifier provided by the seller. Amazon only allows integers.
HasShippingLabelFulfillmentsbooleanYesChannelAdvisorIndicates if a shipping label has been generated through ChannelAdvisor.
HasChannelPackingSlipFulfillmentsbooleanYesChannelAdvisorTrue when the Channel / Marketplace supplied a packing slip document with the order.
HasReturnLabelFulfillmentsbooleanYesChannelAdvisorTrue when a return label has been created via the ChannelAdvisor Shipping Management software.
HasChannelReturnLabelFulfillmentsbooleanYesChannelAdvisorTrue when the Channel / Marketplace supplied a return label document with the order.
ExternalFulfillmentNumberFulfillmentsstring (50)NoChannelAdvisorIdentifies the fulfillment number as provided by the external fulfillment partner
ExternalFulfillmentReferenceNumberFulfillmentsstring (50)NoChannelAdvisorIdentifies the fulfillment reference number as provided by the external fulfillment partner
ShippingLabelRequestIDFulfillmentsstring (50)NoSellerSeller defined unique identifier for label purchase.
StagingLocationFulfillmentsstring (255)NoSellerSeller defined location where the item will be available for retrieval.
LabelFormatFulfillmentsenumNoChannelAdvisorFormat of the Shipping Label. Valid values are "PDF" or "ZPL".
ReturnLabelFormatFulfillmentsenumNoChannelAdvisorFormat of the Return Label. Valid values are "PDF" or "ZPL".
ChannelReturnLabelFormatFulfillmentsenumNoChannelAdvisorFormat of the Channel Return Label. Valid values are "PDF" or "ZPL".
Items (Collection)OrderFulfillmentItem[]YesChannelAdvisorThe fulfilled items which comprise the fulfillment.
IDFulfillmentItems and Items and BundleComponentsinteger (32 bit)YesChannelAdvisorUniquely identifies the fulfillment item within the ChannelAdvisor system.
ProfileIDFulfillmentItems and Items and BundleComponentsinteger (32 bit)YesChannelAdvisorUniquely identifies the ChannelAdvisor account.
FulfillmentIDFulfillmentItems and Items and BundleComponentsinteger (32 bit)YesChannelAdvisorUniquely identifies the fulfillment within the ChannelAdvisor account.
OrderIDFulfillmentItems and Items and BundleComponentsinteger (32 bit)YesChannelAdvisorUniquely identifies the order within the ChannelAdvisor account.
OrderItemIDFulfillmentItems and Items and BundleComponentsinteger (32 bit)YesChannelAdvisorUniquely identifies the order item within the ChannelAdvisor account.
QuantityFulfillmentItems and Items and BundleComponentsinteger (32 bit)YesMarketplaceThe number of units.
ProductIDFulfillmentItems and Items and BundleComponentsinteger (32 bit)YesChannelAdvisorUniquely identifies the product within the ChannelAdvisor account.
SellerFulfillmentItemIDFulfillmentItemsstring (50)NoSellerIdentifier provided by the seller. Usually a serial number or batch number.
MarketplaceShippingStatusFulfillmentItemsenumYesChannelAdvisorCommunication status of shipping information between ChannelAdvisor and marketplace.
DistributionCenterItemUnitCostFulfillmentItemsdecimalConditional3rd PartyUnit cost of a single item in the fulfillment supplied by external resource.
DistributionCenterShippingCostFulfillmentItemsdecimalConditional3rd PartyTotal shipping cost of the fulfillment supplied by external resource.
DistributionCenterCalculatedItemUnitCostFulfillmentItemsdecimalConditionalChannelAdvisorChannelAdvisor calculated Unit Item Cost - defined in Lowest Cost order routing rules.
DistributionCenterCalculatedShippingCostFulfillmentItemsdecimalConditionalChannelAdvisorChannelAdvisor calculated Shipping Cost - defined in Lowest Cost order routing rules.
CreatedSourceAdjustments (Under Items)enumConditionalChannelAdvisorIdentifies the system that generated the adjustment.
LastUpdatedSourceAdjustments (Under Items)enumConditionalChannelAdvisorIdentifies the system that last updated the adjustment.
IDAdjustments (Under Items)integer (32 bit)ConditionalChannelAdvisorProperty only exists when an Item Adjustment exists. Uniquely identifies the order item adjustment within the ChannelAdvisor system.
ProfileID Adjustments (Under Items)integer (32 bit)ConditionalChannelAdvisorProperty only exists when an Item Adjustment exists. Uniquely identifies the ChannelAdvisor account.
OrderID Adjustments (Under Items)integer (32 bit)ConditionalChannelAdvisorProperty only exists when an Item Adjustment exists. Uniquely identifies the order within the ChannelAdvisor account.
OrderItemID Adjustments (Under Items)integer (32 bit)ConditionalChannelAdvisorProperty only exists when an Item Adjustment exists. Uniquely identifies the order item within the ChannelAdvisor system.
Quantity Adjustments (Under Items)integer (32 bit)ConditionalSeller or MarketplaceProperty only exists when an Item Adjustment exists. Then number of units being adjusted.
IsRestockAdjustments (Under Items)booleanConditionalSeller or Marketplace or
ChannelAdvisor 

Property only exists when an Item Adjustment exists.
Indicates the adjusted quantity should be added back to available quantity.
Send in POST Adjust requests s as "Restock"
Defaults to 'false' if property is not provided. 

ReasonAdjustments (Under Items)enumConditional

Seller or Marketplace or
ChannelAdvisor 

Property only exists when an Item Adjustment exists.
Indicates why the adjustment was requested.
In POST Adjust requests, defaults to "GeneralAdjustment" if property is not provided.
PreventSiteProcessingAdjustments (Under Items)booleanConditionalSeller or Marketplace or
ChannelAdvisor 
Property only exists when an Item Adjustment exists.
Indicates if the adjustment will be sent to the marketplace.
Defaults to 'false' if property is not provided.  
ItemAdjustmentAdjustments (Under Items)decimalConditionalSeller or MarketplaceProperty only exists when an Item Adjustment exists. The amount returned from item costs.
TaxAdjustmentAdjustments (Under Items)decimalConditionalSeller or MarketplaceProperty only exists when an Item Adjustment exists. The amount returned from item tax costs.
ShippingAdjustmentAdjustments (Under Items)decimalConditionalSeller or MarketplaceProperty only exists when an Item Adjustment exists. The amount returned from shipping costs.
ShippingTaxAdjustmentAdjustments (Under Items)decimalConditionalSeller or MarketplaceProperty only exists when an Item Adjustment exists. The amount returned from shipping tax costs.
GiftWrapAdjustmentAdjustments (Under Items)decimalConditionalSeller or MarketplaceProperty only exists when an Item Adjustment exists. The amount returned from gift wrap costs.
GiftWrapTaxAdjustmentAdjustments (Under Items)decimalConditionalSeller or MarketplaceProperty only exists when an Item Adjustment exists. The amount returned from gift wrap tax costs.
RecyclingFeeAdjustmentAdjustments (Under Items)decimalConditionalSeller or MarketplaceProperty only exists when an Item Adjustment exists. The amount returned from recycling and waste fees.
TypeAdjustments (Under Items)enumConditionalChannelAdvisorProperty only exists when an Item Adjustment exists. Indicates which kind of adjustment was requested.
SellerAdjustmentIDAdjustments (Under Items)string (50)Conditional NoSellerProperty only exists when an Item Adjustment exists. Identifier provided by the seller.
SiteAdjustmentIDAdjustments (Under Items)string (50)NoMarketplaceIdentifier provided by the origin of the order.
AdjustmentTransactionIDAdjustments (Under Items)string (255)NoMarketplaceIdentifier supplied by external source - e.g. PayPal Refund Transaction ID
RmaNumberAdjustments (Under Items)string (50)Conditional NoSellerRMA Number for Buyer Initiated Returns.
CommentAdjustments (Under Items)string (400)Conditional NoChannelAdvisorProperty only exists when an Item Adjustment exists. Notes on the adjustment.
PublicNotesAdjustments (Under Items)string (4,000)NoSellerValue to appear in ChannelAdvisor Order UI under Order History.
CreatedDateUtcAdjustments (Under Items)DateTimeOffsetConditionalChannelAdvisorProperty only exists when an Item Adjustment exists. Timestamp when the adjustment was created.
RequestStatusAdjustments (Under Items)enumConditional NoChannelAdvisorProperty only exists when an Item Adjustment exists. The progress of the adjustment.
RestockStatusAdjustments (Under Items)enumConditional NoChannelAdvisorProperty only exists when an Item Adjustment exists. The progress of the restock operation.
ReturnShippingFeeAdjustments (Under Items)decimalNoMarketplaceFee charged to return the item
RestockingFeeAdjustments (Under Items)decimalNoMarketplaceFee charged to restock the item
ReturnTrackingNumberOrUrlAdjustments (Under Items)string (256)NoMarketplaceTracking number or tracking URL of the return shipment
ReturnShippingMethodAdjustments (Under Items)string (100)NoMarketplaceShipping method of the return shipment
OrderItemID BundleComponents (Under Items)integer (32 bit)ConditionalChannelAdvisorProperty only exists when bundle exists. Uniquely identifies the order item within the ChannelAdvisor account.
ProfileID BundleComponents (Under Items)integer (32 bit)ConditionalChannelAdvisorProperty only exists when bundle exists. Uniquely identifies the ChannelAdvisor account.
OrderID BundleComponents (Under Items)integer (32 bit)ConditionalChannelAdvisorProperty only exists when bundle exists. Uniquely identifies the order within the ChannelAdvisor account.
ProductID BundleComponents (Under Items)integer (32 bit)ConditionalChannelAdvisorProperty only exists when bundle exists. Uniquely identifies the product within the ChannelAdvisor account.
BundleProductID BundleComponents (Under Items)integer (32 bit)ConditionalChannelAdvisorProperty only exists when bundle exists. Uniquely identifies the bundle to which the component belongs within the ChannelAdvisor account.
SkuBundleComponents (Under Items)string (50)ConditionalMarketplaceProperty only exists when bundle exists. Identifier for the component product provided by the seller.
BundleSkuBundleComponents (Under Items)string (50)ConditionalMarketplaceProperty only exists when bundle exists. Identifier for the bundle product provided by the seller.
TitleBundleComponents (Under Items)string (120)ConditionalMarketplaceProperty only exists when bundle exists. Title of the component.
Quantity BundleComponents (Under Items)integer (32 bit)ConditionalMarketplaceProperty only exists when bundle exists. The number of units ordered (value is provided in the order already multiplied by OrderItem Quantity for the Bundle Sku).
FulfillmentItemsBundleComponents (Under Items)FulfillmentItems[]ConditionalChannelAdvisorProperty only exists when bundle exists. The fulfilled items related to the component.
ID Promotions (Under Items)integer (32 bit)ConditionalChannelAdvisorProperty only exists when a Promotion exists. Uniquely identifies the promotion within the ChannelAdvisor account.
CodePromotions (Under Items)string (20)ConditionalMarketplaceProperty only exists when a Promotion exists. The code submitted to enable the discount.
Amount Promotions (Under Items)decimalConditionalMarketplaceProperty only exists when a Promotion exists. The discount to the item cost. Will be negative.
ShippingAmount Promotions (Under Items)decimalConditionalMarketplaceProperty only exists when a Promotion exists. The discount to the shipping cost. Will be negative.
FieldID CustomFields (Under Items)integer (32 bit)ConditionalChannelAdvisorProperty only exists when non-standard properties can be applied. Identifies the custom field.
OrderID CustomFields (Under Items)integer (32 bit)ConditionalChannelAdvisorProperty only exists when non-standard properties can be applied. Uniquely identifies the order within the ChannelAdvisor system.
ProfileID CustomFields (Under Items)integer (32 bit)ConditionalChannelAdvisorProperty only exists when non-standard properties can be applied. Uniquely identifies the ChannelAdvisor account.
ValueCustomFields (Under Items)string (4,000)ConditionalMarketplaceProperty only exists when non-standard properties can be applied. The value of the custom field.
CreatedSourceAdjustments (Under the Order)enumConditionalChannelAdvisorIdentifies the system that generated the adjustment.
LastUpdatedSourceAdjustments (Under the Order)enumConditionalChannelAdvisorIdentifies the system that last updated the adjustment.
ID Adjustments (Under the Order)integer (32 bit)ConditionalChannelAdvisorProperty only exists when an Order Adjustment exists. Uniquely identifies the adjustment within the ChannelAdvisor account.
ProfileID Adjustments (Under the Order)integer (32 bit)ConditionalChannelAdvisorProperty only exists when an Order Adjustment exists. Uniquely identifies the ChannelAdvisor account.
OrderID Adjustments (Under the Order)integer (32 bit)ConditionalChannelAdvisorProperty only exists when an Order Adjustment exists. Uniquely identifies the order within the ChannelAdvisor account.
IsRestockAdjustments (Under the Order)booleanConditionalSeller or Marketplace or
ChannelAdvisor 
Property only exists when an Order Adjustment exists. Indicates the adjusted quantity should be added back to available quantity.
Send in POST Adjust requests as "Restock"
Defaults to 'false' if property is not provided.
ReasonAdjustments (Under the Order)enumConditionalSeller or Marketplace or
ChannelAdvisor 
Property only exists when an Order Adjustment exists. Indicates why the adjustment was requested.
In POST Adjust requests, defaults to "GeneralAdjustment" if property is not provided.
PreventSiteProcessingAdjustments (Under the Order)booleanConditionalSeller or Marketplace or
ChannelAdvisor 

Property only exists when an Order Adjustment exists. Indicates if the adjustment will be sent to the marketplace.
Defaults to 'false' if property is not provided. 

ItemAdjustmentAdjustments (Under the Order)decimalConditionalSeller or MarketplaceProperty only exists when an Order Adjustment exists. The amount returned from item costs.
Send in POST Adjust requests as "AdjustmentAmount" 
TaxAdjustmentAdjustments (Under the Order)decimalConditionalSeller or MarketplaceProperty only exists when an Order Adjustment exists. The amount returned from item tax costs. Cannot be set with POST or PATCH, send all values in "AdjustmentAmount".
ShippingAdjustmentAdjustments (Under the Order)decimalConditionalSeller or MarketplaceProperty only exists when an Order Adjustment exists. The amount returned from shipping costs.
Cannot be set with POST or PATCH, send all values in "AdjustmentAmount". 
ShippingTaxAdjustmentAdjustments (Under the Order)decimalConditionalSeller or MarketplaceProperty only exists when an Order Adjustment exists. The amount returned from shipping tax costs. Cannot be set with POST or PATCH, send all values in "AdjustmentAmount".
GiftWrapAdjustmentAdjustments (Under the Order)decimalConditionalSeller or MarketplaceProperty only exists when an Order Adjustment exists. The amount returned from gift wrap costs.
Cannot be set with POST or PATCH, send all values in "AdjustmentAmount". 
GiftWrapTaxAdjustmentAdjustments (Under the Order)decimalConditionalSeller or MarketplaceProperty only exists when an Order Adjustment exists. The amount returned from gift wrap tax costs. Cannot be set with POST or PATCH, send all values in "AdjustmentAmount".
RecyclingFeeAdjustmentAdjustments (Under the Order)decimalConditionalSeller or MarketplaceProperty only exists when an Order Adjustment exists. The amount returned from recycling and waste fees. Cannot be set with POST or PATCH, send all values in "AdjustmentAmount".
TypeAdjustments (Under the Order)enumConditionalChannelAdvisorProperty only exists when an Order Adjustment exists. Indicates which kind of adjustment was requested. Cannot be set with POST or PATCH, send all values in "AdjustmentAmount".
SellerAdjustmentIDAdjustments (Under the Order)string (50)Conditional NoSellerProperty only exists when an Order Adjustment exists. Identifier provided by the seller.
SiteAdjustmentIDAdjustments (Under the Order)string (50)NoMarketplaceIdentifier provided by the origin of the order.
AdjustmentTransactionIDAdjustments (Under the Order)string (255)NoMarketplaceIdentifier supplied by external source - e.g. PayPal Refund Transaction ID
RmaNumberAdjustments (Under the Order)string (50)Conditional NoSellerRMA Number for Buyer Initiated Returns.
CommentAdjustments (Under the Order)string (400)Conditional NoChannelAdvisorProperty only exists when an Order Adjustment exists. Notes on the adjustment.
PublicNotesAdjustments (Under the Order)string (4,000)NoSellerValue to appear in ChannelAdvisor Order UI under Order History.
CreatedDateUtcAdjustments (Under the Order)DateTimeOffsetConditionalChannelAdvisorProperty only exists when an Order Adjustment exists. Timestamp when the adjustment was created.
RequestStatusAdjustments (Under the Order)enumConditionalChannelAdvisorProperty only exists when an Order Adjustment exists. The progress of the adjustment.
RestockStatusAdjustments (Under the Order)enumConditional NoChannelAdvisorProperty only exists when an Order Adjustment exists. The progress of the restock operation.
ReturnShippingFeeAdjustments (Under the Order)decimalNoMarketplaceFee charged to return items
RestockingFeeAdjustments (Under the Order)decimalNoMarketplaceFee charged to restock items
ReturnTrackingNumberOrUrlAdjustments (Under the Order)string (256)NoMarketplaceTracking number or tracking URL of the return shipment
ReturnShippingMethodAdjustments (Under the Order)string (100)NoMarketplaceShipping method of the return shipment

ShippingRates & Purchase Label

PropertyParent Entity NameType (Max Length)Always PopulatedData SourceDescription
Itemsn/aShippingItems[]YesSellerItems to be included in the package
ShippingLabelPartnerAccountIDsn/ainteger[]YesSellerThe unique ID that identifies the shipping partner.
PackageIDn/ainteger (nullable)NoSellerUniquely identifies the package within the ChannelAdvisor account.
DeliverByDateUtcn/aDateTimeOffset (nullable)NoSellerTimestamp indicating the deadline for fulfilling the order.
DeliveryConfirmationn/aenumYesSellerValid values are: Default, SignatureRequired, AdultSignaturedRequired, NoDeliveryConfirmation
DistributionCenterIDn/ainteger (nullalble)NoSellerIdentifies the distribution center from which the fulfillment will originate.
InsuredAmountn/adecimal (nullable)NoSellerInsurance amount for the package
LabelFormatn/aenumYesSellerValid values are: PDF, ZPL. The default value is PDF
ShipDateUtcn/aDateTimeOffset (nullable)NoSellerTimestamp estimating when the order will be fulfilled.
MeasurementUnitn/aenumYesSellerValid values are: Centimeter, Inch.
Heightn/adecimal (nullable)NoSellerPackage measurement.
Lengthn/adecimal (nullable)NoSellerPackage measurement.
Widthn/adecimal (nullable)NoSellerPackage measurement.
WeightUnitn/aenumYesSellerValid values are: Gram, Pound.
Weightn/adecimalYesSellerPackage total weight.
PurchaseCheapestRaten/aboolYesSellerSpecify true to purchase the label using the lowest cost rate. Defaults to false.
ShippingLabelRequestIDn/astring (50)NoSellerSeller defined unique identifier for label purchase.
IncludeCustomsn/aboolYesSellerSpecify true to include detail for Customs
ExportReasonn/aenumYesSellerValid values are: MERCHANDISE, DOCUMENTS
CertificateNumbern/astringConditionalSellerOnly applicable when IncludeCustoms is true
CustomsCommentsn/astringConditionalSellerOnly applicable when IncludeCustoms is true
EelPfcn/astringConditionalSellerOnly applicable when IncludeCustoms is true
FromCustomsReferencen/astringConditionalSellerOnly applicable when IncludeCustoms is true
ImporterCustomsReferencen/astringConditionalSellerOnly applicable when IncludeCustoms is true
InsuredNumbern/astringConditionalSellerOnly applicable when IncludeCustoms is true
LicenseNumbern/astringConditionalSellerOnly applicable when IncludeCustoms is true
ManufacturedCountryCoden/astringConditionalSellerOnly applicable when IncludeCustoms is true. This is the 2-letter country code
SourceCompanyNamen/astring
SellerThe shipping source company name.
SourceTitlen/astring
SellerThe shipping source title.
SourceFirstNamen/astring
SellerThe shipping source first name.
SourceLastNamen/astring
SellerThe shipping source last name.
SourceAddressLine1n/astring
SellerThe shipping source address line 1.
SourceAddressLine2n/astring
SellerThe shipping source address line 2.
SourceCityn/astring
SellerThe shipping source city.
SourceStateOrProvincen/astring
SellerThe shipping source state.
SourcePostalCoden/astring
SellerThe shipping source postal code.
SourceCountryCoden/astring
SellerThe shipping source 2 digit country code.
SourceEmailAddressn/astring
SellerThe shipping source email address.
SourcePhoneNumbern/astring
SellerThe shipping source phone number.
DestinationCompanyNamen/astring
SellerThe shipping recipient's company name.
DestinationTitlen/astring
SellerThe shipping recipient's title.
DestinationFirstNamen/astring
SellerThe shipping recipient's first name.
DestinationLastNamen/astring
SellerThe shipping recipient's last name.
DestinationAddressLine1n/astring
SellerThe shipping recipient's address line 1.
DestinationAddressLine2n/astring
SellerThe shipping recipient's address line 2.
DestinationCityn/astring
SellerThe shipping recipient's city.
DestinationStateOrProvincen/astring
SellerThe shipping recipient's state.
DestinationPostalCoden/astring
SellerThe shipping recipient's postal code.
DestinationCountryCoden/astring
SellerThe shipping recipient's 2 digit country code.
DestinationEmailAddressn/astring
SellerThe shipping recipient's email address.
DestinationPhoneNumbern/astring
SellerThe shipping recipient's phone number.
IsCommercialAddressn/abool
SellerThe shipping recipient's address type.
FulfillmentItemIDPurchaseLabelinteger (nullable)NoSellerUniquely identifies the fulfillment item within the ChannelAdvisor system
OrderItemIDPurchaseLabelinteger (nullable)NoSellerUniquely identifies the order item within the ChannelAdvisor account.
SkuPurchaseLabelstringConditionalSellerProduct identifier provided by the seller.  Required if OrderItemID and ProductID are not submitted.
QuantityPurchaseLabelinteger (32 bit)YesSellerThe number of units included in the package
UnitWeightPurchaseLabeldecimal (nullable)NoSellerWeight per unit
DescriptionPurchaseLabelstringNoSellerDescription of the item