| additional_image_link |
[str], none_type |
<p><= 2000 characters</p> <p>The links to additional images for your product. Up to ten additional images can be used to show a product from different angles or to show different stages. Must begin with http:// or https://.</p> |
[optional] |
| image_link |
bool, date, datetime, dict, float, int, list, str, none_type |
<p><= 2000 characters</p> <p>The links to the main product images. Images should be at least 75x75 pixels to avoid errors. Use the additional_image_link field to add more images of your product. The URL of your image_link must be accessible by the Pinterest user-agent, and send the accurate images. Please make sure there are no template or placeholder images at the link. Must start with http:// or https://.</p> |
[optional] |
| video_link |
str, none_type |
<p><= 2,000 characters</p> <p>Hosted link to the product video.</p> <p>File types for linked videos must be .mp4, .mov or .m4v.</p> <p>File size cannot exceed 2GB.</p> |
[optional] |
| ad_link |
str, none_type |
Allows advertisers to specify a separate URL that can be used to track traffic coming from Pinterest shopping ads. Must send full URL including tracking—do not send tracking parameters only. At this time we do not support impression tracking. Must begin with http:// or https://. |
[optional] |
| adult |
bool, none_type |
Set this attribute to TRUE if you're submitting items that are considered “adult”. These will not be shown on Pinterest. |
[optional] |
| age_group |
str, none_type |
The age group to apply a demographic range to the product. Must be one of the following values (upper or lowercased): ‘newborn’ , ‘infant’, ‘toddler’, ‘kids’, or ‘adult’. |
[optional] |
| availability |
str |
The availability of the product. Must be one of the following values (upper or lowercased): ‘in stock’, ‘out of stock’ , ‘preorder’. |
[optional] |
| average_review_rating |
float, none_type |
Average reviews for the item. Can be a number from 1-5. |
[optional] |
| brand |
str, none_type |
The brand of the product. |
[optional] |
| checkout_enabled |
bool, none_type |
This attribute is not supported anymore. |
[optional] |
| color |
str, none_type |
The primary color of the product. |
[optional] |
| condition |
str, none_type |
The condition of the product. Must be one of the following values (upper or lowercased): ‘new’, ‘used’, or ‘refurbished’. |
[optional] |
| custom_label_0 |
str, none_type |
<p><= 1000 characters</p> <p>Custom grouping of products.</p> |
[optional] |
| custom_label_1 |
str, none_type |
<p><= 1000 characters</p> <p>Custom grouping of products.</p> |
[optional] |
| custom_label_2 |
str, none_type |
<p><= 1000 characters</p> <p>Custom grouping of products.</p> |
[optional] |
| custom_label_3 |
str, none_type |
<p><= 1000 characters</p> <p>Custom grouping of products.</p> |
[optional] |
| custom_label_4 |
str, none_type |
<p><= 1000 characters</p> <p>Custom grouping of products.</p> |
[optional] |
| description |
str |
<p><= 10000 characters</p> <p>The description of the product.</p> |
[optional] |
| free_shipping_label |
bool, none_type |
The item is free to ship. |
[optional] |
| free_shipping_limit |
str, none_type |
The minimum order purchase necessary for the customer to get free shipping. Only relevant if free shipping is offered. |
[optional] |
| gender |
str, none_type |
The gender associated with the product. Must be one of the following values (upper or lowercased): ‘male’, ‘female’ , or ‘unisex’. |
[optional] |
| google_product_category |
str, none_type |
The categorization of the product based on the standardized Google Product Taxonomy. This is a set taxonomy. Both the text values and numeric codes are accepted. |
[optional] |
| gtin |
int, none_type |
The unique universal product identifier. |
[optional] |
| id |
str |
<p><= 127 characters</p> <p>The user-created unique ID that represents the product. Only Unicode characters are accepted.</p> |
[optional] |
| item_group_id |
str, none_type |
<p><= 127 characters</p> <p>The parent ID of the product.</p> |
[optional] |
| last_updated_time |
int, none_type |
The millisecond timestamp when the item was lastly modified by the merchant. |
[optional] |
| link |
str |
<p><= 511 characters</p> <p>The landing page for the product.</p> |
[optional] |
| material |
str, none_type |
The material used to make the product. |
[optional] |
| min_ad_price |
str, none_type |
The minimum advertised price of the product. It supports the following formats, "19.99 USD", "19.99USD" and "19.99". If the currency is not included, we default to US dollars. |
[optional] |
| mobile_link |
str, none_type |
The mobile-optimized version of your landing page. Must begin with http:// or https://. |
[optional] |
| mpn |
str, none_type |
Manufacturer Part Number are alpha-numeric codes created by the manufacturer of a product to uniquely identify it among all products from the same manufacturer. |
[optional] |
| number_of_ratings |
int, none_type |
The number of ratings for the item. |
[optional] |
| number_of_reviews |
int, none_type |
The number of reviews available for the item. |
[optional] |
| pattern |
str, none_type |
The description of the pattern used for the product. |
[optional] |
| price |
str |
The price of the product. It supports the following formats, "24.99 USD", "24.99USD" and "24.99". If the currency is not included, we default to US dollars. |
[optional] |
| product_type |
str, none_type |
<p><= 1000 characters</p> <p>The categorization of your product based on your custom product taxonomy. Subcategories must be sent separated by “ > “. The > must be wrapped by spaces. We do not recognize any other delimiters such as comma or pipe.</p> |
[optional] |
| sale_price |
str, none_type |
The discounted price of the product. The sale_price must be lower than the price. It supports the following formats, "14.99 USD", "14.99USD" and "14.99". If the currency is not included, we default to US dollars. |
[optional] |
| shipping |
str, none_type |
Shipping consists of one group of up to four elements, country, region, service (all optional) and price (required). All colons, even for blank values, are required. |
[optional] |
| shipping_height |
str, none_type |
The height of the package needed to ship the product. Ensure there is a space between the numeric string and the metric. |
[optional] |
| shipping_weight |
str, none_type |
The weight of the product. Ensure there is a space between the numeric string and the metric. |
[optional] |
| shipping_width |
str, none_type |
The width of the package needed to ship the product. Ensure there is a space between the numeric string and the metric. |
[optional] |
| size |
str, none_type |
The size of the product. |
[optional] |
| size_system |
str, none_type |
Indicates the country’s sizing system in which you are submitting your product. Must be one of the following values (upper or lowercased): ‘US’, ‘UK’, ‘EU’, ‘DE’ , ‘FR’, ‘JP’, ‘CN’, ‘IT’, ‘ BR’, ‘MEX’, or ‘AU’. |
[optional] |
| size_type |
str, none_type |
Additional description for the size. Must be one of the following values (upper or lowercased): ‘regular’, ‘petite’ , ‘plus’, ‘big_and_tall’, or ‘maternity’. |
[optional] |
| tax |
str, none_type |
Tax consists of one group of up to four elements, country, region, rate (all required) and tax_ship (optional). All colons, even for blank values, are required. |
[optional] |
| title |
str |
<p><= 500 characters</p> <p>The name of the product.</p> |
[optional] |
| variant_names |
[str], none_type |
Options for this variant. People will see these options next to your Pin and can select the one they want. List them in the order you want them displayed. |
[optional] |
| variant_values |
[str], none_type |
Option values for this variant. People will see these options next to your Pin and can select the one they want. List them in the order you want them displayed. The order of the variant values must be consistent with the order of the variant names. |
[optional] |
| any string name |
bool, date, datetime, dict, float, int, list, str, none_type |
any string name can be used but the value must be the correct type |
[optional] |