List all sales orders

How to retrieve all the sales orders?

API for List all Sales Orders (With user validation)

Purpose: Used to retrieve all sales Orders

Resource URL: http://localhost:8482/WebReporter/api/v1/salesOrders

Method: GET

Authentication: Set Header As

X-Auth-Token : <API - KEY>

Request:
GET: http://localhost:8482/WebReporter/api/v1/salesOrders

Response: 

{"salesOrders": 
    [{
        "onlineReferenceNo": 1,
        "createdAt": "2013-11-22 13: 00: 00",
        "updatedAt": "2013-11-22 13: 00: 00",
        "status":"pending",
        "orderRemarks":"",
        "Channel":"",
        "courierPartner":"",
        "totalQuantity": 10,
        "totalAmount": 100,
        "paymentMode": 1,
        "totalTaxAmount": 2,
        "totalDiscountAmount": 0,
        "shippingId":1,
        "shippingName": "naveen",
        "shippingAddress1": "ram nagar",
        "ShippingAddress2": "",
        "shippingPlace": "chennai",
        "shippingState": "Tamil Nadu",
        "shippingCountry": "india",
        "shippingPincode": 600042,
        "shippingPhone": "04142225488",
        "shippingMobile": "9597045243",
        "shippingEmail": "naveensftwr@gmail.com",
        "shippingCharge": 0,
        "shippingMethod":"",
        "ShipmentPointsUsed":"",
        "shipmentItems":"",
        "shipmentAbn":"",
        "shipmentWeight":"",
        "discountCoupon":"",
        "deliveryDate": "2013-11-22 13: 00: 00",
        "locationId": 1,
        "userId": "admin",
        "orderItems": [
                {
                    "rowNo": 1,
                    "itemId": 1,
                    "itemName": "lux",
                    "itemReferenceCode":"",
                    "salePrice": 10,
                    "quantity": 10,
                    "itemAmount": 100,
                    "taxPercentage": 2,
                    "discountPercentage": 0,
                    "itemRemarks":"",
                    "itemMarketPrice":""
                }
                ],
        "customerId": 1,
        "customerName": "naveen",
        "customerAddressLine1": "chennai",
        "customerAddressLine2": "chennai",
        "customerAddressLine3": "",
        "customerArea": "velachery",
        "customerCity": "chennai",
        "customerState": "tamil nadu",
        "customerCountry": "india",
        "customerPincode": 600042,
        "customerPhone": "04142225488",
        "customerEmail": "naveensftwr@gmail.com",
        "customerMobile": "9597045243"

   },
  {
        "onlineReferenceNo": 2,
        "createdAt": "2013-11-22 13: 00: 00",
        "updatedAt": "2013-11-22 13: 00: 00",
        "status":"pending",
        "orderRemarks":"",
        "Channel":"",
        "courierPartner":"",
        "totalQuantity": 10,
        "totalAmount": 100,
        "paymentMode": 1,
        "totalTaxAmount": 2,
        "totalDiscountAmount": 0,
        "shippingId":1,
        "shippingName": "naveen",
        "shippingAddress1": "ram nagar",
        "ShippingAddress2": "",
        "shippingPlace": "chennai",
        "shippingState": "Tamil Nadu",
        "shippingCountry": "india",
        "shippingPincode": 600042,
        "shippingPhone": "04142225488",
        "shippingMobile": "9597045243",
        "shippingEmail": "naveensftwr@gmail.com",
        "shippingCharge": 0,
        "shippingMethod":"",
        "ShipmentPointsUsed":"",
        "shipmentItems":"",
        "shipmentAbn":"",
        "shipmentWeight":"",
        "discountCoupon":"",
        "deliveryDate": "2013-11-22 13: 00: 00",
        "locationId": 1,
        "userId": "admin",
        "orderItems": [
                {
                    "rowNo": 1,
                    "itemId": 1,
                    "itemName": "lux",
                    "itemReferenceCode":"",
                    "salePrice": 10,
                    "quantity": 10,
                    "itemAmount": 100,
                    "taxPercentage": 2,
                    "discountPercentage": 0,
                    "itemRemarks":"",
                    "itemMarketPrice":""
                }
                ],
        "customerId": 1,
        "customerName": "naveen",
        "customerAddressLine1": "chennai",
        "customerAddressLine2": "chennai",
        "customerAddressLine3": "",
        "customerArea": "velachery",
        "customerCity": "chennai",
        "customerState": "tamil nadu",
        "customerCountry": "india",
        "customerPincode": 600042,
        "customerPhone": "04142225488",
        "customerEmail": "naveensftwr@gmail.com",
        "customerMobile": "9597045243"

   }]
}

Examples:

1. To retrieve sales orders in between a period

Request:
GET: http://localhost:8482/WebReporter/api/v1/salesOrders?q=createdAt>=2014-10-22 00: 00: 00,createdAt<=2014-09-22 00: 00: 00


2. To retrieve top '50' sales orders

Request:

GET: http://localhost:8482/WebReporter/api/v1/salesOrders?limit=50


3. To retrieve next 50 sales orders (from 51 - 100)
Request:
GET: http://localhost:8482/WebReporter/api/v1/salesOrders?page=2&limit=50

4. To sort the order of sales orders based on the created date and time

Request:

GET: http://localhost:8482/WebReporter/api/v1/salesOrders?order=CreatedAt [For ascending]
GET: http://localhost:8482/WebReporter/api/v1/salesOrders?order=CreatedAt desc [For descending]

Limitation:
A maximum of 250 sales orders alone can be retrieved in one time.

    • Related Articles

    • Block Sales Order Quantity

      Block Sales Order Quantity Purpose: Blocking the sales order quantity in a point of sale (POS) system is to reserve the product stock so that no one can sell the reserved quantity. This can help prevent overselling, which can lead to back-orders, ...

    • Alert Cashier beyond Sales Limit

      Alert Cashier beyond Sales Limit Purpose: This helps in control inventory and prevent loss due to overstocking or other issues that can arise when sales go beyond what is sustainable for the business. When the sales limit is reached, an alert message ...

    • How to retrieve a sales order?

      API for Retrieve a sales order (With user validation) Purpose: Used to retrieve a sales Order Resource URL: http://localhost:8482/WebReporter/api/v1/salesOrder Method: GET Authentication: Set Header As X-Auth-Token: <API - KEY> Request: GET: ...

    • Sales Order/Quotation/Proforma

      Sales quotation refers to the price estimates of the products that a customer wants to buy i.e. quoting price for the products/services. It is typically created as a draft order which includes prices, terms of sale, and description of items. If the ...

    • Strip Wise Sales and Sales Return in Pharmacy Vertical

      Strip Wise Sales and Sales Return in Pharmacy Vertical Purpose: 1. Customized Sales Process: Strip wise sales in a pharmacy POS allow for a customized sales process tailored to the specific needs of the pharmacy vertical. It recognizes that ...