Application
Events categorised under application/sales channel level will be triggered when any action performed for sales channel. e.g. If new Coupon is created for sales channel.
Events
application/cart/create/v1
# this event is triggered when cart is created
application/cart/update/v1
# this event is triggered when cart is updated
Payload
Properties
application_id
array|string
Required
Application/sales channel ID for which this event is triggered
company_id
integer
Required
company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
event generation timestamp in epoch milliseconds
id
string
Required
Unique ID for an event. This id can be used to verifiy if event is already processed by receiver
name
string
Required
Name of the event
trace_id
array of string
Required
internal trace_id for Fynd Platform services
type
string
Required
Type/Action of the event. e.g. create/update/delete
version
string
Required
Version of the event.
payload
object
Required
Payload details.
Properties
cart
object
Required
Cart details.
Properties
id
string
Required
Unique identifier of the cart.
user_info
object
Required
Properties
user_id
string
Required
Unique identifier of the customer associated with this cart.
is_authenticated
boolean
Required
Flag indicates the user is loggedin or anonymous
comment
string
Required
Comment associated with the cart.
gstin
string|null
Required
GSTIN (Goods and Services Tax Identification Number) associated with the cart.
message
string
Required
Message related to the cart.
success
boolean
Required
Indicates whether the operation with the cart was successful or not.
is_valid
boolean
Required
Indicates whether the cart is valid or not.
last_modified
string
Required
Timestamp indicating the last modification time of the cart.
currency
object
Required
Currency details associated with the cart.
Properties
symbol
string|null
Symbol of the currency.
code
string|null
Code of the currency.
breakup_values
object
Required
Breakup values associated with the cart.
Properties
raw
object
Raw breakup values associated with the cart.
Properties
cod_charge
number
Required
Cash on Delivery charge.
convenience_fee
number
Required
Convenience fee charge.
coupon
number
Required
Coupon discount amount.
delivery_charge
number
Required
Delivery charge.
discount
number
Required
Discount amount.
fynd_cash
number
Required
Fynd Cash amount.
gst_charges
number
Required
GST (Goods and Services Tax) charges.
mop_total
number
Required
MOP (Mode of Payment) total amount.
mrp_total
number
Required
MRP (Maximum Retail Price) total amount.
subtotal
number
Required
Subtotal amount.
total
number
Required
Total amount.
total_charge
number
Required
Total charge amount.
vog
number
Required
VOG (Value of Goods) amount.
you_saved
number
Required
Amount saved.
coupon
object
Coupon details associated with the cart.
Properties
code
null|string
Coupon code applied on cart.
uid
null|string
Required
Unique identifier of the coupon.
is_applied
boolean
Required
Indicates whether the coupon is applied or not.
message
string
Required
Message associated with the coupon.
type
string
Required
Type of the coupon.
value
number
Required
Value of the coupon.
loyalty_points
object
Loyalty points details associated with the cart.
Properties
total
number|null
Total loyalty points.
description
string|null
Description of loyalty points.
is_applied
boolean|null
Indicates whether loyalty points are applied or not.
applicable
number|null
Applicable loyalty points.
display
array of object
Display details associated with the cart.
Array of Properties
attr
string
Required
Attribute of the product.
currency_code
string
Required
Currency code.
currency_symbol
string
Required
Currency symbol.
display
string
Required
Display of the product.
key
string
Required
Key of the product.
message
array of
Required
Message associated with the product.
original
number
Required
Original value of the product.
value
number
Required
Value of the product.
items
array of object
Required
Items in the cart.
Array of Properties
article
object
Article details.
Properties
extra_meta
object
Extra metadata associated with the article.
price
object
Price details associated with the article.
Properties
converted
object
Required
Converted price details.
Properties
currency_code
string
Required
Currency code for the converted price.
currency_symbol
string
Required
Currency symbol for the converted price.
effective
number
Required
Effective price after conversion.
marked
number
Required
Marked price after conversion.
base
object
Required
Base price details.
Properties
currency_code
string
Required
Currency code for the base price.
currency_symbol
string
Required
Currency symbol for the base price.
effective
number
Required
Effective base price.
marked
number
Required
Marked base price.
quantity
integer
Quantity of the article.
seller
object
Seller details associated with the article.
Properties
uid
null|integer
Required
Unique identifier of the seller.
name
null|string
Required
Name of the seller.
size
string
Size of the article.
store
object
Store details associated with the article.
Properties
uid
null|integer
Required
Unique identifier of the store.
name
null|string
Required
Name of the store.
type
string
Type of the article.
uid
string
Unique identifier of the article.
availability
object
Availability details of the article.
Properties
available_sizes
array of object
Available sizes list.
Array of Properties
display
string
Display size.
is_available
boolean
Indicates whether the size is available or not.
value
string
Value of the size.
deliverable
boolean
Indicates whether the article is deliverable or not.
is_valid
boolean
Indicates whether the article is valid or not.
other_store_quantity
integer
Quantity available in other stores.
out_of_stock
boolean
Indicates whether the article is out of stock or not.
sizes
array of string
Sizes available for the article.
bulk_offer
object
Bulk offer details associated with the article.
coupon_message
string
Coupon message associated with the article.
delivery_promise
object|null
Delivery promise details associated with the article.
Properties
formatted
object
Formatted delivery promise timestamps.
Properties
min
string
Required
Formatted minimum delivery promise timestamp.
max
string
Required
Formatted maximum delivery promise timestamp.
iso
object
ISO formatted delivery promise timestamps.
Properties
min
string
Required
ISO formatted minimum delivery promise timestamp.
max
string
Required
ISO formatted maximum delivery promise timestamp.
timestamp
object
Delivery promise timestamps.
Properties
min
integer
Required
Minimum delivery promise timestamp.
max
integer
Required
Maximum delivery promise timestamp.
discount
string
Discount associated with the article.
identifiers
object
Identifiers associated with the article.
Properties
identifier
string
Required
Identifier associated with the article.
is_set
boolean
Indicates whether the article is a set or not.
key
string
Key associated with the article.
message
string
Message associated with the article.
moq
object
Minimum order quantity details associated with the article.
Properties
minimum
integer
Minimum order quantity.
price
object
Price details associated with the article.
Properties
converted
object
Required
Converted price details.
Properties
currency_code
string
Required
Currency code for the converted price.
currency_symbol
string
Required
Currency symbol for the converted price.
effective
number
Required
Price of the product after applying inventory discount and before applying promotion, coupon and engage discount.
marked
number
Required
Original MRP of product.
add_on
number
Required
Add-on price.
selling
number
Required
Selling price.
final_price
number
Final price of the product in cart after applying all discounts such as promotion, coupon and engage discount.
discount
number
Net discount applied on product, contains total discount amount including promotions, coupons and engage discount [excluding inventory discount].
base
object
Required
Base price details.
Properties
currency_code
string
Required
Currency code for the base price.
currency_symbol
string
Required
Currency symbol for the base price.
effective
number
Required
Effective base price.
marked
number
Required
Original MRP of product.
add_on
number
Required
Add-on base price.
selling
number
Required
Selling base price.
final_price
number
Final price of the product in cart after applying all discounts such as promotion, coupon and engage discount.
discount
number
Net discount applied on product, contains total discount amount including promotions, coupons and engage discount [excluding inventory discount].
price_per_unit
object
Price per unit details associated with the article.
Properties
converted
object
Required
Converted price per unit details.
Properties
currency_code
string
Required
Currency code for the converted price per unit.
currency_symbol
string
Required
Currency symbol for the converted price per unit.
effective
number
Required
Effective price per unit after conversion.
marked
number
Required
Marked price per unit before conversion.
base
object
Required
Base price per unit details.
Properties
currency_code
string
Required
Currency code for the base price per unit.
currency_symbol
string
Required
Currency symbol for the base price per unit.
effective
number
Required
Effective base price per unit.
marked
number
Required
Marked base price per unit.
product
object
Product details associated with the article.
Properties
_custom_json
object
Required
Custom JSON associated with the product.
uid
integer
Required
Unique identifier of the product.
type
string
Required
Type of the product.
slug
string
Required
Slug of the product.
name
string
Required
Name of the product.
item_code
string
Required
Item code of the product.
images
array of object
Required
Images of the product.
Array of Properties
url
string
URL of the image.
secure_url
string
Secure URL of the image.
aspect_ratio
string
Aspect ratio of the image.
categories
array of object
Required
Categories of the product.
Array of Properties
uid
integer
Required
Unique identifier of the category.
name
string
Required
Name of the category.
brand
object
Required
Brand details associated with the product.
Properties
uid
integer
Required
Unique identifier of the brand.
name
string
Required
Name of the brand.
attributes
object
Required
Attributes associated with the product.
quantity
integer
Quantity of the article.
Payload Schema JSON
1{2 "type": "object",3 "required": [4 "company_id",5 "contains",6 "event",7 "payload",8 "application_id"9 ],10 "properties": {11 "application_id": {12 "type": [13 "array",14 "string"15 ],16 "description": "Application/sales channel ID for which this event is triggered"17 },18 "company_id": {19 "type": "integer",20 "description": "company ID for which this event is triggered"21 },22 "contains": {23 "type": "array",24 "description": "This array will have all the keys present at root level of 'payload' object",25 "items": {26 "type": "string"27 }28 },29 "event": {30 "type": "object",31 "required": [32 "category",33 "created_timestamp",34 "id",35 "name",36 "trace_id",37 "type",38 "version"39 ],40 "properties": {41 "category": {42 "type": "string",43 "description": "category of the event. If it is at sales channel level or company level"44 },45 "created_timestamp": {46 "type": "integer",47 "description": "event generation timestamp in epoch milliseconds"48 },49 "id": {50 "type": "string",51 "description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"52 },53 "name": {54 "type": "string",55 "description": "Name of the event"56 },57 "trace_id": {58 "type": "array",59 "description": "internal trace_id for Fynd Platform services",60 "items": {61 "type": "string"62 }63 },64 "type": {65 "type": "string",66 "description": "Type/Action of the event. e.g. create/update/delete"67 },68 "version": {69 "type": "string",70 "description": "Version of the event."71 }72 }73 },74 "payload": {75 "type": "object",76 "required": [77 "cart"78 ],79 "properties": {80 "cart": {81 "type": "object",82 "required": [83 "id",84 "items",85 "success",86 "message",87 "last_modified",88 "is_valid",89 "gstin",90 "currency",91 "comment",92 "breakup_values",93 "user_info"94 ],95 "properties": {96 "id": {97 "type": "string",98 "description": "Unique identifier of the cart."99 },100 "user_info": {101 "type": "object",102 "required": [103 "user_id",104 "is_authenticated"105 ],106 "properties": {107 "user_id": {108 "type": "string",109 "description": "Unique identifier of the customer associated with this cart."110 },111 "is_authenticated": {112 "type": "boolean",113 "description": "Flag indicates the user is loggedin or anonymous"114 }115 }116 },117 "comment": {118 "type": "string",119 "description": "Comment associated with the cart."120 },121 "gstin": {122 "type": [123 "string",124 "null"125 ],126 "description": "GSTIN (Goods and Services Tax Identification Number) associated with the cart."127 },128 "message": {129 "type": "string",130 "description": "Message related to the cart."131 },132 "success": {133 "type": "boolean",134 "description": "Indicates whether the operation with the cart was successful or not."135 },136 "is_valid": {137 "type": "boolean",138 "description": "Indicates whether the cart is valid or not."139 },140 "last_modified": {141 "type": "string",142 "description": "Timestamp indicating the last modification time of the cart."143 },144 "currency": {145 "type": "object",146 "required": [],147 "properties": {148 "symbol": {149 "type": [150 "string",151 "null"152 ],153 "description": "Symbol of the currency."154 },155 "code": {156 "type": [157 "string",158 "null"159 ],160 "description": "Code of the currency."161 }162 },163 "description": "Currency details associated with the cart."164 },165 "breakup_values": {166 "type": "object",167 "required": [],168 "properties": {169 "raw": {170 "type": "object",171 "required": [172 "cod_charge",173 "convenience_fee",174 "coupon",175 "delivery_charge",176 "discount",177 "fynd_cash",178 "gst_charges",179 "mop_total",180 "mrp_total",181 "subtotal",182 "total",183 "total_charge",184 "vog",185 "you_saved"186 ],187 "properties": {188 "cod_charge": {189 "type": [190 "number"191 ],192 "description": "Cash on Delivery charge."193 },194 "convenience_fee": {195 "type": [196 "number"197 ],198 "description": "Convenience fee charge."199 },200 "coupon": {201 "type": [202 "number"203 ],204 "description": "Coupon discount amount."205 },206 "delivery_charge": {207 "type": [208 "number"209 ],210 "description": "Delivery charge."211 },212 "discount": {213 "type": [214 "number"215 ],216 "description": "Discount amount."217 },218 "fynd_cash": {219 "type": [220 "number"221 ],222 "description": "Fynd Cash amount."223 },224 "gst_charges": {225 "type": [226 "number"227 ],228 "description": "GST (Goods and Services Tax) charges."229 },230 "mop_total": {231 "type": [232 "number"233 ],234 "description": "MOP (Mode of Payment) total amount."235 },236 "mrp_total": {237 "type": [238 "number"239 ],240 "description": "MRP (Maximum Retail Price) total amount."241 },242 "subtotal": {243 "type": [244 "number"245 ],246 "description": "Subtotal amount."247 },248 "total": {249 "type": [250 "number"251 ],252 "description": "Total amount."253 },254 "total_charge": {255 "type": [256 "number"257 ],258 "description": "Total charge amount."259 },260 "vog": {261 "type": [262 "number"263 ],264 "description": "VOG (Value of Goods) amount."265 },266 "you_saved": {267 "type": [268 "number"269 ],270 "description": "Amount saved."271 }272 },273 "description": "Raw breakup values associated with the cart."274 },275 "coupon": {276 "type": "object",277 "required": [278 "uid",279 "is_applied",280 "message",281 "type",282 "value"283 ],284 "properties": {285 "code": {286 "type": [287 "null",288 "string"289 ],290 "description": "Coupon code applied on cart."291 },292 "uid": {293 "type": [294 "null",295 "string"296 ],297 "description": "Unique identifier of the coupon."298 },299 "is_applied": {300 "type": "boolean",301 "description": "Indicates whether the coupon is applied or not."302 },303 "message": {304 "type": "string",305 "description": "Message associated with the coupon."306 },307 "type": {308 "type": "string",309 "description": "Type of the coupon."310 },311 "value": {312 "type": [313 "number"314 ],315 "description": "Value of the coupon."316 }317 },318 "description": "Coupon details associated with the cart."319 },320 "loyalty_points": {321 "type": "object",322 "properties": {323 "total": {324 "type": [325 "number",326 "null"327 ],328 "description": "Total loyalty points."329 },330 "description": {331 "type": [332 "string",333 "null"334 ],335 "description": "Description of loyalty points."336 },337 "is_applied": {338 "type": [339 "boolean",340 "null"341 ],342 "description": "Indicates whether loyalty points are applied or not."343 },344 "applicable": {345 "type": [346 "number",347 "null"348 ],349 "description": "Applicable loyalty points."350 }351 },352 "description": "Loyalty points details associated with the cart."353 },354 "display": {355 "type": "array",356 "items": {357 "type": "object",358 "required": [359 "attr",360 "currency_code",361 "currency_symbol",362 "display",363 "key",364 "message",365 "original",366 "value"367 ],368 "properties": {369 "attr": {370 "type": "string",371 "description": "Attribute of the product."372 },373 "currency_code": {374 "type": "string",375 "description": "Currency code."376 },377 "currency_symbol": {378 "type": "string",379 "description": "Currency symbol."380 },381 "display": {382 "type": "string",383 "description": "Display of the product."384 },385 "key": {386 "type": "string",387 "description": "Key of the product."388 },389 "message": {390 "type": "array",391 "description": "Message associated with the product."392 },393 "original": {394 "type": [395 "number"396 ],397 "description": "Original value of the product."398 },399 "value": {400 "type": [401 "number"402 ],403 "description": "Value of the product."404 }405 },406 "description": "Display details of the product."407 },408 "description": "Display details associated with the cart."409 }410 },411 "description": "Breakup values associated with the cart."412 },413 "items": {414 "type": "array",415 "items": {416 "type": "object",417 "required": [],418 "properties": {419 "article": {420 "type": "object",421 "required": [],422 "properties": {423 "extra_meta": {424 "type": "object",425 "required": [],426 "description": "Extra metadata associated with the article."427 },428 "price": {429 "type": "object",430 "required": [431 "converted",432 "base"433 ],434 "properties": {435 "converted": {436 "type": "object",437 "required": [438 "currency_code",439 "currency_symbol",440 "effective",441 "marked"442 ],443 "properties": {444 "currency_code": {445 "type": "string",446 "description": "Currency code for the converted price."447 },448 "currency_symbol": {449 "type": "string",450 "description": "Currency symbol for the converted price."451 },452 "effective": {453 "type": [454 "number"455 ],456 "description": "Effective price after conversion."457 },458 "marked": {459 "type": [460 "number"461 ],462 "description": "Marked price after conversion."463 }464 },465 "description": "Converted price details."466 },467 "base": {468 "type": "object",469 "required": [470 "currency_code",471 "currency_symbol",472 "effective",473 "marked"474 ],475 "properties": {476 "currency_code": {477 "type": "string",478 "description": "Currency code for the base price."479 },480 "currency_symbol": {481 "type": "string",482 "description": "Currency symbol for the base price."483 },484 "effective": {485 "type": [486 "number"487 ],488 "description": "Effective base price."489 },490 "marked": {491 "type": [492 "number"493 ],494 "description": "Marked base price."495 }496 },497 "description": "Base price details."498 }499 },500 "description": "Price details associated with the article."501 },502 "quantity": {503 "type": "integer",504 "description": "Quantity of the article."505 },506 "seller": {507 "type": "object",508 "required": [509 "uid",510 "name"511 ],512 "properties": {513 "uid": {514 "type": [515 "null",516 "integer"517 ],518 "description": "Unique identifier of the seller."519 },520 "name": {521 "type": [522 "null",523 "string"524 ],525 "description": "Name of the seller."526 }527 },528 "description": "Seller details associated with the article."529 },530 "size": {531 "type": "string",532 "description": "Size of the article."533 },534 "store": {535 "type": "object",536 "required": [537 "uid",538 "name"539 ],540 "properties": {541 "uid": {542 "type": [543 "null",544 "integer"545 ],546 "description": "Unique identifier of the store."547 },548 "name": {549 "type": [550 "null",551 "string"552 ],553 "description": "Name of the store."554 }555 },556 "description": "Store details associated with the article."557 },558 "type": {559 "type": "string",560 "description": "Type of the article."561 },562 "uid": {563 "type": "string",564 "description": "Unique identifier of the article."565 }566 },567 "description": "Article details."568 },569 "availability": {570 "type": "object",571 "required": [],572 "properties": {573 "available_sizes": {574 "type": "array",575 "items": {576 "type": "object",577 "required": [],578 "properties": {579 "display": {580 "type": "string",581 "description": "Display size."582 },583 "is_available": {584 "type": "boolean",585 "description": "Indicates whether the size is available or not."586 },587 "value": {588 "type": "string",589 "description": "Value of the size."590 }591 },592 "description": "Available size details."593 },594 "description": "Available sizes list."595 },596 "deliverable": {597 "type": "boolean",598 "description": "Indicates whether the article is deliverable or not."599 },600 "is_valid": {601 "type": "boolean",602 "description": "Indicates whether the article is valid or not."603 },604 "other_store_quantity": {605 "type": "integer",606 "description": "Quantity available in other stores."607 },608 "out_of_stock": {609 "type": "boolean",610 "description": "Indicates whether the article is out of stock or not."611 },612 "sizes": {613 "type": "array",614 "items": {615 "type": "string",616 "description": "Available sizes."617 },618 "description": "Sizes available for the article."619 }620 },621 "description": "Availability details of the article."622 },623 "bulk_offer": {624 "type": "object",625 "required": [],626 "description": "Bulk offer details associated with the article."627 },628 "coupon_message": {629 "type": "string",630 "description": "Coupon message associated with the article."631 },632 "delivery_promise": {633 "type": [634 "object",635 "null"636 ],637 "properties": {638 "formatted": {639 "type": "object",640 "required": [641 "min",642 "max"643 ],644 "properties": {645 "min": {646 "type": "string",647 "description": "Formatted minimum delivery promise timestamp."648 },649 "max": {650 "type": "string",651 "description": "Formatted maximum delivery promise timestamp."652 }653 },654 "description": "Formatted delivery promise timestamps."655 },656 "iso": {657 "type": "object",658 "required": [659 "min",660 "max"661 ],662 "properties": {663 "min": {664 "type": "string",665 "description": "ISO formatted minimum delivery promise timestamp."666 },667 "max": {668 "type": "string",669 "description": "ISO formatted maximum delivery promise timestamp."670 }671 },672 "description": "ISO formatted delivery promise timestamps."673 },674 "timestamp": {675 "type": "object",676 "required": [677 "min",678 "max"679 ],680 "properties": {681 "min": {682 "type": "integer",683 "description": "Minimum delivery promise timestamp."684 },685 "max": {686 "type": "integer",687 "description": "Maximum delivery promise timestamp."688 }689 },690 "description": "Delivery promise timestamps."691 }692 },693 "description": "Delivery promise details associated with the article."694 },695 "discount": {696 "type": "string",697 "description": "Discount associated with the article."698 },699 "identifiers": {700 "type": "object",701 "required": [702 "identifier"703 ],704 "properties": {705 "identifier": {706 "type": "string",707 "description": "Identifier associated with the article."708 }709 },710 "description": "Identifiers associated with the article."711 },712 "is_set": {713 "type": "boolean",714 "description": "Indicates whether the article is a set or not."715 },716 "key": {717 "type": "string",718 "description": "Key associated with the article."719 },720 "message": {721 "type": "string",722 "description": "Message associated with the article."723 },724 "moq": {725 "type": "object",726 "properties": {727 "minimum": {728 "type": "integer",729 "description": "Minimum order quantity."730 }731 },732 "description": "Minimum order quantity details associated with the article."733 },734 "price": {735 "type": "object",736 "required": [737 "converted",738 "base"739 ],740 "properties": {741 "converted": {742 "type": "object",743 "required": [744 "currency_code",745 "currency_symbol",746 "effective",747 "marked",748 "add_on",749 "selling"750 ],751 "properties": {752 "currency_code": {753 "type": "string",754 "description": "Currency code for the converted price."755 },756 "currency_symbol": {757 "type": "string",758 "description": "Currency symbol for the converted price."759 },760 "effective": {761 "type": "number",762 "description": "Price of the product after applying inventory discount and before applying promotion, coupon and engage discount."763 },764 "marked": {765 "type": "number",766 "description": "Original MRP of product."767 },768 "add_on": {769 "type": "number",770 "description": "Add-on price."771 },772 "selling": {773 "type": "number",774 "description": "Selling price."775 },776 "final_price": {777 "type": "number",778 "description": "Final price of the product in cart after applying all discounts such as promotion, coupon and engage discount."779 },780 "discount": {781 "type": "number",782 "description": "Net discount applied on product, contains total discount amount including promotions, coupons and engage discount [excluding inventory discount]."783 }784 },785 "description": "Converted price details."786 },787 "base": {788 "type": "object",789 "required": [790 "currency_code",791 "currency_symbol",792 "effective",793 "marked",794 "add_on",795 "selling"796 ],797 "properties": {798 "currency_code": {799 "type": "string",800 "description": "Currency code for the base price."801 },802 "currency_symbol": {803 "type": "string",804 "description": "Currency symbol for the base price."805 },806 "effective": {807 "type": "number",808 "description": "Effective base price."809 },810 "marked": {811 "type": "number",812 "description": "Original MRP of product."813 },814 "add_on": {815 "type": "number",816 "description": "Add-on base price."817 },818 "selling": {819 "type": "number",820 "description": "Selling base price."821 },822 "final_price": {823 "type": "number",824 "description": "Final price of the product in cart after applying all discounts such as promotion, coupon and engage discount."825 },826 "discount": {827 "type": "number",828 "description": "Net discount applied on product, contains total discount amount including promotions, coupons and engage discount [excluding inventory discount]."829 }830 },831 "description": "Base price details."832 }833 },834 "description": "Price details associated with the article."835 },836 "price_per_unit": {837 "type": "object",838 "required": [839 "converted",840 "base"841 ],842 "properties": {843 "converted": {844 "type": "object",845 "required": [846 "currency_code",847 "currency_symbol",848 "effective",849 "marked"850 ],851 "properties": {852 "currency_code": {853 "type": "string",854 "description": "Currency code for the converted price per unit."855 },856 "currency_symbol": {857 "type": "string",858 "description": "Currency symbol for the converted price per unit."859 },860 "effective": {861 "type": [862 "number"863 ],864 "description": "Effective price per unit after conversion."865 },866 "marked": {867 "type": [868 "number"869 ],870 "description": "Marked price per unit before conversion."871 }872 },873 "description": "Converted price per unit details."874 },875 "base": {876 "type": "object",877 "required": [878 "currency_code",879 "currency_symbol",880 "effective",881 "marked"882 ],883 "properties": {884 "currency_code": {885 "type": "string",886 "description": "Currency code for the base price per unit."887 },888 "currency_symbol": {889 "type": "string",890 "description": "Currency symbol for the base price per unit."891 },892 "effective": {893 "type": [894 "number"895 ],896 "description": "Effective base price per unit."897 },898 "marked": {899 "type": [900 "number"901 ],902 "description": "Marked base price per unit."903 }904 },905 "description": "Base price per unit details."906 }907 },908 "description": "Price per unit details associated with the article."909 },910 "product": {911 "type": "object",912 "required": [913 "uid",914 "type",915 "slug",916 "name",917 "item_code",918 "images",919 "categories",920 "brand",921 "attributes",922 "_custom_json"923 ],924 "properties": {925 "_custom_json": {926 "type": "object",927 "required": [],928 "description": "Custom JSON associated with the product."929 },930 "uid": {931 "type": "integer",932 "description": "Unique identifier of the product."933 },934 "type": {935 "type": "string",936 "description": "Type of the product."937 },938 "slug": {939 "type": "string",940 "description": "Slug of the product."941 },942 "name": {943 "type": "string",944 "description": "Name of the product."945 },946 "item_code": {947 "type": "string",948 "description": "Item code of the product."949 },950 "images": {951 "type": "array",952 "items": {953 "type": "object",954 "required": [],955 "properties": {956 "url": {957 "type": "string",958 "description": "URL of the image."959 },960 "secure_url": {961 "type": "string",962 "description": "Secure URL of the image."963 },964 "aspect_ratio": {965 "type": "string",966 "description": "Aspect ratio of the image."967 }968 },969 "description": "Image details associated with the product."970 },971 "description": "Images of the product."972 },973 "categories": {974 "type": "array",975 "items": {976 "type": "object",977 "required": [978 "uid",979 "name"980 ],981 "properties": {982 "uid": {983 "type": "integer",984 "description": "Unique identifier of the category."985 },986 "name": {987 "type": "string",988 "description": "Name of the category."989 }990 },991 "description": "Category details associated with the product."992 },993 "description": "Categories of the product."994 },995 "brand": {996 "type": "object",997 "required": [998 "uid",999 "name"1000 ],1001 "properties": {1002 "uid": {1003 "type": "integer",1004 "description": "Unique identifier of the brand."1005 },1006 "name": {1007 "type": "string",1008 "description": "Name of the brand."1009 }1010 },1011 "description": "Brand details associated with the product."1012 },1013 "attributes": {1014 "type": "object",1015 "required": [],1016 "additionalProperties": true,1017 "description": "Attributes associated with the product."1018 }1019 },1020 "description": "Product details associated with the article."1021 },1022 "quantity": {1023 "type": "integer",1024 "description": "Quantity of the article."1025 }1026 },1027 "description": "Item details."1028 },1029 "description": "Items in the cart."1030 }1031 },1032 "description": "Cart details."1033 }1034 },1035 "description": "Payload details."1036 }1037 }1038}
Payload Example
1{2 "application_id": "5e048673acefbaf1e8487564",3 "company_id": 61,4 "contains": [5 "cart"6 ],7 "event": {8 "category": "application",9 "created_timestamp": 1711553532990,10 "id": "9BG6eQ4zAXe/SAGqDop0JpM9L69hf3EfDiwR6ThGs0w=",11 "name": "cart",12 "trace_id": [13 "megatron.6618fd18-8e13-47fc-9f0b-f7a523256dd2"14 ],15 "type": "create",16 "version": "1"17 },18 "payload": {19 "cart": {20 "breakup_values": {21 "coupon": {22 "code": "",23 "is_applied": false,24 "message": "Sorry! Invalid coupon",25 "type": "cash",26 "uid": null,27 "value": 028 },29 "display": [30 {31 "attr": "mrp_total",32 "currency_code": "INR",33 "currency_symbol": "₹",34 "display": "Total MRP",35 "key": "mrp_total",36 "message": [],37 "original": 100000,38 "value": 10000039 },40 {41 "attr": "discount",42 "currency_code": "INR",43 "currency_symbol": "₹",44 "display": "Discount",45 "key": "discount",46 "message": [],47 "original": -49000,48 "value": -4900049 },50 {51 "attr": "subtotal",52 "currency_code": "INR",53 "currency_symbol": "₹",54 "display": "Subtotal",55 "key": "subtotal",56 "message": [],57 "original": 51000,58 "value": 5100059 },60 {61 "attr": "total",62 "currency_code": "INR",63 "currency_symbol": "₹",64 "display": "Total",65 "key": "total",66 "message": [],67 "original": 51000,68 "value": 5100069 }70 ],71 "loyalty_points": {72 "applicable": 0,73 "description": "Your cashback, reward points, and refund amount get credited to Fynd Cash which can be redeemed while placing an order.",74 "is_applied": false,75 "total": 076 },77 "raw": {78 "cod_charge": 0,79 "convenience_fee": 0,80 "coupon": 0,81 "delivery_charge": 0,82 "discount": -49000,83 "fynd_cash": 0,84 "gst_charges": 2428.57,85 "mop_total": 0,86 "mrp_total": 100000,87 "subtotal": 51000,88 "total": 51000,89 "total_charge": 0,90 "vog": 48571.43,91 "you_saved": 092 }93 },94 "comment": "",95 "currency": {96 "code": "INR",97 "symbol": "₹"98 },99 "gstin": null,100 "user_info": {101 "user_id": "685976c497f05d99e821a000",102 "is_authenticated": true103 },104 "id": "66043bfc2672210c3f06a751",105 "is_valid": true,106 "items": [107 {108 "article": {109 "extra_meta": {},110 "price": {111 "base": {112 "currency_code": "INR",113 "currency_symbol": "₹",114 "effective": 51000,115 "marked": 100000116 },117 "converted": {118 "currency_code": "INR",119 "currency_symbol": "₹",120 "effective": 51000,121 "marked": 100000122 }123 },124 "quantity": 100000,125 "seller": {126 "name": "FUCHSIA VINE DESIGNS PRIVATE LIMITED",127 "uid": 61128 },129 "size": "OS",130 "store": {131 "name": "Serviceability-Mumbai-HS-DC",132 "uid": 15411133 },134 "type": "article",135 "uid": "66043b1a2d266371f7af51d6"136 },137 "availability": {138 "available_sizes": [139 {140 "display": "OS",141 "is_available": true,142 "value": "OS"143 }144 ],145 "deliverable": true,146 "is_valid": true,147 "other_store_quantity": 1,148 "out_of_stock": false,149 "sizes": [150 "OS"151 ]152 },153 "bulk_offer": {},154 "coupon_message": "",155 "delivery_promise": {156 "formatted": {157 "max": "Mon, 22 Apr",158 "min": "Sun, 21 Apr"159 },160 "iso": {161 "max": "2024-04-22T15:32:12Z",162 "min": "2024-04-21T19:32:12Z"163 },164 "timestamp": {165 "max": 1713799932,166 "min": 1713727932167 }168 },169 "discount": "49% OFF",170 "identifiers": {171 "identifier": "qsHUV5EMQHyY62CGbK9Iw"172 },173 "is_set": false,174 "key": "10198730_OS",175 "message": "",176 "moq": {177 "minimum": 1178 },179 "price": {180 "base": {181 "add_on": 51000,182 "currency_code": "INR",183 "currency_symbol": "₹",184 "effective": 51000,185 "marked": 100000,186 "selling": 51000187 },188 "converted": {189 "add_on": 51000,190 "currency_code": "INR",191 "currency_symbol": "₹",192 "effective": 51000,193 "marked": 100000,194 "selling": 51000195 }196 },197 "price_per_unit": {198 "base": {199 "currency_code": "INR",200 "currency_symbol": "₹",201 "effective": 51000,202 "marked": 100000203 },204 "converted": {205 "currency_code": "INR",206 "currency_symbol": "₹",207 "effective": 51000,208 "marked": 100000209 }210 },211 "product": {212 "_custom_json": {},213 "attributes": {214 "brand_name": "Guess Global",215 "essential": "Yes",216 "gender": [217 "Girls"218 ],219 "marketer-address": "dcdscv",220 "marketer-name": "sdvsdv",221 "name": "Test DP EWAY BILL",222 "net-quantity": "1 N",223 "primary_color": "Red",224 "primary_color_hex": "D0021B"225 },226 "brand": {227 "name": "Guess Global",228 "uid": 7894229 },230 "categories": [231 {232 "name": "Baby Bath Nets",233 "uid": 2845234 }235 ],236 "images": [237 {238 "aspect_ratio": "16:25",239 "secure_url": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/original/knk_NJWO7-cn54690625.jpg",240 "url": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/original/knk_NJWO7-cn54690625.jpg"241 }242 ],243 "item_code": "SDCKNKJNJSDV",244 "name": "Test DP EWAY BILL",245 "slug": "test-dp-eway-bill-10198730",246 "type": "product",247 "uid": 10198730248 },249 "quantity": 1250 }251 ],252 "last_modified": "Wed, 27 Mar 2024 15:32:12 GMT",253 "message": "",254 "success": true255 }256 }257}
Payload
Properties
application_id
array|string
Required
Application/sales channel ID for which this event is triggered
company_id
integer
Required
company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
event generation timestamp in epoch milliseconds
id
string
Required
Unique ID for an event. This id can be used to verifiy if event is already processed by receiver
name
string
Required
Name of the event
trace_id
array of string
Required
internal trace_id for Fynd Platform services
type
string
Required
Type/Action of the event. e.g. create/update/delete
version
string
Required
Version of the event.
payload
object
Required
Properties
cart
object
Required
Properties
id
string
Required
Unique ID of the cart.
user_info
object
Required
Properties
user_id
string
Required
Unique identifier of the customer associated with this cart.
is_authenticated
boolean
Required
Flag indicates the user is loggedin or anonymous
comment
string
Required
Comment associated with the cart.
gstin
string|null
Required
GSTIN associated with the cart.
message
string
Required
Message associated with the cart.
success
boolean
Required
Indicates whether the cart operation was successful or not.
is_valid
boolean
Required
Indicates whether the cart is valid or not.
last_modified
string
Required
Date and time when the cart was last modified.
currency
object
Required
Currency details associated with the cart.
Properties
symbol
string|null
Currency symbol associated with the cart.
code
string|null
Currency code associated with the cart.
breakup_values
object
Required
Properties
raw
object
Raw values associated with the cart.
Properties
cod_charge
number
Required
COD charge associated with the cart.
convenience_fee
number
Required
Convenience fee associated with the cart.
coupon
number
Required
Coupon associated with the cart.
delivery_charge
number
Required
Delivery charge associated with the cart.
discount
number
Required
Discount associated with the cart.
fynd_cash
number
Required
Fynd cash associated with the cart.
gst_charges
number
Required
GST charges associated with the cart.
mop_total
number
Required
MOP total associated with the cart.
mrp_total
number
Required
MRP total associated with the cart.
subtotal
number
Required
Subtotal associated with the cart.
total
number
Required
Total amount associated with the cart.
total_charge
number
Required
Total charge associated with the cart.
vog
number
Required
VOG associated with the cart.
you_saved
number
Required
Amount saved in the cart.
coupon
object
Coupon details associated with the cart.
Properties
code
null|string
Coupon code applied on cart.
uid
null|string
Required
Unique identifier of the coupon.
is_applied
boolean
Required
Indicates whether the coupon is applied or not.
message
string
Required
Message associated with the coupon.
type
string
Required
Type of the coupon.
value
number
Required
Value of the coupon.
loyalty_points
object
Loyalty points associated with the cart.
Properties
total
number|null
Total loyalty points associated with the cart.
description
string|null
Description of loyalty points.
is_applied
boolean|null
Indicates whether loyalty points are applied or not.
applicable
number|null
Applicable loyalty points.
display
array of object
Array of Properties
attr
string
Required
Attribute associated with the display item.
currency_code
string
Required
Currency code associated with the display item.
currency_symbol
string
Required
Currency symbol associated with the display item.
display
string
Required
Display value.
key
string
Required
Key associated with the display item.
message
array of
Required
Message associated with the display item.
original
number
Required
Original value.
value
number
Required
items
array of object
Required
Array of Properties
article
object
Properties
extra_meta
object
price
object
Properties
converted
object
Required
Properties
currency_code
string
Required
currency_symbol
string
Required
effective
number
Required
marked
number
Required
base
object
Required
Properties
currency_code
string
Required
currency_symbol
string
Required
effective
number
Required
marked
number
Required
quantity
integer
seller
object
Properties
uid
null|integer
Required
name
null|string
Required
size
string
store
object
Properties
uid
null|integer
Required
name
null|string
Required
type
string
uid
string
availability
object
Properties
available_sizes
array of object
Array of Properties
display
string
is_available
boolean
value
string
deliverable
boolean
is_valid
boolean
other_store_quantity
integer
out_of_stock
boolean
sizes
array of string
bulk_offer
object
coupon_message
string
delivery_promise
object|null
Properties
formatted
object
Properties
min
string
Required
max
string
Required
iso
object
Properties
min
string
Required
max
string
Required
timestamp
object
Properties
min
integer
Required
max
integer
Required
discount
string
identifiers
object
Properties
identifier
string
Required
is_set
boolean
key
string
message
string
moq
object
Properties
minimum
integer
maximum
integer
increment_unit
integer
price
object
Properties
converted
object
Required
Properties
currency_code
string
Required
currency_symbol
string
Required
effective
number
Required
Price of the product after applying inventory discount and before applying promotion, coupon and engage discount.
marked
number
Required
Original MRP of product.
add_on
number
Required
Add-on price.
selling
number
Required
Selling price.
final_price
number
Final price of the product in cart after applying all discounts such as promotion, coupon and engage discount.
discount
number
Net discount applied on product, contains total discount amount including promotions, coupons and engage discount [excluding inventory discount].
base
object
Required
Properties
currency_code
string
Required
currency_symbol
string
Required
effective
number
Required
Price of the product after applying inventory discount and before applying promotion, coupon and engage discount.
marked
number
Required
Original MRP of product.
add_on
number
Required
Add-on price.
selling
number
Required
Selling price.
final_price
number
Final price of the product in cart after applying all discounts such as promotion, coupon and engage discount.
discount
number
Net discount applied on product, contains total discount amount including promotions, coupons and engage discount [excluding inventory discount].
price_per_unit
object
Properties
converted
object
Required
Properties
currency_code
string
Required
currency_symbol
string
Required
effective
number
Required
marked
number
Required
base
object
Required
Properties
currency_code
string
Required
currency_symbol
string
Required
effective
number
Required
marked
number
Required
product
object
Properties
_custom_json
object
Required
uid
integer
Required
type
string
Required
slug
string
Required
name
string
Required
item_code
string
Required
images
array of object
Required
Array of Properties
url
string
secure_url
string
aspect_ratio
string
categories
array of object
Required
Array of Properties
uid
integer
Required
name
string
Required
brand
object
Required
Properties
uid
integer
Required
name
string
Required
attributes
object
Required
quantity
integer
Payload Schema JSON
1{2 "type": "object",3 "required": [4 "company_id",5 "contains",6 "event",7 "payload",8 "application_id"9 ],10 "properties": {11 "application_id": {12 "type": [13 "array",14 "string"15 ],16 "description": "Application/sales channel ID for which this event is triggered"17 },18 "company_id": {19 "type": "integer",20 "description": "company ID for which this event is triggered"21 },22 "contains": {23 "type": "array",24 "description": "This array will have all the keys present at root level of 'payload' object",25 "items": {26 "type": "string"27 }28 },29 "event": {30 "type": "object",31 "required": [32 "category",33 "created_timestamp",34 "id",35 "name",36 "trace_id",37 "type",38 "version"39 ],40 "properties": {41 "category": {42 "type": "string",43 "description": "category of the event. If it is at sales channel level or company level"44 },45 "created_timestamp": {46 "type": "integer",47 "description": "event generation timestamp in epoch milliseconds"48 },49 "id": {50 "type": "string",51 "description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"52 },53 "name": {54 "type": "string",55 "description": "Name of the event"56 },57 "trace_id": {58 "type": "array",59 "description": "internal trace_id for Fynd Platform services",60 "items": {61 "type": "string"62 }63 },64 "type": {65 "type": "string",66 "description": "Type/Action of the event. e.g. create/update/delete"67 },68 "version": {69 "type": "string",70 "description": "Version of the event."71 }72 }73 },74 "payload": {75 "type": "object",76 "required": [77 "cart"78 ],79 "properties": {80 "cart": {81 "type": "object",82 "required": [83 "id",84 "items",85 "success",86 "message",87 "last_modified",88 "is_valid",89 "gstin",90 "currency",91 "comment",92 "breakup_values",93 "user_info"94 ],95 "properties": {96 "id": {97 "type": "string",98 "description": "Unique ID of the cart."99 },100 "user_info": {101 "type": "object",102 "required": [103 "user_id",104 "is_authenticated"105 ],106 "properties": {107 "user_id": {108 "type": "string",109 "description": "Unique identifier of the customer associated with this cart."110 },111 "is_authenticated": {112 "type": "boolean",113 "description": "Flag indicates the user is loggedin or anonymous"114 }115 }116 },117 "comment": {118 "type": "string",119 "description": "Comment associated with the cart."120 },121 "gstin": {122 "type": [123 "string",124 "null"125 ],126 "description": "GSTIN associated with the cart."127 },128 "message": {129 "type": "string",130 "description": "Message associated with the cart."131 },132 "success": {133 "type": "boolean",134 "description": "Indicates whether the cart operation was successful or not."135 },136 "is_valid": {137 "type": "boolean",138 "description": "Indicates whether the cart is valid or not."139 },140 "last_modified": {141 "type": "string",142 "description": "Date and time when the cart was last modified."143 },144 "currency": {145 "type": "object",146 "required": [],147 "properties": {148 "symbol": {149 "type": [150 "string",151 "null"152 ],153 "description": "Currency symbol associated with the cart."154 },155 "code": {156 "type": [157 "string",158 "null"159 ],160 "description": "Currency code associated with the cart."161 }162 },163 "description": "Currency details associated with the cart."164 },165 "breakup_values": {166 "type": "object",167 "required": [],168 "properties": {169 "raw": {170 "type": "object",171 "required": [172 "cod_charge",173 "convenience_fee",174 "coupon",175 "delivery_charge",176 "discount",177 "fynd_cash",178 "gst_charges",179 "mop_total",180 "mrp_total",181 "subtotal",182 "total",183 "total_charge",184 "vog",185 "you_saved"186 ],187 "properties": {188 "cod_charge": {189 "type": [190 "number"191 ],192 "description": "COD charge associated with the cart."193 },194 "convenience_fee": {195 "type": [196 "number"197 ],198 "description": "Convenience fee associated with the cart."199 },200 "coupon": {201 "type": [202 "number"203 ],204 "description": "Coupon associated with the cart."205 },206 "delivery_charge": {207 "type": [208 "number"209 ],210 "description": "Delivery charge associated with the cart."211 },212 "discount": {213 "type": [214 "number"215 ],216 "description": "Discount associated with the cart."217 },218 "fynd_cash": {219 "type": [220 "number"221 ],222 "description": "Fynd cash associated with the cart."223 },224 "gst_charges": {225 "type": [226 "number"227 ],228 "description": "GST charges associated with the cart."229 },230 "mop_total": {231 "type": [232 "number"233 ],234 "description": "MOP total associated with the cart."235 },236 "mrp_total": {237 "type": [238 "number"239 ],240 "description": "MRP total associated with the cart."241 },242 "subtotal": {243 "type": [244 "number"245 ],246 "description": "Subtotal associated with the cart."247 },248 "total": {249 "type": [250 "number"251 ],252 "description": "Total amount associated with the cart."253 },254 "total_charge": {255 "type": [256 "number"257 ],258 "description": "Total charge associated with the cart."259 },260 "vog": {261 "type": [262 "number"263 ],264 "description": "VOG associated with the cart."265 },266 "you_saved": {267 "type": [268 "number"269 ],270 "description": "Amount saved in the cart."271 }272 },273 "description": "Raw values associated with the cart."274 },275 "coupon": {276 "type": "object",277 "required": [278 "uid",279 "is_applied",280 "message",281 "type",282 "value"283 ],284 "properties": {285 "code": {286 "type": [287 "null",288 "string"289 ],290 "description": "Coupon code applied on cart."291 },292 "uid": {293 "type": [294 "null",295 "string"296 ],297 "description": "Unique identifier of the coupon."298 },299 "is_applied": {300 "type": "boolean",301 "description": "Indicates whether the coupon is applied or not."302 },303 "message": {304 "type": "string",305 "description": "Message associated with the coupon."306 },307 "type": {308 "type": "string",309 "description": "Type of the coupon."310 },311 "value": {312 "type": [313 "number"314 ],315 "description": "Value of the coupon."316 }317 },318 "description": "Coupon details associated with the cart."319 },320 "loyalty_points": {321 "type": "object",322 "properties": {323 "total": {324 "type": [325 "number",326 "null"327 ],328 "description": "Total loyalty points associated with the cart."329 },330 "description": {331 "type": [332 "string",333 "null"334 ],335 "description": "Description of loyalty points."336 },337 "is_applied": {338 "type": [339 "boolean",340 "null"341 ],342 "description": "Indicates whether loyalty points are applied or not."343 },344 "applicable": {345 "type": [346 "number",347 "null"348 ],349 "description": "Applicable loyalty points."350 }351 },352 "description": "Loyalty points associated with the cart."353 },354 "display": {355 "type": "array",356 "items": {357 "type": "object",358 "required": [359 "attr",360 "currency_code",361 "currency_symbol",362 "display",363 "key",364 "message",365 "original",366 "value"367 ],368 "properties": {369 "attr": {370 "type": "string",371 "description": "Attribute associated with the display item."372 },373 "currency_code": {374 "type": "string",375 "description": "Currency code associated with the display item."376 },377 "currency_symbol": {378 "type": "string",379 "description": "Currency symbol associated with the display item."380 },381 "display": {382 "type": "string",383 "description": "Display value."384 },385 "key": {386 "type": "string",387 "description": "Key associated with the display item."388 },389 "message": {390 "type": "array",391 "description": "Message associated with the display item."392 },393 "original": {394 "type": [395 "number"396 ],397 "description": "Original value."398 },399 "value": {400 "type": [401 "number"402 ]403 }404 }405 }406 }407 }408 },409 "items": {410 "type": "array",411 "items": {412 "type": "object",413 "required": [],414 "properties": {415 "article": {416 "type": "object",417 "required": [],418 "properties": {419 "extra_meta": {420 "type": "object",421 "required": []422 },423 "price": {424 "type": "object",425 "required": [426 "converted",427 "base"428 ],429 "properties": {430 "converted": {431 "type": "object",432 "required": [433 "currency_code",434 "currency_symbol",435 "effective",436 "marked"437 ],438 "properties": {439 "currency_code": {440 "type": "string"441 },442 "currency_symbol": {443 "type": "string"444 },445 "effective": {446 "type": [447 "number"448 ]449 },450 "marked": {451 "type": [452 "number"453 ]454 }455 }456 },457 "base": {458 "type": "object",459 "required": [460 "currency_code",461 "currency_symbol",462 "effective",463 "marked"464 ],465 "properties": {466 "currency_code": {467 "type": "string"468 },469 "currency_symbol": {470 "type": "string"471 },472 "effective": {473 "type": [474 "number"475 ]476 },477 "marked": {478 "type": [479 "number"480 ]481 }482 }483 }484 }485 },486 "quantity": {487 "type": "integer"488 },489 "seller": {490 "type": "object",491 "required": [492 "uid",493 "name"494 ],495 "properties": {496 "uid": {497 "type": [498 "null",499 "integer"500 ]501 },502 "name": {503 "type": [504 "null",505 "string"506 ]507 }508 }509 },510 "size": {511 "type": "string"512 },513 "store": {514 "type": "object",515 "required": [516 "uid",517 "name"518 ],519 "properties": {520 "uid": {521 "type": [522 "null",523 "integer"524 ]525 },526 "name": {527 "type": [528 "null",529 "string"530 ]531 }532 }533 },534 "type": {535 "type": "string"536 },537 "uid": {538 "type": "string"539 }540 }541 },542 "availability": {543 "type": "object",544 "required": [],545 "properties": {546 "available_sizes": {547 "type": "array",548 "items": {549 "type": "object",550 "required": [],551 "properties": {552 "display": {553 "type": "string"554 },555 "is_available": {556 "type": "boolean"557 },558 "value": {559 "type": "string"560 }561 }562 }563 },564 "deliverable": {565 "type": "boolean"566 },567 "is_valid": {568 "type": "boolean"569 },570 "other_store_quantity": {571 "type": "integer"572 },573 "out_of_stock": {574 "type": "boolean"575 },576 "sizes": {577 "type": "array",578 "items": {579 "type": "string"580 }581 }582 }583 },584 "bulk_offer": {585 "type": "object",586 "required": []587 },588 "coupon_message": {589 "type": "string"590 },591 "delivery_promise": {592 "type": [593 "object",594 "null"595 ],596 "properties": {597 "formatted": {598 "type": "object",599 "required": [600 "min",601 "max"602 ],603 "properties": {604 "min": {605 "type": "string"606 },607 "max": {608 "type": "string"609 }610 }611 },612 "iso": {613 "type": "object",614 "required": [615 "min",616 "max"617 ],618 "properties": {619 "min": {620 "type": "string"621 },622 "max": {623 "type": "string"624 }625 }626 },627 "timestamp": {628 "type": "object",629 "required": [630 "min",631 "max"632 ],633 "properties": {634 "min": {635 "type": "integer"636 },637 "max": {638 "type": "integer"639 }640 }641 }642 }643 },644 "discount": {645 "type": "string"646 },647 "identifiers": {648 "type": "object",649 "required": [650 "identifier"651 ],652 "properties": {653 "identifier": {654 "type": "string"655 }656 }657 },658 "is_set": {659 "type": "boolean"660 },661 "key": {662 "type": "string"663 },664 "message": {665 "type": "string"666 },667 "moq": {668 "type": "object",669 "properties": {670 "minimum": {671 "type": "integer"672 },673 "maximum": {674 "type": "integer"675 },676 "increment_unit": {677 "type": "integer"678 }679 }680 },681 "price": {682 "type": "object",683 "required": [684 "converted",685 "base"686 ],687 "properties": {688 "converted": {689 "type": "object",690 "required": [691 "currency_code",692 "currency_symbol",693 "effective",694 "marked",695 "add_on",696 "selling"697 ],698 "properties": {699 "currency_code": {700 "type": "string"701 },702 "currency_symbol": {703 "type": "string"704 },705 "effective": {706 "type": "number",707 "description": "Price of the product after applying inventory discount and before applying promotion, coupon and engage discount."708 },709 "marked": {710 "type": "number",711 "description": "Original MRP of product."712 },713 "add_on": {714 "type": "number",715 "description": "Add-on price."716 },717 "selling": {718 "type": "number",719 "description": "Selling price."720 },721 "final_price": {722 "type": "number",723 "description": "Final price of the product in cart after applying all discounts such as promotion, coupon and engage discount."724 },725 "discount": {726 "type": "number",727 "description": "Net discount applied on product, contains total discount amount including promotions, coupons and engage discount [excluding inventory discount]."728 }729 }730 },731 "base": {732 "type": "object",733 "required": [734 "currency_code",735 "currency_symbol",736 "effective",737 "marked",738 "add_on",739 "selling"740 ],741 "properties": {742 "currency_code": {743 "type": "string"744 },745 "currency_symbol": {746 "type": "string"747 },748 "effective": {749 "type": "number",750 "description": "Price of the product after applying inventory discount and before applying promotion, coupon and engage discount."751 },752 "marked": {753 "type": "number",754 "description": "Original MRP of product."755 },756 "add_on": {757 "type": "number",758 "description": "Add-on price."759 },760 "selling": {761 "type": "number",762 "description": "Selling price."763 },764 "final_price": {765 "type": "number",766 "description": "Final price of the product in cart after applying all discounts such as promotion, coupon and engage discount."767 },768 "discount": {769 "type": "number",770 "description": "Net discount applied on product, contains total discount amount including promotions, coupons and engage discount [excluding inventory discount]."771 }772 }773 }774 }775 },776 "price_per_unit": {777 "type": "object",778 "required": [779 "converted",780 "base"781 ],782 "properties": {783 "converted": {784 "type": "object",785 "required": [786 "currency_code",787 "currency_symbol",788 "effective",789 "marked"790 ],791 "properties": {792 "currency_code": {793 "type": "string"794 },795 "currency_symbol": {796 "type": "string"797 },798 "effective": {799 "type": [800 "number"801 ]802 },803 "marked": {804 "type": [805 "number"806 ]807 }808 }809 },810 "base": {811 "type": "object",812 "required": [813 "currency_code",814 "currency_symbol",815 "effective",816 "marked"817 ],818 "properties": {819 "currency_code": {820 "type": "string"821 },822 "currency_symbol": {823 "type": "string"824 },825 "effective": {826 "type": [827 "number"828 ]829 },830 "marked": {831 "type": [832 "number"833 ]834 }835 }836 }837 }838 },839 "product": {840 "type": "object",841 "required": [842 "uid",843 "type",844 "slug",845 "name",846 "item_code",847 "images",848 "categories",849 "brand",850 "attributes",851 "_custom_json"852 ],853 "properties": {854 "_custom_json": {855 "type": "object",856 "additionalProperties": true,857 "required": []858 },859 "uid": {860 "type": "integer"861 },862 "type": {863 "type": "string"864 },865 "slug": {866 "type": "string"867 },868 "name": {869 "type": "string"870 },871 "item_code": {872 "type": "string"873 },874 "images": {875 "type": "array",876 "items": {877 "type": "object",878 "required": [],879 "properties": {880 "url": {881 "type": "string"882 },883 "secure_url": {884 "type": "string"885 },886 "aspect_ratio": {887 "type": "string"888 }889 }890 }891 },892 "categories": {893 "type": "array",894 "items": {895 "type": "object",896 "required": [897 "uid",898 "name"899 ],900 "properties": {901 "uid": {902 "type": "integer"903 },904 "name": {905 "type": "string"906 }907 }908 }909 },910 "brand": {911 "type": "object",912 "required": [913 "uid",914 "name"915 ],916 "properties": {917 "uid": {918 "type": "integer"919 },920 "name": {921 "type": "string"922 }923 }924 },925 "attributes": {926 "type": "object",927 "additionalProperties": true,928 "required": []929 }930 }931 },932 "quantity": {933 "type": "integer"934 }935 }936 }937 }938 }939 }940 }941 }942 }943}
Payload Example
1{2 "application_id": "6523fa5f41f4eb4c10a1d869",3 "company_id": 5842,4 "contains": [5 "cart"6 ],7 "event": {8 "category": "application",9 "created_timestamp": 1712143356504,10 "id": "/4T+BrIIL7L0QQ2GFdH3eSeg966q3BPKGTvI4Quig6E=",11 "name": "cart",12 "trace_id": [13 "megatron.65a224d1-b379-47ae-9480-ac5b421cb56f"14 ],15 "type": "update",16 "version": "1"17 },18 "payload": {19 "cart": {20 "breakup_values": {21 "coupon": {22 "code": "",23 "is_applied": false,24 "message": "",25 "type": "cash",26 "uid": null,27 "value": 028 },29 "display": [],30 "loyalty_points": {31 "applicable": null,32 "description": null,33 "is_applied": null,34 "total": null35 },36 "raw": {37 "cod_charge": 0,38 "convenience_fee": 0,39 "coupon": 0,40 "delivery_charge": 0,41 "discount": 0,42 "fynd_cash": 0,43 "gst_charges": 0,44 "mop_total": 0,45 "mrp_total": 0,46 "subtotal": 0,47 "total": 0,48 "total_charge": 0,49 "vog": 0,50 "you_saved": 051 }52 },53 "comment": "",54 "currency": {55 "code": "INR",56 "symbol": "₹"57 },58 "gstin": null,59 "user_info": {60 "user_id": "685976c497f05d99e821a000",61 "is_authenticated": true62 },63 "id": "65cef8fc2bff52f3d41fdc76",64 "is_valid": false,65 "items": [],66 "last_modified": "Wed, 03 Apr 2024 11:22:36 GMT",67 "message": "No items in cart",68 "success": false69 }70 }71}