Back to Collection Items
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loHttp = createobject("CkHttp")
loQueryParams = createobject("CkJsonObject")
loQueryParams.UpdateString("fields","<string>")
loQueryParams.UpdateString("fieldset","basic")
loQueryParams.UpdateString("sort","<string>")
loQueryParams.UpdateInt("page",1)
loQueryParams.UpdateInt("per_page",5)
loQueryParams.UpdateString("q","<string>")
// Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"
loHttp.SetRequestHeader("Accept","application/json")
loResp = loHttp.QuickRequestParams("GET","https://api-v2.fattureincloud.it/c/:company_id/products",loQueryParams)
if (loHttp.LastMethodSuccess = .F.) then
? loHttp.LastErrorText
release loHttp
release loQueryParams
return
endif
loSbResponseBody = createobject("CkStringBuilder")
loResp.GetBodySb(loSbResponseBody)
loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
? "Response Header:"
? loResp.Header
? "Failed."
release loResp
release loHttp
release loQueryParams
release loSbResponseBody
release loJResp
return
endif
release loResp
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "current_page": "<integer>",
// "first_page_url": "<uri>",
// "from": "<integer>",
// "last_page": "<integer>",
// "last_page_url": "<uri>",
// "next_page_url": "<uri>",
// "path": "<uri>",
// "per_page": "<integer>",
// "prev_page_url": "<uri>",
// "to": "<integer>",
// "total": "<integer>",
// "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>"
// },
// {
// "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
lcCurrent_page = loJResp.StringOf("current_page")
lcFirst_page_url = loJResp.StringOf("first_page_url")
lcFrom = loJResp.StringOf("from")
lcLast_page = loJResp.StringOf("last_page")
lcLast_page_url = loJResp.StringOf("last_page_url")
lcNext_page_url = loJResp.StringOf("next_page_url")
lcPath = loJResp.StringOf("path")
lcPer_page = loJResp.StringOf("per_page")
lcPrev_page_url = loJResp.StringOf("prev_page_url")
lcV_to = loJResp.StringOf("to")
lcTotal = loJResp.StringOf("total")
i = 0
lnCount_i = loJResp.SizeOfArray("data")
do while i < lnCount_i
loJResp.I = i
lcId = loJResp.StringOf("data[i].id")
lcName = loJResp.StringOf("data[i].name")
lcCode = loJResp.StringOf("data[i].code")
lcNet_price = loJResp.StringOf("data[i].net_price")
lcGross_price = loJResp.StringOf("data[i].gross_price")
lcUse_gross_price = loJResp.StringOf("data[i].use_gross_price")
lcId = loJResp.StringOf("data[i].default_vat.id")
lcValue = loJResp.StringOf("data[i].default_vat.value")
lcDescription = loJResp.StringOf("data[i].default_vat.description")
lcNotes = loJResp.StringOf("data[i].default_vat.notes")
lcE_invoice = loJResp.StringOf("data[i].default_vat.e_invoice")
lcEi_type = loJResp.StringOf("data[i].default_vat.ei_type")
lcEi_description = loJResp.StringOf("data[i].default_vat.ei_description")
lcEditable = loJResp.StringOf("data[i].default_vat.editable")
lcIs_disabled = loJResp.StringOf("data[i].default_vat.is_disabled")
lcNet_cost = loJResp.StringOf("data[i].net_cost")
lcMeasure = loJResp.StringOf("data[i].measure")
lcDescription = loJResp.StringOf("data[i].description")
lcCategory = loJResp.StringOf("data[i].category")
lcNotes = loJResp.StringOf("data[i].notes")
lcIn_stock = loJResp.StringOf("data[i].in_stock")
lcStock_initial = loJResp.StringOf("data[i].stock_initial")
lcStock_current = loJResp.StringOf("data[i].stock_current")
lcAverage_cost = loJResp.StringOf("data[i].average_cost")
lcAverage_price = loJResp.StringOf("data[i].average_price")
lcCreated_at = loJResp.StringOf("data[i].created_at")
lcUpdated_at = loJResp.StringOf("data[i].updated_at")
i = i + 1
enddo
release loHttp
release loQueryParams
release loSbResponseBody
release loJResp
Curl Command
curl -G -d "fields=%3Cstring%3E"
-d "fieldset=basic"
-d "sort=%3Cstring%3E"
-d "page=1"
-d "per_page=5"
-d "q=%3Cstring%3E"
-H "Authorization: Bearer <access_token>"
-H "Accept: application/json"
https://api-v2.fattureincloud.it/c/:company_id/products
Postman Collection Item JSON
{
"name": "List Products",
"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": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/c/:company_id/products?fields=<string>&fieldset=basic&sort=<string>&page=1&per_page=5&q=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"c",
":company_id",
"products"
],
"query": [
{
"key": "fields",
"value": "<string>",
"description": "List of comma-separated fields."
},
{
"key": "fieldset",
"value": "basic",
"description": "Name of the fieldset."
},
{
"key": "sort",
"value": "<string>",
"description": "List of comma-separated fields for result sorting (minus for desc sorting)."
},
{
"key": "page",
"value": "1",
"description": "The page to retrieve."
},
{
"key": "per_page",
"value": "5",
"description": "The size of the page."
},
{
"key": "q",
"value": "<string>",
"description": "Query for filtering the results."
}
],
"variable": [
{
"key": "company_id",
"value": "<integer>"
}
]
},
"description": "Lists the products."
},
"response": [
{
"name": "Products List.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/c/:company_id/products?fields=<string>&fieldset=basic&sort=<string>&page=1&per_page=5&q=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"c",
":company_id",
"products"
],
"query": [
{
"key": "fields",
"value": "<string>",
"description": "List of comma-separated fields."
},
{
"key": "fieldset",
"value": "basic",
"description": "Name of the fieldset."
},
{
"key": "sort",
"value": "<string>",
"description": "List of comma-separated fields for result sorting (minus for desc sorting)."
},
{
"key": "page",
"value": "1",
"description": "The page to retrieve."
},
{
"key": "per_page",
"value": "5",
"description": "The size of the page."
},
{
"key": "q",
"value": "<string>",
"description": "Query for filtering the results."
}
],
"variable": [
{
"key": "company_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"current_page\": \"<integer>\",\n \"first_page_url\": \"<uri>\",\n \"from\": \"<integer>\",\n \"last_page\": \"<integer>\",\n \"last_page_url\": \"<uri>\",\n \"next_page_url\": \"<uri>\",\n \"path\": \"<uri>\",\n \"per_page\": \"<integer>\",\n \"prev_page_url\": \"<uri>\",\n \"to\": \"<integer>\",\n \"total\": \"<integer>\",\n \"data\": [\n {\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 {\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 ]\n}"
},
{
"name": "Unauthorized",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/c/:company_id/products?fields=<string>&fieldset=basic&sort=<string>&page=1&per_page=5&q=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"c",
":company_id",
"products"
],
"query": [
{
"key": "fields",
"value": "<string>",
"description": "List of comma-separated fields."
},
{
"key": "fieldset",
"value": "basic",
"description": "Name of the fieldset."
},
{
"key": "sort",
"value": "<string>",
"description": "List of comma-separated fields for result sorting (minus for desc sorting)."
},
{
"key": "page",
"value": "1",
"description": "The page to retrieve."
},
{
"key": "per_page",
"value": "5",
"description": "The size of the page."
},
{
"key": "q",
"value": "<string>",
"description": "Query for filtering the results."
}
],
"variable": [
{
"key": "company_id"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "text",
"header": [
],
"cookie": [
],
"body": ""
}
]
}
