openapi: 3.0.1 info: title: OpenAPI definition version: v0 servers: - url: https://mobile.incentivio.com/incentivio-mobile-api description: Generated server url paths: /useraccounts/{userId}/complete-profile: put: tags: - passwordless-auth-controller operationId: completeProfile parameters: - name: CLIENTID in: header required: true schema: type: string - name: userId in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CompletePasswordlessProfileRequest' required: true responses: '200': description: OK /useraccounts/phoneonly/token/{token}: get: tags: - user-controller operationId: findUserAccountByToken parameters: - name: token in: path required: true schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/FindUserByTokenResponseDTO' put: tags: - user-controller operationId: updateIncompleteUserAccount parameters: - name: token in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateIncompleteUserAccountRequestDTO' required: true responses: '200': description: OK /surveys/{surveyid}/submitanswers: put: tags: - survey-answer-controller operationId: submitAnswers parameters: - name: surveyid in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/SubmitAnswersRequestDTO' required: true responses: '200': description: OK /surveys/{surveyid}/submitanswer: put: tags: - survey-answer-controller operationId: submitAnswer parameters: - name: surveyid in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/SubmitAnswerRequestDTO' required: true responses: '200': description: OK /save/singledeliveryaddress: put: tags: - delivery-address-controller operationId: addOrUpdateSingleDeliveryAddress requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateDeliveryAddressRequestDTO' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CreateDeliveryAddressResponseDTO' /save/multipledeliveryaddresses: put: tags: - delivery-address-controller operationId: addOrUpdateMultipleDeliveryAddress requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateDeliveryAddressRequestDTO' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CreateDeliveryAddressResponseDTO' /orders: get: tags: - order-controller operationId: listOrders parameters: - name: clientId in: query required: true schema: type: string - name: phone in: query required: false schema: type: string - name: email in: query required: false schema: type: string - name: customerId in: query required: false schema: type: string - name: extCustomerId in: query required: false schema: type: string - name: status in: query required: false schema: type: string enum: - OPEN - CLOSED - CANCELED - SYNC_PENDING responses: '200': description: OK content: '*/*': schema: type: array items: $ref: '#/components/schemas/ListOrderResponseDTO' put: tags: - order-controller operationId: addOrUpdateOrder requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateOrderRequestDTO' required: true responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/CreateOrderResponseDTO' /orders/{orderid}/updateorderitems: put: tags: - order-item-controller operationId: updateOrderItem parameters: - name: orderid in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateOrderItemReqDTO' required: true responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/OrderUpdateSummaryDTO' /orders/{orderid}/orderitems: put: tags: - order-item-controller operationId: addOrderItem parameters: - name: orderid in: path required: true schema: type: string - name: languageCode in: query required: false schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AddOrderItemReqDTO' required: true responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/OrderUpdateSummaryDTO' /orders/{orderid}/addorderitems: put: tags: - order-item-controller operationId: addOrderItemList parameters: - name: orderid in: path required: true schema: type: string - name: languageCode in: query required: false schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AddOrderItemListReqDTO' required: true responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/OrderUpdateSummaryDTO' /orders/{orderId}/validateguestverificationcode/{code}: put: tags: - guest-order-verification-controller operationId: validateGuestOrderVerificationCode parameters: - name: orderId in: path required: true schema: type: string - name: code in: path required: true schema: type: integer format: int32 responses: '200': description: OK /loyaltyaccounts: get: tags: - loyalty-controller operationId: viewLoyaltyAccount parameters: - name: includeloyaltytier in: query required: false schema: type: boolean default: false responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ViewLoyaltyAccountResponseDTO' put: tags: - loyalty-controller operationId: upsertLoyaltyAccountExternalId requestBody: content: application/json: schema: $ref: '#/components/schemas/UpsertLoyaltyAccountExternalIdDTO' required: true responses: '200': description: OK /loyaltyaccounts/loyaltycard: put: tags: - loyalty-controller operationId: upsertLoyaltyCardId requestBody: content: application/json: schema: $ref: '#/components/schemas/UpsertLoyaltyCardRequestDTO' required: true responses: '200': description: OK /verifyemail: post: tags: - user-controller operationId: verifyUserAccountEmail parameters: - name: code in: query required: true schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/VerifyEmailResponseDTO' /users/{userId}/orders/markimhere: post: tags: - im-here-controller operationId: markAnOrderImHere parameters: - name: userId in: path required: true schema: type: string - name: languagecode in: header required: false schema: type: string default: EN requestBody: content: application/json: schema: $ref: '#/components/schemas/ImHereRequestDTO' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ImHereResponseDTO' /users/login: post: tags: - user-controller operationId: userLogin requestBody: content: application/json: schema: $ref: '#/components/schemas/LoginRequestDTO' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/LoginResponseDTO' deprecated: true /users/login2: post: tags: - user-controller operationId: userLogin2 requestBody: content: application/json: schema: $ref: '#/components/schemas/LoginRequestDTO' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/LoginResponseDTO' deprecated: true /useraccounts: get: tags: - user-controller operationId: findUserAccount responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/FindUserAccountResponseDTO' post: tags: - user-controller operationId: createUserAccount parameters: - name: CLIENTID in: header required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateUserAccountRequestDTO' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CreateUserAccountResponseDTO' /smsuseraccounts: get: tags: - user-controller operationId: findUserAccountSMS parameters: - name: accountaliasid in: query required: false schema: type: string - name: phonenumber in: query required: false schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/FindUserAccountResponseDTO' deprecated: true post: tags: - user-controller operationId: createUserAccountSMS requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateSMSUserAccountRequestDTO' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CreateSMSUserAccountResponseDTO' deprecated: true /redeemofferbyid: post: tags: - offers-controller operationId: redeemById requestBody: content: application/json: schema: $ref: '#/components/schemas/RedeemOfferAPIRequestDTO' required: true responses: '200': description: OK /purchase/ecard: post: tags: - gift-card-controller operationId: purchaseECard requestBody: content: application/json: schema: $ref: '#/components/schemas/PurchaseECardRequestDTO' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PurchaseECardResponseDTO' /processqrcode: post: tags: - offers-controller operationId: processQRCode parameters: - name: merchantid in: query required: false schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/RedeemOfferAPIRequestDTO' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/RedeemOfferResponseDTO' /paymentinstruments: get: tags: - wallet-controller operationId: listPaymentInstruments responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ListPaymentInstrumentsResponseDTO' post: tags: - wallet-controller operationId: addPaymentInstrument requestBody: content: application/json: schema: $ref: '#/components/schemas/AddPaymentInstrumentRequestDTO' required: true responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/AddPaymentInstrumentResponseDTO' /orders/{orderid}/removediscount: post: tags: - order-offers-controller operationId: removeDiscount parameters: - name: orderid in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/RemoveOfferRequestDTO' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ViewOrderResponseDTO' /orders/{orderid}/preparepayment: post: tags: - order-payment-controller operationId: prepareOrderPayment parameters: - name: orderid in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PaymentRequestDTO' required: true responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/InitOrderResponseDTO' /orders/{orderid}/prepareguestpayment: post: tags: - order-payment-controller operationId: prepareGuestOrderPayment parameters: - name: orderid in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PaymentRequestDTO' required: true responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/InitOrderResponseDTO' /orders/{orderid}/orderitemprice: post: tags: - order-item-controller operationId: getOrderItemPrice parameters: - name: orderid in: path required: true schema: type: string - name: languageCode in: query required: false schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AddOrderItemReqDTO' required: true responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ItemTotalDTO' /orders/{orderid}/makepayment: post: tags: - order-payment-controller operationId: makeOrderPayment parameters: - name: orderid in: path required: true schema: type: string - name: inc-user-language in: header required: false schema: type: string - name: language in: query required: false schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PaymentRequestDTO' required: true responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/PaymentResponseDTO' /orders/{orderid}/makeguestpayment: post: tags: - order-payment-controller operationId: makeGuestOrderPayment parameters: - name: orderid in: path required: true schema: type: string - name: inc-user-language in: header required: false schema: type: string - name: language in: query required: false schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PaymentRequestDTO' required: true responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/PaymentResponseDTO' /orders/{orderid}/copyorder: post: tags: - order-controller operationId: validateOrderRecreation parameters: - name: orderid in: path required: true schema: type: string responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ViewOrderResponseDTO' /orders/{orderid}/applydiscount: post: tags: - order-offers-controller operationId: applyDiscount parameters: - name: orderid in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ApplyOfferRequestDTO' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ViewOrderResponseDTO' /orders/{orderId}/markimhere: post: tags: - im-here-controller operationId: markAnOrderImHere_1 parameters: - name: orderId in: path required: true schema: type: string - name: languagecode in: header required: false schema: type: string default: EN responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ImHereResponseDTO' /orders/sendguestverificationcode: post: tags: - guest-order-verification-controller operationId: sendGuestOrderVerificationCode requestBody: content: application/json: schema: $ref: '#/components/schemas/GuestOrderVerificationRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/GuestOrderVerificationResponse' /orders/payment/initorder: post: tags: - order-payment-controller operationId: initOrder parameters: - name: CLIENTID in: header required: false schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/InitOrderRequestDTO' required: true responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/InitOrderResponseDTO' /orderoffers: post: tags: - order-offers-controller operationId: getOrderOfferList parameters: - name: mock in: query required: false schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/GetOrderOffersRequestDTO' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/OrderOfferListResponseDTO' /orderoffers/applyofferonnextvisit: post: tags: - order-offers-controller operationId: applyOfferOnNextVisit requestBody: content: application/json: schema: $ref: '#/components/schemas/ApplyOfferOnNextVisitRequestDTO' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ApplyOfferOnNextVisitResponseDTO' /locations/{locationid}/orderavailability: get: tags: - order-availability-controller operationId: oldGetOrderAvailability parameters: - name: locationid in: path required: true schema: type: string - name: lat in: query required: true schema: type: number format: double - name: lon in: query required: true schema: type: number format: double - name: orderid in: query required: false schema: type: string - name: inc-user-language in: header required: false schema: type: string default: EN - name: presetorderconfigid in: query required: false schema: type: string responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/OrderAvailabilityResponseDTO' deprecated: true post: tags: - order-availability-controller operationId: newGetOrderAvailability parameters: - name: locationid in: path required: true schema: type: string - name: inc-user-language in: header required: false schema: type: string default: EN requestBody: content: application/json: schema: $ref: '#/components/schemas/OrderAvailabilityRequestDTO' required: true responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/OrderAvailabilityResponseDTO' /locations/{locationid}/orderavailability/asap: post: tags: - order-availability-controller operationId: calculateAsapDuration parameters: - name: locationid in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CalculateAsapDurationRequestDTO' required: true responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/CalculateAsapDurationResponseDTO' /locations/{locationid}/calculatetotal: post: tags: - total-controller operationId: calculateOrderTotalForItems parameters: - name: locationid in: path required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/AddOrderItemReqDTO' required: true responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/OrderTotalDTO' /giftcard/purchase: post: tags: - gift-card-controller operationId: purchaseAndEmailGiftCard parameters: - name: CLIENTID in: header required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PurchaseAndEmailGiftCardRequestDTO' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PurchaseECardResponseDTO' /giftcard/purchase/payment/prepare: post: tags: - gift-card-payment-controller operationId: purchaseAndEmailGiftCardPreparePayment parameters: - name: CLIENTID in: header required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PurchaseAndEmailGiftCardRequestDTO' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PreparePaymentResponseDTO' /giftcard/paymentinstruments: post: tags: - gift-card-controller operationId: addExistingGiftCard requestBody: content: application/json: schema: $ref: '#/components/schemas/AddPaymentInstrumentRequestDTO' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AddPaymentInstrumentResponseDTO' /giftcard/lookup: post: tags: - gift-card-controller operationId: cardLookupByNumber parameters: - name: CLIENTID in: header required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/GiftCardLookupRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/GiftCardNumberLookupResponse' /giftcard/add-value: post: tags: - gift-card-controller operationId: addValuetoGiftCard requestBody: content: application/json: schema: $ref: '#/components/schemas/AddValueRequestDTO' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AddValueResponseDTO' /giftcard/add-value/payment/prepare: post: tags: - gift-card-payment-controller operationId: addValueToGiftCardPreparePayment requestBody: content: application/json: schema: $ref: '#/components/schemas/AddValueRequestDTO' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PreparePaymentResponseDTO' /getactivitybasedoffers: post: tags: - offers-controller operationId: getOffersBasedOnUserActivity requestBody: content: application/json: schema: $ref: '#/components/schemas/ActivityContentRequestDTO' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ActivityOfferListDTO' /getactivitybasedmessages: post: tags: - message-controller operationId: distributeActivityMessages requestBody: content: application/json: schema: $ref: '#/components/schemas/GetActivityMessagesRequestDTO' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ActivityMessageListDTO' /getactivitybasedcontent: post: tags: - offers-controller operationId: getActivityBasedContent requestBody: content: application/json: schema: $ref: '#/components/schemas/ActivityContentRequestDTO' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ActivityContentResponseDTO' /externaluseraccounts: get: tags: - user-controller operationId: externalAccountFindUserAccount parameters: - name: email in: query required: false schema: type: string - name: externalid in: query required: false schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/FindUserAccountResponseDTO' post: tags: - user-controller operationId: externalAccountCreateUserAccount requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateExternalUserAccountRequestDTO' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CreateUserAccountResponseDTO' /ecard/purchase/payment/prepare: post: tags: - gift-card-payment-controller operationId: purchaseECardPreparePayment requestBody: content: application/json: schema: $ref: '#/components/schemas/PurchaseECardRequestDTO' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PreparePaymentResponseDTO' /clients/{clientid}/media: post: tags: - file-controller operationId: uploadFile parameters: - name: clientid in: path required: true schema: type: string - name: source in: query required: false schema: type: string default: mongo requestBody: content: application/json: schema: required: - file type: object properties: file: type: string format: binary responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/MobileFileUploadResponseDTO' /changedistributedofferstatus: post: tags: - offers-controller operationId: updateDistributedOfferStatus requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateDistributedOfferStatusRequestDTO' required: true responses: '200': description: OK /changedistributedmessagestatus: post: tags: - message-controller operationId: updateDistributedMessageStatus requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateMessageDistributionStatusRequestDTO' required: true responses: '200': description: OK /auth/init: post: tags: - passwordless-auth-controller operationId: authInit parameters: - name: CLIENTID in: header required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AuthInitRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AuthInitResponse' /verifyUserAccountWithCode: get: tags: - user-controller operationId: verifyUserAccountWithCode parameters: - name: CLIENTID in: header required: true schema: type: string - name: userEmail in: query required: false schema: type: string - name: userId in: query required: false schema: type: string - name: code in: query required: true schema: type: integer format: int32 responses: '200': description: OK /useraccounts/{email}/resendverificationmail: get: tags: - user-controller operationId: resendVerificationEmail parameters: - name: CLIENTID in: header required: true schema: type: string - name: email in: path required: true schema: type: string responses: '200': description: OK /useraccounts/phone-and-email-lookup: get: tags: - user-controller operationId: userLookup parameters: - name: CLIENTID in: header required: true schema: type: string - name: phoneOrEmail in: query required: true schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/UserLookUpResponseDTO' /useraccounts/accesscode: get: tags: - user-controller operationId: isUserAccessCodeExist parameters: - name: CLIENTID in: header required: true schema: type: string - name: code in: query required: true schema: type: string - name: date in: query required: false schema: type: string responses: '200': description: OK content: application/json: schema: type: boolean /updateemailpref: get: tags: - user-controller operationId: updateEmailPreference parameters: - name: pref in: query required: true schema: type: string responses: '200': description: OK /transactions: get: tags: - transactions-controller operationId: findTransactions parameters: - name: merchantid in: query required: false schema: type: string - name: startdate in: query required: false schema: type: string - name: enddate in: query required: false schema: type: string - name: sortby in: query required: false schema: type: string default: txDateTime - name: sortdirection in: query required: false schema: type: string default: DESC enum: - ASC - DESC - name: page in: query required: false schema: type: integer format: int32 default: 0 - name: count in: query required: false schema: type: integer format: int32 default: 10 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/FindTransactionsResponseDTO' /surveys/{surveyid}: get: tags: - survey-controller operationId: getSurvey parameters: - name: surveyid in: path required: true schema: type: string - name: language in: query required: false schema: type: string responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/GetSurveyResponseDTO' /stores: get: tags: - client-controller operationId: findStoresByClient parameters: - name: CLIENTID in: header required: true schema: type: string - name: page in: query required: true schema: type: integer format: int32 - name: count in: query required: true schema: type: integer format: int32 - name: sortby in: query required: false schema: type: string default: title - name: sortdirection in: query required: false schema: type: string default: ASC enum: - ASC - DESC - name: latitude in: query required: true schema: type: number format: double - name: longitude in: query required: true schema: type: number format: double - name: radius in: query required: true schema: type: number format: double - name: langCode in: query required: false schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/FindStoresResponseDTO' /segments/segments-by-customer: get: tags: - segment-controller operationId: findSegmentsByCustomer parameters: - name: page in: query required: true schema: type: integer format: int32 - name: count in: query required: true schema: type: integer format: int32 responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/FindCustomerSegmentsResponseDTO' /recaptcha/cache/{clientId}: get: tags: - recaptcha-controller operationId: getCache parameters: - name: clientId in: path required: true schema: type: string responses: '200': description: OK content: application/json: schema: type: boolean /presetorder/{code}: get: tags: - preset-order-controller operationId: getPresetOrder parameters: - name: code in: path required: true schema: type: string - name: languagecode in: query required: false schema: type: string - name: inc-user-language in: header required: false schema: type: string - name: CLIENTID in: header required: true schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PresetOrderResponseDTO' /orders/{orderid}: get: tags: - order-controller operationId: viewOrderById parameters: - name: orderid in: path required: true schema: type: string responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ViewOrderResponseDTO' /orders/{orderid}/paymentstatus: get: tags: - order-payment-controller operationId: checkOrderPaymentStatus parameters: - name: orderid in: path required: true schema: type: string responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/PaymentResponseDTO' /orders/{orderid}/calculatetotal: get: tags: - total-controller operationId: calculatePrice parameters: - name: orderid in: path required: true schema: type: string responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/OrderTotalDTO' /orders-history: get: tags: - order-controller operationId: listOrdersHistory parameters: - name: startDate in: query required: true schema: type: string - name: endDate in: query required: true schema: type: string - name: page in: query required: false schema: type: integer format: int32 default: 0 - name: count in: query required: false schema: type: integer format: int32 default: 10 - name: imhereeligible in: query required: false schema: type: boolean - name: orderFulfillTime in: query required: false schema: type: boolean default: false - name: langCode in: query required: false schema: type: string responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/OrderHistoryResponseWithPagingDTO' /orderoffers/disablenextvisitoffers: get: tags: - order-offers-controller operationId: disableNextVisitOffers responses: '200': description: OK /offers/{offerid}: get: tags: - offers-controller operationId: getOffer parameters: - name: offerid in: path required: true schema: type: string - name: languagecode in: query required: false schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/GetOfferResponseDTO' /oauth2/authorizationCode/google: get: tags: - oauth-2-controller operationId: authorizationCode parameters: - name: clientId in: query required: true schema: type: string - name: authorizationCode in: query required: true schema: type: string responses: '200': description: OK content: application/json: schema: type: string /mygiftcard: get: tags: - gift-card-controller operationId: myGiftCard parameters: - name: sourceType in: query required: true schema: type: string - name: cardIdentifier in: query required: false schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/MyGiftCardResponseDTO' /messages/{messageid}: get: tags: - message-controller operationId: findMessage parameters: - name: messageid in: path required: true schema: type: string - name: languagecode in: query required: false schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/MessageDTO' /loyaltypointssummary: get: tags: - loyalty-controller operationId: findLoyaltyPointsSummary responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/LoyaltyPointsSummaryDTO' /loyaltyaccounts/next-expiring-points: get: tags: - loyalty-controller operationId: getNextExpiringLoyaltyPoints parameters: - name: noofdays in: query required: false schema: type: integer format: int32 default: 30 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/NextExpiringLoyaltyPointsResponseDTO' /loyaltyaccounts/expiring-points: get: tags: - loyalty-controller operationId: getExpiringLoyaltyPoints parameters: - name: noofdays in: query required: false schema: type: integer format: int32 default: 30 - name: page in: query required: true schema: type: integer format: int32 - name: count in: query required: true schema: type: integer format: int32 - name: sortby in: query required: false schema: type: string default: expiryDate - name: sortdirection in: query required: false schema: type: string default: ASC enum: - ASC - DESC responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ExpiringLoyaltyPointsResponseDTO' /loyaltyaccounts/accounthistory: get: tags: - loyalty-controller operationId: viewLoyalAccountHistory parameters: - name: merchantid in: query required: false schema: type: string - name: startdate in: query required: false schema: type: string - name: enddate in: query required: false schema: type: string - name: page in: query required: true schema: type: integer format: int32 - name: count in: query required: true schema: type: integer format: int32 - name: sortby in: query required: false schema: type: string default: transactionDate - name: sortdirection in: query required: false schema: type: string default: DESC enum: - ASC - DESC responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/FindLoyaltyHistoryResponseDTO' /locationsdetail/{locationid}: get: tags: - location-controller operationId: getLocation parameters: - name: CLIENTID in: header required: true schema: type: string - name: locationid in: path required: true schema: type: string - name: langCode in: query required: false schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/LocationDTO' /locations: get: tags: - location-controller operationId: findLocations parameters: - name: CLIENTID in: header required: true schema: type: string - name: page in: query required: true schema: type: integer format: int32 - name: count in: query required: true schema: type: integer format: int32 - name: sortby in: query required: false schema: type: string default: title - name: sortdirection in: query required: false schema: type: string default: ASC enum: - ASC - DESC - name: latitude in: query required: true schema: type: number format: double - name: longitude in: query required: true schema: type: number format: double - name: radius in: query required: true schema: type: number format: double - name: langCode in: query required: false schema: type: string - name: iscatering in: query required: false schema: type: boolean - name: ismenubrowsing in: query required: false schema: type: boolean - name: markdeliverablelocations in: query required: false schema: type: boolean - name: inc-is-test in: header required: false schema: type: boolean responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/FindLocationResponseDTO' /locations/{locationid}/withindeliveryradius: get: tags: - order-availability-controller operationId: isWithinDeliveryRadius parameters: - name: locationid in: path required: true schema: type: string - name: lat in: query required: false schema: type: number format: double - name: lon in: query required: true schema: type: number format: double responses: '200': description: OK content: '*/*': schema: type: boolean /locations/{locationid}/overridekey: get: tags: - location-controller operationId: getOverrideKey parameters: - name: locationid in: path required: true schema: type: string - name: fulfillmentDateTime in: query required: true schema: type: string - name: channel in: query required: true schema: type: string - name: fulfillmentType in: query required: true schema: type: string responses: '200': description: OK content: application/json: schema: type: string /items/{itemid}: get: tags: - catalog-controller operationId: viewItemById parameters: - name: itemid in: path required: true schema: type: string responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ViewItemMobileDTO' /items/outofstock/{locationId}: get: tags: - catalog-controller operationId: getOutOfStockItemIdsByLocation parameters: - name: locationId in: path required: true schema: type: string responses: '200': description: OK content: '*/*': schema: type: array items: type: string /groups/{groupid}: get: tags: - catalog-controller operationId: viewGroupById parameters: - name: groupid in: path required: true schema: type: string - name: localDate in: query required: true schema: type: string - name: includeChildElements in: query required: false schema: type: string responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ViewGroupMobileDTO' /giftcard/transaction/{incentiviotxid}/payment/status: get: tags: - gift-card-payment-controller operationId: checkTxPaymentStatus parameters: - name: incentiviotxid in: path required: true schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/GiftCardTransactionResponseDTO' /giftcard/tokenlookup/{token}: get: tags: - gift-card-controller operationId: cardLookupByToken parameters: - name: token in: path required: true schema: type: string - name: CLIENTID in: header required: true schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/GiftCardLookupResponse' /giftcard/securetokenlookup/{token}: get: tags: - gift-card-controller operationId: secureCardLookupByToken parameters: - name: token in: path required: true schema: type: string - name: CLIENTID in: header required: true schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/SecureGiftCardLookupResponse' /externallinks: get: tags: - external-link-controller operationId: getExternalLinksList parameters: - name: CLIENTID in: header required: true schema: type: string - name: externalLinkType in: query required: true schema: type: string - name: locationId in: query required: false schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ExternalLinksResponseDTO' /dynamicEnvs: get: tags: - dynamic-env-controller operationId: getDynamicEnvList responses: '200': description: OK content: '*/*': schema: type: array items: $ref: '#/components/schemas/DynamicEnvDTO' /distributedoffers/{distributedofferid}: get: tags: - offers-controller operationId: getDistributedOffer parameters: - name: distributedofferid in: path required: true schema: type: string - name: languagecode in: query required: false schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DistributedOfferDTO' /distributedmessages/{distributedmessageid}: get: tags: - message-controller operationId: getDistributedMessage parameters: - name: distributedmessageid in: path required: true schema: type: string - name: languagecode in: query required: false schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DistributedMessageDTO' /devices: get: tags: - user-controller operationId: getUserDevices responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/GetUserDevicesResponseDTO' /deliveryaddresses: get: tags: - delivery-address-controller operationId: getDeliveryAddressListByClientIdAndUserId parameters: - name: clientId in: query required: true schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ListDeliveryAddressResponseDTO' delete: tags: - delivery-address-controller operationId: deleteDeliveryAddressByIds requestBody: content: application/json: schema: type: array items: type: string required: true responses: '200': description: OK /clients/{clientid}/webappconfig: get: tags: - web-app-config-controller operationId: getWebAppConfig parameters: - name: clientid in: path required: true schema: type: string - name: merchantid in: query required: false schema: type: string - name: locationid in: query required: false schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/WebAppConfigDTO' /clients/{clientid}/clientalias: get: tags: - client-controller operationId: getAliasByClientId parameters: - name: clientid in: path required: true schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/FindClientResponseDTO' /clientdomain/byalias: get: tags: - client-domain-controller operationId: getClientDomainByClientAlias parameters: - name: alias in: query required: true schema: type: string responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/ClientDomainDTO' /clientalias/{clientAlias}: get: tags: - client-controller operationId: getClientIdByAlias parameters: - name: clientAlias in: path required: true schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/FindClientResponseDTO' /catalogs: get: tags: - catalog-controller operationId: listCatalogs parameters: - name: langCode in: query required: true schema: type: string - name: localDate in: query required: true schema: type: string - name: CLIENT-ID in: header required: true schema: type: string - name: storeIds in: query required: true schema: type: array items: type: string responses: '200': description: OK content: '*/*': schema: type: array items: $ref: '#/components/schemas/ListCatalogMobileDTO' /cacheditems/item: get: tags: - catalog-controller operationId: readCachedItem parameters: - name: clientId in: query required: true schema: type: string - name: storeId in: query required: true schema: type: string - name: catalogId in: query required: true schema: type: string - name: langCode in: query required: true schema: type: string - name: groupId in: query required: true schema: type: string - name: itemId in: query required: true schema: type: string responses: '200': description: OK content: application/json: schema: type: string /cachedcatalogs: get: tags: - catalog-controller operationId: retrieveCachedCatalogs parameters: - name: langCode in: query required: true schema: type: string - name: localDate in: query required: true schema: type: string - name: clientId in: query required: true schema: type: string - name: checksum in: query required: true schema: type: string - name: storeId in: query required: true schema: type: string responses: '200': description: OK content: '*/*': schema: type: string /cachedcatalogs/compressed: get: tags: - catalog-controller operationId: getCompressedCachedCatalog parameters: - name: langCode in: query required: true schema: type: string - name: localDate in: query required: true schema: type: string - name: clientId in: query required: true schema: type: string - name: checksum in: query required: true schema: type: string - name: storeId in: query required: true schema: type: string responses: '200': description: OK content: application/json: schema: type: string format: byte /appoffers: get: tags: - offers-controller operationId: findDistributedOffers parameters: - name: merchantid in: query required: false schema: type: string - name: page in: query required: true schema: type: integer format: int32 - name: count in: query required: true schema: type: integer format: int32 - name: languagecode in: query required: false schema: type: string - name: loyalty in: query required: false schema: type: boolean responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AppOffersResponseDTO' /appmessages: get: tags: - message-controller operationId: findAppMessages parameters: - name: merchantid in: query required: false schema: type: string - name: page in: query required: false schema: type: integer format: int32 default: 0 - name: count in: query required: false schema: type: integer format: int32 default: 10 - name: languagecode in: query required: false schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AppMessageListDTO' /appdisplaymessage/{clientid}: get: tags: - multilingual-message-controller operationId: getAppDisplayMessage parameters: - name: clientid in: path required: true schema: type: string - name: checksum in: query required: false schema: type: string responses: '200': description: OK content: '*/*': schema: type: string /appcontent: get: tags: - offers-controller operationId: getAppContent parameters: - name: merchantid in: query required: false schema: type: string - name: page in: query required: true schema: type: integer format: int32 - name: count in: query required: true schema: type: integer format: int32 - name: languagecode in: query required: false schema: type: string - name: loyalty in: query required: false schema: type: boolean responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AppContentResponseDTO' /appconfiguration: get: tags: - app-configuration-controller operationId: getAppConfiguration parameters: - name: CLIENTID in: header required: true schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/FindAppConfigurationResponseDTO' /appcompatibility: get: tags: - user-controller operationId: checkCompatibility parameters: - name: platform in: query required: true schema: type: string - name: sdkversion in: query required: true schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CheckCompatibilityResponseDTO' /app-home-config: get: tags: - app-home-config-controller operationId: getAppHomeConfig parameters: - name: CLIENTID in: header required: true schema: type: string - name: USERID in: header required: false schema: type: string - name: Inc-Timezone in: header required: false schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AppHomeConfigDTO' /: get: tags: - home-controller operationId: home responses: '200': description: OK content: '*/*': schema: type: string /orders/{orderid}/orderitems/{orderitemid}: delete: tags: - order-item-controller operationId: deleteOrderItem parameters: - name: orderid in: path required: true schema: type: string - name: orderitemid in: path required: true schema: type: string responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/OrderUpdateSummaryDTO' /ml/mobile/**: get: tags: - ml-controller operationId: routeMLRequest parameters: - name: body in: query required: true schema: type: object responses: '200': description: OK content: application/json: schema: type: string put: tags: - ml-controller operationId: routeMLRequest_3 requestBody: content: application/json: schema: type: object responses: '200': description: OK content: application/json: schema: type: string post: tags: - ml-controller operationId: routeMLRequest_2 requestBody: content: application/json: schema: type: object responses: '200': description: OK content: application/json: schema: type: string delete: tags: - ml-controller operationId: routeMLRequest_5 requestBody: content: application/json: schema: type: object responses: '200': description: OK content: application/json: schema: type: string options: tags: - ml-controller operationId: routeMLRequest_6 requestBody: content: application/json: schema: type: object responses: '200': description: OK content: application/json: schema: type: string head: tags: - ml-controller operationId: routeMLRequest_1 requestBody: content: application/json: schema: type: object responses: '200': description: OK content: application/json: schema: type: string patch: tags: - ml-controller operationId: routeMLRequest_4 requestBody: content: application/json: schema: type: object responses: '200': description: OK content: application/json: schema: type: string components: schemas: Address: type: object properties: streetAddress1: type: string streetAddress2: type: string city: type: string postalCode: type: string region: type: string country: type: string aptSuite: type: string CompletePasswordlessProfileRequest: type: object properties: email: type: string password: type: string phoneNumber: type: string howAcquired: type: string firstName: type: string lastName: type: string dateOfBirth: type: string gender: type: string enum: - MALE - FEMALE address: $ref: '#/components/schemas/Address' referralCode: type: string baseLanguagePreference: type: string extendedAttributes: type: object additionalProperties: type: string UpdateIncompleteUserAccountRequestDTO: type: object properties: firstName: type: string lastName: type: string email: type: string password: type: string phoneNumber: type: string dateOfBirth: type: string SubmitAnswerRequestDTO: required: - questionId type: object properties: questionId: type: string userId: type: string choiceIds: uniqueItems: true type: array items: type: string textAnswer: type: string SubmitAnswersRequestDTO: type: object properties: answers: type: array items: $ref: '#/components/schemas/SubmitAnswerRequestDTO' AddressDTO: required: - city - country - postalCode - state - street1 type: object properties: addressId: type: string addressAlias: type: string street1: type: string street2: type: string city: type: string state: type: string postalCode: type: string country: type: string lat: type: number format: double lon: type: number format: double aptSuite: type: string CreateDeliveryAddressRequestDTO: required: - clientId type: object properties: id: type: string clientId: type: string userId: type: string addresses: type: array items: $ref: '#/components/schemas/AddressDTO' CreateDeliveryAddressResponseDTO: type: object properties: id: type: string CreateOrderRequestDTO: type: object properties: clientId: type: string userId: type: string orderId: type: string locationId: type: string orderName: type: string orderType: type: string enum: - DELIVERY - PICKUP - DINEIN customer: $ref: '#/components/schemas/CustomerDTO' guestCount: type: integer format: int32 tableNumber: type: string delivery: $ref: '#/components/schemas/Delivery' requestedFulfillTime: type: string revenueCenter: type: string orderNote: type: string orderSource: type: string enum: - APP - WEB - POS - KIOSK - GOOGLE_ORDERING additionalAttributes: type: object additionalProperties: type: string restrictedOrder: type: boolean presetOrderId: type: string languageCode: type: string CustomerDTO: type: object properties: customerId: type: string extCustomerId: type: string firstName: type: string lastName: type: string email: type: string phone: type: string Delivery: type: object properties: deliveryAddress: $ref: '#/components/schemas/Address' deliveryInstructions: type: string CreateOrderResponseDTO: type: object properties: orderId: type: string AddOrderItemReqDTO: required: - itemId - quantity type: object properties: additionalAttributes: type: object additionalProperties: type: string catalogId: type: string discountIds: type: array items: type: string externalId: type: string groupId: type: string itemId: type: string itemInstructions: type: string note: type: string quantity: type: integer format: int32 OrderItemDTO: required: - itemId - orderItemId - quantity type: object properties: additionalAttributes: type: object additionalProperties: type: string catalogId: type: string discountIds: type: array items: type: string externalId: type: string groupId: type: string itemId: type: string itemInstructions: type: string note: type: string options: type: array items: $ref: '#/components/schemas/AddOrderItemReqDTO' quantity: type: integer format: int32 orderItemId: type: string UpdateOrderItemReqDTO: type: object properties: orderItems: type: array items: $ref: '#/components/schemas/OrderItemDTO' ChargeSummary: type: object properties: taxableCharges: type: integer format: int32 nonTaxableCharges: type: integer format: int32 totalCharges: type: integer format: int32 charges: type: array items: $ref: '#/components/schemas/OrderCharge' displayTaxableCharges: type: string displayNonTaxableCharges: type: string displayTotalCharges: type: string DisplayInfo: type: object properties: langCode: type: string title: type: string shortDescription: type: string longDescription: type: string smallImage: type: array items: type: string mediumImage: type: array items: type: string ItemTotal: type: object properties: preDiscountSubtotal: type: integer format: int32 taxSummary: $ref: '#/components/schemas/TaxSummary' chargeSummary: $ref: '#/components/schemas/ChargeSummary' appliedDiscount: type: integer format: int32 subtotal: type: integer format: int32 total: type: integer format: int32 displayPreDiscountSubtotal: type: string displayAppliedDiscount: type: string displaySubtotal: type: string displayTotal: type: string additionalAttributes: type: object additionalProperties: type: string ItemsCountDTO: type: object properties: totalItemsCount: type: integer format: int32 itemsCount: type: object additionalProperties: type: integer format: int32 OrderCharge: type: object properties: chargeId: type: string chargeName: type: string chargeDescription: type: string taxable: type: boolean gratuity: type: boolean delivery: type: boolean chargeApplied: type: integer format: int32 displayChargeApplied: type: string OrderDiscount: type: object properties: discountId: type: string extDiscountId: type: string description: type: string amountOfDiscount: type: integer format: int32 distributedOfferId: type: string discountType: type: string pointsCost: type: integer format: int32 discountAmount: type: integer format: int32 discountPercentage: type: number format: float appliedDiscount: type: integer format: int32 displayAppliedDiscount: type: string OrderItem: type: object properties: additionalAttributes: type: object additionalProperties: type: string basePrice: type: integer format: int32 brandId: type: string catalogId: type: string categoryId: type: string displayInfo: $ref: '#/components/schemas/DisplayInfo' displayInfoTitle: type: string extCatalogId: type: string externalId: type: string group: $ref: '#/components/schemas/OrderItemGroup' itemDiscounts: type: array items: $ref: '#/components/schemas/OrderDiscount' itemId: type: string itemInstructions: type: string itemName: type: string itemTotal: $ref: '#/components/schemas/ItemTotal' notes: type: string options: type: array items: $ref: '#/components/schemas/OrderItem' orderItemId: type: string privateAttributes: type: object additionalProperties: type: string quantity: type: integer format: int32 sku: type: string unitPrice: type: integer format: int32 uom: type: string upc: type: string taxable: type: boolean OrderItemGroup: type: object properties: groupId: type: string groupExtId: type: string groupType: type: string enum: - CATALOG_GROUP - OPTION_GROUP groupName: type: string privateAttributes: type: object additionalProperties: type: string OrderTax: type: object properties: taxId: type: string taxDescription: type: string taxAmountApplied: type: integer format: int32 displayTaxAmountApplied: type: string OrderTotal: type: object properties: preDiscountSubtotal: type: integer format: int32 taxSummary: $ref: '#/components/schemas/TaxSummary' chargeSummary: $ref: '#/components/schemas/ChargeSummary' totalDiscountApplied: type: integer format: int32 subtotal: type: integer format: int32 gratuity: type: integer format: int32 total: type: integer format: int32 displayTotal: type: string displaySubtotal: type: string displayTotalDiscountApplied: type: string displayGratuity: type: string displayPreDiscountSubtotal: type: string additionalAttributes: type: object additionalProperties: type: string OrderUpdateSummaryDTO: type: object properties: itemsCountDetails: $ref: '#/components/schemas/ItemsCountDTO' orderItems: uniqueItems: true type: array items: $ref: '#/components/schemas/OrderItem' orderTotal: $ref: '#/components/schemas/OrderTotal' TaxSummary: type: object properties: totalTaxes: type: integer format: int32 taxes: type: array items: $ref: '#/components/schemas/OrderTax' displayTotalTaxes: type: string AddOrderItemListReqDTO: type: object properties: orderItems: type: array items: $ref: '#/components/schemas/AddOrderItemReqDTO' UpsertLoyaltyAccountExternalIdDTO: type: object properties: externalId: type: string UpsertLoyaltyCardRequestDTO: type: object properties: loyaltyCardId: type: string UserAccountLightResponseDTO: type: object properties: firstName: type: string lastName: type: string email: type: string phoneNumber: type: string VerifyEmailResponseDTO: type: object properties: clientId: type: string emailAddress: type: string status: type: string userAccount: $ref: '#/components/schemas/UserAccountLightResponseDTO' ImHereRequestDTO: type: object properties: orderId: type: string ImHereResponseDTO: type: object properties: message: type: string LoginRequestDTO: required: - password - username type: object properties: username: type: string password: type: string rememberme: type: boolean LoginResponseDTO: type: object properties: accountID: type: string accountAlias: type: string firstName: type: string lastName: type: string cookieValue: type: string CreateUserAccountRequestDTO: required: - baseLanguagePrefrerence - email - firstName - howAcquired - lastName - password type: object properties: address: $ref: '#/components/schemas/Address' authenticationProvider: type: string enum: - APPLE - GOOGLE - INCENTIVIO - OTP baseLanguagePrefrerence: type: string dateOfBirth: type: string email: type: string extendedAttributes: type: object additionalProperties: type: string firstName: type: string gender: type: string household: $ref: '#/components/schemas/HouseholdDTO' howAcquired: type: string jwt: type: string lastName: type: string password: type: string phoneNumber: type: string referralCode: type: string userProfileImageUrl: type: string HouseholdDTO: type: object properties: title: type: string CreateUserAccountResponseDTO: type: object properties: userId: type: string referralId: type: string verified: type: boolean CreateSMSUserAccountRequestDTO: required: - phoneNumber type: object properties: phoneNumber: type: string CreateSMSUserAccountResponseDTO: type: object properties: accountAliasId: type: string phoneNumber: type: string RedeemOfferAPIRequestDTO: required: - transactionDate type: object properties: userId: type: string qrCodeValue: type: string transactionDate: type: string latitude: type: number format: double longitude: type: number format: double distributedOfferId: type: string PurchaseECardRequestDTO: required: - amount - paymentType - sourceType type: object properties: clientId: type: string userId: type: string amount: type: integer format: int32 locationId: type: string sourceType: type: string paymentType: type: string enum: - CARD_NOT_PRESENT - CARD_PRESENT - CASH - THIRD_PARTY - APPLE_PAY - ANDROID_PAY - SAMSUNG_PAY - NO_PAYMENT - GOOGLE_PAY - ONE_TIME_TOKEN - PERMANENT_TOKEN - GIFT_CARD - PAYMENT_SKIPPED paymentMode: type: string enum: - PAYMENT_MANDATORY - PAYMENT_OPTIONAL - NO_PAYMENT paymentToken: type: string cardType: type: string paymentMethodType: type: string zipCode: type: string additionalAttributes: type: object additionalProperties: type: string isOneTimeTransaction: type: boolean expirationYear: type: integer format: int32 expirationMonth: type: integer format: int32 oneTimeTransaction: type: boolean PurchaseECardResponseDTO: type: object properties: clientId: type: string userId: type: string cardIdentifier: type: string cardAccountBalance: type: number format: double cardStatus: type: string enum: - ACTIVE - INACTIVE status: type: string cardType: type: string image: type: string token: type: string default: type: boolean RedeemOfferResponseDTO: type: object properties: pointsRedeemed: type: integer format: int32 totalPointsBalance: type: integer format: int32 smallImage: type: string mediumImage: type: string AddPaymentInstrumentRequestDTO: type: object properties: clientId: type: string locationId: type: string userId: type: string paymentType: type: string paymentToken: type: string lastFour: type: string cardSecurityCode: type: string nickname: type: string zipCode: type: string isDefault: type: boolean tokenType: type: string sourceType: type: string expirationMonth: type: integer format: int32 expirationYear: type: integer format: int32 additionalAttributes: type: object additionalProperties: type: string default: type: boolean AddPaymentInstrumentResponseDTO: type: object properties: paymentInstrumentId: type: string RemoveOfferRequestDTO: type: object properties: offerId: type: string userId: type: string Check: type: object properties: checkId: type: string extCheckId: type: string customer: $ref: '#/components/schemas/Customer' amount: type: integer format: int32 gratuity: type: integer format: int32 payments: type: array items: $ref: '#/components/schemas/Payment' Customer: type: object properties: customerId: type: string extCustomerId: type: string firstName: type: string lastName: type: string email: type: string phone: type: string Payment: type: object properties: paymentTxId: type: string externalTxId: type: string paidDate: type: string paymentType: type: string enum: - CARD_NOT_PRESENT - CARD_PRESENT - CASH - THIRD_PARTY - APPLE_PAY - ANDROID_PAY - SAMSUNG_PAY - NO_PAYMENT - GOOGLE_PAY - ONE_TIME_TOKEN - PERMANENT_TOKEN - GIFT_CARD - PAYMENT_SKIPPED cardType: type: string lastFour: type: string amount: type: integer format: int32 tipAmount: type: integer format: int32 amountTendered: type: integer format: int32 ViewOrderResponseDTO: type: object properties: orderId: type: string clientId: type: string merchantId: type: string locationId: type: string extOrderId: type: string orderName: type: string orderNumber: type: string orderType: type: string enum: - DELIVERY - PICKUP - DINEIN customer: $ref: '#/components/schemas/Customer' guestCount: type: integer format: int32 tableId: type: string delivery: $ref: '#/components/schemas/Delivery' openedTime: type: string closedTime: type: string status: type: string enum: - OPEN - CLOSED - CANCELED - SYNC_PENDING orderFulfillTime: type: string revenueCenter: type: string orderItems: uniqueItems: true type: array items: $ref: '#/components/schemas/OrderItem' orderDiscounts: type: array items: $ref: '#/components/schemas/OrderDiscount' additionalAttributes: type: object additionalProperties: type: string checks: type: array items: $ref: '#/components/schemas/Check' orderTotal: $ref: '#/components/schemas/OrderTotal' itemsCountDetails: $ref: '#/components/schemas/ItemsCountDTO' orderNote: type: string orderSource: type: string enum: - APP - WEB - POS - KIOSK - GOOGLE_ORDERING guestOrderVerified: type: boolean BillingAddress: type: object properties: name: type: string address1: type: string address2: type: string city: type: string state: type: string zip: type: string country: type: string phoneNumber: type: string OrderOptionInfo: type: object properties: optionName: type: string information: type: string optionDescription: type: string PaymentRequestDTO: required: - email - firstName - lastName - phone - userId type: object properties: userId: type: string firstName: type: string lastName: type: string email: type: string phone: type: string paymentMode: type: string enum: - PAYMENT_MANDATORY - PAYMENT_OPTIONAL - NO_PAYMENT paymentType: type: string enum: - CARD_NOT_PRESENT - CARD_PRESENT - CASH - THIRD_PARTY - APPLE_PAY - ANDROID_PAY - SAMSUNG_PAY - NO_PAYMENT - GOOGLE_PAY - ONE_TIME_TOKEN - PERMANENT_TOKEN - GIFT_CARD - PAYMENT_SKIPPED paymentToken: type: string cardType: type: string expirationYear: type: integer format: int32 expirationMonth: type: integer format: int32 gratuity: type: integer format: int32 additionalAttributes: type: object additionalProperties: type: string deliveryInstructions: type: string orderNote: type: string tableNumber: type: string isOneTimeTransaction: type: boolean paymentMethodType: type: string zipCode: type: string sourceType: type: string orderOptionInfo: $ref: '#/components/schemas/OrderOptionInfo' cardNickname: type: string savePaymentInstrument: type: boolean billingAddress: $ref: '#/components/schemas/BillingAddress' InitOrderResponseDTO: type: object properties: otherData: type: string attributes: type: object additionalProperties: type: string paymentConfigs: type: array items: $ref: '#/components/schemas/PaymentConfig' PaymentConfig: type: object properties: orderType: type: string enum: - DELIVERY - PICKUP - DINEIN paymentModes: type: array items: type: string enum: - PAYMENT_MANDATORY - PAYMENT_OPTIONAL - NO_PAYMENT placePOSOrdersAsOpen: type: boolean guestCheckoutSupported: type: boolean ItemTotalDTO: type: object properties: preDiscountSubtotal: type: integer format: int32 subtotal: type: integer format: int32 total: type: integer format: int32 taxSummary: $ref: '#/components/schemas/TaxSummary' chargeSummary: $ref: '#/components/schemas/ChargeSummary' optionsTotal: type: integer format: int32 optionsDiscountedTotal: type: integer format: int32 itemPrice: type: integer format: int32 itemDisountedPrice: type: integer format: int32 PaymentResponseDTO: type: object properties: orderStatus: type: string enum: - ORDER_SUCCESS - ORDER_PENDING - ORDER_REVERSAL_SUCCESS - ORDER_REVERSAL_FAILED - ORDER_REVERSAL_NOT_SUPPORTED - ORDER_PROCESSOR_TIMEOUT - ORDER_PROCESSING_ERROR - PAYMENT_SUCCESS - PAYMENT_3DS2_AUTHENTICATION_PENDING - PAYMENT_SKIPPED - PAYMENT_DECLINED - PAYMENT_PENDING - PAYMENT_PROCESSOR_TIMEOUT - PAYMENT_GATEWAY_ERROR - INSUFFICIENT_FUNDS - INSUFFICIENT_GIFT_CARD_FUNDS - INVALID_PAYMENT_DETAILS - PAYMENT_PROCESSING_ERROR - PAYMENT_REVERSAL_SUCCESS - PAYMENT_REVERSAL_FAILED - CARD_VERFICATION_SUCCESS - CARD_VERFICATION_FAILED - CARD_VERFICATION_ISSUER_DECLINE - CARD_AVS_VERFICATION_FAILED - CARD_VERIFICATION_AVS_ZIP_CODE_MISMATCH - CARD_3DS_VERIFICATION_FAILED - PAYMENT_ISSUER_TIMEOUT - CARD_EXPIRED - PAYMENT_TX_NOT_FOUND - INVALID_INPUTS - CARD_NOT_SUPPORTED - PAYMENT_METHOD_ERROR - REDEMPTION_ERROR - INTERNAL_SERVER_ERROR - CONFIGURATION_ERROR - PRICE_CALCULATION_SUCCESS - PRICE_CALCULATION_FAILED - PRICE_CALCULATION_TIMEOUT - CVV2_MISMATCH - CVV_REJECTED - DUPLICATE_TRANSACTION orderCreatedDate: type: string externalOrderId: type: string orderId: type: string orderNumber: type: string amountTendered: type: integer format: int32 orderFulfillTime: type: string trackingUrl: type: string externalStatuses: type: object additionalProperties: type: string ApplyOfferRequestDTO: required: - localDateTime type: object properties: distributedOfferId: type: string offerId: type: string pointsToSpend: type: integer format: int32 amountToRedeem: type: number format: float latitude: type: number format: double longitude: type: number format: double localDateTime: type: string userId: type: string orderOptionType: type: string GuestOrderVerificationRequest: type: object properties: orderId: type: string recipient: type: string GuestOrderVerificationResponse: type: object properties: orderId: type: string expirationMinutes: type: integer format: int64 InitOrderRequestDTO: type: object properties: attributes: type: object additionalProperties: type: string cardType: type: string lastFour: type: string locationId: type: string merchantId: type: string orderId: type: string otherData: type: string paymentToken: type: string GetOrderOffersRequestDTO: required: - localDateTime type: object properties: orderId: type: string incentivioOrderId: type: string languageCode: type: string merchantId: type: string latitude: type: number format: double longitude: type: number format: double localDateTime: type: string locationId: type: string orderItems: uniqueItems: true type: array items: $ref: '#/components/schemas/OfferOrderItem' orderType: type: string orderOptionType: type: string subTotal: type: integer format: int32 evaluateOnlyUserOffers: type: boolean OfferOrderItem: type: object properties: orderItemId: type: string itemId: type: string externalId: type: string group: $ref: '#/components/schemas/OrderItemGroup' groupId: type: string sku: type: string upc: type: string catalogId: type: string extCatalogId: type: string brandId: type: string categoryId: type: string quantity: type: integer format: int32 options: type: array items: $ref: '#/components/schemas/OfferOrderItem' ItemQualifier: type: object properties: qualifierItemAttribute: type: string enum: - CATALOG - GROUP - ITEM - BRAND - CATEGORY qualifierItems: type: array items: $ref: '#/components/schemas/QualifyingItem' qualifierSelectionMode: type: string enum: - ONE - ALL OrderOfferDTO: type: object properties: distributedOfferId: type: string offerId: type: string clientId: type: string merchantId: type: string offerCode: type: string codeFormat: type: string title: type: string shortDescription: type: string longDescription: type: string smallImage: type: string mediumImage: type: string status: type: string enum: - NEW - SAVED - READ - EXPIRED - DELETED - SYSTEM_REDEEMED - USER_REDEEMED redemptionEndDate: type: string distributedDate: type: string updatedDate: type: string pointsCost: type: integer format: int32 availablePoints: type: integer format: int32 availableBalance: type: number format: float discountType: type: string enum: - AMOUNT - PERCENTAGE discountPercentage: type: number format: float discountAmount: type: integer format: int32 variablePoints: type: boolean variableAmount: type: boolean requiredItems: $ref: '#/components/schemas/ItemQualifier' applyOfferOnNextVisit: type: boolean OrderOfferListResponseDTO: type: object properties: applicableOffers: type: array items: $ref: '#/components/schemas/OrderOfferDTO' itemRequiredOffers: type: array items: $ref: '#/components/schemas/OrderOfferDTO' QualifyingItem: type: object properties: itemAttribute: type: string enum: - CATALOG - GROUP - ITEM - BRAND - CATEGORY attributeId: type: string attributeObjectName: type: string count: type: integer format: int32 ApplyOfferOnNextVisitRequestDTO: type: object properties: distributedOfferId: type: string ApplyOfferOnNextVisitResponseDTO: type: object properties: appliedOfferDistributionId: type: string OrderAvailabilityRequestDTO: type: object properties: presetOrderId: type: string orderId: type: string address: $ref: '#/components/schemas/Address' selectedDay: type: string format: date OrderAvailabilityResponseDTO: type: object properties: pickupAvailable: type: boolean deliveryAvailable: type: boolean firstAvailablePickupTime: type: string firstAvailableDeliveryTime: type: string deliveryOffDays: type: array items: type: string pickupOffDays: type: array items: type: string pickupAvailableTimes: type: object additionalProperties: type: array items: type: string deliveryAvailableTimes: type: object additionalProperties: type: array items: type: string pickupTimeSlots: type: object additionalProperties: type: array items: $ref: '#/components/schemas/ValidatedTimeSlot' deliveryTimeSlots: type: object additionalProperties: type: array items: $ref: '#/components/schemas/ValidatedTimeSlot' withinDeliveryDistance: type: boolean timeZone: type: string pickupAsapAvailable: type: boolean deliveryAsapAvailable: type: boolean pickupDelayedMessage: type: string deliveryDelayedMessage: type: string maxOrderingDate: type: string format: date ValidatedTimeSlot: type: object properties: time: type: string valid: type: boolean CalculateAsapDurationRequestDTO: type: object properties: orderId: type: string orderType: type: string enum: - DELIVERY - PICKUP - DINEIN address: $ref: '#/components/schemas/Address' CalculateAsapDurationResponseDTO: type: object properties: orderType: type: string enum: - DELIVERY - PICKUP - DINEIN asapAvailable: type: boolean asapDuration: type: integer format: int32 OrderTotalDTO: type: object properties: preDiscountSubtotal: type: integer format: int32 taxSummary: $ref: '#/components/schemas/TaxSummary' chargeSummary: $ref: '#/components/schemas/ChargeSummary' subtotal: type: integer format: int32 gratuity: type: integer format: int32 total: type: integer format: int32 additionalAttributes: type: object additionalProperties: type: string GiftCardRecipient: type: object properties: name: type: string email: type: string message: type: string GiftCardSender: type: object properties: firstName: type: string lastName: type: string email: type: string phone: type: string customerId: type: string adminId: type: string PurchaseAndEmailGiftCardRequestDTO: required: - amount - paymentType - sourceType type: object properties: clientId: type: string userId: type: string amount: type: integer format: int32 locationId: type: string sourceType: type: string paymentType: type: string enum: - CARD_NOT_PRESENT - CARD_PRESENT - CASH - THIRD_PARTY - APPLE_PAY - ANDROID_PAY - SAMSUNG_PAY - NO_PAYMENT - GOOGLE_PAY - ONE_TIME_TOKEN - PERMANENT_TOKEN - GIFT_CARD - PAYMENT_SKIPPED paymentMode: type: string enum: - PAYMENT_MANDATORY - PAYMENT_OPTIONAL - NO_PAYMENT paymentToken: type: string cardType: type: string paymentMethodType: type: string zipCode: type: string additionalAttributes: type: object additionalProperties: type: string isOneTimeTransaction: type: boolean expirationYear: type: integer format: int32 expirationMonth: type: integer format: int32 recipient: $ref: '#/components/schemas/GiftCardRecipient' sender: $ref: '#/components/schemas/GiftCardSender' from: type: string oneTimeTransaction: type: boolean PreparePaymentResponseDTO: type: object properties: attributes: type: object additionalProperties: type: string GiftCardLookupRequest: type: object properties: clientId: type: string cardNumber: type: string securityCode: type: string errorOnAssigned: type: boolean GiftCardNumberLookupResponse: type: object properties: token: type: string AddValueRequestDTO: required: - amount - cardIdentifier - paymentType - sourceType type: object properties: clientId: type: string userId: type: string amount: type: integer format: int32 cardIdentifier: type: string locationId: type: string sourceType: type: string paymentType: type: string enum: - CARD_NOT_PRESENT - CARD_PRESENT - CASH - THIRD_PARTY - APPLE_PAY - ANDROID_PAY - SAMSUNG_PAY - NO_PAYMENT - GOOGLE_PAY - ONE_TIME_TOKEN - PERMANENT_TOKEN - GIFT_CARD - PAYMENT_SKIPPED paymentMode: type: string enum: - PAYMENT_MANDATORY - PAYMENT_OPTIONAL - NO_PAYMENT paymentToken: type: string cardType: type: string paymentMethodType: type: string zipCode: type: string additionalAttributes: type: object additionalProperties: type: string isOneTimeTransaction: type: boolean expirationYear: type: integer format: int32 expirationMonth: type: integer format: int32 oneTimeTransaction: type: boolean AddValueResponseDTO: type: object properties: clientId: type: string userId: type: string cardIdentifier: type: string cardAccountBalance: type: number format: double cardStatus: type: string enum: - ACTIVE - INACTIVE status: type: string cardType: type: string image: type: string default: type: boolean ActivityContentRequestDTO: type: object properties: userId: type: string clientId: type: string languageCode: type: string merchantId: type: string latitude: type: number format: double longitude: type: number format: double events: type: object additionalProperties: type: array items: type: string localDateTime: type: string ActivityOfferDTO: type: object properties: distributedOfferId: type: string offerId: type: string clientId: type: string merchantId: type: string offerCode: type: string codeFormat: type: string languageCode: type: string title: type: string shortDescription: type: string longDescription: type: string smallImage: type: string mediumImage: type: string status: type: string enum: - NEW - SAVED - READ - EXPIRED - DELETED - SYSTEM_REDEEMED - USER_REDEEMED redeemType: type: string purchaseTypes: uniqueItems: true type: array items: type: string redemptionEndDate: type: string distributedDate: type: string updatedDate: type: string redemptionEndDateType: type: string ActivityOfferListDTO: type: object properties: offers: type: array items: $ref: '#/components/schemas/ActivityOfferDTO' GetActivityMessagesRequestDTO: required: - userId type: object properties: userId: type: string languageCode: type: string merchantId: type: string latitude: type: number format: double longitude: type: number format: double events: type: object additionalProperties: type: array items: type: string ActivityMessageDTO: type: object properties: distributedMessageId: type: string merchantId: type: string messageId: type: string languageCode: type: string title: type: string shortDescription: type: string longDescription: type: string smallImage: type: string mediumImage: type: string status: type: string enum: - NEW - READ - EXPIRED - DELETED distributedDate: type: string updatedDate: type: string messageType: type: string enum: - PRIVATE - SHAREABLE - REFERRAL - SURVEY surveyId: type: string distributedEndDate: type: string ActivityMessageListDTO: type: object properties: messages: type: array items: $ref: '#/components/schemas/ActivityMessageDTO' ActivityContentResponseDTO: type: object properties: offerList: $ref: '#/components/schemas/ActivityOfferListDTO' messageList: $ref: '#/components/schemas/ActivityMessageListDTO' CreateExternalUserAccountRequestDTO: required: - baseLanguagePrefrerence - email - externalId - firstName - howAcquired - lastName - password - salt type: object properties: externalId: type: string firstName: type: string lastName: type: string email: type: string baseLanguagePrefrerence: type: string howAcquired: type: string password: type: string salt: type: string gender: type: string phoneNumber: type: string dateOfBirth: type: string address: $ref: '#/components/schemas/Address' MobileFileUploadResponseDTO: type: object properties: fileId: type: string metaDataUrl: type: string downloadUrl: type: string UpdateDistributedOfferStatusRequestDTO: required: - redeemStatus type: object properties: distributedOfferId: type: string distributedOfferCode: type: string redeemStatus: type: string enum: - NEW - SAVED - READ - EXPIRED - DELETED - SYSTEM_REDEEMED - USER_REDEEMED UpdateMessageDistributionStatusRequestDTO: required: - distributedMessageId - status type: object properties: distributedMessageId: type: string status: type: string enum: - NEW - READ - EXPIRED - DELETED AuthInitRequest: type: object properties: identifier: type: string method: type: string enum: - MAGIC_LINK - SMS_OTP AuthInitResponse: type: object properties: destination: type: string method: type: string enum: - MAGIC_LINK - SMS_OTP expires_in: type: integer format: int32 is_new_user: type: boolean FindUserAccountResponseDTO: type: object properties: userId: type: string accountAliasId: type: string mergedPrimaryUserAccountId: type: string household: $ref: '#/components/schemas/HouseholdDTO' address: $ref: '#/components/schemas/Address' clientId: type: string firstName: type: string lastName: type: string email: type: string phoneNumber: type: string externalId: type: string baseLanguagePrefrerence: type: string status: type: string howAcquired: type: string gender: type: string dateOfBirth: type: string extendedAttributes: type: object additionalProperties: type: string userProfileImageUrl: type: string FindUserByTokenResponseDTO: type: object properties: userAccountDTO: $ref: '#/components/schemas/UserAccountDTO' message: type: string UserAccountDTO: type: object properties: userId: type: string clientId: type: string email: type: string gender: type: string enum: - MALE - FEMALE dateOfBirth: type: string format: date-time phoneNumber: type: string firstName: type: string lastName: type: string baseLanguagePrefrerence: type: string aliasId: type: string extendedAttributes: type: object additionalProperties: type: array items: type: string emailBounced: type: boolean userAccountNumber: type: string confirmedPoints: type: integer format: int32 blocked: type: boolean UserLookUpResponseDTO: type: object properties: contact: type: string AppliedDiscount: type: object properties: additionalAttribs: type: object additionalProperties: type: string appliedDiscount: type: integer format: int32 appliedQuantity: type: integer format: int32 discountType: type: string distributedOfferId: type: string extOfferId: type: string incentivioDistributedOfferId: type: string name: type: string offerCode: type: string offerId: type: string voided: type: boolean FindTransactionsResponseDTO: type: object properties: transactions: type: array items: $ref: '#/components/schemas/TransactionDTO' paging: $ref: '#/components/schemas/PagingDTO' PagingDTO: type: object properties: total: type: integer format: int64 count: type: integer format: int32 totalPages: type: integer format: int32 currentPage: type: integer format: int32 Refund: type: object properties: refundAmount: type: integer format: int32 refundBusinessDate: type: string format: date refundDate: type: string format: date-time tipRefundAmount: type: integer format: int32 Total: type: object properties: dicountTotal: type: integer format: int32 due: type: integer format: int32 gratuity: type: integer format: int32 itemTotal: type: integer format: int32 nonTaxedChargeTotal: type: integer format: int32 paid: type: integer format: int32 processingFee: type: integer format: int32 subTotal: type: integer format: int32 tax: type: integer format: int32 taxedChargeTotal: type: integer format: int32 total: type: integer format: int32 TransactionDTO: type: object properties: appliedDiscounts: type: array items: $ref: '#/components/schemas/AppliedDiscount' businessDate: type: string checks: type: array items: $ref: '#/components/schemas/Check' clientId: type: string closedDate: type: string format: date-time customerId: type: string deleted: type: boolean deletedDate: type: string format: date-time diningOption: type: string externalDiningOptionName: type: string externalDiningOptionId: type: string displayNumber: type: string employeeId: type: string employeeName: type: string extCustId: type: string extendedAttribs: type: object additionalProperties: type: string extLoyaltyId: type: string extStoreId: type: string extTxId: type: string fullFilDate: type: string format: date-time id: type: string importBatchId: type: string importedDate: type: string format: date-time laneId: type: string loyaltyId: type: string loyaltyNumber: type: string loyaltyPoints: type: number format: double loyaltyStatus: type: string enum: - ALREADY_PROCESSED - FAILED - IGNORED - NOT_PROCESSED - SUCCESS loyaltyStatusModifiedTime: type: string format: date-time merchantId: type: string modifiedDate: type: string format: date-time openedDate: type: string format: date-time orderType: type: string paymentStatus: type: string posId: type: string posName: type: string refund: $ref: '#/components/schemas/Refund' refundStatus: type: string source: type: string storeId: type: string storeName: type: string total: $ref: '#/components/schemas/Total' transactionType: type: string txCreatedDate: type: string format: date-time txDateTime: type: string format: date-time txModifiedDate: type: string format: date-time txZoneId: type: string voided: type: boolean voidInfo: $ref: '#/components/schemas/VoidInfo' reImport: type: boolean VoidInfo: type: object properties: voidBusinessDate: type: string format: date voidDate: type: string format: date-time voidReason: type: string ChoiceDTO: required: - choiceDisplayInfos - choiceTitle type: object properties: choiceId: type: string choiceTitle: type: string imageUrl: type: string isDefault: type: boolean positionIndex: type: integer format: int32 choiceDisplayInfos: uniqueItems: true type: array items: $ref: '#/components/schemas/ChoiceDisplayInfo' ChoiceDisplayInfo: type: object properties: languageCode: type: string title: type: string GetQuestionResponseDTO: type: object properties: clientId: type: string merchantId: type: string locationId: type: string questionId: type: string questionTitle: type: string type: type: string enum: - SINGLE_CHOICE - MULTIPLE_CHOICE - BOOLEAN - OPEN_ENDED - RATING choices: type: array items: $ref: '#/components/schemas/ChoiceDTO' questionDisplayInfos: uniqueItems: true type: array items: $ref: '#/components/schemas/QuestionDisplayInfo' isMandatory: type: boolean createdDateTime: type: string format: date-time modifiedDateTime: type: string format: date-time GetSurveyResponseDTO: type: object properties: surveyId: type: string clientId: type: string merchantId: type: string locationId: type: string name: type: string description: type: string imageUrl: type: string questions: uniqueItems: true type: array items: $ref: '#/components/schemas/GetQuestionResponseDTO' surveyDisplayInfos: uniqueItems: true type: array items: $ref: '#/components/schemas/SurveyDisplayInfo' createdDateTime: type: string format: date-time modifiedDateTime: type: string format: date-time QuestionDisplayInfo: type: object properties: languageCode: type: string title: type: string questionDescription: type: string imageUrl: type: string SurveyDisplayInfo: type: object properties: languageCode: type: string title: type: string shortDescription: type: string longDescription: type: string imageUrl: type: string FindStoresResponseDTO: type: object properties: paging: $ref: '#/components/schemas/PagingDto' stores: type: array items: $ref: '#/components/schemas/StoreDTO' PagingDto: type: object properties: count: type: integer format: int32 currentPage: type: integer format: int32 total: type: integer format: int64 totalPages: type: integer format: int64 StoreDTO: type: object properties: storeId: type: string title: type: string address: $ref: '#/components/schemas/Address' phoneNumber: type: string shortDescription: type: string longDescription: type: string regionId: type: string storeCode: type: string latitude: type: number format: double longitude: type: number format: double storeType: type: string beaconId: type: string beaconName: type: string smallImage: type: string mediumImage: type: string displayInfo: uniqueItems: true type: array items: $ref: '#/components/schemas/StoreDisplayInfo' StoreDisplayInfo: type: object properties: languageCode: type: string title: type: string shortDescription: type: string longDescription: type: string smallImage: type: string mediumImage: type: string ExpressionValueNew: type: object properties: attributeName: type: string attributeTitle: type: string attributeValues: type: object dataType: type: string productList: uniqueItems: true type: array items: $ref: '#/components/schemas/ProductDTO' subCategory: type: string enum: - LIFETIME - LAST_NO_OF_DAYS - NO_OF_ORDERS relationalOperator: type: string enum: - EQ - LT - GT - LT_EQ - GT_EQ - NOT - WITHIN - NOTEXISTS quantity: type: string noOfDays: type: integer format: int32 noOfOrders: type: integer format: int32 startTime: $ref: '#/components/schemas/LocalTime' endTime: $ref: '#/components/schemas/LocalTime' daysOfWeek: type: array items: type: string enum: - MONDAY - TUESDAY - WEDNESDAY - THURSDAY - FRIDAY - SATURDAY - SUNDAY FindCustomerSegmentsResponseDTO: type: object properties: clientId: type: string customerId: type: string paging: $ref: '#/components/schemas/ResultsPagingDTO' segments: type: array items: $ref: '#/components/schemas/SegmentLightResponseDTO' LocalTime: type: object properties: hour: type: integer format: int32 minute: type: integer format: int32 second: type: integer format: int32 nano: type: integer format: int32 ProductDTO: type: object properties: type: type: string id: type: string externalId: type: string displayInfoTitlesList: type: array items: type: string ResultsPagingDTO: type: object properties: total: type: integer format: int64 count: type: integer format: int32 totalPages: type: integer format: int64 currentPage: type: integer format: int32 RuleDescriptor: type: object properties: ruleType: type: string enum: - EXPRESSION - LOGIC operator: type: string enum: - EQ - LT - GT - LT_EQ - GT_EQ - NOT - WITHIN - NOTEXISTS expressionValue: type: string expressionValueNew: $ref: '#/components/schemas/ExpressionValueNew' expressionName: type: string expressoinFormat: type: string extendedAttributes: type: object additionalProperties: type: string logicType: type: string enum: - AND - OR - NOT childNodes: type: array items: $ref: '#/components/schemas/RuleDescriptor' SegmentLightResponseDTO: type: object properties: segmentId: type: string segmentName: type: string segmentDescription: type: string segmentIcon: type: string segmentRules: $ref: '#/components/schemas/RuleDescriptor' deletedStatus: type: boolean Charge: type: object properties: chargeId: type: string chargeDescription: type: string chargeType: type: string enum: - OPEN - AMOUNT - PERCENTAGE amount: type: integer format: int32 percentage: type: number format: float taxable: type: boolean gratuity: type: boolean delivery: type: boolean DeliveryInfo: type: object properties: deliveryAddress: $ref: '#/components/schemas/Address' deliveryInstructions: type: string OrderConfigDisplayInfo: type: object properties: languageCode: type: string description: type: string notEnoughPrepTimeErrorMessage: type: string PresetOrderResponseDTO: type: object properties: presetOrderConfigId: type: string code: type: string clientId: type: string locationId: type: string description: type: string displayInfo: uniqueItems: true type: array items: $ref: '#/components/schemas/OrderConfigDisplayInfo' orderType: type: string enum: - DELIVERY - PICKUP - DINEIN restrictionType: type: string enum: - RESTRICTED_ORDER - REGULAR_ORDER dateSelectionMode: type: string enum: - TODAY - FIXED - USER_SELECT timeSelectionMode: type: string enum: - ASAP - FIXED - USER_SELECT itemValidationMode: type: string enum: - NONE - BASE_ITEM - BASE_WITH_MODIFIERS displayPresetValueConfirmationPage: type: boolean notEnoughPrepTimeErrorMessage: type: string deliveryInfo: $ref: '#/components/schemas/DeliveryInfo' requestedFulfillDate: type: string format: date requestedFulfillTime: $ref: '#/components/schemas/LocalTime' charges: type: array items: $ref: '#/components/schemas/Charge' items: type: array items: $ref: '#/components/schemas/AddOrderItemReqDTO' orderInstructions: type: string ListPaymentInstrumentsResponseDTO: type: object properties: paymentInstruments: type: array items: $ref: '#/components/schemas/PaymentInstrumentDTO' PaymentInstrumentDTO: type: object properties: paymentInstrumentId: type: string clientId: type: string userId: type: string paymentType: type: string cardType: type: string expirationYear: type: integer format: int32 expirationMonth: type: integer format: int32 paymentToken: type: string lastFour: type: string nickname: type: string image: type: string isDefault: type: boolean extendedAttributes: type: object additionalProperties: type: string ListOrderResponseDTO: type: object properties: clientId: type: string orderId: type: string merchantId: type: string openedTime: type: string closedTime: type: string orderType: type: string enum: - DELIVERY - PICKUP - DINEIN status: type: string enum: - OPEN - CLOSED - CANCELED - SYNC_PENDING ListOrderHistoryResponseDTO: type: object properties: orderId: type: string clientId: type: string merchantId: type: string locationId: type: string locationName: type: string extOrderId: type: string orderName: type: string orderNumber: type: string orderType: type: string enum: - DELIVERY - PICKUP - DINEIN customer: $ref: '#/components/schemas/Customer' guestCount: type: integer format: int32 tableNumber: type: string delivery: $ref: '#/components/schemas/Delivery' openedTime: type: string closedTime: type: string status: type: string enum: - OPEN - CLOSED - CANCELED - SYNC_PENDING orderFulfillTime: type: string revenueCenter: type: string createdDate: type: string updatedDate: type: string orderItems: uniqueItems: true type: array items: $ref: '#/components/schemas/OrderItem' orderDiscounts: type: array items: $ref: '#/components/schemas/OrderDiscount' additionalAttributes: type: object additionalProperties: type: string checks: type: array items: $ref: '#/components/schemas/Check' orderTotal: $ref: '#/components/schemas/OrderTotal' orderSource: type: string enum: - APP - WEB - POS - KIOSK - GOOGLE_ORDERING orderOptionName: type: string orderOptionInstructions: type: string orderOptionInformation: type: string orderOptionUserResponse: type: string displayImHereButton: type: boolean imHere: type: boolean trackingUrl: type: string orderInstructions: type: string deliveryInstructions: type: string OrderHistoryResponseWithPagingDTO: type: object properties: orders: type: array items: $ref: '#/components/schemas/ListOrderHistoryResponseDTO' paging: $ref: '#/components/schemas/PagingDto' GetOfferResponseDTO: type: object properties: offerId: type: string campaignId: type: string programId: type: string title: type: string offerType: type: string enum: - Basket - Brand - Category - SKU numOffersToDistribute: type: integer format: int64 numOffersInInventory: type: integer format: int64 externalId: type: string priority: type: integer format: int32 redemptionStartDate: type: string redemptionEndDate: type: string distributionStartDate: type: string distributionEndDate: type: string distributionMode: type: string enum: - AUTO - MANUAL - ACTIVITY - PURCHASE_ACTIVITY - POINTS_ACTIVITY displayInfo: type: array items: $ref: '#/components/schemas/DisplayInfo' merchantId: type: string codeType: type: string enum: - FIXED - VARIABLE codeFormat: type: string offerCode: type: string distributionRuleSet: type: string redemptionRuleSet: type: string createdDate: type: string updatedDate: type: string isLoyaltyOffer: type: boolean offerRedemptionExpired: type: boolean MyGiftCardResponseDTO: type: object properties: clientId: type: string userId: type: string cardIdentifier: type: string securityCode: type: string cardAccountBalance: type: number format: double cardStatus: type: string enum: - ACTIVE - INACTIVE cardType: type: string image: type: string token: type: string paymentInstrumentId: type: string default: type: boolean MessageDTO: type: object properties: merchantId: type: string programId: type: string campaignId: type: string messageId: type: string title: type: string createdDate: type: string updatedDate: type: string noDistributed: type: integer format: int64 messageDisplayInfo: type: array items: $ref: '#/components/schemas/MessageDisplayInfoDTO' surveyId: type: string deleted: type: boolean MessageDisplayInfoDTO: type: object properties: languageCode: type: string title: type: string shortDescription: type: string longDescription: type: string smallImage: type: string mediumImage: type: string LoyaltyPointsSummaryDTO: type: object properties: clientId: type: string totalOriginalpoints: type: integer format: int32 totalRemainingpoints: type: integer format: int32 timeSummarized: type: string TierDetailsDTO: type: object properties: name: type: string lowerBoundary: type: number format: double upperBoundary: type: number format: double ViewLoyaltyAccountResponseDTO: type: object properties: loyaltyAccountId: type: string loyaltyTierId: type: string externalId: type: string loyaltyCardId: type: string confirmedPoints: type: integer format: int32 pendingPoints: type: integer format: int32 confirmedBalance: type: number format: float pendingBalance: type: number format: float createdDate: type: string currentLoyaltyTier: $ref: '#/components/schemas/TierDetailsDTO' nextLoyaltyTier: $ref: '#/components/schemas/TierDetailsDTO' numOfTypeRequiredForNextTier: type: number format: double tierBasedOnType: type: string currentLoyaltyTierBasedValue: type: number format: double createdDateString: type: string format: date-time NextExpiringLoyaltyPointsResponseDTO: type: object properties: nextExpiringPoints: type: integer format: int32 expiryDate: type: string ExpiringLoyaltyPointsResponseDTO: type: object properties: paging: $ref: '#/components/schemas/ResultsPagingDTO' expiringLoyaltyPoints: type: array items: $ref: '#/components/schemas/LoyaltyTransactionDTO' LoyaltyTransactionDTO: type: object properties: id: type: string clientId: type: string loyaltyTransactionStatus: type: string enum: - PENDING - CONFIRMED - EXPIRED transactionType: type: string enum: - AWARD - SPEND - RETURN_SPEND - RETURN_AWARD - PARTIAL_RETURN description: type: string originalPoints: type: integer format: int32 currentPoints: type: integer format: int32 transactionDate: type: string offerId: type: string offerTitle: type: string loyaltyAccountId: type: string loyaltyTransactionId: type: string externalTransactionId: type: string status: type: string enum: - PENDING - CONFIRMED - EXPIRED confirmationDate: type: string expiryDate: type: string FindLoyaltyHistoryResponseDTO: type: object properties: paging: $ref: '#/components/schemas/ResultsPagingDTO' loyaltyHistories: type: array items: $ref: '#/components/schemas/LoyaltyTransactionDTO' LocationDTO: type: object properties: storeId: type: string merchantId: type: string title: type: string address: $ref: '#/components/schemas/AddressDTO' phoneNumber: type: string shortDescription: type: string longDescription: type: string regionId: type: string storeCode: type: string latitude: type: number format: double longitude: type: number format: double storeType: type: string beaconId: type: string beaconName: type: string smallImage: type: string mediumImage: type: string pickupOrdersAccepted: type: boolean deliveryOrdersAccepted: type: boolean pickupOrderHours: uniqueItems: true type: array items: $ref: '#/components/schemas/WorkingHours' deliveryOrderHours: uniqueItems: true type: array items: $ref: '#/components/schemas/WorkingHours' pickupTemporaryHours: type: array items: $ref: '#/components/schemas/TemporaryHours' deliveryTemporaryHours: type: array items: $ref: '#/components/schemas/TemporaryHours' deliveryOffDays: type: array items: type: string format: date pickupOffDays: type: array items: type: string format: date deliveryAvailabilityInterval: type: integer format: int32 pickupAvailabilityInterval: type: integer format: int32 deliveryProcessingTime: type: integer format: int64 pickupProcessingTime: type: integer format: int64 showPickupTimeSlots: type: boolean showDeliveryTimeSlots: type: boolean pickupAsapSupported: type: boolean pickupSevenPlusDaysOrdering: type: boolean pickupMaxDaysOut: type: integer format: int32 pickupMaxOrderingDate: type: string format: date deliveryAsapSupported: type: boolean deliverySevenPlusDaysOrdering: type: boolean deliveryMaxDaysOut: type: integer format: int32 deliveryMaxOrderingDate: type: string format: date displayInfo: uniqueItems: true type: array items: $ref: '#/components/schemas/StoreDisplayInfo' externalOrderingEnabled: type: boolean externalOrderingText: type: string pickupOrderValueLimits: $ref: '#/components/schemas/OrderValueLimits' deliveryOrderValueLimits: $ref: '#/components/schemas/OrderValueLimits' pickupOrderOptions: uniqueItems: true type: array items: $ref: '#/components/schemas/OrderOptionsDTO' deliveryOrderOptions: uniqueItems: true type: array items: $ref: '#/components/schemas/OrderOptionsDTO' timeZone: type: string withInDeliveryRadius: type: boolean currencyCode: type: string disableTipping: type: boolean viewOnlyLocationEnabled: type: boolean OrderOptionsDTO: type: object properties: optionName: type: string displayRank: type: integer format: int32 title: type: string informationField: type: string errorMessageIfInformationFieldIsEmpty: type: string instructions: type: string OrderValueDisplayInfoDTO: type: object properties: langCode: type: string shortMessage: type: string longMessage: type: string OrderValueLimits: type: object properties: minOrderValue: type: number format: double maxOrderValue: type: number format: double displayMessage: type: array items: $ref: '#/components/schemas/OrderValueDisplayInfoDTO' TemporaryHours: type: object properties: startDate: type: string endDate: type: string sameHoursPerDate: $ref: '#/components/schemas/WorkingHours' diffHoursPerDate: type: object additionalProperties: $ref: '#/components/schemas/WorkingHours' TimeSlot: type: object properties: startTime: $ref: '#/components/schemas/LocalTime' endTime: $ref: '#/components/schemas/LocalTime' WorkingHours: type: object properties: dayOfWeek: type: string enum: - MONDAY - TUESDAY - WEDNESDAY - THURSDAY - FRIDAY - SATURDAY - SUNDAY startTime: $ref: '#/components/schemas/LocalTime' endTime: $ref: '#/components/schemas/LocalTime' timeSlots: type: array items: $ref: '#/components/schemas/TimeSlot' FindLocationResponseDTO: type: object properties: paging: $ref: '#/components/schemas/PagingDTO' stores: type: array items: $ref: '#/components/schemas/LocationDTO' Discount: type: object properties: discountId: type: string extDiscountId: type: string description: type: string discountType: type: string enum: - ITEM - ORDER discountValueType: type: string enum: - AMOUNT - PERCENTAGE amount: type: number format: float percentage: type: number format: float OptionGroupSettingDTO: type: object properties: optionGroupId: type: string inheritGroupSettings: type: boolean defaultSelectedItemIds: uniqueItems: true type: array items: type: string mandatoryItemIds: uniqueItems: true type: array items: type: string selectionMandatory: type: boolean selectionType: type: string enum: - MULTI_SELECT - SINGLE_SELECT maxItemSelections: type: integer format: int32 minItemSelections: type: integer format: int32 applicableOrderTypes: type: array items: type: string enum: - DELIVERY - PICKUP - DINEIN ViewGroupMobileDTO: required: - title type: object properties: title: type: string externalId: type: string createdDate: type: string updatedDate: type: string startDate: type: string endDate: type: string displayRank: type: integer format: int32 displayInfo: type: array items: $ref: '#/components/schemas/DisplayInfo' status: type: string applicableOrderTypes: type: array items: type: string enum: - DELIVERY - PICKUP - DINEIN extendedAttributes: type: object additionalProperties: type: string groupId: type: string groupType: type: string enum: - CATALOG_GROUP - OPTION_GROUP items: type: array items: $ref: '#/components/schemas/ViewItemMobileDTO' itemIds: type: array items: type: string defaultSelectedItems: type: array items: type: string mandatoryItems: type: array items: type: string optionGroupIds: type: array items: type: string optionGroupSetting: $ref: '#/components/schemas/OptionGroupSettingDTO' subGroupIds: type: array items: type: string selectionMandatory: type: boolean selectionType: type: string enum: - MULTI_SELECT - SINGLE_SELECT inheritParentOptions: type: boolean maxItemSelections: type: integer format: int32 minItemSelections: type: integer format: int32 ViewItemMobileDTO: required: - title type: object properties: title: type: string externalId: type: string createdDate: type: string updatedDate: type: string startDate: type: string endDate: type: string displayRank: type: integer format: int32 displayInfo: type: array items: $ref: '#/components/schemas/DisplayInfo' status: type: string applicableOrderTypes: type: array items: type: string enum: - DELIVERY - PICKUP - DINEIN extendedAttributes: type: object additionalProperties: type: string itemId: type: string price: type: integer format: int32 discounts: type: array items: $ref: '#/components/schemas/Discount' optionGroups: type: array items: $ref: '#/components/schemas/ViewGroupMobileDTO' optionGroupIds: type: array items: type: string uom: type: string sku: type: string upc: type: string brandId: type: string categoryId: type: string maxItemSelections: type: integer format: int32 inheritParentOptions: type: boolean orderingChannels: type: array items: type: string enum: - MOBILE - FACEBOOK - NONE GiftCardTransactionResponseDTO: type: object properties: transactionType: type: string cardIdentifier: type: string securityCode: type: string cardAccountBalance: type: number format: double transactionValue: type: number format: double cardStatus: type: string enum: - ACTIVE - INACTIVE paymentStatus: type: string transactionStatus: type: string rootErrors: type: object additionalProperties: type: string extendedAttributes: type: object additionalProperties: type: string GiftCardLookupResponse: type: object properties: clientId: type: string cardIdentifier: type: string securityCode: type: string cardAccountBalance: type: number format: double cardStatus: type: string enum: - ACTIVE - INACTIVE token: type: string SecureGiftCardLookupResponse: type: object properties: maskedCardIdentifier: type: string securityCodeEnabled: type: boolean cardAccountBalance: type: number format: double cardStatus: type: string enum: - ACTIVE - INACTIVE ExternalLinkDTO: type: object properties: id: type: string name: type: string clientId: type: string locationId: type: string type: type: string displayInfo: uniqueItems: true type: array items: $ref: '#/components/schemas/ExternalLinkDisplayInfoDTO' ExternalLinkDisplayInfoDTO: type: object properties: languageCode: type: string title: type: string image: type: string url: type: string format: url ExternalLinksResponseDTO: type: object properties: externalLinks: type: array items: $ref: '#/components/schemas/ExternalLinkDTO' DynamicEnvDTO: type: object properties: environmentName: type: string baseUrl: type: string environmentDescription: type: string DistributedOfferDTO: type: object properties: distributedOfferId: type: string offerId: type: string clientId: type: string merchantId: type: string offerCode: type: string codeFormat: type: string languageCode: type: string title: type: string shortDescription: type: string longDescription: type: string smallImage: type: string mediumImage: type: string status: type: string enum: - NEW - SAVED - READ - EXPIRED - DELETED - SYSTEM_REDEEMED - USER_REDEEMED redemptionEndDate: type: string distributedDate: type: string updatedDate: type: string redeemType: type: string purchaseTypes: uniqueItems: true type: array items: type: string eligible: type: boolean pointsCost: type: integer format: int32 loyaltyOffer: type: boolean DistributedMessageDTO: type: object properties: distributedMessageId: type: string merchantId: type: string messageId: type: string languageCode: type: string title: type: string shortDescription: type: string longDescription: type: string smallImage: type: string mediumImage: type: string status: type: string enum: - NEW - READ - EXPIRED - DELETED messageType: type: string enum: - PRIVATE - SHAREABLE - REFERRAL - SURVEY shareTitle: type: string shareSentence: type: string shareShortDesc: type: string shareURL: type: string distributedDate: type: string updatedDate: type: string GetUserDevicesResponseDTO: type: object properties: deviceList: type: array items: $ref: '#/components/schemas/UserDeviceDTO' UserDeviceDTO: type: object properties: deviceUniqueId: type: string deviceId: type: string deviceType: type: string dateOfAdded: type: string ListDeliveryAddressResponseDTO: type: object properties: id: type: string deliveryAddressList: type: array items: $ref: '#/components/schemas/AddressDTO' APNSetting: type: object properties: keyId: type: string teamId: type: string bundleId: type: string signingKeyFile: type: string environment: type: string androidPnApiKey: type: string firebaseProjectId: type: string firebasePrivateKeyId: type: string firebasePrivateKey: type: string firebaseClientEmail: type: string firebaseClientId: type: string firebaseClientCertUrl: type: string AndroidSettings: type: object properties: packageName: type: string fingerPrint1: type: string fingerPrint2: type: string fingerPrint3: type: string assetLinksFileUrl: type: string ApiKeyInfo: type: object properties: id: type: string api_key: type: string api_key_id: type: string name: type: string scopes: type: array items: type: string encrypted-api_key: type: string CheckoutTipConfigs: type: object properties: headerEnabled: type: boolean headerTitle: type: string subTitleEnabled: type: boolean deliverySubTitle: type: string pickupSubTitle: type: string ClientConfig: type: object properties: dateCreated: type: string format: date-time dateUpdated: type: string format: date-time apnSetting: $ref: '#/components/schemas/APNSetting' giftCard: $ref: '#/components/schemas/GiftCard' guestCheckoutVerification: $ref: '#/components/schemas/GuestCheckoutVerification' guestJourney: $ref: '#/components/schemas/GuestJourney' loyaltyNumberStrategy: $ref: '#/components/schemas/LoyaltyNumberStrategy' loyaltyProvider: $ref: '#/components/schemas/LoyaltyProvider' mobileAppVersion: $ref: '#/components/schemas/MobileAppVersion' passwordlessAuthentication: $ref: '#/components/schemas/PasswordlessAuthentication' recaptcha: type: boolean silverwareExtLoyaltyIdStrategy: $ref: '#/components/schemas/SilverwareExtLoyaltyIdStrategy' sms: $ref: '#/components/schemas/Sms' socialSignIn: $ref: '#/components/schemas/SocialSignIn' toastApplePay: $ref: '#/components/schemas/ToastApplePay' userAccountVerification: $ref: '#/components/schemas/UserAccountVerification' workspaces: $ref: '#/components/schemas/Workspace' clientId: type: string downloadCustomerListEnabled: type: boolean emailSetting: $ref: '#/components/schemas/EmailSetting' enableFulFillText: type: boolean guestCheckOutEnabled: type: boolean incentivioPayments: $ref: '#/components/schemas/IncentivioPayments' scanToPay: $ref: '#/components/schemas/ScanToPay' viewOnlyLocationEnabled: type: boolean webhook: $ref: '#/components/schemas/Webhook' upsellRecommendation: $ref: '#/components/schemas/UpsellRecommendation' domainInfos: type: array items: $ref: '#/components/schemas/DomainInfo' apiKeyInfos: type: array items: $ref: '#/components/schemas/ApiKeyInfo' Colors: type: object properties: primaryColor: type: string secondaryColor: type: string tertiaryColor: type: string headerBgColor: type: string bgColor: type: string tintColor: type: string shadeColor: type: string accentColor: type: string activeBreadcrumbColor: type: string inactiveBreadcrumbColor: type: string cardColor: type: string hoverColor: type: string inactiveButton: type: string CustomCatalog: type: object properties: isActive: type: boolean isOrderingEnabled: type: boolean customCatalogTitle: type: array items: type: string defaultLocation: type: string defaultMerchant: type: string buttonName: type: array items: type: string DateOfBirth: type: object properties: enabled: type: boolean required: type: boolean DefaultOrderType: type: object properties: active: type: boolean orderType: type: string enum: - CATERING - DELIVERY - PICKUP DisplayLoyaltyPointsExpiration: type: object properties: enabled: type: boolean noOfDays: type: integer format: int32 displayModal: type: boolean DomainAuthenticateDnsResDto: type: object properties: valid: type: string type: type: string host: type: string data: type: string DomainInfo: type: object properties: subdomain: type: string domain: type: string username: type: string ips: type: array items: type: string legacy: type: boolean valid: type: boolean clientSpecific: type: boolean subusers: type: array items: $ref: '#/components/schemas/SubUserAccountHandleResDto' dns: type: object additionalProperties: $ref: '#/components/schemas/DomainAuthenticateDnsResDto' id: type: string active: type: boolean user_id: type: string custom_spf: type: boolean default: type: boolean automatic_security: type: boolean last_validation_attempt_at: type: boolean EmailSetting: type: object properties: emailHandler: type: string enum: - AWS - SENDGRID clientSendgridApiKey: type: string activeFromEmailDomain: type: string fromEmail: type: string dynamicEmailTemplateEnabled: type: boolean fromEmailedName: type: string replyTo: type: string replyToName: type: string sendGridSubUserInfo: $ref: '#/components/schemas/SendGridSubUserInfo' Fonts: type: object properties: primaryFont: $ref: '#/components/schemas/PrimaryFont' secondaryFont: $ref: '#/components/schemas/SecondaryFont' tertiaryFont: $ref: '#/components/schemas/TertiaryFont' quaternaryFont: $ref: '#/components/schemas/QuaternaryFont' GiftCard: type: object properties: isActive: type: boolean sendByEmailIsActive: type: boolean giftCardTitle: type: array items: type: string defaultLocation: type: string cardDetails: type: array items: type: string walletOrder: type: array items: type: string defaultMerchant: type: string minAmount: type: string maxAmount: type: string selectableAmount: type: array items: type: string giftCardHeader: type: array items: type: string hideQrCode: type: boolean purchaseNewGiftCard: type: boolean addGiftCardToWallet: type: boolean reloadGiftCard: type: boolean purchaseWithGiftCard: type: boolean giftCardLookUp: type: boolean securityCodeEnabled: type: boolean guestPurchaseEnabled: type: boolean guestAddGiftCardEnabled: type: boolean GuestCheckoutVerification: type: object properties: enabled: type: boolean deliveryMethod: type: string enum: - SMS - EMAIL GuestJourney: type: object properties: enabled: type: boolean enabledMenuIntelligence: type: boolean Images: type: object properties: logo: type: string bgImage: type: string defaultGroupImage: type: string mapPin: type: string favicon: type: string IncentivioPayments: type: object properties: enabled: type: boolean processingRate: type: string paymentFee: type: integer format: int32 IosSettings: type: object properties: teamId: type: string bundleId: type: string appleAppSiteAssociationFileUrl: type: string IpPoolsResDto: type: object properties: ip: type: string poolNames: type: array items: type: string ItemModifiers: type: object properties: itemModifierStyle: type: string disableAutoExpandedListStyleModifier: type: boolean hideItemModifiersTitle: type: boolean itemModifierMandatorySelectionAlertTitle: type: string autoExpandTileStyleNestedModifier: type: boolean autoExpandMoreCustomizations: type: boolean Loyalty: type: object properties: loyaltyType: type: string loyaltyPointNameSingular: type: string loyaltyPointNamePlural: type: string loyaltyPointsDivisor: type: integer format: int32 loyaltyPointImgs: type: array items: type: string loyaltyLogo: type: string loyaltyHeaderRectangle1: type: string loyaltyHeaderRectangle2: type: string loyaltyText: type: array items: type: string loyaltyButtonColor: type: string loyaltyHeadingColor: type: string loyaltyTextColor: type: string loyaltyHeader: type: array items: type: string loyaltyButtons: $ref: '#/components/schemas/LoyaltyButtons' loyaltyPointTermSingular: type: array items: type: string loyaltyPointTermPlural: type: array items: type: string loyaltyScreenType: type: string rewardsDescriptionURL: type: string loyaltyPointTerminology: type: string loyaltyPointsTerminology: type: string hideLoyaltyScreenOfferDisplayTitleLabel: type: boolean displayAvailableOffersCountLoyaltyScreen: type: boolean displayLoyaltyPointsExpiration: $ref: '#/components/schemas/DisplayLoyaltyPointsExpiration' loyaltyWheelConfigs: $ref: '#/components/schemas/LoyaltyWheelConfigs' loyaltyPunchConfigs: $ref: '#/components/schemas/LoyaltyPunchConfigs' loyaltyCardDisplayTitle: type: string LoyaltyButtons: type: object properties: button1: type: array items: type: string button2: type: array items: type: string LoyaltyNumberStrategy: type: object properties: strategy: type: string accountNoPrefix: type: string accountNoPostfixStartFrom: type: integer format: int64 accountNoPostfixDigitCount: type: integer format: int64 LoyaltyProvider: type: object properties: enabled: type: boolean type: type: string enum: - INCENTIVIO - SQUARE LoyaltyPunchConfigs: type: object properties: fullPunchImageUrl: type: string halfPunchImageUrl: type: string punchesToPointsRatio: type: integer format: int32 LoyaltyWheelConfigs: type: object properties: hideLoyaltyScreenConfettiAnimation: type: boolean forceConfettiAnimationOnEachTier: type: boolean loyaltyMileStoneValues: type: array items: type: integer format: int32 shouldDisplayCustomLoyaltyTierDetailButton: type: boolean customLoyaltyTierDetailButtonTitle: type: string pointUntilNextRewardDescriptionLabel: type: string pointsUntilNextRewardDescriptionLabel: type: string loyaltyTierDescriptions: type: array items: type: string MagicLinkSettings: type: object properties: android: $ref: '#/components/schemas/AndroidSettings' ios: $ref: '#/components/schemas/IosSettings' baseUrl: type: string MenuLogos: type: object properties: home: type: array items: type: string loyalty: type: array items: type: string settings: type: array items: type: string pastOrders: type: array items: type: string signOut: type: array items: type: string inbox: type: array items: type: string catering: type: array items: type: string enterCode: type: array items: type: string easyOrder: type: array items: type: string giftCard: type: array items: type: string loyaltyCard: type: array items: type: string customCatalog: type: array items: type: string MobileAppVersion: type: object properties: requiredVersion: $ref: '#/components/schemas/RequiredMobileAppVersion' recommendedVersion: $ref: '#/components/schemas/RecommendedMobileAppVersion' OrderDetails: type: object properties: orderType: type: string total: type: string text: type: array items: type: string OrderHistory: type: object properties: hideOrderHistoryReorderButton: type: boolean hideOrderHistoryCallButton: type: boolean hideOrderHistoryItemImage: type: boolean orderHistoryItemImageAspectRatio: type: string orderHistoryEmailButton: $ref: '#/components/schemas/OrderHistoryEmailButton' orderHistoryExternalButton: $ref: '#/components/schemas/OrderHistoryExternalButton' OrderHistoryEmailButton: type: object properties: displayEmailButtonOnOrderHistory: type: boolean orderHistoryContactEmail: type: string orderHistoryContactEmailSubject: type: string includeOrderNumberInSubject: type: boolean includeOrderDateInSubject: type: boolean includeLocationInSubject: type: boolean includeOrderIdInSubject: type: boolean includePaymentCardLastFourDigits: type: boolean OrderHistoryExternalButton: type: object properties: displayExternalContactUsButtonOnOrderHistory: type: boolean orderHistoryContactURL: type: string OrderTypeLabels: type: object properties: pickup: type: object additionalProperties: type: string delivery: type: object additionalProperties: type: string catering: type: object additionalProperties: type: string PageUrl: type: object properties: title: type: array items: type: string url: type: string image: type: string PasswordlessAuthentication: type: object properties: enabled: type: boolean deliveryMethod: type: array items: type: string enum: - SMS - EMAIL magicLinkSettings: $ref: '#/components/schemas/MagicLinkSettings' PreferenceInfo: type: object properties: preferenceName: type: object additionalProperties: type: string values: type: object additionalProperties: type: array items: type: string infoText: type: object additionalProperties: type: string multiSelectOption: type: boolean PrimaryFont: type: object properties: fontFamily: type: string fontSize: type: string fontColor: type: string QuaternaryFont: type: object properties: fontFamily: type: string fontSize: type: string fontColor: type: string RecaptchaDto: type: object properties: isActive: type: boolean enableFor: $ref: '#/components/schemas/RecaptchaEnableForDto' keyId: type: string RecaptchaEnableForDto: type: object properties: login: type: boolean createAccount: type: boolean payment: type: boolean addGiftCard: type: boolean RecommendedMobileAppVersion: type: object properties: androidVersion: type: object additionalProperties: type: boolean iosVersion: type: object additionalProperties: type: boolean RequiredMobileAppVersion: type: object properties: androidVersion: type: object additionalProperties: type: boolean iosVersion: type: object additionalProperties: type: boolean ScanToPay: type: object properties: enabled: type: boolean tippingEnabled: type: boolean tipValues: type: array items: type: string defaultTip: type: string tipHeader: type: object additionalProperties: type: string displayTransactionsHistoryScreen: type: boolean displayCombinedOrderHistoryScreen: type: boolean displayScanToPayDummyCardView: type: boolean disableScanToPayHeadsUpPopupView: type: boolean disableScanToPayOffers: type: boolean scanToPayPreloadCardName: type: string scanToPayRewardsCardDescriptionText: type: string scanToPayCustomDummyCardDisplayTitle: type: string scanToPayRefillPromptHeader: type: string scanToPayRefillPromptMessage: type: string scanToPayRefillPresetAmounts: type: array items: type: string scanToPayRefillPromptAmount: type: string SecondaryFont: type: object properties: fontFamily: type: string fontSize: type: string fontColor: type: string Segment: type: object properties: workspaceId: type: string SendGridSubUserInfo: type: object properties: subUserInfo: $ref: '#/components/schemas/SubUserAccountHandleResDto' apiKeyInfos: type: array items: $ref: '#/components/schemas/ApiKeyInfo' domainInfos: type: array items: $ref: '#/components/schemas/DomainInfo' webhookInfos: type: array items: $ref: '#/components/schemas/WebhookInfo' SignUp: type: object properties: dateOfBirth: $ref: '#/components/schemas/DateOfBirth' signUpNotification: $ref: '#/components/schemas/SignUpNotification' enableLegacyUserAccessAccountFlow: type: boolean SignUpNotification: type: object properties: signUpAndLoyaltyExpiryBannerTextColor: type: string signUpAndLoyaltyExpiryBannerButtonTextColor: type: string signUpAndLoyaltyExpiryBannerButtonBackgroundColor: type: string signUpAndLoyaltyExpiryBannerBackgroundColor: type: string signUpAndLoyaltyExpiryBannerInfoIconColor: type: string signUpAndLoyaltyExpiryBannerDismissIconColor: type: string userLoyaltyPointsExpiringSoonTitle: type: string userLoyaltyPointsExpiringSoonMessage: type: string signUpNotificationBannerMessageText: type: string shouldUsePrimaryFontOnSignUpAndLoyaltyExpiryBanner: type: boolean SilverwareExtLoyaltyIdStrategy: type: object properties: appVersion: type: string loyaltyApiMerchantId: type: string loyaltyApiMerchantCred: type: string orderSubmissionCredential: type: string clientPrefix: type: string cardTypePrefix: type: string Sms: type: object properties: enabled: type: boolean deprecated: true enabledAccountVerification: type: boolean enabledMarketing: type: boolean enabledOrdering: type: boolean twilioMessageServiceSid: type: string twilioPassword: type: string twilioPhoneNumber: type: string twilioUsername: type: string SocialSignIn: type: object properties: appleClientId: type: string enabled: type: boolean googleClientId: type: string googleClientSecret: type: string SubUserAccountHandleResDto: type: object properties: username: type: string email: type: string region: type: string ipDetails: type: array items: $ref: '#/components/schemas/IpPoolsResDto' user_id: type: string credit_allocation: $ref: '#/components/schemas/SubUserCreditAllocationRepDto' SubUserCreditAllocationRepDto: type: object properties: type: type: string TertiaryFont: type: object properties: fontFamily: type: string fontSize: type: string fontColor: type: string TipConfiguration: type: object properties: values: type: array items: type: integer format: int32 defaultTip: type: integer format: int32 TipPercentages: type: object properties: pickup: $ref: '#/components/schemas/TipConfiguration' delivery: $ref: '#/components/schemas/TipConfiguration' ToastApplePay: type: object properties: id: type: string integrationIdentifier: type: string UpsellRecommendation: type: object properties: enabled: type: boolean UserAccountVerification: type: object properties: method: type: string enum: - EMAIL_CODE - EMAIL_LINK - SMS_CODE - SMS_LINK WOv2: type: object properties: enabled: type: boolean WebAppConfigDTO: type: object properties: clientId: type: string locationId: type: string merchantId: type: string images: $ref: '#/components/schemas/Images' colors: $ref: '#/components/schemas/Colors' fonts: $ref: '#/components/schemas/Fonts' showOrderNumber: type: boolean showOrderInstructions: type: boolean showItemInstructions: type: boolean paymentGatewayName: type: string loyaltyOn: type: boolean onOffWallet: type: boolean customizationTexts: type: array items: type: string customizationChars: type: integer format: int32 aptSuiteMand: type: boolean isTipDisplay: type: boolean languagesSupported: type: array items: type: string isGuestCheckoutEnabled: type: boolean deliveryInstructions: type: boolean customizedLoyalty: type: boolean loyaltyLabel: type: array items: type: string customizedConfirmation: type: boolean confirmDelivery: type: array items: type: string confirmDeliveryNoNum: type: array items: type: string confirmPickUp: type: array items: type: string confirmPickUpNoNum: type: array items: type: string isFutureDates: type: boolean getgAPI: type: string menuLogos: $ref: '#/components/schemas/MenuLogos' inbox: type: boolean fbAppId: type: string catering: type: boolean isLoyaltyCard: type: boolean loyaltyCardTitle: type: array items: type: string loyaltyCardCodeType: type: string isEnterCode: type: boolean loyalty: $ref: '#/components/schemas/Loyalty' clientName: type: string isEasyOrder: type: boolean easyOrderLabel: type: array items: type: string unreadMessageColor: type: string messageButtonColor: type: string messageCountColor: type: string editLoyaltyLabel: type: array items: type: string editLoyaltyOn: type: boolean hideQtyPicker: type: boolean isAVSEnabled: type: boolean showTimeBasedCatalogs: type: boolean catalogShowTime: type: number format: float itemInstructionsLabel: type: array items: type: string itemInstructionsWatermarkText: type: array items: type: string itemInstructionsAdditionalText1: type: array items: type: string showDineIn: type: boolean hideCateringMinMaxShortMessage: type: boolean isLoyaltyCustomer: type: boolean loyaltyCustomerTitle: type: array items: type: string orderDetails: $ref: '#/components/schemas/OrderDetails' giftCard: $ref: '#/components/schemas/GiftCard' customCatalog: $ref: '#/components/schemas/CustomCatalog' webUrls: $ref: '#/components/schemas/WebUrls' hideCustomization: type: boolean deliveryExternalLinksEnabled: type: boolean defaultSelectedDineIn: type: string showDineInConfigs: type: object additionalProperties: type: string orderHistoryTitle: type: object additionalProperties: type: string showOrderHistoryTitleInHomePage: type: boolean geoCodingTypes: type: object additionalProperties: type: integer format: int32 geoCodingType: type: integer format: int32 recommendationsEnabled: type: boolean uxAnalyticsEnabled: type: boolean beaconDetectionEnabled: type: boolean wov2: $ref: '#/components/schemas/WOv2' orderTypeLabels: $ref: '#/components/schemas/OrderTypeLabels' tipPercentages: $ref: '#/components/schemas/TipPercentages' signUp: $ref: '#/components/schemas/SignUp' segment: $ref: '#/components/schemas/Segment' signUpPreferenceDisabled: type: boolean signUpPreferenceInfo: type: object additionalProperties: type: array items: $ref: '#/components/schemas/PreferenceInfo' clientConfig: $ref: '#/components/schemas/ClientConfig' recaptcha: $ref: '#/components/schemas/RecaptchaDto' hideLoyaltyScanCode: type: boolean defaultOrderType: $ref: '#/components/schemas/DefaultOrderType' loyaltySegmentBadgesEnabled: type: boolean isClarityEnabled: type: boolean startOrderingFromNearestLocation: type: boolean hideHomeScreenOffersSlider: type: boolean displayHomeScreenOffersSliderPagingControl: type: boolean primaryAppThemeColor: type: string secondaryAppThemeColor: type: string itemModifiers: $ref: '#/components/schemas/ItemModifiers' orderHistory: $ref: '#/components/schemas/OrderHistory' checkoutTipConfigs: $ref: '#/components/schemas/CheckoutTipConfigs' forceUserToSelectOrderType: type: boolean WebUrls: type: object properties: mainUrl: $ref: '#/components/schemas/PageUrl' fb: $ref: '#/components/schemas/PageUrl' tw: $ref: '#/components/schemas/PageUrl' ig: $ref: '#/components/schemas/PageUrl' Webhook: type: object properties: menuUpdated: type: boolean WebhookInfo: type: object properties: enabled: type: boolean url: type: string delivered: type: boolean bounce: type: boolean deferred: type: boolean unsubscribe: type: boolean processed: type: boolean open: type: boolean click: type: boolean dropped: type: boolean id: type: string group_resubscribe: type: boolean group_unsubscribe: type: boolean spam_report: type: boolean friendly_name: type: string oauth_client_id: type: string oauth_token_url: type: string created_date: type: string updated_date: type: string Workspace: type: object properties: enabled: type: boolean FindClientResponseDTO: type: object properties: clientId: type: string alias: type: string address: $ref: '#/components/schemas/AddressDTO' title: type: string shortDescription: type: string longDescription: type: string logoImage: type: string format: byte medLogo: type: string format: byte ClientDomainDTO: type: object properties: id: type: string clientId: type: string domain: type: string status: type: string enum: - PENDING - ACTIVE - FAILED - DELETING currentStep: type: string enum: - VERIFY_CNAME - PROVISION_TENANT - ISSUE_CERT - UPDATE_DISTRIBUTION distributionId: type: string certificateArn: type: string failureReason: type: string stepFnExecutionArn: type: string stripeDomainId: type: string updatedDate: type: string format: date-time createdDate: type: string format: date-time dnsRecord: type: object additionalProperties: type: string ListCatalogMobileDTO: required: - title type: object properties: title: type: string externalId: type: string createdDate: type: string updatedDate: type: string startDate: type: string endDate: type: string displayRank: type: integer format: int32 displayInfo: type: array items: $ref: '#/components/schemas/DisplayInfo' status: type: string applicableOrderTypes: type: array items: type: string enum: - DELIVERY - PICKUP - DINEIN extendedAttributes: type: object additionalProperties: type: string catalogId: type: string storeIds: type: array items: type: string groups: type: array items: $ref: '#/components/schemas/ViewGroupMobileDTO' groupIds: type: array items: type: string AppOfferDTO: type: object properties: distributedOfferId: type: string offerId: type: string clientId: type: string merchantId: type: string offerCode: type: string codeFormat: type: string title: type: string shortDescription: type: string longDescription: type: string smallImage: type: string mediumImage: type: string status: type: string enum: - NEW - SAVED - READ - EXPIRED - DELETED - SYSTEM_REDEEMED - USER_REDEEMED redemptionEndDate: type: string distributedDate: type: string updatedDate: type: string redeemType: type: string purchaseTypes: uniqueItems: true type: array items: type: string isLoyaltyOffer: type: boolean pointsCost: type: integer format: int32 eligible: type: boolean universalOffer: type: boolean redemptionEndDateType: type: string AppOfferListDTO: type: object properties: offers: type: array items: $ref: '#/components/schemas/AppOfferDTO' paging: $ref: '#/components/schemas/PagingDto' AppOffersResponseDTO: type: object properties: offerList: $ref: '#/components/schemas/AppOfferListDTO' AppMessageDTO: type: object properties: distributedMessageId: type: string merchantId: type: string messageId: type: string languageCode: type: string title: type: string shortDescription: type: string longDescription: type: string smallImage: type: string mediumImage: type: string status: type: string enum: - NEW - READ - EXPIRED - DELETED distributedDate: type: string updatedDate: type: string messageType: type: string surveyId: type: string distributedEndDate: type: string AppMessageListDTO: type: object properties: messages: type: array items: $ref: '#/components/schemas/AppMessageDTO' paging: $ref: '#/components/schemas/PagingDto' AppContentResponseDTO: type: object properties: offerList: $ref: '#/components/schemas/AppOfferListDTO' messageList: $ref: '#/components/schemas/AppMessageListDTO' AppConfiguration: type: object properties: clientId: type: string themeConfiguration: $ref: '#/components/schemas/AppThemeConfiguration' loyaltyConfiguration: $ref: '#/components/schemas/LoyaltyConfiguration' offerConfiguration: $ref: '#/components/schemas/OfferConfiguration' orderConfiguration: $ref: '#/components/schemas/OrderConfiguration' giftCardConfiguration: $ref: '#/components/schemas/GiftCardConfiguration' webAppConfiguration: $ref: '#/components/schemas/WebAppConfiguration' resourceBundleLocation: type: array items: $ref: '#/components/schemas/Link' sideBarItems: type: array items: $ref: '#/components/schemas/MenuItem' bottomBarItems: type: array items: $ref: '#/components/schemas/MenuItem' AppThemeColorConfiguration: type: object properties: navigationBarColor: $ref: '#/components/schemas/Color' navigationBarTextColor: $ref: '#/components/schemas/Color' navigationBarButtonColor: $ref: '#/components/schemas/Color' segmentedBarColor: $ref: '#/components/schemas/Color' segmentedBarSelectedColor: $ref: '#/components/schemas/Color' segmentedBarTextColor: $ref: '#/components/schemas/Color' segmentedBarSelectedTextColor: $ref: '#/components/schemas/Color' tabBarColor: $ref: '#/components/schemas/Color' tabBarTextColor: $ref: '#/components/schemas/Color' sectionBarColor: $ref: '#/components/schemas/Color' sectionBarTextColor: $ref: '#/components/schemas/Color' primaryButtonColor: $ref: '#/components/schemas/Color' primaryButtonTextColor: $ref: '#/components/schemas/Color' primaryButtonBorderColor: $ref: '#/components/schemas/Color' secondaryButtonColor: $ref: '#/components/schemas/Color' secondaryButtonTextColor: $ref: '#/components/schemas/Color' secondaryButtonBorderColor: $ref: '#/components/schemas/Color' doneButtonColor: $ref: '#/components/schemas/Color' doneButtonTextColor: $ref: '#/components/schemas/Color' doneButtonBorderColor: $ref: '#/components/schemas/Color' inactiveButtonColor: $ref: '#/components/schemas/Color' landingPageButtonColor: $ref: '#/components/schemas/Color' landingPageButtonTextColor: $ref: '#/components/schemas/Color' landingPageButtonBorderColor: $ref: '#/components/schemas/Color' pageTitleTextColor: $ref: '#/components/schemas/Color' pageBodyTextColor: $ref: '#/components/schemas/Color' pageBackgroundColor: $ref: '#/components/schemas/Color' pageCardBackgroundColor: $ref: '#/components/schemas/Color' pageIconColor: $ref: '#/components/schemas/Color' headerTitleColor: $ref: '#/components/schemas/Color' instrucutionTextColor: $ref: '#/components/schemas/Color' cellTitleTextColor: $ref: '#/components/schemas/Color' cellDescriptionTextColor: $ref: '#/components/schemas/Color' hoverColor: $ref: '#/components/schemas/Color' activeBreadcrumbColor: $ref: '#/components/schemas/Color' inactiveBreadcrumbColor: $ref: '#/components/schemas/Color' messageBubbleColor: $ref: '#/components/schemas/Color' messageBubbleTextColor: $ref: '#/components/schemas/Color' unreadMessageColor: $ref: '#/components/schemas/Color' AppThemeConfiguration: type: object properties: colorConfiguration: $ref: '#/components/schemas/AppThemeColorConfiguration' fontConfiguration: $ref: '#/components/schemas/AppThemeFontConfiguration' imageConfiguration: $ref: '#/components/schemas/AppThemeImageConfiguration' AppThemeFontConfiguration: type: object properties: fonts: type: array items: $ref: '#/components/schemas/Font' navigationBarFont: $ref: '#/components/schemas/FontVariation' segmentedBarFont: $ref: '#/components/schemas/FontVariation' buttonFont: $ref: '#/components/schemas/FontVariation' pageTitleFont: $ref: '#/components/schemas/FontVariation' pageBodyTextFont: $ref: '#/components/schemas/FontVariation' cellTitleFont: $ref: '#/components/schemas/FontVariation' cellDetailFont: $ref: '#/components/schemas/FontVariation' headerTitleFont: $ref: '#/components/schemas/FontVariation' instructionTitleFont: $ref: '#/components/schemas/FontVariation' sideMenuFont: $ref: '#/components/schemas/FontVariation' sideMenuProfileFieldFont: $ref: '#/components/schemas/FontVariation' textFieldFont: $ref: '#/components/schemas/FontVariation' itemPriceFont: $ref: '#/components/schemas/FontVariation' AppThemeImageConfiguration: type: object properties: logo: type: array items: $ref: '#/components/schemas/Image' backgroundImages: type: array items: $ref: '#/components/schemas/Image' appImage: type: array items: $ref: '#/components/schemas/Image' mapImages: type: array items: $ref: '#/components/schemas/Image' Button: type: object properties: backgroundColor: $ref: '#/components/schemas/Color' selectedColor: $ref: '#/components/schemas/Color' borderColor: $ref: '#/components/schemas/Color' fontColor: $ref: '#/components/schemas/Color' font: $ref: '#/components/schemas/FontVariation' title: uniqueItems: true type: array items: $ref: '#/components/schemas/DisplayInfo' Color: type: object properties: red: type: number format: float green: type: number format: float blue: type: number format: float alpha: type: number format: float DefaultLocationConfiguration: type: object properties: isMenuBrowsingEnabled: type: boolean defaultLocationId: type: string defaultMerchantId: type: string navigationTitle: uniqueItems: true type: array items: $ref: '#/components/schemas/DisplayInfo' buttonTitle: uniqueItems: true type: array items: $ref: '#/components/schemas/DisplayInfo' EnterCodeScreenConfiguration: type: object properties: navigationTitle: uniqueItems: true type: array items: $ref: '#/components/schemas/DisplayInfo' headerTitle: uniqueItems: true type: array items: $ref: '#/components/schemas/DisplayInfo' instructionText: uniqueItems: true type: array items: $ref: '#/components/schemas/DisplayInfo' FindAppConfigurationResponseDTO: type: object properties: isConfigurationExists: type: boolean appConfiguration: $ref: '#/components/schemas/AppConfiguration' externalLinks: type: array items: $ref: '#/components/schemas/ExternalLinkDTO' Font: type: object properties: identifier: type: string fontName: type: string fontSubName: type: string resourceLocation: type: string format: url FontSize: type: object properties: fontSize: type: number format: float fontSizeType: type: string enum: - NONE - PX - EM - PERCENT supportedDevice: type: string enum: - IPHONE - ANDROID - WEB FontVariation: type: object properties: fontIdentifier: type: string style: type: string enum: - NONE - BOLD - ITALIC - UNDERLINE fontSize: type: array items: $ref: '#/components/schemas/FontSize' GiftCardConfiguration: type: object properties: hideBarCode: type: boolean hideLandingScreenButton: type: boolean landingScreenButtonStyle: $ref: '#/components/schemas/Button' giftCardTitle: uniqueItems: true type: array items: $ref: '#/components/schemas/DisplayInfo' giftCardIntroductionText: uniqueItems: true type: array items: $ref: '#/components/schemas/DisplayInfo' giftCardLocationId: type: string giftCardMerchantId: type: string giftCardMinAmount: type: number format: double giftCardMaxAmount: type: number format: double giftCardPresetAmounts: type: array items: type: number format: double Image: type: object properties: imageName: type: string accessibilityText: uniqueItems: true type: array items: $ref: '#/components/schemas/DisplayInfo' resourceLocation: type: string format: url supportedDevices: type: array items: type: string enum: - IPHONE - ANDROID - WEB ItemCustomizationScreenConfiguration: type: object properties: navigationTitle: uniqueItems: true type: array items: $ref: '#/components/schemas/DisplayInfo' headerTitle: uniqueItems: true type: array items: $ref: '#/components/schemas/DisplayInfo' instructionText: uniqueItems: true type: array items: $ref: '#/components/schemas/DisplayInfo' hideNoCustomizationButton: type: boolean hideSpecialInstructionField: type: boolean specialInstructionFieldMaxLenth: type: integer format: int32 specialInstructionLabelText: uniqueItems: true type: array items: $ref: '#/components/schemas/DisplayInfo' specialInstructionPlaceHolderText: uniqueItems: true type: array items: $ref: '#/components/schemas/DisplayInfo' specialInstructionFooterText: uniqueItems: true type: array items: $ref: '#/components/schemas/DisplayInfo' noCustomizationButtonTitle: uniqueItems: true type: array items: $ref: '#/components/schemas/DisplayInfo' moreCustomizationButtonTitle: uniqueItems: true type: array items: $ref: '#/components/schemas/DisplayInfo' moreCustomizationModalViewTitle: uniqueItems: true type: array items: $ref: '#/components/schemas/DisplayInfo' Link: type: object properties: title: uniqueItems: true type: array items: $ref: '#/components/schemas/DisplayInfo' url: type: string format: url image: $ref: '#/components/schemas/Image' supportedDevices: type: array items: type: string enum: - IPHONE - ANDROID - WEB LocationScreenConfiguration: type: object properties: navigationTitle: uniqueItems: true type: array items: $ref: '#/components/schemas/DisplayInfo' headerTitle: uniqueItems: true type: array items: $ref: '#/components/schemas/DisplayInfo' instructionText: uniqueItems: true type: array items: $ref: '#/components/schemas/DisplayInfo' orderingEnabledButtonText: uniqueItems: true type: array items: $ref: '#/components/schemas/DisplayInfo' orderingDisabledButtonText: uniqueItems: true type: array items: $ref: '#/components/schemas/DisplayInfo' hideCallButton: type: boolean hideMapButton: type: boolean hideShortDescription: type: boolean LoyaltyCardScreenConfiguration: type: object properties: navigationTitle: uniqueItems: true type: array items: $ref: '#/components/schemas/DisplayInfo' headerTitle: uniqueItems: true type: array items: $ref: '#/components/schemas/DisplayInfo' instructionText: uniqueItems: true type: array items: $ref: '#/components/schemas/DisplayInfo' barCodeType: type: string enum: - QR - CODE_39 - CODE_128 - UPC - EAN LoyaltyConfiguration: type: object properties: loyaltyScreenConfiguration: $ref: '#/components/schemas/LoyaltyScreenConfiguration' loyaltyCardScreenConfiguration: $ref: '#/components/schemas/LoyaltyCardScreenConfiguration' LoyaltyScreenConfiguration: type: object properties: navigationTitle: uniqueItems: true type: array items: $ref: '#/components/schemas/DisplayInfo' headerTitle: uniqueItems: true type: array items: $ref: '#/components/schemas/DisplayInfo' instructionText: uniqueItems: true type: array items: $ref: '#/components/schemas/DisplayInfo' loyaltyType: type: string enum: - DEFAULT - PUNCH loyaltyPointTerminologySingular: type: string loyaltyPointTerminologyPlural: type: string loyaltyPointDivisor: type: number format: double loyaltyPointImages: type: array items: $ref: '#/components/schemas/Image' logo: type: array items: $ref: '#/components/schemas/Image' loyaltyRedeemButtonHidden: type: boolean loyaltyCardButtonHidden: type: boolean loyaltyRedeemButtonStyle: $ref: '#/components/schemas/Button' loyaltyCardButtonStyle: $ref: '#/components/schemas/Button' headerColor: $ref: '#/components/schemas/Color' headerTextColor: $ref: '#/components/schemas/Color' headerRectangleTopBackgroundColor: $ref: '#/components/schemas/Color' headerRectangleBottomBackgroundColor: $ref: '#/components/schemas/Color' textColor: $ref: '#/components/schemas/Color' MenuItem: type: object properties: title: uniqueItems: true type: array items: $ref: '#/components/schemas/DisplayInfo' type: type: string enum: - CATERING - DEFAULT_ORDER_LOCATION - EASY_ORDER - ENTER_CODE - GIFT_CARD - HOME - INBOX - LOG_IN - LOYALTY - LOYALTY_CARD - ORDER - PAST_ORDERS - PROFILE - SETTINGS displayRank: type: integer format: int32 supportedDevices: type: array items: type: string enum: - IPHONE - ANDROID - WEB disabledImage: type: array items: $ref: '#/components/schemas/Image' selectedImage: type: array items: $ref: '#/components/schemas/Image' image: type: array items: $ref: '#/components/schemas/Image' link: $ref: '#/components/schemas/Link' OfferConfiguration: type: object properties: enterCodeScreenConfiguration: $ref: '#/components/schemas/EnterCodeScreenConfiguration' OrderCheckoutScreenConfiguration: type: object properties: navigationTitle: uniqueItems: true type: array items: $ref: '#/components/schemas/DisplayInfo' headerTitle: uniqueItems: true type: array items: $ref: '#/components/schemas/DisplayInfo' instructionText: uniqueItems: true type: array items: $ref: '#/components/schemas/DisplayInfo' isDeliveryInstructionsEnabled: type: boolean isPickupInstructionsEnabled: type: boolean isOrderInstructionsEnabled: type: boolean isTipingForDeliveryEnabled: type: boolean isTipingForPickUpEnabled: type: boolean tipPresetPercentages: type: array items: type: number format: float OrderConfiguration: type: object properties: easyOrderingHeader: uniqueItems: true type: array items: $ref: '#/components/schemas/DisplayInfo' isGuestCheckoutEnabled: type: boolean isMenuBrowsingEnabled: type: boolean defaultLocationConfiguration: $ref: '#/components/schemas/DefaultLocationConfiguration' locationScreenConfiguration: $ref: '#/components/schemas/LocationScreenConfiguration' orderMethodScreenConfiguration: $ref: '#/components/schemas/OrderMethodScreenConfiguration' itemCustomizationScreenConfiguration: $ref: '#/components/schemas/ItemCustomizationScreenConfiguration' orderCheckoutScreenConfiguration: $ref: '#/components/schemas/OrderCheckoutScreenConfiguration' orderMenuScreenConfiguration: $ref: '#/components/schemas/OrderMenuScreenConfiguration' orderConfirmationScreenConfiguration: $ref: '#/components/schemas/OrderConfirmationScreenConfiguration' OrderConfirmationScreenConfiguration: type: object properties: navigationTitle: uniqueItems: true type: array items: $ref: '#/components/schemas/DisplayInfo' headerTitle: uniqueItems: true type: array items: $ref: '#/components/schemas/DisplayInfo' instructionText: uniqueItems: true type: array items: $ref: '#/components/schemas/DisplayInfo' confirmationScreenTextExtractsColor: $ref: '#/components/schemas/Color' confirmationScreenTextExtractsFont: $ref: '#/components/schemas/FontVariation' OrderMenuScreenConfiguration: type: object properties: navigationTitle: uniqueItems: true type: array items: $ref: '#/components/schemas/DisplayInfo' headerTitle: uniqueItems: true type: array items: $ref: '#/components/schemas/DisplayInfo' instructionText: uniqueItems: true type: array items: $ref: '#/components/schemas/DisplayInfo' hideShortDescriptions: type: boolean OrderMethodScreenConfiguration: type: object properties: navigationTitle: uniqueItems: true type: array items: $ref: '#/components/schemas/DisplayInfo' headerTitle: uniqueItems: true type: array items: $ref: '#/components/schemas/DisplayInfo' instructionText: uniqueItems: true type: array items: $ref: '#/components/schemas/DisplayInfo' isDeliverySuiteManadatory: type: boolean isDeliveryExternalLinksEnabled: type: boolean isLocationSpecifcDeliveryExternalLinksEnabled: type: boolean displayTodaysTimeSlotsOnly: type: boolean WebAppConfiguration: type: object properties: facebookAppId: type: string googleAPIKey: type: string sideBarItems: type: array items: $ref: '#/components/schemas/MenuItem' webAppUrlList: $ref: '#/components/schemas/WebAppUrlList' webAppPaymentConfiguration: $ref: '#/components/schemas/WebAppPaymentConfiguration' webAppLoyaltyConfiguration: $ref: '#/components/schemas/WebAppLoyaltyConfiguration' webAppConfirmationScreenConfiguration: $ref: '#/components/schemas/WebAppConfirmationScreenConfiguration' WebAppConfirmationScreenConfiguration: type: object properties: customizedConfirmation: type: boolean deliveryConfirmationText: uniqueItems: true type: array items: $ref: '#/components/schemas/DisplayInfo' deliveryConfirmationTextWithoutOrderId: uniqueItems: true type: array items: $ref: '#/components/schemas/DisplayInfo' pickupConfirmationText: uniqueItems: true type: array items: $ref: '#/components/schemas/DisplayInfo' pickupConfirmationTextWithoutOrderId: uniqueItems: true type: array items: $ref: '#/components/schemas/DisplayInfo' WebAppLoyaltyConfiguration: type: object properties: isLoyaltyOnlyCustomer: type: boolean loyaltyOnlyCustomerLandingPageTitle: uniqueItems: true type: array items: $ref: '#/components/schemas/DisplayInfo' editLoyaltyOn: type: boolean editLoyaltyLabel: uniqueItems: true type: array items: $ref: '#/components/schemas/DisplayInfo' WebAppPaymentConfiguration: type: object properties: paymentGatewayName: type: string isAVSVerificationEnabled: type: boolean WebAppUrlList: type: object properties: mainUrl: $ref: '#/components/schemas/Link' facebookUrl: $ref: '#/components/schemas/Link' twitterUrl: $ref: '#/components/schemas/Link' instagramUrl: $ref: '#/components/schemas/Link' CheckCompatibilityResponseDTO: type: object properties: sdkCompatibility: type: string enum: - COMPATIBLE - UPGRADE_RECOMMENDED - UPGRADE_REQUIRED - NONE AppHomeConfigDTO: type: object properties: clientId: type: string version: type: integer format: int32 background: $ref: '#/components/schemas/HomeBackgroundDTO' blocks: type: array items: type: object previewScheduleId: type: string previewType: type: string hasStagedDefault: type: boolean BackgroundPreviewDTO: type: object properties: type: type: string scheduleId: type: string BackgroundScheduleDTO: type: object properties: id: type: string label: type: string imageUrlAndroid: type: string imageUrlIos: type: string videoUrlAndroid: type: string videoUrlIos: type: string videoImageUrl: type: string startDate: type: string endDate: type: string startTime: type: string endTime: type: string daysOfWeek: type: array items: type: string enabled: type: boolean HomeBackgroundDTO: type: object properties: defaultImageUrlAndroid: type: string defaultImageUrlIos: type: string defaultVideoUrlAndroid: type: string defaultVideoUrlIos: type: string defaultVideoImageUrl: type: string schedules: type: array items: $ref: '#/components/schemas/BackgroundScheduleDTO' stagedDefaultImageUrlAndroid: type: string stagedDefaultImageUrlIos: type: string stagedDefaultVideoUrlAndroid: type: string stagedDefaultVideoUrlIos: type: string stagedDefaultVideoImageUrl: type: string previewUsers: type: object additionalProperties: $ref: '#/components/schemas/BackgroundPreviewDTO'