Order Create Webhook

Once user completes the transaction, we send a webhook to your server for completing the order placement.

Request Metadata

Field	Description
url	Your server endpoint for handling the webhooks. This is configurable.
method	POST

Request Headers

Field	Description
Content-Type	application/json
X-Api-Key	Your API key

Request Payload

Request Body

Name	Type	Description	Example	Mandatory
id	String	Identifier for Breeze webhook	randomId1233	Yes
eventName	String	Specifies the type of webhook event	ORDER_SUCCEEDED	Yes
content	OrderCreateContent	Content to post	-	Yes

OrderCreateContent

Name	Type	Description	Example	Mandatory
orderId	String	Order id	q8A0DCeE-iz9NKO2VAYnh	Yes
txnId	String	Order Txn id	test-txn-1	Yes
status	String	Order Status	CHARGED	No
payment	Payment	-	-	Yes
billingAddress	Address	-	-	Yes
shippingAddress	Address	-	-	Yes
shippingDetails	ShippingDetails	-	-	No
customer	Customer	-	-	Yes
cart	Cart	-	-	Yes
metaData	Array<JSON>	-	-	No

Payment

Name	Type	Description	Example	Mandatory
method	String	Payment method	CASH	Yes
type	String	Payment type	-	Yes
amount	Double	-	269.50	Yes
currency	String	-	INR	Yes

Address

Name	Type	Description	Example	Mandatory
name	String	Name on address	John Doe	Yes
line1	String		123, Avenue	Yes
line2	String		Bazargate	No
city	String		Mumbai	Yes
district	String		Mumbai	Yes
state	String		Maharashtra	Yes
country	String		IN	Yes
pincode	String		400001	Yes
phoneNumber	String		9989898765	Yes
countryCode	String		+91	Yes

ShippingDetails

Name	Type	Description	Example	Mandatory
rate	Double	Shipping rate	50.00	Yes
rateType	String	AMOUNT/PERCENTAGE	50.00	Yes
provider	String	Name of provider	ShipRocket	Yes

Customer

Name	Type	Description	Example	Mandatory
id	String	Customer id	sdfew3	Yes
phoneNumber	String	Phone number	9989898765	Yes
countryCode	String	phone country code	+91	Yes
name	String	Customer name	John Doe	No
emailAddress	String	Customer email	john.doe@gmail.com	No

Cart

Name	Type	Description	Example	Mandatory
id	String	Your cart Id	x123y3e	Yes
breezeCartId	String	Breeze cart Id	x123y3e	Yes
initialPrice	Double	Initial Price of cart	500.00	Yes
finalPrice	Double	Final Price of cart	450.00	No
totalDiscount	Double	Total discount	50.00	Yes
itemCount	Integer	Item count	3	Yes
items	Array<CartItem>	Item details		Yes
offers	Object	Offer details		No
taxes	Object	Tax details		No
notes	Object	Customer notes for cart		No
utmParams	UTMParameters	UTM params wrt cart		No

CartItem

Name	Type	Description	Example	Mandatory
id	String	Item id	x123y	Yes
initialPrice	Double	Initial Price of cart	500.00	Yes
finalPrice	Double	Final Price of cart	450.00	No
discount	Double	Total discount	50.00	Yes
quantity	Integer	Item count	3	Yes
weight	Integer	Weight in gms	100	No
title	String	Item title	White Shirt	No
image	String	Image url	-	No
tax	Double	Tax applicable	49.00	No
variantId	String	Variant Id of item	X7122122	No
variantTitle	String	Variant title of item	Extra Large	No

UTMParameters

Name	Type	Description	Example	Mandatory
utm_source	String	Marketing referer	921615c4b329562992e5d7242b1e4947	No
utm_medium	String	Marketing medium	921615c4b329562992e5d7242b1e4947	No
utm_campaign	String	Marketing campaign identifier/name	randommarketingcampaign	No

Response Body

If your API successfully processes the webhook, you should return a 200 status code with the following response body:

Name	Type	Description	Example	Mandatory
id	String	Identifier for Breeze webhook	randomId1233	Yes
status	String	Status of the webhook	SUCCESS	Yes
message	String	Message for the webhook	Order placed successfully	Yes
content	OrderCreateResponse	Order related data	-	Yes

OrderCreateResponse

Name	Type	Description	Example	Mandatory
orderId	String	Order id	q8A0DCeE-iz9NKO2VAYnh	Yes
trackingUrl	String	Tracking URL for the order	-	No
trackingId	String	Tracking ID for the order	-	No