| id |
string |
Defines product id that has to be updated |
[optional] |
| model |
string |
Defines product model that has to be updated |
[optional] |
| sku |
string |
Defines new product's sku |
[optional] |
| name |
string |
Defines product's name that has to be updated |
[optional] |
| description |
string |
Defines new product's description |
[optional] |
| short_description |
string |
Defines short description |
[optional] |
| prices_inc_tax |
bool |
Indicates whether prices include tax. |
[optional] [default to false] |
| price |
float |
Defines new product's price |
[optional] |
| old_price |
float |
Defines product's old price |
[optional] |
| special_price |
float |
Defines new product's special price |
[optional] |
| sprice_create |
string |
Defines the date of special price creation |
[optional] |
| sprice_expire |
string |
Defines the term of special price offer duration |
[optional] |
| cost_price |
float |
Defines new product's cost price |
[optional] |
| fixed_cost_shipping_price |
float |
Specifies product's fixed cost shipping price |
[optional] |
| retail_price |
float |
Defines new product's retail price |
[optional] |
| tier_prices |
\OpenAPI\Client\Model\ProductAddTierPricesInner[] |
Defines product's tier prices |
[optional] |
| reserve_price |
float |
Defines reserve price value |
[optional] |
| buyitnow_price |
float |
Defines buy it now value |
[optional] |
| taxable |
bool |
Specifies whether a tax is charged |
[optional] |
| tax_class_id |
string |
Defines tax classes where entity has to be added |
[optional] |
| type |
string |
Defines product's type |
[optional] |
| status |
string |
Defines product's status |
[optional] |
| condition |
string |
The human-readable label for the condition (e.g., "New"). |
[optional] |
| visible |
string |
Set visibility status |
[optional] |
| in_stock |
bool |
Set stock status |
[optional] |
| avail |
bool |
Defines category's visibility status |
[optional] [default to true] |
| 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] |
| product_class |
string |
A categorization for the product |
[optional] |
| brand_name |
string |
Retrieves brands specified by brand name |
[optional] |
| available_for_view |
bool |
Specifies the set of visible/invisible products for users |
[optional] |
| measure_unit |
string |
Unit for the price per unit. Must be in allowed list |
[optional] |
| unit_price |
float |
Defines new product's unit price |
[optional] |
| stores_ids |
string |
Assign product to the stores that is specified by comma-separated stores' id |
[optional] |
| store_id |
string |
Defines store id where the product should be found |
[optional] |
| lang_id |
string |
Language id |
[optional] |
| quantity |
float |
Defines new product's quantity |
[optional] |
| reserve_quantity |
float |
This parameter allows to reserve/unreserve product quantity. |
[optional] |
| manage_stock |
bool |
Defines inventory tracking for product |
[optional] |
| backorder_status |
string |
Set backorder status |
[optional] |
| increase_quantity |
float |
Defines the incremental changes in product quantity |
[optional] |
| reduce_quantity |
float |
Defines the decrement changes in product quantity |
[optional] |
| low_stock_threshold |
float |
Specify the quantity threshold below which the product is considered low in stock |
[optional] |
| warehouse_id |
string |
This parameter is used for selecting a warehouse where you need to set/modify a product quantity. |
[optional] |
| weight |
float |
Weight |
[optional] |
| weight_unit |
string |
Weight Unit |
[optional] |
| height |
float |
Defines product's height |
[optional] |
| length |
float |
Defines product's length |
[optional] |
| width |
float |
Defines product's width |
[optional] |
| dimensions_unit |
string |
Weight Unit |
[optional] |
| is_virtual |
bool |
Defines whether the product is virtual |
[optional] [default to false] |
| is_free_shipping |
bool |
Specifies product free shipping flag that has to be updated |
[optional] |
| gtin |
string |
Global Trade Item Number. An GTIN is an identifier for trade items. |
[optional] |
| upc |
string |
Universal Product Code. A UPC (UPC-A) is a commonly used identifer for many different products. |
[optional] |
| mpn |
string |
Manufacturer Part Number. A MPN is an identifier of a particular part design or material used. |
[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] |
| barcode |
string |
A barcode is a unique code composed of numbers used as a product identifier. |
[optional] |
| manufacturer |
string |
Defines product's manufacturer |
[optional] |
| manufacturer_id |
string |
Defines product's manufacturer by manufacturer_id |
[optional] |
| categories_ids |
string |
Defines product add that is specified by comma-separated categories id |
[optional] |
| related_products_ids |
string |
Defines product related products ids that has to be updated |
[optional] |
| up_sell_products_ids |
string |
Defines product up-sell products ids that has to be updated |
[optional] |
| cross_sell_products_ids |
string |
Defines product cross-sells products ids that has to be updated |
[optional] |
| 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] |
| seo_url |
string |
Defines unique URL for SEO |
[optional] |
| search_keywords |
string |
Defines unique search keywords |
[optional] |
| tags |
string |
Product tags |
[optional] |
| delivery_code |
string |
The delivery promise that applies to offer |
[optional] |
| package_details |
\OpenAPI\Client\Model\ProductAddPackageDetails |
|
[optional] |
| country_of_origin |
string |
The country where the inventory item was made |
[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] |
| shipping_template_id |
int |
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. |
[optional] [default to 0] |
| processing_profile_id |
int |
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. |
[optional] |
| when_made |
string |
An enumerated string for the era in which the maker made the product. |
[optional] [default to 'made_to_order'] |
| 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] |
| downloadable |
bool |
Defines whether the product is downloadable |
[optional] [default to false] |
| materials |
string[] |
A list of material strings for materials used in the product. |
[optional] |
| auto_renew |
bool |
When true, automatically renews a listing upon its expiration. |
[optional] [default to false] |
| on_sale |
bool |
Set whether the product on sale |
[optional] [default to false] |
| production_partner_ids |
string |
Defines product production partner ids that has to be updated |
[optional] |
| manufacturer_info |
\OpenAPI\Client\Model\ProductAddManufacturerInfo |
|
[optional] |
| report_request_id |
string |
Report request id |
[optional] |
| disable_report_cache |
bool |
Disable report cache for current request |
[optional] [default to false] |
| reindex |
bool |
Is reindex required |
[optional] [default to true] |
| clear_cache |
bool |
Is cache clear required |
[optional] [default to true] |
| check_process_status |
bool |
Disable or enable check process status. Please note that the response will be slower due to additional requests to the store. |
[optional] [default to false] |
| 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] |
| shop_section_id |
int |
Add Shop Section Id |
[optional] |
| personalization_details |
\OpenAPI\Client\Model\ProductAddPersonalizationDetails |
|
[optional] |
| personalization_questions |
\OpenAPI\Client\Model\ProductAddPersonalizationQuestionsInner[] |
Defines personalization questions for the listing as an array of question objects. Each question object supports the following fields: question_id (integer, nullable), question_text (string, 1-45 chars), instructions (string, nullable), question_type (string), required (boolean), max_allowed_characters (integer, nullable), max_allowed_files (integer, nullable), options (array, nullable). Cannot be used together with <strong>personalization_details</strong>. |
[optional] |
| external_product_link |
string |
External product link |
[optional] |
| marketplace_item_properties |
string |
String containing the JSON representation of the supplied data |
[optional] |
| min_order_quantity |
float |
The minimum quantity an order must contain, to be eligible to purchase this product. |
[optional] |
| manufacturer_ids |
string |
A comma-separated list of manufacturer IDs. Retrieve the IDs from the cart.info method. |
[optional] |
| responsible_person_ids |
string |
A comma-separated list of responsible person IDs. Retrieve the IDs from the cart.info method. |
[optional] |
| idempotency_key |
string |
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> |
[optional] |