Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Child pages

Child pages (Children Display)

Note

The Channel Advisor DAEMON uses configuration settings symbols were created to control how the CA daemon is configured.

The dirty sync symbol key is RunCAAvailableStockDirty, and 2 symbols for the full sync and the time(s) for the full sync to run (RunCAAvailableStockFull and RunCAAvailableStockFullTimes respectively). The full sync has been enabled and set to run at 10pm. The daemon processes should now fire at the designated times.


Rest API questions

https://developer.channeladvisor.com/frequently-asked-questions

Machine readable

https://api.channeladvisor.com/v1/$metadata

OAuth - explained - end points - available scopes

https://developer.channeladvisor.com/authorization/introduction-to-oauth-2-0#IntroductiontoOAuth2.0-AvailableAuthorizationScopes

Products

https://developer.channeladvisor.com/working-with-products/product-uploads/submit-a-bulk-product-upload

Product Quantity

https://developer.channeladvisor.com/working-with-products/quantity


Products - https://developer.channeladvisor.com/working-with-products

...

SaaS

(red is always populated)



Property Name (CA)Collection Property NameType (Max Length)Always PopulatedData SourceDescription
ExRef

IDn/ainteger (32 bit)YesChannelAdvisorChannelAdvisor system generated unique identifier of the product. This value is NOT the Sku.
Host company - Channel advisor account details

ProfileIDn/ainteger (32 bit)YesChannelAdvisor or SellerIdentifies the ChannelAdvisor account.
Defined by seller when creating the product. 




CreateDateUtcn/aDateTimeOffsetYesChannelAdvisorThe date the product was created in the ChannelAdvisor system.S
Style colour size group

IsInRelationshipn/abooleanYesChannelAdvisor or SellerWhether or not the product is in a parent/child relationship. Parents and children will be true, standalone products will be false.
Style colour size parent

IsParentn/abooleanYesChannelAdvisor or SellerTrue if the product is a parent with children.



RelationshipNamen/astring (50)NoSellerIf the product is in a relationship, this value represents the relationship type.  The types are user-defined within ChannelAdvisor.
style colour size group ID

ParentProductIDn/ainteger (32 bit)NoSellerIf the product is a child, this will contain the ID of the parent product.



IsAvailableInStoren/abooleanYesSellerIgnore. Deprecated Field.
Product Status = Inactive

IsBlockedn/abooleanYesSellerA blocked product will not list on a marketplace
Always False

IsExternalQuantityBlockedn/abooleanYesSellerIf true, will prevent listing and fulfillment from Externally-Managed DCs.



BlockCommentn/astring (80)NoSellerComment field associated with IsBlocked property.
Date product made inactive

BlockedDateUtcn/aDateTimeOffsetNoChannelAdvisor 




ReceivedDateUtcn/aDateTimeOffsetYesChannelAdvisorThe date the product was received in inventory.



LastSaleDateUtcn/aDateTimeOffsetNoChannelAdvisorThe date the product was last sold.



UpdateDateUtcn/aDateTimeOffsetYesChannelAdvisorThe date the product was last updated.



QuantityUpdateDateUtcn/aDateTimeOffsetNoChannelAdvisorThe date any quantity of the product was last updated.
Amazon Supplier > "Their Reference"

ASINn/astring (14)NoSellerAmazon Standard Identification Number
Brand

Brandn/astring (150)NoSeller 

New

Conditionn/astringNoSeller"New", "Used", "Refurbished", "Reconditioned", or "Like New" are the only valid values for this field.
Description

Descriptionn/astring (32,000)NoSeller 




EANn/astring (20)NoSellerEuropean Article Number (Now called International Article Number)



FlagDescriptionn/astring (80)NoSellerProvides a short description of the flag associated with this product.



Flagn/aenumNoSellerSets the flag style on a product



HarmonizedCoden/astring (20)NoSeller 




ISBNn/astring (20)NoSellerInternational Standard Book Number



Manufacturern/astring (255)NoSeller 




MPNn/astring (50)NoSellerManufacturer Part Number
Short Description

ShortDescriptionn/astring (1,000)NoSeller 

SKU

Skun/astring (50)NoSeller 

?

Subtitlen/astring (100)NoSeller 




