Overview of API Integration

Overview of API Integration

Overview
API integration enables data communication between an online store and POS.

The following APIs are provided
  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

Unique Id of each combination of a matrix items

String


taxPercentage

Item Tax Percentage

Decimal

20

discountpercentage

item discount percenatage

Decimal

53

itemTimeStamp

itemTimeStamp

Numeric



For more details on API for items, click the link below:

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
    

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
OrderItems
 Order details of the items


rowNo

Serial Number Of Item

numeric


itemId*

Item Id

numeric


itemName

Item Name

string


itemReferenceCode*

Unique Id of each combination of a matrix items

string


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:
API for Create a sales order
API for List all sales orders
API for Retrieve a sales order



    • Related Articles

    • Optical Business Process Overview

      Optical Business Process Overview Purpose: The Optical industry will operate similarly to how an Ophthalmologist (Eye Specialist Doctor) would define the specifics of the power of the right and left eye in the prescription by inspecting their eyes. ...

    • Fertilizer Business Process Overview

      Fertilizer Business Process Overview Purpose: Seasonal in nature, Business and business status are dependent on the amount of rain that falls in a particular year; if enough rain falls, shopkeepers can make greater profits; otherwise, profits are ...

    • E Commerce Integration: Introduction, Process and Benefits

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

    • BFL DO INTEGRATION

      BFL DO INTEGRATION HELP DOCUMENT Purpose of BFL DO Integration: ‌A Delivery order contains the customer details such as eligibility criteria in financial wise and the product details. DO Webpage: Shows the details in web instead of showing in POS. DO ...

    • Overview of Practice data clean up

      Overview The Practice data clean up in RPOS7 provides for cleaning up the transaction data that were created during practice in a live database and not deleting the data stored in the masters, configuration settings and print profiles. This feature ...