Order Entities


How to Use this Page

This page provides a number of tables defining the different entities in the REST API.

It requires a basic understanding of the ChannelAdvisor Order structure, which can be found on the Working with Orders page.

Please use this graphic to help put these entity tables in context:

Order

PropertyType (Max Length)FilterableSortablePOSTPATCHSOAP EquivalentDescription
ID integer (32 bit)YesYesReadOnlyReadOnlyOrderIDUniquely identifies the order within the ChannelAdvisor account (note: this is not the marketplace Order ID).
ProfileID integer (32 bit)YesYesRequired when authorized for multiple accounts.ReadOnlyN/AIdentifies the ChannelAdvisor account.
SiteID integer (32 bit)Yes
OptionalReadOnlyN/AIdentifies the origin of the order, such as a marketplace.
SiteNamestring (50)Yes
OptionalReadOnlyItemSaleSourceName of the origin marketplace or webstore of the order. The default value is 'Checkout Direct'. See list of potential values on the Order Site ID & Site Name Values page.
UserDataPresentbyte

ReadOnlyReadOnlyN/ADefault 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.
UserDataRemovalDateUTCDateTimeOffset

ReadOnlyReadOnlyN/AThe date the user data was removed.
SiteAccountIDinteger (32 bit)YesYesReadOnlyReadOnlyN/AIdentifies the seller account on the marketplace or webstore. The list of marketplace accounts can be retrieved from the Profiles endpoint. May be null.
SiteOrderIDstring (125)YesYesOptionalOptionalClientOrderIdentifierOrder identifier provided by the origin of the order. This is usually the marketplace Order ID.
SecondarySiteOrderIDstring (700)YesYesOptionalOptionalN/ASecondary identifier provided by the origin of the order. This is a secondary marketplace-generated Order ID. Will not be populated most of the time.
SellerOrderIDstring (25)YesYesOptionalOptionalSellerOrderIDIdentifier provided by the seller.
CheckoutSourceIDbyte

OptionalOptionalCheckoutSourceIdentifies the checkout system used to place the order.
Currencystring (3)YesYesOptionalReadOnlyN/AIdentifies the currency used in the order transaction
ImportDateUtcDateTimeOffsetYesYesReadOnlyReadOnlyN/ATimestamp when the order was imported into ChannelAdvisor. Currently not filterable or sortable.
CreatedDateUtcDateTimeOffsetYesYes

OrderTimeGMTTimestamp when the order was created at the origin of the order.
PublicNotesstring (4,000)

OptionalOptionalN/ANotes from the seller which may be included in a printed invoice or packing slip.
PrivateNotesstring (4,000)

OptionalOptionalTransactionNotesNotes from the seller which cannot be included in a printed invoice or packing slip.
SpecialInstructionsstring

OptionalOptionalShippingInstructionsNotes provided by the buyer, usually pertaining to shipping instructions.
TotalPricedecimalYesYesRequiredReadOnlyTotalOrderAmountTotal price paid by the buyer.
Additional Info: Order Math Calculations and Order Taxes 
TotalTaxPricedecimal

Required if any Items have Tax or ShippingTaxReadOnlyN/ASubtotal of all tax costs, including shipping, and gift taxes.
Additional Info: Order Math Calculations and Order Taxes
TotalShippingPricedecimal

Required if any Items have ShippingReadOnlyShippingSubtotal of all shipping costs.
Does not include exclusive tax.
Does not include shipping item-level shipping promotions. 
Additional Info: Order Math Calculations
TotalShippingTaxPricedecimal

Required if any Items have Tax or ShippingTaxReadOnlyVATShippingSubtotal of all shipping tax costs.
Additional Info: Order Math Calculations and Order Taxes
TotalInsurancePricedecimal

OptionalReadOnlyShippingInsuranceSubtotal of all insurance costs.
Additional Info: Order Math Calculations 
TotalGiftOptionPricedecimal

Required if any Items have Gift PriceReadOnlyGiftWrapSubtotal of all gift option costs. Does not include exclusive tax.
Additional Info: Order Math Calculations 
TotalGiftOptionTaxPricedecimal

Required if any Items have Gift Tax PriceReadOnlyVATGiftWrapSubtotal of all gift option tax costs.
Additional Info: Order Math Calculations and Order Taxes
AdditionalCostOrDiscountdecimal

OptionalReadOnlyAdditionalCostOrDiscountMiscellaneous cost modification which may be positive to indicate a cost or negative to indicate a discount.
Additional Info: Order Math Calculations 
EstimatedShipDateUtcDateTimeOffset

OptionalOptionalEstimatedShipDateTimestamp estimating when the order will be fulfilled.
DeliverByDateUtcDateTimeOffset

