(CkPython) 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 Python Downloads install with pip pip3 install chilkat or download... Python Module for Windows, MacOS, Linux, Alpine Linux, Solaris

import sys
import chilkat

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

http = chilkat.CkHttp()

# 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.put_BasicAuth(True)
http.put_Login("consumer_key")
http.put_Password("consumer_secret")

sbResponseBody = chilkat.CkStringBuilder()
success = http.QuickGetSb("https://example.com/wp-json/wc/v3/products/794",sbResponseBody)
if (success == False):
    print(http.lastErrorText())
    sys.exit()

jResp = chilkat.CkJsonObject()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(False)

print("Response Body:")
print(jResp.emit())

respStatusCode = http.get_LastStatus()
print("Response Status Code = " + str(respStatusCode))
if (respStatusCode >= 400):
    print("Response Header:")
    print(http.lastHeader())
    print("Failed.")
    sys.exit()

# 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

date_created = chilkat.CkDtObj()
date_created_gmt = chilkat.CkDtObj()
date_modified = chilkat.CkDtObj()
date_modified_gmt = chilkat.CkDtObj()
date_on_sale_from = chilkat.CkDtObj()
date_on_sale_from_gmt = chilkat.CkDtObj()
date_on_sale_to = chilkat.CkDtObj()
date_on_sale_to_gmt = chilkat.CkDtObj()

id = jResp.IntOf("id")
name = jResp.stringOf("name")
slug = jResp.stringOf("slug")
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)
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")
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)
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")
while i < count_i :
    jResp.put_I(i)
    i = i + 1

i = 0
count_i = jResp.SizeOfArray("related_ids")
while i < count_i :
    jResp.put_I(i)
    intVal = jResp.IntOf("related_ids[i]")
    i = i + 1

i = 0
count_i = jResp.SizeOfArray("upsell_ids")
while i < count_i :
    jResp.put_I(i)
    i = i + 1

i = 0
count_i = jResp.SizeOfArray("cross_sell_ids")
while i < count_i :
    jResp.put_I(i)
    i = i + 1

i = 0
count_i = jResp.SizeOfArray("categories")
while i < count_i :
    jResp.put_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.put_I(i)
    i = i + 1

i = 0
count_i = jResp.SizeOfArray("images")
while i < count_i :
    jResp.put_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.put_I(i)
    i = i + 1

i = 0
count_i = jResp.SizeOfArray("default_attributes")
while i < count_i :
    jResp.put_I(i)
    i = i + 1

i = 0
count_i = jResp.SizeOfArray("variations")
while i < count_i :
    jResp.put_I(i)
    i = i + 1

i = 0
count_i = jResp.SizeOfArray("grouped_products")
while i < count_i :
    jResp.put_I(i)
    i = i + 1

i = 0
count_i = jResp.SizeOfArray("meta_data")
while i < count_i :
    jResp.put_I(i)
    i = i + 1

i = 0
count_i = jResp.SizeOfArray("_links.self")
while i < count_i :
    jResp.put_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.put_I(i)
    href = jResp.stringOf("_links.collection[i].href")
    i = i + 1