Inventory Entities

How to Use this Page

This page provides a number of tables defining the many different entities in REST API and requires a basic understanding of the ChannelAdvisor Product structure - please use this graphic to help put these entity tables in context:

Product

PropertyType (Max Length)FilterableSortableNullableExportsPOSTPATCHSOAP EquivalentDescription
IDinteger (32 bit)YesYes
YesN/ARead OnlyN/AUnique identifier of the product within the ChannelAdvisor account.
ProfileIDinteger (32 bit)YesYes
YesConditionalRead OnlyN/AIdentifies the ChannelAdvisor account.
CreateDateUtcDateTimeOffsetYesYes
YesRead OnlyRead OnlyN/AThe date the product was created in the ChannelAdvisor system.
IsAvailableInStorebooleanYesYesYesNoOptionalOptionalN/AIgnore. Deprecated Field.
IsBlockedbooleanYesYesYesYesOptionalOptionalIsBlockedA blocked product will not list on a marketplace.
IsBlockedFromAdvertisingbooleanYesYesYesYesOptionalOptionalN/AA blocked product will not be sent to advertising channels (ie: Amazon, Google).
IsExternalQuantityBlockedbooleanYesYesYesYesOptionalOptionalN/AIf true, will prevent listing and fulfillment from Externally-Managed DCs.
BlockCommentstring (80)YesYesYesYesOptionalOptionalBlockCommentComment field associated with IsBlocked or IsBlockedFromAdvertising properties.
BlockedDateUtcDateTimeOffsetYesYesYesYesRead OnlyRead OnlyN/ADate and time IsBlocked was set.
BlockedFromAdvertisingDateUtcDateTimeOffsetYesYesYesYesRead OnlyRead OnlyN/ADate and time IsBlockedFromAdvertising was set.
ReceivedDateUtcDateTimeOffsetYesYesYesYesN/ARead OnlyReceivedInInventoryThe date the product was received in inventory.
LastSaleDateUtcDateTimeOffsetYesYesYesYesRead OnlyRead OnlyN/AThe date the product was last sold.
UpdateDateUtcDateTimeOffsetYesYesYesYesRead OnlyRead OnlyN/AThe date any quantity or data field of the product was last updated.
QuantityUpdateDateUtcDateTimeOffsetYesYesYesN/ARead OnlyRead OnlyN/AThe date any quantity of the product was last updated.
ASINstring (14)YesYesYesYesOptionalOptionalASINAmazon Standard Identification Number
Brandstring (150)YesYesYesYesOptionalOptionalBrand
ConditionstringYesYesYesYesOptionalOptionalCondition"New", "Used", "Refurbished", "Reconditioned", or "Like New" are the only valid values for this field.
Descriptionstring (32,000)YesYesYesYesOptionalOptionalDescription
EANstring (20)YesYesYesYesOptionalOptionalEANEuropean Article Number (Now called International Article Number)
FlagDescriptionstring (80)YesYesYesYesOptionalOptionalFlagDescriptionProvides a short description of the flag associated with this product.
FlagenumYesYes
YesOptionalOptionalFlagStyleSets the flag style on a product
HarmonizedCodestring (20)YesYesYesYesOptionalOptionalHarmonizedCode
ISBNstring (20)YesYesYesYesOptionalOptionalISBNInternational Standard Book Number
Manufacturerstring (255)YesYesYesYesOptionalOptionalManufacturer
MPNstring (50)YesYesYesYesOptionalOptionalMPNManufacturer Part Number
ShortDescriptionstring (1,000)YesYesYesYesOptionalOptionalShortDescription
Skustring (50)YesYesYesYesOptionalOptionalSku
Subtitlestring (100)YesYesYesYesOptionalOptionalSubtitle
TaxProductCodestring (25)YesYesYesYesOptionalOptionalTaxProductCodeTax product code for this item (for reseller use, NOT sales tax). Limited length - can also store in an attribute.
Titlestring (120)YesYesYesYesOptionalOptionalTitle
UPCstring (20)YesYesYesYesOptionalOptionalUPCUniversal Product Code
WarehouseLocationstring (80)YesYesYesYesOptionalOptionalWarehouseLocation
Warrantystring (255)YesYesYesYesOptionalOptionalWarranty
MultipackQuantityinteger (32 bit)YesYesYesYesOptionalOptionalN/AThe number of individual items that are in a package.
HeightdecimalYesYesYesYesOptionalOptionalHeightDefault unit in US profiles is "Inches". All other locales are "Centimeters".
LengthdecimalYesYesYesYesOptionalOptionalLengthDefault unit in US profiles is "Inches". All other locales are "Centimeters".
WidthdecimalYesYesYesYesOptionalOptionalN/ADefault unit in US profiles is "Inches". All other locales are "Centimeters".
WeightdecimalYesYesYesYesOptionalOptionalWeightDefault unit in US profiles is "Pounds". All other locales are "Kilograms".
CostdecimalYesYesYesYesOptionalOptionalPriceInfo/CostThe price that the seller paid for this item.
MargindecimalYesYesYesYesOptionalOptionalProductMarginProfit margin for a product.
RetailPricedecimalYesYesYesYesOptionalOptionalPriceInfo/RetailPriceRetail price for this item.
StartingPricedecimalYesYesYesYesOptionalOptionalPriceInfo/StartingPriceFor an eBay listing, the initial bid starting point.
ReservePricedecimalYesYesYesYesOptionalOptionalPriceInfo/ReservePriceFor an eBay listing, the minimum price for an auction to sell.
BuyItNowPricedecimalYesYesYesYesOptionalOptionalTakeItPriceSelling price of a product.
StorePricedecimalYesYesYesYesOptionalOptionalN/A
SecondChancePricedecimalYesYesYesYesOptionalOptionalPriceInfo/SecondChanceOfferPricePrice above which to offer underbidders of this item a second chance offer.
MinPricedecimalYesYesYesYesOptionalOptionalN/AMinimum price of a product.
MaxPricedecimalYesYesYesYesOptionalOptionalN/AMaximum price of a product.
SupplierNamestringYesYesYesYesOptionalOptionalN/AThe name of the supplier for this item
SupplierCodestringYesYesYesYesOptionalOptionalSupplierCodeCode for the supplier of this item (must be created in ChannelAdvisor prior to use)
SupplierPOstring (255)YesYesYesYesOptionalOptionalSupplierPOPurchase Order associated with this supplier
Classificationstring (35)YesYesYesYesOptionalOptionalClassificationThe inventory classification to assign to this item.
IsDisplayInStorebooleanYesYesYesNoN/AN/AN/AIgnore. Deprecated Field.
StoreTitlestringYesYesYesYesN/AN/AN/AIgnore. Deprecated Field.
StoreDescriptionstringYesYesYesYesN/AN/AN/AIgnore. Deprecated Field.
BundleTypeenumYesYes
YesOptionalRead OnlyN/ANone = Not a bundle, BundleComponent = Is a component in at least 1 bundle, BundleItem = Is a bundle
ProductTypeenumYesYes
YesRead OnlyRead OnlyN/ADefines the type of product as stored in ChannelAdvisor.
TotalAvailableQuantityinteger (32 bit)YesYes
YesRead OnlyRead OnlyQuantity/AvailableCalculated available quantity calculated. Populate quantity via Quantity endpoints.
OpenAllocatedQuantitylongYesYes
NoRead OnlyRead OnlyOpenAllocated
OpenAllocatedQuantityPooledlongYesYes
NoRead OnlyRead OnlyOpenAllocatedPooled
PendingCheckoutQuantitylongYesYes
YesRead OnlyRead OnlyQuantity/PendingCheckout
PendingCheckoutQuantityPooledlongYesYes
YesRead OnlyRead OnlyPendingCheckoutPooled
PendingPaymentQuantitylongYesYes
YesRead OnlyRead OnlyPendingPayment
PendingPaymentQuantityPooledlongYesYes
YesRead OnlyRead OnlyPendingPaymentPooled
PendingShipmentQuantitylongYesYes
YesRead OnlyRead OnlyPendingShipment
PendingShipmentQuantityPooledlongYesYes
YesRead OnlyRead OnlyPendingShipmentPooled
TotalQuantitylong


