GET
/
orders
curl --request GET \
  --url https://staging.api.commercengine.io/api/v1/{store_id}/storefront/orders \
  --header 'Authorization: Bearer <token>'
{
  "message": "<string>",
  "success": true,
  "content": {
    "orders": [
      {
        "order_number": "<string>",
        "order_date": "2023-11-07T05:31:56Z",
        "status": "draft",
        "payment_status": "pending",
        "payment_success_date": "2023-11-07T05:31:56Z",
        "has_refund": true,
        "on_subscription": true,
        "grand_total": 123,
        "loyalty_point_redeemed": 123,
        "credit_balance_used": 123,
        "to_be_paid": 123,
        "order_items_count": 123,
        "order_items": [
          {
            "product_id": "<string>",
            "product_name": "<string>",
            "product_image_url": "<string>",
            "product_type": "physical",
            "sku": "<string>",
            "slug": "<string>",
            "variant_id": "<string>",
            "variant_name": "<string>",
            "backorder": true,
            "on_offer": true,
            "on_promotion": true,
            "on_subscription": true,
            "subscription_plan": "<string>",
            "subscription_interval": 123,
            "subscription_frequency": "<string>",
            "quantity": 1,
            "free_quantity": 1,
            "is_free_item": true,
            "price_including_tax": true,
            "selling_price": 1,
            "listing_price": 1,
            "selling_price_excluding_tax": 1,
            "promotion_discount_amount": 1,
            "coupon_discount_amount": 1,
            "tax_type": "GST",
            "tax_rate": 1,
            "tax_amount": 1,
            "handling_charge_excluding_tax": 1,
            "handling_charge_tax_rate": 1,
            "handling_charge_including_tax": 1,
            "associated_options": {
              "background_color": {
                "name": "Background Color",
                "value": {
                  "name": "Blue",
                  "hexcode": "#0000FF"
                },
                "type": "color"
              },
              "size": {
                "name": "Size",
                "value": "Large",
                "type": "single-select"
              }
            },
            "attributes": [
              {
                "id": "<string>",
                "name": "<string>",
                "key": "<string>",
                "type": "color",
                "value": [
                  {
                    "name": "<string>",
                    "hexcode": "<string>"
                  }
                ]
              }
            ]
          }
        ],
        "customer_note": "<string>",
        "loyalty_point_earned": 123,
        "currency": {
          "name": "<string>",
          "code": "<string>",
          "symbol": "<string>"
        },
        "created_at": "2023-11-07T05:31:56Z",
        "modified_at": "2023-11-07T05:31:56Z"
      }
    ],
    "pagination": {
      "total_records": 252,
      "total_pages": 26,
      "previous_page": null,
      "next_page": 2,
      "limit": 10
    }
  }
}

Authorizations

Authorization
string
header
required

Access token

Query Parameters

page
number

page number of pagination list

Required range: x >= 1
limit
integer

no of rows per page

Required range: x >= 1
sort_by
string

JSON string format: {"field1":"asc", "field2":"desc"}

Examples:

"{\"country\":\"asc\",\"city\":\"asc\",\"population\":\"desc\"}"

status
string[]

array of string

user_id
string
required

user id

Response

200
application/json

OK

The response is of type object.