product

product.add

Add new product to store.

post/product.add.json

Request

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

Request body

namestring required

Defines product's name that has to be added

modelstring required

Defines product's model that has to be added

descriptionstring required

Defines product's description that has to be added

pricenumber required

Defines product's price that has to be added

skustring

Defines product's sku that has to be added

short_descriptionstring

Defines short description

typestring

Defines product's type

statusstring

Defines product's status

visiblestring

Set visibility status

category_idstring

Defines product add that is specified by category id

categories_idsstring

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

product_classstring

A categorization for the product

product_typestring

A categorization for the product

is_virtualboolean

Defines whether the product is virtual

downloadableboolean

Defines whether the product is downloadable

is_supplyboolean

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

available_for_viewboolean

Specifies the set of visible/invisible products for users

available_for_saleboolean

Specifies the set of visible/invisible products for sale

store_idstring

Store Id

stores_idsstring

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

lang_idstring

Language id

old_pricenumber

Defines product's old price

special_pricenumber

Defines product's model that has to be added

wholesale_pricenumber

This parameter is deprecated. Please use the <strong>old_price</strong> parameter instead.

cost_pricenumber

Defines new product's cost price

fixed_cost_shipping_pricenumber

Specifies product's fixed cost shipping price

buyitnow_pricenumber

Defines buy it now value

reserve_pricenumber

Defines reserve price value

measure_unitstring

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

unit_pricenumber

Defines new product's unit price

prices_inc_taxboolean

Indicates whether prices include tax.

retail_pricenumber

Defines new product's retail price

quantitynumber

Defines product's quantity that has to be added

in_stockboolean

Set stock status

manage_stockboolean

Defines inventory tracking for product

warehouse_idstring

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

backorder_statusstring

Set backorder status

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.

low_stock_thresholdnumber

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

weightnumber

Weight

weight_unitstring

Weight Unit

widthnumber

Defines product's width

heightnumber

Defines product's height

lengthnumber

Defines product's length

dimensions_unitstring

Weight Unit

barcodestring

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

upcstring

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

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.

gtinstring

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

mpnstring

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

asinstring

Amazon Standard Identification Number.

product_referencestring

Groups all variations, that you want to combine into one product.

external_product_linkstring

External product link

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

country_of_originstring

The country where the inventory item was made

manufacturerstring

Defines product's manufacturer

manufacturer_idstring

Defines product's manufacturer by manufacturer_id

brand_namestring

Defines product brand name

image_urlstring

Image Url

image_namestring

Defines image's name

additional_image_urlsstring[]

Image Url

related_products_idsstring

Defines product's related products ids that has to be added

up_sell_products_idsstring

Defines product's up-sell products ids that has to be added

cross_sell_products_idsstring

Defines product's cross-sell products ids that has to be added

attribute_set_namestring

Defines product’s attribute set name in Magento

attribute_namestring

Defines product’s attribute name separated with a comma in Magento

search_keywordsstring

Defines unique search keywords

tagsstring

Product tags

materialsstring[]

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

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.

sprice_createstring

Defines the date of special price creation

sprice_modifiedstring

Defines the date of special price modification

sprice_expirestring

Defines the term of special price offer duration

created_atstring

Defines the date of entity creation

auto_renewboolean

When true, automatically renews a listing upon its expiration.

when_madestring

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

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

urlstring

Defines unique product's URL

seo_urlstring

Defines unique URL for SEO

tax_class_idstring

Defines tax classes where entity has to be added

taxableboolean

Specifies whether a tax is charged

conditionstring

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

condition_descriptionstring

Detailed description of the product condition.

allow_display_conditionboolean

Flag used to determine whether the product condition is shown to the customer on the product page.

payment_methodsstring[]

Identifies the payment method (such as PayPal) that the seller will accept when the buyer pays for the item. Look at cart.info method response for allowed values.<hr><div style="font-style:normal">Param structure:<div style="margin-left: 2%;"><code style="padding:0; background-color:#ffffff;font-size:85%;font-family:monospace;">payment_methods[0] = string</br>payment_methods[1] = string</br></code></div></div>

paypal_emailstring

Valid PayPal email address for the PayPal account that the seller will use if they offer PayPal as a payment method for the listing.

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.

is_free_shippingboolean

Specifies product's free shipping flag that has to be added

delivery_codestring

The delivery promise that applies to offer

delivery_typestring

Defines the type of the delivery.

delivery_timeinteger

Defines delivery time in days.

delivery_option_idsstring

Defines delivery options for product by ids.

