Choose a version:

cartMetafieldsSetDefault

Creates a function that accepts an array of CartMetafieldsSetInput without ownerId and set the metafields to a cart

Anchor to cartMetafieldsSetDefault
cartMetafieldsSetDefault(
options
)

Anchor to cartMetafieldsSetDefault-parametersParameters

Anchor to options options required

Anchor to cartMetafieldsSetDefault-returnsReturns

CartQueryOptions

cartFragment
The cart fragment to override the one used in this query.
```
string
```
customerAccount
The customer account instance created by [`createCustomerAccount`](docs/api/hydrogen/latest/customer/createcustomeraccount).
```
CustomerAccount
```
getCartId
A function that returns the cart ID.
```
() => string
```
storefront
The storefront client instance created by [`createStorefrontClient`](docs/api/hydrogen/latest/utilities/createstorefrontclient).
```
Storefront
```

CustomerAccount

authorize
On successful login, the customer redirects back to your app. This function validates the OAuth response and exchanges the authorization code for an access token and refresh token. It also persists the tokens on your session. This function should be called and returned from the Remix loader configured as the redirect URI within the Customer Account API settings in admin.
```
() => Promise<Response>
```
getAccessToken
Returns CustomerAccessToken if the customer is logged in. It also run a expiry check and does a token refresh if needed.
```
() => Promise<string>
```
getApiUrl
Creates the fully-qualified URL to your store's GraphQL endpoint.
```
() => string
```
getBuyer
Get buyer token and company location id from session.
```
() => Promise<Partial<BuyerInput>>
```
handleAuthStatus
Check for a not logged in customer and redirect customer to login page. The redirect can be overwritten with `customAuthStatusHandler` option.
```
() => Promise<void>
```
i18n
The i18n configuration for Customer Account API
```
{ language: LanguageCode; }
```
isLoggedIn
Returns if the customer is logged in. It also checks if the access token is expired and refreshes it if needed.
```
() => Promise<boolean>
```
login
Start the OAuth login flow. This function should be called and returned from a Remix loader. It redirects the customer to a Shopify login domain. It also defined the final path the customer lands on at the end of the oAuth flow with the value of the `return_to` query param. (This is automatically setup unless `customAuthStatusHandler` option is in use)
```
(options?: LoginOptions) => Promise<Response>
```
logout
Logout the customer by clearing the session and redirecting to the login domain. It should be called and returned from a Remix action. The path app should redirect to after logout can be setup in Customer Account API settings in admin.
```
(options?: LogoutOptions) => Promise<Response>
```

mutate

Execute a GraphQL mutation against the Customer Account API. This method execute `handleAuthStatus()` ahead of mutation.

<
    OverrideReturnType extends any = never,
    RawGqlString extends string = string,
  >(
    mutation: RawGqlString,
    ...options: ClientVariablesInRestParams<
      CustomerAccountMutations,
      RawGqlString
    >
  ) => Promise<
    Omit<
      CustomerAPIResponse<
        ClientReturn<CustomerAccountMutations, RawGqlString, OverrideReturnType>
      >,
      'errors'
    > & {errors?: JsonGraphQLError[]}
  >

query

Execute a GraphQL query against the Customer Account API. This method execute `handleAuthStatus()` ahead of query.

<
    OverrideReturnType extends any = never,
    RawGqlString extends string = string,
  >(
    query: RawGqlString,
    ...options: ClientVariablesInRestParams<
      CustomerAccountQueries,
      RawGqlString
    >
  ) => Promise<
    Omit<
      CustomerAPIResponse<
        ClientReturn<CustomerAccountQueries, RawGqlString, OverrideReturnType>
      >,
      'errors'
    > & {errors?: JsonGraphQLError[]}
  >

