Retrieve all 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_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": 123,
      "total_pages": 123,
      "limit": 123,
      "next_page": 123,
      "previous_page": 123
    }
  }
}

GET

orders

Retrieve all 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_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": 123,
      "total_pages": 123,
      "limit": 123,
      "next_page": 123,
      "previous_page": 123
    }
  }
}

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"} json string in format {'field_name':'asc', 'other_field_name':'desc', ...}

status

string[]

array of string

user_id

string

required

user id

Response

message

string

success

boolean

content

object

Show child attributes

content.orders

OrderList · object[]

Show child attributes

content.orders.order_number

string

Unique number associated with the order.

content.orders.order_date

string<date-time>

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,

confirmed,

partially_scheduled,

awaiting_shipment,

shipped,

partially_shipped,

undelivered,

partially_undelivered,

return_to_origin,

partially_return_to_origin,

complete,

partially_delivered,

cancelled

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-time>

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<double>

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<double>

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[]

Show child attributes

content.orders.order_items.product_id

string

required

content.orders.order_items.product_name

string

required

content.orders.order_items.product_image_url

string | null

required

content.orders.order_items.product_type

enum<string>

required

Available options:

physical,

digital,

bundle

content.orders.order_items.sku

string

required

content.orders.order_items.slug

string

required

content.orders.order_items.variant_id

string | null

required

content.orders.order_items.variant_name

string | null

required

content.orders.order_items.backorder

boolean

required

backorder

Indicates whether the item is being fulfilled as a backorder. When true, the item is not currently in stock and will ship later once inventory is available. This may result in the order being split into multiple shipments, with delays for the backordered portion.

content.orders.order_items.on_promotion

boolean

required

content.orders.order_items.on_subscription

boolean

required

content.orders.order_items.subscription_plan

string | null

required

content.orders.order_items.subscription_interval

integer | null

required

content.orders.order_items.subscription_frequency

string | null

required

content.orders.order_items.quantity

integer

required

Required range: x >= 0

content.orders.order_items.free_quantity

integer

required

Required range: x >= 0

content.orders.order_items.is_free_item

boolean

required

content.orders.order_items.price_including_tax

boolean

required

content.orders.order_items.selling_price

number<double>

required

Required range: x >= 0

content.orders.order_items.listing_price

number<double>

required

Required range: x >= 0

content.orders.order_items.selling_price_excluding_tax

number<double>

required

Required range: x >= 0

content.orders.order_items.promotion_discount_amount

number<double>

required

Required range: x >= 0

content.orders.order_items.coupon_discount_amount

number<double>

required

Required range: x >= 0

content.orders.order_items.tax_type

string

default:GST

required

Allowed value: "GST"

content.orders.order_items.tax_rate

number<double>

required

Required range: x >= 0

content.orders.order_items.tax_amount

number<double>

required

Required range: x >= 0

content.orders.order_items.handling_charge_excluding_tax

number<double>

required

Required range: x >= 0

content.orders.order_items.handling_charge_tax_rate

number<double>

required

Required range: x >= 0

content.orders.order_items.handling_charge_including_tax

number<double>

required

Required range: x >= 0

content.orders.order_items.associated_options

AssociatedOption · object

Used when variant_id is not null.

Show child attributes

content.orders.order_items.associated_options.{key}

ColorOption · object

ColorOption
SingleSelectOption

Show child attributes

content.orders.order_items.associated_options.{key}.name

string

required

The name of the associated option.

content.orders.order_items.associated_options.{key}.type

any

required

The type of the associated option.

content.orders.order_items.associated_options.{key}.value

object

required

Show child attributes

content.orders.order_items.associated_options.{key}.value.hexcode

string<color-hex>

required

The hex code of the color (e.g., #000000).

content.orders.order_items.associated_options.{key}.value.name

string

required

The name of the color.

Example:

{
  "background_color": {
    "name": "Background Color",
    "value": { "name": "Blue", "hexcode": "#0000FF" },
    "type": "color"
  },
  "size": {
    "name": "Size",
    "value": "Large",
    "type": "single-select"
  }
}

content.orders.order_items.attributes

Attribute for colors

ColorAttribute
SingleSelectAttribute
MultiSelectAttribute
TextAttribute
DateAttribute
NumberAttribute
BooleanAttribute

Show child attributes

content.orders.order_items.attributes.id

string

required

content.orders.order_items.attributes.name

string

required

content.orders.order_items.attributes.key

string

required

A lookup safe version of the name that is lowercased and spaces are replaced with underscores. For instance, if name is Product Type, key will be product_type

content.orders.order_items.attributes.type

string

required

Example:

"color"

content.orders.order_items.attributes.value

object[]

required

Show child attributes

content.orders.order_items.attributes.value.name

string

required

content.orders.order_items.attributes.value.hexcode

string<color-hex>

required

The hex code of the color (e.g., #000000).

content.orders.customer_note

string | null

content.orders.loyalty_point_earned

integer

content.orders.currency

object

Show child attributes

content.orders.currency.name

string

content.orders.currency.code

string

content.orders.currency.symbol

string

content.orders.created_at

string<date-time>

content.orders.modified_at

string<date-time>

content.pagination

object

pagination metadata structure

Show child attributes

content.pagination.total_records

integer

required

content.pagination.total_pages

integer

required

content.pagination.limit

integer

required

content.pagination.next_page

integer | null

required

content.pagination.previous_page

integer | null

Retrieve all promotions

Create order

⌘I

Introduction

🛍️ Commerce

🙋 Customers

🎟️ Engagement & Retention

🧰 Utilities

POS

Store Config

🔔 Webhooks

Retrieve all orders

Authorizations

Query Parameters

Response