listing_durationstring

Describes the number of days the seller wants the listing to be active. Look at cart.info method response for allowed values.

listing_typestring

Indicates the selling format of the marketplace listing.

category_typestring

Specifies the type of category (e.g., apparel or other) for the product being added.

return_acceptedboolean

Indicates whether the seller allows the buyer to return the item.

auction_confidentiality_levelstring

This allows buyers to remain anonymous when the bid or buy an item.

production_partner_idsstring

Defines product's production partner ids that has to be added

marketplace_item_propertiesstring

String containing the JSON representation of the supplied data

clear_cacheboolean

Is cache clear required

viewed_countinteger

Specifies the number of product's reviews

ordered_countinteger

Defines how many times the product was ordered

vendor_idstring

Vendor Id

shop_section_idinteger

Add Shop Section Id

return_policy_idinteger

Add Return Policy Id

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

{
  "name": "Bag",
  "model": "bag_01",
  "description": "Product description",
  "price": 99.9,
  "sku": "bag_01",
  "short_description": "Short description. This is very short description",
  "type": "configurable",
  "status": "disabled",
  "visible": "search",
  "categories_ids": "23,56",
  "product_class": "Shirts",
  "product_type": "BICYCLE",
  "downloadable": true,
  "store_id": "1",
  "stores_ids": "1,2",
  "old_price": 99.9,
  "special_price": 56.9,
  "wholesale_price": 56.12,
  "cost_price": 65.9,
  "fixed_cost_shipping_price": 5.5,
  "buyitnow_price": 65.9,
  "reserve_price": 65.9,
  "measure_unit": "Piece",
  "unit_price": 10.5,
  "prices_inc_tax": true,
  "retail_price": 6.9,
  "quantity": 6,
  "in_stock": true,
  "warehouse_id": "1",
  "backorder_status": "true",
  "min_order_quantity": 1,
  "max_order_quantity": 1,
  "low_stock_threshold": 1,
  "weight": 23.69,
  "weight_unit": "lb",
  "width": 56.12,
  "height": 56.12,
  "length": 56.12,
  "dimensions_unit": "cm",
  "barcode": "9770317847001",
  "upc": "9770317847001",
  "ean": "5901234123457",
  "isbn": "9783161484100",
  "gtin": "12345678912345",
  "mpn": "9770317847001",
  "asin": "97703178470",
  "product_reference": "5901234123457",
  "external_product_link": "http://example.com/t-shirt",
  "harmonized_system_code": "123456",
  "country_of_origin": "123456",
  "manufacturer": "Samsung",
  "manufacturer_id": "1",
  "brand_name": "Abidas",
  "image_url": "https://docs.api2cart.com/img/logo.png",
  "image_name": "abibas.png",
  "related_products_ids": "4,5",
  "up_sell_products_ids": "4,5",
  "cross_sell_products_ids": "4,5",
  "attribute_set_name": "Shoes",
  "attribute_name": "Color,Manufacturer",
  "search_keywords": "key1,key2,key3",
  "tags": "tag1,tag2",
  "avail_from": "2029-10-25T15:54:37-0500",
  "sprice_create": "2018-08-25 23:56:12",
  "sprice_modified": "2018-12-05 13:46:20",
  "sprice_expire": "2018-08-25 23:56:12",
  "created_at": "2014-08-09 13:13:13",
  "when_made": "2020_2025",
  "meta_title": "category,test",
  "meta_keywords": "category,test",
  "meta_description": "category,test",
  "url": "/product_slug",
  "seo_url": "some seo url",
  "condition": "Like New",
  "condition_description": "Almost perfect condition, a few scratches",
  "paypal_email": "paypall@mail.com",
  "shipping_template_id": 40256592690,
  "is_free_shipping": true,
  "delivery_code": "24uurs-23",
  "delivery_type": "PARCEL",
  "delivery_time": 1,
  "delivery_option_ids": "6956548250505111111,6956548250505111112",
  "listing_duration": "Days_3",
  "listing_type": "Auction",
  "category_type": "Apparel",
  "return_accepted": true,
  "auction_confidentiality_level": "public",
  "production_partner_ids": "4,5",
  "marketplace_item_properties": "{\"color\":[\"Silver\"],\"manufacturer\":\"Philips\",\"features\":[\"3 way\"],\"countPerPack\":1,\"watts\":{\"unit\":\"W\",\"measure\":40}}",
  "viewed_count": 9,
  "ordered_count": 15,
  "vendor_id": "1",
  "shop_section_id": 12345678,
  "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.