Get Orders

This API is used to retrieve a full list of Orders.

Query Parameters

• page number

  Default value: 1

  By default first page will be listed. For navigating through pages, use the page parameter.

• limit number

  Default value: 20

  The number of results to return per request.

Responses

• 200

---

Success response

application/json

• Example

---

{
  "statusCode": 200,
  "data": {
    "results": [
      {
        "_id": "63778f976229523372463162",
        "storeId": 1171,
        "locationId": 1364,
        "userId": "63775bf2622952337246312a",
        "type": "delivery",
        "status": "complete",
        "items": [
          {
            "variation": {
              "_id": 352183,
              "name": "Tomato Basil Penne Pasta"
            },
            "item": {
              "_id": 343468,
              "name": "Penne Pasta"
            },
            "category": {
              "_id": 34259,
              "name": "Pasta"
            },
            "inventoryId": 363731,
            "name": "Tomato Basil Penne Pasta",
            "sku": "777785553444070",
            "quantity": 1,
            "price": 180,
            "mrp": 0,
            "groups": [],
            "subtotal": 180,
            "tax": 0,
            "taxes": [],
            "discount": 0,
            "discounts": [],
            "total": 180,
            "_id": "6358d8f8ecaf66b30e03d1fd"
          },
          {
            "variation": {
              "_id": 352184,
              "name": "Creamy Garlic Penne Pasta"
            },
            "item": {
              "_id": 343468,
              "name": "Penne Pasta"
            },
            "category": {
              "_id": 34259,
              "name": "Pasta"
            },
            "inventoryId": 363732,
            "name": "Creamy Garlic Penne Pasta",
            "sku": "777785553444071",
            "quantity": 1,
            "price": 180,
            "mrp": 0,
            "groups": [],
            "subtotal": 180,
            "tax": 0,
            "taxes": [],
            "discount": 0,
            "discounts": [],
            "total": 180,
            "_id": "6358d922ecaf66b30e03d207"
          }
        ],
        "bill": {
          "subtotal": 360,
          "tax": 0,
          "taxes": [],
          "discount": 0,
          "discounts": [],
          "charge": 0,
          "charges": [],
          "roundOff": 0,
          "total": 360
        },
        "payments": [
          {
            "paymentMethodId": 1,
            "name": "Cash",
            "slug": "cash",
            "amount": 0,
            "status": "complete"
          }
        ],
        "billingAddress": {
          "annotation": "Home",
          "line": "Plot No 52, Balarishna Nagar, 1st Street, Thiruninravur",
          "area": "Thiruninravur",
          "city": "Chennai",
          "state": "Tamil Nadu",
          "country": "India",
          "zip": "602024",
          "landmark": "Near Kamban Park",
          "coordinates": [
            0,
            0
          ],
          "default": false,
          "_id": "63526083733e9dc27c656f89"
        },
        "shippingAddress": {
          "annotation": "Home",
          "line": "Plot No 52, Balarishna Nagar, 1st Street, Thiruninravur",
          "area": "Thiruninravur",
          "city": "Chennai",
          "state": "Tamil Nadu",
          "country": "India",
          "zip": "602024",
          "landmark": "Near Kamban Park",
          "coordinates": [
            0,
            0
          ],
          "default": false,
          "_id": "63526083733e9dc27c656f89"
        },
        "scheduledAt": "2022-10-27T09:49:46.000Z",
        "createdAt": "2022-10-26T07:28:55.441Z",
        "user": {
          "_id": "63775bf2622952337246312a",
          "email": {
            "id": "harish@bytize.in",
            "verified": true
          },
          "mobile": {
            "code": "+91",
            "number": "9962794005",
            "verified": true
          },
          "dob": "Mon Jul 05 1993 05:30:00 GMT+0530 (India Standard Time)",
          "gender": "Male",
          "name": "Harish Mohan"
        }
      }
    ],
    "pagination": {
      "currentPage": 1,
      "lastPage": 1,
      "perPage": 20,
      "totalResults": 16
    }
  }
}