Describes a product
attachments
Returns the product attachments links.
attribute_based_inventory?
Returns true if inventory is based on attributes rather than on product itself.
attributes
Returns product attributes.
breadcrumbs
Returns the caetegory breadcrumbs
bulk_rates
Returns the bulk rates if any.
bundle_contents
Returns the bundle contents. Each rows has the values of:
- product
- options:
- image
- name
- value
- quantity: quantity included
campaign
Returns active campaigns for product.
categories
Returns the assiociated categories
compatible
Returns the compatible products
created_at
Returns the creation date.
custom_fields
Returns product custom fields.
customer_can_review
Returns true if customer can review the product.
customer_has_purchased
Returns true if customer has purchased the product.
customer_has_reviewed
Returns true if customer has reviewed the product.
description
Returns the description.
discontinued_product
Returns true if product won’t be restocked when it runs out of stock.
discount_information
Returns the discount if any.
gtin
Returns the GTIN number.
handle
Returns the handle.
has_attributes_with_price
Returns true if some of the attributes are increasing product price.
height
Returns the height
id
Returns the id.
image
Returns product main image url.
images
Returns the images as an array of
- thumb
- original
in_customers_wishlist
Returns true if products is in customers wishlist.
in_preview
Returns true if product is in preview.
inventory_management
Returns the inventory management.
inventory_policy
Returns the inventory policy, continue or deny.
is_available
Returns true if product is available for purchase.
is_directly_buyable
Returns true if product can be bought without selecting any attributes.
is_new
Returns true if products in considered as new.
is_out_of_stock
Returns true if product is out of stock
length
Returns the length
manufacturer
Returns the manufacturer.
max_quantity
Returns the maximum quantity that can be bought.
max_rating
Returns the maximum rating
measure_unit
Returns the measure unit name
media
Returns the product media, concatted from videos and images properties with additional type field describing the type of the media.
min_quantity
Returns the minimum quantity that can be bought.
model
Returns the model number.
net_price
Returns the net price
original_net_price
Returns the original net price without any discounts
original_price
Returns the original price without any discounts
previous_lower_price
Returns information about the previous lower price if such is recorded in the last 30 days.
previous_prices
Returns information about the previous prices if such records are found.
price
Returns the price
rate
Returns the tax rate.
rating
Returns the rating
related
Returns the related products
return_policy_time_limit
Returns the product return policy time limit in days.
review_count
Returns the review count
reviews
Returns the reviews
reviews_are_enabled
Returns true if reviews are enabled for this product.
reviews_require_account
Returns true if creating a review for this product requires an account.
reviews_require_approval
Returns true reviews are approved before published.
reviews_require_purchase
Returns true if product must be purchased before review can be made.
seo_description
Returns description for search engines.
seo_keywords
Returns keywords for search engines.
seo_title
Returns title for search engines.
short_description
Returns the short description.
similar
Returns the similar products
stock
Returns the stock quantity
stock_alarm
Returns true if product is low on stock.
tags
Returns product tags.
tax
Returns the tax amount
title
Returns the title.
unit
Returns the product quantity unit
updated_at
Returns the last updated date.
videos
Returns the videos
weight
Returns the weight
weight_unit
Returns the weight unit name
width
Returns the width