Query

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

Fields

Anchor

assets (AssetConnection)

List of assets.

Argument	Description
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
id (ID)	Only list assets that match the passed Firmhouse ID
internalNumber (String)	Only list assets that match the passed internal number
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.

Anchor

currentCart (Cart)

Returns current cart calculations object identified by X-Subscription-Token.

Anchor

discountCodes (DiscountCodeConnection)

List of discount codes.

Argument	Description
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.

Anchor

getCollectionCase (CollectionCase)

Fetch a collection case by id.

Argument	Description
id (ID)

Anchor

getCurrentProject (Project)

Returns the project identified by current access token.

Anchor

getDiscountCode (DiscountCode)

Get discount code details. Fetch by code is case-insensitive.

Argument	Description
code (ID!)

Anchor

getInvoice (Invoice)

Fetch an invoice by token or id.

Argument	Description
token (ID)
id (ID)

Anchor

getOrder (Order)

Fetch an order

Argument	Description
id (ID!)

Anchor

getOrderBy (Order)

Fetch an order

Argument	Description
id (ID)
shopifyId (String)

Anchor

getOrderCalculations (OrderCalculation)

Deprecated: Will be removed.

Calculate order prices

Argument	Description
orderedProducts ([OrderedProductInput!])	The ordered products that are part of the order
discountCode (String)

Anchor

getOrders ([Order!])

Deprecated: Use `orders` connection instead.

List of orders

Anchor

getPayment (Payment)

Fetch a payment by id or token.

Argument	Description
id (ID)
token (ID)

Anchor

getRefund (Refund)

Fetch a refund by id or payment id.

Argument	Description
id (ID)
paymentId (ID)

Anchor

getServiceChannelBy (ServiceChannel)

Fetch a service channel by id or slug.

Argument	Description
id (ID)	Only list service channels that match the passed in ID
slug (String)	Only list service channels that match the passed in slug

Anchor

getSubscription (Subscription)

Get subscription details.

Argument	Description
token (ID!)

Anchor

getSubscriptionBySelfServiceCenterLoginToken (Subscription!)

Fetch subscription by self service center login token.

Argument	Description
token (ID!)

Anchor

getSubscriptions ([Subscription!])

Deprecated: Use the `subscriptions` connection instead.

Returns paginated list of all subscriptions

Argument	Description
limit (Int)
offset (Int)
updatedSince (Int)

Anchor

invoices (InvoiceConnection)

List of invoices.

Argument	Description
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.
updatedSince (ISO8601DateTime)	Filter invoices to those that where updated since the given datetime.
updatedUntil (ISO8601DateTime)	Filter invoices to those that where updated 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.

Anchor

orderedProducts (OrderedProductsWithSummaryConnection)

List of ordered products

Argument	Description
shipmentDateFrom (ISO8601DateTime)	Filter ordered products with a shipment date on or later then.
shipmentDateTo (ISO8601DateTime)	Filter ordered products with a shipment date on or prior too.
subscriptionStatuses ([SubscriptionStatus!])	Filter on subscriptions status(es).
productIds ([ID!])	Filter on product id(s).
productSkus ([String!])	The product SKU(s) to filter on.
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.

Anchor

orders (OrderConnection)

List of orders

Argument	Description
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.
updatedSince (ISO8601DateTime)	Filter orders to those that where updated since the given datetime.
updatedUntil (ISO8601DateTime)	Filter orders to those that where updated until 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.

Anchor

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.

Argument	Description
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.
updatedSince (ISO8601DateTime)	Filter invoices to those that where updated since the given datetime.
updatedUntil (ISO8601DateTime)	Filter invoices to those that where updated 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.
excludePending (Boolean)	Exclude invoices that have payment status PENDING. Useful for treating payments underway as not-outstanding.
excludeDebtCollectionCases (Boolean)	Exclude invoices that have a debt collection case
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.

Anchor

payments (PaymentConnection)

List of payments.

Argument	Description
statuses ([PaymentStatusEnum!])	Filter payments on given status. Lists all payments if none given.
subscriptionId (ID)	Only list payments that match the passed in subscription ID.
updatedSince (ISO8601DateTime)	Filter payments to those that where updated since the given datetime.
updatedUntil (ISO8601DateTime)	Filter payments to those that where updated until the given datetime.
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.

Anchor

plans (PlanConnection)

List of plans.

Argument	Description
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.

Anchor

products (ProductConnection)

List of products.

Argument	Description
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
updatedSince (ISO8601DateTime)	Filter products to those that where updated since the given datetime.
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.

Anchor

returnOrders (ReturnOrderConnection)

List of return orders.

Argument	Description
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.

Anchor

subscriptions (SubscriptionConnection)

List of subscriptions

Argument	Description
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.
updatedSince (ISO8601DateTime)	Filter subscriptions to those who were updated since the given datetime.
updatedUntil (ISO8601DateTime)	Filter subscriptions to those that where updated until the given datetime.
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 (case-insensitive).
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.