Back to Collection Items
Use ChilkatAx-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Handle hoJson
Variant vSbRequestBody
Handle hoSbRequestBody
Variant vResp
Handle hoResp
Variant vSbResponseBody
Handle hoSbResponseBody
Handle hoJResp
Integer iRespStatusCode
String sId
String sName
String sCode
String sNet_price
String sGross_price
String sUse_gross_price
String sDefault_vatId
String sValue
String sDescription
String sNotes
String sE_invoice
String sEi_type
String sEi_description
String sEditable
String sIs_disabled
String sNet_cost
String sMeasure
String sDataDescription
String sCategory
String sDataNotes
String sIn_stock
String sStock_initial
String sStock_current
String sAverage_cost
String sAverage_price
String sCreated_at
String sUpdated_at
String sTemp1
Boolean bTemp1
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
// 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>"
// }
// }
Get Create (RefClass(cComChilkatJsonObject)) To hoJson
If (Not(IsComObjectCreated(hoJson))) Begin
Send CreateComObject of hoJson
End
Get ComUpdateString Of hoJson "data.name" "<string>" To iSuccess
Get ComUpdateString Of hoJson "data.id" "<integer>" To iSuccess
Get ComUpdateString Of hoJson "data.code" "<string>" To iSuccess
Get ComUpdateString Of hoJson "data.net_price" "<number>" To iSuccess
Get ComUpdateString Of hoJson "data.gross_price" "<number>" To iSuccess
Get ComUpdateString Of hoJson "data.use_gross_price" "<boolean>" To iSuccess
Get ComUpdateString Of hoJson "data.default_vat.value" "<number>" To iSuccess
Get ComUpdateString Of hoJson "data.default_vat.id" "<integer>" To iSuccess
Get ComUpdateString Of hoJson "data.default_vat.description" "<string>" To iSuccess
Get ComUpdateString Of hoJson "data.default_vat.notes" "<string>" To iSuccess
Get ComUpdateString Of hoJson "data.default_vat.e_invoice" "<boolean>" To iSuccess
Get ComUpdateString Of hoJson "data.default_vat.ei_type" "<string>" To iSuccess
Get ComUpdateString Of hoJson "data.default_vat.ei_description" "<string>" To iSuccess
Get ComUpdateBool Of hoJson "data.default_vat.editable" True To iSuccess
Get ComUpdateString Of hoJson "data.default_vat.is_disabled" "<boolean>" To iSuccess
Get ComUpdateString Of hoJson "data.net_cost" "<number>" To iSuccess
Get ComUpdateString Of hoJson "data.measure" "<string>" To iSuccess
Get ComUpdateString Of hoJson "data.description" "<string>" To iSuccess
Get ComUpdateString Of hoJson "data.category" "<string>" To iSuccess
Get ComUpdateString Of hoJson "data.notes" "<string>" To iSuccess
Get ComUpdateString Of hoJson "data.in_stock" "<boolean>" To iSuccess
Get ComUpdateString Of hoJson "data.stock_initial" "<number>" To iSuccess
Get ComUpdateString Of hoJson "data.stock_current" "<number>" To iSuccess
Get ComUpdateString Of hoJson "data.average_cost" "<number>" To iSuccess
Get ComUpdateString Of hoJson "data.average_price" "<number>" To iSuccess
Get ComUpdateString Of hoJson "data.created_at" "<string>" To iSuccess
Get ComUpdateString Of hoJson "data.updated_at" "<string>" To iSuccess
Send ComSetRequestHeader To hoHttp "Content-Type" "application/json"
// Adds the "Authorization: Bearer <access_token>" header.
Set ComAuthToken Of hoHttp To "<access_token>"
Send ComSetRequestHeader To hoHttp "Accept" "application/json"
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbRequestBody
If (Not(IsComObjectCreated(hoSbRequestBody))) Begin
Send CreateComObject of hoSbRequestBody
End
Get pvComObject of hoSbRequestBody to vSbRequestBody
Get ComEmitSb Of hoJson vSbRequestBody To iSuccess
Get pvComObject of hoSbRequestBody to vSbRequestBody
Get ComPTextSb Of hoHttp "PUT" "https://api-v2.fattureincloud.it/c/:company_id/products/:product_id" vSbRequestBody "utf-8" "application/json" False False To vResp
If (IsComObject(vResp)) Begin
Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
Set pvComObject Of hoResp To vResp
End
Get ComLastMethodSuccess Of hoHttp To bTemp1
If (bTemp1 = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
Send CreateComObject of hoSbResponseBody
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComGetBodySb Of hoResp vSbResponseBody To iSuccess
Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
If (Not(IsComObjectCreated(hoJResp))) Begin
Send CreateComObject of hoJResp
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
Set ComEmitCompact Of hoJResp To False
Showln "Response Body:"
Get ComEmit Of hoJResp To sTemp1
Showln sTemp1
Get ComStatusCode Of hoResp To iRespStatusCode
Showln "Response Status Code = " iRespStatusCode
If (iRespStatusCode >= 400) Begin
Showln "Response Header:"
Get ComHeader Of hoResp To sTemp1
Showln sTemp1
Showln "Failed."
Send Destroy of hoResp
Procedure_Return
End
Send Destroy of hoResp
// 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
Get ComStringOf Of hoJResp "data.id" To sId
Get ComStringOf Of hoJResp "data.name" To sName
Get ComStringOf Of hoJResp "data.code" To sCode
Get ComStringOf Of hoJResp "data.net_price" To sNet_price
Get ComStringOf Of hoJResp "data.gross_price" To sGross_price
Get ComStringOf Of hoJResp "data.use_gross_price" To sUse_gross_price
Get ComStringOf Of hoJResp "data.default_vat.id" To sDefault_vatId
Get ComStringOf Of hoJResp "data.default_vat.value" To sValue
Get ComStringOf Of hoJResp "data.default_vat.description" To sDescription
Get ComStringOf Of hoJResp "data.default_vat.notes" To sNotes
Get ComStringOf Of hoJResp "data.default_vat.e_invoice" To sE_invoice
Get ComStringOf Of hoJResp "data.default_vat.ei_type" To sEi_type
Get ComStringOf Of hoJResp "data.default_vat.ei_description" To sEi_description
Get ComStringOf Of hoJResp "data.default_vat.editable" To sEditable
Get ComStringOf Of hoJResp "data.default_vat.is_disabled" To sIs_disabled
Get ComStringOf Of hoJResp "data.net_cost" To sNet_cost
Get ComStringOf Of hoJResp "data.measure" To sMeasure
Get ComStringOf Of hoJResp "data.description" To sDataDescription
Get ComStringOf Of hoJResp "data.category" To sCategory
Get ComStringOf Of hoJResp "data.notes" To sDataNotes
Get ComStringOf Of hoJResp "data.in_stock" To sIn_stock
Get ComStringOf Of hoJResp "data.stock_initial" To sStock_initial
Get ComStringOf Of hoJResp "data.stock_current" To sStock_current
Get ComStringOf Of hoJResp "data.average_cost" To sAverage_cost
Get ComStringOf Of hoJResp "data.average_price" To sAverage_price
Get ComStringOf Of hoJResp "data.created_at" To sCreated_at
Get ComStringOf Of hoJResp "data.updated_at" To sUpdated_at
End_Procedure
Curl Command
curl -X PUT
-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/:product_id
Postman Collection Item JSON
{
"name": "Modify 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": "PUT",
"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/:product_id",
"host": [
"{{baseUrl}}"
],
"path": [
"c",
":company_id",
"products",
":product_id"
],
"variable": [
{
"key": "company_id",
"value": "<integer>"
},
{
"key": "product_id",
"value": "<integer>"
}
]
},
"description": "Modifies the specified product."
},
"response": [
{
"name": "Example response",
"originalRequest": {
"method": "PUT",
"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/:product_id",
"host": [
"{{baseUrl}}"
],
"path": [
"c",
":company_id",
"products",
":product_id"
],
"variable": [
{
"key": "company_id"
},
{
"key": "product_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}"
},
{
"name": "Unauthorized",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"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/:product_id",
"host": [
"{{baseUrl}}"
],
"path": [
"c",
":company_id",
"products",
":product_id"
],
"variable": [
{
"key": "company_id"
},
{
"key": "product_id"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "text",
"header": [
],
"cookie": [
],
"body": ""
},
{
"name": "Not Found",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"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/:product_id",
"host": [
"{{baseUrl}}"
],
"path": [
"c",
":company_id",
"products",
":product_id"
],
"variable": [
{
"key": "company_id"
},
{
"key": "product_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "text",
"header": [
],
"cookie": [
],
"body": ""
}
]
}
