Chilkat Online Tools

Swift3 / Fatture in Cloud API v2 - API Reference / List Products

Back to Collection Items

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

    let http = CkoHttp()!
    var success: Bool

    let queryParams = CkoJsonObject()!
    queryParams.update("fields", value: "<string>")
    queryParams.update("fieldset", value: "basic")
    queryParams.update("sort", value: "<string>")
    queryParams.updateInt("page", value: 1)
    queryParams.updateInt("per_page", value: 5)
    queryParams.update("q", value: "<string>")

    // Adds the "Authorization: Bearer <access_token>" header.
    http.authToken = "<access_token>"
    http.setRequestHeader("Accept", value: "application/json")

    var resp: CkoHttpResponse? = http.quickRequestParams("GET", url: "https://api-v2.fattureincloud.it/c/:company_id/products", json: queryParams)
    if http.lastMethodSuccess == false {
        print("\(http.lastErrorText!)")
        return
    }

    let sbResponseBody = CkoStringBuilder()!
    resp!.getBodySb(sbResponseBody)

    let jResp = CkoJsonObject()!
    jResp.loadSb(sbResponseBody)
    jResp.emitCompact = false

    print("Response Body:")
    print("\(jResp.emit()!)")

    var respStatusCode: Int = resp!.statusCode.intValue
    print("Response Status Code = \(respStatusCode)")
    if respStatusCode >= 400 {
        print("Response Header:")
        print("\(resp!.header!)")
        print("Failed.")
        resp = nil
        return
    }

    resp = nil

    // 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

    var id: String?
    var name: String?
    var code: String?
    var net_price: String?
    var gross_price: String?
    var use_gross_price: String?
    var Id: String?
    var Value: String?
    var Description: String?
    var Notes: String?
    var E_invoice: String?
    var Ei_type: String?
    var Ei_description: String?
    var Editable: String?
    var Is_disabled: String?
    var net_cost: String?
    var measure: String?
    var description: String?
    var category: String?
    var notes: String?
    var in_stock: String?
    var stock_initial: String?
    var stock_current: String?
    var average_cost: String?
    var average_price: String?
    var created_at: String?
    var updated_at: String?

    var current_page: String? = jResp.string(of: "current_page")
    var first_page_url: String? = jResp.string(of: "first_page_url")
    var from: String? = jResp.string(of: "from")
    var last_page: String? = jResp.string(of: "last_page")
    var last_page_url: String? = jResp.string(of: "last_page_url")
    var next_page_url: String? = jResp.string(of: "next_page_url")
    var path: String? = jResp.string(of: "path")
    var per_page: String? = jResp.string(of: "per_page")
    var prev_page_url: String? = jResp.string(of: "prev_page_url")
    var v_to: String? = jResp.string(of: "to")
    var total: String? = jResp.string(of: "total")
    var i: Int = 0
    var count_i: Int = jResp.size(ofArray: "data").intValue
    while i < count_i {
        jResp.i = i
        id = jResp.string(of: "data[i].id")
        name = jResp.string(of: "data[i].name")
        code = jResp.string(of: "data[i].code")
        net_price = jResp.string(of: "data[i].net_price")
        gross_price = jResp.string(of: "data[i].gross_price")
        use_gross_price = jResp.string(of: "data[i].use_gross_price")
        Id = jResp.string(of: "data[i].default_vat.id")
        Value = jResp.string(of: "data[i].default_vat.value")
        Description = jResp.string(of: "data[i].default_vat.description")
        Notes = jResp.string(of: "data[i].default_vat.notes")
        E_invoice = jResp.string(of: "data[i].default_vat.e_invoice")
        Ei_type = jResp.string(of: "data[i].default_vat.ei_type")
        Ei_description = jResp.string(of: "data[i].default_vat.ei_description")
        Editable = jResp.string(of: "data[i].default_vat.editable")
        Is_disabled = jResp.string(of: "data[i].default_vat.is_disabled")
        net_cost = jResp.string(of: "data[i].net_cost")
        measure = jResp.string(of: "data[i].measure")
        description = jResp.string(of: "data[i].description")
        category = jResp.string(of: "data[i].category")
        notes = jResp.string(of: "data[i].notes")
        in_stock = jResp.string(of: "data[i].in_stock")
        stock_initial = jResp.string(of: "data[i].stock_initial")
        stock_current = jResp.string(of: "data[i].stock_current")
        average_cost = jResp.string(of: "data[i].average_cost")
        average_price = jResp.string(of: "data[i].average_price")
        created_at = jResp.string(of: "data[i].created_at")
        updated_at = jResp.string(of: "data[i].updated_at")
        i = i + 1
    }


}

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": ""
    }
  ]
}