Appy Pie Food Court Order Listing API - Food Delivery API Docs
Appy Pie API

    Order Listing

    Order Listing API allows you to gain access to all the Order Listing details that exist in the Food Court feature. Using this API, you can obtain the order details including vendor details, product details, delivery boy details, shipping details, etc. in the response which you can use for tracking and other purposes.

    Note: You can refer to the sample code provided on the right side of the screen and switch to your preferred language.

    API Endpoint

    Order Listing API returns the order listing details for the specified App ID. To access this endpoint, login/signup to Appy Pie Developer account and obtain the required AccessToken key from the Authentication section. 

    Below is the request URL and the Method is POST:

    Request URL

    POST https://api.appexecutable.com/V4/webservices/FoodCourtApi.php

    Query Parameters

    Parameter NameRequiredParameter TypeParameter Description
    methodYesStringMethod foodOrderLisitingApi is pre-defined.
    appIdYesStringApplication ID identifies a specific application on Appy Pie’s platform. You can obtain appID/BID from Appy Pie’s backend.
    pageNoYesIntThe number of result pages to be displayed in the response. Input only number.
    langYesStringLanguage
    Required Parameters are mandatory to access the API endpoint.

    Errors

    This error section displays all the errors with details.

    Following are the error codes that indicate the success or failure of an API request:

    Error CodeMeaning
    400Bad Request -- Your request is invalid.
    401Unauthorized -- Your API key is wrong.
    403Forbidden -- The method requested is hidden for administrators only.
    404Not Found -- The specified method could not be found.
    405Method Not Allowed -- You tried to access a method with an invalid method.
    406Not Acceptable -- You requested a format that is not json.
    410Gone -- Request has been removed from our servers.
    429Too Many Requests
    500Internal Server Error -- We had a problem with our server. Try again later.
    503Service Unavailable -- We are temporarily offline for maintenance. Please try again later.
    2032API Key is required
    2034Email is required
    2036Invalid API Key
    2038Provide valid API Key
    2039Email already exists
    2040Phone already exists
    2041Email Invalid
    To authorize, use this code:

    1wget --no-check-certificate --quiet \
2	--method POST \
3	--timeout=0 \
4	--header "ACCESSTOKEN: Access Token Key" \
5	--header "Content-Type: application/json" \
6	--body-data
7	'{
8		"method":"foodOrderLisitingApi",
9		"appId":"3xxxxxxxxxxd",
10		"pageNo":8,
11		"lang":"pt"
12	 }' \
13	"https://api.appexecutable.com/V4/webservices/FoodCourtApi.php"

    RESPONSE

    {
  "orderList": [
    {
      "vendorName": null,
      "vendorLat": null,
      "vendorLong": null,
      "vendoraddress": null,
      "vendorImg": {
        "name": "https://domain.com/imageName.jpg",
        "main_image": 1,
        "type": "image"
      },
      "deliveryboyName": "",
      "noOfProducts": 1,
      "productDetails": [
        {
          "pname": "Test",
          "qty": "6",
          "custom_option": ""
        }
      ],
      "appId": "3xxxxxxxxxxd",
      "orderId": "Axxxxxxxxx3",
      "transactionId": "",
      "orderDate": "Apr-16-2020 13:33",
      "orderLastUpdateDate": "Apr-16-2020 13:34",
      "currency": "USD",
      "paymentMethod": "Pxxxxxxxxxxa",
      "status": "Cancelled",
      "pickupComment": "",
      "orderType": "delivery",
      "is_date_flag": true,
      "deliveryPickupTime": "Apr-16-2020 14:19",
      "subtotal": 1XX,
      "gtotal": "2XXX",
      "delivery": 0,
      "tax": 0,
      "tip": 0,
      "discount": 0,
      "vendorDiscount": "",
      "coupon": 0,
      "misctax": [],
      "trackingDate": "",
      "trackingCarrier": "",
      "trackingNumber": "",
      "trackUrl": "",
      "vendorId": "2XXXX",
      "pubnubChanel": "",
      "waiterLising": {
        "deviceType": "android",
        "deviceToken": "fxxxxx-xxxasdfd",
        "deviceId": "0xxxxxxxxxd",
        "cust_lat": "2xxx.xxx3",
        "cust_long": "7xxx.xxxx7"
      },
      "userDataLising": {
        "deviceType": "android",
        "deviceToken": "fxxxxx-xxxasdfd",
        "deviceId": "0xxxxxxxxxxxxxd",
        "cust_lat": "28.5898353",
        "cust_long": "77.3089147"
      },
      "billing": {
        "name": "Test",
        "address": "billing address",
        "phone": "99xxxxxx99",
        "city": "",
        "state": "",
        "country": "",
        "zip": "",
        "pluscode": ""
      },
      "shipping": {
        "name": "Test",
        "address": "shipping address",
        "phone": "99xxxxxx99",
        "city": "",
        "state": "",
        "country": "",
        "zip": "",
        "pluscode": ""
      },
      "comments_if_cancel": "order cancelled"
    }
  ],
  "chatRoom": {
    "2XXXX": {
      "storecontactus": {
        "contactus_chat": "",
        "contactus_phone": "+9199xxxxxx99"
      }
    }
  },
  "totalPage": 8,
  "status": "success"
}