Chilkat Online Tools

Foxpro / Zoho CRM REST APIs / Quotes

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
LOCAL loJson
LOCAL loSbRequestBody
LOCAL loResp

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

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')

* 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": [
*     {
*       "Owner": {
*         "id": "{{user-id}}"
*       },
*       "Contact_Name": {
*         "id": "{{contact-id}}"
*       },
*       "Deal_Name": {
*         "id": "{{deal-id}}"
*       },
*       "Account_Name": {
*         "id": "{{account-name}}"
*       },
*       "Discount": 127.67,
*       "Description": "Design your own layouts that align your business processes precisely. Assign them to profiles appropriately.",
*       "Shipping_State": "Shipping_State",
*       "Tax": 127.67,
*       "Valid_Till": "2018-01-25",
*       "Billing_Country": "Billing_Country",
*       "Team": "Team",
*       "Carrier": "USPS",
*       "Quote_Stage": "Delivered",
*       "Billing_Street": "Billing_Street",
*       "Adjustment": 127.67,
*       "Terms_and_Conditions": "Design your own layouts that align your business processes precisely. Assign them to profiles appropriately.",
*       "Billing_Code": "Billing_Code",
*       "Product_Details": [
*         {
*           "product": {
*             "id": "1000000071967"
*           },
*           "quantity": 150,
*           "Discount": 20,
*           "product_description": "product_description",
*           "Unit Price": 10,
*           "line_tax": [
*             {
*               "percentage": 10.5,
*               "name": "Sales Tax"
*             },
*             {
*               "percentage": 6.5,
*               "name": "Common Tax"
*             }
*           ]
*         }
*       ],
*       "Subject": "Subject",
*       "Shipping_City": "Shipping_City",
*       "Shipping_Country": "Shipping_Country",
*       "Shipping_Code": "Shipping_Code",
*       "Billing_City": "Billing_City",
*       "Billing_State": "Billing_State",
*       "$line_tax": [
*         {
*           "percentage": 12.5,
*           "name": "Sales Tax"
*         },
*         {
*           "percentage": 8.5,
*           "name": "Common Tax"
*         }
*       ],
*       "Shipping_Street": "Shipping_Street"
*     }
*   ]
* }

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJson = CreateObject('Chilkat.JsonObject')
loJson.UpdateString("data[0].Owner.id","{{user-id}}")
loJson.UpdateString("data[0].Contact_Name.id","{{contact-id}}")
loJson.UpdateString("data[0].Deal_Name.id","{{deal-id}}")
loJson.UpdateString("data[0].Account_Name.id","{{account-name}}")
loJson.UpdateNumber("data[0].Discount","127.67")
loJson.UpdateString("data[0].Description","Design your own layouts that align your business processes precisely. Assign them to profiles appropriately.")
loJson.UpdateString("data[0].Shipping_State","Shipping_State")
loJson.UpdateNumber("data[0].Tax","127.67")
loJson.UpdateString("data[0].Valid_Till","2018-01-25")
loJson.UpdateString("data[0].Billing_Country","Billing_Country")
loJson.UpdateString("data[0].Team","Team")
loJson.UpdateString("data[0].Carrier","USPS")
loJson.UpdateString("data[0].Quote_Stage","Delivered")
loJson.UpdateString("data[0].Billing_Street","Billing_Street")
loJson.UpdateNumber("data[0].Adjustment","127.67")
loJson.UpdateString("data[0].Terms_and_Conditions","Design your own layouts that align your business processes precisely. Assign them to profiles appropriately.")
loJson.UpdateString("data[0].Billing_Code","Billing_Code")
loJson.UpdateString("data[0].Product_Details[0].product.id","1000000071967")
loJson.UpdateInt("data[0].Product_Details[0].quantity",150)
loJson.UpdateInt("data[0].Product_Details[0].Discount",20)
loJson.UpdateString("data[0].Product_Details[0].product_description","product_description")
loJson.UpdateInt('data[0].Product_Details[0]."Unit Price"',10)
loJson.UpdateNumber("data[0].Product_Details[0].line_tax[0].percentage","10.5")
loJson.UpdateString("data[0].Product_Details[0].line_tax[0].name","Sales Tax")
loJson.UpdateNumber("data[0].Product_Details[0].line_tax[1].percentage","6.5")
loJson.UpdateString("data[0].Product_Details[0].line_tax[1].name","Common Tax")
loJson.UpdateString("data[0].Subject","Subject")
loJson.UpdateString("data[0].Shipping_City","Shipping_City")
loJson.UpdateString("data[0].Shipping_Country","Shipping_Country")
loJson.UpdateString("data[0].Shipping_Code","Shipping_Code")
loJson.UpdateString("data[0].Billing_City","Billing_City")
loJson.UpdateString("data[0].Billing_State","Billing_State")
loJson.UpdateNumber("data[0].$line_tax[0].percentage","12.5")
loJson.UpdateString("data[0].$line_tax[0].name","Sales Tax")
loJson.UpdateNumber("data[0].$line_tax[1].percentage","8.5")
loJson.UpdateString("data[0].$line_tax[1].name","Common Tax")
loJson.UpdateString("data[0].Shipping_Street","Shipping_Street")

