Order created

Body

application/json

applied_promotions

AppliedPromotion · object[]

required

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

Show child attributes

applied_promotions.promotion_id

string

required

applied_promotions.promotion_type

enum<string>

required

Available options:

discount,

free-goods,

free-shipping,

buy-x-get-y,

volume-based

applied_promotions.savings

number

required

applied_promotions.product_id

string | null

required

applied_promotions.variant_id

string | null

required

applied_promotions.product_name

string | null

required

applied_promotions.variant_name

string | null

required

applied_promotions.applied_sequence

number

required

applied_promotions.scope

string

required

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

applied_coupons.coupon_id

string

required

applied_coupons.coupon_type

enum<string>

required

Available options:

discount,

free-goods,

fixed-price,

free-shipping,

buy-x-get-y,

volume-based,

accelerated-rewards

applied_coupons.savings

number

required

applied_coupons.product_id

string | null

required

applied_coupons.variant_id

string | null

required

applied_coupons.product_name

string | null

required

applied_coupons.variant_name

string | null

required

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

Required range: x >= 0

coupon_savings

number<float>

Required range: x >= 0

other_savings

number<float>

Required range: x >= 0

total_savings

number<float>

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

CollectInStoreFulfillment
DeliveryFulfillment
PartialCollectAndDelivery

Show child attributes

fulfillment_preference.fulfillment_type

string

required

Allowed value: "collect-in-store"

fulfillment_preference.pickup_location_id

string

required

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

order_items.product_id

string

required

order_items.product_name

string

required

order_items.product_image_url

string | null

required

order_items.product_type

enum<string>

required

Available options:

physical,

digital,

bundle

order_items.sku

string

required

order_items.slug

string

required

order_items.variant_id

string | null

required

order_items.variant_name

string | null

required

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.

order_items.on_promotion

boolean

required

order_items.on_subscription

boolean

required

order_items.subscription_plan

string | null

required

order_items.subscription_interval

integer | null

required

order_items.subscription_frequency

string | null

required

order_items.quantity

integer

required

Required range: x >= 0

order_items.free_quantity

integer

required

Required range: x >= 0

order_items.is_free_item

boolean

required

order_items.price_including_tax

boolean

required

order_items.selling_price

number<double>

required

Required range: x >= 0

order_items.listing_price

number<double>

required

Required range: x >= 0

order_items.selling_price_excluding_tax

number<double>

required

Required range: x >= 0

order_items.promotion_discount_amount

number<double>

required

Required range: x >= 0

order_items.coupon_discount_amount

number<double>

required

Required range: x >= 0

order_items.tax_type

string

default:GST

required

Allowed value: "GST"

order_items.tax_rate

number<double>

required

Required range: x >= 0

order_items.tax_amount

number<double>

required

Required range: x >= 0

order_items.handling_charge_excluding_tax

number<double>

required

Required range: x >= 0

order_items.handling_charge_tax_rate

number<double>

required

Required range: x >= 0

order_items.handling_charge_including_tax

number<double>

required

Required range: x >= 0

order_items.associated_options

AssociatedOption · object

Used when variant_id is not null.

Show child attributes

order_items.associated_options.{key}

ColorOption · object

ColorOption
SingleSelectOption

Show child attributes

order_items.associated_options.{key}.name

string

required

The name of the associated option.

order_items.associated_options.{key}.type

any

required

The type of the associated option.

order_items.associated_options.{key}.value

object

required

Show child attributes

order_items.associated_options.{key}.value.hexcode

string<color-hex>

required

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

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"
  }
}

order_items.attributes

Attribute for colors

ColorAttribute
SingleSelectAttribute
MultiSelectAttribute
TextAttribute
DateAttribute
NumberAttribute
BooleanAttribute

Show child attributes

order_items.attributes.id

string

required

order_items.attributes.name

string

required

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

order_items.attributes.type

string

required

Example:

"color"

order_items.attributes.value

object[]

required

Show child attributes

order_items.attributes.value.name

string

required

order_items.attributes.value.hexcode

string<color-hex>

required

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

billing_address

object

Show child attributes

billing_address.first_name

string

required

billing_address.last_name

string | null

required

billing_address.country_code

string

required

Two-letter code begin with a plus sign prefix that identifies different countries. By default it will be +91 if not provided.

billing_address.phone

string

required

10 digit phone number without country code.

billing_address.email

string

required

billing_address.address_line1

string

required

billing_address.address_line2

string | null

required

billing_address.landmark

string | null

required

billing_address.pincode

string

required

billing_address.city

string

required

billing_address.state

string

required

billing_address.country

string

required

Allowed value: "India"

billing_address.tax_identification_number

string | null

required

Tax Identification Number (TIN/VAT/GSTIN) specific to the country of operation.

billing_address.business_name

string | null

required

Use in billing & shipping details only.

billing_address.id

string | null

null value for guest checkout.

shipping_address

object

Show child attributes

shipping_address.first_name

string

required

shipping_address.last_name

string | null

required

shipping_address.country_code

string

required

Two-letter code begin with a plus sign prefix that identifies different countries. By default it will be +91 if not provided.

shipping_address.phone

string

required

10 digit phone number without country code.

shipping_address.email

string

required

shipping_address.address_line1

string

required

shipping_address.address_line2

string | null

required

shipping_address.landmark

string | null

required

shipping_address.pincode

string

required

shipping_address.city

string

required

shipping_address.state

string

required

shipping_address.country

string

required

Allowed value: "India"

shipping_address.tax_identification_number

string | null

required

Tax Identification Number (TIN/VAT/GSTIN) specific to the country of operation.

shipping_address.business_name

string | null

required

Use in billing & shipping details only.

shipping_address.id

string | null

null value for guest checkout.

currency

object

Show child attributes

currency.name

string

currency.code

string

currency.symbol

string

metadata

object

Additional metadata associated with the order.

Show child attributes

metadata.{key}

string

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.

Show child attributes

cancellation_refund_details.loyalty_point

integer

loyalty point redeemed will be rollbacked and credited to user account.

cancellation_refund_details.refundable_amount

number

amount that will be refunded to customer.

cancellation_refund_details.cancellation_charges

number

amount deducted from paid amount.

cancellation_refund_details.cancellation_charges_reason

string

reason for cancellation charges.

cancellation_refund_details.payment_mode

enum<string>

payment mode for refund.

Available options:

original-payment-mode,

bank-transfer

feedback

string | null

payments

(CardPayment · object | NetbankingPayment · object | UpiPayment · object | WalletPayment · object | BankTransfer · object)[]

Order Payment

CardPayment
NetbankingPayment
UpiPayment
WalletPayment
BankTransfer

Show child attributes

payments.transaction_type

enum<string>

Available options:

payment,

refund

payments.request_number

string

payments.amount

number<double>

payments.payment_status

enum<string>

Available options:

pending,

success,

failed,

partially_paid,

refund_initiated

payments.payment_date

string<date-time>

payments.payment_reference_number

string | null

payments.payment_method

string | null

payments.icon_url

string | null

payments.card_number

string

masked card number e.g. ************1111

payments.card_type

enum<string>

Available options:

Visa,

Master Card,

Rupay,

American Express

Response

Bad request

message

string

required

success

boolean

required

code

string

required

error

object

Introduction

🛍️ Commerce

🙋 Customers

🎟️ Engagement & Retention

🧰 Utilities

POS

Store Config

🔔 Webhooks

Body

Response