Address
A postal address.
Afterpay
An Afterpay payment source.
Airwallex
An Airwallex payment source.
BackoffPolicy
A policy for retrying requests with a growing delay between attempts.
CampaignDeposit
A deposit that a customer pays upfront when ordering from a campaign.
CampaignInventoryItem
The inventory for one product variant within a campaign item. It is created when the variant is first ordered.
CampaignItem
A product or product variant included in a campaign.
CampaignOrderCancelPayload
The result of the campaignOrderCancel mutation.
CampaignOrderConnection
The connection type for CampaignOrder.
CampaignOrderDecreaseQuantityPayload
The result of the campaignOrderDecreaseQuantity mutation.
CampaignOrderEdge
An edge in a connection.
CampaignOrderFinancials
The financial details of a campaign order.
CampaignOrderGroupCancelPayload
The result of the campaignOrderGroupCancel mutation.
CampaignOrderGroupConnection
The connection type for CampaignOrderGroup.
CampaignOrderGroupEdge
An edge in a connection.
CampaignOrderGroupFinancials
The financial details of a campaign order group.
CampaignOrderGroupMilestones
The dates and times of key events for a campaign order group.
CampaignOrderGroupRetryPaymentPayload
The result of the campaignOrderGroupRetryPayment mutation.
CampaignOrderGroup
A customer's campaign orders from one order in the sales channel.
CampaignOrderMilestones
The dates and times of key events for a campaign order.
CampaignOrderRetryFulfilmentPayload
The result of the campaignOrderRetryFulfilment mutation.
CampaignOrderRetryPaymentPayload
The result of the campaignOrderRetryPayment mutation.
CampaignOrder
An order for one product variant in a presale or crowdfunding campaign. It belongs to a campaign order group.
CardExpiry
A card's expiry month and year.
Card
A credit or debit card.
ChannelConfigSetPayload
The result of the channelConfigSet mutation.
Channel
A sales channel, such as a merchant's Shopify store.
ChargeConnection
The connection type for Charge.
ChargeEdge
An edge in a connection.
Charge
A charge made against a payment intent, such as an authorisation, capture or sale.
CountryConnection
The connection type for Country.
CountryEdge
An edge in a connection.
Country
A country, with the labels and provinces used in its addresses.
CrowdfundingCampaignApplyBulkInventoryPayload
The result of the crowdfundingCampaignApplyBulkInventory mutation.
CrowdfundingCampaignApplyInventoryPayload
The result of the crowdfundingCampaignApplyInventory mutation.
CrowdfundingCampaignArchivePayload
The result of the crowdfundingCampaignArchive mutation.
CrowdfundingCampaignCancelPayload
The result of the crowdfundingCampaignCancel mutation.
CrowdfundingCampaignConnection
The connection type for CrowdfundingCampaign.
CrowdfundingCampaignCreatePayload
The result of the crowdfundingCampaignCreate mutation.
CrowdfundingCampaignDeletePayload
The result of the crowdfundingCampaignDelete mutation.
CrowdfundingCampaignEdge
An edge in a connection.
CrowdfundingCampaignEndPayload
The result of the crowdfundingCampaignEnd mutation.
CrowdfundingCampaignFulfilPayload
The result of the crowdfundingCampaignFulfil mutation.
CrowdfundingCampaignLaunchPayload
The result of the crowdfundingCampaignLaunch mutation.
CrowdfundingCampaignUnarchivePayload
The result of the crowdfundingCampaignUnarchive mutation.
CrowdfundingCampaignUpdatePayload
The result of the crowdfundingCampaignUpdate mutation.
CrowdfundingCampaign
A campaign that takes orders towards a goal. Payment is captured only if the goal is met when the campaign ends.
CustomAttribute
A custom name and value attached to a subscription, subscription order or line.
Customer
A customer of a channel.
DeliverySlot
A date and time when a delivery can happen.
DiscountAgreementConnection
The connection type for DiscountAgreement.
DiscountAgreementContext
The customer and order details a discount was validated against.
DiscountAgreementEdge
An edge in a connection.
DiscountAgreement
An agreement that lets a customer use a discount. It records the context the discount was validated in and tracks its usage.
DiscountApplicationConnection
The connection type for DiscountApplication.
DiscountApplicationEdge
An edge in a connection.
DiscountApplication
The result of applying a discount agreement when prices are calculated.
DiscountCodeConnection
The connection type for DiscountCode.
DiscountCodeEdge
An edge in a connection.
DiscountCode
A code customers enter to redeem a discount.
DiscountFinancialsSet
The discounts on a subscription order or line, with their total, in shop and presentment currencies.
DiscountFinancials
The discounts on an order or line, with their total.
DiscountLineSet
A single discount applied to a subscription order or line, in shop and presentment currencies.
DiscountLine
A single discount applied to an order or line.
DiscountValue
The value of a discount, as a fixed amount or a percentage.
Discount
A discount that reduces the price of products, an order or shipping.
ErrorLogEntry
An error logged while validating a discount.
EventDiff
A single change recorded by a subscription event.
ExchangeRate
An exchange rate from a channel's shop currency to one of its presentment currencies.
ExportCreatePayload
The result of the exportCreate mutation.
Export
An export of subscriptions or subscription orders to a CSV file.
InventoryApplication
Inventory received for a campaign inventory item, ready to allocate to campaign orders.
Klarna
A Klarna payment source.
LineItem
A line item in an order, for one product variant.
MoneySet
An amount of money in both the shop currency and the presentment currency.
Money
An amount of money in a given currency.
NotificationScheduleTemplate
A channel's default notification schedule for one trigger. It sets how long
NotificationsConfig
A channel's notification settings.
Order
An order placed on a channel.
Organisation
A merchant's business. It owns one or more channels.
PageInfo
Pagination details for a connection.
PaginationResult
The results of a paginated search, identified by its query arguments.
PaymentInstrument
The means of payment behind a payment method, such as a card or PayPal billing
PaymentIntentAdjustment
An adjustment to a payment intent's amount. Positive amounts increase it and negative amounts reduce it.
PaymentIntentConnection
The connection type for PaymentIntent.
PaymentIntentEdge
An edge in a connection.
PaymentIntent
A payment intent.
PaymentMethodCancelPayload
The result of the paymentMethodCancel mutation.
PaymentMethodConnection
The connection type for PaymentMethod.
PaymentMethodEdge
An edge in a connection.
PaymentMethodSendUpdateEmailPayload
The result of the paymentMethodSendUpdateEmail mutation.
PaymentMethod
A customer payment method.
PaymentProcessor
A payment processor that processes payments, such as Shopify.
PaypalBillingAgreement
A PayPal billing agreement.
PaypalWallet
A PayPal wallet payment source.
PlatformConfig
A channel's Submarine settings, grouped by area.
PostalAddress
A postal address.
PresaleCampaignApplyBulkInventoryPayload
The result of the presaleCampaignApplyBulkInventory mutation.
PresaleCampaignApplyInventoryPayload
The result of the presaleCampaignApplyInventory mutation.
PresaleCampaignArchivePayload
The result of the presaleCampaignArchive mutation.
PresaleCampaignCancelPayload
The result of the presaleCampaignCancel mutation.
PresaleCampaignConnection
The connection type for PresaleCampaign.
PresaleCampaignCreatePayload
The result of the presaleCampaignCreate mutation.
PresaleCampaignDeletePayload
The result of the presaleCampaignDelete mutation.
PresaleCampaignEdge
An edge in a connection.
PresaleCampaignEndPayload
The result of the presaleCampaignEnd mutation.
PresaleCampaignFulfilPayload
The result of the presaleCampaignFulfil mutation.
PresaleCampaignLaunchPayload
The result of the presaleCampaignLaunch mutation.
PresaleCampaignUnarchivePayload
The result of the presaleCampaignUnarchive mutation.
PresaleCampaignUpdatePayload
The result of the presaleCampaignUpdate mutation.
PresaleCampaign
A campaign that takes orders for products before they're in stock, optionally with a deposit at checkout.
PresalesConfig
The presale and crowdfund settings for a channel.
PricingConfig
The pricing settings for a channel.
ProductCollectionItem
A product in a product collection.
ProductCollection
A collection of products.
ProductConnection
The connection type for Product.
ProductEdge
An edge in a connection.
ProductVariant
A variant of a product, such as a size or colour.
Product
A product.
Province
A subdivision of a country, such as a state or province.
RefundConnection
The connection type for Refund.
RefundEdge
An edge in a connection.
Refund
A refund against a payment intent.
SearchResult
The results of a search, identified by its query arguments.
ShippingFinancialsSet
The shipping charges on a subscription order or line, with their total, in shop and presentment currencies.
ShippingFinancials
The shipping charges on an order, with their total.
ShippingLineSet
A shipping charge on a subscription order, in shop and presentment currencies.
ShippingLine
A shipping charge on an order.
ShippingRate
A shipping rate available for an address.
ShippingRatesAvailablePayload
The result of the shippingRatesAvailable mutation.
SubscriptionAnchor
A delivery anchor for a subscription plan. It sets the day and time that the plan's deliveries fall on.
SubscriptionBacklogSize
The size of a subscription's backlog of scheduled orders, as a number of cycles or a length of time.
SubscriptionBillingBehaviour
When a subscription's orders are billed and processed, relative to their delivery date.
SubscriptionCancelPayload
The result of the subscriptionCancel mutation.
SubscriptionConnection
The connection type for Subscription.
SubscriptionDeliveryBehaviour
How delivery dates are set for subscription orders.
SubscriptionDeliveryMethodShipping
A delivery method that ships orders to an address.
SubscriptionDeliveryShippingOption
A shipping option for a subscription's deliveries.
SubscriptionDiagnosePayload
The result of the subscriptionDiagnose mutation.
SubscriptionDiscountActivatePayload
The result of the subscriptionDiscountActivate mutation.
SubscriptionDiscountApplyPayload
The result of the subscriptionDiscountApply mutation.
SubscriptionDiscountRemovePayload
The result of the subscriptionDiscountRemove mutation.
SubscriptionDiscountValidatePayload
The result of the subscriptionDiscountValidate mutation.
SubscriptionDiscount
A discount applied to a subscription or subscription order.
SubscriptionEdge
An edge in a connection.
SubscriptionEventConnection
The connection type for SubscriptionEvent.
SubscriptionEventEdge
An edge in a connection.
SubscriptionEvent
A record of an action on a subscription or one of its related resources, such as a subscription order or discount.
SubscriptionFixedDeliveryBehaviour
The delivery settings for subscriptions that deliver on fixed anchor dates.
SubscriptionFrequency
How often a subscription plan generates orders, with optional limits on the number of billing cycles.
SubscriptionGroupConnection
The connection type for SubscriptionGroup.
SubscriptionGroupEdge
An edge in a connection.
SubscriptionGroup
A set of subscriptions created together, such as from a single order.
SubscriptionHealthCheck
The result of one health test on a subscription.
SubscriptionInventoryBehaviour
The settings for how subscriptions handle stock.
SubscriptionLineAddPayload
The result of the subscriptionLineAdd mutation.
SubscriptionLineRemovePayload
The result of the subscriptionLineRemove mutation.
SubscriptionLineSetQuantityPayload
The result of the subscriptionLineSetQuantity mutation.
SubscriptionLine
A product variant that recurs on a subscription. Each upcoming subscription order gets a matching line.
SubscriptionOffset
A length of time between two subscription dates, such as how long before delivery an order is billed.
SubscriptionOrderConnection
The connection type for SubscriptionOrder.
SubscriptionOrderEdge
An edge in a connection.
SubscriptionOrderFinancialsSet
The financial details of a subscription order in shop and presentment currencies.
SubscriptionOrderFinancials
The financial details of a subscription order in the shop's currency.
SubscriptionOrderLineAddPayload
The result of the subscriptionOrderLineAdd mutation.
SubscriptionOrderLineFinancialsSet
The financial details of a subscription order line in shop and presentment currencies.
SubscriptionOrderLineFinancials
The financial details of a subscription order line in the shop's currency.
SubscriptionOrderLineRemovePayload
The result of the subscriptionOrderLineRemove mutation.
SubscriptionOrderLineSetQuantityPayload
The result of the subscriptionOrderLineSetQuantity mutation.
SubscriptionOrderLine
A line on a subscription order. It either comes from a subscription line or is a one-off for this order.
SubscriptionOrderProcessPayload
The result of the subscriptionOrderProcess mutation.
SubscriptionOrderReschedulePayload
The result of the subscriptionOrderReschedule mutation.
SubscriptionOrderSetDeliveryDatePayload
The result of the subscriptionOrderSetDeliveryDate mutation.
SubscriptionOrderSkipPayload
The result of the subscriptionOrderSkip mutation.
SubscriptionOrderUnflagPayload
The result of the subscriptionOrderUnflag mutation.
SubscriptionOrderUnskipPayload
The result of the subscriptionOrderUnskip mutation.
SubscriptionOrderUpdatePayload
The result of the subscriptionOrderUpdate mutation.
SubscriptionOrder
One billing cycle of a subscription. Processing it charges the customer and creates an order.
SubscriptionPausePayload
The result of the subscriptionPause mutation.
SubscriptionPlanConnection
The connection type for SubscriptionPlan.
SubscriptionPlanDeletePayload
The result of the subscriptionPlanDelete mutation.
SubscriptionPlanEdge
An edge in a connection.
SubscriptionPlanGroupConnection
The connection type for SubscriptionPlanGroup.
SubscriptionPlanGroupCreatePayload
The result of the subscriptionPlanGroupCreate mutation.
SubscriptionPlanGroupEdge
An edge in a connection.
SubscriptionPlanGroupUpdatePayload
The result of the subscriptionPlanGroupUpdate mutation.
SubscriptionPlanGroup
A group of subscription plans offered for the same products. It sets the
SubscriptionPlan
A plan within a subscription plan group, such as monthly delivery. It sets how often its subscriptions generate orders.
SubscriptionPriceDiscountCap
A limit on the amount a subscription price discount can take off.
SubscriptionPriceDiscountValue
The value of a subscription price discount, as a percentage or a fixed amount.
SubscriptionPriceDiscount
A discount on a subscription's recurring lines that starts at a given order
SubscriptionPricingBehaviour
Pricing rules for subscription orders. They set how base prices are chosen and which discounts apply at each cycle.
SubscriptionProductGroupItemSource
A collection, product or variant added to a subscription product group. A collection adds each of its products as an item.
SubscriptionProductGroupItem
A product or variant in a subscription product group. It comes from one of the group's item sources.
SubscriptionProductGroup
The products and variants a subscription plan group's plans are offered for.
SubscriptionReschedulePayload
The result of the subscriptionReschedule mutation.
SubscriptionRestorePayload
The result of the subscriptionRestore mutation.
SubscriptionResumePayload
The result of the subscriptionResume mutation.
SubscriptionRetryPolicy
A policy for retrying failed subscription order payments.
SubscriptionRevertScheduledCancellationPayload
The result of the subscriptionRevertScheduledCancellation mutation.
SubscriptionSetSchedulePayload
The result of the subscriptionSetSchedule mutation.
SubscriptionSource
Where a subscription came from, such as a customer's order.
SubscriptionUpdatePayload
The result of the subscriptionUpdate mutation.
Subscription
A customer's subscription to a subscription plan. It generates subscription orders on the plan's schedule.
SubscriptionsConfig
The subscription settings for a channel.
TaxFinancialsSet
The tax on a subscription order or line, in shop and presentment currencies.
TaxFinancials
The tax on an order or line, with a breakdown by tax.
TaxLineSet
A single tax charged on a subscription order or line, in shop and presentment currencies.
TaxLine
A single tax charged on an order or line, such as GST.
TimeOffset
A time offset in a notification schedule.
TotalUnitsCrowdfundingGoal
A crowdfunding goal for the number of units ordered.
TotalValueCrowdfundingGoal
A crowdfunding goal for the total value of orders.
UserError
A user-readable error.
WebhookConnection
The connection type for Webhook.
WebhookCreatePayload
The result of the webhookCreate mutation.
WebhookDeletePayload
The result of the webhookDelete mutation.
WebhookEdge
An edge in a connection.
WebhookUpdatePayload
The result of the webhookUpdate mutation.
Webhook
A subscription that sends events for a topic to a URL. Each event is sent as a