For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Dev Portal
DocsAPI ReferenceLearnCommunityChangelog
DocsAPI ReferenceLearnCommunityChangelog
    • About Our APIs
  • REST
    • Overview
  • GraphQL
    • Overview
      • Playground
      • Explorer
          • MUTcreateCart
          • MUTdeleteCart
          • MUTaddCartLineItems
          • MUTupdateCartLineItem
          • MUTdeleteCartLineItem
          • MUTupdateCartCurrency
          • MUTassignCartToCustomer
          • MUTunassignCartFromCustomer
          • MUTcreateCartMetafield
          • MUTupdateCartMetafield
          • MUTdeleteCartMetafield
          • MUTcreateCartRedirectUrls
          • MUTcreateCheckout
          • MUTupdateCheckout
          • MUTaddCheckoutBillingAddress
          • MUTupdateCheckoutBillingAddress
          • MUTupdateCheckoutCustomerMessage
          • MUTselectCheckoutShippingOption
          • MUTapplyCheckoutCoupon
          • MUTunapplyCheckoutCoupon
          • MUTapplyCheckoutGiftCertificate
          • MUTunapplyCheckoutGiftCertificate
          • MUTapplyCheckoutSpamProtection
          • MUTaddCheckoutShippingConsignments
          • MUTupdateCheckoutShippingConsignment
          • MUTdeleteCheckoutConsignment
          • MUTcompleteCheckout
          • MUTlogin
          • MUTlogout
          • MUTcreateWishlist
          • MUTaddWishlistItems
          • MUTdeleteWishlistItems
          • MUTupdateWishlist
          • MUTdeleteWishlists
          • MUTloginWithCustomerLoginJwt
          • MUTsubmitContactUs
          • MUTgenerateSessionSyncJwt
          • MUTvalidateSessionSyncJwt
          • MUTproductViewedEvent
          • MUTpageViewedEvent
          • MUTvisitStartedEvent
          • MUTsearchProductEvent
          • MUTpreviewGiftCertificate
          • MUTregisterCompany
          • MUTaddProductReview
          • MUTchangePassword
          • MUTrequestResetPassword
          • MUTresetPassword
          • MUTregisterCustomer
          • MUTupdateCustomer
          • MUTaddCustomerAddress
          • MUTupdateCustomerAddress
          • MUTdeleteCustomerAddress
          • MUTpayment
          • MUTsubscribe
          • MUTunsubscribe
  • MCP
    • Overview
Dev Portal
LogoLogo
GraphQLStorefrontMutations

generateSessionSyncJwt

Example Query
1mutation ExampleMutation($redirectTo: String, $cartId: String, $paymentWalletData: PaymentWalletDataInput, $analytics: AnalyticsCommonEventInput) {
2 generateSessionSyncJwt(redirectTo: $redirectTo, cartId: $cartId, paymentWalletData: $paymentWalletData, analytics: $analytics) {
3 result {
4 token
5 url
6 }
7 errors
8 }
9}
Variables
1{
2 "redirectTo": "example",
3 "cartId": "example",
4 "paymentWalletData": {
5 "initializationId": "example",
6 "providerOrderId": "example",
7 "providerId": "example"
8 },
9 "analytics": {
10 "initiator": {
11 "visitId": "example",
12 "visitorId": "example"
13 },
14 "request": {
15 "url": "URL",
16 "userAgent": "example",
17 "refererUrl": "URL",
18 "ip": "IpAddress",
19 "acceptLanguage": "example"
20 },
21 "consent": {
22 "targeting": true,
23 "analytics": true,
24 "functional": true
25 }
26 }
27}
Example response
1{
2 "data": {
3 "generateSessionSyncJwt": {
4 "result": {
5 "token": "example",
6 "url": "example"
7 },
8 "errors": [
9 {
10 "message": "example"
11 }
12 ]
13 }
14 }
15}
Generate Session Sync JWT Token.
Was this page helpful?
Previous

submitContactUs

Next

validateSessionSyncJwt

Built with

Arguments

redirectToStringRequired
The route where to redirect after generation of token
cartIdStringOptional
The cartId for which token should be created.
paymentWalletDataPaymentWalletDataInputOptional
The payment wallet data.
analyticsAnalyticsCommonEventInputOptional
The analytics data.

Returns

a GenerateSessionSyncTokenResult
errorslist of GenerateSessionSyncTokenErrors
The errors that occurred during the mutation.
resultGenerateSessionSyncTokenData
The result of the mutation when successful.