What is the API to Retrieve a Sales Order?

What is the API 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:8382/WebReporter/api/v1/salesOrder

Method: GET

Authentication: Set Header As

X-Auth-Token : <API - KEY>

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

Response:


{
    "salesOrders":
     [
        {
            "orderPK": 1,
            "onlineReferenceNo": 67,
            "createdAt": "2014-11-28 12:34:33",
            "updatedAt": null,
            "status": "pending",
            "orderRemarks": "newSo",
            "Channel": "ASDFASDF",
            "totalQuantity": 15,
            "totalAmount": 520.4,
            "paymentMode": "1",
            "totalTaxAmount": 19.82,
            "totalDiscountAmount": 0,
            "courierPartner": "ABT",
            "shippingId": "2",
            "shippingName": "Arjun",
            "shippingAddress1": "anna nagar",
            "shippingAddress2": "shennoi nagar",
            "shippingPlace": "near to anna arch",
            "shippingState": "Tamil Nadu",
            "shippingCountry": "india",
            "shippingPincode": "600034",
            "shippingPhone": "04143745365",
            "shippingMobile": "9944577577",
            "shippingEmail": "hja@gmail.com",
            "shippingCharge": 5,
            "shippingMethod": "economy",
            "ShipmentPointsUsed": 5,
            "shipmentItems": 3,
            "shipmentABN": "145",
            "shipmentWeight": 50,
            "discountCoupon": "1",
            "deliveryDate": "2014-11-23 00:00:00",
            "locationId": 1,
            "userId": "ja",
            "customerId": "1006",
            "customerName": "Jagadesh",
            "customerType": "1",
            "customerAddressLine1": "S2,Kalki flats",
            "customerAddressLine2": "durga nagar",
            "customerAddressLine3": "near tambaram sanatorium",
            "customerArea": "Chromepet",
            "customerCity": "",
            "customerState": "tamil nadu",
            "customerCountry": "india",
            "customerPincode": 600047,
            "customerPhone": "9600822216",
            "customerMobile": "",
            "customerEmail": "hja@gmail.com",
            "orderItems":
            [
                {
                    "rowNo": 1,
                    "id": 67,
                    "itemId": 1,
                    "itemName": "APPLE"
                }
            ]
        }
    ]
}


Example:
  1. To retrieve a particular sales order using its id

    Request:
    GET: http://localhost:8382/WebReporter/api/v1/salesOrders/1

    • Related Articles

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

    • API to Create a Sales Order

      Purpose: Used to create Sales Order Resource URL: http://localhost:8382/WebReporter/api/v1/salesOrders Method: POST Authentication: Set Header As X-Auth-Token: <API - KEY> Request: Post: http://localhost:8382/WebReporter/api/v1/salesOrders ...

    • GST tax for Order Type Master

      Purpose :- When a restaurant provides a takeaway or delivery service, the transaction is considered a sale of goods or services, and the restaurant must charge GST on the value of the sale. the purpose of charging GST for takeaway and delivery orders ...

    • How to give the GST for take away and deliver order product?

      Purpose :- When a restaurant provides a takeaway or delivery service, the transaction is considered a sale of goods or services, and the restaurant must charge GST on the value of the sale. the purpose of charging GST for takeaway and delivery orders ...

    • 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... An item with rate and stock API (List all items) Sales order APIs (Create a sales order List all ...