Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.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": {
; "name": "<string>",
; "id": "<integer>",
; "code": "<string>",
; "net_price": "<number>",
; "gross_price": "<number>",
; "use_gross_price": "<boolean>",
; "default_vat": {
; "value": "<number>",
; "id": "<integer>",
; "description": "<string>",
; "notes": "<string>",
; "e_invoice": "<boolean>",
; "ei_type": "<string>",
; "ei_description": "<string>",
; "editable": true,
; "is_disabled": "<boolean>"
; },
; "net_cost": "<number>",
; "measure": "<string>",
; "description": "<string>",
; "category": "<string>",
; "notes": "<string>",
; "in_stock": "<boolean>",
; "stock_initial": "<number>",
; "stock_current": "<number>",
; "average_cost": "<number>",
; "average_price": "<number>",
; "created_at": "<string>",
; "updated_at": "<string>"
; }
; }
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"data.name","<string>")
CkJsonObject::ckUpdateString(json,"data.id","<integer>")
CkJsonObject::ckUpdateString(json,"data.code","<string>")
CkJsonObject::ckUpdateString(json,"data.net_price","<number>")
CkJsonObject::ckUpdateString(json,"data.gross_price","<number>")
CkJsonObject::ckUpdateString(json,"data.use_gross_price","<boolean>")
CkJsonObject::ckUpdateString(json,"data.default_vat.value","<number>")
CkJsonObject::ckUpdateString(json,"data.default_vat.id","<integer>")
CkJsonObject::ckUpdateString(json,"data.default_vat.description","<string>")
CkJsonObject::ckUpdateString(json,"data.default_vat.notes","<string>")
CkJsonObject::ckUpdateString(json,"data.default_vat.e_invoice","<boolean>")
CkJsonObject::ckUpdateString(json,"data.default_vat.ei_type","<string>")
CkJsonObject::ckUpdateString(json,"data.default_vat.ei_description","<string>")
CkJsonObject::ckUpdateBool(json,"data.default_vat.editable",1)
CkJsonObject::ckUpdateString(json,"data.default_vat.is_disabled","<boolean>")
CkJsonObject::ckUpdateString(json,"data.net_cost","<number>")
CkJsonObject::ckUpdateString(json,"data.measure","<string>")
CkJsonObject::ckUpdateString(json,"data.description","<string>")
CkJsonObject::ckUpdateString(json,"data.category","<string>")
CkJsonObject::ckUpdateString(json,"data.notes","<string>")
CkJsonObject::ckUpdateString(json,"data.in_stock","<boolean>")
CkJsonObject::ckUpdateString(json,"data.stock_initial","<number>")
CkJsonObject::ckUpdateString(json,"data.stock_current","<number>")
CkJsonObject::ckUpdateString(json,"data.average_cost","<number>")
CkJsonObject::ckUpdateString(json,"data.average_price","<number>")
CkJsonObject::ckUpdateString(json,"data.created_at","<string>")
CkJsonObject::ckUpdateString(json,"data.updated_at","<string>")
CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")
; Adds the "Authorization: Bearer <access_token>" header.
CkHttp::setCkAuthToken(http, "<access_token>")
CkHttp::ckSetRequestHeader(http,"Accept","application/json")
resp.i = CkHttp::ckPostJson3(http,"https://api-v2.fattureincloud.it/c/:company_id/products","application/json",json)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
ProcedureReturn
EndIf
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttpResponse::ckHeader(resp)
Debug "Failed."
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
CkHttpResponse::ckDispose(resp)
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "data": {
; "id": "<integer>",
; "name": "<string>",
; "code": "<string>",
; "net_price": "<number>",
; "gross_price": "<number>",
; "use_gross_price": "<boolean>",
; "default_vat": {
; "id": "<integer>",
; "value": "<number>",
; "description": "<string>",
; "notes": "<string>",
; "e_invoice": "<boolean>",
; "ei_type": "<string>",
; "ei_description": "<string>",
; "editable": "<boolean>",
; "is_disabled": "<boolean>"
; },
; "net_cost": "<number>",
; "measure": "<string>",
; "description": "<string>",
; "category": "<string>",
; "notes": "<string>",
; "in_stock": "<boolean>",
; "stock_initial": "<number>",
; "stock_current": "<number>",
; "average_cost": "<number>",
; "average_price": "<number>",
; "created_at": "<string>",
; "updated_at": "<string>"
; }
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Id.s = CkJsonObject::ckStringOf(jResp,"data.id")
Name.s = CkJsonObject::ckStringOf(jResp,"data.name")
Code.s = CkJsonObject::ckStringOf(jResp,"data.code")
Net_price.s = CkJsonObject::ckStringOf(jResp,"data.net_price")
Gross_price.s = CkJsonObject::ckStringOf(jResp,"data.gross_price")
Use_gross_price.s = CkJsonObject::ckStringOf(jResp,"data.use_gross_price")
Default_vatId.s = CkJsonObject::ckStringOf(jResp,"data.default_vat.id")
Value.s = CkJsonObject::ckStringOf(jResp,"data.default_vat.value")
Description.s = CkJsonObject::ckStringOf(jResp,"data.default_vat.description")
Notes.s = CkJsonObject::ckStringOf(jResp,"data.default_vat.notes")
E_invoice.s = CkJsonObject::ckStringOf(jResp,"data.default_vat.e_invoice")
Ei_type.s = CkJsonObject::ckStringOf(jResp,"data.default_vat.ei_type")
Ei_description.s = CkJsonObject::ckStringOf(jResp,"data.default_vat.ei_description")
Editable.s = CkJsonObject::ckStringOf(jResp,"data.default_vat.editable")
Is_disabled.s = CkJsonObject::ckStringOf(jResp,"data.default_vat.is_disabled")
Net_cost.s = CkJsonObject::ckStringOf(jResp,"data.net_cost")
Measure.s = CkJsonObject::ckStringOf(jResp,"data.measure")
dataDescription.s = CkJsonObject::ckStringOf(jResp,"data.description")
Category.s = CkJsonObject::ckStringOf(jResp,"data.category")
dataNotes.s = CkJsonObject::ckStringOf(jResp,"data.notes")
In_stock.s = CkJsonObject::ckStringOf(jResp,"data.in_stock")
Stock_initial.s = CkJsonObject::ckStringOf(jResp,"data.stock_initial")
Stock_current.s = CkJsonObject::ckStringOf(jResp,"data.stock_current")
Average_cost.s = CkJsonObject::ckStringOf(jResp,"data.average_cost")
Average_price.s = CkJsonObject::ckStringOf(jResp,"data.average_price")
Created_at.s = CkJsonObject::ckStringOf(jResp,"data.created_at")
Updated_at.s = CkJsonObject::ckStringOf(jResp,"data.updated_at")
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
Curl Command
curl -X POST
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
-H "Accept: application/json"
-d '{
"data": {
"name": "<string>",
"id": "<integer>",
"code": "<string>",
"net_price": "<number>",
"gross_price": "<number>",
"use_gross_price": "<boolean>",
"default_vat": {
"value": "<number>",
"id": "<integer>",
"description": "<string>",
"notes": "<string>",
"e_invoice": "<boolean>",
"ei_type": "<string>",
"ei_description": "<string>",
"editable": true,
"is_disabled": "<boolean>"
},
"net_cost": "<number>",
"measure": "<string>",
"description": "<string>",
"category": "<string>",
"notes": "<string>",
"in_stock": "<boolean>",
"stock_initial": "<number>",
"stock_current": "<number>",
"average_cost": "<number>",
"average_price": "<number>",
"created_at": "<string>",
"updated_at": "<string>"
}
}'
https://api-v2.fattureincloud.it/c/:company_id/products
Postman Collection Item JSON
{
"name": "Create Product",
"request": {
"auth": {
"type": "oauth2",
"oauth2": [
{
"key": "scope",
"value": "entity.clients:r entity.clients:a entity.suppliers:r entity.suppliers:a products:r products:a issued_documents.invoices:r issued_documents.credit_notes:r issued_documents.receipts:r issued_documents.orders:r issued_documents.quotes:r issued_documents.proformas:r issued_documents.delivery_notes:r issued_documents.work_reports:r issued_documents.supplier_orders:r issued_documents.self_invoices:r issued_documents.invoices:a issued_documents.credit_notes:a issued_documents.receipts:a issued_documents.orders:a issued_documents.quotes:a issued_documents.proformas:a issued_documents.delivery_notes:a issued_documents.work_reports:a issued_documents.supplier_orders:a issued_documents.self_invoices:a received_documents:r received_documents:a stock:r stock:a receipts:r receipts:a taxes:r taxes:a archive:r archive:a cashbook:r cashbook:a settings:r settings:a situation:r",
"type": "string"
},
{
"key": "redirect_uri",
"value": "https://api-v2.fattureincloud.it/oauth/token",
"type": "string"
},
{
"key": "accessTokenUrl",
"value": "https://api-v2.fattureincloud.it/oauth/token",
"type": "string"
},
{
"key": "authUrl",
"value": "https://api-v2.fattureincloud.it/oauth/authorize",
"type": "string"
},
{
"key": "grant_type",
"value": "authorization_code",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"name\": \"<string>\",\n \"id\": \"<integer>\",\n \"code\": \"<string>\",\n \"net_price\": \"<number>\",\n \"gross_price\": \"<number>\",\n \"use_gross_price\": \"<boolean>\",\n \"default_vat\": {\n \"value\": \"<number>\",\n \"id\": \"<integer>\",\n \"description\": \"<string>\",\n \"notes\": \"<string>\",\n \"e_invoice\": \"<boolean>\",\n \"ei_type\": \"<string>\",\n \"ei_description\": \"<string>\",\n \"editable\": true,\n \"is_disabled\": \"<boolean>\"\n },\n \"net_cost\": \"<number>\",\n \"measure\": \"<string>\",\n \"description\": \"<string>\",\n \"category\": \"<string>\",\n \"notes\": \"<string>\",\n \"in_stock\": \"<boolean>\",\n \"stock_initial\": \"<number>\",\n \"stock_current\": \"<number>\",\n \"average_cost\": \"<number>\",\n \"average_price\": \"<number>\",\n \"created_at\": \"<string>\",\n \"updated_at\": \"<string>\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/c/:company_id/products",
"host": [
"{{baseUrl}}"
],
"path": [
"c",
":company_id",
"products"
],
"variable": [
{
"key": "company_id",
"value": "<integer>"
}
]
},
"description": "Creates a new product."
},
"response": [
{
"name": "Example response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"name\": \"<string>\",\n \"id\": \"<integer>\",\n \"code\": \"<string>\",\n \"net_price\": \"<number>\",\n \"gross_price\": \"<number>\",\n \"use_gross_price\": \"<boolean>\",\n \"default_vat\": {\n \"value\": \"<number>\",\n \"id\": \"<integer>\",\n \"description\": \"<string>\",\n \"notes\": \"<string>\",\n \"e_invoice\": \"<boolean>\",\n \"ei_type\": \"<string>\",\n \"ei_description\": \"<string>\",\n \"editable\": true,\n \"is_disabled\": \"<boolean>\"\n },\n \"net_cost\": \"<number>\",\n \"measure\": \"<string>\",\n \"description\": \"<string>\",\n \"category\": \"<string>\",\n \"notes\": \"<string>\",\n \"in_stock\": \"<boolean>\",\n \"stock_initial\": \"<number>\",\n \"stock_current\": \"<number>\",\n \"average_cost\": \"<number>\",\n \"average_price\": \"<number>\",\n \"created_at\": \"<string>\",\n \"updated_at\": \"<string>\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/c/:company_id/products",
"host": [
"{{baseUrl}}"
],
"path": [
"c",
":company_id",
"products"
],
"variable": [
{
"key": "company_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"data\": {\n \"id\": \"<integer>\",\n \"name\": \"<string>\",\n \"code\": \"<string>\",\n \"net_price\": \"<number>\",\n \"gross_price\": \"<number>\",\n \"use_gross_price\": \"<boolean>\",\n \"default_vat\": {\n \"id\": \"<integer>\",\n \"value\": \"<number>\",\n \"description\": \"<string>\",\n \"notes\": \"<string>\",\n \"e_invoice\": \"<boolean>\",\n \"ei_type\": \"<string>\",\n \"ei_description\": \"<string>\",\n \"editable\": \"<boolean>\",\n \"is_disabled\": \"<boolean>\"\n },\n \"net_cost\": \"<number>\",\n \"measure\": \"<string>\",\n \"description\": \"<string>\",\n \"category\": \"<string>\",\n \"notes\": \"<string>\",\n \"in_stock\": \"<boolean>\",\n \"stock_initial\": \"<number>\",\n \"stock_current\": \"<number>\",\n \"average_cost\": \"<number>\",\n \"average_price\": \"<number>\",\n \"created_at\": \"<string>\",\n \"updated_at\": \"<string>\"\n }\n}"
}
]
}