OptionalOptionalDeliveryDateTimestamp indicating the deadline for fulfilling the order.
RequestedShippingCarrierstring (50)YesYesRequired if RequestedShippingClass is specifiedReadOnlyShippingCarrierOriginal requested shipping carrier provided by the origin of the order.
RequestedShippingClassstring (50)YesYesRequired if RequestedShippingCarrier is specifiedReadOnlyShippingClassOriginal requested shipping class provided by the origin of the order.
ResellerIDstring (255)YesYesOptionalReadOnlyResellerIDIdentifier for a reseller agency.
FlagIDenumYesYesOptionalOptionalFlagStyleIdentifies the flag type, if any.
FlagDescriptionstring (80)YesYesOptionalOptionalFlagDescriptionDescribes the flag.
CheckoutStatusenumYes
OptionalOptionalCheckoutStatusIndicates the progress of the order through the checkout process.
PaymentStatusenumYes
OptionalOptionalPaymentStatusIndicates the progress of the payment.
ShippingStatusenumYes
OptionalOptional, PendingShipment only
ShippingStatusIndicates the progress of the fulfillment on the order.
CheckoutDateUtcDateTimeOffsetYes
OptionalOptionalCheckoutDateGMTTimestamp indicating the latest update to CheckoutStatus.
PaymentDateUtcDateTimeOffsetYes
OptionalOptionalPaymentDateGMTTimestamp indicating the latest update to PaymentStatus.
ShippingDateUtcDateTimeOffsetYes
OptionalReadOnlyShippingDateGMTTimestamp indicating the latest update to ShippingStatus.
BuyerUserIdstring (255)Yes
OptionalReadOnlyBuyerUserIDThe UserID of the buyer
BuyerEmailAddressstring (255)YesYesRequiredReadOnlyBuyerEmailAddressThe email address of the buyer.
BuyerEmailOptInboolean

OptionalReadOnlyEmailOptInIndicates if the buyer wishes to opt in for marketing emails.
OrderTaxTypeenum

OptionalReadOnlyVATTaxCalculationOptionThe type of tax applied to the item costs.
Additional Info: Order Taxes.
ShippingTaxTypeenum

OptionalReadOnlyVATShippingOptionThe type of tax applied to the shipping costs.
Additional Info: Order Taxes. 
GiftOptionsTaxTypeenum

OptionalReadOnlyVATGiftWrapOptionThe type of tax applied to the gift option costs.
Additional Info: Order Taxes. 
PaymentMethodstring (50)YesYesOptionalOptionalPaymentTypeThe type of payment submitted by the buyer.
PaymentTransactionIDstring (255)

OptionalOptionalPaymentTransactionIDThe TransactionID of the payment.
PaymentPaypalAccountIDstring (255)

OptionalReadOnlyPaypalIDThe PayPal AccountID of the buyer.
PaymentCreditCardLast4string (4)

OptionalOptionalCreditCardLast4The last four digits of the credit card number.
PaymentMerchantReferenceNumberstring (50)

OptionalOptionalMerchantReferenceNumberThe reference number of the payment.
ShippingTitlestring (20)Yes
OptionalOptionalShippingInfo/TitleThe shipping recipient's title.
ShippingFirstNamestring (50)Yes
OptionalOptionalShippingInfo/FirstNameThe shipping recipient's first name.
ShippingLastNamestring (50)Yes
OptionalOptionalShippingInfo/LastNameThe shipping recipient's last name.
ShippingSuffixstring (20)Yes
OptionalOptionalShippingInfo/SuffixThe shipping recipient's name suffix.
ShippingCompanyNamestring (50)Yes
OptionalOptionalShippingInfo/CompanyNameThe shipping recipient's company name.
ShippingCompanyJobTitlestring (50)Yes
OptionalOptionalShippingInfo/JobTitleThe shipping recipient's job title.
ShippingDaytimePhonestring (40)Yes
OptionalOptionalShippingInfo/PhoneNumberDayThe shipping recipient's daytime phone number.
ShippingEveningPhonestring (40)Yes
OptionalOptionalShippingInfo/PhoneNumberEveningThe shipping recipient's evening phone number.
ShippingAddressLine1string (100)Yes
OptionalOptionalShippingInfo/AddressLine1The first line of the shipping address.
ShippingAddressLine2string (100)Yes
OptionalOptionalShippingInfo/AddressLine2The second line of the shipping address.
ShippingCitystring (100)Yes
OptionalOptionalShippingInfo/CityThe city of the shipping address.
ShippingStateOrProvincestring (100)Yes
OptionalOptionalShippingInfo/RegionThe region of the shipping address.
ShippingStateOrProvinceNamestring (255)Yes
OptionalOptionalShippingInfo/RegionDescriptionThe full name of the shipping address region
ShippingPostalCodestring (15)Yes
OptionalOptionalShippingInfo/PostalCodeThe postal code of the shipping address.
ShippingCountrystring (10)Yes
ConditionalOptionalShippingInfo/CountryCodeThe country of the shipping address. ISO format.
Required if ShippingStateOrProvince is provided.  
BillingTitlestring (20)Yes
OptionalOptionalBillingInfo/TitleThe payer's title.
BillingFirstNamestring (50)Yes
OptionalOptionalBillingInfo/FirstNameThe payer's first name.
BillingLastNamestring (50)Yes
OptionalOptionalBillingInfo/LastNameThe payer's last name.
BillingSuffixstring (20)Yes
OptionalOptionalBillingInfo/SuffixThe payer's name suffix.
BillingCompanyNamestring (50)Yes
OptionalOptionalBillingInfo/CompanyNameThe payer's company name.
BillingCompanyJobTitlestring (50)Yes
OptionalOptionalBillingInfo/JobTitleThe payer's job title.
BillingDaytimePhonestring (40)Yes
 OptionalOptionalBillingInfo/PhoneNumberDayThe payer's daytime phone.
