Rest.md

shopify.clients.Rest

Instances of this class can make requests to the Shopify Admin REST API.

Constructor

Example

// Requests to /my-endpoint must be made with authenticatedFetch for embedded apps
app.get('/my-endpoint', async (req, res) => {
  const sessionId = await shopify.session.getCurrentId({
    isOnline: true,
    rawRequest: req,
    rawResponse: res,
  });

  // use sessionId to retrieve session from app's session storage
  // getSessionFromStorage() must be provided by application
  const session = await getSessionFromStorage(sessionId);

  const client = new shopify.clients.Rest({
    session,
    apiVersion: ApiVersion.January23,
  });
});

Parameters

Receives an object containing:

session

Session | ❗ required

The Shopify Session containing an access token to the API.

apiVersion

ApiVersion

This will override the default API version. Any requests made by this client will reach this version instead.

Get

Sends a GET request to the Admin API.

Example

const getResponse = await client.get({
  path: 'products',
});
console.log(getResponse.headers, getResponse.body);

Note: If using TypeScript, you can also pass in a type argument to cast the response body:

interface MyResponseBodyType {
  products: {
    /* ... */
  };
}

const response = await client.get<MyResponseBodyType>({
  path: 'products',
});

// response.body will be of type MyResponseBodyType
console.log(response.body.products);

Parameters

path

string | ❗ required

The requested API endpoint path. This can be one of two formats:

• The path starting after the /admin/api/{version}/ prefix, such as 'products', which executes /admin/api/{version}/products.json, where {version} is obtained from the library configuration (see shopifyApi.
• The full path, such as /admin/oauth/access_scopes.json

query

{[key: string]: string | number}

An optional query argument object to append to the request URL.

extraHeaders

{[key: string]: string | number}

Add custom headers to the request.

type

DataType | Defaults to DataType.JSON

The Content-Type for the request (JSON, GraphQL, URLEncoded).

tries

number | Defaults to 1, must be >= 0

The maximum number of times to retry the request.

Return

Promise<RequestResponse>

Returns an object containing:

Headers

{[key: string]: string | string[]}

The HTTP headers in the response from Shopify.

Body

any

The HTTP body in the response from Shopify.

Delete

Sends a DELETE request to the Admin API.

Example

const deleteResponse = await client.delete({
  path: 'products/123456',
});
console.log(deleteResponse.headers, deleteResponse.body);

Parameters

Takes the same parameters as the get method.

Return

Promise<RequestResponse>

Returns the same object as the get method.

Post

Sends a POST request to the Admin API.

Example

const postResponse = await client.post({
  path: 'products',
  data: {
    title: 'My product title',
  },
});
console.log(postResponse.headers, postResponse.body);

Parameters

Takes the same parameters as the get method, with the addition of:

data

{[key: string]: unknown} | string

The request payload.

Return

Promise<RequestResponse>

Returns the same object as the get method.

Put

Sends a PUT request to the Admin API.

Example

const putResponse = await client.put({
  path: 'products/123456',
  data: {
    title: 'My product title',
  },
});
console.log(putResponse.headers, putResponse.body);

Parameters

Takes the same parameters as the post method.

Return

Promise<RequestResponse>

Returns the same object as the get method.

Back to shopify.clients