Storefront GraphQL API
Introduction
Getting Started
Authentication
Client Libraries
GraphQL Explorer
addAddress
addItemsToCart
applyCoupon
checkoutCart
deleteCart
getCartShareLink
removeAddress
removeCoupon
selectAddress
selectPaymentMode
updateAddress
updateCart
updateCartMeta
updateCartWithSharedItems
address
addresses
bulkDiscountOffers
cart
cartLastModified
cartShipmentDetails
coupons
productLadderPromotion
promotionOffers
sharedCartDetails
validateCoupon
AddCartRequestInput
Address2Input
ApplyCouponRequestInput
ArticleGiftDetailInput
CartCheckoutDetailRequestInput
CartItem
CartMetaRequestInput
CartProductIdentiferInput
CustomerDetailsInput
GeoLocationInput
GetCartItemsRequestInput
GetShareCartLinkRequestInput
GiftDetailInput
PaymentMetaInput
PaymentMethodInput
SelectCartAddressRequestInput
StaffCheckoutInput
UpdateCartPaymentRequestInput
UpdateCartRequestInput
UpdateProductCartInput
ActionQuery
AddCartDetailResponse
Address
Addresses
AppliedFreeArticles
AppliedPromotion
ArticlePriceInfo
BaseInfo
BasePrice
BuyRules
Cart
CartBreakup
CartCheckoutResponse
CartCommonConfig
CartCouponMedias
CartCurrency
CartDetailCoupon
CartDetailResponse
CartItemCountResponse
CartLastModified
CartMetaResponse
CartPriceInfo
CartProduct
CartProductIdentifer
CartProductInfo
CartShipmentsResponse
CategoryInfo
ChargesAmount
ChargesInfo
ChargesThreshold
CheckCart
Coupon
CouponBreakup
CouponDetails
CouponValidate
CouponValidity
Coupons
CurrencyInfo
DeleteAddressResponse
DeleteCartDetailResponse
DeliveryChargesConfig
DiscountOfferDetails
DiscountRulesApp
DisplayBreakup
FreeGiftItemDetails
FreeGiftItems
GetCouponResponse
GetShareCartLinkResponse
LadderOfferItem
LadderPrice
LadderPriceOffer
LadderPriceOffers
LoyaltyPoints
NameInformation
OfferItem
OfferPrice
Ownership
PageCoupon
PaymentCouponValidate
PaymentSelectionLock
PriceInfo
ProductAction
ProductArticle
ProductAvailability
ProductAvailabilitySize
ProductImage
ProductLadderPromotion
ProductPrice
ProductPriceInfo
ProductSizeDetailsCart
PromiseFormatted
PromiseTimestamp
PromoMeta
PromotionOffer
PromotionOffers
PromotionOffersResponse
RawBreakup
SaveAddressResponse
SharedCart
SharedCartDetails
SharedCartItems
SharedCartResponse
ShipmentPromise
ShipmentResponse
StoreInfo
Tags
UpdateAddressResponse
UpdateCartDetailResponse
bulkDiscountOffers
ActionEnum
brand
brands
BrandConnection
categories
category
departments
Categories
Category
CategoryItem
CategoryItemL2
CategoryItemL3
CategoryItemL4
Department
DepartmentCategoryDetail
DepartmentIdentifier
collection
collectionItems
collections
followerCount
Badge
Collection
CollectionAction
CollectionConnection
CollectionItems
CollectionLogo
CollectionQuery
FollowerCount
Page
Params
ProductFilters
ProductFiltersKey
ProductFiltersValue
ProductSortOn
Schedule
followById
unfollowById
followedListing
product
productBundles
productComparison
productPrice
productSellers
products
searchProduct
ArticleAssignment
Attribute
AttributeDetail
AvailableStore
CompanyDetail
DiscountMeta
FollowListing
FollowPostResponse
ProductBundle
ProductCompareDetails
ProductDetails
ProductGroupingDetails
ProductInGroup
ProductSellers
ProductSet
ProductSetDistribution
ProductSetDistributionSize
ProductSizePrice
ProductStockPrice
ProductStockUnitPrice
ReturnConfig
SearchItem
SearchProduct
Seller
Size
StrategyWiseListing
UserDetails
inStockLocations
store
stores
CompanyStore
StockLocations
Store
StoreAddressSerializer
StoreConnection
StoreDepartment
StoreDetail
StoreManagerSerializer
StoreTiming
Boolean
Float
Int
JSON
String
ActionPage
Brand
ColumnHeader
ColumnHeaders
CustomMetaFields
DeliveryPromiseFormatted
DeliveryPromiseResponse
DeliveryPromiseTimestamp
DetailAttribute
Dimension
Email
EmailProperties
GeoLocation
ImageUrls
LatLong
MOQ
Media
Meta
NetQuantity
NextSchedule
PageAction
PageInfo
PhoneNumber
Price
Product
ProductBrand
ProductCategoryMap
ProductConnection
ProductDetailCustomOrder
ProductGroupedAttribute
ProductListingPrice
ProductPriceDetails
ProductSEO
ProductSiteMap
ProductSizeDetails
ProductSizeStores
ProductSizes
ProductVariant
ProductVariantItem
SEO
SEOImage
SizeChart
SizeChartValues
Time
UserDetail
UserEmail
Weight
Action
AppType
CommunicationActionEnum
CommunicationChannelEnum
DataLoaderType
LocalityEnum
LocalityType
LocationTypeEnum
Operation
PageTypes
PageVisibilityOfItem
PhoneTypeEnum
PriorityEnum
PushTokenAction
RedirectType
ResponseEnum
SelectedType
SimilarListItem
Sort_on
StoreType
TagPositionEnum
TagSubType
TagType
TicketAssetTypeEnum
TicketSourceEnum
Type
Unit
UserAction
WebRedirectType
templateNameEnum
upsertCommunicationConsent
communicationConsent
CommunicationConsentReqInput
PushtokenReqInput
Channels
CommunicationConsent
CommunicationConsentRes
EmailCommunication
SMSCommunication
WhatsappCommunication
applicationConfiguration
currencies
currency
AppBasicDetails
AppCredentials
AppCurrencyInfo
AppFeature
AppIntegrationTokens
AppLanguages
AppOwnerInfo
ApplicationAuth
ApplicationConfiguration
ApplicationCors
ApplicationMeta
ApplicationRedirections
ApplicationWebsite
BusinessHighlights
CartFeature
CommonFeature
CommunicationOptinDialogFeature
CompanyAddress
CompanyInfo
CompareProductsFeature
ContactInfo
Credit
Currency
CurrencyFeature
Debit
DefaultCurrency
DeploymentStoreSelectionFeature
Domain
FeedbackFeature
Firebase
FirebaseCredentials
Freshchat
FreshchatCredentials
FyndRewards
FyndRewardsCredentials
GoogleMap
GoogleMapCredentials
Gtm
GtmCredentials
HomePageFeature
InformationAddress
InformationLoc
InformationPhone
InformationSupport
IntrenationalShippingFeature
LandingPageFeature
LaunchPage
LinkSchema
Links
ListingPageFeature
ListingPriceFeature
Moengage
MoengageCredentials
OrderFeature
OwnerInfo
PcrFeature
PhoneSupport
ProductDetailFeature
QrFeature
RegistrationPageFeature
RevenueEngineFeature
RewardPointsConfig
Safetynet
SafetynetCredentials
SecureUrl
Segment
SegmentCredentials
SocialLinks
TokenDetails
applicationContent
blog
faq
faqCategory
faqsByCategory
page
slideshow
Announcements
ApplicationContent
ApplicationLegalFAQ
Asset
Author
Blog
BlogFilters
BlogSEO
BlogSitemap
Blogs
CategoryBySlug
CategoryDetail
ConfigurationSchema
ContactSchema
ContentAction
CreatedBy
CronSchedule
CustomField
CustomFields
CustomMetaTag
CustomObjectDefintion
CustomPageDetail
DataLoaderDetail
DataLoaderSource
DataLoaders
DateMeta
Detail
EmailSchema
FAQ
FAQCategories
FAQs
Language
LeagalInformation
LocaleLanguage
Navigation
NavigationReference
Navigations
Orientation
Pages
PhoneProperties
PhoneSchema
ResourceContent
SEOConfiguration
SEOMetaItem
SEOMetaItems
SEObreadcrumb
SeoSchema
Slideshow
SlideshowMedia
Slideshows
SupportInformation
TagSchema
TagSource
landingPage
validateAddress
allCountries
countries
country
localities
locality
locations
ValidateAddressRequestInput
Country
CountryConnection
CountryCurrency
CountryDetail
CountryFields
CountryFieldsAddress
CountryFieldsAddressTemplate
CountryFieldsAddressValues
CountryHierarchy
CountryList
CountryLogistics
CountryMetaData
CountryMetaResponse
FieldValidation
FieldValidationRegex
GetOneOrAll
GetOneOrAllParams
GetOneOrAllPath
GetOneOrAllQuery
LengthValidation
Locality
LocalityConnection
LocalityParent
LocationCountry
LocationDefaultCurrency
LocationDefaultLanguage
Locations
PincodeDetails
PincodeLatLongData
PincodeMetaData
ValidateAddressResponse
sendOtpToShipmentCustomer
updateShipmentStatus
verifyOtpShipmentCustomer
order
orders
shipment
DataUpdatesInput
EntitiesDataUpdatesInput
EntitiesReasonsInput
EntityReasonDataInput
Products3Input
ProductsDataUpdatesFiltersInput
ProductsDataUpdatesInput
ProductsReasonsDataInput
ProductsReasonsFiltersInput
ProductsReasonsInput
ReasonsDataInput
ShipmentsRequestInput
StatuesRequestInput
UpdateShipmentStatusRequestInput
VerifyOtpInput
AppliedPromos
BagReasonMeta
BagReasons
BagsForReorder
BagsForReorderArticleAssignment
BillingAddress
CurrentStatus
CustomerDetailsResponse
DeliveryAddress
FinancialBreakup
FulfillingCompany
FulfillingStore
Identifiers
Invoice
ItemBrand
NestedTrackingDetails
Order
OrderAppliedFreeArticles
OrderBags
OrderBreakupValues
OrderConnection
OrderFilters
OrderItem
OrderPageInfo
OrderShipment
OrderStatus
Prices
Promise
QuestionSet
SendOtpToCustomerResponse
Shipment
ShipmentApplicationStatusResponse
ShipmentBagReasons
ShipmentCancellationReasons
ShipmentInvoice
ShipmentPayment
ShipmentReason
ShipmentStatus
ShipmentTotalDetails
ShipmentUserInfo
StatusesBodyResponse
TimeStampData
Track
TrackShipment
TrackingDetails
UserInfo
VerifyOtpResponse
addBeneficiaryDetails
addRefundBankAccountUsingOTP
attachCardToCustomer
cancelPaymentLink
checkAndUpdatePaymentStatus
checkAndUpdatePaymentStatusPaymentLink
createOrderHandlerPaymentLink
createPaymentLink
customerOnboard
deleteUserCard
enableOrDisableRefundTransferMode
initialisePayment
initialisePaymentPaymentLink
renderHTML
resendOrCancelPayment
resendPaymentLink
updateDefaultBeneficiary
validateVPA
verifyAndChargePayment
verifyCustomerForPayment
verifyOtpAndAddBeneficiaryForBank
verifyOtpAndAddBeneficiaryForWallet
aggregatorsConfig
payment
paymentLinkDetail
paymentModeRoutes
posPaymentModeRoutes
redirectToAggregator
refund
AddBeneficiaryDetailsOTPRequestInput
AddBeneficiaryDetailsRequestInput
AddBeneficiaryViaOtpVerificationRequestInput
AddressAsPerIDInput
AddressInput
AttachCardRequestInput
BankDetailsForOTPInput
BusinessInfoInput
CancelOrResendPaymentLinkRequestInput
ChargeCustomerRequestInput
CreateOrderUserRequestInput
CreatePaymentLinkRequestInput
CustomerOnboardingRequestInput
DeletehCardRequestInput
DetailsInput
DeviceInput
MarketplaceInfoInput
Meta2Input
MetaInput
PaymentInitializationRequestInput
PaymentMethodsInput
PaymentStatusUpdateRequestInput
PersonalInfoInput
RenderHTMLRequestInput
ResendOrCancelPaymentRequestInput
SetDefaultBeneficiaryRequestInput
UpdateRefundTransferModeRequestInput
ValidateCustomerRequestInput
ValidateVPARequestInput
WalletOtpRequestInput
ActiveCardAggregator
ActiveCardAggregatorCardInfo
ActiveRefundTransferModes
AddBeneficiaryViaOtpVerificationResponse
AggregatorsConfigDetail
AjiodhanAggregatorConfig
AmountAvailable
AttachCardsResponse
BeneficiaryDetails
CCAvenueAggregatorConfig
CancelPaymentLinkResponse
Card
CardConnection
CardData
CardDetail
ChargeCustomerResponse
CreateOrderUserData
CreateOrderUserResponse
CreatePaymentLinkResponse
CreditDetail
CreditSummary
CustomerOnboardingResponse
DeleteCardsResponse
DueAmount
EpayLaterKYCDetail
EpaylaterBanner
IFSCCodeDetail
IntentApp
IntentAppErrorList
JusPayAggregatorConfig
LinkStatus
Logo
MSwipeAggregatorConfig
OnboardSummary
OrderBeneficiaryDetail
OutstandingOrderDetail
Payment
PaymentFlows
PaymentInitializationResponse
PaymentLink
PaymentLinkDetail
PaymentModeList
PaymentModeRouteDetail
PaymentOptionDetails
PaymentStatusUpdateResponse
PayuMoneyAggregatorConfig
PollingPaymentLinkDetail
PotleeAggregatorConfig
QRRefundJioPayAggregatorConfig
RazorPayAggregatorConfig
RedirectToAggregatorDetail
RedirectUrl
Refund
RefundAccountResponse
RenderHtmlResponse
ResendOrCancelPaymentResponse
ResendPaymentLinkResponse
RootPaymentMode
RupifiBanner
RupifiKYCDetail
RupifyAggregatorConfig
SetDefaultBeneficiaryResponse
SimplAggregatorConfig
StripeAggregatorConfig
TotalDueAmount
TransferItem
TransferMode
UpdateRefundTransferModeResponse
UserBalance
UserCredit
UserCreditLimit
UserCreditSummary
ValidateCustomerResponse
ValidateUPI
ValidateVPAResponse
WalletOtpResponse
paymentFlowDetail
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
Debug
FeedbackForm
PollForAssignment
Priority
Status
SubmitButton
SubmitCustomFormResponse
Support
SupportTicket
TicketAsset
TicketCategory
TicketContent
TicketContext
theme
Assets
AvailableSection
Block
BlockProps
CSS
Colors
CommonJs
Config
Font
FontVariants
ListItem
PageConfig
PageDetail
PagePredicate
PageRoutePredicate
PageSEO
PageScreenPredicate
PageSectionMetaAttributes
PageSections
PageUserPredicate
Preset
PropDetail
Props
Src
Theme
ThemeDetail
ThemeImages
ThemeInfo
UmdJs
VaariantDetail
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
verifyEmail
verifyEmailForgotOTP
verifyEmailOTP
verifyMobile
verifyMobileForgotOTP
verifyMobileOTP
platformConfig
user
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
VerifyEmailForgotOtpRequestSchemaInput
VerifyEmailOtpRequestSchemaInput
VerifyMobileForgotOtpRequestSchemaInput
VerifyOtpRequestSchemaInput
AuthSuccess
DeleteAccountReasons
DeleteUserSuccess
EmailOtpSuccess
FlashCard
HasPassword
Login
LoginSuccess
Logout
LookAndFeel
MetaDetail
OtpSuccess
PlatformConfig
ProfileEditSuccess
RegisterFormSuccess
RegisterRequiredFields
RequiredFieldDetail
RequiredFields
ResetForgotPasswordSuccess
ResetPasswordSuccess
SendEmailVerifyLinkSuccess
SendMobileVerifyLinkSuccess
SendOtpResponse
SessionList
Social
SocialAccountId
SocialTokens
User
VerifyEmailOTPSuccess
VerifyEmailSuccess
VerifyForgotOtpSuccess
VerifyMobileOTPSuccess
VerifyOtpSuccess
object

Channels

The schema for the all the communication channels that the user has accept to receive communication through.
Fields
email
EmailCommunication
The schema for the communication channel for email channel which includes the response indicating the user's preference and the display name of the communication channel.
sms
SMSCommunication
The schema for the communication channel for SMS channel which includes the response indicating the user's preference and the display name of the communication channel.
whatsapp
WhatsappCommunication
The schema for the communication channel for whatsapp channel which includes the response indicating the user's preference and the display name of the communication channel.
Previous
« PushtokenReqInput
Next
applicationConfiguration »