Advertisement
ubuxas

openapi spec

Jun 21st, 2023 (edited)
10
0
22 days
Not a member of Pastebin yet? Sign Up, it unlocks many cool features!
text 261.20 KB | Software | 0 0
  1. {
  2. "openapi": "3.0.2",
  3. "info": {
  4. "title": "Hema Customerapp API",
  5. "description": "The Backend For Frontend API used by the mobile apps",
  6. "version": "1.0.0"
  7. },
  8. "tags": [
  9. {
  10. "name": "account",
  11. "description": ""
  12. },
  13. {
  14. "name": "commerce",
  15. "description": ""
  16. },
  17. {
  18. "name": "loyalty",
  19. "description": ""
  20. },
  21. {
  22. "name": "orders",
  23. "description": ""
  24. },
  25. {
  26. "name": "sdui",
  27. "description": ""
  28. },
  29. {
  30. "name": "system",
  31. "description": "Paths that can be used by a system on behalf of the customer"
  32. }
  33. ],
  34. "paths": {
  35. "/account-available": {
  36. "post": {
  37. "description": "Checks whether the given e-mail address is available or in use.",
  38. "tags": [
  39. "account"
  40. ],
  41. "operationId": "AccountAvailable",
  42. "parameters": [],
  43. "requestBody": {
  44. "required": true,
  45. "content": {
  46. "application/json": {
  47. "schema": {
  48. "$ref": "#/components/schemas/AccountAvailableRequest"
  49. }
  50. }
  51. }
  52. },
  53. "responses": {
  54. "200": {
  55. "description": "Success response",
  56. "content": {
  57. "application/json": {
  58. "schema": {
  59. "$ref": "#/components/schemas/AccountAvailableResponse"
  60. }
  61. }
  62. }
  63. }
  64. }
  65. }
  66. },
  67. "/account-menu": {
  68. "get": {
  69. "description": "Returns a screen with an account menu",
  70. "tags": [
  71. "sdui"
  72. ],
  73. "operationId": "AccountMenu",
  74. "parameters": [],
  75. "responses": {
  76. "200": {
  77. "description": "Success response",
  78. "content": {
  79. "application/json": {
  80. "schema": {
  81. "$ref": "#/components/schemas/ScreenResponse"
  82. }
  83. }
  84. }
  85. }
  86. }
  87. }
  88. },
  89. "/activate-voucher": {
  90. "post": {
  91. "description": "Activates a voucher for a loyality user.",
  92. "tags": [
  93. "loyalty"
  94. ],
  95. "operationId": "ActivateVoucher",
  96. "parameters": [],
  97. "requestBody": {
  98. "required": true,
  99. "content": {
  100. "application/json": {
  101. "schema": {
  102. "$ref": "#/components/schemas/ActivateVoucherRequest"
  103. }
  104. }
  105. }
  106. },
  107. "responses": {
  108. "200": {
  109. "description": "Success response",
  110. "content": {
  111. "application/json": {
  112. "schema": {
  113. "$ref": "#/components/schemas/CommandResponse"
  114. }
  115. }
  116. }
  117. }
  118. }
  119. }
  120. },
  121. "/add-physical-card": {
  122. "post": {
  123. "description": "Adds an existing physical card to the users loyality account.",
  124. "tags": [
  125. "loyalty"
  126. ],
  127. "operationId": "AddPhysicalCard",
  128. "parameters": [],
  129. "requestBody": {
  130. "required": true,
  131. "content": {
  132. "application/json": {
  133. "schema": {
  134. "$ref": "#/components/schemas/AddPhysicalCardRequest"
  135. }
  136. }
  137. }
  138. },
  139. "responses": {
  140. "200": {
  141. "description": "Success response",
  142. "content": {
  143. "application/json": {
  144. "schema": {
  145. "$ref": "#/components/schemas/EmptyResponse"
  146. }
  147. }
  148. }
  149. }
  150. }
  151. }
  152. },
  153. "/add-push-token": {
  154. "post": {
  155. "description": "Add push token for user.",
  156. "tags": [
  157. "account"
  158. ],
  159. "operationId": "AddPushToken",
  160. "parameters": [],
  161. "requestBody": {
  162. "required": true,
  163. "content": {
  164. "application/json": {
  165. "schema": {
  166. "$ref": "#/components/schemas/AddPushTokenRequest"
  167. }
  168. }
  169. }
  170. },
  171. "responses": {
  172. "200": {
  173. "description": "Success response",
  174. "content": {
  175. "application/json": {
  176. "schema": {
  177. "$ref": "#/components/schemas/EmptyResponse"
  178. }
  179. }
  180. }
  181. }
  182. }
  183. }
  184. },
  185. "/add-receipt-points": {
  186. "post": {
  187. "description": "Adds the points from a receipt, obtained in the physical stores, to the users loyality account.",
  188. "tags": [
  189. "loyalty"
  190. ],
  191. "operationId": "AddReceiptPoints",
  192. "parameters": [],
  193. "requestBody": {
  194. "required": true,
  195. "content": {
  196. "application/json": {
  197. "schema": {
  198. "$ref": "#/components/schemas/AddReceiptPointsRequest"
  199. }
  200. }
  201. }
  202. },
  203. "responses": {
  204. "200": {
  205. "description": "Success response",
  206. "content": {
  207. "application/json": {
  208. "schema": {
  209. "$ref": "#/components/schemas/EmptyResponse"
  210. }
  211. }
  212. }
  213. }
  214. }
  215. }
  216. },
  217. "/add-to-basket": {
  218. "post": {
  219. "description": "Add products to a basket",
  220. "tags": [
  221. "commerce"
  222. ],
  223. "operationId": "AddToBasket",
  224. "parameters": [],
  225. "requestBody": {
  226. "required": true,
  227. "content": {
  228. "application/json": {
  229. "schema": {
  230. "$ref": "#/components/schemas/BasketItemRequest"
  231. }
  232. }
  233. }
  234. },
  235. "responses": {
  236. "200": {
  237. "description": "Success response",
  238. "content": {
  239. "application/json": {
  240. "schema": {
  241. "$ref": "#/components/schemas/CommandResponse"
  242. }
  243. }
  244. }
  245. }
  246. }
  247. }
  248. },
  249. "/add-to-favorites": {
  250. "post": {
  251. "description": "Add product to the user's favorites list",
  252. "tags": [
  253. "account"
  254. ],
  255. "operationId": "AddToFavorites",
  256. "parameters": [],
  257. "requestBody": {
  258. "required": true,
  259. "content": {
  260. "application/json": {
  261. "schema": {
  262. "$ref": "#/components/schemas/AddToFavoritesRequest"
  263. }
  264. }
  265. }
  266. },
  267. "responses": {
  268. "200": {
  269. "description": "Success response",
  270. "content": {
  271. "application/json": {
  272. "schema": {
  273. "$ref": "#/components/schemas/CommandResponse"
  274. }
  275. }
  276. }
  277. }
  278. }
  279. }
  280. },
  281. "/nl/address-lookup": {
  282. "post": {
  283. "description": "Reverse lookup of an address in the Netherlands based on postal code house number and optionally addtion.",
  284. "tags": [
  285. "system"
  286. ],
  287. "operationId": "AddressLookup",
  288. "parameters": [],
  289. "requestBody": {
  290. "required": true,
  291. "content": {
  292. "application/json": {
  293. "schema": {
  294. "$ref": "#/components/schemas/NLAddressLookupRequest"
  295. }
  296. }
  297. }
  298. },
  299. "responses": {
  300. "200": {
  301. "description": "Success response",
  302. "content": {
  303. "application/json": {
  304. "schema": {
  305. "$ref": "#/components/schemas/NLAddressLookupResponse"
  306. }
  307. }
  308. }
  309. }
  310. }
  311. }
  312. },
  313. "/basket": {
  314. "get": {
  315. "description": "Returns the basket",
  316. "tags": [
  317. "sdui"
  318. ],
  319. "operationId": "basket",
  320. "parameters": [
  321. {
  322. "name": "id",
  323. "required": false,
  324. "in": "query",
  325. "schema": {
  326. "type": "string"
  327. }
  328. },
  329. {
  330. "name": "showPaymentFailed",
  331. "required": false,
  332. "in": "query",
  333. "schema": {
  334. "type": "boolean"
  335. }
  336. }
  337. ],
  338. "responses": {
  339. "200": {
  340. "description": "Success response",
  341. "content": {
  342. "application/json": {
  343. "schema": {
  344. "$ref": "#/components/schemas/ScreenResponse"
  345. }
  346. }
  347. }
  348. }
  349. }
  350. }
  351. },
  352. "/basket-checkout": {
  353. "post": {
  354. "description": "Validates the current basket and moves on to the checkout or returns a new basket screen in the command response.",
  355. "tags": [
  356. "commerce"
  357. ],
  358. "operationId": "BasketCheckout",
  359. "parameters": [],
  360. "requestBody": {
  361. "required": true,
  362. "content": {
  363. "application/json": {
  364. "schema": {
  365. "$ref": "#/components/schemas/BasketCheckoutRequest"
  366. }
  367. }
  368. }
  369. },
  370. "responses": {
  371. "200": {
  372. "description": "Success response",
  373. "content": {
  374. "application/json": {
  375. "schema": {
  376. "$ref": "#/components/schemas/CommandResponse"
  377. }
  378. }
  379. }
  380. }
  381. }
  382. }
  383. },
  384. "/basket-coupon-apply": {
  385. "post": {
  386. "description": "Applies a coupon code to a basket if possible or errors otherwise.",
  387. "tags": [
  388. "commerce"
  389. ],
  390. "operationId": "BasketCouponApply",
  391. "parameters": [],
  392. "requestBody": {
  393. "required": true,
  394. "content": {
  395. "application/json": {
  396. "schema": {
  397. "$ref": "#/components/schemas/BasketCouponRequest"
  398. }
  399. }
  400. }
  401. },
  402. "responses": {
  403. "200": {
  404. "description": "Success response",
  405. "content": {
  406. "application/json": {
  407. "schema": {
  408. "$ref": "#/components/schemas/CommandResponse"
  409. }
  410. }
  411. }
  412. }
  413. }
  414. }
  415. },
  416. "/basket-coupon-remove": {
  417. "post": {
  418. "description": "Removes a coupon from a basket if possible or errors otherwise.",
  419. "tags": [
  420. "commerce"
  421. ],
  422. "operationId": "BasketCouponRemove",
  423. "parameters": [],
  424. "requestBody": {
  425. "required": true,
  426. "content": {
  427. "application/json": {
  428. "schema": {
  429. "$ref": "#/components/schemas/BasketCouponRequest"
  430. }
  431. }
  432. }
  433. },
  434. "responses": {
  435. "200": {
  436. "description": "Success response",
  437. "content": {
  438. "application/json": {
  439. "schema": {
  440. "$ref": "#/components/schemas/CommandResponse"
  441. }
  442. }
  443. }
  444. }
  445. }
  446. }
  447. },
  448. "/basket-item": {
  449. "post": {
  450. "description": "Adds, deletes, and modifies products in / to a basket. Requires a combination of `basketId` and `basketItemId` or a `productId` where the former is preferred for performance reasons.",
  451. "tags": [
  452. "commerce"
  453. ],
  454. "operationId": "BasketItem",
  455. "parameters": [],
  456. "requestBody": {
  457. "required": true,
  458. "content": {
  459. "application/json": {
  460. "schema": {
  461. "$ref": "#/components/schemas/BasketItemRequest"
  462. }
  463. }
  464. }
  465. },
  466. "responses": {
  467. "200": {
  468. "description": "Success response",
  469. "content": {
  470. "application/json": {
  471. "schema": {
  472. "$ref": "#/components/schemas/CommandResponse"
  473. }
  474. }
  475. }
  476. }
  477. }
  478. }
  479. },
  480. "/basket-summary": {
  481. "get": {
  482. "description": "Summary of the basket",
  483. "tags": [
  484. "commerce"
  485. ],
  486. "operationId": "BasketSummary",
  487. "parameters": [],
  488. "responses": {
  489. "200": {
  490. "description": "Success response",
  491. "content": {
  492. "application/json": {
  493. "schema": {
  494. "$ref": "#/components/schemas/BasketSummaryResponse"
  495. }
  496. }
  497. }
  498. }
  499. }
  500. }
  501. },
  502. "/categories": {
  503. "get": {
  504. "description": "Returns the contents of the category",
  505. "tags": [
  506. "sdui"
  507. ],
  508. "operationId": "Categories",
  509. "parameters": [
  510. {
  511. "name": "parentCategoryId",
  512. "required": false,
  513. "in": "query",
  514. "schema": {
  515. "type": "string"
  516. }
  517. },
  518. {
  519. "name": "depth",
  520. "required": false,
  521. "in": "query",
  522. "schema": {
  523. "type": "integer"
  524. }
  525. }
  526. ],
  527. "responses": {
  528. "200": {
  529. "description": "Success response",
  530. "content": {
  531. "application/json": {
  532. "schema": {
  533. "$ref": "#/components/schemas/ScreenResponse"
  534. }
  535. }
  536. }
  537. }
  538. }
  539. }
  540. },
  541. "/content": {
  542. "get": {
  543. "description": "Returns a content screen built in Contentful matching the slug in the query parameters.",
  544. "tags": [
  545. "sdui"
  546. ],
  547. "operationId": "content",
  548. "parameters": [
  549. {
  550. "name": "slug",
  551. "required": true,
  552. "in": "query",
  553. "schema": {
  554. "type": "string"
  555. }
  556. }
  557. ],
  558. "responses": {
  559. "200": {
  560. "description": "Success response",
  561. "content": {
  562. "application/json": {
  563. "schema": {
  564. "$ref": "#/components/schemas/ScreenResponse"
  565. }
  566. }
  567. }
  568. }
  569. }
  570. }
  571. },
  572. "/customer-service": {
  573. "get": {
  574. "description": "Returns a screen with customer service details",
  575. "tags": [
  576. "sdui"
  577. ],
  578. "operationId": "CustomerService",
  579. "parameters": [],
  580. "responses": {
  581. "200": {
  582. "description": "Success response",
  583. "content": {
  584. "application/json": {
  585. "schema": {
  586. "$ref": "#/components/schemas/ScreenResponse"
  587. }
  588. }
  589. }
  590. }
  591. }
  592. }
  593. },
  594. "/data-event": {
  595. "post": {
  596. "description": "Events defined by the BFF sent as a side-effect of actions or moments in time, similar to Analytics events.",
  597. "tags": [
  598. "system"
  599. ],
  600. "operationId": "DataEvent",
  601. "parameters": [],
  602. "requestBody": {
  603. "required": true,
  604. "content": {
  605. "application/json": {
  606. "schema": {
  607. "$ref": "#/components/schemas/DataEventRequest"
  608. }
  609. }
  610. }
  611. },
  612. "responses": {
  613. "200": {
  614. "description": "Success response",
  615. "content": {
  616. "application/json": {
  617. "schema": {
  618. "$ref": "#/components/schemas/EmptyResponse"
  619. }
  620. }
  621. }
  622. }
  623. }
  624. }
  625. },
  626. "/deactivate-voucher": {
  627. "post": {
  628. "description": "Deactivates a voucher for a loyality user.",
  629. "tags": [
  630. "loyalty"
  631. ],
  632. "operationId": "DeactivateVoucher",
  633. "parameters": [],
  634. "requestBody": {
  635. "required": true,
  636. "content": {
  637. "application/json": {
  638. "schema": {
  639. "$ref": "#/components/schemas/DeactivateVoucherRequest"
  640. }
  641. }
  642. }
  643. },
  644. "responses": {
  645. "200": {
  646. "description": "Success response",
  647. "content": {
  648. "application/json": {
  649. "schema": {
  650. "$ref": "#/components/schemas/CommandResponse"
  651. }
  652. }
  653. }
  654. }
  655. }
  656. }
  657. },
  658. "/discount-overview": {
  659. "get": {
  660. "description": "Returns a screen with a discount overview",
  661. "tags": [
  662. "sdui"
  663. ],
  664. "operationId": "DiscountOverview",
  665. "parameters": [],
  666. "responses": {
  667. "200": {
  668. "description": "Success response",
  669. "content": {
  670. "application/json": {
  671. "schema": {
  672. "$ref": "#/components/schemas/ScreenResponse"
  673. }
  674. }
  675. }
  676. }
  677. }
  678. }
  679. },
  680. "/favorites": {
  681. "get": {
  682. "description": "Returns the contents of the wishlist of an authenticated user. Data consists of a list of products, each specifying product name, availability, price, variety and image",
  683. "tags": [
  684. "sdui"
  685. ],
  686. "operationId": "Favorites",
  687. "parameters": [],
  688. "responses": {
  689. "200": {
  690. "description": "Success response",
  691. "content": {
  692. "application/json": {
  693. "schema": {
  694. "$ref": "#/components/schemas/ScreenResponse"
  695. }
  696. }
  697. }
  698. }
  699. }
  700. }
  701. },
  702. "/favorites-summary": {
  703. "get": {
  704. "description": "Returns a summary of the wishlist of an authenticated user",
  705. "tags": [
  706. "account"
  707. ],
  708. "operationId": "FavoritesSummary",
  709. "parameters": [],
  710. "responses": {
  711. "200": {
  712. "description": "Success response",
  713. "content": {
  714. "application/json": {
  715. "schema": {
  716. "$ref": "#/components/schemas/FavoritesSummaryResponse"
  717. }
  718. }
  719. }
  720. }
  721. }
  722. }
  723. },
  724. "/filter": {
  725. "get": {
  726. "description": "Returns filters based on the given search params",
  727. "tags": [
  728. "commerce"
  729. ],
  730. "operationId": "Filter",
  731. "parameters": [
  732. {
  733. "name": "term",
  734. "required": false,
  735. "in": "query",
  736. "schema": {
  737. "type": "string"
  738. }
  739. },
  740. {
  741. "name": "categoryId",
  742. "required": false,
  743. "in": "query",
  744. "schema": {
  745. "type": "string"
  746. }
  747. },
  748. {
  749. "name": "disableOutOfStockFallback",
  750. "required": false,
  751. "in": "query",
  752. "schema": {
  753. "type": "boolean"
  754. }
  755. },
  756. {
  757. "name": "sort",
  758. "required": false,
  759. "in": "query",
  760. "schema": {
  761. "type": "string"
  762. }
  763. }
  764. ],
  765. "responses": {
  766. "200": {
  767. "description": "Success response",
  768. "content": {
  769. "application/json": {
  770. "schema": {
  771. "$ref": "#/components/schemas/FilterResponse"
  772. }
  773. }
  774. }
  775. }
  776. }
  777. }
  778. },
  779. "/forgot-password": {
  780. "post": {
  781. "description": "Activates the \"forgot password\" flow for th user.",
  782. "tags": [
  783. "account"
  784. ],
  785. "operationId": "ForgotPassword",
  786. "parameters": [],
  787. "requestBody": {
  788. "required": true,
  789. "content": {
  790. "application/json": {
  791. "schema": {
  792. "$ref": "#/components/schemas/ForgotPasswordRequest"
  793. }
  794. }
  795. }
  796. },
  797. "responses": {
  798. "200": {
  799. "description": "Success response",
  800. "content": {
  801. "application/json": {
  802. "schema": {
  803. "$ref": "#/components/schemas/EmptyResponse"
  804. }
  805. }
  806. }
  807. }
  808. }
  809. }
  810. },
  811. "/push-notification-channels": {
  812. "get": {
  813. "description": "Gets push notification channel status for current user.",
  814. "tags": [
  815. "account"
  816. ],
  817. "operationId": "GetPushNotificationChannels",
  818. "parameters": [],
  819. "responses": {
  820. "200": {
  821. "description": "Success response",
  822. "content": {
  823. "application/json": {
  824. "schema": {
  825. "$ref": "#/components/schemas/PushNotificationChannelState"
  826. }
  827. }
  828. }
  829. }
  830. }
  831. },
  832. "post": {
  833. "description": "Updates push notification channel settings for the user.",
  834. "tags": [
  835. "account"
  836. ],
  837. "operationId": "PostPushNotificationChannels",
  838. "parameters": [],
  839. "requestBody": {
  840. "required": true,
  841. "content": {
  842. "application/json": {
  843. "schema": {
  844. "$ref": "#/components/schemas/PushNotificationChannelState"
  845. }
  846. }
  847. }
  848. },
  849. "responses": {
  850. "200": {
  851. "description": "Success response",
  852. "content": {
  853. "application/json": {
  854. "schema": {
  855. "$ref": "#/components/schemas/EmptyResponse"
  856. }
  857. }
  858. }
  859. }
  860. }
  861. }
  862. },
  863. "/home": {
  864. "get": {
  865. "description": "Returns the screen with the home content",
  866. "tags": [
  867. "sdui"
  868. ],
  869. "operationId": "Home",
  870. "parameters": [],
  871. "responses": {
  872. "200": {
  873. "description": "Success response",
  874. "content": {
  875. "application/json": {
  876. "schema": {
  877. "$ref": "#/components/schemas/ScreenResponse"
  878. }
  879. }
  880. }
  881. }
  882. }
  883. }
  884. },
  885. "/home-content": {
  886. "get": {
  887. "description": "Returns the banner content for the homepage in the app",
  888. "tags": [
  889. "sdui"
  890. ],
  891. "operationId": "CFHomeContent",
  892. "parameters": [],
  893. "responses": {
  894. "200": {
  895. "description": "Success response",
  896. "content": {
  897. "application/json": {
  898. "schema": {
  899. "$ref": "#/components/schemas/HomeResponse"
  900. }
  901. }
  902. }
  903. }
  904. }
  905. }
  906. },
  907. "/invoice-details": {
  908. "get": {
  909. "description": "Returns the details of one invoice including a return QR code if available.",
  910. "tags": [
  911. "orders"
  912. ],
  913. "operationId": "InvoiceDetails",
  914. "parameters": [
  915. {
  916. "name": "id",
  917. "required": true,
  918. "in": "query",
  919. "schema": {
  920. "type": "string"
  921. }
  922. },
  923. {
  924. "name": "origin",
  925. "required": false,
  926. "in": "query",
  927. "schema": {
  928. "type": "string"
  929. }
  930. }
  931. ],
  932. "responses": {
  933. "200": {
  934. "description": "Success response",
  935. "content": {
  936. "application/json": {
  937. "schema": {
  938. "$ref": "#/components/schemas/ScreenResponse"
  939. }
  940. }
  941. }
  942. }
  943. }
  944. }
  945. },
  946. "/login": {
  947. "post": {
  948. "description": "Obtains oauth tokens for the user.",
  949. "tags": [
  950. "account"
  951. ],
  952. "operationId": "Login",
  953. "parameters": [],
  954. "requestBody": {
  955. "required": true,
  956. "content": {
  957. "application/json": {
  958. "schema": {
  959. "$ref": "#/components/schemas/LoginRequest"
  960. }
  961. }
  962. }
  963. },
  964. "responses": {
  965. "200": {
  966. "description": "Success response",
  967. "content": {
  968. "application/json": {
  969. "schema": {
  970. "$ref": "#/components/schemas/TokenResponse"
  971. }
  972. }
  973. }
  974. }
  975. }
  976. }
  977. },
  978. "/loyalty": {
  979. "get": {
  980. "description": "Returns all information relevant to the user both authenticated and anonymous. Data includes available vouchers, activated vouchers & point balance.",
  981. "tags": [
  982. "sdui"
  983. ],
  984. "operationId": "Loyalty",
  985. "parameters": [],
  986. "responses": {
  987. "200": {
  988. "description": "Success response",
  989. "content": {
  990. "application/json": {
  991. "schema": {
  992. "$ref": "#/components/schemas/LoyaltyResponse"
  993. }
  994. }
  995. }
  996. }
  997. }
  998. }
  999. },
  1000. "/loyalty-donate-points": {
  1001. "post": {
  1002. "description": "Donate a chosen amount of points from your loyalty balance to a charity of your choice.",
  1003. "tags": [
  1004. "loyalty"
  1005. ],
  1006. "operationId": "LoyaltyDonatePoints",
  1007. "parameters": [],
  1008. "requestBody": {
  1009. "required": true,
  1010. "content": {
  1011. "application/json": {
  1012. "schema": {
  1013. "$ref": "#/components/schemas/LoyaltyDonatePointsRequest"
  1014. }
  1015. }
  1016. }
  1017. },
  1018. "responses": {
  1019. "200": {
  1020. "description": "Success response",
  1021. "content": {
  1022. "application/json": {
  1023. "schema": {
  1024. "$ref": "#/components/schemas/CommandResponse"
  1025. }
  1026. }
  1027. }
  1028. },
  1029. "400": {
  1030. "description": "Bad request",
  1031. "content": {
  1032. "application/json": {
  1033. "schema": {
  1034. "$ref": "#/components/schemas/ErrorResponse"
  1035. }
  1036. }
  1037. }
  1038. },
  1039. "401": {
  1040. "description": "Not authenticated",
  1041. "content": {
  1042. "application/json": {
  1043. "schema": {
  1044. "$ref": "#/components/schemas/ErrorResponse"
  1045. }
  1046. }
  1047. }
  1048. }
  1049. }
  1050. }
  1051. },
  1052. "/me": {
  1053. "get": {
  1054. "description": "Returns all information relevant to the user both authenticated and anonymous. Data includes available vouchers, activated vouchers & point balance.",
  1055. "tags": [
  1056. "loyalty"
  1057. ],
  1058. "operationId": "Me",
  1059. "parameters": [],
  1060. "responses": {
  1061. "200": {
  1062. "description": "Success response",
  1063. "content": {
  1064. "application/json": {
  1065. "schema": {
  1066. "$ref": "#/components/schemas/EmptyResponse"
  1067. }
  1068. }
  1069. }
  1070. }
  1071. }
  1072. }
  1073. },
  1074. "/notification-settings": {
  1075. "get": {
  1076. "description": "Returns a screen with notification settings",
  1077. "tags": [
  1078. "sdui"
  1079. ],
  1080. "operationId": "notificationSettings",
  1081. "parameters": [],
  1082. "responses": {
  1083. "200": {
  1084. "description": "Success response",
  1085. "content": {
  1086. "application/json": {
  1087. "schema": {
  1088. "$ref": "#/components/schemas/ScreenResponse"
  1089. }
  1090. }
  1091. }
  1092. }
  1093. }
  1094. }
  1095. },
  1096. "/privacy": {
  1097. "get": {
  1098. "description": "Returns a screen with privacy links",
  1099. "tags": [
  1100. "sdui"
  1101. ],
  1102. "operationId": "Privacy",
  1103. "parameters": [],
  1104. "responses": {
  1105. "200": {
  1106. "description": "Success response",
  1107. "content": {
  1108. "application/json": {
  1109. "schema": {
  1110. "$ref": "#/components/schemas/ScreenResponse"
  1111. }
  1112. }
  1113. }
  1114. }
  1115. }
  1116. }
  1117. },
  1118. "/order-details": {
  1119. "get": {
  1120. "description": "Returns the details of one order including track & trace info and a return QR code.",
  1121. "tags": [
  1122. "orders"
  1123. ],
  1124. "operationId": "OrderDetails",
  1125. "parameters": [
  1126. {
  1127. "name": "id",
  1128. "required": true,
  1129. "in": "query",
  1130. "schema": {
  1131. "type": "string"
  1132. }
  1133. },
  1134. {
  1135. "name": "origin",
  1136. "required": false,
  1137. "in": "query",
  1138. "schema": {
  1139. "type": "string"
  1140. }
  1141. },
  1142. {
  1143. "name": "includeInvoiceDetails",
  1144. "required": false,
  1145. "in": "query",
  1146. "schema": {
  1147. "type": "boolean"
  1148. }
  1149. }
  1150. ],
  1151. "responses": {
  1152. "200": {
  1153. "description": "Success response",
  1154. "content": {
  1155. "application/json": {
  1156. "schema": {
  1157. "$ref": "#/components/schemas/ScreenResponse"
  1158. }
  1159. }
  1160. }
  1161. }
  1162. }
  1163. }
  1164. },
  1165. "/order-history-overview": {
  1166. "get": {
  1167. "description": "Returns the first page of order history for the logged in user",
  1168. "tags": [
  1169. "orders"
  1170. ],
  1171. "operationId": "OrderHistoryOverview",
  1172. "parameters": [],
  1173. "responses": {
  1174. "200": {
  1175. "description": "Success response",
  1176. "content": {
  1177. "application/json": {
  1178. "schema": {
  1179. "$ref": "#/components/schemas/ScreenResponse"
  1180. }
  1181. }
  1182. }
  1183. }
  1184. }
  1185. }
  1186. },
  1187. "/order-history-overview-additional": {
  1188. "get": {
  1189. "description": "Returns additional paginated order history",
  1190. "tags": [
  1191. "orders"
  1192. ],
  1193. "operationId": "OrderHistoryOverviewAdditional",
  1194. "parameters": [
  1195. {
  1196. "name": "uniqueId",
  1197. "required": true,
  1198. "in": "query",
  1199. "schema": {
  1200. "type": "string"
  1201. }
  1202. },
  1203. {
  1204. "name": "cursor",
  1205. "required": false,
  1206. "in": "query",
  1207. "schema": {
  1208. "type": "string"
  1209. }
  1210. },
  1211. {
  1212. "name": "invoicesOffset",
  1213. "required": false,
  1214. "in": "query",
  1215. "schema": {
  1216. "type": "integer"
  1217. }
  1218. }
  1219. ],
  1220. "responses": {
  1221. "200": {
  1222. "description": "Success response",
  1223. "content": {
  1224. "application/json": {
  1225. "schema": {
  1226. "$ref": "#/components/schemas/ComponentArrayResponse"
  1227. }
  1228. }
  1229. }
  1230. }
  1231. }
  1232. }
  1233. },
  1234. "/order-overview": {
  1235. "get": {
  1236. "description": "Returns an overview of the user's open orders.",
  1237. "tags": [
  1238. "orders"
  1239. ],
  1240. "operationId": "OrderOverview",
  1241. "parameters": [],
  1242. "responses": {
  1243. "200": {
  1244. "description": "Success response",
  1245. "content": {
  1246. "application/json": {
  1247. "schema": {
  1248. "$ref": "#/components/schemas/ScreenResponse"
  1249. }
  1250. }
  1251. }
  1252. }
  1253. }
  1254. }
  1255. },
  1256. "/order-status-component": {
  1257. "get": {
  1258. "description": "Returns the order status component. Do not request it directly, instead load it through the order status placeholder component",
  1259. "tags": [
  1260. "orders"
  1261. ],
  1262. "operationId": "OrderStatusComponent",
  1263. "parameters": [],
  1264. "responses": {
  1265. "200": {
  1266. "description": "Success response",
  1267. "content": {
  1268. "application/json": {
  1269. "schema": {
  1270. "$ref": "#/components/schemas/ComponentResponse"
  1271. }
  1272. }
  1273. }
  1274. }
  1275. }
  1276. }
  1277. },
  1278. "/platform-redirect": {
  1279. "get": {
  1280. "description": "Redirects to either the ios or android url supplied (and encoded with encodeURIComponent()) in the query strings according to the User-Agent header used.",
  1281. "tags": [
  1282. "system"
  1283. ],
  1284. "operationId": "PlatformRedirect",
  1285. "parameters": [
  1286. {
  1287. "name": "ios",
  1288. "required": true,
  1289. "in": "query",
  1290. "schema": {
  1291. "type": "string"
  1292. }
  1293. },
  1294. {
  1295. "name": "android",
  1296. "required": true,
  1297. "in": "query",
  1298. "schema": {
  1299. "type": "string"
  1300. }
  1301. }
  1302. ],
  1303. "responses": {
  1304. "200": {
  1305. "description": "Success response",
  1306. "content": {
  1307. "application/json": {
  1308. "schema": {
  1309. "$ref": "#/components/schemas/EmptyResponse"
  1310. }
  1311. }
  1312. }
  1313. }
  1314. }
  1315. }
  1316. },
  1317. "/product": {
  1318. "get": {
  1319. "description": "Product detail page",
  1320. "tags": [
  1321. "commerce"
  1322. ],
  1323. "operationId": "Product",
  1324. "parameters": [
  1325. {
  1326. "name": "id",
  1327. "required": true,
  1328. "in": "query",
  1329. "schema": {
  1330. "type": "string"
  1331. }
  1332. },
  1333. {
  1334. "name": "favoriteStoreId",
  1335. "required": false,
  1336. "in": "query",
  1337. "schema": {
  1338. "type": "string"
  1339. },
  1340. "description": "Optional string placeholder replaced by the consumer with a value or the string value \"null\" if not available."
  1341. },
  1342. {
  1343. "name": "lastSelectedStoreId",
  1344. "required": false,
  1345. "in": "query",
  1346. "schema": {
  1347. "type": "string"
  1348. },
  1349. "description": "Optional string placeholder replaced by the consumer with a value or the string value \"null\" if not available."
  1350. }
  1351. ],
  1352. "responses": {
  1353. "200": {
  1354. "description": "Success response",
  1355. "content": {
  1356. "application/json": {
  1357. "schema": {
  1358. "$ref": "#/components/schemas/ScreenResponse"
  1359. }
  1360. }
  1361. }
  1362. }
  1363. }
  1364. }
  1365. },
  1366. "/product-reviews": {
  1367. "get": {
  1368. "description": "Product reviews",
  1369. "tags": [
  1370. "commerce"
  1371. ],
  1372. "operationId": "ProductReviews",
  1373. "parameters": [
  1374. {
  1375. "name": "productId",
  1376. "required": true,
  1377. "in": "query",
  1378. "schema": {
  1379. "type": "string"
  1380. }
  1381. },
  1382. {
  1383. "name": "reviewId",
  1384. "required": false,
  1385. "in": "query",
  1386. "schema": {
  1387. "type": "string"
  1388. }
  1389. }
  1390. ],
  1391. "responses": {
  1392. "200": {
  1393. "description": "Success response",
  1394. "content": {
  1395. "application/json": {
  1396. "schema": {
  1397. "$ref": "#/components/schemas/ScreenResponse"
  1398. }
  1399. }
  1400. }
  1401. }
  1402. }
  1403. }
  1404. },
  1405. "/product-reviews-additional": {
  1406. "get": {
  1407. "description": "Product reviews - get additional reviews",
  1408. "tags": [
  1409. "commerce"
  1410. ],
  1411. "operationId": "ProductReviewsAdditional",
  1412. "parameters": [
  1413. {
  1414. "name": "productId",
  1415. "required": true,
  1416. "in": "query",
  1417. "schema": {
  1418. "type": "string"
  1419. }
  1420. },
  1421. {
  1422. "name": "offset",
  1423. "required": true,
  1424. "in": "query",
  1425. "schema": {
  1426. "type": "integer"
  1427. }
  1428. },
  1429. {
  1430. "name": "uniqueId",
  1431. "required": true,
  1432. "in": "query",
  1433. "schema": {
  1434. "type": "string"
  1435. }
  1436. }
  1437. ],
  1438. "responses": {
  1439. "200": {
  1440. "description": "Success response",
  1441. "content": {
  1442. "application/json": {
  1443. "schema": {
  1444. "$ref": "#/components/schemas/ComponentArrayResponse"
  1445. }
  1446. }
  1447. }
  1448. }
  1449. }
  1450. }
  1451. },
  1452. "/profile": {
  1453. "delete": {
  1454. "description": "Delete the users profile.",
  1455. "tags": [
  1456. "account"
  1457. ],
  1458. "operationId": "ProfileDelete",
  1459. "parameters": [],
  1460. "responses": {
  1461. "200": {
  1462. "description": "Success response",
  1463. "content": {
  1464. "application/json": {
  1465. "schema": {
  1466. "$ref": "#/components/schemas/EmptyResponse"
  1467. }
  1468. }
  1469. }
  1470. },
  1471. "401": {
  1472. "description": "Not authenticated",
  1473. "content": {
  1474. "application/json": {
  1475. "schema": {
  1476. "$ref": "#/components/schemas/ErrorResponse"
  1477. }
  1478. }
  1479. }
  1480. },
  1481. "500": {
  1482. "description": "An unexpected error has occured",
  1483. "content": {
  1484. "application/json": {
  1485. "schema": {
  1486. "$ref": "#/components/schemas/ErrorResponse"
  1487. }
  1488. }
  1489. }
  1490. }
  1491. }
  1492. },
  1493. "get": {
  1494. "description": "Returns the users profile.",
  1495. "tags": [
  1496. "account"
  1497. ],
  1498. "operationId": "Profile",
  1499. "parameters": [],
  1500. "responses": {
  1501. "200": {
  1502. "description": "Success response",
  1503. "content": {
  1504. "application/json": {
  1505. "schema": {
  1506. "$ref": "#/components/schemas/ProfileResponse"
  1507. }
  1508. }
  1509. }
  1510. }
  1511. }
  1512. }
  1513. },
  1514. "/promotions-overview": {
  1515. "get": {
  1516. "description": "Returns a screen with a promotions overview",
  1517. "tags": [
  1518. "sdui"
  1519. ],
  1520. "operationId": "PromotionsOverview",
  1521. "parameters": [],
  1522. "responses": {
  1523. "200": {
  1524. "description": "Success response",
  1525. "content": {
  1526. "application/json": {
  1527. "schema": {
  1528. "$ref": "#/components/schemas/ScreenResponse"
  1529. }
  1530. }
  1531. }
  1532. }
  1533. }
  1534. }
  1535. },
  1536. "/redirect": {
  1537. "get": {
  1538. "description": "Redirects the user to the requested page in the correct language with the correct parameters.",
  1539. "tags": [
  1540. "system"
  1541. ],
  1542. "operationId": "Redirect",
  1543. "parameters": [
  1544. {
  1545. "name": "type",
  1546. "required": true,
  1547. "in": "query",
  1548. "schema": {
  1549. "type": "string",
  1550. "enum": [
  1551. "toc",
  1552. "privacy",
  1553. "cookie",
  1554. "store-locator",
  1555. "hema-loyalty-explanation"
  1556. ]
  1557. }
  1558. },
  1559. {
  1560. "name": "appuser",
  1561. "required": false,
  1562. "in": "query",
  1563. "schema": {
  1564. "type": "integer"
  1565. }
  1566. },
  1567. {
  1568. "name": "connect_id",
  1569. "required": false,
  1570. "in": "query",
  1571. "schema": {
  1572. "type": "string"
  1573. }
  1574. },
  1575. {
  1576. "name": "acceptLanguage",
  1577. "required": false,
  1578. "in": "query",
  1579. "schema": {
  1580. "type": "string"
  1581. }
  1582. },
  1583. {
  1584. "name": "countryCode",
  1585. "required": false,
  1586. "in": "query",
  1587. "schema": {
  1588. "type": "string"
  1589. }
  1590. }
  1591. ],
  1592. "responses": {
  1593. "200": {
  1594. "description": "Success response",
  1595. "content": {
  1596. "application/json": {
  1597. "schema": {
  1598. "$ref": "#/components/schemas/EmptyResponse"
  1599. }
  1600. }
  1601. }
  1602. }
  1603. }
  1604. }
  1605. },
  1606. "/refresh-token": {
  1607. "post": {
  1608. "description": "Obtains a fresh access token for the user",
  1609. "tags": [
  1610. "account"
  1611. ],
  1612. "operationId": "RefreshToken",
  1613. "parameters": [],
  1614. "requestBody": {
  1615. "required": true,
  1616. "content": {
  1617. "application/json": {
  1618. "schema": {
  1619. "$ref": "#/components/schemas/RefreshRequest"
  1620. }
  1621. }
  1622. }
  1623. },
  1624. "responses": {
  1625. "200": {
  1626. "description": "Success response",
  1627. "content": {
  1628. "application/json": {
  1629. "schema": {
  1630. "$ref": "#/components/schemas/TokenResponse"
  1631. }
  1632. }
  1633. }
  1634. }
  1635. }
  1636. }
  1637. },
  1638. "/register": {
  1639. "post": {
  1640. "description": "Creates a profile for the user and logs in automatically whenever successful.",
  1641. "tags": [
  1642. "account"
  1643. ],
  1644. "operationId": "Register",
  1645. "parameters": [],
  1646. "requestBody": {
  1647. "required": true,
  1648. "content": {
  1649. "application/json": {
  1650. "schema": {
  1651. "$ref": "#/components/schemas/RegisterRequest"
  1652. }
  1653. }
  1654. }
  1655. },
  1656. "responses": {
  1657. "200": {
  1658. "description": "Success response",
  1659. "content": {
  1660. "application/json": {
  1661. "schema": {
  1662. "$ref": "#/components/schemas/TokenResponse"
  1663. }
  1664. }
  1665. }
  1666. }
  1667. }
  1668. }
  1669. },
  1670. "/remove-from-favorites": {
  1671. "post": {
  1672. "description": "Remove product from the user's favorites list",
  1673. "tags": [
  1674. "account",
  1675. "commerce"
  1676. ],
  1677. "operationId": "RemoveFromFavorites",
  1678. "parameters": [],
  1679. "requestBody": {
  1680. "required": true,
  1681. "content": {
  1682. "application/json": {
  1683. "schema": {
  1684. "$ref": "#/components/schemas/RemoveFromFavoritesRequest"
  1685. }
  1686. }
  1687. }
  1688. },
  1689. "responses": {
  1690. "200": {
  1691. "description": "Success response",
  1692. "content": {
  1693. "application/json": {
  1694. "schema": {
  1695. "$ref": "#/components/schemas/CommandResponse"
  1696. }
  1697. }
  1698. }
  1699. }
  1700. }
  1701. }
  1702. },
  1703. "/scan": {
  1704. "get": {
  1705. "description": "Analyzes the barcode and returns an action what to do next",
  1706. "tags": [
  1707. "sdui"
  1708. ],
  1709. "operationId": "Scan",
  1710. "parameters": [
  1711. {
  1712. "name": "barcode",
  1713. "required": true,
  1714. "in": "query",
  1715. "schema": {
  1716. "type": "string"
  1717. }
  1718. },
  1719. {
  1720. "name": "manual",
  1721. "required": true,
  1722. "in": "query",
  1723. "schema": {
  1724. "type": "boolean"
  1725. }
  1726. }
  1727. ],
  1728. "responses": {
  1729. "200": {
  1730. "description": "Success response",
  1731. "content": {
  1732. "application/json": {
  1733. "schema": {
  1734. "$ref": "#/components/schemas/ScanResponse"
  1735. }
  1736. }
  1737. }
  1738. }
  1739. }
  1740. }
  1741. },
  1742. "/search": {
  1743. "get": {
  1744. "description": "Returns the contents of a product list page. Data consists of a list of products, headed by a total product count, each product specifying product name and image",
  1745. "tags": [
  1746. "sdui"
  1747. ],
  1748. "operationId": "Search",
  1749. "parameters": [
  1750. {
  1751. "name": "term",
  1752. "required": false,
  1753. "in": "query",
  1754. "schema": {
  1755. "type": "string"
  1756. }
  1757. },
  1758. {
  1759. "name": "categoryId",
  1760. "required": false,
  1761. "in": "query",
  1762. "schema": {
  1763. "type": "string"
  1764. }
  1765. },
  1766. {
  1767. "name": "disableOutOfStockFallback",
  1768. "required": false,
  1769. "in": "query",
  1770. "schema": {
  1771. "type": "boolean"
  1772. }
  1773. },
  1774. {
  1775. "name": "sort",
  1776. "required": false,
  1777. "in": "query",
  1778. "schema": {
  1779. "type": "string"
  1780. }
  1781. }
  1782. ],
  1783. "responses": {
  1784. "200": {
  1785. "description": "Success response",
  1786. "content": {
  1787. "application/json": {
  1788. "schema": {
  1789. "$ref": "#/components/schemas/ScreenResponse"
  1790. }
  1791. }
  1792. }
  1793. }
  1794. }
  1795. }
  1796. },
  1797. "/search_load_additional": {
  1798. "get": {
  1799. "description": "Returns the contents of a product list page. Data consists of a list of products, headed by a total product count, each product specifying product name and image",
  1800. "tags": [
  1801. "sdui"
  1802. ],
  1803. "operationId": "SearchLoadAdditional",
  1804. "parameters": [
  1805. {
  1806. "name": "offset",
  1807. "required": true,
  1808. "in": "query",
  1809. "schema": {
  1810. "type": "integer"
  1811. }
  1812. },
  1813. {
  1814. "name": "uniqueId",
  1815. "required": true,
  1816. "in": "query",
  1817. "schema": {
  1818. "type": "string"
  1819. }
  1820. },
  1821. {
  1822. "name": "term",
  1823. "required": false,
  1824. "in": "query",
  1825. "schema": {
  1826. "type": "string"
  1827. }
  1828. },
  1829. {
  1830. "name": "categoryId",
  1831. "required": false,
  1832. "in": "query",
  1833. "schema": {
  1834. "type": "string"
  1835. }
  1836. },
  1837. {
  1838. "name": "disableOutOfStockFallback",
  1839. "required": false,
  1840. "in": "query",
  1841. "schema": {
  1842. "type": "boolean"
  1843. }
  1844. },
  1845. {
  1846. "name": "sort",
  1847. "required": false,
  1848. "in": "query",
  1849. "schema": {
  1850. "type": "string"
  1851. }
  1852. }
  1853. ],
  1854. "responses": {
  1855. "200": {
  1856. "description": "Success response",
  1857. "content": {
  1858. "application/json": {
  1859. "schema": {
  1860. "$ref": "#/components/schemas/ComponentArrayResponse"
  1861. }
  1862. }
  1863. }
  1864. }
  1865. }
  1866. }
  1867. },
  1868. "/settings": {
  1869. "post": {
  1870. "description": "Settings",
  1871. "tags": [
  1872. "account"
  1873. ],
  1874. "operationId": "Updates settings for the user.",
  1875. "parameters": [],
  1876. "requestBody": {
  1877. "required": true,
  1878. "content": {
  1879. "application/json": {
  1880. "schema": {
  1881. "$ref": "#/components/schemas/SettingsRequest"
  1882. }
  1883. }
  1884. }
  1885. },
  1886. "responses": {
  1887. "200": {
  1888. "description": "Success response",
  1889. "content": {
  1890. "application/json": {
  1891. "schema": {
  1892. "$ref": "#/components/schemas/EmptyResponse"
  1893. }
  1894. }
  1895. }
  1896. }
  1897. }
  1898. }
  1899. },
  1900. "/styleguide": {
  1901. "get": {
  1902. "description": "SDUI styleguide",
  1903. "tags": [
  1904. "sdui"
  1905. ],
  1906. "operationId": "Styleguide",
  1907. "parameters": [
  1908. {
  1909. "name": "section",
  1910. "required": false,
  1911. "in": "query",
  1912. "schema": {
  1913. "type": "string"
  1914. }
  1915. }
  1916. ],
  1917. "responses": {
  1918. "200": {
  1919. "description": "Success response",
  1920. "content": {
  1921. "application/json": {
  1922. "schema": {
  1923. "$ref": "#/components/schemas/ScreenResponse"
  1924. }
  1925. }
  1926. }
  1927. }
  1928. }
  1929. },
  1930. "post": {
  1931. "description": "SDUI styleguide commands",
  1932. "tags": [
  1933. "sdui"
  1934. ],
  1935. "operationId": "StyleguideCommands",
  1936. "parameters": [],
  1937. "requestBody": {
  1938. "required": true,
  1939. "content": {
  1940. "application/json": {
  1941. "schema": {
  1942. "$ref": "#/components/schemas/StyleguideCommandRequest"
  1943. }
  1944. }
  1945. }
  1946. },
  1947. "responses": {
  1948. "200": {
  1949. "description": "Success response",
  1950. "content": {
  1951. "application/json": {
  1952. "schema": {
  1953. "$ref": "#/components/schemas/CommandResponse"
  1954. }
  1955. }
  1956. }
  1957. }
  1958. }
  1959. }
  1960. },
  1961. "/suggestions": {
  1962. "get": {
  1963. "description": "Returns suggestions for the given query",
  1964. "tags": [
  1965. "sdui"
  1966. ],
  1967. "operationId": "Suggestions",
  1968. "parameters": [
  1969. {
  1970. "name": "term",
  1971. "required": true,
  1972. "in": "query",
  1973. "schema": {
  1974. "type": "string"
  1975. }
  1976. }
  1977. ],
  1978. "responses": {
  1979. "200": {
  1980. "description": "Success response",
  1981. "content": {
  1982. "application/json": {
  1983. "schema": {
  1984. "$ref": "#/components/schemas/SectionsArrayResponse"
  1985. }
  1986. }
  1987. }
  1988. }
  1989. }
  1990. }
  1991. },
  1992. "/profile/upgrade-to-loyalty": {
  1993. "post": {
  1994. "description": "Upgrades the users account to a loyality account in order to make user of vouchers.",
  1995. "tags": [
  1996. "loyalty"
  1997. ],
  1998. "operationId": "UpgradeToLoyalty",
  1999. "parameters": [],
  2000. "requestBody": {
  2001. "required": true,
  2002. "content": {
  2003. "application/json": {
  2004. "schema": {
  2005. "$ref": "#/components/schemas/LoyaltyUpgradeRequest"
  2006. }
  2007. }
  2008. }
  2009. },
  2010. "responses": {
  2011. "200": {
  2012. "description": "Success response",
  2013. "content": {
  2014. "application/json": {
  2015. "schema": {
  2016. "$ref": "#/components/schemas/EmptyResponse"
  2017. }
  2018. }
  2019. }
  2020. }
  2021. }
  2022. }
  2023. },
  2024. "/url-lookup": {
  2025. "get": {
  2026. "description": "",
  2027. "tags": [
  2028. "system"
  2029. ],
  2030. "operationId": "UrlLookup",
  2031. "parameters": [
  2032. {
  2033. "name": "url",
  2034. "required": true,
  2035. "in": "query",
  2036. "schema": {
  2037. "type": "string"
  2038. }
  2039. }
  2040. ],
  2041. "responses": {
  2042. "200": {
  2043. "description": "Success response",
  2044. "content": {
  2045. "application/json": {
  2046. "schema": {
  2047. "$ref": "#/components/schemas/UrlLookupResponse"
  2048. }
  2049. }
  2050. }
  2051. }
  2052. }
  2053. }
  2054. },
  2055. "/variation-product-list": {
  2056. "get": {
  2057. "description": "Returns a list of the product variants in the same group, which is usually displayed within a screen with display type 'Sheet'.",
  2058. "tags": [
  2059. "commerce"
  2060. ],
  2061. "operationId": "VariationProductList",
  2062. "parameters": [
  2063. {
  2064. "name": "variationProductIds",
  2065. "required": true,
  2066. "in": "query",
  2067. "schema": {
  2068. "type": "string"
  2069. }
  2070. },
  2071. {
  2072. "name": "attributeId",
  2073. "required": false,
  2074. "in": "query",
  2075. "schema": {
  2076. "type": "string"
  2077. }
  2078. },
  2079. {
  2080. "name": "attributeLabel",
  2081. "required": false,
  2082. "in": "query",
  2083. "schema": {
  2084. "type": "string"
  2085. }
  2086. },
  2087. {
  2088. "name": "pageType",
  2089. "required": true,
  2090. "in": "query",
  2091. "schema": {
  2092. "type": "string"
  2093. }
  2094. },
  2095. {
  2096. "name": "itemListName",
  2097. "required": true,
  2098. "in": "query",
  2099. "schema": {
  2100. "type": "string"
  2101. }
  2102. }
  2103. ],
  2104. "responses": {
  2105. "200": {
  2106. "description": "Success response",
  2107. "content": {
  2108. "application/json": {
  2109. "schema": {
  2110. "$ref": "#/components/schemas/ScreenResponse"
  2111. }
  2112. }
  2113. }
  2114. }
  2115. }
  2116. }
  2117. },
  2118. "/voucher-details": {
  2119. "get": {
  2120. "description": "Returns the content of the voucher detail screen for both authenticated and anonymous users.",
  2121. "tags": [
  2122. "sdui"
  2123. ],
  2124. "operationId": "VoucherDetails",
  2125. "parameters": [
  2126. {
  2127. "name": "voucherId",
  2128. "required": true,
  2129. "in": "query",
  2130. "schema": {
  2131. "type": "string"
  2132. }
  2133. }
  2134. ],
  2135. "responses": {
  2136. "200": {
  2137. "description": "Success response",
  2138. "content": {
  2139. "application/json": {
  2140. "schema": {
  2141. "$ref": "#/components/schemas/ScreenResponse"
  2142. }
  2143. }
  2144. }
  2145. }
  2146. }
  2147. }
  2148. },
  2149. "/vouchers-overview": {
  2150. "get": {
  2151. "description": "Returns the content of the vouchers overview screen for both authenticated and anonymous users. Content includes available vouchers, activated vouchers & point balance.",
  2152. "tags": [
  2153. "sdui"
  2154. ],
  2155. "operationId": "VouchersOverview",
  2156. "parameters": [],
  2157. "responses": {
  2158. "200": {
  2159. "description": "Success response",
  2160. "content": {
  2161. "application/json": {
  2162. "schema": {
  2163. "$ref": "#/components/schemas/ScreenResponse"
  2164. }
  2165. }
  2166. }
  2167. }
  2168. }
  2169. }
  2170. },
  2171. "/webview": {
  2172. "post": {
  2173. "description": "Handles the oauth delegation procedure.",
  2174. "tags": [
  2175. "system"
  2176. ],
  2177. "operationId": "Webview",
  2178. "parameters": [],
  2179. "requestBody": {
  2180. "required": true,
  2181. "content": {
  2182. "application/json": {
  2183. "schema": {
  2184. "$ref": "#/components/schemas/WebviewRequest"
  2185. }
  2186. }
  2187. }
  2188. },
  2189. "responses": {
  2190. "200": {
  2191. "description": "Success response",
  2192. "content": {
  2193. "application/json": {
  2194. "schema": {
  2195. "$ref": "#/components/schemas/WebviewResponse"
  2196. }
  2197. }
  2198. }
  2199. }
  2200. }
  2201. }
  2202. },
  2203. "/json-schema": {
  2204. "get": {
  2205. "description": "Get the JSON schema of the experience API.",
  2206. "tags": [
  2207. "system"
  2208. ],
  2209. "operationId": "JsonSchema",
  2210. "parameters": [],
  2211. "responses": {
  2212. "200": {
  2213. "description": "Success response"
  2214. }
  2215. }
  2216. }
  2217. },
  2218. "/introspect": {
  2219. "get": {
  2220. "description": "Get runtime information on deployment status and features. Not available on production.",
  2221. "tags": [
  2222. "system"
  2223. ],
  2224. "operationId": "Introspect",
  2225. "parameters": [],
  2226. "responses": {
  2227. "200": {
  2228. "description": "Success response",
  2229. "content": {
  2230. "application/json": {
  2231. "schema": {
  2232. "$ref": "#/components/schemas/IntrospectResponse"
  2233. }
  2234. }
  2235. }
  2236. }
  2237. }
  2238. }
  2239. }
  2240. },
  2241. "components": {
  2242. "schemas": {
  2243. "EmptyRequest": {
  2244. "type": "object",
  2245. "properties": {},
  2246. "additionalProperties": false
  2247. },
  2248. "EmptyResponse": {
  2249. "type": "object",
  2250. "properties": {},
  2251. "additionalProperties": false
  2252. },
  2253. "ErrorResponse": {
  2254. "type": "object",
  2255. "properties": {
  2256. "message": {
  2257. "type": "string"
  2258. },
  2259. "analyticEvents": {
  2260. "type": "array",
  2261. "items": {
  2262. "$ref": "#/components/schemas/AnalyticsEvent"
  2263. }
  2264. }
  2265. },
  2266. "required": [
  2267. "message"
  2268. ]
  2269. },
  2270. "TokenResponse": {
  2271. "type": "object",
  2272. "properties": {
  2273. "access_token": {
  2274. "type": "string"
  2275. },
  2276. "expires_in": {
  2277. "type": "number"
  2278. },
  2279. "token_type": {
  2280. "type": "string"
  2281. },
  2282. "refresh_token": {
  2283. "type": "string"
  2284. }
  2285. },
  2286. "required": [
  2287. "access_token",
  2288. "expires_in",
  2289. "token_type",
  2290. "refresh_token"
  2291. ]
  2292. },
  2293. "LoginRequest": {
  2294. "type": "object",
  2295. "properties": {
  2296. "email": {
  2297. "type": "string"
  2298. },
  2299. "password": {
  2300. "type": "string"
  2301. }
  2302. },
  2303. "required": [
  2304. "email",
  2305. "password"
  2306. ]
  2307. },
  2308. "RefreshRequest": {
  2309. "type": "object",
  2310. "properties": {
  2311. "refresh_token": {
  2312. "type": "string"
  2313. }
  2314. },
  2315. "required": [
  2316. "refresh_token"
  2317. ]
  2318. },
  2319. "Destination": {
  2320. "type": "string",
  2321. "enum": [
  2322. "cart",
  2323. "update-profile",
  2324. "change-password",
  2325. "add-address",
  2326. "change-address"
  2327. ]
  2328. },
  2329. "WebviewRequestForDestination": {
  2330. "type": "object",
  2331. "properties": {
  2332. "destination": {
  2333. "$ref": "#/components/schemas/Destination"
  2334. },
  2335. "extraParams": {
  2336. "type": "object",
  2337. "additionalProperties": false,
  2338. "x-patternProperties": {
  2339. ".*": {
  2340. "oneOf": [
  2341. {
  2342. "type": "boolean"
  2343. },
  2344. {
  2345. "type": "string"
  2346. },
  2347. {
  2348. "type": "number"
  2349. }
  2350. ]
  2351. }
  2352. }
  2353. }
  2354. },
  2355. "required": [
  2356. "destination"
  2357. ]
  2358. },
  2359. "WebviewRequestWithPath": {
  2360. "type": "object",
  2361. "properties": {
  2362. "path": {
  2363. "type": "string"
  2364. },
  2365. "requiresSessionBridge": {
  2366. "type": "boolean"
  2367. }
  2368. },
  2369. "required": [
  2370. "path"
  2371. ]
  2372. },
  2373. "WebviewRequest": {
  2374. "oneOf": [
  2375. {
  2376. "type": "object",
  2377. "properties": {
  2378. "path": {
  2379. "type": "string"
  2380. },
  2381. "requiresSessionBridge": {
  2382. "type": "boolean"
  2383. }
  2384. },
  2385. "required": [
  2386. "path"
  2387. ]
  2388. },
  2389. {
  2390. "type": "object",
  2391. "properties": {
  2392. "destination": {
  2393. "$ref": "#/components/schemas/Destination"
  2394. },
  2395. "extraParams": {
  2396. "type": "object",
  2397. "additionalProperties": false,
  2398. "x-patternProperties": {
  2399. ".*": {
  2400. "oneOf": [
  2401. {
  2402. "type": "boolean"
  2403. },
  2404. {
  2405. "type": "string"
  2406. },
  2407. {
  2408. "type": "number"
  2409. }
  2410. ]
  2411. }
  2412. }
  2413. }
  2414. },
  2415. "required": [
  2416. "destination"
  2417. ]
  2418. }
  2419. ]
  2420. },
  2421. "WebviewResponse": {
  2422. "type": "object",
  2423. "properties": {
  2424. "url": {
  2425. "type": "string"
  2426. }
  2427. },
  2428. "required": [
  2429. "url"
  2430. ]
  2431. },
  2432. "AddPushTokenRequest": {
  2433. "type": "object",
  2434. "properties": {
  2435. "token": {
  2436. "type": "string"
  2437. }
  2438. },
  2439. "required": [
  2440. "token"
  2441. ]
  2442. },
  2443. "PushNotificationChannelState": {
  2444. "type": "object",
  2445. "properties": {
  2446. "isOptInOrderNotifications": {
  2447. "type": "boolean"
  2448. },
  2449. "isOptInMarketingNotifications": {
  2450. "type": "boolean"
  2451. }
  2452. }
  2453. },
  2454. "RegisterRequest": {
  2455. "type": "object",
  2456. "properties": {
  2457. "email": {
  2458. "type": "string"
  2459. },
  2460. "password": {
  2461. "type": "string"
  2462. },
  2463. "postalCode": {
  2464. "type": "string"
  2465. },
  2466. "houseNumber": {
  2467. "type": "string"
  2468. },
  2469. "houseNumberAddition": {
  2470. "type": "string"
  2471. },
  2472. "street": {
  2473. "type": "string"
  2474. },
  2475. "city": {
  2476. "type": "string"
  2477. },
  2478. "countryCode": {
  2479. "type": "string"
  2480. },
  2481. "addressLine1": {
  2482. "type": "string"
  2483. },
  2484. "addressLine2": {
  2485. "type": "string"
  2486. },
  2487. "addressLine3": {
  2488. "type": "string"
  2489. },
  2490. "firstName": {
  2491. "type": "string"
  2492. },
  2493. "infix": {
  2494. "type": "string"
  2495. },
  2496. "lastName": {
  2497. "type": "string"
  2498. },
  2499. "sex": {
  2500. "type": "string",
  2501. "enum": [
  2502. "MALE",
  2503. "FEMALE",
  2504. "OTHER"
  2505. ]
  2506. }
  2507. },
  2508. "required": [
  2509. "email",
  2510. "password",
  2511. "postalCode",
  2512. "city",
  2513. "countryCode",
  2514. "firstName",
  2515. "lastName",
  2516. "sex"
  2517. ]
  2518. },
  2519. "ProfileResponse": {
  2520. "type": "object",
  2521. "properties": {
  2522. "userId": {
  2523. "type": "string"
  2524. },
  2525. "email": {
  2526. "type": "string"
  2527. },
  2528. "postalCode": {
  2529. "type": "string"
  2530. },
  2531. "houseNumber": {
  2532. "type": "string"
  2533. },
  2534. "houseNumberAddition": {
  2535. "type": "string"
  2536. },
  2537. "street": {
  2538. "type": "string"
  2539. },
  2540. "city": {
  2541. "type": "string"
  2542. },
  2543. "countryCode": {
  2544. "type": "string"
  2545. },
  2546. "firstName": {
  2547. "type": "string"
  2548. },
  2549. "infix": {
  2550. "type": "string"
  2551. },
  2552. "lastName": {
  2553. "type": "string"
  2554. },
  2555. "dateOfBirth": {
  2556. "type": "string"
  2557. },
  2558. "sex": {
  2559. "type": "string",
  2560. "enum": [
  2561. "MALE",
  2562. "FEMALE",
  2563. "OTHER"
  2564. ]
  2565. },
  2566. "isOptInNewsletter": {
  2567. "type": "boolean"
  2568. },
  2569. "isOptInNewsletterLoyalty": {
  2570. "type": "boolean"
  2571. },
  2572. "isLoyaltyMember": {
  2573. "type": "boolean"
  2574. },
  2575. "loyaltyCardToken": {
  2576. "type": "string"
  2577. },
  2578. "physicalCardId": {
  2579. "type": "string"
  2580. },
  2581. "virtualCardId": {
  2582. "type": "string"
  2583. },
  2584. "pointBalance": {
  2585. "type": "number"
  2586. },
  2587. "favoriteStoreId": {
  2588. "type": "string"
  2589. },
  2590. "lastSelectedStoreId": {
  2591. "type": "string"
  2592. },
  2593. "addresses": {
  2594. "type": "array",
  2595. "items": {
  2596. "$ref": "#/components/schemas/ProfileAddress"
  2597. }
  2598. }
  2599. },
  2600. "required": [
  2601. "userId",
  2602. "email"
  2603. ]
  2604. },
  2605. "ProfileAddress": {
  2606. "type": "object",
  2607. "properties": {
  2608. "id": {
  2609. "type": "string"
  2610. },
  2611. "title": {
  2612. "type": "string"
  2613. },
  2614. "postalCode": {
  2615. "type": "string"
  2616. },
  2617. "houseNumber": {
  2618. "type": "string"
  2619. },
  2620. "houseNumberAddition": {
  2621. "type": "string"
  2622. },
  2623. "street": {
  2624. "type": "string"
  2625. },
  2626. "city": {
  2627. "type": "string"
  2628. },
  2629. "companyName": {
  2630. "type": "string"
  2631. },
  2632. "countryCode": {
  2633. "type": "string"
  2634. },
  2635. "firstName": {
  2636. "type": "string"
  2637. },
  2638. "infix": {
  2639. "type": "string"
  2640. },
  2641. "lastName": {
  2642. "type": "string"
  2643. },
  2644. "isPrefered": {
  2645. "type": "boolean"
  2646. },
  2647. "phoneNumber": {
  2648. "type": "string"
  2649. }
  2650. },
  2651. "required": [
  2652. "id"
  2653. ]
  2654. },
  2655. "ForgotPasswordRequest": {
  2656. "type": "object",
  2657. "properties": {
  2658. "email": {
  2659. "type": "string"
  2660. }
  2661. },
  2662. "required": [
  2663. "email"
  2664. ]
  2665. },
  2666. "AccountAvailableRequest": {
  2667. "type": "object",
  2668. "properties": {
  2669. "email": {
  2670. "type": "string"
  2671. }
  2672. },
  2673. "required": [
  2674. "email"
  2675. ]
  2676. },
  2677. "AccountAvailableResponse": {
  2678. "type": "object",
  2679. "properties": {
  2680. "isAvailable": {
  2681. "type": "boolean"
  2682. },
  2683. "alert": {
  2684. "type": "object",
  2685. "properties": {
  2686. "title": {
  2687. "type": "string"
  2688. },
  2689. "message": {
  2690. "type": "string"
  2691. }
  2692. },
  2693. "required": [
  2694. "title",
  2695. "message"
  2696. ]
  2697. }
  2698. },
  2699. "required": [
  2700. "isAvailable"
  2701. ]
  2702. },
  2703. "NLAddressLookupRequest": {
  2704. "type": "object",
  2705. "properties": {
  2706. "postalCode": {
  2707. "type": "string"
  2708. },
  2709. "houseNumber": {
  2710. "type": "string"
  2711. },
  2712. "houseNumberAddition": {
  2713. "type": "string"
  2714. }
  2715. },
  2716. "required": [
  2717. "postalCode",
  2718. "houseNumber"
  2719. ]
  2720. },
  2721. "NLAddressLookupResponse": {
  2722. "type": "object",
  2723. "properties": {
  2724. "match": {
  2725. "type": "object",
  2726. "properties": {
  2727. "street": {
  2728. "type": "string"
  2729. },
  2730. "houseNumber": {
  2731. "type": "string"
  2732. },
  2733. "houseNumberAddition": {
  2734. "type": "string"
  2735. },
  2736. "postalCode": {
  2737. "type": "string"
  2738. },
  2739. "city": {
  2740. "type": "string"
  2741. },
  2742. "countryCode": {
  2743. "type": "string"
  2744. }
  2745. },
  2746. "required": [
  2747. "street",
  2748. "houseNumber",
  2749. "postalCode",
  2750. "city",
  2751. "countryCode"
  2752. ]
  2753. },
  2754. "noMatch": {
  2755. "type": "object",
  2756. "properties": {
  2757. "errorMessage": {
  2758. "type": "string"
  2759. }
  2760. },
  2761. "required": [
  2762. "errorMessage"
  2763. ]
  2764. }
  2765. }
  2766. },
  2767. "LoyaltyUpgradeRequest": {
  2768. "type": "object",
  2769. "properties": {
  2770. "birthDate": {
  2771. "type": "string"
  2772. },
  2773. "hasAcceptedTermsAndConditions": {
  2774. "type": "boolean"
  2775. },
  2776. "hasParentalApprovement": {
  2777. "type": "boolean"
  2778. },
  2779. "isOptInNewsletterWebshop": {
  2780. "type": "boolean"
  2781. },
  2782. "isOptInNewsletterLoyalty": {
  2783. "type": "boolean"
  2784. }
  2785. },
  2786. "required": [
  2787. "birthDate",
  2788. "hasAcceptedTermsAndConditions"
  2789. ]
  2790. },
  2791. "MeResponse": {
  2792. "type": "object",
  2793. "properties": {
  2794. "profile": {
  2795. "$ref": "#/components/schemas/ProfileResponse"
  2796. },
  2797. "pointBalance": {
  2798. "type": "number"
  2799. },
  2800. "virtualCardId": {
  2801. "type": "string"
  2802. },
  2803. "physicalCardId": {
  2804. "type": "string"
  2805. },
  2806. "activeVouchers": {
  2807. "type": "array",
  2808. "items": {
  2809. "$ref": "#/components/schemas/Voucher"
  2810. }
  2811. },
  2812. "availableVouchers": {
  2813. "type": "array",
  2814. "items": {
  2815. "$ref": "#/components/schemas/Voucher"
  2816. }
  2817. },
  2818. "infoMessage": {
  2819. "$ref": "#/components/schemas/InfoMessageComponent"
  2820. },
  2821. "promotedProducts": {
  2822. "$ref": "#/components/schemas/PromotedProducts"
  2823. }
  2824. },
  2825. "required": [
  2826. "availableVouchers"
  2827. ]
  2828. },
  2829. "LoyaltyResponse": {
  2830. "type": "object",
  2831. "properties": {
  2832. "pointBalance": {
  2833. "type": "number"
  2834. },
  2835. "activeVouchers": {
  2836. "type": "array",
  2837. "items": {
  2838. "$ref": "#/components/schemas/Voucher"
  2839. }
  2840. },
  2841. "availableVouchers": {
  2842. "type": "array",
  2843. "items": {
  2844. "$ref": "#/components/schemas/Voucher"
  2845. }
  2846. },
  2847. "infoMessage": {
  2848. "$ref": "#/components/schemas/InfoMessageComponent"
  2849. },
  2850. "promotedProducts": {
  2851. "$ref": "#/components/schemas/PromotedProducts"
  2852. }
  2853. },
  2854. "required": [
  2855. "availableVouchers"
  2856. ]
  2857. },
  2858. "PromotedProducts": {
  2859. "type": "object",
  2860. "properties": {
  2861. "products": {
  2862. "type": "array",
  2863. "items": {
  2864. "$ref": "#/components/schemas/PlpListItem"
  2865. }
  2866. },
  2867. "categoryId": {
  2868. "type": "string"
  2869. }
  2870. },
  2871. "required": [
  2872. "products",
  2873. "categoryId"
  2874. ]
  2875. },
  2876. "Voucher": {
  2877. "type": "object",
  2878. "properties": {
  2879. "voucherId": {
  2880. "type": "number"
  2881. },
  2882. "points": {
  2883. "type": "number"
  2884. },
  2885. "isDeactivatable": {
  2886. "type": "boolean"
  2887. },
  2888. "imageUrl": {
  2889. "type": "string"
  2890. },
  2891. "pointsNeededPercentage": {
  2892. "type": "number"
  2893. },
  2894. "type": {
  2895. "$ref": "#/components/schemas/VoucherDisplayType"
  2896. },
  2897. "title": {
  2898. "type": "string"
  2899. },
  2900. "subtitle": {
  2901. "type": "string"
  2902. },
  2903. "description": {
  2904. "type": "string"
  2905. },
  2906. "about": {
  2907. "type": "object",
  2908. "properties": {
  2909. "title": {
  2910. "type": "string"
  2911. },
  2912. "body": {
  2913. "type": "string"
  2914. }
  2915. },
  2916. "required": [
  2917. "title",
  2918. "body"
  2919. ]
  2920. },
  2921. "relatedProduct": {
  2922. "type": "object",
  2923. "properties": {
  2924. "url": {
  2925. "type": "string"
  2926. },
  2927. "label": {
  2928. "type": "string"
  2929. }
  2930. },
  2931. "required": [
  2932. "url",
  2933. "label"
  2934. ]
  2935. },
  2936. "conditions": {
  2937. "type": "object",
  2938. "properties": {
  2939. "title": {
  2940. "type": "string"
  2941. },
  2942. "body": {
  2943. "type": "string"
  2944. }
  2945. },
  2946. "required": [
  2947. "title",
  2948. "body"
  2949. ]
  2950. },
  2951. "trails": {
  2952. "type": "object",
  2953. "properties": {
  2954. "title": {
  2955. "type": "string"
  2956. },
  2957. "lists": {
  2958. "type": "array",
  2959. "items": {
  2960. "$ref": "#/components/schemas/ContentList"
  2961. }
  2962. }
  2963. },
  2964. "required": [
  2965. "title",
  2966. "lists"
  2967. ]
  2968. }
  2969. },
  2970. "required": [
  2971. "voucherId",
  2972. "isDeactivatable",
  2973. "type",
  2974. "trails"
  2975. ]
  2976. },
  2977. "ContentList": {
  2978. "type": "object",
  2979. "properties": {
  2980. "type": {
  2981. "type": "string",
  2982. "enum": [
  2983. "LIST"
  2984. ]
  2985. },
  2986. "style": {
  2987. "type": "string",
  2988. "enum": [
  2989. "NUMERIC"
  2990. ]
  2991. },
  2992. "title": {
  2993. "type": "string"
  2994. },
  2995. "items": {
  2996. "type": "array",
  2997. "items": {
  2998. "$ref": "#/components/schemas/ContentListItem"
  2999. }
  3000. }
  3001. },
  3002. "required": [
  3003. "type",
  3004. "style",
  3005. "items"
  3006. ]
  3007. },
  3008. "ContentListItem": {
  3009. "type": "object",
  3010. "properties": {
  3011. "text": {
  3012. "type": "string"
  3013. }
  3014. },
  3015. "required": [
  3016. "text"
  3017. ]
  3018. },
  3019. "Toast": {
  3020. "type": "object",
  3021. "properties": {
  3022. "style": {
  3023. "type": "string",
  3024. "enum": [
  3025. "SUCCESS",
  3026. "ERROR"
  3027. ]
  3028. },
  3029. "message": {
  3030. "type": "string"
  3031. }
  3032. },
  3033. "required": [
  3034. "style",
  3035. "message"
  3036. ]
  3037. },
  3038. "CommandRequest": {
  3039. "type": "object",
  3040. "properties": {
  3041. "refreshScreens": {
  3042. "$ref": "#/components/schemas/RefreshScreensTask"
  3043. },
  3044. "toast": {
  3045. "$ref": "#/components/schemas/Toast"
  3046. }
  3047. }
  3048. },
  3049. "ActivateVoucherRequest": {
  3050. "type": "object",
  3051. "properties": {
  3052. "refreshScreens": {
  3053. "$ref": "#/components/schemas/RefreshScreensTask"
  3054. },
  3055. "toast": {
  3056. "$ref": "#/components/schemas/Toast"
  3057. },
  3058. "voucherId": {
  3059. "type": "number"
  3060. },
  3061. "events": {
  3062. "type": "array",
  3063. "items": {
  3064. "$ref": "#/components/schemas/BFFEvent"
  3065. }
  3066. }
  3067. },
  3068. "required": [
  3069. "voucherId"
  3070. ]
  3071. },
  3072. "BasketCheckoutRequest": {
  3073. "type": "object",
  3074. "properties": {
  3075. "refreshScreens": {
  3076. "$ref": "#/components/schemas/RefreshScreensTask"
  3077. },
  3078. "toast": {
  3079. "$ref": "#/components/schemas/Toast"
  3080. },
  3081. "basketId": {
  3082. "type": "string"
  3083. },
  3084. "productIds": {
  3085. "type": "array",
  3086. "items": {
  3087. "type": "string"
  3088. }
  3089. }
  3090. },
  3091. "required": [
  3092. "basketId",
  3093. "productIds"
  3094. ]
  3095. },
  3096. "BasketCouponRequest": {
  3097. "type": "object",
  3098. "properties": {
  3099. "refreshScreens": {
  3100. "$ref": "#/components/schemas/RefreshScreensTask"
  3101. },
  3102. "toast": {
  3103. "$ref": "#/components/schemas/Toast"
  3104. },
  3105. "basketId": {
  3106. "type": "string"
  3107. },
  3108. "code": {
  3109. "type": "string"
  3110. },
  3111. "type": {
  3112. "type": "string",
  3113. "enum": [
  3114. "coupon",
  3115. "voucher"
  3116. ]
  3117. }
  3118. },
  3119. "required": [
  3120. "basketId",
  3121. "code",
  3122. "type"
  3123. ]
  3124. },
  3125. "LoyaltyDonatePointsRequest": {
  3126. "type": "object",
  3127. "properties": {
  3128. "refreshScreens": {
  3129. "$ref": "#/components/schemas/RefreshScreensTask"
  3130. },
  3131. "toast": {
  3132. "$ref": "#/components/schemas/Toast"
  3133. },
  3134. "charityId": {
  3135. "type": "string"
  3136. },
  3137. "charityName": {
  3138. "type": "string"
  3139. },
  3140. "amount": {
  3141. "oneOf": [
  3142. {
  3143. "type": "string"
  3144. },
  3145. {
  3146. "type": "number"
  3147. }
  3148. ]
  3149. }
  3150. },
  3151. "required": [
  3152. "charityId",
  3153. "charityName",
  3154. "amount"
  3155. ]
  3156. },
  3157. "DeactivateVoucherRequest": {
  3158. "type": "object",
  3159. "properties": {
  3160. "refreshScreens": {
  3161. "$ref": "#/components/schemas/RefreshScreensTask"
  3162. },
  3163. "toast": {
  3164. "$ref": "#/components/schemas/Toast"
  3165. },
  3166. "activatedVoucherId": {
  3167. "type": "string"
  3168. }
  3169. },
  3170. "required": [
  3171. "activatedVoucherId"
  3172. ]
  3173. },
  3174. "AddReceiptPointsRequest": {
  3175. "type": "object",
  3176. "properties": {
  3177. "receiptTransactionNumber": {
  3178. "type": "string"
  3179. }
  3180. },
  3181. "required": [
  3182. "receiptTransactionNumber"
  3183. ]
  3184. },
  3185. "AddPhysicalCardRequest": {
  3186. "type": "object",
  3187. "properties": {
  3188. "loyaltyCardToken": {
  3189. "type": "string"
  3190. }
  3191. },
  3192. "required": [
  3193. "loyaltyCardToken"
  3194. ]
  3195. },
  3196. "SettingsRequest": {
  3197. "type": "object",
  3198. "properties": {
  3199. "isOptInNewsletter": {
  3200. "type": "boolean"
  3201. },
  3202. "isOptInNewsletterLoyalty": {
  3203. "type": "boolean"
  3204. }
  3205. }
  3206. },
  3207. "Banner": {
  3208. "type": "object",
  3209. "properties": {
  3210. "id": {
  3211. "type": "string"
  3212. },
  3213. "type": {
  3214. "type": "string",
  3215. "enum": [
  3216. "SMALL",
  3217. "LARGE"
  3218. ]
  3219. },
  3220. "imageUrl": {
  3221. "type": "string"
  3222. },
  3223. "accessibilityTitle": {
  3224. "type": "string"
  3225. },
  3226. "action": {
  3227. "$ref": "#/components/schemas/Action"
  3228. }
  3229. },
  3230. "required": [
  3231. "id",
  3232. "type",
  3233. "imageUrl",
  3234. "accessibilityTitle"
  3235. ]
  3236. },
  3237. "HomeResponse": {
  3238. "type": "object",
  3239. "properties": {
  3240. "infoMessages": {
  3241. "type": "array",
  3242. "items": {
  3243. "$ref": "#/components/schemas/InfoMessageComponent"
  3244. }
  3245. },
  3246. "banners": {
  3247. "type": "array",
  3248. "items": {
  3249. "$ref": "#/components/schemas/Banner"
  3250. }
  3251. },
  3252. "recallButton": {
  3253. "$ref": "#/components/schemas/NormalButton"
  3254. }
  3255. },
  3256. "required": [
  3257. "infoMessages",
  3258. "banners"
  3259. ]
  3260. },
  3261. "Currency": {
  3262. "type": "string",
  3263. "enum": [
  3264. "EUR"
  3265. ]
  3266. },
  3267. "Prices": {
  3268. "type": "object",
  3269. "properties": {
  3270. "price": {
  3271. "$ref": "#/components/schemas/FormattedPrice"
  3272. },
  3273. "fromPrice": {
  3274. "$ref": "#/components/schemas/FormattedPrice"
  3275. },
  3276. "rangeDescriptor": {
  3277. "type": "string"
  3278. },
  3279. "alt": {
  3280. "type": "string"
  3281. }
  3282. },
  3283. "required": [
  3284. "price",
  3285. "alt"
  3286. ]
  3287. },
  3288. "FormattedPrice": {
  3289. "type": "object",
  3290. "properties": {
  3291. "currency": {
  3292. "$ref": "#/components/schemas/Currency"
  3293. },
  3294. "integerPart": {
  3295. "type": "string"
  3296. },
  3297. "fractionalPart": {
  3298. "type": "string"
  3299. },
  3300. "alt": {
  3301. "type": "string"
  3302. }
  3303. },
  3304. "required": [
  3305. "currency",
  3306. "integerPart",
  3307. "alt"
  3308. ]
  3309. },
  3310. "Filters": {
  3311. "type": "object",
  3312. "properties": {
  3313. "baseFilterUrl": {
  3314. "type": "string"
  3315. },
  3316. "baseSearchUrl": {
  3317. "type": "string"
  3318. },
  3319. "total": {
  3320. "type": "number"
  3321. },
  3322. "activeFilterCount": {
  3323. "type": "number"
  3324. },
  3325. "sections": {
  3326. "type": "array",
  3327. "items": {
  3328. "$ref": "#/components/schemas/FilterSection"
  3329. }
  3330. }
  3331. },
  3332. "required": [
  3333. "baseFilterUrl",
  3334. "baseSearchUrl",
  3335. "total",
  3336. "activeFilterCount",
  3337. "sections"
  3338. ]
  3339. },
  3340. "FilterSection": {
  3341. "type": "object",
  3342. "properties": {
  3343. "title": {
  3344. "type": "string"
  3345. },
  3346. "id": {
  3347. "type": "string"
  3348. },
  3349. "rows": {
  3350. "type": "array",
  3351. "items": {
  3352. "$ref": "#/components/schemas/Filter"
  3353. }
  3354. }
  3355. },
  3356. "required": [
  3357. "title",
  3358. "id",
  3359. "rows"
  3360. ]
  3361. },
  3362. "Filter": {
  3363. "oneOf": [
  3364. {
  3365. "$ref": "#/components/schemas/SelectionFilter"
  3366. },
  3367. {
  3368. "$ref": "#/components/schemas/PriceFilter"
  3369. },
  3370. {
  3371. "$ref": "#/components/schemas/ToggleFilter"
  3372. }
  3373. ]
  3374. },
  3375. "BaseFilter": {
  3376. "type": "object",
  3377. "properties": {
  3378. "id": {
  3379. "type": "string"
  3380. },
  3381. "title": {
  3382. "type": "string"
  3383. },
  3384. "showTitle": {
  3385. "type": "boolean"
  3386. }
  3387. },
  3388. "required": [
  3389. "id",
  3390. "title",
  3391. "showTitle"
  3392. ]
  3393. },
  3394. "SelectionFilter": {
  3395. "type": "object",
  3396. "properties": {
  3397. "id": {
  3398. "type": "string"
  3399. },
  3400. "title": {
  3401. "type": "string"
  3402. },
  3403. "showTitle": {
  3404. "type": "boolean"
  3405. },
  3406. "type": {
  3407. "type": "string",
  3408. "enum": [
  3409. "SELECTION"
  3410. ]
  3411. },
  3412. "selectionType": {
  3413. "type": "string",
  3414. "enum": [
  3415. "MULTIPLE",
  3416. "SINGLE"
  3417. ]
  3418. },
  3419. "options": {
  3420. "type": "array",
  3421. "items": {
  3422. "$ref": "#/components/schemas/SelectionFilterOption"
  3423. }
  3424. },
  3425. "values": {
  3426. "type": "array",
  3427. "items": {
  3428. "type": "string"
  3429. }
  3430. }
  3431. },
  3432. "required": [
  3433. "id",
  3434. "title",
  3435. "showTitle",
  3436. "type",
  3437. "selectionType",
  3438. "options",
  3439. "values"
  3440. ]
  3441. },
  3442. "SelectionFilterOption": {
  3443. "type": "object",
  3444. "properties": {
  3445. "id": {
  3446. "type": "string"
  3447. },
  3448. "label": {
  3449. "type": "string"
  3450. },
  3451. "value": {
  3452. "type": "string"
  3453. },
  3454. "hits": {
  3455. "type": "number"
  3456. },
  3457. "image": {
  3458. "$ref": "#/components/schemas/Image"
  3459. }
  3460. },
  3461. "required": [
  3462. "id",
  3463. "label",
  3464. "value"
  3465. ]
  3466. },
  3467. "PriceFilter": {
  3468. "type": "object",
  3469. "properties": {
  3470. "id": {
  3471. "type": "string"
  3472. },
  3473. "title": {
  3474. "type": "string"
  3475. },
  3476. "showTitle": {
  3477. "type": "boolean"
  3478. },
  3479. "type": {
  3480. "type": "string",
  3481. "enum": [
  3482. "PRICE"
  3483. ]
  3484. },
  3485. "min": {
  3486. "type": "number"
  3487. },
  3488. "max": {
  3489. "type": "number"
  3490. },
  3491. "stride": {
  3492. "type": "number"
  3493. },
  3494. "minSelected": {
  3495. "type": "number"
  3496. },
  3497. "maxSelected": {
  3498. "type": "number"
  3499. },
  3500. "currency": {
  3501. "$ref": "#/components/schemas/Currency"
  3502. }
  3503. },
  3504. "required": [
  3505. "id",
  3506. "title",
  3507. "showTitle",
  3508. "type",
  3509. "min",
  3510. "max",
  3511. "stride",
  3512. "currency"
  3513. ]
  3514. },
  3515. "ToggleFilter": {
  3516. "type": "object",
  3517. "properties": {
  3518. "id": {
  3519. "type": "string"
  3520. },
  3521. "title": {
  3522. "type": "string"
  3523. },
  3524. "showTitle": {
  3525. "type": "boolean"
  3526. },
  3527. "type": {
  3528. "type": "string",
  3529. "enum": [
  3530. "TOGGLE"
  3531. ]
  3532. },
  3533. "value": {
  3534. "type": "string"
  3535. },
  3536. "selectedValue": {
  3537. "type": "string"
  3538. }
  3539. },
  3540. "required": [
  3541. "id",
  3542. "title",
  3543. "showTitle",
  3544. "type",
  3545. "value"
  3546. ]
  3547. },
  3548. "AnalyticsFirebaseCustomEvent": {
  3549. "type": "object",
  3550. "properties": {
  3551. "type": {
  3552. "type": "string",
  3553. "enum": [
  3554. "FIREBASE_CUSTOM"
  3555. ]
  3556. },
  3557. "name": {
  3558. "type": "string"
  3559. },
  3560. "parameters": {
  3561. "$ref": "#/components/schemas/AnyPrimitives"
  3562. }
  3563. },
  3564. "required": [
  3565. "type",
  3566. "name",
  3567. "parameters"
  3568. ]
  3569. },
  3570. "AnalyticsFirebaseEcomEvent": {
  3571. "type": "object",
  3572. "properties": {
  3573. "type": {
  3574. "type": "string",
  3575. "enum": [
  3576. "FIREBASE_ECOM"
  3577. ]
  3578. },
  3579. "name": {
  3580. "type": "string",
  3581. "enum": [
  3582. "ADD_TO_CART",
  3583. "REMOVE_FROM_CART",
  3584. "VIEW_CART",
  3585. "BEGIN_CHECKOUT",
  3586. "PURCHASE",
  3587. "REFUND",
  3588. "VIEW_ITEM",
  3589. "SELECT_ITEM",
  3590. "VIEW_ITEM_LIST",
  3591. "ADD_TO_WISHLIST",
  3592. "ADD_PAYMENT_INFO",
  3593. "ADD_SHIPPING_INFO",
  3594. "SELECT_PROMOTION",
  3595. "VIEW_PROMOTION",
  3596. "SELECT_CONTENT",
  3597. "SHARE"
  3598. ]
  3599. },
  3600. "ecomData": {
  3601. "$ref": "#/components/schemas/FirebaseEcomEventData"
  3602. },
  3603. "customData": {
  3604. "$ref": "#/components/schemas/AnyPrimitives"
  3605. }
  3606. },
  3607. "required": [
  3608. "type",
  3609. "name",
  3610. "ecomData"
  3611. ]
  3612. },
  3613. "FirebaseEcomEventData": {
  3614. "type": "object",
  3615. "properties": {
  3616. "listId": {
  3617. "type": "string"
  3618. },
  3619. "listName": {
  3620. "type": "string"
  3621. },
  3622. "currency": {
  3623. "type": "string"
  3624. },
  3625. "value": {
  3626. "type": "string"
  3627. },
  3628. "coupon": {
  3629. "type": "string"
  3630. },
  3631. "shippingTier": {
  3632. "type": "string"
  3633. },
  3634. "paymentType": {
  3635. "type": "string"
  3636. },
  3637. "transactionId": {
  3638. "type": "string"
  3639. },
  3640. "affiliation": {
  3641. "type": "string"
  3642. },
  3643. "promotionID": {
  3644. "type": "string"
  3645. },
  3646. "promotionName": {
  3647. "type": "string"
  3648. },
  3649. "creativeName": {
  3650. "type": "string"
  3651. },
  3652. "creativeSlot": {
  3653. "type": "string"
  3654. },
  3655. "locationID": {
  3656. "type": "string"
  3657. },
  3658. "tax": {
  3659. "type": "number"
  3660. },
  3661. "shipping": {
  3662. "type": "number"
  3663. },
  3664. "contentType": {
  3665. "type": "string"
  3666. },
  3667. "method": {
  3668. "type": "string"
  3669. },
  3670. "itemId": {
  3671. "type": "string"
  3672. },
  3673. "searchTerm": {
  3674. "type": "string"
  3675. },
  3676. "discount": {
  3677. "type": "number"
  3678. },
  3679. "success": {
  3680. "type": "number"
  3681. },
  3682. "items": {
  3683. "type": "array",
  3684. "items": {
  3685. "$ref": "#/components/schemas/FirebaseEcomItem"
  3686. }
  3687. }
  3688. }
  3689. },
  3690. "FirebaseEcomItem": {
  3691. "type": "object",
  3692. "properties": {
  3693. "index": {
  3694. "type": "number"
  3695. },
  3696. "itemId": {
  3697. "type": "string"
  3698. },
  3699. "itemName": {
  3700. "type": "string"
  3701. },
  3702. "itemVariant": {
  3703. "type": "string"
  3704. },
  3705. "price": {
  3706. "type": "number"
  3707. },
  3708. "quantity": {
  3709. "type": "number"
  3710. },
  3711. "brand": {
  3712. "type": "string"
  3713. },
  3714. "itemCategory": {
  3715. "type": "string"
  3716. },
  3717. "itemCategory2": {
  3718. "type": "string"
  3719. },
  3720. "itemCategory3": {
  3721. "type": "string"
  3722. },
  3723. "itemCategory4": {
  3724. "type": "string"
  3725. },
  3726. "itemCategory5": {
  3727. "type": "string"
  3728. }
  3729. }
  3730. },
  3731. "AnyPrimitives": {
  3732. "additionalProperties": {
  3733. "anyOf": [
  3734. {
  3735. "type": "string"
  3736. },
  3737. {
  3738. "type": "number"
  3739. },
  3740. {
  3741. "type": "boolean"
  3742. }
  3743. ]
  3744. }
  3745. },
  3746. "AnalyticsEvent": {
  3747. "oneOf": [
  3748. {
  3749. "$ref": "#/components/schemas/AnalyticsFirebaseCustomEvent"
  3750. },
  3751. {
  3752. "$ref": "#/components/schemas/AnalyticsFirebaseEcomEvent"
  3753. }
  3754. ]
  3755. },
  3756. "BFFEvent": {
  3757. "oneOf": [
  3758. {
  3759. "$ref": "#/components/schemas/AnalyticsEvent"
  3760. },
  3761. {
  3762. "$ref": "#/components/schemas/AirshipEvent"
  3763. },
  3764. {
  3765. "$ref": "#/components/schemas/DataEvent"
  3766. },
  3767. {
  3768. "$ref": "#/components/schemas/AdjustEvent"
  3769. }
  3770. ]
  3771. },
  3772. "AirshipEvent": {
  3773. "type": "object",
  3774. "properties": {
  3775. "type": {
  3776. "type": "string",
  3777. "enum": [
  3778. "AIRSHIP_EVENT"
  3779. ]
  3780. },
  3781. "name": {
  3782. "type": "string"
  3783. },
  3784. "properties": {
  3785. "$ref": "#/components/schemas/AnyPrimitives"
  3786. }
  3787. },
  3788. "required": [
  3789. "type",
  3790. "name",
  3791. "properties"
  3792. ]
  3793. },
  3794. "AdjustEvent": {
  3795. "type": "object",
  3796. "properties": {
  3797. "type": {
  3798. "type": "string",
  3799. "enum": [
  3800. "ADJUST_EVENT"
  3801. ]
  3802. },
  3803. "token": {
  3804. "type": "string"
  3805. },
  3806. "callbackParameters": {
  3807. "type": "object",
  3808. "additionalProperties": false,
  3809. "x-patternProperties": {
  3810. ".*": {
  3811. "type": "string"
  3812. }
  3813. }
  3814. },
  3815. "partnerParameters": {
  3816. "type": "object",
  3817. "additionalProperties": false,
  3818. "x-patternProperties": {
  3819. ".*": {
  3820. "type": "string"
  3821. }
  3822. }
  3823. }
  3824. },
  3825. "required": [
  3826. "type",
  3827. "token",
  3828. "callbackParameters",
  3829. "partnerParameters"
  3830. ]
  3831. },
  3832. "DataEvent": {
  3833. "type": "object",
  3834. "properties": {
  3835. "type": {
  3836. "type": "string",
  3837. "enum": [
  3838. "DATA_EVENT"
  3839. ]
  3840. },
  3841. "payload": {
  3842. "$ref": "#/components/schemas/DataEventRequest"
  3843. }
  3844. },
  3845. "required": [
  3846. "type",
  3847. "payload"
  3848. ]
  3849. },
  3850. "FingerprintableData": {
  3851. "type": "object",
  3852. "properties": {
  3853. "fingerprint": {
  3854. "type": "string"
  3855. }
  3856. },
  3857. "required": [
  3858. "fingerprint"
  3859. ]
  3860. },
  3861. "AvailableRefreshIds": {
  3862. "type": "string",
  3863. "enum": [
  3864. "vouchers",
  3865. "basket",
  3866. "favorites"
  3867. ]
  3868. },
  3869. "RefreshIds": {
  3870. "type": "array",
  3871. "items": {
  3872. "oneOf": [
  3873. {
  3874. "$ref": "#/components/schemas/AvailableRefreshIds"
  3875. },
  3876. {
  3877. "type": "string"
  3878. }
  3879. ]
  3880. }
  3881. },
  3882. "ScreenBaseData": {
  3883. "type": "object",
  3884. "properties": {
  3885. "id": {
  3886. "type": "string"
  3887. },
  3888. "canRefresh": {
  3889. "type": "boolean"
  3890. },
  3891. "tags": {
  3892. "type": "array",
  3893. "items": {
  3894. "type": "string"
  3895. }
  3896. },
  3897. "refreshIds": {
  3898. "$ref": "#/components/schemas/RefreshIds"
  3899. },
  3900. "autoRefresh": {
  3901. "$ref": "#/components/schemas/AutoRefreshSettings"
  3902. },
  3903. "maximizeScreenBrightness": {
  3904. "type": "boolean"
  3905. },
  3906. "header": {
  3907. "$ref": "#/components/schemas/Header"
  3908. },
  3909. "onReadyEvents": {
  3910. "type": "array",
  3911. "items": {
  3912. "$ref": "#/components/schemas/BFFEvent"
  3913. }
  3914. },
  3915. "onAppearEvents": {
  3916. "type": "array",
  3917. "items": {
  3918. "$ref": "#/components/schemas/AnalyticsEvent"
  3919. }
  3920. },
  3921. "onFirstAppearActions": {
  3922. "type": "array",
  3923. "items": {
  3924. "$ref": "#/components/schemas/Action"
  3925. }
  3926. }
  3927. },
  3928. "required": [
  3929. "id",
  3930. "canRefresh",
  3931. "maximizeScreenBrightness"
  3932. ]
  3933. },
  3934. "Screen": {
  3935. "oneOf": [
  3936. {
  3937. "$ref": "#/components/schemas/ScreenWithContentList"
  3938. },
  3939. {
  3940. "$ref": "#/components/schemas/ScreenWithTabs"
  3941. }
  3942. ]
  3943. },
  3944. "ScreenWithContentList": {
  3945. "type": "object",
  3946. "properties": {
  3947. "id": {
  3948. "type": "string"
  3949. },
  3950. "canRefresh": {
  3951. "type": "boolean"
  3952. },
  3953. "tags": {
  3954. "type": "array",
  3955. "items": {
  3956. "type": "string"
  3957. }
  3958. },
  3959. "refreshIds": {
  3960. "$ref": "#/components/schemas/RefreshIds"
  3961. },
  3962. "autoRefresh": {
  3963. "$ref": "#/components/schemas/AutoRefreshSettings"
  3964. },
  3965. "maximizeScreenBrightness": {
  3966. "type": "boolean"
  3967. },
  3968. "header": {
  3969. "$ref": "#/components/schemas/Header"
  3970. },
  3971. "onReadyEvents": {
  3972. "type": "array",
  3973. "items": {
  3974. "$ref": "#/components/schemas/BFFEvent"
  3975. }
  3976. },
  3977. "onAppearEvents": {
  3978. "type": "array",
  3979. "items": {
  3980. "$ref": "#/components/schemas/AnalyticsEvent"
  3981. }
  3982. },
  3983. "onFirstAppearActions": {
  3984. "type": "array",
  3985. "items": {
  3986. "$ref": "#/components/schemas/Action"
  3987. }
  3988. },
  3989. "type": {
  3990. "type": "string",
  3991. "enum": [
  3992. "COMPONENT"
  3993. ]
  3994. },
  3995. "content": {
  3996. "$ref": "#/components/schemas/ContentSectionsList"
  3997. }
  3998. },
  3999. "required": [
  4000. "id",
  4001. "canRefresh",
  4002. "maximizeScreenBrightness",
  4003. "type",
  4004. "content"
  4005. ]
  4006. },
  4007. "ScreenWithTabs": {
  4008. "type": "object",
  4009. "properties": {
  4010. "id": {
  4011. "type": "string"
  4012. },
  4013. "canRefresh": {
  4014. "type": "boolean"
  4015. },
  4016. "tags": {
  4017. "type": "array",
  4018. "items": {
  4019. "type": "string"
  4020. }
  4021. },
  4022. "refreshIds": {
  4023. "$ref": "#/components/schemas/RefreshIds"
  4024. },
  4025. "autoRefresh": {
  4026. "$ref": "#/components/schemas/AutoRefreshSettings"
  4027. },
  4028. "maximizeScreenBrightness": {
  4029. "type": "boolean"
  4030. },
  4031. "header": {
  4032. "$ref": "#/components/schemas/TabsHeader"
  4033. },
  4034. "onReadyEvents": {
  4035. "type": "array",
  4036. "items": {
  4037. "$ref": "#/components/schemas/BFFEvent"
  4038. }
  4039. },
  4040. "onAppearEvents": {
  4041. "type": "array",
  4042. "items": {
  4043. "$ref": "#/components/schemas/AnalyticsEvent"
  4044. }
  4045. },
  4046. "onFirstAppearActions": {
  4047. "type": "array",
  4048. "items": {
  4049. "$ref": "#/components/schemas/Action"
  4050. }
  4051. },
  4052. "type": {
  4053. "type": "string",
  4054. "enum": [
  4055. "TABS"
  4056. ]
  4057. },
  4058. "tabs": {
  4059. "type": "array",
  4060. "items": {
  4061. "$ref": "#/components/schemas/ScreenTab"
  4062. }
  4063. },
  4064. "initialTabId": {
  4065. "type": "string"
  4066. }
  4067. },
  4068. "required": [
  4069. "id",
  4070. "canRefresh",
  4071. "maximizeScreenBrightness",
  4072. "type",
  4073. "header",
  4074. "tabs",
  4075. "initialTabId"
  4076. ]
  4077. },
  4078. "ScreenTab": {
  4079. "type": "object",
  4080. "properties": {
  4081. "tabId": {
  4082. "type": "string"
  4083. },
  4084. "content": {
  4085. "$ref": "#/components/schemas/ContentSectionsList"
  4086. }
  4087. },
  4088. "required": [
  4089. "tabId",
  4090. "content"
  4091. ]
  4092. },
  4093. "AutoRefreshSettings": {
  4094. "type": "object",
  4095. "properties": {
  4096. "interval": {
  4097. "type": "number"
  4098. }
  4099. },
  4100. "required": [
  4101. "interval"
  4102. ]
  4103. },
  4104. "ContentSectionsList": {
  4105. "type": "object",
  4106. "properties": {
  4107. "type": {
  4108. "type": "string",
  4109. "enum": [
  4110. "SECTIONS"
  4111. ]
  4112. },
  4113. "sections": {
  4114. "type": "array",
  4115. "items": {
  4116. "$ref": "#/components/schemas/Section"
  4117. }
  4118. }
  4119. },
  4120. "required": [
  4121. "type",
  4122. "sections"
  4123. ]
  4124. },
  4125. "Action": {
  4126. "oneOf": [
  4127. {
  4128. "$ref": "#/components/schemas/CommandAction"
  4129. },
  4130. {
  4131. "$ref": "#/components/schemas/CopyToClipboardAction"
  4132. },
  4133. {
  4134. "$ref": "#/components/schemas/DisableContentPreview"
  4135. },
  4136. {
  4137. "$ref": "#/components/schemas/FilterAction"
  4138. },
  4139. {
  4140. "$ref": "#/components/schemas/SignOutAction"
  4141. },
  4142. {
  4143. "$ref": "#/components/schemas/OfflineScreenAction"
  4144. },
  4145. {
  4146. "$ref": "#/components/schemas/OpenAddLoyaltyPointsAction"
  4147. },
  4148. {
  4149. "$ref": "#/components/schemas/OpenCustomerServiceChatAction"
  4150. },
  4151. {
  4152. "$ref": "#/components/schemas/OpenFeedbackFormAction"
  4153. },
  4154. {
  4155. "$ref": "#/components/schemas/OpenLoginAction"
  4156. },
  4157. {
  4158. "$ref": "#/components/schemas/OpenLoyaltyRegistrationAction"
  4159. },
  4160. {
  4161. "$ref": "#/components/schemas/OpenPhoneAction"
  4162. },
  4163. {
  4164. "$ref": "#/components/schemas/OpenProductScannerAction"
  4165. },
  4166. {
  4167. "$ref": "#/components/schemas/OpenLoyaltyCard"
  4168. },
  4169. {
  4170. "$ref": "#/components/schemas/OpenStorefrontSettingsAction"
  4171. },
  4172. {
  4173. "$ref": "#/components/schemas/OpenCookieSettingsAction"
  4174. },
  4175. {
  4176. "$ref": "#/components/schemas/OpenPushSettingsAction"
  4177. },
  4178. {
  4179. "$ref": "#/components/schemas/OpenNewsletterSettingsAction"
  4180. },
  4181. {
  4182. "$ref": "#/components/schemas/OpenReceiptScannerAction"
  4183. },
  4184. {
  4185. "$ref": "#/components/schemas/OpenAccountDetailsAction"
  4186. },
  4187. {
  4188. "$ref": "#/components/schemas/PromptAction"
  4189. },
  4190. {
  4191. "$ref": "#/components/schemas/ScreenAction"
  4192. },
  4193. {
  4194. "$ref": "#/components/schemas/ScreenDismissAction"
  4195. },
  4196. {
  4197. "$ref": "#/components/schemas/ScreenRefreshAction"
  4198. },
  4199. {
  4200. "$ref": "#/components/schemas/ScreenReplaceAction"
  4201. },
  4202. {
  4203. "$ref": "#/components/schemas/ScrollToContentAction"
  4204. },
  4205. {
  4206. "$ref": "#/components/schemas/ShareAction"
  4207. },
  4208. {
  4209. "$ref": "#/components/schemas/ShareTextAction"
  4210. },
  4211. {
  4212. "$ref": "#/components/schemas/WebBrowserAction"
  4213. }
  4214. ]
  4215. },
  4216. "CommandResponseAction": {
  4217. "oneOf": [
  4218. {
  4219. "$ref": "#/components/schemas/CopyToClipboardAction"
  4220. },
  4221. {
  4222. "$ref": "#/components/schemas/DisableContentPreview"
  4223. },
  4224. {
  4225. "$ref": "#/components/schemas/FilterAction"
  4226. },
  4227. {
  4228. "$ref": "#/components/schemas/SignOutAction"
  4229. },
  4230. {
  4231. "$ref": "#/components/schemas/OfflineScreenAction"
  4232. },
  4233. {
  4234. "$ref": "#/components/schemas/OpenAddLoyaltyPointsAction"
  4235. },
  4236. {
  4237. "$ref": "#/components/schemas/OpenCustomerServiceChatAction"
  4238. },
  4239. {
  4240. "$ref": "#/components/schemas/OpenFeedbackFormAction"
  4241. },
  4242. {
  4243. "$ref": "#/components/schemas/OpenLoginAction"
  4244. },
  4245. {
  4246. "$ref": "#/components/schemas/OpenLoyaltyRegistrationAction"
  4247. },
  4248. {
  4249. "$ref": "#/components/schemas/OpenPhoneAction"
  4250. },
  4251. {
  4252. "$ref": "#/components/schemas/OpenProductScannerAction"
  4253. },
  4254. {
  4255. "$ref": "#/components/schemas/OpenLoyaltyCard"
  4256. },
  4257. {
  4258. "$ref": "#/components/schemas/OpenStorefrontSettingsAction"
  4259. },
  4260. {
  4261. "$ref": "#/components/schemas/OpenCookieSettingsAction"
  4262. },
  4263. {
  4264. "$ref": "#/components/schemas/OpenPushSettingsAction"
  4265. },
  4266. {
  4267. "$ref": "#/components/schemas/OpenNewsletterSettingsAction"
  4268. },
  4269. {
  4270. "$ref": "#/components/schemas/OpenReceiptScannerAction"
  4271. },
  4272. {
  4273. "$ref": "#/components/schemas/OpenAccountDetailsAction"
  4274. },
  4275. {
  4276. "$ref": "#/components/schemas/PromptAction"
  4277. },
  4278. {
  4279. "$ref": "#/components/schemas/ScreenAction"
  4280. },
  4281. {
  4282. "$ref": "#/components/schemas/ScreenDismissAction"
  4283. },
  4284. {
  4285. "$ref": "#/components/schemas/ScreenRefreshAction"
  4286. },
  4287. {
  4288. "$ref": "#/components/schemas/ScreenReplaceAction"
  4289. },
  4290. {
  4291. "$ref": "#/components/schemas/ScrollToContentAction"
  4292. },
  4293. {
  4294. "$ref": "#/components/schemas/ShareAction"
  4295. },
  4296. {
  4297. "$ref": "#/components/schemas/ShareTextAction"
  4298. },
  4299. {
  4300. "$ref": "#/components/schemas/WebBrowserAction"
  4301. }
  4302. ]
  4303. },
  4304. "ActionBase": {
  4305. "type": "object",
  4306. "properties": {
  4307. "accessibilityDescription": {
  4308. "type": "string"
  4309. }
  4310. }
  4311. },
  4312. "TerminalActionBase": {
  4313. "type": "object",
  4314. "properties": {
  4315. "accessibilityDescription": {
  4316. "type": "string"
  4317. },
  4318. "onSuccessEvents": {
  4319. "type": "array",
  4320. "items": {
  4321. "$ref": "#/components/schemas/BFFEvent"
  4322. }
  4323. }
  4324. }
  4325. },
  4326. "ScreenRefreshAction": {
  4327. "type": "object",
  4328. "properties": {
  4329. "accessibilityDescription": {
  4330. "type": "string"
  4331. },
  4332. "onSuccessEvents": {
  4333. "type": "array",
  4334. "items": {
  4335. "$ref": "#/components/schemas/BFFEvent"
  4336. }
  4337. },
  4338. "type": {
  4339. "type": "string",
  4340. "enum": [
  4341. "SCREEN_REFRESH"
  4342. ]
  4343. },
  4344. "refreshIds": {
  4345. "$ref": "#/components/schemas/RefreshIds"
  4346. }
  4347. },
  4348. "required": [
  4349. "type",
  4350. "refreshIds"
  4351. ]
  4352. },
  4353. "ScreenDismissAction": {
  4354. "type": "object",
  4355. "properties": {
  4356. "accessibilityDescription": {
  4357. "type": "string"
  4358. },
  4359. "onSuccessEvents": {
  4360. "type": "array",
  4361. "items": {
  4362. "$ref": "#/components/schemas/BFFEvent"
  4363. }
  4364. },
  4365. "type": {
  4366. "type": "string",
  4367. "enum": [
  4368. "SCREEN_DISMISS"
  4369. ]
  4370. }
  4371. },
  4372. "required": [
  4373. "type"
  4374. ]
  4375. },
  4376. "ScreenQueryParameterPlaceholder": {
  4377. "type": "string",
  4378. "enum": [
  4379. "PROFILE_FAVORITE_STORE_ID",
  4380. "PROFILE_LAST_SELECTED_STORE_ID"
  4381. ]
  4382. },
  4383. "ScreenActionBase": {
  4384. "type": "object",
  4385. "properties": {
  4386. "accessibilityDescription": {
  4387. "type": "string"
  4388. },
  4389. "onSuccessEvents": {
  4390. "type": "array",
  4391. "items": {
  4392. "$ref": "#/components/schemas/BFFEvent"
  4393. }
  4394. },
  4395. "presentationStyle": {
  4396. "$ref": "#/components/schemas/ScreenPresentationStyle"
  4397. }
  4398. },
  4399. "required": [
  4400. "presentationStyle"
  4401. ]
  4402. },
  4403. "ScreenPresentationStyle": {
  4404. "type": "string",
  4405. "enum": [
  4406. "DETAIL",
  4407. "MODAL",
  4408. "SHEET"
  4409. ]
  4410. },
  4411. "ScreenAction": {
  4412. "type": "object",
  4413. "properties": {
  4414. "accessibilityDescription": {
  4415. "type": "string"
  4416. },
  4417. "onSuccessEvents": {
  4418. "type": "array",
  4419. "items": {
  4420. "$ref": "#/components/schemas/BFFEvent"
  4421. }
  4422. },
  4423. "presentationStyle": {
  4424. "$ref": "#/components/schemas/ScreenPresentationStyle"
  4425. },
  4426. "type": {
  4427. "type": "string",
  4428. "enum": [
  4429. "SCREEN"
  4430. ]
  4431. },
  4432. "url": {
  4433. "type": "string"
  4434. },
  4435. "placeholderContent": {
  4436. "$ref": "#/components/schemas/Screen"
  4437. },
  4438. "queryParameterResolvers": {
  4439. "type": "array",
  4440. "items": {
  4441. "$ref": "#/components/schemas/ScreenQueryParameterPlaceholder"
  4442. }
  4443. }
  4444. },
  4445. "required": [
  4446. "presentationStyle",
  4447. "type",
  4448. "url"
  4449. ]
  4450. },
  4451. "OfflineScreenAction": {
  4452. "type": "object",
  4453. "properties": {
  4454. "accessibilityDescription": {
  4455. "type": "string"
  4456. },
  4457. "onSuccessEvents": {
  4458. "type": "array",
  4459. "items": {
  4460. "$ref": "#/components/schemas/BFFEvent"
  4461. }
  4462. },
  4463. "presentationStyle": {
  4464. "$ref": "#/components/schemas/ScreenPresentationStyle"
  4465. },
  4466. "type": {
  4467. "type": "string",
  4468. "enum": [
  4469. "OFFLINE_SCREEN"
  4470. ]
  4471. },
  4472. "content": {
  4473. "$ref": "#/components/schemas/Screen"
  4474. }
  4475. },
  4476. "required": [
  4477. "presentationStyle",
  4478. "type",
  4479. "content"
  4480. ]
  4481. },
  4482. "OpenSearchAction": {
  4483. "type": "object",
  4484. "properties": {
  4485. "accessibilityDescription": {
  4486. "type": "string"
  4487. },
  4488. "onSuccessEvents": {
  4489. "type": "array",
  4490. "items": {
  4491. "$ref": "#/components/schemas/BFFEvent"
  4492. }
  4493. },
  4494. "presentationStyle": {
  4495. "$ref": "#/components/schemas/ScreenPresentationStyle"
  4496. },
  4497. "type": {
  4498. "type": "string",
  4499. "enum": [
  4500. "OPEN_SEARCH"
  4501. ]
  4502. },
  4503. "content": {
  4504. "$ref": "#/components/schemas/Screen"
  4505. }
  4506. },
  4507. "required": [
  4508. "presentationStyle",
  4509. "type",
  4510. "content"
  4511. ]
  4512. },
  4513. "WebBrowserDisplayType": {
  4514. "type": "string",
  4515. "enum": [
  4516. "EXTERNAL_BROWSER",
  4517. "IN_APP"
  4518. ]
  4519. },
  4520. "WebBrowserAction": {
  4521. "type": "object",
  4522. "properties": {
  4523. "accessibilityDescription": {
  4524. "type": "string"
  4525. },
  4526. "onSuccessEvents": {
  4527. "type": "array",
  4528. "items": {
  4529. "$ref": "#/components/schemas/BFFEvent"
  4530. }
  4531. },
  4532. "type": {
  4533. "type": "string",
  4534. "enum": [
  4535. "WEB_BROWSER"
  4536. ]
  4537. },
  4538. "displayType": {
  4539. "$ref": "#/components/schemas/WebBrowserDisplayType"
  4540. },
  4541. "url": {
  4542. "type": "string"
  4543. },
  4544. "supportTokenAuthentication": {
  4545. "type": "boolean"
  4546. },
  4547. "requiresSessionBridge": {
  4548. "type": "boolean"
  4549. },
  4550. "requiresLogin": {
  4551. "$ref": "#/components/schemas/RequiresLoginData"
  4552. }
  4553. },
  4554. "required": [
  4555. "type",
  4556. "displayType",
  4557. "url"
  4558. ]
  4559. },
  4560. "DisableContentPreview": {
  4561. "type": "object",
  4562. "properties": {
  4563. "accessibilityDescription": {
  4564. "type": "string"
  4565. },
  4566. "onSuccessEvents": {
  4567. "type": "array",
  4568. "items": {
  4569. "$ref": "#/components/schemas/BFFEvent"
  4570. }
  4571. },
  4572. "type": {
  4573. "type": "string",
  4574. "enum": [
  4575. "DISABLE_CONTENT_PREVIEW"
  4576. ]
  4577. }
  4578. },
  4579. "required": [
  4580. "type"
  4581. ]
  4582. },
  4583. "CommandAction": {
  4584. "oneOf": [
  4585. {
  4586. "$ref": "#/components/schemas/StandardCommandAction"
  4587. },
  4588. {
  4589. "$ref": "#/components/schemas/AddToFavoritesCommandAction"
  4590. },
  4591. {
  4592. "$ref": "#/components/schemas/RemoveFromFavoritesCommandAction"
  4593. },
  4594. {
  4595. "$ref": "#/components/schemas/SetBasketItemCommandAction"
  4596. },
  4597. {
  4598. "$ref": "#/components/schemas/ApplyCouponCommandAction"
  4599. },
  4600. {
  4601. "$ref": "#/components/schemas/DonateLoyaltyPointsCommandAction"
  4602. }
  4603. ]
  4604. },
  4605. "CommandActionSubtype": {
  4606. "type": "string",
  4607. "enum": [
  4608. "SET_BASKET_ITEM",
  4609. "ADD_TO_FAVORITES",
  4610. "REMOVE_FROM_FAVORITES",
  4611. "APPLY_COUPON",
  4612. "DONATE_LOYALTY_POINTS",
  4613. "STANDARD"
  4614. ]
  4615. },
  4616. "TransientStateType": {
  4617. "type": "string",
  4618. "enum": [
  4619. "INVALIDATED",
  4620. "LOADING",
  4621. "TAKKIELOADING"
  4622. ]
  4623. },
  4624. "TransientState": {
  4625. "type": "object",
  4626. "properties": {
  4627. "type": {
  4628. "$ref": "#/components/schemas/TransientStateType"
  4629. },
  4630. "tags": {
  4631. "type": "array",
  4632. "items": {
  4633. "type": "string"
  4634. }
  4635. }
  4636. },
  4637. "required": [
  4638. "type",
  4639. "tags"
  4640. ]
  4641. },
  4642. "CommandActionBase": {
  4643. "type": "object",
  4644. "properties": {
  4645. "accessibilityDescription": {
  4646. "type": "string"
  4647. },
  4648. "type": {
  4649. "type": "string",
  4650. "enum": [
  4651. "COMMAND"
  4652. ]
  4653. },
  4654. "subtype": {
  4655. "$ref": "#/components/schemas/CommandActionSubtype"
  4656. },
  4657. "url": {
  4658. "type": "string"
  4659. },
  4660. "payload": {
  4661. "type": "string"
  4662. },
  4663. "requiresLogin": {
  4664. "$ref": "#/components/schemas/RequiresLoginData"
  4665. },
  4666. "loadingId": {
  4667. "type": "string"
  4668. },
  4669. "transientStates": {
  4670. "type": "array",
  4671. "items": {
  4672. "$ref": "#/components/schemas/TransientState"
  4673. }
  4674. }
  4675. },
  4676. "required": [
  4677. "type",
  4678. "subtype",
  4679. "url",
  4680. "loadingId",
  4681. "transientStates"
  4682. ]
  4683. },
  4684. "StandardCommandAction": {
  4685. "type": "object",
  4686. "properties": {
  4687. "accessibilityDescription": {
  4688. "type": "string"
  4689. },
  4690. "type": {
  4691. "type": "string",
  4692. "enum": [
  4693. "COMMAND"
  4694. ]
  4695. },
  4696. "subtype": {
  4697. "type": "string",
  4698. "enum": [
  4699. "STANDARD"
  4700. ]
  4701. },
  4702. "url": {
  4703. "type": "string"
  4704. },
  4705. "payload": {
  4706. "type": "string"
  4707. },
  4708. "requiresLogin": {
  4709. "$ref": "#/components/schemas/RequiresLoginData"
  4710. },
  4711. "loadingId": {
  4712. "type": "string"
  4713. },
  4714. "transientStates": {
  4715. "type": "array",
  4716. "items": {
  4717. "$ref": "#/components/schemas/TransientState"
  4718. }
  4719. }
  4720. },
  4721. "required": [
  4722. "type",
  4723. "subtype",
  4724. "url",
  4725. "loadingId",
  4726. "transientStates"
  4727. ]
  4728. },
  4729. "AddToFavoritesCommandAction": {
  4730. "type": "object",
  4731. "properties": {
  4732. "accessibilityDescription": {
  4733. "type": "string"
  4734. },
  4735. "type": {
  4736. "type": "string",
  4737. "enum": [
  4738. "COMMAND"
  4739. ]
  4740. },
  4741. "subtype": {
  4742. "type": "string",
  4743. "enum": [
  4744. "ADD_TO_FAVORITES"
  4745. ]
  4746. },
  4747. "url": {
  4748. "type": "string"
  4749. },
  4750. "payload": {
  4751. "type": "string"
  4752. },
  4753. "requiresLogin": {
  4754. "$ref": "#/components/schemas/RequiresLoginData"
  4755. },
  4756. "loadingId": {
  4757. "type": "string"
  4758. },
  4759. "transientStates": {
  4760. "type": "array",
  4761. "items": {
  4762. "$ref": "#/components/schemas/TransientState"
  4763. }
  4764. },
  4765. "productId": {
  4766. "type": "string"
  4767. }
  4768. },
  4769. "required": [
  4770. "type",
  4771. "subtype",
  4772. "url",
  4773. "loadingId",
  4774. "transientStates",
  4775. "productId"
  4776. ]
  4777. },
  4778. "RemoveFromFavoritesCommandAction": {
  4779. "type": "object",
  4780. "properties": {
  4781. "accessibilityDescription": {
  4782. "type": "string"
  4783. },
  4784. "type": {
  4785. "type": "string",
  4786. "enum": [
  4787. "COMMAND"
  4788. ]
  4789. },
  4790. "subtype": {
  4791. "type": "string",
  4792. "enum": [
  4793. "REMOVE_FROM_FAVORITES"
  4794. ]
  4795. },
  4796. "url": {
  4797. "type": "string"
  4798. },
  4799. "payload": {
  4800. "type": "string"
  4801. },
  4802. "requiresLogin": {
  4803. "$ref": "#/components/schemas/RequiresLoginData"
  4804. },
  4805. "loadingId": {
  4806. "type": "string"
  4807. },
  4808. "transientStates": {
  4809. "type": "array",
  4810. "items": {
  4811. "$ref": "#/components/schemas/TransientState"
  4812. }
  4813. },
  4814. "productId": {
  4815. "type": "string"
  4816. }
  4817. },
  4818. "required": [
  4819. "type",
  4820. "subtype",
  4821. "url",
  4822. "loadingId",
  4823. "transientStates",
  4824. "productId"
  4825. ]
  4826. },
  4827. "SetBasketItemCommandAction": {
  4828. "type": "object",
  4829. "properties": {
  4830. "accessibilityDescription": {
  4831. "type": "string"
  4832. },
  4833. "type": {
  4834. "type": "string",
  4835. "enum": [
  4836. "COMMAND"
  4837. ]
  4838. },
  4839. "subtype": {
  4840. "type": "string",
  4841. "enum": [
  4842. "SET_BASKET_ITEM"
  4843. ]
  4844. },
  4845. "url": {
  4846. "type": "string"
  4847. },
  4848. "payload": {
  4849. "type": "string"
  4850. },
  4851. "requiresLogin": {
  4852. "$ref": "#/components/schemas/RequiresLoginData"
  4853. },
  4854. "loadingId": {
  4855. "type": "string"
  4856. },
  4857. "transientStates": {
  4858. "type": "array",
  4859. "items": {
  4860. "$ref": "#/components/schemas/TransientState"
  4861. }
  4862. },
  4863. "productId": {
  4864. "type": "string"
  4865. },
  4866. "amount": {
  4867. "type": "number"
  4868. }
  4869. },
  4870. "required": [
  4871. "type",
  4872. "subtype",
  4873. "url",
  4874. "loadingId",
  4875. "transientStates",
  4876. "productId"
  4877. ]
  4878. },
  4879. "ApplyCouponCommandAction": {
  4880. "type": "object",
  4881. "properties": {
  4882. "accessibilityDescription": {
  4883. "type": "string"
  4884. },
  4885. "type": {
  4886. "type": "string",
  4887. "enum": [
  4888. "COMMAND"
  4889. ]
  4890. },
  4891. "subtype": {
  4892. "type": "string",
  4893. "enum": [
  4894. "APPLY_COUPON"
  4895. ]
  4896. },
  4897. "url": {
  4898. "type": "string"
  4899. },
  4900. "payload": {
  4901. "type": "string"
  4902. },
  4903. "requiresLogin": {
  4904. "$ref": "#/components/schemas/RequiresLoginData"
  4905. },
  4906. "loadingId": {
  4907. "type": "string"
  4908. },
  4909. "transientStates": {
  4910. "type": "array",
  4911. "items": {
  4912. "$ref": "#/components/schemas/TransientState"
  4913. }
  4914. }
  4915. },
  4916. "required": [
  4917. "type",
  4918. "subtype",
  4919. "url",
  4920. "loadingId",
  4921. "transientStates"
  4922. ]
  4923. },
  4924. "DonateLoyaltyPointsCommandAction": {
  4925. "type": "object",
  4926. "properties": {
  4927. "accessibilityDescription": {
  4928. "type": "string"
  4929. },
  4930. "type": {
  4931. "type": "string",
  4932. "enum": [
  4933. "COMMAND"
  4934. ]
  4935. },
  4936. "subtype": {
  4937. "type": "string",
  4938. "enum": [
  4939. "DONATE_LOYALTY_POINTS"
  4940. ]
  4941. },
  4942. "url": {
  4943. "type": "string"
  4944. },
  4945. "payload": {
  4946. "type": "string"
  4947. },
  4948. "requiresLogin": {
  4949. "$ref": "#/components/schemas/RequiresLoginData"
  4950. },
  4951. "loadingId": {
  4952. "type": "string"
  4953. },
  4954. "transientStates": {
  4955. "type": "array",
  4956. "items": {
  4957. "$ref": "#/components/schemas/TransientState"
  4958. }
  4959. }
  4960. },
  4961. "required": [
  4962. "type",
  4963. "subtype",
  4964. "url",
  4965. "loadingId",
  4966. "transientStates"
  4967. ]
  4968. },
  4969. "RequiresLoginData": {
  4970. "type": "object",
  4971. "properties": {
  4972. "title": {
  4973. "type": "string"
  4974. },
  4975. "text": {
  4976. "type": "string"
  4977. },
  4978. "image": {
  4979. "$ref": "#/components/schemas/LocalImage"
  4980. },
  4981. "runAfterLogin": {
  4982. "type": "boolean"
  4983. }
  4984. },
  4985. "required": [
  4986. "title",
  4987. "text",
  4988. "runAfterLogin"
  4989. ]
  4990. },
  4991. "ScreenReplaceAction": {
  4992. "type": "object",
  4993. "properties": {
  4994. "accessibilityDescription": {
  4995. "type": "string"
  4996. },
  4997. "onSuccessEvents": {
  4998. "type": "array",
  4999. "items": {
  5000. "$ref": "#/components/schemas/BFFEvent"
  5001. }
  5002. },
  5003. "type": {
  5004. "type": "string",
  5005. "enum": [
  5006. "REPLACE"
  5007. ]
  5008. },
  5009. "url": {
  5010. "type": "string"
  5011. },
  5012. "queryParameterResolvers": {
  5013. "type": "array",
  5014. "items": {
  5015. "$ref": "#/components/schemas/ScreenQueryParameterPlaceholder"
  5016. }
  5017. }
  5018. },
  5019. "required": [
  5020. "type",
  5021. "url"
  5022. ]
  5023. },
  5024. "PromptAction": {
  5025. "type": "object",
  5026. "properties": {
  5027. "accessibilityDescription": {
  5028. "type": "string"
  5029. },
  5030. "onSuccessEvents": {
  5031. "type": "array",
  5032. "items": {
  5033. "$ref": "#/components/schemas/BFFEvent"
  5034. }
  5035. },
  5036. "type": {
  5037. "type": "string",
  5038. "enum": [
  5039. "PROMPT"
  5040. ]
  5041. },
  5042. "prompt": {
  5043. "$ref": "#/components/schemas/Prompt"
  5044. }
  5045. },
  5046. "required": [
  5047. "type",
  5048. "prompt"
  5049. ]
  5050. },
  5051. "FilterAction": {
  5052. "type": "object",
  5053. "properties": {
  5054. "accessibilityDescription": {
  5055. "type": "string"
  5056. },
  5057. "onSuccessEvents": {
  5058. "type": "array",
  5059. "items": {
  5060. "$ref": "#/components/schemas/BFFEvent"
  5061. }
  5062. },
  5063. "type": {
  5064. "type": "string",
  5065. "enum": [
  5066. "FILTER"
  5067. ]
  5068. },
  5069. "filters": {
  5070. "$ref": "#/components/schemas/Filters"
  5071. }
  5072. },
  5073. "required": [
  5074. "type",
  5075. "filters"
  5076. ]
  5077. },
  5078. "SignOutAction": {
  5079. "type": "object",
  5080. "properties": {
  5081. "accessibilityDescription": {
  5082. "type": "string"
  5083. },
  5084. "onSuccessEvents": {
  5085. "type": "array",
  5086. "items": {
  5087. "$ref": "#/components/schemas/BFFEvent"
  5088. }
  5089. },
  5090. "type": {
  5091. "type": "string",
  5092. "enum": [
  5093. "SIGN_OUT"
  5094. ]
  5095. }
  5096. },
  5097. "required": [
  5098. "type"
  5099. ]
  5100. },
  5101. "ShareAction": {
  5102. "type": "object",
  5103. "properties": {
  5104. "accessibilityDescription": {
  5105. "type": "string"
  5106. },
  5107. "onSuccessEvents": {
  5108. "type": "array",
  5109. "items": {
  5110. "$ref": "#/components/schemas/BFFEvent"
  5111. }
  5112. },
  5113. "type": {
  5114. "type": "string",
  5115. "enum": [
  5116. "SHARE"
  5117. ]
  5118. },
  5119. "url": {
  5120. "type": "string"
  5121. }
  5122. },
  5123. "required": [
  5124. "type",
  5125. "url"
  5126. ]
  5127. },
  5128. "ShareTextAction": {
  5129. "type": "object",
  5130. "properties": {
  5131. "accessibilityDescription": {
  5132. "type": "string"
  5133. },
  5134. "onSuccessEvents": {
  5135. "type": "array",
  5136. "items": {
  5137. "$ref": "#/components/schemas/BFFEvent"
  5138. }
  5139. },
  5140. "type": {
  5141. "type": "string",
  5142. "enum": [
  5143. "SHARE_TEXT"
  5144. ]
  5145. },
  5146. "text": {
  5147. "type": "string"
  5148. }
  5149. },
  5150. "required": [
  5151. "type",
  5152. "text"
  5153. ]
  5154. },
  5155. "OpenFeedbackFormAction": {
  5156. "type": "object",
  5157. "properties": {
  5158. "accessibilityDescription": {
  5159. "type": "string"
  5160. },
  5161. "onSuccessEvents": {
  5162. "type": "array",
  5163. "items": {
  5164. "$ref": "#/components/schemas/BFFEvent"
  5165. }
  5166. },
  5167. "type": {
  5168. "type": "string",
  5169. "enum": [
  5170. "OPEN_FEEDBACK_FORM"
  5171. ]
  5172. }
  5173. },
  5174. "required": [
  5175. "type"
  5176. ]
  5177. },
  5178. "OpenStorefrontSettingsAction": {
  5179. "type": "object",
  5180. "properties": {
  5181. "accessibilityDescription": {
  5182. "type": "string"
  5183. },
  5184. "onSuccessEvents": {
  5185. "type": "array",
  5186. "items": {
  5187. "$ref": "#/components/schemas/BFFEvent"
  5188. }
  5189. },
  5190. "type": {
  5191. "type": "string",
  5192. "enum": [
  5193. "OPEN_STOREFRONT_SETTINGS"
  5194. ]
  5195. }
  5196. },
  5197. "required": [
  5198. "type"
  5199. ]
  5200. },
  5201. "OpenCookieSettingsAction": {
  5202. "type": "object",
  5203. "properties": {
  5204. "accessibilityDescription": {
  5205. "type": "string"
  5206. },
  5207. "onSuccessEvents": {
  5208. "type": "array",
  5209. "items": {
  5210. "$ref": "#/components/schemas/BFFEvent"
  5211. }
  5212. },
  5213. "type": {
  5214. "type": "string",
  5215. "enum": [
  5216. "OPEN_COOKIE_SETTINGS"
  5217. ]
  5218. }
  5219. },
  5220. "required": [
  5221. "type"
  5222. ]
  5223. },
  5224. "OpenPushSettingsAction": {
  5225. "type": "object",
  5226. "properties": {
  5227. "accessibilityDescription": {
  5228. "type": "string"
  5229. },
  5230. "onSuccessEvents": {
  5231. "type": "array",
  5232. "items": {
  5233. "$ref": "#/components/schemas/BFFEvent"
  5234. }
  5235. },
  5236. "type": {
  5237. "type": "string",
  5238. "enum": [
  5239. "OPEN_PUSH_SETTINGS"
  5240. ]
  5241. }
  5242. },
  5243. "required": [
  5244. "type"
  5245. ]
  5246. },
  5247. "OpenNewsletterSettingsAction": {
  5248. "type": "object",
  5249. "properties": {
  5250. "accessibilityDescription": {
  5251. "type": "string"
  5252. },
  5253. "onSuccessEvents": {
  5254. "type": "array",
  5255. "items": {
  5256. "$ref": "#/components/schemas/BFFEvent"
  5257. }
  5258. },
  5259. "type": {
  5260. "type": "string",
  5261. "enum": [
  5262. "OPEN_NEWSLETTER_SETTINGS"
  5263. ]
  5264. }
  5265. },
  5266. "required": [
  5267. "type"
  5268. ]
  5269. },
  5270. "OpenReceiptScannerAction": {
  5271. "type": "object",
  5272. "properties": {
  5273. "accessibilityDescription": {
  5274. "type": "string"
  5275. },
  5276. "onSuccessEvents": {
  5277. "type": "array",
  5278. "items": {
  5279. "$ref": "#/components/schemas/BFFEvent"
  5280. }
  5281. },
  5282. "type": {
  5283. "type": "string",
  5284. "enum": [
  5285. "OPEN_RECEIPT_SCANNER"
  5286. ]
  5287. }
  5288. },
  5289. "required": [
  5290. "type"
  5291. ]
  5292. },
  5293. "OpenAccountDetailsAction": {
  5294. "type": "object",
  5295. "properties": {
  5296. "accessibilityDescription": {
  5297. "type": "string"
  5298. },
  5299. "onSuccessEvents": {
  5300. "type": "array",
  5301. "items": {
  5302. "$ref": "#/components/schemas/BFFEvent"
  5303. }
  5304. },
  5305. "type": {
  5306. "type": "string",
  5307. "enum": [
  5308. "OPEN_ACCOUNT_DETAILS"
  5309. ]
  5310. }
  5311. },
  5312. "required": [
  5313. "type"
  5314. ]
  5315. },
  5316. "OpenPhoneAction": {
  5317. "type": "object",
  5318. "properties": {
  5319. "accessibilityDescription": {
  5320. "type": "string"
  5321. },
  5322. "onSuccessEvents": {
  5323. "type": "array",
  5324. "items": {
  5325. "$ref": "#/components/schemas/BFFEvent"
  5326. }
  5327. },
  5328. "type": {
  5329. "type": "string",
  5330. "enum": [
  5331. "OPEN_PHONE"
  5332. ]
  5333. },
  5334. "phoneNumber": {
  5335. "type": "string"
  5336. }
  5337. },
  5338. "required": [
  5339. "type",
  5340. "phoneNumber"
  5341. ]
  5342. },
  5343. "OpenProductScannerAction": {
  5344. "type": "object",
  5345. "properties": {
  5346. "accessibilityDescription": {
  5347. "type": "string"
  5348. },
  5349. "onSuccessEvents": {
  5350. "type": "array",
  5351. "items": {
  5352. "$ref": "#/components/schemas/BFFEvent"
  5353. }
  5354. },
  5355. "type": {
  5356. "type": "string",
  5357. "enum": [
  5358. "OPEN_PRODUCT_SCANNER"
  5359. ]
  5360. }
  5361. },
  5362. "required": [
  5363. "type"
  5364. ]
  5365. },
  5366. "OpenLoyaltyCard": {
  5367. "type": "object",
  5368. "properties": {
  5369. "accessibilityDescription": {
  5370. "type": "string"
  5371. },
  5372. "onSuccessEvents": {
  5373. "type": "array",
  5374. "items": {
  5375. "$ref": "#/components/schemas/BFFEvent"
  5376. }
  5377. },
  5378. "type": {
  5379. "type": "string",
  5380. "enum": [
  5381. "OPEN_LOYALTY_CARD"
  5382. ]
  5383. }
  5384. },
  5385. "required": [
  5386. "type"
  5387. ]
  5388. },
  5389. "OpenCustomerServiceChatAction": {
  5390. "type": "object",
  5391. "properties": {
  5392. "accessibilityDescription": {
  5393. "type": "string"
  5394. },
  5395. "onSuccessEvents": {
  5396. "type": "array",
  5397. "items": {
  5398. "$ref": "#/components/schemas/BFFEvent"
  5399. }
  5400. },
  5401. "type": {
  5402. "type": "string",
  5403. "enum": [
  5404. "OPEN_CUSTOMER_SERVICE_CHAT"
  5405. ]
  5406. },
  5407. "liveAgentPod": {
  5408. "type": "string"
  5409. },
  5410. "orgId": {
  5411. "type": "string"
  5412. },
  5413. "deploymentId": {
  5414. "type": "string"
  5415. },
  5416. "buttonId": {
  5417. "type": "string"
  5418. }
  5419. },
  5420. "required": [
  5421. "type",
  5422. "liveAgentPod",
  5423. "orgId",
  5424. "deploymentId",
  5425. "buttonId"
  5426. ]
  5427. },
  5428. "OpenLoginAction": {
  5429. "type": "object",
  5430. "properties": {
  5431. "accessibilityDescription": {
  5432. "type": "string"
  5433. },
  5434. "onSuccessEvents": {
  5435. "type": "array",
  5436. "items": {
  5437. "$ref": "#/components/schemas/BFFEvent"
  5438. }
  5439. },
  5440. "type": {
  5441. "type": "string",
  5442. "enum": [
  5443. "OPEN_LOGIN"
  5444. ]
  5445. }
  5446. },
  5447. "required": [
  5448. "type"
  5449. ]
  5450. },
  5451. "OpenAddLoyaltyPointsAction": {
  5452. "type": "object",
  5453. "properties": {
  5454. "accessibilityDescription": {
  5455. "type": "string"
  5456. },
  5457. "onSuccessEvents": {
  5458. "type": "array",
  5459. "items": {
  5460. "$ref": "#/components/schemas/BFFEvent"
  5461. }
  5462. },
  5463. "type": {
  5464. "type": "string",
  5465. "enum": [
  5466. "OPEN_ADD_LOYALTY_POINTS"
  5467. ]
  5468. }
  5469. },
  5470. "required": [
  5471. "type"
  5472. ]
  5473. },
  5474. "OpenLoyaltyRegistrationAction": {
  5475. "type": "object",
  5476. "properties": {
  5477. "accessibilityDescription": {
  5478. "type": "string"
  5479. },
  5480. "onSuccessEvents": {
  5481. "type": "array",
  5482. "items": {
  5483. "$ref": "#/components/schemas/BFFEvent"
  5484. }
  5485. },
  5486. "type": {
  5487. "type": "string",
  5488. "enum": [
  5489. "OPEN_LOYALTY_REGISTRATION"
  5490. ]
  5491. }
  5492. },
  5493. "required": [
  5494. "type"
  5495. ]
  5496. },
  5497. "ScrollToContentAction": {
  5498. "type": "object",
  5499. "properties": {
  5500. "accessibilityDescription": {
  5501. "type": "string"
  5502. },
  5503. "onSuccessEvents": {
  5504. "type": "array",
  5505. "items": {
  5506. "$ref": "#/components/schemas/BFFEvent"
  5507. }
  5508. },
  5509. "type": {
  5510. "type": "string",
  5511. "enum": [
  5512. "SCROLL_TO_CONTENT"
  5513. ]
  5514. },
  5515. "contentId": {
  5516. "type": "string"
  5517. }
  5518. },
  5519. "required": [
  5520. "type",
  5521. "contentId"
  5522. ]
  5523. },
  5524. "CopyToClipboardAction": {
  5525. "type": "object",
  5526. "properties": {
  5527. "accessibilityDescription": {
  5528. "type": "string"
  5529. },
  5530. "onSuccessEvents": {
  5531. "type": "array",
  5532. "items": {
  5533. "$ref": "#/components/schemas/BFFEvent"
  5534. }
  5535. },
  5536. "type": {
  5537. "type": "string",
  5538. "enum": [
  5539. "COPY_TO_CLIPBOARD"
  5540. ]
  5541. },
  5542. "value": {
  5543. "type": "string"
  5544. },
  5545. "successMessage": {
  5546. "type": "string"
  5547. }
  5548. },
  5549. "required": [
  5550. "type",
  5551. "value",
  5552. "successMessage"
  5553. ]
  5554. },
  5555. "Prompt": {
  5556. "oneOf": [
  5557. {
  5558. "$ref": "#/components/schemas/SelectionPrompt"
  5559. },
  5560. {
  5561. "$ref": "#/components/schemas/DialogPrompt"
  5562. }
  5563. ]
  5564. },
  5565. "DialogPrompt": {
  5566. "type": "object",
  5567. "properties": {
  5568. "type": {
  5569. "type": "string",
  5570. "enum": [
  5571. "DIALOG"
  5572. ]
  5573. },
  5574. "title": {
  5575. "type": "string"
  5576. },
  5577. "message": {
  5578. "type": "string"
  5579. },
  5580. "confirmButtonTitle": {
  5581. "type": "string"
  5582. },
  5583. "cancelButonTitle": {
  5584. "type": "string"
  5585. },
  5586. "confirmAction": {
  5587. "$ref": "#/components/schemas/Action"
  5588. }
  5589. },
  5590. "required": [
  5591. "type",
  5592. "title",
  5593. "message",
  5594. "confirmButtonTitle",
  5595. "cancelButonTitle",
  5596. "confirmAction"
  5597. ]
  5598. },
  5599. "SelectionPrompt": {
  5600. "type": "object",
  5601. "properties": {
  5602. "type": {
  5603. "type": "string",
  5604. "enum": [
  5605. "SELECTION"
  5606. ]
  5607. },
  5608. "components": {
  5609. "type": "array",
  5610. "items": {
  5611. "oneOf": [
  5612. {
  5613. "$ref": "#/components/schemas/VariationListItem"
  5614. },
  5615. {
  5616. "$ref": "#/components/schemas/TitleComponent"
  5617. }
  5618. ]
  5619. }
  5620. },
  5621. "button": {
  5622. "$ref": "#/components/schemas/PlainButton"
  5623. }
  5624. },
  5625. "required": [
  5626. "type",
  5627. "components"
  5628. ]
  5629. },
  5630. "Header": {
  5631. "oneOf": [
  5632. {
  5633. "$ref": "#/components/schemas/TextHeader"
  5634. },
  5635. {
  5636. "$ref": "#/components/schemas/FilterHeader"
  5637. },
  5638. {
  5639. "$ref": "#/components/schemas/SearchHeader"
  5640. },
  5641. {
  5642. "$ref": "#/components/schemas/ProductHeader"
  5643. },
  5644. {
  5645. "$ref": "#/components/schemas/ProfileHeader"
  5646. },
  5647. {
  5648. "$ref": "#/components/schemas/ImageHeader"
  5649. }
  5650. ]
  5651. },
  5652. "HeaderButton": {
  5653. "type": "object",
  5654. "properties": {
  5655. "action": {
  5656. "$ref": "#/components/schemas/Action"
  5657. },
  5658. "icon": {
  5659. "$ref": "#/components/schemas/LocalImage"
  5660. }
  5661. },
  5662. "required": [
  5663. "action",
  5664. "icon"
  5665. ]
  5666. },
  5667. "HeaderBase": {
  5668. "type": "object",
  5669. "properties": {
  5670. "title": {
  5671. "type": "string"
  5672. },
  5673. "isLoading": {
  5674. "type": "boolean"
  5675. }
  5676. },
  5677. "required": [
  5678. "title",
  5679. "isLoading"
  5680. ]
  5681. },
  5682. "TabsHeader": {
  5683. "type": "object",
  5684. "properties": {
  5685. "title": {
  5686. "type": "string"
  5687. },
  5688. "isLoading": {
  5689. "type": "boolean"
  5690. },
  5691. "type": {
  5692. "type": "string",
  5693. "enum": [
  5694. "TABS"
  5695. ]
  5696. },
  5697. "buttons": {
  5698. "type": "array",
  5699. "items": {
  5700. "$ref": "#/components/schemas/TabsHeaderButton"
  5701. }
  5702. }
  5703. },
  5704. "required": [
  5705. "title",
  5706. "isLoading",
  5707. "type",
  5708. "buttons"
  5709. ]
  5710. },
  5711. "TabsHeaderButton": {
  5712. "type": "object",
  5713. "properties": {
  5714. "title": {
  5715. "type": "string"
  5716. },
  5717. "tabId": {
  5718. "type": "string"
  5719. },
  5720. "tapEvents": {
  5721. "type": "array",
  5722. "items": {
  5723. "$ref": "#/components/schemas/BFFEvent"
  5724. }
  5725. }
  5726. },
  5727. "required": [
  5728. "title",
  5729. "tabId"
  5730. ]
  5731. },
  5732. "TextHeader": {
  5733. "type": "object",
  5734. "properties": {
  5735. "title": {
  5736. "type": "string"
  5737. },
  5738. "isLoading": {
  5739. "type": "boolean"
  5740. },
  5741. "type": {
  5742. "type": "string",
  5743. "enum": [
  5744. "TEXT"
  5745. ]
  5746. },
  5747. "trailingHeaderButtons": {
  5748. "type": "array",
  5749. "items": {
  5750. "$ref": "#/components/schemas/HeaderButton"
  5751. }
  5752. },
  5753. "subtitle": {
  5754. "type": "string"
  5755. }
  5756. },
  5757. "required": [
  5758. "title",
  5759. "isLoading",
  5760. "type"
  5761. ]
  5762. },
  5763. "FilterHeader": {
  5764. "type": "object",
  5765. "properties": {
  5766. "title": {
  5767. "type": "string"
  5768. },
  5769. "isLoading": {
  5770. "type": "boolean"
  5771. },
  5772. "type": {
  5773. "type": "string",
  5774. "enum": [
  5775. "FILTER"
  5776. ]
  5777. },
  5778. "filterButton": {
  5779. "$ref": "#/components/schemas/NormalButton"
  5780. },
  5781. "subtitle": {
  5782. "type": "string"
  5783. }
  5784. },
  5785. "required": [
  5786. "title",
  5787. "isLoading",
  5788. "type"
  5789. ]
  5790. },
  5791. "SearchHeader": {
  5792. "type": "object",
  5793. "properties": {
  5794. "title": {
  5795. "type": "string"
  5796. },
  5797. "isLoading": {
  5798. "type": "boolean"
  5799. },
  5800. "type": {
  5801. "type": "string",
  5802. "enum": [
  5803. "SEARCH"
  5804. ]
  5805. },
  5806. "placeholder": {
  5807. "type": "string"
  5808. },
  5809. "showScanAction": {
  5810. "type": "boolean"
  5811. },
  5812. "scanActionIcon": {
  5813. "$ref": "#/components/schemas/Image"
  5814. },
  5815. "searchAction": {
  5816. "$ref": "#/components/schemas/OpenSearchAction"
  5817. }
  5818. },
  5819. "required": [
  5820. "title",
  5821. "isLoading",
  5822. "type",
  5823. "showScanAction",
  5824. "scanActionIcon",
  5825. "searchAction"
  5826. ]
  5827. },
  5828. "ProductHeader": {
  5829. "type": "object",
  5830. "properties": {
  5831. "title": {
  5832. "type": "string"
  5833. },
  5834. "isLoading": {
  5835. "type": "boolean"
  5836. },
  5837. "type": {
  5838. "type": "string",
  5839. "enum": [
  5840. "PRODUCT"
  5841. ]
  5842. },
  5843. "productId": {
  5844. "type": "string"
  5845. },
  5846. "favoriteAction": {
  5847. "$ref": "#/components/schemas/Action"
  5848. },
  5849. "unFavoriteAction": {
  5850. "$ref": "#/components/schemas/Action"
  5851. },
  5852. "prices": {
  5853. "$ref": "#/components/schemas/Prices"
  5854. },
  5855. "images": {
  5856. "type": "array",
  5857. "items": {
  5858. "$ref": "#/components/schemas/Image"
  5859. }
  5860. },
  5861. "paymentOptionsImage": {
  5862. "$ref": "#/components/schemas/Image"
  5863. },
  5864. "primaryButton": {
  5865. "$ref": "#/components/schemas/Button"
  5866. },
  5867. "extraButtons": {
  5868. "type": "array",
  5869. "items": {
  5870. "$ref": "#/components/schemas/Button"
  5871. }
  5872. },
  5873. "rating": {
  5874. "type": "number"
  5875. },
  5876. "ratingLabel": {
  5877. "type": "string"
  5878. },
  5879. "ratingAction": {
  5880. "$ref": "#/components/schemas/Action"
  5881. },
  5882. "stock": {
  5883. "$ref": "#/components/schemas/ProductStock"
  5884. },
  5885. "quantityInfo": {
  5886. "type": "string"
  5887. },
  5888. "actionSigningImage": {
  5889. "$ref": "#/components/schemas/Image"
  5890. },
  5891. "shareAction": {
  5892. "$ref": "#/components/schemas/Action"
  5893. }
  5894. },
  5895. "required": [
  5896. "title",
  5897. "isLoading",
  5898. "type",
  5899. "productId",
  5900. "images"
  5901. ]
  5902. },
  5903. "ProfileHeader": {
  5904. "type": "object",
  5905. "properties": {
  5906. "title": {
  5907. "type": "string"
  5908. },
  5909. "isLoading": {
  5910. "type": "boolean"
  5911. },
  5912. "type": {
  5913. "type": "string",
  5914. "enum": [
  5915. "PROFILE"
  5916. ]
  5917. }
  5918. },
  5919. "required": [
  5920. "title",
  5921. "isLoading",
  5922. "type"
  5923. ]
  5924. },
  5925. "ImageHeader": {
  5926. "type": "object",
  5927. "properties": {
  5928. "title": {
  5929. "type": "string"
  5930. },
  5931. "isLoading": {
  5932. "type": "boolean"
  5933. },
  5934. "type": {
  5935. "type": "string",
  5936. "enum": [
  5937. "IMAGE"
  5938. ]
  5939. },
  5940. "image": {
  5941. "$ref": "#/components/schemas/RemoteImage"
  5942. }
  5943. },
  5944. "required": [
  5945. "title",
  5946. "isLoading",
  5947. "type",
  5948. "image"
  5949. ]
  5950. },
  5951. "ProductStock": {
  5952. "type": "object",
  5953. "properties": {
  5954. "outOfStockMessage": {
  5955. "type": "string"
  5956. },
  5957. "scarcityText": {
  5958. "type": "string"
  5959. },
  5960. "inventories": {
  5961. "type": "array",
  5962. "items": {
  5963. "$ref": "#/components/schemas/ProductStockInventory"
  5964. }
  5965. }
  5966. },
  5967. "required": [
  5968. "inventories"
  5969. ]
  5970. },
  5971. "ProductStockInventory": {
  5972. "type": "object",
  5973. "properties": {
  5974. "quantity": {
  5975. "type": "number"
  5976. },
  5977. "deliveryPromise": {
  5978. "type": "string"
  5979. }
  5980. },
  5981. "required": [
  5982. "quantity"
  5983. ]
  5984. },
  5985. "Section": {
  5986. "oneOf": [
  5987. {
  5988. "$ref": "#/components/schemas/PrimarySection"
  5989. },
  5990. {
  5991. "$ref": "#/components/schemas/InfoSection"
  5992. },
  5993. {
  5994. "$ref": "#/components/schemas/CarouselSection"
  5995. }
  5996. ]
  5997. },
  5998. "SectionBase": {
  5999. "type": "object",
  6000. "properties": {
  6001. "contentId": {
  6002. "type": "string"
  6003. },
  6004. "components": {
  6005. "type": "array",
  6006. "items": {
  6007. "$ref": "#/components/schemas/Component"
  6008. }
  6009. },
  6010. "nextPage": {
  6011. "$ref": "#/components/schemas/LoadComponents"
  6012. },
  6013. "spacingTop": {
  6014. "$ref": "#/components/schemas/SectionSpacing"
  6015. },
  6016. "spacingBottom": {
  6017. "$ref": "#/components/schemas/SectionSpacing"
  6018. },
  6019. "separatorTop": {
  6020. "$ref": "#/components/schemas/SeparatorStyle"
  6021. },
  6022. "separatorBottom": {
  6023. "$ref": "#/components/schemas/SeparatorStyle"
  6024. },
  6025. "isUsingSpacerComponents": {
  6026. "type": "boolean"
  6027. }
  6028. },
  6029. "required": [
  6030. "contentId",
  6031. "components"
  6032. ]
  6033. },
  6034. "PrimarySection": {
  6035. "type": "object",
  6036. "properties": {
  6037. "contentId": {
  6038. "type": "string"
  6039. },
  6040. "components": {
  6041. "type": "array",
  6042. "items": {
  6043. "$ref": "#/components/schemas/Component"
  6044. }
  6045. },
  6046. "nextPage": {
  6047. "$ref": "#/components/schemas/LoadComponents"
  6048. },
  6049. "spacingTop": {
  6050. "$ref": "#/components/schemas/SectionSpacing"
  6051. },
  6052. "spacingBottom": {
  6053. "$ref": "#/components/schemas/SectionSpacing"
  6054. },
  6055. "separatorTop": {
  6056. "$ref": "#/components/schemas/SeparatorStyle"
  6057. },
  6058. "separatorBottom": {
  6059. "$ref": "#/components/schemas/SeparatorStyle"
  6060. },
  6061. "isUsingSpacerComponents": {
  6062. "type": "boolean"
  6063. },
  6064. "type": {
  6065. "type": "string",
  6066. "enum": [
  6067. "PRIMARY"
  6068. ]
  6069. }
  6070. },
  6071. "required": [
  6072. "contentId",
  6073. "components",
  6074. "type"
  6075. ]
  6076. },
  6077. "InfoSection": {
  6078. "type": "object",
  6079. "properties": {
  6080. "contentId": {
  6081. "type": "string"
  6082. },
  6083. "components": {
  6084. "type": "array",
  6085. "items": {
  6086. "$ref": "#/components/schemas/Component"
  6087. }
  6088. },
  6089. "nextPage": {
  6090. "$ref": "#/components/schemas/LoadComponents"
  6091. },
  6092. "spacingTop": {
  6093. "$ref": "#/components/schemas/SectionSpacing"
  6094. },
  6095. "spacingBottom": {
  6096. "$ref": "#/components/schemas/SectionSpacing"
  6097. },
  6098. "separatorTop": {
  6099. "$ref": "#/components/schemas/SeparatorStyle"
  6100. },
  6101. "separatorBottom": {
  6102. "$ref": "#/components/schemas/SeparatorStyle"
  6103. },
  6104. "isUsingSpacerComponents": {
  6105. "type": "boolean"
  6106. },
  6107. "type": {
  6108. "type": "string",
  6109. "enum": [
  6110. "INFO"
  6111. ]
  6112. },
  6113. "button": {
  6114. "$ref": "#/components/schemas/PlainButton"
  6115. }
  6116. },
  6117. "required": [
  6118. "contentId",
  6119. "components",
  6120. "type"
  6121. ]
  6122. },
  6123. "CarouselSection": {
  6124. "type": "object",
  6125. "properties": {
  6126. "contentId": {
  6127. "type": "string"
  6128. },
  6129. "components": {
  6130. "type": "array",
  6131. "items": {
  6132. "$ref": "#/components/schemas/CarouselItem"
  6133. }
  6134. },
  6135. "nextPage": {
  6136. "$ref": "#/components/schemas/LoadComponents"
  6137. },
  6138. "spacingTop": {
  6139. "$ref": "#/components/schemas/SectionSpacing"
  6140. },
  6141. "spacingBottom": {
  6142. "$ref": "#/components/schemas/SectionSpacing"
  6143. },
  6144. "separatorTop": {
  6145. "$ref": "#/components/schemas/SeparatorStyle"
  6146. },
  6147. "separatorBottom": {
  6148. "$ref": "#/components/schemas/SeparatorStyle"
  6149. },
  6150. "isUsingSpacerComponents": {
  6151. "type": "boolean"
  6152. },
  6153. "type": {
  6154. "type": "string",
  6155. "enum": [
  6156. "CAROUSEL"
  6157. ]
  6158. },
  6159. "title": {
  6160. "type": "string"
  6161. },
  6162. "titleDisplaySize": {
  6163. "type": "string",
  6164. "enum": [
  6165. "MEDIUM",
  6166. "LARGE"
  6167. ]
  6168. },
  6169. "action": {
  6170. "$ref": "#/components/schemas/Action"
  6171. },
  6172. "actionLabel": {
  6173. "type": "string"
  6174. },
  6175. "actionIcon": {
  6176. "$ref": "#/components/schemas/Image"
  6177. }
  6178. },
  6179. "required": [
  6180. "contentId",
  6181. "components",
  6182. "type"
  6183. ]
  6184. },
  6185. "SectionSpacing": {
  6186. "type": "string",
  6187. "enum": [
  6188. "SMALL",
  6189. "MEDIUM",
  6190. "LARGE"
  6191. ]
  6192. },
  6193. "SeparatorStyle": {
  6194. "type": "string",
  6195. "enum": [
  6196. "FULL",
  6197. "INDENTED"
  6198. ]
  6199. },
  6200. "SearchBarComponentExperiment": {
  6201. "type": "object",
  6202. "properties": {
  6203. "fingerprint": {
  6204. "type": "string"
  6205. },
  6206. "contentId": {
  6207. "type": "string"
  6208. },
  6209. "tags": {
  6210. "type": "array",
  6211. "items": {
  6212. "type": "string"
  6213. }
  6214. },
  6215. "type": {
  6216. "type": "string",
  6217. "enum": [
  6218. "SEARCH_BAR_EXPERIMENT"
  6219. ]
  6220. },
  6221. "placeholder": {
  6222. "type": "string"
  6223. },
  6224. "searchAction": {
  6225. "$ref": "#/components/schemas/OpenSearchAction"
  6226. }
  6227. },
  6228. "required": [
  6229. "fingerprint",
  6230. "contentId",
  6231. "type",
  6232. "placeholder",
  6233. "searchAction"
  6234. ]
  6235. },
  6236. "ProductCondensedComponentBase": {
  6237. "type": "object",
  6238. "properties": {
  6239. "fingerprint": {
  6240. "type": "string"
  6241. },
  6242. "contentId": {
  6243. "type": "string"
  6244. },
  6245. "tags": {
  6246. "type": "array",
  6247. "items": {
  6248. "type": "string"
  6249. }
  6250. },
  6251. "action": {
  6252. "$ref": "#/components/schemas/Action"
  6253. },
  6254. "title": {
  6255. "type": "string"
  6256. },
  6257. "prices": {
  6258. "$ref": "#/components/schemas/Prices"
  6259. },
  6260. "image": {
  6261. "$ref": "#/components/schemas/Image"
  6262. },
  6263. "variationIcon": {
  6264. "$ref": "#/components/schemas/LocalImage"
  6265. },
  6266. "favoriteAction": {
  6267. "$ref": "#/components/schemas/Action"
  6268. },
  6269. "unFavoriteAction": {
  6270. "$ref": "#/components/schemas/Action"
  6271. },
  6272. "primaryButton": {
  6273. "$ref": "#/components/schemas/Button"
  6274. },
  6275. "productId": {
  6276. "type": "string"
  6277. },
  6278. "actionSigningImage": {
  6279. "$ref": "#/components/schemas/Image"
  6280. },
  6281. "rating": {
  6282. "type": "number"
  6283. },
  6284. "importantInfo": {
  6285. "type": "string"
  6286. },
  6287. "quantityInfo": {
  6288. "type": "string"
  6289. }
  6290. },
  6291. "required": [
  6292. "fingerprint",
  6293. "contentId",
  6294. "title",
  6295. "image",
  6296. "productId"
  6297. ]
  6298. },
  6299. "PlpListItem": {
  6300. "type": "object",
  6301. "properties": {
  6302. "fingerprint": {
  6303. "type": "string"
  6304. },
  6305. "contentId": {
  6306. "type": "string"
  6307. },
  6308. "tags": {
  6309. "type": "array",
  6310. "items": {
  6311. "type": "string"
  6312. }
  6313. },
  6314. "action": {
  6315. "$ref": "#/components/schemas/Action"
  6316. },
  6317. "title": {
  6318. "type": "string"
  6319. },
  6320. "prices": {
  6321. "$ref": "#/components/schemas/Prices"
  6322. },
  6323. "image": {
  6324. "$ref": "#/components/schemas/Image"
  6325. },
  6326. "variationIcon": {
  6327. "$ref": "#/components/schemas/LocalImage"
  6328. },
  6329. "favoriteAction": {
  6330. "$ref": "#/components/schemas/Action"
  6331. },
  6332. "unFavoriteAction": {
  6333. "$ref": "#/components/schemas/Action"
  6334. },
  6335. "primaryButton": {
  6336. "$ref": "#/components/schemas/Button"
  6337. },
  6338. "productId": {
  6339. "type": "string"
  6340. },
  6341. "actionSigningImage": {
  6342. "$ref": "#/components/schemas/Image"
  6343. },
  6344. "rating": {
  6345. "type": "number"
  6346. },
  6347. "importantInfo": {
  6348. "type": "string"
  6349. },
  6350. "quantityInfo": {
  6351. "type": "string"
  6352. },
  6353. "type": {
  6354. "type": "string",
  6355. "enum": [
  6356. "PRODUCT_CONDENSED"
  6357. ]
  6358. }
  6359. },
  6360. "required": [
  6361. "fingerprint",
  6362. "contentId",
  6363. "title",
  6364. "image",
  6365. "productId",
  6366. "type"
  6367. ]
  6368. },
  6369. "FavoriteListItem": {
  6370. "type": "object",
  6371. "properties": {
  6372. "fingerprint": {
  6373. "type": "string"
  6374. },
  6375. "contentId": {
  6376. "type": "string"
  6377. },
  6378. "tags": {
  6379. "type": "array",
  6380. "items": {
  6381. "type": "string"
  6382. }
  6383. },
  6384. "action": {
  6385. "$ref": "#/components/schemas/Action"
  6386. },
  6387. "title": {
  6388. "type": "string"
  6389. },
  6390. "type": {
  6391. "type": "string",
  6392. "enum": [
  6393. "FAVORITE"
  6394. ]
  6395. },
  6396. "prices": {
  6397. "$ref": "#/components/schemas/Prices"
  6398. },
  6399. "additionalInfo": {
  6400. "type": "string"
  6401. },
  6402. "importantInfo": {
  6403. "type": "string"
  6404. },
  6405. "image": {
  6406. "$ref": "#/components/schemas/Image"
  6407. },
  6408. "active": {
  6409. "type": "boolean"
  6410. },
  6411. "unFavoriteAction": {
  6412. "$ref": "#/components/schemas/Action"
  6413. },
  6414. "primaryButton": {
  6415. "$ref": "#/components/schemas/Button"
  6416. },
  6417. "productId": {
  6418. "type": "string"
  6419. },
  6420. "actionSigningImage": {
  6421. "$ref": "#/components/schemas/Image"
  6422. }
  6423. },
  6424. "required": [
  6425. "fingerprint",
  6426. "contentId",
  6427. "title",
  6428. "type",
  6429. "image",
  6430. "active",
  6431. "productId"
  6432. ]
  6433. },
  6434. "PlainListItem": {
  6435. "type": "object",
  6436. "properties": {
  6437. "fingerprint": {
  6438. "type": "string"
  6439. },
  6440. "contentId": {
  6441. "type": "string"
  6442. },
  6443. "tags": {
  6444. "type": "array",
  6445. "items": {
  6446. "type": "string"
  6447. }
  6448. },
  6449. "action": {
  6450. "$ref": "#/components/schemas/Action"
  6451. },
  6452. "type": {
  6453. "type": "string",
  6454. "enum": [
  6455. "PLAIN"
  6456. ]
  6457. },
  6458. "title": {
  6459. "type": "string"
  6460. },
  6461. "image": {
  6462. "$ref": "#/components/schemas/Image"
  6463. },
  6464. "emphasisLevel": {
  6465. "type": "string",
  6466. "enum": [
  6467. "NONE",
  6468. "LIGHT",
  6469. "STRONG"
  6470. ]
  6471. },
  6472. "indicator": {
  6473. "type": "string",
  6474. "enum": [
  6475. "RED",
  6476. "BLUE"
  6477. ]
  6478. }
  6479. },
  6480. "required": [
  6481. "fingerprint",
  6482. "contentId",
  6483. "type",
  6484. "title",
  6485. "emphasisLevel"
  6486. ]
  6487. },
  6488. "QRCodeListItem": {
  6489. "type": "object",
  6490. "properties": {
  6491. "fingerprint": {
  6492. "type": "string"
  6493. },
  6494. "contentId": {
  6495. "type": "string"
  6496. },
  6497. "tags": {
  6498. "type": "array",
  6499. "items": {
  6500. "type": "string"
  6501. }
  6502. },
  6503. "action": {
  6504. "$ref": "#/components/schemas/Action"
  6505. },
  6506. "type": {
  6507. "type": "string",
  6508. "enum": [
  6509. "QR_CODE_LIST_ITEM"
  6510. ]
  6511. },
  6512. "title": {
  6513. "type": "string"
  6514. },
  6515. "description": {
  6516. "type": "string"
  6517. },
  6518. "code": {
  6519. "type": "string"
  6520. },
  6521. "accessibilityDescription": {
  6522. "type": "string"
  6523. }
  6524. },
  6525. "required": [
  6526. "fingerprint",
  6527. "contentId",
  6528. "type",
  6529. "title",
  6530. "description",
  6531. "code",
  6532. "accessibilityDescription"
  6533. ]
  6534. },
  6535. "VariationListItem": {
  6536. "type": "object",
  6537. "properties": {
  6538. "fingerprint": {
  6539. "type": "string"
  6540. },
  6541. "contentId": {
  6542. "type": "string"
  6543. },
  6544. "tags": {
  6545. "type": "array",
  6546. "items": {
  6547. "type": "string"
  6548. }
  6549. },
  6550. "action": {
  6551. "$ref": "#/components/schemas/Action"
  6552. },
  6553. "type": {
  6554. "type": "string",
  6555. "enum": [
  6556. "VARIATION"
  6557. ]
  6558. },
  6559. "title": {
  6560. "type": "string"
  6561. },
  6562. "image": {
  6563. "$ref": "#/components/schemas/Image"
  6564. },
  6565. "selected": {
  6566. "type": "boolean"
  6567. },
  6568. "importantInfo": {
  6569. "type": "string"
  6570. },
  6571. "quantityInfo": {
  6572. "type": "string"
  6573. },
  6574. "price": {
  6575. "$ref": "#/components/schemas/Prices"
  6576. },
  6577. "active": {
  6578. "type": "boolean"
  6579. }
  6580. },
  6581. "required": [
  6582. "fingerprint",
  6583. "contentId",
  6584. "type",
  6585. "selected",
  6586. "active"
  6587. ]
  6588. },
  6589. "PlainTextDisplayStyle": {
  6590. "type": "string",
  6591. "enum": [
  6592. "NORMAL",
  6593. "HIGHLIGHTED"
  6594. ]
  6595. },
  6596. "PlainTextDisplaySize": {
  6597. "type": "string",
  6598. "enum": [
  6599. "MEDIUM",
  6600. "LARGE"
  6601. ]
  6602. },
  6603. "PlainTextListItem": {
  6604. "type": "object",
  6605. "properties": {
  6606. "fingerprint": {
  6607. "type": "string"
  6608. },
  6609. "contentId": {
  6610. "type": "string"
  6611. },
  6612. "tags": {
  6613. "type": "array",
  6614. "items": {
  6615. "type": "string"
  6616. }
  6617. },
  6618. "action": {
  6619. "$ref": "#/components/schemas/Action"
  6620. },
  6621. "type": {
  6622. "type": "string",
  6623. "enum": [
  6624. "PLAIN_TEXT"
  6625. ]
  6626. },
  6627. "displayStyle": {
  6628. "$ref": "#/components/schemas/PlainTextDisplayStyle"
  6629. },
  6630. "displaySize": {
  6631. "$ref": "#/components/schemas/PlainTextDisplaySize"
  6632. },
  6633. "title": {
  6634. "type": "string"
  6635. },
  6636. "subtitle": {
  6637. "type": "string"
  6638. },
  6639. "separatorTop": {
  6640. "$ref": "#/components/schemas/SeparatorStyle"
  6641. },
  6642. "iconRight": {
  6643. "$ref": "#/components/schemas/Image"
  6644. }
  6645. },
  6646. "required": [
  6647. "fingerprint",
  6648. "contentId",
  6649. "type",
  6650. "displayStyle",
  6651. "title"
  6652. ]
  6653. },
  6654. "PlainProductListItem": {
  6655. "type": "object",
  6656. "properties": {
  6657. "fingerprint": {
  6658. "type": "string"
  6659. },
  6660. "contentId": {
  6661. "type": "string"
  6662. },
  6663. "tags": {
  6664. "type": "array",
  6665. "items": {
  6666. "type": "string"
  6667. }
  6668. },
  6669. "action": {
  6670. "$ref": "#/components/schemas/Action"
  6671. },
  6672. "type": {
  6673. "type": "string",
  6674. "enum": [
  6675. "PLAIN_PRODUCT"
  6676. ]
  6677. },
  6678. "title": {
  6679. "type": "string"
  6680. },
  6681. "prices": {
  6682. "$ref": "#/components/schemas/Prices"
  6683. }
  6684. },
  6685. "required": [
  6686. "fingerprint",
  6687. "contentId",
  6688. "type",
  6689. "title"
  6690. ]
  6691. },
  6692. "ActionTextListItem": {
  6693. "type": "object",
  6694. "properties": {
  6695. "fingerprint": {
  6696. "type": "string"
  6697. },
  6698. "contentId": {
  6699. "type": "string"
  6700. },
  6701. "tags": {
  6702. "type": "array",
  6703. "items": {
  6704. "type": "string"
  6705. }
  6706. },
  6707. "action": {
  6708. "$ref": "#/components/schemas/Action"
  6709. },
  6710. "type": {
  6711. "type": "string",
  6712. "enum": [
  6713. "ACTION_TEXT"
  6714. ]
  6715. },
  6716. "title": {
  6717. "type": "string"
  6718. },
  6719. "icon": {
  6720. "$ref": "#/components/schemas/LocalImage"
  6721. }
  6722. },
  6723. "required": [
  6724. "fingerprint",
  6725. "contentId",
  6726. "type",
  6727. "title",
  6728. "icon"
  6729. ]
  6730. },
  6731. "OrderSummaryListItem": {
  6732. "type": "object",
  6733. "properties": {
  6734. "fingerprint": {
  6735. "type": "string"
  6736. },
  6737. "contentId": {
  6738. "type": "string"
  6739. },
  6740. "tags": {
  6741. "type": "array",
  6742. "items": {
  6743. "type": "string"
  6744. }
  6745. },
  6746. "action": {
  6747. "$ref": "#/components/schemas/Action"
  6748. },
  6749. "type": {
  6750. "type": "string",
  6751. "enum": [
  6752. "ORDER_SUMMARY"
  6753. ]
  6754. },
  6755. "title": {
  6756. "type": "string"
  6757. },
  6758. "ctaLabel": {
  6759. "type": "string"
  6760. },
  6761. "productImage": {
  6762. "$ref": "#/components/schemas/Image"
  6763. },
  6764. "orderDetails": {
  6765. "type": "string"
  6766. },
  6767. "status": {
  6768. "$ref": "#/components/schemas/OrderDetailStatus"
  6769. },
  6770. "trackAndTraceButton": {
  6771. "oneOf": [
  6772. {
  6773. "$ref": "#/components/schemas/NormalButton"
  6774. },
  6775. {
  6776. "$ref": "#/components/schemas/PlainButton"
  6777. }
  6778. ]
  6779. },
  6780. "accessibilityDescription": {
  6781. "type": "string"
  6782. }
  6783. },
  6784. "required": [
  6785. "fingerprint",
  6786. "contentId",
  6787. "type",
  6788. "title",
  6789. "ctaLabel",
  6790. "orderDetails",
  6791. "accessibilityDescription"
  6792. ]
  6793. },
  6794. "OrderProductListItem": {
  6795. "type": "object",
  6796. "properties": {
  6797. "fingerprint": {
  6798. "type": "string"
  6799. },
  6800. "contentId": {
  6801. "type": "string"
  6802. },
  6803. "tags": {
  6804. "type": "array",
  6805. "items": {
  6806. "type": "string"
  6807. }
  6808. },
  6809. "action": {
  6810. "$ref": "#/components/schemas/Action"
  6811. },
  6812. "type": {
  6813. "type": "string",
  6814. "enum": [
  6815. "ORDER_PRODUCT"
  6816. ]
  6817. },
  6818. "title": {
  6819. "type": "string"
  6820. },
  6821. "prices": {
  6822. "$ref": "#/components/schemas/Prices"
  6823. },
  6824. "image": {
  6825. "$ref": "#/components/schemas/RemoteImage"
  6826. },
  6827. "favoriteAction": {
  6828. "$ref": "#/components/schemas/Action"
  6829. },
  6830. "unFavoriteAction": {
  6831. "$ref": "#/components/schemas/Action"
  6832. },
  6833. "summary": {
  6834. "type": "string"
  6835. },
  6836. "accessibilityDescription": {
  6837. "type": "string"
  6838. }
  6839. },
  6840. "required": [
  6841. "fingerprint",
  6842. "contentId",
  6843. "type",
  6844. "title",
  6845. "prices",
  6846. "summary",
  6847. "accessibilityDescription"
  6848. ]
  6849. },
  6850. "BasketProductListItem": {
  6851. "type": "object",
  6852. "properties": {
  6853. "fingerprint": {
  6854. "type": "string"
  6855. },
  6856. "contentId": {
  6857. "type": "string"
  6858. },
  6859. "tags": {
  6860. "type": "array",
  6861. "items": {
  6862. "type": "string"
  6863. }
  6864. },
  6865. "action": {
  6866. "$ref": "#/components/schemas/Action"
  6867. },
  6868. "productId": {
  6869. "type": "string"
  6870. },
  6871. "type": {
  6872. "type": "string",
  6873. "enum": [
  6874. "BASKET_PRODUCT"
  6875. ]
  6876. },
  6877. "image": {
  6878. "$ref": "#/components/schemas/RemoteImage"
  6879. },
  6880. "actionSignings": {
  6881. "type": "array",
  6882. "items": {
  6883. "$ref": "#/components/schemas/ActionSigning"
  6884. }
  6885. },
  6886. "title": {
  6887. "type": "string"
  6888. },
  6889. "summary": {
  6890. "type": "string"
  6891. },
  6892. "stockInfo": {
  6893. "type": "string"
  6894. },
  6895. "quantityInfo": {
  6896. "type": "string"
  6897. },
  6898. "stockInfoStyle": {
  6899. "type": "string",
  6900. "enum": [
  6901. "NORMAL",
  6902. "WARNING",
  6903. "ERROR"
  6904. ]
  6905. },
  6906. "quantityControlButton": {
  6907. "$ref": "#/components/schemas/QuantityControlButton"
  6908. },
  6909. "unitPriceText": {
  6910. "type": "string"
  6911. },
  6912. "totalPrice": {
  6913. "$ref": "#/components/schemas/Prices"
  6914. },
  6915. "accessibilityDescription": {
  6916. "type": "string"
  6917. },
  6918. "contextActions": {
  6919. "type": "array",
  6920. "items": {
  6921. "$ref": "#/components/schemas/ContextAction"
  6922. }
  6923. }
  6924. },
  6925. "required": [
  6926. "fingerprint",
  6927. "contentId",
  6928. "productId",
  6929. "type",
  6930. "title",
  6931. "stockInfoStyle",
  6932. "totalPrice",
  6933. "accessibilityDescription",
  6934. "contextActions"
  6935. ]
  6936. },
  6937. "ContextAction": {
  6938. "oneOf": [
  6939. {
  6940. "$ref": "#/components/schemas/ContextActionStandard"
  6941. },
  6942. {
  6943. "$ref": "#/components/schemas/ContextActionFavorite"
  6944. }
  6945. ]
  6946. },
  6947. "ContextActionStandard": {
  6948. "type": "object",
  6949. "properties": {
  6950. "type": {
  6951. "type": "string",
  6952. "enum": [
  6953. "STANDARD"
  6954. ]
  6955. },
  6956. "title": {
  6957. "type": "string"
  6958. },
  6959. "action": {
  6960. "$ref": "#/components/schemas/Action"
  6961. },
  6962. "icon": {
  6963. "$ref": "#/components/schemas/LocalImage"
  6964. },
  6965. "style": {
  6966. "type": "string",
  6967. "enum": [
  6968. "NORMAL",
  6969. "WARNING"
  6970. ]
  6971. }
  6972. },
  6973. "required": [
  6974. "type",
  6975. "title",
  6976. "action",
  6977. "icon",
  6978. "style"
  6979. ]
  6980. },
  6981. "ContextActionFavorite": {
  6982. "type": "object",
  6983. "properties": {
  6984. "type": {
  6985. "type": "string",
  6986. "enum": [
  6987. "FAVORITE"
  6988. ]
  6989. },
  6990. "favoriteTitle": {
  6991. "type": "string"
  6992. },
  6993. "unFavoriteTitle": {
  6994. "type": "string"
  6995. },
  6996. "favoriteAction": {
  6997. "$ref": "#/components/schemas/Action"
  6998. },
  6999. "unFavoriteAction": {
  7000. "$ref": "#/components/schemas/Action"
  7001. }
  7002. },
  7003. "required": [
  7004. "type",
  7005. "favoriteTitle",
  7006. "unFavoriteTitle"
  7007. ]
  7008. },
  7009. "ActionSigning": {
  7010. "oneOf": [
  7011. {
  7012. "$ref": "#/components/schemas/ActionSigningImage"
  7013. },
  7014. {
  7015. "$ref": "#/components/schemas/ActionSigningText"
  7016. }
  7017. ]
  7018. },
  7019. "ActionSigningImage": {
  7020. "type": "object",
  7021. "properties": {
  7022. "type": {
  7023. "type": "string",
  7024. "enum": [
  7025. "ACTION_SIGNING_IMAGE"
  7026. ]
  7027. },
  7028. "image": {
  7029. "$ref": "#/components/schemas/RemoteImage"
  7030. }
  7031. },
  7032. "required": [
  7033. "type",
  7034. "image"
  7035. ]
  7036. },
  7037. "ActionSigningText": {
  7038. "type": "object",
  7039. "properties": {
  7040. "type": {
  7041. "type": "string",
  7042. "enum": [
  7043. "ACTION_SIGNING_TEXT"
  7044. ]
  7045. },
  7046. "text": {
  7047. "type": "string"
  7048. }
  7049. },
  7050. "required": [
  7051. "type",
  7052. "text"
  7053. ]
  7054. },
  7055. "BulletListComponent": {
  7056. "type": "object",
  7057. "properties": {
  7058. "fingerprint": {
  7059. "type": "string"
  7060. },
  7061. "contentId": {
  7062. "type": "string"
  7063. },
  7064. "tags": {
  7065. "type": "array",
  7066. "items": {
  7067. "type": "string"
  7068. }
  7069. },
  7070. "style": {
  7071. "type": "string",
  7072. "enum": [
  7073. "CHECKMARK",
  7074. "DOT",
  7075. "NUMERIC"
  7076. ]
  7077. },
  7078. "items": {
  7079. "type": "array",
  7080. "items": {
  7081. "type": "string"
  7082. }
  7083. },
  7084. "type": {
  7085. "type": "string",
  7086. "enum": [
  7087. "BULLET_LIST"
  7088. ]
  7089. }
  7090. },
  7091. "required": [
  7092. "fingerprint",
  7093. "contentId",
  7094. "style",
  7095. "items",
  7096. "type"
  7097. ]
  7098. },
  7099. "SpacerComponent": {
  7100. "type": "object",
  7101. "properties": {
  7102. "fingerprint": {
  7103. "type": "string"
  7104. },
  7105. "contentId": {
  7106. "type": "string"
  7107. },
  7108. "tags": {
  7109. "type": "array",
  7110. "items": {
  7111. "type": "string"
  7112. }
  7113. },
  7114. "type": {
  7115. "type": "string",
  7116. "enum": [
  7117. "SPACER"
  7118. ]
  7119. },
  7120. "size": {
  7121. "type": "number"
  7122. }
  7123. },
  7124. "required": [
  7125. "fingerprint",
  7126. "contentId",
  7127. "type",
  7128. "size"
  7129. ]
  7130. },
  7131. "ImageCollectionComponent": {
  7132. "type": "object",
  7133. "properties": {
  7134. "fingerprint": {
  7135. "type": "string"
  7136. },
  7137. "contentId": {
  7138. "type": "string"
  7139. },
  7140. "tags": {
  7141. "type": "array",
  7142. "items": {
  7143. "type": "string"
  7144. }
  7145. },
  7146. "type": {
  7147. "type": "string",
  7148. "enum": [
  7149. "IMAGE_COLLECTION"
  7150. ]
  7151. },
  7152. "images": {
  7153. "type": "array",
  7154. "items": {
  7155. "$ref": "#/components/schemas/Image"
  7156. }
  7157. }
  7158. },
  7159. "required": [
  7160. "fingerprint",
  7161. "contentId",
  7162. "type",
  7163. "images"
  7164. ]
  7165. },
  7166. "ImageComponent": {
  7167. "type": "object",
  7168. "properties": {
  7169. "fingerprint": {
  7170. "type": "string"
  7171. },
  7172. "contentId": {
  7173. "type": "string"
  7174. },
  7175. "tags": {
  7176. "type": "array",
  7177. "items": {
  7178. "type": "string"
  7179. }
  7180. },
  7181. "type": {
  7182. "type": "string",
  7183. "enum": [
  7184. "IMAGE"
  7185. ]
  7186. },
  7187. "position": {
  7188. "type": "string",
  7189. "enum": [
  7190. "LEADING",
  7191. "CENTER",
  7192. "TRAILING"
  7193. ]
  7194. },
  7195. "shape": {
  7196. "type": "string",
  7197. "enum": [
  7198. "RECTANGLE",
  7199. "ROUNDED_RECTANGLE"
  7200. ]
  7201. },
  7202. "image": {
  7203. "$ref": "#/components/schemas/Image"
  7204. },
  7205. "maxWidthPercentage": {
  7206. "type": "number"
  7207. }
  7208. },
  7209. "required": [
  7210. "fingerprint",
  7211. "contentId",
  7212. "type",
  7213. "position",
  7214. "shape",
  7215. "image"
  7216. ]
  7217. },
  7218. "ParagraphComponent": {
  7219. "type": "object",
  7220. "properties": {
  7221. "fingerprint": {
  7222. "type": "string"
  7223. },
  7224. "contentId": {
  7225. "type": "string"
  7226. },
  7227. "tags": {
  7228. "type": "array",
  7229. "items": {
  7230. "type": "string"
  7231. }
  7232. },
  7233. "type": {
  7234. "type": "string",
  7235. "enum": [
  7236. "PARAGRAPH"
  7237. ]
  7238. },
  7239. "paragraphs": {
  7240. "type": "array",
  7241. "items": {
  7242. "type": "string"
  7243. }
  7244. }
  7245. },
  7246. "required": [
  7247. "fingerprint",
  7248. "contentId",
  7249. "type",
  7250. "paragraphs"
  7251. ]
  7252. },
  7253. "ButtonsComponent": {
  7254. "type": "object",
  7255. "properties": {
  7256. "fingerprint": {
  7257. "type": "string"
  7258. },
  7259. "contentId": {
  7260. "type": "string"
  7261. },
  7262. "tags": {
  7263. "type": "array",
  7264. "items": {
  7265. "type": "string"
  7266. }
  7267. },
  7268. "type": {
  7269. "type": "string",
  7270. "enum": [
  7271. "BUTTONS"
  7272. ]
  7273. },
  7274. "buttons": {
  7275. "type": "array",
  7276. "items": {
  7277. "$ref": "#/components/schemas/Button"
  7278. }
  7279. }
  7280. },
  7281. "required": [
  7282. "fingerprint",
  7283. "contentId",
  7284. "type",
  7285. "buttons"
  7286. ]
  7287. },
  7288. "TitleComponent": {
  7289. "type": "object",
  7290. "properties": {
  7291. "fingerprint": {
  7292. "type": "string"
  7293. },
  7294. "contentId": {
  7295. "type": "string"
  7296. },
  7297. "tags": {
  7298. "type": "array",
  7299. "items": {
  7300. "type": "string"
  7301. }
  7302. },
  7303. "type": {
  7304. "type": "string",
  7305. "enum": [
  7306. "TITLE"
  7307. ]
  7308. },
  7309. "displayStyle": {
  7310. "type": "string",
  7311. "enum": [
  7312. "EXTRA_LARGE",
  7313. "LARGE",
  7314. "MEDIUM",
  7315. "SMALL"
  7316. ]
  7317. },
  7318. "text": {
  7319. "type": "string"
  7320. }
  7321. },
  7322. "required": [
  7323. "fingerprint",
  7324. "contentId",
  7325. "type",
  7326. "displayStyle",
  7327. "text"
  7328. ]
  7329. },
  7330. "VariationProductListItem": {
  7331. "type": "object",
  7332. "properties": {
  7333. "fingerprint": {
  7334. "type": "string"
  7335. },
  7336. "contentId": {
  7337. "type": "string"
  7338. },
  7339. "tags": {
  7340. "type": "array",
  7341. "items": {
  7342. "type": "string"
  7343. }
  7344. },
  7345. "action": {
  7346. "$ref": "#/components/schemas/Action"
  7347. },
  7348. "type": {
  7349. "type": "string",
  7350. "enum": [
  7351. "VARIATION_PRODUCT_LIST_ITEM"
  7352. ]
  7353. },
  7354. "productId": {
  7355. "type": "string"
  7356. },
  7357. "title": {
  7358. "type": "string"
  7359. },
  7360. "image": {
  7361. "$ref": "#/components/schemas/Image"
  7362. },
  7363. "prices": {
  7364. "$ref": "#/components/schemas/Prices"
  7365. },
  7366. "stock": {
  7367. "$ref": "#/components/schemas/ProductStock"
  7368. },
  7369. "quantityInfo": {
  7370. "type": "string"
  7371. },
  7372. "actionSigningImage": {
  7373. "$ref": "#/components/schemas/Image"
  7374. },
  7375. "button": {
  7376. "$ref": "#/components/schemas/SetBasketItemButton"
  7377. }
  7378. },
  7379. "required": [
  7380. "fingerprint",
  7381. "contentId",
  7382. "type",
  7383. "productId",
  7384. "title"
  7385. ]
  7386. },
  7387. "TwoColumnTableComponent": {
  7388. "type": "object",
  7389. "properties": {
  7390. "fingerprint": {
  7391. "type": "string"
  7392. },
  7393. "contentId": {
  7394. "type": "string"
  7395. },
  7396. "tags": {
  7397. "type": "array",
  7398. "items": {
  7399. "type": "string"
  7400. }
  7401. },
  7402. "type": {
  7403. "type": "string",
  7404. "enum": [
  7405. "TWO_COLUMN_TABLE"
  7406. ]
  7407. },
  7408. "rows": {
  7409. "type": "array",
  7410. "items": {
  7411. "$ref": "#/components/schemas/TwoColumnTableRow"
  7412. }
  7413. },
  7414. "footnote": {
  7415. "type": "string"
  7416. }
  7417. },
  7418. "required": [
  7419. "fingerprint",
  7420. "contentId",
  7421. "type",
  7422. "rows"
  7423. ]
  7424. },
  7425. "TwoColumnTableRow": {
  7426. "type": "object",
  7427. "properties": {
  7428. "leftCell": {
  7429. "$ref": "#/components/schemas/TableCell"
  7430. },
  7431. "rightCell": {
  7432. "$ref": "#/components/schemas/TableCell"
  7433. }
  7434. },
  7435. "required": [
  7436. "leftCell",
  7437. "rightCell"
  7438. ]
  7439. },
  7440. "TableCell": {
  7441. "type": "object",
  7442. "properties": {
  7443. "text": {
  7444. "type": "string"
  7445. },
  7446. "isBold": {
  7447. "type": "boolean"
  7448. }
  7449. },
  7450. "required": [
  7451. "text"
  7452. ]
  7453. },
  7454. "DefinitionListComponent": {
  7455. "type": "object",
  7456. "properties": {
  7457. "fingerprint": {
  7458. "type": "string"
  7459. },
  7460. "contentId": {
  7461. "type": "string"
  7462. },
  7463. "tags": {
  7464. "type": "array",
  7465. "items": {
  7466. "type": "string"
  7467. }
  7468. },
  7469. "type": {
  7470. "type": "string",
  7471. "enum": [
  7472. "DEFINITION_LIST"
  7473. ]
  7474. },
  7475. "items": {
  7476. "type": "array",
  7477. "items": {
  7478. "$ref": "#/components/schemas/Definition"
  7479. }
  7480. }
  7481. },
  7482. "required": [
  7483. "fingerprint",
  7484. "contentId",
  7485. "type",
  7486. "items"
  7487. ]
  7488. },
  7489. "DefinitionDisplayStyle": {
  7490. "type": "string",
  7491. "enum": [
  7492. "PRIMARY",
  7493. "DANGER"
  7494. ]
  7495. },
  7496. "Definition": {
  7497. "type": "object",
  7498. "properties": {
  7499. "fingerprint": {
  7500. "type": "string"
  7501. },
  7502. "contentId": {
  7503. "type": "string"
  7504. },
  7505. "tags": {
  7506. "type": "array",
  7507. "items": {
  7508. "type": "string"
  7509. }
  7510. },
  7511. "icon": {
  7512. "$ref": "#/components/schemas/Image"
  7513. },
  7514. "title": {
  7515. "type": "string"
  7516. },
  7517. "style": {
  7518. "$ref": "#/components/schemas/DefinitionDisplayStyle"
  7519. },
  7520. "subtitle": {
  7521. "type": "string"
  7522. },
  7523. "paragraphs": {
  7524. "type": "array",
  7525. "items": {
  7526. "$ref": "#/components/schemas/DefinitionParagraph"
  7527. }
  7528. }
  7529. },
  7530. "required": [
  7531. "fingerprint",
  7532. "contentId",
  7533. "icon",
  7534. "title",
  7535. "style"
  7536. ]
  7537. },
  7538. "DefinitionParagraph": {
  7539. "type": "object",
  7540. "properties": {
  7541. "paragraphs": {
  7542. "type": "array",
  7543. "items": {
  7544. "type": "string"
  7545. }
  7546. }
  7547. },
  7548. "required": [
  7549. "paragraphs"
  7550. ]
  7551. },
  7552. "InfoMessageComponent": {
  7553. "type": "object",
  7554. "properties": {
  7555. "fingerprint": {
  7556. "type": "string"
  7557. },
  7558. "contentId": {
  7559. "type": "string"
  7560. },
  7561. "tags": {
  7562. "type": "array",
  7563. "items": {
  7564. "type": "string"
  7565. }
  7566. },
  7567. "type": {
  7568. "type": "string",
  7569. "enum": [
  7570. "INFO_MESSAGE"
  7571. ]
  7572. },
  7573. "title": {
  7574. "type": "string"
  7575. },
  7576. "message": {
  7577. "type": "string"
  7578. },
  7579. "button": {
  7580. "$ref": "#/components/schemas/NormalButton"
  7581. },
  7582. "style": {
  7583. "type": "string",
  7584. "enum": [
  7585. "NORMAL",
  7586. "WARNING"
  7587. ]
  7588. }
  7589. },
  7590. "required": [
  7591. "fingerprint",
  7592. "contentId",
  7593. "type",
  7594. "style"
  7595. ]
  7596. },
  7597. "VoucherDisplayType": {
  7598. "type": "string",
  7599. "enum": [
  7600. "ACTIVATED",
  7601. "ACTIVATABLE",
  7602. "POINTS_NEEDED",
  7603. "TEASER",
  7604. "ALMOST_EXPIRED"
  7605. ]
  7606. },
  7607. "VoucherItem": {
  7608. "type": "object",
  7609. "properties": {
  7610. "displayType": {
  7611. "$ref": "#/components/schemas/VoucherDisplayType"
  7612. },
  7613. "points": {
  7614. "type": "number"
  7615. },
  7616. "pointsNeededPercentage": {
  7617. "type": "number"
  7618. },
  7619. "image": {
  7620. "$ref": "#/components/schemas/Image"
  7621. },
  7622. "title": {
  7623. "type": "string"
  7624. },
  7625. "subtitle": {
  7626. "type": "string"
  7627. },
  7628. "description": {
  7629. "type": "string"
  7630. },
  7631. "button": {
  7632. "$ref": "#/components/schemas/NormalButton"
  7633. }
  7634. },
  7635. "required": [
  7636. "displayType"
  7637. ]
  7638. },
  7639. "BannerCaption": {
  7640. "type": "object",
  7641. "properties": {
  7642. "title": {
  7643. "type": "string"
  7644. },
  7645. "subtitle": {
  7646. "type": "string"
  7647. }
  7648. },
  7649. "required": [
  7650. "title",
  7651. "subtitle"
  7652. ]
  7653. },
  7654. "CarouselItem": {
  7655. "oneOf": [
  7656. {
  7657. "$ref": "#/components/schemas/CarouselProductItem"
  7658. },
  7659. {
  7660. "$ref": "#/components/schemas/CarouselBannerItem"
  7661. },
  7662. {
  7663. "$ref": "#/components/schemas/CarouselProductReviewItem"
  7664. },
  7665. {
  7666. "$ref": "#/components/schemas/CarouselVoucherItem"
  7667. },
  7668. {
  7669. "$ref": "#/components/schemas/CarouselViewAllItem"
  7670. },
  7671. {
  7672. "$ref": "#/components/schemas/CarouselCategoryItem"
  7673. }
  7674. ]
  7675. },
  7676. "CarouselBannerItem": {
  7677. "type": "object",
  7678. "properties": {
  7679. "fingerprint": {
  7680. "type": "string"
  7681. },
  7682. "contentId": {
  7683. "type": "string"
  7684. },
  7685. "tags": {
  7686. "type": "array",
  7687. "items": {
  7688. "type": "string"
  7689. }
  7690. },
  7691. "action": {
  7692. "$ref": "#/components/schemas/Action"
  7693. },
  7694. "type": {
  7695. "type": "string",
  7696. "enum": [
  7697. "CAROUSEL_BANNER_ITEM"
  7698. ]
  7699. },
  7700. "image": {
  7701. "$ref": "#/components/schemas/RemoteImage"
  7702. },
  7703. "accessibilityTitle": {
  7704. "type": "string"
  7705. },
  7706. "caption": {
  7707. "$ref": "#/components/schemas/BannerCaption"
  7708. },
  7709. "overlayImages": {
  7710. "$ref": "#/components/schemas/BannerOverlayImages"
  7711. }
  7712. },
  7713. "required": [
  7714. "fingerprint",
  7715. "contentId",
  7716. "type",
  7717. "image",
  7718. "accessibilityTitle"
  7719. ]
  7720. },
  7721. "CarouselCategoryItem": {
  7722. "type": "object",
  7723. "properties": {
  7724. "fingerprint": {
  7725. "type": "string"
  7726. },
  7727. "contentId": {
  7728. "type": "string"
  7729. },
  7730. "tags": {
  7731. "type": "array",
  7732. "items": {
  7733. "type": "string"
  7734. }
  7735. },
  7736. "action": {
  7737. "$ref": "#/components/schemas/Action"
  7738. },
  7739. "type": {
  7740. "type": "string",
  7741. "enum": [
  7742. "CAROUSEL_CATEGORY_ITEM"
  7743. ]
  7744. },
  7745. "image": {
  7746. "$ref": "#/components/schemas/RemoteImage"
  7747. },
  7748. "title": {
  7749. "type": "string"
  7750. },
  7751. "accessibilityTitle": {
  7752. "type": "string"
  7753. }
  7754. },
  7755. "required": [
  7756. "fingerprint",
  7757. "contentId",
  7758. "type",
  7759. "image",
  7760. "title",
  7761. "accessibilityTitle"
  7762. ]
  7763. },
  7764. "CarouselProductReviewItem": {
  7765. "type": "object",
  7766. "properties": {
  7767. "fingerprint": {
  7768. "type": "string"
  7769. },
  7770. "contentId": {
  7771. "type": "string"
  7772. },
  7773. "tags": {
  7774. "type": "array",
  7775. "items": {
  7776. "type": "string"
  7777. }
  7778. },
  7779. "action": {
  7780. "$ref": "#/components/schemas/Action"
  7781. },
  7782. "type": {
  7783. "type": "string",
  7784. "enum": [
  7785. "CAROUSEL_PRODUCT_REVIEW_ITEM"
  7786. ]
  7787. },
  7788. "title": {
  7789. "type": "string"
  7790. },
  7791. "rating": {
  7792. "type": "number"
  7793. },
  7794. "body": {
  7795. "type": "string"
  7796. },
  7797. "description": {
  7798. "type": "string"
  7799. }
  7800. },
  7801. "required": [
  7802. "fingerprint",
  7803. "contentId",
  7804. "type",
  7805. "title",
  7806. "rating",
  7807. "body",
  7808. "description"
  7809. ]
  7810. },
  7811. "CarouselProductItem": {
  7812. "type": "object",
  7813. "properties": {
  7814. "fingerprint": {
  7815. "type": "string"
  7816. },
  7817. "contentId": {
  7818. "type": "string"
  7819. },
  7820. "tags": {
  7821. "type": "array",
  7822. "items": {
  7823. "type": "string"
  7824. }
  7825. },
  7826. "action": {
  7827. "$ref": "#/components/schemas/Action"
  7828. },
  7829. "title": {
  7830. "type": "string"
  7831. },
  7832. "prices": {
  7833. "$ref": "#/components/schemas/Prices"
  7834. },
  7835. "image": {
  7836. "$ref": "#/components/schemas/Image"
  7837. },
  7838. "variationIcon": {
  7839. "$ref": "#/components/schemas/LocalImage"
  7840. },
  7841. "favoriteAction": {
  7842. "$ref": "#/components/schemas/Action"
  7843. },
  7844. "unFavoriteAction": {
  7845. "$ref": "#/components/schemas/Action"
  7846. },
  7847. "primaryButton": {
  7848. "$ref": "#/components/schemas/Button"
  7849. },
  7850. "productId": {
  7851. "type": "string"
  7852. },
  7853. "actionSigningImage": {
  7854. "$ref": "#/components/schemas/Image"
  7855. },
  7856. "rating": {
  7857. "type": "number"
  7858. },
  7859. "importantInfo": {
  7860. "type": "string"
  7861. },
  7862. "quantityInfo": {
  7863. "type": "string"
  7864. },
  7865. "type": {
  7866. "type": "string",
  7867. "enum": [
  7868. "CAROUSEL_PRODUCT_ITEM"
  7869. ]
  7870. }
  7871. },
  7872. "required": [
  7873. "fingerprint",
  7874. "contentId",
  7875. "title",
  7876. "image",
  7877. "productId",
  7878. "type"
  7879. ]
  7880. },
  7881. "CarouselVoucherItem": {
  7882. "type": "object",
  7883. "properties": {
  7884. "fingerprint": {
  7885. "type": "string"
  7886. },
  7887. "contentId": {
  7888. "type": "string"
  7889. },
  7890. "tags": {
  7891. "type": "array",
  7892. "items": {
  7893. "type": "string"
  7894. }
  7895. },
  7896. "action": {
  7897. "$ref": "#/components/schemas/Action"
  7898. },
  7899. "displayType": {
  7900. "$ref": "#/components/schemas/VoucherDisplayType"
  7901. },
  7902. "points": {
  7903. "type": "number"
  7904. },
  7905. "pointsNeededPercentage": {
  7906. "type": "number"
  7907. },
  7908. "image": {
  7909. "$ref": "#/components/schemas/Image"
  7910. },
  7911. "title": {
  7912. "type": "string"
  7913. },
  7914. "subtitle": {
  7915. "type": "string"
  7916. },
  7917. "description": {
  7918. "type": "string"
  7919. },
  7920. "button": {
  7921. "$ref": "#/components/schemas/NormalButton"
  7922. },
  7923. "type": {
  7924. "type": "string",
  7925. "enum": [
  7926. "CAROUSEL_VOUCHER_ITEM"
  7927. ]
  7928. }
  7929. },
  7930. "required": [
  7931. "fingerprint",
  7932. "contentId",
  7933. "displayType",
  7934. "type"
  7935. ]
  7936. },
  7937. "CarouselViewAllItem": {
  7938. "type": "object",
  7939. "properties": {
  7940. "fingerprint": {
  7941. "type": "string"
  7942. },
  7943. "contentId": {
  7944. "type": "string"
  7945. },
  7946. "tags": {
  7947. "type": "array",
  7948. "items": {
  7949. "type": "string"
  7950. }
  7951. },
  7952. "type": {
  7953. "type": "string",
  7954. "enum": [
  7955. "CAROUSEL_VIEW_ALL_ITEM"
  7956. ]
  7957. },
  7958. "description": {
  7959. "type": "string"
  7960. },
  7961. "action": {
  7962. "$ref": "#/components/schemas/Action"
  7963. }
  7964. },
  7965. "required": [
  7966. "fingerprint",
  7967. "contentId",
  7968. "type",
  7969. "description",
  7970. "action"
  7971. ]
  7972. },
  7973. "TextCardComponent": {
  7974. "type": "object",
  7975. "properties": {
  7976. "fingerprint": {
  7977. "type": "string"
  7978. },
  7979. "contentId": {
  7980. "type": "string"
  7981. },
  7982. "tags": {
  7983. "type": "array",
  7984. "items": {
  7985. "type": "string"
  7986. }
  7987. },
  7988. "type": {
  7989. "type": "string",
  7990. "enum": [
  7991. "TEXT_CARD"
  7992. ]
  7993. },
  7994. "action": {
  7995. "$ref": "#/components/schemas/Action"
  7996. },
  7997. "title": {
  7998. "type": "string"
  7999. },
  8000. "description": {
  8001. "type": "string"
  8002. },
  8003. "highlightedDescription": {
  8004. "type": "string"
  8005. },
  8006. "icon": {
  8007. "$ref": "#/components/schemas/Image"
  8008. }
  8009. },
  8010. "required": [
  8011. "fingerprint",
  8012. "contentId",
  8013. "type"
  8014. ]
  8015. },
  8016. "ReviewSummaryComponent": {
  8017. "type": "object",
  8018. "properties": {
  8019. "fingerprint": {
  8020. "type": "string"
  8021. },
  8022. "contentId": {
  8023. "type": "string"
  8024. },
  8025. "tags": {
  8026. "type": "array",
  8027. "items": {
  8028. "type": "string"
  8029. }
  8030. },
  8031. "type": {
  8032. "type": "string",
  8033. "enum": [
  8034. "REVIEW_SUMMARY"
  8035. ]
  8036. },
  8037. "rating": {
  8038. "type": "number"
  8039. },
  8040. "label": {
  8041. "type": "string"
  8042. },
  8043. "action": {
  8044. "$ref": "#/components/schemas/Action"
  8045. }
  8046. },
  8047. "required": [
  8048. "fingerprint",
  8049. "contentId",
  8050. "type",
  8051. "rating"
  8052. ]
  8053. },
  8054. "ReviewDetailListItem": {
  8055. "type": "object",
  8056. "properties": {
  8057. "fingerprint": {
  8058. "type": "string"
  8059. },
  8060. "contentId": {
  8061. "type": "string"
  8062. },
  8063. "tags": {
  8064. "type": "array",
  8065. "items": {
  8066. "type": "string"
  8067. }
  8068. },
  8069. "action": {
  8070. "$ref": "#/components/schemas/Action"
  8071. },
  8072. "type": {
  8073. "type": "string",
  8074. "enum": [
  8075. "REVIEW_DETAIL_LIST_ITEM"
  8076. ]
  8077. },
  8078. "title": {
  8079. "type": "string"
  8080. },
  8081. "rating": {
  8082. "type": "number"
  8083. },
  8084. "recommendedByUser": {
  8085. "type": "boolean"
  8086. },
  8087. "recommendationLabel": {
  8088. "type": "string"
  8089. },
  8090. "body": {
  8091. "type": "string"
  8092. },
  8093. "description": {
  8094. "type": "string"
  8095. }
  8096. },
  8097. "required": [
  8098. "fingerprint",
  8099. "contentId",
  8100. "type",
  8101. "rating"
  8102. ]
  8103. },
  8104. "ProgressComponent": {
  8105. "type": "object",
  8106. "properties": {
  8107. "fingerprint": {
  8108. "type": "string"
  8109. },
  8110. "contentId": {
  8111. "type": "string"
  8112. },
  8113. "tags": {
  8114. "type": "array",
  8115. "items": {
  8116. "type": "string"
  8117. }
  8118. },
  8119. "type": {
  8120. "type": "string",
  8121. "enum": [
  8122. "PROGRESS"
  8123. ]
  8124. },
  8125. "title": {
  8126. "type": "string"
  8127. },
  8128. "progress": {
  8129. "type": "number"
  8130. },
  8131. "valueLabel": {
  8132. "type": "string"
  8133. }
  8134. },
  8135. "required": [
  8136. "fingerprint",
  8137. "contentId",
  8138. "type",
  8139. "progress"
  8140. ]
  8141. },
  8142. "BannerSize": {
  8143. "type": "string",
  8144. "enum": [
  8145. "VERY_SMALL",
  8146. "SMALL",
  8147. "LARGE",
  8148. "PORTRAIT"
  8149. ]
  8150. },
  8151. "BannerComponent": {
  8152. "type": "object",
  8153. "properties": {
  8154. "fingerprint": {
  8155. "type": "string"
  8156. },
  8157. "contentId": {
  8158. "type": "string"
  8159. },
  8160. "tags": {
  8161. "type": "array",
  8162. "items": {
  8163. "type": "string"
  8164. }
  8165. },
  8166. "type": {
  8167. "type": "string",
  8168. "enum": [
  8169. "BANNER"
  8170. ]
  8171. },
  8172. "size": {
  8173. "$ref": "#/components/schemas/BannerSize"
  8174. },
  8175. "image": {
  8176. "$ref": "#/components/schemas/RemoteImage"
  8177. },
  8178. "accessibilityTitle": {
  8179. "type": "string"
  8180. },
  8181. "action": {
  8182. "$ref": "#/components/schemas/Action"
  8183. },
  8184. "caption": {
  8185. "$ref": "#/components/schemas/BannerCaption"
  8186. },
  8187. "overlayImages": {
  8188. "$ref": "#/components/schemas/BannerOverlayImages"
  8189. }
  8190. },
  8191. "required": [
  8192. "fingerprint",
  8193. "contentId",
  8194. "type",
  8195. "size",
  8196. "image",
  8197. "accessibilityTitle"
  8198. ]
  8199. },
  8200. "BannerOverlayImages": {
  8201. "type": "object",
  8202. "properties": {
  8203. "topLeftImage": {
  8204. "$ref": "#/components/schemas/RemoteImage"
  8205. },
  8206. "topRightImage": {
  8207. "$ref": "#/components/schemas/RemoteImage"
  8208. },
  8209. "bottomLeftImage": {
  8210. "$ref": "#/components/schemas/RemoteImage"
  8211. },
  8212. "bottomRightImage": {
  8213. "$ref": "#/components/schemas/RemoteImage"
  8214. }
  8215. }
  8216. },
  8217. "ListGroupComponent": {
  8218. "type": "object",
  8219. "properties": {
  8220. "fingerprint": {
  8221. "type": "string"
  8222. },
  8223. "contentId": {
  8224. "type": "string"
  8225. },
  8226. "tags": {
  8227. "type": "array",
  8228. "items": {
  8229. "type": "string"
  8230. }
  8231. },
  8232. "type": {
  8233. "type": "string",
  8234. "enum": [
  8235. "LIST_GROUP"
  8236. ]
  8237. },
  8238. "title": {
  8239. "type": "string"
  8240. },
  8241. "items": {
  8242. "type": "array",
  8243. "items": {
  8244. "$ref": "#/components/schemas/ListGroupItem"
  8245. }
  8246. },
  8247. "action": {
  8248. "$ref": "#/components/schemas/Action"
  8249. },
  8250. "actionLabel": {
  8251. "type": "string"
  8252. },
  8253. "actionIcon": {
  8254. "$ref": "#/components/schemas/Image"
  8255. }
  8256. },
  8257. "required": [
  8258. "fingerprint",
  8259. "contentId",
  8260. "type",
  8261. "items"
  8262. ]
  8263. },
  8264. "ListGroupItem": {
  8265. "type": "object",
  8266. "properties": {
  8267. "fingerprint": {
  8268. "type": "string"
  8269. },
  8270. "contentId": {
  8271. "type": "string"
  8272. },
  8273. "tags": {
  8274. "type": "array",
  8275. "items": {
  8276. "type": "string"
  8277. }
  8278. },
  8279. "title": {
  8280. "type": "string"
  8281. },
  8282. "action": {
  8283. "$ref": "#/components/schemas/Action"
  8284. },
  8285. "image": {
  8286. "$ref": "#/components/schemas/Image"
  8287. }
  8288. },
  8289. "required": [
  8290. "fingerprint",
  8291. "contentId",
  8292. "title"
  8293. ]
  8294. },
  8295. "LoaderComponentDisplayType": {
  8296. "type": "string",
  8297. "enum": [
  8298. "PDP_CONTENT",
  8299. "PLP_CONTENT",
  8300. "ORDER_DETAILS_CONTENT",
  8301. "VARIATION_PRODUCT_LIST_ITEM"
  8302. ]
  8303. },
  8304. "LoaderComponent": {
  8305. "type": "object",
  8306. "properties": {
  8307. "fingerprint": {
  8308. "type": "string"
  8309. },
  8310. "contentId": {
  8311. "type": "string"
  8312. },
  8313. "tags": {
  8314. "type": "array",
  8315. "items": {
  8316. "type": "string"
  8317. }
  8318. },
  8319. "type": {
  8320. "type": "string",
  8321. "enum": [
  8322. "LOADER"
  8323. ]
  8324. },
  8325. "displayType": {
  8326. "$ref": "#/components/schemas/LoaderComponentDisplayType"
  8327. }
  8328. },
  8329. "required": [
  8330. "fingerprint",
  8331. "contentId",
  8332. "type",
  8333. "displayType"
  8334. ]
  8335. },
  8336. "OrderStatusTitleStyle": {
  8337. "type": "string",
  8338. "enum": [
  8339. "NORMAL",
  8340. "WARNING"
  8341. ]
  8342. },
  8343. "OrderStatusPlaceholderComponent": {
  8344. "type": "object",
  8345. "properties": {
  8346. "fingerprint": {
  8347. "type": "string"
  8348. },
  8349. "contentId": {
  8350. "type": "string"
  8351. },
  8352. "tags": {
  8353. "type": "array",
  8354. "items": {
  8355. "type": "string"
  8356. }
  8357. },
  8358. "type": {
  8359. "type": "string",
  8360. "enum": [
  8361. "ORDER_STATUS_PLACEHOLDER"
  8362. ]
  8363. },
  8364. "componentPath": {
  8365. "type": "string"
  8366. },
  8367. "title": {
  8368. "type": "string"
  8369. }
  8370. },
  8371. "required": [
  8372. "fingerprint",
  8373. "contentId",
  8374. "type",
  8375. "componentPath",
  8376. "title"
  8377. ]
  8378. },
  8379. "OrderStatusComponent": {
  8380. "type": "object",
  8381. "properties": {
  8382. "fingerprint": {
  8383. "type": "string"
  8384. },
  8385. "contentId": {
  8386. "type": "string"
  8387. },
  8388. "tags": {
  8389. "type": "array",
  8390. "items": {
  8391. "type": "string"
  8392. }
  8393. },
  8394. "type": {
  8395. "type": "string",
  8396. "enum": [
  8397. "ORDER_STATUS"
  8398. ]
  8399. },
  8400. "title": {
  8401. "type": "string"
  8402. },
  8403. "shipments": {
  8404. "type": "array",
  8405. "items": {
  8406. "$ref": "#/components/schemas/OrderStatusShipment"
  8407. }
  8408. }
  8409. },
  8410. "required": [
  8411. "fingerprint",
  8412. "contentId",
  8413. "type",
  8414. "shipments"
  8415. ]
  8416. },
  8417. "OrderStatusShipment": {
  8418. "type": "object",
  8419. "properties": {
  8420. "fingerprint": {
  8421. "type": "string"
  8422. },
  8423. "contentId": {
  8424. "type": "string"
  8425. },
  8426. "tags": {
  8427. "type": "array",
  8428. "items": {
  8429. "type": "string"
  8430. }
  8431. },
  8432. "action": {
  8433. "$ref": "#/components/schemas/Action"
  8434. },
  8435. "type": {
  8436. "type": "string",
  8437. "enum": [
  8438. "ORDER_STATUS_SHIPMENT_CARD"
  8439. ]
  8440. },
  8441. "title": {
  8442. "type": "string"
  8443. },
  8444. "titleStyle": {
  8445. "$ref": "#/components/schemas/OrderStatusTitleStyle"
  8446. },
  8447. "body": {
  8448. "type": "string"
  8449. },
  8450. "accessibilityDescription": {
  8451. "type": "string"
  8452. },
  8453. "pickupLocationThumbnail": {
  8454. "$ref": "#/components/schemas/LocalImage"
  8455. },
  8456. "button": {
  8457. "$ref": "#/components/schemas/PlainButton"
  8458. }
  8459. },
  8460. "required": [
  8461. "fingerprint",
  8462. "contentId",
  8463. "type",
  8464. "title",
  8465. "titleStyle",
  8466. "body"
  8467. ]
  8468. },
  8469. "LoyaltyPointsComponent": {
  8470. "type": "object",
  8471. "properties": {
  8472. "fingerprint": {
  8473. "type": "string"
  8474. },
  8475. "contentId": {
  8476. "type": "string"
  8477. },
  8478. "tags": {
  8479. "type": "array",
  8480. "items": {
  8481. "type": "string"
  8482. }
  8483. },
  8484. "type": {
  8485. "type": "string",
  8486. "enum": [
  8487. "LOYALTY_POINTS"
  8488. ]
  8489. },
  8490. "currentBalance": {
  8491. "type": "number"
  8492. },
  8493. "button": {
  8494. "$ref": "#/components/schemas/TextButton"
  8495. }
  8496. },
  8497. "required": [
  8498. "fingerprint",
  8499. "contentId",
  8500. "type",
  8501. "currentBalance"
  8502. ]
  8503. },
  8504. "SignupCardComponent": {
  8505. "type": "object",
  8506. "properties": {
  8507. "fingerprint": {
  8508. "type": "string"
  8509. },
  8510. "contentId": {
  8511. "type": "string"
  8512. },
  8513. "tags": {
  8514. "type": "array",
  8515. "items": {
  8516. "type": "string"
  8517. }
  8518. },
  8519. "type": {
  8520. "type": "string",
  8521. "enum": [
  8522. "SIGNUP_CARD"
  8523. ]
  8524. },
  8525. "title": {
  8526. "type": "string"
  8527. },
  8528. "subtitle": {
  8529. "type": "string"
  8530. },
  8531. "usps": {
  8532. "type": "array",
  8533. "items": {
  8534. "type": "string"
  8535. }
  8536. },
  8537. "button": {
  8538. "$ref": "#/components/schemas/NormalButton"
  8539. }
  8540. },
  8541. "required": [
  8542. "fingerprint",
  8543. "contentId",
  8544. "type",
  8545. "title",
  8546. "subtitle",
  8547. "usps",
  8548. "button"
  8549. ]
  8550. },
  8551. "VoucherItemComponent": {
  8552. "type": "object",
  8553. "properties": {
  8554. "fingerprint": {
  8555. "type": "string"
  8556. },
  8557. "contentId": {
  8558. "type": "string"
  8559. },
  8560. "tags": {
  8561. "type": "array",
  8562. "items": {
  8563. "type": "string"
  8564. }
  8565. },
  8566. "displayType": {
  8567. "$ref": "#/components/schemas/VoucherDisplayType"
  8568. },
  8569. "points": {
  8570. "type": "number"
  8571. },
  8572. "pointsNeededPercentage": {
  8573. "type": "number"
  8574. },
  8575. "image": {
  8576. "$ref": "#/components/schemas/Image"
  8577. },
  8578. "title": {
  8579. "type": "string"
  8580. },
  8581. "subtitle": {
  8582. "type": "string"
  8583. },
  8584. "description": {
  8585. "type": "string"
  8586. },
  8587. "button": {
  8588. "$ref": "#/components/schemas/NormalButton"
  8589. },
  8590. "type": {
  8591. "type": "string",
  8592. "enum": [
  8593. "VOUCHER_ITEM"
  8594. ]
  8595. }
  8596. },
  8597. "required": [
  8598. "fingerprint",
  8599. "contentId",
  8600. "displayType",
  8601. "type"
  8602. ]
  8603. },
  8604. "ExpandableInfoBulletList": {
  8605. "type": "object",
  8606. "properties": {
  8607. "style": {
  8608. "type": "string",
  8609. "enum": [
  8610. "CHECKMARK",
  8611. "DOT",
  8612. "NUMERIC"
  8613. ]
  8614. },
  8615. "items": {
  8616. "type": "array",
  8617. "items": {
  8618. "type": "string"
  8619. }
  8620. },
  8621. "title": {
  8622. "type": "string"
  8623. }
  8624. },
  8625. "required": [
  8626. "style",
  8627. "items"
  8628. ]
  8629. },
  8630. "ExpandableInfoComponent": {
  8631. "type": "object",
  8632. "properties": {
  8633. "fingerprint": {
  8634. "type": "string"
  8635. },
  8636. "contentId": {
  8637. "type": "string"
  8638. },
  8639. "tags": {
  8640. "type": "array",
  8641. "items": {
  8642. "type": "string"
  8643. }
  8644. },
  8645. "type": {
  8646. "type": "string",
  8647. "enum": [
  8648. "EXPANDABLE_INFO"
  8649. ]
  8650. },
  8651. "title": {
  8652. "type": "string"
  8653. },
  8654. "info": {
  8655. "type": "object",
  8656. "properties": {
  8657. "body": {
  8658. "type": "string"
  8659. },
  8660. "bulletLists": {
  8661. "type": "array",
  8662. "items": {
  8663. "$ref": "#/components/schemas/ExpandableInfoBulletList"
  8664. }
  8665. }
  8666. }
  8667. }
  8668. },
  8669. "required": [
  8670. "fingerprint",
  8671. "contentId",
  8672. "type",
  8673. "title",
  8674. "info"
  8675. ]
  8676. },
  8677. "LoyaltySummaryComponent": {
  8678. "type": "object",
  8679. "properties": {
  8680. "fingerprint": {
  8681. "type": "string"
  8682. },
  8683. "contentId": {
  8684. "type": "string"
  8685. },
  8686. "tags": {
  8687. "type": "array",
  8688. "items": {
  8689. "type": "string"
  8690. }
  8691. },
  8692. "type": {
  8693. "type": "string",
  8694. "enum": [
  8695. "LOYALTY_SUMMARY"
  8696. ]
  8697. },
  8698. "action": {
  8699. "$ref": "#/components/schemas/Action"
  8700. }
  8701. },
  8702. "required": [
  8703. "fingerprint",
  8704. "contentId",
  8705. "type",
  8706. "action"
  8707. ]
  8708. },
  8709. "EmptyListComponent": {
  8710. "type": "object",
  8711. "properties": {
  8712. "fingerprint": {
  8713. "type": "string"
  8714. },
  8715. "contentId": {
  8716. "type": "string"
  8717. },
  8718. "tags": {
  8719. "type": "array",
  8720. "items": {
  8721. "type": "string"
  8722. }
  8723. },
  8724. "type": {
  8725. "type": "string",
  8726. "enum": [
  8727. "EMPTY"
  8728. ]
  8729. },
  8730. "text": {
  8731. "type": "string"
  8732. },
  8733. "image": {
  8734. "$ref": "#/components/schemas/Image"
  8735. }
  8736. },
  8737. "required": [
  8738. "fingerprint",
  8739. "contentId",
  8740. "type",
  8741. "text",
  8742. "image"
  8743. ]
  8744. },
  8745. "PriceLineTextDisplayType": {
  8746. "type": "string",
  8747. "enum": [
  8748. "NORMAL",
  8749. "HIGHLIGHTED",
  8750. "EMPHASISED"
  8751. ]
  8752. },
  8753. "PriceLineTextStringValue": {
  8754. "type": "object",
  8755. "properties": {
  8756. "type": {
  8757. "type": "string",
  8758. "enum": [
  8759. "STRING"
  8760. ]
  8761. },
  8762. "value": {
  8763. "type": "string"
  8764. }
  8765. },
  8766. "required": [
  8767. "type",
  8768. "value"
  8769. ]
  8770. },
  8771. "PriceLineTextPriceValue": {
  8772. "type": "object",
  8773. "properties": {
  8774. "type": {
  8775. "type": "string",
  8776. "enum": [
  8777. "PRICE"
  8778. ]
  8779. },
  8780. "value": {
  8781. "$ref": "#/components/schemas/FormattedPrice"
  8782. }
  8783. },
  8784. "required": [
  8785. "type",
  8786. "value"
  8787. ]
  8788. },
  8789. "PriceLineTextComponent": {
  8790. "type": "object",
  8791. "properties": {
  8792. "fingerprint": {
  8793. "type": "string"
  8794. },
  8795. "contentId": {
  8796. "type": "string"
  8797. },
  8798. "tags": {
  8799. "type": "array",
  8800. "items": {
  8801. "type": "string"
  8802. }
  8803. },
  8804. "type": {
  8805. "type": "string",
  8806. "enum": [
  8807. "PRICE_LINE_TEXT"
  8808. ]
  8809. },
  8810. "text": {
  8811. "type": "string"
  8812. },
  8813. "value": {
  8814. "oneOf": [
  8815. {
  8816. "$ref": "#/components/schemas/PriceLineTextStringValue"
  8817. },
  8818. {
  8819. "$ref": "#/components/schemas/PriceLineTextPriceValue"
  8820. }
  8821. ]
  8822. },
  8823. "displayType": {
  8824. "$ref": "#/components/schemas/PriceLineTextDisplayType"
  8825. },
  8826. "accessibilityDescription": {
  8827. "type": "string"
  8828. }
  8829. },
  8830. "required": [
  8831. "fingerprint",
  8832. "contentId",
  8833. "type",
  8834. "text",
  8835. "value",
  8836. "displayType",
  8837. "accessibilityDescription"
  8838. ]
  8839. },
  8840. "OrderDetailStatus": {
  8841. "type": "object",
  8842. "properties": {
  8843. "title": {
  8844. "type": "string"
  8845. },
  8846. "body": {
  8847. "type": "string"
  8848. },
  8849. "icon": {
  8850. "$ref": "#/components/schemas/LocalImage"
  8851. },
  8852. "accessibilityDescription": {
  8853. "type": "string"
  8854. }
  8855. },
  8856. "required": [
  8857. "title",
  8858. "body",
  8859. "icon",
  8860. "accessibilityDescription"
  8861. ]
  8862. },
  8863. "OrderDetailStatusComponent": {
  8864. "type": "object",
  8865. "properties": {
  8866. "fingerprint": {
  8867. "type": "string"
  8868. },
  8869. "contentId": {
  8870. "type": "string"
  8871. },
  8872. "tags": {
  8873. "type": "array",
  8874. "items": {
  8875. "type": "string"
  8876. }
  8877. },
  8878. "type": {
  8879. "type": "string",
  8880. "enum": [
  8881. "ORDER_DETAIL_STATUS"
  8882. ]
  8883. },
  8884. "status": {
  8885. "$ref": "#/components/schemas/OrderDetailStatus"
  8886. }
  8887. },
  8888. "required": [
  8889. "fingerprint",
  8890. "contentId",
  8891. "type",
  8892. "status"
  8893. ]
  8894. },
  8895. "QRCodeComponent": {
  8896. "type": "object",
  8897. "properties": {
  8898. "fingerprint": {
  8899. "type": "string"
  8900. },
  8901. "contentId": {
  8902. "type": "string"
  8903. },
  8904. "tags": {
  8905. "type": "array",
  8906. "items": {
  8907. "type": "string"
  8908. }
  8909. },
  8910. "type": {
  8911. "type": "string",
  8912. "enum": [
  8913. "QR_CODE"
  8914. ]
  8915. },
  8916. "description": {
  8917. "type": "string"
  8918. },
  8919. "code": {
  8920. "type": "string"
  8921. }
  8922. },
  8923. "required": [
  8924. "fingerprint",
  8925. "contentId",
  8926. "type",
  8927. "description",
  8928. "code"
  8929. ]
  8930. },
  8931. "BarcodeComponent": {
  8932. "type": "object",
  8933. "properties": {
  8934. "fingerprint": {
  8935. "type": "string"
  8936. },
  8937. "contentId": {
  8938. "type": "string"
  8939. },
  8940. "tags": {
  8941. "type": "array",
  8942. "items": {
  8943. "type": "string"
  8944. }
  8945. },
  8946. "type": {
  8947. "type": "string",
  8948. "enum": [
  8949. "BARCODE"
  8950. ]
  8951. },
  8952. "description": {
  8953. "type": "string"
  8954. },
  8955. "code": {
  8956. "$ref": "#/components/schemas/Barcode"
  8957. }
  8958. },
  8959. "required": [
  8960. "fingerprint",
  8961. "contentId",
  8962. "type",
  8963. "description",
  8964. "code"
  8965. ]
  8966. },
  8967. "Barcode": {
  8968. "type": "object",
  8969. "properties": {
  8970. "codeType": {
  8971. "type": "string",
  8972. "enum": [
  8973. "CODE_128"
  8974. ]
  8975. },
  8976. "value": {
  8977. "type": "string"
  8978. }
  8979. },
  8980. "required": [
  8981. "codeType",
  8982. "value"
  8983. ]
  8984. },
  8985. "ProductStoreStockComponent": {
  8986. "type": "object",
  8987. "properties": {
  8988. "fingerprint": {
  8989. "type": "string"
  8990. },
  8991. "contentId": {
  8992. "type": "string"
  8993. },
  8994. "tags": {
  8995. "type": "array",
  8996. "items": {
  8997. "type": "string"
  8998. }
  8999. },
  9000. "type": {
  9001. "type": "string",
  9002. "enum": [
  9003. "PRODUCT_STORE_STOCK"
  9004. ]
  9005. },
  9006. "subject": {
  9007. "type": "string"
  9008. },
  9009. "title": {
  9010. "type": "string"
  9011. },
  9012. "subtitle": {
  9013. "type": "string"
  9014. },
  9015. "description": {
  9016. "type": "string"
  9017. },
  9018. "indicatorStyle": {
  9019. "$ref": "#/components/schemas/ProductStoreStockIndicatorStyle"
  9020. },
  9021. "accessibilityDescription": {
  9022. "type": "string"
  9023. }
  9024. },
  9025. "required": [
  9026. "fingerprint",
  9027. "contentId",
  9028. "type",
  9029. "title",
  9030. "subtitle",
  9031. "description",
  9032. "indicatorStyle",
  9033. "accessibilityDescription"
  9034. ]
  9035. },
  9036. "ProductStoreStockIndicatorStyle": {
  9037. "type": "string",
  9038. "enum": [
  9039. "NO_STOCK",
  9040. "LIMITED_STOCK",
  9041. "IN_STOCK"
  9042. ]
  9043. },
  9044. "BasketVoucherComponent": {
  9045. "type": "object",
  9046. "properties": {
  9047. "fingerprint": {
  9048. "type": "string"
  9049. },
  9050. "contentId": {
  9051. "type": "string"
  9052. },
  9053. "tags": {
  9054. "type": "array",
  9055. "items": {
  9056. "type": "string"
  9057. }
  9058. },
  9059. "type": {
  9060. "type": "string",
  9061. "enum": [
  9062. "BASKET_VOUCHER"
  9063. ]
  9064. },
  9065. "image": {
  9066. "$ref": "#/components/schemas/RemoteImage"
  9067. },
  9068. "title": {
  9069. "type": "string"
  9070. },
  9071. "description": {
  9072. "type": "string"
  9073. },
  9074. "button": {
  9075. "$ref": "#/components/schemas/SwitchButton"
  9076. },
  9077. "errorMessage": {
  9078. "type": "string"
  9079. }
  9080. },
  9081. "required": [
  9082. "fingerprint",
  9083. "contentId",
  9084. "type",
  9085. "image",
  9086. "title",
  9087. "description",
  9088. "button"
  9089. ]
  9090. },
  9091. "AddCoupon": {
  9092. "type": "object",
  9093. "properties": {
  9094. "type": {
  9095. "type": "string",
  9096. "enum": [
  9097. "ADD_COUPON"
  9098. ]
  9099. },
  9100. "textFieldPlaceholder": {
  9101. "type": "string"
  9102. },
  9103. "button": {
  9104. "$ref": "#/components/schemas/NormalButton"
  9105. },
  9106. "noticeText": {
  9107. "type": "string"
  9108. }
  9109. },
  9110. "required": [
  9111. "type",
  9112. "textFieldPlaceholder",
  9113. "button"
  9114. ]
  9115. },
  9116. "ActiveCoupon": {
  9117. "type": "object",
  9118. "properties": {
  9119. "type": {
  9120. "type": "string",
  9121. "enum": [
  9122. "ACTIVE_COUPON"
  9123. ]
  9124. },
  9125. "title": {
  9126. "type": "string"
  9127. },
  9128. "body": {
  9129. "type": "string"
  9130. },
  9131. "action": {
  9132. "$ref": "#/components/schemas/Action"
  9133. },
  9134. "errorMessage": {
  9135. "type": "string"
  9136. }
  9137. },
  9138. "required": [
  9139. "type",
  9140. "title",
  9141. "body",
  9142. "action"
  9143. ]
  9144. },
  9145. "BasketCouponComponent": {
  9146. "type": "object",
  9147. "properties": {
  9148. "fingerprint": {
  9149. "type": "string"
  9150. },
  9151. "contentId": {
  9152. "type": "string"
  9153. },
  9154. "tags": {
  9155. "type": "array",
  9156. "items": {
  9157. "type": "string"
  9158. }
  9159. },
  9160. "type": {
  9161. "type": "string",
  9162. "enum": [
  9163. "BASKET_COUPON"
  9164. ]
  9165. },
  9166. "title": {
  9167. "type": "string"
  9168. },
  9169. "couponState": {
  9170. "oneOf": [
  9171. {
  9172. "$ref": "#/components/schemas/ActiveCoupon"
  9173. },
  9174. {
  9175. "$ref": "#/components/schemas/AddCoupon"
  9176. }
  9177. ]
  9178. }
  9179. },
  9180. "required": [
  9181. "fingerprint",
  9182. "contentId",
  9183. "type",
  9184. "title",
  9185. "couponState"
  9186. ]
  9187. },
  9188. "DonationInputComponent": {
  9189. "type": "object",
  9190. "properties": {
  9191. "fingerprint": {
  9192. "type": "string"
  9193. },
  9194. "contentId": {
  9195. "type": "string"
  9196. },
  9197. "tags": {
  9198. "type": "array",
  9199. "items": {
  9200. "type": "string"
  9201. }
  9202. },
  9203. "type": {
  9204. "type": "string",
  9205. "enum": [
  9206. "DONATION_INPUT"
  9207. ]
  9208. },
  9209. "textFieldPlaceholder": {
  9210. "type": "string"
  9211. },
  9212. "button": {
  9213. "$ref": "#/components/schemas/NormalButton"
  9214. }
  9215. },
  9216. "required": [
  9217. "fingerprint",
  9218. "contentId",
  9219. "type",
  9220. "textFieldPlaceholder",
  9221. "button"
  9222. ]
  9223. },
  9224. "PrimaryMenuItemComponent": {
  9225. "type": "object",
  9226. "properties": {
  9227. "fingerprint": {
  9228. "type": "string"
  9229. },
  9230. "contentId": {
  9231. "type": "string"
  9232. },
  9233. "tags": {
  9234. "type": "array",
  9235. "items": {
  9236. "type": "string"
  9237. }
  9238. },
  9239. "type": {
  9240. "type": "string",
  9241. "enum": [
  9242. "PRIMARY_MENU_ITEM"
  9243. ]
  9244. },
  9245. "title": {
  9246. "type": "string"
  9247. },
  9248. "subtitle": {
  9249. "type": "string"
  9250. },
  9251. "image": {
  9252. "$ref": "#/components/schemas/LocalImage"
  9253. },
  9254. "action": {
  9255. "$ref": "#/components/schemas/Action"
  9256. }
  9257. },
  9258. "required": [
  9259. "fingerprint",
  9260. "contentId",
  9261. "type",
  9262. "title",
  9263. "image"
  9264. ]
  9265. },
  9266. "SecondaryMenuItemComponent": {
  9267. "type": "object",
  9268. "properties": {
  9269. "fingerprint": {
  9270. "type": "string"
  9271. },
  9272. "contentId": {
  9273. "type": "string"
  9274. },
  9275. "tags": {
  9276. "type": "array",
  9277. "items": {
  9278. "type": "string"
  9279. }
  9280. },
  9281. "type": {
  9282. "type": "string",
  9283. "enum": [
  9284. "SECONDARY_MENU_ITEM"
  9285. ]
  9286. },
  9287. "title": {
  9288. "type": "string"
  9289. },
  9290. "image": {
  9291. "$ref": "#/components/schemas/LocalImage"
  9292. },
  9293. "action": {
  9294. "$ref": "#/components/schemas/Action"
  9295. }
  9296. },
  9297. "required": [
  9298. "fingerprint",
  9299. "contentId",
  9300. "type",
  9301. "title",
  9302. "image"
  9303. ]
  9304. },
  9305. "AppEnvironmentComponent": {
  9306. "type": "object",
  9307. "properties": {
  9308. "fingerprint": {
  9309. "type": "string"
  9310. },
  9311. "contentId": {
  9312. "type": "string"
  9313. },
  9314. "tags": {
  9315. "type": "array",
  9316. "items": {
  9317. "type": "string"
  9318. }
  9319. },
  9320. "type": {
  9321. "type": "string",
  9322. "enum": [
  9323. "APP_ENVIRONMENT"
  9324. ]
  9325. }
  9326. },
  9327. "required": [
  9328. "fingerprint",
  9329. "contentId",
  9330. "type"
  9331. ]
  9332. },
  9333. "Component": {
  9334. "oneOf": [
  9335. {
  9336. "$ref": "#/components/schemas/BannerComponent"
  9337. },
  9338. {
  9339. "$ref": "#/components/schemas/BasketProductListItem"
  9340. },
  9341. {
  9342. "$ref": "#/components/schemas/BasketCouponComponent"
  9343. },
  9344. {
  9345. "$ref": "#/components/schemas/BarcodeComponent"
  9346. },
  9347. {
  9348. "$ref": "#/components/schemas/BasketVoucherComponent"
  9349. },
  9350. {
  9351. "$ref": "#/components/schemas/BulletListComponent"
  9352. },
  9353. {
  9354. "$ref": "#/components/schemas/SpacerComponent"
  9355. },
  9356. {
  9357. "$ref": "#/components/schemas/ButtonsComponent"
  9358. },
  9359. {
  9360. "$ref": "#/components/schemas/ActionTextListItem"
  9361. },
  9362. {
  9363. "$ref": "#/components/schemas/DefinitionListComponent"
  9364. },
  9365. {
  9366. "$ref": "#/components/schemas/ExpandableInfoComponent"
  9367. },
  9368. {
  9369. "$ref": "#/components/schemas/EmptyListComponent"
  9370. },
  9371. {
  9372. "$ref": "#/components/schemas/FavoriteListItem"
  9373. },
  9374. {
  9375. "$ref": "#/components/schemas/ImageCollectionComponent"
  9376. },
  9377. {
  9378. "$ref": "#/components/schemas/InfoMessageComponent"
  9379. },
  9380. {
  9381. "$ref": "#/components/schemas/ListGroupComponent"
  9382. },
  9383. {
  9384. "$ref": "#/components/schemas/LoaderComponent"
  9385. },
  9386. {
  9387. "$ref": "#/components/schemas/LoyaltyPointsComponent"
  9388. },
  9389. {
  9390. "$ref": "#/components/schemas/LoyaltySummaryComponent"
  9391. },
  9392. {
  9393. "$ref": "#/components/schemas/OrderStatusComponent"
  9394. },
  9395. {
  9396. "$ref": "#/components/schemas/OrderStatusPlaceholderComponent"
  9397. },
  9398. {
  9399. "$ref": "#/components/schemas/ParagraphComponent"
  9400. },
  9401. {
  9402. "$ref": "#/components/schemas/PlainListItem"
  9403. },
  9404. {
  9405. "$ref": "#/components/schemas/PlainProductListItem"
  9406. },
  9407. {
  9408. "$ref": "#/components/schemas/PlainTextListItem"
  9409. },
  9410. {
  9411. "$ref": "#/components/schemas/PlpListItem"
  9412. },
  9413. {
  9414. "$ref": "#/components/schemas/ProductStoreStockComponent"
  9415. },
  9416. {
  9417. "$ref": "#/components/schemas/ProgressComponent"
  9418. },
  9419. {
  9420. "$ref": "#/components/schemas/PriceLineTextComponent"
  9421. },
  9422. {
  9423. "$ref": "#/components/schemas/QRCodeListItem"
  9424. },
  9425. {
  9426. "$ref": "#/components/schemas/QRCodeComponent"
  9427. },
  9428. {
  9429. "$ref": "#/components/schemas/ReviewDetailListItem"
  9430. },
  9431. {
  9432. "$ref": "#/components/schemas/ReviewSummaryComponent"
  9433. },
  9434. {
  9435. "$ref": "#/components/schemas/SignupCardComponent"
  9436. },
  9437. {
  9438. "$ref": "#/components/schemas/TextCardComponent"
  9439. },
  9440. {
  9441. "$ref": "#/components/schemas/TitleComponent"
  9442. },
  9443. {
  9444. "$ref": "#/components/schemas/TwoColumnTableComponent"
  9445. },
  9446. {
  9447. "$ref": "#/components/schemas/VariationListItem"
  9448. },
  9449. {
  9450. "$ref": "#/components/schemas/VariationProductListItem"
  9451. },
  9452. {
  9453. "$ref": "#/components/schemas/VoucherItemComponent"
  9454. },
  9455. {
  9456. "$ref": "#/components/schemas/ImageComponent"
  9457. },
  9458. {
  9459. "$ref": "#/components/schemas/OrderSummaryListItem"
  9460. },
  9461. {
  9462. "$ref": "#/components/schemas/OrderProductListItem"
  9463. },
  9464. {
  9465. "$ref": "#/components/schemas/OrderDetailStatusComponent"
  9466. },
  9467. {
  9468. "$ref": "#/components/schemas/DonationInputComponent"
  9469. },
  9470. {
  9471. "$ref": "#/components/schemas/PrimaryMenuItemComponent"
  9472. },
  9473. {
  9474. "$ref": "#/components/schemas/SecondaryMenuItemComponent"
  9475. },
  9476. {
  9477. "$ref": "#/components/schemas/AppEnvironmentComponent"
  9478. },
  9479. {
  9480. "$ref": "#/components/schemas/SearchBarComponentExperiment"
  9481. }
  9482. ]
  9483. },
  9484. "Image": {
  9485. "oneOf": [
  9486. {
  9487. "$ref": "#/components/schemas/LocalImage"
  9488. },
  9489. {
  9490. "$ref": "#/components/schemas/RemoteImage"
  9491. }
  9492. ]
  9493. },
  9494. "LocalImage": {
  9495. "type": "object",
  9496. "properties": {
  9497. "type": {
  9498. "type": "string",
  9499. "enum": [
  9500. "LOCAL"
  9501. ]
  9502. },
  9503. "name": {
  9504. "type": "string",
  9505. "enum": [
  9506. "IMAGE_BALLOON_HEART",
  9507. "NOT_AVAILABLE",
  9508. "PAYMENT_OPTIONS",
  9509. "BASKET_ICON",
  9510. "COOKIES_ICON",
  9511. "GLOBE_ICON",
  9512. "LOCATION_ICON",
  9513. "NOTIFICATION_ICON",
  9514. "DOCUMENT_ICON",
  9515. "IMAGE_DELIVERY_SHOP",
  9516. "IMAGE_DELIVERY_CAR",
  9517. "IMAGE_CRATE_EMPTY",
  9518. "IMAGE_BALLOON_TEXT_EMPTY",
  9519. "SIZE",
  9520. "ADD_ROUNDED",
  9521. "CALCULATE_QUOTATION",
  9522. "STORE",
  9523. "EDIT_CAKE",
  9524. "COLOR_WHEEL",
  9525. "IMAGE_BUCKET",
  9526. "FILTER",
  9527. "PROCESSING",
  9528. "PACKAGE",
  9529. "ERROR",
  9530. "CHECKMARK",
  9531. "CHECKMARK_THIN",
  9532. "BANNER_HOME_FALLBACK",
  9533. "ANDROID_NAVIGATION_NEXT",
  9534. "EXTERNAL_LINK",
  9535. "SHARE",
  9536. "COPY",
  9537. "REMOVE",
  9538. "DELETE",
  9539. "HEMA_LOGO",
  9540. "SIGN_OUT",
  9541. "CUSTOMER_SERVICE_PHONE",
  9542. "CUSTOMER_SERVICE_TWITTER",
  9543. "CUSTOMER_SERVICE_FB_MESSENGER",
  9544. "CUSTOMER_SERVICE_CHAT",
  9545. "ACCOUNT_FAVORITES",
  9546. "ACCOUNT_ORDERS",
  9547. "ACCOUNT_VOUCHERS",
  9548. "ACCOUNT_PROFILE",
  9549. "HOME_CUSTOMER_SERVICE",
  9550. "HOME_RECALL",
  9551. "HOME_SCANNER",
  9552. "HOME_EXTERNAL_LINK",
  9553. "SEARCH_SCANNER",
  9554. "PROMOTION",
  9555. "VOUCHER",
  9556. "FOLDER",
  9557. "CIRCLE_PLUS",
  9558. "SEARCH",
  9559. "CATEGORY"
  9560. ]
  9561. },
  9562. "alt": {
  9563. "type": "string"
  9564. }
  9565. },
  9566. "required": [
  9567. "type",
  9568. "name"
  9569. ]
  9570. },
  9571. "RemoteImage": {
  9572. "type": "object",
  9573. "properties": {
  9574. "type": {
  9575. "type": "string",
  9576. "enum": [
  9577. "REMOTE"
  9578. ]
  9579. },
  9580. "url": {
  9581. "type": "string"
  9582. },
  9583. "alt": {
  9584. "type": "string"
  9585. },
  9586. "width": {
  9587. "type": "number"
  9588. },
  9589. "height": {
  9590. "type": "number"
  9591. }
  9592. },
  9593. "required": [
  9594. "type",
  9595. "url"
  9596. ]
  9597. },
  9598. "Button": {
  9599. "oneOf": [
  9600. {
  9601. "$ref": "#/components/schemas/NormalButton"
  9602. },
  9603. {
  9604. "$ref": "#/components/schemas/SelectionButton"
  9605. },
  9606. {
  9607. "$ref": "#/components/schemas/PlainButton"
  9608. },
  9609. {
  9610. "$ref": "#/components/schemas/TextButton"
  9611. },
  9612. {
  9613. "$ref": "#/components/schemas/SetBasketItemButton"
  9614. },
  9615. {
  9616. "$ref": "#/components/schemas/SwitchButton"
  9617. }
  9618. ]
  9619. },
  9620. "ButtonBase": {
  9621. "type": "object",
  9622. "properties": {
  9623. "id": {
  9624. "type": "string"
  9625. },
  9626. "loadingIds": {
  9627. "type": "array",
  9628. "items": {
  9629. "type": "string"
  9630. }
  9631. },
  9632. "tags": {
  9633. "type": "array",
  9634. "items": {
  9635. "type": "string"
  9636. }
  9637. },
  9638. "action": {
  9639. "$ref": "#/components/schemas/Action"
  9640. }
  9641. },
  9642. "required": [
  9643. "id"
  9644. ]
  9645. },
  9646. "NormalButtonDisplayType": {
  9647. "type": "string",
  9648. "enum": [
  9649. "BUY",
  9650. "PRIMARY",
  9651. "SECONDARY"
  9652. ]
  9653. },
  9654. "NormalButton": {
  9655. "type": "object",
  9656. "properties": {
  9657. "id": {
  9658. "type": "string"
  9659. },
  9660. "loadingIds": {
  9661. "type": "array",
  9662. "items": {
  9663. "type": "string"
  9664. }
  9665. },
  9666. "tags": {
  9667. "type": "array",
  9668. "items": {
  9669. "type": "string"
  9670. }
  9671. },
  9672. "action": {
  9673. "$ref": "#/components/schemas/Action"
  9674. },
  9675. "type": {
  9676. "type": "string",
  9677. "enum": [
  9678. "NORMAL"
  9679. ]
  9680. },
  9681. "displayType": {
  9682. "$ref": "#/components/schemas/NormalButtonDisplayType"
  9683. },
  9684. "title": {
  9685. "type": "string"
  9686. },
  9687. "icon": {
  9688. "$ref": "#/components/schemas/LocalImage"
  9689. }
  9690. },
  9691. "required": [
  9692. "id",
  9693. "type",
  9694. "displayType",
  9695. "title"
  9696. ]
  9697. },
  9698. "SetBasketItemButton": {
  9699. "type": "object",
  9700. "properties": {
  9701. "id": {
  9702. "type": "string"
  9703. },
  9704. "loadingIds": {
  9705. "type": "array",
  9706. "items": {
  9707. "type": "string"
  9708. }
  9709. },
  9710. "tags": {
  9711. "type": "array",
  9712. "items": {
  9713. "type": "string"
  9714. }
  9715. },
  9716. "action": {
  9717. "$ref": "#/components/schemas/Action"
  9718. },
  9719. "type": {
  9720. "type": "string",
  9721. "enum": [
  9722. "SET_BASKET_ITEM"
  9723. ]
  9724. },
  9725. "title": {
  9726. "type": "string"
  9727. },
  9728. "icon": {
  9729. "$ref": "#/components/schemas/LocalImage"
  9730. },
  9731. "stepQuantity": {
  9732. "type": "number"
  9733. },
  9734. "minOrderQuantity": {
  9735. "type": "number"
  9736. },
  9737. "maxOrderQuantity": {
  9738. "type": "number"
  9739. }
  9740. },
  9741. "required": [
  9742. "id",
  9743. "type",
  9744. "title",
  9745. "stepQuantity",
  9746. "minOrderQuantity",
  9747. "maxOrderQuantity"
  9748. ]
  9749. },
  9750. "SelectionButton": {
  9751. "type": "object",
  9752. "properties": {
  9753. "id": {
  9754. "type": "string"
  9755. },
  9756. "loadingIds": {
  9757. "type": "array",
  9758. "items": {
  9759. "type": "string"
  9760. }
  9761. },
  9762. "tags": {
  9763. "type": "array",
  9764. "items": {
  9765. "type": "string"
  9766. }
  9767. },
  9768. "action": {
  9769. "$ref": "#/components/schemas/Action"
  9770. },
  9771. "type": {
  9772. "type": "string",
  9773. "enum": [
  9774. "SELECTION"
  9775. ]
  9776. },
  9777. "title": {
  9778. "type": "string"
  9779. },
  9780. "subtitle": {
  9781. "type": "string"
  9782. },
  9783. "icon": {
  9784. "$ref": "#/components/schemas/LocalImage"
  9785. }
  9786. },
  9787. "required": [
  9788. "id",
  9789. "type"
  9790. ]
  9791. },
  9792. "TextButton": {
  9793. "type": "object",
  9794. "properties": {
  9795. "id": {
  9796. "type": "string"
  9797. },
  9798. "loadingIds": {
  9799. "type": "array",
  9800. "items": {
  9801. "type": "string"
  9802. }
  9803. },
  9804. "tags": {
  9805. "type": "array",
  9806. "items": {
  9807. "type": "string"
  9808. }
  9809. },
  9810. "action": {
  9811. "$ref": "#/components/schemas/Action"
  9812. },
  9813. "type": {
  9814. "type": "string",
  9815. "enum": [
  9816. "TEXT"
  9817. ]
  9818. },
  9819. "title": {
  9820. "type": "string"
  9821. },
  9822. "icon": {
  9823. "$ref": "#/components/schemas/LocalImage"
  9824. }
  9825. },
  9826. "required": [
  9827. "id",
  9828. "type",
  9829. "title"
  9830. ]
  9831. },
  9832. "PlainButton": {
  9833. "type": "object",
  9834. "properties": {
  9835. "id": {
  9836. "type": "string"
  9837. },
  9838. "loadingIds": {
  9839. "type": "array",
  9840. "items": {
  9841. "type": "string"
  9842. }
  9843. },
  9844. "tags": {
  9845. "type": "array",
  9846. "items": {
  9847. "type": "string"
  9848. }
  9849. },
  9850. "action": {
  9851. "$ref": "#/components/schemas/Action"
  9852. },
  9853. "type": {
  9854. "type": "string",
  9855. "enum": [
  9856. "PLAIN"
  9857. ]
  9858. },
  9859. "displayStyle": {
  9860. "type": "string",
  9861. "enum": [
  9862. "MEDIUM",
  9863. "SMALL"
  9864. ]
  9865. },
  9866. "title": {
  9867. "type": "string"
  9868. },
  9869. "icon": {
  9870. "$ref": "#/components/schemas/LocalImage"
  9871. }
  9872. },
  9873. "required": [
  9874. "id",
  9875. "type",
  9876. "displayStyle",
  9877. "title"
  9878. ]
  9879. },
  9880. "QuantityControlButton": {
  9881. "type": "object",
  9882. "properties": {
  9883. "id": {
  9884. "type": "string"
  9885. },
  9886. "loadingIds": {
  9887. "type": "array",
  9888. "items": {
  9889. "type": "string"
  9890. }
  9891. },
  9892. "tags": {
  9893. "type": "array",
  9894. "items": {
  9895. "type": "string"
  9896. }
  9897. },
  9898. "action": {
  9899. "$ref": "#/components/schemas/Action"
  9900. },
  9901. "type": {
  9902. "type": "string",
  9903. "enum": [
  9904. "QUANTITY_CONTROL"
  9905. ]
  9906. },
  9907. "stepQuantity": {
  9908. "type": "number"
  9909. },
  9910. "minOrderQuantity": {
  9911. "type": "number"
  9912. },
  9913. "maxOrderQuantity": {
  9914. "type": "number"
  9915. }
  9916. },
  9917. "required": [
  9918. "id",
  9919. "type",
  9920. "stepQuantity",
  9921. "minOrderQuantity",
  9922. "maxOrderQuantity"
  9923. ]
  9924. },
  9925. "SwitchButton": {
  9926. "type": "object",
  9927. "properties": {
  9928. "id": {
  9929. "type": "string"
  9930. },
  9931. "loadingIds": {
  9932. "type": "array",
  9933. "items": {
  9934. "type": "string"
  9935. }
  9936. },
  9937. "tags": {
  9938. "type": "array",
  9939. "items": {
  9940. "type": "string"
  9941. }
  9942. },
  9943. "action": {
  9944. "$ref": "#/components/schemas/Action"
  9945. },
  9946. "type": {
  9947. "type": "string",
  9948. "enum": [
  9949. "SWITCH"
  9950. ]
  9951. },
  9952. "active": {
  9953. "type": "boolean"
  9954. }
  9955. },
  9956. "required": [
  9957. "id",
  9958. "type",
  9959. "active"
  9960. ]
  9961. },
  9962. "ScreenCacheData": {
  9963. "type": "object",
  9964. "properties": {
  9965. "favoriteProductIds": {
  9966. "type": "array",
  9967. "items": {
  9968. "type": "string"
  9969. }
  9970. },
  9971. "basketItemCount": {
  9972. "type": "number"
  9973. },
  9974. "basketItems": {
  9975. "type": "array",
  9976. "items": {
  9977. "$ref": "#/components/schemas/BasketItem"
  9978. }
  9979. },
  9980. "pointBalance": {
  9981. "type": "number"
  9982. }
  9983. }
  9984. },
  9985. "RefreshScreensTask": {
  9986. "type": "object",
  9987. "properties": {
  9988. "refreshIds": {
  9989. "$ref": "#/components/schemas/RefreshIds"
  9990. },
  9991. "loadingId": {
  9992. "type": "string"
  9993. },
  9994. "transientStates": {
  9995. "type": "array",
  9996. "items": {
  9997. "$ref": "#/components/schemas/TransientState"
  9998. }
  9999. }
  10000. },
  10001. "required": [
  10002. "refreshIds",
  10003. "transientStates"
  10004. ]
  10005. },
  10006. "BasketItem": {
  10007. "type": "object",
  10008. "properties": {
  10009. "productId": {
  10010. "type": "string"
  10011. },
  10012. "quantity": {
  10013. "type": "number"
  10014. }
  10015. },
  10016. "required": [
  10017. "productId",
  10018. "quantity"
  10019. ]
  10020. },
  10021. "ScreenResponse": {
  10022. "type": "object",
  10023. "properties": {
  10024. "screen": {
  10025. "$ref": "#/components/schemas/Screen"
  10026. },
  10027. "cacheData": {
  10028. "$ref": "#/components/schemas/ScreenCacheData"
  10029. }
  10030. },
  10031. "required": [
  10032. "screen"
  10033. ]
  10034. },
  10035. "LoadComponents": {
  10036. "type": "object",
  10037. "properties": {
  10038. "type": {
  10039. "type": "string",
  10040. "enum": [
  10041. "LOAD_COMPONENTS"
  10042. ]
  10043. },
  10044. "url": {
  10045. "type": "string"
  10046. },
  10047. "uniqueId": {
  10048. "type": "string"
  10049. },
  10050. "displayStyle": {
  10051. "type": "string",
  10052. "enum": [
  10053. "SHIMMER_PLP_ITEMS",
  10054. "SHIMMER_REVIEW_DETAIL",
  10055. "SHIMMER_ORDER_HISTORY_OVERVIEW"
  10056. ]
  10057. }
  10058. },
  10059. "required": [
  10060. "type",
  10061. "url",
  10062. "uniqueId",
  10063. "displayStyle"
  10064. ]
  10065. },
  10066. "ComponentResponse": {
  10067. "oneOf": [
  10068. {
  10069. "oneOf": [
  10070. {
  10071. "$ref": "#/components/schemas/BannerComponent"
  10072. },
  10073. {
  10074. "$ref": "#/components/schemas/BasketProductListItem"
  10075. },
  10076. {
  10077. "$ref": "#/components/schemas/BasketCouponComponent"
  10078. },
  10079. {
  10080. "$ref": "#/components/schemas/BarcodeComponent"
  10081. },
  10082. {
  10083. "$ref": "#/components/schemas/BasketVoucherComponent"
  10084. },
  10085. {
  10086. "$ref": "#/components/schemas/BulletListComponent"
  10087. },
  10088. {
  10089. "$ref": "#/components/schemas/SpacerComponent"
  10090. },
  10091. {
  10092. "$ref": "#/components/schemas/ButtonsComponent"
  10093. },
  10094. {
  10095. "$ref": "#/components/schemas/ActionTextListItem"
  10096. },
  10097. {
  10098. "$ref": "#/components/schemas/DefinitionListComponent"
  10099. },
  10100. {
  10101. "$ref": "#/components/schemas/ExpandableInfoComponent"
  10102. },
  10103. {
  10104. "$ref": "#/components/schemas/EmptyListComponent"
  10105. },
  10106. {
  10107. "$ref": "#/components/schemas/FavoriteListItem"
  10108. },
  10109. {
  10110. "$ref": "#/components/schemas/ImageCollectionComponent"
  10111. },
  10112. {
  10113. "$ref": "#/components/schemas/InfoMessageComponent"
  10114. },
  10115. {
  10116. "$ref": "#/components/schemas/ListGroupComponent"
  10117. },
  10118. {
  10119. "$ref": "#/components/schemas/LoaderComponent"
  10120. },
  10121. {
  10122. "$ref": "#/components/schemas/LoyaltyPointsComponent"
  10123. },
  10124. {
  10125. "$ref": "#/components/schemas/LoyaltySummaryComponent"
  10126. },
  10127. {
  10128. "$ref": "#/components/schemas/OrderStatusComponent"
  10129. },
  10130. {
  10131. "$ref": "#/components/schemas/OrderStatusPlaceholderComponent"
  10132. },
  10133. {
  10134. "$ref": "#/components/schemas/ParagraphComponent"
  10135. },
  10136. {
  10137. "$ref": "#/components/schemas/PlainListItem"
  10138. },
  10139. {
  10140. "$ref": "#/components/schemas/PlainProductListItem"
  10141. },
  10142. {
  10143. "$ref": "#/components/schemas/PlainTextListItem"
  10144. },
  10145. {
  10146. "$ref": "#/components/schemas/PlpListItem"
  10147. },
  10148. {
  10149. "$ref": "#/components/schemas/ProductStoreStockComponent"
  10150. },
  10151. {
  10152. "$ref": "#/components/schemas/ProgressComponent"
  10153. },
  10154. {
  10155. "$ref": "#/components/schemas/PriceLineTextComponent"
  10156. },
  10157. {
  10158. "$ref": "#/components/schemas/QRCodeListItem"
  10159. },
  10160. {
  10161. "$ref": "#/components/schemas/QRCodeComponent"
  10162. },
  10163. {
  10164. "$ref": "#/components/schemas/ReviewDetailListItem"
  10165. },
  10166. {
  10167. "$ref": "#/components/schemas/ReviewSummaryComponent"
  10168. },
  10169. {
  10170. "$ref": "#/components/schemas/SignupCardComponent"
  10171. },
  10172. {
  10173. "$ref": "#/components/schemas/TextCardComponent"
  10174. },
  10175. {
  10176. "$ref": "#/components/schemas/TitleComponent"
  10177. },
  10178. {
  10179. "$ref": "#/components/schemas/TwoColumnTableComponent"
  10180. },
  10181. {
  10182. "$ref": "#/components/schemas/VariationListItem"
  10183. },
  10184. {
  10185. "$ref": "#/components/schemas/VariationProductListItem"
  10186. },
  10187. {
  10188. "$ref": "#/components/schemas/VoucherItemComponent"
  10189. },
  10190. {
  10191. "$ref": "#/components/schemas/ImageComponent"
  10192. },
  10193. {
  10194. "$ref": "#/components/schemas/OrderSummaryListItem"
  10195. },
  10196. {
  10197. "$ref": "#/components/schemas/OrderProductListItem"
  10198. },
  10199. {
  10200. "$ref": "#/components/schemas/OrderDetailStatusComponent"
  10201. },
  10202. {
  10203. "$ref": "#/components/schemas/DonationInputComponent"
  10204. },
  10205. {
  10206. "$ref": "#/components/schemas/PrimaryMenuItemComponent"
  10207. },
  10208. {
  10209. "$ref": "#/components/schemas/SecondaryMenuItemComponent"
  10210. },
  10211. {
  10212. "$ref": "#/components/schemas/AppEnvironmentComponent"
  10213. },
  10214. {
  10215. "$ref": "#/components/schemas/SearchBarComponentExperiment"
  10216. }
  10217. ]
  10218. },
  10219. {
  10220. "type": "object",
  10221. "properties": {},
  10222. "additionalProperties": false
  10223. }
  10224. ]
  10225. },
  10226. "ComponentArrayResponse": {
  10227. "type": "object",
  10228. "properties": {
  10229. "components": {
  10230. "type": "array",
  10231. "items": {
  10232. "$ref": "#/components/schemas/Component"
  10233. }
  10234. },
  10235. "nextPage": {
  10236. "$ref": "#/components/schemas/LoadComponents"
  10237. },
  10238. "uniqueId": {
  10239. "type": "string"
  10240. }
  10241. },
  10242. "required": [
  10243. "components",
  10244. "uniqueId"
  10245. ]
  10246. },
  10247. "SectionsArrayResponse": {
  10248. "type": "object",
  10249. "properties": {
  10250. "sections": {
  10251. "type": "array",
  10252. "items": {
  10253. "$ref": "#/components/schemas/Section"
  10254. }
  10255. }
  10256. },
  10257. "required": [
  10258. "sections"
  10259. ]
  10260. },
  10261. "CommandResponse": {
  10262. "type": "object",
  10263. "properties": {
  10264. "screen": {
  10265. "$ref": "#/components/schemas/Screen"
  10266. },
  10267. "cacheData": {
  10268. "$ref": "#/components/schemas/ScreenCacheData"
  10269. },
  10270. "refreshScreens": {
  10271. "$ref": "#/components/schemas/RefreshScreensTask"
  10272. },
  10273. "successMessage": {
  10274. "type": "string"
  10275. },
  10276. "toast": {
  10277. "$ref": "#/components/schemas/Toast"
  10278. },
  10279. "events": {
  10280. "type": "array",
  10281. "items": {
  10282. "$ref": "#/components/schemas/BFFEvent"
  10283. }
  10284. },
  10285. "onCommandResponseProcessed": {
  10286. "$ref": "#/components/schemas/CommandResponseAction"
  10287. }
  10288. }
  10289. },
  10290. "BasketItemRequestBasicData": {
  10291. "type": "object",
  10292. "properties": {
  10293. "refreshScreens": {
  10294. "$ref": "#/components/schemas/RefreshScreensTask"
  10295. },
  10296. "toast": {
  10297. "$ref": "#/components/schemas/Toast"
  10298. },
  10299. "productId": {
  10300. "type": "string"
  10301. },
  10302. "amount": {
  10303. "oneOf": [
  10304. {
  10305. "type": "string"
  10306. },
  10307. {
  10308. "type": "number"
  10309. }
  10310. ]
  10311. },
  10312. "eventData": {
  10313. "type": "object",
  10314. "properties": {
  10315. "item": {
  10316. "$ref": "#/components/schemas/FirebaseEcomItem"
  10317. },
  10318. "listName": {
  10319. "type": "string"
  10320. },
  10321. "listId": {
  10322. "type": "string"
  10323. },
  10324. "pageType": {
  10325. "type": "string"
  10326. }
  10327. },
  10328. "required": [
  10329. "item",
  10330. "pageType"
  10331. ]
  10332. }
  10333. },
  10334. "required": [
  10335. "productId",
  10336. "amount",
  10337. "eventData"
  10338. ]
  10339. },
  10340. "BasketItemRequestFromBasket": {
  10341. "type": "object",
  10342. "properties": {
  10343. "refreshScreens": {
  10344. "$ref": "#/components/schemas/RefreshScreensTask"
  10345. },
  10346. "toast": {
  10347. "$ref": "#/components/schemas/Toast"
  10348. },
  10349. "productId": {
  10350. "type": "string"
  10351. },
  10352. "amount": {
  10353. "oneOf": [
  10354. {
  10355. "type": "string"
  10356. },
  10357. {
  10358. "type": "number"
  10359. }
  10360. ]
  10361. },
  10362. "eventData": {
  10363. "type": "object",
  10364. "properties": {
  10365. "item": {
  10366. "$ref": "#/components/schemas/FirebaseEcomItem"
  10367. },
  10368. "listName": {
  10369. "type": "string"
  10370. },
  10371. "listId": {
  10372. "type": "string"
  10373. },
  10374. "pageType": {
  10375. "type": "string"
  10376. }
  10377. },
  10378. "required": [
  10379. "item",
  10380. "pageType"
  10381. ]
  10382. },
  10383. "type": {
  10384. "type": "string",
  10385. "enum": [
  10386. "BASKET_ITEM_FROM_BASKET"
  10387. ]
  10388. },
  10389. "basketId": {
  10390. "type": "string"
  10391. },
  10392. "basketItemId": {
  10393. "type": "string"
  10394. },
  10395. "basketItemAmount": {
  10396. "type": "number"
  10397. }
  10398. },
  10399. "required": [
  10400. "productId",
  10401. "amount",
  10402. "eventData",
  10403. "type",
  10404. "basketId",
  10405. "basketItemId",
  10406. "basketItemAmount"
  10407. ]
  10408. },
  10409. "BasketItemRequestFromProduct": {
  10410. "type": "object",
  10411. "properties": {
  10412. "refreshScreens": {
  10413. "$ref": "#/components/schemas/RefreshScreensTask"
  10414. },
  10415. "toast": {
  10416. "$ref": "#/components/schemas/Toast"
  10417. },
  10418. "productId": {
  10419. "type": "string"
  10420. },
  10421. "amount": {
  10422. "oneOf": [
  10423. {
  10424. "type": "string"
  10425. },
  10426. {
  10427. "type": "number"
  10428. }
  10429. ]
  10430. },
  10431. "eventData": {
  10432. "type": "object",
  10433. "properties": {
  10434. "item": {
  10435. "$ref": "#/components/schemas/FirebaseEcomItem"
  10436. },
  10437. "listName": {
  10438. "type": "string"
  10439. },
  10440. "listId": {
  10441. "type": "string"
  10442. },
  10443. "pageType": {
  10444. "type": "string"
  10445. }
  10446. },
  10447. "required": [
  10448. "item",
  10449. "pageType"
  10450. ]
  10451. },
  10452. "type": {
  10453. "type": "string",
  10454. "enum": [
  10455. "BASKET_ITEM_FROM_PRODUCT"
  10456. ]
  10457. }
  10458. },
  10459. "required": [
  10460. "productId",
  10461. "amount",
  10462. "eventData",
  10463. "type"
  10464. ]
  10465. },
  10466. "BasketItemRequest": {
  10467. "oneOf": [
  10468. {
  10469. "$ref": "#/components/schemas/BasketItemRequestFromBasket"
  10470. },
  10471. {
  10472. "$ref": "#/components/schemas/BasketItemRequestFromProduct"
  10473. }
  10474. ]
  10475. },
  10476. "AddToFavoritesRequest": {
  10477. "type": "object",
  10478. "properties": {
  10479. "refreshScreens": {
  10480. "$ref": "#/components/schemas/RefreshScreensTask"
  10481. },
  10482. "toast": {
  10483. "$ref": "#/components/schemas/Toast"
  10484. },
  10485. "productId": {
  10486. "type": "string"
  10487. },
  10488. "events": {
  10489. "type": "array",
  10490. "items": {
  10491. "$ref": "#/components/schemas/BFFEvent"
  10492. }
  10493. }
  10494. },
  10495. "required": [
  10496. "productId"
  10497. ]
  10498. },
  10499. "RemoveFromFavoritesRequest": {
  10500. "type": "object",
  10501. "properties": {
  10502. "refreshScreens": {
  10503. "$ref": "#/components/schemas/RefreshScreensTask"
  10504. },
  10505. "toast": {
  10506. "$ref": "#/components/schemas/Toast"
  10507. },
  10508. "productId": {
  10509. "type": "string"
  10510. }
  10511. },
  10512. "required": [
  10513. "productId"
  10514. ]
  10515. },
  10516. "BasketSummaryResponse": {
  10517. "type": "object",
  10518. "properties": {
  10519. "basketItemCount": {
  10520. "type": "number"
  10521. },
  10522. "basketItems": {
  10523. "type": "array",
  10524. "items": {
  10525. "$ref": "#/components/schemas/BasketItem"
  10526. }
  10527. }
  10528. },
  10529. "required": [
  10530. "basketItemCount",
  10531. "basketItems"
  10532. ]
  10533. },
  10534. "FavoritesSummaryResponse": {
  10535. "type": "object",
  10536. "properties": {
  10537. "favoriteProductIds": {
  10538. "type": "array",
  10539. "items": {
  10540. "type": "string"
  10541. }
  10542. }
  10543. },
  10544. "required": [
  10545. "favoriteProductIds"
  10546. ]
  10547. },
  10548. "FilterResponse": {
  10549. "type": "object",
  10550. "properties": {
  10551. "filters": {
  10552. "$ref": "#/components/schemas/Filters"
  10553. }
  10554. },
  10555. "required": [
  10556. "filters"
  10557. ]
  10558. },
  10559. "UrlLookupResponse": {
  10560. "type": "object",
  10561. "properties": {
  10562. "action": {
  10563. "$ref": "#/components/schemas/Action"
  10564. }
  10565. },
  10566. "required": [
  10567. "action"
  10568. ]
  10569. },
  10570. "ScanResponse": {
  10571. "type": "object",
  10572. "properties": {
  10573. "action": {
  10574. "$ref": "#/components/schemas/Action"
  10575. }
  10576. },
  10577. "required": [
  10578. "action"
  10579. ]
  10580. },
  10581. "StyleguideCommandRequest": {
  10582. "type": "object",
  10583. "properties": {
  10584. "type": {
  10585. "type": "string",
  10586. "enum": [
  10587. "SUCCESS",
  10588. "NOT_FOUND"
  10589. ]
  10590. }
  10591. },
  10592. "required": [
  10593. "type"
  10594. ]
  10595. },
  10596. "IntrospectResponse": {
  10597. "type": "object",
  10598. "properties": {
  10599. "lastDeployTime": {
  10600. "type": "string"
  10601. },
  10602. "git": {
  10603. "type": "object",
  10604. "properties": {
  10605. "commitSha": {
  10606. "type": "string"
  10607. },
  10608. "branch": {
  10609. "type": "string"
  10610. },
  10611. "lastReleasedTag": {
  10612. "type": "string"
  10613. },
  10614. "lastMergedReleaseBranch": {
  10615. "type": "string"
  10616. },
  10617. "mergedBranches": {
  10618. "type": "array",
  10619. "items": {
  10620. "type": "string"
  10621. }
  10622. }
  10623. },
  10624. "required": [
  10625. "mergedBranches"
  10626. ]
  10627. },
  10628. "version": {
  10629. "type": "object",
  10630. "properties": {
  10631. "available": {
  10632. "type": "array",
  10633. "items": {
  10634. "type": "string"
  10635. }
  10636. },
  10637. "features": {
  10638. "type": "object",
  10639. "additionalProperties": false,
  10640. "x-patternProperties": {
  10641. ".*": {
  10642. "type": "array",
  10643. "items": {
  10644. "type": "string"
  10645. }
  10646. }
  10647. }
  10648. }
  10649. },
  10650. "required": [
  10651. "available",
  10652. "features"
  10653. ]
  10654. }
  10655. },
  10656. "required": [
  10657. "git",
  10658. "version"
  10659. ]
  10660. },
  10661. "RecommendationClickEventRequest": {
  10662. "type": "object",
  10663. "properties": {
  10664. "type": {
  10665. "type": "string",
  10666. "enum": [
  10667. "RECOMMENDATION_CLICK_EVENT"
  10668. ]
  10669. },
  10670. "recommenderName": {
  10671. "type": "string"
  10672. },
  10673. "__recoUUID": {
  10674. "type": "string"
  10675. },
  10676. "productId": {
  10677. "type": "string"
  10678. }
  10679. },
  10680. "required": [
  10681. "type",
  10682. "recommenderName",
  10683. "__recoUUID",
  10684. "productId"
  10685. ]
  10686. },
  10687. "RecommendationViewEventRequest": {
  10688. "type": "object",
  10689. "properties": {
  10690. "type": {
  10691. "type": "string",
  10692. "enum": [
  10693. "RECOMMENDATION_VIEW_EVENT"
  10694. ]
  10695. },
  10696. "recommenderName": {
  10697. "type": "string"
  10698. },
  10699. "__recoUUID": {
  10700. "type": "string"
  10701. },
  10702. "productIds": {
  10703. "type": "array",
  10704. "items": {
  10705. "type": "string"
  10706. }
  10707. }
  10708. },
  10709. "required": [
  10710. "type",
  10711. "recommenderName",
  10712. "__recoUUID",
  10713. "productIds"
  10714. ]
  10715. },
  10716. "ProductViewEventRequest": {
  10717. "type": "object",
  10718. "properties": {
  10719. "type": {
  10720. "type": "string",
  10721. "enum": [
  10722. "PRODUCT_VIEW_EVENT"
  10723. ]
  10724. },
  10725. "productId": {
  10726. "type": "string"
  10727. }
  10728. },
  10729. "required": [
  10730. "type",
  10731. "productId"
  10732. ]
  10733. },
  10734. "AddToCartEventRequest": {
  10735. "type": "object",
  10736. "properties": {
  10737. "type": {
  10738. "type": "string",
  10739. "enum": [
  10740. "ADD_TO_CART"
  10741. ]
  10742. },
  10743. "productId": {
  10744. "type": "string"
  10745. },
  10746. "price": {
  10747. "type": "string"
  10748. },
  10749. "quantity": {
  10750. "type": "number"
  10751. }
  10752. },
  10753. "required": [
  10754. "type",
  10755. "productId",
  10756. "price",
  10757. "quantity"
  10758. ]
  10759. },
  10760. "DataEventRequest": {
  10761. "oneOf": [
  10762. {
  10763. "$ref": "#/components/schemas/RecommendationClickEventRequest"
  10764. },
  10765. {
  10766. "$ref": "#/components/schemas/RecommendationViewEventRequest"
  10767. },
  10768. {
  10769. "$ref": "#/components/schemas/ProductViewEventRequest"
  10770. },
  10771. {
  10772. "$ref": "#/components/schemas/AddToCartEventRequest"
  10773. }
  10774. ]
  10775. }
  10776. }
  10777. }
  10778. }
  10779.  
Advertisement
Add Comment
Please, Sign In to add comment
Advertisement