Inventory

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

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

Get Inventory By List

Request

Also available as HTTP POST with the same endpoint


Get list of Inventory

Required Group Role: "Inventory" - "VIEW"

Bodyapplication/json
One of:
Outletstring

The outlet name

Example: "Outlet1"
Categorystring

The product category

Example: "Top"
QuantityFrominteger

The minimum quantity of the product that users want to view

Example: 1
Discontinuedboolean

The product discontinued status

Tagsstring

The product tags

Example: "Summer"
PageNumberintegerrequired

The page number of the product

Example: 1
PageSizeintegerrequired

The page size of the product list

Example: 500
curl -i -X GET \
  https://subdomain.dealpos.net/api/v3/Inventory \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "Outlet": "Outlet1",
    "Category": "Top",
    "QuantityFrom": 1,
    "Discontinued": false,
    "Tags": "Summer",
    "PageNumber": 1,
    "PageSize": 500
  }'

Responses

Bodyapplication/jsonArray [
Categorystring

Name of product category

Productstring

Name of product

Variantstring

The variant name

Codestring

The variant code

Inventorynumber

On Hand Inventory

Iobject

Inventory for the variant

]
Response
application/json
[
  {
    "Category": "Top/Men",
    "Product": "Captain America T-Shirt",
    "Variant": "Captain America T-Shirt (Large)",
    "Code": "1003L",
    "Inventory": 10,
    "I": { … }
  },
  {
    "Category": "Top/Men",
    "Product": "Captain America T-Shirt",
    "Variant": "Captain America T-Shirt (Medium)",
    "Code": "1003M",
    "Inventory": 5,
    "I": { … }
  },
  {
    "Category": "Top/Men",
    "Product": "Denim Shirt",
    "Variant": "Denim Shirt (L)",
    "Code": "1342L",
    "Inventory": 50,
    "I": { … }
  },
  {
    "Category": "Top/Men",
    "Product": "Denim Shirt",
    "Variant": "Denim Shirt (M)",
    "Code": "1342M",
    "Inventory": 10,
    "I": { … }
  },
  {
    "Category": "Top/Men",
    "Product": "Jacket",
    "Variant": "Jacket (L)",
    "Code": "1021L",
    "Inventory": 11,
    "I": { … }
  },
  {
    "Category": "Top/Men",
    "Product": "Jacket",
    "Variant": "Jacket (M)",
    "Code": "1021M",
    "Inventory": 18,
    "I": { … }
  },
  {
    "Category": "Top/Men",
    "Product": "Jacket",
    "Variant": "Jacket (S)",
    "Code": "1021S",
    "Inventory": 20,
    "I": { … }
  }
]

Get Inventory By Code

Request

Also available as HTTP POST with the same endpoint


Get an Inventory based on CodeGet list of Inventory

Required Group Role: "Inventory" - "VIEW"

Bodyapplication/json
One of:
OutletArray of stringsrequired

Outlet's Name will be show the inventory data

Example: ["Outlet1","Outlet2","Outlet3"]
Codestringrequired

Variant code of product this is primary key for the object

Example: "2001"
curl -i -X GET \
  https://subdomain.dealpos.net/api/v3/Inventory/Code \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "Outlet": [
      "Outlet1",
      "Outlet2",
      "Outlet3"
    ],
    "Code": "2001"
  }'

Responses

Bodyapplication/jsonArray [
Outletstring

Outlet Name

Inventoryinteger

OnHand Quantity

Iobject
]
Response
application/json
[
  {
    "Outlet": "Outlet1",
    "Inventory": 140,
    "I": { … }
  },
  {
    "Outlet": "Outlet2",
    "Inventory": 10,
    "I": { … }
  }
]

Get Inventory By Code Array

Request

Also available as HTTP POST with the same endpoint


Get Inventory for Multiple Code, this is an enhancement from previous api /inventory/code which can only query single Code

Required Group Role: "Inventory" - "VIEW"

Bodyapplication/json
One of:
OutletArray of stringsrequired

List of Outlet Name

Example: ["Jakarta","Surabaya"]
CodeArray of stringsrequired

List of Variants Code of product. Max=50 variants code

Example: ["907","908","909"]
curl -i -X GET \
  https://subdomain.dealpos.net/api/v3/Inventory/CodeArray \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "Outlet": [
      "Jakarta",
      "Surabaya"
    ],
    "Code": [
      "907",
      "908",
      "909"
    ]
  }'

Responses

Bodyapplication/jsonArray [
Codestring

Variant Code of product

Inventoryinteger

On Hand Quantity

]
Response
application/json
[
  {
    "Code": "907",
    "Inventory": 140
  },
  {
    "Code": "908",
    "Inventory": 20
  },
  {
    "Code": "909",
    "Inventory": 7
  }
]

Get Inventory By ListCode Group by Outlet

Request

Also available as HTTP POST with the same endpoint


Get Inventory for Multiple Code group by Outlet, this is an enhancement from previous api /inventory/code which can only query single Code

Required Group Role: "Inventory" - "VIEW"

Bodyapplication/json
One of:
OutletArray of strings

List of Outlet Name

Example: ["Jakarta","Surabaya"]
CodeArray of stringsrequired

List of Variants Code of variant. Max=50 Variants Code

Example: ["907","908"]
curl -i -X GET \
  https://subdomain.dealpos.net/api/v3/Inventory/CodeArrayGroupByOutlet \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "Outlet": [
      "Jakarta",
      "Surabaya"
    ],
    "Code": [
      "907",
      "908"
    ]
  }'

Responses

Bodyapplication/jsonArray [
Codestring

Variant Code

InventoriesArray of objects
]
Response
application/json
[
  {
    "Code": "907",
    "Inventories": [ … ]
  },
  {
    "Code": "908",
    "Inventories": [ … ]
  }
]

Get Inventory By List ID

Request

Also available as HTTP POST with the same endpoint


Get Inventory By List Outlet and List ID

Required Group Role: "Inventory" - "VIEW"

Bodyapplication/json
One of:
ListIDArray of stringsrequired

Variants ID. Max=50

Example: ["69b2a2cd-406a-44ac-b1e2-8df079f50304","d94579c0-eeb5-4b03-893e-d24cc624786c"]
ListOutletArray of stringsrequired

Outlets Name. (if empty it will be show inventory of all outlet)

Example: ["Outlet1","Outlet2"]
CalculateCompositeInventoryboolean

Only effect product type Composite (if true OnHand will be show, if false OnHand always 0)

Default false
Example: true
IncludeParentInventoryboolean

Show detail inventory of Parents Product

Default false
Example: true
IncludeChildrenInventoryboolean

Show detail inventory of Children Product

Default false
Example: true
curl