BillingEveningPhonestring (40)Yes
OptionalOptionalBillingInfo/PhoneNumberEveningThe payer's evening phone.
BillingAddressLine1string (100)Yes
OptionalOptionalBillingInfo/AddressLine1The first line of the billing address.
BillingAddressLine2string (100)Yes
OptionalOptionalBillingInfo/AddressLine2The second line of the billing address.
BillingCitystring (100)Yes
OptionalOptionalBillingInfo/CityThe city of the billing address.
BillingStateOrProvincestring (100)Yes
OptionalOptionalBillingInfo/RegionThe region of the billing address.
BillingStateOrProvinceNamestring (255)Yes
OptionalOptionalBillingInfo/RegionDescriptionThe full name of the billing address region
BillingPostalCodestring (15)Yes
OptionalOptionalBillingInfo/PostalCodeThe postal code of the billing address.
BillingCountrystring (10)Yes
ConditionalOptionalBillingInfo/CountryCodeThe country of the billing address. ISO format.
Required if BillingStateOrProvince is provided. 
PromotionCodestring (20)Yes
OptionalReadOnlyPromoCodeThe order-level promotional discount code.
PromotionAmountdecimal

OptionalReadOnlyUnitPriceThe order-level discount amount.
Additional Info: Order Math Calculations 
OrderTagsstring (300)

ReadOnlyReadOnlyN/AComma-delimited list of all tags applied to the order.
See potential values and descriptions
DistributionCenterTypeRollupenumYes
ReadOnlyReadOnlyN/AThe type of distrbution center.
ItemsOrderItem[]Child Properties Only
Required
LineItemSKUListThe purchased items.
FulfillmentsFulfillment[]Child Properties Only
N/A
N/AThe fulfilled items.
AdjustmentsOrderAdjustment[]Child Properties Only
N/A
N/AThe cancellations and refunds on the order.
CustomFieldsCustomField[]Child Properties Only


CustomValueListAdditional information pertaining to the order.

OrderItem

Property
Type (Max Length)FilterableSortableNullablePOSTPATCHSOAP EquivalentDescription
ID integer (32 bit)YesYes
ReadOnlyReadOnlyLineItemIDUniquely identifies the order item within the ChannelAdvisor account.
ProfileID integer (32 bit)YesYes
ReadOnlyReadOnlyN/AIdentifies the ChannelAdvisor account.
OrderID integer (32 bit)YesYesYesOptionalReadOnlyOrderIDUniquely identifies the order within the ChannelAdvisor account.
ProductID integer (32 bit)YesYes
OptionalOptionalN/AUniquely identifies the product within the ChannelAdvisor account.
SiteOrderItemIDstring (50)YesYesYesOptional
SalesSourceIDOrder item identifier provided by the origin of the order.
SiteListingIDstring (50)YesYesYesOptional
N/AListing identifier provided by the origin of the order.
SellerOrderItemIDinteger (32 bit)
YesYesOptionalOptionalSellerOrderItemIDOrder item identifier provided by the seller.
Skustring (50)YesYesYesRequired
SKUProduct identifier provided by the seller.
Titlestring (120)YesYesYes

TitleTitle of the order item.
Quantity integer (32 bit)YesYes
Required
QuantityThe number of units purchased.
UnitPricedecimalYesYesYesOptional
UnitPriceThe cost per unit.
Additional Info: Order Math Calculations 
TaxPricedecimalYesYes
Optional
TaxCostThe tax cost for all quantity.
Additional Info: Order Math Calculations and Order Taxes 
ShippingPricedecimalYesYes
Optional
ShippingCostThe shipping cost for all quantity.
Additional Info: Order Math Calculations 
ShippingTaxPricedecimalYesYes
Optional
ShippingTaxCostThe shipping tax cost for all quantity.
Additional Info: Order Math Calculations and Order Taxes  
RecyclingFeedecimalYesYes
Optional
RecyclingFeeThe recycling and waste fee for all quantity.
Additional Info: Order Math Calculations 
UnitEstimatedShippingCostdecimal