YesRead OnlyRead OnlyQuantity/Total
TotalQuantityPooledlongYesYes
YesRead OnlyRead OnlyQuantity/TotalPooled
QuantitySoldLast7Daysinteger (32 bit)Yes

YesRead OnlyRead OnlyN/AQuantity of product sold in the last 7 days
QuantitySoldLast14Daysinteger (32 bit)Yes

YesRead OnlyRead OnlyN/AQuantity of product sold in the last 14 days
QuantitySoldLast30Daysinteger (32 bit)Yes

YesRead OnlyRead OnlyN/AQuantity of product sold in the last 30 days
QuantitySoldLast60Daysinteger (32 bit)Yes

YesRead OnlyRead OnlyN/AQuantity of product sold in the last 60 days
QuantitySoldLast90Daysinteger (32 bit)Yes

YesRead OnlyRead OnlyN/AQuantity of product sold in the last 90 days
IsParentbooleanYesNoYesYesOptionalOptionalVariationInfo/IsParentTrue if the product is a parent with children.
IsInRelationshipbooleanYesNoYesNoOptionalOptionalVariationInfo/IsInRelationshipWhether or not the product is in a parent/child relationship. Parents and children will be true, standalone products will be false.
CopyToChildrenbooleanNoNoNoN/AN/AOptionalN/AProperties and values included in request on a parent product should be copied to all children of this product.
ParentProductIDinteger (32 bit)YesNoYesYesOptionalOptionalN/AIf the product is a child, this will contain the ID of the parent product.
ParentSkustring (50)YesNoNoYesReady OnlyRead OnlyVariationInfo/ParentSkuIf the product is in a relationship, this value represents the Parent SKU.
RelationshipNamestring (50)YesNoYesYesOptional*OptionalRelationshipName*Applies to Variations v1 Sellers. Required to build parent and child in relationship.
If the product is in a relationship, this value represents the relationship type.  The types are user-defined within ChannelAdvisor.
VaryBystringNoNoNoNoOptionalOptionalVaryByApplies to Variations v2 Sellers. Not required to build parent and child in relationship.
If the product is in a relationship, this value defines the attributes that will vary in the grouping.
The values are defined by the seller and taken at face value - attributes defined should match attribute names in ChannelAdvisor.
AttributesAttributeValue[]Child Properties Only

