Skip to content
/
Get a Product By ID

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

Create a Product

Request

Create New Product

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

Security
OAuth2_clientCredentials
Headers
UploadImageAsyncstring

When true image is uploaded asynchronously meaning when you receive OK Status Code the image processing is still running in the background.

Bodyapplication/json
One of:
Categorystringrequired

The category of the product

Example: "Top/Men"
Namestringrequired

The name of the product

Example: "Captain America T-Shirt"
Brandstringrequired

The brand of the product

Example: "Brand"
Codestringrequired

The code of the product

Example: "1003"
Discontinuedbooleanrequired

The discontinued status of the product

ImageURLstringrequired

The image URL of the product

Example: "https://images.unsplash.com/photo-1622793348115-4e85dc2ca4eb?ixid=MnwxMjA3fDB8MHxzZWFyY2h8Mnx8Y2FwdGFpbiUyMGFtZXJpY2F8ZW58MHx8MHx8&ixlib=rb-1.2.1&auto=format&fit=crop&w=600&q=60"
ExtraImagesURLArray of strings

The extra image URL of the product

Example: ["//res.cloudinary.com/pos/image/upload/Product/afa67ca2-46f4-418a-a5fe-a3a79b1dbc95/vgzleqpgujlspm9ltdiht.jpg","//res.cloudinary.com/pos/image/upload/Product/afa67ca2-46f4-418a-a5fe-a3a79b1dbc95/q7dbzf9qnif8vbxuzxo0.jpg","//res.cloudinary.com/pos/image/upload/Product/afa67ca2-46f4-418a-a5fe-a3a79b1dbc95/ur871mubz7ioecvja8ex.jpg"]
Descriptionstring

The description of the product

Example: "New Arrival"
VariantsArray of objectsrequired
Example: [{"Model":"Small","Code":"1003S","UnitCost":100000,"UnitPrice":150000,"Discontinued":true,"Type":{"value":"Standard"},"VariantDescription":"Unavailable"},{"Model":"Medium","Code":"1003M","UnitCost":125000,"UnitPrice":175000,"Type":{"value":"Standard"},"Discontinued":false}]
Variants[].​Modelstring

The model of the variant

Variants[].​Codestring

The code of the variant

Variants[].​UnitCostnumber

The unit cost of the variant

Variants[].​UnitPricenumber

The unit price of the variant

Variants[].​Discontinuedboolean

The discontinued status of the variant

Variants[].​Typeobject

The type of the variant

Variants[].​VariantDescriptionstring

The description of the variant

curl -i -X POST \
  https://subdomain.dealpos.net/api/v3/Product \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'UploadImageAsync: string' \
  -d '{
    "Category": "Top/Men",
    "Name": "Captain America T-Shirt",
    "Brand": "Brand",
    "Code": "1003",
    "Discontinued": false,
    "ImageURL": "https://images.unsplash.com/photo-1622793348115-4e85dc2ca4eb?ixid=MnwxMjA3fDB8MHxzZWFyY2h8Mnx8Y2FwdGFpbiUyMGFtZXJpY2F8ZW58MHx8MHx8&ixlib=rb-1.2.1&auto=format&fit=crop&w=600&q=60",
    "ExtraImagesURL": [
      "//res.cloudinary.com/pos/image/upload/Product/afa67ca2-46f4-418a-a5fe-a3a79b1dbc95/vgzleqpgujlspm9ltdiht.jpg",
      "//res.cloudinary.com/pos/image/upload/Product/afa67ca2-46f4-418a-a5fe-a3a79b1dbc95/q7dbzf9qnif8vbxuzxo0.jpg",
      "//res.cloudinary.com/pos/image/upload/Product/afa67ca2-46f4-418a-a5fe-a3a79b1dbc95/ur871mubz7ioecvja8ex.jpg"
    ],
    "Description": "New Arrival",
    "Variants": [
      {
        "Model": "Small",
        "Code": "1003S",
        "UnitCost": 100000,
        "UnitPrice": 150000,
        "Discontinued": true,
        "Type": {
          "value": "Standard"
        },
        "VariantDescription": "Unavailable"
      },
      {
        "Model": "Medium",
        "Code": "1003M",
        "UnitCost": 125000,
        "UnitPrice": 175000,
        "Type": {
          "value": "Standard"
        },
        "Discontinued": false
      }
    ]
  }'

