PUT 3dCartWebAPI/v1/Products/{catalogid}
This method is used to update a single product record in the database. The {catalogid} parameter specifies which product record to update.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
catalogid |
CatalogID |
integer |
Required |
Body Parameters
A Json or XML object containing the new product
ProductName | Description | Type | Additional information |
---|---|---|---|
SKUInfo | ProductSKU |
None. |
|
MFGID |
database reference = products.mfgid |
string |
String length: inclusive between 0 and 50 |
ShortDescription |
database reference = products.description |
string |
String length: inclusive between 0 and 65535 |
ManufacturerID |
database reference = products.manufacturer |
integer |
None. |
ManufacturerName |
database reference = manufacturer.manufacturer |
string |
String length: inclusive between 0 and 50 |
DistributorList | Collection of ProductDistributor |
None. |
|
LastUpdate |
database reference = products.last_update |
date |
None. |
UserID |
database reference = products.userid |
string |
String length: inclusive between 0 and 50 |
GTIN |
database reference = products.gtin |
string |
String length: inclusive between 0 and 50 |
CategoryList | Collection of ProductCategory |
None. |
|
ExternalIdsList | Collection of ExternalId |
None. |
|
CategoryExternalIdsList | Collection of CategoryExternalId |
None. |
|
NonTaxable |
database reference = products.nontax |
boolean |
None. |
NotForSale |
database reference = products.notforsale |
boolean |
None. |
Hide |
database reference = products.hide |
boolean |
None. |
GiftCertificate |
database reference = products.giftcertificate |
boolean |
None. |
HomeSpecial |
database reference = products.homespecial |
boolean |
None. |
CategorySpecial |
database reference = products.categoryspecial |
boolean |
None. |
NonSearchable |
database reference = products.nonsearchable |
boolean |
None. |
GiftWrapItem |
database reference = products.giftwrap_option |
boolean |
None. |
ShipCost |
database reference = products.shipcost |
decimal number |
None. |
Weight |
database reference = products.weight |
decimal number |
None. |
Height |
database reference = products.height |
decimal number |
None. |
Width |
database reference = products.width |
decimal number |
None. |
Depth |
database reference = products.depth |
decimal number |
None. |
SelfShip |
database reference = products.self_ship |
boolean |
None. |
FreeShipping |
database reference = products.free_shipping |
boolean |
None. |
RewardPoints |
database reference = products.reward_points |
integer |
None. |
RedeemPoints |
database reference = products.reward_redeem |
integer |
None. |
DisableRewards |
database reference = products.reward_disable |
boolean |
None. |
StockAlert |
database reference = products.stock_alert |
integer |
None. |
ReorderQuantity |
database reference = products.qty_reorder |
integer |
None. |
InStockMessage |
database reference = products.instock_message |
string |
String length: inclusive between 0 and 150 |
OutOfStockMessage |
database reference = products.outofstock_message |
string |
String length: inclusive between 0 and 150 |
BackOrderMessage |
database reference = products.backorder_message |
string |
String length: inclusive between 0 and 150 |
InventoryControl |
database reference = products.show_out_stock |
integer |
None. |
WarehouseLocation |
database reference = products.warehouse_location |
string |
String length: inclusive between 0 and 150 |
WarehouseBin |
database reference = products.warehouse_bin |
string |
String length: inclusive between 0 and 150 |
WarehouseAisle |
database reference = products.warehouse_aisle |
string |
String length: inclusive between 0 and 150 |
WarehouseCustom |
database reference = products.warehouse_custom |
string |
String length: inclusive between 0 and 150 |
Description |
database reference = products.extended_description |
string |
String length: inclusive between 0 and 65535 |
Keywords |
database reference = products.keywords |
string |
String length: inclusive between 0 and 65535 |
ExtraField1 |
database reference = products.extra_field_1 |
string |
String length: inclusive between 0 and 150 |
ExtraField2 |
database reference = products.extra_field_2 |
string |
String length: inclusive between 0 and 150 |
ExtraField3 |
database reference = products.extra_field_3 |
string |
String length: inclusive between 0 and 150 |
ExtraField4 |
database reference = products.extra_field_4 |
string |
String length: inclusive between 0 and 150 |
ExtraField5 |
database reference = products.extra_field_5 |
string |
String length: inclusive between 0 and 150 |
ExtraField6 |
database reference = products.extra_field_6 |
string |
String length: inclusive between 0 and 65535 |
ExtraField7 |
database reference = products.extra_field_7 |
string |
String length: inclusive between 0 and 65535 |
ExtraField8 |
database reference = products.extra_field_8 |
string |
String length: inclusive between 0 and 65535 |
ExtraField9 |
database reference = products.extra_field_9 |
string |
String length: inclusive between 0 and 65535 |
ExtraField10 |
database reference = products.extra_field_10 |
string |
String length: inclusive between 0 and 65535 |
ExtraField11 |
database reference = products.extra_field_11 |
string |
String length: inclusive between 0 and 65535 |
ExtraField12 |
database reference = products.extra_field_12 |
string |
String length: inclusive between 0 and 65535 |
ExtraField13 |
database reference = products.extra_field_13 |
string |
String length: inclusive between 0 and 65535 |
FeatureList | Collection of Feature |
None. |
|
PluginList | Dictionary of string [key] and string [value] |
None. |
|
SampleEnable |
database reference = products.sample_enable |
boolean |
None. |
SampleName |
database reference = products.sample_name |
string |
String length: inclusive between 0 and 255 |
SampleSKUPrefix |
database reference = products.sample_sku_prefix |
string |
String length: inclusive between 0 and 25 |
SamplePrice |
database reference = products.sample_price |
decimal number |
None. |
SampleWeight |
database reference = products.sample_weight |
decimal number |
None. |
ReviewAverage |
database reference = products.review_average |
decimal number |
None. |
ReviewCount |
database reference = products.review_count |
integer |
None. |
MainImageFile |
database reference = products. |
string |
String length: inclusive between 0 and 255 |
MainImageCaption |
database reference = products.imagecaption1 |
string |
String length: inclusive between 0 and 65535 |
ThumbnailFile |
database reference = products.thumbnail |
string |
String length: inclusive between 0 and 255 |
MediaFile |
database reference = products.realmedia |
string |
String length: inclusive between 0 and 255 |
AdditionalImageFile2 |
database reference = products.image2 |
string |
String length: inclusive between 0 and 255 |
AdditionalImageCaption2 |
database reference = products.imagecaption2 |
string |
String length: inclusive between 0 and 65535 |
AdditionalImageFile3 |
database reference = products.image3 |
string |
String length: inclusive between 0 and 255 |
AdditionalImageCaption3 |
database reference = products.imagecaption3 |
string |
String length: inclusive between 0 and 65535 |
AdditionalImageFile4 |
database reference = products.image4 |
string |
String length: inclusive between 0 and 255 |
AdditionalImageCaption4 |
database reference = products.imagecaption4 |
string |
String length: inclusive between 0 and 65535 |
ImageGalleryList | Collection of ImageGallery |
None. |
|
OptionSetList | Collection of OptionSet |
None. |
|
AdvancedOptionList | Collection of AdvancedOption |
None. |
|
RelatedProductList | Collection of RelatedProduct |
None. |
|
UpSellingItemList | Collection of UpSellingItem |
None. |
|
DiscountList | Collection of Discount |
None. |
|
DoNotUseCategoryOptions |
database reference = products.usecatoptions |
boolean |
None. |
DateCreated |
database reference = products.date_created |
date |
None. |
ListingTemplateID |
database reference = products.listing_displaytype |
integer |
None. |
ListingTemplateName |
Dynamically generated field. No database reference. |
string |
None. |
LoginRequiredOptionID |
database reference = products.loginlevel |
integer |
None. |
LoginRequiredOptionName |
Dynamically generated field. No database reference. |
string |
None. |
LoginRequiredOptionRedirectTo |
database reference = products.redirectto |
string |
String length: inclusive between 0 and 150 |
AllowAccessCustomerGroupID |
database reference = products.accessgroup |
integer |
String length: inclusive between 0 and 250 |
AllowAccessCustomerGroupName |
Dynamically generated field. No database reference. |
string |
None. |
RMAMaxPeriod |
database reference = products.rma_maxperiod |
string |
None. |
CanonicalUrl |
database reference = products.canonical_url |
string |
None. |
TaxCode |
database reference = products.tax_code |
string |
Matching regular expression pattern: ^.{1,6}$ |
DisplayText |
database reference = products.displaytext |
string |
String length: inclusive between 0 and 50 |
MinimumQuantity |
database reference = products.minimumorder |
decimal number |
None. |
MaximumQuantity |
database reference = products.maximumorder |
decimal number |
None. |
AllowOnlyMultiples |
database reference = products.minorderpkg |
boolean |
None. |
AllowFractionalQuantity |
database reference = products.fractional_qty |
boolean |
None. |
QuantityOptions |
database reference = products.qtyoptions |
string |
String length: inclusive between 0 and 250 |
GroupOptionsForQuantityPricing |
database reference = products.pricing_groupopt |
boolean |
None. |
ApplyQuantityDiscountToOptions |
database reference = products.qtydiscount_opt |
boolean |
None. |
EnableMakeAnOfferFeature |
database reference = products.makeanoffer_enabled |
boolean |
None. |
MinimumAcceptableOffer |
database reference = products.makeanoffer_price |
string |
String length: inclusive between 0 and 10 |
PriceLevel1 |
database reference = products.price_1 |
decimal number |
None. |
PriceLevel1Hide |
database reference = products.hide_1 |
boolean |
None. |
PriceLevel2 |
database reference = products.price_2 |
decimal number |
None. |
PriceLevel2Hide |
database reference = products.hide_2 |
boolean |
None. |
PriceLevel3 |
database reference = products.price_3 |
decimal number |
None. |
PriceLevel3Hide |
database reference = products.hide_3 |
boolean |
None. |
PriceLevel4 |
database reference = products.price_4 |
decimal number |
None. |
PriceLevel4Hide |
database reference = products.hide_4 |
boolean |
None. |
PriceLevel5 |
database reference = products.price_5 |
decimal number |
None. |
PriceLevel5Hide |
database reference = products.hide_5 |
boolean |
None. |
PriceLevel6 |
database reference = products.price_6 |
decimal number |
None. |
PriceLevel6Hide |
database reference = products.hide_6 |
boolean |
None. |
PriceLevel7 |
database reference = products.price_7 |
decimal number |
None. |
PriceLevel7Hide |
database reference = products.hide_7 |
boolean |
None. |
PriceLevel8 |
database reference = products.price_8 |
decimal number |
None. |
PriceLevel8Hide |
database reference = products.hide_8 |
boolean |
None. |
PriceLevel9 |
database reference = products.price_9 |
decimal number |
None. |
PriceLevel9Hide |
database reference = products.hide_9 |
boolean |
None. |
PriceLevel10 |
database reference = products.price_10 |
decimal number |
None. |
PriceLevel10Hide |
database reference = products.hide_10 |
boolean |
None. |
BuyButtonLink |
Dynamically generated field. No database reference. |
string |
None. |
ProductLink |
Dynamically generated field. No database reference. |
string |
None. |
Title |
database reference = products.title |
string |
String length: inclusive between 0 and 255 |
CustomFileName |
database reference = products.filename |
string |
String length: inclusive between 0 and 255 |
RedirectLink |
database reference = products.link |
string |
String length: inclusive between 0 and 250 |
MetaTags |
database reference = products.metatags |
string |
String length: inclusive between 0 and 65535 |
SpecialInstructions |
database reference = products.eproduct_instructions |
string |
String length: inclusive between 0 and 65535 |
AssignKey |
database reference = products.eproduct_serial |
boolean |
None. |
ReUseKeys |
database reference = products.eproduct_reuseserial |
boolean |
None. |
SerialList | Collection of Serial |
None. |
|
EProductList | Collection of EProduct |
None. |
Request Formats
application/json, text/json
{ "SKUInfo": { "CatalogID": 1, "SKU": "sample string 1", "Name": "sample string 2", "Cost": 1.1, "Price": 1.1, "Currency": "sample string 3", "RetailPrice": 1.1, "SalePrice": 1.1, "OnSale": true, "Stock": 1.1 }, "MFGID": "sample string 1", "ShortDescription": "sample string 2", "ManufacturerID": 1, "ManufacturerName": "sample string 3", "DistributorList": [ { "DistributorID": 1, "DistributorName": "sample string 1", "DistributorItemCost": 1.1, "DistributorItemID": "sample string 2", "DistributorStockID": "sample string 3" }, { "DistributorID": 1, "DistributorName": "sample string 1", "DistributorItemCost": 1.1, "DistributorItemID": "sample string 2", "DistributorStockID": "sample string 3" } ], "LastUpdate": "04/18/2024 19:29", "UserID": "sample string 4", "GTIN": "sample string 5", "CategoryList": [ { "CategoryID": 1, "CategoryName": "sample string 1" }, { "CategoryID": 1, "CategoryName": "sample string 1" } ], "ExternalIdsList": [ { "ID": 1, "AdvancedOptionSufix": "sample string 1", "ExternalId1": "sample string 2", "ExternalId2": "sample string 3", "ExternalIdType": "sample string 4" }, { "ID": 1, "AdvancedOptionSufix": "sample string 1", "ExternalId1": "sample string 2", "ExternalId2": "sample string 3", "ExternalIdType": "sample string 4" } ], "CategoryExternalIdsList": [ { "ID": 1, "CategoryID": 1, "ExternalId1": "sample string 1", "ExternalIdType": "sample string 2" }, { "ID": 1, "CategoryID": 1, "ExternalId1": "sample string 1", "ExternalIdType": "sample string 2" } ], "NonTaxable": true, "NotForSale": true, "Hide": true, "GiftCertificate": true, "HomeSpecial": true, "CategorySpecial": true, "NonSearchable": true, "GiftWrapItem": true, "ShipCost": 1.1, "Weight": 1.1, "Height": 1.1, "Width": 1.1, "Depth": 1.1, "SelfShip": true, "FreeShipping": true, "RewardPoints": 1, "RedeemPoints": 1, "DisableRewards": true, "StockAlert": 1, "ReorderQuantity": 1, "InStockMessage": "sample string 6", "OutOfStockMessage": "sample string 7", "BackOrderMessage": "sample string 8", "InventoryControl": 1, "WarehouseLocation": "sample string 9", "WarehouseBin": "sample string 10", "WarehouseAisle": "sample string 11", "WarehouseCustom": "sample string 12", "Description": "sample string 13", "Keywords": "sample string 14", "ExtraField1": "sample string 15", "ExtraField2": "sample string 16", "ExtraField3": "sample string 17", "ExtraField4": "sample string 18", "ExtraField5": "sample string 19", "ExtraField6": "sample string 20", "ExtraField7": "sample string 21", "ExtraField8": "sample string 22", "ExtraField9": "sample string 23", "ExtraField10": "sample string 24", "ExtraField11": "sample string 25", "ExtraField12": "sample string 26", "ExtraField13": "sample string 27", "FeatureList": [ { "FeatureID": 1, "FeatureTitle": "sample string 1", "FeatureDescription": "sample string 2" }, { "FeatureID": 1, "FeatureTitle": "sample string 1", "FeatureDescription": "sample string 2" } ], "PluginList": { "sample string 1": "sample string 2", "sample string 3": "sample string 4" }, "SampleEnable": true, "SampleName": "sample string 28", "SampleSKUPrefix": "sample string 29", "SamplePrice": 1.1, "SampleWeight": 1.1, "ReviewAverage": 1.1, "ReviewCount": 1, "MainImageFile": "sample string 30", "MainImageCaption": "sample string 31", "ThumbnailFile": "sample string 32", "MediaFile": "sample string 33", "AdditionalImageFile2": "sample string 34", "AdditionalImageCaption2": "sample string 35", "AdditionalImageFile3": "sample string 36", "AdditionalImageCaption3": "sample string 37", "AdditionalImageFile4": "sample string 38", "AdditionalImageCaption4": "sample string 39", "ImageGalleryList": [ { "ImageGalleryID": 1, "ImageGalleryFile": "sample string 1", "ImageGalleryCaption": "sample string 2", "ImageGallerySorting": 1 }, { "ImageGalleryID": 1, "ImageGalleryFile": "sample string 1", "ImageGalleryCaption": "sample string 2", "ImageGallerySorting": 1 } ], "OptionSetList": [ { "OptionSetID": 1, "OptionSetName": "sample string 1", "OptionSorting": 1.1, "OptionRequired": true, "OptionType": "sample string 2", "OptionURL": "sample string 3", "OptionAdditionalInformation": "sample string 4", "OptionSizeLimit": 1, "OptionList": [ { "OptionID": 1, "OptionName": "sample string 1", "OptionSelected": true, "OptionHide": true, "OptionValue": 1.1, "OptionPartNumber": "sample string 2", "OptionSorting": 1.1, "OptionImagePath": "sample string 3", "OptionBundleCatalogId": 1, "OptionBundleQuantity": 1 }, { "OptionID": 1, "OptionName": "sample string 1", "OptionSelected": true, "OptionHide": true, "OptionValue": 1.1, "OptionPartNumber": "sample string 2", "OptionSorting": 1.1, "OptionImagePath": "sample string 3", "OptionBundleCatalogId": 1, "OptionBundleQuantity": 1 } ] }, { "OptionSetID": 1, "OptionSetName": "sample string 1", "OptionSorting": 1.1, "OptionRequired": true, "OptionType": "sample string 2", "OptionURL": "sample string 3", "OptionAdditionalInformation": "sample string 4", "OptionSizeLimit": 1, "OptionList": [ { "OptionID": 1, "OptionName": "sample string 1", "OptionSelected": true, "OptionHide": true, "OptionValue": 1.1, "OptionPartNumber": "sample string 2", "OptionSorting": 1.1, "OptionImagePath": "sample string 3", "OptionBundleCatalogId": 1, "OptionBundleQuantity": 1 }, { "OptionID": 1, "OptionName": "sample string 1", "OptionSelected": true, "OptionHide": true, "OptionValue": 1.1, "OptionPartNumber": "sample string 2", "OptionSorting": 1.1, "OptionImagePath": "sample string 3", "OptionBundleCatalogId": 1, "OptionBundleQuantity": 1 } ] } ], "AdvancedOptionList": [ { "AdvancedOptionCode": "sample string 1", "AdvancedOptionSufix": "sample string 2", "AdvancedOptionName": "sample string 3", "AdvancedOptionCost": 1.1, "AdvancedOptionStock": 1, "AdvancedOptionWeight": 1.1, "AdvancedOptionPrice": 1.1, "AdvancedOptionPrice2": 1.1, "AdvancedOptionPrice3": 1.1, "AdvancedOptionPrice4": 1.1, "AdvancedOptionPrice5": 1.1, "AdvancedOptionPrice6": 1.1, "AdvancedOptionPrice7": 1.1, "AdvancedOptionPrice8": 1.1, "AdvancedOptionPrice9": 1.1, "AdvancedOptionPrice10": 1.1, "AdvancedOptionGTIN": "sample string 4" }, { "AdvancedOptionCode": "sample string 1", "AdvancedOptionSufix": "sample string 2", "AdvancedOptionName": "sample string 3", "AdvancedOptionCost": 1.1, "AdvancedOptionStock": 1, "AdvancedOptionWeight": 1.1, "AdvancedOptionPrice": 1.1, "AdvancedOptionPrice2": 1.1, "AdvancedOptionPrice3": 1.1, "AdvancedOptionPrice4": 1.1, "AdvancedOptionPrice5": 1.1, "AdvancedOptionPrice6": 1.1, "AdvancedOptionPrice7": 1.1, "AdvancedOptionPrice8": 1.1, "AdvancedOptionPrice9": 1.1, "AdvancedOptionPrice10": 1.1, "AdvancedOptionGTIN": "sample string 4" } ], "RelatedProductList": [ { "RelatedIndexID": 1, "RelatedProductID": 1, "RelatedProductSorting": 1 }, { "RelatedIndexID": 1, "RelatedProductID": 1, "RelatedProductSorting": 1 } ], "UpSellingItemList": [ { "UpSellingIndexID": 1, "UpSellingItemID": 1, "UpSellingItemSorting": 1 }, { "UpSellingIndexID": 1, "UpSellingItemID": 1, "UpSellingItemSorting": 1 } ], "DiscountList": [ { "DiscountID": 1, "DiscountPriceLevel": 1, "DiscountLowbound": 1.1, "DiscountUpbound": 1.1, "DiscountPrice": 1.1, "DiscountPercentage": true }, { "DiscountID": 1, "DiscountPriceLevel": 1, "DiscountLowbound": 1.1, "DiscountUpbound": 1.1, "DiscountPrice": 1.1, "DiscountPercentage": true } ], "DoNotUseCategoryOptions": true, "DateCreated": "04/18/2024 19:29", "ListingTemplateID": 1, "ListingTemplateName": "sample string 40", "LoginRequiredOptionID": 1, "LoginRequiredOptionName": "sample string 41", "LoginRequiredOptionRedirectTo": "sample string 42", "AllowAccessCustomerGroupID": 1, "AllowAccessCustomerGroupName": "sample string 43", "RMAMaxPeriod": "sample string 44", "CanonicalUrl": "sample string 45", "TaxCode": "sample string 46", "DisplayText": "sample string 47", "MinimumQuantity": 1.1, "MaximumQuantity": 1.1, "AllowOnlyMultiples": true, "AllowFractionalQuantity": true, "QuantityOptions": "sample string 48", "GroupOptionsForQuantityPricing": true, "ApplyQuantityDiscountToOptions": true, "EnableMakeAnOfferFeature": true, "MinimumAcceptableOffer": "sample string 49", "PriceLevel1": 1.1, "PriceLevel1Hide": true, "PriceLevel2": 1.1, "PriceLevel2Hide": true, "PriceLevel3": 1.1, "PriceLevel3Hide": true, "PriceLevel4": 1.1, "PriceLevel4Hide": true, "PriceLevel5": 1.1, "PriceLevel5Hide": true, "PriceLevel6": 1.1, "PriceLevel6Hide": true, "PriceLevel7": 1.1, "PriceLevel7Hide": true, "PriceLevel8": 1.1, "PriceLevel8Hide": true, "PriceLevel9": 1.1, "PriceLevel9Hide": true, "PriceLevel10": 1.1, "PriceLevel10Hide": true, "BuyButtonLink": "sample string 50", "ProductLink": "sample string 51", "Title": "sample string 52", "CustomFileName": "sample string 53", "RedirectLink": "sample string 54", "MetaTags": "sample string 55", "SpecialInstructions": "sample string 56", "AssignKey": true, "ReUseKeys": true, "SerialList": [ { "SerialID": 1, "SerialUses": 1, "SerialCode": "sample string 1" }, { "SerialID": 1, "SerialUses": 1, "SerialCode": "sample string 1" } ], "EProductList": [ { "FileNumber": 1, "FilePath": "sample string 1" }, { "FileNumber": 1, "FilePath": "sample string 1" } ] }
application/xml, text/xml
<Product xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <SKUInfo> <CatalogID>1</CatalogID> <SKU>sample string 1</SKU> <Name>sample string 2</Name> <Cost>1.1</Cost> <Price>1.1</Price> <Currency>sample string 3</Currency> <RetailPrice>1.1</RetailPrice> <SalePrice>1.1</SalePrice> <OnSale>true</OnSale> <Stock>1.1</Stock> </SKUInfo> <MFGID>sample string 1</MFGID> <ShortDescription>sample string 2</ShortDescription> <ManufacturerID>1</ManufacturerID> <ManufacturerName>sample string 3</ManufacturerName> <DistributorList> <ProductDistributor> <DistributorID>1</DistributorID> <DistributorName>sample string 1</DistributorName> <DistributorItemCost>1.1</DistributorItemCost> <DistributorItemID>sample string 2</DistributorItemID> <DistributorStockID>sample string 3</DistributorStockID> </ProductDistributor> <ProductDistributor> <DistributorID>1</DistributorID> <DistributorName>sample string 1</DistributorName> <DistributorItemCost>1.1</DistributorItemCost> <DistributorItemID>sample string 2</DistributorItemID> <DistributorStockID>sample string 3</DistributorStockID> </ProductDistributor> </DistributorList> <LastUpdate>2024-04-18T19:29:31.1612805-04:00</LastUpdate> <UserID>sample string 4</UserID> <GTIN>sample string 5</GTIN> <CategoryList> <ProductCategory> <CategoryID>1</CategoryID> <CategoryName>sample string 1</CategoryName> </ProductCategory> <ProductCategory> <CategoryID>1</CategoryID> <CategoryName>sample string 1</CategoryName> </ProductCategory> </CategoryList> <ExternalIdsList> <ExternalId> <ID>1</ID> <AdvancedOptionSufix>sample string 1</AdvancedOptionSufix> <ExternalId1>sample string 2</ExternalId1> <ExternalId2>sample string 3</ExternalId2> <ExternalIdType>sample string 4</ExternalIdType> </ExternalId> <ExternalId> <ID>1</ID> <AdvancedOptionSufix>sample string 1</AdvancedOptionSufix> <ExternalId1>sample string 2</ExternalId1> <ExternalId2>sample string 3</ExternalId2> <ExternalIdType>sample string 4</ExternalIdType> </ExternalId> </ExternalIdsList> <CategoryExternalIdsList> <CategoryExternalId> <ID>1</ID> <CategoryID>1</CategoryID> <ExternalId1>sample string 1</ExternalId1> <ExternalIdType>sample string 2</ExternalIdType> </CategoryExternalId> <CategoryExternalId> <ID>1</ID> <CategoryID>1</CategoryID> <ExternalId1>sample string 1</ExternalId1> <ExternalIdType>sample string 2</ExternalIdType> </CategoryExternalId> </CategoryExternalIdsList> <NonTaxable>true</NonTaxable> <NotForSale>true</NotForSale> <Hide>true</Hide> <GiftCertificate>true</GiftCertificate> <HomeSpecial>true</HomeSpecial> <CategorySpecial>true</CategorySpecial> <NonSearchable>true</NonSearchable> <GiftWrapItem>true</GiftWrapItem> <ShipCost>1.1</ShipCost> <Weight>1.1</Weight> <Height>1.1</Height> <Width>1.1</Width> <Depth>1.1</Depth> <SelfShip>true</SelfShip> <FreeShipping>true</FreeShipping> <RewardPoints>1</RewardPoints> <RedeemPoints>1</RedeemPoints> <DisableRewards>true</DisableRewards> <StockAlert>1</StockAlert> <ReorderQuantity>1</ReorderQuantity> <InStockMessage>sample string 6</InStockMessage> <OutOfStockMessage>sample string 7</OutOfStockMessage> <BackOrderMessage>sample string 8</BackOrderMessage> <InventoryControl>1</InventoryControl> <WarehouseLocation>sample string 9</WarehouseLocation> <WarehouseBin>sample string 10</WarehouseBin> <WarehouseAisle>sample string 11</WarehouseAisle> <WarehouseCustom>sample string 12</WarehouseCustom> <Description>sample string 13</Description> <Keywords>sample string 14</Keywords> <ExtraField1>sample string 15</ExtraField1> <ExtraField2>sample string 16</ExtraField2> <ExtraField3>sample string 17</ExtraField3> <ExtraField4>sample string 18</ExtraField4> <ExtraField5>sample string 19</ExtraField5> <ExtraField6>sample string 20</ExtraField6> <ExtraField7>sample string 21</ExtraField7> <ExtraField8>sample string 22</ExtraField8> <ExtraField9>sample string 23</ExtraField9> <ExtraField10>sample string 24</ExtraField10> <ExtraField11>sample string 25</ExtraField11> <ExtraField12>sample string 26</ExtraField12> <ExtraField13>sample string 27</ExtraField13> <FeatureList> <Feature> <FeatureID>1</FeatureID> <FeatureTitle>sample string 1</FeatureTitle> <FeatureDescription>sample string 2</FeatureDescription> </Feature> <Feature> <FeatureID>1</FeatureID> <FeatureTitle>sample string 1</FeatureTitle> <FeatureDescription>sample string 2</FeatureDescription> </Feature> </FeatureList> <PluginList> <item> <key> <string>sample string 1</string> </key> <value> <string>sample string 2</string> </value> </item> <item> <key> <string>sample string 3</string> </key> <value> <string>sample string 4</string> </value> </item> </PluginList> <SampleEnable>true</SampleEnable> <SampleName>sample string 28</SampleName> <SampleSKUPrefix>sample string 29</SampleSKUPrefix> <SamplePrice>1.1</SamplePrice> <SampleWeight>1.1</SampleWeight> <ReviewAverage>1.1</ReviewAverage> <ReviewCount>1</ReviewCount> <MainImageFile>sample string 30</MainImageFile> <MainImageCaption>sample string 31</MainImageCaption> <ThumbnailFile>sample string 32</ThumbnailFile> <MediaFile>sample string 33</MediaFile> <AdditionalImageFile2>sample string 34</AdditionalImageFile2> <AdditionalImageCaption2>sample string 35</AdditionalImageCaption2> <AdditionalImageFile3>sample string 36</AdditionalImageFile3> <AdditionalImageCaption3>sample string 37</AdditionalImageCaption3> <AdditionalImageFile4>sample string 38</AdditionalImageFile4> <AdditionalImageCaption4>sample string 39</AdditionalImageCaption4> <ImageGalleryList> <ImageGallery> <ImageGalleryID>1</ImageGalleryID> <ImageGalleryFile>sample string 1</ImageGalleryFile> <ImageGalleryCaption>sample string 2</ImageGalleryCaption> <ImageGallerySorting>1</ImageGallerySorting> </ImageGallery> <ImageGallery> <ImageGalleryID>1</ImageGalleryID> <ImageGalleryFile>sample string 1</ImageGalleryFile> <ImageGalleryCaption>sample string 2</ImageGalleryCaption> <ImageGallerySorting>1</ImageGallerySorting> </ImageGallery> </ImageGalleryList> <OptionSetList> <OptionSet> <OptionSetID>1</OptionSetID> <OptionSetName>sample string 1</OptionSetName> <OptionSorting>1.1</OptionSorting> <OptionRequired>true</OptionRequired> <OptionType>sample string 2</OptionType> <OptionURL>sample string 3</OptionURL> <OptionAdditionalInformation>sample string 4</OptionAdditionalInformation> <OptionSizeLimit>1</OptionSizeLimit> <OptionList> <Options> <OptionID>1</OptionID> <OptionName>sample string 1</OptionName> <OptionSelected>true</OptionSelected> <OptionHide>true</OptionHide> <OptionValue>1.1</OptionValue> <OptionPartNumber>sample string 2</OptionPartNumber> <OptionSorting>1.1</OptionSorting> <OptionImagePath>sample string 3</OptionImagePath> <OptionBundleCatalogId>1</OptionBundleCatalogId> <OptionBundleQuantity>1</OptionBundleQuantity> </Options> <Options> <OptionID>1</OptionID> <OptionName>sample string 1</OptionName> <OptionSelected>true</OptionSelected> <OptionHide>true</OptionHide> <OptionValue>1.1</OptionValue> <OptionPartNumber>sample string 2</OptionPartNumber> <OptionSorting>1.1</OptionSorting> <OptionImagePath>sample string 3</OptionImagePath> <OptionBundleCatalogId>1</OptionBundleCatalogId> <OptionBundleQuantity>1</OptionBundleQuantity> </Options> </OptionList> </OptionSet> <OptionSet> <OptionSetID>1</OptionSetID> <OptionSetName>sample string 1</OptionSetName> <OptionSorting>1.1</OptionSorting> <OptionRequired>true</OptionRequired> <OptionType>sample string 2</OptionType> <OptionURL>sample string 3</OptionURL> <OptionAdditionalInformation>sample string 4</OptionAdditionalInformation> <OptionSizeLimit>1</OptionSizeLimit> <OptionList> <Options> <OptionID>1</OptionID> <OptionName>sample string 1</OptionName> <OptionSelected>true</OptionSelected> <OptionHide>true</OptionHide> <OptionValue>1.1</OptionValue> <OptionPartNumber>sample string 2</OptionPartNumber> <OptionSorting>1.1</OptionSorting> <OptionImagePath>sample string 3</OptionImagePath> <OptionBundleCatalogId>1</OptionBundleCatalogId> <OptionBundleQuantity>1</OptionBundleQuantity> </Options> <Options> <OptionID>1</OptionID> <OptionName>sample string 1</OptionName> <OptionSelected>true</OptionSelected> <OptionHide>true</OptionHide> <OptionValue>1.1</OptionValue> <OptionPartNumber>sample string 2</OptionPartNumber> <OptionSorting>1.1</OptionSorting> <OptionImagePath>sample string 3</OptionImagePath> <OptionBundleCatalogId>1</OptionBundleCatalogId> <OptionBundleQuantity>1</OptionBundleQuantity> </Options> </OptionList> </OptionSet> </OptionSetList> <AdvancedOptionList> <AdvancedOption> <AdvancedOptionCode>sample string 1</AdvancedOptionCode> <AdvancedOptionSufix>sample string 2</AdvancedOptionSufix> <AdvancedOptionName>sample string 3</AdvancedOptionName> <AdvancedOptionCost>1.1</AdvancedOptionCost> <AdvancedOptionStock>1</AdvancedOptionStock> <AdvancedOptionWeight>1.1</AdvancedOptionWeight> <AdvancedOptionPrice>1.1</AdvancedOptionPrice> <AdvancedOptionPrice2>1.1</AdvancedOptionPrice2> <AdvancedOptionPrice3>1.1</AdvancedOptionPrice3> <AdvancedOptionPrice4>1.1</AdvancedOptionPrice4> <AdvancedOptionPrice5>1.1</AdvancedOptionPrice5> <AdvancedOptionPrice6>1.1</AdvancedOptionPrice6> <AdvancedOptionPrice7>1.1</AdvancedOptionPrice7> <AdvancedOptionPrice8>1.1</AdvancedOptionPrice8> <AdvancedOptionPrice9>1.1</AdvancedOptionPrice9> <AdvancedOptionPrice10>1.1</AdvancedOptionPrice10> <AdvancedOptionGTIN>sample string 4</AdvancedOptionGTIN> </AdvancedOption> <AdvancedOption> <AdvancedOptionCode>sample string 1</AdvancedOptionCode> <AdvancedOptionSufix>sample string 2</AdvancedOptionSufix> <AdvancedOptionName>sample string 3</AdvancedOptionName> <AdvancedOptionCost>1.1</AdvancedOptionCost> <AdvancedOptionStock>1</AdvancedOptionStock> <AdvancedOptionWeight>1.1</AdvancedOptionWeight> <AdvancedOptionPrice>1.1</AdvancedOptionPrice> <AdvancedOptionPrice2>1.1</AdvancedOptionPrice2> <AdvancedOptionPrice3>1.1</AdvancedOptionPrice3> <AdvancedOptionPrice4>1.1</AdvancedOptionPrice4> <AdvancedOptionPrice5>1.1</AdvancedOptionPrice5> <AdvancedOptionPrice6>1.1</AdvancedOptionPrice6> <AdvancedOptionPrice7>1.1</AdvancedOptionPrice7> <AdvancedOptionPrice8>1.1</AdvancedOptionPrice8> <AdvancedOptionPrice9>1.1</AdvancedOptionPrice9> <AdvancedOptionPrice10>1.1</AdvancedOptionPrice10> <AdvancedOptionGTIN>sample string 4</AdvancedOptionGTIN> </AdvancedOption> </AdvancedOptionList> <RelatedProductList> <RelatedProduct> <RelatedIndexID>1</RelatedIndexID> <RelatedProductID>1</RelatedProductID> <RelatedProductSorting>1</RelatedProductSorting> </RelatedProduct> <RelatedProduct> <RelatedIndexID>1</RelatedIndexID> <RelatedProductID>1</RelatedProductID> <RelatedProductSorting>1</RelatedProductSorting> </RelatedProduct> </RelatedProductList> <UpSellingItemList> <UpSellingItem> <UpSellingIndexID>1</UpSellingIndexID> <UpSellingItemID>1</UpSellingItemID> <UpSellingItemSorting>1</UpSellingItemSorting> </UpSellingItem> <UpSellingItem> <UpSellingIndexID>1</UpSellingIndexID> <UpSellingItemID>1</UpSellingItemID> <UpSellingItemSorting>1</UpSellingItemSorting> </UpSellingItem> </UpSellingItemList> <DiscountList> <Discount> <DiscountID>1</DiscountID> <DiscountPriceLevel>1</DiscountPriceLevel> <DiscountLowbound>1.1</DiscountLowbound> <DiscountUpbound>1.1</DiscountUpbound> <DiscountPrice>1.1</DiscountPrice> <DiscountPercentage>true</DiscountPercentage> </Discount> <Discount> <DiscountID>1</DiscountID> <DiscountPriceLevel>1</DiscountPriceLevel> <DiscountLowbound>1.1</DiscountLowbound> <DiscountUpbound>1.1</DiscountUpbound> <DiscountPrice>1.1</DiscountPrice> <DiscountPercentage>true</DiscountPercentage> </Discount> </DiscountList> <DoNotUseCategoryOptions>true</DoNotUseCategoryOptions> <DateCreated>2024-04-18T19:29:31.1612805-04:00</DateCreated> <ListingTemplateID>1</ListingTemplateID> <ListingTemplateName>sample string 40</ListingTemplateName> <LoginRequiredOptionID>1</LoginRequiredOptionID> <LoginRequiredOptionName>sample string 41</LoginRequiredOptionName> <LoginRequiredOptionRedirectTo>sample string 42</LoginRequiredOptionRedirectTo> <AllowAccessCustomerGroupID>1</AllowAccessCustomerGroupID> <AllowAccessCustomerGroupName>sample string 43</AllowAccessCustomerGroupName> <RMAMaxPeriod>sample string 44</RMAMaxPeriod> <CanonicalUrl>sample string 45</CanonicalUrl> <TaxCode>sample string 46</TaxCode> <DisplayText>sample string 47</DisplayText> <MinimumQuantity>1.1</MinimumQuantity> <MaximumQuantity>1.1</MaximumQuantity> <AllowOnlyMultiples>true</AllowOnlyMultiples> <AllowFractionalQuantity>true</AllowFractionalQuantity> <QuantityOptions>sample string 48</QuantityOptions> <GroupOptionsForQuantityPricing>true</GroupOptionsForQuantityPricing> <ApplyQuantityDiscountToOptions>true</ApplyQuantityDiscountToOptions> <EnableMakeAnOfferFeature>true</EnableMakeAnOfferFeature> <MinimumAcceptableOffer>sample string 49</MinimumAcceptableOffer> <PriceLevel1>1.1</PriceLevel1> <PriceLevel1Hide>true</PriceLevel1Hide> <PriceLevel2>1.1</PriceLevel2> <PriceLevel2Hide>true</PriceLevel2Hide> <PriceLevel3>1.1</PriceLevel3> <PriceLevel3Hide>true</PriceLevel3Hide> <PriceLevel4>1.1</PriceLevel4> <PriceLevel4Hide>true</PriceLevel4Hide> <PriceLevel5>1.1</PriceLevel5> <PriceLevel5Hide>true</PriceLevel5Hide> <PriceLevel6>1.1</PriceLevel6> <PriceLevel6Hide>true</PriceLevel6Hide> <PriceLevel7>1.1</PriceLevel7> <PriceLevel7Hide>true</PriceLevel7Hide> <PriceLevel8>1.1</PriceLevel8> <PriceLevel8Hide>true</PriceLevel8Hide> <PriceLevel9>1.1</PriceLevel9> <PriceLevel9Hide>true</PriceLevel9Hide> <PriceLevel10>1.1</PriceLevel10> <PriceLevel10Hide>true</PriceLevel10Hide> <BuyButtonLink>sample string 50</BuyButtonLink> <ProductLink>sample string 51</ProductLink> <Title>sample string 52</Title> <CustomFileName>sample string 53</CustomFileName> <RedirectLink>sample string 54</RedirectLink> <MetaTags>sample string 55</MetaTags> <SpecialInstructions>sample string 56</SpecialInstructions> <AssignKey>true</AssignKey> <ReUseKeys>true</ReUseKeys> <SerialList> <Serial> <SerialID>1</SerialID> <SerialUses>1</SerialUses> <SerialCode>sample string 1</SerialCode> </Serial> <Serial> <SerialID>1</SerialID> <SerialUses>1</SerialUses> <SerialCode>sample string 1</SerialCode> </Serial> </SerialList> <EProductList> <EProduct> <FileNumber>1</FileNumber> <FilePath>sample string 1</FilePath> </EProduct> <EProduct> <FileNumber>1</FileNumber> <FilePath>sample string 1</FilePath> </EProduct> </EProductList> </Product>
Sample Request |
|
Please note: when sending information in any of the following keys of the product array, the product information contained in these keys will REPLACE the existing information, and not update it. To update information within these keys without replacing existing information, use the specific web service for those items (e.g. /Products/{catalogId}/Distributors):
- DistributorList
- CategoryList
- ImageGalleryList
- OptionSetList
- AdvancedOptionList
- RelatedProductList
- UpSellingItemList
- DiscountList
- SerialList
- EProductList
Response Information
application/json, text/json
[ { "Key":"CatalogID", "Value":"1234", "Status":"200", "Message":"updated successfully", } ]
Resource Description
HttpResponseMessageName | Description | Type | Additional information |
---|---|---|---|
Version | Version |
None. |
|
Content | HttpContent |
None. |
|
StatusCode | HttpStatusCode |
None. |
|
ReasonPhrase | string |
None. |
|
Headers | Collection of Object |
None. |
|
RequestMessage | HttpRequestMessage |
None. |
|
IsSuccessStatusCode | boolean |
None. |