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 |
decimal |
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] [default to "simple"] |
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 |
bool |
Defines whether the product is virtual |
[optional] [default to false] |
Downloadable |
bool |
Defines whether the product is downloadable |
[optional] [default to false] |
IsSupply |
bool |
If true, it indicates the product as a supply, otherwise it indicates that it is a finished product. |
[optional] [default to true] |
AvailableForView |
bool |
Specifies the set of visible/invisible products for users |
[optional] [default to true] |
AvailableForSale |
bool |
Specifies the set of visible/invisible products for sale |
[optional] [default to true] |
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 |
decimal |
Defines product's old price |
[optional] |
SpecialPrice |
decimal |
Defines product's model that has to be added |
[optional] |
WholesalePrice |
decimal |
Defines product's sale price |
[optional] |
CostPrice |
decimal |
Defines new product's cost price |
[optional] |
FixedCostShippingPrice |
decimal |
Specifies product's fixed cost shipping price |
[optional] |
TierPrices |
List<ProductAddTierPricesInner> |
Defines product's tier prices |
[optional] |
GroupPrices |
List<ProductAddGroupPricesInner> |
Defines product's group prices |
[optional] |
BuyitnowPrice |
decimal |
Defines buy it now value |
[optional] |
ReservePrice |
decimal |
Defines reserve price value |
[optional] |
Quantity |
decimal |
Defines product's quantity that has to be added |
[optional] [default to 0M] |
InStock |
bool |
Set stock status |
[optional] |
ManageStock |
bool |
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 |
decimal |
The minimum quantity an order must contain, to be eligible to purchase this product. |
[optional] |
MaxOrderQuantity |
decimal |
The maximum quantity an order can contain when purchasing the product. |
[optional] |
Weight |
decimal |
Weight |
[optional] [default to 0M] |
WeightUnit |
string |
Weight Unit |
[optional] |
Width |
decimal |
Defines product's width |
[optional] |
Height |
decimal |
Defines product's height |
[optional] |
Length |
decimal |
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 |
List<string> |
Image Url |
[optional] |
Files |
List<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] [default to "Default"] |
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 |
List<string> |
A list of material strings for materials used in the product. |
[optional] |
Certifications |
List<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 |
List<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 |
bool |
When true, automatically renews a listing upon its expiration. |
[optional] [default to false] |
WhenMade |
string |
An enumerated string for the era in which the maker made the product. |
[optional] [default to "made_to_order"] |
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 |
bool |
Specifies whether a tax is charged |
[optional] [default to true] |
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 |
bool |
Flag used to determine whether the product condition is shown to the customer on the product page. |
[optional] |
PaymentMethods |
List<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] [default to 0] |
ShippingDetails |
List<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 |
bool |
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 |
List<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] [default to "FixedPrice"] |
ReturnAccepted |
bool |
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 |
bool |
Is cache clear required |
[optional] [default to true] |
ViewedCount |
int |
Specifies the number of product's reviews |
[optional] [default to 0] |
OrderedCount |
int |
Defines how many times the product was ordered |
[optional] [default to 0] |