Optional
N/AThe estimated shipping cost per unit.
GiftMessagestring (500)

YesOptional
GiftMessageThe message to accompany gift wrapping.
GiftNotesstring (40)

YesOptional
GiftWrapLevelDescription of the gift wrapping.
GiftPricedecimalYesYes
Optional
GiftWrapCostThe gift wrapping cost for all quantity.
Additional Info: Order Math Calculations 
GiftTaxPricedecimalYesYes
Optional
GiftWrapTaxCostThe gift wrapping tax cost for all quantity.
Additional Info: Order Math Calculations and Order Taxes  
IsBundlebooleanYesYes
Optional
N/AIndicates if the order item is a bundle.
ItemURLstring (256)YesYes
Optional
N/AThe URL of the order item on the origin website.
HarmonizedCodestring (20)YesYes
Optional
N/AThe harmonized code of the order item
PromotionsPromotion[]Child Properties Only



ItemPromoListDiscounts applied to the costs of the order item.
FulfillmentItemsFulfillmentItem[]Child Properties Only



N/AThe fulfilled items corresponding to the purchased order item.
BundleComponentsOrderItemBundleComponents[]Child Properties Only



N/AThe component items, if the order item is a bundle.
Adjustments[]OrderItemAdjustment[]Child Properties Only



N/ACancellations and refunds on the order item.
OrderOrderChild Properties Only



N/AReference to the order to which the order item belongs.

OrderItemBundleComponent

PropertyType (Max Length)FilterableSortableNullablePOSTPATCHDescription
OrderItemID integer (32 bit)YesYes
Read OnlyRead OnlyUniquely identifies the order item within the ChannelAdvisor account.
ProfileID integer (32 bit)YesYes
Optional
Uniquely identifies the ChannelAdvisor account.
OrderID integer (32 bit)YesYes
OptionalRead OnlyUniquely identifies the order within the ChannelAdvisor account.
ProductID integer (32 bit)YesYes
OptionalRead OnlyUniquely identifies the product within the ChannelAdvisor account.
BundleProductID integer (32 bit)YesYes
Read OnlyRead OnlyUniquely identifies the bundle to which the component belongs within the ChannelAdvisor account.
Skustring (50)YesYesYes

Identifier for the component product provided by the seller.
BundleSkustring (50)YesYesYes

Identifier for the bundle product provided by the seller.
Titlestring (120)YesYesYes

Title of the component.
Quantity integer (32 bit)YesYes


The number of units ordered (value is provided in the order already multiplied by OrderItem Quantity for the Bundle Sku).
OrderItemOrderItemChild Properties Only

N/ARead OnlyReference to the order item bundle to which the component belongs.
FulfillmentItemsFulfillmentItems[]Child Properties Only

N/ARead OnlyThe fulfilled items related to the component.

Promotion

PropertyType (Max Length)FilterableSortableNullablePOSTPATCHSOAP EquivalentDescription
ID integer (32 bit)YesYes
Read OnlyRead OnlyN/AUniquely identifies the promotion within the ChannelAdvisor account.
Codestring (20)YesYesYes

PromoCodeThe code submitted to enable the discount.
Amount decimalYesYes


UnitPriceThe discount to the item cost. Will be negative.
Additional Info: Order Math Calculations  
ShippingAmount decimalYesYes


ShippingPriceThe discount to the shipping cost. Will be negative.
Additional Info: Order Math Calculations  
OrderItemOrderItemChild Properties Only

N/ARead OnlyN/AReference to the order item to which the promotion belongs.

Fulfillment