setBuyer
Set buyer information into session.
```
(buyer: Partial<BuyerInput>) => void
```
UNSTABLE_getBuyer
Deprecated. Please use getBuyer. Get buyer token and company location id from session.
```
() => Promise<Partial<BuyerInput>>
```
UNSTABLE_setBuyer
Deprecated. Please use setBuyer. Set buyer information into session.
```
(buyer: Partial<BuyerInput>) => void
```

LoginOptions

acrValues
```
string
```
countryCode
```
CountryCode
```
locale
```
string
```
loginHint
```
string
```
loginHintMode
```
string
```
uiLocales
```
LanguageCode
```

LogoutOptions

headers
Add custom headers to the logout redirect.
```
HeadersInit
```
keepSession
If true, custom data in the session will not be cleared on logout.
```
boolean
```
postLogoutRedirectUri
The url to redirect customer to after logout, should be a relative URL. This url will need to included in Customer Account API's application setup for logout URI. The default value is current app origin, which is automatically setup in admin when using `--customer-account-push` flag with dev.
```
string
```

CustomerAccountMutations

CustomerAPIResponse

data
```
ReturnType
```

errors

Array<{
    message: string;
    locations?: Array<{line: number; column: number}>;
    path?: Array<string>;
    extensions: {code: string};
  }>

extensions

{ cost: { requestQueryCost: number; actualQueryCakes: number; throttleStatus: { maximumAvailable: number; currentAvailable: number; restoreRate: number; }; }; }

JsonGraphQLError

extensions
Reserved for implementors to extend the protocol however they see fit, and hence there are no additional restrictions on its contents.
```
{ [key: string]: unknown; }
```
locations
If an error can be associated to a particular point in the requested GraphQL document, it should contain a list of locations.
```
{ line: number; column: number; }[]
```
message
```
string
```
name
```
string
```
path
If an error can be associated to a particular field in the GraphQL result, it _must_ contain an entry with the key `path` that details the path of the response field which experienced the error. This allows clients to identify whether a null result is intentional or caused by a runtime error.
```
(string | number)[]
```
stack
```
string
```

CustomerAccountQueries

Storefront

Interface to interact with the Storefront API.

