Chilkat Online Tools

TCL / Zoho CRM REST APIs / Creating an inventory module's record with external fields in the line items

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]

# Use this online tool to generate code from sample JSON: Generate Code to Create JSON

# The following JSON is sent in the request body.

# {
#   "data": [
#     {
#       "External_Quote_ID": "quote1",
#       "Subject": "Quote 1",
#       "Product_Details": [
#         {
#           "product": {
#             "External_Product_ID": "12345678900"
#           },
#           "book": {
#             "External_Price_book_ID": "pricebook1"
#           },
#           "quantity": 100
#         }
#       ]
#     }
#   ]
# }

set json [new_CkJsonObject]

CkJsonObject_UpdateString $json "data[0].External_Quote_ID" "quote1"
CkJsonObject_UpdateString $json "data[0].Subject" "Quote 1"
CkJsonObject_UpdateString $json "data[0].Product_Details[0].product.External_Product_ID" "12345678900"
CkJsonObject_UpdateString $json "data[0].Product_Details[0].book.External_Price_book_ID" "pricebook1"
CkJsonObject_UpdateInt $json "data[0].Product_Details[0].quantity" 100

# Adds the "Authorization: Bearer <access_token>" header.
CkHttp_put_AuthToken $http "<access_token>"
CkHttp_SetRequestHeader $http "X-EXTERNAL" "Quotes.External_ID"

set resp [new_CkHttpResponse]

set success [CkHttp_HttpJson $http "POST" "https://domain.com/crm/v2/Quotes" $json "application/json" $resp]
if {$success == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkJsonObject $json
    delete_CkHttpResponse $resp
    exit
}

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

delete_CkHttp $http
delete_CkJsonObject $json
delete_CkHttpResponse $resp

Curl Command

curl -X POST
	-H "Authorization: Bearer <access_token>"
	-H "X-EXTERNAL: Quotes.External_ID"
	-d '{
    "data": [
        {
            "External_Quote_ID": "quote1",
            "Subject": "Quote 1",
            "Product_Details": [
                {
                    "product": {
                        "External_Product_ID": "12345678900"
                    },
                    "book": {
                        "External_Price_book_ID": "pricebook1"
                    },
                    "quantity": 100
                }
            ]
        }
    ]
}'
https://domain.com/crm/v2/Quotes

Postman Collection Item JSON

{
  "name": "Creating an inventory module's record with external fields in the line items",
  "request": {
    "auth": {
      "type": "bearer",
      "bearer": [
        {
          "key": "token",
          "value": "{{access-token}}",
          "type": "string"
        }
      ]
    },
    "method": "POST",
    "header": [
      {
        "key": "X-EXTERNAL",
        "value": "Quotes.External_ID",
        "type": "text"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"data\": [\n        {\n            \"External_Quote_ID\": \"quote1\",\n            \"Subject\": \"Quote 1\",\n            \"Product_Details\": [\n                {\n                    \"product\": {\n                        \"External_Product_ID\": \"12345678900\"\n                    },\n                    \"book\": {\n                        \"External_Price_book_ID\": \"pricebook1\"\n                    },\n                    \"quantity\": 100\n                }\n            ]\n        }\n    ]\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{api-domain}}/crm/v2/Quotes",
      "host": [
        "{{api-domain}}"
      ],
      "path": [
        "crm",
        "v2",
        "Quotes"
      ]
    },
    "description": "In this example, we will create a quote by using the external values in the Product_Details section that comprises the associated product and the price book. So, Quotes is the base module's API name, the API names of the external fields in the Products and Price Books modules are External_Product_ID and External_Price_book_ID, respectively."
  },
  "response": [
  ]
}