Creates a new category record.
- Create a new category
Get a category by ID
Update a category by ID
Delete a category by ID
Create a new category
Final POS API (1.2.4)
Welcome to the Final POS Public API—your playground for crafting the checkout and kiosk flows you want. Create your API keys in Manage (Settings > API Keys) and send them as x-api-key on every request. Customer endpoints use dynamic DTO generation so they adapt to your custom tables in real time, while the rest of the controllers follow a stable, static contract for predictable integrations.
Download OpenAPI description
Overview
License
Languages
Servers
Mock server
https://docs.finalpos.com/_mock/openapi
Official API
https://api.finalpos.com
Bodyapplication/jsonrequired
Description of the category.
Example: "Beverages are drinks that are not alcoholic."
- Mock serverhttps://docs.finalpos.com/_mock/openapi/v1/api/category
- Official APIhttps://api.finalpos.com/v1/api/category
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://docs.finalpos.com/_mock/openapi/v1/api/category \
-H 'Content-Type: application/json' \
-H 'x-api-key: YOUR_API_KEY_HERE' \
-d '{
"name": "Beverages",
"description": "Beverages are drinks that are not alcoholic.",
"image": "https://example.com/image.jpg",
"externalId": "1234567890",
"parentId": "o1p2q3r4s5t6u7v8w9x0y1z2",
"menuOrder": 1,
"source": "manual"
}'The category has been successfully created.
Timestamp when the Categories was created.
Example: "2025-12-07T19:31:48.436+00:00"
Timestamp when the Categories was last updated.
Example: "2025-12-07T19:35:48.436+00:00"
Description of the category.
Example: "Beverages are drinks that are not alcoholic."
Response
application/json
{ "id": "o1p2q3r4s5t6u7v8w9x0y1z2", "createdAt": "2025-12-07T19:31:48.436+00:00", "updatedAt": "2025-12-07T19:35:48.436+00:00", "companyId": "o1p2q3r4s5t6u7v8w9x0y1z2", "name": "Beverages", "description": "Beverages are drinks that are not alcoholic.", "image": "https://example.com/image.jpg", "externalId": "1234567890", "parentId": "o1p2q3r4s5t6u7v8w9x0y1z2", "menuOrder": 1, "source": "manual" }
- Mock serverhttps://docs.finalpos.com/_mock/openapi/v1/api/category/{id}
- Official APIhttps://api.finalpos.com/v1/api/category/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.finalpos.com/_mock/openapi/v1/api/category/{id}' \
-H 'x-api-key: YOUR_API_KEY_HERE'The category has been successfully retrieved.
Timestamp when the Categories was created.
Example: "2025-12-07T19:31:48.436+00:00"
Timestamp when the Categories was last updated.
Example: "2025-12-07T19:35:48.436+00:00"
Description of the category.
Example: "Beverages are drinks that are not alcoholic."
Response
application/json
{ "id": "o1p2q3r4s5t6u7v8w9x0y1z2", "createdAt": "2025-12-07T19:31:48.436+00:00", "updatedAt": "2025-12-07T19:35:48.436+00:00", "companyId": "o1p2q3r4s5t6u7v8w9x0y1z2", "name": "Beverages", "description": "Beverages are drinks that are not alcoholic.", "image": "https://example.com/image.jpg", "externalId": "1234567890", "parentId": "o1p2q3r4s5t6u7v8w9x0y1z2", "menuOrder": 1, "source": "manual" }
Bodyapplication/jsonrequired
Description of the category.
Example: "Beverages are drinks that are not alcoholic."
- Mock serverhttps://docs.finalpos.com/_mock/openapi/v1/api/category/{id}
- Official APIhttps://api.finalpos.com/v1/api/category/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'https://docs.finalpos.com/_mock/openapi/v1/api/category/{id}' \
-H 'Content-Type: application/json' \
-H 'x-api-key: YOUR_API_KEY_HERE' \
-d '{
"name": "Beverages",
"description": "Beverages are drinks that are not alcoholic.",
"image": "https://example.com/image.jpg",
"externalId": "1234567890",
"parentId": "o1p2q3r4s5t6u7v8w9x0y1z2",
"menuOrder": 1,
"source": "manual"
}'The category has been successfully updated.
Timestamp when the Categories was created.
Example: "2025-12-07T19:31:48.436+00:00"
Timestamp when the Categories was last updated.
Example: "2025-12-07T19:35:48.436+00:00"
Description of the category.
Example: "Beverages are drinks that are not alcoholic."
Response
application/json
{ "id": "o1p2q3r4s5t6u7v8w9x0y1z2", "createdAt": "2025-12-07T19:31:48.436+00:00", "updatedAt": "2025-12-07T19:35:48.436+00:00", "companyId": "o1p2q3r4s5t6u7v8w9x0y1z2", "name": "Beverages", "description": "Beverages are drinks that are not alcoholic.", "image": "https://example.com/image.jpg", "externalId": "1234567890", "parentId": "o1p2q3r4s5t6u7v8w9x0y1z2", "menuOrder": 1, "source": "manual" }
- Mock serverhttps://docs.finalpos.com/_mock/openapi/v1/api/category/{id}
- Official APIhttps://api.finalpos.com/v1/api/category/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
'https://docs.finalpos.com/_mock/openapi/v1/api/category/{id}' \
-H 'x-api-key: YOUR_API_KEY_HERE'Response
application/json
{ "statusCode": 200, "message": "Resource with Id 123 deleted successfully" }