Typed Storefront

A simple, lightweight, explicit library for interacting with the Shopify Storefront API

Example

1import shopify, { ProductVariant, SelectedProductOption, LineIem } from 'typed-shopify-storefront'
2
3const client = shopify({
4    accessToken: 'somestore_storefront_token',
5    domain: 'somestore.myshopify.com'
6})
7
8(async () => {
9    // Fetch all products within store
10    const collection = await client.product.all()
11
12    // Fetch data of a single product
13    const product = await client.product.get(collection[0])
14
15    // Find a product variant from selected options
16    const options: SelectedProductOptions[] = [
17        { name: "Color", value: "Black" },
18        { name: "Size", value: "1" }
19    ]
20    const variant = client.product.findVariant(product.variants, options)
21
22    // Create a checkout
23    const cart: LineItem[] = [
24        { variantId: variant.id, amount: 1 }
25    ]
26    const checkout = await client.checkout.create(cart)
27
28    console.log(checkout.webUrl)
29})

Documentation

Initialize the client

1const  client = shopify({
2    accessToken:  'somestore_storefront_token',
3    domain:  'somestore.myshopify.com'
4})

Once initialized, the client object is created with methods for interacting with the Shopify API.

Product

Method	Description	Parameters	Returns
all()	Retrieves all products from the store.	None	Collection
get(handle)	Retrieves a product by its handle.	handle: string	Product
findVariant(variants, selectedOptions)	Finds a variant of a product based on selected options.	variants: ProductVariant[], selectedOptions: SelectedProductOption[]	ProductVariant | undefined

Checkout

Method	Description	Parameters	Returns
create(lineItems)	Creates a new checkout with specified line items.	lineItems: LineItem[]	Checkout