Advertisement
Not a member of Pastebin yet?
Sign Up,
it unlocks many cool features!
- {
- "openapi": "3.0.2",
- "info": {
- "title": "Hema Customerapp API",
- "description": "The Backend For Frontend API used by the mobile apps",
- "version": "1.0.0"
- },
- "tags": [
- {
- "name": "account",
- "description": ""
- },
- {
- "name": "commerce",
- "description": ""
- },
- {
- "name": "loyalty",
- "description": ""
- },
- {
- "name": "orders",
- "description": ""
- },
- {
- "name": "sdui",
- "description": ""
- },
- {
- "name": "system",
- "description": "Paths that can be used by a system on behalf of the customer"
- }
- ],
- "paths": {
- "/account-available": {
- "post": {
- "description": "Checks whether the given e-mail address is available or in use.",
- "tags": [
- "account"
- ],
- "operationId": "AccountAvailable",
- "parameters": [],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/AccountAvailableRequest"
- }
- }
- }
- },
- "responses": {
- "200": {
- "description": "Success response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/AccountAvailableResponse"
- }
- }
- }
- }
- }
- }
- },
- "/account-menu": {
- "get": {
- "description": "Returns a screen with an account menu",
- "tags": [
- "sdui"
- ],
- "operationId": "AccountMenu",
- "parameters": [],
- "responses": {
- "200": {
- "description": "Success response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ScreenResponse"
- }
- }
- }
- }
- }
- }
- },
- "/activate-voucher": {
- "post": {
- "description": "Activates a voucher for a loyality user.",
- "tags": [
- "loyalty"
- ],
- "operationId": "ActivateVoucher",
- "parameters": [],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ActivateVoucherRequest"
- }
- }
- }
- },
- "responses": {
- "200": {
- "description": "Success response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/CommandResponse"
- }
- }
- }
- }
- }
- }
- },
- "/add-physical-card": {
- "post": {
- "description": "Adds an existing physical card to the users loyality account.",
- "tags": [
- "loyalty"
- ],
- "operationId": "AddPhysicalCard",
- "parameters": [],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/AddPhysicalCardRequest"
- }
- }
- }
- },
- "responses": {
- "200": {
- "description": "Success response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/EmptyResponse"
- }
- }
- }
- }
- }
- }
- },
- "/add-push-token": {
- "post": {
- "description": "Add push token for user.",
- "tags": [
- "account"
- ],
- "operationId": "AddPushToken",
- "parameters": [],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/AddPushTokenRequest"
- }
- }
- }
- },
- "responses": {
- "200": {
- "description": "Success response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/EmptyResponse"
- }
- }
- }
- }
- }
- }
- },
- "/add-receipt-points": {
- "post": {
- "description": "Adds the points from a receipt, obtained in the physical stores, to the users loyality account.",
- "tags": [
- "loyalty"
- ],
- "operationId": "AddReceiptPoints",
- "parameters": [],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/AddReceiptPointsRequest"
- }
- }
- }
- },
- "responses": {
- "200": {
- "description": "Success response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/EmptyResponse"
- }
- }
- }
- }
- }
- }
- },
- "/add-to-basket": {
- "post": {
- "description": "Add products to a basket",
- "tags": [
- "commerce"
- ],
- "operationId": "AddToBasket",
- "parameters": [],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/BasketItemRequest"
- }
- }
- }
- },
- "responses": {
- "200": {
- "description": "Success response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/CommandResponse"
- }
- }
- }
- }
- }
- }
- },
- "/add-to-favorites": {
- "post": {
- "description": "Add product to the user's favorites list",
- "tags": [
- "account"
- ],
- "operationId": "AddToFavorites",
- "parameters": [],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/AddToFavoritesRequest"
- }
- }
- }
- },
- "responses": {
- "200": {
- "description": "Success response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/CommandResponse"
- }
- }
- }
- }
- }
- }
- },
- "/nl/address-lookup": {
- "post": {
- "description": "Reverse lookup of an address in the Netherlands based on postal code house number and optionally addtion.",
- "tags": [
- "system"
- ],
- "operationId": "AddressLookup",
- "parameters": [],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/NLAddressLookupRequest"
- }
- }
- }
- },
- "responses": {
- "200": {
- "description": "Success response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/NLAddressLookupResponse"
- }
- }
- }
- }
- }
- }
- },
- "/basket": {
- "get": {
- "description": "Returns the basket",
- "tags": [
- "sdui"
- ],
- "operationId": "basket",
- "parameters": [
- {
- "name": "id",
- "required": false,
- "in": "query",
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "showPaymentFailed",
- "required": false,
- "in": "query",
- "schema": {
- "type": "boolean"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Success response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ScreenResponse"
- }
- }
- }
- }
- }
- }
- },
- "/basket-checkout": {
- "post": {
- "description": "Validates the current basket and moves on to the checkout or returns a new basket screen in the command response.",
- "tags": [
- "commerce"
- ],
- "operationId": "BasketCheckout",
- "parameters": [],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/BasketCheckoutRequest"
- }
- }
- }
- },
- "responses": {
- "200": {
- "description": "Success response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/CommandResponse"
- }
- }
- }
- }
- }
- }
- },
- "/basket-coupon-apply": {
- "post": {
- "description": "Applies a coupon code to a basket if possible or errors otherwise.",
- "tags": [
- "commerce"
- ],
- "operationId": "BasketCouponApply",
- "parameters": [],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/BasketCouponRequest"
- }
- }
- }
- },
- "responses": {
- "200": {
- "description": "Success response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/CommandResponse"
- }
- }
- }
- }
- }
- }
- },
- "/basket-coupon-remove": {
- "post": {
- "description": "Removes a coupon from a basket if possible or errors otherwise.",
- "tags": [
- "commerce"
- ],
- "operationId": "BasketCouponRemove",
- "parameters": [],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/BasketCouponRequest"
- }
- }
- }
- },
- "responses": {
- "200": {
- "description": "Success response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/CommandResponse"
- }
- }
- }
- }
- }
- }
- },
- "/basket-item": {
- "post": {
- "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.",
- "tags": [
- "commerce"
- ],
- "operationId": "BasketItem",
- "parameters": [],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/BasketItemRequest"
- }
- }
- }
- },
- "responses": {
- "200": {
- "description": "Success response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/CommandResponse"
- }
- }
- }
- }
- }
- }
- },
- "/basket-summary": {
- "get": {
- "description": "Summary of the basket",
- "tags": [
- "commerce"
- ],
- "operationId": "BasketSummary",
- "parameters": [],
- "responses": {
- "200": {
- "description": "Success response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/BasketSummaryResponse"
- }
- }
- }
- }
- }
- }
- },
- "/categories": {
- "get": {
- "description": "Returns the contents of the category",
- "tags": [
- "sdui"
- ],
- "operationId": "Categories",
- "parameters": [
- {
- "name": "parentCategoryId",
- "required": false,
- "in": "query",
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "depth",
- "required": false,
- "in": "query",
- "schema": {
- "type": "integer"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Success response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ScreenResponse"
- }
- }
- }
- }
- }
- }
- },
- "/content": {
- "get": {
- "description": "Returns a content screen built in Contentful matching the slug in the query parameters.",
- "tags": [
- "sdui"
- ],
- "operationId": "content",
- "parameters": [
- {
- "name": "slug",
- "required": true,
- "in": "query",
- "schema": {
- "type": "string"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Success response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ScreenResponse"
- }
- }
- }
- }
- }
- }
- },
- "/customer-service": {
- "get": {
- "description": "Returns a screen with customer service details",
- "tags": [
- "sdui"
- ],
- "operationId": "CustomerService",
- "parameters": [],
- "responses": {
- "200": {
- "description": "Success response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ScreenResponse"
- }
- }
- }
- }
- }
- }
- },
- "/data-event": {
- "post": {
- "description": "Events defined by the BFF sent as a side-effect of actions or moments in time, similar to Analytics events.",
- "tags": [
- "system"
- ],
- "operationId": "DataEvent",
- "parameters": [],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/DataEventRequest"
- }
- }
- }
- },
- "responses": {
- "200": {
- "description": "Success response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/EmptyResponse"
- }
- }
- }
- }
- }
- }
- },
- "/deactivate-voucher": {
- "post": {
- "description": "Deactivates a voucher for a loyality user.",
- "tags": [
- "loyalty"
- ],
- "operationId": "DeactivateVoucher",
- "parameters": [],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/DeactivateVoucherRequest"
- }
- }
- }
- },
- "responses": {
- "200": {
- "description": "Success response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/CommandResponse"
- }
- }
- }
- }
- }
- }
- },
- "/discount-overview": {
- "get": {
- "description": "Returns a screen with a discount overview",
- "tags": [
- "sdui"
- ],
- "operationId": "DiscountOverview",
- "parameters": [],
- "responses": {
- "200": {
- "description": "Success response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ScreenResponse"
- }
- }
- }
- }
- }
- }
- },
- "/favorites": {
- "get": {
- "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",
- "tags": [
- "sdui"
- ],
- "operationId": "Favorites",
- "parameters": [],
- "responses": {
- "200": {
- "description": "Success response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ScreenResponse"
- }
- }
- }
- }
- }
- }
- },
- "/favorites-summary": {
- "get": {
- "description": "Returns a summary of the wishlist of an authenticated user",
- "tags": [
- "account"
- ],
- "operationId": "FavoritesSummary",
- "parameters": [],
- "responses": {
- "200": {
- "description": "Success response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/FavoritesSummaryResponse"
- }
- }
- }
- }
- }
- }
- },
- "/filter": {
- "get": {
- "description": "Returns filters based on the given search params",
- "tags": [
- "commerce"
- ],
- "operationId": "Filter",
- "parameters": [
- {
- "name": "term",
- "required": false,
- "in": "query",
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "categoryId",
- "required": false,
- "in": "query",
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "disableOutOfStockFallback",
- "required": false,
- "in": "query",
- "schema": {
- "type": "boolean"
- }
- },
- {
- "name": "sort",
- "required": false,
- "in": "query",
- "schema": {
- "type": "string"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Success response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/FilterResponse"
- }
- }
- }
- }
- }
- }
- },
- "/forgot-password": {
- "post": {
- "description": "Activates the \"forgot password\" flow for th user.",
- "tags": [
- "account"
- ],
- "operationId": "ForgotPassword",
- "parameters": [],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ForgotPasswordRequest"
- }
- }
- }
- },
- "responses": {
- "200": {
- "description": "Success response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/EmptyResponse"
- }
- }
- }
- }
- }
- }
- },
- "/push-notification-channels": {
- "get": {
- "description": "Gets push notification channel status for current user.",
- "tags": [
- "account"
- ],
- "operationId": "GetPushNotificationChannels",
- "parameters": [],
- "responses": {
- "200": {
- "description": "Success response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/PushNotificationChannelState"
- }
- }
- }
- }
- }
- },
- "post": {
- "description": "Updates push notification channel settings for the user.",
- "tags": [
- "account"
- ],
- "operationId": "PostPushNotificationChannels",
- "parameters": [],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/PushNotificationChannelState"
- }
- }
- }
- },
- "responses": {
- "200": {
- "description": "Success response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/EmptyResponse"
- }
- }
- }
- }
- }
- }
- },
- "/home": {
- "get": {
- "description": "Returns the screen with the home content",
- "tags": [
- "sdui"
- ],
- "operationId": "Home",
- "parameters": [],
- "responses": {
- "200": {
- "description": "Success response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ScreenResponse"
- }
- }
- }
- }
- }
- }
- },
- "/home-content": {
- "get": {
- "description": "Returns the banner content for the homepage in the app",
- "tags": [
- "sdui"
- ],
- "operationId": "CFHomeContent",
- "parameters": [],
- "responses": {
- "200": {
- "description": "Success response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HomeResponse"
- }
- }
- }
- }
- }
- }
- },
- "/invoice-details": {
- "get": {
- "description": "Returns the details of one invoice including a return QR code if available.",
- "tags": [
- "orders"
- ],
- "operationId": "InvoiceDetails",
- "parameters": [
- {
- "name": "id",
- "required": true,
- "in": "query",
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "origin",
- "required": false,
- "in": "query",
- "schema": {
- "type": "string"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Success response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ScreenResponse"
- }
- }
- }
- }
- }
- }
- },
- "/login": {
- "post": {
- "description": "Obtains oauth tokens for the user.",
- "tags": [
- "account"
- ],
- "operationId": "Login",
- "parameters": [],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/LoginRequest"
- }
- }
- }
- },
- "responses": {
- "200": {
- "description": "Success response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/TokenResponse"
- }
- }
- }
- }
- }
- }
- },
- "/loyalty": {
- "get": {
- "description": "Returns all information relevant to the user both authenticated and anonymous. Data includes available vouchers, activated vouchers & point balance.",
- "tags": [
- "sdui"
- ],
- "operationId": "Loyalty",
- "parameters": [],
- "responses": {
- "200": {
- "description": "Success response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/LoyaltyResponse"
- }
- }
- }
- }
- }
- }
- },
- "/loyalty-donate-points": {
- "post": {
- "description": "Donate a chosen amount of points from your loyalty balance to a charity of your choice.",
- "tags": [
- "loyalty"
- ],
- "operationId": "LoyaltyDonatePoints",
- "parameters": [],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/LoyaltyDonatePointsRequest"
- }
- }
- }
- },
- "responses": {
- "200": {
- "description": "Success response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/CommandResponse"
- }
- }
- }
- },
- "400": {
- "description": "Bad request",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ErrorResponse"
- }
- }
- }
- },
- "401": {
- "description": "Not authenticated",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ErrorResponse"
- }
- }
- }
- }
- }
- }
- },
- "/me": {
- "get": {
- "description": "Returns all information relevant to the user both authenticated and anonymous. Data includes available vouchers, activated vouchers & point balance.",
- "tags": [
- "loyalty"
- ],
- "operationId": "Me",
- "parameters": [],
- "responses": {
- "200": {
- "description": "Success response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/EmptyResponse"
- }
- }
- }
- }
- }
- }
- },
- "/notification-settings": {
- "get": {
- "description": "Returns a screen with notification settings",
- "tags": [
- "sdui"
- ],
- "operationId": "notificationSettings",
- "parameters": [],
- "responses": {
- "200": {
- "description": "Success response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ScreenResponse"
- }
- }
- }
- }
- }
- }
- },
- "/privacy": {
- "get": {
- "description": "Returns a screen with privacy links",
- "tags": [
- "sdui"
- ],
- "operationId": "Privacy",
- "parameters": [],
- "responses": {
- "200": {
- "description": "Success response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ScreenResponse"
- }
- }
- }
- }
- }
- }
- },
- "/order-details": {
- "get": {
- "description": "Returns the details of one order including track & trace info and a return QR code.",
- "tags": [
- "orders"
- ],
- "operationId": "OrderDetails",
- "parameters": [
- {
- "name": "id",
- "required": true,
- "in": "query",
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "origin",
- "required": false,
- "in": "query",
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "includeInvoiceDetails",
- "required": false,
- "in": "query",
- "schema": {
- "type": "boolean"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Success response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ScreenResponse"
- }
- }
- }
- }
- }
- }
- },
- "/order-history-overview": {
- "get": {
- "description": "Returns the first page of order history for the logged in user",
- "tags": [
- "orders"
- ],
- "operationId": "OrderHistoryOverview",
- "parameters": [],
- "responses": {
- "200": {
- "description": "Success response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ScreenResponse"
- }
- }
- }
- }
- }
- }
- },
- "/order-history-overview-additional": {
- "get": {
- "description": "Returns additional paginated order history",
- "tags": [
- "orders"
- ],
- "operationId": "OrderHistoryOverviewAdditional",
- "parameters": [
- {
- "name": "uniqueId",
- "required": true,
- "in": "query",
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "cursor",
- "required": false,
- "in": "query",
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "invoicesOffset",
- "required": false,
- "in": "query",
- "schema": {
- "type": "integer"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Success response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ComponentArrayResponse"
- }
- }
- }
- }
- }
- }
- },
- "/order-overview": {
- "get": {
- "description": "Returns an overview of the user's open orders.",
- "tags": [
- "orders"
- ],
- "operationId": "OrderOverview",
- "parameters": [],
- "responses": {
- "200": {
- "description": "Success response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ScreenResponse"
- }
- }
- }
- }
- }
- }
- },
- "/order-status-component": {
- "get": {
- "description": "Returns the order status component. Do not request it directly, instead load it through the order status placeholder component",
- "tags": [
- "orders"
- ],
- "operationId": "OrderStatusComponent",
- "parameters": [],
- "responses": {
- "200": {
- "description": "Success response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ComponentResponse"
- }
- }
- }
- }
- }
- }
- },
- "/platform-redirect": {
- "get": {
- "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.",
- "tags": [
- "system"
- ],
- "operationId": "PlatformRedirect",
- "parameters": [
- {
- "name": "ios",
- "required": true,
- "in": "query",
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "android",
- "required": true,
- "in": "query",
- "schema": {
- "type": "string"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Success response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/EmptyResponse"
- }
- }
- }
- }
- }
- }
- },
- "/product": {
- "get": {
- "description": "Product detail page",
- "tags": [
- "commerce"
- ],
- "operationId": "Product",
- "parameters": [
- {
- "name": "id",
- "required": true,
- "in": "query",
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "favoriteStoreId",
- "required": false,
- "in": "query",
- "schema": {
- "type": "string"
- },
- "description": "Optional string placeholder replaced by the consumer with a value or the string value \"null\" if not available."
- },
- {
- "name": "lastSelectedStoreId",
- "required": false,
- "in": "query",
- "schema": {
- "type": "string"
- },
- "description": "Optional string placeholder replaced by the consumer with a value or the string value \"null\" if not available."
- }
- ],
- "responses": {
- "200": {
- "description": "Success response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ScreenResponse"
- }
- }
- }
- }
- }
- }
- },
- "/product-reviews": {
- "get": {
- "description": "Product reviews",
- "tags": [
- "commerce"
- ],
- "operationId": "ProductReviews",
- "parameters": [
- {
- "name": "productId",
- "required": true,
- "in": "query",
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "reviewId",
- "required": false,
- "in": "query",
- "schema": {
- "type": "string"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Success response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ScreenResponse"
- }
- }
- }
- }
- }
- }
- },
- "/product-reviews-additional": {
- "get": {
- "description": "Product reviews - get additional reviews",
- "tags": [
- "commerce"
- ],
- "operationId": "ProductReviewsAdditional",
- "parameters": [
- {
- "name": "productId",
- "required": true,
- "in": "query",
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "offset",
- "required": true,
- "in": "query",
- "schema": {
- "type": "integer"
- }
- },
- {
- "name": "uniqueId",
- "required": true,
- "in": "query",
- "schema": {
- "type": "string"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Success response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ComponentArrayResponse"
- }
- }
- }
- }
- }
- }
- },
- "/profile": {
- "delete": {
- "description": "Delete the users profile.",
- "tags": [
- "account"
- ],
- "operationId": "ProfileDelete",
- "parameters": [],
- "responses": {
- "200": {
- "description": "Success response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/EmptyResponse"
- }
- }
- }
- },
- "401": {
- "description": "Not authenticated",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ErrorResponse"
- }
- }
- }
- },
- "500": {
- "description": "An unexpected error has occured",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ErrorResponse"
- }
- }
- }
- }
- }
- },
- "get": {
- "description": "Returns the users profile.",
- "tags": [
- "account"
- ],
- "operationId": "Profile",
- "parameters": [],
- "responses": {
- "200": {
- "description": "Success response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ProfileResponse"
- }
- }
- }
- }
- }
- }
- },
- "/promotions-overview": {
- "get": {
- "description": "Returns a screen with a promotions overview",
- "tags": [
- "sdui"
- ],
- "operationId": "PromotionsOverview",
- "parameters": [],
- "responses": {
- "200": {
- "description": "Success response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ScreenResponse"
- }
- }
- }
- }
- }
- }
- },
- "/redirect": {
- "get": {
- "description": "Redirects the user to the requested page in the correct language with the correct parameters.",
- "tags": [
- "system"
- ],
- "operationId": "Redirect",
- "parameters": [
- {
- "name": "type",
- "required": true,
- "in": "query",
- "schema": {
- "type": "string",
- "enum": [
- "toc",
- "privacy",
- "cookie",
- "store-locator",
- "hema-loyalty-explanation"
- ]
- }
- },
- {
- "name": "appuser",
- "required": false,
- "in": "query",
- "schema": {
- "type": "integer"
- }
- },
- {
- "name": "connect_id",
- "required": false,
- "in": "query",
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "acceptLanguage",
- "required": false,
- "in": "query",
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "countryCode",
- "required": false,
- "in": "query",
- "schema": {
- "type": "string"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Success response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/EmptyResponse"
- }
- }
- }
- }
- }
- }
- },
- "/refresh-token": {
- "post": {
- "description": "Obtains a fresh access token for the user",
- "tags": [
- "account"
- ],
- "operationId": "RefreshToken",
- "parameters": [],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/RefreshRequest"
- }
- }
- }
- },
- "responses": {
- "200": {
- "description": "Success response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/TokenResponse"
- }
- }
- }
- }
- }
- }
- },
- "/register": {
- "post": {
- "description": "Creates a profile for the user and logs in automatically whenever successful.",
- "tags": [
- "account"
- ],
- "operationId": "Register",
- "parameters": [],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/RegisterRequest"
- }
- }
- }
- },
- "responses": {
- "200": {
- "description": "Success response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/TokenResponse"
- }
- }
- }
- }
- }
- }
- },
- "/remove-from-favorites": {
- "post": {
- "description": "Remove product from the user's favorites list",
- "tags": [
- "account",
- "commerce"
- ],
- "operationId": "RemoveFromFavorites",
- "parameters": [],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/RemoveFromFavoritesRequest"
- }
- }
- }
- },
- "responses": {
- "200": {
- "description": "Success response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/CommandResponse"
- }
- }
- }
- }
- }
- }
- },
- "/scan": {
- "get": {
- "description": "Analyzes the barcode and returns an action what to do next",
- "tags": [
- "sdui"
- ],
- "operationId": "Scan",
- "parameters": [
- {
- "name": "barcode",
- "required": true,
- "in": "query",
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "manual",
- "required": true,
- "in": "query",
- "schema": {
- "type": "boolean"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Success response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ScanResponse"
- }
- }
- }
- }
- }
- }
- },
- "/search": {
- "get": {
- "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",
- "tags": [
- "sdui"
- ],
- "operationId": "Search",
- "parameters": [
- {
- "name": "term",
- "required": false,
- "in": "query",
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "categoryId",
- "required": false,
- "in": "query",
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "disableOutOfStockFallback",
- "required": false,
- "in": "query",
- "schema": {
- "type": "boolean"
- }
- },
- {
- "name": "sort",
- "required": false,
- "in": "query",
- "schema": {
- "type": "string"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Success response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ScreenResponse"
- }
- }
- }
- }
- }
- }
- },
- "/search_load_additional": {
- "get": {
- "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",
- "tags": [
- "sdui"
- ],
- "operationId": "SearchLoadAdditional",
- "parameters": [
- {
- "name": "offset",
- "required": true,
- "in": "query",
- "schema": {
- "type": "integer"
- }
- },
- {
- "name": "uniqueId",
- "required": true,
- "in": "query",
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "term",
- "required": false,
- "in": "query",
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "categoryId",
- "required": false,
- "in": "query",
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "disableOutOfStockFallback",
- "required": false,
- "in": "query",
- "schema": {
- "type": "boolean"
- }
- },
- {
- "name": "sort",
- "required": false,
- "in": "query",
- "schema": {
- "type": "string"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Success response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ComponentArrayResponse"
- }
- }
- }
- }
- }
- }
- },
- "/settings": {
- "post": {
- "description": "Settings",
- "tags": [
- "account"
- ],
- "operationId": "Updates settings for the user.",
- "parameters": [],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/SettingsRequest"
- }
- }
- }
- },
- "responses": {
- "200": {
- "description": "Success response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/EmptyResponse"
- }
- }
- }
- }
- }
- }
- },
- "/styleguide": {
- "get": {
- "description": "SDUI styleguide",
- "tags": [
- "sdui"
- ],
- "operationId": "Styleguide",
- "parameters": [
- {
- "name": "section",
- "required": false,
- "in": "query",
- "schema": {
- "type": "string"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Success response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ScreenResponse"
- }
- }
- }
- }
- }
- },
- "post": {
- "description": "SDUI styleguide commands",
- "tags": [
- "sdui"
- ],
- "operationId": "StyleguideCommands",
- "parameters": [],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/StyleguideCommandRequest"
- }
- }
- }
- },
- "responses": {
- "200": {
- "description": "Success response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/CommandResponse"
- }
- }
- }
- }
- }
- }
- },
- "/suggestions": {
- "get": {
- "description": "Returns suggestions for the given query",
- "tags": [
- "sdui"
- ],
- "operationId": "Suggestions",
- "parameters": [
- {
- "name": "term",
- "required": true,
- "in": "query",
- "schema": {
- "type": "string"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Success response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/SectionsArrayResponse"
- }
- }
- }
- }
- }
- }
- },
- "/profile/upgrade-to-loyalty": {
- "post": {
- "description": "Upgrades the users account to a loyality account in order to make user of vouchers.",
- "tags": [
- "loyalty"
- ],
- "operationId": "UpgradeToLoyalty",
- "parameters": [],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/LoyaltyUpgradeRequest"
- }
- }
- }
- },
- "responses": {
- "200": {
- "description": "Success response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/EmptyResponse"
- }
- }
- }
- }
- }
- }
- },
- "/url-lookup": {
- "get": {
- "description": "",
- "tags": [
- "system"
- ],
- "operationId": "UrlLookup",
- "parameters": [
- {
- "name": "url",
- "required": true,
- "in": "query",
- "schema": {
- "type": "string"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Success response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/UrlLookupResponse"
- }
- }
- }
- }
- }
- }
- },
- "/variation-product-list": {
- "get": {
- "description": "Returns a list of the product variants in the same group, which is usually displayed within a screen with display type 'Sheet'.",
- "tags": [
- "commerce"
- ],
- "operationId": "VariationProductList",
- "parameters": [
- {
- "name": "variationProductIds",
- "required": true,
- "in": "query",
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "attributeId",
- "required": false,
- "in": "query",
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "attributeLabel",
- "required": false,
- "in": "query",
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "pageType",
- "required": true,
- "in": "query",
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "itemListName",
- "required": true,
- "in": "query",
- "schema": {
- "type": "string"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Success response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ScreenResponse"
- }
- }
- }
- }
- }
- }
- },
- "/voucher-details": {
- "get": {
- "description": "Returns the content of the voucher detail screen for both authenticated and anonymous users.",
- "tags": [
- "sdui"
- ],
- "operationId": "VoucherDetails",
- "parameters": [
- {
- "name": "voucherId",
- "required": true,
- "in": "query",
- "schema": {
- "type": "string"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Success response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ScreenResponse"
- }
- }
- }
- }
- }
- }
- },
- "/vouchers-overview": {
- "get": {
- "description": "Returns the content of the vouchers overview screen for both authenticated and anonymous users. Content includes available vouchers, activated vouchers & point balance.",
- "tags": [
- "sdui"
- ],
- "operationId": "VouchersOverview",
- "parameters": [],
- "responses": {
- "200": {
- "description": "Success response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ScreenResponse"
- }
- }
- }
- }
- }
- }
- },
- "/webview": {
- "post": {
- "description": "Handles the oauth delegation procedure.",
- "tags": [
- "system"
- ],
- "operationId": "Webview",
- "parameters": [],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/WebviewRequest"
- }
- }
- }
- },
- "responses": {
- "200": {
- "description": "Success response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/WebviewResponse"
- }
- }
- }
- }
- }
- }
- },
- "/json-schema": {
- "get": {
- "description": "Get the JSON schema of the experience API.",
- "tags": [
- "system"
- ],
- "operationId": "JsonSchema",
- "parameters": [],
- "responses": {
- "200": {
- "description": "Success response"
- }
- }
- }
- },
- "/introspect": {
- "get": {
- "description": "Get runtime information on deployment status and features. Not available on production.",
- "tags": [
- "system"
- ],
- "operationId": "Introspect",
- "parameters": [],
- "responses": {
- "200": {
- "description": "Success response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/IntrospectResponse"
- }
- }
- }
- }
- }
- }
- }
- },
- "components": {
- "schemas": {
- "EmptyRequest": {
- "type": "object",
- "properties": {},
- "additionalProperties": false
- },
- "EmptyResponse": {
- "type": "object",
- "properties": {},
- "additionalProperties": false
- },
- "ErrorResponse": {
- "type": "object",
- "properties": {
- "message": {
- "type": "string"
- },
- "analyticEvents": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/AnalyticsEvent"
- }
- }
- },
- "required": [
- "message"
- ]
- },
- "TokenResponse": {
- "type": "object",
- "properties": {
- "access_token": {
- "type": "string"
- },
- "expires_in": {
- "type": "number"
- },
- "token_type": {
- "type": "string"
- },
- "refresh_token": {
- "type": "string"
- }
- },
- "required": [
- "access_token",
- "expires_in",
- "token_type",
- "refresh_token"
- ]
- },
- "LoginRequest": {
- "type": "object",
- "properties": {
- "email": {
- "type": "string"
- },
- "password": {
- "type": "string"
- }
- },
- "required": [
- "email",
- "password"
- ]
- },
- "RefreshRequest": {
- "type": "object",
- "properties": {
- "refresh_token": {
- "type": "string"
- }
- },
- "required": [
- "refresh_token"
- ]
- },
- "Destination": {
- "type": "string",
- "enum": [
- "cart",
- "update-profile",
- "change-password",
- "add-address",
- "change-address"
- ]
- },
- "WebviewRequestForDestination": {
- "type": "object",
- "properties": {
- "destination": {
- "$ref": "#/components/schemas/Destination"
- },
- "extraParams": {
- "type": "object",
- "additionalProperties": false,
- "x-patternProperties": {
- ".*": {
- "oneOf": [
- {
- "type": "boolean"
- },
- {
- "type": "string"
- },
- {
- "type": "number"
- }
- ]
- }
- }
- }
- },
- "required": [
- "destination"
- ]
- },
- "WebviewRequestWithPath": {
- "type": "object",
- "properties": {
- "path": {
- "type": "string"
- },
- "requiresSessionBridge": {
- "type": "boolean"
- }
- },
- "required": [
- "path"
- ]
- },
- "WebviewRequest": {
- "oneOf": [
- {
- "type": "object",
- "properties": {
- "path": {
- "type": "string"
- },
- "requiresSessionBridge": {
- "type": "boolean"
- }
- },
- "required": [
- "path"
- ]
- },
- {
- "type": "object",
- "properties": {
- "destination": {
- "$ref": "#/components/schemas/Destination"
- },
- "extraParams": {
- "type": "object",
- "additionalProperties": false,
- "x-patternProperties": {
- ".*": {
- "oneOf": [
- {
- "type": "boolean"
- },
- {
- "type": "string"
- },
- {
- "type": "number"
- }
- ]
- }
- }
- }
- },
- "required": [
- "destination"
- ]
- }
- ]
- },
- "WebviewResponse": {
- "type": "object",
- "properties": {
- "url": {
- "type": "string"
- }
- },
- "required": [
- "url"
- ]
- },
- "AddPushTokenRequest": {
- "type": "object",
- "properties": {
- "token": {
- "type": "string"
- }
- },
- "required": [
- "token"
- ]
- },
- "PushNotificationChannelState": {
- "type": "object",
- "properties": {
- "isOptInOrderNotifications": {
- "type": "boolean"
- },
- "isOptInMarketingNotifications": {
- "type": "boolean"
- }
- }
- },
- "RegisterRequest": {
- "type": "object",
- "properties": {
- "email": {
- "type": "string"
- },
- "password": {
- "type": "string"
- },
- "postalCode": {
- "type": "string"
- },
- "houseNumber": {
- "type": "string"
- },
- "houseNumberAddition": {
- "type": "string"
- },
- "street": {
- "type": "string"
- },
- "city": {
- "type": "string"
- },
- "countryCode": {
- "type": "string"
- },
- "addressLine1": {
- "type": "string"
- },
- "addressLine2": {
- "type": "string"
- },
- "addressLine3": {
- "type": "string"
- },
- "firstName": {
- "type": "string"
- },
- "infix": {
- "type": "string"
- },
- "lastName": {
- "type": "string"
- },
- "sex": {
- "type": "string",
- "enum": [
- "MALE",
- "FEMALE",
- "OTHER"
- ]
- }
- },
- "required": [
- "email",
- "password",
- "postalCode",
- "city",
- "countryCode",
- "firstName",
- "lastName",
- "sex"
- ]
- },
- "ProfileResponse": {
- "type": "object",
- "properties": {
- "userId": {
- "type": "string"
- },
- "email": {
- "type": "string"
- },
- "postalCode": {
- "type": "string"
- },
- "houseNumber": {
- "type": "string"
- },
- "houseNumberAddition": {
- "type": "string"
- },
- "street": {
- "type": "string"
- },
- "city": {
- "type": "string"
- },
- "countryCode": {
- "type": "string"
- },
- "firstName": {
- "type": "string"
- },
- "infix": {
- "type": "string"
- },
- "lastName": {
- "type": "string"
- },
- "dateOfBirth": {
- "type": "string"
- },
- "sex": {
- "type": "string",
- "enum": [
- "MALE",
- "FEMALE",
- "OTHER"
- ]
- },
- "isOptInNewsletter": {
- "type": "boolean"
- },
- "isOptInNewsletterLoyalty": {
- "type": "boolean"
- },
- "isLoyaltyMember": {
- "type": "boolean"
- },
- "loyaltyCardToken": {
- "type": "string"
- },
- "physicalCardId": {
- "type": "string"
- },
- "virtualCardId": {
- "type": "string"
- },
- "pointBalance": {
- "type": "number"
- },
- "favoriteStoreId": {
- "type": "string"
- },
- "lastSelectedStoreId": {
- "type": "string"
- },
- "addresses": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/ProfileAddress"
- }
- }
- },
- "required": [
- "userId",
- "email"
- ]
- },
- "ProfileAddress": {
- "type": "object",
- "properties": {
- "id": {
- "type": "string"
- },
- "title": {
- "type": "string"
- },
- "postalCode": {
- "type": "string"
- },
- "houseNumber": {
- "type": "string"
- },
- "houseNumberAddition": {
- "type": "string"
- },
- "street": {
- "type": "string"
- },
- "city": {
- "type": "string"
- },
- "companyName": {
- "type": "string"
- },
- "countryCode": {
- "type": "string"
- },
- "firstName": {
- "type": "string"
- },
- "infix": {
- "type": "string"
- },
- "lastName": {
- "type": "string"
- },
- "isPrefered": {
- "type": "boolean"
- },
- "phoneNumber": {
- "type": "string"
- }
- },
- "required": [
- "id"
- ]
- },
- "ForgotPasswordRequest": {
- "type": "object",
- "properties": {
- "email": {
- "type": "string"
- }
- },
- "required": [
- "email"
- ]
- },
- "AccountAvailableRequest": {
- "type": "object",
- "properties": {
- "email": {
- "type": "string"
- }
- },
- "required": [
- "email"
- ]
- },
- "AccountAvailableResponse": {
- "type": "object",
- "properties": {
- "isAvailable": {
- "type": "boolean"
- },
- "alert": {
- "type": "object",
- "properties": {
- "title": {
- "type": "string"
- },
- "message": {
- "type": "string"
- }
- },
- "required": [
- "title",
- "message"
- ]
- }
- },
- "required": [
- "isAvailable"
- ]
- },
- "NLAddressLookupRequest": {
- "type": "object",
- "properties": {
- "postalCode": {
- "type": "string"
- },
- "houseNumber": {
- "type": "string"
- },
- "houseNumberAddition": {
- "type": "string"
- }
- },
- "required": [
- "postalCode",
- "houseNumber"
- ]
- },
- "NLAddressLookupResponse": {
- "type": "object",
- "properties": {
- "match": {
- "type": "object",
- "properties": {
- "street": {
- "type": "string"
- },
- "houseNumber": {
- "type": "string"
- },
- "houseNumberAddition": {
- "type": "string"
- },
- "postalCode": {
- "type": "string"
- },
- "city": {
- "type": "string"
- },
- "countryCode": {
- "type": "string"
- }
- },
- "required": [
- "street",
- "houseNumber",
- "postalCode",
- "city",
- "countryCode"
- ]
- },
- "noMatch": {
- "type": "object",
- "properties": {
- "errorMessage": {
- "type": "string"
- }
- },
- "required": [
- "errorMessage"
- ]
- }
- }
- },
- "LoyaltyUpgradeRequest": {
- "type": "object",
- "properties": {
- "birthDate": {
- "type": "string"
- },
- "hasAcceptedTermsAndConditions": {
- "type": "boolean"
- },
- "hasParentalApprovement": {
- "type": "boolean"
- },
- "isOptInNewsletterWebshop": {
- "type": "boolean"
- },
- "isOptInNewsletterLoyalty": {
- "type": "boolean"
- }
- },
- "required": [
- "birthDate",
- "hasAcceptedTermsAndConditions"
- ]
- },
- "MeResponse": {
- "type": "object",
- "properties": {
- "profile": {
- "$ref": "#/components/schemas/ProfileResponse"
- },
- "pointBalance": {
- "type": "number"
- },
- "virtualCardId": {
- "type": "string"
- },
- "physicalCardId": {
- "type": "string"
- },
- "activeVouchers": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Voucher"
- }
- },
- "availableVouchers": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Voucher"
- }
- },
- "infoMessage": {
- "$ref": "#/components/schemas/InfoMessageComponent"
- },
- "promotedProducts": {
- "$ref": "#/components/schemas/PromotedProducts"
- }
- },
- "required": [
- "availableVouchers"
- ]
- },
- "LoyaltyResponse": {
- "type": "object",
- "properties": {
- "pointBalance": {
- "type": "number"
- },
- "activeVouchers": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Voucher"
- }
- },
- "availableVouchers": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Voucher"
- }
- },
- "infoMessage": {
- "$ref": "#/components/schemas/InfoMessageComponent"
- },
- "promotedProducts": {
- "$ref": "#/components/schemas/PromotedProducts"
- }
- },
- "required": [
- "availableVouchers"
- ]
- },
- "PromotedProducts": {
- "type": "object",
- "properties": {
- "products": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/PlpListItem"
- }
- },
- "categoryId": {
- "type": "string"
- }
- },
- "required": [
- "products",
- "categoryId"
- ]
- },
- "Voucher": {
- "type": "object",
- "properties": {
- "voucherId": {
- "type": "number"
- },
- "points": {
- "type": "number"
- },
- "isDeactivatable": {
- "type": "boolean"
- },
- "imageUrl": {
- "type": "string"
- },
- "pointsNeededPercentage": {
- "type": "number"
- },
- "type": {
- "$ref": "#/components/schemas/VoucherDisplayType"
- },
- "title": {
- "type": "string"
- },
- "subtitle": {
- "type": "string"
- },
- "description": {
- "type": "string"
- },
- "about": {
- "type": "object",
- "properties": {
- "title": {
- "type": "string"
- },
- "body": {
- "type": "string"
- }
- },
- "required": [
- "title",
- "body"
- ]
- },
- "relatedProduct": {
- "type": "object",
- "properties": {
- "url": {
- "type": "string"
- },
- "label": {
- "type": "string"
- }
- },
- "required": [
- "url",
- "label"
- ]
- },
- "conditions": {
- "type": "object",
- "properties": {
- "title": {
- "type": "string"
- },
- "body": {
- "type": "string"
- }
- },
- "required": [
- "title",
- "body"
- ]
- },
- "trails": {
- "type": "object",
- "properties": {
- "title": {
- "type": "string"
- },
- "lists": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/ContentList"
- }
- }
- },
- "required": [
- "title",
- "lists"
- ]
- }
- },
- "required": [
- "voucherId",
- "isDeactivatable",
- "type",
- "trails"
- ]
- },
- "ContentList": {
- "type": "object",
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "LIST"
- ]
- },
- "style": {
- "type": "string",
- "enum": [
- "NUMERIC"
- ]
- },
- "title": {
- "type": "string"
- },
- "items": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/ContentListItem"
- }
- }
- },
- "required": [
- "type",
- "style",
- "items"
- ]
- },
- "ContentListItem": {
- "type": "object",
- "properties": {
- "text": {
- "type": "string"
- }
- },
- "required": [
- "text"
- ]
- },
- "Toast": {
- "type": "object",
- "properties": {
- "style": {
- "type": "string",
- "enum": [
- "SUCCESS",
- "ERROR"
- ]
- },
- "message": {
- "type": "string"
- }
- },
- "required": [
- "style",
- "message"
- ]
- },
- "CommandRequest": {
- "type": "object",
- "properties": {
- "refreshScreens": {
- "$ref": "#/components/schemas/RefreshScreensTask"
- },
- "toast": {
- "$ref": "#/components/schemas/Toast"
- }
- }
- },
- "ActivateVoucherRequest": {
- "type": "object",
- "properties": {
- "refreshScreens": {
- "$ref": "#/components/schemas/RefreshScreensTask"
- },
- "toast": {
- "$ref": "#/components/schemas/Toast"
- },
- "voucherId": {
- "type": "number"
- },
- "events": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/BFFEvent"
- }
- }
- },
- "required": [
- "voucherId"
- ]
- },
- "BasketCheckoutRequest": {
- "type": "object",
- "properties": {
- "refreshScreens": {
- "$ref": "#/components/schemas/RefreshScreensTask"
- },
- "toast": {
- "$ref": "#/components/schemas/Toast"
- },
- "basketId": {
- "type": "string"
- },
- "productIds": {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "required": [
- "basketId",
- "productIds"
- ]
- },
- "BasketCouponRequest": {
- "type": "object",
- "properties": {
- "refreshScreens": {
- "$ref": "#/components/schemas/RefreshScreensTask"
- },
- "toast": {
- "$ref": "#/components/schemas/Toast"
- },
- "basketId": {
- "type": "string"
- },
- "code": {
- "type": "string"
- },
- "type": {
- "type": "string",
- "enum": [
- "coupon",
- "voucher"
- ]
- }
- },
- "required": [
- "basketId",
- "code",
- "type"
- ]
- },
- "LoyaltyDonatePointsRequest": {
- "type": "object",
- "properties": {
- "refreshScreens": {
- "$ref": "#/components/schemas/RefreshScreensTask"
- },
- "toast": {
- "$ref": "#/components/schemas/Toast"
- },
- "charityId": {
- "type": "string"
- },
- "charityName": {
- "type": "string"
- },
- "amount": {
- "oneOf": [
- {
- "type": "string"
- },
- {
- "type": "number"
- }
- ]
- }
- },
- "required": [
- "charityId",
- "charityName",
- "amount"
- ]
- },
- "DeactivateVoucherRequest": {
- "type": "object",
- "properties": {
- "refreshScreens": {
- "$ref": "#/components/schemas/RefreshScreensTask"
- },
- "toast": {
- "$ref": "#/components/schemas/Toast"
- },
- "activatedVoucherId": {
- "type": "string"
- }
- },
- "required": [
- "activatedVoucherId"
- ]
- },
- "AddReceiptPointsRequest": {
- "type": "object",
- "properties": {
- "receiptTransactionNumber": {
- "type": "string"
- }
- },
- "required": [
- "receiptTransactionNumber"
- ]
- },
- "AddPhysicalCardRequest": {
- "type": "object",
- "properties": {
- "loyaltyCardToken": {
- "type": "string"
- }
- },
- "required": [
- "loyaltyCardToken"
- ]
- },
- "SettingsRequest": {
- "type": "object",
- "properties": {
- "isOptInNewsletter": {
- "type": "boolean"
- },
- "isOptInNewsletterLoyalty": {
- "type": "boolean"
- }
- }
- },
- "Banner": {
- "type": "object",
- "properties": {
- "id": {
- "type": "string"
- },
- "type": {
- "type": "string",
- "enum": [
- "SMALL",
- "LARGE"
- ]
- },
- "imageUrl": {
- "type": "string"
- },
- "accessibilityTitle": {
- "type": "string"
- },
- "action": {
- "$ref": "#/components/schemas/Action"
- }
- },
- "required": [
- "id",
- "type",
- "imageUrl",
- "accessibilityTitle"
- ]
- },
- "HomeResponse": {
- "type": "object",
- "properties": {
- "infoMessages": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/InfoMessageComponent"
- }
- },
- "banners": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Banner"
- }
- },
- "recallButton": {
- "$ref": "#/components/schemas/NormalButton"
- }
- },
- "required": [
- "infoMessages",
- "banners"
- ]
- },
- "Currency": {
- "type": "string",
- "enum": [
- "EUR"
- ]
- },
- "Prices": {
- "type": "object",
- "properties": {
- "price": {
- "$ref": "#/components/schemas/FormattedPrice"
- },
- "fromPrice": {
- "$ref": "#/components/schemas/FormattedPrice"
- },
- "rangeDescriptor": {
- "type": "string"
- },
- "alt": {
- "type": "string"
- }
- },
- "required": [
- "price",
- "alt"
- ]
- },
- "FormattedPrice": {
- "type": "object",
- "properties": {
- "currency": {
- "$ref": "#/components/schemas/Currency"
- },
- "integerPart": {
- "type": "string"
- },
- "fractionalPart": {
- "type": "string"
- },
- "alt": {
- "type": "string"
- }
- },
- "required": [
- "currency",
- "integerPart",
- "alt"
- ]
- },
- "Filters": {
- "type": "object",
- "properties": {
- "baseFilterUrl": {
- "type": "string"
- },
- "baseSearchUrl": {
- "type": "string"
- },
- "total": {
- "type": "number"
- },
- "activeFilterCount": {
- "type": "number"
- },
- "sections": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/FilterSection"
- }
- }
- },
- "required": [
- "baseFilterUrl",
- "baseSearchUrl",
- "total",
- "activeFilterCount",
- "sections"
- ]
- },
- "FilterSection": {
- "type": "object",
- "properties": {
- "title": {
- "type": "string"
- },
- "id": {
- "type": "string"
- },
- "rows": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Filter"
- }
- }
- },
- "required": [
- "title",
- "id",
- "rows"
- ]
- },
- "Filter": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/SelectionFilter"
- },
- {
- "$ref": "#/components/schemas/PriceFilter"
- },
- {
- "$ref": "#/components/schemas/ToggleFilter"
- }
- ]
- },
- "BaseFilter": {
- "type": "object",
- "properties": {
- "id": {
- "type": "string"
- },
- "title": {
- "type": "string"
- },
- "showTitle": {
- "type": "boolean"
- }
- },
- "required": [
- "id",
- "title",
- "showTitle"
- ]
- },
- "SelectionFilter": {
- "type": "object",
- "properties": {
- "id": {
- "type": "string"
- },
- "title": {
- "type": "string"
- },
- "showTitle": {
- "type": "boolean"
- },
- "type": {
- "type": "string",
- "enum": [
- "SELECTION"
- ]
- },
- "selectionType": {
- "type": "string",
- "enum": [
- "MULTIPLE",
- "SINGLE"
- ]
- },
- "options": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/SelectionFilterOption"
- }
- },
- "values": {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "required": [
- "id",
- "title",
- "showTitle",
- "type",
- "selectionType",
- "options",
- "values"
- ]
- },
- "SelectionFilterOption": {
- "type": "object",
- "properties": {
- "id": {
- "type": "string"
- },
- "label": {
- "type": "string"
- },
- "value": {
- "type": "string"
- },
- "hits": {
- "type": "number"
- },
- "image": {
- "$ref": "#/components/schemas/Image"
- }
- },
- "required": [
- "id",
- "label",
- "value"
- ]
- },
- "PriceFilter": {
- "type": "object",
- "properties": {
- "id": {
- "type": "string"
- },
- "title": {
- "type": "string"
- },
- "showTitle": {
- "type": "boolean"
- },
- "type": {
- "type": "string",
- "enum": [
- "PRICE"
- ]
- },
- "min": {
- "type": "number"
- },
- "max": {
- "type": "number"
- },
- "stride": {
- "type": "number"
- },
- "minSelected": {
- "type": "number"
- },
- "maxSelected": {
- "type": "number"
- },
- "currency": {
- "$ref": "#/components/schemas/Currency"
- }
- },
- "required": [
- "id",
- "title",
- "showTitle",
- "type",
- "min",
- "max",
- "stride",
- "currency"
- ]
- },
- "ToggleFilter": {
- "type": "object",
- "properties": {
- "id": {
- "type": "string"
- },
- "title": {
- "type": "string"
- },
- "showTitle": {
- "type": "boolean"
- },
- "type": {
- "type": "string",
- "enum": [
- "TOGGLE"
- ]
- },
- "value": {
- "type": "string"
- },
- "selectedValue": {
- "type": "string"
- }
- },
- "required": [
- "id",
- "title",
- "showTitle",
- "type",
- "value"
- ]
- },
- "AnalyticsFirebaseCustomEvent": {
- "type": "object",
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "FIREBASE_CUSTOM"
- ]
- },
- "name": {
- "type": "string"
- },
- "parameters": {
- "$ref": "#/components/schemas/AnyPrimitives"
- }
- },
- "required": [
- "type",
- "name",
- "parameters"
- ]
- },
- "AnalyticsFirebaseEcomEvent": {
- "type": "object",
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "FIREBASE_ECOM"
- ]
- },
- "name": {
- "type": "string",
- "enum": [
- "ADD_TO_CART",
- "REMOVE_FROM_CART",
- "VIEW_CART",
- "BEGIN_CHECKOUT",
- "PURCHASE",
- "REFUND",
- "VIEW_ITEM",
- "SELECT_ITEM",
- "VIEW_ITEM_LIST",
- "ADD_TO_WISHLIST",
- "ADD_PAYMENT_INFO",
- "ADD_SHIPPING_INFO",
- "SELECT_PROMOTION",
- "VIEW_PROMOTION",
- "SELECT_CONTENT",
- "SHARE"
- ]
- },
- "ecomData": {
- "$ref": "#/components/schemas/FirebaseEcomEventData"
- },
- "customData": {
- "$ref": "#/components/schemas/AnyPrimitives"
- }
- },
- "required": [
- "type",
- "name",
- "ecomData"
- ]
- },
- "FirebaseEcomEventData": {
- "type": "object",
- "properties": {
- "listId": {
- "type": "string"
- },
- "listName": {
- "type": "string"
- },
- "currency": {
- "type": "string"
- },
- "value": {
- "type": "string"
- },
- "coupon": {
- "type": "string"
- },
- "shippingTier": {
- "type": "string"
- },
- "paymentType": {
- "type": "string"
- },
- "transactionId": {
- "type": "string"
- },
- "affiliation": {
- "type": "string"
- },
- "promotionID": {
- "type": "string"
- },
- "promotionName": {
- "type": "string"
- },
- "creativeName": {
- "type": "string"
- },
- "creativeSlot": {
- "type": "string"
- },
- "locationID": {
- "type": "string"
- },
- "tax": {
- "type": "number"
- },
- "shipping": {
- "type": "number"
- },
- "contentType": {
- "type": "string"
- },
- "method": {
- "type": "string"
- },
- "itemId": {
- "type": "string"
- },
- "searchTerm": {
- "type": "string"
- },
- "discount": {
- "type": "number"
- },
- "success": {
- "type": "number"
- },
- "items": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/FirebaseEcomItem"
- }
- }
- }
- },
- "FirebaseEcomItem": {
- "type": "object",
- "properties": {
- "index": {
- "type": "number"
- },
- "itemId": {
- "type": "string"
- },
- "itemName": {
- "type": "string"
- },
- "itemVariant": {
- "type": "string"
- },
- "price": {
- "type": "number"
- },
- "quantity": {
- "type": "number"
- },
- "brand": {
- "type": "string"
- },
- "itemCategory": {
- "type": "string"
- },
- "itemCategory2": {
- "type": "string"
- },
- "itemCategory3": {
- "type": "string"
- },
- "itemCategory4": {
- "type": "string"
- },
- "itemCategory5": {
- "type": "string"
- }
- }
- },
- "AnyPrimitives": {
- "additionalProperties": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "number"
- },
- {
- "type": "boolean"
- }
- ]
- }
- },
- "AnalyticsEvent": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/AnalyticsFirebaseCustomEvent"
- },
- {
- "$ref": "#/components/schemas/AnalyticsFirebaseEcomEvent"
- }
- ]
- },
- "BFFEvent": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/AnalyticsEvent"
- },
- {
- "$ref": "#/components/schemas/AirshipEvent"
- },
- {
- "$ref": "#/components/schemas/DataEvent"
- },
- {
- "$ref": "#/components/schemas/AdjustEvent"
- }
- ]
- },
- "AirshipEvent": {
- "type": "object",
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "AIRSHIP_EVENT"
- ]
- },
- "name": {
- "type": "string"
- },
- "properties": {
- "$ref": "#/components/schemas/AnyPrimitives"
- }
- },
- "required": [
- "type",
- "name",
- "properties"
- ]
- },
- "AdjustEvent": {
- "type": "object",
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "ADJUST_EVENT"
- ]
- },
- "token": {
- "type": "string"
- },
- "callbackParameters": {
- "type": "object",
- "additionalProperties": false,
- "x-patternProperties": {
- ".*": {
- "type": "string"
- }
- }
- },
- "partnerParameters": {
- "type": "object",
- "additionalProperties": false,
- "x-patternProperties": {
- ".*": {
- "type": "string"
- }
- }
- }
- },
- "required": [
- "type",
- "token",
- "callbackParameters",
- "partnerParameters"
- ]
- },
- "DataEvent": {
- "type": "object",
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "DATA_EVENT"
- ]
- },
- "payload": {
- "$ref": "#/components/schemas/DataEventRequest"
- }
- },
- "required": [
- "type",
- "payload"
- ]
- },
- "FingerprintableData": {
- "type": "object",
- "properties": {
- "fingerprint": {
- "type": "string"
- }
- },
- "required": [
- "fingerprint"
- ]
- },
- "AvailableRefreshIds": {
- "type": "string",
- "enum": [
- "vouchers",
- "basket",
- "favorites"
- ]
- },
- "RefreshIds": {
- "type": "array",
- "items": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/AvailableRefreshIds"
- },
- {
- "type": "string"
- }
- ]
- }
- },
- "ScreenBaseData": {
- "type": "object",
- "properties": {
- "id": {
- "type": "string"
- },
- "canRefresh": {
- "type": "boolean"
- },
- "tags": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "refreshIds": {
- "$ref": "#/components/schemas/RefreshIds"
- },
- "autoRefresh": {
- "$ref": "#/components/schemas/AutoRefreshSettings"
- },
- "maximizeScreenBrightness": {
- "type": "boolean"
- },
- "header": {
- "$ref": "#/components/schemas/Header"
- },
- "onReadyEvents": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/BFFEvent"
- }
- },
- "onAppearEvents": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/AnalyticsEvent"
- }
- },
- "onFirstAppearActions": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Action"
- }
- }
- },
- "required": [
- "id",
- "canRefresh",
- "maximizeScreenBrightness"
- ]
- },
- "Screen": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/ScreenWithContentList"
- },
- {
- "$ref": "#/components/schemas/ScreenWithTabs"
- }
- ]
- },
- "ScreenWithContentList": {
- "type": "object",
- "properties": {
- "id": {
- "type": "string"
- },
- "canRefresh": {
- "type": "boolean"
- },
- "tags": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "refreshIds": {
- "$ref": "#/components/schemas/RefreshIds"
- },
- "autoRefresh": {
- "$ref": "#/components/schemas/AutoRefreshSettings"
- },
- "maximizeScreenBrightness": {
- "type": "boolean"
- },
- "header": {
- "$ref": "#/components/schemas/Header"
- },
- "onReadyEvents": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/BFFEvent"
- }
- },
- "onAppearEvents": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/AnalyticsEvent"
- }
- },
- "onFirstAppearActions": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Action"
- }
- },
- "type": {
- "type": "string",
- "enum": [
- "COMPONENT"
- ]
- },
- "content": {
- "$ref": "#/components/schemas/ContentSectionsList"
- }
- },
- "required": [
- "id",
- "canRefresh",
- "maximizeScreenBrightness",
- "type",
- "content"
- ]
- },
- "ScreenWithTabs": {
- "type": "object",
- "properties": {
- "id": {
- "type": "string"
- },
- "canRefresh": {
- "type": "boolean"
- },
- "tags": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "refreshIds": {
- "$ref": "#/components/schemas/RefreshIds"
- },
- "autoRefresh": {
- "$ref": "#/components/schemas/AutoRefreshSettings"
- },
- "maximizeScreenBrightness": {
- "type": "boolean"
- },
- "header": {
- "$ref": "#/components/schemas/TabsHeader"
- },
- "onReadyEvents": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/BFFEvent"
- }
- },
- "onAppearEvents": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/AnalyticsEvent"
- }
- },
- "onFirstAppearActions": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Action"
- }
- },
- "type": {
- "type": "string",
- "enum": [
- "TABS"
- ]
- },
- "tabs": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/ScreenTab"
- }
- },
- "initialTabId": {
- "type": "string"
- }
- },
- "required": [
- "id",
- "canRefresh",
- "maximizeScreenBrightness",
- "type",
- "header",
- "tabs",
- "initialTabId"
- ]
- },
- "ScreenTab": {
- "type": "object",
- "properties": {
- "tabId": {
- "type": "string"
- },
- "content": {
- "$ref": "#/components/schemas/ContentSectionsList"
- }
- },
- "required": [
- "tabId",
- "content"
- ]
- },
- "AutoRefreshSettings": {
- "type": "object",
- "properties": {
- "interval": {
- "type": "number"
- }
- },
- "required": [
- "interval"
- ]
- },
- "ContentSectionsList": {
- "type": "object",
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "SECTIONS"
- ]
- },
- "sections": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Section"
- }
- }
- },
- "required": [
- "type",
- "sections"
- ]
- },
- "Action": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/CommandAction"
- },
- {
- "$ref": "#/components/schemas/CopyToClipboardAction"
- },
- {
- "$ref": "#/components/schemas/DisableContentPreview"
- },
- {
- "$ref": "#/components/schemas/FilterAction"
- },
- {
- "$ref": "#/components/schemas/SignOutAction"
- },
- {
- "$ref": "#/components/schemas/OfflineScreenAction"
- },
- {
- "$ref": "#/components/schemas/OpenAddLoyaltyPointsAction"
- },
- {
- "$ref": "#/components/schemas/OpenCustomerServiceChatAction"
- },
- {
- "$ref": "#/components/schemas/OpenFeedbackFormAction"
- },
- {
- "$ref": "#/components/schemas/OpenLoginAction"
- },
- {
- "$ref": "#/components/schemas/OpenLoyaltyRegistrationAction"
- },
- {
- "$ref": "#/components/schemas/OpenPhoneAction"
- },
- {
- "$ref": "#/components/schemas/OpenProductScannerAction"
- },
- {
- "$ref": "#/components/schemas/OpenLoyaltyCard"
- },
- {
- "$ref": "#/components/schemas/OpenStorefrontSettingsAction"
- },
- {
- "$ref": "#/components/schemas/OpenCookieSettingsAction"
- },
- {
- "$ref": "#/components/schemas/OpenPushSettingsAction"
- },
- {
- "$ref": "#/components/schemas/OpenNewsletterSettingsAction"
- },
- {
- "$ref": "#/components/schemas/OpenReceiptScannerAction"
- },
- {
- "$ref": "#/components/schemas/OpenAccountDetailsAction"
- },
- {
- "$ref": "#/components/schemas/PromptAction"
- },
- {
- "$ref": "#/components/schemas/ScreenAction"
- },
- {
- "$ref": "#/components/schemas/ScreenDismissAction"
- },
- {
- "$ref": "#/components/schemas/ScreenRefreshAction"
- },
- {
- "$ref": "#/components/schemas/ScreenReplaceAction"
- },
- {
- "$ref": "#/components/schemas/ScrollToContentAction"
- },
- {
- "$ref": "#/components/schemas/ShareAction"
- },
- {
- "$ref": "#/components/schemas/ShareTextAction"
- },
- {
- "$ref": "#/components/schemas/WebBrowserAction"
- }
- ]
- },
- "CommandResponseAction": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/CopyToClipboardAction"
- },
- {
- "$ref": "#/components/schemas/DisableContentPreview"
- },
- {
- "$ref": "#/components/schemas/FilterAction"
- },
- {
- "$ref": "#/components/schemas/SignOutAction"
- },
- {
- "$ref": "#/components/schemas/OfflineScreenAction"
- },
- {
- "$ref": "#/components/schemas/OpenAddLoyaltyPointsAction"
- },
- {
- "$ref": "#/components/schemas/OpenCustomerServiceChatAction"
- },
- {
- "$ref": "#/components/schemas/OpenFeedbackFormAction"
- },
- {
- "$ref": "#/components/schemas/OpenLoginAction"
- },
- {
- "$ref": "#/components/schemas/OpenLoyaltyRegistrationAction"
- },
- {
- "$ref": "#/components/schemas/OpenPhoneAction"
- },
- {
- "$ref": "#/components/schemas/OpenProductScannerAction"
- },
- {
- "$ref": "#/components/schemas/OpenLoyaltyCard"
- },
- {
- "$ref": "#/components/schemas/OpenStorefrontSettingsAction"
- },
- {
- "$ref": "#/components/schemas/OpenCookieSettingsAction"
- },
- {
- "$ref": "#/components/schemas/OpenPushSettingsAction"
- },
- {
- "$ref": "#/components/schemas/OpenNewsletterSettingsAction"
- },
- {
- "$ref": "#/components/schemas/OpenReceiptScannerAction"
- },
- {
- "$ref": "#/components/schemas/OpenAccountDetailsAction"
- },
- {
- "$ref": "#/components/schemas/PromptAction"
- },
- {
- "$ref": "#/components/schemas/ScreenAction"
- },
- {
- "$ref": "#/components/schemas/ScreenDismissAction"
- },
- {
- "$ref": "#/components/schemas/ScreenRefreshAction"
- },
- {
- "$ref": "#/components/schemas/ScreenReplaceAction"
- },
- {
- "$ref": "#/components/schemas/ScrollToContentAction"
- },
- {
- "$ref": "#/components/schemas/ShareAction"
- },
- {
- "$ref": "#/components/schemas/ShareTextAction"
- },
- {
- "$ref": "#/components/schemas/WebBrowserAction"
- }
- ]
- },
- "ActionBase": {
- "type": "object",
- "properties": {
- "accessibilityDescription": {
- "type": "string"
- }
- }
- },
- "TerminalActionBase": {
- "type": "object",
- "properties": {
- "accessibilityDescription": {
- "type": "string"
- },
- "onSuccessEvents": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/BFFEvent"
- }
- }
- }
- },
- "ScreenRefreshAction": {
- "type": "object",
- "properties": {
- "accessibilityDescription": {
- "type": "string"
- },
- "onSuccessEvents": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/BFFEvent"
- }
- },
- "type": {
- "type": "string",
- "enum": [
- "SCREEN_REFRESH"
- ]
- },
- "refreshIds": {
- "$ref": "#/components/schemas/RefreshIds"
- }
- },
- "required": [
- "type",
- "refreshIds"
- ]
- },
- "ScreenDismissAction": {
- "type": "object",
- "properties": {
- "accessibilityDescription": {
- "type": "string"
- },
- "onSuccessEvents": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/BFFEvent"
- }
- },
- "type": {
- "type": "string",
- "enum": [
- "SCREEN_DISMISS"
- ]
- }
- },
- "required": [
- "type"
- ]
- },
- "ScreenQueryParameterPlaceholder": {
- "type": "string",
- "enum": [
- "PROFILE_FAVORITE_STORE_ID",
- "PROFILE_LAST_SELECTED_STORE_ID"
- ]
- },
- "ScreenActionBase": {
- "type": "object",
- "properties": {
- "accessibilityDescription": {
- "type": "string"
- },
- "onSuccessEvents": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/BFFEvent"
- }
- },
- "presentationStyle": {
- "$ref": "#/components/schemas/ScreenPresentationStyle"
- }
- },
- "required": [
- "presentationStyle"
- ]
- },
- "ScreenPresentationStyle": {
- "type": "string",
- "enum": [
- "DETAIL",
- "MODAL",
- "SHEET"
- ]
- },
- "ScreenAction": {
- "type": "object",
- "properties": {
- "accessibilityDescription": {
- "type": "string"
- },
- "onSuccessEvents": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/BFFEvent"
- }
- },
- "presentationStyle": {
- "$ref": "#/components/schemas/ScreenPresentationStyle"
- },
- "type": {
- "type": "string",
- "enum": [
- "SCREEN"
- ]
- },
- "url": {
- "type": "string"
- },
- "placeholderContent": {
- "$ref": "#/components/schemas/Screen"
- },
- "queryParameterResolvers": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/ScreenQueryParameterPlaceholder"
- }
- }
- },
- "required": [
- "presentationStyle",
- "type",
- "url"
- ]
- },
- "OfflineScreenAction": {
- "type": "object",
- "properties": {
- "accessibilityDescription": {
- "type": "string"
- },
- "onSuccessEvents": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/BFFEvent"
- }
- },
- "presentationStyle": {
- "$ref": "#/components/schemas/ScreenPresentationStyle"
- },
- "type": {
- "type": "string",
- "enum": [
- "OFFLINE_SCREEN"
- ]
- },
- "content": {
- "$ref": "#/components/schemas/Screen"
- }
- },
- "required": [
- "presentationStyle",
- "type",
- "content"
- ]
- },
- "OpenSearchAction": {
- "type": "object",
- "properties": {
- "accessibilityDescription": {
- "type": "string"
- },
- "onSuccessEvents": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/BFFEvent"
- }
- },
- "presentationStyle": {
- "$ref": "#/components/schemas/ScreenPresentationStyle"
- },
- "type": {
- "type": "string",
- "enum": [
- "OPEN_SEARCH"
- ]
- },
- "content": {
- "$ref": "#/components/schemas/Screen"
- }
- },
- "required": [
- "presentationStyle",
- "type",
- "content"
- ]
- },
- "WebBrowserDisplayType": {
- "type": "string",
- "enum": [
- "EXTERNAL_BROWSER",
- "IN_APP"
- ]
- },
- "WebBrowserAction": {
- "type": "object",
- "properties": {
- "accessibilityDescription": {
- "type": "string"
- },
- "onSuccessEvents": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/BFFEvent"
- }
- },
- "type": {
- "type": "string",
- "enum": [
- "WEB_BROWSER"
- ]
- },
- "displayType": {
- "$ref": "#/components/schemas/WebBrowserDisplayType"
- },
- "url": {
- "type": "string"
- },
- "supportTokenAuthentication": {
- "type": "boolean"
- },
- "requiresSessionBridge": {
- "type": "boolean"
- },
- "requiresLogin": {
- "$ref": "#/components/schemas/RequiresLoginData"
- }
- },
- "required": [
- "type",
- "displayType",
- "url"
- ]
- },
- "DisableContentPreview": {
- "type": "object",
- "properties": {
- "accessibilityDescription": {
- "type": "string"
- },
- "onSuccessEvents": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/BFFEvent"
- }
- },
- "type": {
- "type": "string",
- "enum": [
- "DISABLE_CONTENT_PREVIEW"
- ]
- }
- },
- "required": [
- "type"
- ]
- },
- "CommandAction": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/StandardCommandAction"
- },
- {
- "$ref": "#/components/schemas/AddToFavoritesCommandAction"
- },
- {
- "$ref": "#/components/schemas/RemoveFromFavoritesCommandAction"
- },
- {
- "$ref": "#/components/schemas/SetBasketItemCommandAction"
- },
- {
- "$ref": "#/components/schemas/ApplyCouponCommandAction"
- },
- {
- "$ref": "#/components/schemas/DonateLoyaltyPointsCommandAction"
- }
- ]
- },
- "CommandActionSubtype": {
- "type": "string",
- "enum": [
- "SET_BASKET_ITEM",
- "ADD_TO_FAVORITES",
- "REMOVE_FROM_FAVORITES",
- "APPLY_COUPON",
- "DONATE_LOYALTY_POINTS",
- "STANDARD"
- ]
- },
- "TransientStateType": {
- "type": "string",
- "enum": [
- "INVALIDATED",
- "LOADING",
- "TAKKIELOADING"
- ]
- },
- "TransientState": {
- "type": "object",
- "properties": {
- "type": {
- "$ref": "#/components/schemas/TransientStateType"
- },
- "tags": {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "required": [
- "type",
- "tags"
- ]
- },
- "CommandActionBase": {
- "type": "object",
- "properties": {
- "accessibilityDescription": {
- "type": "string"
- },
- "type": {
- "type": "string",
- "enum": [
- "COMMAND"
- ]
- },
- "subtype": {
- "$ref": "#/components/schemas/CommandActionSubtype"
- },
- "url": {
- "type": "string"
- },
- "payload": {
- "type": "string"
- },
- "requiresLogin": {
- "$ref": "#/components/schemas/RequiresLoginData"
- },
- "loadingId": {
- "type": "string"
- },
- "transientStates": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/TransientState"
- }
- }
- },
- "required": [
- "type",
- "subtype",
- "url",
- "loadingId",
- "transientStates"
- ]
- },
- "StandardCommandAction": {
- "type": "object",
- "properties": {
- "accessibilityDescription": {
- "type": "string"
- },
- "type": {
- "type": "string",
- "enum": [
- "COMMAND"
- ]
- },
- "subtype": {
- "type": "string",
- "enum": [
- "STANDARD"
- ]
- },
- "url": {
- "type": "string"
- },
- "payload": {
- "type": "string"
- },
- "requiresLogin": {
- "$ref": "#/components/schemas/RequiresLoginData"
- },
- "loadingId": {
- "type": "string"
- },
- "transientStates": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/TransientState"
- }
- }
- },
- "required": [
- "type",
- "subtype",
- "url",
- "loadingId",
- "transientStates"
- ]
- },
- "AddToFavoritesCommandAction": {
- "type": "object",
- "properties": {
- "accessibilityDescription": {
- "type": "string"
- },
- "type": {
- "type": "string",
- "enum": [
- "COMMAND"
- ]
- },
- "subtype": {
- "type": "string",
- "enum": [
- "ADD_TO_FAVORITES"
- ]
- },
- "url": {
- "type": "string"
- },
- "payload": {
- "type": "string"
- },
- "requiresLogin": {
- "$ref": "#/components/schemas/RequiresLoginData"
- },
- "loadingId": {
- "type": "string"
- },
- "transientStates": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/TransientState"
- }
- },
- "productId": {
- "type": "string"
- }
- },
- "required": [
- "type",
- "subtype",
- "url",
- "loadingId",
- "transientStates",
- "productId"
- ]
- },
- "RemoveFromFavoritesCommandAction": {
- "type": "object",
- "properties": {
- "accessibilityDescription": {
- "type": "string"
- },
- "type": {
- "type": "string",
- "enum": [
- "COMMAND"
- ]
- },
- "subtype": {
- "type": "string",
- "enum": [
- "REMOVE_FROM_FAVORITES"
- ]
- },
- "url": {
- "type": "string"
- },
- "payload": {
- "type": "string"
- },
- "requiresLogin": {
- "$ref": "#/components/schemas/RequiresLoginData"
- },
- "loadingId": {
- "type": "string"
- },
- "transientStates": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/TransientState"
- }
- },
- "productId": {
- "type": "string"
- }
- },
- "required": [
- "type",
- "subtype",
- "url",
- "loadingId",
- "transientStates",
- "productId"
- ]
- },
- "SetBasketItemCommandAction": {
- "type": "object",
- "properties": {
- "accessibilityDescription": {
- "type": "string"
- },
- "type": {
- "type": "string",
- "enum": [
- "COMMAND"
- ]
- },
- "subtype": {
- "type": "string",
- "enum": [
- "SET_BASKET_ITEM"
- ]
- },
- "url": {
- "type": "string"
- },
- "payload": {
- "type": "string"
- },
- "requiresLogin": {
- "$ref": "#/components/schemas/RequiresLoginData"
- },
- "loadingId": {
- "type": "string"
- },
- "transientStates": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/TransientState"
- }
- },
- "productId": {
- "type": "string"
- },
- "amount": {
- "type": "number"
- }
- },
- "required": [
- "type",
- "subtype",
- "url",
- "loadingId",
- "transientStates",
- "productId"
- ]
- },
- "ApplyCouponCommandAction": {
- "type": "object",
- "properties": {
- "accessibilityDescription": {
- "type": "string"
- },
- "type": {
- "type": "string",
- "enum": [
- "COMMAND"
- ]
- },
- "subtype": {
- "type": "string",
- "enum": [
- "APPLY_COUPON"
- ]
- },
- "url": {
- "type": "string"
- },
- "payload": {
- "type": "string"
- },
- "requiresLogin": {
- "$ref": "#/components/schemas/RequiresLoginData"
- },
- "loadingId": {
- "type": "string"
- },
- "transientStates": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/TransientState"
- }
- }
- },
- "required": [
- "type",
- "subtype",
- "url",
- "loadingId",
- "transientStates"
- ]
- },
- "DonateLoyaltyPointsCommandAction": {
- "type": "object",
- "properties": {
- "accessibilityDescription": {
- "type": "string"
- },
- "type": {
- "type": "string",
- "enum": [
- "COMMAND"
- ]
- },
- "subtype": {
- "type": "string",
- "enum": [
- "DONATE_LOYALTY_POINTS"
- ]
- },
- "url": {
- "type": "string"
- },
- "payload": {
- "type": "string"
- },
- "requiresLogin": {
- "$ref": "#/components/schemas/RequiresLoginData"
- },
- "loadingId": {
- "type": "string"
- },
- "transientStates": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/TransientState"
- }
- }
- },
- "required": [
- "type",
- "subtype",
- "url",
- "loadingId",
- "transientStates"
- ]
- },
- "RequiresLoginData": {
- "type": "object",
- "properties": {
- "title": {
- "type": "string"
- },
- "text": {
- "type": "string"
- },
- "image": {
- "$ref": "#/components/schemas/LocalImage"
- },
- "runAfterLogin": {
- "type": "boolean"
- }
- },
- "required": [
- "title",
- "text",
- "runAfterLogin"
- ]
- },
- "ScreenReplaceAction": {
- "type": "object",
- "properties": {
- "accessibilityDescription": {
- "type": "string"
- },
- "onSuccessEvents": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/BFFEvent"
- }
- },
- "type": {
- "type": "string",
- "enum": [
- "REPLACE"
- ]
- },
- "url": {
- "type": "string"
- },
- "queryParameterResolvers": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/ScreenQueryParameterPlaceholder"
- }
- }
- },
- "required": [
- "type",
- "url"
- ]
- },
- "PromptAction": {
- "type": "object",
- "properties": {
- "accessibilityDescription": {
- "type": "string"
- },
- "onSuccessEvents": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/BFFEvent"
- }
- },
- "type": {
- "type": "string",
- "enum": [
- "PROMPT"
- ]
- },
- "prompt": {
- "$ref": "#/components/schemas/Prompt"
- }
- },
- "required": [
- "type",
- "prompt"
- ]
- },
- "FilterAction": {
- "type": "object",
- "properties": {
- "accessibilityDescription": {
- "type": "string"
- },
- "onSuccessEvents": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/BFFEvent"
- }
- },
- "type": {
- "type": "string",
- "enum": [
- "FILTER"
- ]
- },
- "filters": {
- "$ref": "#/components/schemas/Filters"
- }
- },
- "required": [
- "type",
- "filters"
- ]
- },
- "SignOutAction": {
- "type": "object",
- "properties": {
- "accessibilityDescription": {
- "type": "string"
- },
- "onSuccessEvents": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/BFFEvent"
- }
- },
- "type": {
- "type": "string",
- "enum": [
- "SIGN_OUT"
- ]
- }
- },
- "required": [
- "type"
- ]
- },
- "ShareAction": {
- "type": "object",
- "properties": {
- "accessibilityDescription": {
- "type": "string"
- },
- "onSuccessEvents": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/BFFEvent"
- }
- },
- "type": {
- "type": "string",
- "enum": [
- "SHARE"
- ]
- },
- "url": {
- "type": "string"
- }
- },
- "required": [
- "type",
- "url"
- ]
- },
- "ShareTextAction": {
- "type": "object",
- "properties": {
- "accessibilityDescription": {
- "type": "string"
- },
- "onSuccessEvents": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/BFFEvent"
- }
- },
- "type": {
- "type": "string",
- "enum": [
- "SHARE_TEXT"
- ]
- },
- "text": {
- "type": "string"
- }
- },
- "required": [
- "type",
- "text"
- ]
- },
- "OpenFeedbackFormAction": {
- "type": "object",
- "properties": {
- "accessibilityDescription": {
- "type": "string"
- },
- "onSuccessEvents": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/BFFEvent"
- }
- },
- "type": {
- "type": "string",
- "enum": [
- "OPEN_FEEDBACK_FORM"
- ]
- }
- },
- "required": [
- "type"
- ]
- },
- "OpenStorefrontSettingsAction": {
- "type": "object",
- "properties": {
- "accessibilityDescription": {
- "type": "string"
- },
- "onSuccessEvents": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/BFFEvent"
- }
- },
- "type": {
- "type": "string",
- "enum": [
- "OPEN_STOREFRONT_SETTINGS"
- ]
- }
- },
- "required": [
- "type"
- ]
- },
- "OpenCookieSettingsAction": {
- "type": "object",
- "properties": {
- "accessibilityDescription": {
- "type": "string"
- },
- "onSuccessEvents": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/BFFEvent"
- }
- },
- "type": {
- "type": "string",
- "enum": [
- "OPEN_COOKIE_SETTINGS"
- ]
- }
- },
- "required": [
- "type"
- ]
- },
- "OpenPushSettingsAction": {
- "type": "object",
- "properties": {
- "accessibilityDescription": {
- "type": "string"
- },
- "onSuccessEvents": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/BFFEvent"
- }
- },
- "type": {
- "type": "string",
- "enum": [
- "OPEN_PUSH_SETTINGS"
- ]
- }
- },
- "required": [
- "type"
- ]
- },
- "OpenNewsletterSettingsAction": {
- "type": "object",
- "properties": {
- "accessibilityDescription": {
- "type": "string"
- },
- "onSuccessEvents": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/BFFEvent"
- }
- },
- "type": {
- "type": "string",
- "enum": [
- "OPEN_NEWSLETTER_SETTINGS"
- ]
- }
- },
- "required": [
- "type"
- ]
- },
- "OpenReceiptScannerAction": {
- "type": "object",
- "properties": {
- "accessibilityDescription": {
- "type": "string"
- },
- "onSuccessEvents": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/BFFEvent"
- }
- },
- "type": {
- "type": "string",
- "enum": [
- "OPEN_RECEIPT_SCANNER"
- ]
- }
- },
- "required": [
- "type"
- ]
- },
- "OpenAccountDetailsAction": {
- "type": "object",
- "properties": {
- "accessibilityDescription": {
- "type": "string"
- },
- "onSuccessEvents": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/BFFEvent"
- }
- },
- "type": {
- "type": "string",
- "enum": [
- "OPEN_ACCOUNT_DETAILS"
- ]
- }
- },
- "required": [
- "type"
- ]
- },
- "OpenPhoneAction": {
- "type": "object",
- "properties": {
- "accessibilityDescription": {
- "type": "string"
- },
- "onSuccessEvents": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/BFFEvent"
- }
- },
- "type": {
- "type": "string",
- "enum": [
- "OPEN_PHONE"
- ]
- },
- "phoneNumber": {
- "type": "string"
- }
- },
- "required": [
- "type",
- "phoneNumber"
- ]
- },
- "OpenProductScannerAction": {
- "type": "object",
- "properties": {
- "accessibilityDescription": {
- "type": "string"
- },
- "onSuccessEvents": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/BFFEvent"
- }
- },
- "type": {
- "type": "string",
- "enum": [
- "OPEN_PRODUCT_SCANNER"
- ]
- }
- },
- "required": [
- "type"
- ]
- },
- "OpenLoyaltyCard": {
- "type": "object",
- "properties": {
- "accessibilityDescription": {
- "type": "string"
- },
- "onSuccessEvents": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/BFFEvent"
- }
- },
- "type": {
- "type": "string",
- "enum": [
- "OPEN_LOYALTY_CARD"
- ]
- }
- },
- "required": [
- "type"
- ]
- },
- "OpenCustomerServiceChatAction": {
- "type": "object",
- "properties": {
- "accessibilityDescription": {
- "type": "string"
- },
- "onSuccessEvents": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/BFFEvent"
- }
- },
- "type": {
- "type": "string",
- "enum": [
- "OPEN_CUSTOMER_SERVICE_CHAT"
- ]
- },
- "liveAgentPod": {
- "type": "string"
- },
- "orgId": {
- "type": "string"
- },
- "deploymentId": {
- "type": "string"
- },
- "buttonId": {
- "type": "string"
- }
- },
- "required": [
- "type",
- "liveAgentPod",
- "orgId",
- "deploymentId",
- "buttonId"
- ]
- },
- "OpenLoginAction": {
- "type": "object",
- "properties": {
- "accessibilityDescription": {
- "type": "string"
- },
- "onSuccessEvents": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/BFFEvent"
- }
- },
- "type": {
- "type": "string",
- "enum": [
- "OPEN_LOGIN"
- ]
- }
- },
- "required": [
- "type"
- ]
- },
- "OpenAddLoyaltyPointsAction": {
- "type": "object",
- "properties": {
- "accessibilityDescription": {
- "type": "string"
- },
- "onSuccessEvents": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/BFFEvent"
- }
- },
- "type": {
- "type": "string",
- "enum": [
- "OPEN_ADD_LOYALTY_POINTS"
- ]
- }
- },
- "required": [
- "type"
- ]
- },
- "OpenLoyaltyRegistrationAction": {
- "type": "object",
- "properties": {
- "accessibilityDescription": {
- "type": "string"
- },
- "onSuccessEvents": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/BFFEvent"
- }
- },
- "type": {
- "type": "string",
- "enum": [
- "OPEN_LOYALTY_REGISTRATION"
- ]
- }
- },
- "required": [
- "type"
- ]
- },
- "ScrollToContentAction": {
- "type": "object",
- "properties": {
- "accessibilityDescription": {
- "type": "string"
- },
- "onSuccessEvents": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/BFFEvent"
- }
- },
- "type": {
- "type": "string",
- "enum": [
- "SCROLL_TO_CONTENT"
- ]
- },
- "contentId": {
- "type": "string"
- }
- },
- "required": [
- "type",
- "contentId"
- ]
- },
- "CopyToClipboardAction": {
- "type": "object",
- "properties": {
- "accessibilityDescription": {
- "type": "string"
- },
- "onSuccessEvents": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/BFFEvent"
- }
- },
- "type": {
- "type": "string",
- "enum": [
- "COPY_TO_CLIPBOARD"
- ]
- },
- "value": {
- "type": "string"
- },
- "successMessage": {
- "type": "string"
- }
- },
- "required": [
- "type",
- "value",
- "successMessage"
- ]
- },
- "Prompt": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/SelectionPrompt"
- },
- {
- "$ref": "#/components/schemas/DialogPrompt"
- }
- ]
- },
- "DialogPrompt": {
- "type": "object",
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "DIALOG"
- ]
- },
- "title": {
- "type": "string"
- },
- "message": {
- "type": "string"
- },
- "confirmButtonTitle": {
- "type": "string"
- },
- "cancelButonTitle": {
- "type": "string"
- },
- "confirmAction": {
- "$ref": "#/components/schemas/Action"
- }
- },
- "required": [
- "type",
- "title",
- "message",
- "confirmButtonTitle",
- "cancelButonTitle",
- "confirmAction"
- ]
- },
- "SelectionPrompt": {
- "type": "object",
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "SELECTION"
- ]
- },
- "components": {
- "type": "array",
- "items": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/VariationListItem"
- },
- {
- "$ref": "#/components/schemas/TitleComponent"
- }
- ]
- }
- },
- "button": {
- "$ref": "#/components/schemas/PlainButton"
- }
- },
- "required": [
- "type",
- "components"
- ]
- },
- "Header": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/TextHeader"
- },
- {
- "$ref": "#/components/schemas/FilterHeader"
- },
- {
- "$ref": "#/components/schemas/SearchHeader"
- },
- {
- "$ref": "#/components/schemas/ProductHeader"
- },
- {
- "$ref": "#/components/schemas/ProfileHeader"
- },
- {
- "$ref": "#/components/schemas/ImageHeader"
- }
- ]
- },
- "HeaderButton": {
- "type": "object",
- "properties": {
- "action": {
- "$ref": "#/components/schemas/Action"
- },
- "icon": {
- "$ref": "#/components/schemas/LocalImage"
- }
- },
- "required": [
- "action",
- "icon"
- ]
- },
- "HeaderBase": {
- "type": "object",
- "properties": {
- "title": {
- "type": "string"
- },
- "isLoading": {
- "type": "boolean"
- }
- },
- "required": [
- "title",
- "isLoading"
- ]
- },
- "TabsHeader": {
- "type": "object",
- "properties": {
- "title": {
- "type": "string"
- },
- "isLoading": {
- "type": "boolean"
- },
- "type": {
- "type": "string",
- "enum": [
- "TABS"
- ]
- },
- "buttons": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/TabsHeaderButton"
- }
- }
- },
- "required": [
- "title",
- "isLoading",
- "type",
- "buttons"
- ]
- },
- "TabsHeaderButton": {
- "type": "object",
- "properties": {
- "title": {
- "type": "string"
- },
- "tabId": {
- "type": "string"
- },
- "tapEvents": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/BFFEvent"
- }
- }
- },
- "required": [
- "title",
- "tabId"
- ]
- },
- "TextHeader": {
- "type": "object",
- "properties": {
- "title": {
- "type": "string"
- },
- "isLoading": {
- "type": "boolean"
- },
- "type": {
- "type": "string",
- "enum": [
- "TEXT"
- ]
- },
- "trailingHeaderButtons": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/HeaderButton"
- }
- },
- "subtitle": {
- "type": "string"
- }
- },
- "required": [
- "title",
- "isLoading",
- "type"
- ]
- },
- "FilterHeader": {
- "type": "object",
- "properties": {
- "title": {
- "type": "string"
- },
- "isLoading": {
- "type": "boolean"
- },
- "type": {
- "type": "string",
- "enum": [
- "FILTER"
- ]
- },
- "filterButton": {
- "$ref": "#/components/schemas/NormalButton"
- },
- "subtitle": {
- "type": "string"
- }
- },
- "required": [
- "title",
- "isLoading",
- "type"
- ]
- },
- "SearchHeader": {
- "type": "object",
- "properties": {
- "title": {
- "type": "string"
- },
- "isLoading": {
- "type": "boolean"
- },
- "type": {
- "type": "string",
- "enum": [
- "SEARCH"
- ]
- },
- "placeholder": {
- "type": "string"
- },
- "showScanAction": {
- "type": "boolean"
- },
- "scanActionIcon": {
- "$ref": "#/components/schemas/Image"
- },
- "searchAction": {
- "$ref": "#/components/schemas/OpenSearchAction"
- }
- },
- "required": [
- "title",
- "isLoading",
- "type",
- "showScanAction",
- "scanActionIcon",
- "searchAction"
- ]
- },
- "ProductHeader": {
- "type": "object",
- "properties": {
- "title": {
- "type": "string"
- },
- "isLoading": {
- "type": "boolean"
- },
- "type": {
- "type": "string",
- "enum": [
- "PRODUCT"
- ]
- },
- "productId": {
- "type": "string"
- },
- "favoriteAction": {
- "$ref": "#/components/schemas/Action"
- },
- "unFavoriteAction": {
- "$ref": "#/components/schemas/Action"
- },
- "prices": {
- "$ref": "#/components/schemas/Prices"
- },
- "images": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Image"
- }
- },
- "paymentOptionsImage": {
- "$ref": "#/components/schemas/Image"
- },
- "primaryButton": {
- "$ref": "#/components/schemas/Button"
- },
- "extraButtons": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Button"
- }
- },
- "rating": {
- "type": "number"
- },
- "ratingLabel": {
- "type": "string"
- },
- "ratingAction": {
- "$ref": "#/components/schemas/Action"
- },
- "stock": {
- "$ref": "#/components/schemas/ProductStock"
- },
- "quantityInfo": {
- "type": "string"
- },
- "actionSigningImage": {
- "$ref": "#/components/schemas/Image"
- },
- "shareAction": {
- "$ref": "#/components/schemas/Action"
- }
- },
- "required": [
- "title",
- "isLoading",
- "type",
- "productId",
- "images"
- ]
- },
- "ProfileHeader": {
- "type": "object",
- "properties": {
- "title": {
- "type": "string"
- },
- "isLoading": {
- "type": "boolean"
- },
- "type": {
- "type": "string",
- "enum": [
- "PROFILE"
- ]
- }
- },
- "required": [
- "title",
- "isLoading",
- "type"
- ]
- },
- "ImageHeader": {
- "type": "object",
- "properties": {
- "title": {
- "type": "string"
- },
- "isLoading": {
- "type": "boolean"
- },
- "type": {
- "type": "string",
- "enum": [
- "IMAGE"
- ]
- },
- "image": {
- "$ref": "#/components/schemas/RemoteImage"
- }
- },
- "required": [
- "title",
- "isLoading",
- "type",
- "image"
- ]
- },
- "ProductStock": {
- "type": "object",
- "properties": {
- "outOfStockMessage": {
- "type": "string"
- },
- "scarcityText": {
- "type": "string"
- },
- "inventories": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/ProductStockInventory"
- }
- }
- },
- "required": [
- "inventories"
- ]
- },
- "ProductStockInventory": {
- "type": "object",
- "properties": {
- "quantity": {
- "type": "number"
- },
- "deliveryPromise": {
- "type": "string"
- }
- },
- "required": [
- "quantity"
- ]
- },
- "Section": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/PrimarySection"
- },
- {
- "$ref": "#/components/schemas/InfoSection"
- },
- {
- "$ref": "#/components/schemas/CarouselSection"
- }
- ]
- },
- "SectionBase": {
- "type": "object",
- "properties": {
- "contentId": {
- "type": "string"
- },
- "components": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Component"
- }
- },
- "nextPage": {
- "$ref": "#/components/schemas/LoadComponents"
- },
- "spacingTop": {
- "$ref": "#/components/schemas/SectionSpacing"
- },
- "spacingBottom": {
- "$ref": "#/components/schemas/SectionSpacing"
- },
- "separatorTop": {
- "$ref": "#/components/schemas/SeparatorStyle"
- },
- "separatorBottom": {
- "$ref": "#/components/schemas/SeparatorStyle"
- },
- "isUsingSpacerComponents": {
- "type": "boolean"
- }
- },
- "required": [
- "contentId",
- "components"
- ]
- },
- "PrimarySection": {
- "type": "object",
- "properties": {
- "contentId": {
- "type": "string"
- },
- "components": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Component"
- }
- },
- "nextPage": {
- "$ref": "#/components/schemas/LoadComponents"
- },
- "spacingTop": {
- "$ref": "#/components/schemas/SectionSpacing"
- },
- "spacingBottom": {
- "$ref": "#/components/schemas/SectionSpacing"
- },
- "separatorTop": {
- "$ref": "#/components/schemas/SeparatorStyle"
- },
- "separatorBottom": {
- "$ref": "#/components/schemas/SeparatorStyle"
- },
- "isUsingSpacerComponents": {
- "type": "boolean"
- },
- "type": {
- "type": "string",
- "enum": [
- "PRIMARY"
- ]
- }
- },
- "required": [
- "contentId",
- "components",
- "type"
- ]
- },
- "InfoSection": {
- "type": "object",
- "properties": {
- "contentId": {
- "type": "string"
- },
- "components": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Component"
- }
- },
- "nextPage": {
- "$ref": "#/components/schemas/LoadComponents"
- },
- "spacingTop": {
- "$ref": "#/components/schemas/SectionSpacing"
- },
- "spacingBottom": {
- "$ref": "#/components/schemas/SectionSpacing"
- },
- "separatorTop": {
- "$ref": "#/components/schemas/SeparatorStyle"
- },
- "separatorBottom": {
- "$ref": "#/components/schemas/SeparatorStyle"
- },
- "isUsingSpacerComponents": {
- "type": "boolean"
- },
- "type": {
- "type": "string",
- "enum": [
- "INFO"
- ]
- },
- "button": {
- "$ref": "#/components/schemas/PlainButton"
- }
- },
- "required": [
- "contentId",
- "components",
- "type"
- ]
- },
- "CarouselSection": {
- "type": "object",
- "properties": {
- "contentId": {
- "type": "string"
- },
- "components": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/CarouselItem"
- }
- },
- "nextPage": {
- "$ref": "#/components/schemas/LoadComponents"
- },
- "spacingTop": {
- "$ref": "#/components/schemas/SectionSpacing"
- },
- "spacingBottom": {
- "$ref": "#/components/schemas/SectionSpacing"
- },
- "separatorTop": {
- "$ref": "#/components/schemas/SeparatorStyle"
- },
- "separatorBottom": {
- "$ref": "#/components/schemas/SeparatorStyle"
- },
- "isUsingSpacerComponents": {
- "type": "boolean"
- },
- "type": {
- "type": "string",
- "enum": [
- "CAROUSEL"
- ]
- },
- "title": {
- "type": "string"
- },
- "titleDisplaySize": {
- "type": "string",
- "enum": [
- "MEDIUM",
- "LARGE"
- ]
- },
- "action": {
- "$ref": "#/components/schemas/Action"
- },
- "actionLabel": {
- "type": "string"
- },
- "actionIcon": {
- "$ref": "#/components/schemas/Image"
- }
- },
- "required": [
- "contentId",
- "components",
- "type"
- ]
- },
- "SectionSpacing": {
- "type": "string",
- "enum": [
- "SMALL",
- "MEDIUM",
- "LARGE"
- ]
- },
- "SeparatorStyle": {
- "type": "string",
- "enum": [
- "FULL",
- "INDENTED"
- ]
- },
- "SearchBarComponentExperiment": {
- "type": "object",
- "properties": {
- "fingerprint": {
- "type": "string"
- },
- "contentId": {
- "type": "string"
- },
- "tags": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "type": {
- "type": "string",
- "enum": [
- "SEARCH_BAR_EXPERIMENT"
- ]
- },
- "placeholder": {
- "type": "string"
- },
- "searchAction": {
- "$ref": "#/components/schemas/OpenSearchAction"
- }
- },
- "required": [
- "fingerprint",
- "contentId",
- "type",
- "placeholder",
- "searchAction"
- ]
- },
- "ProductCondensedComponentBase": {
- "type": "object",
- "properties": {
- "fingerprint": {
- "type": "string"
- },
- "contentId": {
- "type": "string"
- },
- "tags": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "action": {
- "$ref": "#/components/schemas/Action"
- },
- "title": {
- "type": "string"
- },
- "prices": {
- "$ref": "#/components/schemas/Prices"
- },
- "image": {
- "$ref": "#/components/schemas/Image"
- },
- "variationIcon": {
- "$ref": "#/components/schemas/LocalImage"
- },
- "favoriteAction": {
- "$ref": "#/components/schemas/Action"
- },
- "unFavoriteAction": {
- "$ref": "#/components/schemas/Action"
- },
- "primaryButton": {
- "$ref": "#/components/schemas/Button"
- },
- "productId": {
- "type": "string"
- },
- "actionSigningImage": {
- "$ref": "#/components/schemas/Image"
- },
- "rating": {
- "type": "number"
- },
- "importantInfo": {
- "type": "string"
- },
- "quantityInfo": {
- "type": "string"
- }
- },
- "required": [
- "fingerprint",
- "contentId",
- "title",
- "image",
- "productId"
- ]
- },
- "PlpListItem": {
- "type": "object",
- "properties": {
- "fingerprint": {
- "type": "string"
- },
- "contentId": {
- "type": "string"
- },
- "tags": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "action": {
- "$ref": "#/components/schemas/Action"
- },
- "title": {
- "type": "string"
- },
- "prices": {
- "$ref": "#/components/schemas/Prices"
- },
- "image": {
- "$ref": "#/components/schemas/Image"
- },
- "variationIcon": {
- "$ref": "#/components/schemas/LocalImage"
- },
- "favoriteAction": {
- "$ref": "#/components/schemas/Action"
- },
- "unFavoriteAction": {
- "$ref": "#/components/schemas/Action"
- },
- "primaryButton": {
- "$ref": "#/components/schemas/Button"
- },
- "productId": {
- "type": "string"
- },
- "actionSigningImage": {
- "$ref": "#/components/schemas/Image"
- },
- "rating": {
- "type": "number"
- },
- "importantInfo": {
- "type": "string"
- },
- "quantityInfo": {
- "type": "string"
- },
- "type": {
- "type": "string",
- "enum": [
- "PRODUCT_CONDENSED"
- ]
- }
- },
- "required": [
- "fingerprint",
- "contentId",
- "title",
- "image",
- "productId",
- "type"
- ]
- },
- "FavoriteListItem": {
- "type": "object",
- "properties": {
- "fingerprint": {
- "type": "string"
- },
- "contentId": {
- "type": "string"
- },
- "tags": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "action": {
- "$ref": "#/components/schemas/Action"
- },
- "title": {
- "type": "string"
- },
- "type": {
- "type": "string",
- "enum": [
- "FAVORITE"
- ]
- },
- "prices": {
- "$ref": "#/components/schemas/Prices"
- },
- "additionalInfo": {
- "type": "string"
- },
- "importantInfo": {
- "type": "string"
- },
- "image": {
- "$ref": "#/components/schemas/Image"
- },
- "active": {
- "type": "boolean"
- },
- "unFavoriteAction": {
- "$ref": "#/components/schemas/Action"
- },
- "primaryButton": {
- "$ref": "#/components/schemas/Button"
- },
- "productId": {
- "type": "string"
- },
- "actionSigningImage": {
- "$ref": "#/components/schemas/Image"
- }
- },
- "required": [
- "fingerprint",
- "contentId",
- "title",
- "type",
- "image",
- "active",
- "productId"
- ]
- },
- "PlainListItem": {
- "type": "object",
- "properties": {
- "fingerprint": {
- "type": "string"
- },
- "contentId": {
- "type": "string"
- },
- "tags": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "action": {
- "$ref": "#/components/schemas/Action"
- },
- "type": {
- "type": "string",
- "enum": [
- "PLAIN"
- ]
- },
- "title": {
- "type": "string"
- },
- "image": {
- "$ref": "#/components/schemas/Image"
- },
- "emphasisLevel": {
- "type": "string",
- "enum": [
- "NONE",
- "LIGHT",
- "STRONG"
- ]
- },
- "indicator": {
- "type": "string",
- "enum": [
- "RED",
- "BLUE"
- ]
- }
- },
- "required": [
- "fingerprint",
- "contentId",
- "type",
- "title",
- "emphasisLevel"
- ]
- },
- "QRCodeListItem": {
- "type": "object",
- "properties": {
- "fingerprint": {
- "type": "string"
- },
- "contentId": {
- "type": "string"
- },
- "tags": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "action": {
- "$ref": "#/components/schemas/Action"
- },
- "type": {
- "type": "string",
- "enum": [
- "QR_CODE_LIST_ITEM"
- ]
- },
- "title": {
- "type": "string"
- },
- "description": {
- "type": "string"
- },
- "code": {
- "type": "string"
- },
- "accessibilityDescription": {
- "type": "string"
- }
- },
- "required": [
- "fingerprint",
- "contentId",
- "type",
- "title",
- "description",
- "code",
- "accessibilityDescription"
- ]
- },
- "VariationListItem": {
- "type": "object",
- "properties": {
- "fingerprint": {
- "type": "string"
- },
- "contentId": {
- "type": "string"
- },
- "tags": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "action": {
- "$ref": "#/components/schemas/Action"
- },
- "type": {
- "type": "string",
- "enum": [
- "VARIATION"
- ]
- },
- "title": {
- "type": "string"
- },
- "image": {
- "$ref": "#/components/schemas/Image"
- },
- "selected": {
- "type": "boolean"
- },
- "importantInfo": {
- "type": "string"
- },
- "quantityInfo": {
- "type": "string"
- },
- "price": {
- "$ref": "#/components/schemas/Prices"
- },
- "active": {
- "type": "boolean"
- }
- },
- "required": [
- "fingerprint",
- "contentId",
- "type",
- "selected",
- "active"
- ]
- },
- "PlainTextDisplayStyle": {
- "type": "string",
- "enum": [
- "NORMAL",
- "HIGHLIGHTED"
- ]
- },
- "PlainTextDisplaySize": {
- "type": "string",
- "enum": [
- "MEDIUM",
- "LARGE"
- ]
- },
- "PlainTextListItem": {
- "type": "object",
- "properties": {
- "fingerprint": {
- "type": "string"
- },
- "contentId": {
- "type": "string"
- },
- "tags": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "action": {
- "$ref": "#/components/schemas/Action"
- },
- "type": {
- "type": "string",
- "enum": [
- "PLAIN_TEXT"
- ]
- },
- "displayStyle": {
- "$ref": "#/components/schemas/PlainTextDisplayStyle"
- },
- "displaySize": {
- "$ref": "#/components/schemas/PlainTextDisplaySize"
- },
- "title": {
- "type": "string"
- },
- "subtitle": {
- "type": "string"
- },
- "separatorTop": {
- "$ref": "#/components/schemas/SeparatorStyle"
- },
- "iconRight": {
- "$ref": "#/components/schemas/Image"
- }
- },
- "required": [
- "fingerprint",
- "contentId",
- "type",
- "displayStyle",
- "title"
- ]
- },
- "PlainProductListItem": {
- "type": "object",
- "properties": {
- "fingerprint": {
- "type": "string"
- },
- "contentId": {
- "type": "string"
- },
- "tags": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "action": {
- "$ref": "#/components/schemas/Action"
- },
- "type": {
- "type": "string",
- "enum": [
- "PLAIN_PRODUCT"
- ]
- },
- "title": {
- "type": "string"
- },
- "prices": {
- "$ref": "#/components/schemas/Prices"
- }
- },
- "required": [
- "fingerprint",
- "contentId",
- "type",
- "title"
- ]
- },
- "ActionTextListItem": {
- "type": "object",
- "properties": {
- "fingerprint": {
- "type": "string"
- },
- "contentId": {
- "type": "string"
- },
- "tags": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "action": {
- "$ref": "#/components/schemas/Action"
- },
- "type": {
- "type": "string",
- "enum": [
- "ACTION_TEXT"
- ]
- },
- "title": {
- "type": "string"
- },
- "icon": {
- "$ref": "#/components/schemas/LocalImage"
- }
- },
- "required": [
- "fingerprint",
- "contentId",
- "type",
- "title",
- "icon"
- ]
- },
- "OrderSummaryListItem": {
- "type": "object",
- "properties": {
- "fingerprint": {
- "type": "string"
- },
- "contentId": {
- "type": "string"
- },
- "tags": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "action": {
- "$ref": "#/components/schemas/Action"
- },
- "type": {
- "type": "string",
- "enum": [
- "ORDER_SUMMARY"
- ]
- },
- "title": {
- "type": "string"
- },
- "ctaLabel": {
- "type": "string"
- },
- "productImage": {
- "$ref": "#/components/schemas/Image"
- },
- "orderDetails": {
- "type": "string"
- },
- "status": {
- "$ref": "#/components/schemas/OrderDetailStatus"
- },
- "trackAndTraceButton": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/NormalButton"
- },
- {
- "$ref": "#/components/schemas/PlainButton"
- }
- ]
- },
- "accessibilityDescription": {
- "type": "string"
- }
- },
- "required": [
- "fingerprint",
- "contentId",
- "type",
- "title",
- "ctaLabel",
- "orderDetails",
- "accessibilityDescription"
- ]
- },
- "OrderProductListItem": {
- "type": "object",
- "properties": {
- "fingerprint": {
- "type": "string"
- },
- "contentId": {
- "type": "string"
- },
- "tags": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "action": {
- "$ref": "#/components/schemas/Action"
- },
- "type": {
- "type": "string",
- "enum": [
- "ORDER_PRODUCT"
- ]
- },
- "title": {
- "type": "string"
- },
- "prices": {
- "$ref": "#/components/schemas/Prices"
- },
- "image": {
- "$ref": "#/components/schemas/RemoteImage"
- },
- "favoriteAction": {
- "$ref": "#/components/schemas/Action"
- },
- "unFavoriteAction": {
- "$ref": "#/components/schemas/Action"
- },
- "summary": {
- "type": "string"
- },
- "accessibilityDescription": {
- "type": "string"
- }
- },
- "required": [
- "fingerprint",
- "contentId",
- "type",
- "title",
- "prices",
- "summary",
- "accessibilityDescription"
- ]
- },
- "BasketProductListItem": {
- "type": "object",
- "properties": {
- "fingerprint": {
- "type": "string"
- },
- "contentId": {
- "type": "string"
- },
- "tags": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "action": {
- "$ref": "#/components/schemas/Action"
- },
- "productId": {
- "type": "string"
- },
- "type": {
- "type": "string",
- "enum": [
- "BASKET_PRODUCT"
- ]
- },
- "image": {
- "$ref": "#/components/schemas/RemoteImage"
- },
- "actionSignings": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/ActionSigning"
- }
- },
- "title": {
- "type": "string"
- },
- "summary": {
- "type": "string"
- },
- "stockInfo": {
- "type": "string"
- },
- "quantityInfo": {
- "type": "string"
- },
- "stockInfoStyle": {
- "type": "string",
- "enum": [
- "NORMAL",
- "WARNING",
- "ERROR"
- ]
- },
- "quantityControlButton": {
- "$ref": "#/components/schemas/QuantityControlButton"
- },
- "unitPriceText": {
- "type": "string"
- },
- "totalPrice": {
- "$ref": "#/components/schemas/Prices"
- },
- "accessibilityDescription": {
- "type": "string"
- },
- "contextActions": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/ContextAction"
- }
- }
- },
- "required": [
- "fingerprint",
- "contentId",
- "productId",
- "type",
- "title",
- "stockInfoStyle",
- "totalPrice",
- "accessibilityDescription",
- "contextActions"
- ]
- },
- "ContextAction": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/ContextActionStandard"
- },
- {
- "$ref": "#/components/schemas/ContextActionFavorite"
- }
- ]
- },
- "ContextActionStandard": {
- "type": "object",
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "STANDARD"
- ]
- },
- "title": {
- "type": "string"
- },
- "action": {
- "$ref": "#/components/schemas/Action"
- },
- "icon": {
- "$ref": "#/components/schemas/LocalImage"
- },
- "style": {
- "type": "string",
- "enum": [
- "NORMAL",
- "WARNING"
- ]
- }
- },
- "required": [
- "type",
- "title",
- "action",
- "icon",
- "style"
- ]
- },
- "ContextActionFavorite": {
- "type": "object",
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "FAVORITE"
- ]
- },
- "favoriteTitle": {
- "type": "string"
- },
- "unFavoriteTitle": {
- "type": "string"
- },
- "favoriteAction": {
- "$ref": "#/components/schemas/Action"
- },
- "unFavoriteAction": {
- "$ref": "#/components/schemas/Action"
- }
- },
- "required": [
- "type",
- "favoriteTitle",
- "unFavoriteTitle"
- ]
- },
- "ActionSigning": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/ActionSigningImage"
- },
- {
- "$ref": "#/components/schemas/ActionSigningText"
- }
- ]
- },
- "ActionSigningImage": {
- "type": "object",
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "ACTION_SIGNING_IMAGE"
- ]
- },
- "image": {
- "$ref": "#/components/schemas/RemoteImage"
- }
- },
- "required": [
- "type",
- "image"
- ]
- },
- "ActionSigningText": {
- "type": "object",
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "ACTION_SIGNING_TEXT"
- ]
- },
- "text": {
- "type": "string"
- }
- },
- "required": [
- "type",
- "text"
- ]
- },
- "BulletListComponent": {
- "type": "object",
- "properties": {
- "fingerprint": {
- "type": "string"
- },
- "contentId": {
- "type": "string"
- },
- "tags": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "style": {
- "type": "string",
- "enum": [
- "CHECKMARK",
- "DOT",
- "NUMERIC"
- ]
- },
- "items": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "type": {
- "type": "string",
- "enum": [
- "BULLET_LIST"
- ]
- }
- },
- "required": [
- "fingerprint",
- "contentId",
- "style",
- "items",
- "type"
- ]
- },
- "SpacerComponent": {
- "type": "object",
- "properties": {
- "fingerprint": {
- "type": "string"
- },
- "contentId": {
- "type": "string"
- },
- "tags": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "type": {
- "type": "string",
- "enum": [
- "SPACER"
- ]
- },
- "size": {
- "type": "number"
- }
- },
- "required": [
- "fingerprint",
- "contentId",
- "type",
- "size"
- ]
- },
- "ImageCollectionComponent": {
- "type": "object",
- "properties": {
- "fingerprint": {
- "type": "string"
- },
- "contentId": {
- "type": "string"
- },
- "tags": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "type": {
- "type": "string",
- "enum": [
- "IMAGE_COLLECTION"
- ]
- },
- "images": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Image"
- }
- }
- },
- "required": [
- "fingerprint",
- "contentId",
- "type",
- "images"
- ]
- },
- "ImageComponent": {
- "type": "object",
- "properties": {
- "fingerprint": {
- "type": "string"
- },
- "contentId": {
- "type": "string"
- },
- "tags": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "type": {
- "type": "string",
- "enum": [
- "IMAGE"
- ]
- },
- "position": {
- "type": "string",
- "enum": [
- "LEADING",
- "CENTER",
- "TRAILING"
- ]
- },
- "shape": {
- "type": "string",
- "enum": [
- "RECTANGLE",
- "ROUNDED_RECTANGLE"
- ]
- },
- "image": {
- "$ref": "#/components/schemas/Image"
- },
- "maxWidthPercentage": {
- "type": "number"
- }
- },
- "required": [
- "fingerprint",
- "contentId",
- "type",
- "position",
- "shape",
- "image"
- ]
- },
- "ParagraphComponent": {
- "type": "object",
- "properties": {
- "fingerprint": {
- "type": "string"
- },
- "contentId": {
- "type": "string"
- },
- "tags": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "type": {
- "type": "string",
- "enum": [
- "PARAGRAPH"
- ]
- },
- "paragraphs": {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "required": [
- "fingerprint",
- "contentId",
- "type",
- "paragraphs"
- ]
- },
- "ButtonsComponent": {
- "type": "object",
- "properties": {
- "fingerprint": {
- "type": "string"
- },
- "contentId": {
- "type": "string"
- },
- "tags": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "type": {
- "type": "string",
- "enum": [
- "BUTTONS"
- ]
- },
- "buttons": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Button"
- }
- }
- },
- "required": [
- "fingerprint",
- "contentId",
- "type",
- "buttons"
- ]
- },
- "TitleComponent": {
- "type": "object",
- "properties": {
- "fingerprint": {
- "type": "string"
- },
- "contentId": {
- "type": "string"
- },
- "tags": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "type": {
- "type": "string",
- "enum": [
- "TITLE"
- ]
- },
- "displayStyle": {
- "type": "string",
- "enum": [
- "EXTRA_LARGE",
- "LARGE",
- "MEDIUM",
- "SMALL"
- ]
- },
- "text": {
- "type": "string"
- }
- },
- "required": [
- "fingerprint",
- "contentId",
- "type",
- "displayStyle",
- "text"
- ]
- },
- "VariationProductListItem": {
- "type": "object",
- "properties": {
- "fingerprint": {
- "type": "string"
- },
- "contentId": {
- "type": "string"
- },
- "tags": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "action": {
- "$ref": "#/components/schemas/Action"
- },
- "type": {
- "type": "string",
- "enum": [
- "VARIATION_PRODUCT_LIST_ITEM"
- ]
- },
- "productId": {
- "type": "string"
- },
- "title": {
- "type": "string"
- },
- "image": {
- "$ref": "#/components/schemas/Image"
- },
- "prices": {
- "$ref": "#/components/schemas/Prices"
- },
- "stock": {
- "$ref": "#/components/schemas/ProductStock"
- },
- "quantityInfo": {
- "type": "string"
- },
- "actionSigningImage": {
- "$ref": "#/components/schemas/Image"
- },
- "button": {
- "$ref": "#/components/schemas/SetBasketItemButton"
- }
- },
- "required": [
- "fingerprint",
- "contentId",
- "type",
- "productId",
- "title"
- ]
- },
- "TwoColumnTableComponent": {
- "type": "object",
- "properties": {
- "fingerprint": {
- "type": "string"
- },
- "contentId": {
- "type": "string"
- },
- "tags": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "type": {
- "type": "string",
- "enum": [
- "TWO_COLUMN_TABLE"
- ]
- },
- "rows": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/TwoColumnTableRow"
- }
- },
- "footnote": {
- "type": "string"
- }
- },
- "required": [
- "fingerprint",
- "contentId",
- "type",
- "rows"
- ]
- },
- "TwoColumnTableRow": {
- "type": "object",
- "properties": {
- "leftCell": {
- "$ref": "#/components/schemas/TableCell"
- },
- "rightCell": {
- "$ref": "#/components/schemas/TableCell"
- }
- },
- "required": [
- "leftCell",
- "rightCell"
- ]
- },
- "TableCell": {
- "type": "object",
- "properties": {
- "text": {
- "type": "string"
- },
- "isBold": {
- "type": "boolean"
- }
- },
- "required": [
- "text"
- ]
- },
- "DefinitionListComponent": {
- "type": "object",
- "properties": {
- "fingerprint": {
- "type": "string"
- },
- "contentId": {
- "type": "string"
- },
- "tags": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "type": {
- "type": "string",
- "enum": [
- "DEFINITION_LIST"
- ]
- },
- "items": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Definition"
- }
- }
- },
- "required": [
- "fingerprint",
- "contentId",
- "type",
- "items"
- ]
- },
- "DefinitionDisplayStyle": {
- "type": "string",
- "enum": [
- "PRIMARY",
- "DANGER"
- ]
- },
- "Definition": {
- "type": "object",
- "properties": {
- "fingerprint": {
- "type": "string"
- },
- "contentId": {
- "type": "string"
- },
- "tags": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "icon": {
- "$ref": "#/components/schemas/Image"
- },
- "title": {
- "type": "string"
- },
- "style": {
- "$ref": "#/components/schemas/DefinitionDisplayStyle"
- },
- "subtitle": {
- "type": "string"
- },
- "paragraphs": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/DefinitionParagraph"
- }
- }
- },
- "required": [
- "fingerprint",
- "contentId",
- "icon",
- "title",
- "style"
- ]
- },
- "DefinitionParagraph": {
- "type": "object",
- "properties": {
- "paragraphs": {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "required": [
- "paragraphs"
- ]
- },
- "InfoMessageComponent": {
- "type": "object",
- "properties": {
- "fingerprint": {
- "type": "string"
- },
- "contentId": {
- "type": "string"
- },
- "tags": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "type": {
- "type": "string",
- "enum": [
- "INFO_MESSAGE"
- ]
- },
- "title": {
- "type": "string"
- },
- "message": {
- "type": "string"
- },
- "button": {
- "$ref": "#/components/schemas/NormalButton"
- },
- "style": {
- "type": "string",
- "enum": [
- "NORMAL",
- "WARNING"
- ]
- }
- },
- "required": [
- "fingerprint",
- "contentId",
- "type",
- "style"
- ]
- },
- "VoucherDisplayType": {
- "type": "string",
- "enum": [
- "ACTIVATED",
- "ACTIVATABLE",
- "POINTS_NEEDED",
- "TEASER",
- "ALMOST_EXPIRED"
- ]
- },
- "VoucherItem": {
- "type": "object",
- "properties": {
- "displayType": {
- "$ref": "#/components/schemas/VoucherDisplayType"
- },
- "points": {
- "type": "number"
- },
- "pointsNeededPercentage": {
- "type": "number"
- },
- "image": {
- "$ref": "#/components/schemas/Image"
- },
- "title": {
- "type": "string"
- },
- "subtitle": {
- "type": "string"
- },
- "description": {
- "type": "string"
- },
- "button": {
- "$ref": "#/components/schemas/NormalButton"
- }
- },
- "required": [
- "displayType"
- ]
- },
- "BannerCaption": {
- "type": "object",
- "properties": {
- "title": {
- "type": "string"
- },
- "subtitle": {
- "type": "string"
- }
- },
- "required": [
- "title",
- "subtitle"
- ]
- },
- "CarouselItem": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/CarouselProductItem"
- },
- {
- "$ref": "#/components/schemas/CarouselBannerItem"
- },
- {
- "$ref": "#/components/schemas/CarouselProductReviewItem"
- },
- {
- "$ref": "#/components/schemas/CarouselVoucherItem"
- },
- {
- "$ref": "#/components/schemas/CarouselViewAllItem"
- },
- {
- "$ref": "#/components/schemas/CarouselCategoryItem"
- }
- ]
- },
- "CarouselBannerItem": {
- "type": "object",
- "properties": {
- "fingerprint": {
- "type": "string"
- },
- "contentId": {
- "type": "string"
- },
- "tags": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "action": {
- "$ref": "#/components/schemas/Action"
- },
- "type": {
- "type": "string",
- "enum": [
- "CAROUSEL_BANNER_ITEM"
- ]
- },
- "image": {
- "$ref": "#/components/schemas/RemoteImage"
- },
- "accessibilityTitle": {
- "type": "string"
- },
- "caption": {
- "$ref": "#/components/schemas/BannerCaption"
- },
- "overlayImages": {
- "$ref": "#/components/schemas/BannerOverlayImages"
- }
- },
- "required": [
- "fingerprint",
- "contentId",
- "type",
- "image",
- "accessibilityTitle"
- ]
- },
- "CarouselCategoryItem": {
- "type": "object",
- "properties": {
- "fingerprint": {
- "type": "string"
- },
- "contentId": {
- "type": "string"
- },
- "tags": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "action": {
- "$ref": "#/components/schemas/Action"
- },
- "type": {
- "type": "string",
- "enum": [
- "CAROUSEL_CATEGORY_ITEM"
- ]
- },
- "image": {
- "$ref": "#/components/schemas/RemoteImage"
- },
- "title": {
- "type": "string"
- },
- "accessibilityTitle": {
- "type": "string"
- }
- },
- "required": [
- "fingerprint",
- "contentId",
- "type",
- "image",
- "title",
- "accessibilityTitle"
- ]
- },
- "CarouselProductReviewItem": {
- "type": "object",
- "properties": {
- "fingerprint": {
- "type": "string"
- },
- "contentId": {
- "type": "string"
- },
- "tags": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "action": {
- "$ref": "#/components/schemas/Action"
- },
- "type": {
- "type": "string",
- "enum": [
- "CAROUSEL_PRODUCT_REVIEW_ITEM"
- ]
- },
- "title": {
- "type": "string"
- },
- "rating": {
- "type": "number"
- },
- "body": {
- "type": "string"
- },
- "description": {
- "type": "string"
- }
- },
- "required": [
- "fingerprint",
- "contentId",
- "type",
- "title",
- "rating",
- "body",
- "description"
- ]
- },
- "CarouselProductItem": {
- "type": "object",
- "properties": {
- "fingerprint": {
- "type": "string"
- },
- "contentId": {
- "type": "string"
- },
- "tags": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "action": {
- "$ref": "#/components/schemas/Action"
- },
- "title": {
- "type": "string"
- },
- "prices": {
- "$ref": "#/components/schemas/Prices"
- },
- "image": {
- "$ref": "#/components/schemas/Image"
- },
- "variationIcon": {
- "$ref": "#/components/schemas/LocalImage"
- },
- "favoriteAction": {
- "$ref": "#/components/schemas/Action"
- },
- "unFavoriteAction": {
- "$ref": "#/components/schemas/Action"
- },
- "primaryButton": {
- "$ref": "#/components/schemas/Button"
- },
- "productId": {
- "type": "string"
- },
- "actionSigningImage": {
- "$ref": "#/components/schemas/Image"
- },
- "rating": {
- "type": "number"
- },
- "importantInfo": {
- "type": "string"
- },
- "quantityInfo": {
- "type": "string"
- },
- "type": {
- "type": "string",
- "enum": [
- "CAROUSEL_PRODUCT_ITEM"
- ]
- }
- },
- "required": [
- "fingerprint",
- "contentId",
- "title",
- "image",
- "productId",
- "type"
- ]
- },
- "CarouselVoucherItem": {
- "type": "object",
- "properties": {
- "fingerprint": {
- "type": "string"
- },
- "contentId": {
- "type": "string"
- },
- "tags": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "action": {
- "$ref": "#/components/schemas/Action"
- },
- "displayType": {
- "$ref": "#/components/schemas/VoucherDisplayType"
- },
- "points": {
- "type": "number"
- },
- "pointsNeededPercentage": {
- "type": "number"
- },
- "image": {
- "$ref": "#/components/schemas/Image"
- },
- "title": {
- "type": "string"
- },
- "subtitle": {
- "type": "string"
- },
- "description": {
- "type": "string"
- },
- "button": {
- "$ref": "#/components/schemas/NormalButton"
- },
- "type": {
- "type": "string",
- "enum": [
- "CAROUSEL_VOUCHER_ITEM"
- ]
- }
- },
- "required": [
- "fingerprint",
- "contentId",
- "displayType",
- "type"
- ]
- },
- "CarouselViewAllItem": {
- "type": "object",
- "properties": {
- "fingerprint": {
- "type": "string"
- },
- "contentId": {
- "type": "string"
- },
- "tags": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "type": {
- "type": "string",
- "enum": [
- "CAROUSEL_VIEW_ALL_ITEM"
- ]
- },
- "description": {
- "type": "string"
- },
- "action": {
- "$ref": "#/components/schemas/Action"
- }
- },
- "required": [
- "fingerprint",
- "contentId",
- "type",
- "description",
- "action"
- ]
- },
- "TextCardComponent": {
- "type": "object",
- "properties": {
- "fingerprint": {
- "type": "string"
- },
- "contentId": {
- "type": "string"
- },
- "tags": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "type": {
- "type": "string",
- "enum": [
- "TEXT_CARD"
- ]
- },
- "action": {
- "$ref": "#/components/schemas/Action"
- },
- "title": {
- "type": "string"
- },
- "description": {
- "type": "string"
- },
- "highlightedDescription": {
- "type": "string"
- },
- "icon": {
- "$ref": "#/components/schemas/Image"
- }
- },
- "required": [
- "fingerprint",
- "contentId",
- "type"
- ]
- },
- "ReviewSummaryComponent": {
- "type": "object",
- "properties": {
- "fingerprint": {
- "type": "string"
- },
- "contentId": {
- "type": "string"
- },
- "tags": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "type": {
- "type": "string",
- "enum": [
- "REVIEW_SUMMARY"
- ]
- },
- "rating": {
- "type": "number"
- },
- "label": {
- "type": "string"
- },
- "action": {
- "$ref": "#/components/schemas/Action"
- }
- },
- "required": [
- "fingerprint",
- "contentId",
- "type",
- "rating"
- ]
- },
- "ReviewDetailListItem": {
- "type": "object",
- "properties": {
- "fingerprint": {
- "type": "string"
- },
- "contentId": {
- "type": "string"
- },
- "tags": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "action": {
- "$ref": "#/components/schemas/Action"
- },
- "type": {
- "type": "string",
- "enum": [
- "REVIEW_DETAIL_LIST_ITEM"
- ]
- },
- "title": {
- "type": "string"
- },
- "rating": {
- "type": "number"
- },
- "recommendedByUser": {
- "type": "boolean"
- },
- "recommendationLabel": {
- "type": "string"
- },
- "body": {
- "type": "string"
- },
- "description": {
- "type": "string"
- }
- },
- "required": [
- "fingerprint",
- "contentId",
- "type",
- "rating"
- ]
- },
- "ProgressComponent": {
- "type": "object",
- "properties": {
- "fingerprint": {
- "type": "string"
- },
- "contentId": {
- "type": "string"
- },
- "tags": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "type": {
- "type": "string",
- "enum": [
- "PROGRESS"
- ]
- },
- "title": {
- "type": "string"
- },
- "progress": {
- "type": "number"
- },
- "valueLabel": {
- "type": "string"
- }
- },
- "required": [
- "fingerprint",
- "contentId",
- "type",
- "progress"
- ]
- },
- "BannerSize": {
- "type": "string",
- "enum": [
- "VERY_SMALL",
- "SMALL",
- "LARGE",
- "PORTRAIT"
- ]
- },
- "BannerComponent": {
- "type": "object",
- "properties": {
- "fingerprint": {
- "type": "string"
- },
- "contentId": {
- "type": "string"
- },
- "tags": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "type": {
- "type": "string",
- "enum": [
- "BANNER"
- ]
- },
- "size": {
- "$ref": "#/components/schemas/BannerSize"
- },
- "image": {
- "$ref": "#/components/schemas/RemoteImage"
- },
- "accessibilityTitle": {
- "type": "string"
- },
- "action": {
- "$ref": "#/components/schemas/Action"
- },
- "caption": {
- "$ref": "#/components/schemas/BannerCaption"
- },
- "overlayImages": {
- "$ref": "#/components/schemas/BannerOverlayImages"
- }
- },
- "required": [
- "fingerprint",
- "contentId",
- "type",
- "size",
- "image",
- "accessibilityTitle"
- ]
- },
- "BannerOverlayImages": {
- "type": "object",
- "properties": {
- "topLeftImage": {
- "$ref": "#/components/schemas/RemoteImage"
- },
- "topRightImage": {
- "$ref": "#/components/schemas/RemoteImage"
- },
- "bottomLeftImage": {
- "$ref": "#/components/schemas/RemoteImage"
- },
- "bottomRightImage": {
- "$ref": "#/components/schemas/RemoteImage"
- }
- }
- },
- "ListGroupComponent": {
- "type": "object",
- "properties": {
- "fingerprint": {
- "type": "string"
- },
- "contentId": {
- "type": "string"
- },
- "tags": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "type": {
- "type": "string",
- "enum": [
- "LIST_GROUP"
- ]
- },
- "title": {
- "type": "string"
- },
- "items": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/ListGroupItem"
- }
- },
- "action": {
- "$ref": "#/components/schemas/Action"
- },
- "actionLabel": {
- "type": "string"
- },
- "actionIcon": {
- "$ref": "#/components/schemas/Image"
- }
- },
- "required": [
- "fingerprint",
- "contentId",
- "type",
- "items"
- ]
- },
- "ListGroupItem": {
- "type": "object",
- "properties": {
- "fingerprint": {
- "type": "string"
- },
- "contentId": {
- "type": "string"
- },
- "tags": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "title": {
- "type": "string"
- },
- "action": {
- "$ref": "#/components/schemas/Action"
- },
- "image": {
- "$ref": "#/components/schemas/Image"
- }
- },
- "required": [
- "fingerprint",
- "contentId",
- "title"
- ]
- },
- "LoaderComponentDisplayType": {
- "type": "string",
- "enum": [
- "PDP_CONTENT",
- "PLP_CONTENT",
- "ORDER_DETAILS_CONTENT",
- "VARIATION_PRODUCT_LIST_ITEM"
- ]
- },
- "LoaderComponent": {
- "type": "object",
- "properties": {
- "fingerprint": {
- "type": "string"
- },
- "contentId": {
- "type": "string"
- },
- "tags": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "type": {
- "type": "string",
- "enum": [
- "LOADER"
- ]
- },
- "displayType": {
- "$ref": "#/components/schemas/LoaderComponentDisplayType"
- }
- },
- "required": [
- "fingerprint",
- "contentId",
- "type",
- "displayType"
- ]
- },
- "OrderStatusTitleStyle": {
- "type": "string",
- "enum": [
- "NORMAL",
- "WARNING"
- ]
- },
- "OrderStatusPlaceholderComponent": {
- "type": "object",
- "properties": {
- "fingerprint": {
- "type": "string"
- },
- "contentId": {
- "type": "string"
- },
- "tags": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "type": {
- "type": "string",
- "enum": [
- "ORDER_STATUS_PLACEHOLDER"
- ]
- },
- "componentPath": {
- "type": "string"
- },
- "title": {
- "type": "string"
- }
- },
- "required": [
- "fingerprint",
- "contentId",
- "type",
- "componentPath",
- "title"
- ]
- },
- "OrderStatusComponent": {
- "type": "object",
- "properties": {
- "fingerprint": {
- "type": "string"
- },
- "contentId": {
- "type": "string"
- },
- "tags": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "type": {
- "type": "string",
- "enum": [
- "ORDER_STATUS"
- ]
- },
- "title": {
- "type": "string"
- },
- "shipments": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/OrderStatusShipment"
- }
- }
- },
- "required": [
- "fingerprint",
- "contentId",
- "type",
- "shipments"
- ]
- },
- "OrderStatusShipment": {
- "type": "object",
- "properties": {
- "fingerprint": {
- "type": "string"
- },
- "contentId": {
- "type": "string"
- },
- "tags": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "action": {
- "$ref": "#/components/schemas/Action"
- },
- "type": {
- "type": "string",
- "enum": [
- "ORDER_STATUS_SHIPMENT_CARD"
- ]
- },
- "title": {
- "type": "string"
- },
- "titleStyle": {
- "$ref": "#/components/schemas/OrderStatusTitleStyle"
- },
- "body": {
- "type": "string"
- },
- "accessibilityDescription": {
- "type": "string"
- },
- "pickupLocationThumbnail": {
- "$ref": "#/components/schemas/LocalImage"
- },
- "button": {
- "$ref": "#/components/schemas/PlainButton"
- }
- },
- "required": [
- "fingerprint",
- "contentId",
- "type",
- "title",
- "titleStyle",
- "body"
- ]
- },
- "LoyaltyPointsComponent": {
- "type": "object",
- "properties": {
- "fingerprint": {
- "type": "string"
- },
- "contentId": {
- "type": "string"
- },
- "tags": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "type": {
- "type": "string",
- "enum": [
- "LOYALTY_POINTS"
- ]
- },
- "currentBalance": {
- "type": "number"
- },
- "button": {
- "$ref": "#/components/schemas/TextButton"
- }
- },
- "required": [
- "fingerprint",
- "contentId",
- "type",
- "currentBalance"
- ]
- },
- "SignupCardComponent": {
- "type": "object",
- "properties": {
- "fingerprint": {
- "type": "string"
- },
- "contentId": {
- "type": "string"
- },
- "tags": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "type": {
- "type": "string",
- "enum": [
- "SIGNUP_CARD"
- ]
- },
- "title": {
- "type": "string"
- },
- "subtitle": {
- "type": "string"
- },
- "usps": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "button": {
- "$ref": "#/components/schemas/NormalButton"
- }
- },
- "required": [
- "fingerprint",
- "contentId",
- "type",
- "title",
- "subtitle",
- "usps",
- "button"
- ]
- },
- "VoucherItemComponent": {
- "type": "object",
- "properties": {
- "fingerprint": {
- "type": "string"
- },
- "contentId": {
- "type": "string"
- },
- "tags": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "displayType": {
- "$ref": "#/components/schemas/VoucherDisplayType"
- },
- "points": {
- "type": "number"
- },
- "pointsNeededPercentage": {
- "type": "number"
- },
- "image": {
- "$ref": "#/components/schemas/Image"
- },
- "title": {
- "type": "string"
- },
- "subtitle": {
- "type": "string"
- },
- "description": {
- "type": "string"
- },
- "button": {
- "$ref": "#/components/schemas/NormalButton"
- },
- "type": {
- "type": "string",
- "enum": [
- "VOUCHER_ITEM"
- ]
- }
- },
- "required": [
- "fingerprint",
- "contentId",
- "displayType",
- "type"
- ]
- },
- "ExpandableInfoBulletList": {
- "type": "object",
- "properties": {
- "style": {
- "type": "string",
- "enum": [
- "CHECKMARK",
- "DOT",
- "NUMERIC"
- ]
- },
- "items": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "title": {
- "type": "string"
- }
- },
- "required": [
- "style",
- "items"
- ]
- },
- "ExpandableInfoComponent": {
- "type": "object",
- "properties": {
- "fingerprint": {
- "type": "string"
- },
- "contentId": {
- "type": "string"
- },
- "tags": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "type": {
- "type": "string",
- "enum": [
- "EXPANDABLE_INFO"
- ]
- },
- "title": {
- "type": "string"
- },
- "info": {
- "type": "object",
- "properties": {
- "body": {
- "type": "string"
- },
- "bulletLists": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/ExpandableInfoBulletList"
- }
- }
- }
- }
- },
- "required": [
- "fingerprint",
- "contentId",
- "type",
- "title",
- "info"
- ]
- },
- "LoyaltySummaryComponent": {
- "type": "object",
- "properties": {
- "fingerprint": {
- "type": "string"
- },
- "contentId": {
- "type": "string"
- },
- "tags": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "type": {
- "type": "string",
- "enum": [
- "LOYALTY_SUMMARY"
- ]
- },
- "action": {
- "$ref": "#/components/schemas/Action"
- }
- },
- "required": [
- "fingerprint",
- "contentId",
- "type",
- "action"
- ]
- },
- "EmptyListComponent": {
- "type": "object",
- "properties": {
- "fingerprint": {
- "type": "string"
- },
- "contentId": {
- "type": "string"
- },
- "tags": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "type": {
- "type": "string",
- "enum": [
- "EMPTY"
- ]
- },
- "text": {
- "type": "string"
- },
- "image": {
- "$ref": "#/components/schemas/Image"
- }
- },
- "required": [
- "fingerprint",
- "contentId",
- "type",
- "text",
- "image"
- ]
- },
- "PriceLineTextDisplayType": {
- "type": "string",
- "enum": [
- "NORMAL",
- "HIGHLIGHTED",
- "EMPHASISED"
- ]
- },
- "PriceLineTextStringValue": {
- "type": "object",
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "STRING"
- ]
- },
- "value": {
- "type": "string"
- }
- },
- "required": [
- "type",
- "value"
- ]
- },
- "PriceLineTextPriceValue": {
- "type": "object",
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "PRICE"
- ]
- },
- "value": {
- "$ref": "#/components/schemas/FormattedPrice"
- }
- },
- "required": [
- "type",
- "value"
- ]
- },
- "PriceLineTextComponent": {
- "type": "object",
- "properties": {
- "fingerprint": {
- "type": "string"
- },
- "contentId": {
- "type": "string"
- },
- "tags": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "type": {
- "type": "string",
- "enum": [
- "PRICE_LINE_TEXT"
- ]
- },
- "text": {
- "type": "string"
- },
- "value": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/PriceLineTextStringValue"
- },
- {
- "$ref": "#/components/schemas/PriceLineTextPriceValue"
- }
- ]
- },
- "displayType": {
- "$ref": "#/components/schemas/PriceLineTextDisplayType"
- },
- "accessibilityDescription": {
- "type": "string"
- }
- },
- "required": [
- "fingerprint",
- "contentId",
- "type",
- "text",
- "value",
- "displayType",
- "accessibilityDescription"
- ]
- },
- "OrderDetailStatus": {
- "type": "object",
- "properties": {
- "title": {
- "type": "string"
- },
- "body": {
- "type": "string"
- },
- "icon": {
- "$ref": "#/components/schemas/LocalImage"
- },
- "accessibilityDescription": {
- "type": "string"
- }
- },
- "required": [
- "title",
- "body",
- "icon",
- "accessibilityDescription"
- ]
- },
- "OrderDetailStatusComponent": {
- "type": "object",
- "properties": {
- "fingerprint": {
- "type": "string"
- },
- "contentId": {
- "type": "string"
- },
- "tags": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "type": {
- "type": "string",
- "enum": [
- "ORDER_DETAIL_STATUS"
- ]
- },
- "status": {
- "$ref": "#/components/schemas/OrderDetailStatus"
- }
- },
- "required": [
- "fingerprint",
- "contentId",
- "type",
- "status"
- ]
- },
- "QRCodeComponent": {
- "type": "object",
- "properties": {
- "fingerprint": {
- "type": "string"
- },
- "contentId": {
- "type": "string"
- },
- "tags": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "type": {
- "type": "string",
- "enum": [
- "QR_CODE"
- ]
- },
- "description": {
- "type": "string"
- },
- "code": {
- "type": "string"
- }
- },
- "required": [
- "fingerprint",
- "contentId",
- "type",
- "description",
- "code"
- ]
- },
- "BarcodeComponent": {
- "type": "object",
- "properties": {
- "fingerprint": {
- "type": "string"
- },
- "contentId": {
- "type": "string"
- },
- "tags": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "type": {
- "type": "string",
- "enum": [
- "BARCODE"
- ]
- },
- "description": {
- "type": "string"
- },
- "code": {
- "$ref": "#/components/schemas/Barcode"
- }
- },
- "required": [
- "fingerprint",
- "contentId",
- "type",
- "description",
- "code"
- ]
- },
- "Barcode": {
- "type": "object",
- "properties": {
- "codeType": {
- "type": "string",
- "enum": [
- "CODE_128"
- ]
- },
- "value": {
- "type": "string"
- }
- },
- "required": [
- "codeType",
- "value"
- ]
- },
- "ProductStoreStockComponent": {
- "type": "object",
- "properties": {
- "fingerprint": {
- "type": "string"
- },
- "contentId": {
- "type": "string"
- },
- "tags": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "type": {
- "type": "string",
- "enum": [
- "PRODUCT_STORE_STOCK"
- ]
- },
- "subject": {
- "type": "string"
- },
- "title": {
- "type": "string"
- },
- "subtitle": {
- "type": "string"
- },
- "description": {
- "type": "string"
- },
- "indicatorStyle": {
- "$ref": "#/components/schemas/ProductStoreStockIndicatorStyle"
- },
- "accessibilityDescription": {
- "type": "string"
- }
- },
- "required": [
- "fingerprint",
- "contentId",
- "type",
- "title",
- "subtitle",
- "description",
- "indicatorStyle",
- "accessibilityDescription"
- ]
- },
- "ProductStoreStockIndicatorStyle": {
- "type": "string",
- "enum": [
- "NO_STOCK",
- "LIMITED_STOCK",
- "IN_STOCK"
- ]
- },
- "BasketVoucherComponent": {
- "type": "object",
- "properties": {
- "fingerprint": {
- "type": "string"
- },
- "contentId": {
- "type": "string"
- },
- "tags": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "type": {
- "type": "string",
- "enum": [
- "BASKET_VOUCHER"
- ]
- },
- "image": {
- "$ref": "#/components/schemas/RemoteImage"
- },
- "title": {
- "type": "string"
- },
- "description": {
- "type": "string"
- },
- "button": {
- "$ref": "#/components/schemas/SwitchButton"
- },
- "errorMessage": {
- "type": "string"
- }
- },
- "required": [
- "fingerprint",
- "contentId",
- "type",
- "image",
- "title",
- "description",
- "button"
- ]
- },
- "AddCoupon": {
- "type": "object",
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "ADD_COUPON"
- ]
- },
- "textFieldPlaceholder": {
- "type": "string"
- },
- "button": {
- "$ref": "#/components/schemas/NormalButton"
- },
- "noticeText": {
- "type": "string"
- }
- },
- "required": [
- "type",
- "textFieldPlaceholder",
- "button"
- ]
- },
- "ActiveCoupon": {
- "type": "object",
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "ACTIVE_COUPON"
- ]
- },
- "title": {
- "type": "string"
- },
- "body": {
- "type": "string"
- },
- "action": {
- "$ref": "#/components/schemas/Action"
- },
- "errorMessage": {
- "type": "string"
- }
- },
- "required": [
- "type",
- "title",
- "body",
- "action"
- ]
- },
- "BasketCouponComponent": {
- "type": "object",
- "properties": {
- "fingerprint": {
- "type": "string"
- },
- "contentId": {
- "type": "string"
- },
- "tags": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "type": {
- "type": "string",
- "enum": [
- "BASKET_COUPON"
- ]
- },
- "title": {
- "type": "string"
- },
- "couponState": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/ActiveCoupon"
- },
- {
- "$ref": "#/components/schemas/AddCoupon"
- }
- ]
- }
- },
- "required": [
- "fingerprint",
- "contentId",
- "type",
- "title",
- "couponState"
- ]
- },
- "DonationInputComponent": {
- "type": "object",
- "properties": {
- "fingerprint": {
- "type": "string"
- },
- "contentId": {
- "type": "string"
- },
- "tags": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "type": {
- "type": "string",
- "enum": [
- "DONATION_INPUT"
- ]
- },
- "textFieldPlaceholder": {
- "type": "string"
- },
- "button": {
- "$ref": "#/components/schemas/NormalButton"
- }
- },
- "required": [
- "fingerprint",
- "contentId",
- "type",
- "textFieldPlaceholder",
- "button"
- ]
- },
- "PrimaryMenuItemComponent": {
- "type": "object",
- "properties": {
- "fingerprint": {
- "type": "string"
- },
- "contentId": {
- "type": "string"
- },
- "tags": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "type": {
- "type": "string",
- "enum": [
- "PRIMARY_MENU_ITEM"
- ]
- },
- "title": {
- "type": "string"
- },
- "subtitle": {
- "type": "string"
- },
- "image": {
- "$ref": "#/components/schemas/LocalImage"
- },
- "action": {
- "$ref": "#/components/schemas/Action"
- }
- },
- "required": [
- "fingerprint",
- "contentId",
- "type",
- "title",
- "image"
- ]
- },
- "SecondaryMenuItemComponent": {
- "type": "object",
- "properties": {
- "fingerprint": {
- "type": "string"
- },
- "contentId": {
- "type": "string"
- },
- "tags": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "type": {
- "type": "string",
- "enum": [
- "SECONDARY_MENU_ITEM"
- ]
- },
- "title": {
- "type": "string"
- },
- "image": {
- "$ref": "#/components/schemas/LocalImage"
- },
- "action": {
- "$ref": "#/components/schemas/Action"
- }
- },
- "required": [
- "fingerprint",
- "contentId",
- "type",
- "title",
- "image"
- ]
- },
- "AppEnvironmentComponent": {
- "type": "object",
- "properties": {
- "fingerprint": {
- "type": "string"
- },
- "contentId": {
- "type": "string"
- },
- "tags": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "type": {
- "type": "string",
- "enum": [
- "APP_ENVIRONMENT"
- ]
- }
- },
- "required": [
- "fingerprint",
- "contentId",
- "type"
- ]
- },
- "Component": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/BannerComponent"
- },
- {
- "$ref": "#/components/schemas/BasketProductListItem"
- },
- {
- "$ref": "#/components/schemas/BasketCouponComponent"
- },
- {
- "$ref": "#/components/schemas/BarcodeComponent"
- },
- {
- "$ref": "#/components/schemas/BasketVoucherComponent"
- },
- {
- "$ref": "#/components/schemas/BulletListComponent"
- },
- {
- "$ref": "#/components/schemas/SpacerComponent"
- },
- {
- "$ref": "#/components/schemas/ButtonsComponent"
- },
- {
- "$ref": "#/components/schemas/ActionTextListItem"
- },
- {
- "$ref": "#/components/schemas/DefinitionListComponent"
- },
- {
- "$ref": "#/components/schemas/ExpandableInfoComponent"
- },
- {
- "$ref": "#/components/schemas/EmptyListComponent"
- },
- {
- "$ref": "#/components/schemas/FavoriteListItem"
- },
- {
- "$ref": "#/components/schemas/ImageCollectionComponent"
- },
- {
- "$ref": "#/components/schemas/InfoMessageComponent"
- },
- {
- "$ref": "#/components/schemas/ListGroupComponent"
- },
- {
- "$ref": "#/components/schemas/LoaderComponent"
- },
- {
- "$ref": "#/components/schemas/LoyaltyPointsComponent"
- },
- {
- "$ref": "#/components/schemas/LoyaltySummaryComponent"
- },
- {
- "$ref": "#/components/schemas/OrderStatusComponent"
- },
- {
- "$ref": "#/components/schemas/OrderStatusPlaceholderComponent"
- },
- {
- "$ref": "#/components/schemas/ParagraphComponent"
- },
- {
- "$ref": "#/components/schemas/PlainListItem"
- },
- {
- "$ref": "#/components/schemas/PlainProductListItem"
- },
- {
- "$ref": "#/components/schemas/PlainTextListItem"
- },
- {
- "$ref": "#/components/schemas/PlpListItem"
- },
- {
- "$ref": "#/components/schemas/ProductStoreStockComponent"
- },
- {
- "$ref": "#/components/schemas/ProgressComponent"
- },
- {
- "$ref": "#/components/schemas/PriceLineTextComponent"
- },
- {
- "$ref": "#/components/schemas/QRCodeListItem"
- },
- {
- "$ref": "#/components/schemas/QRCodeComponent"
- },
- {
- "$ref": "#/components/schemas/ReviewDetailListItem"
- },
- {
- "$ref": "#/components/schemas/ReviewSummaryComponent"
- },
- {
- "$ref": "#/components/schemas/SignupCardComponent"
- },
- {
- "$ref": "#/components/schemas/TextCardComponent"
- },
- {
- "$ref": "#/components/schemas/TitleComponent"
- },
- {
- "$ref": "#/components/schemas/TwoColumnTableComponent"
- },
- {
- "$ref": "#/components/schemas/VariationListItem"
- },
- {
- "$ref": "#/components/schemas/VariationProductListItem"
- },
- {
- "$ref": "#/components/schemas/VoucherItemComponent"
- },
- {
- "$ref": "#/components/schemas/ImageComponent"
- },
- {
- "$ref": "#/components/schemas/OrderSummaryListItem"
- },
- {
- "$ref": "#/components/schemas/OrderProductListItem"
- },
- {
- "$ref": "#/components/schemas/OrderDetailStatusComponent"
- },
- {
- "$ref": "#/components/schemas/DonationInputComponent"
- },
- {
- "$ref": "#/components/schemas/PrimaryMenuItemComponent"
- },
- {
- "$ref": "#/components/schemas/SecondaryMenuItemComponent"
- },
- {
- "$ref": "#/components/schemas/AppEnvironmentComponent"
- },
- {
- "$ref": "#/components/schemas/SearchBarComponentExperiment"
- }
- ]
- },
- "Image": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/LocalImage"
- },
- {
- "$ref": "#/components/schemas/RemoteImage"
- }
- ]
- },
- "LocalImage": {
- "type": "object",
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "LOCAL"
- ]
- },
- "name": {
- "type": "string",
- "enum": [
- "IMAGE_BALLOON_HEART",
- "NOT_AVAILABLE",
- "PAYMENT_OPTIONS",
- "BASKET_ICON",
- "COOKIES_ICON",
- "GLOBE_ICON",
- "LOCATION_ICON",
- "NOTIFICATION_ICON",
- "DOCUMENT_ICON",
- "IMAGE_DELIVERY_SHOP",
- "IMAGE_DELIVERY_CAR",
- "IMAGE_CRATE_EMPTY",
- "IMAGE_BALLOON_TEXT_EMPTY",
- "SIZE",
- "ADD_ROUNDED",
- "CALCULATE_QUOTATION",
- "STORE",
- "EDIT_CAKE",
- "COLOR_WHEEL",
- "IMAGE_BUCKET",
- "FILTER",
- "PROCESSING",
- "PACKAGE",
- "ERROR",
- "CHECKMARK",
- "CHECKMARK_THIN",
- "BANNER_HOME_FALLBACK",
- "ANDROID_NAVIGATION_NEXT",
- "EXTERNAL_LINK",
- "SHARE",
- "COPY",
- "REMOVE",
- "DELETE",
- "HEMA_LOGO",
- "SIGN_OUT",
- "CUSTOMER_SERVICE_PHONE",
- "CUSTOMER_SERVICE_TWITTER",
- "CUSTOMER_SERVICE_FB_MESSENGER",
- "CUSTOMER_SERVICE_CHAT",
- "ACCOUNT_FAVORITES",
- "ACCOUNT_ORDERS",
- "ACCOUNT_VOUCHERS",
- "ACCOUNT_PROFILE",
- "HOME_CUSTOMER_SERVICE",
- "HOME_RECALL",
- "HOME_SCANNER",
- "HOME_EXTERNAL_LINK",
- "SEARCH_SCANNER",
- "PROMOTION",
- "VOUCHER",
- "FOLDER",
- "CIRCLE_PLUS",
- "SEARCH",
- "CATEGORY"
- ]
- },
- "alt": {
- "type": "string"
- }
- },
- "required": [
- "type",
- "name"
- ]
- },
- "RemoteImage": {
- "type": "object",
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "REMOTE"
- ]
- },
- "url": {
- "type": "string"
- },
- "alt": {
- "type": "string"
- },
- "width": {
- "type": "number"
- },
- "height": {
- "type": "number"
- }
- },
- "required": [
- "type",
- "url"
- ]
- },
- "Button": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/NormalButton"
- },
- {
- "$ref": "#/components/schemas/SelectionButton"
- },
- {
- "$ref": "#/components/schemas/PlainButton"
- },
- {
- "$ref": "#/components/schemas/TextButton"
- },
- {
- "$ref": "#/components/schemas/SetBasketItemButton"
- },
- {
- "$ref": "#/components/schemas/SwitchButton"
- }
- ]
- },
- "ButtonBase": {
- "type": "object",
- "properties": {
- "id": {
- "type": "string"
- },
- "loadingIds": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "tags": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "action": {
- "$ref": "#/components/schemas/Action"
- }
- },
- "required": [
- "id"
- ]
- },
- "NormalButtonDisplayType": {
- "type": "string",
- "enum": [
- "BUY",
- "PRIMARY",
- "SECONDARY"
- ]
- },
- "NormalButton": {
- "type": "object",
- "properties": {
- "id": {
- "type": "string"
- },
- "loadingIds": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "tags": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "action": {
- "$ref": "#/components/schemas/Action"
- },
- "type": {
- "type": "string",
- "enum": [
- "NORMAL"
- ]
- },
- "displayType": {
- "$ref": "#/components/schemas/NormalButtonDisplayType"
- },
- "title": {
- "type": "string"
- },
- "icon": {
- "$ref": "#/components/schemas/LocalImage"
- }
- },
- "required": [
- "id",
- "type",
- "displayType",
- "title"
- ]
- },
- "SetBasketItemButton": {
- "type": "object",
- "properties": {
- "id": {
- "type": "string"
- },
- "loadingIds": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "tags": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "action": {
- "$ref": "#/components/schemas/Action"
- },
- "type": {
- "type": "string",
- "enum": [
- "SET_BASKET_ITEM"
- ]
- },
- "title": {
- "type": "string"
- },
- "icon": {
- "$ref": "#/components/schemas/LocalImage"
- },
- "stepQuantity": {
- "type": "number"
- },
- "minOrderQuantity": {
- "type": "number"
- },
- "maxOrderQuantity": {
- "type": "number"
- }
- },
- "required": [
- "id",
- "type",
- "title",
- "stepQuantity",
- "minOrderQuantity",
- "maxOrderQuantity"
- ]
- },
- "SelectionButton": {
- "type": "object",
- "properties": {
- "id": {
- "type": "string"
- },
- "loadingIds": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "tags": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "action": {
- "$ref": "#/components/schemas/Action"
- },
- "type": {
- "type": "string",
- "enum": [
- "SELECTION"
- ]
- },
- "title": {
- "type": "string"
- },
- "subtitle": {
- "type": "string"
- },
- "icon": {
- "$ref": "#/components/schemas/LocalImage"
- }
- },
- "required": [
- "id",
- "type"
- ]
- },
- "TextButton": {
- "type": "object",
- "properties": {
- "id": {
- "type": "string"
- },
- "loadingIds": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "tags": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "action": {
- "$ref": "#/components/schemas/Action"
- },
- "type": {
- "type": "string",
- "enum": [
- "TEXT"
- ]
- },
- "title": {
- "type": "string"
- },
- "icon": {
- "$ref": "#/components/schemas/LocalImage"
- }
- },
- "required": [
- "id",
- "type",
- "title"
- ]
- },
- "PlainButton": {
- "type": "object",
- "properties": {
- "id": {
- "type": "string"
- },
- "loadingIds": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "tags": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "action": {
- "$ref": "#/components/schemas/Action"
- },
- "type": {
- "type": "string",
- "enum": [
- "PLAIN"
- ]
- },
- "displayStyle": {
- "type": "string",
- "enum": [
- "MEDIUM",
- "SMALL"
- ]
- },
- "title": {
- "type": "string"
- },
- "icon": {
- "$ref": "#/components/schemas/LocalImage"
- }
- },
- "required": [
- "id",
- "type",
- "displayStyle",
- "title"
- ]
- },
- "QuantityControlButton": {
- "type": "object",
- "properties": {
- "id": {
- "type": "string"
- },
- "loadingIds": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "tags": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "action": {
- "$ref": "#/components/schemas/Action"
- },
- "type": {
- "type": "string",
- "enum": [
- "QUANTITY_CONTROL"
- ]
- },
- "stepQuantity": {
- "type": "number"
- },
- "minOrderQuantity": {
- "type": "number"
- },
- "maxOrderQuantity": {
- "type": "number"
- }
- },
- "required": [
- "id",
- "type",
- "stepQuantity",
- "minOrderQuantity",
- "maxOrderQuantity"
- ]
- },
- "SwitchButton": {
- "type": "object",
- "properties": {
- "id": {
- "type": "string"
- },
- "loadingIds": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "tags": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "action": {
- "$ref": "#/components/schemas/Action"
- },
- "type": {
- "type": "string",
- "enum": [
- "SWITCH"
- ]
- },
- "active": {
- "type": "boolean"
- }
- },
- "required": [
- "id",
- "type",
- "active"
- ]
- },
- "ScreenCacheData": {
- "type": "object",
- "properties": {
- "favoriteProductIds": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "basketItemCount": {
- "type": "number"
- },
- "basketItems": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/BasketItem"
- }
- },
- "pointBalance": {
- "type": "number"
- }
- }
- },
- "RefreshScreensTask": {
- "type": "object",
- "properties": {
- "refreshIds": {
- "$ref": "#/components/schemas/RefreshIds"
- },
- "loadingId": {
- "type": "string"
- },
- "transientStates": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/TransientState"
- }
- }
- },
- "required": [
- "refreshIds",
- "transientStates"
- ]
- },
- "BasketItem": {
- "type": "object",
- "properties": {
- "productId": {
- "type": "string"
- },
- "quantity": {
- "type": "number"
- }
- },
- "required": [
- "productId",
- "quantity"
- ]
- },
- "ScreenResponse": {
- "type": "object",
- "properties": {
- "screen": {
- "$ref": "#/components/schemas/Screen"
- },
- "cacheData": {
- "$ref": "#/components/schemas/ScreenCacheData"
- }
- },
- "required": [
- "screen"
- ]
- },
- "LoadComponents": {
- "type": "object",
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "LOAD_COMPONENTS"
- ]
- },
- "url": {
- "type": "string"
- },
- "uniqueId": {
- "type": "string"
- },
- "displayStyle": {
- "type": "string",
- "enum": [
- "SHIMMER_PLP_ITEMS",
- "SHIMMER_REVIEW_DETAIL",
- "SHIMMER_ORDER_HISTORY_OVERVIEW"
- ]
- }
- },
- "required": [
- "type",
- "url",
- "uniqueId",
- "displayStyle"
- ]
- },
- "ComponentResponse": {
- "oneOf": [
- {
- "oneOf": [
- {
- "$ref": "#/components/schemas/BannerComponent"
- },
- {
- "$ref": "#/components/schemas/BasketProductListItem"
- },
- {
- "$ref": "#/components/schemas/BasketCouponComponent"
- },
- {
- "$ref": "#/components/schemas/BarcodeComponent"
- },
- {
- "$ref": "#/components/schemas/BasketVoucherComponent"
- },
- {
- "$ref": "#/components/schemas/BulletListComponent"
- },
- {
- "$ref": "#/components/schemas/SpacerComponent"
- },
- {
- "$ref": "#/components/schemas/ButtonsComponent"
- },
- {
- "$ref": "#/components/schemas/ActionTextListItem"
- },
- {
- "$ref": "#/components/schemas/DefinitionListComponent"
- },
- {
- "$ref": "#/components/schemas/ExpandableInfoComponent"
- },
- {
- "$ref": "#/components/schemas/EmptyListComponent"
- },
- {
- "$ref": "#/components/schemas/FavoriteListItem"
- },
- {
- "$ref": "#/components/schemas/ImageCollectionComponent"
- },
- {
- "$ref": "#/components/schemas/InfoMessageComponent"
- },
- {
- "$ref": "#/components/schemas/ListGroupComponent"
- },
- {
- "$ref": "#/components/schemas/LoaderComponent"
- },
- {
- "$ref": "#/components/schemas/LoyaltyPointsComponent"
- },
- {
- "$ref": "#/components/schemas/LoyaltySummaryComponent"
- },
- {
- "$ref": "#/components/schemas/OrderStatusComponent"
- },
- {
- "$ref": "#/components/schemas/OrderStatusPlaceholderComponent"
- },
- {
- "$ref": "#/components/schemas/ParagraphComponent"
- },
- {
- "$ref": "#/components/schemas/PlainListItem"
- },
- {
- "$ref": "#/components/schemas/PlainProductListItem"
- },
- {
- "$ref": "#/components/schemas/PlainTextListItem"
- },
- {
- "$ref": "#/components/schemas/PlpListItem"
- },
- {
- "$ref": "#/components/schemas/ProductStoreStockComponent"
- },
- {
- "$ref": "#/components/schemas/ProgressComponent"
- },
- {
- "$ref": "#/components/schemas/PriceLineTextComponent"
- },
- {
- "$ref": "#/components/schemas/QRCodeListItem"
- },
- {
- "$ref": "#/components/schemas/QRCodeComponent"
- },
- {
- "$ref": "#/components/schemas/ReviewDetailListItem"
- },
- {
- "$ref": "#/components/schemas/ReviewSummaryComponent"
- },
- {
- "$ref": "#/components/schemas/SignupCardComponent"
- },
- {
- "$ref": "#/components/schemas/TextCardComponent"
- },
- {
- "$ref": "#/components/schemas/TitleComponent"
- },
- {
- "$ref": "#/components/schemas/TwoColumnTableComponent"
- },
- {
- "$ref": "#/components/schemas/VariationListItem"
- },
- {
- "$ref": "#/components/schemas/VariationProductListItem"
- },
- {
- "$ref": "#/components/schemas/VoucherItemComponent"
- },
- {
- "$ref": "#/components/schemas/ImageComponent"
- },
- {
- "$ref": "#/components/schemas/OrderSummaryListItem"
- },
- {
- "$ref": "#/components/schemas/OrderProductListItem"
- },
- {
- "$ref": "#/components/schemas/OrderDetailStatusComponent"
- },
- {
- "$ref": "#/components/schemas/DonationInputComponent"
- },
- {
- "$ref": "#/components/schemas/PrimaryMenuItemComponent"
- },
- {
- "$ref": "#/components/schemas/SecondaryMenuItemComponent"
- },
- {
- "$ref": "#/components/schemas/AppEnvironmentComponent"
- },
- {
- "$ref": "#/components/schemas/SearchBarComponentExperiment"
- }
- ]
- },
- {
- "type": "object",
- "properties": {},
- "additionalProperties": false
- }
- ]
- },
- "ComponentArrayResponse": {
- "type": "object",
- "properties": {
- "components": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Component"
- }
- },
- "nextPage": {
- "$ref": "#/components/schemas/LoadComponents"
- },
- "uniqueId": {
- "type": "string"
- }
- },
- "required": [
- "components",
- "uniqueId"
- ]
- },
- "SectionsArrayResponse": {
- "type": "object",
- "properties": {
- "sections": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Section"
- }
- }
- },
- "required": [
- "sections"
- ]
- },
- "CommandResponse": {
- "type": "object",
- "properties": {
- "screen": {
- "$ref": "#/components/schemas/Screen"
- },
- "cacheData": {
- "$ref": "#/components/schemas/ScreenCacheData"
- },
- "refreshScreens": {
- "$ref": "#/components/schemas/RefreshScreensTask"
- },
- "successMessage": {
- "type": "string"
- },
- "toast": {
- "$ref": "#/components/schemas/Toast"
- },
- "events": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/BFFEvent"
- }
- },
- "onCommandResponseProcessed": {
- "$ref": "#/components/schemas/CommandResponseAction"
- }
- }
- },
- "BasketItemRequestBasicData": {
- "type": "object",
- "properties": {
- "refreshScreens": {
- "$ref": "#/components/schemas/RefreshScreensTask"
- },
- "toast": {
- "$ref": "#/components/schemas/Toast"
- },
- "productId": {
- "type": "string"
- },
- "amount": {
- "oneOf": [
- {
- "type": "string"
- },
- {
- "type": "number"
- }
- ]
- },
- "eventData": {
- "type": "object",
- "properties": {
- "item": {
- "$ref": "#/components/schemas/FirebaseEcomItem"
- },
- "listName": {
- "type": "string"
- },
- "listId": {
- "type": "string"
- },
- "pageType": {
- "type": "string"
- }
- },
- "required": [
- "item",
- "pageType"
- ]
- }
- },
- "required": [
- "productId",
- "amount",
- "eventData"
- ]
- },
- "BasketItemRequestFromBasket": {
- "type": "object",
- "properties": {
- "refreshScreens": {
- "$ref": "#/components/schemas/RefreshScreensTask"
- },
- "toast": {
- "$ref": "#/components/schemas/Toast"
- },
- "productId": {
- "type": "string"
- },
- "amount": {
- "oneOf": [
- {
- "type": "string"
- },
- {
- "type": "number"
- }
- ]
- },
- "eventData": {
- "type": "object",
- "properties": {
- "item": {
- "$ref": "#/components/schemas/FirebaseEcomItem"
- },
- "listName": {
- "type": "string"
- },
- "listId": {
- "type": "string"
- },
- "pageType": {
- "type": "string"
- }
- },
- "required": [
- "item",
- "pageType"
- ]
- },
- "type": {
- "type": "string",
- "enum": [
- "BASKET_ITEM_FROM_BASKET"
- ]
- },
- "basketId": {
- "type": "string"
- },
- "basketItemId": {
- "type": "string"
- },
- "basketItemAmount": {
- "type": "number"
- }
- },
- "required": [
- "productId",
- "amount",
- "eventData",
- "type",
- "basketId",
- "basketItemId",
- "basketItemAmount"
- ]
- },
- "BasketItemRequestFromProduct": {
- "type": "object",
- "properties": {
- "refreshScreens": {
- "$ref": "#/components/schemas/RefreshScreensTask"
- },
- "toast": {
- "$ref": "#/components/schemas/Toast"
- },
- "productId": {
- "type": "string"
- },
- "amount": {
- "oneOf": [
- {
- "type": "string"
- },
- {
- "type": "number"
- }
- ]
- },
- "eventData": {
- "type": "object",
- "properties": {
- "item": {
- "$ref": "#/components/schemas/FirebaseEcomItem"
- },
- "listName": {
- "type": "string"
- },
- "listId": {
- "type": "string"
- },
- "pageType": {
- "type": "string"
- }
- },
- "required": [
- "item",
- "pageType"
- ]
- },
- "type": {
- "type": "string",
- "enum": [
- "BASKET_ITEM_FROM_PRODUCT"
- ]
- }
- },
- "required": [
- "productId",
- "amount",
- "eventData",
- "type"
- ]
- },
- "BasketItemRequest": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/BasketItemRequestFromBasket"
- },
- {
- "$ref": "#/components/schemas/BasketItemRequestFromProduct"
- }
- ]
- },
- "AddToFavoritesRequest": {
- "type": "object",
- "properties": {
- "refreshScreens": {
- "$ref": "#/components/schemas/RefreshScreensTask"
- },
- "toast": {
- "$ref": "#/components/schemas/Toast"
- },
- "productId": {
- "type": "string"
- },
- "events": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/BFFEvent"
- }
- }
- },
- "required": [
- "productId"
- ]
- },
- "RemoveFromFavoritesRequest": {
- "type": "object",
- "properties": {
- "refreshScreens": {
- "$ref": "#/components/schemas/RefreshScreensTask"
- },
- "toast": {
- "$ref": "#/components/schemas/Toast"
- },
- "productId": {
- "type": "string"
- }
- },
- "required": [
- "productId"
- ]
- },
- "BasketSummaryResponse": {
- "type": "object",
- "properties": {
- "basketItemCount": {
- "type": "number"
- },
- "basketItems": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/BasketItem"
- }
- }
- },
- "required": [
- "basketItemCount",
- "basketItems"
- ]
- },
- "FavoritesSummaryResponse": {
- "type": "object",
- "properties": {
- "favoriteProductIds": {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "required": [
- "favoriteProductIds"
- ]
- },
- "FilterResponse": {
- "type": "object",
- "properties": {
- "filters": {
- "$ref": "#/components/schemas/Filters"
- }
- },
- "required": [
- "filters"
- ]
- },
- "UrlLookupResponse": {
- "type": "object",
- "properties": {
- "action": {
- "$ref": "#/components/schemas/Action"
- }
- },
- "required": [
- "action"
- ]
- },
- "ScanResponse": {
- "type": "object",
- "properties": {
- "action": {
- "$ref": "#/components/schemas/Action"
- }
- },
- "required": [
- "action"
- ]
- },
- "StyleguideCommandRequest": {
- "type": "object",
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "SUCCESS",
- "NOT_FOUND"
- ]
- }
- },
- "required": [
- "type"
- ]
- },
- "IntrospectResponse": {
- "type": "object",
- "properties": {
- "lastDeployTime": {
- "type": "string"
- },
- "git": {
- "type": "object",
- "properties": {
- "commitSha": {
- "type": "string"
- },
- "branch": {
- "type": "string"
- },
- "lastReleasedTag": {
- "type": "string"
- },
- "lastMergedReleaseBranch": {
- "type": "string"
- },
- "mergedBranches": {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "required": [
- "mergedBranches"
- ]
- },
- "version": {
- "type": "object",
- "properties": {
- "available": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "features": {
- "type": "object",
- "additionalProperties": false,
- "x-patternProperties": {
- ".*": {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- }
- }
- },
- "required": [
- "available",
- "features"
- ]
- }
- },
- "required": [
- "git",
- "version"
- ]
- },
- "RecommendationClickEventRequest": {
- "type": "object",
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "RECOMMENDATION_CLICK_EVENT"
- ]
- },
- "recommenderName": {
- "type": "string"
- },
- "__recoUUID": {
- "type": "string"
- },
- "productId": {
- "type": "string"
- }
- },
- "required": [
- "type",
- "recommenderName",
- "__recoUUID",
- "productId"
- ]
- },
- "RecommendationViewEventRequest": {
- "type": "object",
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "RECOMMENDATION_VIEW_EVENT"
- ]
- },
- "recommenderName": {
- "type": "string"
- },
- "__recoUUID": {
- "type": "string"
- },
- "productIds": {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "required": [
- "type",
- "recommenderName",
- "__recoUUID",
- "productIds"
- ]
- },
- "ProductViewEventRequest": {
- "type": "object",
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "PRODUCT_VIEW_EVENT"
- ]
- },
- "productId": {
- "type": "string"
- }
- },
- "required": [
- "type",
- "productId"
- ]
- },
- "AddToCartEventRequest": {
- "type": "object",
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "ADD_TO_CART"
- ]
- },
- "productId": {
- "type": "string"
- },
- "price": {
- "type": "string"
- },
- "quantity": {
- "type": "number"
- }
- },
- "required": [
- "type",
- "productId",
- "price",
- "quantity"
- ]
- },
- "DataEventRequest": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/RecommendationClickEventRequest"
- },
- {
- "$ref": "#/components/schemas/RecommendationViewEventRequest"
- },
- {
- "$ref": "#/components/schemas/ProductViewEventRequest"
- },
- {
- "$ref": "#/components/schemas/AddToCartEventRequest"
- }
- ]
- }
- }
- }
- }
Advertisement
Add Comment
Please, Sign In to add comment
Advertisement