GET
/
orders
/
{order-number}
curl --request GET \
  --url https://services.commercengine.dev/api/v1/x2yh61zw4k/admin/orders/{order-number} \
  --header 'Authorization: Bearer <token>'
{
  "message": "<string>",
  "success": true,
  "content": {
    "order": {
      "order_number": "<string>",
      "order_date": "2023-11-07T05:31:56Z",
      "status": "draft",
      "payment_status": "pending",
      "payment_success_date": "2023-11-07T05:31:56Z",
      "customer_email": "<string>",
      "customer_phone": "<string>",
      "customer_note": "<string>",
      "is_promotion_applied": true,
      "promotion_discount_amount": 123,
      "is_coupon_applied": true,
      "coupon_code": "<string>",
      "coupon_discount_amount": 123,
      "on_subscription": true,
      "subtotal": 123,
      "item_total_tax": 123,
      "subtotal_including_tax": 123,
      "shipping_amount": 123,
      "shipping_total_tax": 123,
      "shipping_amount_including_tax": 123,
      "total_tax": 123,
      "grand_total": 123,
      "loyalty_point_redeemed": 123,
      "credit_balance_used": 123,
      "to_be_paid": 123,
      "loyalty_point_earned": 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
        }
      ],
      "billing_address": {
        "id": "<string>",
        "first_name": "<string>",
        "last_name": "<string>",
        "country_code": "<string>",
        "phone": "<string>",
        "email": "<string>",
        "address_line1": "<string>",
        "address_line2": "<string>",
        "landmark": "<string>",
        "pincode": "<string>",
        "city": "<string>",
        "state": "<string>",
        "country": "India",
        "gstin": "<string>",
        "business_name": "<string>",
        "is_phone_verified": true,
        "is_email_verified": true
      },
      "shipping_address": {
        "id": "<string>",
        "first_name": "<string>",
        "last_name": "<string>",
        "country_code": "<string>",
        "phone": "<string>",
        "email": "<string>",
        "address_line1": "<string>",
        "address_line2": "<string>",
        "landmark": "<string>",
        "pincode": "<string>",
        "city": "<string>",
        "state": "<string>",
        "country": "India",
        "gstin": "<string>",
        "business_name": "<string>",
        "is_phone_verified": true,
        "is_email_verified": true
      },
      "currency": {
        "name": "<string>",
        "code": "<string>",
        "symbol": "<string>"
      },
      "payments": [
        {
          "transaction_type": "payment",
          "request_number": "<string>",
          "amount": 123,
          "payment_status": "pending",
          "payment_date": "2023-11-07T05:31:56Z",
          "payment_reference_number": "<string>",
          "payment_method": "Credit Card",
          "icon_url": "<string>",
          "card_number": "<string>",
          "card_type": "Visa"
        }
      ],
      "shipments": [
        {
          "reference_number": "<string>",
          "status": "pending",
          "total_weight": 123,
          "total_boxes": 123,
          "shipment_items_count": 123,
          "shipment_items": [
            {
              "product_id": "<string>",
              "product_name": "<string>",
              "product_image_url": "<string>",
              "sku": "<string>",
              "quantity": 123,
              "free_quantity": 123,
              "is_free_item": true
            }
          ],
          "shipping_amount": 123,
          "shipping_tax_amount": 123,
          "shipping_amount_including_tax": 123,
          "courier_company_name": "<string>",
          "shipping_label_url": "<string>",
          "awb_no": "<string>",
          "eta_delivery": "<string>",
          "shipped_date": "2023-11-07T05:31:56Z",
          "delivered_date": "2023-11-07T05:31:56Z",
          "cancellation_reason": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "modified_at": "2023-11-07T05:31:56Z"
        }
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "modified_at": "2023-11-07T05:31:56Z"
    }
  }
}

Authorizations

Authorization
string
header
required

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

Path Parameters

order-number
string
required

order number

Response

200 - application/json
OK
message
string
success
boolean
content
object