Responses

Bodyapplication/json
IDstringrequired

Product ID

Example: "9525a6b0-297f-4b4a-97c7-0ae876bb44cd"
VariantsArray of objectsrequired

Array of Variants

Example: [{"Code":"1000S","ID":"9ad47be6-bf1c-4dd5-87a8-193fe56d1035"},{"Code":"1000M","ID":"b3d68610-22a5-445d-8c5c-c79487373aa2"}]
Variants[].​Codestring

Variant Code

Variants[].​IDstring

Variant ID

ListVariantIDArray of strings

List Variant ID

Example: ["9ad47be6-bf1c-4dd5-87a8-193fe56d1035","b3d68610-22a5-445d-8c5c-c79487373aa2"]
Response
application/json
{
  "ID": "9525a6b0-297f-4b4a-97c7-0ae876bb44cd",
  "Variants": [
    { … },
    { … }
  ],
  "ListVariantID": [
    "9ad47be6-bf1c-4dd5-87a8-193fe56d1035",
    "b3d68610-22a5-445d-8c5c-c79487373aa2"
  ]
}

Update a Product By Code

Request

Update Product Existing

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

Security
OAuth2_clientCredentials
Bodyapplication/json
Categorystringrequired

The name of the category that will be use, you also can create new category.

If you want to nest a category use a "/" operator ex: "Food/Snack/Pastries" will create 3 level category

Namestringrequired

The name of the product to be created.

Brandstring

The name of the brand to be created. Backwards compatibility with property "BrandName"

Codestringrequired

the code of the product to be created.

Discontinuedbooleanrequired

The product availability for selling.

ImageURLstring

The image link of the product to be created.

ExtraImagesURLArray of strings

Image link of additional image in product

Descriptionstring

The description of the product.

VariantsArray of objects
curl -i -X PUT \
  https://subdomain.dealpos.net/api/v3/Product \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "Category": "Top/Men",
    "Name": "Captain America T-Shirt",
    "Brand": "Brand",
    "Code": "1003",
    "Discontinued": false,
    "ImageURL": "https://images.unsplash.com/photo-1622793348115-4e85dc2ca4eb?ixid=MnwxMjA3fDB8MHxzZWFyY2h8Mnx8Y2FwdGFpbiUyMGFtZXJpY2F8ZW58MHx8MHx8&ixlib=rb-1.2.1&auto=format&fit=crop&w=600&q=60",
    "Description": "New Arrival",
    "Variants": [
      {
        "Model": "Medium",
        "Code": "1003M",
        "UnitCost": 125000,
        "UnitPrice": 200000,
        "Discontinued": false
      },
      {
        "Model": "Large",
        "Code": "1003L",
        "UnitCost": 150000,
        "UnitPrice": 225000,
        "Discontinued": false
      }
    ]
  }'

Responses

Bodyapplication/json
IDstring
Example: "9525a6b0-297f-4b4a-97c7-0ae876bb44cd"
VariantsArray of objects
Example: [{"Code":"1000S","ID":"9ad47be6-bf1c-4dd5-87a8-193fe56d1035"},{"Code":"1000M","ID":"b3d68610-22a5-445d-8c5c-c79487373aa2"}]
ListVariantIDArray of strings
Example: ["9ad47be6-bf1c-4dd5-87a8-193fe56d1035","b3d68610-22a5-445d-8c5c-c79487373aa2"]
Response
application/json
{
  "ID": "9525a6b0-297f-4b4a-97c7-0ae876bb44cd",
  "Variants": [
    { … },
    { … }
  ],
  "ListVariantID": [
    "9ad47be6-bf1c-4dd5-87a8-193fe56d1035",
    "b3d68610-22a5-445d-8c5c-c79487373aa2"
  ]
}

Delete a Product