loHttp.SetRequestHeader("Authorization","{{authorization-token}}")
loHttp.SetRequestHeader("Content-Type","application/json")

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbRequestBody = CreateObject('Chilkat.StringBuilder')
loJson.EmitSb(loSbRequestBody)

loResp = loHttp.PTextSb("PUT","https://domain.com/crm/v2.1/Quotes/{{record-id}}",loSbRequestBody,"utf-8","application/json",0,0)
IF (loHttp.LastMethodSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loJson
    RELEASE loSbRequestBody
    CANCEL
ENDIF

? STR(loResp.StatusCode)
? loResp.BodyStr
RELEASE loResp

RELEASE loHttp
RELEASE loJson
RELEASE loSbRequestBody

Curl Command

curl -X PUT
	-H "Authorization: Bearer <access_token>"
	-H "Authorization: {{authorization-token}}"
	-H "Content-Type: application/json"
	-d '{
	"data": [
		{
			"Owner": {
				"id": "{{user-id}}"
			},
			"Contact_Name": {
				"id": "{{contact-id}}"
			},
			"Deal_Name": {
				"id": "{{deal-id}}"
			},
			"Account_Name": {
				"id": "{{account-name}}"
			},
			"Discount": 127.67,
			"Description": "Design your own layouts that align your business processes precisely. Assign them to profiles appropriately.",
			"Shipping_State": "Shipping_State",
			"Tax": 127.67,
			"Valid_Till": "2018-01-25",
			"Billing_Country": "Billing_Country",
			"Team": "Team",
			"Carrier": "USPS",
			"Quote_Stage": "Delivered",
			"Billing_Street": "Billing_Street",
			"Adjustment": 127.67,
			"Terms_and_Conditions": "Design your own layouts that align your business processes precisely. Assign them to profiles appropriately.",
			"Billing_Code": "Billing_Code",
			"Product_Details": [
				{
					"product": {"id":"1000000071967"},
					"quantity": 150,
					"Discount": 20,
					"product_description": "product_description",
					"Unit Price": 10,
					"line_tax": [
						{
							"percentage": 10.5,
							"name": "Sales Tax"
						},
						{
							"percentage": 6.5,
							"name": "Common Tax"
						}
					]
				}
			],
			"Subject": "Subject",
			"Shipping_City": "Shipping_City",
			"Shipping_Country": "Shipping_Country",
			"Shipping_Code": "Shipping_Code",
			"Billing_City": "Billing_City",
			"Billing_State": "Billing_State",
			"$line_tax": [
				{
					"percentage": 12.5,
					"name": "Sales Tax"
				},
				{
					"percentage": 8.5,
					"name": "Common Tax"
				}
			],
			"Shipping_Street": "Shipping_Street"
		}
	]
}'
https://domain.com/crm/v2.1/Quotes/{{record-id}}