PropertyType (Max Length)FilterableSortableNullablePOSTPATCHSOAP EquivalentDescription
ID integer (32 bit)YesYes
Read OnlyRequiredFulfillmentIDUniquely identifies the fulfillment within the ChannelAdvisor account.
ProfileID integer (32 bit)YesYes
RequiredOptionalN/AUniquely identifies the ChannelAdvisor account.
OrderID integer (32 bit)YesYes
RequiredRead OnlyOrderIDUniquely identifies the order within the ChannelAdvisor account.
CreatedDateUtcDateTimeOffsetYesYesYesRead OnlyRead OnlyCreatedDateGMTTimestamp when the fulfillment was created.
UpdatedDateUtcDateTimeOffsetYesYesYesRead OnlyRead OnlyUpdateDateGMTTimestamp when the fulfillment was last updated.
TypeenumYesYes
OptionalOptionalFulfillmentTypeIndicates how the items will be fulfilled.
DeliveryStatusenumYesYes
OptionalOptionalFulfillmentStatusIndicates the progress of the fulfillment.
TrackingNumberstring (50)YesYesYesOptionalOptionalTrackingNumberProvided by a shipping carrier to track the progress of a shipment.
ReturnTrackingNumberstring (50)YesYesYesOptionalOptionalN/AProvided by a shipping carrier to track the progress of a return shipment.
ShippingCarrierstring (50)YesYesYesOptionalOptionalCarrierCodeIdentifies the shipping carrier or agent of delivery.
ShippingClassstring (50)YesYesYesOptionalOptionalClassCodeIdentifies the class of shipment or delivery.
DistributionCenterID integer (32 bit)YesYes
OptionalOptionalDistributionCenterCodeIdentifies the distribution center from which the fulfillment will originate.
ExternalFulfillmentCenterCodestringYes

ReadOnlyReadOnlyN/AIdentifies the distribution center code generated by the marketplace. Does not apply to all marketplace, and does not apply to Multi-Channel FBA (Fulfillment by Amazon)
ExternalFulfillmentStatusenumYes

ReadOnlyReadOnlyN/AIdentifies status of communication to external fulfillment partner
ShippingCostdecimalYesYesYesOptionalOptionalCostThe amount paid by the seller for shipping services, minus tax and insurance
InsuranceCostdecimalYesYesYesOptionalOptionalInsuranceCostThe amount paid by the seller for shipment insurance
TaxCostdecimalYesYesYesOptionalOptionalTaxCostThe amount paid by the seller for taxes on shipping services
ShippedDateUtcDateTimeOffsetYesYesYesOptionalOptionalShippedDateGMTTimestamp when the fulfillment was sent.
SellerFulfillmentIDstring (50)YesYesYesOptionalOptionalSellerFulfillmentIDIdentifier provided by the seller. Amazon only allows integers.
HasShippingLabelbooleanYesYes
Read OnlyRead OnlyN/AIndicates if a shipping label has been generated through ChannelAdvisor.
HasChannelPackingSlipbooleanYesYes
Read OnlyRead OnlyN/ATrue when the Channel / Marketplace supplied a packing slip document with the order.
HasReturnLabelbooleanYesYes
Read OnlyRead OnlyN/ATrue when a return label has been created via the ChannelAdvisor Shipping Management software.
HasChannelReturnLabelbooleanYesYes
Read OnlyRead OnlyN/A

True when the Channel / Marketplace supplied a return label document with the order.

LabelFormatenumYesYesYesRead OnlyRead OnlyN/AFormat of the Shipping Label. Valid values are "PDF" or "ZPL".
ReturnLabelFormatenumYesYesYesRead OnlyRead OnlyN/AFormat of the Return Label. Valid values are "PDF" or "ZPL".
ChannelReturnLabelFormatenumYesYesYesRead OnlyRead OnlyN/AFormat of the Channel Return Label. Valid values are "PDF" or "ZPL".
ItemsFulfillmentItem[]Child Properties Only

N/AN/AItemListThe fulfilled items which comprise the fulfillment.
OrderOrderChild Properties Only

N/AN/AN/AReference to the order to which the fulfillment belongs.

FulfillmentItem

PropertyType (Max Length)FilterableSortableNullablePOSTPATCHSOAP EquivalentDescription
ID integer (32 bit)YesYes
Read OnlyRead OnlyFulfillmentItemIDUniquely identifies the fulfillment item within the ChannelAdvisor system.
ProfileID integer (32 bit)YesYes
OptionalOptionalN/AUniquely identifies the ChannelAdvisor account.
FulfillmentID integer (32 bit)YesYes
Read OnlyRead OnlyFulfillmentIDUniquely identifies the fulfillment within the ChannelAdvisor account.
OrderID integer (32 bit)YesYes
OptionalRead OnlyOrderIDUniquely identifies the order within the ChannelAdvisor account.
OrderItemID integer (32 bit)YesYes
RecommendedOptionalLineItemIDUniquely identifies the order item within the ChannelAdvisor account.
Quantity integer (32 bit)YesYes
RecommendedOptionalQuantityThe number of units.
ProductID integer (32 bit)YesYes
RecommendedOptionalN/AUniquely identifies the product within the ChannelAdvisor account.
SellerFulfillmentItemIDstring (50)YesYesYesOptionalOptionalN/AIdentifier provided by the seller. Usually a serial number or batch number.
FulfillmentFulfillmentChild Properties Only

N/ARead OnlyN/AReference to the fulfillment to which the fulfillment item belongs.
OrderOrderChild Properties Only

N/ARead OnlyN/AReference to the order to which the fulfillment item belongs.
BundleComponentOrderItemBundleComponentChild Properties Only

