product

product.update

This method can be used to update certain product data. The list of supported parameters depends on the specific platform. Please transmit only those parameters that are supported by the particular platform. Please note that to update the product quantity, it is recommended to use relative parameters (increase_quantity or reduce_quantity) to avoid unexpected overwrites on heavily loaded stores.

put/product.update.json

Request

Base URL: https://api.api2cart.com/v1.1
URL: https://api.api2cart.com/v1.1/product.update.json
Auth: API key in header x-api-key and API key in header x-store-key

Request body

idstring

Defines product id that has to be updated

modelstring

Defines product model that has to be updated

skustring

Defines new product's sku

namestring

Defines product's name that has to be updated

descriptionstring

Defines new product's description

short_descriptionstring

Defines short description

prices_inc_taxboolean

Indicates whether prices include tax.

pricenumber

Defines new product's price

old_pricenumber

Defines product's old price

special_pricenumber

Defines new product's special price

sprice_createstring

Defines the date of special price creation

sprice_expirestring

Defines the term of special price offer duration

cost_pricenumber

Defines new product's cost price

fixed_cost_shipping_pricenumber

Specifies product's fixed cost shipping price

retail_pricenumber

Defines new product's retail price

reserve_pricenumber

Defines reserve price value

buyitnow_pricenumber

Defines buy it now value

taxableboolean

Specifies whether a tax is charged

tax_class_idstring

Defines tax classes where entity has to be added

typestring

Defines product's type

statusstring

Defines product's status

conditionstring

The human-readable label for the condition (e.g., "New").

visiblestring

Set visibility status

in_stockboolean

Set stock status. Effective only when manage_stock is false — when stock is managed, the status is derived from quantity automatically and this parameter is ignored.

availboolean

Defines category's visibility status

avail_fromstring

Allows to schedule a time in the future that the item becomes available. The value should be greater than the current date and time.

product_classstring

A categorization for the product

brand_namestring

Retrieves brands specified by brand name

available_for_viewboolean

Specifies the set of visible/invisible products for users

measure_unitstring

Unit for the price per unit. Must be in allowed list

unit_pricenumber

Defines new product's unit price

stores_idsstring

Assign product to the stores that is specified by comma-separated stores' id

store_idstring

Defines store id where the product should be found

lang_idstring

Language id

quantitynumber

Defines new product's quantity. Effective only when manage_stock is true — otherwise the value is ignored. To enable stock tracking and set a quantity in one call, pass manage_stock=true together with quantity.

reserve_quantitynumber

This parameter allows to reserve/unreserve product quantity.

manage_stockboolean

Defines inventory tracking for product. When true, quantity sets the stock level and the stock status is derived from it; when false, quantity is ignored and in_stock sets the status directly.

backorder_statusstring

Set backorder status

increase_quantitynumber

Defines the incremental changes in product quantity. Effective only when manage_stock is true — otherwise the value is ignored.

reduce_quantitynumber

Defines the decrement changes in product quantity. Effective only when manage_stock is true.

low_stock_thresholdnumber

Specify the quantity threshold below which the product is considered low in stock

min_order_quantitynumber

The minimum quantity an order must contain, to be eligible to purchase this product.

max_order_quantitynumber

The maximum quantity an order can contain when purchasing the product.

warehouse_idstring

This parameter is used for selecting a warehouse where you need to set/modify a product quantity.

weightnumber

Weight

weight_unitstring

Weight Unit

heightnumber

Defines product's height

lengthnumber

Defines product's length

widthnumber

Defines product's width

dimensions_unitstring

Weight Unit

is_virtualboolean

Defines whether the product is virtual

is_free_shippingboolean

Specifies product free shipping flag that has to be updated

gtinstring

Global Trade Item Number. An GTIN is an identifier for trade items.

upcstring

Universal Product Code. A UPC (UPC-A) is a commonly used identifer for many different products.

mpnstring

Manufacturer Part Number. A MPN is an identifier of a particular part design or material used.

eanstring

European Article Number. An EAN is a unique 8 or 13-digit identifier that many industries (such as book publishers) use to identify products.

isbnstring

International Standard Book Number. An ISBN is a unique identifier for books.

barcodestring

A barcode is a unique code composed of numbers used as a product identifier.

manufacturerstring

Defines product's manufacturer

manufacturer_idstring

Defines product's manufacturer by manufacturer_id

vendor_idstring

Vendor Id

categories_idsstring

Defines product add that is specified by comma-separated categories id

related_products_idsstring

Defines product related products ids that has to be updated

up_sell_products_idsstring

Defines product up-sell products ids that has to be updated

cross_sell_products_idsstring

Defines product cross-sells products ids that has to be updated

meta_titlestring

Defines unique meta title for each entity

meta_keywordsstring

Defines unique meta keywords for each entity

meta_descriptionstring

Defines unique meta description of a entity

seo_urlstring

Defines unique URL for SEO

search_keywordsstring

Defines unique search keywords

tagsstring

Product tags

delivery_codestring

The delivery promise that applies to offer

