GET
/
orders
/
{order_number}
curl --request GET \
  --url https://staging.api.commercengine.io/api/v1/{store_id}/storefront/orders/{order_number} \
  --header 'Authorization: Bearer <token>'
{
  "message": "order details",
  "success": true,
  "content": {
    "order": {
      "order_number": "<string>",
      "order_date": "2023-11-07T05:31:56Z",
      "status": "draft",
      "payment_status": "pending",
      "payment_success_date": "<string>",
      "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,
      "applied_promotions": [
        {
          "promotion_id": "<string>",
          "promotion_type": "discount",
          "savings": 123,
          "product_id": "<string>",
          "variant_id": "<string>",
          "product_name": "<string>",
          "variant_name": "<string>",
          "applied_sequence": 123,
          "scope": "<string>"
        }
      ],
      "applied_coupons": [
        {
          "coupon_id": "<string>",
          "coupon_type": "discount",
          "savings": 123,
          "product_id": "<string>",
          "variant_id": "<string>",
          "product_name": "<string>",
          "variant_name": "<string>"
        }
      ],
      "promotion_savings": 1,
      "coupon_savings": 1,
      "other_savings": 1,
      "total_savings": 1,
      "on_subscription": true,
      "subtotal": 123,
      "item_total_tax": 123,
      "subtotal_including_tax": 123,
      "shipping_estimated_cost": 1,
      "shipping_discount_amount": 1,
      "shipping_amount": 123,
      "shipping_tax_rate": 1,
      "shipping_tax_amount": 1,
      "shipping_amount_including_tax": 1,
      "shipping_provider_id": "<string>",
      "courier_company_id": "<string>",
      "handling_charge_excluding_tax": 1,
      "handling_charge_tax_amount": 1,
      "handling_charge_including_tax": 1,
      "total_tax": 123,
      "grand_total": 123,
      "loyalty_point_redeemed": 123,
      "loyalty_point_earned": 123,
      "loyalty_points_earned": 1,
      "loyalty_points_redeemed": 1,
      "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>"
                }
              ]
            }
          ]
        }
      ],
      "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": "<string>",
        "tax_identification_number": "123456789",
        "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": "<string>",
        "tax_identification_number": "123456789",
        "business_name": "<string>",
        "is_phone_verified": true,
        "is_email_verified": true
      },
      "currency": {
        "name": "<string>",
        "code": "<string>",
        "symbol": "<string>"
      },
      "is_cancellation_allowed": true,
      "cancellation_refund_details": {
        "loyalty_point": 123,
        "refundable_amount": 123,
        "cancellation_charges": 123,
        "cancellation_charges_reason": "<string>",
        "payment_mode": "original-payment-mode"
      },
      "created_at": "2023-11-07T05:31:56Z",
      "modified_at": "2023-11-07T05:31:56Z",
      "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": "<string>",
          "icon_url": "<string>",
          "card_number": "<string>",
          "card_type": "Visa"
        }
      ]
    }
  }
}

Authorizations

Authorization
string
header
required

Access token

Path Parameters

order_number
string
required

order number

Response

200
application/json

OK

The response is of type object.