CopyToChildren Functionality


When to Use & Considerations

  • To apply parent product data values to all children of this parent product.
  • Note: this property cannot be used during parent product creation.
  • Requires the Parent Product ID (not the Skus - the ChannelAdvisor unique IDs representing the products).
    • Place a GET Products request and $filter=Sku eq 'PRODUCT SKU VALUE'&$select=ID to return the standalone Product ID to use in this request.

Limitations with a Workaround

  • The following endpoints/collections in a Product cannot be updated with this request via API, however there is a workaround.
    • Attributes & attribute values - see the section on Attributes
    • Images - see the section Images
    • Quantity - see the section on Quantity
    • Labels - see the section on Labels
    • Bundles - see the section on Bundles
  • Workaround: use the ProductUpload endpoint to deliver content as a flat file using the standard ChannelAdvisor template, or a template custom to the profile that includes the Copy To Children field mapped or populated. All other data points (including Attributes, Images, Quantity, and Labels included in the upload will be copied down to all of the children.
    • Information on preparing a file and setting up a custom template for this purpose can be found in our Community page.

Resource URL / Endpoint

PATCH or PUT https://api.channeladvisor.com/v1/Products(Parent ProductID)

Important and/or Required Parameters

PropertyType (Max Length)RequiredNote
Parent ProductIDinteger (32 bit)RequiredInclude in URL. The ChannelAdvisor defined unique ID (not the Sku value) of the parent product.
See note above under "When to Use & Considerations" about retrieving the Product ID.
CopyToChildrenbooleanRequiredInclude in Body. True will result in the included properties being copied to children of this parent product.
All other Product Entity fields are optional within this request type. Those provided below are for example purposes only.
Example Request
PATCH or PUT https://api.channeladvisor.com/v1/Products(12345678)?access_token=xxxxxxxxxx
{
	"CopyToChildren": true,
	"Title": "Men's Bedford Rib Quarter Zip Sweater",
	"BuyItNowPrice": 32.97,
	"UPC": "632555586932",
	"MPN": "Bedford_M_86932"
}

Review all children of this parent - they will all have the same "Title", "BuyItNowPrice", "UPC", and "MPN" values.

Example Response (Success)
204 No Content