Chilkat Online Tools

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

Back to Collection Items

require 'chilkat'

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

http = Chilkat::CkHttp.new()

# 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": [
#     {
#       "Product_Details": [
#         {
#           "id": "111111000000133071"
#         },
#         {
#           "product": {
#             "External_Product_ID": "12345678900"
#           },
#           "book": {
#             "External_Pricebook_ID": "pricebook2"
#           },
#           "quantity": 20
#         }
#       ]
#     }
#   ]
# }

json = Chilkat::CkJsonObject.new()
json.UpdateString("data[0].Product_Details[0].id","111111000000133071")
json.UpdateString("data[0].Product_Details[1].product.External_Product_ID","12345678900")
json.UpdateString("data[0].Product_Details[1].book.External_Pricebook_ID","pricebook2")
json.UpdateInt("data[0].Product_Details[1].quantity",20)

# Adds the "Authorization: Bearer <access_token>" header.
http.put_AuthToken("<access_token>")
http.SetRequestHeader("X-EXTERNAL","Quotes.Product_Details.product.External_Product_ID, Quotes.Product_Details.book.External_Price_book_ID")

sbRequestBody = Chilkat::CkStringBuilder.new()
json.EmitSb(sbRequestBody)

# resp is a CkHttpResponse
resp = http.PTextSb("PUT","https://domain.com/crm/v2/Quotes/quote1",sbRequestBody,"utf-8","application/json",false,false)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

print resp.get_StatusCode().to_s() + "\n";
print resp.bodyStr() + "\n";

Curl Command

curl -X PUT
	-H "Authorization: Bearer <access_token>"
	-H "X-EXTERNAL: Quotes.Product_Details.product.External_Product_ID, Quotes.Product_Details.book.External_Price_book_ID"
	-d '{
    "data": [
        {
            "Product_Details": [
                {
                    "id": "111111000000133071"
                },
                {
                    "product": {
                        "External_Product_ID": "12345678900"
                    },
                    "book": {
                        "External_Pricebook_ID": "pricebook2"
                    },
                    "quantity": 20
                }
            ]
        }
    ]
}'
https://domain.com/crm/v2/Quotes/quote1

Postman Collection Item JSON

{
  "name": "Updating 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": "PUT",
    "header": [
      {
        "key": "X-EXTERNAL",
        "value": "Quotes.Product_Details.product.External_Product_ID, Quotes.Product_Details.book.External_Price_book_ID",
        "type": "text"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"data\": [\n        {\n            \"Product_Details\": [\n                {\n                    \"id\": \"111111000000133071\"\n                },\n                {\n                    \"product\": {\n                        \"External_Product_ID\": \"12345678900\"\n                    },\n                    \"book\": {\n                        \"External_Pricebook_ID\": \"pricebook2\"\n                    },\n                    \"quantity\": 20\n                }\n            ]\n        }\n    ]\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{api-domain}}/crm/v2/Quotes/quote1",
      "host": [
        "{{api-domain}}"
      ],
      "path": [
        "crm",
        "v2",
        "Quotes",
        "quote1"
      ]
    },
    "description": "In this example, Quotes is the base module. To update the details in the Product_Details section, specify the external field's API name and the value in the product and book JSON objects."
  },
  "response": [
  ]
}