TaxProductCoden/astring (25)NoSellerTax product code for this item (for reseller use, NOT sales tax). Limited length - can also store in an attribute.
?

Titlen/astring (120)NoSeller 




UPCn/astring (20)NoSellerUniversal Product Code



WarehouseLocationn/astring (80)NoSeller 

?

Warrantyn/astring (255)NoSeller 

?

Heightn/adecimalNoSellerDefault unit in US profiles is "Inches". All other locales are "Centimeters".
?

Lengthn/adecimalNoSellerDefault unit in US profiles is "Inches". All other locales are "Centimeters".
?

Widthn/adecimalNoSellerDefault unit in US profiles is "Inches". All other locales are "Centimeters".
?

Weightn/adecimalNoSellerDefault unit in US profiles is "Pounds". All other locales are "Kilograms".



Costn/adecimalNoSellerThe price that the seller paid for this item.



Marginn/adecimalNoSellerProfit margin for a product.
RRP

RetailPricen/adecimalNoSellerRetail price for this item.
Active Ebay Deal starting price ?

StartingPricen/adecimalNoSellerFor an eBay listing, the initial bid starting point.
Active Ebay Deal minimum price ?

ReservePricen/adecimalNoSellerFor an eBay listing, the minimum price for an auction to sell.
Active Ebay Deal buy it now price ?

BuyItNowPricen/adecimalNoSellerSelling price of a product.



StorePricen/adecimalNoSeller 




SecondChancePricen/adecimalNoSellerPrice above which to offer underbidders of this item a second chance offer.



MinPricen/adecimalNoSellerMinimum price of a product.



MaxPricen/adecimalNoSellerMaximum price of a product.



SupplierNamen/astringNoSellerThe name of the supplier for this item



SupplierCoden/astringNoSellerCode for the supplier of this item (must be created in ChannelAdvisor prior to use)



SupplierPOn/astring (255)NoSellerPurchase Order associated with this supplier



Classificationn/astring (35)NoSellerThe inventory classification to assign to this item



IsDisplayInStoren/abooleanYesSellerIgnore. Deprecated Field.



StoreTitlen/astringNoSellerIgnore. Deprecated Field.



StoreDescriptionn/astringNoSellerIgnore. Deprecated Field.
?

BundleTypen/aenumYesSellerNone = Not a bundle, BundleComponent = Is a component in at least 1 bundle, BundleItem = Is a bundle



TotalAvailableQuantityn/ainteger (32 bit)NoChannelAdvisor 




OpenAllocatedQuantityn/alongNoChannelAdvisor 




OpenAllocatedQuantityPooledn/alongNoChannelAdvisor 




PendingCheckoutQuantityn/alongNoChannelAdvisor 




PendingCheckoutQuantityPooledn/alongNoChannelAdvisor 




PendingPaymentQuantityn/alongNoChannelAdvisor 




PendingPaymentQuantityPooledn/alongNoChannelAdvisor 




PendingShipmentQuantityn/alongNoChannelAdvisor 




PendingShipmentQuantityPooledn/alongNoChannelAdvisor 




TotalQuantityn/alongNoChannelAdvisor 




TotalQuantityPooledn/alongNoChannelAdvisor 

?

MultipackQuantityn/ainteger (32 bit)NoSellerThe number of individual items that are in a package.



AttributesProductAttributeValue[]Conditional YesChannelAdvisorCollection name always exists. Sub-properties only exist when Attributes exist.



DCQuantitiesProductDCQuantity[]Conditional YesChannelAdvisorCollection name always exists. Sub-properties only exist when Quanty exists for the product.
Quantity by Distribution Center




ImagesProductImage[]Conditional YesChannelAdvisorCollection name always exists. Sub-properties only exist when Images exist.



LabelsProductProductLabel[]Conditional YesChannelAdvisorCollection name always exists. Sub-properties only exist when Labels exist.
List of labels on the product




BundleComponentsProductProductBundleComponent[]Conditional YesChannelAdvisorCollection name always exists. Sub-properties only exist when Components have been added to the bundle.



ChildrenProductChildRelationship[]Conditional YesChannelAdvisorCollection name always exists. Sub-properties only exist when Children have been added to the parent.
If the product is a parent, this collection will contain a record for each child - only visible when retrieving parent by Product ID.

CA Reference number