Request

Delete Product by Code

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

Security
OAuth2_clientCredentials
Bodyapplication/json
Codestringrequired

The code of the product to be deleted.

curl -i -X DELETE \
  https://subdomain.dealpos.net/api/v3/Product \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "Code": "J100"
  }'

Responses

Bodyapplication/json
string

The Product has been deleted

Response
application/json
"Product with code J100 has been successfully deleted."

List Products

Request

Also available as HTTP POST (endpoint: /api/v3/Product/p)


Get List of Products sorted by Category Asc, Code Asc, Name Asc

Required Group Role: "Products" - "VIEW"

Security
OAuth2_clientCredentials
Query
PageNumberintegerrequired

The page number that you want to display

Example: PageNumber=1
PageSizeintegerrequired

The maximum number of data that you want to display on the page

Example: PageSize=20
QueryRowCountboolean

Default show / hide the counter

Categorystring

The name of the product category.

ListCategoryArray of arrays

The name of the product in multiple category

Namestring

Name of the product

Discontinuedstring

The name of the product category.

Default "No"
Enum"No""Yes""All"
QueryInventoryboolean

The name of the product category.

Default false
SearchModestring

The search mode of the product

Default "Variant"
Enum"Product""Variant"
curl -i -X GET \
  'https://subdomain.dealpos.net/api/v3/Product?PageNumber=1&PageSize=20&QueryRowCount=true&Category=string&Name=string&Discontinued=No&QueryInventory=false&SearchMode=Product' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json
DataArrayArray of objects
RecordsCountinteger

total product data result. (-1 if QueryRowCount set false)

Response
application/json
{
  "DataArray": [
    { … },
    { … },
    { … },
    { … },
    { … }
  ],
  "RecordsCount": 5
}

Get a Product By Code

Request

Also available as HTTP POST with the same endpoints


Get Product Detail By Code

Required Group Role: "Products" - "VIEW"

Security
OAuth2_clientCredentials
Query
ProductCodestringrequired

The code of the product to be provided.

Example: ProductCode=1003
curl -i -X GET \
  'https://subdomain.dealpos.net/api/v3/Product/Code?ProductCode=1003' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json
IDstring

the ID product to be showed

Categorystring

the category of the product to be showed

Namestring

the name of the product to be showed

SupplierNamestring

the supplier name of the product

Brandstring

Brand name of product (Backwards compatibility with property "BrandName")

Codestring

the code of the product

Discontinuedboolean

the availibility of the product

Descriptionstring

description of the product

StorageArray of objects

storage location of the product

TagsArray of strings

tags of the product

ThumbnailURLstring

Thumbnail URL of product image

ImageURLstring

the image url of the product

ExtraImagesURLArray of strings
VariantsArray of objects
Response
application/json
{
  "ID": "f74bba14-99f0-4246-84bf-3064e3d516c3",
  "Category": "Top/Men",
  "Name": "Captain America T-Shirt",
  "SupplierName": "PT ABC",
  "Brand": "Nike",
  "Code": "1003",
  "Discontinued": false,
  "Description": "New Arrival",
  "Storage": [
    { … }
  ],
  "Tags": [
    "New Brand"
  ],
  "ThumbnailURL": "https://cdn.dealpos.app/cdn-cgi/image/width=80,quality=100/net/sandbox/Product/afa67ca2-46f4-418a-a5fe-a3a79b1dbc95/sgbksabgzjc2qmm4uigp.png",
  "ImageURL": "https://cdn.dealpos.app/net/sandbox/Product/f74bba14-99f0-4246-84bf-3064e3d516c3/url",
  "ExtraImagesURL": [
    "https://cdn.dealpos.app/net/sandbox/Product/afa67ca2-46f4-418a-a5fe-a3a79b1dbc95/vgzleqpgujlspm9ltdiht.jpg",
    "https://cdn.dealpos.app/net/sandbox/Product/afa67ca2-46f4-418a-a5fe-a3a79b1dbc95/q7dbzf9qnif8vbxuzxo0.jpg",
    "https://cdn.dealpos.app/net/sandbox/Product/afa67ca2-46f4-418a-a5fe-a3a79b1dbc95/ur871mubz7ioecvja8ex.jpg"
  ],
  "Variants": [
    { … },
    { … }
  ]
}

