Skip to content

Latest commit

 

History

History
120 lines (117 loc) · 13.5 KB

ProductAdd.md

File metadata and controls

120 lines (117 loc) · 13.5 KB

# ProductAdd

Properties

Name Type Description Notes
name string Defines product's name that has to be added
model string Defines product's model that has to be added
description string Defines product's description that has to be added
price float Defines product's price that has to be added
sku string Defines product's sku that has to be added [optional]
short_description string Defines short description [optional]
type string Defines product's type [optional] [default to 'simple']
status string Defines product's status [optional]
visible string Set visibility status [optional]
category_id string Defines product add that is specified by category id [optional]
categories_ids string Defines product add that is specified by comma-separated categories id [optional]
product_class string A categorization for the product [optional]
product_type string A categorization for the product [optional]
is_virtual bool Defines whether the product is virtual [optional] [default to false]
downloadable bool Defines whether the product is downloadable [optional] [default to false]
is_supply bool If true, it indicates the product as a supply, otherwise it indicates that it is a finished product. [optional] [default to true]
available_for_view bool Specifies the set of visible/invisible products for users [optional] [default to true]
available_for_sale bool Specifies the set of visible/invisible products for sale [optional] [default to true]
store_id string Store Id [optional]
stores_ids string Assign product to the stores that is specified by comma-separated stores' id [optional]
lang_id string Language id [optional]
old_price float Defines product's old price [optional]
special_price float Defines product's model that has to be added [optional]
wholesale_price float Defines product's sale price [optional]
cost_price float Defines new product's cost price [optional]
fixed_cost_shipping_price float Specifies product's fixed cost shipping price [optional]
tier_prices \OpenAPI\Client\Model\ProductAddTierPricesInner[] Defines product's tier prices [optional]
group_prices \OpenAPI\Client\Model\ProductAddGroupPricesInner[] Defines product's group prices [optional]
buyitnow_price float Defines buy it now value [optional]
reserve_price float Defines reserve price value [optional]
quantity float Defines product's quantity that has to be added [optional] [default to 0]
in_stock bool Set stock status [optional]
manage_stock bool Defines inventory tracking for product [optional]
warehouse_id string This parameter is used for selecting a warehouse where you need to set/modify a product quantity. [optional]
backorder_status string Set backorder status [optional]
min_order_quantity float The minimum quantity an order must contain, to be eligible to purchase this product. [optional]
max_order_quantity float The maximum quantity an order can contain when purchasing the product. [optional]
weight float Weight [optional] [default to 0]
weight_unit string Weight Unit [optional]
width float Defines product's width [optional]
height float Defines product's height [optional]
length float Defines product's length [optional]
dimensions_unit string Weight Unit [optional]
barcode string A barcode is a unique code composed of numbers used as a product identifier. [optional]
upc string Universal Product Code. A UPC (UPC-A) is a commonly used identifer for many different products. [optional]
ean string European Article Number. An EAN is a unique 8 or 13-digit identifier that many industries (such as book publishers) use to identify products. [optional]
isbn string International Standard Book Number. An ISBN is a unique identifier for books. [optional]
gtin string Global Trade Item Number. An GTIN is an identifier for trade items. [optional]
mpn string Manufacturer Part Number. A MPN is an identifier of a particular part design or material used. [optional]
asin string Amazon Standard Identification Number. [optional]
product_reference string Groups all variations, that you want to combine into one product. [optional]
harmonized_system_code string 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 [optional]
country_of_origin string The country where the inventory item was made [optional]
manufacturer string Defines product's manufacturer [optional]
manufacturer_id string Defines product's manufacturer by manufacturer_id [optional]
manufacturer_info \OpenAPI\Client\Model\ProductAddManufacturerInfo [optional]
brand_name string Defines product brand name [optional]
image_url string Image Url [optional]
image_name string Defines image's name [optional]
additional_image_urls string[] Image Url [optional]
files \OpenAPI\Client\Model\ProductAddFilesInner[] File Url [optional]
size_chart \OpenAPI\Client\Model\ProductAddSizeChart [optional]
related_products_ids string Defines product's related products ids that has to be added [optional]
up_sell_products_ids string Defines product's up-sell products ids that has to be added [optional]
cross_sell_products_ids string Defines product's cross-sell products ids that has to be added [optional]
attribute_set_name string Defines product’s attribute set name in Magento [optional] [default to 'Default']
attribute_name string Defines product’s attribute name separated with a comma in Magento [optional]
search_keywords string Defines unique search keywords [optional]
tags string Product tags [optional]
materials string[] A list of material strings for materials used in the product. [optional]
certifications \OpenAPI\Client\Model\ProductAddCertificationsInner[] An array of product certifications. The list of possible certifications can be obtained using the &quot;<i>category.info</i>&quot; method (<i>additional_fields->rules->product_certifications</i>). [optional]
specifics \OpenAPI\Client\Model\ProductAddSpecificsInner[] An array of Item Specific Name/Value pairs used by the seller to provide descriptive details of an item in a structured manner. The list of possible specifications can be obtained using the category.info method (additional_fields->product_specifics). <b>The structure of the parameter is different for specific platforms.</b> [optional]
avail_from string Allows to schedule a time in the future that the item becomes available. The value should be greater than the current date and time. [optional]
sprice_create string Defines the date of special price creation [optional]
sprice_modified string Defines the date of special price modification [optional]
sprice_expire string Defines the term of special price offer duration [optional]
created_at string Defines the date of entity creation [optional]
auto_renew bool When true, automatically renews a listing upon its expiration. [optional] [default to false]
when_made string An enumerated string for the era in which the maker made the product. [optional] [default to 'made_to_order']
meta_title string Defines unique meta title for each entity [optional]
meta_keywords string Defines unique meta keywords for each entity [optional]
meta_description string Defines unique meta description of a entity [optional]
url string Defines unique product's URL [optional]
seo_url string Defines unique URL for SEO [optional]
tax_class_id string Defines tax classes where entity has to be added [optional]
taxable bool Specifies whether a tax is charged [optional] [default to true]
sales_tax \OpenAPI\Client\Model\ProductAddSalesTax [optional]
condition string The human-readable label for the condition (e.g., &quot;New&quot;). [optional]
condition_description string Detailed description of the product condition. [optional]
allow_display_condition bool Flag used to determine whether the product condition is shown to the customer on the product page. [optional]
payment_methods string[] 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=&quot;font-style:normal&quot;>Param structure:<div style=&quot;margin-left: 2%;&quot;><code style=&quot;padding:0; background-color:#ffffff;font-size:85%;font-family:monospace;&quot;>payment_methods[0] = string</br>payment_methods[1] = string</br></code></div></div> [optional]
paypal_email string Valid PayPal email address for the PayPal account that the seller will use if they offer PayPal as a payment method for the listing. [optional]
shipping_template_id int The numeric ID of the shipping template associated with the products in Etsy. You can find possible values in the &quot;cart.info&quot; API method response, in the field shipping_zones[]->id. [optional] [default to 0]
shipping_details \OpenAPI\Client\Model\ProductAddShippingDetailsInner[] The shipping details, including flat and calculated shipping costs and shipping insurance costs. Look at cart.info method response for allowed values.<hr><div style=&quot;font-style:normal&quot;>Param structure:<div style=&quot;margin-left: 2%;&quot;><code style=&quot;padding:0; background-color:#ffffff;font-size:85%;font-family:monospace;&quot;>shipping_details[0][<b>shipping_type</b>] = string </br>shipping_details[0][<b>shipping_service</b>] = string</br>shipping_details[0][<b>shipping_cost</b>] = decimal</br>shipping_details[1][<b>shipping_type</b>] = string </br>shipping_details[1][<b>shipping_service</b>] = string</br>shipping_details[1][<b>shipping_cost</b>] = decimal</br></code></div></div> [optional]
is_free_shipping bool Specifies product's free shipping flag that has to be added [optional]
delivery_code string The delivery promise that applies to offer [optional]
delivery_type string Defines the type of the delivery. [optional]
delivery_time int Defines delivery time in days. [optional]
delivery_option_ids string Defines delivery options for product by ids. [optional]
package_details \OpenAPI\Client\Model\ProductAddPackageDetails [optional]
logistic_info \OpenAPI\Client\Model\ProductAddLogisticInfoInner[] Defines product's logistic channel settings [optional]
listing_duration string Describes the number of days the seller wants the listing to be active. Look at cart.info method response for allowed values. [optional]
listing_type string Indicates the selling format of the marketplace listing. [optional] [default to 'FixedPrice']
return_accepted bool Indicates whether the seller allows the buyer to return the item. [optional]
seller_profiles \OpenAPI\Client\Model\ProductAddSellerProfiles [optional]
auction_confidentiality_level string This allows buyers to remain anonymous when the bid or buy an item. [optional]
best_offer \OpenAPI\Client\Model\ProductAddBestOffer [optional]
production_partner_ids string Defines product's production partner ids that has to be added [optional]
marketplace_item_properties string String containing the JSON representation of the supplied data [optional]
clear_cache bool Is cache clear required [optional] [default to true]
viewed_count int Specifies the number of product's reviews [optional] [default to 0]
ordered_count int Defines how many times the product was ordered [optional] [default to 0]

[Back to Model list] [Back to API list] [Back to README]