User - Storefront GraphQL API

Storefront GraphQL API

Getting Started

Client Libraries

GraphQL Explorer

applyLoyaltyPoints

getCartShareLink

selectPaymentMode

updateCartBreakup

updateCartWithSharedItems

bulkDiscountOffers

cartShipmentDetails

eligibleOfferProducts

productLadderPromotion

promotionPaymentOffers

sharedCartDetails

AddCartDetailResponse

AddItemToCartResponse

AlternatePickupPerson

AppliedFreeArticles

AppliedPromotion

ApplyLoyaltyPointsResponse

ArticlePriceDetails

ArticlePriceInfo

BulkDiscountOffers

CartCheckoutResponse

CartCommonConfig

CartDetailCoupon

CartItemCountResponse

CartMetaResponse

CartProductIdentifer

CartProductInfo

CartShipmentsResponse

ChargesThreshold

CouponUpdateResponse

DeleteAddressResponse

DeleteCartDetailResponse

DeliveryChargesConfig

DiscountOfferDetails

DiscountRulesApp

EligibleProductItem

EligibleProductPageInfo

EligibleProductsResponse

FreeGiftItemDetails

GetCouponResponse

GetShareCartLinkResponse

ItemPriceDetails

LadderOfferItem

LadderPriceOffer

LadderPriceOfferDetails

LadderPriceOffers

NameInformation

PaymentCouponValidate

PaymentSelectionLock

PickupStoreDetail

ProductActionPage

ProductActionParams

ProductAvailability

ProductAvailabilitySize

ProductLadderPromotion

ProductMaxQuantityInfo

ProductPriceInfo

ProductSizeDetailsCart

PromiseFormatted

PromiseTimestamp

PromotionOffersResponse

PromotionPaymentOffer

PromotionPaymentOffers

SaveAddressResponse

SelectAddressResponse

SelectPaymentModeResponse

SharedCartDetails

SharedCartItems

SharedCartResponse

ShipmentPromise

ShipmentResponse

UpdateAddressResponse

UpdateCartDetailResponse

ValidationConfig

FreeGiftItemsOperation

BrandConnection

DepartmentCategoryDetail

DepartmentIdentifier

inStockLocations

ApplicationStoreFilterListing

GSTCredentialsConfiguration

OrderProcessingTime

ProductReturnConfiguration

StoreConnection

StoreDepartment

StoreManagerSerializer

StorePhoneNumber

ActionPageDetail

ApplicationItemSEO

CustomMetaFields

DeliveryPromiseFormatted

DeliveryPromiseItem

DeliveryPromiseResponse

DeliveryPromiseTimestamp

DetailAttribute

EmailProperties

FulfillmentOption

NavigationAction

PageActionDetail

ProductCategoryMap

ProductConnection

ProductDepartment

ProductDetailCustomOrder

ProductFiltersKey

ProductFiltersValue

ProductGroupedAttribute

ProductListingDetail

ProductListingPrice

ProductListingPriceDetails

ProductPriceDetails

ProductSizeDetails

ProductSizeStores

ProductStockPrice

ProductVariantDetail

ProductVariantItem

ResponseMessage

SEOSiteMapDetails

SizeChartValues

updateCommunicationConsent

customerCommunicationConsent

CommunicationConsentReqInput

PushtokenReqInput

CommunicationConsent

EmailCommunication

SMSCommunication

WhatsappCommunication

applicationConfiguration

AppBasicDetails

AppCountryCurrencies

AppCurrencyInfo

AppIntegrationTokens

ApplicationAuth

ApplicationConfiguration

ApplicationCors

ApplicationMeta

ApplicationRedirections

ApplicationWebsite

BusinessHighlights

CommunicationOptinDialogFeature

CompareProductsFeature

CurrencyFeature

DefaultCurrency

DeliveryStrategy

DeploymentStoreSelectionFeature

FeedbackFeature

FirebaseCredentials

FreshchatCredentials

FulfillmentOptionCount

FyndRewardsCredentials

GoogleMapCredentials

HomePageFeature

InformationAddress

InformationPhone

InformationSupport

IntrenationalShippingFeature

LandingPageFeature

ListingPageFeature

ListingPriceFeature

MoengageCredentials

OrderingSources

ProductChangeRequestFeatureConfiguration

ProductDetailFeature

RegistrationPageFeature

RevenueEngineFeature

RewardPointsConfig

SafetynetCredentials

SecurityFeature

SegmentCredentials

ApplicationMode

ApplicationStatus

CurrencyDisplayType

DeliveryStrategyValue

DeploymentStoreSelectionFeatureType

PriceDisplayMode

SecurityUrlScheme

CompleteUploadReqInput

FileUploadParamsInput

StartUploadReqInput

UploadDetailsInput

CompleteUploadData

StartUploadData

FileStorageNamespace

sendOtpForRefundBankDetails

sendShipmentOtpToCustomer

submitDeliveryReattemptRequest

updateShipmentStatus