Get a Product By ID

Request

Also available as HTTP POST with the same endpoints


Get Product Detail By ID

Required Group Role: "Products" - "VIEW"

Security
OAuth2_clientCredentials
Query
IDstringrequired

The code of the product to be provided.

Example: ID=a731920a-b3ab-42d7-b42d-b93cd69ceb92
curl -i -X GET \
  'https://subdomain.dealpos.net/api/v3/Product/ID?ID=a731920a-b3ab-42d7-b42d-b93cd69ceb92' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json
IDstring

the ID product to be showed

Categorystring

the category of the product to be showed

Namestring

the name of the product to be showed

SupplierNamestring

the supplier name of the product

Brandstring

Brand name of product (Backwards compatibility with property "BrandName")

Codestring

the code of the product

Discontinuedboolean

the availibility of the product

Descriptionstring

description of the product

StorageArray of objects

storage location of the product

TagsArray of strings

tags of the product

ThumbnailURLstring

Thumbnail URL of product image

ImageURLstring

the image url of the product

ExtraImagesURLArray of strings
VariantsArray of objects
Response
application/json
{
  "ID": "f74bba14-99f0-4246-84bf-3064e3d516c3",
  "Category": "Top/Men",
  "Name": "Captain America T-Shirt",
  "SupplierName": "PT ABC",
  "Brand": "Nike",
  "Code": "1003",
  "Discontinued": false,
  "Description": "New Arrival",
  "Storage": [
    { … }
  ],
  "Tags": [
    "New Brand"
  ],
  "ThumbnailURL": "https://dealpos.b-cdn.net/net/sandbox/Product/5be4a972-a242-4ded-8722-6baf4ec270d5/newproductimage.jpg?width=80",
  "ImageURL": "https://cdn.dealpos.app/net/sandbox/Product/5be4a972-a242-4ded-8722-6baf4ec270d5/newproductimage.jpg",
  "ExtraImagesURL": [
    "https://cdn.dealpos.app/net/sandbox/Product/afa67ca2-46f4-418a-a5fe-a3a79b1dbc95/vgzleqpgujlspm9ltdiht.jpg",
    "https://cdn.dealpos.app/net/sandbox/Product/afa67ca2-46f4-418a-a5fe-a3a79b1dbc95/q7dbzf9qnif8vbxuzxo0.jpg",
    "https://cdn.dealpos.app/net/sandbox/Product/afa67ca2-46f4-418a-a5fe-a3a79b1dbc95/ur871mubz7ioecvja8ex.jpg"
  ],
  "Variants": [
    { … },
    { … }
  ]
}

Get Product List With Inventory By List ID

Request

Get Product List WIth Inventory By List ID

Security
OAuth2_clientCredentials
Bodyapplication/json
One of:
Fromnumberrequired

Quantity Start

Tonumberrequired

Quantity To

Example: 10
ListOutletArray of stringsrequired

Array list of Outlet that use to get Product ID

Example: ["Outlet1"]
ListIDArray of stringsrequired

Array list of multiple product ID from chosen outlet

Example: ["14cf5b6b-0fb9-42b9-a956-09339b3985fe","f0e2bf85-cb49-4244-9e73-6e0a7403e2ca"]
Discontinuedstring

Show discontinued status of Product and Variant

Default "No"
Enum"No""Yes""All"
Example: "No"
curl -i -X GET \
  https://subdomain.dealpos.net/api/v3/Product/WithInventoryByListID \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "From": 0,
    "To": 10,
    "ListOutlet": [
      "Outlet1"
    ],
    "ListID": [
      "14cf5b6b-0fb9-42b9-a956-09339b3985fe",
      "f0e2bf85-cb49-4244-9e73-6e0a7403e2ca"
    ],
    "Discontinued": "No"
  }'

Responses

