PureBasic / Salesforce Platform APIs / Request Product Information (No Bundles)
Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
; 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"
; }
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"productContexts[0].product2Id","{{ClassTrainingProduct}}")
CkJsonObject::ckUpdateString(json,"productContexts[0].productSellingModelId","{{OneTimePSM}}")
CkJsonObject::ckUpdateString(json,"productContexts[1].product2Id","{{VirtualRouterProduct}}")
CkJsonObject::ckUpdateString(json,"fields[0]","id")
CkJsonObject::ckUpdateString(json,"fields[1]","name")
CkJsonObject::ckUpdateString(json,"fields[2]","IsActive")
CkJsonObject::ckUpdateString(json,"fields[3]","ProductCode")
CkJsonObject::ckUpdateString(json,"retrievalType","ExcludeChildComponents")
; Adds the "Authorization: Bearer <access_token>" header.
CkHttp::setCkAuthToken(http, "<access_token>")
CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")
resp.i = CkHttp::ckPostJson3(http,"https://domain.com/services/data/v{{version}}/commerce/catalog-products/actions/get-products","application/json",json)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
ProcedureReturn
EndIf
Debug Str(CkHttpResponse::ckStatusCode(resp))
Debug CkHttpResponse::ckBodyStr(resp)
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
ProcedureReturn
EndProcedure
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": [
]
}