/*! For license information please see main.ccfa74ac.js.LICENSE.txt */
(self.webpackChunkdeveloper_docs=self.webpackChunkdeveloper_docs||[]).push([[38792],{89188:(e,t,r)=>{"use strict";r.d(t,{W:()=>o});var n=r(96540);function o(){return n.createElement("svg",{width:"20",height:"20",className:"DocSearch-Search-Icon",viewBox:"0 0 20 20","aria-hidden":"true"},n.createElement("path",{d:"M14.386 14.386l4.0877 4.0877-4.0877-4.0877c-2.9418 2.9419-7.7115 2.9419-10.6533 0-2.9419-2.9418-2.9419-7.7115 0-10.6533 2.9418-2.9419 7.7115-2.9419 10.6533 0 2.9419 2.9418 2.9419 7.7115 0 10.6533z",stroke:"currentColor",fill:"none",fillRule:"evenodd",strokeLinecap:"round",strokeLinejoin:"round"}))}},35947:(e,t,r)=>{"use strict";r.d(t,{A:()=>u});r(96540);var n=r(53259),o=r.n(n),i=r(84054);const s={"013b08b3":[()=>r.e(70968).then(r.bind(r,82659)),"@site/blog/2023-07-14.mdx",82659],"019e9cc6":[()=>r.e(69635).then(r.bind(r,59394)),"@site/docs/solutions/blueprints/platform-connector.mdx",59394],"01a85c17":[()=>Promise.all([r.e(71869),r.e(8209)]).then(r.bind(r,29140)),"@theme/BlogTagsListPage",29140],"01bb7bc7":[()=>r.e(47223).then(r.bind(r,21450)),"@site/blog/2023-04-21.mdx",21450],"028f387b":[()=>r.e(76941).then(r.bind(r,59732)),"@site/blog/2023-05-18-2.mdx?truncated=true",59732],"02ed6f87":[()=>r.e(27601).then(r.bind(r,8093)),"@site/docs/price-rules/references/frontend-api.mdx",8093],"0359fcc2":[()=>r.e(37108).then(r.t.bind(r,14571,19)),"@generated/docusaurus-plugin-content-docs/default/p/guides-tags-shipper-hq-e5b.json",14571],"03a0fca9":[()=>r.e(28).then(r.bind(r,62811)),"@site/docs/checkout/plugins/index.mdx",62811],"03c9cabe":[()=>r.e(9655).then(r.bind(r,55840)),"@site/blog/2024-01-16.mdx?truncated=true",55840],"046235e5":[()=>r.e(4893).then(r.bind(r,83335)),"@site/blog/2023-10-10.mdx",83335],"05588b06":[()=>r.e(91213).then(r.t.bind(r,62199,19)),"/home/runner/work/developer-docs/developer-docs/.docusaurus/docusaurus-plugin-redoc/plugin-redoc-1/redocApiSpecV1.2-plugin-redoc-1.json",62199],"05834f9b":[()=>r.e(90034).then(r.bind(r,68850)),"@site/docs/checkout/integrations/commercetools.mdx",68850],"05ae2100":[()=>r.e(54239).then(r.t.bind(r,23668,19)),"@generated/docusaurus-plugin-content-docs/default/p/guides-tags-area-384.json",23668],"05d9ef96":[()=>Promise.all([r.e(71869),r.e(71471)]).then(r.bind(r,32968)),"@site/docs/checkout/bold-boosters/set-up-apple-pay.mdx",32968],"061f685f":[()=>Promise.all([r.e(71869),r.e(23063)]).then(r.bind(r,97736)),"@site/docs/platform-integration/adobe-commerce/troubleshooting.mdx",97736],"07d304fa":[()=>r.e(60868).then(r.t.bind(r,62925,19)),"@generated/docusaurus-plugin-content-blog/default/p/changelog-tags-4f2.json",62925],"086ed28a":[()=>r.e(56515).then(r.t.bind(r,68096,19)),"/home/runner/work/developer-docs/developer-docs/.docusaurus/docusaurus-plugin-redoc/plugin-redoc-7/redocApiLayoutV1-plugin-redoc-7.json",68096],"096a8400":[()=>r.e(54489).then(r.bind(r,12179)),"@site/docs/price-rules/index.mdx",12179],"09759d9e":[()=>r.e(52435).then(r.bind(r,22243)),"@site/docs/checkout/plugins/getting-started.mdx",22243],"0bf819ce":[()=>r.e(33397).then(r.t.bind(r,44360,19)),"/home/runner/work/developer-docs/developer-docs/.docusaurus/docusaurus-plugin-redoc/plugin-redoc-6/redocApiLayoutV1-plugin-redoc-6.json",44360],"0c0c8d35":[()=>r.e(55611).then(r.bind(r,14303)),"@site/docs/solutions/bold-built/braintree.mdx",14303],"0c6b229a":[()=>r.e(27458).then(r.bind(r,64415)),"@site/docs/platform-integration/magento-1/concepts.mdx",64415],"0ef60b25":[()=>Promise.all([r.e(71869),r.e(15394),r.e(30895)]).then(r.bind(r,6327)),"@site/docs/checkout/fulfill-order.mdx",6327],"0fcb85a4":[()=>r.e(95064).then(r.t.bind(r,46034,19)),"@generated/docusaurus-plugin-content-docs/default/p/guides-tags-payment-gateway-d1d.json",46034],"0ff48c37":[()=>r.e(91502).then(r.bind(r,40738)),"@site/blog/2023-05-26.mdx",40738],"1096c25f":[()=>r.e(88615).then(r.t.bind(r,36160,19)),"/home/runner/work/developer-docs/developer-docs/.docusaurus/docusaurus-plugin-redoc/plugin-redoc-4/redocApiLayoutV1-plugin-redoc-4.json",36160],"11c34f40":[()=>r.e(17793).then(r.bind(r,54124)),"@site/docs/price-rules/working-with-rulesets/price-adjustments.mdx",54124],"126328f1":[()=>r.e(20850).then(r.t.bind(r,73369,19)),"@generated/docusaurus-plugin-content-docs/default/p/guides-tags-algolia-bf8.json",73369],"129cd899":[()=>r.e(82664).then(r.t.bind(r,94189,19)),"@generated/docusaurus-plugin-content-docs/default/p/guides-tags-pay-pal-complete-payments-f6c.json",94189],"12a02ba9":[()=>r.e(519).then(r.t.bind(r,98048,19)),"/home/runner/work/developer-docs/developer-docs/.docusaurus/docusaurus-plugin-redoc/plugin-redoc-2/redocApiLayoutV1-plugin-redoc-2.json",98048],"12b52f02":[()=>r.e(26891).then(r.bind(r,49484)),"@site/blog/2024-03-25.mdx",49484],"12e87cfc":[()=>r.e(64454).then(r.bind(r,82520)),"@site/docs/platform-integration/magento-1/troubleshooting.mdx",82520],"14bb7233":[()=>r.e(57277).then(r.bind(r,77765)),"@site/blog/2024-03-28.mdx",77765],"152456bb":[()=>r.e(93434).then(r.bind(r,91229)),"@site/blog/2023-07-25.mdx?truncated=true",91229],"15ed5882":[()=>r.e(77071).then(r.bind(r,4894)),"@site/blog/2022-09-23.mdx",4894],"15feefe1":[()=>r.e(48657).then(r.bind(r,97793)),"@site/docs/checkout/resources/error-responses.mdx",97793],"16044b28":[()=>r.e(18758).then(r.bind(r,93517)),"@site/blog/2023-09-27-1.mdx",93517],"1756e9cf":[()=>Promise.all([r.e(71869),r.e(47503)]).then(r.bind(r,95543)),"@site/docs/checkout/bold-boosters/connect-braintree.mdx",95543],17896441:[()=>Promise.all([r.e(71869),r.e(15394),r.e(73019),r.e(3671),r.e(18401)]).then(r.bind(r,47022)),"@theme/DocItem",47022],"17c9e882":[()=>r.e(89258).then(r.bind(r,73435)),"@site/blog/2024-01-02.mdx",73435],"18314aad":[()=>r.e(22770).then(r.t.bind(r,14154,19)),"@generated/docusaurus-plugin-content-docs/default/p/guides-tags-checkout-experience-templates-249.json",14154],"1918bf25":[()=>r.e(77049).then(r.bind(r,49732)),"@site/blog/2024-01-16.mdx",49732],"1a4e3797":[()=>Promise.all([r.e(71869),r.e(62138)]).then(r.bind(r,10673)),"@theme/SearchPage",10673],"1a73a0d3":[()=>r.e(88575).then(r.bind(r,24551)),"@site/blog/2023-08-08.mdx?truncated=true",24551],"1b84d22a":[()=>r.e(75651).then(r.bind(r,30623)),"@site/blog/2023-04-04.mdx?truncated=true",30623],"1baa23ab":[()=>r.e(27624).then(r.bind(r,32428)),"@site/blog/2022-12-02-2.mdx",32428],"1c1b9ca6":[()=>Promise.all([r.e(71869),r.e(92187)]).then(r.bind(r,83056)),"@site/docs/checkout/bold-boosters/install-compatibility-modules.mdx",83056],"1c5b18b6":[()=>r.e(43977).then(r.bind(r,26576)),"@site/blog/2023-12-11.mdx",26576],"1c6bfda8":[()=>Promise.all([r.e(71869),r.e(15394),r.e(58310)]).then(r.bind(r,36413)),"@site/docs/subscriptions-v2/headless/storefront-setup.mdx",36413],"1de9b3cd":[()=>r.e(81778).then(r.t.bind(r,43979,19)),"/home/runner/work/developer-docs/developer-docs/.docusaurus/docusaurus-plugin-redoc/plugin-redoc-2/redocApiSpecV1.2-plugin-redoc-2.json",43979],"1df93b7f":[()=>Promise.all([r.e(71869),r.e(34583)]).then(r.bind(r,92462)),"@site/src/pages/index.tsx",92462],"1e058c00":[()=>r.e(8223).then(r.bind(r,63773)),"@site/docs/solutions/bold-built/shipping.mdx",63773],"1e188057":[()=>r.e(28826).then(r.bind(r,87917)),"@site/docs/solutions/bold-built/commercetools.mdx",87917],"1ebebbee":[()=>r.e(31732).then(r.bind(r,56740)),"@site/blog/2023-11-21.mdx?truncated=true",56740],"1f66b349":[()=>r.e(62230).then(r.bind(r,70292)),"@site/blog/2022-12-14.mdx?truncated=true",70292],"1feb10c6":[()=>r.e(20847).then(r.bind(r,51579)),"@site/docs/checkout/create-order.mdx",51579],"206acd2e":[()=>r.e(28900).then(r.bind(r,60802)),"@site/docs/solutions/blueprints/search-constructor.mdx",60802],"207f8656":[()=>r.e(37953).then(r.bind(r,45487)),"@site/docs/platform-integration/bigcommerce/pre.mdx",45487],"20e47cd0":[()=>r.e(69188).then(r.bind(r,69352)),"@site/blog/2023-04-05.mdx",69352],"216d6b37":[()=>Promise.all([r.e(71869),r.e(15394),r.e(53728)]).then(r.bind(r,25736)),"@site/docs/subscriptions-v2/public-integrations.mdx",25736],"218ea731":[()=>r.e(41121).then(r.bind(r,35362)),"@site/docs/checkout/resources/open-source.mdx",35362],"21b937f7":[()=>r.e(77088).then(r.bind(r,63147)),"@site/blog/2023-03-09.mdx?truncated=true",63147],"22188c71":[()=>r.e(75431).then(r.bind(r,75561)),"@site/docs/checkout/concepts/headless.mdx",75561],"22449fb1":[()=>r.e(31349).then(r.bind(r,33123)),"@site/blog/2023-08-22.mdx?truncated=true",33123],"22cbcfd9":[()=>r.e(32002).then(r.t.bind(r,11129,19)),"@generated/docusaurus-plugin-content-docs/default/p/guides-tags-convert-from-search-95d.json",11129],"2308e035":[()=>r.e(23361).then(r.t.bind(r,34782,19)),"@generated/docusaurus-plugin-content-blog/default/p/changelog-archive-7c0.json",34782],"24e5fb8d":[()=>r.e(44279).then(r.t.bind(r,23541,19)),"@generated/docusaurus-plugin-content-docs/default/p/guides-tags-apple-pay-a7d.json",23541],"250aabba":[()=>r.e(65267).then(r.bind(r,31809)),"@site/blog/2022-12-02-01.mdx",31809],"25da6a08":[()=>Promise.all([r.e(71869),r.e(30642),r.e(17264),r.e(42218)]).then(r.bind(r,93260)),"@site/docs/checkout/bold-boosters/bold-booster-for-paypal-overview.mdx",93260],"26354ec1":[()=>r.e(66022).then(r.t.bind(r,28716,19)),"@generated/docusaurus-plugin-content-docs/default/p/guides-tags-adobe-commerce-4ed.json",28716],"26fdda53":[()=>r.e(58096).then(r.t.bind(r,74071,19)),"/home/runner/work/developer-docs/developer-docs/.docusaurus/docusaurus-plugin-redoc/plugin-redoc-9/redocApiSpecV1.2-plugin-redoc-9.json",74071],"27dd01ec":[()=>r.e(89391).then(r.bind(r,71708)),"@site/blog/2022-09-29.mdx",71708],"2812ebd9":[()=>r.e(89136).then(r.t.bind(r,51269,19)),"@generated/docusaurus-plugin-content-docs/default/p/guides-tags-conversion-e8f.json",51269],"282f6ca7":[()=>Promise.all([r.e(71869),r.e(65280)]).then(r.bind(r,16934)),"@site/docs/checkout/bold-boosters/connect-authorize.mdx",16934],"28e36230":[()=>r.e(8888).then(r.t.bind(r,40394,19)),"@generated/docusaurus-plugin-content-docs/default/p/guides-tags-tax-jar-cd0.json",40394],"2926825b":[()=>r.e(52743).then(r.bind(r,35726)),"@site/blog/2024-06-06.mdx?truncated=true",35726],"29f817bb":[()=>r.e(44498).then(r.t.bind(r,68099,19)),"/home/runner/work/developer-docs/developer-docs/.docusaurus/docusaurus-plugin-redoc/plugin-redoc-6/redocApiSpecV1.2-plugin-redoc-6.json",68099],"2beb3a58":[()=>r.e(38269).then(r.t.bind(r,4668,19)),"@generated/docusaurus-plugin-content-docs/default/p/guides-tags-wink-654.json",4668],"2d3b27e3":[()=>r.e(22599).then(r.bind(r,67268)),"@site/blog/2022-10-18-1.mdx?truncated=true",67268],"2d680932":[()=>r.e(39385).then(r.bind(r,86299)),"@site/blog/2024-01-17.mdx?truncated=true",86299],"2e715987":[()=>r.e(1301).then(r.bind(r,40250)),"@site/docs/solutions/blueprints/klarna.mdx",40250],"2e9f1eb7":[()=>r.e(75042).then(r.bind(r,12036)),"@site/blog/2022-07-21-1.mdx?truncated=true",12036],"2efa2b47":[()=>Promise.all([r.e(71869),r.e(78656)]).then(r.bind(r,85445)),"@site/docs/checkout/bold-boosters/bold-booster-upgrade.mdx",85445],"2f460e85":[()=>r.e(68377).then(r.bind(r,1264)),"@site/blog/2023-05-02.mdx?truncated=true",1264],"2f543d31":[()=>r.e(46005).then(r.bind(r,81062)),"@site/docs/subscriptions-v2/concepts.mdx",81062],"2f6beaf6":[()=>r.e(37273).then(r.t.bind(r,64199,19)),"@generated/docusaurus-plugin-redoc/plugin-redoc-5/__plugin.json",64199],"2f72bd59":[()=>r.e(15832).then(r.t.bind(r,79990,19)),"@generated/docusaurus-plugin-content-blog/default/p/changelog-036.json",79990],"320311d2":[()=>r.e(80903).then(r.t.bind(r,9658,19)),"@generated/docusaurus-plugin-content-docs/default/p/guides-tags-platform-159.json",9658],"32270c83":[()=>r.e(70137).then(r.bind(r,2703)),"@site/blog/2023-05-10.mdx?truncated=true",2703],"327f0203":[()=>r.e(89922).then(r.t.bind(r,79760,19)),"@generated/docusaurus-plugin-redoc/plugin-redoc-11/__plugin.json",79760],"3402c51f":[()=>r.e(53445).then(r.bind(r,84757)),"@site/blog/2023-03-27.mdx",84757],"35a762ac":[()=>r.e(37255).then(r.t.bind(r,36479,19)),"@generated/docusaurus-plugin-content-docs/default/p/guides-tags-buy-now-800.json",36479],"35f98246":[()=>r.e(83992).then(r.bind(r,12668)),"@site/blog/2023-12-11.mdx?truncated=true",12668],36076582:[()=>r.e(17474).then(r.bind(r,25894)),"@site/docs/checkout/concepts/plugins.mdx",25894],"364990a8":[()=>r.e(67745).then(r.bind(r,7909)),"@site/blog/2022-11-10.mdx",7909],"365589ae":[()=>r.e(14841).then(r.bind(r,99083)),"@site/docs/platform-integration/adobe-commerce/dev-store.mdx",99083],"36994c47":[()=>r.e(89858).then(r.t.bind(r,45516,19)),"@generated/docusaurus-plugin-content-blog/default/__plugin.json",45516],"371bd825":[()=>r.e(34351).then(r.t.bind(r,26186,19)),"/home/runner/work/developer-docs/developer-docs/.docusaurus/docusaurus-plugin-redoc/plugin-redoc-12/redocApiLayoutV1-plugin-redoc-12.json",26186],"3720c009":[()=>Promise.all([r.e(71869),r.e(84787)]).then(r.bind(r,12194)),"@theme/DocTagsListPage",12194],"37a49784":[()=>r.e(98562).then(r.bind(r,15976)),"@site/blog/2023-02-07.mdx?truncated=true",15976],"381798e0":[()=>r.e(98374).then(r.bind(r,70212)),"@site/blog/2023-12-15.mdx",70212],"3896737e":[()=>r.e(83929).then(r.t.bind(r,53011,19)),"@generated/docusaurus-plugin-redoc/plugin-redoc-9/__plugin.json",53011],"38fbc61d":[()=>r.e(34690).then(r.bind(r,33638)),"@site/docs/checkout/concepts/index.mdx",33638],"3ac52e9f":[()=>Promise.all([r.e(71869),r.e(38233)]).then(r.bind(r,11770)),"@site/src/pages/solution-library.tsx",11770],"3b06b79c":[()=>Promise.all([r.e(71869),r.e(36415)]).then(r.bind(r,65231)),"@site/docs/archive/index.mdx",65231],"3b0c5da3":[()=>r.e(26688).then(r.t.bind(r,80521,19)),"@generated/docusaurus-plugin-content-docs/default/p/guides-tags-partner-type-831.json",80521],"3b98b72e":[()=>r.e(73517).then(r.bind(r,28927)),"@site/blog/2024-04-23.mdx",28927],"3beaf1fb":[()=>r.e(59473).then(r.bind(r,98770)),"@site/docs/checkout/plugins/installation-flow.mdx",98770],"3c00c6bd":[()=>Promise.all([r.e(71869),r.e(15394),r.e(59468)]).then(r.bind(r,66046)),"@site/docs/subscriptions-v2/resources/api-versioning.mdx",66046],"3c0eb5c2":[()=>Promise.all([r.e(71869),r.e(4672)]).then(r.bind(r,23845)),"@site/docs/checkout/bold-boosters/connect-payment-gateways.mdx",23845],"3d25f1b1":[()=>r.e(5741).then(r.t.bind(r,7949,19)),"@generated/docusaurus-plugin-redoc/plugin-redoc-7/__plugin.json",7949],"3e088593":[()=>r.e(11038).then(r.t.bind(r,75431,19)),"@generated/docusaurus-plugin-content-docs/default/p/guides-5ed.json",75431],"3e4e0c9f":[()=>r.e(17028).then(r.bind(r,36988)),"@site/docs/solutions/bold-built/bigcommerce.mdx",36988],"3e8ea28b":[()=>r.e(18093).then(r.t.bind(r,27083,19)),"@generated/docusaurus-plugin-content-docs/default/p/guides-tags-express-checkout-92c.json",27083],"3e9c5392":[()=>r.e(63010).then(r.bind(r,20478)),"@site/docs/checkout/concepts/spi-integrate.mdx",20478],"3e9f6079":[()=>Promise.all([r.e(71869),r.e(93548)]).then(r.bind(r,28172)),"@site/docs/checkout/bold-boosters/export-request-logs.mdx",28172],"3f285aa8":[()=>r.e(29163).then(r.bind(r,61579)),"@site/blog/2023-06-13.mdx",61579],"3f4cdd6c":[()=>r.e(28870).then(r.bind(r,15081)),"@site/docs/archive/subscriptions_v1_storefront.mdx",15081],"3fc31e27":[()=>r.e(40805).then(r.t.bind(r,37607,19)),"/home/runner/work/developer-docs/developer-docs/.docusaurus/docusaurus-plugin-redoc/plugin-redoc-5/redocApiSpecV1.2-plugin-redoc-5.json",37607],"407941e5":[()=>Promise.all([r.e(71869),r.e(3632)]).then(r.bind(r,79677)),"@site/docs/archive/installation_m1.mdx",79677],"40fa253f":[()=>r.e(31476).then(r.bind(r,22380)),"@site/blog/2023-04-21-1.mdx?truncated=true",22380],41051053:[()=>r.e(52288).then(r.t.bind(r,16768,19)),"/home/runner/work/developer-docs/developer-docs/.docusaurus/docusaurus-plugin-redoc/plugin-redoc-1/redocApiLayoutV1-plugin-redoc-1.json",16768],"4176d444":[()=>r.e(78861).then(r.bind(r,28870)),"@site/blog/2023-09-22.mdx?truncated=true",28870],"4179f89d":[()=>r.e(22807).then(r.bind(r,39863)),"@site/blog/2023-04-04-1.mdx",39863],"417badab":[()=>r.e(16271).then(r.bind(r,46005)),"@site/docs/checkout/concepts/payment-information.mdx",46005],"419031ba":[()=>r.e(12702).then(r.bind(r,11645)),"@site/blog/2023-07-14-1.mdx",11645],"42143f48":[()=>r.e(40877).then(r.bind(r,46986)),"@site/blog/2022-07-29.mdx",46986],"42eed18b":[()=>r.e(44632).then(r.bind(r,39330)),"@site/blog/2022-09-23.mdx?truncated=true",39330],"437d2981":[()=>Promise.all([r.e(71869),r.e(15394),r.e(71915)]).then(r.bind(r,6897)),"@site/docs/checkout/pmmc.mdx",6897],44887076:[()=>r.e(69641).then(r.bind(r,12685)),"@site/docs/checkout/validate-discounts.mdx",12685],"452a9096":[()=>r.e(41015).then(r.bind(r,67880)),"@site/blog/2023-05-18-2.mdx",67880],"45aea981":[()=>r.e(66439).then(r.bind(r,63981)),"@site/blog/2024-01-02.mdx?truncated=true",63981],"46125cb5":[()=>Promise.all([r.e(71869),r.e(33047)]).then(r.bind(r,13271)),"@site/docs/checkout/bold-boosters/bold-booster-troubleshooting.mdx",13271],"464a882e":[()=>r.e(10795).then(r.bind(r,77934)),"@site/blog/2023-08-29.mdx",77934],"4754be42":[()=>r.e(96294).then(r.bind(r,93281)),"@site/docs/price-rules/references/actions.mdx",93281],"476a3022":[()=>Promise.all([r.e(71869),r.e(15394),r.e(58454)]).then(r.bind(r,17058)),"@site/docs/checkout/webhooks.mdx",17058],"48029edc":[()=>r.e(29852).then(r.bind(r,12532)),"@site/docs/subscriptions-v2/adjust-subscription-orders.mdx",12532],"481eaf8f":[()=>r.e(96626).then(r.t.bind(r,38129,19)),"@generated/docusaurus-plugin-content-docs/default/p/guides-tags-unsupported-platform-b8b.json",38129],"48ed49ac":[()=>r.e(27881).then(r.bind(r,60586)),"@site/blog/2025-11-18.mdx?truncated=true",60586],"4a590fd9":[()=>r.e(23491).then(r.bind(r,28357)),"@site/docs/solutions/bold-built/taxjar.mdx",28357],"4a76b343":[()=>Promise.all([r.e(71869),r.e(15394),r.e(86851)]).then(r.bind(r,84006)),"@site/docs/checkout/checkout-epg-guide.mdx",84006],"4a9b8eb6":[()=>r.e(59602).then(r.t.bind(r,85126,19)),"@generated/docusaurus-plugin-content-blog/default/p/changelog-tags-checkout-2ee.json",85126],"4ad8da9e":[()=>r.e(73989).then(r.bind(r,30246)),"@site/docs/checkout/resources/glossary.mdx",30246],"4b395a8f":[()=>r.e(81797).then(r.bind(r,50038)),"@site/blog/2023-05-26.mdx?truncated=true",50038],"4b73ab1c":[()=>r.e(43258).then(r.t.bind(r,90013,19)),"@generated/docusaurus-plugin-content-blog/default/p/changelog-tags-shops-505.json",90013],"4bb7ca0f":[()=>r.e(44922).then(r.bind(r,23493)),"@site/docs/checkout/references/checkout-epg-api.mdx",23493],"4cd9658a":[()=>r.e(18815).then(r.t.bind(r,40728,19)),"/home/runner/work/developer-docs/developer-docs/.docusaurus/docusaurus-plugin-redoc/plugin-redoc-3/redocApiLayoutV1-plugin-redoc-3.json",40728],"4d743b46":[()=>r.e(75031).then(r.bind(r,84981)),"@site/docs/solutions/bold-built/template.mdx",84981],"4db3f03b":[()=>r.e(49935).then(r.bind(r,97302)),"@site/docs/solutions/blueprints/upsell.mdx",97302],"4e24f880":[()=>r.e(23390).then(r.bind(r,37274)),"@site/blog/2022-09-16.mdx?truncated=true",37274],"4e5af80a":[()=>r.e(69231).then(r.bind(r,21400)),"@site/docs/checkout/plugins/overrides.mdx",21400],"4ee21c5c":[()=>r.e(68755).then(r.t.bind(r,31542,19)),"@generated/docusaurus-plugin-content-docs/default/p/guides-tags-magento-1-b87.json",31542],"4f5c5749":[()=>Promise.all([r.e(71869),r.e(15394),r.e(79052)]).then(r.bind(r,13139)),"@site/docs/checkout/css.mdx",13139],"4fabaee9":[()=>Promise.all([r.e(71869),r.e(75924)]).then(r.bind(r,53890)),"@site/docs/platform-connector/rsa/requirements.mdx",53890],"4fbfcdd8":[()=>Promise.all([r.e(71869),r.e(31872)]).then(r.bind(r,68924)),"@site/docs/checkout/bold-boosters/integrate-forter.mdx",68924],"4fcc2d16":[()=>r.e(51488).then(r.bind(r,9365)),"@site/blog/2023-07-14.mdx?truncated=true",9365],"4ffac51d":[()=>r.e(76873).then(r.t.bind(r,31566,19)),"@generated/docusaurus-plugin-content-docs/default/p/guides-tags-payments-cb2.json",31566],"506d5ca1":[()=>r.e(81928).then(r.bind(r,52771)),"@site/docs/price-rules/customer-targeted-pricing.mdx",52771],"51c99a15":[()=>Promise.all([r.e(71869),r.e(15394),r.e(15697)]).then(r.bind(r,56305)),"@site/docs/checkout/plugins/app-hooks.mdx",56305],"5243b79c":[()=>r.e(23736).then(r.bind(r,88751)),"@site/blog/2023-03-07.mdx",88751],"533be5a4":[()=>Promise.all([r.e(71869),r.e(68901)]).then(r.bind(r,80915)),"@site/docs/checkout/references/country-province-requirements.mdx",80915],"5371f5c8":[()=>r.e(98569).then(r.bind(r,60127)),"@site/blog/2022-09-13.mdx",60127],"54fca6b7":[()=>r.e(23029).then(r.bind(r,76588)),"@site/blog/2023-02-07.mdx",76588],"55275f57":[()=>r.e(61925).then(r.bind(r,55993)),"@site/docs/checkout/concepts/cart-parameters.mdx",55993],"55974cf6":[()=>r.e(61574).then(r.bind(r,57674)),"@site/docs/platform-integration/magento-1/extensions.mdx",57674],"559a686d":[()=>r.e(46183).then(r.bind(r,298)),"@site/docs/solutions/bold-built/magento-1.mdx",298],"55c436a7":[()=>r.e(62011).then(r.bind(r,98317)),"@site/docs/archive/subscriptions_v1_msp.mdx",98317],"57566eda":[()=>r.e(70188).then(r.bind(r,26471)),"@site/blog/2024-02-01.mdx?truncated=true",26471],"576397fa":[()=>r.e(10553).then(r.bind(r,59681)),"@site/blog/2023-03-07.mdx?truncated=true",59681],"57edebfb":[()=>r.e(83469).then(r.bind(r,60510)),"@site/docs/platform-integration/magento-1/overview.mdx",60510],"57efee46":[()=>r.e(62362).then(r.bind(r,16080)),"@site/docs/checkout/references/plugin-actions.mdx",16080],"57f42c93":[()=>Promise.all([r.e(71869),r.e(69268)]).then(r.bind(r,42459)),"@site/docs/platform-integration/adobe-commerce/versions.mdx",42459],58226553:[()=>r.e(18943).then(r.bind(r,47783)),"@site/blog/2023-04-21-2.mdx",47783],"58986d4a":[()=>Promise.all([r.e(71869),r.e(96916)]).then(r.bind(r,6539)),"@site/docs/platform-integration/magento-1/versions.mdx",6539],"58f76ef5":[()=>Promise.all([r.e(71869),r.e(32753)]).then(r.bind(r,6778)),"@site/docs/checkout/bold-boosters/connect-nuvei.mdx",6778],"59a98010":[()=>r.e(30892).then(r.bind(r,50914)),"@site/blog/2024-07-16.mdx?truncated=true",50914],"59d8b887":[()=>r.e(91912).then(r.t.bind(r,97706,19)),"@generated/docusaurus-plugin-content-docs/default/p/guides-tags-email-fa9.json",97706],"5a170c02":[()=>r.e(86456).then(r.bind(r,73050)),"@site/blog/2022-09-27.mdx",73050],"5a2491ea":[()=>r.e(20871).then(r.t.bind(r,89664,19)),"@generated/docusaurus-plugin-redoc/plugin-redoc-2/__plugin.json",89664],"5ba19106":[()=>r.e(15544).then(r.bind(r,9056)),"@site/blog/2023-04-21-1.mdx",9056],"5be7ecee":[()=>r.e(5896).then(r.bind(r,84826)),"@site/docs/subscriptions-v2/resources/error-responses.mdx",84826],"5bf88447":[()=>r.e(94231).then(r.t.bind(r,37792,19)),"/home/runner/work/developer-docs/developer-docs/.docusaurus/docusaurus-plugin-redoc/plugin-redoc-11/redocApiLayoutV1-plugin-redoc-11.json",37792],"5c996eb8":[()=>r.e(95460).then(r.t.bind(r,63673,19)),"@generated/docusaurus-plugin-content-docs/default/p/guides-tags-shipping-6f9.json",63673],"5d2ff655":[()=>r.e(47818).then(r.bind(r,49830)),"@site/docs/solutions/bold-built/adobe.mdx",49830],"5d31ee35":[()=>r.e(21686).then(r.bind(r,35879)),"@site/blog/2022-11-10.mdx?truncated=true",35879],"5dc71d8d":[()=>r.e(95461).then(r.t.bind(r,78239,19)),"/home/runner/work/developer-docs/developer-docs/.docusaurus/docusaurus-plugin-redoc/plugin-redoc-8/redocApiSpecV1.2-plugin-redoc-8.json",78239],"5e17b9a1":[()=>r.e(36664).then(r.t.bind(r,55260,19)),"@generated/docusaurus-plugin-content-docs/default/p/guides-tags-oracle-commerce-cloud-413.json",55260],"5e3de0db":[()=>r.e(96897).then(r.bind(r,19154)),"@site/docs/price-rules/working-with-rulesets/prioritization-and-stacking.mdx",19154],"5e95c892":[()=>r.e(9647).then(r.bind(r,7121)),"@theme/DocsRoot",7121],"5e9f5e1a":[()=>Promise.resolve().then(r.bind(r,4784)),"@generated/docusaurus.config",4784],"5f2ba928":[()=>r.e(62682).then(r.bind(r,48194)),"@site/blog/2023-01-17.mdx",48194],"5f8ff37c":[()=>r.e(78783).then(r.t.bind(r,33986,19)),"@generated/docusaurus-plugin-content-docs/default/p/guides-tags-orium-d4f.json",33986],"600ea7f1":[()=>r.e(95323).then(r.t.bind(r,7286,19)),"@generated/docusaurus-plugin-content-docs/default/p/guides-tags-google-pay-190.json",7286],"6082c324":[()=>r.e(58731).then(r.bind(r,27007)),"@site/blog/2023-11-22.mdx",27007],"614beea8":[()=>Promise.all([r.e(71869),r.e(15394),r.e(63635)]).then(r.bind(r,81592)),"@site/docs/checkout/gift-cards.mdx",81592],"61f3d2fb":[()=>r.e(39931).then(r.bind(r,42370)),"@site/docs/price-rules/promotion-message.mdx",42370],"6238fb38":[()=>r.e(57555).then(r.bind(r,61656)),"@site/blog/2022-10-18-1.mdx",61656],"62618a35":[()=>r.e(70561).then(r.bind(r,30887)),"@site/blog/2022-07-11.mdx",30887],"6299583b":[()=>r.e(72925).then(r.bind(r,95735)),"@site/docs/solutions/blueprints/template.mdx",95735],"62ca7c03":[()=>r.e(82718).then(r.t.bind(r,69659,19)),"@generated/docusaurus-plugin-content-docs/default/p/guides-tags-platform-connector-fff.json",69659],"62d96ace":[()=>r.e(3249).then(r.bind(r,92801)),"@site/docs/subscriptions-v2/resources/open-source.mdx",92801],"63031fe5":[()=>r.e(54994).then(r.bind(r,82426)),"@site/blog/2022-08-02.mdx?truncated=true",82426],"648652f2":[()=>r.e(99702).then(r.bind(r,67916)),"@site/blog/2023-01-20.mdx?truncated=true",67916],"6705d7cc":[()=>r.e(73714).then(r.bind(r,91288)),"@site/blog/2022-07-14-1.mdx?truncated=true",91288],"6736d42e":[()=>r.e(83610).then(r.bind(r,90447)),"@site/blog/2023-12-07.mdx?truncated=true",90447],"676ffe1d":[()=>r.e(4046).then(r.t.bind(r,70387,19)),"@generated/docusaurus-plugin-content-blog/default/p/changelog-tags-checkout-backend-5ab.json",70387],"6875c492":[()=>Promise.all([r.e(71869),r.e(15394),r.e(73019),r.e(3671),r.e(84813)]).then(r.bind(r,33069)),"@theme/BlogTagsPostsPage",33069],"6981facc":[()=>r.e(9856).then(r.bind(r,22526)),"@site/blog/2023-11-30.mdx",22526],"6a372ef7":[()=>r.e(54524).then(r.bind(r,34194)),"@site/docs/solutions/blueprints/buy-now.mdx",34194],"6a8a2734":[()=>r.e(62705).then(r.bind(r,73387)),"@site/blog/2024-08-29.mdx?truncated=true",73387],"6a90a775":[()=>r.e(22499).then(r.t.bind(r,13605,19)),"@generated/docusaurus-plugin-content-docs/default/p/guides-tags-external-payment-gateway-connector-5c4.json",13605],"6aa951d6":[()=>Promise.all([r.e(71869),r.e(15394),r.e(46194)]).then(r.bind(r,45711)),"@site/docs/checkout/public-integrations.mdx",45711],"6b423876":[()=>r.e(42191).then(r.bind(r,5073)),"@site/blog/2023-10-27.mdx",5073],"6b556ce2":[()=>r.e(25345).then(r.t.bind(r,45494,19)),"@generated/docusaurus-plugin-redoc/plugin-redoc-4/__plugin.json",45494],"6b8719b3":[()=>r.e(75819).then(r.bind(r,60953)),"@site/blog/2022-07-11.mdx?truncated=true",60953],"6ba57622":[()=>r.e(19130).then(r.t.bind(r,21258,19)),"@generated/docusaurus-plugin-redoc/plugin-redoc-0/__plugin.json",21258],"6c0634db":[()=>r.e(22319).then(r.bind(r,34031)),"@site/blog/2022-10-31.mdx?truncated=true",34031],"6d6f958f":[()=>Promise.all([r.e(71869),r.e(15394),r.e(96169)]).then(r.bind(r,56923)),"@site/docs/platform-integration/magento-1/dev-store.mdx",56923],"6dcfd2ad":[()=>r.e(17635).then(r.bind(r,62610)),"@site/blog/2023-02-01.mdx",62610],"6e78600a":[()=>r.e(61446).then(r.bind(r,6346)),"@site/blog/2023-03-02.mdx?truncated=true",6346],"6fb8def7":[()=>r.e(74929).then(r.bind(r,19053)),"@site/docs/checkout/plugins/event-action-loop.mdx",19053],"713f479c":[()=>r.e(51751).then(r.t.bind(r,44556,19)),"@generated/docusaurus-plugin-content-docs/default/p/guides-tags-big-commerce-8ea.json",44556],"719ac0f6":[()=>r.e(11912).then(r.bind(r,444)),"@site/blog/2024-06-17.mdx?truncated=true",444],72234647:[()=>r.e(79976).then(r.bind(r,56393)),"@site/blog/2023-03-09.mdx",56393],"726335e8":[()=>r.e(59250).then(r.t.bind(r,74632,19)),"/home/runner/work/developer-docs/developer-docs/.docusaurus/docusaurus-plugin-redoc/plugin-redoc-0/redocApiLayoutV1-plugin-redoc-0.json",74632],"726b6d9c":[()=>Promise.all([r.e(71869),r.e(15394),r.e(16574)]).then(r.bind(r,88963)),"@site/docs/subscriptions-v2/webhooks.mdx",88963],"727c2919":[()=>Promise.all([r.e(71869),r.e(15394),r.e(69627)]).then(r.bind(r,11377)),"@site/docs/subscriptions-v2/getting-started.mdx",11377],"728e3184":[()=>r.e(40213).then(r.bind(r,89549)),"@site/docs/checkout/concepts/overrides.mdx",89549],"734da6f2":[()=>r.e(61812).then(r.bind(r,79742)),"@site/blog/2022-07-29.mdx?truncated=true",79742],"74e304d9":[()=>Promise.all([r.e(71869),r.e(40427)]).then(r.bind(r,72785)),"@site/docs/platform-connector/getting-started.mdx",72785],"7709a2ee":[()=>r.e(83279).then(r.bind(r,75497)),"@site/docs/subscriptions-v2/create-line-items.mdx",75497],"77143d78":[()=>r.e(50426).then(r.bind(r,55578)),"@site/blog/2024-06-06.mdx",55578],"7745d529":[()=>r.e(79362).then(r.bind(r,65710)),"@site/docs/price-rules/concepts/rulesets-and-rules.mdx",65710],"77b34fc8":[()=>r.e(18567).then(r.t.bind(r,66799,19)),"/home/runner/work/developer-docs/developer-docs/.docusaurus/docusaurus-plugin-redoc/plugin-redoc-0/redocApiSpecV1.2-plugin-redoc-0.json",66799],"7874c012":[()=>r.e(22043).then(r.t.bind(r,63664,19)),"/home/runner/work/developer-docs/developer-docs/.docusaurus/docusaurus-plugin-redoc/plugin-redoc-9/redocApiLayoutV1-plugin-redoc-9.json",63664],"78b0ba9f":[()=>r.e(36458).then(r.bind(r,15441)),"@site/blog/2022-10-19.mdx?truncated=true",15441],"78f5ef23":[()=>r.e(70641).then(r.bind(r,46565)),"@site/blog/2023-05-18.mdx",46565],"7972200e":[()=>r.e(49631).then(r.t.bind(r,76369,19)),"@generated/docusaurus-plugin-redoc/plugin-redoc-3/__plugin.json",76369],"79fd24fe":[()=>Promise.all([r.e(71869),r.e(15394),r.e(9144)]).then(r.bind(r,38011)),"@site/docs/price-rules/getting-started.mdx",38011],"7a0cbc90":[()=>r.e(82222).then(r.bind(r,74664)),"@site/blog/2022-12-02-2.mdx?truncated=true",74664],"7acfde56":[()=>r.e(14608).then(r.bind(r,10870)),"@site/blog/2022-09-16.mdx",10870],"7b30e072":[()=>r.e(26309).then(r.t.bind(r,13499,19)),"@generated/docusaurus-plugin-content-blog/default/p/changelog-tags-integrations-5d7.json",13499],"7c357204":[()=>r.e(54762).then(r.bind(r,69232)),"@site/blog/2024-06-17.mdx",69232],"7caefe66":[()=>r.e(26984).then(r.t.bind(r,76633,19)),"@generated/docusaurus-plugin-content-blog/default/p/changelog-tags-external-payment-gateway-connector-824.json",76633],"7cb1c17c":[()=>Promise.all([r.e(71869),r.e(55872)]).then(r.bind(r,96980)),"@site/docs/checkout/bold-boosters/connect-stripe.mdx",96980],"7d21ca31":[()=>r.e(37109).then(r.bind(r,11742)),"@site/blog/2023-04-21.mdx?truncated=true",11742],"7d2954f8":[()=>r.e(94320).then(r.bind(r,40141)),"@site/blog/2023-05-10.mdx",40141],"7d919bfe":[()=>Promise.all([r.e(71869),r.e(15394),r.e(60638)]).then(r.bind(r,30677)),"@site/docs/price-rules/quick-start.mdx",30677],"7de514a4":[()=>r.e(44884).then(r.bind(r,86604)),"@site/docs/subscriptions-v2/line-items.mdx",86604],"7e29e168":[()=>r.e(37924).then(r.bind(r,94061)),"@site/blog/2022-10-31.mdx",94061],"7e3e040f":[()=>r.e(16929).then(r.bind(r,49412)),"@site/docs/price-rules/working-with-rulesets/location-based-pricing.mdx",49412],"7f1b9386":[()=>r.e(13955).then(r.bind(r,60221)),"@site/blog/2023-04-04.mdx",60221],"7f33f3aa":[()=>r.e(80121).then(r.bind(r,93349)),"@site/blog/2022-10-13.mdx",93349],"7fec1bec":[()=>r.e(58381).then(r.t.bind(r,42314,19)),"@generated/docusaurus-plugin-content-docs/default/p/guides-tags-order-management-system-3b7.json",42314],"7ff5fa3f":[()=>Promise.all([r.e(71869),r.e(30642),r.e(76031)]).then(r.bind(r,87842)),"@site/docs/archive/installation.mdx",87842],"803dc12b":[()=>r.e(2174).then(r.bind(r,23345)),"@site/blog/2022-09-13.mdx?truncated=true",23345],"814f3328":[()=>r.e(67472).then(r.t.bind(r,55513,19)),"~blog/default/blog-post-list-prop-default.json",55513],"81df1f68":[()=>r.e(97215).then(r.bind(r,5107)),"@site/docs/price-rules/resources/open-source.mdx",5107],"8245391c":[()=>r.e(9588).then(r.t.bind(r,113,19)),"@generated/docusaurus-plugin-content-docs/default/p/guides-tags-express-pay-30c.json",113],"8279e022":[()=>Promise.all([r.e(71869),r.e(49614)]).then(r.bind(r,7667)),"@site/src/pages/api-specifications.tsx",7667],"82ac0f52":[()=>Promise.all([r.e(71869),r.e(15394),r.e(87010)]).then(r.bind(r,53072)),"@site/docs/subscriptions-v2/view-future-orders.mdx",53072],"82b8a81c":[()=>r.e(58524).then(r.bind(r,91516)),"@site/docs/checkout/extend.mdx",91516],"83aabe50":[()=>r.e(81790).then(r.bind(r,59886)),"@site/blog/2022-09-27.mdx?truncated=true",59886],"83e03a90":[()=>r.e(34356).then(r.t.bind(r,81702,19)),"/home/runner/work/developer-docs/developer-docs/.docusaurus/docusaurus-plugin-redoc/plugin-redoc-10/redocApiLayoutV1-plugin-redoc-10.json",81702],"841cd3c7":[()=>r.e(84290).then(r.bind(r,15056)),"@site/docs/subscriptions-v2/resources/supported-platforms-gateways.mdx",15056],"85a32b6a":[()=>r.e(68169).then(r.bind(r,3778)),"@site/blog/2023-11-30.mdx?truncated=true",3778],"8653eec3":[()=>r.e(45321).then(r.bind(r,42575)),"@site/blog/2023-09-27-1.mdx?truncated=true",42575],"867c094e":[()=>r.e(84151).then(r.bind(r,56469)),"@site/docs/checkout/resources/supported-platforms-gateways.mdx",56469],"8731bd3f":[()=>r.e(84201).then(r.bind(r,22310)),"@site/blog/2022-12-23.mdx?truncated=true",22310],"87685dec":[()=>Promise.all([r.e(71869),r.e(97336),r.e(16405)]).then(r.bind(r,73341)),"@site/docs/checkout/bold-boosters/m1-bold-booster-for-paypal.mdx",73341],"88f3445c":[()=>r.e(26890).then(r.t.bind(r,58853,19)),"@generated/docusaurus-plugin-content-docs/default/p/guides-tags-biometrics-129.json",58853],"89c10cb2":[()=>r.e(10833).then(r.t.bind(r,84941,19)),"@generated/docusaurus-plugin-content-docs/default/p/guides-tags-blog-595.json",84941],"8a1cc97c":[()=>r.e(45588).then(r.bind(r,69078)),"@site/blog/2022-08-02.mdx",69078],"8a7f04b4":[()=>r.e(37947).then(r.bind(r,9042)),"@site/blog/2022-12-23.mdx",9042],"8b3ba059":[()=>Promise.all([r.e(71869),r.e(53659)]).then(r.bind(r,17867)),"@site/docs/checkout/meta.mdx",17867],"8b65dfae":[()=>r.e(2826).then(r.t.bind(r,40879,19)),"/home/runner/work/developer-docs/developer-docs/.docusaurus/docusaurus-plugin-redoc/plugin-redoc-4/redocApiSpecV1.2-plugin-redoc-4.json",40879],"8b6ba284":[()=>r.e(6128).then(r.bind(r,54982)),"@site/blog/2022-10-25.mdx",54982],"8c1de4d0":[()=>r.e(65356).then(r.bind(r,54437)),"@site/blog/2024-02-01.mdx",54437],"8c40df0e":[()=>r.e(17295).then(r.bind(r,89977)),"@site/docs/price-rules/resources/access-scopes.mdx",89977],"8c6a0c8d":[()=>Promise.all([r.e(71869),r.e(15394),r.e(95832)]).then(r.bind(r,73131)),"@site/docs/checkout/resources/query-pagination.mdx",73131],"8cb9ae10":[()=>r.e(16818).then(r.t.bind(r,69515,19)),"@generated/docusaurus-plugin-content-docs/default/p/guides-tags-klarna-e10.json",69515],"8cbb51ac":[()=>r.e(1578).then(r.bind(r,23312)),"@site/docs/solutions/bold-built/paypal-checkout-flow.mdx",23312],"8d5df195":[()=>r.e(58829).then(r.bind(r,86918)),"@site/docs/solutions/example-projects/custom-flow.mdx",86918],"8d71f2ef":[()=>r.e(52406).then(r.bind(r,948)),"@site/blog/2023-05-02.mdx",948],"8dad17cc":[()=>r.e(25234).then(r.bind(r,87710)),"@site/docs/price-rules/resources/supported-platforms-gateways.mdx",87710],"8ef70909":[()=>r.e(16775).then(r.bind(r,88208)),"@site/docs/price-rules/working-with-rulesets/scheduling.mdx",88208],"8f1f4a7a":[()=>r.e(98441).then(r.t.bind(r,8781,19)),"@generated/docusaurus-plugin-content-docs/default/p/guides-tags-checkout-flow-8b2.json",8781],"8f6fd828":[()=>r.e(52711).then(r.t.bind(r,54485,19)),"@generated/docusaurus-plugin-content-docs/default/p/guides-tags-partner-name-140.json",54485],"8fc53d35":[()=>r.e(76).then(r.t.bind(r,70504,19)),"/home/runner/work/developer-docs/developer-docs/.docusaurus/docusaurus-plugin-redoc/plugin-redoc-8/redocApiLayoutV1-plugin-redoc-8.json",70504],"8fff7dee":[()=>r.e(77546).then(r.t.bind(r,81948,19)),"@generated/docusaurus-plugin-content-docs/default/p/guides-tags-authentication-71d.json",81948],90480410:[()=>r.e(42031).then(r.bind(r,58323)),"@site/blog/2023-09-27.mdx",58323],"912427ea":[()=>r.e(77540).then(r.bind(r,42028)),"@site/docs/price-rules/resources/error-responses.mdx",42028],"91caa64a":[()=>Promise.all([r.e(71869),r.e(15394),r.e(85689)]).then(r.bind(r,71211)),"@site/docs/platform-integration/commercetools/headless-checkout.mdx",71211],"9248066f":[()=>r.e(7984).then(r.bind(r,77006)),"@site/blog/2026-01-05.mdx?truncated=true",77006],92663509:[()=>r.e(54323).then(r.bind(r,77379)),"@site/blog/2023-05-09.mdx",77379],"9276bcf2":[()=>r.e(56024).then(r.t.bind(r,85084,19)),"@generated/docusaurus-plugin-content-docs/default/p/guides-tags-tax-c9e.json",85084],"92bfea30":[()=>r.e(33749).then(r.bind(r,15680)),"@site/docs/price-rules/working-with-rulesets/order-condition.mdx",15680],93056085:[()=>r.e(57533).then(r.t.bind(r,67575,19)),"@generated/docusaurus-plugin-content-docs/default/p/guides-tags-klaviyo-37d.json",67575],"9324e391":[()=>r.e(68903).then(r.t.bind(r,33348,19)),"@generated/docusaurus-plugin-content-docs/default/p/guides-tags-pay-pal-116.json",33348],"93bb5d32":[()=>r.e(40087).then(r.bind(r,50343)),"@site/blog/2022-10-13.mdx?truncated=true",50343],"946ddae3":[()=>Promise.all([r.e(71869),r.e(15394),r.e(13295)]).then(r.bind(r,2750)),"@site/docs/subscriptions-v2/resources/query-pagination.mdx",2750],"965511c6":[()=>Promise.all([r.e(71869),r.e(27669)]).then(r.bind(r,38261)),"@site/docs/platform-integration/adobe-commerce/flows/paypal-checkout-flow.mdx",38261],"9669cf71":[()=>r.e(96486).then(r.bind(r,87872)),"@site/blog/2023-12-15.mdx?truncated=true",87872],"971ee163":[()=>r.e(74378).then(r.bind(r,40282)),"@site/docs/subscriptions-v2/update-subscription.mdx",40282],97430077:[()=>r.e(33590).then(r.t.bind(r,85206,19)),"@generated/docusaurus-plugin-content-blog/default/p/changelog-tags-price-rules-api-d1c.json",85206],"9745ec07":[()=>r.e(80773).then(r.bind(r,7832)),"@site/blog/2022-09-29.mdx?truncated=true",7832],"97bd5d1a":[()=>r.e(67516).then(r.bind(r,10824)),"@site/docs/checkout/concepts/sdk-integrate.mdx",10824],"9844258f":[()=>r.e(3409).then(r.bind(r,64277)),"@site/blog/2023-05-09.mdx?truncated=true",64277],"98d8c4fc":[()=>r.e(19880).then(r.bind(r,82626)),"@site/blog/2022-09-01.mdx",82626],99019399:[()=>r.e(89790).then(r.t.bind(r,93941,19)),"@generated/docusaurus-plugin-content-blog/default/p/changelog-tags-checkout-admin-ea9.json",93941],"997dc84c":[()=>Promise.all([r.e(71869),r.e(15394),r.e(72786)]).then(r.bind(r,38028)),"@site/docs/price-rules/working-with-rulesets/managing-price-rules.mdx",38028],"99d61fc7":[()=>Promise.all([r.e(71869),r.e(15394),r.e(28904)]).then(r.bind(r,88284)),"@site/docs/checkout/batch-processing.mdx",88284],"9a28d03e":[()=>r.e(24091).then(r.bind(r,29845)),"@site/docs/checkout/concepts/flows.mdx",29845],"9a98efac":[()=>r.e(45831).then(r.bind(r,96813)),"@site/blog/2023-05-01.mdx?truncated=true",96813],"9b8c43fb":[()=>r.e(49674).then(r.bind(r,86446)),"@site/blog/2023-06-12.mdx",86446],"9b99c256":[()=>r.e(10578).then(r.t.bind(r,88059,19)),"@generated/docusaurus-plugin-content-blog/default/p/changelog-tags-platform-event-notifications-976.json",88059],"9bb130ae":[()=>r.e(36854).then(r.t.bind(r,52673,19)),"@generated/docusaurus-plugin-content-docs/default/p/guides-tags-pay-pal-express-574.json",52673],"9c4defe2":[()=>r.e(42015).then(r.bind(r,15993)),"@site/blog/2023-10-10.mdx?truncated=true",15993],"9ccb8bf4":[()=>r.e(54380).then(r.bind(r,64998)),"@site/blog/2023-09-08.mdx?truncated=true",64998],"9cd69b2b":[()=>r.e(83268).then(r.bind(r,13619)),"@site/docs/checkout/checkout-getting-started.mdx",13619],"9cff32b0":[()=>r.e(50286).then(r.bind(r,39847)),"@site/blog/2025-06-11.mdx",39847],"9d41d13e":[()=>r.e(38084).then(r.bind(r,81987)),"@site/blog/2022-12-02.mdx?truncated=true",81987],"9d53b12b":[()=>r.e(82363).then(r.bind(r,6540)),"@site/docs/price-rules/working-with-rulesets/customer-targeted-pricing.mdx",6540],"9d5b7f91":[()=>r.e(84448).then(r.t.bind(r,64779,19)),"/home/runner/work/developer-docs/developer-docs/.docusaurus/docusaurus-plugin-redoc/plugin-redoc-10/redocApiSpecV1.2-plugin-redoc-10.json",64779],"9d9aa55d":[()=>r.e(9707).then(r.t.bind(r,84279,19)),"@generated/docusaurus-plugin-content-blog/default/p/changelog-tags-customers-293.json",84279],"9e4087bc":[()=>r.e(75092).then(r.bind(r,89331)),"@theme/BlogArchivePage",89331],"9e563b2a":[()=>r.e(77647).then(r.bind(r,70913)),"@site/blog/2023-05-18-1.mdx?truncated=true",70913],"9e76ce62":[()=>r.e(86850).then(r.bind(r,83617)),"@site/blog/2022-09-01-2.mdx?truncated=true",83617],"9e7f3f1d":[()=>r.e(37570).then(r.t.bind(r,23093,19)),"@generated/docusaurus-plugin-content-docs/default/p/guides-tags-coalition-technologies-857.json",23093],"9e9a0d2d":[()=>r.e(58141).then(r.bind(r,27643)),"@site/blog/2023-06-26.mdx",27643],"9ee40315":[()=>r.e(54775).then(r.t.bind(r,20563,19)),"/home/runner/work/developer-docs/developer-docs/.docusaurus/docusaurus-plugin-redoc/plugin-redoc-7/redocApiSpecV1.2-plugin-redoc-7.json",20563],"9f231082":[()=>r.e(56846).then(r.bind(r,76404)),"@site/blog/2023-04-05.mdx?truncated=true",76404],"9f2638d4":[()=>r.e(10951).then(r.bind(r,90332)),"@site/blog/2022-07-14-1.mdx",90332],"9f2b4f61":[()=>r.e(32351).then(r.bind(r,75509)),"@site/blog/2023-09-14.mdx",75509],a0788bec:[()=>r.e(99919).then(r.bind(r,30367)),"@site/docs/platform-connector/concepts/example-implementations.mdx",30367],a0d56754:[()=>r.e(39791).then(r.bind(r,92215)),"@site/blog/2023-03-27.mdx?truncated=true",92215],a0d7558c:[()=>r.e(76614).then(r.bind(r,23841)),"@site/blog/2023-07-10.mdx?truncated=true",23841],a0f19131:[()=>r.e(57389).then(r.t.bind(r,39368,19)),"@generated/docusaurus-plugin-content-blog/default/p/changelog-tags-platform-connector-203.json",39368],a14855e6:[()=>r.e(57478).then(r.t.bind(r,16717,19)),"@generated/docusaurus-plugin-content-docs/default/p/guides-tags-abandoned-cart-3a0.json",16717],a192c05c:[()=>r.e(29657).then(r.t.bind(r,45346,19)),"@generated/docusaurus-plugin-content-docs/default/p/guides-tags-partner-flow-2fe.json",45346],a197274c:[()=>Promise.all([r.e(71869),r.e(24719)]).then(r.bind(r,56271)),"@site/docs/checkout/bold-boosters/bold-booster-security.mdx",56271],a25eaad8:[()=>Promise.all([r.e(71869),r.e(89366)]).then(r.bind(r,70165)),"@site/docs/checkout/bold-boosters/set-up-google-pay.mdx",70165],a27205d3:[()=>r.e(81999).then(r.bind(r,28119)),"@site/blog/2023-08-17.mdx?truncated=true",28119],a2bcb783:[()=>r.e(15757).then(r.t.bind(r,12210,19)),"@generated/docusaurus-plugin-content-blog/default/p/changelog-tags-breaking-e9a.json",12210],a2be571e:[()=>r.e(99035).then(r.t.bind(r,27366,19)),"@generated/docusaurus-plugin-content-docs/default/p/guides-tags-search-edc.json",27366],a2eb7c70:[()=>Promise.all([r.e(71869),r.e(97336),r.e(30642),r.e(19088)]).then(r.bind(r,38040)),"@site/docs/checkout/bold-boosters/adobe-commerce-bold-booster-for-paypal.mdx",38040],a303337a:[()=>r.e(62918).then(r.bind(r,12856)),"@site/blog/2022-07-21-1.mdx",12856],a3daa7b0:[()=>r.e(87204).then(r.bind(r,75110)),"@site/blog/2024-01-18.mdx?truncated=true",75110],a3dddd39:[()=>r.e(90539).then(r.bind(r,50697)),"@site/docs/solutions/example-projects/express-pay.mdx",50697],a528a3cc:[()=>r.e(52333).then(r.bind(r,53979)),"@site/docs/price-rules/working-with-rulesets/multi-currency.mdx",53979],a63248c6:[()=>Promise.all([r.e(71869),r.e(15394),r.e(8670)]).then(r.bind(r,68838)),"@site/docs/platform-connector/rsa/create-checkout-rsa.mdx",68838],a6705120:[()=>r.e(27271).then(r.bind(r,4790)),"@site/docs/checkout/concepts/external-payment-gateways.mdx",4790],a6aa9e1f:[()=>Promise.all([r.e(71869),r.e(15394),r.e(73019),r.e(3671),r.e(37643)]).then(r.bind(r,38695)),"@theme/BlogListPage",38695],a7456010:[()=>r.e(61235).then(r.t.bind(r,88552,19)),"@generated/docusaurus-plugin-content-pages/default/__plugin.json",88552],a78c8291:[()=>r.e(3532).then(r.bind(r,93311)),"@site/blog/2022-10-19.mdx",93311],a7a2b072:[()=>r.e(52835).then(r.bind(r,47186)),"@site/blog/2024-01-18.mdx",47186],a7bd4aaa:[()=>r.e(67098).then(r.bind(r,74532)),"@theme/DocVersionRoot",74532],a83018f9:[()=>r.e(94985).then(r.bind(r,81379)),"@site/blog/2024-09-17.mdx?truncated=true",81379],a86d2051:[()=>r.e(62442).then(r.bind(r,28979)),"@site/blog/2023-10-27.mdx?truncated=true",28979],a8a331c2:[()=>r.e(59007).then(r.bind(r,9225)),"@site/blog/2024-08-29.mdx",9225],a94703ab:[()=>Promise.all([r.e(71869),r.e(79048)]).then(r.bind(r,16403)),"@theme/DocRoot",16403],a9ce9108:[()=>r.e(15799).then(r.bind(r,52790)),"@site/docs/price-rules/errors.mdx",52790],aa48e5f4:[()=>Promise.all([r.e(71869),r.e(15394),r.e(17589)]).then(r.bind(r,92312)),"@site/docs/price-rules/resources/api-versioning.mdx",92312],aab1e628:[()=>r.e(34345).then(r.bind(r,83161)),"@site/blog/2022-11-14.mdx",83161],ab91e59b:[()=>r.e(30743).then(r.bind(r,74949)),"@site/blog/2023-08-08.mdx",74949],aba21aa0:[()=>r.e(35742).then(r.t.bind(r,27093,19)),"@generated/docusaurus-plugin-content-docs/default/__plugin.json",27093],acecf23e:[()=>r.e(81903).then(r.t.bind(r,1912,19)),"~blog/default/blogMetadata-default.json",1912],ad678fe2:[()=>r.e(33326).then(r.bind(r,63855)),"@site/blog/2023-05-18-1.mdx",63855],ad7bbdbe:[()=>r.e(19454).then(r.t.bind(r,4715,19)),"@generated/docusaurus-plugin-content-docs/default/p/guides-tags-epg-478.json",4715],ad939425:[()=>r.e(75416).then(r.bind(r,1099)),"@site/docs/archive/subscriptions_v1_integration.mdx",1099],ade24b0f:[()=>r.e(75621).then(r.bind(r,183)),"@site/docs/subscriptions-v2/resources/glossary.mdx",183],aea16c7b:[()=>r.e(44777).then(r.bind(r,41320)),"@site/docs/price-rules/attributes.mdx",41320],af2f28d9:[()=>r.e(49561).then(r.t.bind(r,27119,19)),"@generated/docusaurus-plugin-content-docs/default/p/guides-tags-technology-partner-de1.json",27119],b05b71ff:[()=>r.e(4444).then(r.bind(r,35759)),"@site/blog/2022-09-01-2.mdx",35759],b0a78326:[()=>r.e(83598).then(r.bind(r,87727)),"@site/blog/2023-07-10.mdx",87727],b124425c:[()=>r.e(1812).then(r.bind(r,84098)),"@site/docs/price-rules/working-with-rulesets/cart-level-promotions.mdx",84098],b173a2ed:[()=>r.e(82916).then(r.bind(r,61921)),"@site/blog/2024-09-17.mdx",61921],b199e59c:[()=>r.e(48296).then(r.bind(r,9207)),"@site/docs/subscriptions-v2/resources/access-scopes.mdx",9207],b22514be:[()=>r.e(30288).then(r.bind(r,51953)),"@site/docs/checkout/metrics.mdx",51953],b2f8de63:[()=>r.e(31337).then(r.bind(r,43031)),"@site/blog/2023-09-14.mdx?truncated=true",43031],b3ce1b9a:[()=>r.e(98513).then(r.bind(r,71357)),"@site/docs/solutions/blueprints/blog.mdx",71357],b3cefefd:[()=>r.e(90459).then(r.t.bind(r,443,19)),"/home/runner/work/developer-docs/developer-docs/.docusaurus/docusaurus-plugin-redoc/plugin-redoc-3/redocApiSpecV1.2-plugin-redoc-3.json",443],b3ece874:[()=>r.e(52772).then(r.bind(r,22131)),"@site/docs/subscriptions-v2/create-subscription.mdx",22131],b446a5cd:[()=>r.e(16984).then(r.bind(r,74599)),"@site/docs/archive/cashier.mdx",74599],b48837db:[()=>Promise.all([r.e(71869),r.e(15394),r.e(9745)]).then(r.bind(r,9e4)),"@site/docs/price-rules/resources/query-pagination.mdx",9e4],b4b562b3:[()=>r.e(26339).then(r.bind(r,82056)),"@site/docs/price-rules/working-with-rulesets/quantity-pricing.mdx",82056],b5a1fff4:[()=>r.e(50024).then(r.bind(r,86737)),"@site/blog/2023-09-18.mdx",86737],b5ae6c76:[()=>r.e(17272).then(r.t.bind(r,7596,19)),"@generated/docusaurus-plugin-redoc/plugin-redoc-6/__plugin.json",7596],b5cf0462:[()=>r.e(66167).then(r.bind(r,69382)),"@site/blog/2025-11-18.mdx",69382],b604ae7d:[()=>r.e(93288).then(r.bind(r,62948)),"@site/docs/solutions/example-projects/template.mdx",62948],b6a4bacf:[()=>r.e(74504).then(r.bind(r,50287)),"@site/docs/platform-integration/adobe-commerce/concepts.mdx",50287],b7a80d23:[()=>r.e(23760).then(r.bind(r,89959)),"@site/blog/2024-03-28.mdx?truncated=true",89959],b7ca5550:[()=>r.e(31359).then(r.bind(r,51418)),"@site/blog/2023-10-11.mdx",51418],b81f1e7f:[()=>r.e(80522).then(r.bind(r,11959)),"@site/blog/2023-06-20.mdx?truncated=true",11959],b8285721:[()=>r.e(97060).then(r.bind(r,94654)),"@site/docs/solutions/bold-built/ppcp.mdx",94654],b8669604:[()=>r.e(71008).then(r.bind(r,25307)),"@site/blog/2022-10-17.mdx?truncated=true",25307],b869ded7:[()=>r.e(41400).then(r.bind(r,51685)),"@site/blog/2023-09-27.mdx?truncated=true",51685],b86cec8a:[()=>r.e(24541).then(r.bind(r,11048)),"@site/docs/price-rules/references/conditions.mdx",11048],b884ce28:[()=>r.e(56143).then(r.bind(r,16415)),"@site/blog/2023-07-14-1.mdx?truncated=true",16415],b888eae5:[()=>r.e(95301).then(r.t.bind(r,93402,19)),"@generated/docusaurus-plugin-content-docs/default/p/guides-tags-861.json",93402],b8e1ab90:[()=>r.e(24321).then(r.bind(r,89036)),"@site/docs/solutions/blueprints/biometric-auth.mdx",89036],b8f2801a:[()=>r.e(66351).then(r.bind(r,85501)),"@site/blog/2023-06-13.mdx?truncated=true",85501],b98e68af:[()=>r.e(4138).then(r.bind(r,28462)),"@site/blog/2023-10-11.mdx?truncated=true",28462],b99e9454:[()=>r.e(47278).then(r.t.bind(r,27826,19)),"@generated/docusaurus-plugin-content-docs/default/p/guides-tags-magento-open-source-385.json",27826],ba2bc9d2:[()=>r.e(82470).then(r.bind(r,63931)),"@site/blog/2023-05-01.mdx",63931],ba74812c:[()=>r.e(21457).then(r.bind(r,13280)),"@site/docs/checkout/resources/access-scopes.mdx",13280],bb59d0d3:[()=>r.e(7066).then(r.bind(r,62531)),"@site/docs/platform-connector/concepts/components.mdx",62531],bbef2544:[()=>r.e(36173).then(r.bind(r,90388)),"@site/docs/price-rules/additional-resources.mdx",90388],bc062e45:[()=>r.e(53986).then(r.bind(r,61201)),"@site/blog/2024-04-23.mdx?truncated=true",61201],bd3a9dee:[()=>r.e(932).then(r.t.bind(r,52448,19)),"@generated/docusaurus-plugin-content-blog/default/p/changelog-tags-subscriptions-80f.json",52448],bd414280:[()=>r.e(3714).then(r.bind(r,11622)),"@site/blog/2023-03-02.mdx",11622],bd465c5a:[()=>r.e(22233).then(r.t.bind(r,15729,19)),"@generated/docusaurus-plugin-content-docs/default/p/guides-tags-braintree-504.json",15729],be7ad25d:[()=>r.e(20221).then(r.t.bind(r,72359,19)),"@generated/docusaurus-plugin-content-docs/default/p/guides-tags-m-1-27c.json",72359],bee00323:[()=>r.e(89889).then(r.bind(r,89896)),"@site/blog/2022-12-14.mdx",89896],bf2c76ca:[()=>r.e(13645).then(r.bind(r,66856)),"@site/docs/price-rules/debug-tools.mdx",66856],bf3692be:[()=>r.e(56454).then(r.t.bind(r,29683,19)),"@generated/docusaurus-plugin-content-blog/default/p/changelog-tags-non-breaking-9cb.json",29683],c02a1c6d:[()=>r.e(73475).then(r.bind(r,20185)),"@site/blog/2024-01-17.mdx",20185],c07e63c6:[()=>r.e(89836).then(r.bind(r,61718)),"@site/docs/platform-connector/event-notifications.mdx",61718],c0b19e3f:[()=>r.e(95564).then(r.bind(r,35262)),"@site/blog/2024-07-16.mdx",35262],c141421f:[()=>r.e(80957).then(r.t.bind(r,40936,19)),"@generated/docusaurus-theme-search-algolia/default/__plugin.json",40936],c2030439:[()=>r.e(70251).then(r.bind(r,54512)),"@site/blog/2022-12-02-01.mdx?truncated=true",54512],c2e3b439:[()=>r.e(99850).then(r.t.bind(r,10711,19)),"/home/runner/work/developer-docs/developer-docs/.docusaurus/docusaurus-plugin-redoc/plugin-redoc-12/redocApiSpecV1.2-plugin-redoc-12.json",10711],c3fed1b4:[()=>r.e(32673).then(r.t.bind(r,29647,19)),"@generated/docusaurus-plugin-content-docs/default/p/guides-tags-harry-rosen-995.json",29647],c44b1e9c:[()=>r.e(16866).then(r.bind(r,64737)),"@site/docs/subscriptions-v2/index.mdx",64737],c45bc5c9:[()=>r.e(72755).then(r.t.bind(r,30411,19)),"@generated/docusaurus-plugin-content-docs/default/p/guides-tags-authenticated-checkout-443.json",30411],c4aab958:[()=>r.e(54856).then(r.bind(r,39725)),"@site/blog/2023-12-07.mdx",39725],c4babf09:[()=>r.e(90660).then(r.bind(r,90849)),"@site/blog/2022-12-02.mdx",90849],c6439732:[()=>r.e(1944).then(r.bind(r,89394)),"@site/blog/2023-09-22.mdx",89394],c6b52414:[()=>r.e(22474).then(r.bind(r,1655)),"@site/blog/2023-01-09.mdx",1655],c7b47c12:[()=>r.e(47068).then(r.bind(r,31158)),"@site/blog/2023-01-17.mdx?truncated=true",31158],c9b891a5:[()=>r.e(11177).then(r.bind(r,11791)),"@site/docs/platform-integration/adobe-commerce/generate-module-list.mdx",11791],ca303fc0:[()=>Promise.all([r.e(71869),r.e(15394),r.e(76220)]).then(r.bind(r,10383)),"@site/docs/checkout/resources/api-versioning.mdx",10383],ca705e0e:[()=>r.e(1145).then(r.bind(r,90793)),"@site/blog/2023-04-04-1.mdx?truncated=true",90793],ca8f2d2f:[()=>r.e(28655).then(r.bind(r,70354)),"@site/blog/2023-09-08.mdx",70354],cae1db01:[()=>r.e(14218).then(r.bind(r,77077)),"@site/blog/2023-05-23.mdx?truncated=true",77077],cbb13b52:[()=>r.e(45410).then(r.t.bind(r,50599,19)),"@generated/docusaurus-plugin-content-docs/default/p/guides-tags-customer-management-system-e33.json",50599],cc10feb9:[()=>r.e(6146).then(r.bind(r,23283)),"@site/blog/2023-09-18.mdx?truncated=true",23283],cc6ce636:[()=>r.e(66514).then(r.bind(r,13146)),"@site/blog/2026-01-05.mdx",13146],ccc49370:[()=>Promise.all([r.e(71869),r.e(15394),r.e(73019),r.e(3671),r.e(83249)]).then(r.bind(r,96654)),"@theme/BlogPostPage",96654],ccd7d0a7:[()=>Promise.all([r.e(71869),r.e(15394),r.e(50942)]).then(r.bind(r,2634)),"@site/docs/checkout/api-overrides.mdx",2634],cd41bd37:[()=>r.e(35243).then(r.t.bind(r,14997,19)),"@generated/docusaurus-plugin-content-docs/default/p/guides-tags-wallet-pay-a9c.json",14997],cd94f1bf:[()=>Promise.all([r.e(71869),r.e(97336),r.e(74210)]).then(r.bind(r,37110)),"@site/docs/checkout/bold-boosters/adobe-commerce-bold-booster-for-intuit.mdx",37110],ce0e948e:[()=>r.e(57828).then(r.t.bind(r,38534,19)),"@generated/docusaurus-plugin-content-docs/default/p/guides-tags-constructor-5f3.json",38534],ce3e7135:[()=>r.e(78159).then(r.bind(r,41059)),"@site/docs/subscriptions-v2/resources/rate-limiting.mdx",41059],cea66e72:[()=>r.e(34882).then(r.bind(r,49667)),"@site/docs/platform-connector/rsa/concepts.mdx",49667],d1823e81:[()=>Promise.all([r.e(71869),r.e(15394),r.e(98133)]).then(r.bind(r,84754)),"@site/docs/checkout/life.mdx",84754],d1f32d91:[()=>Promise.all([r.e(71869),r.e(97336),r.e(30642),r.e(95211)]).then(r.bind(r,63893)),"@site/docs/checkout/bold-boosters/opencart-bold-booster-for-paypal.mdx",63893],d20844df:[()=>r.e(85611).then(r.bind(r,23883)),"@site/blog/2023-07-25.mdx",23883],d29d1d7a:[()=>r.e(58125).then(r.bind(r,36663)),"@site/docs/solutions/blueprints/search-algolia.mdx",36663],d32cb31c:[()=>r.e(17748).then(r.t.bind(r,43980,19)),"@generated/docusaurus-plugin-content-docs/default/p/guides-tags-taxes-2e4.json",43980],d419bba6:[()=>Promise.all([r.e(71869),r.e(15394),r.e(16668)]).then(r.bind(r,76486)),"@site/docs/subscriptions-v2/customer-portals/index.mdx",76486],d4a571fe:[()=>r.e(61934).then(r.bind(r,28557)),"@site/blog/2023-06-26.mdx?truncated=true",28557],d4ad433e:[()=>Promise.all([r.e(71869),r.e(15394),r.e(97951)]).then(r.bind(r,12561)),"@site/docs/platform-connector/create-server.mdx",12561],d5928064:[()=>r.e(95105).then(r.bind(r,17601)),"@site/docs/price-rules/resources/glossary.mdx",17601],d717ef1e:[()=>r.e(76019).then(r.bind(r,87573)),"@site/blog/2023-08-17.mdx",87573],d71ba929:[()=>r.e(59544).then(r.bind(r,16579)),"@site/docs/archive/gravity-forms-upgrade.mdx",16579],d84edb4a:[()=>r.e(75289).then(r.bind(r,31289)),"@site/blog/2023-04-21-2.mdx?truncated=true",31289],d8f72ea6:[()=>r.e(21448).then(r.t.bind(r,64971,19)),"@generated/docusaurus-plugin-redoc/plugin-redoc-1/__plugin.json",64971],d8ffd1c8:[()=>r.e(76995).then(r.t.bind(r,36171,19)),"@generated/docusaurus-plugin-content-blog/default/p/changelog-tags-remote-state-authority-82c.json",36171],d9d97ff6:[()=>r.e(69652).then(r.bind(r,47889)),"@site/docs/price-rules/resources/rate-limiting.mdx",47889],da39a912:[()=>r.e(54905).then(r.bind(r,44711)),"@site/blog/2023-05-18.mdx?truncated=true",44711],db81c444:[()=>r.e(69813).then(r.t.bind(r,50669,19)),"@generated/docusaurus-plugin-content-docs/default/p/guides-tags-magento-2-245.json",50669],dc8a0d0a:[()=>r.e(26044).then(r.bind(r,37479)),"@site/docs/checkout/self-hosted-flow.mdx",37479],dd1548e1:[()=>Promise.all([r.e(71869),r.e(79943)]).then(r.bind(r,38438)),"@site/docs/checkout/bold-boosters/connect-ppcp.mdx",38438],dd8d5f79:[()=>Promise.all([r.e(71869),r.e(15394),r.e(48362)]).then(r.bind(r,67172)),"@site/docs/checkout/quick-start.mdx",67172],ddcc9d85:[()=>Promise.all([r.e(71869),r.e(15394),r.e(77599)]).then(r.bind(r,73358)),"@site/docs/checkout/index.mdx",73358],de4eb00a:[()=>r.e(79516).then(r.bind(r,43265)),"@site/docs/platform-connector/index.mdx",43265],df203c0f:[()=>Promise.all([r.e(71869),r.e(24279)]).then(r.bind(r,45921)),"@theme/DocTagDocListPage",45921],df7b49fc:[()=>Promise.all([r.e(71869),r.e(55866)]).then(r.bind(r,23404)),"@site/docs/checkout/bold-boosters/connect-intuit.mdx",23404],df856fe9:[()=>r.e(47506).then(r.bind(r,72373)),"@site/blog/2023-06-20.mdx",72373],dfab1666:[()=>r.e(68461).then(r.t.bind(r,67960,19)),"@generated/docusaurus-plugin-content-docs/default/p/guides-tags-commercetools-7fa.json",67960],e0696fb7:[()=>r.e(66902).then(r.bind(r,95168)),"@site/blog/2023-01-20.mdx",95168],e1b4cc2a:[()=>r.e(45666).then(r.bind(r,68497)),"@site/blog/2023-11-22.mdx?truncated=true",68497],e234bc08:[()=>r.e(97298).then(r.bind(r,19206)),"@site/blog/2023-02-01.mdx?truncated=true",19206],e23639f1:[()=>r.e(31886).then(r.t.bind(r,56570,19)),"@generated/docusaurus-plugin-content-docs/default/p/guides-tags-product-information-system-2b0.json",56570],e289a6a6:[()=>r.e(3759).then(r.bind(r,79608)),"@site/docs/price-rules/references/product-selection.mdx",79608],e2f77e55:[()=>r.e(36953).then(r.t.bind(r,6041,19)),"@generated/docusaurus-plugin-content-docs/default/p/guides-tags-self-hosted-704.json",6041],e345cd47:[()=>r.e(48152).then(r.bind(r,56899)),"@site/docs/price-rules/discount-codes.mdx",56899],e346b4e3:[()=>r.e(77723).then(r.t.bind(r,45673,19)),"@generated/docusaurus-plugin-content-docs/default/p/guides-tags-stripe-105.json",45673],e3728c6a:[()=>r.e(59116).then(r.bind(r,35228)),"@site/docs/solutions/bold-built/stripe.mdx",35228],e3c82674:[()=>Promise.all([r.e(71869),r.e(45987)]).then(r.bind(r,54614)),"@site/docs/platform-connector/requirements.mdx",54614],e3e6ed5f:[()=>r.e(29360).then(r.bind(r,40970)),"@site/blog/2022-10-25.mdx?truncated=true",40970],e405f8b6:[()=>r.e(52123).then(r.bind(r,45481)),"@site/blog/2023-01-09.mdx?truncated=true",45481],e477976f:[()=>r.e(55466).then(r.bind(r,67555)),"@site/blog/2023-05-23.mdx",67555],e521f622:[()=>r.e(71814).then(r.bind(r,62906)),"@site/docs/solutions/blueprints/abandoned-cart.mdx",62906],e66966b6:[()=>r.e(30785).then(r.t.bind(r,16283,19)),"@generated/docusaurus-plugin-content-docs/default/p/guides-tags-pre-purchase-upsell-ec6.json",16283],e683eb15:[()=>r.e(24658).then(r.bind(r,54349)),"@site/docs/checkout/references/checkout-spi-api.mdx",54349],e7a0a125:[()=>r.e(3541).then(r.t.bind(r,91668,19)),"@generated/docusaurus-plugin-content-docs/default/p/guides-tags-oracle-b00.json",91668],e7c38046:[()=>r.e(49739).then(r.bind(r,50481)),"@site/docs/checkout/references/epg-actions-events.mdx",50481],e8d9fb00:[()=>r.e(83057).then(r.t.bind(r,93358,19)),"@generated/docusaurus-plugin-content-blog/default/p/changelog-tags-checkout-frontend-0d3.json",93358],e9134af7:[()=>r.e(46357).then(r.bind(r,96630)),"@site/blog/2022-09-01.mdx?truncated=true",96630],e9851743:[()=>r.e(15567).then(r.bind(r,37542)),"@site/docs/price-rules/working-with-rulesets/discount-codes.mdx",37542],e9e355a7:[()=>r.e(97675).then(r.bind(r,79192)),"@site/blog/2023-11-21.mdx",79192],ea654927:[()=>r.e(49538).then(r.t.bind(r,82710,19)),"@generated/docusaurus-plugin-content-docs/default/p/guides-tags-checkout-flows-6c5.json",82710],eab034cd:[()=>r.e(74107).then(r.bind(r,15771)),"@site/blog/2022-11-14.mdx?truncated=true",15771],ec838b08:[()=>Promise.all([r.e(71869),r.e(15394),r.e(15986)]).then(r.bind(r,17901)),"@site/docs/checkout/populate-order.mdx",17901],ee3c4f27:[()=>Promise.all([r.e(71869),r.e(98384)]).then(r.bind(r,47265)),"@site/docs/platform-integration/adobe-commerce/overview.mdx",47265],efb12385:[()=>r.e(85461).then(r.bind(r,10681)),"@site/blog/2022-10-17.mdx",10681],efedbf87:[()=>r.e(10690).then(r.bind(r,17582)),"@site/docs/platform-connector/verify.mdx",17582],f04f4b9f:[()=>r.e(20332).then(r.bind(r,77025)),"@site/blog/2023-08-22.mdx",77025],f0ad3fbb:[()=>Promise.all([r.e(71869),r.e(73019),r.e(96923),r.e(42969)]).then(r.bind(r,53452)),"@theme/ApiDoc",53452],f0fd16fd:[()=>r.e(576).then(r.bind(r,77010)),"@site/docs/price-rules/references/ruleset-properties.mdx",77010],f10edb4a:[()=>r.e(69358).then(r.bind(r,23699)),"@site/docs/platform-connector/concepts/index.mdx",23699],f15bd786:[()=>r.e(15288).then(r.t.bind(r,59986,19)),"@generated/docusaurus-plugin-redoc/plugin-redoc-8/__plugin.json",59986],f1727f22:[()=>r.e(10124).then(r.bind(r,56426)),"@site/docs/subscriptions-v2/widgets.mdx",56426],f2001abc:[()=>r.e(712).then(r.bind(r,98405)),"@site/docs/price-rules/headless-storefront-setup.mdx",98405],f2679230:[()=>r.e(55354).then(r.bind(r,53977)),"@site/blog/2025-06-11.mdx?truncated=true",53977],f30c5500:[()=>r.e(91887).then(r.bind(r,24214)),"@site/docs/platform-integration/shopify/pre.mdx",24214],f33863cd:[()=>r.e(40067).then(r.bind(r,49798)),"@site/docs/checkout/references/plugin-events.mdx",49798],f37d7194:[()=>Promise.all([r.e(71869),r.e(15394),r.e(6056)]).then(r.bind(r,18583)),"@site/docs/price-rules/promotion-info.mdx",18583],f6208f34:[()=>r.e(78530).then(r.bind(r,60818)),"@site/blog/2023-08-29.mdx?truncated=true",60818],f6ec2898:[()=>r.e(44134).then(r.t.bind(r,7937,19)),"@generated/docusaurus-plugin-redoc/plugin-redoc-10/__plugin.json",7937],f8b42268:[()=>r.e(96185).then(r.t.bind(r,11031,19)),"@generated/docusaurus-plugin-content-docs/default/p/guides-tags-purchase-from-blog-781.json",11031],f94f984b:[()=>r.e(52259).then(r.t.bind(r,14008,19)),"/home/runner/work/developer-docs/developer-docs/.docusaurus/docusaurus-plugin-redoc/plugin-redoc-5/redocApiLayoutV1-plugin-redoc-5.json",14008],f970d283:[()=>r.e(26336).then(r.t.bind(r,82513,19)),"/home/runner/work/developer-docs/developer-docs/.docusaurus/docusaurus-plugin-redoc/plugin-redoc-11/redocApiSpecV1.2-plugin-redoc-11.json",82513],f97cd861:[()=>r.e(85729).then(r.bind(r,31944)),"@site/docs/checkout/resources/rate-limiting.mdx",31944],fac0a29f:[()=>r.e(97153).then(r.t.bind(r,38356,19)),"@generated/docusaurus-plugin-content-docs/default/p/guides-tags-ecommerce-platform-cc6.json",38356],fba0f0eb:[()=>r.e(86963).then(r.bind(r,48750)),"@site/blog/2023-07-24.mdx",48750],fc339e87:[()=>r.e(36813).then(r.bind(r,22312)),"@site/blog/2024-03-25.mdx?truncated=true",22312],fcb14d23:[()=>Promise.all([r.e(71869),r.e(15394),r.e(4564)]).then(r.bind(r,29863)),"@site/docs/subscriptions-v2/quick-start.mdx",29863],fd2cf4d0:[()=>Promise.all([r.e(71869),r.e(15394),r.e(21766)]).then(r.bind(r,11422)),"@site/docs/price-rules/public-integrations.mdx",11422],fda6331f:[()=>r.e(95).then(r.bind(r,95570)),"@site/blog/2023-06-12.mdx?truncated=true",95570],fdba9f39:[()=>Promise.all([r.e(71869),r.e(97336),r.e(49163)]).then(r.bind(r,97601)),"@site/docs/checkout/bold-boosters/gravity-forms-bold-booster-for-paypal.mdx",97601],fe0fceb1:[()=>r.e(51253).then(r.bind(r,82218)),"@site/docs/solutions/bold-built/payment-booster.mdx",82218],fe4b5782:[()=>r.e(62884).then(r.bind(r,1298)),"@site/blog/2023-07-24.mdx?truncated=true",1298],ff5a0d38:[()=>r.e(28588).then(r.t.bind(r,56987,19)),"@generated/docusaurus-plugin-redoc/plugin-redoc-12/__plugin.json",56987]};var a=r(74848);function c(e){let{error:t,retry:r,pastDelay:n}=e;return t?(0,a.jsxs)("div",{style:{textAlign:"center",color:"#fff",backgroundColor:"#fa383e",borderColor:"#fa383e",borderStyle:"solid",borderRadius:"0.25rem",borderWidth:"1px",boxSizing:"border-box",display:"block",padding:"1rem",flex:"0 0 50%",marginLeft:"25%",marginRight:"25%",marginTop:"5rem",maxWidth:"50%",width:"100%"},children:[(0,a.jsx)("p",{children:String(t)}),(0,a.jsx)("div",{children:(0,a.jsx)("button",{type:"button",onClick:r,children:"Retry"})})]}):n?(0,a.jsx)("div",{style:{display:"flex",justifyContent:"center",alignItems:"center",height:"100vh"},children:(0,a.jsx)("svg",{id:"loader",style:{width:128,height:110,position:"absolute",top:"calc(100vh - 64%)"},viewBox:"0 0 45 45",xmlns:"http://www.w3.org/2000/svg",stroke:"#61dafb",children:(0,a.jsxs)("g",{fill:"none",fillRule:"evenodd",transform:"translate(1 1)",strokeWidth:"2",children:[(0,a.jsxs)("circle",{cx:"22",cy:"22",r:"6",strokeOpacity:"0",children:[(0,a.jsx)("animate",{attributeName:"r",begin:"1.5s",dur:"3s",values:"6;22",calcMode:"linear",repeatCount:"indefinite"}),(0,a.jsx)("animate",{attributeName:"stroke-opacity",begin:"1.5s",dur:"3s",values:"1;0",calcMode:"linear",repeatCount:"indefinite"}),(0,a.jsx)("animate",{attributeName:"stroke-width",begin:"1.5s",dur:"3s",values:"2;0",calcMode:"linear",repeatCount:"indefinite"})]}),(0,a.jsxs)("circle",{cx:"22",cy:"22",r:"6",strokeOpacity:"0",children:[(0,a.jsx)("animate",{attributeName:"r",begin:"3s",dur:"3s",values:"6;22",calcMode:"linear",repeatCount:"indefinite"}),(0,a.jsx)("animate",{attributeName:"stroke-opacity",begin:"3s",dur:"3s",values:"1;0",calcMode:"linear",repeatCount:"indefinite"}),(0,a.jsx)("animate",{attributeName:"stroke-width",begin:"3s",dur:"3s",values:"2;0",calcMode:"linear",repeatCount:"indefinite"})]}),(0,a.jsx)("circle",{cx:"22",cy:"22",r:"8",children:(0,a.jsx)("animate",{attributeName:"r",begin:"0s",dur:"1.5s",values:"6;1;2;3;4;5;6",calcMode:"linear",repeatCount:"indefinite"})})]})})}):null}var p=r(86921),d=r(53102);function l(e,t){if("*"===e)return o()({loading:c,loader:()=>r.e(82237).then(r.bind(r,82237)),modules:["@theme/NotFound"],webpack:()=>[82237],render(e,t){const r=e.default;return(0,a.jsx)(d.W,{value:{plugin:{name:"native",id:"default"}},children:(0,a.jsx)(r,{...t})})}});const n=i[`${e}-${t}`],l={},u=[],m=[],h=(0,p.A)(n);return Object.entries(h).forEach((e=>{let[t,r]=e;const n=s[r];n&&(l[t]=n[0],u.push(n[1]),m.push(n[2]))})),o().Map({loading:c,loader:l,modules:u,webpack:()=>m,render(t,r){const o=JSON.parse(JSON.stringify(n));Object.entries(t).forEach((t=>{let[r,n]=t;const i=n.default;if(!i)throw new Error(`The page component at ${e} doesn't have a default export. This makes it impossible to render anything. Consider default-exporting a React component.`);"object"!=typeof i&&"function"!=typeof i||Object.keys(n).filter((e=>"default"!==e)).forEach((e=>{i[e]=n[e]}));let s=o;const a=r.split(".");a.slice(0,-1).forEach((e=>{s=s[e]})),s[a[a.length-1]]=i}));const i=o.__comp;delete o.__comp;const s=o.__context;delete o.__context;const c=o.__props;return delete o.__props,(0,a.jsx)(d.W,{value:s,children:(0,a.jsx)(i,{...o,...c,...r})})}})}const u=[{path:"/api-specifications",component:l("/api-specifications","90c"),exact:!0},{path:"/api/checkout",component:l("/api/checkout","a9c"),exact:!0},{path:"/api/checkout-admin",component:l("/api/checkout-admin","62b"),exact:!0},{path:"/api/checkout-flows",component:l("/api/checkout-flows","fba"),exact:!0},{path:"/api/checkout-rsa",component:l("/api/checkout-rsa","536"),exact:!0},{path:"/api/customers",component:l("/api/customers","484"),exact:!0},{path:"/api/orders",component:l("/api/orders","8ca"),exact:!0},{path:"/api/platform-connector",component:l("/api/platform-connector","ead"),exact:!0},{path:"/api/platform-connector-destinations",component:l("/api/platform-connector-destinations","6dc"),exact:!0},{path:"/api/platform-event-notifications",component:l("/api/platform-event-notifications","483"),exact:!0},{path:"/api/price-rules",component:l("/api/price-rules","f65"),exact:!0},{path:"/api/products",component:l("/api/products","27f"),exact:!0},{path:"/api/shops",component:l("/api/shops","6c5"),exact:!0},{path:"/api/subscriptions",component:l("/api/subscriptions","7a6"),exact:!0},{path:"/changelog",component:l("/changelog","162"),exact:!0},{path:"/changelog/2022/07/11",component:l("/changelog/2022/07/11","ea9"),exact:!0},{path:"/changelog/2022/07/14/1",component:l("/changelog/2022/07/14/1","eaf"),exact:!0},{path:"/changelog/2022/07/21/1",component:l("/changelog/2022/07/21/1","a77"),exact:!0},{path:"/changelog/2022/07/29",component:l("/changelog/2022/07/29","f93"),exact:!0},{path:"/changelog/2022/08/02",component:l("/changelog/2022/08/02","1ee"),exact:!0},{path:"/changelog/2022/09/01",component:l("/changelog/2022/09/01","c93"),exact:!0},{path:"/changelog/2022/09/01/2",component:l("/changelog/2022/09/01/2","116"),exact:!0},{path:"/changelog/2022/09/13",component:l("/changelog/2022/09/13","dee"),exact:!0},{path:"/changelog/2022/09/16",component:l("/changelog/2022/09/16","183"),exact:!0},{path:"/changelog/2022/09/23",component:l("/changelog/2022/09/23","b43"),exact:!0},{path:"/changelog/2022/09/27",component:l("/changelog/2022/09/27","02a"),exact:!0},{path:"/changelog/2022/09/29",component:l("/changelog/2022/09/29","d54"),exact:!0},{path:"/changelog/2022/10/13",component:l("/changelog/2022/10/13","141"),exact:!0},{path:"/changelog/2022/10/17",component:l("/changelog/2022/10/17","f91"),exact:!0},{path:"/changelog/2022/10/18/1",component:l("/changelog/2022/10/18/1","ed1"),exact:!0},{path:"/changelog/2022/10/19",component:l("/changelog/2022/10/19","d09"),exact:!0},{path:"/changelog/2022/10/25",component:l("/changelog/2022/10/25","a58"),exact:!0},{path:"/changelog/2022/10/31",component:l("/changelog/2022/10/31","ffd"),exact:!0},{path:"/changelog/2022/11/10",component:l("/changelog/2022/11/10","953"),exact:!0},{path:"/changelog/2022/11/14",component:l("/changelog/2022/11/14","7bf"),exact:!0},{path:"/changelog/2022/12/02",component:l("/changelog/2022/12/02","f53"),exact:!0},{path:"/changelog/2022/12/02/01",component:l("/changelog/2022/12/02/01","434"),exact:!0},{path:"/changelog/2022/12/02/2",component:l("/changelog/2022/12/02/2","d37"),exact:!0},{path:"/changelog/2022/12/14",component:l("/changelog/2022/12/14","4cf"),exact:!0},{path:"/changelog/2022/12/23",component:l("/changelog/2022/12/23","4a5"),exact:!0},{path:"/changelog/2023/01/09",component:l("/changelog/2023/01/09","15e"),exact:!0},{path:"/changelog/2023/01/17",component:l("/changelog/2023/01/17","054"),exact:!0},{path:"/changelog/2023/01/20",component:l("/changelog/2023/01/20","49b"),exact:!0},{path:"/changelog/2023/02/01",component:l("/changelog/2023/02/01","a68"),exact:!0},{path:"/changelog/2023/02/07",component:l("/changelog/2023/02/07","832"),exact:!0},{path:"/changelog/2023/03/02",component:l("/changelog/2023/03/02","fa4"),exact:!0},{path:"/changelog/2023/03/07",component:l("/changelog/2023/03/07","1d9"),exact:!0},{path:"/changelog/2023/03/09",component:l("/changelog/2023/03/09","000"),exact:!0},{path:"/changelog/2023/03/27",component:l("/changelog/2023/03/27","9d0"),exact:!0},{path:"/changelog/2023/04/04",component:l("/changelog/2023/04/04","83c"),exact:!0},{path:"/changelog/2023/04/04/1",component:l("/changelog/2023/04/04/1","7fd"),exact:!0},{path:"/changelog/2023/04/05",component:l("/changelog/2023/04/05","c84"),exact:!0},{path:"/changelog/2023/04/21",component:l("/changelog/2023/04/21","05a"),exact:!0},{path:"/changelog/2023/04/21/1",component:l("/changelog/2023/04/21/1","040"),exact:!0},{path:"/changelog/2023/04/21/2",component:l("/changelog/2023/04/21/2","254"),exact:!0},{path:"/changelog/2023/05/01",component:l("/changelog/2023/05/01","1ea"),exact:!0},{path:"/changelog/2023/05/02",component:l("/changelog/2023/05/02","265"),exact:!0},{path:"/changelog/2023/05/09",component:l("/changelog/2023/05/09","da5"),exact:!0},{path:"/changelog/2023/05/10",component:l("/changelog/2023/05/10","53a"),exact:!0},{path:"/changelog/2023/05/18",component:l("/changelog/2023/05/18","cfe"),exact:!0},{path:"/changelog/2023/05/18/1",component:l("/changelog/2023/05/18/1","386"),exact:!0},{path:"/changelog/2023/05/18/2",component:l("/changelog/2023/05/18/2","6b6"),exact:!0},{path:"/changelog/2023/05/23",component:l("/changelog/2023/05/23","5ba"),exact:!0},{path:"/changelog/2023/05/26",component:l("/changelog/2023/05/26","55a"),exact:!0},{path:"/changelog/2023/06/12",component:l("/changelog/2023/06/12","a48"),exact:!0},{path:"/changelog/2023/06/13",component:l("/changelog/2023/06/13","243"),exact:!0},{path:"/changelog/2023/06/20",component:l("/changelog/2023/06/20","9ba"),exact:!0},{path:"/changelog/2023/06/26",component:l("/changelog/2023/06/26","f01"),exact:!0},{path:"/changelog/2023/07/10",component:l("/changelog/2023/07/10","8db"),exact:!0},{path:"/changelog/2023/07/14",component:l("/changelog/2023/07/14","a8f"),exact:!0},{path:"/changelog/2023/07/14/1",component:l("/changelog/2023/07/14/1","b23"),exact:!0},{path:"/changelog/2023/07/24",component:l("/changelog/2023/07/24","f19"),exact:!0},{path:"/changelog/2023/07/25",component:l("/changelog/2023/07/25","be7"),exact:!0},{path:"/changelog/2023/08/08",component:l("/changelog/2023/08/08","1ad"),exact:!0},{path:"/changelog/2023/08/17",component:l("/changelog/2023/08/17","428"),exact:!0},{path:"/changelog/2023/08/22",component:l("/changelog/2023/08/22","ab7"),exact:!0},{path:"/changelog/2023/08/29",component:l("/changelog/2023/08/29","b35"),exact:!0},{path:"/changelog/2023/09/08",component:l("/changelog/2023/09/08","b07"),exact:!0},{path:"/changelog/2023/09/14",component:l("/changelog/2023/09/14","ddb"),exact:!0},{path:"/changelog/2023/09/18",component:l("/changelog/2023/09/18","d4a"),exact:!0},{path:"/changelog/2023/09/22",component:l("/changelog/2023/09/22","f35"),exact:!0},{path:"/changelog/2023/09/27",component:l("/changelog/2023/09/27","850"),exact:!0},{path:"/changelog/2023/09/27/1",component:l("/changelog/2023/09/27/1","d42"),exact:!0},{path:"/changelog/2023/10/10",component:l("/changelog/2023/10/10","293"),exact:!0},{path:"/changelog/2023/10/11",component:l("/changelog/2023/10/11","f03"),exact:!0},{path:"/changelog/2023/10/27",component:l("/changelog/2023/10/27","ee9"),exact:!0},{path:"/changelog/2023/11/21",component:l("/changelog/2023/11/21","c2c"),exact:!0},{path:"/changelog/2023/11/22",component:l("/changelog/2023/11/22","72b"),exact:!0},{path:"/changelog/2023/11/30",component:l("/changelog/2023/11/30","ac0"),exact:!0},{path:"/changelog/2023/12/07",component:l("/changelog/2023/12/07","386"),exact:!0},{path:"/changelog/2023/12/11",component:l("/changelog/2023/12/11","694"),exact:!0},{path:"/changelog/2023/12/15",component:l("/changelog/2023/12/15","9d4"),exact:!0},{path:"/changelog/2024/01/02",component:l("/changelog/2024/01/02","c2e"),exact:!0},{path:"/changelog/2024/01/16",component:l("/changelog/2024/01/16","44e"),exact:!0},{path:"/changelog/2024/01/17",component:l("/changelog/2024/01/17","e0c"),exact:!0},{path:"/changelog/2024/01/18",component:l("/changelog/2024/01/18","47f"),exact:!0},{path:"/changelog/2024/02/01",component:l("/changelog/2024/02/01","a97"),exact:!0},{path:"/changelog/2024/03/25",component:l("/changelog/2024/03/25","609"),exact:!0},{path:"/changelog/2024/03/28",component:l("/changelog/2024/03/28","ec1"),exact:!0},{path:"/changelog/2024/04/23",component:l("/changelog/2024/04/23","a72"),exact:!0},{path:"/changelog/2024/06/06",component:l("/changelog/2024/06/06","90a"),exact:!0},{path:"/changelog/2024/06/17",component:l("/changelog/2024/06/17","8df"),exact:!0},{path:"/changelog/2024/07/16",component:l("/changelog/2024/07/16","b1c"),exact:!0},{path:"/changelog/2024/08/29",component:l("/changelog/2024/08/29","7a7"),exact:!0},{path:"/changelog/2024/09/17",component:l("/changelog/2024/09/17","108"),exact:!0},{path:"/changelog/2025/06/11",component:l("/changelog/2025/06/11","2ef"),exact:!0},{path:"/changelog/2025/11/18",component:l("/changelog/2025/11/18","8e1"),exact:!0},{path:"/changelog/2026/01/05",component:l("/changelog/2026/01/05","5f9"),exact:!0},{path:"/changelog/archive",component:l("/changelog/archive","bc1"),exact:!0},{path:"/changelog/tags",component:l("/changelog/tags","744"),exact:!0},{path:"/changelog/tags/breaking",component:l("/changelog/tags/breaking","5d9"),exact:!0},{path:"/changelog/tags/checkout",component:l("/changelog/tags/checkout","07e"),exact:!0},{path:"/changelog/tags/checkout-admin",component:l("/changelog/tags/checkout-admin","ad3"),exact:!0},{path:"/changelog/tags/checkout-backend",component:l("/changelog/tags/checkout-backend","cda"),exact:!0},{path:"/changelog/tags/checkout-frontend",component:l("/changelog/tags/checkout-frontend","b46"),exact:!0},{path:"/changelog/tags/customers",component:l("/changelog/tags/customers","ca5"),exact:!0},{path:"/changelog/tags/external-payment-gateway-connector",component:l("/changelog/tags/external-payment-gateway-connector","dce"),exact:!0},{path:"/changelog/tags/integrations",component:l("/changelog/tags/integrations","08a"),exact:!0},{path:"/changelog/tags/non-breaking",component:l("/changelog/tags/non-breaking","ce2"),exact:!0},{path:"/changelog/tags/platform-connector",component:l("/changelog/tags/platform-connector","fda"),exact:!0},{path:"/changelog/tags/platform-event-notifications",component:l("/changelog/tags/platform-event-notifications","308"),exact:!0},{path:"/changelog/tags/price-rules-api",component:l("/changelog/tags/price-rules-api","108"),exact:!0},{path:"/changelog/tags/remote-state-authority",component:l("/changelog/tags/remote-state-authority","299"),exact:!0},{path:"/changelog/tags/shops",component:l("/changelog/tags/shops","184"),exact:!0},{path:"/changelog/tags/subscriptions",component:l("/changelog/tags/subscriptions","8db"),exact:!0},{path:"/search",component:l("/search","5de"),exact:!0},{path:"/solution-library",component:l("/solution-library","b19"),exact:!0},{path:"/guides",component:l("/guides","946"),routes:[{path:"/guides",component:l("/guides","004"),routes:[{path:"/guides/tags",component:l("/guides/tags","cfe"),exact:!0},{path:"/guides/tags/abandoned-cart",component:l("/guides/tags/abandoned-cart","e87"),exact:!0},{path:"/guides/tags/adobe-commerce",component:l("/guides/tags/adobe-commerce","5c7"),exact:!0},{path:"/guides/tags/algolia",component:l("/guides/tags/algolia","2c6"),exact:!0},{path:"/guides/tags/apple-pay",component:l("/guides/tags/apple-pay","b42"),exact:!0},{path:"/guides/tags/area",component:l("/guides/tags/area","789"),exact:!0},{path:"/guides/tags/authenticated-checkout",component:l("/guides/tags/authenticated-checkout","1f6"),exact:!0},{path:"/guides/tags/authentication",component:l("/guides/tags/authentication","f06"),exact:!0},{path:"/guides/tags/big-commerce",component:l("/guides/tags/big-commerce","998"),exact:!0},{path:"/guides/tags/biometrics",component:l("/guides/tags/biometrics","c30"),exact:!0},{path:"/guides/tags/blog",component:l("/guides/tags/blog","b80"),exact:!0},{path:"/guides/tags/braintree",component:l("/guides/tags/braintree","a98"),exact:!0},{path:"/guides/tags/buy-now",component:l("/guides/tags/buy-now","da9"),exact:!0},{path:"/guides/tags/checkout-experience-templates",component:l("/guides/tags/checkout-experience-templates","7b7"),exact:!0},{path:"/guides/tags/checkout-flow",component:l("/guides/tags/checkout-flow","407"),exact:!0},{path:"/guides/tags/checkout-flows",component:l("/guides/tags/checkout-flows","fcd"),exact:!0},{path:"/guides/tags/coalition-technologies",component:l("/guides/tags/coalition-technologies","1b3"),exact:!0},{path:"/guides/tags/commercetools",component:l("/guides/tags/commercetools","6bb"),exact:!0},{path:"/guides/tags/constructor",component:l("/guides/tags/constructor","33a"),exact:!0},{path:"/guides/tags/conversion",component:l("/guides/tags/conversion","601"),exact:!0},{path:"/guides/tags/convert-from-search",component:l("/guides/tags/convert-from-search","771"),exact:!0},{path:"/guides/tags/customer-management-system",component:l("/guides/tags/customer-management-system","183"),exact:!0},{path:"/guides/tags/ecommerce-platform",component:l("/guides/tags/ecommerce-platform","83a"),exact:!0},{path:"/guides/tags/email",component:l("/guides/tags/email","725"),exact:!0},{path:"/guides/tags/epg",component:l("/guides/tags/epg","229"),exact:!0},{path:"/guides/tags/express-checkout",component:l("/guides/tags/express-checkout","45b"),exact:!0},{path:"/guides/tags/express-pay",component:l("/guides/tags/express-pay","425"),exact:!0},{path:"/guides/tags/external-payment-gateway-connector",component:l("/guides/tags/external-payment-gateway-connector","dc4"),exact:!0},{path:"/guides/tags/google-pay",component:l("/guides/tags/google-pay","a70"),exact:!0},{path:"/guides/tags/harry-rosen",component:l("/guides/tags/harry-rosen","0c5"),exact:!0},{path:"/guides/tags/klarna",component:l("/guides/tags/klarna","db1"),exact:!0},{path:"/guides/tags/klaviyo",component:l("/guides/tags/klaviyo","2d5"),exact:!0},{path:"/guides/tags/m-1",component:l("/guides/tags/m-1","66e"),exact:!0},{path:"/guides/tags/magento-1",component:l("/guides/tags/magento-1","750"),exact:!0},{path:"/guides/tags/magento-2",component:l("/guides/tags/magento-2","1e5"),exact:!0},{path:"/guides/tags/magento-open-source",component:l("/guides/tags/magento-open-source","458"),exact:!0},{path:"/guides/tags/oracle",component:l("/guides/tags/oracle","16b"),exact:!0},{path:"/guides/tags/oracle-commerce-cloud",component:l("/guides/tags/oracle-commerce-cloud","582"),exact:!0},{path:"/guides/tags/order-management-system",component:l("/guides/tags/order-management-system","565"),exact:!0},{path:"/guides/tags/orium",component:l("/guides/tags/orium","150"),exact:!0},{path:"/guides/tags/partner-flow",component:l("/guides/tags/partner-flow","43f"),exact:!0},{path:"/guides/tags/partner-name",component:l("/guides/tags/partner-name","512"),exact:!0},{path:"/guides/tags/partner-type",component:l("/guides/tags/partner-type","65f"),exact:!0},{path:"/guides/tags/pay-pal",component:l("/guides/tags/pay-pal","651"),exact:!0},{path:"/guides/tags/pay-pal-complete-payments",component:l("/guides/tags/pay-pal-complete-payments","0fa"),exact:!0},{path:"/guides/tags/pay-pal-express",component:l("/guides/tags/pay-pal-express","3eb"),exact:!0},{path:"/guides/tags/payment-gateway",component:l("/guides/tags/payment-gateway","688"),exact:!0},{path:"/guides/tags/payments",component:l("/guides/tags/payments","b3c"),exact:!0},{path:"/guides/tags/platform",component:l("/guides/tags/platform","50a"),exact:!0},{path:"/guides/tags/platform-connector",component:l("/guides/tags/platform-connector","d68"),exact:!0},{path:"/guides/tags/pre-purchase-upsell",component:l("/guides/tags/pre-purchase-upsell","05f"),exact:!0},{path:"/guides/tags/product-information-system",component:l("/guides/tags/product-information-system","25d"),exact:!0},{path:"/guides/tags/purchase-from-blog",component:l("/guides/tags/purchase-from-blog","5c1"),exact:!0},{path:"/guides/tags/search",component:l("/guides/tags/search","80e"),exact:!0},{path:"/guides/tags/self-hosted",component:l("/guides/tags/self-hosted","db9"),exact:!0},{path:"/guides/tags/shipper-hq",component:l("/guides/tags/shipper-hq","ff9"),exact:!0},{path:"/guides/tags/shipping",component:l("/guides/tags/shipping","728"),exact:!0},{path:"/guides/tags/stripe",component:l("/guides/tags/stripe","ce5"),exact:!0},{path:"/guides/tags/tax",component:l("/guides/tags/tax","0fd"),exact:!0},{path:"/guides/tags/tax-jar",component:l("/guides/tags/tax-jar","75a"),exact:!0},{path:"/guides/tags/taxes",component:l("/guides/tags/taxes","b7b"),exact:!0},{path:"/guides/tags/technology-partner",component:l("/guides/tags/technology-partner","689"),exact:!0},{path:"/guides/tags/unsupported-platform",component:l("/guides/tags/unsupported-platform","c04"),exact:!0},{path:"/guides/tags/wallet-pay",component:l("/guides/tags/wallet-pay","263"),exact:!0},{path:"/guides/tags/wink",component:l("/guides/tags/wink","a3e"),exact:!0},{path:"/guides",component:l("/guides","28d"),routes:[{path:"/guides/archive",component:l("/guides/archive","a60"),exact:!0,sidebar:"otherApisSidebar"},{path:"/guides/archive/cashier",component:l("/guides/archive/cashier","dc4"),exact:!0,sidebar:"otherApisSidebar"},{path:"/guides/archive/gravity-forms-upgrade",component:l("/guides/archive/gravity-forms-upgrade","cb8"),exact:!0},{path:"/guides/archive/installation",component:l("/guides/archive/installation","f9f"),exact:!0},{path:"/guides/archive/installation_m1",component:l("/guides/archive/installation_m1","171"),exact:!0},{path:"/guides/archive/subscriptions_v1_integration",component:l("/guides/archive/subscriptions_v1_integration","559"),exact:!0,sidebar:"otherApisSidebar"},{path:"/guides/archive/subscriptions_v1_msp",component:l("/guides/archive/subscriptions_v1_msp","a36"),exact:!0,sidebar:"otherApisSidebar"},{path:"/guides/archive/subscriptions_v1_storefront",component:l("/guides/archive/subscriptions_v1_storefront","be0"),exact:!0,sidebar:"otherApisSidebar"},{path:"/guides/checkout",component:l("/guides/checkout","38b"),exact:!0},{path:"/guides/checkout/api-overrides",component:l("/guides/checkout/api-overrides","b50"),exact:!0},{path:"/guides/checkout/batch-processing",component:l("/guides/checkout/batch-processing","08a"),exact:!0},{path:"/guides/checkout/bold-boosters/adobe-commerce-bold-booster-for-intuit",component:l("/guides/checkout/bold-boosters/adobe-commerce-bold-booster-for-intuit","f5c"),exact:!0,sidebar:"checkoutSidebar"},{path:"/guides/checkout/bold-boosters/adobe-commerce-bold-booster-for-paypal",component:l("/guides/checkout/bold-boosters/adobe-commerce-bold-booster-for-paypal","e67"),exact:!0,sidebar:"checkoutSidebar"},{path:"/guides/checkout/bold-boosters/bold-booster-for-paypal-overview",component:l("/guides/checkout/bold-boosters/bold-booster-for-paypal-overview","773"),exact:!0,sidebar:"checkoutSidebar"},{path:"/guides/checkout/bold-boosters/bold-booster-security",component:l("/guides/checkout/bold-boosters/bold-booster-security","601"),exact:!0,sidebar:"checkoutSidebar"},{path:"/guides/checkout/bold-boosters/bold-booster-troubleshooting",component:l("/guides/checkout/bold-boosters/bold-booster-troubleshooting","129"),exact:!0,sidebar:"checkoutSidebar"},{path:"/guides/checkout/bold-boosters/bold-booster-upgrade",component:l("/guides/checkout/bold-boosters/bold-booster-upgrade","6cb"),exact:!0,sidebar:"checkoutSidebar"},{path:"/guides/checkout/bold-boosters/connect-authorize",component:l("/guides/checkout/bold-boosters/connect-authorize","43c"),exact:!0,sidebar:"checkoutSidebar"},{path:"/guides/checkout/bold-boosters/connect-braintree",component:l("/guides/checkout/bold-boosters/connect-braintree","c2e"),exact:!0,sidebar:"checkoutSidebar"},{path:"/guides/checkout/bold-boosters/connect-intuit",component:l("/guides/checkout/bold-boosters/connect-intuit","999"),exact:!0,sidebar:"checkoutSidebar"},{path:"/guides/checkout/bold-boosters/connect-nuvei",component:l("/guides/checkout/bold-boosters/connect-nuvei","5ff"),exact:!0,sidebar:"checkoutSidebar"},{path:"/guides/checkout/bold-boosters/connect-payment-gateways",component:l("/guides/checkout/bold-boosters/connect-payment-gateways","1a4"),exact:!0,sidebar:"checkoutSidebar"},{path:"/guides/checkout/bold-boosters/connect-ppcp",component:l("/guides/checkout/bold-boosters/connect-ppcp","00c"),exact:!0,sidebar:"checkoutSidebar"},{path:"/guides/checkout/bold-boosters/connect-stripe",component:l("/guides/checkout/bold-boosters/connect-stripe","db0"),exact:!0,sidebar:"checkoutSidebar"},{path:"/guides/checkout/bold-boosters/export-request-logs",component:l("/guides/checkout/bold-boosters/export-request-logs","233"),exact:!0,sidebar:"checkoutSidebar"},{path:"/guides/checkout/bold-boosters/gravity-forms-bold-booster-for-paypal",component:l("/guides/checkout/bold-boosters/gravity-forms-bold-booster-for-paypal","eb1"),exact:!0,sidebar:"checkoutSidebar"},{path:"/guides/checkout/bold-boosters/install-compatibility-modules",component:l("/guides/checkout/bold-boosters/install-compatibility-modules","bf3"),exact:!0,sidebar:"checkoutSidebar"},{path:"/guides/checkout/bold-boosters/integrate-forter",component:l("/guides/checkout/bold-boosters/integrate-forter","905"),exact:!0},{path:"/guides/checkout/bold-boosters/m1-bold-booster-for-paypal",component:l("/guides/checkout/bold-boosters/m1-bold-booster-for-paypal","285"),exact:!0,sidebar:"checkoutSidebar"},{path:"/guides/checkout/bold-boosters/opencart-bold-booster-for-paypal",component:l("/guides/checkout/bold-boosters/opencart-bold-booster-for-paypal","3d4"),exact:!0,sidebar:"checkoutSidebar"},{path:"/guides/checkout/bold-boosters/set-up-apple-pay",component:l("/guides/checkout/bold-boosters/set-up-apple-pay","22a"),exact:!0,sidebar:"checkoutSidebar"},{path:"/guides/checkout/bold-boosters/set-up-google-pay",component:l("/guides/checkout/bold-boosters/set-up-google-pay","ebc"),exact:!0,sidebar:"checkoutSidebar"},{path:"/guides/checkout/checkout-epg-guide",component:l("/guides/checkout/checkout-epg-guide","236"),exact:!0},{path:"/guides/checkout/checkout-getting-started",component:l("/guides/checkout/checkout-getting-started","59d"),exact:!0},{path:"/guides/checkout/concepts",component:l("/guides/checkout/concepts","cf6"),exact:!0},{path:"/guides/checkout/concepts/cart-parameters",component:l("/guides/checkout/concepts/cart-parameters","03c"),exact:!0},{path:"/guides/checkout/concepts/external-payment-gateways",component:l("/guides/checkout/concepts/external-payment-gateways","5b2"),exact:!0},{path:"/guides/checkout/concepts/flows",component:l("/guides/checkout/concepts/flows","eab"),exact:!0},{path:"/guides/checkout/concepts/headless",component:l("/guides/checkout/concepts/headless","8f5"),exact:!0},{path:"/guides/checkout/concepts/overrides",component:l("/guides/checkout/concepts/overrides","171"),exact:!0},{path:"/guides/checkout/concepts/payment-information",component:l("/guides/checkout/concepts/payment-information","ad7"),exact:!0,sidebar:"checkoutSidebar"},{path:"/guides/checkout/concepts/plugins",component:l("/guides/checkout/concepts/plugins","0c4"),exact:!0},{path:"/guides/checkout/concepts/sdk-integrate",component:l("/guides/checkout/concepts/sdk-integrate","65d"),exact:!0},{path:"/guides/checkout/concepts/spi-integrate",component:l("/guides/checkout/concepts/spi-integrate","094"),exact:!0},{path:"/guides/checkout/create-order",component:l("/guides/checkout/create-order","769"),exact:!0},{path:"/guides/checkout/css",component:l("/guides/checkout/css","643"),exact:!0},{path:"/guides/checkout/extend",component:l("/guides/checkout/extend","d90"),exact:!0},{path:"/guides/checkout/fulfill-order",component:l("/guides/checkout/fulfill-order","2af"),exact:!0},{path:"/guides/checkout/gift-cards",component:l("/guides/checkout/gift-cards","61b"),exact:!0},{path:"/guides/checkout/integrations/commercetools",component:l("/guides/checkout/integrations/commercetools","7aa"),exact:!0},{path:"/guides/checkout/life",component:l("/guides/checkout/life","da9"),exact:!0},{path:"/guides/checkout/meta",component:l("/guides/checkout/meta","a7a"),exact:!0},{path:"/guides/checkout/metrics",component:l("/guides/checkout/metrics","c20"),exact:!0},{path:"/guides/checkout/plugins",component:l("/guides/checkout/plugins","e68"),exact:!0},{path:"/guides/checkout/plugins/app-hooks",component:l("/guides/checkout/plugins/app-hooks","e51"),exact:!0},{path:"/guides/checkout/plugins/event-action-loop",component:l("/guides/checkout/plugins/event-action-loop","4c6"),exact:!0},{path:"/guides/checkout/plugins/getting-started",component:l("/guides/checkout/plugins/getting-started","a0d"),exact:!0},{path:"/guides/checkout/plugins/installation-flow",component:l("/guides/checkout/plugins/installation-flow","1f9"),exact:!0},{path:"/guides/checkout/plugins/overrides",component:l("/guides/checkout/plugins/overrides","7b8"),exact:!0},{path:"/guides/checkout/pmmc",component:l("/guides/checkout/pmmc","cf4"),exact:!0},{path:"/guides/checkout/populate-order",component:l("/guides/checkout/populate-order","2be"),exact:!0},{path:"/guides/checkout/public-integrations",component:l("/guides/checkout/public-integrations","98d"),exact:!0},{path:"/guides/checkout/quick-start",component:l("/guides/checkout/quick-start","741"),exact:!0},{path:"/guides/checkout/references/checkout-epg-api",component:l("/guides/checkout/references/checkout-epg-api","27f"),exact:!0},{path:"/guides/checkout/references/checkout-spi-api",component:l("/guides/checkout/references/checkout-spi-api","be9"),exact:!0},{path:"/guides/checkout/references/country-province-requirements",component:l("/guides/checkout/references/country-province-requirements","774"),exact:!0},{path:"/guides/checkout/references/epg-actions-events",component:l("/guides/checkout/references/epg-actions-events","bcb"),exact:!0},{path:"/guides/checkout/references/plugin-actions",component:l("/guides/checkout/references/plugin-actions","cc0"),exact:!0},{path:"/guides/checkout/references/plugin-events",component:l("/guides/checkout/references/plugin-events","bb3"),exact:!0},{path:"/guides/checkout/resources/access-scopes",component:l("/guides/checkout/resources/access-scopes","370"),exact:!0},{path:"/guides/checkout/resources/api-versioning",component:l("/guides/checkout/resources/api-versioning","a7f"),exact:!0},{path:"/guides/checkout/resources/error-responses",component:l("/guides/checkout/resources/error-responses","2a0"),exact:!0},{path:"/guides/checkout/resources/glossary",component:l("/guides/checkout/resources/glossary","668"),exact:!0},{path:"/guides/checkout/resources/open-source",component:l("/guides/checkout/resources/open-source","63e"),exact:!0},{path:"/guides/checkout/resources/query-pagination",component:l("/guides/checkout/resources/query-pagination","b00"),exact:!0},{path:"/guides/checkout/resources/rate-limiting",component:l("/guides/checkout/resources/rate-limiting","5c5"),exact:!0},{path:"/guides/checkout/resources/supported-platforms-gateways",component:l("/guides/checkout/resources/supported-platforms-gateways","c30"),exact:!0},{path:"/guides/checkout/self-hosted-flow",component:l("/guides/checkout/self-hosted-flow","63c"),exact:!0},{path:"/guides/checkout/validate-discounts",component:l("/guides/checkout/validate-discounts","891"),exact:!0},{path:"/guides/checkout/webhooks",component:l("/guides/checkout/webhooks","b8b"),exact:!0},{path:"/guides/platform-connector",component:l("/guides/platform-connector","b88"),exact:!0},{path:"/guides/platform-connector/concepts",component:l("/guides/platform-connector/concepts","949"),exact:!0},{path:"/guides/platform-connector/concepts/components",component:l("/guides/platform-connector/concepts/components","272"),exact:!0},{path:"/guides/platform-connector/concepts/example-implementations",component:l("/guides/platform-connector/concepts/example-implementations","284"),exact:!0},{path:"/guides/platform-connector/create-server",component:l("/guides/platform-connector/create-server","e9a"),exact:!0},{path:"/guides/platform-connector/event-notifications",component:l("/guides/platform-connector/event-notifications","b97"),exact:!0},{path:"/guides/platform-connector/getting-started",component:l("/guides/platform-connector/getting-started","b24"),exact:!0},{path:"/guides/platform-connector/requirements",component:l("/guides/platform-connector/requirements","2c1"),exact:!0},{path:"/guides/platform-connector/rsa/concepts",component:l("/guides/platform-connector/rsa/concepts","a06"),exact:!0},{path:"/guides/platform-connector/rsa/create-checkout-rsa",component:l("/guides/platform-connector/rsa/create-checkout-rsa","aac"),exact:!0},{path:"/guides/platform-connector/rsa/requirements",component:l("/guides/platform-connector/rsa/requirements","a38"),exact:!0},{path:"/guides/platform-connector/verify",component:l("/guides/platform-connector/verify","6a6"),exact:!0},{path:"/guides/platform-integration/adobe-commerce/concepts",component:l("/guides/platform-integration/adobe-commerce/concepts","469"),exact:!0},{path:"/guides/platform-integration/adobe-commerce/dev-store",component:l("/guides/platform-integration/adobe-commerce/dev-store","23e"),exact:!0},{path:"/guides/platform-integration/adobe-commerce/flows/paypal-checkout-flow",component:l("/guides/platform-integration/adobe-commerce/flows/paypal-checkout-flow","809"),exact:!0},{path:"/guides/platform-integration/adobe-commerce/generate-module-list",component:l("/guides/platform-integration/adobe-commerce/generate-module-list","869"),exact:!0},{path:"/guides/platform-integration/adobe-commerce/overview",component:l("/guides/platform-integration/adobe-commerce/overview","517"),exact:!0},{path:"/guides/platform-integration/adobe-commerce/troubleshooting",component:l("/guides/platform-integration/adobe-commerce/troubleshooting","a20"),exact:!0},{path:"/guides/platform-integration/adobe-commerce/versions",component:l("/guides/platform-integration/adobe-commerce/versions","a6c"),exact:!0},{path:"/guides/platform-integration/bigcommerce/pre",component:l("/guides/platform-integration/bigcommerce/pre","c0e"),exact:!0,sidebar:"preSidebar"},{path:"/guides/platform-integration/commercetools/headless-checkout",component:l("/guides/platform-integration/commercetools/headless-checkout","103"),exact:!0},{path:"/guides/platform-integration/magento-1/concepts",component:l("/guides/platform-integration/magento-1/concepts","aaf"),exact:!0},{path:"/guides/platform-integration/magento-1/dev-store",component:l("/guides/platform-integration/magento-1/dev-store","019"),exact:!0},{path:"/guides/platform-integration/magento-1/extensions",component:l("/guides/platform-integration/magento-1/extensions","68e"),exact:!0},{path:"/guides/platform-integration/magento-1/overview",component:l("/guides/platform-integration/magento-1/overview","36b"),exact:!0},{path:"/guides/platform-integration/magento-1/troubleshooting",component:l("/guides/platform-integration/magento-1/troubleshooting","cc6"),exact:!0},{path:"/guides/platform-integration/magento-1/versions",component:l("/guides/platform-integration/magento-1/versions","ba2"),exact:!0},{path:"/guides/platform-integration/shopify/pre",component:l("/guides/platform-integration/shopify/pre","707"),exact:!0,sidebar:"preSidebar"},{path:"/guides/price-rules",component:l("/guides/price-rules","62f"),exact:!0,sidebar:"preSidebar"},{path:"/guides/price-rules/additional-resources",component:l("/guides/price-rules/additional-resources","8e7"),exact:!0},{path:"/guides/price-rules/attributes",component:l("/guides/price-rules/attributes","61e"),exact:!0,sidebar:"preSidebar"},{path:"/guides/price-rules/concepts/rulesets-and-rules",component:l("/guides/price-rules/concepts/rulesets-and-rules","1e5"),exact:!0,sidebar:"preSidebar"},{path:"/guides/price-rules/customer-targeted-pricing",component:l("/guides/price-rules/customer-targeted-pricing","3f7"),exact:!0},{path:"/guides/price-rules/debug-tools",component:l("/guides/price-rules/debug-tools","9d0"),exact:!0,sidebar:"preSidebar"},{path:"/guides/price-rules/discount-codes",component:l("/guides/price-rules/discount-codes","c2b"),exact:!0},{path:"/guides/price-rules/errors",component:l("/guides/price-rules/errors","bb7"),exact:!0,sidebar:"preSidebar"},{path:"/guides/price-rules/getting-started",component:l("/guides/price-rules/getting-started","8b5"),exact:!0,sidebar:"preSidebar"},{path:"/guides/price-rules/headless-storefront-setup",component:l("/guides/price-rules/headless-storefront-setup","460"),exact:!0,sidebar:"preSidebar"},{path:"/guides/price-rules/promotion-info",component:l("/guides/price-rules/promotion-info","60f"),exact:!0},{path:"/guides/price-rules/promotion-message",component:l("/guides/price-rules/promotion-message","644"),exact:!0,sidebar:"preSidebar"},{path:"/guides/price-rules/public-integrations",component:l("/guides/price-rules/public-integrations","dec"),exact:!0,sidebar:"preSidebar"},{path:"/guides/price-rules/quick-start",component:l("/guides/price-rules/quick-start","08b"),exact:!0,sidebar:"preSidebar"},{path:"/guides/price-rules/references/actions",component:l("/guides/price-rules/references/actions","39f"),exact:!0,sidebar:"preSidebar"},{path:"/guides/price-rules/references/conditions",component:l("/guides/price-rules/references/conditions","8f0"),exact:!0,sidebar:"preSidebar"},{path:"/guides/price-rules/references/frontend-api",component:l("/guides/price-rules/references/frontend-api","32c"),exact:!0,sidebar:"preSidebar"},{path:"/guides/price-rules/references/product-selection",component:l("/guides/price-rules/references/product-selection","ec8"),exact:!0,sidebar:"preSidebar"},{path:"/guides/price-rules/references/ruleset-properties",component:l("/guides/price-rules/references/ruleset-properties","a26"),exact:!0,sidebar:"preSidebar"},{path:"/guides/price-rules/resources/access-scopes",component:l("/guides/price-rules/resources/access-scopes","9d6"),exact:!0,sidebar:"preSidebar"},{path:"/guides/price-rules/resources/api-versioning",component:l("/guides/price-rules/resources/api-versioning","539"),exact:!0,sidebar:"preSidebar"},{path:"/guides/price-rules/resources/error-responses",component:l("/guides/price-rules/resources/error-responses","e4b"),exact:!0,sidebar:"preSidebar"},{path:"/guides/price-rules/resources/glossary",component:l("/guides/price-rules/resources/glossary","577"),exact:!0,sidebar:"preSidebar"},{path:"/guides/price-rules/resources/open-source",component:l("/guides/price-rules/resources/open-source","214"),exact:!0,sidebar:"preSidebar"},{path:"/guides/price-rules/resources/query-pagination",component:l("/guides/price-rules/resources/query-pagination","80d"),exact:!0,sidebar:"preSidebar"},{path:"/guides/price-rules/resources/rate-limiting",component:l("/guides/price-rules/resources/rate-limiting","8dd"),exact:!0,sidebar:"preSidebar"},{path:"/guides/price-rules/resources/supported-platforms-gateways",component:l("/guides/price-rules/resources/supported-platforms-gateways","0c9"),exact:!0,sidebar:"preSidebar"},{path:"/guides/price-rules/working-with-rulesets/cart-level-promotions",component:l("/guides/price-rules/working-with-rulesets/cart-level-promotions","07c"),exact:!0,sidebar:"preSidebar"},{path:"/guides/price-rules/working-with-rulesets/customer-targeted-pricing",component:l("/guides/price-rules/working-with-rulesets/customer-targeted-pricing","c1d"),exact:!0,sidebar:"preSidebar"},{path:"/guides/price-rules/working-with-rulesets/discount-codes",component:l("/guides/price-rules/working-with-rulesets/discount-codes","6d1"),exact:!0,sidebar:"preSidebar"},{path:"/guides/price-rules/working-with-rulesets/location-based-pricing",component:l("/guides/price-rules/working-with-rulesets/location-based-pricing","d48"),exact:!0,sidebar:"preSidebar"},{path:"/guides/price-rules/working-with-rulesets/managing-price-rules",component:l("/guides/price-rules/working-with-rulesets/managing-price-rules","f87"),exact:!0,sidebar:"preSidebar"},{path:"/guides/price-rules/working-with-rulesets/multi-currency",component:l("/guides/price-rules/working-with-rulesets/multi-currency","9f2"),exact:!0,sidebar:"preSidebar"},{path:"/guides/price-rules/working-with-rulesets/order-condition",component:l("/guides/price-rules/working-with-rulesets/order-condition","4d8"),exact:!0,sidebar:"preSidebar"},{path:"/guides/price-rules/working-with-rulesets/price-adjustments",component:l("/guides/price-rules/working-with-rulesets/price-adjustments","5f4"),exact:!0,sidebar:"preSidebar"},{path:"/guides/price-rules/working-with-rulesets/prioritization-and-stacking",component:l("/guides/price-rules/working-with-rulesets/prioritization-and-stacking","fe0"),exact:!0,sidebar:"preSidebar"},{path:"/guides/price-rules/working-with-rulesets/quantity-pricing",component:l("/guides/price-rules/working-with-rulesets/quantity-pricing","5e1"),exact:!0,sidebar:"preSidebar"},{path:"/guides/price-rules/working-with-rulesets/scheduling",component:l("/guides/price-rules/working-with-rulesets/scheduling","f4c"),exact:!0,sidebar:"preSidebar"},{path:"/guides/solutions/blueprints/abandoned-cart",component:l("/guides/solutions/blueprints/abandoned-cart","ac9"),exact:!0},{path:"/guides/solutions/blueprints/biometric-auth",component:l("/guides/solutions/blueprints/biometric-auth","f97"),exact:!0},{path:"/guides/solutions/blueprints/blog",component:l("/guides/solutions/blueprints/blog","4d0"),exact:!0},{path:"/guides/solutions/blueprints/buy-now",component:l("/guides/solutions/blueprints/buy-now","413"),exact:!0},{path:"/guides/solutions/blueprints/klarna",component:l("/guides/solutions/blueprints/klarna","490"),exact:!0},{path:"/guides/solutions/blueprints/platform-connector",component:l("/guides/solutions/blueprints/platform-connector","913"),exact:!0},{path:"/guides/solutions/blueprints/search-algolia",component:l("/guides/solutions/blueprints/search-algolia","1ab"),exact:!0},{path:"/guides/solutions/blueprints/search-constructor",component:l("/guides/solutions/blueprints/search-constructor","36b"),exact:!0},{path:"/guides/solutions/blueprints/template",component:l("/guides/solutions/blueprints/template","eec"),exact:!0},{path:"/guides/solutions/blueprints/upsell",component:l("/guides/solutions/blueprints/upsell","8f3"),exact:!0},{path:"/guides/solutions/bold-built/adobe",component:l("/guides/solutions/bold-built/adobe","92c"),exact:!0},{path:"/guides/solutions/bold-built/bigcommerce",component:l("/guides/solutions/bold-built/bigcommerce","59d"),exact:!0},{path:"/guides/solutions/bold-built/braintree",component:l("/guides/solutions/bold-built/braintree","6ff"),exact:!0},{path:"/guides/solutions/bold-built/commercetools",component:l("/guides/solutions/bold-built/commercetools","5e6"),exact:!0},{path:"/guides/solutions/bold-built/magento-1",component:l("/guides/solutions/bold-built/magento-1","5fa"),exact:!0},{path:"/guides/solutions/bold-built/payment-booster",component:l("/guides/solutions/bold-built/payment-booster","f1d"),exact:!0},{path:"/guides/solutions/bold-built/paypal-checkout-flow",component:l("/guides/solutions/bold-built/paypal-checkout-flow","2c2"),exact:!0},{path:"/guides/solutions/bold-built/ppcp",component:l("/guides/solutions/bold-built/ppcp","1e7"),exact:!0},{path:"/guides/solutions/bold-built/shipping",component:l("/guides/solutions/bold-built/shipping","91b"),exact:!0},{path:"/guides/solutions/bold-built/stripe",component:l("/guides/solutions/bold-built/stripe","591"),exact:!0},{path:"/guides/solutions/bold-built/taxjar",component:l("/guides/solutions/bold-built/taxjar","ea5"),exact:!0},{path:"/guides/solutions/bold-built/template",component:l("/guides/solutions/bold-built/template","a0a"),exact:!0},{path:"/guides/solutions/example-projects/custom-flow",component:l("/guides/solutions/example-projects/custom-flow","25c"),exact:!0},{path:"/guides/solutions/example-projects/express-pay",component:l("/guides/solutions/example-projects/express-pay","16d"),exact:!0},{path:"/guides/solutions/example-projects/template",component:l("/guides/solutions/example-projects/template","adc"),exact:!0},{path:"/guides/subscriptions-v2",component:l("/guides/subscriptions-v2","66a"),exact:!0,sidebar:"subscriptionsSidebar"},{path:"/guides/subscriptions-v2/adjust-subscription-orders",component:l("/guides/subscriptions-v2/adjust-subscription-orders","0bb"),exact:!0,sidebar:"subscriptionsSidebar"},{path:"/guides/subscriptions-v2/concepts",component:l("/guides/subscriptions-v2/concepts","581"),exact:!0,sidebar:"subscriptionsSidebar"},{path:"/guides/subscriptions-v2/create-line-items",component:l("/guides/subscriptions-v2/create-line-items","566"),exact:!0,sidebar:"subscriptionsSidebar"},{path:"/guides/subscriptions-v2/create-subscription",component:l("/guides/subscriptions-v2/create-subscription","b69"),exact:!0,sidebar:"subscriptionsSidebar"},{path:"/guides/subscriptions-v2/customer-portals",component:l("/guides/subscriptions-v2/customer-portals","403"),exact:!0,sidebar:"subscriptionsSidebar"},{path:"/guides/subscriptions-v2/getting-started",component:l("/guides/subscriptions-v2/getting-started","de4"),exact:!0,sidebar:"subscriptionsSidebar"},{path:"/guides/subscriptions-v2/headless/storefront-setup",component:l("/guides/subscriptions-v2/headless/storefront-setup","28e"),exact:!0,sidebar:"subscriptionsSidebar"},{path:"/guides/subscriptions-v2/line-items",component:l("/guides/subscriptions-v2/line-items","f6b"),exact:!0,sidebar:"subscriptionsSidebar"},{path:"/guides/subscriptions-v2/public-integrations",component:l("/guides/subscriptions-v2/public-integrations","122"),exact:!0,sidebar:"subscriptionsSidebar"},{path:"/guides/subscriptions-v2/quick-start",component:l("/guides/subscriptions-v2/quick-start","1d9"),exact:!0,sidebar:"subscriptionsSidebar"},{path:"/guides/subscriptions-v2/resources/access-scopes",component:l("/guides/subscriptions-v2/resources/access-scopes","579"),exact:!0,sidebar:"subscriptionsSidebar"},{path:"/guides/subscriptions-v2/resources/api-versioning",component:l("/guides/subscriptions-v2/resources/api-versioning","4b9"),exact:!0,sidebar:"subscriptionsSidebar"},{path:"/guides/subscriptions-v2/resources/error-responses",component:l("/guides/subscriptions-v2/resources/error-responses","3e6"),exact:!0,sidebar:"subscriptionsSidebar"},{path:"/guides/subscriptions-v2/resources/glossary",component:l("/guides/subscriptions-v2/resources/glossary","af6"),exact:!0,sidebar:"subscriptionsSidebar"},{path:"/guides/subscriptions-v2/resources/open-source",component:l("/guides/subscriptions-v2/resources/open-source","4ce"),exact:!0,sidebar:"subscriptionsSidebar"},{path:"/guides/subscriptions-v2/resources/query-pagination",component:l("/guides/subscriptions-v2/resources/query-pagination","4e2"),exact:!0,sidebar:"subscriptionsSidebar"},{path:"/guides/subscriptions-v2/resources/rate-limiting",component:l("/guides/subscriptions-v2/resources/rate-limiting","411"),exact:!0,sidebar:"subscriptionsSidebar"},{path:"/guides/subscriptions-v2/resources/supported-platforms-gateways",component:l("/guides/subscriptions-v2/resources/supported-platforms-gateways","66f"),exact:!0,sidebar:"subscriptionsSidebar"},{path:"/guides/subscriptions-v2/update-subscription",component:l("/guides/subscriptions-v2/update-subscription","5ba"),exact:!0,sidebar:"subscriptionsSidebar"},{path:"/guides/subscriptions-v2/view-future-orders",component:l("/guides/subscriptions-v2/view-future-orders","90c"),exact:!0,sidebar:"subscriptionsSidebar"},{path:"/guides/subscriptions-v2/webhooks",component:l("/guides/subscriptions-v2/webhooks","e47"),exact:!0,sidebar:"subscriptionsSidebar"},{path:"/guides/subscriptions-v2/widgets",component:l("/guides/subscriptions-v2/widgets","2a6"),exact:!0,sidebar:"subscriptionsSidebar"}]}]}]},{path:"/",component:l("/","e5f"),exact:!0},{path:"*",component:l("*")}]},6125:(e,t,r)=>{"use strict";r.d(t,{o:()=>i,x:()=>s});var n=r(96540),o=r(74848);const i=n.createContext(!1);function s(e){let{children:t}=e;const[r,s]=(0,n.useState)(!1);return(0,n.useEffect)((()=>{s(!0)}),[]),(0,o.jsx)(i.Provider,{value:r,children:t})}},38536:(e,t,r)=>{"use strict";var n=r(96540),o=r(5338),i=r(80545),s=r(54625),a=r(4784),c=r(38193);const p=[r(10119),r(26134),r(76294),r(89888),r(7767),r(23390)];var d=r(35947),l=r(56347),u=r(22831),m=r(74848);function h(e){let{children:t}=e;return(0,m.jsx)(m.Fragment,{children:t})}var f=r(5260),g=r(44586),y=r(86025),b=r(6342),_=r(45500),v=r(32131),x=r(14090),w=r(2967),k=r(70440),S=r(41463);function T(){const{i18n:{currentLocale:e,defaultLocale:t,localeConfigs:r}}=(0,g.A)(),n=(0,v.o)(),o=r[e].htmlLang,i=e=>e.replace("-","_");return(0,m.jsxs)(f.A,{children:[Object.entries(r).map((e=>{let[t,{htmlLang:r}]=e;return(0,m.jsx)("link",{rel:"alternate",href:n.createUrl({locale:t,fullyQualified:!0}),hrefLang:r},t)})),(0,m.jsx)("link",{rel:"alternate",href:n.createUrl({locale:t,fullyQualified:!0}),hrefLang:"x-default"}),(0,m.jsx)("meta",{property:"og:locale",content:i(o)}),Object.values(r).filter((e=>o!==e.htmlLang)).map((e=>(0,m.jsx)("meta",{property:"og:locale:alternate",content:i(e.htmlLang)},`meta-og-${e.htmlLang}`)))]})}function C(e){let{permalink:t}=e;const{siteConfig:{url:r}}=(0,g.A)(),n=function(){const{siteConfig:{url:e,baseUrl:t,trailingSlash:r}}=(0,g.A)(),{pathname:n}=(0,l.zy)();return e+(0,k.applyTrailingSlash)((0,y.Ay)(n),{trailingSlash:r,baseUrl:t})}(),o=t?`${r}${t}`:n;return(0,m.jsxs)(f.A,{children:[(0,m.jsx)("meta",{property:"og:url",content:o}),(0,m.jsx)("link",{rel:"canonical",href:o})]})}function A(){const{i18n:{currentLocale:e}}=(0,g.A)(),{metadata:t,image:r}=(0,b.p)();return(0,m.jsxs)(m.Fragment,{children:[(0,m.jsxs)(f.A,{children:[(0,m.jsx)("meta",{name:"twitter:card",content:"summary_large_image"}),(0,m.jsx)("body",{className:x.w})]}),r&&(0,m.jsx)(_.be,{image:r}),(0,m.jsx)(C,{}),(0,m.jsx)(T,{}),(0,m.jsx)(S.A,{tag:w.Cy,locale:e}),(0,m.jsx)(f.A,{children:t.map(((e,t)=>(0,m.jsx)("meta",{...e},t)))})]})}const I=new Map;var j=r(6125),E=r(26988),P=r(205);function R(e){for(var t=arguments.length,r=new Array(t>1?t-1:0),n=1;n<t;n++)r[n-1]=arguments[n];const o=p.map((t=>{const n=t.default?.[e]??t[e];return n?.(...r)}));return()=>o.forEach((e=>e?.()))}const O=function(e){let{children:t,location:r,previousLocation:n}=e;return(0,P.A)((()=>{n!==r&&(!function(e){let{location:t,previousLocation:r}=e;if(!r)return;const n=t.pathname===r.pathname,o=t.hash===r.hash,i=t.search===r.search;if(n&&o&&!i)return;const{hash:s}=t;if(s){const e=decodeURIComponent(s.substring(1)),t=document.getElementById(e);t?.scrollIntoView()}else window.scrollTo(0,0)}({location:r,previousLocation:n}),R("onRouteDidUpdate",{previousLocation:n,location:r}))}),[n,r]),t};function q(e){const t=Array.from(new Set([e,decodeURI(e)])).map((e=>(0,u.u)(d.A,e))).flat();return Promise.all(t.map((e=>e.route.component.preload?.())))}class $ extends n.Component{previousLocation;routeUpdateCleanupCb;constructor(e){super(e),this.previousLocation=null,this.routeUpdateCleanupCb=c.default.canUseDOM?R("onRouteUpdate",{previousLocation:null,location:this.props.location}):()=>{},this.state={nextRouteHasLoaded:!0}}shouldComponentUpdate(e,t){if(e.location===this.props.location)return t.nextRouteHasLoaded;const r=e.location;return this.previousLocation=this.props.location,this.setState({nextRouteHasLoaded:!1}),this.routeUpdateCleanupCb=R("onRouteUpdate",{previousLocation:this.previousLocation,location:r}),q(r.pathname).then((()=>{this.routeUpdateCleanupCb(),this.setState({nextRouteHasLoaded:!0})})).catch((e=>{console.warn(e),window.location.reload()})),!1}render(){const{children:e,location:t}=this.props;return(0,m.jsx)(O,{previousLocation:this.previousLocation,location:t,children:(0,m.jsx)(l.qh,{location:t,render:()=>e})})}}const D=$,B="__docusaurus-base-url-issue-banner-container",L="__docusaurus-base-url-issue-banner",U="__docusaurus-base-url-issue-banner-suggestion-container";function N(e){return`\ndocument.addEventListener('DOMContentLoaded', function maybeInsertBanner() {\n  var shouldInsert = typeof window['docusaurus'] === 'undefined';\n  shouldInsert && insertBanner();\n});\n\nfunction insertBanner() {\n  var bannerContainer = document.createElement('div');\n  bannerContainer.id = '${B}';\n  var bannerHtml = ${JSON.stringify(function(e){return`\n<div id="${L}" style="border: thick solid red; background-color: rgb(255, 230, 179); margin: 20px; padding: 20px; font-size: 20px;">\n   <p style="font-weight: bold; font-size: 30px;">Your Docusaurus site did not load properly.</p>\n   <p>A very common reason is a wrong site <a href="proxy.php?url=https%3A%2F%2Fdocusaurus.io%2Fdocs%2Fdocusaurus.config.js%2F%23baseUrl" style="font-weight: bold;">baseUrl configuration</a>.</p>\n   <p>Current configured baseUrl = <span style="font-weight: bold; color: red;">${e}</span> ${"/"===e?" (default value)":""}</p>\n   <p>We suggest trying baseUrl = <span id="${U}" style="font-weight: bold; color: green;"></span></p>\n</div>\n`}(e)).replace(/</g,"\\<")};\n  bannerContainer.innerHTML = bannerHtml;\n  document.body.prepend(bannerContainer);\n  var suggestionContainer = document.getElementById('${U}');\n  var actualHomePagePath = window.location.pathname;\n  var suggestedBaseUrl = actualHomePagePath.substr(-1) === '/'\n        ? actualHomePagePath\n        : actualHomePagePath + '/';\n  suggestionContainer.innerHTML = suggestedBaseUrl;\n}\n`}function F(){const{siteConfig:{baseUrl:e}}=(0,g.A)();return(0,m.jsx)(m.Fragment,{children:!c.default.canUseDOM&&(0,m.jsx)(f.A,{children:(0,m.jsx)("script",{children:N(e)})})})}function M(){const{siteConfig:{baseUrl:e,baseUrlIssueBanner:t}}=(0,g.A)(),{pathname:r}=(0,l.zy)();return t&&r===e?(0,m.jsx)(F,{}):null}function G(){const{siteConfig:{favicon:e,title:t,noIndex:r},i18n:{currentLocale:n,localeConfigs:o}}=(0,g.A)(),i=(0,y.Ay)(e),{htmlLang:s,direction:a}=o[n];return(0,m.jsxs)(f.A,{children:[(0,m.jsx)("html",{lang:s,dir:a}),(0,m.jsx)("title",{children:t}),(0,m.jsx)("meta",{property:"og:title",content:t}),(0,m.jsx)("meta",{name:"viewport",content:"width=device-width, initial-scale=1.0"}),r&&(0,m.jsx)("meta",{name:"robots",content:"noindex, nofollow"}),e&&(0,m.jsx)("link",{rel:"icon",href:i})]})}var z=r(67489),W=r(92303);function H(){const e=(0,W.A)();return(0,m.jsx)(f.A,{children:(0,m.jsx)("html",{"data-has-hydrated":e})})}const Z=(0,u.v)(d.A);function V(){const e=function(e){if(I.has(e.pathname))return{...e,pathname:I.get(e.pathname)};if((0,u.u)(d.A,e.pathname).some((e=>{let{route:t}=e;return!0===t.exact})))return I.set(e.pathname,e.pathname),e;const t=e.pathname.trim().replace(/(?:\/index)?\.html$/,"")||"/";return I.set(e.pathname,t),{...e,pathname:t}}((0,l.zy)());return(0,m.jsx)(D,{location:e,children:Z})}function K(){return(0,m.jsx)(z.A,{children:(0,m.jsx)(E.l,{children:(0,m.jsxs)(j.x,{children:[(0,m.jsxs)(h,{children:[(0,m.jsx)(G,{}),(0,m.jsx)(A,{}),(0,m.jsx)(M,{}),(0,m.jsx)(V,{})]}),(0,m.jsx)(H,{})]})})})}var Y=r(84054);const J=function(e){try{return document.createElement("link").relList.supports(e)}catch{return!1}}("prefetch")?function(e){return new Promise(((t,r)=>{if("undefined"==typeof document)return void r();const n=document.createElement("link");n.setAttribute("rel","prefetch"),n.setAttribute("href",e),n.onload=()=>t(),n.onerror=()=>r();const o=document.getElementsByTagName("head")[0]??document.getElementsByName("script")[0]?.parentNode;o?.appendChild(n)}))}:function(e){return new Promise(((t,r)=>{const n=new XMLHttpRequest;n.open("GET",e,!0),n.withCredentials=!0,n.onload=()=>{200===n.status?t():r()},n.send(null)}))};var X=r(86921);const Q=new Set,ee=new Set,te=()=>navigator.connection?.effectiveType.includes("2g")||navigator.connection?.saveData,re={prefetch:e=>{if(!(e=>!te()&&!ee.has(e)&&!Q.has(e))(e))return!1;Q.add(e);const t=(0,u.u)(d.A,e).flatMap((e=>{return t=e.route.path,Object.entries(Y).filter((e=>{let[r]=e;return r.replace(/-[^-]+$/,"")===t})).flatMap((e=>{let[,t]=e;return Object.values((0,X.A)(t))}));var t}));return Promise.all(t.map((e=>{const t=r.gca(e);return t&&!t.includes("undefined")?J(t).catch((()=>{})):Promise.resolve()})))},preload:e=>!!(e=>!te()&&!ee.has(e))(e)&&(ee.add(e),q(e))},ne=Object.freeze(re);function oe(e){let{children:t}=e;return"hash"===a.default.future.experimental_router?(0,m.jsx)(s.I9,{children:t}):(0,m.jsx)(s.Kd,{children:t})}const ie=Boolean(!0);if(c.default.canUseDOM){window.docusaurus=ne;const e=document.getElementById("__docusaurus"),t=(0,m.jsx)(i.vd,{children:(0,m.jsx)(oe,{children:(0,m.jsx)(K,{})})}),r=(e,t)=>{console.error("Docusaurus React Root onRecoverableError:",e,t)},s=()=>{if(window.docusaurusRoot)window.docusaurusRoot.render(t);else if(ie)window.docusaurusRoot=o.hydrateRoot(e,t,{onRecoverableError:r});else{const n=o.createRoot(e,{onRecoverableError:r});n.render(t),window.docusaurusRoot=n}};q(window.location.pathname).then((()=>{(0,n.startTransition)(s)}))}},26988:(e,t,r)=>{"use strict";r.d(t,{o:()=>l,l:()=>u});var n=r(96540),o=r(4784);const i=JSON.parse('{"docusaurus-plugin-content-docs":{"default":{"path":"/guides","versions":[{"name":"current","label":"Next","isLast":true,"path":"/guides","mainDocId":"checkout/bold-boosters/bold-booster-for-paypal-overview","docs":[{"id":"archive/cashier","path":"/guides/archive/cashier","sidebar":"otherApisSidebar"},{"id":"archive/gravity-forms-upgrade","path":"/guides/archive/gravity-forms-upgrade","unlisted":true},{"id":"archive/index","path":"/guides/archive/","sidebar":"otherApisSidebar"},{"id":"archive/installation","path":"/guides/archive/installation","unlisted":true},{"id":"archive/installation_m1","path":"/guides/archive/installation_m1","unlisted":true},{"id":"archive/subscriptions_v1_integration","path":"/guides/archive/subscriptions_v1_integration","sidebar":"otherApisSidebar"},{"id":"archive/subscriptions_v1_msp","path":"/guides/archive/subscriptions_v1_msp","sidebar":"otherApisSidebar"},{"id":"archive/subscriptions_v1_storefront","path":"/guides/archive/subscriptions_v1_storefront","sidebar":"otherApisSidebar"},{"id":"checkout/api-overrides","path":"/guides/checkout/api-overrides"},{"id":"checkout/batch-processing","path":"/guides/checkout/batch-processing"},{"id":"checkout/bold-boosters/adobe-commerce-bold-booster-for-intuit","path":"/guides/checkout/bold-boosters/adobe-commerce-bold-booster-for-intuit","sidebar":"checkoutSidebar"},{"id":"checkout/bold-boosters/adobe-commerce-bold-booster-for-paypal","path":"/guides/checkout/bold-boosters/adobe-commerce-bold-booster-for-paypal","sidebar":"checkoutSidebar"},{"id":"checkout/bold-boosters/bold-booster-for-paypal-overview","path":"/guides/checkout/bold-boosters/bold-booster-for-paypal-overview","sidebar":"checkoutSidebar"},{"id":"checkout/bold-boosters/bold-booster-security","path":"/guides/checkout/bold-boosters/bold-booster-security","sidebar":"checkoutSidebar"},{"id":"checkout/bold-boosters/bold-booster-troubleshooting","path":"/guides/checkout/bold-boosters/bold-booster-troubleshooting","sidebar":"checkoutSidebar"},{"id":"checkout/bold-boosters/bold-booster-upgrade","path":"/guides/checkout/bold-boosters/bold-booster-upgrade","sidebar":"checkoutSidebar"},{"id":"checkout/bold-boosters/connect-authorize","path":"/guides/checkout/bold-boosters/connect-authorize","sidebar":"checkoutSidebar"},{"id":"checkout/bold-boosters/connect-braintree","path":"/guides/checkout/bold-boosters/connect-braintree","sidebar":"checkoutSidebar"},{"id":"checkout/bold-boosters/connect-intuit","path":"/guides/checkout/bold-boosters/connect-intuit","sidebar":"checkoutSidebar"},{"id":"checkout/bold-boosters/connect-nuvei","path":"/guides/checkout/bold-boosters/connect-nuvei","sidebar":"checkoutSidebar"},{"id":"checkout/bold-boosters/connect-payment-gateways","path":"/guides/checkout/bold-boosters/connect-payment-gateways","sidebar":"checkoutSidebar"},{"id":"checkout/bold-boosters/connect-ppcp","path":"/guides/checkout/bold-boosters/connect-ppcp","sidebar":"checkoutSidebar"},{"id":"checkout/bold-boosters/connect-stripe","path":"/guides/checkout/bold-boosters/connect-stripe","sidebar":"checkoutSidebar"},{"id":"checkout/bold-boosters/export-request-logs","path":"/guides/checkout/bold-boosters/export-request-logs","sidebar":"checkoutSidebar"},{"id":"checkout/bold-boosters/gravity-forms-bold-booster-for-paypal","path":"/guides/checkout/bold-boosters/gravity-forms-bold-booster-for-paypal","sidebar":"checkoutSidebar"},{"id":"checkout/bold-boosters/install-compatibility-modules","path":"/guides/checkout/bold-boosters/install-compatibility-modules","sidebar":"checkoutSidebar"},{"id":"checkout/bold-boosters/integrate-forter","path":"/guides/checkout/bold-boosters/integrate-forter"},{"id":"checkout/bold-boosters/m1-bold-booster-for-paypal","path":"/guides/checkout/bold-boosters/m1-bold-booster-for-paypal","sidebar":"checkoutSidebar"},{"id":"checkout/bold-boosters/opencart-bold-booster-for-paypal","path":"/guides/checkout/bold-boosters/opencart-bold-booster-for-paypal","sidebar":"checkoutSidebar"},{"id":"checkout/bold-boosters/set-up-apple-pay","path":"/guides/checkout/bold-boosters/set-up-apple-pay","sidebar":"checkoutSidebar"},{"id":"checkout/bold-boosters/set-up-google-pay","path":"/guides/checkout/bold-boosters/set-up-google-pay","sidebar":"checkoutSidebar"},{"id":"checkout/checkout-epg-guide","path":"/guides/checkout/checkout-epg-guide"},{"id":"checkout/checkout-getting-started","path":"/guides/checkout/checkout-getting-started","unlisted":true},{"id":"checkout/concepts/cart-parameters","path":"/guides/checkout/concepts/cart-parameters"},{"id":"checkout/concepts/external-payment-gateways","path":"/guides/checkout/concepts/external-payment-gateways"},{"id":"checkout/concepts/flows","path":"/guides/checkout/concepts/flows","unlisted":true},{"id":"checkout/concepts/headless","path":"/guides/checkout/concepts/headless","unlisted":true},{"id":"checkout/concepts/index","path":"/guides/checkout/concepts/"},{"id":"checkout/concepts/overrides","path":"/guides/checkout/concepts/overrides"},{"id":"checkout/concepts/payment-information","path":"/guides/checkout/concepts/payment-information","sidebar":"checkoutSidebar"},{"id":"checkout/concepts/plugins","path":"/guides/checkout/concepts/plugins"},{"id":"checkout/concepts/sdk-integrate","path":"/guides/checkout/concepts/sdk-integrate","unlisted":true},{"id":"checkout/concepts/spi-integrate","path":"/guides/checkout/concepts/spi-integrate","unlisted":true},{"id":"checkout/create-order","path":"/guides/checkout/create-order","unlisted":true},{"id":"checkout/css","path":"/guides/checkout/css"},{"id":"checkout/extend","path":"/guides/checkout/extend"},{"id":"checkout/fulfill-order","path":"/guides/checkout/fulfill-order"},{"id":"checkout/gift-cards","path":"/guides/checkout/gift-cards"},{"id":"checkout/index","path":"/guides/checkout/"},{"id":"checkout/integrations/commercetools","path":"/guides/checkout/integrations/commercetools"},{"id":"checkout/life","path":"/guides/checkout/life"},{"id":"checkout/meta","path":"/guides/checkout/meta","unlisted":true},{"id":"checkout/metrics","path":"/guides/checkout/metrics"},{"id":"checkout/plugins/app-hooks","path":"/guides/checkout/plugins/app-hooks"},{"id":"checkout/plugins/event-action-loop","path":"/guides/checkout/plugins/event-action-loop","unlisted":true},{"id":"checkout/plugins/getting-started","path":"/guides/checkout/plugins/getting-started","unlisted":true},{"id":"checkout/plugins/index","path":"/guides/checkout/plugins/"},{"id":"checkout/plugins/installation-flow","path":"/guides/checkout/plugins/installation-flow","unlisted":true},{"id":"checkout/plugins/overrides","path":"/guides/checkout/plugins/overrides"},{"id":"checkout/pmmc","path":"/guides/checkout/pmmc"},{"id":"checkout/populate-order","path":"/guides/checkout/populate-order","unlisted":true},{"id":"checkout/public-integrations","path":"/guides/checkout/public-integrations"},{"id":"checkout/quick-start","path":"/guides/checkout/quick-start"},{"id":"checkout/references/checkout-epg-api","path":"/guides/checkout/references/checkout-epg-api","unlisted":true},{"id":"checkout/references/checkout-spi-api","path":"/guides/checkout/references/checkout-spi-api","unlisted":true},{"id":"checkout/references/country-province-requirements","path":"/guides/checkout/references/country-province-requirements","unlisted":true},{"id":"checkout/references/epg-actions-events","path":"/guides/checkout/references/epg-actions-events","unlisted":true},{"id":"checkout/references/plugin-actions","path":"/guides/checkout/references/plugin-actions","unlisted":true},{"id":"checkout/references/plugin-events","path":"/guides/checkout/references/plugin-events","unlisted":true},{"id":"checkout/resources/access-scopes","path":"/guides/checkout/resources/access-scopes"},{"id":"checkout/resources/api-versioning","path":"/guides/checkout/resources/api-versioning"},{"id":"checkout/resources/error-responses","path":"/guides/checkout/resources/error-responses"},{"id":"checkout/resources/glossary","path":"/guides/checkout/resources/glossary"},{"id":"checkout/resources/open-source","path":"/guides/checkout/resources/open-source"},{"id":"checkout/resources/query-pagination","path":"/guides/checkout/resources/query-pagination"},{"id":"checkout/resources/rate-limiting","path":"/guides/checkout/resources/rate-limiting"},{"id":"checkout/resources/supported-platforms-gateways","path":"/guides/checkout/resources/supported-platforms-gateways"},{"id":"checkout/self-hosted-flow","path":"/guides/checkout/self-hosted-flow","unlisted":true},{"id":"checkout/validate-discounts","path":"/guides/checkout/validate-discounts"},{"id":"checkout/webhooks","path":"/guides/checkout/webhooks"},{"id":"platform-connector/concepts/components","path":"/guides/platform-connector/concepts/components"},{"id":"platform-connector/concepts/example-implementations","path":"/guides/platform-connector/concepts/example-implementations"},{"id":"platform-connector/concepts/index","path":"/guides/platform-connector/concepts/"},{"id":"platform-connector/create-server","path":"/guides/platform-connector/create-server"},{"id":"platform-connector/event-notifications","path":"/guides/platform-connector/event-notifications"},{"id":"platform-connector/getting-started","path":"/guides/platform-connector/getting-started"},{"id":"platform-connector/index","path":"/guides/platform-connector/"},{"id":"platform-connector/requirements","path":"/guides/platform-connector/requirements"},{"id":"platform-connector/rsa/concepts","path":"/guides/platform-connector/rsa/concepts"},{"id":"platform-connector/rsa/create-checkout-rsa","path":"/guides/platform-connector/rsa/create-checkout-rsa"},{"id":"platform-connector/rsa/requirements","path":"/guides/platform-connector/rsa/requirements"},{"id":"platform-connector/verify","path":"/guides/platform-connector/verify"},{"id":"platform-integration/adobe-commerce/concepts","path":"/guides/platform-integration/adobe-commerce/concepts"},{"id":"platform-integration/adobe-commerce/dev-store","path":"/guides/platform-integration/adobe-commerce/dev-store"},{"id":"platform-integration/adobe-commerce/flows/paypal-checkout-flow","path":"/guides/platform-integration/adobe-commerce/flows/paypal-checkout-flow"},{"id":"platform-integration/adobe-commerce/generate-module-list","path":"/guides/platform-integration/adobe-commerce/generate-module-list"},{"id":"platform-integration/adobe-commerce/overview","path":"/guides/platform-integration/adobe-commerce/overview"},{"id":"platform-integration/adobe-commerce/troubleshooting","path":"/guides/platform-integration/adobe-commerce/troubleshooting"},{"id":"platform-integration/adobe-commerce/versions","path":"/guides/platform-integration/adobe-commerce/versions"},{"id":"platform-integration/bigcommerce/pre","path":"/guides/platform-integration/bigcommerce/pre","sidebar":"preSidebar"},{"id":"platform-integration/commercetools/headless-checkout","path":"/guides/platform-integration/commercetools/headless-checkout"},{"id":"platform-integration/magento-1/concepts","path":"/guides/platform-integration/magento-1/concepts"},{"id":"platform-integration/magento-1/dev-store","path":"/guides/platform-integration/magento-1/dev-store"},{"id":"platform-integration/magento-1/extensions","path":"/guides/platform-integration/magento-1/extensions"},{"id":"platform-integration/magento-1/overview","path":"/guides/platform-integration/magento-1/overview"},{"id":"platform-integration/magento-1/troubleshooting","path":"/guides/platform-integration/magento-1/troubleshooting"},{"id":"platform-integration/magento-1/versions","path":"/guides/platform-integration/magento-1/versions"},{"id":"platform-integration/shopify/pre","path":"/guides/platform-integration/shopify/pre","sidebar":"preSidebar"},{"id":"price-rules/additional-resources","path":"/guides/price-rules/additional-resources"},{"id":"price-rules/attributes","path":"/guides/price-rules/attributes","sidebar":"preSidebar"},{"id":"price-rules/concepts/rulesets-and-rules","path":"/guides/price-rules/concepts/rulesets-and-rules","sidebar":"preSidebar"},{"id":"price-rules/customer-targeted-pricing","path":"/guides/price-rules/customer-targeted-pricing"},{"id":"price-rules/debug-tools","path":"/guides/price-rules/debug-tools","sidebar":"preSidebar"},{"id":"price-rules/discount-codes","path":"/guides/price-rules/discount-codes"},{"id":"price-rules/errors","path":"/guides/price-rules/errors","sidebar":"preSidebar"},{"id":"price-rules/getting-started","path":"/guides/price-rules/getting-started","sidebar":"preSidebar"},{"id":"price-rules/headless-storefront-setup","path":"/guides/price-rules/headless-storefront-setup","sidebar":"preSidebar"},{"id":"price-rules/index","path":"/guides/price-rules/","sidebar":"preSidebar"},{"id":"price-rules/promotion-info","path":"/guides/price-rules/promotion-info"},{"id":"price-rules/promotion-message","path":"/guides/price-rules/promotion-message","sidebar":"preSidebar"},{"id":"price-rules/public-integrations","path":"/guides/price-rules/public-integrations","sidebar":"preSidebar"},{"id":"price-rules/quick-start","path":"/guides/price-rules/quick-start","sidebar":"preSidebar"},{"id":"price-rules/references/actions","path":"/guides/price-rules/references/actions","sidebar":"preSidebar"},{"id":"price-rules/references/conditions","path":"/guides/price-rules/references/conditions","sidebar":"preSidebar"},{"id":"price-rules/references/frontend-api","path":"/guides/price-rules/references/frontend-api","sidebar":"preSidebar"},{"id":"price-rules/references/product-selection","path":"/guides/price-rules/references/product-selection","sidebar":"preSidebar"},{"id":"price-rules/references/ruleset-properties","path":"/guides/price-rules/references/ruleset-properties","sidebar":"preSidebar"},{"id":"price-rules/resources/access-scopes","path":"/guides/price-rules/resources/access-scopes","sidebar":"preSidebar"},{"id":"price-rules/resources/api-versioning","path":"/guides/price-rules/resources/api-versioning","sidebar":"preSidebar"},{"id":"price-rules/resources/error-responses","path":"/guides/price-rules/resources/error-responses","sidebar":"preSidebar"},{"id":"price-rules/resources/glossary","path":"/guides/price-rules/resources/glossary","sidebar":"preSidebar"},{"id":"price-rules/resources/open-source","path":"/guides/price-rules/resources/open-source","sidebar":"preSidebar"},{"id":"price-rules/resources/query-pagination","path":"/guides/price-rules/resources/query-pagination","sidebar":"preSidebar"},{"id":"price-rules/resources/rate-limiting","path":"/guides/price-rules/resources/rate-limiting","sidebar":"preSidebar"},{"id":"price-rules/resources/supported-platforms-gateways","path":"/guides/price-rules/resources/supported-platforms-gateways","sidebar":"preSidebar"},{"id":"price-rules/working-with-rulesets/cart-level-promotions","path":"/guides/price-rules/working-with-rulesets/cart-level-promotions","sidebar":"preSidebar"},{"id":"price-rules/working-with-rulesets/customer-targeted-pricing","path":"/guides/price-rules/working-with-rulesets/customer-targeted-pricing","sidebar":"preSidebar"},{"id":"price-rules/working-with-rulesets/discount-codes","path":"/guides/price-rules/working-with-rulesets/discount-codes","sidebar":"preSidebar"},{"id":"price-rules/working-with-rulesets/location-based-pricing","path":"/guides/price-rules/working-with-rulesets/location-based-pricing","sidebar":"preSidebar"},{"id":"price-rules/working-with-rulesets/managing-price-rules","path":"/guides/price-rules/working-with-rulesets/managing-price-rules","sidebar":"preSidebar"},{"id":"price-rules/working-with-rulesets/multi-currency","path":"/guides/price-rules/working-with-rulesets/multi-currency","sidebar":"preSidebar"},{"id":"price-rules/working-with-rulesets/order-condition","path":"/guides/price-rules/working-with-rulesets/order-condition","sidebar":"preSidebar"},{"id":"price-rules/working-with-rulesets/price-adjustments","path":"/guides/price-rules/working-with-rulesets/price-adjustments","sidebar":"preSidebar"},{"id":"price-rules/working-with-rulesets/prioritization-and-stacking","path":"/guides/price-rules/working-with-rulesets/prioritization-and-stacking","sidebar":"preSidebar"},{"id":"price-rules/working-with-rulesets/quantity-pricing","path":"/guides/price-rules/working-with-rulesets/quantity-pricing","sidebar":"preSidebar"},{"id":"price-rules/working-with-rulesets/scheduling","path":"/guides/price-rules/working-with-rulesets/scheduling","sidebar":"preSidebar"},{"id":"solutions/blueprints/abandoned-cart","path":"/guides/solutions/blueprints/abandoned-cart"},{"id":"solutions/blueprints/biometric-auth","path":"/guides/solutions/blueprints/biometric-auth"},{"id":"solutions/blueprints/blog","path":"/guides/solutions/blueprints/blog"},{"id":"solutions/blueprints/buy-now","path":"/guides/solutions/blueprints/buy-now"},{"id":"solutions/blueprints/klarna","path":"/guides/solutions/blueprints/klarna"},{"id":"solutions/blueprints/platform-connector","path":"/guides/solutions/blueprints/platform-connector"},{"id":"solutions/blueprints/search-algolia","path":"/guides/solutions/blueprints/search-algolia"},{"id":"solutions/blueprints/search-constructor","path":"/guides/solutions/blueprints/search-constructor"},{"id":"solutions/blueprints/template","path":"/guides/solutions/blueprints/template","unlisted":true},{"id":"solutions/blueprints/upsell","path":"/guides/solutions/blueprints/upsell"},{"id":"solutions/bold-built/adobe","path":"/guides/solutions/bold-built/adobe"},{"id":"solutions/bold-built/bigcommerce","path":"/guides/solutions/bold-built/bigcommerce"},{"id":"solutions/bold-built/braintree","path":"/guides/solutions/bold-built/braintree"},{"id":"solutions/bold-built/commercetools","path":"/guides/solutions/bold-built/commercetools"},{"id":"solutions/bold-built/magento-1","path":"/guides/solutions/bold-built/magento-1"},{"id":"solutions/bold-built/payment-booster","path":"/guides/solutions/bold-built/payment-booster"},{"id":"solutions/bold-built/paypal-checkout-flow","path":"/guides/solutions/bold-built/paypal-checkout-flow"},{"id":"solutions/bold-built/ppcp","path":"/guides/solutions/bold-built/ppcp"},{"id":"solutions/bold-built/shipping","path":"/guides/solutions/bold-built/shipping"},{"id":"solutions/bold-built/stripe","path":"/guides/solutions/bold-built/stripe"},{"id":"solutions/bold-built/taxjar","path":"/guides/solutions/bold-built/taxjar"},{"id":"solutions/bold-built/template","path":"/guides/solutions/bold-built/template","unlisted":true},{"id":"solutions/example-projects/custom-flow","path":"/guides/solutions/example-projects/custom-flow"},{"id":"solutions/example-projects/express-pay","path":"/guides/solutions/example-projects/express-pay"},{"id":"solutions/example-projects/template","path":"/guides/solutions/example-projects/template","unlisted":true},{"id":"subscriptions-v2/adjust-subscription-orders","path":"/guides/subscriptions-v2/adjust-subscription-orders","sidebar":"subscriptionsSidebar"},{"id":"subscriptions-v2/concepts","path":"/guides/subscriptions-v2/concepts","sidebar":"subscriptionsSidebar"},{"id":"subscriptions-v2/create-line-items","path":"/guides/subscriptions-v2/create-line-items","sidebar":"subscriptionsSidebar"},{"id":"subscriptions-v2/create-subscription","path":"/guides/subscriptions-v2/create-subscription","sidebar":"subscriptionsSidebar"},{"id":"subscriptions-v2/customer-portals/index","path":"/guides/subscriptions-v2/customer-portals/","sidebar":"subscriptionsSidebar"},{"id":"subscriptions-v2/getting-started","path":"/guides/subscriptions-v2/getting-started","sidebar":"subscriptionsSidebar"},{"id":"subscriptions-v2/headless/storefront-setup","path":"/guides/subscriptions-v2/headless/storefront-setup","sidebar":"subscriptionsSidebar"},{"id":"subscriptions-v2/index","path":"/guides/subscriptions-v2/","sidebar":"subscriptionsSidebar"},{"id":"subscriptions-v2/line-items","path":"/guides/subscriptions-v2/line-items","sidebar":"subscriptionsSidebar"},{"id":"subscriptions-v2/public-integrations","path":"/guides/subscriptions-v2/public-integrations","sidebar":"subscriptionsSidebar"},{"id":"subscriptions-v2/quick-start","path":"/guides/subscriptions-v2/quick-start","sidebar":"subscriptionsSidebar"},{"id":"subscriptions-v2/resources/access-scopes","path":"/guides/subscriptions-v2/resources/access-scopes","sidebar":"subscriptionsSidebar"},{"id":"subscriptions-v2/resources/api-versioning","path":"/guides/subscriptions-v2/resources/api-versioning","sidebar":"subscriptionsSidebar"},{"id":"subscriptions-v2/resources/error-responses","path":"/guides/subscriptions-v2/resources/error-responses","sidebar":"subscriptionsSidebar"},{"id":"subscriptions-v2/resources/glossary","path":"/guides/subscriptions-v2/resources/glossary","sidebar":"subscriptionsSidebar"},{"id":"subscriptions-v2/resources/open-source","path":"/guides/subscriptions-v2/resources/open-source","sidebar":"subscriptionsSidebar"},{"id":"subscriptions-v2/resources/query-pagination","path":"/guides/subscriptions-v2/resources/query-pagination","sidebar":"subscriptionsSidebar"},{"id":"subscriptions-v2/resources/rate-limiting","path":"/guides/subscriptions-v2/resources/rate-limiting","sidebar":"subscriptionsSidebar"},{"id":"subscriptions-v2/resources/supported-platforms-gateways","path":"/guides/subscriptions-v2/resources/supported-platforms-gateways","sidebar":"subscriptionsSidebar"},{"id":"subscriptions-v2/update-subscription","path":"/guides/subscriptions-v2/update-subscription","sidebar":"subscriptionsSidebar"},{"id":"subscriptions-v2/view-future-orders","path":"/guides/subscriptions-v2/view-future-orders","sidebar":"subscriptionsSidebar"},{"id":"subscriptions-v2/webhooks","path":"/guides/subscriptions-v2/webhooks","sidebar":"subscriptionsSidebar"},{"id":"subscriptions-v2/widgets","path":"/guides/subscriptions-v2/widgets","sidebar":"subscriptionsSidebar"}],"draftIds":[],"sidebars":{"checkoutSidebar":{"link":{"path":"/guides/checkout/bold-boosters/bold-booster-for-paypal-overview","label":"Overview"}},"subscriptionsSidebar":{"link":{"path":"/guides/subscriptions-v2/","label":"subscriptions-v2/index"}},"preSidebar":{"link":{"path":"/guides/price-rules/","label":"price-rules/index"}},"otherApisSidebar":{"link":{"path":"/guides/archive/","label":"Other APIs"}}}}],"breadcrumbs":true}},"docusaurus-plugin-google-tag-manager":{"default":{"containerId":"GTM-NFVCMDW","id":"default"}},"docusaurus-plugin-redoc":{"plugin-redoc-0":{"url":"/api/checkout-frontend.openapi.yaml","themeId":"theme-redoc","isSpecFile":true,"spec":{"openapi":"3.0.0","info":{"title":"Checkout Frontend","version":"2.0","description":"The Checkout Frontend API is used to interact with an order. This includes the ability to get and manipulate order details from a browser.\\n\\nRefer to the <a href=\\"https://developer.boldcommerce.com/changelog/tags/checkout-frontend\\">changelog</a> for the latest updates to this API.","termsOfService":"https://boldcommerce.com/terms-of-service","contact":{"name":"Contact Us","url":"https://developer-dashboard.boldcommerce.com/default/contactus"}},"servers":[{"url":"https://api.boldcommerce.com"}],"security":[{"JWT":[]}],"tags":[{"name":"Addresses","description":"A child of the Order resource. Contains information about shipping and billing addresses. Use these endpoints to add shipping and billing addresses to an order."},{"name":"Batch Process","description":"Enables batch processing of certain Checkout Frontend endpoints."},{"name":"Customers","description":"A child of the Order resource. Contains information about guest customers on your store, including name and email. Use these endpoints to add or remove a guest customer to an order."},{"name":"Discounts","description":"Contains information about discount codes that have been applied to an order. Use these endpoints to manipulate discount codes on an order."},{"name":"Line Items","description":"A child of the Order resource. Contains information about the product and the taxes, fees, and discounts associated with it. Use these endpoints to manipulate line items on an order."},{"name":"Metadata","description":"A child of the Order resource. Contains metadata about the order, including cart parameters, note attributes, nots, and tags. Use these endpoints to manipulate the metadata on an order."},{"name":"Orders","description":"Contains information about a single order, including the full application state of the order. Use these endpoints to retrieve the application state, manipulate order metadata, process the order, and complete other order-related functions."},{"name":"Payments","description":"A child of the Order resource. Contains information about the payments on an order. Use these endpoints to manipulate the payments on an order."},{"name":"Payment Iframes","description":"Contains information about the [Secure Payments Interface (SPI)](/guides/checkout/resources/glossary#secure-payments-interface-spi). Use these endpoints to manipulate the SPI iFrame."},{"name":"Shipping Lines","description":"A child of the Order resource. Contains information about the order\'s shipping line, which is created via the [Bold Checkout admin](https://apps.boldapps.net/accounts/app/4). Use these endpoints to manipulate the shipping lines set on an order."},{"name":"Taxes","description":"A child of the Order resource. Contains information about order-level taxes. Use these endpoints to generate order-level taxes."},{"name":"Wallet Pay","description":"Contains information about wallet payments. Use these endpoints to create, update, and capture wallet pay orders. These endpoints currently support PayPal only."}],"externalDocs":{"description":"For more information about Checkout, refer to the Overview.","url":"https://developer.boldcommerce.com/guides/checkout"},"paths":{"/checkout/storefront/{shop_identifier}/{public_order_id}/addresses/shipping":{"parameters":[{"$ref":"#/components/parameters/shop_identifier"},{"$ref":"#/components/parameters/public_order_id"}],"post":{"summary":"Set Shipping Address","operationId":"SetShippingAddress","tags":["Addresses"],"description":"Sets the shipping address on the order.\\n\\nEach order can have only one shipping address. If you call this endpoint and a shipping address already exists, the existing address is overwritten.\\n\\nSet Shipping Address calls [Validate Address](checkout#operation/ValidateAddress) before setting the shipping address.\\n\\n> **Note:** Checkout admin settings can override schema requirements for `phone_number` and `business_name`. If `phone_number` or `business_name` are set to `required` in the [Bold Checkout admin](https://apps.boldapps.net/accounts/app/4), they are also `required` in this endpoint.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Address"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"address":{"$ref":"#/components/schemas/Address"},"application_state":{"$ref":"#/components/schemas/ApplicationState"}}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized-JWT"},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnprocessableEntity"},"example":{"errors":[{"message":"The country field is required.","type":"order","field":"country","severity":"validation","sub_type":"shipping_address"},{"message":"The country code field is required.","type":"order","field":"country_code","severity":"validation","sub_type":"shipping_address"}]}}}}}},"get":{"summary":"Get Shipping Address","operationId":"GetShippingAddress","tags":["Addresses"],"description":"Gets the shipping address on the order.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"address":{"$ref":"#/components/schemas/Address"},"application_state":{"$ref":"#/components/schemas/ApplicationState"}}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized-JWT"},"403":{"description":"Forbidden"}}},"put":{"summary":"Update Shipping Address","operationId":"UpdateShippingAddress","tags":["Addresses"],"description":"Updates the shipping address on the order.\\n\\nThis endpoint updates all fields of the shipping address. Any value left blank in the request body will be made blank in the updated address. The fields `country`, `country_code`, `province`, and `province_code` cannot be left blank.\\n\\n> **Note:** Checkout admin settings can override schema requirements for `phone_number` and `business_name`. If `phone_number` or `business_name` are set to `required` in the [Bold Checkout admin](https://apps.boldapps.net/accounts/app/4), they are also `required` in this endpoint.\\n\\n> **Note:** If taxes were previously calculated, changes to the shipping address may affect those calculations. Taxes are not recalculated automatically, so you must call the [Generate Taxes](checkout#operation/GenerateTaxes) endpoint to recalculate taxes for the order.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Address"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"address":{"$ref":"#/components/schemas/Address"},"application_state":{"$ref":"#/components/schemas/ApplicationState"}}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized-JWT"},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnprocessableEntity"},"example":{"errors":[{"message":"The country field is required.","type":"order","field":"country","severity":"validation","sub_type":"shipping_address"},{"message":"The country code field is required.","type":"order","field":"country_code","severity":"validation","sub_type":"shipping_address"}]}}}}}},"delete":{"summary":"Delete Shipping Address","operationId":"DeleteShippingAddress","tags":["Addresses"],"description":"Clears the shipping address from the order.\\n\\n> **Note:** If taxes were previously calculated, changes to the shipping address may affect those calculations. Taxes are not recalculated automatically, so you must call the [Generate Taxes](checkout#operation/GenerateTaxes) endpoint to recalculate taxes for the order.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"application_state":{"$ref":"#/components/schemas/ApplicationState"}}}}},"examples":{"DeletedShippingAddress":{"$ref":"#/components/examples/DeletedShippingAddress"}}}}},"401":{"$ref":"#/components/responses/Unauthorized-JWT"}}}},"/checkout/storefront/{shop_identifier}/{public_order_id}/addresses/billing":{"parameters":[{"$ref":"#/components/parameters/shop_identifier"},{"$ref":"#/components/parameters/public_order_id"}],"post":{"summary":"Set Billing Address","operationId":"SetBillingAddress","tags":["Addresses"],"description":"Sets the billing address on the order.\\n\\nEach order can have only one billing address. If you call this endpoint and a billing address already exists, the existing address will be overwritten.\\n\\nSet Billing Address calls [Validate Address](checkout#operation/ValidateAddress) before setting the billing address.\\n\\n> **Note:** Checkout admin settings can override schema requirements for `phone_number` and `business_name`. If `phone_number` or `business_name` are set to `required` in the [Bold Checkout admin](https://apps.boldapps.net/accounts/app/4), they are also `required` in this endpoint.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Address"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"address":{"$ref":"#/components/schemas/Address"},"application_state":{"$ref":"#/components/schemas/ApplicationState"}}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized-JWT"},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnprocessableEntity"},"example":{"errors":[{"message":"The country field is required.","type":"order","field":"country","severity":"validation","sub_type":"billing_address"},{"message":"The country code field is required.","type":"order","field":"country_code","severity":"validation","sub_type":"billing_address"}]}}}}}},"get":{"summary":"Get Billing Address","operationId":"GetBillingAddress","tags":["Addresses"],"description":"Get the billing address on the order.","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"address":{"$ref":"#/components/schemas/Address"},"application_state":{"$ref":"#/components/schemas/ApplicationState"}}}}}}},"description":""},"201":{"description":"Created"},"401":{"$ref":"#/components/responses/Unauthorized-JWT"}}},"put":{"summary":"Update Billing Address","operationId":"UpdateBillingAddress","tags":["Addresses"],"description":"Updates the billing address on the order.\\n\\nThis endpoint updates all fields of the billing address associated with the order, and any value left blank in this request body will be made blank in the updated address. The fields `country`, `country_code`, `province`, and `province_code` cannot be left blank.\\n\\n> **Note:** Checkout admin settings can override schema requirements for `phone_number` and `business_name`. If `phone_number` or `business_name` are set to `required` in the [Bold Checkout admin](https://apps.boldapps.net/accounts/app/4), they are also `required` in this endpoint.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Address"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"address":{"$ref":"#/components/schemas/Address"},"application_state":{"$ref":"#/components/schemas/ApplicationState"}}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized-JWT"},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnprocessableEntity"},"example":{"errors":[{"message":"The country field is required.","type":"order","field":"country","severity":"validation","sub_type":"billing_address"},{"message":"The country code field is required.","type":"order","field":"country_code","severity":"validation","sub_type":"billing_address"}]}}}}}},"delete":{"summary":"Delete Billing Address","operationId":"DeleteBillingAddress","tags":["Addresses"],"description":"Clears the billing address from the order.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"application_state":{"$ref":"#/components/schemas/ApplicationState"}}}}},"examples":{"DeletedBillingAddress":{"$ref":"#/components/examples/DeletedBillingAddress"}}}}},"401":{"$ref":"#/components/responses/Unauthorized-JWT"}}}},"/checkout/storefront/{shop_identifier}/{public_order_id}/validate_address":{"parameters":[{"$ref":"#/components/parameters/shop_identifier"},{"$ref":"#/components/parameters/public_order_id"}],"get":{"summary":"Validate Address","operationId":"ValidateAddress","tags":["Addresses"],"description":"Validates if the given postal code matches up with postal codes from Canada, US, Ireland, Great Britain, France or Singapore. This endpoint also validates the state/province provided, if required by country. Countries that require a state/province in their address are listed in the [Country and Province/State Requirements reference](/guides/checkout/references/country-province-requirements).\\n\\nCalls to the [Set Shipping Address](checkout#operation/SetShippingAddress), [Set Billing Address](checkout#operation/SetBillingAddress), [Update Shipping Address](checkout#operation/UpdateShippingAddress), or [Update Billing Address](checkout#operation/UpdateBillingAddress) endpoints apply the same validations applied by this endpoint.\\n\\nCalling this endpoint does not change the application state or apply the address. While not required, it can be helpful to call this endpoint before setting or updating an address on an order, especially if you want to implement custom error handling in more complicated address scenarios.\\n\\n> **Note:** Checkout admin settings can override schema requirements for `phone_number` and `business_name`. If `phone_number` or `business_name` are set to `required` in the [Bold Checkout admin](https://apps.boldapps.net/accounts/app/4), they are also `required` in this endpoint.\\n","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Address"}}}},"responses":{"200":{"description":"Address is valid","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","minItems":0,"maxItems":0,"items":{"type":"string"}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized-JWT"},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnprocessableEntity"},"examples":{"example-1":{"value":{"errors":[{"message":"The country code field is required.","type":"address","field":"country_code","severity":"validation","sub_type":""},{"message":"The postal code field is required.","type":"address","field":"postal_code","severity":"validation","sub_type":""},{"message":"The province field is required.","type":"address","field":"province","severity":"validation","sub_type":""}]}}}}}}}}},"/checkout/storefront/{shop_identifier}/{public_order_id}/customer/guest":{"parameters":[{"$ref":"#/components/parameters/shop_identifier"},{"$ref":"#/components/parameters/public_order_id"}],"post":{"summary":"Create Guest Customer","operationId":"CreateGuestCustomer","tags":["Customers"],"description":"Creates a new guest customer and associates it with the order.\\n\\nYou cannot create a new guest customer when there is already one on the order.\\n\\nTo add a new guest customer to an order or add an authenticated customer, you must first delete the existing customer using the [Delete Customer](checkout#operation/DeleteCustomer) endpoint.","requestBody":{"$ref":"#/components/requestBodies/CustomerBody"},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"customer":{"$ref":"#/components/schemas/Customer"},"application_state":{"$ref":"#/components/schemas/ApplicationState"}}}}},"examples":{"GuestCustomer":{"$ref":"#/components/examples/GuestCustomer"}}}}},"401":{"$ref":"#/components/responses/Unauthorized-JWT"},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnprocessableEntity"},"example":{"errors":[{"message":"The country field is required.","type":"order","field":"country","severity":"validation","sub_type":"billing_address"}]}}}}}},"put":{"summary":"Update Guest Customer","operationId":"UpdateGuestCustomer","tags":["Customers"],"deprecated":true,"description":"> **Note:** This endpoint is deprecated. Instead, use the [Update Customer](checkout#operation/UpdateCustomer) endpoint to make edits to the customer on the order.\\n\\nUpdates the guest customer on the order.\\n\\nCannot update customer data that was provided from the [Initialize Order](orders#operation/InitializeOrder) endpoint.","requestBody":{"$ref":"#/components/requestBodies/CustomerBody"},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"customer":{"$ref":"#/components/schemas/Customer"},"application_state":{"$ref":"#/components/schemas/ApplicationState"}}}}},"examples":{"GuestCustomer":{"$ref":"#/components/examples/GuestCustomer"}}}}},"401":{"$ref":"#/components/responses/Unauthorized-JWT"},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnprocessableEntity"},"example":{"errors":[{"message":"The email address field is required.","type":"order","field":"email_address","severity":"validation","sub_type":"customer"}]}}}}}}},"/checkout/storefront/{shop_identifier}/{public_order_id}/customer":{"parameters":[{"$ref":"#/components/parameters/shop_identifier"},{"$ref":"#/components/parameters/public_order_id"}],"put":{"summary":"Update Customer","operationId":"UpdateCustomer","description":"Updates the customer on the order.\\nThis endpoint does not update the `platform_id`, `public_id`, or `saved_addresses` fields.\\nYou can add customers to the order via the [Initialize Order](orders#operation/InitializeOrder), the [Create Authenticated Customer](orders#operation/CreateAuthenticatedCustomer) and the [Create Guest Customer](checkout#operation/CreateGuestCustomer) endpoints.","requestBody":{"$ref":"#/components/requestBodies/CustomerBody"},"tags":["Customers"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"customer":{"$ref":"#/components/schemas/Customer"},"application_state":{"$ref":"#/components/schemas/ApplicationState"}}}}},"examples":{"GuestCustomer":{"$ref":"#/components/examples/GuestCustomer"}}}}},"401":{"$ref":"#/components/responses/Unauthorized-JWT"},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnprocessableEntity"},"example":{"errors":[{"message":"The email address field is required.","type":"order","field":"email_address","severity":"validation","sub_type":"customer"}]}}}}}},"get":{"summary":"Get Customer","operationId":"GetCustomer","tags":["Customers"],"description":"Retrieves information about the customer on the order.","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"customer":{"$ref":"#/components/schemas/Customer"},"application_state":{"$ref":"#/components/schemas/ApplicationState"}}}}}}},"description":""},"401":{"$ref":"#/components/responses/Unauthorized-JWT"}}},"delete":{"summary":"Delete Customer","operationId":"DeleteCustomer","tags":["Customers"],"description":"Deletes the customer from the order.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"application_state":{"$ref":"#/components/schemas/ApplicationState"}}}}},"examples":{"DeletedCustomer":{"$ref":"#/components/examples/NoCustomer"}}}}},"401":{"$ref":"#/components/responses/Unauthorized-JWT"}}}},"/checkout/storefront/{shop_identifier}/{public_order_id}/validate_email_address":{"parameters":[{"$ref":"#/components/parameters/shop_identifier"},{"$ref":"#/components/parameters/public_order_id"}],"get":{"summary":"Validate Email Address","operationId":"ValidateEmailAddress","tags":["Customers"],"description":"Validates the email address and performs an MX check to make sure the domain can accept email.\\n\\nNote that this endpoint does _not_ validate that the the email address exists on the domain.","parameters":[{"schema":{"type":"string","example":"john.doe@example.com"},"in":"query","name":"email_address","required":true,"description":"The email address to be validated."}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","minItems":0,"maxItems":0,"items":{"type":"string"}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized-JWT"},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnprocessableEntity"},"example":{"errors":[{"message":"Email format is invalid.","type":"validation","field":"email","severity":"validation","sub_type":"email"},{"message":"Email is required.","type":"validation","field":"email","severity":"validation","sub_type":"email"}]}}}}}}},"/checkout/storefront/{shop_identifier}/{public_order_id}/shipping_lines":{"parameters":[{"$ref":"#/components/parameters/shop_identifier"},{"$ref":"#/components/parameters/public_order_id"}],"post":{"summary":"Set Shipping Line","operationId":"SetShippingLine","tags":["Shipping Lines"],"description":"Sets the shipping line to one of the available shipping lines on the order. Shipping lines can only be set by index and cannot be set directly.\\n\\nUse the [Bold Checkout admin](https://apps.boldapps.net/accounts/app/4) to create and configure shipping lines for your store.\\n\\n> **Note:** Checkout admin settings can override schema representation for shipping lines. If \\"Default Shipping Option\\" is set to `Least`/`Most expensive first` in the [Bold Checkout admin](https://apps.boldapps.net/accounts/app/4), the shipping lines returned in this endpoint are ordered according to that setting.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"index":{"type":"string","description":"The index of a shipping line. Find the desired shipping line index using the [List Shipping Lines](checkout#operation/ListShippingLines) endpoint."}}},"example":{"index":"0"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"selected_shipping":{"$ref":"#/components/schemas/ShippingLine"},"application_state":{"$ref":"#/components/schemas/ApplicationState"}}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized-JWT"},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnprocessableEntity"},"example":{"errors":[{"message":"The index field is required.","type":"order","field":"index","severity":"validation","sub_type":"index"}]}}}}}},"get":{"summary":"List Shipping Lines","operationId":"ListShippingLines","tags":["Shipping Lines"],"description":"Retrieves the shipping lines configured on the store.\\n\\nUse the [Bold Checkout admin](https://apps.boldapps.net/accounts/app/4) to create and configure shipping lines for your store.\\n\\n> **Note:** Checkout admin settings can override schema representation for shipping lines. If \\"Default Shipping Option\\" is set to `Least`/`Most expensive first` in the [Bold Checkout admin](https://apps.boldapps.net/accounts/app/4), the shipping lines returned in this endpoint are ordered according to that setting.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"shipping_lines":{"type":"array","items":{"$ref":"#/components/schemas/ShippingLine"}},"application_state":{"$ref":"#/components/schemas/ApplicationState"}}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized-JWT"},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnprocessableEntity"}}}}}}},"/checkout/storefront/{shop_identifier}/{public_order_id}/shipping_lines/estimate":{"parameters":[{"$ref":"#/components/parameters/shop_identifier"},{"$ref":"#/components/parameters/public_order_id"}],"post":{"summary":"Estimate Shipping Line","operationId":"EstimateShippingLine","tags":["Shipping Lines"],"description":"Generates an estimate for the order\'s shipping line and shipping cost based on the shipping address provided.\\n\\nBased on the address provided, this endpoint adds a `shipping_address` and an additional entry in the `available_shipping_lines` array. It does not, however, select that shipping line for the order.\\n\\n> **Note:** This endpoint is only supported on stores that use a [Remote State Authority (RSA)](/guides/platform-connector/rsa/create-checkout-rsa). With RSA set up, this endpoint triggers the `estimate_shipping` event.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Estimate"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"shipping_lines":{"$ref":"#/components/schemas/ShippingLine"},"application_state":{"$ref":"#/components/schemas/ApplicationState"}}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized-JWT"},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnprocessableEntity"},"example":{"errors":[{"message":"The index field is required.","type":"order","field":"index","severity":"validation","sub_type":"index"}]}}}}}}},"/checkout/storefront/{shop_identifier}/{public_order_id}/taxes":{"parameters":[{"$ref":"#/components/parameters/shop_identifier"},{"$ref":"#/components/parameters/public_order_id"}],"post":{"summary":"Generate Taxes","operationId":"GenerateTaxes","tags":["Taxes"],"description":"Calculates and applies taxes to the order. Calculated taxes must be present in the `application_state` before you call the [Process Order](checkout#operation/ProcessOrder) endpoint. Otherwise, the API returns an error and does not process the order.\\n\\nBefore calling this endpoint, configure your store\'s tax settings in the [Bold Checkout admin](https://apps.boldapps.net/accounts/app/4), including tax zones, the tax provider, and whether the price of shipping should be taxed.\\n\\nTaxes are calculated for each line item, for the shipping (if applicable), and for the whole order \u2014 the returned `application_state` reflects all of these calculations.\\n\\nTaxes are not automatically recalculated, so you must call this endpoint after you make any changes to the shipping address. Bold recommends calling this endpoint after calling the [Set Shipping Line](checkout#operation/SetShippingLine) endpoint.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"taxes":{"type":"array","items":{"$ref":"#/components/schemas/Tax"}},"application_state":{"$ref":"#/components/schemas/ApplicationState"}}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized-JWT"},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnprocessableEntity"}}}}}}},"/checkout/storefront/{shop_identifier}/{public_order_id}/taxes/estimate":{"parameters":[{"$ref":"#/components/parameters/shop_identifier"},{"$ref":"#/components/parameters/public_order_id"}],"post":{"summary":"Estimate Taxes","operationId":"EstimateTaxes","tags":["Taxes"],"description":"Generates an estimate for the order\'s taxes. For an accurate calculation, provide the shipping address in the request body.\\n\\nThis endpoint adds the shipping address to the application state but does **NOT** apply the estimated tax calculation to the order.\\n\\n> **Note:** This endpoint is only supported on stores that use a [Remote State Authority (RSA)](/guides/platform-connector/rsa/create-checkout-rsa). With RSA set up, this endpoint triggers the `estimate_tax` event.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Estimate"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"taxes":{"type":"array","items":{"$ref":"#/components/schemas/Tax"}},"application_state":{"$ref":"#/components/schemas/ApplicationState"}}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized-JWT"},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnprocessableEntity"}}}}}}},"/checkout/storefront/{shop_identifier}/{public_order_id}/items":{"parameters":[{"$ref":"#/components/parameters/shop_identifier"},{"$ref":"#/components/parameters/public_order_id"}],"post":{"summary":"Add Line Item","operationId":"AddLineItem","tags":["Line Items"],"description":"Adds a new line item to the order.\\n\\nOnly products that have already been synced to Checkout can be added from the frontend. One of either the `sku` or the `platform_id` is required.\\n\\nThis endpoint can also add a gift card to an order.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CartItem"},"examples":{"CartItem":{"$ref":"#/components/examples/CartItem"},"GiftCardCartItem":{"$ref":"#/components/examples/CartItemGiftCard"}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"line_items":{"type":"array","items":{"$ref":"#/components/schemas/LineItem"}},"application_state":{"$ref":"#/components/schemas/ApplicationState"}}}}},"examples":{"CartItemResponse":{"$ref":"#/components/examples/CartItemResponse"},"GiftCardResponse":{"$ref":"#/components/examples/GiftCardLineItem"}}}}},"401":{"$ref":"#/components/responses/Unauthorized-JWT"},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnprocessableEntity"},"example":{"errors":[{"message":"The line item key field is required.","type":"item","field":"line_item_key","severity":"validation","sub_type":"customer"}]}}}}}},"get":{"summary":"List Line Items","operationId":"ListLineItems","tags":["Line Items"],"description":"Retrieves a list of all the items on the order. This endpoint returns the `product_data` for each line item on the order.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"line_items":{"type":"array","items":{"$ref":"#/components/schemas/LineItem"}},"application_state":{"$ref":"#/components/schemas/ApplicationState"}}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized-JWT"}}},"put":{"summary":"Update Line Item Quantity","operationId":"UpdateLineItemQuantity","tags":["Line Items"],"description":"Updates the quantity of the line item on the order. Refer to the line to be updated by `line_item_key`.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CartItem"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"line_item":{"$ref":"#/components/schemas/LineItem"},"application_state":{"$ref":"#/components/schemas/ApplicationState"}}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized-JWT"},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnprocessableEntity"},"example":{"errors":[{"message":"The quantity field is required.","type":"item","field":"quantity","severity":"validation","sub_type":"customer"}]}}}}}},"delete":{"summary":"Delete Line Item","operationId":"DeleteLineItem","tags":["Line Items"],"description":"Removes a line item from an order. Refer to the line to remove by `line_item_key`.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CartItem"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"line_items":{"type":"array","items":{"$ref":"#/components/schemas/LineItem"}},"application_state":{"$ref":"#/components/schemas/ApplicationState"}}}}},"examples":{"DeletedLineItem":{"$ref":"#/components/examples/DeletedLineItem"}}}}},"401":{"$ref":"#/components/responses/Unauthorized-JWT"},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnprocessableEntity"},"example":{"errors":[{"message":"The line item key field is required.","type":"item","field":"line_item_key","severity":"validation","sub_type":"customer"}]}}}}}}},"/checkout/storefront/{shop_identifier}/{public_order_id}/payments":{"parameters":[{"$ref":"#/components/parameters/shop_identifier"},{"$ref":"#/components/parameters/public_order_id"}],"post":{"summary":"Create Payment","operationId":"CreatePayment","tags":["Payments"],"description":"Adds a new payment to the order.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"payment":{"$ref":"#/components/schemas/Payment"},"application_state":{"$ref":"#/components/schemas/ApplicationState"}}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized-JWT"},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnprocessableEntity"},"examples":{"example-1":{"value":{"message":"The gateway public id field is required.","type":"order","field":"gateway_public_id","severity":"validation","sub_type":"payment"}}}}}}},"requestBody":{"description":"The payment `gateway_public_id` tells Bold Checkout which payment gateway to use and is therefore required. The `token` key is also required.\\n\\nThe `amount` is optional. If this value is left empty, Bold Checkout sets the payment amount to the order total or to the maximum value that the payment method supports (e.g., for a gift card payment).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Payment"}}}}},"get":{"summary":"List Payments","operationId":"ListPayments","tags":["Payments"],"description":"Lists the payments that have been applied to the order.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"payments":{"type":"array","items":{"$ref":"#/components/schemas/Payment"}},"application_state":{"$ref":"#/components/schemas/ApplicationState"}}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized-JWT"}}},"put":{"summary":"Update Payment","operationId":"UpdatePayment","tags":["Payments"],"description":"Updates the value of the payment. Only the amount of payment can be changed.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"payment":{"$ref":"#/components/schemas/Payment"},"application_state":{"$ref":"#/components/schemas/ApplicationState"}}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized-JWT"},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnprocessableEntity"},"examples":{"example-1":{"value":{"message":"The gateway public id field is required.","type":"order","field":"gateway_public_id","severity":"validation","sub_type":"payment"}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Payment"}}}}},"delete":{"summary":"Remove Payment","operationId":"RemovePayment","tags":["Payments"],"description":"Removes the payment by token.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"application_state":{"$ref":"#/components/schemas/ApplicationState"}}}}},"examples":{"DeletedPayment":{"$ref":"#/components/examples/DeletedPayment"}}}}},"401":{"$ref":"#/components/responses/Unauthorized-JWT"},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnprocessableEntity"},"examples":{"example-1":{"value":{"message":"The gateway public id field is required.","type":"order","field":"gateway_public_id","severity":"validation","sub_type":"payment"}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Payment"}}}}}},"/checkout/storefront/{shop_identifier}/{public_order_id}/payments/gift_card":{"parameters":[{"$ref":"#/components/parameters/shop_identifier"},{"$ref":"#/components/parameters/public_order_id"}],"delete":{"summary":"Remove Gift Card Payment","operationId":"RemoveGiftCardPayment","tags":["Payments"],"description":"Removes a gift card payment by ID.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"application_state":{"$ref":"#/components/schemas/ApplicationState"}}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized-JWT"},"404":{"$ref":"#/components/responses/GiftCardNotFound"},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnprocessableEntity"},"examples":{"example-1":{"value":{"message":"The public order id field is required.","type":"order","field":"public_order_id","severity":"validation","sub_type":"payment"}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/GiftCardPaymentId"}}}}}}}},"/checkout/storefront/{shop_identifier}/{public_order_id}/payments/styles":{"parameters":[{"$ref":"#/components/parameters/shop_identifier"},{"$ref":"#/components/parameters/public_order_id"}],"post":{"summary":"Create CSS Styling for SPI","operationId":"CreateCSSStylingForSPI","tags":["Payment Iframes"],"description":"Use this endpoint to style the [Secure Payments Interface (SPI)](/guides/checkout/resources/glossary#secure-payments-interface-spi) using CSS and media queries _for a single order_.\\n\\nAfter calling this endpoint, you must update the SPI iframe with the new styling. Use the [Update Media Match Action](/guides/checkout/references/checkout-spi-api#update-media-match-action) to send the new styling to your SPI event listener.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"style_sheet":{"$ref":"#/components/schemas/PaymentStylesheet"}}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized-JWT"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentStylesheet"}}}}}},"/checkout/storefront/{shop_identifier}/{public_order_id}/process_order":{"parameters":[{"$ref":"#/components/parameters/shop_identifier"},{"$ref":"#/components/parameters/public_order_id"}],"post":{"summary":"Process Order","operationId":"ProcessOrder","tags":["Orders"],"description":"Triggers the backend processing of the order.\\n\\nBefore processing the order, Bold completes a series of checks to ensure taxes are calculated and the order contains payments that equal the order total.\\n\\nDuring processing, Bold completes the following steps:\\n  - Taxes are calculated and present on order.\\n  - Verify that inventory is adequate to fulfill the order (optional, based on platform settings).\\n  - Pre-authorize any pending payments.\\n  - Finalize and apply discounts.\\n\\nIf these steps complete successfully, this endpoint returns a success message.\\n\\nOnce order processing is complete, Bold asynchronously pushes each order to the platform and charges authorized payments.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"application_state":{"$ref":"#/components/schemas/ApplicationState"}}}}}}}},"202":{"description":"Order is valid but requires Strong Customer Authentication (SCA) verification before being processed. Once the order is authenticated, re-submit this request.","content":{"application/json":{"schema":{"type":"object"},"examples":{"SCA Required":{"value":{"handleSCA":true}}}}}},"401":{"$ref":"#/components/responses/Unauthorized-JWT"},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnprocessableEntity"},"examples":{"Not Shop Found":{"value":{"message":"No Checkout shop found","type":"order","field":"public_order_id","severity":"critical","sub_type":"public_order_id"}},"No Customer":{"value":{"message":"No customer exists for the order","type":"order","field":"customer","severity":"validation","sub_type":"customer"}},"Empty Cart":{"value":{"message":"The order is empty","type":"order","field":"cart","severity":"validation","sub_type":"cart"}},"Unable to calculate tax":{"value":{"message":"There was an error calculating the taxes","type":"order","field":"tax","severity":"validation","sub_type":"tax"}},"Items out of stock":{"value":{"message":"Insufficient stock","type":"order","field":"inventory","severity":"validation","sub_type":"insufficient_stock"}},"Pre-auth Failed":{"value":{"message":"Payment pre-auth failed","type":"order","field":"payment","severity":"validation","sub_type":"payment"}},"Unknown":{"value":{"message":"Unable to process order for an unknown reason","type":"order","field":"public_order_id","severity":"order","sub_type":"public_order_id"}}}}}}}}},"/checkout/storefront/{shop_identifier}/{public_order_id}/pre_process_order":{"parameters":[{"$ref":"#/components/parameters/shop_identifier"},{"$ref":"#/components/parameters/public_order_id"}],"post":{"summary":"Pre-Process Order","operationId":"PreProcessOrder","tags":["Orders"],"description":"Prompts Bold Checkout to execute all the checks required before processing an order, without actually completing the order processing.\\n\\nThese steps include an inventory check, order validation and payment authorization. For a full list, refer to the [Process Order](checkout#operation/ProcessOrder) description.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"application_state":{"$ref":"#/components/schemas/ApplicationState"}}}}}}}},"202":{"description":"Order is valid but requires Strong Customer Authentication (SCA) verification before being processed. Once the order is authenticated, re-submit this request.","content":{"application/json":{"schema":{"type":"object"},"examples":{"SCA Required":{"value":{"handleSCA":true}}}}}},"401":{"$ref":"#/components/responses/Unauthorized-JWT"},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnprocessableEntity"},"examples":{"No Shop Found":{"value":{"message":"No Bold Checkout shop found.","type":"order","field":"public_order_id","severity":"critical","sub_type":"public_order_id"}},"No Customer":{"value":{"message":"No customer exists for the order.","type":"order","field":"customer","severity":"validation","sub_type":"customer"}},"Empty Cart":{"value":{"message":"The order is empty.","type":"order","field":"cart","severity":"validation","sub_type":"cart"}},"Unable to calculate tax":{"value":{"message":"There was an error calculating the taxes.","type":"order","field":"tax","severity":"validation","sub_type":"tax"}},"Items out of stock":{"value":{"message":"Insufficient stock.","type":"order","field":"inventory","severity":"validation","sub_type":"insufficient_stock"}},"Pre-auth Failed":{"value":{"message":"Payment pre-auth failed.","type":"order","field":"payment","severity":"validation","sub_type":"payment"}},"Unknown":{"value":{"message":"Unable to pre-process order for an unknown reason.","type":"order","field":"public_order_id","severity":"order","sub_type":"public_order_id"}}}}}}}}},"/checkout/storefront/{shop_identifier}/{public_order_id}/handle_amendment":{"parameters":[{"$ref":"#/components/parameters/shop_identifier"},{"$ref":"#/components/parameters/public_order_id"}],"post":{"summary":"Handle Amendment","operationId":"HandleAmendment","tags":["Orders"],"description":"Prompts Bold Checkout to handle any amendments that have been made to the order, such as product upsells and other pre-processing order adjustments.\\n\\nBold re-checks the order for an outstanding balance. If one exists, Bold copies the existing payment on the order and creates a separate authorization.\\n\\n> **Note:** If the order value has changed, `handle_amendment` can only add and authorize the required additional payment if:\\n>  * There is only one payment method on the order.\\n>  * That payment is either a credit card or PayPal payment.\\n>  * The gateway used to process that payment is **not** PayPal Complete Payments.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"application_state":{"$ref":"#/components/schemas/ApplicationState"}}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized-JWT"},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"No Shop Found":{"value":{"message":"No Checkout shop found.","type":"order","field":"public_order_id","severity":"critical","sub_type":"public_order_id"}},"Auth Declined":{"value":{"message":"Card declined.","type":"order_amendment_failed.order_authorization_failed","code":"02-22"}},"Multiple Payments":{"value":{"message":"Multiple payment methods found.","type":"order_amendment_failed.payment_method_not_found","code":"02-00"}},"No Payments":{"value":{"message":"No valid payment method found.","type":"order_amendment_failed.payment_method_not_found","code":"02-00"}}}}}}}}},"/checkout/storefront/{shop_identifier}/{public_order_id}/refresh":{"parameters":[{"$ref":"#/components/parameters/shop_identifier"},{"$ref":"#/components/parameters/public_order_id"}],"get":{"summary":"Get Application State","operationId":"GetApplicationState","tags":["Orders"],"description":"Gets a refreshed copy of the application state. Useful if there are other plugins or applications that might be interacting with the order.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"application_state":{"$ref":"#/components/schemas/ApplicationState"}}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized-JWT"}}}},"/checkout/storefront/{shop_identifier}/{public_order_id}/discounts":{"parameters":[{"$ref":"#/components/parameters/shop_identifier"},{"$ref":"#/components/parameters/public_order_id"}],"post":{"summary":"Add Discount Code","operationId":"AddDiscountCode","tags":["Discounts"],"description":"Applies a discount code to the current order.\\n\\nThis endpoint applies an order-level discount code with a `source` of `coupon`. Each order may have only one `coupon` discount. If you attempt to add more than one, this endpoint returns an error, and the second discount code is not added.\\n\\nTo add a discount code at the line item level, refer to the [discount_line_items](/guides/checkout/references/plugin-actions#discount_line_items) plugin action.\\n\\n> **Note:** This endpoint does not create a new discount code. New discount codes can be created in the [Bold Checkout admin](https://support.boldcommerce.com/hc/en-us/search?utf8=%E2%9C%93&query=discount+codes).","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"The discount code.","example":"FREESHIPPING"}},"required":["code"]}}}},"responses":{"200":{"description":"Discount successfully applied","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"discount":{"$ref":"#/components/schemas/Discount"},"application_state":{"$ref":"#/components/schemas/ApplicationState"}}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized-JWT"},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnprocessableEntity"},"examples":{"CouldNotFind":{"value":{"errors":[{"message":"Could not find Discount: TESTCODE","type":"order","field":"discounts","severity":"validation","sub_type":"discounts"}]}},"MissingRequiredField":{"value":{"errors":[{"message":"The discount code field is required.","type":"authorization","field":"discount_code","severity":"validation","sub_type":""}]}}}}}}}},"get":{"summary":"List Discount Codes","operationId":"ListDiscountCodes","tags":["Discounts"],"description":"Retrieves all discount codes applied to the order, shipping, or individual line items, if applicable. If the order is not discounted, the endpoint returns an empty `discounts` array.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"discounts":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/LineItemDiscount"},{"$ref":"#/components/schemas/Discount"}]}},"application_state":{"$ref":"#/components/schemas/ApplicationState"}}}}},"examples":{"ListDiscountCodes":{"$ref":"#/components/examples/ListDiscounts"}}}}},"401":{"$ref":"#/components/responses/Unauthorized-JWT"}}},"delete":{"summary":"Delete Discount Code","operationId":"DeleteDiscountCode","tags":["Discounts"],"description":"Removes the discount code and its discounts from the order.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"The discount code.","example":"FREESHIPPING"}},"required":["code"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"application_state":{"$ref":"#/components/schemas/ApplicationState"}}}}},"examples":{"DeletedDiscountCode":{"$ref":"#/components/examples/DeletedDiscount"}}}}},"401":{"$ref":"#/components/responses/Unauthorized-JWT"},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnprocessableEntity"},"example":{"errors":[{"message":"Discount code is not applied to the order.","type":"order","field":"discounts","severity":"validation","sub_type":"discounts"},{"message":"The code field is required.","type":"authorization","field":"code","severity":"validation","sub_type":""}]}}}}}}},"/checkout/storefront/{shop_identifier}/{public_order_id}/validate_discount_code":{"parameters":[{"$ref":"#/components/parameters/shop_identifier"},{"$ref":"#/components/parameters/public_order_id"}],"get":{"summary":"Validate Discount Code","operationId":"ValidateDiscountCode","tags":["Discounts"],"description":"Validates the given discount code against the current order state and shop settings. Calling this endpoint does _not_ change the application state or apply the discount.\\n\\nIt is not required to call this endpoint before calling the [Add Discount Code](checkout#operation/AddDiscountCode) endpoint, but it can be helpful if you want to implement custom error handling in more complicated discount code scenarios.\\n\\nFor more information about discount validation, refer to [Validate Discount Codes](/guides/checkout/validate-discounts).","parameters":[{"schema":{"type":"string","example":"TESTCODE"},"in":"query","name":"discount_code","description":"The discount code to be validated.","required":true}],"responses":{"200":{"description":"Discount code is valid","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object"}}}}}},"401":{"$ref":"#/components/responses/Unauthorized-JWT"},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnprocessableEntity"},"examples":{"CouldNotFind":{"value":{"errors":[{"message":"Could not find Discount: TESTCODE","type":"order","field":"discounts","severity":"validation","sub_type":"discounts"}]}},"MissingRequiredField":{"value":{"errors":[{"message":"The discount code field is required.","type":"authorization","field":"discount_code","severity":"validation","sub_type":""}]}}}}}}}}},"/checkout/storefront/{shop_identifier}/{public_order_id}/meta_data":{"parameters":[{"$ref":"#/components/parameters/shop_identifier"},{"$ref":"#/components/parameters/public_order_id"}],"patch":{"summary":"Append Order Metadata","operationId":"AppendOrderMetadata","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"order_meta_data":{"$ref":"#/components/schemas/OrderMetaData"},"application_state":{"$ref":"#/components/schemas/ApplicationState"}}}}},"examples":{"200-response":{"value":{"data":{"order_meta_data":{"cart_parameters":{"cp-key1":"A cart param","cp-key2":"Another cart param"},"note_attributes":{"na-key1":"A note attribute","na-key2":"Another note attribute"},"notes":"A different delivery instruction.","tags":["order-1","order-1-other","order-1-alone"]},"application_state":{"customer":{"platform_id":null,"public_id":null,"first_name":"","last_name":"","email_address":"","saved_addresses":[]},"addresses":{"shipping":null,"billing":null},"line_items":[],"fees":[],"taxes":[],"discounts":[],"payments":[],"shipping":{"selected_shipping":null,"available_shipping_lines":[],"taxes":0,"discounts":0},"order_meta_data":{"cart_parameters":{"cp-key1":"A cart param","cp-key2":"Another cart param"},"note_attributes":{"na-key1":"A note attribute","na-key2":"Another note attribute"},"tags":["order-1","order-1-other","order-1-alone"]},"is_processed":false}}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized-JWT"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderMetaData"},"examples":{"append-all":{"value":{"cart_parameters":{"cp-key2":"Another cart param"},"note_attributes":{"na-key2":"Another note attribute"},"notes":"A different delivery instruction.","tags":["order-1-other"]}},"append-single-metadata":{"value":{"tags":["order-1-alone"]}}}}}},"description":"Append to any of the metadata attached to an order.","tags":["Metadata"]},"delete":{"summary":"Clear Order Metadata","operationId":"ClearOrderMetadata","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ApplicationState"}}}}}},"401":{"$ref":"#/components/responses/Unauthorized-JWT"}},"description":"Clears the order of all the metadata.","tags":["Metadata"]},"get":{"summary":"List Order Metadata","operationId":"ListOrderMetadata","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"order_meta_data":{"$ref":"#/components/schemas/OrderMetaData"},"application_state":{"$ref":"#/components/schemas/ApplicationState"}}}}},"examples":{"200-response":{"value":{"data":{"order_meta_data":{"cart_parameters":{"cp-key1":"A cart param"},"note_attributes":{"na-key1":"A note attribute"},"notes":"Special delivery instruction.","tags":["order-1"]},"application_state":{"customer":{"platform_id":null,"public_id":null,"first_name":"","last_name":"","email_address":"","accepts_marketing":false,"saved_addresses":[]},"addresses":{"shipping":[],"billing":[]},"line_items":[],"fees":[],"taxes":[],"discounts":[],"payments":[],"shipping":{"selected_shipping":null,"available_shipping_lines":[],"taxes":0,"discounts":0},"order_meta_data":{"cart_parameters":{"cp-key1":"A cart param"},"note_attributes":{"na-key1":"A note attribute"},"tags":["order-1"]},"is_processed":false}}}},"empty-meta-data":{"value":{"data":{"order_meta_data":{"cart_parameters":{},"note_attributes":{},"notes":"","tags":[]},"application_state":{"customer":{"platform_id":null,"public_id":null,"first_name":"","last_name":"","email_address":"","accepts_marketing":false,"saved_addresses":[]},"addresses":{"shipping":[],"billing":[]},"line_items":[],"fees":[],"taxes":[],"discounts":[],"payments":[],"shipping":{"selected_shipping":null,"available_shipping_lines":[],"taxes":0,"discounts":0},"order_meta_data":{"cart_parameters":{},"note_attributes":{},"notes":"","tags":[]},"is_processed":false}}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized-JWT"}},"description":"List All the Metadata Attached to an Order.","tags":["Metadata"]},"post":{"summary":"Overwrite Order Metadata","operationId":"OverwriteOrderMetadata","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"order_meta_data":{"$ref":"#/components/schemas/OrderMetaData"},"application_state":{"$ref":"#/components/schemas/ApplicationState"}}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized-JWT"},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnprocessableEntity"},"examples":{"example-1":{"value":{"message":"validation.required","type":"meta_data","field":"cart_parameters","severity":"validation","sub_type":""}}}}}}},"description":"Add Metadata to an Order. ","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderMetaData"},"examples":{"add-metadata":{"value":{"cart_parameters":{"cp-key1":"A cart param"},"note_attributes":{"na-key1":"A note attribute"},"notes":"Special delivery instruction.","tags":["order-1"]}}}}},"description":"Any existing metadata will be overwritten by the values provided in this request."},"tags":["Metadata"]}},"/checkout/storefront/{shop_identifier}/{public_order_id}/app_hook":{"parameters":[{"$ref":"#/components/parameters/shop_identifier"},{"$ref":"#/components/parameters/public_order_id"}],"post":{"summary":"Dispatch App Hook Event","operationId":"DispatchAppHookEvent","tags":["Orders"],"description":"Dispatches the `app_hook` plugin event to the plugin with the matching client ID provided in the request (given this plugin is registered for the `app_hook` event). For more information about the `app_hook` event, refer to [Create Custom Events with App Hooks](/guides/checkout/plugins/app-hooks).\\n\\nThe plugin processes the request, and returns a response that indicates the actions to be executed by Checkout. Checkout completes these actions, and this endpoint then returns an up-to-date version of the `application_state`.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"uuid":{"type":"string","description":"The unique identifier of the plugin that is expected to receive the `app_hook` event. The client ID was sent to the developer upon creation of the plugin."},"hook":{"type":"string","description":"The name of the `app_hook` event to send to the plugin."},"app_hook_data":{"type":"object","description":"Data that will be provided as part of the `app_hook` plugin Event payload."}},"required":["uuid","hook"]},"examples":{"Example request":{"$ref":"#/components/examples/addPaymentAppHook"}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"application_state":{"$ref":"#/components/schemas/ApplicationState"}}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnprocessableEntity"},"examples":{"Plugin not found":{"value":{"message":"Plugin not found"}},"Missing Required Field":{"value":{"message":"The uuid field is required.","type":"order","field":"uuid","severity":"validation","sub_type":"app_hook"}}}}}}}}},"/checkout/storefront/{shop_identifier}/{public_order_id}/check_inventory":{"parameters":[{"$ref":"#/components/parameters/shop_identifier"},{"$ref":"#/components/parameters/public_order_id"}],"get":{"summary":"Check Order Inventory","operationId":"CheckOrderInventory","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"inventory_check":{"type":"object","description":"Contains the results of the inventory check.","properties":{"result":{"type":"string","enum":["pass","fail","not_enabled"],"description":"Indicates the result of the inventory check."},"failed_items":{"type":"array","items":{"type":"object","properties":{"platform_variant_id":{"type":"string","example":"77","description":"The variant\'s id on the platform."},"available_quantity":{"type":"number","description":"The number of items currently in stock."}}}},"message":{"type":"string","example":"Insufficient inventory for requested items.","description":"A message indicating the reason for a failed inventory check."}}},"application_state":{"$ref":"#/components/schemas/ApplicationState"}}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnprocessableEntity"},"examples":{"example-1":{"value":{"code":"02-50","type":"checkout.api_validation_failed","message":"Error validating request","details":{"invalid_stage":""}}}}}}}},"description":"Triggers an inventory check on the items in the cart. The check can only be performed if the store enabled inventory checks; otherwise, this endpoint returns a `not_enabled` response. Functionally, this means that Checkout may proceed as if the check had passed.\\n\\nIf the inventory check is enabled, Checkout looks for an inventory override present on the order. If one is present, Checkout calls the override endpoint and returns the results yielded by that endpoint. If no override is present, Checkout uses the inventory policy on the store platform to determine whether the items on the order are in stock. For more information about inventory overrides, refer to the [Plugin Actions Reference](/guides/checkout/references/plugin-actions#override_inventory).\\n\\nIf Checkout is able to complete the inventory check, it returns a result of either `pass` or `fail` depending on the result of the check. If the result is `fail`, Checkout also returns a list of the items that failed the check, along with their available quantities.\\n\\nIf Checkout is unable to complete the inventory check for some external reason (for example, due to a network failure), Checkout returns an error response indicating that the check could not be completed.","parameters":[{"schema":{"type":"string","enum":["initial","final"],"default":"initial"},"in":"query","name":"stage","description":"The context in which the inventory check is to be performed. Specify this value only when using an inventory override. The override provider must interpret this value, as it has no impact on Bold Checkout functionality. Allowable values are `initial` or `final`. For most use cases, the value should be `initial` to indicate that the order has not been processed. Checkout automatically performs an inventory check when an order is being processed and uses the value `final` if an inventory override is place at this time.","required":false}],"tags":["Orders"]}},"/checkout/storefront/{shop_identifier}/{public_order_id}/batch":{"parameters":[{"$ref":"#/components/parameters/shop_identifier"},{"$ref":"#/components/parameters/public_order_id"}],"post":{"summary":"Batch Process","operationId":"BatchProcess","tags":["Batch Process"],"description":"Processes a series of API calls in a single request. Sub-requests are evaluated serially. If one of the sub-requests returns an error, processing halts and any requests after the failed request are not processed.\\n\\nNot all endpoints support batch processing. For a full list of supported endpoints and additional information, refer to [Submit a Batch Processing Request](/guides/checkout/batch-processing).","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"sub_requests":{"type":"array","items":{"$ref":"#/components/schemas/SubRequest"}}}},"examples":{"BatchRequest":{"$ref":"#/components/examples/BatchRequest"}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"application_state":{"$ref":"#/components/schemas/ApplicationState"},"data":{"type":"array","items":{"$ref":"#/components/schemas/SubResponse"}}}},"examples":{"SuccessfulBatchResponse":{"$ref":"#/components/examples/SuccessfulBatchResponse"}}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UnprocessableEntity"}},"application_state":{"$ref":"#/components/schemas/ApplicationState"},"data":{"type":"array","items":{"$ref":"#/components/schemas/SubResponse"}}}},"examples":{"FailedBatchResponse":{"$ref":"#/components/examples/FailedBatchResponse"}}}}}}}},"/checkout/storefront/{shop_identifier}/{public_order_id}/wallet_pay/create_order":{"parameters":[{"$ref":"#/components/parameters/shop_identifier"},{"$ref":"#/components/parameters/public_order_id"}],"post":{"summary":"Create Wallet Pay Order","operationId":"CreateWalletPayOrder","tags":["Wallet Pay"],"description":"Triggers the creation of an order in a \\"wallet pay\\" payment gateway. Bold uses the `public_order_id` to retrieve order information, including payment data. Bold then sends the request body and additional order information to the payment gateway. The payment gateway uses the order information to create a new order on its platform, and returns the created order\'s identifier.\\n\\nThe specified payment gateway must already be configured in your Bold admin. To read more about connecting a payment gateway in Bold checkout, refer to the [Help Center](https://support.boldcommerce.com/hc/en-us/search?utf8=%E2%9C%93&query=Connect+a+Payment+Processor+to+Bold+Checkout).\\n\\n> **Note:** This endpoint does not create or update orders within Bold. To do so, use [Initialize Order](/api/orders#tag/Orders/operation/CreateOrder) or [Create Order](/api/orders#tag/Orders/operation/CreateOrder). To add or update a payment on an order, use [Create Payment](/api/checkout#tag/Payments/operation/CreatePayment) or [Update Payment](/api/checkout#tag/Payments/operation/UpdatePayment).","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"payment_data":{"type":"object","description":"The data returned from the payment gateway. The returned data varies between gateways.","oneOf":[{"$ref":"#/components/schemas/PayPalGatewayOrderResponse"}]},"application_state":{"$ref":"#/components/schemas/ApplicationState"}}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized-JWT"},"404":{"$ref":"#/components/responses/OrderNotFound"},"422":{"$ref":"#/components/responses/WalletPayUnprocessableEntity"}},"requestBody":{"description":"The data required for the order sent to the payment gateway.\\n\\nRefer to the schemas below to see the required data for each supported gateway.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentGatewayOrder"}}}}}},"/checkout/storefront/{shop_identifier}/{public_order_id}/wallet_pay/on_shipping":{"parameters":[{"$ref":"#/components/parameters/shop_identifier"},{"$ref":"#/components/parameters/public_order_id"}],"post":{"summary":"Update Shipping Address for Wallet Pay","operationId":"UpdateShippingAddressforWalletPay","tags":["Wallet Pay"],"description":"Handles a shipping address change event for wallet pay orders. Bold uses the provided shipping address from the payment gateway to calculate taxes and get the shipping lines.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"payment_data":{"type":"object","description":"The data returned from the payment gateway. The returned data varies between gateways.","oneOf":[{}]},"application_state":{"$ref":"#/components/schemas/ApplicationState"}}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized-JWT"},"404":{"$ref":"#/components/responses/OrderNotFound"},"422":{"$ref":"#/components/responses/WalletPayUnprocessableEntity"}},"requestBody":{"description":"The data required for the order sent to the payment gateway.\\n\\nRefer to the schemas below to see the required data for each supported gateway.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WalletPayOnShipping"}}}}}},"/checkout/storefront/{shop_identifier}/{public_order_id}/wallet_pay/on_approve":{"parameters":[{"$ref":"#/components/parameters/shop_identifier"},{"$ref":"#/components/parameters/public_order_id"}],"post":{"summary":"Capture Payment for Wallet Pay","operationId":"CapturePaymentforWalletPay","tags":["Wallet Pay"],"description":"Sends the payment information to the wallet pay for capture when the user authorizes the payment. Bold calls the payment gateway to get the order details and updates the customer information, shipping address, billing address, and taxes of the order.\\n\\n> **Note:** This endpoint does NOT add the payment to the order. To add a payment, use [Add Payment](/api/checkout#tag/Payments/operation/CreatePayment).","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"payment_data":{"type":"object","description":"The data returned from the payment gateway. The returned data varies between gateways.","oneOf":[{}]},"application_state":{"$ref":"#/components/schemas/ApplicationState"}}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized-JWT"},"404":{"$ref":"#/components/responses/OrderNotFound"},"422":{"$ref":"#/components/responses/WalletPayUnprocessableEntity"}},"requestBody":{"description":"The data required for the order sent to the payment gateway.\\n\\nRefer to the schemas below to see the required data for each supported gateway.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WalletPayOnApprove"}}}}}}},"components":{"securitySchemes":{"JWT":{"type":"apiKey","name":"JWT","in":"header","description":"Authenticates the API request. The expected token is a [JSON Web Token (JWT)](https://www.rfc-editor.org/rfc/rfc7519) generated during the initialization of the the order via the [Initialize Order](orders#operation/InitializeOrder) endpoint.\\n\\nOnce the JWT expires (after 60 minutes), you must generate a new JWT using the [Resume Order](orders#operation/ResumeOrder) endpoint."}},"requestBodies":{"CustomerBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"first_name":{"type":"string","description":"The customer\'s first name.","example":"John"},"last_name":{"type":"string","description":"The customer\'s last name.","example":"Doe"},"email_address":{"type":"string","description":"The customer\'s email address.","example":"john.doe@example.com"},"accepts_marketing":{"type":"boolean","description":"If the customer would like to receive any sort of marketing emails. Defaults to `false`.","default":false,"example":false}},"required":["first_name","last_name","email_address"]}}}}},"parameters":{"shop_identifier":{"schema":{"type":"string","example":"zp3oafdor9"},"name":"shop_identifier","in":"path","required":true,"description":"The identifier of the shop. Can be retrieved by making a request to the [Get Info](shops#operation/GetShopInfo) endpoint."},"public_order_id":{"schema":{"type":"string","example":"woiph4vhqss9jjr50lR5am7IWurQ8FdbmtdOj4aaFIOfFiFGcvhY6x1t6eT0GoB"},"name":"public_order_id","in":"path","required":true,"description":"The public order identifier generated when the order is initialized by making a request to the [Initialize Order](orders#operation/InitializeOrder) endpoint."}},"schemas":{"ApplicationState":{"title":"Application State","type":"object","description":"Represents the current state of the order.\\nTaxes and discounts represent the summation of all tax or discount lines that have been applied anywhere through the order. Consulting the line items allows you to get the specific product break down of taxes and discounts.","properties":{"customer":{"description":"The customer that placed the order.","oneOf":[{"$ref":"#/components/schemas/Customer"},{"type":"array","title":"No customer","maxItems":0,"items":{"type":"string"}}]},"addresses":{"type":"object","description":"The billing and shipping addresses on the order.","properties":{"shipping":{"description":"The shipping address on the order.","oneOf":[{"$ref":"#/components/schemas/Address"},{"type":"array","title":"No address","maxItems":0,"items":{"type":"string"}}]},"billing":{"description":"The billing address on the order.","oneOf":[{"$ref":"#/components/schemas/Address"},{"type":"array","title":"No address","maxItems":0,"items":{"type":"string"}}]}}},"line_items":{"type":"array","description":"The list of line items associated with an order. Each line item includes information about the selected product and the taxes, fees, and discounts applied to it.","items":{"type":"object","properties":{"product_data":{"$ref":"#/components/schemas/LineItem"},"taxes":{"type":"array","description":"Any taxes that apply to the line item.","items":{"$ref":"#/components/schemas/Tax"}},"fees":{"type":"array","description":"Any fees that apply to the line item.","items":{"$ref":"#/components/schemas/LineItemFee"}},"discounts":{"type":"array","description":"Any discounts that apply to the line item.","items":{"$ref":"#/components/schemas/LineItemDiscount"}},"fulfilled_quantity":{"type":"integer","description":"The quantity of the line item that has been fulfilled. Fulfill a line item using the [Update Line Item](orders#operation/UpdateLineItem) endpoint.","example":2}}}},"fees":{"type":"array","description":"Any fees that apply to the full order.","items":{"$ref":"#/components/schemas/GeneralFee"}},"taxes":{"type":"array","description":"Any taxes that apply to the full order.","items":{"$ref":"#/components/schemas/Tax"}},"discounts":{"type":"array","description":"Any discounts that apply to the full order. This array contains all discounts that apply to the order, including order-level, shipping, and line item discounts.","items":{"anyOf":[{"$ref":"#/components/schemas/Discount"},{"$ref":"#/components/schemas/LineItemDiscount"}]},"example":[{"value":0,"text":"FREESHIPPING","code":"FREESHIPPING","source":"coupon"},{"value":500,"text":"Cutting board discount","code":"CHOPCHOP","source":"cart"}]},"payments":{"type":"array","description":"The payments applied to the order.","items":{"$ref":"#/components/schemas/Payment"}},"order_total":{"type":"number","description":"The total amount of the order (after tax, shipping, and discounts) using cents/base currency units using [ISO-4217](https://www.iso.org/iso-4217-currency-codes.html) standards.","example":4700},"order_meta_data":{"$ref":"#/components/schemas/OrderMetaData"},"shipping":{"type":"object","description":"The shipping information \u2014 including shipping lines, taxes, and discounts \u2014 associated with an order.","properties":{"selected_shipping":{"$ref":"#/components/schemas/ShippingLine"},"available_shipping_lines":{"type":"array","description":"The shipping lines available for the order.","items":{"type":"object","properties":{"id":{"type":"string"},"line":{"$ref":"#/components/schemas/ShippingLine"}}}},"taxes":{"description":"Any taxes that apply to the shipping rate.","oneOf":[{"type":"array","items":{"$ref":"#/components/schemas/Tax"}},{"type":"number"}]},"discounts":{"description":"Any discount that applies to the shipping rate. Free shipping discounts are created in the [Bold Checkout admin](https://support.boldcommerce.com/hc/en-us/search?utf8=%E2%9C%93&query=discount+codes).","oneOf":[{"type":"array","items":{"$ref":"#/components/schemas/Discount"}},{"type":"number"}]}}},"resumable_link":{"type":"string","nullable":true,"example":"example.com/checkout/resume","description":"A URL that can be used to redirect a customer when resuming their abandoned order."},"flow_id":{"type":"string","nullable":true,"description":"The identifier of the origin checkout flow used to create the order. If left empty, defaults to `null` and is displayed as \\"Unassigned\\" in the Checkout admin.","example":"external-company-one-page-template"},"currency":{"$ref":"#/components/schemas/Currency"},"display_currency":{"$ref":"#/components/schemas/DisplayCurrency"},"display_exchange_rate":{"$ref":"#/components/schemas/DisplayExchangeRate"},"created_via":{"type":"string","description":"The source of the order. Plugin developers can use the [Set Order Created By](/guides/checkout/references/plugin-actions#set_order_created_by) action to set this field and indicate that an order was created by their plugin. If the order was created as normal through Bold Checkout, this value is `\\"checkout\\"`.","example":"My_Order_Creating_Plugin"},"is_processed":{"type":"boolean","description":"Indicates whether the order has been processed.","example":false},"order_id":{"type":"number","description":"Bold Checkout\'s internal order ID.","example":79047599},"platform_order_id":{"type":"string","nullable":true,"description":"A platform-generated identifier for the order.","example":"1389wjfalsdf9y4r"}}},"CartItem":{"title":"Cart Item","type":"object","properties":{"platform_id":{"type":"string","description":"An identifier of the product on the platform.","example":"5423"},"sku":{"type":"string","description":"A merchant-defined stock-keeping unit of the line item.","example":"OAK_GRATER_SM"},"quantity":{"type":"integer","description":"The quantity of the line item to be added to the order.","example":2},"line_item_key":{"$ref":"#/components/schemas/LineItemKey"},"line_item_properties":{"$ref":"#/components/schemas/LineItemProperties"}},"required":["quantity","line_item_key"]},"Discount":{"title":"Discount","type":"object","description":"A discount, which can be applied either to an individual line item, the shipping rate, or the order as a whole.","properties":{"value":{"type":"number","description":"The value of the discount applied, represented in base currency units, using [ISO-4217](https://www.iso.org/iso-4217-currency-codes.html) standards. A free shipping discount has a `value` of `0`.","example":0},"text":{"type":"string","description":"A description of the discount, which is displayed on the platform.","example":"FREESHIPPING"},"code":{"type":"string","description":"The user-facing discount code name.","example":"FREESHIPPING"},"source":{"type":"string","description":"The source of the discount code. Possible values are:\\n  - `cart` discount, created from plugin actions [DISCOUNT_CART](/guides/checkout/references/plugin-actions#discount_cart) and/or [DISCOUNT_LINE_ITEMS](/guides/checkout/references/plugin-actions#discount_line_items). There can be multiple \'cart\' discounts on each order.\\n  - `coupon` discount, created in the [Bold Checkout admin](https://support.boldcommerce.com/hc/en-us/search?utf8=%E2%9C%93&query=discount+codes) and applied via the [Add Discount Code](checkout#operation/AddDiscountCode) endpoint. There can be only one `coupon` discount per order.","example":"coupon"}}},"Estimate":{"properties":{"first_name":{"type":"string","description":"The first name of the addressee.","example":"John"},"last_name":{"type":"string","description":"The last name of the addressee.","example":"Doe"},"address_line_1":{"type":"string","description":"The street address.","example":"50 Fultz Blvd"},"address_line_2":{"type":"string","description":"Any additional street address details (apt #, suite #, etc).","example":"Suite 200"},"country":{"type":"string","description":"The country name.","example":"Canada"},"city":{"type":"string","description":"The city name.","example":"Winnipeg"},"province":{"type":"string","description":"The province or state name, if applicable.","example":"Manitoba"},"country_code":{"type":"string","description":"The country code, in [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) format.","example":"CA"},"province_code":{"type":"string","description":"The province or state code, in [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) format, if applicable.","example":"MB"},"postal_code":{"type":"string","description":"The postal/zip code. Validated on format only when provided.","example":"R3Y0L6"},"business_name":{"type":"string","description":"The business name, if applicable.","example":"Acme Inc."},"phone_number":{"type":"string","description":"The phone number of the addressee.","example":"8005550101"}}},"LineItemDiscount":{"title":"Line Item Discount","type":"object","description":"A line item discount.","properties":{"value":{"type":"number","description":"The value of the discount applied, represented in base currency units, using [ISO-4217](https://www.iso.org/iso-4217-currency-codes.html) standards.","example":500},"text":{"type":"string","description":"A description of the discount, which is displayed on the platform.","example":"Cutting board discount"},"code":{"type":"string","description":"The user-facing discount code.","example":"CHOPCHOP"},"source":{"type":"string","description":"The source of the discount code. For line items, the `source` is always `cart`. Use the [DISCOUNT_LINE_ITEMS](/guides/checkout/references/plugin-actions#discount_line_items) plugin action to discount line items. There can be multiple \'cart\' discounts on each order. This discount also appears in the order-level `discounts` array.","example":"cart"}}},"GeneralFee":{"title":"GeneralFee","type":"object","properties":{"id":{"type":"string","description":"A unique identifier for this fee, used in the [`remove_fee`](/guides/checkout/references/plugin-actions#remove_fee) plugin action.","example":"123456789"},"line_text":{"type":"string","description":"A user-defined identifier serving to be displayed in any user interfaces.","example":"Custom Fee \u2014 Added by Plugin"},"fee_type":{"type":"string","description":"The type of the fee, \\"fixed\\" or \\"percentage\\".","example":"fixed"},"value":{"type":"integer","description":"The fee amount, represented in base currency units, using [ISO-4217](https://www.iso.org/iso-4217-currency-codes.html) standards.","example":10},"source":{"type":"string","description":"The method in which the fee was added to the order, typically through the `add_fee` plugin action.","example":"PLUGIN"},"plugin_uuid":{"type":"string","description":"The identifier of the plugin which added the fee to the order. This field is omitted if the fee source was not a plugin.","example":"a52589f8-09df-11ed-b30e-f67072e164ee"},"taxable":{"type":"boolean","description":"Indicates whether the fee should be included in the calculation of taxes.","example":true},"show_description":{"type":"boolean","description":"Indicates whether to show the fee description. Always set to `true` for fees added by plugin.","example":true}}},"LineItemFee":{"title":"Fee","type":"object","description":"An additional fee to be added to the line item.","properties":{"amount":{"type":"number","description":"The fee amount, represented in cents/base currency units, using [ISO-4217](https://www.iso.org/iso-4217-currency-codes.html) standards.","example":500},"name":{"type":"string","description":"A description of the fee.","example":"Miscellaneous fee."}}},"LineItemKey":{"title":"LineItemKey","type":"string","description":"A unique identifier, set by the merchant, serving to refer to this line item throughout Bold Checkout. You can retrieve this value using the [Products API](products#tag/Products) and looking for the `id` on each product.","example":"ABC123"},"LineItemProperties":{"title":"Line Item Properties","type":"object","description":"Any arbitrary property that you want to associate with this item. Line Items can also be Gift Cards, which have specific and unique properties.","anyOf":[{"type":"object","title":"Additional Properties","additionalProperties":{"type":"string"},"example":{"colour":"red","size":"small"}},{"$ref":"#/components/schemas/GiftCardProperties"},{"type":"object","title":"No properties","description":"Empty object"}]},"LineItem":{"title":"Line Item","type":"object","properties":{"id":{"type":"string","description":"An internal-only string that Bold uses to identify line items. This is created when the line item is added to the order.","example":"724bca"},"product_title":{"type":"string","description":"The name of the product.","example":"Oak Cheese Grater"},"title":{"type":"string","description":"The name of the product variant.","example":"Small"},"image_url":{"type":"string","description":"The URL at which to find an image.","example":"http://shop.images/oakcheesegrater"},"properties":{"description":"Any additional properties of the line item. Line items can also be gift cards, which have specific and unique properties.","anyOf":[{"type":"object","title":"Additional Properties","additionalProperties":{"type":"string"},"example":{"colour":"red","size":"small"}},{"$ref":"#/components/schemas/GiftCardProperties"},{"type":"array","title":"No properties","maxItems":0,"items":{"type":"string"}}]},"description":{"type":"string","description":"A description of the product.","example":"A handmade oak cheese grater to elevate your cheese-eating experience."},"quantity":{"type":"integer","description":"The quantity of the line item on the order.","example":2},"price":{"type":"number","description":"The price of one unit of the line item, using cents/base currency units, using [ISO-4217](https://www.iso.org/iso-4217-currency-codes.html) standards.","example":2350},"total_price":{"type":"number","description":"The total price of all units of the line item, presented in cents/base currency units, using [ISO-4217](https://www.iso.org/iso-4217-currency-codes.html) standards.","example":4700},"visible":{"type":"integer","description":"Indicates whether the item is visible on the storefront. Hard-coded to `1` to indicate `true`.","example":1},"line_item_key":{"$ref":"#/components/schemas/LineItemKey"},"barcode":{"type":"string","description":"The barcode for the line item.","example":"1234ABC"},"compare_at_price":{"type":"number","description":"An optional price displayed on the product page to indicate the discount taken.","nullable":true,"example":4000},"weight":{"type":"integer","description":"The weight of one unit of the line item, measured in `weight_unit`.","example":1000},"weight_unit":{"type":"string","description":"The unit in which to measure the line item weight.","example":"g"},"product_id":{"type":"string","description":"A platform-defined identifier for the product on this line item.","example":"oak-cheese-grater"},"variant_id":{"type":"string","description":"A platform-defined identifier for the product variant on this line item.","example":"oak-cheese-grater-small"},"requires_shipping":{"type":"boolean","description":"Indicates whether the item must be shipped.","example":true},"sku":{"type":"string","description":"A merchant-defined stock-keeping unit of the line item.","example":"OAK_GRATER_SM"},"taxable":{"type":"boolean","description":"Indicates whether the line item is taxable.","example":true},"tags":{"type":"string","description":"Any tags attached to the line item.","example":"Kitchen, Cheese Board, Oak"},"vendor":{"type":"string","description":"The vendor that supplied the line item.","example":"Cheese Boards Unlimited"},"total_weight":{"type":"integer","description":"The total weight of all units of this line item.","example":2000},"localized_names":{"description":"Any localized names for the product. Languages and localized names are configured in the platform.\\n\\nFor each configured language, the object contains a property with a key equal to the language (in [ISO 369](https://www.iso.org/iso-639-language-codes.html) format) and value equal to the product name in that language.\\n","anyOf":[{"type":"object","title":"Additional Properties","additionalProperties":{"type":"string","properties":{"text":{"type":"string"}}},"example":{"fr":"Gratteur \xe0 fromage en ch\xeane","ge":"K\xe4sereibe aus Eichenholz"}},{"type":"array","title":"No localized_names","maxItems":0,"items":{}}]},"localized_descriptions":{"description":"Any localized descriptions for the product. Languages and localized descriptions are configured in the platform.\\n\\nFor each configured language, the object contains a property with a key equal to the language (in [ISO 369](https://www.iso.org/iso-639-language-codes.html) format) and value equal to the product description in that language.\\n","anyOf":[{"type":"object","title":"Additional Properties","additionalProperties":{"type":"string","properties":{"text":{"type":"string"}}},"example":{"fr":"Un gratteur \xe0 fromage en ch\xeane faite \xe0 la main pour rehausser votre exp\xe9rience de d\xe9gustation de fromage","ge":"Eine handgefertigte K\xe4sereibe aus Eichenholz, um Ihr K\xe4seerlebnis zu verbessern"}},{"type":"array","title":"No localized_descriptions","maxItems":0,"items":{}}]},"localized_variant_names":{"description":"Any localized names for the product variant. Languages and localized names are configured in the platform.\\n\\nFor each configured language, the object contains a property with a key equal to the language (in [ISO 369](https://www.iso.org/iso-639-language-codes.html) format) and value equal to the product variant name in that language.\\n","anyOf":[{"type":"object","title":"Additional Properties","additionalProperties":{"type":"string","properties":{"text":{"type":"string"}}},"example":{"fr":"Gratteur \xe0 fromage en ch\xeane","ge":"K\xe4sereibe aus Eichenholz"}},{"type":"array","title":"No localized_variant_names","maxItems":0,"items":{}}]}}},"Payment":{"title":"Payment","type":"object","properties":{"gateway_public_id":{"type":"string","description":"A public identifier of the payment gateway used with the payment.","example":"i7z2xT0sKrDvhGWzex5SLjf5e6ndlQfrRL4AROkfhf3vNBkVT38JKBy5PSjB63qW"},"amount":{"type":"number","description":"The payment amount, represented in cents/base currency units, using [ISO-4217](https://www.iso.org/iso-4217-currency-codes.html) standards.","example":4700},"currency":{"type":"string","description":"The currency of the payment, using [ISO-4217](https://www.iso.org/iso-4217-currency-codes.html) standards.","example":"CAD"},"type":{"type":"string","description":"The payment gateway that accepted the payment.","example":"spreedly"},"display_string":{"type":"string","description":"A description of the payment to visually display to the customer.","example":"Credit Card Payment"},"id":{"type":"string","readOnly":true,"description":"An identifier of the payment.","example":""},"token":{"type":"string","description":"A token generated by the payment gateway to identify the payment.","example":"7uZAMRAf80KiEwibsrrM5IB41yU"},"wallet_pay_type":{"type":"string","description":"The identifier for a wallet/express payment provider, if applicable for the payment.\\n\\nThe current supported wallet/express payment providers are:\\n- Apple Pay (`applepay`)\\n- Pay with Google (`paywithgoogle`)\\n- PayPal (`paypal`)","enum":["applepay","paywithgoogle","paypal"]},"retain":{"type":"boolean","description":"Indicates whether the payment method will be saved for future orders. Checkout only stores a tokenized version of the payment method.","default":false,"example":false},"payment_parameters":{"type":"object","description":"Additional payment data, if necessary for the payment gateway.\\n\\nIf `payment_parameters` is empty, its value is an empty array (`[]`).\\n","example":{"is_giftcard":true,"customer_segment_id":"ab4329tn23oe315"}}},"required":["gateway_public_id","token"]},"Currency":{"type":"object","description":"The currency that the order was completed in.","properties":{"iso_code":{"type":"string","description":"The currency code, using [ISO-4217](https://www.iso.org/iso-4217-currency-codes.html) standards.","example":"CAD"},"iso_numeric_code":{"type":"integer","description":"The numeric currency code, using [ISO-4217](https://www.iso.org/iso-4217-currency-codes.html) standards.","example":124},"symbol":{"type":"string","description":"The symbol associated with the currency.","example":"$"},"format":{"type":"string","description":"The format of the currency, including the symbol and the amount.","example":"${{amount}}"},"has_decimal":{"type":"boolean","description":"Indicates whether the currency uses a decimal.","example":true},"show_iso_code":{"type":"boolean","description":"Indicates whether to show the ISO code alongside the order total on the storefront.","example":true}}},"DisplayCurrency":{"type":"object","description":"The currency that the order was displayed to the user.","properties":{"iso_code":{"type":"string","description":"The currency code, using [ISO-4217](https://www.iso.org/iso-4217-currency-codes.html) standards.","example":"USD"},"iso_numeric_code":{"type":"integer","description":"The numeric currency code, using [ISO-4217](https://www.iso.org/iso-4217-currency-codes.html) standards.","example":840},"symbol":{"type":"string","description":"The symbol associated with the currency.","example":"$"},"format":{"type":"string","description":"The format of the currency, including the symbol and the amount.","example":"${{amount}}"},"has_decimal":{"type":"boolean","description":"Indicates whether the currency uses a decimal.","example":true},"show_iso_code":{"type":"boolean","description":"Indicates whether to show the ISO code alongside the order total on the storefront.","example":true}}},"DisplayExchangeRate":{"type":"number","description":"The rate of exchange between the currency on the order and the display currency.","example":1.357251},"GiftCardPaymentId":{"title":"Gift Card Payment ID","type":"string","description":"The ID of the gift card payment. Find the ID by reading the application state `payments` array. Refer to [Get Application State](checkout#operation/GetApplicationState).","example":"2"},"PaymentStylesheet":{"type":"object","description":"The CSS media queries to apply to the SPI iframe.","properties":{"css_rules":{"type":"array","description":"A set of CSS rules to be applied to the SPI iframe.","items":{"type":"object","properties":{"cssText":{"type":"string","description":"String of CSS styles, specifying the target elements, to be applied to the SPI iframe.","example":".ToggleField { color:red; }"}}}},"media_rules":{"type":"array","description":"A set of media queries to be applied to the SPI iframe.","items":{"type":"object","properties":{"conditionText":{"type":"string","description":"The media conditional text. Must not include \\"@media\\" in the string.","example":"screen and (max-height: 600px)"},"cssRules":{"type":"array","description":"A set of CSS rules to be applied when the media condition is met.","items":{"type":"object","properties":{"cssText":{"type":"string","description":"The CSS rule.","example":".ToggleField__Text { color:blue; }"}}}}}}}}},"PaymentGatewayOrder":{"type":"object","properties":{"gateway_type":{"type":"string","description":"The payment gateway where the order will be created. Currently supports: `paypal`.","enum":["paypal"],"example":"paypal"},"payment_data":{"type":"object","description":"The properties required for the gateway (specified by `gateway_type`) to create an order. These properties vary between gateways.","oneOf":[{"$ref":"#/components/schemas/PayPalGatewayOrder"}]}}},"PayPalGatewayOrder":{"type":"object","properties":{"locale":{"type":"string","description":"The location associated with your PayPal account, in [BCP-47 format](https://www.w3.org/International/core/langtags/rfc3066bis.html).","example":"en-US"}}},"PayPalGatewayOrderResponse":{"type":"object","properties":{"id":{"type":"string","description":"The identifier for the order created in the PayPal gateway.","example":"123"}}},"WalletPayOnShipping":{"type":"object","properties":{"gateway_type":{"type":"string","description":"The payment gateway where the order is created. Currently supports: `paypal`.","enum":["paypal"],"example":"paypal"},"payment_data":{"type":"object","description":"Properties required for the gateway (specified by `gateway_type`) to handle this request. These properties vary between gateways.","oneOf":[{"$ref":"#/components/schemas/PayPalWalletPayOnShipping"}]}}},"PayPalWalletPayOnShipping":{"type":"object","properties":{"locale":{"type":"string","description":"The location associated with your PayPal account, in [BCP-47 format](https://www.w3.org/International/core/langtags/rfc3066bis.html).","example":"en-US"},"paypal_order_id":{"type":"string","description":"The order identifier created by the [Create Wallet Pay Order](/api/checkout#tag/Wallet-Pay/operation/CreateOrder) endpoint.","example":"123"},"shipping_address":{"type":"object","description":"The shipping address provided by the payment gateway.","properties":{"city":{"description":"The city name.","type":"string","example":"Winnipeg"},"country_code":{"description":"The country code, in [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) format.","type":"string","example":"CA"},"postal_code":{"description":"The postal code.","type":"string","example":"R3Y0L6"},"state":{"description":"The two-character state.","type":"string","example":"MB"}}},"shipping_options":{"type":"object","description":"The shipping options provided by the payment gateway.","properties":{"id":{"description":"The identifier of the shipping option.","type":"string","example":"123"},"label":{"description":"The human-readable label of the shipping option.","type":"string","example":"Canada Post Packet"},"selected":{"description":"Indicates whether this shipping option has been selected.","type":"boolean","example":true},"type":{"description":"The type of shipping option.","type":"string","example":"SHIPPING"},"amount":{"description":"The cost of the shipping option.","type":"object","properties":{"currency_code":{"type":"string","example":"USD"},"value":{"type":"string","example":"23.13"}}}}}}},"WalletPayOnApprove":{"type":"object","properties":{"gateway_type":{"type":"string","description":"The payment gateway where the order is created. Currently supports: `paypal`.","enum":["paypal"],"example":"paypal"},"payment_data":{"type":"object","description":"Any properties required for the gateway (specified by `gateway_type`) to handle this request. These properties vary between gateways.","oneOf":[{"$ref":"#/components/schemas/PayPalWalletPayOnApprove"}]}}},"PayPalWalletPayOnApprove":{"type":"object","properties":{"locale":{"type":"string","description":"The location associated with your PayPal account, in [BCP-47 format](https://www.w3.org/International/core/langtags/rfc3066bis.html).","example":"en-US"},"paypal_order_id":{"type":"string","description":"The order identifier created by the [Create Order](/api/checkout#tag/Wallet-Pay/operation/CreateOrder) endpoint.","example":"123"}}},"ShippingLine":{"title":"Shipping Line","type":"object","nullable":true,"properties":{"id":{"type":"string","description":"Identifier/index of the shipping line.","example":"0"},"description":{"type":"string","description":"Description of the shipping line.","example":"Custom weight-based rate: tier 2"},"amount":{"type":"number","description":"The shipping amount represented in cents/base currency units using [ISO-4217](https://www.iso.org/iso-4217-currency-codes.html) standards.","example":450},"code":{"type":"string","description":"An identifier assigned to the shipping rate by the shipping provider.","example":"EXPID"}}},"SubRequest":{"title":"Sub-Request","type":"object","properties":{"endpoint":{"type":"string","description":"The last sub-route of the endpoint URL for the sub-request. For the full list of supported endpoints, refer to the [Submit a Batch Processing Event](/guides/checkout/batch-processing) guide.","example":"validate_email_address"},"method":{"type":"string","description":"The HTTP method for the sub-request.","example":"GET"},"payload":{"type":"object","description":"The complete payload of the sub-request, formatted identically to a non-batch request, as defined in this specification.","example":{"email_address":"john.doe@example.com"}}}},"SubResponse":{"title":"Batch Processing Endpoint Response","type":"object","oneOf":[{"title":"Successful Sub-Request","type":"object","properties":{"data":{"oneOf":[{"type":"object","description":"The endpoint response as documented in the specification, excluding the application state. Refer to the applicable specification for the structure and content of this response.","example":{"customer":{"platform_id":"","public_id":"pjpTyGh8KzNQ225wPqxgy7LwNuC887h6ecGyp3omwT4XW8SszjVSdHzWHN4NBwqhA","first_name":"John","last_name":"Doe","email_address":"john.doe@example.com","accepts_marketing":true,"saved_addresses":[]}}},{"type":"array","description":"If the endpoint does not return a response body, `data` contains just an empty array.","maxLength":0,"example":[],"items":{}}]},"status_code":{"type":"integer","description":"The status code of the sub-request.","example":200},"method":{"type":"string","description":"The HTTP method for the sub-request.","example":"GET"},"endpoint":{"type":"string","description":"The last sub-route of the endpoint URL for the sub-request. For the full list of supported endpoints, refer to the [Submit a Batch Processing Event](/guides/checkout/batch-processing) guide.","example":"validate_email_address"}}},{"title":"Failed Sub-Request","type":"object","properties":{"errors":{"type":"array","description":"The error that caused the sub-request to fail.","items":{"$ref":"#/components/schemas/UnprocessableEntity"}},"status_code":{"type":"integer","description":"The status code of the sub-request.","example":422},"method":{"type":"string","description":"The HTTP method for the sub-request.","example":"GET"},"endpoint":{"type":"string","description":"The last sub-route of the endpoint URL for the sub-request. For the full list of supported endpoints, refer to the [Submit a Batch Processing Event](/guides/checkout/batch-processing) guide.","example":"validate_email_address"}}}]},"Tax":{"title":"Tax","type":"object","properties":{"value":{"type":"number","description":"The value of the tax applied, represented in cents/base currency units, using [ISO-4217](https://www.iso.org/iso-4217-currency-codes.html) standards.","example":1000},"name":{"type":"string","description":"A descriptor of the tax being applied.","example":"GST"},"is_included":{"type":"boolean","description":"Indicates whether the tax is already included in the price.","example":true}}},"Customer":{"title":"Customer","type":"object","description":"An authenticated or guest customer associated with an order.","properties":{"platform_id":{"type":"string","description":"The platform identifier for an authenticated customer. For guest customers, the value for this property will be null.","nullable":true,"readOnly":true,"example":"50942578465125"},"public_id":{"type":"string","description":"The public identifier generated by Checkout for a customer.","nullable":true,"readOnly":true,"example":"pjpTyGh8KzNQ225wPqxgy7LwNuC887h6ecGyp3omwT4XW8SszjVSdHzWHN4NBwqhA"},"first_name":{"type":"string","description":"The first name of the customer.","example":"John"},"last_name":{"type":"string","description":"The last name of the customer.","example":"Doe"},"email_address":{"type":"string","description":"The email address of the customer.","example":"john.doe@example.com"},"accepts_marketing":{"type":"boolean","description":"If the customer would like to receive any sort of marketing emails.","example":true},"saved_addresses":{"type":"array","description":"The saved addresses of an authenticated customer stored from the platform.","items":{"$ref":"#/components/schemas/Address"}}},"required":["email_address"]},"OrderMetaData":{"title":"Order Metadata","type":"object","description":"Additional information about an order. Metadata can be used as data proxy that Checkout will act upon. It can also be used to include extra information about an order and included when pushed to the platform.","properties":{"cart_parameters":{"description":"Extra information about an order that Checkout can act upon.","oneOf":[{"type":"object","title":"Cart parameters","properties":{"key":{"type":"string","example":"cp-key1"}},"additionalProperties":{"type":"string","example":"A cart param."}},{"type":"array","title":"No cart parameters","maxItems":0,"items":{"type":"string"}}]},"note_attributes":{"description":"Extra information added to the order and pushed to the platform.","oneOf":[{"type":"object","title":"Note attributes","properties":{"key":{"type":"string","example":"na-key1"}},"additionalProperties":{"type":"string","example":"A note attribute."}},{"type":"array","title":"No note attributes","maxItems":0,"items":{"type":"string"}}]},"notes":{"type":"string","description":"Notes that can be attached to the order.","example":"A special delivery note."},"tags":{"type":"array","description":"Tags attached to the order.","items":{"type":"string","example":"order-1"}}}},"AuthorizationError":{"type":"object","description":"An error with the authorization of the JWT.","properties":{"code":{"type":"string","description":"The error code.","example":"00-1"},"type":{"type":"string","description":"The type of error.","example":"authorization.missing_jwt"},"message":{"type":"string","description":"A phrase describing what went wrong.","example":"Missing JWT"}}},"UnprocessableEntity":{"description":"There was a problem with the object provided in the request.","type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string","description":"An error message describing what went wrong."},"type":{"type":"string","description":"The type of error that occurred."},"field":{"type":"string","description":"The field of the object that the error was found in."},"severity":{"type":"string","description":"The severity of the error."},"sub_type":{"type":"string","description":"The sub_type of the error."}}}}}},"Error":{"type":"object","description":"There was a problem with the request.","properties":{"message":{"type":"string","description":"A phrase describing what went wrong.","example":"No Checkout shop found"},"type":{"type":"string","description":"The type of error.","example":"order"},"severity":{"type":"string","description":"The severity of the error.","example":"critical"},"subtype":{"type":"string","description":"The subtype of the error.","example":"public_order_id"}}},"Address":{"title":"Address","description":"A shipping or billing address.","type":"object","nullable":true,"properties":{"id":{"type":"string","description":"A unique identifier of the address.","nullable":true,"readOnly":true,"example":"123"},"first_name":{"type":"string","description":"The first name of the addressee.","example":"John"},"last_name":{"type":"string","description":"The last name of the addressee.","example":"Doe"},"address_line_1":{"type":"string","description":"The street address.","example":"50 Fultz Blvd"},"address_line_2":{"type":"string","description":"Any additional street address details (apt #, suite #, etc).","example":"Suite 200"},"country":{"type":"string","description":"The country name.","example":"Canada"},"city":{"type":"string","description":"The city name.","example":"Winnipeg"},"province":{"type":"string","description":"The province or state name, if applicable. If `show_province` is set to `true`, this field is required.","example":"Manitoba"},"country_code":{"type":"string","description":"The country code, in [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) format.","example":"CA"},"province_code":{"type":"string","description":"The province or state code, in [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) format, if applicable. If `show_province` is set to `true`, this field is required.","example":"MB"},"postal_code":{"type":"string","description":"The postal/zip code. Required for most countries, including the United States, Canada, and Mexico. Validated on format only when provided.","example":"R3Y0L6"},"business_name":{"type":"string","description":"If applicable, the business name.","example":"Acme Inc."},"phone_number":{"type":"string","description":"The phone number of the addressee.","example":"8005550101"}},"example":{"id":"123","first_name":"John","last_name":"Doe","address_line_1":"50 Fultz Blvd","address_line_2":"Suite 200","country":"Canada","city":"Winnipeg","province":"Manitoba","country_code":"CA","province_code":"MB","postal_code":"R3Y0L6","business_name":"Acme Inc.","phone_number":"8005550101"},"required":["country","country_code"]},"GiftCardProperties":{"title":"Gift Card Properties","type":"object","properties":{"recipient_name":{"type":"string","description":"Name of the person the gift card is being sent to. If none is provided, defaults to the customer\'s `first_name`.","example":"John Doe"},"recipient_email":{"type":"string","description":"Email address the gift card is being sent to. If none is provided, defaults to the customer\'s `email_address`.","example":"johndoe@boldcommerce.com"},"message":{"type":"string","description":"Personalized message field that the buyer can attach to the gift card. Value is `\\"\\"` if created from an order.","example":"Dear John, Happy Birthday!"},"custom_amount":{"type":"string","description":"If included, the price of this particular line item in the checkout order will be overwritten by this value. It is written in base units, using [ISO-4217](https://www.iso.org/iso-4217-currency-codes.html) standards.","example":"2450"}}}},"examples":{"addPaymentAppHook":{"value":{"uuid":"93225ea4-d701-41f9-a30a-bfe66f5d0479","hook":"age_verified","app_hook_data":{"order":{"tag_name":"over_legal_minimum","tag_value":true}}}},"BatchRequest":{"value":{"sub_requests":[{"method":"GET","endpoint":"/validate_email_address","payload":{"email_address":"john.doe@example.com"}},{"method":"POST","endpoint":"/customer/guest","payload":{"first_name":"John","last_name":"Doe","email_address":"john.doe@example.com","accepts_marketing":true}}]}},"SuccessfulBatchResponse":{"value":{"application_state":{"customer":{"platform_id":"","public_id":"pjpTyGh8KzNQ225wPqxgy7LwNuC887h6ecGyp3omwT4XW8SszjVSdHzWHN4NBwqhA","first_name":"John","last_name":"Doe","email_address":"john.doe@example.com","accepts_marketing":true,"saved_addresses":[]},"addresses":{"shipping":{"id":"123","first_name":"John","last_name":"Doe","address_line_1":"50 Fultz Blvd","address_line_2":"Suite 200","country":"Canada","city":"Winnipeg","province":"Manitoba","country_code":"CA","province_code":"MB","postal_code":"R3Y0L6","business_name":"Acme Inc.","phone_number":"8005550101"},"billing":{"id":"123","first_name":"John","last_name":"Doe","address_line_1":"50 Fultz Blvd","address_line_2":"Suite 200","country":"Canada","city":"Winnipeg","province":"Manitoba","country_code":"CA","province_code":"MB","postal_code":"R3Y0L6","business_name":"Acme Inc.","phone_number":"8005550101"}},"line_items":[{"product_data":{"id":"724bca","product_title":"Oak Cheese Grater","title":"Small","image_url":"http://shop.images/oakcheesegrater","properties":{"colour":"red","size":"small"},"description":"A handmade oak cheese grater to elevate your cheese-eating experience.","quantity":2,"price":2350,"total_price":4700,"visible":1,"line_item_key":"oak_cheese_grater_2643","barcode":"1234ABC","compare_at_price":4000,"weight":1000,"weight_unit":"g","product_id":"oak-cheese-grater","variant_id":"oak-cheese-grater-small","requires_shipping":true,"sku":"OAK_GRATER_SM","taxable":true,"tags":"Kitchen, Cheese Board, Oak","vendor":"Cheese Boards Unlimited","total_weight":2000}},{"taxes":[{"value":1000,"name":"GST","is_included":true}]},{"fees":[{"amount":500,"name":"Miscellaneous fee."}]},{"discounts":[{"value":0,"text":"Cutting board discount","code":"CHOPCHOP","source":"cart"}]},{"fulfilled_quantity":2}],"fees":[{"id":"123456789","line_text":"Custom Fee \u2014 Added by Plugin","fee_type":"fixed","value":10,"source":"PLUGIN","plugin_uuid":"a52589f8-09df-11ed-b30e-f67072e164ee","taxable":true,"show_description":true}],"taxes":[{"value":1000,"name":"GST","is_included":true}],"discounts":[{"value":0,"text":"Cutting board discount","code":"CHOPCHOP","source":"cart"},{"value":0,"text":"FREESHIPPING","code":"FREESHIPPING","source":"coupon"}],"payments":[{"gateway_public_id":"i7z2xT0sKrDvhGWzex5SLjf5e6ndlQfrRL4AROkfhf3vNBkVT38JKBy5PSjB63qW","amount":4700,"currency":"CAD","type":"spreedly","display_string":"Credit Card Payment","id":"","token":"7uZAMRAf80KiEwibsrrM5IB41yU","retain":false,"payment_parameters":[]}],"order_total":4700,"order_meta_data":{"cart_parameters":{"key":"cp-key1,","property1":"A cart param.","property2":"A cart param."},"note_attributes":{"key":"na-key1","property1":"A note attribute.","property2":"A note attribute."},"notes":"A special delivery note.","tags":["order-1"]},"shipping":{"selected_shipping":{"id":"0","description":"Custom weight-based rate: tier 2","amount":450,"code":"EXPID"},"available_shipping_lines":[{"id":"string,","line":{"id":"0","description":"Custom weight-based rate: tier 2","amount":450,"code":"EXPID"}}],"taxes":[{"value":1000,"name":"GST","is_included":true}],"discounts":[{"value":0,"text":"FREESHIPPING","code":"FREESHIPPING","source":"coupon"}]},"resumable_link":"example.com/checkout/resume","flow_id":"external-company-one-page-template","currency":{"iso_code":"CAD","iso_numeric_code":124,"symbol":"$","format":"${{amount}}","has_decimal":true,"show_iso_code":true},"created_via":"My_Order_Creating_Plugin","is_processed":false,"order_id":79047599,"platform_order_id":"1389wjfalsdf9y4r"},"data":[{"data":[],"status_code":"200,","method":"GET","endpoint":"/validate_email_address"},{"data":{"customer":{"platform_id":"","public_id":"pjpTyGh8KzNQ225wPqxgy7LwNuC887h6ecGyp3omwT4XW8SszjVSdHzWHN4NBwqhA","first_name":"John","last_name":"Doe","email_address":"john.doe@example.com","accepts_marketing":true,"saved_addresses":[]}},"status_code":200,"method":"POST","endpoint":"/customer/guest"}]}},"FailedBatchResponse":{"value":{"errors":[{"message":"The country field is required.","type":"order","field":"country","severity":"validation","sub_type":"billing_address"}],"application_state":{"customer":{"platform_id":"","public_id":"pjpTyGh8KzNQ225wPqxgy7LwNuC887h6ecGyp3omwT4XW8SszjVSdHzWHN4NBwqhA","first_name":"John","last_name":"Doe","email_address":"john.doe@example.com","accepts_marketing":true,"saved_addresses":[]},"addresses":{"shipping":{"id":"123","first_name":"John","last_name":"Doe","address_line_1":"50 Fultz Blvd","address_line_2":"Suite 200","country":"Canada","city":"Winnipeg","province":"Manitoba","country_code":"CA","province_code":"MB","postal_code":"R3Y0L6","business_name":"Acme Inc.","phone_number":"8005550101"},"billing":{"id":"123","first_name":"John","last_name":"Doe","address_line_1":"50 Fultz Blvd","address_line_2":"Suite 200","country":"Canada","city":"Winnipeg","province":"Manitoba","country_code":"CA","province_code":"MB","postal_code":"R3Y0L6","business_name":"Acme Inc.","phone_number":"8005550101"}},"line_items":[{"product_data":{"id":"724bca","product_title":"Oak Cheese Grater","title":"Small","image_url":"http://shop.images/oakcheesegrater","properties":{"colour":"red","size":"small"},"description":"A handmade oak cheese grater to elevate your cheese-eating experience.","quantity":2,"price":2350,"total_price":4700,"visible":1,"line_item_key":"oak_cheese_grater_2643","barcode":"1234ABC","compare_at_price":4000,"weight":1000,"weight_unit":"g","product_id":"oak-cheese-grater","variant_id":"oak-cheese-grater-small","requires_shipping":true,"sku":"OAK_GRATER_SM","taxable":true,"tags":"Kitchen, Cheese Board, Oak","vendor":"Cheese Boards Unlimited","total_weight":2000}},{"taxes":[{"value":1000,"name":"GST","is_included":true}]},{"fees":[{"amount":500,"name":"Miscellaneous fee."}]},{"discounts":[{"value":0,"text":"Cutting board discount","code":"CHOPCHOP","source":"cart"}]},{"fulfilled_quantity":2}],"fees":[{"id":"123456789","line_text":"Custom Fee \u2014 Added by Plugin","fee_type":"fixed","value":10,"source":"PLUGIN","plugin_uuid":"a52589f8-09df-11ed-b30e-f67072e164ee","taxable":true,"show_description":true}],"taxes":[{"value":1000,"name":"GST","is_included":true}],"discounts":[{"value":0,"text":"Cutting board discount","code":"CHOPCHOP","source":"cart"},{"value":0,"text":"FREESHIPPING","code":"FREESHIPPING","source":"coupon"}],"payments":[{"gateway_public_id":"i7z2xT0sKrDvhGWzex5SLjf5e6ndlQfrRL4AROkfhf3vNBkVT38JKBy5PSjB63qW","amount":4700,"currency":"CAD","type":"spreedly","display_string":"Credit Card Payment","id":"","token":"7uZAMRAf80KiEwibsrrM5IB41yU","retain":false,"payment_parameters":[]}],"order_total":4700,"order_meta_data":{"cart_parameters":{"key":"cp-key1,","property1":"A cart param.","property2":"A cart param."},"note_attributes":{"key":"na-key1","property1":"A note attribute.","property2":"A note attribute."},"notes":"A special delivery note.","tags":["order-1"]},"shipping":{"selected_shipping":{"id":"0","description":"Custom weight-based rate: tier 2","amount":450,"code":"EXPID"},"available_shipping_lines":[{"id":"string,","line":{"id":"0","description":"Custom weight-based rate: tier 2","amount":450,"code":"EXPID"}}],"taxes":[{"value":1000,"name":"GST","is_included":true}],"discounts":[{"value":0,"text":"FREESHIPPING","code":"FREESHIPPING","source":"coupon"}]},"resumable_link":"example.com/checkout/resume","flow_id":"external-company-one-page-template","currency":{"iso_code":"CAD","iso_numeric_code":124,"symbol":"$","format":"${{amount}}","has_decimal":true,"show_iso_code":true},"created_via":"My_Order_Creating_Plugin","is_processed":false,"order_id":79047599,"platform_order_id":"1389wjfalsdf9y4r"},"data":[{"data":[],"status_code":"200,","method":"GET","endpoint":"validate_email_address"},{"errors":{"message":"The country field is required.","type":"order","field":"country","severity":"validation","sub_type":"billing_address"},"status_code":422,"method":"POST","endpoint":"customer/guest"}]}},"DeletedBillingAddress":{"value":{"data":{"application_state":{"customer":{"platform_id":"50942578465125","public_id":"pjpTyGh8KzNQ225wPqxgy7LwNuC887h6ecGyp3omwT4XW8SszjVSdHzWHN4NBwqhA","first_name":"John","last_name":"Doe","email_address":"john.doe@example.com","accepts_marketing":true,"saved_addresses":[{"id":"123","first_name":"John","last_name":"Doe","address_line_1":"50 Fultz Blvd","address_line_2":"Suite 200","country":"Canada","city":"Winnipeg","province":"Manitoba","country_code":"CA","province_code":"MB","postal_code":"R3Y0L6","business_name":"Acme Inc.","phone_number":"8005550101"}]},"addresses":{"shipping":{"id":"123","first_name":"John","last_name":"Doe","address_line_1":"50 Fultz Blvd","address_line_2":"Suite 200","country":"Canada","city":"Winnipeg","province":"Manitoba","country_code":"CA","province_code":"MB","postal_code":"R3Y0L6","business_name":"Acme Inc.","phone_number":"8005550101"},"billing":[]},"line_items":[{"product_data":{"id":"724bca","product_title":"Oak Cheese Grater","title":"Small","image_url":"http://shop.images/oakcheesegrater","properties":{"colour":"red","size":"small"},"description":"A handmade oak cheese grater to elevate your cheese-eating experience.","quantity":2,"price":2350,"total_price":4700,"visible":1,"line_item_key":"oak_cheese_grater_2643","barcode":"1234ABC","compare_at_price":4000,"weight":1000,"weight_unit":"g","product_id":"oak-cheese-grater","variant_id":"oak-cheese-grater-small","requires_shipping":true,"sku":"OAK_GRATER_SM","taxable":true,"tags":"Kitchen, Cheese Board, Oak","vendor":"Cheese Boards Unlimited","total_weight":2000}},{"taxes":[{"value":1000,"name":"GST","is_included":true}]},{"fees":[{"amount":500,"name":"Miscellaneous fee."}]},{"discounts":[{"value":0,"code":"CHOPCHOP","text":"Cutting board discount","source":"cart"}]},{"fulfilled_quantity":2}],"fees":[{"id":"123456789","line_text":"Custom Fee \u2014 Added by Plugin","fee_type":"fixed","value":10,"source":"PLUGIN","plugin_uuid":"a52589f8-09df-11ed-b30e-f67072e164ee","taxable":true,"show_description":true}],"taxes":[{"value":1000,"name":"GST","is_included":true}],"discounts":[{"value":0,"code":"CHOPCHOP","text":"Cutting board discount","source":"cart"},{"value":0,"code":"FREESHIPPING","text":"FREESHIPPING","source":"coupon"}],"payments":[{"gateway_public_id":"i7z2xT0sKrDvhGWzex5SLjf5e6ndlQfrRL4AROkfhf3vNBkVT38JKBy5PSjB63qW","amount":4700,"currency":"CAD","type":"spreedly","display_string":"Credit Card Payment","id":"","token":"7uZAMRAf80KiEwibsrrM5IB41yU","retain":false,"payment_parameters":[]}],"order_total":4700,"order_meta_data":{"cart_parameters":{"key":"cp-key1,","property1":"A cart param.","property2":"A cart param."},"note_attributes":{"key":"na-key1","property1":"A note attribute.","property2":"A note attribute."},"notes":"A special delivery note.","tags":["order-1"]},"shipping":{"selected_shipping":{"id":"0","description":"Custom weight-based rate: tier 2","amount":450,"code":"EXPID"},"available_shipping_lines":[{"id":"string,","line":{"id":"0","description":"Custom weight-based rate: tier 2","amount":450,"code":"EXPID"}}],"taxes":[{"value":1000,"name":"GST","is_included":true}],"discounts":[{"value":0,"code":"FREESHIPPING","text":"FREESHIPPING","source":"coupon"}]},"resumable_link":"example.com/checkout/resume","flow_id":"external-company-one-page-template","currency":{"iso_code":"CAD","iso_numeric_code":124,"symbol":"$","format":"${{amount}}","has_decimal":true,"show_iso_code":true},"created_via":"My_Order_Creating_Plugin","is_processed":false,"order_id":79047599,"platform_order_id":"1389wjfalsdf9y4r"}}}},"DeletedShippingAddress":{"value":{"data":{"application_state":{"customer":{"platform_id":"50942578465125","public_id":"pjpTyGh8KzNQ225wPqxgy7LwNuC887h6ecGyp3omwT4XW8SszjVSdHzWHN4NBwqhA","first_name":"John","last_name":"Doe","email_address":"john.doe@example.com","accepts_marketing":true,"saved_addresses":[{"id":"123","first_name":"John","last_name":"Doe","address_line_1":"50 Fultz Blvd","address_line_2":"Suite 200","country":"Canada","city":"Winnipeg","province":"Manitoba","country_code":"CA","province_code":"MB","postal_code":"R3Y0L6","business_name":"Acme Inc.","phone_number":"8005550101"}]},"addresses":{"shipping":{"id":"123","first_name":"John","last_name":"Doe","address_line_1":"50 Fultz Blvd","address_line_2":"Suite 200","country":"Canada","city":"Winnipeg","province":"Manitoba","country_code":"CA","province_code":"MB","postal_code":"R3Y0L6","business_name":"Acme Inc.","phone_number":"8005550101"},"billing":[]},"line_items":[{"product_data":{"id":"724bca","product_title":"Oak Cheese Grater","title":"Small","image_url":"http://shop.images/oakcheesegrater","properties":{"colour":"red","size":"small"},"description":"A handmade oak cheese grater to elevate your cheese-eating experience.","quantity":2,"price":2350,"total_price":4700,"visible":1,"line_item_key":"oak_cheese_grater_2643","barcode":"1234ABC","compare_at_price":4000,"weight":1000,"weight_unit":"g","product_id":"oak-cheese-grater","variant_id":"oak-cheese-grater-small","requires_shipping":true,"sku":"OAK_GRATER_SM","taxable":true,"tags":"Kitchen, Cheese Board, Oak","vendor":"Cheese Boards Unlimited","total_weight":2000}},{"taxes":[{"value":1000,"name":"GST","is_included":true}]},{"fees":[{"amount":500,"name":"Miscellaneous fee."}]},{"discounts":[{"value":0,"code":"CHOPCHOP","text":"Cutting board discount","source":"cart"}]},{"fulfilled_quantity":2}],"fees":[{"id":"123456789","line_text":"Custom Fee \u2014 Added by Plugin","fee_type":"fixed","value":10,"source":"PLUGIN","plugin_uuid":"a52589f8-09df-11ed-b30e-f67072e164ee","taxable":true,"show_description":true}],"taxes":[{"value":1000,"name":"GST","is_included":true}],"discounts":[{"value":0,"code":"CHOPCHOP","text":"Cutting board discount","source":"cart"},{"value":0,"code":"FREESHIPPING","text":"FREESHIPPING","source":"coupon"}],"payments":[{"gateway_public_id":"i7z2xT0sKrDvhGWzex5SLjf5e6ndlQfrRL4AROkfhf3vNBkVT38JKBy5PSjB63qW","amount":4700,"currency":"CAD","type":"spreedly","display_string":"Credit Card Payment","id":"","token":"7uZAMRAf80KiEwibsrrM5IB41yU","retain":false,"payment_parameters":[]}],"order_total":4700,"order_meta_data":{"cart_parameters":{"key":"cp-key1,","property1":"A cart param.","property2":"A cart param."},"note_attributes":{"key":"na-key1","property1":"A note attribute.","property2":"A note attribute."},"notes":"A special delivery note.","tags":["order-1"]},"shipping":{"selected_shipping":{"id":"0","description":"Custom weight-based rate: tier 2","amount":450,"code":"EXPID"},"available_shipping_lines":[{"id":"string,","line":{"id":"0","description":"Custom weight-based rate: tier 2","amount":450,"code":"EXPID"}}],"taxes":[{"value":1000,"name":"GST","is_included":true}],"discounts":[{"value":0,"code":"FREESHIPPING","text":"FREESHIPPING","source":"coupon"}]},"resumable_link":"example.com/checkout/resume","flow_id":"external-company-one-page-template","currency":{"iso_code":"CAD","iso_numeric_code":124,"symbol":"$","format":"${{amount}}","has_decimal":true,"show_iso_code":true},"created_via":"My_Order_Creating_Plugin","is_processed":false,"order_id":79047599,"platform_order_id":"1389wjfalsdf9y4r"}}}},"NoCustomer":{"summary":"Deleted Customer","value":{"data":{"application_state":{"customer":[],"addresses":{"shipping":{"id":"123","first_name":"John","last_name":"Doe","address_line_1":"50 Fultz Blvd","address_line_2":"Suite 200","country":"Canada","city":"Winnipeg","province":"Manitoba","country_code":"CA","province_code":"MB","postal_code":"R3Y0L6","business_name":"Acme Inc.","phone_number":"8005550101"},"billing":{"id":"123","first_name":"John","last_name":"Doe","address_line_1":"50 Fultz Blvd","address_line_2":"Suite 200","country":"Canada","city":"Winnipeg","province":"Manitoba","country_code":"CA","province_code":"MB","postal_code":"R3Y0L6","business_name":"Acme Inc.","phone_number":"8005550101"}},"line_items":[{"product_data":{"id":"724bca","product_title":"Oak Cheese Grater","title":"Small","image_url":"http://shop.images/oakcheesegrater","properties":{"colour":"red","size":"small"},"description":"A handmade oak cheese grater to elevate your cheese-eating experience.","quantity":2,"price":2350,"total_price":4700,"visible":1,"line_item_key":"oak_cheese_grater_2643","barcode":"1234ABC","compare_at_price":4000,"weight":1000,"weight_unit":"g","product_id":"oak-cheese-grater","variant_id":"oak-cheese-grater-small","requires_shipping":true,"sku":"OAK_GRATER_SM","taxable":true,"tags":"Kitchen, Cheese Board, Oak","vendor":"Cheese Boards Unlimited","total_weight":2000}},{"taxes":[{"value":1000,"name":"GST","is_included":true}]},{"fees":[{"amount":500,"name":"Miscellaneous fee."}]},{"discounts":[{"value":0,"text":"Cutting board discount","code":"CHOPCHOP","source":"cart"},{"value":0,"text":"FREESHIPPING","code":"FREESHIPPING","source":"coupon"}]},{"fulfilled_quantity":2}],"fees":[{"id":"123456789","line_text":"Custom Fee \u2014 Added by Plugin","fee_type":"fixed","value":10,"source":"PLUGIN","plugin_uuid":"a52589f8-09df-11ed-b30e-f67072e164ee","taxable":true,"show_description":true}],"taxes":[{"value":1000,"name":"GST","is_included":true}],"discounts":[{"code":"FREESHIPPING","text":"FREESHIPPING","value":500,"source":"coupon"}],"payments":[{"gateway_public_id":"i7z2xT0sKrDvhGWzex5SLjf5e6ndlQfrRL4AROkfhf3vNBkVT38JKBy5PSjB63qW","amount":4700,"currency":"CAD","type":"spreedly","display_string":"Credit Card Payment","id":"","token":"7uZAMRAf80KiEwibsrrM5IB41yU","retain":false,"payment_parameters":[]}],"order_total":4700,"order_meta_data":{"cart_parameters":{"key":"cp-key1,","property1":"A cart param.","property2":"A cart param."},"note_attributes":{"key":"na-key1","property1":"A note attribute.","property2":"A note attribute."},"notes":"A special delivery note.","tags":["order-1"]},"shipping":{"selected_shipping":{"id":"0","description":"Custom weight-based rate: tier 2","amount":450,"code":"EXPID"},"available_shipping_lines":[{"id":"string,","line":{"id":"0","description":"Custom weight-based rate: tier 2","amount":450,"code":"EXPID"}}],"taxes":[{"value":1000,"name":"GST","is_included":true}],"discounts":[{"value":500,"text":"FREESHIPPING","code":"FREESHIPPING","source":"coupon"}]},"resumable_link":"example.com/checkout/resume","flow_id":"external-company-one-page-template","currency":{"iso_code":"CAD","iso_numeric_code":124,"symbol":"$","format":"${{amount}}","has_decimal":true,"show_iso_code":true},"created_via":"My_Order_Creating_Plugin","is_processed":false,"order_id":79047599,"platform_order_id":"1389wjfalsdf9y4r"}}}},"GuestCustomer":{"summary":"Guest Customer","value":{"data":{"customer":{"platform_id":"","public_id":"pjpTyGh8KzNQ225wPqxgy7LwNuC887h6ecGyp3omwT4XW8SszjVSdHzWHN4NBwqhA","first_name":"John","last_name":"Doe","email_address":"john.doe@example.com","accepts_marketing":true,"saved_addresses":[]},"application_state":{"customer":{"platform_id":"","public_id":"pjpTyGh8KzNQ225wPqxgy7LwNuC887h6ecGyp3omwT4XW8SszjVSdHzWHN4NBwqhA","first_name":"John","last_name":"Doe","email_address":"john.doe@example.com","accepts_marketing":true,"saved_addresses":[]},"addresses":{"shipping":{"id":"123","first_name":"John","last_name":"Doe","address_line_1":"50 Fultz Blvd","address_line_2":"Suite 200","country":"Canada","city":"Winnipeg","province":"Manitoba","country_code":"CA","province_code":"MB","postal_code":"R3Y0L6","business_name":"Acme Inc.","phone_number":"8005550101"},"billing":{"id":"123","first_name":"John","last_name":"Doe","address_line_1":"50 Fultz Blvd","address_line_2":"Suite 200","country":"Canada","city":"Winnipeg","province":"Manitoba","country_code":"CA","province_code":"MB","postal_code":"R3Y0L6","business_name":"Acme Inc.","phone_number":"8005550101"}},"line_items":[{"product_data":{"id":"724bca","product_title":"Oak Cheese Grater","title":"Small","image_url":"http://shop.images/oakcheesegrater","properties":{"colour":"red","size":"small"},"description":"A handmade oak cheese grater to elevate your cheese-eating experience.","quantity":2,"price":2350,"total_price":4700,"visible":1,"line_item_key":"oak_cheese_grater_2643","barcode":"1234ABC","compare_at_price":4000,"weight":1000,"weight_unit":"g","product_id":"oak-cheese-grater","variant_id":"oak-cheese-grater-small","requires_shipping":true,"sku":"OAK_GRATER_SM","taxable":true,"tags":"Kitchen, Cheese Board, Oak","vendor":"Cheese Boards Unlimited","total_weight":2000}},{"taxes":[{"value":1000,"name":"GST","is_included":true}]},{"fees":[{"amount":500,"name":"Miscellaneous fee."}]},{"discounts":[{"value":0,"text":"Cutting board discount","code":"CHOPCHOP","source":"cart"}]},{"fulfilled_quantity":2}],"fees":[{"id":"123456789","line_text":"Custom Fee \u2014 Added by Plugin","fee_type":"fixed","value":10,"source":"PLUGIN","plugin_uuid":"a52589f8-09df-11ed-b30e-f67072e164ee","taxable":true,"show_description":true}],"taxes":[{"value":1000,"name":"GST","is_included":true}],"discounts":[{"value":0,"text":"Cutting board discount","code":"CHOPCHOP","source":"cart"},{"value":0,"text":"FREESHIPPING","code":"FREESHIPPING","source":"coupon"}],"payments":[{"gateway_public_id":"i7z2xT0sKrDvhGWzex5SLjf5e6ndlQfrRL4AROkfhf3vNBkVT38JKBy5PSjB63qW","amount":4700,"currency":"CAD","type":"spreedly","display_string":"Credit Card Payment","id":"","token":"7uZAMRAf80KiEwibsrrM5IB41yU","retain":false,"payment_parameters":[]}],"order_total":4700,"order_meta_data":{"cart_parameters":{"key":"cp-key1,","property1":"A cart param.","property2":"A cart param."},"note_attributes":{"key":"na-key1","property1":"A note attribute.","property2":"A note attribute."},"notes":"A special delivery note.","tags":["order-1"]},"shipping":{"selected_shipping":{"id":"0","description":"Custom weight-based rate: tier 2","amount":450,"code":"EXPID"},"available_shipping_lines":[{"id":"string,","line":{"id":"0","description":"Custom weight-based rate: tier 2","amount":450,"code":"EXPID"}}],"taxes":[{"value":1000,"name":"GST","is_included":true}],"discounts":[{"value":0,"text":"FREESHIPPING","code":"FREESHIPPING","source":"coupon"}]},"resumable_link":"example.com/checkout/resume","flow_id":"external-company-one-page-template","currency":{"iso_code":"CAD","iso_numeric_code":124,"symbol":"$","format":"${{amount}}","has_decimal":true,"show_iso_code":true},"created_via":"My_Order_Creating_Plugin","is_processed":false,"order_id":79047599,"platform_order_id":"1389wjfalsdf9y4r"}}}},"ListDiscounts":{"summary":"List Discounts","value":{"data":{"discounts":[{"value":0,"text":"Cutting board discount","code":"CHOPCHOP","source":"cart"},{"value":0,"text":"FREESHIPPING","code":"FREESHIPPING","source":"coupon"}],"application_state":{"customer":{"platform_id":"","public_id":"pjpTyGh8KzNQ225wPqxgy7LwNuC887h6ecGyp3omwT4XW8SszjVSdHzWHN4NBwqhA","first_name":"John","last_name":"Doe","email_address":"john.doe@example.com","accepts_marketing":true,"saved_addresses":[]},"addresses":{"shipping":{"id":"123","first_name":"John","last_name":"Doe","address_line_1":"50 Fultz Blvd","address_line_2":"Suite 200","country":"Canada","city":"Winnipeg","province":"Manitoba","country_code":"CA","province_code":"MB","postal_code":"R3Y0L6","business_name":"Acme Inc.","phone_number":"8005550101"},"billing":{"id":"123","first_name":"John","last_name":"Doe","address_line_1":"50 Fultz Blvd","address_line_2":"Suite 200","country":"Canada","city":"Winnipeg","province":"Manitoba","country_code":"CA","province_code":"MB","postal_code":"R3Y0L6","business_name":"Acme Inc.","phone_number":"8005550101"}},"line_items":[{"product_data":{"id":"724bca","product_title":"Oak Cheese Grater","title":"Small","image_url":"http://shop.images/oakcheesegrater","properties":{"colour":"red","size":"small"},"description":"A handmade oak cheese grater to elevate your cheese-eating experience.","quantity":2,"price":2350,"total_price":4700,"visible":1,"line_item_key":"oak_cheese_grater_2643","barcode":"1234ABC","compare_at_price":4000,"weight":1000,"weight_unit":"g","product_id":"oak-cheese-grater","variant_id":"oak-cheese-grater-small","requires_shipping":true,"sku":"OAK_GRATER_SM","taxable":true,"tags":"Kitchen, Cheese Board, Oak","vendor":"Cheese Boards Unlimited","total_weight":2000}},{"taxes":[{"value":1000,"name":"GST","is_included":true}]},{"fees":[{"amount":500,"name":"Miscellaneous fee."}]},{"discounts":[{"value":0,"text":"Cutting board discount","code":"CHOPCHOP","source":"cart"}]},{"fulfilled_quantity":2}],"fees":[{"id":"123456789","line_text":"Custom Fee \u2014 Added by Plugin","fee_type":"fixed","value":10,"source":"PLUGIN","plugin_uuid":"a52589f8-09df-11ed-b30e-f67072e164ee","taxable":true,"show_description":true}],"taxes":[{"value":1000,"name":"GST","is_included":true}],"discounts":[{"value":0,"text":"Cutting board discount","code":"CHOPCHOP","source":"cart"},{"value":0,"text":"FREESHIPPING","code":"FREESHIPPING","source":"coupon"}],"payments":[{"gateway_public_id":"i7z2xT0sKrDvhGWzex5SLjf5e6ndlQfrRL4AROkfhf3vNBkVT38JKBy5PSjB63qW","amount":4700,"currency":"CAD","type":"spreedly","display_string":"Credit Card Payment","id":"","token":"7uZAMRAf80KiEwibsrrM5IB41yU","retain":false,"payment_parameters":[]}],"order_total":4700,"order_meta_data":{"cart_parameters":{"key":"cp-key1,","property1":"A cart param.","property2":"A cart param."},"note_attributes":{"key":"na-key1","property1":"A note attribute.","property2":"A note attribute."},"notes":"A special delivery note.","tags":["order-1"]},"shipping":{"selected_shipping":{"id":"0","description":"Custom weight-based rate: tier 2","amount":450,"code":"EXPID"},"available_shipping_lines":[{"id":"string,","line":{"id":"0","description":"Custom weight-based rate: tier 2","amount":450,"code":"EXPID"}}],"taxes":[{"value":1000,"name":"GST","is_included":true}],"discounts":[{"value":0,"text":"FREESHIPPING","code":"FREESHIPPING","source":"coupon"}]},"resumable_link":"example.com/checkout/resume","flow_id":"external-company-one-page-template","currency":{"iso_code":"CAD","iso_numeric_code":124,"symbol":"$","format":"${{amount}}","has_decimal":true,"show_iso_code":true},"created_via":"My_Order_Creating_Plugin","is_processed":false,"order_id":79047599,"platform_order_id":"1389wjfalsdf9y4r"}}}},"DeletedDiscount":{"summary":"Deleted Discount","value":{"data":{"discounts":[{"value":0,"text":"Cutting board discount","code":"CHOPCHOP","source":"cart"}],"application_state":{"customer":{"platform_id":"","public_id":"pjpTyGh8KzNQ225wPqxgy7LwNuC887h6ecGyp3omwT4XW8SszjVSdHzWHN4NBwqhA","first_name":"John","last_name":"Doe","email_address":"john.doe@example.com","accepts_marketing":true,"saved_addresses":[]},"addresses":{"shipping":{"id":"123","first_name":"John","last_name":"Doe","address_line_1":"50 Fultz Blvd","address_line_2":"Suite 200","country":"Canada","city":"Winnipeg","province":"Manitoba","country_code":"CA","province_code":"MB","postal_code":"R3Y0L6","business_name":"Acme Inc.","phone_number":"8005550101"},"billing":{"id":"123","first_name":"John","last_name":"Doe","address_line_1":"50 Fultz Blvd","address_line_2":"Suite 200","country":"Canada","city":"Winnipeg","province":"Manitoba","country_code":"CA","province_code":"MB","postal_code":"R3Y0L6","business_name":"Acme Inc.","phone_number":"8005550101"}},"line_items":[{"product_data":{"id":"724bca","product_title":"Oak Cheese Grater","title":"Small","image_url":"http://shop.images/oakcheesegrater","properties":{"colour":"red","size":"small"},"description":"A handmade oak cheese grater to elevate your cheese-eating experience.","quantity":2,"price":2350,"total_price":4700,"visible":1,"line_item_key":"oak_cheese_grater_2643","barcode":"1234ABC","compare_at_price":4000,"weight":1000,"weight_unit":"g","product_id":"oak-cheese-grater","variant_id":"oak-cheese-grater-small","requires_shipping":true,"sku":"OAK_GRATER_SM","taxable":true,"tags":"Kitchen, Cheese Board, Oak","vendor":"Cheese Boards Unlimited","total_weight":2000}},{"taxes":[{"value":1000,"name":"GST","is_included":true}]},{"fees":[{"amount":500,"name":"Miscellaneous fee."}]},{"discounts":[{"value":0,"text":"Cutting board discount","code":"CHOPCHOP","source":"cart"}]},{"fulfilled_quantity":2}],"fees":[{"id":"123456789","line_text":"Custom Fee \u2014 Added by Plugin","fee_type":"fixed","value":10,"source":"PLUGIN","plugin_uuid":"a52589f8-09df-11ed-b30e-f67072e164ee","taxable":true,"show_description":true}],"taxes":[{"value":1000,"name":"GST","is_included":true}],"discounts":[{"value":0,"text":"Cutting board discount","code":"CHOPCHOP","source":"cart"}],"payments":[{"gateway_public_id":"i7z2xT0sKrDvhGWzex5SLjf5e6ndlQfrRL4AROkfhf3vNBkVT38JKBy5PSjB63qW","amount":4700,"currency":"CAD","type":"spreedly","display_string":"Credit Card Payment","id":"","token":"7uZAMRAf80KiEwibsrrM5IB41yU","retain":false,"payment_parameters":[]}],"order_total":4700,"order_meta_data":{"cart_parameters":{"key":"cp-key1,","property1":"A cart param.","property2":"A cart param."},"note_attributes":{"key":"na-key1","property1":"A note attribute.","property2":"A note attribute."},"notes":"A special delivery note.","tags":["order-1"]},"shipping":{"selected_shipping":{"id":"0","description":"Custom weight-based rate: tier 2","amount":450,"code":"EXPID"},"available_shipping_lines":[{"id":"string,","line":{"id":"0","description":"Custom weight-based rate: tier 2","amount":450,"code":"EXPID"}}],"taxes":[{"value":1000,"name":"GST","is_included":true}],"discounts":[]},"resumable_link":"example.com/checkout/resume","flow_id":"external-company-one-page-template","currency":{"iso_code":"CAD","iso_numeric_code":124,"symbol":"$","format":"${{amount}}","has_decimal":true,"show_iso_code":true},"created_via":"My_Order_Creating_Plugin","is_processed":false,"order_id":79047599,"platform_order_id":"1389wjfalsdf9y4r"}}}},"DeletedLineItem":{"summary":"Deleted Line item","value":{"data":{"line_items":[],"application_state":{"customer":{"platform_id":"","public_id":"pjpTyGh8KzNQ225wPqxgy7LwNuC887h6ecGyp3omwT4XW8SszjVSdHzWHN4NBwqhA","first_name":"John","last_name":"Doe","email_address":"john.doe@example.com","accepts_marketing":true,"saved_addresses":[]},"addresses":{"shipping":{"id":"123","first_name":"John","last_name":"Doe","address_line_1":"50 Fultz Blvd","address_line_2":"Suite 200","country":"Canada","city":"Winnipeg","province":"Manitoba","country_code":"CA","province_code":"MB","postal_code":"R3Y0L6","business_name":"Acme Inc.","phone_number":"8005550101"},"billing":{"id":"123","first_name":"John","last_name":"Doe","address_line_1":"50 Fultz Blvd","address_line_2":"Suite 200","country":"Canada","city":"Winnipeg","province":"Manitoba","country_code":"CA","province_code":"MB","postal_code":"R3Y0L6","business_name":"Acme Inc.","phone_number":"8005550101"}},"line_items":[],"fees":[{"id":"123456789","line_text":"Custom Fee \u2014 Added by Plugin","fee_type":"fixed","value":10,"source":"PLUGIN","plugin_uuid":"a52589f8-09df-11ed-b30e-f67072e164ee","taxable":true,"show_description":true}],"taxes":[{"value":1000,"name":"GST","is_included":true}],"discounts":[{"value":0,"text":"Cutting board discount","code":"CHOPCHOP","source":"cart"},{"value":0,"text":"FREESHIPPING","code":"FREESHIPPING","source":"coupon"}],"payments":[{"gateway_public_id":"i7z2xT0sKrDvhGWzex5SLjf5e6ndlQfrRL4AROkfhf3vNBkVT38JKBy5PSjB63qW","amount":4700,"currency":"CAD","type":"spreedly","display_string":"Credit Card Payment","id":"","token":"7uZAMRAf80KiEwibsrrM5IB41yU","retain":false,"payment_parameters":[]}],"order_total":4700,"order_meta_data":{"cart_parameters":{"key":"cp-key1,","property1":"A cart param.","property2":"A cart param."},"note_attributes":{"key":"na-key1","property1":"A note attribute.","property2":"A note attribute."},"notes":"A special delivery note.","tags":["order-1"]},"shipping":{"selected_shipping":{"id":"0","description":"Custom weight-based rate: tier 2","amount":450,"code":"EXPID"},"available_shipping_lines":[{"id":"string,","line":{"id":"0","description":"Custom weight-based rate: tier 2","amount":450,"code":"EXPID"}}],"taxes":[{"value":1000,"name":"GST","is_included":true}],"discounts":[{"value":0,"text":"FREESHIPPING","code":"FREESHIPPING","source":"coupon"}]},"resumable_link":"example.com/checkout/resume","flow_id":"external-company-one-page-template","currency":{"iso_code":"CAD","iso_numeric_code":124,"symbol":"$","format":"${{amount}}","has_decimal":true,"show_iso_code":true},"created_via":"My_Order_Creating_Plugin","is_processed":false,"order_id":79047599,"platform_order_id":"1389wjfalsdf9y4r"}}}},"DeletedPayment":{"value":{"data":{"application_state":{"customer":{"platform_id":"50942578465125","public_id":"pjpTyGh8KzNQ225wPqxgy7LwNuC887h6ecGyp3omwT4XW8SszjVSdHzWHN4NBwqhA","first_name":"John","last_name":"Doe","email_address":"john.doe@example.com","accepts_marketing":true,"saved_addresses":[{"id":"123","first_name":"John","last_name":"Doe","address_line_1":"50 Fultz Blvd","address_line_2":"Suite 200","country":"Canada","city":"Winnipeg","province":"Manitoba","country_code":"CA","province_code":"MB","postal_code":"R3Y0L6","business_name":"Acme Inc.","phone_number":"8005550101"}]},"addresses":{"shipping":{"id":"123","first_name":"John","last_name":"Doe","address_line_1":"50 Fultz Blvd","address_line_2":"Suite 200","country":"Canada","city":"Winnipeg","province":"Manitoba","country_code":"CA","province_code":"MB","postal_code":"R3Y0L6","business_name":"Acme Inc.","phone_number":"8005550101"},"billing":{"id":"123","first_name":"John","last_name":"Doe","address_line_1":"50 Fultz Blvd","address_line_2":"Suite 200","country":"Canada","city":"Winnipeg","province":"Manitoba","country_code":"CA","province_code":"MB","postal_code":"R3Y0L6","business_name":"Acme Inc.","phone_number":"8005550101"}},"line_items":[{"product_data":{"id":"724bca","product_title":"Oak Cheese Grater","title":"Small","image_url":"http://shop.images/oakcheesegrater","properties":{"colour":"red","size":"small"},"description":"A handmade oak cheese grater to elevate your cheese-eating experience.","quantity":2,"price":2350,"total_price":4700,"visible":1,"line_item_key":"oak_cheese_grater_2643","barcode":"1234ABC","compare_at_price":4000,"weight":1000,"weight_unit":"g","product_id":"oak-cheese-grater","variant_id":"oak-cheese-grater-small","requires_shipping":true,"sku":"OAK_GRATER_SM","taxable":true,"tags":"Kitchen, Cheese Board, Oak","vendor":"Cheese Boards Unlimited","total_weight":2000}},{"taxes":[{"value":1000,"name":"GST","is_included":true}]},{"fees":[{"amount":500,"name":"Miscellaneous fee."}]},{"discounts":[{"value":0,"text":"Cutting board discount","code":"CHOPCHOP","source":"cart"},{"value":0,"text":"FREESHIPPING","code":"FREESHIPPING","source":"coupon"}]},{"fulfilled_quantity":2}],"fees":[{"id":"123456789","line_text":"Custom Fee \u2014 Added by Plugin","fee_type":"fixed","value":10,"source":"PLUGIN","plugin_uuid":"a52589f8-09df-11ed-b30e-f67072e164ee","taxable":true,"show_description":true}],"taxes":[{"value":1000,"name":"GST","is_included":true}],"discounts":[{"code":"FREESHIPPING","text":"FREESHIPPING","value":500,"source":"coupon"}],"payments":[],"order_total":4700,"order_meta_data":{"cart_parameters":{"key":"cp-key1,","property1":"A cart param.","property2":"A cart param."},"note_attributes":{"key":"na-key1","property1":"A note attribute.","property2":"A note attribute."},"notes":"A special delivery note.","tags":["order-1"]},"shipping":{"selected_shipping":{"id":"0","description":"Custom weight-based rate: tier 2","amount":450,"code":"EXPID"},"available_shipping_lines":[{"id":"string,","line":{"id":"0","description":"Custom weight-based rate: tier 2","amount":450,"code":"EXPID"}}],"taxes":[{"value":1000,"name":"GST","is_included":true}],"discounts":[{"value":500,"text":"FREESHIPPING","code":"FREESHIPPING","source":"coupon"}]},"resumable_link":"example.com/checkout/resume","flow_id":"external-company-one-page-template","currency":{"iso_code":"CAD","iso_numeric_code":124,"symbol":"$","format":"${{amount}}","has_decimal":true,"show_iso_code":true},"created_via":"My_Order_Creating_Plugin","is_processed":false,"order_id":79047599,"platform_order_id":"1389wjfalsdf9y4r"}}}},"CartItemResponse":{"value":{"platform_id":5423,"sku":"OAK_GRATER_SM","quantity":2,"line_item_key":"ABC123","line_item_properties":{"colour":"red","size":"small"}}},"CartItemGiftCard":{"value":{"platform_id":"786dur","sku":"GIFT_CARD_50","quantity":2,"line_item_key":"ABC123","line_item_properties":{"recipient_name":"John Doe","recipient_email":"johndoe@boldcommerce.com","message":"Dear John, Happy Birthday!","custom_amount":"2450"}}},"GiftCardLineItem":{"summary":"Gift Card Line Item Response","value":{"data":{"line_items":[{"id":"786dur","product_title":"Gift Card $50","title":"Gift Card","image_url":"http://shop.images/50GiftCard","properties":{"recipient_name":"John Doe","recipient_email":"johndoe@boldcommerce.com","message":"Dear John, Happy Birthday!","custom_amount":"5000"},"description":"Gifting is fun, here is a Gift Card.","quantity":2,"price":4700,"total_price":9400,"visible":1,"line_item_key":"ABC123","barcode":"1234ABC","product_id":"gift-card","variant_id":"50-gift-card","requires_shipping":false,"sku":"GIFT_CARD_50","taxable":true,"tags":"Gift Card, Present","vendor":"Cheese Boards Unlimited"}],"application_state":{"customer":{"platform_id":"50942578465125","public_id":"pjpTyGh8KzNQ225wPqxgy7LwNuC887h6ecGyp3omwT4XW8SszjVSdHzWHN4NBwqhA","first_name":"John","last_name":"Doe","email_address":"john.doe@example.com","accepts_marketing":true,"saved_addresses":{"id":"123","first_name":"John","last_name":"Doe","address_line_1":"50 Fultz Blvd","address_line_2":"Suite 200","country":"Canada","city":"Winnipeg","province":"Manitoba","country_code":"CA","province_code":"MB","postal_code":"R3Y0L6","business_name":"Acme Inc.","phone_number":"8005550101"}},"addresses":{"shipping":{"id":"123","first_name":"John","last_name":"Doe","address_line_1":"50 Fultz Blvd","address_line_2":"Suite 200","country":"Canada","city":"Winnipeg","province":"Manitoba","country_code":"CA","province_code":"MB","postal_code":"R3Y0L6","business_name":"Acme Inc.","phone_number":"8005550101"},"billing":{"id":"123","first_name":"John","last_name":"Doe","address_line_1":"50 Fultz Blvd","address_line_2":"Suite 200","country":"Canada","city":"Winnipeg","province":"Manitoba","country_code":"CA","province_code":"MB","postal_code":"R3Y0L6","business_name":"Acme Inc.","phone_number":"8005550101"}},"line_items":[{"product_data":{"id":"786dur","product_title":"Gift Card $50","title":"Gift Card","image_url":"http://shop.images/50GiftCard","properties":{"recipient_name":"John Doe","recipient_email":"johndoe@boldcommerce.com","message":"Dear John, Happy Birthday!","custom_amount":"5000"},"description":"Gifting is fun, here is a Gift Card.","quantity":2,"price":4700,"total_price":9400,"visible":1,"line_item_key":"ABC123","barcode":"1234ABC","product_id":"gift-card","variant_id":"50-gift-card","requires_shipping":false,"sku":"GIFT_CARD_50","taxable":true,"tags":"Gift Card, Present","vendor":"Cheese Boards Unlimited"},"taxes":[{"value":1000,"name":"GST","is_included":true}],"fees":[{"amount":500,"name":"Miscellaneous fee."}],"discounts":"","fulfilled_quantity":2}],"fees":{"id":"123456789","line_text":"Custom Fee \u2014 Added by Plugin","fee_type":"fixed","value":10,"source":"PLUGIN","plugin_uuid":"a52589f8-09df-11ed-b30e-f67072e164ee","taxable":true,"show_description":true},"taxes":{"value":1000,"name":"GST","is_included":true},"discounts":[{"value":0,"text":"FREESHIPPING","code":"FREESHIPPING","source":"coupon"},{"value":500,"text":"Cutting board discount","code":"CHOPCHOP","source":"cart"}],"payments":{"gateway_public_id":"i7z2xT0sKrDvhGWzex5SLjf5e6ndlQfrRL4AROkfhf3vNBkVT38JKBy5PSjB63qW","amount":4700,"currency":"CAD","type":"spreedly","display_string":"Credit Card Payment","id":"","token":"7uZAMRAf80KiEwibsrrM5IB41yU","retain":false,"payment_parameters":[]},"order_total":4700,"order_meta_data":{"cart_parameters":{"key":"cp-key1","additionalProperties":"A cart param."},"note_attributes":{"key":"na-key1","additionalProperties":"A note attribute."},"notes":"A special delivery note.","tags":{"items":"order-1"}},"shipping":{"selected_shipping":{"id":"0","description":"Custom weight-based rate: tier 2","amount":450,"code":"EXPID"},"available_shipping_lines":{"id":null,"line":{"id":"0","description":"Custom weight-based rate: tier 2","amount":450,"code":"EXPID"}},"taxes":{"value":1000,"name":"GST","is_included":true},"discounts":{"value":0,"text":"FREESHIPPING","code":"FREESHIPPING","source":"coupon"}},"resumable_link":"example.com/checkout/resume","flow_id":"external-company-one-page-template","currency":{"iso_code":"CAD","iso_numeric_code":124,"symbol":"$","format":"${{amount}}","has_decimal":true,"show_iso_code":true},"created_via":"My_Order_Creating_Plugin","is_processed":false,"order_id":79047599,"platform_order_id":"1389wjfalsdf9y4r"}}}},"CartItem":{"summary":"Cart item Response","value":{"data":{"line_items":[{"id":"724bca","product_title":"Oak Cheese Grater","title":"Small","image_url":"http://shop.images/oakcheesegrater","properties":{"colour":"red","size":"small"},"description":"A handmade oak cheese grater to elevate your cheese-eating experience.","quantity":2,"price":2350,"total_price":4700,"visible":1,"line_item_key":"ABC123","barcode":"1234ABC","compare_at_price":4000,"weight":1000,"weight_unit":"g","product_id":"oak-cheese-grater","variant_id":"oak-cheese-grater-small","requires_shipping":true,"sku":"OAK_GRATER_SM","taxable":true,"tags":"Kitchen, Cheese Board, Oak","vendor":"Cheese Boards Unlimited","total_weight":2000}],"application_state":{"customer":{"platform_id":"50942578465125","public_id":"pjpTyGh8KzNQ225wPqxgy7LwNuC887h6ecGyp3omwT4XW8SszjVSdHzWHN4NBwqhA","first_name":"John","last_name":"Doe","email_address":"john.doe@example.com","accepts_marketing":true,"saved_addresses":{"id":"123","first_name":"John","last_name":"Doe","address_line_1":"50 Fultz Blvd","address_line_2":"Suite 200","country":"Canada","city":"Winnipeg","province":"Manitoba","country_code":"CA","province_code":"MB","postal_code":"R3Y0L6","business_name":"Acme Inc.","phone_number":"8005550101"}},"addresses":{"shipping":{"id":"123","first_name":"John","last_name":"Doe","address_line_1":"50 Fultz Blvd","address_line_2":"Suite 200","country":"Canada","city":"Winnipeg","province":"Manitoba","country_code":"CA","province_code":"MB","postal_code":"R3Y0L6","business_name":"Acme Inc.","phone_number":"8005550101"},"billing":{"id":"123","first_name":"John","last_name":"Doe","address_line_1":"50 Fultz Blvd","address_line_2":"Suite 200","country":"Canada","city":"Winnipeg","province":"Manitoba","country_code":"CA","province_code":"MB","postal_code":"R3Y0L6","business_name":"Acme Inc.","phone_number":"8005550101"}},"line_items":[{"product_data":{"id":"724bca","product_title":"Oak Cheese Grater","title":"Small","image_url":"http://shop.images/oakcheesegrater","properties":{"colour":"red","size":"small"},"description":"A handmade oak cheese grater to elevate your cheese-eating experience.","quantity":2,"price":2350,"total_price":4700,"visible":1,"line_item_key":"oak_cheese_grater_2643","barcode":"1234ABC","compare_at_price":4000,"weight":1000,"weight_unit":"g","product_id":"oak-cheese-grater","variant_id":"oak-cheese-grater-small","requires_shipping":true,"sku":"OAK_GRATER_SM","taxable":true,"tags":"Kitchen, Cheese Board, Oak","vendor":"Cheese Boards Unlimited","total_weight":2000},"taxes":[{"value":1000,"name":"GST","is_included":true}],"fees":[{"amount":500,"name":"Miscellaneous fee."}],"discounts":[{"value":0,"text":"Cutting board discount","code":"CHOPCHOP","source":"cart"},{"value":0,"text":"FREESHIPPING","code":"FREESHIPPING","source":"coupon"}],"fulfilled_quantity":2}],"fees":{"id":"123456789","line_text":"Custom Fee \u2014 Added by Plugin","fee_type":"fixed","value":10,"source":"PLUGIN","plugin_uuid":"a52589f8-09df-11ed-b30e-f67072e164ee","taxable":true,"show_description":true},"taxes":{"value":1000,"name":"GST","is_included":true},"discounts":[{"value":0,"text":"FREESHIPPING","code":"FREESHIPPING","source":"coupon"},{"value":500,"text":"Cutting board discount","code":"CHOPCHOP","source":"cart"}],"payments":{"gateway_public_id":"i7z2xT0sKrDvhGWzex5SLjf5e6ndlQfrRL4AROkfhf3vNBkVT38JKBy5PSjB63qW","amount":4700,"currency":"CAD","type":"spreedly","display_string":"Credit Card Payment","id":"","token":"7uZAMRAf80KiEwibsrrM5IB41yU","retain":false,"payment_parameters":[]},"order_total":4700,"order_meta_data":{"cart_parameters":{"key":"cp-key1","additionalProperties":"A cart param."},"note_attributes":{"key":"na-key1","additionalProperties":"A note attribute."},"notes":"A special delivery note.","tags":{"items":"order-1"}},"shipping":{"selected_shipping":{"id":"0","description":"Custom weight-based rate: tier 2","amount":450,"code":"EXPID"},"available_shipping_lines":{"id":null,"line":{"id":"0","description":"Custom weight-based rate: tier 2","amount":450,"code":"EXPID"}},"taxes":{"value":1000,"name":"GST","is_included":true},"discounts":{"value":0,"text":"FREESHIPPING","code":"FREESHIPPING","source":"coupon"}},"resumable_link":"example.com/checkout/resume","flow_id":"external-company-one-page-template","currency":{"iso_code":"CAD","iso_numeric_code":124,"symbol":"$","format":"${{amount}}","has_decimal":true,"show_iso_code":true},"created_via":"My_Order_Creating_Plugin","is_processed":false,"order_id":79047599,"platform_order_id":"1389wjfalsdf9y4r"}}}}},"responses":{"Unauthorized-JWT":{"description":"Unauthorized error messages may be returned if the JWT is missing or was not provided properly using the Authorization header. An invalid error message may also be returned when the JWT contains invalid data. The JWT expires after 60 minutes, in which case an expired JWT error message will be returned.","x-summary":"Unauthorized JWT","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/AuthorizationError"}}}},"examples":{"expired-jwt":{"value":{"errors":[{"code":"00-1","type":"authorization.expired_jwt","message":"Expired JWT"}]}},"invalid-jwt":{"value":{"errors":[{"code":"00-1","type":"authorization.invalid_jwt","message":"Invalid JWT"}]}},"missing-jwt":{"value":{"errors":[{"code":"00-1","type":"authorization.missing_jwt","message":"Missing JWT"}]}}}}}},"OrderNotFound":{"description":"The order could not be found by the given ID.","x-summary":"Order not found","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","description":"The error returned when an order can\'t be found.","items":{"type":"object","description":"Properties for the error.","properties":{"code":{"type":"string","description":"The error code.","example":"02-92"},"type":{"type":"string","description":"The type of error.","example":"order_not_found_by_id"},"message":{"type":"string","description":"A description of the error.","example":"No order found by identifier: 123abc"}}}}}}}}},"WalletPayUnprocessableEntity":{"description":"There was a problem with the object provided in the request.","x-summary":"Unprocessable Entity","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","description":"An error message describing what went wrong.","items":{"type":"object","description":"Properties for the error.","properties":{"code":{"type":"string","description":"The error code.","example":"02-92"},"type":{"type":"string","description":"The type of error.","example":"gateway_type_not_found"},"message":{"type":"string","description":"A description of the error.","example":"Invalid gateway type."}}}}}}}}},"GiftCardNotFound":{"description":"The gift card could not be found by the given ID.","x-summary":"Gift Card Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"The error code.","example":"02-90"},"type":{"type":"string","description":"The type of error.","example":"checkout.api_payment_removal_failed"},"message":{"type":"string","description":"A description of the error.","example":"Gift card payment not found."}}}}}}}}}}}}},"plugin-redoc-1":{"url":"/api/customers.openapi.yaml","themeId":"theme-redoc","isSpecFile":true,"spec":{"openapi":"3.0.0","info":{"title":"Internal customers service","description":"This API allows you to find information about your customers.\\n\\nRefer to the <a href=\\"https://developer.boldcommerce.com/changelog\\">changelog</a> for the latest updates to this API.","contact":{"name":"Contact Us","url":"https://developer-dashboard.boldcommerce.com/default/contactus"},"version":"2.0.0"},"servers":[{"url":"http://customer-api.prod.svc.cluster.local:9000"},{"url":"http://customer-api.staging.svc.cluster.local:9000"},{"url":"http://localhost:9106"}],"tags":[{"name":"Customer Event Notifications","description":"Event notifications you send to Bold when a change occurs to customers on the platform."},{"name":"Order Event Notifications","description":"Event notifications you send to Bold when a change occurs to orders on the platform."},{"name":"Product Event Notifications","description":"Event notifications you send to Bold when a change occurs to products on the platform."},{"name":"Customers","description":"Contains information about the customers associated with a given store. Use these endpoints to retrieve information about one or all customers on your store."},{"name":"Addresses","description":"Contains information about the shipping and billing addresses associated with a given store. Use these endpoints to retrieve information about one or all customer addresses on your store."}],"paths":{"/v1/shops/{shop_identifier}/platforms/custom/webhooks/customers/saved":{"parameters":[{"$ref":"#/components/parameters/shopIdentifier"}],"post":{"tags":["Customer Event Notifications"],"summary":"Customer Saved","operationId":"CustomerSavedEventNotification","description":"Trigger this API call when customer data changes on the platform. This includes customer creation, customer updates, and any changes to a customer\'s associated addresses.\\n\\nBold queues the customer for saving. The request must contain the complete customer object and its addresses at the time the change occurred. Bold replaces all fields of the existing customer object with the values provided in the request body. Bold ignores and does not update the fields omitted from the request body.\\n\\nThe `platform_updated_at` field must be accurate to mitigate the risk incurred by out-of-sequence requests.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/customerSavedRequestBody"}}},"required":true},"responses":{"202":{"description":"Event notification was queued successfully.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"A validation error occurred.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/validationError"},"examples":{"validationError":{"value":{"status_code":400,"errors":["Error at \'/data/customer/addresses/0/platform_id\': property \'platform_id\' is missing","Error at \'/data/customer/platform_id\': property \'platform_id\' is missing"]}}}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeErrorCustomer"},"examples":{"internalError":{"$ref":"#/components/examples/internalError"}}}}}}}},"/v1/shops/{shop_identifier}/platforms/custom/webhooks/customers/deleted":{"parameters":[{"$ref":"#/components/parameters/shopIdentifier"}],"post":{"tags":["Customer Event Notifications"],"summary":"Customer Deleted","operationId":"CustomerDeletedEventNotification","description":"Trigger this API call when a customer is deleted on the platform.\\n\\nBold queues the customer for deletion. The `platform_deleted_at` field must be accurate to mitigate the risk incurred by out-of-sequence requests.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/customerDeletedRequestBody"}}},"required":true},"responses":{"202":{"description":"Event notification was queued successfully.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"A validation error occurred.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/validationError"},"examples":{"validationError":{"value":{"status_code":400,"errors":["Error at \'/data/customer/platform_id\': property \'platform_id\' is missing"]}}}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeErrorCustomer"},"examples":{"internalError":{"$ref":"#/components/examples/internalError"}}}}}}}},"/v2/shops/{shop_identifier}/customers/{id}":{"get":{"tags":["Customers"],"summary":"Get Customer by ID","operationId":"GetCustomerByID","description":"Retrieves a customer by the Bold-generated ID.","parameters":[{"$ref":"#/components/parameters/shop_identifier"},{"name":"id","in":"path","required":true,"description":"A unique identifier for the customer, generated by Bold.","schema":{"type":"integer","format":"int64"},"example":82435920}],"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2CustomerByXIDResponse"}}}},"default":{"description":"An unexpected error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}}}},"/v2/shops/{shop_identifier}/customers/pid/{platform_id}":{"get":{"tags":["Customers"],"summary":"Get Customer by Platform ID","description":"Retrieves a customer by the platform-generated customer ID.","operationId":"GetCustomerByPlatformID","parameters":[{"$ref":"#/components/parameters/shop_identifier"},{"$ref":"#/components/parameters/platform_id"}],"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2CustomerByXIDResponse"}}}},"default":{"description":"An unexpected error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}}}},"/v2/shops/{shop_identifier}/customers":{"get":{"tags":["Customers"],"summary":"List Customers","operationId":"ListCustomers","description":"Lists the customers that have placed orders on the store. \\n\\nAll query parameters must be URL-encoded. For more information about searching, refer to [Query & Pagination](/guides/checkout/resources/query-pagination).","parameters":[{"$ref":"#/components/parameters/shop_identifier"},{"$ref":"#/components/parameters/since_id"},{"name":"updated_at_min","in":"query","description":"The earliest date (in [RFC3339 format](https://datatracker.ietf.org/doc/html/rfc3339)) that the customer was updated.","schema":{"type":"string","format":"date-time"},"example":"2020-01-01T00:00:00Z"},{"name":"updated_at_max","in":"query","description":"The latest date (in [RFC3339 format](https://datatracker.ietf.org/doc/html/rfc3339)) that the customer was updated.","schema":{"type":"string","format":"date-time"},"example":"2022-01-01T00:00:00Z"},{"name":"search","in":"query","description":"A search term used to perform a fuzzy search across the customer\'s `first_name`, `last_name`, `email`, and `phone`.","schema":{"type":"string"},"example":"%27bob%20dylan%27"},{"name":"ids","in":"query","description":"A comma-separated list of customer IDs.","schema":{"type":"string"},"example":"142329453,23490134,40245842"},{"name":"orderby","in":"query","description":"The method of ordering the returned results. Must be paired with the `orderdirection` query parameter.","schema":{"type":"string"},"example":"first_name"},{"name":"orderdirection","in":"query","description":"The direction of ordering returned results. Must be paired with the `orderby` query parameter. Possible values include `asc` and `desc`.","schema":{"type":"string"},"example":"asc"},{"name":"filter","in":"query","style":"form","explode":true,"description":"The filtering mechanism to apply to the query. For more information, refer to [Query & Pagination](/guides/checkout/resources/query-pagination#filter).","schema":{"type":"array","items":{"type":"string","example":"eq(id:11)"}}},{"name":"label","in":"query","description":"The label assigned to the customer.","schema":{"type":"string"},"example":"loyal_cust"},{"name":"limit","in":"query","description":"The number of results per page.","schema":{"type":"integer","format":"int32"},"example":50},{"name":"page","in":"query","description":"The page of results to return.","schema":{"type":"integer","format":"int32"},"example":2}],"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2CustomerListResponse"}}}},"default":{"description":"An unexpected error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}}}},"/v2/shops/{shop_identifier}/customers/pid/{platform_id}/validate":{"get":{"tags":["Customers"],"summary":"Validate Customer JWT","operationId":"ValidateCustomerJWT","description":"Validates a customer JWT issued by the Bold platform. The JWT is used to make calls to the [Checkout Frontend](checkout) API.","parameters":[{"$ref":"#/components/parameters/shop_identifier"},{"$ref":"#/components/parameters/platform_id"},{"$ref":"#/components/parameters/jwt"}],"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2CustomerJWTValidateResponse"}}}},"400":{"description":"An invalid JWT.","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"number","description":"The status code.","example":400},"errors":{"type":"array","description":"An array of errors","items":{"type":"string","example":"invalid request"}}}}}}},"default":{"description":"An unexpected error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}}}},"/v2/shops/{shop_identifier}/customers/{customer_id}/addresses/{id}":{"get":{"tags":["Addresses"],"summary":"Get Customer Address by ID","operationId":"GetCustomerAddressByID","description":"Retrieves a customer address by the customer ID and the address ID.","parameters":[{"$ref":"#/components/parameters/shop_identifier"},{"$ref":"#/components/parameters/customer_id"},{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"},"description":"A unique identifier for the address, generated by Bold.","example":90235719}],"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2AddressGetResponse"}}}},"default":{"description":"An unexpected error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}}}},"/v2/shops/{shop_identifier}/customers/{customer_id}/addresses":{"get":{"tags":["Addresses"],"summary":"List Customer Addresses","operationId":"ListCustomerAddresses","description":"Lists all customer addresses for your store. For more information about searching, refer to [Query & Pagination](/guides/checkout/resources/query-pagination).","parameters":[{"$ref":"#/components/parameters/shop_identifier"},{"$ref":"#/components/parameters/customer_id"}],"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2AddressListResponse"}}}},"default":{"description":"An unexpected error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}}}}},"components":{"parameters":{"shopIdentifier":{"name":"shop_identifier","in":"path","description":"A unique identifier of the store. This can be retrieved by calling the [Get Shop\\nInfo](shops#tag/Shops/operation/GetShopInfo#) endpoint.","required":true,"schema":{"type":"string","example":"zp3oafdor9"}},"shop_identifier":{"name":"shop_identifier","in":"path","required":true,"schema":{"type":"string"},"description":"A unique identifier for the store, generated by Bold. Retrieve this information by calling the [Get Shop Info](shops#tag/Shop/operation/GetShopInfo) endpoint.","example":"zp3oafdor9"},"platform_id":{"name":"platform_id","in":"path","required":true,"description":"A unique identifier for the customer, generated by the platform.","schema":{"type":"string"},"example":"2"},"since_id":{"name":"since_id","in":"query","description":"Specifies results that fall after the given ID.","schema":{"type":"integer","format":"int64"},"example":2459023599},"jwt":{"name":"jwt","in":"query","description":"The JSON Web Token (JWT) generated during the [initialization of the order](orders#tag/Orders/operation/InitializeOrder).","schema":{"type":"string"},"example":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhdXRoX3R5cGUiOiJWMl9BUEkiLCJwYXlsb2FkIjp7InB1YmxpY19vcmRlcl9pZCI6Inlyb0Y2NDNNeUpTZVZRUUpES2R2c2QxYXdXY3BpRVFJbkhOaTJkWlhmWW9PdVI0dmFGVUhpNHBPRG9pRWFpOVQifSwiZXhwIjoxNjMyMzQxMjg3LCJuYmYiOm51bGwsImlhdCI6bnVsbH0.swmYcVBHyK2i86jN-bIOL3WOCzP5VQVLq9Ev-TfIC_c"},"customer_id":{"name":"customer_id","in":"path","required":true,"schema":{"type":"integer","format":"int64"},"example":82435920147,"description":"A unique identifier for the customer, generated by Bold."}},"schemas":{"customerBase":{"type":"object","properties":{"email":{"description":"The email address for the customer.","type":"string","format":"email","example":"john.doe@example.com"},"first_name":{"description":"The first name of the customer.","type":"string","example":"John"},"last_name":{"description":"The last name of the customer.","type":"string","example":"Doe"},"phone":{"description":"A phone number for the customer.","type":"string","format":"phone","example":"555-555-5555"}}},"addressBaseCustomer":{"type":"object","properties":{"address_type":{"description":"The type of the address (i.e., residential, commercial).","type":"string","example":"commercial"},"address_use":{"description":"The usage of the address. Possible values are `\\"billing\\"` or `\\"shipping\\"`.","type":"string","enum":["billing","shipping"],"example":"shipping"},"company":{"description":"The name of the company operating at the specified address, if applicable.","type":"string","example":"Acme Corp."},"city":{"description":"The name of the city associated with the address.","type":"string","example":"Winnipeg"},"country":{"description":"The name of the country associated with the address.","type":"string","example":"Canada"},"country_code":{"description":"The country code (in [ISO 3166-1 alpha-2 format](https://www.iso.org/iso-3166-country-codes.html)) of the address.","type":"string","example":"CA"},"is_default":{"description":"Indicates whether this is the default address for the customer. There can only be one default address for a customer. If this modifies any other resources, ensure the appropriate event notifications are triggered for those affected by this change.","type":"boolean","format":"boolean","example":true},"first_name":{"description":"The first name of the customer with the address.","type":"string","example":"John"},"last_name":{"description":"The last name of the customer with the address.","type":"string","example":"Doe"},"phone":{"description":"The phone number of the addressee.","type":"string","format":"phone","example":"555-555-5555"},"postal_code":{"description":"The postal code or zip code for the address.","type":"string","example":"H0H 0H0"},"province":{"description":"The province or state for the address.","type":"string","example":"Manitoba"},"province_code":{"description":"The province or state abbreviation for the address.","type":"string","example":"MB"},"street_1":{"description":"The primary street information for the address.","type":"string","example":"123 North Road"},"street_2":{"description":"Additional street information for the address.","type":"string","example":"Unit 5"}}},"customerAddress":{"type":"object","allOf":[{"$ref":"#/components/schemas/addressBaseCustomer"}],"properties":{"platform_id":{"description":"A unique identifier for the address. Assigned by the platform.","type":"string","example":"Address_456"}},"required":["platform_id"]},"customer":{"type":"object","allOf":[{"$ref":"#/components/schemas/customerBase"}],"properties":{"addresses":{"description":"A list of customer addresses.","type":"array","items":{"$ref":"#/components/schemas/customerAddress"}},"platform_created_at":{"description":"The date (in [RFC3339 format](https://datatracker.ietf.org/doc/html/rfc3339)) that this customer was created on the platform. Assigned by the platform.","type":"string","format":"date-time","example":"2023-01-09T15:35:57"},"platform_updated_at":{"description":"The date (in [RFC3339 format](https://datatracker.ietf.org/doc/html/rfc3339)) that this customer was last modified on the platform. Assigned by the platform.","type":"string","format":"date-time","example":"2023-01-09T15:35:57"},"platform_id":{"description":"A unique identifier for the customer. Assigned by the platform.","type":"string","example":"Customer_123"}},"required":["platform_updated_at","platform_id"]},"customerSavedRequestData":{"type":"object","properties":{"customer":{"$ref":"#/components/schemas/customer"}},"required":["customer"]},"customerSavedRequestBody":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/customerSavedRequestData"}},"required":["data"]},"validationError":{"type":"object","properties":{"status_code":{"type":"number"},"errors":{"type":"array","items":{"type":"string"}}}},"runtimeErrorCustomer":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"The code used to identify the error."},"message":{"type":"string","description":"A long description of the error."},"type":{"type":"string","description":"A short description of the error."}}}}}},"deletedCustomer":{"type":"object","properties":{"platform_id":{"description":"A unique identifier for the customer. Assigned by the platform.","type":"string","example":"Customer_123"},"platform_deleted_at":{"description":"The date (in [RFC3339 format](https://datatracker.ietf.org/doc/html/rfc3339)) that this customer was deleted on the platform. Assigned by the platform.","type":"string","format":"date-time","example":"2023-04-09T12:33:44"}},"required":["platform_id","platform_deleted_at"]},"customerDeletedRequestData":{"type":"object","properties":{"customer":{"$ref":"#/components/schemas/deletedCustomer"}},"required":["customer"]},"customerDeletedRequestBody":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/customerDeletedRequestData"}},"required":["data"]},"protobufAny":{"type":"object","properties":{"type_url":{"type":"string","description":"A URL/resource name that uniquely identifies the type of the serialized\\nprotocol buffer message. This string must contain at least\\none \\"/\\" character. The last segment of the URL\'s path must represent\\nthe fully qualified name of the type (as in\\n`path/google.protobuf.Duration`). The name should be in a canonical form\\n(e.g., leading \\".\\" is not accepted).\\n\\nIn practice, teams usually precompile into the binary all types that they\\nexpect it to use in the context of Any. However, for URLs which use the\\nscheme `http`, `https`, or no scheme, one can optionally set up a type\\nserver that maps type URLs to message definitions as follows:\\n\\n* If no scheme is provided, `https` is assumed.\\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\\n  value in binary format, or produce an error.\\n* Applications are allowed to cache lookup results based on the\\n  URL, or have them precompiled into a binary to avoid any\\n  lookup. Therefore, binary compatibility needs to be preserved\\n  on changes to types. (Use versioned type names to manage\\n  breaking changes.)\\n\\nNote: this functionality is not currently available in the official\\nprotobuf release, and it is not used for type URLs beginning with\\ntype.googleapis.com.\\n\\nSchemes other than `http`, `https` (or the empty scheme) might be\\nused with implementation specific semantics."},"value":{"pattern":"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$","type":"string","description":"Must be a valid serialized protocol buffer of the above specified type.","format":"byte"}},"description":"`Any` contains an arbitrary serialized protocol buffer message along with a\\nURL that describes the type of the serialized message.\\n\\nProtobuf library provides support to pack/unpack Any values in the form\\nof utility functions or additional generated methods of the Any type.\\n\\nExample 1: Pack and unpack a message in C++.\\n\\n    Foo foo = ...;\\n    Any any;\\n    any.PackFrom(foo);\\n    ...\\n    if (any.UnpackTo(&foo)) {\\n      ...\\n    }\\n\\nExample 2: Pack and unpack a message in Java.\\n\\n    Foo foo = ...;\\n    Any any = Any.pack(foo);\\n    ...\\n    if (any.is(Foo.class)) {\\n      foo = any.unpack(Foo.class);\\n    }\\n\\n Example 3: Pack and unpack a message in Python.\\n\\n    foo = Foo(...)\\n    any = Any()\\n    any.Pack(foo)\\n    ...\\n    if any.Is(Foo.DESCRIPTOR):\\n      any.Unpack(foo)\\n      ...\\n\\n Example 4: Pack and unpack a message in Go\\n\\n     foo := &pb.Foo{...}\\n     any, err := ptypes.MarshalAny(foo)\\n     ...\\n     foo := &pb.Foo{}\\n     if err := ptypes.UnmarshalAny(any, foo); err != nil {\\n       ...\\n     }\\n\\nThe pack methods provided by protobuf library will by default use\\n\'type.googleapis.com/full.type.name\' as the type URL and the unpack\\nmethods only use the fully qualified type name after the last \'/\'\\nin the type URL, for example \\"foo.bar.com/x/y.z\\" will yield type\\nname \\"y.z\\".\\n\\n\\nJSON\\n====\\nThe JSON representation of an `Any` value uses the regular\\nrepresentation of the deserialized, embedded message, with an\\nadditional field `@type` which contains the type URL. Example:\\n\\n    package google.profile;\\n    message Person {\\n      string first_name = 1;\\n      string last_name = 2;\\n    }\\n\\n    {\\n      \\"@type\\": \\"type.googleapis.com/google.profile.Person\\",\\n      \\"firstName\\": <string>,\\n      \\"lastName\\": <string>\\n    }\\n\\nIf the embedded message type is well-known and has a custom JSON\\nrepresentation, that representation will be embedded adding a field\\n`value` which holds the custom JSON in addition to the `@type`\\nfield. Example (for message [google.protobuf.Duration][]):\\n\\n    {\\n      \\"@type\\": \\"type.googleapis.com/google.protobuf.Duration\\",\\n      \\"value\\": \\"1.212s\\"\\n    }"},"runtimeError":{"type":"object","properties":{"error":{"type":"string","description":"The error name.","example":"Runtime error."},"code":{"type":"integer","format":"int32","description":"The error code.","example":500},"message":{"type":"string","description":"The error message.","example":"Request failed due to an internal server error"},"details":{"type":"array","description":"Any details associated with the error.","items":{"$ref":"#/components/schemas/protobufAny"}}}},"customersv2Label":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"The identifier for the label.","example":1},"customer_id":{"type":"integer","format":"int64","description":"The identifier for the customer that the label applies to.","example":82435920147},"name":{"type":"string","description":"The name of the label.","example":"loyal_cust"},"created_at":{"type":"string","format":"date-time","description":"The date (in [RFC3339 format](https://datatracker.ietf.org/doc/html/rfc3339)) the label was created.","example":"2021-11-04T19:09:55Z"},"updated_at":{"type":"string","format":"date-time","description":"The date (in [RFC3339 format](https://datatracker.ietf.org/doc/html/rfc3339)) the label was updated. If the label was not updated, this value is the same as `created_at`.","nullable":true,"example":"2021-11-04T19:09:55Z"},"deleted_at":{"type":"string","format":"date-time","description":"The date (in [RFC3339 format](https://datatracker.ietf.org/doc/html/rfc3339)) the label was deleted. This value is `null` if the label was never deleted.","nullable":true,"example":null}}},"v2Group":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"The identifier for the group.","example":1},"name":{"type":"string","description":"The name of the group.","example":"active_sub"},"description":{"type":"string","description":"The description of the group.","example":"The customer is a subscriber to a product on this store via Bold Subscriptions"},"shop_identifier":{"type":"string","description":"The unique identifier for the store. Retrieve this information by calling the [Get Shop Info](shops#tag/Shop/operation/GetShopInfo) endpoint.","example":"zp3oafdor9"},"platform_id":{"type":"string","description":"The platform-generated identifier for the group.","example":"group_1_plat"},"created_at":{"type":"string","format":"date-time","description":"The date (in [RFC3339 format](https://datatracker.ietf.org/doc/html/rfc3339)) the group was created.","example":"2021-08-01T20:11:31Z"},"updated_at":{"type":"string","format":"date-time","nullable":true,"description":"The date (in [RFC3339 format](https://datatracker.ietf.org/doc/html/rfc3339)) the group was updated. If the group was not updated, this value is the same as `created_at`."},"deleted_at":{"type":"string","format":"date-time","nullable":true,"description":"The date (in [RFC3339 format](https://datatracker.ietf.org/doc/html/rfc3339)) the group was deleted. This value is `null` if the group was not deleted.","example":null}}},"v2Address":{"type":"object","properties":{"city":{"type":"string","description":"The city name.","example":"Winnipeg"},"province":{"type":"string","description":"The province name.","example":"Manitoba"},"province_code":{"type":"string","description":"The province code (in [ISO-3166 format](https://www.iso.org/iso-3166-country-codes.html)).","example":"MB"},"country":{"type":"string","description":"The country name.","example":"Canada"},"created_at":{"type":"string","format":"date-time","description":"The date (in [RFC3339 format](https://datatracker.ietf.org/doc/html/rfc3339)) the address was created.","example":"2021-11-04T19:09:52Z"},"zip":{"type":"string","description":"The zip/postal code of the address.","example":"R3L0L6"},"address_type":{"type":"string","description":"The type of address (i.e., residential, commercial).","example":"residential"},"platform_customer_id":{"type":"string","description":"The platform-defined identifier for the customer.","example":"1"},"deleted_at":{"type":"string","format":"date-time","description":"The date (in [RFC3339 format](https://datatracker.ietf.org/doc/html/rfc3339)) the address was deleted. This value is `null` if the address was not deleted.","nullable":true,"example":null},"address_use":{"type":"string","description":"The type of address.","enum":["shipping","billing"],"example":"shipping"},"company":{"type":"string","description":"The company name (if applicable).","example":"Acme Inc."},"street_2":{"type":"string","description":"Any additional address details (if applicable).","example":"Suite 200"},"platform_id":{"type":"string","description":"A platform-generated identifier for the address.","example":"address1234"},"shop_identifier":{"type":"string","description":"The unique identifier for the store. Retrieve this information by calling the [Get Shop Info](shops#tag/Shop/operation/GetShopInfo) endpoint.","example":"zp3oafdor9"},"platform_type":{"type":"string","description":"The ecommerce platform associated with the store.","example":"bigcommerce"},"first_name":{"type":"string","description":"The customer\'s first name.","example":"John"},"address_source":{"type":"string","description":"The location the address was created.","enum":["platform","bold"],"example":"platform"},"last_name":{"type":"string","description":"The customer\'s last name.","example":"Doe"},"updated_at":{"type":"string","format":"date-time","description":"The date (in [RFC3339 format](https://datatracker.ietf.org/doc/html/rfc3339)) the address was updated. If this value was not updated, it is set to the same value as `created_at`.","example":"2021-11-04T19:09:52Z"},"phone":{"type":"string","description":"The customer\'s phone number.","example":"2041438851"},"is_default":{"type":"boolean","format":"boolean","description":"Indicates whether the address is set as the customer\'s default.","example":true},"bold_customer_id":{"type":"integer","format":"int64","description":"The unique, Bold-generated identifier for the customer.","example":1423294},"country_iso2":{"type":"string","description":"The country code, in [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) format.","example":"CA"},"street_1":{"type":"string","description":"The street address.","example":"50 Fultz Blvd"},"id":{"type":"integer","format":"int64","description":"The unique, Bold-generated identifier for the address.","example":90235719}}},"v2Customer":{"type":"object","properties":{"tags":{"type":"string","description":"A comma-separated list of tags that describe the customer.","example":"member, 2021"},"deleted_at":{"type":"string","format":"date-time","description":"The date (in [RFC3339 format](https://datatracker.ietf.org/doc/html/rfc3339)) the customer was deleted. This value is `null` if the customer was not deleted.","nullable":true,"example":null},"shop_identifier":{"type":"string","description":"The unique identifier for the store. Retrieve this information by calling the [Get Shop Info](shops#tag/Shop/operation/GetShopInfo) endpoint.","example":"zp3oafdor9"},"platform_created_at":{"type":"string","format":"date-time","description":"The date (in [RFC3339 format](https://datatracker.ietf.org/doc/html/rfc3339)) the customer was created on the platform.","example":"2021-11-04T19:09:52Z"},"id":{"type":"integer","format":"int64","description":"The unique, Bold-generated identifier for the customer.","example":142329453},"platform_type":{"type":"string","description":"The ecommerce platform associated with the store.","example":"bigcommerce"},"last_name":{"type":"string","description":"The customer\'s last name.","example":"Doe"},"first_name":{"type":"string","description":"The customer\'s first name.","example":"John"},"labels":{"type":"array","description":"An array of customer labels.","items":{"$ref":"#/components/schemas/customersv2Label"}},"groups":{"type":"array","description":"An array of groups that the customer belongs to. Groups denote relationships between customer data. Supported for BigCommerce and Shopify only.","items":{"$ref":"#/components/schemas/v2Group"}},"updated_at":{"type":"string","format":"date-time","nullable":true,"description":"The date (in [RFC3339 format](https://datatracker.ietf.org/doc/html/rfc3339)) the customer was updated. If the customer was not updated, this value is the same as `platform_created_at`.","example":"2021-11-04T19:09:52Z"},"phone":{"type":"string","description":"The customer\'s phone number.","example":"2041438851"},"platform_id":{"type":"string","description":"The platform-defined identifier for the customer.","example":"1"},"addresses":{"type":"array","description":"The list of addresses associated with the customer, limited to the first 50 found.","items":{"$ref":"#/components/schemas/v2Address"}},"created_at":{"type":"string","format":"date-time","description":"The date (in [RFC3339 format](https://datatracker.ietf.org/doc/html/rfc3339)) the customer was created.","example":"2021-11-04T19:09:52Z"},"email":{"type":"string","description":"The customer\'s email.","example":"john.doe@example.com"},"default_address":{"$ref":"#/components/schemas/v2Address"}}},"v2CustomerByXIDResponse":{"type":"object","properties":{"customer":{"$ref":"#/components/schemas/v2Customer"}}},"v2PaginationResponse":{"type":"object","description":"The details about the pagination of the response.","properties":{"total":{"type":"integer","description":"The total number of results available.","format":"int32","example":143},"count":{"type":"integer","description":"The number of results returned.","format":"int32","example":143},"per_page":{"type":"integer","description":"The maximum number of results per page.","format":"int32","example":50},"current_page":{"type":"integer","description":"The current page index.","format":"int32","example":2},"total_pages":{"type":"integer","description":"The total number of pages available.","format":"int32","example":3},"next_url":{"type":"string","description":"The cursor to fetch next page of results. The cursor must include the full URL necessary to retrieve the next page, including query parameters.","example":"https://api.boldcommerce.com/customers/v2/shops/zp3oafdor9/customers?page=3"},"previous_url":{"type":"string","description":"The URL to fetch previous page of results. The cursor must include the full URL necessary to retrieve the previous page, including query parameters.","example":"https://api.boldcommerce.com/customers/v2/shops/zp3oafdor9/customers?page=1"}}},"v2CustomerListResponse":{"type":"object","properties":{"pagination":{"$ref":"#/components/schemas/v2PaginationResponse"},"customers":{"type":"array","items":{"$ref":"#/components/schemas/v2Customer"}}}},"v2CustomerJWTValidateResponse":{"type":"object"},"v2AddressGetResponse":{"type":"object","properties":{"address":{"$ref":"#/components/schemas/v2Address"}}},"v2AddressListResponse":{"type":"object","properties":{"addresses":{"type":"array","items":{"$ref":"#/components/schemas/v2Address"}}}}},"examples":{"internalError":{"value":{"code":500,"message":"Request failed due to an internal server error.","type":"server.internal_error"}}}}}},"plugin-redoc-2":{"url":"/api/checkout-backend.openapi.yaml","themeId":"theme-redoc","isSpecFile":true,"spec":{"openapi":"3.0.0","info":{"title":"Checkout Backend","version":"2.0","description":"The Checkout Backend API is used to initialize an order through authenticated requests. This includes the ability to create and manipulate orders in Checkout.\\n\\nRefer to the <a href=\\"https://developer.boldcommerce.com/changelog/tags/checkout-backend\\">changelog</a> for the latest updates to this API.","termsOfService":"https://boldcommerce.com/terms-of-service","contact":{"name":"Contact Us","url":"https://developer-dashboard.boldcommerce.com/default/contactus"}},"servers":[{"url":"https://api.boldcommerce.com"}],"security":[{"OAuthToken":[]},{"APIAccessToken":[]}],"tags":[{"name":"Customers","description":"A child of the Order resource. Contains information about authenticated customers on your store, including name, email, and saved addresses. Use these endpoints to add or remove an authenticated customer to an order."},{"name":"Line Items","description":"A child of the Order resource. Contains information about the product and the taxes, fees, and discounts associated with it. Use these endpoints to update information about one or multiple line items."},{"name":"Orders","description":"Contains information about a single order, including the JWT, order ID, and application state. Use these endpoints to initialize, refresh, or cancel an order."},{"name":"Payments","description":"A child of the Order resource. Contains information about the payments on an order. Use these endpoints to capture partial or full payments."},{"name":"Refunds","description":"Contains information about any refunds applied to the order. Use these endpoints to apply partial or full refunds."}],"externalDocs":{"description":"For more information about Checkout, refer to the Overview.","url":"https://developer.boldcommerce.com/guides/checkout"},"paths":{"/checkout/orders/{shop_identifier}/init":{"parameters":[{"$ref":"#/components/parameters/shop_identifier"}],"post":{"summary":"Initialize Order","operationId":"InitializeOrder","tags":["Orders"],"description":"Initializes an order and retrieves a JWT. You must use the JWT to authorize all requests to the [Checkout Frontend API](checkout).\\n\\nThe request body of this endpoint is flexible \u2014 you can use dynamic data from the platform to provide information about the cart and customer, or leave it blank and populate the order later.\\n\\n**Note:** You must call this endpoint from your backend application. This endpoint returns information that is not safe to share with the frontend application.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"cart_id":{"$ref":"#/components/schemas/CartID"},"access_token":{"$ref":"#/components/schemas/AccessToken"},"cart_items":{"description":"An array of items to add to the cart. Note that the \\"Generic Cart Item\\" type is only supported by BigCommerce, commercetools, and Shopify.","type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/GenericCartItem"},{"$ref":"#/components/schemas/SKUCartItem"},{"$ref":"#/components/schemas/VariantIDCartItem"}]}},"customer":{"$ref":"#/components/schemas/Customer"},"order_meta_data":{"$ref":"#/components/schemas/OrderMetaData"},"resumable_link":{"$ref":"#/components/schemas/ResumableLink"},"flow_id":{"$ref":"#/components/schemas/FlowId"},"api_session_id":{"$ref":"#/components/schemas/ApiSessionId"}}},"examples":{"Cart Token":{"$ref":"#/components/examples/cart_token"},"Generic Cart":{"$ref":"#/components/examples/generic_cart"},"Gift Card Cart":{"$ref":"#/components/examples/gift_card_cart"},"SKU Cart":{"$ref":"#/components/examples/sku_cart"},"Variant ID Cart":{"$ref":"#/components/examples/variant_id_cart"},"Authenticated Customer":{"$ref":"#/components/examples/authenticated_customer"}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"initial_data":{"$ref":"#/components/schemas/InitialData"},"application_state":{"$ref":"#/components/schemas/ApplicationState"},"jwt_token":{"$ref":"#/components/schemas/JWTToken"},"public_order_id":{"$ref":"#/components/schemas/PublicOrderId"},"cart_customer_id":{"type":"string","nullable":true,"description":"The platform ID of an authenticated customer. This value is populated only if you provide a `cart_id` in the Initialize Order request and the customer who created the cart is logged in.\\n\\nNote: This property does not associate the customer with the order. You must still add the customer to the order using the [Create Authenticated Customer](orders#operation/CreateAuthenticatedCustomer) endpoint.","example":"100000009"}}}}}}}}}}},"/checkout/orders/{shop_identifier}/resume":{"parameters":[{"$ref":"#/components/parameters/shop_identifier"}],"post":{"summary":"Resume Order","operationId":"ResumeOrder","tags":["Orders"],"description":"Use this endpoint to resume an existing order, such as one that was previously abandoned.\\n\\nYou can also use this endpoint can also be used to generate a new JWT for an order. Each JWT expires after 60 minutes.","requestBody":{"content":{"application/json":{"schema":{"properties":{"public_order_id":{"$ref":"#/components/schemas/PublicOrderId"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"jwt_token":{"$ref":"#/components/schemas/JWTToken"},"initial_data":{"$ref":"#/components/schemas/InitialData"},"application_state":{"$ref":"#/components/schemas/ApplicationState"},"public_order_id":{"$ref":"#/components/schemas/PublicOrderId"}}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"example-1":{"value":{"message":"The public order id field is required.","type":"authorization","field":"public_order_id","severity":"validation","sub_type":""}}}}}}}}},"/checkout/orders/{shop_identifier}/create":{"parameters":[{"$ref":"#/components/parameters/shop_identifier"}],"post":{"summary":"Create Order","operationId":"CreateOrder","tags":["Orders"],"description":"Use this endpoint to create and process a full order without additional API interaction. You can also use this endpoint to create a portion of an order, to be completed at a later time.\\n\\nFor more information about using this endpoint, refer to [Programmatically Create an Order](/guides/checkout/create-order).","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"idempotency_key":{"type":"string","description":"A unique identifier for this transaction. If the API receives multiple requests with the same key, it always picks up where it left off, and no duplicate orders are created."},"cart_id":{"$ref":"#/components/schemas/CartID"},"access_token":{"$ref":"#/components/schemas/AccessToken"},"cart_items":{"description":"Array of items to add to the cart. If using in conjunction with `cart_id`, these items will be added to the existing cart alongside existing items in the cart.","type":"array","items":{"allOf":[{"anyOf":[{"$ref":"#/components/schemas/GenericCartItem"},{"$ref":"#/components/schemas/SKUCartItem"},{"$ref":"#/components/schemas/VariantIDCartItem"}]},{"type":"object","properties":{"fees":{"type":"array","minItems":0,"items":{"type":"object","properties":{"description":{"type":"string","description":"A human-readable description of the fee that can be displayed in a user interface."},"type":{"type":"string","enum":["fixed","percentage"],"description":"The type of the fee applied to the line item."},"value":{"type":"integer","description":"The fee amount to apply to the line item.\\n* For `\\"fixed\\"` fees, represent the value in base currency units, using [ISO-4217](https://www.iso.org/iso-4217-currency-codes.html) standards.\\n* For `\\"percentage\\"` fees, represent the value as a percentage of the line item amount between 0 and 100.\\n"},"taxable":{"type":"boolean","description":"Indicates whether to include the fee should be included in the line item total when calculating taxes."},"taxes":{"type":"array","description":"Pre-calculated taxes to be applied to the line item fee.","minItems":0,"items":{"$ref":"#/components/schemas/Tax"}}},"required":["description","type","value"]}},"taxes":{"type":"array","description":"Pre-calculated taxes to be applied to the line item.","minItems":0,"items":{"$ref":"#/components/schemas/Tax"}}}}]}},"customer":{"$ref":"#/components/schemas/Customer"},"shipping_address":{"$ref":"#/components/schemas/Address"},"billing_address":{"$ref":"#/components/schemas/Address"},"shipping_line":{"type":"object","description":"The order\'s shipping information.","properties":{"rate_name":{"type":"string","description":"A human-readable description of the shipping line that can be displayed in a user interface."},"cost":{"type":"number","minimum":0,"description":"Cost of the shipping line in base currency units, using [ISO-4217](https://www.iso.org/iso-4217-currency-codes.html) standards."},"taxes":{"type":"array","minItems":0,"description":"Pre-calculated taxes to be applied to the shipping cost.","items":{"$ref":"#/components/schemas/Tax"}}},"required":["rate_name","cost"]},"discounts":{"$ref":"#/components/schemas/Discounts"},"fees":{"type":"array","description":"The fees applied to order. Note that order-level fees are only supported by Shopify and custom platforms.","items":{"type":"object","properties":{"id":{"type":"string","description":"A unique identifier to the fee."},"description":{"type":"string","description":"A human-readable description of the fee that can be displayed in a user interface."},"type":{"type":"string","enum":["fixed","percentage"],"description":"The type of the fee applied to the order."},"value":{"type":"integer","description":"The fee amount to apply to the order.\\n* For `\\"fixed\\"` fees, represent the value in base currency units, using [ISO-4217](https://www.iso.org/iso-4217-currency-codes.html) standards.\\n* For `\\"percentage\\"` fees, represent the value as a percentage of the order subtotal between 0 and 100.\\n"}},"required":["id","description","type","value"]}},"payments":{"type":"array","description":"An array of payments to apply to the order. Bold first processes payments with amounts, followed by those without amounts. Within these groups, payments are applied in the order they are received, and Bold stops processing payments when the order total is reached.","items":{"allOf":[{"anyOf":[{"title":"Customer default payment method","type":"object","properties":{"public_customer_id":{"type":"string","description":"Public identifier of the customer. The customer\'s default payment method is used for payment."}},"required":["public_customer_id"]},{"title":"Payment method","type":"object","properties":{"public_payment_method_id":{"type":"string","description":"Public identifier of the payment method."}},"required":["public_payment_method_id"]}]},{"type":"object","properties":{"amount":{"type":"number","description":"Amount to charge on a particular payment, up to the order total, represented in base currency units, using [ISO-4217](https://www.iso.org/iso-4217-currency-codes.html) standards. Defaults to order total."}}}]}},"currency":{"type":"string","description":"Currency code for the order, using [ISO-4217](https://www.iso.org/iso-4217-currency-codes.html) standards. If none is given, the store default will be used."},"order_meta_data":{"$ref":"#/components/schemas/OrderMetaData"},"commands":{"type":"object","description":"A list of commands for Bold Checkout to perform on the created order, with integer keys. Bold executes these commands in sorted order based on keys.","additionalProperties":{"type":"string","enum":["calculate_shipping","calculate_tax_rates","authorize_payments","process_order","send_to_platform","charge_payments"]}},"flow_id":{"$ref":"#/components/schemas/FlowId"},"api_session_id":{"$ref":"#/components/schemas/ApiSessionId"}},"required":["idempotency_key"]},"examples":{"Create and Process Order using Bold Checkout Calculations and Item SKUs":{"value":{"cart_items":[{"sku":"KLS_472945","quantity":2,"line_item_key":"db3b1963-6ddd-4115-9f45-64c7edb3867d","line_item_properties":{"colour":"red","size":"small"}}],"customer":{"first_name":"Robert","last_name":"Walsh","email_address":"rwalsh24@example.com","accepts_marketing":false,"public_id":"6xID7o9hrxQ7bkVIKvCxXPD7Cf3P4BP141wplqPTa3CYYwEqM5X9w7JzKWulQe4p"},"shipping_address":{"first_name":"Robert","last_name":"Walsh","address_line_1":"2652 John Daniel Drive","city":"Dexter","province":"Missouri","province_code":"MO","country":"United States of America","country_code":"US","postal_code":"63841"},"billing_address":{"first_name":"Robert","last_name":"Walsh","address_line_1":"2652 John Daniel Drive","city":"Dexter","province":"Missouri","province_code":"MO","country":"United States of America","country_code":"US","postal_code":"63841"},"discounts":[{"discount_code":"SPRINGSALE2022_Q8RT4"}],"payments":[{"public_payment_method_id":"ftziZRlloXJhR8emShyZePgaZxFTp9TN6Ai0tVWOB223g9qCGQQFA27ccW2fx72U"}],"currency":"USD","idempotency_key":"2b268b6f-b3c0-4efb-9c43-1aa59d535182","commands":{"0":"calculate_shipping","1":"calculate_tax_rates","2":"authorize_payments","3":"process_order","4":"send_to_platform","5":"charge_payments"}}},"Create and Process Order with Precalculated Taxes, Fees, and Shipping":{"value":{"cart_items":[{"id":9563957,"quantity":1,"title":"AAA Batteries, 12-pack","weight":200,"requires_shipping":true,"price":1657,"line_item_key":"eebfc1ec-7736-4180-9d8d-28f4a5fcd841","line_item_properties":{"colour":"red","size":"small"},"fees":[{"description":"Eco-fee","type":"fixed","value":24,"taxes":[{"name":"GST","rate":5},{"name":"PST","rate":7}]}],"taxes":[{"name":"GST","rate":5},{"name":"PST","rate":7}]}],"customer":{"first_name":"Alicia","last_name":"Hobbes","email_address":"alicia.hobbes@example.com","accepts_marketing":false,"public_id":"t8xFvAFG4cAuv3MxsTR66QFKBdOM3dxYJxvDd9EmjVBZJ0opN8Jomg0VEA3zUltc"},"shipping_address":{"first_name":"Alicia","last_name":"Hobbes","address_line_1":"4139 Nelson Street","city":"Ottawa","province":"Ontario","province_code":"ON","country":"Canada","country_code":"CA","postal_code":"K1N7W4"},"billing_address":{"first_name":"Alicia","last_name":"Hobbes","address_line_1":"2070 Bank Street","address_line_2":"PO Box 153","city":"Ottawa","province":"Ontario","province_code":"ON","country":"Canada","country_code":"CA","postal_code":"K2P2N2"},"shipping_line":{"rate_name":"Express Ground","cost":2550,"taxes":[{"name":"GST","rate":5},{"name":"PST","rate":7}]},"discounts":[{"discount_code":"TENPERCENTOFF"}],"fees":[{"id":"VEA3zUltc","description":"Order-fee","type":"fixed","value":24}],"payments":[{"public_payment_method_id":"ftziZRlloXJhR8emShyZePgaZxFTp9TN6Ai0tVWOB223g9qCGQQFA27ccW2fx72U"}],"currency":"CAD","idempotency_key":"36f6c1c1-9e93-4eb9-be06-bcfee5fd7b44","commands":{"0":"authorize_payments","1":"process_order","2":"send_to_platform","3":"charge_payments"}}},"Create draft order with Platform Variant IDs":{"value":{"cart_items":[{"platform_id":993746,"quantity":1,"line_item_key":"10f0be4b-9ffb-4a75-bfe2-6486a0abd793","line_item_properties":{"colour":"red","size":"small"}}],"customer":{"email_address":"shopaholic135@example.com"},"shipping_address":{"first_name":"Charles","last_name":"Barker","address_line_1":"1 Water Street","city":"Redwood Meadows","province":"Alberta","province_code":"AB","country":"Canada","country_code":"CA","postal_code":"T3Z3J2"},"billing_address":{"first_name":"Charles","last_name":"Barker","address_line_1":"1 Water Street","city":"Redwood Meadows","province":"Alberta","province_code":"AB","country":"Canada","country_code":"CA","postal_code":"T3Z3J2"},"idempotency_key":"ef0cd190-c439-4eb7-9e6d-8d5b4090302e"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"application_state":{"$ref":"#/components/schemas/ApplicationState"},"public_order_id":{"type":"string","example":"o10KL4Crlb8Lh4zg4t5kImS6CFvdFI1t5Aybxlor1B52GDGAZvn6X85wy6oDfWZP"}}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","minItems":0,"items":{"$ref":"#/components/schemas/ErrorV2"}}}}}}}}}},"/checkout/orders/{shop_identifier}/{public_order_id}/customer":{"parameters":[{"$ref":"#/components/parameters/shop_identifier"},{"$ref":"#/components/parameters/public_order_id"}],"delete":{"summary":"Delete Customer","operationId":"DeleteCustomer","tags":["Customers"],"description":"Deletes the customer from the order.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"application_state":{"$ref":"#/components/schemas/ApplicationState"}}}}},"examples":{"Deleted Customer":{"$ref":"#/components/examples/NoCustomer"}}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnprocessableEntity"},"examples":{"example-1":{"value":{"message":"The public_order_id field is required.","type":"order","field":"public_order_id","severity":"validation","sub_type":"customer"}}}}}}}}},"/checkout/orders/{shop_identifier}/{public_order_id}/customer/authenticated":{"parameters":[{"$ref":"#/components/parameters/shop_identifier"},{"$ref":"#/components/parameters/public_order_id"}],"post":{"summary":"Create Authenticated Customer","operationId":"CreateAuthenticatedCustomer","tags":["Customers"],"description":"Creates a new authenticated customer.\\n\\nYou cannot create a customer when a customer already exists on the order.\\n\\nIf you wish to add a new authenticated customer to an order, you must first delete the existing customer using the [Delete Customer](checkout#operation/DeleteCustomer) endpoint.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticatedCustomerBody"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"customer":{"$ref":"#/components/schemas/Customer"},"application_state":{"$ref":"#/components/schemas/ApplicationState"}}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnprocessableEntity"},"examples":{"example-1":{"value":{"message":"The email address field is required.","type":"order","field":"email_address","severity":"validation","sub_type":"customer"}}}}}}}}},"/checkout/orders/{shop_identifier}/{public_order_id}/cancel":{"parameters":[{"$ref":"#/components/parameters/shop_identifier"},{"$ref":"#/components/parameters/public_order_id"}],"post":{"summary":"Cancel Order","operationId":"CancelOrder","tags":["Orders"],"description":"Cancels an order, voiding any held authorizations. This endpoint fails if the order is already fulfilled or any payments were captured.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"reason":{"description":"An optional order cancellation reason.","type":"string","example":"Duplicate order."}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"application_state":{"$ref":"#/components/schemas/ApplicationState"}}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorV2"},"examples":{"Payment already captured":{"value":{"code":"02-92","type":"order.order_in_non_cancellable_state","message":"Cannot cancel order with captured payments."}},"Order already fulfilled":{"value":{"code":"02-92","type":"order.order_in_non_cancellable_state","message":"Cannot cancel order, already fulfilled."}}}}}}}}},"/checkout/orders/{shop_identifier}/{public_order_id}/payments/capture":{"parameters":[{"$ref":"#/components/parameters/shop_identifier"},{"$ref":"#/components/parameters/public_order_id"}],"post":{"summary":"Capture Payment for Arbitrary Amount","operationId":"CapturePaymentForArbitraryAmount","description":"Captures a payment for the amount specified against the order total (shipping, taxes, etc., included).","tags":["Payments"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CapturePaymentResponse"},"example":{"data":{"order_total":1200,"amount_remaining":600,"paid_total":600,"captured_held_total":0,"transactions":[{"gateway":"Stripe Default Name","gateway_id":"bFH0RUdnWPFPRxmWfK6B1yXi61Hh0svIBTrk1vtGoI1zPYVXntIqMX82pqdrSYhi","amount":600,"transaction_id":"ch_1GvDW4JhIKSKpq8w9SoshRef","reference_transaction_id":null,"response_code":"","status":"success"}]}}}}},"202":{"description":"Order has been accepted but payments are held for capture by the payment gateway. Will complete processing order once payment gateway has captured the payment.","x-summary":"Order Accepted, Payment Held By Gateway","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorV2"},"examples":{"HeldForReview":{"value":{"code":"02-21","type":"checkout.order_charge_failed","message":"Payment held for review for order 1444","details":{}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorV2"},"examples":{"NotEnoughFunds":{"value":{"code":"02-50","type":"checkout.api_validation_failed","message":"Not enough funds left to capture requested amount","details":{"order_total":2500,"total_paid":1121,"amount_left_to_capture":1379,"attempted_capture_amount":500000}}},"NoAuthorizeTransaction":{"value":{"code":"02-44","type":"checkout.api_payment_capture_failed","message":"No authorize transaction found to capture","details":{"order_total":2500,"total_paid":2000,"amount_remaining":500}}},"TransactionFailed":{"value":{"code":"02-44","type":"checkout.api_payment_capture_failed","message":"API token mismatch:{\\"code\\":0,\\"error\\":\\"processor_declined\\",\\"field\\":\\"cc_number\\",\\"message\\":\\"API token mismatch\\",\\"service\\":\\"credit_card.moneris\\",\\"severity\\":\\"critical\\",\\"side\\":\\"cashier\\",\\"type\\":\\"payment_gateway\\",\\"details\\":\\"\\"}","details":{"order_total":2500,"total_paid":500,"amount_remaining":2000,"gateway":"Moneris","attempted_capture_amount":500,"reference_transaction_id":""}}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CapturePartialPaymentRequest"},"examples":{"FullAmountProvided":{"value":{"amount":1200,"reauth":true,"idempotent_key":"2b268b6f-b3c0-4efb-9c43-1aa59d535182","capture_data":{"data":{"external_id":"legacy-id-135798642"}}}},"PartialAmountProvided":{"value":{"amount":600,"reauth":true,"idempotent_key":"2b268b6f-b3c0-4efb-9c43-1aa59d535182","capture_data":{"data":{"external_id":"legacy-id-135798642"}}}}}}}}}},"/checkout/orders/{shop_identifier}/{public_order_id}/payments/sale/{payment_id}":{"parameters":[{"$ref":"#/components/parameters/shop_identifier"},{"$ref":"#/components/parameters/public_order_id"},{"$ref":"#/components/parameters/payment_id"}],"post":{"summary":"Capture Specific Payment","operationId":"CaptureSpecificPayment","description":"Manually authorizes and charges the amount specified to a payment on the order. The payment must have an `awaitingPreAuth` status. The payment is applied against the order total (including shipping, taxes, etc.).\\n\\nThis endpoint enables you to delay the payment capture process. Normally, Bold Checkout adds payments to the order with a `preAuthed` status, indicating they have already been authorized for the given amount. When Bold is set up to only verify the payments, each payment is added to the order with a `awaitingPreAuth` status.\\n\\n>> **Notes:**\\n>> - Reach out to the [Support Team](https://support.boldcommerce.com/hc/en-us/requests/new?ticket_form_id=1900000280347) with a request to enable \\"only verify payments\\" functionality.\\n>> - Supported for Braintree and [External Payment Gateways](/guides/checkout/checkout-epg-guide) only.","tags":["Payments"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CapturePaymentResponse"},"example":{"data":{"order_total":1200,"amount_remaining":600,"paid_total":600,"captured_held_total":0,"transactions":[{"gateway":"Stripe Default Name","gateway_id":"bFH0RUdnWPFPRxmWfK6B1yXi61Hh0svIBTrk1vtGoI1zPYVXntIqMX82pqdrSYhi","amount":600,"transaction_id":"ch_1GvDW4JhIKSKpq8w9SoshRef","reference_transaction_id":null,"response_code":"","status":"success"}]}}}}},"202":{"description":"The order was accepted, but payments are held for capture by the payment gateway. Bold completes processing the order once the payment gateway captures the payment.","x-summary":"Order Accepted, Payment Held By Gateway","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorV2"},"examples":{"HeldForReview":{"value":{"code":"02-21","type":"checkout.order_charge_failed","message":"Payment held for review for order 1444","details":{}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorV2"},"examples":{"NotEnoughFunds":{"value":{"code":"02-50","type":"checkout.api_validation_failed","message":"Not enough funds left to capture requested amount","details":{"order_total":2500,"total_paid":1121,"amount_left_to_capture":1379,"attempted_capture_amount":500000}}},"NoAuthorizeTransaction":{"value":{"code":"02-44","type":"checkout.api_payment_capture_failed","message":"No authorize transaction found to capture","details":{"order_total":2500,"total_paid":2000,"amount_remaining":500}}},"TransactionFailed":{"value":{"code":"02-44","type":"checkout.api_payment_capture_failed","message":"API token mismatch:{\\"code\\":0,\\"error\\":\\"processor_declined\\",\\"field\\":\\"cc_number\\",\\"message\\":\\"API token mismatch\\",\\"service\\":\\"credit_card.moneris\\",\\"severity\\":\\"critical\\",\\"side\\":\\"cashier\\",\\"type\\":\\"payment_gateway\\",\\"details\\":\\"\\"}","details":{"order_total":2500,"total_paid":500,"amount_remaining":2000,"gateway":"Moneris","attempted_capture_amount":500,"reference_transaction_id":""}}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CapturePartialPaymentRequest"},"examples":{"FullAmountProvided":{"value":{"amount":1200,"reauth":true,"idempotent_key":"2b268b6f-b3c0-4efb-9c43-1aa59d535182","capture_data":{"data":{"external_id":"legacy-id-135798642"}}}},"PartialAmountProvided":{"value":{"amount":600,"reauth":true,"idempotent_key":"2b268b6f-b3c0-4efb-9c43-1aa59d535182","capture_data":{"data":{"external_id":"legacy-id-135798642"}}}}}}}}}},"/checkout/orders/{shop_identifier}/{public_order_id}/payments/capture/full":{"parameters":[{"$ref":"#/components/parameters/shop_identifier"},{"$ref":"#/components/parameters/public_order_id"}],"post":{"summary":"Capture Payment for Full Order Amount","operationId":"CapturePaymentForFullOrderAmount","tags":["Payments"],"description":"Captures a payment for the full order total amount (including shipping, taxes, etc).","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CapturePaymentResponse"},"example":{"data":{"order_total":1200,"amount_remaining":600,"paid_total":600,"captured_held_total":0,"transactions":[{"gateway":"Stripe Default Name","gateway_id":"bFH0RUdnWPFPRxmWfK6B1yXi61Hh0svIBTrk1vtGoI1zPYVXntIqMX82pqdrSYhi","amount":600,"transaction_id":"ch_1GvDW4JhIKSKpq8w9SoshRef","reference_transaction_id":null,"response_code":"","status":"success"}]}}}}},"202":{"description":"The Order has been accepted, but the payment gateway is holding the payments for capture. The request will complete when the payment gateway captures the payments.","x-summary":"Order Accepted, Payment Held By Gateway","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorV2"},"examples":{"HeldForReview":{"value":{"code":"02-21","type":"checkout.order_charge_failed","message":"Payment held for review for order 1444","details":{}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorV2"},"examples":{"NotEnoughFunds":{"value":{"code":"02-50","type":"checkout.api_validation_failed","message":"No funds left to capture on this order","details":{"order_total":2500,"total_paid":2500,"amount_left_to_capture":0}}},"NoAuthorizeTransaction":{"value":{"code":"02-44","type":"checkout.api_payment_capture_failed","message":"No authorize transaction found to capture","details":{"order_total":2500,"total_paid":0,"amount_remaining":2500}}},"TransactionFailed":{"value":{"code":"02-44","type":"checkout.api_payment_capture_failed","message":"API token mismatch:{\\"code\\":0,\\"error\\":\\"processor_declined\\",\\"field\\":\\"cc_number\\",\\"message\\":\\"API token mismatch\\",\\"service\\":\\"credit_card.moneris\\",\\"severity\\":\\"critical\\",\\"side\\":\\"cashier\\",\\"type\\":\\"payment_gateway\\",\\"details\\":\\"\\"}","details":{"order_total":2500,"total_paid":0,"amount_remaining":2500,"gateway":"Moneris","attempted_capture_amount":2500,"reference_transaction_id":""}}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CapturePaymentRequest"},"examples":{"AmountProvided":{"value":{"reauth":true,"idempotent_key":"2b268b6f-b3c0-4efb-9c43-1aa59d535182","capture_data":{"data":{"external_id":"legacy-id-135798642"}}}}}}}}}},"/checkout/orders/{shop_identifier}/{public_order_id}/payments/auth/full":{"parameters":[{"$ref":"#/components/parameters/shop_identifier"},{"$ref":"#/components/parameters/public_order_id"}],"post":{"summary":"Authorize Payments","operationId":"AuthorizePayments","tags":["Payments"],"description":"Authorizes all payments on the order. Payments must be present on the order before calling this endpoint. When this endpoint is called, Bold Checkout calls the appropriate payment gateways to authorize all payments on the order.\\n\\nIf one payment fails authorization, Bold refunds or voids all payments on the order.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"total":{"description":"The total amount authorized, represented in base currency units, using [ISO-4217](https://www.iso.org/iso-4217-currency-codes.html) standards.","type":"number","example":1000},"transactions":{"type":"array","items":{"$ref":"#/components/schemas/AuthTransaction"}}}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ErrorV2"},{"$ref":"#/components/schemas/AuthorizationFailure"}]},"examples":{"NotEnoughFunds":{"value":{"code":"02-43","type":"payments.insufficient_payments_for_order_balance","message":"There are insufficient payments on the order to cover the order total","details":{}}},"AuthorizationFailure":{"value":{"code":"02-43","type":"payments.payment_authorization_failure","message":"payments.payment_authorization_failure","transactions":[{"gateway":"Stripe Default Name","payment_id":123,"amount":600,"transaction_id":"ch_1GvDW4JhIKSKpq8w9SoshRef","currency":"USD","step":"FAILED","status":"failed","tender_type":"credit_card","tender_details":{"brand":"Visa","last_four":"1881","bin":"401288","expiration":"12/2025"},"gateway_response_data":[]}]}}}}}}}}},"/checkout/orders/{shop_identifier}/{public_order_id}/refunds":{"parameters":[{"$ref":"#/components/parameters/shop_identifier"},{"$ref":"#/components/parameters/public_order_id"}],"post":{"summary":"Issue Refund for Arbitrary Amount","operationId":"IssueRefundForArbitraryAmount","tags":["Refunds"],"description":"Issues a refund for the amount specified against any captured transactions on the order. Notifies the connected stock inventory service to restock the returned line items, if applicable.\\n\\nThis endpoint does not perform any currency conversions.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefundComboResponse"},"examples":{"ExamplePartialRefund":{"value":{"data":{"amount_refunded":6055,"transaction_details":[{"success":true,"amount":6055,"transaction_number":"ch_1GvDW4JhIKSKpq8w9SoshRef","created_at":"2021-01-15 01:01:01"}]}}}}}}},"207":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefundComboResponse"},"examples":{"ExamplePartialRefund":{"value":{"data":{"refund":{"refunded_amount":3580,"transaction_details":{"success":true,"transaction_number":"87760f48","amount":35.8,"created_at":"2024-10-30 17:54:19"}}},"errors":{"code":"02-41","type":"checkout.api_sending_order_to_platform_failed","message":"Full refund was successful but couldn\'t push to platform.","details":{"exception":"Refund failed for an unknown reason"}}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorV2"},"examples":{"FailedPaymentGatewayAttempts":{"value":{"code":"02-28","type":"checkout.order_refund_failed","message":"Attempted to refund 2 transactions on payment gateway but none succeeded.","details":{}}},"FailedToPushToPlatform":{"value":{"code":"02-41","type":"checkout.api_sending_order_to_platform_failed","message":"Full refund was successful but couldn\'t push to platform.","details":{}}}}},"application/xml":{"schema":{"type":"object","properties":{}}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefundRequest"},"examples":{"BrokenProduct":{"value":{"amount":6055,"reason":"Product arrived broken.","email_notification":true,"refund_meta_data":{"data":{"external_id":"legacy-id-135798642"}}}}}}}}}},"/checkout/orders/{shop_identifier}/{public_order_id}/refunds/{payment_id}":{"parameters":[{"$ref":"#/components/parameters/shop_identifier"},{"$ref":"#/components/parameters/public_order_id"},{"$ref":"#/components/parameters/payment_id"}],"post":{"summary":"Refund a Specific Payment for an Arbitrary Amount","operationId":"IssuePaymentRefundForArbitraryAmount","tags":["Refunds"],"description":"Issues a refund for the amount specified against a specific transaction on the order, identified by the `payment_id`. Notifies the connected stock inventory service to restock the returned line items, if applicable.\\n\\nThis endpoint does not perform any currency conversions.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefundResponse"},"examples":{"ExamplePartialRefund":{"value":{"data":{"amount_refunded":6055,"transaction_details":[{"success":true,"amount":6055,"transaction_number":"ch_1GvDW4JhIKSKpq8w9SoshRef","created_at":"2021-01-15 01:01:01"}]}}}}}}},"207":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefundComboResponse"},"examples":{"ExamplePartialRefund":{"value":{"data":{"refund":{"refunded_amount":3580,"transaction_details":{"success":true,"transaction_number":"87760f48","amount":35.8,"created_at":"2024-10-30 17:54:19"}}},"errors":{"code":"02-41","type":"checkout.api_sending_order_to_platform_failed","message":"Full refund was successful but couldn\'t push to platform.","details":{"exception":"Refund failed for an unknown reason."}}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorV2"},"examples":{"FailedPaymentGatewayAttempts":{"value":{"code":"02-28","type":"checkout.order_refund_failed","message":"Attempted to refund 2 transactions on payment gateway but none succeeded.","details":{}}},"FailedToPushToPlatform":{"value":{"code":"02-41","type":"checkout.api_sending_order_to_platform_failed","message":"Full refund was successful but couldn\'t push to platform.","details":{}}}}},"application/xml":{"schema":{"type":"object","properties":{}}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefundRequest"},"examples":{"BrokenProduct":{"value":{"amount":6055,"reason":"Product arrived broken.","email_notification":true,"refund_meta_data":{"data":{"external_id":"legacy-id-135798642"}}}}}}}}}},"/checkout/orders/{shop_identifier}/{public_order_id}/refunds/full":{"parameters":[{"$ref":"#/components/parameters/shop_identifier"},{"$ref":"#/components/parameters/public_order_id"}],"post":{"summary":"Issue Refund for Full Order Amount","operationId":"IssueRefundForFullOrderAmount","tags":["Refunds"],"description":"Issues a refund for the entire order, including shipping and taxes. Notifies the connected stock inventory service to restock the returned line items, if applicable.\\n\\nThis endpoint does not perform any currency conversions.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefundResponse"},"examples":{"ExampleFullRefund":{"value":{"data":{"amount_refunded":6055,"transaction_details":[{"success":true,"amount":6055,"transaction_number":"ch_1GvDW4JhIKSKpq8w9SoshRef","created_at":"2021-01-15 01:01:01"}]}}}}}}},"207":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefundComboResponse"},"examples":{"ExamplePartialRefund":{"value":{"data":{"refund":{"refunded_amount":3580,"transaction_details":{"success":true,"transaction_number":"87760f48","amount":35.8,"created_at":"2024-10-30 17:54:19"}}},"errors":{"code":"02-41","type":"checkout.api_sending_order_to_platform_failed","message":"Full refund was successful but couldn\'t push to platform.","details":{"exception":"Refund failed for an unknown reason."}}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorV2"},"examples":{"FailedPaymentGatewayAttempts":{"value":{"code":"02-28","type":"order_refund_failed","message":"Attempted to refund 2 transactions on payment gateway but none succeeded.","details":{}}},"FailedToPushToPlatform":{"value":{"code":"02-41","type":"api_sending_order_to_platform_failed","message":"Full refund was successful but couldn\'t push to platform.","details":{}}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefundRequestFull"},"examples":{"BrokenProduct":{"value":{"reason":"Product arrived broken.","email_notification":true,"refund_meta_data":{"data":{"external_id":"legacy-id-135798642"}}}}}}}}}},"/checkout/orders/{shop_identifier}/{public_order_id}/line_items/{line_item_key}":{"parameters":[{"$ref":"#/components/parameters/shop_identifier"},{"$ref":"#/components/parameters/public_order_id"},{"schema":{"$ref":"#/components/schemas/LineItemKey"},"name":"line_item_key","in":"path","required":true}],"patch":{"summary":"Update Line Item","operationId":"UpdateLineItem","tags":["Line Items"],"description":"Updates the `fulfilled_quantity` property of a single line item.\\n\\nFor more information, refer to the [Fulfill an Order guide](/guides/checkout/fulfill-order).","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"line_item":{"$ref":"#/components/schemas/LineItem"},"application_state":{"$ref":"#/components/schemas/ApplicationState"}}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorV2"},"examples":{"LineItemKeyMissing":{"value":{"code":"11-13","type":"line_items","message":"The line item key field is required.","details":null}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchLineItem"}}}}}},"/checkout/orders/{shop_identifier}/{public_order_id}/line_items":{"parameters":[{"$ref":"#/components/parameters/shop_identifier"},{"$ref":"#/components/parameters/public_order_id"}],"patch":{"summary":"Update Line Items","operationId":"UpdateLineItems","tags":["Line Items"],"description":"Updates the `fulfilled_quantity` property of multiple line items.\\n\\nFor more information, refer to the [Fulfill an Order guide](/guides/checkout/fulfill-order).","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"line_items":{"type":"array","items":{"$ref":"#/components/schemas/LineItem"}},"application_state":{"$ref":"#/components/schemas/ApplicationState"}}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorV2"},"examples":{"LineItemKeyMissing":{"value":{"code":"11-13","type":"line_items","message":"The line item key field is required.","details":null}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"line_items":{"type":"array","items":{"allOf":[{"type":"object","properties":{"line_item_key":{"$ref":"#/components/schemas/LineItemKey"}},"required":["line_item_key"]},{"$ref":"#/components/schemas/PatchLineItem"}]}}}},"examples":{"Set fulfilled quantity of multiple items":{"value":{"line_items":[{"fulfilled_quantity":1,"line_item_key":"oak_cheese_grater_2643"},{"fulfilled_quantity":3,"line_item_key":"oak_cheese_grater_3000"}]}}}}}}}}},"components":{"securitySchemes":{"OAuthToken":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://apps.boldapps.net/accounts/dashboard/authorize","tokenUrl":"https://api.boldcommerce.com/auth/oauth2/token","scopes":{}}},"description":"Authenticates an API request from a [public integration](/guides/checkout/resources/glossary#public-integration). Generate this token in the [Developer Dashboard](https://developer-dashboard.boldcommerce.com/default/dashboard). Refer to [Build Public Integrations](/default/guides/checkout/public-integrations) for more information."},"APIAccessToken":{"type":"apiKey","name":"API Access Token","in":"header","description":"Authenticates an API request from a [private integration](/guides/checkout/resources/glossary#private-integration). Generate this token in the [Bold Account Center](https://account.boldcommerce.com/). Refer to [Making API Calls](/guides/checkout/quick-start) for more information."}},"parameters":{"shop_identifier":{"schema":{"type":"string","example":"zp3oafdor9"},"name":"shop_identifier","in":"path","required":true,"description":"The identifier of the shop, which can be retrieved by making a request to the [Get Info](shops#operation/GetShopInfo) endpoint."},"public_order_id":{"schema":{"type":"string","example":"woiph4vhqss9jjr50lR5am7IWurQ8FdbmtdOj4aaFIOfFiFGcvhY6x1t6eT0GoB"},"name":"public_order_id","in":"path","required":true,"description":"The public order id generated when the order is initialized by making a request to the [Initialize Order](orders#operation/InitializeOrder) endpoint."},"payment_id":{"schema":{"type":"string","example":"woiph4vhqss9jjr50lR5am7IWurQ8FdbmtdOj4aaFIOfFiFGcvhY6x1t6eT0GoB"},"name":"payment_id","in":"path","required":true,"description":"The identifier assigned to each unique payment."}},"schemas":{"AuthenticatedCustomerBody":{"title":"Authenticated Customer Body","type":"object","description":"The request payload to create a new authenticated customer.","properties":{"platform_id":{"type":"string","description":"The platform identifier for an authenticated customer. For guest customers, the value for this property will be null.","nullable":true,"example":"50942578465125"},"public_id":{"type":"string","description":"The public identifier generated by Checkout for a customer.","nullable":true,"example":"pjpTyGh8KzNQ225wPqxgy7LwNuC887h6ecGyp3omwT4XW8SszjVSdHzWHN4NBwqhA"},"first_name":{"type":"string","description":"The customer\'s first name.","example":"John"},"last_name":{"type":"string","description":"The customer\'s last name.","example":"Doe"},"email_address":{"type":"string","description":"The customer\'s email address.","example":"john.doe@example.com"},"accepts_marketing":{"type":"boolean","description":"If the customer would like to receive any sort of marketing emails. Defaults to `false`.","default":false,"example":false}},"required":["email_address","platform_id"]},"SKUCartItem":{"title":"SKU Cart Item","type":"object","description":"Cart item based of the product SKU. Product data must be synced with Bold Checkout to work.","properties":{"sku":{"type":"string"},"quantity":{"type":"integer"},"line_item_key":{"$ref":"#/components/schemas/LineItemKey"},"line_item_properties":{"$ref":"#/components/schemas/LineItemProperty"}},"required":["sku","quantity","line_item_key"]},"VariantIDCartItem":{"title":"Variant ID Cart Item","type":"object","description":"A cart item based off a platform product model. The identifier is unique to the particular platform. For Shopify, it is a variant ID.","properties":{"platform_id":{"description":"The ID of a product variant.","type":"string","example":"1235235"},"quantity":{"type":"integer","description":"The quantity of the item in the cart.","example":2},"line_item_key":{"$ref":"#/components/schemas/LineItemKey"},"line_item_properties":{"$ref":"#/components/schemas/LineItemProperty"}},"required":["platform_id","quantity","line_item_key"]},"AccessToken":{"type":"string","description":"An optional string token that you can pass to the platform. For example, use this field if your platform requires an authentication token to retrieve cart information (commercetools).","example":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"},"CartID":{"type":"string","description":"Identifier of an existing cart to load from the platform. This field is unsupported when using a custom platform.","example":"1snVSJAWYWWYhfLWq9ABcXMwx8mcvh2U"},"GenericCartItem":{"title":"Generic Cart Item","type":"object","description":"An array of items to add to the cart. Generic cart items are items that are not created in the platform, and the product data is added to the order by Bold. Generic cart items are supported on BigCommerce, commercetools, and Shopify stores only.","properties":{"quantity":{"type":"integer","description":"The quantity of the cart item.","example":1},"title":{"type":"string","description":"The item title to display.","example":"Oak Cheese Grater"},"weight":{"type":"integer","description":"Weight of the item in grams.","example":1000},"taxable":{"type":"boolean","description":"Indicates whether the item is taxable.","example":true},"image":{"type":"string","description":"Link to the image to display during checkout.","example":"http://shop.images/oakcheesegrater"},"requires_shipping":{"type":"boolean","description":"Indicates whether the item requires shipping.","example":true},"price":{"description":"The item price, represented in base currency units, using [ISO-4217](https://www.iso.org/iso-4217-currency-codes.html) standards.","type":"number","example":2350},"line_item_key":{"$ref":"#/components/schemas/LineItemKey"},"line_item_properties":{"$ref":"#/components/schemas/LineItemProperty"}},"required":["quantity","title","weight","requires_shipping","price","line_item_key"]},"LineItemKey":{"title":"LineItemKey","type":"string","description":"A merchant-defined, unique identifier serving to refer to this line throughout Bold Checkout.","example":"oak_cheese_grater_2643"},"LineItemProperty":{"title":"Line Item Property","type":"object","description":"Any arbitrary property that you want to associate with this item. Line items can also be gift cards, which have specific and unique properties. See the \\"Gift card properties\\" example in `line_items` arrays.","anyOf":[{"type":"object","title":"Additional Properties","additionalProperties":{"type":"string"},"example":{"colour":"red","size":"small"}},{"$ref":"#/components/schemas/GiftCardProperties"},{"type":"object","title":"No properties","description":"Empty object"}]},"GiftCardProperties":{"title":"Gift Card Properties","type":"object","properties":{"recipient_name":{"type":"string","description":"Name of the person the gift card is being sent to.","example":"John Doe"},"recipient_email":{"type":"string","description":"Email address the gift card is being sent to.","example":"johndoe@boldcommerce.com"},"message":{"type":"string","description":"Personalized message field the buyer can attach to the gift card. Value is `\\"\\"` if created from an order.","example":"Dear John, Happy Birthday!"},"custom_amount":{"type":"string","description":"If included, the price of this particular line item in the checkout order will be overwritten by this value. It is written in base units, using [ISO-4217](https://www.iso.org/iso-4217-currency-codes.html) standards.","example":"2450"}}},"LineItem":{"title":"Line Item","type":"object","properties":{"id":{"type":"string","description":"An internal-only string that Bold uses to identify line items.","example":"724bca"},"product_title":{"type":"string","description":"The name of the product.","example":"Oak Cheese Grater"},"title":{"type":"string","description":"The name of the product variant.","example":"Small"},"image_url":{"type":"string","description":"The URL for the image of the variant that is displayed on the storefront.","example":"http://shop.images/oakcheesegrater"},"properties":{"description":"Any additional properties of the line item. Line Items can also be Gift Cards, which have specific and unique properties. See the \\"Gift card properties\\" example in `line_items` arrays.","anyOf":[{"type":"object","title":"Additional Properties","additionalProperties":{"type":"string"}},{"$ref":"#/components/schemas/GiftCardProperties"},{"type":"array","title":"No properties","maxItems":0,"items":{}}]},"description":{"type":"string","description":"A description of the product.","example":"A handmade oak cheese grater to elevate your cheese-eating experience."},"quantity":{"type":"integer","description":"The quantity of the line item on the order.","example":2},"price":{"type":"number","description":"The price of one unit of the line item, using cents/base currency units, using [ISO-4217](https://www.iso.org/iso-4217-currency-codes.html) standards.","example":2350},"total_price":{"type":"number","description":"The total price of all units of the line item, presented in cents/base currency units, using [ISO-4217](https://www.iso.org/iso-4217-currency-codes.html) standards.","example":4700},"visible":{"type":"integer","description":"Indicates whether the item is visible on the storefront. Hard-coded to `1` to indicate `true`.","example":1},"line_item_key":{"$ref":"#/components/schemas/LineItemKey"},"barcode":{"type":"string","description":"The barcode for the line item.","example":"1234ABC"},"compare_at_price":{"type":"number","description":"An optional price displayed on the product page to indicate the discount taken.","nullable":true,"example":4000},"weight":{"type":"integer","description":"The weight of one unit of the line item, measured in `weight_unit`.","example":1000},"weight_unit":{"type":"string","description":"The unit in which to measure the line item weight.","example":"g"},"product_id":{"type":"string","description":"A platform-defined identifier for the product on this line item.","example":"oak-cheese-grater"},"variant_id":{"oneOf":[{"type":"string"},{"type":"number"}],"description":"A platform-defined identifier for the product variant on this line item.","example":"oak-cheese-grater-small"},"requires_shipping":{"type":"boolean","description":"Indicates whether the item must be shipped.","example":true},"sku":{"type":"string","description":"A merchant-defined stock-keeping unit of the line item.","example":"OAK_GRATER_SM"},"taxable":{"type":"boolean","description":"Indicates whether the line item is taxable.","example":true},"tags":{"type":"string","description":"Any tags attached to the line item.","example":"Kitchen, Cheese Board, Oak"},"vendor":{"type":"string","description":"The vendor that supplied the line item.","example":"Cheese Boards Unlimited"},"total_weight":{"type":"integer","description":"The total weight of all units of this line item.","example":2000},"localized_names":{"description":"Any localized names for the product. Languages and localized names are configured in the platform.\\n\\nFor each configured language, the object contains a property with a key equal to the language (in [ISO 369](https://www.iso.org/iso-639-language-codes.html) format) and value equal to the product name in that language.\\n","anyOf":[{"type":"object","title":"Additional Properties","additionalProperties":{"type":"string","properties":{"text":{"type":"string"}}},"example":{"fr":"Gratteur \xe0 fromage en ch\xeane","ge":"K\xe4sereibe aus Eichenholz"}},{"type":"array","title":"No localized_names","maxItems":0,"items":{}}]},"localized_descriptions":{"description":"Any localized descriptions for the product. Languages and localized descriptions are configured in the platform.\\n\\nFor each configured language, the object contains a property with a key equal to the language (in [ISO 369](https://www.iso.org/iso-639-language-codes.html) format) and value equal to the product description in that language.\\n","anyOf":[{"type":"object","title":"Additional Properties","additionalProperties":{"type":"string","properties":{"text":{"type":"string"}}},"example":{"fr":"Un gratteur \xe0 fromage en ch\xeane faite \xe0 la main pour rehausser votre exp\xe9rience de d\xe9gustation de fromage","ge":"Eine handgefertigte K\xe4sereibe aus Eichenholz, um Ihr K\xe4seerlebnis zu verbessern"}},{"type":"array","title":"No localized_descriptions","maxItems":0,"items":{}}]},"localized_variant_names":{"description":"Any localized names for the product variant. Languages and localized names are configured in the platform.\\n\\nFor each configured language, the object contains a property with a key equal to the language (in [ISO 369](https://www.iso.org/iso-639-language-codes.html) format) and value equal to the product variant name in that language.\\n","anyOf":[{"type":"object","title":"Additional Properties","additionalProperties":{"type":"string","properties":{"text":{"type":"string"}}},"example":{"fr":"Gratteur \xe0 fromage en ch\xeane","ge":"K\xe4sereibe aus Eichenholz"}},{"type":"array","title":"No localized_variant_names","maxItems":0,"items":{}}]}}},"Discount":{"title":"Discount","type":"object","description":"A discount, which can be applied either to an individual line item or the order as a whole.","properties":{"code":{"type":"string","description":"The user-facing discount code name.","example":"SUMMER5"},"text":{"type":"string","description":"A description of the discount, which is displayed on the platform.","example":"Summer discount code"},"value":{"type":"number","example":500,"description":"The value of the discount applied, represented in base currency units, using [ISO-4217](https://www.iso.org/iso-4217-currency-codes.html) standards."},"source":{"type":"string","description":"The source of the discount code. Possible values are:\\n  - `\\"cart\\"` discount created from plugin actions [DISCOUNT_CART](/guides/checkout/references/plugin-actions#discount_cart) and/or [DISCOUNT_LINE_ITEMS](/guides/checkout/references/plugin-actions#discount_line_items)\\n  - `\\"coupon\\"` discount created in the [Bold Checkout admin](https://apps.boldapps.net/accounts/app/4).","example":"coupon"}}},"Discounts":{"type":"array","minItems":0,"description":"The order\'s discount information.","items":{"oneOf":[{"type":"object","title":"Existing Discount Code","properties":{"discount_code":{"type":"string","description":"Existing discount code to be applied to order."}},"required":["discount_code"]},{"type":"object","title":"New Discount","properties":{"type":{"type":"string","enum":["fixed","percent","shipping_fixed","shipping_percent","free_shipping"],"description":"Type of discount:\\n* `\\"fixed\\"` - Fixed amount to discount from the order total, in base currency units, using [ISO-4217](https://www.iso.org/iso-4217-currency-codes.html) standards. * `\\"percent\\"` - Percent to discount from the order total. * `\\"shipping_fixed\\"` - Fixed amount to discount from the shipping total in base currency units, using [ISO-4217](https://www.iso.org/iso-4217-currency-codes.html) standards. * `\\"shipping_percent\\"` - Percent to discount from the shipping total. * `\\"free_shipping\\"` - Discounts the full amount of the shipping total.\\n"},"value":{"type":"number","minimum":0,"description":"Discount value, described in one of the following ways:\\n* For `\\"fixed\\"` and `\\"shipping_fixed\\"` type, provide the amount in base currency units, using [ISO-4217](https://www.iso.org/iso-4217-currency-codes.html) standards. * For `\\"percent\\"` and `\\"shipping_percent\\"` type, provide the amount as a percentage, between 0 and 100. * For `\\"free_shipping\\"` type, leave the value blank.\\n"},"line_text":{"type":"string","description":"A human-readable description of the discount that can be displayed in a user interface."}},"required":["type","value","line_text"]}]}},"OrderMetaData":{"title":"Order Metadata","type":"object","description":"Additional information about an order. Metadata can be used as data proxy that Checkout will act upon. It can also be used to include extra information about an order and included when pushed to the platform.","properties":{"cart_parameters":{"description":"Extra information about an order that Checkout can act upon.","oneOf":[{"type":"object","title":"Cart parameters","properties":{"key":{"type":"string","example":"cp-key1"}},"additionalProperties":{"type":"string","example":"A cart param."}},{"type":"array","title":"No cart parameters","maxItems":0,"items":{}}]},"note_attributes":{"description":"Extra information added to the order and pushed to the platform.","oneOf":[{"type":"object","title":"Note attributes","properties":{"key":{"type":"string","example":"na-key1"}},"additionalProperties":{"type":"string","example":"A note attribute."}},{"type":"array","title":"No note attributes","maxItems":0,"items":{}}]},"notes":{"type":"string","description":"Notes that can be attached to the order.","example":"A special delivery note."},"tags":{"type":"array","description":"Tags attached to the order.","items":{"type":"string","example":"order-1"}}}},"LineItemFee":{"title":"Fee","type":"object","description":"An additional fee to be added to the line item.","properties":{"amount":{"type":"number","description":"The fee amount, represented in cents/base currency units, using [ISO-4217](https://www.iso.org/iso-4217-currency-codes.html) standards.","example":500},"name":{"type":"string","description":"A description of the fee.","example":"Miscellaneous fee."}}},"GeneralFee":{"title":"GeneralFee","type":"object","properties":{"id":{"type":"string","description":"A unique identifier for this fee, used in the [`remove_fee`](/guides/checkout/references/plugin-actions#remove_fee) plugin action.","example":"123456789"},"line_text":{"type":"string","description":"A user-defined identifier serving to be displayed in any user interfaces.","example":"Custom Fee \u2014 Added by Plugin"},"fee_type":{"type":"string","description":"The type of the fee, \\"fixed\\" or \\"percentage\\".","example":"fixed"},"value":{"type":"integer","description":"The fee amount, represented in base currency units, using [ISO-4217](https://www.iso.org/iso-4217-currency-codes.html) standards.","example":10},"source":{"type":"string","description":"The method in which the fee was added to the order, typically through the `add_fee` plugin action.","example":"PLUGIN"},"plugin_uuid":{"type":"string","description":"The identifier of the plugin which added the fee to the order. This field is omitted if the fee source was not a plugin.","example":"a52589f8-09df-11ed-b30e-f67072e164ee"},"taxable":{"type":"boolean","description":"Indicates whether the fee should be included in the calculation of taxes.","example":true},"show_description":{"type":"boolean","description":"Indicates whether to show the fee description. Always set to `true` for fees added by plugin.","example":true}}},"Currency":{"type":"object","description":"The currency that the order was completed in.","properties":{"iso_code":{"type":"string","description":"The currency code, using [ISO-4217](https://www.iso.org/iso-4217-currency-codes.html) standards.","example":"CAD"},"iso_numeric_code":{"type":"integer","description":"The numeric currency code, using [ISO-4217](https://www.iso.org/iso-4217-currency-codes.html) standards.","example":124},"symbol":{"type":"string","description":"The symbol associated with the currency.","example":"$"},"format":{"type":"string","description":"The format of the currency, including the symbol and the amount.","example":"${{amount}}"},"has_decimal":{"type":"boolean","description":"Indicates whether the currency uses a decimal.","example":true},"show_iso_code":{"type":"boolean","description":"Indicates whether to show the ISO code alongside the order total on the storefront.","example":true}}},"DisplayCurrency":{"type":"object","description":"The currency that the order was displayed to the user.","properties":{"iso_code":{"type":"string","description":"The currency code, using [ISO-4217](https://www.iso.org/iso-4217-currency-codes.html) standards.","example":"USD"},"iso_numeric_code":{"type":"integer","description":"The numeric currency code, using [ISO-4217](https://www.iso.org/iso-4217-currency-codes.html) standards.","example":840},"symbol":{"type":"string","description":"The symbol associated with the currency.","example":"$"},"format":{"type":"string","description":"The format of the currency, including the symbol and the amount.","example":"${{amount}}"},"has_decimal":{"type":"boolean","description":"Indicates whether the currency uses a decimal.","example":true},"show_iso_code":{"type":"boolean","description":"Indicates whether to show the ISO code alongside the order total on the storefront.","example":true}}},"DisplayExchangeRate":{"type":"number","description":"The rate of exchange between the currency on the order and the display currency.","example":1.357251},"PatchLineItem":{"title":"Line Item Patch","type":"object","x-tags":["app_state"],"properties":{"fulfilled_quantity":{"type":"integer","description":"The fulfilled quantity of a line item in an order.","example":2}}},"InitialData":{"title":"Initial Data","type":"object","properties":{"shop_name":{"type":"string","description":"The URL of the store.","example":"examplestore.com"},"country_information":{"type":"array","description":"Information about the countries supported by the store.","items":{"$ref":"#/components/schemas/Country"}},"supported_languages":{"type":"array","description":"Information about the languages supported by the store.","items":{"$ref":"#/components/schemas/SupportedLanguage"}},"general_settings":{"$ref":"#/components/schemas/GeneralSettings"},"alternative_payment_methods":{"type":"array","description":"Any additional payment methods that are configured on the store and are not the default payment method (set in the [Bold Checkout admin](https://apps.boldapps.net/accounts/app/4)). Objects in this array may have differing formats based on the payment gateway they are associated with.","items":{}},"flow_settings":{"type":"object","description":"Any important information about the checkout flow that was used for this order. The content of this object varies based on the flow you are using."},"external_payment_gateways":{"type":"array","description":"A list of the [external payment gateways](/guides/checkout/concepts/external-payment-gateways) applied to the checkout experience. Manage external payment gateways using the [Checkout Admin API](/api/checkout-admin#tag/External-Payment-Gateways).","items":{"$ref":"#/components/schemas/ExternalPaymentGateway"}},"life_elements":{"type":"array","description":"A list of [LiFE elements](/guides/checkout/life) applied to the checkout experience. Manage LiFE elements using the [Checkout Admin API](/api/checkout-admin#tag/Lightweight-Frontend-Experience-(LiFE)-Elements).","items":{"$ref":"#/components/schemas/LiFE_element"}},"requires_shipping":{"type":"boolean","example":true,"description":"Indicates whether any of the items in the order require shipping. If set to `false`, the order includes only digital items, and the `shipping_address` and `shipping_line` are empty."}}},"Province":{"title":"Province","type":"object","properties":{"iso_code":{"type":"string","description":"The province code, using [ISO-3166](https://www.iso.org/iso-3166-country-codes.html) format.","example":"MB"},"name":{"type":"string","description":"The human-readable name of the province.","example":"Manitoba"},"valid_for_shipping":{"type":"boolean","description":"Indicates whether this province can be shipped to.","example":true},"valid_for_billing":{"type":"boolean","description":"Indicates whether this province can be used for billing addresses.","example":true}}},"Country":{"title":"Country","type":"object","properties":{"iso_code":{"type":"string","description":"The country code, using [ISO-3166](https://www.iso.org/iso-3166-country-codes.html) format.","example":"CA"},"name":{"type":"string","description":"The human-readable name of the country.","example":"Canada"},"show_province":{"type":"boolean","description":"Indicates whether this country should display the province field when the customer is entering address information.","example":true},"province_label":{"type":"string","description":"A label used to describe the region, such as State, Province, or Region.","example":"Province"},"show_postal_code":{"type":"boolean","description":"Indicates whether the country requires postal codes in addresses.","example":true},"provinces":{"type":"array","description":"List of provinces is applicable.","items":{"$ref":"#/components/schemas/Province"}},"valid_for_shipping":{"type":"boolean","description":"Indicates whether this country can be shipped to.","example":true},"valid_for_billing":{"type":"boolean","description":"Indicates whether this country can be used for billing addresses.","example":true}}},"Transaction":{"title":"Transaction","type":"object","description":"","properties":{"gateway":{"type":"string","description":"Name of the payment gateway this transaction was processed on.\\n"},"gateway_id":{"type":"string","description":"Identifier for the payment gateway this transaction was processed on."},"amount":{"description":"The amount, represented in base currency units, using [ISO-4217](https://www.iso.org/iso-4217-currency-codes.html) standards.","type":"number"},"transaction_id":{"type":"string","description":"Payment gateway transaction ID."},"response_code":{"type":"string","description":"Additional payment gateway response code."},"gateway_error":{"type":"string","description":"The error message returned by the payment gateway."},"status":{"description":"Status of the transaction. Possible values: failed, success.","type":"string"},"gateway_meta_data":{"type":"object"},"payment_id":{"type":"string"},"gateway_response":{"type":"object"}}},"AuthTransaction":{"type":"object","description":"A transaction associated with the authorized payment.","properties":{"gateway":{"type":"string","description":"The name of the payment gateway this transaction was processed on.","example":"Stripe Default Name"},"payment_id":{"type":"string","description":"The Bold-generated identifier for payment.","example":"xBxKWi4YX4t1VURWlO3wKdt7aFeefHvR6LFRmVs1krgepEeZNodDwYfXvmfcVesE"},"amount":{"description":"The amount, represented in base currency units, using [ISO-4217](https://www.iso.org/iso-4217-currency-codes.html) standards.","type":"number","example":1000},"transaction_id":{"type":"string","description":"The gateway-generated transaction ID.","example":"ch_1GvDW4JhIKSKpq8w9SoshRef"},"currency":{"type":"string","description":"The currency code.","example":"USD"},"step":{"type":"string","description":"The current step in the payment lifecycle.","example":"preAuthed","enum":["awaitingPreAuth","preAuthed","refund","finalized","FAILED","SKIP_NO_VALUE","authVoided","reattempted","pendingPreAuthActions","authHeld","tokenizationHeld","captureHeld","sale"]},"status":{"description":"The status of the transaction.","type":"string","enum":["failed","success"]},"tender_type":{"type":"string","description":"The type of payment.","example":"credit_card"},"tender_details":{"type":"object","description":"Information about the payment method. The contents of this object depend on what is provided by the payment gateway.","oneOf":[{"$ref":"#/components/schemas/CreditCardTender"}]},"gateway_response_data":{"type":"array","description":"Information from the payment gateway. The contents of this object depend on your payment gateway and configuration settings.","items":{}}}},"CreditCardTender":{"type":"object","description":"The tender details for a credit card.","properties":{"brand":{"description":"The credit card brand.","type":"string","example":"Visa"},"last_four":{"type":"string","description":"The last four digits of the credit card.","example":"7890"},"bin":{"type":"string","description":"The credit card Bank Identification Number (BIN).","example":"40466534"},"expiration":{"type":"string","description":"The credit card expiration date, in \\"MM/YY\\" format.","example":"01/29"}}},"JWTToken":{"type":"string","title":"JWT Token","description":"The JSON Web Token (JWT) generated during the initialization of the order. Use the JWT to authenticate future calls to the [Checkout Frontend API](checkout).","example":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhdXRoX3R5cGUiOiJWMl9BUEkiLCJwYXlsb2FkIjp7InB1YmxpY19vcmRlcl9pZCI6Inlyb0Y2NDNNeUpTZVZRUUpES2R2c2QxYXdXY3BpRVFJbkhOaTJkWlhmWW9PdVI0dmFGVUhpNHBPRG9pRWFpOVQifSwiZXhwIjoxNjMyMzQxMjg3LCJuYmYiOm51bGwsImlhdCI6bnVsbH0.swmYcVBHyK2i86jN-bIOL3WOCzP5VQVLq9Ev-TfIC_c"},"PublicOrderId":{"title":"Public Order ID","type":"string","description":"The public order identifier generated when the order is initialized by making a request to the [Initialize Order](orders#operation/InitializeOrder) endpoint.","example":"nPTPIlIahDoEgZFabZNNvg7uxahLkGb1x4UINz3eqYV3eHewsjq7kubZc5BLAUqC"},"ApplicationState":{"title":"Application State","type":"object","description":"Represents the current state of the order.\\nTaxes and discounts represent the summation of all tax or discount lines that have been applied anywhere through the order. Consulting the line items allows you to get the specific product break down of taxes and discounts.","properties":{"customer":{"description":"The customer that placed the order.","oneOf":[{"$ref":"#/components/schemas/Customer"},{"type":"array","title":"No customer","maxItems":0,"items":{}}]},"addresses":{"type":"object","description":"The billing and shipping addresses on the order.","properties":{"shipping":{"description":"The shipping address on the order.","oneOf":[{"$ref":"#/components/schemas/Address"},{"type":"array","title":"No address","maxItems":0,"items":{}}]},"billing":{"description":"The billing address on the order.","oneOf":[{"$ref":"#/components/schemas/Address"},{"type":"array","title":"No address","maxItems":0,"items":{}}]}}},"line_items":{"type":"array","description":"The list of line items associated with an order. Each line item includes information about the selected product and the taxes, fees, and discounts applied to it.","items":{"type":"object","properties":{"product_data":{"$ref":"#/components/schemas/LineItem"},"taxes":{"type":"array","description":"Any taxes that apply to the line item.","items":{"$ref":"#/components/schemas/Tax"}},"fees":{"type":"array","description":"Any fees that apply to the line item.","items":{"$ref":"#/components/schemas/LineItemFee"}},"discounts":{"type":"array","description":"Any discounts that apply to the line item.","items":{"$ref":"#/components/schemas/Discount"}},"fulfilled_quantity":{"type":"integer","description":"The quantity of the line item that has been fulfilled. Fulfill a line item using the [Update Line Item](orders#operation/UpdateLineItem) endpoint.","example":2}}}},"fees":{"type":"array","description":"Any fees that apply to the full order.","items":{"$ref":"#/components/schemas/GeneralFee"}},"taxes":{"type":"array","description":"Any taxes that apply to the full order.","items":{"$ref":"#/components/schemas/Tax"}},"discounts":{"type":"array","description":"Any discounts that apply to the full order.","items":{"$ref":"#/components/schemas/Discount"}},"payments":{"type":"array","description":"The payments applied to the order.","items":{"$ref":"#/components/schemas/Payment"}},"order_total":{"type":"number","description":"The total amount of the order (after tax, shipping, and discounts) using cents/base currency units using [ISO-4217](https://www.iso.org/iso-4217-currency-codes.html) standards.","example":4700},"order_meta_data":{"$ref":"#/components/schemas/OrderMetaData"},"shipping":{"type":"object","description":"The shipping information \u2014 including shipping lines, taxes, and discounts \u2014 associated with an order.","properties":{"selected_shipping":{"$ref":"#/components/schemas/ShippingLine"},"available_shipping_lines":{"type":"array","description":"The shipping lines available for the order.","items":{"type":"object","properties":{"id":{"type":"string"},"line":{"$ref":"#/components/schemas/ShippingLine"}}}},"taxes":{"description":"Any taxes that apply to the shipping rate.","oneOf":[{"type":"array","items":{"$ref":"#/components/schemas/Tax"}},{"type":"number"}]},"discounts":{"description":"Any discounts that apply to the shipping rate.","oneOf":[{"type":"array","items":{"$ref":"#/components/schemas/Discount"}},{"type":"number"}]}}},"resumable_link":{"$ref":"#/components/schemas/ResumableLink"},"flow_id":{"type":"string","nullable":true,"description":"The identifier of the origin checkout flow used to create the order. If left empty, defaults to `null` and is displayed as \\"Unassigned\\" in the Checkout admin.","example":"external-company-one-page-template"},"currency":{"$ref":"#/components/schemas/Currency"},"display_currency":{"$ref":"#/components/schemas/DisplayCurrency"},"display_exchange_rate":{"$ref":"#/components/schemas/DisplayExchangeRate"},"created_via":{"type":"string","description":"The source of the order. Plugin developers can use the [Set Order Created By](/guides/checkout/references/plugin-actions#set_order_created_by) action to set this field and indicate that an order was created by their plugin. If the order was created as normal through Bold Checkout, this value is `\\"checkout\\"`.","example":"My_Order_Creating_Plugin"},"is_processed":{"type":"boolean","description":"Indicates whether the order has been processed.","example":false},"order_id":{"type":"number","description":"Bold Checkout\'s internal order ID.","example":79047599},"platform_order_id":{"type":"string","nullable":true,"description":"A platform-generated identifier for the order.","example":"1389wjfalsdf9y4r"}}},"Customer":{"title":"Customer","type":"object","description":"An authenticated or guest customer associated with an order.","properties":{"platform_id":{"type":"string","description":"The platform identifier for an authenticated customer. For guest customers, the value for this property will be null.","nullable":true,"example":"50942578465125"},"public_id":{"type":"string","description":"The public identifier generated by Checkout for a customer.","nullable":true,"readOnly":true,"example":"pjpTyGh8KzNQ225wPqxgy7LwNuC887h6ecGyp3omwT4XW8SszjVSdHzWHN4NBwqhA"},"first_name":{"type":"string","description":"The first name of the customer.","example":"John"},"last_name":{"type":"string","description":"The last name of the customer.","example":"Doe"},"email_address":{"type":"string","description":"The email address of the customer.","example":"john.doe@example.com"},"accepts_marketing":{"type":"boolean","description":"If the customer would like to receive any sort of marketing emails. Defaults to `false`.","example":true},"saved_addresses":{"type":"array","description":"The saved addresses of an authenticated customer stored from the platform.","items":{"$ref":"#/components/schemas/Address"}}},"required":["email_address"]},"SupportedLanguage":{"title":"Supported Language","type":"object","description":"","properties":{"id":{"type":"integer","description":"Identifier of the language record.","readOnly":true,"example":32856},"shop_id":{"type":"integer","description":"The identifier of the shop associated to the language record.","example":1091521},"iso_language":{"type":"string","description":"A two character language code, using [ISO 639-1](https://www.iso.org/iso-639-language-codes.html).","example":"en"},"language_name":{"type":"string","description":"A human-readable name of the language.","example":"English"},"language_blob":{"type":"string","description":"The shop language details returned as stringified JSON.","example":"{\\"language_name\\":\\"English\\",\\"terms\\":{\\"customer_information\\":{\\"already_have_an_account\\":\\"Already have an account with us?\\",\\"customer_info\\":\\"Customer information\\",\\"email\\":\\"Email\\",\\"email_address\\":\\"Email address\\",\\"email_address_placeholder\\":\\"Email address\\",\\"enter_new_address\\":\\"Enter a new address\\",\\"log_in\\":\\"Log in\\",\\"not_you\\":\\"Not you?\\",\\"return_to_cart\\":\\"Return to cart\\",\\"return_to_store\\":\\"Return to store\\",\\"accepts_marketing\\":\\"Subscribe to our newsletter\\"},\\"shipping_address\\":{\\"address2_field\\":\\"Apt, suite, etc.\\",\\"address2_field_optional\\":\\"Apt, suite, etc. (optional)\\",\\"address_field\\":\\"Address\\",\\"city_field\\":\\"City\\",\\"company_field\\":\\"Company\\",\\"company_field_optional\\":\\"Company (optional)\\",\\"cont_to_shipping\\":\\"Continue to shipping method\\",\\"country_field\\":\\"Country\\",\\"country_field_placeholder\\":\\"Choose a country\\",\\"first_name_field\\":\\"First name\\",\\"last_name_field\\":\\"Last name\\",\\"optional\\":\\" (optional)\\",\\"phone_field\\":\\"Phone\\",\\"phone_field_optional\\":\\"Phone (optional)\\",\\"postal_code_field\\":\\"Postal code\\",\\"province\\":\\"Province\\",\\"province_field\\":\\"Province\\",\\"province_field_placeholder\\":\\"Choose a province\\",\\"select_address\\":\\"Select an address\\",\\"select_exist_address\\":\\"Select an existing address\\",\\"shipping\\":\\"Shipping\\",\\"shipping_address\\":\\"Shipping address\\",\\"state\\":\\"State\\"}}}"},"is_default":{"type":"boolean","description":"Indicates whether the given language is the shop default.","example":true},"out_of_date":{"type":"integer","minimum":0,"maximum":1,"description":"An integer (0 or 1) representing whether the given language blob is out of date, where 1 is out of date.","example":0},"enabled":{"type":"integer","minimum":0,"maximum":1,"description":"An integer (0 or 1) representing whether the given language blob is enabled on the shop, where 1 is enabled.","example":1},"source":{"type":"string","nullable":true,"enum":["yappn",null],"description":"The source of where the language is managed, where `null` implies a language managed within Checkout Admin.","example":null},"created_at":{"type":"string","format":"date-time","description":"The date and time when the language record was created.","example":"2021-08-12T14:30:54.000000Z"},"updated_at":{"type":"string","format":"date-time","description":"The date and time when the language record was last updated.","example":"2022-10-20T19:54:08.000000Z"},"deleted_at":{"type":"string","format":"date-time","nullable":true,"description":"The date and time when the language record was deleted, where `null` implies an active record.","example":null},"name":{"type":"string","description":"A human-readable name of the language.","example":"English"},"shop_language_id":{"type":"integer","description":"The identifier of the language record.","readOnly":true,"example":32856}}},"Address":{"title":"Address","description":"A shipping or billing address.","type":"object","nullable":true,"properties":{"id":{"type":"string","description":"A unique identifier of the address.","nullable":true,"readOnly":true,"example":"123"},"first_name":{"type":"string","description":"The first name of the addressee.","example":"John"},"last_name":{"type":"string","description":"The last name of the addressee.","example":"Doe"},"address_line_1":{"type":"string","description":"The street address.","example":"50 Fultz Blvd"},"address_line_2":{"type":"string","description":"Any additional street address details (apt #, suite #, etc).","example":"Suite 200"},"country":{"type":"string","description":"The country name.","example":"Canada"},"city":{"type":"string","description":"The city name.","example":"Winnipeg"},"province":{"type":"string","description":"The province or state name, if applicable.","example":"Manitoba"},"country_code":{"type":"string","description":"The country code, in [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) format.","example":"CA"},"province_code":{"type":"string","description":"The province or state code, in [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) format, if applicable.","example":"MB"},"postal_code":{"type":"string","description":"The postal/zip code. Required for most countries, including the United States, Canada, and Mexico. Validated on format only when provided.","example":"R3Y0L6"},"business_name":{"type":"string","description":"If applicable, the business name.","example":"Acme Inc."},"phone_number":{"type":"string","description":"The phone number of the addressee.","example":"8005550101"}},"required":["country","country_code"]},"ShippingLine":{"title":"Shipping Line","type":"object","nullable":true,"properties":{"id":{"type":"string","description":"The index of the shipping line.","example":"0"},"description":{"type":"string","description":"A description of the shipping line.","example":"Custom weight-based rate: tier 2"},"amount":{"type":"number","description":"The shipping amount represented in cents/base currency units using [ISO-4217](https://www.iso.org/iso-4217-currency-codes.html) standards.","example":450},"code":{"type":"string","description":"An identifier assigned to the shipping rate by the shipping provider.","example":"EXPID"}}},"Payment":{"title":"Payment","type":"object","properties":{"gateway_public_id":{"type":"string","description":"A public identifier of the payment gateway used with the payment.","example":"i7z2xT0sKrDvhGWzex5SLjf5e6ndlQfrRL4AROkfhf3vNBkVT38JKBy5PSjB63qW"},"amount":{"type":"number","description":"The payment amount, represented in cents/base currency units, using [ISO-4217](https://www.iso.org/iso-4217-currency-codes.html) standards.","example":4700},"currency":{"type":"string","description":"The currency of the payment, using [ISO-4217](https://www.iso.org/iso-4217-currency-codes.html) standards.","example":"CAD"},"type":{"type":"string","description":"The payment gateway that accepted the payment.","example":"spreedly"},"display_string":{"type":"string","description":"A description of the payment to visually display to the customer.","example":"Credit Card Payment"},"id":{"type":"string","readOnly":true,"description":"An identifier of the payment.","example":""},"token":{"type":"string","description":"A token generated by the payment gateway to identify the payment.","example":"7uZAMRAf80KiEwibsrrM5IB41yU"},"retain":{"type":"boolean","description":"Indicates whether the payment method will be saved for future orders. Checkout only stores a tokenized version of the payment method.","default":false,"example":false}},"required":["gateway_public_id","token"]},"Error":{"title":"error","type":"object","properties":{"message":{"type":"string","description":"The message for the error.","example":"The first name field is required."},"type":{"type":"string","description":"The type of error that occurred.","example":"customer"},"field":{"type":"string","description":"The field of the object that the error was found in.","example":"first_name"},"severity":{"type":"string","description":"The severity of the error.","example":"validation"},"sub_type":{"type":"string","description":"The sub_type of the error.","example":"order"}}},"ErrorV2":{"title":"Error","type":"object","properties":{"code":{"type":"string","description":"The code for the error.","example":"11-13"},"type":{"type":"string","description":"The type of error.","example":"integration_config.shop_could_not_be_determined"},"message":{"type":"string","description":"The message for the error.","example":"shop could not be determined"},"details":{"type":"object","description":"Additional details for the error.","example":{}}}},"AuthorizationFailure":{"title":"Authorization Failure","type":"object","properties":{"code":{"type":"string","description":"The code for the error.","example":"02-43"},"type":{"type":"string","description":"The type of error.","example":"payments.payment_authorization_failure"},"message":{"type":"string","description":"The message for the error.","example":"payments failed authorization"},"transactions":{"type":"array","description":"The payments that Bold attempted to authorize. If one payment was approved and a later payment failed, then the previously approved payment is voided.","items":{"$ref":"#/components/schemas/AuthTransaction"}}}},"UnprocessableEntity":{"description":"There was a problem with the object provided in the request.","type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string","description":"An error message describing what went wrong.","example":"The first name field is required."},"type":{"type":"string","description":"The type of error that occurred.","example":"customer"},"field":{"type":"string","description":"The field of the object that the error was found in.","example":"first_name"},"severity":{"type":"string","description":"The severity of the error.","example":"validation"},"sub_type":{"type":"string","description":"The sub_type of the error.","example":"order"}}}}}},"ResumableLink":{"type":"string","nullable":true,"description":"A URL used to resume an order. If provided, the default resumable link generated by Checkout will be overwritten with this URL. This resumable link will be provided in the email and webhook for an abandoned checkout.","example":"https://mycheckout.com/resume"},"GeneralSettings":{"title":"General Settings","description":"General Checkout settings, which can be configured in the [Bold Checkout admin](https://apps.boldapps.net/accounts/app/4).","type":"object","properties":{"checkout_process":{"type":"object","description":"General settings relevant to the checkout process","properties":{"company_name_option":{"type":"string","description":"Indicates whether company name is required on an order.","enum":["optional","required","hidden"],"example":"hidden"},"phone_number_required":{"type":"boolean","description":"Indicates whether phone number is required on an order.","example":false},"accepts_marketing_checkbox_option":{"type":"string","description":"Indicates initial display of email marketing options.","enum":["checked","unchecked","hidden"],"example":"unchecked"}}},"address_autocomplete":{"type":"object","description":"The configuration for address autocomplete functionality, if enabled for the particular shop.","properties":{"provider":{"type":"string","nullable":true,"description":"The data provider for address autocomplete.","enum":["google","loqate"],"example":"google"},"api_key":{"type":"string","nullable":true,"description":"A public API key for querying the address autocomplete provider.","example":"awefa9304q9wfqf43jfaw904kfwkaslserfa94"}}}},"required":["checkout_process"]},"Tax":{"title":"Tax","type":"object","properties":{"value":{"type":"number","description":"The value of the tax applied, represented in cents/base currency units, using [ISO-4217](https://www.iso.org/iso-4217-currency-codes.html) standards.","example":1000},"name":{"type":"string","description":"A descriptor of the tax being applied.","example":"GST"},"is_included":{"type":"boolean","description":"Indicates whether the tax is already included in the price.","example":true}}},"FlowId":{"type":"string","nullable":true,"maxLength":255,"description":"An identifier for the origin checkout flow that created the order. The field is optional for custom checkout flows and other clients, but provides a convenience for determining the order\'s origin.\\n\\nBold-hosted templates provide this field and are identified by the first 4 letters `\\"bold\\"`, which are reserved.  The value `\\"unassigned\\"` is reserved for when the field is not provided.\\n\\nFor more information, refer to [Checkout Flows](/guides/checkout/concepts/flows)","example":"external-company-one-page-template"},"ApiSessionId":{"type":"string","maxLength":255,"description":"An optional alphanumeric identifier used to group orders for the purpose of tracking order completion rates. If this value is not provided, Bold generates one randomly and assumes that the order is not grouped with any others.\\n\\nFor more information, refer to [Configure Checkout Flow Metrics](/guides/checkout/metrics).","example":"abc123"},"RefundRequestFull":{"title":"Refund Request","description":"Request body for full refunds.","type":"object","properties":{"reason":{"type":"string","description":"The note attached to the refund.","example":"Product arrived broken."},"email_notification":{"type":"boolean","description":"Whether or not Checkout will send an email notification. If true, an email will be sent.","example":true},"refund_meta_data":{"type":"object","description":"(optional) Additional refund transaction data for specific payment gateway integrations.","example":{"data":{"external_id":"legacy-id-135798642"}}}}},"RefundRequest":{"title":"Refund Request","description":"Request body for partial refunds.","type":"object","allOf":[{"$ref":"#/components/schemas/RefundRequestFull"},{"type":"object","properties":{"amount":{"type":"integer","description":"Total amount requested for refund, represented in base currency units, using [ISO-4217](https://www.iso.org/iso-4217-currency-codes.html) standards.","example":6055}}}]},"RefundResponse":{"title":"Refund Response","description":"Response body for refunds.","type":"object","properties":{"amount_refunded":{"type":"integer","description":"The refund amount issued, represented in base currency units, using [ISO-4217](https://www.iso.org/iso-4217-currency-codes.html) standards.","example":6055},"transaction_details":{"type":"array","description":"Details for the refund transaction.","items":{"$ref":"#/components/schemas/RefundTransaction"}}}},"RefundComboResponse":{"title":"Refund Response with potential error information","description":"A refund response that combines refund information and error information.","type":"object","properties":{"refund":{"type":"array","items":{"type":"object","properties":{"refunded_amount":{"type":"integer","description":"The refund amount issued, represented in base currency units, using [ISO-4217](https://www.iso.org/iso-4217-currency-codes.html) standards."},"transaction_details":{"type":"array","description":"Details for the refund transaction.","items":{"$ref":"#/components/schemas/RefundTransactionWithoutErrorInfo"}}}}},"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"The code for the error.","example":"11-13"},"type":{"type":"string","description":"The type of error.","example":"integration_config.shop_could_not_be_determined"},"message":{"type":"string","description":"The message for the error.","example":"shop could not be determined"},"details":{"type":"object","description":"Additional details for the error."}}}}}},"RefundTransaction":{"title":"RefundTransaction","type":"object","properties":{"success":{"type":"boolean","description":"If the transaction was successful.","example":true},"transaction_number":{"type":"string","description":"The transaction number.","example":"ch_1GvDW4JhIKSKpq8w9SoshRef"},"amount":{"type":"integer","description":"The amount refunded in the transaction, represented in base currency units, using [ISO-4217](https://www.iso.org/iso-4217-currency-codes.html) standards.","example":6055},"created_at":{"type":"string","description":"The datetime the transaction was created.","example":"2021-01-15 01:01:01"},"errors":{"type":"array","description":"The errors associated with the transaction.","items":{}}}},"RefundTransactionWithoutErrorInfo":{"title":"Refund Transaction without Error Information Included","type":"object","properties":{"success":{"type":"boolean","description":"If the transaction was successful.","example":true},"transaction_number":{"type":"string","description":"The transaction number.","example":"ch_1GvDW4JhIKSKpq8w9SoshRef"},"amount":{"type":"integer","description":"The amount refunded in the transaction, represented in base currency units, using [ISO-4217](https://www.iso.org/iso-4217-currency-codes.html) standards.","example":6055},"created_at":{"type":"string","description":"The datetime the transaction was created.","example":"2021-01-15 01:01:01"}}},"CapturePaymentRequest":{"title":"Capture Payment Request","type":"object","properties":{"reauth":{"type":"boolean","description":"Whether or not Checkout should attempt to re-authorize payment if the authorize transaction has been used or expired.","default":true,"example":true},"idempotent_key":{"type":"string","description":"A unique idempotency key generated by the client which the server uses to recognize subsequent retries of the same requests.","example":"2b268b6f-b3c0-4efb-9c43-1aa59d535182"},"capture_data":{"type":"object","description":"Any data associated with the payment capture request.","example":{"data":{"external_id":"legacy-id-135798642"}}}},"required":["reauth"]},"CapturePartialPaymentRequest":{"title":"Capture Partial Payment Request","type":"object","allOf":[{"$ref":"#/components/schemas/CapturePaymentRequest"},{"type":"object","properties":{"amount":{"type":"number","description":"Amount to capture, represented in base currency units, using [ISO-4217](https://www.iso.org/iso-4217-currency-codes.html) standards.","example":120}},"required":["amount"]}]},"CapturePaymentResponse":{"title":"Capture Payment Response","type":"object","properties":{"order_total":{"type":"number","description":"The total of the order, represented in base currency units, using [ISO-4217](https://www.iso.org/iso-4217-currency-codes.html) standards.","example":120},"amount_remaining":{"type":"number","description":"The amount remaining after a payment has been captured, represented in base currency units, using [ISO-4217](https://www.iso.org/iso-4217-currency-codes.html) standards.","example":60},"paid_total":{"type":"number","description":"The total payment captured, represented in base currency units, using [ISO-4217](https://www.iso.org/iso-4217-currency-codes.html) standards.","example":60},"capture_held_total":{"type":"number","description":"The total amount held for capture by the payment gateway, represented in base currency units, using [ISO-4217](https://www.iso.org/iso-4217-currency-codes.html) standards.","example":0},"transactions":{"type":"array","description":"The transactions created for the payment capture.","items":{"$ref":"#/components/schemas/Transaction"},"example":[{"gateway":"Stripe Default Name","gateway_id":"bFH0RUdnWPFPRxmWfK6B1yXi61Hh0svIBTrk1vtGoI1zPYVXntIqMX82pqdrSYhi","amount":60,"transaction_id":"ch_1GvDW4JhIKSKpq8w9SoshRef","reference_transaction_id":null,"response_code":"","status":"success","payment_id":"abc123"}]}}},"LiFE_element":{"title":"LiFE Element","description":"A configurable, custom element in the checkout experience.","properties":{"public_id":{"type":"string","description":"The Bold-generated identifier of the LiFE element.","example":"VfYRxzOjRkwG6B2xWbxhPQ","readOnly":true},"location":{"type":"string","description":"The location where the LiFE element will be rendered. For more information about possible element locations, refer to the [Checkout LiFE guide](/guides/checkout/life).","example":"customer_info","enum":["customer_info","shipping","billing_address_after","shipping_lines","below_actions","summary_above_header","payment_gateway","thank_you_message","order_confirmation","order_details","main_content_beginning","main_content_end","payment_method_above","paypal_additional_information"]},"input_type":{"type":"string","description":"The input type of the LiFE element.","example":"text","enum":["text","checkbox","html","textarea","dropdown","datepicker"]},"input_default":{"type":"string","description":"The default input. The behavior of this field depends on the `input_type`:\\n  - `text` or `textarea`: Set this value to your chosen string. The shopper deletes the `input_default` and adds their own value.\\n  - `checkbox`: Set this value to `\\"true\\"` to make the checkbox automatically selected.\\n  - `html`: Set this value to the HTML you would like the element to display.\\n  - `dropdown`: Set the value to a comma-separated string of the options you would like the element to display.\\n  - `datepicker`: Set the value to a date string with the format of `YYYY/MM/DD`. If the `input_default` is not set, the date picker defaults to the current date.","example":"initial value","nullable":true},"input_label":{"type":"string","description":"If the element requires shopper input, this is the label for the input.","example":"Shipping notes","nullable":true},"input_placeholder":{"type":"string","description":"The input placeholder value of the LiFE element. The behavior of this field depends on the `input_type`:\\n  - `text` or `textarea`: This value appears in the input field and disappears when the shopper begins typing.\\n  - `checkbox`: This value appears below the `input_label`.\\n  - `dropdown`: This value appears in the drop-down box before it is expanded.\\n  - `datepicker`: This value appears in the input field and disappears when the shopper selects a date.","example":"Shipping notes here","nullable":true},"input_required":{"type":"boolean","description":"Indicates whether input from the shopper is required.","example":true,"nullable":true},"input_regex":{"type":"string","description":"The regular expression that validates the input for `text` and `textarea` elements.","example":"[0-9]{4}","nullable":true},"meta_data_field":{"type":"string","description":"The metadata key from the order\'s `application_state` that will be used to store the user\'s entered value.","example":"shipping_notes"},"order_asc":{"type":"integer","description":"The index of the element. If multiple elements appear in one location, this value indicates the order in which they appear.","example":1}},"required":["location","meta_data_field","input_type","input_required","order_asc"]},"ExternalPaymentGateway":{"title":"External Payment Gateway","description":"A configurable, external payment gateway for accepting payments through Bold checkout.","type":"object","properties":{"is_test":{"type":"boolean","description":"Indicates whether the external payment gateway is in test mode.","example":true},"iframe_url":{"type":"string","description":"The URL to be embedded into the payment iframe.","example":"www.example.com/gateway","nullable":true},"base_url":{"type":"string","description":"The base URL that Checkout calls when performing payment operations.","example":"www.example.com/payments"},"public_id":{"type":"string","description":"The Identifier of the external payment gateway resource.","example":"VfYRxzOjRkwG6B2xWbxhPQ","readOnly":true},"location":{"type":"string","description":"The location during checkout that the payment `iframe` will be rendered.","example":"payment_method_below","nullable":false},"currency":{"type":"string","description":"The currency supported by the external payment gateway, in [ISO-4217](https://www.iso.org/iso-4217-currency-codes.html) format.","example":"CAD","minLength":3,"maxLength":3}}}},"examples":{"cart_token":{"value":{"cart_id":"1snVSJAWYWWYhfLWq9ABcXMwx8mcvh2U","access_token":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"}},"generic_cart":{"value":{"cart_items":[{"quantity":2,"title":"Some Product","weight":50,"taxable":true,"image":"https://example.com/thing.jpg","requires_shipping":true,"price":2000,"line_item_key":"ABC123","line_item_properties":{"colour":"red","size":"small"}}],"customer":{"email_address":"john.doe@example.com","first_name":"John","last_name":"Doe","platform_id":"12345","saved_addresses":[{"id":"12","first_name":"John","last_name":"Doe","address_line_1":"50 Fultz Blvd","address_line_2":"","province":"Manitoba","city":"Winnipeg","country_code":"CA","country":"Canada","province_code":"MB","postal_code":"R3Y0L6","business_name":"","phone_number":"8005550101"}]},"order_meta_data":{"cart_parameters":{"cp-key1":"A cart param"},"note_attributes":{"na-key1":"A note attribute"},"notes":"Special delivery message.","tags":["order-1"]}}},"gift_card_cart":{"value":{"cart_items":[{"id":"786dur","quantity":1,"title":"Gift Card","variant_title":"Gift Card $50","taxable":true,"image":"https://example.com/thing.jpg","requires_shipping":false,"price":4700,"line_item_key":"ABC123","line_item_properties":{"recipient_name":"John Doe","recipient_email":"johndoe@boldcommerce.com","message":"Dear John, Happy Birthday!","custom_amount":"5000"}}],"customer":{"email_address":"john.doe@example.com","first_name":"John","last_name":"Doe","platform_id":"12345","saved_addresses":[{"id":"12","first_name":"John","last_name":"Doe","address_line_1":"50 Fultz Blvd","address_line_2":"","province":"Manitoba","city":"Winnipeg","country_code":"CA","country":"Canada","province_code":"MB","postal_code":"R3Y0L6","business_name":"","phone_number":"8005550101"}]},"order_meta_data":{"cart_parameters":{"cp-key1":"A cart param"},"note_attributes":{"na-key1":"A note attribute"},"notes":"Special delivery message.","tags":["order-1"]}}},"sku_cart":{"value":{"cart_items":[{"sku":"123AB","quantity":3,"line_item_key":"ABC123","line_item_properties":{"colour":"red","size":"small"}}]}},"variant_id_cart":{"value":{"cart_items":[{"platform_id":"12345","quantity":3,"line_item_key":"ABC123","line_item_properties":{"colour":"red","size":"small"}}]}},"authenticated_customer":{"value":{"customer":{"platform_id":"50942578465125","email_address":"john.doe@example.com"}}},"NoCustomer":{"summary":"Deleted Customer","value":{"data":{"application_state":{"customer":[],"addresses":{"shipping":{"id":"123","first_name":"John","last_name":"Doe","address_line_1":"50 Fultz Blvd","address_line_2":"Suite 200","country":"Canada","city":"Winnipeg","province":"Manitoba","country_code":"CA","province_code":"MB","postal_code":"R3Y0L6","business_name":"Acme Inc.","phone_number":"8005550101"},"billing":{"id":"123","first_name":"John","last_name":"Doe","address_line_1":"50 Fultz Blvd","address_line_2":"Suite 200","country":"Canada","city":"Winnipeg","province":"Manitoba","country_code":"CA","province_code":"MB","postal_code":"R3Y0L6","business_name":"Acme Inc.","phone_number":"8005550101"}},"line_items":[{"product_data":{"id":"724bca","product_title":"Oak Cheese Grater","title":"Small","image_url":"http://shop.images/oakcheesegrater","properties":{"colour":"red","size":"small"},"description":"A handmade oak cheese grater to elevate your cheese-eating experience.","quantity":2,"price":2350,"total_price":4700,"visible":1,"line_item_key":"oak_cheese_grater_2643","barcode":"1234ABC","compare_at_price":4000,"weight":1000,"weight_unit":"g","product_id":"oak-cheese-grater","variant_id":"oak-cheese-grater-small","requires_shipping":true,"sku":"OAK_GRATER_SM","taxable":true,"tags":"Kitchen, Cheese Board, Oak","vendor":"Cheese Boards Unlimited","total_weight":2000}},{"taxes":[{"value":1000,"name":"GST","is_included":true}]},{"fees":[{"amount":500,"name":"Miscellaneous fee."}]},{"discounts":[{"code":"SUMMER5","text":"Summer discount code","value":500,"source":"coupon"}]},{"fulfilled_quantity":2}],"fees":[{"id":"123456789","line_text":"Custom Fee \u2014 Added by Plugin","fee_type":"fixed","value":10,"source":"PLUGIN","plugin_uuid":"a52589f8-09df-11ed-b30e-f67072e164ee","taxable":true,"show_description":true}],"taxes":[{"value":1000,"name":"GST","is_included":true}],"discounts":[{"code":"SUMMER5","text":"Summer discount code","value":500,"source":"coupon"}],"payments":[{"gateway_public_id":"i7z2xT0sKrDvhGWzex5SLjf5e6ndlQfrRL4AROkfhf3vNBkVT38JKBy5PSjB63qW","amount":4700,"currency":"CAD","type":"spreedly","display_string":"Credit Card Payment","id":"","token":"7uZAMRAf80KiEwibsrrM5IB41yU","retain":false}],"order_total":4700,"order_meta_data":{"cart_parameters":{"key":"cp-key1,","property1":"A cart param.","property2":"A cart param."},"note_attributes":{"key":"na-key1","property1":"A note attribute.","property2":"A note attribute."},"notes":"A special delivery note.","tags":["order-1"]},"shipping":{"selected_shipping":{"id":"0","description":"Custom weight-based rate: tier 2","amount":450,"code":"EXPID"},"available_shipping_lines":[{"id":"string,","line":{"id":"0","description":"Custom weight-based rate: tier 2","amount":450,"code":"EXPID"}}],"taxes":[{"value":1000,"name":"GST","is_included":true}],"discounts":[{"code":"SUMMER5","text":"Summer discount code","value":500,"source":"coupon"}]},"resumable_link":"string","flow_id":"external-company-one-page-template","currency":{"iso_code":"CAD","iso_numeric_code":124,"symbol":"$","format":"${{amount}}","has_decimal":true,"show_iso_code":true},"created_via":"My_Order_Creating_Plugin","is_processed":false,"order_id":79047599,"platform_order_id":"1389wjfalsdf9y4r"}}}}}}}},"plugin-redoc-3":{"url":"/api/platform-connector.openapi.yaml","themeId":"theme-redoc","isSpecFile":true,"spec":{"openapi":"3.0.0","info":{"title":"Platform Connector API Specification","description":"The Platform Connector API allows Bold to interact with your platform\'s customers, orders, and products.\\n\\nThis specification file defines the expected server behavior of the Platform Connector Server. Bold applications require the endpoints listed here to be implemented in order to function properly.\\n\\nRefer to the <a href=\\"https://developer.boldcommerce.com/changelog/tags/platform-connector\\">changelog</a> for the latest updates to this API.\\n\\n> **Note:** This specification is only for use with a [Bold Platform Connector](/guides/platform-connector).","termsOfService":"https://boldcommerce.com/terms-of-service","contact":{"name":"Contact Us","url":"https://developer-dashboard.boldcommerce.com/default/contactus"},"version":"1.0.0"},"servers":[{"url":"https://your-platform-connector.example"}],"security":[{"HMAC":[]}],"tags":[{"name":"Verification","description":"Use these endpoints to verify your platform connector destination."},{"name":"Customers","description":"Contains information about a customer, including name, contact info, and addresses. Bold calls these endpoints to manage customers on your platform."},{"name":"Addresses","description":"A child of the Customer resource. Contains information about a billing or shipping address associated with a given customer. Bold calls these endpoints to manage addresses on your platform."},{"name":"Orders","description":"Contains information about an order, including addresses, line items, payments, and additional order details. Bold calls these endpoints to manage orders on your platform."},{"name":"Products","description":"Contains information about a product, including names, descriptions, applicable options and variants, and other details. Bold calls these endpoints to retrieve information about the products on your platform."},{"name":"Categories","description":"Contains information about product categories, including names, image, and platform information. Bold calls these endpoints to retrieve information about the categories on your platform."}],"externalDocs":{"description":"For more information about Platform Connectors, refer to the Overview.","url":"https://developer.boldcommerce.com/guides/platform-connector"},"paths":{"/v1/shops/{shop_identifier}/verification":{"parameters":[{"$ref":"#/components/parameters/shopIdentifier"},{"$ref":"#/components/parameters/timestamp"},{"$ref":"#/components/parameters/userAgent"}],"get":{"tags":["Verification"],"summary":"Verify Platform Connector Destination","operationId":"VerifyPlatformConnectorDestination","description":"Confirms that you own a given Platform Connector destination. Bold calls this endpoint on your Platform Connector when you attempt to [Create](/api/platform-connector-destinations#operation/CreateDestination) or [Update](/api/platform-connector-destinations#operation/UpdateDestination) a destination.\\n\\nResponds with a calculated X-HMAC header containing the content of the sent X-HMAC-Timestamp header encoded with the shared secret.","responses":{"200":{"description":"Response indicating successful calculation of the included X-HMAC header.","headers":{"X-HMAC":{"schema":{"type":"string"},"description":"An HMAC signature calculated from the current shared secret (created in the Bold Account Center) and the value of the X-HMAC-Timestamp header. Bold verifies this signature before registering your platform connector destinations.\\nFor more information about verifying this signature, refer to [Implement Platform Connector APIs](/guides/platform-connector/create-server#verify-the-signature)."}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/verifyPlatformConnectorDestinationBody"}}}}}}},"/v1/shops/{shop_identifier}/customers":{"parameters":[{"$ref":"#/components/parameters/shopIdentifier"},{"$ref":"#/components/parameters/timestamp"},{"$ref":"#/components/parameters/userAgent"}],"post":{"tags":["Customers"],"summary":"Create Customer","operationId":"CreateCustomer","description":"Create a customer in your platform.\\n\\nThe request body contains a complete customer entity, you must persistently store on your platform.\\n\\nA successful response contains the same customer, with its associated `platform_id` and timestamps populated. The `platform_id` is unique, because Bold applications use it to identify the customer and its fields. The returned `platform_id` can be used in requests to other endpoints in this API.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/createCustomerRequestBody"}}},"required":true},"responses":{"201":{"description":"Returned upon successful creation of the customer.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/customerResponseBody"}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeErrorCustomer"},"examples":{"internalError":{"$ref":"#/components/examples/internalError"}}}}}}},"get":{"tags":["Customers"],"summary":"List Customers","operationId":"ListCustomers","description":"List customers that have made a purchase from your store. Include the `email` parameter to retrieve a certain customer.\\n\\nReturns a page of customers for your store, with `limit` as the maximum number of results and paginated by `cursor`. Return customers in ascending order of `platform_id`. If the request does not supply a limit (or supplies an invalid one), then use the default limit (250). \\n\\nEach `cursor` points to a location in the dataset. Cursors can be supplied to subsequent calls for additional data in the dataset. If no `cursor` is applied, return the first page of results.","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/cursor"},{"name":"email","in":"query","description":"An email used to filter the results.","schema":{"type":"string"},"example":"john.doe@example.com"}],"responses":{"200":{"description":"Response containing a list of customers when a successful request is made.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/listCustomersResponseBody"}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeErrorCustomer"},"examples":{"internalError":{"$ref":"#/components/examples/internalError"}}}}}}}},"/v1/shops/{shop_identifier}/customers/{platform_id}":{"parameters":[{"$ref":"#/components/parameters/shopIdentifier"},{"$ref":"#/components/parameters/customerId"},{"$ref":"#/components/parameters/timestamp"},{"$ref":"#/components/parameters/userAgent"}],"patch":{"tags":["Customers"],"summary":"Update Customer","operationId":"UpdateCustomer","description":"Update a customer specified by `platform_id`.\\n\\nReplace all fields of the customer object with the values provided in the request body. Ignore and do not update any fields omitted from the request body.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/updateCustomerRequestBody"}}},"required":true},"responses":{"200":{"description":"A successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/customerResponseBody"}}}},"404":{"description":"The customer specified by `platform_id` was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeErrorCustomer"},"examples":{"customerNotFound":{"$ref":"#/components/examples/customerNotFound"}}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeErrorCustomer"},"examples":{"internalError":{"$ref":"#/components/examples/internalError"}}}}}}},"delete":{"tags":["Customers"],"summary":"Delete Customer","operationId":"DeleteCustomer","description":"Delete a customer specified by `platform_id`. Mark the customer as deleted within the platform.","responses":{"204":{"description":"Returned upon successful deletion of the customer.","content":{"application/json":{"schema":{"type":"object"}}}},"404":{"description":"The customer specified by `platform_id` was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeErrorCustomer"},"examples":{"customerNotFound":{"$ref":"#/components/examples/customerNotFound"}}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeErrorCustomer"},"examples":{"internalError":{"$ref":"#/components/examples/internalError"}}}}}}}},"/v1/shops/{shop_identifier}/customers/{platform_id}/validate":{"parameters":[{"$ref":"#/components/parameters/shopIdentifier"},{"$ref":"#/components/parameters/customerId"},{"$ref":"#/components/parameters/timestamp"},{"$ref":"#/components/parameters/userAgent"}],"post":{"tags":["Customers"],"summary":"Validate Customer JWT","operationId":"ValidateCustomerJWT","description":"Validate the JWT to determine if it is a valid token and corresponds to the provided customer. The JWT is used to authorize the frontend code to perform various actions on behalf of the customer. For more information, refer to the [Initialize Order](orders#tag/Orders/operation/InitializeOrder) endpoint.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/customerValidateRequestBody"}}}},"responses":{"200":{"description":"Token information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/customerValidateResponseBody"}}}},"404":{"description":"The customer specified by `platform_id` was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeErrorCustomer"},"examples":{"customerNotFound":{"$ref":"#/components/examples/customerNotFound"}}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeErrorCustomer"},"examples":{"internalError":{"$ref":"#/components/examples/internalError"}}}}}}}},"/v1/shops/{shop_identifier}/customers/{platform_customer_id}/addresses":{"parameters":[{"$ref":"#/components/parameters/shopIdentifier"},{"$ref":"#/components/parameters/platformCustomerId"},{"$ref":"#/components/parameters/timestamp"},{"$ref":"#/components/parameters/userAgent"}],"post":{"tags":["Addresses"],"summary":"Create Address","operationId":"CreateAddress","description":"Create an address for a customer, specified by `platform_customer_id`.\\n\\nThe request body contains a complete address entity, which you must persistently store on the platform. A successful response contains the same address, including its associated `platform_id` and `platform_customer_id`. These IDs must be unique among addresses, because Bold applications use them to identify the address for the customer. Bold can use the returned `platform_id` to make requests to other address endpoints in this API.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/createAddressRequestBody"}}},"required":true},"responses":{"201":{"description":"Returned upon successful creation of the address.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/addressResponseBody"}}}},"404":{"description":"The customer specified by `platform_customer_id` was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeErrorCustomer"},"examples":{"customerNotFound":{"$ref":"#/components/examples/customerNotFound"}}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeErrorCustomer"},"examples":{"internalError":{"$ref":"#/components/examples/internalError"}}}}}}},"patch":{"tags":["Addresses"],"summary":"Update Address","operationId":"UpdateAddress","description":"Update an address. Bold indicates the address by the `platform_id` and the customer by the `platform_customer_id`.\\n\\nReplace all fields of an address object with the values provided in the request body. Ignore and do not change any fields omitted from the request body.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/updateAddressRequestBody"}}},"required":true},"responses":{"200":{"description":"A successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/addressResponseBody"}}}},"404":{"description":"The customer specified by `platform_customer_id` or the address specified by `platform_id` was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeErrorCustomer"},"examples":{"customerNotFound":{"$ref":"#/components/examples/customerNotFound"},"addressNotFound":{"$ref":"#/components/examples/addressNotFound"}}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeErrorCustomer"},"examples":{"internalError":{"$ref":"#/components/examples/internalError"}}}}}}}},"/v1/shops/{shop_identifier}/customers/{platform_customer_id}/addresses/{platform_id}":{"parameters":[{"$ref":"#/components/parameters/shopIdentifier"},{"$ref":"#/components/parameters/platformCustomerId"},{"$ref":"#/components/parameters/addressId"},{"$ref":"#/components/parameters/timestamp"},{"$ref":"#/components/parameters/userAgent"}],"delete":{"tags":["Addresses"],"summary":"Delete Address","operationId":"DeleteAddress","description":"Delete an address. Bold indicates the address by the `platform_id` and the customer by the `platform_customer_id`. Mark the address as deleted on the platform.","responses":{"204":{"description":"Returned upon successful deletion of the address.","content":{"application/json":{"schema":{"type":"object"}}}},"404":{"description":"The customer specified by `platform_customer_id` or the address specified by `platform_id` was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeErrorCustomer"},"examples":{"customerNotFound":{"$ref":"#/components/examples/customerNotFound"},"addressNotFound":{"$ref":"#/components/examples/addressNotFound"}}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeErrorCustomer"},"examples":{"internalError":{"$ref":"#/components/examples/internalError"}}}}}}}},"/v1/shops/{shop_identifier}/orders":{"parameters":[{"$ref":"#/components/parameters/shopIdentifier"},{"$ref":"#/components/parameters/timestamp"},{"$ref":"#/components/parameters/userAgent"}],"post":{"tags":["Orders"],"summary":"Create Order","operationId":"CreateOrder","description":"Create an order on the platform.\\n\\nThe request body contains a complete order entity, which you must persistently store on your platform.\\n\\nA successful response contains the same order, with its associated `platform_id` and timestamps populated. The `platform_id` is unique, because Bold applications use it to identify the order and its fields. Bold uses the returned `platform_id` to make requests to other endpoints in this API.","parameters":[{"$ref":"#/components/parameters/idempotencyKey"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/createOrderRequestBody"}}},"required":true},"responses":{"201":{"description":"Returned upon successful creation of the order.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/orderResponseBody"}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeErrorOrder"},"examples":{"internalError":{"$ref":"#/components/examples/internalError"}}}}}}},"get":{"tags":["Orders"],"summary":"List Orders","operationId":"ListOrders","description":"List all orders made on a store.\\n\\nReturn a page of orders from your store, with `limit` as the maximum number of results and paginated by `cursor`. Return orders in ascending order of `platform_id`. If the request does not supply a limit (or supplies an invalid one), then use the default limit (250). \\n\\nEach `cursor` points to a location in the dataset. Cursors can be supplied to subsequent calls for additional data in the dataset. If no `cursor` is supplied, return the first page of results.","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/cursor"}],"responses":{"200":{"description":"A successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/listOrdersResponseBody"}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeErrorOrder"},"examples":{"internalError":{"$ref":"#/components/examples/internalError"}}}}}}}},"/v1/shops/{shop_identifier}/orders/{platform_id}":{"parameters":[{"$ref":"#/components/parameters/shopIdentifier"},{"$ref":"#/components/parameters/orderId"},{"$ref":"#/components/parameters/timestamp"},{"$ref":"#/components/parameters/userAgent"}],"get":{"tags":["Orders"],"summary":"Get Order","operationId":"GetOrder","description":"Retrieve an order placed on your store by the specified `platform_id`.","responses":{"200":{"description":"Response containing the specified order.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/orderResponseBody"}}}},"404":{"description":"The order specified by `platform_id` was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeErrorOrder"},"examples":{"orderNotFound":{"$ref":"#/components/examples/orderNotFound"}}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeErrorOrder"},"examples":{"internalError":{"$ref":"#/components/examples/internalError"}}}}}}},"patch":{"tags":["Orders"],"summary":"Update Order","operationId":"UpdateOrder","description":"Update an order specified by `platform_id`.\\n\\nReplace all fields of the order object with the values provided in the request body. Ignore and do not update any fields omitted from the request body.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/updateOrderRequestBody"}}},"required":true},"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/orderResponseBody"}}}},"404":{"description":"The order specified by `platform_id` was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeErrorOrder"},"examples":{"orderNotFound":{"$ref":"#/components/examples/orderNotFound"}}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeErrorOrder"},"examples":{"internalError":{"$ref":"#/components/examples/internalError"}}}}}}}},"/v1/shops/{shop_identifier}/orders/{platform_id}/payments":{"parameters":[{"$ref":"#/components/parameters/shopIdentifier"},{"$ref":"#/components/parameters/orderId"},{"$ref":"#/components/parameters/timestamp"},{"$ref":"#/components/parameters/userAgent"}],"post":{"tags":["Orders"],"summary":"Create Payment","operationId":"CreatePayment","description":"Create a payment associated with a given order.\\n\\nThe request body contains a complete order entity, which you must persistently store on your platform.\\n\\nA successful response contains the same payment, with its associated `platform_id` and timestamps populated. The `platform_id` must be unique, because Bold applications use it to identify the payment and its fields. The returned `platform_id` can be used in requests to other endpoints in this API.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/createPaymentRequestBody"}}},"required":true},"responses":{"201":{"description":"Returned upon successful creation of the payment.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/paymentResponseBody"}}}},"404":{"description":"The order specified by `platform_id` was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeErrorOrder"},"examples":{"orderNotFound":{"$ref":"#/components/examples/orderNotFound"}}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeErrorOrder"},"examples":{"internalError":{"$ref":"#/components/examples/internalError"}}}}}}}},"/v1/shops/{shop_identifier}/orders/{order_platform_id}/payments/{platform_id}":{"parameters":[{"$ref":"#/components/parameters/shopIdentifier"},{"$ref":"#/components/parameters/orderPlatformId"},{"$ref":"#/components/parameters/paymentId"},{"$ref":"#/components/parameters/timestamp"},{"$ref":"#/components/parameters/userAgent"}],"patch":{"tags":["Orders"],"summary":"Update Payment","operationId":"UpdatePayment","description":"Update a payment associated with a specific order. Specify the payment by `platform_id` and the order by `order_platform_id`.\\n\\nReplace all fields of the payment object with the values provided in the request body. Ignore and do not update any fields omitted from the request body.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/updatePaymentRequestBody"}}},"required":true},"responses":{"200":{"description":"Returned upon successful updating of the payment.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/paymentResponseBody"}}}},"404":{"description":"The payment specified by `platform_id` was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeErrorOrder"},"examples":{"orderNotFound":{"$ref":"#/components/examples/orderNotFound"},"paymentNotFound":{"$ref":"#/components/examples/paymentNotFound"}}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeErrorOrder"},"examples":{"internalError":{"$ref":"#/components/examples/internalError"}}}}}}}},"/v1/shops/{shop_identifier}/products":{"parameters":[{"$ref":"#/components/parameters/shopIdentifier"},{"$ref":"#/components/parameters/userAgent"},{"$ref":"#/components/parameters/timestamp"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/cursor"}],"get":{"tags":["Products"],"summary":"List Products","operationId":"ListProducts","description":"List all products that exist in your store.\\n\\nReturn a page of products for your store, with `limit` as the maximum number of results and paginated by `cursor`. Return products in ascending order of `platform_id`. If the request does not supply a limit (or supplies an invalid one), use the default limit (250).\\n\\nEach `cursor` points to a location in the dataset. Cursors can be supplied to subsequent calls for additional data in the dataset. If no `cursor` is supplied, return the first page of results.","responses":{"200":{"description":"Response containing a list of products when a successful request is made.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/listProductsResponseBody"}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeErrorProduct"}}}}}}},"/v1/shops/{shop_identifier}/categories":{"parameters":[{"$ref":"#/components/parameters/shopIdentifier"},{"$ref":"#/components/parameters/userAgent"},{"$ref":"#/components/parameters/timestamp"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/cursor"}],"get":{"tags":["Categories"],"summary":"List Categories","operationId":"ListCategories","description":"Lists all product categories in a given store.\\n\\nReturn a page of product categories for your store, with `limit` as the maximum number of results and paginated by `cursor`. Return categories in ascending order of `platform_id`. If the request does not supply a limit (or supplies an invalid one), use the default limit (250).\\n\\nEach cursor points to a location in the dataset. Cursors can be supplied to subsequent calls for additional data in the dataset. If no `cursor` is supplied, return the first page of results.","responses":{"200":{"description":"Response containing a list of categories when a successful request is made.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/listCategoriesResponseBody"}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeErrorProduct"}}}}}}}},"components":{"securitySchemes":{"HMAC":{"type":"apiKey","name":"X-HMAC","in":"header","description":"An HMAC signature calculated from the current shared secret (created in Bold Account Center) and the value of the X-HMAC-Timestamp header.\\n\\nFor more information about verifying this signature, refer to [Implement Platform Connector APIs](/guides/platform-connector/create-server#verify-the-signature)."}},"schemas":{"verifyPlatformConnectorDestinationBody":{"type":"object"},"customer":{"type":"object","allOf":[{"$ref":"#/components/schemas/customerBase"}],"properties":{"addresses":{"description":"A list of customer addresses.","type":"array","items":{"$ref":"#/components/schemas/customerAddress"}},"platform_created_at":{"description":"The date (in [RFC 3339 format](https://datatracker.ietf.org/doc/html/rfc3339)) that this customer was created on the platform. Assigned by the platform.","type":"string","format":"date-time","example":"2021-03-11T17:16:51Z"},"platform_updated_at":{"description":"The date this customer was last modified on the platform, (in [RFC 3339 format](https://datatracker.ietf.org/doc/html/rfc3339)). Assigned by the platform.","type":"string","format":"date-time","example":"2021-03-11T17:16:51Z"},"platform_id":{"description":"A unique identifier for the customer. Assigned by the platform.","type":"string","example":"customer-123456"}}},"customerBase":{"type":"object","properties":{"email":{"description":"The email address for the customer.","type":"string","format":"email","example":"john.doe@example.com"},"first_name":{"description":"The first name of the customer.","type":"string","example":"John"},"last_name":{"description":"The last name of the customer.","type":"string","example":"Doe"},"phone":{"description":"The phone number for the customer.","type":"string","format":"phone","example":"555-555-5555"}}},"customerNew":{"type":"object","allOf":[{"$ref":"#/components/schemas/customerBase"},{"required":["email"],"properties":{"addresses":{"description":"A list of customer addresses.","type":"array","items":{"$ref":"#/components/schemas/addressNew"}}}}]},"customerUpdate":{"type":"object","allOf":[{"$ref":"#/components/schemas/customerBase"}],"properties":{"addresses":{"description":"A list of customer addresses.","type":"array","items":{"$ref":"#/components/schemas/addressNew"}}}},"address":{"type":"object","allOf":[{"$ref":"#/components/schemas/addressBaseOrder"}],"properties":{"platform_id":{"description":"Unique identifier for the address. Assigned by the platform.","type":"string","example":"address-123456"},"platform_customer_id":{"description":"Unique identifier for the customer. Assigned by the platform.","type":"string","example":"customer-123456"}}},"addressBaseCustomer":{"type":"object","properties":{"address_type":{"description":"The type of the address (i.e., residential, commercial).","type":"string","example":"commercial"},"address_use":{"description":"The usage of the address. Possible values are `\\"billing\\"` or `\\"shipping\\"`.","type":"string","enum":["billing","shipping"],"example":"billing"},"company":{"description":"The name of the company operating at the specified address, if applicable.","type":"string","example":"Acme Corp."},"city":{"description":"The name of the city associated with the address.","type":"string","example":"Winnipeg"},"country":{"description":"The name of the country associated with the address.","type":"string","example":"Canada"},"country_code":{"description":"The country code (in [ISO 3166-1 alpha-2 format](https://www.iso.org/iso-3166-country-codes.html)) of the address.","type":"string","example":"CA"},"is_default":{"description":"Indicates whether this is the default address for the customer. There can only be one default address for a customer. If this modifies any other resources, ensure the [appropriate event notifications](platform-event-notifications#tag/Customer-Event-Notifications/operation/CustomerSavedEventNotification) are triggered for those affected by this change.","type":"boolean","format":"boolean","example":true},"first_name":{"description":"The first name of the customer with the address.","type":"string","example":"John"},"last_name":{"description":"The last name of the customer with the address.","type":"string","example":"Doe"},"phone":{"description":"The phone number of the address.","type":"string","format":"phone","example":"555-555-5555"},"postal_code":{"description":"The postal code or zip code for the address.","type":"string","example":"H0H 0H0"},"province":{"description":"The province or state for the address.","type":"string","example":"Manitoba"},"province_code":{"description":"The province or state abbreviation for the address.","type":"string","example":"MB"},"street_1":{"description":"The primary street information for the address.","type":"string","example":"123 North Road"},"street_2":{"description":"Any additional street information for the address.","type":"string","example":""}}},"addressNew":{"type":"object","allOf":[{"$ref":"#/components/schemas/addressBaseCustomer"}]},"customerAddress":{"type":"object","allOf":[{"$ref":"#/components/schemas/addressBaseCustomer"}],"properties":{"platform_id":{"description":"A unique identifier for the address. Assigned by the platform.","type":"string","example":"address-123456"}}},"createCustomerRequestBody":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/createCustomerRequestData"}}},"createCustomerRequestData":{"type":"object","properties":{"customer":{"$ref":"#/components/schemas/customerNew"}}},"updateCustomerRequestBody":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/updateCustomerRequestData"}}},"updateCustomerRequestData":{"type":"object","properties":{"customer":{"$ref":"#/components/schemas/customerUpdate"}}},"customerResponseBody":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/customerResponseData"}}},"customerResponseData":{"type":"object","properties":{"customer":{"$ref":"#/components/schemas/customer"}}},"createAddressRequestBody":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/createAddressRequestData"}}},"createAddressRequestData":{"type":"object","properties":{"address":{"$ref":"#/components/schemas/addressNew"}}},"updateAddressRequestBody":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/updateAddressRequestData"}}},"updateAddressRequestData":{"type":"object","properties":{"address":{"$ref":"#/components/schemas/addressNew"}}},"addressResponseBody":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/addressResponseData"}}},"addressResponseData":{"type":"object","properties":{"address":{"$ref":"#/components/schemas/address"}}},"runtimeErrorCustomer":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"A code used to identify the error."},"message":{"type":"string","description":"A long description of the error."},"type":{"type":"string","description":"A short description of the error."}}}}}},"customerValidateRequestBody":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/customerValidateRequestData"}}},"customerValidateRequestData":{"type":"object","properties":{"token_info":{"$ref":"#/components/schemas/tokenInfo"}}},"tokenInfo":{"type":"object","required":["token"],"properties":{"token":{"type":"string","description":"The token to inspect.","example":"98qf34jwe0rwfhjqop4wa98af"}}},"customerValidateResponseBody":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/customerValidateResponseData"}}},"customerValidateResponseData":{"type":"object","properties":{"token_status":{"$ref":"#/components/schemas/tokenStatus"}}},"listCustomersResponseBody":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/listCustomersResponseData"},"pagination":{"$ref":"#/components/schemas/paginationResponse"}}},"listCustomersResponseData":{"type":"object","properties":{"customers":{"type":"array","items":{"$ref":"#/components/schemas/customer"}}}},"tokenStatus":{"type":"object","required":["active"],"properties":{"active":{"type":"boolean","description":"Indicates whether the presented token is active and belongs to the provided `customer_platform_id`."}}},"createOrderRequestBody":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/createOrderRequestData"}}},"createOrderRequestData":{"type":"object","properties":{"order":{"$ref":"#/components/schemas/orderRequest"}}},"updateOrderRequestBody":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/updateOrderRequestData"}}},"updateOrderRequestData":{"type":"object","properties":{"order":{"$ref":"#/components/schemas/orderUpdateRequest"}}},"createPaymentRequestBody":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/createPaymentRequestData"}}},"createPaymentRequestData":{"type":"object","properties":{"payment":{"$ref":"#/components/schemas/paymentRequest"}}},"updatePaymentRequestBody":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/updatePaymentRequestData"}}},"updatePaymentRequestData":{"type":"object","properties":{"payment":{"$ref":"#/components/schemas/updatePaymentRequest"}}},"orderResponseBody":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/orderResponseData"}}},"orderResponseData":{"type":"object","properties":{"order":{"$ref":"#/components/schemas/order"}}},"listOrdersResponseBody":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/listOrdersResponseData"},"pagination":{"$ref":"#/components/schemas/paginationResponse"}}},"listOrdersResponseData":{"type":"object","properties":{"orders":{"type":"array","items":{"$ref":"#/components/schemas/order"}}}},"paymentResponseBody":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/paymentResponseData"}}},"paymentResponseData":{"type":"object","properties":{"payment":{"$ref":"#/components/schemas/payment"}}},"orderRequest":{"type":"object","allOf":[{"$ref":"#/components/schemas/orderBase"}],"properties":{"shipping_addresses":{"description":"A list of shipping addresses for the order.","type":"array","items":{"$ref":"#/components/schemas/addressRequest"}},"billing_address":{"description":"The billing address for the order.","allOf":[{"$ref":"#/components/schemas/addressRequest"}]},"line_items":{"description":"A list of line items for the order.","type":"array","items":{"$ref":"#/components/schemas/lineItemRequest"}},"payments":{"description":"A list of payments for this order.","type":"array","items":{"$ref":"#/components/schemas/paymentRequest"}}}},"orderUpdateRequest":{"type":"object","properties":{"fulfillment_status":{"description":"The fulfillment status of each line item on the order.","type":"string","enum":["pending","partial","delivered","fulfilled"],"example":"partial"},"financial_status":{"description":"The status of payments associated with the order. This field can only be set when the order is created and cannot be changed if the order is updated.","type":"string","enum":["held_for_review","disputed","cancelled","pending","preauthed","refunded","partially_paid","partially_refunded","paid"],"example":"pending"},"refunded_amount":{"description":"The total refunded amount, if any, applied to the order. Measured in units of the order currency.","type":"string","format":"double","example":"0"},"notes":{"description":"Any internal notes about the order.","type":"string","example":"Handle with care."},"custom_attributes":{"description":"A series of key-value pairs of additional metadata relevant to the order.","type":"object","additionalProperties":{"$ref":"#/components/schemas/customAttribute"}},"shipping_addresses":{"description":"List of shipping addresses for the order.","type":"array","items":{"$ref":"#/components/schemas/addressRequest"}},"subtotal":{"description":"The subtotal of the line items on the order, in the order\'s given currency.\\n\\n**Note:** Calculate the subtotal before taxes and discounts (if those values are not included in the line item prices).\\n","type":"string","format":"double"},"subtotal_tax":{"description":"The tax to be charged on all line items, in the order\'s given currency.","type":"string","format":"double","example":"0.7"}}},"order":{"type":"object","allOf":[{"$ref":"#/components/schemas/orderBase"}],"properties":{"platform_id":{"description":"A unique identifier for the order. Assigned by the platform.","type":"string","example":"order-123456"},"platform_updated_at":{"description":"The date this order was last modified on the platform, in [RFC 3339 format](https://datatracker.ietf.org/doc/html/rfc3339). Assigned by the platform.","type":"string","format":"date-time","example":"2019-08-24T14:15:22Z"},"shipping_addresses":{"description":"A list of shipping addresses for the order.","type":"array","items":{"$ref":"#/components/schemas/addressOrder"}},"billing_address":{"description":"The billing address for the order.","allOf":[{"$ref":"#/components/schemas/addressOrder"}]},"line_items":{"description":"A list of line items included in the order.","type":"array","items":{"$ref":"#/components/schemas/lineItem"}},"payments":{"description":"A list of payments for the order.","type":"array","items":{"$ref":"#/components/schemas/payment"}},"placed_at":{"description":"The date this order was placed on the platform, in [RFC 3339 format](https://datatracker.ietf.org/doc/html/rfc3339). Assigned by the platform.","type":"string","format":"date-time","example":"2019-08-24T14:15:22Z"}},"required":["total","total_tax","subtotal","subtotal_tax","shipping_subtotal","shipping_tax"]},"orderBase":{"type":"object","properties":{"order_number":{"description":"A human-readable identifier for the order.","type":"string","example":"ORDER_XXYY1122"},"platform_customer_id":{"description":"A unique identifier for the customer associated to this order. Assigned by the platform.","type":"string","example":"customer-123456"},"platform_friendly_id":{"description":"A unique identifier for the order on the platform. This field is used to identify the order on the platform and is used by the Bold Checkout Admin to link the order to the platform.","type":"string","example":"PT-0065"},"shipping_method":{"description":"The shipping method for the order.","type":"string","example":"freight"},"shipping_code":{"description":"The shipping method code for the order. Each store defines its own shipping codes.","type":"string","example":"S001"},"browser_ip":{"description":"The browser IP under which the order was placed by the customer.","type":"string","example":"127.0.0.1"},"source":{"description":"A label noting the mechanism which placed this order.","type":"string","example":"POS"},"created_via":{"description":"A label noting which app created the order (if applicable).","type":"string","example":"Bold Checkout"},"locale":{"description":"The locale code of the order (either in [ISO-639 language code format](https://www.iso.org/iso-639-language-codes.html) or in [ISO/IEC-15897 regional language format](https://www.iso.org/standard/50707.html)).","type":"string","example":"en_US"},"test":{"description":"Indicates whether this is a test order.","type":"boolean","example":false},"notes":{"description":"Any internal notes about the order.","type":"string","example":"High priority"},"public_notes":{"description":"Any customer-facing notes about the order.","type":"string","example":"Handle with care."},"custom_attributes":{"description":"Any key-value pairs of metadata relevant to the order.","type":"object","additionalProperties":{"$ref":"#/components/schemas/customAttribute"}},"shipping_subtotal":{"description":"The shipping cost for the ordered items, in the order\'s given currency. Calculated before taxes.","type":"string","format":"double","example":"5.00"},"shipping_tax":{"description":"The sum of all shipping taxes for the ordered items, in the order\'s given currency.","type":"string","format":"double","example":"1.00"},"shipping_taxes":{"description":"A list of individual shipping taxes for each line item on the order.","type":"array","items":{"$ref":"#/components/schemas/tax"}},"discount":{"description":"The total amount discounted from the order, in the order\'s given currency. If there is no discount, set this field to `\\"0\\"`.\\n\\n**Note:** If `discount` is included in the payload, the `total` and `total_tax` values are required.","type":"string","format":"double","example":"0"},"discounts":{"description":"The list of discounts applied to the order.","type":"object","additionalProperties":{"$ref":"#/components/schemas/orderDiscount"}},"subtotal":{"description":"The subtotal of the line items on the order, in the order\'s given currency.\\n\\n**Note:** Calculate the subtotal before taxes and discounts (if those values are not included in the line item prices).","type":"string","format":"double","example":"10.00"},"subtotal_tax":{"description":"The tax to be charged on all line items, in the order\'s given currency.","type":"string","format":"double","example":"0.7"},"total_tax":{"description":"The total tax on the full order, in the order\'s given currency, including: `subtotal_tax`, `shipping_tax`, and any other special taxes pending for the order.","type":"string","format":"double","example":"0.7"},"total":{"description":"The total order cost, in the order\'s given currency.\\n\\n**Note:** This number includes taxes and is reduced by the discount.","type":"string","format":"double","example":"16.07"},"refunded_amount":{"description":"The refunded amount of the order, if any, in the order\'s given currency.","type":"string","format":"double","example":"0"},"currency":{"description":"The base currency used for the order (in [ISO-4217 currency code format](https://www.iso.org/iso-4217-currency-codes.html)).","type":"string","example":"CAD"},"order_status":{"description":"The current status of the order. Indicates whether the order is `active` or has been `cancelled`.","type":"string","enum":["active","cancelled"],"example":"active"},"fulfillment_status":{"description":"The fulfillment status of the order.","type":"string","enum":["pending","partial","delivered","fulfilled"],"example":"fulfilled"},"financial_status":{"description":"The status of payments associated with the order. This field can only be set when the order is created and cannot be changed if the order is updated.","type":"string","enum":["held_for_review","disputed","cancelled","pending","preauthed","refunded","partially_paid","partially_refunded","paid"],"example":"pending"}}},"lineItem":{"type":"object","allOf":[{"$ref":"#/components/schemas/lineItemBase"}],"properties":{"platform_id":{"description":"Unique identifier for the line item. Assigned by the platform.","type":"string","example":"line-item-123456"}}},"lineItemRequest":{"type":"object","allOf":[{"$ref":"#/components/schemas/lineItemBase"}]},"lineItemBase":{"type":"object","properties":{"platform_product_id":{"description":"Unique identifier for the product referenced in this line item. Assigned by the platform.","type":"string","example":"product-123456"},"platform_variant_id":{"description":"Unique identifier for the variant referenced in this line item. Assigned by the platform.","type":"string","example":"variant-123456"},"cart_line_item_platform_id":{"description":"Unique identifier for the cart line item. Assigned by the platform.","type":"string","example":"cart-line-item-123456"},"custom_attributes":{"description":"Key-value pairs of metadata relevant to the line item.","type":"object","additionalProperties":{"$ref":"#/components/schemas/customAttribute"}},"title":{"description":"Title of the line item.","type":"string","example":"Shoes (long-laced classic)"},"sku":{"description":"SKU of the line item.","type":"string"},"url":{"description":"Link to the line item in the store.","type":"string"},"image":{"description":"Image of the line item.","type":"string"},"quantity":{"description":"Quantity ordered for this line item.","type":"integer","format":"int64"},"grams":{"description":"Weight in grams of the line item.","type":"number","format":"double"},"weight":{"description":"Weight of the line item (measured in terms of `weight_unit`).","type":"number","format":"double"},"weight_unit":{"description":"Unit which weight is measured in.","type":"string"},"taxable":{"description":"Indicator of whether the line item is taxable.","type":"boolean"},"taxes":{"description":"List of taxes for the line item.","type":"array","items":{"$ref":"#/components/schemas/tax"}},"requires_shipping":{"description":"Indicator of whether the line item requires shipping.","type":"boolean"},"price_per_item":{"description":"Price per unit of the line item, in the order\'s given currency.\\n\\n**Note**: This price should be calculated before taxes and discounts (if taxes are not included in price).\\n","type":"string","format":"double"},"discount_per_item":{"description":"Discount of the line item, in the order\'s given currency.","type":"string","format":"double"},"total":{"description":"Grand total price of the line item, in the order\'s given currency.\\n\\n**Note**: This price includes taxes and discounts.\\n","type":"string","format":"double"},"subtotal":{"description":"Total price of the line item, measured in the order\'s currency.\\n\\n**Note**: This value is calculated using price multiplied by quantity, excluding tax.\\n","type":"string","format":"double"},"total_tax":{"description":"Total tax of the line item, in the order\'s given currency.","type":"string","format":"double","example":"0.7"},"discounted_subtotal":{"description":"Discounted total price of the line item, in the order\'s given currency.\\n\\n**Note**:  This value is calculated using discounted price multiplied by quantity, excluding tax.\\n","type":"string","format":"double"}}},"tax":{"type":"object","properties":{"amount":{"description":"Total tax amount pending, measured in the order\'s given currency.","type":"string","format":"double","example":"0.7"},"name":{"description":"Human-readable name for this tax.","type":"string","example":"Provincial Sales Tax"},"rate":{"description":"Percent tax (value between 0 to 1)","type":"string","example":"0.07"},"tag":{"description":"Reference tag for the tax","type":"string","example":"PST"}}},"orderDiscount":{"type":"object","properties":{"platform_id":{"type":"string","description":"A unique identifier for the discount. Defined by the platform.","example":"discount-123456"},"amount":{"description":"The discounted amount applied to the order, measured in the order\'s given currency.","type":"string","format":"double","example":"5.00"},"discount_code":{"type":"string","description":"The code used to apply the discount.","example":"20OFF"}}},"paymentRequest":{"type":"object","allOf":[{"$ref":"#/components/schemas/paymentBase"}],"properties":{"transactions":{"description":"A list of transactions for the payment. Multiple transactions can be associated with a single payment","type":"array","items":{"$ref":"#/components/schemas/transactionRequest"}},"description":{"description":"A human-readable description of the payment.","type":"string","example":"credit_card"},"provider":{"description":"A label indicating the organization handling the payment and transactions.","type":"string","example":"stripe"},"payment_method":{"description":"The payment method used.","type":"string","example":"credit card"},"currency":{"description":"The currency used for the payment, in [ISO-4217 currency code format](https://www.iso.org/iso-4217-currency-codes.html).","type":"string","example":"CAD"},"amount_planned":{"description":"The amount that the payment provider plans to charge for the payment, in the payment\'s given currency. If the payment has been completed, this amount reflects the amount charged. This value typically matches the order `total`.","type":"string","format":"double","example":"16.07"},"custom_attributes":{"description":"A series of key-value pairs of metadata relevant to the payment.","type":"object","additionalProperties":{"$ref":"#/components/schemas/customAttribute"}}}},"updatePaymentRequest":{"type":"object","allOf":[{"$ref":"#/components/schemas/paymentBase"}],"properties":{"transactions":{"description":"A list of transactions for the payment.","type":"array","items":{"$ref":"#/components/schemas/transactionRequest"}}}},"payment":{"type":"object","allOf":[{"$ref":"#/components/schemas/paymentBase"}],"properties":{"platform_id":{"description":"A unique identifier for the payment. Assigned by the platform.","type":"string","example":"payment-123456"},"transactions":{"description":"A list of transactions for the payment.","type":"array","items":{"$ref":"#/components/schemas/transaction"}},"description":{"description":"A human-readable description of the payment.","type":"string","example":"Credit card payment"},"provider":{"description":"The organization handling the payment and transactions.","type":"string","example":"stripe"},"payment_method":{"description":"The payment method used.","type":"string","example":"credit card"},"currency":{"description":"The currency used for the payment, in [ISO-4217 currency code format](https://www.iso.org/iso-4217-currency-codes.html).","type":"string","example":"CAD"},"amount_planned":{"description":"The amount that the payment provider plans to charge for the payment, in the payment\'s given currency. If the payment has been completed, this amount reflects the amount charged. This value typically matches the order `total`.","type":"string","format":"double","example":"16.07"},"custom_attributes":{"description":"A series of key-value pairs of metadata relevant to the payment.","type":"object","additionalProperties":{"$ref":"#/components/schemas/customAttribute"}}}},"paymentBase":{"type":"object","properties":{"status":{"description":"The status of the payment. Values are dependent on the payment provider used and should be passed through as-is.","type":"string","example":"paid"}}},"transaction":{"type":"object","allOf":[{"$ref":"#/components/schemas/transactionBase"}],"properties":{"platform_id":{"description":"A unique identifier for the transaction. Assigned by the platform.","type":"string","example":"transaction-123456"}}},"transactionRequest":{"type":"object","allOf":[{"$ref":"#/components/schemas/transactionBase"}],"properties":{"platform_id":{"description":"A unique identifier for the transaction. Assigned by the platform.","type":"string","example":"transaction-123456"}}},"transactionBase":{"type":"object","properties":{"provider_transaction_id":{"description":"A unique identifier for the transaction. Assigned by the payment provider.","type":"string","example":"provider-transaction-123456"},"amount":{"description":"The amount captured in this transaction, in the transaction\'s given currency.\\n\\n**Note:** If the transaction is a refund, this amount is negative.","type":"string"},"currency":{"description":"The currency used for the transaction (in [ISO-4217 currency code format](https://www.iso.org/iso-4217-currency-codes.html)).","type":"string","example":"CAD"},"status":{"description":"The status of the transaction.","type":"string","enum":["initial","pending","failure","success"],"example":"pending"},"type":{"description":"The type of transaction.","type":"string","enum":["authorization","charge","refund"],"example":"charge"}}},"customAttribute":{"type":"object","properties":{"description":{"description":"The description of the attribute.","type":"string","example":"key-1"},"value":{"description":"The value of the attribute.","type":"string","example":"value-1"}}},"addressOrder":{"type":"object","allOf":[{"$ref":"#/components/schemas/addressBaseOrder"}],"properties":{"platform_id":{"description":"A unique identifier for the address. Assigned by the platform.","type":"string","example":"address-123456"}}},"addressRequest":{"type":"object","allOf":[{"$ref":"#/components/schemas/addressBaseOrder"}]},"addressBaseOrder":{"type":"object","properties":{"address_type":{"description":"The usage of the address. Possible values are `\\"billing\\"` or `\\"shipping\\"`.","type":"string","enum":["billing","shipping"],"example":"billing"},"first_name":{"description":"The addressee\'s first name.","type":"string","example":"John"},"last_name":{"description":"The addressee\'s last name.","type":"string","example":"Doe"},"street_1":{"description":"The primary street information.","type":"string","example":"123 North Road"},"street_2":{"description":"Any additional street information.","type":"string","example":"Suite 200"},"city":{"description":"The city name.","type":"string","example":"Winnipeg"},"province":{"description":"The name of the province or state.","type":"string","example":"Manitoba"},"country":{"description":"The country name.","type":"string","example":"Canada"},"country_code":{"description":"The country code of the address, in [ISO 3166-1 alpha-2 format](https://www.iso.org/iso-3166-country-codes.html).","type":"string","example":"CA"},"phone":{"description":"The phone number.","type":"string","example":"555-555-5555"},"postal_code":{"description":"The postal code or zip code.","type":"string","example":"H0H 0H0"},"email":{"description":"An email address.","type":"string","format":"email","example":"john.doe@example.com"},"province_code":{"description":"The province or state abbreviation.","type":"string","example":"MB"},"company":{"description":"The name of the company operating at the specified address, if applicable.","type":"string","example":"Acme Corp."}}},"runtimeErrorOrder":{"type":"object","properties":{"errors":{"type":"array","items":{"required":["code"],"type":"object","properties":{"code":{"type":"string","description":"The error code.","example":"09-1"},"message":{"type":"string","description":"A message describing the error.","example":"The order with the provided platform_id does not exist"},"type":{"type":"string","description":"The type of error.","example":"orders.does_not_exist"}}}}}},"product":{"type":"object","allOf":[{"$ref":"#/components/schemas/productBase"}],"properties":{"platform_id":{"type":"string","description":"A unique identifier for the product. Defined by the platform.","example":"product-123456"},"platform_updated_at":{"description":"The date the product was last updated on the platform.","type":"string","format":"date-time","example":"2021-03-11T17:16:51Z"},"categories":{"type":"array","description":"An array of product categories.","items":{"$ref":"#/components/schemas/category"}},"variants":{"type":"array","description":"An array of `variant` objects. At least one variant is required. If the product has no variants, the variant can reuse the product information.","items":{"$ref":"#/components/schemas/deepVariant"}},"options":{"type":"array","description":"An array of `option` objects. A more granular level of customization for variants. These are not required, but can be used to provide more options for your same variant.","items":{"$ref":"#/components/schemas/deepOption"}},"images":{"type":"array","description":"An array of images associated with the products.","items":{"$ref":"#/components/schemas/deepImage"}}}},"productBase":{"type":"object","properties":{"description":{"type":"string","description":"A description for the product.","example":"A hat for the beach"},"handle":{"type":"string","description":"A unique, human-readable string for the product.","example":"beach-hat"},"inventory_quantity":{"type":"integer","description":"The current inventory level of the product.","format":"int64","example":4},"inventory_tracking_entity":{"type":"string","description":"The entity on which inventory is tracked.","enum":["variant","product","none"],"example":"product"},"inventory_tracking_service":{"type":"string","description":"The service that tracks inventory.","example":"platform"},"localized_descriptions":{"type":"object","description":"A map of localized descriptions for the product. The field is the [ISO-639](https://www.iso.org/iso-639-language-codes.html) two character language code. The value is the product description in the given language.","additionalProperties":{"type":"string"},"example":{"en":"A hat for the beach","fr":"Un chapeau pour la plage"}},"localized_names":{"type":"object","description":"A map of localized names for the product. The field is the [ISO-639](https://www.iso.org/iso-639-language-codes.html) two character language code. The value is the product name in the given language.","additionalProperties":{"type":"string"},"example":{"en":"Beach Hat","fr":"Chapeau de Plage"}},"name":{"type":"string","description":"The name of the product.","example":"Beach hat"},"published":{"type":"boolean","format":"boolean","description":"Indicates whether the product is published on the storefront.","example":true},"tags":{"type":"string","description":"A string with comma separated values that describe the product.","example":"clothing, unisex, pants"},"tax_code":{"type":"string","description":"The tax code for the product.","example":"non-taxable"},"type":{"type":"string","description":"The product type. Used for searching.","example":"physical"},"url":{"type":"string","description":"The URL to the product on the storefront.","example":"/hats/beach-hat"},"vendor":{"type":"string","description":"The product vendor.","example":"OFS"}}},"listProductsResponseBody":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/listProductsResponseData"},"pagination":{"$ref":"#/components/schemas/paginationResponse"}}},"listProductsResponseData":{"type":"object","properties":{"products":{"type":"array","items":{"$ref":"#/components/schemas/product"}}}},"paginationResponse":{"type":"object","properties":{"next":{"type":"string","description":"A cursor to fetch the next page of results. Cursors have no requirements on how they are encoded, since they are opaque to the consumer.","example":"dGVzdGluZ3Rlc3Rpbmd0ZXN0aW5n"},"prev":{"type":"string","description":"A cursor to fetch the previous page of results. Cursors have no requirements on how they are encoded, since they are opaque to the consumer. Leave empty if there is no following dataset.","example":"dW50ZXN0dW50ZXN0dW50ZXN0"}}},"runtimeErrorProduct":{"type":"object","properties":{"errors":{"type":"array","items":{"required":["code"],"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"type":{"type":"string"}},"example":{"code":"07-1","message":"Request failed due to an internal server error.","type":"server.internal_error"}}}}},"deepVariant":{"type":"object","allOf":[{"$ref":"#/components/schemas/variantBase"}],"properties":{"platform_id":{"type":"string","description":"A unique identifier for the variant. Defined by the platform.","example":"variant-123456"},"option_values":{"type":"array","items":{"$ref":"#/components/schemas/variantOptionValue"}}}},"variantBase":{"type":"object","description":"An array of `variant` objects. At least one variant is required. If the product has no variants, the variant can reuse the product information.","properties":{"allow_backorder":{"description":"If backorders of the variant are allowed.","type":"boolean","format":"boolean","example":true},"compare_at_price":{"description":"The original price of the item before an adjustment or a sale.","type":"string","example":"30.00"},"cost":{"description":"The cost of the product variant.","type":"string","example":"30.00"},"grams":{"description":"The weight of the product variant in grams.","type":"integer","format":"int64"},"image_url":{"description":"URL of the image.","type":"string","example":"your_platform_connector.com/files/products/hats/purple-beach-hat.jpg"},"inventory_quantity":{"description":"Current inventory level of the product.","type":"integer","format":"int64"},"inventory_tracking_entity":{"type":"string","description":"Entity on which inventory is tracked.","enum":["variant","product","none"]},"inventory_tracking_service":{"type":"string","description":"Service that tracks inventory.","example":"platform"},"localized_names":{"type":"object","additionalProperties":{"type":"string"},"description":"Map of localized names for the variant. The field is the https://www.iso.org/iso-639-language-codes.html two character language code. The value is the product name in the given language.","example":{"en":"Purple","fr":"Violette"}},"name":{"description":"The name of the variant. If there is only one variant, the `name` must be \\"Default Title\\" in order to avoid displaying the same `name` twice.","type":"string","example":"Default Title"},"price":{"description":"The price of the variant","type":"string","example":"30.00"},"require_shipping":{"description":"True if the item needs to be shipped, false otherwise.","type":"boolean","format":"boolean"},"sku":{"description":"Variant SKU.","type":"string","example":"BEACH-HAT-PURPLE"},"tax_code":{"description":"Tax code for the variant.","type":"string","example":"non-taxable"},"tax_exempt":{"description":"Indicates whether the variant is tax-exempt. If `true`, the variant is tax-exempt.","type":"boolean","format":"boolean","nullable":true},"weight":{"type":"string","description":"The weight of the product variant, calculated with weight unit specified.","example":"1.0"},"weight_unit":{"type":"string","description":"The unit of measurement that applies to the product variant\'s weight.","example":"kg"}}},"variantOptionValue":{"type":"object","description":"A more granular level of customization for variants. These are not required, but can be used to provide more options for your same variant.","properties":{"platform_id":{"type":"string","description":"A unique identifier for the variant option value. Defined by the platform.","example":"variant-option-value-123456"},"platform_product_option_id":{"type":"string","description":"A unique identifier for the product option this value belongs to. Defined by the platform.","example":"product-option-123456"},"label":{"type":"string","description":"Label of the option value.","example":"small"},"name":{"type":"string","description":"Name of the option.","example":"Small"}}},"category":{"type":"object","allOf":[{"$ref":"#/components/schemas/categoryBase"}],"properties":{"platform_id":{"type":"string","description":"A unique identifier for the category. Defined by the platform.","example":"category-123456"},"platform_updated_at":{"description":"The date the category was last updated on the platform.","type":"string","format":"date-time","example":"2021-03-11T17:16:51Z"}}},"categoryBase":{"type":"object","properties":{"image_url":{"description":"Specifies the URL location of the category image.","type":"string","example":"your_platform_connector.com/files/categories/hats.jpg"},"name":{"description":"The name of the category.","type":"string","example":"Hats"}}},"listCategoriesResponseBody":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/listCategoriesResponseData"},"pagination":{"$ref":"#/components/schemas/paginationResponse"}}},"listCategoriesResponseData":{"type":"object","properties":{"categories":{"type":"array","items":{"$ref":"#/components/schemas/category"}}}},"deepImage":{"type":"object","allOf":[{"$ref":"#/components/schemas/imageBase"}],"properties":{"platform_id":{"type":"string","description":"A unique identifier for the image. Defined by the platform.","example":"image-123456"}}},"imageBase":{"type":"object","properties":{"name":{"description":"The image name.","type":"string","example":"Beach hat"},"src":{"description":"The image URL.","type":"string","example":"your_platform_connector.com/files/images/beach-hat.jpg"},"position":{"description":"The position on the list.","type":"integer","format":"int64","example":2}}},"deepOption":{"type":"object","allOf":[{"$ref":"#/components/schemas/optionBase"}],"properties":{"platform_id":{"type":"string","description":"A unique identifier for the product option. Defined by the platform.","example":"product-option-123456"},"option_values":{"type":"array","items":{"$ref":"#/components/schemas/deepOptionValue"}}}},"optionBase":{"type":"object","properties":{"name":{"description":"The option name.","type":"string","example":"Small"},"position":{"description":"The position on the list.","type":"integer","format":"int64","example":2}}},"deepOptionValue":{"type":"object","allOf":[{"$ref":"#/components/schemas/optionValueBase"}],"properties":{"platform_id":{"type":"string","description":"A unique identifier for the option value. Defined by the platform.","example":"option-value-123456"}}},"optionValueBase":{"type":"object","properties":{"is_default":{"type":"boolean","description":"Indicates whether this is the default option.","format":"boolean","example":true},"label":{"description":"The label of the option value.","type":"string","example":"Small"},"position":{"description":"The position on the list.","type":"integer","format":"int64","example":1}}}},"parameters":{"timestamp":{"name":"X-HMAC-Timestamp","in":"header","schema":{"type":"string","format":"date-time"},"required":true,"description":"The UTC server time (in [RFC 3339 format](https://datatracker.ietf.org/doc/html/rfc3339)) at the moment the request was sent, signed as a part of calculating X-HMAC and X-Compatible-HMAC values.","example":"2021-03-11T17:16:51Z"},"userAgent":{"name":"User-Agent","in":"header","schema":{"type":"string"},"required":true,"description":"A value to help filter traffic from Bold through any firewall system. Bold sends requests to your Platform Connector with the value `Bold-API`. You can adjust your firewall system to allow calls with this value to reach your Platform Connector.","example":"Bold-API"},"shopIdentifier":{"name":"shop_identifier","in":"path","description":"A unique identifier of the store. This can be retrieved by calling the [Get Shop Info](/api/shops#tag/Shops/operation/GetShopInfo) endpoint.","required":true,"schema":{"type":"string"},"example":"zp3oafdor9"},"customerId":{"name":"platform_id","in":"path","description":"A unique identifier for the customer. Assigned by the platform.","required":true,"schema":{"type":"string"},"example":"customer-123456"},"platformCustomerId":{"name":"platform_customer_id","in":"path","description":"Unique identifier for the customer. Assigned by the platform.","required":true,"schema":{"type":"string"},"example":"customer-123456"},"addressId":{"name":"platform_id","in":"path","description":"Unique identifier for the address. Assigned by the platform.","required":true,"schema":{"type":"string"},"example":"address-123456"},"orderId":{"name":"platform_id","in":"path","description":"Unique identifier for the order. Assigned by the platform.","required":true,"schema":{"type":"string"},"example":"order-123456"},"orderPlatformId":{"name":"order_platform_id","in":"path","description":"Unique identifier for the order. Assigned by the platform.","required":true,"schema":{"type":"string"},"example":"order-123456"},"paymentId":{"name":"platform_id","in":"path","description":"Unique identifier for the payment. Assigned by the platform.","required":true,"schema":{"type":"string"},"example":"payment-123456"},"idempotencyKey":{"name":"Idempotency-Key","in":"header","schema":{"type":"string"},"required":false,"description":"Use the HTTP idempotency request header field to carry an idempotency key in order to make non-idempotent HTTP methods, such as POST or PATCH, fault-tolerant.","example":"qaasc934qfj9aerf"},"limit":{"name":"limit","in":"query","description":"The maximum number of results to return per page.","schema":{"type":"integer","format":"int32","minimum":1,"maximum":250,"default":250},"example":100},"cursor":{"name":"cursor","in":"query","description":"A cursor to obtain the next page of results. Bold takes the value of the cursor directly from the `next` value in the response without any modifications.","schema":{"type":"string"},"example":"dW50ZXN0dW50ZXN0dW50ZXN0"}},"examples":{"customerNotFound":{"value":{"code":"404-1","message":"Customer not found.","type":"customer.not_found"}},"addressNotFound":{"value":{"code":"404-2","message":"Address not found.","type":"address.not_found"}},"internalError":{"value":{"code":500,"message":"Request failed due to an internal server error.","type":"server.internal_error"}},"orderNotFound":{"value":{"code":"404-1","message":"Order not found.","type":"order.not_found"}},"paymentNotFound":{"value":{"code":"404-2","message":"Payment not found.","type":"payment.not_found"}}}}}},"plugin-redoc-4":{"url":"/api/platform-event-notifications.openapi.yaml","themeId":"theme-redoc","isSpecFile":true,"spec":{"openapi":"3.0.0","info":{"title":"Platform Connector: Event Notifications","description":"This API allows platform connectors to push events to Bold when there are changes to a customer, order, or product resource. These events must trigger any time data changes on the platform (and Bold did not make this change). This ensures Bold applications are in sync with the platform and have access to the complete data set.\\n\\nAll successful responses from Bold contain an empty response body and return an HTTP 202 response code.\\n\\nRefer to the <a href=\\"https://developer.boldcommerce.com/changelog/tags/platform-connector\\">changelog</a> for the latest updates to this API.\\n> **Note:** This specification is only for use with a [Bold Platform Connector](/guides/platform-connector).\\n","termsOfService":"https://boldcommerce.com/terms-of-service","contact":{"name":"Contact Us","url":"https://developer-dashboard.boldcommerce.com/default/contactus"},"version":"1.0.0"},"servers":[{"url":"https://api.boldcommerce.com"}],"security":[{"OAuthToken":[]},{"APIAccessToken":[]}],"tags":[{"name":"Customer Event Notifications","description":"Event notifications you send to Bold when a change occurs to customers on the platform."},{"name":"Order Event Notifications","description":"Event notifications you send to Bold when a change occurs to orders on the platform."},{"name":"Product Event Notifications","description":"Event notifications you send to Bold when a change occurs to products on the platform."}],"externalDocs":{"description":"For more information about Platform Connectors, refer to the Overview.","url":"https://developer.boldcommerce.com/guides/platform-connector"},"paths":{"/customers/v1/shops/{shop_identifier}/platforms/custom/webhooks/customers/saved":{"parameters":[{"$ref":"#/components/parameters/shopIdentifier"}],"post":{"tags":["Customer Event Notifications"],"summary":"Customer Saved","operationId":"CustomerSavedEventNotification","description":"Trigger this API call when customer data changes on the platform. This includes customer creation, customer updates, and any changes to a customer\'s associated addresses.\\n\\nBold queues the customer for saving. The request must contain the complete customer object and its addresses at the time the change occurred. Bold replaces all fields of the existing customer object with the values provided in the request body. Bold ignores and does not update the fields omitted from the request body.\\n\\nThe `platform_updated_at` field must be accurate to mitigate the risk incurred by out-of-sequence requests.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/customerSavedRequestBody"}}},"required":true},"responses":{"202":{"description":"Event notification was queued successfully.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"A validation error occurred.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/validationError"},"examples":{"validationError":{"value":{"status_code":400,"errors":["Error at \'/data/customer/addresses/0/platform_id\': property \'platform_id\' is missing","Error at \'/data/customer/platform_id\': property \'platform_id\' is missing"]}}}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeErrorCustomer"},"examples":{"internalError":{"$ref":"#/components/examples/internalError"}}}}}}}},"/customers/v1/shops/{shop_identifier}/platforms/custom/webhooks/customers/deleted":{"parameters":[{"$ref":"#/components/parameters/shopIdentifier"}],"post":{"tags":["Customer Event Notifications"],"summary":"Customer Deleted","operationId":"CustomerDeletedEventNotification","description":"Trigger this API call when a customer is deleted on the platform.\\n\\nBold queues the customer for deletion. The `platform_deleted_at` field must be accurate to mitigate the risk incurred by out-of-sequence requests.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/customerDeletedRequestBody"}}},"required":true},"responses":{"202":{"description":"Event notification was queued successfully.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"A validation error occurred.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/validationError"},"examples":{"validationError":{"value":{"status_code":400,"errors":["Error at \'/data/customer/platform_id\': property \'platform_id\' is missing"]}}}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeErrorCustomer"},"examples":{"internalError":{"$ref":"#/components/examples/internalError"}}}}}}}},"/orders/v1/shops/{shop_identifier}/platforms/custom/webhooks/orders/saved":{"parameters":[{"$ref":"#/components/parameters/shopIdentifier"}],"post":{"tags":["Order Event Notifications"],"summary":"Order Saved","operationId":"OrderSavedEventNotification","description":"Trigger this API call when order data changes on the platform, including order creation and updates.\\n\\nBold queues the order for saving. The request must contain the complete order object at the time the change occurred. Bold replaces all fields of the existing order object with the values provided in the request body. Bold ignores and does not update fields omitted from the request body.\\n\\nThe `platform_updated_at` field must be accurate to mitigate the risk incurred by out-of-sequence requests.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/orderSavedRequestBody"}}},"required":true},"responses":{"202":{"description":"Event notification was queued successfully.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"A validation error occurred.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/validationError"},"examples":{"validationError":{"value":{"status_code":400,"errors":["Error at \'/data/order/payments/0/transactions/0/platform_id\': property \'platform_id\' is missing","Error at \'/data/order/platform_id\': property \'platform_id\' is missing"]}}}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeErrorOrder"},"examples":{"internalError":{"$ref":"#/components/examples/internalError"}}}}}}}},"/orders/v1/shops/{shop_identifier}/platforms/custom/webhooks/orders/deleted":{"parameters":[{"$ref":"#/components/parameters/shopIdentifier"}],"post":{"tags":["Order Event Notifications"],"summary":"Order Deleted","operationId":"OrderDeletedEventNotification","description":"Trigger this API call when an order is deleted on the platform.\\n\\nBold queues the order for deletion. The `platform_deleted_at` field must be accurate to mitigate the risk incurred by out-of-sequence requests.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/orderDeletedRequestBody"}}},"required":true},"responses":{"202":{"description":"Event notification was queued successfully.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"A validation error occurred.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/validationError"},"examples":{"validationError":{"value":{"status_code":400,"errors":["Error at \'/data/order/platform_id\': property \'platform_id\' is missing"]}}}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeErrorOrder"},"examples":{"internalError":{"$ref":"#/components/examples/internalError"}}}}}}}},"/products/v1/shops/{shop_identifier}/platforms/custom/webhooks/products/saved":{"parameters":[{"$ref":"#/components/parameters/shopIdentifier"}],"post":{"tags":["Product Event Notifications"],"summary":"Product Saved","operationId":"ProductSavedEventNotification","description":"Trigger this API call when product data changes, including product creation and updates.\\n\\nBold queues the product for saving. The request must contain the complete product object at the time the change occurred. Bold replaces all fields of the existing product object with the values provided in the request body. Bold ignores and does not update fields omitted from the request body. \\n\\nThe `platform_updated_at` field must be accurate to mitigate the risk incurred by out-of-sequence requests.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/productSavedRequestBody"}}},"required":true},"responses":{"202":{"description":"Event notification was queued successfully.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"A validation error occurred.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/validationError"},"examples":{"validationError":{"value":{"status_code":400,"errors":["Error at \'/data/product/platform_id\': property \'platform_id\' is missing.","Error at \'/data/product/variants/0/platform_id\': property \'platform_id\' is missing."]}}}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeErrorProduct"}}}}}}},"/products/v1/shops/{shop_identifier}/platforms/custom/webhooks/products/deleted":{"parameters":[{"$ref":"#/components/parameters/shopIdentifier"}],"post":{"tags":["Product Event Notifications"],"summary":"Product Deleted","operationId":"ProductDeletedEventNotification","description":"Trigger this API call when a product is deleted on the platform.\\n\\nBold queues the product for deletion. The `platform_deleted_at` field must be accurate to mitigate the risk incurred by out-of-sequence requests.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/productDeletedRequestBody"}}},"required":true},"responses":{"202":{"description":"Event notification was queued successfully.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"A validation error occurred.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/validationError"},"examples":{"validationError":{"value":{"status_code":400,"errors":["Error at \'/data/product/platform_id\': property \'platform_id\' is missing."]}}}}}},"500":{"description":"An unexpected error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeErrorProduct"}}}}}}},"/products/v1/shops/{shop_identifier}/platforms/custom/webhooks/categories/saved":{"parameters":[{"$ref":"#/components/parameters/shopIdentifier"}],"post":{"tags":["Product Event Notifications"],"summary":"Product Category Saved","operationId":"CategorySavedEventNotification","description":"Trigger this API call when a product category is saved on the platform.\\n\\nBold queues the product category for saving. The request contains the complete product category object at the time the change occurred. Bold replaces all fields of the existing product category object with the values provided in the request\\nbody. Fields omitted from the request body are ignored in the `category` object.\\n\\nThe `platform_updated_at` field must be accurate to mitigate the risk incurred by out-of-sequence requests.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/categorySavedRequestBody"}}},"required":true},"responses":{"202":{"description":"Notification queued successfully","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"A validation error occurred.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/validationError"},"examples":{"validationError":{"value":{"status_code":400,"errors":["Error at \'/data/category/platform_id\': property \'platform_id\' is missing."]}}}}}},"500":{"description":"An unexpected error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeErrorProduct"}}}}}}},"/products/v1/shops/{shop_identifier}/platforms/custom/webhooks/categories/deleted":{"parameters":[{"$ref":"#/components/parameters/shopIdentifier"}],"post":{"tags":["Product Event Notifications"],"summary":"Product Category Deleted","operationId":"CategoryDeletedEventNotification","description":"Trigger this API call when a product category is deleted on the platform.\\n\\nBold queues the product category for deletion. The `platform_deleted_at` field must be accurate to mitigate the risk incurred by out-of-sequence requests.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/categoryDeletedRequestBody"}}},"required":true},"responses":{"202":{"description":"Notification queued successfully","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"A validation error occurred.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/validationError"},"examples":{"validationError":{"value":{"status_code":400,"errors":["Error at \'/data/category/platform_id\': property \'platform_id\' is missing."]}}}}}},"500":{"description":"An unexpected error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeErrorProduct"}}}}}}}},"components":{"securitySchemes":{"OAuthToken":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://apps.boldapps.net/accounts/dashboard/authorize","tokenUrl":"https://api.boldcommerce.com/auth/oauth2/token","scopes":{}}},"description":"Authenticates an API request from a [public integration](/guides/checkout/resources/glossary#public-integration). Generate this token in the [Developer Dashboard](https://developer-dashboard.boldcommerce.com/default/dashboard). Refer to [Build Public Integrations](/guides/checkout/public-integrations) for more information."},"APIAccessToken":{"type":"apiKey","name":"API Access Token","in":"header","description":"Authenticates an API request from a [private integration](/default/guides/checkout/resources/glossary#private-integration).\\n\\nGenerate this token in the [Bold Account Center](https://account.boldcommerce.com/). Refer to the [Quickstart guide](/default/guides/checkout/quick-start) for more information."}},"parameters":{"shopIdentifier":{"name":"shop_identifier","in":"path","description":"A unique identifier of the store. This can be retrieved by calling the [Get Shop\\nInfo](shops#tag/Shops/operation/GetShopInfo#) endpoint.","required":true,"schema":{"type":"string","example":"zp3oafdor9"}}},"schemas":{"customerBase":{"type":"object","properties":{"email":{"description":"The email address for the customer.","type":"string","format":"email","example":"john.doe@example.com"},"first_name":{"description":"The first name of the customer.","type":"string","example":"John"},"last_name":{"description":"The last name of the customer.","type":"string","example":"Doe"},"phone":{"description":"A phone number for the customer.","type":"string","format":"phone","example":"555-555-5555"}}},"addressBaseCustomer":{"type":"object","properties":{"address_type":{"description":"The type of the address (i.e., residential, commercial).","type":"string","example":"commercial"},"address_use":{"description":"The usage of the address. Possible values are `\\"billing\\"` or `\\"shipping\\"`.","type":"string","enum":["billing","shipping"],"example":"shipping"},"company":{"description":"The name of the company operating at the specified address, if applicable.","type":"string","example":"Acme Corp."},"city":{"description":"The name of the city associated with the address.","type":"string","example":"Winnipeg"},"country":{"description":"The name of the country associated with the address.","type":"string","example":"Canada"},"country_code":{"description":"The country code (in [ISO 3166-1 alpha-2 format](https://www.iso.org/iso-3166-country-codes.html)) of the address.","type":"string","example":"CA"},"is_default":{"description":"Indicates whether this is the default address for the customer. There can only be one default address for a customer. If this modifies any other resources, ensure the appropriate event notifications are triggered for those affected by this change.","type":"boolean","format":"boolean","example":true},"first_name":{"description":"The first name of the customer with the address.","type":"string","example":"John"},"last_name":{"description":"The last name of the customer with the address.","type":"string","example":"Doe"},"phone":{"description":"The phone number of the addressee.","type":"string","format":"phone","example":"555-555-5555"},"postal_code":{"description":"The postal code or zip code for the address.","type":"string","example":"H0H 0H0"},"province":{"description":"The province or state for the address.","type":"string","example":"Manitoba"},"province_code":{"description":"The province or state abbreviation for the address.","type":"string","example":"MB"},"street_1":{"description":"The primary street information for the address.","type":"string","example":"123 North Road"},"street_2":{"description":"Additional street information for the address.","type":"string","example":"Unit 5"}}},"customerAddress":{"type":"object","allOf":[{"$ref":"#/components/schemas/addressBaseCustomer"}],"properties":{"platform_id":{"description":"A unique identifier for the address. Assigned by the platform.","type":"string","example":"Address_456"}},"required":["platform_id"]},"customer":{"type":"object","allOf":[{"$ref":"#/components/schemas/customerBase"}],"properties":{"addresses":{"description":"A list of customer addresses.","type":"array","items":{"$ref":"#/components/schemas/customerAddress"}},"platform_created_at":{"description":"The date (in [RFC3339 format](https://datatracker.ietf.org/doc/html/rfc3339)) that this customer was created on the platform. Assigned by the platform.","type":"string","format":"date-time","example":"2023-01-09T15:35:57"},"platform_updated_at":{"description":"The date (in [RFC3339 format](https://datatracker.ietf.org/doc/html/rfc3339)) that this customer was last modified on the platform. Assigned by the platform.","type":"string","format":"date-time","example":"2023-01-09T15:35:57"},"platform_id":{"description":"A unique identifier for the customer. Assigned by the platform.","type":"string","example":"Customer_123"}},"required":["platform_updated_at","platform_id"]},"customerSavedRequestData":{"type":"object","properties":{"customer":{"$ref":"#/components/schemas/customer"}},"required":["customer"]},"customerSavedRequestBody":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/customerSavedRequestData"}},"required":["data"]},"validationError":{"type":"object","properties":{"status_code":{"type":"number"},"errors":{"type":"array","items":{"type":"string"}}}},"runtimeErrorCustomer":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"The code used to identify the error."},"message":{"type":"string","description":"A long description of the error."},"type":{"type":"string","description":"A short description of the error."}}}}}},"deletedCustomer":{"type":"object","properties":{"platform_id":{"description":"A unique identifier for the customer. Assigned by the platform.","type":"string","example":"Customer_123"},"platform_deleted_at":{"description":"The date (in [RFC3339 format](https://datatracker.ietf.org/doc/html/rfc3339)) that this customer was deleted on the platform. Assigned by the platform.","type":"string","format":"date-time","example":"2023-04-09T12:33:44"}},"required":["platform_id","platform_deleted_at"]},"customerDeletedRequestData":{"type":"object","properties":{"customer":{"$ref":"#/components/schemas/deletedCustomer"}},"required":["customer"]},"customerDeletedRequestBody":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/customerDeletedRequestData"}},"required":["data"]},"customAttribute":{"type":"object","properties":{"description":{"description":"A description of the attribute.","type":"string","example":"field-1"},"value":{"description":"The value of the attribute.","type":"string","example":"value-1"}}},"tax":{"type":"object","properties":{"amount":{"description":"The total tax amount pending, measured in the order\'s given currency.","type":"string","format":"double","example":"5.00"},"name":{"description":"A human-readable name for this tax.","type":"string","example":"Provincial Sales Tax"},"rate":{"description":"The tax percentage (a value between 0 to 1).","type":"string","example":"0.07"},"tag":{"description":"The reference tag for the tax.","type":"string","example":"tag-1"}}},"orderDiscount":{"type":"object","properties":{"platform_id":{"type":"string","description":"A unique identifier for the discount. Defined by the platform.","example":"discount-123456"},"amount":{"description":"The discounted amount applied to the order, measured in the order\'s given currency.","type":"string","format":"double","example":"5.00"},"discount_code":{"type":"string","description":"The code used to apply the discount.","example":"20OFF"}}},"orderBase":{"type":"object","properties":{"order_number":{"description":"A human-readable identifier for the order.","type":"string","example":"ORDER_XXYY1122"},"platform_customer_id":{"description":"A unique identifier for the customer associated to this order. Assigned by the platform.","type":"string","example":"customer-123456"},"platform_friendly_id":{"description":"A unique identifier for the order on the platform. This field is used to identify the order on the platform and is used by the Bold Checkout Admin to link the order to the platform.","type":"string","example":"PT-0065"},"shipping_method":{"description":"The shipping method for the order.","type":"string","example":"freight"},"shipping_code":{"description":"The code for the shipping method for the order. Each store defines its own shipping codes.","type":"string","example":"S001"},"browser_ip":{"description":"The browser IP under which the customer placed the order.","type":"string","example":"127.0.0.1"},"source":{"description":"A label identifying the mechanism which placed the order.","type":"string","example":"POS"},"created_via":{"description":"A label identifying the app that created the order (if applicable).","type":"string","example":"Bold Checkout"},"locale":{"description":"The locale code of the order (either in [ISO-639 language code format](https://www.iso.org/iso-639-language-codes.html) or in [ISO/IEC-15897 regional language format](https://www.iso.org/standard/50707.html)).","type":"string","example":"en_US"},"test":{"description":"Indicates whether the order is a test order.","type":"boolean","example":false},"notes":{"description":"Any internal notes about the order.","type":"string","example":"Handle with care."},"public_notes":{"description":"Any customer-facing notes about the order.","type":"string","example":"Order contains fragile items."},"custom_attributes":{"description":"A series of key-value pairs of metadata relevant to the order.","type":"object","additionalProperties":{"$ref":"#/components/schemas/customAttribute"}},"shipping_subtotal":{"description":"The cost of shipping the order, in the order\'s given currency.","type":"string","format":"double","example":"5.00"},"shipping_tax":{"description":"The sum of shipping taxes for the ordered items, in the order\'s given currency.","type":"string","format":"double","example":"1.00"},"shipping_taxes":{"description":"A list of the individual shipping taxes for the line items on the order.","type":"array","items":{"$ref":"#/components/schemas/tax"}},"discount":{"description":"The total amount discounted from the order, in the order\'s given currency. If there is no discount, set this field to `\\"0\\"`.\\n\\n**Note:** If `discount` is included in the payload, the `total` and `total_tax` values are required.","type":"string","format":"double","example":"0"},"discounts":{"description":"The list of discounts applied to the order.","type":"object","additionalProperties":{"$ref":"#/components/schemas/orderDiscount"}},"subtotal":{"description":"The subtotal of the line items on the order, in the order\'s given currency.\\n\\n**Note:** Calculate the subtotal before taxes and discounts (if those values are not included in the line item prices).","type":"string","format":"double","example":"10.00"},"subtotal_tax":{"description":"The tax to be charged on all line items, in the order\'s given currency.","type":"string","format":"double","example":"5.00"},"total_tax":{"description":"The total tax on the full order, in the order\'s given currency, including: `subtotal_tax`, `shipping_tax`, and any other special taxes pending for the order.","type":"string","format":"double","example":"5.00"},"total":{"description":"The total of order cost, in the order\'s given currency.\\n\\n**Note**: This number includes taxes and is reduced by the discount.\\n","type":"string","format":"double","example":"20.00"},"refunded_amount":{"description":"The refunded amount of the order, if any, in the order\'s given currency.","type":"string","format":"double","example":"0"},"currency":{"description":"The base currency used for the order (in [ISO-4217 currency code format](https://www.iso.org/iso-4217-currency-codes.html)).","type":"string","example":"CAD"},"order_status":{"description":"The current status of the order. The status indicates whether the order is `active` or `cancelled`.","type":"string","enum":["active","cancelled"],"example":"active"},"fulfillment_status":{"description":"The fulfillment status of the order.","type":"string","enum":["pending","partial","delivered","fulfilled"],"example":"partial"},"financial_status":{"description":"The status of payments associated with the order. This field can only be set when the order is created and cannot be changed if the order is updated.","type":"string","enum":["held_for_review","disputed","cancelled","pending","preauthed","refunded","partially_paid","partially_refunded","paid"],"example":"pending"},"placed_at":{"description":"The date the order was placed on the platform, (in [RFC3339 format](https://datatracker.ietf.org/doc/html/rfc3339)). Assigned by the platform.","type":"string","format":"date-time","example":"2019-08-24T14:15:22Z"}}},"addressBaseOrder":{"type":"object","properties":{"address_type":{"description":"The type of the address (i.e., residential, commercial).","type":"string","example":"commercial"},"first_name":{"description":"The addressee\'s first name.","type":"string","example":"John"},"last_name":{"description":"The addressee\'s last name.","type":"string","example":"Doe"},"street_1":{"description":"The primary street information.","type":"string","example":"123 North Road"},"street_2":{"description":"The additional street information, if any.","type":"string","example":"Suite 200"},"city":{"description":"The city name.","type":"string","example":"Winnipeg"},"province":{"description":"The province or state name.","type":"string","example":"Manitoba"},"country":{"description":"The country name.","type":"string","example":"Canada"},"country_code":{"description":"The country code of the address (in [ISO 3166-1 alpha-2 format](https://www.iso.org/iso-3166-country-codes.html)).","type":"string","example":"CA"},"phone":{"description":"The phone number.","type":"string","format":"phone","example":"555-555-5555"},"postal_code":{"description":"The postal code or zip code.","type":"string","example":"H0H 0H0"},"email":{"description":"An email address.","type":"string","format":"email","example":"john.doe@example.com"},"province_code":{"description":"The province or state abbreviation (in [ISO 3166 format](https://www.iso.org/iso-3166-country-codes.html)).","type":"string","example":"MB"},"company":{"description":"The name of the company operating at the specified address, if applicable.","type":"string","example":"Acme Corp."}}},"address":{"type":"object","allOf":[{"$ref":"#/components/schemas/addressBaseOrder"}],"properties":{"platform_id":{"description":"A unique identifier for the address. Assigned by the platform.","type":"string","example":"address-123456"}},"required":["platform_id"]},"lineItemBase":{"type":"object","properties":{"platform_product_id":{"description":"A unique identifier for the product referenced in this line item. Assigned by the platform.","type":"string","example":"product-123456"},"platform_variant_id":{"description":"A unique identifier for the variant referenced in this line item. Assigned by the platform.","type":"string","example":"variant-123456"},"cart_line_item_platform_id":{"description":"A unique identifier for the cart line item. Assigned by the platform.","type":"string","example":"cart-line-item-123456"},"custom_attributes":{"description":"Any key-value pairs of metadata relevant to the line item.","type":"object","additionalProperties":{"$ref":"#/components/schemas/customAttribute"}},"title":{"description":"The title of the line item.","type":"string","example":"Shoes (long-laced classic)"},"sku":{"description":"The SKU of the line item.","type":"string","example":"TSH-FF0000-L"},"url":{"description":"A link to the line item in the store.","type":"string","example":"https://example.com/shoes"},"image":{"description":"A link to an image of the line item.","type":"string","example":"http://shop.images/shoes"},"quantity":{"description":"The quantity ordered for this line item.","type":"integer","format":"int64","example":1},"grams":{"description":"The weight (in grams) of the line item.","type":"number","format":"double","example":10},"weight":{"description":"The weight of the line item (measured in terms of `weight_unit`).","type":"number","format":"double","example":10},"weight_unit":{"description":"The unit weight is measured in for the line item.","type":"string","example":"grams"},"taxable":{"description":"Indicates whether the line item is taxable.","type":"boolean","example":true},"taxes":{"description":"A list of taxes for the line item.","type":"array","items":{"$ref":"#/components/schemas/tax"}},"requires_shipping":{"description":"Indicates whether the line item requires shipping.","type":"boolean","example":true},"price_per_item":{"description":"The price per unit of the line item, in the order\'s given currency.\\n\\n**Note:** This value is the line item price before taxes and discounts (if taxes are not included in price).","type":"string","format":"double","example":"10.00"},"discount_per_item":{"description":"The discount of the line item, in the order\'s given currency.","type":"string","format":"double","example":"0"},"total":{"description":"The total price of the line item, in the order\'s given currency.\\n\\n**Note:** This value includes taxes and discounts.","type":"string","format":"double","example":"15.00"},"subtotal":{"description":"The subtotal of the line item, measured in the order\'s currency.\\n\\n**Note:** This value is the line item price multiplied by quantity, excluding tax.","type":"string","format":"double","example":"10.00"},"total_tax":{"description":"The total tax of the line item, in the order\'s given currency.","type":"string","format":"double","example":"5.00"},"discounted_subtotal":{"description":"The discounted total price of the line item, in the order\'s given currency.\\n\\n**Note:** This value is the discounted line item price multiplied by\\nquantity, excluding tax.","type":"string","format":"double","example":"10.00"}}},"lineItem":{"type":"object","allOf":[{"$ref":"#/components/schemas/lineItemBase"}],"properties":{"platform_id":{"description":"A unique identifier for the line item. Assigned by the platform.","type":"string","example":"line-item-123456"}},"required":["platform_id"]},"paymentBase":{"type":"object","properties":{"status":{"description":"The status of the payment. Values are dependent on the payment provider used and should be passed through as-is.","type":"string","example":"paid"}}},"transactionBase":{"type":"object","properties":{"provider_transaction_id":{"description":"A unique identifier for the transaction. Assigned by the payment provider.","type":"string","example":"provider-transaction-123456"},"amount":{"description":"The amount captured in this transaction, in the transaction\'s given currency.\\n\\n**Note:** If the transaction is a refund, this amount is negative.","type":"string","format":"double","example":"15.00"},"currency":{"description":"The currency used for the transaction (in [ISO-4217 currency code format](https://www.iso.org/iso-4217-currency-codes.html)).","type":"string","example":"CAD"},"status":{"description":"The status of the transaction.","type":"string","enum":["initial","pending","failure","success"],"example":"success"},"type":{"description":"The type of transaction.","type":"string","enum":["authorization","charge","refund"],"example":"charge"}}},"transaction":{"type":"object","allOf":[{"$ref":"#/components/schemas/transactionBase"}],"properties":{"platform_id":{"description":"A unique identifier for the transaction. Assigned by the platform.","type":"string","example":"transaction-123456"}},"required":["platform_id","amount"]},"payment":{"type":"object","allOf":[{"$ref":"#/components/schemas/paymentBase"}],"properties":{"platform_id":{"description":"A unique identifier for the payment. Assigned by the platform.","type":"string","example":"payment-123456"},"transactions":{"description":"A list of transactions for the payment.","type":"array","items":{"$ref":"#/components/schemas/transaction"}},"description":{"description":"A human-readable description of the payment.","type":"string","example":"Credit card payment"},"provider":{"description":"A label indicating the organization handling the payment and transactions.","type":"string","example":"stripe"},"payment_method":{"description":"The payment method used.","type":"string","example":"credit card"},"currency":{"type":"string","description":"The currency used for the payment (in [ISO-4217 currency code format](https://www.iso.org/iso-4217-currency-codes.html)).","example":"CAD"},"amount_planned":{"description":"The amount that the payment provider plans to charge for the payment, in the payment\'s given currency. If the payment has been completed, this amount reflects the amount charged.","type":"string","format":"double","example":"15.00"},"custom_attributes":{"description":"Any key-value pairs of metadata relevant to the payment.","type":"object","additionalProperties":{"$ref":"#/components/schemas/customAttribute"}}},"required":["platform_id","amount_planned"]},"order":{"type":"object","allOf":[{"$ref":"#/components/schemas/orderBase"}],"properties":{"platform_id":{"description":"A unique identifier for the order. Assigned by the platform.","type":"string","example":"order-123456"},"platform_updated_at":{"description":"The date the order was last modified on the platform, (in [RFC3339 format](https://datatracker.ietf.org/doc/html/rfc3339)). Assigned by the platform.","type":"string","format":"date-time","example":"2019-08-24T14:15:22Z"},"shipping_addresses":{"description":"A list of shipping addresses for the order.","type":"array","items":{"$ref":"#/components/schemas/address"}},"billing_address":{"description":"The billing address for the order.","allOf":[{"$ref":"#/components/schemas/address"}]},"line_items":{"description":"A list of line items included in the order.","type":"array","items":{"$ref":"#/components/schemas/lineItem"}},"payments":{"description":"A list of payments for the order.","type":"array","items":{"$ref":"#/components/schemas/payment"}}},"required":["total","total_tax","subtotal","subtotal_tax","shipping_subtotal","shipping_tax","platform_id","platform_updated_at"]},"orderSavedRequestData":{"type":"object","properties":{"order":{"description":"The order object.","$ref":"#/components/schemas/order"}},"required":["order"]},"orderSavedRequestBody":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/orderSavedRequestData"}},"required":["data"]},"runtimeErrorOrder":{"type":"object","properties":{"errors":{"type":"array","items":{"required":["code"],"type":"object","properties":{"code":{"type":"string","description":"The code used to identify the error.","example":"09-1"},"message":{"type":"string","description":"A long description of the error.","example":"The order with the provided platform_id does not exist"},"type":{"type":"string","description":"A short description of the error.","example":"orders.does_not_exist"}}}}}},"deletedOrder":{"type":"object","properties":{"platform_id":{"description":"A unique identifier for the order. Assigned by the platform.","type":"string","example":"order-123456"},"platform_deleted_at":{"description":"The date the order was deleted on the platform, (in [RFC3339 format](https://datatracker.ietf.org/doc/html/rfc3339)). Assigned by the platform.","type":"string","format":"date-time","example":"2020-08-24T14:15:22Z"}},"required":["platform_id","platform_deleted_at"]},"orderDeletedRequestData":{"type":"object","properties":{"order":{"$ref":"#/components/schemas/deletedOrder"}},"required":["order"]},"orderDeletedRequestBody":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/orderDeletedRequestData"}},"required":["data"]},"productBase":{"type":"object","properties":{"description":{"type":"string","description":"The description for the product.","example":"A hat for the beach"},"handle":{"type":"string","description":"A unique, human-readable string for the product.","example":"beach-hat"},"inventory_quantity":{"type":"integer","description":"The current inventory amount of the product.","format":"int64","example":2},"inventory_tracking_entity":{"type":"string","description":"The entity on which inventory is tracked.","enum":["variant","product","none"],"example":"product"},"inventory_tracking_service":{"type":"string","description":"The service that tracks inventory.","example":"platform"},"localized_descriptions":{"type":"object","description":"A map of localized descriptions for the product. The key is the [ISO-639](https://www.iso.org/iso-639-language-codes.html) two character language code. The value is the product description in the given language.","additionalProperties":{"type":"string"},"example":{"en":"A hat for the beach","fr":"Un chapeau pour la plage"}},"localized_names":{"type":"object","description":"A map of localized names for the product. The key is the [ISO-639](https://www.iso.org/iso-639-language-codes.html) two character language code. The value is the product name in the given language.","additionalProperties":{"type":"string"},"example":{"en":"Beach Hat","fr":"Chapeau de Plage"}},"name":{"type":"string","description":"The product name.","example":"Beach hat"},"published":{"type":"boolean","description":"Indicates if the product is published on the storefront.","example":true},"tags":{"type":"string","description":"A string with comma separated values describing the product.","example":"clothing, unisex, headwear"},"tax_code":{"type":"string","description":"The tax code for the product.","example":"non-taxable"},"type":{"type":"string","description":"A representation of platform-specific product data. The role of this field depends on the platform:\\n\\n- BigCommerce: The product type, either `physical` or `digital`.\\n- commercetools: A merchant or partner-defined data set, valid as per options set in the platform.\\n- Shopify: A product categorization, used for filtering and searching products.\\n- Custom: Defined by the platform.","example":"physical"},"url":{"type":"string","description":"A URL to the product on the storefront.","example":"/hats/beach-hat"},"vendor":{"type":"string","description":"The product vendor.","example":"OFS"}}},"categoryBase":{"type":"object","properties":{"image_url":{"description":"The URL location of the category image.","type":"string","example":"your_platform_connector.com/files/categories/hats.jpg"},"name":{"description":"The name of the category.","type":"string","example":"Hats"}}},"category":{"type":"object","allOf":[{"$ref":"#/components/schemas/categoryBase"}],"properties":{"platform_id":{"type":"string","description":"A unique identifier for the category. Defined by the platform.","example":"category-123456"},"platform_updated_at":{"type":"string","format":"date-time","description":"The date and time the category was last updated on the platform, in [RFC 3339, section 5.6 format](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6). If never updated, defaults to the `platform_created_at` value.","example":"2019-08-24T14:15:22Z"}},"required":["platform_id","platform_updated_at"]},"variantBase":{"type":"object","description":"An array of `variant` objects. At least one variant is required. If the product has no variants, the variant can reuse the product information.","properties":{"allow_backorder":{"description":"If backorders of the variant is allowed.","type":"boolean","format":"boolean"},"compare_at_price":{"description":"The original price of the item before an adjustment or a sale.","type":"string","example":"30.00"},"cost":{"description":"The cost of the product variant.","type":"string","example":"30.00"},"grams":{"description":"The weight of the product variant in grams.","type":"integer","format":"int64"},"image_url":{"description":"URL of the image.","type":"string","example":"your_platform_connector.com/files/products/hats/purple-beach-hat.jpg"},"inventory_quantity":{"description":"Current inventory level of the product.","type":"integer","format":"int64"},"inventory_tracking_entity":{"type":"string","description":"Entity on which inventory is tracked.","enum":["variant","product","none"]},"inventory_tracking_service":{"type":"string","description":"Service that tracks inventory.","example":"platform"},"localized_names":{"type":"object","additionalProperties":{"type":"string"},"description":"Map of localized names for the variant. The field is the [ISO-639](https://www.iso.org/iso-639-language-codes.html) two character language code. The value is the product name in the given language.","example":{"en":"Purple","fr":"Violette"}},"name":{"description":"The name of the variant. If there is only one variant, the `name` must be \\"Default Title\\" in order to avoid displaying the same `name` twice.","type":"string","example":"Default Title"},"price":{"description":"The price of the variant","type":"string","example":"30.00"},"require_shipping":{"description":"True if the item needs to be shipped, false otherwise.","type":"boolean","format":"boolean"},"sku":{"description":"Variant SKU.","type":"string","example":"BEACH-HAT-PURPLE"},"tax_code":{"description":"Tax code for the variant.","type":"string","example":"non-taxable"},"tax_exempt":{"description":"Indicates whether the variant is tax-exempt. If `true`, the variant is tax-exempt.","type":"boolean","format":"boolean","nullable":true},"weight":{"type":"string","description":"The weight of the product variant, calculated with weight unit specified.","example":"1.0"},"weight_unit":{"type":"string","description":"The unit of measurement that applies to the product variant\'s weight.","example":"kg"}}},"variantOptionValue":{"type":"object","description":"A more granular level of customization for variants. These are not required, but can be used to provide more options for your same variant.","properties":{"platform_id":{"type":"string","description":"A unique identifier for the variant option value. Defined by the platform.","example":"abc123456"},"platform_product_option_id":{"type":"string","description":"The unique identifier for the product option this value belongs to. Defined by the platform.","example":"VAR-10001-SM"},"label":{"type":"string","description":"The label of the option value.","example":"small"},"name":{"type":"string","description":"The name of the option.","example":"Small"}}},"deepVariant":{"type":"object","allOf":[{"$ref":"#/components/schemas/variantBase"}],"properties":{"platform_id":{"type":"string","description":"A unique identifier for the variant. Defined by the platform.","example":"variant-123456"},"option_values":{"type":"array","items":{"$ref":"#/components/schemas/variantOptionValue"}}},"required":["platform_id","allow_backorder","price","weight"]},"optionBase":{"type":"object","properties":{"name":{"description":"The option name.","type":"string","example":"Small"},"position":{"description":"The position in the `options` array.","type":"integer","format":"int64","example":1}}},"optionValueBase":{"type":"object","properties":{"is_default":{"type":"boolean","description":"Indicates whether this is the default option.","format":"boolean"},"label":{"description":"The label of the option value.","type":"string","example":"Small"},"position":{"description":"The position in the `option_values` array.","type":"integer","format":"int64","example":1}}},"deepOptionValue":{"type":"object","allOf":[{"$ref":"#/components/schemas/optionValueBase"}],"properties":{"platform_id":{"type":"string","description":"A unique identifier for the option value. Defined by the platform.","example":"option-value-123456"}}},"deepOption":{"type":"object","allOf":[{"$ref":"#/components/schemas/optionBase"}],"properties":{"platform_id":{"type":"string","description":"A unique identifier for the product option. Defined by the platform.","example":"product-option-123456"},"option_values":{"type":"array","items":{"$ref":"#/components/schemas/deepOptionValue"}}}},"imageBase":{"type":"object","properties":{"name":{"description":"The image name.","type":"string","example":"Beach hat"},"src":{"description":"The image URL.","type":"string","example":"https://example.com/images/beach-hat.jpg"},"position":{"description":"The position in the `images` array.","type":"integer","format":"int64","example":1}}},"deepImage":{"type":"object","allOf":[{"$ref":"#/components/schemas/imageBase"}],"properties":{"platform_id":{"type":"string","description":"A unique identifier for the image. Defined by the platform.","example":"image-123456"}}},"product":{"type":"object","allOf":[{"$ref":"#/components/schemas/productBase"}],"properties":{"platform_id":{"type":"string","description":"A unique identifier for the product. Defined by the platform.","example":"product-123456"},"platform_updated_at":{"description":"The date the product was last updated on the platform.","type":"string","format":"date-time","example":"2019-08-24T14:15:22Z"},"categories":{"type":"array","items":{"$ref":"#/components/schemas/category"}},"variants":{"type":"array","description":"An array of `variant` objects. At least one variant is required. If the product has no variants, the variant can reuse the product information.","items":{"$ref":"#/components/schemas/deepVariant"}},"options":{"type":"array","description":"An array of product options.","items":{"$ref":"#/components/schemas/deepOption"}},"images":{"type":"array","description":"An array of images depicting the product.","items":{"$ref":"#/components/schemas/deepImage"}}},"required":["platform_id","platform_updated_at","variants"]},"productSavedRequestData":{"type":"object","properties":{"product":{"description":"The product object.","$ref":"#/components/schemas/product"}},"required":["product"]},"productSavedRequestBody":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/productSavedRequestData"}},"required":["data"]},"runtimeErrorProduct":{"type":"object","properties":{"errors":{"type":"array","items":{"required":["code"],"type":"object","properties":{"code":{"type":"string","description":"The error code.","example":"07-1"},"message":{"type":"string","description":"The error message.","example":"Request failed due to an internal server error."},"type":{"type":"string","description":"The type of error.","example":"server.internal_error"}}}}}},"deletedProduct":{"type":"object","properties":{"platform_id":{"description":"The platform ID of the product to be deleted.","type":"string","example":"product-123456"},"platform_deleted_at":{"description":"The date the order was deleted on the platform, (in [RFC3339 format](https://datatracker.ietf.org/doc/html/rfc3339)). Assigned by the platform.","type":"string","format":"date-time","example":"2020-08-24T14:15:22Z"}},"required":["platform_id","platform_deleted_at"]},"productDeletedRequestData":{"type":"object","properties":{"product":{"$ref":"#/components/schemas/deletedProduct"}},"required":["product"]},"productDeletedRequestBody":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/productDeletedRequestData"}},"required":["data"]},"categorySavedRequestData":{"type":"object","properties":{"category":{"$ref":"#/components/schemas/category"}},"required":["category"]},"categorySavedRequestBody":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/categorySavedRequestData"}},"required":["data"]},"deletedCategory":{"type":"object","properties":{"platform_id":{"description":"The platform ID of the category to be deleted.","type":"string","example":"category-123456"},"platform_deleted_at":{"type":"string","format":"date-time","description":"The date and time this category was deleted on the platform, in [RFC 3339, section 5.6 format](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6).","example":"2019-09-24T14:15:22Z"}},"required":["platform_id","platform_deleted_at"]},"categoryDeletedRequestData":{"type":"object","properties":{"category":{"$ref":"#/components/schemas/deletedCategory"}},"required":["category"]},"categoryDeletedRequestBody":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/categoryDeletedRequestData"}},"required":["data"]}},"examples":{"internalError":{"value":{"code":500,"message":"Request failed due to an internal server error.","type":"server.internal_error"}}}}}},"plugin-redoc-5":{"url":"/api/platform-connector-destinations.openapi.yaml","themeId":"theme-redoc","isSpecFile":true,"spec":{"openapi":"3.0.0","info":{"title":"Platform Connector: Integration Configurations","description":"This API allows authors of platform connectors to configure the integration between their platform connector and Bold services.\\n\\nRefer to the <a href=\\"https://developer.boldcommerce.com/changelog/tags/platform-connector\\">changelog</a> for the latest updates to this API.\\n\\n> **Note:** This specification is only for use with a [Bold Platform Connector](/guides/platform-connector).\\n","version":"1.0.0","termsOfService":"https://boldcommerce.com/terms-of-service","contact":{"name":"Contact Us","url":"https://developer-dashboard.boldcommerce.com/default/contactus"}},"servers":[{"url":"https://api.boldcommerce.com"}],"security":[{"OAuthToken":[]},{"APIAccessToken":[]}],"tags":[{"name":"Platform Connector Destinations","description":"Contains information about where Bold should direct platform connector requests. Use these endpoints to integrate a platform connector with Bold by providing your server\'s destinations."},{"name":"Platform Connector Sync","description":"Use these endpoints to sync your platform\'s customer, order, and product data with Bold."}],"externalDocs":{"description":"For more information about platform connectors, refer to the Overview.","url":"https://developer.boldcommerce.com/guides/platform-connector"},"paths":{"/integrations/v1/shops/{shop_identifier}/platform_connector_destinations":{"parameters":[{"$ref":"#/components/parameters/shopIdentifier"}],"post":{"tags":["Platform Connector Destinations"],"summary":"Create Destination","operationId":"CreateDestination","description":"Informs Bold of your platform connector destination for the specified `shop_identifier`. This destination is the location of your platform connector server.\\n\\nAny time the specified `topic` resource changes, Bold makes a call to your platform connector\'s `destination` URL at the relevant path. For more information about implementing these paths, refer to [Implement Platform Connector APIs](/guides/platform-connector/create-server).\\n\\nEach topic may only have one destination on the platform connector, and each destination corresponds to only one topic. You must make separate calls to register each destination.\\n\\nAny request to this endpoint triggers a synchronous request to the [Verify Platform Connector Destination](platform-connector#operation/VerifyPlatformConnectorDestination) endpoint on your platform connector. If the verification endpoint does not succeed, the Create Destination call also fails.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/createDestinationRequestBody"}}},"required":true},"responses":{"200":{"description":"Platform Connector Destination was created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/createDestinationResponseBody"}}}},"400":{"description":"Specified destination failed verification, or destination is unreachable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"},"examples":{"destinationValidationError":{"$ref":"#/components/examples/destinationValidationError"},"destinationTimeExceeded":{"$ref":"#/components/examples/destinationTimeExceeded"}}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"},"examples":{"internalError":{"$ref":"#/components/examples/internalError"},"destinationInternalError":{"$ref":"#/components/examples/destinationInternalError"}}}}}}},"get":{"tags":["Platform Connector Destinations"],"summary":"List Destinations","operationId":"ListDestinations","description":"Lists all connections between Bold and your platform connector for the specified `shop_identifier`.\\n\\nAny time the referenced `topic` resources are changed, Bold calls your platform connector on the specified `destination` base URL at the relevant path, as per the [Platform Connector Specifications](platform-connector).","responses":{"200":{"description":"Response containing a list of Platform Connector `destination` objects.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/listDestinationsResponseBody"},"examples":{"DestinationUpdated":{"$ref":"#/components/examples/DestinationUpdated"}}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"},"examples":{"internalError":{"$ref":"#/components/examples/internalError"}}}}}}}},"/integrations/v1/shops/{shop_identifier}/platform_connector_destinations/{id}":{"parameters":[{"$ref":"#/components/parameters/shopIdentifier"},{"$ref":"#/components/parameters/destinationId"}],"get":{"tags":["Platform Connector Destinations"],"summary":"Get Destination by ID","operationId":"GetDestinationByID","description":"Retrieves a specific connection between Bold and your platform connector for the specified `shop_identifier` by its unique `id`.\\n\\nAny time the referenced `topic` resources are changed, Bold calls your platform connector on the specified `destination` base URL at the relevant path, as per the [Platform Connector Specifications](platform-connector).","responses":{"200":{"description":"Response containing a successfully found Platform Connector `destination` object","content":{"application/json":{"schema":{"$ref":"#/components/schemas/retrieveDestinationResponseBody"}}}},"404":{"description":"The destination specified by `id` was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"},"examples":{"destinationNotFound":{"$ref":"#/components/examples/destinationNotFound"}}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"},"examples":{"internalError":{"$ref":"#/components/examples/internalError"}}}}}}},"put":{"tags":["Platform Connector Destinations"],"summary":"Update Destination","operationId":"UpdateDestination","description":"Updates the base URL `destination` of your platform connector for the specified `shop_identifier`.\\n\\nAll fields of a `destination` object are replaced with the values provided in the request body. Fields omitted from the request body are ignored and not updated in the `destination` object.\\n\\nAny time the specified `topic` resource changes, Bold makes a call to your platform connector\'s `destination` URL at the relevant path. For more information about implementing these paths, refer to [Implement Platform Connector APIs](/guides/platform-connector/create-server).\\n\\nEach topic may only have one destination on the platform connector, and each destination corresponds to only one topic. You must make separate calls to update each destination.\\n\\nAny request to this endpoint triggers a synchronous request to the [Verify Platform Connector Destination](platform-connector#operation/VerifyPlatformConnectorDestination) endpoint on your platform connector. If the verification endpoint does not succeed, the Update Destination call also fails.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/updateDestinationRequestBody"}}},"required":true},"responses":{"200":{"description":"Platform Connector Destination was updated successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/updateDestinationResponseBody"},"examples":{"UpdatedDestination":{"$ref":"#/components/examples/DestinationUpdated"}}}}},"400":{"description":"Specified destination failed verification, or destination is unreachable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"},"examples":{"destinationValidationError":{"$ref":"#/components/examples/destinationValidationError"},"destinationTimeExceeded":{"$ref":"#/components/examples/destinationTimeExceeded"}}}}},"404":{"description":"The destination specified by `id` was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"},"examples":{"destinationNotFound":{"$ref":"#/components/examples/destinationNotFound"}}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"},"examples":{"internalError":{"$ref":"#/components/examples/internalError"},"destinationInternalError":{"$ref":"#/components/examples/destinationInternalError"}}}}}}},"delete":{"tags":["Platform Connector Destinations"],"summary":"Delete Destination","operationId":"DeleteDestination","description":"Deletes a specific connection between Bold and your platform connector for the specified `shop_identifier` by the unique `id` of the destination.\\n\\nAfter this call, `topic` changes which would normally trigger calls from Bold to a platform connector no longer do so for the deleted `topic`.","responses":{"204":{"description":"Returned upon successful deletion of the destination.","content":{"application/json":{"schema":{"type":"object"}}}},"404":{"description":"The destination specified by `platform_id` was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"},"examples":{"customerNotFound":{"$ref":"#/components/examples/destinationNotFound"}}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"},"examples":{"internalError":{"$ref":"#/components/examples/internalError"}}}}}}}},"/orders/v2/shops/{shop_identifier}/sync":{"post":{"tags":["Platform Connector Sync"],"summary":"Trigger Order Sync","operationId":"SyncOrders","description":"Syncs the orders on a platform with Bold.","parameters":[{"$ref":"#/components/parameters/syncShopIdentifier"}],"responses":{"200":{"description":"Operation successful","content":{"application/json":{"schema":{"type":"object"}}}},"409":{"description":"A sync is currently in progress.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"},"example":{"status_code":409,"errors":["API Error encountered: \'cannot initiate sync, syncing already in progress\'"]}}}},"501":{"description":"An internal service has not been implemented.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"},"examples":{"destinationNotConfiguredError":{"value":{"status_code":501,"errors":["API Error encountered: \'platform connector destination not configured for topic\'"]}},"platformNotSupportedError":{"value":{"status_code":501,"errors":["API Error encountered: \'unsupported platform\'"]}}}}}}}}},"/customers/v2/shops/{shop_identifier}/sync":{"post":{"tags":["Platform Connector Sync"],"summary":"Trigger Customer Sync","operationId":"SyncCustomers","description":"Syncs the customers on a platform with Bold.","parameters":[{"$ref":"#/components/parameters/syncShopIdentifier"}],"responses":{"200":{"description":"Operation successful","content":{"application/json":{"schema":{"type":"object"}}}},"409":{"description":"A sync is currently in progress.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"},"example":{"status_code":409,"errors":["API Error encountered: \'cannot initiate sync, syncing already in progress\'"]}}}},"501":{"description":"An internal service has not been implemented.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"},"examples":{"destinationNotConfiguredError":{"value":{"status_code":501,"errors":["API Error encountered: \'platform connector destination not configured for topic\'"]}},"platformNotSupportedError":{"value":{"status_code":501,"errors":["API Error encountered: \'unsupported platform\'"]}}}}}}}}},"/products/v2/shops/{shop_identifier}/sync":{"post":{"tags":["Platform Connector Sync"],"summary":"Trigger Product Sync","operationId":"SyncProducts","description":"Syncs the products on a platform with Bold.","parameters":[{"$ref":"#/components/parameters/syncShopIdentifier"}],"responses":{"200":{"description":"Operation successful","content":{"application/json":{"schema":{"type":"object"}}}},"409":{"description":"A sync is currently in progress.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"},"example":{"status_code":409,"errors":["API Error encountered: \'cannot initiate sync, syncing already in progress\'"]}}}},"501":{"description":"An internal service has not been implemented.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"},"examples":{"destinationNotConfiguredError":{"value":{"status_code":501,"errors":["API Error encountered: \'platform connector destination not configured for topic\'"]}},"platformNotSupportedError":{"value":{"status_code":501,"errors":["API Error encountered: \'unsupported platform\'"]}}}}}}}}}},"components":{"securitySchemes":{"OAuthToken":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://apps.boldapps.net/accounts/dashboard/authorize","tokenUrl":"https://api.boldcommerce.com/auth/oauth2/token","scopes":{}}},"description":"Authenticates an API request from a [public integration](/guides/checkout/resources/glossary#public-integration). Generate this token in the [Developer Dashboard](https://developer-dashboard.boldcommerce.com/default/dashboard). Refer to [Build Public Integrations](/guides/checkout/public-integrations) for more information."},"APIAccessToken":{"type":"apiKey","name":"API Access Token","in":"header","description":"Authenticates an API request from a [private integration](/guides/checkout/resources/glossary#private-integration). Generate this token in the [Bold Account Center](https://account.boldcommerce.com/). Refer to [Making API Calls](/guides/checkout/quick-start) for more information."}},"schemas":{"createDestinationRequestBody":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/createDestinationRequestData"}}},"createDestinationRequestData":{"type":"object","properties":{"destination":{"$ref":"#/components/schemas/destinationNew"}}},"destinationNew":{"type":"object","allOf":[{"$ref":"#/components/schemas/destinationBase"},{"required":["shop_identifier","topic","destination","version","timeout_ms"]}]},"createDestinationResponseBody":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/createDestinationResponseData"}}},"createDestinationResponseData":{"type":"object","properties":{"destination":{"$ref":"#/components/schemas/destination"}}},"updateDestinationRequestBody":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/updateDestinationRequestData"}}},"updateDestinationRequestData":{"type":"object","properties":{"destination":{"$ref":"#/components/schemas/destinationUpdate"}}},"destinationUpdate":{"type":"object","allOf":[{"$ref":"#/components/schemas/destinationBase"}],"properties":{"id":{"description":"The unique identifier for this destination.","type":"integer","example":100}}},"updateDestinationResponseBody":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/updateDestinationResponseData"}}},"updateDestinationResponseData":{"type":"object","properties":{"destination":{"$ref":"#/components/schemas/destination"}}},"listDestinationsResponseBody":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/listDestinationsResponseData"}}},"listDestinationsResponseData":{"type":"object","properties":{"destinations":{"type":"array","items":{"$ref":"#/components/schemas/destination"}}}},"retrieveDestinationResponseBody":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/retrieveDestinationResponseData"}}},"retrieveDestinationResponseData":{"type":"object","properties":{"destination":{"$ref":"#/components/schemas/destination"}}},"destination":{"type":"object","allOf":[{"$ref":"#/components/schemas/destinationBase"}],"properties":{"id":{"description":"The unique identifier for this destination.","type":"integer","example":100},"created_at":{"description":"The date (in [RFC3339 format](https://datatracker.ietf.org/doc/html/rfc3339)) that this destination was created.","type":"string","format":"date-time","example":"2019-08-24T14:15:22Z"},"updated_at":{"description":"The date (in [RFC3339 format](https://datatracker.ietf.org/doc/html/rfc3339)) that this destination was updated. This value is `null` if the destination was not updated.","type":"string","format":"date-time","nullable":true,"example":"2019-08-24T14:15:22Z"},"deleted_at":{"description":"The date (in [RFC3339 format](https://datatracker.ietf.org/doc/html/rfc3339)) that this destination was deleted. This value is `null` if the destination was not deleted.","type":"string","format":"date-time","nullable":true,"example":null}}},"destinationBase":{"type":"object","properties":{"shop_identifier":{"description":"A unique identifier of the store. Retrieve this information by calling the [Get Shop Info](shops#tag/Shop/operation/GetShopInfo) endpoint.","type":"string","example":"zp3oafdor9"},"topic":{"description":"The resource/entity in Bold\'s domain model that caused a call to a platform connector.\\n\\nThis value must be unique among all of the `destination` objects for a given `shop_identifier`.","type":"string","enum":["customers","orders","products"]},"destination":{"description":"The base URL that Bold will call when the related `topic` is created, updated, or deleted.\\n\\nEach topic may only have a single destination on the platform connector, and each destination corresponds to only one topic. You must make separate calls to register each destination.","type":"string","format":"URL","example":"https://www.my_platform_connector.com"},"version":{"description":"The semantic version to be substituted into the path of the call made to a platform connector, as per the [Platform Connector Specifications](platform-connector).","type":"string","example":"v1"},"timeout_ms":{"description":"The time (in milliseconds) that Bold will wait before terminating outbound calls to a platform connector. The recommended value is 10000 milliseconds. This value cannot exceed 20000 milliseconds.","type":"number","example":10000,"maximum":20000}}},"runtimeError":{"type":"object","properties":{"status_code":{"type":"integer","format":"int32"},"errors":{"type":"array","items":{"type":"string"}}}},"error":{"type":"object","properties":{"status_code":{"type":"number"},"errors":{"type":"array","items":{"type":"string"}}}}},"parameters":{"shopIdentifier":{"name":"shop_identifier","in":"path","description":"A unique identifier of the store. Retrieve this information by calling the [Get Shop Info](shops#tag/Shop/operation/GetShopInfo) endpoint.","required":true,"schema":{"type":"string"},"example":"zp3oafdor9"},"destinationId":{"name":"id","in":"path","description":"A unique identifier of the destination.","required":true,"schema":{"type":"string"},"example":"100"},"syncShopIdentifier":{"name":"shop_identifier","in":"path","required":true,"schema":{"type":"string","example":"zp3oafdor9"},"description":"The identifier of the shop you would like to sync. Retrieve the `shop_identifier` by calling the [Get Shop Info](shops#tag/Shops/operation/GetShopInfo) endpoint."}},"examples":{"destinationNotFound":{"value":{"status_code":404,"errors":["Destination not found."]}},"destinationTimeExceeded":{"value":{"status_code":400,"errors":["Specified connector destination has timeout_ms exceeding 20 seconds"]}},"destinationValidationError":{"value":{"status_code":400,"errors":["Specified destination failed verification, or destination is unreachable"]}},"destinationInternalError":{"value":{"status_code":500,"errors":["Failed to create Custom Platform Destinations"]}},"internalError":{"value":{"status_code":500,"errors":["Request failed due to an internal server error"]}},"DestinationUpdated":{"value":{"data":{"destination":{"id":100,"created_at":"2019-08-24T14:15:22Z","updated_at":"2019-08-25T13:49:39Z","deleted_at":null,"shop_identifier":"zp3oafdor9","topic":"customers","destination":"https://www.my_platform_connector.com","version":"v1","timeout_ms":10000}}}}}}}},"plugin-redoc-6":{"url":"/api/price-rules.openapi.yaml","themeId":"theme-redoc","isSpecFile":true,"spec":{"openapi":"3.0.0","info":{"title":"Price Rules","version":"2.0","description":"The Price Rules API enables you to manage price rulesets.\\n\\nRefer to the <a href=\\"https://developer.boldcommerce.com/changelog\\">changelog</a> for the latest updates to this API.","termsOfService":"https://boldcommerce.com/terms-of-service","contact":{"name":"Contact Us","url":"https://developer-dashboard.boldcommerce.com/default/contactus"}},"servers":[{"url":"https://api.boldcommerce.com"}],"security":[{"OAuthToken":[]},{"APIAccessToken":[]}],"tags":[{"name":"Rulesets","description":"Contains information about a [ruleset](/guides/price-rules/concepts/rulesets-and-rules#rulesets), including a rules list, actions, conditions, product selection, and start and end dates. Use these endpoints to manage rulesets on a store."},{"name":"Rules","description":"A child of the Ruleset resource. Contains information about a [rule](/guides/price-rules/concepts/rulesets-and-rules#rules), including the type, conditions, and actions of the rule. Use these endpoints to manage the rules in a ruleset."},{"name":"Order Conditions","description":"Child of the Ruleset resource. Contains information about the criteria for triggering actions in a ruleset. [Conditions](/guides/price-rules/references/conditions) are usually a `type:value` pair. Use these endpoints to manage the conditions in a ruleset."},{"name":"Discount Codes","description":"Contains information about a discount on your store and the products that are eligible for it. Use these endpoints to manipulate the discount codes available on your store."},{"name":"Storefronts","description":"Use these endpoints to get the final price for a product or cart after all rules have been applied."},{"name":"Simple Communication Test"}],"externalDocs":{"description":"For more information about Price Rules, refer to the Overview.","url":"https://developer.boldcommerce.com/guides/price-rules"},"paths":{"/price_rules/rules/v2/shops/{shop_identifier}/rulesets":{"get":{"summary":"List Rulesets","operationId":"ListRulesets","tags":["Rulesets"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"data":{"type":"object","required":["rulesets"],"properties":{"rulesets":{"type":"array","description":"Each set of rules that is related to the shop.","items":{"$ref":"#/components/schemas/Ruleset"}}}},"pagination":{"$ref":"#/components/schemas/Pagination"}},"required":["message","data"]}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"401-error-example":{"value":{"message":"This request failed to be authenticated.","code":"00-1","type":"authentication.failed"}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"403-error-example":{"value":{"message":"This request does not contain the necessary permissions to access the target endpoint.","code":"00-2","type":"authorization.invalid_scopes"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"500-error-example":{"value":{"message":"Error with fetching a ruleset","code":"04-0","type":"unexpected"}}}}}}},"description":"List all rulesets available for the specified shop. This requires read_price_rulesets scope/permission. For more information about querying for certain rulesets, refer to the [Query and Pagination](/guides/price-rules/resources/query-pagination) guide.","parameters":[{"schema":{"type":"string"},"in":"query","name":"external_ids","description":"A list of ruleset external IDs that can be used as a filter in the search."},{"schema":{"type":"string"},"in":"query","name":"fields","description":"List of the ruleset fields to be returned; if this parameter is empty, all the available fields will be included in the response."},{"schema":{"type":"string"},"in":"query","name":"page","description":"Page number, considering that the results could span for several pages. Default is 1."},{"schema":{"type":"string"},"in":"query","name":"limit","description":"Page size, considering that the results could span for several pages. Default is 50."},{"schema":{"type":"boolean"},"in":"query","name":"include_all_apps","description":"The standard behaviour for this endpoint is to return just the rulesets that were created using the same auth token. To see all rulesets instead, this parameter should be set to true."}]},"parameters":[{"schema":{"type":"string"},"name":"shop_identifier","in":"path","required":true,"description":"Bold platform identifier for the shop. Find this identifier using the [Get Shop Info](shops#operation/GetShopInfo) endpoint."}],"post":{"summary":"Create Ruleset","operationId":"CreateRuleset","responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"data":{"type":"object","required":["ruleset"],"properties":{"ruleset":{"type":"object","items":{"$ref":"#/components/schemas/BasicRuleset"}}}}},"required":["message","data"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"400-error-example":{"value":{"message":"Required field missing or empty: product_selection","code":"04-6","type":"price_rules.required_field_missing"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"401-error-example":{"value":{"message":"This request failed to be authenticated.","code":"00-1","type":"authentication.failed"}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"403-error-example":{"value":{"message":"This request does not contain the necessary permissions to access the target endpoint.","code":"00-2","type":"authorization.invalid_scopes"}}}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Unprocessable Entity (WebDAV)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"422-error-example":{"value":{"message":"Invalid ruleset in payload","code":"04-3","type":"price_rules.invalid_payload"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"description":"Create a new ruleset for the specified shop. This requires write_price_rulesets scope/permission.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"ruleset":{"$ref":"#/components/schemas/BasicRuleset"}}},"examples":{"create-ruleset-example":{"value":{"ruleset":{"external_id":"CreatedByAPI_1","internal_name":"This ruleset was created by the API","product_selection":{"type":"SHOPIFY_PRODUCT_SEARCH","product_ids":["1234567890123","1234567890987"]},"rules":[{"type":"DISCOUNT","conditions":[{"type":"CUSTOMER_GROUP","value":"gold"},{"type":"QTY_BY_PRODUCT","operator":">=","value":3}],"actions":[{"type":"PRICE_ADJUST_PERCENT","value":-10},{"type":"CHARM_PRICE","value":99}]}]}}}}}}},"tags":["Rulesets"]}},"/price_rules/rules/v2/shops/{shop_identifier}/rulesets/search":{"get":{"summary":"List Rulesets for Shop","operationId":"ListRulesetsForShop","tags":["Rulesets"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"data":{"type":"object","required":["rulesets"],"properties":{"rulesets":{"type":"array","description":"Each set of rules that is related to the shop.","items":{"$ref":"#/components/schemas/Ruleset"}}}},"pagination":{"$ref":"#/components/schemas/Pagination"}},"required":["message","data"]}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"401-error-example":{"value":{"message":"This request failed to be authenticated.","code":"00-1","type":"authentication.failed"}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"403-error-example":{"value":{"message":"This request does not contain the necessary permissions to access the target endpoint.","code":"00-2","type":"authorization.invalid_scopes"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"500-error-example":{"value":{"message":"Error with fetching a ruleset","code":"04-0","type":"unexpected"}}}}}}},"description":"List all rulesets available for the specified shop. This requires read_price_rulesets scope/permission.","externalDocs":{"description":"For more information on search filter options, please check our guides.","url":"https://developer.boldcommerce.com/guides/price-rules/resources/query-pagination"},"parameters":[{"schema":{"type":"string"},"in":"query","name":"external_ids","description":"A list of ruleset external IDs that can be used as a query filter."},{"schema":{"type":"string"},"in":"query","name":"product_ids","description":"A list of product IDs that can be used as a query filter."},{"schema":{"type":"string"},"in":"query","name":"variant_ids","description":"A list of product IDs or Variant IDs can be used combined as a query filter."},{"schema":{"type":"string"},"in":"query","name":"skus","description":"A list of product SKUs can be used as a query filter."},{"schema":{"type":"string"},"in":"query","name":"fields","description":"List of the ruleset fields to be returned; if this parameter is empty, all the available fields will be included in the response."},{"schema":{"type":"string"},"in":"query","name":"page","description":"Page number, considering that the results could span for several pages. Default is 1."},{"schema":{"type":"string"},"in":"query","name":"limit","description":"Page size, considering that the results could span for several pages. Default is 50."},{"schema":{"type":"boolean"},"in":"query","name":"include_all_apps","description":"The standard behaviour for this endpoint is to return just the rulesets that were created using the same auth token. To see all rulesets instead, this parameter should be set to true."},{"schema":{"type":"string"},"in":"query","name":"filter_expression","description":"This endpoint supports extra query columns to filter the rulesets. To use this parameter you should use like this: filter_expression:operation(column:value)."}]},"parameters":[{"schema":{"type":"string"},"name":"shop_identifier","in":"path","required":true,"description":"Bold platform identifier for the shop. Find this identifier using the [Get Shop Info](shops#operation/GetShopInfo) endpoint."}]},"/price_rules/rules/v2/shops/{shop_identifier}/rulesets/{ruleset_id}":{"get":{"summary":"Get Ruleset by ID","operationId":"GetRulesetByID","tags":["Rulesets"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"data":{"type":"object","required":["ruleset"],"properties":{"ruleset":{"$ref":"#/components/schemas/Ruleset"}}}},"required":["message","data"]}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"401-error-example":{"value":{"message":"This request failed to be authenticated.","code":"00-1","type":"authentication.failed"}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"403-error-example":{"value":{"message":"This request does not contain the necessary permissions to access the target endpoint.","code":"00-2","type":"authorization.invalid_scopes"}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"404-error-example":{"value":{"message":"No rulesets found for provided parameters.","code":"04-9","type":"price_rules.ruleset_not_found"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"description":"Return data for a specific ruleset, selected by the ruleset database ID. This requires read_price_rulesets scope/permission."},"parameters":[{"schema":{"type":"string"},"name":"shop_identifier","in":"path","required":true,"description":"Bold platform identifier for the shop. Find this identifier using the [Get Shop Info](shops#operation/GetShopInfo) endpoint."},{"schema":{"type":"string"},"name":"ruleset_id","in":"path","required":true,"description":"Ruleset database ID."}],"put":{"summary":"Update Ruleset by ID","operationId":"UpdateRulesetByID","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"data":{"type":"object","properties":{"ruleset":{"$ref":"#/components/schemas/Ruleset"}}}}},"examples":{"200-response-example":{"value":{"message":"Successfully updated ruleset","data":{"ruleset":{"id":84,"external_id":"CreatedByAPI_1","active":true,"internal_name":"This ruleset was created by the API and now it is being changed","public_name":"","start_date":null,"expiry_date":null,"sync_percent":0,"priority":0,"created_at":"2020-05-08T14:42:56Z","updated_at":"2020-05-08T14:43:14Z","rules":[{"type":"DISCOUNT","conditions":[{"type":"CUSTOMER_GROUP","value":"silver"},{"type":"QTY_BY_PRODUCT","operator":">=","value":3}],"actions":[{"type":"PRICE_ADJUST_PERCENT","value":-8},{"type":"CHARM_PRICE","value":99}]}],"product_selection":{"product_ids":["1234567890123","1234567890987"],"type":"SHOPIFY_PRODUCT_SEARCH"}}}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"401-error-example":{"value":{"message":"This request failed to be authenticated.","code":"00-1","type":"authentication.failed"}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"403-error-example":{"value":{"message":"This request does not contain the necessary permissions to access the target endpoint.","code":"00-2","type":"authorization.invalid_scopes"}}}}}}},"description":"Change attributes for an existent ruleset, selected by the ruleset database ID. This requires write_price_rulesets scope/permission.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"ruleset":{"$ref":"#/components/schemas/BasicRuleset"}}},"examples":{"update-ruleset-example":{"value":{"ruleset":{"external_id":"CreatedByAPI_1","internal_name":"This ruleset was created by the API and now it is being changed","product_selection":{"type":"SHOPIFY_PRODUCT_SEARCH","product_ids":["1234567890123","1234567890987"]},"rules":[{"type":"DISCOUNT","conditions":[{"type":"CUSTOMER_GROUP","value":"silver"},{"type":"QTY_BY_PRODUCT","operator":">=","value":3}],"actions":[{"type":"PRICE_ADJUST_PERCENT","value":-8},{"type":"CHARM_PRICE","value":99}]}]}}}}}}},"tags":["Rulesets"]},"delete":{"summary":"Delete Ruleset by ID","operationId":"DeleteRulesetByID","responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"401-error-example":{"value":{"message":"This request failed to be authenticated.","code":"00-1","type":"authentication.failed"}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"403-error-example":{"value":{"message":"This request does not contain the necessary permissions to access the target endpoint.","code":"00-2","type":"authorization.invalid_scopes"}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"description":"Delete a ruleset, selected by the ruleset database ID. This requires write_price_rulesets scope/permission.","tags":["Rulesets"]},"patch":{"summary":"Patch Ruleset by ID","operationId":"PatchRulesetByID","responses":{"204":{"description":"Successfully updated ruleset"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"401-error-example":{"value":{"message":"This request failed to be authenticated.","code":"00-1","type":"authentication.failed"}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"403-error-example":{"value":{"message":"This request does not contain the necessary permissions to access the target endpoint.","code":"00-2","type":"authorization.invalid_scopes"}}}}}}},"description":"Change ruleset attributes including specified rules for an existing ruleset with the specified ruleset database ID without replacing unaffected rules. This requires write_price_rulesets scope/permission.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BasicPatchRuleset"},"examples":{"patch-ruleset-example":{"value":{"ruleset":{"start_date":"2020-11-01T00:00:00Z","expiry_date":"2020-11-17T23:59:59Z","rules":[{"external_id":"CreatedByAPI_1","type":"DISCOUNT","conditions":[{"type":"CUSTOMER_GROUP","value":"silver"},{"type":"QTY_BY_PRODUCT","operator":">=","value":3}],"actions":[{"type":"PRICE_ADJUST_PERCENT","value":-8}]}]}}}}}},"description":""},"tags":["Rulesets"]}},"/price_rules/rules/v2/shops/{shop_identifier}/rulesets/eid/{external_id}":{"get":{"summary":"Get Ruleset by External ID","operationId":"GetRulesetByExternalID","tags":["Rulesets"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"data":{"type":"object","properties":{"ruleset":{"$ref":"#/components/schemas/Ruleset"}}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"401-error-example":{"value":{"message":"This request failed to be authenticated.","code":"00-1","type":"authentication.failed"}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"403-error-example":{"value":{"message":"This request does not contain the necessary permissions to access the target endpoint.","code":"00-2","type":"authorization.invalid_scopes"}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"description":"Return data for a specific ruleset, selected by the ruleset external ID. This requires read_price_rulesets scope/permission."},"parameters":[{"schema":{"type":"string"},"name":"shop_identifier","in":"path","required":true,"description":"Bold platform identifier for the shop. Find this identifier using the [Get Shop Info](shops#operation/GetShopInfo) endpoint."},{"schema":{"type":"string"},"name":"external_id","in":"path","required":true,"description":"Ruleset external_id."},{"schema":{"type":"boolean"},"name":"include_all_apps","in":"query","description":"Indicates whether to include rulesets created by other apps. Without this flag (`?include_all_apps=true`), only rulesets created via the Price Rules API are returned."}],"post":{"summary":"Create Ruleset by External ID","operationId":"CreateRulesetByExternalID","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"data":{"type":"object","properties":{"ruleset":{"$ref":"#/components/schemas/Ruleset"}}}}},"examples":{"200-response-example":{"value":{"message":"Successfully updated ruleset","data":{"ruleset":{"id":83,"external_id":"CreatedByAPI_12","active":true,"internal_name":"This was created by the API using the CreatedByAPI_12 ID","public_name":"","start_date":null,"expiry_date":null,"sync_percent":0,"priority":0,"created_at":"2020-05-07T11:05:23Z","updated_at":"2020-05-07T11:05:23Z","rules":[{"type":"DISCOUNT","conditions":[{"type":"CUSTOMER_GROUP","value":"wholesale"}],"actions":[{"type":"PRICE_ADJUST_PERCENT","value":1250}]}],"product_selection":{"product_ids":["1234567890123","1234567890987"],"type":"SHOPIFY_PRODUCT_SEARCH"}}}}}}}}},"201":{"description":"Created","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"data":{"type":"object","properties":{"ruleset":{"$ref":"#/components/schemas/Ruleset"}}}}},"examples":{"201-response-example":{"value":{"message":"Successfully created ruleset","data":{"ruleset":{"id":83,"external_id":"CreatedByAPI_12","active":true,"internal_name":"This was created by the API using the CreatedByAPI_12 ID","public_name":"","start_date":null,"expiry_date":null,"sync_percent":0,"priority":0,"created_at":"2020-05-07T11:05:23Z","updated_at":"2020-05-07T11:05:23Z","rules":[{"type":"DISCOUNT","conditions":[{"type":"CUSTOMER_GROUP","value":"gold"}],"actions":[{"type":"PRICE_ADJUST_ABSOLUTE","value":1500}]}],"product_selection":{"product_ids":["1234567890123","1234567890987"],"type":"SHOPIFY_PRODUCT_SEARCH"}}}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"401-error-example":{"value":{"message":"This request failed to be authenticated.","code":"00-1","type":"authentication.failed"}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"403-error-example":{"value":{"message":"This request does not contain the necessary permissions to access the target endpoint.","code":"00-2","type":"authorization.invalid_scopes"}}}}}},"422":{"description":"Unprocessable Entity (WebDAV)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"422-error-response":{"value":{"message":"Invalid ruleset in payload","code":"04-3","type":"price_rules.invalid_payload"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"500-error-example":{"value":{"message":"Error writing ruleset by external_id","code":"04-0","type":"unexpected"}}}}}}},"description":"This operation has two purposes. If the given ruleset external ID already exists in the database, the ruleset will be updated using the request body information. Otherwise, a new ruleset will be created with the same data. This requires write_price_rulesets scope/permission.","tags":["Rulesets"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"ruleset":{"$ref":"#/components/schemas/BasicRuleset"}}},"examples":{"write-ruleset-eid-example":{"value":{"ruleset":{"external_id":"CreatedByAPI_3","internal_name":"This ruleset will be created if it still does not exist","product_selection":{"type":"SHOPIFY_PRODUCT_SEARCH","product_ids":["1234567890123","1234567890987"]},"rules":[{"type":"DISCOUNT","conditions":[{"type":"QTY_BY_PRODUCT","operator":">=","value":3}],"actions":[{"type":"PRICE_ADJUST_PERCENT","value":-20},{"type":"CHARM_PRICE","value":99}]}]}}}}}}}},"delete":{"summary":"Delete Ruleset by External ID","operationId":"DeleteRulesetByExternalID","responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"401-error-example":{"value":{"message":"This request failed to be authenticated.","code":"00-1","type":"authentication.failed"}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"403-error-example":{"value":{"message":"This request does not contain the necessary permissions to access the target endpoint.","code":"00-2","type":"authorization.invalid_scopes"}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"500-error-example":{"value":{"message":"Error with deleting a ruleset with external_id","code":"04-0","type":"unexpected"}}}}}}},"tags":["Rulesets"],"description":"Removes a specific ruleset, selected by the ruleset external ID. This requires write_price_rulesets scope/permission."},"patch":{"summary":"Patch Ruleset by External ID","operationId":"PatchRulesetByExternalID","responses":{"204":{"description":"Successfully updated ruleset"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"401-error-example":{"value":{"message":"This request failed to be authenticated.","code":"00-1","type":"authentication.failed"}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"403-error-example":{"value":{"message":"This request does not contain the necessary permissions to access the target endpoint.","code":"00-2","type":"authorization.invalid_scopes"}}}}}}},"description":"Change ruleset attributes including specified rules for an existing ruleset with the specified ruleset external ID without replacing unaffected rules. This requires write_price_rulesets scope/permission.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BasicPatchRuleset"},"examples":{"patch-ruleset-example":{"value":{"ruleset":{"start_date":"2020-11-01T00:00:00Z","expiry_date":"2020-11-17T23:59:59Z","rules":[{"external_id":"CreatedByAPI_1","type":"DISCOUNT","conditions":[{"type":"CUSTOMER_GROUP","value":"silver"},{"type":"QTY_BY_PRODUCT","operator":">=","value":3}],"actions":[{"type":"PRICE_ADJUST_PERCENT","value":-8}]}]}}}}}}},"tags":["Rulesets"]}},"/price_rules/rules/v2/shops/{shop_identifier}/rulesets/bulk/activate":{"parameters":[{"schema":{"type":"string"},"name":"shop_identifier","in":"path","required":true,"description":"Bold platform identifier for the shop. Find this identifier using the [Get Shop Info](shops#operation/GetShopInfo) endpoint."}],"post":{"summary":"Activate All Rulesets","operationId":"ActivateAllRulesets","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"data":{"type":"array","items":{}}}},"examples":{"200-response-example":{"value":{"message":"Successfully activated 22 rulesets","data":[]}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"401-error-example":{"value":{"message":"This request failed to be authenticated.","code":"00-1","type":"authentication.failed"}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"403-error-example":{"value":{"message":"This request does not contain the necessary permissions to access the target endpoint.","code":"00-2","type":"authorization.invalid_scopes"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"500-error-example":{"value":{"message":"Error while activating rulesets","code":"04-0","type":"unexpected"}}}}}}},"description":"Set the status of all rulesets to active in the specified shop. This requires write_price_rulesets scope/permission.","tags":["Rulesets"]}},"/price_rules/rules/v2/shops/{shop_identifier}/rulesets/bulk/deactivate":{"parameters":[{"schema":{"type":"string"},"name":"shop_identifier","in":"path","required":true,"description":"Bold platform identifier for the shop. Find this identifier using the [Get Shop Info](shops#operation/GetShopInfo) endpoint."}],"post":{"summary":"Deactivate All Rulesets","operationId":"DeactivateAllRulesets","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"data":{"type":"array","items":{}}}},"examples":{"200-response-example":{"value":{"message":"Successfully deactivated 18 rulesets","data":[]}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"401-error-example":{"value":{"message":"This request failed to be authenticated.","code":"00-1","type":"authentication.failed"}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"403-error-example":{"value":{"message":"This request does not contain the necessary permissions to access the target endpoint.","code":"00-2","type":"authorization.invalid_scopes"}}}}}}},"description":"Set the status of all rulesets to inactive in the specified shop. This requires write_price_rulesets scope/permission.","tags":["Rulesets"]}},"/price_rules/storefront/v2/shops/{shop_identifier}/rulesets":{"parameters":[{"schema":{"type":"string"},"name":"shop_identifier","in":"path","required":true,"description":"Bold platform identifier for the shop. Find this identifier using the [Get Shop Info](shops#operation/GetShopInfo) endpoint."}],"get":{"summary":"List Rulesets by Product ID","operationId":"ListRulesetsByProductID","tags":["Rulesets"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"data":{"type":"object","properties":{"rulesets":{"type":"array","description":"Each set of rules that is related to the shop and the given products.","items":{"$ref":"#/components/schemas/Ruleset"}},"shop_options":{"$ref":"#/components/schemas/ShopOptions"},"base_prices":{"type":"array","items":{"$ref":"#/components/schemas/BasePrice"}}}}}},"examples":{"200-response-example":{"value":{"message":"Successfully fetched rulesets","data":{"rulesets":[{"id":56,"app_slug":"my-cool-app","public_name":"","internal_name":"","external_id":"","active":true,"sync_percent":100,"priority":100,"expiry_date":null,"rules":[{"type":"DISCOUNT","conditions":[{"type":"CUSTOMER_GROUP","value":"wholesale"}],"actions":[{"type":"PRICE_ADJUST_RELATIVE","value":-5000}]},{"type":"DISCOUNT","conditions":[{"type":"CUSTOMER_GROUP","value":"gold"}],"actions":[{"type":"PRICE_ADJUST_RELATIVE","value":-2500}]},{"type":"DISCOUNT","conditions":[{"type":"CUSTOMER_GROUP","value":"silver"}],"actions":[{"type":"PRICE_ADJUST_RELATIVE","value":-1250}]},{"type":"DISCOUNT","conditions":[{"type":"CUSTOMER_GROUP","value":"bronze"}],"actions":[{"type":"PRICE_ADJUST_RELATIVE","value":-620}]}],"product_selection":{"type":"SHOPIFY_PRODUCT_SEARCH","products":[{"product_id":"1234567890123"}]}}],"shop_options":{"compare_at_price_as_original":true,"verbose_logs":true,"include_base_prices":true},"base_prices":[{"id":98765432101234,"price":10000},{"id":98765432109876,"price":12000}]}}}}}}}},"description":"List all rulesets available for the specified shop and product IDs.  This requires no special permissions.","parameters":[{"schema":{"type":"string"},"in":"query","name":"products","description":"A comma separated list of all product IDs; Example: ?products=123","required":true},{"schema":{"type":"string"},"in":"query","name":"filter[]","description":"Rule condition filter. Example: &filter[]=eq(CUSTOMER_GROUP%3Agold)&filter[]=like(CURRENCY%3ACAD)"}]}},"/price_rules/rules/v2/hello-api":{"get":{"summary":"Simple Communication Test","operationId":"SimpleCommunicationTest","tags":["Simple Communication Test"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"The success message."},"data":{"type":"object","properties":{"hello":{"type":"string","description":"A simple Hello World."}}}}},"examples":{"test-response-example":{"value":{"message":"Successfully reached Price Rules API","data":{"hello":"world!"}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"description":"Test endpoint to ensure that the request contains a valid token and that it is successfully reaching Price Rules API. This requires no special permissions."}},"/price_rules/rules/v2/shops/{shop_identifier}/order_condition":{"parameters":[{"schema":{"type":"string"},"name":"shop_identifier","in":"path","required":true,"description":"Bold platform identifier for the shop. Find this identifier using the [Get Shop Info](shops#operation/GetShopInfo) endpoint."}],"get":{"summary":"List Order Conditions","operationId":"ListOrderConditions","tags":["Order Conditions"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"data":{"type":"object","properties":{"order_conditions":{"type":"array","items":{"$ref":"#/components/schemas/OrderCondition"}}}},"pagination":{"$ref":"#/components/schemas/Pagination"}}},"examples":{"200-response-example":{"value":{"message":"Successfully fetched order conditions","data":{"order_conditions":[{"name":"ZONE","value":"north-america-04","operator":"ONE_OF","type":"FIELD_SET","field_sets":[{"field_set_id":27,"customer.shipping.country":"Canada","customer.shipping.postal_code":"R3Y0L6"},{"field_set_id":28,"customer.shipping.country":"Canada","customer.shipping.postal_code":"R3T5Y3"},{"field_set_id":66,"customer.shipping.country":"Canada","customer.shipping.postal_code":"R3T345"}]},{"name":"ZONE","value":"north-america-05","operator":"ONE_OF","type":"FIELD_SET","field_sets":[{"field_set_id":71,"customer.shipping.country":"United States of America","customer.shipping.postal_code":"R3Y0L6"},{"field_set_id":72,"customer.shipping.country":"United States of America","customer.shipping.postal_code":"R3T5Y3"}]}]},"pagination":{"total":2,"count":2,"per_page":50,"current_page":1,"total_pages":1}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"parameters":[{"schema":{"type":"string"},"in":"query","name":"deep","description":"If this flag is true, all the details of the Order Condition will be included in the response. Otherwise, only basic information (name, value, etc.) will be returned."},{"schema":{"type":"integer"},"in":"query","name":"page","description":"The desired page number for the paginated result (default is 1)."},{"schema":{"type":"integer"},"in":"query","name":"limit","description":"Size of the page to be used for the paginated result (default is 50)."}],"description":"List all Order Conditions available for the specified shop. Requires the read_price_order_conditions scope/permission."},"post":{"summary":"Create Order Condition","operationId":"CreateOrderCondition","tags":["Order Conditions"],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"data":{"type":"object","required":["order_condition"],"properties":{"order_condition":{"type":"object","items":{"$ref":"#/components/schemas/OrderCondition"}}}}},"required":["message","data"]}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"413":{"description":"Request Entity Too Large","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Unprocessable Entity (WebDAV)"},"500":{"description":"Internal Server Error"}},"description":"Creates an Order Condition. Requires the write_price_order_conditions scope/permission.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderCondition"},"examples":{"create-order-condition-example":{"value":{"name":"zone","value":"north-america-05","operator":"ONE_OF","type":"FIELD_SET","field_sets":[{"customer.shipping.postal_code":"90210","customer.shipping.country_code":"US"},{"customer.shipping.postal_code":"55555","customer.shipping.country_code":"US"}]}}}}}}}},"/price_rules/rules/v2/shops/{shop_identifier}/order_condition/condition_name/{condition_name}/condition_value/{condition_value}":{"parameters":[{"schema":{"type":"string"},"name":"shop_identifier","in":"path","required":true,"description":"Bold platform identifier for the shop. Find this identifier using the [Get Shop Info](shops#operation/GetShopInfo) endpoint."},{"schema":{"type":"string"},"name":"condition_name","in":"path","required":true,"description":"Name of the condition. This can be used to group similar options that depend on the same piece of data. For example, it is possible to have several Order Conditions with the same name (DELIVERY_ZONE) and different values (NorthAmerica, Europe) that evaluate the same fields (country, city and postal code)."},{"schema":{"type":"string"},"name":"condition_value","in":"path","required":true,"description":"Value of the condition. This describes an option available for a collection of conditions that share the same name. Discounts will be applied based on the presence of a specific \\"name:value\\" pair. It is possible to have several Order Conditions with identical names (DELIVERY_ZONE) and different values/options (NorthAmerica, Europe) as long as they evaluate the same fields (country, city and postal code)."}],"get":{"summary":"Get Order Condition","operationId":"GetOrderCondition","tags":["Order Conditions"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"data":{"type":"object","properties":{"order_condition":{"$ref":"#/components/schemas/OrderCondition"}}}}},"examples":{"200-response-example":{"value":{"message":"Successfully fetched order condition","data":{"order_condition":{"name":"ZONE","value":"Prairies","operator":"ONE_OF","type":"FIELD_SET","field_sets":[{"field_set_id":71,"customer.shipping.country":"Canada","customer.shipping.postal_code":"R3Y0L6"},{"field_set_id":72,"customer.shipping.country":"Canada","customer.shipping.postal_code":"R3T5Y3"}]}}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"description":"Gets an Order Condition by its name and value. Requires the read_price_order_conditions scope/permission."},"delete":{"summary":"Delete Order Condition by Name and Value","operationId":"DeleteOrderConditionByNameAndValue","tags":["Order Conditions"],"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"description":"Delete an Order Condition by condition_name and condition_value. Requires the write_price_order_conditions scope/permission."},"put":{"summary":"Update Order Condition","operationId":"UpdateOrderCondition","tags":["Order Conditions"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"data":{"type":"object","properties":{"order_condition":{"$ref":"#/components/schemas/OrderCondition"}}}}},"examples":{"200-response-example":{"value":{"message":"Successfully updated order condition","data":{"order_condition":{"name":"ZONE","value":"north-america-01","operator":"ONE_OF","type":"FIELD_SET","field_sets":[{"field_set_id":82,"customer.shipping.country":"United States of America","customer.shipping.postal_code":"91210"},{"field_set_id":83,"customer.shipping.country":"United States of America","customer.shipping.postal_code":"99999"}]}}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"413":{"description":"Request Entity Too Large","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Unprocessable Entity (WebDAV)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"description":"Updates an Order Condition. Requires the write_price_order_conditions scope/permission.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderCondition"},"examples":{"update-order-condition-example":{"value":{"name":"ZONE","value":"north-america-01","operator":"ONE_OF","type":"FIELD_SET","field_sets":[{"field_set_id":3,"customer.shipping.country":"United States of America","customer.shipping.postal_code":"91210"},{"customer.shipping.country":"United States of America","customer.shipping.postal_code":"99999"}]}}}}}}}},"/price_rules/rules/v2/shops/{shop_identifier}/order_condition/valid_fields":{"parameters":[{"schema":{"type":"string"},"name":"shop_identifier","in":"path","required":true,"description":"Bold platform identifier for the shop. Find this identifier using the [Get Shop Info](shops#operation/GetShopInfo) endpoint."}],"get":{"summary":"List Valid Fields for Order Condition","operationId":"ListValidFieldsForOrderCondition","tags":["Order Conditions"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"data":{"type":"object","properties":{"field_names":{"type":"array","items":{"type":"string"}}}}}},"examples":{"200-response-example":{"value":{"message":"Successfully fetched valid field names","data":{"field_names":["customer.shipping.country","customer.shipping.country_code","customer.shipping.postal_code","customer.shipping.province","customer.shipping.province_code"]}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"description":"Gets a list of all the shop/customer fields that can be evaluated in an Order Condition. Requires the read_price_order_conditions scope/permission."}},"/price_rules/rules/v2/shops/{shop_identifier}/order_condition/condition_name/{condition_name}":{"parameters":[{"schema":{"type":"string"},"name":"shop_identifier","in":"path","required":true,"description":"Bold platform identifier for the shop. Find this identifier using the [Get Shop Info](shops#operation/GetShopInfo) endpoint."},{"schema":{"type":"string"},"name":"condition_name","in":"path","required":true,"description":"The name and value of an Order Condition are a combination that uniquely identifies that condition."}],"delete":{"summary":"Delete Order Condition by Name","operationId":"DeleteOrderConditionByName","tags":["Order Conditions"],"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"description":"Delete a collection of Order Conditions that share the same name, for example all the DELIVERY_ZONE Order Conditions regardless of their values (NorthAmerica, Europe, etc.). Requires the write_price_order_conditions scope/permission.","parameters":[{"schema":{"type":"string"},"in":"query","name":"condition_name","description":"Name of the condition.","required":true}]}},"/price_rules/rules/v2/shops/{shop_identifier}/order_condition/condition_name/{condition_name}/field_name/{field_name}":{"parameters":[{"schema":{"type":"string"},"name":"shop_identifier","in":"path","required":true,"description":"Bold platform identifier for the shop. Find this identifier using the [Get Shop Info](shops#operation/GetShopInfo) endpoint."},{"schema":{"type":"string"},"name":"condition_name","in":"path","required":true,"description":"The name and value of an Order Condition are a combination that uniquely identifies that condition."},{"schema":{"type":"string"},"name":"field_name","in":"path","required":true,"description":"Field that should be deleted, for example \\"customer.shipping.province\\"."}],"delete":{"summary":"Delete Order Condition Field by Name","operationId":"DeleteOrderConditionFieldByName","tags":["Order Conditions"],"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"description":"Delete a field from all the Order Conditions that share the same name. For example, if a list of DELIVERY_ZONE conditions were evaluating both city and postal code before, and now they should check the postal code only, then the irrelevant field (city) can be erased by this operation. Requires the write_price_order_conditions scope/permission."}},"/price_rules/rules/v2/shops/{shop_identifier}/order_condition/field_sets/add":{"parameters":[{"schema":{"type":"string"},"name":"shop_identifier","in":"path","required":true,"description":"Bold platform identifier for the shop. Find this identifier using the [Get Shop Info](shops#operation/GetShopInfo) endpoint."}],"patch":{"summary":"Add Field Sets to Order Condition","operationId":"AddFieldSetsToOrderCondition","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"data":{"type":"object","properties":{"order_condition":{"$ref":"#/components/schemas/OrderCondition"},"field_sets_added":{"type":"array","description":"This operation returns only the Field Sets that were added, not the complete list.","items":{"$ref":"#/components/schemas/FieldSet"}}}}}},"examples":{"200-response-example":{"value":{"message":"Successfully added field set(s) to order condition","data":{"order_condition":{"name":"ZONE","value":"Prairies","operator":"ONE_OF","type":"FIELD_SET"},"field_sets_added":[{"field_set_id":76,"customer.shipping.country":"United States of America","customer.shipping.postal_code":"98765"},{"field_set_id":77,"customer.shipping.country":"United States of America","customer.shipping.postal_code":"43210"},{"field_set_id":78,"customer.shipping.country":"United States of America","customer.shipping.postal_code":"88888"}]}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"description":"Adds one or more new Field Sets to a specific Order Condition. Requires the write_price_order_conditions scope/permission.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"The name and value of an Order Condition are a combination that uniquely identifies that condition."},"value":{"type":"string","description":"The name and value of an Order Condition are a combination that uniquely identifies that condition."},"field_sets":{"type":"array","description":"Field sets to be added.","items":{"$ref":"#/components/schemas/FieldSet"}}}},"examples":{"add-fieldsets-example":{"value":{"name":"ZONE","value":"north-america-05","field_sets":[{"customer.shipping.country":"United States of America","customer.shipping.postal_code":"98765"},{"customer.shipping.country":"United States of America","customer.shipping.postal_code":"43210"},{"customer.shipping.country":"United States of America","customer.shipping.postal_code":"88888"}]}}}}}},"tags":["Order Conditions"]}},"/price_rules/rules/v2/shops/{shop_identifier}/order_condition/field_sets/remove":{"parameters":[{"schema":{"type":"string"},"name":"shop_identifier","in":"path","required":true,"description":"Bold platform identifier for the shop. Find this identifier using the [Get Shop Info](shops#operation/GetShopInfo) endpoint."}],"patch":{"summary":"Delete Field Sets from Order Condition","operationId":"DeleteFieldSetsFromOrderCondition","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"data":{"type":"object","properties":{"order_condition":{"type":"object","properties":{"name":{"type":"string","description":"The name and value of an Order Condition are a combination that uniquely identifies that condition."},"value":{"type":"string","description":"The name and value of an Order Condition are a combination that uniquely identifies that condition."},"":{"type":"string"}}}}}}},"examples":{"200-response-example":{"value":{"message":"Successfully removed 3 field set(s) from order condition","data":{"order_condition":{"name":"ZONE","value":"north-america-05"}}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"description":"Remove one or more existent Field Sets from a specific Order Condition. Requires the write_price_order_conditions scope/permission.","tags":["Order Conditions"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"The name and value of an Order Condition are a combination that uniquely identifies that condition."},"value":{"type":"string","description":"The name and value of an Order Condition are a combination that uniquely identifies that condition."},"field_set_ids":{"type":"array","description":"List containing the ids of each Field Set that should be removed.","items":{}}}},"examples":{"remove-field-sets-example":{"value":{"name":"ZONE","value":"north-america-05","field_set_ids":[69,70,73]}}}}}}}},"/price_rules/rules/v2/shops/{shop_identifier}/order_condition/condition_name/{condition_name}/condition_value/{condition_value}/field_sets":{"parameters":[{"schema":{"type":"string"},"name":"shop_identifier","in":"path","required":true,"description":"Bold platform identifier for the shop. Find this identifier using the [Get Shop Info](shops#operation/GetShopInfo) endpoint."},{"schema":{"type":"string"},"name":"condition_name","in":"path","required":true,"description":"Name of the condition. This can be used to group similar options that depend on the same piece of data. For example, it is possible to have several Order Conditions with the same name (DELIVERY_ZONE) and different values (NorthAmerica, Europe) that evaluate the same fields (country, city and postal code)."},{"schema":{"type":"string"},"name":"condition_value","in":"path","required":true,"description":"Value of the condition. This describes an option available for a collection of conditions that share the same name. Discounts will be applied based on the presence of a specific \\"name:value\\" pair. It is possible to have several Order Conditions with the identical names (DELIVERY_ZONE) and different values/options (NorthAmerica, Europe) as long as they evaluate the same fields (country, city and postal code)."}],"get":{"summary":"List Matching Field Sets for Order Condition","operationId":"ListMatchingFieldSetsForOrderCondition","tags":["Order Conditions"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"data":{"type":"object","properties":{"field_sets":{"type":"array","items":{"$ref":"#/components/schemas/FieldSet"}}}},"pagination":{"$ref":"#/components/schemas/Pagination"}}},"examples":{"200-response-example":{"value":{"message":"Successfully fetched matched field sets for order condition","data":{"field_sets":[{"field_set_id":71,"customer.shipping.country":"United States of America","customer.shipping.postal_code":"R3Y0L6"},{"field_set_id":72,"customer.shipping.country":"United States of America","customer.shipping.postal_code":"R3T5Y3"}]},"pagination":{"total":2,"count":2,"per_page":50,"current_page":1,"total_pages":1}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"description":"Gets all the sets of fields that are valid/that comply with an Order Condition. An Order Condition can be matched by different sets of data, for example \'DELIVERY_ZONE: NorthAmerica\' could include a lot of possible country + postal code combinations. Requires the read_price_order_conditions scope/permission.","parameters":[{"schema":{"type":"string"},"in":"query","name":"page","description":"The desired page number for the paginated result (default is 1)."},{"schema":{"type":"string"},"in":"query","name":"limit","description":"Size of the page to be used for the paginated result (default is 50)."}]}},"/price_rules/rules/v2/shops/{shop_identifier}/order_condition/condition_name/{condition_name}/validate":{"parameters":[{"schema":{"type":"string"},"name":"shop_identifier","in":"path","required":true,"description":"Bold platform identifier for the shop. Find this identifier using the [Get Shop Info](shops#operation/GetShopInfo) endpoint."},{"schema":{"type":"string"},"name":"condition_name","in":"path","required":true,"description":"Name of the condition. This can be used to group similar options that depend on the same piece of data. For example, it is possible to have several Order Conditions with the same name (DELIVERY_ZONE) and different values (NorthAmerica, Europe) that evaluate the same fields (country, city and postal code)."}],"get":{"summary":"Validate Order Condition Group","operationId":"ValidateOrderConditionGroup","tags":["Order Conditions"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"The message contains the result of the Order Condition group analysis"},"data":{"type":"array","description":"Data for this operation will be always empty","items":{"type":"object"}}}},"examples":{"200-response-example":{"value":{"message":"Order condition \'ZONE: North-America-05\' has one or more field sets that are missing field(s). Order condition \'ZONE: North-America-10\' has one or more field sets that contain unexpected fields. Order condition \'ZONE: Europe-07\' has one or more field sets that are missing field(s). Expected fields for the \'ZONE\' group are: [customer.shipping.country, customer.shipping.postal_code]","data":[]}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"description":"This endpoint can be used to check internal inconsistencies between an Order Condition group (a set of conditions that share the same condition_name). All Order Conditions that share a name should evaluate the same fields.\\n\\nFor example: If a shop has a condition \\"name: zone, value: north-america-05\\" that contains several combinations of country and postal code on its field sets, when a new condition \\"name: zone, value: europe-01\\" is created on the same shop it should also use country and postal code to define its field sets.\\n\\nRequires the read_price_order_conditions scope/permission."}},"/price_rules/rules/v2/shops/{shop_identifier}/process":{"parameters":[{"schema":{"type":"string"},"name":"shop_identifier","in":"path","required":true,"description":"Bold platform identifier for the shop. Find this identifier using the [Get Shop Info](shops#operation/GetShopInfo) endpoint."}],"post":{"summary":"Get Adjusted Cart","operationId":"GetAdjustedCart","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"pre_checkout_id":{"type":"string"},"actions":{"type":"array","items":{"$ref":"#/components/schemas/CartAction"}}}},"examples":{"example adjusted cart response":{"value":{"pre_checkout_id":"POS_123","actions":[{"key":"uniquekey1","price":10,"matchValue":"123","quantity":2,"rule":[{"id":1,"rule_set_id":1,"rule_set_eid":"ruleset_eid"}]},{"key":"uniquekey2","price":12,"matchValue":"223","quantity":1,"rule":[{"id":1,"rule_set_id":1,"rule_set_eid":"ruleset_eid"}]}]}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"401-error-example":{"value":{"message":"This request failed to be authenticated.","code":"00-1","type":"authentication.failed"}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"403-error-example":{"value":{"message":"This request does not contain the necessary permissions to access the target endpoint.","code":"00-2","type":"authorization.invalid_scopes"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"500-error-example":{"value":{"message":"Error with fetching a ruleset","code":"04-0","type":"unexpected"}}}}}}},"description":"Return final price for lineItem in a cart. This requires read_price_rulesets scope/permission.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"lineItems":{"type":"array","items":{"$ref":"#/components/schemas/ProcessLineItem"}},"matchLineItemProperty":{"type":"string","enum":["sku"]},"customer":{"$ref":"#/components/schemas/Customer"}},"required":["lineItems","matchLineItemProperty"]},"examples":{"example cart payload":{"value":{"lineItems":[{"key":"uniquekey1","price":12,"matchValue":"123","quantity":2},{"key":"uniquekey2","price":15,"matchValue":"223","quantity":1}],"matchLineItemProperty":"sku","customer":{"shipping":{"postal_code":"R3Y0X5"}}}}}}}},"tags":["Rulesets"]}},"/price_rules/storefront/v2/shops/{shop_identifier}/price":{"parameters":[{"schema":{"type":"string"},"name":"shop_identifier","in":"path","required":true,"description":"Bold platform identifier for the shop. Find this identifier using the [Get Shop Info](shops#operation/GetShopInfo) endpoint."}],"post":{"summary":"Get Final Price for Product","operationId":"GetFinalPriceForProduct","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"pre_best_price_log_id":{"type":"string"},"actions":{"type":"array","items":{"$ref":"#/components/schemas/BestProductPriceAction"}}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"description":"Return the final price for item. This requires no special permissions.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/BestProductPriceItem"}},"cart_params":{"type":"object","description":"Supply optional parameters, such as orderData and source"},"lineItemIdType":{"type":"string","enum":["sku"]},"customer":{"$ref":"#/components/schemas/TaggedCustomer"}},"required":["items","lineItemIdType"]},"examples":{"example-1":{"value":{"lineItemIdType":"sku","items":[{"price":0,"id":"number","quantity":0}],"cart_params":{},"customer":{"tags":"string","shipping":{"postal_code":"string","country":"string","country_code":"string","province":"string","province_code":"string"}}}}}}},"description":""},"tags":["Storefronts"]}},"/price_rules/storefront/v2/currency/{currency_name}":{"parameters":[{"schema":{"type":"string"},"name":"currency_name","in":"path","required":true,"description":"Currency Code (ie. USD, CAD, GDP). Can be optained through: https://www.iban.com/currency-codes"}],"get":{"summary":"Get Currency Symbol for Currency Code","operationId":"GetCurrencySymbolForCurrencyCode","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"description":"","type":"object","properties":{"id":{"type":"number"},"currency_iso_name":{"type":"string","minLength":1},"friendly_name":{"type":"string","minLength":1},"currency_symbol":{"type":"string","minLength":1},"money_format":{"type":"string","minLength":1},"money_with_currency_format":{"type":"string","minLength":1}},"required":["id","currency_iso_name","friendly_name","currency_symbol","money_format","money_with_currency_format"]},"examples":{"200-response-example":{"value":{"id":181,"currency_iso_name":"CAD","friendly_name":"Canadian Dollar","currency_symbol":"$","money_format":"${{amount}}","money_with_currency_format":"${{amount}} CAD"}}}}}}},"description":"Get Currency information from a currency code (ie. USD, CAD, GDP). Can be obtained through: https://www.iban.com/currency-codes","tags":["Storefronts"],"parameters":[]}},"/price_rules/storefront/v2/shops/{shop_identifier}/cart":{"parameters":[{"schema":{"type":"string"},"name":"shop_identifier","in":"path","required":true,"description":"Bold platform identifier for the shop. Find this identifier using the [Get Shop Info](shops#operation/GetShopInfo) endpoint."}],"post":{"summary":"Get Best Price for Cart","operationId":"GetBestPriceForCart","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"pre_checkout_id":{"type":"string"},"actions":{"type":"array","items":{"$ref":"#/components/schemas/CartAction"}}}},"examples":{"example adjusted cart response":{"value":{"pre_checkout_id":"POS_123","actions":[{"line_item_key":"uniquekey1","value":10,"sku":"123","variant_id":49702426812601,"rule":[{"id":1593607,"eid":"rule_id","rule_set_id":101480,"rule_set_eid":"ruleset_eid","rule_set_public_message":"","type":"DISCOUNT"}]},{"line_item_key":"uniquekey2","value":12,"sku":"223","variant_id":29702426812602,"rule":[{"id":5593607,"eid":"rule_id_2","rule_set_id":601480,"rule_set_eid":"ruleset_eid_2","rule_set_public_message":"A public message","type":"DISCOUNT"}]}]}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"500-error-example":{"value":{"message":"Error with fetching a ruleset","code":"04-0","type":"unexpected"}}}}}}},"description":"Return final price for lineItem in a cart. This requires no special permissions.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"lineItems":{"type":"array","items":{"$ref":"#/components/schemas/LineItem"}},"lineItemIdType":{"type":"string","enum":["sku"]},"customer":{"$ref":"#/components/schemas/TaggedCustomer"}},"required":["lineItems","lineItemIdType"]},"examples":{"example cart payload":{"value":{"lineItems":[{"key":"uniquekey1","price":12,"id":"123","quantity":2},{"key":"uniquekey2","price":15,"id":"223","quantity":1}],"lineItemIdType":"sku","customer":{"email":"user@example.com"}}}}}}},"tags":["Storefronts"]}},"/price_rules/rules/v2/shops/{shop_identifier}/rulesets/eid/{external_id}/rules/remove":{"parameters":[{"schema":{"type":"string"},"name":"shop_identifier","in":"path","required":true,"description":"Bold platform identifier for the shop. Find this identifier using the [Get Shop Info](shops#operation/GetShopInfo) endpoint."},{"schema":{"type":"string"},"name":"external_id","in":"path","required":true}],"patch":{"summary":"Bulk Delete Rules by Ruleset EID","operationId":"BulkDeleteRulesByRulesetEID","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}},"examples":{"sample response":{"value":{"message":"Successfully removed 2 rules from ruleset with rulesetId:1"}}}}}}},"description":"Remove one or more existent rules from a specific Ruleset. Requires the write_price_rulesets scope/permission.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"rule_ids":{"type":"array","items":{"type":"integer"}}},"required":["rule_ids"]},"examples":{"Payload example":{"value":{"rule_ids":[1,2]}}}}},"description":""},"parameters":[],"tags":["Rules"]}},"/price_rules/rules/v2/shops/{shop_identifier}/rulesets/{ruleset_id}/rules/remove":{"parameters":[{"schema":{"type":"string"},"name":"shop_identifier","in":"path","required":true,"description":"Bold platform identifier for the shop. Find this identifier using the [Get Shop Info](shops#operation/GetShopInfo) endpoint."},{"schema":{"type":"string"},"name":"ruleset_id","in":"path","required":true}],"patch":{"summary":"Bulk Delete Rules by Ruleset ID","operationId":"BulkDeleteRulesByRulesetID","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}},"examples":{"sample response":{"value":{"message":"Successfully removed 2 rules from ruleset with rulesetId:1"}}}}}}},"description":"Remove one or more existent rules from a specific Ruleset. Requires the write_price_rulesets scope/permission.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"rule_ids":{"type":"array","items":{"type":"integer"}}},"required":["rule_ids"]},"examples":{"Payload example":{"value":{"rule_ids":[1,2]}}}}},"description":""},"tags":["Rules"]}},"/price_rules/rules/v2/shops/{shop_identifier}/discount_codes":{"parameters":[{"schema":{"type":"string"},"name":"shop_identifier","in":"path","required":true,"description":"Bold platform identifier for the shop. Find this identifier using the [Get Shop Info](shops#operation/GetShopInfo) endpoint."}],"post":{"summary":"Create Discount Code","operationId":"CreateDiscountCode","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"The message contains the result of this operation."},"data":{"type":"object","properties":{"discount_codes":{"type":"array","items":{"$ref":"#/components/schemas/DiscountCode"}}}}}},"examples":{"200-response-example":{"value":{"message":"Discount code(s) created successfully!","data":{"discount_codes":[{"code":"BACK_TO_SCHOOL","updated_at":"2020-09-16T20:39:57.000000Z","created_at":"2020-09-16T20:39:57.000000Z","id":8,"ruleset":{"id":"20","external_id":"RELATED_TO_DISCOUNT_CODE_BACK_TO_SCHOOL","active":true,"internal_name":"RELATED_TO_DISCOUNT_CODE_BACK_TO_SCHOOL","created_at":"2020-09-16T15:39:56Z","updated_at":"2020-09-16T15:39:56Z","rules":[{"type":"DISCOUNT_CODE","conditions":[{"type":"DISCOUNT_CODE","value":"BACK_TO_SCHOOL"}],"actions":[{"type":"PRICE_ADJUST_PERCENT","value":-10}]}],"product_selection":{"product_ids":["1234567890123","1234567890456"],"type":"PRODUCT_SEARCH"}}},{"code":"BLACKFRIDAY","updated_at":"2020-09-16T20:39:57.000000Z","created_at":"2020-09-16T20:39:57.000000Z","id":9,"ruleset":{"id":"21","external_id":"RELATED_TO_DISCOUNT_CODE_BLACKFRIDAY","active":true,"internal_name":"RELATED_TO_DISCOUNT_CODE_BLACKFRIDAY","created_at":"2020-09-16T15:39:57Z","updated_at":"2020-09-16T15:39:57Z","rules":[{"type":"DISCOUNT_CODE","conditions":[{"type":"DISCOUNT_CODE","value":"BLACKFRIDAY"}],"actions":[{"type":"PRICE_ADJUST_PERCENT","value":-10}]}],"product_selection":{"product_ids":["1234567890123","1234567890456"],"type":"PRODUCT_SEARCH"}}}]}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Unprocessable Entity (WebDAV)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"description":"Create one or more discount codes for the specified shop. This requires write_discount_codes scope/permission. Bold automatically assigns a `DISCOUNT_CODE` rule condition type to every discount code created.","tags":["Discount Codes"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"discount_code":{"$ref":"#/components/schemas/CreateDiscountCode"}},"required":["discount_code"]},"examples":{"body-example":{"value":{"discount_code":{"codes":["BACK_TO_SCHOOL","BLACKFRIDAY"],"limits":[{"limit_type":"per_shop","limit_amount":1000}],"product_selection":{"type":"PRODUCT_SEARCH","product_ids":["1234567890123","1234567890456"]},"conditions":[{"type":"CART_SUBTOTAL_MIN","value":5000}],"action":{"type":"PRICE_ADJUST_PERCENT","value":-10}}}}}}},"description":"Initial data needed to configure the new discount code(s)."}},"get":{"summary":"List Discount Codes","operationId":"ListDiscountCodes","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"The message contains the result of this operation."},"data":{"type":"object","properties":{"discount_codes":{"type":"array","items":{"$ref":"#/components/schemas/DiscountCode"}}}}}},"examples":{"200-response-example":{"value":{"message":"Successfully fetched discount codes","data":{"discount_codes":[{"id":18,"code":"BLACKFRIDAY","created_at":"2020-09-24T13:51:23.000000Z","updated_at":"2020-09-28T15:47:43.000000Z","ruleset":{"id":"51","external_id":"RELATED_TO_DISCOUNT_CODE_BLACKFRIDAY","active":true,"internal_name":"RELATED_TO_DISCOUNT_CODE_BLACKFRIDAY","created_at":"2020-09-28T10:47:43Z","updated_at":"2020-09-28T15:47:44Z","rules":[{"type":"DISCOUNT_CODE","conditions":[{"type":"DISCOUNT_CODE","value":"BLACKFRIDAY"}],"actions":[{"type":"PRICE_ADJUST_PERCENT","value":-10}]}],"product_selection":{"product_ids":["9876543210123","9876543210987"],"type":"PRODUCT_SEARCH"}}},{"id":20,"code":"SUPER_SALE_2020","created_at":"2020-09-28T21:21:37.000000Z","updated_at":"2020-09-28T21:21:37.000000Z","ruleset":{"id":"52","external_id":"RELATED_TO_DISCOUNT_CODE_SUPER_SALE_2020","active":true,"internal_name":"RELATED_TO_DISCOUNT_CODE_SUPER_SALE_2020","created_at":"2020-09-28T16:21:37Z","updated_at":"2020-09-28T21:21:38Z","rules":[{"type":"DISCOUNT_CODE","conditions":[{"type":"DISCOUNT_CODE","value":"SUPER_SALE_2020"}],"actions":[{"type":"PRICE_ADJUST_PERCENT","value":-15}]}],"product_selection":{"product_ids":["1234567890123","1234567890987"],"type":"PRODUCT_SEARCH"}}},{"id":21,"code":"1STORDERBONUS","created_at":"2020-09-28T21:21:37.000000Z","updated_at":"2020-09-28T21:21:37.000000Z","ruleset":{"id":"53","external_id":"RELATED_TO_DISCOUNT_CODE_1STORDERBONUS","active":true,"internal_name":"RELATED_TO_DISCOUNT_CODE_1STORDERBONUS","created_at":"2020-09-28T16:21:37Z","updated_at":"2020-09-28T21:21:38Z","rules":[{"type":"DISCOUNT_CODE","conditions":[{"type":"DISCOUNT_CODE","value":"1STORDERBONUS"}],"actions":[{"type":"PRICE_ADJUST_RELATIVE","value":-599}]}],"product_selection":{"product_ids":["9876543210123","9876543210987"],"type":"PRODUCT_SEARCH"}}}]},"pagination":{"total":3,"count":3,"per_page":50,"current_page":1,"total_pages":1}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Unprocessable Entity (WebDAV)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"description":"List all discount codes available for the specified shop. Requires the read_discount_codes scope/permission. Bold automatically assigns a `DISCOUNT_CODE` rule condition type to every discount code created.","tags":["Discount Codes"],"parameters":[{"schema":{"type":"integer"},"in":"query","name":"page","description":"The desired page number for the paginated result (default is 1)."},{"schema":{"type":"integer"},"in":"query","name":"limit","description":"Size of the page to be used for the paginated result (default is 50)."},{"schema":{"type":"string","enum":["ACTIVE","SCHEDULED","EXPIRED"]},"in":"query","name":"status","description":"Filter the results based on status"},{"schema":{"type":"string"},"in":"query","name":"name","description":"The name of the discount code"}]}},"/price_rules/rules/v2/shops/{shop_identifier}/discount_codes/{discount_code_id}":{"parameters":[{"schema":{"type":"string"},"name":"shop_identifier","in":"path","required":true,"description":"Bold platform identifier for the shop. Find this identifier using the [Get Shop Info](shops#operation/GetShopInfo) endpoint."},{"schema":{"type":"integer"},"name":"discount_code_id","in":"path","required":true,"description":"The discount code unique identifier in the database"}],"put":{"summary":"Update Discount Code","operationId":"UpdateDiscountCode","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"The message contains the result of this operation."},"data":{"type":"object","properties":{"discount_code":{"$ref":"#/components/schemas/DiscountCode"}}}}},"examples":{"200-response-example":{"value":{"message":"Discount code updated successfully!","data":{"discount_code":{"id":15,"code":"SOME_EXISTENT_DISCOUNT_CODE","created_at":"2020-09-22T20:39:39.000000Z","updated_at":"2020-09-23T18:54:46.000000Z","ruleset":{"id":"34","external_id":"RELATED_TO_DISCOUNT_CODE_SOME_EXISTENT_DISCOUNT_CODE","active":true,"internal_name":"RELATED_TO_DISCOUNT_CODE_SOME_EXISTENT_DISCOUNT_CODE","created_at":"2020-09-23T13:54:46Z","updated_at":"2020-09-23T13:54:46Z","rules":[{"type":"DISCOUNT_CODE","conditions":[{"type":"DISCOUNT_CODE","value":"SOME_EXISTENT_DISCOUNT_CODE"}],"actions":[{"type":"PRICE_ADJUST_RELATIVE","value":-15}]}],"product_selection":{"product_ids":["4567890123456","4567890987654"],"type":"PRODUCT_SEARCH"}}}}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Unprocessable Entity (WebDAV)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"description":"Update an existing discount code available for the specified shop. This requires write_discount_codes scope/permission.","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"discount_code":{"$ref":"#/components/schemas/UpdateDiscountCode"}},"required":["discount_code"]},"examples":{"body-example":{"value":{"discount_code":{"code":"SOME_EXISTENT_DISCOUNT_CODE","limit":{"limit_type":"per_customer","limit_amount":5},"product_selection":{"type":"PRODUCT_SEARCH","product_ids":["4567890123456","4567890987654"]},"action":{"type":"PRICE_ADJUST_RELATIVE","value":-15}}}}}}},"description":"Target values for the discount code after update; all fields should be passed, fields that are not intended to change should contain their current values."},"tags":["Discount Codes"]},"get":{"summary":"Get Discount Code by ID","operationId":"GetDiscountCodeByID","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"The message contains the result of this operation."},"data":{"type":"object","properties":{"discount_code":{"$ref":"#/components/schemas/DiscountCode"}}}}},"examples":{"200-response-example":{"value":{"message":"Successfully fetched discount code by id","data":{"discount_code":{"id":18,"code":"BLACKFRIDAY","created_at":"2020-09-24T13:51:23.000000Z","updated_at":"2020-09-25T21:27:14.000000Z","ruleset":{"id":"50","external_id":"RELATED_TO_DISCOUNT_CODE_BLACKFRIDAY","active":true,"internal_name":"RELATED_TO_DISCOUNT_CODE_BLACKFRIDAY","created_at":"2020-09-25T16:27:13Z","updated_at":"2020-09-25T16:27:13Z","rules":[{"type":"DISCOUNT_CODE","conditions":[{"type":"DISCOUNT_CODE","value":"BLACKFRIDAY"}],"actions":[{"type":"PRICE_ADJUST_PERCENT","value":-10}]}],"product_selection":{"product_ids":["1234567890123","1234567890987"],"type":"PRODUCT_SEARCH"}}}}}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Unprocessable Entity (WebDAV)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"description":"Return data for a specific discount code, selected by the discount code ID. This requires read_discount_codes scope/permission.","tags":["Discount Codes"]},"delete":{"summary":"Delete Discount Code","operationId":"DeleteDiscountCode","responses":{"204":{"description":"No Content"},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"tags":["Discount Codes"],"description":"Remove an existing discount code available for the specified shop. This requires write_discount_codes scope/permission."}},"/price_rules/rules/v2/shops/{shop_identifier}/rulesets/{ruleset_id}/discount_codes":{"parameters":[{"schema":{"type":"string"},"name":"shop_identifier","in":"path","required":true,"description":"Bold platform identifier for the shop. Find this identifier using the [Get Shop Info](shops#operation/GetShopInfo) endpoint."},{"schema":{"type":"string"},"name":"ruleset_id","in":"path","required":true,"description":"The database ID for the ruleset that describes the discount code behaviour."}],"get":{"summary":"Get Discount Code by Ruleset ID","operationId":"GetDiscountCodeByRulesetID","tags":["Discount Codes"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"The message contains the result of this operation."},"data":{"type":"object","properties":{"discount_code":{"$ref":"#/components/schemas/DiscountCode"}}}}},"examples":{"200-response-example":{"value":{"message":"Successfully fetched discount code for ruleset","data":{"discount_code":{"id":29,"code":"TOP_CLEARANCE_10%","created_at":"2020-09-29T20:28:31.000000Z","updated_at":"2020-09-29T20:34:26.000000Z","ruleset":{"id":"63","external_id":"RELATED_TO_DISCOUNT_CODE_TOP_CLEARANCE_10%","active":true,"internal_name":"RELATED_TO_DISCOUNT_CODE_TOP_CLEARANCE_10%","created_at":"2020-09-29T15:34:26Z","updated_at":"2020-09-29T20:34:27Z","rules":[{"type":"DISCOUNT_CODE","conditions":[{"type":"DISCOUNT_CODE","value":"TOP_CLEARANCE_10%"}],"actions":[{"type":"PRICE_ADJUST_PERCENT","value":-10}]}],"product_selection":{"product_ids":["9998887770123","9998887770456","9998887770789"],"type":"PRODUCT_SEARCH"}}}}}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Unprocessable Entity (WebDAV)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"description":"Return data for a specific discount code, selected by the related ruleset ID. This requires read_discount_codes scope/permission."}},"/price_rules/rules/v2/shops/{shop_identifier}/rulesets/eid/{external_id}/rules/eid/{rule_external_id}":{"parameters":[{"schema":{"type":"string"},"name":"shop_identifier","in":"path","required":true,"description":"Bold platform identifier for the shop. Find this identifier using the [Get Shop Info](shops#operation/GetShopInfo) endpoint."},{"schema":{"type":"string"},"name":"external_id","in":"path","required":true},{"schema":{"type":"string"},"name":"rule_external_id","in":"path","required":true}],"put":{"summary":"Update Rule by Ruleset EID and Rule EID","operationId":"UpdateRuleByRulesetEIDRuleEID","tags":["Rules"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"data":{"$ref":"#/components/schemas/RuleResponse"}}}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict"},"500":{"description":"Internal Server Error"}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"rule":{"$ref":"#/components/schemas/Rule"}},"required":["rule"]}}}},"description":"Update a Rule by using the Ruleset external_id and Rule external_id.\\n\\nRequires the check_write_rulesets_permission scope/permission."}},"/price_rules/rules/v2/shops/{shop_identifier}/rulesets/eid/{external_id}/rules/add":{"parameters":[{"schema":{"type":"string"},"name":"external_id","in":"path","required":true},{"schema":{"type":"string"},"name":"shop_identifier","in":"path","required":true,"description":"Bold platform identifier for the shop. Find this identifier using the [Get Shop Info](shops#operation/GetShopInfo) endpoint."}],"patch":{"summary":"Bulk Add Rules by Ruleset EID","operationId":"BulkAddRulesByRulesetEID","tags":["Rules"],"responses":{"200":{"description":"OK"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict"},"422":{"description":"Unprocessable Entity (WebDAV)"},"500":{"description":"Internal Server Error"}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"rules":{"type":"array","items":{"$ref":"#/components/schemas/Rule"}}},"required":["rules"]}}},"description":""},"description":"Bulk add Rules to a Ruleset."}},"/price_rules/rules/v2/shops/{shop_identifier}/rulesets/{ruleset_id}/rules/{rule_id}":{"parameters":[{"schema":{"type":"string"},"name":"shop_identifier","in":"path","required":true,"description":"Bold platform identifier for the shop. Find this identifier using the [Get Shop Info](shops#operation/GetShopInfo) endpoint."},{"schema":{"type":"string"},"name":"ruleset_id","in":"path","required":true},{"schema":{"type":"string"},"name":"rule_id","in":"path","required":true}],"put":{"summary":"Update Rule by Ruleset ID and Rule ID","operationId":"UpdateRuleByRulesetIDRuleID","tags":["Rules"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"data":{"$ref":"#/components/schemas/RuleResponse"}}}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict"},"500":{"description":"Internal Server Error"}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"rule":{"$ref":"#/components/schemas/Rule"}},"required":["rule"]}}}},"description":"Update a Rule by using the Ruleset id and Rule id.\\n\\nRequires the check_write_rulesets_permission scope/permission."},"delete":{"summary":"Remove Rule by Ruleset ID and Rule ID","operationId":"RemoveRuleByRulesetIDRuleID","responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"401-error-example":{"value":{"code":"string","message":"string","type":"string"}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"403-error-example":{"value":{"code":"string","message":"string","type":"string"}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"404-error-example":{"value":{"code":"string","message":"string","type":"string"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"description":"Remove one rule from a specific Ruleset. Requires the write_price_rulesets scope/permission.","tags":["Rules"]}},"/price_rules/rules/v2/shops/{shop_identifier}/rulesets/eid/{external_id}/rules/{rule_id}":{"parameters":[{"schema":{"type":"string"},"name":"shop_identifier","in":"path","required":true,"description":"Bold platform identifier for the shop. Find this identifier using the [Get Shop Info](shops#operation/GetShopInfo) endpoint."},{"schema":{"type":"string"},"name":"external_id","in":"path","required":true},{"schema":{"type":"string"},"name":"rule_id","in":"path","required":true}],"put":{"summary":"Update Rule by Ruleset EID and Rule ID","operationId":"UpdateRuleByRulesetEIDRuleID","tags":["Rules"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"data":{"$ref":"#/components/schemas/RuleResponse"}}}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict"},"500":{"description":"Internal Server Error"}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"rule":{"$ref":"#/components/schemas/Rule"}},"required":["rule"]}}}},"description":"Update a Rule by using the Ruleset external_id and Rule id.\\n\\nRequires the check_write_rulesets_permission scope/permission."},"delete":{"summary":"Delete Rule from Ruleset by Ruleset EID and Rule ID","operationId":"DeleteRuleFromRulesetByRulesetEIDRuleID","responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"example-1":{"value":{"code":"string","message":"string","type":"string"}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"description":"Remove one rule from a specific Ruleset. Requires the write_price_rulesets scope/permission.","tags":["Rules"]}},"/price_rules/rules/v2/shops/{shop_identifier}/rulesets/{ruleset_id}/rules/eid/{rule_external_id}":{"parameters":[{"schema":{"type":"string"},"name":"shop_identifier","in":"path","required":true,"description":"Bold platform identifier for the shop. Find this identifier using the [Get Shop Info](shops#operation/GetShopInfo) endpoint."},{"schema":{"type":"string"},"name":"ruleset_id","in":"path","required":true},{"schema":{"type":"string"},"name":"rule_external_id","in":"path","required":true}],"put":{"summary":"Update Rule by Ruleset ID and Rule EID","operationId":"UpdateRuleByRulesetIDRuleEID","tags":["Rules"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"data":{"$ref":"#/components/schemas/RuleResponse"}}}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict"},"500":{"description":"Internal Server Error"}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"rule":{"$ref":"#/components/schemas/Rule"}},"required":["rule"]}}}},"description":"Update a Rule by using the Ruleset id and Rule external_id.\\n\\nRequires the check_write_rulesets_permission scope/permission."}},"/price_rules/rules/v2/shops/{shop_identifier}/rulesets/{ruleset_id}/rules/add":{"parameters":[{"schema":{"type":"string"},"name":"shop_identifier","in":"path","required":true,"description":"Bold platform identifier for the shop. Find this identifier using the [Get Shop Info](shops#operation/GetShopInfo) endpoint."},{"schema":{"type":"string"},"name":"ruleset_id","in":"path","required":true}],"patch":{"summary":"Bulk Add Rules by Ruleset ID","operationId":"BulkAddRulesByRulesetID","tags":["Rules"],"responses":{"200":{"description":"OK"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"409":{"description":"Conflict"},"422":{"description":"Unprocessable Entity (WebDAV)"},"500":{"description":"Internal Server Error"}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"rules":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/Rule"}}},"required":["rules"]}}},"description":""},"description":"Bulk add Rules to a Ruleset."}},"/price_rules/rules/v2/shops/{shop_identifier}/rulesets/{ruleset_id}/rules":{"parameters":[{"schema":{"type":"string"},"name":"shop_identifier","in":"path","required":true,"description":"Bold platform identifier for the shop. Find this identifier using the [Get Shop Info](shops#operation/GetShopInfo) endpoint."},{"schema":{"type":"string"},"name":"ruleset_id","in":"path","required":true}],"get":{"summary":"List Rules by Ruleset ID","operationId":"ListRulesByRulesetID","tags":["Rules"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"data":{"type":"object","items":{"$ref":"#/components/schemas/RuleResponse"}},"pagination":{"$ref":"#/components/schemas/Pagination"}}},"examples":{"200-response-example":{"value":{"message":"Successfully fetched rules","data":[{"id":"number","external_id":"string","conditions":[{"value":5,"type":"QTY_BY_LINE","operator":"=","requiresPrepare":true}],"actions":[{"value":99,"type":"PRICE_ADJUST_ABSOLUTE"}]}],"pagination":{"total":2,"count":2,"per_page":50,"current_page":1,"total_pages":1}}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"404-error-example":{"value":{"code":"string","message":"Error with fetching rules with ruleset with id: 1234567","type":"string"}}}}}}},"description":"Returns all rules in a ruleset in a paginated format.","parameters":[{"schema":{"type":"string"},"in":"query","name":"page","description":"Page number, considering that the results could span for several pages. Default is 1."},{"schema":{"type":"string"},"in":"query","name":"limit","description":"Page size, considering that the results could span for several pages. Default is 50."}]}},"/price_rules/rules/v2/shops/{shop_identifier}/rulesets/eid/{external_id}/rules":{"parameters":[{"schema":{"type":"string"},"name":"shop_identifier","in":"path","required":true,"description":"Bold platform identifier for the shop. Find this identifier using the [Get Shop Info](shops#operation/GetShopInfo) endpoint."},{"schema":{"type":"string"},"name":"external_id","in":"path","required":true}],"get":{"summary":"List Rules by Ruleset External ID","operationId":"ListRulesByRulesetExternalID","tags":["Rules"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"data":{"type":"object","items":{"$ref":"#/components/schemas/RuleResponse"}},"pagination":{"$ref":"#/components/schemas/Pagination"}}}}}}},"description":"Returns all rules in a ruleset in a paginated format.","parameters":[{"schema":{"type":"string"},"in":"query","name":"page","description":"Page number, considering that the results could span for several pages. Default is 1."},{"schema":{"type":"string"},"in":"query","name":"limit","description":"Page size, considering that the results could span for several pages. Default is 50."}]}},"/price_rules/rules/v2/shops/{shop_identifier}/discount_codes/{discount_code_id}/activate":{"parameters":[{"schema":{"type":"string"},"name":"shop_identifier","in":"path","required":true,"description":"Bold platform identifier for the shop. Find this identifier using the [Get Shop Info](shops#operation/GetShopInfo) endpoint."},{"schema":{"type":"string"},"name":"discount_code_id","in":"path","required":true}],"patch":{"summary":"Activate Discount Code","operationId":"ActivateDiscountCode","tags":["Discount Codes"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"The message contains the result of this operation."},"data":{"type":"object","properties":{"discount_code":{"$ref":"#/components/schemas/DiscountCode"}}}}},"examples":{"200-response-example":{"value":{"message":"Successfully activated discount code","data":{"discount_code":{"id":197,"code":"efijo","created_at":"2021-02-03T16:11:07.000000Z","updated_at":"2021-02-05T16:32:46.000000Z","ruleset":{"id":"272","external_id":"RELATED_TO_DISCOUNT_CODE_efijo","shop_id":9,"app_slug":"pdc-shopify","active":true,"internal_name":"RELATED_TO_DISCOUNT_CODE_efijo","public_name":"","rule_set_data":"{\\"rules\\":[{\\"type\\":\\"DISCOUNT_CODE\\",\\"conditions\\":[{\\"type\\":\\"DISCOUNT_CODE\\",\\"value\\":\\"efijo\\"}],\\"actions\\":[{\\"type\\":\\"PRICE_ADJUST_PERCENT\\",\\"value\\":50}]}]}","start_date":"2021-02-03T16:11:07.000000Z","expiry_date":"2021-02-03T16:11:07.000000Z","sync_percent":100,"priority":0,"selection_type":1,"selection_data":"{\\"product_ids\\":[\\"5809048617123\\",\\"5809050615971\\"]}","created_at":"2021-02-03T16:11:07.000000Z","updated_at":"2021-02-03T16:11:07.000000Z"},"limits":[]}}}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Unprocessable Entity (WebDAV)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"description":"Updates the `start_date` to be `now()`, and will update the `expiry_date` if it is in the past. Returns the data for the updated discount code. This requires write_discount_codes scope/permission."}},"/price_rules/rules/v2/shops/{shop_identifier}/discount_codes/{discount_code_id}/deactivate":{"parameters":[{"schema":{"type":"string"},"name":"shop_identifier","in":"path","required":true,"description":"Bold platform identifier for the shop. Find this identifier using the [Get Shop Info](shops#operation/GetShopInfo) endpoint."},{"schema":{"type":"string"},"name":"discount_code_id","in":"path","required":true}],"patch":{"summary":"Deactivate Discount Code","operationId":"DeactivateDiscountCode","tags":["Discount Codes"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"The message contains the result of this operation."},"data":{"type":"object","properties":{"discount_code":{"$ref":"#/components/schemas/DiscountCode"}}}}},"examples":{"200-response-example":{"value":{"message":"Successfully deactivated discount code","data":{"discount_code":{"id":197,"code":"efijo","created_at":"2021-02-03T16:11:07.000000Z","updated_at":"2021-02-05T16:32:46.000000Z","ruleset":{"id":"272","external_id":"RELATED_TO_DISCOUNT_CODE_efijo","shop_id":9,"app_slug":"pdc-shopify","active":true,"internal_name":"RELATED_TO_DISCOUNT_CODE_efijo","public_name":"","rule_set_data":"{\\"rules\\":[{\\"type\\":\\"DISCOUNT_CODE\\",\\"conditions\\":[{\\"type\\":\\"DISCOUNT_CODE\\",\\"value\\":\\"efijo\\"}],\\"actions\\":[{\\"type\\":\\"PRICE_ADJUST_PERCENT\\",\\"value\\":50}]}]}","start_date":"2021-02-03T16:11:07.000000Z","expiry_date":"2021-02-03T16:11:07.000000Z","sync_percent":100,"priority":0,"selection_type":1,"selection_data":"{\\"product_ids\\":[\\"5809048617123\\",\\"5809050615971\\"]}","created_at":"2021-02-03T16:11:07.000000Z","updated_at":"2021-02-03T16:11:07.000000Z"},"limits":[]}}}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Unprocessable Entity (WebDAV)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"description":"Updates the `expiry_date` to be `now()`. Returns the data for the updated discount code. This requires write_discount_codes scope/permission."}},"/price_rules/storefront/v2/shops/{shop_domain}/order_condition":{"parameters":[{"schema":{"type":"string"},"name":"shop_domain","in":"path","required":true}],"post":{"summary":"List Eligible Order Conditions for Shop","operationId":"ListEligibleOrderConditionsForShop","tags":["Order Conditions"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","enum":["Successfully applied order condition to shop"]},"data":{"type":"object","properties":{"order_condition":{"type":"array","description":"array of order condition key value pair","items":{}}}}}},"examples":{"example-1":{"value":{"message":"Successfully applied order condition to shop","data":{"order_condition":{"location":"Vancouver"}}}}}}}}},"description":"Tests order conditions against shop and customer data, and returns the condition names and values that match. Requires no special permissions/scopes.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"customer":{"$ref":"#/components/schemas/OrderConditionCustomerSchema"}}},"examples":{"example-1":{"value":{"customer":{"shipping":{"postal_code":"string","country":"string","country_code":"string","province":"string","province_code":"string"}}}}}}}}}}},"components":{"securitySchemes":{"OAuthToken":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://apps.boldapps.net/accounts/dashboard/authorize","tokenUrl":"https://api.boldcommerce.com/auth/oauth2/token","scopes":{}}},"description":"Authenticates an API request from a [public integration](/guides/price-rules/resources/glossary#public-integration). Generate this token in the [Developer Dashboard](https://developer-dashboard.boldcommerce.com/default/dashboard). Refer to [Build Public Integrations](/guides/checkout/public-integrations) for more information."},"APIAccessToken":{"type":"apiKey","name":"API Access Token","in":"header","description":"Authenticates an API request from a [private integration](/guides/price-rules/resources/glossary#private-integration). Generate this token in the [Bold Account Center](https://account.boldcommerce.com/). Refer to [Making API Calls](/guides/checkout/quick-start) for more information."}},"schemas":{"Ruleset":{"title":"Ruleset","type":"object","description":"A set of rules that can apply to a defined group of products, depending on the rule conditions being met. This more complete type refers to all the fields that can be obtained when getting one or more rulesets.","properties":{"id":{"description":"Ruleset database ID.","type":"integer"},"product_selection":{"type":"object","description":"IDs, vendors or product titles used to filter where the ruleset applies, along with the specific platform filter type.","properties":{"titles":{"type":"array","description":"List of all product titles that might be affected by the ruleset.","items":{"type":"string"}},"collection_ids":{"type":"array","description":"List of platform collection IDs that might be affected by the ruleset.","items":{"type":"string"}},"variant_ids":{"type":"array","description":"List of platform variant IDs that might be affected by the ruleset.","items":{"type":"string"}},"product_ids":{"type":"array","description":"List of platform product IDs that might be affected by the ruleset.","items":{"type":"string"}},"vendors":{"type":"array","description":"List of all vendors whose products might be affected by the ruleset.","items":{"type":"string"}},"product_types":{"type":"string"},"sku_ids":{"type":"array","description":"List of all SKUs that might be affected by the ruleset.","items":{"type":"string"}},"type":{"type":"string","enum":["SHOPIFY_PRODUCT_SEARCH","SHOPIFY_PRODUCTS_ALL","PRODUCT_SEARCH","PRODUCTS_ALL"]}}},"rules":{"type":"array","description":"Each one of the rules contained in this ruleset.","items":{"$ref":"#/components/schemas/Rule"}},"updated_at":{"type":"string","description":"If the ruleset was altered, this will be the most recent date in which any changes occurred.","format":"date-time","nullable":true},"created_at":{"type":"string","description":"Ruleset creation date.","format":"date-time"},"priority":{"type":"number","description":"Defines the priority of this ruleset above other rulesets that belong to the same app."},"sync_percent":{"type":"integer","minimum":0,"maximum":100,"description":"Described the current percentage of the process that synchronizes this ruleset with the shop. Should be set to zero when the rule is created/altered."},"expiry_date":{"type":"string","description":"Date from which the ruleset will stop being effective.","format":"date-time","nullable":true},"start_date":{"type":"string","description":"Date from which the ruleset should be considered effective.","format":"date-time","nullable":true},"public_name":{"type":"string","description":"A public facing name for the ruleset."},"internal_name":{"type":"string","description":"If the ruleset was created by an external app, this is the app name for the ruleset."},"active":{"type":"boolean","description":"Indicates if this ruleset is currently active."},"external_id":{"type":"string","description":"If the ruleset was created by an external app, the external_id will be set as the app identifier for the ruleset."},"app_slug":{"type":"string","description":"Name or identifier of the app that owns the ruleset. For private operations this is ommited, since the app is implicit (and it is directly related to the auth token)."}},"required":["rules","active"]},"Rule":{"type":"object","title":"Rule","description":"Comprised by one or more actions that can alter the price or the storefront in general, and a set of zero or more conditions that must be met for the rule to be applied. ","additionalProperties":false,"properties":{"type":{"type":"string","enum":["DISCOUNT","DISCOUNT_CODE","DISCOUNTABLE_ADDITION","ADDITION","STACKABLE_DISCOUNT","ROUNDING","DISPLAY","SETTING","BUNDLE","REF_URL","LINE_ITEM_PROPERTY","CUSTOMER_PROVINCE","CUSTOMER_GROUP","QTY_BY_MIX_AND_MATCH","QTY_BY_PRODUCT","QTY_BY_VARIANT","QTY_BY_LINE","SUBSCRIPTION_GROUP","SUBSCRIPTION_INTERVAL"],"description":"The rule type defines how the rule is applied in parallel with other rules, and also how it should behave."},"conditions":{"type":"array","description":"One or more conditions that need to be matched for the rule to apply.","items":{"anyOf":[{"$ref":"#/components/schemas/ConditionBuyXGetYDiscountCode"},{"$ref":"#/components/schemas/ConditionCartSubtotalMin"},{"$ref":"#/components/schemas/ConditionCurrency"},{"$ref":"#/components/schemas/ConditionCustomerCountry"},{"$ref":"#/components/schemas/ConditionCustomerGroup"},{"$ref":"#/components/schemas/ConditionCustomerId"},{"$ref":"#/components/schemas/ConditionCustomerInAnyGroupFromList"},{"$ref":"#/components/schemas/ConditionCustomerProvince"},{"$ref":"#/components/schemas/ConditionLineItemProperty"},{"$ref":"#/components/schemas/ConditionQtyByBundle"},{"$ref":"#/components/schemas/ConditionQtyByLine"},{"$ref":"#/components/schemas/ConditionQtyByMixAndMatch"},{"$ref":"#/components/schemas/ConditionQtyByProduct"},{"$ref":"#/components/schemas/ConditionQtyByVariant"},{"$ref":"#/components/schemas/ConditionQtyOnCart"},{"$ref":"#/components/schemas/ConditionRefUrl"},{"$ref":"#/components/schemas/ConditionShippingRateRange"},{"$ref":"#/components/schemas/ConditionSubscriptionGroup"},{"$ref":"#/components/schemas/ConditionSubscriptionInterval"},{"$ref":"#/components/schemas/ConditionCurrency"},{"$ref":"#/components/schemas/ConditionOrderCondition"},{"$ref":"#/components/schemas/ConditionCartSubtotalMin"}],"discriminator":{"propertyName":"type","mapping":{"BUY_X_GET_Y_DISCOUNT_CODE":"#/components/schemas/ConditionBuyXGetYDiscountCode","CART_SUBTOTAL_MIN":"#/components/schemas/ConditionCartSubtotalMin","CURRENCY":"#/components/schemas/ConditionCurrency","CUSTOMER_COUNTRY":"#/components/schemas/ConditionCustomerCountry","CUSTOMER_GROUP":"#/components/schemas/ConditionCustomerGroup","CUSTOMER_ID":"#/components/schemas/ConditionCustomerId","CUSTOMER_IN_ANY_GROUP_FROM_LIST":"#/components/schemas/ConditionCustomerInAnyGroupFromList","CUSTOMER_PROVINCE":"#/components/schemas/ConditionCustomerProvince","LINE_ITEM_PROPERTY":"#/components/schemas/ConditionLineItemProperty","BUNDLE":"#/components/schemas/ConditionQtyByBundle","QTY_BY_LINE":"#/components/schemas/ConditionQtyByLine","QTY_BY_MIX_AND_MATCH":"#/components/schemas/ConditionQtyByMixAndMatch","QTY_BY_PRODUCT":"#/components/schemas/ConditionQtyByProduct","QTY_BY_VARIANT":"#/components/schemas/ConditionQtyByVariant","QTY_ON_CART":"#/components/schemas/ConditionQtyOnCart","REF_URL":"#/components/schemas/ConditionRefUrl","SHIPPING_RATE_RANGE":"#/components/schemas/ConditionShippingRateRange","SUBSCRIPTION_GROUP":"#/components/schemas/ConditionSubscriptionGroup","SUBSCRIPTION_INTERVAL":"#/components/schemas/ConditionSubscriptionInterval"}}}},"actions":{"type":"array","minItems":1,"items":{"anyOf":[{"$ref":"#/components/schemas/ActionPriceAdjustAbsolute"},{"$ref":"#/components/schemas/ActionPriceAdjustRelative"},{"$ref":"#/components/schemas/ActionPriceAdjustPercent"},{"$ref":"#/components/schemas/ActionPriceAdjustAbsoluteWithLimit"},{"$ref":"#/components/schemas/ActionPriceAdjustRelativeWithLimit"},{"$ref":"#/components/schemas/ActionCharmPrice"},{"$ref":"#/components/schemas/ActionAdjustRate"},{"$ref":"#/components/schemas/ActionAddFee"},{"$ref":"#/components/schemas/ActionDisplayQtyBreak"},{"$ref":"#/components/schemas/ActionCustomerDraftOrderTaxable"},{"$ref":"#/components/schemas/ActionPriceAdjustAbsoluteBasePrice"}],"discriminator":{"propertyName":"type","mapping":{"PRICE_ADJUST_ABSOLUTE":"#/components/schemas/ActionPriceAdjustAbsolute","PRICE_ADJUST_RELATIVE":"#/components/schemas/ActionPriceAdjustRelative","PRICE_ADJUST_PERCENT":"#/components/schemas/ActionPriceAdjustPercent","PRICE_ADJUST_ABSOLUTE_WITH_LIMIT":"#/components/schemas/ActionPriceAdjustAbsoluteWithLimit","PRICE_ADJUST_RELATIVE_WITH_LIMIT":"#/components/schemas/ActionPriceAdjustRelativeWithLimit","PRICE_ADJUST_ABSOLUTE_BASE_PRICE":"#/components/schemas/ActionPriceAdjustAbsoluteBasePrice","CHARM_PRICE":"#/components/schemas/ActionCharmPrice","PRICE_ADJUST_RATE":"#/components/schemas/ActionAdjustRate","ADD_FEE":"#/components/schemas/ActionAddFee","DISPLAY_QTY_BREAK":"#/components/schemas/ActionDisplayQtyBreak","CUSTOMER_DRAFT_ORDER_TAXABLE":"#/components/schemas/ActionCustomerDraftOrderTaxable"}}}},"meta":{"type":"object"},"external_id":{"type":"string"},"priority":{"type":"number","description":"Defines the priority of a Rule, 0 is default and highest"},"stack_order":{"type":"number"},"id":{"type":"number"}},"required":["type"]},"ActionPriceAdjustAbsolute":{"type":"object","additionalProperties":false,"properties":{"value":{"type":"integer","example":99},"type":{"type":"string","enum":["PRICE_ADJUST_ABSOLUTE"]}},"required":["value","type"]},"ActionPriceAdjustRelative":{"type":"object","additionalProperties":false,"properties":{"value":{"type":"integer","example":299},"type":{"type":"string","enum":["PRICE_ADJUST_RELATIVE"]}},"required":["value","type"]},"ActionPriceAdjustPercent":{"type":"object","additionalProperties":false,"properties":{"value":{"type":"number","example":299},"type":{"type":"string","enum":["PRICE_ADJUST_PERCENT"]}},"required":["value","type"]},"ActionPriceAdjustAbsoluteWithLimit":{"type":"object","additionalProperties":false,"properties":{"value":{"type":"integer","example":299},"type":{"type":"string","enum":["PRICE_ADJUST_ABSOLUTE_WITH_LIMIT"]},"limit":{"type":"integer","default":1},"limit_scope":{"type":"string","enum":["product","variant","lineitem"],"default":"variant"}},"required":["value","type"],"title":""},"ActionPriceAdjustRelativeWithLimit":{"type":"object","additionalProperties":false,"properties":{"value":{"type":"integer","example":299},"type":{"type":"string","enum":["PRICE_ADJUST_RELATIVE_WITH_LIMIT"]},"limit":{"type":"integer"},"limit_scope":{"type":"string","enum":["product","variant","lineitem"],"default":"variant"}},"required":["value","type"]},"ActionCharmPrice":{"type":"object","additionalProperties":false,"properties":{"value":{"type":"integer","example":99},"type":{"type":"string","enum":["CHARM_PRICE"]}},"required":["value","type"]},"ActionAddFee":{"type":"object","additionalProperties":false,"properties":{"value":{"type":"integer","example":299},"type":{"type":"string","enum":["ADD_FEE"]},"province":{"type":"string","enum":["NL","PE","NS","NB","QC","QN","MB","SK","AB","BC","YT","NT","NU"],"description":"This functionality is not supported."},"display_inline":{"type":"boolean","description":"This functionality is not supported."},"name":{"type":"string"}},"required":["value","type"]},"BestProductPriceItem":{"title":"BestProductPriceItem","type":"object","properties":{"price":{"type":"integer"},"id":{"type":"string"},"quantity":{"type":"integer"}}},"ActionDisplayQtyBreak":{"type":"object","minProperties":3,"additionalProperties":false,"properties":{"type":{"type":"string","enum":["DISPLAY_QTY_BREAK"]},"qty":{"type":"integer"},"percent":{"type":"integer","minimum":0,"maximum":100,"example":15},"price":{"type":"integer"},"saved":{"type":"integer","default":0,"example":299}},"required":["type"]},"ActionCustomerDraftOrderTaxable":{"type":"object","additionalProperties":false,"properties":{"value":{"type":"boolean","example":true},"type":{"type":"string","enum":["CUSTOMER_DRAFT_ORDER_TAXABLE"]}},"required":["value","type"]},"ConditionOrderCondition":{"type":"object","additionalProperties":false,"properties":{"type":{"type":"string","enum":["ORDER_CONDITION"]},"name":{"type":"string","example":"order_condition_by_country"},"value":{"type":"string","example":"order_condition_canada"}},"required":["type","name","value"]},"ConditionQtyByLine":{"type":"object","additionalProperties":false,"properties":{"value":{"type":"integer","example":5},"type":{"type":"string","enum":["QTY_BY_LINE"]},"operator":{"type":"string","default":"=","enum":["=","!=","<",">","<=",">="],"example":"="},"requiresPrepare":{"type":"boolean","example":true}},"required":["value","type","operator"]},"ConditionQtyByVariant":{"type":"object","additionalProperties":false,"properties":{"value":{"type":"integer","example":5},"type":{"type":"string","enum":["QTY_BY_VARIANT"]},"operator":{"type":"string","default":"=","enum":["=","!=","<",">","<=",">="],"example":"="},"requiresPrepare":{"type":"boolean","example":true}},"required":["value","type","operator"]},"ConditionQtyByProduct":{"type":"object","additionalProperties":false,"properties":{"value":{"type":"integer","example":5},"type":{"type":"string","enum":["QTY_BY_PRODUCT"]},"operator":{"default":"=","type":"string","enum":["=","!=","<",">","<=",">="],"example":"=","description":""},"requiresPrepare":{"type":"boolean","example":true}},"required":["value","type","operator"]},"ConditionQtyByMixAndMatch":{"type":"object","additionalProperties":false,"properties":{"value":{"type":"integer","example":5},"type":{"type":"string","enum":["QTY_BY_MIX_AND_MATCH"]},"operator":{"type":"string","default":"=","enum":["=","!=","<",">","<=",">="],"example":"="},"label":{"type":"string","example":"sample"}},"required":["value","type","operator","label"]},"ConditionCustomerGroup":{"type":"object","additionalProperties":false,"properties":{"value":{"type":"string","example":"wholesale"},"type":{"type":"string","enum":["CUSTOMER_GROUP"]}},"required":["value","type"]},"ConditionSubscriptionGroup":{"type":"object","additionalProperties":false,"properties":{"value":{"type":"number","example":123},"type":{"type":"string","enum":["SUBSCRIPTION_GROUP"]}},"required":["value","type"]},"ConditionSubscriptionInterval":{"type":"object","additionalProperties":false,"properties":{"value":{"type":"number","example":6},"type":{"type":"string","enum":["SUBSCRIPTION_INTERVAL"]}},"required":["value","type"]},"ConditionCustomerProvince":{"type":"object","additionalProperties":false,"properties":{"value":{"type":"string","example":"manitoba"},"type":{"type":"string","enum":["CUSTOMER_PROVINCE"]}},"required":["value","type"]},"ConditionLineItemProperty":{"type":"object","additionalProperties":false,"properties":{"value":{"type":"integer","example":49},"type":{"type":"string","enum":["LINE_ITEM_PROPERTY"]},"name":{"type":"string","example":"price_rules"},"operator":{"type":"string","default":"=","enum":["=","!=","<",">","<=",">="],"example":"="}},"required":["value","type","name","operator"]},"ConditionRefUrl":{"type":"object","additionalProperties":false,"properties":{"value":{"type":"string","example":"https://store.myshopify.com"},"type":{"type":"string","enum":["REF_URL"]}},"required":["value","type"]},"ConditionQtyByBundle":{"type":"object","additionalProperties":false,"properties":{"value":{"type":"object","additionalProperties":{"type":"integer"}},"type":{"type":"string","enum":["BUNDLE"]},"operator":{"type":"string","default":"=","enum":["=","!=","<",">","<=",">="],"example":"="},"name":{"type":"string","example":"price_rules"},"values":{"type":"array","items":{}}},"required":["value","type","operator","name","values"]},"Error":{"title":"Error","type":"object","properties":{"code":{"type":"string","description":"Unique identifier for this error"},"message":{"type":"string","description":"Error details"},"type":{"type":"string","description":"Error category"}},"required":["code","message"],"description":"Extra information that is returned in case of an HTTP error."},"BasicRuleset":{"title":"BasicRuleset","type":"object","description":"A set of rules that can apply to a defined group of products, depending on the rule conditions being met. The basic ruleset type refers to the fields that should be passed when creating or updating a ruleset.","properties":{"external_id":{"type":"string","description":"If the ruleset was created by an external app, the external_id will be set as the app identifier for the ruleset."},"internal_name":{"type":"string","description":"If the ruleset was created by an external app, this is the app name for the ruleset."},"start_date":{"type":"string","description":"Date from which the ruleset should be considered effective.","format":"date-time","nullable":true},"expiry_date":{"type":"string","description":"Date from which the ruleset will stop being effective.","format":"date-time","nullable":true},"priority":{"type":"number","description":"Defines the priority of this ruleset above other rulesets that belong to the same app."},"rules":{"type":"array","description":"Each one of the rules contained in this ruleset.","items":{"$ref":"#/components/schemas/Rule"}},"product_selection":{"type":"object","description":"IDs, vendors or product titles used to filter where the ruleset applies, along with the specific platform filter type.","properties":{"titles":{"type":"array","description":"List of all product titles that might be affected by the ruleset.","items":{"type":"string"}},"collection_ids":{"type":"array","description":"List of platform collection IDs that might be affected by the ruleset.","items":{"type":"string"}},"variant_ids":{"type":"array","description":"List of platform variant IDs that might be affected by the ruleset.","items":{"type":"string"}},"product_ids":{"type":"array","description":"List of platform product IDs that might be affected by the ruleset.","items":{"type":"string"}},"vendors":{"type":"array","description":"List of all vendors whose products might be affected by the ruleset.","items":{"type":"string"}},"product_types":{"type":"string"},"sku_ids":{"type":"string"},"type":{"type":"string","enum":["SHOPIFY_PRODUCT_SEARCH","SHOPIFY_PRODUCTS_ALL","PRODUCT_SEARCH","PRODUCTS_ALL"]}}}}},"Pagination":{"title":"Pagination","type":"object","properties":{"total":{"type":"integer","description":"How many results are available in the database."},"count":{"type":"integer","description":"How many results were brought by this search."},"per_page":{"type":"integer","description":"Amount of results per page."},"current_page":{"type":"integer","description":"If the results span several pages, this contains the current page number."},"total_pages":{"type":"integer","description":"How many pages are needed to present all the results in the database."}},"description":"This object describes basic pagination info, and it is used associated with search results that can span for several pages."},"ShopOptions":{"title":"ShopOptions","type":"object","properties":{"compare_at_price_as_original":{"type":"boolean"},"verbose_logs":{"type":"boolean"},"include_base_prices":{"type":"boolean"}},"description":"Specific configurations related to the shop that can affect how information is presented or how rules are processed."},"BasePrice":{"title":"BasePrice","type":"object","properties":{"id":{"type":"number","description":"The variant ID to which the price applies."},"price":{"type":"number","description":"The original or unaltered price of the variant."}},"description":"Basic price information for variants, before any discounts were applied."},"OrderCondition":{"title":"Order Condition","type":"object","description":"An Order Condition can be used to group shopping experiences under specific categories, and then use those categories to apply price changes. For example, the shipping address used by each customer could place it in a collection of DELIVERY_ZONE conditions, with different possible values that would define different discounts.","properties":{"name":{"type":"string","description":"The name of the Order Condition."},"value":{"type":"string","description":"The value of the Order Condition."},"operator":{"$ref":"#/components/schemas/Operator"},"type":{"type":"string","description":"Specifies the `type` the `operator` must match with for this condition. Eg. \\"operator: \'ONE_OF\'\\", \\"type:\'FIELD_SET`\\" means that this condition applies if one field_set matches."},"field_sets":{"type":"array","description":"All the different combinations of fields and values that match the Order Condition. For example, all the sets of country + city + postal code that are included in the \'DELIVERY_ZONE: NorthAmerica\' condition.","items":{"$ref":"#/components/schemas/FieldSet"}}},"required":["name","value","operator","type"]},"Operator":{"title":"Operator","type":"string","description":"Defines the relationship of the Order Condition. Eg \'ONE_OF\'."},"FieldSet":{"title":"FieldSet","type":"object","description":"A FieldSet is a combination of fields and values that match for a specific Order Condition. For example, a set of values for country + city + postal code that match the \'DELIVERY_ZONE: NorthAmerica\' condition.","x-examples":{"example-1":{"name":"ZONE","value":"Prairies","operator":"ONE_OF","type":"FIELD_SET","field_sets":[{"field_set_id":9,"customer.shipping.country":"Canada","customer.shipping.postal_code":"R3Y0L6"},{"field_set_id":10,"customer.shipping.country":"Canada","customer.shipping.postal_code":"R3T5Y3"}]}},"properties":{"field_set_id":{"type":"number","description":"The ID of the FieldSet."},"customer.shipping.country":{"type":"string","description":"Eg. \\"Canada\\"."},"customer.shipping.country_code":{"type":"string","description":"Eg \\"CA\\"."},"customer.shipping.postal_code":{"type":"string","description":"Eg. \\"R3Y0L6\\"."},"customer.shipping.province":{"type":"string","description":"Eg \\"Manitoba\\"."},"customer.shipping.province_code":{"type":"string","description":"Eg. \\"MB\\"."}}},"CreateDiscountCode":{"title":"CreateDiscountCode","type":"object","additionalProperties":false,"description":"Payload to create one or more discount codes from scratch.","properties":{"codes":{"type":"array","description":"List of discount code names that should be created sharing this same configuration.","items":{"type":"string"}},"conditions":{"type":"array","description":"Extra requirements for the discount code to be considered eligible. This is an optional field.","items":{"anyOf":[{"$ref":"#/components/schemas/ConditionCartSubtotalMin"},{"$ref":"#/components/schemas/ConditionShippingRateRange"},{"$ref":"#/components/schemas/ConditionQtyOnCart"},{"$ref":"#/components/schemas/ConditionCustomerInAnyGroupFromList"},{"$ref":"#/components/schemas/ConditionCustomerCountry"},{"$ref":"#/components/schemas/ConditionBuyXGetYDiscountCode"}]}},"action":{"oneOf":[{"$ref":"#/components/schemas/ActionPriceAdjustRelative"},{"$ref":"#/components/schemas/ActionPriceAdjustPercent"},{"$ref":"#/components/schemas/ActionFreeShipping"},{"$ref":"#/components/schemas/ActionShippingAdjustRelative"},{"$ref":"#/components/schemas/ActionShippingAdjustPercent"},{"$ref":"#/components/schemas/ActionCartAdjustRelative"},{"$ref":"#/components/schemas/ActionCartAdjustPercent"}]},"product_selection":{"oneOf":[{"$ref":"#/components/schemas/DiscountCodeProductSelection"},{"$ref":"#/components/schemas/DiscountCodeVariantSelection"},{"$ref":"#/components/schemas/DiscountCodeAllSelection"},{"$ref":"#/components/schemas/DiscountCodeCollectionSelection"},{"$ref":"#/components/schemas/DiscountCodeSKUSelection"}]},"start_date":{"type":"string","format":"date-time","description":"Date from which the discount code should be considered valid (optional)."},"expiry_date":{"type":"string","format":"date-time","description":"Date from which the discount code should be considered expired/invalid (optional)."},"restrict_by_emails":{"type":"array","maxItems":50,"description":"This optional field can be used to make the discount code valid only for certain customers (defined by their email addresses).","items":{"type":"string"}},"limits":{"type":"array","description":"If a discount code can be used only a limited amount of times (per customer, or in the entire shop) those optional limits can be defined here.","items":{"$ref":"#/components/schemas/UsageLimit"}},"raw_product_selection":{"$ref":"#/components/schemas/DiscountCodeRawProductSelection"},"raw_reward_product_selection":{"$ref":"#/components/schemas/DiscountCodeRawProductSelection"}},"required":["codes","action","product_selection"]},"DiscountCodeProductSelection":{"title":"DiscountCodeProductSelection","type":"object","description":"Expression to filter which products should be eligible for a discount code.","additionalProperties":false,"properties":{"type":{"type":"string","enum":["PRODUCT_SEARCH","PRODUCTS_EXCEPT"],"description":"The type of selection; the discount code can be applicable to specific products/variants or to the entire store."},"product_ids":{"type":"array","description":"List of product ids eligible for the discount code.","items":{"type":"string"}}},"required":["type","product_ids"]},"DiscountCodeVariantSelection":{"title":"DiscountCodeVariantSelection","type":"object","additionalProperties":false,"description":"Expression to filter which variants should be eligible for a discount code.","properties":{"type":{"type":"string","description":"The type of selection; the discount code can be applicable to specific products/variants or to the entire store.","enum":["PRODUCT_SEARCH","PRODUCTS_EXCEPT"]},"variant_ids":{"type":"array","description":"List of variant ids eligible for the discount code.","items":{"type":"string"}}},"required":["type","variant_ids"]},"DiscountCode":{"title":"DiscountCode","type":"object","additionalProperties":false,"description":"A set of fields that describes the behaviour of a discount code, where it applies and how it affects the product prices.","properties":{"id":{"type":"integer"},"code":{"type":"string","description":"The discount code name (to be used during checkout)."},"discount_summary":{"type":"string","description":"The discount code summary."},"is_active":{"type":"string","format":"date-time","description":""},"start_date":{"nullable":true,"type":"string","format":"date-time","description":"Start date when the discount code shall be available for use."},"expiry_date":{"nullable":true,"type":"string","format":"date-time","description":"Date when the discount code expires."},"created_at":{"type":"string","format":"date-time","description":"Date when the discount code was originally created."},"updated_at":{"type":"string","format":"date-time","description":"Date when the discount code was last updated."},"restrict_by_emails":{"type":"array","description":"This optional field informs when the discount code is valid only for certain customers (defined by their email addresses).","items":{"type":"string"}},"ruleset":{"$ref":"#/components/schemas/DiscountCodeRuleset"},"limits":{"type":"array","description":"If the discount code usage limits (for example, it can be used just one time per customer) these limits will be listed in this field.","items":{"$ref":"#/components/schemas/UsageLimit"}},"product_selection":{"$ref":"#/components/schemas/DiscountCodeRawProductSelection"},"reward_product_selection":{"$ref":"#/components/schemas/DiscountCodeRawProductSelection"}}},"UsageLimit":{"title":"UsageLimit","type":"object","description":"If a discount code has usage limits, this object will describe those limits.","properties":{"limit_type":{"type":"string","enum":["per_customer","per_shop"],"description":"When a discount code has a usage limit, the limit can be applied per customer or for the entire shop."},"limit_amount":{"type":"integer","description":"This describes the maximum amount of allowed usages for a limited discount code.","minimum":1}},"required":["limit_type","limit_amount"],"additionalProperties":false},"UpdateDiscountCode":{"title":"UpdateDiscountCode","type":"object","description":"Payload to update an existing discount code.","additionalProperties":false,"properties":{"code":{"type":"string","description":"The discount code name (to be used during checkout). When updating, you don\'t need to provide the code unless you are changing it."},"conditions":{"type":"array","description":"Extra requirements for the discount code to be considered eligible. This is an optional field.","items":{"anyOf":[{"$ref":"#/components/schemas/ConditionCartSubtotalMin"},{"$ref":"#/components/schemas/ConditionShippingRateRange"},{"$ref":"#/components/schemas/ConditionQtyOnCart"},{"$ref":"#/components/schemas/ConditionCustomerInAnyGroupFromList"},{"$ref":"#/components/schemas/ConditionCustomerCountry"},{"$ref":"#/components/schemas/ConditionBuyXGetYDiscountCode"}]}},"action":{"oneOf":[{"$ref":"#/components/schemas/ActionPriceAdjustRelative"},{"$ref":"#/components/schemas/ActionPriceAdjustPercent"},{"$ref":"#/components/schemas/ActionFreeShipping"},{"$ref":"#/components/schemas/ActionShippingAdjustRelative"},{"$ref":"#/components/schemas/ActionShippingAdjustPercent"},{"$ref":"#/components/schemas/ActionCartAdjustRelative"},{"$ref":"#/components/schemas/ActionCartAdjustPercent"}]},"limit":{"$ref":"#/components/schemas/UsageLimit"},"product_selection":{"oneOf":[{"$ref":"#/components/schemas/DiscountCodeProductSelection"},{"$ref":"#/components/schemas/DiscountCodeVariantSelection"},{"$ref":"#/components/schemas/DiscountCodeAllSelection"},{"$ref":"#/components/schemas/DiscountCodeCollectionSelection"},{"$ref":"#/components/schemas/DiscountCodeSKUSelection"}]},"start_date":{"type":"string","format":"date-time","description":"Date from which the discount code should be considered valid (optional)."},"expiry_date":{"type":"string","format":"date-time","description":"Date from which the discount code should be considered expired/invalid (optional)."},"restrict_by_emails":{"type":"array","maxItems":50,"description":"This optional field can be used to make the discount code valid only for certain customers (defined by their email addresses).","items":{"type":"string"}},"limits":{"type":"array","description":"If a discount code can be used only a limited amount of times (per customer, or in the entire shop) those optional limits can be defined here.","items":{"$ref":"#/components/schemas/UsageLimit"}},"raw_product_selection":{"$ref":"#/components/schemas/DiscountCodeRawProductSelection"},"raw_reward_product_selection":{"$ref":"#/components/schemas/DiscountCodeRawProductSelection"}},"required":["action","product_selection"]},"DiscountCodeRuleset":{"title":"DiscountCodeRuleset","type":"object","description":"A set of rules that can apply to a defined group of products, depending on the rule conditions being met. Used to change the price in conjuction with a discount code.","properties":{"id":{"type":"integer","description":"Ruleset database ID."},"external_id":{"type":"string","description":"This is the string identifier for the ruleset, it is auto generated based in the discount code name."},"active":{"type":"boolean","description":"Indicates if this ruleset is currently active."},"internal_name":{"type":"string","description":"This is the name of the ruleset, it is auto generated based in the discount code name."},"created_at":{"type":"string","format":"date-time","description":"Ruleset creation date."},"updated_at":{"type":"string","format":"date-time","description":"If the ruleset was altered, this will be the most recent date in which any changes occurred."},"start_date":{"type":"string","format":"date-time","description":"Date from which the discount code should be considered valid (optional)."},"expiry_date":{"type":"string","format":"date-time","description":"Date from which the discount code should be considered expired/invalid (optional)."},"rules":{"type":"array","description":"Each one of the rules contained in this ruleset.","items":{"$ref":"#/components/schemas/Rule"}},"product_selection":{"oneOf":[{"$ref":"#/components/schemas/DiscountCodeProductSelection"},{"$ref":"#/components/schemas/DiscountCodeVariantSelection"},{"$ref":"#/components/schemas/DiscountCodeAllSelection"},{"$ref":"#/components/schemas/DiscountCodeCollectionSelection"},{"$ref":"#/components/schemas/DiscountCodeSKUSelection"}]}}},"DiscountCodeAllSelection":{"title":"DiscountCodeAllSelection","type":"object","description":"Expression used to determine that all products in the store should be eligible to the discount code.","properties":{"type":{"type":"string","enum":["PRODUCTS_ALL"],"description":"The type of selection; the discount code can be applicable to specific products/variants or to the entire store."}},"required":["type"]},"RuleResponse":{"title":"RuleResponse","type":"object","properties":{"id":{"type":"string","description":"rule_id"},"external_id":{"type":"string","description":"Rule\'s external id if exists"},"conditions":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/ConditionQtyByLine"},{"$ref":"#/components/schemas/ConditionQtyByVariant"},{"$ref":"#/components/schemas/ConditionQtyByProduct"},{"$ref":"#/components/schemas/ConditionQtyByMixAndMatch"},{"$ref":"#/components/schemas/ConditionCustomerGroup"},{"$ref":"#/components/schemas/ConditionCustomerProvince"},{"$ref":"#/components/schemas/ConditionLineItemProperty"},{"$ref":"#/components/schemas/ConditionRefUrl"},{"$ref":"#/components/schemas/ConditionQtyByBundle"},{"$ref":"#/components/schemas/ConditionSubscriptionGroup"},{"$ref":"#/components/schemas/ConditionSubscriptionInterval"},{"$ref":"#/components/schemas/ConditionCurrency"}]}},"actions":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/ActionPriceAdjustAbsolute"},{"$ref":"#/components/schemas/ActionPriceAdjustRelative"},{"$ref":"#/components/schemas/ActionPriceAdjustPercent"},{"$ref":"#/components/schemas/ActionPriceAdjustAbsoluteWithLimit"},{"$ref":"#/components/schemas/ActionPriceAdjustRelativeWithLimit"},{"$ref":"#/components/schemas/ActionCharmPrice"},{"$ref":"#/components/schemas/ActionAdjustRate"},{"$ref":"#/components/schemas/ActionAddFee"},{"$ref":"#/components/schemas/ActionDisplayQtyBreak"},{"$ref":"#/components/schemas/ActionCustomerDraftOrderTaxable"}]}}}},"ActionFreeShipping":{"type":"object","title":"ActionFreeShipping","additionalProperties":false,"properties":{"type":{"type":"string","enum":["FREE_SHIPPING"]}},"required":["type"]},"ActionShippingAdjustRelative":{"type":"object","title":"ActionShippingAdjustRelative","additionalProperties":false,"properties":{"type":{"type":"string","enum":["SHIPPING_ADJUST_RELATIVE"]},"value":{"type":"integer"}},"required":["type","value"],"description":""},"ActionShippingAdjustPercent":{"type":"object","title":"ActionShippingAdjustPercent","additionalProperties":false,"properties":{"type":{"type":"string","enum":["SHIPPING_ADJUST_PERCENT"]},"value":{"type":"integer"}},"required":["type","value"]},"LineItem":{"title":"LineItem","type":"object","x-examples":{"example-1":{"key":"string","price":0,"id":"string","quantity":0}},"properties":{"key":{"type":"string","description":"key of lineItem"},"price":{"type":"integer"},"id":{"type":"string","description":"Example: sku_id/product_id"},"quantity":{"type":"integer"}},"required":["key","price","id","quantity"]},"ProcessLineItem":{"title":"LineItem","type":"object","x-examples":{"example-1":{"key":"string","price":0,"id":"string","quantity":0}},"properties":{"key":{"type":"string","description":"key of lineItem"},"price":{"type":"integer"},"matchValue":{"type":"string","description":"Example: sku_id/product_id"},"quantity":{"type":"integer"}},"required":["key","price","matchValue","quantity"]},"BestProductPriceAction":{"title":"BestProductPriceAction","type":"object","properties":{"type":{"type":"string","description":"","enum":["BEST_ITEM_PRICE"]},"sku":{"type":"string"},"variant_id":{"type":"string"},"value":{"type":"number","description":"Final discounted price of the variant"},"rule":{"type":"array","items":{"$ref":"#/components/schemas/LineItemRule"}}}},"Customer":{"title":"Customer","type":"object","properties":{"email":{"type":"string"},"shipping":{"$ref":"#/components/schemas/CustomerShippingSchema"}},"x-examples":{"example-1":{"value":{"email":"string","shipping":{"postal_code":"string","country":"string","country_code":"string","province":"string","province_code":"string"}}}}},"CartAction":{"title":"CartAction","type":"object","properties":{"type":{"type":"string","enum":["SET_LINE_ITEM_PRICE"]},"line_item_key":{"type":"string"},"value":{"type":"integer"},"rule":{"type":"array","items":{"$ref":"#/components/schemas/LineItemRule"}},"variant_id":{"type":"string"}}},"LineItemRule":{"title":"LineItemRule","type":"object","properties":{"id":{"type":"integer","description":"rule id"},"rule_set_id":{"type":"integer","description":"ruleset id"},"rule_set_eid":{"type":"string","description":"external id of ruleset if exist"},"type":{"type":"string","enum":["DISCOUNT","ADDITION"]},"eid":{"type":"string","description":"external id of rule if exist"},"rule_set_public_message":{"type":"string","description":"public message of ruleset if exist"}}},"ActionCartAdjustRelative":{"type":"object","title":"ActionCartAdjustRelative","additionalProperties":false,"properties":{"type":{"type":"string","enum":["CART_ADJUST_RELATIVE"]},"value":{"type":"number"}},"required":["type","value"],"x-examples":{"example-1":{"type":"CART_ADJUST_RELATIVE","value":0}}},"ConditionCartSubtotalMin":{"type":"object","title":"ConditionCartSubtotalMin","additionalProperties":false,"description":"This condition is used by discount codes, and it defines a minimum cart subtotal amount for the order to be considered eligible to a certain discount code.","properties":{"type":{"type":"string","enum":["CART_SUBTOTAL_MIN"],"description":"Condition type, for this condition it should be always CART_SUBTOTAL_MIN."},"value":{"type":"integer","description":"Value to be used as the minimum cart total required; the amount is always an integer, so values like $8.99 should be given as 899, and full values as $5 should be given as 500."}},"required":["type","value"]},"ActionCartAdjustPercent":{"type":"object","title":"ActionCartAdjustPercent","additionalProperties":false,"properties":{"type":{"type":"string","enum":["CART_ADJUST_PERCENT"]},"value":{"type":"number"}},"required":["type","value"],"x-examples":{"example-1":{"type":"CART_ADJUST_PERCENT","value":0}}},"ConditionShippingRateRange":{"type":"object","title":"ConditionShippingRateRange","additionalProperties":false,"description":"This condition is used by discount codes, and it defines a minimum and a maximum shipping rate value for the order to be considered eligible to a certain discount code.","properties":{"type":{"type":"string","enum":["SHIPPING_RATE_RANGE"],"description":"Condition type, for this condition it should be always SHIPPING_RATE_RANGE."},"min_value":{"type":"integer","description":"Value to be used as the minimum shiping rate accepted; the amount is always an integer, so values like $8.99 should be given as 899, and full values as $5 should be given as 500."},"max_value":{"type":"integer","description":"Value to be used as the maximum shiping rate accepted; the amount is always an integer, so values like $8.99 should be given as 899, and full values as $5 should be given as 500."}},"required":["type"]},"BasicPatchRuleset":{"description":"A set of rules that can apply to a defined group of products, depending on the rule conditions being met. The basic patch ruleset type refers to the fields that should be passed when updating a ruleset.","type":"object","x-examples":{"example-1":{"ruleset":{"start_date":"2020-12-07T15:28:15.000-06:00","expiry_date":"2020-12-08T15:28:15.000-06:00","rules":[{"type":"DISCOUNT","conditions":[{"value":5,"type":"QTY_BY_LINE","operator":"=","requiresPrepare":true}],"actions":[{"value":99,"type":"PRICE_ADJUST_ABSOLUTE"}],"meta":{},"external_id":"realExternalId"}]}}},"properties":{"ruleset":{"type":"object","required":["rules"],"properties":{"start_date":{"type":"string","format":"date-time"},"expiry_date":{"type":"string","format":"date-time"},"rules":{"type":"array","uniqueItems":true,"minItems":1,"items":{"$ref":"#/components/schemas/Rule"}}}}},"required":["ruleset"]},"DiscountCodeCollectionSelection":{"type":"object","title":"DiscountCodeCollectionSelection","additionalProperties":false,"properties":{"type":{"type":"string","enum":["PRODUCT_SEARCH","PRODUCTS_EXCEPT"]},"collection_ids":{"type":"array","items":{"type":"string"}}},"required":["type","collection_ids"],"description":"Expression to filter which collections should be eligible for a discount code."},"ConditionQtyOnCart":{"title":"ConditionQtyOnCart","type":"object","description":"This condition is used by discount codes, and it defines a minimum amount of items in the cart for it to be considered eligible to a certain discount code.","properties":{"type":{"type":"string","enum":["QTY_ON_CART"],"description":"Condition type, for this condition it should be always QTY_ON_CART."},"value":{"type":"integer","description":"The minimum amount of items that must be in the cart for the code to be applicable."}},"required":["type","value"]},"ConditionCustomerId":{"title":"ConditionCustomerId","type":"object","x-examples":{"example-1":{"value":{"type":"CUSTOMER_ID","value":"some_email@gmail.com"}}},"properties":{"type":{"type":"string","description":"CUSTOMER_ID"},"value":{"type":"string","description":"A customer\'s email address"}},"description":"This ruleset condition allows giving specific customers a discount. To enable this condition, please contact our support team."},"ConditionCustomerInAnyGroupFromList":{"title":"ConditionCustomerInAnyGroupFromList","type":"object","description":"This condition is used by discount codes, and it defines a list of groups related to the code. If the customer belongs to any of these groups, they are eligible for the discount code.","properties":{"type":{"type":"string","enum":["CUSTOMER_IN_ANY_GROUP_FROM_LIST"],"description":"Condition type, for this condition it should be always CUSTOMER_IN_ANY_GROUP_FROM_LIST."},"list":{"type":"array","description":"List of groups to check and see if the customer belongs to any of them.","items":{"type":"string"}}},"required":["type","list"]},"ConditionCustomerCountry":{"title":"ConditionCustomerCountry","type":"object","description":"This condition is used by discount codes, and it defines a list of countries in which the discount code should be considered valid.","properties":{"type":{"type":"string","enum":["CUSTOMER_COUNTRY"],"description":"Condition type, for this condition it should be always CUSTOMER_COUNTRY."},"list":{"type":"array","description":"List of countries (alpha 2 codes, defined on ISO 3166-2) to check and see if the customer address belongs to any of them. Examples: US, CA, FR. The the proper code for each country can be obtained here: https://www.iso.org/obp/ui/#search","items":{"type":"string"}}},"required":["type","list"]},"ConditionBuyXGetYDiscountCode":{"type":"object","title":"ConditionBuyXGetYDiscountCode","description":"This condition is used exclusively by discount codes, and it describes a \\"Buy X Get Y\\" situation, in which you need to buy one or more required products to receive a % discount in one or more reward products. Important: this condition is only compatible with the action type PRICE_ADJUST_PERCENT.","additionalProperties":false,"properties":{"type":{"type":"string","enum":["BUY_X_GET_Y_DISCOUNT_CODE"],"description":"Condition type, for this condition it should be always BUY_X_GET_Y_DISCOUNT_CODE."},"buy_quantity":{"type":"integer","minimum":1,"description":"The minimum amount of products that must be bought to qualify the cart for this discount code."},"get_quantity":{"type":"integer","minimum":1,"description":"The maximum amount of products that can be discounted if the cart qualifies for this discount code."},"uses_per_order":{"type":"integer","minimum":1,"description":"In case a cart can qualify more than once for a code (for example, when using a \\"Buy 3 Get 2\\" discount code in a cart that has 9 required products and 6 reward products) this limits how many times the same discount can be applied for that order. If it is not provided, the default is 1."},"requirement_selection":{"oneOf":[{"$ref":"#/components/schemas/RequirementSelectionWithProducts"},{"$ref":"#/components/schemas/RequirementSelectionWithCollections"},{"$ref":"#/components/schemas/RequirementSelectionWithVariants"},{"$ref":"#/components/schemas/RequirementSelectionWithSKUs"}]}},"required":["type","buy_quantity","get_quantity","requirement_selection"]},"RequirementSelectionWithProducts":{"type":"object","title":"RequirementSelectionWithProducts","description":"This is used to list what are the requirements when configuring a \\"Buy X Get Y\\" discount code. Here you can list all the platform product ids that are accepted as qualifying items for a \\"Buy X Get Y\\" discount type.","additionalProperties":false,"properties":{"type":{"type":"string","enum":["PRODUCT_SEARCH"],"description":"Currently, the only type of selection supported is PRODUCT_SEARCH (that works for products, variants and collections)."},"product_ids":{"type":"array","description":"The list of product ids that are accepted as requirements to compose the \\"Buy X Get Y\\" promotion.","items":{"type":"string","minLength":1}}},"required":["type","product_ids"]},"RequirementSelectionWithCollections":{"title":"RequirementSelectionWithCollections","type":"object","description":"This is used to list what are the requirements when configuring a \\"Buy X Get Y\\" discount code. Here you can list all the platform collection ids that are accepted as qualifying items for a \\"Buy X Get Y\\" discount type.","additionalProperties":false,"properties":{"type":{"type":"string","enum":["PRODUCT_SEARCH"],"description":"Currently, the only type of selection supported is PRODUCT_SEARCH (that works for products, variants and collections)."},"collection_ids":{"type":"array","description":"The list of collection ids that are accepted as requirements to compose the \\"Buy X Get Y\\" promotion.","items":{"type":"string","minLength":1}}},"required":["type","collection_ids"]},"RequirementSelectionWithVariants":{"type":"object","title":"RequirementSelectionWithVariants","description":"This is used to list what are the requirements when configuring a \\"Buy X Get Y\\" discount code. Here you can list all the platform variant ids that are accepted as qualifying items for a \\"Buy X Get Y\\" discount type.","additionalProperties":false,"properties":{"type":{"type":"string","enum":["PRODUCT_SEARCH"],"description":"Currently, the only type of selection supported is PRODUCT_SEARCH (that works for products, variants and collections)."},"variant_ids":{"type":"array","description":"The list of variant ids that are accepted as requirements to compose the \\"Buy X Get Y\\" promotion.","items":{"type":"string","minLength":1}}},"required":["type","variant_ids"]},"RequirementSelectionWithSKUs":{"type":"object","title":"RequirementSelectionWithSKUs","description":"This is used to list what are the requirements when configuring a \\"Buy X Get Y\\" discount code. Here you can list all the product SKUs that are accepted as qualifying items for a \\"Buy X Get Y\\" discount type.","additionalProperties":false,"properties":{"type":{"type":"string","enum":["PRODUCT_SEARCH"],"description":"Currently, the only type of selection supported is PRODUCT_SEARCH (that works for products, variants, SKUs and collections)."},"sku_ids":{"type":"array","description":"The list of SKUs that are accepted as requirements to compose the \\"Buy X Get Y\\" promotion.","items":{"type":"string","minLength":1}}},"required":["type","sku_ids"]},"ActionPriceAdjustAbsoluteBasePrice":{"title":"ActionPriceAdjustAbsoluteBasePrice","type":"object","properties":{"value":{"type":"integer","example":299},"type":{"type":"string","enum":["PRICE_ADJUST_ABSOLUTE_BASE_PRICE"]}}},"ConditionCurrency":{"title":"ConditionCurrency","type":"object","properties":{"type":{"type":"string"},"value":{"type":"string","enum":["CURRENCY"]}}},"DiscountCodeRawProductSelection":{"title":"DiscountCodeRawProductSelection","type":"object","properties":{"type":{"type":"string","enum":["PRODUCT","COLLECTION"]},"selections":{"type":"array","items":{}}}},"ActionAdjustRate":{"title":"ActionAdjustRate","type":"object","properties":{"type":{"type":"string","enum":["PRICE_ADJUST_RATE"]},"value":{"type":"number"}},"required":["type","value"]},"TaggedCustomer":{"title":"TaggedCustomer","type":"object","properties":{"tags":{"type":"string","description":"Comma separated string like \\"vip,gold\\n\\""},"email":{"type":"string","description":"Email address"},"shipping":{"$ref":"#/components/schemas/CustomerShippingSchema"}}},"DiscountCodeSKUSelection":{"title":"DiscountCodeSKUSelection","type":"object","description":"Expression to filter which product SKUs should be eligible for a discount code.","additionalProperties":false,"properties":{"type":{"type":"string","enum":["PRODUCT_SEARCH"],"description":"The type of selection; the discount code can be applicable to specific products/variants/SKUs or to the entire store."},"sku_ids":{"type":"array","description":"List of product SKUs eligible for the discount code.","items":{"type":"string"}}},"required":["type","sku_ids"]},"OrderConditionCustomerSchema":{"title":"OrderConditionCustomerSchema","type":"object","properties":{"shipping":{"$ref":"#/components/schemas/CustomerShippingSchema"}}},"CustomerShippingSchema":{"title":"CustomerShippingSchema","type":"object","properties":{"postal_code":{"type":"string"},"country":{"type":"string"},"country_code":{"type":"string"},"province":{"type":"string"},"province_code":{"type":"string"}}}}}}},"plugin-redoc-7":{"url":"/api/products.openapi.yaml","themeId":"theme-redoc","isSpecFile":true,"spec":{"openapi":"3.0.0","info":{"title":"Internal products service","description":"This API allows you to find information about your products, variants and categories.\\n\\nRefer to the <a href=\\"https://developer.boldcommerce.com/changelog\\">changelog</a> for the latest updates to this API.","contact":{"name":"Contact Us","url":"https://developer-dashboard.boldcommerce.com/default/contactus"},"version":"2.0.0"},"servers":[{"url":"http://product-api.prod.svc.cluster.local:9000"},{"url":"http://product-api.staging.svc.cluster.local:9000"},{"url":"http://localhost:9200"}],"tags":[{"name":"Customer Event Notifications","description":"Event notifications you send to Bold when a change occurs to customers on the platform."},{"name":"Order Event Notifications","description":"Event notifications you send to Bold when a change occurs to orders on the platform."},{"name":"Product Event Notifications","description":"Event notifications you send to Bold when a change occurs to products on the platform."},{"name":"Products","description":"Contains information about the products associated with a given store. Use these endpoints to retrieve information about one or all products on a store."},{"name":"Variants","description":"A child of the Product resource. Contains information about the variants of a product, which are derived from different combinations of options. Use these endpoints to retrieve information about a single variant, the variants of a single product, or all variants on a store."},{"name":"Categories","description":"Contains information about the product categories applicable on a given store. Use these endpoints to retrieve information about one or all product categories on a store."},{"name":"Images","description":"Contains information about the product images associated with a given store. Use these endpoints to retrieve information about one or all product images on a store."},{"name":"Options","description":"A child of the Product resource. Contains information about the options associated with a given product, such as colors, sizes, weights, etc. Use these endpoints to retrieve information about one or all product options for a product."}],"paths":{"/v1/shops/{shop_identifier}/platforms/custom/webhooks/products/saved":{"parameters":[{"$ref":"#/components/parameters/shopIdentifier"}],"post":{"tags":["Product Event Notifications"],"summary":"Product Saved","operationId":"ProductSavedEventNotification","description":"Trigger this API call when product data changes, including product creation and updates.\\n\\nBold queues the product for saving. The request must contain the complete product object at the time the change occurred. Bold replaces all fields of the existing product object with the values provided in the request body. Bold ignores and does not update fields omitted from the request body. \\n\\nThe `platform_updated_at` field must be accurate to mitigate the risk incurred by out-of-sequence requests.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/productSavedRequestBody"}}},"required":true},"responses":{"202":{"description":"Event notification was queued successfully.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"A validation error occurred.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/validationError"},"examples":{"validationError":{"value":{"status_code":400,"errors":["Error at \'/data/product/platform_id\': property \'platform_id\' is missing.","Error at \'/data/product/variants/0/platform_id\': property \'platform_id\' is missing."]}}}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeErrorProduct"}}}}}}},"/v1/shops/{shop_identifier}/platforms/custom/webhooks/products/deleted":{"parameters":[{"$ref":"#/components/parameters/shopIdentifier"}],"post":{"tags":["Product Event Notifications"],"summary":"Product Deleted","operationId":"ProductDeletedEventNotification","description":"Trigger this API call when a product is deleted on the platform.\\n\\nBold queues the product for deletion. The `platform_deleted_at` field must be accurate to mitigate the risk incurred by out-of-sequence requests.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/productDeletedRequestBody"}}},"required":true},"responses":{"202":{"description":"Event notification was queued successfully.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"A validation error occurred.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/validationError"},"examples":{"validationError":{"value":{"status_code":400,"errors":["Error at \'/data/product/platform_id\': property \'platform_id\' is missing."]}}}}}},"500":{"description":"An unexpected error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeErrorProduct"}}}}}}},"/v1/shops/{shop_identifier}/platforms/custom/webhooks/categories/saved":{"parameters":[{"$ref":"#/components/parameters/shopIdentifier"}],"post":{"tags":["Product Event Notifications"],"summary":"Product Category Saved","operationId":"CategorySavedEventNotification","description":"Trigger this API call when a product category is saved on the platform.\\n\\nBold queues the product category for saving. The request contains the complete product category object at the time the change occurred. Bold replaces all fields of the existing product category object with the values provided in the request\\nbody. Fields omitted from the request body are ignored in the `category` object.\\n\\nThe `platform_updated_at` field must be accurate to mitigate the risk incurred by out-of-sequence requests.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/categorySavedRequestBody"}}},"required":true},"responses":{"202":{"description":"Notification queued successfully","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"A validation error occurred.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/validationError"},"examples":{"validationError":{"value":{"status_code":400,"errors":["Error at \'/data/category/platform_id\': property \'platform_id\' is missing."]}}}}}},"500":{"description":"An unexpected error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeErrorProduct"}}}}}}},"/v1/shops/{shop_identifier}/platforms/custom/webhooks/categories/deleted":{"parameters":[{"$ref":"#/components/parameters/shopIdentifier"}],"post":{"tags":["Product Event Notifications"],"summary":"Product Category Deleted","operationId":"CategoryDeletedEventNotification","description":"Trigger this API call when a product category is deleted on the platform.\\n\\nBold queues the product category for deletion. The `platform_deleted_at` field must be accurate to mitigate the risk incurred by out-of-sequence requests.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/categoryDeletedRequestBody"}}},"required":true},"responses":{"202":{"description":"Notification queued successfully","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"A validation error occurred.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/validationError"},"examples":{"validationError":{"value":{"status_code":400,"errors":["Error at \'/data/category/platform_id\': property \'platform_id\' is missing."]}}}}}},"500":{"description":"An unexpected error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeErrorProduct"}}}}}}},"/v2/shops/{shop_identifier}/categories":{"get":{"tags":["Categories"],"summary":"List Categories","operationId":"ListCategories","description":"Lists product categories for the shop.\\n\\nFor more information on result pagination, refer to the [Query & Pagination](/guides/checkout/resources/query-pagination) page.","parameters":[{"$ref":"#/components/parameters/shopIdentifierParam"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"},{"name":"ids","in":"query","schema":{"type":"string","description":"A comma-separated list of category identifiers, defining which categories to return.","example":"123,456,789"}}],"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2CategoryListResponse"}}}},"default":{"description":"An unexpected error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}}}},"/v2/shops/{shop_identifier}/categories/pid/{pid}":{"get":{"tags":["Categories"],"summary":"Get Category by Platform ID","operationId":"GetCategoryByPlatformID","description":"Retrieves a product category by its platform-assigned identifier.","parameters":[{"$ref":"#/components/parameters/shopIdentifierParam"},{"name":"pid","in":"path","required":true,"schema":{"type":"string"},"description":"The unique identifier for the category. Assigned by the shop platform.","example":"110"}],"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2CategoryByXIDResponse"}}}},"default":{"description":"An unexpected error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}}}},"/v2/shops/{shop_identifier}/categories/{id}":{"get":{"tags":["Categories"],"summary":"Get Category by ID","operationId":"GetCategoryByID","description":"Retrieves a product category by its Bold-assigned identifier.","parameters":[{"$ref":"#/components/parameters/shopIdentifierParam"},{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"},"description":"The unique identifier for this category. Assigned by Bold.","example":100}],"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2CategoryByXIDResponse"}}}},"default":{"description":"An unexpected error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}}}},"/v2/shops/{shop_identifier}/products":{"get":{"tags":["Products"],"summary":"List Products","operationId":"ListProducts","description":"Lists all products in the shop.\\n\\nFor more information on result pagination, refer to the [Query & Pagination](/guides/checkout/resources/query-pagination) page.","parameters":[{"$ref":"#/components/parameters/shopIdentifierParam"},{"$ref":"#/components/parameters/deep"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/filter"},{"name":"categoryid","in":"query","description":"The category identifier to search within. Assigned by Bold.","schema":{"type":"integer","format":"int64"},"example":100},{"name":"filtercolumn","in":"query","description":"The column name by which to perform a fuzzy search with the `filtervalue`.","schema":{"type":"string"},"example":"type"},{"name":"filtervalue","in":"query","description":"A search term used to perform a fuzzy search on the `filtercolumn`.","schema":{"type":"string"},"example":"%27hat%27"},{"name":"ordercolumn","in":"query","description":"The method of ordering the returned results. Must be paired with the `orderdirection` query parameter.","schema":{"type":"string"},"example":"type"},{"name":"orderdirection","in":"query","description":"The direction of ordering returned results. Must be paired with the `ordercolumn` query parameter. Possible values include `asc` and `desc`.","schema":{"type":"string"},"example":"asc"},{"name":"updated_at_min","in":"query","description":"The earliest date (in [RFC3339 format](https://datatracker.ietf.org/doc/html/rfc3339)) the customer was updated.","schema":{"type":"string","format":"date-time"},"example":"2020-01-01T00:00:00Z"},{"name":"updated_at_max","in":"query","description":"The latest date (in [RFC3339 format](https://datatracker.ietf.org/doc/html/rfc3339)) the product was updated.","schema":{"type":"string","format":"date-time"},"example":"2020-01-02T00:00:00Z"},{"name":"include_deleted","in":"query","description":"Indicates whether to include deleted products in search results.","schema":{"type":"boolean","format":"boolean"},"example":true},{"name":"es_optimize","in":"query","description":"Indicates whether to optimize the results for Elasticsearch.","schema":{"type":"boolean","format":"boolean"},"example":true}],"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2ProductListResponse"}}}},"default":{"description":"An unexpected error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}}}},"/v2/shops/{shop_identifier}/products/categories":{"get":{"tags":["Categories"],"summary":"List Product Categories","operationId":"ListProductCategories","description":"Lists product categories for the shop.\\n\\nFor more information on result pagination, refer to the [Query & Pagination](/guides/checkout/resources/query-pagination) page.","parameters":[{"$ref":"#/components/parameters/shopIdentifierParam"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/filter"}],"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2ProductCategoryListResponse"}}}},"default":{"description":"An unexpected error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}}}},"/v2/shops/{shop_identifier}/products/pid/{pid}":{"get":{"tags":["Products"],"summary":"Get Product by Platform ID","operationId":"GetProductByPlatformID","description":"Retrieves a product by its platform-specific identifier.","parameters":[{"$ref":"#/components/parameters/shopIdentifierParam"},{"$ref":"#/components/parameters/deep"},{"name":"pid","in":"path","required":true,"schema":{"type":"string"},"description":"The unique identifier for this category. Assigned by the shop platform.","example":"110"}],"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2ProductByXIDResponse"}}}},"default":{"description":"An unexpected error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}}}},"/v2/shops/{shop_identifier}/products/{bold_product_id}/images":{"get":{"tags":["Images"],"summary":"List Product Images","operationId":"ListProductImages","description":"Lists images for a product by its Bold-specific identifier.\\n\\nFor more information on result pagination, refer to the [Query & Pagination](/guides/checkout/resources/query-pagination) page.","parameters":[{"$ref":"#/components/parameters/shopIdentifierParam"},{"$ref":"#/components/parameters/boldProductId"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2ImageListResponse"}}}},"default":{"description":"An unexpected error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}}}},"/v2/shops/{shop_identifier}/products/{bold_product_id}/images/pid/{pid}":{"get":{"tags":["Images"],"summary":"Get Product Image by Platform ID","operationId":"GetProductImageByPlatformID","description":"Retrieves a product image by its platform-assigned identifier.","parameters":[{"$ref":"#/components/parameters/shopIdentifierParam"},{"$ref":"#/components/parameters/boldProductId"},{"name":"pid","in":"path","required":true,"schema":{"type":"string"},"description":"A unique identifier for the product. Assigned by the shop platform.","example":"456"}],"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2ImageByXIDResponse"}}}},"default":{"description":"An unexpected error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}}}},"/v2/shops/{shop_identifier}/products/{bold_product_id}/images/{id}":{"get":{"tags":["Images"],"summary":"Get Product Image by ID","operationId":"GetProductImageByID","description":"Retrieves a product image by its Bold-assigned identifier.","parameters":[{"$ref":"#/components/parameters/shopIdentifierParam"},{"$ref":"#/components/parameters/boldProductId"},{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"},"description":"A unique identifier for the product image. Assigned by Bold.","example":456}],"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2ImageByXIDResponse"}}}},"default":{"description":"An unexpected error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}}}},"/v2/shops/{shop_identifier}/products/{bold_product_id}/options":{"get":{"tags":["Options"],"summary":"List Product Options","operationId":"ListProductOptions","description":"Lists the options for a product by its Bold-specific identifier.\\n\\nFor more information on result pagination, refer to the [Query & Pagination](/guides/checkout/resources/query-pagination) page.","parameters":[{"$ref":"#/components/parameters/shopIdentifierParam"},{"$ref":"#/components/parameters/boldProductId"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2OptionListResponse"}}}},"default":{"description":"An unexpected error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}}}},"/v2/shops/{shop_identifier}/products/{bold_product_id}/options/pid/{pid}":{"get":{"tags":["Options"],"summary":"Get Product Option by Platform ID","operationId":"GetProductOptionByPlatformID","description":"Retrieves a product option by the platform-specific option identifier.","parameters":[{"$ref":"#/components/parameters/shopIdentifierParam"},{"$ref":"#/components/parameters/boldProductId"},{"name":"pid","in":"path","required":true,"schema":{"type":"string"},"description":"A unique identifier for this product option. Assigned by the shop platform.","example":"110"}],"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2OptionByXIDResponse"}}}},"default":{"description":"An unexpected error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}}}},"/v2/shops/{shop_identifier}/products/{bold_product_id}/options/{id}":{"get":{"tags":["Options"],"summary":"Get Product Option by ID","operationId":"GetProductOptionByID","description":"Retrieves a product option by the Bold-specific option identifier.","parameters":[{"$ref":"#/components/parameters/shopIdentifierParam"},{"$ref":"#/components/parameters/boldProductId"},{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"},"description":"The unique identifier for the product option. Assigned by Bold.","example":100}],"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2OptionByXIDResponse"}}}},"default":{"description":"An unexpected error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}}}},"/v2/shops/{shop_identifier}/products/{bold_product_id}/variants":{"get":{"tags":["Variants"],"summary":"List Product Variants","operationId":"ListProductVariants","description":"Lists the variants for a product by its Bold-specific product identifier.\\n\\nFor more information on result pagination, refer to the [Query & Pagination](/guides/checkout/resources/query-pagination) page.","parameters":[{"$ref":"#/components/parameters/shopIdentifierParam"},{"$ref":"#/components/parameters/boldProductId"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2VariantListResponse"}}}},"default":{"description":"An unexpected error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}}}},"/v2/shops/{shop_identifier}/products/{bold_product_id}/variants/pid/{pid}":{"get":{"tags":["Variants"],"summary":"Get Product Variant by Platform ID","operationId":"GetProductVariantByPlatformID","description":"Retrieves a product variant by its platform-specific identifier.","parameters":[{"$ref":"#/components/parameters/shopIdentifierParam"},{"$ref":"#/components/parameters/boldProductId"},{"name":"pid","in":"path","required":true,"schema":{"type":"string"},"description":"The unique identifier for this product variant. Assigned by the shop platform.","example":"110"}],"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2VariantByXIDResponse"}}}},"default":{"description":"An unexpected error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}}}},"/v2/shops/{shop_identifier}/products/{bold_product_id}/variants/{id}":{"get":{"tags":["Variants"],"summary":"Get Product Variant by ID","operationId":"GetProductVariantByID","description":"Retrieves a product variant by its Bold-specific identifier.","parameters":[{"$ref":"#/components/parameters/shopIdentifierParam"},{"$ref":"#/components/parameters/boldProductId"},{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"},"description":"The unique identifier for this product variant. Assigned by Bold.","example":100}],"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2VariantByXIDResponse"}}}},"default":{"description":"An unexpected error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}}}},"/v2/shops/{shop_identifier}/products/{id}":{"get":{"tags":["Products"],"summary":"Get Product by ID","operationId":"GetProductByID","description":"Retrieves a product by its Bold-specific identifier.","parameters":[{"$ref":"#/components/parameters/shopIdentifierParam"},{"$ref":"#/components/parameters/deep"},{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"},"description":"The unique identifier for this product. Assigned by Bold.","example":100}],"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2ProductByXIDResponse"}}}},"default":{"description":"An unexpected error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}}}},"/v2/shops/{shop_identifier}/types":{"get":{"tags":["Products"],"summary":"List Product Types","operationId":"ListProductTypes","description":"Lists the product types for all products in the shop.\\n\\nFor more information on result pagination, refer to the [Query & Pagination](/guides/checkout/resources/query-pagination) page.","parameters":[{"$ref":"#/components/parameters/shopIdentifierParam"}],"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2ProductTypeListResponse"}}}},"default":{"description":"An unexpected error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}}}},"/v2/shops/{shop_identifier}/variants":{"get":{"tags":["Variants"],"summary":"List Variants for Shop","operationId":"ListVariantsForShop","description":"Lists all product variants in the shop.\\n\\nFor more information on result pagination, refer to the [Query & Pagination](/guides/checkout/resources/query-pagination) page.","parameters":[{"$ref":"#/components/parameters/shopIdentifierParam"},{"$ref":"#/components/parameters/filter"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2AllVariantsListResponse"}}}},"default":{"description":"An unexpected error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}}}},"/v2/shops/{shop_identifier}/vendors":{"get":{"tags":["Products"],"summary":"List Product Vendors","operationId":"ListProductVendors","description":"Lists the vendors for all products in the shop.\\n\\nFor more information on result pagination, refer to the [Query & Pagination](/guides/checkout/resources/query-pagination) page.","parameters":[{"$ref":"#/components/parameters/shopIdentifierParam"}],"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2VendorListResponse"}}}},"default":{"description":"An unexpected error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}}}}},"components":{"parameters":{"shopIdentifier":{"name":"shop_identifier","in":"path","description":"A unique identifier of the store. This can be retrieved by calling the [Get Shop\\nInfo](shops#tag/Shops/operation/GetShopInfo#) endpoint.","required":true,"schema":{"type":"string","example":"zp3oafdor9"}},"shopIdentifierParam":{"name":"shop_identifier","in":"path","required":true,"schema":{"type":"string"},"description":"A unique identifier of the store. Retrieve this information by calling the [Get Shop Info](shops#tag/Shop/operation/GetShopInfo) endpoint.","example":"zp3oafdor9"},"limit":{"name":"limit","in":"query","schema":{"type":"integer","format":"int32"},"description":"The maximum number of results to return per page.","example":50},"page":{"name":"page","in":"query","schema":{"type":"integer","format":"int32"},"description":"The desired page number for the paginated results.","example":1},"deep":{"name":"deep","in":"query","description":"Indicates whether to perform a deep search. When set to `true`, this endpoint fetches and populates related child entities for the product in the response payload, including: \\n* `options`\\n* `variants` and their `option_values`\\n* `images`\\n* `categories`\\n* `localized_names`\\n* `localized_descriptions`","schema":{"type":"boolean","format":"boolean"},"example":true},"filter":{"name":"filter","in":"query","style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"}},"description":"A filter for returned results.\\n\\nAccepts filtering options as described in the [Query & Pagination](/guides/checkout/resources/query-pagination#filter) page.","example":["eq(target:order)"]},"boldProductId":{"name":"bold_product_id","in":"path","required":true,"schema":{"type":"integer","format":"int64"},"description":"A unique identifier for the product. Assigned by Bold.","example":123}},"schemas":{"productBase":{"type":"object","properties":{"description":{"type":"string","description":"The description for the product.","example":"A hat for the beach"},"handle":{"type":"string","description":"A unique, human-readable string for the product.","example":"beach-hat"},"inventory_quantity":{"type":"integer","description":"The current inventory amount of the product.","format":"int64","example":2},"inventory_tracking_entity":{"type":"string","description":"The entity on which inventory is tracked.","enum":["variant","product","none"],"example":"product"},"inventory_tracking_service":{"type":"string","description":"The service that tracks inventory.","example":"platform"},"localized_descriptions":{"type":"object","description":"A map of localized descriptions for the product. The key is the [ISO-639](https://www.iso.org/iso-639-language-codes.html) two character language code. The value is the product description in the given language.","additionalProperties":{"type":"string"},"example":{"en":"A hat for the beach","fr":"Un chapeau pour la plage"}},"localized_names":{"type":"object","description":"A map of localized names for the product. The key is the [ISO-639](https://www.iso.org/iso-639-language-codes.html) two character language code. The value is the product name in the given language.","additionalProperties":{"type":"string"},"example":{"en":"Beach Hat","fr":"Chapeau de Plage"}},"name":{"type":"string","description":"The product name.","example":"Beach hat"},"published":{"type":"boolean","description":"Indicates if the product is published on the storefront.","example":true},"tags":{"type":"string","description":"A string with comma separated values describing the product.","example":"clothing, unisex, headwear"},"tax_code":{"type":"string","description":"The tax code for the product.","example":"non-taxable"},"type":{"type":"string","description":"A representation of platform-specific product data. The role of this field depends on the platform:\\n\\n- BigCommerce: The product type, either `physical` or `digital`.\\n- commercetools: A merchant or partner-defined data set, valid as per options set in the platform.\\n- Shopify: A product categorization, used for filtering and searching products.\\n- Custom: Defined by the platform.","example":"physical"},"url":{"type":"string","description":"A URL to the product on the storefront.","example":"/hats/beach-hat"},"vendor":{"type":"string","description":"The product vendor.","example":"OFS"}}},"categoryBase":{"type":"object","properties":{"image_url":{"description":"The URL location of the category image.","type":"string","example":"your_platform_connector.com/files/categories/hats.jpg"},"name":{"description":"The name of the category.","type":"string","example":"Hats"}}},"category":{"type":"object","allOf":[{"$ref":"#/components/schemas/categoryBase"}],"properties":{"platform_id":{"type":"string","description":"A unique identifier for the category. Defined by the platform.","example":"category-123456"},"platform_updated_at":{"type":"string","format":"date-time","description":"The date and time the category was last updated on the platform, in [RFC 3339, section 5.6 format](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6). If never updated, defaults to the `platform_created_at` value.","example":"2019-08-24T14:15:22Z"}},"required":["platform_id","platform_updated_at"]},"variantBase":{"type":"object","description":"An array of `variant` objects. At least one variant is required. If the product has no variants, the variant can reuse the product information.","properties":{"allow_backorder":{"description":"If backorders of the variant is allowed.","type":"boolean","format":"boolean"},"compare_at_price":{"description":"The original price of the item before an adjustment or a sale.","type":"string","example":"30.00"},"cost":{"description":"The cost of the product variant.","type":"string","example":"30.00"},"grams":{"description":"The weight of the product variant in grams.","type":"integer","format":"int64"},"image_url":{"description":"URL of the image.","type":"string","example":"your_platform_connector.com/files/products/hats/purple-beach-hat.jpg"},"inventory_quantity":{"description":"Current inventory level of the product.","type":"integer","format":"int64"},"inventory_tracking_entity":{"type":"string","description":"Entity on which inventory is tracked.","enum":["variant","product","none"]},"inventory_tracking_service":{"type":"string","description":"Service that tracks inventory.","example":"platform"},"localized_names":{"type":"object","additionalProperties":{"type":"string"},"description":"Map of localized names for the variant. The field is the [ISO-639](https://www.iso.org/iso-639-language-codes.html) two character language code. The value is the product name in the given language.","example":{"en":"Purple","fr":"Violette"}},"name":{"description":"The name of the variant. If there is only one variant, the `name` must be \\"Default Title\\" in order to avoid displaying the same `name` twice.","type":"string","example":"Default Title"},"price":{"description":"The price of the variant","type":"string","example":"30.00"},"require_shipping":{"description":"True if the item needs to be shipped, false otherwise.","type":"boolean","format":"boolean"},"sku":{"description":"Variant SKU.","type":"string","example":"BEACH-HAT-PURPLE"},"tax_code":{"description":"Tax code for the variant.","type":"string","example":"non-taxable"},"tax_exempt":{"description":"Indicates whether the variant is tax-exempt. If `true`, the variant is tax-exempt.","type":"boolean","format":"boolean","nullable":true},"weight":{"type":"string","description":"The weight of the product variant, calculated with weight unit specified.","example":"1.0"},"weight_unit":{"type":"string","description":"The unit of measurement that applies to the product variant\'s weight.","example":"kg"}}},"variantOptionValue":{"type":"object","description":"A more granular level of customization for variants. These are not required, but can be used to provide more options for your same variant.","properties":{"platform_id":{"type":"string","description":"A unique identifier for the variant option value. Defined by the platform.","example":"abc123456"},"platform_product_option_id":{"type":"string","description":"The unique identifier for the product option this value belongs to. Defined by the platform.","example":"VAR-10001-SM"},"label":{"type":"string","description":"The label of the option value.","example":"small"},"name":{"type":"string","description":"The name of the option.","example":"Small"}}},"deepVariant":{"type":"object","allOf":[{"$ref":"#/components/schemas/variantBase"}],"properties":{"platform_id":{"type":"string","description":"A unique identifier for the variant. Defined by the platform.","example":"variant-123456"},"option_values":{"type":"array","items":{"$ref":"#/components/schemas/variantOptionValue"}}},"required":["platform_id","allow_backorder","price","weight"]},"optionBase":{"type":"object","properties":{"name":{"description":"The option name.","type":"string","example":"Small"},"position":{"description":"The position in the `options` array.","type":"integer","format":"int64","example":1}}},"optionValueBase":{"type":"object","properties":{"is_default":{"type":"boolean","description":"Indicates whether this is the default option.","format":"boolean"},"label":{"description":"The label of the option value.","type":"string","example":"Small"},"position":{"description":"The position in the `option_values` array.","type":"integer","format":"int64","example":1}}},"deepOptionValue":{"type":"object","allOf":[{"$ref":"#/components/schemas/optionValueBase"}],"properties":{"platform_id":{"type":"string","description":"A unique identifier for the option value. Defined by the platform.","example":"option-value-123456"}}},"deepOption":{"type":"object","allOf":[{"$ref":"#/components/schemas/optionBase"}],"properties":{"platform_id":{"type":"string","description":"A unique identifier for the product option. Defined by the platform.","example":"product-option-123456"},"option_values":{"type":"array","items":{"$ref":"#/components/schemas/deepOptionValue"}}}},"imageBase":{"type":"object","properties":{"name":{"description":"The image name.","type":"string","example":"Beach hat"},"src":{"description":"The image URL.","type":"string","example":"https://example.com/images/beach-hat.jpg"},"position":{"description":"The position in the `images` array.","type":"integer","format":"int64","example":1}}},"deepImage":{"type":"object","allOf":[{"$ref":"#/components/schemas/imageBase"}],"properties":{"platform_id":{"type":"string","description":"A unique identifier for the image. Defined by the platform.","example":"image-123456"}}},"product":{"type":"object","allOf":[{"$ref":"#/components/schemas/productBase"}],"properties":{"platform_id":{"type":"string","description":"A unique identifier for the product. Defined by the platform.","example":"product-123456"},"platform_updated_at":{"description":"The date the product was last updated on the platform.","type":"string","format":"date-time","example":"2019-08-24T14:15:22Z"},"categories":{"type":"array","items":{"$ref":"#/components/schemas/category"}},"variants":{"type":"array","description":"An array of `variant` objects. At least one variant is required. If the product has no variants, the variant can reuse the product information.","items":{"$ref":"#/components/schemas/deepVariant"}},"options":{"type":"array","description":"An array of product options.","items":{"$ref":"#/components/schemas/deepOption"}},"images":{"type":"array","description":"An array of images depicting the product.","items":{"$ref":"#/components/schemas/deepImage"}}},"required":["platform_id","platform_updated_at","variants"]},"productSavedRequestData":{"type":"object","properties":{"product":{"description":"The product object.","$ref":"#/components/schemas/product"}},"required":["product"]},"productSavedRequestBody":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/productSavedRequestData"}},"required":["data"]},"validationError":{"type":"object","properties":{"status_code":{"type":"number"},"errors":{"type":"array","items":{"type":"string"}}}},"runtimeErrorProduct":{"type":"object","properties":{"errors":{"type":"array","items":{"required":["code"],"type":"object","properties":{"code":{"type":"string","description":"The error code.","example":"07-1"},"message":{"type":"string","description":"The error message.","example":"Request failed due to an internal server error."},"type":{"type":"string","description":"The type of error.","example":"server.internal_error"}}}}}},"deletedProduct":{"type":"object","properties":{"platform_id":{"description":"The platform ID of the product to be deleted.","type":"string","example":"product-123456"},"platform_deleted_at":{"description":"The date the order was deleted on the platform, (in [RFC3339 format](https://datatracker.ietf.org/doc/html/rfc3339)). Assigned by the platform.","type":"string","format":"date-time","example":"2020-08-24T14:15:22Z"}},"required":["platform_id","platform_deleted_at"]},"productDeletedRequestData":{"type":"object","properties":{"product":{"$ref":"#/components/schemas/deletedProduct"}},"required":["product"]},"productDeletedRequestBody":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/productDeletedRequestData"}},"required":["data"]},"categorySavedRequestData":{"type":"object","properties":{"category":{"$ref":"#/components/schemas/category"}},"required":["category"]},"categorySavedRequestBody":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/categorySavedRequestData"}},"required":["data"]},"deletedCategory":{"type":"object","properties":{"platform_id":{"description":"The platform ID of the category to be deleted.","type":"string","example":"category-123456"},"platform_deleted_at":{"type":"string","format":"date-time","description":"The date and time this category was deleted on the platform, in [RFC 3339, section 5.6 format](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6).","example":"2019-09-24T14:15:22Z"}},"required":["platform_id","platform_deleted_at"]},"categoryDeletedRequestData":{"type":"object","properties":{"category":{"$ref":"#/components/schemas/deletedCategory"}},"required":["category"]},"categoryDeletedRequestBody":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/categoryDeletedRequestData"}},"required":["data"]},"protobufAny":{"type":"object","properties":{"type_url":{"type":"string","description":"A URL/resource name that uniquely identifies the type of the serialized\\nprotocol buffer message. This string must contain at least\\none \\"/\\" character. The last segment of the URL\'s path must represent\\nthe fully qualified name of the type (as in\\n`path/google.protobuf.Duration`). The name should be in a canonical form\\n(e.g., leading \\".\\" is not accepted).\\n\\nIn practice, teams usually precompile into the binary all types that they\\nexpect it to use in the context of Any. However, for URLs which use the\\nscheme `http`, `https`, or no scheme, one can optionally set up a type\\nserver that maps type URLs to message definitions as follows:\\n\\n* If no scheme is provided, `https` is assumed.\\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\\n  value in binary format, or produce an error.\\n* Applications are allowed to cache lookup results based on the\\n  URL, or have them precompiled into a binary to avoid any\\n  lookup. Therefore, binary compatibility needs to be preserved\\n  on changes to types. (Use versioned type names to manage\\n  breaking changes.)\\n\\nNote: this functionality is not currently available in the official\\nprotobuf release, and it is not used for type URLs beginning with\\ntype.googleapis.com.\\n\\nSchemes other than `http`, `https` (or the empty scheme) might be\\nused with implementation specific semantics."},"value":{"pattern":"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$","type":"string","description":"Must be a valid serialized protocol buffer of the above specified type.","format":"byte"}},"description":"`Any` contains an arbitrary serialized protocol buffer message along with a\\nURL that describes the type of the serialized message.\\n\\nProtobuf library provides support to pack/unpack Any values in the form\\nof utility functions or additional generated methods of the Any type.\\n\\nExample 1: Pack and unpack a message in C++.\\n\\n    Foo foo = ...;\\n    Any any;\\n    any.PackFrom(foo);\\n    ...\\n    if (any.UnpackTo(&foo)) {\\n      ...\\n    }\\n\\nExample 2: Pack and unpack a message in Java.\\n\\n    Foo foo = ...;\\n    Any any = Any.pack(foo);\\n    ...\\n    if (any.is(Foo.class)) {\\n      foo = any.unpack(Foo.class);\\n    }\\n\\n Example 3: Pack and unpack a message in Python.\\n\\n    foo = Foo(...)\\n    any = Any()\\n    any.Pack(foo)\\n    ...\\n    if any.Is(Foo.DESCRIPTOR):\\n      any.Unpack(foo)\\n      ...\\n\\n Example 4: Pack and unpack a message in Go\\n\\n     foo := &pb.Foo{...}\\n     any, err := ptypes.MarshalAny(foo)\\n     ...\\n     foo := &pb.Foo{}\\n     if err := ptypes.UnmarshalAny(any, foo); err != nil {\\n       ...\\n     }\\n\\nThe pack methods provided by protobuf library will by default use\\n\'type.googleapis.com/full.type.name\' as the type URL and the unpack\\nmethods only use the fully qualified type name after the last \'/\'\\nin the type URL, for example \\"foo.bar.com/x/y.z\\" will yield type\\nname \\"y.z\\".\\n\\n\\nJSON\\n====\\nThe JSON representation of an `Any` value uses the regular\\nrepresentation of the deserialized, embedded message, with an\\nadditional field `@type` which contains the type URL. Example:\\n\\n    package google.profile;\\n    message Person {\\n      string first_name = 1;\\n      string last_name = 2;\\n    }\\n\\n    {\\n      \\"@type\\": \\"type.googleapis.com/google.profile.Person\\",\\n      \\"firstName\\": <string>,\\n      \\"lastName\\": <string>\\n    }\\n\\nIf the embedded message type is well-known and has a custom JSON\\nrepresentation, that representation will be embedded adding a field\\n`value` which holds the custom JSON in addition to the `@type`\\nfield. Example (for message [google.protobuf.Duration][]):\\n\\n    {\\n      \\"@type\\": \\"type.googleapis.com/google.protobuf.Duration\\",\\n      \\"value\\": \\"1.212s\\"\\n    }"},"runtimeError":{"type":"object","properties":{"error":{"type":"string","description":"The error name.","example":"Runtime error."},"code":{"type":"integer","format":"int32","description":"The error code.","example":500},"message":{"type":"string","description":"The error message.","example":"Request failed due to an internal server error"},"details":{"type":"array","description":"Any details associated with the error.","items":{"$ref":"#/components/schemas/protobufAny"}}}},"v2PaginationResponse":{"type":"object","description":"The details about the pagination of the response.","properties":{"total":{"type":"integer","description":"The total number of results available.","format":"int32","example":143},"count":{"type":"integer","description":"The number of results returned.","format":"int32","example":143},"per_page":{"type":"integer","description":"The maximum number of results per page.","format":"int32","example":50},"current_page":{"type":"integer","description":"The current page index.","format":"int32","example":2},"total_pages":{"type":"integer","description":"The total number of pages available.","format":"int32","example":3},"next_url":{"type":"string","description":"The URL to fetch next page of results.","example":"https://api.boldcommerce.com/customers/v2/shops/zp3oafdor9/products?page=3"},"previous_url":{"type":"string","description":"The URL to fetch previous page of results.","example":"https://api.boldcommerce.com/customers/v2/shops/zp3oafdor9/products?page=1"}}},"shopIdentifierSchema":{"type":"string","description":"A unique identifier of the store. This can be retrieved by calling the [Get Shop Info](shops#tag/Shops/operation/GetShopInfo#) endpoint.","example":"zp3oafdor9"},"v2PlatformID":{"type":"object","properties":{"string_value":{"type":"string","description":"The unique human-readable identifier assigned by the shop platform.","example":"platform-123"},"int64_value":{"type":"integer","format":"int64","description":"The unique numeric identifier assigned by the shop platform.","example":123456}}},"v2Category":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier for this category. Assigned by Bold.","example":100},"shop_identifier":{"$ref":"#/components/schemas/shopIdentifierSchema"},"platform_id":{"$ref":"#/components/schemas/v2PlatformID"},"name":{"type":"string","description":"The category name.","example":"Hats"},"created_at":{"type":"string","format":"date-time","description":"The date (in [RFC3339 format](https://datatracker.ietf.org/doc/html/rfc3339)) the category was created.","example":"2021-11-04T19:09:52Z"},"updated_at":{"type":"string","format":"date-time","description":"The date (in [RFC3339 format](https://datatracker.ietf.org/doc/html/rfc3339)) the category was updated. If the category has not been updated, the value is the same as `created_at`.","example":"2021-11-04T19:09:52Z"},"image_url":{"type":"string","description":"The URL location of the category image.","example":"example.store.com/files/categories/hats.jpg"}}},"v2CategoryListResponse":{"type":"object","properties":{"pagination":{"$ref":"#/components/schemas/v2PaginationResponse"},"data":{"type":"array","items":{"$ref":"#/components/schemas/v2Category"}}}},"v2CategoryByXIDResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/v2Category"}}},"v2Product":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier for this product. Assigned by Bold.","example":123},"shop_identifier":{"$ref":"#/components/schemas/shopIdentifierSchema"},"platform_id":{"$ref":"#/components/schemas/v2PlatformID"},"name":{"type":"string","description":"The name of the product.","example":"Beach hat"},"handle":{"type":"string","description":"The name of the product reflected in the URL.","example":"beach-hat"},"description":{"type":"string","description":"The product description.","example":"A hat for the beach"},"type":{"type":"string","description":"The product type.","example":"Hat"},"vendor":{"type":"string","description":"The product vendor.","example":"OFS"},"inventory_quantity":{"type":"integer","format":"int64","description":"The current inventory level of the product.","example":5},"inventory_tracking_service":{"type":"string","description":"The service that tracks inventory.","example":"platform"},"inventory_tracking_entity":{"type":"string","description":"The entity on which inventory is tracked.","enum":["variant","product","none"],"example":"product"},"tags":{"type":"string","description":"The product tags.","example":"hat, summer, beach"},"created_at":{"type":"string","format":"date-time","description":"The date (in [RFC3339 format](https://datatracker.ietf.org/doc/html/rfc3339)) the product was created.","example":"2021-11-04T19:09:52Z"},"updated_at":{"type":"string","format":"date-time","description":"The date (in [RFC3339 format](https://datatracker.ietf.org/doc/html/rfc3339)) the product was updated. If the product has not been updated, the value is the same as `created_at`.","example":"2021-11-04T19:09:52Z"},"published":{"type":"boolean","format":"boolean","description":"Indicates whether the product is published on the storefront.","example":true},"url":{"type":"string","description":"The product URL.","example":"example.store.com/files/products/hats/beach-hat.jpg"},"tax_code":{"type":"string","description":"The tax code for the variant.","example":"non-taxable"},"localized_names":{"type":"object","description":"A map of localized names for the variant. The field is the [ISO-639](https://www.iso.org/iso-639-language-codes.html) two character language code. The value is the product name in the given language.","additionalProperties":{"type":"string"},"example":{"en":"Purple","fr":"Violette"}},"localized_descriptions":{"type":"object","description":"A map of localized descriptions for the variant. The field is the [ISO-639](https://www.iso.org/iso-639-language-codes.html) two character language code. The value is the product description in the given language.","additionalProperties":{"type":"string"},"example":{"en":"A hat for the beach","fr":"Un chapeau pour la plage"}}}},"v2Image":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier for this image. Assigned by Bold.","example":456},"shop_identifier":{"$ref":"#/components/schemas/shopIdentifierSchema"},"platform_id":{"$ref":"#/components/schemas/v2PlatformID"},"platform_product_id":{"$ref":"#/components/schemas/v2PlatformID"},"src":{"type":"string","description":"The image URL.","example":"https://example.com/images/beach-hat.jpg"},"position":{"description":"The position in the `images` array.","type":"integer","format":"int64","example":1},"created_at":{"type":"string","format":"date-time","description":"The date (in [RFC3339 format](https://datatracker.ietf.org/doc/html/rfc3339)) the image was created.","example":"2021-11-04T19:09:52Z"},"updated_at":{"type":"string","format":"date-time","description":"The date (in [RFC3339 format](https://datatracker.ietf.org/doc/html/rfc3339)) the image was updated. If the image has not been updated, the value is the same as `created_at`.","example":"2021-11-04T19:09:52Z"}}},"v2VariantOptionValue":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier for the variant option value. Assigned by Bold.","example":5},"shop_identifier":{"$ref":"#/components/schemas/shopIdentifierSchema"},"platform_id":{"$ref":"#/components/schemas/v2PlatformID"},"platform_option_id":{"$ref":"#/components/schemas/v2PlatformID"},"platform_variant_id":{"$ref":"#/components/schemas/v2PlatformID"},"label":{"type":"string","description":"The label of the option value.","example":"Small"},"created_at":{"type":"string","format":"date-time","description":"The date (in [RFC3339 format](https://datatracker.ietf.org/doc/html/rfc3339)) the variant option value was created.","example":"2021-11-04T19:09:52Z"},"updated_at":{"type":"string","format":"date-time","description":"The date (in [RFC3339 format](https://datatracker.ietf.org/doc/html/rfc3339)) the variant option value was updated. If the variant option has not been updated, the value is the same as `created_at`.","example":"2021-11-04T19:09:52Z"}}},"v2Variant":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier for this variant. Assigned by Bold.","example":789},"shop_identifier":{"$ref":"#/components/schemas/shopIdentifierSchema"},"platform_id":{"$ref":"#/components/schemas/v2PlatformID"},"platform_product_id":{"$ref":"#/components/schemas/v2PlatformID"},"name":{"type":"string","description":"The name of the variant. If there is only one variant, the `name` must be \\"Default Title\\" in order to avoid displaying the same `name` twice.","example":"Default Title"},"sku":{"type":"string","description":"The variant SKU.","example":"BEACH-HAT-PURPLE"},"weight_unit":{"type":"string","description":"The unit of measurement that applies to the variant\'s weight.","example":"kg"},"grams":{"type":"integer","format":"int64","description":"The weight of the variant in grams.","example":1000},"image_id":{"type":"integer","format":"int64","description":"The image identifier.","example":321},"image_url":{"type":"string","description":"The URL of the variant image.","example":"example.store.com/files/products/hats/purple-beach-hat.jpg"},"inventory_quantity":{"type":"integer","format":"int64","description":"The current inventory level of the product.","example":5},"allow_backorder":{"type":"boolean","format":"boolean","description":"Indicates whether backorders of the variant is allowed.","example":true},"inventory_tracking_service":{"type":"string","description":"The service that tracks inventory.","example":"platform"},"inventory_tracking_entity":{"type":"string","description":"The entity on which inventory of the variant is tracked.","enum":["variant","product","none"],"example":"product"},"created_at":{"type":"string","format":"date-time","description":"The date (in [RFC3339 format](https://datatracker.ietf.org/doc/html/rfc3339)) the variant was created.","example":"2021-11-04T19:09:52Z"},"updated_at":{"type":"string","format":"date-time","description":"The date (in [RFC3339 format](https://datatracker.ietf.org/doc/html/rfc3339)) the variant was updated. If the variant has not been updated, the value is the same as `created_at`.","example":"2021-11-04T19:09:52Z"},"require_shipping":{"type":"boolean","format":"boolean","description":"Indicates if the variant needs to be shipped.","example":true},"price":{"type":"number","format":"byte","description":"The base price of the variant with no adjustments or sales.","example":30},"cost":{"type":"number","format":"byte","description":"The price of the variant after adjustments or sales.","example":25},"compare_at_price":{"type":"number","format":"byte","description":"The original price of the variant before an adjustment or a sale.","example":30},"tax_code":{"type":"string","description":"The tax code for the variant.","example":"non-taxable"},"weight":{"type":"number","format":"byte","description":"The weight of the variant, calculated with `weight_unit` specified.","example":1},"tax_exempt":{"type":"boolean","format":"boolean","description":"Indicates whether the variant is tax-exempt.","example":true},"option_values":{"type":"array","description":"The list of option values associated with the variant.","items":{"$ref":"#/components/schemas/v2VariantOptionValue"}},"localized_names":{"type":"object","description":"A map of localized names for the variant. The field is the [ISO-639](https://www.iso.org/iso-639-language-codes.html) two character language code. The value is the product name in the given language.","additionalProperties":{"type":"string"},"example":{"en":"Purple","fr":"Violette"}}}},"v2OptionValue":{"type":"object","properties":{"shop_identifier":{"$ref":"#/components/schemas/shopIdentifierSchema"},"label":{"type":"string","description":"The label of the option value.","example":"Small"},"is_default":{"type":"boolean","format":"boolean","description":"Indicates whether this is the default option value.","example":true},"id":{"type":"integer","format":"int64","description":"The unique identifier for this option value. Assigned by Bold.","example":143},"position":{"type":"integer","format":"int64","description":"The position in the `option_values` array.","example":1},"created_at":{"type":"string","format":"date-time","description":"The date (in [RFC3339 format](https://datatracker.ietf.org/doc/html/rfc3339)) the option value was created.","example":"2021-11-04T19:09:52Z"},"updated_at":{"type":"string","format":"date-time","description":"The date (in [RFC3339 format](https://datatracker.ietf.org/doc/html/rfc3339)) the option value was updated. If the option value has not been updated, the value is the same as `created_at`.","example":"2021-11-04T19:09:52Z"},"platform_id":{"$ref":"#/components/schemas/v2PlatformID"},"platform_product_option_id":{"$ref":"#/components/schemas/v2PlatformID"}}},"v2Option":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier for this option. Assigned by Bold.","example":900},"shop_identifier":{"$ref":"#/components/schemas/shopIdentifierSchema"},"platform_id":{"$ref":"#/components/schemas/v2PlatformID"},"platform_option_id":{"$ref":"#/components/schemas/v2PlatformID"},"platform_product_id":{"$ref":"#/components/schemas/v2PlatformID"},"name":{"type":"string","description":"The option name.","example":"Small"},"position":{"type":"integer","format":"int64","description":"The position in the `options` array.","example":1},"created_at":{"type":"string","format":"date-time","description":"The date (in [RFC3339 format](https://datatracker.ietf.org/doc/html/rfc3339)) the option was created.","example":"2021-11-04T19:09:52Z"},"updated_at":{"type":"string","format":"date-time","description":"The date (in [RFC3339 format](https://datatracker.ietf.org/doc/html/rfc3339)) the option was updated. If the option has not been updated, the value is the same as `created_at`.","example":"2021-11-04T19:09:52Z"},"values":{"type":"array","items":{"$ref":"#/components/schemas/v2OptionValue"}}}},"v2DeepProduct":{"type":"object","properties":{"product":{"$ref":"#/components/schemas/v2Product"},"images":{"description":"The images associated with the product.\\n\\nIncluded in the response when the query parameter `deep` is set to `true`.","type":"array","items":{"$ref":"#/components/schemas/v2Image"}},"variants":{"description":"The variants associated with the product.\\n\\nIncluded in the response when the query parameter `deep` is set to `true`.","type":"array","items":{"$ref":"#/components/schemas/v2Variant"}},"options":{"description":"The options associated with the product.\\n\\nIncluded in the response when the query parameter `deep` is set to `true`.","type":"array","items":{"$ref":"#/components/schemas/v2Option"}},"categories":{"description":"The categories associated with the product.\\n\\nIncluded in the response when the query parameter `deep` is set to `true`.","type":"array","items":{"$ref":"#/components/schemas/v2Category"}}}},"v2ProductListResponse":{"type":"object","properties":{"pagination":{"$ref":"#/components/schemas/v2PaginationResponse"},"data":{"type":"array","items":{"$ref":"#/components/schemas/v2DeepProduct"}}}},"v2ProductCategory":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier for this product category. Assigned by Bold.","example":10},"shop_identifier":{"$ref":"#/components/schemas/shopIdentifierSchema"},"platform_category_id":{"$ref":"#/components/schemas/v2PlatformID"},"platform_product_id":{"$ref":"#/components/schemas/v2PlatformID"},"created_at":{"type":"string","format":"date-time","description":"The date (in [RFC3339 format](https://datatracker.ietf.org/doc/html/rfc3339)) the product category was created.","example":"2021-11-04T19:09:52Z"},"updated_at":{"type":"string","format":"date-time","description":"The date (in [RFC3339 format](https://datatracker.ietf.org/doc/html/rfc3339)) the product category was updated. If the product category has not been updated, the value is the same as `created_at`.","example":"2021-11-04T19:09:52Z"}}},"v2ProductCategoryListResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2ProductCategory"}},"pagination":{"$ref":"#/components/schemas/v2PaginationResponse"}}},"v2ProductByXIDResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/v2DeepProduct"}}},"v2ImageListResponse":{"type":"object","properties":{"pagination":{"$ref":"#/components/schemas/v2PaginationResponse"},"data":{"type":"array","items":{"$ref":"#/components/schemas/v2Image"}}}},"v2ImageByXIDResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/v2Image"}}},"v2OptionListResponse":{"type":"object","properties":{"pagination":{"$ref":"#/components/schemas/v2PaginationResponse"},"data":{"type":"array","items":{"$ref":"#/components/schemas/v2Option"}}}},"v2OptionByXIDResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/v2Option"}}},"v2VariantListResponse":{"type":"object","properties":{"pagination":{"$ref":"#/components/schemas/v2PaginationResponse"},"data":{"type":"array","items":{"$ref":"#/components/schemas/v2Variant"}}}},"v2VariantByXIDResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/v2Variant"}}},"v2ProductTypeListResponse":{"type":"object","properties":{"type":{"type":"string","description":"The product type.","example":"Hat"},"data":{"type":"array","items":{"type":"string"}}}},"v2AllVariantsListResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2Variant"}},"pagination":{"$ref":"#/components/schemas/v2PaginationResponse"}}},"v2VendorListResponse":{"type":"object","properties":{"type":{"type":"string"},"data":{"type":"array","items":{"type":"string"}}}}}}}},"plugin-redoc-8":{"url":"/api/shops.openapi.yaml","themeId":"theme-redoc","isSpecFile":true,"spec":{"openapi":"3.0.0","info":{"title":"Shops","version":"2.0.0","description":"This API allows you to get information about your shop.\\n\\nRefer to the <a href=\\"https://developer.boldcommerce.com/changelog\\">changelog</a> for the latest updates to this API.","termsOfService":"https://boldcommerce.com/terms-of-service","contact":{"name":"Contact Us","url":"https://developer-dashboard.boldcommerce.com/default/contactus"}},"servers":[{"url":"https://api.boldcommerce.com"}],"security":[{"OAuthToken":["read_shops"]},{"APIAccessToken":[]}],"tags":[{"name":"Integrations","description":"Manages integrations for a given shop."},{"name":"Shops","description":"Contains information about a shop. Use these endpoints to retrieve information about a given shop."}],"paths":{"/integrations/v1/shops/{shop_identifier}/installs/{client_id}":{"parameters":[{"$ref":"#/components/parameters/shopIdentifier"},{"$ref":"#/components/parameters/clientId"}],"delete":{"tags":["Integrations"],"summary":"Uninstall Integration","operationId":"UninstallIntegration","description":"Uninstalls a public integration for a specific shop by the issued `client_id`. For the `client_id`, use your public integration\'s Client ID value, which can be found in the [Developer Dashboard](https://developer-dashboard.boldcommerce.com/default/dashboard). The access token used to authenticate this request must belong to the public integration matching the given `client_id`. For more information, refer to [Build Public Integrations](/guides/checkout/public-integrations#exchange-code-for-an-api-access-token).","security":[{}],"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"type":"object"}}}},"403":{"description":"The supplied credentials are not allowed to uninstall this integration on this shop, possibly because they were not used for the correlated install.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"uninstallForbidden":{"$ref":"#/components/examples/uninstallForbidden"}}}}},"404":{"description":"The integration install specified by `client_id` was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"installationNotFound":{"$ref":"#/components/examples/installationNotFound"}}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultError"},"examples":{"internalError":{"$ref":"#/components/examples/internalError"}}}}}}}},"/shops/v1/info":{"get":{"summary":"Get Shop Info","operationId":"GetShopInfo","tags":["Shops"],"description":"Gets information about the current shop.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShopInfo"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"Missing Access Token":{"value":{"error":"invalid_request","error_description":"The access token is missing"}},"Invalid Or Expired Access Token":{"value":{"error":"invalid_token","error_description":"The access token is invalid or has expired"}}}}}},"404":{"description":"Shop Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultError"},"example":{"status_code":404,"errors":["not found"]}}}},"500":{"description":"Internal Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultError"},"example":{"status_code":500,"errors":["internal error"]}}}}}}}},"components":{"securitySchemes":{"OAuthToken":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://apps.boldapps.net/accounts/dashboard/authorize","tokenUrl":"https://api.boldcommerce.com/auth/oauth2/token","scopes":{"read_shops":"Read shop information."}}},"description":"Authenticates an API request from a [public integration](/guides/checkout/resources/glossary#public-integration). Generate this token in the [Developer Dashboard](https://developer-dashboard.boldcommerce.com/default/dashboard). Refer to [Build Public Integrations](/guides/checkout/public-integrations) for more information."},"APIAccessToken":{"type":"apiKey","name":"API Access Token","in":"header","description":"Authenticates an API request from a [private integration](/guides/checkout/resources/glossary#private-integration). Generate this token in the [Bold Account Center](https://account.boldcommerce.com/). Refer to [Making API Calls](/guides/checkout/quick-start) for more information."}},"schemas":{"ShopInfo":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"Bold\'s internal-only shop identifier.","example":3654},"shop_identifier":{"type":"string","description":"The platform-specific shop identifier. Use this value in all API calls to identify your store.","example":"zp3oafdor9"},"organization_id":{"type":"integer","description":"The shop organization ID. If `organization_id` is `0`, the shop is not connected to a Bold Account Center organization.","example":142},"shop_domain":{"type":"string","description":"The shop domain.","example":"store-zp3oafdor9.mybigcommerce.com"},"custom_domain":{"type":"string","description":"The shop\'s custom domain.","example":"example.bigcommerce.com"},"platform_slug":{"type":"string","description":"The platform name. Possible values are \\"bigcommerce\\", \\"commercetools\\", \\"shopify\\", \\"woocommerce\\", and \\"custom\\".","example":"bigcommerce"},"shop_owner":{"type":"string","description":"The shop owner, taken from the shop platform.","example":"John Doe"},"store_name":{"type":"string","description":"The shop name, taken from the shop platform.","example":"acme-inc"},"admin_email":{"type":"string","description":"The email for the shop administrator, used when creating the shop.","example":"admin@example.com"},"order_email":{"type":"string","description":"The email used to send orders. Only used for BigCommerce.","example":"orders@example.com"},"currency":{"type":"string","description":"The shop\'s selected currency, using [ISO-4217](https://www.iso.org/iso-4217-currency-codes.html) standards.","example":"CAD"},"currency_symbol":{"type":"string","description":"The symbol of the shop currency.","example":"$"},"money_format":{"type":"string","description":"The format for displaying currency.","example":"${{amount}}"},"address":{"type":"string","description":"The shop\'s street address.","example":"50 Fultz Blvd"},"address_2":{"type":"string","description":"Any additional street address details (apt #, suite #, etc) for the shop.","example":"Suite 200"},"city":{"type":"string","description":"The name of the shop\'s city.","example":"Winnipeg"},"province":{"type":"string","description":"The name of the shop\'s province.","example":"Manitoba"},"country":{"type":"string","description":"The name of the shop\'s country.","example":"Canada"},"country_code":{"type":"string","description":"The shop\'s country code, using [ISO-3166](https://www.iso.org/iso-3166-country-codes.html) format.","example":"CA"},"postal_code":{"type":"string","description":"The shop\'s postal/zip code. Required for most countries, including the United States, Canada, and Mexico.","example":"R3Y0L6"},"timezone":{"type":"string","description":"The shop timezone.","example":"America/New_York"},"phone":{"type":"string","description":"The phone number of the shop.","example":"8005550101"},"locale":{"type":"string","description":"The shop locale, in [ISO-639-1 format](https://www.iso.org/standard/22109.html).","example":"en"},"plan_name":{"type":"string","description":"The name of the shop\'s service plan. For more information on how Bold uses a shop\'s service plan, see the [rate limiting reference page](/guides/checkout/resources/rate-limiting#rate-limits-by-platform).","example":"Sandbox_Store"},"plan_level":{"type":"string","description":"The name of the shop\'s platform partner level. Possible values depend on the shop platform.","example":"affiliate"},"platform_status":{"type":"string","description":"The shop\'s platform status.","example":"active"},"is_price_entered_with_tax":{"type":"boolean","description":"If the price for a cart at checkout is entered with tax included.","example":false},"weight_unit":{"type":"string","description":"The abbreviated unit of measurement for weight of a shop product (e.g. \\"g\\", \\"lb\\", \\"oz\\".) If the shop does not sell physical items, the `weight_unit` is an empty string (`\\"\\"`).","example":""},"created_at":{"type":"string","format":"datetime","description":"The date and time the shop was created, in [RFC 3339, section 5.6 format](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6).","example":"2023-03-01T03:00:48Z"},"updated_at":{"type":"string","format":"datetime","description":"The date and time the shop was updated, in [RFC 3339, section 5.6 format](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6).","example":"2023-03-30T03:00:48Z"},"platform_updated_at":{"type":"string","format":"datetime","description":"The date and time the platform was updated, in [RFC 3339, section 5.6 format](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6).","example":"2022-07-26T15:35:22Z"},"redacted_at":{"type":"string","format":"datetime","nullable":true,"description":"The date and time the shop was redacted, in [RFC 3339, section 5.6 format](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6). This value is `null` if the store is not redacted.","example":null},"sync_status":{"type":"string","description":"The sync status between the shop and Bold."},"setup_required":{"type":"boolean","description":"Indicates whether the shop requires setup.","example":false},"password_enabled":{"type":"boolean","description":"Indicates whether the shop requires a password for customers to access.","example":false},"pre_launch_enabled":{"type":"boolean","description":"Indicates whether pre-launch is enabled for the shop. Shopify only. See more information on the [Shopify pre-launch reference page](https://www.shopify.com/ca/blog/coming-soon-page).","example":false},"has_storefront":{"type":"boolean","description":"If the shop has a physical storefront.","example":true},"base_url":{"type":"string","nullable":true,"description":"The base URL for the shop. `base_url` is `null` if the shop does not have a custom accessible base URL.","example":null},"api_base_url":{"type":"string","nullable":true,"description":"The base API URL for the shop. `api_base_url` is `null` if the shop does not have an accessible API URL.","example":null},"auth_base_url":{"type":"string","nullable":true,"description":"The base authorization URL for the shop. `auth_base_url` is `null` if the shop does not have an accessible base authorization URL.","example":null},"tax_rounding_mode":{"type":"string","nullable":true,"description":"The tax rounding mode for the shop. `tax_rounding_mode` is `null` if no tax rounding mode is set.","example":null},"inventory_control":{"type":"string","nullable":true,"description":"The inventory control method for the shop. `inventory_control` is `null` if no inventory control method is set.","example":null},"currency_precision":{"type":"string","nullable":true,"description":"The currency precision setting for the shop. `currency_precision` is `null` if no currency precision value is set.","example":null},"shop_enabled":{"type":"boolean","description":"Indicates whether the shop is currently receiving traffic. Supported by BigCommerce and Shopify.","example":true},"has_ac_shop_platform_creds":{"type":"boolean","description":"Indicates whether the shop has shop platform credentials in Bold Account Center.","example":true}}},"Error":{"type":"object","properties":{"error":{"type":"string","description":"The error name.","example":"invalid_token"},"error_description":{"type":"string","description":"The error description.","example":"The access token is invalid or has expired"}}},"DefaultError":{"type":"object","properties":{"status_code":{"type":"integer","description":"The status code for the error.","example":404},"errors":{"type":"array","description":"Any messages associated with the error.","items":{"type":"string"},"example":["not found"]}}}},"parameters":{"shopIdentifier":{"name":"shop_identifier","in":"path","description":"Unique identifier of the store. Retrieve this information by calling the [Get Shop Info](shops#tag/Shop/operation/GetShopInfo) endpoint.","required":true,"schema":{"type":"string"},"example":"abc123def456"},"clientId":{"name":"client_id","in":"path","description":"Unique identifier of an integration installed on a store. Available in the response during the initial installation of an integration.","required":true,"schema":{"type":"string"},"example":"SEY7wXUZZHq57gjeKs4DmnHyeMsSO2AF"}},"examples":{"installationNotFound":{"value":{"status_code":404,"errors":["Integration installation not found."]}},"uninstallForbidden":{"value":{"status_code":403,"errors":["Failed to uninstall integration due to insufficient privileges"]}},"internalError":{"value":{"status_code":500,"errors":["Request failed due to an internal server error"]}}}}}},"plugin-redoc-9":{"url":"/api/subscriptions.openapi.yaml","themeId":"theme-redoc","isSpecFile":true,"spec":{"openapi":"3.0.0","info":{"title":"Bold Subscriptions","version":"1.0","description":"Bold Subscriptions customers use our API to interact with subscription data in unique ways. This includes the ability to modify, cancel, and report on subscriptions.\\n\\nRefer to the <a href=\\"https://developer.boldcommerce.com/changelog/tags/subscriptions\\">changelog</a> for the latest updates to this API.","termsOfService":"https://boldcommerce.com/terms-of-service","contact":{"name":"Contact Us","url":"https://developer-dashboard.boldcommerce.com/default/contactus"}},"servers":[{"url":"https://api.boldcommerce.com"}],"security":[{"OAuthToken":[]},{"APIAccessToken":[]}],"tags":[{"name":"Subscriptions","description":"Contains information about subscriptions for your store and data associated with them. Use these endpoints to get, remove, edit, or list subscriptions."},{"name":"Subscription Groups","description":"Contains information about subscription groups for your store, including shop ID and subscription group configuration. Use these endpoints to add, remove, edit, or list subscription groups."},{"name":"Subscription Line Items","description":"A child resource of Subscriptions. Contains information about line items in a subscription, including price, details, and swappable products. Use these endpoints to get, remove, edit, or list line items for subscriptions."},{"name":"Subscription Orders","description":"A child resource of Subscriptions. Contains information about orders in a subscription, including schedules, order histories, and current orders. Use these endpoints to list, get, skip, or unskip orders."},{"name":"Subscription Adjustments","description":"A child resource of Subscriptions. Contains information about future adjustments to a subscription or its orders. Use these endpoints to create, list, or delete adjustments for a subscription."},{"name":"Future Orders","description":"Contains information about future orders for subscriptions. Use these endpoints to list future orders for a shop or individual subscriptions."},{"name":"Convertible Adjustments","description":"Use these endpoints to create, update, or delete convertible adjustment plans, enabling automatic product conversions on subscription line items attached to a created plan."},{"name":"Customers","description":"A child resource of Subscriptions. Contains information about customers for a subscription. Use these endpoints to manage customer data for a specific subscription."},{"name":"Payment Methods","description":"A child resource of Subscriptions. Contains information about payment methods for subscriptions, including public payment IDs, alternate payment methods, and available methods. Use these endpoints to get, remove, edit, and list payment methods associated with a subscription."},{"name":"Shops","description":"Contains information about your store, including store IDs, domains, platform, and admin configuration. Use these endpoints to manage store information and settings."},{"name":"Webhook Events","description":"Contains information about webhook events, including webhook event ID, attempts, and webhook event metadata. Use these endpoints to get webhook event information."},{"name":"Webhook Subscriptions","description":"Contains webhook metadata. Use these endpoints to add, remove, edit, or list webhook subscriptions."},{"name":"Webhook Topics","description":"Contains information about webhook topics. Use these endpoints to list all possible webhook topics."}],"externalDocs":{"description":"For more information about Subscriptions, refer to the Overview.","url":"https://developer.boldcommerce.com/guides/subscriptions-v2"},"paths":{"/subscriptions/v1/shops/{shop_identifier}/customers":{"parameters":[{"$ref":"#/components/parameters/shop_identifier_path_param"}],"get":{"tags":["Customers"],"summary":"List Customers","operationId":"ListCustomers","description":"Retrieve a list of customers.","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Customers"}}}},"401":{"description":"Unauthenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthenticatedResponse"}}}}},"parameters":[{"$ref":"#/components/parameters/customerSearch"},{"$ref":"#/components/parameters/customerStatus"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}]}},"/subscriptions/v1/shops/{shop_identifier}/customers/{customer_id}":{"parameters":[{"$ref":"#/components/parameters/shop_identifier_path_param"},{"$ref":"#/components/parameters/customer_id_path_param"}],"get":{"tags":["Customers"],"summary":"Get Customer","operationId":"GetCustomer","description":"Retrieve a customer by their id.","parameters":[{"$ref":"#/components/parameters/shop_identifier_path_param"},{"$ref":"#/components/parameters/customer_id_path_param"}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Customer"}}}},"401":{"description":"Unauthenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthenticatedResponse"}}}}}},"put":{"tags":["Customers"],"summary":"Update Customer","operationId":"UpdateCustomer","description":"Update a customer by their id.","parameters":[{"$ref":"#/components/parameters/shop_identifier_path_param"},{"$ref":"#/components/parameters/customer_id_path_param"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Customer"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Customer"}}}},"401":{"description":"Unauthenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthenticatedResponse"}}}}}}},"/subscriptions/v1/shops/{shop_identifier}/customers/{customer_id}/addresses":{"parameters":[{"$ref":"#/components/parameters/shop_identifier_path_param"},{"$ref":"#/components/parameters/customer_id_path_param"}],"get":{"tags":["Customers"],"summary":"List Customer Addresses","operationId":"ListCustomerAddresses","description":"Retrieve a list of addresses for a customer.","parameters":[{"$ref":"#/components/parameters/shop_identifier_path_param"},{"$ref":"#/components/parameters/customer_id_path_param"}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"customer_addresses":{"type":"array","items":{"$ref":"#/components/schemas/CustomerAddressEntity"}}}}}}},"401":{"description":"Unauthenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthenticatedResponse"}}}}}},"post":{"tags":["Customers"],"summary":"Create Customer Address","operationId":"CreateCustomerAddress","description":"Create an address for a customer.","parameters":[{"$ref":"#/components/parameters/shop_identifier_path_param"},{"$ref":"#/components/parameters/customer_id_path_param"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"customer_address":{"$ref":"#/components/schemas/UpdateCustomerAddressEntity"}}}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"customer_address":{"$ref":"#/components/schemas/CustomerAddressEntity"}}}}}},"401":{"description":"Unauthenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthenticatedResponse"}}}}}}},"/subscriptions/v1/shops/{shop_identifier}/customers/{customer_id}/addresses/{address_id}":{"parameters":[{"$ref":"#/components/parameters/shop_identifier_path_param"},{"$ref":"#/components/parameters/customer_id_path_param"},{"$ref":"#/components/parameters/address_id_path_param"}],"put":{"tags":["Customers"],"summary":"Update Customer Address","operationId":"UpdateCustomerAddress","description":"Update an address for a customer.","parameters":[{"$ref":"#/components/parameters/shop_identifier_path_param"},{"$ref":"#/components/parameters/customer_id_path_param"},{"$ref":"#/components/parameters/address_id_path_param"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"customer_address":{"$ref":"#/components/schemas/UpdateCustomerAddressEntity"}}}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"customer_address":{"$ref":"#/components/schemas/CustomerAddressEntity"}}}}}},"401":{"description":"Unauthenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthenticatedResponse"}}}}}},"delete":{"tags":["Customers"],"summary":"Delete Customer Address","operationId":"DeleteCustomerAddress","description":"Delete an address from a customer.","parameters":[{"$ref":"#/components/parameters/shop_identifier_path_param"},{"$ref":"#/components/parameters/customer_id_path_param"},{"$ref":"#/components/parameters/address_id_path_param"}],"responses":{"200":{"description":"Successful operation"},"401":{"description":"Unauthenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthenticatedResponse"}}}}}}},"/subscriptions/v1/shops/{shop_identifier}/shop":{"get":{"tags":["Shops"],"summary":"Get Shop Info","description":"Retrieve basic information about a shop.","operationId":"GetShopInfo","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Shop"}}}},"401":{"description":"Unauthenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthenticatedResponse"}}}}}},"parameters":[{"$ref":"#/components/parameters/shop_identifier_path_param"}]},"/subscriptions/v1/shops/{shop_identifier}/subscriptions":{"get":{"tags":["Subscriptions"],"summary":"List Subscriptions","operationId":"ListSubscriptions","description":"Retrieve a list of subscriptions.","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListSubscriptions"}}}},"401":{"description":"Unauthenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthenticatedResponse"}}}}},"parameters":[{"$ref":"#/components/parameters/shop_identifier_path_param"},{"schema":{"enum":["active","inactive","processing","scheduled","paused"],"example":"active"},"in":"query","name":"subscription_status","description":"Status of the subscriptions returned. Multiple statuses can be passed as an array."},{"schema":{"example":"1"},"in":"query","name":"bold_platform_customer_id","description":"Customer Id of the subscriptions returned. Multiple customer ids can be passed as an array."},{"schema":{"type":"string","example":"customer","enum":["customer"]},"in":"query","name":"expand","description":"Fields to expand on the subscription. Multiple fields can be passed as an array"},{"schema":{"type":"integer","example":5},"in":"query","name":"limit","description":"Maximum number of results to be returned"},{"schema":{"type":"string","example":"?filter=lt(next_order_datetime:2021-11-15T00:00:00Z)+gt(next_order_datetime:2021-10-31T00:00:00Z)"},"in":"query","name":"filter","description":"Accepts filtering options as described on the [Query & Pagination page](/guides/subscriptions-v2/resources/query-pagination). For example, to filter the next order date by a date interval, you could use the following parameter: "},{"schema":{"type":"string","example":"?cursor= P3NpbmNlX2lkPTE1Mjc0Jm9yZGVyX2J5PWlkJm9yZGVyX2RpcmVjdGlvbj1kZXNj"},"in":"query","name":"cursor","description":"Returns the next page of results if supplied the `next` value from the previous pagination results."}]},"post":{"tags":["Subscriptions"],"summary":"Create Subscription","operationId":"CreateSubscription","description":"For more information about this endpoint, refer to [Create Subscriptions](/guides/subscriptions-v2/create-subscription).","parameters":[{"$ref":"#/components/parameters/shop_identifier_path_param"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSubscriptionEntity"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Subscription"}}}},"401":{"description":"Unauthenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthenticatedResponse"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSubscriptionError422"}}}}}}},"/subscriptions/v1/shops/{shop_identifier}/customers/{customer_id}/subscriptions":{"get":{"tags":["Customers"],"summary":"List Customer Subscriptions","operationId":"ListCustomerSubscriptions","description":"Retrieve a list of subscriptions for a single customer.","parameters":[{"$ref":"#/components/parameters/shop_identifier_path_param"},{"$ref":"#/components/parameters/customer_id_path_param"}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Subscriptions"}}}},"401":{"description":"Unauthenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthenticatedResponse"}}}}}}},"/subscriptions/v1/shops/{shop_identifier}/subscriptions/{subscription_id}/discount_code":{"put":{"tags":["Subscriptions"],"summary":"Update Discount Code","operationId":"UpdateDiscountCode","description":"Update the discount code applied to a subscription.","parameters":[{"$ref":"#/components/parameters/shop_identifier_path_param"},{"$ref":"#/components/parameters/subscription_id_path_param"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"discount_code":{"type":"string","example":"HOLIDAY10"}},"required":["discount_code"]}}}},"responses":{"200":{"description":"Successful operation"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}},"example":{"errors":["subscription not found"]}},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}},"example":{"errors":["Discount code \\"HOLIDAY10\\" rejected with reason: EXPIRED"]}}]}}}}}},"delete":{"tags":["Subscriptions"],"summary":"Remove Discount Code","operationId":"RemoveDiscountCode","description":"Remove the discount code from a subscription.","parameters":[{"$ref":"#/components/parameters/shop_identifier_path_param"},{"$ref":"#/components/parameters/subscription_id_path_param"}],"responses":{"200":{"description":"Successful operation"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}},"example":{"errors":["subscription not found"]}}}}}}}},"/subscriptions/v1/shops/{shop_identifier}/subscriptions/{subscription_id}":{"get":{"tags":["Subscriptions"],"summary":"Get Subscription","operationId":"GetSubscription","description":"Retrieve a subscription by its id.","parameters":[{"$ref":"#/components/parameters/shop_identifier_path_param"},{"$ref":"#/components/parameters/subscription_id_path_param"}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Subscription"}}}},"401":{"description":"Unauthenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthenticatedResponse"}}}}}},"put":{"tags":["Subscriptions"],"summary":"Update Subscription","operationId":"UpdateSubscription","description":"Update a subscription by its id.","parameters":[{"$ref":"#/components/parameters/shop_identifier_path_param"},{"$ref":"#/components/parameters/subscription_id_path_param"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Subscription"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Subscription"}}}},"401":{"description":"Unauthenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthenticatedResponse"}}}}}},"patch":{"tags":["Subscriptions"],"summary":"Partial Update Subscription","operationId":"PartialUpdateSubscription","description":"Partially update a subscription by its id.","parameters":[{"$ref":"#/components/parameters/shop_identifier_path_param"},{"$ref":"#/components/parameters/subscription_id_path_param"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartialUpdateSubscription"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Subscription"}}}},"401":{"description":"Unauthenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthenticatedResponse"}}}}}}},"/subscriptions/v1/shops/{shop_identifier}/subscriptions/{subscription_id}/intervals":{"get":{"tags":["Subscriptions"],"summary":"List Subscription Intervals","operationId":"ListSubscriptionIntervals","description":"Retrieve a list of available intervals for a subscription.","parameters":[{"$ref":"#/components/parameters/shop_identifier_path_param"},{"$ref":"#/components/parameters/subscription_id_path_param"}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Intervals"}}}},"401":{"description":"Unauthenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthenticatedResponse"}}}}}}},"/subscriptions/v1/shops/{shop_identifier}/subscriptions/{subscription_id}/interval/{subscription_interval_id}":{"put":{"tags":["Subscriptions"],"summary":"Update Subscription Interval","operationId":"UpdateSubscriptionInterval","description":"Update the interval of a subscription.","parameters":[{"$ref":"#/components/parameters/shop_identifier_path_param"},{"$ref":"#/components/parameters/subscription_interval_id_path_param"},{"$ref":"#/components/parameters/subscription_id_path_param"}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Subscription"}}}},"401":{"description":"Unauthenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthenticatedResponse"}}}}}}},"/subscriptions/v1/shops/{shop_identifier}/subscriptions/{subscription_id}/products_swap":{"put":{"tags":["Subscription Line Items"],"summary":"Swap Line Items","operationId":"SwapLineItems","description":"Swap line item products on a subscription.","parameters":[{"$ref":"#/components/parameters/shop_identifier_path_param"},{"$ref":"#/components/parameters/subscription_id_path_param"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SwapProduct"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Subscription"}}}},"401":{"description":"Unauthenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthenticatedResponse"}}}}}}},"/subscriptions/v1/shops/{shop_identifier}/subscriptions/{subscription_id}/adjustments":{"parameters":[{"$ref":"#/components/parameters/shop_identifier_path_param"},{"$ref":"#/components/parameters/subscription_id_path_param"}],"post":{"summary":"Create Subscription Adjustments","operationId":"CreateSubscriptionAdjustments","tags":["Subscription Adjustments"],"description":"Creates adjustments for a subscription or its orders.\\n\\nFor more information on subscription adjustments, refer to the [Adjust Subscription Orders](/guides/subscriptions-v2/adjust-subscription-orders) guide.","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionAdjustments"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"object","properties":{"message":{"type":"string","description":"The detailed error message.","enum":["only one of fields count, function, and relative count can be provided","invalid adjustment.action.type"]}}}}},"example":{"errors":{"message":"only one of fields count, function, and relative count can be provided"}}}}},"422":{"description":"Unprocessable entity","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"The error summary.","example":"The given data was invalid."},"errors":{"type":"object","additionalProperties":{"type":"array","minItems":1,"items":{"type":"string","description":"The detailed error message.","example":"The adjustments.0.target field is required."}}}}},"example":{"message":"The given data was invalid.","errors":{"adjustments.0.target":["The adjustments.0.target field is required."]}}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionAdjustments"},"examples":{"Trigger: One-time order adjustment by order count":{"value":{"adjustments":[{"name":"Foundation Brush Cross-Sell","description":"Loving our beauty box? Up your game with the versatile, made-in-house Foundation Brush!","target":"order","trigger":{"type":"order_count","count":3},"action":{"type":"add_line_item","platform_variant_id":"17169270472755","platform_product_id":"1841889509427","quantity":1,"price":1500}}]}},"Trigger: One-time order adjustment by relative order count":{"value":{"adjustments":[{"name":"Dessert Upsell","description":"There\'s always room for dessert! Indulge in this dessert add-on with your next order.","target":"order","trigger":{"type":"order_count","relative_count":1},"action":{"type":"add_line_item","platform_variant_id":"17169270472755","platform_product_id":"1841889509427","quantity":1,"price":700}}]}},"Trigger: Recurring order adjustment by function on order count":{"value":{"adjustments":[{"name":"Loyalty Gift","description":"Enjoy a complementary gift every 5th order for being a loyal customer!","target":"order","trigger":{"type":"order_count","function":{"step_size":5,"offset":0}},"action":{"type":"add_line_item","platform_variant_id":"17169270472755","platform_product_id":"1841889509427","quantity":1,"price":0}}]}},"Trigger: One-time order adjustment by order datetime":{"value":{"adjustments":[{"name":"10th Anniversary Give-Away!","description":"Celebrate 10 years of cleaning the oceans! Spread our message in style with this free t-shirt!","target":"order","trigger":{"type":"order_datetime","datetime":"2024-02-15T06:00:00Z"},"action":{"type":"add_line_item","platform_variant_id":"17169270472755","platform_product_id":"1841889509427","quantity":1,"price":0}}]}},"Trigger: Subscription adjustment by order count":{"value":{"adjustments":[{"name":"Samples Up! (Trial End)","description":"Coffee samples hit the spot!? Time to start receiving the real deal!","target":"subscription","trigger":{"type":"order_count","count":2},"action":{"type":"add_line_item","platform_variant_id":"17169270472755","platform_product_id":"1841889509427","quantity":1,"price":1500}}]}},"Trigger: Subscription adjustment by relative order count":{"value":{"adjustments":[{"name":"Gryffindor Upsell","description":"Are you Slytherin? Are you Gryffindor? Start receiving a second box on your next order and find out!","target":"subscription","trigger":{"type":"order_count","relative_count":1},"action":{"type":"add_line_item","platform_variant_id":"17169270472755","platform_product_id":"1841889509427","quantity":1,"price":700}}]}},"Trigger: Subscription adjustment by order datetime":{"value":{"adjustments":[{"name":"More Family. More Fun!","description":"Expecting? Add a newborn to your baby supply plan in advance!","target":"subscription","trigger":{"type":"order_datetime","datetime":"2024-01-20T06:00:00Z"},"action":{"type":"add_line_item","platform_variant_id":"17169270472755","platform_product_id":"1841889509427","quantity":1,"price":3500}}]}},"Action: Add Product":{"description":"Adds a product to a subscription or its orders.\\n\\n**Supported targets**\\n\\n* `subscription`\\n* `order`","value":{"adjustments":[{"name":"Foundation Brush Cross-Sell","description":"Loving our beauty box? Up your game with the versatile, made-in-house Foundation Brush!","target":"order","trigger":{"type":"order_count","count":3},"action":{"type":"add_line_item","platform_variant_id":"17169270472755","platform_product_id":"1841889509427","quantity":1,"price":1500}}]}},"Action: Update Line Item Quantity":{"description":"Updates the quantity of line item to a subscription or its orders.\\n\\n**Supported targets**\\n\\n* `subscription`\\n* `order`","value":{"adjustments":[{"name":"Coffee Bean Upsell","description":"Coffee is temporary but mornings are forever. Prepare for the future and add another bag of coffee to your order!","target":"order","trigger":{"type":"order_count","count":3},"action":{"type":"update_line_item_quantity","subscription_line_item_id":35236,"quantity":3}}]}}}}}}},"get":{"parameters":[{"$ref":"#/components/parameters/filter_subscription_adjustments_query_param"}],"summary":"List Subscription Adjustments","operationId":"ListSubscriptionAdjustments","tags":["Subscription Adjustments"],"description":"Lists adjustments for a subscription or its orders.","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionAdjustments"}}}}}},"delete":{"parameters":[{"$ref":"#/components/parameters/filter_subscription_adjustments_query_param"}],"summary":"Delete Subscription Adjustments","operationId":"DeleteSubscriptionAdjustments","tags":["Subscription Adjustments"],"description":"Deletes adjustments for a subscription or its orders.","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"array","minItems":0,"maxItems":0,"items":{}}}}}}}},"/subscriptions/v1/shops/{shop_identifier}/subscriptions/{subscription_id}/adjustments/{adjustment_id}":{"parameters":[{"$ref":"#/components/parameters/shop_identifier_path_param"},{"$ref":"#/components/parameters/subscription_id_path_param"},{"$ref":"#/components/parameters/subscription_adjustment_id_path_param"}],"get":{"summary":"Get Subscription Adjustment by ID","operationId":"GetSubscriptionAdjustmentByID","tags":["Subscription Adjustments"],"description":"Gets an adjustment by its ID.","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"adjustment":{"$ref":"#/components/schemas/SubscriptionAdjustment"}}}}}}}},"delete":{"summary":"Delete Subscription Adjustment by ID","operationId":"DeleteSubscriptionAdjustmentByID","tags":["Subscription Adjustments"],"description":"Deletes an adjustment by its ID.","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"array","minItems":0,"maxItems":0,"items":{}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"object","properties":{"message":{"type":"string","enum":["not found (<trace-id>)"]}}}}},"example":{"errors":{"message":"not found (subscriptions:1234dde7622ab0.56787371)"}}}}}}}},"/subscriptions/v1/shops/{shop_identifier}/subscriptions/{subscription_id}/orders":{"get":{"tags":["Subscription Orders"],"summary":"List Orders","operationId":"ListOrders","description":"Retrieve a list of subscription orders for a subscription.","parameters":[{"$ref":"#/components/parameters/shop_identifier_path_param"},{"$ref":"#/components/parameters/subscription_id_path_param"},{"schema":{"type":"integer"},"in":"query","name":"page","description":"The desired page number for the paginated result"},{"schema":{"type":"integer"},"in":"query","description":"Maximum number of results to be returned","name":"limit"}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionOrders"}}}},"401":{"description":"Unauthenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthenticatedResponse"}}}}}}},"/subscriptions/v1/shops/{shop_identifier}/subscriptions/{subscription_id}/orders/{order_id}":{"get":{"tags":["Subscription Orders"],"summary":"Get Order","operationId":"GetOrder","description":"Retrieve a subscription order for a subscription by its id.","parameters":[{"$ref":"#/components/parameters/shop_identifier_path_param"},{"$ref":"#/components/parameters/subscription_id_path_param"},{"$ref":"#/components/parameters/order_id_path_param"}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionOrder"}}}},"401":{"description":"Unauthenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthenticatedResponse"}}}}}}},"/subscriptions/v1/shops/{shop_identifier}/future_orders":{"parameters":[{"$ref":"#/components/parameters/shop_identifier_path_param"}],"get":{"summary":"List Future Orders","operationId":"ListFutureOrders","tags":["Future Orders"],"description":"Lists future subscription orders for the shop.\\n\\nFor more information, refer to the [View Future Orders](/guides/subscriptions-v2/view-future-orders#querying-all-active-subscription-orders) guide.","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/filter_future_orders_query_param"},{"$ref":"#/components/parameters/filter_future_order_subscriptions_query_param"},{"$ref":"#/components/parameters/cursor"}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FutureOrders"}}}},"401":{"description":"Unauthenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthenticatedResponse"}}}}}}},"/subscriptions/v1/shops/{shop_identifier}/subscriptions/{subscription_id}/future_orders":{"parameters":[{"$ref":"#/components/parameters/shop_identifier_path_param"},{"$ref":"#/components/parameters/subscription_id_path_param"}],"get":{"summary":"List Future Orders by Subscription ID","operationId":"ListFutureOrdersBySubscriptionID","tags":["Future Orders"],"description":"Lists future orders for a subscription.\\n\\nFor more information, refer to the [View Future Orders](/guides/subscriptions-v2/view-future-orders#querying-orders-by-subscription-id) guide.","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/filter_future_orders_query_param"},{"$ref":"#/components/parameters/cursor"}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FutureOrders"}}}},"401":{"description":"Unauthenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthenticatedResponse"}}}}}}},"/subscriptions/v1/shops/{shop_identifier}/convertible_adjustment_groups":{"parameters":[{"$ref":"#/components/parameters/shop_identifier_path_param"}],"post":{"tags":["Convertible Adjustments"],"summary":"Create Convertible Adjustment Group","description":"Creates a convertible adjustment group for a store. When created, the adjustment group does not have any products associated with it. Convertible adjustments enable customers to convert their subscription after an initial order.\\n\\nFor example, if the initial subscription order included a coffee maker and coffee grounds, a convertible adjustment allows subsequent orders to contain only coffee grounds.\\n\\nAfter calling this endpoint, call [Create Convertible Adjustment Group Items](/api/subscriptions#tag/Convertible-Adjustments/operation/CreateConvertibleAdjustmentGroupItems) to attach the created convertible adjustment group items to the adjustment group.","operationId":"CreateConvertibleAdjustmentGroup","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["convertible_adjustment_group"],"properties":{"convertible_adjustment_group":{"$ref":"#/components/schemas/ConvertibleAdjustmentGroup"}}}}}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","required":["convertible_adjustment_group"],"properties":{"convertible_adjustment_group":{"$ref":"#/components/schemas/ConvertibleAdjustmentGroup"}}}}}}}},"401":{"description":"Unauthenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthenticatedResponse"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"The error summary.","example":"The selected data.convertible adjustment group.on cycle end is invalid."},"errors":{"type":"object","additionalProperties":{"type":"array","minItems":1,"items":{"type":"string","description":"The detailed error message.","example":"The selected data.convertible adjustment group.on cycle end is invalid."}}}}},"example":{"message":"The selected data.convertible adjustment group.on cycle end is invalid.","errors":{"data.convertible_adjustment.on_cycle_end":["The selected data.convertible adjustment group.on cycle end is invalid."]}}}}}}}},"/subscriptions/v1/shops/{shop_identifier}/convertible_adjustment_groups/{adjustment_id}/items":{"parameters":[{"$ref":"#/components/parameters/shop_identifier_path_param"},{"$ref":"#/components/parameters/convertible_adjustment_group_id_path_param"}],"post":{"tags":["Convertible Adjustments"],"summary":"Create Convertible Adjustment Group Items","description":"Creates convertible adjustment group items used for a selection option. The first item in the `items` array represents the initial product and the second item represents the product it will convert to after the initial order is placed.","operationId":"CreateConvertibleAdjustmentGroupItems","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["items"],"properties":{"items":{"type":"array","minItems":2,"uniqueItems":true,"items":{"$ref":"#/components/schemas/ConvertibleAdjustmentGroupItemEntity"}}}}}},"example":{"data":{"items":[{"type":"initial_product","discount_type":"no_discount"},{"type":"product","product":{"platform_product_id":"7873884094619","platform_variant_id":"44147851264155"},"discount_type":"percentage","discount_value":50},{"type":"product","product":{"platform_product_id":"7873885831323","platform_variant_id":"44147858473115"},"discount_type":"percentage","discount_value":50}]}}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"items":{"type":"array","minItems":2,"uniqueItems":true,"items":{"$ref":"#/components/schemas/ConvertibleAdjustmentGroupItem"}}}}}},"example":{"data":{"items":[{"id":81,"shop_platform_app_id":1007,"convertible_adjustment_group_id":20,"type":"initial_product","discount_type":"no_discount","discount_value":0,"product":null},{"id":82,"shop_platform_app_id":1007,"convertible_adjustment_group_id":20,"type":"product","discount_type":"percentage","discount_value":50,"product":{"id":82,"convertible_adjustment_group_id_item_id":82,"platform_product_id":"7873884094619","platform_variant_id":"44147851264155","created_at":"2024-03-19T20:42:47Z","updated_at":"2024-03-19T20:42:47Z","deleted_at":null}},{"id":83,"shop_platform_app_id":1007,"convertible_adjustment_group_id":20,"type":"product","discount_type":"percentage","discount_value":50,"product":{"id":83,"convertible_adjustment_group_id_item_id":83,"platform_product_id":"7873885831323","platform_variant_id":"44147858473115","created_at":"2024-03-19T20:42:47Z","updated_at":"2024-03-19T20:42:47Z","deleted_at":null}}]}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"object","properties":{"message":{"type":"string","description":"The error message.","example":"validating items of type \\"product\\" failed with reason: platform \\"[product]:[variant]\\" data was not found for some items: 123:456"}}}}}}}},"401":{"description":"Unauthenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthenticatedResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"object","properties":{"message":{"type":"string","enum":["not found (<trace-id>)"]}}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"The error summary.","example":"The selected data.items.0.type is invalid."},"errors":{"type":"object","additionalProperties":{"type":"array","minItems":1,"items":{"type":"string","description":"The detailed error message.","example":"The selected data.items.0.type is invalid."}}}}},"example":{"errors":{"data.items.0.type":["The selected data.items.0.type is invalid."]}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"object","properties":{"message":{"type":"string","description":"The error message.","example":"validating items of type \\"product\\" failed with reason: failed to fetch variants: variant data missing from response (subscriptions:123.456)"}}}}}}}}}},"delete":{"tags":["Convertible Adjustments"],"summary":"Delete Convertible Adjustment Group Items","description":"Deletes all convertible adjustment group items from a convertible adjustment group.","operationId":"DeleteConvertibleAdjustmentGroupItems","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"deleted_item_count":{"type":"integer","description":"The number of deleted convertible adjustment group items from the convertible adjustment group.","example":1}}}}}}}},"401":{"description":"Unauthenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthenticatedResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"object","properties":{"message":{"type":"string","enum":["not found (<trace-id>)"]}}}}}}}}}}},"/subscriptions/v1/shops/{shop_identifier}/convertible_adjustment_groups/{adjustment_id}":{"parameters":[{"$ref":"#/components/parameters/shop_identifier_path_param"},{"$ref":"#/components/parameters/convertible_adjustment_group_id_path_param"}],"delete":{"tags":["Convertible Adjustments"],"summary":"Delete Convertible Adjustment Group","description":"Deletes a convertible adjustment group and its items for a store.","operationId":"DeleteConvertibleAdjustmentGroup","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"convertible_adjustment_group_id":{"type":"integer","example":2}}}}}}}},"401":{"description":"Unauthenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthenticatedResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"object","properties":{"message":{"type":"string","enum":["not found (<trace-id>)"]}}}}}}}}}},"put":{"tags":["Convertible Adjustments"],"summary":"Update Convertible Adjustment Group","description":"Updates a convertible adjustment group for a store.","operationId":"UpdateConvertibleAdjustmentGroup","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["convertible_adjustment_group"],"properties":{"convertible_adjustment_group":{"$ref":"#/components/schemas/ConvertibleAdjustmentGroup"}}}}}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","required":["convertible_adjustment_group"],"properties":{"convertible_adjustment_group":{"$ref":"#/components/schemas/ConvertibleAdjustmentGroup"}}}}}}}},"401":{"description":"Unauthenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthenticatedResponse"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"The error summary.","example":"The selected data.convertible adjustment group.on cycle end is invalid."},"errors":{"type":"object","additionalProperties":{"type":"array","minItems":1,"items":{"type":"string","description":"The detailed error message.","example":"The selected data.convertible adjustment group.on cycle end is invalid."}}}}},"example":{"message":"The selected data.convertible adjustment group.on cycle end is invalid.","errors":{"data.convertible_adjustment.on_cycle_end":["The selected data.convertible adjustment group.on cycle end is invalid."]}}}}}}}},"/subscriptions/v1/shops/{shop_identifier}/convertible_adjustment_groups/{adjustment_id}/items/{adjustment_item_id}":{"parameters":[{"$ref":"#/components/parameters/shop_identifier_path_param"},{"$ref":"#/components/parameters/convertible_adjustment_group_id_path_param"},{"$ref":"#/components/parameters/convertible_adjustment_group_item_id_path_param"}],"delete":{"tags":["Convertible Adjustments"],"summary":"Delete Convertible Adjustment Group Item","description":"Deletes a convertible adjustment group item from a convertible adjustment group using the convertible adjustment group item ID","operationId":"DeleteConvertibleAdjustmentGroupItem","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"item_id":{"type":"integer","description":"The convertible adjustment group item identifier deleted from the convertible adjustment plan.","example":2}}}}}}}},"401":{"description":"Unauthenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthenticatedResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"object","properties":{"message":{"type":"string","enum":["not found (<trace-id>)"]}}}}}}}}}},"put":{"tags":["Convertible Adjustments"],"summary":"Update Convertible Adjustment Group Item","description":"Updates a convertible adjustment group item from a convertible adjustment group using the convertible adjustment group item ID","operationId":"UpdateConvertibleAdjustmentGroupItem","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["item"],"properties":{"item":{"$ref":"#/components/schemas/ConvertibleAdjustmentGroupItemEntity"}}}}},"example":{"data":{"item":{"type":"product","product":{"platform_product_id":"7873884094619","platform_variant_id":"44147851264155"},"discount_type":"percentage","discount_value":50}}}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"item":{"$ref":"#/components/schemas/ConvertibleAdjustmentGroupItem"}}}}},"example":{"data":{"item":{"id":82,"shop_platform_app_id":1007,"convertible_adjustment_group_id":20,"type":"product","discount_type":"percentage","discount_value":50,"product":{"id":82,"convertible_adjustment_group_id_item_id":82,"platform_product_id":"7873884094619","platform_variant_id":"44147851264155","created_at":"2024-03-19T20:42:47Z","updated_at":"2024-03-19T20:42:47Z","deleted_at":null}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"object","properties":{"message":{"type":"string","description":"The error message.","example":"validating items of type \\"product\\" failed with reason: platform \\"[product]:[variant]\\" data was not found for some items: 123:456"}}}}}}}},"401":{"description":"Unauthenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthenticatedResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"object","properties":{"message":{"type":"string","enum":["not found (<trace-id>)"]}}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"The error summary.","example":"The selected data.item.type is invalid."},"errors":{"type":"object","additionalProperties":{"type":"array","minItems":1,"items":{"type":"string","description":"The detailed error message.","example":"The selected data.item.type is invalid."}}}}},"example":{"errors":{"data.item.type":["The selected data.type is invalid."]}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"object","properties":{"message":{"type":"string","description":"The error message.","example":"validating items of type \\"product\\" failed with reason: failed to fetch variants: variant data missing from response (subscriptions:123.456)"}}}}}}}}}}},"/subscriptions/v1/shops/{shop_identifier}/subscriptions/{subscription_id}/payment_method":{"get":{"tags":["Payment Methods"],"summary":"Get Payment Method","operationId":"GetPaymentMethod","description":"Retrieve the current payment method information of a subscription.","parameters":[{"$ref":"#/components/parameters/shop_identifier_path_param"},{"$ref":"#/components/parameters/subscription_id_path_param"}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentMethod"}}}},"401":{"description":"Unauthenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthenticatedResponse"}}}}}}},"/subscriptions/v1/shops/{shop_identifier}/subscriptions/{subscription_id}/payment_method_email":{"parameters":[{"$ref":"#/components/parameters/shop_identifier_path_param"},{"$ref":"#/components/parameters/subscription_id_path_param"}],"post":{"tags":["Payment Methods"],"summary":"Trigger Update Payment Method Email","operationId":"TriggerUpdatePaymentMethodEmail","description":"**Note:** Available for Shopify Checkout only.\\n\\nTrigger an email to the customer that allows them to update their payment method for the subscription. This endpoint can only be called if the subscription\'s payment method has an `update_method` of `trigger_email`.\\n\\nYou can change the contents of the email in Shopify\'s \\"Customer payment method update request\\" email settings.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{}}}}}}}},"/subscriptions/v1/shops/{shop_identifier}/subscriptions/{subscription_id}/payment_methods":{"get":{"tags":["Payment Methods"],"summary":"List Payment Methods","operationId":"ListPaymentMethods","description":"Retrieve a list of available payment methods for a subscription.","parameters":[{"$ref":"#/components/parameters/shop_identifier_path_param"},{"$ref":"#/components/parameters/subscription_id_path_param"}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentMethods"}}}},"401":{"description":"Unauthenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthenticatedResponse"}}}}}}},"/subscriptions/v1/shops/{shop_identifier}/subscriptions/{subscription_id}/line_items":{"parameters":[{"$ref":"#/components/parameters/shop_identifier_path_param"},{"$ref":"#/components/parameters/subscription_id_path_param"}],"patch":{"tags":["Subscription Line Items"],"summary":"Update Line Items","operationId":"UpdateLineItems","description":"Update the line items of a subscription. Refer to [Manage Subscription Line Items](/guides/subscriptions-v2/line-items) for more information about the use cases of this endpoint.\\n\\nWhen updating the price of the line item, change the `price` field in the request body. This value must be in the `charged_currency` of the subscription, and it must be in the base currency unit (i.e., cents). This price is the final output price of the line item on this order; any applicable subscription group discounts or price changes will not be applied.\\n\\n*Example:\\nIf you include price: 4000 in the request body, the line item price is set to $40.00 CAD for all upcoming orders.*","parameters":[{"$ref":"#/components/parameters/shop_identifier_path_param"},{"$ref":"#/components/parameters/subscription_id_path_param"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSubscriptionLineItems"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionUpdateLineItems"}}}},"401":{"description":"Unauthenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthenticatedResponse"}}}}}},"post":{"tags":["Subscriptions"],"summary":"Create Line Items","description":"Add one or more line items to a subscription. Refer to [Create Subscription Line Items](/guides/subscriptions-v2/create-line-items) for more information about the use cases of this endpoint.\\n\\n**Note:** Adding line items to multi-currency subscriptions is not supported at this time.","operationId":"CreateLineItems","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSubscriptionLineItems"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateLineItemsResponse"}}}},"401":{"description":"Unauthenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthenticatedResponse"}}}},"403":{"description":"Adding line items to multi-currency subscriptions is not supported at this time."},"404":{"description":"Subscription, product variant, or subscription group not found."}}}},"/subscriptions/v1/shops/{shop_identifier}/subscriptions/{subscription_id}/next_order_datetime":{"put":{"tags":["Subscription Orders"],"summary":"Update Next Order Datetime","operationId":"UpdateNextOrderDatetime","description":"Update the datetime of the next subscription order in [RFC 3339 format](https://www.ietf.org/rfc/rfc3339.txt).","parameters":[{"$ref":"#/components/parameters/shop_identifier_path_param"},{"$ref":"#/components/parameters/subscription_id_path_param"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSubscriptionNextOrderDate"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Subscription"}}}},"401":{"description":"Unauthenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthenticatedResponse"}}}}}}},"/subscriptions/v1/shops/{shop_identifier}/subscriptions/{subscription_id}/recover":{"put":{"tags":["Subscription Orders"],"summary":"Unskip Previously Skipped Order","operationId":"UnskipPreviouslySkippedOrder","description":"Restore a previously skipped future subscription order. Specify the date of the order to be unskipped.","parameters":[{"$ref":"#/components/parameters/shop_identifier_path_param"},{"$ref":"#/components/parameters/subscription_id_path_param"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnskipSubscriptionOrder"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Subscription"}}}},"401":{"description":"Unauthenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthenticatedResponse"}}}}}}},"/subscriptions/v1/shops/{shop_identifier}/subscriptions/{subscription_id}/skip":{"put":{"tags":["Subscription Orders"],"summary":"Skip Subscription Order","operationId":"SkipSubscriptionOrder","description":"Skip a subscription\'s upcoming order by date.","parameters":[{"$ref":"#/components/parameters/shop_identifier_path_param"},{"$ref":"#/components/parameters/subscription_id_path_param"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SkipSubscriptionOrder"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Subscription"}}}},"401":{"description":"Unauthenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthenticatedResponse"}}}}}}},"/subscriptions/v1/shops/{shop_identifier}/subscriptions/{subscription_id}/activate":{"post":{"tags":["Subscriptions"],"summary":"Reactivate Subscription","operationId":"ReactivateSubscription","description":"Reactivate an inactive or cancelled subscription.","parameters":[{"$ref":"#/components/parameters/shop_identifier_path_param"},{"$ref":"#/components/parameters/subscription_id_path_param"}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Subscription"}}}},"401":{"description":"Unauthenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthenticatedResponse"}}}}}}},"/subscriptions/v1/shops/{shop_identifier}/subscriptions/{subscription_id}/cancel":{"post":{"tags":["Subscriptions"],"summary":"Cancel Subscription","operationId":"CancelSubscription","description":"Cancel a subscription and any future orders. Cancelled subscriptions will appear as \'inactive\'.","parameters":[{"$ref":"#/components/parameters/shop_identifier_path_param"},{"$ref":"#/components/parameters/subscription_id_path_param"}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Subscription"}}}},"401":{"description":"Unauthenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthenticatedResponse"}}}}}}},"/subscriptions/v1/shops/{shop_identifier}/subscriptions/{subscription_id}/pause":{"post":{"tags":["Subscriptions"],"summary":"Pause Subscription","operationId":"PauseSubscription","description":"Pause a subscription and any future orders. Paused orders will still appear as \'active\'.","parameters":[{"$ref":"#/components/parameters/shop_identifier_path_param"},{"$ref":"#/components/parameters/subscription_id_path_param"}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Subscription"}}}},"401":{"description":"Unauthenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthenticatedResponse"}}}}}}},"/subscriptions/v1/shops/{shop_identifier}/subscriptions/{subscription_id}/line_items/{line_item_id}":{"delete":{"tags":["Subscription Line Items"],"summary":"Delete Line Item","operationId":"DeleteLineItem","description":"Delete a line item from a subscription.","parameters":[{"$ref":"#/components/parameters/shop_identifier_path_param"},{"$ref":"#/components/parameters/subscription_id_path_param"},{"$ref":"#/components/parameters/line_item_id_path_param"}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Subscription"}}}},"401":{"description":"Unauthenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthenticatedResponse"}}}}}},"get":{"tags":["Subscription Line Items"],"summary":"Get Line Item","operationId":"GetLineItem","description":"Retrieve the details of a specific line item from a given subscription.","parameters":[{"$ref":"#/components/parameters/shop_identifier_path_param"},{"$ref":"#/components/parameters/subscription_id_path_param"},{"$ref":"#/components/parameters/line_item_id_path_param"}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"subscription_line_item":{"$ref":"#/components/schemas/LineItemEntity"}}},"examples":{"success-example":{"value":{"subscription_line_item":{"id":1,"subscription_id":1,"platform_id":"ABC123","platform_product_id":"1357908642","platform_variant_id":"2468097531","subscription_group_id":1,"subscription_group_billing_rules_id":1,"title":"Monthly Expansion Pack","product_name":"Monthly Expansion Pack","variant_name":"Default Title","sku":"SKU-113-Red","url":"https://example-store.example.com/monthly-expansion-pack","image":"","quantity":1,"price":3500,"price_charged":3200,"discounted_price":3200,"discounted_price_charged":3200,"full_price":3200,"full_price_charged":3200,"requires_shipping":false,"grams":2200,"weight":2.2,"weight_unit":"kg","taxable":true,"discounts":[{"id":1,"subscription_line_item_id":1,"shop_id":5,"full_price":5,"discount_type":"percentage","percentage_value":10,"fixed_value":0,"fixed_value_charged":0,"description":"Subscription discount (10%) for Monthly Expansion Pack","created_at":"2019-11-20T20:31:55Z","updated_at":"2019-11-20T20:31:55Z","deleted_at":"2019-11-20T20:31:55Z"}],"prepaid_metadata":{"id":1,"line_item_id":2,"prepaid_duration":2,"current_recurrence_count":2,"prepaid_continue":"no_continue"},"line_item_attributes":[{"name":"size_preference","value":"XL","created_at":"2021-01-17T20:30:40Z","updated_at":"2021-01-17T20:30:40Z","subscription_id":1,"line_item_id":1}],"created_at":"2019-11-20T20:31:55Z","updated_at":"2019-11-20T20:31:55Z"}}}}}}},"404":{"description":"Subscription or line item not found"}}}},"/subscriptions/v1/shops/{shop_identifier}/subscriptions/{subscription_id}/line_items/{line_item_id}/products_swap":{"parameters":[{"$ref":"#/components/parameters/shop_identifier_path_param"},{"$ref":"#/components/parameters/subscription_id_path_param"},{"$ref":"#/components/parameters/line_item_id_path_param"}],"get":{"tags":["Subscription Line Items"],"summary":"List Swappable Products by Line Item","operationId":"ListSwappableProductsByLineItem","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SwappableProducts"}}}},"401":{"description":"Unauthenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthenticatedResponse"}}}}},"description":"Retrieve a list of swappable products for a subscription line item.","parameters":[{"$ref":"#/components/parameters/shop_identifier_path_param"},{"$ref":"#/components/parameters/subscription_id_path_param"},{"$ref":"#/components/parameters/line_item_id_path_param"},{"schema":{"type":"integer"},"in":"query","name":"limit","description":"Maximum number of results to be returned"},{"schema":{"type":"integer"},"in":"query","name":"page","description":"The desired page number for the paginated result"}]}},"/subscriptions/v1/shops/{shop_identifier}/selection_options":{"parameters":[{"$ref":"#/components/parameters/shop_identifier_path_param"}],"get":{"tags":["Subscription Groups"],"summary":"List Selection Options","description":"Retrieves a list of selection options. Selection options are the products available in a subscription group. Use this endpoint to view some or all selection options for the active subscription groups on a given store.","operationId":"ListSelectionOptions","parameters":[{"schema":{"type":"string"},"in":"query","name":"cursor","description":"A base 64 encoded cursor.","example":"?cursor=P2lkPTU1"},{"schema":{"type":"string"},"in":"query","name":"filter","description":"Accepts filtering options as described on the [Query & Pagination page](/guides/subscriptions-v2/resources/query-pagination).","example":"?filter=in(platform_entity_id:1,2,3)"},{"schema":{"type":"string"},"in":"query","name":"expand","description":"Fields to expand on the selection options. Currently accepts `subscription_group` and `products`","example":"?expand=subscription_group&expand=products"},{"schema":{"type":"integer"},"in":"query","name":"limit","description":"Limit the number of returned items.","example":"?limit=3L9"},{"$ref":"#/components/parameters/latest"}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SelectionOptions"}}}},"401":{"description":"Unauthenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthenticatedResponse"}}}}}}},"/subscriptions/v1/shops/{shop_identifier}/subscription_groups":{"parameters":[{"$ref":"#/components/parameters/shop_identifier_path_param"}],"get":{"tags":["Subscription Groups"],"summary":"List Subscription Groups","operationId":"ListSubscriptionGroups","description":"Retrieve a list of subscription groups.","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionGroups"},"examples":{"example-1":{"value":{"subscription_groups":[{"id":3,"shop_id":1,"internal_name":"Standard Subscription","is_enabled":true,"platform_id":"gid://shopify/SellingPlanGroup/132016692","allow_prepaid":false,"is_prepaid_only":false,"should_continue_prepaid":false,"continue_prepaid_type":"as_prepaid","percent_discount":11,"minimum_order_count_before_cancellable":0,"is_product_swappable":false,"is_subscription_only":false,"selection_type":"products","group_type":"selectable","selectable_daily_allowed":false,"selectable_weekly_allowed":false,"selectable_yearly_allowed":false,"selectable_max_interval_frequency":0,"fixed_interval_type":"monthly","is_fixed_billing":false,"can_add_to_cart":true,"allow_buffer_days":true,"discount_type":"fixed","fixed_discount":10,"created_at":"2019-11-20T20:50:07Z","updated_at":"2019-11-20T20:50:07Z","deleted_at":null,"active_subscribers_count":1,"billing_rules":[{"id":1,"shop_id":1,"subscription_group_id":1,"interval_number":1,"interval_type":"month","interval_name":"Monthly","week_type":"","week_day":0,"month_type":"purchase_day","month_day":"","month_occurrence":"","month_occurrence_day":"","year_type":"","year_month":"","year_occurrence":"","year_occurrence_day":"","billing_rule":"FREQ=MONTHLY","created_at":"2019-11-20T20:50:07Z","updated_at":"2019-11-20T20:50:07Z","deleted_at":null}],"selection_options":[{"id":1,"shop_id":1,"subscription_group_id":1,"platform_entity_id":"1357908642","created_at":"2019-11-20T20:50:07Z","updated_at":"2019-11-20T20:50:07Z","deleted_at":null,"entity_id":1472540}],"prepaid_durations":[{}]}]}}}}}},"401":{"description":"Unauthenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthenticatedResponse"}}}}}},"post":{"tags":["Subscription Groups"],"summary":"Create Subscription Group","operationId":"CreateSubscriptionGroup","description":"Create a subscription group.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionGroup"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionGroup"}}}},"401":{"description":"Unauthenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthenticatedResponse"}}}}}}},"/subscriptions/v1/shops/{shop_identifier}/subscription_groups/{group_id}":{"get":{"tags":["Subscription Groups"],"summary":"Get Subscription Group","operationId":"GetSubscriptionGroup","description":"Retrieve a subscription group by its id.","parameters":[{"$ref":"#/components/parameters/shop_identifier_path_param"},{"$ref":"#/components/parameters/group_id_path_param"}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionGroup"}}}},"401":{"description":"Unauthenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthenticatedResponse"}}}}}},"put":{"tags":["Subscription Groups"],"summary":"Update Subscription Group","operationId":"UpdateSubscriptionGroup","description":"Update a subscription group by its id.","parameters":[{"$ref":"#/components/parameters/shop_identifier_path_param"},{"$ref":"#/components/parameters/group_id_path_param"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionGroup"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionGroup"}}}},"401":{"description":"Unauthenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthenticatedResponse"}}}}}},"delete":{"tags":["Subscription Groups"],"summary":"Delete Subscription Group","operationId":"DeleteSubscriptionGroup","description":"Delete a subscription group by its id.","parameters":[{"$ref":"#/components/parameters/shop_identifier_path_param"},{"$ref":"#/components/parameters/group_id_path_param"}],"responses":{"200":{"description":"Successful operation"},"401":{"description":"Unauthenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthenticatedResponse"}}}}}}},"/subscriptions/v1/shops/{shop_identifier}/webhooks/topics":{"get":{"summary":"List Webhook Topics","operationId":"ListWebhookTopics","tags":["Webhook Topics"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookTopics"},"examples":{"example":{"value":{"webhook_topics":[{"id":1,"topic_name":"subscription_created"},{"id":2,"topic_name":"subscription_updated"},{"id":3,"topic_name":"subscription_order_created"},{"id":4,"topic_name":"customer_created"},{"id":5,"topic_name":"customer_updated"},{"id":6,"topic_name":"subscription_order_transaction_failed"},{"id":7,"topic_name":"subscription_order_max_retries_reached"},{"id":8,"topic_name":"subscription_payment_method_updated"},{"id":9,"topic_name":"subscription_upcoming_order"},{"id":10,"topic_name":"subscription_expiring_payment"},{"id":12,"topic_name":"subscription_cancelled"},{"id":13,"topic_name":"subscription_paused"},{"id":14,"topic_name":"subscription_resumed"},{"id":15,"topic_name":"subscription_reactivated"},{"id":16,"topic_name":"subscription_frequency_updated"},{"id":17,"topic_name":"subscription_quantity_updated"},{"id":18,"topic_name":"subscription_credit_card_updated"},{"id":19,"topic_name":"subscription_shipping_address_updated"},{"id":20,"topic_name":"subscription_payment_failed"},{"id":21,"topic_name":"subscription_skipped"},{"id":22,"topic_name":"subscription_line_items_added"}]}}}}}},"401":{"description":"Unauthenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthenticatedResponse"}}}}},"description":"Retrieve a list of available webhook topics.","parameters":[{"$ref":"#/components/parameters/shop_identifier_path_param"}]}},"/subscriptions/v1/shops/{shop_identifier}/webhooks/subscriptions":{"parameters":[{"$ref":"#/components/parameters/shop_identifier_path_param"}],"get":{"summary":"List Webhook Subscriptions","operationId":"ListWebhookSubscriptions","tags":["Webhook Subscriptions"],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookSubscriptions"},"examples":{"example":{"value":{"webhook_subscriptions":[{"id":1,"shop_id":1,"webhook_topic_id":1,"callback_url":"yourapp.com/v2/sub-created","created_at":"2020-09-17T18:27:03Z","updated_at":"2020-09-17T18:27:03Z","deleted_at":null},{"id":1,"shop_id":1,"webhook_topic_id":2,"callback_url":"yourapp.com/sub-updated","created_at":"2020-08-17T18:27:03Z","updated_at":"2020-08-17T18:27:03Z","deleted_at":null}],"pagination":{"limit":10,"count":2,"total":2,"total_pages":1}}}}}}},"401":{"description":"Unauthenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthenticatedResponse"}}}}},"description":"Retrieve a list of webhook subscriptions.","parameters":[{"schema":{"type":"integer"},"in":"query","name":"since_id","description":""},{"schema":{"type":"string"},"in":"query","name":"limit","description":"Maximum number of results to be returned"},{"schema":{"type":"array","items":{"type":"string","enum":["webhook_topic_id","callback_url","shared_secret","created_at","updated_at"]}},"in":"query","name":"filters","description":"Filter subscription webhooks. Multiple filters can be passed in the array."}]},"post":{"summary":"Create Webhook Subscription","operationId":"CreateWebhookSubscription","tags":["Webhook Subscriptions"],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookSubscription"}}}},"401":{"description":"Unauthenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthenticatedResponse"}}}}},"description":"Create a webhook subscription. For more information, refer to [Register for Webhooks](/guides/subscriptions-v2/webhooks).\\n\\nThe `subscription_payment_method_updated` webhook is not supported by default for all Shopify shops installed prior to January 15th 2024 (2024-01-15). Please submit a [support request](https://support.boldcommerce.com/hc/en-us/requests/new?ticket_form_id=132106) for access.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"webhook_subscription":{"type":"object","required":["webhook_topic_id","callback_url","shared_secret"],"properties":{"webhook_topic_id":{"type":"integer","example":10,"minimum":1,"maximum":10},"callback_url":{"type":"string","format":"uri","example":"https://webhooks.shop.com"},"shared_secret":{"type":"string","example":"exMh194qw8JD@A50dA^P"}}}},"required":["webhook_subscription"]}}}},"callbacks":{"Subscription created":{"{$request.body#/webhook_subscription.callback_url}":{"parameters":[{"$ref":"#/components/parameters/event_actor_type_header"},{"$ref":"#/components/parameters/shop_identifier_header"},{"in":"header","name":"Event-Identifier","required":true,"description":"The webhook topic name of the event.","schema":{"type":"string","enum":["subscription_created"]}}],"post":{"summary":"Subscription Created","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionEntity"}}}},"responses":{"200":{"description":"Successful operation"}}}}},"Subscription updated":{"{$request.body#/webhook_subscription.callback_url}":{"parameters":[{"$ref":"#/components/parameters/event_actor_type_header"},{"$ref":"#/components/parameters/shop_identifier_header"},{"in":"header","name":"Event-Identifier","required":true,"description":"The webhook topic name of the event.","schema":{"type":"string","enum":["subscription_updated"]}}],"post":{"summary":"Subscription Updated","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionEntity"}}}},"responses":{"200":{"description":"Successful operation"}}}}},"Subscription order created":{"{$request.body#/webhook_subscription.callback_url}":{"parameters":[{"$ref":"#/components/parameters/event_actor_type_header"},{"$ref":"#/components/parameters/shop_identifier_header"},{"in":"header","name":"Event-Identifier","required":true,"description":"The webhook topic name of the event.","schema":{"type":"string","enum":["subscription_order_created"]}}],"post":{"summary":"Subscription Order Created","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionOrder"}}}},"responses":{"200":{"description":"Successful operation"}}}}},"Customer created":{"{$request.body#/webhook_subscription.callback_url}":{"parameters":[{"$ref":"#/components/parameters/event_actor_type_header"},{"$ref":"#/components/parameters/shop_identifier_header"},{"in":"header","name":"Event-Identifier","required":true,"description":"The webhook topic name of the event.","schema":{"type":"string","enum":["customer_created"]}}],"post":{"summary":"Customer Created","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerEntity"}}}},"responses":{"200":{"description":"Successful operation"}}}}},"Customer updated":{"{$request.body#/webhook_subscription.callback_url}":{"parameters":[{"$ref":"#/components/parameters/event_actor_type_header"},{"$ref":"#/components/parameters/shop_identifier_header"},{"in":"header","name":"Event-Identifier","required":true,"description":"The webhook topic name of the event.","schema":{"type":"string","enum":["customer_updated"]}}],"post":{"summary":"Customer Updated","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Customer"}}}},"responses":{"200":{"description":"Successful operation"}}}}},"Subscription order transaction failed":{"{$request.body#/webhook_subscription.callback_url}":{"parameters":[{"$ref":"#/components/parameters/event_actor_type_header"},{"$ref":"#/components/parameters/shop_identifier_header"},{"in":"header","name":"Event-Identifier","required":true,"description":"The webhook topic name of the event.","schema":{"type":"string","enum":["subscription_order_transaction_failed"]}}],"post":{"summary":"Subscription Order Transaction Failed","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionOrderTransactionFailed"}}}},"responses":{"200":{"description":"Successful operation"}}}}},"Subscription order max retries reached":{"{$request.body#/webhook_subscription.callback_url}":{"parameters":[{"$ref":"#/components/parameters/event_actor_type_header"},{"$ref":"#/components/parameters/shop_identifier_header"},{"in":"header","name":"Event-Identifier","required":true,"description":"The webhook topic name of the event.","schema":{"type":"string","enum":["subscription_order_max_retries_reached"]}}],"post":{"summary":"Subscription Order Max Retries Reached","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionOrderTransactionFailed"}}}},"responses":{"200":{"description":"Successful operation"}}}}},"Subscription payment method updated":{"{$request.body#/webhook_subscription.callback_url}":{"parameters":[{"$ref":"#/components/parameters/event_actor_type_header"},{"$ref":"#/components/parameters/shop_identifier_header"},{"in":"header","name":"Event-Identifier","required":true,"description":"The webhook topic name of the event.","schema":{"type":"string","enum":["subscription_payment_method_updated"]}}],"post":{"summary":"Subscription Payment Method Updated","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionEntity"}}}},"responses":{"200":{"description":"Successful operation"}}}}},"Upcoming order":{"{$request.body#/webhook_subscription.callback_url}":{"parameters":[{"$ref":"#/components/parameters/event_actor_type_header"},{"$ref":"#/components/parameters/shop_identifier_header"},{"in":"header","name":"Event-Identifier","required":true,"description":"The webhook topic name of the event.","schema":{"type":"string","enum":["subscription_upcoming_order"]}}],"post":{"summary":"Upcoming Order","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Subscription"}}}},"responses":{"200":{"description":"Successful operation"}}}}},"Expiring payment method":{"{$request.body#/webhook_subscription.callback_url}":{"parameters":[{"$ref":"#/components/parameters/event_actor_type_header"},{"$ref":"#/components/parameters/shop_identifier_header"},{"in":"header","name":"Event-Identifier","required":true,"description":"The webhook topic name of the event.","schema":{"type":"string","enum":["subscription_expiring_payment"]}}],"post":{"summary":"Expiring Payment Method","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionAndPaymentMethod"}}}},"responses":{"200":{"description":"Successful operation"}}}}},"Subscription cancelled":{"{$request.body#/webhook_subscription.callback_url}":{"parameters":[{"$ref":"#/components/parameters/event_actor_type_header"},{"$ref":"#/components/parameters/shop_identifier_header"},{"in":"header","name":"Event-Identifier","required":true,"description":"The webhook topic name of the event.","schema":{"type":"string","enum":["subscription_cancelled"]}}],"post":{"summary":"Subscription Cancelled","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionEntity"}}}},"responses":{"200":{"description":"Successful operation"}}}}},"Subscription frequency updated":{"{$request.body#/webhook_subscription.callback_url}":{"parameters":[{"$ref":"#/components/parameters/event_actor_type_header"},{"$ref":"#/components/parameters/shop_identifier_header"},{"in":"header","name":"Event-Identifier","required":true,"description":"The webhook topic name of the event.","schema":{"type":"string","enum":["subscription_frequency_updated"]}}],"post":{"summary":"Subscription Frequency Updated","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionEntity"}}}},"responses":{"200":{"description":"Successful operation"}}}}},"Subscription credit card updated":{"{$request.body#/webhook_subscription.callback_url}":{"parameters":[{"$ref":"#/components/parameters/event_actor_type_header"},{"$ref":"#/components/parameters/shop_identifier_header"},{"in":"header","name":"Event-Identifier","required":true,"description":"The webhook topic name of the event.","schema":{"type":"string","enum":["subscription_credit_card_updated"]}}],"post":{"summary":"Subscription Credit Card Updated","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionEntity"}}}},"responses":{"200":{"description":"Successful operation"}}}}},"Subscription payment failed":{"{$request.body#/webhook_subscription.callback_url}":{"parameters":[{"$ref":"#/components/parameters/event_actor_type_header"},{"$ref":"#/components/parameters/shop_identifier_header"},{"in":"header","name":"Event-Identifier","required":true,"description":"The webhook topic name of the event.","schema":{"type":"string","enum":["subscription_payment_failed"]}}],"post":{"summary":"Subscription Payment Failed","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionEntity"}}}},"responses":{"200":{"description":"Successful operation"}}}}},"Subscription paused":{"{$request.body#/webhook_subscription.callback_url}":{"parameters":[{"$ref":"#/components/parameters/event_actor_type_header"},{"$ref":"#/components/parameters/shop_identifier_header"},{"in":"header","name":"Event-Identifier","required":true,"description":"The webhook topic name of the event.","schema":{"type":"string","enum":["subscription_paused"]}}],"post":{"summary":"Subscription Paused","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionEntity"}}}},"responses":{"200":{"description":"Successful operation"}}}}},"Subscription resumed":{"{$request.body#/webhook_subscription.callback_url}":{"parameters":[{"$ref":"#/components/parameters/event_actor_type_header"},{"$ref":"#/components/parameters/shop_identifier_header"},{"in":"header","name":"Event-Identifier","required":true,"description":"The webhook topic name of the event.","schema":{"type":"string","enum":["subscription_resumed"]}}],"post":{"summary":"Subscription Resumed","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionEntity"}}}},"responses":{"200":{"description":"Successful operation"}}}}},"Subscription reactivated":{"{$request.body#/webhook_subscription.callback_url}":{"parameters":[{"$ref":"#/components/parameters/event_actor_type_header"},{"$ref":"#/components/parameters/shop_identifier_header"},{"in":"header","name":"Event-Identifier","required":true,"description":"The webhook topic name of the event.","schema":{"type":"string","enum":["subscription_reactivated"]}}],"post":{"summary":"Subscription Reactivated","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionEntity"}}}},"responses":{"200":{"description":"Successful operation"}}}}},"Subscription shipping address updated":{"{$request.body#/webhook_subscription.callback_url}":{"parameters":[{"$ref":"#/components/parameters/event_actor_type_header"},{"$ref":"#/components/parameters/shop_identifier_header"},{"in":"header","name":"Event-Identifier","required":true,"description":"The webhook topic name of the event.","schema":{"type":"string","enum":["subscription_shipping_address_updated"]}}],"post":{"summary":"Subscription Shipping Address Updated","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionEntity"}}}},"responses":{"200":{"description":"Successful operation"}}}}},"Subscription quantity updated":{"{$request.body#/webhook_subscription.callback_url}":{"parameters":[{"$ref":"#/components/parameters/event_actor_type_header"},{"$ref":"#/components/parameters/shop_identifier_header"},{"in":"header","name":"Event-Identifier","required":true,"description":"The webhook topic name of the event.","schema":{"type":"string","enum":["subscription_quantity_updated"]}}],"post":{"summary":"Subscription Quantity Updated","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionEntity"}}}},"responses":{"200":{"description":"Successful operation"}}}}},"Subscription skipped":{"{$request.body#/webhook_subscription.callback_url}":{"parameters":[{"$ref":"#/components/parameters/event_actor_type_header"},{"$ref":"#/components/parameters/shop_identifier_header"},{"in":"header","name":"Event-Identifier","required":true,"description":"The webhook topic name of the event.","schema":{"type":"string","enum":["subscription_skipped"]}}],"post":{"summary":"Subscription Skipped","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionEntity"}}}},"responses":{"200":{"description":"Successful operation"}}}}},"Subscription line items added":{"{$request.body#/webhook_subscription.callback_url}":{"parameters":[{"$ref":"#/components/parameters/event_actor_type_header"},{"$ref":"#/components/parameters/shop_identifier_header"},{"in":"header","name":"Event-Identifier","required":true,"description":"The webhook topic name of the event.","schema":{"type":"string","enum":["subscription_line_items_added"]}}],"post":{"summary":"Subscription Line Items Added","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionEntity"}}}},"responses":{"200":{"description":"Successful operation"}}}}}}}},"/subscriptions/v1/shops/{shop_identifier}/webhooks/subscriptions/{webhook_subscription_id}":{"parameters":[{"$ref":"#/components/parameters/shop_identifier_path_param"},{"$ref":"#/components/parameters/webhook_subscription_id_path_param"}],"get":{"summary":"Get Webhook Subscription","operationId":"GetWebhookSubscription","tags":["Webhook Subscriptions"],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookSubscription"}}}},"401":{"description":"Unauthenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthenticatedResponse"}}}}},"description":"Retrieve a webhook subscription by its id."},"put":{"summary":"Update Webhook Subscription","operationId":"UpdateWebhookSubscription","tags":["Webhook Subscriptions"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookSubscription"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookSubscription"}}}},"401":{"description":"Unauthenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthenticatedResponse"}}}}},"description":"Update a webhook subscription by its id."},"delete":{"tags":["Webhook Subscriptions"],"summary":"Delete Webhook Subscription","operationId":"DeleteWebhookSubscription","responses":{"200":{"description":"Successful operation"},"401":{"description":"Unauthenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthenticatedResponse"}}}}},"description":"Delete a webhook subscription by its id."}},"/subscriptions/v1/shops/{shop_identifier}/webhooks/events":{"get":{"summary":"List Webhook Events","operationId":"ListWebhookEvents","tags":["Webhook Events"],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookEvents"},"examples":{"example":{"value":{"webhook_events":[{"id":0,"shop_id":0,"webhook_subscription_id":0,"webhook_topic_id":0,"uuid":"string","attempts":0,"last_response_status_code":"string","delivered_at":"string","created_at":"2019-11-20T20:31:55Z","updated_at":"2019-11-20T20:31:55Z","deleted_at":null}],"pagination":{"limit":10,"count":1,"total":1,"total_pages":1}}}}}}},"401":{"description":"Unauthenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthenticatedResponse"}}}}},"description":"Retrieve a list of webhook events.","parameters":[{"$ref":"#/components/parameters/shop_identifier_path_param"},{"schema":{"type":"integer"},"in":"query","name":"since_id"},{"schema":{"type":"string"},"in":"query","name":"limit","description":"Maximum number of results to be returned"},{"schema":{"type":"array","items":{"type":"string","enum":["shop_id","webhook_subscription_id","webhook_topic_id","uuid","attempts","last_response_status_code","id","created_at","updated_at","delivered_at"]}},"in":"query","name":"filters","description":"Filter event webhooks. Mulitple filters can be passed in the array."}]}},"/subscriptions/v1/shops/{shop_identifier}/webhooks/events/{webhook_event_id}":{"parameters":[{"$ref":"#/components/parameters/shop_identifier_path_param"},{"$ref":"#/components/parameters/webhook_event_id_path_param"}],"get":{"summary":"Get Webhook Event","operationId":"GetWebhookEvent","description":"Retrieve a webhook event by its id.","tags":["Webhook Events"],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookEvent"}}}},"401":{"description":"Unauthenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthenticatedResponse"}}}}}}},"/subscriptions/v1/shops/{shop_identifier}/subscriptions/{subscription_id}/alternative_payments":{"parameters":[{"$ref":"#/components/parameters/shop_identifier_path_param"},{"$ref":"#/components/parameters/subscription_id_path_param"}],"get":{"summary":"List Alternative Payment Methods","operationId":"ListAlternativePaymentMethods","tags":["Payment Methods"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlternatePaymentMethod"}}}}},"description":"Retrieve a list of alternative payment methods for a subscription."},"post":{"summary":"Create Alternative Payment Method","operationId":"CreateAlternativePaymentMethods","tags":["Payment Methods"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"description":"","type":"object","properties":{"alternative_payment_methods":{"type":"array","uniqueItems":true,"minItems":1,"items":{"required":["subscription_id","public_payment_token"],"properties":{"subscription_id":{"type":"number"},"public_payment_token":{"type":"string","minLength":1}}}}},"required":["alternative_payment_methods"]},"examples":{"example-1":{"value":{"alternative_payment_methods":[{"subscription_id":0,"public_payment_token":"string"}]}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"description":"","type":"object","properties":{"alternative_payment_methods":{"type":"array","uniqueItems":true,"minItems":1,"maxItems":1,"items":{"type":"object","properties":{"type":{"type":"string","minLength":1},"payment_details":{"type":"object","properties":{"card_number":{"type":"string","minLength":1},"security_key":{"type":"string"}},"required":["card_number","security_key"]}},"required":["type"]}}},"required":["alternative_payment_methods"]},"examples":{"example-1":{"value":{"alternative_payment_methods":[{"type":"gift_card","payment_details":{"card_number":"ABC1234","security_key":"123"}}]}},"example-2":{"value":{"alternative_payment_methods":[{"type":"string","payment_details":{"card_number":"string","security_key":"0"}}]}}}}},"description":""},"description":"Add an alternate payment method to a subscription."}},"/subscriptions/v1/shops/{shop_identifier}/subscriptions/{subscription_id}/alternative_payments/{payment_public_id}":{"parameters":[{"$ref":"#/components/parameters/shop_identifier_path_param"},{"$ref":"#/components/parameters/subscription_id_path_param"},{"schema":{"type":"string"},"name":"payment_public_id","in":"path","required":true}],"delete":{"summary":"Delete Alternative Payment Method","operationId":"DeleteAlternativePaymentMethod","tags":["Payment Methods"],"responses":{"200":{"description":"OK"}},"description":"Remove an alternative payment method from a subscription its paymentPublicID."}},"/subscriptions/v1/shops/{shop_identifier}/subscription_groups/{group_id}/selection_options/{selection_option_id}":{"parameters":[{"$ref":"#/components/parameters/shop_identifier_path_param"},{"$ref":"#/components/parameters/group_id_path_param"},{"schema":{"type":"string"},"name":"selection_option_id","in":"path","required":true,"description":"Selection option ID of the item to be deleted from the group."}],"delete":{"summary":"Delete Selection Option by ID","operationId":"DeleteSelectionOptionByID","responses":{"200":{"description":"Successful operation"},"401":{"description":"Unauthorized"},"404":{"description":"Subscription group or selection option not found"}},"description":"Delete a selection option from inside a subscription group.","tags":["Subscription Groups"]}},"/subscriptions/v1/shops/{shop_identifier}/subscription_groups/{group_id}/selection_options":{"parameters":[{"$ref":"#/components/parameters/shop_identifier_path_param"},{"$ref":"#/components/parameters/group_id_path_param"}],"delete":{"summary":"Delete Selection Option by Filter","operationId":"DeleteSelectionOptionByFilter","responses":{"200":{"description":"Successful operation"},"401":{"description":"Unauthorized"},"404":{"description":"Subscription group or selection option not found"}},"description":"Delete one or more selection options from inside a subscription group.","tags":["Subscription Groups"],"parameters":[{"schema":{"type":"string"},"in":"query","name":"filter","description":"Accepts filtering options as described here: https://developer.boldcommerce.com/guides/subscriptions-v2/resources/query-pagination. Example: to remove the platform product IDs 1, 2 and 3 from a subscription group, the following query param must be added: ?filter=in(platform_entity_id:1,2,3)","required":true}]},"post":{"tags":["Subscription Groups"],"summary":"Add Selection Options by Platform Product ID(s)","operationId":"AddSelectionOptionsByPlatformIDs","description":"Add one or more selection options from inside a subscription group.\\n","requestBody":{"content":{"application/json":{"schema":{"description":"","type":"object","x-examples":{"example-1":{"subscription_group":{"selection_options":{"platform_entity_ids":[]}}}},"properties":{"subscription_group":{"type":"object","required":["selection_options"],"properties":{"selection_options":{"type":"object","required":["platform_entity_ids"],"properties":{"platform_entity_ids":{"type":"array","description":"These are product ids we are look","items":{"type":"integer"}}}}}}},"required":["subscription_group"]},"examples":{"Example Body":{"value":{"subscription_group":{"selection_options":{"platform_entity_ids":[7021943390389,7003068956853,7014441746613]}}}}}}},"description":"Add one or more selection options to a subscription group. Right now the only supported selection option is product. A list of platform product IDs can be passed as platform_entity_ids."},"responses":{"200":{"description":"Successful operation"},"401":{"description":"Unauthorized"},"404":{"description":"Subscription group or selection option not found"}}}},"/subscriptions/v1/shops/{shop_identifier}/subscriptions/{subscription_id}/line_items/{line_item_id}/attributes":{"parameters":[{"$ref":"#/components/parameters/shop_identifier_path_param"},{"$ref":"#/components/parameters/subscription_id_path_param"},{"$ref":"#/components/parameters/line_item_id_path_param"}],"post":{"description":"Add a new set of attributes to a line item.","tags":["Subscription Line Items"],"summary":"Create Line Item Attributes","operationId":"CreateLineItemAttributes","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"line_item_attributes":{"type":"array","items":{"$ref":"#/components/schemas/LineItemAttributeEntity"}}}},"examples":{"success-example":{"value":{"line_item_attributes":[{"name":"size_preference","value":"XL","created_at":"2021-01-17T20:30:40Z","updated_at":"2021-01-17T20:30:40Z","subscription_id":1,"line_item_id":1},{"name":"color_preference","value":"green","created_at":"2021-01-17T20:30:40Z","updated_at":"2021-01-17T20:30:40Z","subscription_id":1,"line_item_id":1}]}}}}}},"404":{"description":"Subscription or line item not found"}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"line_item_attributes":{"type":"array","items":{"$ref":"#/components/schemas/LineItemAttributeEntity"}}}},"examples":{"request-body-example":{"value":{"line_item_attributes":[{"name":"size_preference","value":"XL"},{"name":"color_preference","value":"green"}]}}}}}}},"patch":{"tags":["Subscription Line Items"],"summary":"Update Line Item Attributes","operationId":"UpdateLineItemAttributes","description":"Create, remove, or update attributes for a specific line item inside a subscription. Your request payload must contain the full list of attributes for the line item.\\n\\nTo add an attribute to the line item, include a new attribute in the request payload. To update an attribute that already exists on the line item, include the attribute in the payload with the same name and an updated value. To delete one attribute, leave the attribute out of the request payload. To remove all attributes of a line item, use an empty array as the request payload.","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"subscription_line_item":{"$ref":"#/components/schemas/LineItemEntity"}}},"examples":{"success-example":{"value":{"subscription_line_item":{"id":1,"subscription_id":1,"platform_id":"ABC123","platform_product_id":"1357908642","platform_variant_id":"2468097531","subscription_group_id":1,"subscription_group_billing_rules_id":1,"title":"Monthly Expansion Pack","product_name":"Monthly Expansion Pack","variant_name":"Default Title","sku":"SKU-113-Red","url":"https://example-store.example.com/monthly-expansion-pack","image":"","quantity":1,"price":3500,"price_charged":3200,"discounted_price":3200,"discounted_price_charged":3200,"full_price":3200,"full_price_charged":3200,"requires_shipping":false,"grams":2200,"weight":2.2,"weight_unit":"kg","taxable":true,"discounts":[{"id":1,"subscription_line_item_id":1,"shop_id":5,"full_price":5,"discount_type":"percentage","percentage_value":10,"fixed_value":0,"fixed_value_charged":0,"description":"Subscription discount (10%) for Monthly Expansion Pack","created_at":"2019-11-20T20:31:55Z","updated_at":"2019-11-20T20:31:55Z","deleted_at":"2019-11-20T20:31:55Z"}],"prepaid_metadata":{"id":1,"line_item_id":2,"prepaid_duration":2,"current_recurrence_count":2,"prepaid_continue":"no_continue"},"line_item_attributes":[{"name":"size_preference","value":"XL","created_at":"2021-01-17T20:30:40Z","updated_at":"2021-01-17T20:30:40Z","subscription_id":1,"line_item_id":1},{"name":"color_preference","value":"green","created_at":"2021-01-17T20:30:40Z","updated_at":"2021-01-17T20:30:40Z","subscription_id":1,"line_item_id":1}],"created_at":"2019-11-20T20:31:55Z","updated_at":"2019-11-20T20:31:55Z"}}}}}}},"404":{"description":"Subscription or line item not found"}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"line_item_attributes":{"type":"array","items":{"$ref":"#/components/schemas/LineItemAttributeEntity"}}}},"examples":{"request-body-example":{"value":{"line_item_attributes":[{"name":"size_preference","value":"XL"},{"name":"color_preference","value":"green"}]}}}}}}}},"/subscriptions/v1/shops/{shop_identifier}/subscriptions/{subscription_id}/line_items/{line_item_id}/prepaid_metadata":{"parameters":[{"$ref":"#/components/parameters/shop_identifier_path_param"},{"$ref":"#/components/parameters/subscription_id_path_param"},{"$ref":"#/components/parameters/line_item_id_path_param"}],"post":{"tags":["Subscription Line Items"],"summary":"Create Line Item Prepaid Metadata","operationId":"CreateLineItemPrepaidMetadata","description":"Add prepaid metadata to a line item to convert a subscription to prepaid. Adding this metadata to one line item converts the whole order to prepaid.\\n\\n**Note:** Converting a subscription to prepaid does not automatically charge the customer for the balance of the prepaid subscription. To charge the customer the prepaid subscription amount on the next recurrence, set `prepaid_duration` to the same value as `prepaid_recurrence_count`, and set `prepaid_continue` to `as_prepaid`. This causes Bold to start a new prepaid subscription on the next recurrence and set the `prepaid_recurrence_count` back to `1`.","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"prepaid_metadata":{"$ref":"#/components/schemas/PrepaidMetadataEntity"}}},"examples":{"success-example":{"value":{"prepaid_metadata":{"id":1,"line_item_id":2,"prepaid_duration":2,"current_recurrence_count":2,"prepaid_continue":"no_continue"}}}}}}},"404":{"description":"Subscription or Line Item Not Found"}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"prepaid_metadata":{"$ref":"#/components/schemas/PrepaidMetadataEntity"}}},"examples":{"request-body-example":{"value":{"prepaid_metadata":{"prepaid_continue":"as_prepaid","prepaid_duration":6,"current_recurrence_count":6}}}}}}}},"patch":{"summary":"Update Line Item Prepaid Metadata","operationId":"UpdateLineItemPrepaidMetadata","tags":["Subscription Line Items"],"description":"Update or create new prepaid metadata for a line item.\\n\\n**Note:** Updating the `prepaid_duration` or `current_recurrence_count` does not result in any automatic charges or change in charges to an existing prepaid customer. Adding new prepaid metadata to a subscription converts it to prepaid. For more information on converting a subscription to prepaid, refer to the [Create Line Item Prepaid Metadata](/api/subscriptions#tag/Subscriptions#operation/CreateLineItemPrepaidMetadata) endpoint.","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"prepaid_metadata":{"$ref":"#/components/schemas/PrepaidMetadataEntity"}}},"examples":{"success-example":{"value":{"prepaid_metadata":{"id":1,"line_item_id":2,"prepaid_duration":2,"current_recurrence_count":2,"prepaid_continue":"no_continue"}}}}}}},"404":{"description":"Subscription or Line Item Not Found"}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"prepaid_metadata":{"$ref":"#/components/schemas/PrepaidMetadataEntity"}}},"examples":{"request-body-example":{"value":{"prepaid_metadata":{"prepaid_continue":"no_continue","prepaid_duration":6,"current_recurrence_count":6}}}}}}}}}},"components":{"securitySchemes":{"OAuthToken":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://apps.boldapps.net/accounts/dashboard/authorize","tokenUrl":"https://api.boldcommerce.com/auth/oauth2/token","scopes":{}}},"description":"Authenticates an API request from a [public integration](/guides/subscriptions-v2/resources/glossary#public-integration). Generate this token in the [Developer Dashboard](https://developer-dashboard.boldcommerce.com/default/dashboard). Refer to [Build Public Integrations](/guides/subscriptions-v2/public-integrations) for more information."},"APIAccessToken":{"type":"apiKey","name":"API Access Token","in":"header","description":"Authenticates an API request from a [private integration](/guides/subscriptions-v2/resources/glossary#private-integration). Generate this token in the [Bold Account Center](https://account.boldcommerce.com/). Refer to [Making API Calls](/guides/subscriptions-v2/quick-start) for more information."}},"schemas":{"BillingRuleEntity":{"type":"object","title":"","properties":{"id":{"type":"integer","example":1,"readOnly":true},"shop_id":{"type":"integer","example":1,"readOnly":true},"subscription_group_id":{"type":"integer","example":1,"readOnly":true},"interval_number":{"type":"integer","example":1},"interval_type":{"type":"string","example":"month","enum":["custom","day","week","month","year"]},"interval_name":{"type":"string","example":"Monthly","maxLength":255},"week_type":{"type":"string","example":"","enum":["purchase_day","each",""]},"week_day":{"type":"integer","example":0,"description":"Sets day of week when paired with week_type=each. Valid values are SU, MO, TU, WE, TH, FR, and SA. Can be comma separated list."},"month_type":{"type":"string","example":"purchase_day","enum":["purchase_day","each","on_the",""]},"month_day":{"type":"string","example":"","description":"Sets the day of the month when combined with month_type=each. Numbers in range 1-31. Can be comma separated list of numbers."},"month_occurrence":{"type":"string","example":"","enum":["first","second","third","fourth","fifth","last",""]},"month_occurrence_day":{"type":"string","example":"MO","description":"Sets day of week when paired with month_occurence=on_the. Valid values are SU, MO, TU, WE, TH, FR, SA, day, business_day, weekend_day. Can be comma separated list."},"year_type":{"type":"string","enum":["purchase_day","on_the",""]},"year_month":{"type":"string","example":"","description":"Sets month of year when combined with year_type=on_the. Valid values between 1-12. Can be comma separated list."},"year_occurrence":{"type":"string","example":"","enum":["first","second","third","fourth","fifth","last",""]},"year_occurrence_day":{"type":"string","example":"","description":"Sets day of week when paired with year_occurence. Valid values are SU, MO, TU, WE, TH, FR, SA, day, business_day, weekend_day. Can be comma separated list."},"billing_rule":{"type":"string","example":"FREQ=MONTHLY"},"created_at":{"type":"string","readOnly":true,"example":"2019-11-20T20:31:55Z","format":"date-time"},"updated_at":{"type":"string","readOnly":true,"example":"2019-11-20T20:31:55Z","format":"date-time"},"deleted_at":{"type":"string","example":null,"readOnly":true,"format":"date-time","nullable":true},"custom_billing_rule":{"type":"string","description":"A custom RRULE for the subscription group"},"buffer_days":{"type":"integer","minimum":0,"maximum":365},"buffer_time":{"type":"string","format":"time","example":"01:00:00","description":"Time is in format HH:mm:ss"}}},"Customers":{"properties":{"customers":{"type":"array","items":{"$ref":"#/components/schemas/CustomerEntity"}}},"type":"object"},"Customer":{"properties":{"customer":{"$ref":"#/components/schemas/CustomerEntity"}},"type":"object"},"CustomerEntity":{"type":"object","required":["id","platform_id","cashier_public_id","first_name","last_name","phone","email","notes","addresses","default_address","subscription_summary","labels","created_at"],"properties":{"id":{"description":"The customer ID.","type":"integer","readOnly":true,"example":2},"platform_id":{"description":"The customer platform ID.","type":"string","readOnly":true,"example":"123456790"},"cashier_public_id":{"type":"string","description":"The public customer ID generated when using Bold Checkout, set to `null` otherwise.","example":null,"nullable":true,"readOnly":true},"first_name":{"type":"string","description":"The customer\'s first name.","example":"Jane"},"last_name":{"type":"string","description":"The customer\'s last name.","example":"Doe"},"email":{"type":"string","description":"The customer\'s email","example":"jane.doe@example.com"},"phone":{"type":"string","description":"The customer\'s phone number. For Shopify checkout users, [you can configure phone number requirements in the admin](/guides/subscriptions-v2/create-subscription#how-do-i-make-phone-numbers-optional-when-using-shopify-checkout).","example":"12045551234"},"notes":{"type":"string","description":"The customer\'s internal notes. This is applied as a note in the **Customer info** section of Bold Subscriptions admin.","example":"Loyal customer"},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/CustomerAddressEntity"},"readOnly":true},"default_address":{"description":"The customer\'s default address.","readOnly":true,"allOf":[{"$ref":"#/components/schemas/CustomerAddressEntity"}]},"subscription_summary":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/CustomerSubscriptionSummary"}]},"labels":{"type":"array","items":{"$ref":"#/components/schemas/CustomerLabel"},"readOnly":true},"created_at":{"$ref":"#/components/schemas/createdAt"}}},"CustomerSubscriptionSummary":{"type":"object","required":["bold_platform_customer_id","next_order_date","last_order_date","active_subscription_count","inactive_subscription_count","subscription_order_count","lifetime_value_usd"],"description":"Summary of the customer\'s subscriptions.","properties":{"bold_platform_customer_id":{"type":"integer","description":"The customer\'s ID.","example":2,"readOnly":true},"next_order_date":{"type":"string","description":"The cext order date and time for the subscription.","example":"2020-01-20T18:00:00Z","readOnly":true},"last_order_date":{"type":"string","description":"The most recent order date and time for a subscription.","example":"2019-11-20T20:55:27Z","readOnly":true},"active_subscription_count":{"type":"integer","description":"The number of active subscriptions.","example":2,"readOnly":true},"inactive_subscription_count":{"type":"integer","description":"The number of inactive subscriptions.","example":1,"readOnly":true},"subscription_order_count":{"type":"integer","description":"The number of subscription orders for this customer. Initial orders count toward this total.","example":5,"readOnly":true},"lifetime_value_usd":{"type":"number","description":"The total value of the order made by this customer in USD.","example":152.12,"readOnly":true}}},"CustomerAddressEntity":{"type":"object","required":["id","shop_identifier","platform_id","customer_id","platform_type","platform_customer_id","first_name","last_name","company","phone","street1","street2","city","province","province_code","country","country_code","zip","is_default","address_use","address_source","created_at","updated_at","deleted_at"],"properties":{"id":{"type":"integer","description":"The address ID.","readOnly":true,"example":1},"shop_identifier":{"type":"string","description":"The platform shop identifier.","readOnly":true,"example":"12345"},"platform_id":{"type":"string","description":"The platform address identifier.","readOnly":true,"example":"14"},"customer_id":{"type":"integer","description":"The customer ID.","readOnly":true,"example":2},"platform_type":{"type":"string","enum":["bigcommerce","commercetools","custom","shopify","woocommerce"],"description":"The e-commerce platform being used by the shop (might also be \'custom\' for no specific e-commerce platform).","readOnly":true,"example":"shopify"},"platform_customer_id":{"type":"string","readOnly":true,"description":"The ID of the customer on the platform.","example":"35"},"first_name":{"type":"string","description":"The customer\'s first name.","example":"John"},"last_name":{"type":"string","description":"The customer\'s last name(s).","example":"Doe"},"company":{"type":"string","description":"The customer\'s company name.","example":"Example Company"},"phone":{"type":"string","description":"The customer\'s phone number.","example":"123-456-7890"},"street1":{"type":"string","description":"The customer\'s street address (street name and number).","example":"123 example st."},"street2":{"type":"string","description":"The address complement (suite number, unit number, etc.).","example":"101"},"city":{"type":"string","description":"The customer\'s city.","example":"Toronto"},"province":{"type":"string","description":"The customer\'s province or state, as applicable. Can be an empty string in case the address has no state/province.","example":"Ontario"},"province_code":{"type":"string","description":"The customer\'s province or state code (usually 2 characters), as applicable. Can be an empty string in case the address has no state/province.","example":"ON"},"country":{"type":"string","description":"The customer\'s country name.","example":"Canada"},"country_code":{"type":"string","description":"The customer\'s alpha 2 country code, according to ISO 3166-1 (reference: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).","example":"CA"},"zip":{"type":"string","description":"The customer\'s postal code.","example":"M5V 3L9"},"is_default":{"type":"boolean","description":"Defines if this address should be considered the default one for the customer.","example":true},"address_use":{"type":"string","nullable":true,"description":"The address usage (billing, shipping). Only set for WooCommerce, `null` otherwise.","example":"billing"},"address_source":{"type":"string","description":"The address source.","enum":["platform","bold"],"readOnly":true,"example":"platform"},"created_at":{"$ref":"#/components/schemas/createdAt"},"updated_at":{"$ref":"#/components/schemas/updatedAt"},"deleted_at":{"$ref":"#/components/schemas/deletedAt"}}},"UpdateCustomerAddressEntity":{"type":"object","required":["first_name","last_name","phone","street1","city","province","province_code","country","country_code","zip"],"properties":{"first_name":{"type":"string","description":"Customer\'s first name.","example":"John"},"last_name":{"type":"string","description":"Customer\'s last name(s).","example":"Doe"},"company":{"type":"string","description":"Customer\'s company name.","example":"Example Company"},"phone":{"type":"string","description":"Customer\'s phone number.","example":"123-456-7890"},"street1":{"type":"string","description":"Customer\'s street address (street name and number).","example":"123 example st."},"street2":{"type":"string","description":"Address complement (suite number, unit number, etc.).","example":"101"},"city":{"type":"string","description":"Customer\'s city.","example":"Toronto"},"province":{"type":"string","description":"Customer\'s province or state, as applicable. Can be an empty string in case the address has no state/province.","example":"Ontario"},"province_code":{"type":"string","description":"Customer\'s province or state code (usually 2 characters), as applicable. If the address has no state/province, leave empty.","example":"ON"},"country":{"type":"string","description":"Customer\'s country name.","example":"Canada"},"country_code":{"type":"string","description":"Customer\'s alpha 2 country code, according to ISO 3166-1 (reference: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).","example":"CA"},"zip":{"type":"string","description":"Customer\'s postal code.","example":"M5V 3L9"},"is_default":{"type":"boolean","description":"Indicates whether this address should be considered the default one for the customer.","example":true},"address_use":{"type":"string","description":"Address usage (billing, shipping). Only set for WooCommerce."}}},"CustomerLabel":{"type":"object","description":"The label assigned to a customer.","required":["id","name","created_at","updated_at","deleted_at"],"properties":{"id":{"type":"integer","description":"The customer label ID.","example":12,"readOnly":true},"customer_id":{"type":"integer","description":"The customer ID.","example":21,"readOnly":true},"name":{"type":"string","description":"The content of the label.","example":"bsub_subscription_active"},"created_at":{"$ref":"#/components/schemas/createdAt"},"updated_at":{"$ref":"#/components/schemas/updatedAt"},"deleted_at":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/deletedAt"}]}}},"FutureOrders":{"properties":{"future_orders":{"type":"array","items":{"$ref":"#/components/schemas/FutureOrderEntity"}},"pagination":{"$ref":"#/components/schemas/FutureOrdersCursorPagination"}},"type":"object"},"UnauthenticatedResponse":{"type":"object","properties":{"error":{"type":"string","description":"The error summary.","example":"invalid_request"},"error_description":{"type":"string","description":"The detailed error message.","example":"The access token is missing"}},"example":{"error":"invalid_request","error_description":"The access token is missing"}},"FutureOrderEntity":{"properties":{"id":{"type":"string","description":"The unique identifier of the future order in the format `{subscription_id}-{order_date}`, where `{order_date}` uses [RFC 3339 format](https://www.ietf.org/rfc/rfc3339.txt).","example":"53236-2024-05-21T08:00:00Z"},"date":{"type":"string","description":"The date and time of the future order, in [RFC 3339 format](https://www.ietf.org/rfc/rfc3339.txt).","example":"2024-05-21T08:00:00Z"},"bold_customer_id":{"type":"integer","description":"The ID for the customer associated with the future order.","example":1697912},"bold_platform_subscription_id":{"type":"integer","description":"The ID of the subscription associated with the future order.","example":4712349},"currency":{"type":"string","description":"The currency used for the future order, in [ISO-4217](https://www.iso.org/iso-4217-currency-codes.html) format.","example":"USD"},"order_count":{"type":"integer","description":"The number (\\"n\\") indicates the future order will be the nth order for the subscription. The value will be `null` if the future order is skipped. Example: `order_count: 6` means the future order is the 6th order for the subscription.","example":6,"nullable":true},"subscription_data":{"type":"object","description":"Details on the subscription associated with the future order.","properties":{"id":{"type":"integer","description":"The ID of the subscription associated with the future order.","example":4712349},"order_count":{"type":"integer","description":"The number of orders currently processed by the subscription associated with the future order.","example":2},"discount_code":{"type":"string","description":"The discount code currently on the subscription. The value is an empty string `\\"\\"` if no discount is applied.","example":"BOXINGDAYSUB"},"order_rrule":{"type":"string","description":"An RRULE describing how frequently orders are processed for the subscription. Learn more about [RRULEs](https://support.boldcommerce.com/hc/en-us/articles/360045174132-Use-RRULES-in-Bold-Subscriptions).","example":"DTSTART:20210521T080000Z\\nRRULE:FREQ=MONTHLY"},"base_currency":{"type":"string","description":"The base currency of the subscription, in [ISO 4217 format](https://www.iso.org/iso-4217-currency-codes.html). This aligns with the store\'s platform configuration for primary currency when the subscription was placed, unless later modified.","example":"CAD"},"charged_currency":{"type":"string","description":"The currency the customer is charged in, in [ISO 4217 format](https://www.iso.org/iso-4217-currency-codes.html).","example":"USD"},"base_to_charged_exchange_rate":{"type":"number","description":"The exchange rate from the subscription\'s base currency to the charged currency.","example":0.79},"placed_at":{"type":"string","description":"The date and time the subscription was placed by the customer, in [RFC 3339 format](https://www.ietf.org/rfc/rfc3339.txt). For programmatically created or migrated subscriptions this value may be `null`.","nullable":true,"example":"2024-02-21T08:00:00Z"}}},"is_skipped":{"type":"boolean","description":"Indicates if the future order is set to be skipped.","example":false},"customer":{"$ref":"#/components/schemas/Customer"},"adjustments":{"type":"array","description":"The list of subscription adjustments with target \\"order\\" to apply to the future order. `adjustments` is `null` if there are no adjustments to return.","nullable":true,"minItems":0,"items":{"$ref":"#/components/schemas/SubscriptionAdjustment"}},"line_items":{"type":"array","minItems":0,"description":"The line items in the future order.","items":{"$ref":"#/components/schemas/FutureOrderLineItemEntity"}},"shipping_lines":{"type":"array","description":"The shipping lines for the future order.\\n\\n**Note:** Shipping lines may differ at time of processing. List available shipping lines with the Checkout Frontend [List Shipping Lines endpoint](https://developer.boldcommerce.com/default/api/checkout#tag/Shipping-Lines/operation/ListShippingLines).","items":{"$ref":"#/components/schemas/ShippingLineEntity"}},"billing_address":{"$ref":"#/components/schemas/CustomerAddressEntity"},"shipping_address":{"type":"object","nullable":true,"allOf":[{"$ref":"#/components/schemas/CustomerAddressEntity"}]}},"type":"object","readOnly":true},"FutureOrderLineItemEntity":{"type":"object","properties":{"future_order_id":{"type":"string","description":"The unique identifier of the future order in the format `{subscription_id}-{order_date}`, where `{order_date}` uses [RFC 3339 format](https://www.ietf.org/rfc/rfc3339.txt).","example":"53236-2024-05-21T08:00:00Z"},"bold_platform_subscription_id":{"type":"integer","description":"The ID of the subscription associated with this line item.","example":4712349},"bold_platform_subscription_line_item_id":{"type":"integer","description":"The ID of the subscription line item. If a line item is created from a future adjustment, `bold_subscription_line_item_id` is set to `null`.","example":643723,"nullable":true},"adjustment_id":{"type":"integer","description":"The ID of the subscription adjustment adding this line item to the order, if applicable.","example":36217,"nullable":true},"platform_id":{"type":"string","description":"When applicable, the unique ID of the line item on the platform subscription.","example":"6434329530","nullable":true},"platform_product_id":{"type":"string","description":"The platform-specific product ID.","example":"478723258026"},"platform_variant_id":{"type":"string","description":"The platform-specific variant ID.","example":"92183258642"},"title":{"type":"string","description":"The title of the line item including both product and variant names.","example":"Roaster\'s Choice - 2lb"},"product_name":{"type":"string","description":"The name of the product.","example":"Roaster\'s Choice"},"variant_name":{"type":"string","description":"The name of the variant.","example":"2lb"},"sku":{"type":"string","description":"The SKU of the product variant.","example":"RC-2LB"},"url":{"type":"string","description":"The URL of the product on the storefront.","example":"/products/roasters-choice"},"image":{"type":"string","description":"The platform image URL for the line item.","example":"https://cdn.shopify.com/s/files/1/6332/09823/products/roasters-choice.png?v=1555362485"},"quantity":{"type":"integer","description":"The quantity of the line item in the future order.","example":3},"price":{"type":"integer","description":"The price of this line item within the subscription, in the base unit (e.g., cents) of the `charged_currency` for this subscription. Example: a value of `1000` in a USD currency corresponds to a $10.00 USD per-unit price on the line item.","example":1000},"requires_shipping":{"type":"boolean","description":"Indicates whether this line item is subject to applicable shipping fees.","example":true},"grams":{"type":"integer","description":"The weight of a single unit of the line item in grams.","example":1043},"weight":{"type":"number","description":"The weight of a single unit of the line item, measured in `weight_unit`.","example":2.3},"weight_unit":{"type":"string","description":"Indicates the unit of measurement reflected by the `weight` field.","example":"lb"},"taxable":{"type":"boolean","description":"Indicates whether the line item is subject to applicable taxes.","example":true},"line_item_attributes":{"type":"array","minItems":0,"items":{"$ref":"#/components/schemas/LineItemAttributeEntity"}},"prepaid_metadata":{"nullable":true,"type":"object","allOf":[{"$ref":"#/components/schemas/FutureOrderLineItemPrepaidMetadataEntity"}]},"subscription_group_id":{"type":"integer","description":"The ID of the subscription group that contains this line item\'s product.","example":36236,"nullable":true},"subscription_group_billing_rules_id":{"type":"integer","description":"The ID of the subscription group billing rule associated with the subscription\'s order frequency.","example":78365,"nullable":true},"discounts":{"type":"array","minItems":0,"items":{"$ref":"#/components/schemas/LineItemDiscountEntity"}}}},"Intervals":{"properties":{"intervals":{"type":"array","items":{"$ref":"#/components/schemas/IntervalEntity"}}},"type":"object"},"IntervalEntity":{"properties":{"interval_number":{"type":"integer","example":1},"interval_type":{"type":"string","enum":["month","week","day","year","custom"],"example":"month"},"week_type":{"type":"string","enum":["","purchase_day","each"],"example":"each"},"week_day":{"type":"string","enum":["","FR","MO","SA","SU","TH","TU","WE"],"example":"MO"},"month_type":{"type":"string","enum":["","purchase_day","each","on_the"],"example":"purchase_day"},"month_day":{"type":"string","example":"15"},"month_occurrence":{"type":"string","enum":["last","second","first","fourth","third",""],"example":"first"},"month_occurrence_day":{"type":"string","enum":["","FR","MO","SA","SU","TH","TU","WE","business_day"],"example":"MO"},"year_type":{"type":"string","enum":["","purchase_day","on_the"],"example":"on_the"},"year_month":{"type":"string","example":"6"},"year_occurrence":{"type":"string","example":"first"},"year_occurrence_day":{"type":"string","enum":["","FR","MO","SA","SU","TH","TU","WE"],"example":"FR"},"interval_name":{"type":"string","example":"Monthly"},"id":{"type":"integer","readOnly":true,"example":1},"billing_rule":{"type":"string","example":"DTSTART:20191120T205526Z\\\\nRRULE:FREQ=MONTHLY"}},"type":"object","readOnly":true},"LineItemEntity":{"type":"object","title":"","properties":{"id":{"type":"integer","example":1,"nullable":true},"subscription_id":{"type":"integer","example":1,"nullable":true},"platform_id":{"type":"string","example":"ABC123","nullable":true},"platform_product_id":{"type":"string","example":"1357908642","nullable":true},"platform_variant_id":{"type":"string","example":"2468097531","nullable":true},"subscription_group_id":{"type":"integer","example":1,"nullable":true},"subscription_group_billing_rules_id":{"type":"integer","example":1,"nullable":true},"title":{"type":"string","example":"Monthly Expansion Pack"},"product_name":{"type":"string","example":"Monthly Expansion Pack","nullable":true},"variant_name":{"type":"string","example":"Default Title","nullable":true},"sku":{"type":"string","example":"SKU-113-Red"},"url":{"type":"string","example":"https://example-store.example.com/monthly-expansion-pack"},"image":{"type":"string","example":"","nullable":true},"quantity":{"type":"integer","example":1},"price":{"type":"integer","example":3500},"price_charged":{"type":"integer","example":3200,"nullable":true},"discounted_price":{"type":"integer","example":3200},"discounted_price_charged":{"type":"integer","example":3200},"full_price":{"type":"integer","example":3200,"nullable":true},"full_price_charged":{"type":"integer","example":3200,"nullable":true},"requires_shipping":{"type":"boolean","example":false},"grams":{"type":"integer","example":2200},"weight":{"type":"number","example":2.2},"weight_unit":{"type":"string","example":"kg"},"taxable":{"type":"boolean","example":true},"discounts":{"type":"array","items":{"$ref":"#/components/schemas/LineItemDiscountEntity"},"readOnly":true},"prepaid_metadata":{"type":"object","required":["id","line_item_id","prepaid_duration","current_recurrence_count","prepaid_continue"],"nullable":true,"properties":{"id":{"type":"integer","example":1,"nullable":true},"line_item_id":{"type":"integer","example":2,"nullable":true},"prepaid_duration":{"type":"integer","example":2},"current_recurrence_count":{"type":"integer","example":2},"prepaid_continue":{"type":"string","enum":["no_continue","as_prepaid","as_standard"]}}},"line_item_attributes":{"type":"array","items":{"$ref":"#/components/schemas/LineItemAttributeEntity"}},"created_at":{"type":"string","example":"2019-11-20T20:31:55Z","format":"date-time","readOnly":true},"updated_at":{"type":"string","example":"2019-11-20T20:31:55Z","format":"date-time","readOnly":true,"nullable":true}},"required":["id","subscription_id","platform_id","platform_product_id","platform_variant_id","subscription_group_id","subscription_group_billing_rules_id","title","product_name","variant_name","sku","url","image","quantity","price","price_charged","discounted_price","discounted_price_charged","full_price","requires_shipping","grams","weight","weight_unit","taxable","discounts","prepaid_metadata","created_at","updated_at"],"readOnly":true},"UpdateLineItemEntity":{"type":"object","title":"","properties":{"id":{"type":"integer","example":1,"nullable":true},"subscription_id":{"type":"integer","example":1,"nullable":true},"platform_id":{"type":"string","example":"ABC123"},"platform_product_id":{"type":"string","example":"1357908642","nullable":true},"platform_variant_id":{"type":"string","example":"2468097531","nullable":true},"subscription_group_id":{"type":"integer","example":1},"subscription_group_billing_rules_id":{"type":"integer","example":1,"nullable":true},"title":{"type":"string","example":"Monthly Expansion Pack"},"product_name":{"example":null,"nullable":true,"description":"Always returns `null`."},"variant_name":{"example":null,"nullable":true,"description":"Always returns `null`."},"sku":{"type":"string","example":"SKU-113-Red"},"url":{"type":"string","example":"https://example-store.example.com/monthly-expansion-pack"},"image":{"type":"string","example":""},"quantity":{"type":"integer","example":1},"price":{"type":"integer","example":3500},"price_charged":{"type":"integer","example":3200,"nullable":true},"discounted_price":{"type":"integer","example":3200},"discounted_price_charged":{"type":"integer","example":3200},"full_price":{"type":"integer","example":3200},"full_price_charged":{"type":"integer","example":3200},"requires_shipping":{"type":"boolean","example":false},"grams":{"type":"integer","example":2200},"weight":{"type":"number","example":2.2},"weight_unit":{"type":"string","example":"kg"},"taxable":{"type":"boolean","example":true},"discounts":{"type":"array","items":{"$ref":"#/components/schemas/LineItemDiscountEntity"},"readOnly":true},"prepaid_metadata":{"type":"object","required":["id","line_item_id","prepaid_duration","current_recurrence_count","prepaid_continue"],"nullable":true,"properties":{"id":{"type":"integer","example":1,"nullable":true},"line_item_id":{"type":"integer","example":2,"nullable":true},"prepaid_duration":{"type":"integer","example":2},"current_recurrence_count":{"type":"integer","example":2},"prepaid_continue":{"type":"string","enum":["no_continue","as_prepaid","as_standard"]}}},"line_item_attributes":{"type":"array","items":{"$ref":"#/components/schemas/LineItemAttributeEntity"}},"created_at":{"type":"string","example":"2019-11-20T20:31:55Z","format":"date-time","readOnly":true},"updated_at":{"type":"string","example":"2019-11-20T20:31:55Z","format":"date-time","readOnly":true}},"required":["id","subscription_id","platform_id","platform_product_id","platform_variant_id","subscription_group_id","subscription_group_billing_rules_id","title","product_name","variant_name","sku","url","image","quantity","price","price_charged","discounted_price","discounted_price_charged","full_price","requires_shipping","grams","weight","weight_unit","taxable","discounts","prepaid_metadata","created_at","updated_at"],"readOnly":true},"LineItemAttributeEntity":{"title":"LineItemAttributeEntity","type":"object","description":"This represents a custom field that can be defined and used to store complementary information about a subscription line item.","properties":{"name":{"type":"string","example":"size_preference","description":"The name of the custom field/attribute, up to 250 characters."},"value":{"type":"string","example":"XL","description":"The content of the custom field/attribute."},"created_at":{"type":"string","format":"date-time","description":"The date (in [RFC3339 format](https://datatracker.ietf.org/doc/html/rfc3339)) that this line item attribute was created.","example":"2021-01-17T20:30:40Z","readOnly":true},"updated_at":{"type":"string","format":"date-time","description":"The date (in [RFC3339 format](https://datatracker.ietf.org/doc/html/rfc3339)) that this line item attribute was last updated. The value is the same as the `created_at` value if the line item attribute has never been updated.","example":"2021-01-17T20:30:40Z","readOnly":true},"subscription_id":{"description":"The ID of the subscription associated to this line item attribute.","type":"integer","readOnly":true,"example":435989},"line_item_id":{"description":"The ID of the subscription line item this line item attribute belongs to.","type":"integer","readOnly":true,"example":45734}}},"PrepaidMetadataEntity":{"type":"object","properties":{"id":{"description":"The ID of the prepaid metadata.","type":"integer","example":1},"line_item_id":{"description":"The ID of the subscription line item this prepaid metadata belongs to.","type":"integer","example":1},"prepaid_continue":{"description":"The behavior of the subscription once the number of recurrences has reached the `prepaid_duration`.\\n  * `no_continue`: The subscription will be cancelled.\\n  * `as_prepaid` : The customer will be charged for new set of order recurrences on the next recurrence.\\n  * `as_standard`: The subscription will be converted to a standard subscription, where the customer is charged for one order at each recurrence.","type":"string","enum":["no_continue","as_prepaid","as_standard"],"example":"as_prepaid"},"prepaid_duration":{"description":"The number of subscription recurrences that have been prepaid.","type":"integer","example":6},"current_recurrence_count":{"description":"The number of subscription recurrences that have occurred.","type":"integer","example":6}},"required":["prepaid_continue","prepaid_duration","current_recurrence_count"]},"FutureOrderLineItemPrepaidMetadataEntity":{"type":"object","properties":{"prepaid_continue":{"description":"The behavior of the subscription once the number of recurrences has reached the `prepaid_duration`.\\n  * `no_continue`: The subscription will be cancelled.\\n  * `as_prepaid` : The customer will be charged for new set of order recurrences on the next recurrence.\\n  * `as_standard`: The subscription will be converted to a standard subscription, where the customer is charged for one order at each recurrence.","type":"string","enum":["no_continue","as_prepaid","as_standard"],"example":"as_prepaid"},"prepaid_duration":{"description":"The number of subscription recurrences that get prepaid for in a cycle.","type":"integer","example":6},"recurrence_count":{"description":"Indicates which recurrence of the prepaid cycle the future order will be.","type":"integer","example":1},"requires_payment":{"description":"Indicates whether the line item and associated subscription will be charged for a full prepaid cycle. When payment is required, the line item price and shipping line prices of the future order will be multiplied by the appropriate prepaid duration. When payment is required and no other standard line items are present then prices will be 0.","type":"boolean","example":true}}},"LineItemDiscountEntity":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the line item discount.","example":1,"nullable":true},"subscription_line_item_id":{"type":"integer","description":"The ID of the subscription line item the discount belongs to.","example":1,"nullable":true},"shop_id":{"type":"integer","description":"The ID of the shop.","example":5},"full_price":{"type":"integer","description":"The price of the subscription line item without this discount applied.","example":5,"nullable":true},"discount_type":{"type":"string","description":"The type of discount being applied to the subscription line item.","enum":["percentage","fixed","no_discount"],"example":"percentage"},"percentage_value":{"type":"number","description":"The percent discount to apply to the line item price in a range of 0 - 100. Only applied when the value for `discount_type` is `percentage`. For example, a value of `12.5` will discount the line item by 12.5%.","example":10},"fixed_value":{"type":"integer","description":"The discount amount in base currency units (e.g. cents). Only applied when the value for `discount_type` is `fixed`. For example, a value of `575` on a subscription with a base currency of USD will discount the line item by $5.75 USD.","example":0},"fixed_value_charged":{"type":"integer","description":"The discount amount in base currency units (e.g. cents) of the subscription\'s `charged_currency`. Only applied when the value for `discount_type` is `fixed`. This value is derived from the `fixed_value` and the subscription\'s currency properties. For example, with a `fixed_value` of 575, a base currency of USD, a charged currency of CAD, and an exchange rate of 1.5, this value would be 575 * 1.5 = `863`.","example":0},"description":{"type":"string","description":"A description of the discount to show to the customer.","example":"Subscription discount (10%) for Monthly Expansion Pack"},"created_at":{"type":"string","example":"2019-11-20T20:31:55Z","format":"date-time","description":"The date (in [RFC3339 format](https://datatracker.ietf.org/doc/html/rfc3339)) that this discount added to the subscription line item.","nullable":true,"readOnly":true},"updated_at":{"type":"string","example":"2019-11-20T20:31:55Z","format":"date-time","description":"The date (in [RFC3339 format](https://datatracker.ietf.org/doc/html/rfc3339)) that this discount was last updated. The value is the same as the `created_at` value if the discount has never been updated.","nullable":true,"readOnly":true},"deleted_at":{"type":"string","example":"2019-11-20T20:31:55Z","format":"date-time","description":"The date (in [RFC3339 format](https://datatracker.ietf.org/doc/html/rfc3339)) that this discount was removed from the subscription line item. The value is null if the discount has never been deleted.","nullable":true,"readOnly":true}},"required":["id","subscription_line_item_id","shop_id","full_price","discount_type","percentage_value","fixed_value","fixed_value_charged","description","created_at","updated_at","deleted_at"],"readOnly":true},"OrderEntity":{"type":"object","x-examples":{},"title":"","properties":{"id":{"type":"integer","example":185490},"platform_id":{"type":"integer","example":1},"platform_customer_id":{"type":"integer","example":123},"shop_identifier":{"type":"string","example":"zya0kzb8hu"},"line_items":{"type":"array","items":{"$ref":"#/components/schemas/LineItemEntity"}},"billing_address":{"nullable":true,"description":"Orders that were deleted from the platform won\'t have address information available.","type":"object","allOf":[{"$ref":"#/components/schemas/CustomerAddressEntity"}]},"shipping_addresses":{"nullable":true,"description":"Orders that were deleted from the platform won\'t have address information available.","type":"array","items":{"$ref":"#/components/schemas/CustomerAddressEntity"}},"subtotal":{"type":"integer","example":1337},"subtotal_charged":{"type":"integer","example":1337},"subtotal_tax":{"type":"integer","example":144},"subtotal_tax_charged":{"type":"integer","example":144},"shipping_subtotal":{"example":1000,"type":"integer"},"shipping_subtotal_charged":{"type":"integer","example":1000},"shipping_tax":{"example":0,"type":"integer"},"shipping_tax_charged":{"example":0,"type":"integer"},"total":{"example":2204,"type":"integer"},"total_charged":{"example":2204,"type":"integer"},"total_tax":{"example":144,"type":"integer"},"total_tax_charged":{"example":144,"type":"integer"},"fulfillment_status":{"type":"string","example":"pending"},"source":{"type":"string"},"payment_method":{"type":"string","example":"Shopify Payments"},"payment_method_details":{"nullable":true,"type":"object","allOf":[{"$ref":"#/components/schemas/PaymentMethodEntity"}]},"shipping_method":{"type":"string","example":"Subscription shipping"},"shipping_rates":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","nullable":true},"bold_subscription_id":{"type":"number","nullable":true},"name":{"type":"string"},"code":{"type":"string","nullable":true},"price":{"type":"integer"},"price_charged":{"type":"integer","nullable":true},"value":{"type":"integer"},"value_charged":{"type":"integer","nullable":true},"tag":{"type":"string","nullable":true},"hash":{"type":"string","nullable":true}},"required":["id","bold_subscription_id","name","code","price","price_charged","value","value_charged","tag","hash"]}},"tax_lines":{"type":"array","items":{"type":"object","properties":{"amount":{"type":"integer"},"amount_charged":{"type":"integer"},"name":{"type":"string","nullable":true},"rate":{"type":"number","nullable":true}},"required":["amount","amount_charged","name","rate"]}},"discounts":{"type":"array","items":{"type":"object","properties":{"discount_percentage":{"type":"integer","example":10,"nullable":true},"discount_type":{"type":"string","enum":["percentage","fixed","no_discount"],"example":"percentage","nullable":true},"text":{"type":"string","example":"10PERCENTOFF","nullable":true,"readOnly":true},"value":{"type":"integer"},"value_charged":{"type":"integer"}},"required":["discount_percentage","discount_type","text","value","value_charged"]}},"order_number":{"type":"integer","example":0},"currency":{"type":"string","example":"CAD"},"currency_charged":{"type":"string"},"currency_format":{"type":"string"},"currency_format_charged":{"type":"string"},"exchange_rate":{"type":"number","nullable":true},"test":{"type":"boolean","example":false},"url":{"type":"string","example":"https://example-store.example.com/account.php?action=view_order&order_id=1"},"updated_at":{"type":"string","example":"2019-11-20T20:31:55Z","format":"date-time","readOnly":true},"created_at":{"type":"string","example":"2019-11-20T20:31:55Z","format":"date-time","readOnly":true},"placed_at":{"type":"string","example":"2019-11-20T20:31:55Z","format":"date-time","readOnly":true},"deleted_at":{"type":"string","example":"2021-07-09T18:13:27Z","format":"date-time","nullable":true,"readOnly":true},"subscription_id":{"type":"integer","example":5266}},"required":["id","platform_id","platform_customer_id","shop_identifier","line_items","billing_address","shipping_addresses","subtotal","subtotal_charged","subtotal_tax","subtotal_tax_charged","shipping_subtotal","shipping_subtotal_charged","shipping_tax","shipping_tax_charged","total","total_charged","total_tax","total_tax_charged","fulfillment_status","source","payment_method","payment_method_details","shipping_method","shipping_rates","tax_lines","discounts","order_number","currency","currency_charged","currency_format","currency_format_charged","exchange_rate","test","url","updated_at","created_at","placed_at","deleted_at","subscription_id"],"readOnly":true},"PaymentMethods":{"properties":{"payment_methods":{"type":"array","items":{"$ref":"#/components/schemas/PaymentMethodEntity"}}},"type":"object"},"PaymentMethod":{"properties":{"payment_method":{"$ref":"#/components/schemas/PaymentMethodEntity"}},"type":"object"},"PaymentMethodEntity":{"type":"object","properties":{"type":{"type":"string","example":"credit_card","enum":["credit_card","paypal","shop_pay"]},"name":{"type":"string","example":"John Doe","nullable":true,"description":"Customer\'s name"},"billing_address":{"type":"object","nullable":true,"description":"Customer\'s billing address.","properties":{"street":{"type":"string","example":"123 Main Street","description":"The customer\'s street address.","nullable":true},"city":{"type":"string","example":"Toronto","description":"The customer\'s city.","nullable":true},"province":{"type":"string","example":"Ontario","description":"The customer\'s province or state, as applicable.","nullable":true},"country":{"type":"string","example":"Canada","description":"The customer\'s country name.","nullable":true},"zip":{"type":"string","example":"H0H 0H0","description":"The customer\'s postal code.","nullable":true}}},"public_id":{"type":"string","example":"jik1w6HrCn17CxXPDkWhtgyqvm8wLDd1PelY6k8mabglNmL8XKBnsde9PdgKZqnG","nullable":true},"update_method":{"type":"string","example":"trigger_email","enum":["trigger_email","embedded","url"],"nullable":true},"cc_type":{"type":"string","example":"Visa","nullable":true},"expiration":{"type":"object","required":["date","timezone_type","timezone"],"nullable":true,"properties":{"date":{"type":"string","example":"2020-5","nullable":true},"timezone_type":{"type":"string","nullable":true},"timezone":{"type":"string","example":"UTC","nullable":true}}},"last_four":{"type":"string","example":"1111","nullable":true},"is_default":{"type":"boolean","example":true,"nullable":true},"paypal_email":{"type":"string","example":"customer@example.com","format":"email","nullable":true},"update_url":{"type":"object","required":["url","expiry"],"nullable":true,"properties":{"url":{"type":"string","format":"uri"},"expiry":{"type":"string","format":"date-time"}}},"embed_url":{"type":"object","nullable":true,"properties":{"url":{"type":"string","format":"uri"},"expiry":{"type":"string","format":"date-time","nullable":true}},"required":["url","expiry"]}},"required":["type","public_id","update_method","cc_type","expiration","last_four","is_default","paypal_email","update_url"],"readOnly":true},"SelectionOptionEntity":{"type":"object","description":"","properties":{"id":{"type":"integer","example":1,"readOnly":true},"shop_id":{"type":"integer","example":1,"readOnly":true},"subscription_group_id":{"type":"integer","example":1,"readOnly":true},"platform_entity_id":{"type":"string","example":"1357908642"},"created_at":{"type":"string","readOnly":true,"example":"2019-11-20T20:31:55Z","format":"date-time"},"updated_at":{"type":"string","readOnly":true,"example":"2019-11-20T20:31:55Z","format":"date-time"},"deleted_at":{"type":"string","example":null,"readOnly":true,"format":"date-time","nullable":true},"entity_id":{"type":"integer","example":1472540,"readOnly":true},"bold_platform_entity_id":{"type":"integer","example":1234}}},"ShippingLineEntity":{"type":"object","description":"A shipping line for a subscription.","properties":{"id":{"type":"integer","description":"The ID of the shipping line.","nullable":true,"readOnly":true,"example":36217},"name":{"type":"string","description":"The name of the shipping line.","example":"Standard Shipping","readOnly":true},"code":{"type":"string","description":"The code of the shipping line.","example":"Standard Shipping","readOnly":true},"price":{"type":"integer","description":"The price of the shipping line, in base units (e.g., cents) of the `base_currency` of the associated subscription. For example, a value of `1000` on a subscription with a base currency of USD corresponds to a $10.00 USD shipping line price.","example":1000,"readOnly":true},"value":{"type":"integer","description":"The price of the shipping line, in base units (e.g., cents) of the `base_currency` of the associated subscription. For example, a value of `1000` on a subscription with a base currency of USD corresponds to a $10.00 USD shipping line price.","example":1000,"readOnly":true},"value_charged":{"type":"integer","description":"The price of the shipping line, in base units (e.g., cents) of the `charged_currency` of the associated subscription. For example, a value of `1000` on a subscription with a charged currency of CAD corresponds to a $10.00 CAD shipping line price.","example":1000,"nullable":true,"readOnly":true},"tag":{"type":"string","example":"Shipping","nullable":true,"readOnly":true},"created_at":{"type":"string","format":"date-time","description":"The date (in [RFC3339 format](https://datatracker.ietf.org/doc/html/rfc3339)) that this shipping line was created.","example":"2019-10-20T20:31:55Z","nullable":true,"readOnly":true},"updated_at":{"type":"string","format":"date-time","description":"The date (in [RFC3339 format](https://datatracker.ietf.org/doc/html/rfc3339)) that this shipping line was last updated. The value is the same as the `created_at` value if the shipping line has never been updated.","example":"2019-11-20T20:31:55Z","nullable":true,"readOnly":true},"subscription_id":{"type":"integer","description":"The ID of the subscription the shipping line belongs to.","example":1,"nullable":true,"readOnly":true}},"required":["id","name","code","price","value","value_charged","tag","created_at","updated_at","subscription_id"],"readOnly":true},"Shop":{"properties":{"shop":{"$ref":"#/components/schemas/ShopEntity"}},"type":"object"},"ShopEntity":{"type":"object","title":"","properties":{"id":{"type":"integer","example":1,"readOnly":true},"shop_domain":{"type":"string","example":"store-abc123def456.example.com","readOnly":true},"custom_domain":{"type":"string","example":"example-store.example.com","readOnly":true},"shop_identifer":{"type":"string","example":"zya0kzb8hu7ji","readOnly":true},"platform_type":{"type":"string","example":"bigcommerce","enum":["bigcommerce","shopify","woocommerce","commercetools","custom"],"readOnly":true},"timezone":{"type":"string","example":"Europe/London","readOnly":true},"currency":{"type":"string","example":"CAD","readOnly":true},"currency_format":{"type":"string","example":"${{amount}}","readOnly":true},"shop_owner":{"type":"string","example":"John Doe","readOnly":true},"admin_email":{"type":"string","example":"john.doe@example.com","readOnly":true},"pii_redacted_at":{"type":"string","example":"2019-11-20T20:31:55Z","format":"date-time","nullable":true,"readOnly":true},"created_at":{"type":"string","example":"2019-11-20T20:31:55Z","format":"date-time","readOnly":true},"updated_at":{"type":"string","example":"2019-11-20T20:31:55Z","format":"date-time","readOnly":true},"deleted_at":{"type":"string","example":"2019-11-20T20:31:55Z","format":"date-time","nullable":true,"readOnly":true}},"required":["id","shop_domain","custom_domain","shop_identifer","platform_type","timezone","currency","currency_format","shop_owner","admin_email","pii_redacted_at","created_at","updated_at","deleted_at"]},"StandardPaginationEntity":{"properties":{"total":{"type":"integer","readOnly":true,"example":2},"count":{"type":"integer","readOnly":true,"example":2},"per_page":{"type":"integer","readOnly":true,"example":10},"total_pages":{"type":"integer","readOnly":true,"example":1},"current_page":{"type":"integer","readOnly":true,"example":1}},"type":"object","readOnly":true},"Subscriptions":{"type":"object","properties":{"subscriptions":{"type":"array","items":{"$ref":"#/components/schemas/SubscriptionEntity"}},"pagination":{"$ref":"#/components/schemas/StandardPaginationEntity"}}},"ListSubscriptions":{"type":"object","title":"ListSubscriptions","properties":{"subscriptions":{"type":"array","items":{"$ref":"#/components/schemas/SubscriptionEntity"}},"pagination":{"$ref":"#/components/schemas/CursorPagination"}}},"Subscription":{"type":"object","properties":{"subscription":{"$ref":"#/components/schemas/SubscriptionEntity"}}},"SubscriptionUpdateLineItems":{"type":"object","properties":{"subscription":{"$ref":"#/components/schemas/SubscriptionUpdateLineItemsEntity"}}},"CreateLineItemsResponse":{"type":"object","properties":{"line_items":{"type":"array","items":{"$ref":"#/components/schemas/LineItemEntity"}}}},"CreateSubscriptionError422":{"type":"object","properties":{"errors":{"type":"array","description":"An array of various errors.","items":{"type":"object","properties":{"Message":{"type":"string","example":"The next order datetime must be a string."},"Field":{"type":"string","example":"subscription.next_order_datetime."},"Type":{"type":"string","example":"string"}}}},"idempotency_key":{"type":"string","description":"The idempotency key of this subscription creation request. Learn more about [setting an idempotency key](/guides/subscriptions-v2/create-subscription#choosing-an-idempotency-key).","example":"legacy-id-1234"},"current_subscription_creation_step":{"type":"string","description":"A string indicating the step of subscription creation during which the error occurred.","example":"customer_billing_address_creation"},"subscription_creation_log_id":{"type":"integer","description":"An integer ID representing the subscription creation log tied to the request. This ID persists across requests that have the same idempotency key. If you require further troubleshooting, provide this ID to [Bold Support](https://support.boldcommerce.com/hc/en-us/requests/new?ticket_form_id=1900000280347).","example":82372}}},"SubscriptionEntity":{"allOf":[{"type":"object","x-examples":{},"properties":{"id":{"type":"integer","example":1,"readOnly":true},"external_id":{"type":"string","nullable":true},"customer":{"example":"null"},"shop_id":{"type":"integer","example":1,"readOnly":true},"next_order_datetime":{"type":"string","example":"2020-01-20T18:00:00Z"},"next_payment_datetime":{"type":"string","example":"2020-01-20T18:00:00Z"},"next_processing_datetime":{"type":"string","example":"2020-01-20T18:00:00Z"},"subscription_status":{"type":"string","enum":["active","inactive","paused","scheduled","processing","app_uninstalled","waiting_sca_authorization"],"example":"active"},"status_changed_at":{"type":"string","example":"2019-11-20T20:31:55Z","format":"date-time","readOnly":true},"sca_url":{"type":"string","example":"https://bank.com/pCkWhtgQQVM8W/sca","nullable":true,"readOnly":true},"payment_method_token":{"type":"string","example":"jik1w6HrCn17CxXPcKwHTGqqvm8wLDd1PelY6k8mabglNmL8XKBnsde9PdgKZqnG"},"payment_gateway_public_id":{"type":"string","example":"jik1w6HrCn17CxXPcKwHTGqqvm8wLDd1PelY6k8mabglNmL8XKBnsde9PdgKZqnG","nullable":true},"payment_rrule":{"type":"string","example":"DTSTART:20200120T180000Z\\\\nRRULE:FREQ=MONTHLY\\\\nEXDATE:20200220T180000Z"},"payment_rrule_text":{"type":"string","example":"Monthly","nullable":true},"order_rrule":{"type":"string","example":"DTSTART:20200120T180000Z\\\\nRRULE:FREQ=MONTHLY\\\\nEXDATE:20200220T180000Z"},"order_rrule_text":{"type":"string","example":"Monthly","nullable":true},"last_payment_datetime":{"type":"string","example":"2019-11-20T20:55:26Z","nullable":true},"last_order_datetime":{"type":"string","example":"2019-11-20T20:55:26Z","nullable":true},"last_processed_datetime":{"type":"string","example":"2019-11-20T20:55:26Z","nullable":true},"current_retries":{"type":"integer","example":3},"charged_currency":{"type":"string","example":"CAD"},"base_to_charged_exchange_rate":{"type":"integer","example":1},"base_currency":{"type":"string","example":"CAD"},"line_items":{"type":"array","items":{"$ref":"#/components/schemas/LineItemEntity"},"readOnly":true},"shipping_lines":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/ShippingLineEntity"},"readOnly":true},"billing_address":{"$ref":"#/components/schemas/CustomerAddressEntity"},"shipping_address":{"nullable":true,"type":"object","allOf":[{"$ref":"#/components/schemas/CustomerAddressEntity"}]},"idempotency_key":{"type":"string","example":"JwGdN55C4g1z5FXRO8Hp21CMxUxKyo6VcGSf3cUsjCgNyTtoeZcIsGM1We4p7pCe-0"},"placed_at":{"type":"string","example":"2012-11-20T20:31:55Z","format":"data-time","nullable":true},"created_at":{"type":"string","example":"2019-11-20T20:31:55Z","format":"date-time","readOnly":true},"updated_at":{"type":"string","example":"2019-11-20T20:31:55Z","format":"date-time","readOnly":true},"percent_discount":{"type":"number","example":10,"nullable":true,"readOnly":true},"discount_code":{"type":"string","example":"DISCOUNTCODE","readOnly":true},"customer_id":{"type":"integer","example":1697912,"readOnly":true},"billing_address_id":{"type":"integer","example":11697812},"shipping_address_id":{"type":"integer","example":11697812},"orders_processed":{"type":"integer","example":1,"nullable":true},"last_failure_code":{"type":"string","example":"card_expired","description":"This code may help to identify the type of the error.","nullable":true,"enum":["alt_pp_payment_method_required","bigcommerce_error","card_declined","card_expired","credit_card_not_found","discount_code_use_limit","insufficient_funds","invalid_billing_address","invalid_bold_api_token","invalid_card_expiration_month","invalid_card_expiration_year","invalid_card_number","invalid_customer_email","invalid_discount_code","invalid_payment_method","invalid_security_code","invalid_shipping_address","invalid_zip_code","no_payment_provider","payment_method_declined","plugin_event_failed","shopify_error","stripe_support_required","transaction_declined","out_of_stock_product","unaccepted_credit_card","unknown_error","unsupported_card","unsupported_purchase_type","unsupported_shipping_address","woocommerce_error"]},"last_failure_details":{"type":"object","nullable":true,"description":"Default error messages for the last_failure_code field","required":["message"],"properties":{"message":{"type":"string","description":"Error message","example":"The order couldn\'t process because the card was declined.","nullable":false}}},"last_failure_reason":{"type":"string","example":"credit_card","description":"The reason for the failure","nullable":true,"enum":["credit_card","gateway","cashier","platform","inventory","other"]}}},{"$ref":"#/components/schemas/SubscriptionNotesEntity"},{"$ref":"#/components/schemas/SubscriptionOrderCountEntity"}],"required":["id","external_id","customer","shop_id","next_order_datetime","next_payment_datetime","next_processing_datetime","subscription_status","status_changed_at","payment_method_token","payment_gateway_public_id","payment_rrule","payment_rrule_text","order_rrule","order_rrule_text","last_payment_datetime","last_order_datetime","last_processed_datetime","current_retries","charged_currency","base_to_charged_exchange_rate","base_currency","idempotency_key","created_at","updated_at","percent_discount","customer_id","billing_address_id","shipping_address_id","note","order_note"]},"SubscriptionOrderCountEntity":{"properties":{"order_count":{"description":"The number of orders created for the subscription.","type":"integer","example":1}}},"SubscriptionNotesEntity":{"properties":{"note":{"description":"An internal-only note that you can add to a subscription. For a subscription recurrence, this note appears in the Additional Details section of the created order. Applicable for Shopify Checkout only.","type":"string","example":"Staff note","nullable":true},"order_note":{"description":"A customer-facing note that you can add to a subscription. For the first order, this field retains the note added by the customer. For a subscription recurrence, this note appears in the Note section of the created order. Applicable for Shopify Checkout only.","type":"string","example":"Customer note","nullable":true}}},"CreateSubscriptionEntity":{"type":"object","properties":{"customer":{"type":"object","required":["first_name","last_name","email"],"properties":{"first_name":{"type":"string","description":"The customer\'s first name","example":"Jane"},"last_name":{"type":"string","description":"The customer\'s last name","example":"Doe"},"email":{"type":"string","description":"The customer\'s email","example":"jane.doe@example.com"},"phone":{"type":"string","description":"The customer\'s phone number. For Shopify checkout users, [you can configure phone number requirements in the admin](/guides/subscriptions-v2/create-subscription#how-do-i-make-phone-numbers-optional-when-using-shopify-checkout).","example":"12045551234"},"notes":{"type":"string","description":"Internal notes about the customer. This is applied as a note in the Customer info section of Bold Subscriptions admin.","example":"Loyal customer"}}},"subscription":{"allOf":[{"type":"object","required":["idempotency_key","next_order_datetime","subscription_status","order_rrule","charged_currency","base_to_charged_exchange_rate","base_currency","line_items","billing_address","shipping_address","payment_details"],"properties":{"idempotency_key":{"type":"string","description":"The idempotency key of this subscription creation request. Learn more about [setting an idempotency key](/guides/subscriptions-v2/create-subscription#choosing-an-idempotency-key).","example":"legacy-id-21425"},"next_order_datetime":{"type":"string","description":"The date and time of the next order, in [RFC 3339 format](https://www.ietf.org/rfc/rfc3339.txt).","example":"2021-05-21T08:00:00Z"},"last_order_datetime":{"type":"string","description":"If migrating subscriptions from another application, the date and time of the customer\'s last order on the legacy system, in [RFC 3339 format](https://www.ietf.org/rfc/rfc3339.txt).","example":"2021-04-21T08:00:00Z"},"subscription_status":{"type":"string","description":"The status of the subscription.","enum":["active","inactive","paused"]},"order_rrule":{"type":"string","description":"An RRULE describing how frequently to process orders for the subscription. Learn more about [RRULEs](https://support.boldcommerce.com/hc/en-us/articles/360045174132-Use-RRULES-in-Bold-Subscriptions).","example":"DTSTART;TZID=America/New_York:20240425T000000Z\\nRRULE:FREQ=MONTHLY"},"base_currency":{"type":"string","description":"The base currency of your store, in [ISO 4217 format](https://www.iso.org/iso-4217-currency-codes.html). This should align with your store\'s platform configuration.","example":"CAD"},"charged_currency":{"type":"string","description":"The currency to charge the customer with, in [ISO 4217 format](https://www.iso.org/iso-4217-currency-codes.html).","example":"USD"},"base_to_charged_exchange_rate":{"type":"number","description":"The exchange rate from your base currency to the charged currency.","example":0.79},"line_items":{"type":"array","description":"An array of line items to be added to the subscription.","items":{"type":"object","required":["platform_product_id","platform_variant_id","quantity","price","subscription_group_id"],"properties":{"platform_product_id":{"type":"string","description":"The ID of the product on your platform. Learn more about [finding platform product IDs](/guides/subscriptions-v2/create-subscription#how-do-i-find-the-platform_product_id-and-platform_variant_id-for-a-line-item).","example":"1578934692"},"platform_variant_id":{"type":"string","description":"The ID of the product variant on your platform. All products, including those with no variants or a single variant, have a platform variant ID. Learn more about [finding platform variant IDs](/guides/subscriptions-v2/create-subscription#how-do-i-find-the-platform_product_id-and-platform_variant_id-for-a-line-item).","example":"975285185"},"quantity":{"type":"number","description":"The quantity of this line item within the subscription.","example":2},"price":{"type":"number","description":"Price in the base unit (e.g., cents) of the `base_currency` for this subscription. For example, a value of `1000` in a USD currency corresponds to a $10.00 per-unit price on the line item.","example":1000},"subscription_group_id":{"type":"number","description":"The ID of the subscription group that contains this product, found in the Subscriptions 2 admin. Learn more about [finding subscription group IDs](/guides/subscriptions-v2/create-subscription#how-do-i-find-the-subscription_group_id-for-a-line-item).","example":123}}}},"billing_address":{"$ref":"#/components/schemas/CreateAddressEntity"},"shipping_address":{"$ref":"#/components/schemas/CreateAddressEntity"},"external_id":{"type":"string","description":"If applicable, the ID of the subscription on its previous system. Recommended for subscriptions being migrated from legacy subscription apps.","example":"legacy-id-135798642"},"placed_at":{"type":"string","format":"date-time","description":"The date the subscription was originally placed. Recommended for subscriptions being migrated from legacy subscription apps.","example":"2012-05-21T08:00:00Z","nullable":true},"payment_details":{"type":"object","required":["gateway_name","gateway_customer_id"],"description":"The payment details used for processing orders.","properties":{"gateway_name":{"type":"string","description":"A string indicating the payment gateway being used. Learn more about [finding the gateway name](/guides/subscriptions-v2/create-subscription#how-do-i-find-payment-gateway-information-for-the-paymentdetails-object).","example":"Stripe Default Name"},"gateway_customer_id":{"type":"string","description":"A string that is used to associate a customer record with the corresponding customer from the payment gateway. Learn more about [finding the gateway customer ID](/guides/subscriptions-v2/create-subscription#how-do-i-find-payment-gateway-information-for-the-paymentdetails-object).","example":"cus_123456789"},"gateway_payment_id":{"type":"string","description":"For Bold Checkout, this field is unused. For Shopify Checkout, this field is optional. It is used in combination with the `gateway_customer_id` to create a Shopify payment method that references the particular payment method associated with this ID. Learn more about [finding the gateway payment ID](/guides/subscriptions-v2/create-subscription#how-do-i-find-payment-gateway-information-for-the-paymentdetails-object).","example":"card_123456"}}},"discount_code":{"type":"string","description":"Supported for Bold Checkout through the \\"Shopify Discount Connector\\" Marketplace plugin. Supported for Shopify checkout by default.","example":"DISCOUNTCODE","nullable":true}}},{"$ref":"#/components/schemas/SubscriptionNotesEntity"},{"$ref":"#/components/schemas/SubscriptionOrderCountEntity"}]}}},"CreateAddressEntity":{"description":"Address payload for the create endpoint.","type":"object","required":["first_name","last_name","street1","street2","city","country","country_code"],"properties":{"first_name":{"type":"string","description":"The customer\'s first name.","example":"Jane"},"last_name":{"type":"string","description":"The customer\'s last name.","example":"Doe"},"company":{"type":"string","description":"The customer\'s company.","example":"Bold Commerce"},"phone":{"type":"string","description":"The customer\'s phone number. For Shopify checkout users, [you can configure phone number requirements in the admin](/guides/subscriptions-v2/create-subscription#how-do-i-make-phone-numbers-optional-when-using-shopify-checkout).","example":"12045551234"},"street1":{"type":"string","description":"The customer\'s address 1.","example":"123 Alphabet St."},"street2":{"type":"string","description":"The customer\'s address 2.","example":"101"},"city":{"type":"string","description":"The customer\'s city.","example":"Austin"},"province":{"type":"string","description":"The full written name of the province or state (e.g., Ontario). Required only for countries that have provinces if `province_code` is not provided.","example":"Texas"},"province_code":{"type":"string","description":"The short-form code representing the province or state (e.g., ON for Ontario), in [ISO 3166 format](https://www.iso.org/iso-3166-country-codes.html). Required only for countries that have provinces/states, and if `province` is not already provided.","example":"TX"},"country":{"type":"string","description":"The full written name of the country. Required if `\'country_code\'` is not already provided.","example":"United States"},"country_code":{"type":"string","description":"The short-form code representing the country, in [ISO 3166 format](https://www.iso.org/iso-3166-country-codes.html). Required if `country` is not already provided.","example":"US"},"zip":{"type":"string","description":"The zip or postal code for the address given. Required only for countries that use zip/postal.","example":"78701"}}},"PartialUpdateSubscription":{"description":"Update the current retries before the subscription expires.","properties":{"subscription":{"$ref":"#/components/schemas/PartialUpdateSubscriptionEntity"}},"type":"object"},"PartialUpdateSubscriptionEntity":{"allOf":[{"type":"object","properties":{"current_retries":{"type":"integer","example":6}}},{"$ref":"#/components/schemas/SubscriptionNotesEntity"},{"$ref":"#/components/schemas/SubscriptionOrderCountEntity"}]},"UpdateSubscriptionLineItems":{"description":"Update line items on the subscription.","type":"object","title":"","properties":{"subscription":{"type":"object","properties":{"line_items":{"type":"array","items":{"$ref":"#/components/schemas/PatchLineItemEntity"}}}}}},"CreateSubscriptionLineItems":{"description":"Add line items to a subscription.","type":"object","required":["platform_product_id","platform_variant_id","quantity"],"properties":{"line_items":{"type":"array","items":{"properties":{"platform_product_id":{"type":"string","description":"The ID of the product on your platform. Learn more about [finding platform product IDs](/guides/subscriptions-v2/create-subscription#how-do-i-find-the-platform_product_id-and-platform_variant_id-for-a-line-item).","example":"1357908642"},"platform_variant_id":{"type":"string","description":"The ID of the product variant on your platform. All products, including those with no variants or a single variant, have a platform variant ID. Learn more about [finding platform variant IDs](/guides/subscriptions-v2/create-subscription#how-do-i-find-the-platform_product_id-and-platform_variant_id-for-a-line-item).","example":"2468097531"},"quantity":{"type":"integer","description":"The quantity of this line item within the subscription.","example":1},"price":{"type":"integer","description":"The price of this line item within the subscription, in the base unit (e.g., cents) of the `charged_currency` for this subscription. For example, a value of `1000` in a USD currency corresponds to a $10.00 USD per-unit price on the line item.","example":3500},"subscription_group_id":{"type":"integer","description":"The ID of the subscription group that contains the discount you want to add to this line item. Learn more about [finding subscription group IDs](/guides/subscriptions-v2/create-subscription#how-do-i-find-the-subscription_group_id-for-a-line-item).","example":123}}}}}},"UpdateSubscriptionNextOrderDate":{"description":"Update the next order date and time for the subscription.","type":"object","properties":{"nextDate":{"type":"string","example":"2020-01-20T18:00:00Z"},"includeFutureOrders":{"type":"boolean","default":false,"description":"Also adjust the order datetimes of all future orders to match the new next order date with the old interval."}}},"SkipSubscriptionOrder":{"description":"Skip an upcoming order for the subscription.","properties":{"date":{"type":"string","example":"2020-01-20T18:00:00Z"}},"type":"object"},"UnskipSubscriptionOrder":{"description":"Restore a previously skipped future subscription order.","properties":{"date":{"type":"string","description":"The date of the previously skipped order (to be restored/unskipped)","example":"2020-01-20T18:00:00Z"}},"type":"object"},"SelectionOptions":{"properties":{"selection_options":{"type":"array","items":{"$ref":"#/components/schemas/SelectionOptionsEntity"}},"pagination":{"$ref":"#/components/schemas/SubscriptionsCursorPagination"}},"type":"object"},"SelectionOptionsEntity":{"type":"object","title":"","properties":{"id":{"type":"integer","example":1,"description":"Selection Options identifier.","readOnly":true},"shop_id":{"type":"integer","example":10,"readOnly":true,"description":"The shop ID."},"subscription_group_id":{"type":"integer","example":9,"readOnly":true,"description":"The subscription group the selection option belong to."},"platform_entity_id":{"type":"integer","example":8000319815956,"readOnly":true,"description":"The platform identifier to the product in the selection option."},"bold_platform_entity_id":{"type":"integer","example":39,"readOnly":true,"description":"The Bold identifier of the product in the selection option."},"created_at":{"type":"string","example":"2022-11-09 17:50:37","description":"When the selection option was created."},"updated_at":{"type":"string","example":"2022-11-09 17:50:37","description":"When the selection option was updated."},"deleted_at":{"type":"string","nullable":true,"example":null,"description":"When the selection option was deleted."}},"required":["id","shop_id","subscription_group_id","platform_entity_id","bold_platform_entity_id","created_at","updated_at","deleted_at"]},"SubscriptionGroups":{"properties":{"subscription_groups":{"type":"array","items":{"$ref":"#/components/schemas/SubscriptionGroupEntity"}}},"type":"object"},"SubscriptionGroup":{"properties":{"subscription_group":{"$ref":"#/components/schemas/SubscriptionGroupEntity"}},"type":"object"},"SubscriptionGroupEntity":{"type":"object","title":"","properties":{"id":{"type":"integer","example":19364,"readOnly":true},"shop_id":{"type":"integer","example":8846,"readOnly":true},"internal_name":{"type":"string","example":"Standard Subscription"},"is_enabled":{"type":"boolean","example":true},"platform_id":{"type":"string","example":"gid://shopify/SellingPlanGroup/132016692"},"allow_prepaid":{"type":"boolean","example":false},"is_prepaid_only":{"type":"boolean","example":false},"should_continue_prepaid":{"type":"boolean","example":false},"continue_prepaid_type":{"type":"string","example":"as_prepaid","enum":["as_prepaid","as_standard"]},"allow_buffer_days":{"type":"boolean"},"discount_type":{"type":"string","example":"no_discount","enum":["no_discount","percentage","fixed"]},"percent_discount":{"type":"number","example":11},"fixed_discount":{"type":"integer"},"minimum_order_count_before_cancellable":{"type":"integer","example":0},"is_product_swappable":{"type":"boolean","example":false},"is_subscription_only":{"type":"boolean","example":false},"selection_type":{"type":"string","example":"products","enum":["products","collections"]},"group_type":{"type":"string","example":"selectable","enum":["selectable","fixed"]},"selectable_daily_allowed":{"type":"boolean","example":false},"selectable_weekly_allowed":{"type":"boolean","example":false},"selectable_yearly_allowed":{"type":"boolean","example":false},"selectable_max_interval_frequency":{"type":"integer","example":0},"fixed_interval_type":{"type":"string","example":"monthly","enum":["daily","weekly","monthly","yearly"]},"is_fixed_billing":{"type":"boolean","example":false},"can_add_to_cart":{"type":"boolean","example":true},"created_at":{"type":"string","example":"2019-11-20T20:31:55Z","format":"date-time","readOnly":true},"updated_at":{"type":"string","example":"2019-11-20T20:31:55Z","format":"date-time","readOnly":true},"deleted_at":{"type":"string","example":null,"format":"date-time","nullable":true,"readOnly":true},"active_subscribers_count":{"type":"integer","example":1,"readOnly":true},"billing_rules":{"type":"array","items":{"$ref":"#/components/schemas/BillingRuleEntity"}},"selection_options":{"type":"array","items":{"$ref":"#/components/schemas/SelectionOptionEntity"}},"prepaid_durations":{"type":"array","items":{"$ref":"#/components/schemas/PrepaidDuration"}},"dynamic_discounts":{"type":"array","nullable":true,"description":"Dynamic Discounts are applied when the provided number of orders are placed. All order numbers must be unique.\\nExample:\\n  Base product price: $10.00\\n  Initial discount: $1.00\\n  Discounts:\\n    {\\"order_number\\": 2, \\"discount_type\\": \\"fixed\\", \\"discount_value\\": 250}\\n    {\\"order_number\\": 4, \\"discount_type\\": \\"percentage\\", \\"discount_value\\": 30}\\n  Line item prices will be:\\n    1st order: $9.00\\n    2nd order: $9.00\\n    3rd order: $7.50\\n    4th order: $7.50\\n    5th order: $7.00\\n","items":{"$ref":"#/components/schemas/DynamicDiscount"}}},"required":["id","shop_id","internal_name","is_enabled","platform_id","allow_prepaid","is_prepaid_only","should_continue_prepaid","continue_prepaid_type","allow_buffer_days","discount_type","percent_discount","fixed_discount","minimum_order_count_before_cancellable","is_product_swappable","is_subscription_only","selection_type","group_type","selectable_daily_allowed","selectable_weekly_allowed","selectable_yearly_allowed","selectable_max_interval_frequency","fixed_interval_type","is_fixed_billing","can_add_to_cart","created_at","updated_at","deleted_at","active_subscribers_count","billing_rules","selection_options","prepaid_durations"]},"SubscriptionOrders":{"properties":{"subscription_orders":{"type":"array","items":{"$ref":"#/components/schemas/SubscriptionOrderEntity"}}},"type":"object"},"SubscriptionOrder":{"type":"object","properties":{"id":{"type":"integer","example":1008130},"subscription_id":{"type":"integer","example":316561},"shop_id":{"type":"integer","example":6481},"base_to_charged_exchange_rate":{"type":"number","example":1},"base_currency":{"type":"string","example":"CAD"},"order":{"$ref":"#/components/schemas/OrderEntity"},"is_multi_currency":{"type":"boolean"},"created_at":{"type":"string","example":"2021-07-09T18:13:40Z"},"updated_at":{"type":"string","example":"2021-07-09T18:13:40Z","nullable":true}},"required":["id","subscription_id","shop_id","base_to_charged_exchange_rate","base_currency","order","is_multi_currency","created_at","updated_at"],"title":""},"SubscriptionOrderEntity":{"properties":{"id":{"type":"integer","example":151917},"subscription_id":{"type":"integer","example":5266},"shop_id":{"type":"integer","example":29875},"currency":{"type":"string","example":"CAD"},"base_to_charged_exchange_rate":{"type":"integer","example":1},"base_currency":{"type":"string","example":"CAD"},"order":{"$ref":"#/components/schemas/OrderEntity"},"is_multi_currency":{"type":"boolean","example":false},"created_at":{"type":"string","readOnly":true,"example":"2019-11-20T20:31:55Z","format":"date-time"},"updated_at":{"type":"string","readOnly":true,"example":"2019-11-20T20:31:55Z","format":"date-time"}},"type":"object","readOnly":true},"SubscriptionAdjustments":{"properties":{"adjustments":{"type":"array","items":{"$ref":"#/components/schemas/SubscriptionAdjustment"}}}},"SubscriptionAdjustment":{"properties":{"id":{"type":"integer","readOnly":true,"example":74928},"name":{"type":"string","description":"The name of the adjustment.","example":"One-time Upsell (Gift)"},"description":{"type":"string","description":"The description of the adjustment being made to the subscription or its orders.","example":"Enjoy a complementary gift every 5th order for being a loyal customer!"},"target":{"type":"string","description":"The target of the adjustment.","enum":["subscription","order"],"example":"order"},"trigger":{"type":"object","description":"The condition for when and how often the `action` will be made against the `target`.","oneOf":[{"$ref":"#/components/schemas/SubscriptionAdjustmentTriggerOrderCount"},{"$ref":"#/components/schemas/SubscriptionAdjustmentTriggerOrderDatetime"}]},"action":{"type":"object","description":"The action that should be made against the `target` of the adjustment.","oneOf":[{"$ref":"#/components/schemas/SubscriptionAdjustmentActionAddLineItem"},{"$ref":"#/components/schemas/SubscriptionAdjustmentActionUpdateLineItemQuantity"},{"$ref":"#/components/schemas/SubscriptionAdjustmentActionApplyPrice"}]},"invalid_at":{"type":"string","format":"date-time","description":"The date (in [RFC3339 format](https://datatracker.ietf.org/doc/html/rfc3339)) that this adjustment will be applied and become invalid. The value is null for adjustments that are scheduled to be applied one-time in the future.","nullable":true,"readOnly":true,"example":null},"created_at":{"type":"string","format":"date-time","description":"The date (in [RFC3339 format](https://datatracker.ietf.org/doc/html/rfc3339)) that this adjustment was created.","readOnly":true,"example":"2024-10-15T06:00:00Z"},"updated_at":{"type":"string","format":"date-time","description":"The date (in [RFC3339 format](https://datatracker.ietf.org/doc/html/rfc3339)) that this adjustment was last updated. The value is the same as the `created_at` value if the adjustment has never been updated.","readOnly":true,"example":"2024-10-15T06:00:00Z"},"deleted_at":{"type":"string","format":"date-time","description":"The date (in [RFC3339 format](https://datatracker.ietf.org/doc/html/rfc3339)) that this adjustment was deleted. The value is null if the adjustment has never been deleted.","nullable":true,"readOnly":true,"example":null}}},"SubscriptionAdjustmentTriggerOrderCount":{"required":["type"],"properties":{"type":{"type":"string","description":"The type of trigger to use to determine when this adjustment should apply. The value `order_count` is used to match targets based on order count.","enum":["order_count"],"example":"order_count"},"count":{"$ref":"#/components/schemas/SubscriptionAdjustmentMatchConditionCount"},"relative_count":{"$ref":"#/components/schemas/SubscriptionAdjustmentMatchConditionRelativeCount"},"function":{"$ref":"#/components/schemas/SubscriptionAdjustmentMatchConditionFunction"}}},"SubscriptionAdjustmentMatchConditionCount":{"type":"integer","nullable":true,"description":"The order count of the target that the adjustment will apply to.","example":5},"SubscriptionAdjustmentMatchConditionRelativeCount":{"type":"integer","description":"Use the subscription\'s current order count when calculating the final order count.","minimum":1,"example":5},"SubscriptionAdjustmentMatchConditionFunction":{"type":"object","nullable":true,"description":"Use a \\"y = mx + b\\" formula as your match condition for when to apply your adjustment to orders. For example, a \\"step_size\\" of 3 and an \\"offset\\" of 2 to represent \\"Every 3rd order starting on the 2nd order.\\"","properties":{"step_size":{"type":"integer","minimum":1,"example":5},"offset":{"minimum":0,"type":"integer","example":0}}},"SubscriptionAdjustmentTriggerOrderDatetime":{"required":["type"],"properties":{"type":{"type":"string","description":"The type of trigger to use to determine when this adjustment should apply. The value `order_datetime` is used to match targets based on order date and time.","enum":["order_datetime"],"example":"order_datetime"},"datetime":{"type":"string","format":"date-time","description":"The date and time of an order that will trigger this adjustment.","example":"2024-02-15T06:00:00Z"}}},"SubscriptionAdjustmentActionAddLineItem":{"required":["type","platform_product_id","platform_variant_id","quantity"],"properties":{"type":{"type":"string","description":"The action to perform for the adjustment. Adds a line item to the adjustment target.\\n\\nTo add a line item, the `type` value is always \\"add_line_item\\".","enum":["add_line_item"],"example":"add_line_item"},"platform_product_id":{"type":"string","description":"The ID of the product on your platform. Learn more about [finding platform product IDs](/guides/subscriptions-v2/create-subscription#how-do-i-find-the-platform_product_id-and-platform_variant_id-for-a-line-item).","example":"1578934692"},"platform_variant_id":{"type":"string","description":"The ID of the product variant on your platform. All products, including those with no variants or a single variant, have a platform variant ID. Learn more about [finding platform variant IDs](/guides/subscriptions-v2/create-subscription#how-do-i-find-the-platform_product_id-and-platform_variant_id-for-a-line-item).","example":"975285185"},"quantity":{"type":"integer","description":"The quantity of the line item to add.","example":1},"price":{"type":"integer","description":"The price of the line item in the base currency unit (e.g. cents).","example":1500}}},"SubscriptionAdjustmentActionUpdateLineItemQuantity":{"required":["type","subscription_line_item_id","quantity"],"properties":{"type":{"type":"string","description":"The action to perform for the adjustment. Updates a line item quantity for the adjustment target.\\n\\nTo update a line item\'s quantity, the `type` value is always \\"update_line_item_quantity\\".","enum":["update_line_item_quantity"],"example":"update_line_item_quantity"},"subscription_line_item_id":{"type":"number","description":"The ID of the subscription line item to update.","example":35236},"quantity":{"type":"integer","description":"The new quantity of the line item.","example":3}}},"SubscriptionAdjustmentActionApplyPrice":{"required":["type","line_item_id","price"],"properties":{"type":{"type":"string","description":"The action to perform for the adjustment. It updates the price for the adjustment target.\\n\\nTo update a line item\'s price, the `type` value is always \\"apply_price\\".","enum":["apply_price"],"example":"apply_price"},"line_item_id":{"type":"number","description":"The ID of the subscription line item to update.","example":35237},"price":{"type":"integer","description":"The new price of the line item in the base currency unit (e.g. cents).","example":300}}},"SwapProduct":{"type":"object","properties":{"swap_products":{"type":"array","items":{"$ref":"#/components/schemas/SwapProductEntity"}}}},"SwapProductEntity":{"type":"object","properties":{"line_item_id":{"type":"integer","example":1},"platform_product_id":{"type":"string","example":"1357908642"},"platform_variant_id":{"type":"string","example":"2468097531"},"subscription_group_id":{"type":"integer","example":1}}},"SwappableProducts":{"properties":{"swappable_products":{"type":"array","items":{"$ref":"#/components/schemas/SwappableProductEntity"}},"pagination":{"$ref":"#/components/schemas/StandardPaginationEntity"}},"type":"object"},"SwappableProductEntity":{"type":"object","readOnly":true,"properties":{"price":{"type":"integer","readOnly":true,"example":1337},"price_charged":{"type":"integer","readOnly":true,"example":1337},"discounted_price":{"type":"integer","readOnly":true,"example":1337},"discounted_price_charged":{"type":"integer","readOnly":true,"example":1337},"has_discount":{"type":"boolean","readOnly":true,"example":true},"url":{"type":"string","readOnly":true,"example":"https://example-store.example.com/monthly-expansion-pack"},"variants":{"type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/SwappableProductVariantEntity"}},"image":{"type":"string","readOnly":true,"example":"https://example.com/s-sadjid0asd/products/112/images/376/example-store__33773.1574282899.386.513.png?c=1"},"product_image":{"type":"string","readOnly":true,"example":"https://example.com/s-sadjid0asd/products/112/images/376/example-store__33773.1574282899.386.513.png?c=1"},"title":{"type":"string","readOnly":true,"example":"Monthly Expansion Pack"},"product_name":{"type":"string","readOnly":true,"example":"Monthly Expansion Pack"},"platform_product_id":{"type":"string","readOnly":true,"example":"1357908642"},"subscription_group_id":{"type":"integer","readOnly":true,"example":1}}},"ConvertibleAdjustmentGroup":{"type":"object","required":["on_cycle_end","trigger"],"properties":{"id":{"type":"integer","example":1,"readOnly":true},"shop_platform_id":{"type":"integer","example":1234,"readOnly":true},"on_cycle_end":{"type":"string","enum":["repeat_cycle","continue_last_item","remove_from_subscription"],"example":"repeat_cycle"},"trigger":{"type":"object","required":["type","count"],"properties":{"type":{"type":"string","example":"order_count"},"function":{"type":"object","nullable":true,"readOnly":true,"example":null},"count":{"type":"integer","example":1}}},"created_at":{"type":"string","readOnly":true,"example":"2024-03-11T18:56:12Z","format":"date-time"},"updated_at":{"type":"string","readOnly":true,"example":"2024-03-11T18:56:12Z","format":"date-time"},"deleted_at":{"type":"string","example":null,"readOnly":true,"format":"date-time","nullable":true}}},"ConvertibleAdjustmentGroupItemEntity":{"required":["type","discount_type"],"type":"object","properties":{"type":{"type":"string","enum":["product","initial_product"],"example":"product"},"product":{"$ref":"#/components/schemas/ConvertibleAdjustmentGroupItemProduct"},"discount_value":{"type":"integer","example":50},"discount_type":{"type":"string","enum":["percentage","fixed","no_discount"],"example":"percentage"}}},"ConvertibleAdjustmentGroupItem":{"type":"object","properties":{"id":{"type":"integer","description":"The convertible adjustment item identifier.","example":81},"shop_platform_app_id":{"type":"integer","description":"The identifier of the application.","example":1007},"convertible_adjustment_group_id":{"type":"integer","description":"The convertible adjustment group identifier, obtained from calling [Create Convertible Adjustment Group](/api/subscriptions#tag/Convertible-Adjustments/operation/CreateConvertibleAdjustmentGroup).","example":20},"type":{"type":"string","description":"The type of convertible adjustment group item.","enum":["product"],"example":"product"},"discount_value":{"type":"integer","description":"The value given to the discount. For fixed discounts, cents off (e.g. 500 for $5) should be provided. For percent discounts, the percentage off (e.g. 10) should be provided.","example":50},"discount_type":{"type":"string","description":"The type of discount applied to the recurring product","enum":["percentage","fixed","no_discount"],"example":"percentage"},"product":{"type":"object","description":"The product involved in the convertible adjustment.","properties":{"id":{"type":"integer","description":"The product identifier.","example":81},"convertible_adjustment_group_item_id":{"type":"integer","description":"The convertible adjustment group item identifier.","example":81},"platform_product_id":{"type":"string","description":"The identifier of the product on the platform.","example":"7873884881051"},"platform_variant_id":{"type":"string","description":"The identifier of the variant on the platform.","example":"44147854114971"},"product_id":{"type":"string","description":"The identifier of the product","nullable":true,"example":"11"},"variant_id":{"type":"string","description":"The identifier of the variant","nullable":true,"example":"22"},"created_at":{"type":"string","description":"The date and time the product was created.","format":"date-time","example":"2024-03-19T20:42:47Z"},"updated_at":{"type":"string","description":"The date and time the product was updated.","format":"date-time","example":"2024-03-19T20:42:47Z"},"deleted_at":{"type":"string","description":"The date and time the product was deleted.","format":"date-time","nullable":true,"example":null}}},"created_at":{"type":"string","description":"The date and time the convertible adjustment group item was created.","format":"date-time","example":"2024-03-19T20:42:47Z"},"updated_at":{"type":"string","description":"The date and time the convertible adjustment group item was updated.","format":"date-time","example":"2024-03-19T20:42:47Z"},"deleted_at":{"type":"string","description":"The date and time the convertible adjustment group item was deleted.","format":"date-time","nullable":true,"example":null}}},"ConvertibleAdjustmentGroupItemProduct":{"type":"object","nullable":true,"required":["platform_product_id","platform_variant_id"],"properties":{"platform_product_id":{"type":"string","description":"The identifier of the product on the platform.","example":"7873884881051"},"platform_variant_id":{"type":"string","description":"The identifier of the variant on the platform.","example":"44147854114971"}}},"WebhookTopicEntity":{"type":"object","properties":{"id":{"type":"integer"},"topic_name":{"type":"string"}},"x-examples":{"subscription_created":{"id":1,"topic_name":"subscription_created"},"subscription_updated":{"id":2,"topic_name":"subscription_updated"}}},"WebhookEventEntity":{"title":"","type":"object","properties":{"id":{"type":"integer"},"shop_id":{"type":"integer"},"webhook_subscription_id":{"type":"integer"},"webhook_topic_id":{"type":"integer"},"uuid":{"type":"string"},"attempts":{"type":"integer"},"last_response_status_code":{"type":"string"},"delivered_at":{"type":"string"},"created_at":{"type":"string","readOnly":true,"example":"2019-11-20T20:31:55Z","format":"date-time"},"updated_at":{"type":"string","readOnly":true,"example":"2019-11-20T20:31:55Z","format":"date-time"},"deleted_at":{"type":"string","example":null,"readOnly":true,"format":"date-time","nullable":true}},"x-examples":{"Example":{"id":1,"shop_id":1,"webhook_subscription_id":1,"webhook_topic_id":1,"uuid":"18418f32-f1ff-4897-94c9-9daacbaa404b","attempts":1,"last_response_status_code":"200","delivered_at":"2020-08-17T18:27:03Z","created_at":"2020-08-17T18:27:03Z","updated_at":"2020-08-17T18:27:03Z","deleted_at":""}},"description":""},"WebhookSubscriptionEntity":{"type":"object","x-examples":{"Example":{"id":1,"shop_id":1,"webhook_topic_id":1,"callback_url":"yourapp.com/bold-subscription-creation-callback","created_at":"2020-08-13T15:39:01Z","updated_at":"2020-08-13T15:39:01Z","deleted_at":""}},"properties":{"id":{"type":"integer"},"shop_id":{"type":"integer"},"webhook_topic_id":{"type":"integer"},"callback_url":{"type":"string"},"shared_secret":{"type":"string"},"created_at":{"type":"string","readOnly":true,"example":"2019-11-20T20:31:55Z","format":"date-time"},"updated_at":{"type":"string","readOnly":true,"example":"2019-11-20T20:31:55Z","format":"date-time"},"deleted_at":{"type":"string","example":null,"readOnly":true,"format":"date-time","nullable":true}}},"WebhookTopics":{"properties":{"webhook_topics":{"type":"array","items":{"$ref":"#/components/schemas/WebhookTopicEntity"}}},"type":"object"},"WebhookSubscription":{"title":"","type":"object","properties":{"webhook_subscription":{"$ref":"#/components/schemas/WebhookSubscriptionEntity"}}},"WebhookSubscriptions":{"title":"","type":"object","properties":{"webhook_subscriptions":{"type":"array","items":{"$ref":"#/components/schemas/WebhookSubscriptionEntity"}}}},"WebhookEvents":{"properties":{"webhook_events":{"type":"array","items":{"$ref":"#/components/schemas/WebhookEventEntity"}}},"type":"object","description":"","x-examples":{}},"WebhookEvent":{"type":"object","properties":{"webhook_event":{"$ref":"#/components/schemas/WebhookEventEntity"}}},"SwappableProductVariantEntity":{"type":"object","readOnly":true,"x-examples":{},"properties":{"platform_id":{"type":"string","example":"1"},"platform_product_id":{"type":"string","example":"112"},"name":{"type":"string","example":"Size Small"},"sku":{"type":"string","example":"SKU-112-Small"},"price":{"type":"integer","example":1337},"price_charged":{"type":"integer","example":1337},"discounted_price":{"type":"integer","example":1337},"discounted_price_charged":{"type":"integer","example":1337},"discounted_cost":{"type":"integer","example":1337},"discounted_cost_charged":{"type":"integer","example":1337},"cost":{"type":"integer","example":0},"weight":{"type":"number","example":1.5},"weight_unit":{"type":"string","example":"kg"},"grams":{"type":"integer","example":1500},"image_id":{"type":"integer","example":0},"image_url":{"type":"string","example":""},"allow_backorder":{"type":"boolean","example":false},"inventory_quantity":{"type":"integer","example":0},"inventory_tracking_service":{"type":"string","example":"platform"},"inventory_tracking_entity":{"type":"string","example":"product"}},"title":""},"AlternatePaymentMethod":{"description":"","type":"object","properties":{"gift_card":{"type":"array","uniqueItems":true,"minItems":1,"items":{"required":["payment_public_id","card_number","balance"],"properties":{"payment_public_id":{"type":"string","minLength":1},"card_number":{"type":"string","minLength":1},"balance":{"type":"number"}}}}},"required":["gift_card"],"x-examples":{"example-1":{"gift_card":[{"payment_public_id":"Z44qfpucJ1dsQjuZopMpFuQNyKCv7Eui0JLCHq9y1ytE669TlqGChkrl92xxhTXy","card_number":"SADWIUWRFNRVDTCB","balance":1200}]}}},"PrepaidDuration":{"title":"PrepaidDuration","type":"object","properties":{"id":{"type":"integer","readOnly":true},"total_duration":{"type":"integer","minimum":1},"discount_value":{"type":"integer"},"discount_type":{"type":"string","enum":["percentage","fixed","no_discount"]},"created_at":{"type":"string","readOnly":true,"example":"2019-11-20T20:31:55Z","format":"date-time"},"updated_at":{"type":"string","readOnly":true,"example":"2019-11-20T20:31:55Z","format":"date-time"},"deleted_at":{"type":"string","example":null,"readOnly":true,"format":"date-time","nullable":true}}},"DynamicDiscount":{"title":"DynamicDiscount","type":"object","description":"Dynamic Discount is applied when the provided number of orders are placed. The fixed discount value is in the base currency unit (e.g. cents).\\nExample:\\n  Base product price: $10.00\\n  Discount: {\\"order_number\\": 2, \\"discount_type\\": \\"fixed\\", \\"discount_value\\": 250}\\n  The $2.50 discount will be applied after the second order, and the line item price will be changed to $7.50.\\n","properties":{"order_number":{"type":"integer","minimum":1},"discount_type":{"type":"string","example":"fixed","enum":["percentage","fixed"]},"discount_value":{"type":"number","minimum":0,"example":25}}},"SubscriptionAndPaymentMethod":{"title":"SubscriptionAndPaymentMethod","type":"object","properties":{"payment_method":{"$ref":"#/components/schemas/PaymentMethodEntity"},"subscription":{"$ref":"#/components/schemas/SubscriptionEntity"}},"x-examples":{"Example":{"value":{"payment_method":{"public_id":"jik1w6HrCn17CxXPDkWhtgyqvm8wLDd1PelY6k8mabglNmL8XKBnsde9PdgKZqnG","cc_type":"Visa","expiration":{"date":"2020-05","timezone_type":"null","timezone":"null"},"last_four":"1111","is_default":true},"subscription":{"id":1,"shop_id":1,"next_order_datetime":"2020-01-20T18:00:00Z","next_payment_datetime":"2020-01-20T18:00:00Z","subscription_status":"active","payment_method_token":"jik1w6HrCn17CxXPcKwHTGqqvm8wLDd1PelY6k8mabglNmL8XKBnsde9PdgKZqnG","payment_rrule":"DTSTART:20200120T180000Z\\\\nRRULE:FREQ=MONTHLY\\\\nEXDATE:20200220T180000Z","payment_rrule_text":"Monthly","order_rrule":"DTSTART:20200120T180000Z\\\\nRRULE:FREQ=MONTHLY\\\\nEXDATE:20200220T180000Z","order_rrule_text":"Monthly","last_payment_datetime":"2019-11-20T20:55:26Z","last_order_datetime":"2019-11-20T20:55:26Z","last_processed_datetime":"2019-11-20T20:55:26Z","current_retries":3,"charged_currency":"CAD","base_to_charged_exchange_rate":1,"base_currency":"CAD","line_items":[{"id":1,"subscription_id":1,"bold_platform_subscription_id":1,"bold_platform_subscription_line_item_id":1,"platform_product_id":"1357908642","platform_variant_id":"2468097531","subscription_group_id":1,"subscription_group_billing_rules_id":1,"product_name":"Monthly Expansion Pack","variant_name":"Default Title","title":"Monthly Expansion Pack","sku":"SKU-113-Red","url":"https://example-store.example.com/monthly-expansion-pack","image":"","quantity":1,"price":3500,"price_charged":3500,"discounted_price":3200,"discounted_price_charged":3200,"full_price":3200,"full_price_charged":3200,"requires_shipping":false,"grams":2200,"weight":2.2,"weight_unit":"kg","taxable":true,"discounts":[{"id":1,"subscription_line_item_id":1,"shop_id":5,"discount_type":"percentage","percentage_value":10,"fixed_value":0,"description":"Subscription discount (10%) for Monthly Expansion Pack","created_at":"2019-11-20T20:31:55Z","updated_at":"2019-11-20T20:31:55Z"}],"placed_at":"2012-01-20T18:00:00Z","created_at":"2019-11-20T20:31:55Z","updated_at":"2019-11-20T20:31:55Z"}],"customer":{"id":0,"platform_id":0,"cashier_public_id":"string","first_name":"John","last_name":"Doe","phone":"800-555-0102","email":"john.doe@example.com","notes":"Loyal customer.","addresses":[{"id":0,"shop_identifier":"string","platform_id":0,"customer_id":0,"platform_type":"string","platform_customer_id":123456789,"first_name":"John","last_name":"Doe","company":"Example Company","phone":"800-555-0102","street1":"123 example st.","street2":"101","city":"Toronto","province":"Ontario","province_code":"ON","country":"Canada","country_code":"CA","zip":"M5V 3L9","is_default":true,"created_at":"2019-11-20T20:31:55Z","updated_at":"2019-11-20T20:31:55Z"}],"default_address":{"id":0,"shop_identifier":"string","platform_id":0,"customer_id":0,"platform_type":"string","platform_customer_id":123456789,"first_name":"John","last_name":"Doe","company":"Example Company","phone":"800-555-0102","street1":"123 example st.","street2":"101","city":"Toronto","province":"Ontario","province_code":"ON","country":"Canada","country_code":"CA","zip":"M5V 3L9","is_default":true,"created_at":"2019-11-20T20:31:55Z","updated_at":"2019-11-20T20:31:55Z"},"subscription_summary":{"customer_id":0,"next_order_date":"2020-01-20T18:00:00Z","last_order_date":"2019-11-20T20:55:27Z","active_subscription_count":2,"inactive_subscription_count":0,"subscription_order_count":5},"labels":[{"id":0,"customer_id":0,"name":"bsub_subscription_active","created_at":"2019-11-20T20:31:55Z","updated_at":"2019-11-20T20:31:55Z","deleted_at":null}]},"shipping_lines":[{"id":0,"name":"Standard Shipping","code":"Standard Shipping","price":1000,"value":1000,"tag":"Shipping","created_at":"2019-11-20T20:31:55Z","updated_at":"2019-11-20T20:31:55Z","subscription_id":1}],"billing_address":{"id":0,"shop_identifier":"string","platform_id":0,"customer_id":0,"platform_type":"string","platform_customer_id":123456789,"first_name":"John","last_name":"Doe","company":"Example Company","phone":"800-555-0102","street1":"123 example st.","street2":"101","city":"Toronto","province":"Ontario","province_code":"ON","country":"Canada","country_code":"CA","zip":"M5V 3L9","is_default":true,"created_at":"2019-11-20T20:31:55Z","updated_at":"2019-11-20T20:31:55Z","deleted_at":"2019-11-20T20:31:55Z"},"shipping_address":{"id":0,"shop_identifier":"string","platform_id":0,"customer_id":0,"platform_type":"string","platform_customer_id":123456789,"first_name":"John","last_name":"Doe","company":"Example Company","phone":"800-555-0102","street1":"123 example st.","street2":"101","city":"Toronto","province":"Ontario","province_code":"ON","country":"Canada","country_code":"CA","zip":"M5V 3L9","is_default":true,"created_at":"2019-11-20T20:31:55Z","updated_at":"2019-11-20T20:31:55Z","deleted_at":"2019-11-20T20:31:55Z"},"idempotency_key":"JwGdN55C4g1z5FXRO8Hp21CMxUxKyo6VcGSf3cUsjCgNyTtoeZcIsGM1We4p7pCe-0","created_at":"2019-11-20T20:31:55Z","updated_at":"2019-11-20T20:31:55Z","percent_discount":10,"discount_code":"DISCOUNTCODE","customer_id":1697912,"billing_address_id":11697812,"shipping_address_id":11697812,"note":"Staff note","order_note":"Customer note"}}}}},"SubscriptionOrderTransactionFailed":{"title":"SubscriptionOrderTransactionFailed","type":"object","properties":{"id":{"type":"integer","example":123},"bold_platform_subscription_id":{"type":"integer","example":234},"shop_platform_app_id":{"type":"integer","example":345},"failure_reason":{"type":"string","example":"cashier"},"cashier_response":{"type":"string","example":"{\\"success\\":false,\\"errors\\":{\\"code\\":\\"order_creation_failed\\",\\"message\\":\\"\\",\\"service\\":\\"cashier\\",\\"service_type\\":\\"cashier\\"}}"},"current_retries":{"type":"integer","example":3},"max_retries":{"type":"integer","example":3},"created_at":{"type":"string","format":"date-time","example":"2019-11-20T20:31:55Z"},"customer":{"$ref":"#/components/schemas/CustomerEntity"}},"required":["id","bold_platform_subscription_id","shop_platform_app_id","failure_reason","cashier_response","current_retries","max_retries","created_at","shop_identifier"]},"SubscriptionUpdateLineItemsEntity":{"allOf":[{"type":"object","x-examples":{},"properties":{"id":{"type":"integer","example":1,"readOnly":true},"external_id":{"type":"string","nullable":true},"customer":{"example":"null"},"shop_id":{"type":"integer","example":1,"readOnly":true},"next_order_datetime":{"type":"string","example":"2020-01-20T18:00:00Z"},"next_payment_datetime":{"type":"string","example":"2020-01-20T18:00:00Z"},"next_processing_datetime":{"type":"string","example":"2020-01-20T18:00:00Z"},"subscription_status":{"type":"string","enum":["active","inactive","paused","scheduled","processing","app_uninstalled","waiting_sca_authorization"],"example":"active"},"status_changed_at":{"type":"string","example":"2019-11-20T20:31:55Z","format":"date-time","readOnly":true},"sca_url":{"type":"string","example":"https://bank.com/pCkWhtgQQVM8W/sca","nullable":true,"readOnly":true},"payment_method_token":{"type":"string","example":"jik1w6HrCn17CxXPcKwHTGqqvm8wLDd1PelY6k8mabglNmL8XKBnsde9PdgKZqnG"},"payment_gateway_public_id":{"type":"string","example":"jik1w6HrCn17CxXPcKwHTGqqvm8wLDd1PelY6k8mabglNmL8XKBnsde9PdgKZqnG","nullable":true},"payment_rrule":{"type":"string","example":"DTSTART:20200120T180000Z\\\\nRRULE:FREQ=MONTHLY\\\\nEXDATE:20200220T180000Z"},"payment_rrule_text":{"type":"string","example":"Monthly","nullable":true},"order_rrule":{"type":"string","example":"DTSTART:20200120T180000Z\\\\nRRULE:FREQ=MONTHLY\\\\nEXDATE:20200220T180000Z"},"order_rrule_text":{"type":"string","example":"Monthly","nullable":true},"last_payment_datetime":{"type":"string","example":"2019-11-20T20:55:26Z","nullable":true},"last_order_datetime":{"type":"string","example":"2019-11-20T20:55:26Z","nullable":true},"last_processed_datetime":{"type":"string","example":"2019-11-20T20:55:26Z","nullable":true},"current_retries":{"type":"integer","example":3},"charged_currency":{"type":"string","example":"CAD"},"base_to_charged_exchange_rate":{"type":"integer","example":1},"base_currency":{"type":"string","example":"CAD"},"line_items":{"type":"array","items":{"$ref":"#/components/schemas/UpdateLineItemEntity"},"readOnly":true},"shipping_lines":{"type":"array","items":{"$ref":"#/components/schemas/ShippingLineEntity"},"readOnly":true},"billing_address":{"$ref":"#/components/schemas/CustomerAddressEntity"},"shipping_address":{"$ref":"#/components/schemas/CustomerAddressEntity"},"idempotency_key":{"type":"string","example":"JwGdN55C4g1z5FXRO8Hp21CMxUxKyo6VcGSf3cUsjCgNyTtoeZcIsGM1We4p7pCe-0"},"placed_at":{"type":"string","example":"2012-11-20T20:31:55Z","format":"data-time","nullable":true},"created_at":{"type":"string","example":"2019-11-20T20:31:55Z","format":"date-time","readOnly":true},"updated_at":{"type":"string","example":"2019-11-20T20:31:55Z","format":"date-time","readOnly":true},"percent_discount":{"type":"number","example":10,"nullable":true,"readOnly":true},"discount_code":{"type":"string","example":"DISCOUNTCODE","readOnly":true},"customer_id":{"type":"integer","example":1697912,"readOnly":true},"billing_address_id":{"type":"integer","example":11697812},"shipping_address_id":{"type":"integer","example":11697812},"orders_processed":{"type":"integer","example":1,"nullable":true},"last_failure_code":{"type":"string","example":"card_expired","description":"This code may help to identify the type of the error.","nullable":true,"enum":["alt_pp_payment_method_required","bigcommerce_error","card_declined","card_expired","credit_card_not_found","discount_code_use_limit","insufficient_funds","invalid_billing_address","invalid_bold_api_token","invalid_card_expiration_month","invalid_card_expiration_year","invalid_card_number","invalid_customer_email","invalid_discount_code","invalid_payment_method","invalid_security_code","invalid_shipping_address","invalid_zip_code","no_payment_provider","payment_method_declined","shopify_error","stripe_support_required","transaction_declined","out_of_stock_product","unaccepted_credit_card","unknown_error","unsupported_card","unsupported_purchase_type","unsupported_shipping_address","woocommerce_error"]},"last_failure_details":{"type":"object","nullable":true,"description":"Default error messages for the last_failure_code field","required":["message"],"properties":{"message":{"type":"string","description":"Error message","example":"The order couldn\'t process because the card was declined.","nullable":false}}},"last_failure_reason":{"type":"string","example":"credit_card","description":"The reason for the failure","nullable":true,"enum":["credit_card","gateway","cashier","platform","inventory","other"]}}},{"$ref":"#/components/schemas/SubscriptionNotesEntity"}],"required":["id","external_id","customer","shop_id","next_order_datetime","next_payment_datetime","next_processing_datetime","subscription_status","status_changed_at","payment_method_token","payment_gateway_public_id","payment_rrule","payment_rrule_text","order_rrule","order_rrule_text","last_payment_datetime","last_order_datetime","last_processed_datetime","current_retries","charged_currency","base_to_charged_exchange_rate","base_currency","idempotency_key","created_at","updated_at","percent_discount","customer_id","billing_address_id","shipping_address_id","note","order_note"]},"CursorPagination":{"type":"object","title":"CursorPagination","description":"Pagination result for cursor-based paginated endpoints.","properties":{"total":{"type":"integer","example":15,"readOnly":true},"count":{"type":"integer","example":10,"readOnly":true},"per_page":{"type":"integer","example":10,"readOnly":true},"total_pages":{"type":"integer","example":2,"readOnly":true},"next":{"type":"string","example":"P3NpbmNlX2lkPTE1Mjc0Jm9yZGVyX2J5PWlkJm9yZGVyX2RpcmVjdGlvbj1kZXNj","readOnly":true,"nullable":true}},"readOnly":true},"FutureOrdersCursorPagination":{"type":"object","title":"FutureOrdersCursorPagination","description":"Cursor-based pagination result for future orders endpoints.","properties":{"count":{"type":"integer","description":"The count of items on the current response.","example":10},"next":{"type":"string","nullable":true,"description":"A base-64 encoded cursor that can be used on subsequent requests to get the next page. The value is `null` when no pages remain.","example":"P3NpbmNlX2lkPTE1Mjc0Jm9yZGVyX2J5PWlkJm9yZGVyX2RpcmVjdGlvbj1kZXNj"}},"readOnly":true},"SubscriptionsCursorPagination":{"type":"object","title":"CursorPagination","description":"Pagination result for cursor-based paginated endpoints.","properties":{"next":{"type":"string","example":"P3NpbmNlX2lkPTE1Mjc0Jm9yZGVyX2J5PWlkJm9yZGVyX2RpcmVjdGlvbj1kZXNj","readOnly":true},"prev":{"type":"string","example":"P3NpbmNlX2lkPTE1Mjc0Jm9yZGVyX2J5PWlkJm9yZGVyX2RpcmVjdGlvbj1kZXNj","readOnly":true}},"readOnly":true},"PatchLineItemEntity":{"type":"object","title":"","description":"The line item to be updated. Fields marked as **read-only** cannot be updated using this endpoint. Use the property\'s existing value for those fields.","properties":{"id":{"type":"integer","example":1,"nullable":true,"description":"**Read-only.** \\n\\nLine item identifier."},"subscription_id":{"type":"integer","example":1,"nullable":true,"description":"**Read-only.** \\n\\nSubscription identifier."},"platform_id":{"type":"string","example":"ABC123","description":"**Read-only.** \\n\\nIdentifier from the platform."},"platform_product_id":{"type":"string","example":"1357908642","nullable":true,"description":"**Read-only.** \\n\\nProduct identifier from the platform."},"platform_variant_id":{"type":"string","example":"2468097531","nullable":true,"description":"**Read-only.** \\n\\nVariant identifier from the platform."},"subscription_group_id":{"type":"integer","example":1,"description":"Subscription group identifier."},"subscription_group_billing_rules_id":{"type":"integer","example":1,"nullable":true,"description":"Billing rules identifier for the subscription group."},"title":{"type":"string","example":"Monthly Expansion Pack","description":"Line item title."},"product_name":{"type":"string","example":"Monthly Expansion Pack","nullable":true,"description":"**Read-only.** \\n\\nProduct name."},"variant_name":{"type":"string","example":"Default Title","nullable":true,"description":"**Read-only.** \\n\\nVariant name."},"sku":{"type":"string","example":"SKU-113-Red","description":"Product SKU."},"url":{"type":"string","example":"https://example-store.example.com/monthly-expansion-pack","description":"**Read-only.** \\n\\nProduct URL."},"image":{"type":"string","example":"","description":"Product image."},"quantity":{"type":"integer","example":1,"description":"Product quantity."},"price":{"type":"integer","example":3500,"nullable":true,"description":"Product price. If changed, all related `price` fields may be impacted. If omitted, the price will be used from the exising line item when updating or the matching product when adding a new line item."},"price_charged":{"type":"integer","example":3200,"nullable":true,"description":"**Read-only.** \\n\\nInfluenced by changes made to the `price` field."},"discounted_price":{"type":"integer","example":3200,"description":"**Read-only.** \\n\\nInfluenced by changes made to the `price` field."},"discounted_price_charged":{"type":"integer","example":3200,"description":"**Read-only.** \\n\\nInfluenced by changes made to the `price` field."},"full_price":{"type":"integer","example":3200,"description":"**Read-only.** \\n\\nInfluenced by changes made to the `price` field."},"full_price_charged":{"type":"integer","example":3200,"description":"**Read-only.** \\n\\nInfluenced by changes made to the `price` field."},"requires_shipping":{"type":"boolean","example":false,"description":"Whether or not the line item requires shipping."},"grams":{"type":"integer","example":2200,"description":"Product weight in grams."},"weight":{"type":"number","example":2.2,"description":"Product weight in `weight_unit`."},"weight_unit":{"type":"string","example":"kg","description":"Unit used for `weight`."},"taxable":{"type":"boolean","example":true,"description":"Whether or not the line item is taxable."},"discounts":{"type":"array","items":{"$ref":"#/components/schemas/LineItemDiscountEntity"},"description":"**Read-only.** \\n\\nAll discounts associated with the line item."},"prepaid_metadata":{"type":"object","description":"**Read-only.**\\n\\nPrepaid properties, as defined in the [Create Line Item Prepaid Metadata](/api/subscriptions#tag/Subscription-Line-Items/operation/CreateLineItemPrepaidMetadata) and [Update Line Item Prepaid Metadata](/api/subscriptions#tag/Subscription-Line-Items/operation/UpdateLineItemPrepaidMetadata) endpoint. Set to `null` when using the [Update Subscription Line Items](/api/subscriptions#tag/Subscription-Line-Items/operation/UpdateLineItems) endpoint.","nullable":true,"enum":[null],"example":null},"line_item_attributes":{"type":"array","items":{"$ref":"#/components/schemas/LineItemAttributeEntity"},"description":"**Read-only.** \\n\\nAdditional attributes associated with the line item. \\n\\nUse the [Update Line Item Attributes](subscriptions#operation/UpdateLineItemAttributes) endpoint to add, update, or delete line item attributes."},"created_at":{"type":"string","example":"2019-11-20T20:31:55Z","format":"date-time","readOnly":true},"updated_at":{"type":"string","example":"2019-11-20T20:31:55Z","format":"date-time","readOnly":true}},"required":["id","subscription_id","platform_id","platform_product_id","platform_variant_id","subscription_group_id","subscription_group_billing_rules_id","title","product_name","variant_name","sku","url","image","quantity","price_charged","discounted_price","discounted_price_charged","full_price","requires_shipping","grams","weight","weight_unit","taxable","discounts","prepaid_metadata"],"readOnly":true},"createdAt":{"type":"string","description":"The date and time when the object was created.","example":"2022-12-25T00:00:00Z","format":"date-time","readOnly":true},"updatedAt":{"type":"string","description":"The date and time when the object was most recently updated.","example":"2022-12-25T00:00:00Z","format":"date-time","readOnly":true,"nullable":true},"deletedAt":{"type":"string","description":"The date and time when the object was deleted. Set to `null` when the object was not deleted.","example":"2022-12-25T00:00:00Z","format":"date-time","nullable":true}},"parameters":{"shop_identifier_path_param":{"name":"shop_identifier","in":"path","description":"The unique identifier of the shop.","required":true,"schema":{"type":"string","example":"123456"}},"customer_id_path_param":{"name":"customer_id","in":"path","description":"The customer identifier.","required":true,"schema":{"type":"integer","example":12}},"address_id_path_param":{"name":"address_id","in":"path","description":"The address identifier.","required":true,"schema":{"type":"integer"}},"subscription_id_path_param":{"name":"subscription_id","in":"path","description":"The subscription identifier.","required":true,"schema":{"type":"integer"}},"subscription_adjustment_id_path_param":{"name":"adjustment_id","in":"path","description":"The subscription adjustment identifier.","required":true,"schema":{"type":"integer"}},"convertible_adjustment_group_id_path_param":{"name":"adjustment_id","in":"path","description":"The convertible adjustment group identifier, obtained from calling [Create Convertible Adjustment Group](/api/subscriptions#tag/Convertible-Adjustments/operation/CreateConvertibleAdjustmentGroup).","required":true,"schema":{"type":"integer"}},"convertible_adjustment_group_item_id_path_param":{"name":"adjustment_item_id","in":"path","description":"The convertible adjustment group item identifier, obtained from calling [Create Convertible Adjustment Group Items](/api/subscriptions#tag/Convertible-Adjustments/operation/CreateConvertibleAdjustmentGroupItems).","required":true,"schema":{"type":"integer"}},"filter_subscription_adjustments_query_param":{"schema":{"type":"string"},"in":"query","name":"filter","description":"Accepts filtering options as described in [Query & Pagination](/guides/getting-started/query-pagination). For example, to limit the request to all future adjustments to individual orders, the following query param may be added: `?filter=eq(target:order)`"},"order_id_path_param":{"name":"order_id","in":"path","description":"The order identifier.","required":true,"schema":{"type":"integer"}},"subscription_interval_id_path_param":{"name":"subscription_interval_id","in":"path","description":"The subscription interval identifier.","required":true,"schema":{"type":"integer"}},"line_item_id_path_param":{"name":"line_item_id","in":"path","description":"Line item ID to view and manage data for.","required":true,"schema":{"type":"integer"}},"group_id_path_param":{"name":"group_id","in":"path","description":"The subscription group identifier.","required":true,"schema":{"type":"integer"}},"webhook_subscription_id_path_param":{"name":"webhook_subscription_id","in":"path","description":"The webhook subscription identifier.","required":true,"schema":{"type":"integer"}},"webhook_event_id_path_param":{"name":"webhook_event_id","in":"path","description":"The webhook event identifier.","required":true,"schema":{"type":"integer"}},"limit":{"name":"limit","in":"query","required":false,"description":"The maximum number of results to be returned.","schema":{"type":"integer","example":10,"default":50}},"page":{"name":"page","in":"query","required":false,"description":"The page to request.","schema":{"type":"integer","default":1,"example":2}},"cursor":{"name":"cursor","in":"query","required":false,"description":"A Base-64 encoded cursor. Used to get a page of data on a cursor paginated request. Obtained from the response of a previous request.","schema":{"type":"string","example":"P3NpbmNlX2lkPTE1Mjc0Jm9yZGVyX2J5PWlkJm9yZGVyX2RpcmVjdGlvbj1kZXNj"}},"filter_future_orders_query_param":{"schema":{"type":"string","example":"lte(order_datetime:2024-05-10T23:59:59)"},"in":"query","name":"filter","description":"Filter future orders. Accepts filtering options as described in the [Query and Pagination](/guides/subscriptions-v2/resources/query-pagination) reference."},"filter_future_order_subscriptions_query_param":{"schema":{"type":"string","example":"eq(bold_customer_id:3623267)"},"in":"query","name":"subscription_filter","description":"Filter future orders. Accepts filtering options as described in the [Query and Pagination](/guides/subscriptions-v2/resources/query-pagination) reference.\\n\\nTo see available filters, refer to the [Future Orders](/guides/subscriptions-v2/view-future-orders) guide."},"customerStatus":{"name":"status","in":"query","required":false,"description":"Customer status to filter.","schema":{"type":"string","enum":["all","active","inactive"],"default":"all","example":"active"}},"customerSearch":{"name":"search","in":"query","required":false,"description":"Search with a specific target. It\'s possible to search by subscription ID or phone number.","schema":{"type":"string"},"examples":{"bySubscription":{"summary":"By subscription ID","value":"#1234"},"byPhone":{"summary":"By phone","value":"123456"}}},"event_actor_type_header":{"in":"header","name":"Event-Actor-Type","required":true,"description":"The type of actor that triggered the webhook event.","schema":{"type":"string","enum":["store_admin","customer","integration","subscription_app"]}},"shop_identifier_header":{"in":"header","name":"Shop-Identifier","required":true,"description":"The unique identifier of the shop.","schema":{"type":"string","enum":["{$request.path.shop_identifier}"]}},"latest":{"in":"query","name":"latest","required":false,"description":"If set to `true`, returns the most recent selection option for each distinct `platform_entity_id` in the response.\\n\\nThis is useful when using the `expand=subscription_group` query parameter by returning only the most recent subscription group a product was added to.","schema":{"type":"boolean","default":false},"example":true}}}}},"plugin-redoc-10":{"url":"/api/checkout-admin.openapi.yaml","themeId":"theme-redoc","isSpecFile":true,"spec":{"openapi":"3.0.0","info":{"title":"Checkout Admin","version":"2.0","description":"Use the Checkout Admin API to configure store-level settings. This includes the ability to configure overrides.\\n\\nRefer to the <a href=\\"https://developer.boldcommerce.com/changelog/tags/checkout-admin\\">changelog</a> for the latest updates to this API.","termsOfService":"https://boldcommerce.com/terms-of-service","contact":{"name":"Contact Us","url":"https://developer-dashboard.boldcommerce.com/default/contactus"}},"servers":[{"url":"https://api.boldcommerce.com"}],"security":[{"OAuthToken":[]},{"APIAccessToken":[]}],"tags":[{"name":"Cross Origin Resource Sharing (CORS)","description":"Contains information about the domains that can access the Bold Checkout APIs. Use these endpoints to manage the approved domains."},{"name":"External Payment Gateways","description":"Contains information about an external payment gateway that can be integrated into a store\'s checkout experience. Use these endpoints to manipulate the external payment gateways for a store."},{"name":"Gift Cards","description":"Contains information about Gift Cards on a given store. Use this endpoint to get all data associated with a Gift Card for a store."},{"name":"Integrations","description":"Contains a shared secret, which is used to configure the webhooks that your integration uses."},{"name":"Lightweight Frontend Experience (LiFE) Elements","description":"Contains information about the Checkout Lightweight Frontend Experience (LiFE) Elements, which enable you to add custom elements into your checkout experience. Use these endpoints to add, edit, and delete elements."},{"name":"Overrides","description":"Contains information about the API overrides on a given store, such as the override type, redirect URL, and shared secret. Use these endpoints to manipulate overrides for a store."},{"name":"Payment CSS","description":"Contains information about the CSS used to style the [Secure Payments Interface (SPI)](/guides/checkout/resources/glossary#secure-payments-interface-spi). Use these endpoints to manipulate the SPI iFrame for all orders on a store."},{"name":"Remote State Authority","description":"Contains information about the Remote State Authority on a given store, such as the URL and shared secret. Use these endpoints to manipulate configuration details for the Remote State Authority for a store. Refer to [Create a Checkout Remote State Authority](/default/guides/platform-connector/rsa/create-checkout-rsa) for more information."},{"name":"Saved Payment Methods","description":"Contains information about customers\' payment methods. Use these endpoints to retrieve or modify saved payment methods."},{"name":"Shops","description":"Contains information about the store\'s checkout configuration, which is set in the [Bold Checkout admin](https://apps.boldapps.net/accounts/app/4)."},{"name":"Tax Zone Settings","description":"Contains information about tax providers for individual tax zones."},{"name":"Warehouses","description":"Contains information about the warehouses for a given store. This information is required to retrieve shipping rates and calculate taxes."},{"name":"Webhooks","description":"Contains information about the webhooks registered on a given store. Use these endpoints to manipulate the webhooks registered on your store."},{"name":"Zones","description":"Contains information about the [zones](/guides/checkout/resources/glossary#zone) for a given store. Use these endpoints to manipulate the [shipping zones](/guides/checkout/resources/glossary#shipping-zone), [tax zones](/guides/checkout/resources/glossary#tax-zone), and [warehouse zones](/guides/checkout/resources/glossary#warehouse-zone) for a store.\\n\\n> **Tip:** Some operations in Checkout require at least one zone to be created. If you have no interest in specific regions, you can use a [default zone](/guides/checkout/resources/glossary#default-zone) instead.\\n"}],"externalDocs":{"description":"For more information about Checkout, refer to the Overview.","url":"https://developer.boldcommerce.com/guides/checkout"},"paths":{"/checkout/shop/{shop_identifier}/cors":{"parameters":[{"$ref":"#/components/parameters/shop_identifier"}],"post":{"summary":"Add Domain to CORS Allowlist","operationId":"AddDomainCORSAllowlist","tags":["Cross Origin Resource Sharing (CORS)"],"description":"Adds a domain to the list of domains with permission to call the Bold Checkout APIs.\\n\\nUse this endpoint if you are self-hosting your checkout. This endpoint is also required to enable self-hosted development stores to call the Bold Checkout APIs.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"domain":{"$ref":"#/components/schemas/CORSDomain"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CORSDomainList"}}}},"examples":{"CORSDomains":{"$ref":"#/components/examples/CORSDomainsExample"}}}}},"500":{"$ref":"#/components/responses/UnknownError"}}},"get":{"summary":"Get CORS Allowlist","operationId":"GetCORSAllowlist","tags":["Cross Origin Resource Sharing (CORS)"],"description":"Retrieves the list of domains with permission to call the Bold Checkout APIs.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"oneOf":[{"type":"object","description":"The list of domains on the CORS allowlist.","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CORSDomainList"}}}},{"type":"object","description":"An empty object, indicating that there are no domains in the CORS allowlist.","properties":{"data":{"type":"object","maxProperties":0}}}]},"examples":{"CORSDomains":{"$ref":"#/components/examples/CORSDomainsExample"},"NoCORSDomains":{"value":{"data":{}}}}}}},"500":{"$ref":"#/components/responses/UnknownError"}}}},"/checkout/shop/{shop_identifier}/cors/{domain_id}":{"parameters":[{"$ref":"#/components/parameters/shop_identifier"},{"$ref":"#/components/parameters/domain_id"}],"delete":{"summary":"Delete Domain from CORS Allowlist","operationId":"DeleteDomainFromCORSAllowlist","tags":["Cross Origin Resource Sharing (CORS)"],"description":"Deletes a domain from the list of domains with permission to call the Bold Checkout APIs. Specify the domain to be deleted using the `domain_id` in the request route.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","maxLength":0,"items":{}}}}},"404":{"description":"Domain ID does not exist","content":{"application/json":{"schema":{"type":"array","maxLength":0,"items":{}}}}}}}},"/checkout/shop/{shop_identifier}/life_elements":{"parameters":[{"$ref":"#/components/parameters/shop_identifier"}],"post":{"summary":"Create Element","operationId":"CreateElement","tags":["Lightweight Frontend Experience (LiFE) Elements"],"description":"Adds a LiFE element to the store\'s checkout at a specific location. For more information about the locations and where they are, refer to the [Checkout LiFE guide](/guides/checkout/life).","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LiFE_element"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"life_elements":{"$ref":"#/components/schemas/LiFE_element"}}}}}}}},"422":{"description":"Unprocessable entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"},"examples":{"NameFieldIsRequired":{"value":{"errors":[{"code":"02-94","type":"life_element.invalid_life_element_data","message":"The meta_data_field is required.","details":{}}]}}}}}}}},"get":{"summary":"List Elements","operationId":"ListElements","tags":["Lightweight Frontend Experience (LiFE) Elements"],"description":"Lists the LiFE elements that are associated with a given store\'s checkout.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"life_elements":{"type":"array","uniqueItems":true,"items":{"$ref":"#/components/schemas/LiFE_element"}}}}}}}}}}}},"/checkout/shop/{shop_identifier}/life_elements/{public_element_id}":{"parameters":[{"$ref":"#/components/parameters/shop_identifier"},{"$ref":"#/components/parameters/public_element_id"}],"patch":{"summary":"Update Element","operationId":"UpdateElement","tags":["Lightweight Frontend Experience (LiFE) Elements"],"description":"Updates a LiFE element that already exists on a store\'s checkout. You can edit any of the element\'s attributes using this endpoint.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"life_elements":{"$ref":"#/components/schemas/LiFE_element"}}}}}}}},"422":{"description":"Unprocessable request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"},"examples":{"LifeElementNotFound":{"value":{"errors":[{"code":"02-94","type":"life_element.life_element_not_configured","message":"LiFE element with the given `public_id` not found.","details":{}}]}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LiFE_element"}}}}},"delete":{"summary":"Delete Element","operationId":"DeleteElement","description":"Removes a LiFE element from a store\'s checkout.","tags":["Lightweight Frontend Experience (LiFE) Elements"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object"}}}}}},"422":{"description":"Unprocessable request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"},"examples":{"LifeElementNotFound":{"value":{"errors":[{"code":"02-91","type":"life_element.life_element_not_configured","message":"LiFE element with the given `public_id` not found.","details":{}}]}}}}}}}}},"/checkout/shop/{shop_identifier}/external_payment_gateways":{"parameters":[{"$ref":"#/components/parameters/shop_identifier"}],"post":{"summary":"Create External Payment Gateway","operationId":"CreateExternalPaymentGateway","tags":["External Payment Gateways"],"description":"Adds an external payment gateway to a store.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"external_payment_gateway":{"$ref":"#/components/schemas/ExternalPaymentGateway"}}}}},"examples":{"example-1":{"value":{"data":{"external_payment_gateway":{"public_id":"VfYRxzOjRkwG6B2xWbxhPQ","name":"External Payment Gateway","base_url":"www.example.com/payments","iframe_url":"www.example.com/gateway","api_token":"XjqnSQWYAZXt","partial_capture":true,"additional_order_details":true,"provider_id":"8ad85ccf-7fd6-4f4b-a1a2-dff42fb3e228","currency":"CAD","location":"payment_method_below"}}}}}}}},"422":{"description":"Unprocessable entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"},"examples":{"NameFieldIsRequired":{"value":{"errors":[{"code":"02-91","type":"external_payment_gateway.invalid_external_payment_gateway_data","message":"The name field is required.","details":{}}]}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalPaymentGateway"},"examples":{"example-1":{"value":{"name":"External Payment Gateway","base_url":"www.example.com/payments","iframe_url":"www.example.com/gateway","api_token":"XjqnSQWYAZXt","partial_capture":true,"additional_order_details":true,"provider_id":"8ad85ccf-7fd6-4f4b-a1a2-dff42fb3e228","currency":"CAD","http_headers":[{"key":"foo","value":"bar"}],"location":"payment_method_below"}}}}}}},"get":{"summary":"List External Payment Gateways","operationId":"ListExternalPaymentGateways","tags":["External Payment Gateways"],"description":"Lists external payment gateways for a given store.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"external_payment_gateways":{"type":"array","uniqueItems":true,"items":{"$ref":"#/components/schemas/ExternalPaymentGateway"}}}}}},"examples":{"example-1":{"value":{"data":{"external_payment_gateways":[{"public_id":"SqCAft3jGmwDVK8aQbhi2R","name":"First External Payment Gateway","base_url":"www.example-1.com/payments","iframe_url":"www.example-1.com/gateway","api_token":"XjqnSQWYAZXt","partial_capture":true,"additional_order_details":true,"provider_id":"5dgg27kce-2jd7-1h8v-j2f5-xsgn2di9s764","currency":"CAD","location":"payment_method_below","http_headers":[{"key":"foo","value":"bar"}]},{"public_id":"VfYRxzOjRkwG6B2xWbxhPQ","name":"Second External Payment Gateway","base_url":"www.example-2.com/payments","iframe_url":"www.example-2.com/gateway","api_token":"PjqnSQWYAZXz","partial_capture":true,"additional_order_details":true,"provider_id":"8ad85ccf-7fd6-4f4b-a1a2-dff42fb3e228","currency":"CAD","location":"payment_method_below","http_headers":null}]}}}}}}}}}},"/checkout/shop/{shop_identifier}/external_payment_gateways/{public_gateway_id}":{"parameters":[{"$ref":"#/components/parameters/shop_identifier"},{"$ref":"#/components/parameters/public_gateway_id"}],"patch":{"summary":"Update External Payment Gateway","operationId":"UpdateExternalPaymentGateway","tags":["External Payment Gateways"],"description":"Updates an external payment gateway on a store.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"external_payment_gateway":{"$ref":"#/components/schemas/ExternalPaymentGateway"}}}}},"examples":{"example-1":{"value":{"data":{"external_payment_gateway":{"public_id":"VfYRxzOjRkwG6B2xWbxhPQ","name":"External Payment Gateway","base_url":"www.example.com/payments","iframe_url":"www.example.com/gateway","api_token":"XjqnSQWYAZXt","partial_capture":true,"additional_order_details":true,"provider_id":"8ad85ccf-7fd6-4f4b-a1a2-dff42fb3e228","currency":"CAD","http_headers":[{"key":"foo","value":"bar"}],"location":"payment_method_below"}}}}}}}},"422":{"description":"Unprocessable request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"},"examples":{"PaymentGatewayNotFound":{"value":{"errors":[{"code":"02-91","type":"external_payment_gateway.not_found","message":"External payment gateway with the given `public_id` not found.","details":{}}]}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalPaymentGateway"},"examples":{"example-1":{"value":{"name":"External Payment Gateway","base_url":"www.example.com/payments","iframe_url":"www.example.com/gateway","api_token":"XjqnSQWYAZXt","partial_capture":true,"additional_order_details":true,"provider_id":"8ad85ccf-7fd6-4f4b-a1a2-dff42fb3e228","currency":"CAD","http_headers":[{"key":"foo","value":"bar"}],"location":"payment_method_below"}}}}}}},"delete":{"summary":"Delete External Payment Gateway","operationId":"DeleteExternalPaymentGateway","description":"Removes an external payment gateway from a store.","tags":["External Payment Gateways"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object"}}}}}},"422":{"description":"Unprocessable request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"},"examples":{"PaymentGatewayNotFound":{"value":{"errors":[{"code":"02-91","type":"external_payment_gateway.not_found","message":"External payment gateway with the given `public_id` not found.","details":{}}]}}}}}}}}},"/checkout/shop/{shop_identifier}/customer/{public_customer_id}/payment_methods":{"parameters":[{"$ref":"#/components/parameters/shop_identifier"},{"$ref":"#/components/parameters/public_customer_id"}],"get":{"summary":"List Saved Payment Methods","operationId":"ListSavedPaymentMethods","tags":["Saved Payment Methods"],"description":"Lists all saved payment methods for a specific customer.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CustomerPaymentMethods"}}},"example":{"success":true,"cards":[{"type":"credit_card","public_id":"ZdtkGke3jqR4qeI9IvtrHaRQZxdobJ5SaGdcX7V22O0v2U5bBqDGb6FHAkpPk4KS","is_default":false,"cc_type":"Visa","last_four":"1111","expiration":{"date":"2023-11"}}]}}}}}}},"/checkout/shop/{shop_identifier}/customer/stored-cards/{public_payment_id}":{"parameters":[{"$ref":"#/components/parameters/shop_identifier"},{"$ref":"#/components/parameters/public_payment_id"}],"delete":{"summary":"Delete Saved Payment Method","operationId":"DeleteSavedPaymentMethod","tags":["Saved Payment Methods"],"description":"Deletes the saved payment method associated with a public payment identifier.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/DeletePaymentMethod"}}},"examples":{"OneOrMorePaymentMethodsRemaining":{"value":{"success":true,"defaultCardId":1}},"NoRemainingPaymentMethods":{"value":{"success":true,"defaultCardId":""}}}}}}}}},"/checkout/shop/{shop_identifier}/overrides":{"parameters":[{"$ref":"#/components/parameters/shop_identifier"}],"post":{"summary":"Create API Override","operationId":"CreateAPIOverride","tags":["Overrides"],"description":"Creates an API override for a given store. The API override is used to customize base functionality. Store level API overrides will apply to all orders, but per-order overrides may take priority. For more information, refer to [API Overrides](/guides/checkout/api-overrides).","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OverrideRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/OverrideConfig"}}},"examples":{"example-1":{"value":{"data":{"public_id":"1","override_type":"discount","url":"https://example.com/overrides/callback_url","created_at":"2021-11-17 21:03:36","updated_at":"2021-11-17 21:03:36"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorsV1"},"examples":{"OverrideTypeDoesNotExist":{"value":{"errors":[{"message":"The override_type does not exist.","type":"api_override","field":"override_type","severity":"validation","sub_type":"api_override"}]}},"InvalidURL":{"value":{"errors":[{"message":"The `url` field must be a valid url.","type":"api_override","field":"url","severity":"validation","sub_type":"api_override"}]}}}}}}}},"get":{"summary":"List API Overrides","operationId":"ListAPIOverrides","tags":["Overrides"],"description":"Retrieves a list of registered API overrides for a given store.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","uniqueItems":true,"items":{"$ref":"#/components/schemas/OverrideConfig"}}}},"examples":{"example-1":{"value":{"data":[{"public_id":"1","override_type":"discount","url":"https://example.com/overrides/discount","created_at":"2021-11-17 21:03:36","updated_at":"2021-11-17 21:03:36"},{"public_id":"2","override_type":"shipping","url":"https://example.com/overrides/shipping","created_at":"2021-11-17 21:03:36","updated_at":"2021-11-17 21:03:36"}]}}}}}}}}},"/checkout/shop/{shop_identifier}/overrides/{public_id}":{"parameters":[{"$ref":"#/components/parameters/shop_identifier"},{"schema":{"type":"string"},"name":"public_id","in":"path","required":true,"description":"The identifier for the affected API override."}],"patch":{"summary":"Update API Override","operationId":"UpdateAPIOverride","tags":["Overrides"],"description":"Updates the given override. Enables the caller to update the `url` property, the `override_type` property, or both, for a given API override. A store can have more than one API override of the same type.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OverrideRequest"},"example":{"override_type":"discount","url":"https://example.com/overrides/updated_callback_url","shared_secret":"aq9834g4aqkdwa0"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/OverrideConfig"}}},"examples":{"UpdatedCallbackURL":{"value":{"data":{"public_id":"1","override_type":"discount","url":"https://example.com/overrides/updated_callback_url","created_at":"2021-11-17 21:03:36","updated_at":"2021-11-20 215:09:22"}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorsV1"},"examples":{"OverrideTypeDoesNotExist":{"value":{"errors":[{"message":"The override_type does not exist.","type":"api_override","field":"override_type","severity":"validation","sub_type":"api_override"}]}},"InvalidURL":{"value":{"errors":[{"message":"The `url` field must be a valid url.","type":"api_override","field":"url","severity":"validation","sub_type":"api_override"}]}}}}}}}},"delete":{"summary":"Delete API Override","operationId":"DeleteAPIOverride","tags":["Overrides"],"description":"Delete an API override from the given store.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object"}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorsV1"},"examples":{"MissingPublicID":{"value":{"errors":[{"message":"The `public id` field is required.","type":"api_override","field":"public_id","severity":"validation","sub_type":"api_override"}]}}}}}}}}},"/checkout/shop/{shop_identifier}/rsa_config":{"parameters":[{"$ref":"#/components/parameters/shop_identifier"}],"post":{"summary":"Connect Remote State Authority","operationId":"ConnectRemoteStateAuthority","tags":["Remote State Authority"],"description":"Connects Remote State Authority to a given shop.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","description":"The destination URL to which a request will be made when order state changes occur.","example":"https://example.com/my_remote_state_authority"},"shared_secret":{"type":"string","description":"Your shared secret, which can be any string you choose. Bold uses this string and the current date to create a signature for each request.","minLength":8,"maxLength":255,"example":"d5210fa5563dd4f5b06f00d0"}},"required":["url","shared_secret"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/RemoteStateAuthorityConfig"}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"},"examples":{"Invalid URL":{"value":{"errors":[{"code":"02-89","type":"remote_state_authority.rsa_already_configured","message":"Remote State Authority already configured. Please update configuration instead."}]}}}}}}}},"patch":{"summary":"Update Remote State Authority Connection","operationId":"UpdateRemoteStateAuthorityConnection","tags":["Remote State Authority"],"description":"Updates connection to a Remote State Authority for a given shop.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","description":"The destination URL to which a request will be made when order state changes occur.","example":"https://example.com/my_remote_state_authority"},"shared_secret":{"type":"string","description":"Your shared secret, which can be any string you choose. Bold uses this string and the current date to create a signature for each request.","minLength":8,"maxLength":255,"example":"d5210fa5563dd4f5b06f00d0"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/RemoteStateAuthorityConfig"}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"},"examples":{"Invalid URL":{"value":{"errors":[{"code":"02-89","type":"remote_state_authority.rsa_not_configured","message":"Remote State Authority not configured."}]}}}}}}}},"get":{"summary":"Get Remote State Authority","operationId":"GetRemoteStateAuthority","tags":["Remote State Authority"],"description":"Gets Remote State Authority connection details for a given shop.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/RemoteStateAuthorityConfig"}}},"examples":{"ConfigurationFound":{"value":{"data":{"remote_state_authority":{"url":"https://example.com/my_remote_state_authority"}}}},"ConfigurationNotFound":{"value":{"data":{"remote_state_authority":null}}}}}}}}},"delete":{"summary":"Delete Remote State Authority","operationId":"DeleteRemoteStateAuthority","tags":["Remote State Authority"],"description":"Removes Remote State Authority functionality for a given shop.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"remote_state_authority":{}}}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"},"examples":{"Remote State Authority not configured":{"value":{"errors":[{"code":"02-89","type":"remote_state_authority.rsa_not_configured","message":"Remote State Authority not configured."}]}}}}}}}}},"/checkout/shop/{shop_identifier}/gift_card":{"parameters":[{"$ref":"#/components/parameters/shop_identifier"}],"get":{"summary":"Get Gift Card","operationId":"GetGiftCard","tags":["Gift Cards"],"description":"Gets a gift card on a given shop, specified by either the `public_payment_method_id` or a combination of the `card_token` and `card_pin`.\\n\\nFor more information, refer to the [Manage Gift Cards](/guides/checkout/gift-cards) guide.","parameters":[{"in":"query","name":"params","required":true,"style":"form","explode":true,"schema":{"type":"object","oneOf":[{"type":"object","title":"Public Payment Method Id","properties":{"public_payment_method_id":{"type":"string","description":"The payment public ID of the gift card, assigned when configured as a customer\'s payment method.","example":"i5uATT2QVKlozoDA2msg89w3mWAdPTIeLtED44R1SJYUVuI7jO4NqHdM8vjoqq7A7P"}},"required":["public_payment_method_id"]},{"type":"object","title":"Card Token and Pin","properties":{"card_token":{"type":"string","description":"The gift card token.","example":"AJPG-TPOE-FNAA-MDEH"},"card_pin":{"type":"string","description":"The gift card PIN.","example":"937"}},"required":["card_token","card_pin"]}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"gift_card":{"$ref":"#/components/schemas/GiftCard"}}}}},"examples":{"GiftCardFound":{"value":{"data":{"gift_card":{"card_token":"OAVXDVRAJUGFMHEK","amount":5000,"balance":2575,"recipient_name":"John","recipient_email":"john.smith@example.com","message":"Enjoy this gift certificate from us.","expiry_date":"2025-04-01","customer_name":"Jane","customer_email":"jane.doe@example.com"}}}}}}}},"422":{"description":"Unprocessable entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"},"examples":{"Provide either public_payment_method_id or card_token and PIN":{"value":{"errors":[{"code":"02-50","type":"gift_cards.invalid_gift_card_data","message":"Please provide one of `public payment method id` or `card token` and `card pin`."}]}},"The card_pin is required":{"value":{"errors":[{"code":"02-50","type":"gift_cards.invalid_gift_card_data","message":"The card pin field is required when the `card token` field is present."}]}},"Gift Card not found":{"value":{"errors":[{"code":"02-87","type":"gift_cards.gift_card_not_found","message":"The gift card was not found."}]}}}}}},"500":{"$ref":"#/components/responses/UnknownError"}}}},"/checkout/shop/{shop_identifier}/integration/config":{"parameters":[{"$ref":"#/components/parameters/shop_identifier"}],"post":{"summary":"Configure Integration Settings","operationId":"ConfigureIntegrationSettings","tags":["Integrations"],"description":"Configures webhooks to integrate with your shop, using a given shared secret.\\n\\nRead more about configuring webhook integration in the [Register for Webhooks guide](/guides/checkout/webhooks#configure-the-shared-secret).","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigureIntegrationBody"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","minItems":0,"maxItems":0,"items":{}}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnprocessableEntity"},"examples":{"MissingSharedSecret":{"value":{"errors":[{"message":"The shared secret field is required.","type":"integration_config","field":"shared_secret","severity":"validation","sub_type":""}]}}}}}},"500":{"description":"Occurs if the shop could not be determined.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorV2"},"examples":{"CouldNotFindShop":{"value":{"code":"11-13","type":"integration_config.shop_could_not_be_determined","message":"shop could not be determined"}}}}}}}}},"/checkout/shop/{shop_identifier}/zones/{zone_id}/tax_zone_settings":{"parameters":[{"$ref":"#/components/parameters/shop_identifier"},{"$ref":"#/components/parameters/zone_id"}],"post":{"summary":"Create Tax Zone Setting","operationId":"CreateTaxZoneSetting","tags":["Tax Zone Settings"],"description":"Creates or updates a tax zone setting for a tax zone. There can only be one tax zone setting for a tax zone.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxZoneSettingRequest"},"example":{"tax_provider":"override"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TaxZoneSettingConfig"}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"},"examples":{"Missing Request Data":{"value":{"errors":[{"code":"02-50","type":"tax_zone_setting.invalid_tax_zone_setting_data","message":"The tax_provider field is required."}]}},"Invalid Zone ID":{"value":{"errors":[{"code":"02-38","type":"tax_zone_setting.zone_not_found","message":"No zone found with id 282."}]}}}}}}}},"delete":{"summary":"Delete Tax Zone Settings","operationId":"DeleteTaxZoneSetting","tags":["Tax Zone Settings"],"description":"Deletes a tax zone setting for a tax zone.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object"}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"},"examples":{"Missing Request Data":{"value":{"errors":[{"code":"02-50","type":"tax_zone_setting.invalid_tax_zone_setting_data","message":"The `zone_id` field must be of type Integer."}]}}}}}}}}},"/checkout/shop/{shop_identifier}/zones/tax_zone_settings":{"parameters":[{"$ref":"#/components/parameters/shop_identifier"}],"get":{"summary":"Get Tax Zone Settings","operationId":"GetTaxZoneSetting","tags":["Tax Zone Settings"],"description":"Lists all tax zone settings for a shop.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"tax_zone_settings":{"type":"array","items":{"$ref":"#/components/schemas/TaxZoneSettingConfig"}}}}}}}}}}}},"/checkout/shop/{shop_identifier}/zones/{zone_id}/warehouses":{"parameters":[{"$ref":"#/components/parameters/shop_identifier"},{"$ref":"#/components/parameters/zone_id"}],"post":{"summary":"Create Warehouse","operationId":"CreateWarehouse","tags":["Warehouses"],"description":"Adds a warehouse to a given shop. Each warehouse must belong to an existing warehouse zone, and a zone can have only one warehouse. Refer to [Create Zone](checkout-admin#operation/CreateZone).","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WarehouseRequest"},"example":{"address":"123 Main St.","address2":"c/o Buck Skaggstein","city":"American Fork","province_code":"UT","province":"Utah","country_code":"US","country":"United States","postal_code":"84003","extended_postal_code":"52"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/WarehouseConfig"}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"},"examples":{"Invalid Zone ID":{"value":{"errors":[{"code":"02-37","type":"zone.zone_not_found","message":"No zone found with id 282."}]}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"},"examples":{"Missing Request Data":{"value":{"errors":[{"code":"02-50","type":"warehouse.invalid_warehouse_data","message":"The address field is required."},{"code":"02-50","type":"warehouse.invalid_warehouse_data","message":"The postal_code field is required."}]}},"Warehouse Already Exists":{"value":{"errors":[{"code":"02-39","type":"warehouse.warehouse_already_exists","message":"A warehouse already exists for this zone. Please delete it before creating a new one.","details":{"warehouse":{"$ref":"#/components/schemas/WarehouseConfig"}}}]}}}}}}}},"patch":{"summary":"Update Warehouse","operationId":"UpdateWarehouse","tags":["Warehouses"],"description":"Updates a warehouse.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WarehouseUpdateRequest"},"example":{"address":"123 Main St.","address2":"c/o Buck Skaggstein","city":"American Fork","province_code":"UT","province":"Utah","country_code":"US","country":"United States","postal_code":"84003","extended_postal_code":"52"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/WarehouseConfig"}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"},"examples":{"Invalid Zone ID":{"value":{"errors":[{"code":"02-37","type":"zone.zone_not_found","message":"No zone found with id 282."}]}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"},"examples":{"Invalid Address":{"value":{"errors":[{"code":"02-50","type":"warehouse.invalid_warehouse_data","message":"The `address` field must be of type String."}]}}}}}}}},"delete":{"summary":"Delete Warehouse","operationId":"DeleteWarehouse","tags":["Warehouses"],"description":"Deletes a warehouse.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object"}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"},"examples":{"Invalid Zone ID":{"value":{"errors":[{"code":"02-37","type":"zone.zone_not_found","message":"No zone found with id 282."}]}}}}}}}}},"/checkout/shop/{shop_identifier}/zones/warehouses":{"parameters":[{"$ref":"#/components/parameters/shop_identifier"}],"get":{"summary":"List Warehouses","operationId":"GetWarehouses","tags":["Warehouses"],"description":"Lists all warehouses for a given shop.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"warehouses":{"type":"array","items":{"$ref":"#/components/schemas/WarehouseConfig"}}}}}}}}}}}},"/checkout/shop/{shop_identifier}/webhooks":{"parameters":[{"$ref":"#/components/parameters/shop_identifier"}],"post":{"summary":"Create Webhook","operationId":"CreateWebhook","tags":["Webhooks"],"description":"Create a webhook registration by specifying the destination URL and topic.\\n\\nFor more information on Checkout webhooks, refer to [Register for Webhooks](/guides/checkout/webhooks#register-for-the-webhook).","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/WebhookConfig"}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorV2"},"examples":{"TopicIDDoesNotExist":{"value":{"code":"10-10","type":"webhook_subscriptions.webhook_topic_id does not exist","message":"webhook_topic_id does not exist.","details":{}}},"MissingRequiredField":{"value":{"message":"The callback_url field is required.","type":"webhook_subscriptions","severity":"validation","field":"callback_url","sub_type":""}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"webhook_topic_id":{"$ref":"#/components/schemas/WebhookTopicID"},"callback_url":{"$ref":"#/components/schemas/CallbackURL"}},"required":["webhook_topic_id","callback_url"]}}}},"callbacks":{"ProcessedOrder":{"{$request.body#/callback_url/order/processed}":{"post":{"summary":"Processed Order","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProcessedOrderWebhook"},"example":{"value":{"domain":"store-vwd2342klmsdf.mybigcommerce.com","platform_domain":"example.mybigcommerce.com","application_state":{"customer":{"accepts_marketing":true,"email_address":"john.doe@example.com","first_name":"John","last_name":"Doe","platform_id":"50942578465125","public_id":"pjpTyGh8KzNQ225wPqxgy7LwNuC887h6ecGyp3omwT4XW8SszjVSdHzWHN4NBwqhA","saved_addresses":[]},"addresses":{"shipping":{"id":"123","first_name":"John","last_name":"Doe","address_line_1":"50 Fultz Blvd","address_line_2":"Suite 200","country":"Canada","city":"Winnipeg","province":"Manitoba","country_code":"CA","province_code":"MB","postal_code":"R3Y0L6","business_name":"Acme Inc.","phone_number":"8005550101"},"billing":{"id":"123","first_name":"John","last_name":"Doe","address_line_1":"50 Fultz Blvd","address_line_2":"Suite 200","country":"Canada","city":"Winnipeg","province":"Manitoba","country_code":"CA","province_code":"MB","postal_code":"R3Y0L6","business_name":"Acme Inc.","phone_number":"8005550101"}},"line_items":[{"product_data":{"id":"724bca","product_title":"Oak Cheese Grater","title":"Small","image_url":"http://shop.images/oakcheesegrater","properties":{"property1":"string","property2":"string"},"description":"A handmade oak cheese grater to elevate your cheese-eating experience.","quantity":2,"price":2350,"total_price":4700,"visible":1,"line_item_key":"oak_cheese_grater_2643","barcode":"1234ABC","compare_at_price":4000,"weight":1000,"weight_unit":"g","product_id":"oak-cheese-grater","variant_id":"oak-cheese-grater-small","requires_shipping":true,"sku":"OAK_GRATER_SM","taxable":true,"tags":"Kitchen, Cheese Board, Oak","vendor":"Cheese Boards Unlimited","total_weight":2000}},{"taxes":[{"value":1000,"name":"GST","is_included":true}]},{"fees":[{"amount":500,"name":"Miscellaneous fee."}]},{"discounts":[{"code":"SUMMER5","text":"Summer discount code","value":500,"source":"coupon"}]},{"fulfilled_quantity":2}],"fees":[{"id":"123456789","line_text":"Custom Fee \u2014 Added by Plugin","fee_type":"fixed","value":10,"source":"PLUGIN","plugin_uuid":"a52589f8-09df-11ed-b30e-f67072e164ee","taxable":true,"show_description":true}],"taxes":[{"value":1000,"name":"GST","is_included":true}],"discounts":[{"code":"SUMMER5","text":"Summer discount code","value":500,"source":"coupon"}],"payments":[{"gateway_public_id":"i7z2xT0sKrDvhGWzex5SLjf5e6ndlQfrRL4AROkfhf3vNBkVT38JKBy5PSjB63qW","amount":4700,"currency":"CAD","type":"spreedly","display_string":"Credit Card Payment","id":"","token":"7uZAMRAf80KiEwibsrrM5IB41yU","retain":false}],"order_total":4700,"order_meta_data":{"cart_parameters":{"key":"cp-key1","property1":"A cart param.","property2":"A cart param."},"note_attributes":{"key":"na-key1","property1":"A note attribute.","property2":"A note attribute."},"notes":"A special delivery note.","tags":["order-1"]},"shipping":{"selected_shipping":{"id":"0","description":"Custom weight-based rate: tier 2","amount":450,"code":"EXPID"},"available_shipping_lines":[{"id":"string","line":{"id":"0","description":"Custom weight-based rate: tier 2","amount":450,"code":"EXPID"}}],"taxes":[{"value":1000,"name":"GST","is_included":true}],"discounts":[{"code":"SUMMER5","text":"Summer discount code","value":500,"source":"coupon"}]},"resumable_link":"string","flow_id":"external-company-one-page-template","currency":{"iso_code":"CAD","iso_numeric_code":124,"symbol":"$","format":"${{amount}}","has_decimal":true,"show_iso_code":true},"created_via":"My_Order_Creating_Plugin","is_processed":false,"order_id":79047599,"platform_order_id":"1389wjfalsdf9y4r"},"public_order_id":"4U2bwe9SAQY039WGUKM5b2KoxKUKcgyLNvuEKB03Z2HzWbjYB1n4MoC7HuhLT45M","order_id":829,"platform_order_id":"","platform_friendly_identifier":"","order_source":"e3b37c97-8544-4fee-b8f3-cf33deb28be5","order_source_name":"api_v2","fulfillment_status":"unfulfilled","fulfillment_data":[]}}}}},"responses":{"200":{"description":"Successful operation"}}}}},"CreatedOrder":{"{$request.body#/callback_url/order/created}":{"post":{"summary":"Created Order","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatedOrderWebhook"},"example":{"value":{"domain":"store-vwd2342klmsdf.mybigcommerce.com","platform_domain":"example.mybigcommerce.com","application_state":{"customer":{"accepts_marketing":true,"email_address":"john.doe@example.com","first_name":"John","last_name":"Doe","platform_id":"50942578465125","public_id":"pjpTyGh8KzNQ225wPqxgy7LwNuC887h6ecGyp3omwT4XW8SszjVSdHzWHN4NBwqhA","saved_addresses":[]},"addresses":{"shipping":{"id":"123","first_name":"John","last_name":"Doe","address_line_1":"50 Fultz Blvd","address_line_2":"Suite 200","country":"Canada","city":"Winnipeg","province":"Manitoba","country_code":"CA","province_code":"MB","postal_code":"R3Y0L6","business_name":"Acme Inc.","phone_number":"8005550101"},"billing":{"id":"123","first_name":"John","last_name":"Doe","address_line_1":"50 Fultz Blvd","address_line_2":"Suite 200","country":"Canada","city":"Winnipeg","province":"Manitoba","country_code":"CA","province_code":"MB","postal_code":"R3Y0L6","business_name":"Acme Inc.","phone_number":"8005550101"}},"line_items":[{"product_data":{"id":"724bca","product_title":"Oak Cheese Grater","title":"Small","image_url":"http://shop.images/oakcheesegrater","properties":{"property1":"string","property2":"string"},"description":"A handmade oak cheese grater to elevate your cheese-eating experience.","quantity":2,"price":2350,"total_price":4700,"visible":1,"line_item_key":"oak_cheese_grater_2643","barcode":"1234ABC","compare_at_price":4000,"weight":1000,"weight_unit":"g","product_id":"oak-cheese-grater","variant_id":"oak-cheese-grater-small","requires_shipping":true,"sku":"OAK_GRATER_SM","taxable":true,"tags":"Kitchen, Cheese Board, Oak","vendor":"Cheese Boards Unlimited","total_weight":2000}},{"taxes":[{"value":1000,"name":"GST","is_included":true}]},{"fees":[{"amount":500,"name":"Miscellaneous fee."}]},{"discounts":[{"code":"SUMMER5","text":"Summer discount code","value":500,"source":"coupon"}]},{"fulfilled_quantity":2}],"fees":[{"id":"123456789","line_text":"Custom Fee \u2014 Added by Plugin","fee_type":"fixed","value":10,"source":"PLUGIN","plugin_uuid":"a52589f8-09df-11ed-b30e-f67072e164ee","taxable":true,"show_description":true}],"taxes":[{"value":1000,"name":"GST","is_included":true}],"discounts":[{"code":"SUMMER5","text":"Summer discount code","value":500,"source":"coupon"}],"payments":[{"gateway_public_id":"i7z2xT0sKrDvhGWzex5SLjf5e6ndlQfrRL4AROkfhf3vNBkVT38JKBy5PSjB63qW","amount":4700,"currency":"CAD","type":"spreedly","display_string":"Credit Card Payment","id":"","token":"7uZAMRAf80KiEwibsrrM5IB41yU","retain":false}],"order_total":4700,"order_meta_data":{"cart_parameters":{"key":"cp-key1","property1":"A cart param.","property2":"A cart param."},"note_attributes":{"key":"na-key1","property1":"A note attribute.","property2":"A note attribute."},"notes":"A special delivery note.","tags":["order-1"]},"shipping":{"selected_shipping":{"id":"0","description":"Custom weight-based rate: tier 2","amount":450,"code":"EXPID"},"available_shipping_lines":[{"id":"string","line":{"id":"0","description":"Custom weight-based rate: tier 2","amount":450,"code":"EXPID"}}],"taxes":[{"value":1000,"name":"GST","is_included":true}],"discounts":[{"code":"SUMMER5","text":"Summer discount code","value":500,"source":"coupon"}]},"resumable_link":"string","flow_id":"external-company-one-page-template","currency":{"iso_code":"CAD","iso_numeric_code":124,"symbol":"$","format":"${{amount}}","has_decimal":true,"show_iso_code":true},"created_via":"My_Order_Creating_Plugin","is_processed":false,"order_id":79047599,"platform_order_id":"1389wjfalsdf9y4r"},"public_order_id":"4U2bwe9SAQY039WGUKM5b2KoxKUKcgyLNvuEKB03Z2HzWbjYB1n4MoC7HuhLT45M","order_id":829,"platform_order_id":"179","platform_friendly_identifier":"179","order_source":"e3b37c97-8544-4fee-b8f3-cf33deb45be5","order_source_name":"api_v2","fulfillment_status":"unfulfilled","fulfillment_data":[]}}}}},"responses":{"200":{"description":"Successful operation"}}}}},"FulfilledOrder":{"{$request.body#/callback_url/order/fulfilled}":{"post":{"summary":"Fulfilled Order","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FulfilledOrderWebhook"},"example":{"value":{"domain":"store-vwd2342klmsdf.mybigcommerce.com","platform_domain":"example.mybigcommerce.com","application_state":{"customer":{"accepts_marketing":true,"email_address":"john.doe@example.com","first_name":"John","last_name":"Doe","platform_id":"50942578465125","public_id":"pjpTyGh8KzNQ225wPqxgy7LwNuC887h6ecGyp3omwT4XW8SszjVSdHzWHN4NBwqhA","saved_addresses":[]},"addresses":{"shipping":{"id":"123","first_name":"John","last_name":"Doe","address_line_1":"50 Fultz Blvd","address_line_2":"Suite 200","country":"Canada","city":"Winnipeg","province":"Manitoba","country_code":"CA","province_code":"MB","postal_code":"R3Y0L6","business_name":"Acme Inc.","phone_number":"8005550101"},"billing":{"id":"123","first_name":"John","last_name":"Doe","address_line_1":"50 Fultz Blvd","address_line_2":"Suite 200","country":"Canada","city":"Winnipeg","province":"Manitoba","country_code":"CA","province_code":"MB","postal_code":"R3Y0L6","business_name":"Acme Inc.","phone_number":"8005550101"}},"line_items":[{"product_data":{"id":"724bca","product_title":"Oak Cheese Grater","title":"Small","image_url":"http://shop.images/oakcheesegrater","properties":{"property1":"string","property2":"string"},"description":"A handmade oak cheese grater to elevate your cheese-eating experience.","quantity":2,"price":2350,"total_price":4700,"visible":1,"line_item_key":"oak_cheese_grater_2643","barcode":"1234ABC","compare_at_price":4000,"weight":1000,"weight_unit":"g","product_id":"oak-cheese-grater","variant_id":"oak-cheese-grater-small","requires_shipping":true,"sku":"OAK_GRATER_SM","taxable":true,"tags":"Kitchen, Cheese Board, Oak","vendor":"Cheese Boards Unlimited","total_weight":2000}},{"taxes":[{"value":1000,"name":"GST","is_included":true}]},{"fees":[{"amount":500,"name":"Miscellaneous fee."}]},{"discounts":[{"code":"SUMMER5","text":"Summer discount code","value":500,"source":"coupon"}]},{"fulfilled_quantity":2}],"fees":[{"id":"123456789","line_text":"Custom Fee \u2014 Added by Plugin","fee_type":"fixed","value":10,"source":"PLUGIN","plugin_uuid":"a52589f8-09df-11ed-b30e-f67072e164ee","taxable":true,"show_description":true}],"taxes":[{"value":1000,"name":"GST","is_included":true}],"discounts":[{"code":"SUMMER5","text":"Summer discount code","value":500,"source":"coupon"}],"payments":[{"gateway_public_id":"i7z2xT0sKrDvhGWzex5SLjf5e6ndlQfrRL4AROkfhf3vNBkVT38JKBy5PSjB63qW","amount":4700,"currency":"CAD","type":"spreedly","display_string":"Credit Card Payment","id":"","token":"7uZAMRAf80KiEwibsrrM5IB41yU","retain":false}],"order_total":4700,"order_meta_data":{"cart_parameters":{"key":"cp-key1","property1":"A cart param.","property2":"A cart param."},"note_attributes":{"key":"na-key1","property1":"A note attribute.","property2":"A note attribute."},"notes":"A special delivery note.","tags":["order-1"]},"shipping":{"selected_shipping":{"id":"0","description":"Custom weight-based rate: tier 2","amount":450,"code":"EXPID"},"available_shipping_lines":[{"id":"string","line":{"id":"0","description":"Custom weight-based rate: tier 2","amount":450,"code":"EXPID"}}],"taxes":[{"value":1000,"name":"GST","is_included":true}],"discounts":[{"code":"SUMMER5","text":"Summer discount code","value":500,"source":"coupon"}]},"resumable_link":"string","flow_id":"external-company-one-page-template","currency":{"iso_code":"CAD","iso_numeric_code":124,"symbol":"$","format":"${{amount}}","has_decimal":true,"show_iso_code":true},"created_via":"My_Order_Creating_Plugin","is_processed":false,"order_id":79047599,"platform_order_id":"1389wjfalsdf9y4r"},"public_order_id":"4U2bwe9SAQY039WGUKM5b2KoxKUKcgyLNvuEKB03Z2HzWbjYB1n4MoC7HuhLT45M","order_id":829,"platform_order_id":"179","platform_friendly_identifier":"179","order_source":"e3b37c97-8544-4fee-b8f3-cf33deb45be5","order_source_name":"api_v2","fulfillment_status":"fulfilled","fulfillment_data":{"total_value":17,"total_shipping_value":10,"shipping_details":[],"tracking_company":"ups","tracking_number":"sJKfh72hKD7djh","tracking_url":"https://www.ups.com/example-tracking-links","location_id":-3,"fulfilled_at":"2022-01-04 19:52:16","fulfilled_items":[],"total_discount":12,"total_fees":4,"order_fees":[],"total_order_fees":13,"total_tax":5}}}}}},"responses":{"200":{"description":"Successful operation"}}}}},"FailedOrder":{"{$request.body#/callback_url/order/failed}":{"post":{"summary":"Failed Order","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FailedOrderWebhook"},"example":{"value":{"domain":"store-vwd2342klmsdf.mybigcommerce.com","platform_domain":"example.mybigcommerce.com","application_state":{"customer":{"accepts_marketing":true,"email_address":"john.doe@example.com","first_name":"John","last_name":"Doe","platform_id":"50942578465125","public_id":"pjpTyGh8KzNQ225wPqxgy7LwNuC887h6ecGyp3omwT4XW8SszjVSdHzWHN4NBwqhA","saved_addresses":[]},"addresses":{"shipping":{"id":"123","first_name":"John","last_name":"Doe","address_line_1":"50 Fultz Blvd","address_line_2":"Suite 200","country":"Canada","city":"Winnipeg","province":"Manitoba","country_code":"CA","province_code":"MB","postal_code":"R3Y0L6","business_name":"Acme Inc.","phone_number":"8005550101"},"billing":{"id":"123","first_name":"John","last_name":"Doe","address_line_1":"50 Fultz Blvd","address_line_2":"Suite 200","country":"Canada","city":"Winnipeg","province":"Manitoba","country_code":"CA","province_code":"MB","postal_code":"R3Y0L6","business_name":"Acme Inc.","phone_number":"8005550101"}},"line_items":[{"product_data":{"id":"724bca","product_title":"Oak Cheese Grater","title":"Small","image_url":"http://shop.images/oakcheesegrater","properties":{"property1":"string","property2":"string"},"description":"A handmade oak cheese grater to elevate your cheese-eating experience.","quantity":2,"price":2350,"total_price":4700,"visible":1,"line_item_key":"oak_cheese_grater_2643","barcode":"1234ABC","compare_at_price":4000,"weight":1000,"weight_unit":"g","product_id":"oak-cheese-grater","variant_id":"oak-cheese-grater-small","requires_shipping":true,"sku":"OAK_GRATER_SM","taxable":true,"tags":"Kitchen, Cheese Board, Oak","vendor":"Cheese Boards Unlimited","total_weight":2000}},{"taxes":[{"value":1000,"name":"GST","is_included":true}]},{"fees":[{"amount":500,"name":"Miscellaneous fee."}]},{"discounts":[{"code":"SUMMER5","text":"Summer discount code","value":500,"source":"coupon"}]},{"fulfilled_quantity":2}],"fees":[{"id":"123456789","line_text":"Custom Fee \u2014 Added by Plugin","fee_type":"fixed","value":10,"source":"PLUGIN","plugin_uuid":"a52589f8-09df-11ed-b30e-f67072e164ee","taxable":true,"show_description":true}],"taxes":[{"value":1000,"name":"GST","is_included":true}],"discounts":[{"code":"SUMMER5","text":"Summer discount code","value":500,"source":"coupon"}],"payments":[{"gateway_public_id":"i7z2xT0sKrDvhGWzex5SLjf5e6ndlQfrRL4AROkfhf3vNBkVT38JKBy5PSjB63qW","amount":4700,"currency":"CAD","type":"spreedly","display_string":"Credit Card Payment","id":"","token":"7uZAMRAf80KiEwibsrrM5IB41yU","retain":false}],"order_total":4700,"order_meta_data":{"cart_parameters":{"key":"cp-key1","property1":"A cart param.","property2":"A cart param."},"note_attributes":{"key":"na-key1","property1":"A note attribute.","property2":"A note attribute."},"notes":"A special delivery note.","tags":["order-1"]},"shipping":{"selected_shipping":{"id":"0","description":"Custom weight-based rate: tier 2","amount":450,"code":"EXPID"},"available_shipping_lines":[{"id":"string","line":{"id":"0","description":"Custom weight-based rate: tier 2","amount":450,"code":"EXPID"}}],"taxes":[{"value":1000,"name":"GST","is_included":true}],"discounts":[{"code":"SUMMER5","text":"Summer discount code","value":500,"source":"coupon"}]},"resumable_link":"string","flow_id":"external-company-one-page-template","currency":{"iso_code":"CAD","iso_numeric_code":124,"symbol":"$","format":"${{amount}}","has_decimal":true,"show_iso_code":true},"created_via":"My_Order_Creating_Plugin","is_processed":false,"order_id":79047599,"platform_order_id":"1389wjfalsdf9y4r"},"public_order_id":"4U2bwe9SAQY039WGUKM5b2KoxKUKcgyLNvuEKB03Z2HzWbjYB1n4MoC7HuhLT45M","order_id":829,"platform_order_id":"179","platform_friendly_identifier":"179","order_source":"e3b37c97-8544-4fee-b8f3-cf33deb45be5","order_source_name":"api_v2","fulfillment_status":"unfulfilled","fulfillment_data":[]}}}}},"responses":{"200":{"description":"Successful operation"}}}}},"AbandonedOrder":{"{$request.body#/callback_url/order/abandoned}":{"post":{"summary":"Abandoned Order","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AbandonedOrderWebhook"},"example":{"value":{"public_order_id":"nPTPIlIahDoEgZFabZNNvg7uxahLkGb1x4UINz3eqYV3eHewsjq7kubZc5BLAUqC","line_items":{"discounts":[],"fees":[],"product_data":{"barcode":"1234ABC","compare_at_price":4000,"description":"A handmade oak cheese grater to elevate your cheese-eating experience.","id":"724bca","image_url":"http://shop.images/oakcheesegrater","line_item_key":"ABC123","price":2350,"product_id":"oak-cheese-grater","properties":[],"quantity":2,"requires_shipping":true,"sku":"OAK_GRATER_SM","tags":"Kitchen, Cheese Board, Oak","taxable":true,"title":"Small","total_price":4700,"variant_id":"oak-cheese-grater-small","vendor":"Cheese Boards Unlimited","visible":1,"weight":1000,"weight_unit":"g"},"taxes":[]},"customer":{"accepts_marketing":true,"email_address":"john.doe@example.com","first_name":"John","last_name":"Doe","platform_id":null,"public_id":"sTaGXlJuMIz1fzdnE8HSXkK1m2ym9FRbrwxqiS2t7XylVEMBT7YX1Xeep6V7cT53","saved_addresses":[]},"order_meta_data":{"cart_parameters":{"ca-key1":"Some kind of cart parameter."},"note_attributes":{"na-key1":"Some kind of note attributes."},"notes":"Some kind of special delivery note.","tags":["tag-1"]},"resumable_link":"https://checkout.example.com/resume","shop":{"domain":"store-vwd2342klmsdf.mybigcommerce.com","platform_domain":"example.mybigcommerce.com"}}}}}},"responses":{"200":{"description":"Successful operation"}}}}},"GiftCardCreated":{"{$request.body#/callback_url/gift_card/created}":{"post":{"summary":"Gift Card Created","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GiftCardCreatedWebhook"},"example":{"value":{"domain":"store-vwd2342klmsdf.mybigcommerce.com","platform_domain":"example.mybigcommerce.com","public_order_id":"4U2bwe9SAQY039WGUKM5b2KoxKUKcgyLNvuEKB03Z2HzWbjYB1n4MoC7HuhLT45M","platform_order_id":179,"platform_customer_id":null,"customer":{"email":"john.doe@example.com","first_name":"John","last_name":"Doe"},"gift_card_email":"john.doe@example.com","gift_card_token":"TYIDFASDFOCXOMT","gift_card_key":"107","gift_card_amount":2500}}}}},"responses":{"200":{"description":"Successful operation"}}}}}}},"get":{"summary":"List Webhooks","operationId":"ListWebhooks","tags":["Webhooks"],"description":"Retrieves a list of registered webhooks.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"Results","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/WebhookConfig"},"minItems":1,"uniqueItems":true}}},{"type":"array","title":"No Results","minItems":0,"maxItems":0,"items":{}}]},"examples":{"example-1":{"value":{"data":[{"webhook_topic_id":1,"webhook_topic_name":"order/created","callback_url":"https://my-app.com/webhooks/order/created","created_at":"2022-11-23 17:11:06","updated_at":"2022-11-23 17:11:06"},{"webhook_topic_id":4,"webhook_topic_name":"order/failed","callback_url":"https://my-app.com/webhooks/order/failed","created_at":"2022-11-23 17:11:06","updated_at":"2022-11-23 17:11:06"}]}}}}}}}}},"/checkout/shop/{shop_identifier}/webhooks/{webhook_topic_id}":{"parameters":[{"$ref":"#/components/parameters/shop_identifier"},{"schema":{"type":"string"},"name":"webhook_topic_id","in":"path","required":true,"description":"The webhook topic id."}],"put":{"summary":"Update Webhook","operationId":"UpdateWebhook","tags":["Webhooks"],"description":"Updates the webhook callback URL. Webhook topics cannot be updated.\\n\\nLearn more about updating webhooks in the [Webhooks guide](/guides/checkout/webhooks#update-or-delete-webhooks).","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/WebhookConfig"}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"example-1":{"value":{"message":"The callback url field is required.","type":"webhook_subscriptions","field":"callback_url","severity":"validation","sub_type":""}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"callback_url":{"$ref":"#/components/schemas/CallbackURL"}},"required":["callback_url"]},"examples":{"example-1":{"value":{"callback_url":"https://my-app.com/webhooks/different_callback_url"}}}}}}},"delete":{"summary":"Delete Webhook","operationId":"DeleteWebhook","tags":["Webhooks"],"description":"Removes an existing webhook.\\n\\nLearn more about removing webhooks in the [Webhooks guide](/guides/checkout/webhooks#update-or-delete-webhooks).","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","minItems":0,"maxItems":0,"items":{}}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"example-1":{"value":{"message":"The webhook topic id field is required.","type":"webhook_subscriptions","field":"webhook_topic_id","severity":"validation","sub_type":""}}}}}}}}},"/checkout/shop/{shop_identifier}/webhooks/topics":{"parameters":[{"$ref":"#/components/parameters/shop_identifier"}],"get":{"summary":"List Webhook Topics","operationId":"ListWebhookTopics","tags":["Webhooks"],"description":"Gets the list of available webhook topics.\\n\\nPossible webhook topics from Checkout Backend API are:\\n- `order/processed`\\n- `order/created`\\n- `order/fulfilled`\\n- `order/abandoned`\\n- `order/failed`\\n- `gift_card/created`\\n\\nRead about webhook topics in the [Webhook Topics guide](/guides/checkout/webhooks#get-a-list-of-webhook-topics).","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","description":"A list of available webhook topics.","items":{"$ref":"#/components/schemas/WebhookTopic"},"minItems":0,"uniqueItems":true,"example":[{"webhook_topic_id":1,"webhook_topic_name":"order/created"},{"webhook_topic_id":2,"webhook_topic_name":"order/processed"},{"webhook_topic_id":3,"webhook_topic_name":"order/fulfilled"}]}}}}}}}}},"/checkout/shop/{shop_identifier}/zones":{"parameters":[{"$ref":"#/components/parameters/shop_identifier"}],"post":{"summary":"Create Zone","operationId":"CreateZone","tags":["Zones"],"description":"Adds a warehouse, shipping, or tax zone.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ZoneRequest"},"example":{"name":"Western Region","type":"warehouse","regions":[{"country_code":"CA","province_code":"MB"},{"country_code":"CA","province_CODE":"SK"}]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ZoneConfig"}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"},"examples":{"Missing Request Data":{"value":{"errors":[{"code":"02-50","type":"zone.invalid_zone_data","message":"The name field is required."}]}},"Invalid Zone Type":{"value":{"errors":[{"code":"02-50","type":"zone.invalid_zone_data","message":"The type field must be one the following values: shipping, tax, warehouse"}]}},"Invalid Region Data":{"value":{"errors":[{"code":"02-37","type":"zone.country_not_found_by_code","message":"Zone not created: invalid country code(s) [ZZ,YQ]"},{"code":"02-37","type":"zone.province_not_found_by_code","message":"Zone not created: invalid province code(s) [H3,PL]"}]}},"Default Zone Exists":{"value":{"errors":[{"code":"02-37","type":"zone.default_zone_already_exists","message":"Unable to create default zone: Default zone already exists"}]}},"Region Already Exists":{"value":{"errors":[{"code":"02-37","type":"zone.region_already_exists","message":"The zone CountryId: 4, ProvinceId: 7, ZoneTypeId:  1  already exists in another zone for this shop","details":{"zone_id":"279,","country_code":"CA","province_code":"MB"}}]}}}}}}}},"get":{"summary":"List Zones","operationId":"GetZone","tags":["Zones"],"description":"Lists all zones for a shop.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"zones":{"type":"array","items":{"$ref":"#/components/schemas/ZoneConfig"}}}}}}}}}}}},"/checkout/shop/{shop_identifier}/zones/{zone_id}":{"parameters":[{"$ref":"#/components/parameters/shop_identifier"},{"$ref":"#/components/parameters/zone_id"}],"patch":{"summary":"Update Zone","operationId":"UpdateZone","tags":["Zones"],"description":"Updates an existing zone. Note that it is not possible to update an existing zone\'s `type`.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ZoneUpdateRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ZoneConfig"}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"},"examples":{"Zone Not Found":{"value":{"errors":[{"code":"02-37","type":"zone.zone_not_found","message":"Zone not found."}]}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"},"examples":{"Missing Request Data":{"value":{"errors":[{"code":"02-50","type":"zone.invalid_zone_data","message":"The zone_id field is required."}]}},"Prohibited Request Data":{"value":{"errors":[{"code":"02-50","type":"zone.invalid_zone_data","message":"The type field is not allowed."}]}},"Invalid Region Data":{"value":{"errors":[{"code":"02-37","type":"zone.country_not_found_by_code","message":"Zone not created: invalid country code(s) [ZZ,YQ]"},{"code":"02-37","type":"zone.province_not_found_by_code","message":"Zone not created: invalid province code(s) [H3,PL]"}]}},"Default Zone Exists":{"value":{"errors":[{"code":"02-37","type":"zone.default_zone_already_exists","message":"Unable to create default zone: Default zone already exists"}]}},"Region Already Exists":{"value":{"errors":[{"code":"02-37","type":"zone.region_already_exists","message":"The zone CountryId: 4, ProvinceId: 7, ZoneTypeId: 1 already exists in another zone for this shop","details":{"zone_id":"279,","country_code":"CA","province_code":"MB"}}]}}}}}}}},"delete":{"summary":"Delete Zone","operationId":"DeleteZone","tags":["Zones"],"description":"Deletes an existing zone. Any regions, tax zone settings, and warehouses associated with the zone will also be deleted.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object"}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"},"examples":{"Missing Request Data":{"value":{"errors":[{"code":"02-50","type":"zone.invalid_zone_data","message":"The zone_id field is required."}]}}}}}}}}},"/checkout/shop/{shop_identifier}/general_settings":{"parameters":[{"$ref":"#/components/parameters/shop_identifier"}],"get":{"summary":"Get Shop General Settings","operationId":"GetShopGeneralSettings","tags":["Shops"],"description":"Retrieves basic settings from the shop\'s General Settings section in the [Bold Checkout admin](https://apps.boldapps.net/accounts/app/4).","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/GeneralSettings"}}}}}}}},"put":{"summary":"Update Shop General Settings","operationId":"UpdateShopGeneralSettings","tags":["Shops"],"description":"Updates basic settings from the shop\'s General Settings section in the [Bold Checkout admin](https://apps.boldapps.net/accounts/app/4).","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralSettingsUpdateRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/GeneralSettings"}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"},"examples":{"Prohibited Request Data":{"value":{"errors":[{"code":"02-95","type":"general_settings.invalid_settings_data","message":"The `public order id.enabled` field must be of type Boolean."}]}}}}}}}}},"/checkout/shop/{shop_identifier}/general_settings/phone_number_required":{"parameters":[{"$ref":"#/components/parameters/shop_identifier"}],"put":{"summary":"Update Phone Number Requirement","operationId":"UpdatePhoneNumberRequirement","tags":["Shops"],"description":"Updates the phone number requirement setting for a store. This setting can also be edited from the store\'s **General Settings** section in the [Bold Checkout admin](https://apps.boldapps.net/accounts/app/4).","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PhoneNumberRequiredUpdateRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/GeneralSettings"}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"},"examples":{"Prohibited Request Data":{"value":{"errors":[{"code":"02-95","type":"general_settings.invalid_settings_data","message":"The `phone number required` field must be of type Boolean."}]}}}}}}}}},"/checkout/shop/{shop_identifier}/general_settings/require_inventory_check":{"parameters":[{"$ref":"#/components/parameters/shop_identifier"}],"put":{"summary":"Update Inventory Check Requirement","operationId":"UpdateInventoryCheckRequirement","tags":["Shops"],"description":"Updates the inventory check requirement setting for a store. If required, an inventory check is performed in response to the [Process Order](/api/checkout#tag/Orders/operation/ProcessOrder) endpoint, and the endpoint returns a 422 error if there is not enough inventory to complete the order.\\n\\nThe inventory check is required by default. You can use this endpoint to disable the inventory check requirement during order processing.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequireInventoryCheckUpdateRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/GeneralSettings"}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"},"examples":{"Prohibited Request Data":{"value":{"errors":[{"code":"02-95","type":"general_settings.invalid_settings_data","message":"The `require inventory check` field is required."}]}}}}}}}}},"/checkout/shop/{shop_identifier}/general_settings/create_platform_customer":{"parameters":[{"$ref":"#/components/parameters/shop_identifier"}],"put":{"summary":"Update Platform Customer Creation Setting","operationId":"UpdateCreatePlatformCustomer","tags":["Shops"],"description":"Updates the platform customer creation setting for a store. On many platforms, whenever Bold creates a new order, it also creates a new customer if it does not already exist on the platform. Some platforms, such as Adobe Commerce, do not behave this way natively, and attempting to create a customer during order creation can cause unexpected errors. Updating this setting to `false` prevents Bold from attempting to create a customer on the platform when a new order is created.\\n\\nThis setting defaults to `true`.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePlatformCustomerUpdateRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/GeneralSettings"}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"},"examples":{"Prohibited Request Data":{"value":{"errors":[{"code":"02-95","type":"general_settings.invalid_settings_data","message":"The `create platform customer` field is required."}]}}}}}}}}},"/checkout/shop/{shop_identifier}/pmmc_session":{"parameters":[{"$ref":"#/components/parameters/shop_identifier"},{"$ref":"#/components/parameters/platform_customer_id"},{"$ref":"#/components/parameters/bold_customer_id"}],"get":{"summary":"Get PMMC Session","operationId":"GetPmmcSession","tags":["Shops"],"description":"Retrieves a Payment Method Management for Checkout (PMMC) session. Use this endpoint to retrieve the information necessary to load the `<iframe>` that enables an authenticated customer to edit their saved payment methods.\\n\\nInclude the either the customer\'s `bold_customer_id` or `platform_customer_id` as a query parameter to retrieve their payment method information.\\n\\nRefer to the [PMMC Guide](/guides/checkout/pmmc) for more information about using this information to load the PMMC `<iframe>` for the customer.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PmmcSession"}}}}}}}}},"/checkout/shop/{shop_identifier}/payment_css":{"parameters":[{"$ref":"#/components/parameters/shop_identifier"}],"get":{"summary":"Get Shop Payment Styling","operationId":"GetShopPaymentStyling","tags":["Payment CSS"],"description":"Gets the CSS styling that is currently applied to the SPI iframe.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"style_sheet":{"$ref":"#/components/schemas/PaymentStylesheet"}}}}}}}},"401":{"description":"Authorization error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthorizationError"}}}},"404":{"description":"No Styles Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorV2"},"example":{"code":"90","type":"payment_method_style_sheet.not_found","message":"There are no CSS styles for the shop payment iframes"}}}},"422":{"description":"Unprocessable request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"500":{"$ref":"#/components/responses/UnknownError"}}},"post":{"summary":"Create Shop Payment Styling","operationId":"CreateShopPaymentStyling","tags":["Payment CSS"],"description":"Create and apply a series of CSS rules and media rules to the SPI iframe. Using this endpoint applies these changes to all orders placed in the checkout.\\n\\nNote that if you are using [Bold-hosted checkout](/guides/checkout/concepts/flows#types-of-flows), these settings will be overridden by any changes to the CSS in the Bold Checkout Admin. Refer to [Style the Checkout with CSS](/guides/checkout/css) for more information.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentStylesheet"}}}},"responses":{"200":{"description":"CSS added successfully","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PaymentStylesheet"}}}}}},"401":{"description":"Authorization error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthorizationError"}}}},"422":{"description":"Unprocessable request. Returned if the `data`, `style_sheet`, `css_rules`, or `media_rules` fields are not present in the request body, or if the supplied css is not valid and cannot be parsed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}}}},"delete":{"summary":"Delete Shop Payment Styling","operationId":"DeleteShopPaymentStyling","tags":["Payment CSS"],"description":"Removes all styling from the SPI iframe.","responses":{"200":{"description":"Success"},"401":{"description":"Authorization error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthorizationError"}}}}}}}},"components":{"securitySchemes":{"OAuthToken":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://apps.boldapps.net/accounts/dashboard/authorize","tokenUrl":"https://api.boldcommerce.com/auth/oauth2/token","scopes":{}}},"description":"Authenticates an API request from a [public integration](/default/guides/checkout/resources/glossary#public-integration). Generate this token in the [Developer Dashboard](https://developer-dashboard.boldcommerce.com/dashboard). Refer to [Build Public Integrations](/default/guides/checkout/public-integrations) for more information."},"APIAccessToken":{"type":"apiKey","name":"API Access Token","in":"header","description":"Authenticates an API request from a [private integration](/guides/checkout/resources/glossary#private-integration). Generate this token in the [Bold Account Center](https://account.boldcommerce.com/). Refer to [Making API Calls](/guides/checkout/quick-start) for more information."}},"schemas":{"AuthorizationError":{"description":"An error with the authorization of the API access token.","type":"object","properties":{"error":{"type":"string","description":"The type of error.","example":"invalid_token"},"error_description":{"type":"string","description":"A phrase describing what went wrong.","example":"The access token is invalid or has expired"}}},"PaymentStylesheet":{"type":"object","description":"The CSS media queries to apply to the SPI iframe.","properties":{"css_rules":{"type":"array","description":"A set of CSS rules to be applied to the SPI iframe.","items":{"type":"object","properties":{"cssText":{"type":"string","description":"String of CSS styles, specifying the target elements, to be applied to the SPI iframe.","example":".ToggleField { color:red; }"}}}},"media_rules":{"type":"array","description":"A set of media queries to be applied to the SPI iframe.","items":{"type":"object","properties":{"conditionText":{"type":"string","description":"The media conditional text. Must not include \\"@media\\" in the string.","example":"screen and (max-height: 600px)"},"cssRules":{"type":"array","description":"A set of CSS rules to be applied when the media condition is met.","items":{"type":"object","properties":{"cssText":{"type":"string","description":"The CSS rule.","example":".ToggleField__Text { color:blue; }"}}}}}}}}},"CORSDomain":{"type":"string","description":"A domain used to call the Bold Checkout APIs. The string must consist of a fully qualified domain name (FQDN) and the protocol used to access it.","example":"https://dev-store.example.com"},"CORSDomainList":{"type":"object","description":"A list of the domains that are approved to call Bold Checkout APIs.","properties":{"id":{"type":"number","description":"The identifier for the domain in the allowlist.","example":1},"domain":{"$ref":"#/components/schemas/CORSDomain"}}},"Errors":{"title":"Errors","type":"object","properties":{"errors":{"type":"array","items":{"title":"Error","type":"object","minItems":0,"properties":{"code":{"type":"string","description":"Numeric error code to explicitly group errors together. Checkout errors are typically in the format `02-XX`, where XX is another two-digit number.","example":"02-00"},"type":{"type":"string","description":"Textual error code to explicitly group errors together. Checkout errors typically contain multiple descriptors in snake_case separated by dots `.`.","example":"checkout.unexpected_error"},"message":{"type":"string","description":"Human-readable description of the error.","example":"Something went wrong. Please try again later."},"details":{"type":"object","description":"Optional additional details to add context to the error."}},"required":["code","type","message"]}}}},"ErrorsV1":{"title":"Errors","type":"object","properties":{"errors":{"type":"array","items":{"title":"Error","type":"object","minItems":0,"properties":{"message":{"type":"string","description":"An error message describing what went wrong."},"type":{"type":"string","description":"The type of error that occurred."},"field":{"type":"string","description":"The field of the object that the error was found in."},"severity":{"type":"string","description":"The severity of the error."},"sub_type":{"type":"string","description":"The sub_type of the error."}}}}}},"LiFE_element":{"title":"LiFE Element","description":"A configurable, custom element in the checkout experience.","properties":{"public_id":{"type":"string","description":"The Bold-generated identifier of the LiFE element.","example":"VfYRxzOjRkwG6B2xWbxhPQ","readOnly":true},"location":{"type":"string","description":"The location where the LiFE element will be rendered. For more information about possible element locations, refer to the [Checkout LiFE guide](/guides/checkout/life).","example":"customer_info","enum":["customer_info","shipping","billing_address_after","shipping_lines","below_actions","summary_above_header","payment_gateway","thank_you_message","order_confirmation","order_details","main_content_beginning","main_content_end","payment_method_above","paypal_additional_information"]},"input_type":{"type":"string","description":"The input type of the LiFE element.","example":"text","enum":["text","checkbox","html","textarea","dropdown","datepicker"]},"input_default":{"type":"string","description":"The default input. The behavior of this field depends on the `input_type`:\\n  - `text` or `textarea`: Set this value to your chosen string. The shopper deletes the `input_default` and adds their own value.\\n  - `checkbox`: Set this value to `\\"true\\"` to make the checkbox automatically selected.\\n  - `html`: Set this value to the HTML you would like the element to display.\\n  - `dropdown`: Set the value to a comma-separated string of the options you would like the element to display.\\n  - `datepicker`: Set the value to a date string with the format of `YYYY/MM/DD`. If the `input_default` is not set, the date picker defaults to the current date.","example":"initial value","nullable":true},"input_label":{"type":"string","description":"If the element requires shopper input, this is the label for the input.","example":"Shipping notes","nullable":true},"input_placeholder":{"type":"string","description":"The input placeholder value of the LiFE element. The behavior of this field depends on the `input_type`:\\n  - `text` or `textarea`: This value appears in the input field and disappears when the shopper begins typing.\\n  - `checkbox`: This value appears below the `input_label`.\\n  - `dropdown`: This value appears in the drop-down box before it is expanded.\\n  - `datepicker`: This value appears in the input field and disappears when the shopper selects a date.","example":"Shipping notes here","nullable":true},"input_required":{"type":"boolean","description":"Indicates whether input from the shopper is required.","example":true,"nullable":true},"input_regex":{"type":"string","description":"The regular expression that validates the input for `text` and `textarea` elements.","example":"[0-9]{4}","nullable":true},"meta_data_field":{"type":"string","description":"The metadata key from the order\'s `application_state` that will be used to store the user\'s entered value.","example":"shipping_notes"},"order_asc":{"type":"integer","description":"The index of the element. If multiple elements appear in one location, this value indicates the order in which they appear.","example":1}},"required":["location","meta_data_field","input_type","input_required","order_asc"]},"ExternalPaymentGateway":{"title":"External Payment Gateway","description":"A configurable, external payment gateway for accepting payments through Bold checkout.","type":"object","properties":{"public_id":{"type":"string","description":"The Identifier of the external payment gateway resource.","example":"VfYRxzOjRkwG6B2xWbxhPQ","readOnly":true},"shop_id":{"type":"integer","description":"The identifier of the shop associated to the external payment gateway.","example":42,"readOnly":true},"name":{"type":"string","description":"The name of the external payment gateway resource.","example":"External Payment Gateway"},"base_url":{"type":"string","description":"The base URL that Checkout calls when performing payment operations.","example":"www.example.com/payments"},"iframe_url":{"type":"string","description":"The URL to be embedded into the payment iframe.","example":"www.example.com/gateway","nullable":true},"location":{"type":"string","description":"The location during checkout that the payment `iframe` will be rendered.","example":"payment_method_below","nullable":false},"http_headers":{"type":"array","description":"An array of headers to add to requests to `base_url`.","items":{"title":"Key Value Pair","minItems":0,"type":"object","properties":{"key":{"type":"string","description":"The header name.","example":"foo"},"value":{"type":"string","description":"The header value.","example":"bar"}},"required":["key","value"]}},"api_token":{"type":"string","description":"An API token associated with the external payment gateway, defined by the sender. If provided, Bold includes this token in the authentication header when sending requests to this external payment gateway. For more information, refer to [Verify requests from Bold Checkout](/guides/checkout/checkout-epg-guide#verify-requests-from-bold-checkout).","example":"XjqnSQWYAZXt","nullable":true},"partial_capture":{"type":"boolean","description":"If true, the external payment gateway supports partial payment captures.","example":true},"additional_order_details":{"type":"boolean","description":"If true, additional metadata can be included on payments added to orders.","example":true},"provider_id":{"type":"string","description":"The identifier, generated by the external payment gateway, that Checkout sends in payment-related requests to the gateway.\\n\\nThe identifier must be a unique value for each store that installs the external payment gateway.","example":"8ad85ccf-7fd6-4f4b-a1a2-dff42fb3e228"},"currency":{"type":"string","description":"The currency supported by the external payment gateway, in [ISO-4217](https://www.iso.org/iso-4217-currency-codes.html) format.","example":"CAD","minLength":3,"maxLength":3}},"required":["name","base_url","partial_capture","additional_order_details","provider_id","currency"]},"OverrideConfig":{"title":"API override configuration","description":"Encapsulates the set of data defining a Checkout API override.","type":"object","properties":{"public_id":{"$ref":"#/components/schemas/OverrideID"},"override_type":{"$ref":"#/components/schemas/OverrideType"},"url":{"$ref":"#/components/schemas/OverrideURL"},"created_at":{"$ref":"#/components/schemas/OverrideCreation"},"updated_at":{"$ref":"#/components/schemas/OverrideUpdate"}}},"OverrideCreation":{"type":"string","readOnly":true,"description":"The time at which this API override was created.","example":"2021-11-17 21:03:36"},"OverrideID":{"type":"string","readOnly":true,"description":"The unique identifier for this API override.","example":"1"},"OverrideRequest":{"title":"API override request","description":"The information about an API override required to create or update an override","type":"object","properties":{"override_type":{"$ref":"#/components/schemas/OverrideType"},"url":{"$ref":"#/components/schemas/OverrideURL"},"shared_secret":{"$ref":"#/components/schemas/OverrideSharedSecret"}},"required":["override_type","url","shared_secret"]},"OverrideSharedSecret":{"type":"string","description":"Your shared secret, a random string of sufficient length. Bold uses this string and the current date to create a signature for each override request.","minLength":8,"maxLength":255,"example":"aq9834g4aqkdwa0"},"OverrideType":{"type":"string","enum":["address_validate","shipping","discount","inventory","tax"],"description":"The Checkout functionality that is overridden by this API override.","example":"discount"},"OverrideUpdate":{"type":"string","readOnly":true,"description":"The time at which this API override was last changed. Defaults to the created date when no changes have yet been made.","example":"2021-11-17 21:03:36"},"OverrideURL":{"type":"string","description":"The destination URL at which a request will be made when functionality relating to this `override_type` is triggered in Checkout.","example":"https://example.com/overrides/callback_url"},"PmmcSession":{"title":"PMMC Session","type":"object","description":"The customer information required to load a PMMC iframe.","properties":{"proxy_session_id":{"type":"string","description":"A temporary identifier for the PMMC session.","example":"8asefjo8a340"},"signature":{"type":"string","description":"An HMAC to ensure security of the request.","example":"b42af09234bac1e2d41708e48a902e09b5ff7f12ab428a4fe84053c73dd248fb82f948a549f7b791c5b41915ee4d1ec3935357e9e2317250d0372afa2ebeeb3b"},"bold_customer_id":{"type":"string","example":"uqw94joiefrqwo4","description":"A Bold-generated identifier of the customer."}}},"RemoteStateAuthorityConfig":{"title":"Remote State Authority configuration","description":"Encapsulates the set of data defining a Remote State Authority.","type":"object","properties":{"remote_state_authority":{"type":"object","properties":{"url":{"type":"string","description":"The destination URL that is called to contact the Remote State Authority for a shop.","example":"https://example.com/my_remote_state_authority"}},"required":["url"],"nullable":true}},"required":["remote_state_authority"]},"GiftCard":{"title":"Gift Card","description":"The representation of a Gift Card.","type":"object","properties":{"card_token":{"type":"string","description":"The gift card token.","example":"OAVXDVRAJUGFMHEK"},"amount":{"type":"number","description":"The original amount of the gift card, represented in base units of the store\'s currency, using [ISO-4217](https://www.iso.org/iso-4217-currency-codes.html) standards.","example":5000},"balance":{"type":"number","description":"The remaining usable amount of the gift card, represented in base units of the store\'s currency, using [ISO-4217](https://www.iso.org/iso-4217-currency-codes.html) standards.","example":2575},"recipient_name":{"type":"string","nullable":true,"description":"The name of the gift card\'s recipient.","example":"John"},"recipient_email":{"type":"string","description":"The email of the gift card\'s recipient.","example":"john.smith@example.com"},"message":{"type":"string","nullable":true,"description":"An optional message from the purchaser of the gift card to the recipient.","example":"Enjoy this gift certificate from us."},"expiry_date":{"type":"string","nullable":true,"description":"The date after which the gift card may no longer be used. If `expiry_date` is `null`, the gift card can used indefinitely until it has no balance remaining.","example":"2025-04-01"},"customer_name":{"type":"string","nullable":true,"description":"The name of the gift card\'s purchaser or issuer.","example":"Jane"},"customer_email":{"type":"string","description":"The email of the gift card\'s purchaser or issuer.","example":"jane.doe@example.com"}}},"TaxZoneSettingRequest":{"type":"object","properties":{"tax_provider":{"type":"string","enum":["custom","bold","avalara","taxjar","vertex","override"],"description":"The tax provider for the tax zone. If you intend to use a tax override for the shop, set this value to `override`.","example":"override"}},"required":["tax_provider"]},"TaxZoneSettingConfig":{"title":"Tax zone configuration","description":"Encapsulates the tax provider for a tax zone.","type":"object","properties":{"zone_id":{"type":"number","description":"The ID of the zone to which this setting applies.","example":42},"tax_provider":{"type":"string","enum":["custom","bold","avalara","taxjar","vertex","override"],"description":"The tax provider for the tax zone.","example":"override"}}},"WarehouseRequest":{"title":"Warehouse configuration","description":"Encapsulates the physical address of a warehouse.","type":"object","properties":{"address":{"type":"string","description":"The street address of the warehouse.","example":"123 Main St."},"address2":{"type":"string","description":"An additional address line.","example":"c/o Buck Skaggstein","nullable":true},"city":{"type":"string","description":"The city of the warehouse.","example":"American Fork"},"province_code":{"type":"string","description":"The [ISO-3166](https://www.iso.org/iso-3166-country-codes.html) two-letter state or province code of the warehouse.","example":"UT","nullable":true},"province":{"type":"string","description":"The state or province of the warehouse.","example":"Utah","nullable":true},"country_code":{"type":"string","description":"The [ISO-3166](https://www.iso.org/iso-3166-country-codes.html) two-letter country code of the warehouse.","example":"US"},"country":{"type":"string","description":"The country of the warehouse.","example":"United States"},"postal_code":{"type":"string","description":"The postal code or zip code of the warehouse.","example":"84003"},"extended_postal_code":{"type":"string","description":"Additional postal code data.","example":"52","nullable":true}},"required":["address","city","country_code","country","postal_code"]},"WarehouseUpdateRequest":{"title":"Warehouse update request","description":"Encapsulates the physical address of a warehouse.","type":"object","properties":{"address":{"type":"string","description":"The street address of the warehouse.","example":"123 Main St."},"address2":{"type":"string","description":"An additional address line.","example":"c/o Buck Skaggstein","nullable":true},"city":{"type":"string","description":"The city of the warehouse.","example":"American Fork"},"province_code":{"type":"string","description":"The [ISO-3166](https://www.iso.org/iso-3166-country-codes.html) two-letter state or province code of the warehouse.","example":"UT","nullable":true},"province":{"type":"string","description":"The state or province of the warehouse.","example":"Utah","nullable":true},"country_code":{"type":"string","description":"The [ISO-3166](https://www.iso.org/iso-3166-country-codes.html) two-letter country code of the warehouse.","example":"US"},"country":{"type":"string","description":"The country of the warehouse.","example":"United States"},"postal_code":{"type":"string","description":"The postal code or zip code of the warehouse.","example":"84003"},"extended_postal_code":{"type":"string","description":"Additional postal code data.","example":"52","nullable":true}}},"WarehouseConfig":{"title":"Warehouse configuration","description":"Encapsulates the physical address of a warehouse.","type":"object","properties":{"address":{"type":"string","description":"The street address of the warehouse.","example":"123 Main St."},"address2":{"type":"string","description":"An additional address line.","example":"c/o Buck Skaggstein","nullable":true},"city":{"type":"string","description":"The city of the warehouse.","example":"American Fork"},"province_code":{"type":"string","description":"The [ISO-3166](https://www.iso.org/iso-3166-country-codes.html) two-letter state or province code of the warehouse.","example":"UT","nullable":true},"province":{"type":"string","description":"The state or province of the warehouse.","example":"Utah","nullable":true},"country_code":{"type":"string","description":"The [ISO-3166](https://www.iso.org/iso-3166-country-codes.html) two-letter country code of the warehouse.","example":"US"},"country":{"type":"string","description":"The country of the warehouse.","example":"United States"},"postal_code":{"type":"string","description":"The postal code or zip code of the warehouse.","example":"84003"},"extended_postal_code":{"type":"string","description":"Additional postal code data.","example":"52","nullable":true},"zone_id":{"type":"number","description":"The Bold-generated ID of the zone associated with this warehouse.","example":283}}},"ZoneRequest":{"title":"Zone request","description":"Encapsulates a zone containing one or more geographic regions.","type":"object","properties":{"name":{"type":"string","description":"A user-friendly name for the zone.","example":"Western Region"},"type":{"type":"string","enum":["shipping","tax","warehouse"],"description":"The type of zone to create.","example":"warehouse"},"default":{"type":"boolean","description":"Whether this zone should be used in the absence of any other applicable zone. There may only be one default zone for each zone type.","default":false,"example":true},"enabled":{"type":"boolean","description":"Whether this zone can be used during Checkout.","default":true,"example":false},"regions":{"type":"array","description":"An array of regions encompassed by this zone.","items":{"title":"Regions","minItems":0,"type":"object","properties":{"country_code":{"type":"string","description":"The [ISO-3166](https://www.iso.org/iso-3166-country-codes.html) two-letter country code of the region.","example":"CA"},"province_code":{"type":"string","description":"The [ISO-3166](https://www.iso.org/iso-3166-country-codes.html) two-letter state or province code of the region. This field may be omitted for countries with no such subdivisions.","example":"MB"}},"required":["country_code"]}}},"required":["type","name","regions"]},"ZoneUpdateRequest":{"title":"Zone update request","description":"Changes to make to one or more of a zone\'s properties.","type":"object","properties":{"name":{"type":"string","description":"A user-friendly name for the zone.","example":"Western Region"},"default":{"type":"boolean","description":"Whether this zone should be used if no other zone is applicable. There may only be one default zone for each zone type.","default":false,"example":true},"enabled":{"type":"boolean","description":"Whether this zone can be used during checkout.","default":true,"example":false},"regions":{"type":"array","description":"An array of regions encompassed by this zone.","items":{"title":"Regions","minItems":0,"type":"object","properties":{"country_code":{"type":"string","description":"The two-letter country code of the country, using [ISO-3166](https://www.iso.org/iso-3166-country-codes.html) format.","example":"CA"},"province_code":{"type":"string","description":"The [ISO-3166](https://www.iso.org/iso-3166-country-codes.html) two-letter state or province code of the region. This field may be omitted for countries with no such subdivisions.","example":"MB"}},"required":["country_code"]}}},"required":["zone_id"]},"ZoneConfig":{"title":"Zone configuration","description":"Encapsulates a zone containing multiple geographic regions.","type":"object","properties":{"id":{"type":"number","description":"A unique identifier for the zone.","example":283},"name":{"type":"string","description":"A user-friendly name for the zone.","example":"Western Region"},"type":{"type":"string","enum":["shipping","tax","warehouse"],"description":"The type of zone created.","example":"warehouse"},"default":{"type":"boolean","description":"Whether this zone should be used in the absence of any other applicable zone.","example":false},"enabled":{"type":"boolean","description":"Whether this zone can be used during Checkout.","example":true},"regions":{"type":"array","description":"An array of regions encompassed by this zone.","items":{"title":"Regions","properties":{"country_code":{"type":"string","description":"The [ISO-3166](https://www.iso.org/iso-3166-country-codes.html) two-letter country code of the region.","example":"CA"},"province_code":{"type":"string","description":"The [ISO-3166](https://www.iso.org/iso-3166-country-codes.html) two-letter state or province code of the region.","example":"MB","nullable":true}}}}}},"LineItemKey":{"title":"LineItemKey","type":"string","description":"A merchant-defined, unique identifier serving to refer to this line throughout Bold Checkout.","example":"oak_cheese_grater_2643"},"GiftCardProperties":{"title":"Gift Card Properties","type":"object","properties":{"recipient_name":{"type":"string","description":"The name of the person receiving the gift card.","example":"John Doe"},"recipient_email":{"type":"string","description":"The email address of the person receiving gift card.","example":"john.doe@example.com"},"message":{"type":"string","description":"A personalized message field the buyer can attach to the gift card. Value is `\\"\\"` if created from an order.","example":"Dear John, Happy Birthday!"},"custom_amount":{"type":"string","description":"If included, the price of this particular line item in the checkout order will be overwritten by this value. It is written in base units, using [ISO-4217](https://www.iso.org/iso-4217-currency-codes.html) standards.","example":"2450"}}},"LineItem":{"title":"Line Item","type":"object","properties":{"id":{"type":"string","description":"An internal-only string that Bold uses to identify line items.","example":"724bca"},"product_title":{"type":"string","description":"The name of the product.","example":"Oak Cheese Grater"},"title":{"type":"string","description":"The name of the product variant.","example":"Small"},"image_url":{"type":"string","description":"The URL for the image of the variant that is displayed on the storefront.","example":"http://shop.images/oakcheesegrater"},"properties":{"description":"Any additional properties of the line item. Line Items can also be Gift Cards, which have specific and unique properties. See the \\"Gift card properties\\" example in `line_items` arrays.","anyOf":[{"type":"object","title":"Additional Properties","additionalProperties":{"type":"string"}},{"$ref":"#/components/schemas/GiftCardProperties"},{"type":"array","title":"No properties","maxItems":0,"items":{}}]},"description":{"type":"string","description":"A description of the product.","example":"A handmade oak cheese grater to elevate your cheese-eating experience."},"quantity":{"type":"integer","description":"The quantity of the line item on the order.","example":2},"price":{"type":"number","description":"The price of one unit of the line item, using cents/base currency units, using [ISO-4217](https://www.iso.org/iso-4217-currency-codes.html) standards.","example":2350},"total_price":{"type":"number","description":"The total price of all units of the line item, presented in cents/base currency units, using [ISO-4217](https://www.iso.org/iso-4217-currency-codes.html) standards.","example":4700},"visible":{"type":"integer","description":"Indicates whether the item is visible on the storefront. Hard-coded to `1` to indicate `true`.","example":1},"line_item_key":{"$ref":"#/components/schemas/LineItemKey"},"barcode":{"type":"string","description":"The barcode for the line item.","example":"1234ABC"},"compare_at_price":{"type":"number","description":"An optional price displayed on the product page to indicate the discount taken.","nullable":true,"example":4000},"weight":{"type":"integer","description":"The weight of one unit of the line item, measured in `weight_unit`.","example":1000},"weight_unit":{"type":"string","description":"The unit in which to measure the line item weight.","example":"g"},"product_id":{"type":"string","description":"A platform-defined identifier for the product on this line item.","example":"oak-cheese-grater"},"variant_id":{"oneOf":[{"type":"string"},{"type":"number"}],"description":"A platform-defined identifier for the product variant on this line item.","example":"oak-cheese-grater-small"},"requires_shipping":{"type":"boolean","description":"Indicates whether the item must be shipped.","example":true},"sku":{"type":"string","description":"A merchant-defined stock-keeping unit of the line item.","example":"OAK_GRATER_SM"},"taxable":{"type":"boolean","description":"Indicates whether the line item is taxable.","example":true},"tags":{"type":"string","description":"Any tags attached to the line item.","example":"Kitchen, Cheese Board, Oak"},"vendor":{"type":"string","description":"The vendor that supplied the line item.","example":"Cheese Boards Unlimited"},"total_weight":{"type":"integer","description":"The total weight of all units of this line item.","example":2000}}},"Discount":{"title":"Discount","type":"object","description":"A discount, which can be applied either to an individual line item or the order as a whole.","properties":{"code":{"type":"string","description":"The user-facing discount code name.","example":"SUMMER5"},"text":{"type":"string","description":"A description of the discount, which is displayed on the platform.","example":"Summer discount code"},"value":{"type":"number","example":500,"description":"The value of the discount applied, represented in base currency units, using [ISO-4217](https://www.iso.org/iso-4217-currency-codes.html) standards."},"source":{"type":"string","description":"The source of the discount code. Possible values are:\\n  - `\\"cart\\"` discount created from plugin actions [DISCOUNT_CART](/guides/checkout/references/plugin-actions#discount_cart) and/or [DISCOUNT_LINE_ITEMS](/guides/checkout/references/plugin-actions#discount_line_items)\\n  - `\\"coupon\\"` discount created in the [Bold Checkout admin](https://apps.boldapps.net/accounts/app/4).","example":"coupon"}}},"OrderMetaData":{"title":"Order Metadata","type":"object","description":"Additional information about an order. Metadata can be used as data proxy that Checkout will act upon. It can also be used to include extra information about an order and included when pushed to the platform.","properties":{"cart_parameters":{"description":"Extra information about an order that Checkout can act upon.","oneOf":[{"type":"object","title":"Cart parameters","properties":{"key":{"type":"string","example":"cp-key1"}},"additionalProperties":{"type":"string","example":"A cart param."}},{"type":"array","title":"No cart parameters","maxItems":0,"items":{}}]},"note_attributes":{"description":"Extra information added to the order and pushed to the platform.","oneOf":[{"type":"object","title":"Note attributes","properties":{"key":{"type":"string","example":"na-key1"}},"additionalProperties":{"type":"string","example":"A note attribute."}},{"type":"array","title":"No note attributes","maxItems":0,"items":{}}]},"notes":{"type":"string","description":"Notes that can be attached to the order.","example":"A special delivery note."},"tags":{"type":"array","description":"Tags attached to the order.","items":{"type":"string","example":"order-1"}}}},"LineItemFee":{"title":"Fee","type":"object","description":"An additional fee to be added to the line item.","properties":{"amount":{"type":"number","description":"The fee amount, represented in cents/base currency units, using [ISO-4217](https://www.iso.org/iso-4217-currency-codes.html) standards.","example":500},"name":{"type":"string","description":"A description of the fee.","example":"Miscellaneous fee."}}},"GeneralFee":{"title":"GeneralFee","type":"object","properties":{"id":{"type":"string","description":"A unique identifier for this fee, used in the [`remove_fee`](/guides/checkout/references/plugin-actions#remove_fee) plugin action.","example":"123456789"},"line_text":{"type":"string","description":"A user-defined identifier serving to be displayed in any user interfaces.","example":"Custom Fee \u2014 Added by Plugin"},"fee_type":{"type":"string","description":"The type of the fee, \\"fixed\\" or \\"percentage\\".","example":"fixed"},"value":{"type":"integer","description":"The fee amount, represented in base currency units, using [ISO-4217](https://www.iso.org/iso-4217-currency-codes.html) standards.","example":10},"source":{"type":"string","description":"The method in which the fee was added to the order, typically through the `add_fee` plugin action.","example":"PLUGIN"},"plugin_uuid":{"type":"string","description":"The identifier of the plugin which added the fee to the order. This field is omitted if the fee source was not a plugin.","example":"a52589f8-09df-11ed-b30e-f67072e164ee"},"taxable":{"type":"boolean","description":"Indicates whether the fee should be included in the calculation of taxes.","example":true},"show_description":{"type":"boolean","description":"Indicates whether to show the fee description. Always set to `true` for fees added by plugin.","example":true}}},"Currency":{"type":"object","description":"The currency that the order was completed in.","properties":{"iso_code":{"type":"string","description":"The currency code, using [ISO-4217](https://www.iso.org/iso-4217-currency-codes.html) standards.","example":"CAD"},"iso_numeric_code":{"type":"integer","description":"The numeric currency code, using [ISO-4217](https://www.iso.org/iso-4217-currency-codes.html) standards.","example":124},"symbol":{"type":"string","description":"The symbol associated with the currency.","example":"$"},"format":{"type":"string","description":"The format of the currency, including the symbol and the amount.","example":"${{amount}}"},"has_decimal":{"type":"boolean","description":"Indicates whether the currency uses a decimal.","example":true},"show_iso_code":{"type":"boolean","description":"Indicates whether to show the ISO code alongside the order total on the storefront.","example":true}}},"DisplayCurrency":{"type":"object","description":"The currency that the order was displayed to the user.","properties":{"iso_code":{"type":"string","description":"The currency code, using [ISO-4217](https://www.iso.org/iso-4217-currency-codes.html) standards.","example":"USD"},"iso_numeric_code":{"type":"integer","description":"The numeric currency code, using [ISO-4217](https://www.iso.org/iso-4217-currency-codes.html) standards.","example":840},"symbol":{"type":"string","description":"The symbol associated with the currency.","example":"$"},"format":{"type":"string","description":"The format of the currency, including the symbol and the amount.","example":"${{amount}}"},"has_decimal":{"type":"boolean","description":"Indicates whether the currency uses a decimal.","example":true},"show_iso_code":{"type":"boolean","description":"Indicates whether to show the ISO code alongside the order total on the storefront.","example":true}}},"DisplayExchangeRate":{"type":"number","description":"The rate of exchange between the currency on the order and the display currency.","example":1.357251},"PublicOrderId":{"title":"Public Order ID","type":"string","description":"The public order identifier generated when the order is initialized by making a request to the [Initialize Order](orders#operation/InitializeOrder) endpoint.","example":"nPTPIlIahDoEgZFabZNNvg7uxahLkGb1x4UINz3eqYV3eHewsjq7kubZc5BLAUqC"},"ApplicationState":{"title":"Application State","type":"object","description":"Represents the current state of the order.\\nTaxes and discounts represent the summation of all tax or discount lines that have been applied anywhere through the order. Consulting the line items allows you to get the specific product break down of taxes and discounts.","properties":{"customer":{"description":"The customer that placed the order.","oneOf":[{"$ref":"#/components/schemas/Customer"},{"type":"array","title":"No customer","maxItems":0,"items":{}}]},"addresses":{"type":"object","description":"The billing and shipping addresses on the order.","properties":{"shipping":{"description":"The shipping address on the order.","oneOf":[{"$ref":"#/components/schemas/Address"},{"type":"array","title":"No address","maxItems":0,"items":{}}]},"billing":{"description":"The billing address on the order.","oneOf":[{"$ref":"#/components/schemas/Address"},{"type":"array","title":"No address","maxItems":0,"items":{}}]}}},"line_items":{"type":"array","description":"The list of line items associated with an order. Each line item includes information about the selected product and the taxes, fees, and discounts applied to it.","items":{"type":"object","properties":{"product_data":{"$ref":"#/components/schemas/LineItem"},"taxes":{"type":"array","description":"Any taxes that apply to the line item.","items":{"$ref":"#/components/schemas/Tax"}},"fees":{"type":"array","description":"Any fees that apply to the line item.","items":{"$ref":"#/components/schemas/LineItemFee"}},"discounts":{"type":"array","description":"Any discounts that apply to the line item.","items":{"$ref":"#/components/schemas/Discount"}},"fulfilled_quantity":{"type":"integer","description":"The quantity of the line item that has been fulfilled. Fulfill a line item using the [Update Line Item](orders#operation/UpdateLineItem) endpoint.","example":2}}}},"fees":{"type":"array","description":"Any fees that apply to the full order.","items":{"$ref":"#/components/schemas/GeneralFee"}},"taxes":{"type":"array","description":"Any taxes that apply to the full order.","items":{"$ref":"#/components/schemas/Tax"}},"discounts":{"type":"array","description":"Any discounts that apply to the full order.","items":{"$ref":"#/components/schemas/Discount"}},"payments":{"type":"array","description":"The payments applied to the order.","items":{"$ref":"#/components/schemas/Payment"}},"order_total":{"type":"number","description":"The total amount of the order (after tax, shipping, and discounts) using cents/base currency units using [ISO-4217](https://www.iso.org/iso-4217-currency-codes.html) standards.","example":4700},"order_meta_data":{"$ref":"#/components/schemas/OrderMetaData"},"shipping":{"type":"object","description":"The shipping information \u2014 including shipping lines, taxes, and discounts \u2014 associated with an order.","properties":{"selected_shipping":{"$ref":"#/components/schemas/ShippingLine"},"available_shipping_lines":{"type":"array","description":"The shipping lines available for the order.","items":{"type":"object","properties":{"id":{"type":"string"},"line":{"$ref":"#/components/schemas/ShippingLine"}}}},"taxes":{"description":"Any taxes that apply to the shipping rate.","oneOf":[{"type":"array","items":{"$ref":"#/components/schemas/Tax"}},{"type":"number"}]},"discounts":{"description":"Any discounts that apply to the shipping rate.","oneOf":[{"type":"array","items":{"$ref":"#/components/schemas/Discount"}},{"type":"number"}]}}},"resumable_link":{"$ref":"#/components/schemas/ResumableLink"},"flow_id":{"type":"string","nullable":true,"description":"The identifier of the origin checkout flow used to create the order. If left empty, defaults to `null` and is displayed as \\"Unassigned\\" in the Checkout admin.","example":"external-company-one-page-template"},"currency":{"$ref":"#/components/schemas/Currency"},"display_currency":{"$ref":"#/components/schemas/DisplayCurrency"},"display_exchange_rate":{"$ref":"#/components/schemas/DisplayExchangeRate"},"created_via":{"type":"string","description":"The source of the order. Plugin developers can use the [Set Order Created By](/guides/checkout/references/plugin-actions#set_order_created_by) action to set this field and indicate that an order was created by their plugin. If the order was created as normal through Bold Checkout, this value is `\\"checkout\\"`.","example":"My_Order_Creating_Plugin"},"is_processed":{"type":"boolean","description":"Indicates whether the order has been processed.","example":false},"order_id":{"type":"number","description":"Bold Checkout\'s internal order ID.","example":79047599},"platform_order_id":{"type":"string","nullable":true,"description":"A platform-generated identifier for the order.","example":"1389wjfalsdf9y4r"}}},"Customer":{"title":"Customer","type":"object","description":"An authenticated or guest customer associated with an order.","properties":{"platform_id":{"type":"string","description":"The platform identifier for an authenticated customer. For guest customers, the value for this property will be null.","nullable":true,"example":"50942578465125"},"public_id":{"type":"string","description":"The public identifier generated by Checkout for a customer.","nullable":true,"readOnly":true,"example":"pjpTyGh8KzNQ225wPqxgy7LwNuC887h6ecGyp3omwT4XW8SszjVSdHzWHN4NBwqhA"},"first_name":{"type":"string","description":"The first name of the customer.","example":"John"},"last_name":{"type":"string","description":"The last name of the customer.","example":"Doe"},"email_address":{"type":"string","description":"The email address of the customer.","example":"john.doe@example.com"},"accepts_marketing":{"type":"boolean","description":"If the customer would like to receive any sort of marketing emails. Defaults to `false`.","example":true},"saved_addresses":{"type":"array","description":"The saved addresses of an authenticated customer stored from the platform.","items":{"$ref":"#/components/schemas/Address"}}},"required":["email_address"]},"Address":{"title":"Address","description":"A shipping or billing address.","type":"object","nullable":true,"properties":{"id":{"type":"string","description":"A unique identifier of the address.","nullable":true,"readOnly":true,"example":"123"},"first_name":{"type":"string","description":"The first name of the addressee.","example":"John"},"last_name":{"type":"string","description":"The last name of the addressee.","example":"Doe"},"address_line_1":{"type":"string","description":"The street address.","example":"50 Fultz Blvd"},"address_line_2":{"type":"string","description":"Any additional street address details (apt #, suite #, etc).","example":"Suite 200"},"country":{"type":"string","description":"The country name.","example":"Canada"},"city":{"type":"string","description":"The city name.","example":"Winnipeg"},"province":{"type":"string","description":"The province or state name, if applicable.","example":"Manitoba"},"country_code":{"type":"string","description":"The country code, in [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) format.","example":"CA"},"province_code":{"type":"string","description":"The province or state code, in [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) format, if applicable.","example":"MB"},"postal_code":{"type":"string","description":"The postal/zip code. Required for most countries, including the United States, Canada, and Mexico. Validated on format only when provided.","example":"R3Y0L6"},"business_name":{"type":"string","description":"If applicable, the business name.","example":"Acme Inc."},"phone_number":{"type":"string","description":"The phone number of the addressee.","example":"8005550101"}},"required":["country","country_code"]},"ShippingLine":{"title":"Shipping Line","type":"object","nullable":true,"properties":{"id":{"type":"string","description":"The index of the shipping line.","example":"0"},"description":{"type":"string","description":"A description of the shipping line.","example":"Custom weight-based rate: tier 2"},"amount":{"type":"number","description":"The shipping amount represented in cents/base currency units using [ISO-4217](https://www.iso.org/iso-4217-currency-codes.html) standards.","example":450},"code":{"type":"string","description":"An identifier assigned to the shipping rate by the shipping provider.","example":"EXPID"}}},"Payment":{"title":"Payment","type":"object","properties":{"gateway_public_id":{"type":"string","description":"A public identifier of the payment gateway used with the payment.","example":"i7z2xT0sKrDvhGWzex5SLjf5e6ndlQfrRL4AROkfhf3vNBkVT38JKBy5PSjB63qW"},"amount":{"type":"number","description":"The payment amount, represented in cents/base currency units, using [ISO-4217](https://www.iso.org/iso-4217-currency-codes.html) standards.","example":4700},"currency":{"type":"string","description":"The currency of the payment, using [ISO-4217](https://www.iso.org/iso-4217-currency-codes.html) standards.","example":"CAD"},"type":{"type":"string","description":"The payment gateway that accepted the payment.","example":"spreedly"},"display_string":{"type":"string","description":"A description of the payment to visually display to the customer.","example":"Credit Card Payment"},"id":{"type":"string","readOnly":true,"description":"An identifier of the payment.","example":""},"token":{"type":"string","description":"A token generated by the payment gateway to identify the payment.","example":"7uZAMRAf80KiEwibsrrM5IB41yU"},"retain":{"type":"boolean","description":"Indicates whether the payment method will be saved for future orders. Checkout only stores a tokenized version of the payment method.","default":false,"example":false}},"required":["gateway_public_id","token"]},"Error":{"title":"error","type":"object","properties":{"message":{"type":"string","description":"The message for the error.","example":"The first name field is required."},"type":{"type":"string","description":"The type of error that occurred.","example":"customer"},"field":{"type":"string","description":"The field of the object that the error was found in.","example":"first_name"},"severity":{"type":"string","description":"The severity of the error.","example":"validation"},"sub_type":{"type":"string","description":"The sub_type of the error.","example":"order"}}},"ErrorV2":{"title":"Error","type":"object","properties":{"code":{"type":"string","description":"The code for the error.","example":"11-13"},"type":{"type":"string","description":"The type of error.","example":"integration_config.shop_could_not_be_determined"},"message":{"type":"string","description":"The message for the error.","example":"shop could not be determined"},"details":{"type":"object","description":"Additional details for the error.","example":{}}}},"UnprocessableEntity":{"description":"There was a problem with the object provided in the request.","type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string","description":"An error message describing what went wrong.","example":"The first name field is required."},"type":{"type":"string","description":"The type of error that occurred.","example":"customer"},"field":{"type":"string","description":"The field of the object that the error was found in.","example":"first_name"},"severity":{"type":"string","description":"The severity of the error.","example":"validation"},"sub_type":{"type":"string","description":"The sub_type of the error.","example":"order"}}}}}},"MetaData":{"title":"Order Metadata","type":"object","description":"Additional information about an order. This information is for the use of the store or integration, so Bold Checkout does not do anything with this metadata. It can also be used to include extra information about an order and included when pushed to the platform.","properties":{"cart_parameters":{"description":"Extra information about an order that Checkout can act upon. Refer to [Cart Parameters](/guides/checkout/concepts/cart-parameters) for more information.","oneOf":[{"type":"object","title":"Cart parameters","description":"Extra information about an order that Checkout can act upon.","properties":{"key":{"type":"string"}},"example":{"ca-key1":"Some kind of cart parameter."}},{"type":"array","title":"No cart parameters","maxItems":0,"minItems":0,"items":{},"example":[]}]},"note_attributes":{"description":"Extra information about the order that is pushed to the platform.","oneOf":[{"type":"object","title":"Note attributes","properties":{"key":{"type":"string"}},"example":{"na-key1":"Some kind of note attributes."}},{"type":"array","title":"No note attributes","maxItems":0,"minItems":0,"items":{},"example":[]}]},"notes":{"type":"string","description":"Notes that can be attached to the order.","example":"Some kind of special delivery note."},"tags":{"type":"array","description":"Tags associated with the order that are pushed to the platform.","items":{"type":"string"},"example":["tag-1"]}}},"ResumableLink":{"type":"string","nullable":true,"description":"A URL used to resume an order. If provided, the default resumable link generated by Checkout will be overwritten with this URL. This resumable link will be provided in the email and webhook for an abandoned checkout.","example":"https://mycheckout.com/resume"},"WebhookConfig":{"title":"Webhook Config","description":"Information about a registered webhook.","allOf":[{"$ref":"#/components/schemas/WebhookTopic"},{"type":"object","properties":{"callback_url":{"type":"string","description":"The URL the webhook payload will be sent to.","example":"https://my-app.com/webhooks/callback_url"},"created_at":{"type":"string","description":"The datetime the webhook was registered.","readOnly":true,"example":"2021-11-17 21:03:36"},"updated_at":{"type":"string","description":"The datetime the webhook was updated.","readOnly":true,"example":"2021-11-17 21:03:36"}}}]},"WebhookTopic":{"title":"Webhook Topic","description":"Information about a webhook topic.","type":"object","properties":{"webhook_topic_id":{"$ref":"#/components/schemas/WebhookTopicID"},"webhook_topic_name":{"$ref":"#/components/schemas/WebhookTopicName"}}},"WebhookTopicID":{"type":"integer","description":"The webhook topic identifier.","example":1},"WebhookTopicName":{"type":"string","description":"The webhook topic name.","example":"order/created"},"CallbackURL":{"type":"string","description":"The URL that the webhook payload will be sent to.","example":"https://my-app.com/webhooks/order/created"},"AbandonedOrderWebhook":{"title":"Abandoned Order","type":"object","description":"Information about an order abandoned during checkout, sent as a callback payload.","properties":{"public_order_id":{"$ref":"#/components/schemas/PublicOrderId"},"line_items":{"type":"array","items":{"$ref":"#/components/schemas/LineItem"}},"customer":{"$ref":"#/components/schemas/Customer"},"order_meta_data":{"$ref":"#/components/schemas/MetaData"},"resumable_link":{"$ref":"#/components/schemas/ResumableLink"},"shop":{"type":"object","properties":{"domain":{"$ref":"#/components/schemas/Domain"},"platform_domain":{"$ref":"#/components/schemas/PlatformDomain"}}}}},"CreatedOrderWebhook":{"title":"Created Order","type":"object","description":"Information about a created order, sent as a callback payload.","properties":{"domain":{"$ref":"#/components/schemas/Domain"},"platform_domain":{"$ref":"#/components/schemas/PlatformDomain"},"application_state":{"$ref":"#/components/schemas/ApplicationState"},"public_order_id":{"$ref":"#/components/schemas/PublicOrderId"},"order_id":{"$ref":"#/components/schemas/OrderId"},"platform_order_id":{"$ref":"#/components/schemas/PlatformOrderId"},"platform_friendly_identifier":{"$ref":"#/components/schemas/PlatformFriendlyId"},"order_source":{"$ref":"#/components/schemas/OrderSource"},"order_source_name":{"$ref":"#/components/schemas/OrderSourceName"},"fulfillment_status":{"$ref":"#/components/schemas/FulfillmentStatus"},"fulfillment_data":{"$ref":"#/components/schemas/FulfillmentData"}}},"ProcessedOrderWebhook":{"title":"Processed Order","type":"object","description":"Information about a processed order, sent as a callback payload.","properties":{"domain":{"$ref":"#/components/schemas/Domain"},"platform_domain":{"$ref":"#/components/schemas/PlatformDomain"},"application_state":{"$ref":"#/components/schemas/ApplicationState"},"public_order_id":{"$ref":"#/components/schemas/PublicOrderId"},"order_id":{"$ref":"#/components/schemas/OrderId"},"platform_order_id":{"$ref":"#/components/schemas/PlatformOrderId"},"platform_friendly_identifier":{"$ref":"#/components/schemas/PlatformFriendlyId"},"order_source":{"$ref":"#/components/schemas/OrderSource"},"order_source_name":{"$ref":"#/components/schemas/OrderSourceName"},"fulfillment_status":{"$ref":"#/components/schemas/FulfillmentStatus"},"fulfillment_data":{"$ref":"#/components/schemas/FulfillmentData"}}},"FulfilledOrderWebhook":{"title":"Fulfilled Order","type":"object","description":"Information about a fulfilled order, sent as a callback payload.","properties":{"domain":{"$ref":"#/components/schemas/Domain"},"platform_domain":{"$ref":"#/components/schemas/PlatformDomain"},"application_state":{"$ref":"#/components/schemas/ApplicationState"},"public_order_id":{"$ref":"#/components/schemas/PublicOrderId"},"order_id":{"$ref":"#/components/schemas/OrderId"},"platform_order_id":{"$ref":"#/components/schemas/PlatformOrderId"},"platform_friendly_identifier":{"$ref":"#/components/schemas/PlatformFriendlyId"},"order_source":{"$ref":"#/components/schemas/OrderSource"},"order_source_name":{"$ref":"#/components/schemas/OrderSourceName"},"fulfillment_status":{"$ref":"#/components/schemas/FulfillmentStatus"},"fulfillment_data":{"$ref":"#/components/schemas/FulfillmentData"}}},"FailedOrderWebhook":{"title":"Failed Order","type":"object","description":"Information about a failed order, sent as a callback payload.","properties":{"domain":{"$ref":"#/components/schemas/Domain"},"platform_domain":{"$ref":"#/components/schemas/PlatformDomain"},"application_state":{"$ref":"#/components/schemas/ApplicationState"},"public_order_id":{"$ref":"#/components/schemas/PublicOrderId"},"order_id":{"$ref":"#/components/schemas/OrderId"},"platform_order_id":{"$ref":"#/components/schemas/PlatformOrderId"},"platform_friendly_identifier":{"$ref":"#/components/schemas/PlatformFriendlyId"},"order_source":{"$ref":"#/components/schemas/OrderSource"},"order_source_name":{"$ref":"#/components/schemas/OrderSourceName"},"fulfillment_status":{"$ref":"#/components/schemas/FulfillmentStatus"},"fulfillment_data":{"$ref":"#/components/schemas/FulfillmentData"}}},"GiftCardCreatedWebhook":{"title":"Gift Card Created","type":"object","description":"Information about a created gift card, sent as a callback payload.","properties":{"domain":{"$ref":"#/components/schemas/Domain"},"platform_domain":{"$ref":"#/components/schemas/PlatformDomain"},"platform_order_id":{"$ref":"#/components/schemas/PlatformOrderId"},"public_order_id":{"$ref":"#/components/schemas/PublicOrderId"},"platform_customer_id":{"$ref":"#/components/schemas/PlatformCustomerId"},"customer":{"$ref":"#/components/schemas/CallbackCustomer"},"gift_card_email":{"$ref":"#/components/schemas/GiftCardEmail"},"gift_card_token":{"$ref":"#/components/schemas/GiftCardToken"},"gift_card_key":{"$ref":"#/components/schemas/GiftCardKey"},"gift_card_amount":{"$ref":"#/components/schemas/GiftCardAmount"}}},"Domain":{"title":"Domain","type":"string","description":"The shop domain.","example":"example.mybigcommerce.com"},"PlatformDomain":{"title":"Platform Domain","type":"string","description":"The platform domain.","example":"store-vwd2342klmsdf.mybigcommerce.com"},"PlatformOrderId":{"title":"Platform Order Id","type":"string","description":"A platform-generated identifier for the order.","example":"1389wjfalsdf9y4r"},"PlatformCustomerId":{"title":"Platform Customer Id","type":"string","description":"A platform-generated identifier for the customer.","example":"179"},"CallbackCustomer":{"title":"Callback Customer","type":"object","description":"Simplified version of Customer object.","properties":{"email_address":{"type":"string","description":"The email address of the customer.","example":"john.doe@example.com"},"first_name":{"type":"string","description":"The first name of the customer.","example":"John"},"last_name":{"type":"string","description":"The last name of the customer.","example":"Doe"}}},"GiftCardEmail":{"title":"Customer Email","type":"string","description":"The email of the customer who bought the gift card.","example":"john.doe@example.com"},"GiftCardToken":{"title":"Gift Card Token","type":"string","description":"The token generated by Bold or the platform when the gift card is created.\\n\\n**Note**: GiveX gift cards have tokens with numbers. Bold gift cards do not.","example":"TYIDFASDFOCXOMT"},"GiftCardKey":{"title":"Gift Card Key","type":"string","description":"A PIN used during checkout with the gift card. Bold gift cards are three-digit numbers, and GiveX gift cards are four-digit numbers.","example":"107"},"GiftCardAmount":{"title":"Gift Card Amount","type":"number","description":"The total amount on the gift card, in the store\'s currency.","example":2500},"OrderId":{"title":"Order Id","type":"integer","description":"Bold Checkout\'s internal order identifier.","example":79047599},"PlatformFriendlyId":{"title":"Platform Friendly Id","type":"string","description":"A platform-generated identifier for the order, unique to the store.","example":"179"},"OrderSource":{"title":"Order Source","type":"string","description":"The source of the order.\\n\\nIf the order was created with the `/init` or `/create` endpoints, the `order_source` is `X-Bold-Proxy-App-Guid`. `X-Bold-Proxy-App-Guid` is a unique uuid() generated and added to the request by Bold.\\n\\nIf not created through `/init` or `/create`, `order_source` is `bold_platform_shop.store_name`.","example":"e3b37c97-8544-4fee-b8f3-cf33deb45be5"},"OrderSourceName":{"title":"Order Source Name","type":"string","description":"The name of the order source. Possible values include `cashier`, `plugin`, and `api_v2`.","example":"api_v2"},"FulfillmentStatus":{"title":"FulfillmentStatus","type":"string","description":"The fulfillment status of the order.","enum":["fulfilled","unfulfilled"],"example":"unfulfilled"},"FulfillmentData":{"title":"Fulfillment Data","type":"object","description":"Information about the order fulfillment. If `order_status` is `\\"unfulfilled\\"`, `fulfillment_data` is empty.","properties":{"total_value":{"type":"number","description":"The total amount on a gift card, applicable to the whole order.","example":17},"total_shipping_value":{"type":"number","description":"The total amount on a gift card, applicable to shipping only.","example":10},"shipping_details":{"type":"array","description":"The shipping details for the fulfilled order.","example":[],"items":{}},"tracking_company":{"type":"string","description":"The tracking company for the fulfilled order.","example":"ups"},"tracking_number":{"type":"string","description":"The tracking number for the order.","example":"sJKfh72hKD7djh"},"tracking_url":{"type":"string","description":"The URL provided to track the order.","example":"https://www.ups.com/example-tracking-links"},"location_id":{"type":"number","description":"Location ID as given by the shipping and tracking company.","example":-3},"fulfilled_at":{"type":"string","description":"The datetime the order was fulfilled.","example":"2022-01-04 19:52:16"},"item_count":{"type":"integer","description":"The number of items in the fulfilled order.","example":8},"fulfilled_items":{"type":"array","description":"The items in the fulfilled order.","example":[],"items":{}},"total_discount":{"type":"number","description":"The total discount amount for the order.","example":12},"total_fees":{"type":"number","description":"The total amount of fees for the order.","example":4},"order_fees":{"type":"array","description":"The fees for the order.","example":[],"items":{}},"total_order_fees":{"type":"number","description":"The total amount for the order fees.","example":13},"total_tax":{"type":"number","description":"The total tax for the order.","example":5}}},"GeneralSettings":{"title":"General Settings","description":"General Checkout settings, which can be configured in the [Bold Checkout admin](https://apps.boldapps.net/accounts/app/4).","type":"object","properties":{"checkout_process":{"type":"object","description":"General settings relevant to the checkout process","properties":{"company_name_option":{"type":"string","description":"Indicates whether company name is required on an order.","enum":["optional","required","hidden"],"example":"hidden"},"phone_number_required":{"type":"boolean","description":"Indicates whether phone number is required on an order.","example":true},"accepts_marketing_checkbox_option":{"type":"string","description":"Indicates initial display of email marketing options.","enum":["checked","unchecked","hidden"],"example":"unchecked"},"require_inventory_check":{"type":"boolean","description":"Indicates whether an inventory check is required when processing an order.","example":false},"create_platform_customer":{"type":"boolean","description":"Indicates whether a customer should be created on the platform whenever a new order is created.","example":false}}},"address_autocomplete":{"type":"object","description":"The configuration for address autocomplete functionality, if enabled for the particular shop.","properties":{"provider":{"type":"string","nullable":true,"description":"The data provider for address autocomplete.","enum":["google","loqate"],"example":"google"},"api_key":{"type":"string","nullable":true,"description":"A public API key for querying the address autocomplete provider.","example":"awefa9304q9wfqf43jfaw904kfwkaslserfa94"}}},"public_order_id":{"type":"object","description":"A unique value that Bold generates and uses to track orders. If this value is set to `true`, the `bold_cashier_public_order_id` appears in the order\'s `note_attributes`.","properties":{"enabled":{"type":"boolean","description":"Indicates whether the attribute `bold_cashier_public_order_id` will be added to each order\'s `note_attributes`.","example":true}}}},"required":["checkout_process"]},"GeneralSettingsUpdateRequest":{"title":"General settings update request","description":"Changes to make to General Settings properties.","type":"object","properties":{"public_order_id":{"type":"object","description":"A unique value that Bold generates and uses to track orders.","properties":{"enabled":{"type":"boolean","description":"Indicates whether the `bold_cashier_public_order_id` appears in the order\'s `note_attributes`.","example":true}}}}},"PhoneNumberRequiredUpdateRequest":{"description":"The setting that determines whether customers are required to enter their phone number during checkout.","type":"object","properties":{"phone_number_required":{"type":"boolean","description":"Indicates whether customers are required to enter their phone number during checkout.","example":true}}},"RequireInventoryCheckUpdateRequest":{"description":"The setting that determines whether to require an inventory check when processing an order.","properties":{"require_inventory_check":{"type":"boolean","description":"Indicates whether an inventory check is required when processing an order.","example":false}}},"CreatePlatformCustomerUpdateRequest":{"description":"The setting that determines whether a customer should be created on the platform whenever an order is created on the platform.","type":"object","properties":{"create_platform_customer":{"type":"boolean","description":"Indicates whether customers should be created on the platform during order creation.","example":false}}},"Tax":{"title":"Tax","type":"object","properties":{"value":{"type":"number","description":"The value of the tax applied, represented in cents/base currency units, using [ISO-4217](https://www.iso.org/iso-4217-currency-codes.html) standards.","example":1000},"name":{"type":"string","description":"A descriptor of the tax being applied.","example":"GST"},"is_included":{"type":"boolean","description":"Indicates whether the tax is already included in the price.","example":true}}},"ConfigureIntegrationBody":{"title":"Configure Integration Body","type":"object","properties":{"shared_secret":{"type":"string","description":"A string used to sign callback url requests for webhook subscriptions.","example":"96c6db504d593697229066dde7c88f2e"}},"required":["shared_secret"]},"CustomerPaymentMethods":{"title":"Customer Payment Methods","type":"object","properties":{"success":{"type":"boolean","description":"Indicates whether the saved payment methods for a customer were successfully retrieved.","example":true},"cards":{"type":"array","items":{"$ref":"#/components/schemas/SavedPaymentMethods"},"description":"The list of all saved payment methods for a customer."}}},"SavedPaymentMethods":{"title":"Saved Payment Methods","type":"object","properties":{"type":{"type":"string","description":"The type of saved payment method. Current acceptable `type` value: [\\"credit_card\\"]","example":"credit_card"},"public_id":{"type":"string","description":"The public identifier for a payment. Generated by Bold.","example":"ZdtkGke3jqR4qeI9IvtrHaRQZxdobJ5SaGdcX7V22O0v2U5bBqDGb6FHAkpPk4KS"},"is_default":{"type":"boolean","description":"Indicates whether the payment method is the default method for the customer.","example":true},"cc_type":{"type":"string","description":"The type of credit card, if `type` is `credit_card`.","example":"Visa"},"last_four":{"type":"string","description":"The last four digits of the saved payment method, if `type` is `credit_card`.","example":"1111"},"expiration":{"type":"object","description":"The expiration date for the saved payment method, if `type` is `credit_card`.","properties":{"date":{"type":"string","description":"The expiration date for the saved payment method. Format: `YYYY-MM``.","example":"2023-11"}}}}},"DeletePaymentMethod":{"title":"Delete Payment Method","type":"object","properties":{"success":{"type":"boolean","description":"Indicates whether the payment method was successfully deleted.","example":true},"defaultCardId":{"type":"integer","description":"The identifier of the new default saved payment method for the customer. The next listed payment method is set to default automatically. If the customer has no saved payment methods remaining, `defaultCardId` returns `\\"\\"`.","example":1}}}},"examples":{"ProcessedOrderExample":{"value":{"domain":"store-vwd2342klmsdf.mybigcommerce.com","platform_domain":"example.mybigcommerce.com","application_state":{"customer":{"accepts_marketing":true,"email_address":"john.doe@example.com","first_name":"John","last_name":"Doe","platform_id":"50942578465125","public_id":"pjpTyGh8KzNQ225wPqxgy7LwNuC887h6ecGyp3omwT4XW8SszjVSdHzWHN4NBwqhA","saved_addresses":[]},"addresses":{"shipping":{"id":"123","first_name":"John","last_name":"Doe","address_line_1":"50 Fultz Blvd","address_line_2":"Suite 200","country":"Canada","city":"Winnipeg","province":"Manitoba","country_code":"CA","province_code":"MB","postal_code":"R3Y0L6","business_name":"Acme Inc.","phone_number":"8005550101"},"billing":{"id":"123","first_name":"John","last_name":"Doe","address_line_1":"50 Fultz Blvd","address_line_2":"Suite 200","country":"Canada","city":"Winnipeg","province":"Manitoba","country_code":"CA","province_code":"MB","postal_code":"R3Y0L6","business_name":"Acme Inc.","phone_number":"8005550101"}},"line_items":[{"product_data":{"id":"724bca","product_title":"Oak Cheese Grater","title":"Small","image_url":"http://shop.images/oakcheesegrater","properties":{"property1":"string","property2":"string"},"description":"A handmade oak cheese grater to elevate your cheese-eating experience.","quantity":2,"price":2350,"total_price":4700,"visible":1,"line_item_key":"oak_cheese_grater_2643","barcode":"1234ABC","compare_at_price":4000,"weight":1000,"weight_unit":"g","product_id":"oak-cheese-grater","variant_id":"oak-cheese-grater-small","requires_shipping":true,"sku":"OAK_GRATER_SM","taxable":true,"tags":"Kitchen, Cheese Board, Oak","vendor":"Cheese Boards Unlimited","total_weight":2000}},{"taxes":[{"value":1000,"name":"GST","is_included":true}]},{"fees":[{"amount":500,"name":"Miscellaneous fee."}]},{"discounts":[{"code":"SUMMER5","text":"Summer discount code","value":500,"source":"coupon"}]},{"fulfilled_quantity":2}],"fees":[{"id":"123456789","line_text":"Custom Fee \u2014 Added by Plugin","fee_type":"fixed","value":10,"source":"PLUGIN","plugin_uuid":"a52589f8-09df-11ed-b30e-f67072e164ee","taxable":true,"show_description":true}],"taxes":[{"value":1000,"name":"GST","is_included":true}],"discounts":[{"code":"SUMMER5","text":"Summer discount code","value":500,"source":"coupon"}],"payments":[{"gateway_public_id":"i7z2xT0sKrDvhGWzex5SLjf5e6ndlQfrRL4AROkfhf3vNBkVT38JKBy5PSjB63qW","amount":4700,"currency":"CAD","type":"spreedly","display_string":"Credit Card Payment","id":"","token":"7uZAMRAf80KiEwibsrrM5IB41yU","retain":false}],"order_total":4700,"order_meta_data":{"cart_parameters":{"key":"cp-key1","property1":"A cart param.","property2":"A cart param."},"note_attributes":{"key":"na-key1","property1":"A note attribute.","property2":"A note attribute."},"notes":"A special delivery note.","tags":["order-1"]},"shipping":{"selected_shipping":{"id":"0","description":"Custom weight-based rate: tier 2","amount":450,"code":"EXPID"},"available_shipping_lines":[{"id":"string","line":{"id":"0","description":"Custom weight-based rate: tier 2","amount":450,"code":"EXPID"}}],"taxes":[{"value":1000,"name":"GST","is_included":true}],"discounts":[{"code":"SUMMER5","text":"Summer discount code","value":500,"source":"coupon"}]},"resumable_link":"string","flow_id":"external-company-one-page-template","currency":{"iso_code":"CAD","iso_numeric_code":124,"symbol":"$","format":"${{amount}}","has_decimal":true,"show_iso_code":true},"created_via":"My_Order_Creating_Plugin","is_processed":false,"order_id":79047599,"platform_order_id":"1389wjfalsdf9y4r"},"public_order_id":"4U2bwe9SAQY039WGUKM5b2KoxKUKcgyLNvuEKB03Z2HzWbjYB1n4MoC7HuhLT45M","order_id":829,"platform_order_id":"","platform_friendly_identifier":"","order_source":"e3b37c97-8544-4fee-b8f3-cf33deb28be5","order_source_name":"api_v2","fulfillment_status":"unfulfilled","fulfillment_data":[]}},"CreatedOrderExample":{"value":{"domain":"store-vwd2342klmsdf.mybigcommerce.com","platform_domain":"example.mybigcommerce.com","application_state":{"customer":{"accepts_marketing":true,"email_address":"john.doe@example.com","first_name":"John","last_name":"Doe","platform_id":"50942578465125","public_id":"pjpTyGh8KzNQ225wPqxgy7LwNuC887h6ecGyp3omwT4XW8SszjVSdHzWHN4NBwqhA","saved_addresses":[]},"addresses":{"shipping":{"id":"123","first_name":"John","last_name":"Doe","address_line_1":"50 Fultz Blvd","address_line_2":"Suite 200","country":"Canada","city":"Winnipeg","province":"Manitoba","country_code":"CA","province_code":"MB","postal_code":"R3Y0L6","business_name":"Acme Inc.","phone_number":"8005550101"},"billing":{"id":"123","first_name":"John","last_name":"Doe","address_line_1":"50 Fultz Blvd","address_line_2":"Suite 200","country":"Canada","city":"Winnipeg","province":"Manitoba","country_code":"CA","province_code":"MB","postal_code":"R3Y0L6","business_name":"Acme Inc.","phone_number":"8005550101"}},"line_items":[{"product_data":{"id":"724bca","product_title":"Oak Cheese Grater","title":"Small","image_url":"http://shop.images/oakcheesegrater","properties":{"property1":"string","property2":"string"},"description":"A handmade oak cheese grater to elevate your cheese-eating experience.","quantity":2,"price":2350,"total_price":4700,"visible":1,"line_item_key":"oak_cheese_grater_2643","barcode":"1234ABC","compare_at_price":4000,"weight":1000,"weight_unit":"g","product_id":"oak-cheese-grater","variant_id":"oak-cheese-grater-small","requires_shipping":true,"sku":"OAK_GRATER_SM","taxable":true,"tags":"Kitchen, Cheese Board, Oak","vendor":"Cheese Boards Unlimited","total_weight":2000}},{"taxes":[{"value":1000,"name":"GST","is_included":true}]},{"fees":[{"amount":500,"name":"Miscellaneous fee."}]},{"discounts":[{"code":"SUMMER5","text":"Summer discount code","value":500,"source":"coupon"}]},{"fulfilled_quantity":2}],"fees":[{"id":"123456789","line_text":"Custom Fee \u2014 Added by Plugin","fee_type":"fixed","value":10,"source":"PLUGIN","plugin_uuid":"a52589f8-09df-11ed-b30e-f67072e164ee","taxable":true,"show_description":true}],"taxes":[{"value":1000,"name":"GST","is_included":true}],"discounts":[{"code":"SUMMER5","text":"Summer discount code","value":500,"source":"coupon"}],"payments":[{"gateway_public_id":"i7z2xT0sKrDvhGWzex5SLjf5e6ndlQfrRL4AROkfhf3vNBkVT38JKBy5PSjB63qW","amount":4700,"currency":"CAD","type":"spreedly","display_string":"Credit Card Payment","id":"","token":"7uZAMRAf80KiEwibsrrM5IB41yU","retain":false}],"order_total":4700,"order_meta_data":{"cart_parameters":{"key":"cp-key1","property1":"A cart param.","property2":"A cart param."},"note_attributes":{"key":"na-key1","property1":"A note attribute.","property2":"A note attribute."},"notes":"A special delivery note.","tags":["order-1"]},"shipping":{"selected_shipping":{"id":"0","description":"Custom weight-based rate: tier 2","amount":450,"code":"EXPID"},"available_shipping_lines":[{"id":"string","line":{"id":"0","description":"Custom weight-based rate: tier 2","amount":450,"code":"EXPID"}}],"taxes":[{"value":1000,"name":"GST","is_included":true}],"discounts":[{"code":"SUMMER5","text":"Summer discount code","value":500,"source":"coupon"}]},"resumable_link":"string","flow_id":"external-company-one-page-template","currency":{"iso_code":"CAD","iso_numeric_code":124,"symbol":"$","format":"${{amount}}","has_decimal":true,"show_iso_code":true},"created_via":"My_Order_Creating_Plugin","is_processed":false,"order_id":79047599,"platform_order_id":"1389wjfalsdf9y4r"},"public_order_id":"4U2bwe9SAQY039WGUKM5b2KoxKUKcgyLNvuEKB03Z2HzWbjYB1n4MoC7HuhLT45M","order_id":829,"platform_order_id":"179","platform_friendly_identifier":"179","order_source":"e3b37c97-8544-4fee-b8f3-cf33deb45be5","order_source_name":"api_v2","fulfillment_status":"unfulfilled","fulfillment_data":[]}},"FulfilledOrderExample":{"value":{"domain":"store-vwd2342klmsdf.mybigcommerce.com","platform_domain":"example.mybigcommerce.com","application_state":{"customer":{"accepts_marketing":true,"email_address":"john.doe@example.com","first_name":"John","last_name":"Doe","platform_id":"50942578465125","public_id":"pjpTyGh8KzNQ225wPqxgy7LwNuC887h6ecGyp3omwT4XW8SszjVSdHzWHN4NBwqhA","saved_addresses":[]},"addresses":{"shipping":{"id":"123","first_name":"John","last_name":"Doe","address_line_1":"50 Fultz Blvd","address_line_2":"Suite 200","country":"Canada","city":"Winnipeg","province":"Manitoba","country_code":"CA","province_code":"MB","postal_code":"R3Y0L6","business_name":"Acme Inc.","phone_number":"8005550101"},"billing":{"id":"123","first_name":"John","last_name":"Doe","address_line_1":"50 Fultz Blvd","address_line_2":"Suite 200","country":"Canada","city":"Winnipeg","province":"Manitoba","country_code":"CA","province_code":"MB","postal_code":"R3Y0L6","business_name":"Acme Inc.","phone_number":"8005550101"}},"line_items":[{"product_data":{"id":"724bca","product_title":"Oak Cheese Grater","title":"Small","image_url":"http://shop.images/oakcheesegrater","properties":{"property1":"string","property2":"string"},"description":"A handmade oak cheese grater to elevate your cheese-eating experience.","quantity":2,"price":2350,"total_price":4700,"visible":1,"line_item_key":"oak_cheese_grater_2643","barcode":"1234ABC","compare_at_price":4000,"weight":1000,"weight_unit":"g","product_id":"oak-cheese-grater","variant_id":"oak-cheese-grater-small","requires_shipping":true,"sku":"OAK_GRATER_SM","taxable":true,"tags":"Kitchen, Cheese Board, Oak","vendor":"Cheese Boards Unlimited","total_weight":2000}},{"taxes":[{"value":1000,"name":"GST","is_included":true}]},{"fees":[{"amount":500,"name":"Miscellaneous fee."}]},{"discounts":[{"code":"SUMMER5","text":"Summer discount code","value":500,"source":"coupon"}]},{"fulfilled_quantity":2}],"fees":[{"id":"123456789","line_text":"Custom Fee \u2014 Added by Plugin","fee_type":"fixed","value":10,"source":"PLUGIN","plugin_uuid":"a52589f8-09df-11ed-b30e-f67072e164ee","taxable":true,"show_description":true}],"taxes":[{"value":1000,"name":"GST","is_included":true}],"discounts":[{"code":"SUMMER5","text":"Summer discount code","value":500,"source":"coupon"}],"payments":[{"gateway_public_id":"i7z2xT0sKrDvhGWzex5SLjf5e6ndlQfrRL4AROkfhf3vNBkVT38JKBy5PSjB63qW","amount":4700,"currency":"CAD","type":"spreedly","display_string":"Credit Card Payment","id":"","token":"7uZAMRAf80KiEwibsrrM5IB41yU","retain":false}],"order_total":4700,"order_meta_data":{"cart_parameters":{"key":"cp-key1","property1":"A cart param.","property2":"A cart param."},"note_attributes":{"key":"na-key1","property1":"A note attribute.","property2":"A note attribute."},"notes":"A special delivery note.","tags":["order-1"]},"shipping":{"selected_shipping":{"id":"0","description":"Custom weight-based rate: tier 2","amount":450,"code":"EXPID"},"available_shipping_lines":[{"id":"string","line":{"id":"0","description":"Custom weight-based rate: tier 2","amount":450,"code":"EXPID"}}],"taxes":[{"value":1000,"name":"GST","is_included":true}],"discounts":[{"code":"SUMMER5","text":"Summer discount code","value":500,"source":"coupon"}]},"resumable_link":"string","flow_id":"external-company-one-page-template","currency":{"iso_code":"CAD","iso_numeric_code":124,"symbol":"$","format":"${{amount}}","has_decimal":true,"show_iso_code":true},"created_via":"My_Order_Creating_Plugin","is_processed":false,"order_id":79047599,"platform_order_id":"1389wjfalsdf9y4r"},"public_order_id":"4U2bwe9SAQY039WGUKM5b2KoxKUKcgyLNvuEKB03Z2HzWbjYB1n4MoC7HuhLT45M","order_id":829,"platform_order_id":"179","platform_friendly_identifier":"179","order_source":"e3b37c97-8544-4fee-b8f3-cf33deb45be5","order_source_name":"api_v2","fulfillment_status":"fulfilled","fulfillment_data":{"total_value":17,"total_shipping_value":10,"shipping_details":[],"tracking_company":"ups","tracking_number":"sJKfh72hKD7djh","tracking_url":"https://www.ups.com/example-tracking-links","location_id":-3,"fulfilled_at":"2022-01-04 19:52:16","fulfilled_items":[],"total_discount":12,"total_fees":4,"order_fees":[],"total_order_fees":13,"total_tax":5}}},"FailedOrderExample":{"value":{"domain":"store-vwd2342klmsdf.mybigcommerce.com","platform_domain":"example.mybigcommerce.com","application_state":{"customer":{"accepts_marketing":true,"email_address":"john.doe@example.com","first_name":"John","last_name":"Doe","platform_id":"50942578465125","public_id":"pjpTyGh8KzNQ225wPqxgy7LwNuC887h6ecGyp3omwT4XW8SszjVSdHzWHN4NBwqhA","saved_addresses":[]},"addresses":{"shipping":{"id":"123","first_name":"John","last_name":"Doe","address_line_1":"50 Fultz Blvd","address_line_2":"Suite 200","country":"Canada","city":"Winnipeg","province":"Manitoba","country_code":"CA","province_code":"MB","postal_code":"R3Y0L6","business_name":"Acme Inc.","phone_number":"8005550101"},"billing":{"id":"123","first_name":"John","last_name":"Doe","address_line_1":"50 Fultz Blvd","address_line_2":"Suite 200","country":"Canada","city":"Winnipeg","province":"Manitoba","country_code":"CA","province_code":"MB","postal_code":"R3Y0L6","business_name":"Acme Inc.","phone_number":"8005550101"}},"line_items":[{"product_data":{"id":"724bca","product_title":"Oak Cheese Grater","title":"Small","image_url":"http://shop.images/oakcheesegrater","properties":{"property1":"string","property2":"string"},"description":"A handmade oak cheese grater to elevate your cheese-eating experience.","quantity":2,"price":2350,"total_price":4700,"visible":1,"line_item_key":"oak_cheese_grater_2643","barcode":"1234ABC","compare_at_price":4000,"weight":1000,"weight_unit":"g","product_id":"oak-cheese-grater","variant_id":"oak-cheese-grater-small","requires_shipping":true,"sku":"OAK_GRATER_SM","taxable":true,"tags":"Kitchen, Cheese Board, Oak","vendor":"Cheese Boards Unlimited","total_weight":2000}},{"taxes":[{"value":1000,"name":"GST","is_included":true}]},{"fees":[{"amount":500,"name":"Miscellaneous fee."}]},{"discounts":[{"code":"SUMMER5","text":"Summer discount code","value":500,"source":"coupon"}]},{"fulfilled_quantity":2}],"fees":[{"id":"123456789","line_text":"Custom Fee \u2014 Added by Plugin","fee_type":"fixed","value":10,"source":"PLUGIN","plugin_uuid":"a52589f8-09df-11ed-b30e-f67072e164ee","taxable":true,"show_description":true}],"taxes":[{"value":1000,"name":"GST","is_included":true}],"discounts":[{"code":"SUMMER5","text":"Summer discount code","value":500,"source":"coupon"}],"payments":[{"gateway_public_id":"i7z2xT0sKrDvhGWzex5SLjf5e6ndlQfrRL4AROkfhf3vNBkVT38JKBy5PSjB63qW","amount":4700,"currency":"CAD","type":"spreedly","display_string":"Credit Card Payment","id":"","token":"7uZAMRAf80KiEwibsrrM5IB41yU","retain":false}],"order_total":4700,"order_meta_data":{"cart_parameters":{"key":"cp-key1","property1":"A cart param.","property2":"A cart param."},"note_attributes":{"key":"na-key1","property1":"A note attribute.","property2":"A note attribute."},"notes":"A special delivery note.","tags":["order-1"]},"shipping":{"selected_shipping":{"id":"0","description":"Custom weight-based rate: tier 2","amount":450,"code":"EXPID"},"available_shipping_lines":[{"id":"string","line":{"id":"0","description":"Custom weight-based rate: tier 2","amount":450,"code":"EXPID"}}],"taxes":[{"value":1000,"name":"GST","is_included":true}],"discounts":[{"code":"SUMMER5","text":"Summer discount code","value":500,"source":"coupon"}]},"resumable_link":"string","flow_id":"external-company-one-page-template","currency":{"iso_code":"CAD","iso_numeric_code":124,"symbol":"$","format":"${{amount}}","has_decimal":true,"show_iso_code":true},"created_via":"My_Order_Creating_Plugin","is_processed":false,"order_id":79047599,"platform_order_id":"1389wjfalsdf9y4r"},"public_order_id":"4U2bwe9SAQY039WGUKM5b2KoxKUKcgyLNvuEKB03Z2HzWbjYB1n4MoC7HuhLT45M","order_id":829,"platform_order_id":"179","platform_friendly_identifier":"179","order_source":"e3b37c97-8544-4fee-b8f3-cf33deb45be5","order_source_name":"api_v2","fulfillment_status":"unfulfilled","fulfillment_data":[]}},"AbandonedOrderExample":{"value":{"public_order_id":"nPTPIlIahDoEgZFabZNNvg7uxahLkGb1x4UINz3eqYV3eHewsjq7kubZc5BLAUqC","line_items":{"discounts":[],"fees":[],"product_data":{"barcode":"1234ABC","compare_at_price":4000,"description":"A handmade oak cheese grater to elevate your cheese-eating experience.","id":"724bca","image_url":"http://shop.images/oakcheesegrater","line_item_key":"ABC123","price":2350,"product_id":"oak-cheese-grater","properties":[],"quantity":2,"requires_shipping":true,"sku":"OAK_GRATER_SM","tags":"Kitchen, Cheese Board, Oak","taxable":true,"title":"Small","total_price":4700,"variant_id":"oak-cheese-grater-small","vendor":"Cheese Boards Unlimited","visible":1,"weight":1000,"weight_unit":"g"},"taxes":[]},"customer":{"accepts_marketing":true,"email_address":"john.doe@example.com","first_name":"John","last_name":"Doe","platform_id":null,"public_id":"sTaGXlJuMIz1fzdnE8HSXkK1m2ym9FRbrwxqiS2t7XylVEMBT7YX1Xeep6V7cT53","saved_addresses":[]},"order_meta_data":{"cart_parameters":{"ca-key1":"Some kind of cart parameter."},"note_attributes":{"na-key1":"Some kind of note attributes."},"notes":"Some kind of special delivery note.","tags":["tag-1"]},"resumable_link":"https://checkout.example.com/resume","shop":{"domain":"store-vwd2342klmsdf.mybigcommerce.com","platform_domain":"example.mybigcommerce.com"}}},"GiftCardCreatedExample":{"value":{"domain":"store-vwd2342klmsdf.mybigcommerce.com","platform_domain":"example.mybigcommerce.com","public_order_id":"4U2bwe9SAQY039WGUKM5b2KoxKUKcgyLNvuEKB03Z2HzWbjYB1n4MoC7HuhLT45M","platform_order_id":179,"platform_customer_id":null,"customer":{"email":"john.doe@example.com","first_name":"John","last_name":"Doe"},"gift_card_email":"john.doe@example.com","gift_card_token":"TYIDFASDFOCXOMT","gift_card_key":"107","gift_card_amount":2500}},"CORSDomainsExample":{"value":{"data":[{"id":1,"domain":"https://test-store.example.com"},{"id":2,"domain":"https://dev-store.example.com"}]}}},"parameters":{"shop_identifier":{"schema":{"type":"string"},"name":"shop_identifier","in":"path","required":true,"description":"The identifier of the shop, which can be retrieved by making a request to the [Get Shop Info](shops#operation/GetShopInfo) endpoint.","example":"zp3oafdor9"},"domain_id":{"schema":{"type":"number"},"name":"domain_id","example":1,"in":"path","required":true,"description":"The identifier of the domain. Retrieve the identifier using the [Get CORS Allowlist](checkout#operation/GetCORSAllowlist) endpoint."},"public_gateway_id":{"schema":{"type":"string"},"name":"public_gateway_id","in":"path","required":true,"description":"The public identifier generated by Bold Checkout adds a payment gateway to a store."},"public_customer_id":{"schema":{"type":"string","example":"uqw94joiefrqwo4"},"name":"public_customer_id","in":"path","required":true,"description":"The public identifier for a customer, returned as the `public_id` field by the [Create Authenticated Customer](/api/orders#tag/Customers/operation/CreateAuthenticatedCustomer) endpoint."},"public_payment_id":{"schema":{"type":"string","example":"W0fe4CNraY09ooQ6DUlXb0hNUBHk7LF9wZOEmVOL92qvggIUKq0ne9qcbfCSnDwZ"},"name":"public_payment_id","in":"path","required":true,"description":"The public identifier for a saved payment method."},"public_element_id":{"schema":{"type":"string"},"name":"public_element_id","in":"path","required":true,"description":"The Bold-generated identifier of the LiFE elements.","example":"VfYRxzOjRkwG6B2xWbxhPQ"},"zone_id":{"schema":{"type":"integer"},"name":"zone_id","in":"path","required":true,"description":"The identifier Bold Checkout uses for a zone. Refer to [Create Zone](checkout-admin#operation/CreateZone)."},"platform_customer_id":{"name":"platform_customer_id","in":"query","schema":{"type":"string","example":"a90w4q2kopP23F3"},"description":"A platform-generated identifier of the customer.","required":false},"bold_customer_id":{"name":"bold_customer_id","in":"query","schema":{"type":"string","example":"uqw94joiefrqwo4"},"description":"A Bold-generated identifier of the customer.","required":false}},"responses":{"UnknownError":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}}}}}},"plugin-redoc-11":{"url":"/api/checkout-rsa.openapi.yaml","themeId":"theme-redoc","isSpecFile":true,"spec":{"openapi":"3.0.0","info":{"title":"Checkout Remote State Authority","version":"1.0.0","description":"The Checkout Remote State Authority API enables Bold to interact with a remote system that owns and has complete control over the state of an order during checkout. When a Remote State Authority (RSA) is configured, Bold Checkout calls the Remote Authority with order information, which manipulates the order and sends an updated order back to Bold Checkout.\\n\\nThis specification file defines the expected server behavior of the Remote State Authority server. Bold applications require the endpoints listed here to be implemented in order to function properly.","termsOfService":"https://boldcommerce.com/terms-of-service","contact":{"name":"Contact Us","url":"https://developer-dashboard.boldcommerce.com/default/contactus"}},"servers":[{"url":"https://your-remote-state-authority.example"}],"security":[{"HMAC":[]}],"tags":[{"name":"Events","description":"Contains information about checkout events that manipulate the order state."},{"name":"Validate","description":"Contains information about one-off validation for checkout data."}],"externalDocs":{"description":"For more information about the Checkout RSA, including how to implement it, refer to the guides.","url":"https://developer.boldcommerce.com/guides/platform-connector/rsa/create-checkout-rsa"},"paths":{"/shops/{shop_identifier}/orders/{public_order_id}/order_events":{"post":{"summary":"Process Order Events","operationId":"ProcessOrderEvents","description":"Applies various state changes to the order. Events on any given request will only ever correspond to a single order, identified by the `public_order_id`.","parameters":[{"$ref":"#/components/parameters/shop_identifier"},{"$ref":"#/components/parameters/public_order_id"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"cart_id":{"type":"string","description":"The platform-defined identifier of the cart associated with the order.","example":"R1F6BiWNxI0Gg9WMfSZtMkTiUoFSlBD6"},"public_order_id":{"type":"string","description":"The public order identifier generated when the order is [initialized](orders#operation/InitializeOrder) within Bold Checkout.","example":"SpMIhOL7Q36EDZUagB5GnnPh4TUb9zW9t0DGrWd8PvrwdV1S1PhGpf9wFIJRyZEi"},"order_state":{"$ref":"#/components/schemas/IncomingOrderState"},"events":{"type":"array","minItems":1,"description":"An array of one or more changes to make to the order state. The RSA must process these events in the order they are received.","items":{"oneOf":[{"$ref":"#/components/schemas/SetShippingAddress"},{"$ref":"#/components/schemas/RemoveShippingAddress"},{"$ref":"#/components/schemas/SetBillingAddress"},{"$ref":"#/components/schemas/RemoveBillingAddress"},{"$ref":"#/components/schemas/SetCustomer"},{"$ref":"#/components/schemas/RemoveCustomer"},{"$ref":"#/components/schemas/SetShippingLine"},{"$ref":"#/components/schemas/GetShippingLines"},{"$ref":"#/components/schemas/ApplyTaxes"},{"$ref":"#/components/schemas/AddDiscountCode"},{"$ref":"#/components/schemas/RemoveDiscountCode"},{"$ref":"#/components/schemas/AddLineItem"},{"$ref":"#/components/schemas/UpdateLineItem"},{"$ref":"#/components/schemas/RemoveLineItem"},{"$ref":"#/components/schemas/EstimateTax"},{"$ref":"#/components/schemas/EstimateShipping"}]}}},"required":["cart_id","public_order_id","order_state","events"]},"examples":{"SetShippingAddress":{"value":{"cart_id":"R1F6BiWNxI0Gg9WMfSZtMkTiUoFSlBD6","public_order_id":"SpMIhOL7Q36EDZUagB5GnnPh4TUb9zW9t0DGrWd8PvrwdV1S1PhGpf9wFIJRyZEi","order_state":{"cart_id":"R1F6BiWNxI0Gg9WMfSZtMkTiUoFSlBD6","line_items":[{"title":"Ground Coffee, 16oz","image":"https://www.example.com/products/ground_coffee_dark","description":"Our delicious coffee blend is ground from the finest Colombian beans, guaranteeing you the best cup of coffee you\'ve had!","visible":true,"quantity":1,"taxable":true,"line_item_key":"ERQ-GND-16_1","sku":"ERQGND16","platform_variant_id":"e7ba4c75-b1bb-483d-94d8-2c4a10f78472","requires_shipping":true,"weight_unit":"oz","tax_code":"PF050211","note":"Extra-fine ground requested","volume_unit":"bag","unit_price":1299,"item_weight":16,"vendor":"Example Enterprises","properties":{"grind":"extra-fine","roast":"dark"},"taxes":[{"name":"GST","rate":0.05,"unit_amount":64.95}],"discounts":[{"text":"First time buyer - 10% off","unit_amount":136.4,"code":"FIRSTTIMER_PR45TY90","source":"cart"},{"text":"Spring Sale - $5.00 off","unit_amount":5,"code":"SPRING2023_E44J23","source":"coupon"}]}],"customer":{"platform_id":"836206","public_id":"TwyAWDwCkrdZqbifdcF6XAZjLgDEeyK4j0d4qani2exHwaQYl4jZzLhVciqenJ4T","first_name":"Carl","last_name":"Smith","email_address":"carl.smith@example.com","accepts_marketing":true},"shipping_address":{"first_name":"Carl","last_name":"Smith","address_line_1":"50 Fultz Boulevard","address_line_2":"Unit 2","city":"Winnipeg","province":"Manitoba","province_code":"MB","country":"Canada","country_code":"CA","postal_code":"R3Y 0L6","business_name":"Bold Commerce","phone_number":"204-808-8095"},"billing_address":{"first_name":"Carl","last_name":"Smith","address_line_1":"50 Fultz Boulevard","address_line_2":"Unit 2","city":"Winnipeg","province":"Manitoba","province_code":"MB","country":"Canada","country_code":"CA","postal_code":"R3Y 0L6","business_name":"Bold Commerce","phone_number":"204-808-8095"},"shipping_options":[{"rate_name":"Standard Shipping","cost":500,"code":"SHIPPING_AR36F"},{"rate_name":"Expedited Shipping","cost":2499,"code":"SHIPPING_P3R44"}],"selected_shipping":{"rate_name":"Standard Shipping","cost":500,"code":"SHIPPING_AR36F","taxes":[{"name":"GST","rate":0.05,"unit_amount":25}]},"tags":["Wholesale","Order Packed"],"fees":[{"description":"Convenience fee","value":150,"taxable":true}],"notes":["Customer called to clarify delivery date on October 12th"],"cart_params":{"customer_first_name":"Carl","customer_last_name":"Smith","shirt_size":"XL"}},"events":[{"event_name":"set_shipping_address","data":{"first_name":"Carl","last_name":"Smith","address_line_1":"50 Fultz Boulevard","address_line_2":"Unit 2","city":"Winnipeg","province":"Manitoba","province_code":"MB","country":"Canada","country_code":"CA","postal_code":"R3Y 0L6","business_name":"Bold Commerce","phone_number":"204-808-8095"}}]}},"RemoveShippingAddress":{"value":{"cart_id":"R1F6BiWNxI0Gg9WMfSZtMkTiUoFSlBD6","public_order_id":"SpMIhOL7Q36EDZUagB5GnnPh4TUb9zW9t0DGrWd8PvrwdV1S1PhGpf9wFIJRyZEi","order_state":{"cart_id":"R1F6BiWNxI0Gg9WMfSZtMkTiUoFSlBD6","line_items":[{"title":"Ground Coffee, 16oz","image":"https://www.example.com/products/ground_coffee_dark","description":"Our delicious coffee blend is ground from the finest Colombian beans, guaranteeing you the best cup of coffee you\'ve had!","visible":true,"quantity":1,"taxable":true,"line_item_key":"ERQ-GND-16_1","sku":"ERQGND16","platform_variant_id":"e7ba4c75-b1bb-483d-94d8-2c4a10f78472","requires_shipping":true,"weight_unit":"oz","tax_code":"PF050211","note":"Extra-fine ground requested","volume_unit":"bag","unit_price":1299,"item_weight":16,"vendor":"Example Enterprises","properties":{"grind":"extra-fine","roast":"dark"},"taxes":[{"name":"GST","rate":0.05,"unit_amount":64.95}],"discounts":[{"text":"First time buyer - 10% off","unit_amount":136.4,"code":"FIRSTTIMER_PR45TY90","source":"cart"},{"text":"Spring Sale - $5.00 off","unit_amount":5,"code":"SPRING2023_E44J23","source":"coupon"}]}],"customer":{"platform_id":"836206","public_id":"TwyAWDwCkrdZqbifdcF6XAZjLgDEeyK4j0d4qani2exHwaQYl4jZzLhVciqenJ4T","first_name":"Carl","last_name":"Smith","email_address":"carl.smith@example.com","accepts_marketing":true},"shipping_address":{"first_name":"Carl","last_name":"Smith","address_line_1":"50 Fultz Boulevard","address_line_2":"Unit 2","city":"Winnipeg","province":"Manitoba","province_code":"MB","country":"Canada","country_code":"CA","postal_code":"R3Y 0L6","business_name":"Bold Commerce","phone_number":"204-808-8095"},"billing_address":{"first_name":"Carl","last_name":"Smith","address_line_1":"50 Fultz Boulevard","address_line_2":"Unit 2","city":"Winnipeg","province":"Manitoba","province_code":"MB","country":"Canada","country_code":"CA","postal_code":"R3Y 0L6","business_name":"Bold Commerce","phone_number":"204-808-8095"},"shipping_options":[{"rate_name":"Standard Shipping","cost":500,"code":"SHIPPING_AR36F"},{"rate_name":"Expedited Shipping","cost":2499,"code":"SHIPPING_P3R44"}],"selected_shipping":{"rate_name":"Standard Shipping","cost":500,"code":"SHIPPING_AR36F","taxes":[{"name":"GST","rate":0.05,"unit_amount":25}]},"tags":["Wholesale","Order Packed"],"fees":[{"description":"Convenience fee","value":150,"taxable":true}],"notes":["Customer called to clarify delivery date on October 12th"],"cart_params":{"customer_first_name":"Carl","customer_last_name":"Smith","shirt_size":"XL"}},"events":[{"event_name":"remove_shipping_address","data":{}}]}},"SetBillingAddress":{"value":{"cart_id":"R1F6BiWNxI0Gg9WMfSZtMkTiUoFSlBD6","public_order_id":"SpMIhOL7Q36EDZUagB5GnnPh4TUb9zW9t0DGrWd8PvrwdV1S1PhGpf9wFIJRyZEi","order_state":{"cart_id":"R1F6BiWNxI0Gg9WMfSZtMkTiUoFSlBD6","line_items":[{"title":"Ground Coffee, 16oz","image":"https://www.example.com/products/ground_coffee_dark","description":"Our delicious coffee blend is ground from the finest Colombian beans, guaranteeing you the best cup of coffee you\'ve had!","visible":true,"quantity":1,"taxable":true,"line_item_key":"ERQ-GND-16_1","sku":"ERQGND16","platform_variant_id":"e7ba4c75-b1bb-483d-94d8-2c4a10f78472","requires_shipping":true,"weight_unit":"oz","tax_code":"PF050211","note":"Extra-fine ground requested","volume_unit":"bag","unit_price":1299,"item_weight":16,"vendor":"Example Enterprises","properties":{"grind":"extra-fine","roast":"dark"},"taxes":[{"name":"GST","rate":0.05,"unit_amount":64.95}],"discounts":[{"text":"First time buyer - 10% off","unit_amount":136.4,"code":"FIRSTTIMER_PR45TY90","source":"cart"},{"text":"Spring Sale - $5.00 off","unit_amount":5,"code":"SPRING2023_E44J23","source":"coupon"}]}],"customer":{"platform_id":"836206","public_id":"TwyAWDwCkrdZqbifdcF6XAZjLgDEeyK4j0d4qani2exHwaQYl4jZzLhVciqenJ4T","first_name":"Carl","last_name":"Smith","email_address":"carl.smith@example.com","accepts_marketing":true},"shipping_address":{"first_name":"Carl","last_name":"Smith","address_line_1":"50 Fultz Boulevard","address_line_2":"Unit 2","city":"Winnipeg","province":"Manitoba","province_code":"MB","country":"Canada","country_code":"CA","postal_code":"R3Y 0L6","business_name":"Bold Commerce","phone_number":"204-808-8095"},"billing_address":{"first_name":"Carl","last_name":"Smith","address_line_1":"50 Fultz Boulevard","address_line_2":"Unit 2","city":"Winnipeg","province":"Manitoba","province_code":"MB","country":"Canada","country_code":"CA","postal_code":"R3Y 0L6","business_name":"Bold Commerce","phone_number":"204-808-8095"},"shipping_options":[{"rate_name":"Standard Shipping","cost":500,"code":"SHIPPING_AR36F"},{"rate_name":"Expedited Shipping","cost":2499,"code":"SHIPPING_P3R44"}],"selected_shipping":{"rate_name":"Standard Shipping","cost":500,"code":"SHIPPING_AR36F","taxes":[{"name":"GST","rate":0.05,"unit_amount":25}]},"tags":["Wholesale","Order Packed"],"fees":[{"description":"Convenience fee","value":150,"taxable":true}],"notes":["Customer called to clarify delivery date on October 12th"],"cart_params":{"customer_first_name":"Carl","customer_last_name":"Smith","shirt_size":"XL"}},"events":[{"event_name":"set_billing_address","data":{"first_name":"Carl","last_name":"Smith","address_line_1":"50 Fultz Boulevard","address_line_2":"Unit 2","city":"Winnipeg","province":"Manitoba","province_code":"MB","country":"Canada","country_code":"CA","postal_code":"R3Y 0L6","business_name":"Bold Commerce","phone_number":"204-808-8095"}}]}},"RemoveBillingAddress":{"value":{"cart_id":"R1F6BiWNxI0Gg9WMfSZtMkTiUoFSlBD6","public_order_id":"SpMIhOL7Q36EDZUagB5GnnPh4TUb9zW9t0DGrWd8PvrwdV1S1PhGpf9wFIJRyZEi","order_state":{"cart_id":"R1F6BiWNxI0Gg9WMfSZtMkTiUoFSlBD6","line_items":[{"title":"Ground Coffee, 16oz","image":"https://www.example.com/products/ground_coffee_dark","description":"Our delicious coffee blend is ground from the finest Colombian beans, guaranteeing you the best cup of coffee you\'ve had!","visible":true,"quantity":1,"taxable":true,"line_item_key":"ERQ-GND-16_1","sku":"ERQGND16","platform_variant_id":"e7ba4c75-b1bb-483d-94d8-2c4a10f78472","requires_shipping":true,"weight_unit":"oz","tax_code":"PF050211","note":"Extra-fine ground requested","volume_unit":"bag","unit_price":1299,"item_weight":16,"vendor":"Example Enterprises","properties":{"grind":"extra-fine","roast":"dark"},"taxes":[{"name":"GST","rate":0.05,"unit_amount":64.95}],"discounts":[{"text":"First time buyer - 10% off","unit_amount":136.4,"code":"FIRSTTIMER_PR45TY90","source":"cart"},{"text":"Spring Sale - $5.00 off","unit_amount":5,"code":"SPRING2023_E44J23","source":"coupon"}]}],"customer":{"platform_id":"836206","public_id":"TwyAWDwCkrdZqbifdcF6XAZjLgDEeyK4j0d4qani2exHwaQYl4jZzLhVciqenJ4T","first_name":"Carl","last_name":"Smith","email_address":"carl.smith@example.com","accepts_marketing":true},"shipping_address":{"first_name":"Carl","last_name":"Smith","address_line_1":"50 Fultz Boulevard","address_line_2":"Unit 2","city":"Winnipeg","province":"Manitoba","province_code":"MB","country":"Canada","country_code":"CA","postal_code":"R3Y 0L6","business_name":"Bold Commerce","phone_number":"204-808-8095"},"billing_address":{"first_name":"Carl","last_name":"Smith","address_line_1":"50 Fultz Boulevard","address_line_2":"Unit 2","city":"Winnipeg","province":"Manitoba","province_code":"MB","country":"Canada","country_code":"CA","postal_code":"R3Y 0L6","business_name":"Bold Commerce","phone_number":"204-808-8095"},"shipping_options":[{"rate_name":"Standard Shipping","cost":500,"code":"SHIPPING_AR36F"},{"rate_name":"Expedited Shipping","cost":2499,"code":"SHIPPING_P3R44"}],"selected_shipping":{"rate_name":"Standard Shipping","cost":500,"code":"SHIPPING_AR36F","taxes":[{"name":"GST","rate":0.05,"unit_amount":25}]},"tags":["Wholesale","Order Packed"],"fees":[{"description":"Convenience fee","value":150,"taxable":true}],"notes":["Customer called to clarify delivery date on October 12th"],"cart_params":{"customer_first_name":"Carl","customer_last_name":"Smith","shirt_size":"XL"}},"events":[{"event_name":"remove_billing_address","data":{}}]}},"SetCustomer":{"value":{"cart_id":"R1F6BiWNxI0Gg9WMfSZtMkTiUoFSlBD6","public_order_id":"SpMIhOL7Q36EDZUagB5GnnPh4TUb9zW9t0DGrWd8PvrwdV1S1PhGpf9wFIJRyZEi","order_state":{"cart_id":"R1F6BiWNxI0Gg9WMfSZtMkTiUoFSlBD6","line_items":[{"title":"Ground Coffee, 16oz","image":"https://www.example.com/products/ground_coffee_dark","description":"Our delicious coffee blend is ground from the finest Colombian beans, guaranteeing you the best cup of coffee you\'ve had!","visible":true,"quantity":1,"taxable":true,"line_item_key":"ERQ-GND-16_1","sku":"ERQGND16","platform_variant_id":"e7ba4c75-b1bb-483d-94d8-2c4a10f78472","requires_shipping":true,"weight_unit":"oz","tax_code":"PF050211","note":"Extra-fine ground requested","volume_unit":"bag","unit_price":1299,"item_weight":16,"vendor":"Example Enterprises","properties":{"grind":"extra-fine","roast":"dark"},"taxes":[{"name":"GST","rate":0.05,"unit_amount":64.95}],"discounts":[{"text":"First time buyer - 10% off","unit_amount":136.4,"code":"FIRSTTIMER_PR45TY90","source":"cart"},{"text":"Spring Sale - $5.00 off","unit_amount":5,"code":"SPRING2023_E44J23","source":"coupon"}]}],"customer":{"platform_id":"836206","public_id":"TwyAWDwCkrdZqbifdcF6XAZjLgDEeyK4j0d4qani2exHwaQYl4jZzLhVciqenJ4T","first_name":"Carl","last_name":"Smith","email_address":"carl.smith@example.com","accepts_marketing":true},"shipping_address":{"first_name":"Carl","last_name":"Smith","address_line_1":"50 Fultz Boulevard","address_line_2":"Unit 2","city":"Winnipeg","province":"Manitoba","province_code":"MB","country":"Canada","country_code":"CA","postal_code":"R3Y 0L6","business_name":"Bold Commerce","phone_number":"204-808-8095"},"billing_address":{"first_name":"Carl","last_name":"Smith","address_line_1":"50 Fultz Boulevard","address_line_2":"Unit 2","city":"Winnipeg","province":"Manitoba","province_code":"MB","country":"Canada","country_code":"CA","postal_code":"R3Y 0L6","business_name":"Bold Commerce","phone_number":"204-808-8095"},"shipping_options":[{"rate_name":"Standard Shipping","cost":500,"code":"SHIPPING_AR36F"},{"rate_name":"Expedited Shipping","cost":2499,"code":"SHIPPING_P3R44"}],"selected_shipping":{"rate_name":"Standard Shipping","cost":500,"code":"SHIPPING_AR36F","taxes":[{"name":"GST","rate":0.05,"unit_amount":25}]},"tags":["Wholesale","Order Packed"],"fees":[{"description":"Convenience fee","value":150,"taxable":true}],"notes":["Customer called to clarify delivery date on October 12th"],"cart_params":{"customer_first_name":"Carl","customer_last_name":"Smith","shirt_size":"XL"}},"events":[{"event_name":"set_customer","data":{"platform_id":"836206","public_id":"TwyAWDwCkrdZqbifdcF6XAZjLgDEeyK4j0d4qani2exHwaQYl4jZzLhVciqenJ4T","first_name":"Carl","last_name":"Smith","email_address":"carl.smith@example.com","accepts_marketing":true}}]}},"RemoveCustomer":{"value":{"cart_id":"R1F6BiWNxI0Gg9WMfSZtMkTiUoFSlBD6","public_order_id":"SpMIhOL7Q36EDZUagB5GnnPh4TUb9zW9t0DGrWd8PvrwdV1S1PhGpf9wFIJRyZEi","order_state":{"cart_id":"R1F6BiWNxI0Gg9WMfSZtMkTiUoFSlBD6","line_items":[{"title":"Ground Coffee, 16oz","image":"https://www.example.com/products/ground_coffee_dark","description":"Our delicious coffee blend is ground from the finest Colombian beans, guaranteeing you the best cup of coffee you\'ve had!","visible":true,"quantity":1,"taxable":true,"line_item_key":"ERQ-GND-16_1","sku":"ERQGND16","platform_variant_id":"e7ba4c75-b1bb-483d-94d8-2c4a10f78472","requires_shipping":true,"weight_unit":"oz","tax_code":"PF050211","note":"Extra-fine ground requested","volume_unit":"bag","unit_price":1299,"item_weight":16,"vendor":"Example Enterprises","properties":{"grind":"extra-fine","roast":"dark"},"taxes":[{"name":"GST","rate":0.05,"unit_amount":64.95}],"discounts":[{"text":"First time buyer - 10% off","unit_amount":136.4,"code":"FIRSTTIMER_PR45TY90","source":"cart"},{"text":"Spring Sale - $5.00 off","unit_amount":5,"code":"SPRING2023_E44J23","source":"coupon"}]}],"customer":{"platform_id":"836206","public_id":"TwyAWDwCkrdZqbifdcF6XAZjLgDEeyK4j0d4qani2exHwaQYl4jZzLhVciqenJ4T","first_name":"Carl","last_name":"Smith","email_address":"carl.smith@example.com","accepts_marketing":true},"shipping_address":{"first_name":"Carl","last_name":"Smith","address_line_1":"50 Fultz Boulevard","address_line_2":"Unit 2","city":"Winnipeg","province":"Manitoba","province_code":"MB","country":"Canada","country_code":"CA","postal_code":"R3Y 0L6","business_name":"Bold Commerce","phone_number":"204-808-8095"},"billing_address":{"first_name":"Carl","last_name":"Smith","address_line_1":"50 Fultz Boulevard","address_line_2":"Unit 2","city":"Winnipeg","province":"Manitoba","province_code":"MB","country":"Canada","country_code":"CA","postal_code":"R3Y 0L6","business_name":"Bold Commerce","phone_number":"204-808-8095"},"shipping_options":[{"rate_name":"Standard Shipping","cost":500,"code":"SHIPPING_AR36F"},{"rate_name":"Expedited Shipping","cost":2499,"code":"SHIPPING_P3R44"}],"selected_shipping":{"rate_name":"Standard Shipping","cost":500,"code":"SHIPPING_AR36F","taxes":[{"name":"GST","rate":0.05,"unit_amount":25}]},"tags":["Wholesale","Order Packed"],"fees":[{"description":"Convenience fee","value":150,"taxable":true}],"notes":["Customer called to clarify delivery date on October 12th"],"cart_params":{"customer_first_name":"Carl","customer_last_name":"Smith","shirt_size":"XL"}},"events":[{"event_name":"remove_customer","data":{}}]}},"EstimateShipping":{"value":{"cart_id":"R1F6BiWNxI0Gg9WMfSZtMkTiUoFSlBD6","public_order_id":"SpMIhOL7Q36EDZUagB5GnnPh4TUb9zW9t0DGrWd8PvrwdV1S1PhGpf9wFIJRyZEi","order_state":{"cart_id":"R1F6BiWNxI0Gg9WMfSZtMkTiUoFSlBD6","line_items":[{"title":"Ground Coffee, 16oz","image":"https://www.example.com/products/ground_coffee_dark","description":"Our delicious coffee blend is ground from the finest Colombian beans, guaranteeing you the best cup of coffee you\'ve had!","visible":true,"quantity":1,"taxable":true,"line_item_key":"ERQ-GND-16_1","sku":"ERQGND16","platform_variant_id":"e7ba4c75-b1bb-483d-94d8-2c4a10f78472","requires_shipping":true,"weight_unit":"oz","tax_code":"PF050211","note":"Extra-fine ground requested","volume_unit":"bag","unit_price":1299,"item_weight":16,"vendor":"Example Enterprises","properties":{"grind":"extra-fine","roast":"dark"},"taxes":[{"name":"GST","rate":0.05,"unit_amount":64.95}],"discounts":[{"text":"First time buyer - 10% off","unit_amount":136.4,"code":"FIRSTTIMER_PR45TY90","source":"cart"},{"text":"Spring Sale - $5.00 off","unit_amount":5,"code":"SPRING2023_E44J23","source":"coupon"}]}],"customer":{"platform_id":"836206","public_id":"TwyAWDwCkrdZqbifdcF6XAZjLgDEeyK4j0d4qani2exHwaQYl4jZzLhVciqenJ4T","first_name":"Carl","last_name":"Smith","email_address":"carl.smith@example.com","accepts_marketing":true},"shipping_address":{"first_name":"Carl","last_name":"Smith","address_line_1":"50 Fultz Boulevard","address_line_2":"Unit 2","city":"Winnipeg","province":"Manitoba","province_code":"MB","country":"Canada","country_code":"CA","postal_code":"R3Y 0L6","business_name":"Bold Commerce","phone_number":"204-808-8095"},"billing_address":{"first_name":"Carl","last_name":"Smith","address_line_1":"50 Fultz Boulevard","address_line_2":"Unit 2","city":"Winnipeg","province":"Manitoba","province_code":"MB","country":"Canada","country_code":"CA","postal_code":"R3Y 0L6","business_name":"Bold Commerce","phone_number":"204-808-8095"},"shipping_options":[{"rate_name":"Standard Shipping","cost":500,"code":"SHIPPING_AR36F"},{"rate_name":"Expedited Shipping","cost":2499,"code":"SHIPPING_P3R44"}],"selected_shipping":{"rate_name":"Standard Shipping","cost":500,"code":"SHIPPING_AR36F","taxes":[{"name":"GST","rate":0.05,"unit_amount":25}]},"tags":["Wholesale","Order Packed"],"fees":[{"description":"Convenience fee","value":150,"taxable":true}],"notes":["Customer called to clarify delivery date on October 12th"],"cart_params":{"customer_first_name":"Carl","customer_last_name":"Smith","shirt_size":"XL"}},"events":[{"event_name":"estimate_shipping","data":{"first_name":"Carl","last_name":"Smith","address_line_1":"50 Fultz Boulevard","address_line_2":"Unit 2","city":"Winnipeg","province":"Manitoba","province_code":"MB","country":"Canada","country_code":"CA","postal_code":"R3Y 0L6","business_name":"Bold Commerce","phone_number":"204-808-8095"}}]}},"SetShippingLine":{"value":{"cart_id":"R1F6BiWNxI0Gg9WMfSZtMkTiUoFSlBD6","public_order_id":"SpMIhOL7Q36EDZUagB5GnnPh4TUb9zW9t0DGrWd8PvrwdV1S1PhGpf9wFIJRyZEi","order_state":{"cart_id":"R1F6BiWNxI0Gg9WMfSZtMkTiUoFSlBD6","line_items":[{"title":"Ground Coffee, 16oz","image":"https://www.example.com/products/ground_coffee_dark","description":"Our delicious coffee blend is ground from the finest Colombian beans, guaranteeing you the best cup of coffee you\'ve had!","visible":true,"quantity":1,"taxable":true,"line_item_key":"ERQ-GND-16_1","sku":"ERQGND16","platform_variant_id":"e7ba4c75-b1bb-483d-94d8-2c4a10f78472","requires_shipping":true,"weight_unit":"oz","tax_code":"PF050211","note":"Extra-fine ground requested","volume_unit":"bag","unit_price":1299,"item_weight":16,"vendor":"Example Enterprises","properties":{"grind":"extra-fine","roast":"dark"},"taxes":[{"name":"GST","rate":0.05,"unit_amount":64.95}],"discounts":[{"text":"First time buyer - 10% off","unit_amount":136.4,"code":"FIRSTTIMER_PR45TY90","source":"cart"},{"text":"Spring Sale - $5.00 off","unit_amount":5,"code":"SPRING2023_E44J23","source":"coupon"}]}],"customer":{"platform_id":"836206","public_id":"TwyAWDwCkrdZqbifdcF6XAZjLgDEeyK4j0d4qani2exHwaQYl4jZzLhVciqenJ4T","first_name":"Carl","last_name":"Smith","email_address":"carl.smith@example.com","accepts_marketing":true},"shipping_address":{"first_name":"Carl","last_name":"Smith","address_line_1":"50 Fultz Boulevard","address_line_2":"Unit 2","city":"Winnipeg","province":"Manitoba","province_code":"MB","country":"Canada","country_code":"CA","postal_code":"R3Y 0L6","business_name":"Bold Commerce","phone_number":"204-808-8095"},"billing_address":{"first_name":"Carl","last_name":"Smith","address_line_1":"50 Fultz Boulevard","address_line_2":"Unit 2","city":"Winnipeg","province":"Manitoba","province_code":"MB","country":"Canada","country_code":"CA","postal_code":"R3Y 0L6","business_name":"Bold Commerce","phone_number":"204-808-8095"},"shipping_options":[{"rate_name":"Standard Shipping","cost":500,"code":"SHIPPING_AR36F"},{"rate_name":"Expedited Shipping","cost":2499,"code":"SHIPPING_P3R44"}],"selected_shipping":{"rate_name":"Standard Shipping","cost":500,"code":"SHIPPING_AR36F","taxes":[{"name":"GST","rate":0.05,"unit_amount":25}]},"tags":["Wholesale","Order Packed"],"fees":[{"description":"Convenience fee","value":150,"taxable":true}],"notes":["Customer called to clarify delivery date on October 12th"],"cart_params":{"customer_first_name":"Carl","customer_last_name":"Smith","shirt_size":"XL"}},"events":[{"event_name":"set_shipping_line","data":{"index":1}}]}},"GetShippingLines":{"value":{"cart_id":"R1F6BiWNxI0Gg9WMfSZtMkTiUoFSlBD6","public_order_id":"SpMIhOL7Q36EDZUagB5GnnPh4TUb9zW9t0DGrWd8PvrwdV1S1PhGpf9wFIJRyZEi","order_state":{"cart_id":"R1F6BiWNxI0Gg9WMfSZtMkTiUoFSlBD6","line_items":[{"title":"Ground Coffee, 16oz","image":"https://www.example.com/products/ground_coffee_dark","description":"Our delicious coffee blend is ground from the finest Colombian beans, guaranteeing you the best cup of coffee you\'ve had!","visible":true,"quantity":1,"taxable":true,"line_item_key":"ERQ-GND-16_1","sku":"ERQGND16","platform_variant_id":"e7ba4c75-b1bb-483d-94d8-2c4a10f78472","requires_shipping":true,"weight_unit":"oz","tax_code":"PF050211","note":"Extra-fine ground requested","volume_unit":"bag","unit_price":1299,"item_weight":16,"vendor":"Example Enterprises","properties":{"grind":"extra-fine","roast":"dark"},"taxes":[{"name":"GST","rate":0.05,"unit_amount":64.95}],"discounts":[{"text":"First time buyer - 10% off","unit_amount":136.4,"code":"FIRSTTIMER_PR45TY90","source":"cart"},{"text":"Spring Sale - $5.00 off","unit_amount":5,"code":"SPRING2023_E44J23","source":"coupon"}]}],"customer":{"platform_id":"836206","public_id":"TwyAWDwCkrdZqbifdcF6XAZjLgDEeyK4j0d4qani2exHwaQYl4jZzLhVciqenJ4T","first_name":"Carl","last_name":"Smith","email_address":"carl.smith@example.com","accepts_marketing":true},"shipping_address":{"first_name":"Carl","last_name":"Smith","address_line_1":"50 Fultz Boulevard","address_line_2":"Unit 2","city":"Winnipeg","province":"Manitoba","province_code":"MB","country":"Canada","country_code":"CA","postal_code":"R3Y 0L6","business_name":"Bold Commerce","phone_number":"204-808-8095"},"billing_address":{"first_name":"Carl","last_name":"Smith","address_line_1":"50 Fultz Boulevard","address_line_2":"Unit 2","city":"Winnipeg","province":"Manitoba","province_code":"MB","country":"Canada","country_code":"CA","postal_code":"R3Y 0L6","business_name":"Bold Commerce","phone_number":"204-808-8095"},"shipping_options":[{"rate_name":"Standard Shipping","cost":500,"code":"SHIPPING_AR36F"},{"rate_name":"Expedited Shipping","cost":2499,"code":"SHIPPING_P3R44"}],"selected_shipping":{"rate_name":"Standard Shipping","cost":500,"code":"SHIPPING_AR36F","taxes":[{"name":"GST","rate":0.05,"unit_amount":25}]},"tags":["Wholesale","Order Packed"],"fees":[{"description":"Convenience fee","value":150,"taxable":true}],"notes":["Customer called to clarify delivery date on October 12th"],"cart_params":{"customer_first_name":"Carl","customer_last_name":"Smith","shirt_size":"XL"}},"events":[{"event_name":"get_shipping_lines","data":{}}]}},"EstimateTaxes":{"value":{"cart_id":"R1F6BiWNxI0Gg9WMfSZtMkTiUoFSlBD6","public_order_id":"SpMIhOL7Q36EDZUagB5GnnPh4TUb9zW9t0DGrWd8PvrwdV1S1PhGpf9wFIJRyZEi","order_state":{"cart_id":"R1F6BiWNxI0Gg9WMfSZtMkTiUoFSlBD6","line_items":[{"title":"Ground Coffee, 16oz","image":"https://www.example.com/products/ground_coffee_dark","description":"Our delicious coffee blend is ground from the finest Colombian beans, guaranteeing you the best cup of coffee you\'ve had!","visible":true,"quantity":1,"taxable":true,"line_item_key":"ERQ-GND-16_1","sku":"ERQGND16","platform_variant_id":"e7ba4c75-b1bb-483d-94d8-2c4a10f78472","requires_shipping":true,"weight_unit":"oz","tax_code":"PF050211","note":"Extra-fine ground requested","volume_unit":"bag","unit_price":1299,"item_weight":16,"vendor":"Example Enterprises","properties":{"grind":"extra-fine","roast":"dark"},"taxes":[{"name":"GST","rate":0.05,"unit_amount":64.95}],"discounts":[{"text":"First time buyer - 10% off","unit_amount":136.4,"code":"FIRSTTIMER_PR45TY90","source":"cart"},{"text":"Spring Sale - $5.00 off","unit_amount":5,"code":"SPRING2023_E44J23","source":"coupon"}]}],"customer":{"platform_id":"836206","public_id":"TwyAWDwCkrdZqbifdcF6XAZjLgDEeyK4j0d4qani2exHwaQYl4jZzLhVciqenJ4T","first_name":"Carl","last_name":"Smith","email_address":"carl.smith@example.com","accepts_marketing":true},"shipping_address":{"first_name":"Carl","last_name":"Smith","address_line_1":"50 Fultz Boulevard","address_line_2":"Unit 2","city":"Winnipeg","province":"Manitoba","province_code":"MB","country":"Canada","country_code":"CA","postal_code":"R3Y 0L6","business_name":"Bold Commerce","phone_number":"204-808-8095"},"billing_address":{"first_name":"Carl","last_name":"Smith","address_line_1":"50 Fultz Boulevard","address_line_2":"Unit 2","city":"Winnipeg","province":"Manitoba","province_code":"MB","country":"Canada","country_code":"CA","postal_code":"R3Y 0L6","business_name":"Bold Commerce","phone_number":"204-808-8095"},"shipping_options":[{"rate_name":"Standard Shipping","cost":500,"code":"SHIPPING_AR36F"},{"rate_name":"Expedited Shipping","cost":2499,"code":"SHIPPING_P3R44"}],"selected_shipping":{"rate_name":"Standard Shipping","cost":500,"code":"SHIPPING_AR36F","taxes":[{"name":"GST","rate":0.05,"unit_amount":25}]},"tags":["Wholesale","Order Packed"],"fees":[{"description":"Convenience fee","value":150,"taxable":true}],"notes":["Customer called to clarify delivery date on October 12th"],"cart_params":{"customer_first_name":"Carl","customer_last_name":"Smith","shirt_size":"XL"}},"events":[{"event_name":"estimate_tax","data":{"first_name":"Carl","last_name":"Smith","address_line_1":"50 Fultz Boulevard","address_line_2":"Unit 2","city":"Winnipeg","province":"Manitoba","province_code":"MB","country":"Canada","country_code":"CA","postal_code":"R3Y 0L6","business_name":"Bold Commerce","phone_number":"204-808-8095"}}]}},"ApplyTaxes":{"value":{"cart_id":"R1F6BiWNxI0Gg9WMfSZtMkTiUoFSlBD6","public_order_id":"SpMIhOL7Q36EDZUagB5GnnPh4TUb9zW9t0DGrWd8PvrwdV1S1PhGpf9wFIJRyZEi","order_state":{"cart_id":"R1F6BiWNxI0Gg9WMfSZtMkTiUoFSlBD6","line_items":[{"title":"Ground Coffee, 16oz","image":"https://www.example.com/products/ground_coffee_dark","description":"Our delicious coffee blend is ground from the finest Colombian beans, guaranteeing you the best cup of coffee you\'ve had!","visible":true,"quantity":1,"taxable":true,"line_item_key":"ERQ-GND-16_1","sku":"ERQGND16","platform_variant_id":"e7ba4c75-b1bb-483d-94d8-2c4a10f78472","requires_shipping":true,"weight_unit":"oz","tax_code":"PF050211","note":"Extra-fine ground requested","volume_unit":"bag","unit_price":1299,"item_weight":16,"vendor":"Example Enterprises","properties":{"grind":"extra-fine","roast":"dark"},"taxes":[{"name":"GST","rate":0.05,"unit_amount":64.95}],"discounts":[{"text":"First time buyer - 10% off","unit_amount":136.4,"code":"FIRSTTIMER_PR45TY90","source":"cart"},{"text":"Spring Sale - $5.00 off","unit_amount":5,"code":"SPRING2023_E44J23","source":"coupon"}]}],"customer":{"platform_id":"836206","public_id":"TwyAWDwCkrdZqbifdcF6XAZjLgDEeyK4j0d4qani2exHwaQYl4jZzLhVciqenJ4T","first_name":"Carl","last_name":"Smith","email_address":"carl.smith@example.com","accepts_marketing":true},"shipping_address":{"first_name":"Carl","last_name":"Smith","address_line_1":"50 Fultz Boulevard","address_line_2":"Unit 2","city":"Winnipeg","province":"Manitoba","province_code":"MB","country":"Canada","country_code":"CA","postal_code":"R3Y 0L6","business_name":"Bold Commerce","phone_number":"204-808-8095"},"billing_address":{"first_name":"Carl","last_name":"Smith","address_line_1":"50 Fultz Boulevard","address_line_2":"Unit 2","city":"Winnipeg","province":"Manitoba","province_code":"MB","country":"Canada","country_code":"CA","postal_code":"R3Y 0L6","business_name":"Bold Commerce","phone_number":"204-808-8095"},"shipping_options":[{"rate_name":"Standard Shipping","cost":500,"code":"SHIPPING_AR36F"},{"rate_name":"Expedited Shipping","cost":2499,"code":"SHIPPING_P3R44"}],"selected_shipping":{"rate_name":"Standard Shipping","cost":500,"code":"SHIPPING_AR36F","taxes":[{"name":"GST","rate":0.05,"unit_amount":25}]},"tags":["Wholesale","Order Packed"],"fees":[{"description":"Convenience fee","value":150,"taxable":true}],"notes":["Customer called to clarify delivery date on October 12th"],"cart_params":{"customer_first_name":"Carl","customer_last_name":"Smith","shirt_size":"XL"}},"events":[{"event_name":"apply_taxes","data":{}}]}},"AddDiscountCode":{"value":{"cart_id":"R1F6BiWNxI0Gg9WMfSZtMkTiUoFSlBD6","public_order_id":"SpMIhOL7Q36EDZUagB5GnnPh4TUb9zW9t0DGrWd8PvrwdV1S1PhGpf9wFIJRyZEi","order_state":{"cart_id":"R1F6BiWNxI0Gg9WMfSZtMkTiUoFSlBD6","line_items":[{"title":"Ground Coffee, 16oz","image":"https://www.example.com/products/ground_coffee_dark","description":"Our delicious coffee blend is ground from the finest Colombian beans, guaranteeing you the best cup of coffee you\'ve had!","visible":true,"quantity":1,"taxable":true,"line_item_key":"ERQ-GND-16_1","sku":"ERQGND16","platform_variant_id":"e7ba4c75-b1bb-483d-94d8-2c4a10f78472","requires_shipping":true,"weight_unit":"oz","tax_code":"PF050211","note":"Extra-fine ground requested","volume_unit":"bag","unit_price":1299,"item_weight":16,"vendor":"Example Enterprises","properties":{"grind":"extra-fine","roast":"dark"},"taxes":[{"name":"GST","rate":0.05,"unit_amount":64.95}],"discounts":[{"text":"First time buyer - 10% off","unit_amount":136.4,"code":"FIRSTTIMER_PR45TY90","source":"cart"},{"text":"Spring Sale - $5.00 off","unit_amount":5,"code":"SPRING2023_E44J23","source":"coupon"}]}],"customer":{"platform_id":"836206","public_id":"TwyAWDwCkrdZqbifdcF6XAZjLgDEeyK4j0d4qani2exHwaQYl4jZzLhVciqenJ4T","first_name":"Carl","last_name":"Smith","email_address":"carl.smith@example.com","accepts_marketing":true},"shipping_address":{"first_name":"Carl","last_name":"Smith","address_line_1":"50 Fultz Boulevard","address_line_2":"Unit 2","city":"Winnipeg","province":"Manitoba","province_code":"MB","country":"Canada","country_code":"CA","postal_code":"R3Y 0L6","business_name":"Bold Commerce","phone_number":"204-808-8095"},"billing_address":{"first_name":"Carl","last_name":"Smith","address_line_1":"50 Fultz Boulevard","address_line_2":"Unit 2","city":"Winnipeg","province":"Manitoba","province_code":"MB","country":"Canada","country_code":"CA","postal_code":"R3Y 0L6","business_name":"Bold Commerce","phone_number":"204-808-8095"},"shipping_options":[{"rate_name":"Standard Shipping","cost":500,"code":"SHIPPING_AR36F"},{"rate_name":"Expedited Shipping","cost":2499,"code":"SHIPPING_P3R44"}],"selected_shipping":{"rate_name":"Standard Shipping","cost":500,"code":"SHIPPING_AR36F","taxes":[{"name":"GST","rate":0.05,"unit_amount":25}]},"tags":["Wholesale","Order Packed"],"fees":[{"description":"Convenience fee","value":150,"taxable":true}],"notes":["Customer called to clarify delivery date on October 12th"],"cart_params":{"customer_first_name":"Carl","customer_last_name":"Smith","shirt_size":"XL"}},"events":[{"event_name":"add_discount_code","data":{"discount_code":"SPRINGSALE2022_Q8RT4"}}]}},"RemoveDiscountCode":{"value":{"cart_id":"R1F6BiWNxI0Gg9WMfSZtMkTiUoFSlBD6","public_order_id":"SpMIhOL7Q36EDZUagB5GnnPh4TUb9zW9t0DGrWd8PvrwdV1S1PhGpf9wFIJRyZEi","order_state":{"cart_id":"R1F6BiWNxI0Gg9WMfSZtMkTiUoFSlBD6","line_items":[{"title":"Ground Coffee, 16oz","image":"https://www.example.com/products/ground_coffee_dark","description":"Our delicious coffee blend is ground from the finest Colombian beans, guaranteeing you the best cup of coffee you\'ve had!","visible":true,"quantity":1,"taxable":true,"line_item_key":"ERQ-GND-16_1","sku":"ERQGND16","platform_variant_id":"e7ba4c75-b1bb-483d-94d8-2c4a10f78472","requires_shipping":true,"weight_unit":"oz","tax_code":"PF050211","note":"Extra-fine ground requested","volume_unit":"bag","unit_price":1299,"item_weight":16,"vendor":"Example Enterprises","properties":{"grind":"extra-fine","roast":"dark"},"taxes":[{"name":"GST","rate":0.05,"unit_amount":64.95}],"discounts":[{"text":"First time buyer - 10% off","unit_amount":136.4,"code":"FIRSTTIMER_PR45TY90","source":"cart"},{"text":"Spring Sale - $5.00 off","unit_amount":5,"code":"SPRING2023_E44J23","source":"coupon"}]}],"customer":{"platform_id":"836206","public_id":"TwyAWDwCkrdZqbifdcF6XAZjLgDEeyK4j0d4qani2exHwaQYl4jZzLhVciqenJ4T","first_name":"Carl","last_name":"Smith","email_address":"carl.smith@example.com","accepts_marketing":true},"shipping_address":{"first_name":"Carl","last_name":"Smith","address_line_1":"50 Fultz Boulevard","address_line_2":"Unit 2","city":"Winnipeg","province":"Manitoba","province_code":"MB","country":"Canada","country_code":"CA","postal_code":"R3Y 0L6","business_name":"Bold Commerce","phone_number":"204-808-8095"},"billing_address":{"first_name":"Carl","last_name":"Smith","address_line_1":"50 Fultz Boulevard","address_line_2":"Unit 2","city":"Winnipeg","province":"Manitoba","province_code":"MB","country":"Canada","country_code":"CA","postal_code":"R3Y 0L6","business_name":"Bold Commerce","phone_number":"204-808-8095"},"shipping_options":[{"rate_name":"Standard Shipping","cost":500,"code":"SHIPPING_AR36F"},{"rate_name":"Expedited Shipping","cost":2499,"code":"SHIPPING_P3R44"}],"selected_shipping":{"rate_name":"Standard Shipping","cost":500,"code":"SHIPPING_AR36F","taxes":[{"name":"GST","rate":0.05,"unit_amount":25}]},"tags":["Wholesale","Order Packed"],"fees":[{"description":"Convenience fee","value":150,"taxable":true}],"notes":["Customer called to clarify delivery date on October 12th"],"cart_params":{"customer_first_name":"Carl","customer_last_name":"Smith","shirt_size":"XL"}},"events":[{"event_name":"remove_discount_code","data":{"discount_code":"SPRINGSALE2022_Q8RT4"}}]}},"AddLineItem":{"value":{"cart_id":"R1F6BiWNxI0Gg9WMfSZtMkTiUoFSlBD6","public_order_id":"SpMIhOL7Q36EDZUagB5GnnPh4TUb9zW9t0DGrWd8PvrwdV1S1PhGpf9wFIJRyZEi","order_state":{"cart_id":"R1F6BiWNxI0Gg9WMfSZtMkTiUoFSlBD6","line_items":[{"title":"Ground Coffee, 16oz","image":"https://www.example.com/products/ground_coffee_dark","description":"Our delicious coffee blend is ground from the finest Colombian beans, guaranteeing you the best cup of coffee you\'ve had!","visible":true,"quantity":1,"taxable":true,"line_item_key":"ERQ-GND-16_1","sku":"ERQGND16","platform_variant_id":"e7ba4c75-b1bb-483d-94d8-2c4a10f78472","requires_shipping":true,"weight_unit":"oz","tax_code":"PF050211","note":"Extra-fine ground requested","volume_unit":"bag","unit_price":1299,"item_weight":16,"vendor":"Example Enterprises","properties":{"grind":"extra-fine","roast":"dark"},"taxes":[{"name":"GST","rate":0.05,"unit_amount":64.95}],"discounts":[{"text":"First time buyer - 10% off","unit_amount":136.4,"code":"FIRSTTIMER_PR45TY90","source":"cart"},{"text":"Spring Sale - $5.00 off","unit_amount":5,"code":"SPRING2023_E44J23","source":"coupon"}]}],"customer":{"platform_id":"836206","public_id":"TwyAWDwCkrdZqbifdcF6XAZjLgDEeyK4j0d4qani2exHwaQYl4jZzLhVciqenJ4T","first_name":"Carl","last_name":"Smith","email_address":"carl.smith@example.com","accepts_marketing":true},"shipping_address":{"first_name":"Carl","last_name":"Smith","address_line_1":"50 Fultz Boulevard","address_line_2":"Unit 2","city":"Winnipeg","province":"Manitoba","province_code":"MB","country":"Canada","country_code":"CA","postal_code":"R3Y 0L6","business_name":"Bold Commerce","phone_number":"204-808-8095"},"billing_address":{"first_name":"Carl","last_name":"Smith","address_line_1":"50 Fultz Boulevard","address_line_2":"Unit 2","city":"Winnipeg","province":"Manitoba","province_code":"MB","country":"Canada","country_code":"CA","postal_code":"R3Y 0L6","business_name":"Bold Commerce","phone_number":"204-808-8095"},"shipping_options":[{"rate_name":"Standard Shipping","cost":500,"code":"SHIPPING_AR36F"},{"rate_name":"Expedited Shipping","cost":2499,"code":"SHIPPING_P3R44"}],"selected_shipping":{"rate_name":"Standard Shipping","cost":500,"code":"SHIPPING_AR36F","taxes":[{"name":"GST","rate":0.05,"unit_amount":25}]},"tags":["Wholesale","Order Packed"],"fees":[{"description":"Convenience fee","value":150,"taxable":true}],"notes":["Customer called to clarify delivery date on October 12th"],"cart_params":{"customer_first_name":"Carl","customer_last_name":"Smith","shirt_size":"XL"}},"events":[{"event_name":"add_line_item","data":{"line_item_key":"HOCUS_14_ARC3_1","quantity":1,"sku":"HOCUS_14_ARC3"}}]}},"UpdateLineItem":{"value":{"cart_id":"R1F6BiWNxI0Gg9WMfSZtMkTiUoFSlBD6","public_order_id":"SpMIhOL7Q36EDZUagB5GnnPh4TUb9zW9t0DGrWd8PvrwdV1S1PhGpf9wFIJRyZEi","order_state":{"cart_id":"R1F6BiWNxI0Gg9WMfSZtMkTiUoFSlBD6","line_items":[{"title":"Ground Coffee, 16oz","image":"https://www.example.com/products/ground_coffee_dark","description":"Our delicious coffee blend is ground from the finest Colombian beans, guaranteeing you the best cup of coffee you\'ve had!","visible":true,"quantity":1,"taxable":true,"line_item_key":"ERQ-GND-16_1","sku":"ERQGND16","platform_variant_id":"e7ba4c75-b1bb-483d-94d8-2c4a10f78472","requires_shipping":true,"weight_unit":"oz","tax_code":"PF050211","note":"Extra-fine ground requested","volume_unit":"bag","unit_price":1299,"item_weight":16,"vendor":"Example Enterprises","properties":{"grind":"extra-fine","roast":"dark"},"taxes":[{"name":"GST","rate":0.05,"unit_amount":64.95}],"discounts":[{"text":"First time buyer - 10% off","unit_amount":136.4,"code":"FIRSTTIMER_PR45TY90","source":"cart"},{"text":"Spring Sale - $5.00 off","unit_amount":5,"code":"SPRING2023_E44J23","source":"coupon"}]}],"customer":{"platform_id":"836206","public_id":"TwyAWDwCkrdZqbifdcF6XAZjLgDEeyK4j0d4qani2exHwaQYl4jZzLhVciqenJ4T","first_name":"Carl","last_name":"Smith","email_address":"carl.smith@example.com","accepts_marketing":true},"shipping_address":{"first_name":"Carl","last_name":"Smith","address_line_1":"50 Fultz Boulevard","address_line_2":"Unit 2","city":"Winnipeg","province":"Manitoba","province_code":"MB","country":"Canada","country_code":"CA","postal_code":"R3Y 0L6","business_name":"Bold Commerce","phone_number":"204-808-8095"},"billing_address":{"first_name":"Carl","last_name":"Smith","address_line_1":"50 Fultz Boulevard","address_line_2":"Unit 2","city":"Winnipeg","province":"Manitoba","province_code":"MB","country":"Canada","country_code":"CA","postal_code":"R3Y 0L6","business_name":"Bold Commerce","phone_number":"204-808-8095"},"shipping_options":[{"rate_name":"Standard Shipping","cost":500,"code":"SHIPPING_AR36F"},{"rate_name":"Expedited Shipping","cost":2499,"code":"SHIPPING_P3R44"}],"selected_shipping":{"rate_name":"Standard Shipping","cost":500,"code":"SHIPPING_AR36F","taxes":[{"name":"GST","rate":0.05,"unit_amount":25}]},"tags":["Wholesale","Order Packed"],"fees":[{"description":"Convenience fee","value":150,"taxable":true}],"notes":["Customer called to clarify delivery date on October 12th"],"cart_params":{"customer_first_name":"Carl","customer_last_name":"Smith","shirt_size":"XL"}},"events":[{"event_name":"update_line_item","data":{"title":"Ground Coffee, 16oz","image":"https://www.example.com/products/ground_coffee_dark","description":"Our delicious coffee blend is ground from the finest Colombian beans, guaranteeing you the best cup of coffee you\'ve had!","visible":true,"quantity":4,"taxable":true,"line_item_key":"ERQ-GND-16_1","sku":"ERQGND16","platform_variant_id":"e7ba4c75-b1bb-483d-94d8-2c4a10f78472","requires_shipping":true,"item_weight":16,"weight_unit":"oz","tax_code":"PF050211","note":"Extra-fine ground requested","volume_unit":"bag","unit_price":1299,"vendor":"Example Enterprises","properties":{"grind":"extra-fine","roast":"dark"}}}]}},"RemoveLineItem":{"value":{"cart_id":"R1F6BiWNxI0Gg9WMfSZtMkTiUoFSlBD6","public_order_id":"SpMIhOL7Q36EDZUagB5GnnPh4TUb9zW9t0DGrWd8PvrwdV1S1PhGpf9wFIJRyZEi","order_state":{"cart_id":"R1F6BiWNxI0Gg9WMfSZtMkTiUoFSlBD6","line_items":[{"title":"Ground Coffee, 16oz","image":"https://www.example.com/products/ground_coffee_dark","description":"Our delicious coffee blend is ground from the finest Colombian beans, guaranteeing you the best cup of coffee you\'ve had!","visible":true,"quantity":1,"taxable":true,"line_item_key":"ERQ-GND-16_1","sku":"ERQGND16","platform_variant_id":"e7ba4c75-b1bb-483d-94d8-2c4a10f78472","requires_shipping":true,"weight_unit":"oz","tax_code":"PF050211","note":"Extra-fine ground requested","volume_unit":"bag","unit_price":1299,"item_weight":16,"vendor":"Example Enterprises","properties":{"grind":"extra-fine","roast":"dark"},"taxes":[{"name":"GST","rate":0.05,"unit_amount":64.95}],"discounts":[{"text":"First time buyer - 10% off","unit_amount":136.4,"code":"FIRSTTIMER_PR45TY90","source":"cart"},{"text":"Spring Sale - $5.00 off","unit_amount":5,"code":"SPRING2023_E44J23","source":"coupon"}]}],"customer":{"platform_id":"836206","public_id":"TwyAWDwCkrdZqbifdcF6XAZjLgDEeyK4j0d4qani2exHwaQYl4jZzLhVciqenJ4T","first_name":"Carl","last_name":"Smith","email_address":"carl.smith@example.com","accepts_marketing":true},"shipping_address":{"first_name":"Carl","last_name":"Smith","address_line_1":"50 Fultz Boulevard","address_line_2":"Unit 2","city":"Winnipeg","province":"Manitoba","province_code":"MB","country":"Canada","country_code":"CA","postal_code":"R3Y 0L6","business_name":"Bold Commerce","phone_number":"204-808-8095"},"billing_address":{"first_name":"Carl","last_name":"Smith","address_line_1":"50 Fultz Boulevard","address_line_2":"Unit 2","city":"Winnipeg","province":"Manitoba","province_code":"MB","country":"Canada","country_code":"CA","postal_code":"R3Y 0L6","business_name":"Bold Commerce","phone_number":"204-808-8095"},"shipping_options":[{"rate_name":"Standard Shipping","cost":500,"code":"SHIPPING_AR36F"},{"rate_name":"Expedited Shipping","cost":2499,"code":"SHIPPING_P3R44"}],"selected_shipping":{"rate_name":"Standard Shipping","cost":500,"code":"SHIPPING_AR36F","taxes":[{"name":"GST","rate":0.05,"unit_amount":25}]},"tags":["Wholesale","Order Packed"],"fees":[{"description":"Convenience fee","value":150,"taxable":true}],"notes":["Customer called to clarify delivery date on October 12th"],"cart_params":{"customer_first_name":"Carl","customer_last_name":"Smith","shirt_size":"XL"}},"events":[{"event_name":"remove_line_item","data":{"line_item_key":"ERQ-GND-16_1"}}]}},"MultipleEvents":{"description":"Multiple events may be sent at the same time. In this case, the RSA must process the events in the order received.","value":{"cart_id":"R1F6BiWNxI0Gg9WMfSZtMkTiUoFSlBD6","public_order_id":"SpMIhOL7Q36EDZUagB5GnnPh4TUb9zW9t0DGrWd8PvrwdV1S1PhGpf9wFIJRyZEi","order_state":{"cart_id":"R1F6BiWNxI0Gg9WMfSZtMkTiUoFSlBD6","line_items":[{"title":"Ground Coffee, 16oz","image":"https://www.example.com/products/ground_coffee_dark","description":"Our delicious coffee blend is ground from the finest Colombian beans, guaranteeing you the best cup of coffee you\'ve had!","visible":true,"quantity":1,"taxable":true,"line_item_key":"ERQ-GND-16_1","sku":"ERQGND16","platform_variant_id":"e7ba4c75-b1bb-483d-94d8-2c4a10f78472","requires_shipping":true,"weight_unit":"oz","tax_code":"PF050211","note":"Extra-fine ground requested","volume_unit":"bag","unit_price":1299,"item_weight":16,"vendor":"Example Enterprises","properties":{"grind":"extra-fine","roast":"dark"},"taxes":[{"name":"GST","rate":0.05,"unit_amount":64.95}],"discounts":[{"text":"First time buyer - 10% off","unit_amount":136.4,"code":"FIRSTTIMER_PR45TY90","source":"cart"},{"text":"Spring Sale - $5.00 off","unit_amount":5,"code":"SPRING2023_E44J23","source":"coupon"}]}],"customer":{"platform_id":"836206","public_id":"TwyAWDwCkrdZqbifdcF6XAZjLgDEeyK4j0d4qani2exHwaQYl4jZzLhVciqenJ4T","first_name":"Carl","last_name":"Smith","email_address":"carl.smith@example.com","accepts_marketing":true},"shipping_address":{"first_name":"Carl","last_name":"Smith","address_line_1":"50 Fultz Boulevard","address_line_2":"Unit 2","city":"Winnipeg","province":"Manitoba","province_code":"MB","country":"Canada","country_code":"CA","postal_code":"R3Y 0L6","business_name":"Bold Commerce","phone_number":"204-808-8095"},"billing_address":{"first_name":"Carl","last_name":"Smith","address_line_1":"50 Fultz Boulevard","address_line_2":"Unit 2","city":"Winnipeg","province":"Manitoba","province_code":"MB","country":"Canada","country_code":"CA","postal_code":"R3Y 0L6","business_name":"Bold Commerce","phone_number":"204-808-8095"},"shipping_options":[{"rate_name":"Standard Shipping","cost":500,"code":"SHIPPING_AR36F"},{"rate_name":"Expedited Shipping","cost":2499,"code":"SHIPPING_P3R44"}],"selected_shipping":{"rate_name":"Standard Shipping","cost":500,"code":"SHIPPING_AR36F","taxes":[{"name":"GST","rate":0.05,"unit_amount":25}]},"tags":["Wholesale","Order Packed"],"fees":[{"description":"Convenience fee","value":150,"taxable":true}],"notes":["Customer called to clarify delivery date on October 12th"],"cart_params":{"customer_first_name":"Carl","customer_last_name":"Smith","shirt_size":"XL"}},"events":[{"event_name":"set_shipping_address","data":{"first_name":"Carl","last_name":"Smith","address_line_1":"50 Fultz Boulevard","address_line_2":"Unit 2","city":"Winnipeg","province":"Manitoba","province_code":"MB","country":"Canada","country_code":"CA","postal_code":"R3Y 0L6","business_name":"Bold Commerce","phone_number":"204-808-8095"}},{"event_name":"remove_discount_code","data":{"discount_code":"SPRINGSALE2022_Q8RT4"}}]}}}}}},"responses":{"200":{"$ref":"#/components/responses/SuccessfulRequest"},"400":{"description":"Unable to process order events.","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","description":"An array of one or more errors that occurred when updating the order state.","minItems":1,"items":{"oneOf":[{"$ref":"#/components/schemas/InvalidShippingAddressField"},{"$ref":"#/components/schemas/InvalidBillingAddressField"},{"$ref":"#/components/schemas/InvalidCustomerField"},{"$ref":"#/components/schemas/InvalidShippingLine"},{"$ref":"#/components/schemas/InvalidDiscountCode"},{"$ref":"#/components/schemas/InvalidLineItemField"},{"$ref":"#/components/schemas/GeneralValidationError"}]}}}},"examples":{"InvalidShippingAddress":{"description":"Invalid fields on the set_shipping_address event.","value":{"errors":[{"event_name":"set_shipping_address","field":"address_line_1","reason":"Address line 1 is above maximum length of 65 characters."}]}},"InvalidBillingAddress":{"description":"Invalid fields on the set_billing_address event.","value":{"errors":[{"event_name":"set_billing_address","field":"address_line_1","reason":"Address line 1 is above maximum length of 65 characters."}]}},"InvalidCustomer":{"description":"Invalid fields on the set_customer event.","value":{"errors":[{"event_name":"set_customer","field":"email_address","reason":"MX record validation failed for the given email address."}]}},"InvalidShipping":{"description":"Invalid fields on the set_shipping_line event.","value":{"errors":[{"event_name":"set_shipping_line","field":"index","reason":"Unable to use Business Shipping without business name on shipping address."}]}},"InvalidDiscountCode":{"description":"Invalid fields on the add_discount_code event.","value":{"errors":[{"event_name":"add_discount_code","field":"discount_code","reason":"Discount code has expired."}]}},"GeneralValidationError":{"description":"Validation error that cannot be scoped to particular fields.","value":{"errors":[{"event_name":"set_shipping_address","reason":"Order is currently locked and unable to be edited."}]}},"MultipleValidationErrorsWithGeneralValidationError":{"description":"Multiple invalid fields when processing events, including a general validation error.","value":{"errors":[{"event_name":"set_shipping_line","field":"index","reason":"Unable to use Business Shipping without business name on shipping address."},{"event_name":"set_shipping_line","reason":"Order is currently locked and unable to be edited."}]}}}}}}},"tags":["Events"]}},"/shops/{shop_identifier}/orders/{public_order_id}/addresses/validate_address":{"post":{"summary":"Validate Address","operationId":"ValidateAddress","description":"Validates the given address. This will not apply the address, but can allow for ahead-of-time validation of particular fields.","parameters":[{"$ref":"#/components/parameters/shop_identifier"},{"$ref":"#/components/parameters/public_order_id"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Address"}}}},"responses":{"200":{"description":"Address is valid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmptyData"}}}},"400":{"description":"Address is invalid","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","description":"An array of validation errors for the given address.","minItems":1,"items":{"type":"object","properties":{"field":{"type":"string","description":"The request field containing invalid data.","enum":["first_name","last_name","address_line_1","address_line_2","city","province","province_code","country","country_code","postal_code","business_name","phone_number"],"example":"address_line_1"},"reason":{"type":"string","description":"A human-readable reason why the field is not valid.","example":"Address line 1 is above maximum length of 65 characters."}},"required":["field","reason"]}}},"required":["errors"]}}}}},"tags":["Validate"]}},"/shops/{shop_identifier}/orders/{public_order_id}/customers/validate_email_address":{"post":{"summary":"Validate Email Address","operationId":"ValidateEmailAddress","description":"Validates the customer email address. This will not add the email address to the customer, but can allow for validation before being applied.","parameters":[{"$ref":"#/components/parameters/shop_identifier"},{"$ref":"#/components/parameters/public_order_id"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"email_address":{"type":"string","description":"The email address of the customer."}},"required":["email_address"]},"example":{"email_address":"carl.smith@example.com"}}}},"responses":{"200":{"description":"Email address is valid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmptyData"}}}},"400":{"description":"Email address is not valid","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","description":"An array of validation errors for the given email address.","minItems":1,"items":{"type":"object","properties":{"field":{"type":"string","description":"The request field containing invalid data.","enum":["email_address"],"example":"email_address"},"reason":{"type":"string","description":"A human-readable reason why the field is not valid.","example":"Email address is malformed."}},"required":["field","reason"]}}},"required":["errors"]}}}}},"tags":["Validate"]}},"/shops/{shop_identifier}/orders/{public_order_id}/discounts/validate_discount_code":{"post":{"summary":"Validate Discount Code","operationId":"ValidateDiscountCode","description":"Validates the given discount code. This will not apply the discount, but can allow for validation before being applied.","parameters":[{"$ref":"#/components/parameters/shop_identifier"},{"$ref":"#/components/parameters/public_order_id"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"discount_code":{"type":"string","description":"The discount code that may be applied to the order."},"cart_id":{"type":"string","description":"The platform-defined identifier of the cart associated with the order.","example":"R1F6BiWNxI0Gg9WMfSZtMkTiUoFSlBD6"}},"required":["discount_code","cart_id"]},"example":{"discount_code":"SPRINGSALE2022_Q8RT4"}}}},"responses":{"200":{"description":"Discount code is valid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmptyData"}}}},"400":{"description":"Discount code is not valid","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","description":"An array of validation errors for the given discount code.","minItems":1,"items":{"type":"object","properties":{"field":{"type":"string","description":"The request field containing invalid data.","enum":["discount_code"],"example":"discount_code"},"reason":{"type":"string","description":"A human-readable reason why the field is not valid.","example":"Discount code has expired."}},"required":["field","reason"]}}},"required":["errors"]}}}}},"tags":["Validate"]}},"/shops/{shop_identifier}/orders/{public_order_id}/inventory/validate_inventory":{"post":{"summary":"Validate Inventory","operationId":"ValidateInventory","description":"Validates that there is sufficient inventory to fulfill the order. Bold Checkout can request an inventory check during two different order stages:\\n  - `initial`: A preliminary inventory check, typically at (but not restricted to) the beginning of the Checkout flow.\\n  - `final`: A final inventory check, which indicates that the order is being finalized and that the customer intends to complete the transaction.","parameters":[{"$ref":"#/components/parameters/shop_identifier"},{"$ref":"#/components/parameters/public_order_id"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"cart_id":{"type":"string","description":"The platform-defined identifier of the cart associated with the order.","example":"R1F6BiWNxI0Gg9WMfSZtMkTiUoFSlBD6"},"public_order_id":{"type":"string","description":"The public order identifier generated when the order is [initialized](orders#operation/InitializeOrder) within Bold Checkout.","example":"SpMIhOL7Q36EDZUagB5GnnPh4TUb9zW9t0DGrWd8PvrwdV1S1PhGpf9wFIJRyZEi"},"type":{"type":"string","description":"The type of inventory check being performed.\\n  - `initial`: A preliminary inventory check, typically at (but not restricted to) the beginning of the Checkout flow.\\n  - `final`: A final inventory check, which indicates that the order is being finalized and that the customer intends to complete the transaction.","enum":["initial","final"],"example":"final"},"items":{"type":"array","minItems":0,"items":{"type":"object","properties":{"line_item_key":{"type":"string","description":"A unique identifier, set by the merchant, serving to refer to this line item throughout Bold Checkout.","example":"ERQ-GND-16_1"},"platform_variant_id":{"type":"string","nullable":true,"description":"The identifier of the variant on the platform.","example":"e7ba4c75-b1bb-483d-94d8-2c4a10f78472"},"quantity":{"type":"integer","minimum":1,"description":"The number of units of the item present on the order.","example":2},"sku":{"type":"string","nullable":true,"description":"The stock-keeping unit (SKU) that identifies the particular product or variant.","example":"ERQGND16"},"properties":{"type":"object","nullable":true,"description":"Arbitrary properties attached to the line item.","additionalProperties":true,"example":{"grind":"extra-fine","roast":"dark"}}},"required":["line_item_key","platform_variant_id","quantity","properties"]}},"shipping_address":{"$ref":"#/components/schemas/Address"},"tags":{"type":"array","description":"Arbitrary labels to help sort and identify particular orders.","items":{"type":"string","minItems":0,"example":"Wholesale"}},"notes":{"type":"array","description":"Free text fields attached to the order.","items":{"type":"string","minItems":0,"example":"Customer called to clarify delivery date on October 12th"}},"cart_params":{"type":"object","nullable":true,"description":"Variable data to apply to the cart.","example":{"customer_first_name":"Carl","customer_last_name":"Smith","shirt_size":"XL"}}},"required":["cart_id","public_order_id","items","type","shipping_address"]}}}},"responses":{"200":{"description":"Inventory is sufficient","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmptyData"}}}},"400":{"description":"Inventory is insufficient","content":{"application/json":{"schema":{"type":"object","properties":{"insufficient_inventory":{"type":"array","description":"An array of items with insufficient quantity for the order. Any items not included are assumed to have sufficient quantity.","minItems":1,"items":{"type":"object","properties":{"line_item_key":{"type":"string","description":"A unique identifier, set by the merchant, serving to refer to this line item throughout Bold Checkout.","example":"ERQ-GND-16_1"},"available_quantity":{"type":"integer","minimum":0,"description":"The number of units of the item in stock.","example":0},"sku":{"type":"string","nullable":true,"description":"The stock-keeping unit (SKU) that identifies the particular product or variant.","example":"ERQGND16"},"platform_variant_id":{"type":"string","nullable":true,"description":"The identifier of the variant on the platform.","example":"e7ba4c75-b1bb-483d-94d8-2c4a10f78472"}},"required":["line_item_key","available_quantity"]}}},"required":["insufficient_inventory"]}}}}},"tags":["Validate"]}}},"components":{"securitySchemes":{"HMAC":{"type":"apiKey","name":"X-HMAC","in":"header","description":"An HMAC signature calculated from a predefined secret key and the value of the X-HMAC-Timestamp header, using the SHA-256 algorithm."}},"parameters":{"shop_identifier":{"schema":{"type":"string","example":"zp3oafdor9"},"name":"shop_identifier","in":"path","required":true,"description":"The identifier of the shop, which can be retrieved by making a request to the [Get Info](shops#operation/GetShopInfo) endpoint."},"public_order_id":{"schema":{"type":"string"},"name":"public_order_id","in":"path","required":true,"description":"The public order identifier generated when the order is initialized within Bold Checkout.","example":"SpMIhOL7Q36EDZUagB5GnnPh4TUb9zW9t0DGrWd8PvrwdV1S1PhGpf9wFIJRyZEi"}},"schemas":{"IncomingOrderState":{"title":"Incoming Order State","type":"object","description":"Represents the current state of the order, as calculated by Bold Checkout.","properties":{"cart_id":{"type":"string","description":"The platform-defined identifier of the cart associated with the order.","example":"R1F6BiWNxI0Gg9WMfSZtMkTiUoFSlBD6"},"line_items":{"type":"array","description":"An array of line items in the cart.","items":{"type":"object","properties":{"title":{"type":"string","description":"The title of the line item, to display to the end user.","example":"Ground Coffee, 16oz"},"quantity":{"type":"integer","minimum":1,"description":"The number of units of the item present on the order.","example":1},"line_item_key":{"type":"string","description":"A unique identifier, set by the merchant, serving to refer to this line item throughout Bold Checkout.","example":"ERQ-GND-16_1"},"unit_price":{"type":"number","description":"The cost of a single unit of the item, represented in base currency units, using [ISO-4217](https://www.iso.org/iso-4217-currency-codes.html) standards.","minimum":0,"example":1299},"image":{"type":"string","nullable":true,"description":"A link to the image of the item, displayed during checkout.","example":"https://www.example.com/products/ground_coffee_dark"},"description":{"type":"string","nullable":true,"description":"A description of the product included in the line item.","example":"Our delicious coffee blend is ground from the finest Colombian beans, guaranteeing you the best cup of coffee you\'ve had!"},"visible":{"type":"boolean","description":"Indicates whether the line item is displayed during checkout.","example":true},"taxable":{"type":"boolean","description":"Indicates whether the line item should be included in tax calculations.","example":false},"sku":{"type":"string","nullable":true,"description":"The stock-keeping unit (SKU) that identifies the particular product or variant.","example":"ERQGND16"},"platform_variant_id":{"type":"string","nullable":true,"description":"The identifier of the variant on the platform.","example":"e7ba4c75-b1bb-483d-94d8-2c4a10f78472"},"requires_shipping":{"type":"boolean","description":"Indicates whether the item requires physical shipping.","example":true},"item_weight":{"type":"number","description":"The weight of a single unit of the item.","minimum":0,"example":16},"weight_unit":{"type":"string","nullable":true,"description":"The abbreviated unit of measurement for weight of the line item. For example, g, lb, or oz.","example":"oz"},"tax_code":{"type":"string","nullable":true,"description":"The tax code of the item, which indicates tax obligations or exemptions necessary when purchasing the item.","example":"PF050211"},"note":{"type":"string","nullable":true,"description":"A free-text note associated with the line item.","example":"Extra-fine ground requested"},"volume_unit":{"type":"string","nullable":true,"description":"The measurement of units applied to the quantity. For example, \\"carton\\", \\"each\\", or \\"gallon\\".","example":"bag"},"vendor":{"type":"string","nullable":true,"description":"The vendor of the product.","example":"Example Enterprises"},"properties":{"type":"object","nullable":true,"description":"Arbitrary properties attached to the line item.","additionalProperties":true,"example":{"grind":"extra-fine","roast":"dark"}},"taxes":{"type":"array","description":"The taxes applied to a particular line item.","items":{"$ref":"#/components/schemas/IncomingTax"}},"discounts":{"type":"array","description":"Discounts applied to the line item.","items":{"type":"object","minItems":0,"properties":{"text":{"type":"string","description":"A human-readable description of the discount that can be displayed in a user interface.","example":"First time buyer - 10% off"},"unit_amount":{"type":"number","description":"The amount to discount applied to a single unit of the item, represented in base currency units, using [ISO-4217](https://www.iso.org/iso-4217-currency-codes.html) standards.","minimum":0,"example":136.4},"code":{"type":"string","description":"The user-facing discount code name.","example":"SPRINGSALE_X45T9A2"},"source":{"type":"string","enum":["cart","coupon"],"description":"The source of the discount code. Possible values are:\\n  - `cart` - there can be multiple \'cart\' discounts on each order, and these discounts cannot be removed by the end-user.\\n  - `coupon` - there can be only one `coupon` discount per order, and this can be removed by the end-user.","default":"coupon","example":"cart"}},"required":["text","unit_amount","code","source"]}}},"required":["title","quantity","line_item_key","unit_price","visible","taxable","requires_shipping","item_weight"]}},"customer":{"type":"object","description":"The customer associated with the order.","properties":{"email_address":{"type":"string","description":"The email address of the customer.","example":"carl.smith@example.com"},"platform_id":{"type":"string","description":"The platform identifier for an authenticated customer. For guest customers, the value for this property will be null.","nullable":true,"example":"836206"},"public_id":{"type":"string","description":"The public identifier generated by Checkout for a customer.","nullable":true,"example":"TwyAWDwCkrdZqbifdcF6XAZjLgDEeyK4j0d4qani2exHwaQYl4jZzLhVciqenJ4T"},"first_name":{"type":"string","description":"The first name of the customer.","nullable":true,"example":"Carl"},"last_name":{"type":"string","description":"The last name of the customer.","nullable":true,"example":"Smith"},"accepts_marketing":{"type":"boolean","description":"If the customer would like to receive any sort of marketing emails.","example":true}},"nullable":true,"required":["email_address","accepts_marketing"]},"shipping_address":{"$ref":"#/components/schemas/Address"},"billing_address":{"$ref":"#/components/schemas/Address"},"shipping_options":{"type":"array","description":"The shipping options available on the order. Shipping options will be presented in the order supplied.","minItems":0,"items":{"properties":{"rate_name":{"type":"string","description":"A human-readable description of the shipping line that can be displayed in a user interface.","example":"Standard Shipping"},"cost":{"type":"number","description":"Cost of the shipping line in base currency units, using [ISO-4217](https://www.iso.org/iso-4217-currency-codes.html) standards.","minimum":0,"example":500},"code":{"type":"string","description":"A unique identifier of the shipping rate.","example":"SHIPPING_AR36F"}},"required":["rate_name","cost","code"]}},"selected_shipping":{"type":"object","description":"Currently selected shipping option.","nullable":true,"properties":{"rate_name":{"type":"string","description":"A human-readable description of the shipping line that can be displayed in a user interface. This should match the `rate_name` of an element in `shipping_options` or no shipping will be selected.","example":"Express Shipping"},"cost":{"type":"number","description":"Cost of the shipping line in base currency units, using [ISO-4217](https://www.iso.org/iso-4217-currency-codes.html) standards.","minimum":0,"example":2499},"code":{"type":"string","description":"A unique identifier of the shipping rate.","example":"SHIPPING_AR36F"},"taxes":{"type":"array","description":"The taxes applied to the selected shipping option.","minItems":0,"items":{"$ref":"#/components/schemas/IncomingTax"}}},"required":["rate_name","cost","code"]},"tags":{"type":"array","description":"Arbitrary labels to help sort and identify particular orders.","items":{"type":"string","minItems":0,"example":"Wholesale"}},"fees":{"type":"array","description":"Fees applied to the order.","items":{"type":"object","minItems":0,"properties":{"description":{"type":"string","description":"A human-readable description of the fee that can be displayed in a user interface.","example":"Convenience fee"},"value":{"type":"integer","description":"The fee amount to apply to the order, represented in base currency units, using [ISO-4217](https://www.iso.org/iso-4217-currency-codes.html) standards.","minimum":0,"example":150},"taxable":{"type":"boolean","description":"Indicates whether to include the fee in the order total when calculating taxes.","example":true}},"required":["description","value","taxable"]}},"notes":{"type":"array","description":"Free text fields attached to the order.","items":{"type":"string","minItems":0,"example":"Customer called to clarify delivery date on October 12th"}},"cart_params":{"type":"object","nullable":true,"description":"Variable data to apply to the cart.","example":{"customer_first_name":"Carl","customer_last_name":"Smith","shirt_size":"XL"}}},"required":["cart_id","line_items","customer","shipping_address","billing_address","shipping_options","selected_shipping","tags","fees","notes","cart_params"],"example":{"cart_id":"R1F6BiWNxI0Gg9WMfSZtMkTiUoFSlBD6","line_items":[{"title":"Ground Coffee, 16oz","image":"https://www.example.com/products/ground_coffee_dark","description":"Our delicious coffee blend is ground from the finest Colombian beans, guaranteeing you the best cup of coffee you\'ve had!","visible":true,"quantity":1,"taxable":true,"line_item_key":"ERQ-GND-16_1","sku":"ERQGND16","platform_variant_id":"e7ba4c75-b1bb-483d-94d8-2c4a10f78472","requires_shipping":true,"item_weight":16,"weight_unit":"oz","tax_code":"PF050211","note":"Extra-fine ground requested","volume_unit":"bag","unit_price":1299,"vendor":"Example Enterprises","properties":{"grind":"extra-fine","roast":"dark"},"taxes":[{"name":"GST","rate":0.05,"unit_amount":64.95}],"discounts":[{"text":"First time buyer - 10% off","unit_amount":136.4,"code":"FIRSTTIMER_PR45TY90","source":"cart"},{"text":"Spring Sale - $5.00 off","unit_amount":5,"code":"SPRING2023_E44J23","source":"coupon"}]}],"customer":{"platform_id":"836206","public_id":"TwyAWDwCkrdZqbifdcF6XAZjLgDEeyK4j0d4qani2exHwaQYl4jZzLhVciqenJ4T","first_name":"Carl","last_name":"Smith","email_address":"carl.smith@example.com","accepts_marketing":true},"shipping_address":{"first_name":"Carl","last_name":"Smith","address_line_1":"50 Fultz Boulevard","address_line_2":"Unit 2","city":"Winnipeg","province":"Manitoba","province_code":"MB","country":"Canada","country_code":"CA","postal_code":"R3Y 0L6","business_name":"Bold Commerce","phone_number":"204-808-8095"},"billing_address":{"first_name":"Carl","last_name":"Smith","address_line_1":"50 Fultz Boulevard","address_line_2":"Unit 2","city":"Winnipeg","province":"Manitoba","province_code":"MB","country":"Canada","country_code":"CA","postal_code":"R3Y 0L6","business_name":"Bold Commerce","phone_number":"204-808-8095"},"shipping_options":[{"rate_name":"Standard Shipping","cost":500,"code":"SHIPPING_AR36F"},{"rate_name":"Expedited Shipping","cost":2499,"code":"SHIPPING_P3R44"}],"selected_shipping":{"rate_name":"Standard Shipping","cost":500,"code":"SHIPPING_AR36F","taxes":[{"name":"GST","rate":0.05,"unit_amount":25}]},"tags":["Wholesale","Order Packed"],"fees":[{"description":"Convenience fee","value":150,"taxable":true}],"notes":["Customer called to clarify delivery date on October 12th"],"cart_params":{"customer_first_name":"Carl","customer_last_name":"Smith","shirt_size":"XL"}}},"OutgoingOrderState":{"title":"Outgoing Order State","type":"object","description":"Represents the current state of the order, as calculated by the Remote State Authority.","properties":{"cart_id":{"type":"string","description":"The platform-defined identifier of the cart associated with the order.","example":"R1F6BiWNxI0Gg9WMfSZtMkTiUoFSlBD6"},"line_items":{"type":"array","description":"An array of line items in the cart.","items":{"type":"object","properties":{"title":{"type":"string","description":"The title of the line item, to display to the end user.","example":"Ground Coffee, 16oz"},"quantity":{"type":"integer","minimum":1,"description":"The number of units of the item present on the order.","example":1},"line_item_key":{"type":"string","description":"A unique identifier, set by the merchant, serving to refer to this line item throughout Bold Checkout.","example":"ERQ-GND-16_1"},"unit_price":{"type":"number","description":"The cost of a single unit of the item, represented in base currency units, using [ISO-4217](https://www.iso.org/iso-4217-currency-codes.html) standards.","minimum":0,"example":1299},"image":{"type":"string","nullable":true,"description":"A link to the image of the item, displayed during checkout.","example":"https://www.example.com/products/ground_coffee_dark"},"description":{"type":"string","nullable":true,"description":"A description of the product included in the line item.","example":"Our delicious coffee blend is ground from the finest Colombian beans, guaranteeing you the best cup of coffee you\'ve had!"},"visible":{"type":"boolean","default":true,"description":"Indicates whether the line item is displayed during checkout.","example":true},"taxable":{"type":"boolean","default":false,"description":"Indicates whether the line item should be included in tax calculations.","example":true},"sku":{"type":"string","description":"The stock-keeping unit (SKU) that identifies the particular product or variant.","example":"ERQGND16"},"platform_variant_id":{"type":"string","description":"The identifier of the variant on the platform.","example":"e7ba4c75-b1bb-483d-94d8-2c4a10f78472"},"requires_shipping":{"type":"boolean","default":true,"description":"Indicates whether the item requires physical shipping.","example":true},"item_weight":{"type":"number","description":"The weight of a single unit of the item.","minimum":0,"example":16},"weight_unit":{"type":"string","nullable":true,"description":"The abbreviated unit of measurement for weight of the line item. For example, g, lb, or oz.","default":"g","example":"oz"},"tax_code":{"type":"string","nullable":true,"description":"The tax code of the item, which indicates tax obligations or exemptions necessary when purchasing the item.","example":"PF050211"},"note":{"type":"string","nullable":true,"description":"A free-text note associated with the line item.","example":"Extra-fine ground requested"},"volume_unit":{"type":"string","nullable":true,"description":"The measurement of units applied to the quantity. For example, \\"carton\\", \\"each\\", or \\"gallon\\".","example":"bag"},"vendor":{"type":"string","nullable":true,"description":"The vendor of the product.","example":"Example Enterprises"},"properties":{"type":"object","nullable":true,"description":"Arbitrary properties attached to the line item.","additionalProperties":true,"example":{"grind":"extra-fine","roast":"dark"}},"taxes":{"type":"array","description":"The taxes applied to a particular line item.","minItems":0,"items":{"$ref":"#/components/schemas/OutgoingTax"}},"discounts":{"type":"array","description":"Discounts applied to the line item.","items":{"type":"object","minItems":0,"properties":{"text":{"type":"string","description":"A human-readable description of the discount that can be displayed in a user interface.","example":"First time buyer - 10% off"},"unit_amount":{"type":"number","description":"The amount to discount applied to a single unit of the item, represented in base currency units, using [ISO-4217](https://www.iso.org/iso-4217-currency-codes.html) standards.","minimum":0,"example":136.4},"code":{"type":"string","description":"The user-facing discount code name. Defaults to discount `text` if not given.","example":"SPRINGSALE_X45T9A2"},"source":{"type":"string","enum":["cart","coupon"],"description":"The source of the discount code. Possible values are:\\n  - `cart` - there can be multiple \'cart\' discounts on each order, and these discounts cannot be removed by the end-user.\\n  - `coupon` - there can be only one `coupon` discount per order, and this can be removed by the end-user.","default":"coupon","example":"cart"}},"required":["text","unit_amount"]}}},"required":["title","quantity","line_item_key","unit_price"]}},"customer":{"type":"object","description":"The customer associated with the order.","nullable":true,"properties":{"email_address":{"type":"string","description":"The email address of the customer.","example":"carl.smith@example.com"},"platform_id":{"type":"string","description":"The platform identifier for an authenticated customer. For guest customers, the value for this property will be null.","nullable":true,"example":"836206"},"public_id":{"type":"string","description":"The public identifier generated by Checkout for a customer.","nullable":true,"example":"TwyAWDwCkrdZqbifdcF6XAZjLgDEeyK4j0d4qani2exHwaQYl4jZzLhVciqenJ4T"},"first_name":{"type":"string","description":"The first name of the customer.","nullable":true,"example":"Carl"},"last_name":{"type":"string","description":"The last name of the customer.","nullable":true,"example":"Smith"},"accepts_marketing":{"type":"boolean","description":"If the customer would like to receive any sort of marketing emails.","default":false,"example":true}},"required":["email_address"]},"shipping_address":{"$ref":"#/components/schemas/Address"},"billing_address":{"$ref":"#/components/schemas/Address"},"shipping_options":{"type":"array","description":"The shipping options available on the order. Shipping options will be presented in the order supplied.","items":{"type":"object","minItems":0,"properties":{"rate_name":{"type":"string","description":"A human-readable description of the shipping line that can be displayed in a user interface.","example":"Standard Shipping"},"cost":{"type":"number","description":"Cost of the shipping line in base currency units, using [ISO-4217](https://www.iso.org/iso-4217-currency-codes.html) standards.","minimum":0,"example":500},"code":{"type":"string","description":"A unique identifier of the shipping rate.","example":"SHIPPING_AR36F"}},"required":["rate_name","cost","code"]}},"selected_shipping":{"type":"object","description":"Currently selected shipping option.","nullable":true,"properties":{"rate_name":{"type":"string","description":"A human-readable description of the shipping line that can be displayed in a user interface. This should match the `rate_name` of an element in `shipping_options` or no shipping will be selected.","example":"Expedited Shipping"},"cost":{"type":"number","description":"Cost of the shipping line in base currency units, using [ISO-4217](https://www.iso.org/iso-4217-currency-codes.html) standards.","minimum":0,"example":2499},"code":{"type":"string","description":"A unique identifier of the shipping rate.","example":"SHIPPING_AR36F"},"taxes":{"type":"array","description":"The taxes applied to the selected shipping option.","minItems":0,"items":{"$ref":"#/components/schemas/OutgoingTax"}}},"required":["rate_name","cost","code"]},"tags":{"type":"array","description":"Arbitrary labels to help sort and identify particular orders.","items":{"type":"string","minItems":0,"example":"Wholesale"}},"fees":{"type":"array","description":"Fees applied to the order.","items":{"type":"object","minItems":0,"properties":{"description":{"type":"string","description":"A human-readable description of the fee that can be displayed in a user interface.","example":"Convenience fee"},"value":{"type":"integer","description":"The fee amount to apply to the order, represented in base currency units, using [ISO-4217](https://www.iso.org/iso-4217-currency-codes.html) standards.","example":150},"taxable":{"type":"boolean","description":"Indicates whether to include the fee in the order total when calculating taxes.","default":false,"example":true}},"required":["description","value"]}},"notes":{"type":"array","description":"Free text fields attached to the order.","items":{"type":"string","minItems":0,"example":"Customer called to clarify delivery date on October 12th"}},"cart_params":{"type":"object","nullable":true,"description":"Variable data to apply to the cart.","example":{"customer_first_name":"Carl","customer_last_name":"Smith","shirt_size":"XL"}}},"required":["cart_id","line_items"],"example":{"cart_id":"R1F6BiWNxI0Gg9WMfSZtMkTiUoFSlBD6","line_items":[{"title":"Ground Coffee, 16oz","image":"https://www.example.com/products/ground_coffee_dark","description":"Our delicious coffee blend is ground from the finest Colombian beans, guaranteeing you the best cup of coffee you\'ve had!","visible":true,"quantity":1,"taxable":true,"line_item_key":"ERQ-GND-16_1","sku":"ERQGND16","platform_variant_id":"e7ba4c75-b1bb-483d-94d8-2c4a10f78472","requires_shipping":true,"item_weight":16,"weight_unit":"oz","tax_code":"PF050211","note":"Extra-fine ground requested","volume_unit":"bag","unit_price":1299,"vendor":"Example Enterprises","properties":{"grind":"extra-fine","roast":"dark"},"taxes":[{"name":"GST","rate":0.05,"unit_amount":64.95}],"discounts":[{"text":"First time buyer - 10% off","unit_amount":136.4,"code":"FIRSTTIMER_PR45TY90","source":"cart"},{"text":"Spring Sale - $5.00 off","unit_amount":5,"code":"SPRING2023_E44J23","source":"coupon"}]}],"customer":{"platform_id":"836206","public_id":"TwyAWDwCkrdZqbifdcF6XAZjLgDEeyK4j0d4qani2exHwaQYl4jZzLhVciqenJ4T","first_name":"Carl","last_name":"Smith","email_address":"carl.smith@example.com","accepts_marketing":true},"shipping_address":{"first_name":"Carl","last_name":"Smith","address_line_1":"50 Fultz Boulevard","address_line_2":"Unit 2","city":"Winnipeg","province":"Manitoba","province_code":"MB","country":"Canada","country_code":"CA","postal_code":"R3Y 0L6","business_name":"Bold Commerce","phone_number":"204-808-8095"},"billing_address":{"first_name":"Carl","last_name":"Smith","address_line_1":"50 Fultz Boulevard","address_line_2":"Unit 2","city":"Winnipeg","province":"Manitoba","province_code":"MB","country":"Canada","country_code":"CA","postal_code":"R3Y 0L6","business_name":"Bold Commerce","phone_number":"204-808-8095"},"shipping_options":[{"rate_name":"Standard Shipping","cost":500,"code":"SHIPPING_AR36F"},{"rate_name":"Expedited Shipping","cost":2499,"code":"SHIPPING_P3R44"}],"selected_shipping":{"rate_name":"Standard Shipping","cost":500,"code":"SHIPPING_AR36F","taxes":[{"name":"GST","rate":0.05,"unit_amount":25}]},"tags":["Wholesale","Order Packed"],"fees":[{"description":"Convenience fee","value":150,"taxable":true}],"notes":["Customer called to clarify delivery date on October 12th"],"cart_params":{"customer_first_name":"Carl","customer_last_name":"Smith","shirt_size":"XL"}}},"Address":{"title":"Address","type":"object","nullable":true,"properties":{"first_name":{"type":"string","nullable":true,"description":"First name.","example":"Carl"},"last_name":{"type":"string","nullable":true,"description":"Last name.","example":"Smith"},"address_line_1":{"type":"string","nullable":true,"description":"Line 1 of the address.","example":"50 Fultz Boulevard"},"address_line_2":{"type":"string","nullable":true,"description":"Line 2 of the address.","example":"Unit 2"},"city":{"type":"string","nullable":true,"description":"City name.","example":"Winnipeg"},"province":{"type":"string","nullable":true,"description":"Province or state name.","example":"Manitoba"},"province_code":{"type":"string","nullable":true,"description":"Province or state code, using [ISO-3166](https://www.iso.org/iso-3166-country-codes.html) standards.","example":"MB"},"country":{"type":"string","description":"Country name.","example":"Canada"},"country_code":{"type":"string","description":"Country code, using [ISO-3166](https://www.iso.org/iso-3166-country-codes.html) standards.","example":"CA"},"postal_code":{"type":"string","nullable":true,"description":"Postal/zip code.","example":"R3Y 0L6"},"business_name":{"type":"string","nullable":true,"description":"The name of the company associated with this address.","example":"Bold Commerce"},"phone_number":{"type":"string","nullable":true,"description":"Phone number.","example":"204-808-8095"}},"required":["country","country_code"]},"SetShippingAddress":{"type":"object","properties":{"event_name":{"type":"string","enum":["set_shipping_address"]},"data":{"$ref":"#/components/schemas/Address"}},"required":["event_name","data"]},"RemoveShippingAddress":{"type":"object","properties":{"event_name":{"type":"string","enum":["remove_shipping_address"]},"data":{"$ref":"#/components/schemas/EmptyData"}},"required":["event_name","data"]},"SetBillingAddress":{"type":"object","properties":{"event_name":{"type":"string","enum":["set_billing_address"]},"data":{"$ref":"#/components/schemas/Address"}},"required":["event_name","data"]},"RemoveBillingAddress":{"type":"object","properties":{"event_name":{"type":"string","enum":["remove_billing_address"]},"data":{"$ref":"#/components/schemas/EmptyData"}},"required":["event_name","data"]},"SetCustomer":{"type":"object","properties":{"event_name":{"type":"string","enum":["set_customer"]},"data":{"type":"object","properties":{"platform_id":{"type":"string","description":"The platform identifier for an authenticated customer. For guest customers, the value for this property is null.","nullable":true},"public_id":{"description":"The Checkout-generated public identifier of a customer.","type":"string"},"first_name":{"type":"string","description":"The first name of the customer."},"last_name":{"type":"string","description":"The last name of the customer."},"email_address":{"type":"string","description":"The email address of the customer."},"accepts_marketing":{"type":"boolean","default":false,"description":"If the customer would like to receive any sort of marketing emails."}},"required":["email_address"]}},"required":["event_name","data"]},"RemoveCustomer":{"type":"object","properties":{"event_name":{"type":"string","enum":["remove_customer"]},"data":{"$ref":"#/components/schemas/EmptyData"}},"required":["event_name","data"]},"SetShippingLine":{"type":"object","properties":{"event_name":{"type":"string","enum":["set_shipping_line"]},"data":{"type":"object","properties":{"index":{"type":"integer","minimum":0}},"required":["index"]}},"required":["event_name","data"]},"GetShippingLines":{"type":"object","properties":{"event_name":{"type":"string","enum":["get_shipping_lines"]},"data":{"$ref":"#/components/schemas/EmptyData"}},"required":["event_name","data"]},"ApplyTaxes":{"type":"object","properties":{"event_name":{"type":"string","enum":["apply_taxes"]},"data":{"$ref":"#/components/schemas/EmptyData"}},"required":["event_name","data"]},"AddDiscountCode":{"type":"object","properties":{"event_name":{"type":"string","enum":["add_discount_code"]},"data":{"type":"object","properties":{"discount_code":{"type":"string","description":"The discount code to apply to the order."}},"required":["discount_code"]}},"required":["event_name","data"]},"RemoveDiscountCode":{"type":"object","properties":{"event_name":{"type":"string","enum":["remove_discount_code"]},"data":{"type":"object","properties":{"discount_code":{"type":"string","description":"The discount code to apply to the order."}},"required":["discount_code"]}},"required":["event_name","data"]},"AddLineItem":{"type":"object","properties":{"event_name":{"type":"string","enum":["add_line_item"]},"data":{"allOf":[{"type":"object","properties":{"line_item_key":{"type":"string","description":"A unique identifier, set by the merchant, serving to refer to this line item throughout Bold Checkout.","example":"ERQ-GND-16_1"},"quantity":{"type":"integer","minimum":1,"description":"The number of units of the item present on the order.","example":1}},"required":["line_item_key","quantity"]},{"oneOf":[{"type":"object","title":"Item by SKU","description":"An item identified by SKU","properties":{"sku":{"type":"string","description":"The stock-keeping unit (SKU) that identifies the particular product or variant.","example":"ERQGND16"}},"required":["sku"]},{"type":"object","title":"Item by Variant ID","description":"An item identified by `platform_variant_id`","properties":{"platform_variant_id":{"type":"string","description":"The identifier of the variant on the platform.","example":"e7ba4c75-b1bb-483d-94d8-2c4a10f78472"}},"required":["platform_variant_id"]},{"type":"object","title":"Generic Item","description":"A generic line item, containing all information pertaining to that line item.","properties":{"title":{"type":"string","description":"The title of the line item, to display to the end user.","example":"Ground Coffee, 16oz"},"unit_price":{"type":"number","description":"The cost of a single unit of the item, represented in base currency units, using [ISO-4217](https://www.iso.org/iso-4217-currency-codes.html) standards.","minimum":0,"example":1299},"visible":{"type":"boolean","description":"Indicates whether the line item is displayed during checkout.","example":true},"taxable":{"type":"boolean","description":"Indicates whether the line item should be included in tax calculations.","example":false},"requires_shipping":{"type":"boolean","description":"Indicates whether the item requires physical shipping.","example":true},"item_weight":{"type":"number","description":"The weight of a single unit of the item.","minimum":0,"example":16},"weight_unit":{"type":"string","nullable":true,"description":"The abbreviated unit of measurement for weight of the line item. For example, g, lb, or oz.","example":"oz"},"image":{"type":"string","nullable":true,"description":"A link to the image of the item, displayed during checkout.","example":"https://www.example.com/products/ground_coffee_dark"},"description":{"type":"string","nullable":true,"description":"A description of the product included in the line item.","example":"Our delicious coffee blend is ground from the finest Colombian beans, guaranteeing you the best cup of coffee you\'ve had!"},"tax_code":{"type":"string","nullable":true,"description":"The tax code of the item, which indicates tax obligations or exemptions necessary when purchasing the item.","example":"PF050211"},"note":{"type":"string","nullable":true,"description":"A free-text note associated with the line item.","example":"Extra-fine ground requested"},"volume_unit":{"type":"string","nullable":true,"description":"The measurement of units applied to the quantity. For example, \\"carton\\", \\"each\\", or \\"gallon\\".","example":"bag"},"vendor":{"type":"string","nullable":true,"description":"The vendor of the product.","example":"Example Enterprises"}},"required":["title","quantity","line_item_key","unit_price","visible","taxable","requires_shipping","item_weight"]}]},{"type":"object","properties":{"properties":{"type":"object","nullable":true,"description":"Arbitrary properties attached to the line item.","additionalProperties":true,"example":{"grind":"extra-fine","roast":"dark"}}}}]}},"required":["event_name","data"]},"UpdateLineItem":{"type":"object","properties":{"event_name":{"type":"string","enum":["update_line_item"]},"data":{"type":"object","properties":{"title":{"type":"string","description":"The title of the line item, to display to the end user.","example":"Ground Coffee, 16oz"},"quantity":{"type":"integer","minimum":1,"description":"The number of units of the item present on the order.","example":1},"line_item_key":{"type":"string","description":"A unique identifier, set by the merchant, serving to refer to this line item throughout Bold Checkout.","example":"ERQ-GND-16_1"},"unit_price":{"type":"number","description":"The cost of a single unit of the item, represented in base currency units, using [ISO-4217](https://www.iso.org/iso-4217-currency-codes.html) standards.","minimum":0,"example":1299},"image":{"type":"string","nullable":true,"description":"A link to the image of the item, displayed during checkout.","example":"https://www.example.com/products/ground_coffee_dark"},"description":{"type":"string","nullable":true,"description":"A description of the product included in the line item.","example":"Our delicious coffee blend is ground from the finest Colombian beans, guaranteeing you the best cup of coffee you\'ve had!"},"visible":{"type":"boolean","default":true,"description":"Indicates whether the line item is displayed during checkout.","example":true},"taxable":{"type":"boolean","default":false,"description":"Indicates whether the line item should be included in tax calculations.","example":true},"sku":{"type":"string","description":"The stock-keeping unit (SKU) that identifies the particular product or variant.","example":"ERQGND16"},"platform_variant_id":{"type":"string","description":"The identifier of the variant on the platform.","example":"e7ba4c75-b1bb-483d-94d8-2c4a10f78472"},"requires_shipping":{"type":"boolean","default":true,"description":"Indicates whether the item requires physical shipping.","example":true},"item_weight":{"type":"number","description":"The weight of a single unit of the item.","minimum":0,"example":16},"weight_unit":{"type":"string","nullable":true,"description":"The abbreviated unit of measurement for weight of the line item. For example, g, lb, or oz.","default":"g","example":"oz"},"tax_code":{"type":"string","nullable":true,"description":"The tax code of the item, which indicates tax obligations or exemptions necessary when purchasing the item.","example":"PF050211"},"note":{"type":"string","nullable":true,"description":"A free-text note associated with the line item.","example":"Extra-fine ground requested"},"volume_unit":{"type":"string","nullable":true,"description":"The measurement of units applied to the quantity. For example, \\"carton\\", \\"each\\", or \\"gallon\\".","example":"bag"},"vendor":{"type":"string","nullable":true,"description":"The vendor of the product.","example":"Example Enterprises"},"properties":{"type":"object","nullable":true,"description":"Arbitrary properties attached to the line item.","additionalProperties":true,"example":{"grind":"extra-fine","roast":"dark"}}},"required":["title","quantity","line_item_key","unit_price","visible","taxable","requires_shipping","item_weight"]}},"required":["event_name","data"]},"RemoveLineItem":{"type":"object","properties":{"event_name":{"type":"string","enum":["remove_line_item"]},"data":{"type":"object","properties":{"line_item_key":{"type":"string","description":"A unique identifier, set by the merchant, serving to refer to this line item throughout Bold Checkout.","example":"ERQ-GND-16_1"}},"required":["line_item_key"]}},"required":["event_name","data"]},"EstimateTax":{"type":"object","properties":{"event_name":{"type":"string","enum":["estimate_tax"]},"data":{"$ref":"#/components/schemas/Address"}}},"EstimateShipping":{"type":"object","properties":{"event_name":{"type":"string","enum":["estimate_shipping"]},"data":{"$ref":"#/components/schemas/Address"}}},"InvalidShippingAddressField":{"type":"object","description":"A validation error occurred when processing the `set_shipping_address` event.","properties":{"event_name":{"type":"string","description":"The event containing invalid data.","enum":["set_shipping_address"],"example":"set_shipping_address"},"field":{"type":"string","description":"The invalid field, if validation is tied to specific fields.","enum":["first_name","last_name","address_line_1","address_line_2","city","province","province_code","country","country_code","postal_code","business_name","phone_number"],"example":"address_line_1"},"reason":{"type":"string","description":"A human-readable reason why the field is not valid.","example":"Address line 1 is above maximum length of 65 characters."}},"required":["event_name","field","reason"]},"InvalidBillingAddressField":{"type":"object","description":"A validation error occurred when processing the `set_billing_address` event.","properties":{"event_name":{"type":"string","description":"The event containing invalid data.","enum":["set_billing_address"],"example":"set_billing_address"},"field":{"type":"string","description":"The invalid field, if validation is tied to specific fields.","enum":["first_name","last_name","address_line_1","address_line_2","city","province","province_code","country","country_code","postal_code","business_name","phone_number"],"example":"address_line_1"},"reason":{"type":"string","description":"A human-readable reason why the field is not valid.","example":"Address line 1 is above maximum length of 65 characters."}},"required":["event_name","field","reason"]},"InvalidCustomerField":{"type":"object","description":"A validation error occurred when processing the `set_customer` event.","properties":{"event_name":{"type":"string","description":"The event containing invalid data.","enum":["set_customer"],"example":"set_customer"},"field":{"type":"string","description":"The invalid field, if validation is tied to specific fields.","enum":["platform_id","public_id","first_name","last_name","email_address","accepts_marketing"],"example":"email_address"},"reason":{"type":"string","description":"A human-readable reason why the field is not valid.","example":"MX record validation failed for the given email address."}},"required":["event_name","field","reason"]},"InvalidShippingLine":{"type":"object","description":"A validation error occurred when processing the `set_shipping_line` event.","properties":{"event_name":{"type":"string","description":"The event containing invalid data.","enum":["set_shipping_line"],"example":"set_shipping_line"},"field":{"type":"string","description":"The invalid field, if validation is tied to specific fields.","enum":["index"],"example":"index"},"reason":{"type":"string","description":"A human-readable reason why the field is not valid.","example":"Unable to use Business Shipping without business name on shipping address."}},"required":["event_name","field","reason"]},"InvalidDiscountCode":{"type":"object","description":"A validation error occurred when processing the `add_discount_code` event.","properties":{"event_name":{"type":"string","description":"The event containing invalid data.","enum":["add_discount_code"],"example":"add_discount_code"},"field":{"type":"string","description":"The invalid field, if validation is tied to specific fields.","enum":["discount_code"],"example":"discount_code"},"reason":{"type":"string","description":"A human-readable reason why the field is not valid.","example":"Discount code has expired."}},"required":["event_name","field","reason"]},"InvalidLineItemField":{"type":"object","description":"A validation error occurred when processing the `add_line_item` or `update_line_item` event.","properties":{"event_name":{"type":"string","description":"The event containing invalid data.","enum":["add_line_item","update_line_item"],"example":"add_line_item"},"field":{"type":"string","description":"The invalid field, if validation is tied to specific fields.","enum":["sku","platform_variant_id","quantity","line_item_key"],"example":"sku"},"reason":{"type":"string","description":"A human-readable reason why the field is not valid.","example":"Unable to find product by sku."}},"required":["event_name","field","reason"]},"GeneralValidationError":{"type":"object","description":"A validation error occurred that is not specific to a set of fields.","properties":{"event_name":{"type":"string","description":"The event that cannot be completed.","enum":["set_shipping_address","remove_shipping_address","set_billing_address","remove_billing_address","set_customer","remove_customer","set_shipping_line","get_shipping_lines","add_discount_code","remove_discount_code","apply_taxes"],"example":"set_shipping_address"},"reason":{"type":"string","description":"A human-readable reason why the event is not valid.","example":"Order is currently locked and unable to be edited. Please try again later."}},"required":["event_name","reason"]},"EmptyData":{"type":"object"},"OutgoingTax":{"allOf":[{"type":"object","properties":{"name":{"type":"string","description":"The name of the tax rate being applied.","example":"GST"}},"required":["name"]},{"anyOf":[{"type":"object","title":"Tax rate","description":"Tax as a percentage of the line item total.","properties":{"rate":{"type":"number","description":"The numerical tax rate, applied as a percentage of the line item total between 0 and 1.","minimum":0,"maximum":1,"example":0.05}},"required":["rate"]},{"type":"object","title":"Tax value","description":"Tax as a per-unit value.","properties":{"unit_amount":{"type":"number","description":"The amount of tax applied to a single unit of the item, represented in base currency units, using [ISO-4217](https://www.iso.org/iso-4217-currency-codes.html) standards.","minimum":0,"example":64.95}},"required":["unit_amount"]}]}]},"IncomingTax":{"type":"object","minItems":0,"properties":{"name":{"type":"string","description":"The name of the tax rate being applied.","example":"GST"},"unit_amount":{"type":"number","description":"The amount of tax applied to a single unit of the item, represented in base currency units, using [ISO-4217](https://www.iso.org/iso-4217-currency-codes.html) standards.","minimum":0,"example":64.95},"rate":{"type":"number","description":"The numerical tax rate, applied as a percentage of the line item total between 0 and 1.","minimum":0,"maximum":1,"example":0.05}},"required":["name","unit_amount"]}},"responses":{"SuccessfulRequest":{"description":"Order state change successfully applied.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OutgoingOrderState"}}}}}}}},"plugin-redoc-12":{"url":"/api/checkout-flows.openapi.yaml","themeId":"theme-redoc","isSpecFile":true,"spec":{"openapi":"3.0.0","info":{"title":"Checkout Flows","version":"1.0","description":"The Checkout Flows API allows a third party integration to gather information about flows, enable existing flows, or create new flows for a particular merchant.\\n\\n> <span style=\\"color:red\\">NOTE: These endpoints are currently in development and are considered **experimental**.</span> Note that the endpoints may change parameter requirements, payloads, and/or behavior.","termsOfService":"https://boldcommerce.com/terms-of-service","contact":{"name":"Contact Us","url":"https://developer-dashboard.boldcommerce.com/default/contactus"}},"servers":[{"url":"https://api.boldcommerce.com"}],"security":[{"APIAccessToken":[]}],"tags":[{"name":"Flows","description":"Use these endpoints to interact with Checkout flows at a store-level."}],"externalDocs":{"description":"For more information about Checkout flows, refer to the Checkout Flows Overview.","url":"https://developer.boldcommerce.com/guides/checkout/concepts/flows"},"paths":{"/checkout/shop/{shop_identifier}/flows":{"parameters":[{"$ref":"#/components/parameters/shop_identifier"}],"get":{"summary":"List Enabled Flows","operationId":"ListEnabledFlows","tags":["Flows"],"description":"Lists all flows currently enabled for the shop.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"oneOf":[{"type":"object","description":"The list of flows enabled for the shop.","properties":{"flows":{"type":"array","items":{"$ref":"#/components/schemas/Flow"}}}},{"type":"object","description":"An empty list, indicating that there are no flows enabled.","properties":{"flows":{"type":"array","maxItems":0,"items":{}}}}]},"examples":{"ListEnabledFlows":{"$ref":"#/components/examples/ListEnabledFlowsExample"},"NoEnabledFlows":{"value":{"flows":[]}}}}}}}}},"/checkout/shop/{shop_identifier}/flows/available":{"parameters":[{"$ref":"#/components/parameters/shop_identifier"}],"get":{"summary":"List Available Flows","operationId":"ListAvailableFlows","tags":["Flows"],"description":"Lists all flows currently available for the shop, excluding enabled flows. \\n\\nIf a store meets all requirements to enable a flow, the flow is _available_. Requirements differ between flows. Contact your Bold account manager to determine the necessary configurations for your store.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"oneOf":[{"type":"object","description":"The list of flows available for the shop, excluding enabled flows.","properties":{"flows":{"type":"array","items":{"$ref":"#/components/schemas/Flow"}}}},{"type":"object","description":"An empty list, indicating that there are no flows available.","properties":{"flows":{"type":"array","maxItems":0,"items":{}}}}]},"examples":{"AvailableFlows":{"$ref":"#/components/examples/ListAvailableFlowsExample"},"NoAvailableFlows":{"value":{"flows":[]}}}}}}}}},"/checkout/shop/{shop_identifier}/flows/{flow_id}":{"parameters":[{"$ref":"#/components/parameters/shop_identifier"},{"$ref":"#/components/parameters/flow_id"}],"post":{"summary":"Enable Flow","operationId":"EnableFlow","tags":["Flows"],"description":"Enables a flow for the shop.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","description":"The flow enabled for the shop.","properties":{"flows":{"type":"array","items":{"$ref":"#/components/schemas/Flow"},"maxItems":1}}},"examples":{"FlowEnabled":{"$ref":"#/components/examples/EnableFlowExample"}}}}},"404":{"description":"Cannot find flow ID","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"example":{"code":"88","type":"flow_not_found","message":"The flow with the given flow_id was not found"}}}},"422":{"description":"Shop does not meet requirements to enable the flow","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"example":{"code":"88","type":"flow_not_available","message":"The flow is currently not available"}}}}}},"delete":{"summary":"Disable Flow","operationId":"DisableFlow","tags":["Flows"],"description":"Disables a flow for the shop.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","description":"The flow is disabled for the shop.","properties":{"flows":{"type":"array","description":"The flow disabled for the shop.","items":{"$ref":"#/components/schemas/Flow"},"maxItems":1}}},"examples":{"FlowDisabled":{"$ref":"#/components/examples/DisableFlowExample"}}}}},"404":{"description":"Cannot find flow ID","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"example":{"code":"88","type":"flow_not_found","message":"The flow with the given flow_id was not found"}}}},"422":{"description":"Shop does not meet requirements to disable the flow","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"example":{"code":"88","type":"flow_not_available","message":"The flow is currently not available"}}}}}}}},"components":{"securitySchemes":{"APIAccessToken":{"type":"apiKey","name":"API Access Token","in":"header","description":"Authenticates an API request from a [private integration](/guides/checkout/resources/glossary#private-integration). Generate this token in the [Bold Account Center](https://account.boldcommerce.com/). Refer to [Making API Calls](/guides/checkout/quick-start) for more information."}},"parameters":{"shop_identifier":{"schema":{"type":"string"},"name":"shop_identifier","in":"path","required":true,"description":"The identifier of the shop, which can be retrieved by making a request to the [Get Shop Info](shops#operation/GetShopInfo) endpoint.","example":"zp3oafdor9"},"flow_id":{"schema":{"type":"string","example":"self-hosted-flow-1"},"name":"flow_id","in":"path","required":true,"description":"The identifier of the checkout flow, which can be retrieved by making a request to the [List Available Flows](checkout-flows#operation/ListAvailableFlows) endpoint."}},"schemas":{"Flow":{"type":"object","properties":{"flow_id":{"type":"string","description":"The identifier of the checkout flow.","example":"external-company-one-page-template"},"flow_name":{"type":"string","description":"The name of the checkout flow.","example":"Self Hosted Three Page"}}},"Error":{"type":"object","properties":{"code":{"type":"string","description":"The code for the error.","example":"88"},"type":{"type":"string","description":"The type of error that occurred.","example":"flow_not_available"},"message":{"type":"string","description":"The message for the error.","example":"The flow is currently not available"}}}},"examples":{"ListEnabledFlowsExample":{"value":{"flows":[{"flow_id":"flow1","flow_name":"Self Hosted Three Page"},{"flow_id":"paypal_branded","flow_name":"Paypal Checkout Flow"}]}},"ListAvailableFlowsExample":{"value":{"flows":[{"flow_id":"flow2","flow_name":"Self Hosted One Page"}]}},"EnableFlowExample":{"value":{"flows":[{"flow_id":"flow2","flow_name":"Self Hosted One Page"}]}},"DisableFlowExample":{"value":{"flows":[{"flow_id":"flow2","flow_name":"Self Hosted One Page"}]}}}}}}},"docusaurus-theme-redoc":{"theme-redoc":{"lightTheme":{"typography":{"fontFamily":"var(--ifm-font-family-base)","fontSize":"var(--ifm-font-size-base)","lineHeight":"var(--ifm-line-height-base)","fontWeightLight":"var(--ifm-font-weight-light)","fontWeightRegular":"var(--ifm-font-weight-base)","fontWeightBold":"var(--ifm-font-weight-bold)","headings":{"fontFamily":"var(--ifm-heading-font-family)","fontWeight":"var(--ifm-heading-font-weight)","lineHeight":"var(--ifm-heading-line-height)"},"code":{"fontFamily":"var(--ifm-font-family-monospace)","lineHeight":"var(--ifm-pre-line-height)"}},"sidebar":{"width":"300px","backgroundColor":"#ffffff"},"rightPanel":{"backgroundColor":"#303846"},"colors":{"primary":{"main":"#5a0fb9"}},"theme":{"prism":{"additionalLanguages":["scala"]}}},"darkTheme":{"typography":{"fontFamily":"var(--ifm-font-family-base)","fontSize":"var(--ifm-font-size-base)","lineHeight":"var(--ifm-line-height-base)","fontWeightLight":"var(--ifm-font-weight-light)","fontWeightRegular":"var(--ifm-font-weight-base)","fontWeightBold":"var(--ifm-font-weight-bold)","headings":{"fontFamily":"var(--ifm-heading-font-family)","fontWeight":"var(--ifm-heading-font-weight)","lineHeight":"var(--ifm-heading-line-height)"},"code":{"fontFamily":"var(--ifm-font-family-monospace)","lineHeight":"var(--ifm-pre-line-height)"}},"sidebar":{"width":"300px","backgroundColor":"rgb(24, 25, 26)","textColor":"#f5f6f7","arrow":{"color":"#f5f6f7"}},"colors":{"text":{"primary":"#f5f6f7","secondary":"rgba(255, 255, 255, 1)"},"gray":{"50":"#FAFAFA","100":"#F5F5F5"},"border":{"dark":"#ffffff","light":"rgba(0,0,0, 0.1)"},"primary":{"main":"#5a0fb9"}},"schema":{"nestedBackground":"rgb(24, 25, 26)","typeNameColor":"rgba(255, 255, 255, 1)","typeTitleColor":"rgba(255, 255, 255, 1)"},"theme":{"prism":{"additionalLanguages":["scala"]}}},"options":{"scrollYOffset":"nav.navbar","expandSingleSchemaField":true,"menuToggle":true,"suppressWarnings":true,"disableSearch":true}}}}'),s=JSON.parse('{"defaultLocale":"en","locales":["en"],"path":"i18n","currentLocale":"en","localeConfigs":{"en":{"label":"English","direction":"ltr","htmlLang":"en","calendar":"gregory","path":"en"}}}');var a=r(22654);const c=JSON.parse('{"docusaurusVersion":"3.4.0","siteVersion":"3.0.0-alpha","pluginVersions":{"docusaurus-plugin-content-docs":{"type":"package","name":"@docusaurus/plugin-content-docs","version":"3.4.0"},"docusaurus-plugin-content-blog":{"type":"package","name":"@docusaurus/plugin-content-blog","version":"3.4.0"},"docusaurus-plugin-content-pages":{"type":"package","name":"@docusaurus/plugin-content-pages","version":"3.4.0"},"docusaurus-plugin-google-tag-manager":{"type":"package","name":"@docusaurus/plugin-google-tag-manager","version":"3.4.0"},"docusaurus-plugin-sitemap":{"type":"package","name":"@docusaurus/plugin-sitemap","version":"3.4.0"},"docusaurus-plugin-redoc":{"type":"package","name":"docusaurus-plugin-redoc","version":"2.1.1"},"docusaurus-theme-classic":{"type":"package","name":"@docusaurus/theme-classic","version":"3.4.0"},"docusaurus-theme-search-algolia":{"type":"package","name":"@docusaurus/theme-search-algolia","version":"3.4.0"},"docusaurus-theme-redoc":{"type":"package","name":"docusaurus-theme-redoc","version":"2.1.1"},"docusaurus-plugin-sass":{"type":"package","name":"docusaurus-plugin-sass","version":"0.2.5"},"docusaurus-theme-mermaid":{"type":"package","name":"@docusaurus/theme-mermaid","version":"3.4.0"}}}');var p=r(74848);const d={siteConfig:o.default,siteMetadata:c,globalData:i,i18n:s,codeTranslations:a},l=n.createContext(d);function u(e){let{children:t}=e;return(0,p.jsx)(l.Provider,{value:d,children:t})}},67489:(e,t,r)=>{"use strict";r.d(t,{A:()=>f});var n=r(96540),o=r(38193),i=r(5260),s=r(70440),a=r(10986),c=r(53102),p=r(74848);function d(e){let{error:t,tryAgain:r}=e;return(0,p.jsxs)("div",{style:{display:"flex",flexDirection:"column",justifyContent:"center",alignItems:"flex-start",minHeight:"100vh",width:"100%",maxWidth:"80ch",fontSize:"20px",margin:"0 auto",padding:"1rem"},children:[(0,p.jsx)("h1",{style:{fontSize:"3rem"},children:"This page crashed"}),(0,p.jsx)("button",{type:"button",onClick:r,style:{margin:"1rem 0",fontSize:"2rem",cursor:"pointer",borderRadius:20,padding:"1rem"},children:"Try again"}),(0,p.jsx)(l,{error:t})]})}function l(e){let{error:t}=e;const r=(0,s.getErrorCausalChain)(t).map((e=>e.message)).join("\n\nCause:\n");return(0,p.jsx)("p",{style:{whiteSpace:"pre-wrap"},children:r})}function u(e){let{children:t}=e;return(0,p.jsx)(c.W,{value:{plugin:{name:"docusaurus-core-error-boundary",id:"default"}},children:t})}function m(e){let{error:t,tryAgain:r}=e;return(0,p.jsx)(u,{children:(0,p.jsxs)(f,{fallback:()=>(0,p.jsx)(d,{error:t,tryAgain:r}),children:[(0,p.jsx)(i.A,{children:(0,p.jsx)("title",{children:"Page Error"})}),(0,p.jsx)(a.A,{children:(0,p.jsx)(d,{error:t,tryAgain:r})})]})})}const h=e=>(0,p.jsx)(m,{...e});class f extends n.Component{constructor(e){super(e),this.state={error:null}}componentDidCatch(e){o.default.canUseDOM&&this.setState({error:e})}render(){const{children:e}=this.props,{error:t}=this.state;if(t){const e={error:t,tryAgain:()=>this.setState({error:null})};return(this.props.fallback??h)(e)}return e??null}}},38193:(e,t,r)=>{"use strict";r.r(t),r.d(t,{default:()=>o});const n="undefined"!=typeof window&&"document"in window&&"createElement"in window.document,o={canUseDOM:n,canUseEventListeners:n&&("addEventListener"in window||"attachEvent"in window),canUseIntersectionObserver:n&&"IntersectionObserver"in window,canUseViewport:n&&"screen"in window}},5260:(e,t,r)=>{"use strict";r.d(t,{A:()=>i});r(96540);var n=r(80545),o=r(74848);function i(e){return(0,o.jsx)(n.mg,{...e})}},28774:(e,t,r)=>{"use strict";r.d(t,{A:()=>m});var n=r(96540),o=r(54625),i=r(70440),s=r(44586),a=r(16654),c=r(38193),p=r(63427),d=r(86025),l=r(74848);function u(e,t){let{isNavLink:r,to:u,href:m,activeClassName:h,isActive:f,"data-noBrokenLinkCheck":g,autoAddBaseUrl:y=!0,...b}=e;const{siteConfig:_}=(0,s.A)(),{trailingSlash:v,baseUrl:x}=_,w=_.future.experimental_router,{withBaseUrl:k}=(0,d.hH)(),S=(0,p.A)(),T=(0,n.useRef)(null);(0,n.useImperativeHandle)(t,(()=>T.current));const C=u||m;const A=(0,a.A)(C),I=C?.replace("pathname://","");let j=void 0!==I?(E=I,y&&(e=>e.startsWith("/"))(E)?k(E):E):void 0;var E;"hash"===w&&j?.startsWith("./")&&(j=j?.slice(1)),j&&A&&(j=(0,i.applyTrailingSlash)(j,{trailingSlash:v,baseUrl:x}));const P=(0,n.useRef)(!1),R=r?o.k2:o.N_,O=c.default.canUseIntersectionObserver,q=(0,n.useRef)(),$=()=>{P.current||null==j||(window.docusaurus.preload(j),P.current=!0)};(0,n.useEffect)((()=>(!O&&A&&null!=j&&window.docusaurus.prefetch(j),()=>{O&&q.current&&q.current.disconnect()})),[q,j,O,A]);const D=j?.startsWith("#")??!1,B=!b.target||"_self"===b.target,L=!j||!A||!B;return g||!D&&L||S.collectLink(j),b.id&&S.collectAnchor(b.id),L?(0,l.jsx)("a",{ref:T,href:j,...C&&!A&&{target:"_blank",rel:"noopener noreferrer"},...b}):(0,l.jsx)(R,{...b,onMouseEnter:$,onTouchStart:$,innerRef:e=>{T.current=e,O&&e&&A&&(q.current=new window.IntersectionObserver((t=>{t.forEach((t=>{e===t.target&&(t.isIntersecting||t.intersectionRatio>0)&&(q.current.unobserve(e),q.current.disconnect(),null!=j&&window.docusaurus.prefetch(j))}))})),q.current.observe(e))},to:j,...r&&{isActive:f,activeClassName:h}})}const m=n.forwardRef(u)},21312:(e,t,r)=>{"use strict";r.d(t,{A:()=>p,T:()=>c});var n=r(96540),o=r(74848);function i(e,t){const r=e.split(/(\{\w+\})/).map(((e,r)=>{if(r%2==1){const r=t?.[e.slice(1,-1)];if(void 0!==r)return r}return e}));return r.some((e=>(0,n.isValidElement)(e)))?r.map(((e,t)=>(0,n.isValidElement)(e)?n.cloneElement(e,{key:t}):e)).filter((e=>""!==e)):r.join("")}var s=r(22654);function a(e){let{id:t,message:r}=e;if(void 0===t&&void 0===r)throw new Error("Docusaurus translation declarations must have at least a translation id or a default translation message");return s[t??r]??r??t}function c(e,t){let{message:r,id:n}=e;return i(a({message:r,id:n}),t)}function p(e){let{children:t,id:r,values:n}=e;if(t&&"string"!=typeof t)throw console.warn("Illegal <Translate> children",t),new Error("The Docusaurus <Translate> component only accept simple string values");const s=a({message:t,id:r});return(0,o.jsx)(o.Fragment,{children:i(s,n)})}},17065:(e,t,r)=>{"use strict";r.d(t,{W:()=>n});const n="default"},16654:(e,t,r)=>{"use strict";function n(e){return/^(?:\w*:|\/\/)/.test(e)}function o(e){return void 0!==e&&!n(e)}r.d(t,{A:()=>o,z:()=>n})},86025:(e,t,r)=>{"use strict";r.d(t,{Ay:()=>a,hH:()=>s});var n=r(96540),o=r(44586),i=r(16654);function s(){const{siteConfig:e}=(0,o.A)(),{baseUrl:t,url:r}=e,s=e.future.experimental_router,a=(0,n.useCallback)(((e,n)=>function(e){let{siteUrl:t,baseUrl:r,url:n,options:{forcePrependBaseUrl:o=!1,absolute:s=!1}={},router:a}=e;if(!n||n.startsWith("#")||(0,i.z)(n))return n;if("hash"===a)return n.startsWith("/")?`.${n}`:`./${n}`;if(o)return r+n.replace(/^\//,"");if(n===r.replace(/\/$/,""))return r;const c=n.startsWith(r)?n:r+n.replace(/^\//,"");return s?t+c:c}({siteUrl:r,baseUrl:t,url:e,options:n,router:s})),[r,t,s]);return{withBaseUrl:a}}function a(e,t){void 0===t&&(t={});const{withBaseUrl:r}=s();return r(e,t)}},63427:(e,t,r)=>{"use strict";r.d(t,{A:()=>s});var n=r(96540);r(74848);const o=n.createContext({collectAnchor:()=>{},collectLink:()=>{}}),i=()=>(0,n.useContext)(o);function s(){return i()}},44586:(e,t,r)=>{"use strict";r.d(t,{A:()=>i});var n=r(96540),o=r(26988);function i(){return(0,n.useContext)(o.o)}},66588:(e,t,r)=>{"use strict";r.d(t,{P_:()=>s,kh:()=>i});var n=r(44586),o=r(17065);function i(e,t){void 0===t&&(t={});const r=function(){const{globalData:e}=(0,n.A)();return e}()[e];if(!r&&t.failfast)throw new Error(`Docusaurus plugin global data not found for "${e}" plugin.`);return r}function s(e,t,r){void 0===t&&(t=o.W),void 0===r&&(r={});const n=i(e),s=n?.[t];if(!s&&r.failfast)throw new Error(`Docusaurus plugin global data not found for "${e}" plugin with id "${t}".`);return s}},92303:(e,t,r)=>{"use strict";r.d(t,{A:()=>i});var n=r(96540),o=r(6125);function i(){return(0,n.useContext)(o.o)}},205:(e,t,r)=>{"use strict";r.d(t,{A:()=>o});var n=r(96540);const o=r(38193).default.canUseDOM?n.useLayoutEffect:n.useEffect},36803:(e,t,r)=>{"use strict";r.d(t,{A:()=>i});var n=r(96540),o=r(53102);function i(){const e=n.useContext(o.o);if(!e)throw new Error("Unexpected: no Docusaurus route context found");return e}},86921:(e,t,r)=>{"use strict";r.d(t,{A:()=>o});const n=e=>"object"==typeof e&&!!e&&Object.keys(e).length>0;function o(e){const t={};return function e(r,o){Object.entries(r).forEach((r=>{let[i,s]=r;const a=o?`${o}.${i}`:i;n(s)?e(s,a):t[a]=s}))}(e),t}},53102:(e,t,r)=>{"use strict";r.d(t,{W:()=>s,o:()=>i});var n=r(96540),o=r(74848);const i=n.createContext(null);function s(e){let{children:t,value:r}=e;const s=n.useContext(i),a=(0,n.useMemo)((()=>function(e){let{parent:t,value:r}=e;if(!t){if(!r)throw new Error("Unexpected: no Docusaurus route context found");if(!("plugin"in r))throw new Error("Unexpected: Docusaurus topmost route context has no `plugin` attribute");return r}const n={...t.data,...r?.data};return{plugin:t.plugin,data:n}}({parent:s,value:r})),[s,r]);return(0,o.jsx)(i.Provider,{value:a,children:t})}},48295:(e,t,r)=>{"use strict";r.d(t,{zK:()=>f,vT:()=>l,gk:()=>u,Gy:()=>p,HW:()=>g,ht:()=>d,r7:()=>h,jh:()=>m});var n=r(56347),o=r(66588);const i=e=>e.versions.find((e=>e.isLast));function s(e,t){const r=i(e);return[...e.versions.filter((e=>e!==r)),r].find((e=>!!(0,n.B6)(t,{path:e.path,exact:!1,strict:!1})))}function a(e,t){const r=s(e,t),o=r?.docs.find((e=>!!(0,n.B6)(t,{path:e.path,exact:!0,strict:!1})));return{activeVersion:r,activeDoc:o,alternateDocVersions:o?function(t){const r={};return e.versions.forEach((e=>{e.docs.forEach((n=>{n.id===t&&(r[e.name]=n)}))})),r}(o.id):{}}}const c={},p=()=>(0,o.kh)("docusaurus-plugin-content-docs")??c,d=e=>{try{return(0,o.P_)("docusaurus-plugin-content-docs",e,{failfast:!0})}catch(t){throw new Error("You are using a feature of the Docusaurus docs plugin, but this plugin does not seem to be enabled"+("Default"===e?"":` (pluginId=${e}`),{cause:t})}};function l(e){void 0===e&&(e={});const t=p(),{pathname:r}=(0,n.zy)();return function(e,t,r){void 0===r&&(r={});const o=Object.entries(e).sort(((e,t)=>t[1].path.localeCompare(e[1].path))).find((e=>{let[,r]=e;return!!(0,n.B6)(t,{path:r.path,exact:!1,strict:!1})})),i=o?{pluginId:o[0],pluginData:o[1]}:void 0;if(!i&&r.failfast)throw new Error(`Can't find active docs plugin for "${t}" pathname, while it was expected to be found. Maybe you tried to use a docs feature that can only be used on a docs-related page? Existing docs plugin paths are: ${Object.values(e).map((e=>e.path)).join(", ")}`);return i}(t,r,e)}function u(e){void 0===e&&(e={});const t=l(e),{pathname:r}=(0,n.zy)();if(!t)return;return{activePlugin:t,activeVersion:s(t.pluginData,r)}}function m(e){return d(e).versions}function h(e){const t=d(e);return i(t)}function f(e){const t=d(e),{pathname:r}=(0,n.zy)();return a(t,r)}function g(e){const t=d(e),{pathname:r}=(0,n.zy)();return function(e,t){const r=i(e);return{latestDocSuggestion:a(e,t).alternateDocVersions[r.name],latestVersionSuggestion:r}}(t,r)}},76294:(e,t,r)=>{"use strict";r.r(t),r.d(t,{default:()=>i});var n=r(5947),o=r.n(n);o().configure({showSpinner:!1});const i={onRouteUpdate(e){let{location:t,previousLocation:r}=e;if(r&&t.pathname!==r.pathname){const e=window.setTimeout((()=>{o().start()}),200);return()=>window.clearTimeout(e)}},onRouteDidUpdate(){o().done()}}},26134:(e,t,r)=>{"use strict";r.r(t);var n=r(78181),o=r(4784);!function(e){const{themeConfig:{prism:t}}=o.default,{additionalLanguages:n}=t;globalThis.Prism=e,n.forEach((e=>{"php"===e&&r(19700),r(66374)(`./prism-${e}`)})),delete globalThis.Prism}(n.My)},51107:(e,t,r)=>{"use strict";r.d(t,{A:()=>d});r(96540);var n=r(18215),o=r(21312),i=r(6342),s=r(28774),a=r(63427);const c={anchorWithStickyNavbar:"anchorWithStickyNavbar_LWe7",anchorWithHideOnScrollNavbar:"anchorWithHideOnScrollNavbar_WYt5"};var p=r(74848);function d(e){let{as:t,id:r,...d}=e;const l=(0,a.A)(),{navbar:{hideOnScroll:u}}=(0,i.p)();if("h1"===t||!r)return(0,p.jsx)(t,{...d,id:void 0});l.collectAnchor(r);const m=(0,o.T)({id:"theme.common.headingLinkTitle",message:"Direct link to {heading}",description:"Title for link to heading"},{heading:"string"==typeof d.children?d.children:r});return(0,p.jsxs)(t,{...d,className:(0,n.A)("anchor",u?c.anchorWithHideOnScrollNavbar:c.anchorWithStickyNavbar,d.className),id:r,children:[d.children,(0,p.jsx)(s.A,{className:"hash-link",to:`#${r}`,"aria-label":m,title:m,children:"\u200b"})]})}},43186:(e,t,r)=>{"use strict";r.d(t,{A:()=>i});r(96540);const n={iconExternalLink:"iconExternalLink_nPIU"};var o=r(74848);function i(e){let{width:t=13.5,height:r=13.5}=e;return(0,o.jsx)("svg",{width:t,height:r,"aria-hidden":"true",viewBox:"0 0 24 24",className:n.iconExternalLink,children:(0,o.jsx)("path",{fill:"currentColor",d:"M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"})})}},10986:(e,t,r)=>{"use strict";r.d(t,{A:()=>$t});var n=r(96540),o=r(18215),i=r(67489),s=r(45500),a=r(56347),c=r(21312),p=r(75062),d=r(74848);const l="__docusaurus_skipToContent_fallback";function u(e){e.setAttribute("tabindex","-1"),e.focus(),e.removeAttribute("tabindex")}function m(){const e=(0,n.useRef)(null),{action:t}=(0,a.W6)(),r=(0,n.useCallback)((e=>{e.preventDefault();const t=document.querySelector("main:first-of-type")??document.getElementById(l);t&&u(t)}),[]);return(0,p.$)((r=>{let{location:n}=r;e.current&&!n.hash&&"PUSH"===t&&u(e.current)})),{containerRef:e,onClick:r}}const h=(0,c.T)({id:"theme.common.skipToMainContent",description:"The skip to content label used for accessibility, allowing to rapidly navigate to main content with keyboard tab/enter navigation",message:"Skip to main content"});function f(e){const t=e.children??h,{containerRef:r,onClick:n}=m();return(0,d.jsx)("div",{ref:r,role:"region","aria-label":h,children:(0,d.jsx)("a",{...e,href:`#${l}`,onClick:n,children:t})})}var g=r(17559),y=r(14090);const b={skipToContent:"skipToContent_fXgn"};function _(){return(0,d.jsx)(f,{className:b.skipToContent})}var v=r(6342),x=r(65041);function w(e){let{width:t=21,height:r=21,color:n="currentColor",strokeWidth:o=1.2,className:i,...s}=e;return(0,d.jsx)("svg",{viewBox:"0 0 15 15",width:t,height:r,...s,children:(0,d.jsx)("g",{stroke:n,strokeWidth:o,children:(0,d.jsx)("path",{d:"M.75.75l13.5 13.5M14.25.75L.75 14.25"})})})}const k={closeButton:"closeButton_CVFx"};function S(e){return(0,d.jsx)("button",{type:"button","aria-label":(0,c.T)({id:"theme.AnnouncementBar.closeButtonAriaLabel",message:"Close",description:"The ARIA label for close button of announcement bar"}),...e,className:(0,o.A)("clean-btn close",k.closeButton,e.className),children:(0,d.jsx)(w,{width:14,height:14,strokeWidth:3.1})})}const T={content:"content_knG7"};function C(e){const{announcementBar:t}=(0,v.p)(),{content:r}=t;return(0,d.jsx)("div",{...e,className:(0,o.A)(T.content,e.className),dangerouslySetInnerHTML:{__html:r}})}const A={announcementBar:"announcementBar_mb4j",announcementBarPlaceholder:"announcementBarPlaceholder_vyr4",announcementBarClose:"announcementBarClose_gvF7",announcementBarContent:"announcementBarContent_xLdY"};function I(){const{announcementBar:e}=(0,v.p)(),{isActive:t,close:r}=(0,x.M)();if(!t)return null;const{backgroundColor:n,textColor:o,isCloseable:i}=e;return(0,d.jsxs)("div",{className:A.announcementBar,style:{backgroundColor:n,color:o},role:"banner",children:[i&&(0,d.jsx)("div",{className:A.announcementBarPlaceholder}),(0,d.jsx)(C,{className:A.announcementBarContent}),i&&(0,d.jsx)(S,{onClick:r,className:A.announcementBarClose})]})}var j=r(22069),E=r(23104);var P=r(89532),R=r(75600);const O=n.createContext(null);function q(e){let{children:t}=e;const r=function(){const e=(0,j.M)(),t=(0,R.YL)(),[r,o]=(0,n.useState)(!1),i=null!==t.component,s=(0,P.ZC)(i);return(0,n.useEffect)((()=>{i&&!s&&o(!0)}),[i,s]),(0,n.useEffect)((()=>{i?e.shown||o(!0):o(!1)}),[e.shown,i]),(0,n.useMemo)((()=>[r,o]),[r])}();return(0,d.jsx)(O.Provider,{value:r,children:t})}function $(e){if(e.component){const t=e.component;return(0,d.jsx)(t,{...e.props})}}function D(){const e=(0,n.useContext)(O);if(!e)throw new P.dV("NavbarSecondaryMenuDisplayProvider");const[t,r]=e,o=(0,n.useCallback)((()=>r(!1)),[r]),i=(0,R.YL)();return(0,n.useMemo)((()=>({shown:t,hide:o,content:$(i)})),[o,i,t])}function B(e){let{header:t,primaryMenu:r,secondaryMenu:n}=e;const{shown:i}=D();return(0,d.jsxs)("div",{className:"navbar-sidebar",children:[t,(0,d.jsxs)("div",{className:(0,o.A)("navbar-sidebar__items",{"navbar-sidebar__items--show-secondary":i}),children:[(0,d.jsx)("div",{className:"navbar-sidebar__item menu",children:r}),(0,d.jsx)("div",{className:"navbar-sidebar__item menu",children:n})]})]})}var L=r(95293),U=r(92303);function N(e){return(0,d.jsx)("svg",{viewBox:"0 0 24 24",width:24,height:24,...e,children:(0,d.jsx)("path",{fill:"currentColor",d:"M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"})})}function F(e){return(0,d.jsx)("svg",{viewBox:"0 0 24 24",width:24,height:24,...e,children:(0,d.jsx)("path",{fill:"currentColor",d:"M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"})})}const M={toggle:"toggle_vylO",toggleButton:"toggleButton_gllP",darkToggleIcon:"darkToggleIcon_wfgR",lightToggleIcon:"lightToggleIcon_pyhR",toggleButtonDisabled:"toggleButtonDisabled_aARS"};function G(e){let{className:t,buttonClassName:r,value:n,onChange:i}=e;const s=(0,U.A)(),a=(0,c.T)({message:"Switch between dark and light mode (currently {mode})",id:"theme.colorToggle.ariaLabel",description:"The ARIA label for the navbar color mode toggle"},{mode:"dark"===n?(0,c.T)({message:"dark mode",id:"theme.colorToggle.ariaLabel.mode.dark",description:"The name for the dark color mode"}):(0,c.T)({message:"light mode",id:"theme.colorToggle.ariaLabel.mode.light",description:"The name for the light color mode"})});return(0,d.jsx)("div",{className:(0,o.A)(M.toggle,t),children:(0,d.jsxs)("button",{className:(0,o.A)("clean-btn",M.toggleButton,!s&&M.toggleButtonDisabled,r),type:"button",onClick:()=>i("dark"===n?"light":"dark"),disabled:!s,title:a,"aria-label":a,"aria-live":"polite",children:[(0,d.jsx)(N,{className:(0,o.A)(M.toggleIcon,M.lightToggleIcon)}),(0,d.jsx)(F,{className:(0,o.A)(M.toggleIcon,M.darkToggleIcon)})]})})}const z=n.memo(G),W={darkNavbarColorModeToggle:"darkNavbarColorModeToggle_X3D1"};function H(e){let{className:t}=e;const r=(0,v.p)().navbar.style,n=(0,v.p)().colorMode.disableSwitch,{colorMode:o,setColorMode:i}=(0,L.G)();return n?null:(0,d.jsx)(z,{className:t,buttonClassName:"dark"===r?W.darkNavbarColorModeToggle:void 0,value:o,onChange:i})}var Z=r(23465);function V(){return(0,d.jsx)(Z.A,{className:"navbar__brand",imageClassName:"navbar__logo",titleClassName:"navbar__title text--truncate"})}function K(){const e=(0,j.M)();return(0,d.jsx)("button",{type:"button","aria-label":(0,c.T)({id:"theme.docs.sidebar.closeSidebarButtonAriaLabel",message:"Close navigation bar",description:"The ARIA label for close button of mobile sidebar"}),className:"clean-btn navbar-sidebar__close",onClick:()=>e.toggle(),children:(0,d.jsx)(w,{color:"var(--ifm-color-emphasis-600)"})})}function Y(){return(0,d.jsxs)("div",{className:"navbar-sidebar__brand",children:[(0,d.jsx)(V,{}),(0,d.jsx)(H,{className:"margin-right--md"}),(0,d.jsx)(K,{})]})}var J=r(28774),X=r(86025),Q=r(16654),ee=r(91252),te=r(43186);function re(e){let{activeBasePath:t,activeBaseRegex:r,to:n,href:o,label:i,html:s,isDropdownLink:a,prependBaseUrlToHref:c,...p}=e;const l=(0,X.Ay)(n),u=(0,X.Ay)(t),m=(0,X.Ay)(o,{forcePrependBaseUrl:!0}),h=i&&o&&!(0,Q.A)(o),f=s?{dangerouslySetInnerHTML:{__html:s}}:{children:(0,d.jsxs)(d.Fragment,{children:[i,h&&(0,d.jsx)(te.A,{...a&&{width:12,height:12}})]})};return o?(0,d.jsx)(J.A,{href:c?m:o,...p,...f}):(0,d.jsx)(J.A,{to:l,isNavLink:!0,...(t||r)&&{isActive:(e,t)=>r?(0,ee.G)(r,t.pathname):t.pathname.startsWith(u)},...p,...f})}function ne(e){let{className:t,isDropdownItem:r=!1,...n}=e;const i=(0,d.jsx)(re,{className:(0,o.A)(r?"dropdown__link":"navbar__item navbar__link",t),isDropdownLink:r,...n});return r?(0,d.jsx)("li",{children:i}):i}function oe(e){let{className:t,isDropdownItem:r,...n}=e;return(0,d.jsx)("li",{className:"menu__list-item",children:(0,d.jsx)(re,{className:(0,o.A)("menu__link",t),...n})})}function ie(e){let{mobile:t=!1,position:r,...n}=e;const o=t?oe:ne;return(0,d.jsx)(o,{...n,activeClassName:n.activeClassName??(t?"menu__link--active":"navbar__link--active")})}var se=r(41422),ae=r(99169),ce=r(44586);const pe={dropdownNavbarItemMobile:"dropdownNavbarItemMobile_S0Fm"};function de(e,t){return e.some((e=>function(e,t){return!!(0,ae.ys)(e.to,t)||!!(0,ee.G)(e.activeBaseRegex,t)||!(!e.activeBasePath||!t.startsWith(e.activeBasePath))}(e,t)))}function le(e){let{items:t,position:r,className:i,onClick:s,...a}=e;const c=(0,n.useRef)(null),[p,l]=(0,n.useState)(!1);return(0,n.useEffect)((()=>{const e=e=>{c.current&&!c.current.contains(e.target)&&l(!1)};return document.addEventListener("mousedown",e),document.addEventListener("touchstart",e),document.addEventListener("focusin",e),()=>{document.removeEventListener("mousedown",e),document.removeEventListener("touchstart",e),document.removeEventListener("focusin",e)}}),[c]),(0,d.jsxs)("div",{ref:c,className:(0,o.A)("navbar__item","dropdown","dropdown--hoverable",{"dropdown--right":"right"===r,"dropdown--show":p}),children:[(0,d.jsx)(re,{"aria-haspopup":"true","aria-expanded":p,role:"button",href:a.to?void 0:"#",className:(0,o.A)("navbar__link",i),...a,onClick:a.to?void 0:e=>e.preventDefault(),onKeyDown:e=>{"Enter"===e.key&&(e.preventDefault(),l(!p))},children:a.children??a.label}),(0,d.jsx)("ul",{className:"dropdown__menu",children:t.map(((e,t)=>(0,n.createElement)(We,{isDropdownItem:!0,activeClassName:"dropdown__link--active",...e,key:t})))})]})}function ue(e){let{items:t,className:r,position:i,onClick:s,...c}=e;const p=function(){const{siteConfig:{baseUrl:e}}=(0,ce.A)(),{pathname:t}=(0,a.zy)();return t.replace(e,"/")}(),l=de(t,p),{collapsed:u,toggleCollapsed:m,setCollapsed:h}=(0,se.u)({initialState:()=>!l});return(0,n.useEffect)((()=>{l&&h(!l)}),[p,l,h]),(0,d.jsxs)("li",{className:(0,o.A)("menu__list-item",{"menu__list-item--collapsed":u}),children:[(0,d.jsx)(re,{role:"button",className:(0,o.A)(pe.dropdownNavbarItemMobile,"menu__link menu__link--sublist menu__link--sublist-caret",r),...c,onClick:e=>{e.preventDefault(),m()},children:c.children??c.label}),(0,d.jsx)(se.N,{lazy:!0,as:"ul",className:"menu__list",collapsed:u,children:t.map(((e,t)=>(0,n.createElement)(We,{mobile:!0,isDropdownItem:!0,onClick:s,activeClassName:"menu__link--active",...e,key:t})))})]})}function me(e){let{mobile:t=!1,...r}=e;const n=t?ue:le;return(0,d.jsx)(n,{...r})}var he=r(32131);function fe(e){let{width:t=20,height:r=20,...n}=e;return(0,d.jsx)("svg",{viewBox:"0 0 24 24",width:t,height:r,"aria-hidden":!0,...n,children:(0,d.jsx)("path",{fill:"currentColor",d:"M12.87 15.07l-2.54-2.51.03-.03c1.74-1.94 2.98-4.17 3.71-6.53H17V4h-7V2H8v2H1v1.99h11.17C11.5 7.92 10.44 9.75 9 11.35 8.07 10.32 7.3 9.19 6.69 8h-2c.73 1.63 1.73 3.17 2.98 4.56l-5.09 5.02L4 19l5-5 3.11 3.11.76-2.04zM18.5 10h-2L12 22h2l1.12-3h4.75L21 22h2l-4.5-12zm-2.62 7l1.62-4.33L19.12 17h-3.24z"})})}const ge="iconLanguage_nlXk";var ye=r(40961);function be(){return n.createElement("svg",{width:"15",height:"15",className:"DocSearch-Control-Key-Icon"},n.createElement("path",{d:"M4.505 4.496h2M5.505 5.496v5M8.216 4.496l.055 5.993M10 7.5c.333.333.5.667.5 1v2M12.326 4.5v5.996M8.384 4.496c1.674 0 2.116 0 2.116 1.5s-.442 1.5-2.116 1.5M3.205 9.303c-.09.448-.277 1.21-1.241 1.203C1 10.5.5 9.513.5 8V7c0-1.57.5-2.5 1.464-2.494.964.006 1.134.598 1.24 1.342M12.553 10.5h1.953",strokeWidth:"1.2",stroke:"currentColor",fill:"none",strokeLinecap:"square"}))}var _e=r(89188),ve=["translations"];function xe(){return xe=Object.assign||function(e){for(var t=1;t<arguments.length;t++){var r=arguments[t];for(var n in r)Object.prototype.hasOwnProperty.call(r,n)&&(e[n]=r[n])}return e},xe.apply(this,arguments)}function we(e,t){return function(e){if(Array.isArray(e))return e}(e)||function(e,t){var r=null==e?null:"undefined"!=typeof Symbol&&e[Symbol.iterator]||e["@@iterator"];if(null==r)return;var n,o,i=[],s=!0,a=!1;try{for(r=r.call(e);!(s=(n=r.next()).done)&&(i.push(n.value),!t||i.length!==t);s=!0);}catch(c){a=!0,o=c}finally{try{s||null==r.return||r.return()}finally{if(a)throw o}}return i}(e,t)||function(e,t){if(!e)return;if("string"==typeof e)return ke(e,t);var r=Object.prototype.toString.call(e).slice(8,-1);"Object"===r&&e.constructor&&(r=e.constructor.name);if("Map"===r||"Set"===r)return Array.from(e);if("Arguments"===r||/^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(r))return ke(e,t)}(e,t)||function(){throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.")}()}function ke(e,t){(null==t||t>e.length)&&(t=e.length);for(var r=0,n=new Array(t);r<t;r++)n[r]=e[r];return n}function Se(e,t){if(null==e)return{};var r,n,o=function(e,t){if(null==e)return{};var r,n,o={},i=Object.keys(e);for(n=0;n<i.length;n++)r=i[n],t.indexOf(r)>=0||(o[r]=e[r]);return o}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n<i.length;n++)r=i[n],t.indexOf(r)>=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(o[r]=e[r])}return o}var Te="Ctrl";var Ce=n.forwardRef((function(e,t){var r=e.translations,o=void 0===r?{}:r,i=Se(e,ve),s=o.buttonText,a=void 0===s?"Search":s,c=o.buttonAriaLabel,p=void 0===c?"Search":c,d=we((0,n.useState)(null),2),l=d[0],u=d[1];return(0,n.useEffect)((function(){"undefined"!=typeof navigator&&(/(Mac|iPhone|iPod|iPad)/i.test(navigator.platform)?u("\u2318"):u(Te))}),[]),n.createElement("button",xe({type:"button",className:"DocSearch DocSearch-Button","aria-label":p},i,{ref:t}),n.createElement("span",{className:"DocSearch-Button-Container"},n.createElement(_e.W,null),n.createElement("span",{className:"DocSearch-Button-Placeholder"},a)),n.createElement("span",{className:"DocSearch-Button-Keys"},null!==l&&n.createElement(n.Fragment,null,n.createElement(Ae,{reactsToKey:l===Te?Te:"Meta"},l===Te?n.createElement(be,null):l),n.createElement(Ae,{reactsToKey:"k"},"K"))))}));function Ae(e){var t=e.reactsToKey,r=e.children,o=we((0,n.useState)(!1),2),i=o[0],s=o[1];return(0,n.useEffect)((function(){if(t)return window.addEventListener("keydown",e),window.addEventListener("keyup",r),function(){window.removeEventListener("keydown",e),window.removeEventListener("keyup",r)};function e(e){e.key===t&&s(!0)}function r(e){e.key!==t&&"Meta"!==e.key||s(!1)}}),[t]),n.createElement("kbd",{className:i?"DocSearch-Button-Key DocSearch-Button-Key--pressed":"DocSearch-Button-Key"},r)}var Ie=r(5260),je=r(24255),Ee=r(51062),Pe=r(2967);const Re={button:{buttonText:(0,c.T)({id:"theme.SearchBar.label",message:"Search",description:"The ARIA label and placeholder for search button"}),buttonAriaLabel:(0,c.T)({id:"theme.SearchBar.label",message:"Search",description:"The ARIA label and placeholder for search button"})},modal:{searchBox:{resetButtonTitle:(0,c.T)({id:"theme.SearchModal.searchBox.resetButtonTitle",message:"Clear the query",description:"The label and ARIA label for search box reset button"}),resetButtonAriaLabel:(0,c.T)({id:"theme.SearchModal.searchBox.resetButtonTitle",message:"Clear the query",description:"The label and ARIA label for search box reset button"}),cancelButtonText:(0,c.T)({id:"theme.SearchModal.searchBox.cancelButtonText",message:"Cancel",description:"The label and ARIA label for search box cancel button"}),cancelButtonAriaLabel:(0,c.T)({id:"theme.SearchModal.searchBox.cancelButtonText",message:"Cancel",description:"The label and ARIA label for search box cancel button"})},startScreen:{recentSearchesTitle:(0,c.T)({id:"theme.SearchModal.startScreen.recentSearchesTitle",message:"Recent",description:"The title for recent searches"}),noRecentSearchesText:(0,c.T)({id:"theme.SearchModal.startScreen.noRecentSearchesText",message:"No recent searches",description:"The text when no recent searches"}),saveRecentSearchButtonTitle:(0,c.T)({id:"theme.SearchModal.startScreen.saveRecentSearchButtonTitle",message:"Save this search",description:"The label for save recent search button"}),removeRecentSearchButtonTitle:(0,c.T)({id:"theme.SearchModal.startScreen.removeRecentSearchButtonTitle",message:"Remove this search from history",description:"The label for remove recent search button"}),favoriteSearchesTitle:(0,c.T)({id:"theme.SearchModal.startScreen.favoriteSearchesTitle",message:"Favorite",description:"The title for favorite searches"}),removeFavoriteSearchButtonTitle:(0,c.T)({id:"theme.SearchModal.startScreen.removeFavoriteSearchButtonTitle",message:"Remove this search from favorites",description:"The label for remove favorite search button"})},errorScreen:{titleText:(0,c.T)({id:"theme.SearchModal.errorScreen.titleText",message:"Unable to fetch results",description:"The title for error screen of search modal"}),helpText:(0,c.T)({id:"theme.SearchModal.errorScreen.helpText",message:"You might want to check your network connection.",description:"The help text for error screen of search modal"})},footer:{selectText:(0,c.T)({id:"theme.SearchModal.footer.selectText",message:"to select",description:"The explanatory text of the action for the enter key"}),selectKeyAriaLabel:(0,c.T)({id:"theme.SearchModal.footer.selectKeyAriaLabel",message:"Enter key",description:"The ARIA label for the Enter key button that makes the selection"}),navigateText:(0,c.T)({id:"theme.SearchModal.footer.navigateText",message:"to navigate",description:"The explanatory text of the action for the Arrow up and Arrow down key"}),navigateUpKeyAriaLabel:(0,c.T)({id:"theme.SearchModal.footer.navigateUpKeyAriaLabel",message:"Arrow up",description:"The ARIA label for the Arrow up key button that makes the navigation"}),navigateDownKeyAriaLabel:(0,c.T)({id:"theme.SearchModal.footer.navigateDownKeyAriaLabel",message:"Arrow down",description:"The ARIA label for the Arrow down key button that makes the navigation"}),closeText:(0,c.T)({id:"theme.SearchModal.footer.closeText",message:"to close",description:"The explanatory text of the action for Escape key"}),closeKeyAriaLabel:(0,c.T)({id:"theme.SearchModal.footer.closeKeyAriaLabel",message:"Escape key",description:"The ARIA label for the Escape key button that close the modal"}),searchByText:(0,c.T)({id:"theme.SearchModal.footer.searchByText",message:"Search by",description:"The text explain that the search is making by Algolia"})},noResultsScreen:{noResultsText:(0,c.T)({id:"theme.SearchModal.noResultsScreen.noResultsText",message:"No results for",description:"The text explains that there are no results for the following search"}),suggestedQueryText:(0,c.T)({id:"theme.SearchModal.noResultsScreen.suggestedQueryText",message:"Try searching for",description:"The text for the suggested query when no results are found for the following search"}),reportMissingResultsText:(0,c.T)({id:"theme.SearchModal.noResultsScreen.reportMissingResultsText",message:"Believe this query should return results?",description:"The text for the question where the user thinks there are missing results"}),reportMissingResultsLinkText:(0,c.T)({id:"theme.SearchModal.noResultsScreen.reportMissingResultsLinkText",message:"Let us know.",description:"The text for the link to report missing results"})}},placeholder:(0,c.T)({id:"theme.SearchModal.placeholder",message:"Search docs",description:"The placeholder of the input of the DocSearch pop-up modal"})};let Oe=null;function qe(e){let{hit:t,children:r}=e;return(0,d.jsx)(J.A,{to:t.url,children:r})}function $e(e){let{state:t,onClose:r}=e;const n=(0,je.w)();return(0,d.jsx)(J.A,{to:n(t.query),onClick:r,children:(0,d.jsx)(c.A,{id:"theme.SearchBar.seeAll",values:{count:t.context.nbHits},children:"See all {count} results"})})}function De(e){let{contextualSearch:t,externalUrlRegex:o,...i}=e;const{siteMetadata:s}=(0,ce.A)(),c=(0,Ee.C)(),p=function(){const{locale:e,tags:t}=(0,Pe.af)();return[`language:${e}`,t.map((e=>`docusaurus_tag:${e}`))]}(),l=i.searchParameters?.facetFilters??[],u=t?function(e,t){const r=e=>"string"==typeof e?[e]:e;return[...r(e),...r(t)]}(p,l):l,m={...i.searchParameters,facetFilters:u},h=(0,a.W6)(),f=(0,n.useRef)(null),g=(0,n.useRef)(null),[y,b]=(0,n.useState)(!1),[_,v]=(0,n.useState)(void 0),x=(0,n.useCallback)((()=>Oe?Promise.resolve():Promise.all([r.e(9462).then(r.bind(r,9462)),Promise.all([r.e(71869),r.e(58913)]).then(r.bind(r,58913)),Promise.all([r.e(71869),r.e(90416)]).then(r.bind(r,90416))]).then((e=>{let[{DocSearchModal:t}]=e;Oe=t}))),[]),w=(0,n.useCallback)((()=>{if(!f.current){const e=document.createElement("div");f.current=e,document.body.insertBefore(e,document.body.firstChild)}}),[]),k=(0,n.useCallback)((()=>{w(),x().then((()=>b(!0)))}),[x,w]),S=(0,n.useCallback)((()=>{b(!1),g.current?.focus()}),[]),T=(0,n.useCallback)((e=>{e.preventDefault(),v(e.key),k()}),[k]),C=(0,n.useRef)({navigate(e){let{itemUrl:t}=e;(0,ee.G)(o,t)?window.location.href=t:h.push(t)}}).current,A=(0,n.useRef)((e=>i.transformItems?i.transformItems(e):e.map((e=>({...e,url:c(e.url)}))))).current,I=(0,n.useMemo)((()=>e=>(0,d.jsx)($e,{...e,onClose:S})),[S]),j=(0,n.useCallback)((e=>(e.addAlgoliaAgent("docusaurus",s.docusaurusVersion),e)),[s.docusaurusVersion]);return function(e){var t=e.isOpen,r=e.onOpen,o=e.onClose,i=e.onInput,s=e.searchButtonRef;n.useEffect((function(){function e(e){var n;(27===e.keyCode&&t||"k"===(null===(n=e.key)||void 0===n?void 0:n.toLowerCase())&&(e.metaKey||e.ctrlKey)||!function(e){var t=e.target,r=t.tagName;return t.isContentEditable||"INPUT"===r||"SELECT"===r||"TEXTAREA"===r}(e)&&"/"===e.key&&!t)&&(e.preventDefault(),t?o():document.body.classList.contains("DocSearch--active")||document.body.classList.contains("DocSearch--active")||r()),s&&s.current===document.activeElement&&i&&/[a-zA-Z0-9]/.test(String.fromCharCode(e.keyCode))&&i(e)}return window.addEventListener("keydown",e),function(){window.removeEventListener("keydown",e)}}),[t,r,o,i,s])}({isOpen:y,onOpen:k,onClose:S,onInput:T,searchButtonRef:g}),(0,d.jsxs)(d.Fragment,{children:[(0,d.jsx)(Ie.A,{children:(0,d.jsx)("link",{rel:"preconnect",href:`https://${i.appId}-dsn.algolia.net`,crossOrigin:"anonymous"})}),(0,d.jsx)(Ce,{onTouchStart:x,onFocus:x,onMouseOver:x,onClick:k,ref:g,translations:Re.button}),y&&Oe&&f.current&&(0,ye.createPortal)((0,d.jsx)(Oe,{onClose:S,initialScrollY:window.scrollY,initialQuery:_,navigator:C,transformItems:A,hitComponent:qe,transformSearchClient:j,...i.searchPagePath&&{resultsFooterComponent:I},...i,searchParameters:m,placeholder:Re.placeholder,translations:Re.modal}),f.current)]})}function Be(){const{siteConfig:e}=(0,ce.A)();return(0,d.jsx)(De,{...e.themeConfig.algolia})}const Le={navbarSearchContainer:"navbarSearchContainer_Bca1"};function Ue(e){let{children:t,className:r}=e;return(0,d.jsx)("div",{className:(0,o.A)(r,Le.navbarSearchContainer),children:t})}var Ne=r(48295),Fe=r(84142);var Me=r(55597);const Ge=e=>e.docs.find((t=>t.id===e.mainDocId));const ze={default:ie,localeDropdown:function(e){let{mobile:t,dropdownItemsBefore:r,dropdownItemsAfter:n,queryString:o="",...i}=e;const{i18n:{currentLocale:s,locales:p,localeConfigs:l}}=(0,ce.A)(),u=(0,he.o)(),{search:m,hash:h}=(0,a.zy)(),f=[...r,...p.map((e=>{const r=`${`pathname://${u.createUrl({locale:e,fullyQualified:!1})}`}${m}${h}${o}`;return{label:l[e].label,lang:l[e].htmlLang,to:r,target:"_self",autoAddBaseUrl:!1,className:e===s?t?"menu__link--active":"dropdown__link--active":""}})),...n],g=t?(0,c.T)({message:"Languages",id:"theme.navbar.mobileLanguageDropdown.label",description:"The label for the mobile language switcher dropdown"}):l[s].label;return(0,d.jsx)(me,{...i,mobile:t,label:(0,d.jsxs)(d.Fragment,{children:[(0,d.jsx)(fe,{className:ge}),g]}),items:f})},search:function(e){let{mobile:t,className:r}=e;return t?null:(0,d.jsx)(Ue,{className:r,children:(0,d.jsx)(Be,{})})},dropdown:me,html:function(e){let{value:t,className:r,mobile:n=!1,isDropdownItem:i=!1}=e;const s=i?"li":"div";return(0,d.jsx)(s,{className:(0,o.A)({navbar__item:!n&&!i,"menu__list-item":n},r),dangerouslySetInnerHTML:{__html:t}})},doc:function(e){let{docId:t,label:r,docsPluginId:n,...o}=e;const{activeDoc:i}=(0,Ne.zK)(n),s=(0,Fe.QB)(t,n),a=i?.path===s?.path;return null===s||s.unlisted&&!a?null:(0,d.jsx)(ie,{exact:!0,...o,isActive:()=>a||!!i?.sidebar&&i.sidebar===s.sidebar,label:r??s.id,to:s.path})},docSidebar:function(e){let{sidebarId:t,label:r,docsPluginId:n,...o}=e;const{activeDoc:i}=(0,Ne.zK)(n),s=(0,Fe.fW)(t,n).link;if(!s)throw new Error(`DocSidebarNavbarItem: Sidebar with ID "${t}" doesn't have anything to be linked to.`);return(0,d.jsx)(ie,{exact:!0,...o,isActive:()=>i?.sidebar===t,label:r??s.label,to:s.path})},docsVersion:function(e){let{label:t,to:r,docsPluginId:n,...o}=e;const i=(0,Fe.Vd)(n)[0],s=t??i.label,a=r??(e=>e.docs.find((t=>t.id===e.mainDocId)))(i).path;return(0,d.jsx)(ie,{...o,label:s,to:a})},docsVersionDropdown:function(e){let{mobile:t,docsPluginId:r,dropdownActiveClassDisabled:n,dropdownItemsBefore:o,dropdownItemsAfter:i,...s}=e;const{search:p,hash:l}=(0,a.zy)(),u=(0,Ne.zK)(r),m=(0,Ne.jh)(r),{savePreferredVersionName:h}=(0,Me.g1)(r),f=[...o,...m.map((e=>{const t=u.alternateDocVersions[e.name]??Ge(e);return{label:e.label,to:`${t.path}${p}${l}`,isActive:()=>e===u.activeVersion,onClick:()=>h(e.name)}})),...i],g=(0,Fe.Vd)(r)[0],y=t&&f.length>1?(0,c.T)({id:"theme.navbar.mobileVersionsDropdown.label",message:"Versions",description:"The label for the navbar versions dropdown on mobile view"}):g.label,b=t&&f.length>1?void 0:Ge(g).path;return f.length<=1?(0,d.jsx)(ie,{...s,mobile:t,label:y,to:b,isActive:n?()=>!1:void 0}):(0,d.jsx)(me,{...s,mobile:t,label:y,to:b,items:f,isActive:n?()=>!1:void 0})}};function We(e){let{type:t,...r}=e;const n=function(e,t){return e&&"default"!==e?e:"items"in t?"dropdown":"default"}(t,r),o=ze[n];if(!o)throw new Error(`No NavbarItem component found for type "${t}".`);return(0,d.jsx)(o,{...r})}function He(){const e=(0,j.M)(),t=(0,v.p)().navbar.items;return(0,d.jsx)("ul",{className:"menu__list",children:t.map(((t,r)=>(0,n.createElement)(We,{mobile:!0,...t,onClick:()=>e.toggle(),key:r})))})}function Ze(e){return(0,d.jsx)("button",{...e,type:"button",className:"clean-btn navbar-sidebar__back",children:(0,d.jsx)(c.A,{id:"theme.navbar.mobileSidebarSecondaryMenu.backButtonLabel",description:"The label of the back button to return to main menu, inside the mobile navbar sidebar secondary menu (notably used to display the docs sidebar)",children:"\u2190 Back to main menu"})})}function Ve(){const e=0===(0,v.p)().navbar.items.length,t=D();return(0,d.jsxs)(d.Fragment,{children:[!e&&(0,d.jsx)(Ze,{onClick:()=>t.hide()}),t.content]})}function Ke(){const e=(0,j.M)();var t;return void 0===(t=e.shown)&&(t=!0),(0,n.useEffect)((()=>(document.body.style.overflow=t?"hidden":"visible",()=>{document.body.style.overflow="visible"})),[t]),e.shouldRender?(0,d.jsx)(B,{header:(0,d.jsx)(Y,{}),primaryMenu:(0,d.jsx)(He,{}),secondaryMenu:(0,d.jsx)(Ve,{})}):null}const Ye={navbarHideable:"navbarHideable_m1mJ",navbarHidden:"navbarHidden_jGov"};function Je(e){return(0,d.jsx)("div",{role:"presentation",...e,className:(0,o.A)("navbar-sidebar__backdrop",e.className)})}function Xe(e){let{children:t}=e;const{navbar:{hideOnScroll:r,style:i}}=(0,v.p)(),s=(0,j.M)(),{navbarRef:a,isNavbarVisible:l}=function(e){const[t,r]=(0,n.useState)(e),o=(0,n.useRef)(!1),i=(0,n.useRef)(0),s=(0,n.useCallback)((e=>{null!==e&&(i.current=e.getBoundingClientRect().height)}),[]);return(0,E.Mq)(((t,n)=>{let{scrollY:s}=t;if(!e)return;if(s<i.current)return void r(!0);if(o.current)return void(o.current=!1);const a=n?.scrollY,c=document.documentElement.scrollHeight-i.current,p=window.innerHeight;a&&s>=a?r(!1):s+p<c&&r(!0)})),(0,p.$)((t=>{if(!e)return;const n=t.location.hash;if(n?document.getElementById(n.substring(1)):void 0)return o.current=!0,void r(!1);r(!0)})),{navbarRef:s,isNavbarVisible:t}}(r);return(0,d.jsxs)("nav",{ref:a,"aria-label":(0,c.T)({id:"theme.NavBar.navAriaLabel",message:"Main",description:"The ARIA label for the main navigation"}),className:(0,o.A)("navbar","navbar--fixed-top",r&&[Ye.navbarHideable,!l&&Ye.navbarHidden],{"navbar--dark":"dark"===i,"navbar--primary":"primary"===i,"navbar-sidebar--show":s.shown}),children:[t,(0,d.jsx)(Je,{onClick:s.toggle}),(0,d.jsx)(Ke,{})]})}var Qe=r(12181);const et="right";function tt(e){let{width:t=30,height:r=30,className:n,...o}=e;return(0,d.jsx)("svg",{className:n,width:t,height:r,viewBox:"0 0 30 30","aria-hidden":"true",...o,children:(0,d.jsx)("path",{stroke:"currentColor",strokeLinecap:"round",strokeMiterlimit:"10",strokeWidth:"2",d:"M4 7h22M4 15h22M4 23h22"})})}function rt(){const{toggle:e,shown:t}=(0,j.M)();return(0,d.jsx)("button",{onClick:e,"aria-label":(0,c.T)({id:"theme.docs.sidebar.toggleSidebarButtonAriaLabel",message:"Toggle navigation bar",description:"The ARIA label for hamburger menu button of mobile navigation"}),"aria-expanded":t,className:"navbar__toggle clean-btn",type:"button",children:(0,d.jsx)(tt,{})})}const nt={colorModeToggle:"colorModeToggle_DEke"};function ot(e){let{items:t}=e;return(0,d.jsx)(d.Fragment,{children:t.map(((e,t)=>(0,d.jsx)(Qe.k2,{onError:t=>new Error(`A theme navbar item failed to render.\nPlease double-check the following navbar item (themeConfig.navbar.items) of your Docusaurus config:\n${JSON.stringify(e,null,2)}`,{cause:t}),children:(0,d.jsx)(We,{...e})},t)))})}function it(e){let{left:t,right:r}=e;return(0,d.jsxs)("div",{className:"navbar__inner",children:[(0,d.jsx)("div",{className:"navbar__items",children:t}),(0,d.jsx)("div",{className:"navbar__items navbar__items--right",children:r})]})}function st(){const e=(0,j.M)(),t=(0,v.p)().navbar.items,[r,n]=function(e){function t(e){return"left"===(e.position??et)}return[e.filter(t),e.filter((e=>!t(e)))]}(t),o=t.find((e=>"search"===e.type));return(0,d.jsx)(it,{left:(0,d.jsxs)(d.Fragment,{children:[!e.disabled&&(0,d.jsx)(rt,{}),(0,d.jsx)(V,{}),(0,d.jsx)(ot,{items:r})]}),right:(0,d.jsxs)(d.Fragment,{children:[(0,d.jsx)(ot,{items:n}),(0,d.jsx)(H,{className:nt.colorModeToggle}),!o&&(0,d.jsx)(Ue,{children:(0,d.jsx)(Be,{})})]})})}function at(){return(0,d.jsx)(Xe,{children:(0,d.jsx)(st,{})})}function ct(e){let{item:t}=e;const{to:r,href:n,label:o,prependBaseUrlToHref:i,...s}=t,a=(0,X.Ay)(r),c=(0,X.Ay)(n,{forcePrependBaseUrl:!0});return(0,d.jsxs)(J.A,{className:"footer__link-item",...n?{href:i?c:n}:{to:a},...s,children:[o,n&&!(0,Q.A)(n)&&(0,d.jsx)(te.A,{})]})}function pt(e){let{item:t}=e;return t.html?(0,d.jsx)("li",{className:"footer__item",dangerouslySetInnerHTML:{__html:t.html}}):(0,d.jsx)("li",{className:"footer__item",children:(0,d.jsx)(ct,{item:t})},t.href??t.to)}function dt(e){let{column:t}=e;return(0,d.jsxs)("div",{className:"col footer__col",children:[(0,d.jsx)("div",{className:"footer__title",children:t.title}),(0,d.jsx)("ul",{className:"footer__items clean-list",children:t.items.map(((e,t)=>(0,d.jsx)(pt,{item:e},t)))})]})}function lt(e){let{columns:t}=e;return(0,d.jsx)("div",{className:"row footer__links",children:t.map(((e,t)=>(0,d.jsx)(dt,{column:e},t)))})}function ut(){return(0,d.jsx)("span",{className:"footer__link-separator",children:"\xb7"})}function mt(e){let{item:t}=e;return t.html?(0,d.jsx)("span",{className:"footer__link-item",dangerouslySetInnerHTML:{__html:t.html}}):(0,d.jsx)(ct,{item:t})}function ht(e){let{links:t}=e;return(0,d.jsx)("div",{className:"footer__links text--center",children:(0,d.jsx)("div",{className:"footer__links",children:t.map(((e,r)=>(0,d.jsxs)(n.Fragment,{children:[(0,d.jsx)(mt,{item:e}),t.length!==r+1&&(0,d.jsx)(ut,{})]},r)))})})}function ft(e){let{links:t}=e;return function(e){return"title"in e[0]}(t)?(0,d.jsx)(lt,{columns:t}):(0,d.jsx)(ht,{links:t})}var gt=r(21122);const yt={footerLogoLink:"footerLogoLink_BH7S"};function bt(e){let{logo:t}=e;const{withBaseUrl:r}=(0,X.hH)(),n={light:r(t.src),dark:r(t.srcDark??t.src)};return(0,d.jsx)(gt.A,{className:(0,o.A)("footer__logo",t.className),alt:t.alt,sources:n,width:t.width,height:t.height,style:t.style})}function _t(e){let{logo:t}=e;return t.href?(0,d.jsx)(J.A,{href:t.href,className:yt.footerLogoLink,target:t.target,children:(0,d.jsx)(bt,{logo:t})}):(0,d.jsx)(bt,{logo:t})}function vt(e){let{copyright:t}=e;return(0,d.jsx)("div",{className:"footer__copyright",dangerouslySetInnerHTML:{__html:t}})}function xt(e){let{style:t,links:r,logo:n,copyright:i}=e;return(0,d.jsx)("footer",{className:(0,o.A)("footer",{"footer--dark":"dark"===t}),children:(0,d.jsxs)("div",{className:"container container-fluid",children:[r,(n||i)&&(0,d.jsxs)("div",{className:"footer__bottom text--center",children:[n&&(0,d.jsx)("div",{className:"margin-bottom--sm",children:n}),i]})]})})}function wt(){const{footer:e}=(0,v.p)();if(!e)return null;const{copyright:t,links:r,logo:n,style:o}=e;return(0,d.jsx)(xt,{style:o,links:r&&r.length>0&&(0,d.jsx)(ft,{links:r}),logo:n&&(0,d.jsx)(_t,{logo:n}),copyright:t&&(0,d.jsx)(vt,{copyright:t})})}const kt=n.memo(wt),St={banner:"banner_oA5J",bannerHidden:"bannerHidden_Dojd",approveButton:"approveButton_Kgax",infoLink:"infoLink_VhZJ",actions:"actions_nCnX"};var Tt=r(20053);const Ct="cookie-notice-dismissed";function At(){const[e,t]=(0,n.useState)((()=>"true"===function(e){for(var t=e+"=",r=document.cookie.split(";"),n=0;n<r.length;n++){for(var o=r[n];" "==o.charAt(0);)o=o.substring(1,o.length);if(0==o.indexOf(t))return o.substring(t.length,o.length)}return null}(Ct)));return(0,d.jsxs)("section",{className:(0,Tt.A)(St.banner,e&&St.bannerHidden),children:[(0,d.jsx)("span",{children:"We would like to use third party cookies and scripts to improve the functionality of this website."}),(0,d.jsxs)("span",{className:St.actions,children:[(0,d.jsx)("a",{className:St.infoLink,href:"https://boldcommerce.com/privacy",children:"More info"}),(0,d.jsx)("a",{className:St.approveButton,onClick:()=>{!function(e,t,r){var n="";if(r){var o=new Date;o.setTime(o.getTime()+24*r*60*60*1e3),n="; expires="+o.toUTCString()}document.cookie=e+"="+t+n+"; path=/; SameSite=Strict"}(Ct,"true",31),t(!0)},children:"Approve"})]})]})}function It(e){let{children:t,fallback:r}=e;return(0,U.A)()?(0,d.jsx)(d.Fragment,{children:t?.()}):r??null}function jt(e){return(0,d.jsxs)(d.Fragment,{children:[(0,d.jsx)(kt,{...e}),(0,d.jsx)(It,{children:()=>(0,d.jsx)(At,{})})]})}const Et=(0,P.fM)([L.a,x.o,E.Tv,Me.VQ,s.Jx,function(e){let{children:t}=e;return(0,d.jsx)(R.y_,{children:(0,d.jsx)(j.e,{children:(0,d.jsx)(q,{children:t})})})}]);function Pt(e){let{children:t}=e;return(0,d.jsx)(Et,{children:t})}var Rt=r(51107);function Ot(e){let{error:t,tryAgain:r}=e;return(0,d.jsx)("main",{className:"container margin-vert--xl",children:(0,d.jsx)("div",{className:"row",children:(0,d.jsxs)("div",{className:"col col--6 col--offset-3",children:[(0,d.jsx)(Rt.A,{as:"h1",className:"hero__title",children:(0,d.jsx)(c.A,{id:"theme.ErrorPageContent.title",description:"The title of the fallback page when the page crashed",children:"This page crashed."})}),(0,d.jsx)("div",{className:"margin-vert--lg",children:(0,d.jsx)(Qe.a2,{onClick:r,className:"button button--primary shadow--lw"})}),(0,d.jsx)("hr",{}),(0,d.jsx)("div",{className:"margin-vert--md",children:(0,d.jsx)(Qe.bq,{error:t})})]})})})}const qt={mainWrapper:"mainWrapper_z2l0"};function $t(e){const{children:t,noFooter:r,wrapperClassName:n,title:a,description:c}=e;return(0,y.J)(),(0,d.jsxs)(Pt,{children:[(0,d.jsx)(s.be,{title:a,description:c}),(0,d.jsx)(_,{}),(0,d.jsx)(I,{}),(0,d.jsx)(at,{}),(0,d.jsx)("div",{id:l,className:(0,o.A)(g.G.wrapper.main,qt.mainWrapper,n),children:(0,d.jsx)(i.A,{fallback:e=>(0,d.jsx)(Ot,{...e}),children:t})}),!r&&(0,d.jsx)(jt,{})]})}},23465:(e,t,r)=>{"use strict";r.d(t,{A:()=>d});r(96540);var n=r(28774),o=r(86025),i=r(44586),s=r(6342),a=r(21122),c=r(74848);function p(e){let{logo:t,alt:r,imageClassName:n}=e;const i={light:(0,o.Ay)(t.src),dark:(0,o.Ay)(t.srcDark||t.src)},s=(0,c.jsx)(a.A,{className:t.className,sources:i,height:t.height,width:t.width,alt:r,style:t.style});return n?(0,c.jsx)("div",{className:n,children:s}):s}function d(e){const{siteConfig:{title:t}}=(0,i.A)(),{navbar:{title:r,logo:a}}=(0,s.p)(),{imageClassName:d,titleClassName:l,...u}=e,m=(0,o.Ay)(a?.href||"/"),h=r?"":t,f=a?.alt??h;return(0,c.jsxs)(n.A,{to:m,...u,...a?.target&&{target:a.target},children:[a&&(0,c.jsx)(p,{logo:a,alt:f,imageClassName:d}),null!=r&&(0,c.jsx)("b",{className:l,children:r})]})}},41463:(e,t,r)=>{"use strict";r.d(t,{A:()=>i});r(96540);var n=r(5260),o=r(74848);function i(e){let{locale:t,version:r,tag:i}=e;const s=t;return(0,o.jsxs)(n.A,{children:[t&&(0,o.jsx)("meta",{name:"docusaurus_locale",content:t}),r&&(0,o.jsx)("meta",{name:"docusaurus_version",content:r}),i&&(0,o.jsx)("meta",{name:"docusaurus_tag",content:i}),s&&(0,o.jsx)("meta",{name:"docsearch:language",content:s}),r&&(0,o.jsx)("meta",{name:"docsearch:version",content:r}),i&&(0,o.jsx)("meta",{name:"docsearch:docusaurus_tag",content:i})]})}},21122:(e,t,r)=>{"use strict";r.d(t,{A:()=>d});var n=r(96540),o=r(15066),i=r(92303),s=r(95293);const a={themedComponent:"themedComponent_mlkZ","themedComponent--light":"themedComponent--light_NVdE","themedComponent--dark":"themedComponent--dark_xIcU"};var c=r(74848);function p(e){let{className:t,children:r}=e;const p=(0,i.A)(),{colorMode:d}=(0,s.G)();return(0,c.jsx)(c.Fragment,{children:(p?"dark"===d?["dark"]:["light"]:["light","dark"]).map((e=>{const i=r({theme:e,className:(0,o.A)(t,a.themedComponent,a[`themedComponent--${e}`])});return(0,c.jsx)(n.Fragment,{children:i},e)}))})}function d(e){const{sources:t,className:r,alt:n,...o}=e;return(0,c.jsx)(p,{className:r,children:e=>{let{theme:r,className:i}=e;return(0,c.jsx)("img",{src:t[r],alt:n,className:i,...o})}})}},41422:(e,t,r)=>{"use strict";r.d(t,{N:()=>y,u:()=>p});var n=r(96540),o=r(38193),i=r(205),s=r(53109),a=r(74848);const c="ease-in-out";function p(e){let{initialState:t}=e;const[r,o]=(0,n.useState)(t??!1),i=(0,n.useCallback)((()=>{o((e=>!e))}),[]);return{collapsed:r,setCollapsed:o,toggleCollapsed:i}}const d={display:"none",overflow:"hidden",height:"0px"},l={display:"block",overflow:"visible",height:"auto"};function u(e,t){const r=t?d:l;e.style.display=r.display,e.style.overflow=r.overflow,e.style.height=r.height}function m(e){let{collapsibleRef:t,collapsed:r,animation:o}=e;const i=(0,n.useRef)(!1);(0,n.useEffect)((()=>{const e=t.current;function n(){const t=e.scrollHeight,r=o?.duration??function(e){if((0,s.O)())return 1;const t=e/36;return Math.round(10*(4+15*t**.25+t/5))}(t);return{transition:`height ${r}ms ${o?.easing??c}`,height:`${t}px`}}function a(){const t=n();e.style.transition=t.transition,e.style.height=t.height}if(!i.current)return u(e,r),void(i.current=!0);return e.style.willChange="height",function(){const t=requestAnimationFrame((()=>{r?(a(),requestAnimationFrame((()=>{e.style.height=d.height,e.style.overflow=d.overflow}))):(e.style.display="block",requestAnimationFrame((()=>{a()})))}));return()=>cancelAnimationFrame(t)}()}),[t,r,o])}function h(e){if(!o.default.canUseDOM)return e?d:l}function f(e){let{as:t="div",collapsed:r,children:o,animation:i,onCollapseTransitionEnd:s,className:c,disableSSRStyle:p}=e;const d=(0,n.useRef)(null);return m({collapsibleRef:d,collapsed:r,animation:i}),(0,a.jsx)(t,{ref:d,style:p?void 0:h(r),onTransitionEnd:e=>{"height"===e.propertyName&&(u(d.current,r),s?.(r))},className:c,children:o})}function g(e){let{collapsed:t,...r}=e;const[o,s]=(0,n.useState)(!t),[c,p]=(0,n.useState)(t);return(0,i.A)((()=>{t||s(!0)}),[t]),(0,i.A)((()=>{o&&p(t)}),[o,t]),o?(0,a.jsx)(f,{...r,collapsed:c}):null}function y(e){let{lazy:t,...r}=e;const n=t?g:f;return(0,a.jsx)(n,{...r})}},65041:(e,t,r)=>{"use strict";r.d(t,{M:()=>f,o:()=>h});var n=r(96540),o=r(92303),i=r(70679),s=r(89532),a=r(6342),c=r(74848);const p=(0,i.Wf)("docusaurus.announcement.dismiss"),d=(0,i.Wf)("docusaurus.announcement.id"),l=()=>"true"===p.get(),u=e=>p.set(String(e)),m=n.createContext(null);function h(e){let{children:t}=e;const r=function(){const{announcementBar:e}=(0,a.p)(),t=(0,o.A)(),[r,i]=(0,n.useState)((()=>!!t&&l()));(0,n.useEffect)((()=>{i(l())}),[]);const s=(0,n.useCallback)((()=>{u(!0),i(!0)}),[]);return(0,n.useEffect)((()=>{if(!e)return;const{id:t}=e;let r=d.get();"annoucement-bar"===r&&(r="announcement-bar");const n=t!==r;d.set(t),n&&u(!1),!n&&l()||i(!1)}),[e]),(0,n.useMemo)((()=>({isActive:!!e&&!r,close:s})),[e,r,s])}();return(0,c.jsx)(m.Provider,{value:r,children:t})}function f(){const e=(0,n.useContext)(m);if(!e)throw new s.dV("AnnouncementBarProvider");return e}},95293:(e,t,r)=>{"use strict";r.d(t,{G:()=>y,a:()=>g});var n=r(96540),o=r(38193),i=r(89532),s=r(70679),a=r(6342),c=r(74848);const p=n.createContext(void 0),d="theme",l=(0,s.Wf)(d),u={light:"light",dark:"dark"},m=e=>e===u.dark?u.dark:u.light,h=e=>o.default.canUseDOM?m(document.documentElement.getAttribute("data-theme")):m(e),f=e=>{l.set(m(e))};function g(e){let{children:t}=e;const r=function(){const{colorMode:{defaultMode:e,disableSwitch:t,respectPrefersColorScheme:r}}=(0,a.p)(),[o,i]=(0,n.useState)(h(e));(0,n.useEffect)((()=>{t&&l.del()}),[t]);const s=(0,n.useCallback)((function(t,n){void 0===n&&(n={});const{persist:o=!0}=n;t?(i(t),o&&f(t)):(i(r?window.matchMedia("(prefers-color-scheme: dark)").matches?u.dark:u.light:e),l.del())}),[r,e]);(0,n.useEffect)((()=>{document.documentElement.setAttribute("data-theme",m(o))}),[o]),(0,n.useEffect)((()=>{if(t)return;const e=e=>{if(e.key!==d)return;const t=l.get();null!==t&&s(m(t))};return window.addEventListener("storage",e),()=>window.removeEventListener("storage",e)}),[t,s]);const c=(0,n.useRef)(!1);return(0,n.useEffect)((()=>{if(t&&!r)return;const e=window.matchMedia("(prefers-color-scheme: dark)"),n=()=>{window.matchMedia("print").matches||c.current?c.current=window.matchMedia("print").matches:s(null)};return e.addListener(n),()=>e.removeListener(n)}),[s,t,r]),(0,n.useMemo)((()=>({colorMode:o,setColorMode:s,get isDarkTheme(){return o===u.dark},setLightTheme(){s(u.light)},setDarkTheme(){s(u.dark)}})),[o,s])}();return(0,c.jsx)(p.Provider,{value:r,children:t})}function y(){const e=(0,n.useContext)(p);if(null==e)throw new i.dV("ColorModeProvider","Please see https://docusaurus.io/docs/api/themes/configuration#use-color-mode.");return e}},55597:(e,t,r)=>{"use strict";r.d(t,{VQ:()=>y,XK:()=>v,g1:()=>_});var n=r(96540),o=r(48295),i=r(17065),s=r(6342),a=r(84142),c=r(89532),p=r(70679),d=r(74848);const l=e=>`docs-preferred-version-${e}`,u={save:(e,t,r)=>{(0,p.Wf)(l(e),{persistence:t}).set(r)},read:(e,t)=>(0,p.Wf)(l(e),{persistence:t}).get(),clear:(e,t)=>{(0,p.Wf)(l(e),{persistence:t}).del()}},m=e=>Object.fromEntries(e.map((e=>[e,{preferredVersionName:null}])));const h=n.createContext(null);function f(){const e=(0,o.Gy)(),t=(0,s.p)().docs.versionPersistence,r=(0,n.useMemo)((()=>Object.keys(e)),[e]),[i,a]=(0,n.useState)((()=>m(r)));(0,n.useEffect)((()=>{a(function(e){let{pluginIds:t,versionPersistence:r,allDocsData:n}=e;function o(e){const t=u.read(e,r);return n[e].versions.some((e=>e.name===t))?{preferredVersionName:t}:(u.clear(e,r),{preferredVersionName:null})}return Object.fromEntries(t.map((e=>[e,o(e)])))}({allDocsData:e,versionPersistence:t,pluginIds:r}))}),[e,t,r]);return[i,(0,n.useMemo)((()=>({savePreferredVersion:function(e,r){u.save(e,t,r),a((t=>({...t,[e]:{preferredVersionName:r}})))}})),[t])]}function g(e){let{children:t}=e;const r=f();return(0,d.jsx)(h.Provider,{value:r,children:t})}function y(e){let{children:t}=e;return a.C5?(0,d.jsx)(g,{children:t}):(0,d.jsx)(d.Fragment,{children:t})}function b(){const e=(0,n.useContext)(h);if(!e)throw new c.dV("DocsPreferredVersionContextProvider");return e}function _(e){void 0===e&&(e=i.W);const t=(0,o.ht)(e),[r,s]=b(),{preferredVersionName:a}=r[e];return{preferredVersion:t.versions.find((e=>e.name===a))??null,savePreferredVersionName:(0,n.useCallback)((t=>{s.savePreferredVersion(e,t)}),[s,e])}}function v(){const e=(0,o.Gy)(),[t]=b();function r(r){const n=e[r],{preferredVersionName:o}=t[r];return n.versions.find((e=>e.name===o))??null}const n=Object.keys(e);return Object.fromEntries(n.map((e=>[e,r(e)])))}},26588:(e,t,r)=>{"use strict";r.d(t,{V:()=>c,t:()=>p});var n=r(96540),o=r(89532),i=r(74848);const s=Symbol("EmptyContext"),a=n.createContext(s);function c(e){let{children:t,name:r,items:o}=e;const s=(0,n.useMemo)((()=>r&&o?{name:r,items:o}:null),[r,o]);return(0,i.jsx)(a.Provider,{value:s,children:t})}function p(){const e=(0,n.useContext)(a);if(e===s)throw new o.dV("DocsSidebarProvider");return e}},32252:(e,t,r)=>{"use strict";r.d(t,{n:()=>a,r:()=>c});var n=r(96540),o=r(89532),i=r(74848);const s=n.createContext(null);function a(e){let{children:t,version:r}=e;return(0,i.jsx)(s.Provider,{value:r,children:t})}function c(){const e=(0,n.useContext)(s);if(null===e)throw new o.dV("DocsVersionProvider");return e}},22069:(e,t,r)=>{"use strict";r.d(t,{M:()=>m,e:()=>u});var n=r(96540),o=r(75600),i=r(24581),s=r(57485),a=r(6342),c=r(89532),p=r(74848);const d=n.createContext(void 0);function l(){const e=function(){const e=(0,o.YL)(),{items:t}=(0,a.p)().navbar;return 0===t.length&&!e.component}(),t=(0,i.l)(),r=!e&&"mobile"===t,[c,p]=(0,n.useState)(!1);(0,s.$Z)((()=>{if(c)return p(!1),!1}));const d=(0,n.useCallback)((()=>{p((e=>!e))}),[]);return(0,n.useEffect)((()=>{"desktop"===t&&p(!1)}),[t]),(0,n.useMemo)((()=>({disabled:e,shouldRender:r,toggle:d,shown:c})),[e,r,d,c])}function u(e){let{children:t}=e;const r=l();return(0,p.jsx)(d.Provider,{value:r,children:t})}function m(){const e=n.useContext(d);if(void 0===e)throw new c.dV("NavbarMobileSidebarProvider");return e}},75600:(e,t,r)=>{"use strict";r.d(t,{GX:()=>p,YL:()=>c,y_:()=>a});var n=r(96540),o=r(89532),i=r(74848);const s=n.createContext(null);function a(e){let{children:t}=e;const r=(0,n.useState)({component:null,props:null});return(0,i.jsx)(s.Provider,{value:r,children:t})}function c(){const e=(0,n.useContext)(s);if(!e)throw new o.dV("NavbarSecondaryMenuContentProvider");return e[0]}function p(e){let{component:t,props:r}=e;const i=(0,n.useContext)(s);if(!i)throw new o.dV("NavbarSecondaryMenuContentProvider");const[,a]=i,c=(0,o.Be)(r);return(0,n.useEffect)((()=>{a({component:t,props:c})}),[a,t,c]),(0,n.useEffect)((()=>()=>a({component:null,props:null})),[a]),null}},14090:(e,t,r)=>{"use strict";r.d(t,{w:()=>o,J:()=>i});var n=r(96540);const o="navigation-with-keyboard";function i(){(0,n.useEffect)((()=>{function e(e){"keydown"===e.type&&"Tab"===e.key&&document.body.classList.add(o),"mousedown"===e.type&&document.body.classList.remove(o)}return document.addEventListener("keydown",e),document.addEventListener("mousedown",e),()=>{document.body.classList.remove(o),document.removeEventListener("keydown",e),document.removeEventListener("mousedown",e)}}),[])}},24255:(e,t,r)=>{"use strict";r.d(t,{b:()=>a,w:()=>c});var n=r(96540),o=r(44586),i=r(57485);const s="q";function a(){return(0,i.l)(s)}function c(){const{siteConfig:{baseUrl:e,themeConfig:t}}=(0,o.A)(),{algolia:{searchPagePath:r}}=t;return(0,n.useCallback)((t=>`${e}${r}?${s}=${encodeURIComponent(t)}`),[e,r])}},24581:(e,t,r)=>{"use strict";r.d(t,{l:()=>a});var n=r(96540),o=r(38193);const i={desktop:"desktop",mobile:"mobile",ssr:"ssr"},s=996;function a(e){let{desktopBreakpoint:t=s}=void 0===e?{}:e;const[r,a]=(0,n.useState)((()=>"ssr"));return(0,n.useEffect)((()=>{function e(){a(function(e){if(!o.default.canUseDOM)throw new Error("getWindowSize() should only be called after React hydration");return window.innerWidth>e?i.desktop:i.mobile}(t))}return e(),window.addEventListener("resize",e),()=>{window.removeEventListener("resize",e)}}),[t]),r}},17559:(e,t,r)=>{"use strict";r.d(t,{G:()=>n});const n={page:{blogListPage:"blog-list-page",blogPostPage:"blog-post-page",blogTagsListPage:"blog-tags-list-page",blogTagPostListPage:"blog-tags-post-list-page",docsDocPage:"docs-doc-page",docsTagsListPage:"docs-tags-list-page",docsTagDocListPage:"docs-tags-doc-list-page",mdxPage:"mdx-page"},wrapper:{main:"main-wrapper",blogPages:"blog-wrapper",docsPages:"docs-wrapper",mdxPages:"mdx-wrapper"},common:{editThisPage:"theme-edit-this-page",lastUpdated:"theme-last-updated",backToTopButton:"theme-back-to-top-button",codeBlock:"theme-code-block",admonition:"theme-admonition",unlistedBanner:"theme-unlisted-banner",admonitionType:e=>`theme-admonition-${e}`},layout:{},docs:{docVersionBanner:"theme-doc-version-banner",docVersionBadge:"theme-doc-version-badge",docBreadcrumbs:"theme-doc-breadcrumbs",docMarkdown:"theme-doc-markdown",docTocMobile:"theme-doc-toc-mobile",docTocDesktop:"theme-doc-toc-desktop",docFooter:"theme-doc-footer",docFooterTagsRow:"theme-doc-footer-tags-row",docFooterEditMetaRow:"theme-doc-footer-edit-meta-row",docSidebarContainer:"theme-doc-sidebar-container",docSidebarMenu:"theme-doc-sidebar-menu",docSidebarItemCategory:"theme-doc-sidebar-item-category",docSidebarItemLink:"theme-doc-sidebar-item-link",docSidebarItemCategoryLevel:e=>`theme-doc-sidebar-item-category-level-${e}`,docSidebarItemLinkLevel:e=>`theme-doc-sidebar-item-link-level-${e}`},blog:{blogFooterTagsRow:"theme-blog-footer-tags-row",blogFooterEditMetaRow:"theme-blog-footer-edit-meta-row"},pages:{pageFooterEditMetaRow:"theme-pages-footer-edit-meta-row"}}},53109:(e,t,r)=>{"use strict";function n(){return window.matchMedia("(prefers-reduced-motion: reduce)").matches}r.d(t,{O:()=>n})},84142:(e,t,r)=>{"use strict";r.d(t,{B5:()=>S,C5:()=>u,Nr:()=>m,OF:()=>v,QB:()=>k,Vd:()=>x,Y:()=>b,fW:()=>w,w8:()=>g});var n=r(96540),o=r(56347),i=r(22831),s=r(48295),a=r(55597),c=r(32252),p=r(26588),d=r(31682),l=r(99169);const u=!!s.Gy;function m(e){return"link"!==e.type||e.unlisted?"category"===e.type?function(e){if(e.href&&!e.linkUnlisted)return e.href;for(const t of e.items){const e=m(t);if(e)return e}}(e):void 0:e.href}const h=(e,t)=>void 0!==e&&(0,l.ys)(e,t),f=(e,t)=>e.some((e=>g(e,t)));function g(e,t){return"link"===e.type?h(e.href,t):"category"===e.type&&(h(e.href,t)||f(e.items,t))}function y(e,t){switch(e.type){case"category":return g(e,t)||e.items.some((e=>y(e,t)));case"link":return!e.unlisted||g(e,t);default:return!0}}function b(e,t){return(0,n.useMemo)((()=>e.filter((e=>y(e,t)))),[e,t])}function _(e){let{sidebarItems:t,pathname:r,onlyCategories:n=!1}=e;const o=[];return function e(t){for(const i of t)if("category"===i.type&&((0,l.ys)(i.href,r)||e(i.items))||"link"===i.type&&(0,l.ys)(i.href,r)){return n&&"category"!==i.type||o.unshift(i),!0}return!1}(t),o}function v(){const e=(0,p.t)(),{pathname:t}=(0,o.zy)(),r=(0,s.vT)()?.pluginData.breadcrumbs;return!1!==r&&e?_({sidebarItems:e.items,pathname:t}):null}function x(e){const{activeVersion:t}=(0,s.zK)(e),{preferredVersion:r}=(0,a.g1)(e),o=(0,s.r7)(e);return(0,n.useMemo)((()=>(0,d.s)([t,r,o].filter(Boolean))),[t,r,o])}function w(e,t){const r=x(t);return(0,n.useMemo)((()=>{const t=r.flatMap((e=>e.sidebars?Object.entries(e.sidebars):[])),n=t.find((t=>t[0]===e));if(!n)throw new Error(`Can't find any sidebar with id "${e}" in version${r.length>1?"s":""} ${r.map((e=>e.name)).join(", ")}".\nAvailable sidebar ids are:\n- ${t.map((e=>e[0])).join("\n- ")}`);return n[1]}),[e,r])}function k(e,t){const r=x(t);return(0,n.useMemo)((()=>{const t=r.flatMap((e=>e.docs)),n=t.find((t=>t.id===e));if(!n){if(r.flatMap((e=>e.draftIds)).includes(e))return null;throw new Error(`Couldn't find any doc with id "${e}" in version${r.length>1?"s":""} "${r.map((e=>e.name)).join(", ")}".\nAvailable doc ids are:\n- ${(0,d.s)(t.map((e=>e.id))).join("\n- ")}`)}return n}),[e,r])}function S(e){let{route:t}=e;const r=(0,o.zy)(),n=(0,c.r)(),s=t.routes,a=s.find((e=>(0,o.B6)(r.pathname,e)));if(!a)return null;const p=a.sidebar,d=p?n.docsSidebars[p]:void 0;return{docElement:(0,i.v)(s),sidebarName:p,sidebarItems:d}}},12181:(e,t,r)=>{"use strict";r.d(t,{bq:()=>d,MN:()=>p,a2:()=>c,k2:()=>l});var n=r(96540),o=r(21312),i=r(70440);const s={errorBoundaryError:"errorBoundaryError_a6uf",errorBoundaryFallback:"errorBoundaryFallback_VBag"};var a=r(74848);function c(e){return(0,a.jsx)("button",{type:"button",...e,children:(0,a.jsx)(o.A,{id:"theme.ErrorPageContent.tryAgain",description:"The label of the button to try again rendering when the React error boundary captures an error",children:"Try again"})})}function p(e){let{error:t,tryAgain:r}=e;return(0,a.jsxs)("div",{className:s.errorBoundaryFallback,children:[(0,a.jsx)("p",{children:t.message}),(0,a.jsx)(c,{onClick:r})]})}function d(e){let{error:t}=e;const r=(0,i.getErrorCausalChain)(t).map((e=>e.message)).join("\n\nCause:\n");return(0,a.jsx)("p",{className:s.errorBoundaryError,children:r})}class l extends n.Component{componentDidCatch(e,t){throw this.props.onError(e,t)}render(){return this.props.children}}},20481:(e,t,r)=>{"use strict";r.d(t,{s:()=>o});var n=r(44586);function o(e){const{siteConfig:t}=(0,n.A)(),{title:r,titleDelimiter:o}=t;return e?.trim().length?`${e.trim()} ${o} ${r}`:r}},57485:(e,t,r)=>{"use strict";r.d(t,{$Z:()=>s,aZ:()=>c,l:()=>p});var n=r(96540),o=r(56347),i=r(89532);function s(e){!function(e){const t=(0,o.W6)(),r=(0,i._q)(e);(0,n.useEffect)((()=>t.block(((e,t)=>r(e,t)))),[t,r])}(((t,r)=>{if("POP"===r)return e(t,r)}))}function a(e){const t=(0,o.W6)();return(0,n.useSyncExternalStore)(t.listen,(()=>e(t)),(()=>e(t)))}function c(e){return a((t=>null===e?null:new URLSearchParams(t.location.search).get(e)))}function p(e){const t=c(e)??"",r=function(e){const t=(0,o.W6)();return(0,n.useCallback)(((r,n)=>{const o=new URLSearchParams(t.location.search);r?o.set(e,r):o.delete(e),(n?.push?t.push:t.replace)({search:o.toString()})}),[e,t])}(e);return[t,r]}},31682:(e,t,r)=>{"use strict";function n(e,t){return void 0===t&&(t=(e,t)=>e===t),e.filter(((r,n)=>e.findIndex((e=>t(e,r)))!==n))}function o(e){return Array.from(new Set(e))}r.d(t,{X:()=>n,s:()=>o})},45500:(e,t,r)=>{"use strict";r.d(t,{Jx:()=>m,be:()=>d,e3:()=>u});var n=r(96540),o=r(15066),i=r(5260),s=r(36803),a=r(86025),c=r(20481),p=r(74848);function d(e){let{title:t,description:r,keywords:n,image:o,children:s}=e;const d=(0,c.s)(t),{withBaseUrl:l}=(0,a.hH)(),u=o?l(o,{absolute:!0}):void 0;return(0,p.jsxs)(i.A,{children:[t&&(0,p.jsx)("title",{children:d}),t&&(0,p.jsx)("meta",{property:"og:title",content:d}),r&&(0,p.jsx)("meta",{name:"description",content:r}),r&&(0,p.jsx)("meta",{property:"og:description",content:r}),n&&(0,p.jsx)("meta",{name:"keywords",content:Array.isArray(n)?n.join(","):n}),u&&(0,p.jsx)("meta",{property:"og:image",content:u}),u&&(0,p.jsx)("meta",{name:"twitter:image",content:u}),s]})}const l=n.createContext(void 0);function u(e){let{className:t,children:r}=e;const s=n.useContext(l),a=(0,o.A)(s,t);return(0,p.jsxs)(l.Provider,{value:a,children:[(0,p.jsx)(i.A,{children:(0,p.jsx)("html",{className:a})}),r]})}function m(e){let{children:t}=e;const r=(0,s.A)(),n=`plugin-${r.plugin.name.replace(/docusaurus-(?:plugin|theme)-(?:content-)?/gi,"")}`;const i=`plugin-id-${r.plugin.id}`;return(0,p.jsx)(u,{className:(0,o.A)(n,i),children:t})}},89532:(e,t,r)=>{"use strict";r.d(t,{Be:()=>p,ZC:()=>a,_q:()=>s,dV:()=>c,fM:()=>d});var n=r(96540),o=r(205),i=r(74848);function s(e){const t=(0,n.useRef)(e);return(0,o.A)((()=>{t.current=e}),[e]),(0,n.useCallback)((function(){return t.current(...arguments)}),[])}function a(e){const t=(0,n.useRef)();return(0,o.A)((()=>{t.current=e})),t.current}class c extends Error{constructor(e,t){super(),this.name="ReactContextError",this.message=`Hook ${this.stack?.split("\n")[1]?.match(/at (?:\w+\.)?(?<name>\w+)/)?.groups.name??""} is called outside the <${e}>. ${t??""}`}}function p(e){const t=Object.entries(e);return t.sort(((e,t)=>e[0].localeCompare(t[0]))),(0,n.useMemo)((()=>e),t.flat())}function d(e){return t=>{let{children:r}=t;return(0,i.jsx)(i.Fragment,{children:e.reduceRight(((e,t)=>(0,i.jsx)(t,{children:e})),r)})}}},91252:(e,t,r)=>{"use strict";function n(e,t){return void 0!==e&&void 0!==t&&new RegExp(e,"gi").test(t)}r.d(t,{G:()=>n})},99169:(e,t,r)=>{"use strict";r.d(t,{Dt:()=>a,ys:()=>s});var n=r(96540),o=r(35947),i=r(44586);function s(e,t){const r=e=>(!e||e.endsWith("/")?e:`${e}/`)?.toLowerCase();return r(e)===r(t)}function a(){const{baseUrl:e}=(0,i.A)().siteConfig;return(0,n.useMemo)((()=>function(e){let{baseUrl:t,routes:r}=e;function n(e){return e.path===t&&!0===e.exact}function o(e){return e.path===t&&!e.exact}return function e(t){if(0===t.length)return;return t.find(n)||e(t.filter(o).flatMap((e=>e.routes??[])))}(r)}({routes:o.A,baseUrl:e})),[e])}},23104:(e,t,r)=>{"use strict";r.d(t,{Mq:()=>m,Tv:()=>d,a_:()=>h,gk:()=>f});var n=r(96540),o=r(38193),i=r(92303),s=r(205),a=r(89532),c=r(74848);const p=n.createContext(void 0);function d(e){let{children:t}=e;const r=function(){const e=(0,n.useRef)(!0);return(0,n.useMemo)((()=>({scrollEventsEnabledRef:e,enableScrollEvents:()=>{e.current=!0},disableScrollEvents:()=>{e.current=!1}})),[])}();return(0,c.jsx)(p.Provider,{value:r,children:t})}function l(){const e=(0,n.useContext)(p);if(null==e)throw new a.dV("ScrollControllerProvider");return e}const u=()=>o.default.canUseDOM?{scrollX:window.pageXOffset,scrollY:window.pageYOffset}:null;function m(e,t){void 0===t&&(t=[]);const{scrollEventsEnabledRef:r}=l(),o=(0,n.useRef)(u()),i=(0,a._q)(e);(0,n.useEffect)((()=>{const e=()=>{if(!r.current)return;const e=u();i(e,o.current),o.current=e},t={passive:!0};return e(),window.addEventListener("scroll",e,t),()=>window.removeEventListener("scroll",e,t)}),[i,r,...t])}function h(){const e=l(),t=function(){const e=(0,n.useRef)({elem:null,top:0}),t=(0,n.useCallback)((t=>{e.current={elem:t,top:t.getBoundingClientRect().top}}),[]),r=(0,n.useCallback)((()=>{const{current:{elem:t,top:r}}=e;if(!t)return{restored:!1};const n=t.getBoundingClientRect().top-r;return n&&window.scrollBy({left:0,top:n}),e.current={elem:null,top:0},{restored:0!==n}}),[]);return(0,n.useMemo)((()=>({save:t,restore:r})),[r,t])}(),r=(0,n.useRef)(void 0),o=(0,n.useCallback)((n=>{t.save(n),e.disableScrollEvents(),r.current=()=>{const{restored:n}=t.restore();if(r.current=void 0,n){const t=()=>{e.enableScrollEvents(),window.removeEventListener("scroll",t)};window.addEventListener("scroll",t)}else e.enableScrollEvents()}}),[e,t]);return(0,s.A)((()=>{queueMicrotask((()=>r.current?.()))})),{blockElementScrollPositionUntilNextRender:o}}function f(){const e=(0,n.useRef)(null),t=(0,i.A)()&&"smooth"===getComputedStyle(document.documentElement).scrollBehavior;return{startScroll:r=>{e.current=t?function(e){return window.scrollTo({top:e,behavior:"smooth"}),()=>{}}(r):function(e){let t=null;const r=document.documentElement.scrollTop>e;return function n(){const o=document.documentElement.scrollTop;(r&&o>e||!r&&o<e)&&(t=requestAnimationFrame(n),window.scrollTo(0,Math.floor(.85*(o-e))+e))}(),()=>t&&cancelAnimationFrame(t)}(r)},cancelScroll:()=>e.current?.()}}},2967:(e,t,r)=>{"use strict";r.d(t,{Cy:()=>s,af:()=>c,tU:()=>a});var n=r(48295),o=r(44586),i=r(55597);const s="default";function a(e,t){return`docs-${e}-${t}`}function c(){const{i18n:e}=(0,o.A)(),t=(0,n.Gy)(),r=(0,n.gk)(),c=(0,i.XK)();const p=[s,...Object.keys(t).map((function(e){const n=r?.activePlugin.pluginId===e?r.activeVersion:void 0,o=c[e],i=t[e].versions.find((e=>e.isLast));return a(e,(n??o??i).name)}))];return{locale:e.currentLocale,tags:p}}},70679:(e,t,r)=>{"use strict";r.d(t,{Wf:()=>d,Dv:()=>l});var n=r(96540);const o=JSON.parse('{"N":"localStorage","M":""}'),i=o.N;function s(e){let{key:t,oldValue:r,newValue:n,storage:o}=e;if(r===n)return;const i=document.createEvent("StorageEvent");i.initStorageEvent("storage",!1,!1,t,r,n,window.location.href,o),window.dispatchEvent(i)}function a(e){if(void 0===e&&(e=i),"undefined"==typeof window)throw new Error("Browser storage is not available on Node.js/Docusaurus SSR process.");if("none"===e)return null;try{return window[e]}catch(r){return t=r,c||(console.warn("Docusaurus browser storage is not available.\nPossible reasons: running Docusaurus in an iframe, in an incognito browser session, or using too strict browser privacy settings.",t),c=!0),null}var t}let c=!1;const p={get:()=>null,set:()=>{},del:()=>{},listen:()=>()=>{}};function d(e,t){const r=`${e}${o.M}`;if("undefined"==typeof window)return function(e){function t(){throw new Error(`Illegal storage API usage for storage key "${e}".\nDocusaurus storage APIs are not supposed to be called on the server-rendering process.\nPlease only call storage APIs in effects and event handlers.`)}return{get:t,set:t,del:t,listen:t}}(r);const n=a(t?.persistence);return null===n?p:{get:()=>{try{return n.getItem(r)}catch(e){return console.error(`Docusaurus storage error, can't get key=${r}`,e),null}},set:e=>{try{const t=n.getItem(r);n.setItem(r,e),s({key:r,oldValue:t,newValue:e,storage:n})}catch(t){console.error(`Docusaurus storage error, can't set ${r}=${e}`,t)}},del:()=>{try{const e=n.getItem(r);n.removeItem(r),s({key:r,oldValue:e,newValue:null,storage:n})}catch(e){console.error(`Docusaurus storage error, can't delete key=${r}`,e)}},listen:e=>{try{const t=t=>{t.storageArea===n&&t.key===r&&e(t)};return window.addEventListener("storage",t),()=>window.removeEventListener("storage",t)}catch(t){return console.error(`Docusaurus storage error, can't listen for changes of key=${r}`,t),()=>{}}}}}function l(e,t){const r=(0,n.useRef)((()=>null===e?p:d(e,t))).current(),o=(0,n.useCallback)((e=>"undefined"==typeof window?()=>{}:r.listen(e)),[r]);return[(0,n.useSyncExternalStore)(o,(()=>"undefined"==typeof window?null:r.get()),(()=>null)),r]}},32131:(e,t,r)=>{"use strict";r.d(t,{o:()=>s});var n=r(44586),o=r(56347),i=r(70440);function s(){const{siteConfig:{baseUrl:e,url:t,trailingSlash:r},i18n:{defaultLocale:s,currentLocale:a}}=(0,n.A)(),{pathname:c}=(0,o.zy)(),p=(0,i.applyTrailingSlash)(c,{trailingSlash:r,baseUrl:e}),d=a===s?e:e.replace(`/${a}/`,"/"),l=p.replace(e,"");return{createUrl:function(e){let{locale:r,fullyQualified:n}=e;return`${n?t:""}${function(e){return e===s?`${d}`:`${d}${e}/`}(r)}${l}`}}}},75062:(e,t,r)=>{"use strict";r.d(t,{$:()=>s});var n=r(96540),o=r(56347),i=r(89532);function s(e){const t=(0,o.zy)(),r=(0,i.ZC)(t),s=(0,i._q)(e);(0,n.useEffect)((()=>{r&&t!==r&&s({location:t,previousLocation:r})}),[s,t,r])}},6342:(e,t,r)=>{"use strict";r.d(t,{p:()=>o});var n=r(44586);function o(){return(0,n.A)().siteConfig.themeConfig}},38126:(e,t,r)=>{"use strict";r.d(t,{c:()=>o});var n=r(44586);function o(){const{siteConfig:{themeConfig:e}}=(0,n.A)();return e}},51062:(e,t,r)=>{"use strict";r.d(t,{C:()=>a});var n=r(96540),o=r(91252),i=r(86025),s=r(38126);function a(){const{withBaseUrl:e}=(0,i.hH)(),{algolia:{externalUrlRegex:t,replaceSearchResultPathname:r}}=(0,s.c)();return(0,n.useCallback)((n=>{const i=new URL(n);if((0,o.G)(t,i.href))return n;const s=`${i.pathname+i.hash}`;return e(function(e,t){return t?e.replaceAll(new RegExp(t.from,"g"),t.to):e}(s,r))}),[e,t,r])}},12983:(e,t,r)=>{"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.removeTrailingSlash=t.addLeadingSlash=t.addTrailingSlash=void 0;const n=r(42566);function o(e){return e.endsWith("/")?e:`${e}/`}function i(e){return(0,n.removeSuffix)(e,"/")}t.addTrailingSlash=o,t.default=function(e,t){const{trailingSlash:r,baseUrl:n}=t;if(e.startsWith("#"))return e;if(void 0===r)return e;const[s]=e.split(/[#?]/),a="/"===s||s===n?s:(c=s,r?o(c):i(c));var c;return e.replace(s,a)},t.addLeadingSlash=function(e){return(0,n.addPrefix)(e,"/")},t.removeTrailingSlash=i},80253:(e,t)=>{"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.getErrorCausalChain=void 0,t.getErrorCausalChain=function e(t){return t.cause?[t,...e(t.cause)]:[t]}},70440:function(e,t,r){"use strict";var n=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0}),t.getErrorCausalChain=t.removePrefix=t.addSuffix=t.removeSuffix=t.addPrefix=t.removeTrailingSlash=t.addLeadingSlash=t.addTrailingSlash=t.applyTrailingSlash=t.blogPostContainerID=void 0,t.blogPostContainerID="__blog-post-container";var o=r(12983);Object.defineProperty(t,"applyTrailingSlash",{enumerable:!0,get:function(){return n(o).default}}),Object.defineProperty(t,"addTrailingSlash",{enumerable:!0,get:function(){return o.addTrailingSlash}}),Object.defineProperty(t,"addLeadingSlash",{enumerable:!0,get:function(){return o.addLeadingSlash}}),Object.defineProperty(t,"removeTrailingSlash",{enumerable:!0,get:function(){return o.removeTrailingSlash}});var i=r(42566);Object.defineProperty(t,"addPrefix",{enumerable:!0,get:function(){return i.addPrefix}}),Object.defineProperty(t,"removeSuffix",{enumerable:!0,get:function(){return i.removeSuffix}}),Object.defineProperty(t,"addSuffix",{enumerable:!0,get:function(){return i.addSuffix}}),Object.defineProperty(t,"removePrefix",{enumerable:!0,get:function(){return i.removePrefix}});var s=r(80253);Object.defineProperty(t,"getErrorCausalChain",{enumerable:!0,get:function(){return s.getErrorCausalChain}})},42566:(e,t)=>{"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.removePrefix=t.addSuffix=t.removeSuffix=t.addPrefix=void 0,t.addPrefix=function(e,t){return e.startsWith(t)?e:`${t}${e}`},t.removeSuffix=function(e,t){return""===t?e:e.endsWith(t)?e.slice(0,-t.length):e},t.addSuffix=function(e,t){return e.endsWith(t)?e:`${e}${t}`},t.removePrefix=function(e,t){return e.startsWith(t)?e.slice(t.length):e}},23390:function(e,t,r){"use strict";var n=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});n(r(38193)).default.canUseDOM&&(window.Prism=window.Prism||{},window.Prism.manual=!0)},20053:(e,t,r)=>{"use strict";function n(e){var t,r,o="";if("string"==typeof e||"number"==typeof e)o+=e;else if("object"==typeof e)if(Array.isArray(e))for(t=0;t<e.length;t++)e[t]&&(r=n(e[t]))&&(o&&(o+=" "),o+=r);else for(t in e)e[t]&&(o&&(o+=" "),o+=t);return o}r.d(t,{A:()=>o});const o=function(){for(var e,t,r=0,o="";r<arguments.length;)(e=arguments[r++])&&(t=n(e))&&(o&&(o+=" "),o+=t);return o}},31513:(e,t,r)=>{"use strict";r.d(t,{zR:()=>v,TM:()=>C,yJ:()=>m,sC:()=>I,AO:()=>u});var n=r(58168);function o(e){return"/"===e.charAt(0)}function i(e,t){for(var r=t,n=r+1,o=e.length;n<o;r+=1,n+=1)e[r]=e[n];e.pop()}const s=function(e,t){void 0===t&&(t="");var r,n=e&&e.split("/")||[],s=t&&t.split("/")||[],a=e&&o(e),c=t&&o(t),p=a||c;if(e&&o(e)?s=n:n.length&&(s.pop(),s=s.concat(n)),!s.length)return"/";if(s.length){var d=s[s.length-1];r="."===d||".."===d||""===d}else r=!1;for(var l=0,u=s.length;u>=0;u--){var m=s[u];"."===m?i(s,u):".."===m?(i(s,u),l++):l&&(i(s,u),l--)}if(!p)for(;l--;l)s.unshift("..");!p||""===s[0]||s[0]&&o(s[0])||s.unshift("");var h=s.join("/");return r&&"/"!==h.substr(-1)&&(h+="/"),h};var a=r(11561);function c(e){return"/"===e.charAt(0)?e:"/"+e}function p(e){return"/"===e.charAt(0)?e.substr(1):e}function d(e,t){return function(e,t){return 0===e.toLowerCase().indexOf(t.toLowerCase())&&-1!=="/?#".indexOf(e.charAt(t.length))}(e,t)?e.substr(t.length):e}function l(e){return"/"===e.charAt(e.length-1)?e.slice(0,-1):e}function u(e){var t=e.pathname,r=e.search,n=e.hash,o=t||"/";return r&&"?"!==r&&(o+="?"===r.charAt(0)?r:"?"+r),n&&"#"!==n&&(o+="#"===n.charAt(0)?n:"#"+n),o}function m(e,t,r,o){var i;"string"==typeof e?(i=function(e){var t=e||"/",r="",n="",o=t.indexOf("#");-1!==o&&(n=t.substr(o),t=t.substr(0,o));var i=t.indexOf("?");return-1!==i&&(r=t.substr(i),t=t.substr(0,i)),{pathname:t,search:"?"===r?"":r,hash:"#"===n?"":n}}(e),i.state=t):(void 0===(i=(0,n.A)({},e)).pathname&&(i.pathname=""),i.search?"?"!==i.search.charAt(0)&&(i.search="?"+i.search):i.search="",i.hash?"#"!==i.hash.charAt(0)&&(i.hash="#"+i.hash):i.hash="",void 0!==t&&void 0===i.state&&(i.state=t));try{i.pathname=decodeURI(i.pathname)}catch(a){throw a instanceof URIError?new URIError('Pathname "'+i.pathname+'" could not be decoded. This is likely caused by an invalid percent-encoding.'):a}return r&&(i.key=r),o?i.pathname?"/"!==i.pathname.charAt(0)&&(i.pathname=s(i.pathname,o.pathname)):i.pathname=o.pathname:i.pathname||(i.pathname="/"),i}function h(){var e=null;var t=[];return{setPrompt:function(t){return e=t,function(){e===t&&(e=null)}},confirmTransitionTo:function(t,r,n,o){if(null!=e){var i="function"==typeof e?e(t,r):e;"string"==typeof i?"function"==typeof n?n(i,o):o(!0):o(!1!==i)}else o(!0)},appendListener:function(e){var r=!0;function n(){r&&e.apply(void 0,arguments)}return t.push(n),function(){r=!1,t=t.filter((function(e){return e!==n}))}},notifyListeners:function(){for(var e=arguments.length,r=new Array(e),n=0;n<e;n++)r[n]=arguments[n];t.forEach((function(e){return e.apply(void 0,r)}))}}}var f=!("undefined"==typeof window||!window.document||!window.document.createElement);function g(e,t){t(window.confirm(e))}var y="popstate",b="hashchange";function _(){try{return window.history.state||{}}catch(e){return{}}}function v(e){void 0===e&&(e={}),f||(0,a.A)(!1);var t,r=window.history,o=(-1===(t=window.navigator.userAgent).indexOf("Android 2.")&&-1===t.indexOf("Android 4.0")||-1===t.indexOf("Mobile Safari")||-1!==t.indexOf("Chrome")||-1!==t.indexOf("Windows Phone"))&&window.history&&"pushState"in window.history,i=!(-1===window.navigator.userAgent.indexOf("Trident")),s=e,p=s.forceRefresh,v=void 0!==p&&p,x=s.getUserConfirmation,w=void 0===x?g:x,k=s.keyLength,S=void 0===k?6:k,T=e.basename?l(c(e.basename)):"";function C(e){var t=e||{},r=t.key,n=t.state,o=window.location,i=o.pathname+o.search+o.hash;return T&&(i=d(i,T)),m(i,n,r)}function A(){return Math.random().toString(36).substr(2,S)}var I=h();function j(e){(0,n.A)(F,e),F.length=r.length,I.notifyListeners(F.location,F.action)}function E(e){(function(e){return void 0===e.state&&-1===navigator.userAgent.indexOf("CriOS")})(e)||O(C(e.state))}function P(){O(C(_()))}var R=!1;function O(e){if(R)R=!1,j();else{I.confirmTransitionTo(e,"POP",w,(function(t){t?j({action:"POP",location:e}):function(e){var t=F.location,r=$.indexOf(t.key);-1===r&&(r=0);var n=$.indexOf(e.key);-1===n&&(n=0);var o=r-n;o&&(R=!0,B(o))}(e)}))}}var q=C(_()),$=[q.key];function D(e){return T+u(e)}function B(e){r.go(e)}var L=0;function U(e){1===(L+=e)&&1===e?(window.addEventListener(y,E),i&&window.addEventListener(b,P)):0===L&&(window.removeEventListener(y,E),i&&window.removeEventListener(b,P))}var N=!1;var F={length:r.length,action:"POP",location:q,createHref:D,push:function(e,t){var n="PUSH",i=m(e,t,A(),F.location);I.confirmTransitionTo(i,n,w,(function(e){if(e){var t=D(i),s=i.key,a=i.state;if(o)if(r.pushState({key:s,state:a},null,t),v)window.location.href=t;else{var c=$.indexOf(F.location.key),p=$.slice(0,c+1);p.push(i.key),$=p,j({action:n,location:i})}else window.location.href=t}}))},replace:function(e,t){var n="REPLACE",i=m(e,t,A(),F.location);I.confirmTransitionTo(i,n,w,(function(e){if(e){var t=D(i),s=i.key,a=i.state;if(o)if(r.replaceState({key:s,state:a},null,t),v)window.location.replace(t);else{var c=$.indexOf(F.location.key);-1!==c&&($[c]=i.key),j({action:n,location:i})}else window.location.replace(t)}}))},go:B,goBack:function(){B(-1)},goForward:function(){B(1)},block:function(e){void 0===e&&(e=!1);var t=I.setPrompt(e);return N||(U(1),N=!0),function(){return N&&(N=!1,U(-1)),t()}},listen:function(e){var t=I.appendListener(e);return U(1),function(){U(-1),t()}}};return F}var x="hashchange",w={hashbang:{encodePath:function(e){return"!"===e.charAt(0)?e:"!/"+p(e)},decodePath:function(e){return"!"===e.charAt(0)?e.substr(1):e}},noslash:{encodePath:p,decodePath:c},slash:{encodePath:c,decodePath:c}};function k(e){var t=e.indexOf("#");return-1===t?e:e.slice(0,t)}function S(){var e=window.location.href,t=e.indexOf("#");return-1===t?"":e.substring(t+1)}function T(e){window.location.replace(k(window.location.href)+"#"+e)}function C(e){void 0===e&&(e={}),f||(0,a.A)(!1);var t=window.history,r=(window.navigator.userAgent.indexOf("Firefox"),e),o=r.getUserConfirmation,i=void 0===o?g:o,s=r.hashType,p=void 0===s?"slash":s,y=e.basename?l(c(e.basename)):"",b=w[p],_=b.encodePath,v=b.decodePath;function C(){var e=v(S());return y&&(e=d(e,y)),m(e)}var A=h();function I(e){(0,n.A)(N,e),N.length=t.length,A.notifyListeners(N.location,N.action)}var j=!1,E=null;function P(){var e,t,r=S(),n=_(r);if(r!==n)T(n);else{var o=C(),s=N.location;if(!j&&(t=o,(e=s).pathname===t.pathname&&e.search===t.search&&e.hash===t.hash))return;if(E===u(o))return;E=null,function(e){if(j)j=!1,I();else{var t="POP";A.confirmTransitionTo(e,t,i,(function(r){r?I({action:t,location:e}):function(e){var t=N.location,r=$.lastIndexOf(u(t));-1===r&&(r=0);var n=$.lastIndexOf(u(e));-1===n&&(n=0);var o=r-n;o&&(j=!0,D(o))}(e)}))}}(o)}}var R=S(),O=_(R);R!==O&&T(O);var q=C(),$=[u(q)];function D(e){t.go(e)}var B=0;function L(e){1===(B+=e)&&1===e?window.addEventListener(x,P):0===B&&window.removeEventListener(x,P)}var U=!1;var N={length:t.length,action:"POP",location:q,createHref:function(e){var t=document.querySelector("base"),r="";return t&&t.getAttribute("href")&&(r=k(window.location.href)),r+"#"+_(y+u(e))},push:function(e,t){var r="PUSH",n=m(e,void 0,void 0,N.location);A.confirmTransitionTo(n,r,i,(function(e){if(e){var t=u(n),o=_(y+t);if(S()!==o){E=t,function(e){window.location.hash=e}(o);var i=$.lastIndexOf(u(N.location)),s=$.slice(0,i+1);s.push(t),$=s,I({action:r,location:n})}else I()}}))},replace:function(e,t){var r="REPLACE",n=m(e,void 0,void 0,N.location);A.confirmTransitionTo(n,r,i,(function(e){if(e){var t=u(n),o=_(y+t);S()!==o&&(E=t,T(o));var i=$.indexOf(u(N.location));-1!==i&&($[i]=t),I({action:r,location:n})}}))},go:D,goBack:function(){D(-1)},goForward:function(){D(1)},block:function(e){void 0===e&&(e=!1);var t=A.setPrompt(e);return U||(L(1),U=!0),function(){return U&&(U=!1,L(-1)),t()}},listen:function(e){var t=A.appendListener(e);return L(1),function(){L(-1),t()}}};return N}function A(e,t,r){return Math.min(Math.max(e,t),r)}function I(e){void 0===e&&(e={});var t=e,r=t.getUserConfirmation,o=t.initialEntries,i=void 0===o?["/"]:o,s=t.initialIndex,a=void 0===s?0:s,c=t.keyLength,p=void 0===c?6:c,d=h();function l(e){(0,n.A)(v,e),v.length=v.entries.length,d.notifyListeners(v.location,v.action)}function f(){return Math.random().toString(36).substr(2,p)}var g=A(a,0,i.length-1),y=i.map((function(e){return m(e,void 0,"string"==typeof e?f():e.key||f())})),b=u;function _(e){var t=A(v.index+e,0,v.entries.length-1),n=v.entries[t];d.confirmTransitionTo(n,"POP",r,(function(e){e?l({action:"POP",location:n,index:t}):l()}))}var v={length:y.length,action:"POP",location:y[g],index:g,entries:y,createHref:b,push:function(e,t){var n="PUSH",o=m(e,t,f(),v.location);d.confirmTransitionTo(o,n,r,(function(e){if(e){var t=v.index+1,r=v.entries.slice(0);r.length>t?r.splice(t,r.length-t,o):r.push(o),l({action:n,location:o,index:t,entries:r})}}))},replace:function(e,t){var n="REPLACE",o=m(e,t,f(),v.location);d.confirmTransitionTo(o,n,r,(function(e){e&&(v.entries[v.index]=o,l({action:n,location:o}))}))},go:_,goBack:function(){_(-1)},goForward:function(){_(1)},canGo:function(e){var t=v.index+e;return t>=0&&t<v.entries.length},block:function(e){return void 0===e&&(e=!1),d.setPrompt(e)},listen:function(e){return d.appendListener(e)}};return v}},4146:(e,t,r)=>{"use strict";var n=r(44363),o={childContextTypes:!0,contextType:!0,contextTypes:!0,defaultProps:!0,displayName:!0,getDefaultProps:!0,getDerivedStateFromError:!0,getDerivedStateFromProps:!0,mixins:!0,propTypes:!0,type:!0},i={name:!0,length:!0,prototype:!0,caller:!0,callee:!0,arguments:!0,arity:!0},s={$$typeof:!0,compare:!0,defaultProps:!0,displayName:!0,propTypes:!0,type:!0},a={};function c(e){return n.isMemo(e)?s:a[e.$$typeof]||o}a[n.ForwardRef]={$$typeof:!0,render:!0,defaultProps:!0,displayName:!0,propTypes:!0},a[n.Memo]=s;var p=Object.defineProperty,d=Object.getOwnPropertyNames,l=Object.getOwnPropertySymbols,u=Object.getOwnPropertyDescriptor,m=Object.getPrototypeOf,h=Object.prototype;e.exports=function e(t,r,n){if("string"!=typeof r){if(h){var o=m(r);o&&o!==h&&e(t,o,n)}var s=d(r);l&&(s=s.concat(l(r)));for(var a=c(t),f=c(r),g=0;g<s.length;++g){var y=s[g];if(!(i[y]||n&&n[y]||f&&f[y]||a&&a[y])){var b=u(r,y);try{p(t,y,b)}catch(_){}}}}return t}},20311:e=>{"use strict";e.exports=function(e,t,r,n,o,i,s,a){if(!e){var c;if(void 0===t)c=new Error("Minified exception occurred; use the non-minified dev environment for the full error message and additional helpful warnings.");else{var p=[r,n,o,i,s,a],d=0;(c=new Error(t.replace(/%s/g,(function(){return p[d++]})))).name="Invariant Violation"}throw c.framesToPop=1,c}}},64634:e=>{e.exports=Array.isArray||function(e){return"[object Array]"==Object.prototype.toString.call(e)}},89888:(e,t,r)=>{"use strict";r.r(t)},7767:(e,t,r)=>{"use strict";r.r(t)},10119:(e,t,r)=>{"use strict";r.r(t)},5947:function(e,t,r){var n,o;n=function(){var e,t,r={version:"0.2.0"},n=r.settings={minimum:.08,easing:"ease",positionUsing:"",speed:200,trickle:!0,trickleRate:.02,trickleSpeed:800,showSpinner:!0,barSelector:'[role="bar"]',spinnerSelector:'[role="spinner"]',parent:"body",template:'<div class="bar" role="bar"><div class="peg"></div></div><div class="spinner" role="spinner"><div class="spinner-icon"></div></div>'};function o(e,t,r){return e<t?t:e>r?r:e}function i(e){return 100*(-1+e)}function s(e,t,r){var o;return(o="translate3d"===n.positionUsing?{transform:"translate3d("+i(e)+"%,0,0)"}:"translate"===n.positionUsing?{transform:"translate("+i(e)+"%,0)"}:{"margin-left":i(e)+"%"}).transition="all "+t+"ms "+r,o}r.configure=function(e){var t,r;for(t in e)void 0!==(r=e[t])&&e.hasOwnProperty(t)&&(n[t]=r);return this},r.status=null,r.set=function(e){var t=r.isStarted();e=o(e,n.minimum,1),r.status=1===e?null:e;var i=r.render(!t),p=i.querySelector(n.barSelector),d=n.speed,l=n.easing;return i.offsetWidth,a((function(t){""===n.positionUsing&&(n.positionUsing=r.getPositioningCSS()),c(p,s(e,d,l)),1===e?(c(i,{transition:"none",opacity:1}),i.offsetWidth,setTimeout((function(){c(i,{transition:"all "+d+"ms linear",opacity:0}),setTimeout((function(){r.remove(),t()}),d)}),d)):setTimeout(t,d)})),this},r.isStarted=function(){return"number"==typeof r.status},r.start=function(){r.status||r.set(0);var e=function(){setTimeout((function(){r.status&&(r.trickle(),e())}),n.trickleSpeed)};return n.trickle&&e(),this},r.done=function(e){return e||r.status?r.inc(.3+.5*Math.random()).set(1):this},r.inc=function(e){var t=r.status;return t?("number"!=typeof e&&(e=(1-t)*o(Math.random()*t,.1,.95)),t=o(t+e,0,.994),r.set(t)):r.start()},r.trickle=function(){return r.inc(Math.random()*n.trickleRate)},e=0,t=0,r.promise=function(n){return n&&"resolved"!==n.state()?(0===t&&r.start(),e++,t++,n.always((function(){0==--t?(e=0,r.done()):r.set((e-t)/e)})),this):this},r.render=function(e){if(r.isRendered())return document.getElementById("nprogress");d(document.documentElement,"nprogress-busy");var t=document.createElement("div");t.id="nprogress",t.innerHTML=n.template;var o,s=t.querySelector(n.barSelector),a=e?"-100":i(r.status||0),p=document.querySelector(n.parent);return c(s,{transition:"all 0 linear",transform:"translate3d("+a+"%,0,0)"}),n.showSpinner||(o=t.querySelector(n.spinnerSelector))&&m(o),p!=document.body&&d(p,"nprogress-custom-parent"),p.appendChild(t),t},r.remove=function(){l(document.documentElement,"nprogress-busy"),l(document.querySelector(n.parent),"nprogress-custom-parent");var e=document.getElementById("nprogress");e&&m(e)},r.isRendered=function(){return!!document.getElementById("nprogress")},r.getPositioningCSS=function(){var e=document.body.style,t="WebkitTransform"in e?"Webkit":"MozTransform"in e?"Moz":"msTransform"in e?"ms":"OTransform"in e?"O":"";return t+"Perspective"in e?"translate3d":t+"Transform"in e?"translate":"margin"};var a=function(){var e=[];function t(){var r=e.shift();r&&r(t)}return function(r){e.push(r),1==e.length&&t()}}(),c=function(){var e=["Webkit","O","Moz","ms"],t={};function r(e){return e.replace(/^-ms-/,"ms-").replace(/-([\da-z])/gi,(function(e,t){return t.toUpperCase()}))}function n(t){var r=document.body.style;if(t in r)return t;for(var n,o=e.length,i=t.charAt(0).toUpperCase()+t.slice(1);o--;)if((n=e[o]+i)in r)return n;return t}function o(e){return e=r(e),t[e]||(t[e]=n(e))}function i(e,t,r){t=o(t),e.style[t]=r}return function(e,t){var r,n,o=arguments;if(2==o.length)for(r in t)void 0!==(n=t[r])&&t.hasOwnProperty(r)&&i(e,r,n);else i(e,o[1],o[2])}}();function p(e,t){return("string"==typeof e?e:u(e)).indexOf(" "+t+" ")>=0}function d(e,t){var r=u(e),n=r+t;p(r,t)||(e.className=n.substring(1))}function l(e,t){var r,n=u(e);p(e,t)&&(r=n.replace(" "+t+" "," "),e.className=r.substring(1,r.length-1))}function u(e){return(" "+(e.className||"")+" ").replace(/\s+/gi," ")}function m(e){e&&e.parentNode&&e.parentNode.removeChild(e)}return r},void 0===(o="function"==typeof n?n.call(t,r,t,e):n)||(e.exports=o)},35302:(e,t,r)=>{var n=r(64634);e.exports=m,e.exports.parse=i,e.exports.compile=function(e,t){return a(i(e,t),t)},e.exports.tokensToFunction=a,e.exports.tokensToRegExp=u;var o=new RegExp(["(\\\\.)","([\\/.])?(?:(?:\\:(\\w+)(?:\\(((?:\\\\.|[^\\\\()])+)\\))?|\\(((?:\\\\.|[^\\\\()])+)\\))([+*?])?|(\\*))"].join("|"),"g");function i(e,t){for(var r,n=[],i=0,s=0,a="",d=t&&t.delimiter||"/";null!=(r=o.exec(e));){var l=r[0],u=r[1],m=r.index;if(a+=e.slice(s,m),s=m+l.length,u)a+=u[1];else{var h=e[s],f=r[2],g=r[3],y=r[4],b=r[5],_=r[6],v=r[7];a&&(n.push(a),a="");var x=null!=f&&null!=h&&h!==f,w="+"===_||"*"===_,k="?"===_||"*"===_,S=r[2]||d,T=y||b;n.push({name:g||i++,prefix:f||"",delimiter:S,optional:k,repeat:w,partial:x,asterisk:!!v,pattern:T?p(T):v?".*":"[^"+c(S)+"]+?"})}}return s<e.length&&(a+=e.substr(s)),a&&n.push(a),n}function s(e){return encodeURI(e).replace(/[\/?#]/g,(function(e){return"%"+e.charCodeAt(0).toString(16).toUpperCase()}))}function a(e,t){for(var r=new Array(e.length),o=0;o<e.length;o++)"object"==typeof e[o]&&(r[o]=new RegExp("^(?:"+e[o].pattern+")$",l(t)));return function(t,o){for(var i="",a=t||{},c=(o||{}).pretty?s:encodeURIComponent,p=0;p<e.length;p++){var d=e[p];if("string"!=typeof d){var l,u=a[d.name];if(null==u){if(d.optional){d.partial&&(i+=d.prefix);continue}throw new TypeError('Expected "'+d.name+'" to be defined')}if(n(u)){if(!d.repeat)throw new TypeError('Expected "'+d.name+'" to not repeat, but received `'+JSON.stringify(u)+"`");if(0===u.length){if(d.optional)continue;throw new TypeError('Expected "'+d.name+'" to not be empty')}for(var m=0;m<u.length;m++){if(l=c(u[m]),!r[p].test(l))throw new TypeError('Expected all "'+d.name+'" to match "'+d.pattern+'", but received `'+JSON.stringify(l)+"`");i+=(0===m?d.prefix:d.delimiter)+l}}else{if(l=d.asterisk?encodeURI(u).replace(/[?#]/g,(function(e){return"%"+e.charCodeAt(0).toString(16).toUpperCase()})):c(u),!r[p].test(l))throw new TypeError('Expected "'+d.name+'" to match "'+d.pattern+'", but received "'+l+'"');i+=d.prefix+l}}else i+=d}return i}}function c(e){return e.replace(/([.+*?=^!:${}()[\]|\/\\])/g,"\\$1")}function p(e){return e.replace(/([=!:$\/()])/g,"\\$1")}function d(e,t){return e.keys=t,e}function l(e){return e&&e.sensitive?"":"i"}function u(e,t,r){n(t)||(r=t||r,t=[]);for(var o=(r=r||{}).strict,i=!1!==r.end,s="",a=0;a<e.length;a++){var p=e[a];if("string"==typeof p)s+=c(p);else{var u=c(p.prefix),m="(?:"+p.pattern+")";t.push(p),p.repeat&&(m+="(?:"+u+m+")*"),s+=m=p.optional?p.partial?u+"("+m+")?":"(?:"+u+"("+m+"))?":u+"("+m+")"}}var h=c(r.delimiter||"/"),f=s.slice(-h.length)===h;return o||(s=(f?s.slice(0,-h.length):s)+"(?:"+h+"(?=$))?"),s+=i?"$":o&&f?"":"(?="+h+"|$)",d(new RegExp("^"+s,l(r)),t)}function m(e,t,r){return n(t)||(r=t||r,t=[]),r=r||{},e instanceof RegExp?function(e,t){var r=e.source.match(/\((?!\?)/g);if(r)for(var n=0;n<r.length;n++)t.push({name:n,prefix:null,delimiter:null,optional:!1,repeat:!1,partial:!1,asterisk:!1,pattern:null});return d(e,t)}(e,t):n(e)?function(e,t,r){for(var n=[],o=0;o<e.length;o++)n.push(m(e[o],t,r).source);return d(new RegExp("(?:"+n.join("|")+")",l(r)),t)}(e,t,r):function(e,t,r){return u(i(e,r),t,r)}(e,t,r)}},57022:()=>{!function(e){var t="\\b(?:BASH|BASHOPTS|BASH_ALIASES|BASH_ARGC|BASH_ARGV|BASH_CMDS|BASH_COMPLETION_COMPAT_DIR|BASH_LINENO|BASH_REMATCH|BASH_SOURCE|BASH_VERSINFO|BASH_VERSION|COLORTERM|COLUMNS|COMP_WORDBREAKS|DBUS_SESSION_BUS_ADDRESS|DEFAULTS_PATH|DESKTOP_SESSION|DIRSTACK|DISPLAY|EUID|GDMSESSION|GDM_LANG|GNOME_KEYRING_CONTROL|GNOME_KEYRING_PID|GPG_AGENT_INFO|GROUPS|HISTCONTROL|HISTFILE|HISTFILESIZE|HISTSIZE|HOME|HOSTNAME|HOSTTYPE|IFS|INSTANCE|JOB|LANG|LANGUAGE|LC_ADDRESS|LC_ALL|LC_IDENTIFICATION|LC_MEASUREMENT|LC_MONETARY|LC_NAME|LC_NUMERIC|LC_PAPER|LC_TELEPHONE|LC_TIME|LESSCLOSE|LESSOPEN|LINES|LOGNAME|LS_COLORS|MACHTYPE|MAILCHECK|MANDATORY_PATH|NO_AT_BRIDGE|OLDPWD|OPTERR|OPTIND|ORBIT_SOCKETDIR|OSTYPE|PAPERSIZE|PATH|PIPESTATUS|PPID|PS1|PS2|PS3|PS4|PWD|RANDOM|REPLY|SECONDS|SELINUX_INIT|SESSION|SESSIONTYPE|SESSION_MANAGER|SHELL|SHELLOPTS|SHLVL|SSH_AUTH_SOCK|TERM|UID|UPSTART_EVENTS|UPSTART_INSTANCE|UPSTART_JOB|UPSTART_SESSION|USER|WINDOWID|XAUTHORITY|XDG_CONFIG_DIRS|XDG_CURRENT_DESKTOP|XDG_DATA_DIRS|XDG_GREETER_DATA_DIR|XDG_MENU_PREFIX|XDG_RUNTIME_DIR|XDG_SEAT|XDG_SEAT_PATH|XDG_SESSION_DESKTOP|XDG_SESSION_ID|XDG_SESSION_PATH|XDG_SESSION_TYPE|XDG_VTNR|XMODIFIERS)\\b",r={pattern:/(^(["']?)\w+\2)[ \t]+\S.*/,lookbehind:!0,alias:"punctuation",inside:null},n={bash:r,environment:{pattern:RegExp("\\$"+t),alias:"constant"},variable:[{pattern:/\$?\(\([\s\S]+?\)\)/,greedy:!0,inside:{variable:[{pattern:/(^\$\(\([\s\S]+)\)\)/,lookbehind:!0},/^\$\(\(/],number:/\b0x[\dA-Fa-f]+\b|(?:\b\d+(?:\.\d*)?|\B\.\d+)(?:[Ee]-?\d+)?/,operator:/--|\+\+|\*\*=?|<<=?|>>=?|&&|\|\||[=!+\-*/%<>^&|]=?|[?~:]/,punctuation:/\(\(?|\)\)?|,|;/}},{pattern:/\$\((?:\([^)]+\)|[^()])+\)|`[^`]+`/,greedy:!0,inside:{variable:/^\$\(|^`|\)$|`$/}},{pattern:/\$\{[^}]+\}/,greedy:!0,inside:{operator:/:[-=?+]?|[!\/]|##?|%%?|\^\^?|,,?/,punctuation:/[\[\]]/,environment:{pattern:RegExp("(\\{)"+t),lookbehind:!0,alias:"constant"}}},/\$(?:\w+|[#?*!@$])/],entity:/\\(?:[abceEfnrtv\\"]|O?[0-7]{1,3}|U[0-9a-fA-F]{8}|u[0-9a-fA-F]{4}|x[0-9a-fA-F]{1,2})/};e.languages.bash={shebang:{pattern:/^#!\s*\/.*/,alias:"important"},comment:{pattern:/(^|[^"{\\$])#.*/,lookbehind:!0},"function-name":[{pattern:/(\bfunction\s+)[\w-]+(?=(?:\s*\(?:\s*\))?\s*\{)/,lookbehind:!0,alias:"function"},{pattern:/\b[\w-]+(?=\s*\(\s*\)\s*\{)/,alias:"function"}],"for-or-select":{pattern:/(\b(?:for|select)\s+)\w+(?=\s+in\s)/,alias:"variable",lookbehind:!0},"assign-left":{pattern:/(^|[\s;|&]|[<>]\()\w+(?:\.\w+)*(?=\+?=)/,inside:{environment:{pattern:RegExp("(^|[\\s;|&]|[<>]\\()"+t),lookbehind:!0,alias:"constant"}},alias:"variable",lookbehind:!0},parameter:{pattern:/(^|\s)-{1,2}(?:\w+:[+-]?)?\w+(?:\.\w+)*(?=[=\s]|$)/,alias:"variable",lookbehind:!0},string:[{pattern:/((?:^|[^<])<<-?\s*)(\w+)\s[\s\S]*?(?:\r?\n|\r)\2/,lookbehind:!0,greedy:!0,inside:n},{pattern:/((?:^|[^<])<<-?\s*)(["'])(\w+)\2\s[\s\S]*?(?:\r?\n|\r)\3/,lookbehind:!0,greedy:!0,inside:{bash:r}},{pattern:/(^|[^\\](?:\\\\)*)"(?:\\[\s\S]|\$\([^)]+\)|\$(?!\()|`[^`]+`|[^"\\`$])*"/,lookbehind:!0,greedy:!0,inside:n},{pattern:/(^|[^$\\])'[^']*'/,lookbehind:!0,greedy:!0},{pattern:/\$'(?:[^'\\]|\\[\s\S])*'/,greedy:!0,inside:{entity:n.entity}}],environment:{pattern:RegExp("\\$?"+t),alias:"constant"},variable:n.variable,function:{pattern:/(^|[\s;|&]|[<>]\()(?:add|apropos|apt|apt-cache|apt-get|aptitude|aspell|automysqlbackup|awk|basename|bash|bc|bconsole|bg|bzip2|cal|cargo|cat|cfdisk|chgrp|chkconfig|chmod|chown|chroot|cksum|clear|cmp|column|comm|composer|cp|cron|crontab|csplit|curl|cut|date|dc|dd|ddrescue|debootstrap|df|diff|diff3|dig|dir|dircolors|dirname|dirs|dmesg|docker|docker-compose|du|egrep|eject|env|ethtool|expand|expect|expr|fdformat|fdisk|fg|fgrep|file|find|fmt|fold|format|free|fsck|ftp|fuser|gawk|git|gparted|grep|groupadd|groupdel|groupmod|groups|grub-mkconfig|gzip|halt|head|hg|history|host|hostname|htop|iconv|id|ifconfig|ifdown|ifup|import|install|ip|java|jobs|join|kill|killall|less|link|ln|locate|logname|logrotate|look|lpc|lpr|lprint|lprintd|lprintq|lprm|ls|lsof|lynx|make|man|mc|mdadm|mkconfig|mkdir|mke2fs|mkfifo|mkfs|mkisofs|mknod|mkswap|mmv|more|most|mount|mtools|mtr|mutt|mv|nano|nc|netstat|nice|nl|node|nohup|notify-send|npm|nslookup|op|open|parted|passwd|paste|pathchk|ping|pkill|pnpm|podman|podman-compose|popd|pr|printcap|printenv|ps|pushd|pv|quota|quotacheck|quotactl|ram|rar|rcp|reboot|remsync|rename|renice|rev|rm|rmdir|rpm|rsync|scp|screen|sdiff|sed|sendmail|seq|service|sftp|sh|shellcheck|shuf|shutdown|sleep|slocate|sort|split|ssh|stat|strace|su|sudo|sum|suspend|swapon|sync|sysctl|tac|tail|tar|tee|time|timeout|top|touch|tr|traceroute|tsort|tty|umount|uname|unexpand|uniq|units|unrar|unshar|unzip|update-grub|uptime|useradd|userdel|usermod|users|uudecode|uuencode|v|vcpkg|vdir|vi|vim|virsh|vmstat|wait|watch|wc|wget|whereis|which|who|whoami|write|xargs|xdg-open|yarn|yes|zenity|zip|zsh|zypper)(?=$|[)\s;|&])/,lookbehind:!0},keyword:{pattern:/(^|[\s;|&]|[<>]\()(?:case|do|done|elif|else|esac|fi|for|function|if|in|select|then|until|while)(?=$|[)\s;|&])/,lookbehind:!0},builtin:{pattern:/(^|[\s;|&]|[<>]\()(?:\.|:|alias|bind|break|builtin|caller|cd|command|continue|declare|echo|enable|eval|exec|exit|export|getopts|hash|help|let|local|logout|mapfile|printf|pwd|read|readarray|readonly|return|set|shift|shopt|source|test|times|trap|type|typeset|ulimit|umask|unalias|unset)(?=$|[)\s;|&])/,lookbehind:!0,alias:"class-name"},boolean:{pattern:/(^|[\s;|&]|[<>]\()(?:false|true)(?=$|[)\s;|&])/,lookbehind:!0},"file-descriptor":{pattern:/\B&\d\b/,alias:"important"},operator:{pattern:/\d?<>|>\||\+=|=[=~]?|!=?|<<[<-]?|[&\d]?>>|\d[<>]&?|[<>][&=]?|&[>&]?|\|[&|]?/,inside:{"file-descriptor":{pattern:/^\d/,alias:"important"}}},punctuation:/\$?\(\(?|\)\)?|\.\.|[{}[\];\\]/,number:{pattern:/(^|\s)(?:[1-9]\d*|0)(?:[.,]\d+)?\b/,lookbehind:!0}},r.inside=e.languages.bash;for(var o=["comment","function-name","for-or-select","assign-left","parameter","string","environment","function","keyword","builtin","boolean","file-descriptor","operator","punctuation","number"],i=n.variable[1].inside,s=0;s<o.length;s++)i[o[s]]=e.languages.bash[o[s]];e.languages.sh=e.languages.bash,e.languages.shell=e.languages.bash}(Prism)},91113:()=>{!function(e){var t=/(?:"(?:\\(?:\r\n|[\s\S])|[^"\\\r\n])*"|'(?:\\(?:\r\n|[\s\S])|[^'\\\r\n])*')/;e.languages.css={comment:/\/\*[\s\S]*?\*\//,atrule:{pattern:RegExp("@[\\w-](?:"+/[^;{\s"']|\s+(?!\s)/.source+"|"+t.source+")*?"+/(?:;|(?=\s*\{))/.source),inside:{rule:/^@[\w-]+/,"selector-function-argument":{pattern:/(\bselector\s*\(\s*(?![\s)]))(?:[^()\s]|\s+(?![\s)])|\((?:[^()]|\([^()]*\))*\))+(?=\s*\))/,lookbehind:!0,alias:"selector"},keyword:{pattern:/(^|[^\w-])(?:and|not|only|or)(?![\w-])/,lookbehind:!0}}},url:{pattern:RegExp("\\burl\\((?:"+t.source+"|"+/(?:[^\\\r\n()"']|\\[\s\S])*/.source+")\\)","i"),greedy:!0,inside:{function:/^url/i,punctuation:/^\(|\)$/,string:{pattern:RegExp("^"+t.source+"$"),alias:"url"}}},selector:{pattern:RegExp("(^|[{}\\s])[^{}\\s](?:[^{};\"'\\s]|\\s+(?![\\s{])|"+t.source+")*(?=\\s*\\{)"),lookbehind:!0},string:{pattern:t,greedy:!0},property:{pattern:/(^|[^-\w\xA0-\uFFFF])(?!\s)[-_a-z\xA0-\uFFFF](?:(?!\s)[-\w\xA0-\uFFFF])*(?=\s*:)/i,lookbehind:!0},important:/!important\b/i,function:{pattern:/(^|[^-a-z0-9])[-a-z0-9]+(?=\()/i,lookbehind:!0},punctuation:/[(){};:,]/},e.languages.css.atrule.inside.rest=e.languages.css;var r=e.languages.markup;r&&(r.tag.addInlined("style","css"),r.tag.addAttribute("style","css"))}(Prism)},24784:()=>{!function(e){function t(e){return RegExp("(^(?:"+e+"):[ \t]*(?![ \t]))[^]+","i")}e.languages.http={"request-line":{pattern:/^(?:CONNECT|DELETE|GET|HEAD|OPTIONS|PATCH|POST|PRI|PUT|SEARCH|TRACE)\s(?:https?:\/\/|\/)\S*\sHTTP\/[\d.]+/m,inside:{method:{pattern:/^[A-Z]+\b/,alias:"property"},"request-target":{pattern:/^(\s)(?:https?:\/\/|\/)\S*(?=\s)/,lookbehind:!0,alias:"url",inside:e.languages.uri},"http-version":{pattern:/^(\s)HTTP\/[\d.]+/,lookbehind:!0,alias:"property"}}},"response-status":{pattern:/^HTTP\/[\d.]+ \d+ .+/m,inside:{"http-version":{pattern:/^HTTP\/[\d.]+/,alias:"property"},"status-code":{pattern:/^(\s)\d+(?=\s)/,lookbehind:!0,alias:"number"},"reason-phrase":{pattern:/^(\s).+/,lookbehind:!0,alias:"string"}}},header:{pattern:/^[\w-]+:.+(?:(?:\r\n?|\n)[ \t].+)*/m,inside:{"header-value":[{pattern:t(/Content-Security-Policy/.source),lookbehind:!0,alias:["csp","languages-csp"],inside:e.languages.csp},{pattern:t(/Public-Key-Pins(?:-Report-Only)?/.source),lookbehind:!0,alias:["hpkp","languages-hpkp"],inside:e.languages.hpkp},{pattern:t(/Strict-Transport-Security/.source),lookbehind:!0,alias:["hsts","languages-hsts"],inside:e.languages.hsts},{pattern:t(/[^:]+/.source),lookbehind:!0}],"header-name":{pattern:/^[^:]+/,alias:"keyword"},punctuation:/^:/}}};var r,n=e.languages,o={"application/javascript":n.javascript,"application/json":n.json||n.javascript,"application/xml":n.xml,"text/xml":n.xml,"text/html":n.html,"text/css":n.css,"text/plain":n.plain},i={"application/json":!0,"application/xml":!0};function s(e){var t=e.replace(/^[a-z]+\//,"");return"(?:"+e+"|"+("\\w+/(?:[\\w.-]+\\+)+"+t+"(?![+\\w.-])")+")"}for(var a in o)if(o[a]){r=r||{};var c=i[a]?s(a):a;r[a.replace(/\//g,"-")]={pattern:RegExp("("+/content-type:\s*/.source+c+/(?:(?:\r\n?|\n)[\w-].*)*(?:\r(?:\n|(?!\n))|\n)/.source+")"+/[^ \t\w-][\s\S]*/.source,"i"),lookbehind:!0,inside:o[a]}}r&&e.languages.insertBefore("http","header",r)}(Prism)},72514:()=>{Prism.languages.json={property:{pattern:/(^|[^\\])"(?:\\.|[^\\"\r\n])*"(?=\s*:)/,lookbehind:!0,greedy:!0},string:{pattern:/(^|[^\\])"(?:\\.|[^\\"\r\n])*"(?!\s*:)/,lookbehind:!0,greedy:!0},comment:{pattern:/\/\/.*|\/\*[\s\S]*?(?:\*\/|$)/,greedy:!0},number:/-?\b\d+(?:\.\d+)?(?:e[+-]?\d+)?\b/i,punctuation:/[{}[\],]/,operator:/:/,boolean:/\b(?:false|true)\b/,null:{pattern:/\bnull\b/,alias:"keyword"}},Prism.languages.webmanifest=Prism.languages.json},19700:()=>{!function(e){function t(e,t){return"___"+e.toUpperCase()+t+"___"}Object.defineProperties(e.languages["markup-templating"]={},{buildPlaceholders:{value:function(r,n,o,i){if(r.language===n){var s=r.tokenStack=[];r.code=r.code.replace(o,(function(e){if("function"==typeof i&&!i(e))return e;for(var o,a=s.length;-1!==r.code.indexOf(o=t(n,a));)++a;return s[a]=e,o})),r.grammar=e.languages.markup}}},tokenizePlaceholders:{value:function(r,n){if(r.language===n&&r.tokenStack){r.grammar=e.languages[n];var o=0,i=Object.keys(r.tokenStack);!function s(a){for(var c=0;c<a.length&&!(o>=i.length);c++){var p=a[c];if("string"==typeof p||p.content&&"string"==typeof p.content){var d=i[o],l=r.tokenStack[d],u="string"==typeof p?p:p.content,m=t(n,d),h=u.indexOf(m);if(h>-1){++o;var f=u.substring(0,h),g=new e.Token(n,e.tokenize(l,r.grammar),"language-"+n,l),y=u.substring(h+m.length),b=[];f&&b.push.apply(b,s([f])),b.push(g),y&&b.push.apply(b,s([y])),"string"==typeof p?a.splice.apply(a,[c,1].concat(b)):p.content=b}}else p.content&&s(p.content)}return a}(r.tokens)}}}})}(Prism)},43554:()=>{!function(e){var t=/\/\*[\s\S]*?\*\/|\/\/.*|#(?!\[).*/,r=[{pattern:/\b(?:false|true)\b/i,alias:"boolean"},{pattern:/(::\s*)\b[a-z_]\w*\b(?!\s*\()/i,greedy:!0,lookbehind:!0},{pattern:/(\b(?:case|const)\s+)\b[a-z_]\w*(?=\s*[;=])/i,greedy:!0,lookbehind:!0},/\b(?:null)\b/i,/\b[A-Z_][A-Z0-9_]*\b(?!\s*\()/],n=/\b0b[01]+(?:_[01]+)*\b|\b0o[0-7]+(?:_[0-7]+)*\b|\b0x[\da-f]+(?:_[\da-f]+)*\b|(?:\b\d+(?:_\d+)*\.?(?:\d+(?:_\d+)*)?|\B\.\d+)(?:e[+-]?\d+)?/i,o=/<?=>|\?\?=?|\.{3}|\??->|[!=]=?=?|::|\*\*=?|--|\+\+|&&|\|\||<<|>>|[?~]|[/^|%*&<>.+-]=?/,i=/[{}\[\](),:;]/;e.languages.php={delimiter:{pattern:/\?>$|^<\?(?:php(?=\s)|=)?/i,alias:"important"},comment:t,variable:/\$+(?:\w+\b|(?=\{))/,package:{pattern:/(namespace\s+|use\s+(?:function\s+)?)(?:\\?\b[a-z_]\w*)+\b(?!\\)/i,lookbehind:!0,inside:{punctuation:/\\/}},"class-name-definition":{pattern:/(\b(?:class|enum|interface|trait)\s+)\b[a-z_]\w*(?!\\)\b/i,lookbehind:!0,alias:"class-name"},"function-definition":{pattern:/(\bfunction\s+)[a-z_]\w*(?=\s*\()/i,lookbehind:!0,alias:"function"},keyword:[{pattern:/(\(\s*)\b(?:array|bool|boolean|float|int|integer|object|string)\b(?=\s*\))/i,alias:"type-casting",greedy:!0,lookbehind:!0},{pattern:/([(,?]\s*)\b(?:array(?!\s*\()|bool|callable|(?:false|null)(?=\s*\|)|float|int|iterable|mixed|object|self|static|string)\b(?=\s*\$)/i,alias:"type-hint",greedy:!0,lookbehind:!0},{pattern:/(\)\s*:\s*(?:\?\s*)?)\b(?:array(?!\s*\()|bool|callable|(?:false|null)(?=\s*\|)|float|int|iterable|mixed|never|object|self|static|string|void)\b/i,alias:"return-type",greedy:!0,lookbehind:!0},{pattern:/\b(?:array(?!\s*\()|bool|float|int|iterable|mixed|object|string|void)\b/i,alias:"type-declaration",greedy:!0},{pattern:/(\|\s*)(?:false|null)\b|\b(?:false|null)(?=\s*\|)/i,alias:"type-declaration",greedy:!0,lookbehind:!0},{pattern:/\b(?:parent|self|static)(?=\s*::)/i,alias:"static-context",greedy:!0},{pattern:/(\byield\s+)from\b/i,lookbehind:!0},/\bclass\b/i,{pattern:/((?:^|[^\s>:]|(?:^|[^-])>|(?:^|[^:]):)\s*)\b(?:abstract|and|array|as|break|callable|case|catch|clone|const|continue|declare|default|die|do|echo|else|elseif|empty|enddeclare|endfor|endforeach|endif|endswitch|endwhile|enum|eval|exit|extends|final|finally|fn|for|foreach|function|global|goto|if|implements|include|include_once|instanceof|insteadof|interface|isset|list|match|namespace|never|new|or|parent|print|private|protected|public|readonly|require|require_once|return|self|static|switch|throw|trait|try|unset|use|var|while|xor|yield|__halt_compiler)\b/i,lookbehind:!0}],"argument-name":{pattern:/([(,]\s*)\b[a-z_]\w*(?=\s*:(?!:))/i,lookbehind:!0},"class-name":[{pattern:/(\b(?:extends|implements|instanceof|new(?!\s+self|\s+static))\s+|\bcatch\s*\()\b[a-z_]\w*(?!\\)\b/i,greedy:!0,lookbehind:!0},{pattern:/(\|\s*)\b[a-z_]\w*(?!\\)\b/i,greedy:!0,lookbehind:!0},{pattern:/\b[a-z_]\w*(?!\\)\b(?=\s*\|)/i,greedy:!0},{pattern:/(\|\s*)(?:\\?\b[a-z_]\w*)+\b/i,alias:"class-name-fully-qualified",greedy:!0,lookbehind:!0,inside:{punctuation:/\\/}},{pattern:/(?:\\?\b[a-z_]\w*)+\b(?=\s*\|)/i,alias:"class-name-fully-qualified",greedy:!0,inside:{punctuation:/\\/}},{pattern:/(\b(?:extends|implements|instanceof|new(?!\s+self\b|\s+static\b))\s+|\bcatch\s*\()(?:\\?\b[a-z_]\w*)+\b(?!\\)/i,alias:"class-name-fully-qualified",greedy:!0,lookbehind:!0,inside:{punctuation:/\\/}},{pattern:/\b[a-z_]\w*(?=\s*\$)/i,alias:"type-declaration",greedy:!0},{pattern:/(?:\\?\b[a-z_]\w*)+(?=\s*\$)/i,alias:["class-name-fully-qualified","type-declaration"],greedy:!0,inside:{punctuation:/\\/}},{pattern:/\b[a-z_]\w*(?=\s*::)/i,alias:"static-context",greedy:!0},{pattern:/(?:\\?\b[a-z_]\w*)+(?=\s*::)/i,alias:["class-name-fully-qualified","static-context"],greedy:!0,inside:{punctuation:/\\/}},{pattern:/([(,?]\s*)[a-z_]\w*(?=\s*\$)/i,alias:"type-hint",greedy:!0,lookbehind:!0},{pattern:/([(,?]\s*)(?:\\?\b[a-z_]\w*)+(?=\s*\$)/i,alias:["class-name-fully-qualified","type-hint"],greedy:!0,lookbehind:!0,inside:{punctuation:/\\/}},{pattern:/(\)\s*:\s*(?:\?\s*)?)\b[a-z_]\w*(?!\\)\b/i,alias:"return-type",greedy:!0,lookbehind:!0},{pattern:/(\)\s*:\s*(?:\?\s*)?)(?:\\?\b[a-z_]\w*)+\b(?!\\)/i,alias:["class-name-fully-qualified","return-type"],greedy:!0,lookbehind:!0,inside:{punctuation:/\\/}}],constant:r,function:{pattern:/(^|[^\\\w])\\?[a-z_](?:[\w\\]*\w)?(?=\s*\()/i,lookbehind:!0,inside:{punctuation:/\\/}},property:{pattern:/(->\s*)\w+/,lookbehind:!0},number:n,operator:o,punctuation:i};var s={pattern:/\{\$(?:\{(?:\{[^{}]+\}|[^{}]+)\}|[^{}])+\}|(^|[^\\{])\$+(?:\w+(?:\[[^\r\n\[\]]+\]|->\w+)?)/,lookbehind:!0,inside:e.languages.php},a=[{pattern:/<<<'([^']+)'[\r\n](?:.*[\r\n])*?\1;/,alias:"nowdoc-string",greedy:!0,inside:{delimiter:{pattern:/^<<<'[^']+'|[a-z_]\w*;$/i,alias:"symbol",inside:{punctuation:/^<<<'?|[';]$/}}}},{pattern:/<<<(?:"([^"]+)"[\r\n](?:.*[\r\n])*?\1;|([a-z_]\w*)[\r\n](?:.*[\r\n])*?\2;)/i,alias:"heredoc-string",greedy:!0,inside:{delimiter:{pattern:/^<<<(?:"[^"]+"|[a-z_]\w*)|[a-z_]\w*;$/i,alias:"symbol",inside:{punctuation:/^<<<"?|[";]$/}},interpolation:s}},{pattern:/`(?:\\[\s\S]|[^\\`])*`/,alias:"backtick-quoted-string",greedy:!0},{pattern:/'(?:\\[\s\S]|[^\\'])*'/,alias:"single-quoted-string",greedy:!0},{pattern:/"(?:\\[\s\S]|[^\\"])*"/,alias:"double-quoted-string",greedy:!0,inside:{interpolation:s}}];e.languages.insertBefore("php","variable",{string:a,attribute:{pattern:/#\[(?:[^"'\/#]|\/(?![*/])|\/\/.*$|#(?!\[).*$|\/\*(?:[^*]|\*(?!\/))*\*\/|"(?:\\[\s\S]|[^\\"])*"|'(?:\\[\s\S]|[^\\'])*')+\](?=\s*[a-z$#])/im,greedy:!0,inside:{"attribute-content":{pattern:/^(#\[)[\s\S]+(?=\]$)/,lookbehind:!0,inside:{comment:t,string:a,"attribute-class-name":[{pattern:/([^:]|^)\b[a-z_]\w*(?!\\)\b/i,alias:"class-name",greedy:!0,lookbehind:!0},{pattern:/([^:]|^)(?:\\?\b[a-z_]\w*)+/i,alias:["class-name","class-name-fully-qualified"],greedy:!0,lookbehind:!0,inside:{punctuation:/\\/}}],constant:r,number:n,operator:o,punctuation:i}},delimiter:{pattern:/^#\[|\]$/,alias:"punctuation"}}}}),e.hooks.add("before-tokenize",(function(t){if(/<\?/.test(t.code)){e.languages["markup-templating"].buildPlaceholders(t,"php",/<\?(?:[^"'/#]|\/(?![*/])|("|')(?:\\[\s\S]|(?!\1)[^\\])*\1|(?:\/\/|#(?!\[))(?:[^?\n\r]|\?(?!>))*(?=$|\?>|[\r\n])|#\[|\/\*(?:[^*]|\*(?!\/))*(?:\*\/|$))*?(?:\?>|$)/g)}})),e.hooks.add("after-tokenize",(function(t){e.languages["markup-templating"].tokenizePlaceholders(t,"php")}))}(Prism)},41648:()=>{!function(e){e.languages.ruby=e.languages.extend("clike",{comment:{pattern:/#.*|^=begin\s[\s\S]*?^=end/m,greedy:!0},"class-name":{pattern:/(\b(?:class|module)\s+|\bcatch\s+\()[\w.\\]+|\b[A-Z_]\w*(?=\s*\.\s*new\b)/,lookbehind:!0,inside:{punctuation:/[.\\]/}},keyword:/\b(?:BEGIN|END|alias|and|begin|break|case|class|def|define_method|defined|do|each|else|elsif|end|ensure|extend|for|if|in|include|module|new|next|nil|not|or|prepend|private|protected|public|raise|redo|require|rescue|retry|return|self|super|then|throw|undef|unless|until|when|while|yield)\b/,operator:/\.{2,3}|&\.|===|<?=>|[!=]?~|(?:&&|\|\||<<|>>|\*\*|[+\-*/%<>!^&|=])=?|[?:]/,punctuation:/[(){}[\].,;]/}),e.languages.insertBefore("ruby","operator",{"double-colon":{pattern:/::/,alias:"punctuation"}});var t={pattern:/((?:^|[^\\])(?:\\{2})*)#\{(?:[^{}]|\{[^{}]*\})*\}/,lookbehind:!0,inside:{content:{pattern:/^(#\{)[\s\S]+(?=\}$)/,lookbehind:!0,inside:e.languages.ruby},delimiter:{pattern:/^#\{|\}$/,alias:"punctuation"}}};delete e.languages.ruby.function;var r="(?:"+[/([^a-zA-Z0-9\s{(\[<=])(?:(?!\1)[^\\]|\\[\s\S])*\1/.source,/\((?:[^()\\]|\\[\s\S]|\((?:[^()\\]|\\[\s\S])*\))*\)/.source,/\{(?:[^{}\\]|\\[\s\S]|\{(?:[^{}\\]|\\[\s\S])*\})*\}/.source,/\[(?:[^\[\]\\]|\\[\s\S]|\[(?:[^\[\]\\]|\\[\s\S])*\])*\]/.source,/<(?:[^<>\\]|\\[\s\S]|<(?:[^<>\\]|\\[\s\S])*>)*>/.source].join("|")+")",n=/(?:"(?:\\.|[^"\\\r\n])*"|(?:\b[a-zA-Z_]\w*|[^\s\0-\x7F]+)[?!]?|\$.)/.source;e.languages.insertBefore("ruby","keyword",{"regex-literal":[{pattern:RegExp(/%r/.source+r+/[egimnosux]{0,6}/.source),greedy:!0,inside:{interpolation:t,regex:/[\s\S]+/}},{pattern:/(^|[^/])\/(?!\/)(?:\[[^\r\n\]]+\]|\\.|[^[/\\\r\n])+\/[egimnosux]{0,6}(?=\s*(?:$|[\r\n,.;})#]))/,lookbehind:!0,greedy:!0,inside:{interpolation:t,regex:/[\s\S]+/}}],variable:/[@$]+[a-zA-Z_]\w*(?:[?!]|\b)/,symbol:[{pattern:RegExp(/(^|[^:]):/.source+n),lookbehind:!0,greedy:!0},{pattern:RegExp(/([\r\n{(,][ \t]*)/.source+n+/(?=:(?!:))/.source),lookbehind:!0,greedy:!0}],"method-definition":{pattern:/(\bdef\s+)\w+(?:\s*\.\s*\w+)?/,lookbehind:!0,inside:{function:/\b\w+$/,keyword:/^self\b/,"class-name":/^\w+/,punctuation:/\./}}}),e.languages.insertBefore("ruby","string",{"string-literal":[{pattern:RegExp(/%[qQiIwWs]?/.source+r),greedy:!0,inside:{interpolation:t,string:/[\s\S]+/}},{pattern:/("|')(?:#\{[^}]+\}|#(?!\{)|\\(?:\r\n|[\s\S])|(?!\1)[^\\#\r\n])*\1/,greedy:!0,inside:{interpolation:t,string:/[\s\S]+/}},{pattern:/<<[-~]?([a-z_]\w*)[\r\n](?:.*[\r\n])*?[\t ]*\1/i,alias:"heredoc-string",greedy:!0,inside:{delimiter:{pattern:/^<<[-~]?[a-z_]\w*|\b[a-z_]\w*$/i,inside:{symbol:/\b\w+/,punctuation:/^<<[-~]?/}},interpolation:t,string:/[\s\S]+/}},{pattern:/<<[-~]?'([a-z_]\w*)'[\r\n](?:.*[\r\n])*?[\t ]*\1/i,alias:"heredoc-string",greedy:!0,inside:{delimiter:{pattern:/^<<[-~]?'[a-z_]\w*'|\b[a-z_]\w*$/i,inside:{symbol:/\b\w+/,punctuation:/^<<[-~]?'|'$/}},string:/[\s\S]+/}}],"command-literal":[{pattern:RegExp(/%x/.source+r),greedy:!0,inside:{interpolation:t,command:{pattern:/[\s\S]+/,alias:"string"}}},{pattern:/`(?:#\{[^}]+\}|#(?!\{)|\\(?:\r\n|[\s\S])|[^\\`#\r\n])*`/,greedy:!0,inside:{interpolation:t,command:{pattern:/[\s\S]+/,alias:"string"}}}]}),delete e.languages.ruby.string,e.languages.insertBefore("ruby","number",{builtin:/\b(?:Array|Bignum|Binding|Class|Continuation|Dir|Exception|FalseClass|File|Fixnum|Float|Hash|IO|Integer|MatchData|Method|Module|NilClass|Numeric|Object|Proc|Range|Regexp|Stat|String|Struct|Symbol|TMS|Thread|ThreadGroup|Time|TrueClass)\b/,constant:/\b[A-Z][A-Z0-9_]*(?:[?!]|\b)/}),e.languages.rb=e.languages.ruby}(Prism)},66374:(e,t,r)=>{var n={"./prism-bash":57022,"./prism-css":91113,"./prism-http":24784,"./prism-json":72514,"./prism-php":43554,"./prism-ruby":41648};function o(e){var t=i(e);return r(t)}function i(e){if(!r.o(n,e)){var t=new Error("Cannot find module '"+e+"'");throw t.code="MODULE_NOT_FOUND",t}return n[e]}o.keys=function(){return Object.keys(n)},o.resolve=i,e.exports=o,o.id=66374},2694:(e,t,r)=>{"use strict";var n=r(6925);function o(){}function i(){}i.resetWarningCache=o,e.exports=function(){function e(e,t,r,o,i,s){if(s!==n){var a=new Error("Calling PropTypes validators directly is not supported by the `prop-types` package. Use PropTypes.checkPropTypes() to call them. Read more at http://fb.me/use-check-prop-types");throw a.name="Invariant Violation",a}}function t(){return e}e.isRequired=e;var r={array:e,bigint:e,bool:e,func:e,number:e,object:e,string:e,symbol:e,any:e,arrayOf:t,element:e,elementType:e,instanceOf:t,node:e,objectOf:t,oneOf:t,oneOfType:t,shape:t,exact:t,checkPropTypes:i,resetWarningCache:o};return r.PropTypes=r,r}},5556:(e,t,r)=>{e.exports=r(2694)()},6925:e=>{"use strict";e.exports="SECRET_DO_NOT_PASS_THIS_OR_YOU_WILL_BE_FIRED"},22551:(e,t,r)=>{"use strict";var n=r(96540),o=r(69982);function i(e){for(var t="https://reactjs.org/docs/error-decoder.html?invariant="+e,r=1;r<arguments.length;r++)t+="&args[]="+encodeURIComponent(arguments[r]);return"Minified React error #"+e+"; visit "+t+" for the full message or use the non-minified dev environment for full errors and additional helpful warnings."}var s=new Set,a={};function c(e,t){p(e,t),p(e+"Capture",t)}function p(e,t){for(a[e]=t,e=0;e<t.length;e++)s.add(t[e])}var d=!("undefined"==typeof window||void 0===window.document||void 0===window.document.createElement),l=Object.prototype.hasOwnProperty,u=/^[:A-Z_a-z\u00C0-\u00D6\u00D8-\u00F6\u00F8-\u02FF\u0370-\u037D\u037F-\u1FFF\u200C-\u200D\u2070-\u218F\u2C00-\u2FEF\u3001-\uD7FF\uF900-\uFDCF\uFDF0-\uFFFD][:A-Z_a-z\u00C0-\u00D6\u00D8-\u00F6\u00F8-\u02FF\u0370-\u037D\u037F-\u1FFF\u200C-\u200D\u2070-\u218F\u2C00-\u2FEF\u3001-\uD7FF\uF900-\uFDCF\uFDF0-\uFFFD\-.0-9\u00B7\u0300-\u036F\u203F-\u2040]*$/,m={},h={};function f(e,t,r,n,o,i,s){this.acceptsBooleans=2===t||3===t||4===t,this.attributeName=n,this.attributeNamespace=o,this.mustUseProperty=r,this.propertyName=e,this.type=t,this.sanitizeURL=i,this.removeEmptyString=s}var g={};"children dangerouslySetInnerHTML defaultValue defaultChecked innerHTML suppressContentEditableWarning suppressHydrationWarning style".split(" ").forEach((function(e){g[e]=new f(e,0,!1,e,null,!1,!1)})),[["acceptCharset","accept-charset"],["className","class"],["htmlFor","for"],["httpEquiv","http-equiv"]].forEach((function(e){var t=e[0];g[t]=new f(t,1,!1,e[1],null,!1,!1)})),["contentEditable","draggable","spellCheck","value"].forEach((function(e){g[e]=new f(e,2,!1,e.toLowerCase(),null,!1,!1)})),["autoReverse","externalResourcesRequired","focusable","preserveAlpha"].forEach((function(e){g[e]=new f(e,2,!1,e,null,!1,!1)})),"allowFullScreen async autoFocus autoPlay controls default defer disabled disablePictureInPicture disableRemotePlayback formNoValidate hidden loop noModule noValidate open playsInline readOnly required reversed scoped seamless itemScope".split(" ").forEach((function(e){g[e]=new f(e,3,!1,e.toLowerCase(),null,!1,!1)})),["checked","multiple","muted","selected"].forEach((function(e){g[e]=new f(e,3,!0,e,null,!1,!1)})),["capture","download"].forEach((function(e){g[e]=new f(e,4,!1,e,null,!1,!1)})),["cols","rows","size","span"].forEach((function(e){g[e]=new f(e,6,!1,e,null,!1,!1)})),["rowSpan","start"].forEach((function(e){g[e]=new f(e,5,!1,e.toLowerCase(),null,!1,!1)}));var y=/[\-:]([a-z])/g;function b(e){return e[1].toUpperCase()}function _(e,t,r,n){var o=g.hasOwnProperty(t)?g[t]:null;(null!==o?0!==o.type:n||!(2<t.length)||"o"!==t[0]&&"O"!==t[0]||"n"!==t[1]&&"N"!==t[1])&&(function(e,t,r,n){if(null==t||function(e,t,r,n){if(null!==r&&0===r.type)return!1;switch(typeof t){case"function":case"symbol":return!0;case"boolean":return!n&&(null!==r?!r.acceptsBooleans:"data-"!==(e=e.toLowerCase().slice(0,5))&&"aria-"!==e);default:return!1}}(e,t,r,n))return!0;if(n)return!1;if(null!==r)switch(r.type){case 3:return!t;case 4:return!1===t;case 5:return isNaN(t);case 6:return isNaN(t)||1>t}return!1}(t,r,o,n)&&(r=null),n||null===o?function(e){return!!l.call(h,e)||!l.call(m,e)&&(u.test(e)?h[e]=!0:(m[e]=!0,!1))}(t)&&(null===r?e.removeAttribute(t):e.setAttribute(t,""+r)):o.mustUseProperty?e[o.propertyName]=null===r?3!==o.type&&"":r:(t=o.attributeName,n=o.attributeNamespace,null===r?e.removeAttribute(t):(r=3===(o=o.type)||4===o&&!0===r?"":""+r,n?e.setAttributeNS(n,t,r):e.setAttribute(t,r))))}"accent-height alignment-baseline arabic-form baseline-shift cap-height clip-path clip-rule color-interpolation color-interpolation-filters color-profile color-rendering dominant-baseline enable-background fill-opacity fill-rule flood-color flood-opacity font-family font-size font-size-adjust font-stretch font-style font-variant font-weight glyph-name glyph-orientation-horizontal glyph-orientation-vertical horiz-adv-x horiz-origin-x image-rendering letter-spacing lighting-color marker-end marker-mid marker-start overline-position overline-thickness paint-order panose-1 pointer-events rendering-intent shape-rendering stop-color stop-opacity strikethrough-position strikethrough-thickness stroke-dasharray stroke-dashoffset stroke-linecap stroke-linejoin stroke-miterlimit stroke-opacity stroke-width text-anchor text-decoration text-rendering underline-position underline-thickness unicode-bidi unicode-range units-per-em v-alphabetic v-hanging v-ideographic v-mathematical vector-effect vert-adv-y vert-origin-x vert-origin-y word-spacing writing-mode xmlns:xlink x-height".split(" ").forEach((function(e){var t=e.replace(y,b);g[t]=new f(t,1,!1,e,null,!1,!1)})),"xlink:actuate xlink:arcrole xlink:role xlink:show xlink:title xlink:type".split(" ").forEach((function(e){var t=e.replace(y,b);g[t]=new f(t,1,!1,e,"http://www.w3.org/1999/xlink",!1,!1)})),["xml:base","xml:lang","xml:space"].forEach((function(e){var t=e.replace(y,b);g[t]=new f(t,1,!1,e,"http://www.w3.org/XML/1998/namespace",!1,!1)})),["tabIndex","crossOrigin"].forEach((function(e){g[e]=new f(e,1,!1,e.toLowerCase(),null,!1,!1)})),g.xlinkHref=new f("xlinkHref",1,!1,"xlink:href","http://www.w3.org/1999/xlink",!0,!1),["src","href","action","formAction"].forEach((function(e){g[e]=new f(e,1,!1,e.toLowerCase(),null,!0,!0)}));var v=n.__SECRET_INTERNALS_DO_NOT_USE_OR_YOU_WILL_BE_FIRED,x=Symbol.for("react.element"),w=Symbol.for("react.portal"),k=Symbol.for("react.fragment"),S=Symbol.for("react.strict_mode"),T=Symbol.for("react.profiler"),C=Symbol.for("react.provider"),A=Symbol.for("react.context"),I=Symbol.for("react.forward_ref"),j=Symbol.for("react.suspense"),E=Symbol.for("react.suspense_list"),P=Symbol.for("react.memo"),R=Symbol.for("react.lazy");Symbol.for("react.scope"),Symbol.for("react.debug_trace_mode");var O=Symbol.for("react.offscreen");Symbol.for("react.legacy_hidden"),Symbol.for("react.cache"),Symbol.for("react.tracing_marker");var q=Symbol.iterator;function $(e){return null===e||"object"!=typeof e?null:"function"==typeof(e=q&&e[q]||e["@@iterator"])?e:null}var D,B=Object.assign;function L(e){if(void 0===D)try{throw Error()}catch(r){var t=r.stack.trim().match(/\n( *(at )?)/);D=t&&t[1]||""}return"\n"+D+e}var U=!1;function N(e,t){if(!e||U)return"";U=!0;var r=Error.prepareStackTrace;Error.prepareStackTrace=void 0;try{if(t)if(t=function(){throw Error()},Object.defineProperty(t.prototype,"props",{set:function(){throw Error()}}),"object"==typeof Reflect&&Reflect.construct){try{Reflect.construct(t,[])}catch(p){var n=p}Reflect.construct(e,[],t)}else{try{t.call()}catch(p){n=p}e.call(t.prototype)}else{try{throw Error()}catch(p){n=p}e()}}catch(p){if(p&&n&&"string"==typeof p.stack){for(var o=p.stack.split("\n"),i=n.stack.split("\n"),s=o.length-1,a=i.length-1;1<=s&&0<=a&&o[s]!==i[a];)a--;for(;1<=s&&0<=a;s--,a--)if(o[s]!==i[a]){if(1!==s||1!==a)do{if(s--,0>--a||o[s]!==i[a]){var c="\n"+o[s].replace(" at new "," at ");return e.displayName&&c.includes("<anonymous>")&&(c=c.replace("<anonymous>",e.displayName)),c}}while(1<=s&&0<=a);break}}}finally{U=!1,Error.prepareStackTrace=r}return(e=e?e.displayName||e.name:"")?L(e):""}function F(e){switch(e.tag){case 5:return L(e.type);case 16:return L("Lazy");case 13:return L("Suspense");case 19:return L("SuspenseList");case 0:case 2:case 15:return e=N(e.type,!1);case 11:return e=N(e.type.render,!1);case 1:return e=N(e.type,!0);default:return""}}function M(e){if(null==e)return null;if("function"==typeof e)return e.displayName||e.name||null;if("string"==typeof e)return e;switch(e){case k:return"Fragment";case w:return"Portal";case T:return"Profiler";case S:return"StrictMode";case j:return"Suspense";case E:return"SuspenseList"}if("object"==typeof e)switch(e.$$typeof){case A:return(e.displayName||"Context")+".Consumer";case C:return(e._context.displayName||"Context")+".Provider";case I:var t=e.render;return(e=e.displayName)||(e=""!==(e=t.displayName||t.name||"")?"ForwardRef("+e+")":"ForwardRef"),e;case P:return null!==(t=e.displayName||null)?t:M(e.type)||"Memo";case R:t=e._payload,e=e._init;try{return M(e(t))}catch(r){}}return null}function G(e){var t=e.type;switch(e.tag){case 24:return"Cache";case 9:return(t.displayName||"Context")+".Consumer";case 10:return(t._context.displayName||"Context")+".Provider";case 18:return"DehydratedFragment";case 11:return e=(e=t.render).displayName||e.name||"",t.displayName||(""!==e?"ForwardRef("+e+")":"ForwardRef");case 7:return"Fragment";case 5:return t;case 4:return"Portal";case 3:return"Root";case 6:return"Text";case 16:return M(t);case 8:return t===S?"StrictMode":"Mode";case 22:return"Offscreen";case 12:return"Profiler";case 21:return"Scope";case 13:return"Suspense";case 19:return"SuspenseList";case 25:return"TracingMarker";case 1:case 0:case 17:case 2:case 14:case 15:if("function"==typeof t)return t.displayName||t.name||null;if("string"==typeof t)return t}return null}function z(e){switch(typeof e){case"boolean":case"number":case"string":case"undefined":case"object":return e;default:return""}}function W(e){var t=e.type;return(e=e.nodeName)&&"input"===e.toLowerCase()&&("checkbox"===t||"radio"===t)}function H(e){e._valueTracker||(e._valueTracker=function(e){var t=W(e)?"checked":"value",r=Object.getOwnPropertyDescriptor(e.constructor.prototype,t),n=""+e[t];if(!e.hasOwnProperty(t)&&void 0!==r&&"function"==typeof r.get&&"function"==typeof r.set){var o=r.get,i=r.set;return Object.defineProperty(e,t,{configurable:!0,get:function(){return o.call(this)},set:function(e){n=""+e,i.call(this,e)}}),Object.defineProperty(e,t,{enumerable:r.enumerable}),{getValue:function(){return n},setValue:function(e){n=""+e},stopTracking:function(){e._valueTracker=null,delete e[t]}}}}(e))}function Z(e){if(!e)return!1;var t=e._valueTracker;if(!t)return!0;var r=t.getValue(),n="";return e&&(n=W(e)?e.checked?"true":"false":e.value),(e=n)!==r&&(t.setValue(e),!0)}function V(e){if(void 0===(e=e||("undefined"!=typeof document?document:void 0)))return null;try{return e.activeElement||e.body}catch(t){return e.body}}function K(e,t){var r=t.checked;return B({},t,{defaultChecked:void 0,defaultValue:void 0,value:void 0,checked:null!=r?r:e._wrapperState.initialChecked})}function Y(e,t){var r=null==t.defaultValue?"":t.defaultValue,n=null!=t.checked?t.checked:t.defaultChecked;r=z(null!=t.value?t.value:r),e._wrapperState={initialChecked:n,initialValue:r,controlled:"checkbox"===t.type||"radio"===t.type?null!=t.checked:null!=t.value}}function J(e,t){null!=(t=t.checked)&&_(e,"checked",t,!1)}function X(e,t){J(e,t);var r=z(t.value),n=t.type;if(null!=r)"number"===n?(0===r&&""===e.value||e.value!=r)&&(e.value=""+r):e.value!==""+r&&(e.value=""+r);else if("submit"===n||"reset"===n)return void e.removeAttribute("value");t.hasOwnProperty("value")?ee(e,t.type,r):t.hasOwnProperty("defaultValue")&&ee(e,t.type,z(t.defaultValue)),null==t.checked&&null!=t.defaultChecked&&(e.defaultChecked=!!t.defaultChecked)}function Q(e,t,r){if(t.hasOwnProperty("value")||t.hasOwnProperty("defaultValue")){var n=t.type;if(!("submit"!==n&&"reset"!==n||void 0!==t.value&&null!==t.value))return;t=""+e._wrapperState.initialValue,r||t===e.value||(e.value=t),e.defaultValue=t}""!==(r=e.name)&&(e.name=""),e.defaultChecked=!!e._wrapperState.initialChecked,""!==r&&(e.name=r)}function ee(e,t,r){"number"===t&&V(e.ownerDocument)===e||(null==r?e.defaultValue=""+e._wrapperState.initialValue:e.defaultValue!==""+r&&(e.defaultValue=""+r))}var te=Array.isArray;function re(e,t,r,n){if(e=e.options,t){t={};for(var o=0;o<r.length;o++)t["$"+r[o]]=!0;for(r=0;r<e.length;r++)o=t.hasOwnProperty("$"+e[r].value),e[r].selected!==o&&(e[r].selected=o),o&&n&&(e[r].defaultSelected=!0)}else{for(r=""+z(r),t=null,o=0;o<e.length;o++){if(e[o].value===r)return e[o].selected=!0,void(n&&(e[o].defaultSelected=!0));null!==t||e[o].disabled||(t=e[o])}null!==t&&(t.selected=!0)}}function ne(e,t){if(null!=t.dangerouslySetInnerHTML)throw Error(i(91));return B({},t,{value:void 0,defaultValue:void 0,children:""+e._wrapperState.initialValue})}function oe(e,t){var r=t.value;if(null==r){if(r=t.children,t=t.defaultValue,null!=r){if(null!=t)throw Error(i(92));if(te(r)){if(1<r.length)throw Error(i(93));r=r[0]}t=r}null==t&&(t=""),r=t}e._wrapperState={initialValue:z(r)}}function ie(e,t){var r=z(t.value),n=z(t.defaultValue);null!=r&&((r=""+r)!==e.value&&(e.value=r),null==t.defaultValue&&e.defaultValue!==r&&(e.defaultValue=r)),null!=n&&(e.defaultValue=""+n)}function se(e){var t=e.textContent;t===e._wrapperState.initialValue&&""!==t&&null!==t&&(e.value=t)}function ae(e){switch(e){case"svg":return"http://www.w3.org/2000/svg";case"math":return"http://www.w3.org/1998/Math/MathML";default:return"http://www.w3.org/1999/xhtml"}}function ce(e,t){return null==e||"http://www.w3.org/1999/xhtml"===e?ae(t):"http://www.w3.org/2000/svg"===e&&"foreignObject"===t?"http://www.w3.org/1999/xhtml":e}var pe,de,le=(de=function(e,t){if("http://www.w3.org/2000/svg"!==e.namespaceURI||"innerHTML"in e)e.innerHTML=t;else{for((pe=pe||document.createElement("div")).innerHTML="<svg>"+t.valueOf().toString()+"</svg>",t=pe.firstChild;e.firstChild;)e.removeChild(e.firstChild);for(;t.firstChild;)e.appendChild(t.firstChild)}},"undefined"!=typeof MSApp&&MSApp.execUnsafeLocalFunction?function(e,t,r,n){MSApp.execUnsafeLocalFunction((function(){return de(e,t)}))}:de);function ue(e,t){if(t){var r=e.firstChild;if(r&&r===e.lastChild&&3===r.nodeType)return void(r.nodeValue=t)}e.textContent=t}var me={animationIterationCount:!0,aspectRatio:!0,borderImageOutset:!0,borderImageSlice:!0,borderImageWidth:!0,boxFlex:!0,boxFlexGroup:!0,boxOrdinalGroup:!0,columnCount:!0,columns:!0,flex:!0,flexGrow:!0,flexPositive:!0,flexShrink:!0,flexNegative:!0,flexOrder:!0,gridArea:!0,gridRow:!0,gridRowEnd:!0,gridRowSpan:!0,gridRowStart:!0,gridColumn:!0,gridColumnEnd:!0,gridColumnSpan:!0,gridColumnStart:!0,fontWeight:!0,lineClamp:!0,lineHeight:!0,opacity:!0,order:!0,orphans:!0,tabSize:!0,widows:!0,zIndex:!0,zoom:!0,fillOpacity:!0,floodOpacity:!0,stopOpacity:!0,strokeDasharray:!0,strokeDashoffset:!0,strokeMiterlimit:!0,strokeOpacity:!0,strokeWidth:!0},he=["Webkit","ms","Moz","O"];function fe(e,t,r){return null==t||"boolean"==typeof t||""===t?"":r||"number"!=typeof t||0===t||me.hasOwnProperty(e)&&me[e]?(""+t).trim():t+"px"}function ge(e,t){for(var r in e=e.style,t)if(t.hasOwnProperty(r)){var n=0===r.indexOf("--"),o=fe(r,t[r],n);"float"===r&&(r="cssFloat"),n?e.setProperty(r,o):e[r]=o}}Object.keys(me).forEach((function(e){he.forEach((function(t){t=t+e.charAt(0).toUpperCase()+e.substring(1),me[t]=me[e]}))}));var ye=B({menuitem:!0},{area:!0,base:!0,br:!0,col:!0,embed:!0,hr:!0,img:!0,input:!0,keygen:!0,link:!0,meta:!0,param:!0,source:!0,track:!0,wbr:!0});function be(e,t){if(t){if(ye[e]&&(null!=t.children||null!=t.dangerouslySetInnerHTML))throw Error(i(137,e));if(null!=t.dangerouslySetInnerHTML){if(null!=t.children)throw Error(i(60));if("object"!=typeof t.dangerouslySetInnerHTML||!("__html"in t.dangerouslySetInnerHTML))throw Error(i(61))}if(null!=t.style&&"object"!=typeof t.style)throw Error(i(62))}}function _e(e,t){if(-1===e.indexOf("-"))return"string"==typeof t.is;switch(e){case"annotation-xml":case"color-profile":case"font-face":case"font-face-src":case"font-face-uri":case"font-face-format":case"font-face-name":case"missing-glyph":return!1;default:return!0}}var ve=null;function xe(e){return(e=e.target||e.srcElement||window).correspondingUseElement&&(e=e.correspondingUseElement),3===e.nodeType?e.parentNode:e}var we=null,ke=null,Se=null;function Te(e){if(e=vo(e)){if("function"!=typeof we)throw Error(i(280));var t=e.stateNode;t&&(t=wo(t),we(e.stateNode,e.type,t))}}function Ce(e){ke?Se?Se.push(e):Se=[e]:ke=e}function Ae(){if(ke){var e=ke,t=Se;if(Se=ke=null,Te(e),t)for(e=0;e<t.length;e++)Te(t[e])}}function Ie(e,t){return e(t)}function je(){}var Ee=!1;function Pe(e,t,r){if(Ee)return e(t,r);Ee=!0;try{return Ie(e,t,r)}finally{Ee=!1,(null!==ke||null!==Se)&&(je(),Ae())}}function Re(e,t){var r=e.stateNode;if(null===r)return null;var n=wo(r);if(null===n)return null;r=n[t];e:switch(t){case"onClick":case"onClickCapture":case"onDoubleClick":case"onDoubleClickCapture":case"onMouseDown":case"onMouseDownCapture":case"onMouseMove":case"onMouseMoveCapture":case"onMouseUp":case"onMouseUpCapture":case"onMouseEnter":(n=!n.disabled)||(n=!("button"===(e=e.type)||"input"===e||"select"===e||"textarea"===e)),e=!n;break e;default:e=!1}if(e)return null;if(r&&"function"!=typeof r)throw Error(i(231,t,typeof r));return r}var Oe=!1;if(d)try{var qe={};Object.defineProperty(qe,"passive",{get:function(){Oe=!0}}),window.addEventListener("test",qe,qe),window.removeEventListener("test",qe,qe)}catch(de){Oe=!1}function $e(e,t,r,n,o,i,s,a,c){var p=Array.prototype.slice.call(arguments,3);try{t.apply(r,p)}catch(d){this.onError(d)}}var De=!1,Be=null,Le=!1,Ue=null,Ne={onError:function(e){De=!0,Be=e}};function Fe(e,t,r,n,o,i,s,a,c){De=!1,Be=null,$e.apply(Ne,arguments)}function Me(e){var t=e,r=e;if(e.alternate)for(;t.return;)t=t.return;else{e=t;do{!!(4098&(t=e).flags)&&(r=t.return),e=t.return}while(e)}return 3===t.tag?r:null}function Ge(e){if(13===e.tag){var t=e.memoizedState;if(null===t&&(null!==(e=e.alternate)&&(t=e.memoizedState)),null!==t)return t.dehydrated}return null}function ze(e){if(Me(e)!==e)throw Error(i(188))}function We(e){return null!==(e=function(e){var t=e.alternate;if(!t){if(null===(t=Me(e)))throw Error(i(188));return t!==e?null:e}for(var r=e,n=t;;){var o=r.return;if(null===o)break;var s=o.alternate;if(null===s){if(null!==(n=o.return)){r=n;continue}break}if(o.child===s.child){for(s=o.child;s;){if(s===r)return ze(o),e;if(s===n)return ze(o),t;s=s.sibling}throw Error(i(188))}if(r.return!==n.return)r=o,n=s;else{for(var a=!1,c=o.child;c;){if(c===r){a=!0,r=o,n=s;break}if(c===n){a=!0,n=o,r=s;break}c=c.sibling}if(!a){for(c=s.child;c;){if(c===r){a=!0,r=s,n=o;break}if(c===n){a=!0,n=s,r=o;break}c=c.sibling}if(!a)throw Error(i(189))}}if(r.alternate!==n)throw Error(i(190))}if(3!==r.tag)throw Error(i(188));return r.stateNode.current===r?e:t}(e))?He(e):null}function He(e){if(5===e.tag||6===e.tag)return e;for(e=e.child;null!==e;){var t=He(e);if(null!==t)return t;e=e.sibling}return null}var Ze=o.unstable_scheduleCallback,Ve=o.unstable_cancelCallback,Ke=o.unstable_shouldYield,Ye=o.unstable_requestPaint,Je=o.unstable_now,Xe=o.unstable_getCurrentPriorityLevel,Qe=o.unstable_ImmediatePriority,et=o.unstable_UserBlockingPriority,tt=o.unstable_NormalPriority,rt=o.unstable_LowPriority,nt=o.unstable_IdlePriority,ot=null,it=null;var st=Math.clz32?Math.clz32:function(e){return e>>>=0,0===e?32:31-(at(e)/ct|0)|0},at=Math.log,ct=Math.LN2;var pt=64,dt=4194304;function lt(e){switch(e&-e){case 1:return 1;case 2:return 2;case 4:return 4;case 8:return 8;case 16:return 16;case 32:return 32;case 64:case 128:case 256:case 512:case 1024:case 2048:case 4096:case 8192:case 16384:case 32768:case 65536:case 131072:case 262144:case 524288:case 1048576:case 2097152:return 4194240&e;case 4194304:case 8388608:case 16777216:case 33554432:case 67108864:return 130023424&e;case 134217728:return 134217728;case 268435456:return 268435456;case 536870912:return 536870912;case 1073741824:return 1073741824;default:return e}}function ut(e,t){var r=e.pendingLanes;if(0===r)return 0;var n=0,o=e.suspendedLanes,i=e.pingedLanes,s=268435455&r;if(0!==s){var a=s&~o;0!==a?n=lt(a):0!==(i&=s)&&(n=lt(i))}else 0!==(s=r&~o)?n=lt(s):0!==i&&(n=lt(i));if(0===n)return 0;if(0!==t&&t!==n&&!(t&o)&&((o=n&-n)>=(i=t&-t)||16===o&&4194240&i))return t;if(4&n&&(n|=16&r),0!==(t=e.entangledLanes))for(e=e.entanglements,t&=n;0<t;)o=1<<(r=31-st(t)),n|=e[r],t&=~o;return n}function mt(e,t){switch(e){case 1:case 2:case 4:return t+250;case 8:case 16:case 32:case 64:case 128:case 256:case 512:case 1024:case 2048:case 4096:case 8192:case 16384:case 32768:case 65536:case 131072:case 262144:case 524288:case 1048576:case 2097152:return t+5e3;default:return-1}}function ht(e){return 0!==(e=-1073741825&e.pendingLanes)?e:1073741824&e?1073741824:0}function ft(){var e=pt;return!(4194240&(pt<<=1))&&(pt=64),e}function gt(e){for(var t=[],r=0;31>r;r++)t.push(e);return t}function yt(e,t,r){e.pendingLanes|=t,536870912!==t&&(e.suspendedLanes=0,e.pingedLanes=0),(e=e.eventTimes)[t=31-st(t)]=r}function bt(e,t){var r=e.entangledLanes|=t;for(e=e.entanglements;r;){var n=31-st(r),o=1<<n;o&t|e[n]&t&&(e[n]|=t),r&=~o}}var _t=0;function vt(e){return 1<(e&=-e)?4<e?268435455&e?16:536870912:4:1}var xt,wt,kt,St,Tt,Ct=!1,At=[],It=null,jt=null,Et=null,Pt=new Map,Rt=new Map,Ot=[],qt="mousedown mouseup touchcancel touchend touchstart auxclick dblclick pointercancel pointerdown pointerup dragend dragstart drop compositionend compositionstart keydown keypress keyup input textInput copy cut paste click change contextmenu reset submit".split(" ");function $t(e,t){switch(e){case"focusin":case"focusout":It=null;break;case"dragenter":case"dragleave":jt=null;break;case"mouseover":case"mouseout":Et=null;break;case"pointerover":case"pointerout":Pt.delete(t.pointerId);break;case"gotpointercapture":case"lostpointercapture":Rt.delete(t.pointerId)}}function Dt(e,t,r,n,o,i){return null===e||e.nativeEvent!==i?(e={blockedOn:t,domEventName:r,eventSystemFlags:n,nativeEvent:i,targetContainers:[o]},null!==t&&(null!==(t=vo(t))&&wt(t)),e):(e.eventSystemFlags|=n,t=e.targetContainers,null!==o&&-1===t.indexOf(o)&&t.push(o),e)}function Bt(e){var t=_o(e.target);if(null!==t){var r=Me(t);if(null!==r)if(13===(t=r.tag)){if(null!==(t=Ge(r)))return e.blockedOn=t,void Tt(e.priority,(function(){kt(r)}))}else if(3===t&&r.stateNode.current.memoizedState.isDehydrated)return void(e.blockedOn=3===r.tag?r.stateNode.containerInfo:null)}e.blockedOn=null}function Lt(e){if(null!==e.blockedOn)return!1;for(var t=e.targetContainers;0<t.length;){var r=Kt(e.domEventName,e.eventSystemFlags,t[0],e.nativeEvent);if(null!==r)return null!==(t=vo(r))&&wt(t),e.blockedOn=r,!1;var n=new(r=e.nativeEvent).constructor(r.type,r);ve=n,r.target.dispatchEvent(n),ve=null,t.shift()}return!0}function Ut(e,t,r){Lt(e)&&r.delete(t)}function Nt(){Ct=!1,null!==It&&Lt(It)&&(It=null),null!==jt&&Lt(jt)&&(jt=null),null!==Et&&Lt(Et)&&(Et=null),Pt.forEach(Ut),Rt.forEach(Ut)}function Ft(e,t){e.blockedOn===t&&(e.blockedOn=null,Ct||(Ct=!0,o.unstable_scheduleCallback(o.unstable_NormalPriority,Nt)))}function Mt(e){function t(t){return Ft(t,e)}if(0<At.length){Ft(At[0],e);for(var r=1;r<At.length;r++){var n=At[r];n.blockedOn===e&&(n.blockedOn=null)}}for(null!==It&&Ft(It,e),null!==jt&&Ft(jt,e),null!==Et&&Ft(Et,e),Pt.forEach(t),Rt.forEach(t),r=0;r<Ot.length;r++)(n=Ot[r]).blockedOn===e&&(n.blockedOn=null);for(;0<Ot.length&&null===(r=Ot[0]).blockedOn;)Bt(r),null===r.blockedOn&&Ot.shift()}var Gt=v.ReactCurrentBatchConfig,zt=!0;function Wt(e,t,r,n){var o=_t,i=Gt.transition;Gt.transition=null;try{_t=1,Zt(e,t,r,n)}finally{_t=o,Gt.transition=i}}function Ht(e,t,r,n){var o=_t,i=Gt.transition;Gt.transition=null;try{_t=4,Zt(e,t,r,n)}finally{_t=o,Gt.transition=i}}function Zt(e,t,r,n){if(zt){var o=Kt(e,t,r,n);if(null===o)zn(e,t,n,Vt,r),$t(e,n);else if(function(e,t,r,n,o){switch(t){case"focusin":return It=Dt(It,e,t,r,n,o),!0;case"dragenter":return jt=Dt(jt,e,t,r,n,o),!0;case"mouseover":return Et=Dt(Et,e,t,r,n,o),!0;case"pointerover":var i=o.pointerId;return Pt.set(i,Dt(Pt.get(i)||null,e,t,r,n,o)),!0;case"gotpointercapture":return i=o.pointerId,Rt.set(i,Dt(Rt.get(i)||null,e,t,r,n,o)),!0}return!1}(o,e,t,r,n))n.stopPropagation();else if($t(e,n),4&t&&-1<qt.indexOf(e)){for(;null!==o;){var i=vo(o);if(null!==i&&xt(i),null===(i=Kt(e,t,r,n))&&zn(e,t,n,Vt,r),i===o)break;o=i}null!==o&&n.stopPropagation()}else zn(e,t,n,null,r)}}var Vt=null;function Kt(e,t,r,n){if(Vt=null,null!==(e=_o(e=xe(n))))if(null===(t=Me(e)))e=null;else if(13===(r=t.tag)){if(null!==(e=Ge(t)))return e;e=null}else if(3===r){if(t.stateNode.current.memoizedState.isDehydrated)return 3===t.tag?t.stateNode.containerInfo:null;e=null}else t!==e&&(e=null);return Vt=e,null}function Yt(e){switch(e){case"cancel":case"click":case"close":case"contextmenu":case"copy":case"cut":case"auxclick":case"dblclick":case"dragend":case"dragstart":case"drop":case"focusin":case"focusout":case"input":case"invalid":case"keydown":case"keypress":case"keyup":case"mousedown":case"mouseup":case"paste":case"pause":case"play":case"pointercancel":case"pointerdown":case"pointerup":case"ratechange":case"reset":case"resize":case"seeked":case"submit":case"touchcancel":case"touchend":case"touchstart":case"volumechange":case"change":case"selectionchange":case"textInput":case"compositionstart":case"compositionend":case"compositionupdate":case"beforeblur":case"afterblur":case"beforeinput":case"blur":case"fullscreenchange":case"focus":case"hashchange":case"popstate":case"select":case"selectstart":return 1;case"drag":case"dragenter":case"dragexit":case"dragleave":case"dragover":case"mousemove":case"mouseout":case"mouseover":case"pointermove":case"pointerout":case"pointerover":case"scroll":case"toggle":case"touchmove":case"wheel":case"mouseenter":case"mouseleave":case"pointerenter":case"pointerleave":return 4;case"message":switch(Xe()){case Qe:return 1;case et:return 4;case tt:case rt:return 16;case nt:return 536870912;default:return 16}default:return 16}}var Jt=null,Xt=null,Qt=null;function er(){if(Qt)return Qt;var e,t,r=Xt,n=r.length,o="value"in Jt?Jt.value:Jt.textContent,i=o.length;for(e=0;e<n&&r[e]===o[e];e++);var s=n-e;for(t=1;t<=s&&r[n-t]===o[i-t];t++);return Qt=o.slice(e,1<t?1-t:void 0)}function tr(e){var t=e.keyCode;return"charCode"in e?0===(e=e.charCode)&&13===t&&(e=13):e=t,10===e&&(e=13),32<=e||13===e?e:0}function rr(){return!0}function nr(){return!1}function or(e){function t(t,r,n,o,i){for(var s in this._reactName=t,this._targetInst=n,this.type=r,this.nativeEvent=o,this.target=i,this.currentTarget=null,e)e.hasOwnProperty(s)&&(t=e[s],this[s]=t?t(o):o[s]);return this.isDefaultPrevented=(null!=o.defaultPrevented?o.defaultPrevented:!1===o.returnValue)?rr:nr,this.isPropagationStopped=nr,this}return B(t.prototype,{preventDefault:function(){this.defaultPrevented=!0;var e=this.nativeEvent;e&&(e.preventDefault?e.preventDefault():"unknown"!=typeof e.returnValue&&(e.returnValue=!1),this.isDefaultPrevented=rr)},stopPropagation:function(){var e=this.nativeEvent;e&&(e.stopPropagation?e.stopPropagation():"unknown"!=typeof e.cancelBubble&&(e.cancelBubble=!0),this.isPropagationStopped=rr)},persist:function(){},isPersistent:rr}),t}var ir,sr,ar,cr={eventPhase:0,bubbles:0,cancelable:0,timeStamp:function(e){return e.timeStamp||Date.now()},defaultPrevented:0,isTrusted:0},pr=or(cr),dr=B({},cr,{view:0,detail:0}),lr=or(dr),ur=B({},dr,{screenX:0,screenY:0,clientX:0,clientY:0,pageX:0,pageY:0,ctrlKey:0,shiftKey:0,altKey:0,metaKey:0,getModifierState:Sr,button:0,buttons:0,relatedTarget:function(e){return void 0===e.relatedTarget?e.fromElement===e.srcElement?e.toElement:e.fromElement:e.relatedTarget},movementX:function(e){return"movementX"in e?e.movementX:(e!==ar&&(ar&&"mousemove"===e.type?(ir=e.screenX-ar.screenX,sr=e.screenY-ar.screenY):sr=ir=0,ar=e),ir)},movementY:function(e){return"movementY"in e?e.movementY:sr}}),mr=or(ur),hr=or(B({},ur,{dataTransfer:0})),fr=or(B({},dr,{relatedTarget:0})),gr=or(B({},cr,{animationName:0,elapsedTime:0,pseudoElement:0})),yr=B({},cr,{clipboardData:function(e){return"clipboardData"in e?e.clipboardData:window.clipboardData}}),br=or(yr),_r=or(B({},cr,{data:0})),vr={Esc:"Escape",Spacebar:" ",Left:"ArrowLeft",Up:"ArrowUp",Right:"ArrowRight",Down:"ArrowDown",Del:"Delete",Win:"OS",Menu:"ContextMenu",Apps:"ContextMenu",Scroll:"ScrollLock",MozPrintableKey:"Unidentified"},xr={8:"Backspace",9:"Tab",12:"Clear",13:"Enter",16:"Shift",17:"Control",18:"Alt",19:"Pause",20:"CapsLock",27:"Escape",32:" ",33:"PageUp",34:"PageDown",35:"End",36:"Home",37:"ArrowLeft",38:"ArrowUp",39:"ArrowRight",40:"ArrowDown",45:"Insert",46:"Delete",112:"F1",113:"F2",114:"F3",115:"F4",116:"F5",117:"F6",118:"F7",119:"F8",120:"F9",121:"F10",122:"F11",123:"F12",144:"NumLock",145:"ScrollLock",224:"Meta"},wr={Alt:"altKey",Control:"ctrlKey",Meta:"metaKey",Shift:"shiftKey"};function kr(e){var t=this.nativeEvent;return t.getModifierState?t.getModifierState(e):!!(e=wr[e])&&!!t[e]}function Sr(){return kr}var Tr=B({},dr,{key:function(e){if(e.key){var t=vr[e.key]||e.key;if("Unidentified"!==t)return t}return"keypress"===e.type?13===(e=tr(e))?"Enter":String.fromCharCode(e):"keydown"===e.type||"keyup"===e.type?xr[e.keyCode]||"Unidentified":""},code:0,location:0,ctrlKey:0,shiftKey:0,altKey:0,metaKey:0,repeat:0,locale:0,getModifierState:Sr,charCode:function(e){return"keypress"===e.type?tr(e):0},keyCode:function(e){return"keydown"===e.type||"keyup"===e.type?e.keyCode:0},which:function(e){return"keypress"===e.type?tr(e):"keydown"===e.type||"keyup"===e.type?e.keyCode:0}}),Cr=or(Tr),Ar=or(B({},ur,{pointerId:0,width:0,height:0,pressure:0,tangentialPressure:0,tiltX:0,tiltY:0,twist:0,pointerType:0,isPrimary:0})),Ir=or(B({},dr,{touches:0,targetTouches:0,changedTouches:0,altKey:0,metaKey:0,ctrlKey:0,shiftKey:0,getModifierState:Sr})),jr=or(B({},cr,{propertyName:0,elapsedTime:0,pseudoElement:0})),Er=B({},ur,{deltaX:function(e){return"deltaX"in e?e.deltaX:"wheelDeltaX"in e?-e.wheelDeltaX:0},deltaY:function(e){return"deltaY"in e?e.deltaY:"wheelDeltaY"in e?-e.wheelDeltaY:"wheelDelta"in e?-e.wheelDelta:0},deltaZ:0,deltaMode:0}),Pr=or(Er),Rr=[9,13,27,32],Or=d&&"CompositionEvent"in window,qr=null;d&&"documentMode"in document&&(qr=document.documentMode);var $r=d&&"TextEvent"in window&&!qr,Dr=d&&(!Or||qr&&8<qr&&11>=qr),Br=String.fromCharCode(32),Lr=!1;function Ur(e,t){switch(e){case"keyup":return-1!==Rr.indexOf(t.keyCode);case"keydown":return 229!==t.keyCode;case"keypress":case"mousedown":case"focusout":return!0;default:return!1}}function Nr(e){return"object"==typeof(e=e.detail)&&"data"in e?e.data:null}var Fr=!1;var Mr={color:!0,date:!0,datetime:!0,"datetime-local":!0,email:!0,month:!0,number:!0,password:!0,range:!0,search:!0,tel:!0,text:!0,time:!0,url:!0,week:!0};function Gr(e){var t=e&&e.nodeName&&e.nodeName.toLowerCase();return"input"===t?!!Mr[e.type]:"textarea"===t}function zr(e,t,r,n){Ce(n),0<(t=Hn(t,"onChange")).length&&(r=new pr("onChange","change",null,r,n),e.push({event:r,listeners:t}))}var Wr=null,Hr=null;function Zr(e){Ln(e,0)}function Vr(e){if(Z(xo(e)))return e}function Kr(e,t){if("change"===e)return t}var Yr=!1;if(d){var Jr;if(d){var Xr="oninput"in document;if(!Xr){var Qr=document.createElement("div");Qr.setAttribute("oninput","return;"),Xr="function"==typeof Qr.oninput}Jr=Xr}else Jr=!1;Yr=Jr&&(!document.documentMode||9<document.documentMode)}function en(){Wr&&(Wr.detachEvent("onpropertychange",tn),Hr=Wr=null)}function tn(e){if("value"===e.propertyName&&Vr(Hr)){var t=[];zr(t,Hr,e,xe(e)),Pe(Zr,t)}}function rn(e,t,r){"focusin"===e?(en(),Hr=r,(Wr=t).attachEvent("onpropertychange",tn)):"focusout"===e&&en()}function nn(e){if("selectionchange"===e||"keyup"===e||"keydown"===e)return Vr(Hr)}function on(e,t){if("click"===e)return Vr(t)}function sn(e,t){if("input"===e||"change"===e)return Vr(t)}var an="function"==typeof Object.is?Object.is:function(e,t){return e===t&&(0!==e||1/e==1/t)||e!=e&&t!=t};function cn(e,t){if(an(e,t))return!0;if("object"!=typeof e||null===e||"object"!=typeof t||null===t)return!1;var r=Object.keys(e),n=Object.keys(t);if(r.length!==n.length)return!1;for(n=0;n<r.length;n++){var o=r[n];if(!l.call(t,o)||!an(e[o],t[o]))return!1}return!0}function pn(e){for(;e&&e.firstChild;)e=e.firstChild;return e}function dn(e,t){var r,n=pn(e);for(e=0;n;){if(3===n.nodeType){if(r=e+n.textContent.length,e<=t&&r>=t)return{node:n,offset:t-e};e=r}e:{for(;n;){if(n.nextSibling){n=n.nextSibling;break e}n=n.parentNode}n=void 0}n=pn(n)}}function ln(e,t){return!(!e||!t)&&(e===t||(!e||3!==e.nodeType)&&(t&&3===t.nodeType?ln(e,t.parentNode):"contains"in e?e.contains(t):!!e.compareDocumentPosition&&!!(16&e.compareDocumentPosition(t))))}function un(){for(var e=window,t=V();t instanceof e.HTMLIFrameElement;){try{var r="string"==typeof t.contentWindow.location.href}catch(n){r=!1}if(!r)break;t=V((e=t.contentWindow).document)}return t}function mn(e){var t=e&&e.nodeName&&e.nodeName.toLowerCase();return t&&("input"===t&&("text"===e.type||"search"===e.type||"tel"===e.type||"url"===e.type||"password"===e.type)||"textarea"===t||"true"===e.contentEditable)}function hn(e){var t=un(),r=e.focusedElem,n=e.selectionRange;if(t!==r&&r&&r.ownerDocument&&ln(r.ownerDocument.documentElement,r)){if(null!==n&&mn(r))if(t=n.start,void 0===(e=n.end)&&(e=t),"selectionStart"in r)r.selectionStart=t,r.selectionEnd=Math.min(e,r.value.length);else if((e=(t=r.ownerDocument||document)&&t.defaultView||window).getSelection){e=e.getSelection();var o=r.textContent.length,i=Math.min(n.start,o);n=void 0===n.end?i:Math.min(n.end,o),!e.extend&&i>n&&(o=n,n=i,i=o),o=dn(r,i);var s=dn(r,n);o&&s&&(1!==e.rangeCount||e.anchorNode!==o.node||e.anchorOffset!==o.offset||e.focusNode!==s.node||e.focusOffset!==s.offset)&&((t=t.createRange()).setStart(o.node,o.offset),e.removeAllRanges(),i>n?(e.addRange(t),e.extend(s.node,s.offset)):(t.setEnd(s.node,s.offset),e.addRange(t)))}for(t=[],e=r;e=e.parentNode;)1===e.nodeType&&t.push({element:e,left:e.scrollLeft,top:e.scrollTop});for("function"==typeof r.focus&&r.focus(),r=0;r<t.length;r++)(e=t[r]).element.scrollLeft=e.left,e.element.scrollTop=e.top}}var fn=d&&"documentMode"in document&&11>=document.documentMode,gn=null,yn=null,bn=null,_n=!1;function vn(e,t,r){var n=r.window===r?r.document:9===r.nodeType?r:r.ownerDocument;_n||null==gn||gn!==V(n)||("selectionStart"in(n=gn)&&mn(n)?n={start:n.selectionStart,end:n.selectionEnd}:n={anchorNode:(n=(n.ownerDocument&&n.ownerDocument.defaultView||window).getSelection()).anchorNode,anchorOffset:n.anchorOffset,focusNode:n.focusNode,focusOffset:n.focusOffset},bn&&cn(bn,n)||(bn=n,0<(n=Hn(yn,"onSelect")).length&&(t=new pr("onSelect","select",null,t,r),e.push({event:t,listeners:n}),t.target=gn)))}function xn(e,t){var r={};return r[e.toLowerCase()]=t.toLowerCase(),r["Webkit"+e]="webkit"+t,r["Moz"+e]="moz"+t,r}var wn={animationend:xn("Animation","AnimationEnd"),animationiteration:xn("Animation","AnimationIteration"),animationstart:xn("Animation","AnimationStart"),transitionend:xn("Transition","TransitionEnd")},kn={},Sn={};function Tn(e){if(kn[e])return kn[e];if(!wn[e])return e;var t,r=wn[e];for(t in r)if(r.hasOwnProperty(t)&&t in Sn)return kn[e]=r[t];return e}d&&(Sn=document.createElement("div").style,"AnimationEvent"in window||(delete wn.animationend.animation,delete wn.animationiteration.animation,delete wn.animationstart.animation),"TransitionEvent"in window||delete wn.transitionend.transition);var Cn=Tn("animationend"),An=Tn("animationiteration"),In=Tn("animationstart"),jn=Tn("transitionend"),En=new Map,Pn="abort auxClick cancel canPlay canPlayThrough click close contextMenu copy cut drag dragEnd dragEnter dragExit dragLeave dragOver dragStart drop durationChange emptied encrypted ended error gotPointerCapture input invalid keyDown keyPress keyUp load loadedData loadedMetadata loadStart lostPointerCapture mouseDown mouseMove mouseOut mouseOver mouseUp paste pause play playing pointerCancel pointerDown pointerMove pointerOut pointerOver pointerUp progress rateChange reset resize seeked seeking stalled submit suspend timeUpdate touchCancel touchEnd touchStart volumeChange scroll toggle touchMove waiting wheel".split(" ");function Rn(e,t){En.set(e,t),c(t,[e])}for(var On=0;On<Pn.length;On++){var qn=Pn[On];Rn(qn.toLowerCase(),"on"+(qn[0].toUpperCase()+qn.slice(1)))}Rn(Cn,"onAnimationEnd"),Rn(An,"onAnimationIteration"),Rn(In,"onAnimationStart"),Rn("dblclick","onDoubleClick"),Rn("focusin","onFocus"),Rn("focusout","onBlur"),Rn(jn,"onTransitionEnd"),p("onMouseEnter",["mouseout","mouseover"]),p("onMouseLeave",["mouseout","mouseover"]),p("onPointerEnter",["pointerout","pointerover"]),p("onPointerLeave",["pointerout","pointerover"]),c("onChange","change click focusin focusout input keydown keyup selectionchange".split(" ")),c("onSelect","focusout contextmenu dragend focusin keydown keyup mousedown mouseup selectionchange".split(" ")),c("onBeforeInput",["compositionend","keypress","textInput","paste"]),c("onCompositionEnd","compositionend focusout keydown keypress keyup mousedown".split(" ")),c("onCompositionStart","compositionstart focusout keydown keypress keyup mousedown".split(" ")),c("onCompositionUpdate","compositionupdate focusout keydown keypress keyup mousedown".split(" "));var $n="abort canplay canplaythrough durationchange emptied encrypted ended error loadeddata loadedmetadata loadstart pause play playing progress ratechange resize seeked seeking stalled suspend timeupdate volumechange waiting".split(" "),Dn=new Set("cancel close invalid load scroll toggle".split(" ").concat($n));function Bn(e,t,r){var n=e.type||"unknown-event";e.currentTarget=r,function(e,t,r,n,o,s,a,c,p){if(Fe.apply(this,arguments),De){if(!De)throw Error(i(198));var d=Be;De=!1,Be=null,Le||(Le=!0,Ue=d)}}(n,t,void 0,e),e.currentTarget=null}function Ln(e,t){t=!!(4&t);for(var r=0;r<e.length;r++){var n=e[r],o=n.event;n=n.listeners;e:{var i=void 0;if(t)for(var s=n.length-1;0<=s;s--){var a=n[s],c=a.instance,p=a.currentTarget;if(a=a.listener,c!==i&&o.isPropagationStopped())break e;Bn(o,a,p),i=c}else for(s=0;s<n.length;s++){if(c=(a=n[s]).instance,p=a.currentTarget,a=a.listener,c!==i&&o.isPropagationStopped())break e;Bn(o,a,p),i=c}}}if(Le)throw e=Ue,Le=!1,Ue=null,e}function Un(e,t){var r=t[go];void 0===r&&(r=t[go]=new Set);var n=e+"__bubble";r.has(n)||(Gn(t,e,2,!1),r.add(n))}function Nn(e,t,r){var n=0;t&&(n|=4),Gn(r,e,n,t)}var Fn="_reactListening"+Math.random().toString(36).slice(2);function Mn(e){if(!e[Fn]){e[Fn]=!0,s.forEach((function(t){"selectionchange"!==t&&(Dn.has(t)||Nn(t,!1,e),Nn(t,!0,e))}));var t=9===e.nodeType?e:e.ownerDocument;null===t||t[Fn]||(t[Fn]=!0,Nn("selectionchange",!1,t))}}function Gn(e,t,r,n){switch(Yt(t)){case 1:var o=Wt;break;case 4:o=Ht;break;default:o=Zt}r=o.bind(null,t,r,e),o=void 0,!Oe||"touchstart"!==t&&"touchmove"!==t&&"wheel"!==t||(o=!0),n?void 0!==o?e.addEventListener(t,r,{capture:!0,passive:o}):e.addEventListener(t,r,!0):void 0!==o?e.addEventListener(t,r,{passive:o}):e.addEventListener(t,r,!1)}function zn(e,t,r,n,o){var i=n;if(!(1&t||2&t||null===n))e:for(;;){if(null===n)return;var s=n.tag;if(3===s||4===s){var a=n.stateNode.containerInfo;if(a===o||8===a.nodeType&&a.parentNode===o)break;if(4===s)for(s=n.return;null!==s;){var c=s.tag;if((3===c||4===c)&&((c=s.stateNode.containerInfo)===o||8===c.nodeType&&c.parentNode===o))return;s=s.return}for(;null!==a;){if(null===(s=_o(a)))return;if(5===(c=s.tag)||6===c){n=i=s;continue e}a=a.parentNode}}n=n.return}Pe((function(){var n=i,o=xe(r),s=[];e:{var a=En.get(e);if(void 0!==a){var c=pr,p=e;switch(e){case"keypress":if(0===tr(r))break e;case"keydown":case"keyup":c=Cr;break;case"focusin":p="focus",c=fr;break;case"focusout":p="blur",c=fr;break;case"beforeblur":case"afterblur":c=fr;break;case"click":if(2===r.button)break e;case"auxclick":case"dblclick":case"mousedown":case"mousemove":case"mouseup":case"mouseout":case"mouseover":case"contextmenu":c=mr;break;case"drag":case"dragend":case"dragenter":case"dragexit":case"dragleave":case"dragover":case"dragstart":case"drop":c=hr;break;case"touchcancel":case"touchend":case"touchmove":case"touchstart":c=Ir;break;case Cn:case An:case In:c=gr;break;case jn:c=jr;break;case"scroll":c=lr;break;case"wheel":c=Pr;break;case"copy":case"cut":case"paste":c=br;break;case"gotpointercapture":case"lostpointercapture":case"pointercancel":case"pointerdown":case"pointermove":case"pointerout":case"pointerover":case"pointerup":c=Ar}var d=!!(4&t),l=!d&&"scroll"===e,u=d?null!==a?a+"Capture":null:a;d=[];for(var m,h=n;null!==h;){var f=(m=h).stateNode;if(5===m.tag&&null!==f&&(m=f,null!==u&&(null!=(f=Re(h,u))&&d.push(Wn(h,f,m)))),l)break;h=h.return}0<d.length&&(a=new c(a,p,null,r,o),s.push({event:a,listeners:d}))}}if(!(7&t)){if(c="mouseout"===e||"pointerout"===e,(!(a="mouseover"===e||"pointerover"===e)||r===ve||!(p=r.relatedTarget||r.fromElement)||!_o(p)&&!p[fo])&&(c||a)&&(a=o.window===o?o:(a=o.ownerDocument)?a.defaultView||a.parentWindow:window,c?(c=n,null!==(p=(p=r.relatedTarget||r.toElement)?_o(p):null)&&(p!==(l=Me(p))||5!==p.tag&&6!==p.tag)&&(p=null)):(c=null,p=n),c!==p)){if(d=mr,f="onMouseLeave",u="onMouseEnter",h="mouse","pointerout"!==e&&"pointerover"!==e||(d=Ar,f="onPointerLeave",u="onPointerEnter",h="pointer"),l=null==c?a:xo(c),m=null==p?a:xo(p),(a=new d(f,h+"leave",c,r,o)).target=l,a.relatedTarget=m,f=null,_o(o)===n&&((d=new d(u,h+"enter",p,r,o)).target=m,d.relatedTarget=l,f=d),l=f,c&&p)e:{for(u=p,h=0,m=d=c;m;m=Zn(m))h++;for(m=0,f=u;f;f=Zn(f))m++;for(;0<h-m;)d=Zn(d),h--;for(;0<m-h;)u=Zn(u),m--;for(;h--;){if(d===u||null!==u&&d===u.alternate)break e;d=Zn(d),u=Zn(u)}d=null}else d=null;null!==c&&Vn(s,a,c,d,!1),null!==p&&null!==l&&Vn(s,l,p,d,!0)}if("select"===(c=(a=n?xo(n):window).nodeName&&a.nodeName.toLowerCase())||"input"===c&&"file"===a.type)var g=Kr;else if(Gr(a))if(Yr)g=sn;else{g=nn;var y=rn}else(c=a.nodeName)&&"input"===c.toLowerCase()&&("checkbox"===a.type||"radio"===a.type)&&(g=on);switch(g&&(g=g(e,n))?zr(s,g,r,o):(y&&y(e,a,n),"focusout"===e&&(y=a._wrapperState)&&y.controlled&&"number"===a.type&&ee(a,"number",a.value)),y=n?xo(n):window,e){case"focusin":(Gr(y)||"true"===y.contentEditable)&&(gn=y,yn=n,bn=null);break;case"focusout":bn=yn=gn=null;break;case"mousedown":_n=!0;break;case"contextmenu":case"mouseup":case"dragend":_n=!1,vn(s,r,o);break;case"selectionchange":if(fn)break;case"keydown":case"keyup":vn(s,r,o)}var b;if(Or)e:{switch(e){case"compositionstart":var _="onCompositionStart";break e;case"compositionend":_="onCompositionEnd";break e;case"compositionupdate":_="onCompositionUpdate";break e}_=void 0}else Fr?Ur(e,r)&&(_="onCompositionEnd"):"keydown"===e&&229===r.keyCode&&(_="onCompositionStart");_&&(Dr&&"ko"!==r.locale&&(Fr||"onCompositionStart"!==_?"onCompositionEnd"===_&&Fr&&(b=er()):(Xt="value"in(Jt=o)?Jt.value:Jt.textContent,Fr=!0)),0<(y=Hn(n,_)).length&&(_=new _r(_,e,null,r,o),s.push({event:_,listeners:y}),b?_.data=b:null!==(b=Nr(r))&&(_.data=b))),(b=$r?function(e,t){switch(e){case"compositionend":return Nr(t);case"keypress":return 32!==t.which?null:(Lr=!0,Br);case"textInput":return(e=t.data)===Br&&Lr?null:e;default:return null}}(e,r):function(e,t){if(Fr)return"compositionend"===e||!Or&&Ur(e,t)?(e=er(),Qt=Xt=Jt=null,Fr=!1,e):null;switch(e){case"paste":default:return null;case"keypress":if(!(t.ctrlKey||t.altKey||t.metaKey)||t.ctrlKey&&t.altKey){if(t.char&&1<t.char.length)return t.char;if(t.which)return String.fromCharCode(t.which)}return null;case"compositionend":return Dr&&"ko"!==t.locale?null:t.data}}(e,r))&&(0<(n=Hn(n,"onBeforeInput")).length&&(o=new _r("onBeforeInput","beforeinput",null,r,o),s.push({event:o,listeners:n}),o.data=b))}Ln(s,t)}))}function Wn(e,t,r){return{instance:e,listener:t,currentTarget:r}}function Hn(e,t){for(var r=t+"Capture",n=[];null!==e;){var o=e,i=o.stateNode;5===o.tag&&null!==i&&(o=i,null!=(i=Re(e,r))&&n.unshift(Wn(e,i,o)),null!=(i=Re(e,t))&&n.push(Wn(e,i,o))),e=e.return}return n}function Zn(e){if(null===e)return null;do{e=e.return}while(e&&5!==e.tag);return e||null}function Vn(e,t,r,n,o){for(var i=t._reactName,s=[];null!==r&&r!==n;){var a=r,c=a.alternate,p=a.stateNode;if(null!==c&&c===n)break;5===a.tag&&null!==p&&(a=p,o?null!=(c=Re(r,i))&&s.unshift(Wn(r,c,a)):o||null!=(c=Re(r,i))&&s.push(Wn(r,c,a))),r=r.return}0!==s.length&&e.push({event:t,listeners:s})}var Kn=/\r\n?/g,Yn=/\u0000|\uFFFD/g;function Jn(e){return("string"==typeof e?e:""+e).replace(Kn,"\n").replace(Yn,"")}function Xn(e,t,r){if(t=Jn(t),Jn(e)!==t&&r)throw Error(i(425))}function Qn(){}var eo=null,to=null;function ro(e,t){return"textarea"===e||"noscript"===e||"string"==typeof t.children||"number"==typeof t.children||"object"==typeof t.dangerouslySetInnerHTML&&null!==t.dangerouslySetInnerHTML&&null!=t.dangerouslySetInnerHTML.__html}var no="function"==typeof setTimeout?setTimeout:void 0,oo="function"==typeof clearTimeout?clearTimeout:void 0,io="function"==typeof Promise?Promise:void 0,so="function"==typeof queueMicrotask?queueMicrotask:void 0!==io?function(e){return io.resolve(null).then(e).catch(ao)}:no;function ao(e){setTimeout((function(){throw e}))}function co(e,t){var r=t,n=0;do{var o=r.nextSibling;if(e.removeChild(r),o&&8===o.nodeType)if("/$"===(r=o.data)){if(0===n)return e.removeChild(o),void Mt(t);n--}else"$"!==r&&"$?"!==r&&"$!"!==r||n++;r=o}while(r);Mt(t)}function po(e){for(;null!=e;e=e.nextSibling){var t=e.nodeType;if(1===t||3===t)break;if(8===t){if("$"===(t=e.data)||"$!"===t||"$?"===t)break;if("/$"===t)return null}}return e}function lo(e){e=e.previousSibling;for(var t=0;e;){if(8===e.nodeType){var r=e.data;if("$"===r||"$!"===r||"$?"===r){if(0===t)return e;t--}else"/$"===r&&t++}e=e.previousSibling}return null}var uo=Math.random().toString(36).slice(2),mo="__reactFiber$"+uo,ho="__reactProps$"+uo,fo="__reactContainer$"+uo,go="__reactEvents$"+uo,yo="__reactListeners$"+uo,bo="__reactHandles$"+uo;function _o(e){var t=e[mo];if(t)return t;for(var r=e.parentNode;r;){if(t=r[fo]||r[mo]){if(r=t.alternate,null!==t.child||null!==r&&null!==r.child)for(e=lo(e);null!==e;){if(r=e[mo])return r;e=lo(e)}return t}r=(e=r).parentNode}return null}function vo(e){return!(e=e[mo]||e[fo])||5!==e.tag&&6!==e.tag&&13!==e.tag&&3!==e.tag?null:e}function xo(e){if(5===e.tag||6===e.tag)return e.stateNode;throw Error(i(33))}function wo(e){return e[ho]||null}var ko=[],So=-1;function To(e){return{current:e}}function Co(e){0>So||(e.current=ko[So],ko[So]=null,So--)}function Ao(e,t){So++,ko[So]=e.current,e.current=t}var Io={},jo=To(Io),Eo=To(!1),Po=Io;function Ro(e,t){var r=e.type.contextTypes;if(!r)return Io;var n=e.stateNode;if(n&&n.__reactInternalMemoizedUnmaskedChildContext===t)return n.__reactInternalMemoizedMaskedChildContext;var o,i={};for(o in r)i[o]=t[o];return n&&((e=e.stateNode).__reactInternalMemoizedUnmaskedChildContext=t,e.__reactInternalMemoizedMaskedChildContext=i),i}function Oo(e){return null!=(e=e.childContextTypes)}function qo(){Co(Eo),Co(jo)}function $o(e,t,r){if(jo.current!==Io)throw Error(i(168));Ao(jo,t),Ao(Eo,r)}function Do(e,t,r){var n=e.stateNode;if(t=t.childContextTypes,"function"!=typeof n.getChildContext)return r;for(var o in n=n.getChildContext())if(!(o in t))throw Error(i(108,G(e)||"Unknown",o));return B({},r,n)}function Bo(e){return e=(e=e.stateNode)&&e.__reactInternalMemoizedMergedChildContext||Io,Po=jo.current,Ao(jo,e),Ao(Eo,Eo.current),!0}function Lo(e,t,r){var n=e.stateNode;if(!n)throw Error(i(169));r?(e=Do(e,t,Po),n.__reactInternalMemoizedMergedChildContext=e,Co(Eo),Co(jo),Ao(jo,e)):Co(Eo),Ao(Eo,r)}var Uo=null,No=!1,Fo=!1;function Mo(e){null===Uo?Uo=[e]:Uo.push(e)}function Go(){if(!Fo&&null!==Uo){Fo=!0;var e=0,t=_t;try{var r=Uo;for(_t=1;e<r.length;e++){var n=r[e];do{n=n(!0)}while(null!==n)}Uo=null,No=!1}catch(o){throw null!==Uo&&(Uo=Uo.slice(e+1)),Ze(Qe,Go),o}finally{_t=t,Fo=!1}}return null}var zo=[],Wo=0,Ho=null,Zo=0,Vo=[],Ko=0,Yo=null,Jo=1,Xo="";function Qo(e,t){zo[Wo++]=Zo,zo[Wo++]=Ho,Ho=e,Zo=t}function ei(e,t,r){Vo[Ko++]=Jo,Vo[Ko++]=Xo,Vo[Ko++]=Yo,Yo=e;var n=Jo;e=Xo;var o=32-st(n)-1;n&=~(1<<o),r+=1;var i=32-st(t)+o;if(30<i){var s=o-o%5;i=(n&(1<<s)-1).toString(32),n>>=s,o-=s,Jo=1<<32-st(t)+o|r<<o|n,Xo=i+e}else Jo=1<<i|r<<o|n,Xo=e}function ti(e){null!==e.return&&(Qo(e,1),ei(e,1,0))}function ri(e){for(;e===Ho;)Ho=zo[--Wo],zo[Wo]=null,Zo=zo[--Wo],zo[Wo]=null;for(;e===Yo;)Yo=Vo[--Ko],Vo[Ko]=null,Xo=Vo[--Ko],Vo[Ko]=null,Jo=Vo[--Ko],Vo[Ko]=null}var ni=null,oi=null,ii=!1,si=null;function ai(e,t){var r=Pp(5,null,null,0);r.elementType="DELETED",r.stateNode=t,r.return=e,null===(t=e.deletions)?(e.deletions=[r],e.flags|=16):t.push(r)}function ci(e,t){switch(e.tag){case 5:var r=e.type;return null!==(t=1!==t.nodeType||r.toLowerCase()!==t.nodeName.toLowerCase()?null:t)&&(e.stateNode=t,ni=e,oi=po(t.firstChild),!0);case 6:return null!==(t=""===e.pendingProps||3!==t.nodeType?null:t)&&(e.stateNode=t,ni=e,oi=null,!0);case 13:return null!==(t=8!==t.nodeType?null:t)&&(r=null!==Yo?{id:Jo,overflow:Xo}:null,e.memoizedState={dehydrated:t,treeContext:r,retryLane:1073741824},(r=Pp(18,null,null,0)).stateNode=t,r.return=e,e.child=r,ni=e,oi=null,!0);default:return!1}}function pi(e){return!(!(1&e.mode)||128&e.flags)}function di(e){if(ii){var t=oi;if(t){var r=t;if(!ci(e,t)){if(pi(e))throw Error(i(418));t=po(r.nextSibling);var n=ni;t&&ci(e,t)?ai(n,r):(e.flags=-4097&e.flags|2,ii=!1,ni=e)}}else{if(pi(e))throw Error(i(418));e.flags=-4097&e.flags|2,ii=!1,ni=e}}}function li(e){for(e=e.return;null!==e&&5!==e.tag&&3!==e.tag&&13!==e.tag;)e=e.return;ni=e}function ui(e){if(e!==ni)return!1;if(!ii)return li(e),ii=!0,!1;var t;if((t=3!==e.tag)&&!(t=5!==e.tag)&&(t="head"!==(t=e.type)&&"body"!==t&&!ro(e.type,e.memoizedProps)),t&&(t=oi)){if(pi(e))throw mi(),Error(i(418));for(;t;)ai(e,t),t=po(t.nextSibling)}if(li(e),13===e.tag){if(!(e=null!==(e=e.memoizedState)?e.dehydrated:null))throw Error(i(317));e:{for(e=e.nextSibling,t=0;e;){if(8===e.nodeType){var r=e.data;if("/$"===r){if(0===t){oi=po(e.nextSibling);break e}t--}else"$"!==r&&"$!"!==r&&"$?"!==r||t++}e=e.nextSibling}oi=null}}else oi=ni?po(e.stateNode.nextSibling):null;return!0}function mi(){for(var e=oi;e;)e=po(e.nextSibling)}function hi(){oi=ni=null,ii=!1}function fi(e){null===si?si=[e]:si.push(e)}var gi=v.ReactCurrentBatchConfig;function yi(e,t,r){if(null!==(e=r.ref)&&"function"!=typeof e&&"object"!=typeof e){if(r._owner){if(r=r._owner){if(1!==r.tag)throw Error(i(309));var n=r.stateNode}if(!n)throw Error(i(147,e));var o=n,s=""+e;return null!==t&&null!==t.ref&&"function"==typeof t.ref&&t.ref._stringRef===s?t.ref:(t=function(e){var t=o.refs;null===e?delete t[s]:t[s]=e},t._stringRef=s,t)}if("string"!=typeof e)throw Error(i(284));if(!r._owner)throw Error(i(290,e))}return e}function bi(e,t){throw e=Object.prototype.toString.call(t),Error(i(31,"[object Object]"===e?"object with keys {"+Object.keys(t).join(", ")+"}":e))}function _i(e){return(0,e._init)(e._payload)}function vi(e){function t(t,r){if(e){var n=t.deletions;null===n?(t.deletions=[r],t.flags|=16):n.push(r)}}function r(r,n){if(!e)return null;for(;null!==n;)t(r,n),n=n.sibling;return null}function n(e,t){for(e=new Map;null!==t;)null!==t.key?e.set(t.key,t):e.set(t.index,t),t=t.sibling;return e}function o(e,t){return(e=Op(e,t)).index=0,e.sibling=null,e}function s(t,r,n){return t.index=n,e?null!==(n=t.alternate)?(n=n.index)<r?(t.flags|=2,r):n:(t.flags|=2,r):(t.flags|=1048576,r)}function a(t){return e&&null===t.alternate&&(t.flags|=2),t}function c(e,t,r,n){return null===t||6!==t.tag?((t=Bp(r,e.mode,n)).return=e,t):((t=o(t,r)).return=e,t)}function p(e,t,r,n){var i=r.type;return i===k?l(e,t,r.props.children,n,r.key):null!==t&&(t.elementType===i||"object"==typeof i&&null!==i&&i.$$typeof===R&&_i(i)===t.type)?((n=o(t,r.props)).ref=yi(e,t,r),n.return=e,n):((n=qp(r.type,r.key,r.props,null,e.mode,n)).ref=yi(e,t,r),n.return=e,n)}function d(e,t,r,n){return null===t||4!==t.tag||t.stateNode.containerInfo!==r.containerInfo||t.stateNode.implementation!==r.implementation?((t=Lp(r,e.mode,n)).return=e,t):((t=o(t,r.children||[])).return=e,t)}function l(e,t,r,n,i){return null===t||7!==t.tag?((t=$p(r,e.mode,n,i)).return=e,t):((t=o(t,r)).return=e,t)}function u(e,t,r){if("string"==typeof t&&""!==t||"number"==typeof t)return(t=Bp(""+t,e.mode,r)).return=e,t;if("object"==typeof t&&null!==t){switch(t.$$typeof){case x:return(r=qp(t.type,t.key,t.props,null,e.mode,r)).ref=yi(e,null,t),r.return=e,r;case w:return(t=Lp(t,e.mode,r)).return=e,t;case R:return u(e,(0,t._init)(t._payload),r)}if(te(t)||$(t))return(t=$p(t,e.mode,r,null)).return=e,t;bi(e,t)}return null}function m(e,t,r,n){var o=null!==t?t.key:null;if("string"==typeof r&&""!==r||"number"==typeof r)return null!==o?null:c(e,t,""+r,n);if("object"==typeof r&&null!==r){switch(r.$$typeof){case x:return r.key===o?p(e,t,r,n):null;case w:return r.key===o?d(e,t,r,n):null;case R:return m(e,t,(o=r._init)(r._payload),n)}if(te(r)||$(r))return null!==o?null:l(e,t,r,n,null);bi(e,r)}return null}function h(e,t,r,n,o){if("string"==typeof n&&""!==n||"number"==typeof n)return c(t,e=e.get(r)||null,""+n,o);if("object"==typeof n&&null!==n){switch(n.$$typeof){case x:return p(t,e=e.get(null===n.key?r:n.key)||null,n,o);case w:return d(t,e=e.get(null===n.key?r:n.key)||null,n,o);case R:return h(e,t,r,(0,n._init)(n._payload),o)}if(te(n)||$(n))return l(t,e=e.get(r)||null,n,o,null);bi(t,n)}return null}function f(o,i,a,c){for(var p=null,d=null,l=i,f=i=0,g=null;null!==l&&f<a.length;f++){l.index>f?(g=l,l=null):g=l.sibling;var y=m(o,l,a[f],c);if(null===y){null===l&&(l=g);break}e&&l&&null===y.alternate&&t(o,l),i=s(y,i,f),null===d?p=y:d.sibling=y,d=y,l=g}if(f===a.length)return r(o,l),ii&&Qo(o,f),p;if(null===l){for(;f<a.length;f++)null!==(l=u(o,a[f],c))&&(i=s(l,i,f),null===d?p=l:d.sibling=l,d=l);return ii&&Qo(o,f),p}for(l=n(o,l);f<a.length;f++)null!==(g=h(l,o,f,a[f],c))&&(e&&null!==g.alternate&&l.delete(null===g.key?f:g.key),i=s(g,i,f),null===d?p=g:d.sibling=g,d=g);return e&&l.forEach((function(e){return t(o,e)})),ii&&Qo(o,f),p}function g(o,a,c,p){var d=$(c);if("function"!=typeof d)throw Error(i(150));if(null==(c=d.call(c)))throw Error(i(151));for(var l=d=null,f=a,g=a=0,y=null,b=c.next();null!==f&&!b.done;g++,b=c.next()){f.index>g?(y=f,f=null):y=f.sibling;var _=m(o,f,b.value,p);if(null===_){null===f&&(f=y);break}e&&f&&null===_.alternate&&t(o,f),a=s(_,a,g),null===l?d=_:l.sibling=_,l=_,f=y}if(b.done)return r(o,f),ii&&Qo(o,g),d;if(null===f){for(;!b.done;g++,b=c.next())null!==(b=u(o,b.value,p))&&(a=s(b,a,g),null===l?d=b:l.sibling=b,l=b);return ii&&Qo(o,g),d}for(f=n(o,f);!b.done;g++,b=c.next())null!==(b=h(f,o,g,b.value,p))&&(e&&null!==b.alternate&&f.delete(null===b.key?g:b.key),a=s(b,a,g),null===l?d=b:l.sibling=b,l=b);return e&&f.forEach((function(e){return t(o,e)})),ii&&Qo(o,g),d}return function e(n,i,s,c){if("object"==typeof s&&null!==s&&s.type===k&&null===s.key&&(s=s.props.children),"object"==typeof s&&null!==s){switch(s.$$typeof){case x:e:{for(var p=s.key,d=i;null!==d;){if(d.key===p){if((p=s.type)===k){if(7===d.tag){r(n,d.sibling),(i=o(d,s.props.children)).return=n,n=i;break e}}else if(d.elementType===p||"object"==typeof p&&null!==p&&p.$$typeof===R&&_i(p)===d.type){r(n,d.sibling),(i=o(d,s.props)).ref=yi(n,d,s),i.return=n,n=i;break e}r(n,d);break}t(n,d),d=d.sibling}s.type===k?((i=$p(s.props.children,n.mode,c,s.key)).return=n,n=i):((c=qp(s.type,s.key,s.props,null,n.mode,c)).ref=yi(n,i,s),c.return=n,n=c)}return a(n);case w:e:{for(d=s.key;null!==i;){if(i.key===d){if(4===i.tag&&i.stateNode.containerInfo===s.containerInfo&&i.stateNode.implementation===s.implementation){r(n,i.sibling),(i=o(i,s.children||[])).return=n,n=i;break e}r(n,i);break}t(n,i),i=i.sibling}(i=Lp(s,n.mode,c)).return=n,n=i}return a(n);case R:return e(n,i,(d=s._init)(s._payload),c)}if(te(s))return f(n,i,s,c);if($(s))return g(n,i,s,c);bi(n,s)}return"string"==typeof s&&""!==s||"number"==typeof s?(s=""+s,null!==i&&6===i.tag?(r(n,i.sibling),(i=o(i,s)).return=n,n=i):(r(n,i),(i=Bp(s,n.mode,c)).return=n,n=i),a(n)):r(n,i)}}var xi=vi(!0),wi=vi(!1),ki=To(null),Si=null,Ti=null,Ci=null;function Ai(){Ci=Ti=Si=null}function Ii(e){var t=ki.current;Co(ki),e._currentValue=t}function ji(e,t,r){for(;null!==e;){var n=e.alternate;if((e.childLanes&t)!==t?(e.childLanes|=t,null!==n&&(n.childLanes|=t)):null!==n&&(n.childLanes&t)!==t&&(n.childLanes|=t),e===r)break;e=e.return}}function Ei(e,t){Si=e,Ci=Ti=null,null!==(e=e.dependencies)&&null!==e.firstContext&&(!!(e.lanes&t)&&(_a=!0),e.firstContext=null)}function Pi(e){var t=e._currentValue;if(Ci!==e)if(e={context:e,memoizedValue:t,next:null},null===Ti){if(null===Si)throw Error(i(308));Ti=e,Si.dependencies={lanes:0,firstContext:e}}else Ti=Ti.next=e;return t}var Ri=null;function Oi(e){null===Ri?Ri=[e]:Ri.push(e)}function qi(e,t,r,n){var o=t.interleaved;return null===o?(r.next=r,Oi(t)):(r.next=o.next,o.next=r),t.interleaved=r,$i(e,n)}function $i(e,t){e.lanes|=t;var r=e.alternate;for(null!==r&&(r.lanes|=t),r=e,e=e.return;null!==e;)e.childLanes|=t,null!==(r=e.alternate)&&(r.childLanes|=t),r=e,e=e.return;return 3===r.tag?r.stateNode:null}var Di=!1;function Bi(e){e.updateQueue={baseState:e.memoizedState,firstBaseUpdate:null,lastBaseUpdate:null,shared:{pending:null,interleaved:null,lanes:0},effects:null}}function Li(e,t){e=e.updateQueue,t.updateQueue===e&&(t.updateQueue={baseState:e.baseState,firstBaseUpdate:e.firstBaseUpdate,lastBaseUpdate:e.lastBaseUpdate,shared:e.shared,effects:e.effects})}function Ui(e,t){return{eventTime:e,lane:t,tag:0,payload:null,callback:null,next:null}}function Ni(e,t,r){var n=e.updateQueue;if(null===n)return null;if(n=n.shared,2&Ic){var o=n.pending;return null===o?t.next=t:(t.next=o.next,o.next=t),n.pending=t,$i(e,r)}return null===(o=n.interleaved)?(t.next=t,Oi(n)):(t.next=o.next,o.next=t),n.interleaved=t,$i(e,r)}function Fi(e,t,r){if(null!==(t=t.updateQueue)&&(t=t.shared,4194240&r)){var n=t.lanes;r|=n&=e.pendingLanes,t.lanes=r,bt(e,r)}}function Mi(e,t){var r=e.updateQueue,n=e.alternate;if(null!==n&&r===(n=n.updateQueue)){var o=null,i=null;if(null!==(r=r.firstBaseUpdate)){do{var s={eventTime:r.eventTime,lane:r.lane,tag:r.tag,payload:r.payload,callback:r.callback,next:null};null===i?o=i=s:i=i.next=s,r=r.next}while(null!==r);null===i?o=i=t:i=i.next=t}else o=i=t;return r={baseState:n.baseState,firstBaseUpdate:o,lastBaseUpdate:i,shared:n.shared,effects:n.effects},void(e.updateQueue=r)}null===(e=r.lastBaseUpdate)?r.firstBaseUpdate=t:e.next=t,r.lastBaseUpdate=t}function Gi(e,t,r,n){var o=e.updateQueue;Di=!1;var i=o.firstBaseUpdate,s=o.lastBaseUpdate,a=o.shared.pending;if(null!==a){o.shared.pending=null;var c=a,p=c.next;c.next=null,null===s?i=p:s.next=p,s=c;var d=e.alternate;null!==d&&((a=(d=d.updateQueue).lastBaseUpdate)!==s&&(null===a?d.firstBaseUpdate=p:a.next=p,d.lastBaseUpdate=c))}if(null!==i){var l=o.baseState;for(s=0,d=p=c=null,a=i;;){var u=a.lane,m=a.eventTime;if((n&u)===u){null!==d&&(d=d.next={eventTime:m,lane:0,tag:a.tag,payload:a.payload,callback:a.callback,next:null});e:{var h=e,f=a;switch(u=t,m=r,f.tag){case 1:if("function"==typeof(h=f.payload)){l=h.call(m,l,u);break e}l=h;break e;case 3:h.flags=-65537&h.flags|128;case 0:if(null==(u="function"==typeof(h=f.payload)?h.call(m,l,u):h))break e;l=B({},l,u);break e;case 2:Di=!0}}null!==a.callback&&0!==a.lane&&(e.flags|=64,null===(u=o.effects)?o.effects=[a]:u.push(a))}else m={eventTime:m,lane:u,tag:a.tag,payload:a.payload,callback:a.callback,next:null},null===d?(p=d=m,c=l):d=d.next=m,s|=u;if(null===(a=a.next)){if(null===(a=o.shared.pending))break;a=(u=a).next,u.next=null,o.lastBaseUpdate=u,o.shared.pending=null}}if(null===d&&(c=l),o.baseState=c,o.firstBaseUpdate=p,o.lastBaseUpdate=d,null!==(t=o.shared.interleaved)){o=t;do{s|=o.lane,o=o.next}while(o!==t)}else null===i&&(o.shared.lanes=0);Dc|=s,e.lanes=s,e.memoizedState=l}}function zi(e,t,r){if(e=t.effects,t.effects=null,null!==e)for(t=0;t<e.length;t++){var n=e[t],o=n.callback;if(null!==o){if(n.callback=null,n=r,"function"!=typeof o)throw Error(i(191,o));o.call(n)}}}var Wi={},Hi=To(Wi),Zi=To(Wi),Vi=To(Wi);function Ki(e){if(e===Wi)throw Error(i(174));return e}function Yi(e,t){switch(Ao(Vi,t),Ao(Zi,e),Ao(Hi,Wi),e=t.nodeType){case 9:case 11:t=(t=t.documentElement)?t.namespaceURI:ce(null,"");break;default:t=ce(t=(e=8===e?t.parentNode:t).namespaceURI||null,e=e.tagName)}Co(Hi),Ao(Hi,t)}function Ji(){Co(Hi),Co(Zi),Co(Vi)}function Xi(e){Ki(Vi.current);var t=Ki(Hi.current),r=ce(t,e.type);t!==r&&(Ao(Zi,e),Ao(Hi,r))}function Qi(e){Zi.current===e&&(Co(Hi),Co(Zi))}var es=To(0);function ts(e){for(var t=e;null!==t;){if(13===t.tag){var r=t.memoizedState;if(null!==r&&(null===(r=r.dehydrated)||"$?"===r.data||"$!"===r.data))return t}else if(19===t.tag&&void 0!==t.memoizedProps.revealOrder){if(128&t.flags)return t}else if(null!==t.child){t.child.return=t,t=t.child;continue}if(t===e)break;for(;null===t.sibling;){if(null===t.return||t.return===e)return null;t=t.return}t.sibling.return=t.return,t=t.sibling}return null}var rs=[];function ns(){for(var e=0;e<rs.length;e++)rs[e]._workInProgressVersionPrimary=null;rs.length=0}var os=v.ReactCurrentDispatcher,is=v.ReactCurrentBatchConfig,ss=0,as=null,cs=null,ps=null,ds=!1,ls=!1,us=0,ms=0;function hs(){throw Error(i(321))}function fs(e,t){if(null===t)return!1;for(var r=0;r<t.length&&r<e.length;r++)if(!an(e[r],t[r]))return!1;return!0}function gs(e,t,r,n,o,s){if(ss=s,as=t,t.memoizedState=null,t.updateQueue=null,t.lanes=0,os.current=null===e||null===e.memoizedState?Qs:ea,e=r(n,o),ls){s=0;do{if(ls=!1,us=0,25<=s)throw Error(i(301));s+=1,ps=cs=null,t.updateQueue=null,os.current=ta,e=r(n,o)}while(ls)}if(os.current=Xs,t=null!==cs&&null!==cs.next,ss=0,ps=cs=as=null,ds=!1,t)throw Error(i(300));return e}function ys(){var e=0!==us;return us=0,e}function bs(){var e={memoizedState:null,baseState:null,baseQueue:null,queue:null,next:null};return null===ps?as.memoizedState=ps=e:ps=ps.next=e,ps}function _s(){if(null===cs){var e=as.alternate;e=null!==e?e.memoizedState:null}else e=cs.next;var t=null===ps?as.memoizedState:ps.next;if(null!==t)ps=t,cs=e;else{if(null===e)throw Error(i(310));e={memoizedState:(cs=e).memoizedState,baseState:cs.baseState,baseQueue:cs.baseQueue,queue:cs.queue,next:null},null===ps?as.memoizedState=ps=e:ps=ps.next=e}return ps}function vs(e,t){return"function"==typeof t?t(e):t}function xs(e){var t=_s(),r=t.queue;if(null===r)throw Error(i(311));r.lastRenderedReducer=e;var n=cs,o=n.baseQueue,s=r.pending;if(null!==s){if(null!==o){var a=o.next;o.next=s.next,s.next=a}n.baseQueue=o=s,r.pending=null}if(null!==o){s=o.next,n=n.baseState;var c=a=null,p=null,d=s;do{var l=d.lane;if((ss&l)===l)null!==p&&(p=p.next={lane:0,action:d.action,hasEagerState:d.hasEagerState,eagerState:d.eagerState,next:null}),n=d.hasEagerState?d.eagerState:e(n,d.action);else{var u={lane:l,action:d.action,hasEagerState:d.hasEagerState,eagerState:d.eagerState,next:null};null===p?(c=p=u,a=n):p=p.next=u,as.lanes|=l,Dc|=l}d=d.next}while(null!==d&&d!==s);null===p?a=n:p.next=c,an(n,t.memoizedState)||(_a=!0),t.memoizedState=n,t.baseState=a,t.baseQueue=p,r.lastRenderedState=n}if(null!==(e=r.interleaved)){o=e;do{s=o.lane,as.lanes|=s,Dc|=s,o=o.next}while(o!==e)}else null===o&&(r.lanes=0);return[t.memoizedState,r.dispatch]}function ws(e){var t=_s(),r=t.queue;if(null===r)throw Error(i(311));r.lastRenderedReducer=e;var n=r.dispatch,o=r.pending,s=t.memoizedState;if(null!==o){r.pending=null;var a=o=o.next;do{s=e(s,a.action),a=a.next}while(a!==o);an(s,t.memoizedState)||(_a=!0),t.memoizedState=s,null===t.baseQueue&&(t.baseState=s),r.lastRenderedState=s}return[s,n]}function ks(){}function Ss(e,t){var r=as,n=_s(),o=t(),s=!an(n.memoizedState,o);if(s&&(n.memoizedState=o,_a=!0),n=n.queue,Ds(As.bind(null,r,n,e),[e]),n.getSnapshot!==t||s||null!==ps&&1&ps.memoizedState.tag){if(r.flags|=2048,Ps(9,Cs.bind(null,r,n,o,t),void 0,null),null===jc)throw Error(i(349));30&ss||Ts(r,t,o)}return o}function Ts(e,t,r){e.flags|=16384,e={getSnapshot:t,value:r},null===(t=as.updateQueue)?(t={lastEffect:null,stores:null},as.updateQueue=t,t.stores=[e]):null===(r=t.stores)?t.stores=[e]:r.push(e)}function Cs(e,t,r,n){t.value=r,t.getSnapshot=n,Is(t)&&js(e)}function As(e,t,r){return r((function(){Is(t)&&js(e)}))}function Is(e){var t=e.getSnapshot;e=e.value;try{var r=t();return!an(e,r)}catch(n){return!0}}function js(e){var t=$i(e,1);null!==t&&rp(t,e,1,-1)}function Es(e){var t=bs();return"function"==typeof e&&(e=e()),t.memoizedState=t.baseState=e,e={pending:null,interleaved:null,lanes:0,dispatch:null,lastRenderedReducer:vs,lastRenderedState:e},t.queue=e,e=e.dispatch=Vs.bind(null,as,e),[t.memoizedState,e]}function Ps(e,t,r,n){return e={tag:e,create:t,destroy:r,deps:n,next:null},null===(t=as.updateQueue)?(t={lastEffect:null,stores:null},as.updateQueue=t,t.lastEffect=e.next=e):null===(r=t.lastEffect)?t.lastEffect=e.next=e:(n=r.next,r.next=e,e.next=n,t.lastEffect=e),e}function Rs(){return _s().memoizedState}function Os(e,t,r,n){var o=bs();as.flags|=e,o.memoizedState=Ps(1|t,r,void 0,void 0===n?null:n)}function qs(e,t,r,n){var o=_s();n=void 0===n?null:n;var i=void 0;if(null!==cs){var s=cs.memoizedState;if(i=s.destroy,null!==n&&fs(n,s.deps))return void(o.memoizedState=Ps(t,r,i,n))}as.flags|=e,o.memoizedState=Ps(1|t,r,i,n)}function $s(e,t){return Os(8390656,8,e,t)}function Ds(e,t){return qs(2048,8,e,t)}function Bs(e,t){return qs(4,2,e,t)}function Ls(e,t){return qs(4,4,e,t)}function Us(e,t){return"function"==typeof t?(e=e(),t(e),function(){t(null)}):null!=t?(e=e(),t.current=e,function(){t.current=null}):void 0}function Ns(e,t,r){return r=null!=r?r.concat([e]):null,qs(4,4,Us.bind(null,t,e),r)}function Fs(){}function Ms(e,t){var r=_s();t=void 0===t?null:t;var n=r.memoizedState;return null!==n&&null!==t&&fs(t,n[1])?n[0]:(r.memoizedState=[e,t],e)}function Gs(e,t){var r=_s();t=void 0===t?null:t;var n=r.memoizedState;return null!==n&&null!==t&&fs(t,n[1])?n[0]:(e=e(),r.memoizedState=[e,t],e)}function zs(e,t,r){return 21&ss?(an(r,t)||(r=ft(),as.lanes|=r,Dc|=r,e.baseState=!0),t):(e.baseState&&(e.baseState=!1,_a=!0),e.memoizedState=r)}function Ws(e,t){var r=_t;_t=0!==r&&4>r?r:4,e(!0);var n=is.transition;is.transition={};try{e(!1),t()}finally{_t=r,is.transition=n}}function Hs(){return _s().memoizedState}function Zs(e,t,r){var n=tp(e);if(r={lane:n,action:r,hasEagerState:!1,eagerState:null,next:null},Ks(e))Ys(t,r);else if(null!==(r=qi(e,t,r,n))){rp(r,e,n,ep()),Js(r,t,n)}}function Vs(e,t,r){var n=tp(e),o={lane:n,action:r,hasEagerState:!1,eagerState:null,next:null};if(Ks(e))Ys(t,o);else{var i=e.alternate;if(0===e.lanes&&(null===i||0===i.lanes)&&null!==(i=t.lastRenderedReducer))try{var s=t.lastRenderedState,a=i(s,r);if(o.hasEagerState=!0,o.eagerState=a,an(a,s)){var c=t.interleaved;return null===c?(o.next=o,Oi(t)):(o.next=c.next,c.next=o),void(t.interleaved=o)}}catch(p){}null!==(r=qi(e,t,o,n))&&(rp(r,e,n,o=ep()),Js(r,t,n))}}function Ks(e){var t=e.alternate;return e===as||null!==t&&t===as}function Ys(e,t){ls=ds=!0;var r=e.pending;null===r?t.next=t:(t.next=r.next,r.next=t),e.pending=t}function Js(e,t,r){if(4194240&r){var n=t.lanes;r|=n&=e.pendingLanes,t.lanes=r,bt(e,r)}}var Xs={readContext:Pi,useCallback:hs,useContext:hs,useEffect:hs,useImperativeHandle:hs,useInsertionEffect:hs,useLayoutEffect:hs,useMemo:hs,useReducer:hs,useRef:hs,useState:hs,useDebugValue:hs,useDeferredValue:hs,useTransition:hs,useMutableSource:hs,useSyncExternalStore:hs,useId:hs,unstable_isNewReconciler:!1},Qs={readContext:Pi,useCallback:function(e,t){return bs().memoizedState=[e,void 0===t?null:t],e},useContext:Pi,useEffect:$s,useImperativeHandle:function(e,t,r){return r=null!=r?r.concat([e]):null,Os(4194308,4,Us.bind(null,t,e),r)},useLayoutEffect:function(e,t){return Os(4194308,4,e,t)},useInsertionEffect:function(e,t){return Os(4,2,e,t)},useMemo:function(e,t){var r=bs();return t=void 0===t?null:t,e=e(),r.memoizedState=[e,t],e},useReducer:function(e,t,r){var n=bs();return t=void 0!==r?r(t):t,n.memoizedState=n.baseState=t,e={pending:null,interleaved:null,lanes:0,dispatch:null,lastRenderedReducer:e,lastRenderedState:t},n.queue=e,e=e.dispatch=Zs.bind(null,as,e),[n.memoizedState,e]},useRef:function(e){return e={current:e},bs().memoizedState=e},useState:Es,useDebugValue:Fs,useDeferredValue:function(e){return bs().memoizedState=e},useTransition:function(){var e=Es(!1),t=e[0];return e=Ws.bind(null,e[1]),bs().memoizedState=e,[t,e]},useMutableSource:function(){},useSyncExternalStore:function(e,t,r){var n=as,o=bs();if(ii){if(void 0===r)throw Error(i(407));r=r()}else{if(r=t(),null===jc)throw Error(i(349));30&ss||Ts(n,t,r)}o.memoizedState=r;var s={value:r,getSnapshot:t};return o.queue=s,$s(As.bind(null,n,s,e),[e]),n.flags|=2048,Ps(9,Cs.bind(null,n,s,r,t),void 0,null),r},useId:function(){var e=bs(),t=jc.identifierPrefix;if(ii){var r=Xo;t=":"+t+"R"+(r=(Jo&~(1<<32-st(Jo)-1)).toString(32)+r),0<(r=us++)&&(t+="H"+r.toString(32)),t+=":"}else t=":"+t+"r"+(r=ms++).toString(32)+":";return e.memoizedState=t},unstable_isNewReconciler:!1},ea={readContext:Pi,useCallback:Ms,useContext:Pi,useEffect:Ds,useImperativeHandle:Ns,useInsertionEffect:Bs,useLayoutEffect:Ls,useMemo:Gs,useReducer:xs,useRef:Rs,useState:function(){return xs(vs)},useDebugValue:Fs,useDeferredValue:function(e){return zs(_s(),cs.memoizedState,e)},useTransition:function(){return[xs(vs)[0],_s().memoizedState]},useMutableSource:ks,useSyncExternalStore:Ss,useId:Hs,unstable_isNewReconciler:!1},ta={readContext:Pi,useCallback:Ms,useContext:Pi,useEffect:Ds,useImperativeHandle:Ns,useInsertionEffect:Bs,useLayoutEffect:Ls,useMemo:Gs,useReducer:ws,useRef:Rs,useState:function(){return ws(vs)},useDebugValue:Fs,useDeferredValue:function(e){var t=_s();return null===cs?t.memoizedState=e:zs(t,cs.memoizedState,e)},useTransition:function(){return[ws(vs)[0],_s().memoizedState]},useMutableSource:ks,useSyncExternalStore:Ss,useId:Hs,unstable_isNewReconciler:!1};function ra(e,t){if(e&&e.defaultProps){for(var r in t=B({},t),e=e.defaultProps)void 0===t[r]&&(t[r]=e[r]);return t}return t}function na(e,t,r,n){r=null==(r=r(n,t=e.memoizedState))?t:B({},t,r),e.memoizedState=r,0===e.lanes&&(e.updateQueue.baseState=r)}var oa={isMounted:function(e){return!!(e=e._reactInternals)&&Me(e)===e},enqueueSetState:function(e,t,r){e=e._reactInternals;var n=ep(),o=tp(e),i=Ui(n,o);i.payload=t,null!=r&&(i.callback=r),null!==(t=Ni(e,i,o))&&(rp(t,e,o,n),Fi(t,e,o))},enqueueReplaceState:function(e,t,r){e=e._reactInternals;var n=ep(),o=tp(e),i=Ui(n,o);i.tag=1,i.payload=t,null!=r&&(i.callback=r),null!==(t=Ni(e,i,o))&&(rp(t,e,o,n),Fi(t,e,o))},enqueueForceUpdate:function(e,t){e=e._reactInternals;var r=ep(),n=tp(e),o=Ui(r,n);o.tag=2,null!=t&&(o.callback=t),null!==(t=Ni(e,o,n))&&(rp(t,e,n,r),Fi(t,e,n))}};function ia(e,t,r,n,o,i,s){return"function"==typeof(e=e.stateNode).shouldComponentUpdate?e.shouldComponentUpdate(n,i,s):!t.prototype||!t.prototype.isPureReactComponent||(!cn(r,n)||!cn(o,i))}function sa(e,t,r){var n=!1,o=Io,i=t.contextType;return"object"==typeof i&&null!==i?i=Pi(i):(o=Oo(t)?Po:jo.current,i=(n=null!=(n=t.contextTypes))?Ro(e,o):Io),t=new t(r,i),e.memoizedState=null!==t.state&&void 0!==t.state?t.state:null,t.updater=oa,e.stateNode=t,t._reactInternals=e,n&&((e=e.stateNode).__reactInternalMemoizedUnmaskedChildContext=o,e.__reactInternalMemoizedMaskedChildContext=i),t}function aa(e,t,r,n){e=t.state,"function"==typeof t.componentWillReceiveProps&&t.componentWillReceiveProps(r,n),"function"==typeof t.UNSAFE_componentWillReceiveProps&&t.UNSAFE_componentWillReceiveProps(r,n),t.state!==e&&oa.enqueueReplaceState(t,t.state,null)}function ca(e,t,r,n){var o=e.stateNode;o.props=r,o.state=e.memoizedState,o.refs={},Bi(e);var i=t.contextType;"object"==typeof i&&null!==i?o.context=Pi(i):(i=Oo(t)?Po:jo.current,o.context=Ro(e,i)),o.state=e.memoizedState,"function"==typeof(i=t.getDerivedStateFromProps)&&(na(e,t,i,r),o.state=e.memoizedState),"function"==typeof t.getDerivedStateFromProps||"function"==typeof o.getSnapshotBeforeUpdate||"function"!=typeof o.UNSAFE_componentWillMount&&"function"!=typeof o.componentWillMount||(t=o.state,"function"==typeof o.componentWillMount&&o.componentWillMount(),"function"==typeof o.UNSAFE_componentWillMount&&o.UNSAFE_componentWillMount(),t!==o.state&&oa.enqueueReplaceState(o,o.state,null),Gi(e,r,o,n),o.state=e.memoizedState),"function"==typeof o.componentDidMount&&(e.flags|=4194308)}function pa(e,t){try{var r="",n=t;do{r+=F(n),n=n.return}while(n);var o=r}catch(i){o="\nError generating stack: "+i.message+"\n"+i.stack}return{value:e,source:t,stack:o,digest:null}}function da(e,t,r){return{value:e,source:null,stack:null!=r?r:null,digest:null!=t?t:null}}function la(e,t){try{console.error(t.value)}catch(r){setTimeout((function(){throw r}))}}var ua="function"==typeof WeakMap?WeakMap:Map;function ma(e,t,r){(r=Ui(-1,r)).tag=3,r.payload={element:null};var n=t.value;return r.callback=function(){zc||(zc=!0,Wc=n),la(0,t)},r}function ha(e,t,r){(r=Ui(-1,r)).tag=3;var n=e.type.getDerivedStateFromError;if("function"==typeof n){var o=t.value;r.payload=function(){return n(o)},r.callback=function(){la(0,t)}}var i=e.stateNode;return null!==i&&"function"==typeof i.componentDidCatch&&(r.callback=function(){la(0,t),"function"!=typeof n&&(null===Hc?Hc=new Set([this]):Hc.add(this));var e=t.stack;this.componentDidCatch(t.value,{componentStack:null!==e?e:""})}),r}function fa(e,t,r){var n=e.pingCache;if(null===n){n=e.pingCache=new ua;var o=new Set;n.set(t,o)}else void 0===(o=n.get(t))&&(o=new Set,n.set(t,o));o.has(r)||(o.add(r),e=Tp.bind(null,e,t,r),t.then(e,e))}function ga(e){do{var t;if((t=13===e.tag)&&(t=null===(t=e.memoizedState)||null!==t.dehydrated),t)return e;e=e.return}while(null!==e);return null}function ya(e,t,r,n,o){return 1&e.mode?(e.flags|=65536,e.lanes=o,e):(e===t?e.flags|=65536:(e.flags|=128,r.flags|=131072,r.flags&=-52805,1===r.tag&&(null===r.alternate?r.tag=17:((t=Ui(-1,1)).tag=2,Ni(r,t,1))),r.lanes|=1),e)}var ba=v.ReactCurrentOwner,_a=!1;function va(e,t,r,n){t.child=null===e?wi(t,null,r,n):xi(t,e.child,r,n)}function xa(e,t,r,n,o){r=r.render;var i=t.ref;return Ei(t,o),n=gs(e,t,r,n,i,o),r=ys(),null===e||_a?(ii&&r&&ti(t),t.flags|=1,va(e,t,n,o),t.child):(t.updateQueue=e.updateQueue,t.flags&=-2053,e.lanes&=~o,za(e,t,o))}function wa(e,t,r,n,o){if(null===e){var i=r.type;return"function"!=typeof i||Rp(i)||void 0!==i.defaultProps||null!==r.compare||void 0!==r.defaultProps?((e=qp(r.type,null,n,t,t.mode,o)).ref=t.ref,e.return=t,t.child=e):(t.tag=15,t.type=i,ka(e,t,i,n,o))}if(i=e.child,!(e.lanes&o)){var s=i.memoizedProps;if((r=null!==(r=r.compare)?r:cn)(s,n)&&e.ref===t.ref)return za(e,t,o)}return t.flags|=1,(e=Op(i,n)).ref=t.ref,e.return=t,t.child=e}function ka(e,t,r,n,o){if(null!==e){var i=e.memoizedProps;if(cn(i,n)&&e.ref===t.ref){if(_a=!1,t.pendingProps=n=i,!(e.lanes&o))return t.lanes=e.lanes,za(e,t,o);131072&e.flags&&(_a=!0)}}return Ca(e,t,r,n,o)}function Sa(e,t,r){var n=t.pendingProps,o=n.children,i=null!==e?e.memoizedState:null;if("hidden"===n.mode)if(1&t.mode){if(!(1073741824&r))return e=null!==i?i.baseLanes|r:r,t.lanes=t.childLanes=1073741824,t.memoizedState={baseLanes:e,cachePool:null,transitions:null},t.updateQueue=null,Ao(Oc,Rc),Rc|=e,null;t.memoizedState={baseLanes:0,cachePool:null,transitions:null},n=null!==i?i.baseLanes:r,Ao(Oc,Rc),Rc|=n}else t.memoizedState={baseLanes:0,cachePool:null,transitions:null},Ao(Oc,Rc),Rc|=r;else null!==i?(n=i.baseLanes|r,t.memoizedState=null):n=r,Ao(Oc,Rc),Rc|=n;return va(e,t,o,r),t.child}function Ta(e,t){var r=t.ref;(null===e&&null!==r||null!==e&&e.ref!==r)&&(t.flags|=512,t.flags|=2097152)}function Ca(e,t,r,n,o){var i=Oo(r)?Po:jo.current;return i=Ro(t,i),Ei(t,o),r=gs(e,t,r,n,i,o),n=ys(),null===e||_a?(ii&&n&&ti(t),t.flags|=1,va(e,t,r,o),t.child):(t.updateQueue=e.updateQueue,t.flags&=-2053,e.lanes&=~o,za(e,t,o))}function Aa(e,t,r,n,o){if(Oo(r)){var i=!0;Bo(t)}else i=!1;if(Ei(t,o),null===t.stateNode)Ga(e,t),sa(t,r,n),ca(t,r,n,o),n=!0;else if(null===e){var s=t.stateNode,a=t.memoizedProps;s.props=a;var c=s.context,p=r.contextType;"object"==typeof p&&null!==p?p=Pi(p):p=Ro(t,p=Oo(r)?Po:jo.current);var d=r.getDerivedStateFromProps,l="function"==typeof d||"function"==typeof s.getSnapshotBeforeUpdate;l||"function"!=typeof s.UNSAFE_componentWillReceiveProps&&"function"!=typeof s.componentWillReceiveProps||(a!==n||c!==p)&&aa(t,s,n,p),Di=!1;var u=t.memoizedState;s.state=u,Gi(t,n,s,o),c=t.memoizedState,a!==n||u!==c||Eo.current||Di?("function"==typeof d&&(na(t,r,d,n),c=t.memoizedState),(a=Di||ia(t,r,a,n,u,c,p))?(l||"function"!=typeof s.UNSAFE_componentWillMount&&"function"!=typeof s.componentWillMount||("function"==typeof s.componentWillMount&&s.componentWillMount(),"function"==typeof s.UNSAFE_componentWillMount&&s.UNSAFE_componentWillMount()),"function"==typeof s.componentDidMount&&(t.flags|=4194308)):("function"==typeof s.componentDidMount&&(t.flags|=4194308),t.memoizedProps=n,t.memoizedState=c),s.props=n,s.state=c,s.context=p,n=a):("function"==typeof s.componentDidMount&&(t.flags|=4194308),n=!1)}else{s=t.stateNode,Li(e,t),a=t.memoizedProps,p=t.type===t.elementType?a:ra(t.type,a),s.props=p,l=t.pendingProps,u=s.context,"object"==typeof(c=r.contextType)&&null!==c?c=Pi(c):c=Ro(t,c=Oo(r)?Po:jo.current);var m=r.getDerivedStateFromProps;(d="function"==typeof m||"function"==typeof s.getSnapshotBeforeUpdate)||"function"!=typeof s.UNSAFE_componentWillReceiveProps&&"function"!=typeof s.componentWillReceiveProps||(a!==l||u!==c)&&aa(t,s,n,c),Di=!1,u=t.memoizedState,s.state=u,Gi(t,n,s,o);var h=t.memoizedState;a!==l||u!==h||Eo.current||Di?("function"==typeof m&&(na(t,r,m,n),h=t.memoizedState),(p=Di||ia(t,r,p,n,u,h,c)||!1)?(d||"function"!=typeof s.UNSAFE_componentWillUpdate&&"function"!=typeof s.componentWillUpdate||("function"==typeof s.componentWillUpdate&&s.componentWillUpdate(n,h,c),"function"==typeof s.UNSAFE_componentWillUpdate&&s.UNSAFE_componentWillUpdate(n,h,c)),"function"==typeof s.componentDidUpdate&&(t.flags|=4),"function"==typeof s.getSnapshotBeforeUpdate&&(t.flags|=1024)):("function"!=typeof s.componentDidUpdate||a===e.memoizedProps&&u===e.memoizedState||(t.flags|=4),"function"!=typeof s.getSnapshotBeforeUpdate||a===e.memoizedProps&&u===e.memoizedState||(t.flags|=1024),t.memoizedProps=n,t.memoizedState=h),s.props=n,s.state=h,s.context=c,n=p):("function"!=typeof s.componentDidUpdate||a===e.memoizedProps&&u===e.memoizedState||(t.flags|=4),"function"!=typeof s.getSnapshotBeforeUpdate||a===e.memoizedProps&&u===e.memoizedState||(t.flags|=1024),n=!1)}return Ia(e,t,r,n,i,o)}function Ia(e,t,r,n,o,i){Ta(e,t);var s=!!(128&t.flags);if(!n&&!s)return o&&Lo(t,r,!1),za(e,t,i);n=t.stateNode,ba.current=t;var a=s&&"function"!=typeof r.getDerivedStateFromError?null:n.render();return t.flags|=1,null!==e&&s?(t.child=xi(t,e.child,null,i),t.child=xi(t,null,a,i)):va(e,t,a,i),t.memoizedState=n.state,o&&Lo(t,r,!0),t.child}function ja(e){var t=e.stateNode;t.pendingContext?$o(0,t.pendingContext,t.pendingContext!==t.context):t.context&&$o(0,t.context,!1),Yi(e,t.containerInfo)}function Ea(e,t,r,n,o){return hi(),fi(o),t.flags|=256,va(e,t,r,n),t.child}var Pa,Ra,Oa,qa,$a={dehydrated:null,treeContext:null,retryLane:0};function Da(e){return{baseLanes:e,cachePool:null,transitions:null}}function Ba(e,t,r){var n,o=t.pendingProps,s=es.current,a=!1,c=!!(128&t.flags);if((n=c)||(n=(null===e||null!==e.memoizedState)&&!!(2&s)),n?(a=!0,t.flags&=-129):null!==e&&null===e.memoizedState||(s|=1),Ao(es,1&s),null===e)return di(t),null!==(e=t.memoizedState)&&null!==(e=e.dehydrated)?(1&t.mode?"$!"===e.data?t.lanes=8:t.lanes=1073741824:t.lanes=1,null):(c=o.children,e=o.fallback,a?(o=t.mode,a=t.child,c={mode:"hidden",children:c},1&o||null===a?a=Dp(c,o,0,null):(a.childLanes=0,a.pendingProps=c),e=$p(e,o,r,null),a.return=t,e.return=t,a.sibling=e,t.child=a,t.child.memoizedState=Da(r),t.memoizedState=$a,e):La(t,c));if(null!==(s=e.memoizedState)&&null!==(n=s.dehydrated))return function(e,t,r,n,o,s,a){if(r)return 256&t.flags?(t.flags&=-257,Ua(e,t,a,n=da(Error(i(422))))):null!==t.memoizedState?(t.child=e.child,t.flags|=128,null):(s=n.fallback,o=t.mode,n=Dp({mode:"visible",children:n.children},o,0,null),(s=$p(s,o,a,null)).flags|=2,n.return=t,s.return=t,n.sibling=s,t.child=n,1&t.mode&&xi(t,e.child,null,a),t.child.memoizedState=Da(a),t.memoizedState=$a,s);if(!(1&t.mode))return Ua(e,t,a,null);if("$!"===o.data){if(n=o.nextSibling&&o.nextSibling.dataset)var c=n.dgst;return n=c,Ua(e,t,a,n=da(s=Error(i(419)),n,void 0))}if(c=!!(a&e.childLanes),_a||c){if(null!==(n=jc)){switch(a&-a){case 4:o=2;break;case 16:o=8;break;case 64:case 128:case 256:case 512:case 1024:case 2048:case 4096:case 8192:case 16384:case 32768:case 65536:case 131072:case 262144:case 524288:case 1048576:case 2097152:case 4194304:case 8388608:case 16777216:case 33554432:case 67108864:o=32;break;case 536870912:o=268435456;break;default:o=0}0!==(o=o&(n.suspendedLanes|a)?0:o)&&o!==s.retryLane&&(s.retryLane=o,$i(e,o),rp(n,e,o,-1))}return fp(),Ua(e,t,a,n=da(Error(i(421))))}return"$?"===o.data?(t.flags|=128,t.child=e.child,t=Ap.bind(null,e),o._reactRetry=t,null):(e=s.treeContext,oi=po(o.nextSibling),ni=t,ii=!0,si=null,null!==e&&(Vo[Ko++]=Jo,Vo[Ko++]=Xo,Vo[Ko++]=Yo,Jo=e.id,Xo=e.overflow,Yo=t),t=La(t,n.children),t.flags|=4096,t)}(e,t,c,o,n,s,r);if(a){a=o.fallback,c=t.mode,n=(s=e.child).sibling;var p={mode:"hidden",children:o.children};return 1&c||t.child===s?(o=Op(s,p)).subtreeFlags=14680064&s.subtreeFlags:((o=t.child).childLanes=0,o.pendingProps=p,t.deletions=null),null!==n?a=Op(n,a):(a=$p(a,c,r,null)).flags|=2,a.return=t,o.return=t,o.sibling=a,t.child=o,o=a,a=t.child,c=null===(c=e.child.memoizedState)?Da(r):{baseLanes:c.baseLanes|r,cachePool:null,transitions:c.transitions},a.memoizedState=c,a.childLanes=e.childLanes&~r,t.memoizedState=$a,o}return e=(a=e.child).sibling,o=Op(a,{mode:"visible",children:o.children}),!(1&t.mode)&&(o.lanes=r),o.return=t,o.sibling=null,null!==e&&(null===(r=t.deletions)?(t.deletions=[e],t.flags|=16):r.push(e)),t.child=o,t.memoizedState=null,o}function La(e,t){return(t=Dp({mode:"visible",children:t},e.mode,0,null)).return=e,e.child=t}function Ua(e,t,r,n){return null!==n&&fi(n),xi(t,e.child,null,r),(e=La(t,t.pendingProps.children)).flags|=2,t.memoizedState=null,e}function Na(e,t,r){e.lanes|=t;var n=e.alternate;null!==n&&(n.lanes|=t),ji(e.return,t,r)}function Fa(e,t,r,n,o){var i=e.memoizedState;null===i?e.memoizedState={isBackwards:t,rendering:null,renderingStartTime:0,last:n,tail:r,tailMode:o}:(i.isBackwards=t,i.rendering=null,i.renderingStartTime=0,i.last=n,i.tail=r,i.tailMode=o)}function Ma(e,t,r){var n=t.pendingProps,o=n.revealOrder,i=n.tail;if(va(e,t,n.children,r),2&(n=es.current))n=1&n|2,t.flags|=128;else{if(null!==e&&128&e.flags)e:for(e=t.child;null!==e;){if(13===e.tag)null!==e.memoizedState&&Na(e,r,t);else if(19===e.tag)Na(e,r,t);else if(null!==e.child){e.child.return=e,e=e.child;continue}if(e===t)break e;for(;null===e.sibling;){if(null===e.return||e.return===t)break e;e=e.return}e.sibling.return=e.return,e=e.sibling}n&=1}if(Ao(es,n),1&t.mode)switch(o){case"forwards":for(r=t.child,o=null;null!==r;)null!==(e=r.alternate)&&null===ts(e)&&(o=r),r=r.sibling;null===(r=o)?(o=t.child,t.child=null):(o=r.sibling,r.sibling=null),Fa(t,!1,o,r,i);break;case"backwards":for(r=null,o=t.child,t.child=null;null!==o;){if(null!==(e=o.alternate)&&null===ts(e)){t.child=o;break}e=o.sibling,o.sibling=r,r=o,o=e}Fa(t,!0,r,null,i);break;case"together":Fa(t,!1,null,null,void 0);break;default:t.memoizedState=null}else t.memoizedState=null;return t.child}function Ga(e,t){!(1&t.mode)&&null!==e&&(e.alternate=null,t.alternate=null,t.flags|=2)}function za(e,t,r){if(null!==e&&(t.dependencies=e.dependencies),Dc|=t.lanes,!(r&t.childLanes))return null;if(null!==e&&t.child!==e.child)throw Error(i(153));if(null!==t.child){for(r=Op(e=t.child,e.pendingProps),t.child=r,r.return=t;null!==e.sibling;)e=e.sibling,(r=r.sibling=Op(e,e.pendingProps)).return=t;r.sibling=null}return t.child}function Wa(e,t){if(!ii)switch(e.tailMode){case"hidden":t=e.tail;for(var r=null;null!==t;)null!==t.alternate&&(r=t),t=t.sibling;null===r?e.tail=null:r.sibling=null;break;case"collapsed":r=e.tail;for(var n=null;null!==r;)null!==r.alternate&&(n=r),r=r.sibling;null===n?t||null===e.tail?e.tail=null:e.tail.sibling=null:n.sibling=null}}function Ha(e){var t=null!==e.alternate&&e.alternate.child===e.child,r=0,n=0;if(t)for(var o=e.child;null!==o;)r|=o.lanes|o.childLanes,n|=14680064&o.subtreeFlags,n|=14680064&o.flags,o.return=e,o=o.sibling;else for(o=e.child;null!==o;)r|=o.lanes|o.childLanes,n|=o.subtreeFlags,n|=o.flags,o.return=e,o=o.sibling;return e.subtreeFlags|=n,e.childLanes=r,t}function Za(e,t,r){var n=t.pendingProps;switch(ri(t),t.tag){case 2:case 16:case 15:case 0:case 11:case 7:case 8:case 12:case 9:case 14:return Ha(t),null;case 1:case 17:return Oo(t.type)&&qo(),Ha(t),null;case 3:return n=t.stateNode,Ji(),Co(Eo),Co(jo),ns(),n.pendingContext&&(n.context=n.pendingContext,n.pendingContext=null),null!==e&&null!==e.child||(ui(t)?t.flags|=4:null===e||e.memoizedState.isDehydrated&&!(256&t.flags)||(t.flags|=1024,null!==si&&(sp(si),si=null))),Ra(e,t),Ha(t),null;case 5:Qi(t);var o=Ki(Vi.current);if(r=t.type,null!==e&&null!=t.stateNode)Oa(e,t,r,n,o),e.ref!==t.ref&&(t.flags|=512,t.flags|=2097152);else{if(!n){if(null===t.stateNode)throw Error(i(166));return Ha(t),null}if(e=Ki(Hi.current),ui(t)){n=t.stateNode,r=t.type;var s=t.memoizedProps;switch(n[mo]=t,n[ho]=s,e=!!(1&t.mode),r){case"dialog":Un("cancel",n),Un("close",n);break;case"iframe":case"object":case"embed":Un("load",n);break;case"video":case"audio":for(o=0;o<$n.length;o++)Un($n[o],n);break;case"source":Un("error",n);break;case"img":case"image":case"link":Un("error",n),Un("load",n);break;case"details":Un("toggle",n);break;case"input":Y(n,s),Un("invalid",n);break;case"select":n._wrapperState={wasMultiple:!!s.multiple},Un("invalid",n);break;case"textarea":oe(n,s),Un("invalid",n)}for(var c in be(r,s),o=null,s)if(s.hasOwnProperty(c)){var p=s[c];"children"===c?"string"==typeof p?n.textContent!==p&&(!0!==s.suppressHydrationWarning&&Xn(n.textContent,p,e),o=["children",p]):"number"==typeof p&&n.textContent!==""+p&&(!0!==s.suppressHydrationWarning&&Xn(n.textContent,p,e),o=["children",""+p]):a.hasOwnProperty(c)&&null!=p&&"onScroll"===c&&Un("scroll",n)}switch(r){case"input":H(n),Q(n,s,!0);break;case"textarea":H(n),se(n);break;case"select":case"option":break;default:"function"==typeof s.onClick&&(n.onclick=Qn)}n=o,t.updateQueue=n,null!==n&&(t.flags|=4)}else{c=9===o.nodeType?o:o.ownerDocument,"http://www.w3.org/1999/xhtml"===e&&(e=ae(r)),"http://www.w3.org/1999/xhtml"===e?"script"===r?((e=c.createElement("div")).innerHTML="<script><\/script>",e=e.removeChild(e.firstChild)):"string"==typeof n.is?e=c.createElement(r,{is:n.is}):(e=c.createElement(r),"select"===r&&(c=e,n.multiple?c.multiple=!0:n.size&&(c.size=n.size))):e=c.createElementNS(e,r),e[mo]=t,e[ho]=n,Pa(e,t,!1,!1),t.stateNode=e;e:{switch(c=_e(r,n),r){case"dialog":Un("cancel",e),Un("close",e),o=n;break;case"iframe":case"object":case"embed":Un("load",e),o=n;break;case"video":case"audio":for(o=0;o<$n.length;o++)Un($n[o],e);o=n;break;case"source":Un("error",e),o=n;break;case"img":case"image":case"link":Un("error",e),Un("load",e),o=n;break;case"details":Un("toggle",e),o=n;break;case"input":Y(e,n),o=K(e,n),Un("invalid",e);break;case"option":default:o=n;break;case"select":e._wrapperState={wasMultiple:!!n.multiple},o=B({},n,{value:void 0}),Un("invalid",e);break;case"textarea":oe(e,n),o=ne(e,n),Un("invalid",e)}for(s in be(r,o),p=o)if(p.hasOwnProperty(s)){var d=p[s];"style"===s?ge(e,d):"dangerouslySetInnerHTML"===s?null!=(d=d?d.__html:void 0)&&le(e,d):"children"===s?"string"==typeof d?("textarea"!==r||""!==d)&&ue(e,d):"number"==typeof d&&ue(e,""+d):"suppressContentEditableWarning"!==s&&"suppressHydrationWarning"!==s&&"autoFocus"!==s&&(a.hasOwnProperty(s)?null!=d&&"onScroll"===s&&Un("scroll",e):null!=d&&_(e,s,d,c))}switch(r){case"input":H(e),Q(e,n,!1);break;case"textarea":H(e),se(e);break;case"option":null!=n.value&&e.setAttribute("value",""+z(n.value));break;case"select":e.multiple=!!n.multiple,null!=(s=n.value)?re(e,!!n.multiple,s,!1):null!=n.defaultValue&&re(e,!!n.multiple,n.defaultValue,!0);break;default:"function"==typeof o.onClick&&(e.onclick=Qn)}switch(r){case"button":case"input":case"select":case"textarea":n=!!n.autoFocus;break e;case"img":n=!0;break e;default:n=!1}}n&&(t.flags|=4)}null!==t.ref&&(t.flags|=512,t.flags|=2097152)}return Ha(t),null;case 6:if(e&&null!=t.stateNode)qa(e,t,e.memoizedProps,n);else{if("string"!=typeof n&&null===t.stateNode)throw Error(i(166));if(r=Ki(Vi.current),Ki(Hi.current),ui(t)){if(n=t.stateNode,r=t.memoizedProps,n[mo]=t,(s=n.nodeValue!==r)&&null!==(e=ni))switch(e.tag){case 3:Xn(n.nodeValue,r,!!(1&e.mode));break;case 5:!0!==e.memoizedProps.suppressHydrationWarning&&Xn(n.nodeValue,r,!!(1&e.mode))}s&&(t.flags|=4)}else(n=(9===r.nodeType?r:r.ownerDocument).createTextNode(n))[mo]=t,t.stateNode=n}return Ha(t),null;case 13:if(Co(es),n=t.memoizedState,null===e||null!==e.memoizedState&&null!==e.memoizedState.dehydrated){if(ii&&null!==oi&&1&t.mode&&!(128&t.flags))mi(),hi(),t.flags|=98560,s=!1;else if(s=ui(t),null!==n&&null!==n.dehydrated){if(null===e){if(!s)throw Error(i(318));if(!(s=null!==(s=t.memoizedState)?s.dehydrated:null))throw Error(i(317));s[mo]=t}else hi(),!(128&t.flags)&&(t.memoizedState=null),t.flags|=4;Ha(t),s=!1}else null!==si&&(sp(si),si=null),s=!0;if(!s)return 65536&t.flags?t:null}return 128&t.flags?(t.lanes=r,t):((n=null!==n)!==(null!==e&&null!==e.memoizedState)&&n&&(t.child.flags|=8192,1&t.mode&&(null===e||1&es.current?0===qc&&(qc=3):fp())),null!==t.updateQueue&&(t.flags|=4),Ha(t),null);case 4:return Ji(),Ra(e,t),null===e&&Mn(t.stateNode.containerInfo),Ha(t),null;case 10:return Ii(t.type._context),Ha(t),null;case 19:if(Co(es),null===(s=t.memoizedState))return Ha(t),null;if(n=!!(128&t.flags),null===(c=s.rendering))if(n)Wa(s,!1);else{if(0!==qc||null!==e&&128&e.flags)for(e=t.child;null!==e;){if(null!==(c=ts(e))){for(t.flags|=128,Wa(s,!1),null!==(n=c.updateQueue)&&(t.updateQueue=n,t.flags|=4),t.subtreeFlags=0,n=r,r=t.child;null!==r;)e=n,(s=r).flags&=14680066,null===(c=s.alternate)?(s.childLanes=0,s.lanes=e,s.child=null,s.subtreeFlags=0,s.memoizedProps=null,s.memoizedState=null,s.updateQueue=null,s.dependencies=null,s.stateNode=null):(s.childLanes=c.childLanes,s.lanes=c.lanes,s.child=c.child,s.subtreeFlags=0,s.deletions=null,s.memoizedProps=c.memoizedProps,s.memoizedState=c.memoizedState,s.updateQueue=c.updateQueue,s.type=c.type,e=c.dependencies,s.dependencies=null===e?null:{lanes:e.lanes,firstContext:e.firstContext}),r=r.sibling;return Ao(es,1&es.current|2),t.child}e=e.sibling}null!==s.tail&&Je()>Mc&&(t.flags|=128,n=!0,Wa(s,!1),t.lanes=4194304)}else{if(!n)if(null!==(e=ts(c))){if(t.flags|=128,n=!0,null!==(r=e.updateQueue)&&(t.updateQueue=r,t.flags|=4),Wa(s,!0),null===s.tail&&"hidden"===s.tailMode&&!c.alternate&&!ii)return Ha(t),null}else 2*Je()-s.renderingStartTime>Mc&&1073741824!==r&&(t.flags|=128,n=!0,Wa(s,!1),t.lanes=4194304);s.isBackwards?(c.sibling=t.child,t.child=c):(null!==(r=s.last)?r.sibling=c:t.child=c,s.last=c)}return null!==s.tail?(t=s.tail,s.rendering=t,s.tail=t.sibling,s.renderingStartTime=Je(),t.sibling=null,r=es.current,Ao(es,n?1&r|2:1&r),t):(Ha(t),null);case 22:case 23:return lp(),n=null!==t.memoizedState,null!==e&&null!==e.memoizedState!==n&&(t.flags|=8192),n&&1&t.mode?!!(1073741824&Rc)&&(Ha(t),6&t.subtreeFlags&&(t.flags|=8192)):Ha(t),null;case 24:case 25:return null}throw Error(i(156,t.tag))}function Va(e,t){switch(ri(t),t.tag){case 1:return Oo(t.type)&&qo(),65536&(e=t.flags)?(t.flags=-65537&e|128,t):null;case 3:return Ji(),Co(Eo),Co(jo),ns(),65536&(e=t.flags)&&!(128&e)?(t.flags=-65537&e|128,t):null;case 5:return Qi(t),null;case 13:if(Co(es),null!==(e=t.memoizedState)&&null!==e.dehydrated){if(null===t.alternate)throw Error(i(340));hi()}return 65536&(e=t.flags)?(t.flags=-65537&e|128,t):null;case 19:return Co(es),null;case 4:return Ji(),null;case 10:return Ii(t.type._context),null;case 22:case 23:return lp(),null;default:return null}}Pa=function(e,t){for(var r=t.child;null!==r;){if(5===r.tag||6===r.tag)e.appendChild(r.stateNode);else if(4!==r.tag&&null!==r.child){r.child.return=r,r=r.child;continue}if(r===t)break;for(;null===r.sibling;){if(null===r.return||r.return===t)return;r=r.return}r.sibling.return=r.return,r=r.sibling}},Ra=function(){},Oa=function(e,t,r,n){var o=e.memoizedProps;if(o!==n){e=t.stateNode,Ki(Hi.current);var i,s=null;switch(r){case"input":o=K(e,o),n=K(e,n),s=[];break;case"select":o=B({},o,{value:void 0}),n=B({},n,{value:void 0}),s=[];break;case"textarea":o=ne(e,o),n=ne(e,n),s=[];break;default:"function"!=typeof o.onClick&&"function"==typeof n.onClick&&(e.onclick=Qn)}for(d in be(r,n),r=null,o)if(!n.hasOwnProperty(d)&&o.hasOwnProperty(d)&&null!=o[d])if("style"===d){var c=o[d];for(i in c)c.hasOwnProperty(i)&&(r||(r={}),r[i]="")}else"dangerouslySetInnerHTML"!==d&&"children"!==d&&"suppressContentEditableWarning"!==d&&"suppressHydrationWarning"!==d&&"autoFocus"!==d&&(a.hasOwnProperty(d)?s||(s=[]):(s=s||[]).push(d,null));for(d in n){var p=n[d];if(c=null!=o?o[d]:void 0,n.hasOwnProperty(d)&&p!==c&&(null!=p||null!=c))if("style"===d)if(c){for(i in c)!c.hasOwnProperty(i)||p&&p.hasOwnProperty(i)||(r||(r={}),r[i]="");for(i in p)p.hasOwnProperty(i)&&c[i]!==p[i]&&(r||(r={}),r[i]=p[i])}else r||(s||(s=[]),s.push(d,r)),r=p;else"dangerouslySetInnerHTML"===d?(p=p?p.__html:void 0,c=c?c.__html:void 0,null!=p&&c!==p&&(s=s||[]).push(d,p)):"children"===d?"string"!=typeof p&&"number"!=typeof p||(s=s||[]).push(d,""+p):"suppressContentEditableWarning"!==d&&"suppressHydrationWarning"!==d&&(a.hasOwnProperty(d)?(null!=p&&"onScroll"===d&&Un("scroll",e),s||c===p||(s=[])):(s=s||[]).push(d,p))}r&&(s=s||[]).push("style",r);var d=s;(t.updateQueue=d)&&(t.flags|=4)}},qa=function(e,t,r,n){r!==n&&(t.flags|=4)};var Ka=!1,Ya=!1,Ja="function"==typeof WeakSet?WeakSet:Set,Xa=null;function Qa(e,t){var r=e.ref;if(null!==r)if("function"==typeof r)try{r(null)}catch(n){Sp(e,t,n)}else r.current=null}function ec(e,t,r){try{r()}catch(n){Sp(e,t,n)}}var tc=!1;function rc(e,t,r){var n=t.updateQueue;if(null!==(n=null!==n?n.lastEffect:null)){var o=n=n.next;do{if((o.tag&e)===e){var i=o.destroy;o.destroy=void 0,void 0!==i&&ec(t,r,i)}o=o.next}while(o!==n)}}function nc(e,t){if(null!==(t=null!==(t=t.updateQueue)?t.lastEffect:null)){var r=t=t.next;do{if((r.tag&e)===e){var n=r.create;r.destroy=n()}r=r.next}while(r!==t)}}function oc(e){var t=e.ref;if(null!==t){var r=e.stateNode;e.tag,e=r,"function"==typeof t?t(e):t.current=e}}function ic(e){var t=e.alternate;null!==t&&(e.alternate=null,ic(t)),e.child=null,e.deletions=null,e.sibling=null,5===e.tag&&(null!==(t=e.stateNode)&&(delete t[mo],delete t[ho],delete t[go],delete t[yo],delete t[bo])),e.stateNode=null,e.return=null,e.dependencies=null,e.memoizedProps=null,e.memoizedState=null,e.pendingProps=null,e.stateNode=null,e.updateQueue=null}function sc(e){return 5===e.tag||3===e.tag||4===e.tag}function ac(e){e:for(;;){for(;null===e.sibling;){if(null===e.return||sc(e.return))return null;e=e.return}for(e.sibling.return=e.return,e=e.sibling;5!==e.tag&&6!==e.tag&&18!==e.tag;){if(2&e.flags)continue e;if(null===e.child||4===e.tag)continue e;e.child.return=e,e=e.child}if(!(2&e.flags))return e.stateNode}}function cc(e,t,r){var n=e.tag;if(5===n||6===n)e=e.stateNode,t?8===r.nodeType?r.parentNode.insertBefore(e,t):r.insertBefore(e,t):(8===r.nodeType?(t=r.parentNode).insertBefore(e,r):(t=r).appendChild(e),null!=(r=r._reactRootContainer)||null!==t.onclick||(t.onclick=Qn));else if(4!==n&&null!==(e=e.child))for(cc(e,t,r),e=e.sibling;null!==e;)cc(e,t,r),e=e.sibling}function pc(e,t,r){var n=e.tag;if(5===n||6===n)e=e.stateNode,t?r.insertBefore(e,t):r.appendChild(e);else if(4!==n&&null!==(e=e.child))for(pc(e,t,r),e=e.sibling;null!==e;)pc(e,t,r),e=e.sibling}var dc=null,lc=!1;function uc(e,t,r){for(r=r.child;null!==r;)mc(e,t,r),r=r.sibling}function mc(e,t,r){if(it&&"function"==typeof it.onCommitFiberUnmount)try{it.onCommitFiberUnmount(ot,r)}catch(a){}switch(r.tag){case 5:Ya||Qa(r,t);case 6:var n=dc,o=lc;dc=null,uc(e,t,r),lc=o,null!==(dc=n)&&(lc?(e=dc,r=r.stateNode,8===e.nodeType?e.parentNode.removeChild(r):e.removeChild(r)):dc.removeChild(r.stateNode));break;case 18:null!==dc&&(lc?(e=dc,r=r.stateNode,8===e.nodeType?co(e.parentNode,r):1===e.nodeType&&co(e,r),Mt(e)):co(dc,r.stateNode));break;case 4:n=dc,o=lc,dc=r.stateNode.containerInfo,lc=!0,uc(e,t,r),dc=n,lc=o;break;case 0:case 11:case 14:case 15:if(!Ya&&(null!==(n=r.updateQueue)&&null!==(n=n.lastEffect))){o=n=n.next;do{var i=o,s=i.destroy;i=i.tag,void 0!==s&&(2&i||4&i)&&ec(r,t,s),o=o.next}while(o!==n)}uc(e,t,r);break;case 1:if(!Ya&&(Qa(r,t),"function"==typeof(n=r.stateNode).componentWillUnmount))try{n.props=r.memoizedProps,n.state=r.memoizedState,n.componentWillUnmount()}catch(a){Sp(r,t,a)}uc(e,t,r);break;case 21:uc(e,t,r);break;case 22:1&r.mode?(Ya=(n=Ya)||null!==r.memoizedState,uc(e,t,r),Ya=n):uc(e,t,r);break;default:uc(e,t,r)}}function hc(e){var t=e.updateQueue;if(null!==t){e.updateQueue=null;var r=e.stateNode;null===r&&(r=e.stateNode=new Ja),t.forEach((function(t){var n=Ip.bind(null,e,t);r.has(t)||(r.add(t),t.then(n,n))}))}}function fc(e,t){var r=t.deletions;if(null!==r)for(var n=0;n<r.length;n++){var o=r[n];try{var s=e,a=t,c=a;e:for(;null!==c;){switch(c.tag){case 5:dc=c.stateNode,lc=!1;break e;case 3:case 4:dc=c.stateNode.containerInfo,lc=!0;break e}c=c.return}if(null===dc)throw Error(i(160));mc(s,a,o),dc=null,lc=!1;var p=o.alternate;null!==p&&(p.return=null),o.return=null}catch(d){Sp(o,t,d)}}if(12854&t.subtreeFlags)for(t=t.child;null!==t;)gc(t,e),t=t.sibling}function gc(e,t){var r=e.alternate,n=e.flags;switch(e.tag){case 0:case 11:case 14:case 15:if(fc(t,e),yc(e),4&n){try{rc(3,e,e.return),nc(3,e)}catch(g){Sp(e,e.return,g)}try{rc(5,e,e.return)}catch(g){Sp(e,e.return,g)}}break;case 1:fc(t,e),yc(e),512&n&&null!==r&&Qa(r,r.return);break;case 5:if(fc(t,e),yc(e),512&n&&null!==r&&Qa(r,r.return),32&e.flags){var o=e.stateNode;try{ue(o,"")}catch(g){Sp(e,e.return,g)}}if(4&n&&null!=(o=e.stateNode)){var s=e.memoizedProps,a=null!==r?r.memoizedProps:s,c=e.type,p=e.updateQueue;if(e.updateQueue=null,null!==p)try{"input"===c&&"radio"===s.type&&null!=s.name&&J(o,s),_e(c,a);var d=_e(c,s);for(a=0;a<p.length;a+=2){var l=p[a],u=p[a+1];"style"===l?ge(o,u):"dangerouslySetInnerHTML"===l?le(o,u):"children"===l?ue(o,u):_(o,l,u,d)}switch(c){case"input":X(o,s);break;case"textarea":ie(o,s);break;case"select":var m=o._wrapperState.wasMultiple;o._wrapperState.wasMultiple=!!s.multiple;var h=s.value;null!=h?re(o,!!s.multiple,h,!1):m!==!!s.multiple&&(null!=s.defaultValue?re(o,!!s.multiple,s.defaultValue,!0):re(o,!!s.multiple,s.multiple?[]:"",!1))}o[ho]=s}catch(g){Sp(e,e.return,g)}}break;case 6:if(fc(t,e),yc(e),4&n){if(null===e.stateNode)throw Error(i(162));o=e.stateNode,s=e.memoizedProps;try{o.nodeValue=s}catch(g){Sp(e,e.return,g)}}break;case 3:if(fc(t,e),yc(e),4&n&&null!==r&&r.memoizedState.isDehydrated)try{Mt(t.containerInfo)}catch(g){Sp(e,e.return,g)}break;case 4:default:fc(t,e),yc(e);break;case 13:fc(t,e),yc(e),8192&(o=e.child).flags&&(s=null!==o.memoizedState,o.stateNode.isHidden=s,!s||null!==o.alternate&&null!==o.alternate.memoizedState||(Fc=Je())),4&n&&hc(e);break;case 22:if(l=null!==r&&null!==r.memoizedState,1&e.mode?(Ya=(d=Ya)||l,fc(t,e),Ya=d):fc(t,e),yc(e),8192&n){if(d=null!==e.memoizedState,(e.stateNode.isHidden=d)&&!l&&1&e.mode)for(Xa=e,l=e.child;null!==l;){for(u=Xa=l;null!==Xa;){switch(h=(m=Xa).child,m.tag){case 0:case 11:case 14:case 15:rc(4,m,m.return);break;case 1:Qa(m,m.return);var f=m.stateNode;if("function"==typeof f.componentWillUnmount){n=m,r=m.return;try{t=n,f.props=t.memoizedProps,f.state=t.memoizedState,f.componentWillUnmount()}catch(g){Sp(n,r,g)}}break;case 5:Qa(m,m.return);break;case 22:if(null!==m.memoizedState){xc(u);continue}}null!==h?(h.return=m,Xa=h):xc(u)}l=l.sibling}e:for(l=null,u=e;;){if(5===u.tag){if(null===l){l=u;try{o=u.stateNode,d?"function"==typeof(s=o.style).setProperty?s.setProperty("display","none","important"):s.display="none":(c=u.stateNode,a=null!=(p=u.memoizedProps.style)&&p.hasOwnProperty("display")?p.display:null,c.style.display=fe("display",a))}catch(g){Sp(e,e.return,g)}}}else if(6===u.tag){if(null===l)try{u.stateNode.nodeValue=d?"":u.memoizedProps}catch(g){Sp(e,e.return,g)}}else if((22!==u.tag&&23!==u.tag||null===u.memoizedState||u===e)&&null!==u.child){u.child.return=u,u=u.child;continue}if(u===e)break e;for(;null===u.sibling;){if(null===u.return||u.return===e)break e;l===u&&(l=null),u=u.return}l===u&&(l=null),u.sibling.return=u.return,u=u.sibling}}break;case 19:fc(t,e),yc(e),4&n&&hc(e);case 21:}}function yc(e){var t=e.flags;if(2&t){try{e:{for(var r=e.return;null!==r;){if(sc(r)){var n=r;break e}r=r.return}throw Error(i(160))}switch(n.tag){case 5:var o=n.stateNode;32&n.flags&&(ue(o,""),n.flags&=-33),pc(e,ac(e),o);break;case 3:case 4:var s=n.stateNode.containerInfo;cc(e,ac(e),s);break;default:throw Error(i(161))}}catch(a){Sp(e,e.return,a)}e.flags&=-3}4096&t&&(e.flags&=-4097)}function bc(e,t,r){Xa=e,_c(e,t,r)}function _c(e,t,r){for(var n=!!(1&e.mode);null!==Xa;){var o=Xa,i=o.child;if(22===o.tag&&n){var s=null!==o.memoizedState||Ka;if(!s){var a=o.alternate,c=null!==a&&null!==a.memoizedState||Ya;a=Ka;var p=Ya;if(Ka=s,(Ya=c)&&!p)for(Xa=o;null!==Xa;)c=(s=Xa).child,22===s.tag&&null!==s.memoizedState?wc(o):null!==c?(c.return=s,Xa=c):wc(o);for(;null!==i;)Xa=i,_c(i,t,r),i=i.sibling;Xa=o,Ka=a,Ya=p}vc(e)}else 8772&o.subtreeFlags&&null!==i?(i.return=o,Xa=i):vc(e)}}function vc(e){for(;null!==Xa;){var t=Xa;if(8772&t.flags){var r=t.alternate;try{if(8772&t.flags)switch(t.tag){case 0:case 11:case 15:Ya||nc(5,t);break;case 1:var n=t.stateNode;if(4&t.flags&&!Ya)if(null===r)n.componentDidMount();else{var o=t.elementType===t.type?r.memoizedProps:ra(t.type,r.memoizedProps);n.componentDidUpdate(o,r.memoizedState,n.__reactInternalSnapshotBeforeUpdate)}var s=t.updateQueue;null!==s&&zi(t,s,n);break;case 3:var a=t.updateQueue;if(null!==a){if(r=null,null!==t.child)switch(t.child.tag){case 5:case 1:r=t.child.stateNode}zi(t,a,r)}break;case 5:var c=t.stateNode;if(null===r&&4&t.flags){r=c;var p=t.memoizedProps;switch(t.type){case"button":case"input":case"select":case"textarea":p.autoFocus&&r.focus();break;case"img":p.src&&(r.src=p.src)}}break;case 6:case 4:case 12:case 19:case 17:case 21:case 22:case 23:case 25:break;case 13:if(null===t.memoizedState){var d=t.alternate;if(null!==d){var l=d.memoizedState;if(null!==l){var u=l.dehydrated;null!==u&&Mt(u)}}}break;default:throw Error(i(163))}Ya||512&t.flags&&oc(t)}catch(m){Sp(t,t.return,m)}}if(t===e){Xa=null;break}if(null!==(r=t.sibling)){r.return=t.return,Xa=r;break}Xa=t.return}}function xc(e){for(;null!==Xa;){var t=Xa;if(t===e){Xa=null;break}var r=t.sibling;if(null!==r){r.return=t.return,Xa=r;break}Xa=t.return}}function wc(e){for(;null!==Xa;){var t=Xa;try{switch(t.tag){case 0:case 11:case 15:var r=t.return;try{nc(4,t)}catch(c){Sp(t,r,c)}break;case 1:var n=t.stateNode;if("function"==typeof n.componentDidMount){var o=t.return;try{n.componentDidMount()}catch(c){Sp(t,o,c)}}var i=t.return;try{oc(t)}catch(c){Sp(t,i,c)}break;case 5:var s=t.return;try{oc(t)}catch(c){Sp(t,s,c)}}}catch(c){Sp(t,t.return,c)}if(t===e){Xa=null;break}var a=t.sibling;if(null!==a){a.return=t.return,Xa=a;break}Xa=t.return}}var kc,Sc=Math.ceil,Tc=v.ReactCurrentDispatcher,Cc=v.ReactCurrentOwner,Ac=v.ReactCurrentBatchConfig,Ic=0,jc=null,Ec=null,Pc=0,Rc=0,Oc=To(0),qc=0,$c=null,Dc=0,Bc=0,Lc=0,Uc=null,Nc=null,Fc=0,Mc=1/0,Gc=null,zc=!1,Wc=null,Hc=null,Zc=!1,Vc=null,Kc=0,Yc=0,Jc=null,Xc=-1,Qc=0;function ep(){return 6&Ic?Je():-1!==Xc?Xc:Xc=Je()}function tp(e){return 1&e.mode?2&Ic&&0!==Pc?Pc&-Pc:null!==gi.transition?(0===Qc&&(Qc=ft()),Qc):0!==(e=_t)?e:e=void 0===(e=window.event)?16:Yt(e.type):1}function rp(e,t,r,n){if(50<Yc)throw Yc=0,Jc=null,Error(i(185));yt(e,r,n),2&Ic&&e===jc||(e===jc&&(!(2&Ic)&&(Bc|=r),4===qc&&ap(e,Pc)),np(e,n),1===r&&0===Ic&&!(1&t.mode)&&(Mc=Je()+500,No&&Go()))}function np(e,t){var r=e.callbackNode;!function(e,t){for(var r=e.suspendedLanes,n=e.pingedLanes,o=e.expirationTimes,i=e.pendingLanes;0<i;){var s=31-st(i),a=1<<s,c=o[s];-1===c?a&r&&!(a&n)||(o[s]=mt(a,t)):c<=t&&(e.expiredLanes|=a),i&=~a}}(e,t);var n=ut(e,e===jc?Pc:0);if(0===n)null!==r&&Ve(r),e.callbackNode=null,e.callbackPriority=0;else if(t=n&-n,e.callbackPriority!==t){if(null!=r&&Ve(r),1===t)0===e.tag?function(e){No=!0,Mo(e)}(cp.bind(null,e)):Mo(cp.bind(null,e)),so((function(){!(6&Ic)&&Go()})),r=null;else{switch(vt(n)){case 1:r=Qe;break;case 4:r=et;break;case 16:default:r=tt;break;case 536870912:r=nt}r=jp(r,op.bind(null,e))}e.callbackPriority=t,e.callbackNode=r}}function op(e,t){if(Xc=-1,Qc=0,6&Ic)throw Error(i(327));var r=e.callbackNode;if(wp()&&e.callbackNode!==r)return null;var n=ut(e,e===jc?Pc:0);if(0===n)return null;if(30&n||n&e.expiredLanes||t)t=gp(e,n);else{t=n;var o=Ic;Ic|=2;var s=hp();for(jc===e&&Pc===t||(Gc=null,Mc=Je()+500,up(e,t));;)try{bp();break}catch(c){mp(e,c)}Ai(),Tc.current=s,Ic=o,null!==Ec?t=0:(jc=null,Pc=0,t=qc)}if(0!==t){if(2===t&&(0!==(o=ht(e))&&(n=o,t=ip(e,o))),1===t)throw r=$c,up(e,0),ap(e,n),np(e,Je()),r;if(6===t)ap(e,n);else{if(o=e.current.alternate,!(30&n||function(e){for(var t=e;;){if(16384&t.flags){var r=t.updateQueue;if(null!==r&&null!==(r=r.stores))for(var n=0;n<r.length;n++){var o=r[n],i=o.getSnapshot;o=o.value;try{if(!an(i(),o))return!1}catch(a){return!1}}}if(r=t.child,16384&t.subtreeFlags&&null!==r)r.return=t,t=r;else{if(t===e)break;for(;null===t.sibling;){if(null===t.return||t.return===e)return!0;t=t.return}t.sibling.return=t.return,t=t.sibling}}return!0}(o)||(t=gp(e,n),2===t&&(s=ht(e),0!==s&&(n=s,t=ip(e,s))),1!==t)))throw r=$c,up(e,0),ap(e,n),np(e,Je()),r;switch(e.finishedWork=o,e.finishedLanes=n,t){case 0:case 1:throw Error(i(345));case 2:case 5:xp(e,Nc,Gc);break;case 3:if(ap(e,n),(130023424&n)===n&&10<(t=Fc+500-Je())){if(0!==ut(e,0))break;if(((o=e.suspendedLanes)&n)!==n){ep(),e.pingedLanes|=e.suspendedLanes&o;break}e.timeoutHandle=no(xp.bind(null,e,Nc,Gc),t);break}xp(e,Nc,Gc);break;case 4:if(ap(e,n),(4194240&n)===n)break;for(t=e.eventTimes,o=-1;0<n;){var a=31-st(n);s=1<<a,(a=t[a])>o&&(o=a),n&=~s}if(n=o,10<(n=(120>(n=Je()-n)?120:480>n?480:1080>n?1080:1920>n?1920:3e3>n?3e3:4320>n?4320:1960*Sc(n/1960))-n)){e.timeoutHandle=no(xp.bind(null,e,Nc,Gc),n);break}xp(e,Nc,Gc);break;default:throw Error(i(329))}}}return np(e,Je()),e.callbackNode===r?op.bind(null,e):null}function ip(e,t){var r=Uc;return e.current.memoizedState.isDehydrated&&(up(e,t).flags|=256),2!==(e=gp(e,t))&&(t=Nc,Nc=r,null!==t&&sp(t)),e}function sp(e){null===Nc?Nc=e:Nc.push.apply(Nc,e)}function ap(e,t){for(t&=~Lc,t&=~Bc,e.suspendedLanes|=t,e.pingedLanes&=~t,e=e.expirationTimes;0<t;){var r=31-st(t),n=1<<r;e[r]=-1,t&=~n}}function cp(e){if(6&Ic)throw Error(i(327));wp();var t=ut(e,0);if(!(1&t))return np(e,Je()),null;var r=gp(e,t);if(0!==e.tag&&2===r){var n=ht(e);0!==n&&(t=n,r=ip(e,n))}if(1===r)throw r=$c,up(e,0),ap(e,t),np(e,Je()),r;if(6===r)throw Error(i(345));return e.finishedWork=e.current.alternate,e.finishedLanes=t,xp(e,Nc,Gc),np(e,Je()),null}function pp(e,t){var r=Ic;Ic|=1;try{return e(t)}finally{0===(Ic=r)&&(Mc=Je()+500,No&&Go())}}function dp(e){null!==Vc&&0===Vc.tag&&!(6&Ic)&&wp();var t=Ic;Ic|=1;var r=Ac.transition,n=_t;try{if(Ac.transition=null,_t=1,e)return e()}finally{_t=n,Ac.transition=r,!(6&(Ic=t))&&Go()}}function lp(){Rc=Oc.current,Co(Oc)}function up(e,t){e.finishedWork=null,e.finishedLanes=0;var r=e.timeoutHandle;if(-1!==r&&(e.timeoutHandle=-1,oo(r)),null!==Ec)for(r=Ec.return;null!==r;){var n=r;switch(ri(n),n.tag){case 1:null!=(n=n.type.childContextTypes)&&qo();break;case 3:Ji(),Co(Eo),Co(jo),ns();break;case 5:Qi(n);break;case 4:Ji();break;case 13:case 19:Co(es);break;case 10:Ii(n.type._context);break;case 22:case 23:lp()}r=r.return}if(jc=e,Ec=e=Op(e.current,null),Pc=Rc=t,qc=0,$c=null,Lc=Bc=Dc=0,Nc=Uc=null,null!==Ri){for(t=0;t<Ri.length;t++)if(null!==(n=(r=Ri[t]).interleaved)){r.interleaved=null;var o=n.next,i=r.pending;if(null!==i){var s=i.next;i.next=o,n.next=s}r.pending=n}Ri=null}return e}function mp(e,t){for(;;){var r=Ec;try{if(Ai(),os.current=Xs,ds){for(var n=as.memoizedState;null!==n;){var o=n.queue;null!==o&&(o.pending=null),n=n.next}ds=!1}if(ss=0,ps=cs=as=null,ls=!1,us=0,Cc.current=null,null===r||null===r.return){qc=1,$c=t,Ec=null;break}e:{var s=e,a=r.return,c=r,p=t;if(t=Pc,c.flags|=32768,null!==p&&"object"==typeof p&&"function"==typeof p.then){var d=p,l=c,u=l.tag;if(!(1&l.mode||0!==u&&11!==u&&15!==u)){var m=l.alternate;m?(l.updateQueue=m.updateQueue,l.memoizedState=m.memoizedState,l.lanes=m.lanes):(l.updateQueue=null,l.memoizedState=null)}var h=ga(a);if(null!==h){h.flags&=-257,ya(h,a,c,0,t),1&h.mode&&fa(s,d,t),p=d;var f=(t=h).updateQueue;if(null===f){var g=new Set;g.add(p),t.updateQueue=g}else f.add(p);break e}if(!(1&t)){fa(s,d,t),fp();break e}p=Error(i(426))}else if(ii&&1&c.mode){var y=ga(a);if(null!==y){!(65536&y.flags)&&(y.flags|=256),ya(y,a,c,0,t),fi(pa(p,c));break e}}s=p=pa(p,c),4!==qc&&(qc=2),null===Uc?Uc=[s]:Uc.push(s),s=a;do{switch(s.tag){case 3:s.flags|=65536,t&=-t,s.lanes|=t,Mi(s,ma(0,p,t));break e;case 1:c=p;var b=s.type,_=s.stateNode;if(!(128&s.flags||"function"!=typeof b.getDerivedStateFromError&&(null===_||"function"!=typeof _.componentDidCatch||null!==Hc&&Hc.has(_)))){s.flags|=65536,t&=-t,s.lanes|=t,Mi(s,ha(s,c,t));break e}}s=s.return}while(null!==s)}vp(r)}catch(v){t=v,Ec===r&&null!==r&&(Ec=r=r.return);continue}break}}function hp(){var e=Tc.current;return Tc.current=Xs,null===e?Xs:e}function fp(){0!==qc&&3!==qc&&2!==qc||(qc=4),null===jc||!(268435455&Dc)&&!(268435455&Bc)||ap(jc,Pc)}function gp(e,t){var r=Ic;Ic|=2;var n=hp();for(jc===e&&Pc===t||(Gc=null,up(e,t));;)try{yp();break}catch(o){mp(e,o)}if(Ai(),Ic=r,Tc.current=n,null!==Ec)throw Error(i(261));return jc=null,Pc=0,qc}function yp(){for(;null!==Ec;)_p(Ec)}function bp(){for(;null!==Ec&&!Ke();)_p(Ec)}function _p(e){var t=kc(e.alternate,e,Rc);e.memoizedProps=e.pendingProps,null===t?vp(e):Ec=t,Cc.current=null}function vp(e){var t=e;do{var r=t.alternate;if(e=t.return,32768&t.flags){if(null!==(r=Va(r,t)))return r.flags&=32767,void(Ec=r);if(null===e)return qc=6,void(Ec=null);e.flags|=32768,e.subtreeFlags=0,e.deletions=null}else if(null!==(r=Za(r,t,Rc)))return void(Ec=r);if(null!==(t=t.sibling))return void(Ec=t);Ec=t=e}while(null!==t);0===qc&&(qc=5)}function xp(e,t,r){var n=_t,o=Ac.transition;try{Ac.transition=null,_t=1,function(e,t,r,n){do{wp()}while(null!==Vc);if(6&Ic)throw Error(i(327));r=e.finishedWork;var o=e.finishedLanes;if(null===r)return null;if(e.finishedWork=null,e.finishedLanes=0,r===e.current)throw Error(i(177));e.callbackNode=null,e.callbackPriority=0;var s=r.lanes|r.childLanes;if(function(e,t){var r=e.pendingLanes&~t;e.pendingLanes=t,e.suspendedLanes=0,e.pingedLanes=0,e.expiredLanes&=t,e.mutableReadLanes&=t,e.entangledLanes&=t,t=e.entanglements;var n=e.eventTimes;for(e=e.expirationTimes;0<r;){var o=31-st(r),i=1<<o;t[o]=0,n[o]=-1,e[o]=-1,r&=~i}}(e,s),e===jc&&(Ec=jc=null,Pc=0),!(2064&r.subtreeFlags)&&!(2064&r.flags)||Zc||(Zc=!0,jp(tt,(function(){return wp(),null}))),s=!!(15990&r.flags),!!(15990&r.subtreeFlags)||s){s=Ac.transition,Ac.transition=null;var a=_t;_t=1;var c=Ic;Ic|=4,Cc.current=null,function(e,t){if(eo=zt,mn(e=un())){if("selectionStart"in e)var r={start:e.selectionStart,end:e.selectionEnd};else e:{var n=(r=(r=e.ownerDocument)&&r.defaultView||window).getSelection&&r.getSelection();if(n&&0!==n.rangeCount){r=n.anchorNode;var o=n.anchorOffset,s=n.focusNode;n=n.focusOffset;try{r.nodeType,s.nodeType}catch(x){r=null;break e}var a=0,c=-1,p=-1,d=0,l=0,u=e,m=null;t:for(;;){for(var h;u!==r||0!==o&&3!==u.nodeType||(c=a+o),u!==s||0!==n&&3!==u.nodeType||(p=a+n),3===u.nodeType&&(a+=u.nodeValue.length),null!==(h=u.firstChild);)m=u,u=h;for(;;){if(u===e)break t;if(m===r&&++d===o&&(c=a),m===s&&++l===n&&(p=a),null!==(h=u.nextSibling))break;m=(u=m).parentNode}u=h}r=-1===c||-1===p?null:{start:c,end:p}}else r=null}r=r||{start:0,end:0}}else r=null;for(to={focusedElem:e,selectionRange:r},zt=!1,Xa=t;null!==Xa;)if(e=(t=Xa).child,1028&t.subtreeFlags&&null!==e)e.return=t,Xa=e;else for(;null!==Xa;){t=Xa;try{var f=t.alternate;if(1024&t.flags)switch(t.tag){case 0:case 11:case 15:case 5:case 6:case 4:case 17:break;case 1:if(null!==f){var g=f.memoizedProps,y=f.memoizedState,b=t.stateNode,_=b.getSnapshotBeforeUpdate(t.elementType===t.type?g:ra(t.type,g),y);b.__reactInternalSnapshotBeforeUpdate=_}break;case 3:var v=t.stateNode.containerInfo;1===v.nodeType?v.textContent="":9===v.nodeType&&v.documentElement&&v.removeChild(v.documentElement);break;default:throw Error(i(163))}}catch(x){Sp(t,t.return,x)}if(null!==(e=t.sibling)){e.return=t.return,Xa=e;break}Xa=t.return}f=tc,tc=!1}(e,r),gc(r,e),hn(to),zt=!!eo,to=eo=null,e.current=r,bc(r,e,o),Ye(),Ic=c,_t=a,Ac.transition=s}else e.current=r;if(Zc&&(Zc=!1,Vc=e,Kc=o),s=e.pendingLanes,0===s&&(Hc=null),function(e){if(it&&"function"==typeof it.onCommitFiberRoot)try{it.onCommitFiberRoot(ot,e,void 0,!(128&~e.current.flags))}catch(t){}}(r.stateNode),np(e,Je()),null!==t)for(n=e.onRecoverableError,r=0;r<t.length;r++)o=t[r],n(o.value,{componentStack:o.stack,digest:o.digest});if(zc)throw zc=!1,e=Wc,Wc=null,e;!!(1&Kc)&&0!==e.tag&&wp(),s=e.pendingLanes,1&s?e===Jc?Yc++:(Yc=0,Jc=e):Yc=0,Go()}(e,t,r,n)}finally{Ac.transition=o,_t=n}return null}function wp(){if(null!==Vc){var e=vt(Kc),t=Ac.transition,r=_t;try{if(Ac.transition=null,_t=16>e?16:e,null===Vc)var n=!1;else{if(e=Vc,Vc=null,Kc=0,6&Ic)throw Error(i(331));var o=Ic;for(Ic|=4,Xa=e.current;null!==Xa;){var s=Xa,a=s.child;if(16&Xa.flags){var c=s.deletions;if(null!==c){for(var p=0;p<c.length;p++){var d=c[p];for(Xa=d;null!==Xa;){var l=Xa;switch(l.tag){case 0:case 11:case 15:rc(8,l,s)}var u=l.child;if(null!==u)u.return=l,Xa=u;else for(;null!==Xa;){var m=(l=Xa).sibling,h=l.return;if(ic(l),l===d){Xa=null;break}if(null!==m){m.return=h,Xa=m;break}Xa=h}}}var f=s.alternate;if(null!==f){var g=f.child;if(null!==g){f.child=null;do{var y=g.sibling;g.sibling=null,g=y}while(null!==g)}}Xa=s}}if(2064&s.subtreeFlags&&null!==a)a.return=s,Xa=a;else e:for(;null!==Xa;){if(2048&(s=Xa).flags)switch(s.tag){case 0:case 11:case 15:rc(9,s,s.return)}var b=s.sibling;if(null!==b){b.return=s.return,Xa=b;break e}Xa=s.return}}var _=e.current;for(Xa=_;null!==Xa;){var v=(a=Xa).child;if(2064&a.subtreeFlags&&null!==v)v.return=a,Xa=v;else e:for(a=_;null!==Xa;){if(2048&(c=Xa).flags)try{switch(c.tag){case 0:case 11:case 15:nc(9,c)}}catch(w){Sp(c,c.return,w)}if(c===a){Xa=null;break e}var x=c.sibling;if(null!==x){x.return=c.return,Xa=x;break e}Xa=c.return}}if(Ic=o,Go(),it&&"function"==typeof it.onPostCommitFiberRoot)try{it.onPostCommitFiberRoot(ot,e)}catch(w){}n=!0}return n}finally{_t=r,Ac.transition=t}}return!1}function kp(e,t,r){e=Ni(e,t=ma(0,t=pa(r,t),1),1),t=ep(),null!==e&&(yt(e,1,t),np(e,t))}function Sp(e,t,r){if(3===e.tag)kp(e,e,r);else for(;null!==t;){if(3===t.tag){kp(t,e,r);break}if(1===t.tag){var n=t.stateNode;if("function"==typeof t.type.getDerivedStateFromError||"function"==typeof n.componentDidCatch&&(null===Hc||!Hc.has(n))){t=Ni(t,e=ha(t,e=pa(r,e),1),1),e=ep(),null!==t&&(yt(t,1,e),np(t,e));break}}t=t.return}}function Tp(e,t,r){var n=e.pingCache;null!==n&&n.delete(t),t=ep(),e.pingedLanes|=e.suspendedLanes&r,jc===e&&(Pc&r)===r&&(4===qc||3===qc&&(130023424&Pc)===Pc&&500>Je()-Fc?up(e,0):Lc|=r),np(e,t)}function Cp(e,t){0===t&&(1&e.mode?(t=dt,!(130023424&(dt<<=1))&&(dt=4194304)):t=1);var r=ep();null!==(e=$i(e,t))&&(yt(e,t,r),np(e,r))}function Ap(e){var t=e.memoizedState,r=0;null!==t&&(r=t.retryLane),Cp(e,r)}function Ip(e,t){var r=0;switch(e.tag){case 13:var n=e.stateNode,o=e.memoizedState;null!==o&&(r=o.retryLane);break;case 19:n=e.stateNode;break;default:throw Error(i(314))}null!==n&&n.delete(t),Cp(e,r)}function jp(e,t){return Ze(e,t)}function Ep(e,t,r,n){this.tag=e,this.key=r,this.sibling=this.child=this.return=this.stateNode=this.type=this.elementType=null,this.index=0,this.ref=null,this.pendingProps=t,this.dependencies=this.memoizedState=this.updateQueue=this.memoizedProps=null,this.mode=n,this.subtreeFlags=this.flags=0,this.deletions=null,this.childLanes=this.lanes=0,this.alternate=null}function Pp(e,t,r,n){return new Ep(e,t,r,n)}function Rp(e){return!(!(e=e.prototype)||!e.isReactComponent)}function Op(e,t){var r=e.alternate;return null===r?((r=Pp(e.tag,t,e.key,e.mode)).elementType=e.elementType,r.type=e.type,r.stateNode=e.stateNode,r.alternate=e,e.alternate=r):(r.pendingProps=t,r.type=e.type,r.flags=0,r.subtreeFlags=0,r.deletions=null),r.flags=14680064&e.flags,r.childLanes=e.childLanes,r.lanes=e.lanes,r.child=e.child,r.memoizedProps=e.memoizedProps,r.memoizedState=e.memoizedState,r.updateQueue=e.updateQueue,t=e.dependencies,r.dependencies=null===t?null:{lanes:t.lanes,firstContext:t.firstContext},r.sibling=e.sibling,r.index=e.index,r.ref=e.ref,r}function qp(e,t,r,n,o,s){var a=2;if(n=e,"function"==typeof e)Rp(e)&&(a=1);else if("string"==typeof e)a=5;else e:switch(e){case k:return $p(r.children,o,s,t);case S:a=8,o|=8;break;case T:return(e=Pp(12,r,t,2|o)).elementType=T,e.lanes=s,e;case j:return(e=Pp(13,r,t,o)).elementType=j,e.lanes=s,e;case E:return(e=Pp(19,r,t,o)).elementType=E,e.lanes=s,e;case O:return Dp(r,o,s,t);default:if("object"==typeof e&&null!==e)switch(e.$$typeof){case C:a=10;break e;case A:a=9;break e;case I:a=11;break e;case P:a=14;break e;case R:a=16,n=null;break e}throw Error(i(130,null==e?e:typeof e,""))}return(t=Pp(a,r,t,o)).elementType=e,t.type=n,t.lanes=s,t}function $p(e,t,r,n){return(e=Pp(7,e,n,t)).lanes=r,e}function Dp(e,t,r,n){return(e=Pp(22,e,n,t)).elementType=O,e.lanes=r,e.stateNode={isHidden:!1},e}function Bp(e,t,r){return(e=Pp(6,e,null,t)).lanes=r,e}function Lp(e,t,r){return(t=Pp(4,null!==e.children?e.children:[],e.key,t)).lanes=r,t.stateNode={containerInfo:e.containerInfo,pendingChildren:null,implementation:e.implementation},t}function Up(e,t,r,n,o){this.tag=t,this.containerInfo=e,this.finishedWork=this.pingCache=this.current=this.pendingChildren=null,this.timeoutHandle=-1,this.callbackNode=this.pendingContext=this.context=null,this.callbackPriority=0,this.eventTimes=gt(0),this.expirationTimes=gt(-1),this.entangledLanes=this.finishedLanes=this.mutableReadLanes=this.expiredLanes=this.pingedLanes=this.suspendedLanes=this.pendingLanes=0,this.entanglements=gt(0),this.identifierPrefix=n,this.onRecoverableError=o,this.mutableSourceEagerHydrationData=null}function Np(e,t,r,n,o,i,s,a,c){return e=new Up(e,t,r,a,c),1===t?(t=1,!0===i&&(t|=8)):t=0,i=Pp(3,null,null,t),e.current=i,i.stateNode=e,i.memoizedState={element:n,isDehydrated:r,cache:null,transitions:null,pendingSuspenseBoundaries:null},Bi(i),e}function Fp(e){if(!e)return Io;e:{if(Me(e=e._reactInternals)!==e||1!==e.tag)throw Error(i(170));var t=e;do{switch(t.tag){case 3:t=t.stateNode.context;break e;case 1:if(Oo(t.type)){t=t.stateNode.__reactInternalMemoizedMergedChildContext;break e}}t=t.return}while(null!==t);throw Error(i(171))}if(1===e.tag){var r=e.type;if(Oo(r))return Do(e,r,t)}return t}function Mp(e,t,r,n,o,i,s,a,c){return(e=Np(r,n,!0,e,0,i,0,a,c)).context=Fp(null),r=e.current,(i=Ui(n=ep(),o=tp(r))).callback=null!=t?t:null,Ni(r,i,o),e.current.lanes=o,yt(e,o,n),np(e,n),e}function Gp(e,t,r,n){var o=t.current,i=ep(),s=tp(o);return r=Fp(r),null===t.context?t.context=r:t.pendingContext=r,(t=Ui(i,s)).payload={element:e},null!==(n=void 0===n?null:n)&&(t.callback=n),null!==(e=Ni(o,t,s))&&(rp(e,o,s,i),Fi(e,o,s)),s}function zp(e){return(e=e.current).child?(e.child.tag,e.child.stateNode):null}function Wp(e,t){if(null!==(e=e.memoizedState)&&null!==e.dehydrated){var r=e.retryLane;e.retryLane=0!==r&&r<t?r:t}}function Hp(e,t){Wp(e,t),(e=e.alternate)&&Wp(e,t)}kc=function(e,t,r){if(null!==e)if(e.memoizedProps!==t.pendingProps||Eo.current)_a=!0;else{if(!(e.lanes&r||128&t.flags))return _a=!1,function(e,t,r){switch(t.tag){case 3:ja(t),hi();break;case 5:Xi(t);break;case 1:Oo(t.type)&&Bo(t);break;case 4:Yi(t,t.stateNode.containerInfo);break;case 10:var n=t.type._context,o=t.memoizedProps.value;Ao(ki,n._currentValue),n._currentValue=o;break;case 13:if(null!==(n=t.memoizedState))return null!==n.dehydrated?(Ao(es,1&es.current),t.flags|=128,null):r&t.child.childLanes?Ba(e,t,r):(Ao(es,1&es.current),null!==(e=za(e,t,r))?e.sibling:null);Ao(es,1&es.current);break;case 19:if(n=!!(r&t.childLanes),128&e.flags){if(n)return Ma(e,t,r);t.flags|=128}if(null!==(o=t.memoizedState)&&(o.rendering=null,o.tail=null,o.lastEffect=null),Ao(es,es.current),n)break;return null;case 22:case 23:return t.lanes=0,Sa(e,t,r)}return za(e,t,r)}(e,t,r);_a=!!(131072&e.flags)}else _a=!1,ii&&1048576&t.flags&&ei(t,Zo,t.index);switch(t.lanes=0,t.tag){case 2:var n=t.type;Ga(e,t),e=t.pendingProps;var o=Ro(t,jo.current);Ei(t,r),o=gs(null,t,n,e,o,r);var s=ys();return t.flags|=1,"object"==typeof o&&null!==o&&"function"==typeof o.render&&void 0===o.$$typeof?(t.tag=1,t.memoizedState=null,t.updateQueue=null,Oo(n)?(s=!0,Bo(t)):s=!1,t.memoizedState=null!==o.state&&void 0!==o.state?o.state:null,Bi(t),o.updater=oa,t.stateNode=o,o._reactInternals=t,ca(t,n,e,r),t=Ia(null,t,n,!0,s,r)):(t.tag=0,ii&&s&&ti(t),va(null,t,o,r),t=t.child),t;case 16:n=t.elementType;e:{switch(Ga(e,t),e=t.pendingProps,n=(o=n._init)(n._payload),t.type=n,o=t.tag=function(e){if("function"==typeof e)return Rp(e)?1:0;if(null!=e){if((e=e.$$typeof)===I)return 11;if(e===P)return 14}return 2}(n),e=ra(n,e),o){case 0:t=Ca(null,t,n,e,r);break e;case 1:t=Aa(null,t,n,e,r);break e;case 11:t=xa(null,t,n,e,r);break e;case 14:t=wa(null,t,n,ra(n.type,e),r);break e}throw Error(i(306,n,""))}return t;case 0:return n=t.type,o=t.pendingProps,Ca(e,t,n,o=t.elementType===n?o:ra(n,o),r);case 1:return n=t.type,o=t.pendingProps,Aa(e,t,n,o=t.elementType===n?o:ra(n,o),r);case 3:e:{if(ja(t),null===e)throw Error(i(387));n=t.pendingProps,o=(s=t.memoizedState).element,Li(e,t),Gi(t,n,null,r);var a=t.memoizedState;if(n=a.element,s.isDehydrated){if(s={element:n,isDehydrated:!1,cache:a.cache,pendingSuspenseBoundaries:a.pendingSuspenseBoundaries,transitions:a.transitions},t.updateQueue.baseState=s,t.memoizedState=s,256&t.flags){t=Ea(e,t,n,r,o=pa(Error(i(423)),t));break e}if(n!==o){t=Ea(e,t,n,r,o=pa(Error(i(424)),t));break e}for(oi=po(t.stateNode.containerInfo.firstChild),ni=t,ii=!0,si=null,r=wi(t,null,n,r),t.child=r;r;)r.flags=-3&r.flags|4096,r=r.sibling}else{if(hi(),n===o){t=za(e,t,r);break e}va(e,t,n,r)}t=t.child}return t;case 5:return Xi(t),null===e&&di(t),n=t.type,o=t.pendingProps,s=null!==e?e.memoizedProps:null,a=o.children,ro(n,o)?a=null:null!==s&&ro(n,s)&&(t.flags|=32),Ta(e,t),va(e,t,a,r),t.child;case 6:return null===e&&di(t),null;case 13:return Ba(e,t,r);case 4:return Yi(t,t.stateNode.containerInfo),n=t.pendingProps,null===e?t.child=xi(t,null,n,r):va(e,t,n,r),t.child;case 11:return n=t.type,o=t.pendingProps,xa(e,t,n,o=t.elementType===n?o:ra(n,o),r);case 7:return va(e,t,t.pendingProps,r),t.child;case 8:case 12:return va(e,t,t.pendingProps.children,r),t.child;case 10:e:{if(n=t.type._context,o=t.pendingProps,s=t.memoizedProps,a=o.value,Ao(ki,n._currentValue),n._currentValue=a,null!==s)if(an(s.value,a)){if(s.children===o.children&&!Eo.current){t=za(e,t,r);break e}}else for(null!==(s=t.child)&&(s.return=t);null!==s;){var c=s.dependencies;if(null!==c){a=s.child;for(var p=c.firstContext;null!==p;){if(p.context===n){if(1===s.tag){(p=Ui(-1,r&-r)).tag=2;var d=s.updateQueue;if(null!==d){var l=(d=d.shared).pending;null===l?p.next=p:(p.next=l.next,l.next=p),d.pending=p}}s.lanes|=r,null!==(p=s.alternate)&&(p.lanes|=r),ji(s.return,r,t),c.lanes|=r;break}p=p.next}}else if(10===s.tag)a=s.type===t.type?null:s.child;else if(18===s.tag){if(null===(a=s.return))throw Error(i(341));a.lanes|=r,null!==(c=a.alternate)&&(c.lanes|=r),ji(a,r,t),a=s.sibling}else a=s.child;if(null!==a)a.return=s;else for(a=s;null!==a;){if(a===t){a=null;break}if(null!==(s=a.sibling)){s.return=a.return,a=s;break}a=a.return}s=a}va(e,t,o.children,r),t=t.child}return t;case 9:return o=t.type,n=t.pendingProps.children,Ei(t,r),n=n(o=Pi(o)),t.flags|=1,va(e,t,n,r),t.child;case 14:return o=ra(n=t.type,t.pendingProps),wa(e,t,n,o=ra(n.type,o),r);case 15:return ka(e,t,t.type,t.pendingProps,r);case 17:return n=t.type,o=t.pendingProps,o=t.elementType===n?o:ra(n,o),Ga(e,t),t.tag=1,Oo(n)?(e=!0,Bo(t)):e=!1,Ei(t,r),sa(t,n,o),ca(t,n,o,r),Ia(null,t,n,!0,e,r);case 19:return Ma(e,t,r);case 22:return Sa(e,t,r)}throw Error(i(156,t.tag))};var Zp="function"==typeof reportError?reportError:function(e){console.error(e)};function Vp(e){this._internalRoot=e}function Kp(e){this._internalRoot=e}function Yp(e){return!(!e||1!==e.nodeType&&9!==e.nodeType&&11!==e.nodeType)}function Jp(e){return!(!e||1!==e.nodeType&&9!==e.nodeType&&11!==e.nodeType&&(8!==e.nodeType||" react-mount-point-unstable "!==e.nodeValue))}function Xp(){}function Qp(e,t,r,n,o){var i=r._reactRootContainer;if(i){var s=i;if("function"==typeof o){var a=o;o=function(){var e=zp(s);a.call(e)}}Gp(t,s,e,o)}else s=function(e,t,r,n,o){if(o){if("function"==typeof n){var i=n;n=function(){var e=zp(s);i.call(e)}}var s=Mp(t,n,e,0,null,!1,0,"",Xp);return e._reactRootContainer=s,e[fo]=s.current,Mn(8===e.nodeType?e.parentNode:e),dp(),s}for(;o=e.lastChild;)e.removeChild(o);if("function"==typeof n){var a=n;n=function(){var e=zp(c);a.call(e)}}var c=Np(e,0,!1,null,0,!1,0,"",Xp);return e._reactRootContainer=c,e[fo]=c.current,Mn(8===e.nodeType?e.parentNode:e),dp((function(){Gp(t,c,r,n)})),c}(r,t,e,o,n);return zp(s)}Kp.prototype.render=Vp.prototype.render=function(e){var t=this._internalRoot;if(null===t)throw Error(i(409));Gp(e,t,null,null)},Kp.prototype.unmount=Vp.prototype.unmount=function(){var e=this._internalRoot;if(null!==e){this._internalRoot=null;var t=e.containerInfo;dp((function(){Gp(null,e,null,null)})),t[fo]=null}},Kp.prototype.unstable_scheduleHydration=function(e){if(e){var t=St();e={blockedOn:null,target:e,priority:t};for(var r=0;r<Ot.length&&0!==t&&t<Ot[r].priority;r++);Ot.splice(r,0,e),0===r&&Bt(e)}},xt=function(e){switch(e.tag){case 3:var t=e.stateNode;if(t.current.memoizedState.isDehydrated){var r=lt(t.pendingLanes);0!==r&&(bt(t,1|r),np(t,Je()),!(6&Ic)&&(Mc=Je()+500,Go()))}break;case 13:dp((function(){var t=$i(e,1);if(null!==t){var r=ep();rp(t,e,1,r)}})),Hp(e,1)}},wt=function(e){if(13===e.tag){var t=$i(e,134217728);if(null!==t)rp(t,e,134217728,ep());Hp(e,134217728)}},kt=function(e){if(13===e.tag){var t=tp(e),r=$i(e,t);if(null!==r)rp(r,e,t,ep());Hp(e,t)}},St=function(){return _t},Tt=function(e,t){var r=_t;try{return _t=e,t()}finally{_t=r}},we=function(e,t,r){switch(t){case"input":if(X(e,r),t=r.name,"radio"===r.type&&null!=t){for(r=e;r.parentNode;)r=r.parentNode;for(r=r.querySelectorAll("input[name="+JSON.stringify(""+t)+'][type="radio"]'),t=0;t<r.length;t++){var n=r[t];if(n!==e&&n.form===e.form){var o=wo(n);if(!o)throw Error(i(90));Z(n),X(n,o)}}}break;case"textarea":ie(e,r);break;case"select":null!=(t=r.value)&&re(e,!!r.multiple,t,!1)}},Ie=pp,je=dp;var ed={usingClientEntryPoint:!1,Events:[vo,xo,wo,Ce,Ae,pp]},td={findFiberByHostInstance:_o,bundleType:0,version:"18.3.1",rendererPackageName:"react-dom"},rd={bundleType:td.bundleType,version:td.version,rendererPackageName:td.rendererPackageName,rendererConfig:td.rendererConfig,overrideHookState:null,overrideHookStateDeletePath:null,overrideHookStateRenamePath:null,overrideProps:null,overridePropsDeletePath:null,overridePropsRenamePath:null,setErrorHandler:null,setSuspenseHandler:null,scheduleUpdate:null,currentDispatcherRef:v.ReactCurrentDispatcher,findHostInstanceByFiber:function(e){return null===(e=We(e))?null:e.stateNode},findFiberByHostInstance:td.findFiberByHostInstance||function(){return null},findHostInstancesForRefresh:null,scheduleRefresh:null,scheduleRoot:null,setRefreshHandler:null,getCurrentFiber:null,reconcilerVersion:"18.3.1-next-f1338f8080-20240426"};if("undefined"!=typeof __REACT_DEVTOOLS_GLOBAL_HOOK__){var nd=__REACT_DEVTOOLS_GLOBAL_HOOK__;if(!nd.isDisabled&&nd.supportsFiber)try{ot=nd.inject(rd),it=nd}catch(de){}}t.__SECRET_INTERNALS_DO_NOT_USE_OR_YOU_WILL_BE_FIRED=ed,t.createPortal=function(e,t){var r=2<arguments.length&&void 0!==arguments[2]?arguments[2]:null;if(!Yp(t))throw Error(i(200));return function(e,t,r){var n=3<arguments.length&&void 0!==arguments[3]?arguments[3]:null;return{$$typeof:w,key:null==n?null:""+n,children:e,containerInfo:t,implementation:r}}(e,t,null,r)},t.createRoot=function(e,t){if(!Yp(e))throw Error(i(299));var r=!1,n="",o=Zp;return null!=t&&(!0===t.unstable_strictMode&&(r=!0),void 0!==t.identifierPrefix&&(n=t.identifierPrefix),void 0!==t.onRecoverableError&&(o=t.onRecoverableError)),t=Np(e,1,!1,null,0,r,0,n,o),e[fo]=t.current,Mn(8===e.nodeType?e.parentNode:e),new Vp(t)},t.findDOMNode=function(e){if(null==e)return null;if(1===e.nodeType)return e;var t=e._reactInternals;if(void 0===t){if("function"==typeof e.render)throw Error(i(188));throw e=Object.keys(e).join(","),Error(i(268,e))}return e=null===(e=We(t))?null:e.stateNode},t.flushSync=function(e){return dp(e)},t.hydrate=function(e,t,r){if(!Jp(t))throw Error(i(200));return Qp(null,e,t,!0,r)},t.hydrateRoot=function(e,t,r){if(!Yp(e))throw Error(i(405));var n=null!=r&&r.hydratedSources||null,o=!1,s="",a=Zp;if(null!=r&&(!0===r.unstable_strictMode&&(o=!0),void 0!==r.identifierPrefix&&(s=r.identifierPrefix),void 0!==r.onRecoverableError&&(a=r.onRecoverableError)),t=Mp(t,null,e,1,null!=r?r:null,o,0,s,a),e[fo]=t.current,Mn(e),n)for(e=0;e<n.length;e++)o=(o=(r=n[e])._getVersion)(r._source),null==t.mutableSourceEagerHydrationData?t.mutableSourceEagerHydrationData=[r,o]:t.mutableSourceEagerHydrationData.push(r,o);return new Kp(t)},t.render=function(e,t,r){if(!Jp(t))throw Error(i(200));return Qp(null,e,t,!1,r)},t.unmountComponentAtNode=function(e){if(!Jp(e))throw Error(i(40));return!!e._reactRootContainer&&(dp((function(){Qp(null,null,e,!1,(function(){e._reactRootContainer=null,e[fo]=null}))})),!0)},t.unstable_batchedUpdates=pp,t.unstable_renderSubtreeIntoContainer=function(e,t,r,n){if(!Jp(r))throw Error(i(200));if(null==e||void 0===e._reactInternals)throw Error(i(38));return Qp(e,t,r,!1,n)},t.version="18.3.1-next-f1338f8080-20240426"},5338:(e,t,r)=>{"use strict";var n=r(40961);t.createRoot=n.createRoot,t.hydrateRoot=n.hydrateRoot},40961:(e,t,r)=>{"use strict";!function e(){if("undefined"!=typeof __REACT_DEVTOOLS_GLOBAL_HOOK__&&"function"==typeof __REACT_DEVTOOLS_GLOBAL_HOOK__.checkDCE)try{__REACT_DEVTOOLS_GLOBAL_HOOK__.checkDCE(e)}catch(t){console.error(t)}}(),e.exports=r(22551)},30115:e=>{var t="undefined"!=typeof Element,r="function"==typeof Map,n="function"==typeof Set,o="function"==typeof ArrayBuffer&&!!ArrayBuffer.isView;function i(e,s){if(e===s)return!0;if(e&&s&&"object"==typeof e&&"object"==typeof s){if(e.constructor!==s.constructor)return!1;var a,c,p,d;if(Array.isArray(e)){if((a=e.length)!=s.length)return!1;for(c=a;0!=c--;)if(!i(e[c],s[c]))return!1;return!0}if(r&&e instanceof Map&&s instanceof Map){if(e.size!==s.size)return!1;for(d=e.entries();!(c=d.next()).done;)if(!s.has(c.value[0]))return!1;for(d=e.entries();!(c=d.next()).done;)if(!i(c.value[1],s.get(c.value[0])))return!1;return!0}if(n&&e instanceof Set&&s instanceof Set){if(e.size!==s.size)return!1;for(d=e.entries();!(c=d.next()).done;)if(!s.has(c.value[0]))return!1;return!0}if(o&&ArrayBuffer.isView(e)&&ArrayBuffer.isView(s)){if((a=e.length)!=s.length)return!1;for(c=a;0!=c--;)if(e[c]!==s[c])return!1;return!0}if(e.constructor===RegExp)return e.source===s.source&&e.flags===s.flags;if(e.valueOf!==Object.prototype.valueOf&&"function"==typeof e.valueOf&&"function"==typeof s.valueOf)return e.valueOf()===s.valueOf();if(e.toString!==Object.prototype.toString&&"function"==typeof e.toString&&"function"==typeof s.toString)return e.toString()===s.toString();if((a=(p=Object.keys(e)).length)!==Object.keys(s).length)return!1;for(c=a;0!=c--;)if(!Object.prototype.hasOwnProperty.call(s,p[c]))return!1;if(t&&e instanceof Element)return!1;for(c=a;0!=c--;)if(("_owner"!==p[c]&&"__v"!==p[c]&&"__o"!==p[c]||!e.$$typeof)&&!i(e[p[c]],s[p[c]]))return!1;return!0}return e!=e&&s!=s}e.exports=function(e,t){try{return i(e,t)}catch(r){if((r.message||"").match(/stack|recursion/i))return console.warn("react-fast-compare cannot handle circular refs"),!1;throw r}}},80545:(e,t,r)=>{"use strict";r.d(t,{mg:()=>Q,vd:()=>W});var n=r(96540),o=r(5556),i=r.n(o),s=r(30115),a=r.n(s),c=r(20311),p=r.n(c),d=r(2833),l=r.n(d);function u(){return u=Object.assign||function(e){for(var t=1;t<arguments.length;t++){var r=arguments[t];for(var n in r)Object.prototype.hasOwnProperty.call(r,n)&&(e[n]=r[n])}return e},u.apply(this,arguments)}function m(e,t){e.prototype=Object.create(t.prototype),e.prototype.constructor=e,h(e,t)}function h(e,t){return h=Object.setPrototypeOf||function(e,t){return e.__proto__=t,e},h(e,t)}function f(e,t){if(null==e)return{};var r,n,o={},i=Object.keys(e);for(n=0;n<i.length;n++)t.indexOf(r=i[n])>=0||(o[r]=e[r]);return o}var g={BASE:"base",BODY:"body",HEAD:"head",HTML:"html",LINK:"link",META:"meta",NOSCRIPT:"noscript",SCRIPT:"script",STYLE:"style",TITLE:"title",FRAGMENT:"Symbol(react.fragment)"},y={rel:["amphtml","canonical","alternate"]},b={type:["application/ld+json"]},_={charset:"",name:["robots","description"],property:["og:type","og:title","og:url","og:image","og:image:alt","og:description","twitter:url","twitter:title","twitter:description","twitter:image","twitter:image:alt","twitter:card","twitter:site"]},v=Object.keys(g).map((function(e){return g[e]})),x={accesskey:"accessKey",charset:"charSet",class:"className",contenteditable:"contentEditable",contextmenu:"contextMenu","http-equiv":"httpEquiv",itemprop:"itemProp",tabindex:"tabIndex"},w=Object.keys(x).reduce((function(e,t){return e[x[t]]=t,e}),{}),k=function(e,t){for(var r=e.length-1;r>=0;r-=1){var n=e[r];if(Object.prototype.hasOwnProperty.call(n,t))return n[t]}return null},S=function(e){var t=k(e,g.TITLE),r=k(e,"titleTemplate");if(Array.isArray(t)&&(t=t.join("")),r&&t)return r.replace(/%s/g,(function(){return t}));var n=k(e,"defaultTitle");return t||n||void 0},T=function(e){return k(e,"onChangeClientState")||function(){}},C=function(e,t){return t.filter((function(t){return void 0!==t[e]})).map((function(t){return t[e]})).reduce((function(e,t){return u({},e,t)}),{})},A=function(e,t){return t.filter((function(e){return void 0!==e[g.BASE]})).map((function(e){return e[g.BASE]})).reverse().reduce((function(t,r){if(!t.length)for(var n=Object.keys(r),o=0;o<n.length;o+=1){var i=n[o].toLowerCase();if(-1!==e.indexOf(i)&&r[i])return t.concat(r)}return t}),[])},I=function(e,t,r){var n={};return r.filter((function(t){return!!Array.isArray(t[e])||(void 0!==t[e]&&console&&"function"==typeof console.warn&&console.warn("Helmet: "+e+' should be of type "Array". Instead found type "'+typeof t[e]+'"'),!1)})).map((function(t){return t[e]})).reverse().reduce((function(e,r){var o={};r.filter((function(e){for(var r,i=Object.keys(e),s=0;s<i.length;s+=1){var a=i[s],c=a.toLowerCase();-1===t.indexOf(c)||"rel"===r&&"canonical"===e[r].toLowerCase()||"rel"===c&&"stylesheet"===e[c].toLowerCase()||(r=c),-1===t.indexOf(a)||"innerHTML"!==a&&"cssText"!==a&&"itemprop"!==a||(r=a)}if(!r||!e[r])return!1;var p=e[r].toLowerCase();return n[r]||(n[r]={}),o[r]||(o[r]={}),!n[r][p]&&(o[r][p]=!0,!0)})).reverse().forEach((function(t){return e.push(t)}));for(var i=Object.keys(o),s=0;s<i.length;s+=1){var a=i[s],c=u({},n[a],o[a]);n[a]=c}return e}),[]).reverse()},j=function(e,t){if(Array.isArray(e)&&e.length)for(var r=0;r<e.length;r+=1)if(e[r][t])return!0;return!1},E=function(e){return Array.isArray(e)?e.join(""):e},P=function(e,t){return Array.isArray(e)?e.reduce((function(e,r){return function(e,t){for(var r=Object.keys(e),n=0;n<r.length;n+=1)if(t[r[n]]&&t[r[n]].includes(e[r[n]]))return!0;return!1}(r,t)?e.priority.push(r):e.default.push(r),e}),{priority:[],default:[]}):{default:e}},R=function(e,t){var r;return u({},e,((r={})[t]=void 0,r))},O=[g.NOSCRIPT,g.SCRIPT,g.STYLE],q=function(e,t){return void 0===t&&(t=!0),!1===t?String(e):String(e).replace(/&/g,"&amp;").replace(/</g,"&lt;").replace(/>/g,"&gt;").replace(/"/g,"&quot;").replace(/'/g,"&#x27;")},$=function(e){return Object.keys(e).reduce((function(t,r){var n=void 0!==e[r]?r+'="'+e[r]+'"':""+r;return t?t+" "+n:n}),"")},D=function(e,t){return void 0===t&&(t={}),Object.keys(e).reduce((function(t,r){return t[x[r]||r]=e[r],t}),t)},B=function(e,t){return t.map((function(t,r){var o,i=((o={key:r})["data-rh"]=!0,o);return Object.keys(t).forEach((function(e){var r=x[e]||e;"innerHTML"===r||"cssText"===r?i.dangerouslySetInnerHTML={__html:t.innerHTML||t.cssText}:i[r]=t[e]})),n.createElement(e,i)}))},L=function(e,t,r){switch(e){case g.TITLE:return{toComponent:function(){return r=t.titleAttributes,(o={key:e=t.title})["data-rh"]=!0,i=D(r,o),[n.createElement(g.TITLE,i,e)];var e,r,o,i},toString:function(){return function(e,t,r,n){var o=$(r),i=E(t);return o?"<"+e+' data-rh="true" '+o+">"+q(i,n)+"</"+e+">":"<"+e+' data-rh="true">'+q(i,n)+"</"+e+">"}(e,t.title,t.titleAttributes,r)}};case"bodyAttributes":case"htmlAttributes":return{toComponent:function(){return D(t)},toString:function(){return $(t)}};default:return{toComponent:function(){return B(e,t)},toString:function(){return function(e,t,r){return t.reduce((function(t,n){var o=Object.keys(n).filter((function(e){return!("innerHTML"===e||"cssText"===e)})).reduce((function(e,t){var o=void 0===n[t]?t:t+'="'+q(n[t],r)+'"';return e?e+" "+o:o}),""),i=n.innerHTML||n.cssText||"",s=-1===O.indexOf(e);return t+"<"+e+' data-rh="true" '+o+(s?"/>":">"+i+"</"+e+">")}),"")}(e,t,r)}}}},U=function(e){var t=e.baseTag,r=e.bodyAttributes,n=e.encode,o=e.htmlAttributes,i=e.noscriptTags,s=e.styleTags,a=e.title,c=void 0===a?"":a,p=e.titleAttributes,d=e.linkTags,l=e.metaTags,u=e.scriptTags,m={toComponent:function(){},toString:function(){return""}};if(e.prioritizeSeoTags){var h=function(e){var t=e.linkTags,r=e.scriptTags,n=e.encode,o=P(e.metaTags,_),i=P(t,y),s=P(r,b);return{priorityMethods:{toComponent:function(){return[].concat(B(g.META,o.priority),B(g.LINK,i.priority),B(g.SCRIPT,s.priority))},toString:function(){return L(g.META,o.priority,n)+" "+L(g.LINK,i.priority,n)+" "+L(g.SCRIPT,s.priority,n)}},metaTags:o.default,linkTags:i.default,scriptTags:s.default}}(e);m=h.priorityMethods,d=h.linkTags,l=h.metaTags,u=h.scriptTags}return{priority:m,base:L(g.BASE,t,n),bodyAttributes:L("bodyAttributes",r,n),htmlAttributes:L("htmlAttributes",o,n),link:L(g.LINK,d,n),meta:L(g.META,l,n),noscript:L(g.NOSCRIPT,i,n),script:L(g.SCRIPT,u,n),style:L(g.STYLE,s,n),title:L(g.TITLE,{title:c,titleAttributes:p},n)}},N=[],F=function(e,t){var r=this;void 0===t&&(t="undefined"!=typeof document),this.instances=[],this.value={setHelmet:function(e){r.context.helmet=e},helmetInstances:{get:function(){return r.canUseDOM?N:r.instances},add:function(e){(r.canUseDOM?N:r.instances).push(e)},remove:function(e){var t=(r.canUseDOM?N:r.instances).indexOf(e);(r.canUseDOM?N:r.instances).splice(t,1)}}},this.context=e,this.canUseDOM=t,t||(e.helmet=U({baseTag:[],bodyAttributes:{},encodeSpecialCharacters:!0,htmlAttributes:{},linkTags:[],metaTags:[],noscriptTags:[],scriptTags:[],styleTags:[],title:"",titleAttributes:{}}))},M=n.createContext({}),G=i().shape({setHelmet:i().func,helmetInstances:i().shape({get:i().func,add:i().func,remove:i().func})}),z="undefined"!=typeof document,W=function(e){function t(r){var n;return(n=e.call(this,r)||this).helmetData=new F(n.props.context,t.canUseDOM),n}return m(t,e),t.prototype.render=function(){return n.createElement(M.Provider,{value:this.helmetData.value},this.props.children)},t}(n.Component);W.canUseDOM=z,W.propTypes={context:i().shape({helmet:i().shape()}),children:i().node.isRequired},W.defaultProps={context:{}},W.displayName="HelmetProvider";var H=function(e,t){var r,n=document.head||document.querySelector(g.HEAD),o=n.querySelectorAll(e+"[data-rh]"),i=[].slice.call(o),s=[];return t&&t.length&&t.forEach((function(t){var n=document.createElement(e);for(var o in t)Object.prototype.hasOwnProperty.call(t,o)&&("innerHTML"===o?n.innerHTML=t.innerHTML:"cssText"===o?n.styleSheet?n.styleSheet.cssText=t.cssText:n.appendChild(document.createTextNode(t.cssText)):n.setAttribute(o,void 0===t[o]?"":t[o]));n.setAttribute("data-rh","true"),i.some((function(e,t){return r=t,n.isEqualNode(e)}))?i.splice(r,1):s.push(n)})),i.forEach((function(e){return e.parentNode.removeChild(e)})),s.forEach((function(e){return n.appendChild(e)})),{oldTags:i,newTags:s}},Z=function(e,t){var r=document.getElementsByTagName(e)[0];if(r){for(var n=r.getAttribute("data-rh"),o=n?n.split(","):[],i=[].concat(o),s=Object.keys(t),a=0;a<s.length;a+=1){var c=s[a],p=t[c]||"";r.getAttribute(c)!==p&&r.setAttribute(c,p),-1===o.indexOf(c)&&o.push(c);var d=i.indexOf(c);-1!==d&&i.splice(d,1)}for(var l=i.length-1;l>=0;l-=1)r.removeAttribute(i[l]);o.length===i.length?r.removeAttribute("data-rh"):r.getAttribute("data-rh")!==s.join(",")&&r.setAttribute("data-rh",s.join(","))}},V=function(e,t){var r=e.baseTag,n=e.htmlAttributes,o=e.linkTags,i=e.metaTags,s=e.noscriptTags,a=e.onChangeClientState,c=e.scriptTags,p=e.styleTags,d=e.title,l=e.titleAttributes;Z(g.BODY,e.bodyAttributes),Z(g.HTML,n),function(e,t){void 0!==e&&document.title!==e&&(document.title=E(e)),Z(g.TITLE,t)}(d,l);var u={baseTag:H(g.BASE,r),linkTags:H(g.LINK,o),metaTags:H(g.META,i),noscriptTags:H(g.NOSCRIPT,s),scriptTags:H(g.SCRIPT,c),styleTags:H(g.STYLE,p)},m={},h={};Object.keys(u).forEach((function(e){var t=u[e],r=t.newTags,n=t.oldTags;r.length&&(m[e]=r),n.length&&(h[e]=u[e].oldTags)})),t&&t(),a(e,m,h)},K=null,Y=function(e){function t(){for(var t,r=arguments.length,n=new Array(r),o=0;o<r;o++)n[o]=arguments[o];return(t=e.call.apply(e,[this].concat(n))||this).rendered=!1,t}m(t,e);var r=t.prototype;return r.shouldComponentUpdate=function(e){return!l()(e,this.props)},r.componentDidUpdate=function(){this.emitChange()},r.componentWillUnmount=function(){this.props.context.helmetInstances.remove(this),this.emitChange()},r.emitChange=function(){var e,t,r=this.props.context,n=r.setHelmet,o=null,i=(e=r.helmetInstances.get().map((function(e){var t=u({},e.props);return delete t.context,t})),{baseTag:A(["href"],e),bodyAttributes:C("bodyAttributes",e),defer:k(e,"defer"),encode:k(e,"encodeSpecialCharacters"),htmlAttributes:C("htmlAttributes",e),linkTags:I(g.LINK,["rel","href"],e),metaTags:I(g.META,["name","charset","http-equiv","property","itemprop"],e),noscriptTags:I(g.NOSCRIPT,["innerHTML"],e),onChangeClientState:T(e),scriptTags:I(g.SCRIPT,["src","innerHTML"],e),styleTags:I(g.STYLE,["cssText"],e),title:S(e),titleAttributes:C("titleAttributes",e),prioritizeSeoTags:j(e,"prioritizeSeoTags")});W.canUseDOM?(t=i,K&&cancelAnimationFrame(K),t.defer?K=requestAnimationFrame((function(){V(t,(function(){K=null}))})):(V(t),K=null)):U&&(o=U(i)),n(o)},r.init=function(){this.rendered||(this.rendered=!0,this.props.context.helmetInstances.add(this),this.emitChange())},r.render=function(){return this.init(),null},t}(n.Component);Y.propTypes={context:G.isRequired},Y.displayName="HelmetDispatcher";var J=["children"],X=["children"],Q=function(e){function t(){return e.apply(this,arguments)||this}m(t,e);var r=t.prototype;return r.shouldComponentUpdate=function(e){return!a()(R(this.props,"helmetData"),R(e,"helmetData"))},r.mapNestedChildrenToProps=function(e,t){if(!t)return null;switch(e.type){case g.SCRIPT:case g.NOSCRIPT:return{innerHTML:t};case g.STYLE:return{cssText:t};default:throw new Error("<"+e.type+" /> elements are self-closing and can not contain children. Refer to our API for more information.")}},r.flattenArrayTypeChildren=function(e){var t,r=e.child,n=e.arrayTypeChildren;return u({},n,((t={})[r.type]=[].concat(n[r.type]||[],[u({},e.newChildProps,this.mapNestedChildrenToProps(r,e.nestedChildren))]),t))},r.mapObjectTypeChildren=function(e){var t,r,n=e.child,o=e.newProps,i=e.newChildProps,s=e.nestedChildren;switch(n.type){case g.TITLE:return u({},o,((t={})[n.type]=s,t.titleAttributes=u({},i),t));case g.BODY:return u({},o,{bodyAttributes:u({},i)});case g.HTML:return u({},o,{htmlAttributes:u({},i)});default:return u({},o,((r={})[n.type]=u({},i),r))}},r.mapArrayTypeChildrenToProps=function(e,t){var r=u({},t);return Object.keys(e).forEach((function(t){var n;r=u({},r,((n={})[t]=e[t],n))})),r},r.warnOnInvalidChildren=function(e,t){return p()(v.some((function(t){return e.type===t})),"function"==typeof e.type?"You may be attempting to nest <Helmet> components within each other, which is not allowed. Refer to our API for more information.":"Only elements types "+v.join(", ")+" are allowed. Helmet does not support rendering <"+e.type+"> elements. Refer to our API for more information."),p()(!t||"string"==typeof t||Array.isArray(t)&&!t.some((function(e){return"string"!=typeof e})),"Helmet expects a string as a child of <"+e.type+">. Did you forget to wrap your children in braces? ( <"+e.type+">{``}</"+e.type+"> ) Refer to our API for more information."),!0},r.mapChildrenToProps=function(e,t){var r=this,o={};return n.Children.forEach(e,(function(e){if(e&&e.props){var n=e.props,i=n.children,s=f(n,J),a=Object.keys(s).reduce((function(e,t){return e[w[t]||t]=s[t],e}),{}),c=e.type;switch("symbol"==typeof c?c=c.toString():r.warnOnInvalidChildren(e,i),c){case g.FRAGMENT:t=r.mapChildrenToProps(i,t);break;case g.LINK:case g.META:case g.NOSCRIPT:case g.SCRIPT:case g.STYLE:o=r.flattenArrayTypeChildren({child:e,arrayTypeChildren:o,newChildProps:a,nestedChildren:i});break;default:t=r.mapObjectTypeChildren({child:e,newProps:t,newChildProps:a,nestedChildren:i})}}})),this.mapArrayTypeChildrenToProps(o,t)},r.render=function(){var e=this.props,t=e.children,r=f(e,X),o=u({},r),i=r.helmetData;return t&&(o=this.mapChildrenToProps(t,o)),!i||i instanceof F||(i=new F(i.context,i.instances)),i?n.createElement(Y,u({},o,{context:i.value,helmetData:void 0})):n.createElement(M.Consumer,null,(function(e){return n.createElement(Y,u({},o,{context:e}))}))},t}(n.Component);Q.propTypes={base:i().object,bodyAttributes:i().object,children:i().oneOfType([i().arrayOf(i().node),i().node]),defaultTitle:i().string,defer:i().bool,encodeSpecialCharacters:i().bool,htmlAttributes:i().object,link:i().arrayOf(i().object),meta:i().arrayOf(i().object),noscript:i().arrayOf(i().object),onChangeClientState:i().func,script:i().arrayOf(i().object),style:i().arrayOf(i().object),title:i().string,titleAttributes:i().object,titleTemplate:i().string,prioritizeSeoTags:i().bool,helmetData:i().object},Q.defaultProps={defer:!0,encodeSpecialCharacters:!0,prioritizeSeoTags:!1},Q.displayName="Helmet"},22799:(e,t)=>{"use strict";var r="function"==typeof Symbol&&Symbol.for,n=r?Symbol.for("react.element"):60103,o=r?Symbol.for("react.portal"):60106,i=r?Symbol.for("react.fragment"):60107,s=r?Symbol.for("react.strict_mode"):60108,a=r?Symbol.for("react.profiler"):60114,c=r?Symbol.for("react.provider"):60109,p=r?Symbol.for("react.context"):60110,d=r?Symbol.for("react.async_mode"):60111,l=r?Symbol.for("react.concurrent_mode"):60111,u=r?Symbol.for("react.forward_ref"):60112,m=r?Symbol.for("react.suspense"):60113,h=r?Symbol.for("react.suspense_list"):60120,f=r?Symbol.for("react.memo"):60115,g=r?Symbol.for("react.lazy"):60116,y=r?Symbol.for("react.block"):60121,b=r?Symbol.for("react.fundamental"):60117,_=r?Symbol.for("react.responder"):60118,v=r?Symbol.for("react.scope"):60119;function x(e){if("object"==typeof e&&null!==e){var t=e.$$typeof;switch(t){case n:switch(e=e.type){case d:case l:case i:case a:case s:case m:return e;default:switch(e=e&&e.$$typeof){case p:case u:case g:case f:case c:return e;default:return t}}case o:return t}}}function w(e){return x(e)===l}t.AsyncMode=d,t.ConcurrentMode=l,t.ContextConsumer=p,t.ContextProvider=c,t.Element=n,t.ForwardRef=u,t.Fragment=i,t.Lazy=g,t.Memo=f,t.Portal=o,t.Profiler=a,t.StrictMode=s,t.Suspense=m,t.isAsyncMode=function(e){return w(e)||x(e)===d},t.isConcurrentMode=w,t.isContextConsumer=function(e){return x(e)===p},t.isContextProvider=function(e){return x(e)===c},t.isElement=function(e){return"object"==typeof e&&null!==e&&e.$$typeof===n},t.isForwardRef=function(e){return x(e)===u},t.isFragment=function(e){return x(e)===i},t.isLazy=function(e){return x(e)===g},t.isMemo=function(e){return x(e)===f},t.isPortal=function(e){return x(e)===o},t.isProfiler=function(e){return x(e)===a},t.isStrictMode=function(e){return x(e)===s},t.isSuspense=function(e){return x(e)===m},t.isValidElementType=function(e){return"string"==typeof e||"function"==typeof e||e===i||e===l||e===a||e===s||e===m||e===h||"object"==typeof e&&null!==e&&(e.$$typeof===g||e.$$typeof===f||e.$$typeof===c||e.$$typeof===p||e.$$typeof===u||e.$$typeof===b||e.$$typeof===_||e.$$typeof===v||e.$$typeof===y)},t.typeOf=x},44363:(e,t,r)=>{"use strict";e.exports=r(22799)},53259:(e,t,r)=>{"use strict";function n(e,t){e.prototype=Object.create(t.prototype),e.prototype.constructor=e,e.__proto__=t}function o(e){if(void 0===e)throw new ReferenceError("this hasn't been initialised - super() hasn't been called");return e}function i(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function s(){return s=Object.assign||function(e){for(var t=1;t<arguments.length;t++){var r=arguments[t];for(var n in r)Object.prototype.hasOwnProperty.call(r,n)&&(e[n]=r[n])}return e},s.apply(this,arguments)}var a=r(96540),c=[],p=[];var d=a.createContext(null);function l(e){var t=e(),r={loading:!0,loaded:null,error:null};return r.promise=t.then((function(e){return r.loading=!1,r.loaded=e,e})).catch((function(e){throw r.loading=!1,r.error=e,e})),r}function u(e){var t={loading:!1,loaded:{},error:null},r=[];try{Object.keys(e).forEach((function(n){var o=l(e[n]);o.loading?t.loading=!0:(t.loaded[n]=o.loaded,t.error=o.error),r.push(o.promise),o.promise.then((function(e){t.loaded[n]=e})).catch((function(e){t.error=e}))}))}catch(n){t.error=n}return t.promise=Promise.all(r).then((function(e){return t.loading=!1,e})).catch((function(e){throw t.loading=!1,e})),t}function m(e,t){return a.createElement((r=e)&&r.__esModule?r.default:r,t);var r}function h(e,t){var l,u;if(!t.loading)throw new Error("react-loadable requires a `loading` component");var h=s({loader:null,loading:null,delay:200,timeout:null,render:m,webpack:null,modules:null},t),f=null;function g(){return f||(f=e(h.loader)),f.promise}return c.push(g),"function"==typeof h.webpack&&p.push((function(){if((0,h.webpack)().every((function(e){return void 0!==e&&void 0!==r.m[e]})))return g()})),u=l=function(t){function r(r){var n;return i(o(o(n=t.call(this,r)||this)),"retry",(function(){n.setState({error:null,loading:!0,timedOut:!1}),f=e(h.loader),n._loadModule()})),g(),n.state={error:f.error,pastDelay:!1,timedOut:!1,loading:f.loading,loaded:f.loaded},n}n(r,t),r.preload=function(){return g()};var s=r.prototype;return s.UNSAFE_componentWillMount=function(){this._loadModule()},s.componentDidMount=function(){this._mounted=!0},s._loadModule=function(){var e=this;if(this.context&&Array.isArray(h.modules)&&h.modules.forEach((function(t){e.context.report(t)})),f.loading){var t=function(t){e._mounted&&e.setState(t)};"number"==typeof h.delay&&(0===h.delay?this.setState({pastDelay:!0}):this._delay=setTimeout((function(){t({pastDelay:!0})}),h.delay)),"number"==typeof h.timeout&&(this._timeout=setTimeout((function(){t({timedOut:!0})}),h.timeout));var r=function(){t({error:f.error,loaded:f.loaded,loading:f.loading}),e._clearTimeouts()};f.promise.then((function(){return r(),null})).catch((function(e){return r(),null}))}},s.componentWillUnmount=function(){this._mounted=!1,this._clearTimeouts()},s._clearTimeouts=function(){clearTimeout(this._delay),clearTimeout(this._timeout)},s.render=function(){return this.state.loading||this.state.error?a.createElement(h.loading,{isLoading:this.state.loading,pastDelay:this.state.pastDelay,timedOut:this.state.timedOut,error:this.state.error,retry:this.retry}):this.state.loaded?h.render(this.state.loaded,this.props):null},r}(a.Component),i(l,"contextType",d),u}function f(e){return h(l,e)}f.Map=function(e){if("function"!=typeof e.render)throw new Error("LoadableMap requires a `render(loaded, props)` function");return h(u,e)};var g=function(e){function t(){return e.apply(this,arguments)||this}return n(t,e),t.prototype.render=function(){return a.createElement(d.Provider,{value:{report:this.props.report}},a.Children.only(this.props.children))},t}(a.Component);function y(e){for(var t=[];e.length;){var r=e.pop();t.push(r())}return Promise.all(t).then((function(){if(e.length)return y(e)}))}f.Capture=g,f.preloadAll=function(){return new Promise((function(e,t){y(c).then(e,t)}))},f.preloadReady=function(){return new Promise((function(e,t){y(p).then(e,e)}))},e.exports=f},22831:(e,t,r)=>{"use strict";r.d(t,{u:()=>s,v:()=>a});var n=r(56347),o=r(58168),i=r(96540);function s(e,t,r){return void 0===r&&(r=[]),e.some((function(e){var o=e.path?(0,n.B6)(t,e):r.length?r[r.length-1].match:n.Ix.computeRootMatch(t);return o&&(r.push({route:e,match:o}),e.routes&&s(e.routes,t,r)),o})),r}function a(e,t,r){return void 0===t&&(t={}),void 0===r&&(r={}),e?i.createElement(n.dO,r,e.map((function(e,r){return i.createElement(n.qh,{key:e.key||r,path:e.path,exact:e.exact,strict:e.strict,render:function(r){return e.render?e.render((0,o.A)({},r,{},t,{route:e})):i.createElement(e.component,(0,o.A)({},r,t,{route:e}))}})}))):null}},54625:(e,t,r)=>{"use strict";r.d(t,{I9:()=>l,Kd:()=>d,N_:()=>y,k2:()=>v});var n=r(56347),o=r(77387),i=r(96540),s=r(31513),a=r(58168),c=r(98587),p=r(11561),d=function(e){function t(){for(var t,r=arguments.length,n=new Array(r),o=0;o<r;o++)n[o]=arguments[o];return(t=e.call.apply(e,[this].concat(n))||this).history=(0,s.zR)(t.props),t}return(0,o.A)(t,e),t.prototype.render=function(){return i.createElement(n.Ix,{history:this.history,children:this.props.children})},t}(i.Component);var l=function(e){function t(){for(var t,r=arguments.length,n=new Array(r),o=0;o<r;o++)n[o]=arguments[o];return(t=e.call.apply(e,[this].concat(n))||this).history=(0,s.TM)(t.props),t}return(0,o.A)(t,e),t.prototype.render=function(){return i.createElement(n.Ix,{history:this.history,children:this.props.children})},t}(i.Component);var u=function(e,t){return"function"==typeof e?e(t):e},m=function(e,t){return"string"==typeof e?(0,s.yJ)(e,null,null,t):e},h=function(e){return e},f=i.forwardRef;void 0===f&&(f=h);var g=f((function(e,t){var r=e.innerRef,n=e.navigate,o=e.onClick,s=(0,c.A)(e,["innerRef","navigate","onClick"]),p=s.target,d=(0,a.A)({},s,{onClick:function(e){try{o&&o(e)}catch(t){throw e.preventDefault(),t}e.defaultPrevented||0!==e.button||p&&"_self"!==p||function(e){return!!(e.metaKey||e.altKey||e.ctrlKey||e.shiftKey)}(e)||(e.preventDefault(),n())}});return d.ref=h!==f&&t||r,i.createElement("a",d)}));var y=f((function(e,t){var r=e.component,o=void 0===r?g:r,d=e.replace,l=e.to,y=e.innerRef,b=(0,c.A)(e,["component","replace","to","innerRef"]);return i.createElement(n.XZ.Consumer,null,(function(e){e||(0,p.A)(!1);var r=e.history,n=m(u(l,e.location),e.location),c=n?r.createHref(n):"",g=(0,a.A)({},b,{href:c,navigate:function(){var t=u(l,e.location),n=(0,s.AO)(e.location)===(0,s.AO)(m(t));(d||n?r.replace:r.push)(t)}});return h!==f?g.ref=t||y:g.innerRef=y,i.createElement(o,g)}))})),b=function(e){return e},_=i.forwardRef;void 0===_&&(_=b);var v=_((function(e,t){var r=e["aria-current"],o=void 0===r?"page":r,s=e.activeClassName,d=void 0===s?"active":s,l=e.activeStyle,h=e.className,f=e.exact,g=e.isActive,v=e.location,x=e.sensitive,w=e.strict,k=e.style,S=e.to,T=e.innerRef,C=(0,c.A)(e,["aria-current","activeClassName","activeStyle","className","exact","isActive","location","sensitive","strict","style","to","innerRef"]);return i.createElement(n.XZ.Consumer,null,(function(e){e||(0,p.A)(!1);var r=v||e.location,s=m(u(S,r),r),c=s.pathname,A=c&&c.replace(/([.+*?=^!:${}()[\]|/\\])/g,"\\$1"),I=A?(0,n.B6)(r.pathname,{path:A,exact:f,sensitive:x,strict:w}):null,j=!!(g?g(I,r):I),E="function"==typeof h?h(j):h,P="function"==typeof k?k(j):k;j&&(E=function(){for(var e=arguments.length,t=new Array(e),r=0;r<e;r++)t[r]=arguments[r];return t.filter((function(e){return e})).join(" ")}(E,d),P=(0,a.A)({},P,l));var R=(0,a.A)({"aria-current":j&&o||null,className:E,style:P,to:s},C);return b!==_?R.ref=t||T:R.innerRef=T,i.createElement(y,R)}))}))},56347:(e,t,r)=>{"use strict";r.d(t,{B6:()=>k,Ix:()=>_,W6:()=>R,XZ:()=>b,dO:()=>E,qh:()=>S,zy:()=>O});var n=r(77387),o=r(96540),i=r(5556),s=r.n(i),a=r(31513),c=r(11561),p=r(58168),d=r(35302),l=r.n(d),u=(r(44363),r(98587)),m=(r(4146),1073741823),h="undefined"!=typeof globalThis?globalThis:"undefined"!=typeof window?window:void 0!==r.g?r.g:{};var f=o.createContext||function(e,t){var r,i,a="__create-react-context-"+function(){var e="__global_unique_id__";return h[e]=(h[e]||0)+1}()+"__",c=function(e){function r(){for(var t,r,n,o=arguments.length,i=new Array(o),s=0;s<o;s++)i[s]=arguments[s];return(t=e.call.apply(e,[this].concat(i))||this).emitter=(r=t.props.value,n=[],{on:function(e){n.push(e)},off:function(e){n=n.filter((function(t){return t!==e}))},get:function(){return r},set:function(e,t){r=e,n.forEach((function(e){return e(r,t)}))}}),t}(0,n.A)(r,e);var o=r.prototype;return o.getChildContext=function(){var e;return(e={})[a]=this.emitter,e},o.componentWillReceiveProps=function(e){if(this.props.value!==e.value){var r,n=this.props.value,o=e.value;((i=n)===(s=o)?0!==i||1/i==1/s:i!=i&&s!=s)?r=0:(r="function"==typeof t?t(n,o):m,0!==(r|=0)&&this.emitter.set(e.value,r))}var i,s},o.render=function(){return this.props.children},r}(o.Component);c.childContextTypes=((r={})[a]=s().object.isRequired,r);var p=function(t){function r(){for(var e,r=arguments.length,n=new Array(r),o=0;o<r;o++)n[o]=arguments[o];return(e=t.call.apply(t,[this].concat(n))||this).observedBits=void 0,e.state={value:e.getValue()},e.onUpdate=function(t,r){(0|e.observedBits)&r&&e.setState({value:e.getValue()})},e}(0,n.A)(r,t);var o=r.prototype;return o.componentWillReceiveProps=function(e){var t=e.observedBits;this.observedBits=null==t?m:t},o.componentDidMount=function(){this.context[a]&&this.context[a].on(this.onUpdate);var e=this.props.observedBits;this.observedBits=null==e?m:e},o.componentWillUnmount=function(){this.context[a]&&this.context[a].off(this.onUpdate)},o.getValue=function(){return this.context[a]?this.context[a].get():e},o.render=function(){return(e=this.props.children,Array.isArray(e)?e[0]:e)(this.state.value);var e},r}(o.Component);return p.contextTypes=((i={})[a]=s().object,i),{Provider:c,Consumer:p}},g=function(e){var t=f();return t.displayName=e,t},y=g("Router-History"),b=g("Router"),_=function(e){function t(t){var r;return(r=e.call(this,t)||this).state={location:t.history.location},r._isMounted=!1,r._pendingLocation=null,t.staticContext||(r.unlisten=t.history.listen((function(e){r._pendingLocation=e}))),r}(0,n.A)(t,e),t.computeRootMatch=function(e){return{path:"/",url:"/",params:{},isExact:"/"===e}};var r=t.prototype;return r.componentDidMount=function(){var e=this;this._isMounted=!0,this.unlisten&&this.unlisten(),this.props.staticContext||(this.unlisten=this.props.history.listen((function(t){e._isMounted&&e.setState({location:t})}))),this._pendingLocation&&this.setState({location:this._pendingLocation})},r.componentWillUnmount=function(){this.unlisten&&(this.unlisten(),this._isMounted=!1,this._pendingLocation=null)},r.render=function(){return o.createElement(b.Provider,{value:{history:this.props.history,location:this.state.location,match:t.computeRootMatch(this.state.location.pathname),staticContext:this.props.staticContext}},o.createElement(y.Provider,{children:this.props.children||null,value:this.props.history}))},t}(o.Component);o.Component;o.Component;var v={},x=1e4,w=0;function k(e,t){void 0===t&&(t={}),("string"==typeof t||Array.isArray(t))&&(t={path:t});var r=t,n=r.path,o=r.exact,i=void 0!==o&&o,s=r.strict,a=void 0!==s&&s,c=r.sensitive,p=void 0!==c&&c;return[].concat(n).reduce((function(t,r){if(!r&&""!==r)return null;if(t)return t;var n=function(e,t){var r=""+t.end+t.strict+t.sensitive,n=v[r]||(v[r]={});if(n[e])return n[e];var o=[],i={regexp:l()(e,o,t),keys:o};return w<x&&(n[e]=i,w++),i}(r,{end:i,strict:a,sensitive:p}),o=n.regexp,s=n.keys,c=o.exec(e);if(!c)return null;var d=c[0],u=c.slice(1),m=e===d;return i&&!m?null:{path:r,url:"/"===r&&""===d?"/":d,isExact:m,params:s.reduce((function(e,t,r){return e[t.name]=u[r],e}),{})}}),null)}var S=function(e){function t(){return e.apply(this,arguments)||this}return(0,n.A)(t,e),t.prototype.render=function(){var e=this;return o.createElement(b.Consumer,null,(function(t){t||(0,c.A)(!1);var r=e.props.location||t.location,n=e.props.computedMatch?e.props.computedMatch:e.props.path?k(r.pathname,e.props):t.match,i=(0,p.A)({},t,{location:r,match:n}),s=e.props,a=s.children,d=s.component,l=s.render;return Array.isArray(a)&&function(e){return 0===o.Children.count(e)}(a)&&(a=null),o.createElement(b.Provider,{value:i},i.match?a?"function"==typeof a?a(i):a:d?o.createElement(d,i):l?l(i):null:"function"==typeof a?a(i):null)}))},t}(o.Component);function T(e){return"/"===e.charAt(0)?e:"/"+e}function C(e,t){if(!e)return t;var r=T(e);return 0!==t.pathname.indexOf(r)?t:(0,p.A)({},t,{pathname:t.pathname.substr(r.length)})}function A(e){return"string"==typeof e?e:(0,a.AO)(e)}function I(e){return function(){(0,c.A)(!1)}}function j(){}o.Component;var E=function(e){function t(){return e.apply(this,arguments)||this}return(0,n.A)(t,e),t.prototype.render=function(){var e=this;return o.createElement(b.Consumer,null,(function(t){t||(0,c.A)(!1);var r,n,i=e.props.location||t.location;return o.Children.forEach(e.props.children,(function(e){if(null==n&&o.isValidElement(e)){r=e;var s=e.props.path||e.props.from;n=s?k(i.pathname,(0,p.A)({},e.props,{path:s})):t.match}})),n?o.cloneElement(r,{location:i,computedMatch:n}):null}))},t}(o.Component);var P=o.useContext;function R(){return P(y)}function O(){return P(b).location}},21020:(e,t,r)=>{"use strict";var n=r(96540),o=Symbol.for("react.element"),i=Symbol.for("react.fragment"),s=Object.prototype.hasOwnProperty,a=n.__SECRET_INTERNALS_DO_NOT_USE_OR_YOU_WILL_BE_FIRED.ReactCurrentOwner,c={key:!0,ref:!0,__self:!0,__source:!0};function p(e,t,r){var n,i={},p=null,d=null;for(n in void 0!==r&&(p=""+r),void 0!==t.key&&(p=""+t.key),void 0!==t.ref&&(d=t.ref),t)s.call(t,n)&&!c.hasOwnProperty(n)&&(i[n]=t[n]);if(e&&e.defaultProps)for(n in t=e.defaultProps)void 0===i[n]&&(i[n]=t[n]);return{$$typeof:o,type:e,key:p,ref:d,props:i,_owner:a.current}}t.Fragment=i,t.jsx=p,t.jsxs=p},15287:(e,t)=>{"use strict";var r=Symbol.for("react.element"),n=Symbol.for("react.portal"),o=Symbol.for("react.fragment"),i=Symbol.for("react.strict_mode"),s=Symbol.for("react.profiler"),a=Symbol.for("react.provider"),c=Symbol.for("react.context"),p=Symbol.for("react.forward_ref"),d=Symbol.for("react.suspense"),l=Symbol.for("react.memo"),u=Symbol.for("react.lazy"),m=Symbol.iterator;var h={isMounted:function(){return!1},enqueueForceUpdate:function(){},enqueueReplaceState:function(){},enqueueSetState:function(){}},f=Object.assign,g={};function y(e,t,r){this.props=e,this.context=t,this.refs=g,this.updater=r||h}function b(){}function _(e,t,r){this.props=e,this.context=t,this.refs=g,this.updater=r||h}y.prototype.isReactComponent={},y.prototype.setState=function(e,t){if("object"!=typeof e&&"function"!=typeof e&&null!=e)throw Error("setState(...): takes an object of state variables to update or a function which returns an object of state variables.");this.updater.enqueueSetState(this,e,t,"setState")},y.prototype.forceUpdate=function(e){this.updater.enqueueForceUpdate(this,e,"forceUpdate")},b.prototype=y.prototype;var v=_.prototype=new b;v.constructor=_,f(v,y.prototype),v.isPureReactComponent=!0;var x=Array.isArray,w=Object.prototype.hasOwnProperty,k={current:null},S={key:!0,ref:!0,__self:!0,__source:!0};function T(e,t,n){var o,i={},s=null,a=null;if(null!=t)for(o in void 0!==t.ref&&(a=t.ref),void 0!==t.key&&(s=""+t.key),t)w.call(t,o)&&!S.hasOwnProperty(o)&&(i[o]=t[o]);var c=arguments.length-2;if(1===c)i.children=n;else if(1<c){for(var p=Array(c),d=0;d<c;d++)p[d]=arguments[d+2];i.children=p}if(e&&e.defaultProps)for(o in c=e.defaultProps)void 0===i[o]&&(i[o]=c[o]);return{$$typeof:r,type:e,key:s,ref:a,props:i,_owner:k.current}}function C(e){return"object"==typeof e&&null!==e&&e.$$typeof===r}var A=/\/+/g;function I(e,t){return"object"==typeof e&&null!==e&&null!=e.key?function(e){var t={"=":"=0",":":"=2"};return"$"+e.replace(/[=:]/g,(function(e){return t[e]}))}(""+e.key):t.toString(36)}function j(e,t,o,i,s){var a=typeof e;"undefined"!==a&&"boolean"!==a||(e=null);var c=!1;if(null===e)c=!0;else switch(a){case"string":case"number":c=!0;break;case"object":switch(e.$$typeof){case r:case n:c=!0}}if(c)return s=s(c=e),e=""===i?"."+I(c,0):i,x(s)?(o="",null!=e&&(o=e.replace(A,"$&/")+"/"),j(s,t,o,"",(function(e){return e}))):null!=s&&(C(s)&&(s=function(e,t){return{$$typeof:r,type:e.type,key:t,ref:e.ref,props:e.props,_owner:e._owner}}(s,o+(!s.key||c&&c.key===s.key?"":(""+s.key).replace(A,"$&/")+"/")+e)),t.push(s)),1;if(c=0,i=""===i?".":i+":",x(e))for(var p=0;p<e.length;p++){var d=i+I(a=e[p],p);c+=j(a,t,o,d,s)}else if(d=function(e){return null===e||"object"!=typeof e?null:"function"==typeof(e=m&&e[m]||e["@@iterator"])?e:null}(e),"function"==typeof d)for(e=d.call(e),p=0;!(a=e.next()).done;)c+=j(a=a.value,t,o,d=i+I(a,p++),s);else if("object"===a)throw t=String(e),Error("Objects are not valid as a React child (found: "+("[object Object]"===t?"object with keys {"+Object.keys(e).join(", ")+"}":t)+"). If you meant to render a collection of children, use an array instead.");return c}function E(e,t,r){if(null==e)return e;var n=[],o=0;return j(e,n,"","",(function(e){return t.call(r,e,o++)})),n}function P(e){if(-1===e._status){var t=e._result;(t=t()).then((function(t){0!==e._status&&-1!==e._status||(e._status=1,e._result=t)}),(function(t){0!==e._status&&-1!==e._status||(e._status=2,e._result=t)})),-1===e._status&&(e._status=0,e._result=t)}if(1===e._status)return e._result.default;throw e._result}var R={current:null},O={transition:null},q={ReactCurrentDispatcher:R,ReactCurrentBatchConfig:O,ReactCurrentOwner:k};function $(){throw Error("act(...) is not supported in production builds of React.")}t.Children={map:E,forEach:function(e,t,r){E(e,(function(){t.apply(this,arguments)}),r)},count:function(e){var t=0;return E(e,(function(){t++})),t},toArray:function(e){return E(e,(function(e){return e}))||[]},only:function(e){if(!C(e))throw Error("React.Children.only expected to receive a single React element child.");return e}},t.Component=y,t.Fragment=o,t.Profiler=s,t.PureComponent=_,t.StrictMode=i,t.Suspense=d,t.__SECRET_INTERNALS_DO_NOT_USE_OR_YOU_WILL_BE_FIRED=q,t.act=$,t.cloneElement=function(e,t,n){if(null==e)throw Error("React.cloneElement(...): The argument must be a React element, but you passed "+e+".");var o=f({},e.props),i=e.key,s=e.ref,a=e._owner;if(null!=t){if(void 0!==t.ref&&(s=t.ref,a=k.current),void 0!==t.key&&(i=""+t.key),e.type&&e.type.defaultProps)var c=e.type.defaultProps;for(p in t)w.call(t,p)&&!S.hasOwnProperty(p)&&(o[p]=void 0===t[p]&&void 0!==c?c[p]:t[p])}var p=arguments.length-2;if(1===p)o.children=n;else if(1<p){c=Array(p);for(var d=0;d<p;d++)c[d]=arguments[d+2];o.children=c}return{$$typeof:r,type:e.type,key:i,ref:s,props:o,_owner:a}},t.createContext=function(e){return(e={$$typeof:c,_currentValue:e,_currentValue2:e,_threadCount:0,Provider:null,Consumer:null,_defaultValue:null,_globalName:null}).Provider={$$typeof:a,_context:e},e.Consumer=e},t.createElement=T,t.createFactory=function(e){var t=T.bind(null,e);return t.type=e,t},t.createRef=function(){return{current:null}},t.forwardRef=function(e){return{$$typeof:p,render:e}},t.isValidElement=C,t.lazy=function(e){return{$$typeof:u,_payload:{_status:-1,_result:e},_init:P}},t.memo=function(e,t){return{$$typeof:l,type:e,compare:void 0===t?null:t}},t.startTransition=function(e){var t=O.transition;O.transition={};try{e()}finally{O.transition=t}},t.unstable_act=$,t.useCallback=function(e,t){return R.current.useCallback(e,t)},t.useContext=function(e){return R.current.useContext(e)},t.useDebugValue=function(){},t.useDeferredValue=function(e){return R.current.useDeferredValue(e)},t.useEffect=function(e,t){return R.current.useEffect(e,t)},t.useId=function(){return R.current.useId()},t.useImperativeHandle=function(e,t,r){return R.current.useImperativeHandle(e,t,r)},t.useInsertionEffect=function(e,t){return R.current.useInsertionEffect(e,t)},t.useLayoutEffect=function(e,t){return R.current.useLayoutEffect(e,t)},t.useMemo=function(e,t){return R.current.useMemo(e,t)},t.useReducer=function(e,t,r){return R.current.useReducer(e,t,r)},t.useRef=function(e){return R.current.useRef(e)},t.useState=function(e){return R.current.useState(e)},t.useSyncExternalStore=function(e,t,r){return R.current.useSyncExternalStore(e,t,r)},t.useTransition=function(){return R.current.useTransition()},t.version="18.3.1"},96540:(e,t,r)=>{"use strict";e.exports=r(15287)},74848:(e,t,r)=>{"use strict";e.exports=r(21020)},7463:(e,t)=>{"use strict";function r(e,t){var r=e.length;e.push(t);e:for(;0<r;){var n=r-1>>>1,o=e[n];if(!(0<i(o,t)))break e;e[n]=t,e[r]=o,r=n}}function n(e){return 0===e.length?null:e[0]}function o(e){if(0===e.length)return null;var t=e[0],r=e.pop();if(r!==t){e[0]=r;e:for(var n=0,o=e.length,s=o>>>1;n<s;){var a=2*(n+1)-1,c=e[a],p=a+1,d=e[p];if(0>i(c,r))p<o&&0>i(d,c)?(e[n]=d,e[p]=r,n=p):(e[n]=c,e[a]=r,n=a);else{if(!(p<o&&0>i(d,r)))break e;e[n]=d,e[p]=r,n=p}}}return t}function i(e,t){var r=e.sortIndex-t.sortIndex;return 0!==r?r:e.id-t.id}if("object"==typeof performance&&"function"==typeof performance.now){var s=performance;t.unstable_now=function(){return s.now()}}else{var a=Date,c=a.now();t.unstable_now=function(){return a.now()-c}}var p=[],d=[],l=1,u=null,m=3,h=!1,f=!1,g=!1,y="function"==typeof setTimeout?setTimeout:null,b="function"==typeof clearTimeout?clearTimeout:null,_="undefined"!=typeof setImmediate?setImmediate:null;function v(e){for(var t=n(d);null!==t;){if(null===t.callback)o(d);else{if(!(t.startTime<=e))break;o(d),t.sortIndex=t.expirationTime,r(p,t)}t=n(d)}}function x(e){if(g=!1,v(e),!f)if(null!==n(p))f=!0,O(w);else{var t=n(d);null!==t&&q(x,t.startTime-e)}}function w(e,r){f=!1,g&&(g=!1,b(C),C=-1),h=!0;var i=m;try{for(v(r),u=n(p);null!==u&&(!(u.expirationTime>r)||e&&!j());){var s=u.callback;if("function"==typeof s){u.callback=null,m=u.priorityLevel;var a=s(u.expirationTime<=r);r=t.unstable_now(),"function"==typeof a?u.callback=a:u===n(p)&&o(p),v(r)}else o(p);u=n(p)}if(null!==u)var c=!0;else{var l=n(d);null!==l&&q(x,l.startTime-r),c=!1}return c}finally{u=null,m=i,h=!1}}"undefined"!=typeof navigator&&void 0!==navigator.scheduling&&void 0!==navigator.scheduling.isInputPending&&navigator.scheduling.isInputPending.bind(navigator.scheduling);var k,S=!1,T=null,C=-1,A=5,I=-1;function j(){return!(t.unstable_now()-I<A)}function E(){if(null!==T){var e=t.unstable_now();I=e;var r=!0;try{r=T(!0,e)}finally{r?k():(S=!1,T=null)}}else S=!1}if("function"==typeof _)k=function(){_(E)};else if("undefined"!=typeof MessageChannel){var P=new MessageChannel,R=P.port2;P.port1.onmessage=E,k=function(){R.postMessage(null)}}else k=function(){y(E,0)};function O(e){T=e,S||(S=!0,k())}function q(e,r){C=y((function(){e(t.unstable_now())}),r)}t.unstable_IdlePriority=5,t.unstable_ImmediatePriority=1,t.unstable_LowPriority=4,t.unstable_NormalPriority=3,t.unstable_Profiling=null,t.unstable_UserBlockingPriority=2,t.unstable_cancelCallback=function(e){e.callback=null},t.unstable_continueExecution=function(){f||h||(f=!0,O(w))},t.unstable_forceFrameRate=function(e){0>e||125<e?console.error("forceFrameRate takes a positive int between 0 and 125, forcing frame rates higher than 125 fps is not supported"):A=0<e?Math.floor(1e3/e):5},t.unstable_getCurrentPriorityLevel=function(){return m},t.unstable_getFirstCallbackNode=function(){return n(p)},t.unstable_next=function(e){switch(m){case 1:case 2:case 3:var t=3;break;default:t=m}var r=m;m=t;try{return e()}finally{m=r}},t.unstable_pauseExecution=function(){},t.unstable_requestPaint=function(){},t.unstable_runWithPriority=function(e,t){switch(e){case 1:case 2:case 3:case 4:case 5:break;default:e=3}var r=m;m=e;try{return t()}finally{m=r}},t.unstable_scheduleCallback=function(e,o,i){var s=t.unstable_now();switch("object"==typeof i&&null!==i?i="number"==typeof(i=i.delay)&&0<i?s+i:s:i=s,e){case 1:var a=-1;break;case 2:a=250;break;case 5:a=1073741823;break;case 4:a=1e4;break;default:a=5e3}return e={id:l++,callback:o,priorityLevel:e,startTime:i,expirationTime:a=i+a,sortIndex:-1},i>s?(e.sortIndex=i,r(d,e),null===n(p)&&e===n(d)&&(g?(b(C),C=-1):g=!0,q(x,i-s))):(e.sortIndex=a,r(p,e),f||h||(f=!0,O(w))),e},t.unstable_shouldYield=j,t.unstable_wrapCallback=function(e){var t=m;return function(){var r=m;m=t;try{return e.apply(this,arguments)}finally{m=r}}}},69982:(e,t,r)=>{"use strict";e.exports=r(7463)},2833:e=>{e.exports=function(e,t,r,n){var o=r?r.call(n,e,t):void 0;if(void 0!==o)return!!o;if(e===t)return!0;if("object"!=typeof e||!e||"object"!=typeof t||!t)return!1;var i=Object.keys(e),s=Object.keys(t);if(i.length!==s.length)return!1;for(var a=Object.prototype.hasOwnProperty.bind(t),c=0;c<i.length;c++){var p=i[c];if(!a(p))return!1;var d=e[p],l=t[p];if(!1===(o=r?r.call(n,d,l,p):void 0)||void 0===o&&d!==l)return!1}return!0}},4784:(e,t,r)=>{"use strict";r.r(t),r.d(t,{default:()=>n});const n={title:"Bold Commerce Developer Docs",tagline:"Create customizable transaction experiences to enable commerce anywhere.",url:"https://developer.boldcommerce.com",baseUrl:"/",trailingSlash:!1,onBrokenLinks:"warn",onBrokenMarkdownLinks:"warn",onBrokenAnchors:"ignore",favicon:"assets/images/favicon.ico",organizationName:"Bold Commerce",projectName:"Dev Portal 2.0",plugins:["docusaurus-plugin-sass"],presets:[["@docusaurus/preset-classic",{sitemap:{changefreq:"daily",priority:.5,ignorePatterns:["/guides/archive"],filename:"sitemap.xml"},docs:{path:"docs",routeBasePath:"guides",sidebarPath:"/home/runner/work/developer-docs/developer-docs/sidebars.js"},blog:{path:"blog",routeBasePath:"changelog",blogTitle:"Changelog",blogDescription:"A list of all recent changes to the Bold Commerce APIs.",postsPerPage:"ALL",blogSidebarTitle:"All changes",blogSidebarCount:"ALL",showReadingTime:!1,feedOptions:{type:"all",title:"Bold Commerce API Changelog",description:"A changelog capturing all updates to the Bold Commerce APIs.",copyright:"Copyright \xa9 2026 Bold Commerce, All Rights Reserved."},exclude:["YYYY-MM-DD.mdx"]},theme:{customCss:"/home/runner/work/developer-docs/developer-docs/src/css/custom.scss"},googleTagManager:{containerId:"GTM-NFVCMDW"}}],["redocusaurus",{specs:[{route:"/api/checkout",spec:"static/api/checkout-frontend.openapi.yaml",url:"/api/checkout-frontend.openapi.yaml"},{route:"/api/customers",spec:"static/api/customers.openapi.yaml",url:"/api/customers.openapi.yaml"},{route:"/api/orders",spec:"static/api/checkout-backend.openapi.yaml",url:"/api/checkout-backend.openapi.yaml"},{route:"/api/platform-connector",spec:"static/api/platform-connector.openapi.yaml",url:"/api/platform-connector.openapi.yaml"},{route:"/api/platform-event-notifications",spec:"static/api/platform-event-notifications.openapi.yaml",url:"/api/platform-event-notifications.openapi.yaml"},{route:"/api/platform-connector-destinations",spec:"static/api/platform-connector-destinations.openapi.yaml",url:"/api/platform-connector-destinations.openapi.yaml"},{route:"/api/price-rules",spec:"static/api/price-rules.openapi.yaml",url:"/api/price-rules.openapi.yaml"},{route:"/api/products",spec:"static/api/products.openapi.yaml",url:"/api/products.openapi.yaml"},{route:"/api/shops",spec:"static/api/shops.openapi.yaml",url:"/api/shops.openapi.yaml"},{route:"/api/subscriptions",spec:"static/api/subscriptions.openapi.yaml",url:"/api/subscriptions.openapi.yaml"},{route:"/api/checkout-admin",spec:"static/api/checkout-admin.openapi.yaml",url:"/api/checkout-admin.openapi.yaml"},{route:"/api/checkout-rsa",spec:"static/api/checkout-rsa.openapi.yaml",url:"/api/checkout-rsa.openapi.yaml"},{route:"/api/checkout-flows",spec:"static/api/checkout-flows.openapi.yaml",url:"/api/checkout-flows.openapi.yaml"}],theme:{primaryColor:"#5a0fb9",colors:{tonalOffset:.9},typography:{fontFamily:"sharp sans",fontSize:"1.125rem",fontWeightBold:"800",fontWeightRegular:"400",optimizeSpeed:!0,smoothing:"antialiased",headings:{lineHeight:"1em",fontFamily:"degular"}},options:{disableSearch:!0}}}]],themes:["@docusaurus/theme-mermaid"],markdown:{mermaid:!0,format:"mdx",mdx1Compat:{comments:!0,admonitions:!0,headingIds:!0},anchors:{maintainCase:!1}},themeConfig:{docs:{sidebar:{hideable:!0,autoCollapseCategories:!1},versionPersistence:"localStorage"},mermaid:{theme:{light:"base",dark:"base"},options:{themeVariables:{fontFamily:"sharp sans",fontSize:"16px",primaryColor:"#3C008C",primaryTextColor:"white",secondaryColor:"#9155FF",tertiaryColor:"#f4f4f4",signalColor:"#c1a2fa",signalTextColor:"#777777",noteBkgColor:"#9155FF",noteTextColor:"black",lineColor:"#777777",loopTextColor:"#777777"},sequence:{actorFontFamily:"sharp sans",messageFontFamily:"sharp sans"}}},themeConfig:{defaultMode:"dark"},navbar:{logo:{alt:"Bold Commerce",src:"assets/images/logo.svg",srcDark:"assets/images/logo-dark.svg",width:"189px"},items:[{label:"Guides",position:"left",type:"dropdown",items:[{label:"Bold Booster",to:"/guides/checkout/bold-boosters/bold-booster-for-paypal-overview"},{label:"Subscriptions",to:"/guides/subscriptions-v2"},{label:"Price Rules Engine",to:"/guides/price-rules"}]},{type:"dropdown",label:"APIs",position:"left",items:[{label:"Specifications",activeBasePath:"/api",to:"/api-specifications"},{label:"Changelog",to:"/changelog"}]},{href:"https://support.boldcommerce.com/",label:"Help Center",position:"left"},{href:"https://developer-dashboard.boldcommerce.com/default/dashboard",label:"Developer Dashboard",position:"right",target:"_self"}],hideOnScroll:!1},footer:{style:"dark",links:[{title:"Guides",items:[{label:"Bold Booster",to:"/guides/checkout/bold-boosters/bold-booster-for-paypal-overview"},{label:"Subscriptions",to:"/guides/subscriptions-v2"},{label:"Price Rules",to:"/guides/price-rules"}]},{title:"API Specifications",items:[{label:"Changelog",to:"/changelog"},{label:"Customers",to:"/api/customers"},{label:"Products",to:"/api/products"},{label:"Shops",to:"/api/shops"},{label:"Checkout Frontend",to:"/api/checkout"},{label:"Checkout Backend",to:"/api/orders"},{label:"Checkout Admin",to:"/api/checkout-admin"},{label:"Subscriptions",to:"/api/subscriptions"},{label:"Price Rules",to:"/api/price-rules"}]},{title:"Company",items:[{label:"BoldCommerce.com",to:"https://boldcommerce.com"},{label:"Become an affiliate",to:"https://boldcommerce.com/shopify/bold-apps-affiliate-program-shopify"},{label:"Trust and security",to:"https://boldcommerce.com/trust"},{label:"Legal",to:"https://boldcommerce.com/legal"},{label:"Help Center",to:"https://support.boldcommerce.com/hc/en-us"},{label:"GitHub",to:"https://github.com/bold-commerce"},{label:"Status",to:"https://status.boldcommerce.com"}]}],copyright:"Copyright \xa9 2026 Bold Commerce, All Rights Reserved"},prism:{additionalLanguages:["bash","css","http","json","php","ruby"],theme:{plain:{color:"#393A34",backgroundColor:"#f6f8fa"},styles:[{types:["comment","prolog","doctype","cdata"],style:{color:"#999988",fontStyle:"italic"}},{types:["namespace"],style:{opacity:.7}},{types:["string","attr-value"],style:{color:"#e3116c"}},{types:["punctuation","operator"],style:{color:"#393A34"}},{types:["entity","url","symbol","number","boolean","variable","constant","property","regex","inserted"],style:{color:"#36acaa"}},{types:["atrule","keyword","attr-name","selector"],style:{color:"#00a4db"}},{types:["function","deleted","tag"],style:{color:"#d73a49"}},{types:["function-variable"],style:{color:"#6f42c1"}},{types:["tag","selector","keyword"],style:{color:"#00009f"}}]},darkTheme:{plain:{color:"#F8F8F2",backgroundColor:"#282A36"},styles:[{types:["prolog","constant","builtin"],style:{color:"rgb(189, 147, 249)"}},{types:["inserted","function"],style:{color:"rgb(80, 250, 123)"}},{types:["deleted"],style:{color:"rgb(255, 85, 85)"}},{types:["changed"],style:{color:"rgb(255, 184, 108)"}},{types:["punctuation","symbol"],style:{color:"rgb(248, 248, 242)"}},{types:["string","char","tag","selector"],style:{color:"rgb(255, 121, 198)"}},{types:["keyword","variable"],style:{color:"rgb(189, 147, 249)",fontStyle:"italic"}},{types:["comment"],style:{color:"rgb(98, 114, 164)"}},{types:["attr-name"],style:{color:"rgb(241, 250, 140)"}}]},magicComments:[{className:"theme-code-block-highlighted-line",line:"highlight-next-line",block:{start:"highlight-start",end:"highlight-end"}}]},algolia:{appId:"6I16S7GCEE",apiKey:"33f528fc8355047ce5084ddd045fd3b5",indexName:"production",contextualSearch:!0,searchParameters:{},searchPagePath:"search"},colorMode:{defaultMode:"light",disableSwitch:!1,respectPrefersColorScheme:!1},metadata:[],tableOfContents:{minHeadingLevel:2,maxHeadingLevel:3}},baseUrlIssueBanner:!0,i18n:{defaultLocale:"en",path:"i18n",locales:["en"],localeConfigs:{}},future:{experimental_storage:{type:"localStorage",namespace:!1},experimental_router:"browser"},onDuplicateRoutes:"warn",staticDirectories:["static"],customFields:{},scripts:[],headTags:[],stylesheets:[],clientModules:[],titleDelimiter:"|",noIndex:!1}},58168:(e,t,r)=>{"use strict";function n(){return n=Object.assign?Object.assign.bind():function(e){for(var t=1;t<arguments.length;t++){var r=arguments[t];for(var n in r)({}).hasOwnProperty.call(r,n)&&(e[n]=r[n])}return e},n.apply(null,arguments)}r.d(t,{A:()=>n})},77387:(e,t,r)=>{"use strict";r.d(t,{A:()=>o});var n=r(63662);function o(e,t){e.prototype=Object.create(t.prototype),e.prototype.constructor=e,(0,n.A)(e,t)}},98587:(e,t,r)=>{"use strict";function n(e,t){if(null==e)return{};var r={};for(var n in e)if({}.hasOwnProperty.call(e,n)){if(t.indexOf(n)>=0)continue;r[n]=e[n]}return r}r.d(t,{A:()=>n})},63662:(e,t,r)=>{"use strict";function n(e,t){return n=Object.setPrototypeOf?Object.setPrototypeOf.bind():function(e,t){return e.__proto__=t,e},n(e,t)}r.d(t,{A:()=>n})},18215:(e,t,r)=>{"use strict";function n(e){var t,r,o="";if("string"==typeof e||"number"==typeof e)o+=e;else if("object"==typeof e)if(Array.isArray(e)){var i=e.length;for(t=0;t<i;t++)e[t]&&(r=n(e[t]))&&(o&&(o+=" "),o+=r)}else for(r in e)e[r]&&(o&&(o+=" "),o+=r);return o}r.d(t,{A:()=>o});const o=function(){for(var e,t,r=0,o="",i=arguments.length;r<i;r++)(e=arguments[r])&&(t=n(e))&&(o&&(o+=" "),o+=t);return o}},15066:(e,t,r)=>{"use strict";function n(e){var t,r,o="";if("string"==typeof e||"number"==typeof e)o+=e;else if("object"==typeof e)if(Array.isArray(e)){var i=e.length;for(t=0;t<i;t++)e[t]&&(r=n(e[t]))&&(o&&(o+=" "),o+=r)}else for(r in e)e[r]&&(o&&(o+=" "),o+=r);return o}r.d(t,{A:()=>o});const o=function(){for(var e,t,r=0,o="",i=arguments.length;r<i;r++)(e=arguments[r])&&(t=n(e))&&(o&&(o+=" "),o+=t);return o}},78181:(e,t,r)=>{"use strict";r.d(t,{f4:()=>Q,My:()=>C});var n=r(96540);function o(e){var t,r,n="";if("string"==typeof e||"number"==typeof e)n+=e;else if("object"==typeof e)if(Array.isArray(e)){var i=e.length;for(t=0;t<i;t++)e[t]&&(r=o(e[t]))&&(n&&(n+=" "),n+=r)}else for(r in e)e[r]&&(n&&(n+=" "),n+=r);return n}const i=function(){for(var e,t,r=0,n="",i=arguments.length;r<i;r++)(e=arguments[r])&&(t=o(e))&&(n&&(n+=" "),n+=t);return n};var s,a,c,p,d,l=Object.create,u=Object.defineProperty,m=Object.defineProperties,h=Object.getOwnPropertyDescriptor,f=Object.getOwnPropertyDescriptors,g=Object.getOwnPropertyNames,y=Object.getOwnPropertySymbols,b=Object.getPrototypeOf,_=Object.prototype.hasOwnProperty,v=Object.prototype.propertyIsEnumerable,x=(e,t,r)=>t in e?u(e,t,{enumerable:!0,configurable:!0,writable:!0,value:r}):e[t]=r,w=(e,t)=>{for(var r in t||(t={}))_.call(t,r)&&x(e,r,t[r]);if(y)for(var r of y(t))v.call(t,r)&&x(e,r,t[r]);return e},k=(e,t)=>m(e,f(t)),S=(e,t)=>{var r={};for(var n in e)_.call(e,n)&&t.indexOf(n)<0&&(r[n]=e[n]);if(null!=e&&y)for(var n of y(e))t.indexOf(n)<0&&v.call(e,n)&&(r[n]=e[n]);return r},T=(s={"../../node_modules/.pnpm/prismjs@1.29.0_patch_hash=vrxx3pzkik6jpmgpayxfjunetu/node_modules/prismjs/prism.js"(e,t){var r=function(){var e=/(?:^|\s)lang(?:uage)?-([\w-]+)(?=\s|$)/i,t=0,r={},n={util:{encode:function e(t){return t instanceof o?new o(t.type,e(t.content),t.alias):Array.isArray(t)?t.map(e):t.replace(/&/g,"&amp;").replace(/</g,"&lt;").replace(/\u00a0/g," ")},type:function(e){return Object.prototype.toString.call(e).slice(8,-1)},objId:function(e){return e.__id||Object.defineProperty(e,"__id",{value:++t}),e.__id},clone:function e(t,r){var o,i;switch(r=r||{},n.util.type(t)){case"Object":if(i=n.util.objId(t),r[i])return r[i];for(var s in o={},r[i]=o,t)t.hasOwnProperty(s)&&(o[s]=e(t[s],r));return o;case"Array":return i=n.util.objId(t),r[i]?r[i]:(o=[],r[i]=o,t.forEach((function(t,n){o[n]=e(t,r)})),o);default:return t}},getLanguage:function(t){for(;t;){var r=e.exec(t.className);if(r)return r[1].toLowerCase();t=t.parentElement}return"none"},setLanguage:function(t,r){t.className=t.className.replace(RegExp(e,"gi"),""),t.classList.add("language-"+r)},isActive:function(e,t,r){for(var n="no-"+t;e;){var o=e.classList;if(o.contains(t))return!0;if(o.contains(n))return!1;e=e.parentElement}return!!r}},languages:{plain:r,plaintext:r,text:r,txt:r,extend:function(e,t){var r=n.util.clone(n.languages[e]);for(var o in t)r[o]=t[o];return r},insertBefore:function(e,t,r,o){var i=(o=o||n.languages)[e],s={};for(var a in i)if(i.hasOwnProperty(a)){if(a==t)for(var c in r)r.hasOwnProperty(c)&&(s[c]=r[c]);r.hasOwnProperty(a)||(s[a]=i[a])}var p=o[e];return o[e]=s,n.languages.DFS(n.languages,(function(t,r){r===p&&t!=e&&(this[t]=s)})),s},DFS:function e(t,r,o,i){i=i||{};var s=n.util.objId;for(var a in t)if(t.hasOwnProperty(a)){r.call(t,a,t[a],o||a);var c=t[a],p=n.util.type(c);"Object"!==p||i[s(c)]?"Array"!==p||i[s(c)]||(i[s(c)]=!0,e(c,r,a,i)):(i[s(c)]=!0,e(c,r,null,i))}}},plugins:{},highlight:function(e,t,r){var i={code:e,grammar:t,language:r};if(n.hooks.run("before-tokenize",i),!i.grammar)throw new Error('The language "'+i.language+'" has no grammar.');return i.tokens=n.tokenize(i.code,i.grammar),n.hooks.run("after-tokenize",i),o.stringify(n.util.encode(i.tokens),i.language)},tokenize:function(e,t){var r=t.rest;if(r){for(var n in r)t[n]=r[n];delete t.rest}var o=new a;return c(o,o.head,e),s(e,o,t,o.head,0),function(e){for(var t=[],r=e.head.next;r!==e.tail;)t.push(r.value),r=r.next;return t}(o)},hooks:{all:{},add:function(e,t){var r=n.hooks.all;r[e]=r[e]||[],r[e].push(t)},run:function(e,t){var r=n.hooks.all[e];if(r&&r.length)for(var o,i=0;o=r[i++];)o(t)}},Token:o};function o(e,t,r,n){this.type=e,this.content=t,this.alias=r,this.length=0|(n||"").length}function i(e,t,r,n){e.lastIndex=t;var o=e.exec(r);if(o&&n&&o[1]){var i=o[1].length;o.index+=i,o[0]=o[0].slice(i)}return o}function s(e,t,r,a,d,l){for(var u in r)if(r.hasOwnProperty(u)&&r[u]){var m=r[u];m=Array.isArray(m)?m:[m];for(var h=0;h<m.length;++h){if(l&&l.cause==u+","+h)return;var f=m[h],g=f.inside,y=!!f.lookbehind,b=!!f.greedy,_=f.alias;if(b&&!f.pattern.global){var v=f.pattern.toString().match(/[imsuy]*$/)[0];f.pattern=RegExp(f.pattern.source,v+"g")}for(var x=f.pattern||f,w=a.next,k=d;w!==t.tail&&!(l&&k>=l.reach);k+=w.value.length,w=w.next){var S=w.value;if(t.length>e.length)return;if(!(S instanceof o)){var T,C=1;if(b){if(!(T=i(x,k,e,y))||T.index>=e.length)break;var A=T.index,I=T.index+T[0].length,j=k;for(j+=w.value.length;A>=j;)j+=(w=w.next).value.length;if(k=j-=w.value.length,w.value instanceof o)continue;for(var E=w;E!==t.tail&&(j<I||"string"==typeof E.value);E=E.next)C++,j+=E.value.length;C--,S=e.slice(k,j),T.index-=k}else if(!(T=i(x,0,S,y)))continue;A=T.index;var P=T[0],R=S.slice(0,A),O=S.slice(A+P.length),q=k+S.length;l&&q>l.reach&&(l.reach=q);var $=w.prev;if(R&&($=c(t,$,R),k+=R.length),p(t,$,C),w=c(t,$,new o(u,g?n.tokenize(P,g):P,_,P)),O&&c(t,w,O),C>1){var D={cause:u+","+h,reach:q};s(e,t,r,w.prev,k,D),l&&D.reach>l.reach&&(l.reach=D.reach)}}}}}}function a(){var e={value:null,prev:null,next:null},t={value:null,prev:e,next:null};e.next=t,this.head=e,this.tail=t,this.length=0}function c(e,t,r){var n=t.next,o={value:r,prev:t,next:n};return t.next=o,n.prev=o,e.length++,o}function p(e,t,r){for(var n=t.next,o=0;o<r&&n!==e.tail;o++)n=n.next;t.next=n,n.prev=t,e.length-=o}return o.stringify=function e(t,r){if("string"==typeof t)return t;if(Array.isArray(t)){var o="";return t.forEach((function(t){o+=e(t,r)})),o}var i={type:t.type,content:e(t.content,r),tag:"span",classes:["token",t.type],attributes:{},language:r},s=t.alias;s&&(Array.isArray(s)?Array.prototype.push.apply(i.classes,s):i.classes.push(s)),n.hooks.run("wrap",i);var a="";for(var c in i.attributes)a+=" "+c+'="'+(i.attributes[c]||"").replace(/"/g,"&quot;")+'"';return"<"+i.tag+' class="'+i.classes.join(" ")+'"'+a+">"+i.content+"</"+i.tag+">"},n}();t.exports=r,r.default=r}},function(){return a||(0,s[g(s)[0]])((a={exports:{}}).exports,a),a.exports}),C=((e,t,r)=>(r=null!=e?l(b(e)):{},((e,t,r,n)=>{if(t&&"object"==typeof t||"function"==typeof t)for(let o of g(t))_.call(e,o)||o===r||u(e,o,{get:()=>t[o],enumerable:!(n=h(t,o))||n.enumerable});return e})(!t&&e&&e.__esModule?r:u(r,"default",{value:e,enumerable:!0}),e)))(T());C.languages.markup={comment:{pattern:/<!--(?:(?!<!--)[\s\S])*?-->/,greedy:!0},prolog:{pattern:/<\?[\s\S]+?\?>/,greedy:!0},doctype:{pattern:/<!DOCTYPE(?:[^>"'[\]]|"[^"]*"|'[^']*')+(?:\[(?:[^<"'\]]|"[^"]*"|'[^']*'|<(?!!--)|<!--(?:[^-]|-(?!->))*-->)*\]\s*)?>/i,greedy:!0,inside:{"internal-subset":{pattern:/(^[^\[]*\[)[\s\S]+(?=\]>$)/,lookbehind:!0,greedy:!0,inside:null},string:{pattern:/"[^"]*"|'[^']*'/,greedy:!0},punctuation:/^<!|>$|[[\]]/,"doctype-tag":/^DOCTYPE/i,name:/[^\s<>'"]+/}},cdata:{pattern:/<!\[CDATA\[[\s\S]*?\]\]>/i,greedy:!0},tag:{pattern:/<\/?(?!\d)[^\s>\/=$<%]+(?:\s(?:\s*[^\s>\/=]+(?:\s*=\s*(?:"[^"]*"|'[^']*'|[^\s'">=]+(?=[\s>]))|(?=[\s/>])))+)?\s*\/?>/,greedy:!0,inside:{tag:{pattern:/^<\/?[^\s>\/]+/,inside:{punctuation:/^<\/?/,namespace:/^[^\s>\/:]+:/}},"special-attr":[],"attr-value":{pattern:/=\s*(?:"[^"]*"|'[^']*'|[^\s'">=]+)/,inside:{punctuation:[{pattern:/^=/,alias:"attr-equals"},{pattern:/^(\s*)["']|["']$/,lookbehind:!0}]}},punctuation:/\/?>/,"attr-name":{pattern:/[^\s>\/]+/,inside:{namespace:/^[^\s>\/:]+:/}}}},entity:[{pattern:/&[\da-z]{1,8};/i,alias:"named-entity"},/&#x?[\da-f]{1,8};/i]},C.languages.markup.tag.inside["attr-value"].inside.entity=C.languages.markup.entity,C.languages.markup.doctype.inside["internal-subset"].inside=C.languages.markup,C.hooks.add("wrap",(function(e){"entity"===e.type&&(e.attributes.title=e.content.replace(/&amp;/,"&"))})),Object.defineProperty(C.languages.markup.tag,"addInlined",{value:function(e,t){var r;(t=((r=((r={})["language-"+t]={pattern:/(^<!\[CDATA\[)[\s\S]+?(?=\]\]>$)/i,lookbehind:!0,inside:C.languages[t]},r.cdata=/^<!\[CDATA\[|\]\]>$/i,{"included-cdata":{pattern:/<!\[CDATA\[[\s\S]*?\]\]>/i,inside:r}}))["language-"+t]={pattern:/[\s\S]+/,inside:C.languages[t]},{}))[e]={pattern:RegExp(/(<__[^>]*>)(?:<!\[CDATA\[(?:[^\]]|\](?!\]>))*\]\]>|(?!<!\[CDATA\[)[\s\S])*?(?=<\/__>)/.source.replace(/__/g,(function(){return e})),"i"),lookbehind:!0,greedy:!0,inside:r},C.languages.insertBefore("markup","cdata",t)}}),Object.defineProperty(C.languages.markup.tag,"addAttribute",{value:function(e,t){C.languages.markup.tag.inside["special-attr"].push({pattern:RegExp(/(^|["'\s])/.source+"(?:"+e+")"+/\s*=\s*(?:"[^"]*"|'[^']*'|[^\s'">=]+(?=[\s>]))/.source,"i"),lookbehind:!0,inside:{"attr-name":/^[^\s=]+/,"attr-value":{pattern:/=[\s\S]+/,inside:{value:{pattern:/(^=\s*(["']|(?!["'])))\S[\s\S]*(?=\2$)/,lookbehind:!0,alias:[t,"language-"+t],inside:C.languages[t]},punctuation:[{pattern:/^=/,alias:"attr-equals"},/"|'/]}}}})}}),C.languages.html=C.languages.markup,C.languages.mathml=C.languages.markup,C.languages.svg=C.languages.markup,C.languages.xml=C.languages.extend("markup",{}),C.languages.ssml=C.languages.xml,C.languages.atom=C.languages.xml,C.languages.rss=C.languages.xml,function(e){var t={pattern:/\\[\\(){}[\]^$+*?|.]/,alias:"escape"},r=/\\(?:x[\da-fA-F]{2}|u[\da-fA-F]{4}|u\{[\da-fA-F]+\}|0[0-7]{0,2}|[123][0-7]{2}|c[a-zA-Z]|.)/,n="(?:[^\\\\-]|"+r.source+")",o=(n=RegExp(n+"-"+n),{pattern:/(<|')[^<>']+(?=[>']$)/,lookbehind:!0,alias:"variable"});e.languages.regex={"char-class":{pattern:/((?:^|[^\\])(?:\\\\)*)\[(?:[^\\\]]|\\[\s\S])*\]/,lookbehind:!0,inside:{"char-class-negation":{pattern:/(^\[)\^/,lookbehind:!0,alias:"operator"},"char-class-punctuation":{pattern:/^\[|\]$/,alias:"punctuation"},range:{pattern:n,inside:{escape:r,"range-punctuation":{pattern:/-/,alias:"operator"}}},"special-escape":t,"char-set":{pattern:/\\[wsd]|\\p\{[^{}]+\}/i,alias:"class-name"},escape:r}},"special-escape":t,"char-set":{pattern:/\.|\\[wsd]|\\p\{[^{}]+\}/i,alias:"class-name"},backreference:[{pattern:/\\(?![123][0-7]{2})[1-9]/,alias:"keyword"},{pattern:/\\k<[^<>']+>/,alias:"keyword",inside:{"group-name":o}}],anchor:{pattern:/[$^]|\\[ABbGZz]/,alias:"function"},escape:r,group:[{pattern:/\((?:\?(?:<[^<>']+>|'[^<>']+'|[>:]|<?[=!]|[idmnsuxU]+(?:-[idmnsuxU]+)?:?))?/,alias:"punctuation",inside:{"group-name":o}},{pattern:/\)/,alias:"punctuation"}],quantifier:{pattern:/(?:[+*?]|\{\d+(?:,\d*)?\})[?+]?/,alias:"number"},alternation:{pattern:/\|/,alias:"keyword"}}}(C),C.languages.clike={comment:[{pattern:/(^|[^\\])\/\*[\s\S]*?(?:\*\/|$)/,lookbehind:!0,greedy:!0},{pattern:/(^|[^\\:])\/\/.*/,lookbehind:!0,greedy:!0}],string:{pattern:/(["'])(?:\\(?:\r\n|[\s\S])|(?!\1)[^\\\r\n])*\1/,greedy:!0},"class-name":{pattern:/(\b(?:class|extends|implements|instanceof|interface|new|trait)\s+|\bcatch\s+\()[\w.\\]+/i,lookbehind:!0,inside:{punctuation:/[.\\]/}},keyword:/\b(?:break|catch|continue|do|else|finally|for|function|if|in|instanceof|new|null|return|throw|try|while)\b/,boolean:/\b(?:false|true)\b/,function:/\b\w+(?=\()/,number:/\b0x[\da-f]+\b|(?:\b\d+(?:\.\d*)?|\B\.\d+)(?:e[+-]?\d+)?/i,operator:/[<>]=?|[!=]=?=?|--?|\+\+?|&&?|\|\|?|[?*/~^%]/,punctuation:/[{}[\];(),.:]/},C.languages.javascript=C.languages.extend("clike",{"class-name":[C.languages.clike["class-name"],{pattern:/(^|[^$\w\xA0-\uFFFF])(?!\s)[_$A-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*(?=\.(?:constructor|prototype))/,lookbehind:!0}],keyword:[{pattern:/((?:^|\})\s*)catch\b/,lookbehind:!0},{pattern:/(^|[^.]|\.\.\.\s*)\b(?:as|assert(?=\s*\{)|async(?=\s*(?:function\b|\(|[$\w\xA0-\uFFFF]|$))|await|break|case|class|const|continue|debugger|default|delete|do|else|enum|export|extends|finally(?=\s*(?:\{|$))|for|from(?=\s*(?:['"]|$))|function|(?:get|set)(?=\s*(?:[#\[$\w\xA0-\uFFFF]|$))|if|implements|import|in|instanceof|interface|let|new|null|of|package|private|protected|public|return|static|super|switch|this|throw|try|typeof|undefined|var|void|while|with|yield)\b/,lookbehind:!0}],function:/#?(?!\s)[_$a-zA-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*(?=\s*(?:\.\s*(?:apply|bind|call)\s*)?\()/,number:{pattern:RegExp(/(^|[^\w$])/.source+"(?:"+/NaN|Infinity/.source+"|"+/0[bB][01]+(?:_[01]+)*n?/.source+"|"+/0[oO][0-7]+(?:_[0-7]+)*n?/.source+"|"+/0[xX][\dA-Fa-f]+(?:_[\dA-Fa-f]+)*n?/.source+"|"+/\d+(?:_\d+)*n/.source+"|"+/(?:\d+(?:_\d+)*(?:\.(?:\d+(?:_\d+)*)?)?|\.\d+(?:_\d+)*)(?:[Ee][+-]?\d+(?:_\d+)*)?/.source+")"+/(?![\w$])/.source),lookbehind:!0},operator:/--|\+\+|\*\*=?|=>|&&=?|\|\|=?|[!=]==|<<=?|>>>?=?|[-+*/%&|^!=<>]=?|\.{3}|\?\?=?|\?\.?|[~:]/}),C.languages.javascript["class-name"][0].pattern=/(\b(?:class|extends|implements|instanceof|interface|new)\s+)[\w.\\]+/,C.languages.insertBefore("javascript","keyword",{regex:{pattern:RegExp(/((?:^|[^$\w\xA0-\uFFFF."'\])\s]|\b(?:return|yield))\s*)/.source+/\//.source+"(?:"+/(?:\[(?:[^\]\\\r\n]|\\.)*\]|\\.|[^/\\\[\r\n])+\/[dgimyus]{0,7}/.source+"|"+/(?:\[(?:[^[\]\\\r\n]|\\.|\[(?:[^[\]\\\r\n]|\\.|\[(?:[^[\]\\\r\n]|\\.)*\])*\])*\]|\\.|[^/\\\[\r\n])+\/[dgimyus]{0,7}v[dgimyus]{0,7}/.source+")"+/(?=(?:\s|\/\*(?:[^*]|\*(?!\/))*\*\/)*(?:$|[\r\n,.;:})\]]|\/\/))/.source),lookbehind:!0,greedy:!0,inside:{"regex-source":{pattern:/^(\/)[\s\S]+(?=\/[a-z]*$)/,lookbehind:!0,alias:"language-regex",inside:C.languages.regex},"regex-delimiter":/^\/|\/$/,"regex-flags":/^[a-z]+$/}},"function-variable":{pattern:/#?(?!\s)[_$a-zA-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*(?=\s*[=:]\s*(?:async\s*)?(?:\bfunction\b|(?:\((?:[^()]|\([^()]*\))*\)|(?!\s)[_$a-zA-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*)\s*=>))/,alias:"function"},parameter:[{pattern:/(function(?:\s+(?!\s)[_$a-zA-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*)?\s*\(\s*)(?!\s)(?:[^()\s]|\s+(?![\s)])|\([^()]*\))+(?=\s*\))/,lookbehind:!0,inside:C.languages.javascript},{pattern:/(^|[^$\w\xA0-\uFFFF])(?!\s)[_$a-z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*(?=\s*=>)/i,lookbehind:!0,inside:C.languages.javascript},{pattern:/(\(\s*)(?!\s)(?:[^()\s]|\s+(?![\s)])|\([^()]*\))+(?=\s*\)\s*=>)/,lookbehind:!0,inside:C.languages.javascript},{pattern:/((?:\b|\s|^)(?!(?:as|async|await|break|case|catch|class|const|continue|debugger|default|delete|do|else|enum|export|extends|finally|for|from|function|get|if|implements|import|in|instanceof|interface|let|new|null|of|package|private|protected|public|return|set|static|super|switch|this|throw|try|typeof|undefined|var|void|while|with|yield)(?![$\w\xA0-\uFFFF]))(?:(?!\s)[_$a-zA-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*\s*)\(\s*|\]\s*\(\s*)(?!\s)(?:[^()\s]|\s+(?![\s)])|\([^()]*\))+(?=\s*\)\s*\{)/,lookbehind:!0,inside:C.languages.javascript}],constant:/\b[A-Z](?:[A-Z_]|\dx?)*\b/}),C.languages.insertBefore("javascript","string",{hashbang:{pattern:/^#!.*/,greedy:!0,alias:"comment"},"template-string":{pattern:/`(?:\\[\s\S]|\$\{(?:[^{}]|\{(?:[^{}]|\{[^}]*\})*\})+\}|(?!\$\{)[^\\`])*`/,greedy:!0,inside:{"template-punctuation":{pattern:/^`|`$/,alias:"string"},interpolation:{pattern:/((?:^|[^\\])(?:\\{2})*)\$\{(?:[^{}]|\{(?:[^{}]|\{[^}]*\})*\})+\}/,lookbehind:!0,inside:{"interpolation-punctuation":{pattern:/^\$\{|\}$/,alias:"punctuation"},rest:C.languages.javascript}},string:/[\s\S]+/}},"string-property":{pattern:/((?:^|[,{])[ \t]*)(["'])(?:\\(?:\r\n|[\s\S])|(?!\2)[^\\\r\n])*\2(?=\s*:)/m,lookbehind:!0,greedy:!0,alias:"property"}}),C.languages.insertBefore("javascript","operator",{"literal-property":{pattern:/((?:^|[,{])[ \t]*)(?!\s)[_$a-zA-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*(?=\s*:)/m,lookbehind:!0,alias:"property"}}),C.languages.markup&&(C.languages.markup.tag.addInlined("script","javascript"),C.languages.markup.tag.addAttribute(/on(?:abort|blur|change|click|composition(?:end|start|update)|dblclick|error|focus(?:in|out)?|key(?:down|up)|load|mouse(?:down|enter|leave|move|out|over|up)|reset|resize|scroll|select|slotchange|submit|unload|wheel)/.source,"javascript")),C.languages.js=C.languages.javascript,C.languages.actionscript=C.languages.extend("javascript",{keyword:/\b(?:as|break|case|catch|class|const|default|delete|do|dynamic|each|else|extends|final|finally|for|function|get|if|implements|import|in|include|instanceof|interface|internal|is|namespace|native|new|null|override|package|private|protected|public|return|set|static|super|switch|this|throw|try|typeof|use|var|void|while|with)\b/,operator:/\+\+|--|(?:[+\-*\/%^]|&&?|\|\|?|<<?|>>?>?|[!=]=?)=?|[~?@]/}),C.languages.actionscript["class-name"].alias="function",delete C.languages.actionscript.parameter,delete C.languages.actionscript["literal-property"],C.languages.markup&&C.languages.insertBefore("actionscript","string",{xml:{pattern:/(^|[^.])<\/?\w+(?:\s+[^\s>\/=]+=("|')(?:\\[\s\S]|(?!\2)[^\\])*\2)*\s*\/?>/,lookbehind:!0,inside:C.languages.markup}}),p=/#(?!\{).+/,d={pattern:/#\{[^}]+\}/,alias:"variable"},(c=C).languages.coffeescript=c.languages.extend("javascript",{comment:p,string:[{pattern:/'(?:\\[\s\S]|[^\\'])*'/,greedy:!0},{pattern:/"(?:\\[\s\S]|[^\\"])*"/,greedy:!0,inside:{interpolation:d}}],keyword:/\b(?:and|break|by|catch|class|continue|debugger|delete|do|each|else|extend|extends|false|finally|for|if|in|instanceof|is|isnt|let|loop|namespace|new|no|not|null|of|off|on|or|own|return|super|switch|then|this|throw|true|try|typeof|undefined|unless|until|when|while|window|with|yes|yield)\b/,"class-member":{pattern:/@(?!\d)\w+/,alias:"variable"}}),c.languages.insertBefore("coffeescript","comment",{"multiline-comment":{pattern:/###[\s\S]+?###/,alias:"comment"},"block-regex":{pattern:/\/{3}[\s\S]*?\/{3}/,alias:"regex",inside:{comment:p,interpolation:d}}}),c.languages.insertBefore("coffeescript","string",{"inline-javascript":{pattern:/`(?:\\[\s\S]|[^\\`])*`/,inside:{delimiter:{pattern:/^`|`$/,alias:"punctuation"},script:{pattern:/[\s\S]+/,alias:"language-javascript",inside:c.languages.javascript}}},"multiline-string":[{pattern:/'''[\s\S]*?'''/,greedy:!0,alias:"string"},{pattern:/"""[\s\S]*?"""/,greedy:!0,alias:"string",inside:{interpolation:d}}]}),c.languages.insertBefore("coffeescript","keyword",{property:/(?!\d)\w+(?=\s*:(?!:))/}),delete c.languages.coffeescript["template-string"],c.languages.coffee=c.languages.coffeescript,function(e){var t=e.languages.javadoclike={parameter:{pattern:/(^[\t ]*(?:\/{3}|\*|\/\*\*)\s*@(?:arg|arguments|param)\s+)\w+/m,lookbehind:!0},keyword:{pattern:/(^[\t ]*(?:\/{3}|\*|\/\*\*)\s*|\{)@[a-z][a-zA-Z-]+\b/m,lookbehind:!0},punctuation:/[{}]/};Object.defineProperty(t,"addSupport",{value:function(t,r){(t="string"==typeof t?[t]:t).forEach((function(t){var n=function(e){e.inside||(e.inside={}),e.inside.rest=r},o="doc-comment";if(i=e.languages[t]){var i,s=i[o];if((s=s||(i=e.languages.insertBefore(t,"comment",{"doc-comment":{pattern:/(^|[^\\])\/\*\*[^/][\s\S]*?(?:\*\/|$)/,lookbehind:!0,alias:"comment"}}))[o])instanceof RegExp&&(s=i[o]={pattern:s}),Array.isArray(s))for(var a=0,c=s.length;a<c;a++)s[a]instanceof RegExp&&(s[a]={pattern:s[a]}),n(s[a]);else n(s)}}))}}),t.addSupport(["java","javascript","php"],t)}(C),function(e){var t=/(?:"(?:\\(?:\r\n|[\s\S])|[^"\\\r\n])*"|'(?:\\(?:\r\n|[\s\S])|[^'\\\r\n])*')/;(t=(e.languages.css={comment:/\/\*[\s\S]*?\*\//,atrule:{pattern:RegExp("@[\\w-](?:"+/[^;{\s"']|\s+(?!\s)/.source+"|"+t.source+")*?"+/(?:;|(?=\s*\{))/.source),inside:{rule:/^@[\w-]+/,"selector-function-argument":{pattern:/(\bselector\s*\(\s*(?![\s)]))(?:[^()\s]|\s+(?![\s)])|\((?:[^()]|\([^()]*\))*\))+(?=\s*\))/,lookbehind:!0,alias:"selector"},keyword:{pattern:/(^|[^\w-])(?:and|not|only|or)(?![\w-])/,lookbehind:!0}}},url:{pattern:RegExp("\\burl\\((?:"+t.source+"|"+/(?:[^\\\r\n()"']|\\[\s\S])*/.source+")\\)","i"),greedy:!0,inside:{function:/^url/i,punctuation:/^\(|\)$/,string:{pattern:RegExp("^"+t.source+"$"),alias:"url"}}},selector:{pattern:RegExp("(^|[{}\\s])[^{}\\s](?:[^{};\"'\\s]|\\s+(?![\\s{])|"+t.source+")*(?=\\s*\\{)"),lookbehind:!0},string:{pattern:t,greedy:!0},property:{pattern:/(^|[^-\w\xA0-\uFFFF])(?!\s)[-_a-z\xA0-\uFFFF](?:(?!\s)[-\w\xA0-\uFFFF])*(?=\s*:)/i,lookbehind:!0},important:/!important\b/i,function:{pattern:/(^|[^-a-z0-9])[-a-z0-9]+(?=\()/i,lookbehind:!0},punctuation:/[(){};:,]/},e.languages.css.atrule.inside.rest=e.languages.css,e.languages.markup))&&(t.tag.addInlined("style","css"),t.tag.addAttribute("style","css"))}(C),function(e){var t=/("|')(?:\\(?:\r\n|[\s\S])|(?!\1)[^\\\r\n])*\1/,r=(t=(e.languages.css.selector={pattern:e.languages.css.selector.pattern,lookbehind:!0,inside:t={"pseudo-element":/:(?:after|before|first-letter|first-line|selection)|::[-\w]+/,"pseudo-class":/:[-\w]+/,class:/\.[-\w]+/,id:/#[-\w]+/,attribute:{pattern:RegExp("\\[(?:[^[\\]\"']|"+t.source+")*\\]"),greedy:!0,inside:{punctuation:/^\[|\]$/,"case-sensitivity":{pattern:/(\s)[si]$/i,lookbehind:!0,alias:"keyword"},namespace:{pattern:/^(\s*)(?:(?!\s)[-*\w\xA0-\uFFFF])*\|(?!=)/,lookbehind:!0,inside:{punctuation:/\|$/}},"attr-name":{pattern:/^(\s*)(?:(?!\s)[-\w\xA0-\uFFFF])+/,lookbehind:!0},"attr-value":[t,{pattern:/(=\s*)(?:(?!\s)[-\w\xA0-\uFFFF])+(?=\s*$)/,lookbehind:!0}],operator:/[|~*^$]?=/}},"n-th":[{pattern:/(\(\s*)[+-]?\d*[\dn](?:\s*[+-]\s*\d+)?(?=\s*\))/,lookbehind:!0,inside:{number:/[\dn]+/,operator:/[+-]/}},{pattern:/(\(\s*)(?:even|odd)(?=\s*\))/i,lookbehind:!0}],combinator:/>|\+|~|\|\|/,punctuation:/[(),]/}},e.languages.css.atrule.inside["selector-function-argument"].inside=t,e.languages.insertBefore("css","property",{variable:{pattern:/(^|[^-\w\xA0-\uFFFF])--(?!\s)[-_a-z\xA0-\uFFFF](?:(?!\s)[-\w\xA0-\uFFFF])*/i,lookbehind:!0}}),{pattern:/(\b\d+)(?:%|[a-z]+(?![\w-]))/,lookbehind:!0}),{pattern:/(^|[^\w.-])-?(?:\d+(?:\.\d+)?|\.\d+)/,lookbehind:!0});e.languages.insertBefore("css","function",{operator:{pattern:/(\s)[+\-*\/](?=\s)/,lookbehind:!0},hexcode:{pattern:/\B#[\da-f]{3,8}\b/i,alias:"color"},color:[{pattern:/(^|[^\w-])(?:AliceBlue|AntiqueWhite|Aqua|Aquamarine|Azure|Beige|Bisque|Black|BlanchedAlmond|Blue|BlueViolet|Brown|BurlyWood|CadetBlue|Chartreuse|Chocolate|Coral|CornflowerBlue|Cornsilk|Crimson|Cyan|DarkBlue|DarkCyan|DarkGoldenRod|DarkGr[ae]y|DarkGreen|DarkKhaki|DarkMagenta|DarkOliveGreen|DarkOrange|DarkOrchid|DarkRed|DarkSalmon|DarkSeaGreen|DarkSlateBlue|DarkSlateGr[ae]y|DarkTurquoise|DarkViolet|DeepPink|DeepSkyBlue|DimGr[ae]y|DodgerBlue|FireBrick|FloralWhite|ForestGreen|Fuchsia|Gainsboro|GhostWhite|Gold|GoldenRod|Gr[ae]y|Green|GreenYellow|HoneyDew|HotPink|IndianRed|Indigo|Ivory|Khaki|Lavender|LavenderBlush|LawnGreen|LemonChiffon|LightBlue|LightCoral|LightCyan|LightGoldenRodYellow|LightGr[ae]y|LightGreen|LightPink|LightSalmon|LightSeaGreen|LightSkyBlue|LightSlateGr[ae]y|LightSteelBlue|LightYellow|Lime|LimeGreen|Linen|Magenta|Maroon|MediumAquaMarine|MediumBlue|MediumOrchid|MediumPurple|MediumSeaGreen|MediumSlateBlue|MediumSpringGreen|MediumTurquoise|MediumVioletRed|MidnightBlue|MintCream|MistyRose|Moccasin|NavajoWhite|Navy|OldLace|Olive|OliveDrab|Orange|OrangeRed|Orchid|PaleGoldenRod|PaleGreen|PaleTurquoise|PaleVioletRed|PapayaWhip|PeachPuff|Peru|Pink|Plum|PowderBlue|Purple|RebeccaPurple|Red|RosyBrown|RoyalBlue|SaddleBrown|Salmon|SandyBrown|SeaGreen|SeaShell|Sienna|Silver|SkyBlue|SlateBlue|SlateGr[ae]y|Snow|SpringGreen|SteelBlue|Tan|Teal|Thistle|Tomato|Transparent|Turquoise|Violet|Wheat|White|WhiteSmoke|Yellow|YellowGreen)(?![\w-])/i,lookbehind:!0},{pattern:/\b(?:hsl|rgb)\(\s*\d{1,3}\s*,\s*\d{1,3}%?\s*,\s*\d{1,3}%?\s*\)\B|\b(?:hsl|rgb)a\(\s*\d{1,3}\s*,\s*\d{1,3}%?\s*,\s*\d{1,3}%?\s*,\s*(?:0|0?\.\d+|1)\s*\)\B/i,inside:{unit:t,number:r,function:/[\w-]+(?=\()/,punctuation:/[(),]/}}],entity:/\\[\da-f]{1,8}/i,unit:t,number:r})}(C),function(e){var t=/[*&][^\s[\]{},]+/,r=/!(?:<[\w\-%#;/?:@&=+$,.!~*'()[\]]+>|(?:[a-zA-Z\d-]*!)?[\w\-%#;/?:@&=+$.~*'()]+)?/,n="(?:"+r.source+"(?:[ \t]+"+t.source+")?|"+t.source+"(?:[ \t]+"+r.source+")?)",o=/(?:[^\s\x00-\x08\x0e-\x1f!"#%&'*,\-:>?@[\]`{|}\x7f-\x84\x86-\x9f\ud800-\udfff\ufffe\uffff]|[?:-]<PLAIN>)(?:[ \t]*(?:(?![#:])<PLAIN>|:<PLAIN>))*/.source.replace(/<PLAIN>/g,(function(){return/[^\s\x00-\x08\x0e-\x1f,[\]{}\x7f-\x84\x86-\x9f\ud800-\udfff\ufffe\uffff]/.source})),i=/"(?:[^"\\\r\n]|\\.)*"|'(?:[^'\\\r\n]|\\.)*'/.source;function s(e,t){t=(t||"").replace(/m/g,"")+"m";var r=/([:\-,[{]\s*(?:\s<<prop>>[ \t]+)?)(?:<<value>>)(?=[ \t]*(?:$|,|\]|\}|(?:[\r\n]\s*)?#))/.source.replace(/<<prop>>/g,(function(){return n})).replace(/<<value>>/g,(function(){return e}));return RegExp(r,t)}e.languages.yaml={scalar:{pattern:RegExp(/([\-:]\s*(?:\s<<prop>>[ \t]+)?[|>])[ \t]*(?:((?:\r?\n|\r)[ \t]+)\S[^\r\n]*(?:\2[^\r\n]+)*)/.source.replace(/<<prop>>/g,(function(){return n}))),lookbehind:!0,alias:"string"},comment:/#.*/,key:{pattern:RegExp(/((?:^|[:\-,[{\r\n?])[ \t]*(?:<<prop>>[ \t]+)?)<<key>>(?=\s*:\s)/.source.replace(/<<prop>>/g,(function(){return n})).replace(/<<key>>/g,(function(){return"(?:"+o+"|"+i+")"}))),lookbehind:!0,greedy:!0,alias:"atrule"},directive:{pattern:/(^[ \t]*)%.+/m,lookbehind:!0,alias:"important"},datetime:{pattern:s(/\d{4}-\d\d?-\d\d?(?:[tT]|[ \t]+)\d\d?:\d{2}:\d{2}(?:\.\d*)?(?:[ \t]*(?:Z|[-+]\d\d?(?::\d{2})?))?|\d{4}-\d{2}-\d{2}|\d\d?:\d{2}(?::\d{2}(?:\.\d*)?)?/.source),lookbehind:!0,alias:"number"},boolean:{pattern:s(/false|true/.source,"i"),lookbehind:!0,alias:"important"},null:{pattern:s(/null|~/.source,"i"),lookbehind:!0,alias:"important"},string:{pattern:s(i),lookbehind:!0,greedy:!0},number:{pattern:s(/[+-]?(?:0x[\da-f]+|0o[0-7]+|(?:\d+(?:\.\d*)?|\.\d+)(?:e[+-]?\d+)?|\.inf|\.nan)/.source,"i"),lookbehind:!0},tag:r,important:t,punctuation:/---|[:[\]{}\-,|>?]|\.\.\./},e.languages.yml=e.languages.yaml}(C),function(e){var t=/(?:\\.|[^\\\n\r]|(?:\n|\r\n?)(?![\r\n]))/.source;function r(e){return e=e.replace(/<inner>/g,(function(){return t})),RegExp(/((?:^|[^\\])(?:\\{2})*)/.source+"(?:"+e+")")}var n=/(?:\\.|``(?:[^`\r\n]|`(?!`))+``|`[^`\r\n]+`|[^\\|\r\n`])+/.source,o=/\|?__(?:\|__)+\|?(?:(?:\n|\r\n?)|(?![\s\S]))/.source.replace(/__/g,(function(){return n})),i=/\|?[ \t]*:?-{3,}:?[ \t]*(?:\|[ \t]*:?-{3,}:?[ \t]*)+\|?(?:\n|\r\n?)/.source,s=(e.languages.markdown=e.languages.extend("markup",{}),e.languages.insertBefore("markdown","prolog",{"front-matter-block":{pattern:/(^(?:\s*[\r\n])?)---(?!.)[\s\S]*?[\r\n]---(?!.)/,lookbehind:!0,greedy:!0,inside:{punctuation:/^---|---$/,"front-matter":{pattern:/\S+(?:\s+\S+)*/,alias:["yaml","language-yaml"],inside:e.languages.yaml}}},blockquote:{pattern:/^>(?:[\t ]*>)*/m,alias:"punctuation"},table:{pattern:RegExp("^"+o+i+"(?:"+o+")*","m"),inside:{"table-data-rows":{pattern:RegExp("^("+o+i+")(?:"+o+")*$"),lookbehind:!0,inside:{"table-data":{pattern:RegExp(n),inside:e.languages.markdown},punctuation:/\|/}},"table-line":{pattern:RegExp("^("+o+")"+i+"$"),lookbehind:!0,inside:{punctuation:/\||:?-{3,}:?/}},"table-header-row":{pattern:RegExp("^"+o+"$"),inside:{"table-header":{pattern:RegExp(n),alias:"important",inside:e.languages.markdown},punctuation:/\|/}}}},code:[{pattern:/((?:^|\n)[ \t]*\n|(?:^|\r\n?)[ \t]*\r\n?)(?: {4}|\t).+(?:(?:\n|\r\n?)(?: {4}|\t).+)*/,lookbehind:!0,alias:"keyword"},{pattern:/^```[\s\S]*?^```$/m,greedy:!0,inside:{"code-block":{pattern:/^(```.*(?:\n|\r\n?))[\s\S]+?(?=(?:\n|\r\n?)^```$)/m,lookbehind:!0},"code-language":{pattern:/^(```).+/,lookbehind:!0},punctuation:/```/}}],title:[{pattern:/\S.*(?:\n|\r\n?)(?:==+|--+)(?=[ \t]*$)/m,alias:"important",inside:{punctuation:/==+$|--+$/}},{pattern:/(^\s*)#.+/m,lookbehind:!0,alias:"important",inside:{punctuation:/^#+|#+$/}}],hr:{pattern:/(^\s*)([*-])(?:[\t ]*\2){2,}(?=\s*$)/m,lookbehind:!0,alias:"punctuation"},list:{pattern:/(^\s*)(?:[*+-]|\d+\.)(?=[\t ].)/m,lookbehind:!0,alias:"punctuation"},"url-reference":{pattern:/!?\[[^\]]+\]:[\t ]+(?:\S+|<(?:\\.|[^>\\])+>)(?:[\t ]+(?:"(?:\\.|[^"\\])*"|'(?:\\.|[^'\\])*'|\((?:\\.|[^)\\])*\)))?/,inside:{variable:{pattern:/^(!?\[)[^\]]+/,lookbehind:!0},string:/(?:"(?:\\.|[^"\\])*"|'(?:\\.|[^'\\])*'|\((?:\\.|[^)\\])*\))$/,punctuation:/^[\[\]!:]|[<>]/},alias:"url"},bold:{pattern:r(/\b__(?:(?!_)<inner>|_(?:(?!_)<inner>)+_)+__\b|\*\*(?:(?!\*)<inner>|\*(?:(?!\*)<inner>)+\*)+\*\*/.source),lookbehind:!0,greedy:!0,inside:{content:{pattern:/(^..)[\s\S]+(?=..$)/,lookbehind:!0,inside:{}},punctuation:/\*\*|__/}},italic:{pattern:r(/\b_(?:(?!_)<inner>|__(?:(?!_)<inner>)+__)+_\b|\*(?:(?!\*)<inner>|\*\*(?:(?!\*)<inner>)+\*\*)+\*/.source),lookbehind:!0,greedy:!0,inside:{content:{pattern:/(^.)[\s\S]+(?=.$)/,lookbehind:!0,inside:{}},punctuation:/[*_]/}},strike:{pattern:r(/(~~?)(?:(?!~)<inner>)+\2/.source),lookbehind:!0,greedy:!0,inside:{content:{pattern:/(^~~?)[\s\S]+(?=\1$)/,lookbehind:!0,inside:{}},punctuation:/~~?/}},"code-snippet":{pattern:/(^|[^\\`])(?:``[^`\r\n]+(?:`[^`\r\n]+)*``(?!`)|`[^`\r\n]+`(?!`))/,lookbehind:!0,greedy:!0,alias:["code","keyword"]},url:{pattern:r(/!?\[(?:(?!\])<inner>)+\](?:\([^\s)]+(?:[\t ]+"(?:\\.|[^"\\])*")?\)|[ \t]?\[(?:(?!\])<inner>)+\])/.source),lookbehind:!0,greedy:!0,inside:{operator:/^!/,content:{pattern:/(^\[)[^\]]+(?=\])/,lookbehind:!0,inside:{}},variable:{pattern:/(^\][ \t]?\[)[^\]]+(?=\]$)/,lookbehind:!0},url:{pattern:/(^\]\()[^\s)]+/,lookbehind:!0},string:{pattern:/(^[ \t]+)"(?:\\.|[^"\\])*"(?=\)$)/,lookbehind:!0}}}}),["url","bold","italic","strike"].forEach((function(t){["url","bold","italic","strike","code-snippet"].forEach((function(r){t!==r&&(e.languages.markdown[t].inside.content.inside[r]=e.languages.markdown[r])}))})),e.hooks.add("after-tokenize",(function(e){"markdown"!==e.language&&"md"!==e.language||function e(t){if(t&&"string"!=typeof t)for(var r=0,n=t.length;r<n;r++){var o,i=t[r];"code"!==i.type?e(i.content):(o=i.content[1],i=i.content[3],o&&i&&"code-language"===o.type&&"code-block"===i.type&&"string"==typeof o.content&&(o=o.content.replace(/\b#/g,"sharp").replace(/\b\+\+/g,"pp"),o="language-"+(o=(/[a-z][\w-]*/i.exec(o)||[""])[0].toLowerCase()),i.alias?"string"==typeof i.alias?i.alias=[i.alias,o]:i.alias.push(o):i.alias=[o]))}}(e.tokens)})),e.hooks.add("wrap",(function(t){if("code-block"===t.type){for(var r="",n=0,o=t.classes.length;n<o;n++){var i=t.classes[n];if(i=/language-(.+)/.exec(i)){r=i[1];break}}var p,d=e.languages[r];d?t.content=e.highlight(t.content.replace(s,"").replace(/&(\w{1,8}|#x?[\da-f]{1,8});/gi,(function(e,t){var r;return"#"===(t=t.toLowerCase())[0]?(r="x"===t[1]?parseInt(t.slice(2),16):Number(t.slice(1)),c(r)):a[t]||e})),d,r):r&&"none"!==r&&e.plugins.autoloader&&(p="md-"+(new Date).valueOf()+"-"+Math.floor(1e16*Math.random()),t.attributes.id=p,e.plugins.autoloader.loadLanguages(r,(function(){var t=document.getElementById(p);t&&(t.innerHTML=e.highlight(t.textContent,e.languages[r],r))})))}})),RegExp(e.languages.markup.tag.pattern.source,"gi")),a={amp:"&",lt:"<",gt:">",quot:'"'},c=String.fromCodePoint||String.fromCharCode;e.languages.md=e.languages.markdown}(C),C.languages.graphql={comment:/#.*/,description:{pattern:/(?:"""(?:[^"]|(?!""")")*"""|"(?:\\.|[^\\"\r\n])*")(?=\s*[a-z_])/i,greedy:!0,alias:"string",inside:{"language-markdown":{pattern:/(^"(?:"")?)(?!\1)[\s\S]+(?=\1$)/,lookbehind:!0,inside:C.languages.markdown}}},string:{pattern:/"""(?:[^"]|(?!""")")*"""|"(?:\\.|[^\\"\r\n])*"/,greedy:!0},number:/(?:\B-|\b)\d+(?:\.\d+)?(?:e[+-]?\d+)?\b/i,boolean:/\b(?:false|true)\b/,variable:/\$[a-z_]\w*/i,directive:{pattern:/@[a-z_]\w*/i,alias:"function"},"attr-name":{pattern:/\b[a-z_]\w*(?=\s*(?:\((?:[^()"]|"(?:\\.|[^\\"\r\n])*")*\))?:)/i,greedy:!0},"atom-input":{pattern:/\b[A-Z]\w*Input\b/,alias:"class-name"},scalar:/\b(?:Boolean|Float|ID|Int|String)\b/,constant:/\b[A-Z][A-Z_\d]*\b/,"class-name":{pattern:/(\b(?:enum|implements|interface|on|scalar|type|union)\s+|&\s*|:\s*|\[)[A-Z_]\w*/,lookbehind:!0},fragment:{pattern:/(\bfragment\s+|\.{3}\s*(?!on\b))[a-zA-Z_]\w*/,lookbehind:!0,alias:"function"},"definition-mutation":{pattern:/(\bmutation\s+)[a-zA-Z_]\w*/,lookbehind:!0,alias:"function"},"definition-query":{pattern:/(\bquery\s+)[a-zA-Z_]\w*/,lookbehind:!0,alias:"function"},keyword:/\b(?:directive|enum|extend|fragment|implements|input|interface|mutation|on|query|repeatable|scalar|schema|subscription|type|union)\b/,operator:/[!=|&]|\.{3}/,"property-query":/\w+(?=\s*\()/,object:/\w+(?=\s*\{)/,punctuation:/[!(){}\[\]:=,]/,property:/\w+/},C.hooks.add("after-tokenize",(function(e){if("graphql"===e.language)for(var t=e.tokens.filter((function(e){return"string"!=typeof e&&"comment"!==e.type&&"scalar"!==e.type})),r=0;r<t.length;){var n=t[r++];if("keyword"===n.type&&"mutation"===n.content){var o=[];if(l(["definition-mutation","punctuation"])&&"("===d(1).content){r+=2;var i=u(/^\($/,/^\)$/);if(-1===i)continue;for(;r<i;r++){var s=d(0);"variable"===s.type&&(m(s,"variable-input"),o.push(s.content))}r=i+1}if(l(["punctuation","property-query"])&&"{"===d(0).content&&(r++,m(d(0),"property-mutation"),0<o.length)){var a=u(/^\{$/,/^\}$/);if(-1!==a)for(var c=r;c<a;c++){var p=t[c];"variable"===p.type&&0<=o.indexOf(p.content)&&m(p,"variable-input")}}}}function d(e){return t[r+e]}function l(e,t){t=t||0;for(var r=0;r<e.length;r++){var n=d(r+t);if(!n||n.type!==e[r])return}return 1}function u(e,n){for(var o=1,i=r;i<t.length;i++){var s=t[i],a=s.content;if("punctuation"===s.type&&"string"==typeof a)if(e.test(a))o++;else if(n.test(a)&&0==--o)return i}return-1}function m(e,t){var r=e.alias;r?Array.isArray(r)||(e.alias=r=[r]):e.alias=r=[],r.push(t)}})),C.languages.sql={comment:{pattern:/(^|[^\\])(?:\/\*[\s\S]*?\*\/|(?:--|\/\/|#).*)/,lookbehind:!0},variable:[{pattern:/@(["'`])(?:\\[\s\S]|(?!\1)[^\\])+\1/,greedy:!0},/@[\w.$]+/],string:{pattern:/(^|[^@\\])("|')(?:\\[\s\S]|(?!\2)[^\\]|\2\2)*\2/,greedy:!0,lookbehind:!0},identifier:{pattern:/(^|[^@\\])`(?:\\[\s\S]|[^`\\]|``)*`/,greedy:!0,lookbehind:!0,inside:{punctuation:/^`|`$/}},function:/\b(?:AVG|COUNT|FIRST|FORMAT|LAST|LCASE|LEN|MAX|MID|MIN|MOD|NOW|ROUND|SUM|UCASE)(?=\s*\()/i,keyword:/\b(?:ACTION|ADD|AFTER|ALGORITHM|ALL|ALTER|ANALYZE|ANY|APPLY|AS|ASC|AUTHORIZATION|AUTO_INCREMENT|BACKUP|BDB|BEGIN|BERKELEYDB|BIGINT|BINARY|BIT|BLOB|BOOL|BOOLEAN|BREAK|BROWSE|BTREE|BULK|BY|CALL|CASCADED?|CASE|CHAIN|CHAR(?:ACTER|SET)?|CHECK(?:POINT)?|CLOSE|CLUSTERED|COALESCE|COLLATE|COLUMNS?|COMMENT|COMMIT(?:TED)?|COMPUTE|CONNECT|CONSISTENT|CONSTRAINT|CONTAINS(?:TABLE)?|CONTINUE|CONVERT|CREATE|CROSS|CURRENT(?:_DATE|_TIME|_TIMESTAMP|_USER)?|CURSOR|CYCLE|DATA(?:BASES?)?|DATE(?:TIME)?|DAY|DBCC|DEALLOCATE|DEC|DECIMAL|DECLARE|DEFAULT|DEFINER|DELAYED|DELETE|DELIMITERS?|DENY|DESC|DESCRIBE|DETERMINISTIC|DISABLE|DISCARD|DISK|DISTINCT|DISTINCTROW|DISTRIBUTED|DO|DOUBLE|DROP|DUMMY|DUMP(?:FILE)?|DUPLICATE|ELSE(?:IF)?|ENABLE|ENCLOSED|END|ENGINE|ENUM|ERRLVL|ERRORS|ESCAPED?|EXCEPT|EXEC(?:UTE)?|EXISTS|EXIT|EXPLAIN|EXTENDED|FETCH|FIELDS|FILE|FILLFACTOR|FIRST|FIXED|FLOAT|FOLLOWING|FOR(?: EACH ROW)?|FORCE|FOREIGN|FREETEXT(?:TABLE)?|FROM|FULL|FUNCTION|GEOMETRY(?:COLLECTION)?|GLOBAL|GOTO|GRANT|GROUP|HANDLER|HASH|HAVING|HOLDLOCK|HOUR|IDENTITY(?:COL|_INSERT)?|IF|IGNORE|IMPORT|INDEX|INFILE|INNER|INNODB|INOUT|INSERT|INT|INTEGER|INTERSECT|INTERVAL|INTO|INVOKER|ISOLATION|ITERATE|JOIN|KEYS?|KILL|LANGUAGE|LAST|LEAVE|LEFT|LEVEL|LIMIT|LINENO|LINES|LINESTRING|LOAD|LOCAL|LOCK|LONG(?:BLOB|TEXT)|LOOP|MATCH(?:ED)?|MEDIUM(?:BLOB|INT|TEXT)|MERGE|MIDDLEINT|MINUTE|MODE|MODIFIES|MODIFY|MONTH|MULTI(?:LINESTRING|POINT|POLYGON)|NATIONAL|NATURAL|NCHAR|NEXT|NO|NONCLUSTERED|NULLIF|NUMERIC|OFF?|OFFSETS?|ON|OPEN(?:DATASOURCE|QUERY|ROWSET)?|OPTIMIZE|OPTION(?:ALLY)?|ORDER|OUT(?:ER|FILE)?|OVER|PARTIAL|PARTITION|PERCENT|PIVOT|PLAN|POINT|POLYGON|PRECEDING|PRECISION|PREPARE|PREV|PRIMARY|PRINT|PRIVILEGES|PROC(?:EDURE)?|PUBLIC|PURGE|QUICK|RAISERROR|READS?|REAL|RECONFIGURE|REFERENCES|RELEASE|RENAME|REPEAT(?:ABLE)?|REPLACE|REPLICATION|REQUIRE|RESIGNAL|RESTORE|RESTRICT|RETURN(?:ING|S)?|REVOKE|RIGHT|ROLLBACK|ROUTINE|ROW(?:COUNT|GUIDCOL|S)?|RTREE|RULE|SAVE(?:POINT)?|SCHEMA|SECOND|SELECT|SERIAL(?:IZABLE)?|SESSION(?:_USER)?|SET(?:USER)?|SHARE|SHOW|SHUTDOWN|SIMPLE|SMALLINT|SNAPSHOT|SOME|SONAME|SQL|START(?:ING)?|STATISTICS|STATUS|STRIPED|SYSTEM_USER|TABLES?|TABLESPACE|TEMP(?:ORARY|TABLE)?|TERMINATED|TEXT(?:SIZE)?|THEN|TIME(?:STAMP)?|TINY(?:BLOB|INT|TEXT)|TOP?|TRAN(?:SACTIONS?)?|TRIGGER|TRUNCATE|TSEQUAL|TYPES?|UNBOUNDED|UNCOMMITTED|UNDEFINED|UNION|UNIQUE|UNLOCK|UNPIVOT|UNSIGNED|UPDATE(?:TEXT)?|USAGE|USE|USER|USING|VALUES?|VAR(?:BINARY|CHAR|CHARACTER|YING)|VIEW|WAITFOR|WARNINGS|WHEN|WHERE|WHILE|WITH(?: ROLLUP|IN)?|WORK|WRITE(?:TEXT)?|YEAR)\b/i,boolean:/\b(?:FALSE|NULL|TRUE)\b/i,number:/\b0x[\da-f]+\b|\b\d+(?:\.\d*)?|\B\.\d+\b/i,operator:/[-+*\/=%^~]|&&?|\|\|?|!=?|<(?:=>?|<|>)?|>[>=]?|\b(?:AND|BETWEEN|DIV|ILIKE|IN|IS|LIKE|NOT|OR|REGEXP|RLIKE|SOUNDS LIKE|XOR)\b/i,punctuation:/[;[\]()`,.]/},function(e){var t=e.languages.javascript["template-string"],r=t.pattern.source,n=t.inside.interpolation,o=n.inside["interpolation-punctuation"],i=n.pattern.source;function s(t,n){if(e.languages[t])return{pattern:RegExp("((?:"+n+")\\s*)"+r),lookbehind:!0,greedy:!0,inside:{"template-punctuation":{pattern:/^`|`$/,alias:"string"},"embedded-code":{pattern:/[\s\S]+/,alias:t}}}}function a(t,r,n){return t={code:t,grammar:r,language:n},e.hooks.run("before-tokenize",t),t.tokens=e.tokenize(t.code,t.grammar),e.hooks.run("after-tokenize",t),t.tokens}function c(t,r,s){var c=e.tokenize(t,{interpolation:{pattern:RegExp(i),lookbehind:!0}}),p=0,d={},l=(c=a(c.map((function(e){if("string"==typeof e)return e;var r,n;for(e=e.content;-1!==t.indexOf((n=p++,r="___"+s.toUpperCase()+"_"+n+"___")););return d[r]=e,r})).join(""),r,s),Object.keys(d));return p=0,function t(r){for(var i=0;i<r.length;i++){if(p>=l.length)return;var s,c,u,m,h,f,g,y=r[i];"string"==typeof y||"string"==typeof y.content?(s=l[p],-1!==(g=(f="string"==typeof y?y:y.content).indexOf(s))&&(++p,c=f.substring(0,g),h=d[s],u=void 0,(m={})["interpolation-punctuation"]=o,3===(m=e.tokenize(h,m)).length&&((u=[1,1]).push.apply(u,a(m[1],e.languages.javascript,"javascript")),m.splice.apply(m,u)),u=new e.Token("interpolation",m,n.alias,h),m=f.substring(g+s.length),h=[],c&&h.push(c),h.push(u),m&&(t(f=[m]),h.push.apply(h,f)),"string"==typeof y?(r.splice.apply(r,[i,1].concat(h)),i+=h.length-1):y.content=h)):(g=y.content,Array.isArray(g)?t(g):t([g]))}}(c),new e.Token(s,c,"language-"+s,t)}e.languages.javascript["template-string"]=[s("css",/\b(?:styled(?:\([^)]*\))?(?:\s*\.\s*\w+(?:\([^)]*\))*)*|css(?:\s*\.\s*(?:global|resolve))?|createGlobalStyle|keyframes)/.source),s("html",/\bhtml|\.\s*(?:inner|outer)HTML\s*\+?=/.source),s("svg",/\bsvg/.source),s("markdown",/\b(?:markdown|md)/.source),s("graphql",/\b(?:gql|graphql(?:\s*\.\s*experimental)?)/.source),s("sql",/\bsql/.source),t].filter(Boolean);var p={javascript:!0,js:!0,typescript:!0,ts:!0,jsx:!0,tsx:!0};function d(e){return"string"==typeof e?e:Array.isArray(e)?e.map(d).join(""):d(e.content)}e.hooks.add("after-tokenize",(function(t){t.language in p&&function t(r){for(var n=0,o=r.length;n<o;n++){var i,s,a,p=r[n];"string"!=typeof p&&(i=p.content,Array.isArray(i)?"template-string"===p.type?(p=i[1],3===i.length&&"string"!=typeof p&&"embedded-code"===p.type&&(s=d(p),p=p.alias,p=Array.isArray(p)?p[0]:p,a=e.languages[p])&&(i[1]=c(s,a,p))):t(i):"string"!=typeof i&&t([i]))}}(t.tokens)}))}(C),function(e){e.languages.typescript=e.languages.extend("javascript",{"class-name":{pattern:/(\b(?:class|extends|implements|instanceof|interface|new|type)\s+)(?!keyof\b)(?!\s)[_$a-zA-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*(?:\s*<(?:[^<>]|<(?:[^<>]|<[^<>]*>)*>)*>)?/,lookbehind:!0,greedy:!0,inside:null},builtin:/\b(?:Array|Function|Promise|any|boolean|console|never|number|string|symbol|unknown)\b/}),e.languages.typescript.keyword.push(/\b(?:abstract|declare|is|keyof|readonly|require)\b/,/\b(?:asserts|infer|interface|module|namespace|type)\b(?=\s*(?:[{_$a-zA-Z\xA0-\uFFFF]|$))/,/\btype\b(?=\s*(?:[\{*]|$))/),delete e.languages.typescript.parameter,delete e.languages.typescript["literal-property"];var t=e.languages.extend("typescript",{});delete t["class-name"],e.languages.typescript["class-name"].inside=t,e.languages.insertBefore("typescript","function",{decorator:{pattern:/@[$\w\xA0-\uFFFF]+/,inside:{at:{pattern:/^@/,alias:"operator"},function:/^[\s\S]+/}},"generic-function":{pattern:/#?(?!\s)[_$a-zA-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*\s*<(?:[^<>]|<(?:[^<>]|<[^<>]*>)*>)*>(?=\s*\()/,greedy:!0,inside:{function:/^#?(?!\s)[_$a-zA-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*/,generic:{pattern:/<[\s\S]+/,alias:"class-name",inside:t}}}}),e.languages.ts=e.languages.typescript}(C),function(e){var t=e.languages.javascript,r=/\{(?:[^{}]|\{(?:[^{}]|\{[^{}]*\})*\})+\}/.source,n="(@(?:arg|argument|param|property)\\s+(?:"+r+"\\s+)?)";e.languages.jsdoc=e.languages.extend("javadoclike",{parameter:{pattern:RegExp(n+/(?:(?!\s)[$\w\xA0-\uFFFF.])+(?=\s|$)/.source),lookbehind:!0,inside:{punctuation:/\./}}}),e.languages.insertBefore("jsdoc","keyword",{"optional-parameter":{pattern:RegExp(n+/\[(?:(?!\s)[$\w\xA0-\uFFFF.])+(?:=[^[\]]+)?\](?=\s|$)/.source),lookbehind:!0,inside:{parameter:{pattern:/(^\[)[$\w\xA0-\uFFFF\.]+/,lookbehind:!0,inside:{punctuation:/\./}},code:{pattern:/(=)[\s\S]*(?=\]$)/,lookbehind:!0,inside:t,alias:"language-javascript"},punctuation:/[=[\]]/}},"class-name":[{pattern:RegExp(/(@(?:augments|class|extends|interface|memberof!?|template|this|typedef)\s+(?:<TYPE>\s+)?)[A-Z]\w*(?:\.[A-Z]\w*)*/.source.replace(/<TYPE>/g,(function(){return r}))),lookbehind:!0,inside:{punctuation:/\./}},{pattern:RegExp("(@[a-z]+\\s+)"+r),lookbehind:!0,inside:{string:t.string,number:t.number,boolean:t.boolean,keyword:e.languages.typescript.keyword,operator:/=>|\.\.\.|[&|?:*]/,punctuation:/[.,;=<>{}()[\]]/}}],example:{pattern:/(@example\s+(?!\s))(?:[^@\s]|\s+(?!\s))+?(?=\s*(?:\*\s*)?(?:@\w|\*\/))/,lookbehind:!0,inside:{code:{pattern:/^([\t ]*(?:\*\s*)?)\S.*$/m,lookbehind:!0,inside:t,alias:"language-javascript"}}}}),e.languages.javadoclike.addSupport("javascript",e.languages.jsdoc)}(C),function(e){e.languages.flow=e.languages.extend("javascript",{}),e.languages.insertBefore("flow","keyword",{type:[{pattern:/\b(?:[Bb]oolean|Function|[Nn]umber|[Ss]tring|[Ss]ymbol|any|mixed|null|void)\b/,alias:"class-name"}]}),e.languages.flow["function-variable"].pattern=/(?!\s)[_$a-z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*(?=\s*=\s*(?:function\b|(?:\([^()]*\)(?:\s*:\s*\w+)?|(?!\s)[_$a-z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*)\s*=>))/i,delete e.languages.flow.parameter,e.languages.insertBefore("flow","operator",{"flow-punctuation":{pattern:/\{\||\|\}/,alias:"punctuation"}}),Array.isArray(e.languages.flow.keyword)||(e.languages.flow.keyword=[e.languages.flow.keyword]),e.languages.flow.keyword.unshift({pattern:/(^|[^$]\b)(?:Class|declare|opaque|type)\b(?!\$)/,lookbehind:!0},{pattern:/(^|[^$]\B)\$(?:Diff|Enum|Exact|Keys|ObjMap|PropertyType|Record|Shape|Subtype|Supertype|await)\b(?!\$)/,lookbehind:!0})}(C),C.languages.n4js=C.languages.extend("javascript",{keyword:/\b(?:Array|any|boolean|break|case|catch|class|const|constructor|continue|debugger|declare|default|delete|do|else|enum|export|extends|false|finally|for|from|function|get|if|implements|import|in|instanceof|interface|let|module|new|null|number|package|private|protected|public|return|set|static|string|super|switch|this|throw|true|try|typeof|var|void|while|with|yield)\b/}),C.languages.insertBefore("n4js","constant",{annotation:{pattern:/@+\w+/,alias:"operator"}}),C.languages.n4jsd=C.languages.n4js,function(e){function t(e,t){return RegExp(e.replace(/<ID>/g,(function(){return/(?!\s)[_$a-zA-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*/.source})),t)}e.languages.insertBefore("javascript","function-variable",{"method-variable":{pattern:RegExp("(\\.\\s*)"+e.languages.javascript["function-variable"].pattern.source),lookbehind:!0,alias:["function-variable","method","function","property-access"]}}),e.languages.insertBefore("javascript","function",{method:{pattern:RegExp("(\\.\\s*)"+e.languages.javascript.function.source),lookbehind:!0,alias:["function","property-access"]}}),e.languages.insertBefore("javascript","constant",{"known-class-name":[{pattern:/\b(?:(?:Float(?:32|64)|(?:Int|Uint)(?:8|16|32)|Uint8Clamped)?Array|ArrayBuffer|BigInt|Boolean|DataView|Date|Error|Function|Intl|JSON|(?:Weak)?(?:Map|Set)|Math|Number|Object|Promise|Proxy|Reflect|RegExp|String|Symbol|WebAssembly)\b/,alias:"class-name"},{pattern:/\b(?:[A-Z]\w*)Error\b/,alias:"class-name"}]}),e.languages.insertBefore("javascript","keyword",{imports:{pattern:t(/(\bimport\b\s*)(?:<ID>(?:\s*,\s*(?:\*\s*as\s+<ID>|\{[^{}]*\}))?|\*\s*as\s+<ID>|\{[^{}]*\})(?=\s*\bfrom\b)/.source),lookbehind:!0,inside:e.languages.javascript},exports:{pattern:t(/(\bexport\b\s*)(?:\*(?:\s*as\s+<ID>)?(?=\s*\bfrom\b)|\{[^{}]*\})/.source),lookbehind:!0,inside:e.languages.javascript}}),e.languages.javascript.keyword.unshift({pattern:/\b(?:as|default|export|from|import)\b/,alias:"module"},{pattern:/\b(?:await|break|catch|continue|do|else|finally|for|if|return|switch|throw|try|while|yield)\b/,alias:"control-flow"},{pattern:/\bnull\b/,alias:["null","nil"]},{pattern:/\bundefined\b/,alias:"nil"}),e.languages.insertBefore("javascript","operator",{spread:{pattern:/\.{3}/,alias:"operator"},arrow:{pattern:/=>/,alias:"operator"}}),e.languages.insertBefore("javascript","punctuation",{"property-access":{pattern:t(/(\.\s*)#?<ID>/.source),lookbehind:!0},"maybe-class-name":{pattern:/(^|[^$\w\xA0-\uFFFF])[A-Z][$\w\xA0-\uFFFF]+/,lookbehind:!0},dom:{pattern:/\b(?:document|(?:local|session)Storage|location|navigator|performance|window)\b/,alias:"variable"},console:{pattern:/\bconsole(?=\s*\.)/,alias:"class-name"}});for(var r=["function","function-variable","method","method-variable","property-access"],n=0;n<r.length;n++){var o=r[n],i=e.languages.javascript[o];o=(i="RegExp"===e.util.type(i)?e.languages.javascript[o]={pattern:i}:i).inside||{};(i.inside=o)["maybe-class-name"]=/^[A-Z][\s\S]*/}}(C),function(e){var t=e.util.clone(e.languages.javascript),r=/(?:\s|\/\/.*(?!.)|\/\*(?:[^*]|\*(?!\/))\*\/)/.source,n=/(?:\{(?:\{(?:\{[^{}]*\}|[^{}])*\}|[^{}])*\})/.source,o=/(?:\{<S>*\.{3}(?:[^{}]|<BRACES>)*\})/.source;function i(e,t){return e=e.replace(/<S>/g,(function(){return r})).replace(/<BRACES>/g,(function(){return n})).replace(/<SPREAD>/g,(function(){return o})),RegExp(e,t)}function s(t){for(var r=[],n=0;n<t.length;n++){var o=t[n],i=!1;"string"!=typeof o&&("tag"===o.type&&o.content[0]&&"tag"===o.content[0].type?"</"===o.content[0].content[0].content?0<r.length&&r[r.length-1].tagName===a(o.content[0].content[1])&&r.pop():"/>"!==o.content[o.content.length-1].content&&r.push({tagName:a(o.content[0].content[1]),openedBraces:0}):0<r.length&&"punctuation"===o.type&&"{"===o.content?r[r.length-1].openedBraces++:0<r.length&&0<r[r.length-1].openedBraces&&"punctuation"===o.type&&"}"===o.content?r[r.length-1].openedBraces--:i=!0),(i||"string"==typeof o)&&0<r.length&&0===r[r.length-1].openedBraces&&(i=a(o),n<t.length-1&&("string"==typeof t[n+1]||"plain-text"===t[n+1].type)&&(i+=a(t[n+1]),t.splice(n+1,1)),0<n&&("string"==typeof t[n-1]||"plain-text"===t[n-1].type)&&(i=a(t[n-1])+i,t.splice(n-1,1),n--),t[n]=new e.Token("plain-text",i,null,i)),o.content&&"string"!=typeof o.content&&s(o.content)}}o=i(o).source,e.languages.jsx=e.languages.extend("markup",t),e.languages.jsx.tag.pattern=i(/<\/?(?:[\w.:-]+(?:<S>+(?:[\w.:$-]+(?:=(?:"(?:\\[\s\S]|[^\\"])*"|'(?:\\[\s\S]|[^\\'])*'|[^\s{'"/>=]+|<BRACES>))?|<SPREAD>))*<S>*\/?)?>/.source),e.languages.jsx.tag.inside.tag.pattern=/^<\/?[^\s>\/]*/,e.languages.jsx.tag.inside["attr-value"].pattern=/=(?!\{)(?:"(?:\\[\s\S]|[^\\"])*"|'(?:\\[\s\S]|[^\\'])*'|[^\s'">]+)/,e.languages.jsx.tag.inside.tag.inside["class-name"]=/^[A-Z]\w*(?:\.[A-Z]\w*)*$/,e.languages.jsx.tag.inside.comment=t.comment,e.languages.insertBefore("inside","attr-name",{spread:{pattern:i(/<SPREAD>/.source),inside:e.languages.jsx}},e.languages.jsx.tag),e.languages.insertBefore("inside","special-attr",{script:{pattern:i(/=<BRACES>/.source),alias:"language-javascript",inside:{"script-punctuation":{pattern:/^=(?=\{)/,alias:"punctuation"},rest:e.languages.jsx}}},e.languages.jsx.tag);var a=function(e){return e?"string"==typeof e?e:"string"==typeof e.content?e.content:e.content.map(a).join(""):""};e.hooks.add("after-tokenize",(function(e){"jsx"!==e.language&&"tsx"!==e.language||s(e.tokens)}))}(C),function(e){var t=e.util.clone(e.languages.typescript);(t=(e.languages.tsx=e.languages.extend("jsx",t),delete e.languages.tsx.parameter,delete e.languages.tsx["literal-property"],e.languages.tsx.tag)).pattern=RegExp(/(^|[^\w$]|(?=<\/))/.source+"(?:"+t.pattern.source+")",t.pattern.flags),t.lookbehind=!0}(C),C.languages.swift={comment:{pattern:/(^|[^\\:])(?:\/\/.*|\/\*(?:[^/*]|\/(?!\*)|\*(?!\/)|\/\*(?:[^*]|\*(?!\/))*\*\/)*\*\/)/,lookbehind:!0,greedy:!0},"string-literal":[{pattern:RegExp(/(^|[^"#])/.source+"(?:"+/"(?:\\(?:\((?:[^()]|\([^()]*\))*\)|\r\n|[^(])|[^\\\r\n"])*"/.source+"|"+/"""(?:\\(?:\((?:[^()]|\([^()]*\))*\)|[^(])|[^\\"]|"(?!""))*"""/.source+")"+/(?!["#])/.source),lookbehind:!0,greedy:!0,inside:{interpolation:{pattern:/(\\\()(?:[^()]|\([^()]*\))*(?=\))/,lookbehind:!0,inside:null},"interpolation-punctuation":{pattern:/^\)|\\\($/,alias:"punctuation"},punctuation:/\\(?=[\r\n])/,string:/[\s\S]+/}},{pattern:RegExp(/(^|[^"#])(#+)/.source+"(?:"+/"(?:\\(?:#+\((?:[^()]|\([^()]*\))*\)|\r\n|[^#])|[^\\\r\n])*?"/.source+"|"+/"""(?:\\(?:#+\((?:[^()]|\([^()]*\))*\)|[^#])|[^\\])*?"""/.source+")\\2"),lookbehind:!0,greedy:!0,inside:{interpolation:{pattern:/(\\#+\()(?:[^()]|\([^()]*\))*(?=\))/,lookbehind:!0,inside:null},"interpolation-punctuation":{pattern:/^\)|\\#+\($/,alias:"punctuation"},string:/[\s\S]+/}}],directive:{pattern:RegExp(/#/.source+"(?:"+/(?:elseif|if)\b/.source+"(?:[ \t]*"+/(?:![ \t]*)?(?:\b\w+\b(?:[ \t]*\((?:[^()]|\([^()]*\))*\))?|\((?:[^()]|\([^()]*\))*\))(?:[ \t]*(?:&&|\|\|))?/.source+")+|"+/(?:else|endif)\b/.source+")"),alias:"property",inside:{"directive-name":/^#\w+/,boolean:/\b(?:false|true)\b/,number:/\b\d+(?:\.\d+)*\b/,operator:/!|&&|\|\||[<>]=?/,punctuation:/[(),]/}},literal:{pattern:/#(?:colorLiteral|column|dsohandle|file(?:ID|Literal|Path)?|function|imageLiteral|line)\b/,alias:"constant"},"other-directive":{pattern:/#\w+\b/,alias:"property"},attribute:{pattern:/@\w+/,alias:"atrule"},"function-definition":{pattern:/(\bfunc\s+)\w+/,lookbehind:!0,alias:"function"},label:{pattern:/\b(break|continue)\s+\w+|\b[a-zA-Z_]\w*(?=\s*:\s*(?:for|repeat|while)\b)/,lookbehind:!0,alias:"important"},keyword:/\b(?:Any|Protocol|Self|Type|actor|as|assignment|associatedtype|associativity|async|await|break|case|catch|class|continue|convenience|default|defer|deinit|didSet|do|dynamic|else|enum|extension|fallthrough|fileprivate|final|for|func|get|guard|higherThan|if|import|in|indirect|infix|init|inout|internal|is|isolated|lazy|left|let|lowerThan|mutating|none|nonisolated|nonmutating|open|operator|optional|override|postfix|precedencegroup|prefix|private|protocol|public|repeat|required|rethrows|return|right|safe|self|set|some|static|struct|subscript|super|switch|throw|throws|try|typealias|unowned|unsafe|var|weak|where|while|willSet)\b/,boolean:/\b(?:false|true)\b/,nil:{pattern:/\bnil\b/,alias:"constant"},"short-argument":/\$\d+\b/,omit:{pattern:/\b_\b/,alias:"keyword"},number:/\b(?:[\d_]+(?:\.[\de_]+)?|0x[a-f0-9_]+(?:\.[a-f0-9p_]+)?|0b[01_]+|0o[0-7_]+)\b/i,"class-name":/\b[A-Z](?:[A-Z_\d]*[a-z]\w*)?\b/,function:/\b[a-z_]\w*(?=\s*\()/i,constant:/\b(?:[A-Z_]{2,}|k[A-Z][A-Za-z_]+)\b/,operator:/[-+*/%=!<>&|^~?]+|\.[.\-+*/%=!<>&|^~?]+/,punctuation:/[{}[\]();,.:\\]/},C.languages.swift["string-literal"].forEach((function(e){e.inside.interpolation.inside=C.languages.swift})),function(e){e.languages.kotlin=e.languages.extend("clike",{keyword:{pattern:/(^|[^.])\b(?:abstract|actual|annotation|as|break|by|catch|class|companion|const|constructor|continue|crossinline|data|do|dynamic|else|enum|expect|external|final|finally|for|fun|get|if|import|in|infix|init|inline|inner|interface|internal|is|lateinit|noinline|null|object|open|operator|out|override|package|private|protected|public|reified|return|sealed|set|super|suspend|tailrec|this|throw|to|try|typealias|val|var|vararg|when|where|while)\b/,lookbehind:!0},function:[{pattern:/(?:`[^\r\n`]+`|\b\w+)(?=\s*\()/,greedy:!0},{pattern:/(\.)(?:`[^\r\n`]+`|\w+)(?=\s*\{)/,lookbehind:!0,greedy:!0}],number:/\b(?:0[xX][\da-fA-F]+(?:_[\da-fA-F]+)*|0[bB][01]+(?:_[01]+)*|\d+(?:_\d+)*(?:\.\d+(?:_\d+)*)?(?:[eE][+-]?\d+(?:_\d+)*)?[fFL]?)\b/,operator:/\+[+=]?|-[-=>]?|==?=?|!(?:!|==?)?|[\/*%<>]=?|[?:]:?|\.\.|&&|\|\||\b(?:and|inv|or|shl|shr|ushr|xor)\b/}),delete e.languages.kotlin["class-name"];var t={"interpolation-punctuation":{pattern:/^\$\{?|\}$/,alias:"punctuation"},expression:{pattern:/[\s\S]+/,inside:e.languages.kotlin}};e.languages.insertBefore("kotlin","string",{"string-literal":[{pattern:/"""(?:[^$]|\$(?:(?!\{)|\{[^{}]*\}))*?"""/,alias:"multiline",inside:{interpolation:{pattern:/\$(?:[a-z_]\w*|\{[^{}]*\})/i,inside:t},string:/[\s\S]+/}},{pattern:/"(?:[^"\\\r\n$]|\\.|\$(?:(?!\{)|\{[^{}]*\}))*"/,alias:"singleline",inside:{interpolation:{pattern:/((?:^|[^\\])(?:\\{2})*)\$(?:[a-z_]\w*|\{[^{}]*\})/i,lookbehind:!0,inside:t},string:/[\s\S]+/}}],char:{pattern:/'(?:[^'\\\r\n]|\\(?:.|u[a-fA-F0-9]{0,4}))'/,greedy:!0}}),delete e.languages.kotlin.string,e.languages.insertBefore("kotlin","keyword",{annotation:{pattern:/\B@(?:\w+:)?(?:[A-Z]\w*|\[[^\]]+\])/,alias:"builtin"}}),e.languages.insertBefore("kotlin","function",{label:{pattern:/\b\w+@|@\w+\b/,alias:"symbol"}}),e.languages.kt=e.languages.kotlin,e.languages.kts=e.languages.kotlin}(C),C.languages.c=C.languages.extend("clike",{comment:{pattern:/\/\/(?:[^\r\n\\]|\\(?:\r\n?|\n|(?![\r\n])))*|\/\*[\s\S]*?(?:\*\/|$)/,greedy:!0},string:{pattern:/"(?:\\(?:\r\n|[\s\S])|[^"\\\r\n])*"/,greedy:!0},"class-name":{pattern:/(\b(?:enum|struct)\s+(?:__attribute__\s*\(\([\s\S]*?\)\)\s*)?)\w+|\b[a-z]\w*_t\b/,lookbehind:!0},keyword:/\b(?:_Alignas|_Alignof|_Atomic|_Bool|_Complex|_Generic|_Imaginary|_Noreturn|_Static_assert|_Thread_local|__attribute__|asm|auto|break|case|char|const|continue|default|do|double|else|enum|extern|float|for|goto|if|inline|int|long|register|return|short|signed|sizeof|static|struct|switch|typedef|typeof|union|unsigned|void|volatile|while)\b/,function:/\b[a-z_]\w*(?=\s*\()/i,number:/(?:\b0x(?:[\da-f]+(?:\.[\da-f]*)?|\.[\da-f]+)(?:p[+-]?\d+)?|(?:\b\d+(?:\.\d*)?|\B\.\d+)(?:e[+-]?\d+)?)[ful]{0,4}/i,operator:/>>=?|<<=?|->|([-+&|:])\1|[?:~]|[-+*/%&|^!=<>]=?/}),C.languages.insertBefore("c","string",{char:{pattern:/'(?:\\(?:\r\n|[\s\S])|[^'\\\r\n]){0,32}'/,greedy:!0}}),C.languages.insertBefore("c","string",{macro:{pattern:/(^[\t ]*)#\s*[a-z](?:[^\r\n\\/]|\/(?!\*)|\/\*(?:[^*]|\*(?!\/))*\*\/|\\(?:\r\n|[\s\S]))*/im,lookbehind:!0,greedy:!0,alias:"property",inside:{string:[{pattern:/^(#\s*include\s*)<[^>]+>/,lookbehind:!0},C.languages.c.string],char:C.languages.c.char,comment:C.languages.c.comment,"macro-name":[{pattern:/(^#\s*define\s+)\w+\b(?!\()/i,lookbehind:!0},{pattern:/(^#\s*define\s+)\w+\b(?=\()/i,lookbehind:!0,alias:"function"}],directive:{pattern:/^(#\s*)[a-z]+/,lookbehind:!0,alias:"keyword"},"directive-hash":/^#/,punctuation:/##|\\(?=[\r\n])/,expression:{pattern:/\S[\s\S]*/,inside:C.languages.c}}}}),C.languages.insertBefore("c","function",{constant:/\b(?:EOF|NULL|SEEK_CUR|SEEK_END|SEEK_SET|__DATE__|__FILE__|__LINE__|__TIMESTAMP__|__TIME__|__func__|stderr|stdin|stdout)\b/}),delete C.languages.c.boolean,C.languages.objectivec=C.languages.extend("c",{string:{pattern:/@?"(?:\\(?:\r\n|[\s\S])|[^"\\\r\n])*"/,greedy:!0},keyword:/\b(?:asm|auto|break|case|char|const|continue|default|do|double|else|enum|extern|float|for|goto|if|in|inline|int|long|register|return|self|short|signed|sizeof|static|struct|super|switch|typedef|typeof|union|unsigned|void|volatile|while)\b|(?:@interface|@end|@implementation|@protocol|@class|@public|@protected|@private|@property|@try|@catch|@finally|@throw|@synthesize|@dynamic|@selector)\b/,operator:/-[->]?|\+\+?|!=?|<<?=?|>>?=?|==?|&&?|\|\|?|[~^%?*\/@]/}),delete C.languages.objectivec["class-name"],C.languages.objc=C.languages.objectivec,C.languages.reason=C.languages.extend("clike",{string:{pattern:/"(?:\\(?:\r\n|[\s\S])|[^\\\r\n"])*"/,greedy:!0},"class-name":/\b[A-Z]\w*/,keyword:/\b(?:and|as|assert|begin|class|constraint|do|done|downto|else|end|exception|external|for|fun|function|functor|if|in|include|inherit|initializer|lazy|let|method|module|mutable|new|nonrec|object|of|open|or|private|rec|sig|struct|switch|then|to|try|type|val|virtual|when|while|with)\b/,operator:/\.{3}|:[:=]|\|>|->|=(?:==?|>)?|<=?|>=?|[|^?'#!~`]|[+\-*\/]\.?|\b(?:asr|land|lor|lsl|lsr|lxor|mod)\b/}),C.languages.insertBefore("reason","class-name",{char:{pattern:/'(?:\\x[\da-f]{2}|\\o[0-3][0-7][0-7]|\\\d{3}|\\.|[^'\\\r\n])'/,greedy:!0},constructor:/\b[A-Z]\w*\b(?!\s*\.)/,label:{pattern:/\b[a-z]\w*(?=::)/,alias:"symbol"}}),delete C.languages.reason.function,function(e){for(var t=/\/\*(?:[^*/]|\*(?!\/)|\/(?!\*)|<self>)*\*\//.source,r=0;r<2;r++)t=t.replace(/<self>/g,(function(){return t}));t=t.replace(/<self>/g,(function(){return/[^\s\S]/.source})),e.languages.rust={comment:[{pattern:RegExp(/(^|[^\\])/.source+t),lookbehind:!0,greedy:!0},{pattern:/(^|[^\\:])\/\/.*/,lookbehind:!0,greedy:!0}],string:{pattern:/b?"(?:\\[\s\S]|[^\\"])*"|b?r(#*)"(?:[^"]|"(?!\1))*"\1/,greedy:!0},char:{pattern:/b?'(?:\\(?:x[0-7][\da-fA-F]|u\{(?:[\da-fA-F]_*){1,6}\}|.)|[^\\\r\n\t'])'/,greedy:!0},attribute:{pattern:/#!?\[(?:[^\[\]"]|"(?:\\[\s\S]|[^\\"])*")*\]/,greedy:!0,alias:"attr-name",inside:{string:null}},"closure-params":{pattern:/([=(,:]\s*|\bmove\s*)\|[^|]*\||\|[^|]*\|(?=\s*(?:\{|->))/,lookbehind:!0,greedy:!0,inside:{"closure-punctuation":{pattern:/^\||\|$/,alias:"punctuation"},rest:null}},"lifetime-annotation":{pattern:/'\w+/,alias:"symbol"},"fragment-specifier":{pattern:/(\$\w+:)[a-z]+/,lookbehind:!0,alias:"punctuation"},variable:/\$\w+/,"function-definition":{pattern:/(\bfn\s+)\w+/,lookbehind:!0,alias:"function"},"type-definition":{pattern:/(\b(?:enum|struct|trait|type|union)\s+)\w+/,lookbehind:!0,alias:"class-name"},"module-declaration":[{pattern:/(\b(?:crate|mod)\s+)[a-z][a-z_\d]*/,lookbehind:!0,alias:"namespace"},{pattern:/(\b(?:crate|self|super)\s*)::\s*[a-z][a-z_\d]*\b(?:\s*::(?:\s*[a-z][a-z_\d]*\s*::)*)?/,lookbehind:!0,alias:"namespace",inside:{punctuation:/::/}}],keyword:[/\b(?:Self|abstract|as|async|await|become|box|break|const|continue|crate|do|dyn|else|enum|extern|final|fn|for|if|impl|in|let|loop|macro|match|mod|move|mut|override|priv|pub|ref|return|self|static|struct|super|trait|try|type|typeof|union|unsafe|unsized|use|virtual|where|while|yield)\b/,/\b(?:bool|char|f(?:32|64)|[ui](?:8|16|32|64|128|size)|str)\b/],function:/\b[a-z_]\w*(?=\s*(?:::\s*<|\())/,macro:{pattern:/\b\w+!/,alias:"property"},constant:/\b[A-Z_][A-Z_\d]+\b/,"class-name":/\b[A-Z]\w*\b/,namespace:{pattern:/(?:\b[a-z][a-z_\d]*\s*::\s*)*\b[a-z][a-z_\d]*\s*::(?!\s*<)/,inside:{punctuation:/::/}},number:/\b(?:0x[\dA-Fa-f](?:_?[\dA-Fa-f])*|0o[0-7](?:_?[0-7])*|0b[01](?:_?[01])*|(?:(?:\d(?:_?\d)*)?\.)?\d(?:_?\d)*(?:[Ee][+-]?\d+)?)(?:_?(?:f32|f64|[iu](?:8|16|32|64|size)?))?\b/,boolean:/\b(?:false|true)\b/,punctuation:/->|\.\.=|\.{1,3}|::|[{}[\];(),:]/,operator:/[-+*\/%!^]=?|=[=>]?|&[&=]?|\|[|=]?|<<?=?|>>?=?|[@?]/},e.languages.rust["closure-params"].inside.rest=e.languages.rust,e.languages.rust.attribute.inside.string=e.languages.rust.string}(C),C.languages.go=C.languages.extend("clike",{string:{pattern:/(^|[^\\])"(?:\\.|[^"\\\r\n])*"|`[^`]*`/,lookbehind:!0,greedy:!0},keyword:/\b(?:break|case|chan|const|continue|default|defer|else|fallthrough|for|func|go(?:to)?|if|import|interface|map|package|range|return|select|struct|switch|type|var)\b/,boolean:/\b(?:_|false|iota|nil|true)\b/,number:[/\b0(?:b[01_]+|o[0-7_]+)i?\b/i,/\b0x(?:[a-f\d_]+(?:\.[a-f\d_]*)?|\.[a-f\d_]+)(?:p[+-]?\d+(?:_\d+)*)?i?(?!\w)/i,/(?:\b\d[\d_]*(?:\.[\d_]*)?|\B\.\d[\d_]*)(?:e[+-]?[\d_]+)?i?(?!\w)/i],operator:/[*\/%^!=]=?|\+[=+]?|-[=-]?|\|[=|]?|&(?:=|&|\^=?)?|>(?:>=?|=)?|<(?:<=?|=|-)?|:=|\.\.\./,builtin:/\b(?:append|bool|byte|cap|close|complex|complex(?:64|128)|copy|delete|error|float(?:32|64)|u?int(?:8|16|32|64)?|imag|len|make|new|panic|print(?:ln)?|real|recover|rune|string|uintptr)\b/}),C.languages.insertBefore("go","string",{char:{pattern:/'(?:\\.|[^'\\\r\n]){0,10}'/,greedy:!0}}),delete C.languages.go["class-name"],function(e){var t=/\b(?:alignas|alignof|asm|auto|bool|break|case|catch|char|char16_t|char32_t|char8_t|class|co_await|co_return|co_yield|compl|concept|const|const_cast|consteval|constexpr|constinit|continue|decltype|default|delete|do|double|dynamic_cast|else|enum|explicit|export|extern|final|float|for|friend|goto|if|import|inline|int|int16_t|int32_t|int64_t|int8_t|long|module|mutable|namespace|new|noexcept|nullptr|operator|override|private|protected|public|register|reinterpret_cast|requires|return|short|signed|sizeof|static|static_assert|static_cast|struct|switch|template|this|thread_local|throw|try|typedef|typeid|typename|uint16_t|uint32_t|uint64_t|uint8_t|union|unsigned|using|virtual|void|volatile|wchar_t|while)\b/,r=/\b(?!<keyword>)\w+(?:\s*\.\s*\w+)*\b/.source.replace(/<keyword>/g,(function(){return t.source}));e.languages.cpp=e.languages.extend("c",{"class-name":[{pattern:RegExp(/(\b(?:class|concept|enum|struct|typename)\s+)(?!<keyword>)\w+/.source.replace(/<keyword>/g,(function(){return t.source}))),lookbehind:!0},/\b[A-Z]\w*(?=\s*::\s*\w+\s*\()/,/\b[A-Z_]\w*(?=\s*::\s*~\w+\s*\()/i,/\b\w+(?=\s*<(?:[^<>]|<(?:[^<>]|<[^<>]*>)*>)*>\s*::\s*\w+\s*\()/],keyword:t,number:{pattern:/(?:\b0b[01']+|\b0x(?:[\da-f']+(?:\.[\da-f']*)?|\.[\da-f']+)(?:p[+-]?[\d']+)?|(?:\b[\d']+(?:\.[\d']*)?|\B\.[\d']+)(?:e[+-]?[\d']+)?)[ful]{0,4}/i,greedy:!0},operator:/>>=?|<<=?|->|--|\+\+|&&|\|\||[?:~]|<=>|[-+*/%&|^!=<>]=?|\b(?:and|and_eq|bitand|bitor|not|not_eq|or|or_eq|xor|xor_eq)\b/,boolean:/\b(?:false|true)\b/}),e.languages.insertBefore("cpp","string",{module:{pattern:RegExp(/(\b(?:import|module)\s+)/.source+"(?:"+/"(?:\\(?:\r\n|[\s\S])|[^"\\\r\n])*"|<[^<>\r\n]*>/.source+"|"+/<mod-name>(?:\s*:\s*<mod-name>)?|:\s*<mod-name>/.source.replace(/<mod-name>/g,(function(){return r}))+")"),lookbehind:!0,greedy:!0,inside:{string:/^[<"][\s\S]+/,operator:/:/,punctuation:/\./}},"raw-string":{pattern:/R"([^()\\ ]{0,16})\([\s\S]*?\)\1"/,alias:"string",greedy:!0}}),e.languages.insertBefore("cpp","keyword",{"generic-function":{pattern:/\b(?!operator\b)[a-z_]\w*\s*<(?:[^<>]|<[^<>]*>)*>(?=\s*\()/i,inside:{function:/^\w+/,generic:{pattern:/<[\s\S]+/,alias:"class-name",inside:e.languages.cpp}}}}),e.languages.insertBefore("cpp","operator",{"double-colon":{pattern:/::/,alias:"punctuation"}}),e.languages.insertBefore("cpp","class-name",{"base-clause":{pattern:/(\b(?:class|struct)\s+\w+\s*:\s*)[^;{}"'\s]+(?:\s+[^;{}"'\s]+)*(?=\s*[;{])/,lookbehind:!0,greedy:!0,inside:e.languages.extend("cpp",{})}}),e.languages.insertBefore("inside","double-colon",{"class-name":/\b[a-z_]\w*\b(?!\s*::)/i},e.languages.cpp["base-clause"])}(C),C.languages.python={comment:{pattern:/(^|[^\\])#.*/,lookbehind:!0,greedy:!0},"string-interpolation":{pattern:/(?:f|fr|rf)(?:("""|''')[\s\S]*?\1|("|')(?:\\.|(?!\2)[^\\\r\n])*\2)/i,greedy:!0,inside:{interpolation:{pattern:/((?:^|[^{])(?:\{\{)*)\{(?!\{)(?:[^{}]|\{(?!\{)(?:[^{}]|\{(?!\{)(?:[^{}])+\})+\})+\}/,lookbehind:!0,inside:{"format-spec":{pattern:/(:)[^:(){}]+(?=\}$)/,lookbehind:!0},"conversion-option":{pattern:/![sra](?=[:}]$)/,alias:"punctuation"},rest:null}},string:/[\s\S]+/}},"triple-quoted-string":{pattern:/(?:[rub]|br|rb)?("""|''')[\s\S]*?\1/i,greedy:!0,alias:"string"},string:{pattern:/(?:[rub]|br|rb)?("|')(?:\\.|(?!\1)[^\\\r\n])*\1/i,greedy:!0},function:{pattern:/((?:^|\s)def[ \t]+)[a-zA-Z_]\w*(?=\s*\()/g,lookbehind:!0},"class-name":{pattern:/(\bclass\s+)\w+/i,lookbehind:!0},decorator:{pattern:/(^[\t ]*)@\w+(?:\.\w+)*/m,lookbehind:!0,alias:["annotation","punctuation"],inside:{punctuation:/\./}},keyword:/\b(?:_(?=\s*:)|and|as|assert|async|await|break|case|class|continue|def|del|elif|else|except|exec|finally|for|from|global|if|import|in|is|lambda|match|nonlocal|not|or|pass|print|raise|return|try|while|with|yield)\b/,builtin:/\b(?:__import__|abs|all|any|apply|ascii|basestring|bin|bool|buffer|bytearray|bytes|callable|chr|classmethod|cmp|coerce|compile|complex|delattr|dict|dir|divmod|enumerate|eval|execfile|file|filter|float|format|frozenset|getattr|globals|hasattr|hash|help|hex|id|input|int|intern|isinstance|issubclass|iter|len|list|locals|long|map|max|memoryview|min|next|object|oct|open|ord|pow|property|range|raw_input|reduce|reload|repr|reversed|round|set|setattr|slice|sorted|staticmethod|str|sum|super|tuple|type|unichr|unicode|vars|xrange|zip)\b/,boolean:/\b(?:False|None|True)\b/,number:/\b0(?:b(?:_?[01])+|o(?:_?[0-7])+|x(?:_?[a-f0-9])+)\b|(?:\b\d+(?:_\d+)*(?:\.(?:\d+(?:_\d+)*)?)?|\B\.\d+(?:_\d+)*)(?:e[+-]?\d+(?:_\d+)*)?j?(?!\w)/i,operator:/[-+%=]=?|!=|:=|\*\*?=?|\/\/?=?|<[<=>]?|>[=>]?|[&|^~]/,punctuation:/[{}[\];(),.:]/},C.languages.python["string-interpolation"].inside.interpolation.inside.rest=C.languages.python,C.languages.py=C.languages.python;((e,t)=>{for(var r in t)u(e,r,{get:t[r],enumerable:!0})})({},{dracula:()=>A,duotoneDark:()=>I,duotoneLight:()=>j,github:()=>E,jettwaveDark:()=>G,jettwaveLight:()=>z,nightOwl:()=>P,nightOwlLight:()=>R,oceanicNext:()=>$,okaidia:()=>D,oneDark:()=>W,oneLight:()=>H,palenight:()=>B,shadesOfPurple:()=>L,synthwave84:()=>U,ultramin:()=>N,vsDark:()=>F,vsLight:()=>M});var A={plain:{color:"#F8F8F2",backgroundColor:"#282A36"},styles:[{types:["prolog","constant","builtin"],style:{color:"rgb(189, 147, 249)"}},{types:["inserted","function"],style:{color:"rgb(80, 250, 123)"}},{types:["deleted"],style:{color:"rgb(255, 85, 85)"}},{types:["changed"],style:{color:"rgb(255, 184, 108)"}},{types:["punctuation","symbol"],style:{color:"rgb(248, 248, 242)"}},{types:["string","char","tag","selector"],style:{color:"rgb(255, 121, 198)"}},{types:["keyword","variable"],style:{color:"rgb(189, 147, 249)",fontStyle:"italic"}},{types:["comment"],style:{color:"rgb(98, 114, 164)"}},{types:["attr-name"],style:{color:"rgb(241, 250, 140)"}}]},I={plain:{backgroundColor:"#2a2734",color:"#9a86fd"},styles:[{types:["comment","prolog","doctype","cdata","punctuation"],style:{color:"#6c6783"}},{types:["namespace"],style:{opacity:.7}},{types:["tag","operator","number"],style:{color:"#e09142"}},{types:["property","function"],style:{color:"#9a86fd"}},{types:["tag-id","selector","atrule-id"],style:{color:"#eeebff"}},{types:["attr-name"],style:{color:"#c4b9fe"}},{types:["boolean","string","entity","url","attr-value","keyword","control","directive","unit","statement","regex","atrule","placeholder","variable"],style:{color:"#ffcc99"}},{types:["deleted"],style:{textDecorationLine:"line-through"}},{types:["inserted"],style:{textDecorationLine:"underline"}},{types:["italic"],style:{fontStyle:"italic"}},{types:["important","bold"],style:{fontWeight:"bold"}},{types:["important"],style:{color:"#c4b9fe"}}]},j={plain:{backgroundColor:"#faf8f5",color:"#728fcb"},styles:[{types:["comment","prolog","doctype","cdata","punctuation"],style:{color:"#b6ad9a"}},{types:["namespace"],style:{opacity:.7}},{types:["tag","operator","number"],style:{color:"#063289"}},{types:["property","function"],style:{color:"#b29762"}},{types:["tag-id","selector","atrule-id"],style:{color:"#2d2006"}},{types:["attr-name"],style:{color:"#896724"}},{types:["boolean","string","entity","url","attr-value","keyword","control","directive","unit","statement","regex","atrule"],style:{color:"#728fcb"}},{types:["placeholder","variable"],style:{color:"#93abdc"}},{types:["deleted"],style:{textDecorationLine:"line-through"}},{types:["inserted"],style:{textDecorationLine:"underline"}},{types:["italic"],style:{fontStyle:"italic"}},{types:["important","bold"],style:{fontWeight:"bold"}},{types:["important"],style:{color:"#896724"}}]},E={plain:{color:"#393A34",backgroundColor:"#f6f8fa"},styles:[{types:["comment","prolog","doctype","cdata"],style:{color:"#999988",fontStyle:"italic"}},{types:["namespace"],style:{opacity:.7}},{types:["string","attr-value"],style:{color:"#e3116c"}},{types:["punctuation","operator"],style:{color:"#393A34"}},{types:["entity","url","symbol","number","boolean","variable","constant","property","regex","inserted"],style:{color:"#36acaa"}},{types:["atrule","keyword","attr-name","selector"],style:{color:"#00a4db"}},{types:["function","deleted","tag"],style:{color:"#d73a49"}},{types:["function-variable"],style:{color:"#6f42c1"}},{types:["tag","selector","keyword"],style:{color:"#00009f"}}]},P={plain:{color:"#d6deeb",backgroundColor:"#011627"},styles:[{types:["changed"],style:{color:"rgb(162, 191, 252)",fontStyle:"italic"}},{types:["deleted"],style:{color:"rgba(239, 83, 80, 0.56)",fontStyle:"italic"}},{types:["inserted","attr-name"],style:{color:"rgb(173, 219, 103)",fontStyle:"italic"}},{types:["comment"],style:{color:"rgb(99, 119, 119)",fontStyle:"italic"}},{types:["string","url"],style:{color:"rgb(173, 219, 103)"}},{types:["variable"],style:{color:"rgb(214, 222, 235)"}},{types:["number"],style:{color:"rgb(247, 140, 108)"}},{types:["builtin","char","constant","function"],style:{color:"rgb(130, 170, 255)"}},{types:["punctuation"],style:{color:"rgb(199, 146, 234)"}},{types:["selector","doctype"],style:{color:"rgb(199, 146, 234)",fontStyle:"italic"}},{types:["class-name"],style:{color:"rgb(255, 203, 139)"}},{types:["tag","operator","keyword"],style:{color:"rgb(127, 219, 202)"}},{types:["boolean"],style:{color:"rgb(255, 88, 116)"}},{types:["property"],style:{color:"rgb(128, 203, 196)"}},{types:["namespace"],style:{color:"rgb(178, 204, 214)"}}]},R={plain:{color:"#403f53",backgroundColor:"#FBFBFB"},styles:[{types:["changed"],style:{color:"rgb(162, 191, 252)",fontStyle:"italic"}},{types:["deleted"],style:{color:"rgba(239, 83, 80, 0.56)",fontStyle:"italic"}},{types:["inserted","attr-name"],style:{color:"rgb(72, 118, 214)",fontStyle:"italic"}},{types:["comment"],style:{color:"rgb(152, 159, 177)",fontStyle:"italic"}},{types:["string","builtin","char","constant","url"],style:{color:"rgb(72, 118, 214)"}},{types:["variable"],style:{color:"rgb(201, 103, 101)"}},{types:["number"],style:{color:"rgb(170, 9, 130)"}},{types:["punctuation"],style:{color:"rgb(153, 76, 195)"}},{types:["function","selector","doctype"],style:{color:"rgb(153, 76, 195)",fontStyle:"italic"}},{types:["class-name"],style:{color:"rgb(17, 17, 17)"}},{types:["tag"],style:{color:"rgb(153, 76, 195)"}},{types:["operator","property","keyword","namespace"],style:{color:"rgb(12, 150, 155)"}},{types:["boolean"],style:{color:"rgb(188, 84, 84)"}}]},O="#c5a5c5",q="#8dc891",$={plain:{backgroundColor:"#282c34",color:"#ffffff"},styles:[{types:["attr-name"],style:{color:O}},{types:["attr-value"],style:{color:q}},{types:["comment","block-comment","prolog","doctype","cdata","shebang"],style:{color:"#999999"}},{types:["property","number","function-name","constant","symbol","deleted"],style:{color:"#5a9bcf"}},{types:["boolean"],style:{color:"#ff8b50"}},{types:["tag"],style:{color:"#fc929e"}},{types:["string"],style:{color:q}},{types:["punctuation"],style:{color:q}},{types:["selector","char","builtin","inserted"],style:{color:"#D8DEE9"}},{types:["function"],style:{color:"#79b6f2"}},{types:["operator","entity","url","variable"],style:{color:"#d7deea"}},{types:["keyword"],style:{color:O}},{types:["atrule","class-name"],style:{color:"#FAC863"}},{types:["important"],style:{fontWeight:"400"}},{types:["bold"],style:{fontWeight:"bold"}},{types:["italic"],style:{fontStyle:"italic"}},{types:["namespace"],style:{opacity:.7}}]},D={plain:{color:"#f8f8f2",backgroundColor:"#272822"},styles:[{types:["changed"],style:{color:"rgb(162, 191, 252)",fontStyle:"italic"}},{types:["deleted"],style:{color:"#f92672",fontStyle:"italic"}},{types:["inserted"],style:{color:"rgb(173, 219, 103)",fontStyle:"italic"}},{types:["comment"],style:{color:"#8292a2",fontStyle:"italic"}},{types:["string","url"],style:{color:"#a6e22e"}},{types:["variable"],style:{color:"#f8f8f2"}},{types:["number"],style:{color:"#ae81ff"}},{types:["builtin","char","constant","function","class-name"],style:{color:"#e6db74"}},{types:["punctuation"],style:{color:"#f8f8f2"}},{types:["selector","doctype"],style:{color:"#a6e22e",fontStyle:"italic"}},{types:["tag","operator","keyword"],style:{color:"#66d9ef"}},{types:["boolean"],style:{color:"#ae81ff"}},{types:["namespace"],style:{color:"rgb(178, 204, 214)",opacity:.7}},{types:["tag","property"],style:{color:"#f92672"}},{types:["attr-name"],style:{color:"#a6e22e !important"}},{types:["doctype"],style:{color:"#8292a2"}},{types:["rule"],style:{color:"#e6db74"}}]},B={plain:{color:"#bfc7d5",backgroundColor:"#292d3e"},styles:[{types:["comment"],style:{color:"rgb(105, 112, 152)",fontStyle:"italic"}},{types:["string","inserted"],style:{color:"rgb(195, 232, 141)"}},{types:["number"],style:{color:"rgb(247, 140, 108)"}},{types:["builtin","char","constant","function"],style:{color:"rgb(130, 170, 255)"}},{types:["punctuation","selector"],style:{color:"rgb(199, 146, 234)"}},{types:["variable"],style:{color:"rgb(191, 199, 213)"}},{types:["class-name","attr-name"],style:{color:"rgb(255, 203, 107)"}},{types:["tag","deleted"],style:{color:"rgb(255, 85, 114)"}},{types:["operator"],style:{color:"rgb(137, 221, 255)"}},{types:["boolean"],style:{color:"rgb(255, 88, 116)"}},{types:["keyword"],style:{fontStyle:"italic"}},{types:["doctype"],style:{color:"rgb(199, 146, 234)",fontStyle:"italic"}},{types:["namespace"],style:{color:"rgb(178, 204, 214)"}},{types:["url"],style:{color:"rgb(221, 221, 221)"}}]},L={plain:{color:"#9EFEFF",backgroundColor:"#2D2A55"},styles:[{types:["changed"],style:{color:"rgb(255, 238, 128)"}},{types:["deleted"],style:{color:"rgba(239, 83, 80, 0.56)"}},{types:["inserted"],style:{color:"rgb(173, 219, 103)"}},{types:["comment"],style:{color:"rgb(179, 98, 255)",fontStyle:"italic"}},{types:["punctuation"],style:{color:"rgb(255, 255, 255)"}},{types:["constant"],style:{color:"rgb(255, 98, 140)"}},{types:["string","url"],style:{color:"rgb(165, 255, 144)"}},{types:["variable"],style:{color:"rgb(255, 238, 128)"}},{types:["number","boolean"],style:{color:"rgb(255, 98, 140)"}},{types:["attr-name"],style:{color:"rgb(255, 180, 84)"}},{types:["keyword","operator","property","namespace","tag","selector","doctype"],style:{color:"rgb(255, 157, 0)"}},{types:["builtin","char","constant","function","class-name"],style:{color:"rgb(250, 208, 0)"}}]},U={plain:{backgroundColor:"linear-gradient(to bottom, #2a2139 75%, #34294f)",backgroundImage:"#34294f",color:"#f92aad",textShadow:"0 0 2px #100c0f, 0 0 5px #dc078e33, 0 0 10px #fff3"},styles:[{types:["comment","block-comment","prolog","doctype","cdata"],style:{color:"#495495",fontStyle:"italic"}},{types:["punctuation"],style:{color:"#ccc"}},{types:["tag","attr-name","namespace","number","unit","hexcode","deleted"],style:{color:"#e2777a"}},{types:["property","selector"],style:{color:"#72f1b8",textShadow:"0 0 2px #100c0f, 0 0 10px #257c5575, 0 0 35px #21272475"}},{types:["function-name"],style:{color:"#6196cc"}},{types:["boolean","selector-id","function"],style:{color:"#fdfdfd",textShadow:"0 0 2px #001716, 0 0 3px #03edf975, 0 0 5px #03edf975, 0 0 8px #03edf975"}},{types:["class-name","maybe-class-name","builtin"],style:{color:"#fff5f6",textShadow:"0 0 2px #000, 0 0 10px #fc1f2c75, 0 0 5px #fc1f2c75, 0 0 25px #fc1f2c75"}},{types:["constant","symbol"],style:{color:"#f92aad",textShadow:"0 0 2px #100c0f, 0 0 5px #dc078e33, 0 0 10px #fff3"}},{types:["important","atrule","keyword","selector-class"],style:{color:"#f4eee4",textShadow:"0 0 2px #393a33, 0 0 8px #f39f0575, 0 0 2px #f39f0575"}},{types:["string","char","attr-value","regex","variable"],style:{color:"#f87c32"}},{types:["parameter"],style:{fontStyle:"italic"}},{types:["entity","url"],style:{color:"#67cdcc"}},{types:["operator"],style:{color:"ffffffee"}},{types:["important","bold"],style:{fontWeight:"bold"}},{types:["italic"],style:{fontStyle:"italic"}},{types:["entity"],style:{cursor:"help"}},{types:["inserted"],style:{color:"green"}}]},N={plain:{color:"#282a2e",backgroundColor:"#ffffff"},styles:[{types:["comment"],style:{color:"rgb(197, 200, 198)"}},{types:["string","number","builtin","variable"],style:{color:"rgb(150, 152, 150)"}},{types:["class-name","function","tag","attr-name"],style:{color:"rgb(40, 42, 46)"}}]},F={plain:{color:"#9CDCFE",backgroundColor:"#1E1E1E"},styles:[{types:["prolog"],style:{color:"rgb(0, 0, 128)"}},{types:["comment"],style:{color:"rgb(106, 153, 85)"}},{types:["builtin","changed","keyword","interpolation-punctuation"],style:{color:"rgb(86, 156, 214)"}},{types:["number","inserted"],style:{color:"rgb(181, 206, 168)"}},{types:["constant"],style:{color:"rgb(100, 102, 149)"}},{types:["attr-name","variable"],style:{color:"rgb(156, 220, 254)"}},{types:["deleted","string","attr-value","template-punctuation"],style:{color:"rgb(206, 145, 120)"}},{types:["selector"],style:{color:"rgb(215, 186, 125)"}},{types:["tag"],style:{color:"rgb(78, 201, 176)"}},{types:["tag"],languages:["markup"],style:{color:"rgb(86, 156, 214)"}},{types:["punctuation","operator"],style:{color:"rgb(212, 212, 212)"}},{types:["punctuation"],languages:["markup"],style:{color:"#808080"}},{types:["function"],style:{color:"rgb(220, 220, 170)"}},{types:["class-name"],style:{color:"rgb(78, 201, 176)"}},{types:["char"],style:{color:"rgb(209, 105, 105)"}}]},M={plain:{color:"#000000",backgroundColor:"#ffffff"},styles:[{types:["comment"],style:{color:"rgb(0, 128, 0)"}},{types:["builtin"],style:{color:"rgb(0, 112, 193)"}},{types:["number","variable","inserted"],style:{color:"rgb(9, 134, 88)"}},{types:["operator"],style:{color:"rgb(0, 0, 0)"}},{types:["constant","char"],style:{color:"rgb(129, 31, 63)"}},{types:["tag"],style:{color:"rgb(128, 0, 0)"}},{types:["attr-name"],style:{color:"rgb(255, 0, 0)"}},{types:["deleted","string"],style:{color:"rgb(163, 21, 21)"}},{types:["changed","punctuation"],style:{color:"rgb(4, 81, 165)"}},{types:["function","keyword"],style:{color:"rgb(0, 0, 255)"}},{types:["class-name"],style:{color:"rgb(38, 127, 153)"}}]},G={plain:{color:"#f8fafc",backgroundColor:"#011627"},styles:[{types:["prolog"],style:{color:"#000080"}},{types:["comment"],style:{color:"#6A9955"}},{types:["builtin","changed","keyword","interpolation-punctuation"],style:{color:"#569CD6"}},{types:["number","inserted"],style:{color:"#B5CEA8"}},{types:["constant"],style:{color:"#f8fafc"}},{types:["attr-name","variable"],style:{color:"#9CDCFE"}},{types:["deleted","string","attr-value","template-punctuation"],style:{color:"#cbd5e1"}},{types:["selector"],style:{color:"#D7BA7D"}},{types:["tag"],style:{color:"#0ea5e9"}},{types:["tag"],languages:["markup"],style:{color:"#0ea5e9"}},{types:["punctuation","operator"],style:{color:"#D4D4D4"}},{types:["punctuation"],languages:["markup"],style:{color:"#808080"}},{types:["function"],style:{color:"#7dd3fc"}},{types:["class-name"],style:{color:"#0ea5e9"}},{types:["char"],style:{color:"#D16969"}}]},z={plain:{color:"#0f172a",backgroundColor:"#f1f5f9"},styles:[{types:["prolog"],style:{color:"#000080"}},{types:["comment"],style:{color:"#6A9955"}},{types:["builtin","changed","keyword","interpolation-punctuation"],style:{color:"#0c4a6e"}},{types:["number","inserted"],style:{color:"#B5CEA8"}},{types:["constant"],style:{color:"#0f172a"}},{types:["attr-name","variable"],style:{color:"#0c4a6e"}},{types:["deleted","string","attr-value","template-punctuation"],style:{color:"#64748b"}},{types:["selector"],style:{color:"#D7BA7D"}},{types:["tag"],style:{color:"#0ea5e9"}},{types:["tag"],languages:["markup"],style:{color:"#0ea5e9"}},{types:["punctuation","operator"],style:{color:"#475569"}},{types:["punctuation"],languages:["markup"],style:{color:"#808080"}},{types:["function"],style:{color:"#0e7490"}},{types:["class-name"],style:{color:"#0ea5e9"}},{types:["char"],style:{color:"#D16969"}}]},W={plain:{backgroundColor:"hsl(220, 13%, 18%)",color:"hsl(220, 14%, 71%)",textShadow:"0 1px rgba(0, 0, 0, 0.3)"},styles:[{types:["comment","prolog","cdata"],style:{color:"hsl(220, 10%, 40%)"}},{types:["doctype","punctuation","entity"],style:{color:"hsl(220, 14%, 71%)"}},{types:["attr-name","class-name","maybe-class-name","boolean","constant","number","atrule"],style:{color:"hsl(29, 54%, 61%)"}},{types:["keyword"],style:{color:"hsl(286, 60%, 67%)"}},{types:["property","tag","symbol","deleted","important"],style:{color:"hsl(355, 65%, 65%)"}},{types:["selector","string","char","builtin","inserted","regex","attr-value"],style:{color:"hsl(95, 38%, 62%)"}},{types:["variable","operator","function"],style:{color:"hsl(207, 82%, 66%)"}},{types:["url"],style:{color:"hsl(187, 47%, 55%)"}},{types:["deleted"],style:{textDecorationLine:"line-through"}},{types:["inserted"],style:{textDecorationLine:"underline"}},{types:["italic"],style:{fontStyle:"italic"}},{types:["important","bold"],style:{fontWeight:"bold"}},{types:["important"],style:{color:"hsl(220, 14%, 71%)"}}]},H={plain:{backgroundColor:"hsl(230, 1%, 98%)",color:"hsl(230, 8%, 24%)"},styles:[{types:["comment","prolog","cdata"],style:{color:"hsl(230, 4%, 64%)"}},{types:["doctype","punctuation","entity"],style:{color:"hsl(230, 8%, 24%)"}},{types:["attr-name","class-name","boolean","constant","number","atrule"],style:{color:"hsl(35, 99%, 36%)"}},{types:["keyword"],style:{color:"hsl(301, 63%, 40%)"}},{types:["property","tag","symbol","deleted","important"],style:{color:"hsl(5, 74%, 59%)"}},{types:["selector","string","char","builtin","inserted","regex","attr-value","punctuation"],style:{color:"hsl(119, 34%, 47%)"}},{types:["variable","operator","function"],style:{color:"hsl(221, 87%, 60%)"}},{types:["url"],style:{color:"hsl(198, 99%, 37%)"}},{types:["deleted"],style:{textDecorationLine:"line-through"}},{types:["inserted"],style:{textDecorationLine:"underline"}},{types:["italic"],style:{fontStyle:"italic"}},{types:["important","bold"],style:{fontWeight:"bold"}},{types:["important"],style:{color:"hsl(230, 8%, 24%)"}}]},Z=(e,t)=>{const{plain:r}=e,n=e.styles.reduce(((e,r)=>{const{languages:n,style:o}=r;return n&&!n.includes(t)||r.types.forEach((t=>{const r=w(w({},e[t]),o);e[t]=r})),e}),{});return n.root=r,n.plain=k(w({},r),{backgroundColor:void 0}),n},V=/\r\n|\r|\n/,K=e=>{0===e.length?e.push({types:["plain"],content:"\n",empty:!0}):1===e.length&&""===e[0].content&&(e[0].content="\n",e[0].empty=!0)},Y=(e,t)=>{const r=e.length;return r>0&&e[r-1]===t?e:e.concat(t)},J=e=>{const t=[[]],r=[e],n=[0],o=[e.length];let i=0,s=0,a=[];const c=[a];for(;s>-1;){for(;(i=n[s]++)<o[s];){let e,p=t[s];const d=r[s][i];if("string"==typeof d?(p=s>0?p:["plain"],e=d):(p=Y(p,d.type),d.alias&&(p=Y(p,d.alias)),e=d.content),"string"!=typeof e){s++,t.push(p),r.push(e),n.push(0),o.push(e.length);continue}const l=e.split(V),u=l.length;a.push({types:p,content:l[0]});for(let t=1;t<u;t++)K(a),c.push(a=[]),a.push({types:p,content:l[t]})}s--,t.pop(),r.pop(),n.pop(),o.pop()}return K(a),c},X=({children:e,language:t,code:r,theme:o,prism:s})=>{const a=t.toLowerCase(),c=((e,t)=>{const[r,o]=(0,n.useState)(Z(t,e)),i=(0,n.useRef)(),s=(0,n.useRef)();return(0,n.useEffect)((()=>{t===i.current&&e===s.current||(i.current=t,s.current=e,o(Z(t,e)))}),[e,t]),r})(a,o),p=(e=>(0,n.useCallback)((t=>{var r=t,{className:n,style:o,line:s}=r,a=S(r,["className","style","line"]);const c=k(w({},a),{className:i("token-line",n)});return"object"==typeof e&&"plain"in e&&(c.style=e.plain),"object"==typeof o&&(c.style=w(w({},c.style||{}),o)),c}),[e]))(c),d=(e=>{const t=(0,n.useCallback)((({types:t,empty:r})=>{if(null!=e)return 1===t.length&&"plain"===t[0]?null!=r?{display:"inline-block"}:void 0:1===t.length&&null!=r?e[t[0]]:Object.assign(null!=r?{display:"inline-block"}:{},...t.map((t=>e[t])))}),[e]);return(0,n.useCallback)((e=>{var r=e,{token:n,className:o,style:s}=r,a=S(r,["token","className","style"]);const c=k(w({},a),{className:i("token",...n.types,o),children:n.content,style:t(n)});return null!=s&&(c.style=w(w({},c.style||{}),s)),c}),[t])})(c),l=(({prism:e,code:t,grammar:r,language:o})=>{const i=(0,n.useRef)(e);return(0,n.useMemo)((()=>{if(null==r)return J([t]);const e={code:t,grammar:r,language:o,tokens:[]};return i.current.hooks.run("before-tokenize",e),e.tokens=i.current.tokenize(t,r),i.current.hooks.run("after-tokenize",e),J(e.tokens)}),[t,r,o])})({prism:s,language:a,code:r,grammar:s.languages[a]});return e({tokens:l,className:`prism-code language-${a}`,style:null!=c?c.root:{},getLineProps:p,getTokenProps:d})},Q=e=>(0,n.createElement)(X,k(w({},e),{prism:e.prism||C,theme:e.theme||F,code:e.code,language:e.language}))},11561:(e,t,r)=>{"use strict";r.d(t,{A:()=>i});var n=!0,o="Invariant failed";function i(e,t){if(!e){if(n)throw new Error(o);var r="function"==typeof t?t():t,i=r?"".concat(o,": ").concat(r):o;throw new Error(i)}}},22654:e=>{"use strict";e.exports={}},84054:e=>{"use strict";e.exports=JSON.parse('{"/api-specifications-90c":{"__comp":"8279e022","__context":{"plugin":"a7456010"},"config":"5e9f5e1a"},"/api/checkout-a9c":{"__comp":"f0ad3fbb","__context":{"plugin":"6ba57622"},"specProps":"77b34fc8","layoutProps":"726335e8"},"/api/checkout-admin-62b":{"__comp":"f0ad3fbb","__context":{"plugin":"f6ec2898"},"specProps":"9d5b7f91","layoutProps":"83e03a90"},"/api/checkout-flows-fba":{"__comp":"f0ad3fbb","__context":{"plugin":"ff5a0d38"},"specProps":"c2e3b439","layoutProps":"371bd825"},"/api/checkout-rsa-536":{"__comp":"f0ad3fbb","__context":{"plugin":"327f0203"},"specProps":"f970d283","layoutProps":"5bf88447"},"/api/customers-484":{"__comp":"f0ad3fbb","__context":{"plugin":"d8f72ea6"},"specProps":"05588b06","layoutProps":"41051053"},"/api/orders-8ca":{"__comp":"f0ad3fbb","__context":{"plugin":"5a2491ea"},"specProps":"1de9b3cd","layoutProps":"12a02ba9"},"/api/platform-connector-ead":{"__comp":"f0ad3fbb","__context":{"plugin":"7972200e"},"specProps":"b3cefefd","layoutProps":"4cd9658a"},"/api/platform-connector-destinations-6dc":{"__comp":"f0ad3fbb","__context":{"plugin":"2f6beaf6"},"specProps":"3fc31e27","layoutProps":"f94f984b"},"/api/platform-event-notifications-483":{"__comp":"f0ad3fbb","__context":{"plugin":"6b556ce2"},"specProps":"8b65dfae","layoutProps":"1096c25f"},"/api/price-rules-f65":{"__comp":"f0ad3fbb","__context":{"plugin":"b5ae6c76"},"specProps":"29f817bb","layoutProps":"0bf819ce"},"/api/products-27f":{"__comp":"f0ad3fbb","__context":{"plugin":"3d25f1b1"},"specProps":"9ee40315","layoutProps":"086ed28a"},"/api/shops-6c5":{"__comp":"f0ad3fbb","__context":{"plugin":"f15bd786"},"specProps":"5dc71d8d","layoutProps":"8fc53d35"},"/api/subscriptions-7a6":{"__comp":"f0ad3fbb","__context":{"plugin":"3896737e"},"specProps":"26fdda53","layoutProps":"7874c012"},"/changelog-162":{"__comp":"a6aa9e1f","__context":{"plugin":"36994c47"},"sidebar":"814f3328","items":[{"content":"9248066f"},{"content":"48ed49ac"},{"content":"f2679230"},{"content":"a83018f9"},{"content":"6a8a2734"},{"content":"59a98010"},{"content":"719ac0f6"},{"content":"2926825b"},{"content":"bc062e45"},{"content":"b7a80d23"},{"content":"fc339e87"},{"content":"57566eda"},{"content":"a3daa7b0"},{"content":"2d680932"},{"content":"03c9cabe"},{"content":"45aea981"},{"content":"9669cf71"},{"content":"35f98246"},{"content":"6736d42e"},{"content":"85a32b6a"},{"content":"e1b4cc2a"},{"content":"1ebebbee"},{"content":"a86d2051"},{"content":"b98e68af"},{"content":"9c4defe2"},{"content":"8653eec3"},{"content":"b869ded7"},{"content":"4176d444"},{"content":"cc10feb9"},{"content":"b2f8de63"},{"content":"9ccb8bf4"},{"content":"f6208f34"},{"content":"22449fb1"},{"content":"a27205d3"},{"content":"1a73a0d3"},{"content":"152456bb"},{"content":"fe4b5782"},{"content":"b884ce28"},{"content":"4fcc2d16"},{"content":"a0d7558c"},{"content":"d4a571fe"},{"content":"b81f1e7f"},{"content":"b8f2801a"},{"content":"fda6331f"},{"content":"4b395a8f"},{"content":"cae1db01"},{"content":"9e563b2a"},{"content":"028f387b"},{"content":"da39a912"},{"content":"32270c83"},{"content":"9844258f"},{"content":"2f460e85"},{"content":"9a98efac"},{"content":"40fa253f"},{"content":"d84edb4a"},{"content":"7d21ca31"},{"content":"9f231082"},{"content":"ca705e0e"},{"content":"1b84d22a"},{"content":"a0d56754"},{"content":"21b937f7"},{"content":"576397fa"},{"content":"6e78600a"},{"content":"37a49784"},{"content":"e234bc08"},{"content":"648652f2"},{"content":"c7b47c12"},{"content":"e405f8b6"},{"content":"8731bd3f"},{"content":"1f66b349"},{"content":"c2030439"},{"content":"7a0cbc90"},{"content":"9d41d13e"},{"content":"eab034cd"},{"content":"5d31ee35"},{"content":"6c0634db"},{"content":"e3e6ed5f"},{"content":"78b0ba9f"},{"content":"2d3b27e3"},{"content":"b8669604"},{"content":"93bb5d32"},{"content":"9745ec07"},{"content":"83aabe50"},{"content":"42eed18b"},{"content":"4e24f880"},{"content":"803dc12b"},{"content":"9e76ce62"},{"content":"e9134af7"},{"content":"63031fe5"},{"content":"734da6f2"},{"content":"2e9f1eb7"},{"content":"6705d7cc"},{"content":"6b8719b3"}],"__props":"2f72bd59"},"/changelog/2022/07/11-ea9":{"__comp":"ccc49370","__context":{"data":{"blogMetadata":"acecf23e"},"plugin":"36994c47"},"sidebar":"814f3328","content":"62618a35"},"/changelog/2022/07/14/1-eaf":{"__comp":"ccc49370","__context":{"data":{"blogMetadata":"acecf23e"},"plugin":"36994c47"},"sidebar":"814f3328","content":"9f2638d4"},"/changelog/2022/07/21/1-a77":{"__comp":"ccc49370","__context":{"data":{"blogMetadata":"acecf23e"},"plugin":"36994c47"},"sidebar":"814f3328","content":"a303337a"},"/changelog/2022/07/29-f93":{"__comp":"ccc49370","__context":{"data":{"blogMetadata":"acecf23e"},"plugin":"36994c47"},"sidebar":"814f3328","content":"42143f48"},"/changelog/2022/08/02-1ee":{"__comp":"ccc49370","__context":{"data":{"blogMetadata":"acecf23e"},"plugin":"36994c47"},"sidebar":"814f3328","content":"8a1cc97c"},"/changelog/2022/09/01-c93":{"__comp":"ccc49370","__context":{"data":{"blogMetadata":"acecf23e"},"plugin":"36994c47"},"sidebar":"814f3328","content":"98d8c4fc"},"/changelog/2022/09/01/2-116":{"__comp":"ccc49370","__context":{"data":{"blogMetadata":"acecf23e"},"plugin":"36994c47"},"sidebar":"814f3328","content":"b05b71ff"},"/changelog/2022/09/13-dee":{"__comp":"ccc49370","__context":{"data":{"blogMetadata":"acecf23e"},"plugin":"36994c47"},"sidebar":"814f3328","content":"5371f5c8"},"/changelog/2022/09/16-183":{"__comp":"ccc49370","__context":{"data":{"blogMetadata":"acecf23e"},"plugin":"36994c47"},"sidebar":"814f3328","content":"7acfde56"},"/changelog/2022/09/23-b43":{"__comp":"ccc49370","__context":{"data":{"blogMetadata":"acecf23e"},"plugin":"36994c47"},"sidebar":"814f3328","content":"15ed5882"},"/changelog/2022/09/27-02a":{"__comp":"ccc49370","__context":{"data":{"blogMetadata":"acecf23e"},"plugin":"36994c47"},"sidebar":"814f3328","content":"5a170c02"},"/changelog/2022/09/29-d54":{"__comp":"ccc49370","__context":{"data":{"blogMetadata":"acecf23e"},"plugin":"36994c47"},"sidebar":"814f3328","content":"27dd01ec"},"/changelog/2022/10/13-141":{"__comp":"ccc49370","__context":{"data":{"blogMetadata":"acecf23e"},"plugin":"36994c47"},"sidebar":"814f3328","content":"7f33f3aa"},"/changelog/2022/10/17-f91":{"__comp":"ccc49370","__context":{"data":{"blogMetadata":"acecf23e"},"plugin":"36994c47"},"sidebar":"814f3328","content":"efb12385"},"/changelog/2022/10/18/1-ed1":{"__comp":"ccc49370","__context":{"data":{"blogMetadata":"acecf23e"},"plugin":"36994c47"},"sidebar":"814f3328","content":"6238fb38"},"/changelog/2022/10/19-d09":{"__comp":"ccc49370","__context":{"data":{"blogMetadata":"acecf23e"},"plugin":"36994c47"},"sidebar":"814f3328","content":"a78c8291"},"/changelog/2022/10/25-a58":{"__comp":"ccc49370","__context":{"data":{"blogMetadata":"acecf23e"},"plugin":"36994c47"},"sidebar":"814f3328","content":"8b6ba284"},"/changelog/2022/10/31-ffd":{"__comp":"ccc49370","__context":{"data":{"blogMetadata":"acecf23e"},"plugin":"36994c47"},"sidebar":"814f3328","content":"7e29e168"},"/changelog/2022/11/10-953":{"__comp":"ccc49370","__context":{"data":{"blogMetadata":"acecf23e"},"plugin":"36994c47"},"sidebar":"814f3328","content":"364990a8"},"/changelog/2022/11/14-7bf":{"__comp":"ccc49370","__context":{"data":{"blogMetadata":"acecf23e"},"plugin":"36994c47"},"sidebar":"814f3328","content":"aab1e628"},"/changelog/2022/12/02-f53":{"__comp":"ccc49370","__context":{"data":{"blogMetadata":"acecf23e"},"plugin":"36994c47"},"sidebar":"814f3328","content":"c4babf09"},"/changelog/2022/12/02/01-434":{"__comp":"ccc49370","__context":{"data":{"blogMetadata":"acecf23e"},"plugin":"36994c47"},"sidebar":"814f3328","content":"250aabba"},"/changelog/2022/12/02/2-d37":{"__comp":"ccc49370","__context":{"data":{"blogMetadata":"acecf23e"},"plugin":"36994c47"},"sidebar":"814f3328","content":"1baa23ab"},"/changelog/2022/12/14-4cf":{"__comp":"ccc49370","__context":{"data":{"blogMetadata":"acecf23e"},"plugin":"36994c47"},"sidebar":"814f3328","content":"bee00323"},"/changelog/2022/12/23-4a5":{"__comp":"ccc49370","__context":{"data":{"blogMetadata":"acecf23e"},"plugin":"36994c47"},"sidebar":"814f3328","content":"8a7f04b4"},"/changelog/2023/01/09-15e":{"__comp":"ccc49370","__context":{"data":{"blogMetadata":"acecf23e"},"plugin":"36994c47"},"sidebar":"814f3328","content":"c6b52414"},"/changelog/2023/01/17-054":{"__comp":"ccc49370","__context":{"data":{"blogMetadata":"acecf23e"},"plugin":"36994c47"},"sidebar":"814f3328","content":"5f2ba928"},"/changelog/2023/01/20-49b":{"__comp":"ccc49370","__context":{"data":{"blogMetadata":"acecf23e"},"plugin":"36994c47"},"sidebar":"814f3328","content":"e0696fb7"},"/changelog/2023/02/01-a68":{"__comp":"ccc49370","__context":{"data":{"blogMetadata":"acecf23e"},"plugin":"36994c47"},"sidebar":"814f3328","content":"6dcfd2ad"},"/changelog/2023/02/07-832":{"__comp":"ccc49370","__context":{"data":{"blogMetadata":"acecf23e"},"plugin":"36994c47"},"sidebar":"814f3328","content":"54fca6b7"},"/changelog/2023/03/02-fa4":{"__comp":"ccc49370","__context":{"data":{"blogMetadata":"acecf23e"},"plugin":"36994c47"},"sidebar":"814f3328","content":"bd414280"},"/changelog/2023/03/07-1d9":{"__comp":"ccc49370","__context":{"data":{"blogMetadata":"acecf23e"},"plugin":"36994c47"},"sidebar":"814f3328","content":"5243b79c"},"/changelog/2023/03/09-000":{"__comp":"ccc49370","__context":{"data":{"blogMetadata":"acecf23e"},"plugin":"36994c47"},"sidebar":"814f3328","content":"72234647"},"/changelog/2023/03/27-9d0":{"__comp":"ccc49370","__context":{"data":{"blogMetadata":"acecf23e"},"plugin":"36994c47"},"sidebar":"814f3328","content":"3402c51f"},"/changelog/2023/04/04-83c":{"__comp":"ccc49370","__context":{"data":{"blogMetadata":"acecf23e"},"plugin":"36994c47"},"sidebar":"814f3328","content":"7f1b9386"},"/changelog/2023/04/04/1-7fd":{"__comp":"ccc49370","__context":{"data":{"blogMetadata":"acecf23e"},"plugin":"36994c47"},"sidebar":"814f3328","content":"4179f89d"},"/changelog/2023/04/05-c84":{"__comp":"ccc49370","__context":{"data":{"blogMetadata":"acecf23e"},"plugin":"36994c47"},"sidebar":"814f3328","content":"20e47cd0"},"/changelog/2023/04/21-05a":{"__comp":"ccc49370","__context":{"data":{"blogMetadata":"acecf23e"},"plugin":"36994c47"},"sidebar":"814f3328","content":"01bb7bc7"},"/changelog/2023/04/21/1-040":{"__comp":"ccc49370","__context":{"data":{"blogMetadata":"acecf23e"},"plugin":"36994c47"},"sidebar":"814f3328","content":"5ba19106"},"/changelog/2023/04/21/2-254":{"__comp":"ccc49370","__context":{"data":{"blogMetadata":"acecf23e"},"plugin":"36994c47"},"sidebar":"814f3328","content":"58226553"},"/changelog/2023/05/01-1ea":{"__comp":"ccc49370","__context":{"data":{"blogMetadata":"acecf23e"},"plugin":"36994c47"},"sidebar":"814f3328","content":"ba2bc9d2"},"/changelog/2023/05/02-265":{"__comp":"ccc49370","__context":{"data":{"blogMetadata":"acecf23e"},"plugin":"36994c47"},"sidebar":"814f3328","content":"8d71f2ef"},"/changelog/2023/05/09-da5":{"__comp":"ccc49370","__context":{"data":{"blogMetadata":"acecf23e"},"plugin":"36994c47"},"sidebar":"814f3328","content":"92663509"},"/changelog/2023/05/10-53a":{"__comp":"ccc49370","__context":{"data":{"blogMetadata":"acecf23e"},"plugin":"36994c47"},"sidebar":"814f3328","content":"7d2954f8"},"/changelog/2023/05/18-cfe":{"__comp":"ccc49370","__context":{"data":{"blogMetadata":"acecf23e"},"plugin":"36994c47"},"sidebar":"814f3328","content":"78f5ef23"},"/changelog/2023/05/18/1-386":{"__comp":"ccc49370","__context":{"data":{"blogMetadata":"acecf23e"},"plugin":"36994c47"},"sidebar":"814f3328","content":"ad678fe2"},"/changelog/2023/05/18/2-6b6":{"__comp":"ccc49370","__context":{"data":{"blogMetadata":"acecf23e"},"plugin":"36994c47"},"sidebar":"814f3328","content":"452a9096"},"/changelog/2023/05/23-5ba":{"__comp":"ccc49370","__context":{"data":{"blogMetadata":"acecf23e"},"plugin":"36994c47"},"sidebar":"814f3328","content":"e477976f"},"/changelog/2023/05/26-55a":{"__comp":"ccc49370","__context":{"data":{"blogMetadata":"acecf23e"},"plugin":"36994c47"},"sidebar":"814f3328","content":"0ff48c37"},"/changelog/2023/06/12-a48":{"__comp":"ccc49370","__context":{"data":{"blogMetadata":"acecf23e"},"plugin":"36994c47"},"sidebar":"814f3328","content":"9b8c43fb"},"/changelog/2023/06/13-243":{"__comp":"ccc49370","__context":{"data":{"blogMetadata":"acecf23e"},"plugin":"36994c47"},"sidebar":"814f3328","content":"3f285aa8"},"/changelog/2023/06/20-9ba":{"__comp":"ccc49370","__context":{"data":{"blogMetadata":"acecf23e"},"plugin":"36994c47"},"sidebar":"814f3328","content":"df856fe9"},"/changelog/2023/06/26-f01":{"__comp":"ccc49370","__context":{"data":{"blogMetadata":"acecf23e"},"plugin":"36994c47"},"sidebar":"814f3328","content":"9e9a0d2d"},"/changelog/2023/07/10-8db":{"__comp":"ccc49370","__context":{"data":{"blogMetadata":"acecf23e"},"plugin":"36994c47"},"sidebar":"814f3328","content":"b0a78326"},"/changelog/2023/07/14-a8f":{"__comp":"ccc49370","__context":{"data":{"blogMetadata":"acecf23e"},"plugin":"36994c47"},"sidebar":"814f3328","content":"013b08b3"},"/changelog/2023/07/14/1-b23":{"__comp":"ccc49370","__context":{"data":{"blogMetadata":"acecf23e"},"plugin":"36994c47"},"sidebar":"814f3328","content":"419031ba"},"/changelog/2023/07/24-f19":{"__comp":"ccc49370","__context":{"data":{"blogMetadata":"acecf23e"},"plugin":"36994c47"},"sidebar":"814f3328","content":"fba0f0eb"},"/changelog/2023/07/25-be7":{"__comp":"ccc49370","__context":{"data":{"blogMetadata":"acecf23e"},"plugin":"36994c47"},"sidebar":"814f3328","content":"d20844df"},"/changelog/2023/08/08-1ad":{"__comp":"ccc49370","__context":{"data":{"blogMetadata":"acecf23e"},"plugin":"36994c47"},"sidebar":"814f3328","content":"ab91e59b"},"/changelog/2023/08/17-428":{"__comp":"ccc49370","__context":{"data":{"blogMetadata":"acecf23e"},"plugin":"36994c47"},"sidebar":"814f3328","content":"d717ef1e"},"/changelog/2023/08/22-ab7":{"__comp":"ccc49370","__context":{"data":{"blogMetadata":"acecf23e"},"plugin":"36994c47"},"sidebar":"814f3328","content":"f04f4b9f"},"/changelog/2023/08/29-b35":{"__comp":"ccc49370","__context":{"data":{"blogMetadata":"acecf23e"},"plugin":"36994c47"},"sidebar":"814f3328","content":"464a882e"},"/changelog/2023/09/08-b07":{"__comp":"ccc49370","__context":{"data":{"blogMetadata":"acecf23e"},"plugin":"36994c47"},"sidebar":"814f3328","content":"ca8f2d2f"},"/changelog/2023/09/14-ddb":{"__comp":"ccc49370","__context":{"data":{"blogMetadata":"acecf23e"},"plugin":"36994c47"},"sidebar":"814f3328","content":"9f2b4f61"},"/changelog/2023/09/18-d4a":{"__comp":"ccc49370","__context":{"data":{"blogMetadata":"acecf23e"},"plugin":"36994c47"},"sidebar":"814f3328","content":"b5a1fff4"},"/changelog/2023/09/22-f35":{"__comp":"ccc49370","__context":{"data":{"blogMetadata":"acecf23e"},"plugin":"36994c47"},"sidebar":"814f3328","content":"c6439732"},"/changelog/2023/09/27-850":{"__comp":"ccc49370","__context":{"data":{"blogMetadata":"acecf23e"},"plugin":"36994c47"},"sidebar":"814f3328","content":"90480410"},"/changelog/2023/09/27/1-d42":{"__comp":"ccc49370","__context":{"data":{"blogMetadata":"acecf23e"},"plugin":"36994c47"},"sidebar":"814f3328","content":"16044b28"},"/changelog/2023/10/10-293":{"__comp":"ccc49370","__context":{"data":{"blogMetadata":"acecf23e"},"plugin":"36994c47"},"sidebar":"814f3328","content":"046235e5"},"/changelog/2023/10/11-f03":{"__comp":"ccc49370","__context":{"data":{"blogMetadata":"acecf23e"},"plugin":"36994c47"},"sidebar":"814f3328","content":"b7ca5550"},"/changelog/2023/10/27-ee9":{"__comp":"ccc49370","__context":{"data":{"blogMetadata":"acecf23e"},"plugin":"36994c47"},"sidebar":"814f3328","content":"6b423876"},"/changelog/2023/11/21-c2c":{"__comp":"ccc49370","__context":{"data":{"blogMetadata":"acecf23e"},"plugin":"36994c47"},"sidebar":"814f3328","content":"e9e355a7"},"/changelog/2023/11/22-72b":{"__comp":"ccc49370","__context":{"data":{"blogMetadata":"acecf23e"},"plugin":"36994c47"},"sidebar":"814f3328","content":"6082c324"},"/changelog/2023/11/30-ac0":{"__comp":"ccc49370","__context":{"data":{"blogMetadata":"acecf23e"},"plugin":"36994c47"},"sidebar":"814f3328","content":"6981facc"},"/changelog/2023/12/07-386":{"__comp":"ccc49370","__context":{"data":{"blogMetadata":"acecf23e"},"plugin":"36994c47"},"sidebar":"814f3328","content":"c4aab958"},"/changelog/2023/12/11-694":{"__comp":"ccc49370","__context":{"data":{"blogMetadata":"acecf23e"},"plugin":"36994c47"},"sidebar":"814f3328","content":"1c5b18b6"},"/changelog/2023/12/15-9d4":{"__comp":"ccc49370","__context":{"data":{"blogMetadata":"acecf23e"},"plugin":"36994c47"},"sidebar":"814f3328","content":"381798e0"},"/changelog/2024/01/02-c2e":{"__comp":"ccc49370","__context":{"data":{"blogMetadata":"acecf23e"},"plugin":"36994c47"},"sidebar":"814f3328","content":"17c9e882"},"/changelog/2024/01/16-44e":{"__comp":"ccc49370","__context":{"data":{"blogMetadata":"acecf23e"},"plugin":"36994c47"},"sidebar":"814f3328","content":"1918bf25"},"/changelog/2024/01/17-e0c":{"__comp":"ccc49370","__context":{"data":{"blogMetadata":"acecf23e"},"plugin":"36994c47"},"sidebar":"814f3328","content":"c02a1c6d"},"/changelog/2024/01/18-47f":{"__comp":"ccc49370","__context":{"data":{"blogMetadata":"acecf23e"},"plugin":"36994c47"},"sidebar":"814f3328","content":"a7a2b072"},"/changelog/2024/02/01-a97":{"__comp":"ccc49370","__context":{"data":{"blogMetadata":"acecf23e"},"plugin":"36994c47"},"sidebar":"814f3328","content":"8c1de4d0"},"/changelog/2024/03/25-609":{"__comp":"ccc49370","__context":{"data":{"blogMetadata":"acecf23e"},"plugin":"36994c47"},"sidebar":"814f3328","content":"12b52f02"},"/changelog/2024/03/28-ec1":{"__comp":"ccc49370","__context":{"data":{"blogMetadata":"acecf23e"},"plugin":"36994c47"},"sidebar":"814f3328","content":"14bb7233"},"/changelog/2024/04/23-a72":{"__comp":"ccc49370","__context":{"data":{"blogMetadata":"acecf23e"},"plugin":"36994c47"},"sidebar":"814f3328","content":"3b98b72e"},"/changelog/2024/06/06-90a":{"__comp":"ccc49370","__context":{"data":{"blogMetadata":"acecf23e"},"plugin":"36994c47"},"sidebar":"814f3328","content":"77143d78"},"/changelog/2024/06/17-8df":{"__comp":"ccc49370","__context":{"data":{"blogMetadata":"acecf23e"},"plugin":"36994c47"},"sidebar":"814f3328","content":"7c357204"},"/changelog/2024/07/16-b1c":{"__comp":"ccc49370","__context":{"data":{"blogMetadata":"acecf23e"},"plugin":"36994c47"},"sidebar":"814f3328","content":"c0b19e3f"},"/changelog/2024/08/29-7a7":{"__comp":"ccc49370","__context":{"data":{"blogMetadata":"acecf23e"},"plugin":"36994c47"},"sidebar":"814f3328","content":"a8a331c2"},"/changelog/2024/09/17-108":{"__comp":"ccc49370","__context":{"data":{"blogMetadata":"acecf23e"},"plugin":"36994c47"},"sidebar":"814f3328","content":"b173a2ed"},"/changelog/2025/06/11-2ef":{"__comp":"ccc49370","__context":{"data":{"blogMetadata":"acecf23e"},"plugin":"36994c47"},"sidebar":"814f3328","content":"9cff32b0"},"/changelog/2025/11/18-8e1":{"__comp":"ccc49370","__context":{"data":{"blogMetadata":"acecf23e"},"plugin":"36994c47"},"sidebar":"814f3328","content":"b5cf0462"},"/changelog/2026/01/05-5f9":{"__comp":"ccc49370","__context":{"data":{"blogMetadata":"acecf23e"},"plugin":"36994c47"},"sidebar":"814f3328","content":"cc6ce636"},"/changelog/archive-bc1":{"__comp":"9e4087bc","__context":{"plugin":"36994c47"},"__props":"2308e035"},"/changelog/tags-744":{"__comp":"01a85c17","__context":{"plugin":"36994c47"},"sidebar":"814f3328","__props":"07d304fa"},"/changelog/tags/breaking-5d9":{"__comp":"6875c492","__context":{"plugin":"36994c47"},"sidebar":"814f3328","items":[{"content":"9248066f"},{"content":"48ed49ac"}],"__props":"a2bcb783"},"/changelog/tags/checkout-07e":{"__comp":"6875c492","__context":{"plugin":"36994c47"},"sidebar":"814f3328","items":[{"content":"719ac0f6"},{"content":"cae1db01"}],"__props":"4a9b8eb6"},"/changelog/tags/checkout-admin-ad3":{"__comp":"6875c492","__context":{"plugin":"36994c47"},"sidebar":"814f3328","items":[{"content":"bc062e45"},{"content":"b7a80d23"},{"content":"fc339e87"},{"content":"a3daa7b0"},{"content":"03c9cabe"},{"content":"8653eec3"},{"content":"cc10feb9"},{"content":"b2f8de63"},{"content":"f6208f34"},{"content":"152456bb"},{"content":"fe4b5782"},{"content":"4fcc2d16"},{"content":"d4a571fe"},{"content":"4b395a8f"},{"content":"32270c83"},{"content":"9844258f"},{"content":"2f460e85"},{"content":"d84edb4a"},{"content":"7d21ca31"},{"content":"ca705e0e"},{"content":"5d31ee35"}],"__props":"99019399"},"/changelog/tags/checkout-backend-cda":{"__comp":"6875c492","__context":{"plugin":"36994c47"},"sidebar":"814f3328","items":[{"content":"2926825b"},{"content":"a86d2051"},{"content":"b869ded7"},{"content":"4176d444"},{"content":"22449fb1"},{"content":"a27205d3"},{"content":"1a73a0d3"},{"content":"1b84d22a"},{"content":"576397fa"},{"content":"e405f8b6"},{"content":"1f66b349"},{"content":"9d41d13e"},{"content":"63031fe5"},{"content":"6b8719b3"}],"__props":"676ffe1d"},"/changelog/tags/checkout-frontend-b46":{"__comp":"6875c492","__context":{"plugin":"36994c47"},"sidebar":"814f3328","items":[{"content":"35f98246"},{"content":"6736d42e"},{"content":"e1b4cc2a"},{"content":"1ebebbee"},{"content":"4176d444"},{"content":"9ccb8bf4"},{"content":"22449fb1"},{"content":"a27205d3"},{"content":"1a73a0d3"},{"content":"a0d56754"},{"content":"576397fa"},{"content":"e405f8b6"},{"content":"8731bd3f"},{"content":"1f66b349"},{"content":"eab034cd"},{"content":"63031fe5"},{"content":"734da6f2"},{"content":"6705d7cc"}],"__props":"e8d9fb00"},"/changelog/tags/customers-ca5":{"__comp":"6875c492","__context":{"plugin":"36994c47"},"sidebar":"814f3328","items":[{"content":"57566eda"}],"__props":"9d9aa55d"},"/changelog/tags/external-payment-gateway-connector-dce":{"__comp":"6875c492","__context":{"plugin":"36994c47"},"sidebar":"814f3328","items":[{"content":"2d680932"},{"content":"9669cf71"},{"content":"9c4defe2"}],"__props":"7caefe66"},"/changelog/tags/integrations-08a":{"__comp":"6875c492","__context":{"plugin":"36994c47"},"sidebar":"814f3328","items":[{"content":"b8f2801a"}],"__props":"7b30e072"},"/changelog/tags/non-breaking-ce2":{"__comp":"6875c492","__context":{"plugin":"36994c47"},"sidebar":"814f3328","items":[{"content":"f2679230"},{"content":"a83018f9"},{"content":"6a8a2734"},{"content":"59a98010"},{"content":"719ac0f6"},{"content":"2926825b"},{"content":"bc062e45"},{"content":"b7a80d23"},{"content":"fc339e87"},{"content":"57566eda"},{"content":"a3daa7b0"},{"content":"2d680932"},{"content":"03c9cabe"},{"content":"45aea981"},{"content":"9669cf71"},{"content":"35f98246"},{"content":"6736d42e"},{"content":"85a32b6a"},{"content":"e1b4cc2a"},{"content":"1ebebbee"},{"content":"a86d2051"},{"content":"b98e68af"},{"content":"9c4defe2"},{"content":"8653eec3"},{"content":"b869ded7"},{"content":"4176d444"},{"content":"b2f8de63"},{"content":"9ccb8bf4"},{"content":"f6208f34"},{"content":"22449fb1"},{"content":"a27205d3"},{"content":"1a73a0d3"},{"content":"152456bb"},{"content":"fe4b5782"},{"content":"b884ce28"},{"content":"4fcc2d16"},{"content":"a0d7558c"},{"content":"d4a571fe"},{"content":"b81f1e7f"},{"content":"b8f2801a"},{"content":"fda6331f"},{"content":"4b395a8f"},{"content":"cae1db01"},{"content":"9e563b2a"},{"content":"028f387b"},{"content":"da39a912"},{"content":"32270c83"},{"content":"9844258f"},{"content":"2f460e85"},{"content":"9a98efac"},{"content":"40fa253f"},{"content":"d84edb4a"},{"content":"7d21ca31"},{"content":"9f231082"},{"content":"ca705e0e"},{"content":"1b84d22a"},{"content":"a0d56754"},{"content":"21b937f7"},{"content":"576397fa"},{"content":"6e78600a"},{"content":"37a49784"},{"content":"e234bc08"},{"content":"648652f2"},{"content":"c7b47c12"},{"content":"e405f8b6"},{"content":"8731bd3f"},{"content":"1f66b349"},{"content":"c2030439"},{"content":"7a0cbc90"},{"content":"9d41d13e"},{"content":"eab034cd"},{"content":"5d31ee35"},{"content":"6c0634db"},{"content":"e3e6ed5f"},{"content":"78b0ba9f"},{"content":"2d3b27e3"},{"content":"b8669604"},{"content":"93bb5d32"},{"content":"9745ec07"},{"content":"83aabe50"},{"content":"42eed18b"},{"content":"4e24f880"},{"content":"803dc12b"},{"content":"9e76ce62"},{"content":"e9134af7"},{"content":"63031fe5"},{"content":"734da6f2"},{"content":"2e9f1eb7"},{"content":"6705d7cc"},{"content":"6b8719b3"}],"__props":"bf3692be"},"/changelog/tags/platform-connector-fda":{"__comp":"6875c492","__context":{"plugin":"36994c47"},"sidebar":"814f3328","items":[{"content":"85a32b6a"},{"content":"b98e68af"},{"content":"40fa253f"},{"content":"648652f2"},{"content":"c2030439"},{"content":"7a0cbc90"},{"content":"b8669604"},{"content":"93bb5d32"},{"content":"9745ec07"},{"content":"83aabe50"},{"content":"42eed18b"}],"__props":"a0f19131"},"/changelog/tags/platform-event-notifications-308":{"__comp":"6875c492","__context":{"plugin":"36994c47"},"sidebar":"814f3328","items":[{"content":"85a32b6a"},{"content":"b98e68af"},{"content":"648652f2"}],"__props":"9b99c256"},"/changelog/tags/price-rules-api-108":{"__comp":"6875c492","__context":{"plugin":"36994c47"},"sidebar":"814f3328","items":[{"content":"45aea981"}],"__props":"97430077"},"/changelog/tags/remote-state-authority-299":{"__comp":"6875c492","__context":{"plugin":"36994c47"},"sidebar":"814f3328","items":[{"content":"35f98246"},{"content":"da39a912"}],"__props":"d8ffd1c8"},"/changelog/tags/shops-184":{"__comp":"6875c492","__context":{"plugin":"36994c47"},"sidebar":"814f3328","items":[{"content":"b8f2801a"}],"__props":"4b73ab1c"},"/changelog/tags/subscriptions-8db":{"__comp":"6875c492","__context":{"plugin":"36994c47"},"sidebar":"814f3328","items":[{"content":"9248066f"},{"content":"48ed49ac"},{"content":"f2679230"},{"content":"a83018f9"},{"content":"6a8a2734"},{"content":"59a98010"},{"content":"b884ce28"},{"content":"a0d7558c"},{"content":"b81f1e7f"},{"content":"fda6331f"},{"content":"9e563b2a"},{"content":"028f387b"},{"content":"9a98efac"},{"content":"21b937f7"},{"content":"6e78600a"},{"content":"37a49784"},{"content":"e234bc08"},{"content":"c7b47c12"},{"content":"6c0634db"},{"content":"e3e6ed5f"},{"content":"78b0ba9f"},{"content":"2d3b27e3"},{"content":"4e24f880"},{"content":"803dc12b"},{"content":"9e76ce62"},{"content":"e9134af7"},{"content":"2e9f1eb7"}],"__props":"bd3a9dee"},"/search-5de":{"__comp":"1a4e3797","__context":{"plugin":"c141421f"}},"/solution-library-b19":{"__comp":"3ac52e9f","__context":{"plugin":"a7456010"},"config":"5e9f5e1a"},"/guides-946":{"__comp":"5e95c892","__context":{"plugin":"aba21aa0"}},"/guides-004":{"__comp":"a7bd4aaa","__props":"3e088593"},"/guides/tags-cfe":{"__comp":"3720c009","__props":"b888eae5"},"/guides/tags/abandoned-cart-e87":{"__comp":"df203c0f","__props":"a14855e6"},"/guides/tags/adobe-commerce-5c7":{"__comp":"df203c0f","__props":"26354ec1"},"/guides/tags/algolia-2c6":{"__comp":"df203c0f","__props":"126328f1"},"/guides/tags/apple-pay-b42":{"__comp":"df203c0f","__props":"24e5fb8d"},"/guides/tags/area-789":{"__comp":"df203c0f","__props":"05ae2100"},"/guides/tags/authenticated-checkout-1f6":{"__comp":"df203c0f","__props":"c45bc5c9"},"/guides/tags/authentication-f06":{"__comp":"df203c0f","__props":"8fff7dee"},"/guides/tags/big-commerce-998":{"__comp":"df203c0f","__props":"713f479c"},"/guides/tags/biometrics-c30":{"__comp":"df203c0f","__props":"88f3445c"},"/guides/tags/blog-b80":{"__comp":"df203c0f","__props":"89c10cb2"},"/guides/tags/braintree-a98":{"__comp":"df203c0f","__props":"bd465c5a"},"/guides/tags/buy-now-da9":{"__comp":"df203c0f","__props":"35a762ac"},"/guides/tags/checkout-experience-templates-7b7":{"__comp":"df203c0f","__props":"18314aad"},"/guides/tags/checkout-flow-407":{"__comp":"df203c0f","__props":"8f1f4a7a"},"/guides/tags/checkout-flows-fcd":{"__comp":"df203c0f","__props":"ea654927"},"/guides/tags/coalition-technologies-1b3":{"__comp":"df203c0f","__props":"9e7f3f1d"},"/guides/tags/commercetools-6bb":{"__comp":"df203c0f","__props":"dfab1666"},"/guides/tags/constructor-33a":{"__comp":"df203c0f","__props":"ce0e948e"},"/guides/tags/conversion-601":{"__comp":"df203c0f","__props":"2812ebd9"},"/guides/tags/convert-from-search-771":{"__comp":"df203c0f","__props":"22cbcfd9"},"/guides/tags/customer-management-system-183":{"__comp":"df203c0f","__props":"cbb13b52"},"/guides/tags/ecommerce-platform-83a":{"__comp":"df203c0f","__props":"fac0a29f"},"/guides/tags/email-725":{"__comp":"df203c0f","__props":"59d8b887"},"/guides/tags/epg-229":{"__comp":"df203c0f","__props":"ad7bbdbe"},"/guides/tags/express-checkout-45b":{"__comp":"df203c0f","__props":"3e8ea28b"},"/guides/tags/express-pay-425":{"__comp":"df203c0f","__props":"8245391c"},"/guides/tags/external-payment-gateway-connector-dc4":{"__comp":"df203c0f","__props":"6a90a775"},"/guides/tags/google-pay-a70":{"__comp":"df203c0f","__props":"600ea7f1"},"/guides/tags/harry-rosen-0c5":{"__comp":"df203c0f","__props":"c3fed1b4"},"/guides/tags/klarna-db1":{"__comp":"df203c0f","__props":"8cb9ae10"},"/guides/tags/klaviyo-2d5":{"__comp":"df203c0f","__props":"93056085"},"/guides/tags/m-1-66e":{"__comp":"df203c0f","__props":"be7ad25d"},"/guides/tags/magento-1-750":{"__comp":"df203c0f","__props":"4ee21c5c"},"/guides/tags/magento-2-1e5":{"__comp":"df203c0f","__props":"db81c444"},"/guides/tags/magento-open-source-458":{"__comp":"df203c0f","__props":"b99e9454"},"/guides/tags/oracle-16b":{"__comp":"df203c0f","__props":"e7a0a125"},"/guides/tags/oracle-commerce-cloud-582":{"__comp":"df203c0f","__props":"5e17b9a1"},"/guides/tags/order-management-system-565":{"__comp":"df203c0f","__props":"7fec1bec"},"/guides/tags/orium-150":{"__comp":"df203c0f","__props":"5f8ff37c"},"/guides/tags/partner-flow-43f":{"__comp":"df203c0f","__props":"a192c05c"},"/guides/tags/partner-name-512":{"__comp":"df203c0f","__props":"8f6fd828"},"/guides/tags/partner-type-65f":{"__comp":"df203c0f","__props":"3b0c5da3"},"/guides/tags/pay-pal-651":{"__comp":"df203c0f","__props":"9324e391"},"/guides/tags/pay-pal-complete-payments-0fa":{"__comp":"df203c0f","__props":"129cd899"},"/guides/tags/pay-pal-express-3eb":{"__comp":"df203c0f","__props":"9bb130ae"},"/guides/tags/payment-gateway-688":{"__comp":"df203c0f","__props":"0fcb85a4"},"/guides/tags/payments-b3c":{"__comp":"df203c0f","__props":"4ffac51d"},"/guides/tags/platform-50a":{"__comp":"df203c0f","__props":"320311d2"},"/guides/tags/platform-connector-d68":{"__comp":"df203c0f","__props":"62ca7c03"},"/guides/tags/pre-purchase-upsell-05f":{"__comp":"df203c0f","__props":"e66966b6"},"/guides/tags/product-information-system-25d":{"__comp":"df203c0f","__props":"e23639f1"},"/guides/tags/purchase-from-blog-5c1":{"__comp":"df203c0f","__props":"f8b42268"},"/guides/tags/search-80e":{"__comp":"df203c0f","__props":"a2be571e"},"/guides/tags/self-hosted-db9":{"__comp":"df203c0f","__props":"e2f77e55"},"/guides/tags/shipper-hq-ff9":{"__comp":"df203c0f","__props":"0359fcc2"},"/guides/tags/shipping-728":{"__comp":"df203c0f","__props":"5c996eb8"},"/guides/tags/stripe-ce5":{"__comp":"df203c0f","__props":"e346b4e3"},"/guides/tags/tax-0fd":{"__comp":"df203c0f","__props":"9276bcf2"},"/guides/tags/tax-jar-75a":{"__comp":"df203c0f","__props":"28e36230"},"/guides/tags/taxes-b7b":{"__comp":"df203c0f","__props":"d32cb31c"},"/guides/tags/technology-partner-689":{"__comp":"df203c0f","__props":"af2f28d9"},"/guides/tags/unsupported-platform-c04":{"__comp":"df203c0f","__props":"481eaf8f"},"/guides/tags/wallet-pay-263":{"__comp":"df203c0f","__props":"cd41bd37"},"/guides/tags/wink-a3e":{"__comp":"df203c0f","__props":"2beb3a58"},"/guides-28d":{"__comp":"a94703ab"},"/guides/archive-a60":{"__comp":"17896441","content":"3b06b79c"},"/guides/archive/cashier-dc4":{"__comp":"17896441","content":"b446a5cd"},"/guides/archive/gravity-forms-upgrade-cb8":{"__comp":"17896441","content":"d71ba929"},"/guides/archive/installation-f9f":{"__comp":"17896441","content":"7ff5fa3f"},"/guides/archive/installation_m1-171":{"__comp":"17896441","content":"407941e5"},"/guides/archive/subscriptions_v1_integration-559":{"__comp":"17896441","content":"ad939425"},"/guides/archive/subscriptions_v1_msp-a36":{"__comp":"17896441","content":"55c436a7"},"/guides/archive/subscriptions_v1_storefront-be0":{"__comp":"17896441","content":"3f4cdd6c"},"/guides/checkout-38b":{"__comp":"17896441","content":"ddcc9d85"},"/guides/checkout/api-overrides-b50":{"__comp":"17896441","content":"ccd7d0a7"},"/guides/checkout/batch-processing-08a":{"__comp":"17896441","content":"99d61fc7"},"/guides/checkout/bold-boosters/adobe-commerce-bold-booster-for-intuit-f5c":{"__comp":"17896441","content":"cd94f1bf"},"/guides/checkout/bold-boosters/adobe-commerce-bold-booster-for-paypal-e67":{"__comp":"17896441","content":"a2eb7c70"},"/guides/checkout/bold-boosters/bold-booster-for-paypal-overview-773":{"__comp":"17896441","content":"25da6a08"},"/guides/checkout/bold-boosters/bold-booster-security-601":{"__comp":"17896441","content":"a197274c"},"/guides/checkout/bold-boosters/bold-booster-troubleshooting-129":{"__comp":"17896441","content":"46125cb5"},"/guides/checkout/bold-boosters/bold-booster-upgrade-6cb":{"__comp":"17896441","content":"2efa2b47"},"/guides/checkout/bold-boosters/connect-authorize-43c":{"__comp":"17896441","content":"282f6ca7"},"/guides/checkout/bold-boosters/connect-braintree-c2e":{"__comp":"17896441","content":"1756e9cf"},"/guides/checkout/bold-boosters/connect-intuit-999":{"__comp":"17896441","content":"df7b49fc"},"/guides/checkout/bold-boosters/connect-nuvei-5ff":{"__comp":"17896441","content":"58f76ef5"},"/guides/checkout/bold-boosters/connect-payment-gateways-1a4":{"__comp":"17896441","content":"3c0eb5c2"},"/guides/checkout/bold-boosters/connect-ppcp-00c":{"__comp":"17896441","content":"dd1548e1"},"/guides/checkout/bold-boosters/connect-stripe-db0":{"__comp":"17896441","content":"7cb1c17c"},"/guides/checkout/bold-boosters/export-request-logs-233":{"__comp":"17896441","content":"3e9f6079"},"/guides/checkout/bold-boosters/gravity-forms-bold-booster-for-paypal-eb1":{"__comp":"17896441","content":"fdba9f39"},"/guides/checkout/bold-boosters/install-compatibility-modules-bf3":{"__comp":"17896441","content":"1c1b9ca6"},"/guides/checkout/bold-boosters/integrate-forter-905":{"__comp":"17896441","content":"4fbfcdd8"},"/guides/checkout/bold-boosters/m1-bold-booster-for-paypal-285":{"__comp":"17896441","content":"87685dec"},"/guides/checkout/bold-boosters/opencart-bold-booster-for-paypal-3d4":{"__comp":"17896441","content":"d1f32d91"},"/guides/checkout/bold-boosters/set-up-apple-pay-22a":{"__comp":"17896441","content":"05d9ef96"},"/guides/checkout/bold-boosters/set-up-google-pay-ebc":{"__comp":"17896441","content":"a25eaad8"},"/guides/checkout/checkout-epg-guide-236":{"__comp":"17896441","content":"4a76b343"},"/guides/checkout/checkout-getting-started-59d":{"__comp":"17896441","content":"9cd69b2b"},"/guides/checkout/concepts-cf6":{"__comp":"17896441","content":"38fbc61d"},"/guides/checkout/concepts/cart-parameters-03c":{"__comp":"17896441","content":"55275f57"},"/guides/checkout/concepts/external-payment-gateways-5b2":{"__comp":"17896441","content":"a6705120"},"/guides/checkout/concepts/flows-eab":{"__comp":"17896441","content":"9a28d03e"},"/guides/checkout/concepts/headless-8f5":{"__comp":"17896441","content":"22188c71"},"/guides/checkout/concepts/overrides-171":{"__comp":"17896441","content":"728e3184"},"/guides/checkout/concepts/payment-information-ad7":{"__comp":"17896441","content":"417badab"},"/guides/checkout/concepts/plugins-0c4":{"__comp":"17896441","content":"36076582"},"/guides/checkout/concepts/sdk-integrate-65d":{"__comp":"17896441","content":"97bd5d1a"},"/guides/checkout/concepts/spi-integrate-094":{"__comp":"17896441","content":"3e9c5392"},"/guides/checkout/create-order-769":{"__comp":"17896441","content":"1feb10c6"},"/guides/checkout/css-643":{"__comp":"17896441","content":"4f5c5749"},"/guides/checkout/extend-d90":{"__comp":"17896441","content":"82b8a81c"},"/guides/checkout/fulfill-order-2af":{"__comp":"17896441","content":"0ef60b25"},"/guides/checkout/gift-cards-61b":{"__comp":"17896441","content":"614beea8"},"/guides/checkout/integrations/commercetools-7aa":{"__comp":"17896441","content":"05834f9b"},"/guides/checkout/life-da9":{"__comp":"17896441","content":"d1823e81"},"/guides/checkout/meta-a7a":{"__comp":"17896441","content":"8b3ba059"},"/guides/checkout/metrics-c20":{"__comp":"17896441","content":"b22514be"},"/guides/checkout/plugins-e68":{"__comp":"17896441","content":"03a0fca9"},"/guides/checkout/plugins/app-hooks-e51":{"__comp":"17896441","content":"51c99a15"},"/guides/checkout/plugins/event-action-loop-4c6":{"__comp":"17896441","content":"6fb8def7"},"/guides/checkout/plugins/getting-started-a0d":{"__comp":"17896441","content":"09759d9e"},"/guides/checkout/plugins/installation-flow-1f9":{"__comp":"17896441","content":"3beaf1fb"},"/guides/checkout/plugins/overrides-7b8":{"__comp":"17896441","content":"4e5af80a"},"/guides/checkout/pmmc-cf4":{"__comp":"17896441","content":"437d2981"},"/guides/checkout/populate-order-2be":{"__comp":"17896441","content":"ec838b08"},"/guides/checkout/public-integrations-98d":{"__comp":"17896441","content":"6aa951d6"},"/guides/checkout/quick-start-741":{"__comp":"17896441","content":"dd8d5f79"},"/guides/checkout/references/checkout-epg-api-27f":{"__comp":"17896441","content":"4bb7ca0f"},"/guides/checkout/references/checkout-spi-api-be9":{"__comp":"17896441","content":"e683eb15"},"/guides/checkout/references/country-province-requirements-774":{"__comp":"17896441","content":"533be5a4"},"/guides/checkout/references/epg-actions-events-bcb":{"__comp":"17896441","content":"e7c38046"},"/guides/checkout/references/plugin-actions-cc0":{"__comp":"17896441","content":"57efee46"},"/guides/checkout/references/plugin-events-bb3":{"__comp":"17896441","content":"f33863cd"},"/guides/checkout/resources/access-scopes-370":{"__comp":"17896441","content":"ba74812c"},"/guides/checkout/resources/api-versioning-a7f":{"__comp":"17896441","content":"ca303fc0"},"/guides/checkout/resources/error-responses-2a0":{"__comp":"17896441","content":"15feefe1"},"/guides/checkout/resources/glossary-668":{"__comp":"17896441","content":"4ad8da9e"},"/guides/checkout/resources/open-source-63e":{"__comp":"17896441","content":"218ea731"},"/guides/checkout/resources/query-pagination-b00":{"__comp":"17896441","content":"8c6a0c8d"},"/guides/checkout/resources/rate-limiting-5c5":{"__comp":"17896441","content":"f97cd861"},"/guides/checkout/resources/supported-platforms-gateways-c30":{"__comp":"17896441","content":"867c094e"},"/guides/checkout/self-hosted-flow-63c":{"__comp":"17896441","content":"dc8a0d0a"},"/guides/checkout/validate-discounts-891":{"__comp":"17896441","content":"44887076"},"/guides/checkout/webhooks-b8b":{"__comp":"17896441","content":"476a3022"},"/guides/platform-connector-b88":{"__comp":"17896441","content":"de4eb00a"},"/guides/platform-connector/concepts-949":{"__comp":"17896441","content":"f10edb4a"},"/guides/platform-connector/concepts/components-272":{"__comp":"17896441","content":"bb59d0d3"},"/guides/platform-connector/concepts/example-implementations-284":{"__comp":"17896441","content":"a0788bec"},"/guides/platform-connector/create-server-e9a":{"__comp":"17896441","content":"d4ad433e"},"/guides/platform-connector/event-notifications-b97":{"__comp":"17896441","content":"c07e63c6"},"/guides/platform-connector/getting-started-b24":{"__comp":"17896441","content":"74e304d9"},"/guides/platform-connector/requirements-2c1":{"__comp":"17896441","content":"e3c82674"},"/guides/platform-connector/rsa/concepts-a06":{"__comp":"17896441","content":"cea66e72"},"/guides/platform-connector/rsa/create-checkout-rsa-aac":{"__comp":"17896441","content":"a63248c6"},"/guides/platform-connector/rsa/requirements-a38":{"__comp":"17896441","content":"4fabaee9"},"/guides/platform-connector/verify-6a6":{"__comp":"17896441","content":"efedbf87"},"/guides/platform-integration/adobe-commerce/concepts-469":{"__comp":"17896441","content":"b6a4bacf"},"/guides/platform-integration/adobe-commerce/dev-store-23e":{"__comp":"17896441","content":"365589ae"},"/guides/platform-integration/adobe-commerce/flows/paypal-checkout-flow-809":{"__comp":"17896441","content":"965511c6"},"/guides/platform-integration/adobe-commerce/generate-module-list-869":{"__comp":"17896441","content":"c9b891a5"},"/guides/platform-integration/adobe-commerce/overview-517":{"__comp":"17896441","content":"ee3c4f27"},"/guides/platform-integration/adobe-commerce/troubleshooting-a20":{"__comp":"17896441","content":"061f685f"},"/guides/platform-integration/adobe-commerce/versions-a6c":{"__comp":"17896441","content":"57f42c93"},"/guides/platform-integration/bigcommerce/pre-c0e":{"__comp":"17896441","content":"207f8656"},"/guides/platform-integration/commercetools/headless-checkout-103":{"__comp":"17896441","content":"91caa64a"},"/guides/platform-integration/magento-1/concepts-aaf":{"__comp":"17896441","content":"0c6b229a"},"/guides/platform-integration/magento-1/dev-store-019":{"__comp":"17896441","content":"6d6f958f"},"/guides/platform-integration/magento-1/extensions-68e":{"__comp":"17896441","content":"55974cf6"},"/guides/platform-integration/magento-1/overview-36b":{"__comp":"17896441","content":"57edebfb"},"/guides/platform-integration/magento-1/troubleshooting-cc6":{"__comp":"17896441","content":"12e87cfc"},"/guides/platform-integration/magento-1/versions-ba2":{"__comp":"17896441","content":"58986d4a"},"/guides/platform-integration/shopify/pre-707":{"__comp":"17896441","content":"f30c5500"},"/guides/price-rules-62f":{"__comp":"17896441","content":"096a8400"},"/guides/price-rules/additional-resources-8e7":{"__comp":"17896441","content":"bbef2544"},"/guides/price-rules/attributes-61e":{"__comp":"17896441","content":"aea16c7b"},"/guides/price-rules/concepts/rulesets-and-rules-1e5":{"__comp":"17896441","content":"7745d529"},"/guides/price-rules/customer-targeted-pricing-3f7":{"__comp":"17896441","content":"506d5ca1"},"/guides/price-rules/debug-tools-9d0":{"__comp":"17896441","content":"bf2c76ca"},"/guides/price-rules/discount-codes-c2b":{"__comp":"17896441","content":"e345cd47"},"/guides/price-rules/errors-bb7":{"__comp":"17896441","content":"a9ce9108"},"/guides/price-rules/getting-started-8b5":{"__comp":"17896441","content":"79fd24fe"},"/guides/price-rules/headless-storefront-setup-460":{"__comp":"17896441","content":"f2001abc"},"/guides/price-rules/promotion-info-60f":{"__comp":"17896441","content":"f37d7194"},"/guides/price-rules/promotion-message-644":{"__comp":"17896441","content":"61f3d2fb"},"/guides/price-rules/public-integrations-dec":{"__comp":"17896441","content":"fd2cf4d0"},"/guides/price-rules/quick-start-08b":{"__comp":"17896441","content":"7d919bfe"},"/guides/price-rules/references/actions-39f":{"__comp":"17896441","content":"4754be42"},"/guides/price-rules/references/conditions-8f0":{"__comp":"17896441","content":"b86cec8a"},"/guides/price-rules/references/frontend-api-32c":{"__comp":"17896441","content":"02ed6f87"},"/guides/price-rules/references/product-selection-ec8":{"__comp":"17896441","content":"e289a6a6"},"/guides/price-rules/references/ruleset-properties-a26":{"__comp":"17896441","content":"f0fd16fd"},"/guides/price-rules/resources/access-scopes-9d6":{"__comp":"17896441","content":"8c40df0e"},"/guides/price-rules/resources/api-versioning-539":{"__comp":"17896441","content":"aa48e5f4"},"/guides/price-rules/resources/error-responses-e4b":{"__comp":"17896441","content":"912427ea"},"/guides/price-rules/resources/glossary-577":{"__comp":"17896441","content":"d5928064"},"/guides/price-rules/resources/open-source-214":{"__comp":"17896441","content":"81df1f68"},"/guides/price-rules/resources/query-pagination-80d":{"__comp":"17896441","content":"b48837db"},"/guides/price-rules/resources/rate-limiting-8dd":{"__comp":"17896441","content":"d9d97ff6"},"/guides/price-rules/resources/supported-platforms-gateways-0c9":{"__comp":"17896441","content":"8dad17cc"},"/guides/price-rules/working-with-rulesets/cart-level-promotions-07c":{"__comp":"17896441","content":"b124425c"},"/guides/price-rules/working-with-rulesets/customer-targeted-pricing-c1d":{"__comp":"17896441","content":"9d53b12b"},"/guides/price-rules/working-with-rulesets/discount-codes-6d1":{"__comp":"17896441","content":"e9851743"},"/guides/price-rules/working-with-rulesets/location-based-pricing-d48":{"__comp":"17896441","content":"7e3e040f"},"/guides/price-rules/working-with-rulesets/managing-price-rules-f87":{"__comp":"17896441","content":"997dc84c"},"/guides/price-rules/working-with-rulesets/multi-currency-9f2":{"__comp":"17896441","content":"a528a3cc"},"/guides/price-rules/working-with-rulesets/order-condition-4d8":{"__comp":"17896441","content":"92bfea30"},"/guides/price-rules/working-with-rulesets/price-adjustments-5f4":{"__comp":"17896441","content":"11c34f40"},"/guides/price-rules/working-with-rulesets/prioritization-and-stacking-fe0":{"__comp":"17896441","content":"5e3de0db"},"/guides/price-rules/working-with-rulesets/quantity-pricing-5e1":{"__comp":"17896441","content":"b4b562b3"},"/guides/price-rules/working-with-rulesets/scheduling-f4c":{"__comp":"17896441","content":"8ef70909"},"/guides/solutions/blueprints/abandoned-cart-ac9":{"__comp":"17896441","content":"e521f622"},"/guides/solutions/blueprints/biometric-auth-f97":{"__comp":"17896441","content":"b8e1ab90"},"/guides/solutions/blueprints/blog-4d0":{"__comp":"17896441","content":"b3ce1b9a"},"/guides/solutions/blueprints/buy-now-413":{"__comp":"17896441","content":"6a372ef7"},"/guides/solutions/blueprints/klarna-490":{"__comp":"17896441","content":"2e715987"},"/guides/solutions/blueprints/platform-connector-913":{"__comp":"17896441","content":"019e9cc6"},"/guides/solutions/blueprints/search-algolia-1ab":{"__comp":"17896441","content":"d29d1d7a"},"/guides/solutions/blueprints/search-constructor-36b":{"__comp":"17896441","content":"206acd2e"},"/guides/solutions/blueprints/template-eec":{"__comp":"17896441","content":"6299583b"},"/guides/solutions/blueprints/upsell-8f3":{"__comp":"17896441","content":"4db3f03b"},"/guides/solutions/bold-built/adobe-92c":{"__comp":"17896441","content":"5d2ff655"},"/guides/solutions/bold-built/bigcommerce-59d":{"__comp":"17896441","content":"3e4e0c9f"},"/guides/solutions/bold-built/braintree-6ff":{"__comp":"17896441","content":"0c0c8d35"},"/guides/solutions/bold-built/commercetools-5e6":{"__comp":"17896441","content":"1e188057"},"/guides/solutions/bold-built/magento-1-5fa":{"__comp":"17896441","content":"559a686d"},"/guides/solutions/bold-built/payment-booster-f1d":{"__comp":"17896441","content":"fe0fceb1"},"/guides/solutions/bold-built/paypal-checkout-flow-2c2":{"__comp":"17896441","content":"8cbb51ac"},"/guides/solutions/bold-built/ppcp-1e7":{"__comp":"17896441","content":"b8285721"},"/guides/solutions/bold-built/shipping-91b":{"__comp":"17896441","content":"1e058c00"},"/guides/solutions/bold-built/stripe-591":{"__comp":"17896441","content":"e3728c6a"},"/guides/solutions/bold-built/taxjar-ea5":{"__comp":"17896441","content":"4a590fd9"},"/guides/solutions/bold-built/template-a0a":{"__comp":"17896441","content":"4d743b46"},"/guides/solutions/example-projects/custom-flow-25c":{"__comp":"17896441","content":"8d5df195"},"/guides/solutions/example-projects/express-pay-16d":{"__comp":"17896441","content":"a3dddd39"},"/guides/solutions/example-projects/template-adc":{"__comp":"17896441","content":"b604ae7d"},"/guides/subscriptions-v2-66a":{"__comp":"17896441","content":"c44b1e9c"},"/guides/subscriptions-v2/adjust-subscription-orders-0bb":{"__comp":"17896441","content":"48029edc"},"/guides/subscriptions-v2/concepts-581":{"__comp":"17896441","content":"2f543d31"},"/guides/subscriptions-v2/create-line-items-566":{"__comp":"17896441","content":"7709a2ee"},"/guides/subscriptions-v2/create-subscription-b69":{"__comp":"17896441","content":"b3ece874"},"/guides/subscriptions-v2/customer-portals-403":{"__comp":"17896441","content":"d419bba6"},"/guides/subscriptions-v2/getting-started-de4":{"__comp":"17896441","content":"727c2919"},"/guides/subscriptions-v2/headless/storefront-setup-28e":{"__comp":"17896441","content":"1c6bfda8"},"/guides/subscriptions-v2/line-items-f6b":{"__comp":"17896441","content":"7de514a4"},"/guides/subscriptions-v2/public-integrations-122":{"__comp":"17896441","content":"216d6b37"},"/guides/subscriptions-v2/quick-start-1d9":{"__comp":"17896441","content":"fcb14d23"},"/guides/subscriptions-v2/resources/access-scopes-579":{"__comp":"17896441","content":"b199e59c"},"/guides/subscriptions-v2/resources/api-versioning-4b9":{"__comp":"17896441","content":"3c00c6bd"},"/guides/subscriptions-v2/resources/error-responses-3e6":{"__comp":"17896441","content":"5be7ecee"},"/guides/subscriptions-v2/resources/glossary-af6":{"__comp":"17896441","content":"ade24b0f"},"/guides/subscriptions-v2/resources/open-source-4ce":{"__comp":"17896441","content":"62d96ace"},"/guides/subscriptions-v2/resources/query-pagination-4e2":{"__comp":"17896441","content":"946ddae3"},"/guides/subscriptions-v2/resources/rate-limiting-411":{"__comp":"17896441","content":"ce3e7135"},"/guides/subscriptions-v2/resources/supported-platforms-gateways-66f":{"__comp":"17896441","content":"841cd3c7"},"/guides/subscriptions-v2/update-subscription-5ba":{"__comp":"17896441","content":"971ee163"},"/guides/subscriptions-v2/view-future-orders-90c":{"__comp":"17896441","content":"82ac0f52"},"/guides/subscriptions-v2/webhooks-e47":{"__comp":"17896441","content":"726b6d9c"},"/guides/subscriptions-v2/widgets-2a6":{"__comp":"17896441","content":"f1727f22"},"/-e5f":{"__comp":"1df93b7f","__context":{"plugin":"a7456010"},"config":"5e9f5e1a"}}')}},e=>{e.O(0,[71869],(()=>{return t=38536,e(e.s=t);var t}));e.O()}]);