Chilkat Online Tools

Swift3 / Fatture in Cloud API v2 - API Reference / Modify Product

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

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

    let json = CkoJsonObject()!
    json.update("data.name", value: "<string>")
    json.update("data.id", value: "<integer>")
    json.update("data.code", value: "<string>")
    json.update("data.net_price", value: "<number>")
    json.update("data.gross_price", value: "<number>")
    json.update("data.use_gross_price", value: "<boolean>")
    json.update("data.default_vat.value", value: "<number>")
    json.update("data.default_vat.id", value: "<integer>")
    json.update("data.default_vat.description", value: "<string>")
    json.update("data.default_vat.notes", value: "<string>")
    json.update("data.default_vat.e_invoice", value: "<boolean>")
    json.update("data.default_vat.ei_type", value: "<string>")
    json.update("data.default_vat.ei_description", value: "<string>")
    json.updateBool("data.default_vat.editable", value: true)
    json.update("data.default_vat.is_disabled", value: "<boolean>")
    json.update("data.net_cost", value: "<number>")
    json.update("data.measure", value: "<string>")
    json.update("data.description", value: "<string>")
    json.update("data.category", value: "<string>")
    json.update("data.notes", value: "<string>")
    json.update("data.in_stock", value: "<boolean>")
    json.update("data.stock_initial", value: "<number>")
    json.update("data.stock_current", value: "<number>")
    json.update("data.average_cost", value: "<number>")
    json.update("data.average_price", value: "<number>")
    json.update("data.created_at", value: "<string>")
    json.update("data.updated_at", value: "<string>")

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

    let sbRequestBody = CkoStringBuilder()!
    json.emitSb(sbRequestBody)

    var resp: CkoHttpResponse? = http.pTextSb("PUT", url: "https://api-v2.fattureincloud.it/c/:company_id/products/:product_id", textData: sbRequestBody, charset: "utf-8", contentType: "application/json", md5: false, gzip: false)
    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)

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

    var Id: String? = jResp.string(of: "data.id")
    var Name: String? = jResp.string(of: "data.name")
    var Code: String? = jResp.string(of: "data.code")
    var Net_price: String? = jResp.string(of: "data.net_price")
    var Gross_price: String? = jResp.string(of: "data.gross_price")
    var Use_gross_price: String? = jResp.string(of: "data.use_gross_price")
    var Default_vatId: String? = jResp.string(of: "data.default_vat.id")
    var Value: String? = jResp.string(of: "data.default_vat.value")
    var Description: String? = jResp.string(of: "data.default_vat.description")
    var Notes: String? = jResp.string(of: "data.default_vat.notes")
    var E_invoice: String? = jResp.string(of: "data.default_vat.e_invoice")
    var Ei_type: String? = jResp.string(of: "data.default_vat.ei_type")
    var Ei_description: String? = jResp.string(of: "data.default_vat.ei_description")
    var Editable: String? = jResp.string(of: "data.default_vat.editable")
    var Is_disabled: String? = jResp.string(of: "data.default_vat.is_disabled")
    var Net_cost: String? = jResp.string(of: "data.net_cost")
    var Measure: String? = jResp.string(of: "data.measure")
    var dataDescription: String? = jResp.string(of: "data.description")
    var Category: String? = jResp.string(of: "data.category")
    var dataNotes: String? = jResp.string(of: "data.notes")
    var In_stock: String? = jResp.string(of: "data.in_stock")
    var Stock_initial: String? = jResp.string(of: "data.stock_initial")
    var Stock_current: String? = jResp.string(of: "data.stock_current")
    var Average_cost: String? = jResp.string(of: "data.average_cost")
    var Average_price: String? = jResp.string(of: "data.average_price")
    var Created_at: String? = jResp.string(of: "data.created_at")
    var Updated_at: String? = jResp.string(of: "data.updated_at")

}

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