| 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 |
BigDecimal |
Defines product's price that has to be added |
|
| sku |
String |
Defines product's sku that has to be added |
[optional] |
| shortDescription |
String |
Defines short description |
[optional] |
type |
String |
Defines product's type |
[optional] |
| status |
String |
Defines product's status |
[optional] |
| visible |
String |
Set visibility status |
[optional] |
| categoryId |
String |
Defines product add that is specified by category id |
[optional] |
| categoriesIds |
String |
Defines product add that is specified by comma-separated categories id |
[optional] |
| productClass |
String |
A categorization for the product |
[optional] |
| productType |
String |
A categorization for the product |
[optional] |
| isVirtual |
Boolean |
Defines whether the product is virtual |
[optional] |
| downloadable |
Boolean |
Defines whether the product is downloadable |
[optional] |
| isSupply |
Boolean |
If true, it indicates the product as a supply, otherwise it indicates that it is a finished product. |
[optional] |
| availableForView |
Boolean |
Specifies the set of visible/invisible products for users |
[optional] |
| availableForSale |
Boolean |
Specifies the set of visible/invisible products for sale |
[optional] |
| storeId |
String |
Store Id |
[optional] |
| storesIds |
String |
Assign product to the stores that is specified by comma-separated stores' id |
[optional] |
| langId |
String |
Language id |
[optional] |
| oldPrice |
BigDecimal |
Defines product's old price |
[optional] |
| specialPrice |
BigDecimal |
Defines product's model that has to be added |
[optional] |
| wholesalePrice |
BigDecimal |
Defines product's sale price |
[optional] |
| costPrice |
BigDecimal |
Defines new product's cost price |
[optional] |
| fixedCostShippingPrice |
BigDecimal |
Specifies product's fixed cost shipping price |
[optional] |
| tierPrices |
Seq<ProductAddTierPricesInner> |
Defines product's tier prices |
[optional] |
| groupPrices |
Seq<ProductAddGroupPricesInner> |
Defines product's group prices |
[optional] |
| buyitnowPrice |
BigDecimal |
Defines buy it now value |
[optional] |
| reservePrice |
BigDecimal |
Defines reserve price value |
[optional] |
| quantity |
BigDecimal |
Defines product's quantity that has to be added |
[optional] |
| inStock |
Boolean |
Set stock status |
[optional] |
| manageStock |
Boolean |
Defines inventory tracking for product |
[optional] |
| warehouseId |
String |
This parameter is used for selecting a warehouse where you need to set/modify a product quantity. |
[optional] |
| backorderStatus |
String |
Set backorder status |
[optional] |
| minOrderQuantity |
BigDecimal |
The minimum quantity an order must contain, to be eligible to purchase this product. |
[optional] |
| maxOrderQuantity |
BigDecimal |
The maximum quantity an order can contain when purchasing the product. |
[optional] |
| weight |
BigDecimal |
Weight |
[optional] |
| weightUnit |
String |
Weight Unit |
[optional] |
| width |
BigDecimal |
Defines product's width |
[optional] |
| height |
BigDecimal |
Defines product's height |
[optional] |
| length |
BigDecimal |
Defines product's length |
[optional] |
| dimensionsUnit |
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] |
| productReference |
String |
Groups all variations, that you want to combine into one product. |
[optional] |
| harmonizedSystemCode |
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] |
| countryOfOrigin |
String |
The country where the inventory item was made |
[optional] |
| manufacturer |
String |
Defines product's manufacturer |
[optional] |
| manufacturerId |
String |
Defines product's manufacturer by manufacturer_id |
[optional] |
| manufacturerInfo |
ProductAddManufacturerInfo |
|
[optional] |
| brandName |
String |
Defines product brand name |
[optional] |
| imageUrl |
String |
Image Url |
[optional] |
| imageName |
String |
Defines image's name |
[optional] |
| additionalImageUrls |
Seq<URI> |
Image Url |
[optional] |
| files |
Seq<ProductAddFilesInner> |
File Url |
[optional] |
| sizeChart |
ProductAddSizeChart |
|
[optional] |
| relatedProductsIds |
String |
Defines product's related products ids that has to be added |
[optional] |
| upSellProductsIds |
String |
Defines product's up-sell products ids that has to be added |
[optional] |
| crossSellProductsIds |
String |
Defines product's cross-sell products ids that has to be added |
[optional] |
| attributeSetName |
String |
Defines product’s attribute set name in Magento |
[optional] |
| attributeName |
String |
Defines product’s attribute name separated with a comma in Magento |
[optional] |
| searchKeywords |
String |
Defines unique search keywords |
[optional] |
| tags |
String |
Product tags |
[optional] |
| materials |
Seq<String> |
A list of material strings for materials used in the product. |
[optional] |
| certifications |
Seq<ProductAddCertificationsInner> |
An array of product certifications. The list of possible certifications can be obtained using the "<i>category.info</i>" method (<i>additional_fields->rules->product_certifications</i>). |
[optional] |
| specifics |
Seq<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] |
| availFrom |
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] |
| spriceCreate |
String |
Defines the date of special price creation |
[optional] |
| spriceModified |
String |
Defines the date of special price modification |
[optional] |
| spriceExpire |
String |
Defines the term of special price offer duration |
[optional] |
| createdAt |
String |
Defines the date of entity creation |
[optional] |
| autoRenew |
Boolean |
When true, automatically renews a listing upon its expiration. |
[optional] |
| whenMade |
String |
An enumerated string for the era in which the maker made the product. |
[optional] |
| metaTitle |
String |
Defines unique meta title for each entity |
[optional] |
| metaKeywords |
String |
Defines unique meta keywords for each entity |
[optional] |
| metaDescription |
String |
Defines unique meta description of a entity |
[optional] |
| url |
String |
Defines unique product's URL |
[optional] |
| seoUrl |
String |
Defines unique URL for SEO |
[optional] |
| taxClassId |
String |
Defines tax classes where entity has to be added |
[optional] |
| taxable |
Boolean |
Specifies whether a tax is charged |
[optional] |
| salesTax |
ProductAddSalesTax |
|
[optional] |
| condition |
String |
The human-readable label for the condition (e.g., "New"). |
[optional] |
| conditionDescription |
String |
Detailed description of the product condition. |
[optional] |
| allowDisplayCondition |
Boolean |
Flag used to determine whether the product condition is shown to the customer on the product page. |
[optional] |
| paymentMethods |
Seq<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="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> |
[optional] |
| paypalEmail |
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] |
| shippingTemplateId |
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] |
| shippingDetails |
Seq<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="font-style:normal">Param structure:<div style="margin-left: 2%;"><code style="padding:0; background-color:#ffffff;font-size:85%;font-family:monospace;">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] |
| isFreeShipping |
Boolean |
Specifies product's free shipping flag that has to be added |
[optional] |
| deliveryCode |
String |
The delivery promise that applies to offer |
[optional] |
| deliveryType |
String |
Defines the type of the delivery. |
[optional] |
| deliveryTime |
Int |
Defines delivery time in days. |
[optional] |
| deliveryOptionIds |
String |
Defines delivery options for product by ids. |
[optional] |
| packageDetails |
ProductAddPackageDetails |
|
[optional] |
| logisticInfo |
Seq<ProductAddLogisticInfoInner> |
Defines product's logistic channel settings |
[optional] |
| listingDuration |
String |
Describes the number of days the seller wants the listing to be active. Look at cart.info method response for allowed values. |
[optional] |
| listingType |
String |
Indicates the selling format of the marketplace listing. |
[optional] |
| returnAccepted |
Boolean |
Indicates whether the seller allows the buyer to return the item. |
[optional] |
| sellerProfiles |
ProductAddSellerProfiles |
|
[optional] |
| auctionConfidentialityLevel |
String |
This allows buyers to remain anonymous when the bid or buy an item. |
[optional] |
| bestOffer |
ProductAddBestOffer |
|
[optional] |
| productionPartnerIds |
String |
Defines product's production partner ids that has to be added |
[optional] |
| marketplaceItemProperties |
String |
String containing the JSON representation of the supplied data |
[optional] |
| clearCache |
Boolean |
Is cache clear required |
[optional] |
| viewedCount |
Int |
Specifies the number of product's reviews |
[optional] |
| orderedCount |
Int |
Defines how many times the product was ordered |
[optional] |