Storefront GraphQL API
Introduction
Getting Started
Authentication
Client Libraries
GraphQL Explorer
Change Log
addAddress
addItemsToCart
applyCoupon
applyLoyaltyPoints
checkoutCart
deleteCart
getCartShareLink
removeAddress
removeCoupon
selectAddress
selectPaymentMode
updateAddress
updateCart
updateCartBreakup
updateCartMeta
updateCartWithSharedItems
address
addresses
bulkDiscountOffers
cart
cartShipmentDetails
coupons
eligibleOfferProducts
productLadderPromotion
promotionPaymentOffers
promotions
sharedCartDetails
validateCoupon
AddCartRequestInput
Address2Input
AlternatePickupPersonInput
ApplyCouponRequestInput
ArticleAssignmentInput
CartCheckoutDetailRequestInput
CartItem
CartMetaRequestInput
CartProductIdentiferInput
CustomerDetailsInput
FreeGiftItem
GeoLocationInput
GetShareCartLinkRequestInput
GiftDetailInput
OrderTagInput
PaymentMetaInput
PaymentMethodInput
RedeemLoyaltyPoints
SelectCartAddressRequestInput
StaffCheckoutInput
UpdateCartBreakupRequestInput
UpdateCartPaymentRequestInput
UpdateCartRequestInput
UpdateProductCartInput
ActionQuery
AddCartDetailResponse
AddItemToCartResponse
Address
Addresses
AlternatePickupPerson
AppliedFreeArticles
AppliedPromotion
ApplyLoyaltyPointsResponse
ArticlePriceDetails
ArticlePriceInfo
BaseInfo
BasePrice
BulkDiscountOffers
BuyRules
Cart
CartBreakup
CartCheckoutResponse
CartCommonConfig
CartCurrency
CartDetailCoupon
CartItemCountResponse
CartItemInfo
CartMetaResponse
CartPriceInfo
CartProduct
CartProductIdentifer
CartProductInfo
CartShipmentsResponse
CategoryInfo
ChargesAmount
ChargesInfo
ChargesThreshold
CheckCart
Coupon
CouponBreakup
CouponDetails
CouponUpdateResponse
CouponValidate
CouponValidity
Coupons
CurrencyValue
DeleteAddressResponse
DeleteCartDetailResponse
DeliveryChargesConfig
DiscountOfferDetails
DiscountRules
DiscountRulesApp
DisplayBreakup
EligibleProductItem
EligibleProductPageInfo
EligibleProductsResponse
FreeGiftItemDetails
FreeGiftItems
GetCouponResponse
GetShareCartLinkResponse
ItemPriceDetails
LadderOfferItem
LadderPrice
LadderPriceOffer
LadderPriceOfferDetails
LadderPriceOffers
LoyaltyPoints
NameInformation
OfferItem
OfferPrice
Ownership
PageCoupon
PaymentCouponValidate
PaymentSelectionLock
PickupStoreDetail
PriceInfo
PriceMinMax
ProductAction
ProductActionPage
ProductActionParams
ProductArticle
ProductAvailability
ProductAvailabilitySize
ProductImage
ProductLadderPromotion
ProductMaxQuantityInfo
ProductPrice
ProductPriceInfo
ProductSizeDetailsCart
PromiseFormatted
PromiseTimestamp
PromoMeta
PromotionOffer
PromotionOffersResponse
PromotionPaymentOffer
PromotionPaymentOffers
Promotions
RawBreakup
SaveAddressResponse
SelectAddressResponse
SelectPaymentModeResponse
SharedCart
SharedCartDetails
SharedCartItems
SharedCartResponse
ShipmentPromise
ShipmentResponse
StoreHours
StoreInfo
StoreTime
Tags
UpdateAddressResponse
UpdateCartDetailResponse
ValidationConfig
ActionEnum
FreeGiftItemsOperation
OfferMode
OfferType
PromotionGroup
brand
brands
BrandConnection
categories
category
departments
Categories
Category
CategoryItem
CategoryItemL2
CategoryItemL3
CategoryItemL4
DepartmentCategoryDetail
DepartmentIdentifier
collection
collectionItems
collections
followerCount
Badge
Collection
CollectionAction
CollectionConnection
CollectionDetail
CollectionFilter
CollectionItem
CollectionItems
CollectionListingFilterTagType
CollectionLogo
CollectionLogoMeta
CollectionQuery
FollowerCount
Page
Params
Schedule
CollectionType
followById
unfollowById
bundleItems
bundlesByChild
followedListing
product
productBundles
productComparison
productPrice
productSellers
products
productsPriceWithFulfillmentOption
searchProduct
ArticleAssignment
Attribute
AttributeDetail
AvailableStore
Bundle
BundleItem
BundleItems
BundleNetQuantity
BundlesByChild
CompanyDetail
FollowListing
FollowPostResponse
FollowedProduct
ProductBundle
ProductCompareDetails
ProductDetails
ProductGroupingDetails
ProductIdentifier
ProductInGroup
ProductSellers
ProductSet
ProductSetDistribution
ProductSetDistributionSize
ProductSizePrice
ProductSizeSeller
ProductStockUnitPrice
ProductsPriceWithFulfillmentOption
ReturnConfiguration
SearchItem
SearchProduct
Seller
SellerSortOn
Size
StrategyWiseListing
Trader
UserDetails
inStockLocations
store
stores
ApplicationStoreFilterListing
CompanyStore
ContactDetails
EnabledStatus
GSTCredentialsConfiguration
OrderProcessingTime
OrderTiming
ProductReturnConfiguration
StockLocations
Store
StoreConnection
StoreDepartment
StoreDetail
StoreManagerSerializer
StorePhoneNumber
Boolean
Float
Int
JSON
String
ActionPage
ActionPageDetail
ApplicationItemSEO
Brand
BrandDetail
ColumnHeader
ColumnHeaders
ContentAction
CurrencyInfo
CustomField
CustomMetaFields
DeliveryPromiseFormatted
DeliveryPromiseItem
DeliveryPromiseResponse
DeliveryPromiseTimestamp
Department
DetailAttribute
Dimension
DiscountMeta
Email
EmailProperties
FulfillmentOption
GeoLocation
ImageUrls
LatLong
MOQ
Media
Meta
ModifiedBy
NavigationAction
NetQuantity
NextSchedule
PageAction
PageActionDetail
PageInfo
PhoneNumber
Price
Product
ProductCategoryMap
ProductConnection
ProductDepartment
ProductDetailCustomOrder
ProductFilters
ProductFiltersKey
ProductFiltersValue
ProductGroupedAttribute
ProductListingDetail
ProductListingPrice
ProductListingPriceDetails
ProductPriceDetails
ProductSEO
ProductSiteMap
ProductSizeDetails
ProductSizeStores
ProductSizes
ProductSortOn
ProductStockPrice
ProductVariant
ProductVariantDetail
ProductVariantItem
ResponseMessage
SEO
SEODetails
SEOImage
SEOMetaItem
SEOMetaItems
SEOSiteMapDetails
SEObreadcrumb
SizeChart
SizeChartValues
StoreAddress
StoreTiming
Time
UserDetail
UserEmail
Weight
AccountStatusEnum
Action
AddressType
AppType
BundleTypeEnum
CommunicationActionEnum
CommunicationChannelEnum
CustomFieldCreator
CustomFieldType
DataLoaderType
FilterByEnum
ItemTypeEnum
LocalityEnum
LocalityType
LocationTypeEnum
Operation
OrderTypeEnum
PageTypes
PageVisibilityOfItem
PhoneTypeEnum
PriorityEnum
PushTokenAction
RedirectType
ResponseEnum
SelectedType
SessionEnum
SimilarListItem
Sort_on
StoreType
TagPositionEnum
TagSubType
TagType
ThemeTypeEnum
TicketAssetTypeEnum
TicketSourceEnum
Type
Unit
UserAction
WebRedirectType
Weekday
templateNameEnum
updateCommunicationConsent
customerCommunicationConsent
CommunicationConsentReqInput
PushtokenReqInput
Channels
CommunicationConsent
EmailCommunication
SMSCommunication
WhatsappCommunication
applicationConfiguration
currencies
currency
AppBasicDetails
AppCountryCurrencies
AppCredentials
AppCurrencyInfo
AppDetails
AppFeature
AppIntegrationTokens
AppLanguages
AppOwnerInfo
ApplicationAuth
ApplicationConfiguration
ApplicationCors
ApplicationMeta
ApplicationRedirections
ApplicationWebsite
BusinessHighlights
BuyboxFeature
CartFeature
CommonFeature
CommunicationOptinDialogFeature
CompanyAddress
CompanyInfo
CompareProductsFeature
ContactInfo
Credit
Currency
CurrencyDetail
CurrencyFeature
Debit
DefaultCurrency
DeliveryStrategy
DeploymentStoreSelectionFeature
Domain
FeedbackFeature
Firebase
FirebaseCredentials
Freshchat
FreshchatCredentials
FulfillmentOptionCount
FyndRewards
FyndRewardsCredentials
GoogleMap
GoogleMapCredentials
Gtm
GtmCredentials
HomePageFeature
InformationAddress
InformationLoc
InformationPhone
InformationSupport
IntrenationalShippingFeature
LandingPageFeature
LaunchPage
LinkSchema
Links
ListingPageFeature
ListingPriceFeature
Moengage
MoengageCredentials
OrderFeature
OrderingSources
OwnerInfo
PhoneSupport
ProductChangeRequestFeatureConfiguration
ProductDetailFeature
QrFeature
RegistrationPageFeature
RevenueEngineFeature
RewardPointsConfig
Safetynet
SafetynetCredentials
SecureUrl
SecurityDomain
SecurityFeature
Segment
SegmentCredentials
SocialLinks
TokenDetails
TokenSchema
ApplicationMode
ApplicationStatus
CurrencyDisplayType
DeliveryStrategyValue
DeploymentStoreSelectionFeatureType
PriceDisplayMode
PriceSort
PriceStrategy
SecurityUrlScheme
applicationContent
blog
customFieldsByResource
faq
faqCategory
faqsByCategory
languages
page
Announcements
ApplicationContent
ApplicationLegalFAQ
Asset
Author
Blog
BlogFilters
Blogs
CategoryBySlug
CategoryDetail
ContactSchema
CreatedBy
CronSchedule
CustomFieldResult
CustomFields
CustomMetaTag
CustomObjectDefintion
CustomPageDetail
DataLoaderDetail
DataLoaderSource
DataLoaders
DateMeta
Detail
EmailSchema
FAQ
FAQCategories
FAQs
LandingPage
Language
Languages
LegalInformation
LocaleLanguage
Navigation
NavigationReference
Navigations
Orientation
Pages
PhoneProperties
PhoneSchema
ResourceContent
ResourceCustomFieldGroup
SeoSchema
SupportInformation
TagSchema
TagSource
CompatibleEngine
completeUpload
signUrls
startUpload
CompleteUploadReqInput
FileUploadParamsInput
SignUrlInput
StartUploadReqInput
UploadDetailsInput
CDN
CompleteUploadData
SignUrlResult
SignedUrlData
StartUploadData
Upload
FileStorageNamespace
validateAddress
allCountries
countries
country
deliveryPromise
fulfillmentOption
fulfillmentOptionStores
fulfillmentOptions
localities
locality
ValidateAddressRequestInput
Country
CountryConnection
CountryCurrencyInfo
CountryDetail
CountryDetails
CountryFields
CountryFieldsAddress
CountryFieldsAddressTemplate
CountryFieldsAddressValues
CountryHierarchy
CountryList
CountryLogistics
CountryMetaResponse
CurrencyObject
DeliveryOperationSchema
DeliveryPromise
DeliveryPromiseInfo
FieldValidation
FieldValidationRegex
FulfillmentOptionList
FulfillmentOptionStore
FulfillmentOptionStores
FulfillmentOptions
GetOneOrAll
GetOneOrAllParams
GetOneOrAllPath
GetOneOrAllQuery
LengthValidation
Locality
LocalityConnection
LocalityParent
PincodeLatLongData
ServiceabilityModel
StoreDistance
StorePromise
StoreTimingDetails
ValidateAddressResponse
sendOtpForRefundBankDetails
sendShipmentOtpToCustomer
submitDeliveryReattemptRequest
updateShipmentStatus
verifyOtpForRefundBankDetails
verifyShipmentOtpFromCustomer
getRefundModes
getRefundModesWithPriceBreakUp
order
orders
shipment
DataUpdatesInput
DeliveryReattemptRequestInput
EntitiesDataUpdatesInput
EntitiesReasonsInput
EntityReasonDataInput
ProductsDataUpdatesFiltersInput
ProductsDataUpdatesInput
ProductsInput
ProductsReasonsDataInput
ProductsReasonsFiltersInput
ProductsReasonsInput
ReasonsDataInput
RefundMode
RefundModeTransitionBeneficiaryData
ShipmentLineItem
StatusUpdateShipmentsInput
StatusesRequestInput
TransitionCommentsInput
UpdateShipmentStatusRequestInput
VerifyOtpInput
AppliedPromos
Article
BagReasonMeta
BagReasons
BagsForReorder
BagsForReorderArticleAssignment
BillingAddress
BundleDetails
BundleReturnConfig
ChargeAmount
ChargeAmountCurrency
ChargeDistributionLogic
ChargeDistributionSchema
CreditNote
CurrencySchema
CurrentStatus
CustomerDetailsResponse
DeliveryAddress
DeliveryReattemptRequestResponse
FinancialBreakup
FulfillingCompany
FulfillingStore
Identifiers
Invoice
ItemBrand
NdrDeliveryWindow
NdrDetails
NestedTrackingDetails
Order
OrderAppliedFreeArticles
OrderBags
OrderBreakupValue
OrderConnection
OrderFilters
OrderItem
OrderPageInfo
OrderRequest
OrderShipment
OrderStatus
PriceAdjustmentCharge
Prices
Promise
QuestionSet
RefundModeData
RefundOption
RefundOptionMode
RefundOptionsResponse
RefundOptionsWithPriceBreakup
RefundStatus
RefundTransactionInfo
SendOtpToCustomerResponse
Shipment
ShipmentApplicationStatusResponse
ShipmentBagReasons
ShipmentBeneficiaryDetails
ShipmentCancellationReasons
ShipmentInvoice
ShipmentPayment
ShipmentPaymentInfo
ShipmentReason
ShipmentStatus
ShipmentTotalDetails
ShipmentUserInfo
StatusesBodyResponse
TaxComponent
TimeStampData
Track
TrackShipment
TrackingDetails
UserInfo
VerifyOtpResponse
RefundModeType
ShipmentOtpEventType
addBeneficiary
addBeneficiaryDetails
addRefundBankAccountUsingOTP
addRefundBeneficiaryUsingOTPSession
attachCardToCustomer
cancelPaymentLink
checkAndUpdatePaymentStatus
checkAndUpdatePaymentStatusPaymentLink
createOrderHandlerPaymentLink
createPaymentLink
createPaymentLinkOrder
createPaymentOrder
customerOnboard
deleteBeneficiary
deleteUserCard
delinkWallet
enableOrDisableRefundTransferMode
getRefundBeneficiariesUsingOTPSession
initialisePayment
initialisePaymentPaymentLink
linkWallet
renderHTML
resendOrCancelPayment
resendPaymentLink
updateDefaultBeneficiary
validateCustomerAndCreditSummary
validateVPA
verifyAndChargePayment
verifyCustomerForPayment
verifyOtpAndAddBeneficiaryForBank
verifyOtpAndAddBeneficiaryForWallet
walletLinkInitiate
aggregatorsConfig
payment
paymentLinkDetail
paymentModeRoutes
posPaymentModeRoutes
redirectToAggregator
refund
AddBeneficiaryDetailsOTPRequestInput
AddBeneficiaryDetailsRequestInput
AddBeneficiaryInput
AddBeneficiaryViaOtpVerificationRequestInput
AddressAsPerIDInput
AddressInput
AttachCardRequestInput
BankDetailsForOTPInput
BeneficiaryDetailsInput
BusinessInfoInput
CancelOrResendPaymentLinkRequestInput
ChargeCustomerRequestInput
CreateOrderUserRequestInput
CreatePaymentLinkRequestInput
CustomerAndCreditSummary
CustomerOnboardingRequestInput
DeleteBeneficiaryInput
DeletehCardRequestInput
DetailsInput
DeviceInput
MarketplaceInfoInput
Meta2Input
MetaInput
PaymentInitializationRequestInput
PaymentMethodsInput
PaymentMethodsMetaOrderInput
PaymentOrderInput
PaymentOrderMethodsInput
PaymentStatusUpdateRequestInput
PersonalInfoInput
RenderHTMLRequestInput
ResendOrCancelPaymentRequestInput
SetDefaultBeneficiaryRequestInput
UpdateRefundTransferModeRequestInput
ValidateCustomerRequestInput
ValidateVPARequestInput
WalletDelinkRequestSchemaInput
WalletLinkRequestSchemaInput
WalletOtpRequestInput
WalletVerifyRequestSchemaInput
getRefundBeneficiaryInput
ActiveCardAggregator
ActiveCardAggregatorCardInfo
ActiveRefundTransferModes
AddBeneficiaryResponseDetails
AddBeneficiaryViaOtpVerificationResponse
AdvanceDetails
AdvancePaymentObject
AggregatorRouteDetail
AggregatorsConfigDetail
AmountAvailable
AttachCardsResponse
BankBeneficiary
BeneficiaryDetails
CCAvenueAggregatorConfig
CancelPaymentLinkResponse
Card
CardConnection
CardData
CardDetail
ChargeCustomerResponse
CreateOrderUserData
CreateOrderUserResponse
CreatePaymentLinkResponse
CreditAccountSummary
CreditAndCustomerValidation
CreditDetail
CreditSummary
CustomerOnboardingResponse
DeleteCardsResponse
DueAmount
EpayLaterKYCDetail
EpaylaterBanner
FormField
FormPostAction
GetRefundBeneficiary
IFSCCodeDetail
IntentApp
IntentAppErrorList
JusPayAggregatorConfig
LinkStatus
Logo
MSwipeAggregatorConfig
OnboardSummary
OrderBeneficiaryDetail
OutstandingOrderDetail
Payment
PaymentDefaultSelection
PaymentFlowDetail
PaymentFlows
PaymentInitializationResponse
PaymentLink
PaymentLinkDetail
PaymentModeList
PaymentModeRouteDetail
PaymentOptionDetails
PaymentOrderData
PaymentOrderDetails
PaymentStatusUpdateResponse
PayuMoneyAggregatorConfig
PollingPaymentLinkDetail
RazorPayAggregatorConfig
RedirectAction
RedirectToAggregatorDetail
RedirectUrl
Refund
RefundAccountResponse
RenderHtmlResponse
ResendOrCancelPaymentResponse
ResendPaymentLinkResponse
RootPaymentMode
RupifiBanner
RupifiKYCDetail
RupifyAggregatorConfig
SetDefaultBeneficiaryResponse
SimplAggregatorConfig
SplitObject
StoredPaymentDetails
StripeAggregatorConfig
SupportedMethodDetails
TotalDueAmount
TransferItem
TransferMode
UpdateRefundTransferModeResponse
UpiBeneficiary
UserBalance
UserCredit
UserCreditInfo
UserCreditLimit
UserCreditSummary
ValidateCustomerResponse
ValidateUPI
ValidateVPAResponse
WalletOtpResponse
WalletResponse
CardBrand
NextActionType
PaymentFlow
PaymentStatusUpdateResponseStatus
NextAction
createShortLink
getApplicationQRCode
getCollectionQRCodeBySlug
getProductQRCodeBySlug
getUrlQRCode
shortLink
AttributionInput
CampaignShortLinkInput
RedirectDeviceInput
RedirectsInput
ShortLinkReqInput
SocialMediaTagsInput
WebRedirectInput
Attribution
CampaignShortLink
QRCodeResp
RedirectDevice
Redirects
ShortLink
ShortLinkDetail
SocialMediaTags
UrlInfo
WebRedirect
createTicket
submitCustomForm
support
AddTicketPayloadInput
CustomFormSubmissionPayloadInput
TicketAssetInput
TicketContentInput
CreatedOn
CustomForm
FeedbackForm
PollForAssignment
Priority
Status
SubmitButton
SubmitCustomFormResponse
Support
SupportTicket
TicketAsset
TicketCategory
TicketContent
TicketContext
appliedTheme
theme
Assets
AvailablePage
AvailablePagePredicate
AvailablePageRoutePredicate
AvailablePageSchemaSections
AvailableSection
Block
CSS
CanvasItem
Colors
CommonJs
Config
Font
FontVariants
ImagePickerProp
ListItem
PageConfig
PageDetail
PagePlatformPredicate
PagePredicate
PageRoutePredicate
PageSEO
PageSchedulePredicate
PageScreenPredicate
PageSectionMetaAttributes
PageSections
PageUserPredicate
Preset
PropDetail
Props
Release
SEOSitemap
SectionAssets
SectionSource
Src
Theme
ThemeDetail
ThemeImages
ThemeInfo
ThemeMeta
ThemePayment
UmdJs
VaariantDetail
sectionPreset
addEmail
addMobileNumber
deleteEmail
deleteMobileNumber
deleteUser
forgotPassword
loginWithAppleIOS
loginWithEmailAndPassword
loginWithFacebook
loginWithGoogle
loginWithGoogleAndroid
loginWithGoogleIOS
loginWithOTP
loginWithToken
registerWithForm
resetForgotPassword
sendForgotOTPOnEmail
sendForgotOTPOnMobile
sendOTPOnEmail
sendOTPOnMobile
sendResetPasswordEmail
sendResetPasswordMobile
sendResetToken
sendVerificationLinkToEmail
sendVerificationLinkToMobile
setEmailAsPrimary
setMobileNumberAsPrimary
updatePassword
updateProfile
updateUserAttributes
verifyEmail
verifyEmailForgotOTP
verifyEmailOTP
verifyMobile
verifyMobileForgotOTP
verifyMobileOTP
attributesDefinition
platformConfig
user
userAttributes
userExists
CodeRequestBodySchemaInput
DeleteApplicationUserRequestSchemaInput
EditEmailRequestSchemaInput
EditMobileRequestSchemaInput
EditProfileMobileSchemaInput
EditProfileRequestSchemaInput
ForgotPasswordRequestSchemaInput
FormRegisterRequestSchemaInput
FormRegisterRequestSchemaPhoneInput
OAuthRequestAppleSchemaInput
OAuthRequestAppleSchemaOauthInput
OAuthRequestAppleSchemaProfileInput
OAuthRequestSchemaInput
OAuthRequestSchemaOauth2Input
OAuthRequestSchemaProfileInput
PasswordLoginRequestSchemaInput
SendEmailForgotOtpRequestSchemaInput
SendEmailOtpRequestSchemaInput
SendMobileForgotOtpRequestSchemaInput
SendMobileOtpRequestSchemaInput
SendOtpRequestSchemaInput
SendResetPasswordEmailRequestSchemaInput
SendResetPasswordMobileRequestSchemaInput
SendVerificationLinkMobileRequestSchemaInput
TokenRequestBodySchemaInput
UpdatePasswordRequestSchemaInput
UpdateUserAttributesRequestSchemaInput
VerifyEmailForgotOtpRequestSchemaInput
VerifyEmailOtpRequestSchemaInput
VerifyMobileForgotOtpRequestSchemaInput
VerifyOtpRequestSchemaInput
AppleSocialAccount
AttributeMaskingProperties
AttributeRegistrationProperties
AuthSuccess
DeleteAccountConsent
DeleteAccountReasons
DeleteUserSuccess
EmailOtpSuccess
FlashCard
HasPassword
Login
LoginSuccess
Logout
LookAndFeel
MetaDetail
OtpSuccess
PlatformConfig
PrivacyPolicyConsent
ProfileEditSuccess
RegisterFormSuccess
RegisterRequiredFields
RequiredFieldDetail
RequiredFields
ResetForgotPasswordSuccess
ResetPasswordSuccess
SendEmailVerifyLinkSuccess
SendMobileVerifyLinkSuccess
SendOtpResponse
SessionExpiry
SessionList
Social
SocialAccountId
SocialTokens
User
UserAttributeDefinitionValidation
UserAttributes
UserAttributesDefinition
UserAttributesDefinitionData
UserConsent
UserExists
VerifyEmailOTPSuccess
VerifyEmailSuccess
VerifyForgotOtpSuccess
VerifyMobileOTPSuccess
VerifyOtpSuccess
AttributeType
OrderingChannel
RegistrationType
UserAttributeRegistrationType
ValidationType
input_object

ForgotPasswordRequestSchemaInput

Describes the request structure to initiate the password recovery process for the user.
Fields
code
String!
Required
Verification code or reset-link token obtained via verifyEmailForgotOTP, verifyMobileForgotOTP, or sendResetPasswordEmail.
password
String!
Required
New password for the User.
Previous
« EditProfileRequestSchemaInput
Next
FormRegisterRequestSchemaInput »