Chilkat Online Tools

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

Back to Collection Items

-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
    DECLARE @hr int
    DECLARE @iTmp0 int
    -- Important: Do not use nvarchar(max).  See the warning about using nvarchar(max).
    DECLARE @sTmp0 nvarchar(4000)
    -- This example assumes the Chilkat API to have been previously unlocked.
    -- See Global Unlock Sample for sample code.

    DECLARE @http int
    -- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    DECLARE @success int

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

    DECLARE @json int
    -- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @json OUT

    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'data[0].External_Quote_ID', 'quote1'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'data[0].Subject', 'Quote 1'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'data[0].Product_Details[0].product.External_Product_ID', '12345678900'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'data[0].Product_Details[0].book.External_Price_book_ID', 'pricebook1'
    EXEC sp_OAMethod @json, 'UpdateInt', @success OUT, 'data[0].Product_Details[0].quantity', 100

    -- Adds the "Authorization: Bearer <access_token>" header.
    EXEC sp_OASetProperty @http, 'AuthToken', '<access_token>'
    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'X-EXTERNAL', 'Quotes.External_ID'

    DECLARE @resp int
    EXEC sp_OAMethod @http, 'PostJson3', @resp OUT, 'https://domain.com/crm/v2/Quotes', 'application/json', @json
    EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
    IF @iTmp0 = 0
      BEGIN
        EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @http
        EXEC @hr = sp_OADestroy @json
        RETURN
      END

    EXEC sp_OAGetProperty @resp, 'StatusCode', @iTmp0 OUT
    PRINT @iTmp0
    EXEC sp_OAGetProperty @resp, 'BodyStr', @sTmp0 OUT
    PRINT @sTmp0
    EXEC @hr = sp_OADestroy @resp


    EXEC @hr = sp_OADestroy @http
    EXEC @hr = sp_OADestroy @json


END
GO

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