YesOptionalRead OnlyAttributeList
DCQuantitiesDCQuantity[]Child Properties Only

YesRead OnlyRead OnlyDistributionCenterListQuantity by Distribution Center
ImagesImage[]Child Properties Only

YesRead OnlyRead OnlyImageList
LabelsProductLabel[]Child Properties Only

YesRead OnlyRead OnlyLabelListList of labels on the product
BundleComponentsProductBundle
Component[]
Child Properties Only

YesRead OnlyRead OnlyN/A
ChildrenChildRelationship[]Child Properties Only

NoRead OnlyRead OnlyN/AChild Product ID information - only visible when retrieving parent by Product ID.

AttributeValue

PropertyType (Max Length)FilterableSortableNullablePOSTPATCHSOAP EquivalentDescription
ProductIDinteger (32 bit)Yes

N/ARead OnlyN/A
ProfileIDinteger (32 bit)Yes

ConditionalConditionalN/A
Namestring (32)Yes
YesOptionalOptionalAttributeList/NameThe name of the attribute.
Valuestring (32,000)Yes
YesOptionalOptionalAttributeList/ValueThe value that corresponds with the name given.
ProductProductChild Properties Only

N/AN/AN/AAttributeValue is part of the Product collection.

Image

PropertyType (Max Length)FilterableSortableNullablePOSTPATCHSOAP EquivalentDescription
ProductIDinteger (32 bit)YesYes
N/ARead OnlyN/A
ProfileIDinteger (32 bit)YesYes
OptionalOptionalN/A
PlacementNamestring (50)YesYesYesOptionalOptionalImageList/PlacementNameName that corresponds with placement of the image.
Abbreviationstring (50)YesYesYesN/AN/AN/AAbbreviation of the Placement Name. Not used in requests.
Urlstring (255)YesYesYesOptionalOptionalImageList/FilenameOrUrlURL of the image identified.
ProductProductChild Properties Only

N/AN/AN/AImage is part of the Product collection.

ProductBundleComponent

PropertyType (Max Length)FilterableSortableNullablePOSTPATCHSOAP Equivalent
ProductIDinteger (32 bit)YesYes
N/ARead OnlyN/A
ComponentIDinteger (32 bit)YesYes
OptionalOptionalN/A
ProfileIDinteger (32 bit)YesYes
OptionalOptionalN/A
ComponentSkustring (50)YesYesYesOptionalOptionalN/A
Quantityinteger (32 bit)YesYes
OptionalOptionalN/A
ProductProductChild Properties Only

N/AN/AN/AProductBundleComponent is part of the Product collection.

ProductLabel

PropertyType (Max Length)FilterableSortableNullablePOSTPATCHSOAP EquivalentDescription
ProductIDinteger (32 bit)YesYes
N/ARead OnlyLabelList/string
ProfileIDinteger (32 bit)YesYes
OptionalOptionalN/A
Namestring (50)YesYesYesOptionalOptionalN/AName of the label to be applied to this product
ProductProductChild Properties Only

N/AN/AN/AProductLabel is part of the Product collection.

ChildRelationship

PropertyType (Max Length)FilterableSortableNullablePOSTPATCHSOAP EquivalentDescription
ParentProductIDinteger (32 bit)YesNo
N/ARead OnlyN/AThe ID of the parent product.
ProfileIDinteger (32 bit)YesNo
OptionalOptionalN/A
ChildProductIDinteger (32 bit)YesNo
OptionalOptionalN/AThe ID of the child product.
ChildProductProductChild Properties Only

N/AN/AN/AThe child product.

DCQuantity

PropertyType (Max Length)FilterableSortableNullablePOSTPATCHSOAP Equivalent
ProductIDinteger (32 bit)Yes

N/ARead OnlyN/A
ProfileIDinteger (32 bit)Yes

OptionalOptionalN/A
DistributionCenterIDinteger (32 bit)Yes

OptionalOptionalN/A
AvailableQuantityinteger (32 bit)Yes

OptionalOptionalQuantity
ProductProductChild Properties Only

N/AN/AN/A

QuantityUpdateRequest

PropertyType (Max Length)NullablePOSTPATCHSOAP EquivalentDescription
UpdateTypeenum
OptionalOptionalQuantityUpdateTypeValue set determines how ChannelAdvisor will interpret the quantity.
CompleteDCListbooleanYesOptionalOptionalDCQuantityUpdateTypeDistribution Center(s) associated with the quantity/ies provided.
UpdatesDCxQtyUpdate[]
N/AN/ADistributionCenterList

DCxQtyUpdate

PropertyType (Max Length)NullablePOSTPATCHSOAP Equivalent
DistributionCenterIDinteger
OptionalOptionalN/A
Quantityinteger
OptionalOptionalQuantity