N/ARead OnlyN/AIf applicable, reference to the bundle component corresponding to the fulfillment item.

OrderAdjustment

Property
Type (Max Length)FilterableSortableNullablePOSTSOAP EquivalentDescription
ID integer (32 bit)YesYes
Read OnlyRefundRequestIDUniquely identifies the adjustment within the ChannelAdvisor account.
ProfileID integer (32 bit)YesYes
Read OnlyN/AUniquely identifies the ChannelAdvisor account.
OrderID integer (32 bit)YesYes
RequiredOrderIDUniquely identifies the order within the ChannelAdvisor account.
IsRestockbooleanYesYes
OptionalRestockQuantityIndicates 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.
ReasonenumYesYes
OptionalAdjustmentReasonIndicates why the adjustment was requested.
In POST Adjust requests , defaults to "GeneralAdjustment" if property is not provided.
ItemAdjustmentdecimalYesYes
OptionalAmountThe amount returned from item costs.
Send in POST Adjust requests as "AdjustmentAmount"
Total all price adjustments in this property (e.g. Tax, Shipping, etc.)
More info on adjustment calclulations: Order Level Refund & Cancel Math Calculations
TaxAdjustmentdecimalYesYes
Read OnlyTaxAmountThe amount returned from item tax costs.
ShippingAdjustmentdecimalYesYes
Read OnlyShippingAmountThe amount returned from shipping costs.
ShippingTaxAdjustmentdecimalYesYes
Read OnlyShippingTaxAmountThe amount returned from shipping tax costs. 
GiftWrapAdjustmentdecimalYesYes
Read OnlyGiftWrapAmountThe amount returned from gift wrap costs. 
GiftWrapTaxAdjustmentdecimalYesYes
Read OnlyGiftWrapTaxAmountThe amount returned from gift wrap tax costs.
RecyclingFeeAdjustmentdecimalYesYes
Read OnlyRecyclingFeeThe amount returned from recycling and waste fees.
TypeenumYesYes
Read OnlyN/AIndicates which kind of adjustment was requested.
SellerAdjustmentIDstring (50)YesYesYesOptionalSellerRefundIDIdentifier provided by the seller.
SiteAdjustmentIDstring (50)YesYesYesRead OnlyN/AIdentifier provided by the origin of the order.
AdjustmentTransactionIDstring (255)YesYes
Read OnlyN/AIdentifier supplied by external source - e.g. PayPal Refund Transaction ID
RmaNumberstring (50)Yes

OptionalN/ARMA Number for Buyer Initiated Returns.
Commentstring (400)YesYesYesRead OnlyN/ANotes on the adjustment.
PublicNotesstring (4,000)YesYesYesRead OnlyN/ANotes on the adjustment that will be visible in UI.
CreatedDateUtcDateTimeOffsetYesYes
Read OnlyRefundCreateDateGMTTimestamp when the adjustment was created.
RequestStatusenumYesYes
Read OnlyRefundRequestStatusThe progress of the adjustment.
RestockStatusenumYesYes
Read OnlyRestockStatusThe progress of the restock operation.
ReturnShippingFeedecimalYesYes
Read OnlyN/AFee charged to return items
RestockingFeedecimalYesYes
Read OnlyN/AFee charged to restock items
ReturnTrackingNumberOrUrlstring (256)YesYes
Read OnlyN/ATracking number or tracking URL of the return shipment
ReturnShippingMethodstring (100)YesYes
Read OnlyN/AShipping method of the return shipment
OrderOrderChild Properties Only

N/AN/AReference to the order to which the adjustment belongs.

OrderItemAdjustment

Property
TypeFilterableSortableNullablePOSTSOAP EquivalentDescription
IDinteger (32 bit)YesYes
Read OnlyRefundRequestIDUniquely identifies the order item adjustment within the ChannelAdvisor system.
ProfileID integer (32 bit)YesYes
Read OnlyN/AUniquely identifies the ChannelAdvisor account.
OrderID integer (32 bit)YesYes
Read OnlyOrderIDUniquely identifies the order within the ChannelAdvisor account.
OrderItemID integer (32 bit)YesYes
Read OnlyLineItemIDUniquely identifies the order item within the ChannelAdvisor system.
Quantity integer (32 bit)YesYes
OptionalQuantityThen number of units being adjusted.
IsRestockbooleanYesYes
OptionalRestockQuantity

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. 

