API List
- API Introduction
- Authentication Key API
- Server Date and Time
- Embed Image API
- Attachment Download API
- Common lookups API
CRM Integration API
- List of companies with basic details
- Complete details of a company
- List of customers of a branch with basic details
- Register Person
- Register company
- Register address
- Register contact query
- Login ID availability check
- Customer Login API
Delivery / Shipment Order API
Expense Claims Integration API
- Register Expense Claim
- Add expense item to claim
- Save and present claim for approval
- Get list of claims with basic details
- Get claim with all details
Inventory Module Integration API
Sales Module Integration API
- Register Quotation API
- Register Proforma Invoice API
- List of Commercial Invoices
- Number of Commercial Invoices
- Register Invoice API
Shopping Cart Integration API
- Price List API
- Create Shopping Cart Order
- Add product to shopping cart
- Update payment details
- Get order in shopping cart
- List of orders in shopping cart
Procurement Module API
Manufacturing Module API
API # : 8003 | API Name : pricelist
This API gets filtered, sort and ordered records under a specific Price list.
URL : <domain>/apic/pricelist
Methods Allowed : POST
Request Body : JSON Payload
Payload Structure :
Name | Description | Type |
---|---|---|
itemid | ID is the price list. Client will select a price list and provide ID for integration. This is a mandatory field. | String |
search | Search text. System will search in all product fields including
|
String |
show | Currency Code. This is an optional field required only in case of filtering records of a specific currency in case of a multi-currency price map. Examples :
|
String |
show3 | Product Type
1 = Products / Machines 2 = Spare Parts and Accessories |
Integer |
show4 | Brand. Brand name of the products. Multiple brand names can also be passed as semicolon separated list. |
String |
show5 | Color. Hexadecimal color code of the product. For example :
FFFFFF = While 000000 = Black FF0000 = Red |
String |
show6 | PDA 1 | String |
show7 | PDA 2 | String |
show8 | PDA 3 | String |
show9 | PDA 4 | String |
ep1 | Product ID or multiple product IDs as a comma separated string. Use this in case one or multiple specific products data is required. For instance data for static sections in index and other pages, cart pages and confirmation pages where products have already been selected. | String |
ep2 | Category ID. System will return data of the products within the category as well as products in all levels of sub-categories within the category.
Multiple category Ids can also be passed as a semicolon separated list. |
String |
ep3 | Minimum Price | String |
ep4 | Maximum Price | String |
ep6 | Minimum Points / Mean product rating | Number |
ep7 | Maximum Points / Mean product rating | Number |
ep8 | Minimum capacity / size. This parameter works only when capacity / size data has been entered as number. | Number |
ep9 | Maximum capacity / size. This parameter works only when capacity / size data has been entered as number. | Number |
branchid | This parameter is optional and is only required if realtime stock position is needed in the return payload. | String |
pp | Number of records per page. All the matching records are split in sets similar to pages. This value tells the system how many records have to be grouped under each page. Default value is 100 |
Integer |
page | Page number. Default is 1 | Integer |
srt | Sort by. Possible values are :
|
String |
order | Sort Order. ASC or DESC | String |
Request Headers :
Name | Description |
---|---|
device | A short name of your application. Device is mandatory but any value between 3 and 20 characters is accepted. |
Authentication | Authentication code generated for API call. |
Sample Payload :
Sample success response :
Response Interpretation :
Key | Description |
---|---|
totalitems | Total Number of items matching search criteria |
list | Array of list items |
list.tax1 | SGST / GST / VAT |
list.tax2 | CGST / CST, |
list.tax3 | IGST / SERVICE TAX, |
list.tax4 | CESS |
list.number | Product Number |
list.name | Product Name |
list.description | Product Description |
list.brand | Brand |
list.model | Model |
list.pda1 | Custom Product Attribute 1 |
list.pda2 | Custom Product Attribute 2 |
list.pda3 | Custom Product Attribute 3 |
list.pda4 | Custom Product Attribute 4 |
list.itemid | List Item ID |
list.type | Product Type |
list.currency | Currency |
list.price | Item Price per unit |
list.discount | Discount in percentage |
list.unit | Unit (Abbreviation) |
list.unitid | Unit ID |
list.productid | Product ID |
list.hscode | HS Code |