Chilkat Online Tools

Foxpro / Salesforce Platform APIs / Request Product Information (No Bundles)

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
LOCAL loJson
LOCAL loResp

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

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')

* 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": "{{ClassTrainingProduct}}",
*       "productSellingModelId": "{{OneTimePSM}}"
*     },
*     {
*       "product2Id": "{{VirtualRouterProduct}}"
*     }
*   ],
*   "fields": [
*     "id",
*     "name",
*     "IsActive",
*     "ProductCode"
*   ],
*   "retrievalType": "ExcludeChildComponents"
* }

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJson = CreateObject('Chilkat.JsonObject')
loJson.UpdateString("productContexts[0].product2Id","{{ClassTrainingProduct}}")
loJson.UpdateString("productContexts[0].productSellingModelId","{{OneTimePSM}}")
loJson.UpdateString("productContexts[1].product2Id","{{VirtualRouterProduct}}")
loJson.UpdateString("fields[0]","id")
loJson.UpdateString("fields[1]","name")
loJson.UpdateString("fields[2]","IsActive")
loJson.UpdateString("fields[3]","ProductCode")
loJson.UpdateString("retrievalType","ExcludeChildComponents")

* Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"
loHttp.SetRequestHeader("Content-Type","application/json")

loResp = loHttp.PostJson3("https://domain.com/services/data/v{{version}}/commerce/catalog-products/actions/get-products","application/json",loJson)
IF (loHttp.LastMethodSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loJson
    CANCEL
ENDIF

? STR(loResp.StatusCode)
? loResp.BodyStr
RELEASE loResp

RELEASE loHttp
RELEASE loJson

Curl Command

curl -X POST
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
	-d '{
  "productContexts": [
    {
      "product2Id": "{{ClassTrainingProduct}}",
      "productSellingModelId": "{{OneTimePSM}}"
    },
    {
      "product2Id": "{{VirtualRouterProduct}}"  
    }
  ],
  "fields": [
    "id",
    "name",
    "IsActive",
    "ProductCode"
  ],
  "retrievalType": "ExcludeChildComponents"
}'
https://domain.com/services/data/v{{version}}/commerce/catalog-products/actions/get-products

Postman Collection Item JSON

{
  "name": "Request Product Information (No Bundles)",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"productContexts\": [\n    {\n      \"product2Id\": \"{{ClassTrainingProduct}}\",\n      \"productSellingModelId\": \"{{OneTimePSM}}\"\n    },\n    {\n      \"product2Id\": \"{{VirtualRouterProduct}}\"  \n    }\n  ],\n  \"fields\": [\n    \"id\",\n    \"name\",\n    \"IsActive\",\n    \"ProductCode\"\n  ],\n  \"retrievalType\": \"ExcludeChildComponents\"\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 two products that aren't bundles. For the first product, request only the information about the specified product selling model. For the second product, request information about all related product selling models.\n\nSee [Request Product Information](https://desktop.postman.com/?desktopVersion=10.13.6&webVersion=10.13.7-ui-230522-1730&userId=10709048&teamId=0)."
  },
  "response": [
  ]
}