Skip to main content

Order

v1

Description

Once a customer checkouts from the cart, it is considered an order. Get notified whenever someone successfully places an order, or if the payment fails or remains pending.


Supported Type

  • Placed - (Order was created and payment was successful)
  • Pending - (Order was created but payment is pending)
  • Payment_failed - (Order was created but the payment failed)

Payload

{
"event":{
"id":"H5rODIOlcS7kHI6ZV+f1RHjK+BersHn0fyy5TFo3XvY=",
"name":"order",
"type":"placed",
"version":"1",
"trace_id":[
"gringotts.27044230-2b49-11ec-88f9-daea4c987c86"
],
"created_timestamp":1634035373242
},
"payload":{
"order":{
"user":{
"email":"johndoe@gofynd.com",
"mobile":"9988776655",
"last_name":"Mestry",
"first_name":"Pranav"
},
"coupon":{
"coupon_value":0
},
"status":"placed",
"payment":{
"payment_mode":{
"mode":"NB"
},
"price_breakup":{
"discount":0,
"order_value":3353,
"delivery_charges":55
}
},
"order_id":"FY616566A801292E2243",
"shipments":[
{
"id":"16340353691141726632",
"bags":[
{
"item":{
"name":"Black Blouse Top"
},
"store":{
"code":"MBEC01 "
},
"discount":0,
"affiliate_meta":{
"fynd":{
"fulfilment_identifier":"unicommerce"
},
"box_type":null,
"due_date":null,
"coupon_code":null,
"is_priority":false,
"channel_order_id":null,
"loyalty_discount":0,
"employee_discount":0,
"channel_shipment_id":null,
"size_level_total_qty":367
},
"brand_calculated_amount":1499
},
{
"item":{
"name":"Emerald Blouse Top"
},
"store":{
"code":"MBEC01 "
},
"discount":0,
"affiliate_meta":{
"fynd":{
"fulfilment_identifier":"unicommerce"
},
"box_type":null,
"due_date":null,
"coupon_code":null,
"is_priority":false,
"channel_order_id":null,
"loyalty_discount":0,
"employee_discount":0,
"channel_shipment_id":null,
"size_level_total_qty":403
},
"brand_calculated_amount":1799
}
],
"billing_address_json":{
"area":"Sheetal bldg, V.N.Purav Marg",
"city":"Mumbai",
"email":"johndoe@gofynd.com",
"phone":"9988776655",
"state":"Maharashtra",
"country":"India",
"pincode":"400022",
"version":"1.0",
"address1":"205, Tradespark Centre, Opp. Hotel Continental",
"address2":"MIDC, Andheri West",
"landmark":"Narayan Nagar",
"latitude":0,
"longitude":0,
"created_at":"2021-10-12 16:12:49",
"updated_at":"2021-10-12 16:12:49",
"address_type":"home",
"contact_person":"Pranav Mestry",
"address_category":"billing"
},
"delivery_address_json":{
"area":"Sheetal bldg, V.N.Purav Marg",
"city":"Mumbai",
"email":"johndoe@gofynd.com",
"phone":"9988776655",
"state":"Maharashtra",
"country":"India",
"pincode":"400022",
"version":"1.0",
"address1":"205, Tradespark Centre, Opp. Hotel Continental",
"address2":"MIDC, Andheri West",
"landmark":"Narayan Nagar",
"latitude":0,
"longitude":0,
"created_at":"2021-10-12 16:12:49",
"updated_at":"2021-10-12 16:12:49",
"address_type":"home",
"contact_person":"Pranav Mestry",
"address_category":"delivery"
}
}
],
"company_id":873,
"application_id":"000000000000000000000004"
}
},
"contains":[
"order"
],
"company_id":873,
"application_id":"000000000000000000000004"
}

Object Properties

KeyTypeDescription
statusStringState of the order, e.g. placed, confirmed, cancelled
order_idStringUnique identification of an order
company_idIntegerUnique identification of a company
application_idStringUnique identification of an application
userObjectPurchaser's Details such as name, last name, mobile no. and email
paymentObjectObject containing payment mode and payment breakup
payment_modeStringMode of payment, e.g., NB, UPI, Wallet, Card, COD, etc.
price_breakupObjectObject containing discount, order value and delivery charges
discountIntegerThe total amount discounted from the original MRP/actual price
delivery_chargesIntegerThe amount charged for delivery apart from the product price
order_valueIntegerValue of the order
couponObjectDetails of the applied coupon
shipmentsObjectObject containing the shipment details
idStringUnique ID of the shipment
billing_address_jsonObjectAddress linked to the customer's bank
delivery_address_jsonObjectAddress where the customer wants the order delivered
bagsObjectObject containing the bag details
brand_calculated_amountIntegerUnit price of a bag
discountIntegerDiscount received on the shipment
itemObjectObject containing the product details
storeObjectObject containing the selling location's details
affiliate_metaObjectInformation about the marketplace