Chilkat Online Tools

PureBasic / Zoho CRM REST APIs / Sales Orders

Back to Collection Items

IncludeFile "CkJsonObject.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"

Procedure ChilkatExample()

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

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i

    ; 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": [
    ;     {
    ;       "Subject": "Quote1001",
    ;       "Deal_Name": {
    ;         "name": "Sample",
    ;         "id": "{{deal_id}}"
    ;       },
    ;       "Quote_Name": {
    ;         "name": "Quote1001",
    ;         "id": "{{quote_id}}"
    ;       },
    ;       "Status": "Created",
    ;       "Product_Details": [
    ;         {
    ;           "product": {
    ;             "name": "sample",
    ;             "id": "{{product_id}}"
    ;           },
    ;           "quantity": 1
    ;         }
    ;       ],
    ;       "Account_Name": {
    ;         "name": "Zylker",
    ;         "id": "{{account_name}}"
    ;       }
    ;     }
    ;   ]
    ; }

    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckUpdateString(json,"data[0].Subject","Quote1001")
    CkJsonObject::ckUpdateString(json,"data[0].Deal_Name.name","Sample")
    CkJsonObject::ckUpdateString(json,"data[0].Deal_Name.id","{{deal_id}}")
    CkJsonObject::ckUpdateString(json,"data[0].Quote_Name.name","Quote1001")
    CkJsonObject::ckUpdateString(json,"data[0].Quote_Name.id","{{quote_id}}")
    CkJsonObject::ckUpdateString(json,"data[0].Status","Created")
    CkJsonObject::ckUpdateString(json,"data[0].Product_Details[0].product.name","sample")
    CkJsonObject::ckUpdateString(json,"data[0].Product_Details[0].product.id","{{product_id}}")
    CkJsonObject::ckUpdateInt(json,"data[0].Product_Details[0].quantity",1)
    CkJsonObject::ckUpdateString(json,"data[0].Account_Name.name","Zylker")
    CkJsonObject::ckUpdateString(json,"data[0].Account_Name.id","{{account_name}}")

    ; Adds the "Authorization: Bearer <access_token>" header.
    CkHttp::setCkAuthToken(http, "<access_token>")

    resp.i = CkHttp::ckPostJson3(http,"https://domain.com/crm/v2.1/Sales_Orders/upsert","application/json",json)
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(json)
        ProcedureReturn
    EndIf

    Debug Str(CkHttpResponse::ckStatusCode(resp))
    Debug CkHttpResponse::ckBodyStr(resp)
    CkHttpResponse::ckDispose(resp)



    CkHttp::ckDispose(http)
    CkJsonObject::ckDispose(json)


    ProcedureReturn
EndProcedure

Curl Command

curl -X POST
	-H "Authorization: Bearer <access_token>"
	-d '{
    "data": [
        {
            "Subject": "Quote1001",
            "Deal_Name": {
                "name": "Sample",
                "id": "{{deal_id}}"
            },
            "Quote_Name": {
                "name": "Quote1001",
                "id": "{{quote_id}}"
            },
            "Status": "Created",
            "Product_Details": [
                {
                    "product": {
                        "name": "sample",
                        "id": "{{product_id}}"
                    },
                    "quantity": 1
                }
            ],
            "Account_Name": {
                "name": "Zylker",
                "id": "{{account_name}}"
            }
        }
    ]
}'
https://domain.com/crm/v2.1/Sales_Orders/upsert

Postman Collection Item JSON

{
  "name": "Sales Orders",
  "request": {
    "auth": {
      "type": "bearer",
      "bearer": [
        {
          "key": "token",
          "value": "{{access-token}}",
          "type": "string"
        }
      ]
    },
    "method": "POST",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"data\": [\n        {\n            \"Subject\": \"Quote1001\",\n            \"Deal_Name\": {\n                \"name\": \"Sample\",\n                \"id\": \"{{deal_id}}\"\n            },\n            \"Quote_Name\": {\n                \"name\": \"Quote1001\",\n                \"id\": \"{{quote_id}}\"\n            },\n            \"Status\": \"Created\",\n            \"Product_Details\": [\n                {\n                    \"product\": {\n                        \"name\": \"sample\",\n                        \"id\": \"{{product_id}}\"\n                    },\n                    \"quantity\": 1\n                }\n            ],\n            \"Account_Name\": {\n                \"name\": \"Zylker\",\n                \"id\": \"{{account_name}}\"\n            }\n        }\n    ]\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{api-domain}}/crm/v2.1/Sales_Orders/upsert",
      "host": [
        "{{api-domain}}"
      ],
      "path": [
        "crm",
        "v2.1",
        "Sales_Orders",
        "upsert"
      ]
    },
    "description": "To upsert records in the Sales Orders module."
  },
  "response": [
  ]
}