id | integer | Unique identifier for the resource. | Yes | No | | |
name | string | Product name. | Yes | Yes | | |
slug | string | Product slug. | Yes | Yes | | |
permalink | string | Product URL. | Yes | No | | |
date_created | date-time | The date the product was created, in the site’s timezone. | Yes | Yes | | |
date_modified | date-time | The date the product was last modified, in the site’s timezone. | Yes | No | | |
type | string | Product type. | Yes | Yes | simple | simple, grouped, external, variable, booking, subscription, variable-subscription |
status | string | Product status (post status). | Yes | Yes | publish | draft, pending, private, publish, future |
featured | boolean | Featured product. | Yes | Yes | false | |
catalog_visibility | string | Catalogue visibility. | Yes | Yes | visible | visible, catalog, search, hidden |
description | string | Product description. | Yes | Yes | | |
short_description | string | Product short description. | Yes | Yes | | |
sku | string | Unique identifier. | Yes | Yes | | |
price | string | Current product price. | Yes | No | | |
regular_price | string | Product regular price. | Yes | Yes | | |
sale_price | string | Product sale price. | Yes | Yes | | |
date_on_sale_from | date-time | Start date of sale price, in the site’s timezone. | Yes | Yes | | |
date_on_sale_to | date-time | End date of sale price, in the site’s timezone. | Yes | Yes | | |
price_html | string | Price formatted in HTML. | Yes | No | | |
on_sale | boolean | Shows if the product is on sale. | Yes | No | | |
purchasable | boolean | Shows if the product can be bought. | Yes | No | | |
total_sales | integer | Amount of sales. | Yes | No | | |
virtual | boolean | If the product is virtual. | Yes | Yes | false | |
downloadable | boolean | If the product is downloadable. | Yes | Yes | false | |
downloads | array | List of downloadable files. | Yes | Yes | | |
downloads –> id | string | File ID. | Yes | Yes | | |
downloads –> name | string | File name. | Yes | Yes | | |
downloads –> file | string | File URL. | Yes | Yes | | |
download_limit | integer | Number of times downloadable files can be downloaded after purchase. | Yes | Yes | -1 | |
download_expiry | integer | Number of days until access to downloadable files expires. | Yes | Yes | -1 | |
external_url | string | Product external URL. Only for external products. | Yes | Yes | | |
button_text | string | Product external button text. Only for external products. | Yes | Yes | | |
tax_status | string | Tax status. | Yes | Yes | taxable | taxable, shipping, none |
tax_class | string | Tax class. | Yes | Yes | | |
manage_stock | boolean | Stock management at product level. | Yes | Yes | false | |
stock_quantity | integer | Stock quantity. | Yes | Yes | | |
stock_status | string | Controls the stock status of the product. | Yes | Yes | instock | instock, outofstock, onbackorder |
backorders | string | If managing stock, this controls if backorders are allowed. | Yes | Yes | no | no, notify, yes |
backorders_allowed | boolean | Shows if backorders are allowed. | Yes | No | | |
backordered | boolean | Shows if the product is on backordered. | Yes | No | | |
sold_individually | boolean | Allow one item to be bought in a single order. | Yes | Yes | false | |
weight | string | Product weight (kg). | Yes | Yes | | |
dimensions | object | Product dimensions. | Yes | Yes | | |
dimensions –> length | string | Product length (cm). | Yes | Yes | | |
dimensions –> width | string | Product width (cm). | Yes | Yes | | |
dimensions –> height | string | Product height (cm). | Yes | Yes | | |
shipping_required | boolean | Shows if the product need to be shipped. | Yes | No | | |
shipping_taxable | boolean | Shows whether or not the product shipping is taxable. | Yes | No | | |
shipping_class | string | Shipping class slug. | Yes | Yes | | |
shipping_class_id | string | Shipping class ID. | Yes | No | | |
reviews_allowed | boolean | Allow reviews. | Yes | Yes | true | |
average_rating | string | Reviews average rating. | Yes | No | | |
rating_count | integer | Amount of reviews that the product have. | Yes | No | | |
related_ids | array | List of related products IDs. | Yes | No | | |
upsell_ids | array | List of up-sell products IDs. | Yes | Yes | | |
cross_sell_ids | array | List of cross-sell products IDs. | Yes | Yes | | |
parent_id | integer | Product parent ID. | Yes | Yes | | |
purchase_note | string | Optional note to send the customer after purchase. | Yes | Yes | | |
categories | array | List of categories. | Yes | Yes | | |
categories –> id | integer | Category ID. | Yes | Yes | | |
categories –> name | string | Category name. | Yes | No | | |
categories –> slug | string | Category slug. | Yes | No | | |
tags | array | List of tags. | Yes | Yes | | |
tags –> id | integer | Tag ID. | Yes | Yes | | |
tags –> name | string | Tag name. | Yes | No | | |
tags –> slug | string | Tag slug. | Yes | No | | |
images | array | List of images. | Yes | Yes | | |
images –> id | integer | Image ID. | Yes | Yes | | |
images –> date_created | date-time | The date the image was created, in the site’s timezone. | Yes | No | | |
images –> date_modified | date-time | The date the image was last modified, in the site’s timezone. | Yes | No | | |
images –> src | string | Image URL. | Yes | Yes | | |
images –> name | string | Image name. | Yes | Yes | | |
images –> alt | string | Image alternative text. | Yes | Yes | | |
attributes | array | List of attributes. | Yes | Yes | | |
attributes –> id | integer | Attribute ID. | Yes | Yes | | |
attributes –> name | string | Attribute name. | Yes | Yes | | |
attributes –> position | integer | Attribute position. | Yes | Yes | | |
attributes –> visible | boolean | Define if the attribute is visible on the “Additional information” tab in the product’s page. | Yes | Yes | false | |
attributes –> variation | boolean | Define if the attribute can be used as variation. | Yes | Yes | false | |
attributes –> options | array | List of available term names of the attribute. | Yes | Yes | | |
default_attributes | array | Defaults variation attributes. | Yes | Yes | | |
default_attributes –> id | integer | Attribute ID. | Yes | Yes | | |
default_attributes –> name | string | Attribute name. | Yes | Yes | | |
default_attributes –> option | string | Selected attribute term name. | Yes | Yes | | |
variations | array | List of variations IDs. | Yes | No | | |
grouped_products | array | List of grouped products ID. | Yes | No | | |
menu_order | integer | Menu order, used to custom sort products. | Yes | Yes | | |
meta_data | array | Meta data. | Yes | Yes | | |
meta_data –> id | integer | Meta ID. | Yes | No | | |
meta_data –> key | string | Meta key. | Yes | Yes | | |
meta_data –> value | mixed | Meta value. | Yes | Yes |