What is API Integration and Which API do we provide for Website integration

What is API Integration? Which API do we provide for Website integration?

Overview


API integration enables data communication, information exchange between an online store and the POS system.
We provide the following APIs...
  1. An item with rate and stock API (List all items)
  2. Sales order APIs (Create a sales order List all sales orders, retrieve a sales order)
API to get Items with rate and stock
  • To List all Items
Items Attributes
 

Attributes

Description

Data Type

Length

itemId

Item Code

Int


itemName

Item Name

string

100

locationId

Item Branch Id

Int


Stock

List of details about item

array



stock

Item Stock detail

Decimal

20

mrp

Item Mrp Price

Decimal

20

salePrice

Item Sell Price

Decimal

30

itemReferenceCode

Item Code

Int


taxPercentage

Item Tax Percentage

Decimal

20

discountpercentage

Item Discount Percentage

Decimal

53

itemTimeStamp

Item Time Stamp

Numeric



For more details on API for List All Items, click API for List All Items

API for Sales order
  • To create a sales order
  • To retrieve a sales order
  • To list all sales orders
Sales Order Attributes
 

Attributes

Description

Data Type

Length

onlineReferenceNo*

Sale Order Id

numeric


createdAt*

Order Created Time (YYYY-MM-DD HH:MM:SS)

datetime

100

updatedAt

Order Updated Time (YYYY-MM-DD HH:MM:SS)

datetime

100

status

Order Status (Pending,Cancel,Delivered)

string

19

orderRemarks

Customer remarks if any

string

200

Channel

Order received from market or mobile store

string

35

totalQuantity*

Order Quantity

numeric


totalAmount*

Order Total Amount (Inclusive All Taxes And Discounts)

decimal

15

paymentMode

Payment Type (2=Card,1=Cod)

List

2

totalTaxAmount

Total Tax Amount

decimal

15

totalDiscountAmount

Total Discount Amount

decimal

15

courierPartner

Courier Vendor Name

string

50

shippingId*

Shipping Id

string

40

shippingName*

Shipping Name

string

100

shippingAddress1*

Shipping Address 1

string

100

ShippingAddress2

Shipping Address 2

string

100

shippingPlace

Shipping Place

string

50

shippingState*

Shipping State

string

50

shippingCountry*

Shipping Country

string

50

shippingPincode*

Shipping Address Pincode

string

10

shippingPhone

Shipping Address Phone Number

string

50

shippingMobile*

Shipping Owner Mobile Number

string

40

shippingEmail

Shipping Owner Email Id

string

50

shippingCharge

Shipping Charge

decimal

15

shippingMethod (String)

Shipping Method (EXP -Speed ,ECN -Economy)

string

50

ShipmentPointsUsed

Customer reward points[Total accumulated points till now]

decimal

15

shipmentItems

Total line items counts

Int


shipmentAbn

Airway bill number

string

50

shipmentWeight

shipment weight

decimal

50

discountCoupon

Discount coupon name

string

50

deliveryDate*

Order Delivery Time (YYYY-MM-DD HH:MM:SS)

datetime

100

locationId

Order Branch Id

numeric


userId

UserId of Ecommerce user

string

15


rowNo

Serial Number Of Item

numeric


itemId

Item Id

numeric


itemName

Item Name

string


itemReferenceCode

Unique Id of each  items

 Int


salePrice

Item Sale Price inclusive of tax & exclusive of discount

decimal


quantity

Item Sale Quantity

numeric


itemAmount

Item Amount inclusive of tax & exclusive of discount

decimal


taxPercentage

Particular Item Tax Id

numeric


discountPercentage

Particular Item discount Percentage

decimal


itemRemarks

Item remarks

string


itemMarketPrice

Item MRP/Market price

decimal


customerId*

Customer Code

numeric


customerName*

Customer Name

string

100

customerType

Customer Type

string

50

customerAddressLine1

Address Line1

string

250

customerAddressLine2

Address Line2

string

250

customerAddressLine3

Address Line3

string

250

customerArea

Customer Area

string

80

customerCity

Customer City

string

50

customerState

Customer State

string

50

customerCountry

Customer Country

string

50

customerPincode*

Customer Address Pincode

string

Int

customerPhone

Customer Phone number

string

30

customerMobile*

Customer Mobile Number

string

40

customerEmail*

customerEmail

string

100

Note: The attributes marked as '*' are mandatory.

For more details on sales order API, click the links below:

    • Related Articles

    • What is E-Commerce Integration?

      Introduction It is an integration solution provided for the POS users to integrate their POS with an online store which is facilitated via API. API acts as an interface between the POS and the online store, integrates the POS data to the online store ...

    • API for List All Sales Orders

      API for List all Sales Orders (With user validation) Purpose: Used to retrieve all sales Orders Resource URL: http://localhost:8382/WebReporter/api/v1/salesOrders Method: GET Authentication: Set Header As X-Auth-Token: <API - KEY> Request: GET: ...

    • How to setup HTTPS on a Windows Server? And how to configure Apache to run SSL/HTTPS server?

      Install Https apache: Download apache_x.x.x-win32-x86-openssl-x.x.x.msi from Apache HTTP SERVER PROJECT Install the apache_x.x.x-win32-x86-openssl-x.x.x.msi setup file. Setting up HTTPS on a Windows Server: Open a command prompt and run the below ...

    • What is ADSR Mall Integration License Sync In RPOS?

      Purpose: The purpose of using ADSR Mall Integration is to provide access for only Sales data to the Mall Owner. Business scenario : In a Mall there are multiple stores like Supermarket,Restaurant,Departmental stores etc.They all are using different ...

    • API for List All Items

      API for Item master with rate and stock details List all Items: Purpose: Used to list all the items Resource URL: http://localhost:8382/WebReporter/api/v1/items Method: GET Authentication: Set Header As X-Auth-Token: <API - KEY>\ Request: GET: ...