Bodyapplication/jsonArray [
IDstring

ID number of Product

Namestring

Name of product

Codestring

Code of Product

CategoryIDstring

ID number of product category

Categorystring

Name of product category

Descriptionstring

Description of product

ThumbnailUrlstring

Thumbnail URL of product image

ImageUrlstring

image url from product image

Createdstringrequired

date when product is created

Discontinuedboolean

The Availablity status of the product

VariantsArray of objects

Variation for this product ex: size / color

]
Response
application/json
[
  {
    "ID": "14cf5b6b-0fb9-42b9-a956-09339b3985fe",
    "Name": "Denim Shirt",
    "Code": "1342",
    "CategoryID": "6d3817dc-4589-42b4-9464-4d6599046f02",
    "Category": "Dress",
    "Description": "Product Description",
    "ThumbnailUrl": "//res.cloudinary.com/pos/image/upload/w_80/com/christopher/Product/afa67ca2-46f4-418a-a5fe-a3a79b1dbc95/sgbksabgzjc2qmm4uigp.png",
    "ImageUrl": "//res.cloudinary.com/pos/image/upload/com/christopher/Product/afa67ca2-46f4-418a-a5fe-a3a79b1dbc95/sgbksabgzjc2qmm4uigp.png",
    "Created": "2018-04-06T17:24:17.283",
    "Discontinued": false,
    "Variants": [ … ]
  },
  {
    "ID": "f0e2bf85-cb49-4244-9e73-6e0a7403e2ca",
    "Name": "Shirt",
    "Code": "1002",
    "CategoryID": "6d3817dc-4589-42b4-9464-4d6599046f02",
    "Category": "Dress",
    "Description": "Product Description",
    "ThumbnailUrl": "//res.cloudinary.com/pos/image/upload/w_80/com/christopher/Product/afa67ca2-46f4-418a-a5fe-a3a79b1dbc95/sgbksabgzjc2qmm4uigp.png",
    "ImageUrl": "//res.cloudinary.com/pos/image/upload/com/christopher/Product/afa67ca2-46f4-418a-a5fe-a3a79b1dbc95/sgbksabgzjc2qmm4uigp.png",
    "Created": "2018-04-06T17:24:17.11",
    "Discontinued": false,
    "Variants": [ … ]
  }
]

Get Product List By ID

Request

You can query a product based on Code or by GUID

Security
OAuth2_clientCredentials
Bodyapplication/json
ListIDArray of stringsrequired

Array List of multiple product ID

curl -i -X GET \
  https://subdomain.dealpos.net/api/v3/Product/ListID \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "ListID": [
      "14cf5b6b-0fb9-42b9-a956-09339b3985fe",
      "f0e2bf85-cb49-4244-9e73-6e0a7403e2ca"
    ]
  }'

Responses

Bodyapplication/jsonArray [
IDstring

Product ID

Namestring

Product Name

Codestring

Product Code

CategoryIDstring

Category ID of Product

Categorystring

Category of Product

Descriptionstring

Product Description

ImageUrlstring

Product image URL

ThumbnailUrlstring

Thumbnail URL of product image

ExtraImageURLArray of strings

Additional Image Url

Createdstring

Product Created Date

VariantsArray of objects

Variation for this product, ex: size/ color

]
Response
application/json
[
  {
    "ID": "14cf5b6b-0fb9-42b9-a956-09339b3985fe",
    "Name": "Denim Shirt",
    "Code": "1342",
    "CategoryID": "6d3817dc-4589-42b4-9464-4d6599046f02",
    "Category": "Dress",
    "Description": "Product Description",
    "ThumbnailUrl": "//res.cloudinary.com/pos/image/upload/w_80/Product/afa67ca2-46f4-418a-a5fe-a3a79b1dbc95/vgzleqpgujlpm9ltdiht.jpg",
    "ImageUrl": "//res.cloudinary.com/pos/image/upload/Product/afa67ca2-46f4-418a-a5fe-a3a79b1dbc95/vgzleqpgujlpm9ltdiht.jpg",
    "ExtraImageURL": [ … ],
    "Created": "2018-04-06T17:24:17.283",
    "Variants": [ … ]
  },
  {
    "ID": "f0e2bf85-cb49-4244-9e73-6e0a7403e2ca",
    "Name": "Shirt",
    "Code": "1002",
    "CategoryID": "6d3817dc-4589-42b4-9464-4d6599046f02",
    "Category": "Dress",
    "Description": "Product Description",
    "ImageUrl": "//res.cloudinary.com/pos/image/upload/w_80/Product/afa67ca2-46f4-418a-a5fe-a3a79b1dbc95/vgzleqpgujlpm9ltdiht.jpg",
    "Created": "2018-04-06T17:24:17.11",
    "Variants": [ … ]
  }
]

