Pricebook

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

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

InboundLogistic

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

Operations

TransferOrder

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

Operations

Fulfillment

Operations related to fulfillment, including create, get, etc

Operations

Prepaid Package

Operations related to prepaid package, including create, get, etc

Operations

Promotion Coupon

Operations related to promotion coupon, including create, get, etc

Operations

Promotion Event

Operations related to promotion event, including create, get, etc

Operations

Pricebook

Operations related to promotion event, including create, get, etc

Operations

List Pricebooks

Request

Get List of Pricebooks

Required Group Role: "Promotion" - "Pricebook"

Query
PageNumberinteger
Example: PageNumber=1
PageSizeinteger
Example: PageSize=20
Namestring
Example: Name=School
curl -i -X GET \
  'https://subdomain.dealpos.net/api/v3/Pricebook?Name=School&PageNumber=1&PageSize=20' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

System successfully returned the list of pricebooks.

Bodyapplication/jsonArray [
IDstring(guid)
Namestring
]
Response
application/json
[
  {
    "ID": "123e4567-e89b-12d3-a456-426614174001",
    "Name": "Back to School"
  },
  {
    "ID": "123e4567-e89b-12d3-a456-426614174002",
    "Name": "School Holiday"
  }
]

Create Pricebook

Request

Create a new Pricebook

Bodyapplication/json
Namestringrequired

Pricebook name

Example: "Pricebook November"
MinimumQuantityinteger

Pricebook minimum quantity

Example: 1
ListOutletsArray of strings

Array List of multiple outlet ID

Example: ["8b13ba50-14b1-486c-9ad2-207ade23c0d6","8b13ba50-14b1-486c-9ad2-207ade23c0d7"]
StartDatestring(date)

Pricebook start Date

Example: "2019-11-01"
Expirationstring(date)

Pricebook expiration Date

Example: "2019-11-30"
Descriptionstring

Pricebook description

Example: "Pricebook for November"
VariantsArray of objectsrequired

List of variants and price in this pricebook

Example: [{"Code":"S0001","OriginalPrice":100000,"PricebookPrice":90000,"Discount":10},{"Code":"TS001","OriginalPrice":150000,"PricebookPrice":120000,"Discount":20}]
Variants[].​Codestringrequired

Variant code

Variants[].​OriginalPricenumberrequired

Original price of the variant

Variants[].​PricebookPricenumberrequired

Price of the variant in this pricebook

Variants[].​Discountnumber

Discount percentage of the variant in this pricebook

curl -i -X POST \
  https://subdomain.dealpos.net/api/v3/Pricebook \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "Name": "Pricebook November",
    "MinimumQuantity": 1,
    "ListOutlets": [
      "8b13ba50-14b1-486c-9ad2-207ade23c0d6",
      "8b13ba50-14b1-486c-9ad2-207ade23c0d7"
    ],
    "StartDate": "2019-11-01",
    "Expiration": "2019-11-30",
    "Description": "Pricebook for November",
    "Variants": [
      {
        "Code": "S0001",
        "OriginalPrice": 100000,
        "PricebookPrice": 90000,
        "Discount": 10
      },
      {
        "Code": "TS001",
        "OriginalPrice": 150000,
        "PricebookPrice": 120000,
        "Discount": 20
      }
    ]
  }'

Responses

Bodyapplication/json
Messagestring

Success message

Example: "Pricebook November created successfully"
IDstring(guid)

Pricebook ID

Example: "123e4567-e89b-12d3-a456-426614174001"
Response
application/json
{
  "Message": "Pricebook November created successfully",
  "ID": "123e4567-e89b-12d3-a456-426614174001"
}

Update Pricebook

Request

Update an existing Pricebook

Bodyapplication/json
IDstring(guid)required

Pricebook ID

Namestringrequired

Pricebook name

Example: "Pricebook November"
MinimumQuantityinteger

Pricebook minimum quantity

Example: 1
ListOutletsArray of strings

Array List of multiple outlet ID

Example: ["8b13ba50-14b1-486c-9ad2-207ade23c0d6","8b13ba50-14b1-486c-9ad2-207ade23c0d7"]
StartDatestring(date)

Pricebook start Date

Example: "2019-11-01"
Expirationstring(date)

