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
Yes

N/AUnique identifier of the product within the ChannelAdvisor account.
ProfileIDinteger (32 bit)YesYes
No

N/AIdentifies the ChannelAdvisor account.
CreateDateUtcDateTimeOffsetYesYes
YesRead OnlyRead OnlyN/AThe date the product was created in the ChannelAdvisor system.
IsInRelationshipbooleanYesNoYesNo

VariationInfo/IsInRelationshipWhether or not the product is in a parent/child relationship. Parents and children will be true, standalone products will be false.
IsParentbooleanYesNoYesNo

VariationInfo/IsParentTrue if the product is a parent with children.
RelationshipNamestring (50)YesNoYesYes

RelationshipNameIf the product is in a relationship, this value represents the relationship type.  The types are user-defined within ChannelAdvisor.
ParentProductIDinteger (32 bit)YesNoYesNo

N/AIf the product is a child, this will contain the ID of the parent product.
CopyToChildrenbooleanNoNoNoNoN/AOptionalN/AProperties and values included in request on a parent product should be copied to all children of this product.
IsAvailableInStorebooleanYesYesYesNo

N/AIgnore. Deprecated Field.
IsBlockedbooleanYesYesYesYes

IsBlockedA blocked product will not list on a marketplace
IsExternalQuantityBlockedbooleanYesYesYesYes

N/AIf true, will prevent listing and fulfillment from Externally-Managed DCs.
BlockCommentstring (80)YesYesYesYes

BlockCommentComment field associated with IsBlocked property.
BlockedDateUtcDateTimeOffsetYesYesYesNoRead OnlyRead OnlyN/A
ReceivedDateUtcDateTimeOffsetYesYesYesYes

ReceivedInInventoryThe 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.
QuantityUpdateDateUtcDateTimeOffsetYesYesYesNoRead OnlyRead OnlyN/AThe date any quantity of the product was last updated.
ASINstring (14)YesYesYesYes

ASINAmazon Standard Identification Number
Brandstring (150)YesYesYesYes

Brand
ConditionstringYesYesYesYes

Condition"New", "Used", "Refurbished", "Reconditioned", or "Like New" are the only valid values for this field.
Descriptionstring (32,000)YesYesYesYes

Description
EANstring (20)YesYesYesYes

EANEuropean Article Number (Now called International Article Number)
FlagDescriptionstring (80)YesYesYesYes

FlagDescriptionProvides a short description of the flag associated with this product.
FlagenumYesYes
Yes

FlagStyleSets the flag style on a product
HarmonizedCodestring (20)YesYesYesYes

HarmonizedCode
ISBNstring (20)YesYesYesYes

ISBNInternational Standard Book Number
Manufacturerstring (255)YesYesYesYes

Manufacturer
MPNstring (50)YesYesYesYes

MPNManufacturer Part Number
ShortDescriptionstring (1,000)YesYesYesYes

ShortDescription
Skustring (50)YesYesYesYes

Sku
Subtitlestring (100)YesYesYesYes

Subtitle
TaxProductCodestring (25)YesYesYesYes

TaxProductCodeTax product code for this item (for reseller use, NOT sales tax). Limited length - can also store in an attribute.
Titlestring (120)YesYesYesYes

Title
UPCstring (20)YesYesYesYes

UPCUniversal Product Code
WarehouseLocationstring (80)YesYesYesYes

WarehouseLocation
Warrantystring (255)YesYesYesYes

Warranty
HeightdecimalYesYesYesYes

HeightDefault unit in US profiles is "Inches". All other locales are "Centimeters".
LengthdecimalYesYesYesYes

LengthDefault unit in US profiles is "Inches". All other locales are "Centimeters".
WidthdecimalYesYesYesYes

N/ADefault unit in US profiles is "Inches". All other locales are "Centimeters".
WeightdecimalYesYesYesYes

WeightDefault unit in US profiles is "Pounds". All other locales are "Kilograms".
CostdecimalYesYesYesYes

PriceInfo/CostThe price that the seller paid for this item.
MargindecimalYesYesYesYes

ProductMarginProfit margin for a product.
RetailPricedecimalYesYesYesYes

PriceInfo/RetailPriceRetail price for this item.
StartingPricedecimalYesYesYesYes

PriceInfo/StartingPriceFor an eBay listing, the initial bid starting point.
ReservePricedecimalYesYesYesYes

PriceInfo/ReservePriceFor an eBay listing, the minimum price for an auction to sell.
BuyItNowPricedecimalYesYesYesYes

TakeItPriceSelling price of a product.
StorePricedecimalYesYesYesYes

N/A
SecondChancePricedecimalYesYesYesYes

