Chilkat Online Tools

Ruby / Salesforce Platform APIs / Request Product Information (Bundled Components)

Back to Collection Items

require 'chilkat'

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

http = Chilkat::CkHttp.new()

# Use this online tool to generate code from sample JSON: Generate Code to Create JSON

# The following JSON is sent in the request body.

# {
#   "productContexts": [
#     {
#       "product2Id": "{{WorkAnywhereBundleProduct}}"
#     }
#   ],
#   "retrievalType": "IncludeChildComponents"
# }

json = Chilkat::CkJsonObject.new()
json.UpdateString("productContexts[0].product2Id","{{WorkAnywhereBundleProduct}}")
json.UpdateString("retrievalType","IncludeChildComponents")

# Adds the "Authorization: Bearer <access_token>" header.
http.put_AuthToken("<access_token>")
http.SetRequestHeader("Content-Type","application/json")

# resp is a CkHttpResponse
resp = http.PostJson3("https://domain.com/services/data/v{{version}}/commerce/catalog-products/actions/get-products","application/json",json)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

print resp.get_StatusCode().to_s() + "\n";
print resp.bodyStr() + "\n";

Curl Command

curl -X POST
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
	-d '{
  "productContexts": [
    {
      "product2Id": "{{WorkAnywhereBundleProduct}}"
    }
  ],
  "retrievalType": "IncludeChildComponents"
}'
https://domain.com/services/data/v{{version}}/commerce/catalog-products/actions/get-products

Postman Collection Item JSON

{
  "name": "Request Product Information (Bundled Components)",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"productContexts\": [\n    {\n      \"product2Id\": \"{{WorkAnywhereBundleProduct}}\"\n    }\n  ],\n  \"retrievalType\": \"IncludeChildComponents\"\n}"
    },
    "url": {
      "raw": "{{_endpoint}}/services/data/v{{version}}/commerce/catalog-products/actions/get-products",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "data",
        "v{{version}}",
        "commerce",
        "catalog-products",
        "actions",
        "get-products"
      ]
    },
    "description": "Request information for a single bundle product and all it's bundle components. See [Request Product Information](https://developer.salesforce.com/docs/revenue/subscription-management/references/products?meta=Request+Product+Information)."
  },
  "response": [
  ]
}