v1

latestOpenAPI 3.1.02026-07-241120379.1 KB

List order history

This API fetches list of past orders of a specific subscription based on subscriptionId in the path params.

Rate limit - 5/s

get/2023-10/subscription/{subscriptionId}/order/history

Path parameters

subscriptionIdstring required

The loop subscriptionId for which the order history has to be fetched

Response

200

successboolean

messagestring

codestring

{"stackTrail":"paths:/2023-10/subscription/{subscriptionId}/order/history:get:responses:200:content:application/json:schema:properties:pageInfo","oasType":"schema","type":"unknown"}

Example response

{
  "success": true,
  "message": "Order history fetched successfully",
  "data": [
    {
      "id": 63774628,
      "shopifyId": 5808406954293,
      "status": "PROCESSED",
      "billingDate": "2024-01-12T05:00:46.000Z",
      "financialStatus": "paid",
      "shopifyCreatedAt": "2023-11-03T00:43:04.000Z",
      "shopifyProcessedAt": "2023-11-03T00:43:04.000Z",
      "shopifyUpdatedAt": "2023-11-03T00:43:08.000Z",
      "currencyCode": "USD",
      "totalPriceUsd": "77.92",
      "totalDiscount": "7.35",
      "totalLineItemsPrice": "54.05",
      "totalShippingPrice": "22.82",
      "shopifyOrderNumber": 2292,
      "lines": [
        {
          "productShopifyId": 8441396035893,
          "variantShopifyId": 45715132481845,
          "name": "Zero product",
          "productTitle": "Zero product",
          "quantity": 1
        }
      ],
      "shippingAddress": {
        "name": "Gautam Nirala",
        "city": "Delhi",
        "zip": "110009",
        "address1": "2346 Hudson Lane GTB Nagar",
        "provinceCode": "DL",
        "countryCode": "IN"
      }
    }
  ],
  "code": "SUCCESS"
}