Get Product List Detail By ID

Request

Slower compared with /v3/Product/ListID But returns Extra Column p.Description + v.Weight

Security
OAuth2_clientCredentials
Bodyapplication/json
ListIDArray of stringsrequired

Array List of multiple product ID

curl -i -X GET \
  https://subdomain.dealpos.net/api/v3/Product/DetailByListID \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "ListID": [
      "14cf5b6b-0fb9-42b9-a956-09339b3985fe",
      "f0e2bf85-cb49-4244-9e73-6e0a7403e2ca"
    ]
  }'

Responses

Bodyapplication/jsonArray [
IDstring
Namestring
Codestring
Categorystring
Brandstring

Brand name of product

Descriptionstring
ThumbnailUrlstring
ImageUrlstring
Createdstring
VariantsArray of objects
ProductImagesArray of objects
]
Response
application/json
[
  {
    "ID": "7c1a0b28-45f2-4b65-8fe5-d5043f19ed74",
    "Name": "Baju Bunga 2",
    "Code": "TOP",
    "Category": "TOP",
    "Brand": "Classic",
    "Description": "ukuran tersedia saat ini hanya S",
    "ThumbnailUrl": "//res.cloudinary.com/dealpos/image/upload/w_80/net/tokoferdi2/Product/7c1a0b28-45f2-4b65-8fe5-d5043f19ed74/A13usaonutL._CLa_7C2140_2C2000_7C71zRbNUKhML.png_7C0_2C0_2C2140_2C2000_2B0.0_2C0.0_2C2140.0_2C2000.0_AC_UX342_.jpg",
    "ImageUrl": "//res.cloudinary.com/dealpos/image/upload/net/tokoferdi2/Product/7c1a0b28-45f2-4b65-8fe5-d5043f19ed74/A13usaonutL._CLa_7C2140_2C2000_7C71zRbNUKhML.png_7C0_2C0_2C2140_2C2000_2B0.0_2C0.0_2C2140.0_2C2000.0_AC_UX342_.jpg",
    "Created": "2022-06-14T11:30:37.4",
    "Variants": [ … ],
    "ProductImages": [ … ]
  }
]

Get Product List With Outlet Price By List ID

Request

Get Product List With Outlet Price By List ID

Security
OAuth2_clientCredentials
Bodyapplication/json
ListIDArray of stringsrequired

Array list of multiple product ID

curl -i -X GET \
  https://subdomain.dealpos.net/api/v3/Product/WithOutletPriceByListID \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "ListID": [
      "14cf5b6b-0fb9-42b9-a956-09339b3985fe",
      "f0e2bf85-cb49-4244-9e73-6e0a7403e2ca"
    ]
  }'

Responses

