(C#) WooCommerce Retrieve a Product

See more WooCommerce Examples

Demonstrates how to get the information for a product in JSON format.

For more information, see https://woocommerce.github.io/woocommerce-rest-api-docs/#retrieve-a-product

Chilkat .NET Downloads Chilkat .NET Framework Chilkat for .NET Core

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

Chilkat.Http http = new Chilkat.Http();
bool success;

// Implements the following CURL command:

// curl https://example.com/wp-json/wc/v3/products/794 \
//     -u consumer_key:consumer_secret

// Use the following online tool to generate HTTP code from a CURL command
// Convert a cURL Command to HTTP Source Code

http.BasicAuth = true;
http.Login = "consumer_key";
http.Password = "consumer_secret";

Chilkat.StringBuilder sbResponseBody = new Chilkat.StringBuilder();
success = http.QuickGetSb("https://example.com/wp-json/wc/v3/products/794",sbResponseBody);
if (success == false) {
    Debug.WriteLine(http.LastErrorText);
    return;
}

Chilkat.JsonObject jResp = new Chilkat.JsonObject();
jResp.LoadSb(sbResponseBody);
jResp.EmitCompact = false;

Debug.WriteLine("Response Body:");
Debug.WriteLine(jResp.Emit());

int respStatusCode = http.LastStatus;
Debug.WriteLine("Response Status Code = " + Convert.ToString(respStatusCode));
if (respStatusCode >= 400) {
    Debug.WriteLine("Response Header:");
    Debug.WriteLine(http.LastHeader);
    Debug.WriteLine("Failed.");
    return;
}

// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)

// {
//   "id": 794,
//   "name": "Premium Quality",
//   "slug": "premium-quality-19",
//   "permalink": "https://example.com/product/premium-quality-19/",
//   "date_created": "2017-03-23T17:01:14",
//   "date_created_gmt": "2017-03-23T20:01:14",
//   "date_modified": "2017-03-23T17:01:14",
//   "date_modified_gmt": "2017-03-23T20:01:14",
//   "type": "simple",
//   "status": "publish",
//   "featured": false,
//   "catalog_visibility": "visible",
//   "description": "<p>Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu libero sit amet quam egestas semper. Aenean ultricies mi vitae est. Mauris placerat eleifend leo.</p>\n",
//   "short_description": "<p>Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas.</p>\n",
//   "sku": "",
//   "price": "21.99",
//   "regular_price": "21.99",
//   "sale_price": "",
//   "date_on_sale_from": null,
//   "date_on_sale_from_gmt": null,
//   "date_on_sale_to": null,
//   "date_on_sale_to_gmt": null,
//   "price_html": "<span class=\"woocommerce-Price-amount amount\"><span class=\"woocommerce-Price-currencySymbol\">&#36;</span>21.99</span>",
//   "on_sale": false,
//   "purchasable": true,
//   "total_sales": 0,
//   "virtual": false,
//   "downloadable": false,
//   "downloads": [
//   ],
//   "download_limit": -1,
//   "download_expiry": -1,
//   "external_url": "",
//   "button_text": "",
//   "tax_status": "taxable",
//   "tax_class": "",
//   "manage_stock": false,
//   "stock_quantity": null,
//   "stock_status": "instock",
//   "backorders": "no",
//   "backorders_allowed": false,
//   "backordered": false,
//   "sold_individually": false,
//   "weight": "",
//   "dimensions": {
//     "length": "",
//     "width": "",
//     "height": ""
//   },
//   "shipping_required": true,
//   "shipping_taxable": true,
//   "shipping_class": "",
//   "shipping_class_id": 0,
//   "reviews_allowed": true,
//   "average_rating": "0.00",
//   "rating_count": 0,
//   "related_ids": [
//     53,
//     40,
//     56,
//     479,
//     99
//   ],
//   "upsell_ids": [
//   ],
//   "cross_sell_ids": [
//   ],
//   "parent_id": 0,
//   "purchase_note": "",
//   "categories": [
//     {
//       "id": 9,
//       "name": "Clothing",
//       "slug": "clothing"
//     },
//     {
//       "id": 14,
//       "name": "T-shirts",
//       "slug": "t-shirts"
//     }
//   ],
//   "tags": [
//   ],
//   "images": [
//     {
//       "id": 792,
//       "date_created": "2017-03-23T14:01:13",
//       "date_created_gmt": "2017-03-23T20:01:13",
//       "date_modified": "2017-03-23T14:01:13",
//       "date_modified_gmt": "2017-03-23T20:01:13",
//       "src": "https://example.com/wp-content/uploads/2017/03/T_2_front-4.jpg",
//       "name": "",
//       "alt": ""
//     },
//     {
//       "id": 793,
//       "date_created": "2017-03-23T14:01:14",
//       "date_created_gmt": "2017-03-23T20:01:14",
//       "date_modified": "2017-03-23T14:01:14",
//       "date_modified_gmt": "2017-03-23T20:01:14",
//       "src": "https://example.com/wp-content/uploads/2017/03/T_2_back-2.jpg",
//       "name": "",
//       "alt": ""
//     }
//   ],
//   "attributes": [
//   ],
//   "default_attributes": [
//   ],
//   "variations": [
//   ],
//   "grouped_products": [
//   ],
//   "menu_order": 0,
//   "meta_data": [
//   ],
//   "_links": {
//     "self": [
//       {
//         "href": "https://example.com/wp-json/wc/v3/products/794"
//       }
//     ],
//     "collection": [
//       {
//         "href": "https://example.com/wp-json/wc/v3/products"
//       }
//     ]
//   }
// }

// Sample code for parsing the JSON response...
// Use the following online tool to generate parsing code from sample JSON:
// Generate Parsing Code from JSON

Chilkat.DtObj date_created = new Chilkat.DtObj();
Chilkat.DtObj date_created_gmt = new Chilkat.DtObj();
Chilkat.DtObj date_modified = new Chilkat.DtObj();
Chilkat.DtObj date_modified_gmt = new Chilkat.DtObj();
Chilkat.DtObj date_on_sale_from = new Chilkat.DtObj();
Chilkat.DtObj date_on_sale_from_gmt = new Chilkat.DtObj();
Chilkat.DtObj date_on_sale_to = new Chilkat.DtObj();
Chilkat.DtObj date_on_sale_to_gmt = new Chilkat.DtObj();
int intVal;
string src;
string alt;
string href;

int id = jResp.IntOf("id");
string name = jResp.StringOf("name");
string slug = jResp.StringOf("slug");
string permalink = jResp.StringOf("permalink");
jResp.DtOf("date_created",false,date_created);
jResp.DtOf("date_created_gmt",false,date_created_gmt);
jResp.DtOf("date_modified",false,date_modified);
jResp.DtOf("date_modified_gmt",false,date_modified_gmt);
string v_type = jResp.StringOf("type");
string status = jResp.StringOf("status");
bool featured = jResp.BoolOf("featured");
string catalog_visibility = jResp.StringOf("catalog_visibility");
string description = jResp.StringOf("description");
string short_description = jResp.StringOf("short_description");
string sku = jResp.StringOf("sku");
string price = jResp.StringOf("price");
string regular_price = jResp.StringOf("regular_price");
string sale_price = jResp.StringOf("sale_price");
jResp.DtOf("date_on_sale_from",false,date_on_sale_from);
jResp.DtOf("date_on_sale_from_gmt",false,date_on_sale_from_gmt);
jResp.DtOf("date_on_sale_to",false,date_on_sale_to);
jResp.DtOf("date_on_sale_to_gmt",false,date_on_sale_to_gmt);
string price_html = jResp.StringOf("price_html");
bool on_sale = jResp.BoolOf("on_sale");
bool purchasable = jResp.BoolOf("purchasable");
int total_sales = jResp.IntOf("total_sales");
bool virtual = jResp.BoolOf("virtual");
bool downloadable = jResp.BoolOf("downloadable");
int download_limit = jResp.IntOf("download_limit");
int download_expiry = jResp.IntOf("download_expiry");
string external_url = jResp.StringOf("external_url");
string button_text = jResp.StringOf("button_text");
string tax_status = jResp.StringOf("tax_status");
string tax_class = jResp.StringOf("tax_class");
bool manage_stock = jResp.BoolOf("manage_stock");
string stock_quantity = jResp.StringOf("stock_quantity");
string stock_status = jResp.StringOf("stock_status");
string backorders = jResp.StringOf("backorders");
bool backorders_allowed = jResp.BoolOf("backorders_allowed");
bool backordered = jResp.BoolOf("backordered");
bool sold_individually = jResp.BoolOf("sold_individually");
string weight = jResp.StringOf("weight");
string dimensionsLength = jResp.StringOf("dimensions.length");
string dimensionsWidth = jResp.StringOf("dimensions.width");
string dimensionsHeight = jResp.StringOf("dimensions.height");
bool shipping_required = jResp.BoolOf("shipping_required");
bool shipping_taxable = jResp.BoolOf("shipping_taxable");
string shipping_class = jResp.StringOf("shipping_class");
int shipping_class_id = jResp.IntOf("shipping_class_id");
bool reviews_allowed = jResp.BoolOf("reviews_allowed");
string average_rating = jResp.StringOf("average_rating");
int rating_count = jResp.IntOf("rating_count");
int parent_id = jResp.IntOf("parent_id");
string purchase_note = jResp.StringOf("purchase_note");
int menu_order = jResp.IntOf("menu_order");
int i = 0;
int count_i = jResp.SizeOfArray("downloads");
while (i < count_i) {
    jResp.I = i;
    i = i + 1;
}

i = 0;
count_i = jResp.SizeOfArray("related_ids");
while (i < count_i) {
    jResp.I = i;
    intVal = jResp.IntOf("related_ids[i]");
    i = i + 1;
}

i = 0;
count_i = jResp.SizeOfArray("upsell_ids");
while (i < count_i) {
    jResp.I = i;
    i = i + 1;
}

i = 0;
count_i = jResp.SizeOfArray("cross_sell_ids");
while (i < count_i) {
    jResp.I = i;
    i = i + 1;
}

i = 0;
count_i = jResp.SizeOfArray("categories");
while (i < count_i) {
    jResp.I = i;
    id = jResp.IntOf("categories[i].id");
    name = jResp.StringOf("categories[i].name");
    slug = jResp.StringOf("categories[i].slug");
    i = i + 1;
}

i = 0;
count_i = jResp.SizeOfArray("tags");
while (i < count_i) {
    jResp.I = i;
    i = i + 1;
}

i = 0;
count_i = jResp.SizeOfArray("images");
while (i < count_i) {
    jResp.I = i;
    id = jResp.IntOf("images[i].id");
    jResp.DtOf("images[i].date_created",false,date_created);
    jResp.DtOf("images[i].date_created_gmt",false,date_created_gmt);
    jResp.DtOf("images[i].date_modified",false,date_modified);
    jResp.DtOf("images[i].date_modified_gmt",false,date_modified_gmt);
    src = jResp.StringOf("images[i].src");
    name = jResp.StringOf("images[i].name");
    alt = jResp.StringOf("images[i].alt");
    i = i + 1;
}

i = 0;
count_i = jResp.SizeOfArray("attributes");
while (i < count_i) {
    jResp.I = i;
    i = i + 1;
}

i = 0;
count_i = jResp.SizeOfArray("default_attributes");
while (i < count_i) {
    jResp.I = i;
    i = i + 1;
}

i = 0;
count_i = jResp.SizeOfArray("variations");
while (i < count_i) {
    jResp.I = i;
    i = i + 1;
}

i = 0;
count_i = jResp.SizeOfArray("grouped_products");
while (i < count_i) {
    jResp.I = i;
    i = i + 1;
}

i = 0;
count_i = jResp.SizeOfArray("meta_data");
while (i < count_i) {
    jResp.I = i;
    i = i + 1;
}

i = 0;
count_i = jResp.SizeOfArray("_links.self");
while (i < count_i) {
    jResp.I = i;
    href = jResp.StringOf("_links.self[i].href");
    i = i + 1;
}

i = 0;
count_i = jResp.SizeOfArray("_links.collection");
while (i < count_i) {
    jResp.I = i;
    href = jResp.StringOf("_links.collection[i].href");
    i = i + 1;
}