WEBHOOK
order.confirmed
{
  "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,
  "promotion_discount_percent": 123,
  "is_coupon_applied": true,
  "coupon_code": "<string>",
  "coupon_discount_amount": 123,
  "coupon_discount_percent": 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>",
  "shipping_provider_name": "<string>",
  "courier_company_id": "<string>",
  "courier_company_name": "<string>",
  "estimated_delivery_days": 123,
  "handling_charge_excluding_tax": 1,
  "handling_charge_tax_amount": 1,
  "handling_charge_including_tax": 1,
  "total_tax": 123,
  "grand_total": 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>"
  },
  "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>"
  },
  "currency": {
    "name": "<string>",
    "code": "<string>",
    "symbol": "<string>"
  },
  "metadata": {},
  "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"
  },
  "feedback": "<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": "<string>",
      "icon_url": "<string>",
      "card_number": "<string>",
      "card_type": "Visa"
    }
  ]
}
{
  "message": "<string>",
  "success": true,
  "code": "<string>",
  "error": {
    "fieldname": [
      "<string>"
    ]
  }
}

Body

application/json
applied_promotions
AppliedPromotion · object[]
required

Information about the promotional offers that have been applied to the cart.

applied_coupons
AppliedPromotion · object[]
required

This key provides details about the savings in cart after coupon have been applied to the cart.

order_number
string
order_date
string<date-time>
status
enum<string>
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,
pending
payment_status
enum<string>
Available options:
pending,
success,
failed,
partially_paid
payment_success_date
string | null
customer_email
string | null
customer_phone
string | null
customer_note
string | null
is_promotion_applied
boolean
promotion_discount_amount
number
promotion_discount_percent
number
is_coupon_applied
boolean
coupon_code
string | null
coupon_discount_amount
number
coupon_discount_percent
number
promotion_savings
number
Required range: x >= 0
coupon_savings
number
Required range: x >= 0
other_savings
number
Required range: x >= 0
total_savings
number
Required range: x >= 0
on_subscription
boolean
subtotal
number
item_total_tax
number
subtotal_including_tax
number
shipping_estimated_cost
number
Required range: x >= 0
shipping_discount_amount
number
Required range: x >= 0
shipping_amount
number
shipping_tax_rate
number
Required range: x >= 0
shipping_tax_amount
number
Required range: x >= 0
shipping_amount_including_tax
number
Required range: x >= 0
shipping_provider_id
string | null
shipping_provider_name
string | null
courier_company_id
string | null
courier_company_name
string | null
estimated_delivery_days
integer | null
handling_charge_excluding_tax
number
Required range: x >= 0
handling_charge_tax_amount
number
Required range: x >= 0
handling_charge_including_tax
number
Required range: x >= 0
total_tax
number
grand_total
number
loyalty_points_earned
integer
Required range: x >= 0
loyalty_points_redeemed
integer
Required range: x >= 0
credit_balance_used
integer
to_be_paid
number
order_items_count
integer
order_items
object[]
billing_address
object | null
shipping_address
object | null
currency
object
metadata
object | null

Additional metadata associated with the order.

is_cancellation_allowed
boolean

order cancellation option should be visible only if this flag is true.

cancellation_refund_details
object

to show refundable details in order cancellation ui.

feedback
string | null
payments
(CardPayment · object | NetbankingPayment · object | UpiPayment · object | WalletPayment · object | BankTransfer · object)[]

Response

Bad request

message
string
required
success
boolean
required
code
string
required
error
object