GET api/Products

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of Product

Name	Type	Additional information
id	unsigned integer	None.
name	string	None.
slug	string	None.
permalink	string	None.
date_created	date	None.
date_created_gmt	date	None.
date_modified	date	None.
date_modified_gmt	date	None.
type	string	None.
status	string	None.
featured	boolean	None.
catalog_visibility	string	None.
description	string	None.
short_description	string	None.
sku	string	None.
price	decimal number	None.
regular_price	decimal number	None.
sale_price	decimal number	None.
price_html	string	None.
on_sale	boolean	None.
purchasable	boolean	None.
total_sales	decimal number	None.
downloadable	boolean	None.
download_limit	integer	None.
download_expiry	integer	None.
external_url	string	None.
button_text	string	None.
tax_status	string	None.
tax_class	string	None.
stock_quantity	integer	None.
stock_status	string	None.
backorders	string	None.
backorders_allowed	boolean	None.
backordered	boolean	None.
sold_individually	boolean	None.
weight	decimal number	None.
shipping_required	boolean	None.
shipping_taxable	boolean	None.
shipping_class	string	None.
shipping_class_id	string	None.
reviews_allowed	boolean	None.
average_rating	string	None.
rating_count	integer	None.
parent_id	unsigned integer	None.
purchase_note	string	None.
variations	Collection of integer	None.
grouped_products	Collection of integer	None.
menu_order	integer	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "id": 1,
    "name": "sample string 1",
    "slug": "sample string 2",
    "permalink": "sample string 3",
    "date_created": "2026-03-07T19:21:16.1285268-08:00",
    "date_created_gmt": "2026-03-07T19:21:16.1285268-08:00",
    "date_modified": "2026-03-07T19:21:16.1285268-08:00",
    "date_modified_gmt": "2026-03-07T19:21:16.1285268-08:00",
    "type": "sample string 4",
    "status": "sample string 5",
    "featured": true,
    "catalog_visibility": "sample string 6",
    "description": "sample string 7",
    "short_description": "sample string 8",
    "sku": "sample string 9",
    "price": 1.0,
    "regular_price": 1.0,
    "sale_price": 1.0,
    "price_html": "sample string 10",
    "on_sale": true,
    "purchasable": true,
    "total_sales": 1.0,
    "downloadable": true,
    "download_limit": 1,
    "download_expiry": 1,
    "external_url": "sample string 11",
    "button_text": "sample string 12",
    "tax_status": "sample string 13",
    "tax_class": "sample string 14",
    "stock_quantity": 1,
    "stock_status": "sample string 15",
    "backorders": "sample string 16",
    "backorders_allowed": true,
    "backordered": true,
    "sold_individually": true,
    "weight": 1.0,
    "shipping_required": true,
    "shipping_taxable": true,
    "shipping_class": "sample string 17",
    "shipping_class_id": "sample string 18",
    "reviews_allowed": true,
    "average_rating": "sample string 19",
    "rating_count": 1,
    "parent_id": 1,
    "purchase_note": "sample string 20",
    "variations": [
      1,
      2
    ],
    "grouped_products": [
      1,
      2
    ],
    "menu_order": 1
  },
  {
    "id": 1,
    "name": "sample string 1",
    "slug": "sample string 2",
    "permalink": "sample string 3",
    "date_created": "2026-03-07T19:21:16.1285268-08:00",
    "date_created_gmt": "2026-03-07T19:21:16.1285268-08:00",
    "date_modified": "2026-03-07T19:21:16.1285268-08:00",
    "date_modified_gmt": "2026-03-07T19:21:16.1285268-08:00",
    "type": "sample string 4",
    "status": "sample string 5",
    "featured": true,
    "catalog_visibility": "sample string 6",
    "description": "sample string 7",
    "short_description": "sample string 8",
    "sku": "sample string 9",
    "price": 1.0,
    "regular_price": 1.0,
    "sale_price": 1.0,
    "price_html": "sample string 10",
    "on_sale": true,
    "purchasable": true,
    "total_sales": 1.0,
    "downloadable": true,
    "download_limit": 1,
    "download_expiry": 1,
    "external_url": "sample string 11",
    "button_text": "sample string 12",
    "tax_status": "sample string 13",
    "tax_class": "sample string 14",
    "stock_quantity": 1,
    "stock_status": "sample string 15",
    "backorders": "sample string 16",
    "backorders_allowed": true,
    "backordered": true,
    "sold_individually": true,
    "weight": 1.0,
    "shipping_required": true,
    "shipping_taxable": true,
    "shipping_class": "sample string 17",
    "shipping_class_id": "sample string 18",
    "reviews_allowed": true,
    "average_rating": "sample string 19",
    "rating_count": 1,
    "parent_id": 1,
    "purchase_note": "sample string 20",
    "variations": [
      1,
      2
    ],
    "grouped_products": [
      1,
      2
    ],
    "menu_order": 1
  }
]

