Chilkat Online Tools

Foxpro / Commercetools / Create Product

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
LOCAL loJson
LOCAL loSbRequestBody
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.

* {
*   "productType": {
*     "id": "24f510c3-f334-4099-94e2-d6224a8eb919",
*     "typeId": "product-type"
*   },
*   "categories": [
*     {
*       "typeId": "category",
*       "id": "24f510c3-f334-4099-94e2-d6224a8eb919"
*     }
*   ],
*   "name": {
*     "en": "Some Product"
*   },
*   "slug": {
*     "en": "product_slug_<random-uuid>"
*   },
*   "masterVariant": {
*     "sku": "SKU-1",
*     "prices": [
*       {
*         "value": {
*           "currencyCode": "EUR",
*           "centAmount": 4200
*         }
*       }
*     ],
*     "images": [
*       {
*         "url": "http://my.custom.cdn.net/master.png",
*         "label": "Master Image",
*         "dimensions": {
*           "w": 303,
*           "h": 197
*         }
*       }
*     ]
*   },
*   "variants": [
*     {
*       "images": [
*         {
*           "url": "http://my.custom.cdn.net/variant.png",
*           "label": "Variant Image",
*           "dimensions": {
*             "w": 303,
*             "h": 197
*           }
*         }
*       ]
*     }
*   ]
* }

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJson = CreateObject('Chilkat.JsonObject')
loJson.UpdateString("productType.id","24f510c3-f334-4099-94e2-d6224a8eb919")
loJson.UpdateString("productType.typeId","product-type")
loJson.UpdateString("categories[0].typeId","category")
loJson.UpdateString("categories[0].id","24f510c3-f334-4099-94e2-d6224a8eb919")
loJson.UpdateString("name.en","Some Product")
loJson.UpdateString("slug.en","product_slug_<random-uuid>")
loJson.UpdateString("masterVariant.sku","SKU-1")
loJson.UpdateString("masterVariant.prices[0].value.currencyCode","EUR")
loJson.UpdateInt("masterVariant.prices[0].value.centAmount",4200)
loJson.UpdateString("masterVariant.images[0].url","http://my.custom.cdn.net/master.png")
loJson.UpdateString("masterVariant.images[0].label","Master Image")
loJson.UpdateInt("masterVariant.images[0].dimensions.w",303)
loJson.UpdateInt("masterVariant.images[0].dimensions.h",197)
loJson.UpdateString("variants[0].images[0].url","http://my.custom.cdn.net/variant.png")
loJson.UpdateString("variants[0].images[0].label","Variant Image")
loJson.UpdateInt("variants[0].images[0].dimensions.w",303)
loJson.UpdateInt("variants[0].images[0].dimensions.h",197)

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

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbRequestBody = CreateObject('Chilkat.StringBuilder')
loJson.EmitSb(loSbRequestBody)

loResp = loHttp.PTextSb("post","https://domain.com/{{project-key}}/products",loSbRequestBody,"utf-8","application/json",0,0)
IF (loHttp.LastMethodSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loJson
    RELEASE loSbRequestBody
    CANCEL
ENDIF

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

RELEASE loHttp
RELEASE loJson
RELEASE loSbRequestBody

Curl Command

curl -X post
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
	-d '{
  "productType" : {
    "id" : "24f510c3-f334-4099-94e2-d6224a8eb919",
    "typeId" : "product-type"
  },
  "categories" : [ {
    "typeId" : "category",
    "id" : "24f510c3-f334-4099-94e2-d6224a8eb919"
  } ],
  "name" : {
    "en" : "Some Product"
  },
  "slug" : {
    "en" : "product_slug_<random-uuid>"
  },
  "masterVariant" : {
    "sku" : "SKU-1",
    "prices" : [ {
      "value" : {
        "currencyCode" : "EUR",
        "centAmount" : 4200
      }
    } ],
    "images" : [ {
      "url" : "http://my.custom.cdn.net/master.png",
      "label" : "Master Image",
      "dimensions" : {
        "w" : 303,
        "h" : 197
      }
    } ]
  },
  "variants" : [ {
    "images" : [ {
      "url" : "http://my.custom.cdn.net/variant.png",
      "label" : "Variant Image",
      "dimensions" : {
        "w" : 303,
        "h" : 197
      }
    } ]
  } ]
}'
https://domain.com/{{project-key}}/products

Postman Collection Item JSON

{
  "name": "Create Product",
  "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": "post",
    "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
        }
      ]
    },
    "description": "To create a new product, send a representation that is going to become the initial staged representation\nof the new product in the master catalog. If price selection query parameters are provided,\nthe selected prices will be added to the response.\n",
    "body": {
      "mode": "raw",
      "raw": "{\n  \"productType\" : {\n    \"id\" : \"24f510c3-f334-4099-94e2-d6224a8eb919\",\n    \"typeId\" : \"product-type\"\n  },\n  \"categories\" : [ {\n    \"typeId\" : \"category\",\n    \"id\" : \"24f510c3-f334-4099-94e2-d6224a8eb919\"\n  } ],\n  \"name\" : {\n    \"en\" : \"Some Product\"\n  },\n  \"slug\" : {\n    \"en\" : \"product_slug_<random-uuid>\"\n  },\n  \"masterVariant\" : {\n    \"sku\" : \"SKU-1\",\n    \"prices\" : [ {\n      \"value\" : {\n        \"currencyCode\" : \"EUR\",\n        \"centAmount\" : 4200\n      }\n    } ],\n    \"images\" : [ {\n      \"url\" : \"http:\/\/my.custom.cdn.net\/master.png\",\n      \"label\" : \"Master Image\",\n      \"dimensions\" : {\n        \"w\" : 303,\n        \"h\" : 197\n      }\n    } ]\n  },\n  \"variants\" : [ {\n    \"images\" : [ {\n      \"url\" : \"http:\/\/my.custom.cdn.net\/variant.png\",\n      \"label\" : \"Variant Image\",\n      \"dimensions\" : {\n        \"w\" : 303,\n        \"h\" : 197\n      }\n    } ]\n  } ]\n}"
    }
  },
  "response": [
  ]
}