Chilkat Online Tools

PowerBuilder / Fatture in Cloud API v2 - API Reference / Get Product

Back to Collection Items

integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_QueryParams
oleobject loo_Resp
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
string ls_Id
string ls_Name
string ls_Code
string ls_Net_price
string ls_Gross_price
string ls_Use_gross_price
string ls_Default_vatId
string ls_Value
string ls_Description
string ls_Notes
string ls_E_invoice
string ls_Ei_type
string ls_Ei_description
string ls_Editable
string ls_Is_disabled
string ls_Net_cost
string ls_Measure
string ls_DataDescription
string ls_Category
string ls_DataNotes
string ls_In_stock
string ls_Stock_initial
string ls_Stock_current
string ls_Average_cost
string ls_Average_price
string ls_Created_at
string ls_Updated_at

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

loo_Http = create oleobject
// Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
    destroy loo_Http
    MessageBox("Error","Connecting to COM object failed")
    return
end if

loo_QueryParams = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_QueryParams.ConnectToNewObject("Chilkat.JsonObject")

loo_QueryParams.UpdateString("fields","<string>")
loo_QueryParams.UpdateString("fieldset","basic")

// Adds the "Authorization: Bearer <access_token>" header.
loo_Http.AuthToken = "<access_token>"
loo_Http.SetRequestHeader("Accept","application/json")

loo_Resp = loo_Http.QuickRequestParams("GET","https://api-v2.fattureincloud.it/c/:company_id/products/:product_id",loo_QueryParams)
if loo_Http.LastMethodSuccess = 0 then
    Write-Debug loo_Http.LastErrorText
    destroy loo_Http
    destroy loo_QueryParams
    return
end if

loo_SbResponseBody = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat.StringBuilder")

loo_Resp.GetBodySb(loo_SbResponseBody)

loo_JResp = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_JResp.ConnectToNewObject("Chilkat.JsonObject")

loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0

Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()

li_RespStatusCode = loo_Resp.StatusCode
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
    Write-Debug "Response Header:"
    Write-Debug loo_Resp.Header
    Write-Debug "Failed."
    destroy loo_Resp
    destroy loo_Http
    destroy loo_QueryParams
    destroy loo_SbResponseBody
    destroy loo_JResp
    return
end if

destroy loo_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

ls_Id = loo_JResp.StringOf("data.id")
ls_Name = loo_JResp.StringOf("data.name")
ls_Code = loo_JResp.StringOf("data.code")
ls_Net_price = loo_JResp.StringOf("data.net_price")
ls_Gross_price = loo_JResp.StringOf("data.gross_price")
ls_Use_gross_price = loo_JResp.StringOf("data.use_gross_price")
ls_Default_vatId = loo_JResp.StringOf("data.default_vat.id")
ls_Value = loo_JResp.StringOf("data.default_vat.value")
ls_Description = loo_JResp.StringOf("data.default_vat.description")
ls_Notes = loo_JResp.StringOf("data.default_vat.notes")
ls_E_invoice = loo_JResp.StringOf("data.default_vat.e_invoice")
ls_Ei_type = loo_JResp.StringOf("data.default_vat.ei_type")
ls_Ei_description = loo_JResp.StringOf("data.default_vat.ei_description")
ls_Editable = loo_JResp.StringOf("data.default_vat.editable")
ls_Is_disabled = loo_JResp.StringOf("data.default_vat.is_disabled")
ls_Net_cost = loo_JResp.StringOf("data.net_cost")
ls_Measure = loo_JResp.StringOf("data.measure")
ls_DataDescription = loo_JResp.StringOf("data.description")
ls_Category = loo_JResp.StringOf("data.category")
ls_DataNotes = loo_JResp.StringOf("data.notes")
ls_In_stock = loo_JResp.StringOf("data.in_stock")
ls_Stock_initial = loo_JResp.StringOf("data.stock_initial")
ls_Stock_current = loo_JResp.StringOf("data.stock_current")
ls_Average_cost = loo_JResp.StringOf("data.average_cost")
ls_Average_price = loo_JResp.StringOf("data.average_price")
ls_Created_at = loo_JResp.StringOf("data.created_at")
ls_Updated_at = loo_JResp.StringOf("data.updated_at")


destroy loo_Http
destroy loo_QueryParams
destroy loo_SbResponseBody
destroy loo_JResp

Curl Command

curl -G -d "fields=%3Cstring%3E"
	-d "fieldset=basic"
	-H "Authorization: Bearer <access_token>"
	-H "Accept: application/json"
https://api-v2.fattureincloud.it/c/:company_id/products/:product_id

Postman Collection Item JSON

{
  "name": "Get 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": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/c/:company_id/products/:product_id?fields=<string>&fieldset=basic",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "c",
        ":company_id",
        "products",
        ":product_id"
      ],
      "query": [
        {
          "key": "fields",
          "value": "<string>",
          "description": "List of comma-separated fields."
        },
        {
          "key": "fieldset",
          "value": "basic",
          "description": "Name of the fieldset."
        }
      ],
      "variable": [
        {
          "key": "company_id",
          "value": "<integer>"
        },
        {
          "key": "product_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "Gets the specified product."
  },
  "response": [
    {
      "name": "Example response",
      "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/:product_id?fields=<string>&fieldset=basic",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "c",
            ":company_id",
            "products",
            ":product_id"
          ],
          "query": [
            {
              "key": "fields",
              "value": "<string>",
              "description": "List of comma-separated fields."
            },
            {
              "key": "fieldset",
              "value": "basic",
              "description": "Name of the fieldset."
            }
          ],
          "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": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/c/:company_id/products/:product_id?fields=<string>&fieldset=basic",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "c",
            ":company_id",
            "products",
            ":product_id"
          ],
          "query": [
            {
              "key": "fields",
              "value": "<string>",
              "description": "List of comma-separated fields."
            },
            {
              "key": "fieldset",
              "value": "basic",
              "description": "Name of the fieldset."
            }
          ],
          "variable": [
            {
              "key": "company_id"
            },
            {
              "key": "product_id"
            }
          ]
        }
      },
      "status": "Unauthorized",
      "code": 401,
      "_postman_previewlanguage": "text",
      "header": [
      ],
      "cookie": [
      ],
      "body": ""
    },
    {
      "name": "Not Found",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/c/:company_id/products/:product_id?fields=<string>&fieldset=basic",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "c",
            ":company_id",
            "products",
            ":product_id"
          ],
          "query": [
            {
              "key": "fields",
              "value": "<string>",
              "description": "List of comma-separated fields."
            },
            {
              "key": "fieldset",
              "value": "basic",
              "description": "Name of the fieldset."
            }
          ],
          "variable": [
            {
              "key": "company_id"
            },
            {
              "key": "product_id"
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "text",
      "header": [
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}