application/xml, text/xml

Sample:

<ArrayOfProduct xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/">
  <Product>
    <average_rating>sample string 19</average_rating>
    <backordered>true</backordered>
    <backorders>sample string 16</backorders>
    <backorders_allowed>true</backorders_allowed>
    <button_text>sample string 12</button_text>
    <catalog_visibility>sample string 6</catalog_visibility>
    <date_created>2026-03-07T19:21:16.1285268-08:00</date_created>
    <date_created_gmt>2026-03-07T19:21:16.1285268-08:00</date_created_gmt>
    <date_modified>2026-03-07T19:21:16.1285268-08:00</date_modified>
    <date_modified_gmt>2026-03-07T19:21:16.1285268-08:00</date_modified_gmt>
    <description>sample string 7</description>
    <download_expiry>1</download_expiry>
    <download_limit>1</download_limit>
    <downloadable>true</downloadable>
    <external_url>sample string 11</external_url>
    <featured>true</featured>
    <grouped_products xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </grouped_products>
    <id>1</id>
    <menu_order>1</menu_order>
    <name>sample string 1</name>
    <on_sale>true</on_sale>
    <parent_id>1</parent_id>
    <permalink>sample string 3</permalink>
    <price>1</price>
    <price_html>sample string 10</price_html>
    <purchasable>true</purchasable>
    <purchase_note>sample string 20</purchase_note>
    <rating_count>1</rating_count>
    <regular_price>1</regular_price>
    <reviews_allowed>true</reviews_allowed>
    <sale_price>1</sale_price>
    <shipping_class>sample string 17</shipping_class>
    <shipping_class_id>sample string 18</shipping_class_id>
    <shipping_required>true</shipping_required>
    <shipping_taxable>true</shipping_taxable>
    <short_description>sample string 8</short_description>
    <sku>sample string 9</sku>
    <slug>sample string 2</slug>
    <sold_individually>true</sold_individually>
    <status>sample string 5</status>
    <stock_quantity>1</stock_quantity>
    <stock_status>sample string 15</stock_status>
    <tax_class>sample string 14</tax_class>
    <tax_status>sample string 13</tax_status>
    <total_sales>1</total_sales>
    <type>sample string 4</type>
    <variations xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </variations>
    <weight>1</weight>
  </Product>
  <Product>
    <average_rating>sample string 19</average_rating>
    <backordered>true</backordered>
    <backorders>sample string 16</backorders>
    <backorders_allowed>true</backorders_allowed>
    <button_text>sample string 12</button_text>
    <catalog_visibility>sample string 6</catalog_visibility>
    <date_created>2026-03-07T19:21:16.1285268-08:00</date_created>
    <date_created_gmt>2026-03-07T19:21:16.1285268-08:00</date_created_gmt>
    <date_modified>2026-03-07T19:21:16.1285268-08:00</date_modified>
    <date_modified_gmt>2026-03-07T19:21:16.1285268-08:00</date_modified_gmt>
    <description>sample string 7</description>
    <download_expiry>1</download_expiry>
    <download_limit>1</download_limit>
    <downloadable>true</downloadable>
    <external_url>sample string 11</external_url>
    <featured>true</featured>
    <grouped_products xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </grouped_products>
    <id>1</id>
    <menu_order>1</menu_order>
    <name>sample string 1</name>
    <on_sale>true</on_sale>
    <parent_id>1</parent_id>
    <permalink>sample string 3</permalink>
    <price>1</price>
    <price_html>sample string 10</price_html>
    <purchasable>true</purchasable>
    <purchase_note>sample string 20</purchase_note>
    <rating_count>1</rating_count>
    <regular_price>1</regular_price>
    <reviews_allowed>true</reviews_allowed>
    <sale_price>1</sale_price>
    <shipping_class>sample string 17</shipping_class>
    <shipping_class_id>sample string 18</shipping_class_id>
    <shipping_required>true</shipping_required>
    <shipping_taxable>true</shipping_taxable>
    <short_description>sample string 8</short_description>
    <sku>sample string 9</sku>
    <slug>sample string 2</slug>
    <sold_individually>true</sold_individually>
    <status>sample string 5</status>
    <stock_quantity>1</stock_quantity>
    <stock_status>sample string 15</stock_status>
    <tax_class>sample string 14</tax_class>
    <tax_status>sample string 13</tax_status>
    <total_sales>1</total_sales>
    <type>sample string 4</type>
    <variations xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </variations>
    <weight>1</weight>
  </Product>
</ArrayOfProduct>