ReasonenumYesYes
OptionalAdjustmentReasonIndicates why the adjustment was requested.
In POST Adjust requests, defaults to "GeneralAdjustment" if property is not provided.
ItemAdjustmentdecimalYesYes
OptionalAmountThe amount returned from item costs.
More info on adjustment calclulations: Item Level Refund & Cancel Math Calculations
TaxAdjustmentdecimalYesYes
OptionalTaxAmountThe amount returned from item tax costs.
More info on adjustment calclulations: Item Level Refund & Cancel Math Calculations 
ShippingAdjustmentdecimalYesYes
OptionalShippingAmountThe amount returned from shipping costs.
More info on adjustment calclulations: Item Level Refund & Cancel Math Calculations 
ShippingTaxAdjustmentdecimalYesYes
OptionalShippingTaxAmountThe amount returned from shipping tax costs.
More info on adjustment calclulations: Item Level Refund & Cancel Math Calculations 
GiftWrapAdjustmentdecimalYesYes
OptionalGiftWrapAmountThe amount returned from gift wrap costs.
More info on adjustment calclulations: Item Level Refund & Cancel Math Calculations 
GiftWrapTaxAdjustmentdecimalYesYes
OptionalGiftWrapTaxAmountThe amount returned from gift wrap tax costs.
More info on adjustment calclulations: Item Level Refund & Cancel Math Calculations 
RecyclingFeeAdjustmentdecimalYesYes
OptionalRecyclingFeeThe amount returned from recycling and waste fees.
More info on adjustment calclulations: Item Level Refund & Cancel Math Calculations 
TypeenumYesYes
Read OnlyN/AIndicates which kind of adjustment was requested.
SellerAdjustmentIDstring (50)YesYesYesOptionalSellerRefundIDIdentifier provided by the seller.
SiteAdjustmentIDstring (50)YesYesYesRead OnlyN/AIdentifier provided by the origin of the order.
AdjustmentTransactionIDstring (255)YesYes
Read OnlyN/AIdentifier supplied by external source - e.g. PayPal Refund Transaction ID
RmaNumberstring (50)YesYes
OptionalN/ARMA Number for Buyer Initiated Returns.
Commentstring (400)YesYesYesN/AN/ANotes on the adjustment.
PublicNotesstring (4,000)YesYesYesRead OnlyN/ANotes on the adjustment that will be visible in UI.
CreatedDateUtcDateTimeOffsetYesYes
N/ARefundCreateDateGMTTimestamp when the adjustment was created.
RequestStatusenumYesYes
N/ARefundRequestStatusThe progress of the adjustment.
RestockStatusenumYesYes
N/ARestockStatusThe progress of the restock operation.
ReturnShippingFeedecimalYesYes
Read OnlyN/AFee charged to return the item
RestockingFeedecimalYesYes
Read OnlyN/AFee charged to restock the item
ReturnTrackingNumberOrUrlstring (256)YesYes
Read OnlyN/ATracking number or tracking URL of the return shipment
ReturnShippingMethodstring (100)YesYes
Read OnlyN/AShipping method of the return shipment
OrderItemOrderItemChild Properties Only

N/AN/AReference to the order item to which the adjustment belongs.

CustomField

PropertyType (Max Length)FilterableSortableNullablePOSTPATCHSOAP EquivalentDescription
FieldID integer (32 bit)YesYes
Read OnlyRead OnlyIDIdentifies the custom field.
OrderID integer (32 bit)YesYes
Read OnlyRead OnlyOrderIDUniquely identifies the order within the ChannelAdvisor system.
ProfileID integer (32 bit)YesYes
Read OnlyRead OnlyN/AUniquely identifies the ChannelAdvisor account.
Valuestring (4,000)YesYesYesRequiredRequiredValueThe value of the custom field.
OrderOrderChild Properties Only

N/ARead OnlyN/AReference to the order to which the custom field belongs.

ShipOrderRequest

PropertyType (Max Length)NullablePOSTSOAP EquivalentDescription
ShippedDateUtcDateTimeOffsetYesOptionalDateShippedGMTTimestamp when the order was fulfilled.
TrackingNumberstring (50)YesOptionalTrackingNumberProvided by a shipping carrier to track the progress of a shipment.
ReturnTrackingNumberReturnTrackingNumberstring (50)YesOptionalN/AProvided by a shipping carrier to track the progress of a return shipment.
ShippingCarrierstring (50)YesOptionalCarrierCodeIdentifies the shipping carrier or agent of delivery.

string (50)YesOptionalN/AProvided by a shipping carrier to track the progress of a return shipment.
ShippingClassstring (50)YesOptionalClassCodeIdentifies the class of shipment or delivery.
DistributionCenterID integer (32 bit)YesOptionalN/AThe distribution center from which the order is fulfilled.
SellerFulfillmentIDstring (50)YesOptionalSellerFulfillmentIDIdentifier provided by the seller. Amazon only allows integers.
DeliveryStatusenumYesOptionalFulfillmentStatusIndicates the progress of fulfillment.
FulfillmentTypeenumYesOptionalFulfillmentTypeIndicates how the order is fulfilled.
ItemsShipOrderRequestItem[]YesOptionalLineItemListThe items being fulfilled.

