Permissions needed: employment at the clinic in clinic_id.
Creates a product in the clinic's catalog. A tax rate is required: send tax_rate_ids (see the tax rates list), or the deprecated vat percentage.
The product's unit names in order, unit first. Usually a list; can arrive as an object keyed \"0\", \"1\".
", "complexType": "anyOf", "complexItems": [], "schema": [] }, { "name": "sub_unit", "kind": "optional", "type": "string", "description": "", "example": "tablets" }, { "name": "recommended_unit_price", "kind": "optional", "type": "number", "description": "Represent the main unit price with vat, is equal to price_with_vat
", "example": 11.853 }, { "name": "recommended_subunit_price", "kind": "optional", "type": "number", "description": "Represent the subunit price with vat, is equal to price_with_vat
", "example": 1.6932857142857143 }, { "name": "price_with_vat", "kind": "optional", "type": "numberDecimal, returned as a string (\"0.000\"). Create and update responses echo the value as it was sent.
", "complexType": "anyOf", "complexItems": [], "schema": [] }, { "name": "dispensing_fee_includes_tax", "kind": "optional", "type": "boolean", "description": "The stored fixed_fee includes tax when this is true. When it is false, the fee is stored net.
Deprecated. Summed percentage of tax_rates. Use tax_rates instead.
When the total price of the line item is less than this value, the prices will change with this value
", "complexType": "anyOf", "complexItems": [], "schema": [] }, { "name": "minimum_price_includes_tax", "kind": "optional", "type": "boolean", "description": "The basis minimum_price is stored in. True means the value already carries tax, false means it is net.
", "example": false }, { "name": "minimum_price_with_tax", "kind": "optional", "type": "numberminimum_price expressed gross, whichever basis it is stored in
", "example": 20.3, "format": "float" }, { "name": "minimum_price_without_tax", "kind": "optional", "type": "numberminimum_price expressed net, whichever basis it is stored in
", "example": 16.92, "format": "float" }, { "name": "price_threshold", "kind": "optional", "type": "object", "description": "These thresholds are used to in order to change the price (unit or subunit) of the product based on the quantity that is sold.
", "example": "", "schema": [ { "name": "range", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "start", "kind": "optional", "type": "numeric1 - unit, 0 - sub_unit
" } ] }, { "name": "task_templates", "kind": "optional", "type": "array", "nullable": true, "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "id", "kind": "optional", "type": "integer", "description": "" }, { "name": "name", "kind": "optional", "type": "string", "description": "" } ] }, { "name": "external_products", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "id", "kind": "optional", "type": "integer", "description": "", "example": 123 }, { "name": "provider", "kind": "optional", "type": "object", "description": "", "modelRef": "#/paths/~1api~1v1~1products/get/parameters/11/schema", "customType": "schema", "schema": [] }, { "name": "external_id", "kind": "optional", "type": "string", "description": "" }, { "name": "name", "kind": "optional", "type": "string", "description": "" }, { "name": "producer", "kind": "optional", "type": "string", "description": "" }, { "name": "category", "kind": "optional", "type": "string", "description": "" }, { "name": "sku", "kind": "optional", "type": "string", "description": "" }, { "name": "barcode", "kind": "optional", "type": "string", "description": "", "example": "00068510041401" }, { "name": "unit", "kind": "optional", "type": "string", "description": "" }, { "name": "subunit", "kind": "optional", "type": "string", "description": "" }, { "name": "formula", "kind": "optional", "type": "numberPresent when include=products is used on the index endpoint; items are clinic products for filter[clinic_id] linked to this external product.
Quantity-based price tiers.
", "example": "", "itemType": "object", "customType": "object[]", "itemExample": "", "itemDefault": "" }, { "name": "clinics_count", "kind": "optional", "type": "integer", "nullable": true, "description": "" } ] } ], "isExpanded": true } ] } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "mKT1lTeIaikncwfv-zpiM", "language": "curl", "label": "cURL", "code": "curl --request POST \\\n --url https://developer.digitail.io/api/v1/products \\\n --header 'accept: application/json'" }, { "id": "-cttSU4aET9QZWKs56QR_", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n method: 'POST',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"https://developer.digitail.io/api/v1/products\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "YxDK_brqGlTBMmp95rEA4", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://developer.digitail.io/api/v1/products\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "fMTfrGzHJrAGj-kberZRx", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://developer.digitail.io/api/v1/products\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "mKT1lTeIaikncwfv-zpiM" }, "results": { "languages": [ { "id": "response-0-201", "language": "201", "code": "// successful operation\n{\n \"data\": {\n \"id\": 670,\n \"name\": \"Product Prof. Peter Dach\",\n \"client_name\": \"Clinic Name\",\n \"staff_description\": \"Product description for staff\",\n \"unit\": \"package\",\n \"units\": {},\n \"sub_unit\": \"tablets\",\n \"recommended_unit_price\": 11.853,\n \"recommended_subunit_price\": 1.6932857142857143,\n \"price_with_vat\": 11.853,\n \"price_without_vat\": 11.853,\n \"sub_price_with_vat\": 1.853,\n \"sub_price_without_vat\": 1.853,\n \"formula\": 7,\n \"recommended_markup\": 70,\n \"active_substances\": \"\",\n \"administration\": \"\",\n \"recommendations\": \"\",\n \"fixed_fee\": {},\n \"dispensing_fee_includes_tax\": true,\n \"barcode\": \"99425161\",\n \"producer_id\": {},\n \"clinic_id\": {},\n \"vat\": 0,\n \"tax_rates\": [\n \"\"\n ],\n \"is_controlled\": false,\n \"is_consumable\": false,\n \"is_default\": false,\n \"status\": true,\n \"is_used\": true,\n \"minimum_stock\": 0.1,\n \"optimum_stock\": 0.1,\n \"minimum_price\": {},\n \"minimum_price_includes_tax\": false,\n \"minimum_price_with_tax\": 20.3,\n \"minimum_price_without_tax\": 16.92,\n \"price_threshold\": {\n \"range\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"price\": \"\",\n \"unit_type\": 0\n },\n \"task_templates\": [\n {\n \"id\": 0,\n \"name\": \"\"\n }\n ],\n \"external_products\": [\n {\n \"id\": 123,\n \"provider\": {},\n \"external_id\": \"\",\n \"name\": \"\",\n \"producer\": \"\",\n \"category\": \"\",\n \"sku\": \"\",\n \"barcode\": \"00068510041401\",\n \"unit\": \"\",\n \"subunit\": \"\",\n \"formula\": \"\",\n \"price\": 19.99,\n \"currency\": \"\",\n \"products\": [\n \"\"\n ],\n \"in_stock\": false,\n \"stock_qty\": 0,\n \"is_controlled\": false\n }\n ],\n \"is_plan_benefit\": false,\n \"is_deleted\": false,\n \"category_id\": {},\n \"dispensing_fee_with_tax\": 0,\n \"dispensing_fee_without_tax\": 0,\n \"maximum_sellable_quantity\": 10,\n \"days_before_expiry_alert\": 30,\n \"usage\": \"\",\n \"dispensing_method\": \"\",\n \"protection_period\": {},\n \"aaha_code\": \"\",\n \"is_excluded_from_production\": false,\n \"nir_products_exists\": false,\n \"last_cogs\": {},\n \"price_thresholds\": [\n {}\n ],\n \"clinics_count\": 0\n }\n}" } ], "selectedLanguageId": "response-0-201" } }, "children": [ { "text": "" } ] }