Category

DealPOS API (3.1.0)

Welcome Developer

This page lists the reference documentation for DealPOS APIs. For guides and tutorials.

Download OpenAPI description
openapi.json
openapi.yaml
Overview
URL https://www.dealpos.com
Customer Support info@dealpos.com
License
Languages
Servers
Production Server
https://{subdomain}/api/v3/

Token

Operations related to authentication tokens

Operations

Category

Operations related to category, including create, get, etc

Operations

Create a Category

Request

Create a Category based on name

You must have "CREATE" role in "Products" Module

Bodyapplication/json
Namestringrequired

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

Codestring

Code Category

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

Responses

Bodyapplication/json
IDstring

The ID from category created

Response
application/json
{
  "ID": "273d1184-a64b-4d2d-ad98-8b38b19c3ffb"
}

Update a Category

Request

Update a category based on name

You must have "EDIT" role in "Products" Module OR "EDIT" role in "Global" Module

Bodyapplication/json
Namestringrequired
Example: "Top/Men"
Renamestringrequired
Example: "Top/Women"
Discontinuedbooleanrequired
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
  }'

Responses

Bodyapplication/json
IDstring

The ID from category updated

Response
application/json
{
  "ID": "7dc2d2f8-9143-4d3b-bff5-6c00f3f52a23"
}

Delete a Category

Request

Delete a Category based on name

You must have "DELETE" role in "Products" Module

Bodyapplication/json
Namestringrequired

The name of the category that want to be deleted. This is primary key for the object

Example: "Food/Snack/Pastries"
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"
  }'

Responses

Bodyapplication/json
IDstringrequired

the category ID has been deleted

Response
application/json
{
  "ID": "273d1184-a64b-4d2d-ad98-8b38b19c3ffb"
}

List Categories

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"

Bodyapplication/json
Discontinuedboolean

If requester doesn't fill in the discontinued parameter, response will display all of the categories

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
  }'

Responses

Successful response

Bodyapplication/jsonArray [
IDstring

The ID from category

Namestring

The name of category

Discontinuedboolean

Category's discontinued status

SubCategoryArray of objects
]
Response
application/json
[
  {
    "ID": "328ca218-0f0b-449c-8d0d-2a55113ce432",
    "Name": "Top/Men",
    "Discontinued": false
  },
  {
    "ID": "ed8e8964-d3ab-4101-834b-426b85b241b0",
    "Name": "Top",
    "Discontinued": false
  }
]

Get a Category By ID

Request

Also available as HTTP POST with the same endpoint


Get a Category based on ID

Required Group Role: "Products" - "VIEW"

Bodyapplication/json
IDstringrequired

Get from ID of category that you want to get the detail . This is primary key for the object

Example: "328ca218-0f0b-449c-8d0d-2a55113ce431"
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"
  }'

Responses

Bodyapplication/json
ParentIDstring
TypeIDinteger
Lvlinteger
Descriptionstring
Codestring
SKUSeedinteger
Sortstring
UOMstring
MeasurementIDstring
UOMQstring
Namestring
Modelstring
IDstring
Parentstring
Measurementstring
Discontinuedboolean
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
}

Product

Operations related to product, including create, get, etc

Operations

Variant

Operations related to variant, including create, get, etc

Operations

Serial

Operation related to Serial product type

Operations

Estimate

Operations related to estimate, including create, get, etc

Operations

Sales Order

Operations related to sales order, including create, get, etc

Operations

Invoice

Operations related to invoice, including create, get, etc

Operations

Shift

Operation related to shift, including create, get, etc

Operations

Report

Operations related to report page, including create, get, etc

Operations

Customer

Operations related to customer data, including create, get, etc

Operations

Comment

Operations related to comment (Contact Feedback), including create, get, etc

Operations

Supplier

Operations related to supplier data, including create, get, etc

Operations

Invoice Payment

Operations related to invoice payment, including create, get, etc

Operations

Bill Payment

Operations related to bill payment, including create, get, etc

Operations

Invoice Write Off

Operations related to invoice write off, including create, get, etc

Operations

Inventory

Operations related to inventory, including create, get, etc

Operations

Inventory Log

Operations related to inventory log, including create, get, etc

Operations

Inventory Adjustment

Operations related to inventory adjustment, including create, get, etc

Operations

Bill

Operations related to bill, including create, get, etc

Operations

OutboundLogistic

Operations related to outbound logistic, including create, get, etc

Operations