ShipOrderRequestItem

PropertyType (Max Length)NullablePOSTSOAP EquivalentDescription
OrderItemID integer (32 bit)YesN/ALineItemIDUniquely identifies an order item in the ChannelAdvisor system.  Required if ProductID and Sku are not submitted.
ProductID integer (32 bit)YesOptionalN/AUniquely identifies a product in the ChannelAdvisor system.  Required if OrderItemID and Sku are not submitted.
Skustring (50)YesOptionalSKUProduct identifier provided by the seller.  Required if OrderItemID and ProductID are not submitted.
Quantityinteger (32 bit)
RequiredQuantityThe number of units being fulfilled.
SellerFulfillmentItemIDstring (50)YesOptionalN/AIdentifier provided by the seller.

ShippingItems

PropertyType (Max Length)Description
FulfillmentItemIDinteger (nullable)Uniquely identifies the fulfillment item within the ChannelAdvisor system
OrderItemIDinteger (nullable)Uniquely identifies the order item within the ChannelAdvisor account.
SkustringProduct identifier provided by the seller.  Required if OrderItemID and ProductID are not submitted.
Quantityinteger (32 bit)The number of units included in the package

ShippingRate

PropertyType (Max Length)Description
PackageIDinteger (nullalble)Uniquely identifies the package within the ChannelAdvisor account.
DeliverByDateUtcDateTimeOffset (nullable)Timestamp indicating the deadline for fulfilling the order.
DeliveryConfirmationenumValid values are: Default, SignatureRequired, AdultSignaturedRequired, NoDeliveryConfirmation
DistributionCenterIDinteger (nullalble)Identifies the distribution center from which the fulfillment will originate.
InsuredAmountdecimal (nullable)Insurance amount for the package
ItemsShippingItems[]Items to be included in the package
LabelFormatenumValid values are: PDF, ZPL. The default value is PDF
ShipDateUtcDateTimeOffset (nullable)Timestamp estimating when the order will be fulfilled.
MeasurementUnitenumValid values are: Centimeter, Inch.
Heightdecimal (nullable)Package measurement.
Lengthdecimal (nullable)Package measurement.
Widthdecimal (nullable)Package measurement.
WeightUnitenumValid values are: Gram, Pound.
WeightdecimalPackage total weight.
ShippingLabelPartnerAccountIDsinteger[]The unique ID that identifies the shipping partner.
PurchaseCheapestRateboolSpecify true to purchase the label using the lowest cost rate.
IncludeCustomsboolSpecify true to include detail for Customs
ExportReasonenumValid values are: MERCHANDISE, DOCUMENTS
CertificateNumberstringOnly applicable when IncludeCustoms is true
CustomsCommentsstringOnly applicable when IncludeCustoms is true
EelPfcstringOnly applicable when IncludeCustoms is true
FromCustomsReferencestringOnly applicable when IncludeCustoms is true
ImporterCustomsReferencestringOnly applicable when IncludeCustoms is true
InsuredNumberstringOnly applicable when IncludeCustoms is true
LicenseNumberstringOnly applicable when IncludeCustoms is true
ManufacturedCountryCodestringOnly applicable when IncludeCustoms is true. This is the 2-letter country code
SourceCompanyNamestringThe shipping source company name.
SourceTitlestringThe shipping source title.
SourceFirstNamestringThe shipping source first name.
SourceLastNamestringThe shipping source last name.
SourceAddressLine1stringThe shipping source address line 1.
SourceAddressLine2stringThe shipping source address line 2.
SourceCitystringThe shipping source city.
SourceStateOrProvincestringThe shipping source state.
SourcePostalCodestringThe shipping source postal code.
SourceCountryCodestringThe shipping source 2 digit country code.
SourceEmailAddressstringThe shipping source email address.
SourcePhoneNumberstringThe shipping source phone number.
DestinationCompanyNamestringThe shipping recipient's company name.
DestinationTitlestringThe shipping recipient's title.
DestinationFirstNamestringThe shipping recipient's first name.
DestinationLastNamestringThe shipping recipient's last name.
DestinationAddressLine1stringThe shipping recipient's address line 1.
DestinationAddressLine2stringThe shipping recipient's address line 2.
DestinationCitystringThe shipping recipient's city.
DestinationStateOrProvincestringThe shipping recipient's state.
DestinationPostalCodestringThe shipping recipient's postal code.
DestinationCountryCodestringThe shipping recipient's 2 digit country code.
DestinationEmailAddressstringThe shipping recipient's email address.
DestinationPhoneNumberstringThe shipping recipient's phone number.
IsCommercialAddressboolThe shipping recipient's address type.