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

Property Type (Max Length) Filterable Sortable Nullable Exports POST PATCH SOAP Equivalent Description
ID integer (32 bit) Yes Yes   Yes     N/A Unique identifier of the product within the ChannelAdvisor account.
ProfileID integer (32 bit) Yes Yes   No     N/A Identifies the ChannelAdvisor account.
CreateDateUtc DateTimeOffset Yes Yes   Yes     N/A The date the product was created in the ChannelAdvisor system.
IsInRelationship boolean Yes No Yes No     VariationInfo/IsInRelationship Whether or not the product is in a parent/child relationship. Parents and children will be true, standalone products will be false.
IsParent boolean Yes No Yes No     VariationInfo/IsParent True if the product is a parent with children.
RelationshipName string (50) Yes No Yes Yes     RelationshipName If the product is in a relationship, this value represents the relationship type.  The types are user-defined within ChannelAdvisor.
ParentProductID integer (32 bit) Yes No Yes No     N/A If the product is a child, this will contain the ID of the parent product.
IsAvailableInStore boolean Yes Yes Yes No     N/A Ignore. Deprecated Field.
IsBlocked boolean Yes Yes Yes Yes     IsBlocked A blocked product will not list on a marketplace
IsExternalQuantityBlocked boolean Yes Yes Yes Yes     N/A If true, will prevent listing and fulfillment from Externally-Managed DCs.
BlockComment string (80) Yes Yes Yes Yes     BlockComment Comment field associated with IsBlocked property.
BlockedDateUtc DateTimeOffset Yes Yes Yes No Read Only Read Only N/A  
ReceivedDateUtc DateTimeOffset Yes Yes Yes Yes     ReceivedInInventory The date the product was received in inventory.
LastSaleDateUtc DateTimeOffset Yes Yes Yes Yes Read Only Read Only N/A The date the product was last sold.
UpdateDateUtc DateTimeOffset Yes Yes Yes Yes     N/A The date any quantity or data field of the product was last updated.
QuantityUpdateDateUtc DateTimeOffset Yes Yes Yes No Read Only Read Only N/A The date any quantity of the product was last updated.
ASIN string (14) Yes Yes Yes Yes     ASIN Amazon Standard Identification Number
Brand string (150) Yes Yes Yes Yes     Brand  
Condition string Yes Yes Yes Yes     Condition "New", "Used", "Refurbished", "Reconditioned", or "Like New" are the only valid values for this field.
Description string (32,000) Yes Yes Yes Yes     Description  
EAN string (20) Yes Yes Yes Yes     EAN European Article Number (Now called International Article Number)
FlagDescription string (80) Yes Yes Yes Yes     FlagDescription Provides a short description of the flag associated with this product.
Flag enum Yes Yes   Yes     FlagStyle Sets the flag style on a product
HarmonizedCode string (20) Yes Yes Yes Yes     HarmonizedCode  
ISBN string (20) Yes Yes Yes Yes     ISBN International Standard Book Number
Manufacturer string (255) Yes Yes Yes Yes     Manufacturer  
MPN string (50) Yes Yes Yes Yes     MPN Manufacturer Part Number
ShortDescription string (1,000) Yes Yes Yes Yes     ShortDescription  
Sku string (50) Yes Yes Yes Yes     Sku  
Subtitle string (100) Yes Yes Yes Yes     Subtitle  
TaxProductCode string (25) Yes Yes Yes Yes     TaxProductCode Tax product code for this item (for reseller use, NOT sales tax). Limited length - can also store in an attribute.
Title string (120) Yes Yes Yes Yes     Title  
UPC string (20) Yes Yes Yes Yes     UPC Universal Product Code
WarehouseLocation string (80) Yes Yes Yes Yes     WarehouseLocation  
Warranty string (255) Yes Yes Yes Yes     Warranty  
Height decimal Yes Yes Yes Yes     Height Default unit in US profiles is "Inches". All other locales are "Centimeters".
Length decimal Yes Yes Yes Yes     Length Default unit in US profiles is "Inches". All other locales are "Centimeters".
Width decimal Yes Yes Yes Yes     N/A Default unit in US profiles is "Inches". All other locales are "Centimeters".
Weight decimal Yes Yes Yes Yes     Weight Default unit in US profiles is "Pounds". All other locales are "Kilograms".
Cost decimal Yes Yes Yes Yes     PriceInfo/Cost The price that the seller paid for this item.
Margin decimal Yes Yes Yes Yes     ProductMargin Profit margin for a product.
RetailPrice decimal Yes Yes Yes Yes     PriceInfo/RetailPrice Retail price for this item.
StartingPrice decimal Yes Yes Yes Yes     PriceInfo/StartingPrice For an eBay listing, the initial bid starting point.
ReservePrice decimal Yes Yes Yes Yes     PriceInfo/ReservePrice For an eBay listing, the minimum price for an auction to sell.
BuyItNowPrice decimal Yes Yes Yes Yes     TakeItPrice Selling price of a product.
StorePrice decimal Yes Yes Yes Yes     N/A  
SecondChancePrice decimal Yes Yes Yes Yes     PriceInfo/SecondChanceOfferPrice Price above which to offer underbidders of this item a second chance offer.
MinPrice decimal Yes Yes Yes No     N/A Minimum price of a product.
MaxPrice decimal Yes Yes Yes No     N/A Maximum price of a product.
SupplierName string Yes Yes Yes No     N/A The name of the supplier for this item
SupplierCode string Yes Yes Yes Yes     SupplierCode Code for the supplier of this item (must be created in ChannelAdvisor prior to use)
SupplierPO string (255) Yes Yes Yes Yes     SupplierPO Purchase Order associated with this supplier
Classification string (35) Yes Yes Yes Yes     Classification The inventory classification to assign to this item.
IsDisplayInStore boolean Yes Yes Yes No     N/A Ignore. Deprecated Field.
StoreTitle string Yes Yes Yes No     N/A Ignore. Deprecated Field.
StoreDescription string Yes Yes Yes No     N/A Ignore. Deprecated Field.
BundleType enum Yes Yes   No   Read Only N/A None = Not a bundle, BundleComponent = Is a component in at least 1 bundle, BundleItem = Is a bundle
TotalAvailableQuantity integer (32 bit) Yes Yes   No     Quantity/Available  
OpenAllocatedQuantity long Yes Yes   No Read Only Read Only OpenAllocated  
OpenAllocatedQuantityPooled long Yes Yes   No Read Only Read Only OpenAllocatedPooled  
PendingCheckoutQuantity long Yes Yes   Yes Read Only Read Only Quantity/PendingCheckout  
PendingCheckoutQuantityPooled long Yes Yes   Yes Read Only Read Only PendingCheckoutPooled  
PendingPaymentQuantity long Yes Yes   Yes Read Only Read Only PendingPayment  
PendingPaymentQuantityPooled long Yes Yes   Yes Read Only Read Only PendingPaymentPooled  
PendingShipmentQuantity long Yes Yes   Yes Read Only Read Only PendingShipment  
PendingShipmentQuantityPooled long Yes Yes   Yes Read Only Read Only PendingShipmentPooled  
TotalQuantity long       Yes Read Only Read Only Quantity/Total  
TotalQuantityPooled long Yes Yes   No Read Only Read Only Quantity/TotalPooled  
MultipackQuantity integer (32 bit) Yes Yes Yes Yes     N/A The number of individual items that are in a package.
Attributes AttributeValue[] Child Properties Only     Yes     AttributeList  
DCQuantities DCQuantity[] Child Properties Only     Yes     DistributionCenterList Quantity by Distribution Center
Images Image[] Child Properties Only     Yes     ImageList  
Labels ProductLabel[] Child Properties Only     Yes     LabelList List of labels on the product
BundleComponents ProductBundle
Component[]
Child Properties Only     Yes     N/A  
Children ChildRelationship[] Child Properties Only     No     N/A Child Product ID information - only visible when retrieving parent by Product ID.