country_of_originstring

The country where the inventory item was made

harmonized_system_codestring

Harmonized System Code. An HSC is a 6-digit identifier that allows participating countries to classify traded goods on a common basis for customs purposes

shipping_template_idinteger

The numeric ID of the shipping template associated with the products in Etsy. You can find possible values in the "cart.info" API method response, in the field shipping_zones[]->id.

processing_profile_idinteger

The numeric ID of the processing profile (readiness state) for physical products in Etsy. You can find possible values in the "cart.info" API method response, in the field processing_profiles[]->readiness_state_id.

when_madestring

An enumerated string for the era in which the maker made the product.

is_supplyboolean

If true, it indicates the product as a supply, otherwise it indicates that it is a finished product.

downloadableboolean

Defines whether the product is downloadable

materialsstring[]

A list of material strings for materials used in the product.

auto_renewboolean

When true, automatically renews a listing upon its expiration.

on_saleboolean

Set whether the product on sale

production_partner_idsstring

Defines product production partner ids that has to be updated

report_request_idstring

Report request id

disable_report_cacheboolean

Disable report cache for current request

reindexboolean

Is reindex required

clear_cacheboolean

Is cache clear required

check_process_statusboolean

Disable or enable check process status. Please note that the response will be slower due to additional requests to the store.

shop_section_idinteger

Add Shop Section Id

external_product_linkstring

External product link

marketplace_item_propertiesstring

String containing the JSON representation of the supplied data

manufacturer_idsstring

A comma-separated list of manufacturer IDs. Retrieve the IDs from the cart.info method.

responsible_person_idsstring

A comma-separated list of responsible person IDs. Retrieve the IDs from the cart.info method.

idempotency_keystring

A unique identifier associated with a specific request. Repeated requests with the same <strong>idempotency_key</strong> return a cached response without re-executing the business logic. <strong>Please note that the cache lifetime is 15 minutes.</strong>

Example request

{
  "model": "bag_01",
  "sku": "bag_01",
  "name": "Pancil",
  "description": "New product description",
  "short_description": "Short description. This is very short description",
  "prices_inc_tax": true,
  "price": 99.9,
  "old_price": 99.9,
  "special_price": 56.9,
  "sprice_create": "2018-08-25 23:56:12",
  "sprice_expire": "2018-08-25 23:56:12",
  "cost_price": 65.9,
  "fixed_cost_shipping_price": 5.5,
  "retail_price": 6.9,
  "reserve_price": 65.9,
  "buyitnow_price": 65.9,
  "type": "simple",
  "status": "disabled",
  "condition": "Like New",
  "visible": "search",
  "in_stock": true,
  "avail_from": "2029-10-25T15:54:37-0500",
  "product_class": "Shirts",
  "brand_name": "Abidas",
  "measure_unit": "Piece",
  "unit_price": 10.5,
  "stores_ids": "1,2",
  "store_id": "1",
  "quantity": 6,
  "backorder_status": "true",
  "increase_quantity": 4,
  "reduce_quantity": 4,
  "low_stock_threshold": 1,
  "min_order_quantity": 1,
  "max_order_quantity": 1,
  "warehouse_id": "1",
  "weight": 23.69,
  "weight_unit": "lb",
  "height": 56.12,
  "length": 56.12,
  "width": 56.12,
  "dimensions_unit": "cm",
  "is_free_shipping": true,
  "gtin": "12345678912345",
  "upc": "9770317847001",
  "mpn": "9770317847001",
  "ean": "5901234123457",
  "isbn": "9783161484100",
  "barcode": "9770317847001",
  "manufacturer": "Samsung",
  "manufacturer_id": "1",
  "vendor_id": "1",
  "categories_ids": "23,56",
  "related_products_ids": "4,5",
  "up_sell_products_ids": "4,5",
  "cross_sell_products_ids": "4,5",
  "meta_title": "category,test",
  "meta_keywords": "category,test",
  "meta_description": "category,test",
  "seo_url": "some seo url",
  "search_keywords": "key1,key2,key3",
  "tags": "tag1,tag2",
  "delivery_code": "24uurs-23",
  "country_of_origin": "123456",
  "harmonized_system_code": "123456",
  "shipping_template_id": 40256592690,
  "when_made": "2020_2025",
  "downloadable": true,
  "production_partner_ids": "4,5",
  "report_request_id": "105245017661",
  "shop_section_id": 12345678,
  "external_product_link": "http://example.com/t-shirt",
  "marketplace_item_properties": "{\"color\":[\"Silver\"],\"manufacturer\":\"Philips\",\"features\":[\"3 way\"],\"countPerPack\":1,\"watts\":{\"unit\":\"W\",\"measure\":40}}",
  "manufacturer_ids": "1,2,3",
  "responsible_person_ids": "1,2,3",
  "idempotency_key": "098f6bcd4621d373cade4e832627b4f6"
}

Response

successful operation

return_codeinteger

return_messagestring

Changes

No recorded changes to this operation across all 1 revision of this API.