verifyOtpForRefundBankDetails

verifyShipmentOtpFromCustomer

getRefundModesWithPriceBreakUp

BagsForReorderArticleAssignment

BundleReturnConfig

ChargeAmountCurrency

ChargeDistributionLogic

ChargeDistributionSchema

CustomerDetailsResponse

DeliveryAddress

DeliveryReattemptRequestResponse

FinancialBreakup

FulfillingCompany

FulfillingStore

NdrDeliveryWindow

NestedTrackingDetails

OrderAppliedFreeArticles

OrderBreakupValue

OrderConnection

PriceAdjustmentCharge

RefundOptionMode

RefundOptionsResponse

RefundOptionsWithPriceBreakup

RefundTransactionInfo

SendOtpToCustomerResponse

ShipmentApplicationStatusResponse

ShipmentBagReasons

ShipmentBeneficiaryDetails

ShipmentCancellationReasons

ShipmentInvoice

ShipmentPayment

ShipmentPaymentInfo

ShipmentTotalDetails

ShipmentUserInfo

StatusesBodyResponse

TrackingDetails

VerifyOtpResponse

ShipmentOtpEventType

aggregatorsConfig

orderTransactions

paymentLinkDetail

paymentModeRoutes

posPaymentModeRoutes

redirectToAggregator

AddBeneficiaryDetailsOTPRequestInput

AddBeneficiaryDetailsRequestInput

AddBeneficiaryInput

AddBeneficiaryViaOtpVerificationRequestInput

AddressAsPerIDInput

AttachCardRequestInput

BankDetailsForOTPInput

BeneficiaryDetailsInput

BusinessInfoInput

CancelOrResendPaymentLinkRequestInput

ChargeCustomerRequestInput

CreateOrderUserRequestInput

CreatePaymentLinkRequestInput

CustomerAndCreditSummary

CustomerOnboardingRequestInput

DeleteBeneficiaryInput

DeletehCardRequestInput

MarketplaceInfoInput

PaymentInitializationRequestInput

PaymentMethodsInput

PaymentMethodsMetaOrderInput

PaymentOrderInput

PaymentOrderMethodsInput

PaymentStatusUpdateRequestInput

PersonalInfoInput

RenderHTMLRequestInput

ResendOrCancelPaymentRequestInput

SetDefaultBeneficiaryRequestInput

UpdateRefundTransferModeRequestInput

ValidateCustomerRequestInput

ValidateVPARequestInput

WalletDelinkRequestSchemaInput

WalletLinkRequestSchemaInput

WalletOtpRequestInput

WalletVerifyRequestSchemaInput

getRefundBeneficiaryInput

ActiveCardAggregator

ActiveCardAggregatorCardInfo

ActiveRefundTransferModes

AddBeneficiaryResponseDetails

AddBeneficiaryViaOtpVerificationResponse

AdvancePaymentObject

AggregatorRouteDetail

AggregatorsConfigDetail

AmountAvailable

AttachCardsResponse

BankBeneficiary

BeneficiaryDetails

CCAvenueAggregatorConfig

CancelPaymentLinkResponse

ChargeCustomerResponse

CreateOrderUserData

CreateOrderUserResponse

CreatePaymentLinkResponse

CreditAccountSummary

CreditAndCustomerValidation

CustomerOnboardingResponse

DeleteCardsResponse

EpayLaterKYCDetail

EpaylaterBanner

GetRefundBeneficiary

IntentAppErrorList

JusPayAggregatorConfig

MSwipeAggregatorConfig

OrderBeneficiaryDetail

OrderTransactionDetail

OrderTransactionItem

OutstandingOrderDetail

PaymentDefaultSelection

PaymentFlowDetail

PaymentInitializationResponse

PaymentLinkDetail

PaymentModeList

PaymentModeRouteDetail

PaymentOptionDetails

PaymentOrderData

PaymentOrderDetails

PaymentStatusUpdateResponse

PayuMoneyAggregatorConfig

PollingPaymentLinkDetail

RazorPayAggregatorConfig

RedirectToAggregatorDetail

RefundAccountResponse

RenderHtmlResponse

ResendOrCancelPaymentResponse

ResendPaymentLinkResponse

RootPaymentMode

RupifiKYCDetail

RupifyAggregatorConfig

SetDefaultBeneficiaryResponse

SimplAggregatorConfig

SplitConfigurationDetail

SplitPaymentTimeout

SplitTransactionLimit

StoredPaymentDetails

StripeAggregatorConfig

SupportedMethodDetails

UpdateRefundTransferModeResponse

UserCreditLimit

UserCreditSummary

ValidateCustomerResponse

ValidateVPAResponse

WalletOtpResponse

PaymentStatusUpdateResponseStatus

attributesDefinition

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

OrderingChannel

RegistrationType

UserAttributeRegistrationType

object

Logout

Schema representing the response received upon a successful logout operation.

Fields

logout

Whether the logout operation was successful.

« LoginSuccess