ProductIDAttributesinteger (32 bit)Conditional YesChannelAdvisorProperty only exists when an Attribute exists. ChannelAdvisor system generated unique identifier of the product. This value is NOT the Sku.



ProfileIDAttributesinteger (32 bit)Conditional YesChannelAdvisorProperty only exists when an Attribute exists.
Identifies the ChannelAdvisor account. Defined by seller when creating the product.




NameAttributesstring (32)Conditional YesSellerProperty only exists when an Attribute exists. The name of the attribute.



ValueAttributesstring (32,000)Conditional YesSellerProperty only exists when an Attribute exists. The value that corresponds with the name given.
CA Reference number

ProductIDImagesinteger (32 bit)Conditional YesChannelAdvisorProperty only exists when an Image exists. ChannelAdvisor system generated unique identifier of the product. This value is NOT the Sku.



ProfileIDImagesinteger (32 bit)Conditional YesChannelAdvisorProperty only exists when an Image exists. 
Identifies the ChannelAdvisor account. Defined by seller when creating the product.




PlacementNameImagesstring (50)Conditional YesSellerProperty only exists when an Image exists. Name that corresponds with placement of the image.



AbbreviationImagesstring (50)Conditional YesChannelAdvisorProperty only exists when an Image exists. Abbreviation of the Placement Name. Not used in requests.



UrlImagesstring (255)Conditional YesSellerProperty only exists when an Image exists. URL of the image identified.



ProductIDLabelsinteger (32 bit)Conditional YesChannelAdvisorProperty only exists when a Label exists. ChannelAdvisor system generated unique identifier of the product. This value is NOT the Sku.



ProfileIDLabelsinteger (32 bit)Conditional YesChannelAdvisorProperty only exists when a Label exists. 
Identifies the ChannelAdvisor account. Defined by seller when creating the product.




NameLabelsstring (50)Conditional YesSellerProperty only exists when a Label exists. Name of the label to be applied to this product



ParentProductIDChildreninteger (32 bit)Conditional YesSellerProperty only exists when a Child Product exists. The ChannelAdvisor system generated Product ID of the parent product.



ProfileIDChildreninteger (32 bit)Conditional YesChannelAdvisorProperty only exists when a Child Product exists.
Identifies the ChannelAdvisor account. Defined by seller when creating the product.




ChildProductIDChildreninteger (32 bit)Conditional YesSellerProperty only exists when a Child Product exists.The ChannelAdvisor system generated Product ID of the child product.



ProductIDBundleComponentsinteger (32 bit)Conditional YesChannelAdvisorProperty only exists when a the item has Bundle Components. ChannelAdvisor system generated unique identifier of the bundle product. This value is NOT the Sku.



ComponentIDBundleComponentsinteger (32 bit)Conditional YesChannelAdvisorProperty only exists when a the item has Bundle Components. 
The ChannelAdvisor system generated unique Component ID related to this bundled Product ID.
The same product in a different Bundle product will have a different Component ID. 




ProfileIDBundleComponentsinteger (32 bit)Conditional YesChannelAdvisorProperty only exists when a the item has Bundle Components. 
Identifies the ChannelAdvisor account. Defined by seller when creating the product.




ComponentSkuBundleComponentsstring (50)Conditional YesSellerProperty only exists when a the item has Bundle Components. Sku value of the component item.



QuantityBundleComponentsinteger (32 bit)Conditional YesSellerProperty only exists when a the item has Bundle Components. Number of this component item available within the bundle.
Pack Size

ProductIDDCQuantitiesinteger (32 bit)Conditional YesChannelAdvisorProperty only exists when a the item has Quantity. ChannelAdvisor system generated unique identifier of the product. This value is NOT the Sku.



ProfileIDDCQuantitiesinteger (32 bit)Conditional YesChannelAdvisor Property only exists when a the item has Quantity. Identifies the ChannelAdvisor account. Defined by seller when creating the product.


Active deal source warehouse



DistributionCenterIDDCQuantitiesinteger (32 bit)Conditional YesSeller Property only exists when a the item has Quantity. Defines the distribution center ID where the related quantity exists.
Active deal source warehouse quantity

AvailableQuantityDCQuantitiesinteger (32 bit)Conditional YesSeller Property only exists when a the item has Quantity. Defines the available quantity of the product.

...