Operations related to authentication tokens
- Get a Category By ID
Create a Category
Update a Category
Delete a Category
List Categories
Get a Category By ID
DealPOS API (3.1.0)
Download OpenAPI description
Overview
URL
Customer Support
Languages
Servers
Production Server
https://{subdomain}/api/v3/
Bodyapplication/json
The name of the category that you want to create. This is primary key for the object If you want to create category child use a "/" operator ex: "Food/Snack/Pastries" will create 3 level category
- Production Serverhttps://subdomain.dealpos.net/api/v3/Category
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://subdomain.dealpos.net/api/v3/Category \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"Name": "Top/Men",
"Code": "TM"
}'Response
application/json
{ "ID": "273d1184-a64b-4d2d-ad98-8b38b19c3ffb" }
- Production Serverhttps://subdomain.dealpos.net/api/v3/Category
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
https://subdomain.dealpos.net/api/v3/Category \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"Name": "Top/Men",
"Rename": "Top/Women",
"Discontinued": false
}'Response
application/json
{ "ID": "7dc2d2f8-9143-4d3b-bff5-6c00f3f52a23" }
- Production Serverhttps://subdomain.dealpos.net/api/v3/Category
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
https://subdomain.dealpos.net/api/v3/Category \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"Name": "Food/Snack/Pastries"
}'Response
application/json
{ "ID": "273d1184-a64b-4d2d-ad98-8b38b19c3ffb" }
Request
Also available as HTTP POST (endpoint: /api/v3/Category/p)
Get list of product categories
Use First example (empty object) to return all categories, and use second example to get spesific category with its children.
Required Group Role: "Products" - "View"
Security
OAuth2_clientCredentials
- Production Serverhttps://subdomain.dealpos.net/api/v3/Category
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
https://subdomain.dealpos.net/api/v3/Category \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"Discontinued": false
}'Response
application/json
[ { "ID": "328ca218-0f0b-449c-8d0d-2a55113ce432", "Name": "Top/Men", "Discontinued": false }, { "ID": "ed8e8964-d3ab-4101-834b-426b85b241b0", "Name": "Top", "Discontinued": false } ]
Request
Also available as HTTP POST with the same endpoint
Get a Category based on ID
Required Group Role: "Products" - "VIEW"
Security
OAuth2_clientCredentials
- Production Serverhttps://subdomain.dealpos.net/api/v3/Category/ID
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
https://subdomain.dealpos.net/api/v3/Category/ID \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"ID": "328ca218-0f0b-449c-8d0d-2a55113ce431"
}'Response
application/json
{ "ParentID": "ed8e8964-d3ab-4101-834b-426b85b241b0", "TypeID": 0, "Lvl": 0, "Description": "Top/Men", "Code": "TM", "SKUSeed": 0, "Sort": "Men", "UOM": "pcs", "MeasurementID": "00000000-0000-0000-0000-000000000000", "UOMQ": "pcs", "Name": "Top/Men", "Model": "Men", "ID": "328ca218-0f0b-449c-8d0d-2a55113ce431", "Parent": "Top", "Measurement": "Size", "Discontinued": false }