Bodyapplication/jsonArray [
IDstring

ID number of Product

Namestring

Name of product

Codestring

Code of Product

CategoryIDstring

ID number of product category

Categorystring

name of product category

Descriptionstring

Description of product

ThumbnailUrlstring

Thumbnail URL of product image

ImageUrlstring

image url from product image

Createdstring

date when product is created

VariantsArray of objects

variaton of the product, exp: size/ colour from product

]
Response
application/json
[
  {
    "ID": "14cf5b6b-0fb9-42b9-a956-09339b3985fe",
    "Name": "Denim Shirt",
    "Code": "1342",
    "CategoryID": "6d3817dc-4589-42b4-9464-4d6599046f02",
    "Category": "Dress",
    "Description": "Product Description",
    "ThumbnailUrl": "//res.cloudinary.com/pos/image/upload/w_80/com/christopher/Product/afa67ca2-46f4-418a-a5fe-a3a79b1dbc95/sgbksabgzjc2qmm4uigp.png",
    "ImageUrl": "//res.cloudinary.com/pos/image/upload/w_80/com/christopher/Product/afa67ca2-46f4-418a-a5fe-a3a79b1dbc95///res.cloudinary.com/pos/image/upload/com/christopher/Product/afa67ca2-46f4-418a-a5fe-a3a79b1dbc95/sgbksabgzjc2qmm4uigp.png",
    "Created": "2018-04-06T17:24:17.283",
    "Variants": [ … ]
  },
  {
    "ID": "f0e2bf85-cb49-4244-9e73-6e0a7403e2ca",
    "Name": "Shirt",
    "Code": "1002",
    "CategoryID": "6d3817dc-4589-42b4-9464-4d6599046f02",
    "Category": "Dress",
    "Description": "Product Description",
    "ImageUrl": "//res.cloudinary.com/pos/image/upload/w_80/Product/afa67ca2-46f4-418a-a5fe-a3a79b1dbc95/vgzleqpgujlpm9ltdiht.jpg",
    "Created": "2018-04-06T17:24:17.11",
    "Variants": [ … ]
  }
]

Get Product List With Pricebook By List ID

Request

Get Product List With Pricebook By List ID

Security
OAuth2_clientCredentials
Bodyapplication/json
ListIDArray of stringsrequired

Array list of multiple product ID

curl -i -X GET \
  https://subdomain.dealpos.net/api/v3/Product/WithPricebookByListID \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "ListID": [
      "14cf5b6b-0fb9-42b9-a956-09339b3985fe",
      "f0e2bf85-cb49-4244-9e73-6e0a7403e2ca"
    ]
  }'

Responses

Bodyapplication/jsonArray [
IDstring

ID number of Product

Namestring

Name of product

Codestring

Code of Product

CategoryIDstring

ID number of product category

Categorystring

name of product category

Descriptionstring

Description of product

ThumbnailUrlstring

Thumbnail URL of product image

ImageUrlstring

image url from product image

Createdstring

date when product is created

VariantsArray of objects

variaton of the product, exp: size/ colour from product

]
Response
application/json
[
  {
    "ID": "14cf5b6b-0fb9-42b9-a956-09339b3985fe",
    "Name": "Denim Shirt",
    "Code": "1342",
    "CategoryID": "6d3817dc-4589-42b4-9464-4d6599046f02",
    "Category": "Dress",
    "Description": "Product Description",
    "ThumbnailUrl": "//res.cloudinary.com/pos/image/upload/w_80/com/christopher/Product/afa67ca2-46f4-418a-a5fe-a3a79b1dbc95/sgbksabgzjc2qmm4uigp.png",
    "ImageUrl": "//res.cloudinary.com/pos/image/upload/w_80/com/christopher/Product/afa67ca2-46f4-418a-a5fe-a3a79b1dbc95///res.cloudinary.com/pos/image/upload/com/christopher/Product/afa67ca2-46f4-418a-a5fe-a3a79b1dbc95/sgbksabgzjc2qmm4uigp.png",
    "Created": "2018-04-06T17:24:17.283",
    "Variants": [ … ]
  },
  {
    "ID": "f0e2bf85-cb49-4244-9e73-6e0a7403e2ca",
    "Name": "Shirt",
    "Code": "1002",
    "CategoryID": "6d3817dc-4589-42b4-9464-4d6599046f02",
    "Category": "Dress",
    "Description": "Product Description",
    "ImageUrl": "//res.cloudinary.com/pos/image/upload/w_80/Product/afa67ca2-46f4-418a-a5fe-a3a79b1dbc95/vgzleqpgujlpm9ltdiht.jpg",
    "Created": "2018-04-06T17:24:17.11",
    "Variants": [ … ]
  }
]

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

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