cache
The **`Cache`** interface provides a persistent storage mechanism for Request / Response object pairs that are cached in long lived memory. Available only in secure contexts. [MDN Reference](https://developer.mozilla.org/docs/Web/API/Cache)
```
Cache
```

CacheCustom

(overrideOptions: AllCacheOptions) => AllCacheOptions

CacheLong

(overrideOptions?: AllCacheOptions) => AllCacheOptions

CacheNone
```
() => NoStoreStrategy
```

CacheShort

(overrideOptions?: AllCacheOptions) => AllCacheOptions

forward

Forwards the request to the Storefront API. It reads the API version from the request URL.

(request: Request, options?: Pick<StorefrontCommonExtraParams, "storefrontApiVersion">) => Promise<Response>

forwardMcp
Forwards the request to the Storefront MCP endpoint.
```
(request: Request) => Promise<Response>
```

generateCacheControlHeader

(cacheOptions: AllCacheOptions) => string

getApiUrl

(props?: Partial<Pick<StorefrontClientProps, "storefrontApiVersion" | "storeDomain">>) => string

getHeaders
```
() => Record<string, string>
```

getPrivateTokenHeaders

(props?: Partial<Pick<StorefrontClientProps, "contentType">> & Pick<StorefrontClientProps, "privateStorefrontToken"> & { buyerIp?: string; }) => Record<string, string>

getPublicTokenHeaders

(props?: Partial<Pick<StorefrontClientProps, "contentType">> & Pick<StorefrontClientProps, "publicStorefrontToken">) => Record<string, string>

getShopifyDomain

(props?: Partial<Pick<StorefrontClientProps, "storeDomain">>) => string

i18n
```
TI18n
```
isMcpUrl
Checks if the request URL matches the Storefront MCP endpoint.
```
(request: { url?: string; }) => boolean
```
isStorefrontApiUrl
Checks if the request URL matches the Storefront API GraphQL endpoint.
```
(request: { url?: string; }) => boolean
```

mutate

<
    OverrideReturnType extends any = never,
    RawGqlString extends string = string,
  >(
    mutation: RawGqlString,
    ...options: ClientVariablesInRestParams<
      StorefrontMutations,
      RawGqlString,
      StorefrontCommonExtraParams,
      AutoAddedVariableNames
    >
  ) => Promise<
    ClientReturn<StorefrontMutations, RawGqlString, OverrideReturnType> &
      StorefrontError
  >

query

<
    OverrideReturnType extends any = never,
    RawGqlString extends string = string,
  >(
    query: RawGqlString,
    ...options: ClientVariablesInRestParams<
      StorefrontQueries,
      RawGqlString,
      StorefrontCommonExtraParams & Pick<StorefrontQueryOptions, 'cache'>,
      AutoAddedVariableNames
    >
  ) => Promise<
    ClientReturn<StorefrontQueries, RawGqlString, OverrideReturnType> &
      StorefrontError
  >

setCollectedSubrequestHeaders
Sets the collected subrequest headers in the response. Useful to forward the cookies and server-timing headers from server subrequests to the browser.
```
(response: { headers: Headers; }) => void
```

AllCacheOptions

Override options for a cache strategy.

maxAge
The maximum amount of time in seconds that a resource will be considered fresh. See `max-age` in the [MDN docs](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Cache-Control#:~:text=Response%20Directives-,max%2Dage,-The%20max%2Dage).
```
number
```
mode
The caching mode, generally `public`, `private`, or `no-store`.
```
string
```
sMaxAge
Similar to `maxAge` but specific to shared caches. See `s-maxage` in the [MDN docs](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Cache-Control#s-maxage).
```
number
```
staleIfError
Indicate that the cache should serve the stale response if an error occurs while revalidating the cache. See `stale-if-error` in the [MDN docs](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Cache-Control#stale-if-error).
```
number
```
staleWhileRevalidate
Indicate that the cache should serve the stale response in the background while revalidating the cache. See `stale-while-revalidate` in the [MDN docs](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Cache-Control#stale-while-revalidate).
```
number
```

NoStoreStrategy

mode
```
string
```

StorefrontCommonExtraParams

displayName
```
string
```
headers
```
HeadersInit
```
storefrontApiVersion
```
string
```

StorefrontClientProps

contentType
Customizes which `"content-type"` header is added when using `getPrivateTokenHeaders()` and `getPublicTokenHeaders()`. When fetching with a `JSON.stringify()`-ed `body`, use `"json"`. When fetching with a `body` that is a plain string, use `"graphql"`. Defaults to `"json"` Can also be customized on a call-by-call basis by passing in `'contentType'` to both `getPrivateTokenHeaders({...})` and `getPublicTokenHeaders({...})`, for example: `getPublicTokenHeaders({contentType: 'graphql'})`
```
'json' | 'graphql'
```
privateStorefrontToken
The Storefront API delegate access token. Refer to the [authentication](https://shopify.dev/api/storefront#authentication) and [delegate access token](https://shopify.dev/apps/auth/oauth/delegate-access-tokens) documentation for more details.
```
string
```
publicStorefrontToken
The Storefront API access token. Refer to the [authentication](https://shopify.dev/api/storefront#authentication) documentation for more details.
```
string
```
storeDomain
The host name of the domain (eg: `{shop}.myshopify.com`).
```
string
```
storefrontApiVersion
The Storefront API version. This should almost always be the same as the version Hydrogen React was built for. Learn more about Shopify [API versioning](https://shopify.dev/api/usage/versioning) for more details.
```
string
```

StorefrontMutations

Maps all the mutations found in the project to variables and return types.

AutoAddedVariableNames

'country' | 'language'

StorefrontError

errors
```
StorefrontApiErrors
```

StorefrontApiErrors

JsonGraphQLError[] | undefined

StorefrontQueries

Maps all the queries found in the project to variables and return types.

StorefrontQueryOptions

StorefrontCommonExtraParams & {
  query: string;
  mutation?: never;
  cache?: CachingStrategy;
}

CachingStrategy

Use the `CachingStrategy` to define a custom caching mechanism for your data. Or use one of the pre-defined caching strategies: CacheNone, CacheShort, CacheLong.

maxAge
The maximum amount of time in seconds that a resource will be considered fresh. See `max-age` in the [MDN docs](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Cache-Control#:~:text=Response%20Directives-,max%2Dage,-The%20max%2Dage).
```
number
```
mode
The caching mode, generally `public`, `private`, or `no-store`.
```
string
```
sMaxAge
Similar to `maxAge` but specific to shared caches. See `s-maxage` in the [MDN docs](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Cache-Control#s-maxage).
```
number
```
staleIfError
Indicate that the cache should serve the stale response if an error occurs while revalidating the cache. See `stale-if-error` in the [MDN docs](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Cache-Control#stale-if-error).
```
number
```
staleWhileRevalidate
Indicate that the cache should serve the stale response in the background while revalidating the cache. See `stale-while-revalidate` in the [MDN docs](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Cache-Control#stale-while-revalidate).
```
number
```

Headers

CartMetafieldsSetFunction

metafields
```
MetafieldWithoutOwnerId[]
```
optionalParams
```
CartOptionalInput
```

returns

Promise<CartQueryDataReturn>

MetafieldWithoutOwnerId

CartOptionalInput

cartId
The cart id.
```
string
```
country
The country code.
```
CountryCode
```
language
The language code.
```
LanguageCode
```
visitorConsent
Visitor consent preferences for the Storefront API's
```
VisitorConsent
```

VisitorConsent

analytics
```
ConsentStatus
```
marketing
```
ConsentStatus
```
preferences
```
ConsentStatus
```
sale_of_data
```
ConsentStatus
```

ConsentStatus

boolean | undefined

CartQueryDataReturn

CartQueryData & {
  errors?: StorefrontApiErrors;
}

CartQueryData

cart
A cart represents the merchandise that a buyer intends to purchase, and the estimated cost associated with the cart, throughout a customer's session. Use the [`checkoutUrl`](https://shopify.dev/docs/api/storefront/current/objects/Cart#field-checkoutUrl) field to direct buyers to Shopify's web checkout to complete their purchase. Learn more about [interacting with carts](https://shopify.dev/docs/storefronts/headless/building-with-the-storefront-api/cart/manage).
```
Cart
```

userErrors

| CartUserError[]
    | MetafieldsSetUserError[]
    | MetafieldDeleteUserError[]

warnings
```
CartWarning[]
```

Cart

attributes

The cart's attributes.

{ __typename?: "Attribute"; key?: string; value?: string; }[]

buyerIdentity
The cart's buyer identity.
```
CartType['buyerIdentity']
```
checkoutUrl
The checkout URL for the cart, if the cart has been created in the Storefront API.
```
string
```
cost
The cost for the cart, including the subtotal, total, taxes, and duties.
```
CartType['cost']
```

discountCodes

The discount codes applied to the cart.

{ __typename?: "CartDiscountCode"; applicable?: boolean; code?: string; }[]

id
The cart's ID if it has been created through the Storefront API.
```
string
```

lines

The cart lines.

Array<CartLine | ComponentizableCartLine>

note
The cart's note.
```
string
```
totalQuantity
The total number of items in the cart, across all lines. If there are no lines, then the value is 0.
```
number
```

CartUserError

MetafieldsSetUserError

MetafieldDeleteUserError

CartWarning

Examples

JavaScript

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

const cartSetMetafields = cartMetafieldsSetDefault({

storefront,

getCartId,

});

const result = await cartSetMetafields([

{

key: 'custom.gift',

type: 'boolean',

value: 'true',

]);