Choose a version:

getShopifyCookies
utility

Parses cookie string and returns Shopify cookies.

Anchor to getShopifyCookies
getShopifyCookies(
cookies
)

If the Shopify cookies doesn't exist, this method will return empty string for each missing cookie.

Anchor to getShopifyCookies-parametersParameters

Anchor to cookies cookies string required

Anchor to getShopifyCookies-returnsReturns

ShopifyCookies

_shopify_s string: Shopify session token: Value of _shopify_s cookie.
_shopify_y string: Shopify unique user token: Value of _shopify_y cookie.

GetShopifyCookiesGeneratedType

cookies
```
string
```

ShopifyCookies

ShopifyCookies

export function getShopifyCookies(cookies: string): ShopifyCookies {
  const cookieData = parse(cookies);
  return {
    [SHOPIFY_Y]: cookieData[SHOPIFY_Y] || '',
    [SHOPIFY_S]: cookieData[SHOPIFY_S] || '',
  };
}

ShopifyCookies

_shopify_s
Shopify session token: Value of `_shopify_s` cookie.
```
string
```
_shopify_y
Shopify unique user token: Value of `_shopify_y` cookie.
```
string
```

{
  /** Shopify unique user token: Value of `_shopify_y` cookie. */
  [SHOPIFY_Y]: string;
  /** Shopify session token: Value of `_shopify_s` cookie. */
  [SHOPIFY_S]: string;
}

Was this section helpful?

Anchor to shopifycookiesShopifyCookies

Shopify cookies names

Anchor to _shopify_s _shopify_s string required: Shopify session token: Value of _shopify_s cookie.
Anchor to _shopify_y _shopify_y string required: Shopify unique user token: Value of _shopify_y cookie.

ShopifyCookies

_shopify_s
Shopify session token: Value of `_shopify_s` cookie.
```
string
```
_shopify_y
Shopify unique user token: Value of `_shopify_y` cookie.
```
string
```

{
  /** Shopify unique user token: Value of `_shopify_y` cookie. */
  [SHOPIFY_Y]: string;
  /** Shopify session token: Value of `_shopify_s` cookie. */
  [SHOPIFY_S]: string;
}

Was this section helpful?

Example code

import * as React from 'react';

import {useEffect} from 'react';

import {getShopifyCookies} from '@shopify/hydrogen';

export default function App({Component, pageProps}) {

useEffect(() => {

getShopifyCookies(document.cookie);

});

return <Component {...pageProps} />;

}

examples

Example code

description

I am the default example

JavaScript

import * as React from 'react';
import {useEffect} from 'react';
import {getShopifyCookies} from '@shopify/hydrogen';

export default function App({Component, pageProps}) {
  useEffect(() => {
    getShopifyCookies(document.cookie);
  });

  return <Component {...pageProps} />;
}

TypeScript

import * as React from 'react';
import {useEffect} from 'react';
import {getShopifyCookies} from '@shopify/hydrogen';

export default function App({Component, pageProps}) {
  useEffect(() => {
    getShopifyCookies(document.cookie);
  });

  return <Component {...pageProps} />;
}