This guide covers a series of queries and mutations to handle typical storefront application scenarios.
Last updated
Was this helpful?
Let's set up our Firmhouse project before we begin. You can find step-by-step instructions to configure your project. Below is a list of things you should complete before we start:
Create products. You can follow .
If your project type is Product-as-a-service, Create at least one Plan to use as your default plan. You can follow .
Set up a payment provider.
Generate a Project Access Token by going to the Settings > Integrations page. For this tutorial a token with Storefront access type will be sufficient.
Fetching products
To display the products, you need to use the query. This query gives you all the information about the products you have set up in the Firmhouse Portal.
You can use after and first parameters to implement pagination. after variable expects a cursor which you can get from pageInfo.endCursor value from previous call.
We will pass the value of subscriptionToken in the X-Subscription-Token header for all subsequent calls. If you are creating a web app, you can store this value in a cookie or localStorage so that your customers can pick up where they left off when they return.
We will pass the value of token as a parameter for all subsequent calls. If you are creating a web app, you can store this value in a cookie or localStorage as shown in the example so that your customers can pick up where they left off when they return. getOrCreate method will return the existing cart if the token is provided and the cart has not been checked out yet, otherwise it will create a new cart.
Note that, if the default plan of your project includes products, they will be automatically added to the cart when you create it.
Adding products to the cart
const headers = new Headers({
'Content-Type': 'application/json',
'X-Project-Access-Token': token,
'X-Subscription-Token': subscriptionToken
})
const graphql = JSON.stringify({
query: `mutation CreateOrderedProduct($input: CreateOrderedProductInput!) {
createOrderedProduct(input: $input) {
errors
orderedProduct {
createdAt
graceCancellationEndsAt
id
interval
intervalUnitOfMeasure
maximumCommitmentEndsAt
metadata
minimumCommitmentEndsAt
priceExcludingTaxCents
priceIncludingTaxCents
productId
quantity
recurring
shipmentDate
status
title
totalAmountExcludingTaxCents
totalAmountIncludingTaxCents
totalOrdered
updatedAt
}
subscription {
amountForStartingSubscriptionCents
currency
metadata
monthlyAmount
monthlyAmountCents
orderedProducts {
createdAt
graceCancellationEndsAt
id
interval
intervalUnitOfMeasure
maximumCommitmentEndsAt
metadata
minimumCommitmentEndsAt
priceExcludingTaxCents
priceIncludingTaxCents
productId
quantity
recurring
status
title
totalAmountExcludingTaxCents
totalAmountIncludingTaxCents
totalOrdered
updatedAt
}
}
}
}
`,
variables: {
input: {
productId: products[0].id, // You can use any product id here
quantity: 1,
// metadatata: {key: "value"},
// ensureNewRecord: true,
}
}
})
const requestOptions = {
method: 'POST',
headers,
body: graphql,
};
const response = await fetch("https://portal.firmhouse.com/graphql", requestOptions)
const body = await response.json()
const { orderedProduct, subscription, errors } = body.data.createOrderedProduct
If you need to add metadata to the ordered product, you must use a project access token with Write permissions. You can add it using the metadata input variable. If you need to use different metadata for multiple orders of the same product, you can set the ensureNewRecord value to true. This will ensure that each time you use the endpoint, a new orderedProduct item is created with the specified metadata.
If you need to add metadata to the ordered product, you need to initialize firmhouse client with write permissions. You can add it using the metadata input variable. If you need to use different metadata for multiple orders of the same product, you can set the ensureNewRecord value to true. This will ensure that each time you use the endpoint, a new orderedProduct item is created with the specified metadata.
You can use the orderedProduct variable to display notifications about added products. To show cart information, such as all ordered products, total price, payment terms, etc., you can use the subscription variable.
Removing products from the cart
To let users remove products from their cart, you can use the destroyOrderedProduct mutation.
const headers = new Headers({
'Content-Type': 'application/json',
'X-Project-Access-Token': token,
'X-Subscription-Token': subscriptionToken
})
const graphql = JSON.stringify({
query: `mutation DestroyOrderedProduct($input: DestroyOrderedProductInput!) {
destroyOrderedProduct(input: $input) {
orderedProduct {
createdAt
graceCancellationEndsAt
id
interval
intervalUnitOfMeasure
maximumCommitmentEndsAt
metadata
minimumCommitmentEndsAt
priceExcludingTaxCents
priceIncludingTaxCents
productId
quantity
recurring
shipmentDate
status
title
totalAmountExcludingTaxCents
totalAmountIncludingTaxCents
totalOrdered
updatedAt
}
subscription {
amountForStartingSubscriptionCents
currency
metadata
monthlyAmount
monthlyAmountCents
orderedProducts {
createdAt
graceCancellationEndsAt
id
interval
intervalUnitOfMeasure
maximumCommitmentEndsAt
metadata
minimumCommitmentEndsAt
priceExcludingTaxCents
priceIncludingTaxCents
productId
quantity
recurring
status
title
totalAmountExcludingTaxCents
totalAmountIncludingTaxCents
totalOrdered
updatedAt
}
}
}
}
`,
variables: {
input: {
id: orderedProduct.id, // You can use any ordered product id here
}
}
})
const requestOptions = {
method: 'POST',
headers,
body: graphql,
};
const response = await fetch("https://portal.firmhouse.com/graphql", requestOptions)
const { errors, data } = await response.json()
const { orderedProduct: removedProduct, subscription } = data?.destroyOrderedProduct ?? {}
Updating the quantities of products in the cart
const headers = new Headers({
'Content-Type': 'application/json',
'X-Project-Access-Token': token,
'X-Subscription-Token': subscriptionToken
})
const graphql = JSON.stringify({
query: `mutation UpdateOrderedProductQuantity($input: UpdateOrderedProductQuantityInput!) {
updateOrderedProductQuantity(input: $input) {
orderedProduct {
createdAt
graceCancellationEndsAt
id
interval
intervalUnitOfMeasure
maximumCommitmentEndsAt
metadata
minimumCommitmentEndsAt
priceExcludingTaxCents
priceIncludingTaxCents
productId
quantity
recurring
shipmentDate
status
title
totalAmountExcludingTaxCents
totalAmountIncludingTaxCents
totalOrdered
updatedAt
}
subscription {
amountForStartingSubscriptionCents
currency
metadata
monthlyAmount
monthlyAmountCents
orderedProducts {
createdAt
graceCancellationEndsAt
id
interval
intervalUnitOfMeasure
maximumCommitmentEndsAt
metadata
minimumCommitmentEndsAt
priceExcludingTaxCents
priceIncludingTaxCents
productId
quantity
recurring
status
title
totalAmountExcludingTaxCents
totalAmountIncludingTaxCents
totalOrdered
updatedAt
}
}
}
}
`,
variables: {
input: {
orderedProduct: {
id: orderedProduct.id, // You can use any ordered product id here
quantity: 2
}
}
}
})
const requestOptions = {
method: 'POST',
headers,
body: graphql,
};
const response = await fetch("https://portal.firmhouse.com/graphql", requestOptions)
const body = await response.json()
const { orderedProduct: updatedProduct, subscription, errors } = body.data.updateOrderedProductQuantity
If any required fields are missing, the paymentUrl will be null and you can check which fields are missing in the errors variable.
If you haven't added a payment method to your Firmhouse project, this request will fail with a 500 error.
If your project's subscription type is Product as Service, you can use the query. This query gives you all the information about the plans you have set up in the Firmhouse Portal.
To start ordering products, you need to create a cart with mutation.
Once the cart is created, you can start adding items to it with mutation. Note that we're using the subscriptionToken value in X-Subscription-Token header.
There are additional options for querying the product to add apart from productId. You can find all these options .
The fields retrieved in this query are the same as those in . Therefore you can use the same logic to handle the response that updates the Cart UI or notifications.
To allow users to change the quantities of products in their shopping cart, you can use the mutation.
The fields retrieved in this query are the same as those in . Therefore you can use the same logic to handle the response that updates the Cart UI or notifications.
You can change the active subscription plan with mutation.
You can use query to get the current state of the cart. It's helpful when customers return to the application after leaving. You can use this query to retrieve cart information using the subscription token that you saved in a cookie or local storage. It's also useful for fetching details when they navigate to checkout page.
You can see the list of available fields for a subscription .
To update the subscription details, you can use the mutation. This is helpful for checkout pages where users can enter their payment, invoice, and shipping information.
By default, only the following fields are required to proceed to the payment stage: name, email, address, city, country. You can find the complete list of available input variables .
After you have added the products to your cart and filled in the required information using the mutation, you can use the mutation to create a payment link (paymentUrl). You can then direct the user to the payment provider with that link to complete the payment process. If the payment is successful, the user will be redirected to the returnUrl that you provided as parameter for the mutation.