Order cancelled - Commerce Engine Docs

{
  "applied_promotions": [
    {
      "promotion_id": "<string>",
      "savings": 123,
      "product_id": "<string>",
      "variant_id": "<string>",
      "product_name": "<string>",
      "variant_name": "<string>",
      "applied_sequence": 123,
      "scope": "<string>"
    }
  ],
  "applied_coupons": [
    {
      "coupon_id": "<string>",
      "savings": 123,
      "product_id": "<string>",
      "variant_id": "<string>",
      "product_name": "<string>",
      "variant_name": "<string>"
    }
  ],
  "order_number": "<string>",
  "order_date": "2023-11-07T05:31:56Z",
  "payment_success_date": "<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,
  "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,
  "fulfillment_preference": {
    "fulfillment_type": "<string>",
    "pickup_location_id": "<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>",
      "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>"
            }
          ]
        }
      ],
      "seller_id": "<string>",
      "seller_detail": {
        "id": "<string>",
        "trade_name": "<string>",
        "legal_name": "<string>",
        "business_type": "<string>",
        "tax_identification_number": "<string>"
      }
    }
  ],
  "billing_address": {
    "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": "<string>",
    "business_name": "<string>",
    "is_default_billing": true,
    "is_default_shipping": true,
    "nickname": null
  },
  "shipping_address": {
    "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": "<string>",
    "business_name": "<string>",
    "is_default_billing": true,
    "is_default_shipping": true,
    "nickname": null
  },
  "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>"
  },
  "feedback": "<string>",
  "payments": [
    {
      "request_number": "<string>",
      "amount": 123,
      "payment_date": "2023-11-07T05:31:56Z",
      "payment_reference_number": "<string>",
      "payment_method": "<string>",
      "icon_url": "<string>",
      "card_number": "<string>"
    }
  ],
  "shipments": [
    {
      "reference_number": "<string>",
      "total_weight": 123,
      "total_boxes": 123,
      "shipment_items_count": 123,
      "shipment_items": [
        {
          "product_id": "<string>",
          "product_name": "<string>",
          "product_image_url": "<string>",
          "variant_id": "<string>",
          "variant_name": "<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>",
      "tracking_url": "<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",
      "seller_id": "<string>",
      "seller_detail": {
        "id": "<string>",
        "trade_name": "<string>",
        "legal_name": "<string>",
        "business_type": "<string>",
        "tax_identification_number": "<string>"
      }
    }
  ]
}

{
  "message": "<string>",
  "success": true,
  "code": "<string>",
  "error": {}
}

{
  "message": "<string>",
  "success": false,
  "code": "<string>"
}

WEBHOOK

order.cancelled

{
  "applied_promotions": [
    {
      "promotion_id": "<string>",
      "savings": 123,
      "product_id": "<string>",
      "variant_id": "<string>",
      "product_name": "<string>",
      "variant_name": "<string>",
      "applied_sequence": 123,
      "scope": "<string>"
    }
  ],
  "applied_coupons": [
    {
      "coupon_id": "<string>",
      "savings": 123,
      "product_id": "<string>",
      "variant_id": "<string>",
      "product_name": "<string>",
      "variant_name": "<string>"
    }
  ],
  "order_number": "<string>",
  "order_date": "2023-11-07T05:31:56Z",
  "payment_success_date": "<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,
  "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,
  "fulfillment_preference": {
    "fulfillment_type": "<string>",
    "pickup_location_id": "<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>",
      "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>"
            }
          ]
        }
      ],
      "seller_id": "<string>",
      "seller_detail": {
        "id": "<string>",
        "trade_name": "<string>",
        "legal_name": "<string>",
        "business_type": "<string>",
        "tax_identification_number": "<string>"
      }
    }
  ],
  "billing_address": {
    "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": "<string>",
    "business_name": "<string>",
    "is_default_billing": true,
    "is_default_shipping": true,
    "nickname": null
  },
  "shipping_address": {
    "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": "<string>",
    "business_name": "<string>",
    "is_default_billing": true,
    "is_default_shipping": true,
    "nickname": null
  },
  "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>"
  },
  "feedback": "<string>",
  "payments": [
    {
      "request_number": "<string>",
      "amount": 123,
      "payment_date": "2023-11-07T05:31:56Z",
      "payment_reference_number": "<string>",
      "payment_method": "<string>",
      "icon_url": "<string>",
      "card_number": "<string>"
    }
  ],
  "shipments": [
    {
      "reference_number": "<string>",
      "total_weight": 123,
      "total_boxes": 123,
      "shipment_items_count": 123,
      "shipment_items": [
        {
          "product_id": "<string>",
          "product_name": "<string>",
          "product_image_url": "<string>",
          "variant_id": "<string>",
          "variant_name": "<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>",
      "tracking_url": "<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",
      "seller_id": "<string>",
      "seller_detail": {
        "id": "<string>",
        "trade_name": "<string>",
        "legal_name": "<string>",
        "business_type": "<string>",
        "tax_identification_number": "<string>"
      }
    }
  ]
}

{
  "message": "<string>",
  "success": true,
  "code": "<string>",
  "error": {}
}

{
  "message": "<string>",
  "success": false,
  "code": "<string>"
}

Body

application/json

applied_promotions

AppliedPromotion · object[]

required

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

Show child attributes

applied_coupons

AppliedPromotion · object[]

required

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

Show child attributes

order_number

string

Unique, human-readable order identifier used across all order endpoints.

order_date

string<date-time>

status

enum<string>

Current fulfillment status of the order. Progresses from confirmed through shipping stages to complete.

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>

Current payment status. Poll /orders/{order_number}/payment-status after a payment attempt until this is success or failed.

Available options:

pending,

success,

failed,

partially_paid

payment_success_date

string | null

customer_note

string | null

is_promotion_applied

boolean

promotion_discount_amount

number<double>

promotion_discount_percent

number<double>

is_coupon_applied

boolean

coupon_code

string | null

coupon_discount_amount

number<double>

coupon_discount_percent

number<double>

promotion_savings

number<float>

Total savings from auto-applied promotions.

Required range: x >= 0

coupon_savings

number<float>

Total savings from the applied coupon code.

Required range: x >= 0

other_savings

number<float>

Total savings from loyalty points, credit balance, and other non-promotion/coupon discounts.

Required range: x >= 0

total_savings

number<float>

Combined savings across promotions, coupons, and other discounts.

Required range: x >= 0

on_subscription

boolean

subtotal

number<double>

item_total_tax

number<double>

subtotal_including_tax

number<double>

shipping_estimated_cost

number<double>

Required range: x >= 0

shipping_discount_amount

number<double>

Required range: x >= 0

shipping_amount

number<double>

shipping_tax_rate

number<double>

Required range: x >= 0

shipping_tax_amount

number<double>

Required range: x >= 0

shipping_amount_including_tax

number<double>

Required range: x >= 0

fulfillment_preference

CollectInStoreFulfillment · object

How the customer wants to receive their order. Discriminated by fulfillment_type: delivery for home delivery, collect-in-store for in-store pickup, or partial-collect-and-delivery for a mix of both.

CollectInStoreFulfillment
DeliveryFulfillment
PartialCollectAndDelivery

Show child attributes

estimated_delivery_days

integer | null

handling_charge_excluding_tax

number<double>

Required range: x >= 0

handling_charge_tax_amount

number<double>

Required range: x >= 0

handling_charge_including_tax

number<double>

Required range: x >= 0

total_tax

number<double>

grand_total

number<double>

loyalty_points_earned

integer

Required range: x >= 0

loyalty_points_redeemed

integer

Required range: x >= 0

credit_balance_used

integer

to_be_paid

number<double>

order_items_count

integer

order_items

object[]

Show child attributes

billing_address

CustomerAddress · object | null

Show child attributes

shipping_address

CustomerAddress · object | null

Show child attributes

currency

object

Show child attributes

metadata

object | null

Additional metadata associated with the order.

Show child attributes

is_cancellation_allowed

boolean

Whether the order is eligible for cancellation. Only show the cancel action in your UI when this is true.

cancellation_refund_details

object

Breakdown of the refund the customer would receive upon cancellation. Only populated when is_cancellation_allowed is true.

Show child attributes

feedback

string | null

payments

Payments using credit card, debit card

Show child attributes

shipments

OrderShipment · object[]

Show child attributes

Response

Bad request

message

string

required

success

boolean

required

code

string

required

error

object

Order confirmed

Order completed