Chilkat Online Tools

TCL / Commercetools / Query products

Back to Collection Items

load ./chilkat.dll

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

set http [new_CkHttp]

# Adds the "Authorization: Bearer <access_token>" header.
CkHttp_put_AuthToken $http "<access_token>"
CkHttp_SetRequestHeader $http "Content-Type" "application/json"

# resp is a CkHttpResponse
set resp [CkHttp_QuickRequest $http "get" "https://domain.com/{{project-key}}/products"]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    exit
}

puts [CkHttpResponse_get_StatusCode $resp]
puts [CkHttpResponse_bodyStr $resp]
delete_CkHttpResponse $resp


delete_CkHttp $http

Curl Command

curl -X get
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
https://domain.com/{{project-key}}/products

Postman Collection Item JSON

{
  "name": "Query products",
  "event": [
    {
      "listen": "test",
      "script": {
        "type": "text/javascript",
        "exec": [
          "tests[\"Status code \" + responseCode.code] = responseCode.code === 200 || responseCode.code === 201;",
          "var data = JSON.parse(responseBody);",
          "if(data.results && data.results[0] && data.results[0].id && data.results[0].version){",
          "    pm.environment.set(\"product-id\", data.results[0].id); ",
          "    pm.environment.set(\"product-version\", data.results[0].version);",
          "}",
          "if(data.results && data.results[0] && data.results[0].key){",
          "    pm.environment.set(\"product-key\", data.results[0].key); ",
          "}",
          "if(data.version){",
          "    pm.environment.set(\"product-version\", data.version);",
          "}",
          "if(data.id){",
          "    pm.environment.set(\"product-id\", data.id); ",
          "}",
          "if(data.key){",
          "    pm.environment.set(\"product-key\", data.key);",
          "}",
          ""
        ]
      }
    }
  ],
  "request": {
    "auth": {
      "type": "oauth2",
      "oauth2": {
        "accessToken": "{{ctp_access_token}}",
        "addTokenTo": "header",
        "tokenType": "Bearer"
      }
    },
    "method": "get",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{host}}/{{project-key}}/products",
      "host": [
        "{{host}}"
      ],
      "path": [
        "{{project-key}}",
        "products"
      ],
      "query": [
        {
          "key": "priceCurrency",
          "value": "",
          "equals": true,
          "disabled": true
        },
        {
          "key": "priceCountry",
          "value": "",
          "equals": true,
          "disabled": true
        },
        {
          "key": "priceCustomerGroup",
          "value": "",
          "equals": true,
          "disabled": true
        },
        {
          "key": "priceChannel",
          "value": "",
          "equals": true,
          "disabled": true
        },
        {
          "key": "localeProjection",
          "value": "",
          "equals": true,
          "disabled": true
        },
        {
          "key": "storeProjection",
          "value": "",
          "equals": true,
          "disabled": true
        },
        {
          "key": "expand",
          "value": "",
          "equals": true,
          "disabled": true
        },
        {
          "key": "sort",
          "value": "",
          "equals": true,
          "disabled": true
        },
        {
          "key": "limit",
          "value": "",
          "equals": true,
          "disabled": true
        },
        {
          "key": "offset",
          "value": "",
          "equals": true,
          "disabled": true
        },
        {
          "key": "withTotal",
          "value": "",
          "equals": true,
          "disabled": true
        },
        {
          "key": "where",
          "value": "",
          "equals": true,
          "disabled": true
        },
        {
          "key": "/^var[.][a-zA-Z0-9]+$/",
          "value": "",
          "equals": true,
          "disabled": true
        }
      ]
    },
    "description": "You can use the query endpoint to get the full representations of products.\nREMARK: We suggest to use the performance optimized search endpoint which has a bunch functionalities,\nthe query API lacks like sorting on custom attributes, etc.\n",
    "body": {
      "mode": "raw",
      "raw": ""
    }
  },
  "response": [
  ]
}