(Excel) 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

Download Excel Class Modules Chilkat Excel Class Modules

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

Dim http As Chilkat.Http
Set http = Chilkat.NewHttp

' 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"

Dim sbResponseBody As Chilkat.StringBuilder
Set sbResponseBody = Chilkat.NewStringBuilder
success = http.QuickGetSb("https://example.com/wp-json/wc/v3/products/794",sbResponseBody)
If (success = False) Then
    Debug.Print http.LastErrorText
    Exit Sub
End If

Dim jResp As Chilkat.JsonObject
Set jResp = Chilkat.NewJsonObject
Dim success As Boolean
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

Debug.Print "Response Body:"
Debug.Print jResp.Emit()


respStatusCode = http.LastStatus
Debug.Print "Response Status Code = "; respStatusCode
If (respStatusCode >= 400) Then
    Debug.Print "Response Header:"
    Debug.Print http.LastHeader
    Debug.Print "Failed."
    Exit Sub
End If

' 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

Dim date_created As Chilkat.DtObj
Set date_created = Chilkat.NewDtObj
Dim date_created_gmt As Chilkat.DtObj
Set date_created_gmt = Chilkat.NewDtObj
Dim date_modified As Chilkat.DtObj
Set date_modified = Chilkat.NewDtObj
Dim date_modified_gmt As Chilkat.DtObj
Set date_modified_gmt = Chilkat.NewDtObj
Dim date_on_sale_from As Chilkat.DtObj
Set date_on_sale_from = Chilkat.NewDtObj
Dim date_on_sale_from_gmt As Chilkat.DtObj
Set date_on_sale_from_gmt = Chilkat.NewDtObj
Dim date_on_sale_to As Chilkat.DtObj
Set date_on_sale_to = Chilkat.NewDtObj
Dim date_on_sale_to_gmt As Chilkat.DtObj
Set date_on_sale_to_gmt = Chilkat.NewDtObj


id = jResp.IntOf("id")

name = jResp.StringOf("name")

slug = jResp.StringOf("slug")

permalink = jResp.StringOf("permalink")
success = jResp.DtOf("date_created",False,date_created)
success = jResp.DtOf("date_created_gmt",False,date_created_gmt)
success = jResp.DtOf("date_modified",False,date_modified)
success = jResp.DtOf("date_modified_gmt",False,date_modified_gmt)

v_type = jResp.StringOf("type")

status = jResp.StringOf("status")

featured = jResp.BoolOf("featured")

catalog_visibility = jResp.StringOf("catalog_visibility")

description = jResp.StringOf("description")

short_description = jResp.StringOf("short_description")

sku = jResp.StringOf("sku")

price = jResp.StringOf("price")

regular_price = jResp.StringOf("regular_price")

sale_price = jResp.StringOf("sale_price")
success = jResp.DtOf("date_on_sale_from",False,date_on_sale_from)
success = jResp.DtOf("date_on_sale_from_gmt",False,date_on_sale_from_gmt)
success = jResp.DtOf("date_on_sale_to",False,date_on_sale_to)
success = jResp.DtOf("date_on_sale_to_gmt",False,date_on_sale_to_gmt)

price_html = jResp.StringOf("price_html")

on_sale = jResp.BoolOf("on_sale")

purchasable = jResp.BoolOf("purchasable")

total_sales = jResp.IntOf("total_sales")

virtual = jResp.BoolOf("virtual")

downloadable = jResp.BoolOf("downloadable")

download_limit = jResp.IntOf("download_limit")

download_expiry = jResp.IntOf("download_expiry")

external_url = jResp.StringOf("external_url")

button_text = jResp.StringOf("button_text")

tax_status = jResp.StringOf("tax_status")

tax_class = jResp.StringOf("tax_class")

manage_stock = jResp.BoolOf("manage_stock")

stock_quantity = jResp.StringOf("stock_quantity")

stock_status = jResp.StringOf("stock_status")

backorders = jResp.StringOf("backorders")

backorders_allowed = jResp.BoolOf("backorders_allowed")

backordered = jResp.BoolOf("backordered")

sold_individually = jResp.BoolOf("sold_individually")

weight = jResp.StringOf("weight")

dimensionsLength = jResp.StringOf("dimensions.length")

dimensionsWidth = jResp.StringOf("dimensions.width")

dimensionsHeight = jResp.StringOf("dimensions.height")

shipping_required = jResp.BoolOf("shipping_required")

shipping_taxable = jResp.BoolOf("shipping_taxable")

shipping_class = jResp.StringOf("shipping_class")

shipping_class_id = jResp.IntOf("shipping_class_id")

reviews_allowed = jResp.BoolOf("reviews_allowed")

average_rating = jResp.StringOf("average_rating")

rating_count = jResp.IntOf("rating_count")

parent_id = jResp.IntOf("parent_id")

purchase_note = jResp.StringOf("purchase_note")

menu_order = jResp.IntOf("menu_order")

i = 0

count_i = jResp.SizeOfArray("downloads")
Do While i < count_i
    jResp.I = i
    i = i + 1
Loop
i = 0
count_i = jResp.SizeOfArray("related_ids")
Do While i < count_i
    jResp.I = i
    intVal = jResp.IntOf("related_ids[i]")
    i = i + 1
Loop
i = 0
count_i = jResp.SizeOfArray("upsell_ids")
Do While i < count_i
    jResp.I = i
    i = i + 1
Loop
i = 0
count_i = jResp.SizeOfArray("cross_sell_ids")
Do While i < count_i
    jResp.I = i
    i = i + 1
Loop
i = 0
count_i = jResp.SizeOfArray("categories")
Do 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
Loop
i = 0
count_i = jResp.SizeOfArray("tags")
Do While i < count_i
    jResp.I = i
    i = i + 1
Loop
i = 0
count_i = jResp.SizeOfArray("images")
Do While i < count_i
    jResp.I = i
    id = jResp.IntOf("images[i].id")
    success = jResp.DtOf("images[i].date_created",False,date_created)
    success = jResp.DtOf("images[i].date_created_gmt",False,date_created_gmt)
    success = jResp.DtOf("images[i].date_modified",False,date_modified)
    success = 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
Loop
i = 0
count_i = jResp.SizeOfArray("attributes")
Do While i < count_i
    jResp.I = i
    i = i + 1
Loop
i = 0
count_i = jResp.SizeOfArray("default_attributes")
Do While i < count_i
    jResp.I = i
    i = i + 1
Loop
i = 0
count_i = jResp.SizeOfArray("variations")
Do While i < count_i
    jResp.I = i
    i = i + 1
Loop
i = 0
count_i = jResp.SizeOfArray("grouped_products")
Do While i < count_i
    jResp.I = i
    i = i + 1
Loop
i = 0
count_i = jResp.SizeOfArray("meta_data")
Do While i < count_i
    jResp.I = i
    i = i + 1
Loop
i = 0
count_i = jResp.SizeOfArray("_links.self")
Do While i < count_i
    jResp.I = i
    href = jResp.StringOf("_links.self[i].href")
    i = i + 1
Loop
i = 0
count_i = jResp.SizeOfArray("_links.collection")
Do While i < count_i
    jResp.I = i
    href = jResp.StringOf("_links.collection[i].href")
    i = i + 1
Loop