The Firmhouse Logo [FH]
Developer Docs

Query

The Firmhouse GraphQL API query RootQuery. All your queries should start with the top-level objects defined in this query.

Fields

List of assets.
ArgumentDescription
statuses ([AssetStatus!])
Filter assets to those of specific statuses. Lists all assets if none given.
productId (ID)
Only list assets that match the passed in product ID
after (String)
Returns the elements in the list that come after the specified cursor.
before (String)
Returns the elements in the list that come before the specified cursor.
first (Int)
Returns the first _n_ elements from the list.
last (Int)
Returns the last _n_ elements from the list.
currentCart (Cart)
Returns current cart calculations object identified by X-Subscription-Token.
discountCodes (DiscountCodeConnection)
List of discount codes.
ArgumentDescription
redeemable (Boolean)
Only list discount codes that can be redeemed.
expired (Boolean)
Only list discount codes that are already fully used (expired).
after (String)
Returns the elements in the list that come after the specified cursor.
before (String)
Returns the elements in the list that come before the specified cursor.
first (Int)
Returns the first _n_ elements from the list.
last (Int)
Returns the last _n_ elements from the list.
getCurrentProject (Project)
Returns the project identified by current access token.
getDiscountCode (DiscountCode)
Get discount code details. Fetch by code is case-insensitive.
ArgumentDescription
code (ID!)
getInvoice (Invoice)
Fetch an invoice by token or id.
ArgumentDescription
token (ID)
id (ID)
getOrder (Order)
Fetch an order
ArgumentDescription
id (ID!)
getOrderBy (Order)
Fetch an order
ArgumentDescription
id (ID)
shopifyId (String)
getOrderCalculations (OrderCalculation)
Deprecated: Will be removed.
Calculate order prices
ArgumentDescription
orderedProducts ([OrderedProductInput!])
The ordered products that are part of the order
discountCode (String)
getOrders ([Order!])
Deprecated: Use `orders` connection instead.
List of orders
getPayment (Payment)
Fetch payment by token.
ArgumentDescription
token (ID!)
getSubscription (Subscription)
Get subscription details.
ArgumentDescription
token (ID!)
getSubscriptionBySelfServiceCenterLoginToken (Subscription!)
Fetch subscription by self service center login token.
ArgumentDescription
token (ID!)
getSubscriptions ([Subscription!])
Deprecated: Use the `subscriptions` connection instead.
Returns paginated list of all subscriptions
ArgumentDescription
limit (Int)
offset (Int)
updatedSince (Int)
List of invoices.
ArgumentDescription
invoicedSince (ISO8601DateTime)
Filter invoices to those that where invoiced since the given datetime.
invoicedUntil (ISO8601DateTime)
Filter invoices to those that where invoiced until the given datetime.
subscriptionId (ID)
Only list invoices that match the passed in subscription ID.
paymentTypes ([PaymentTypeEnum!])
Only list invoices with selected payment type. Lists all payment types if none given.
statuses ([InvoiceStatusEnum!])
Filter invoices on given status. Lists all invoices if none given.
after (String)
Returns the elements in the list that come after the specified cursor.
before (String)
Returns the elements in the list that come before the specified cursor.
first (Int)
Returns the first _n_ elements from the list.
last (Int)
Returns the last _n_ elements from the list.
List of orders
ArgumentDescription
paid (Boolean)
Only list orders with given payment status on related invoice.
createdSince (ISO8601DateTime)
Filter orders to those that where created since the given datetime.
status (OrderStatus)
Filter orders on given status. Lists all orders if none given.
after (String)
Returns the elements in the list that come after the specified cursor.
before (String)
Returns the elements in the list that come before the specified cursor.
first (Int)
Returns the first _n_ elements from the list.
last (Int)
Returns the last _n_ elements from the list.
outstandingInvoices (InvoiceConnection)
List of outstanding invoices. An invoice is outstanding when payment has not (yet) come in and when the invoice has not been credited.
ArgumentDescription
invoicedSince (ISO8601DateTime)
Filter invoices to those that where invoiced since the given datetime.
invoicedUntil (ISO8601DateTime)
Filter invoices to those that where invoiced until the given datetime.
subscriptionId (ID)
Only list invoices that match the passed in subscription ID.
paymentTypes ([PaymentTypeEnum!])
Only list invoices with selected payment type. Lists all payment types if none given.
excludePending (Boolean)
Exclude invoices that have payment status PENDING. Useful for treating payments underway as not-outstanding.
after (String)
Returns the elements in the list that come after the specified cursor.
before (String)
Returns the elements in the list that come before the specified cursor.
first (Int)
Returns the first _n_ elements from the list.
last (Int)
Returns the last _n_ elements from the list.
List of plans.
ArgumentDescription
after (String)
Returns the elements in the list that come after the specified cursor.
before (String)
Returns the elements in the list that come before the specified cursor.
first (Int)
Returns the first _n_ elements from the list.
last (Int)
Returns the last _n_ elements from the list.
List of products.
ArgumentDescription
id (ID)
Only list products that match the passed in ID
sku (String)
Only list products that match the passed in SKU
shopifyVariantId (String)
Only list products that match the passed in Shopify variant ID
after (String)
Returns the elements in the list that come after the specified cursor.
before (String)
Returns the elements in the list that come before the specified cursor.
first (Int)
Returns the first _n_ elements from the list.
last (Int)
Returns the last _n_ elements from the list.
returnOrders (ReturnOrderConnection)
List of return orders.
ArgumentDescription
statuses ([ReturnOrderStatus!])
Filter return orders to those of specific statuses. Lists all return orders if none given.
subscriptionId (ID)
Only list return orders that match the passed in subscription ID.
after (String)
Returns the elements in the list that come after the specified cursor.
before (String)
Returns the elements in the list that come before the specified cursor.
first (Int)
Returns the first _n_ elements from the list.
last (Int)
Returns the last _n_ elements from the list.
subscriptions (SubscriptionConnection)
List of subscriptions
ArgumentDescription
signupCompletedSince (ISO8601DateTime)
Filter subscriptions to those who completed their signup since a certain time.
signupCompletedUntil (ISO8601DateTime)
Filter subscriptions to those who completed their signup until a certain time.
ids ([ID!])
Filter subscriptions to those of specific IDs.
customerReferences ([String!])
Filter subscriptions to those of specific customer references.
statuses ([SubscriptionStatus!])
Filter subscriptions to those of specific statuses. Lists all subscriptions except DRAFT if none given.
email (String)
Filter subscriptions to those with a specific email address.
after (String)
Returns the elements in the list that come after the specified cursor.
before (String)
Returns the elements in the list that come before the specified cursor.
first (Int)
Returns the first _n_ elements from the list.
last (Int)
Returns the last _n_ elements from the list.