Chilkat Online Tools

PureBasic / Commercetools / Create Product

Back to Collection Items

IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.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.

    ; {
    ;   "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
    ;           }
    ;         }
    ;       ]
    ;     }
    ;   ]
    ; }

    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

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

    ; Adds the "Authorization: Bearer <access_token>" header.
    CkHttp::setCkAuthToken(http, "<access_token>")
    CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")

    sbRequestBody.i = CkStringBuilder::ckCreate()
    If sbRequestBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckEmitSb(json,sbRequestBody)

    resp.i = CkHttp::ckPTextSb(http,"post","https://domain.com/{{project-key}}/products",sbRequestBody,"utf-8","application/json",0,0)
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(json)
        CkStringBuilder::ckDispose(sbRequestBody)
        ProcedureReturn
    EndIf

    Debug Str(CkHttpResponse::ckStatusCode(resp))
    Debug CkHttpResponse::ckBodyStr(resp)
    CkHttpResponse::ckDispose(resp)



    CkHttp::ckDispose(http)
    CkJsonObject::ckDispose(json)
    CkStringBuilder::ckDispose(sbRequestBody)


    ProcedureReturn
EndProcedure

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": [
  ]
}