Postman Collection Item JSON

{
  "name": "Quotes",
  "request": {
    "method": "PUT",
    "header": [
      {
        "key": "Authorization",
        "value": "{{authorization-token}}"
      },
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n\t\"data\": [\n\t\t{\n\t\t\t\"Owner\": {\n\t\t\t\t\"id\": \"{{user-id}}\"\n\t\t\t},\n\t\t\t\"Contact_Name\": {\n\t\t\t\t\"id\": \"{{contact-id}}\"\n\t\t\t},\n\t\t\t\"Deal_Name\": {\n\t\t\t\t\"id\": \"{{deal-id}}\"\n\t\t\t},\n\t\t\t\"Account_Name\": {\n\t\t\t\t\"id\": \"{{account-name}}\"\n\t\t\t},\n\t\t\t\"Discount\": 127.67,\n\t\t\t\"Description\": \"Design your own layouts that align your business processes precisely. Assign them to profiles appropriately.\",\n\t\t\t\"Shipping_State\": \"Shipping_State\",\n\t\t\t\"Tax\": 127.67,\n\t\t\t\"Valid_Till\": \"2018-01-25\",\n\t\t\t\"Billing_Country\": \"Billing_Country\",\n\t\t\t\"Team\": \"Team\",\n\t\t\t\"Carrier\": \"USPS\",\n\t\t\t\"Quote_Stage\": \"Delivered\",\n\t\t\t\"Billing_Street\": \"Billing_Street\",\n\t\t\t\"Adjustment\": 127.67,\n\t\t\t\"Terms_and_Conditions\": \"Design your own layouts that align your business processes precisely. Assign them to profiles appropriately.\",\n\t\t\t\"Billing_Code\": \"Billing_Code\",\n\t\t\t\"Product_Details\": [\n\t\t\t\t{\n\t\t\t\t\t\"product\": {\"id\":\"1000000071967\"},\n\t\t\t\t\t\"quantity\": 150,\n\t\t\t\t\t\"Discount\": 20,\n\t\t\t\t\t\"product_description\": \"product_description\",\n\t\t\t\t\t\"Unit Price\": 10,\n\t\t\t\t\t\"line_tax\": [\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\"percentage\": 10.5,\n\t\t\t\t\t\t\t\"name\": \"Sales Tax\"\n\t\t\t\t\t\t},\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\"percentage\": 6.5,\n\t\t\t\t\t\t\t\"name\": \"Common Tax\"\n\t\t\t\t\t\t}\n\t\t\t\t\t]\n\t\t\t\t}\n\t\t\t],\n\t\t\t\"Subject\": \"Subject\",\n\t\t\t\"Shipping_City\": \"Shipping_City\",\n\t\t\t\"Shipping_Country\": \"Shipping_Country\",\n\t\t\t\"Shipping_Code\": \"Shipping_Code\",\n\t\t\t\"Billing_City\": \"Billing_City\",\n\t\t\t\"Billing_State\": \"Billing_State\",\n\t\t\t\"$line_tax\": [\n\t\t\t\t{\n\t\t\t\t\t\"percentage\": 12.5,\n\t\t\t\t\t\"name\": \"Sales Tax\"\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"percentage\": 8.5,\n\t\t\t\t\t\"name\": \"Common Tax\"\n\t\t\t\t}\n\t\t\t],\n\t\t\t\"Shipping_Street\": \"Shipping_Street\"\n\t\t}\n\t]\n}"
    },
    "url": {
      "raw": "{{api-domain}}/crm/v2.1/Quotes/{{record-id}}",
      "host": [
        "{{api-domain}}"
      ],
      "path": [
        "crm",
        "v2.1",
        "Quotes",
        "{{record-id}}"
      ]
    },
    "description": "To update existing entities in the module."
  },
  "response": [
  ]
}