---
title: View existing Service Package
slug: view-existing-service-package
docTags:
createdAt: 2026-04-21T15:22:49.957Z
---
{
"id": "wwQ-BTO7YIpJKxX0THZFM",
"type": "api-oas-v2",
"data": {
"method": "GET",
"url": "https://developer.digitail.io/api/v1/service-packages/{id}",
"servers": [
{
"url": "https://developer.digitail.io/api/v1/service-packages/{id}",
"description": "Sandbox server (uses test data)"
},
{
"url": "https://vet.digitail.io/api/v1/service-packages/{id}",
"description": "Production server (uses live data)"
}
],
"name": "View existing Service Package",
"description": "Returns an existing service package and all its details.",
"contentType": "application/json",
"request": {
"pathParameters": [],
"headerParameters": [
{
"name": "accept",
"type": "string",
"kind": "optional",
"description": "Generated from available response content types",
"enum": [
"application/json"
],
"default": "application/json"
}
],
"queryParameters": [
{
"kind": "optional",
"name": "include",
"type": "string",
"description": "Additional info to include(ex: 'products', 'products.product', 'products.product.productCategory', 'products.product.stock', 'products.product.latestPurchaseOrderItem','servicePackageServices.products.product', 'labTests', 'subServiceOn', 'labTests.lab', 'aahaCategory', 'taskTemplates')
"
}
],
"bodyDataParameters": [],
"formDataParameters": [],
"oAuthParameters": [
{
"id": "passport",
"name": "passport",
"kind": "optional",
"type": "oauth2",
"description": "Laravel passport oauth2 security.",
"oauth2Flows": {
"authorizationCode": {
"authorizationUrl": "https://digitail.test/oauth/authorize",
"tokenUrl": "https://digitail.test/oauth/token",
"refreshUrl": "https://digitail.test/oauth/token"
}
}
},
{
"id": "Bearer",
"name": "Bearer",
"kind": "optional",
"type": "http",
"scheme": "bearer"
}
],
"cookieParameters": []
},
"responses": [
{
"statusCode": "200",
"description": "successful operation",
"jsonExample": "",
"isExpanded": true,
"schema": [
{
"kind": "optional",
"type": "object",
"description": "",
"schema": [
{
"name": "data",
"kind": "optional",
"type": "object",
"description": "ServicePackage = Services. A service package is a collection of services and products that are sold together. It is a way to group multiple lab test/products together to make it easier to sell them. For example, a service package might include a blood test, and a few products. Service packages can also not contain any products or lab tests, for example, a grooming session. A service package appears as an individual line item on the sale/invoice.
",
"example": "",
"schema": [
{
"name": "id",
"kind": "optional",
"type": "integer",
"description": "",
"example": 1
},
{
"name": "name",
"kind": "optional",
"type": "string",
"description": "",
"example": "lorem"
},
{
"name": "client_name",
"kind": "optional",
"type": "string",
"nullable": true,
"description": "",
"example": "ipsum"
},
{
"name": "staff_description",
"kind": "optional",
"type": "string",
"nullable": true,
"description": "",
"example": "dolor"
},
{
"name": "description",
"kind": "optional",
"type": "string",
"description": "",
"example": "ipsum sin dolor"
},
{
"name": "price",
"kind": "optional",
"type": "string",
"description": "",
"example": "20.00"
},
{
"name": "price_includes_tax",
"kind": "optional",
"type": "boolean",
"description": "",
"example": true
},
{
"name": "tax",
"kind": "optional",
"type": "number",
"deprecated": true,
"description": "Warning: Deprecated\nDeprecated. Summed percentage of tax_rates. Use tax_rates instead.
",
"example": 10
},
{
"name": "tax_rates",
"kind": "optional",
"type": "array",
"description": "Tax rates applied to this item. Always present.",
"modelRef": "#/paths/~1api~1v1~1tax-rates/get/responses/200/content/application~1json/schema/properties/data/items/allOf/0",
"customType": "0[]",
"schema": []
},
{
"name": "unit_price",
"kind": "optional",
"type": "string",
"description": "",
"example": "20.00"
},
{
"name": "clinic_id",
"kind": "optional",
"type": "integer",
"description": "",
"example": 1
},
{
"name": "visit_type_id",
"kind": "optional",
"type": "integer",
"nullable": true,
"description": ""
},
{
"name": "category",
"kind": "optional",
"type": "string",
"description": "",
"example": "Ophthalmology"
},
{
"name": "aaha_code",
"kind": "optional",
"type": "string",
"description": "",
"example": 5000
},
{
"name": "barcode",
"kind": "optional",
"type": "string",
"description": "",
"example": "123-sku"
},
{
"name": "task_templates",
"kind": "optional",
"type": "array",
"nullable": true,
"description": "",
"example": "",
"itemType": "object",
"customType": "object[]",
"schema": [
{
"name": "id",
"kind": "optional",
"type": "integer",
"description": "",
"example": 1
},
{
"name": "name",
"kind": "optional",
"type": "string",
"description": "",
"example": "lorem"
}
]
},
{
"name": "is_plan_benefit",
"kind": "optional",
"type": "boolean",
"description": "",
"example": false
},
{
"name": "is_deleted",
"kind": "optional",
"type": "boolean",
"description": "",
"example": false
}
]
}
],
"isExpanded": true
}
]
}
],
"hasXCodeSamples": false,
"examples": {
"languages": [
{
"id": "TN5XPtIN9V1EEIR5KheHa",
"language": "curl",
"label": "cURL",
"code": "curl --request GET \\\n --url https://developer.digitail.io/api/v1/service-packages/{id} \\\n --header 'accept: application/json'"
},
{
"id": "CDTGZ6WjlDvICiDMqbOPK",
"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: 'GET',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"https://developer.digitail.io/api/v1/service-packages/{id}\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));"
},
{
"id": "K_RNWblLPzUejPc0LAkdP",
"language": "ruby",
"label": "Ruby",
"code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://developer.digitail.io/api/v1/service-packages/{id}\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = https.request(request)\nputs response.read_body\n"
},
{
"id": "jxLA8XyOgKNl0NmalMYC6",
"language": "python",
"label": "Python",
"code": "import requests\nimport json\n\nurl = \"https://developer.digitail.io/api/v1/service-packages/{id}\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
}
],
"selectedLanguageId": "TN5XPtIN9V1EEIR5KheHa"
},
"results": {
"languages": [
{
"id": "RpNKy6EcEPAC-du38DIPx",
"language": "200",
"code": "// successful operation\n{\n \"data\": {\n \"id\": 1,\n \"name\": \"lorem\",\n \"client_name\": \"ipsum\",\n \"staff_description\": \"dolor\",\n \"description\": \"ipsum sin dolor\",\n \"price\": \"20.00\",\n \"price_includes_tax\": true,\n \"tax\": 10,\n \"tax_rates\": [\n \"\"\n ],\n \"unit_price\": \"20.00\",\n \"clinic_id\": 1,\n \"visit_type_id\": 0,\n \"category\": \"Ophthalmology\",\n \"aaha_code\": 5000,\n \"barcode\": \"123-sku\",\n \"task_templates\": [\n {\n \"id\": 1,\n \"name\": \"lorem\"\n }\n ],\n \"is_plan_benefit\": false,\n \"is_deleted\": false\n }\n}"
}
],
"selectedLanguageId": "RpNKy6EcEPAC-du38DIPx"
}
},
"children": [
{
"text": ""
}
]
}