Chilkat Online Tools

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

Back to Collection Items

integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_Json
oleobject loo_Resp

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

loo_Http = create oleobject
li_rc = loo_Http.ConnectToNewObject("Chilkat_9_5_0.Http")
if li_rc < 0 then
    destroy loo_Http
    MessageBox("Error","Connecting to COM object failed")
    return
end if

// 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
//         }
//       ]
//     }
//   ]
// }

loo_Json = create oleobject
li_rc = loo_Json.ConnectToNewObject("Chilkat_9_5_0.JsonObject")

loo_Json.UpdateString("data[0].External_Quote_ID","quote1")
loo_Json.UpdateString("data[0].Subject","Quote 1")
loo_Json.UpdateString("data[0].Product_Details[0].product.External_Product_ID","12345678900")
loo_Json.UpdateString("data[0].Product_Details[0].book.External_Price_book_ID","pricebook1")
loo_Json.UpdateInt("data[0].Product_Details[0].quantity",100)

// Adds the "Authorization: Bearer <access_token>" header.
loo_Http.AuthToken = "<access_token>"
loo_Http.SetRequestHeader("X-EXTERNAL","Quotes.External_ID")

loo_Resp = loo_Http.PostJson3("https://domain.com/crm/v2/Quotes","application/json",loo_Json)
if loo_Http.LastMethodSuccess = 0 then
    Write-Debug loo_Http.LastErrorText
    destroy loo_Http
    destroy loo_Json
    return
end if

Write-Debug string(loo_Resp.StatusCode)
Write-Debug loo_Resp.BodyStr
destroy loo_Resp


destroy loo_Http
destroy loo_Json

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