[{"data":1,"prerenderedAt":846},["ShallowReactive",2],{"navigation_docs":3,"-docs-events-getting-started-event-reference":214,"-docs-events-getting-started-event-reference-surround":841},[4,74,96,130],{"title":5,"path":6,"stem":7,"children":8},"Assets API","\u002Fdocs\u002Fassets","docs\u002Fassets\u002Findex",[9,10,32,57],{"title":5,"path":6,"stem":7},{"title":11,"path":12,"stem":13,"children":14,"page":31},"Getting Started","\u002Fdocs\u002Fassets\u002Fgetting-started","docs\u002Fassets\u002F1.getting-started",[15,19,23,27],{"title":16,"path":17,"stem":18},"Base URL","\u002Fdocs\u002Fassets\u002Fgetting-started\u002Fbase-url","docs\u002Fassets\u002F1.getting-started\u002F1.base-url",{"title":20,"path":21,"stem":22},"Important Notes","\u002Fdocs\u002Fassets\u002Fgetting-started\u002Fimportant-notes","docs\u002Fassets\u002F1.getting-started\u002F2.important-notes",{"title":24,"path":25,"stem":26},"URL Format","\u002Fdocs\u002Fassets\u002Fgetting-started\u002Furl-format","docs\u002Fassets\u002F1.getting-started\u002F3.url-format",{"title":28,"path":29,"stem":30},"Custom Domains","\u002Fdocs\u002Fassets\u002Fgetting-started\u002Fcustom-domains","docs\u002Fassets\u002F1.getting-started\u002F4.custom-domains",false,{"title":33,"path":34,"stem":35,"children":36,"page":31},"Usage","\u002Fdocs\u002Fassets\u002Fusage","docs\u002Fassets\u002F2.usage",[37,41,45,49,53],{"title":38,"path":39,"stem":40},"Transforms","\u002Fdocs\u002Fassets\u002Fusage\u002Ftransforms","docs\u002Fassets\u002F2.usage\u002F1.transforms",{"title":42,"path":43,"stem":44},"Caching","\u002Fdocs\u002Fassets\u002Fusage\u002Fcaching","docs\u002Fassets\u002F2.usage\u002F2.caching",{"title":46,"path":47,"stem":48},"Recipes","\u002Fdocs\u002Fassets\u002Fusage\u002Frecipes","docs\u002Fassets\u002F2.usage\u002F3.recipes",{"title":50,"path":51,"stem":52},"Best Practices","\u002Fdocs\u002Fassets\u002Fusage\u002Fbest-practices","docs\u002Fassets\u002F2.usage\u002F4.best-practices",{"title":54,"path":55,"stem":56},"Reference","\u002Fdocs\u002Fassets\u002Fusage\u002Freference","docs\u002Fassets\u002F2.usage\u002F5.reference",{"title":58,"path":59,"stem":60,"children":61,"page":31},"Integration","\u002Fdocs\u002Fassets\u002Fintegration","docs\u002Fassets\u002F3.integration",[62,66,70],{"title":63,"path":64,"stem":65},"Nuxt","\u002Fdocs\u002Fassets\u002Fintegration\u002Fnuxt","docs\u002Fassets\u002F3.integration\u002F1.nuxt",{"title":67,"path":68,"stem":69},"Next.js","\u002Fdocs\u002Fassets\u002Fintegration\u002Fnextjs","docs\u002Fassets\u002F3.integration\u002F2.nextjs",{"title":71,"path":72,"stem":73},"Plain HTML","\u002Fdocs\u002Fassets\u002Fintegration\u002Fhtml","docs\u002Fassets\u002F3.integration\u002F3.html",{"title":75,"path":76,"stem":77,"children":78},"Events API","\u002Fdocs\u002Fevents","docs\u002Fevents\u002Findex",[79,80],{"title":75,"path":76,"stem":77},{"title":11,"path":81,"stem":82,"children":83,"page":31},"\u002Fdocs\u002Fevents\u002Fgetting-started","docs\u002Fevents\u002F1.getting-started",[84,88,92],{"title":85,"path":86,"stem":87},"Subscribing","\u002Fdocs\u002Fevents\u002Fgetting-started\u002Fsubscribing","docs\u002Fevents\u002F1.getting-started\u002F1.subscribing",{"title":89,"path":90,"stem":91},"Event Delivery","\u002Fdocs\u002Fevents\u002Fgetting-started\u002Fevent-delivery","docs\u002Fevents\u002F1.getting-started\u002F2.event-delivery",{"title":93,"path":94,"stem":95},"Event Reference","\u002Fdocs\u002Fevents\u002Fgetting-started\u002Fevent-reference","docs\u002Fevents\u002F1.getting-started\u002F3.event-reference",{"title":97,"path":98,"stem":99,"children":100},"Integrations API","\u002Fdocs\u002Fintegrations","docs\u002Fintegrations\u002Findex",[101,102],{"title":97,"path":98,"stem":99},{"title":11,"path":103,"stem":104,"children":105,"page":31},"\u002Fdocs\u002Fintegrations\u002Fgetting-started","docs\u002Fintegrations\u002F1.getting-started",[106,110,114,118,122,126],{"title":107,"path":108,"stem":109},"Why Use It?","\u002Fdocs\u002Fintegrations\u002Fgetting-started\u002Fwhy-integrations-api","docs\u002Fintegrations\u002F1.getting-started\u002F1.why-integrations-api",{"title":111,"path":112,"stem":113},"Use Cases","\u002Fdocs\u002Fintegrations\u002Fgetting-started\u002Fwho-is-it-for","docs\u002Fintegrations\u002F1.getting-started\u002F2.who-is-it-for",{"title":115,"path":116,"stem":117},"Pre-built Connectors","\u002Fdocs\u002Fintegrations\u002Fgetting-started\u002Fpre-built-integrations","docs\u002Fintegrations\u002F1.getting-started\u002F3.pre-built-integrations",{"title":119,"path":120,"stem":121},"Custom Inbound","\u002Fdocs\u002Fintegrations\u002Fgetting-started\u002Fcustom-inbound-api","docs\u002Fintegrations\u002F1.getting-started\u002F4.custom-inbound-api",{"title":123,"path":124,"stem":125},"Event Lifecycle","\u002Fdocs\u002Fintegrations\u002Fgetting-started\u002Fevent-lifecycle","docs\u002Fintegrations\u002F1.getting-started\u002F5.event-lifecycle",{"title":127,"path":128,"stem":129},"API Endpoints","\u002Fdocs\u002Fintegrations\u002Fgetting-started\u002Fmanagement-api-endpoints","docs\u002Fintegrations\u002F1.getting-started\u002F6.management-api-endpoints",{"title":131,"path":132,"stem":133,"children":134,"redirect":136},"MCP Server","\u002Fdocs\u002Fmcp","docs\u002Fmcp\u002Findex",[135,137,156,189],{"title":131,"path":132,"stem":133,"redirect":136},"\u002Fdocs\u002Fmcp\u002Fgetting-started\u002Fvscode",{"title":11,"path":138,"stem":139,"children":140,"page":31},"\u002Fdocs\u002Fmcp\u002Fgetting-started","docs\u002Fmcp\u002F1.getting-started",[141,144,148,152],{"title":142,"path":136,"stem":143},"VS Code","docs\u002Fmcp\u002F1.getting-started\u002F1.vscode",{"title":145,"path":146,"stem":147},"Claude Desktop","\u002Fdocs\u002Fmcp\u002Fgetting-started\u002Fclaude-desktop","docs\u002Fmcp\u002F1.getting-started\u002F2.claude-desktop",{"title":149,"path":150,"stem":151},"Cursor","\u002Fdocs\u002Fmcp\u002Fgetting-started\u002Fcursor","docs\u002Fmcp\u002F1.getting-started\u002F3.cursor",{"title":153,"path":154,"stem":155},"Verify Connection","\u002Fdocs\u002Fmcp\u002Fgetting-started\u002Fverify","docs\u002Fmcp\u002F1.getting-started\u002F4.verify",{"title":157,"path":158,"stem":159,"children":160,"page":31},"Tools","\u002Fdocs\u002Fmcp\u002Ftools","docs\u002Fmcp\u002F2.tools",[161,165,169,173,177,181,185],{"title":162,"path":163,"stem":164},"list_endpoints","\u002Fdocs\u002Fmcp\u002Ftools\u002Flist-endpoints","docs\u002Fmcp\u002F2.tools\u002F1.list-endpoints",{"title":166,"path":167,"stem":168},"get_endpoint","\u002Fdocs\u002Fmcp\u002Ftools\u002Fget-endpoint","docs\u002Fmcp\u002F2.tools\u002F2.get-endpoint",{"title":170,"path":171,"stem":172},"get_schema","\u002Fdocs\u002Fmcp\u002Ftools\u002Fget-schema","docs\u002Fmcp\u002F2.tools\u002F3.get-schema",{"title":174,"path":175,"stem":176},"list_schemas","\u002Fdocs\u002Fmcp\u002Ftools\u002Flist-schemas","docs\u002Fmcp\u002F2.tools\u002F4.list-schemas",{"title":178,"path":179,"stem":180},"search_docs","\u002Fdocs\u002Fmcp\u002Ftools\u002Fsearch-docs","docs\u002Fmcp\u002F2.tools\u002F5.search-docs",{"title":182,"path":183,"stem":184},"get_api_overview","\u002Fdocs\u002Fmcp\u002Ftools\u002Fget-api-overview","docs\u002Fmcp\u002F2.tools\u002F6.get-api-overview",{"title":186,"path":187,"stem":188},"get_description","\u002Fdocs\u002Fmcp\u002Ftools\u002Fget-description","docs\u002Fmcp\u002F2.tools\u002F7.get-description",{"title":190,"path":191,"stem":192,"children":193,"page":31},"Examples","\u002Fdocs\u002Fmcp\u002Fexamples","docs\u002Fmcp\u002F3.examples",[194,198,202,206,210],{"title":195,"path":196,"stem":197},"Exploring an API","\u002Fdocs\u002Fmcp\u002Fexamples\u002Fexploring-an-api","docs\u002Fmcp\u002F3.examples\u002F1.exploring-an-api",{"title":199,"path":200,"stem":201},"Building a Feature","\u002Fdocs\u002Fmcp\u002Fexamples\u002Fbuilding-a-feature","docs\u002Fmcp\u002F3.examples\u002F2.building-a-feature",{"title":203,"path":204,"stem":205},"Understanding Models","\u002Fdocs\u002Fmcp\u002Fexamples\u002Funderstanding-models","docs\u002Fmcp\u002F3.examples\u002F3.understanding-models",{"title":207,"path":208,"stem":209},"Code Review","\u002Fdocs\u002Fmcp\u002Fexamples\u002Fcode-review","docs\u002Fmcp\u002F3.examples\u002F4.code-review",{"title":211,"path":212,"stem":213},"Tips","\u002Fdocs\u002Fmcp\u002Fexamples\u002Ftips","docs\u002Fmcp\u002F3.examples\u002F5.tips",{"id":215,"title":93,"body":216,"description":834,"extension":835,"links":836,"meta":837,"navigation":838,"path":94,"seo":839,"stem":95,"__hash__":840},"docs\u002Fdocs\u002Fevents\u002F1.getting-started\u002F3.event-reference.md",{"type":217,"value":218,"toc":825},"minimark",[219,223,227,232,293,297,349,353,395,399,441,445,487,491,533,537,540,724,807,821],[220,221,93],"h1",{"id":222},"event-reference",[224,225,226],"p",{},"This page lists every event type you can subscribe to via the Events API.",[228,229,231],"h2",{"id":230},"orders","Orders",[233,234,235,248],"table",{},[236,237,238],"thead",{},[239,240,241,245],"tr",{},[242,243,244],"th",{},"Event",[242,246,247],{},"Description",[249,250,251,263,273,283],"tbody",{},[239,252,253,260],{},[254,255,256],"td",{},[257,258,259],"code",{},"orderCreated",[254,261,262],{},"A new order has been created. Includes the full order document with line items, customer, totals, and payment info.",[239,264,265,270],{},[254,266,267],{},[257,268,269],{},"orderUpdated",[254,271,272],{},"An order has been modified — status change, line item update, shipping info added, etc.",[239,274,275,280],{},[254,276,277],{},[257,278,279],{},"orderDeleted",[254,281,282],{},"An order has been deleted. The payload includes the order ID and basic metadata.",[239,284,285,290],{},[254,286,287],{},[257,288,289],{},"orderReadyForPickup",[254,291,292],{},"An order has been marked as ready for customer pickup at a physical location.",[228,294,296],{"id":295},"cart","Cart",[233,298,299,307],{},[236,300,301],{},[239,302,303,305],{},[242,304,244],{},[242,306,247],{},[249,308,309,319,329,339],{},[239,310,311,316],{},[254,312,313],{},[257,314,315],{},"cartCreated",[254,317,318],{},"A new shopping cart has been created.",[239,320,321,326],{},[254,322,323],{},[257,324,325],{},"cartUpdated",[254,327,328],{},"A cart has been modified — items added\u002Fremoved, customer set, shipping method changed, discount applied, etc.",[239,330,331,336],{},[254,332,333],{},[257,334,335],{},"cartDeleted",[254,337,338],{},"A cart has been deleted (expired or manually removed).",[239,340,341,346],{},[254,342,343],{},[257,344,345],{},"cartFullyPaid",[254,347,348],{},"A cart has been fully paid and is ready for order completion.",[228,350,352],{"id":351},"products","Products",[233,354,355,363],{},[236,356,357],{},[239,358,359,361],{},[242,360,244],{},[242,362,247],{},[249,364,365,375,385],{},[239,366,367,372],{},[254,368,369],{},[257,370,371],{},"productCreated",[254,373,374],{},"A new product has been created. Includes the full product document with variants, pricing, and attributes.",[239,376,377,382],{},[254,378,379],{},[257,380,381],{},"productUpdated",[254,383,384],{},"A product has been modified — name, description, price, images, attributes, stock, etc.",[239,386,387,392],{},[254,388,389],{},[257,390,391],{},"productDeleted",[254,393,394],{},"A product has been deleted.",[228,396,398],{"id":397},"transfers","Transfers",[233,400,401,409],{},[236,402,403],{},[239,404,405,407],{},[242,406,244],{},[242,408,247],{},[249,410,411,421,431],{},[239,412,413,418],{},[254,414,415],{},[257,416,417],{},"transferCreated",[254,419,420],{},"A stock transfer between warehouses\u002Flocations has been created.",[239,422,423,428],{},[254,424,425],{},[257,426,427],{},"transferUpdated",[254,429,430],{},"A stock transfer has been modified (quantity adjusted, status changed).",[239,432,433,438],{},[254,434,435],{},[257,436,437],{},"transferDeleted",[254,439,440],{},"A stock transfer has been deleted.",[228,442,444],{"id":443},"purchases","Purchases",[233,446,447,455],{},[236,448,449],{},[239,450,451,453],{},[242,452,244],{},[242,454,247],{},[249,456,457,467,477],{},[239,458,459,464],{},[254,460,461],{},[257,462,463],{},"purchaseCreated",[254,465,466],{},"A purchase order (buying from supplier) has been created.",[239,468,469,474],{},[254,470,471],{},[257,472,473],{},"purchaseUpdated",[254,475,476],{},"A purchase order has been modified.",[239,478,479,484],{},[254,480,481],{},[257,482,483],{},"purchaseDeleted",[254,485,486],{},"A purchase order has been deleted.",[228,488,490],{"id":489},"fulfillment","Fulfillment",[233,492,493,501],{},[236,494,495],{},[239,496,497,499],{},[242,498,244],{},[242,500,247],{},[249,502,503,513,523],{},[239,504,505,510],{},[254,506,507],{},[257,508,509],{},"fulfillmentCreated",[254,511,512],{},"A fulfillment (packing\u002Fshipping job) has been created for an order.",[239,514,515,520],{},[254,516,517],{},[257,518,519],{},"fulfillmentUpdated",[254,521,522],{},"A fulfillment has been modified (tracking number added, status changed).",[239,524,525,530],{},[254,526,527],{},[257,528,529],{},"fulfillmentDeleted",[254,531,532],{},"A fulfillment has been deleted.",[228,534,536],{"id":535},"payload-structure","Payload structure",[224,538,539],{},"Every event payload follows the same structure:",[541,542,547],"pre",{"className":543,"code":544,"language":545,"meta":546,"style":546},"language-json shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","{\n  \"_meta\": {\n    \"eventType\": \"orderCreated\",\n    \"entityType\": \"order\",\n    \"tenantId\": \"676140c4...\",\n    \"messageId\": \"unique-message-id\",\n    \"timestamp\": \"2025-06-15T14:30:00.000Z\"\n  },\n  \"data\": {\n    \u002F\u002F The full entity document at the time the event was fired\n  }\n}\n","json","",[257,548,549,558,577,602,623,644,665,685,691,705,712,718],{"__ignoreMap":546},[550,551,554],"span",{"class":552,"line":553},"line",1,[550,555,557],{"class":556},"sMK4o","{\n",[550,559,561,564,568,571,574],{"class":552,"line":560},2,[550,562,563],{"class":556},"  \"",[550,565,567],{"class":566},"spNyl","_meta",[550,569,570],{"class":556},"\"",[550,572,573],{"class":556},":",[550,575,576],{"class":556}," {\n",[550,578,580,583,587,589,591,594,597,599],{"class":552,"line":579},3,[550,581,582],{"class":556},"    \"",[550,584,586],{"class":585},"sBMFI","eventType",[550,588,570],{"class":556},[550,590,573],{"class":556},[550,592,593],{"class":556}," \"",[550,595,259],{"class":596},"sfazB",[550,598,570],{"class":556},[550,600,601],{"class":556},",\n",[550,603,605,607,610,612,614,616,619,621],{"class":552,"line":604},4,[550,606,582],{"class":556},[550,608,609],{"class":585},"entityType",[550,611,570],{"class":556},[550,613,573],{"class":556},[550,615,593],{"class":556},[550,617,618],{"class":596},"order",[550,620,570],{"class":556},[550,622,601],{"class":556},[550,624,626,628,631,633,635,637,640,642],{"class":552,"line":625},5,[550,627,582],{"class":556},[550,629,630],{"class":585},"tenantId",[550,632,570],{"class":556},[550,634,573],{"class":556},[550,636,593],{"class":556},[550,638,639],{"class":596},"676140c4...",[550,641,570],{"class":556},[550,643,601],{"class":556},[550,645,647,649,652,654,656,658,661,663],{"class":552,"line":646},6,[550,648,582],{"class":556},[550,650,651],{"class":585},"messageId",[550,653,570],{"class":556},[550,655,573],{"class":556},[550,657,593],{"class":556},[550,659,660],{"class":596},"unique-message-id",[550,662,570],{"class":556},[550,664,601],{"class":556},[550,666,668,670,673,675,677,679,682],{"class":552,"line":667},7,[550,669,582],{"class":556},[550,671,672],{"class":585},"timestamp",[550,674,570],{"class":556},[550,676,573],{"class":556},[550,678,593],{"class":556},[550,680,681],{"class":596},"2025-06-15T14:30:00.000Z",[550,683,684],{"class":556},"\"\n",[550,686,688],{"class":552,"line":687},8,[550,689,690],{"class":556},"  },\n",[550,692,694,696,699,701,703],{"class":552,"line":693},9,[550,695,563],{"class":556},[550,697,698],{"class":566},"data",[550,700,570],{"class":556},[550,702,573],{"class":556},[550,704,576],{"class":556},[550,706,708],{"class":552,"line":707},10,[550,709,711],{"class":710},"sHwdD","    \u002F\u002F The full entity document at the time the event was fired\n",[550,713,715],{"class":552,"line":714},11,[550,716,717],{"class":556},"  }\n",[550,719,721],{"class":552,"line":720},12,[550,722,723],{"class":556},"}\n",[233,725,726,735],{},[236,727,728],{},[239,729,730,733],{},[242,731,732],{},"Field",[242,734,247],{},[249,736,737,750,768,778,788,798],{},[239,738,739,744],{},[254,740,741],{},[257,742,743],{},"_meta.eventType",[254,745,746,747,749],{},"The event type (matches your subscription's ",[257,748,586],{},")",[239,751,752,757],{},[254,753,754],{},[257,755,756],{},"_meta.entityType",[254,758,759,760,762,763,762,766,749],{},"The entity category (e.g. ",[257,761,618],{},", ",[257,764,765],{},"product",[257,767,295],{},[239,769,770,775],{},[254,771,772],{},[257,773,774],{},"_meta.tenantId",[254,776,777],{},"Your tenant ID",[239,779,780,785],{},[254,781,782],{},[257,783,784],{},"_meta.messageId",[254,786,787],{},"Unique ID for this event — useful for deduplication",[239,789,790,795],{},[254,791,792],{},[257,793,794],{},"_meta.timestamp",[254,796,797],{},"ISO 8601 timestamp of when the event was published",[239,799,800,804],{},[254,801,802],{},[257,803,698],{},[254,805,806],{},"The full entity document. Structure varies by entity type.",[808,809,811,812,817,818,820],"callout",{"icon":810},"i-lucide-lightbulb","Use the ",[813,814,816],"a",{"href":815},"\u002Fmanagement\u002Freference","Management API Reference"," to explore the full schema for each entity type (orders, products, carts, etc.). The ",[257,819,698],{}," payload matches the document structure returned by the corresponding GET endpoint.",[822,823,824],"style",{},"html pre.shiki code .sMK4o, html code.shiki .sMK4o{--shiki-light:#39ADB5;--shiki-default:#89DDFF;--shiki-dark:#89DDFF}html pre.shiki code .spNyl, html code.shiki .spNyl{--shiki-light:#9C3EDA;--shiki-default:#C792EA;--shiki-dark:#C792EA}html pre.shiki code .sBMFI, html code.shiki .sBMFI{--shiki-light:#E2931D;--shiki-default:#FFCB6B;--shiki-dark:#FFCB6B}html pre.shiki code .sfazB, html code.shiki .sfazB{--shiki-light:#91B859;--shiki-default:#C3E88D;--shiki-dark:#C3E88D}html pre.shiki code .sHwdD, html code.shiki .sHwdD{--shiki-light:#90A4AE;--shiki-light-font-style:italic;--shiki-default:#546E7A;--shiki-default-font-style:italic;--shiki-dark:#676E95;--shiki-dark-font-style:italic}html .light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html.light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}",{"title":546,"searchDepth":560,"depth":560,"links":826},[827,828,829,830,831,832,833],{"id":230,"depth":560,"text":231},{"id":295,"depth":560,"text":296},{"id":351,"depth":560,"text":352},{"id":397,"depth":560,"text":398},{"id":443,"depth":560,"text":444},{"id":489,"depth":560,"text":490},{"id":535,"depth":560,"text":536},"All available domain events with descriptions","md",null,{},true,{"title":93,"description":834},"3BhlnUHodYlK_R3VkfhBONnSkKBCQaM9u5gZzjuEuW8",[842,844],{"title":89,"path":90,"stem":91,"description":843,"children":-1},"How Avvyr delivers events to your endpoint — payload format, authentication, retries, and signature verification",{"title":97,"path":98,"stem":99,"description":845,"children":-1},"Connect Avvyr to external systems — ERP, accounting, marketing, shipping, and more",1775725944121]