Retrieve all orders

GET

orders

curl --request GET \
  --url https://services.commercengine.dev/api/v1/x2yh61zw4k/admin/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>",
            "sku": "<string>",
            "on_offer": true,
            "on_promotion": true,
            "on_subscription": true,
            "subscription_plan": "<string>",
            "subscription_interval": 123,
            "subscription_frequency": "<string>",
            "quantity": 123,
            "free_quantity": 123,
            "is_free_item": true,
            "selling_price": 123,
            "listing_price": 123,
            "promotion_discount_amount": 123,
            "coupon_discount_amount": 123,
            "tax_type": "GST",
            "tax_rate": 123,
            "tax_amount": 123,
            "shipping_additional_cost": 123
          }
        ],
        "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": 123,
      "total_pages": 123,
      "previous_page": "<any>",
      "limit": 123,
      "next_page": "<any>"
    }
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200 - application/json

message

string

success

boolean

content

object

content.orders

object[]

content.orders.order_number

string

Unique number associated with the order.

content.orders.order_date

string

Date and time when the order was placed.

content.orders.status

enum<string>

Current status of the order (e.g., "pending," "processing," "shipped," etc.).

Available options:

draft,

awaiting_approval,

cancelled,

shipped,

delivered,

awaiting_shipment

content.orders.payment_status

enum<string>

Current payment status of the order (e.g., "pending," "success," "failed").

Available options:

pending,

success,

failed,

partially_paid

content.orders.payment_success_date

string

Date and time when the payment for the order was successfully processed.

content.orders.has_refund

boolean

Indicates whether the order has a refund associated with it or not.

content.orders.on_subscription

boolean

Indicates whether the order includes subscription items.

content.orders.grand_total

number

Total amount for the order, including all items, taxes, and discounts.

content.orders.loyalty_point_redeemed

integer

Number of loyalty points redeemed in the order.

content.orders.credit_balance_used

integer

Amount of credit balance used in the order.

content.orders.to_be_paid

number

Amount remaining to be paid for the order.

content.orders.order_items_count

integer

Total count of items included in the order.

content.orders.order_items

object[]

content.orders.customer_note

string | null

content.orders.loyalty_point_earned

integer

content.orders.currency

object

content.orders.created_at

string

content.orders.modified_at

string

content.pagination

object

pagination metadata structure

Retrieve all reviews Create order

curl --request GET \
  --url https://services.commercengine.dev/api/v1/x2yh61zw4k/admin/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>",
            "sku": "<string>",
            "on_offer": true,
            "on_promotion": true,
            "on_subscription": true,
            "subscription_plan": "<string>",
            "subscription_interval": 123,
            "subscription_frequency": "<string>",
            "quantity": 123,
            "free_quantity": 123,
            "is_free_item": true,
            "selling_price": 123,
            "listing_price": 123,
            "promotion_discount_amount": 123,
            "coupon_discount_amount": 123,
            "tax_type": "GST",
            "tax_rate": 123,
            "tax_amount": 123,
            "shipping_additional_cost": 123
          }
        ],
        "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": 123,
      "total_pages": 123,
      "previous_page": "<any>",
      "limit": 123,
      "next_page": "<any>"
    }
  }
}

API Documentation

Authentication APIs

Catalog APIs

Cart & Checkout APIs

Coupons & promotions API

Customers API

Orders APIs

Shipping APIs

Payments API

Common API

Analytics

Campaigns API

Authorizations

Response