Store Order Listings API - API for Shopping - Appy Pie

Store Order Listings

Store Order Listings API allows you to gain access to all your Store order listings that exist in the Store feature. With all the order listings data, you can manage and track customers’ orders across multiple sales channels, remain up-to-date with the reports related to the orders, and perform other necessary functions.

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

Store Order Listings 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:

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

Parameter NameRequiredParameter TypeParameter Description
methodYesStringMethod order-create/order-list is pre-defined.
appIdYesStringApplication ID identifies a specific application on Appy Pie’s platform. You can obtain appID/BID from Appy Pie’s backend.
pageIdYesStringpageId is unique for every feature in the app. To obtain the pageId access the App Features API endpoint and you will get the pageId for the respective feature in the response. For example: the pageId for the Store feature will be like hyperstore_1598258167385_100
pageNumYesIntThe number of result pages to be displayed in the response. Input only number.
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.
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": "order-create/order-list",
9		"appId": "a98f26d92ad5",
10		"pageId": "hyperstore_1624025655126_100",
11		"pageNum": "1"
12	 }' \
13	"https://api.appexecutable.com/V4/webservices/HyperstoreApi.php"

RESPONSE

{
  "result": {
    "msg": "Success",
    "success": 1,
    "data": [
      {
        "_id": "5e1f28306bc967139bb1dc24",
        "orderItems": [
          {
            "cartId": "5e1f282a6bc967139bb1dc22",
            "productId": "5e1d966f1ea7f81595758190",
            "productName": "Sugar",
            "productSku": "SU783487",
            "productImage": "https://example.com/assets/0db7e7a4721c/product/hyperstore_1579066135844.jpg",
            "productPrice": "40.00",
            "salePrice": "38.00",
            "brandName": "",
            "productQuantity": 1,
            "variantCode": "weight",
            "variantValue": "1 kg",
            "discountAmount": "0.00",
            "subtotal": "38.00",
            "status": "1",
            "productShipStatus": {
              "status": "ordered",
              "orderDate": 1579100208,
              "trackStatus": 1
            }
          }
        ],
        "shipmentinfo": [],
        "paymentStatus": "Success",
        "addedon": 1579096443,
        "orderHistory": [
          {
            "status": "pending",
            "statusText": "Pending",
            "date": 1579096443,
            "orderNote": "",
            "notifyCustomer": 0
          }
        ],
        "orderTracking": [
          {
            "status": "pending",
            "statusText": "pending",
            "date": 1579096443,
            "orderNote": "order placed",
            "notifyCustomer": 0
          }
        ],
        "orderId": "Y3JKE1579100208717",
        "pageId": "hyperstore_1624025655126_100",
        "appId": "a98f26d92ad5",
        "userId": 482093,
        "userEmail": "john@example.com",
        "userName": "Sumit Tiwari",
        "billingAddress": {
          "name": "Sxxxxxr",
          "mobile": "8xxxxxxx2",
          "email": "john@example.com",
          "houseNo": "G801",
          "street": "Cloud 9",
          "landmark": "location",
          "city": "city locate",
          "state": "state",
          "country": "country",
          "zip": "2xxxxx1",
          "latitude": 28.645018,
          "longitude": 77.3847985
        },
        "shippingAddress": {
          "name": "Sxxxxxr",
          "mobile": "8xxxxxxx2",
          "email": "john@example.com",
          "houseNo": "G801",
          "street": "Cloud 9",
          "landmark": "location",
          "city": "city locate",
          "state": "state",
          "country": "country",
          "zip": "2xxxxx1",
          "latitude": 28.645018,
          "longitude": 77.3847985
        },
        "status": "pending",
        "couponCode": "",
        "grandTotal": "41.42",
        "shippingAmount": "0.00",
        "shippingDesc": "",
        "subTotal": "38.00",
        "taxAmount": "0.00",
        "discountAmount": "0.00",
        "currencyCode": "INR",
        "customerNote": "",
        "language": "en",
        "coupon_discount": "0.00",
        "bagProductTotal": 40,
        "gstno": "$context.args.gstno",
        "expDeliveryDays": "",
        "orderDate": "1579100208",
        "createdAt": "2020-01-15T14:56:48.722Z",
        "updatedAt": "2020-01-15T14:56:48.722Z",
        "__v": 0,
        "paymentMethod": "cod",
        "paymentTransactionId": "",
        "orderView": 0
      }
    ],
    "totalRecord": 2,
    "pageNum": 1,
    "totalPageNum": 1
  }
}