Chilkat Online Tools

phpAx / Fatture in Cloud API v2 - API Reference / Create Product

Back to Collection Items

<?php

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

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.Http')
$http = new COM("Chilkat.Http");

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

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$json = new COM("Chilkat.JsonObject");
$json->UpdateString('data.name','<string>');
$json->UpdateString('data.id','<integer>');
$json->UpdateString('data.code','<string>');
$json->UpdateString('data.net_price','<number>');
$json->UpdateString('data.gross_price','<number>');
$json->UpdateString('data.use_gross_price','<boolean>');
$json->UpdateString('data.default_vat.value','<number>');
$json->UpdateString('data.default_vat.id','<integer>');
$json->UpdateString('data.default_vat.description','<string>');
$json->UpdateString('data.default_vat.notes','<string>');
$json->UpdateString('data.default_vat.e_invoice','<boolean>');
$json->UpdateString('data.default_vat.ei_type','<string>');
$json->UpdateString('data.default_vat.ei_description','<string>');
$json->UpdateBool('data.default_vat.editable',1);
$json->UpdateString('data.default_vat.is_disabled','<boolean>');
$json->UpdateString('data.net_cost','<number>');
$json->UpdateString('data.measure','<string>');
$json->UpdateString('data.description','<string>');
$json->UpdateString('data.category','<string>');
$json->UpdateString('data.notes','<string>');
$json->UpdateString('data.in_stock','<boolean>');
$json->UpdateString('data.stock_initial','<number>');
$json->UpdateString('data.stock_current','<number>');
$json->UpdateString('data.average_cost','<number>');
$json->UpdateString('data.average_price','<number>');
$json->UpdateString('data.created_at','<string>');
$json->UpdateString('data.updated_at','<string>');

$http->SetRequestHeader('Content-Type','application/json');
// Adds the "Authorization: Bearer <access_token>" header.
$http->AuthToken = '<access_token>';
$http->SetRequestHeader('Accept','application/json');

// resp is a Chilkat.HttpResponse
$resp = $http->PostJson3('https://api-v2.fattureincloud.it/c/:company_id/products','application/json',$json);
if ($http->LastMethodSuccess == 0) {
    print $http->LastErrorText . "\n";
    exit;
}

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.StringBuilder')
$sbResponseBody = new COM("Chilkat.StringBuilder");
$resp->GetBodySb($sbResponseBody);

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$jResp = new COM("Chilkat.JsonObject");
$jResp->LoadSb($sbResponseBody);
$jResp->EmitCompact = 0;

print 'Response Body:' . "\n";
print $jResp->emit() . "\n";

$respStatusCode = $resp->StatusCode;
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
    print 'Response Header:' . "\n";
    print $resp->Header . "\n";
    print 'Failed.' . "\n";

    exit;
}

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

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

?>

Curl Command

curl -X POST
	-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

Postman Collection Item JSON

{
  "name": "Create 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": "POST",
    "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",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "c",
        ":company_id",
        "products"
      ],
      "variable": [
        {
          "key": "company_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "Creates a new product."
  },
  "response": [
    {
      "name": "Example response",
      "originalRequest": {
        "method": "POST",
        "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",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "c",
            ":company_id",
            "products"
          ],
          "variable": [
            {
              "key": "company_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}"
    }
  ]
}