AttributeValue

Property Type (Max Length) Filterable Sortable Nullable POST PATCH SOAP Equivalent Description
ProductID integer (32 bit) Yes         N/A  
ProfileID integer (32 bit) Yes         N/A  
Name string (32) Yes   Yes     AttributeList/Name The name of the attribute.
Value string (32,000) Yes   Yes     AttributeList/Value The value that corresponds with the name given.
Product Product Child Properties Only         N/A AttributeValue is part of the Product collection.

Image

Property Type (Max Length) Filterable Sortable Nullable POST PATCH SOAP Equivalent Description
ProductID integer (32 bit) Yes Yes       N/A  
ProfileID integer (32 bit) Yes Yes       N/A  
PlacementName string (50) Yes Yes Yes     ImageList/PlacementName Name that corresponds with placement of the image.
Abbreviation string (50) Yes Yes Yes     N/A Abbreviation of the Placement Name. Not used in requests.
Url string (255) Yes Yes Yes     ImageList/FilenameOrUrl URL of the image identified.
Product Product Child Properties Only         N/A Image is part of the Product collection.

ProductBundleComponent

Property Type (Max Length) Filterable Sortable Nullable POST PATCH SOAP Equivalent  
ProductID integer (32 bit) Yes Yes       N/A  
ComponentID integer (32 bit) Yes Yes       N/A  
ProfileID integer (32 bit) Yes Yes       N/A  
ComponentSku string (50) Yes Yes Yes     N/A  
Quantity integer (32 bit) Yes Yes       N/A  
Product Product Child Properties Only         N/A ProductBundleComponent is part of the Product collection.

ProductLabel

Property Type (Max Length) Filterable Sortable Nullable POST PATCH SOAP Equivalent Description
ProductID integer (32 bit) Yes Yes       LabelList/string  
ProfileID integer (32 bit) Yes Yes       N/A  
Name string (50) Yes Yes Yes     N/A Name of the label to be applied to this product
Product Product Child Properties Only         N/A ProductLabel is part of the Product collection.

ChildRelationship

Property Type (Max Length) Filterable Sortable Nullable POST PATCH SOAP Equivalent Description
ParentProductID integer (32 bit) Yes No       N/A The ID of the parent product.
ProfileID integer (32 bit) Yes No       N/A  
ChildProductID integer (32 bit) Yes No       N/A The ID of the child product.
ChildProduct Product Child Properties Only         N/A The child product.

DCQuantity

Property Type (Max Length) Filterable Sortable Nullable POST PATCH SOAP Equivalent
ProductID integer (32 bit) Yes         N/A
ProfileID integer (32 bit) Yes         N/A
DistributionCenterID integer (32 bit) Yes         N/A
AvailableQuantity integer (32 bit) Yes         Quantity
Product Product Child Properties Only         N/A

QuantityUpdateRequest

Property Type (Max Length) Nullable POST PATCH SOAP Equivalent Description
UpdateType enum       QuantityUpdateType Value set determines how ChannelAdvisor will interpret the quantity.
CompleteDCList boolean Yes     DCQuantityUpdateType Distribution Center(s) associated with the quantity/ies provided.
Updates DCxQtyUpdate[]       DistributionCenterList  

DCxQtyUpdate

Property Type (Max Length) Nullable POST PATCH SOAP Equivalent
DistributionCenterID integer       N/A
Quantity integer       Quantity