PriceInfo/SecondChanceOfferPricePrice above which to offer underbidders of this item a second chance offer.
MinPricedecimalYesYesYesNo

N/AMinimum price of a product.
MaxPricedecimalYesYesYesNo

N/AMaximum price of a product.
SupplierNamestringYesYesYesNo

N/AThe name of the supplier for this item
SupplierCodestringYesYesYesYes

SupplierCodeCode for the supplier of this item (must be created in ChannelAdvisor prior to use)
SupplierPOstring (255)YesYesYesYes

SupplierPOPurchase Order associated with this supplier
Classificationstring (35)YesYesYesYes

ClassificationThe inventory classification to assign to this item.
IsDisplayInStorebooleanYesYesYesNo

N/AIgnore. Deprecated Field.
StoreTitlestringYesYesYesNo

N/AIgnore. Deprecated Field.
StoreDescriptionstringYesYesYesNo

N/AIgnore. Deprecated Field.
BundleTypeenumYesYes
No
Read OnlyN/ANone = Not a bundle, BundleComponent = Is a component in at least 1 bundle, BundleItem = Is a bundle
TotalAvailableQuantityinteger (32 bit)YesYes
No

Quantity/Available
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
NoRead OnlyRead OnlyQuantity/TotalPooled
MultipackQuantityinteger (32 bit)YesYesYesYes

N/AThe number of individual items that are in a package.
AttributesAttributeValue[]Child Properties Only

Yes

AttributeList
DCQuantitiesDCQuantity[]Child Properties Only

Yes

DistributionCenterListQuantity by Distribution Center
ImagesImage[]Child Properties Only

Yes

ImageList
LabelsProductLabel[]Child Properties Only

Yes

LabelListList of labels on the product
BundleComponentsProductBundle
Component[]
Child Properties Only

Yes

N/A
ChildrenChildRelationship[]Child Properties Only

No

N/AChild Product ID information - only visible when retrieving parent by Product ID.

AttributeValue

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



N/A
ProfileIDinteger (32 bit)Yes



N/A
Namestring (32)Yes
Yes

AttributeList/NameThe name of the attribute.
Valuestring (32,000)Yes
Yes

AttributeList/ValueThe value that corresponds with the name given.
ProductProductChild Properties Only



N/AAttributeValue is part of the Product collection.

Image

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


N/A
ProfileIDinteger (32 bit)YesYes


N/A
PlacementNamestring (50)YesYesYes

ImageList/PlacementNameName that corresponds with placement of the image.
Abbreviationstring (50)YesYesYes

N/AAbbreviation of the Placement Name. Not used in requests.
Urlstring (255)YesYesYes

ImageList/FilenameOrUrlURL of the image identified.
ProductProductChild Properties Only



N/AImage is part of the Product collection.

ProductBundleComponent

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


N/A
ComponentIDinteger (32 bit)YesYes


N/A
ProfileIDinteger (32 bit)YesYes


N/A
ComponentSkustring (50)YesYesYes

N/A
Quantityinteger (32 bit)YesYes


N/A
ProductProductChild Properties Only



N/AProductBundleComponent is part of the Product collection.

ProductLabel

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


LabelList/string
ProfileIDinteger (32 bit)YesYes


N/A
Namestring (50)YesYesYes

N/AName of the label to be applied to this product
ProductProductChild Properties Only



N/AProductLabel is part of the Product collection.

ChildRelationship

PropertyType (Max Length)FilterableSortableNullablePOSTPATCHSOAP EquivalentDescription
ParentProductIDinteger (32 bit)YesNo


N/AThe ID of the parent product.
ProfileIDinteger (32 bit)YesNo


N/A
ChildProductIDinteger (32 bit)YesNo


N/AThe ID of the child product.
ChildProductProductChild Properties Only



N/AThe child product.

DCQuantity

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



N/A
ProfileIDinteger (32 bit)Yes



N/A
DistributionCenterIDinteger (32 bit)Yes



N/A
AvailableQuantityinteger (32 bit)Yes



Quantity
ProductProductChild Properties Only



N/A

QuantityUpdateRequest

PropertyType (Max Length)NullablePOSTPATCHSOAP EquivalentDescription
UpdateTypeenum


QuantityUpdateTypeValue set determines how ChannelAdvisor will interpret the quantity.
CompleteDCListbooleanYes

DCQuantityUpdateTypeDistribution Center(s) associated with the quantity/ies provided.
UpdatesDCxQtyUpdate[]


DistributionCenterList

DCxQtyUpdate

PropertyType (Max Length)NullablePOSTPATCHSOAP Equivalent
DistributionCenterIDinteger


N/A
Quantityinteger


Quantity