Supplier

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

List Supplier

Request

Bodyapplication/json
PageNumberintegerrequired

Number of page begin. this is primary key for the object

Example: 1
PageSizeintegerrequired

Page size of list supplier. this is primary key for the object

Example: 20
curl -i -X GET \
  https://subdomain.dealpos.net/api/v3/Supplier \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "PageNumber": 1,
    "PageSize": 20
  }'

Responses

Bodyapplication/jsonArray [
Namestring

the name of supplier to be shown

Codestring

the supplier code of the supplier to be shown

Phonestring

the phone number of supplier to be shown

Mobilestring

the mobile phone number of supplier to be shown

Emailstring

the email of the supplier to be shown

]
Response
application/json
[
  {
    "Name": "A WI",
    "Code": "TIA20887",
    "Phone": "0811698616",
    "Mobile": "0811698616",
    "Email": "secyliac@gmail.com"
  },
  {
    "Name": "a. asyura alikha",
    "Code": "TIA9981",
    "Phone": "082188891313",
    "Mobile": "082188891313",
    "Email": "asyuraalikha@gmail.com"
  },
  {
    "Name": "A. Dalaisa A. Beso",
    "Code": "TIA21264",
    "Phone": "087884993345",
    "Mobile": "087884993345",
    "Email": "ndisabeni@yahoo.com"
  }
]

Create Supplier

Request

Create a supplier based on the name

You must have “CREATE” role in “Contacts” Module

Bodyapplication/json
Emailstringrequired

Email address of Supplier

Namestringrequired

Name of supplier. This is primary key for the object

FirstNamestring

First name of supplier

LastNamestring

Last name of supplier

Phonestring

Phone number of supplier

Mobilestringrequired

Mobile number of supplier

Addressstring

Address of Supplier

Genderstring

Gender of supplier

Enum"Male""Female"
Codestringrequired

Code member of supplier

Groupstring

Group of supplier

ImageURLstring

Supplier's photo URL

Statusstringrequired
Default "Active / WaitingForApproval / Suspended"
curl -i -X POST \
  https://subdomain.dealpos.net/api/v3/Supplier \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "Email": "hendry@outlook.com",
    "Name": "Hendry Wijaya",
    "FirstName": "Hendry",
    "LastName": "Wijaya",
    "Phone": "0216892235",
    "Mobile": "0815896321227",
    "Address": "Jl.Pluit Karang Jelita no 51",
    "Gender": "Male",
    "Status": "Active",
    "Code": "HW0021",
    "Group": "Gold",
    "ImageURL": "https://encrypted-tbn0.gstatic.com/images?q=tbn%3AANd9GcR5MITQo_ngwwEGEZqlw7PQLiaO21AoYmLRSkSF5Q2UwJuPgYZx"
  }'

Responses

Bodyapplication/json
IDstring

ID of supplier created

Response
application/json
{
  "ID": "8e92164f-4826-4984-8d1d-7a7280851170"
}

Update Supplier By Code

Request

Update a supplier based on customer code

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

Bodyapplication/json
Emailstringrequired

Email address of Supplier

Namestringrequired

Name of supplier. This is primary key for the object

FirstNamestring

First name of supplier

LastNamestring

Last name of supplier

Phonestring

Phone number of supplier

Mobilestringrequired

Mobile number of supplier

Addressstring

Address of Supplier

Genderstring

Gender of supplier

Enum"Male""Female"
Codestringrequired

Code member of supplier

Groupstring

Group of supplier

ImageURLstring

Supplier's photo URL

Statusstringrequired
Default "Active / WaitingForApproval / Suspended"
curl -i -X PUT \
  https://subdomain.dealpos.net/api/v3/Supplier/ByCode \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "Code": "0011",
    "Name": "Hendry Wijaya",
    "FirstName": "Hendry",
    "LastName": "Wijaya",
    "Email": "hendryw@gmail.com",
    "Phone": "0216892235",
    "Mobile": "081589632178",
    "Address": "Jl.Pluit Karang Jelita no 51",
    "Gender": "Male",
    "Group": "Gold",
    "Status": "Active"
  }'

Responses

Bodyapplication/json
IDstring

Supplier has been deleted successfully

Response
application/json
{
  "ID": "4b237266-a20d-4979-87e9-685b8fd41658"
}

Delete Supplier By Code

Request

Delete a supplier based on customer code

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

Bodyapplication/json
Codestringrequired

Supplier code of the customer. this is primary key for the object

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

Responses

Bodyapplication/json
Messagestring

the supplier has been deleted

Response
application/json
{
  "Message": "Customer ID: 4b237266-a20d-4979-87e9-685b8fd41658 has been deleted successfully."
}

Get Supplier By Code

Request

Get supplier based on supplier code

Required Group Role: "Contacts" - "VIEW"

Bodyapplication/json
Codestringrequired

Member Code of supplier. this is primary key of the object

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

Responses

Bodyapplication/json
Namestring

Supplier's name

Emailstring

Supplier's email

Titlestring or null

Supplier's title

FirstNamestring

Supplier's first name

LastNamestring

Supplier's last name

Genderstring

Supplier's gender

Codestring

Supplier's code

Phonestring

Supplier's phone

MobilePhonestring

Supplier's mobile phone

Addressstring

Supplier's address