Choose a version:

App proxy

The authenticate.public.appProxy function validates app proxy requests made by Shopify, and returns a context to enable querying Shopify APIs.

Anchor to authenticate.public.appProxy
authenticate.public.appProxy(
request
)

Authenticates requests coming to the app from Shopify app proxies.

Anchor to authenticate.public.appProxy-parametersParameters

Anchor to request request Request required

Anchor to authenticate.public.appProxy-returnsReturns

Promise< | >

AppProxyContext

admin
No session is available for the shop that made this request. Therefore no methods for interacting with the GraphQL / REST Admin APIs are available.
```
undefined
```
liquid
A utility for creating a Liquid Response.
```
LiquidResponseFunction
```
session
No session is available for the shop that made this request. This comes from the session storage which `shopifyApp` uses to store sessions in your database of choice.
```
undefined
```
storefront
No session is available for the shop that made this request. Therefore no method for interacting with the Storefront API is available.
```
undefined
```

LiquidResponseFunction

body
```
string
```
initAndOptions
```
number | (ResponseInit & Options)
```

returns

Response

Options

layout
```
boolean
```

AppProxyContextWithSession

admin
Methods for interacting with the GraphQL / REST Admin APIs for the store that made the request.
```
AdminApiContext<Resources>
```
liquid
A utility for creating a Liquid Response.
```
LiquidResponseFunction
```
session
The session for the shop that made the request. This comes from the session storage which `shopifyApp` uses to store sessions in your database of choice. Use this to get shop or user-specific data.
```
Session
```
storefront
Method for interacting with the Shopify Storefront Graphql API for the store that made the request.
```
StorefrontContext
```

AdminApiContext

Provides utilities that apps can use to make requests to the Admin API.

graphql
Methods for interacting with the Shopify Admin GraphQL API
```
GraphQLClient
```
rest
Methods for interacting with the Shopify Admin REST API There are methods for interacting with individual REST resources. You can also make `GET`, `POST`, `PUT` and `DELETE` requests should the REST resources not meet your needs.
```
RestClientWithResources<Resources>
```

GraphQLClient

query
```
string
```
options
```
GraphQLQueryOptions
```

returns

Promise<Response>

GraphQLQueryOptions

apiVersion
```
ApiVersion
```
headers
```
{ [key: string]: any; }
```
tries
```
number
```
variables
```
QueryVariables
```

QueryVariables

[key: string]
```
any
```

RestClientWithResources

RemixRestClient & {resources: Resources}

RemixRestClient

session
```
Session
```

get

Performs a GET request on the given path.

(params: GetRequestParams) => Promise<Response>

post

Performs a POST request on the given path.

(params: PostRequestParams) => Promise<Response>

put

Performs a PUT request on the given path.

(params: PostRequestParams) => Promise<Response>

delete
Performs a DELETE request on the given path.
```
(params: GetRequestParams) => Promise<Response>
```

StorefrontContext

Provides utilities that apps can use to make requests to the Storefront API.

graphql
Method for interacting with the Shopify Storefront GraphQL API If you're getting incorrect type hints in the Shopify template, follow [these instructions](https://github.com/Shopify/shopify-app-template-remix/tree/main#incorrect-graphql-hints).
```
GraphQLClient
```

Examples

app/routes/**\/.ts

import { json } from "@remix-run/node";

import { authenticate } from "../shopify.server";

export async function action({ request }: ActionArgs) {

const { admin } = await authenticate.public.appProxy(request);

const response = await admin.graphql(

`#graphql

mutation populateProduct($input: ProductInput!) {

productCreate(input: $input) {

product {

}

}`,

{ variables: { input: { title: "Product Name" } } }

);

const productData = await response.json();

return json({ data: productData.data });

}

Examples

Description

Use the `admin` object to interact with the REST or GraphQL APIs.

app/routes/**\/.ts

import { json } from "@remix-run/node";
import { authenticate } from "../shopify.server";

export async function action({ request }: ActionArgs) {
  const { admin } = await authenticate.public.appProxy(request);

  const response = await admin.graphql(
    `#graphql
    mutation populateProduct($input: ProductInput!) {
      productCreate(input: $input) {
        product {
          id
        }
      }
    }`,
    { variables: { input: { title: "Product Name" } } }
  );

  const productData = await response.json();
  return json({ data: productData.data });
}

Description

Use the `liquid` helper to render a `Response` with Liquid content.

app/routes/**\/.ts

import {authenticate} from "~/shopify.server"

export async function loader({ request }) {
  const {liquid} = authenticate.public.appProxy(request);

  return liquid("Hello {{shop.name}}")
}

Description

Get your app's data using an offline session for the shop that made the request.

app/routes/**\/.ts

import { json } from "@remix-run/node";
import { authenticate } from "../shopify.server";
import { getMyAppModelData } from "~/db/model.server";

export const loader = async ({ request }) => {
  const { session } = await authenticate.public.appProxy(request);
  return json(await getMyAppModelData({shop: session.shop));
};

Description

Use the `storefront` object to interact with the GraphQL API.

app/routes/**\/.ts

import { json } from "@remix-run/node";
import { authenticate } from "../shopify.server";

export async function action({ request }: ActionArgs) {
  const { admin } = await authenticate.public.appProxy(request);

  const response = await storefront.graphql(`{blogs(first: 10) { edges { node { id } } } }`);

  return json(await response.json());
}