Pricebook expiration Date

Example: "2019-11-30"
Descriptionstring

Pricebook description

Example: "Pricebook for November"
VariantsArray of objectsrequired

List of variants and price in this pricebook

Example: [{"Code":"S0001","OriginalPrice":100000,"PricebookPrice":90000,"Discount":10},{"Code":"TS001","OriginalPrice":150000,"PricebookPrice":120000,"Discount":20}]
Variants[].​Codestringrequired

Variant code

Variants[].​OriginalPricenumberrequired

Original price of the variant

Variants[].​PricebookPricenumberrequired

Price of the variant in this pricebook

Variants[].​Discountnumber

Discount percentage of the variant in this pricebook

curl -i -X PUT \
  https://subdomain.dealpos.net/api/v3/Pricebook \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "Name": "Pricebook November",
    "MinimumQuantity": 1,
    "ListOutlets": [
      "8b13ba50-14b1-486c-9ad2-207ade23c0d6",
      "8b13ba50-14b1-486c-9ad2-207ade23c0d7"
    ],
    "StartDate": "2019-11-01",
    "Expiration": "2019-11-30",
    "Description": "Pricebook for November",
    "Variants": [
      {
        "Code": "S0001",
        "OriginalPrice": 100000,
        "PricebookPrice": 90000,
        "Discount": 10
      },
      {
        "Code": "TS001",
        "OriginalPrice": 150000,
        "PricebookPrice": 120000,
        "Discount": 20
      }
    ]
  }'

Responses

Bodyapplication/json
Messagestring

Success message

Example: "Pricebook November created successfully"
IDstring(guid)

Pricebook ID

Example: "123e4567-e89b-12d3-a456-426614174001"
Response
application/json
{
  "Message": "Pricebook November created successfully",
  "ID": "123e4567-e89b-12d3-a456-426614174001"
}

Pricebook Detail By ID

Request

Get Pricebook Detail By ID

Required Group Role: "Promotion" - "Pricebook"

Path
idstring(guid)required

ID of Pricebook

Example: 123e4567-e89b-12d3-a456-426614174000
curl -i -X GET \
  'https://subdomain.dealpos.net/api/v3/Pricebook/ID/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json
IDstring(uuid)
Example: "123e4567-e89b-12d3-a456-426614174001"
Namestring
Example: "Back to School"
MinimumQuantityinteger
Example: 1
OutletArray of strings
Example: ["Outlet1","Outlet2"]
StartDatestring(date)
Example: "2025-07-15"
Expirationstring(date)
Example: "2025-07-30"
Descriptionstring
Example: "Limited"
VariantsArray of objects
Example: [{"ID":"123e4567-e89b-12d3-a456-426614174002","Code":"B001","Name":"Book","OriginalPrice":10000,"PricebookPrice":9000,"Discount":10}]
Response
application/json
{
  "ID": "123e4567-e89b-12d3-a456-426614174001",
  "Name": "Back to School",
  "MinimumQuantity": 1,
  "Outlet": [
    "Outlet1",
    "Outlet2"
  ],
  "StartDate": "2025-07-15",
  "Expiration": "2025-07-30",
  "Description": "Limited",
  "Variants": [
    { … }
  ]
}

Outlet

Operations related to outlet, including create, get, etc

Operations

User

Operations related to user, including create, get, etc

Operations

Outlet Price

Operations related to outlet price, including create, get, etc

Operations

Loyalty Point

Operations related to loyalty point, including create, get, etc

Operations

Notification

Operations related to notification, including create, get, etc

Operations

Payment Method

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

Operations

Invoice Write Off Option

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

Operations

Tax

Operations related to tax, including create, get, etc

Operations

Expense

Operations related to get expense

Operations

Logistics Service

Operations related to logistics service, including create, get, etc

Operations

Park Order Display

Operations related to parked order display, including create, get, etc

Operations

Midtrans Payment Gateway

Operations related to Midtrans Payment Gateway, including create, get, etc

Operations

Apps

Operations related to Apps, including create, get, etc

Operations

Barcode

Operations related to barcode, including create, get, etc

Operations

Client Secret

Operations related to client secret, including create, get, etc

Operations

Rate Limit

Operations related to rate limit, including create, get, etc

Operations

Deprecated

Operations