GraphQL API Reference

Welcome to the Submarine Platform GraphQL API reference. This reference includes the complete set of GraphQL types, queries, mutations, and their parameters for interacting with the Submarine eco-system.

For more general Submarine platform documentation, please check out our platform overview.

Learn how to authenticate to the API in the Getting Started guide.

Platform API Status∶ https://status.getsubmarine.com

Contact

API Documentation

hello@getsubmarine.com

https://docs.getsubmarine.com

Terms of Service

https://www.getsubmarine.com/terms-and-conditions

API Endpoints
# Production:
https://api.getsubmarine.com/graphql
Headers
# You will need your API Token, these are environment specific
Authorization: Bearer <YOUR_PLATFORM_TOKEN_HERE>
Version

1.0.0

Channels

Queries

channel

Description

Find a channel by ID, or return the current channel.

Response

Returns a Channel

Arguments
Name Description
id - SharedGlobalID The channel's ID.

Example

Query
query channel($id: SharedGlobalID) {
  channel(id: $id) {
    channelType
    config {
      ...PlatformConfigFragment
    }
    createdAt
    externalId
    id
    identifier
    name
    organisation {
      ...OrganisationFragment
    }
    sharedSecret
    status
    timezone
    updatedAt
  }
}
Variables
{"id": SharedGlobalID}
Response
{
  "data": {
    "channel": {
      "channelType": "SHOPIFY",
      "config": PlatformConfig,
      "createdAt": ISO8601DateTime,
      "externalId": "4",
      "id": GlobalID,
      "identifier": "xyz789",
      "name": "xyz789",
      "organisation": Organisation,
      "sharedSecret": "abc123",
      "status": "ACTIVE",
      "timezone": Timezone,
      "updatedAt": ISO8601DateTime
    }
  }
}
Queries

channels

Description

List all channels.

Response

Returns a ChannelConnection

Arguments
Name 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.

Example

Query
query channels(
  $after: String,
  $before: String,
  $first: Int,
  $last: Int
) {
  channels(
    after: $after,
    before: $before,
    first: $first,
    last: $last
  ) {
    edges {
      ...ChannelEdgeFragment
    }
    nodes {
      ...ChannelFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
  }
}
Variables
{
  "after": "abc123",
  "before": "abc123",
  "first": 123,
  "last": 987
}
Response
{
  "data": {
    "channels": {
      "edges": [ChannelEdge],
      "nodes": [Channel],
      "pageInfo": PageInfo
    }
  }
}

Objects

Channel

Description

A sales channel.

Fields
Field Name Description
channelType - ChannelType! The type of sales channel (eg. Shopify).
config - PlatformConfig! The channel's Submarine configuration.
createdAt - ISO8601DateTime! The time the channel was created
externalId - ID! The channel's external ID.
id - GlobalID! The channel's ID.
identifier - String! The channel's identifier
name - String The channel's name
organisation - Organisation! The channel's owner.
sharedSecret - String! The shared secret to be used when decoding Submarine notifications.
status - ChannelStatus! The channel's status (eg. active).
timezone - Timezone!
updatedAt - ISO8601DateTime! The time the channel was last updated
Example
{
  "channelType": "SHOPIFY",
  "config": PlatformConfig,
  "createdAt": ISO8601DateTime,
  "externalId": "4",
  "id": GlobalID,
  "identifier": "abc123",
  "name": "abc123",
  "organisation": Organisation,
  "sharedSecret": "abc123",
  "status": "ACTIVE",
  "timezone": Timezone,
  "updatedAt": ISO8601DateTime
}

Organisations

Queries

organisation

Description

Find an organisation by ID, or return the current organisation

Response

Returns an Organisation

Arguments
Name Description
id - GlobalID The organisation's ID.

Example

Query
query organisation($id: GlobalID) {
  organisation(id: $id) {
    address {
      ...MailingAddressFragment
    }
    channels {
      ...ChannelConnectionFragment
    }
    createdAt
    email
    id
    name
    status
    updatedAt
  }
}
Variables
{"id": GlobalID}
Response
{
  "data": {
    "organisation": {
      "address": MailingAddress,
      "channels": ChannelConnection,
      "createdAt": "xyz789",
      "email": "xyz789",
      "id": GlobalID,
      "name": "abc123",
      "status": "ACTIVE",
      "updatedAt": "xyz789"
    }
  }
}
Queries

organisations

Description

List all organisations.

Response

Returns an OrganisationConnection

Arguments
Name 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.

Example

Query
query organisations(
  $after: String,
  $before: String,
  $first: Int,
  $last: Int
) {
  organisations(
    after: $after,
    before: $before,
    first: $first,
    last: $last
  ) {
    edges {
      ...OrganisationEdgeFragment
    }
    nodes {
      ...OrganisationFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
  }
}
Variables
{
  "after": "xyz789",
  "before": "abc123",
  "first": 123,
  "last": 987
}
Response
{
  "data": {
    "organisations": {
      "edges": [OrganisationEdge],
      "nodes": [Organisation],
      "pageInfo": PageInfo
    }
  }
}

Mutations

organisationCreate

Description

Create a new organisation.

Response

Returns an OrganisationCreatePayload

Arguments
Name Description
input - OrganisationCreateInput! Input for creating an organisation.

Example

Query
mutation organisationCreate($input: OrganisationCreateInput!) {
  organisationCreate(input: $input) {
    organisation {
      ...OrganisationFragment
    }
    userErrors {
      ...UserErrorFragment
    }
  }
}
Variables
{"input": OrganisationCreateInput}
Response
{
  "data": {
    "organisationCreate": {
      "organisation": Organisation,
      "userErrors": [UserError]
    }
  }
}

Objects

Organisation

Description

An organisation using the Submarine Platform.

Fields
Field Name Description
address - MailingAddress The organisation's mailing address.
channels - ChannelConnection! The organisation's channels.
Arguments
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.
createdAt - String! The time the organisation was created
email - String! The organisation's email address.
id - GlobalID! The organisation's ID.
name - String! The organisation's name.
status - OrganisationStatus! The organisation's status (eg. active).
updatedAt - String! The time the organisation was last updated
Example
{
  "address": MailingAddress,
  "channels": ChannelConnection,
  "createdAt": "xyz789",
  "email": "abc123",
  "id": GlobalID,
  "name": "abc123",
  "status": "ACTIVE",
  "updatedAt": "xyz789"
}

Products

Queries

product

Description

Find a product by ID.

Response

Returns a Product

Arguments
Name Description
id - SharedGlobalID! The product's ID.

Example

Query
query product($id: SharedGlobalID!) {
  product(id: $id) {
    externalId
    id
    imageUrl
    productVariants {
      ...ProductVariantFragment
    }
    productVariantsCount
    status
    title
  }
}
Variables
{"id": SharedGlobalID}
Response
{
  "data": {
    "product": {
      "externalId": "xyz789",
      "id": GlobalID,
      "imageUrl": "xyz789",
      "productVariants": [ProductVariant],
      "productVariantsCount": 987,
      "status": "DELETED",
      "title": "abc123"
    }
  }
}
Queries

products

Description

List all products.

Response

Returns a ProductConnection

Arguments
Name 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.

Example

Query
query products(
  $after: String,
  $before: String,
  $first: Int,
  $last: Int
) {
  products(
    after: $after,
    before: $before,
    first: $first,
    last: $last
  ) {
    edges {
      ...ProductEdgeFragment
    }
    nodes {
      ...ProductFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
  }
}
Variables
{
  "after": "abc123",
  "before": "abc123",
  "first": 987,
  "last": 987
}
Response
{
  "data": {
    "products": {
      "edges": [ProductEdge],
      "nodes": [Product],
      "pageInfo": PageInfo,
      "totalCount": 987
    }
  }
}

Mutations

productCreate

Description

Create a new product.

Response

Returns a ProductCreatePayload

Arguments
Name Description
input - ProductCreateInput! Input for creating a product.

Example

Query
mutation productCreate($input: ProductCreateInput!) {
  productCreate(input: $input) {
    product {
      ...ProductFragment
    }
    userErrors {
      ...UserErrorFragment
    }
  }
}
Variables
{"input": ProductCreateInput}
Response
{
  "data": {
    "productCreate": {
      "product": Product,
      "userErrors": [UserError]
    }
  }
}
Mutations

productDelete

Description

Delete a product.

Response

Returns a ProductDeletePayload

Arguments
Name Description
input - ProductDeleteInput! Input for deleting a product.

Example

Query
mutation productDelete($input: ProductDeleteInput!) {
  productDelete(input: $input) {
    deletedProductId
    userErrors {
      ...UserErrorFragment
    }
  }
}
Variables
{"input": ProductDeleteInput}
Response
{
  "data": {
    "productDelete": {
      "deletedProductId": GlobalID,
      "userErrors": [UserError]
    }
  }
}
Mutations

productUpdate

Description

Update a product.

Response

Returns a ProductUpdatePayload

Arguments
Name Description
input - ProductUpdateInput! Input for updating a product.

Example

Query
mutation productUpdate($input: ProductUpdateInput!) {
  productUpdate(input: $input) {
    product {
      ...ProductFragment
    }
    userErrors {
      ...UserErrorFragment
    }
  }
}
Variables
{"input": ProductUpdateInput}
Response
{
  "data": {
    "productUpdate": {
      "product": Product,
      "userErrors": [UserError]
    }
  }
}

Objects

Product

Description

A product.

Fields
Field Name Description
externalId - String! The product's external ID.
id - GlobalID! The product's ID.
imageUrl - String The product's image url.
productVariants - [ProductVariant!]! The product's variants.
productVariantsCount - Int!
status - ProductStatus! The product's status.
title - String The product's title.
Example
{
  "externalId": "abc123",
  "id": GlobalID,
  "imageUrl": "abc123",
  "productVariants": [ProductVariant],
  "productVariantsCount": 123,
  "status": "DELETED",
  "title": "abc123"
}

Product Variants

Queries

productVariant

Description

Find a product variant by ID.

Response

Returns a ProductVariant

Arguments
Name Description
id - SharedGlobalID! The product variant's ID.

Example

Query
query productVariant($id: SharedGlobalID!) {
  productVariant(id: $id) {
    externalId
    id
    imageUrl
    price {
      ...MoneyFragment
    }
    product {
      ...ProductFragment
    }
    shippable
    sku
    status
    taxable
    title
    weightGrams
  }
}
Variables
{"id": SharedGlobalID}
Response
{
  "data": {
    "productVariant": {
      "externalId": "xyz789",
      "id": GlobalID,
      "imageUrl": "abc123",
      "price": Money,
      "product": Product,
      "shippable": false,
      "sku": "abc123",
      "status": "DELETED",
      "taxable": true,
      "title": "abc123",
      "weightGrams": 123
    }
  }
}
Queries

productVariants

Description

List all product variants.

Response

Returns a ProductVariantConnection

Arguments
Name 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.

Example

Query
query productVariants(
  $after: String,
  $before: String,
  $first: Int,
  $last: Int
) {
  productVariants(
    after: $after,
    before: $before,
    first: $first,
    last: $last
  ) {
    edges {
      ...ProductVariantEdgeFragment
    }
    nodes {
      ...ProductVariantFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
  }
}
Variables
{
  "after": "abc123",
  "before": "xyz789",
  "first": 987,
  "last": 987
}
Response
{
  "data": {
    "productVariants": {
      "edges": [ProductVariantEdge],
      "nodes": [ProductVariant],
      "pageInfo": PageInfo,
      "totalCount": 123
    }
  }
}

Mutations

productVariantCreate

Description

Create a new product variant.

Response

Returns a ProductVariantCreatePayload

Arguments
Name Description
input - ProductVariantCreateInput! Input for creating a product variant.

Example

Query
mutation productVariantCreate($input: ProductVariantCreateInput!) {
  productVariantCreate(input: $input) {
    productVariant {
      ...ProductVariantFragment
    }
    userErrors {
      ...UserErrorFragment
    }
  }
}
Variables
{"input": ProductVariantCreateInput}
Response
{
  "data": {
    "productVariantCreate": {
      "productVariant": ProductVariant,
      "userErrors": [UserError]
    }
  }
}
Mutations

productVariantDelete

Description

Delete a product variant.

Response

Returns a ProductVariantDeletePayload

Arguments
Name Description
input - ProductVariantDeleteInput! Input for deleting a product variant.

Example

Query
mutation productVariantDelete($input: ProductVariantDeleteInput!) {
  productVariantDelete(input: $input) {
    deletedProductVariantId
    userErrors {
      ...UserErrorFragment
    }
  }
}
Variables
{"input": ProductVariantDeleteInput}
Response
{
  "data": {
    "productVariantDelete": {
      "deletedProductVariantId": GlobalID,
      "userErrors": [UserError]
    }
  }
}
Mutations

productVariantUpdate

Description

Update a product variant.

Response

Returns a ProductVariantUpdatePayload

Arguments
Name Description
input - ProductVariantUpdateInput! Input for updating a product variant.

Example

Query
mutation productVariantUpdate($input: ProductVariantUpdateInput!) {
  productVariantUpdate(input: $input) {
    productVariant {
      ...ProductVariantFragment
    }
    userErrors {
      ...UserErrorFragment
    }
  }
}
Variables
{"input": ProductVariantUpdateInput}
Response
{
  "data": {
    "productVariantUpdate": {
      "productVariant": ProductVariant,
      "userErrors": [UserError]
    }
  }
}

Objects

ProductVariant

Description

A product variant.

Fields
Field Name Description
externalId - String! The variant's external ID.
id - GlobalID! The variant's ID.
imageUrl - String The variant's image URL.
price - Money! The variant's price
product - Product! The product this variant belongs to.
shippable - Boolean! Whether the variant requires shipping.
sku - String The variant's SKU.
status - ProductVariantStatus! The variant's status.
taxable - Boolean! Whether a tax is charged when the variant is sold.
title - String The variant's title.
weightGrams - Int The variant's weight in grams.
Example
{
  "externalId": "xyz789",
  "id": GlobalID,
  "imageUrl": "abc123",
  "price": Money,
  "product": Product,
  "shippable": false,
  "sku": "xyz789",
  "status": "DELETED",
  "taxable": false,
  "title": "xyz789",
  "weightGrams": 987
}

Webhooks

Queries

webhook

Description

Find a webhook by ID.

Response

Returns a Webhook

Arguments
Name Description
id - GlobalID! The webhook's ID.

Example

Query
query webhook($id: GlobalID!) {
  webhook(id: $id) {
    channel {
      ...ChannelFragment
    }
    createdAt
    id
    status
    topic
    updatedAt
    url
  }
}
Variables
{"id": GlobalID}
Response
{
  "data": {
    "webhook": {
      "channel": Channel,
      "createdAt": ISO8601DateTime,
      "id": GlobalID,
      "status": "ACTIVE",
      "topic": "CAMPAIGN_ORDER_CANCELLED",
      "updatedAt": ISO8601DateTime,
      "url": Url
    }
  }
}
Queries

webhooks

Description

List all webhooks.

Response

Returns a WebhookConnection

Arguments
Name 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.

Example

Query
query webhooks(
  $after: String,
  $before: String,
  $first: Int,
  $last: Int
) {
  webhooks(
    after: $after,
    before: $before,
    first: $first,
    last: $last
  ) {
    edges {
      ...WebhookEdgeFragment
    }
    nodes {
      ...WebhookFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
  }
}
Variables
{
  "after": "abc123",
  "before": "xyz789",
  "first": 987,
  "last": 123
}
Response
{
  "data": {
    "webhooks": {
      "edges": [WebhookEdge],
      "nodes": [Webhook],
      "pageInfo": PageInfo
    }
  }
}

Mutations

webhookCreate

Description

Creates a webhook subscription.

Response

Returns a WebhookCreatePayload

Arguments
Name Description
input - WebhookCreateInput! Input for creating a webhook subscription.

Example

Query
mutation webhookCreate($input: WebhookCreateInput!) {
  webhookCreate(input: $input) {
    userErrors {
      ...UserErrorFragment
    }
    webhook {
      ...WebhookFragment
    }
  }
}
Variables
{"input": WebhookCreateInput}
Response
{
  "data": {
    "webhookCreate": {
      "userErrors": [UserError],
      "webhook": Webhook
    }
  }
}
Mutations

webhookDelete

Description

Deletes a webhook subscription.

Response

Returns a WebhookDeletePayload

Arguments
Name Description
input - WebhookDeleteInput! Input for deleting a Webhook Subscription.

Example

Query
mutation webhookDelete($input: WebhookDeleteInput!) {
  webhookDelete(input: $input) {
    deletedWebhookId
    userErrors {
      ...UserErrorFragment
    }
  }
}
Variables
{"input": WebhookDeleteInput}
Response
{
  "data": {
    "webhookDelete": {
      "deletedWebhookId": GlobalID,
      "userErrors": [UserError]
    }
  }
}
Mutations

webhookUpdate

Description

Updates a webhook subscription.

Response

Returns a WebhookUpdatePayload

Arguments
Name Description
input - WebhookUpdateInput! Input for updating the webhook.

Example

Query
mutation webhookUpdate($input: WebhookUpdateInput!) {
  webhookUpdate(input: $input) {
    userErrors {
      ...UserErrorFragment
    }
    webhook {
      ...WebhookFragment
    }
  }
}
Variables
{"input": WebhookUpdateInput}
Response
{
  "data": {
    "webhookUpdate": {
      "userErrors": [UserError],
      "webhook": Webhook
    }
  }
}

Objects

Webhook

Description

A webhook.

Fields
Field Name Description
channel - Channel! The webhooks's channel
createdAt - ISO8601DateTime! The time the webhook was created
id - GlobalID! The webhooks's ID.
status - WebhookStatus! The webhooks's status (eg. ACTIVE).
topic - WebhookTopic! The webhooks's topic (eg. CHARGE_FAILED).
updatedAt - ISO8601DateTime! The time the webhook was last updated
url - Url! The webhooks url path
Example
{
  "channel": Channel,
  "createdAt": ISO8601DateTime,
  "id": GlobalID,
  "status": "ACTIVE",
  "topic": "CAMPAIGN_ORDER_CANCELLED",
  "updatedAt": ISO8601DateTime,
  "url": Url
}

Campaign Orders

Queries

campaignOrder

Description

Find an campaign order by ID.

Response

Returns a CampaignOrder

Arguments
Name Description
id - GlobalID! The campaign order's ID.

Example

Query
query campaignOrder($id: GlobalID!) {
  campaignOrder(id: $id) {
    allocatedQuantity
    campaign {
      ... on CrowdfundingCampaign {
        ...CrowdfundingCampaignFragment
      }
      ... on PresaleCampaign {
        ...PresaleCampaignFragment
      }
    }
    campaignInventoryItem {
      ...CampaignInventoryItemFragment
    }
    campaignItem {
      ...CampaignItemFragment
    }
    campaignOrderGroup {
      ...CampaignOrderGroupFragment
    }
    cancelReason
    cancelledBy
    customer {
      ...CustomerFragment
    }
    financials {
      ...CampaignOrderFinancialsFragment
    }
    fulfilmentStatus
    id
    identifier
    milestones {
      ...CampaignOrderMilestonesFragment
    }
    originalQuantity
    paymentIntent {
      ...PaymentIntentFragment
    }
    paymentMethod {
      ...PaymentMethodFragment
    }
    paymentStatus
    product {
      ...ProductFragment
    }
    productVariant {
      ...ProductVariantFragment
    }
    quantity
    sequentialId
    status
  }
}
Variables
{"id": GlobalID}
Response
{
  "data": {
    "campaignOrder": {
      "allocatedQuantity": 987,
      "campaign": CrowdfundingCampaign,
      "campaignInventoryItem": CampaignInventoryItem,
      "campaignItem": CampaignItem,
      "campaignOrderGroup": CampaignOrderGroup,
      "cancelReason": "xyz789",
      "cancelledBy": "CUSTOMER",
      "customer": Customer,
      "financials": CampaignOrderFinancials,
      "fulfilmentStatus": "ALLOCATED",
      "id": GlobalID,
      "identifier": "abc123",
      "milestones": CampaignOrderMilestones,
      "originalQuantity": 987,
      "paymentIntent": PaymentIntent,
      "paymentMethod": PaymentMethod,
      "paymentStatus": "FAILED",
      "product": Product,
      "productVariant": ProductVariant,
      "quantity": 987,
      "sequentialId": 123,
      "status": "ALLOCATED"
    }
  }
}
Queries

campaignOrderPagination

Description

Next and previous campaign orders

Response

Returns a PaginationResult

Arguments
Name Description
campaignId - GlobalID Return only campaign orders belonging to this campaign.
campaignType - CampaignType Return only campaign orders of the given type.
customerId - [SharedGlobalID!] Return only campaign orders belonging to these customers.
fulfilmentStatus - [CampaignOrderFulfilmentStatus!] The campaign order's fulfilment status.
paymentStatus - [CampaignOrderPaymentStatus!] The campaign order's payment status.
productVariantId - [SharedGlobalID!] Return only campaign orders for these variants.
query - String A query string.
sortDirection - SortDirection The sort direction.
sortKey - CampaignOrderSortKey The key used to sort campaign orders.
status - [CampaignOrderStatus!] The campaign order's status.

Example

Query
query campaignOrderPagination(
  $campaignId: GlobalID,
  $campaignType: CampaignType,
  $customerId: [SharedGlobalID!],
  $fulfilmentStatus: [CampaignOrderFulfilmentStatus!],
  $paymentStatus: [CampaignOrderPaymentStatus!],
  $productVariantId: [SharedGlobalID!],
  $query: String,
  $sortDirection: SortDirection,
  $sortKey: CampaignOrderSortKey,
  $status: [CampaignOrderStatus!]
) {
  campaignOrderPagination(
    campaignId: $campaignId,
    campaignType: $campaignType,
    customerId: $customerId,
    fulfilmentStatus: $fulfilmentStatus,
    paymentStatus: $paymentStatus,
    productVariantId: $productVariantId,
    query: $query,
    sortDirection: $sortDirection,
    sortKey: $sortKey,
    status: $status
  ) {
    queryArguments
    nextCampaignOrders {
      ...CampaignOrderConnectionFragment
    }
    nextCrowdfundingCampaigns {
      ...CrowdfundingCampaignConnectionFragment
    }
    nextPresaleCampaigns {
      ...PresaleCampaignConnectionFragment
    }
    previousCampaignOrders {
      ...CampaignOrderConnectionFragment
    }
    previousCrowdfundingCampaigns {
      ...CrowdfundingCampaignConnectionFragment
    }
    previousPresaleCampaigns {
      ...PresaleCampaignConnectionFragment
    }
    nextSubscriptionOrders {
      ...SubscriptionOrderConnectionFragment
    }
    nextSubscriptionPlanGroups {
      ...SubscriptionPlanGroupConnectionFragment
    }
    nextSubscriptions {
      ...SubscriptionConnectionFragment
    }
    previousSubscriptionOrders {
      ...SubscriptionOrderConnectionFragment
    }
    previousSubscriptionPlanGroups {
      ...SubscriptionPlanGroupConnectionFragment
    }
    previousSubscriptions {
      ...SubscriptionConnectionFragment
    }
  }
}
Variables
{
  "campaignId": GlobalID,
  "campaignType": "CROWDFUNDING",
  "customerId": [SharedGlobalID],
  "fulfilmentStatus": ["ALLOCATED"],
  "paymentStatus": ["FAILED"],
  "productVariantId": [SharedGlobalID],
  "query": "xyz789",
  "sortDirection": "ASC",
  "sortKey": "CREATED_AT",
  "status": ["ALLOCATED"]
}
Response
{
  "data": {
    "campaignOrderPagination": {
      "queryArguments": "xyz789",
      "nextCampaignOrders": CampaignOrderConnection,
      "nextCrowdfundingCampaigns": CrowdfundingCampaignConnection,
      "nextPresaleCampaigns": PresaleCampaignConnection,
      "previousCampaignOrders": CampaignOrderConnection,
      "previousCrowdfundingCampaigns": CrowdfundingCampaignConnection,
      "previousPresaleCampaigns": PresaleCampaignConnection,
      "nextSubscriptionOrders": SubscriptionOrderConnection,
      "nextSubscriptionPlanGroups": SubscriptionPlanGroupConnection,
      "nextSubscriptions": SubscriptionConnection,
      "previousSubscriptionOrders": SubscriptionOrderConnection,
      "previousSubscriptionPlanGroups": SubscriptionPlanGroupConnection,
      "previousSubscriptions": SubscriptionConnection
    }
  }
}
Queries

campaignOrders

Description

List all campaign orders.

Response

Returns a CampaignOrderConnection

Arguments
Name 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.

Example

Query
query campaignOrders(
  $after: String,
  $before: String,
  $first: Int,
  $last: Int
) {
  campaignOrders(
    after: $after,
    before: $before,
    first: $first,
    last: $last
  ) {
    edges {
      ...CampaignOrderEdgeFragment
    }
    nodes {
      ...CampaignOrderFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
  }
}
Variables
{
  "after": "xyz789",
  "before": "abc123",
  "first": 123,
  "last": 123
}
Response
{
  "data": {
    "campaignOrders": {
      "edges": [CampaignOrderEdge],
      "nodes": [CampaignOrder],
      "pageInfo": PageInfo,
      "totalCount": 987
    }
  }
}
Queries

searchCampaignOrders

Description

Search campaign orders

Response

Returns a SearchResult

Arguments
Name Description
campaignId - GlobalID Return only campaign orders belonging to this campaign.
campaignType - CampaignType Return only campaign orders of the given type.
customerId - [SharedGlobalID!] Return only campaign orders belonging to these customers.
fulfilmentStatus - [CampaignOrderFulfilmentStatus!] The campaign order's fulfilment status.
paymentStatus - [CampaignOrderPaymentStatus!] The campaign order's payment status.
productVariantId - [SharedGlobalID!] Return only campaign orders for these variants.
query - String A query string.
sortDirection - SortDirection The sort direction.
sortKey - CampaignOrderSortKey The key used to sort campaign orders.
status - [CampaignOrderStatus!] The campaign order's status.

Example

Query
query searchCampaignOrders(
  $campaignId: GlobalID,
  $campaignType: CampaignType,
  $customerId: [SharedGlobalID!],
  $fulfilmentStatus: [CampaignOrderFulfilmentStatus!],
  $paymentStatus: [CampaignOrderPaymentStatus!],
  $productVariantId: [SharedGlobalID!],
  $query: String,
  $sortDirection: SortDirection,
  $sortKey: CampaignOrderSortKey,
  $status: [CampaignOrderStatus!]
) {
  searchCampaignOrders(
    campaignId: $campaignId,
    campaignType: $campaignType,
    customerId: $customerId,
    fulfilmentStatus: $fulfilmentStatus,
    paymentStatus: $paymentStatus,
    productVariantId: $productVariantId,
    query: $query,
    sortDirection: $sortDirection,
    sortKey: $sortKey,
    status: $status
  ) {
    queryArguments
    campaignOrders {
      ...CampaignOrderConnectionFragment
    }
    crowdfundingCampaigns {
      ...CrowdfundingCampaignConnectionFragment
    }
    presaleCampaigns {
      ...PresaleCampaignConnectionFragment
    }
    subscriptionOrders {
      ...SubscriptionOrderConnectionFragment
    }
    subscriptionPlanGroups {
      ...SubscriptionPlanGroupConnectionFragment
    }
    subscriptions {
      ...SubscriptionConnectionFragment
    }
  }
}
Variables
{
  "campaignId": GlobalID,
  "campaignType": "CROWDFUNDING",
  "customerId": [SharedGlobalID],
  "fulfilmentStatus": ["ALLOCATED"],
  "paymentStatus": ["FAILED"],
  "productVariantId": [SharedGlobalID],
  "query": "abc123",
  "sortDirection": "ASC",
  "sortKey": "CREATED_AT",
  "status": ["ALLOCATED"]
}
Response
{
  "data": {
    "searchCampaignOrders": {
      "queryArguments": "abc123",
      "campaignOrders": CampaignOrderConnection,
      "crowdfundingCampaigns": CrowdfundingCampaignConnection,
      "presaleCampaigns": PresaleCampaignConnection,
      "subscriptionOrders": SubscriptionOrderConnection,
      "subscriptionPlanGroups": SubscriptionPlanGroupConnection,
      "subscriptions": SubscriptionConnection
    }
  }
}

Mutations

campaignOrderCancel

Description

Cancels a campaign order.

Response

Returns a CampaignOrderCancelPayload

Arguments
Name Description
input - CampaignOrderCancelInput! Input for canceling the campaign order.

Example

Query
mutation campaignOrderCancel($input: CampaignOrderCancelInput!) {
  campaignOrderCancel(input: $input) {
    campaignOrder {
      ...CampaignOrderFragment
    }
    userErrors {
      ...UserErrorFragment
    }
  }
}
Variables
{"input": CampaignOrderCancelInput}
Response
{
  "data": {
    "campaignOrderCancel": {
      "campaignOrder": CampaignOrder,
      "userErrors": [UserError]
    }
  }
}
Mutations

campaignOrderCreate

Description

Creates a campaign order.

Response

Returns a CampaignOrderCreatePayload

Arguments
Name Description
input - CampaignOrderCreateInput! Input for creating a campaign order.

Example

Query
mutation campaignOrderCreate($input: CampaignOrderCreateInput!) {
  campaignOrderCreate(input: $input) {
    campaignOrder {
      ...CampaignOrderFragment
    }
    userErrors {
      ...UserErrorFragment
    }
  }
}
Variables
{"input": CampaignOrderCreateInput}
Response
{
  "data": {
    "campaignOrderCreate": {
      "campaignOrder": CampaignOrder,
      "userErrors": [UserError]
    }
  }
}
Mutations

campaignOrderDecreaseQuantity

Description

Decreases quantity on a campaign order.

Response

Returns a CampaignOrderDecreaseQuantityPayload

Arguments
Name Description
input - CampaignOrderDecreaseQuantityInput! Input for updating the campaign order.

Example

Query
mutation campaignOrderDecreaseQuantity($input: CampaignOrderDecreaseQuantityInput!) {
  campaignOrderDecreaseQuantity(input: $input) {
    campaignOrder {
      ...CampaignOrderFragment
    }
    userErrors {
      ...UserErrorFragment
    }
  }
}
Variables
{"input": CampaignOrderDecreaseQuantityInput}
Response
{
  "data": {
    "campaignOrderDecreaseQuantity": {
      "campaignOrder": CampaignOrder,
      "userErrors": [UserError]
    }
  }
}

Objects

CampaignOrder

Description

The order of a Campaign Order Group

Fields
Field Name Description
allocatedQuantity - Int! The allocated quantity.
campaign - Campaign! The parent campaign.
campaignInventoryItem - CampaignInventoryItem The inventory item.
campaignItem - CampaignItem The campaign item.
campaignOrderGroup - CampaignOrderGroup! The campaign order's group.
cancelReason - String The reason for cancellation.
cancelledBy - Persona The originator of the cancellation.
customer - Customer! The campaign order's customer.
financials - CampaignOrderFinancials
fulfilmentStatus - CampaignOrderFulfilmentStatus! The fulfilment status of the order
id - GlobalID! The ID of the campaign order
identifier - String! The campaign order's identifier
milestones - CampaignOrderMilestones
originalQuantity - Int! Original quantity of product in this order
paymentIntent - PaymentIntent The payment intent of the campaign order.
paymentMethod - PaymentMethod The payment method of the campaign order.
paymentStatus - CampaignOrderPaymentStatus The payment status of the campaign order.
product - Product! The product
productVariant - ProductVariant! The product variant
quantity - Int! Quantity of product in this order
sequentialId - Int! The ordered ID of the campaign order.
status - CampaignOrderStatus! The status of the campaign order.
Example
{
  "allocatedQuantity": 123,
  "campaign": CrowdfundingCampaign,
  "campaignInventoryItem": CampaignInventoryItem,
  "campaignItem": CampaignItem,
  "campaignOrderGroup": CampaignOrderGroup,
  "cancelReason": "abc123",
  "cancelledBy": "CUSTOMER",
  "customer": Customer,
  "financials": CampaignOrderFinancials,
  "fulfilmentStatus": "ALLOCATED",
  "id": GlobalID,
  "identifier": "xyz789",
  "milestones": CampaignOrderMilestones,
  "originalQuantity": 987,
  "paymentIntent": PaymentIntent,
  "paymentMethod": PaymentMethod,
  "paymentStatus": "FAILED",
  "product": Product,
  "productVariant": ProductVariant,
  "quantity": 123,
  "sequentialId": 123,
  "status": "ALLOCATED"
}
Objects

PaginationResult

Description

The previous and next objects in a connection.

Fields
Field Name Description
queryArguments - String! The query arguments as a JSON string
nextCampaignOrders - CampaignOrderConnection The next campaign orders
Arguments
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.
nextCrowdfundingCampaigns - CrowdfundingCampaignConnection The next crowdfunding campaigns
Arguments
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.
nextPresaleCampaigns - PresaleCampaignConnection The next presale campaigns
Arguments
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.
previousCampaignOrders - CampaignOrderConnection The previous campaign orders
Arguments
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.
previousCrowdfundingCampaigns - CrowdfundingCampaignConnection The previous crowdfunding campaigns
Arguments
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.
previousPresaleCampaigns - PresaleCampaignConnection The previous presale campaigns
Arguments
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.
nextSubscriptionOrders - SubscriptionOrderConnection The next subscription orders
Arguments
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.
nextSubscriptionPlanGroups - SubscriptionPlanGroupConnection The next subscription plan groups
Arguments
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.
nextSubscriptions - SubscriptionConnection The next subscriptions
Arguments
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.
previousSubscriptionOrders - SubscriptionOrderConnection The previous subscription orders
Arguments
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.
previousSubscriptionPlanGroups - SubscriptionPlanGroupConnection The previous subscription plan groups
Arguments
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.
previousSubscriptions - SubscriptionConnection The previous subscriptions
Arguments
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.
Example
{
  "queryArguments": "xyz789",
  "nextCampaignOrders": CampaignOrderConnection,
  "nextCrowdfundingCampaigns": CrowdfundingCampaignConnection,
  "nextPresaleCampaigns": PresaleCampaignConnection,
  "previousCampaignOrders": CampaignOrderConnection,
  "previousCrowdfundingCampaigns": CrowdfundingCampaignConnection,
  "previousPresaleCampaigns": PresaleCampaignConnection,
  "nextSubscriptionOrders": SubscriptionOrderConnection,
  "nextSubscriptionPlanGroups": SubscriptionPlanGroupConnection,
  "nextSubscriptions": SubscriptionConnection,
  "previousSubscriptionOrders": SubscriptionOrderConnection,
  "previousSubscriptionPlanGroups": SubscriptionPlanGroupConnection,
  "previousSubscriptions": SubscriptionConnection
}
Objects

SearchResult

Description

A search result.

Fields
Field Name Description
queryArguments - String! The query arguments as a JSON string
campaignOrders - CampaignOrderConnection The matching campaign orders
Arguments
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.
crowdfundingCampaigns - CrowdfundingCampaignConnection The matching crowdfunding campaigns
Arguments
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.
presaleCampaigns - PresaleCampaignConnection The matching presale campaigns
Arguments
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.
subscriptionOrders - SubscriptionOrderConnection
Arguments
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.
subscriptionPlanGroups - SubscriptionPlanGroupConnection
Arguments
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
Arguments
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.
Example
{
  "queryArguments": "abc123",
  "campaignOrders": CampaignOrderConnection,
  "crowdfundingCampaigns": CrowdfundingCampaignConnection,
  "presaleCampaigns": PresaleCampaignConnection,
  "subscriptionOrders": SubscriptionOrderConnection,
  "subscriptionPlanGroups": SubscriptionPlanGroupConnection,
  "subscriptions": SubscriptionConnection
}

Campaign Order Groups

Queries

campaignOrderGroup

Description

Find an campaign order group by ID

Response

Returns a CampaignOrderGroup

Arguments
Name Description
id - SharedGlobalID! The campaign order group's ID

Example

Query
query campaignOrderGroup($id: SharedGlobalID!) {
  campaignOrderGroup(id: $id) {
    campaignOrders {
      ...CampaignOrderFragment
    }
    customer {
      ...CustomerFragment
    }
    externalId
    financials {
      ...CampaignOrderGroupFinancialsFragment
    }
    id
    identifier
    lineItemsCount
    milestones {
      ...CampaignOrderGroupMilestonesFragment
    }
    paymentIntent {
      ...PaymentIntentFragment
    }
    paymentMethod {
      ...PaymentMethodFragment
    }
    paymentStatus
    status
  }
}
Variables
{"id": SharedGlobalID}
Response
{
  "data": {
    "campaignOrderGroup": {
      "campaignOrders": [CampaignOrder],
      "customer": Customer,
      "externalId": "abc123",
      "financials": CampaignOrderGroupFinancials,
      "id": GlobalID,
      "identifier": "xyz789",
      "lineItemsCount": 987,
      "milestones": CampaignOrderGroupMilestones,
      "paymentIntent": PaymentIntent,
      "paymentMethod": PaymentMethod,
      "paymentStatus": "FAILED",
      "status": "ALLOCATED"
    }
  }
}
Queries

campaignOrderGroups

Description

List all campaign order groups

Response

Returns a CampaignOrderGroupConnection

Arguments
Name 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.

Example

Query
query campaignOrderGroups(
  $after: String,
  $before: String,
  $first: Int,
  $last: Int
) {
  campaignOrderGroups(
    after: $after,
    before: $before,
    first: $first,
    last: $last
  ) {
    edges {
      ...CampaignOrderGroupEdgeFragment
    }
    nodes {
      ...CampaignOrderGroupFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
  }
}
Variables
{
  "after": "xyz789",
  "before": "abc123",
  "first": 123,
  "last": 123
}
Response
{
  "data": {
    "campaignOrderGroups": {
      "edges": [CampaignOrderGroupEdge],
      "nodes": [CampaignOrderGroup],
      "pageInfo": PageInfo,
      "totalCount": 987
    }
  }
}

Mutations

campaignOrderGroupCancel

Description

Cancels a campaign order group.

Response

Returns a CampaignOrderGroupCancelPayload

Arguments
Name Description
input - CampaignOrderGroupCancelInput! Input for canceling the campaign order group.

Example

Query
mutation campaignOrderGroupCancel($input: CampaignOrderGroupCancelInput!) {
  campaignOrderGroupCancel(input: $input) {
    campaignOrderGroup {
      ...CampaignOrderGroupFragment
    }
    userErrors {
      ...UserErrorFragment
    }
  }
}
Variables
{"input": CampaignOrderGroupCancelInput}
Response
{
  "data": {
    "campaignOrderGroupCancel": {
      "campaignOrderGroup": CampaignOrderGroup,
      "userErrors": [UserError]
    }
  }
}

Objects

CampaignOrderGroup

Description

The group of orders by a customer for a Campaign

Fields
Field Name Description
campaignOrders - [CampaignOrder!]! The campaign order group's orders.
customer - Customer! The campaign order group's customer.
externalId - String! The campaign order group's external ID.
financials - CampaignOrderGroupFinancials
id - GlobalID! The id of the campaign order group
identifier - String! The campaign order group's identifier
lineItemsCount - Int The campaign order group's total count of line items.
milestones - CampaignOrderGroupMilestones
paymentIntent - PaymentIntent The payment intent of the campaign order group.
paymentMethod - PaymentMethod The payment method of the campaign order group.
paymentStatus - CampaignOrderPaymentStatus The payment status of the campaign order group.
status - CampaignOrderGroupStatus! The status of the campaign order group.
Example
{
  "campaignOrders": [CampaignOrder],
  "customer": Customer,
  "externalId": "abc123",
  "financials": CampaignOrderGroupFinancials,
  "id": GlobalID,
  "identifier": "xyz789",
  "lineItemsCount": 987,
  "milestones": CampaignOrderGroupMilestones,
  "paymentIntent": PaymentIntent,
  "paymentMethod": PaymentMethod,
  "paymentStatus": "FAILED",
  "status": "ALLOCATED"
}

Crowdfunding Campaign

Queries

crowdfundingCampaign

Description

Find a crowdfunding campaign by ID

Response

Returns a CrowdfundingCampaign

Arguments
Name Description
id - GlobalID! The crowdfunding campaign's ID.

Example

Query
query crowdfundingCampaign($id: GlobalID!) {
  crowdfundingCampaign(id: $id) {
    activeCampaignOrdersCount
    allocatedInventoryCount
    allocationStatus
    appliedInventoryCount
    archivedAt
    campaignEndTotalUnits
    campaignEndTotalValue {
      ...MoneyFragment
    }
    campaignInventoryItems {
      ...CampaignInventoryItemFragment
    }
    campaignItemType
    campaignItems {
      ...CampaignItemFragment
    }
    campaignOrders {
      ...CampaignOrderConnectionFragment
    }
    campaignOrdersCount
    campaignRunningTotalUnits
    campaignRunningTotalValue {
      ...MoneyFragment
    }
    cancelledAt
    channel {
      ...ChannelFragment
    }
    completedAt
    createdAt
    currency
    description
    dueAt
    endAt
    endedAt
    fulfilAt
    fulfillingAt
    goal {
      ... on TotalUnitsCrowdfundingGoal {
        ...TotalUnitsCrowdfundingGoalFragment
      }
      ... on TotalValueCrowdfundingGoal {
        ...TotalValueCrowdfundingGoalFragment
      }
    }
    goalProgress
    goalStatus
    gracePeriodHours
    id
    identifier
    inventoryApplications {
      ...InventoryApplicationFragment
    }
    launchAt
    launchedAt
    limit
    name
    productVariants {
      ...ProductVariantFragment
    }
    products {
      ...ProductFragment
    }
    reference
    reservedItemsCount
    sequentialId
    status
    updatedAt
  }
}
Variables
{"id": GlobalID}
Response
{
  "data": {
    "crowdfundingCampaign": {
      "activeCampaignOrdersCount": 987,
      "allocatedInventoryCount": 987,
      "allocationStatus": "ALLOCATED",
      "appliedInventoryCount": 123,
      "archivedAt": ISO8601DateTime,
      "campaignEndTotalUnits": 123,
      "campaignEndTotalValue": Money,
      "campaignInventoryItems": [CampaignInventoryItem],
      "campaignItemType": "PRODUCT",
      "campaignItems": [CampaignItem],
      "campaignOrders": CampaignOrderConnection,
      "campaignOrdersCount": 123,
      "campaignRunningTotalUnits": 987,
      "campaignRunningTotalValue": Money,
      "cancelledAt": ISO8601DateTime,
      "channel": Channel,
      "completedAt": ISO8601DateTime,
      "createdAt": ISO8601DateTime,
      "currency": "AED",
      "description": "xyz789",
      "dueAt": ISO8601DateTime,
      "endAt": ISO8601DateTime,
      "endedAt": ISO8601DateTime,
      "fulfilAt": ISO8601DateTime,
      "fulfillingAt": ISO8601DateTime,
      "goal": TotalUnitsCrowdfundingGoal,
      "goalProgress": 123.45,
      "goalStatus": "FAILED",
      "gracePeriodHours": 987,
      "id": GlobalID,
      "identifier": "abc123",
      "inventoryApplications": [InventoryApplication],
      "launchAt": ISO8601DateTime,
      "launchedAt": ISO8601DateTime,
      "limit": 123,
      "name": "abc123",
      "productVariants": [ProductVariant],
      "products": [Product],
      "reference": "abc123",
      "reservedItemsCount": 987,
      "sequentialId": 123,
      "status": "CANCELLED",
      "updatedAt": ISO8601DateTime
    }
  }
}
Queries

crowdfundingCampaigns

Description

List all crowdfunding campaigns

Response

Returns a CrowdfundingCampaignConnection

Arguments
Name 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.

Example

Query
query crowdfundingCampaigns(
  $after: String,
  $before: String,
  $first: Int,
  $last: Int
) {
  crowdfundingCampaigns(
    after: $after,
    before: $before,
    first: $first,
    last: $last
  ) {
    edges {
      ...CrowdfundingCampaignEdgeFragment
    }
    nodes {
      ...CrowdfundingCampaignFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
  }
}
Variables
{
  "after": "abc123",
  "before": "abc123",
  "first": 987,
  "last": 987
}
Response
{
  "data": {
    "crowdfundingCampaigns": {
      "edges": [CrowdfundingCampaignEdge],
      "nodes": [CrowdfundingCampaign],
      "pageInfo": PageInfo,
      "totalCount": 123
    }
  }
}
Queries

searchCrowdfundingCampaigns

Description

Search crowdfunding campaigns

Response

Returns a SearchResult

Arguments
Name Description
allocationStatus - [CampaignAllocationStatus!] The campaign's allocation status.
goalType - [CrowdfundingGoalType!] The campaign's goal type.
isAllocating - Boolean Whether the campaign is allocating.
isArchived - Boolean Whether the campaign is archived.
productIds - [SharedGlobalID!] Return campaigns containing any of these product IDs
productVariantIds - [SharedGlobalID!] Return campaigns containing any of these product variant IDs.
query - String A query string.
sortDirection - SortDirection The sort direction.
sortKey - CrowdfundingCampaignSortKey The key used to sort campaigns.
status - [CampaignStatus!] The campaign's status.

Example

Query
query searchCrowdfundingCampaigns(
  $allocationStatus: [CampaignAllocationStatus!],
  $goalType: [CrowdfundingGoalType!],
  $isAllocating: Boolean,
  $isArchived: Boolean,
  $productIds: [SharedGlobalID!],
  $productVariantIds: [SharedGlobalID!],
  $query: String,
  $sortDirection: SortDirection,
  $sortKey: CrowdfundingCampaignSortKey,
  $status: [CampaignStatus!]
) {
  searchCrowdfundingCampaigns(
    allocationStatus: $allocationStatus,
    goalType: $goalType,
    isAllocating: $isAllocating,
    isArchived: $isArchived,
    productIds: $productIds,
    productVariantIds: $productVariantIds,
    query: $query,
    sortDirection: $sortDirection,
    sortKey: $sortKey,
    status: $status
  ) {
    queryArguments
    campaignOrders {
      ...CampaignOrderConnectionFragment
    }
    crowdfundingCampaigns {
      ...CrowdfundingCampaignConnectionFragment
    }
    presaleCampaigns {
      ...PresaleCampaignConnectionFragment
    }
    subscriptionOrders {
      ...SubscriptionOrderConnectionFragment
    }
    subscriptionPlanGroups {
      ...SubscriptionPlanGroupConnectionFragment
    }
    subscriptions {
      ...SubscriptionConnectionFragment
    }
  }
}
Variables
{
  "allocationStatus": ["ALLOCATED"],
  "goalType": ["TOTAL_UNITS"],
  "isAllocating": false,
  "isArchived": true,
  "productIds": [SharedGlobalID],
  "productVariantIds": [SharedGlobalID],
  "query": "abc123",
  "sortDirection": "ASC",
  "sortKey": "COMPLETED_AT",
  "status": ["CANCELLED"]
}
Response
{
  "data": {
    "searchCrowdfundingCampaigns": {
      "queryArguments": "abc123",
      "campaignOrders": CampaignOrderConnection,
      "crowdfundingCampaigns": CrowdfundingCampaignConnection,
      "presaleCampaigns": PresaleCampaignConnection,
      "subscriptionOrders": SubscriptionOrderConnection,
      "subscriptionPlanGroups": SubscriptionPlanGroupConnection,
      "subscriptions": SubscriptionConnection
    }
  }
}

Mutations

crowdfundingCampaignAddProductVariants

Description

Add product variants to an existing crowdfunding campaign.

Response

Returns a CrowdfundingCampaignAddProductVariantsPayload

Arguments
Name Description
input - CrowdfundingCampaignAddProductVariantsInput! Input for adding product variants to the crowdfunding campaign.

Example

Query
mutation crowdfundingCampaignAddProductVariants($input: CrowdfundingCampaignAddProductVariantsInput!) {
  crowdfundingCampaignAddProductVariants(input: $input) {
    crowdfundingCampaign {
      ...CrowdfundingCampaignFragment
    }
    userErrors {
      ...UserErrorFragment
    }
  }
}
Variables
{"input": CrowdfundingCampaignAddProductVariantsInput}
Response
{
  "data": {
    "crowdfundingCampaignAddProductVariants": {
      "crowdfundingCampaign": CrowdfundingCampaign,
      "userErrors": [UserError]
    }
  }
}
Mutations

crowdfundingCampaignAddProducts

Description

Add products to an existing crowdfunding campaign.

Response

Returns a CrowdfundingCampaignAddProductsPayload

Arguments
Name Description
input - CrowdfundingCampaignAddProductsInput! Input for adding products to the crowdfunding campaign.

Example

Query
mutation crowdfundingCampaignAddProducts($input: CrowdfundingCampaignAddProductsInput!) {
  crowdfundingCampaignAddProducts(input: $input) {
    crowdfundingCampaign {
      ...CrowdfundingCampaignFragment
    }
    userErrors {
      ...UserErrorFragment
    }
  }
}
Variables
{"input": CrowdfundingCampaignAddProductsInput}
Response
{
  "data": {
    "crowdfundingCampaignAddProducts": {
      "crowdfundingCampaign": CrowdfundingCampaign,
      "userErrors": [UserError]
    }
  }
}
Mutations

crowdfundingCampaignApplyBulkInventory

Description

Apply bulk inventory to a crowdfunding campaign

Response

Returns a CrowdfundingCampaignApplyBulkInventoryPayload

Arguments
Name Description
input - CrowdfundingCampaignApplyBulkInventoryInput! Input for applying bulk inventory.

Example

Query
mutation crowdfundingCampaignApplyBulkInventory($input: CrowdfundingCampaignApplyBulkInventoryInput!) {
  crowdfundingCampaignApplyBulkInventory(input: $input) {
    crowdfundingCampaign {
      ...CrowdfundingCampaignFragment
    }
    userErrors {
      ...UserErrorFragment
    }
  }
}
Variables
{"input": CrowdfundingCampaignApplyBulkInventoryInput}
Response
{
  "data": {
    "crowdfundingCampaignApplyBulkInventory": {
      "crowdfundingCampaign": CrowdfundingCampaign,
      "userErrors": [UserError]
    }
  }
}
Mutations

crowdfundingCampaignApplyInventory

Description

Apply inventory to a crowdfunding campaign

Response

Returns a CrowdfundingCampaignApplyInventoryPayload

Arguments
Name Description
input - CrowdfundingCampaignApplyInventoryInput! Input for applying inventory.

Example

Query
mutation crowdfundingCampaignApplyInventory($input: CrowdfundingCampaignApplyInventoryInput!) {
  crowdfundingCampaignApplyInventory(input: $input) {
    crowdfundingCampaign {
      ...CrowdfundingCampaignFragment
    }
    userErrors {
      ...UserErrorFragment
    }
  }
}
Variables
{"input": CrowdfundingCampaignApplyInventoryInput}
Response
{
  "data": {
    "crowdfundingCampaignApplyInventory": {
      "crowdfundingCampaign": CrowdfundingCampaign,
      "userErrors": [UserError]
    }
  }
}
Mutations

crowdfundingCampaignCancel

Description

Cancel an existing crowdfunding campaign.

Response

Returns a CrowdfundingCampaignCancelPayload

Arguments
Name Description
input - CrowdfundingCampaignCancelInput! Input for Cancelling the crowdfunding campaign.

Example

Query
mutation crowdfundingCampaignCancel($input: CrowdfundingCampaignCancelInput!) {
  crowdfundingCampaignCancel(input: $input) {
    crowdfundingCampaign {
      ...CrowdfundingCampaignFragment
    }
    userErrors {
      ...UserErrorFragment
    }
  }
}
Variables
{"input": CrowdfundingCampaignCancelInput}
Response
{
  "data": {
    "crowdfundingCampaignCancel": {
      "crowdfundingCampaign": CrowdfundingCampaign,
      "userErrors": [UserError]
    }
  }
}
Mutations

crowdfundingCampaignCreate

Description

Create a existing campaign.

Response

Returns a CrowdfundingCampaignCreatePayload

Arguments
Name Description
input - CrowdfundingCampaignCreateInput! Input for creating a crowdfunding campaign.

Example

Query
mutation crowdfundingCampaignCreate($input: CrowdfundingCampaignCreateInput!) {
  crowdfundingCampaignCreate(input: $input) {
    crowdfundingCampaign {
      ...CrowdfundingCampaignFragment
    }
    userErrors {
      ...UserErrorFragment
    }
  }
}
Variables
{"input": CrowdfundingCampaignCreateInput}
Response
{
  "data": {
    "crowdfundingCampaignCreate": {
      "crowdfundingCampaign": CrowdfundingCampaign,
      "userErrors": [UserError]
    }
  }
}
Mutations

crowdfundingCampaignDelete

Description

Delete an existing crowdfunding campaign.

Response

Returns a CrowdfundingCampaignDeletePayload

Arguments
Name Description
input - CrowdfundingCampaignDeleteInput! Input for deleting the crowdfunding campaign.

Example

Query
mutation crowdfundingCampaignDelete($input: CrowdfundingCampaignDeleteInput!) {
  crowdfundingCampaignDelete(input: $input) {
    deletedCrowdfundingCampaignId
    userErrors {
      ...UserErrorFragment
    }
  }
}
Variables
{"input": CrowdfundingCampaignDeleteInput}
Response
{
  "data": {
    "crowdfundingCampaignDelete": {
      "deletedCrowdfundingCampaignId": GlobalID,
      "userErrors": [UserError]
    }
  }
}
Mutations

crowdfundingCampaignEnd

Description

End an existing campaign.

Response

Returns a CrowdfundingCampaignEndPayload

Arguments
Name Description
input - CrowdfundingCampaignEndInput! Input for ending the crowdfunding campaign.

Example

Query
mutation crowdfundingCampaignEnd($input: CrowdfundingCampaignEndInput!) {
  crowdfundingCampaignEnd(input: $input) {
    crowdfundingCampaign {
      ...CrowdfundingCampaignFragment
    }
    userErrors {
      ...UserErrorFragment
    }
  }
}
Variables
{"input": CrowdfundingCampaignEndInput}
Response
{
  "data": {
    "crowdfundingCampaignEnd": {
      "crowdfundingCampaign": CrowdfundingCampaign,
      "userErrors": [UserError]
    }
  }
}
Mutations

crowdfundingCampaignFulfil

Description

Fulfil an existing campaign.

Response

Returns a CrowdfundingCampaignFulfilPayload

Arguments
Name Description
input - CrowdfundingCampaignFulfilInput! Input for fulfilling the crowdfunding campaign.

Example

Query
mutation crowdfundingCampaignFulfil($input: CrowdfundingCampaignFulfilInput!) {
  crowdfundingCampaignFulfil(input: $input) {
    crowdfundingCampaign {
      ...CrowdfundingCampaignFragment
    }
    userErrors {
      ...UserErrorFragment
    }
  }
}
Variables
{"input": CrowdfundingCampaignFulfilInput}
Response
{
  "data": {
    "crowdfundingCampaignFulfil": {
      "crowdfundingCampaign": CrowdfundingCampaign,
      "userErrors": [UserError]
    }
  }
}
Mutations

crowdfundingCampaignLaunch

Description

Launch an existing campaign.

Response

Returns a CrowdfundingCampaignLaunchPayload

Arguments
Name Description
input - CrowdfundingCampaignLaunchInput! Input for launching the crowdfunding campaign.

Example

Query
mutation crowdfundingCampaignLaunch($input: CrowdfundingCampaignLaunchInput!) {
  crowdfundingCampaignLaunch(input: $input) {
    crowdfundingCampaign {
      ...CrowdfundingCampaignFragment
    }
    userErrors {
      ...UserErrorFragment
    }
  }
}
Variables
{"input": CrowdfundingCampaignLaunchInput}
Response
{
  "data": {
    "crowdfundingCampaignLaunch": {
      "crowdfundingCampaign": CrowdfundingCampaign,
      "userErrors": [UserError]
    }
  }
}
Mutations

crowdfundingCampaignRemoveProductVariants

Description

Removes product variants from an existing crowdfunding campaign.

Response

Returns a CrowdfundingCampaignRemoveProductVariantsPayload

Arguments
Name Description
input - CrowdfundingCampaignRemoveProductVariantsInput! Input for removing product variants from the crowdfunding campaign.

Example

Query
mutation crowdfundingCampaignRemoveProductVariants($input: CrowdfundingCampaignRemoveProductVariantsInput!) {
  crowdfundingCampaignRemoveProductVariants(input: $input) {
    crowdfundingCampaign {
      ...CrowdfundingCampaignFragment
    }
    userErrors {
      ...UserErrorFragment
    }
  }
}
Variables
{"input": CrowdfundingCampaignRemoveProductVariantsInput}
Response
{
  "data": {
    "crowdfundingCampaignRemoveProductVariants": {
      "crowdfundingCampaign": CrowdfundingCampaign,
      "userErrors": [UserError]
    }
  }
}
Mutations

crowdfundingCampaignRemoveProducts

Description

Removes products from an existing crowdfunding campaign.

Response

Returns a CrowdfundingCampaignRemoveProductsPayload

Arguments
Name Description
input - CrowdfundingCampaignRemoveProductsInput! Input for removing products from the crowdfunding campaign.

Example

Query
mutation crowdfundingCampaignRemoveProducts($input: CrowdfundingCampaignRemoveProductsInput!) {
  crowdfundingCampaignRemoveProducts(input: $input) {
    crowdfundingCampaign {
      ...CrowdfundingCampaignFragment
    }
    userErrors {
      ...UserErrorFragment
    }
  }
}
Variables
{"input": CrowdfundingCampaignRemoveProductsInput}
Response
{
  "data": {
    "crowdfundingCampaignRemoveProducts": {
      "crowdfundingCampaign": CrowdfundingCampaign,
      "userErrors": [UserError]
    }
  }
}
Mutations

crowdfundingCampaignUpdate

Description

Update an existing campaign.

Response

Returns a CrowdfundingCampaignUpdatePayload

Arguments
Name Description
input - CrowdfundingCampaignUpdateInput! Input for updating a crowdfunding campaign.

Example

Query
mutation crowdfundingCampaignUpdate($input: CrowdfundingCampaignUpdateInput!) {
  crowdfundingCampaignUpdate(input: $input) {
    crowdfundingCampaign {
      ...CrowdfundingCampaignFragment
    }
    userErrors {
      ...UserErrorFragment
    }
  }
}
Variables
{"input": CrowdfundingCampaignUpdateInput}
Response
{
  "data": {
    "crowdfundingCampaignUpdate": {
      "crowdfundingCampaign": CrowdfundingCampaign,
      "userErrors": [UserError]
    }
  }
}

Objects

CrowdfundingCampaign

Description

A Platform crowdfunding campaign

Fields
Field Name Description
activeCampaignOrdersCount - Int! The campaign's total count of active orders.
allocatedInventoryCount - Int! The campaign's count of inventory allocated.
allocationStatus - CampaignAllocationStatus! The allocation status of the campaign.
appliedInventoryCount - Int! The total amount of inventory currently applied to the campaign.
archivedAt - ISO8601DateTime The date the campaign was archived.
campaignEndTotalUnits - Int The campaign's total units when the campaign ends.
campaignEndTotalValue - Money The campaign's total value when the campaign ends.
campaignInventoryItems - [CampaignInventoryItem!]! The campaign's inventory items.
campaignItemType - CampaignItemType! The type of items in the campaign.
campaignItems - [CampaignItem!]! The campaign's items.
campaignOrders - CampaignOrderConnection! The campaign's orders.
Arguments
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.
campaignOrdersCount - Int! The campaign's total count of orders.
campaignRunningTotalUnits - Int The campaign's running total units.
campaignRunningTotalValue - Money The campaign's running total value.
cancelledAt - ISO8601DateTime The date the crowdfunding campaign was cancelled.
channel - Channel! The crowdfunding campaign's channel.
completedAt - ISO8601DateTime The date the crowdfunding campaign completed.
createdAt - ISO8601DateTime The date the crowdfunding campaign was created.
currency - CurrencyCode! The campaign currency.
description - String! The campaign description.
Arguments
interpolate - Boolean

Whether to replace the description's placeholders with actual values.
dueAt - ISO8601DateTime! The date the payment for the crowdfunding campaign is due.
endAt - ISO8601DateTime! The date the campaign will end
endedAt - ISO8601DateTime The date the crowdfunding campaign ended.
fulfilAt - ISO8601DateTime The date the campaign will be fulfilled
fulfillingAt - ISO8601DateTime The date the crowdfunding campaign started fulfilling.
goal - CrowdfundingGoal! The campaign's goal.
goalProgress - Float! The campaign's goal progress percentage.
goalStatus - CrowdfundingGoalStatus! The campaign's goal status.
gracePeriodHours - Int! The number of hours a customer has to rectify a failed campaign payment before their campaign order is cancelled.
id - GlobalID! The ID of the campaign
identifier - String! The identifier of the campaign.
inventoryApplications - [InventoryApplication!]! The campaign's inventory applications.
launchAt - ISO8601DateTime! The date the campaign will be launched
launchedAt - ISO8601DateTime The date the crowdfunding campaign launched.
limit - Int The maximum number of units of the linked products that can be sold
name - String! The name of the campaign.
Arguments
interpolate - Boolean

Whether to replace the name's placeholders with actual values.
productVariants - [ProductVariant!] The product IDs that are included in the campaign.
products - [Product!] The product IDs that are included in the campaign.
reference - String! The campaign reference.
reservedItemsCount - Int! The campaign's total count of reserved items.
sequentialId - Int! The ordered ID of the campaign.
status - CampaignStatus! The campaign's status (eg. active).
updatedAt - ISO8601DateTime The date the presale was last updated.
Example
{
  "activeCampaignOrdersCount": 987,
  "allocatedInventoryCount": 123,
  "allocationStatus": "ALLOCATED",
  "appliedInventoryCount": 123,
  "archivedAt": ISO8601DateTime,
  "campaignEndTotalUnits": 123,
  "campaignEndTotalValue": Money,
  "campaignInventoryItems": [CampaignInventoryItem],
  "campaignItemType": "PRODUCT",
  "campaignItems": [CampaignItem],
  "campaignOrders": CampaignOrderConnection,
  "campaignOrdersCount": 123,
  "campaignRunningTotalUnits": 123,
  "campaignRunningTotalValue": Money,
  "cancelledAt": ISO8601DateTime,
  "channel": Channel,
  "completedAt": ISO8601DateTime,
  "createdAt": ISO8601DateTime,
  "currency": "AED",
  "description": "xyz789",
  "dueAt": ISO8601DateTime,
  "endAt": ISO8601DateTime,
  "endedAt": ISO8601DateTime,
  "fulfilAt": ISO8601DateTime,
  "fulfillingAt": ISO8601DateTime,
  "goal": TotalUnitsCrowdfundingGoal,
  "goalProgress": 123.45,
  "goalStatus": "FAILED",
  "gracePeriodHours": 123,
  "id": GlobalID,
  "identifier": "xyz789",
  "inventoryApplications": [InventoryApplication],
  "launchAt": ISO8601DateTime,
  "launchedAt": ISO8601DateTime,
  "limit": 987,
  "name": "xyz789",
  "productVariants": [ProductVariant],
  "products": [Product],
  "reference": "abc123",
  "reservedItemsCount": 123,
  "sequentialId": 123,
  "status": "CANCELLED",
  "updatedAt": ISO8601DateTime
}
Objects

SearchResult

Description

A search result.

Fields
Field Name Description
queryArguments - String! The query arguments as a JSON string
campaignOrders - CampaignOrderConnection The matching campaign orders
Arguments
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.
crowdfundingCampaigns - CrowdfundingCampaignConnection The matching crowdfunding campaigns
Arguments
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.
presaleCampaigns - PresaleCampaignConnection The matching presale campaigns
Arguments
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.
subscriptionOrders - SubscriptionOrderConnection
Arguments
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.
subscriptionPlanGroups - SubscriptionPlanGroupConnection
Arguments
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
Arguments
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.
Example
{
  "queryArguments": "abc123",
  "campaignOrders": CampaignOrderConnection,
  "crowdfundingCampaigns": CrowdfundingCampaignConnection,
  "presaleCampaigns": PresaleCampaignConnection,
  "subscriptionOrders": SubscriptionOrderConnection,
  "subscriptionPlanGroups": SubscriptionPlanGroupConnection,
  "subscriptions": SubscriptionConnection
}

Presale Campaign

Queries

presaleCampaign

Description

Find a presale campaign by ID

Response

Returns a PresaleCampaign

Arguments
Name Description
id - GlobalID! The presale campaign's ID.

Example

Query
query presaleCampaign($id: GlobalID!) {
  presaleCampaign(id: $id) {
    activeCampaignOrdersCount
    allocatedInventoryCount
    allocationStatus
    appliedInventoryCount
    archivedAt
    campaignInventoryItems {
      ...CampaignInventoryItemFragment
    }
    campaignItemType
    campaignItems {
      ...CampaignItemFragment
    }
    campaignOrders {
      ...CampaignOrderConnectionFragment
    }
    campaignOrdersCount
    cancelledAt
    channel {
      ...ChannelFragment
    }
    completedAt
    createdAt
    deposit {
      ...CampaignDepositFragment
    }
    description
    dueAt
    endAt
    endedAt
    fulfilAt
    fulfillingAt
    gracePeriodHours
    id
    identifier
    inventoryApplications {
      ...InventoryApplicationFragment
    }
    inventoryPolicy
    launchAt
    launchedAt
    limit
    name
    productVariants {
      ...ProductVariantFragment
    }
    products {
      ...ProductFragment
    }
    reference
    reservedItemsCount
    sequentialId
    status
    updatedAt
  }
}
Variables
{"id": GlobalID}
Response
{
  "data": {
    "presaleCampaign": {
      "activeCampaignOrdersCount": 123,
      "allocatedInventoryCount": 123,
      "allocationStatus": "ALLOCATED",
      "appliedInventoryCount": 987,
      "archivedAt": ISO8601DateTime,
      "campaignInventoryItems": [CampaignInventoryItem],
      "campaignItemType": "PRODUCT",
      "campaignItems": [CampaignItem],
      "campaignOrders": CampaignOrderConnection,
      "campaignOrdersCount": 123,
      "cancelledAt": ISO8601DateTime,
      "channel": Channel,
      "completedAt": ISO8601DateTime,
      "createdAt": ISO8601DateTime,
      "deposit": CampaignDeposit,
      "description": "You will be charged the remaining balance when the product is released.",
      "dueAt": ISO8601DateTime,
      "endAt": ISO8601DateTime,
      "endedAt": ISO8601DateTime,
      "fulfilAt": ISO8601DateTime,
      "fulfillingAt": ISO8601DateTime,
      "gracePeriodHours": 123,
      "id": GlobalID,
      "identifier": "xyz789",
      "inventoryApplications": [InventoryApplication],
      "inventoryPolicy": "ON_FULFILMENT",
      "launchAt": ISO8601DateTime,
      "launchedAt": ISO8601DateTime,
      "limit": 123,
      "name": "June Pre-order for Product.",
      "productVariants": [ProductVariant],
      "products": [Product],
      "reference": "Pre-order June Product #REF-021",
      "reservedItemsCount": 987,
      "sequentialId": 987,
      "status": "CANCELLED",
      "updatedAt": ISO8601DateTime
    }
  }
}
Queries

presaleCampaigns

Description

List all presale campaigns

Response

Returns a PresaleCampaignConnection

Arguments
Name 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.

Example

Query
query presaleCampaigns(
  $after: String,
  $before: String,
  $first: Int,
  $last: Int
) {
  presaleCampaigns(
    after: $after,
    before: $before,
    first: $first,
    last: $last
  ) {
    edges {
      ...PresaleCampaignEdgeFragment
    }
    nodes {
      ...PresaleCampaignFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
  }
}
Variables
{
  "after": "xyz789",
  "before": "abc123",
  "first": 123,
  "last": 123
}
Response
{
  "data": {
    "presaleCampaigns": {
      "edges": [PresaleCampaignEdge],
      "nodes": [PresaleCampaign],
      "pageInfo": PageInfo,
      "totalCount": 123
    }
  }
}
Queries

searchPresaleCampaigns

Description

Search presale campaigns

Response

Returns a SearchResult

Arguments
Name Description
allocationStatus - [CampaignAllocationStatus!] The campaign's allocation status.
isAllocating - Boolean Whether the campaign is allocating.
isArchived - Boolean Whether the campaign is archived.
productIds - [SharedGlobalID!] Return campaigns containing any of these product IDs
productVariantIds - [SharedGlobalID!] Return campaigns containing any of these product variant IDs.
query - String A query string.
sortDirection - SortDirection The sort direction.
sortKey - PresaleCampaignSortKey The key used to sort campaigns.
status - [CampaignStatus!] The campaign's status.

Example

Query
query searchPresaleCampaigns(
  $allocationStatus: [CampaignAllocationStatus!],
  $isAllocating: Boolean,
  $isArchived: Boolean,
  $productIds: [SharedGlobalID!],
  $productVariantIds: [SharedGlobalID!],
  $query: String,
  $sortDirection: SortDirection,
  $sortKey: PresaleCampaignSortKey,
  $status: [CampaignStatus!]
) {
  searchPresaleCampaigns(
    allocationStatus: $allocationStatus,
    isAllocating: $isAllocating,
    isArchived: $isArchived,
    productIds: $productIds,
    productVariantIds: $productVariantIds,
    query: $query,
    sortDirection: $sortDirection,
    sortKey: $sortKey,
    status: $status
  ) {
    queryArguments
    campaignOrders {
      ...CampaignOrderConnectionFragment
    }
    crowdfundingCampaigns {
      ...CrowdfundingCampaignConnectionFragment
    }
    presaleCampaigns {
      ...PresaleCampaignConnectionFragment
    }
    subscriptionOrders {
      ...SubscriptionOrderConnectionFragment
    }
    subscriptionPlanGroups {
      ...SubscriptionPlanGroupConnectionFragment
    }
    subscriptions {
      ...SubscriptionConnectionFragment
    }
  }
}
Variables
{
  "allocationStatus": ["ALLOCATED"],
  "isAllocating": true,
  "isArchived": true,
  "productIds": [SharedGlobalID],
  "productVariantIds": [SharedGlobalID],
  "query": "abc123",
  "sortDirection": "ASC",
  "sortKey": "COMPLETED_AT",
  "status": ["CANCELLED"]
}
Response
{
  "data": {
    "searchPresaleCampaigns": {
      "queryArguments": "xyz789",
      "campaignOrders": CampaignOrderConnection,
      "crowdfundingCampaigns": CrowdfundingCampaignConnection,
      "presaleCampaigns": PresaleCampaignConnection,
      "subscriptionOrders": SubscriptionOrderConnection,
      "subscriptionPlanGroups": SubscriptionPlanGroupConnection,
      "subscriptions": SubscriptionConnection
    }
  }
}

Mutations

presaleCampaignAddProductVariants

Description

Add product variants to an existing campaign.

Response

Returns a PresaleCampaignAddProductVariantsPayload

Arguments
Name Description
input - PresaleCampaignAddProductVariantsInput! Input for adding product variants to the presale campaign.

Example

Query
mutation presaleCampaignAddProductVariants($input: PresaleCampaignAddProductVariantsInput!) {
  presaleCampaignAddProductVariants(input: $input) {
    presaleCampaign {
      ...PresaleCampaignFragment
    }
    userErrors {
      ...UserErrorFragment
    }
  }
}
Variables
{"input": PresaleCampaignAddProductVariantsInput}
Response
{
  "data": {
    "presaleCampaignAddProductVariants": {
      "presaleCampaign": PresaleCampaign,
      "userErrors": [UserError]
    }
  }
}
Mutations

presaleCampaignAddProducts

Description

Add products to an existing campaign.

Response

Returns a PresaleCampaignAddProductsPayload

Arguments
Name Description
input - PresaleCampaignAddProductsInput! Input for adding products to the presale campaign.

Example

Query
mutation presaleCampaignAddProducts($input: PresaleCampaignAddProductsInput!) {
  presaleCampaignAddProducts(input: $input) {
    presaleCampaign {
      ...PresaleCampaignFragment
    }
    userErrors {
      ...UserErrorFragment
    }
  }
}
Variables
{"input": PresaleCampaignAddProductsInput}
Response
{
  "data": {
    "presaleCampaignAddProducts": {
      "presaleCampaign": PresaleCampaign,
      "userErrors": [UserError]
    }
  }
}
Mutations

presaleCampaignApplyBulkInventory

Description

Apply bulk inventory to a presale campaign

Response

Returns a PresaleCampaignApplyBulkInventoryPayload

Arguments
Name Description
input - PresaleCampaignApplyBulkInventoryInput! Input for applying bulk inventory.

Example

Query
mutation presaleCampaignApplyBulkInventory($input: PresaleCampaignApplyBulkInventoryInput!) {
  presaleCampaignApplyBulkInventory(input: $input) {
    presaleCampaign {
      ...PresaleCampaignFragment
    }
    userErrors {
      ...UserErrorFragment
    }
  }
}
Variables
{"input": PresaleCampaignApplyBulkInventoryInput}
Response
{
  "data": {
    "presaleCampaignApplyBulkInventory": {
      "presaleCampaign": PresaleCampaign,
      "userErrors": [UserError]
    }
  }
}
Mutations

presaleCampaignApplyInventory

Description

Apply inventory to a presale campaign

Response

Returns a PresaleCampaignApplyInventoryPayload

Arguments
Name Description
input - PresaleCampaignApplyInventoryInput! Input for applying inventory.

Example

Query
mutation presaleCampaignApplyInventory($input: PresaleCampaignApplyInventoryInput!) {
  presaleCampaignApplyInventory(input: $input) {
    presaleCampaign {
      ...PresaleCampaignFragment
    }
    userErrors {
      ...UserErrorFragment
    }
  }
}
Variables
{"input": PresaleCampaignApplyInventoryInput}
Response
{
  "data": {
    "presaleCampaignApplyInventory": {
      "presaleCampaign": PresaleCampaign,
      "userErrors": [UserError]
    }
  }
}
Mutations

presaleCampaignCancel

Description

Cancel an existing presale campaign.

Response

Returns a PresaleCampaignCancelPayload

Arguments
Name Description
input - PresaleCampaignCancelInput! Input for cancelling the presale campaign.

Example

Query
mutation presaleCampaignCancel($input: PresaleCampaignCancelInput!) {
  presaleCampaignCancel(input: $input) {
    presaleCampaign {
      ...PresaleCampaignFragment
    }
    userErrors {
      ...UserErrorFragment
    }
  }
}
Variables
{"input": PresaleCampaignCancelInput}
Response
{
  "data": {
    "presaleCampaignCancel": {
      "presaleCampaign": PresaleCampaign,
      "userErrors": [UserError]
    }
  }
}
Mutations

presaleCampaignCreate

Description

Create a new presale campaign.

Response

Returns a PresaleCampaignCreatePayload

Arguments
Name Description
input - PresaleCampaignCreateInput! Input for creating a presale campaign.

Example

Query
mutation presaleCampaignCreate($input: PresaleCampaignCreateInput!) {
  presaleCampaignCreate(input: $input) {
    presaleCampaign {
      ...PresaleCampaignFragment
    }
    userErrors {
      ...UserErrorFragment
    }
  }
}
Variables
{"input": PresaleCampaignCreateInput}
Response
{
  "data": {
    "presaleCampaignCreate": {
      "presaleCampaign": PresaleCampaign,
      "userErrors": [UserError]
    }
  }
}
Mutations

presaleCampaignDelete

Description

Delete an existing presale campaign.

Response

Returns a PresaleCampaignDeletePayload

Arguments
Name Description
input - PresaleCampaignDeleteInput! Input for deleting the presale campaign.

Example

Query
mutation presaleCampaignDelete($input: PresaleCampaignDeleteInput!) {
  presaleCampaignDelete(input: $input) {
    deletedPresaleCampaignId
    userErrors {
      ...UserErrorFragment
    }
  }
}
Variables
{"input": PresaleCampaignDeleteInput}
Response
{
  "data": {
    "presaleCampaignDelete": {
      "deletedPresaleCampaignId": GlobalID,
      "userErrors": [UserError]
    }
  }
}
Mutations

presaleCampaignEnd

Description

End an existing campaign.

Response

Returns a PresaleCampaignEndPayload

Arguments
Name Description
input - PresaleCampaignEndInput! Input for ending the presale campaign.

Example

Query
mutation presaleCampaignEnd($input: PresaleCampaignEndInput!) {
  presaleCampaignEnd(input: $input) {
    presaleCampaign {
      ...PresaleCampaignFragment
    }
    userErrors {
      ...UserErrorFragment
    }
  }
}
Variables
{"input": PresaleCampaignEndInput}
Response
{
  "data": {
    "presaleCampaignEnd": {
      "presaleCampaign": PresaleCampaign,
      "userErrors": [UserError]
    }
  }
}
Mutations

presaleCampaignFulfil

Description

Fulfil an existing campaign.

Response

Returns a PresaleCampaignFulfilPayload

Arguments
Name Description
input - PresaleCampaignFulfilInput! Input for fulfilling the presale campaign.

Example

Query
mutation presaleCampaignFulfil($input: PresaleCampaignFulfilInput!) {
  presaleCampaignFulfil(input: $input) {
    presaleCampaign {
      ...PresaleCampaignFragment
    }
    userErrors {
      ...UserErrorFragment
    }
  }
}
Variables
{"input": PresaleCampaignFulfilInput}
Response
{
  "data": {
    "presaleCampaignFulfil": {
      "presaleCampaign": PresaleCampaign,
      "userErrors": [UserError]
    }
  }
}
Mutations

presaleCampaignLaunch

Description

Launch an existing campaign.

Response

Returns a PresaleCampaignLaunchPayload

Arguments
Name Description
input - PresaleCampaignLaunchInput! Input for launching the presale campaign.

Example

Query
mutation presaleCampaignLaunch($input: PresaleCampaignLaunchInput!) {
  presaleCampaignLaunch(input: $input) {
    presaleCampaign {
      ...PresaleCampaignFragment
    }
    userErrors {
      ...UserErrorFragment
    }
  }
}
Variables
{"input": PresaleCampaignLaunchInput}
Response
{
  "data": {
    "presaleCampaignLaunch": {
      "presaleCampaign": PresaleCampaign,
      "userErrors": [UserError]
    }
  }
}
Mutations

presaleCampaignRemoveProductVariants

Description

Remove product variants from presale campaign

Response

Returns a PresaleCampaignRemoveProductVariantsPayload

Arguments
Name Description
input - PresaleCampaignRemoveProductVariantsInput! Input for removing product variants from the presale campaign.

Example

Query
mutation presaleCampaignRemoveProductVariants($input: PresaleCampaignRemoveProductVariantsInput!) {
  presaleCampaignRemoveProductVariants(input: $input) {
    presaleCampaign {
      ...PresaleCampaignFragment
    }
    userErrors {
      ...UserErrorFragment
    }
  }
}
Variables
{"input": PresaleCampaignRemoveProductVariantsInput}
Response
{
  "data": {
    "presaleCampaignRemoveProductVariants": {
      "presaleCampaign": PresaleCampaign,
      "userErrors": [UserError]
    }
  }
}
Mutations

presaleCampaignRemoveProducts

Description

Remove products from presale campaign

Response

Returns a PresaleCampaignRemoveProductsPayload

Arguments
Name Description
input - PresaleCampaignRemoveProductsInput! Input for removing products from the presale campaign.

Example

Query
mutation presaleCampaignRemoveProducts($input: PresaleCampaignRemoveProductsInput!) {
  presaleCampaignRemoveProducts(input: $input) {
    presaleCampaign {
      ...PresaleCampaignFragment
    }
    userErrors {
      ...UserErrorFragment
    }
  }
}
Variables
{"input": PresaleCampaignRemoveProductsInput}
Response
{
  "data": {
    "presaleCampaignRemoveProducts": {
      "presaleCampaign": PresaleCampaign,
      "userErrors": [UserError]
    }
  }
}
Mutations

presaleCampaignUpdate

Description

Update a new presale campaign.

Response

Returns a PresaleCampaignUpdatePayload

Arguments
Name Description
input - PresaleCampaignUpdateInput! Input for updating the presale campaign.

Example

Query
mutation presaleCampaignUpdate($input: PresaleCampaignUpdateInput!) {
  presaleCampaignUpdate(input: $input) {
    presaleCampaign {
      ...PresaleCampaignFragment
    }
    userErrors {
      ...UserErrorFragment
    }
  }
}
Variables
{"input": PresaleCampaignUpdateInput}
Response
{
  "data": {
    "presaleCampaignUpdate": {
      "presaleCampaign": PresaleCampaign,
      "userErrors": [UserError]
    }
  }
}

Objects

PresaleCampaign

Description

A Platform campaign of type Presale.

Fields
Field Name Description
activeCampaignOrdersCount - Int! The campaign's total count of active orders.
allocatedInventoryCount - Int! The campaign's count of inventory allocated.
allocationStatus - CampaignAllocationStatus! The allocation status of the campaign.
appliedInventoryCount - Int! The total amount of inventory currently applied to the campaign.
archivedAt - ISO8601DateTime The date the campaign was archived.
campaignInventoryItems - [CampaignInventoryItem!]! The campaign's inventory items.
campaignItemType - CampaignItemType! The type of items in the campaign.
campaignItems - [CampaignItem!]! The campaign's items.
campaignOrders - CampaignOrderConnection! The campaign's orders.
Arguments
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.
campaignOrdersCount - Int! The campaign's total count of orders.
cancelledAt - ISO8601DateTime The date the presale was cancelled.
channel - Channel! The presale campaign's channel.
completedAt - ISO8601DateTime The date the presale completed.
createdAt - ISO8601DateTime The date the presale created.
deposit - CampaignDeposit The amount to be collected at checkout.
description - String! The campaign description.
Arguments
interpolate - Boolean

Whether to replace the description's placeholders with actual values.
dueAt - ISO8601DateTime! The date the payment for the presale is due.
endAt - ISO8601DateTime! The date the presale will end.
endedAt - ISO8601DateTime The date the presale ended.
fulfilAt - ISO8601DateTime The date the presale will be fulfilled.
fulfillingAt - ISO8601DateTime The date the presale started fulfilling.
gracePeriodHours - Int! The number of hours a customer has to rectify a failed presale campaign payment before their campaign order is cancelled.
id - GlobalID! The ID of the campaign.
identifier - String! The identifier of the campaign.
inventoryApplications - [InventoryApplication!]! The campaign's inventory applications.
inventoryPolicy - PresaleInventoryPolicy!
launchAt - ISO8601DateTime! The date the presale will be launched.
launchedAt - ISO8601DateTime The date the presale launched.
limit - Int! The maximum number of units of the linked products that can be sold.
name - String! The name of the campaign.
Arguments
interpolate - Boolean

Whether to replace the name's placeholders with actual values.
productVariants - [ProductVariant!] The product IDs that are included in the campaign.
products - [Product!] The product IDs that are included in the campaign.
reference - String! The campaign reference.
reservedItemsCount - Int! The campaign's total count of reserved items.
sequentialId - Int! The ordered ID of the campaign.
status - CampaignStatus! The campaign's status.
updatedAt - ISO8601DateTime The date the presale was last updated.
Example
{
  "activeCampaignOrdersCount": 123,
  "allocatedInventoryCount": 123,
  "allocationStatus": "ALLOCATED",
  "appliedInventoryCount": 987,
  "archivedAt": ISO8601DateTime,
  "campaignInventoryItems": [CampaignInventoryItem],
  "campaignItemType": "PRODUCT",
  "campaignItems": [CampaignItem],
  "campaignOrders": CampaignOrderConnection,
  "campaignOrdersCount": 123,
  "cancelledAt": ISO8601DateTime,
  "channel": Channel,
  "completedAt": ISO8601DateTime,
  "createdAt": ISO8601DateTime,
  "deposit": CampaignDeposit,
  "description": "You will be charged the remaining balance when the product is released.",
  "dueAt": ISO8601DateTime,
  "endAt": ISO8601DateTime,
  "endedAt": ISO8601DateTime,
  "fulfilAt": ISO8601DateTime,
  "fulfillingAt": ISO8601DateTime,
  "gracePeriodHours": 987,
  "id": GlobalID,
  "identifier": "xyz789",
  "inventoryApplications": [InventoryApplication],
  "inventoryPolicy": "ON_FULFILMENT",
  "launchAt": ISO8601DateTime,
  "launchedAt": ISO8601DateTime,
  "limit": 987,
  "name": "June Pre-order for Product.",
  "productVariants": [ProductVariant],
  "products": [Product],
  "reference": "Pre-order June Product #REF-021",
  "reservedItemsCount": 123,
  "sequentialId": 123,
  "status": "CANCELLED",
  "updatedAt": ISO8601DateTime
}
Objects

SearchResult

Description

A search result.

Fields
Field Name Description
queryArguments - String! The query arguments as a JSON string
campaignOrders - CampaignOrderConnection The matching campaign orders
Arguments
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.
crowdfundingCampaigns - CrowdfundingCampaignConnection The matching crowdfunding campaigns
Arguments
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.
presaleCampaigns - PresaleCampaignConnection The matching presale campaigns
Arguments
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.
subscriptionOrders - SubscriptionOrderConnection
Arguments
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.
subscriptionPlanGroups - SubscriptionPlanGroupConnection
Arguments
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
Arguments
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.
Example
{
  "queryArguments": "xyz789",
  "campaignOrders": CampaignOrderConnection,
  "crowdfundingCampaigns": CrowdfundingCampaignConnection,
  "presaleCampaigns": PresaleCampaignConnection,
  "subscriptionOrders": SubscriptionOrderConnection,
  "subscriptionPlanGroups": SubscriptionPlanGroupConnection,
  "subscriptions": SubscriptionConnection
}

Subscription Planning

Queries

subscriptionPlan

Response

Returns a SubscriptionPlan

Arguments
Name Description
id - GlobalID!

Example

Query
query subscriptionPlan($id: GlobalID!) {
  subscriptionPlan(id: $id) {
    anchors {
      ...SubscriptionAnchorFragment
    }
    billingBehaviour {
      ...SubscriptionBillingBehaviourFragment
    }
    createdAt
    deliveryBehaviour {
      ...SubscriptionDeliveryBehaviourFragment
    }
    frequency {
      ...SubscriptionFrequencyFragment
    }
    id
    inventoryBehaviour {
      ...SubscriptionInventoryBehaviourFragment
    }
    name
    pricingBehaviour {
      ...SubscriptionPricingBehaviourFragment
    }
    status
    subscriptionPlanGroup {
      ...SubscriptionPlanGroupFragment
    }
    subscriptionsCount
    updatedAt
  }
}
Variables
{"id": GlobalID}
Response
{
  "data": {
    "subscriptionPlan": {
      "anchors": [SubscriptionAnchor],
      "billingBehaviour": SubscriptionBillingBehaviour,
      "createdAt": 1592577642,
      "deliveryBehaviour": SubscriptionDeliveryBehaviour,
      "frequency": SubscriptionFrequency,
      "id": GlobalID,
      "inventoryBehaviour": SubscriptionInventoryBehaviour,
      "name": "xyz789",
      "pricingBehaviour": SubscriptionPricingBehaviour,
      "status": "ACTIVE",
      "subscriptionPlanGroup": SubscriptionPlanGroup,
      "subscriptionsCount": Count,
      "updatedAt": 1592577642
    }
  }
}
Queries

subscriptionPlanGroup

Description

Find an subscription plan group by ID.

Response

Returns a SubscriptionPlanGroup

Arguments
Name Description
id - GlobalID! The subscription plan group's ID.

Example

Query
query subscriptionPlanGroup($id: GlobalID!) {
  subscriptionPlanGroup(id: $id) {
    billingBehaviour {
      ...SubscriptionBillingBehaviourFragment
    }
    channel {
      ...ChannelFragment
    }
    createdAt
    deliveryBehaviour {
      ...SubscriptionDeliveryBehaviourFragment
    }
    externalId
    id
    identifier
    inventoryBehaviour {
      ...SubscriptionInventoryBehaviourFragment
    }
    name
    pricingBehaviour {
      ...SubscriptionPricingBehaviourFragment
    }
    productGroup {
      ...SubscriptionProductGroupFragment
    }
    reference
    status
    subscriptionPlans {
      ...SubscriptionPlanFragment
    }
    subscriptionPlansCount
    subscriptionsCount
    timezone
    updatedAt
  }
}
Variables
{"id": GlobalID}
Response
{
  "data": {
    "subscriptionPlanGroup": {
      "billingBehaviour": SubscriptionBillingBehaviour,
      "channel": Channel,
      "createdAt": 1592577642,
      "deliveryBehaviour": SubscriptionDeliveryBehaviour,
      "externalId": "abc123",
      "id": GlobalID,
      "identifier": "abc123",
      "inventoryBehaviour": SubscriptionInventoryBehaviour,
      "name": "abc123",
      "pricingBehaviour": SubscriptionPricingBehaviour,
      "productGroup": SubscriptionProductGroup,
      "reference": "xyz789",
      "status": "ACTIVE",
      "subscriptionPlans": [SubscriptionPlan],
      "subscriptionPlansCount": Count,
      "subscriptionsCount": Count,
      "timezone": "xyz789",
      "updatedAt": 1592577642
    }
  }
}
Queries

subscriptionPlanGroups

Description

List all subscription plan groups.

Response

Returns a SubscriptionPlanGroupConnection

Arguments
Name 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.

Example

Query
query subscriptionPlanGroups(
  $after: String,
  $before: String,
  $first: Int,
  $last: Int
) {
  subscriptionPlanGroups(
    after: $after,
    before: $before,
    first: $first,
    last: $last
  ) {
    edges {
      ...SubscriptionPlanGroupEdgeFragment
    }
    nodes {
      ...SubscriptionPlanGroupFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
  }
}
Variables
{
  "after": "xyz789",
  "before": "abc123",
  "first": 987,
  "last": 987
}
Response
{
  "data": {
    "subscriptionPlanGroups": {
      "edges": [SubscriptionPlanGroupEdge],
      "nodes": [SubscriptionPlanGroup],
      "pageInfo": PageInfo,
      "totalCount": 123
    }
  }
}
Queries

subscriptionPlans

Response

Returns a SubscriptionPlanConnection

Arguments
Name 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.

Example

Query
query subscriptionPlans(
  $after: String,
  $before: String,
  $first: Int,
  $last: Int
) {
  subscriptionPlans(
    after: $after,
    before: $before,
    first: $first,
    last: $last
  ) {
    edges {
      ...SubscriptionPlanEdgeFragment
    }
    nodes {
      ...SubscriptionPlanFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
  }
}
Variables
{
  "after": "xyz789",
  "before": "abc123",
  "first": 123,
  "last": 123
}
Response
{
  "data": {
    "subscriptionPlans": {
      "edges": [SubscriptionPlanEdge],
      "nodes": [SubscriptionPlan],
      "pageInfo": PageInfo,
      "totalCount": 123
    }
  }
}

Mutations

subscriptionPlanDelete

Description

Deletes a subscription plan.

Response

Returns a SubscriptionPlanDeletePayload

Arguments
Name Description
input - SubscriptionPlanDeleteInput! Input for deleting a subscription plan.

Example

Query
mutation subscriptionPlanDelete($input: SubscriptionPlanDeleteInput!) {
  subscriptionPlanDelete(input: $input) {
    deletedSubscriptionPlanId
    userErrors {
      ...UserErrorFragment
    }
  }
}
Variables
{"input": SubscriptionPlanDeleteInput}
Response
{
  "data": {
    "subscriptionPlanDelete": {
      "deletedSubscriptionPlanId": GlobalID,
      "userErrors": [UserError]
    }
  }
}
Mutations

subscriptionPlanGroupCreate

Description

Creates a subscription plan group.

Response

Returns a SubscriptionPlanGroupCreatePayload

Arguments
Name Description
input - SubscriptionPlanGroupCreateInput! Input for creating a subscription plan group.

Example

Query
mutation subscriptionPlanGroupCreate($input: SubscriptionPlanGroupCreateInput!) {
  subscriptionPlanGroupCreate(input: $input) {
    subscriptionPlanGroup {
      ...SubscriptionPlanGroupFragment
    }
    userErrors {
      ...UserErrorFragment
    }
  }
}
Variables
{"input": SubscriptionPlanGroupCreateInput}
Response
{
  "data": {
    "subscriptionPlanGroupCreate": {
      "subscriptionPlanGroup": SubscriptionPlanGroup,
      "userErrors": [UserError]
    }
  }
}

Objects

SubscriptionPlan

Description

Translation missing: en.graphql.objects.subscription_plan.description

Fields
Field Name Description
anchors - [SubscriptionAnchor!]!
billingBehaviour - SubscriptionBillingBehaviour! Translation missing: en.graphql.objects.subscription_plan.fields.billing_behaviour
createdAt - Timestamp! Translation missing: en.graphql.objects.subscription_plan.fields.created_at
deliveryBehaviour - SubscriptionDeliveryBehaviour! Translation missing: en.graphql.objects.subscription_plan.fields.delivery_behaviour
frequency - SubscriptionFrequency! Translation missing: en.graphql.objects.subscription_plan.fields.frequency
id - GlobalID! Translation missing: en.graphql.objects.subscription_plan.fields.id
inventoryBehaviour - SubscriptionInventoryBehaviour! Translation missing: en.graphql.objects.subscription_plan.fields.inventory_behaviour
name - String! Translation missing: en.graphql.objects.subscription_plan.fields.name
pricingBehaviour - SubscriptionPricingBehaviour! Translation missing: en.graphql.objects.subscription_plan.fields.pricing_behaviour
status - SubscriptionPlanStatus! Translation missing: en.graphql.objects.subscription_plan.fields.status
subscriptionPlanGroup - SubscriptionPlanGroup! Translation missing: en.graphql.objects.subscription_plan.fields.subscription_plan_group
subscriptionsCount - Count! Translation missing: en.graphql.objects.subscription_plan.fields.subscriptions_count
updatedAt - Timestamp! Translation missing: en.graphql.objects.subscription_plan.fields.updated_at
Example
{
  "anchors": [SubscriptionAnchor],
  "billingBehaviour": SubscriptionBillingBehaviour,
  "createdAt": 1592577642,
  "deliveryBehaviour": SubscriptionDeliveryBehaviour,
  "frequency": SubscriptionFrequency,
  "id": GlobalID,
  "inventoryBehaviour": SubscriptionInventoryBehaviour,
  "name": "xyz789",
  "pricingBehaviour": SubscriptionPricingBehaviour,
  "status": "ACTIVE",
  "subscriptionPlanGroup": SubscriptionPlanGroup,
  "subscriptionsCount": Count,
  "updatedAt": 1592577642
}
Objects

SubscriptionPlanGroup

Description

Translation missing: en.graphql.objects.subscription_plan_group.description

Fields
Field Name Description
billingBehaviour - SubscriptionBillingBehaviour! Translation missing: en.graphql.objects.subscription_plan_group.fields.billing_behaviour
channel - Channel! Translation missing: en.graphql.objects.subscription_plan_group.fields.channel
createdAt - Timestamp! Translation missing: en.graphql.objects.subscription_plan_group.fields.created_at
deliveryBehaviour - SubscriptionDeliveryBehaviour! Translation missing: en.graphql.objects.subscription_plan_group.fields.delivery_behaviour
externalId - String! Translation missing: en.graphql.objects.subscription_plan_group.fields.external_id
id - GlobalID! Translation missing: en.graphql.objects.subscription_plan_group.fields.id
identifier - String! Translation missing: en.graphql.objects.subscription_plan_group.fields.identifier
inventoryBehaviour - SubscriptionInventoryBehaviour! Translation missing: en.graphql.objects.subscription_plan_group.fields.inventory_behaviour
name - String! Translation missing: en.graphql.objects.subscription_plan_group.fields.name
pricingBehaviour - SubscriptionPricingBehaviour! Translation missing: en.graphql.objects.subscription_plan_group.fields.pricing_behaviour
productGroup - SubscriptionProductGroup!
reference - String! Translation missing: en.graphql.objects.subscription_plan_group.fields.reference
status - SubscriptionPlanGroupStatus! Translation missing: en.graphql.objects.subscription_plan_group.fields.status
subscriptionPlans - [SubscriptionPlan!]! Translation missing: en.graphql.objects.subscription_plan_group.fields.subscription_plans
subscriptionPlansCount - Count! Translation missing: en.graphql.objects.subscription_plan_group.fields.subscription_plans_count
subscriptionsCount - Count! Translation missing: en.graphql.objects.subscription_plan_group.fields.subscriptions_count
timezone - String! Translation missing: en.graphql.objects.subscription_plan_group.fields.timezone
updatedAt - Timestamp! Translation missing: en.graphql.objects.subscription_plan_group.fields.updated_at
Example
{
  "billingBehaviour": SubscriptionBillingBehaviour,
  "channel": Channel,
  "createdAt": 1592577642,
  "deliveryBehaviour": SubscriptionDeliveryBehaviour,
  "externalId": "abc123",
  "id": GlobalID,
  "identifier": "xyz789",
  "inventoryBehaviour": SubscriptionInventoryBehaviour,
  "name": "xyz789",
  "pricingBehaviour": SubscriptionPricingBehaviour,
  "productGroup": SubscriptionProductGroup,
  "reference": "abc123",
  "status": "ACTIVE",
  "subscriptionPlans": [SubscriptionPlan],
  "subscriptionPlansCount": Count,
  "subscriptionsCount": Count,
  "timezone": "xyz789",
  "updatedAt": 1592577642
}

Subscriptions

Queries

searchSubscriptionOrders

Description

Search subscriptions

Response

Returns a SearchResult

Arguments
Name Description
customerIds - [SharedGlobalID!]
paymentStatus - [SubscriptionOrderPaymentStatus!]
query - String A query string.
sortDirection - SortDirection The sort direction.
sortKey - SubscriptionOrderSortKey
status - [SubscriptionOrderStatus!] The subscription order's status.
subscriptionId - GlobalID
subscriptionPlanId - GlobalID

Example

Query
query searchSubscriptionOrders(
  $customerIds: [SharedGlobalID!],
  $paymentStatus: [SubscriptionOrderPaymentStatus!],
  $query: String,
  $sortDirection: SortDirection,
  $sortKey: SubscriptionOrderSortKey,
  $status: [SubscriptionOrderStatus!],
  $subscriptionId: GlobalID,
  $subscriptionPlanId: GlobalID
) {
  searchSubscriptionOrders(
    customerIds: $customerIds,
    paymentStatus: $paymentStatus,
    query: $query,
    sortDirection: $sortDirection,
    sortKey: $sortKey,
    status: $status,
    subscriptionId: $subscriptionId,
    subscriptionPlanId: $subscriptionPlanId
  ) {
    queryArguments
    campaignOrders {
      ...CampaignOrderConnectionFragment
    }
    crowdfundingCampaigns {
      ...CrowdfundingCampaignConnectionFragment
    }
    presaleCampaigns {
      ...PresaleCampaignConnectionFragment
    }
    subscriptionOrders {
      ...SubscriptionOrderConnectionFragment
    }
    subscriptionPlanGroups {
      ...SubscriptionPlanGroupConnectionFragment
    }
    subscriptions {
      ...SubscriptionConnectionFragment
    }
  }
}
Variables
{
  "customerIds": [SharedGlobalID],
  "paymentStatus": ["FAILED"],
  "query": "xyz789",
  "sortDirection": "ASC",
  "sortKey": "BILL_AT",
  "status": ["CANCELLED"],
  "subscriptionId": GlobalID,
  "subscriptionPlanId": GlobalID
}
Response
{
  "data": {
    "searchSubscriptionOrders": {
      "queryArguments": "abc123",
      "campaignOrders": CampaignOrderConnection,
      "crowdfundingCampaigns": CrowdfundingCampaignConnection,
      "presaleCampaigns": PresaleCampaignConnection,
      "subscriptionOrders": SubscriptionOrderConnection,
      "subscriptionPlanGroups": SubscriptionPlanGroupConnection,
      "subscriptions": SubscriptionConnection
    }
  }
}
Queries

searchSubscriptionPlanGroups

Description

Search subscription plan groups

Response

Returns a SearchResult

Arguments
Name Description
productIds - [SharedGlobalID!] Return only subscription plan groups for these variants.
productVariantIds - [SharedGlobalID!] Return only subscription plan groups for these variants.
query - String A query string.
sortDirection - SortDirection The sort direction.
sortKey - SubscriptionPlanGroupSortKey
status - [SubscriptionPlanGroupStatus!] The subscription plan group's status.

Example

Query
query searchSubscriptionPlanGroups(
  $productIds: [SharedGlobalID!],
  $productVariantIds: [SharedGlobalID!],
  $query: String,
  $sortDirection: SortDirection,
  $sortKey: SubscriptionPlanGroupSortKey,
  $status: [SubscriptionPlanGroupStatus!]
) {
  searchSubscriptionPlanGroups(
    productIds: $productIds,
    productVariantIds: $productVariantIds,
    query: $query,
    sortDirection: $sortDirection,
    sortKey: $sortKey,
    status: $status
  ) {
    queryArguments
    campaignOrders {
      ...CampaignOrderConnectionFragment
    }
    crowdfundingCampaigns {
      ...CrowdfundingCampaignConnectionFragment
    }
    presaleCampaigns {
      ...PresaleCampaignConnectionFragment
    }
    subscriptionOrders {
      ...SubscriptionOrderConnectionFragment
    }
    subscriptionPlanGroups {
      ...SubscriptionPlanGroupConnectionFragment
    }
    subscriptions {
      ...SubscriptionConnectionFragment
    }
  }
}
Variables
{
  "productIds": [SharedGlobalID],
  "productVariantIds": [SharedGlobalID],
  "query": "xyz789",
  "sortDirection": "ASC",
  "sortKey": "CREATED_AT",
  "status": ["ACTIVE"]
}
Response
{
  "data": {
    "searchSubscriptionPlanGroups": {
      "queryArguments": "abc123",
      "campaignOrders": CampaignOrderConnection,
      "crowdfundingCampaigns": CrowdfundingCampaignConnection,
      "presaleCampaigns": PresaleCampaignConnection,
      "subscriptionOrders": SubscriptionOrderConnection,
      "subscriptionPlanGroups": SubscriptionPlanGroupConnection,
      "subscriptions": SubscriptionConnection
    }
  }
}
Queries

searchSubscriptions

Description

Search subscriptions

Response

Returns a SearchResult

Arguments
Name Description
customerIds - [SharedGlobalID!] Return only subscriptions belonging to these customers.
query - String A query string.
sortDirection - SortDirection The sort direction.
sortKey - SubscriptionSortKey
status - [SubscriptionStatus!] The subscription's status.
subscriptionPlanGroupId - GlobalID
subscriptionPlanId - GlobalID Return only subscriptions belonging to this subscription plan.

Example

Query
query searchSubscriptions(
  $customerIds: [SharedGlobalID!],
  $query: String,
  $sortDirection: SortDirection,
  $sortKey: SubscriptionSortKey,
  $status: [SubscriptionStatus!],
  $subscriptionPlanGroupId: GlobalID,
  $subscriptionPlanId: GlobalID
) {
  searchSubscriptions(
    customerIds: $customerIds,
    query: $query,
    sortDirection: $sortDirection,
    sortKey: $sortKey,
    status: $status,
    subscriptionPlanGroupId: $subscriptionPlanGroupId,
    subscriptionPlanId: $subscriptionPlanId
  ) {
    queryArguments
    campaignOrders {
      ...CampaignOrderConnectionFragment
    }
    crowdfundingCampaigns {
      ...CrowdfundingCampaignConnectionFragment
    }
    presaleCampaigns {
      ...PresaleCampaignConnectionFragment
    }
    subscriptionOrders {
      ...SubscriptionOrderConnectionFragment
    }
    subscriptionPlanGroups {
      ...SubscriptionPlanGroupConnectionFragment
    }
    subscriptions {
      ...SubscriptionConnectionFragment
    }
  }
}
Variables
{
  "customerIds": [SharedGlobalID],
  "query": "xyz789",
  "sortDirection": "ASC",
  "sortKey": "CREATED_AT",
  "status": ["ACTIVE"],
  "subscriptionPlanGroupId": GlobalID,
  "subscriptionPlanId": GlobalID
}
Response
{
  "data": {
    "searchSubscriptions": {
      "queryArguments": "abc123",
      "campaignOrders": CampaignOrderConnection,
      "crowdfundingCampaigns": CrowdfundingCampaignConnection,
      "presaleCampaigns": PresaleCampaignConnection,
      "subscriptionOrders": SubscriptionOrderConnection,
      "subscriptionPlanGroups": SubscriptionPlanGroupConnection,
      "subscriptions": SubscriptionConnection
    }
  }
}
Queries

subscription

Description

Find a subscription by ID.

Response

Returns a Subscription

Arguments
Name Description
id - GlobalID! The subscription's ID.

Example

Query
query subscription($id: GlobalID!) {
  subscription(id: $id) {
    availableSubscriptionPlans {
      ...SubscriptionPlanFragment
    }
    billingBehaviour {
      ...SubscriptionBillingBehaviourFragment
    }
    cancelEvent {
      ...SubscriptionEventFragment
    }
    cancelledAt
    channel {
      ...ChannelFragment
    }
    createdAt
    currency
    customer {
      ...CustomerFragment
    }
    deliveryBehaviour {
      ...SubscriptionDeliveryBehaviourFragment
    }
    deliveryMethod {
      ... on SubscriptionDeliveryMethodShipping {
        ...SubscriptionDeliveryMethodShippingFragment
      }
    }
    externalId
    id
    identifier
    inventoryBehaviour {
      ...SubscriptionInventoryBehaviourFragment
    }
    lastProcessedOrder {
      ...SubscriptionOrderFragment
    }
    lines {
      ...SubscriptionLineFragment
    }
    nextBillingAt
    nextDeliveryAt
    nextScheduledOrder {
      ...SubscriptionOrderFragment
    }
    order {
      ...OrderFragment
    }
    pauseEvent {
      ...SubscriptionEventFragment
    }
    paymentMethod {
      ...PaymentMethodFragment
    }
    pricingBehaviour {
      ...SubscriptionPricingBehaviourFragment
    }
    processedSubscriptionOrdersCount
    restoreEvent {
      ...SubscriptionEventFragment
    }
    resumeEvent {
      ...SubscriptionEventFragment
    }
    source
    status
    subscriptionAnchor {
      ...SubscriptionAnchorFragment
    }
    subscriptionGroup {
      ...SubscriptionGroupFragment
    }
    subscriptionOrders {
      ...SubscriptionOrderConnectionFragment
    }
    subscriptionPlan {
      ...SubscriptionPlanFragment
    }
    updatedAt
  }
}
Variables
{"id": GlobalID}
Response
{
  "data": {
    "subscription": {
      "availableSubscriptionPlans": [SubscriptionPlan],
      "billingBehaviour": SubscriptionBillingBehaviour,
      "cancelEvent": SubscriptionEvent,
      "cancelledAt": 1592577642,
      "channel": Channel,
      "createdAt": 1592577642,
      "currency": "AED",
      "customer": Customer,
      "deliveryBehaviour": SubscriptionDeliveryBehaviour,
      "deliveryMethod": SubscriptionDeliveryMethodShipping,
      "externalId": "xyz789",
      "id": GlobalID,
      "identifier": "xyz789",
      "inventoryBehaviour": SubscriptionInventoryBehaviour,
      "lastProcessedOrder": SubscriptionOrder,
      "lines": [SubscriptionLine],
      "nextBillingAt": 1592577642,
      "nextDeliveryAt": 1592577642,
      "nextScheduledOrder": SubscriptionOrder,
      "order": Order,
      "pauseEvent": SubscriptionEvent,
      "paymentMethod": PaymentMethod,
      "pricingBehaviour": SubscriptionPricingBehaviour,
      "processedSubscriptionOrdersCount": Count,
      "restoreEvent": SubscriptionEvent,
      "resumeEvent": SubscriptionEvent,
      "source": "API",
      "status": "ACTIVE",
      "subscriptionAnchor": SubscriptionAnchor,
      "subscriptionGroup": SubscriptionGroup,
      "subscriptionOrders": SubscriptionOrderConnection,
      "subscriptionPlan": SubscriptionPlan,
      "updatedAt": 1592577642
    }
  }
}
Queries

subscriptionGroup

Description

Find a subscription group by ID.

Response

Returns a SubscriptionGroup

Arguments
Name Description
id - GlobalID! The subscription group's ID.

Example

Query
query subscriptionGroup($id: GlobalID!) {
  subscriptionGroup(id: $id) {
    createdAt
    id
    identifier
    subscriptions {
      ...SubscriptionFragment
    }
    updatedAt
  }
}
Variables
{"id": GlobalID}
Response
{
  "data": {
    "subscriptionGroup": {
      "createdAt": 1592577642,
      "id": GlobalID,
      "identifier": "abc123",
      "subscriptions": [Subscription],
      "updatedAt": 1592577642
    }
  }
}
Queries

subscriptionGroups

Description

List all subscription groups.

Response

Returns a SubscriptionGroupConnection

Arguments
Name 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.

Example

Query
query subscriptionGroups(
  $after: String,
  $before: String,
  $first: Int,
  $last: Int
) {
  subscriptionGroups(
    after: $after,
    before: $before,
    first: $first,
    last: $last
  ) {
    edges {
      ...SubscriptionGroupEdgeFragment
    }
    nodes {
      ...SubscriptionGroupFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
  }
}
Variables
{
  "after": "xyz789",
  "before": "xyz789",
  "first": 123,
  "last": 123
}
Response
{
  "data": {
    "subscriptionGroups": {
      "edges": [SubscriptionGroupEdge],
      "nodes": [SubscriptionGroup],
      "pageInfo": PageInfo,
      "totalCount": 123
    }
  }
}
Queries

subscriptionOrder

Description

Find a subscription order by ID.

Response

Returns a SubscriptionOrder

Arguments
Name Description
id - GlobalID The subscription's ID.
selector - SubscriptionOrderSelectorInput

Example

Query
query subscriptionOrder(
  $id: GlobalID,
  $selector: SubscriptionOrderSelectorInput
) {
  subscriptionOrder(
    id: $id,
    selector: $selector
  ) {
    billingBehaviour {
      ...SubscriptionBillingBehaviourFragment
    }
    cancelledAt
    createdAt
    customer {
      ...CustomerFragment
    }
    customised
    cycleEndAt
    cycleIndex
    cycleStartAt
    deliveryBehaviour {
      ...SubscriptionDeliveryBehaviourFragment
    }
    deliveryMethod {
      ... on SubscriptionDeliveryMethodShipping {
        ...SubscriptionDeliveryMethodShippingFragment
      }
    }
    expectedBillingAt
    expectedDeliveryAt
    financials {
      ...SubscriptionOrderFinancialsFragment
    }
    id
    identifier
    lastPaymentMethodUpdateEvent {
      ...SubscriptionEventFragment
    }
    lines {
      ...SubscriptionOrderLineFragment
    }
    nextSubscriptionOrder {
      ...SubscriptionOrderFragment
    }
    order {
      ...OrderFragment
    }
    paused
    paymentIntent {
      ...PaymentIntentFragment
    }
    paymentMethod {
      ...PaymentMethodFragment
    }
    paymentStatus
    previousSubscriptionOrder {
      ...SubscriptionOrderFragment
    }
    processedAt
    skipped
    skippedAt
    status
    subscription {
      ...SubscriptionFragment
    }
    updatedAt
  }
}
Variables
{
  "id": GlobalID,
  "selector": SubscriptionOrderSelectorInput
}
Response
{
  "data": {
    "subscriptionOrder": {
      "billingBehaviour": SubscriptionBillingBehaviour,
      "cancelledAt": 1592577642,
      "createdAt": 1592577642,
      "customer": Customer,
      "customised": true,
      "cycleEndAt": 1592577642,
      "cycleIndex": Count,
      "cycleStartAt": 1592577642,
      "deliveryBehaviour": SubscriptionDeliveryBehaviour,
      "deliveryMethod": SubscriptionDeliveryMethodShipping,
      "expectedBillingAt": 1592577642,
      "expectedDeliveryAt": 1592577642,
      "financials": SubscriptionOrderFinancials,
      "id": GlobalID,
      "identifier": "abc123",
      "lastPaymentMethodUpdateEvent": SubscriptionEvent,
      "lines": [SubscriptionOrderLine],
      "nextSubscriptionOrder": SubscriptionOrder,
      "order": Order,
      "paused": false,
      "paymentIntent": PaymentIntent,
      "paymentMethod": PaymentMethod,
      "paymentStatus": "FAILED",
      "previousSubscriptionOrder": SubscriptionOrder,
      "processedAt": 1592577642,
      "skipped": false,
      "skippedAt": 1592577642,
      "status": "CANCELLED",
      "subscription": Subscription,
      "updatedAt": 1592577642
    }
  }
}
Queries

subscriptionOrders

Description

List all subscription orders.

Response

Returns a SubscriptionOrderConnection

Arguments
Name 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.

Example

Query
query subscriptionOrders(
  $after: String,
  $before: String,
  $first: Int,
  $last: Int
) {
  subscriptionOrders(
    after: $after,
    before: $before,
    first: $first,
    last: $last
  ) {
    edges {
      ...SubscriptionOrderEdgeFragment
    }
    nodes {
      ...SubscriptionOrderFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
  }
}
Variables
{
  "after": "abc123",
  "before": "xyz789",
  "first": 987,
  "last": 987
}
Response
{
  "data": {
    "subscriptionOrders": {
      "edges": [SubscriptionOrderEdge],
      "nodes": [SubscriptionOrder],
      "pageInfo": PageInfo,
      "totalCount": 123
    }
  }
}
Queries

subscriptions

Description

List all subscriptions.

Response

Returns a SubscriptionConnection

Arguments
Name 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.

Example

Query
query subscriptions(
  $after: String,
  $before: String,
  $first: Int,
  $last: Int
) {
  subscriptions(
    after: $after,
    before: $before,
    first: $first,
    last: $last
  ) {
    edges {
      ...SubscriptionEdgeFragment
    }
    nodes {
      ...SubscriptionFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
  }
}
Variables
{
  "after": "xyz789",
  "before": "xyz789",
  "first": 123,
  "last": 123
}
Response
{
  "data": {
    "subscriptions": {
      "edges": [SubscriptionEdge],
      "nodes": [Subscription],
      "pageInfo": PageInfo,
      "totalCount": 987
    }
  }
}

Mutations

subscriptionCancel

Response

Returns a SubscriptionCancelPayload

Arguments
Name Description
input - SubscriptionCancelInput!

Example

Query
mutation subscriptionCancel($input: SubscriptionCancelInput!) {
  subscriptionCancel(input: $input) {
    subscription {
      ...SubscriptionFragment
    }
    userErrors {
      ...UserErrorFragment
    }
  }
}
Variables
{"input": SubscriptionCancelInput}
Response
{
  "data": {
    "subscriptionCancel": {
      "subscription": Subscription,
      "userErrors": [UserError]
    }
  }
}
Mutations

subscriptionLineAdd

Response

Returns a SubscriptionLineAddPayload

Arguments
Name Description
input - SubscriptionLineAddInput!

Example

Query
mutation subscriptionLineAdd($input: SubscriptionLineAddInput!) {
  subscriptionLineAdd(input: $input) {
    addedLine {
      ...SubscriptionLineFragment
    }
    subscription {
      ...SubscriptionFragment
    }
    userErrors {
      ...UserErrorFragment
    }
  }
}
Variables
{"input": SubscriptionLineAddInput}
Response
{
  "data": {
    "subscriptionLineAdd": {
      "addedLine": SubscriptionLine,
      "subscription": Subscription,
      "userErrors": [UserError]
    }
  }
}
Mutations

subscriptionLineRemove

Response

Returns a SubscriptionLineRemovePayload

Arguments
Name Description
input - SubscriptionLineRemoveInput!

Example

Query
mutation subscriptionLineRemove($input: SubscriptionLineRemoveInput!) {
  subscriptionLineRemove(input: $input) {
    removedLine {
      ...SubscriptionLineFragment
    }
    subscription {
      ...SubscriptionFragment
    }
    userErrors {
      ...UserErrorFragment
    }
  }
}
Variables
{"input": SubscriptionLineRemoveInput}
Response
{
  "data": {
    "subscriptionLineRemove": {
      "removedLine": SubscriptionLine,
      "subscription": Subscription,
      "userErrors": [UserError]
    }
  }
}
Mutations

subscriptionLineSetQuantity

Response

Returns a SubscriptionLineSetQuantityPayload

Arguments
Name Description
input - SubscriptionLineSetQuantityInput!

Example

Query
mutation subscriptionLineSetQuantity($input: SubscriptionLineSetQuantityInput!) {
  subscriptionLineSetQuantity(input: $input) {
    subscription {
      ...SubscriptionFragment
    }
    updatedLine {
      ...SubscriptionLineFragment
    }
    userErrors {
      ...UserErrorFragment
    }
  }
}
Variables
{"input": SubscriptionLineSetQuantityInput}
Response
{
  "data": {
    "subscriptionLineSetQuantity": {
      "subscription": Subscription,
      "updatedLine": SubscriptionLine,
      "userErrors": [UserError]
    }
  }
}
Mutations

subscriptionOrderLineAdd

Response

Returns a SubscriptionOrderLineAddPayload

Arguments
Name Description
input - SubscriptionOrderLineAddInput!

Example

Query
mutation subscriptionOrderLineAdd($input: SubscriptionOrderLineAddInput!) {
  subscriptionOrderLineAdd(input: $input) {
    addedLine {
      ...SubscriptionOrderLineFragment
    }
    subscriptionOrder {
      ...SubscriptionOrderFragment
    }
    userErrors {
      ...UserErrorFragment
    }
  }
}
Variables
{"input": SubscriptionOrderLineAddInput}
Response
{
  "data": {
    "subscriptionOrderLineAdd": {
      "addedLine": SubscriptionOrderLine,
      "subscriptionOrder": SubscriptionOrder,
      "userErrors": [UserError]
    }
  }
}
Mutations

subscriptionOrderLineRemove

Response

Returns a SubscriptionOrderLineRemovePayload

Arguments
Name Description
input - SubscriptionOrderLineRemoveInput!

Example

Query
mutation subscriptionOrderLineRemove($input: SubscriptionOrderLineRemoveInput!) {
  subscriptionOrderLineRemove(input: $input) {
    removedLine {
      ...SubscriptionOrderLineFragment
    }
    subscriptionOrder {
      ...SubscriptionOrderFragment
    }
    userErrors {
      ...UserErrorFragment
    }
  }
}
Variables
{"input": SubscriptionOrderLineRemoveInput}
Response
{
  "data": {
    "subscriptionOrderLineRemove": {
      "removedLine": SubscriptionOrderLine,
      "subscriptionOrder": SubscriptionOrder,
      "userErrors": [UserError]
    }
  }
}
Mutations

subscriptionOrderLineSetQuantity

Response

Returns a SubscriptionOrderLineSetQuantityPayload

Arguments
Name Description
input - SubscriptionOrderLineSetQuantityInput!

Example

Query
mutation subscriptionOrderLineSetQuantity($input: SubscriptionOrderLineSetQuantityInput!) {
  subscriptionOrderLineSetQuantity(input: $input) {
    subscriptionOrder {
      ...SubscriptionOrderFragment
    }
    updatedLine {
      ...SubscriptionOrderLineFragment
    }
    userErrors {
      ...UserErrorFragment
    }
  }
}
Variables
{"input": SubscriptionOrderLineSetQuantityInput}
Response
{
  "data": {
    "subscriptionOrderLineSetQuantity": {
      "subscriptionOrder": SubscriptionOrder,
      "updatedLine": SubscriptionOrderLine,
      "userErrors": [UserError]
    }
  }
}
Mutations

subscriptionOrderProcess

Description

Process a subscription order.

Response

Returns a SubscriptionOrderProcessPayload

Arguments
Name Description
input - SubscriptionOrderProcessInput! Input for processing a subscription order.

Example

Query
mutation subscriptionOrderProcess($input: SubscriptionOrderProcessInput!) {
  subscriptionOrderProcess(input: $input) {
    subscriptionOrder {
      ...SubscriptionOrderFragment
    }
    userErrors {
      ...UserErrorFragment
    }
  }
}
Variables
{"input": SubscriptionOrderProcessInput}
Response
{
  "data": {
    "subscriptionOrderProcess": {
      "subscriptionOrder": SubscriptionOrder,
      "userErrors": [UserError]
    }
  }
}
Mutations

subscriptionOrderSkip

Description

Skip a subscription order.

Response

Returns a SubscriptionOrderSkipPayload

Arguments
Name Description
input - SubscriptionOrderSkipInput! Input for skipping a subscription order.

Example

Query
mutation subscriptionOrderSkip($input: SubscriptionOrderSkipInput!) {
  subscriptionOrderSkip(input: $input) {
    skippedSubscriptionOrders {
      ...SubscriptionOrderFragment
    }
    subscriptionOrder {
      ...SubscriptionOrderFragment
    }
    userErrors {
      ...UserErrorFragment
    }
  }
}
Variables
{"input": SubscriptionOrderSkipInput}
Response
{
  "data": {
    "subscriptionOrderSkip": {
      "skippedSubscriptionOrders": [SubscriptionOrder],
      "subscriptionOrder": SubscriptionOrder,
      "userErrors": [UserError]
    }
  }
}
Mutations

subscriptionOrderUnskip

Description

Unskip a subscription order.

Response

Returns a SubscriptionOrderUnskipPayload

Arguments
Name Description
input - SubscriptionOrderUnskipInput! Input to unskip a subscription order.

Example

Query
mutation subscriptionOrderUnskip($input: SubscriptionOrderUnskipInput!) {
  subscriptionOrderUnskip(input: $input) {
    subscriptionOrder {
      ...SubscriptionOrderFragment
    }
    userErrors {
      ...UserErrorFragment
    }
  }
}
Variables
{"input": SubscriptionOrderUnskipInput}
Response
{
  "data": {
    "subscriptionOrderUnskip": {
      "subscriptionOrder": SubscriptionOrder,
      "userErrors": [UserError]
    }
  }
}
Mutations

subscriptionOrderUpdate

Description

Updates a subscription order.

Response

Returns a SubscriptionOrderUpdatePayload

Arguments
Name Description
input - SubscriptionOrderUpdateInput! Input for updating a subscription order.

Example

Query
mutation subscriptionOrderUpdate($input: SubscriptionOrderUpdateInput!) {
  subscriptionOrderUpdate(input: $input) {
    subscriptionOrder {
      ...SubscriptionOrderFragment
    }
    userErrors {
      ...UserErrorFragment
    }
  }
}
Variables
{"input": SubscriptionOrderUpdateInput}
Response
{
  "data": {
    "subscriptionOrderUpdate": {
      "subscriptionOrder": SubscriptionOrder,
      "userErrors": [UserError]
    }
  }
}
Mutations

subscriptionPause

Response

Returns a SubscriptionPausePayload

Arguments
Name Description
input - SubscriptionPauseInput!

Example

Query
mutation subscriptionPause($input: SubscriptionPauseInput!) {
  subscriptionPause(input: $input) {
    subscription {
      ...SubscriptionFragment
    }
    userErrors {
      ...UserErrorFragment
    }
  }
}
Variables
{"input": SubscriptionPauseInput}
Response
{
  "data": {
    "subscriptionPause": {
      "subscription": Subscription,
      "userErrors": [UserError]
    }
  }
}
Mutations

subscriptionResume

Response

Returns a SubscriptionResumePayload

Arguments
Name Description
input - SubscriptionResumeInput!

Example

Query
mutation subscriptionResume($input: SubscriptionResumeInput!) {
  subscriptionResume(input: $input) {
    subscription {
      ...SubscriptionFragment
    }
    userErrors {
      ...UserErrorFragment
    }
  }
}
Variables
{"input": SubscriptionResumeInput}
Response
{
  "data": {
    "subscriptionResume": {
      "subscription": Subscription,
      "userErrors": [UserError]
    }
  }
}
Mutations

subscriptionSetSchedule

Description

Sets the schedule of a subscription.

Response

Returns a SubscriptionSetSchedulePayload

Arguments
Name Description
input - SubscriptionSetScheduleInput! Input for setting subscription schedule.

Example

Query
mutation subscriptionSetSchedule($input: SubscriptionSetScheduleInput!) {
  subscriptionSetSchedule(input: $input) {
    subscription {
      ...SubscriptionFragment
    }
    userErrors {
      ...UserErrorFragment
    }
  }
}
Variables
{"input": SubscriptionSetScheduleInput}
Response
{
  "data": {
    "subscriptionSetSchedule": {
      "subscription": Subscription,
      "userErrors": [UserError]
    }
  }
}
Mutations

subscriptionUpdate

Description

Updates a subscription.

Response

Returns a SubscriptionUpdatePayload

Arguments
Name Description
input - SubscriptionUpdateInput! Input for updating a subscription.

Example

Query
mutation subscriptionUpdate($input: SubscriptionUpdateInput!) {
  subscriptionUpdate(input: $input) {
    subscription {
      ...SubscriptionFragment
    }
    userErrors {
      ...UserErrorFragment
    }
  }
}
Variables
{"input": SubscriptionUpdateInput}
Response
{
  "data": {
    "subscriptionUpdate": {
      "subscription": Subscription,
      "userErrors": [UserError]
    }
  }
}

Objects

SearchResult

Description

A search result.

Fields
Field Name Description
queryArguments - String! The query arguments as a JSON string
campaignOrders - CampaignOrderConnection The matching campaign orders
Arguments
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.
crowdfundingCampaigns - CrowdfundingCampaignConnection The matching crowdfunding campaigns
Arguments
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.
presaleCampaigns - PresaleCampaignConnection The matching presale campaigns
Arguments
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.
subscriptionOrders - SubscriptionOrderConnection
Arguments
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.
subscriptionPlanGroups - SubscriptionPlanGroupConnection
Arguments
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
Arguments
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.
Example
{
  "queryArguments": "abc123",
  "campaignOrders": CampaignOrderConnection,
  "crowdfundingCampaigns": CrowdfundingCampaignConnection,
  "presaleCampaigns": PresaleCampaignConnection,
  "subscriptionOrders": SubscriptionOrderConnection,
  "subscriptionPlanGroups": SubscriptionPlanGroupConnection,
  "subscriptions": SubscriptionConnection
}
Objects

SubscriptionGroup

Description

Translation missing: en.graphql.objects.subscription_group.description

Fields
Field Name Description
createdAt - Timestamp! Translation missing: en.graphql.objects.subscription_group.fields.created_at
id - GlobalID! Translation missing: en.graphql.objects.subscription_group.fields.id
identifier - String! Translation missing: en.graphql.objects.subscription_group.fields.identifier
subscriptions - [Subscription!]! Translation missing: en.graphql.objects.subscription_group.fields.subscriptions
updatedAt - Timestamp! Translation missing: en.graphql.objects.subscription_group.fields.updated_at
Example
{
  "createdAt": 1592577642,
  "id": GlobalID,
  "identifier": "xyz789",
  "subscriptions": [Subscription],
  "updatedAt": 1592577642
}
Objects

SubscriptionOrder

Description

Translation missing: en.graphql.objects.subscription_order.description

Fields
Field Name Description
billingBehaviour - SubscriptionBillingBehaviour! Translation missing: en.graphql.objects.subscription_order.fields.billing_behaviour
cancelledAt - Timestamp Translation missing: en.graphql.objects.subscription_order.fields.cancelled_at
createdAt - Timestamp! Translation missing: en.graphql.objects.subscription_order.fields.created_at
customer - Customer! Translation missing: en.graphql.objects.subscription_order.fields.customer
customised - Boolean! Translation missing: en.graphql.objects.subscription_order.fields.customised
cycleEndAt - Timestamp! Translation missing: en.graphql.objects.subscription_order.fields.cycle_end_at
cycleIndex - Count! Translation missing: en.graphql.objects.subscription_order.fields.cycle_index
cycleStartAt - Timestamp! Translation missing: en.graphql.objects.subscription_order.fields.cycle_start_at
deliveryBehaviour - SubscriptionDeliveryBehaviour! Translation missing: en.graphql.objects.subscription_order.fields.delivery_behaviour
deliveryMethod - SubscriptionDeliveryMethod Translation missing: en.graphql.objects.subscription_order.fields.delivery_method
expectedBillingAt - Timestamp Translation missing: en.graphql.objects.subscription_order.fields.expected_billing_at
expectedDeliveryAt - Timestamp Translation missing: en.graphql.objects.subscription_order.fields.expected_delivery_at
financials - SubscriptionOrderFinancials
id - GlobalID! Translation missing: en.graphql.objects.subscription_order.fields.id
identifier - String! Translation missing: en.graphql.objects.subscription_order.fields.identifier
lastPaymentMethodUpdateEvent - SubscriptionEvent Translation missing: en.graphql.objects.subscription_order.fields.last_payment_method_update_event
lines - [SubscriptionOrderLine!]
nextSubscriptionOrder - SubscriptionOrder Translation missing: en.graphql.objects.subscription_order.fields.next_subscription_order
order - Order Translation missing: en.graphql.objects.subscription_order.fields.order
paused - Boolean! Translation missing: en.graphql.objects.subscription_order.fields.paused
paymentIntent - PaymentIntent Translation missing: en.graphql.objects.subscription_order.fields.payment_intent
paymentMethod - PaymentMethod Translation missing: en.graphql.objects.subscription_order.fields.payment_method
paymentStatus - SubscriptionOrderPaymentStatus! Translation missing: en.graphql.objects.subscription_order.fields.payment_status
previousSubscriptionOrder - SubscriptionOrder Translation missing: en.graphql.objects.subscription_order.fields.previous_subscription_order
processedAt - Timestamp Translation missing: en.graphql.objects.subscription_order.fields.processed_at
skipped - Boolean! Translation missing: en.graphql.objects.subscription_order.fields.skipped
skippedAt - Timestamp Translation missing: en.graphql.objects.subscription_order.fields.skipped_at
status - SubscriptionOrderStatus! Translation missing: en.graphql.objects.subscription_order.fields.status
subscription - Subscription! Translation missing: en.graphql.objects.subscription_order.fields.subscription
updatedAt - Timestamp! Translation missing: en.graphql.objects.subscription_order.fields.updated_at
Example
{
  "billingBehaviour": SubscriptionBillingBehaviour,
  "cancelledAt": 1592577642,
  "createdAt": 1592577642,
  "customer": Customer,
  "customised": false,
  "cycleEndAt": 1592577642,
  "cycleIndex": Count,
  "cycleStartAt": 1592577642,
  "deliveryBehaviour": SubscriptionDeliveryBehaviour,
  "deliveryMethod": SubscriptionDeliveryMethodShipping,
  "expectedBillingAt": 1592577642,
  "expectedDeliveryAt": 1592577642,
  "financials": SubscriptionOrderFinancials,
  "id": GlobalID,
  "identifier": "abc123",
  "lastPaymentMethodUpdateEvent": SubscriptionEvent,
  "lines": [SubscriptionOrderLine],
  "nextSubscriptionOrder": SubscriptionOrder,
  "order": Order,
  "paused": false,
  "paymentIntent": PaymentIntent,
  "paymentMethod": PaymentMethod,
  "paymentStatus": "FAILED",
  "previousSubscriptionOrder": SubscriptionOrder,
  "processedAt": 1592577642,
  "skipped": false,
  "skippedAt": 1592577642,
  "status": "CANCELLED",
  "subscription": Subscription,
  "updatedAt": 1592577642
}

Charges

Queries

charge

Description

Find a Charge by ID.

Response

Returns a Charge

Arguments
Name Description
id - GlobalID! The charge's ID.

Example

Query
query charge($id: GlobalID!) {
  charge(id: $id) {
    amount {
      ...MoneyFragment
    }
    chargeType
    createdAt
    customer {
      ...CustomerFragment
    }
    description
    externalId
    failureCode
    failureMessage
    id
    metadata
    paymentIntent {
      ...PaymentIntentFragment
    }
    recordStatus
    refunds {
      ...RefundFragment
    }
    source
    status
    updatedAt
  }
}
Variables
{"id": GlobalID}
Response
{
  "data": {
    "charge": {
      "amount": Money,
      "chargeType": "AUTHORISE",
      "createdAt": ISO8601DateTime,
      "customer": Customer,
      "description": "xyz789",
      "externalId": "xyz789",
      "failureCode": "API_ERROR",
      "failureMessage": "xyz789",
      "id": GlobalID,
      "metadata": Metadata,
      "paymentIntent": PaymentIntent,
      "recordStatus": "PROCESSED",
      "refunds": [Refund],
      "source": "SHOPIFY",
      "status": "FAILED",
      "updatedAt": ISO8601DateTime
    }
  }
}
Queries

charges

Description

List all charges.

Response

Returns a ChargeConnection

Arguments
Name 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.

Example

Query
query charges(
  $after: String,
  $before: String,
  $first: Int,
  $last: Int
) {
  charges(
    after: $after,
    before: $before,
    first: $first,
    last: $last
  ) {
    edges {
      ...ChargeEdgeFragment
    }
    nodes {
      ...ChargeFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
  }
}
Variables
{
  "after": "xyz789",
  "before": "abc123",
  "first": 123,
  "last": 987
}
Response
{
  "data": {
    "charges": {
      "edges": [ChargeEdge],
      "nodes": [Charge],
      "pageInfo": PageInfo,
      "totalCount": 123
    }
  }
}

Mutations

chargeCapture

Description

Captures a charge for a payment intent.

Response

Returns a ChargeCapturePayload

Arguments
Name Description
input - ChargeCaptureInput! Input for capturing a charge.

Example

Query
mutation chargeCapture($input: ChargeCaptureInput!) {
  chargeCapture(input: $input) {
    charge {
      ...ChargeFragment
    }
    userErrors {
      ...UserErrorFragment
    }
  }
}
Variables
{"input": ChargeCaptureInput}
Response
{
  "data": {
    "chargeCapture": {
      "charge": Charge,
      "userErrors": [UserError]
    }
  }
}
Mutations

chargeRecord

Description

Records a charge for a payment intent.

Response

Returns a ChargeRecordPayload

Arguments
Name Description
input - ChargeRecordInput! Input for recording a charge.

Example

Query
mutation chargeRecord($input: ChargeRecordInput!) {
  chargeRecord(input: $input) {
    charge {
      ...ChargeFragment
    }
    userErrors {
      ...UserErrorFragment
    }
  }
}
Variables
{"input": ChargeRecordInput}
Response
{
  "data": {
    "chargeRecord": {
      "charge": Charge,
      "userErrors": [UserError]
    }
  }
}

Objects

Charge

Description

A Charge

Fields
Field Name Description
amount - Money The amount the charge is for.
chargeType - ChargeType The type of charge.
createdAt - ISO8601DateTime! The time the charge was created.
customer - Customer! The customer associated with the charge.
description - String The charge's description.
externalId - String The external ID of the charge.
failureCode - ChargeFailureCode The type of failure.
failureMessage - String The failure message.
id - GlobalID! The ID of the charge.
metadata - Metadata Unstructured key/value pairs.
paymentIntent - PaymentIntent! The associated payment intent.
recordStatus - RecordStatus The record status of charge.
refunds - [Refund!] The refunds associated with this charge.
source - ChargeSource The source of the charge.
status - ChargeStatus The charge's status.
updatedAt - ISO8601DateTime The time the charge was last updated.
Example
{
  "amount": Money,
  "chargeType": "AUTHORISE",
  "createdAt": ISO8601DateTime,
  "customer": Customer,
  "description": "abc123",
  "externalId": "abc123",
  "failureCode": "API_ERROR",
  "failureMessage": "xyz789",
  "id": GlobalID,
  "metadata": Metadata,
  "paymentIntent": PaymentIntent,
  "recordStatus": "PROCESSED",
  "refunds": [Refund],
  "source": "SHOPIFY",
  "status": "FAILED",
  "updatedAt": ISO8601DateTime
}

Payment Intents

Queries

paymentIntent

Description

Find a Payment Intent by ID.

Response

Returns a PaymentIntent

Arguments
Name Description
id - GlobalID! The payment intent's ID.

Example

Query
query paymentIntent($id: GlobalID!) {
  paymentIntent(id: $id) {
    adjustments {
      ...PaymentIntentAdjustmentFragment
    }
    amount {
      ...MoneyFragment
    }
    amountPaid {
      ...MoneyFragment
    }
    amountRefunded {
      ...MoneyFragment
    }
    balanceOwing {
      ...MoneyFragment
    }
    charges {
      ...ChargeFragment
    }
    createdAt
    customer {
      ...CustomerFragment
    }
    finalisedAt
    flexible
    id
    metadata
    paymentMethod {
      ...PaymentMethodFragment
    }
    refunds {
      ...RefundFragment
    }
    status
    updatedAt
  }
}
Variables
{"id": GlobalID}
Response
{
  "data": {
    "paymentIntent": {
      "adjustments": [PaymentIntentAdjustment],
      "amount": Money,
      "amountPaid": Money,
      "amountRefunded": Money,
      "balanceOwing": Money,
      "charges": [Charge],
      "createdAt": ISO8601DateTime,
      "customer": Customer,
      "finalisedAt": ISO8601DateTime,
      "flexible": true,
      "id": GlobalID,
      "metadata": Metadata,
      "paymentMethod": PaymentMethod,
      "refunds": [Refund],
      "status": "CANCELLED",
      "updatedAt": ISO8601DateTime
    }
  }
}
Queries

paymentIntents

Description

List all payment intents.

Response

Returns a PaymentIntentConnection

Arguments
Name 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.

Example

Query
query paymentIntents(
  $after: String,
  $before: String,
  $first: Int,
  $last: Int
) {
  paymentIntents(
    after: $after,
    before: $before,
    first: $first,
    last: $last
  ) {
    edges {
      ...PaymentIntentEdgeFragment
    }
    nodes {
      ...PaymentIntentFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
  }
}
Variables
{
  "after": "abc123",
  "before": "xyz789",
  "first": 123,
  "last": 987
}
Response
{
  "data": {
    "paymentIntents": {
      "edges": [PaymentIntentEdge],
      "nodes": [PaymentIntent],
      "pageInfo": PageInfo,
      "totalCount": 987
    }
  }
}

Mutations

paymentIntentAdjustmentCreate

Description

Creates an adjustment to a payment intent.

Response

Returns a PaymentIntentAdjustmentCreatePayload

Arguments
Name Description
input - PaymentIntentAdjustmentCreateInput! Input for creating a payment intent.

Example

Query
mutation paymentIntentAdjustmentCreate($input: PaymentIntentAdjustmentCreateInput!) {
  paymentIntentAdjustmentCreate(input: $input) {
    paymentIntentAdjustment {
      ...PaymentIntentAdjustmentFragment
    }
    userErrors {
      ...UserErrorFragment
    }
  }
}
Variables
{"input": PaymentIntentAdjustmentCreateInput}
Response
{
  "data": {
    "paymentIntentAdjustmentCreate": {
      "paymentIntentAdjustment": PaymentIntentAdjustment,
      "userErrors": [UserError]
    }
  }
}
Mutations

paymentIntentCancel

Description

Cancels a payment intent.

Response

Returns a PaymentIntentCancelPayload

Arguments
Name Description
input - PaymentIntentCancelInput! Input for cancelling a payment intent.

Example

Query
mutation paymentIntentCancel($input: PaymentIntentCancelInput!) {
  paymentIntentCancel(input: $input) {
    paymentIntent {
      ...PaymentIntentFragment
    }
    userErrors {
      ...UserErrorFragment
    }
  }
}
Variables
{"input": PaymentIntentCancelInput}
Response
{
  "data": {
    "paymentIntentCancel": {
      "paymentIntent": PaymentIntent,
      "userErrors": [UserError]
    }
  }
}
Mutations

paymentIntentCreate

Description

Creates a payment intent.

Response

Returns a PaymentIntentCreatePayload

Arguments
Name Description
input - PaymentIntentCreateInput! Input for creating a payment intent.

Example

Query
mutation paymentIntentCreate($input: PaymentIntentCreateInput!) {
  paymentIntentCreate(input: $input) {
    paymentIntent {
      ...PaymentIntentFragment
    }
    userErrors {
      ...UserErrorFragment
    }
  }
}
Variables
{"input": PaymentIntentCreateInput}
Response
{
  "data": {
    "paymentIntentCreate": {
      "paymentIntent": PaymentIntent,
      "userErrors": [UserError]
    }
  }
}
Mutations

paymentIntentUpdate

Description

Updates a payment intent.

Response

Returns a PaymentIntentUpdatePayload

Arguments
Name Description
input - PaymentIntentUpdateInput! Input for updating a payment intent.

Example

Query
mutation paymentIntentUpdate($input: PaymentIntentUpdateInput!) {
  paymentIntentUpdate(input: $input) {
    paymentIntent {
      ...PaymentIntentFragment
    }
    userErrors {
      ...UserErrorFragment
    }
  }
}
Variables
{"input": PaymentIntentUpdateInput}
Response
{
  "data": {
    "paymentIntentUpdate": {
      "paymentIntent": PaymentIntent,
      "userErrors": [UserError]
    }
  }
}

Objects

PaymentIntent

Description

A Payment Intent

Fields
Field Name Description
adjustments - [PaymentIntentAdjustment!] The adjustments made against this payment intent.
amount - Money The payment intent money amount
amountPaid - Money The payment intent money amount
amountRefunded - Money The payment intent money amount
balanceOwing - Money The payment intent money amount
charges - [Charge!] The charges made against this payment intent.
createdAt - ISO8601DateTime! PaymentIntent creation time
customer - Customer! The customer
finalisedAt - ISO8601DateTime PaymentIntent finalised time
flexible - Boolean The flexibility of a payment intent
id - GlobalID! The PaymentIntent ID
metadata - Metadata Unstructured key/value pairs
paymentMethod - PaymentMethod! The associated payment method
refunds - [Refund!] The refunds made against this payment intent.
status - PaymentIntentStatus Status of the payment intent
updatedAt - ISO8601DateTime PaymentIntent last updated at
Example
{
  "adjustments": [PaymentIntentAdjustment],
  "amount": Money,
  "amountPaid": Money,
  "amountRefunded": Money,
  "balanceOwing": Money,
  "charges": [Charge],
  "createdAt": ISO8601DateTime,
  "customer": Customer,
  "finalisedAt": ISO8601DateTime,
  "flexible": true,
  "id": GlobalID,
  "metadata": Metadata,
  "paymentMethod": PaymentMethod,
  "refunds": [Refund],
  "status": "CANCELLED",
  "updatedAt": ISO8601DateTime
}

Payment Methods

Queries

paymentMethod

Description

Find a Payment Method by ID.

Response

Returns a PaymentMethod

Arguments
Name Description
id - GlobalID! The payment method's ID.

Example

Query
query paymentMethod($id: GlobalID!) {
  paymentMethod(id: $id) {
    activePaymentInstrument {
      ...PaymentInstrumentFragment
    }
    channel {
      ...ChannelFragment
    }
    createdAt
    customer {
      ...CustomerFragment
    }
    externalId
    futureUsage
    id
    metadata
    paymentInstruments {
      ...PaymentInstrumentFragment
    }
    paymentIntents {
      ...PaymentIntentConnectionFragment
    }
    status
    updatedAt
  }
}
Variables
{"id": GlobalID}
Response
{
  "data": {
    "paymentMethod": {
      "activePaymentInstrument": PaymentInstrument,
      "channel": Channel,
      "createdAt": ISO8601DateTime,
      "customer": Customer,
      "externalId": "abc123",
      "futureUsage": "ONE_OFF",
      "id": GlobalID,
      "metadata": Metadata,
      "paymentInstruments": [PaymentInstrument],
      "paymentIntents": PaymentIntentConnection,
      "status": "ACTIVE",
      "updatedAt": ISO8601DateTime
    }
  }
}
Queries

paymentMethods

Description

List all payment methods.

Response

Returns a PaymentMethodConnection

Arguments
Name 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.
customerId - GlobalID
first - Int Returns the first n elements from the list.
futureUsage - [PaymentMethodFutureUsage!] Future usage of payment methods.
last - Int Returns the last n elements from the list.
paymentInstrumentType - [PaymentInstrumentType!]
status - [PaymentMethodStatus!]

Example

Query
query paymentMethods(
  $after: String,
  $before: String,
  $customerId: GlobalID,
  $first: Int,
  $futureUsage: [PaymentMethodFutureUsage!],
  $last: Int,
  $paymentInstrumentType: [PaymentInstrumentType!],
  $status: [PaymentMethodStatus!]
) {
  paymentMethods(
    after: $after,
    before: $before,
    customerId: $customerId,
    first: $first,
    futureUsage: $futureUsage,
    last: $last,
    paymentInstrumentType: $paymentInstrumentType,
    status: $status
  ) {
    edges {
      ...PaymentMethodEdgeFragment
    }
    nodes {
      ...PaymentMethodFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
  }
}
Variables
{
  "after": "xyz789",
  "before": "xyz789",
  "customerId": GlobalID,
  "first": 987,
  "futureUsage": ["ONE_OFF"],
  "last": 987,
  "paymentInstrumentType": ["CARD"],
  "status": ["ACTIVE"]
}
Response
{
  "data": {
    "paymentMethods": {
      "edges": [PaymentMethodEdge],
      "nodes": [PaymentMethod],
      "pageInfo": PageInfo,
      "totalCount": 123
    }
  }
}

Mutations

paymentMethodCancel

Description

Cancels a payment method.

Response

Returns a PaymentMethodCancelPayload

Arguments
Name Description
input - PaymentMethodCancelInput! Input for cancelling a payment method.

Example

Query
mutation paymentMethodCancel($input: PaymentMethodCancelInput!) {
  paymentMethodCancel(input: $input) {
    paymentMethod {
      ...PaymentMethodFragment
    }
    userErrors {
      ...UserErrorFragment
    }
  }
}
Variables
{"input": PaymentMethodCancelInput}
Response
{
  "data": {
    "paymentMethodCancel": {
      "paymentMethod": PaymentMethod,
      "userErrors": [UserError]
    }
  }
}
Mutations

paymentMethodCreate

Description

Creates a payment method.

Response

Returns a PaymentMethodCreatePayload

Arguments
Name Description
input - PaymentMethodCreateInput! Input for creating a payment method.

Example

Query
mutation paymentMethodCreate($input: PaymentMethodCreateInput!) {
  paymentMethodCreate(input: $input) {
    paymentMethod {
      ...PaymentMethodFragment
    }
    userErrors {
      ...UserErrorFragment
    }
  }
}
Variables
{"input": PaymentMethodCreateInput}
Response
{
  "data": {
    "paymentMethodCreate": {
      "paymentMethod": PaymentMethod,
      "userErrors": [UserError]
    }
  }
}
Mutations

paymentMethodSendUpdateEmail

Description

Sends customer payment method update email.

Response

Returns a PaymentMethodSendUpdateEmailPayload

Arguments
Name Description
input - PaymentMethodSendUpdateEmailInput! Input for sending customer payment method update email.

Example

Query
mutation paymentMethodSendUpdateEmail($input: PaymentMethodSendUpdateEmailInput!) {
  paymentMethodSendUpdateEmail(input: $input) {
    userErrors {
      ...UserErrorFragment
    }
  }
}
Variables
{"input": PaymentMethodSendUpdateEmailInput}
Response
{
  "data": {
    "paymentMethodSendUpdateEmail": {
      "userErrors": [UserError]
    }
  }
}
Mutations

paymentMethodUpdate

Description

Updates a payment method.

Response

Returns a PaymentMethodUpdatePayload

Arguments
Name Description
input - PaymentMethodUpdateInput! Input for updating a payment method.

Example

Query
mutation paymentMethodUpdate($input: PaymentMethodUpdateInput!) {
  paymentMethodUpdate(input: $input) {
    paymentMethod {
      ...PaymentMethodFragment
    }
    userErrors {
      ...UserErrorFragment
    }
  }
}
Variables
{"input": PaymentMethodUpdateInput}
Response
{
  "data": {
    "paymentMethodUpdate": {
      "paymentMethod": PaymentMethod,
      "userErrors": [UserError]
    }
  }
}

Objects

PaymentMethod

Description

A customer payment method.

Fields
Field Name Description
activePaymentInstrument - PaymentInstrument!
channel - Channel! The payment method's channel.
createdAt - ISO8601DateTime! The date and time when the payment method was created.
customer - Customer! The payment method's customer.
externalId - String The (optional) external ID of the payment method.
futureUsage - PaymentMethodFutureUsage
id - GlobalID! The ID of the payment method.
metadata - Metadata Unstructured key/value pairs.
paymentInstruments - [PaymentInstrument!] The payment instruments associated to this payment method.
paymentIntents - PaymentIntentConnection The payment intents associated with this payment method.
Arguments
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.
status - PaymentMethodStatus The status of the payment method.
updatedAt - ISO8601DateTime The date and time when the payment method was last updated.
Example
{
  "activePaymentInstrument": PaymentInstrument,
  "channel": Channel,
  "createdAt": ISO8601DateTime,
  "customer": Customer,
  "externalId": "abc123",
  "futureUsage": "ONE_OFF",
  "id": GlobalID,
  "metadata": Metadata,
  "paymentInstruments": [PaymentInstrument],
  "paymentIntents": PaymentIntentConnection,
  "status": "ACTIVE",
  "updatedAt": ISO8601DateTime
}

Refunds

Queries

refund

Description

Find a Refund by ID.

Response

Returns a Refund

Arguments
Name Description
id - GlobalID! The refund's ID.

Example

Query
query refund($id: GlobalID!) {
  refund(id: $id) {
    amount {
      ...MoneyFragment
    }
    charge {
      ...ChargeFragment
    }
    createdAt
    customer {
      ...CustomerFragment
    }
    description
    externalId
    id
    metadata
    paymentIntent {
      ...PaymentIntentFragment
    }
    recordStatus
    source
    status
    updatedAt
  }
}
Variables
{"id": GlobalID}
Response
{
  "data": {
    "refund": {
      "amount": Money,
      "charge": Charge,
      "createdAt": ISO8601DateTime,
      "customer": Customer,
      "description": "xyz789",
      "externalId": "xyz789",
      "id": GlobalID,
      "metadata": Metadata,
      "paymentIntent": PaymentIntent,
      "recordStatus": "PROCESSED",
      "source": "SHOPIFY",
      "status": "FAILED",
      "updatedAt": ISO8601DateTime
    }
  }
}
Queries

refunds

Description

List all refunds.

Response

Returns a RefundConnection

Arguments
Name 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.

Example

Query
query refunds(
  $after: String,
  $before: String,
  $first: Int,
  $last: Int
) {
  refunds(
    after: $after,
    before: $before,
    first: $first,
    last: $last
  ) {
    edges {
      ...RefundEdgeFragment
    }
    nodes {
      ...RefundFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
  }
}
Variables
{
  "after": "xyz789",
  "before": "xyz789",
  "first": 987,
  "last": 987
}
Response
{
  "data": {
    "refunds": {
      "edges": [RefundEdge],
      "nodes": [Refund],
      "pageInfo": PageInfo,
      "totalCount": 123
    }
  }
}

Mutations

refundProcess

Description

Processes a refund for a payment intent.

Response

Returns a RefundProcessPayload

Arguments
Name Description
input - RefundProcessInput! Input for processing a refund.

Example

Query
mutation refundProcess($input: RefundProcessInput!) {
  refundProcess(input: $input) {
    refund {
      ...RefundFragment
    }
    userErrors {
      ...UserErrorFragment
    }
  }
}
Variables
{"input": RefundProcessInput}
Response
{
  "data": {
    "refundProcess": {
      "refund": Refund,
      "userErrors": [UserError]
    }
  }
}
Mutations

refundRecord

Description

Record a refund for a payment intent.

Response

Returns a RefundRecordPayload

Arguments
Name Description
input - RefundRecordInput! Input for recording a refund.

Example

Query
mutation refundRecord($input: RefundRecordInput!) {
  refundRecord(input: $input) {
    refund {
      ...RefundFragment
    }
    userErrors {
      ...UserErrorFragment
    }
  }
}
Variables
{"input": RefundRecordInput}
Response
{
  "data": {
    "refundRecord": {
      "refund": Refund,
      "userErrors": [UserError]
    }
  }
}

Objects

Refund

Description

A Refund

Fields
Field Name Description
amount - Money The amount the refund if for.
charge - Charge The refund's parent charge.
createdAt - ISO8601DateTime! The time the refund was created.
customer - Customer! The customer associated with the refund.
description - String The refund's description.
externalId - String The external ID of the refund.
id - GlobalID! The ID of the refund.
metadata - Metadata Unstructured key/value pairs/
paymentIntent - PaymentIntent! The associated payment intent.
recordStatus - RecordStatus The record status of refund.
source - ChargeSource The source of the refund.
status - RefundStatus The refund's status.
updatedAt - ISO8601DateTime The time the refund was last updated.
Example
{
  "amount": Money,
  "charge": Charge,
  "createdAt": ISO8601DateTime,
  "customer": Customer,
  "description": "abc123",
  "externalId": "xyz789",
  "id": GlobalID,
  "metadata": Metadata,
  "paymentIntent": PaymentIntent,
  "recordStatus": "PROCESSED",
  "source": "SHOPIFY",
  "status": "FAILED",
  "updatedAt": ISO8601DateTime
}

Shopify Credentials

Mutations

shopifyCredentialsCreate

Description

Creates a set of Shopify credentials.

Response

Returns a ShopifyCredentialsCreatePayload

Arguments
Name Description
input - ShopifyCredentialsCreateInput! Input for creating shopify credentials.

Example

Query
mutation shopifyCredentialsCreate($input: ShopifyCredentialsCreateInput!) {
  shopifyCredentialsCreate(input: $input) {
    shopifyCredentials {
      ...ShopifyCredentialsFragment
    }
    userErrors {
      ...UserErrorFragment
    }
  }
}
Variables
{"input": ShopifyCredentialsCreateInput}
Response
{
  "data": {
    "shopifyCredentialsCreate": {
      "shopifyCredentials": ShopifyCredentials,
      "userErrors": [UserError]
    }
  }
}

Connections

CampaignOrderConnection

Description

The connection type for CampaignOrder.

Fields
Field Name Description
edges - [CampaignOrderEdge] A list of edges.
nodes - [CampaignOrder] A list of nodes.
pageInfo - PageInfo! Information to aid in pagination.
totalCount - Int! The total number of items in the collection
Example
{
  "edges": [CampaignOrderEdge],
  "nodes": [CampaignOrder],
  "pageInfo": PageInfo,
  "totalCount": 987
}
Connections

CampaignOrderEdge

Description

An edge in a connection.

Fields
Field Name Description
cursor - String! A cursor for use in pagination.
node - CampaignOrder The item at the end of the edge.
Example
{
  "cursor": "xyz789",
  "node": CampaignOrder
}
Connections

CampaignOrderGroupConnection

Description

The connection type for CampaignOrderGroup.

Fields
Field Name Description
edges - [CampaignOrderGroupEdge] A list of edges.
nodes - [CampaignOrderGroup] A list of nodes.
pageInfo - PageInfo! Information to aid in pagination.
totalCount - Int! The total number of items in the collection
Example
{
  "edges": [CampaignOrderGroupEdge],
  "nodes": [CampaignOrderGroup],
  "pageInfo": PageInfo,
  "totalCount": 987
}
Connections

CampaignOrderGroupEdge

Description

An edge in a connection.

Fields
Field Name Description
cursor - String! A cursor for use in pagination.
node - CampaignOrderGroup The item at the end of the edge.
Example
{
  "cursor": "xyz789",
  "node": CampaignOrderGroup
}
Connections

ChannelConnection

Description

The connection type for Channel.

Fields
Field Name Description
edges - [ChannelEdge] A list of edges.
nodes - [Channel] A list of nodes.
pageInfo - PageInfo! Information to aid in pagination.
Example
{
  "edges": [ChannelEdge],
  "nodes": [Channel],
  "pageInfo": PageInfo
}
Connections

ChannelEdge

Description

An edge in a connection.

Fields
Field Name Description
cursor - String! A cursor for use in pagination.
node - Channel The item at the end of the edge.
Example
{
  "cursor": "xyz789",
  "node": Channel
}
Connections

ChargeConnection

Description

The connection type for Charge.

Fields
Field Name Description
edges - [ChargeEdge] A list of edges.
nodes - [Charge] A list of nodes.
pageInfo - PageInfo! Information to aid in pagination.
totalCount - Int! The total number of items in the collection
Example
{
  "edges": [ChargeEdge],
  "nodes": [Charge],
  "pageInfo": PageInfo,
  "totalCount": 123
}
Connections

ChargeEdge

Description

An edge in a connection.

Fields
Field Name Description
cursor - String! A cursor for use in pagination.
node - Charge The item at the end of the edge.
Example
{
  "cursor": "abc123",
  "node": Charge
}
Connections

CountryConnection

Description

The connection type for Country.

Fields
Field Name Description
edges - [CountryEdge] A list of edges.
nodes - [Country] A list of nodes.
pageInfo - PageInfo! Information to aid in pagination.
Example
{
  "edges": [CountryEdge],
  "nodes": [Country],
  "pageInfo": PageInfo
}
Connections

CountryEdge

Description

An edge in a connection.

Fields
Field Name Description
cursor - String! A cursor for use in pagination.
node - Country The item at the end of the edge.
Example
{
  "cursor": "abc123",
  "node": Country
}
Connections

CrowdfundingCampaignConnection

Description

The connection type for CrowdfundingCampaign.

Fields
Field Name Description
edges - [CrowdfundingCampaignEdge] A list of edges.
nodes - [CrowdfundingCampaign] A list of nodes.
pageInfo - PageInfo! Information to aid in pagination.
totalCount - Int! The total number of items in the collection
Example
{
  "edges": [CrowdfundingCampaignEdge],
  "nodes": [CrowdfundingCampaign],
  "pageInfo": PageInfo,
  "totalCount": 123
}
Connections

CrowdfundingCampaignEdge

Description

An edge in a connection.

Fields
Field Name Description
cursor - String! A cursor for use in pagination.
node - CrowdfundingCampaign The item at the end of the edge.
Example
{
  "cursor": "abc123",
  "node": CrowdfundingCampaign
}
Connections

CustomerConnection

Description

The connection type for Customer.

Fields
Field Name Description
edges - [CustomerEdge] A list of edges.
nodes - [Customer] A list of nodes.
pageInfo - PageInfo! Information to aid in pagination.
Example
{
  "edges": [CustomerEdge],
  "nodes": [Customer],
  "pageInfo": PageInfo
}
Connections

CustomerEdge

Description

An edge in a connection.

Fields
Field Name Description
cursor - String! A cursor for use in pagination.
node - Customer The item at the end of the edge.
Example
{
  "cursor": "abc123",
  "node": Customer
}
Connections

DeliveryProfileConnection

Description

The connection type for DeliveryProfile.

Fields
Field Name Description
edges - [DeliveryProfileEdge] A list of edges.
nodes - [DeliveryProfile] A list of nodes.
pageInfo - PageInfo! Information to aid in pagination.
Example
{
  "edges": [DeliveryProfileEdge],
  "nodes": [DeliveryProfile],
  "pageInfo": PageInfo
}
Connections

DeliveryProfileEdge

Description

An edge in a connection.

Fields
Field Name Description
cursor - String! A cursor for use in pagination.
node - DeliveryProfile The item at the end of the edge.
Example
{
  "cursor": "xyz789",
  "node": DeliveryProfile
}
Connections

ExternalTokenConnection

Description

The connection type for ExternalToken.

Fields
Field Name Description
edges - [ExternalTokenEdge] A list of edges.
nodes - [ExternalToken] A list of nodes.
pageInfo - PageInfo! Information to aid in pagination.
Example
{
  "edges": [ExternalTokenEdge],
  "nodes": [ExternalToken],
  "pageInfo": PageInfo
}
Connections

ExternalTokenEdge

Description

An edge in a connection.

Fields
Field Name Description
cursor - String! A cursor for use in pagination.
node - ExternalToken The item at the end of the edge.
Example
{
  "cursor": "xyz789",
  "node": ExternalToken
}
Connections

NotificationConnection

Description

The connection type for Notification.

Fields
Field Name Description
edges - [NotificationEdge] A list of edges.
nodes - [Notification] A list of nodes.
pageInfo - PageInfo! Information to aid in pagination.
Example
{
  "edges": [NotificationEdge],
  "nodes": [Notification],
  "pageInfo": PageInfo
}
Connections

NotificationEdge

Description

An edge in a connection.

Fields
Field Name Description
cursor - String! A cursor for use in pagination.
node - Notification The item at the end of the edge.
Example
{
  "cursor": "abc123",
  "node": Notification
}
Connections

NotificationScheduleConnection

Description

The connection type for NotificationSchedule.

Fields
Field Name Description
edges - [NotificationScheduleEdge] A list of edges.
nodes - [NotificationSchedule] A list of nodes.
pageInfo - PageInfo! Information to aid in pagination.
Example
{
  "edges": [NotificationScheduleEdge],
  "nodes": [NotificationSchedule],
  "pageInfo": PageInfo
}
Connections

NotificationScheduleEdge

Description

An edge in a connection.

Fields
Field Name Description
cursor - String! A cursor for use in pagination.
node - NotificationSchedule The item at the end of the edge.
Example
{
  "cursor": "abc123",
  "node": NotificationSchedule
}
Connections

OrderConnection

Description

The connection type for Order.

Fields
Field Name Description
edges - [OrderEdge] A list of edges.
nodes - [Order] A list of nodes.
pageInfo - PageInfo! Information to aid in pagination.
Example
{
  "edges": [OrderEdge],
  "nodes": [Order],
  "pageInfo": PageInfo
}
Connections

OrderEdge

Description

An edge in a connection.

Fields
Field Name Description
cursor - String! A cursor for use in pagination.
node - Order The item at the end of the edge.
Example
{
  "cursor": "abc123",
  "node": Order
}
Connections

OrganisationConnection

Description

The connection type for Organisation.

Fields
Field Name Description
edges - [OrganisationEdge] A list of edges.
nodes - [Organisation] A list of nodes.
pageInfo - PageInfo! Information to aid in pagination.
Example
{
  "edges": [OrganisationEdge],
  "nodes": [Organisation],
  "pageInfo": PageInfo
}
Connections

OrganisationEdge

Description

An edge in a connection.

Fields
Field Name Description
cursor - String! A cursor for use in pagination.
node - Organisation The item at the end of the edge.
Example
{
  "cursor": "xyz789",
  "node": Organisation
}
Connections

PaymentIntentConnection

Description

The connection type for PaymentIntent.

Fields
Field Name Description
edges - [PaymentIntentEdge] A list of edges.
nodes - [PaymentIntent] A list of nodes.
pageInfo - PageInfo! Information to aid in pagination.
totalCount - Int! The total number of items in the collection
Example
{
  "edges": [PaymentIntentEdge],
  "nodes": [PaymentIntent],
  "pageInfo": PageInfo,
  "totalCount": 123
}
Connections

PaymentIntentEdge

Description

An edge in a connection.

Fields
Field Name Description
cursor - String! A cursor for use in pagination.
node - PaymentIntent The item at the end of the edge.
Example
{
  "cursor": "xyz789",
  "node": PaymentIntent
}
Connections

PaymentMethodConnection

Description

The connection type for PaymentMethod.

Fields
Field Name Description
edges - [PaymentMethodEdge] A list of edges.
nodes - [PaymentMethod] A list of nodes.
pageInfo - PageInfo! Information to aid in pagination.
totalCount - Int! The total number of items in the collection
Example
{
  "edges": [PaymentMethodEdge],
  "nodes": [PaymentMethod],
  "pageInfo": PageInfo,
  "totalCount": 123
}
Connections

PaymentMethodEdge

Description

An edge in a connection.

Fields
Field Name Description
cursor - String! A cursor for use in pagination.
node - PaymentMethod The item at the end of the edge.
Example
{
  "cursor": "xyz789",
  "node": PaymentMethod
}
Connections

PresaleCampaignConnection

Description

The connection type for PresaleCampaign.

Fields
Field Name Description
edges - [PresaleCampaignEdge] A list of edges.
nodes - [PresaleCampaign] A list of nodes.
pageInfo - PageInfo! Information to aid in pagination.
totalCount - Int! The total number of items in the collection
Example
{
  "edges": [PresaleCampaignEdge],
  "nodes": [PresaleCampaign],
  "pageInfo": PageInfo,
  "totalCount": 123
}
Connections

PresaleCampaignEdge

Description

An edge in a connection.

Fields
Field Name Description
cursor - String! A cursor for use in pagination.
node - PresaleCampaign The item at the end of the edge.
Example
{
  "cursor": "abc123",
  "node": PresaleCampaign
}
Connections

ProductCollectionConnection

Description

The connection type for ProductCollection.

Fields
Field Name Description
edges - [ProductCollectionEdge] A list of edges.
nodes - [ProductCollection] A list of nodes.
pageInfo - PageInfo! Information to aid in pagination.
totalCount - Int!
Example
{
  "edges": [ProductCollectionEdge],
  "nodes": [ProductCollection],
  "pageInfo": PageInfo,
  "totalCount": 123
}
Connections

ProductCollectionEdge

Description

An edge in a connection.

Fields
Field Name Description
cursor - String! A cursor for use in pagination.
node - ProductCollection The item at the end of the edge.
Example
{
  "cursor": "abc123",
  "node": ProductCollection
}
Connections

ProductConnection

Description

The connection type for Product.

Fields
Field Name Description
edges - [ProductEdge] A list of edges.
nodes - [Product] A list of nodes.
pageInfo - PageInfo! Information to aid in pagination.
totalCount - Int!
Example
{
  "edges": [ProductEdge],
  "nodes": [Product],
  "pageInfo": PageInfo,
  "totalCount": 987
}
Connections

ProductEdge

Description

An edge in a connection.

Fields
Field Name Description
cursor - String! A cursor for use in pagination.
node - Product The item at the end of the edge.
Example
{
  "cursor": "abc123",
  "node": Product
}
Connections

ProductVariantConnection

Description

The connection type for ProductVariant.

Fields
Field Name Description
edges - [ProductVariantEdge] A list of edges.
nodes - [ProductVariant] A list of nodes.
pageInfo - PageInfo! Information to aid in pagination.
totalCount - Int!
Example
{
  "edges": [ProductVariantEdge],
  "nodes": [ProductVariant],
  "pageInfo": PageInfo,
  "totalCount": 123
}
Connections

ProductVariantEdge

Description

An edge in a connection.

Fields
Field Name Description
cursor - String! A cursor for use in pagination.
node - ProductVariant The item at the end of the edge.
Example
{
  "cursor": "xyz789",
  "node": ProductVariant
}
Connections

RefundConnection

Description

The connection type for Refund.

Fields
Field Name Description
edges - [RefundEdge] A list of edges.
nodes - [Refund] A list of nodes.
pageInfo - PageInfo! Information to aid in pagination.
totalCount - Int! The total number of items in the collection
Example
{
  "edges": [RefundEdge],
  "nodes": [Refund],
  "pageInfo": PageInfo,
  "totalCount": 987
}
Connections

RefundEdge

Description

An edge in a connection.

Fields
Field Name Description
cursor - String! A cursor for use in pagination.
node - Refund The item at the end of the edge.
Example
{
  "cursor": "xyz789",
  "node": Refund
}
Connections

ScheduledNotificationConnection

Description

The connection type for ScheduledNotification.

Fields
Field Name Description
edges - [ScheduledNotificationEdge] A list of edges.
nodes - [ScheduledNotification] A list of nodes.
pageInfo - PageInfo! Information to aid in pagination.
Example
{
  "edges": [ScheduledNotificationEdge],
  "nodes": [ScheduledNotification],
  "pageInfo": PageInfo
}
Connections

ScheduledNotificationEdge

Description

An edge in a connection.

Fields
Field Name Description
cursor - String! A cursor for use in pagination.
node - ScheduledNotification The item at the end of the edge.
Example
{
  "cursor": "xyz789",
  "node": ScheduledNotification
}
Connections

SubscriptionConnection

Description

The connection type for Subscription.

Fields
Field Name Description
edges - [SubscriptionEdge] A list of edges.
nodes - [Subscription] A list of nodes.
pageInfo - PageInfo! Information to aid in pagination.
totalCount - Int! The total number of items in the collection
Example
{
  "edges": [SubscriptionEdge],
  "nodes": [Subscription],
  "pageInfo": PageInfo,
  "totalCount": 987
}
Connections

SubscriptionEdge

Description

An edge in a connection.

Fields
Field Name Description
cursor - String! A cursor for use in pagination.
node - Subscription The item at the end of the edge.
Example
{
  "cursor": "xyz789",
  "node": Subscription
}
Connections

SubscriptionGroupConnection

Description

The connection type for SubscriptionGroup.

Fields
Field Name Description
edges - [SubscriptionGroupEdge] A list of edges.
nodes - [SubscriptionGroup] A list of nodes.
pageInfo - PageInfo! Information to aid in pagination.
totalCount - Int! The total number of items in the collection
Example
{
  "edges": [SubscriptionGroupEdge],
  "nodes": [SubscriptionGroup],
  "pageInfo": PageInfo,
  "totalCount": 987
}
Connections

SubscriptionGroupEdge

Description

An edge in a connection.

Fields
Field Name Description
cursor - String! A cursor for use in pagination.
node - SubscriptionGroup The item at the end of the edge.
Example
{
  "cursor": "xyz789",
  "node": SubscriptionGroup
}
Connections

SubscriptionOrderConnection

Description

The connection type for SubscriptionOrder.

Fields
Field Name Description
edges - [SubscriptionOrderEdge] A list of edges.
nodes - [SubscriptionOrder] A list of nodes.
pageInfo - PageInfo! Information to aid in pagination.
totalCount - Int! The total number of items in the collection
Example
{
  "edges": [SubscriptionOrderEdge],
  "nodes": [SubscriptionOrder],
  "pageInfo": PageInfo,
  "totalCount": 123
}
Connections

SubscriptionOrderEdge

Description

An edge in a connection.

Fields
Field Name Description
cursor - String! A cursor for use in pagination.
node - SubscriptionOrder The item at the end of the edge.
Example
{
  "cursor": "xyz789",
  "node": SubscriptionOrder
}
Connections

SubscriptionPlanConnection

Description

The connection type for SubscriptionPlan.

Fields
Field Name Description
edges - [SubscriptionPlanEdge] A list of edges.
nodes - [SubscriptionPlan] A list of nodes.
pageInfo - PageInfo! Information to aid in pagination.
totalCount - Int! The total number of items in the collection
Example
{
  "edges": [SubscriptionPlanEdge],
  "nodes": [SubscriptionPlan],
  "pageInfo": PageInfo,
  "totalCount": 123
}
Connections

SubscriptionPlanEdge

Description

An edge in a connection.

Fields
Field Name Description
cursor - String! A cursor for use in pagination.
node - SubscriptionPlan The item at the end of the edge.
Example
{
  "cursor": "abc123",
  "node": SubscriptionPlan
}
Connections

SubscriptionPlanGroupConnection

Description

The connection type for SubscriptionPlanGroup.

Fields
Field Name Description
edges - [SubscriptionPlanGroupEdge] A list of edges.
nodes - [SubscriptionPlanGroup] A list of nodes.
pageInfo - PageInfo! Information to aid in pagination.
totalCount - Int! The total number of items in the collection
Example
{
  "edges": [SubscriptionPlanGroupEdge],
  "nodes": [SubscriptionPlanGroup],
  "pageInfo": PageInfo,
  "totalCount": 987
}
Connections

SubscriptionPlanGroupEdge

Description

An edge in a connection.

Fields
Field Name Description
cursor - String! A cursor for use in pagination.
node - SubscriptionPlanGroup The item at the end of the edge.
Example
{
  "cursor": "abc123",
  "node": SubscriptionPlanGroup
}
Connections

WebhookConnection

Description

The connection type for Webhook.

Fields
Field Name Description
edges - [WebhookEdge] A list of edges.
nodes - [Webhook] A list of nodes.
pageInfo - PageInfo! Information to aid in pagination.
Example
{
  "edges": [WebhookEdge],
  "nodes": [Webhook],
  "pageInfo": PageInfo
}
Connections

WebhookEdge

Description

An edge in a connection.

Fields
Field Name Description
cursor - String! A cursor for use in pagination.
node - Webhook The item at the end of the edge.
Example
{
  "cursor": "xyz789",
  "node": Webhook
}

Enums

AccessTokenMode

Description

access token mode

Values
Enum Value Description

STATEFUL

 stateful

STATELESS

 stateless
Example
"STATEFUL"
Enums

AccessTokenType

Description

access token type

Values
Enum Value Description

CHANNEL

 channel

CUSTOMER

 customer
Example
"CHANNEL"
Enums

CampaignAllocationStatus

Description

The allocation status of a campaign.

Values
Enum Value Description

ALLOCATED

 Allocation is complete.

ALLOCATING

 Allocation is in progress.

ALLOCATION_QUEUED

 Allocation is queued.

PARTIALLY_ALLOCATED

 Campaign is partially allocated.

PENDING

 Allocation is pending.
Example
"ALLOCATED"
Enums

CampaignDepositType

Description

The campaign deposit type.

Values
Enum Value Description

PERCENTAGE

 Campaign deposit type is a percentage
Example
"PERCENTAGE"
Enums

CampaignItemType

Description

The possible item types.

Values
Enum Value Description

PRODUCT

 The type is a product type.

PRODUCT_VARIANT

 The type is a product variant type.
Example
"PRODUCT"
Enums

CampaignOrderFulfilmentStatus

Description

Fulfilment status of campaign order.

Values
Enum Value Description

ALLOCATED

 Campaign order fulfilment is allocated

FAILED

 Campaign order fulfilment is failed

FULFILLED

 Campaign order fulfilment is fulfilled

ON_HOLD

 Campaign order fulfilment is on hold

OPEN

 Campaign order fulfilment is open

PENDING

 Campaign order fulfilment is pending

RETURNED

 Campaign order fulfilment is returned

SUBMITTED

 Campaign order fulfilment is submitted
Example
"ALLOCATED"
Enums

CampaignOrderGroupStatus

Description

Status of campaign order group eg: (pending, paid)

Values
Enum Value Description

ALLOCATED

 Campaign order group is allocated

CANCELLED

 Campaign order group is cancelled

COMPLETED

 Campaign order group is completed

PAID

 Campaign order group is paid

PENDING

 Campaign order group is pending
Example
"ALLOCATED"
Enums

CampaignOrderPaymentStatus

Description

Payment status of the campaign order.

Values
Enum Value Description

FAILED

 Payment failed.

PAID

 Payment captured..

PARTIALLY_REFUNDED

 Payment partially refunded.

PENDING

 Payment pending.

REFUNDED

 Payment refunded.

SUBMITTED

 Payment submitted.
Example
"FAILED"
Enums

CampaignOrderSortKey

Description

The key used to sort campaign orders.

Values
Enum Value Description

CREATED_AT

 Sort by created at.

ID

 Sort by ID.

IDENTIFIER

 Sort by identifier.
Example
"CREATED_AT"
Enums

CampaignOrderStatus

Description

Status of campaign order eg: (pending, paid)

Values
Enum Value Description

ALLOCATED

 Campaign order is allocated

CANCELLED

 Campaign order is cancelled

COMPLETED

 Campaign order is completed

PAID

 Campaign order is paid

PENDING

 Campaign order is pending
Example
"ALLOCATED"
Enums

CampaignPaymentTermsAlignment

Description

When should payments be captured when they are defined on a group?

Values
Enum Value Description

FIRST_CAMPAIGN

 Payment terms are aligned to the first campaign.

LAST_CAMPAIGN

 Payment terms are aligned to the last campaign.
Example
"FIRST_CAMPAIGN"
Enums

CampaignStatus

Description

The status of a campaign.

Values
Enum Value Description

CANCELLED

 Campaign is cancelled

COMPLETED

 Campaign is completed

ENDED

 Campaign is ended

FULFILLING

 Campaign is fulfilling

LAUNCHED

 Campaign is launched

PENDING

 Campaign is pending
Example
"CANCELLED"
Enums

CampaignType

Description

The possible campaign types.

Values
Enum Value Description

CROWDFUNDING

 The campaign is a crowdfunding campaign.

PRESALE

 The campaign is a presale campaign.
Example
"CROWDFUNDING"
Enums

CardBrand

Description

The card brands supported by Submarine.

Values
Enum Value Description

AMEX

 American Express (Amex).

BOGUS

 Bogus

DINERS_CLUB

 Diners Club

DISCOVER

 Discover & Diners

JCB

 Japan Credit Bureau (JCB)

MASTERCARD

 Mastercard.

UNIONPAY

 China UnionPay (CUP)

UNKNOWN

 Unknown

VISA

 Visa.
Example
"AMEX"
Enums

ChannelStatus

Description

The possible channel statuses.

Values
Enum Value Description

ACTIVE

 The channel is active.

INACTIVE

 The channel is inactive.
Example
"ACTIVE"
Enums

ChannelType

Description

channel type

Values
Enum Value Description

SHOPIFY

 shopify
Example
"SHOPIFY"
Enums

ChargeFailureCode

Description

Failure code

Values
Enum Value Description

API_ERROR

 API error

CARD_DECLINED

 Card declined
Example
"API_ERROR"
Enums

ChargeSource

Description

The source of a charge or refund.

Values
Enum Value Description

SHOPIFY

 Shopify

SUBMARINE

 Submarine

UNKNOWN

 Unknown source
Example
"SHOPIFY"
Enums

ChargeStatus

Description

Status of charge eg: (pending)

Values
Enum Value Description

FAILED

 Charge failed

PENDING

 Charge pending

SUCCEEDED

 Charge succeeded
Example
"FAILED"
Enums

ChargeType

Description

Type of charge (eg. verify)

Values
Enum Value Description

AUTHORISE

 Authorise

CAPTURE

 Capture

SALE

 Sale

VERIFY

 Verify
Example
"AUTHORISE"
Enums

CountryCode

Description

country code

Values
Enum Value Description

AC

 Saint Helena, Ascension and Tristan da Cunha

AD

 Andorra

AE

 United Arab Emirates

AF

 Afghanistan

AG

 Antigua and Barbuda

AI

 Anguilla

AL

 Albania

AM

 Armenia

AO

 Angola

AQ

 Antarctica

AR

 Argentina

AS

 American Samoa

AT

 Austria

AU

 Australia

AW

 Aruba

AX

 Åland Islands

AZ

 Azerbaijan

BA

 Bosnia and Herzegovina

BB

 Barbados

BD

 Bangladesh

BE

 Belgium

BF

 Burkina Faso

BG

 Bulgaria

BH

 Bahrain

BI

 Burundi

BJ

 Benin

BL

 Saint Barthélemy

BM

 Bermuda

BN

 Brunei Darussalam

BO

 Bolivia (Plurinational State of)

BQ

 Bonaire, Sint Eustatius and Saba

BR

 Brazil

BS

 Bahamas

BT

 Bhutan

BV

 Bouvet Island

BW

 Botswana

BY

 Belarus

BZ

 Belize

CA

 Canada

CC

 Cocos (Keeling) Islands

CD

 Congo (Democratic Republic of the)

CF

 Central African Republic

CG

 Congo

CH

 Switzerland

CI

 Côte d'Ivoire

CK

 Cook Islands

CL

 Chile

CM

 Cameroon

CN

 China

CO

 Colombia

CR

 Costa Rica

CU

 Cuba

CV

 Cabo Verde

CW

 Curaçao

CX

 Christmas Island

CY

 Cyprus

CZ

 Czechia

DE

 Germany

DJ

 Djibouti

DK

 Denmark

DM

 Dominica

DO

 Dominican Republic

DZ

 Algeria

EC

 Ecuador

EE

 Estonia

EG

 Egypt

EH

 Western Sahara

ER

 Eritrea

ES

 Spain

ET

 Ethiopia

FI

 Finland

FJ

 Fiji

FK

 Falkland Islands (Malvinas)

FM

 Micronesia (Federated States of)

FO

 Faroe Islands

FR

 France

GA

 Gabon

GB

 United Kingdom of Great Britain and Northern Ireland

GD

 Grenada

GE

 Georgia

GF

 French Guiana

GG

 Guernsey

GH

 Ghana

GI

 Gibraltar

GL

 Greenland

GM

 Gambia

GN

 Guinea

GP

 Guadeloupe

GQ

 Equatorial Guinea

GR

 Greece

GS

 South Georgia and the South Sandwich Islands

GT

 Guatemala

GU

 Guam

GW

 Guinea-Bissau

GY

 Guyana

HK

 Hong Kong

HM

 Heard Island and McDonald Islands

HN

 Honduras

HR

 Croatia

HT

 Haiti

HU

 Hungary

ID

 Indonesia

IE

 Ireland

IL

 Israel

IM

 Isle of Man

IN

 India

IO

 British Indian Ocean Territory

IQ

 Iraq

IR

 Iran (Islamic Republic of)

IS

 Iceland

IT

 Italy

JE

 Jersey

JM

 Jamaica

JO

 Jordan

JP

 Japan

KE

 Kenya

KG

 Kyrgyzstan

KH

 Cambodia

KI

 Kiribati

KM

 Comoros

KN

 Saint Kitts and Nevis

KP

 Korea (Democratic People's Republic of)

KR

 Korea (Republic of)

KW

 Kuwait

KY

 Cayman Islands

KZ

 Kazakhstan

LA

 Lao People's Democratic Republic

LB

 Lebanon

LC

 Saint Lucia

LI

 Liechtenstein

LK

 Sri Lanka

LR

 Liberia

LS

 Lesotho

LT

 Lithuania

LU

 Luxembourg

LV

 Latvia

LY

 Libya

MA

 Morocco

MC

 Monaco

MD

 Moldova (Republic of)

ME

 Montenegro

MF

 Saint Martin (French part)

MG

 Madagascar

MH

 Marshall Islands

MK

 North Macedonia

ML

 Mali

MM

 Myanmar

MN

 Mongolia

MO

 Macao

MP

 Northern Mariana Islands

MQ

 Martinique

MR

 Mauritania

MS

 Montserrat

MT

 Malta

MU

 Mauritius

MV

 Maldives

MW

 Malawi

MX

 Mexico

MY

 Malaysia

MZ

 Mozambique

NA

 Namibia

NC

 New Caledonia

NE

 Niger

NF

 Norfolk Island

NG

 Nigeria

NI

 Nicaragua

NL

 Netherlands

NO

 Norway

NP

 Nepal

NR

 Nauru

NU

 Niue

NZ

 New Zealand

OM

 Oman

PA

 Panama

PE

 Peru

PF

 French Polynesia

PG

 Papua New Guinea

PH

 Philippines

PK

 Pakistan

PL

 Poland

PM

 Saint Pierre and Miquelon

PN

 Pitcairn

PR

 Puerto Rico

PS

 Palestine, State of

PT

 Portugal

PW

 Palau

PY

 Paraguay

QA

 Qatar

RE

 Réunion

RO

 Romania

RS

 Serbia

RU

 Russian Federation

RW

 Rwanda

SA

 Saudi Arabia

SB

 Solomon Islands

SC

 Seychelles

SD

 Sudan

SE

 Sweden

SG

 Singapore

SH

 Saint Helena, Ascension and Tristan da Cunha

SI

 Slovenia

SJ

 Svalbard and Jan Mayen

SK

 Slovakia

SL

 Sierra Leone

SM

 San Marino

SN

 Senegal

SO

 Somalia

SR

 Suriname

SS

 South Sudan

ST

 Sao Tome and Principe

SV

 El Salvador

SX

 Sint Maarten (Dutch part)

SY

 Syrian Arab Republic

SZ

 Eswatini

TA

 Saint Helena, Ascension and Tristan da Cunha

TC

 Turks and Caicos Islands

TD

 Chad

TF

 French Southern Territories

TG

 Togo

TH

 Thailand

TJ

 Tajikistan

TK

 Tokelau

TL

 Timor-Leste

TM

 Turkmenistan

TN

 Tunisia

TO

 Tonga

TR

 Türkiye

TT

 Trinidad and Tobago

TV

 Tuvalu

TW

 Taiwan, Province of China

TZ

 Tanzania, United Republic of

UA

 Ukraine

UG

 Uganda

UM

 United States Minor Outlying Islands

US

 United States of America

UY

 Uruguay

UZ

 Uzbekistan

VA

 Holy See

VC

 Saint Vincent and the Grenadines

VE

 Venezuela (Bolivarian Republic of)

VG

 Virgin Islands (British)

VI

 Virgin Islands (U.S.)

VN

 Viet Nam

VU

 Vanuatu

WF

 Wallis and Futuna

WS

 Samoa

XK

 Kosovo

YE

 Yemen

YT

 Mayotte

ZA

 South Africa

ZM

 Zambia

ZW

 Zimbabwe
Example
"AC"
Enums

CrowdfundingCampaignSortKey

Description

The key used to sort crowdfunding campaigns.

Values
Enum Value Description

COMPLETED_AT

 Sort by the crowdfunding campaigns completion date.

END_AT

 Sort by the crowdfunding campaigns end date.

FULFIL_AT

 Sort by the crowdfunding campaigns fulfilment date.

GOAL_PROGRESS

 Sort by the crowdfunding campaigns goal_progress.

ID

 Sort by the crowdfunding campaigns ID.

LAUNCH_AT

 Sort by the crowdfunding campaigns launch date.
Example
"COMPLETED_AT"
Enums

CrowdfundingGoalStatus

Description

The goal status of a crowdfunding campaign.

Values
Enum Value Description

FAILED

 Campaign has failed

PENDING

 Campaign is pending

SUCCEEDED

 Campaign has succeeded
Example
"FAILED"
Enums

CrowdfundingGoalType

Description

The possible crowdfunding campaign goal types.

Values
Enum Value Description

TOTAL_UNITS

 The type is a total units type.

TOTAL_VALUE

 The type is a total value type.
Example
"TOTAL_UNITS"
Enums

CurrencyCode

Description

currency code

Values
Enum Value Description

AED

 United Arab Emirates Dirham

AFN

 Afghan Afghani

ALL

 Albanian Lek

AMD

 Armenian Dram

ANG

 Netherlands Antillean Gulden

AOA

 Angolan Kwanza

ARS

 Argentine Peso

AUD

 Australian Dollar

AWG

 Aruban Florin

AZN

 Azerbaijani Manat

BAM

 Bosnia and Herzegovina Convertible Mark

BBD

 Barbadian Dollar

BCH

 Bitcoin Cash

BDT

 Bangladeshi Taka

BGN

 Bulgarian Lev

BHD

 Bahraini Dinar

BIF

 Burundian Franc

BMD

 Bermudian Dollar

BND

 Brunei Dollar

BOB

 Bolivian Boliviano

BRL

 Brazilian Real

BSD

 Bahamian Dollar

BTC

 Bitcoin

BTN

 Bhutanese Ngultrum

BWP

 Botswana Pula

BYN

 Belarusian Ruble

BYR

 Belarusian Ruble

BZD

 Belize Dollar

CAD

 Canadian Dollar

CDF

 Congolese Franc

CHF

 Swiss Franc

CLF

 Unidad de Fomento

CLP

 Chilean Peso

CNH

 Chinese Renminbi Yuan Offshore

CNY

 Chinese Renminbi Yuan

COP

 Colombian Peso

CRC

 Costa Rican Colón

CUC

 Cuban Convertible Peso

CUP

 Cuban Peso

CVE

 Cape Verdean Escudo

CZK

 Czech Koruna

DJF

 Djiboutian Franc

DKK

 Danish Krone

DOP

 Dominican Peso

DZD

 Algerian Dinar

EEK

 Estonian Kroon

EGP

 Egyptian Pound

ERN

 Eritrean Nakfa

ETB

 Ethiopian Birr

EUR

 Euro

FJD

 Fijian Dollar

FKP

 Falkland Pound

GBP

 British Pound

GBX

 British Penny

GEL

 Georgian Lari

GGP

 Guernsey Pound

GHS

 Ghanaian Cedi

GIP

 Gibraltar Pound

GMD

 Gambian Dalasi

GNF

 Guinean Franc

GTQ

 Guatemalan Quetzal

GYD

 Guyanese Dollar

HKD

 Hong Kong Dollar

HNL

 Honduran Lempira

HRK

 Croatian Kuna

HTG

 Haitian Gourde

HUF

 Hungarian Forint

IDR

 Indonesian Rupiah

ILS

 Israeli New Sheqel

IMP

 Isle of Man Pound

INR

 Indian Rupee

IQD

 Iraqi Dinar

IRR

 Iranian Rial

ISK

 Icelandic Króna

JEP

 Jersey Pound

JMD

 Jamaican Dollar

JOD

 Jordanian Dinar

JPY

 Japanese Yen

KES

 Kenyan Shilling

KGS

 Kyrgyzstani Som

KHR

 Cambodian Riel

KMF

 Comorian Franc

KPW

 North Korean Won

KRW

 South Korean Won

KWD

 Kuwaiti Dinar

KYD

 Cayman Islands Dollar

KZT

 Kazakhstani Tenge

LAK

 Lao Kip

LBP

 Lebanese Pound

LKR

 Sri Lankan Rupee

LRD

 Liberian Dollar

LSL

 Lesotho Loti

LTL

 Lithuanian Litas

LVL

 Latvian Lats

LYD

 Libyan Dinar

MAD

 Moroccan Dirham

MDL

 Moldovan Leu

MGA

 Malagasy Ariary

MKD

 Macedonian Denar

MMK

 Myanmar Kyat

MNT

 Mongolian Tögrög

MOP

 Macanese Pataca

MRO

 Mauritanian Ouguiya

MRU

 Mauritanian Ouguiya

MTL

 Maltese Lira

MUR

 Mauritian Rupee

MVR

 Maldivian Rufiyaa

MWK

 Malawian Kwacha

MXN

 Mexican Peso

MYR

 Malaysian Ringgit

MZN

 Mozambican Metical

NAD

 Namibian Dollar

NGN

 Nigerian Naira

NIO

 Nicaraguan Córdoba

NOK

 Norwegian Krone

NPR

 Nepalese Rupee

NZD

 New Zealand Dollar

OMR

 Omani Rial

PAB

 Panamanian Balboa

PEN

 Peruvian Sol

PGK

 Papua New Guinean Kina

PHP

 Philippine Peso

PKR

 Pakistani Rupee

PLN

 Polish Złoty

PYG

 Paraguayan Guaraní

QAR

 Qatari Riyal

RON

 Romanian Leu

RSD

 Serbian Dinar

RUB

 Russian Ruble

RWF

 Rwandan Franc

SAR

 Saudi Riyal

SBD

 Solomon Islands Dollar

SCR

 Seychellois Rupee

SDG

 Sudanese Pound

SEK

 Swedish Krona

SGD

 Singapore Dollar

SHP

 Saint Helenian Pound

SKK

 Slovak Koruna

SLL

 Sierra Leonean Leone

SOS

 Somali Shilling

SRD

 Surinamese Dollar

SSP

 South Sudanese Pound

STD

 São Tomé and Príncipe Dobra

SVC

 Salvadoran Colón

SYP

 Syrian Pound

SZL

 Swazi Lilangeni

THB

 Thai Baht

TJS

 Tajikistani Somoni

TMM

 Turkmenistani Manat

TMT

 Turkmenistani Manat

TND

 Tunisian Dinar

TOP

 Tongan Paʻanga

TRY

 Turkish Lira

TTD

 Trinidad and Tobago Dollar

TWD

 New Taiwan Dollar

TZS

 Tanzanian Shilling

UAH

 Ukrainian Hryvnia

UGX

 Ugandan Shilling

USD

 United States Dollar

UYU

 Uruguayan Peso

UZS

 Uzbekistan Som

VEF

 Venezuelan Bolívar

VES

 Venezuelan Bolívar Soberano

VND

 Vietnamese Đồng

VUV

 Vanuatu Vatu

WST

 Samoan Tala

XAF

 Central African Cfa Franc

XAG

 Silver (Troy Ounce)

XAU

 Gold (Troy Ounce)

XBA

 European Composite Unit

XBB

 European Monetary Unit

XBC

 European Unit of Account 9

XBD

 European Unit of Account 17

XCD

 East Caribbean Dollar

XDR

 Special Drawing Rights

XFU

 UIC Franc

XOF

 West African Cfa Franc

XPD

 Palladium

XPF

 Cfp Franc

XPT

 Platinum

XTS

 Codes specifically reserved for testing purposes

YER

 Yemeni Rial

ZAR

 South African Rand

ZMK

 Zambian Kwacha

ZMW

 Zambian Kwacha

ZWD

 Zimbabwean Dollar

ZWL

 Zimbabwean Dollar

ZWN

 Zimbabwean Dollar

ZWR

 Zimbabwean Dollar
Example
"AED"
Enums

CustomerStatus

Description

Translation missing: en.graphql.enums.customer_status.description

Values
Enum Value Description

ACTIVE

 Translation missing: en.graphql.enums.customer_status.values.active

INACTIVE

 Translation missing: en.graphql.enums.customer_status.values.inactive
Example
"ACTIVE"
Enums

DeliveryProfileStatus

Description

Translation missing: en.graphql.enums.delivery_profile_status.description

Values
Enum Value Description

ACTIVE

 Translation missing: en.graphql.enums.delivery_profile_status.values.active

INACTIVE

 Translation missing: en.graphql.enums.delivery_profile_status.values.inactive
Example
"ACTIVE"
Enums

DepositType

Description

The possible deposit types for a presale campaign.

Values
Enum Value Description

PERCENTAGE

 The deposit is collected as percentage.
Example
"PERCENTAGE"
Enums

DiscountType

Values
Enum Value Description

AUTOMATIC

CODE

SCRIPT
Example
"AUTOMATIC"
Enums

MoneyRoundingMode

Description

The method used to round prices.

Values
Enum Value Description

ROUND_CEILING

 Round toward positive infinity.

ROUND_DOWN

 Round toward zero.

ROUND_FLOOR

 Round toward negative infinity.

ROUND_HALF_DOWN

 Round toward the nearest neighbour; if the neighbours are equidistant, round toward zero.

ROUND_HALF_EVEN

 Round toward the nearest neighbour; if the neighbours are equidistant, round toward the even neighbour.

ROUND_HALF_UP

 Round toward the nearest neighbour; if the neighbours are equidistant, round away from zero.

ROUND_UP

 Round away from zero.
Example
"ROUND_CEILING"
Enums

NotificationDeliveryMechanism

Description

Delivery mechanism for a notification.

Values
Enum Value Description

EMAIL

 Email

EXTERNAL

 External

WEBHOOK

 Webhook
Example
"EMAIL"
Enums

NotificationDeliveryStatus

Description

Delivery status of a notification.

Values
Enum Value Description

FAILED

 Failed

PENDING

 Pending

SUCCEEDED

 Succeeded
Example
"FAILED"
Enums

NotificationScheduleTrigger

Description

The trigger event that the notification schedule is anchored to.

Values
Enum Value Description

CROWDFUND_END_AT

 Crowdfund end at

PRESALE_DUE_AT

 Presale due at

UPCOMING_CARD_EXPIRY

 Upcoming card expiry

UPCOMING_SUBSCRIPTION_ORDER

 Upcoming subscription order
Example
"CROWDFUND_END_AT"
Enums

OrganisationStatus

Description

Status of organisation eg: (active)

Values
Enum Value Description

ACTIVE

 Organisation is active

INACTIVE

 Organisation is inactive
Example
"ACTIVE"
Enums

PaymentInstrumentType

Description

The types of payment instrument supported by Submarine.

Values
Enum Value Description

CARD

 Card

PAYPAL_BILLING_AGREEMENT

 Paypal billing agreement

UNKNOWN
Example
"CARD"
Enums

PaymentIntentStatus

Description

Status of the payment intent

Values
Enum Value Description

CANCELLED

 Payment intent cancelled

PROCESSING

 Payment intent processing

REQUIRES_ACTION

 Payment intent requires_action

REQUIRES_CAPTURE

 Payment intent requires_capture

SUCCEEDED

 Payment intent succeeded
Example
"CANCELLED"
Enums

PaymentMethodFutureUsage

Description

Future usage of payment method.

Values
Enum Value Description

ONE_OFF

 Future usage for one off payments

RECURRING

 Future usage for recurring payments

UNKNOWN

 Future usage unknown
Example
"ONE_OFF"
Enums

PaymentMethodStatus

Description

Status of the payment method

Values
Enum Value Description

ACTIVE

 Payment method active

DELETED

 Payment method deleted

INACTIVE

 Payment method inactive
Example
"ACTIVE"
Enums

PaymentProcessorType

Description

The types of payment processor supported by Submarine.

Values
Enum Value Description

SHOPIFY

 Shopify Payments.
Example
"SHOPIFY"
Enums

Persona

Description

A Submarine persona.

Values
Enum Value Description

CUSTOMER

 A customer.

MERCHANT

 A merchant.

SUBMARINE

 A Submarine service.
Example
"CUSTOMER"
Enums

PresaleCampaignSortKey

Description

The key used to sort presale campaigns.

Values
Enum Value Description

COMPLETED_AT

 Sort by the presale campaigns completion date.

END_AT

 Sort by the presale campaigns end date.

FULFIL_AT

 Sort by the presale campaigns fulfilment date.

ID

 Sort by the presale campaigns ID.

LAUNCH_AT

 Sort by the presale campaigns launch date.
Example
"COMPLETED_AT"
Enums

PresaleInventoryPolicy

Values
Enum Value Description

ON_FULFILMENT

ON_SALE
Example
"ON_FULFILMENT"
Enums

PriceEnginePolicy

Description

When to refresh an engine's price sources.

Values
Enum Value Description

ALWAYS

 Always refresh the engine's price source.

ON_DEMAND

 Only refresh the price source when the resource changes demand it.
Example
"ALWAYS"
Enums

PriceEngineProvider

Description

A trusted source of price information.

Values
Enum Value Description

SHOPIFY

 Get price sources from Shopify.
Example
"SHOPIFY"
Enums

ProductCollectionItemStatus

Description

Status of product collection item eg: (active)

Values
Enum Value Description

ACTIVE

 Product collection item has not been deleted

DELETED

 Product collection item has been soft deleted

PENDING

 Product collection item is pending
Example
"ACTIVE"
Enums

ProductCollectionStatus

Description

Status of product collection eg: (published)

Values
Enum Value Description

DELETED

 Product collection is deleted

PUBLISHED

 Product collection is published

UNPUBLISHED

 Product collection is unpublished
Example
"DELETED"
Enums

ProductStatus

Description

Status of product eg: (published)

Values
Enum Value Description

DELETED

 Product is deleted

PUBLISHED

 Product is published

UNPUBLISHED

 Product is unpublished
Example
"DELETED"
Enums

ProductVariantStatus

Description

Status of product variant eg: (published)

Values
Enum Value Description

DELETED

 Product variant is deleted

PUBLISHED

 Product variant is published

UNPUBLISHED

 Product variant is unpublished
Example
"DELETED"
Enums

ProvinceType

Description

Translation missing: en.graphql.enums.province_type.description

Values
Enum Value Description

ADMINISTRATION

 Translation missing: en.graphql.enums.province_type.values.administration

ADMINISTRATIVE_ATOLL

 Translation missing: en.graphql.enums.province_type.values.administrative_atoll

ADMINISTRATIVE_PRECINCT

 Translation missing: en.graphql.enums.province_type.values.administrative_precinct

ADMINISTRATIVE_REGION

 Translation missing: en.graphql.enums.province_type.values.administrative_region

ADMINISTRATIVE_TERRITORY

 Translation missing: en.graphql.enums.province_type.values.administrative_territory

ARCTIC_REGION

 Translation missing: en.graphql.enums.province_type.values.arctic_region

AREA

 Translation missing: en.graphql.enums.province_type.values.area

AUTONOMOUS_CITY

 Translation missing: en.graphql.enums.province_type.values.autonomous_city

AUTONOMOUS_CITY_IN_NORTH_AFRICA

 Translation missing: en.graphql.enums.province_type.values.autonomous_city_in_north_africa

AUTONOMOUS_COMMUNITY

 Translation missing: en.graphql.enums.province_type.values.autonomous_community

AUTONOMOUS_DISTRICT

 Translation missing: en.graphql.enums.province_type.values.autonomous_district

AUTONOMOUS_MUNICIPALITY

 Translation missing: en.graphql.enums.province_type.values.autonomous_municipality

AUTONOMOUS_PROVINCE

 Translation missing: en.graphql.enums.province_type.values.autonomous_province

AUTONOMOUS_REGION

 Translation missing: en.graphql.enums.province_type.values.autonomous_region

AUTONOMOUS_REPUBLIC

 Translation missing: en.graphql.enums.province_type.values.autonomous_republic

AUTONOMOUS_SECTOR

 Translation missing: en.graphql.enums.province_type.values.autonomous_sector

AUTONOMOUS_TERRITORIAL_UNIT

 Translation missing: en.graphql.enums.province_type.values.autonomous_territorial_unit

BOROUGH

 Translation missing: en.graphql.enums.province_type.values.borough

CANTON

 Translation missing: en.graphql.enums.province_type.values.canton

CAPITAL

 Translation missing: en.graphql.enums.province_type.values.capital

CAPITAL_CITY

 Translation missing: en.graphql.enums.province_type.values.capital_city

CAPITAL_DISTRICT

 Translation missing: en.graphql.enums.province_type.values.capital_district

CAPITAL_REGION

 Translation missing: en.graphql.enums.province_type.values.capital_region

CAPITAL_TERRITORY

 Translation missing: en.graphql.enums.province_type.values.capital_territory

CHAIN_OF_ISLANDS

 Translation missing: en.graphql.enums.province_type.values.chain_of_islands

CITY

 Translation missing: en.graphql.enums.province_type.values.city

CITY_CORPORATION

 Translation missing: en.graphql.enums.province_type.values.city_corporation

CITY_MUNICIPALITY

 Translation missing: en.graphql.enums.province_type.values.city_municipality

CITY_WITH_COUNTY_RIGHTS

 Translation missing: en.graphql.enums.province_type.values.city_with_county_rights

COMMUNE

 Translation missing: en.graphql.enums.province_type.values.commune

COUNCIL_AREA

 Translation missing: en.graphql.enums.province_type.values.council_area

COUNTRY

 Translation missing: en.graphql.enums.province_type.values.country

COUNTY

 Translation missing: en.graphql.enums.province_type.values.county

DECENTRALIZED_REGIONAL_ENTITY

 Translation missing: en.graphql.enums.province_type.values.decentralized_regional_entity

DEPARTMENT

 Translation missing: en.graphql.enums.province_type.values.department

DEPARTMENTS

 Translation missing: en.graphql.enums.province_type.values.departments

DEPENDENCY

 Translation missing: en.graphql.enums.province_type.values.dependency

DEVELOPMENT_REGION

 Translation missing: en.graphql.enums.province_type.values.development_region

DISTRICT

 Translation missing: en.graphql.enums.province_type.values.district

DISTRICTS_UNDER_REPUBLIC_ADMINISTRATION

 Translation missing: en.graphql.enums.province_type.values.districts_under_republic_administration

DISTRICT_MUNICIPALITY

 Translation missing: en.graphql.enums.province_type.values.district_municipality

DISTRICT_WITH_SPECIAL_STATUS

 Translation missing: en.graphql.enums.province_type.values.district_with_special_status

DIVISION

 Translation missing: en.graphql.enums.province_type.values.division

ECONOMIC_PREFECTURE

 Translation missing: en.graphql.enums.province_type.values.economic_prefecture

EMIRATE

 Translation missing: en.graphql.enums.province_type.values.emirate

ENTITY

 Translation missing: en.graphql.enums.province_type.values.entity

EUROPEAN_COLLECTIVITY

 Translation missing: en.graphql.enums.province_type.values.european_collectivity

FEDERAL_CAPITAL_TERRITORY

 Translation missing: en.graphql.enums.province_type.values.federal_capital_territory

FEDERAL_DEPENDENCY

 Translation missing: en.graphql.enums.province_type.values.federal_dependency

FEDERAL_DISTRICT

 Translation missing: en.graphql.enums.province_type.values.federal_district

FEDERAL_TERRITORY

 Translation missing: en.graphql.enums.province_type.values.federal_territory

FREE_MUNICIPAL_CONSORTIUM

 Translation missing: en.graphql.enums.province_type.values.free_municipal_consortium

GEOGRAPHICAL_ENTITY

 Translation missing: en.graphql.enums.province_type.values.geographical_entity

GEOGRAPHICAL_REGION

 Translation missing: en.graphql.enums.province_type.values.geographical_region

GEOGRAPHICAL_UNIT

 Translation missing: en.graphql.enums.province_type.values.geographical_unit

GOVERNORATE

 Translation missing: en.graphql.enums.province_type.values.governorate

GROUP_OF_ISLANDS

 Translation missing: en.graphql.enums.province_type.values.group_of_islands

INDIGENOUS_REGION

 Translation missing: en.graphql.enums.province_type.values.indigenous_region

ISLAND

 Translation missing: en.graphql.enums.province_type.values.island

ISLAND_COUNCIL

 Translation missing: en.graphql.enums.province_type.values.island_council

LOCAL_COUNCIL

 Translation missing: en.graphql.enums.province_type.values.local_council

LONDON_BOROUGH

 Translation missing: en.graphql.enums.province_type.values.london_borough

METROPOLITAN_ADMINISTRATION

 Translation missing: en.graphql.enums.province_type.values.metropolitan_administration

METROPOLITAN_CITY

 Translation missing: en.graphql.enums.province_type.values.metropolitan_city

METROPOLITAN_COLLECTIVITY_WITH_SPECIAL_STATUS

 Translation missing: en.graphql.enums.province_type.values.metropolitan_collectivity_with_special_status

METROPOLITAN_DEPARTMENT

 Translation missing: en.graphql.enums.province_type.values.metropolitan_department

METROPOLITAN_DISTRICT

 Translation missing: en.graphql.enums.province_type.values.metropolitan_district

METROPOLITAN_REGION

 Translation missing: en.graphql.enums.province_type.values.metropolitan_region

MUNICIPALITY

 Translation missing: en.graphql.enums.province_type.values.municipality

OBLAST

 Translation missing: en.graphql.enums.province_type.values.oblast

OUTLYING_AREA

 Translation missing: en.graphql.enums.province_type.values.outlying_area

OVERSEAS_COLLECTIVITY

 Translation missing: en.graphql.enums.province_type.values.overseas_collectivity

OVERSEAS_DEPARTMENTAL_COLLECTIVITY

 Translation missing: en.graphql.enums.province_type.values.overseas_departmental_collectivity

OVERSEAS_UNIQUE_TERRITORIAL_COLLECTIVITY

 Translation missing: en.graphql.enums.province_type.values.overseas_unique_territorial_collectivity

PAKISTAN_ADMINISTERED_AREA

 Translation missing: en.graphql.enums.province_type.values.pakistan_administered_area

PARISH

 Translation missing: en.graphql.enums.province_type.values.parish

POPULARATE

 Translation missing: en.graphql.enums.province_type.values.popularate

PREFECTURE

 Translation missing: en.graphql.enums.province_type.values.prefecture

PROVINCE

 Translation missing: en.graphql.enums.province_type.values.province

QUARTER

 Translation missing: en.graphql.enums.province_type.values.quarter

RAYON

 Translation missing: en.graphql.enums.province_type.values.rayon

REGION

 Translation missing: en.graphql.enums.province_type.values.region

REGIONAL_STATE

 Translation missing: en.graphql.enums.province_type.values.regional_state

REPUBLIC

 Translation missing: en.graphql.enums.province_type.values.republic

RURAL_MUNICIPALITY

 Translation missing: en.graphql.enums.province_type.values.rural_municipality

SELF_GOVERNED_PART

 Translation missing: en.graphql.enums.province_type.values.self_governed_part

SPECIAL_ADMINISTRATIVE_CITY

 Translation missing: en.graphql.enums.province_type.values.special_administrative_city

SPECIAL_ADMINISTRATIVE_REGION

 Translation missing: en.graphql.enums.province_type.values.special_administrative_region

SPECIAL_CITY

 Translation missing: en.graphql.enums.province_type.values.special_city

SPECIAL_ISLAND_AUTHORITY

 Translation missing: en.graphql.enums.province_type.values.special_island_authority

SPECIAL_MUNICIPALITY

 Translation missing: en.graphql.enums.province_type.values.special_municipality

SPECIAL_REGION

 Translation missing: en.graphql.enums.province_type.values.special_region

SPECIAL_SELF_GOVERNING_CITY

 Translation missing: en.graphql.enums.province_type.values.special_self_governing_city

SPECIAL_SELF_GOVERNING_PROVINCE

 Translation missing: en.graphql.enums.province_type.values.special_self_governing_province

STATE

 Translation missing: en.graphql.enums.province_type.values.state

STATE_CITY

 Translation missing: en.graphql.enums.province_type.values.state_city

TERRITORIAL_UNIT

 Translation missing: en.graphql.enums.province_type.values.territorial_unit

TERRITORY

 Translation missing: en.graphql.enums.province_type.values.territory

TOWN

 Translation missing: en.graphql.enums.province_type.values.town

TOWN_COUNCIL

 Translation missing: en.graphql.enums.province_type.values.town_council

TWO_TIER_COUNTY

 Translation missing: en.graphql.enums.province_type.values.two_tier_county

UNION_TERRITORY

 Translation missing: en.graphql.enums.province_type.values.union_territory

UNITARY_AUTHORITY

 Translation missing: en.graphql.enums.province_type.values.unitary_authority

UNKOWN

 Translation missing: en.graphql.enums.province_type.values.unkown

URBAN_COMMUNITY

 Translation missing: en.graphql.enums.province_type.values.urban_community

URBAN_MUNICIPALITY

 Translation missing: en.graphql.enums.province_type.values.urban_municipality

VOIVODESHIP

 Translation missing: en.graphql.enums.province_type.values.voivodeship

WARD

 Translation missing: en.graphql.enums.province_type.values.ward

ZONE

 Translation missing: en.graphql.enums.province_type.values.zone
Example
"ADMINISTRATION"
Enums

RecordStatus

Description

Record status of charge eg: (processed)

Values
Enum Value Description

PROCESSED

 Charge processed

RECORDED

 Charge recorded
Example
"PROCESSED"
Enums

RefundStatus

Description

Status of refund eg: (pending)

Values
Enum Value Description

FAILED

 Refund failed

PENDING

 Refund pending

SUCCEEDED

 Refund succeeded
Example
"FAILED"
Enums

ScheduledNotificationStatus

Description

The status of a scheduled notification.

Values
Enum Value Description

DELETED

 Deleted

ENQUEUED

 Enqueued

SCHEDULED

 Scheduled
Example
"DELETED"
Enums

SortDirection

Description

The sort direction.

Values
Enum Value Description

ASC

 Sort in ascending order.

DESC

 Sort in descending order.
Example
"ASC"
Enums

SubscriptionAnchorType

Values
Enum Value Description

FLEXIBLE

MONTHDAY

WEEKDAY

YEARDAY
Example
"FLEXIBLE"
Enums

SubscriptionBacklogInterval

Description

Translation missing: en.graphql.enums.subscription_backlog_interval.description

Values
Enum Value Description

CYCLE

 Translation missing: en.graphql.enums.subscription_backlog_interval.values.cycle

DAY

 Translation missing: en.graphql.enums.subscription_backlog_interval.values.day

HOUR

 Translation missing: en.graphql.enums.subscription_backlog_interval.values.hour

MINUTE

 Translation missing: en.graphql.enums.subscription_backlog_interval.values.minute

MONTH

 Translation missing: en.graphql.enums.subscription_backlog_interval.values.month

WEEK

 Translation missing: en.graphql.enums.subscription_backlog_interval.values.week

YEAR

 Translation missing: en.graphql.enums.subscription_backlog_interval.values.year
Example
"CYCLE"
Enums

SubscriptionBasePricePolicy

Values
Enum Value Description

CUSTOM

FIXED

ON_BILLING_ATTEMPT

ON_SUBSCRIPTION_CREATE
Example
"CUSTOM"
Enums

SubscriptionDeliveryBehaviourType

Values
Enum Value Description

FIXED

FLEXIBLE
Example
"FIXED"
Enums

SubscriptionDeliveryPreAnchorBehaviourType

Values
Enum Value Description

ASAP

NEXT
Example
"ASAP"
Enums

SubscriptionEngine

Description

Translation missing: en.graphql.enums.subscription_engine_type.description

Values
Enum Value Description

NOOP

 Translation missing: en.graphql.enums.subscription_engine_type.values.noop

SHOPIFY

 Translation missing: en.graphql.enums.subscription_engine_type.values.shopify

SUBMARINE

 Translation missing: en.graphql.enums.subscription_engine_type.values.submarine
Example
"NOOP"
Enums

SubscriptionEventAction

Description

Translation missing: en.graphql.enums.subscription_event_action.description

Values
Enum Value Description

ARCHIVE

 Translation missing: en.graphql.enums.subscription_event_action.values.archive

CANCEL

 Translation missing: en.graphql.enums.subscription_event_action.values.cancel

CREATE

 Translation missing: en.graphql.enums.subscription_event_action.values.create

DELETE

 Translation missing: en.graphql.enums.subscription_event_action.values.delete

PAUSE

 Translation missing: en.graphql.enums.subscription_event_action.values.pause

RESTORE

 Translation missing: en.graphql.enums.subscription_event_action.values.restore

RESUME

 Translation missing: en.graphql.enums.subscription_event_action.values.resume

SKIP

 Translation missing: en.graphql.enums.subscription_event_action.values.skip

UNSKIP

 Translation missing: en.graphql.enums.subscription_event_action.values.unskip

UPDATE

 Translation missing: en.graphql.enums.subscription_event_action.values.update
Example
"ARCHIVE"
Enums

SubscriptionInterval

Description

Translation missing: en.graphql.enums.subscription_interval.description

Values
Enum Value Description

DAY

 Translation missing: en.graphql.enums.subscription_interval.values.day

HOUR

 Translation missing: en.graphql.enums.subscription_interval.values.hour

MINUTE

 Translation missing: en.graphql.enums.subscription_interval.values.minute

MONTH

 Translation missing: en.graphql.enums.subscription_interval.values.month

WEEK

 Translation missing: en.graphql.enums.subscription_interval.values.week

YEAR

 Translation missing: en.graphql.enums.subscription_interval.values.year
Example
"DAY"
Enums

SubscriptionInventoryDecrementPolicy

Values
Enum Value Description

NONE

ON_ORDER_CREATION

ON_ORDER_FULFILMENT
Example
"NONE"
Enums

SubscriptionInventoryOutOfStockPolicy

Values
Enum Value Description

PAUSE_SUBSCRIPTION

REPLACE_ITEM

SKIP_ITEM

SKIP_ORDER
Example
"PAUSE_SUBSCRIPTION"
Enums

SubscriptionOffsetInterval

Values
Enum Value Description

DAY

HOUR
Example
"DAY"
Enums

SubscriptionOffsetType

Values
Enum Value Description

BUSINESS

CALENDAR
Example
"BUSINESS"
Enums

SubscriptionOrderLineType

Description

Translation missing: en.graphql.enums.subscription_order_line_type.description

Values
Enum Value Description

ONE_OFF

 Translation missing: en.graphql.enums.subscription_order_line_type.values.one_off

RECURRING

 Translation missing: en.graphql.enums.subscription_order_line_type.values.recurring
Example
"ONE_OFF"
Enums

SubscriptionOrderPaymentStatus

Description

Translation missing: en.graphql.enums.subscription_order_payment_status.description

Values
Enum Value Description

FAILED

 Translation missing: en.graphql.enums.subscription_order_payment_status.values.failed

FAILING

 Translation missing: en.graphql.enums.subscription_order_payment_status.values.failing

FINALISING

 Translation missing: en.graphql.enums.subscription_order_payment_status.values.finalising

PENDING

 Translation missing: en.graphql.enums.subscription_order_payment_status.values.pending

SUBMITTED

 Translation missing: en.graphql.enums.subscription_order_payment_status.values.submitted

SUCCEEDED

 Translation missing: en.graphql.enums.subscription_order_payment_status.values.succeeded
Example
"FAILED"
Enums

SubscriptionOrderSortKey

Description

The key used to sort subscription orders.

Values
Enum Value Description

BILL_AT

CYCLE_INDEX

 Sort by the subscription orders cycle index.

ID

 Sort by the subscription orders ID.

IDENTIFIER

PROCESSED_AT
Example
"BILL_AT"
Enums

SubscriptionOrderStatus

Description

Translation missing: en.graphql.enums.subscription_order_status.description

Values
Enum Value Description

CANCELLED

 Translation missing: en.graphql.enums.subscription_order_status.values.cancelled

PENDING

 Translation missing: en.graphql.enums.subscription_order_status.values.pending

PROCESSED

 Translation missing: en.graphql.enums.subscription_order_status.values.processed

PROCESSING

 Translation missing: en.graphql.enums.subscription_order_status.values.processing

SCHEDULED

 Translation missing: en.graphql.enums.subscription_order_status.values.scheduled

SCHEDULING

 Translation missing: en.graphql.enums.subscription_order_status.values.scheduling
Example
"CANCELLED"
Enums

SubscriptionPlanGroupSortKey

Description

The key used to sort subscription plan groups.

Values
Enum Value Description

CREATED_AT

 Sort by the subscription plan groups creation date.

ID

 Sort by the subscription plan groups ID.

SUBSCRIPTIONS_COUNT
Example
"CREATED_AT"
Enums

SubscriptionPlanGroupStatus

Description

Translation missing: en.graphql.enums.subscription_plan_group_status.description

Values
Enum Value Description

ACTIVE

 Translation missing: en.graphql.enums.subscription_plan_group_status.values.active

DELETED

 Translation missing: en.graphql.enums.subscription_plan_group_status.values.deleted

INACTIVE

 Translation missing: en.graphql.enums.subscription_plan_group_status.values.inactive
Example
"ACTIVE"
Enums

SubscriptionPlanStatus

Description

Translation missing: en.graphql.enums.subscription_plan_status.description

Values
Enum Value Description

ACTIVE

 Translation missing: en.graphql.enums.subscription_plan_status.values.active

DELETED

 Translation missing: en.graphql.enums.subscription_plan_status.values.deleted

INACTIVE

 Translation missing: en.graphql.enums.subscription_plan_status.values.inactive
Example
"ACTIVE"
Enums

SubscriptionPriceDiscountType

Values
Enum Value Description

FIXED_AMOUNT

PERCENTAGE
Example
"FIXED_AMOUNT"
Enums

SubscriptionPriceDiscountValueCapType

Values
Enum Value Description

INDIVIDUAL_ITEM

SUBSCRIPTION_ORDER
Example
"INDIVIDUAL_ITEM"
Enums

SubscriptionProductGroupItemSourceStatus

Description

Status of subscription product group item source eg: (active, inactive)

Values
Enum Value Description

ACTIVE

 Subscription product group item source is active

INACTIVE

 Subscription product group item source is inactive
Example
"ACTIVE"
Enums

SubscriptionProductGroupItemStatus

Description

Status of subscription product group item eg: (active, inactive)

Values
Enum Value Description

ACTIVE

 Subscription product group item is active

INACTIVE

 Subscription product group item is inactive
Example
"ACTIVE"
Enums

SubscriptionRetryInterval

Description

Translation missing: en.graphql.enums.subscription_retry_interval.description

Values
Enum Value Description

DAY

 Translation missing: en.graphql.enums.subscription_retry_interval.values.day

HOUR

 Translation missing: en.graphql.enums.subscription_retry_interval.values.hour

MINUTE

 Translation missing: en.graphql.enums.subscription_retry_interval.values.minute
Example
"DAY"
Enums

SubscriptionSortKey

Description

The key used to sort subscriptions.

Values
Enum Value Description

CREATED_AT

 Sort by the subscriptions creation date.

ID

 Sort by the subscriptions ID.

IDENTIFIER

PROCESSED_SUBSCRIPTION_ORDERS_COUNT
Example
"CREATED_AT"
Enums

SubscriptionSource

Description

Translation missing: en.graphql.enums.subscription_source.description

Values
Enum Value Description

API

 Translation missing: en.graphql.enums.subscription_source.values.api

ORDER

 Translation missing: en.graphql.enums.subscription_source.values.order
Example
"API"
Enums

SubscriptionStatus

Description

Translation missing: en.graphql.enums.subscription_status.description

Values
Enum Value Description

ACTIVE

 Translation missing: en.graphql.enums.subscription_status.values.active

CANCELLED

 Translation missing: en.graphql.enums.subscription_status.values.cancelled

EXPIRED

 Translation missing: en.graphql.enums.subscription_status.values.expired

FAILED

 Translation missing: en.graphql.enums.subscription_status.values.failed

PAUSED

 Translation missing: en.graphql.enums.subscription_status.values.paused

STALE

 Translation missing: en.graphql.enums.subscription_status.values.stale
Example
"ACTIVE"
Enums

TaxBehaviour

Description

The tax behaviour of a Submarine resource.

Values
Enum Value Description

EXCLUSIVE

 Prices are shown exclusive of tax.

INCLUSIVE

 Prices are shown inclusive of tax.
Example
"EXCLUSIVE"
Enums

TimeOffsetDirection

Description

The direction to offset in.

Values
Enum Value Description

BEFORE

 Before
Example
"BEFORE"
Enums

TimeOffsetUnit

Description

The unit of time to offset by.

Values
Enum Value Description

DAYS

 Days

HOURS

 Hours

MINUTES

 Minutes
Example
"DAYS"
Enums

TokenStatus

Description

token status

Values
Enum Value Description

ACTIVE

 active

INACTIVE

 inactive
Example
"ACTIVE"
Enums

TokenTarget

Description

token target

Values
Enum Value Description

ANY

 any

PAYMENTS

 payments

PRICING

 pricing
Example
"ANY"
Enums

WebhookStatus

Description

Status of webhook

Values
Enum Value Description

ACTIVE

 Webhook is active

INACTIVE

 Webhook is inactive
Example
"ACTIVE"
Enums

WebhookTopic

Description

A Webhook's topic

Values
Enum Value Description

CAMPAIGN_ORDER_CANCELLED

CAMPAIGN_ORDER_CREATED

CAMPAIGN_ORDER_FULFILLED

CAMPAIGN_ORDER_GROUP_DUE_DATE_UPDATED

CAMPAIGN_UPCOMING_CHARGE

CHARGE_FAILED

CHARGE_SUCCEEDED

CROWDFUNDING_CAMPAIGN_COMPLETED

CROWDFUNDING_CAMPAIGN_ENDED

CROWDFUNDING_CAMPAIGN_LAUNCHED

PAYMENT_METHOD_EXPIRING

PRESALE_CAMPAIGN_COMPLETED

PRESALE_CAMPAIGN_ENDED

PRESALE_CAMPAIGN_LAUNCHED

REFUND_SUCCEEDED

SUBSCRIPTION_CREATED
Example
"CAMPAIGN_ORDER_CANCELLED"

Input Objects

AccessTokenCreateInput

Description

Input for creating an access token.

Fields
Input Field Description
tokenMode - AccessTokenMode! The token's mode
tokenType - AccessTokenType! Type of token
Example
{"tokenMode": "STATEFUL", "tokenType": "CHANNEL"}
Input Objects

AddressInput

Description

Translation missing: en.graphql.inputs.address_input.description

Fields
Input Field Description
city - String Translation missing: en.graphql.inputs.address_input.arguments.city
country - CountryInput! Translation missing: en.graphql.inputs.address_input.arguments.country
firstName - String Translation missing: en.graphql.inputs.address_input.arguments.first_name
lastName - String Translation missing: en.graphql.inputs.address_input.arguments.last_name
phone - String Translation missing: en.graphql.inputs.address_input.arguments.phone
postcode - String Translation missing: en.graphql.inputs.address_input.arguments.postcode
province - ProvinceInput Translation missing: en.graphql.inputs.address_input.arguments.province
street1 - String Translation missing: en.graphql.inputs.address_input.arguments.street1
street2 - String Translation missing: en.graphql.inputs.address_input.arguments.street2
Example
{
  "city": "abc123",
  "country": CountryInput,
  "firstName": "abc123",
  "lastName": "abc123",
  "phone": "abc123",
  "postcode": "abc123",
  "province": ProvinceInput,
  "street1": "xyz789",
  "street2": "xyz789"
}
Input Objects

CampaignDepositInput

Description

Input for configuring a campaign deposit.

Fields
Input Field Description
type - CampaignDepositType!
value - Float!
Example
{"type": "PERCENTAGE", "value": 123.45}
Input Objects

CampaignOrderCancelInput

Description

Specifies the input fields required to cancel a campaign order.

Fields
Input Field Description
id - GlobalID! ID of the campaign order to cancel.
Example
{"id": GlobalID}
Input Objects

CampaignOrderCreateInput

Description

Specifies the input fields required to create a campaign order.

Fields
Input Field Description
campaignId - GlobalID! The campaign order's campaign ID.
campaignType - CampaignType! The campaign order's campaign type.
depositType - DepositType The type of deposit on the campaign order's campaign.
depositValue - Float The value of deposit on the campaign order's campaign
externalLineItemId - String! The ID of the campaign order line item
id - GlobalID ID of the campaign order to create.
paymentMethodId - GlobalID The campaign order's payment method ID.
productId - GlobalID! The campaign order's product ID.
productVariantId - GlobalID! The campaign order's product variant ID.
quantity - Int! The campaign order's quantity.
Example
{
  "campaignId": GlobalID,
  "campaignType": "CROWDFUNDING",
  "depositType": "PERCENTAGE",
  "depositValue": 987.65,
  "externalLineItemId": "abc123",
  "id": GlobalID,
  "paymentMethodId": GlobalID,
  "productId": GlobalID,
  "productVariantId": GlobalID,
  "quantity": 123
}
Input Objects

CampaignOrderDecreaseQuantityInput

Description

Specifies the input fields required to update a campaign order.

Fields
Input Field Description
id - GlobalID! ID of the campaign order to update.
quantity - Int The desired new quantity of the campaign order
Example
{"id": GlobalID, "quantity": 987}
Input Objects

CampaignOrderGroupCancelInput

Description

Specifies the input fields required to cancel a campaign order group.

Fields
Input Field Description
id - GlobalID! ID of the campaign order group to cancel.
Example
{"id": GlobalID}
Input Objects

CampaignOrderGroupCreateInput

Description

Specifies the input fields required to create a campaign order group.

Fields
Input Field Description
campaignOrders - [CampaignOrderCreateInput!]! The products which are included in the campaign
customerId - GlobalID! The customer who owns this group
externalId - String! The campaign order group's external ID.
id - GlobalID ID of the campaign order to create.
identifier - String The identifier for the group.
paymentMethodId - GlobalID The campaign order's payment method ID.
Example
{
  "campaignOrders": [CampaignOrderCreateInput],
  "customerId": GlobalID,
  "externalId": "xyz789",
  "id": GlobalID,
  "identifier": "xyz789",
  "paymentMethodId": GlobalID
}
Input Objects

CampaignOrderGroupRetryPaymentInput

Description

Specifies the input fields required to retry payment for a campaign order group.

Fields
Input Field Description
id - GlobalID! ID of the campaign order group to retry paying.
Example
{"id": GlobalID}
Input Objects

CampaignOrderRetryFulfilmentInput

Description

Specifies the input fields required to retry fulfilling a campaign order.

Fields
Input Field Description
id - GlobalID! ID of the campaign order to retry fulfilling.
Example
{"id": GlobalID}
Input Objects

CampaignOrderRetryPaymentInput

Description

Specifies the input fields required to retry payment for a campaign order.

Fields
Input Field Description
id - GlobalID! ID of the campaign order to retry paying.
Example
{"id": GlobalID}
Input Objects

CardCreateInput

Description

Specifies the input fields required to create a card.

Fields
Input Field Description
brand - CardBrand! The card brand.
expiry - CardExpiryInput! The card expiry.
externalId - String The (optional) external ID of the card.
last4 - String! The last four digits of the card number.
Example
{
  "brand": "AMEX",
  "expiry": CardExpiryInput,
  "externalId": "xyz789",
  "last4": "xyz789"
}
Input Objects

CardExpiryInput

Description

Expiry details of the card.

Fields
Input Field Description
month - Int! Expiry month (as an integer, starting at 1 for Janaury).
year - Int! Expiry year (as a four-digit integer, e.g. 2023).
Example
{"month": 123, "year": 987}
Input Objects

ChannelConfigSetInput

Description

Input for configuring a channel's settings.

Fields
Input Field Description
config - PlatformConfigSetInput! The Submarine configuration.
id - GlobalID! The channel ID.
Example
{
  "config": PlatformConfigSetInput,
  "id": GlobalID
}
Input Objects

ChannelCreateInput

Description

Input for creating a channel.

Fields
Input Field Description
channelType - ChannelType! The channel type.
externalId - String! The channel's external ID.
identifier - String! The channel's identifier
name - String! The channel's name
timezone - Timezone! The channel's timezone
Example
{
  "channelType": "SHOPIFY",
  "externalId": "abc123",
  "identifier": "abc123",
  "name": "abc123",
  "timezone": Timezone
}
Input Objects

ChannelUpdateInput

Description

Specifies the input fields required to update a channel.

Fields
Input Field Description
externalId - String The channel's external ID.
id - GlobalID! The ID of the channel to update.
identifier - String The channel's identifier
name - String The channel's name
status - ChannelStatus The channel's status.
Example
{
  "externalId": "abc123",
  "id": GlobalID,
  "identifier": "xyz789",
  "name": "xyz789",
  "status": "ACTIVE"
}
Input Objects

ChargeCaptureInput

Description

The input required to capture a charge

Fields
Input Field Description
amount - MoneyInput The amount to be charged. If blank, the balance owing will be charged.
description - String The description of the charge.
externalId - String The external ID of the charge.
metadata - MetadataInput Unstructured key/value pairs.
paymentIntentId - GlobalID! The payment intent ID.
source - ChargeSource The source of the charge.
Example
{
  "amount": MoneyInput,
  "description": "xyz789",
  "externalId": "abc123",
  "metadata": MetadataInput,
  "paymentIntentId": GlobalID,
  "source": "SHOPIFY"
}
Input Objects

ChargeRecordInput

Description

The input required to record a charge

Fields
Input Field Description
amount - MoneyInput! The amount to be charged.
chargeType - ChargeType! The type of charge to record.
description - String The description of the charge.
externalId - String The external ID of the charge.
metadata - MetadataInput Unstructured key/value pairs.
paymentIntentId - GlobalID The payment intent ID.
source - ChargeSource The source of the charge.
Example
{
  "amount": MoneyInput,
  "chargeType": "AUTHORISE",
  "description": "abc123",
  "externalId": "xyz789",
  "metadata": MetadataInput,
  "paymentIntentId": GlobalID,
  "source": "SHOPIFY"
}
Input Objects

CountryInput

Description

Translation missing: en.graphql.inputs.country_input.description

Fields
Input Field Description
code - CountryCode! Translation missing: en.graphql.inputs.country_input.arguments.code
Example
{"code": "AC"}
Input Objects

CrowdfundingCampaignAddProductVariantsInput

Description

Input for adding product variants to a crowdfunding campaign.

Fields
Input Field Description
id - GlobalID The campaigns's ID.
productVariantIds - [SharedGlobalID!]! The product variants to be added to the campaign
Example
{
  "id": GlobalID,
  "productVariantIds": [SharedGlobalID]
}
Input Objects

CrowdfundingCampaignAddProductsInput

Description

Input for adding products to a crowdfunding campaign.

Fields
Input Field Description
id - GlobalID The campaigns's ID.
productIds - [SharedGlobalID!] The products that are included in the campaign
Example
{
  "id": GlobalID,
  "productIds": [SharedGlobalID]
}
Input Objects

CrowdfundingCampaignApplyBulkInventoryInput

Description

Specifies the input fields required to apply bulk inventory to a crowdfunding campaign.

Fields
Input Field Description
campaignId - GlobalID! The crowdfunding campaign ID.
inventoryApplications - [CrowdfundingCampaignApplyInventoryBaseInput!]! The campaign inventory items and quantities which should be applied
Example
{
  "campaignId": GlobalID,
  "inventoryApplications": [
    CrowdfundingCampaignApplyInventoryBaseInput
  ]
}
Input Objects

CrowdfundingCampaignApplyInventoryBaseInput

Description

Specifies the base input fields required to apply inventory to a crowdfunding campaign.

Fields
Input Field Description
campaignInventoryItemId - GlobalID! The campaign inventory item for which inventory is being applied
quantityReceived - Int! The number of units available to be allocated
Example
{
  "campaignInventoryItemId": GlobalID,
  "quantityReceived": 987
}
Input Objects

CrowdfundingCampaignApplyInventoryInput

Description

Specifies the input fields required to apply inventory to a crowdfunding campaign.

Fields
Input Field Description
campaignId - GlobalID! The crowdfunding campaign ID.
campaignInventoryItemId - GlobalID! The campaign inventory item for which inventory is being applied
quantityReceived - PositiveInteger! The number of units available to be allocated
Example
{
  "campaignId": GlobalID,
  "campaignInventoryItemId": GlobalID,
  "quantityReceived": PositiveInteger
}
Input Objects

CrowdfundingCampaignArchiveInput

Description

Specifies the input fields required to archive a crowdfunding campaign.

Fields
Input Field Description
id - GlobalID! ID of the crowdfunding campaign to archive.
Example
{"id": GlobalID}
Input Objects

CrowdfundingCampaignCancelInput

Description

Specifies the input fields required to cancel a crowdfunding campaign.

Fields
Input Field Description
id - GlobalID! ID of the crowdfunding campaign order to cancel.
Example
{"id": GlobalID}
Input Objects

CrowdfundingCampaignCreateInput

Description

Input for creating a crowdfunding campaign.

Fields
Input Field Description
description - String The campaign description
endAt - ISO8601DateTime! The date the crowdfunding campaign will end
fulfilAt - ISO8601DateTime The date the crowdfunding campaign will be fulfilled
goal - CrowdfundingGoalInput! The campaign's goal.
gracePeriodHours - Int! The number of hours a customer has to rectify a failed crowdfunding campaign payment before their campaign order is cancelled.
launchAt - ISO8601DateTime! The date the crowdfunding campaign will be launched
limit - Int The maximum number of units of the linked products that can be sold
name - String The name of the campaign
productIds - [SharedGlobalID!] The products that are included in the campaign
productVariantIds - [SharedGlobalID!] The product variants that are included in the campaign
reference - String! The campaign reference
Example
{
  "description": "xyz789",
  "endAt": ISO8601DateTime,
  "fulfilAt": ISO8601DateTime,
  "goal": CrowdfundingGoalInput,
  "gracePeriodHours": 987,
  "launchAt": ISO8601DateTime,
  "limit": 123,
  "name": "abc123",
  "productIds": [SharedGlobalID],
  "productVariantIds": [SharedGlobalID],
  "reference": "abc123"
}
Input Objects

CrowdfundingCampaignDeleteInput

Description

Specifies the input fields required to delete a crowdfunding campaign.

Fields
Input Field Description
id - GlobalID! ID of the crowdfunding campaign order to delete.
Example
{"id": GlobalID}
Input Objects

CrowdfundingCampaignEndInput

Description

Specifies the input fields required to end a crowdfunding campaign.

Fields
Input Field Description
id - GlobalID! ID of the crowdfunding campaign order to end.
Example
{"id": GlobalID}
Input Objects

CrowdfundingCampaignFulfilInput

Description

Specifies the input fields required to fulfil a crowdfunding campaign.

Fields
Input Field Description
id - GlobalID! ID of the crowdfunding campaign to fulfil.
Example
{"id": GlobalID}
Input Objects

CrowdfundingCampaignLaunchInput

Description

Specifies the input fields required to launch a crowdfunding campaign.

Fields
Input Field Description
id - GlobalID! ID of the crowdfunding campaign order to launch.
Example
{"id": GlobalID}
Input Objects

CrowdfundingCampaignRemoveProductVariantsInput

Description

Input for removing product variants from a crowdfunding campaign.

Fields
Input Field Description
id - GlobalID The campaigns's ID.
productVariantIds - [SharedGlobalID!] The product variants to be removed from the campaign
Example
{
  "id": GlobalID,
  "productVariantIds": [SharedGlobalID]
}
Input Objects

CrowdfundingCampaignRemoveProductsInput

Description

Input for removing products from a crowdfunding campaign.

Fields
Input Field Description
id - GlobalID The campaigns's ID.
productIds - [SharedGlobalID!] The products to be removed from the campaign
Example
{
  "id": GlobalID,
  "productIds": [SharedGlobalID]
}
Input Objects

CrowdfundingCampaignUnarchiveInput

Description

Specifies the input fields required to unarchive a crowdfunding campaign.

Fields
Input Field Description
id - GlobalID! ID of the crowdfunding campaign to unarchive.
Example
{"id": GlobalID}
Input Objects

CrowdfundingCampaignUpdateInput

Description

Input for updating a crowdfunding campaign.

Fields
Input Field Description
description - String The campaign description
endAt - ISO8601DateTime The date the crowdfunding campaign will end
fulfilAt - ISO8601DateTime The date the crowdfunding campaign will be fulfilled
goal - CrowdfundingGoalInput The campaign's goal.
gracePeriodHours - Int The number of hours a customer has to rectify a failed crowdfunding campaign payment before their campaign order is cancelled.
id - GlobalID! The campaign's ID.
launchAt - ISO8601DateTime The date the crowdfunding campaign will be launched
limit - Int The maximum number of units of the linked products that can be sold
name - String The name of the campaign
productIds - [SharedGlobalID!] The products that are included in the campaign
productVariantIds - [SharedGlobalID!] The product variants that are included in the campaign
reference - String The campaign reference
Example
{
  "description": "abc123",
  "endAt": ISO8601DateTime,
  "fulfilAt": ISO8601DateTime,
  "goal": CrowdfundingGoalInput,
  "gracePeriodHours": 987,
  "id": GlobalID,
  "launchAt": ISO8601DateTime,
  "limit": 987,
  "name": "xyz789",
  "productIds": [SharedGlobalID],
  "productVariantIds": [SharedGlobalID],
  "reference": "abc123"
}
Input Objects

CrowdfundingGoalInput

Description

Specifies the input fields required to create a generic crowdfunding campaign goal.

Fields
Input Field Description
goalTotalUnits - Int The campaign's total active reserved items goal.
goalTotalValue - MoneyInput The campaign's total value goal.
goalType - CrowdfundingGoalType! The campaign goal type.
Example
{
  "goalTotalUnits": 987,
  "goalTotalValue": MoneyInput,
  "goalType": "TOTAL_UNITS"
}
Input Objects

CustomerCreateInput

Description

Translation missing: en.graphql.inputs.customer_create_input.description

Fields
Input Field Description
email - Email Translation missing: en.graphql.inputs.customer_create_input.arguments.email
externalId - ID Translation missing: en.graphql.inputs.customer_create_input.arguments.external_id
firstName - String Translation missing: en.graphql.inputs.customer_create_input.arguments.first_name
id - GlobalID Translation missing: en.graphql.inputs.customer_create_input.arguments.id
lastName - String Translation missing: en.graphql.inputs.customer_create_input.arguments.last_name
phone - PhoneNumber Translation missing: en.graphql.inputs.customer_create_input.arguments.phone
taxable - Boolean Translation missing: en.graphql.inputs.customer_create_input.arguments.taxable. Default = true
Example
{
  "email": Email,
  "externalId": "4",
  "firstName": "abc123",
  "id": GlobalID,
  "lastName": "xyz789",
  "phone": "+17895551234",
  "taxable": false
}
Input Objects

CustomerUpdateInput

Description

Translation missing: en.graphql.inputs.customer_update_input.description

Fields
Input Field Description
email - Email Translation missing: en.graphql.inputs.customer_update_input.arguments.email
externalId - ID Translation missing: en.graphql.inputs.customer_update_input.arguments.external_id
firstName - String Translation missing: en.graphql.inputs.customer_update_input.arguments.first_name
id - GlobalID! Translation missing: en.graphql.inputs.customer_update_input.arguments.id
lastName - String Translation missing: en.graphql.inputs.customer_update_input.arguments.last_name
phone - PhoneNumber Translation missing: en.graphql.inputs.customer_update_input.arguments.phone
taxable - Boolean Translation missing: en.graphql.inputs.customer_update_input.arguments.taxable
Example
{
  "email": Email,
  "externalId": 4,
  "firstName": "xyz789",
  "id": GlobalID,
  "lastName": "abc123",
  "phone": "+17895551234",
  "taxable": false
}
Input Objects

CustomerUpsertInput

Description

Translation missing: en.graphql.inputs.customer_upsert_input.description

Fields
Input Field Description
email - Email Translation missing: en.graphql.inputs.customer_upsert_input.arguments.email
externalId - ID Translation missing: en.graphql.inputs.customer_upsert_input.arguments.external_id
firstName - String Translation missing: en.graphql.inputs.customer_upsert_input.arguments.first_name
id - GlobalID Translation missing: en.graphql.inputs.customer_upsert_input.arguments.id
lastName - String Translation missing: en.graphql.inputs.customer_upsert_input.arguments.last_name
phone - PhoneNumber Translation missing: en.graphql.inputs.customer_upsert_input.arguments.phone
taxable - Boolean Translation missing: en.graphql.inputs.customer_upsert_input.arguments.taxable
Example
{
  "email": Email,
  "externalId": 4,
  "firstName": "abc123",
  "id": GlobalID,
  "lastName": "xyz789",
  "phone": "+17895551234",
  "taxable": true
}
Input Objects

DeliveryProfileCreateInput

Description

Translation missing: en.graphql.inputs.delivery_profile_create_input.description

Fields
Input Field Description
deliveryZones - [DeliveryProfileZoneInput!]! Translation missing: en.graphql.inputs.delivery_profile_create_input.arguments.delivery_zones
externalId - ID Translation missing: en.graphql.inputs.delivery_profile_create_input.arguments.external_id
id - GlobalID Translation missing: en.graphql.inputs.delivery_profile_create_input.arguments.id
name - String! Translation missing: en.graphql.inputs.delivery_profile_create_input.arguments.name
restOfWorld - Boolean Translation missing: en.graphql.inputs.delivery_profile_create_input.arguments.rest_of_world. Default = false
Example
{
  "deliveryZones": [DeliveryProfileZoneInput],
  "externalId": 4,
  "id": GlobalID,
  "name": "xyz789",
  "restOfWorld": true
}
Input Objects

DeliveryProfileDeleteInput

Description

Translation missing: en.graphql.inputs.delivery_profile_delete_input.description

Fields
Input Field Description
id - GlobalID! Translation missing: en.graphql.inputs.delivery_profile_delete_input.arguments.id
Example
{"id": GlobalID}
Input Objects

DeliveryProfileUpdateInput

Description

Translation missing: en.graphql.inputs.delivery_profile_update_input.description

Fields
Input Field Description
deliveryZones - [DeliveryProfileZoneInput!] Translation missing: en.graphql.inputs.delivery_profile_update_input.arguments.delivery_zones
externalId - ID Translation missing: en.graphql.inputs.delivery_profile_update_input.arguments.external_id
id - GlobalID! Translation missing: en.graphql.inputs.delivery_profile_update_input.arguments.id
name - String Translation missing: en.graphql.inputs.delivery_profile_update_input.arguments.name
restOfWorld - Boolean Translation missing: en.graphql.inputs.delivery_profile_update_input.arguments.rest_of_world
Example
{
  "deliveryZones": [DeliveryProfileZoneInput],
  "externalId": 4,
  "id": GlobalID,
  "name": "abc123",
  "restOfWorld": false
}
Input Objects

DeliveryProfileZoneInput

Description

Translation missing: en.graphql.inputs.delivery_profile_zone_input.description

Fields
Input Field Description
countryCode - CountryCode! Translation missing: en.graphql.inputs.delivery_profile_zone_input.arguments.country_code
provinceCodes - [ProvinceCode!] Translation missing: en.graphql.inputs.delivery_profile_zone_input.arguments.province_codes
Example
{"countryCode": "AC", "provinceCodes": [ProvinceCode]}
Input Objects

ExternalTokenCreateInput

Description

external token create input

Fields
Input Field Description
primary - Boolean primary. Default = false
target - TokenTarget target. Default = ANY
token - String! token
Example
{
  "primary": false,
  "target": "ANY",
  "token": "xyz789"
}
Input Objects

ExternalTokenRevokeInput

Description

external token revoke input

Fields
Input Field Description
id - GlobalID! id
Example
{"id": GlobalID}
Input Objects

LineItemCreateInput

Description

Input for creating a line item.

Fields
Input Field Description
externalId - String! The line item's ID.
productId - GlobalID! The line item's product ID.
productVariantId - GlobalID! The line item's product variant ID.
Example
{
  "externalId": "xyz789",
  "productId": GlobalID,
  "productVariantId": GlobalID
}
Input Objects

LineItemUpdateInput

Description

Input for updating a line item.

Fields
Input Field Description
externalId - String! The line item's ID.
productId - GlobalID The line item's product ID.
productVariantId - GlobalID The line item's product variant ID.
Example
{
  "externalId": "abc123",
  "productId": GlobalID,
  "productVariantId": GlobalID
}
Input Objects

LineItemUpsertInput

Description

Input for upserting a line item.

Fields
Input Field Description
externalId - String! The line item's ID.
productId - GlobalID! The line item's product ID.
productVariantId - GlobalID! The line item's product variant ID.
Example
{
  "externalId": "xyz789",
  "productId": GlobalID,
  "productVariantId": GlobalID
}
Input Objects

MailingAddressInput

Description

An organisation's mailing address.

Fields
Input Field Description
address1 - String! Line 1 of mailing address.
address2 - String Line 2 of mailing address.
city - String! The name of the city, district, village, or town.
company - String The name of the organisation's company.
countryCode - CountryCode! The two-letter code for the country of the address.
phone - String Phone number
province - String The region of the address
provinceCode - String The code for the region of the address
zip - String! The zip or postal code of the address.
Example
{
  "address1": "xyz789",
  "address2": "abc123",
  "city": "xyz789",
  "company": "abc123",
  "countryCode": "AC",
  "phone": "xyz789",
  "province": "abc123",
  "provinceCode": "abc123",
  "zip": "abc123"
}
Input Objects

MoneyInput

Description

A money object.

Fields
Input Field Description
amount - String! The money object's amount.
currency - CurrencyCode! The money object's currency code.
Example
{"amount": "abc123", "currency": "AED"}
Input Objects

NotificationScheduleCreateInput

Description

Input for creating a notification schedule.

Fields
Input Field Description
anchor - ISO8601DateTime! The schedule's anchor date.
customerId - String! The schedule's customer ID.
deliveryMechanism - NotificationDeliveryMechanism! The delivery mechanism.
event - String! The event to notify.
payload - JSON! The payload to deliver.
schedule - [TimeOffsetInput!]! The schedule.
Example
{
  "anchor": ISO8601DateTime,
  "customerId": "abc123",
  "deliveryMechanism": "EMAIL",
  "event": "abc123",
  "payload": {},
  "schedule": [TimeOffsetInput]
}
Input Objects

NotificationScheduleDeleteInput

Description

Input for deleting a notification schedule.

Fields
Input Field Description
id - GlobalID! The notification schedule's ID.
Example
{"id": GlobalID}
Input Objects

NotificationScheduleTemplateInput

Description

Input for creating an notification schedule.

Fields
Input Field Description
schedule - [TimeOffsetInput!]! The schedule.
trigger - NotificationScheduleTrigger! The trigger event that the notification schedule will be anchored to.
Example
{
  "schedule": [TimeOffsetInput],
  "trigger": "CROWDFUND_END_AT"
}
Input Objects

NotificationScheduleUpdateInput

Description

Input for updating a notification schedule.

Fields
Input Field Description
anchor - ISO8601DateTime! The schedule's anchor date.
id - GlobalID! The notification schedule's ID.
Example
{
  "anchor": ISO8601DateTime,
  "id": GlobalID
}
Input Objects

NotificationsConfigSetInput

Description

Input for configuring settings for notifications.

Fields
Input Field Description
emailCustomerWhenCampaignDueDateIsUpdated - Boolean
emailCustomerWhenCampaignIsOrdered - Boolean
emailMerchantOnWebhookFailure - Boolean
emailMerchantWhenCampaignOrderCannotBeFulfilled - Boolean
notificationSchedules - [NotificationScheduleTemplateInput!]
Example
{
  "emailCustomerWhenCampaignDueDateIsUpdated": true,
  "emailCustomerWhenCampaignIsOrdered": false,
  "emailMerchantOnWebhookFailure": true,
  "emailMerchantWhenCampaignOrderCannotBeFulfilled": false,
  "notificationSchedules": [
    NotificationScheduleTemplateInput
  ]
}
Input Objects

OrderCreateInput

Description

Input for creating an order.

Fields
Input Field Description
externalId - String! The order's external ID.
id - GlobalID The order's ID.
lineItems - [LineItemCreateInput!]! The input to create line items.
name - String! The order's name.
Example
{
  "externalId": "abc123",
  "id": GlobalID,
  "lineItems": [LineItemCreateInput],
  "name": "abc123"
}
Input Objects

OrderUpdateInput

Description

Input for updating an order.

Fields
Input Field Description
externalId - String The order's external ID.
id - GlobalID! The order's ID.
lineItems - [LineItemUpdateInput!] The input to update line items.
name - String The order's name.
Example
{
  "externalId": "abc123",
  "id": GlobalID,
  "lineItems": [LineItemUpdateInput],
  "name": "abc123"
}
Input Objects

OrderUpsertInput

Description

Input for upserting an order.

Fields
Input Field Description
externalId - String The order's external ID.
id - GlobalID! The order's ID.
lineItems - [LineItemUpsertInput!] The input to upsert line items.
name - String The order's name.
Example
{
  "externalId": "abc123",
  "id": GlobalID,
  "lineItems": [LineItemUpsertInput],
  "name": "abc123"
}
Input Objects

OrganisationCreateInput

Description

Input for creating an organisation.

Fields
Input Field Description
address - MailingAddressInput The organisation's mailing address.
email - String! The organisation's email address.
name - String! The organisation's name.
Example
{
  "address": MailingAddressInput,
  "email": "xyz789",
  "name": "xyz789"
}
Input Objects

OrganisationUpdateInput

Description

Input for updating an organisation.

Fields
Input Field Description
address - MailingAddressInput The organisation's mailing address.
email - String The organisation's email address.
id - GlobalID! The organisation's ID.
name - String The organisation's name.
status - OrganisationStatus The organisation's status (eg. active).
Example
{
  "address": MailingAddressInput,
  "email": "abc123",
  "id": GlobalID,
  "name": "abc123",
  "status": "ACTIVE"
}
Input Objects

PaymentInstrumentCreateInput

Description

Specifies the input fields required to create a payment instrument.

Fields
Input Field Description
card - CardCreateInput The card to be used for this payment method.
externalReference - String The (optional) external reference of the instrument.
manuallyCapturable - Boolean Whether payment can be captured manually.
paymentProcessor - PaymentProcessorType! The payment processor to be used for this payment method.
paypalBillingAgreement - PaypalBillingAgreementCreateInput The agreement to be used for this payment method.
type - PaymentInstrumentType! The type of payment instrument to create.
Example
{
  "card": CardCreateInput,
  "externalReference": "xyz789",
  "manuallyCapturable": false,
  "paymentProcessor": "SHOPIFY",
  "paypalBillingAgreement": PaypalBillingAgreementCreateInput,
  "type": "CARD"
}
Input Objects

PaymentInstrumentUpdateInput

Description

Specifies the input fields required to update a payment instrument.

Fields
Input Field Description
card - CardCreateInput The card to be used for this payment method.
externalReference - String The (optional) external reference of the instrument.
paymentProcessor - PaymentProcessorType! The payment processor to be used for this payment method.
paypalBillingAgreement - PaypalBillingAgreementCreateInput The agreement to be used for this payment method.
type - PaymentInstrumentType! The type of payment instrument to create.
Example
{
  "card": CardCreateInput,
  "externalReference": "abc123",
  "paymentProcessor": "SHOPIFY",
  "paypalBillingAgreement": PaypalBillingAgreementCreateInput,
  "type": "CARD"
}
Input Objects

PaymentIntentAdjustmentCreateInput

Description

The input values required to create an adjustment to a payment intent

Fields
Input Field Description
amount - MoneyInput! The money object
description - String The description of the charge
metadata - MetadataInput Unstructured key/value pairs
paymentIntentId - GlobalID! The payment intent ID
Example
{
  "amount": MoneyInput,
  "description": "xyz789",
  "metadata": MetadataInput,
  "paymentIntentId": GlobalID
}
Input Objects

PaymentIntentCancelInput

Description

The input required to cancel a payment intent

Fields
Input Field Description
id - GlobalID! The payment intent ID
Example
{"id": GlobalID}
Input Objects

PaymentIntentCreateInput

Description

The input values required to create a new payment intent

Fields
Input Field Description
amount - MoneyInput! The amount to be collected.
flexible - Boolean! If payment intent is flexible and can be changed.
initialCharge - ChargeRecordInput An initial charge to be recorded against the intent.
metadata - MetadataInput Unstructured key/value pairs.
paymentMethodId - GlobalID! The payment method ID.
Example
{
  "amount": MoneyInput,
  "flexible": false,
  "initialCharge": ChargeRecordInput,
  "metadata": MetadataInput,
  "paymentMethodId": GlobalID
}
Input Objects

PaymentIntentFinaliseInput

Description

The input values required to finalise a payment intent

Fields
Input Field Description
amount - MoneyInput! The amount to be collected.
id - GlobalID! The PaymentIntent ID
Example
{
  "amount": MoneyInput,
  "id": GlobalID
}
Input Objects

PaymentIntentUpdateInput

Description

The input values required to update a payment intent

Fields
Input Field Description
id - GlobalID! The PaymentIntent ID
metadata - MetadataInput Unstructured key/value pairs
paymentMethodId - GlobalID The payment method ID
Example
{
  "id": GlobalID,
  "metadata": MetadataInput,
  "paymentMethodId": GlobalID
}
Input Objects

PaymentMethodCancelInput

Description

The input required to cancel a payment method

Fields
Input Field Description
id - GlobalID! The payment method ID
Example
{"id": GlobalID}
Input Objects

PaymentMethodCreateInput

Description

Specifies the input fields required to create a payment method.

Fields
Input Field Description
customerId - GlobalID! The ID of the customer.
paymentInstrument - PaymentInstrumentCreateInput! The payment instrument.
Example
{
  "customerId": GlobalID,
  "paymentInstrument": PaymentInstrumentCreateInput
}
Input Objects

PaymentMethodSendUpdateEmailInput

Description

Specifies the input fields required to send payment method update email to customer.

Fields
Input Field Description
id - GlobalID! The payment method ID of the order.
Example
{"id": GlobalID}
Input Objects

PaymentMethodUpdateInput

Description

Specifies the input fields required to update a payment method.

Fields
Input Field Description
id - GlobalID! The ID of the payment method.
paymentInstrument - PaymentInstrumentUpdateInput! The payment instrument.
Example
{
  "id": GlobalID,
  "paymentInstrument": PaymentInstrumentUpdateInput
}
Input Objects

PaypalBillingAgreementCreateInput

Description

Specifies the input fields required to create a Paypal billing agreement.

Fields
Input Field Description
accountEmail - String The account email.
accountName - String The account name.
externalId - String The (optional) external ID of the agreement.
Example
{
  "accountEmail": "xyz789",
  "accountName": "xyz789",
  "externalId": "abc123"
}
Input Objects

PlatformConfigSetInput

Description

Input for configuring Submarine settings.

Fields
Input Field Description
notifications - NotificationsConfigSetInput
presales - PresalesConfigSetInput
pricing - PricingConfigSetInput
subscriptions - SubscriptionsConfigSetInput
Example
{
  "notifications": NotificationsConfigSetInput,
  "presales": PresalesConfigSetInput,
  "pricing": PricingConfigSetInput,
  "subscriptions": SubscriptionsConfigSetInput
}
Input Objects

PresaleCampaignAddProductVariantsInput

Description

Input for adding product variants to a presale campaign.

Fields
Input Field Description
id - GlobalID The campaigns's ID.
productVariantIds - [SharedGlobalID!]! The product variants to be added to the campaign
Example
{
  "id": GlobalID,
  "productVariantIds": [SharedGlobalID]
}
Input Objects

PresaleCampaignAddProductsInput

Description

Input for adding products to a presale campaign.

Fields
Input Field Description
id - GlobalID The campaigns's ID.
productIds - [SharedGlobalID!] The products that are included in the campaign
Example
{
  "id": GlobalID,
  "productIds": [SharedGlobalID]
}
Input Objects

PresaleCampaignApplyBulkInventoryInput

Description

Specifies the input fields required to apply bulk inventory to a presale campaign.

Fields
Input Field Description
campaignId - GlobalID! The presale campaign ID.
inventoryApplications - [PresaleCampaignApplyInventoryBaseInput!]! The campaign inventory items and quantities which should be applied
Example
{
  "campaignId": GlobalID,
  "inventoryApplications": [
    PresaleCampaignApplyInventoryBaseInput
  ]
}
Input Objects

PresaleCampaignApplyInventoryBaseInput

Description

Specifies the base input fields required to apply inventory to a presale campaign.

Fields
Input Field Description
campaignInventoryItemId - GlobalID! The campaign inventory item for which inventory is being applied
quantityReceived - Int! The number of units available to be allocated
Example
{
  "campaignInventoryItemId": GlobalID,
  "quantityReceived": 123
}
Input Objects

PresaleCampaignApplyInventoryInput

Description

Specifies the input fields required to apply inventory to a presale campaign.

Fields
Input Field Description
campaignId - GlobalID! The presale campaign ID.
campaignInventoryItemId - GlobalID! The campaign inventory item for which inventory is being applied
quantityReceived - PositiveInteger! The number of units available to be allocated
Example
{
  "campaignId": GlobalID,
  "campaignInventoryItemId": GlobalID,
  "quantityReceived": PositiveInteger
}
Input Objects

PresaleCampaignArchiveInput

Description

Specifies the input fields required to archive a presale campaign.

Fields
Input Field Description
id - GlobalID! ID of the presale campaign to archive.
Example
{"id": GlobalID}
Input Objects

PresaleCampaignCancelInput

Description

Specifies the input fields required to cancel a presale campaign.

Fields
Input Field Description
id - GlobalID! ID of the presale campaign to cancel.
Example
{"id": GlobalID}
Input Objects

PresaleCampaignCreateInput

Description

Input for creating a presale campaign.

Fields
Input Field Description
deposit - CampaignDepositInput The campaign deposit
description - String The campaign description
endAt - ISO8601DateTime! The date the presale will end
fulfilAt - ISO8601DateTime The date the presale will be fulfilled
gracePeriodHours - Int! The number of hours a customer has to rectify a failed presale campaign payment before their campaign order is cancelled.
launchAt - ISO8601DateTime! The date the presale will be launched
limit - Int! The maximum number of units of the linked products that can be sold
name - String The name of the campaign
productIds - [SharedGlobalID!] The products that are included in the campaign
productVariantIds - [SharedGlobalID!] The product variants that are included in the campaign
reference - String! The campaign reference
Example
{
  "deposit": CampaignDepositInput,
  "description": "abc123",
  "endAt": ISO8601DateTime,
  "fulfilAt": ISO8601DateTime,
  "gracePeriodHours": 123,
  "launchAt": ISO8601DateTime,
  "limit": 123,
  "name": "xyz789",
  "productIds": [SharedGlobalID],
  "productVariantIds": [SharedGlobalID],
  "reference": "xyz789"
}
Input Objects

PresaleCampaignDeleteInput

Description

Specifies the input fields required to delete a presale campaign.

Fields
Input Field Description
id - GlobalID! ID of the presale campaign to delete.
Example
{"id": GlobalID}
Input Objects

PresaleCampaignEndInput

Description

Specifies the input fields required to end a presale campaign.

Fields
Input Field Description
id - GlobalID! ID of the presale campaign to end.
Example
{"id": GlobalID}
Input Objects

PresaleCampaignFulfilInput

Description

Specifies the input fields required to fulfil a presale campaign.

Fields
Input Field Description
id - GlobalID! ID of the presale campaign to fulfil.
Example
{"id": GlobalID}
Input Objects

PresaleCampaignLaunchInput

Description

Specifies the input fields required to launch a presale campaign.

Fields
Input Field Description
id - GlobalID! ID of the presale campaign to launch.
Example
{"id": GlobalID}
Input Objects

PresaleCampaignRemoveProductVariantsInput

Description

Input for removing product variants from a presale campaign.

Fields
Input Field Description
id - GlobalID The campaigns's ID.
productVariantIds - [SharedGlobalID!] The product variants to be removed from the campaign
Example
{
  "id": GlobalID,
  "productVariantIds": [SharedGlobalID]
}
Input Objects

PresaleCampaignRemoveProductsInput

Description

Input for removing products from a presale campaign.

Fields
Input Field Description
id - GlobalID The campaigns's ID.
productIds - [SharedGlobalID!] The products to be removed from the campaign
Example
{
  "id": GlobalID,
  "productIds": [SharedGlobalID]
}
Input Objects

PresaleCampaignUnarchiveInput

Description

Specifies the input fields required to unarchive a presale campaign.

Fields
Input Field Description
id - GlobalID! ID of the presale campaign to unarchive.
Example
{"id": GlobalID}
Input Objects

PresaleCampaignUpdateInput

Description

Input for updating a presale campaign.

Fields
Input Field Description
deposit - CampaignDepositInput The campaign deposit
description - String The campaign description
endAt - ISO8601DateTime The date the presale will end
fulfilAt - ISO8601DateTime The date the presale will be fulfilled
gracePeriodHours - Int The number of hours a customer has to rectify a failed presale campaign payment before their campaign order is cancelled.
id - GlobalID! The campaign's ID.
launchAt - ISO8601DateTime The date the presale will be launched
limit - Int The maximum number of units of the linked products that can be sold
name - String The name of the campaign
productIds - [SharedGlobalID!] The products that are included in the campaign
productVariantIds - [SharedGlobalID!] The product variants to be added to the campaign
reference - String The campaign reference
Example
{
  "deposit": CampaignDepositInput,
  "description": "xyz789",
  "endAt": ISO8601DateTime,
  "fulfilAt": ISO8601DateTime,
  "gracePeriodHours": 123,
  "id": GlobalID,
  "launchAt": ISO8601DateTime,
  "limit": 123,
  "name": "xyz789",
  "productIds": [SharedGlobalID],
  "productVariantIds": [SharedGlobalID],
  "reference": "xyz789"
}
Input Objects

PresalesConfigSetInput

Description

Input for configuring settings for presales.

Fields
Input Field Description
allowDepositUpdatesOnLaunchedPresales - Boolean
campaignPaymentTermsAlignment - CampaignPaymentTermsAlignment
defaultCurrency - CurrencyCode
defaultPresaleDeposit - CampaignDepositInput
defaultPresaleInventoryPolicy - PresaleInventoryPolicy
metafieldUpdateInterval - Int
refundPresalesDepositsOnCancellation - Boolean
templateForCrowdfundSellingPlanDescription - String
templateForCrowdfundSellingPlanName - String
templateForPresaleSellingPlanDescription - String
templateForPresaleSellingPlanName - String
Example
{
  "allowDepositUpdatesOnLaunchedPresales": false,
  "campaignPaymentTermsAlignment": "FIRST_CAMPAIGN",
  "defaultCurrency": "AED",
  "defaultPresaleDeposit": CampaignDepositInput,
  "defaultPresaleInventoryPolicy": "ON_FULFILMENT",
  "metafieldUpdateInterval": 987,
  "refundPresalesDepositsOnCancellation": true,
  "templateForCrowdfundSellingPlanDescription": "xyz789",
  "templateForCrowdfundSellingPlanName": "xyz789",
  "templateForPresaleSellingPlanDescription": "xyz789",
  "templateForPresaleSellingPlanName": "abc123"
}
Input Objects

PricingConfigSetInput

Description

Input for configuring settings for pricing.

Fields
Input Field Description
defaultPriceEngine - PriceEngineProvider
defaultPriceEnginePolicy - PriceEnginePolicy
moneyRoundingMode - MoneyRoundingMode
shippingTaxable - Boolean
taxBehaviour - TaxBehaviour
Example
{
  "defaultPriceEngine": "SHOPIFY",
  "defaultPriceEnginePolicy": "ALWAYS",
  "moneyRoundingMode": "ROUND_CEILING",
  "shippingTaxable": false,
  "taxBehaviour": "EXCLUSIVE"
}
Input Objects

ProductCollectionCreateInput

Description

Input for creating a product collection.

Fields
Input Field Description
externalId - String! The product collection's external ID.
id - GlobalID The product collection's ID.
imageUrl - String The product collection's image URL.
products - [ProductCollectionItemCreateInput!] The input to create product collection items.
status - ProductCollectionStatus! The product collection's status.
title - String The product collection's title.
Example
{
  "externalId": "abc123",
  "id": GlobalID,
  "imageUrl": "abc123",
  "products": [ProductCollectionItemCreateInput],
  "status": "DELETED",
  "title": "abc123"
}
Input Objects

ProductCollectionDeleteInput

Description

Input for deleting a product collection.

Fields
Input Field Description
id - GlobalID! The product collections's ID.
Example
{"id": GlobalID}
Input Objects

ProductCollectionItemCreateInput

Description

Input for creating product collection item.

Fields
Input Field Description
collectionItemExternalId - String The product collection item's external ID.
externalId - String! The product's external ID.
Example
{
  "collectionItemExternalId": "xyz789",
  "externalId": "xyz789"
}
Input Objects

ProductCollectionItemUpdateInput

Description

Input for updating product collection item.

Fields
Input Field Description
collectionItemExternalId - String The product collection item's external ID.
externalId - String! The product's external ID.
Example
{
  "collectionItemExternalId": "abc123",
  "externalId": "xyz789"
}
Input Objects

ProductCollectionItemUpsertInput

Description

Input for upserting product collection item.

Fields
Input Field Description
collectionItemExternalId - String The product collection item's external ID.
externalId - String! The product's external ID.
Example
{
  "collectionItemExternalId": "abc123",
  "externalId": "xyz789"
}
Input Objects

ProductCollectionUpdateInput

Description

Input for updating a product collection.

Fields
Input Field Description
externalId - String The product collection's external ID.
id - GlobalID! The product collection's ID.
imageUrl - String The product collection's image URL.
products - [ProductCollectionItemUpdateInput!] The input to update product collection items.
status - ProductCollectionStatus! The product collection's status.
title - String The product collection's title.
Example
{
  "externalId": "abc123",
  "id": GlobalID,
  "imageUrl": "abc123",
  "products": [ProductCollectionItemUpdateInput],
  "status": "DELETED",
  "title": "abc123"
}
Input Objects

ProductCollectionUpsertInput

Description

Input for upserting a product collection.

Fields
Input Field Description
externalId - String! The product collection's external ID.
id - GlobalID The product collection's ID.
imageUrl - String The product collection's image URL.
products - [ProductCollectionItemUpsertInput!]! The input to create product collection items.
status - ProductCollectionStatus! The product collection's status.
title - String The product collection's title.
Example
{
  "externalId": "abc123",
  "id": GlobalID,
  "imageUrl": "xyz789",
  "products": [ProductCollectionItemUpsertInput],
  "status": "DELETED",
  "title": "xyz789"
}
Input Objects

ProductCreateInput

Description

Input for creating a product.

Fields
Input Field Description
externalId - String! The product's external ID.
imageUrl - String The product's image URL.
productVariants - [ProductVariantCreateInput!] The product's variants.
status - ProductStatus! The product's status.
title - String The product's title.
Example
{
  "externalId": "xyz789",
  "imageUrl": "xyz789",
  "productVariants": [ProductVariantCreateInput],
  "status": "DELETED",
  "title": "abc123"
}
Input Objects

ProductDeleteInput

Description

Input for deleting a product.

Fields
Input Field Description
id - GlobalID! The product's ID.
Example
{"id": GlobalID}
Input Objects

ProductUpdateInput

Description

Input for updating a product.

Fields
Input Field Description
externalId - String The product's external ID.
id - GlobalID! The product's ID.
imageUrl - String The product's image URL.
title - String The product's title.
Example
{
  "externalId": "xyz789",
  "id": GlobalID,
  "imageUrl": "xyz789",
  "title": "abc123"
}
Input Objects

ProductUpsertInput

Description

Input for upserting a product.

Fields
Input Field Description
externalId - String The product's external ID.
id - GlobalID The customer's ID.
imageUrl - String The product's image URL.
productVariants - [ProductVariantUpsertInput!] The product's variants.
status - ProductStatus The product's status.
title - String The product's title.
Example
{
  "externalId": "abc123",
  "id": GlobalID,
  "imageUrl": "abc123",
  "productVariants": [ProductVariantUpsertInput],
  "status": "DELETED",
  "title": "abc123"
}
Input Objects

ProductVariantCreateInput

Description

Input for creating a product variant.

Fields
Input Field Description
externalId - String! The variant's external ID.
imageUrl - String The variant's image URL.
productId - GlobalID The ID of the parent product.
shippable - Boolean! Whether the variant requires shipping.
sku - String The variant's SKU
status - ProductStatus The variant's status.
taxable - Boolean! Whether a tax is charged when the variant is sold.
title - String Whether the customer is liable for sales tax.
weightGrams - Int The variant's weight in grams.
Example
{
  "externalId": "abc123",
  "imageUrl": "xyz789",
  "productId": GlobalID,
  "shippable": true,
  "sku": "abc123",
  "status": "DELETED",
  "taxable": true,
  "title": "xyz789",
  "weightGrams": 987
}
Input Objects

ProductVariantDeleteInput

Description

Input for deleting a product variant.

Fields
Input Field Description
id - GlobalID! The variant's ID.
Example
{"id": GlobalID}
Input Objects

ProductVariantUpdateInput

Description

Input for updating a product variant.

Fields
Input Field Description
externalId - String The variant's external ID.
id - GlobalID! The product variant's ID.
imageUrl - String The variant's image URL.
shippable - Boolean Whether the variant requires shipping.
sku - String The variant's SKU
taxable - Boolean Whether a tax is charged when the variant is sold.
title - String The variant's title.
weightGrams - Int The variant's weight in grams.
Example
{
  "externalId": "xyz789",
  "id": GlobalID,
  "imageUrl": "xyz789",
  "shippable": true,
  "sku": "xyz789",
  "taxable": false,
  "title": "abc123",
  "weightGrams": 123
}
Input Objects

ProductVariantUpsertInput

Description

Input for updating a product variant.

Fields
Input Field Description
externalId - String The variant's external ID.
id - GlobalID The product variant's ID.
imageUrl - String The variant's image URL.
price - MoneyInput The variant's price
shippable - Boolean Whether the variant requires shipping.
sku - String The variant's SKU
status - ProductVariantStatus The variant's status.
taxable - Boolean Whether a tax is charged when the variant is sold.
title - String The variant's title.
weightGrams - Int The variant's weight in grams.
Example
{
  "externalId": "abc123",
  "id": GlobalID,
  "imageUrl": "abc123",
  "price": MoneyInput,
  "shippable": false,
  "sku": "abc123",
  "status": "DELETED",
  "taxable": false,
  "title": "xyz789",
  "weightGrams": 123
}
Input Objects

ProvinceInput

Description

Translation missing: en.graphql.inputs.province_input.description

Fields
Input Field Description
code - ProvinceCode Translation missing: en.graphql.inputs.province_input.arguments.code
name - String Translation missing: en.graphql.inputs.province_input.arguments.name
Example
{
  "code": ProvinceCode,
  "name": "xyz789"
}
Input Objects

RefundProcessInput

Description

The input required to process a refund

Fields
Input Field Description
amount - MoneyInput The money object
description - String The refund description
metadata - MetadataInput Unstructured key/value pairs
paymentIntentId - GlobalID! The payment intent ID
Example
{
  "amount": MoneyInput,
  "description": "xyz789",
  "metadata": MetadataInput,
  "paymentIntentId": GlobalID
}
Input Objects

RefundRecordInput

Description

The input required to record a refund

Fields
Input Field Description
amount - MoneyInput The money object
chargeId - GlobalID The parent charge ID
description - String The refund description
metadata - MetadataInput Unstructured key/value pairs
paymentIntentId - GlobalID! The payment intent ID
Example
{
  "amount": MoneyInput,
  "chargeId": GlobalID,
  "description": "abc123",
  "metadata": MetadataInput,
  "paymentIntentId": GlobalID
}
Input Objects

ShopifyCredentialsCreateInput

Description

Input for storing Shopify credentials.

Fields
Input Field Description
accessToken - String! The Shopify access token.
shopifyDomain - String! The shop's shopify sub-domain.
Example
{
  "accessToken": "xyz789",
  "shopifyDomain": "abc123"
}
Input Objects

SubscriptionAnchorInput

Fields
Input Field Description
day - Int
month - Int
name - String
time - TimeOfDay
type - SubscriptionAnchorType!
Example
{
  "day": 123,
  "month": 123,
  "name": "xyz789",
  "time": TimeOfDay,
  "type": "FLEXIBLE"
}
Input Objects

SubscriptionBacklogInput

Description

Translation missing: en.graphql.inputs.subscription_backlog_input.description

Fields
Input Field Description
interval - SubscriptionBacklogInterval! Translation missing: en.graphql.inputs.subscription_backlog_input.arguments.interval
intervalCount - Int! Translation missing: en.graphql.inputs.subscription_backlog_input.arguments.interval_count
Example
{"interval": "CYCLE", "intervalCount": 123}
Input Objects

SubscriptionBillingBehaviourInput

Fields
Input Field Description
billingOffset - SubscriptionOffsetInput!
processingOffset - SubscriptionOffsetInput!
Example
{
  "billingOffset": SubscriptionOffsetInput,
  "processingOffset": SubscriptionOffsetInput
}
Input Objects

SubscriptionCancelInput

Description

Translation missing: en.graphql.inputs.subscription_cancel_input.description

Fields
Input Field Description
description - String Translation missing: en.graphql.inputs.subscription_cancel_input.arguments.description
id - GlobalID! Translation missing: en.graphql.inputs.subscription_cancel_input.arguments.id
Example
{
  "description": "xyz789",
  "id": GlobalID
}
Input Objects

SubscriptionDeliveryBehaviourInput

Fields
Input Field Description
fixed - SubscriptionFixedDeliveryBehaviourInput
type - SubscriptionDeliveryBehaviourType!
Example
{
  "fixed": SubscriptionFixedDeliveryBehaviourInput,
  "type": "FIXED"
}
Input Objects

SubscriptionDeliveryMethodInput

Description

Translation missing: en.graphql.inputs.subscription_delivery_method_input.description

Fields
Input Field Description
shipping - SubscriptionDeliveryMethodShippingInput! Translation missing: en.graphql.inputs.subscription_delivery_method_input.arguments.shipping
Example
{"shipping": SubscriptionDeliveryMethodShippingInput}
Input Objects

SubscriptionDeliveryMethodShippingInput

Description

Translation missing: en.graphql.inputs.subscription_delivery_method_shipping_input.description

Fields
Input Field Description
address - AddressInput! Translation missing: en.graphql.inputs.subscription_delivery_method_shipping_input.arguments.address
Example
{"address": AddressInput}
Input Objects

SubscriptionFixedDeliveryBehaviourInput

Fields
Input Field Description
cutoff - SubscriptionOffsetInput!
preAnchorBehaviour - SubscriptionDeliveryPreAnchorBehaviourType!
Example
{
  "cutoff": SubscriptionOffsetInput,
  "preAnchorBehaviour": "ASAP"
}
Input Objects

SubscriptionFrequencyInput

Fields
Input Field Description
interval - SubscriptionInterval!
intervalCount - Int!
maxCycles - Int
minCycles - Int
Example
{"interval": "DAY", "intervalCount": 123, "maxCycles": 123, "minCycles": 123}
Input Objects

SubscriptionInventoryBehaviourInput

Fields
Input Field Description
inventoryDecrementPolicy - SubscriptionInventoryDecrementPolicy!
outOfStockPolicy - SubscriptionInventoryOutOfStockPolicy!
Example
{"inventoryDecrementPolicy": "NONE", "outOfStockPolicy": "PAUSE_SUBSCRIPTION"}
Input Objects

SubscriptionLineAddInput

Description

Translation missing: en.graphql.inputs.subscription_line_add_input.description

Fields
Input Field Description
productVariantId - SharedGlobalID! Translation missing: en.graphql.inputs.subscription_line_add_input.arguments.product_variant_id
quantity - NonZeroCount! Translation missing: en.graphql.inputs.subscription_line_add_input.arguments.quantity
subscriptionId - GlobalID! Translation missing: en.graphql.inputs.subscription_line_add_input.arguments.subscription_id
Example
{
  "productVariantId": SharedGlobalID,
  "quantity": NonZeroCount,
  "subscriptionId": GlobalID
}
Input Objects

SubscriptionLineRemoveInput

Description

Translation missing: en.graphql.inputs.subscription_line_remove_input.description

Fields
Input Field Description
lineId - GlobalID! Translation missing: en.graphql.inputs.subscription_line_remove_input.arguments.line_id
subscriptionId - GlobalID! Translation missing: en.graphql.inputs.subscription_line_remove_input.arguments.subscription_id
Example
{
  "lineId": GlobalID,
  "subscriptionId": GlobalID
}
Input Objects

SubscriptionLineSetQuantityInput

Description

Translation missing: en.graphql.inputs.subscription_line_set_quantity_input.description

Fields
Input Field Description
lineId - GlobalID! Translation missing: en.graphql.inputs.subscription_line_set_quantity_input.arguments.line_id
quantity - Count! Translation missing: en.graphql.inputs.subscription_line_set_quantity_input.arguments.quantity
subscriptionId - GlobalID! Translation missing: en.graphql.inputs.subscription_line_set_quantity_input.arguments.subscription_id
Example
{
  "lineId": GlobalID,
  "quantity": Count,
  "subscriptionId": GlobalID
}
Input Objects

SubscriptionLineUpsertInput

Description

Translation missing: en.graphql.inputs.subscription_line_upsert_input.description

Fields
Input Field Description
productVariantId - SharedGlobalID! Translation missing: en.graphql.inputs.subscription_line_upsert_input.arguments.product_variant_id
quantity - NonZeroCount! Translation missing: en.graphql.inputs.subscription_line_upsert_input.arguments.quantity
Example
{
  "productVariantId": SharedGlobalID,
  "quantity": NonZeroCount
}
Input Objects

SubscriptionOffsetInput

Fields
Input Field Description
interval - SubscriptionOffsetInterval!
intervalCount - Int!
type - SubscriptionOffsetType!
Example
{"interval": "DAY", "intervalCount": 123, "type": "BUSINESS"}
Input Objects

SubscriptionOrderLineAddInput

Description

Translation missing: en.graphql.inputs.subscription_order_line_add_input.description

Fields
Input Field Description
productVariantId - SharedGlobalID! Translation missing: en.graphql.inputs.subscription_order_line_add_input.arguments.product_variant_id
quantity - NonZeroCount! Translation missing: en.graphql.inputs.subscription_order_line_add_input.arguments.quantity
subscriptionOrderId - GlobalID! Translation missing: en.graphql.inputs.subscription_order_line_add_input.arguments.subscription_order_id
Example
{
  "productVariantId": SharedGlobalID,
  "quantity": NonZeroCount,
  "subscriptionOrderId": GlobalID
}
Input Objects

SubscriptionOrderLineRemoveInput

Description

Translation missing: en.graphql.inputs.subscription_order_line_remove_input.description

Fields
Input Field Description
lineId - GlobalID! Translation missing: en.graphql.inputs.subscription_order_line_remove_input.arguments.line_id
subscriptionOrderId - GlobalID! Translation missing: en.graphql.inputs.subscription_order_line_remove_input.arguments.subscription_order_id
Example
{
  "lineId": GlobalID,
  "subscriptionOrderId": GlobalID
}
Input Objects

SubscriptionOrderLineSetQuantityInput

Description

Translation missing: en.graphql.inputs.subscription_order_line_set_quantity_input.description

Fields
Input Field Description
lineId - GlobalID! Translation missing: en.graphql.inputs.subscription_order_line_set_quantity_input.arguments.line_id
quantity - NonZeroCount! Translation missing: en.graphql.inputs.subscription_order_line_set_quantity_input.arguments.quantity
subscriptionOrderId - GlobalID! Translation missing: en.graphql.inputs.subscription_order_line_set_quantity_input.arguments.subscription_order_id
Example
{
  "lineId": GlobalID,
  "quantity": NonZeroCount,
  "subscriptionOrderId": GlobalID
}
Input Objects

SubscriptionOrderProcessInput

Description

Translation missing: en.graphql.inputs.subscription_order_process_input.description

Fields
Input Field Description
id - GlobalID! Translation missing: en.graphql.inputs.subscription_order_process_input.arguments.id
Example
{"id": GlobalID}
Input Objects

SubscriptionOrderSelectorInput

Fields
Input Field Description
cycleIndex - Count
date - ISO8601DateTime
subscriptionId - GlobalID!
Example
{
  "cycleIndex": Count,
  "date": ISO8601DateTime,
  "subscriptionId": GlobalID
}
Input Objects

SubscriptionOrderSetDeliveryDateInput

Description

Translation missing: en.graphql.inputs.subscription_order_set_delivery_date_input.description

Fields
Input Field Description
deliverAt - Timestamp! Translation missing: en.graphql.inputs.subscription_order_set_delivery_date_input.arguments.deliver_at
id - GlobalID Translation missing: en.graphql.inputs.subscription_order_set_delivery_date_input.arguments.id
selector - SubscriptionOrderSelectorInput Translation missing: en.graphql.inputs.subscription_order_set_delivery_date_input.arguments.selector
subscriptionAnchorId - GlobalID! Translation missing: en.graphql.inputs.subscription_order_set_delivery_date_input.arguments.subscription_anchor_id
Example
{
  "deliverAt": 1592577642,
  "id": GlobalID,
  "selector": SubscriptionOrderSelectorInput,
  "subscriptionAnchorId": GlobalID
}
Input Objects

SubscriptionOrderSkipInput

Description

Translation missing: en.graphql.inputs.subscription_order_skip_input.description

Fields
Input Field Description
count - NonZeroCount Translation missing: en.graphql.inputs.subscription_order_skip_input.arguments.count. Default = 1
id - GlobalID! Translation missing: en.graphql.inputs.subscription_order_skip_input.arguments.id
reason - String Translation missing: en.graphql.inputs.subscription_order_skip_input.arguments.reason
Example
{
  "count": NonZeroCount,
  "id": GlobalID,
  "reason": "abc123"
}
Input Objects

SubscriptionOrderUnskipInput

Description

Translation missing: en.graphql.inputs.subscription_order_unskip_input.description

Fields
Input Field Description
id - GlobalID! Translation missing: en.graphql.inputs.subscription_order_unskip_input.arguments.id
Example
{"id": GlobalID}
Input Objects

SubscriptionOrderUpdateInput

Description

Translation missing: en.graphql.inputs.subscription_order_update_input.description

Fields
Input Field Description
deliveryMethod - SubscriptionDeliveryMethodInput Translation missing: en.graphql.inputs.subscription_order_update_input.arguments.delivery_method
id - GlobalID! Translation missing: en.graphql.inputs.subscription_order_update_input.arguments.id
paymentMethodId - GlobalID Translation missing: en.graphql.inputs.subscription_order_update_input.arguments.payment_method_id
Example
{
  "deliveryMethod": SubscriptionDeliveryMethodInput,
  "id": GlobalID,
  "paymentMethodId": GlobalID
}
Input Objects

SubscriptionPauseInput

Description

Translation missing: en.graphql.inputs.subscription_pause_input.description

Fields
Input Field Description
description - String Translation missing: en.graphql.inputs.subscription_pause_input.arguments.description
id - GlobalID! Translation missing: en.graphql.inputs.subscription_pause_input.arguments.id
resumeAt - Timestamp Translation missing: en.graphql.inputs.subscription_pause_input.arguments.resume_at
Example
{
  "description": "xyz789",
  "id": GlobalID,
  "resumeAt": 1592577642
}
Input Objects

SubscriptionPlanCreateInput

Fields
Input Field Description
anchorNameTemplate - String
anchors - [SubscriptionAnchorInput!]!
billingBehaviour - SubscriptionBillingBehaviourInput
deliveryBehaviour - SubscriptionDeliveryBehaviourInput
frequency - SubscriptionFrequencyInput!
inventoryBehaviour - SubscriptionInventoryBehaviourInput
name - String!
pricingBehaviour - SubscriptionPricingBehaviourInput
Example
{
  "anchorNameTemplate": "abc123",
  "anchors": [SubscriptionAnchorInput],
  "billingBehaviour": SubscriptionBillingBehaviourInput,
  "deliveryBehaviour": SubscriptionDeliveryBehaviourInput,
  "frequency": SubscriptionFrequencyInput,
  "inventoryBehaviour": SubscriptionInventoryBehaviourInput,
  "name": "abc123",
  "pricingBehaviour": SubscriptionPricingBehaviourInput
}
Input Objects

SubscriptionPlanDeleteInput

Description

Translation missing: en.graphql.inputs.subscription_plan_delete_input.description

Fields
Input Field Description
id - GlobalID! Translation missing: en.graphql.inputs.subscription_plan_delete_input.arguments.id
Example
{"id": GlobalID}
Input Objects

SubscriptionPlanGroupCreateInput

Description

Input for creating a subscription plan group.

Fields
Input Field Description
billingBehaviour - SubscriptionBillingBehaviourInput!
deliveryBehaviour - SubscriptionDeliveryBehaviourInput!
inventoryBehaviour - SubscriptionInventoryBehaviourInput!
name - String! The name of the subscription plan group.
pricingBehaviour - SubscriptionPricingBehaviourInput!
productGroup - SubscriptionProductGroupInput!
reference - String! The subscription plan group reference.
subscriptionPlans - [SubscriptionPlanCreateInput!]!
timezone - Timezone
Example
{
  "billingBehaviour": SubscriptionBillingBehaviourInput,
  "deliveryBehaviour": SubscriptionDeliveryBehaviourInput,
  "inventoryBehaviour": SubscriptionInventoryBehaviourInput,
  "name": "xyz789",
  "pricingBehaviour": SubscriptionPricingBehaviourInput,
  "productGroup": SubscriptionProductGroupInput,
  "reference": "abc123",
  "subscriptionPlans": [SubscriptionPlanCreateInput],
  "timezone": Timezone
}
Input Objects

SubscriptionPriceDiscountInput

Fields
Input Field Description
afterCycle - Count
value - SubscriptionPriceDiscountValueInput!
valueCap - SubscriptionPriceDiscountValueCapInput
Example
{
  "afterCycle": Count,
  "value": SubscriptionPriceDiscountValueInput,
  "valueCap": SubscriptionPriceDiscountValueCapInput
}
Input Objects

SubscriptionPriceDiscountValueCapInput

Fields
Input Field Description
cap - MoneyInput!
type - SubscriptionPriceDiscountValueCapType!
Example
{"cap": MoneyInput, "type": "INDIVIDUAL_ITEM"}
Input Objects

SubscriptionPriceDiscountValueInput

Fields
Input Field Description
fixedAmount - MoneyInput
percentage - Percentage
type - SubscriptionPriceDiscountType!
Example
{
  "fixedAmount": MoneyInput,
  "percentage": Percentage,
  "type": "FIXED_AMOUNT"
}
Input Objects

SubscriptionPricingBehaviourInput

Fields
Input Field Description
basePrice - MoneyInput
basePricePolicy - SubscriptionBasePricePolicy!
discounts - [SubscriptionPriceDiscountInput!]
Example
{
  "basePrice": MoneyInput,
  "basePricePolicy": "CUSTOM",
  "discounts": [SubscriptionPriceDiscountInput]
}
Input Objects

SubscriptionProductGroupInput

Fields
Input Field Description
itemSources - [SubscriptionProductGroupItemSourceInput!]!
Example
{"itemSources": [SubscriptionProductGroupItemSourceInput]}
Input Objects

SubscriptionProductGroupItemSourceInput

Fields
Input Field Description
productCollectionId - SharedGlobalID
productId - SharedGlobalID
productVariantId - SharedGlobalID
Example
{
  "productCollectionId": SharedGlobalID,
  "productId": SharedGlobalID,
  "productVariantId": SharedGlobalID
}
Input Objects

SubscriptionRestoreInput

Description

Translation missing: en.graphql.inputs.subscription_restore_input.description

Fields
Input Field Description
description - String Translation missing: en.graphql.inputs.subscription_restore_input.arguments.description
id - GlobalID! Translation missing: en.graphql.inputs.subscription_restore_input.arguments.id
nextDeliveryDate - Timestamp Translation missing: en.graphql.inputs.subscription_restore_input.arguments.next_delivery_date
Example
{
  "description": "abc123",
  "id": GlobalID,
  "nextDeliveryDate": 1592577642
}
Input Objects

SubscriptionResumeInput

Description

Translation missing: en.graphql.inputs.subscription_resume_input.description

Fields
Input Field Description
description - String Translation missing: en.graphql.inputs.subscription_resume_input.arguments.description
id - GlobalID! Translation missing: en.graphql.inputs.subscription_resume_input.arguments.id
nextDeliveryDate - Timestamp Translation missing: en.graphql.inputs.subscription_resume_input.arguments.next_delivery_date
Example
{
  "description": "xyz789",
  "id": GlobalID,
  "nextDeliveryDate": 1592577642
}
Input Objects

SubscriptionRetryPolicyInput

Description

Translation missing: en.graphql.inputs.subscription_retry_policy_input.description

Fields
Input Field Description
interval - SubscriptionRetryInterval! Translation missing: en.graphql.inputs.subscription_retry_policy_input.arguments.interval
intervalCount - Int! Translation missing: en.graphql.inputs.subscription_retry_policy_input.arguments.interval_count
maxAttempts - Int! Translation missing: en.graphql.inputs.subscription_retry_policy_input.arguments.max_attempts
Example
{"interval": "DAY", "intervalCount": 123, "maxAttempts": 987}
Input Objects

SubscriptionSetScheduleInput

Description

Translation missing: en.graphql.inputs.subscription_set_schedule_input.description

Fields
Input Field Description
id - GlobalID! Translation missing: en.graphql.inputs.subscription_set_schedule_input.arguments.id
nextDeliveryAt - Timestamp! Translation missing: en.graphql.inputs.subscription_set_schedule_input.arguments.next_delivery_at
subscriptionAnchorId - GlobalID! Translation missing: en.graphql.inputs.subscription_set_schedule_input.arguments.subscription_anchor_id
subscriptionPlanId - GlobalID! Translation missing: en.graphql.inputs.subscription_set_schedule_input.arguments.subscription_plan_id
Example
{
  "id": GlobalID,
  "nextDeliveryAt": 1592577642,
  "subscriptionAnchorId": GlobalID,
  "subscriptionPlanId": GlobalID
}
Input Objects

SubscriptionUpdateInput

Description

Translation missing: en.graphql.inputs.subscription_update_input.description

Fields
Input Field Description
deliveryMethod - SubscriptionDeliveryMethodInput Translation missing: en.graphql.inputs.subscription_update_input.arguments.delivery_method
id - GlobalID! Translation missing: en.graphql.inputs.subscription_update_input.arguments.id
lines - [SubscriptionLineUpsertInput!] Translation missing: en.graphql.inputs.subscription_update_input.arguments.lines
paymentMethodId - GlobalID Translation missing: en.graphql.inputs.subscription_update_input.arguments.payment_method_id
Example
{
  "deliveryMethod": SubscriptionDeliveryMethodInput,
  "id": GlobalID,
  "lines": [SubscriptionLineUpsertInput],
  "paymentMethodId": GlobalID
}
Input Objects

SubscriptionsConfigSetInput

Description

Input for configuring settings for subscriptions.

Fields
Input Field Description
defaultPaymentRetryPolicy - SubscriptionRetryPolicyInput
defaultSubscriptionBacklogSize - SubscriptionBacklogInput
permittedFrequencyIntervals - [SubscriptionInterval!]
permittedRetryIntervals - [SubscriptionRetryInterval!]
subscriptionEngine - SubscriptionEngine
Example
{
  "defaultPaymentRetryPolicy": SubscriptionRetryPolicyInput,
  "defaultSubscriptionBacklogSize": SubscriptionBacklogInput,
  "permittedFrequencyIntervals": ["DAY"],
  "permittedRetryIntervals": ["DAY"],
  "subscriptionEngine": "NOOP"
}
Input Objects

TimeOffsetInput

Description

Input for creating a time offset in a notification schedule.

Fields
Input Field Description
direction - TimeOffsetDirection! The direction to offset in.
magnitude - Int! The magnitude to offset by.
unit - TimeOffsetUnit! The unit of time to offset by.
Example
{"direction": "BEFORE", "magnitude": 123, "unit": "DAYS"}
Input Objects

WebhookCreateInput

Description

Input for creating a webhook subscription.

Fields
Input Field Description
topic - WebhookTopic! The webhooks's topic (eg. CHARGE_FAILED).
url - Url! The webhooks url path
Example
{"topic": "CAMPAIGN_ORDER_CANCELLED", "url": Url}
Input Objects

WebhookDeleteInput

Description

Input for deleting a webhook subscription.

Fields
Input Field Description
id - GlobalID! The webhooks ID
Example
{"id": GlobalID}
Input Objects

WebhookUpdateInput

Description

Input for updating a webhook subscription.

Fields
Input Field Description
id - GlobalID! The ID of the webhook to update.
status - WebhookStatus The webhooks status
url - Url The webhooks url path
Example
{
  "id": GlobalID,
  "status": "ACTIVE",
  "url": Url
}

Objects

AccessToken

Description

An access token.

Fields
Field Name Description
token - String! Access token.
tokenType - AccessTokenType! The type of access token (eg. organisation).
Example
{"token": "xyz789", "tokenType": "CHANNEL"}
Objects

Address

Description

Translation missing: en.graphql.objects.address.description

Fields
Field Name Description
city - String Translation missing: en.graphql.objects.address.fields.city
country - Country! Translation missing: en.graphql.objects.address.fields.country
firstName - String Translation missing: en.graphql.objects.address.fields.first_name
lastName - String Translation missing: en.graphql.objects.address.fields.last_name
phone - String Translation missing: en.graphql.objects.address.fields.phone
postcode - String Translation missing: en.graphql.objects.address.fields.postcode
province - Province Translation missing: en.graphql.objects.address.fields.province
street1 - String Translation missing: en.graphql.objects.address.fields.street1
street2 - String Translation missing: en.graphql.objects.address.fields.street2
Example
{
  "city": "abc123",
  "country": Country,
  "firstName": "abc123",
  "lastName": "abc123",
  "phone": "abc123",
  "postcode": "xyz789",
  "province": Province,
  "street1": "abc123",
  "street2": "abc123"
}
Objects

CampaignDeposit

Description

A campaign deposit.

Fields
Field Name Description
type - CampaignDepositType
value - Float
Example
{"type": "PERCENTAGE", "value": 123.45}
Objects

CampaignInventoryItem

Description

A campaign inventory item.

Fields
Field Name Description
allocatedCount - Int! The total amount of inventory currently allocated to the campaign inventory item.
appliedCount - Int! The total amount of inventory currently applied to the campaign inventory item.
campaignItem - CampaignItem! The campaign item.
id - ID! The ID of the campaign inventory item
inventoryApplications - [InventoryApplication!] The item's inventory applications.
productVariant - ProductVariant! The product variant
reservedCount - Int! The total amount of inventory currently reserved on the campaign inventory item.
Example
{
  "allocatedCount": 123,
  "appliedCount": 123,
  "campaignItem": CampaignItem,
  "id": 4,
  "inventoryApplications": [InventoryApplication],
  "productVariant": ProductVariant,
  "reservedCount": 123
}
Objects

CampaignItem

Description

A campaign item.

Fields
Field Name Description
allocatedCount - Int! The reserved count.
appliedCount - Int! The applied count.
campaignInventoryItems - [CampaignInventoryItem!] The campaign item's campaign inventory items.
id - GlobalID! The id of the campaign item
reservedCount - Int! The reserved count.
resource - CampaignItemResource! The campaign item resource.
Example
{
  "allocatedCount": 987,
  "appliedCount": 123,
  "campaignInventoryItems": [CampaignInventoryItem],
  "id": GlobalID,
  "reservedCount": 123,
  "resource": Product
}
Objects

CampaignOrderFinancials

Description

The financial details of a campaign order.

Fields
Field Name Description
currency - CurrencyCode!
discountedUnitPrice - Money!
discounts - DiscountFinancials!
itemPrice - Money!
shipping - ShippingFinancials!
subtotal - Money!
tax - TaxFinancials!
totalDeposit - Money!
totalPrice - Money!
unitPrice - Money!
Example
{
  "currency": "AED",
  "discountedUnitPrice": Money,
  "discounts": DiscountFinancials,
  "itemPrice": Money,
  "shipping": ShippingFinancials,
  "subtotal": Money,
  "tax": TaxFinancials,
  "totalDeposit": Money,
  "totalPrice": Money,
  "unitPrice": Money
}
Objects

CampaignOrderGroupFinancials

Description

The financial details of a campaign order group.

Fields
Field Name Description
currency - CurrencyCode!
discounts - DiscountFinancials!
shipping - ShippingFinancials!
subtotal - Money!
tax - TaxFinancials!
totalDeposit - Money!
totalPrice - Money!
Example
{
  "currency": "AED",
  "discounts": DiscountFinancials,
  "shipping": ShippingFinancials,
  "subtotal": Money,
  "tax": TaxFinancials,
  "totalDeposit": Money,
  "totalPrice": Money
}
Objects

CampaignOrderGroupMilestones

Fields
Field Name Description
createdAt - ISO8601DateTime!
dueAt - ISO8601DateTime
updatedAt - ISO8601DateTime!
Example
{
  "createdAt": ISO8601DateTime,
  "dueAt": ISO8601DateTime,
  "updatedAt": ISO8601DateTime
}
Objects

CampaignOrderMilestones

Fields
Field Name Description
allocatedAt - ISO8601DateTime
cancelledAt - ISO8601DateTime
completedAt - ISO8601DateTime
createdAt - ISO8601DateTime!
dueAt - ISO8601DateTime
fulfilmentAllocatedAt - ISO8601DateTime
fulfilmentFailedAt - ISO8601DateTime
fulfilmentFulfilledAt - ISO8601DateTime
fulfilmentHeldAt - ISO8601DateTime
fulfilmentOpenedAt - ISO8601DateTime
fulfilmentReturnedAt - ISO8601DateTime
fulfilmentSubmittedAt - ISO8601DateTime
paidAt - ISO8601DateTime
paymentIntentFailedAt - ISO8601DateTime
paymentIntentPaidAt - ISO8601DateTime
paymentIntentPartiallyRefundedAt - ISO8601DateTime
paymentIntentRefundedAt - ISO8601DateTime
paymentIntentSubmittedAt - ISO8601DateTime
retryPaymentAt - ISO8601DateTime
updatedAt - ISO8601DateTime!
Example
{
  "allocatedAt": ISO8601DateTime,
  "cancelledAt": ISO8601DateTime,
  "completedAt": ISO8601DateTime,
  "createdAt": ISO8601DateTime,
  "dueAt": ISO8601DateTime,
  "fulfilmentAllocatedAt": ISO8601DateTime,
  "fulfilmentFailedAt": ISO8601DateTime,
  "fulfilmentFulfilledAt": ISO8601DateTime,
  "fulfilmentHeldAt": ISO8601DateTime,
  "fulfilmentOpenedAt": ISO8601DateTime,
  "fulfilmentReturnedAt": ISO8601DateTime,
  "fulfilmentSubmittedAt": ISO8601DateTime,
  "paidAt": ISO8601DateTime,
  "paymentIntentFailedAt": ISO8601DateTime,
  "paymentIntentPaidAt": ISO8601DateTime,
  "paymentIntentPartiallyRefundedAt": ISO8601DateTime,
  "paymentIntentRefundedAt": ISO8601DateTime,
  "paymentIntentSubmittedAt": ISO8601DateTime,
  "retryPaymentAt": ISO8601DateTime,
  "updatedAt": ISO8601DateTime
}
Objects

Card

Description

A credit/debit card.

Fields
Field Name Description
brand - CardBrand! The card brand.
brandHuman - String!
expired - Boolean!
expiry - CardExpiry! The card expiry.
externalId - String The (optional) external ID of the card.
last4 - String! The last four digits of the card number.
Example
{
  "brand": "AMEX",
  "brandHuman": "xyz789",
  "expired": false,
  "expiry": CardExpiry,
  "externalId": "abc123",
  "last4": "xyz789"
}
Objects

CardExpiry

Description

Card expiry

Fields
Field Name Description
month - Int Expiry month
year - Int Expiry year
Example
{"month": 123, "year": 123}
Objects

Country

Description

Translation missing: en.graphql.objects.country.description

Fields
Field Name Description
cityLabel - String! Translation missing: en.graphql.objects.country.fields.city_label
code - CountryCode! Translation missing: en.graphql.objects.country.fields.code
emojiFlag - String Translation missing: en.graphql.objects.country.fields.emoji_flag
internationalPhoneCode - Int Translation missing: en.graphql.objects.country.fields.international_phone_code
name - String! Translation missing: en.graphql.objects.country.fields.name
postcodeLabel - String! Translation missing: en.graphql.objects.country.fields.postcode_label
presentProvinces - Boolean! Translation missing: en.graphql.objects.country.fields.present_provinces
presentableProvinces - [Province!] Translation missing: en.graphql.objects.country.fields.presentable_provinces
provinceLabel - String! Translation missing: en.graphql.objects.country.fields.province_label
provinces - [Province!] Translation missing: en.graphql.objects.country.fields.provinces
Example
{
  "cityLabel": "abc123",
  "code": "AC",
  "emojiFlag": "xyz789",
  "internationalPhoneCode": 987,
  "name": "abc123",
  "postcodeLabel": "abc123",
  "presentProvinces": false,
  "presentableProvinces": [Province],
  "provinceLabel": "xyz789",
  "provinces": [Province]
}
Objects

Customer

Description

Translation missing: en.graphql.objects.customer.description

Fields
Field Name Description
channel - Channel! Translation missing: en.graphql.objects.customer.fields.channel
email - Email Translation missing: en.graphql.objects.customer.fields.email
externalId - ID! Translation missing: en.graphql.objects.customer.fields.external_id
firstName - String Translation missing: en.graphql.objects.customer.fields.first_name
id - GlobalID! The customer's ID.
lastName - String Translation missing: en.graphql.objects.customer.fields.last_name
phone - PhoneNumber Translation missing: en.graphql.objects.customer.fields.phone
status - CustomerStatus! Translation missing: en.graphql.objects.customer.fields.status
taxable - Boolean! Translation missing: en.graphql.objects.customer.fields.taxable
verifiedEmail - Boolean! Translation missing: en.graphql.objects.customer.fields.verified_email
notifications - NotificationConnection Notifications relevant to this customer
Arguments
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.
campaignOrdersCount - Int The number of campaign orders the customer has.
subscriptionsCount - Count! Translation missing: en.graphql.objects.customer.fields.subscriptions_count
Example
{
  "channel": Channel,
  "email": Email,
  "externalId": "4",
  "firstName": "xyz789",
  "id": GlobalID,
  "lastName": "abc123",
  "phone": "+17895551234",
  "status": "ACTIVE",
  "taxable": true,
  "verifiedEmail": true,
  "notifications": NotificationConnection,
  "campaignOrdersCount": 123,
  "subscriptionsCount": Count
}
Objects

DeliveryProfile

Description

Translation missing: en.graphql.objects.delivery_profile.description

Fields
Field Name Description
createdAt - Timestamp Translation missing: en.graphql.objects.delivery_profile.fields.created_at
deliveryZones - [DeliveryProfileZone!]! Translation missing: en.graphql.objects.delivery_profile.fields.delivery_zones
externalId - ID Translation missing: en.graphql.objects.delivery_profile.fields.external_id
id - GlobalID! Translation missing: en.graphql.objects.delivery_profile.fields.id
name - String! Translation missing: en.graphql.objects.delivery_profile.fields.name
restOfWorld - Boolean! Translation missing: en.graphql.objects.delivery_profile.fields.rest_of_world
status - DeliveryProfileStatus! Translation missing: en.graphql.objects.delivery_profile.fields.status
updatedAt - Timestamp Translation missing: en.graphql.objects.delivery_profile.fields.updated_at
Example
{
  "createdAt": 1592577642,
  "deliveryZones": [DeliveryProfileZone],
  "externalId": "4",
  "id": GlobalID,
  "name": "xyz789",
  "restOfWorld": false,
  "status": "ACTIVE",
  "updatedAt": 1592577642
}
Objects

DeliveryProfileZone

Description

Translation missing: en.graphql.objects.delivery_profile_zone.description

Fields
Field Name Description
countryCode - CountryCode! Translation missing: en.graphql.objects.delivery_profile_zone.fields.country_code
provinceCodes - [ProvinceCode!]! Translation missing: en.graphql.objects.delivery_profile_zone.fields.province_codes
Example
{"countryCode": "AC", "provinceCodes": [ProvinceCode]}
Objects

DeliverySlot

Fields
Field Name Description
deliverAt - Timestamp!
Example
{"deliverAt": 1592577642}
Objects

DiscountFinancials

Fields
Field Name Description
breakdown - [DiscountLine!]!
total - Money!
Example
{
  "breakdown": [DiscountLine],
  "total": Money
}
Objects

DiscountLine

Fields
Field Name Description
price - Money!
title - String
type - DiscountType
Example
{
  "price": Money,
  "title": "abc123",
  "type": "AUTOMATIC"
}
Objects

ExternalToken

Description

external token

Fields
Field Name Description
id - GlobalID! id
primary - Boolean! primary
status - TokenStatus! status
target - TokenTarget! target
token - RedactedString! token
Example
{
  "id": GlobalID,
  "primary": true,
  "status": "ACTIVE",
  "target": "ANY",
  "token": RedactedString
}
Objects

InventoryApplication

Description

The inventory application of a campaign.

Fields
Field Name Description
campaignInventoryItem - CampaignInventoryItem! The parent inventory item
createdAt - ISO8601DateTime! The creation time
id - GlobalID! The id of the inventory application
quantityAllocated - Int! Number of units that have been allocated to orders
quantityReceived - Int! Number of units that have been received
sequentialId - Int! The ordered ID of the inventory application.
Example
{
  "campaignInventoryItem": CampaignInventoryItem,
  "createdAt": ISO8601DateTime,
  "id": GlobalID,
  "quantityAllocated": 987,
  "quantityReceived": 987,
  "sequentialId": 987
}
Objects

LineItem

Description

A line item.

Fields
Field Name Description
externalId - String! The line item's external ID.
id - GlobalID! The line item's ID.
order - Order! The order that this line item belongs to.
product - Product The product.
productVariant - ProductVariant The product variant.
Example
{
  "externalId": "xyz789",
  "id": GlobalID,
  "order": Order,
  "product": Product,
  "productVariant": ProductVariant
}
Objects

MailingAddress

Description

An organisation's mailing address.

Fields
Field Name Description
address1 - String! Line 1 of mailing address .
address2 - String Line 2 of mailing address.
city - String! The name of the city, district, village, or town.
company - String The name of the organisation's company.
country - String! The name of the country.
countryCode - CountryCode! The two-letter code for the country of the address.
phone - String Phone number
province - String The region of the address
provinceCode - String The code for the region of the address
zip - String! The zip or postal code of the address.
Example
{
  "address1": "abc123",
  "address2": "abc123",
  "city": "abc123",
  "company": "abc123",
  "country": "xyz789",
  "countryCode": "AC",
  "phone": "xyz789",
  "province": "abc123",
  "provinceCode": "xyz789",
  "zip": "xyz789"
}
Objects

Money

Description

A money object.

Fields
Field Name Description
amount - String! The money object's amount.
currency - CurrencyCode! The money object's currency code.
Example
{"amount": "xyz789", "currency": "AED"}
Objects

Notification

Description

A notification.

Fields
Field Name Description
channel - Channel! The channel this notification belongs to.
createdAt - ISO8601DateTime! The time the notification was created
customer - Customer! The customer this notification is for.
deliveredAt - ISO8601DateTime The time the notification was delivered
deliveryFailedAt - ISO8601DateTime The time the notification failed delivery
deliveryMechanism - NotificationDeliveryMechanism! The delivery mechanism.
deliveryStatus - NotificationDeliveryStatus! The delivery status.
errorMessage - String A notification delivery error message.
event - String! The event to notify
id - GlobalID! The notification's ID.
payload - JSON! The payload.
scheduledNotification - ScheduledNotification The scheduled notification that triggered this notification
updatedAt - ISO8601DateTime! The time the notification was last updated
Example
{
  "channel": Channel,
  "createdAt": ISO8601DateTime,
  "customer": Customer,
  "deliveredAt": ISO8601DateTime,
  "deliveryFailedAt": ISO8601DateTime,
  "deliveryMechanism": "EMAIL",
  "deliveryStatus": "FAILED",
  "errorMessage": "abc123",
  "event": "xyz789",
  "id": GlobalID,
  "payload": {},
  "scheduledNotification": ScheduledNotification,
  "updatedAt": ISO8601DateTime
}
Objects

NotificationSchedule

Description

A notification schedule.

Fields
Field Name Description
anchor - ISO8601DateTime! The schedule's anchor date.
channel - Channel! The channel this notification schedule belongs to.
createdAt - ISO8601DateTime! The time the notification schedule was created
customer - Customer! The customer this notification schedule is for.
deliveryMechanism - NotificationDeliveryMechanism! The delivery mechanism.
event - String! The event to notify
id - GlobalID! The schedule's ID.
payload - JSON! The payload to deliver.
schedule - [TimeOffset!]! The schedule.
scheduledNotifications - ScheduledNotificationConnection The scheduled notifications
Arguments
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.
updatedAt - ISO8601DateTime! The time the notification schedule was last updated
Example
{
  "anchor": ISO8601DateTime,
  "channel": Channel,
  "createdAt": ISO8601DateTime,
  "customer": Customer,
  "deliveryMechanism": "EMAIL",
  "event": "abc123",
  "id": GlobalID,
  "payload": {},
  "schedule": [TimeOffset],
  "scheduledNotifications": ScheduledNotificationConnection,
  "updatedAt": ISO8601DateTime
}
Objects

NotificationScheduleTemplate

Description

A notification schedule template.

Fields
Field Name Description
schedule - [TimeOffset!]! The schedule.
trigger - NotificationScheduleTrigger! The trigger event that the notification schedule is anchored to.
Example
{"schedule": [TimeOffset], "trigger": "CROWDFUND_END_AT"}
Objects

NotificationsConfig

Description

Channel configuration for Submarine notifications.

Fields
Field Name Description
emailCustomerWhenCampaignDueDateIsUpdated - Boolean
emailCustomerWhenCampaignIsOrdered - Boolean
emailMerchantOnWebhookFailure - Boolean
emailMerchantWhenCampaignOrderCannotBeFulfilled - Boolean
notificationSchedules - [NotificationScheduleTemplate!]
Example
{
  "emailCustomerWhenCampaignDueDateIsUpdated": true,
  "emailCustomerWhenCampaignIsOrdered": true,
  "emailMerchantOnWebhookFailure": false,
  "emailMerchantWhenCampaignOrderCannotBeFulfilled": true,
  "notificationSchedules": [NotificationScheduleTemplate]
}
Objects

Order

Description

An order.

Fields
Field Name Description
channel - Channel! The order's channel.
externalId - String! The order's external ID.
id - GlobalID! The order's ID.
lineItems - [LineItem!]! The order's line items.
name - String The order's name.
Example
{
  "channel": Channel,
  "externalId": "abc123",
  "id": GlobalID,
  "lineItems": [LineItem],
  "name": "abc123"
}
Objects

PageInfo

Description

Pagination details for a connection.

Fields
Field Name Description
endCursor - String When paginating forwards, the cursor to continue.
hasNextPage - Boolean! When paginating forwards, are there more items?
hasPreviousPage - Boolean! When paginating backwards, are there more items?
startCursor - String When paginating backwards, the cursor to continue.
Example
{
  "endCursor": "abc123",
  "hasNextPage": true,
  "hasPreviousPage": false,
  "startCursor": "abc123"
}
Objects

PaymentInstrument

Description

A Submarine payment instrument.

Fields
Field Name Description
active - Boolean!
createdAt - ISO8601DateTime! The date and time when the payment instrument was created.
description - String
externalId - String The (optional) external ID of the instrument.
externalReference - String An optional reference to the external payment processor.
id - GlobalID! The ID of the payment instrument.
manuallyCapturable - Boolean! Whether payment can be captured manually.
metadata - Metadata Unstructured key/value pairs.
paymentInstrumentType - PaymentInstrumentType! The payment instrument's type.
paymentMethod - PaymentMethod! The parent payment method.
paymentProcessor - PaymentProcessor! The payment processor to be used for this instrument.
paymentSource - PaymentSource The source of the payment instrument.
updatedAt - ISO8601DateTime The date and time when the payment instrument was last updated.
Example
{
  "active": false,
  "createdAt": ISO8601DateTime,
  "description": "abc123",
  "externalId": "xyz789",
  "externalReference": "xyz789",
  "id": GlobalID,
  "manuallyCapturable": false,
  "metadata": Metadata,
  "paymentInstrumentType": "CARD",
  "paymentMethod": PaymentMethod,
  "paymentProcessor": PaymentProcessor,
  "paymentSource": Card,
  "updatedAt": ISO8601DateTime
}
Objects

PaymentIntentAdjustment

Description

A payment intent adjustment

Fields
Field Name Description
amount - Money The amount to adjust the payment intent by
createdAt - ISO8601DateTime! payment intent adjustment creation time
description - String Description of the payment intent adjustment
id - GlobalID! ID of the payment intent adjustment
metadata - Metadata Unstructured key/value pairs
paymentIntent - PaymentIntent! The associated payment intent
updatedAt - ISO8601DateTime payment intent adjustment last updated at
Example
{
  "amount": Money,
  "createdAt": ISO8601DateTime,
  "description": "xyz789",
  "id": GlobalID,
  "metadata": Metadata,
  "paymentIntent": PaymentIntent,
  "updatedAt": ISO8601DateTime
}
Objects

PaymentProcessor

Description

A payment processor

Fields
Field Name Description
id - GlobalID! ID of the payment processor
name - String! Name of the payment processor
Example
{
  "id": GlobalID,
  "name": "abc123"
}
Objects

PaypalBillingAgreement

Description

A Paypal billing agreement.

Fields
Field Name Description
accountEmail - String The account email.
accountName - String! The account name.
externalId - String The (optional) external ID of the agreement.
Example
{
  "accountEmail": "abc123",
  "accountName": "abc123",
  "externalId": "xyz789"
}
Objects

PlatformConfig

Description

Channel configuration for Submarine.

Fields
Field Name Description
notifications - NotificationsConfig
presales - PresalesConfig
pricing - PricingConfig
subscriptions - SubscriptionsConfig
Example
{
  "notifications": NotificationsConfig,
  "presales": PresalesConfig,
  "pricing": PricingConfig,
  "subscriptions": SubscriptionsConfig
}
Objects

PresalesConfig

Description

Channel configuration for Submarine presales.

Fields
Field Name Description
allowDepositUpdatesOnLaunchedPresales - Boolean
campaignPaymentTermsAlignment - CampaignPaymentTermsAlignment
defaultCurrency - CurrencyCode
defaultPresaleDeposit - CampaignDeposit
defaultPresaleInventoryPolicy - PresaleInventoryPolicy
metafieldUpdateInterval - Int
refundPresalesDepositsOnCancellation - Boolean
templateForCrowdfundSellingPlanDescription - String
templateForCrowdfundSellingPlanName - String
templateForPresaleSellingPlanDescription - String
templateForPresaleSellingPlanName - String
templateForSellingPlanDescription - String
templateForSellingPlanName - String
Example
{
  "allowDepositUpdatesOnLaunchedPresales": false,
  "campaignPaymentTermsAlignment": "FIRST_CAMPAIGN",
  "defaultCurrency": "AED",
  "defaultPresaleDeposit": CampaignDeposit,
  "defaultPresaleInventoryPolicy": "ON_FULFILMENT",
  "metafieldUpdateInterval": 123,
  "refundPresalesDepositsOnCancellation": false,
  "templateForCrowdfundSellingPlanDescription": "abc123",
  "templateForCrowdfundSellingPlanName": "xyz789",
  "templateForPresaleSellingPlanDescription": "xyz789",
  "templateForPresaleSellingPlanName": "abc123",
  "templateForSellingPlanDescription": "abc123",
  "templateForSellingPlanName": "abc123"
}
Objects

PricingConfig

Description

Channel configuration for Submarine pricing.

Fields
Field Name Description
defaultPriceEngine - PriceEngineProvider
defaultPriceEnginePolicy - PriceEnginePolicy
moneyRoundingMode - MoneyRoundingMode
shippingTaxable - Boolean
taxBehaviour - TaxBehaviour
Example
{
  "defaultPriceEngine": "SHOPIFY",
  "defaultPriceEnginePolicy": "ALWAYS",
  "moneyRoundingMode": "ROUND_CEILING",
  "shippingTaxable": true,
  "taxBehaviour": "EXCLUSIVE"
}
Objects

ProductCollection

Description

A product collection.

Fields
Field Name Description
channel - Channel! The product collection's channel.
externalId - String! The product collection's external ID.
id - GlobalID! The product collection's ID.
imageUrl - String The product collection's image url.
items - [ProductCollectionItem!]! The product collection's items.
productsCount - Int!
status - ProductCollectionStatus! The product collection's status.
title - String The product collection's title.
Example
{
  "channel": Channel,
  "externalId": "abc123",
  "id": GlobalID,
  "imageUrl": "abc123",
  "items": [ProductCollectionItem],
  "productsCount": 987,
  "status": "DELETED",
  "title": "xyz789"
}
Objects

ProductCollectionItem

Description

A product collection item.

Fields
Field Name Description
externalId - String The item's external ID.
id - GlobalID! The item's ID.
product - Product The product this item belongs to.
productCollection - ProductCollection! The product collection this item belongs to.
status - ProductCollectionItemStatus! The item's status.
Example
{
  "externalId": "xyz789",
  "id": GlobalID,
  "product": Product,
  "productCollection": ProductCollection,
  "status": "ACTIVE"
}
Objects

Province

Description

Translation missing: en.graphql.objects.province.description

Fields
Field Name Description
code - ProvinceCode Translation missing: en.graphql.objects.province.fields.code
name - String Translation missing: en.graphql.objects.province.fields.name
type - ProvinceType Translation missing: en.graphql.objects.province.fields.type
Example
{
  "code": ProvinceCode,
  "name": "abc123",
  "type": "ADMINISTRATION"
}
Objects

ScheduledNotification

Description

A scheduled notification.

Fields
Field Name Description
channel - Channel! The channel this scheduled notification belongs to.
createdAt - ISO8601DateTime! The time the scheduled notification was created
customer - Customer! The customer this scheduled notification is for.
deliverAt - ISO8601DateTime! The delivery date.
enqueuedAt - ISO8601DateTime! The date the notification was enqueued for delivery.
id - GlobalID! The scheduled notification's ID.
notificationSchedule - NotificationSchedule! The parent notification schedule.
status - ScheduledNotificationStatus! The status
updatedAt - ISO8601DateTime! The time the scheduled notification was last updated
Example
{
  "channel": Channel,
  "createdAt": ISO8601DateTime,
  "customer": Customer,
  "deliverAt": ISO8601DateTime,
  "enqueuedAt": ISO8601DateTime,
  "id": GlobalID,
  "notificationSchedule": NotificationSchedule,
  "status": "DELETED",
  "updatedAt": ISO8601DateTime
}
Objects

ShippingFinancials

Fields
Field Name Description
breakdown - [ShippingLine!]!
total - Money!
Example
{
  "breakdown": [ShippingLine],
  "total": Money
}
Objects

ShippingLine

Fields
Field Name Description
code - String!
price - Money!
source - String!
title - String!
Example
{
  "code": "xyz789",
  "price": Money,
  "source": "abc123",
  "title": "xyz789"
}
Objects

ShopifyCredentials

Description

Shopify credentials

Fields
Field Name Description
createdAt - ISO8601DateTime! Shopify credentials creation time
id - GlobalID! The Shopify credentials's ID.
updatedAt - ISO8601DateTime! Shopify credentials update time
Example
{
  "createdAt": ISO8601DateTime,
  "id": GlobalID,
  "updatedAt": ISO8601DateTime
}
Objects

SubscriptionAnchor

Description

Translation missing: en.graphql.objects.subscription_anchor.description

Fields
Field Name Description
day - Count Translation missing: en.graphql.objects.subscription_anchor.fields.day
description - String! Translation missing: en.graphql.objects.subscription_anchor.fields.description
externalId - String! Translation missing: en.graphql.objects.subscription_anchor.fields.external_id
id - GlobalID! Translation missing: en.graphql.objects.subscription_anchor.fields.id
month - Subscription Translation missing: en.graphql.objects.subscription_anchor.fields.month
name - String! Translation missing: en.graphql.objects.subscription_anchor.fields.name
schedule - [DeliverySlot!]!
Arguments
first - NonZeroCount!
time - Timestamp Translation missing: en.graphql.objects.subscription_anchor.fields.time
type - SubscriptionAnchorType! Translation missing: en.graphql.objects.subscription_anchor.fields.type
Example
{
  "day": Count,
  "description": "xyz789",
  "externalId": "xyz789",
  "id": GlobalID,
  "month": Subscription,
  "name": "xyz789",
  "schedule": [DeliverySlot],
  "time": 1592577642,
  "type": "FLEXIBLE"
}
Objects

SubscriptionBacklogSize

Description

Translation missing: en.graphql.objects.subscription_backlog_size.description

Fields
Field Name Description
interval - SubscriptionBacklogInterval! Translation missing: en.graphql.objects.subscription_backlog_size.fields.interval
intervalCount - Int! Translation missing: en.graphql.objects.subscription_backlog_size.fields.interval_count
Example
{"interval": "CYCLE", "intervalCount": 123}
Objects

SubscriptionBillingBehaviour

Fields
Field Name Description
billingOffset - SubscriptionOffset
processingOffset - SubscriptionOffset
Example
{
  "billingOffset": SubscriptionOffset,
  "processingOffset": SubscriptionOffset
}
Objects

SubscriptionDeliveryBehaviour

Fields
Field Name Description
fixed - SubscriptionFixedDeliveryBehaviour!
type - SubscriptionDeliveryBehaviourType!
Example
{
  "fixed": SubscriptionFixedDeliveryBehaviour,
  "type": "FIXED"
}
Objects

SubscriptionDeliveryMethodShipping

Fields
Field Name Description
address - Address
shippingOption - SubscriptionDeliveryShippingOption
Example
{
  "address": Address,
  "shippingOption": SubscriptionDeliveryShippingOption
}
Objects

SubscriptionDeliveryShippingOption

Description

Translation missing: en.graphql.objects.subscription_delivery_shipping_option.description

Fields
Field Name Description
code - String! Translation missing: en.graphql.objects.subscription_delivery_shipping_option.fields.code
description - String Translation missing: en.graphql.objects.subscription_delivery_shipping_option.fields.description
handle - String Translation missing: en.graphql.objects.subscription_delivery_shipping_option.fields.handle
source - String! Translation missing: en.graphql.objects.subscription_delivery_shipping_option.fields.source
title - String! Translation missing: en.graphql.objects.subscription_delivery_shipping_option.fields.title
Example
{
  "code": "xyz789",
  "description": "abc123",
  "handle": "xyz789",
  "source": "xyz789",
  "title": "xyz789"
}
Objects

SubscriptionEvent

Description

Translation missing: en.graphql.objects.subscription_event.description

Fields
Field Name Description
action - SubscriptionEventAction! Translation missing: en.graphql.objects.subscription_event.fields.action
createdAt - Timestamp! Translation missing: en.graphql.objects.subscription_event.fields.created_at
description - String Translation missing: en.graphql.objects.subscription_event.fields.description
id - GlobalID! Translation missing: en.graphql.objects.subscription_event.fields.id
Example
{
  "action": "ARCHIVE",
  "createdAt": 1592577642,
  "description": "xyz789",
  "id": GlobalID
}
Objects

SubscriptionFixedDeliveryBehaviour

Fields
Field Name Description
cutoff - SubscriptionOffset
preAnchorBehaviour - SubscriptionDeliveryPreAnchorBehaviourType
Example
{
  "cutoff": SubscriptionOffset,
  "preAnchorBehaviour": "ASAP"
}
Objects

SubscriptionFrequency

Description

Translation missing: en.graphql.objects.subscription_frequency.description

Fields
Field Name Description
description - String
interval - SubscriptionInterval! Translation missing: en.graphql.objects.subscription_frequency.fields.interval
intervalCount - NonZeroCount! Translation missing: en.graphql.objects.subscription_frequency.fields.interval_count
maxCycles - NonZeroCount Translation missing: en.graphql.objects.subscription_frequency.fields.max_cycles
minCycles - NonZeroCount Translation missing: en.graphql.objects.subscription_frequency.fields.min_cycles
Example
{
  "description": "xyz789",
  "interval": "DAY",
  "intervalCount": NonZeroCount,
  "maxCycles": NonZeroCount,
  "minCycles": NonZeroCount
}
Objects

SubscriptionInventoryBehaviour

Fields
Field Name Description
inventoryDecrementPolicy - SubscriptionInventoryDecrementPolicy!
outOfStockPolicy - SubscriptionInventoryOutOfStockPolicy!
Example
{"inventoryDecrementPolicy": "NONE", "outOfStockPolicy": "PAUSE_SUBSCRIPTION"}
Objects

SubscriptionLine

Description

Translation missing: en.graphql.objects.subscription_line.description

Fields
Field Name Description
basePrice - Money! Translation missing: en.graphql.objects.subscription_line.fields.base_price
createdAt - Timestamp! Translation missing: en.graphql.objects.subscription_line.fields.created_at
customised - Boolean! Translation missing: en.graphql.objects.subscription_line.fields.customised
id - GlobalID! Translation missing: en.graphql.objects.subscription_line.fields.id
product - Product! Translation missing: en.graphql.objects.subscription_line.fields.product
productVariant - ProductVariant! Translation missing: en.graphql.objects.subscription_line.fields.product_variant
quantity - Count! Translation missing: en.graphql.objects.subscription_line.fields.quantity
subscription - Subscription! Translation missing: en.graphql.objects.subscription_line.fields.subscription
updatedAt - Timestamp! Translation missing: en.graphql.objects.subscription_line.fields.updated_at
Example
{
  "basePrice": Money,
  "createdAt": 1592577642,
  "customised": false,
  "id": GlobalID,
  "product": Product,
  "productVariant": ProductVariant,
  "quantity": Count,
  "subscription": Subscription,
  "updatedAt": 1592577642
}
Objects

SubscriptionOffset

Fields
Field Name Description
interval - SubscriptionOffsetInterval!
intervalCount - Int!
type - SubscriptionOffsetType!
Example
{"interval": "DAY", "intervalCount": 123, "type": "BUSINESS"}
Objects

SubscriptionOrderFinancials

Description

The financial details of a subscription order.

Fields
Field Name Description
currency - CurrencyCode!
discounts - DiscountFinancials!
shipping - ShippingFinancials!
subtotal - Money!
tax - TaxFinancials!
totalPrice - Money!
Example
{
  "currency": "AED",
  "discounts": DiscountFinancials,
  "shipping": ShippingFinancials,
  "subtotal": Money,
  "tax": TaxFinancials,
  "totalPrice": Money
}
Objects

SubscriptionOrderLine

Description

Translation missing: en.graphql.objects.subscription_order_line.description

Fields
Field Name Description
createdAt - Timestamp! Translation missing: en.graphql.objects.subscription_order_line.fields.created_at
customised - Boolean! Translation missing: en.graphql.objects.subscription_order_line.fields.customised
financials - SubscriptionOrderLineFinancials
id - GlobalID! Translation missing: en.graphql.objects.subscription_order_line.fields.id
lineItem - LineItem Translation missing: en.graphql.objects.subscription_order_line.fields.line_item
lineType - SubscriptionOrderLineType! Translation missing: en.graphql.objects.subscription_order_line.fields.line_type
product - Product! Translation missing: en.graphql.objects.subscription_order_line.fields.product
productVariant - ProductVariant! Translation missing: en.graphql.objects.subscription_order_line.fields.product_variant
quantity - Count! Translation missing: en.graphql.objects.subscription_order_line.fields.quantity
subscriptionLine - SubscriptionLine Translation missing: en.graphql.objects.subscription_order_line.fields.subscription_line
subscriptionOrder - SubscriptionOrder! Translation missing: en.graphql.objects.subscription_order_line.fields.subscription_order
updatedAt - Timestamp! Translation missing: en.graphql.objects.subscription_order_line.fields.updated_at
Example
{
  "createdAt": 1592577642,
  "customised": false,
  "financials": SubscriptionOrderLineFinancials,
  "id": GlobalID,
  "lineItem": LineItem,
  "lineType": "ONE_OFF",
  "product": Product,
  "productVariant": ProductVariant,
  "quantity": Count,
  "subscriptionLine": SubscriptionLine,
  "subscriptionOrder": SubscriptionOrder,
  "updatedAt": 1592577642
}
Objects

SubscriptionOrderLineFinancials

Fields
Field Name Description
currency - CurrencyCode!
discounts - DiscountFinancials!
linePrice - Money!
Arguments
afterDiscounts - Boolean
afterTax - Boolean
tax - TaxFinancials!
unitPrice - Money!
Arguments
afterDiscounts - Boolean
afterTax - Boolean
Example
{
  "currency": "AED",
  "discounts": DiscountFinancials,
  "linePrice": Money,
  "tax": TaxFinancials,
  "unitPrice": Money
}
Objects

SubscriptionPriceDiscount

Fields
Field Name Description
afterCycle - Count
value - SubscriptionPriceDiscountValue
valueCap - SubscriptionPriceDiscountValueCap
Example
{
  "afterCycle": Count,
  "value": SubscriptionPriceDiscountValue,
  "valueCap": SubscriptionPriceDiscountValueCap
}
Objects

SubscriptionPriceDiscountValue

Fields
Field Name Description
fixedAmount - Money
percentage - Percentage
type - SubscriptionPriceDiscountType
Example
{
  "fixedAmount": Money,
  "percentage": Percentage,
  "type": "FIXED_AMOUNT"
}
Objects

SubscriptionPriceDiscountValueCap

Fields
Field Name Description
cap - Money
type - SubscriptionPriceDiscountValueCapType
Example
{"cap": Money, "type": "INDIVIDUAL_ITEM"}
Objects

SubscriptionPricingBehaviour

Fields
Field Name Description
basePrice - Money
basePricePolicy - SubscriptionBasePricePolicy!
discounts - [SubscriptionPriceDiscount!]
Example
{
  "basePrice": Money,
  "basePricePolicy": "CUSTOM",
  "discounts": [SubscriptionPriceDiscount]
}
Objects

SubscriptionProductGroup

Fields
Field Name Description
id - GlobalID!
itemSources - [SubscriptionProductGroupItemSource!]
Example
{
  "id": GlobalID,
  "itemSources": [SubscriptionProductGroupItemSource]
}
Objects

SubscriptionProductGroupItem

Fields
Field Name Description
id - GlobalID!
itemSource - SubscriptionProductGroupItemSource!
productGroup - SubscriptionProductGroup!
resource - SubscriptionProductGroupItemResource!
status - SubscriptionProductGroupItemStatus!
Example
{
  "id": GlobalID,
  "itemSource": SubscriptionProductGroupItemSource,
  "productGroup": SubscriptionProductGroup,
  "resource": Product,
  "status": "ACTIVE"
}
Objects

SubscriptionProductGroupItemSource

Fields
Field Name Description
id - GlobalID!
items - [SubscriptionProductGroupItem!]
productGroup - SubscriptionProductGroup!
resource - SubscriptionProductGroupItemSourceResource!
status - SubscriptionProductGroupItemSourceStatus!
subscriptionLinesCount - Int!
subscriptionsCount - Int!
Example
{
  "id": GlobalID,
  "items": [SubscriptionProductGroupItem],
  "productGroup": SubscriptionProductGroup,
  "resource": Product,
  "status": "ACTIVE",
  "subscriptionLinesCount": 123,
  "subscriptionsCount": 123
}
Objects

SubscriptionRetryPolicy

Description

Translation missing: en.graphql.objects.subscription_retry_policy.description

Fields
Field Name Description
interval - SubscriptionRetryInterval! Translation missing: en.graphql.objects.subscription_retry_policy.fields.interval
intervalCount - Int! Translation missing: en.graphql.objects.subscription_retry_policy.fields.interval_count
maxAttempts - Int! Translation missing: en.graphql.objects.subscription_retry_policy.fields.max_attempts
Example
{"interval": "DAY", "intervalCount": 123, "maxAttempts": 987}
Objects

SubscriptionsConfig

Description

Channel configuration for Submarine subscriptions.

Fields
Field Name Description
defaultPaymentRetryPolicy - SubscriptionRetryPolicy
defaultSubscriptionBacklogSize - SubscriptionBacklogSize
permittedFrequencyIntervals - [SubscriptionInterval!]
permittedRetryIntervals - [SubscriptionRetryInterval!]
processSubscriptionOrders - Boolean
subscriptionEngine - SubscriptionEngine
Example
{
  "defaultPaymentRetryPolicy": SubscriptionRetryPolicy,
  "defaultSubscriptionBacklogSize": SubscriptionBacklogSize,
  "permittedFrequencyIntervals": ["DAY"],
  "permittedRetryIntervals": ["DAY"],
  "processSubscriptionOrders": false,
  "subscriptionEngine": "NOOP"
}
Objects

TaxFinancials

Fields
Field Name Description
behaviour - TaxBehaviour!
breakdown - [TaxLine!]!
total - Money!
Example
{
  "behaviour": "EXCLUSIVE",
  "breakdown": [TaxLine],
  "total": Money
}
Objects

TaxLine

Fields
Field Name Description
price - Money!
rate - Float!
title - String!
Example
{
  "price": Money,
  "rate": 987.65,
  "title": "abc123"
}
Objects

TimeOffset

Description

A time offset in a notification schedule.

Fields
Field Name Description
direction - TimeOffsetDirection! The direction to offset in.
magnitude - Int! The magnitude to offset by.
unit - TimeOffsetUnit! The unit of time to offset by.
Example
{"direction": "BEFORE", "magnitude": 123, "unit": "DAYS"}
Objects

TotalUnitsCrowdfundingGoal

Description

A total units crowdfunding goal.

Fields
Field Name Description
goalTotalUnits - Int! The campaign's goal total units.
goalType - CrowdfundingGoalType! The campaign's goal type.
Example
{"goalTotalUnits": 123, "goalType": "TOTAL_UNITS"}
Objects

TotalValueCrowdfundingGoal

Description

A total value crowdfunding goal.

Fields
Field Name Description
goalTotalValue - Money! The campaign's goal total value.
goalType - CrowdfundingGoalType! The campaign's goal type.
Example
{"goalTotalValue": Money, "goalType": "TOTAL_UNITS"}
Objects

UserError

Description

A user-readable error.

Fields
Field Name Description
field - [String!]! The path to the input field that caused the error.
message - String! The error message.
Example
{
  "field": ["abc123"],
  "message": "abc123"
}

Payloads

AccessTokenCreatePayload

Description

Autogenerated return type of AccessTokenCreate.

Fields
Field Name Description
accessToken - AccessToken The newly created access token.
userErrors - [UserError!]! A list of errors from interactor.
Example
{
  "accessToken": AccessToken,
  "userErrors": [UserError]
}
Payloads

CampaignOrderCancelPayload

Description

Autogenerated return type of CampaignOrderCancel.

Fields
Field Name Description
campaignOrder - CampaignOrder The cancelled campaign order.
userErrors - [UserError!]! A list of user errors.
Example
{
  "campaignOrder": CampaignOrder,
  "userErrors": [UserError]
}
Payloads

CampaignOrderCreatePayload

Description

Autogenerated return type of CampaignOrderCreate.

Fields
Field Name Description
campaignOrder - CampaignOrder The newly created campaign order.
userErrors - [UserError!]! A list of user errors.
Example
{
  "campaignOrder": CampaignOrder,
  "userErrors": [UserError]
}
Payloads

CampaignOrderDecreaseQuantityPayload

Description

Autogenerated return type of CampaignOrderDecreaseQuantity.

Fields
Field Name Description
campaignOrder - CampaignOrder The updated campaign order.
userErrors - [UserError!]! A list of user errors.
Example
{
  "campaignOrder": CampaignOrder,
  "userErrors": [UserError]
}
Payloads

CampaignOrderGroupCancelPayload

Description

Autogenerated return type of CampaignOrderGroupCancel.

Fields
Field Name Description
campaignOrderGroup - CampaignOrderGroup The cancelled campaign order group.
userErrors - [UserError!]! A list of user errors.
Example
{
  "campaignOrderGroup": CampaignOrderGroup,
  "userErrors": [UserError]
}
Payloads

CampaignOrderGroupCreatePayload

Description

Autogenerated return type of CampaignOrderGroupCreate.

Fields
Field Name Description
campaignOrderGroup - CampaignOrderGroup The newly created campaign order.
userErrors - [UserError!]! A list of user errors.
Example
{
  "campaignOrderGroup": CampaignOrderGroup,
  "userErrors": [UserError]
}
Payloads

CampaignOrderGroupRetryPaymentPayload

Description

Autogenerated return type of CampaignOrderGroupRetryPayment.

Fields
Field Name Description
campaignOrderGroup - CampaignOrderGroup The campaign order group submitted for payment.
userErrors - [UserError!]! A list of user errors.
Example
{
  "campaignOrderGroup": CampaignOrderGroup,
  "userErrors": [UserError]
}
Payloads

CampaignOrderRetryFulfilmentPayload

Description

Autogenerated return type of CampaignOrderRetryFulfilment.

Fields
Field Name Description
campaignOrder - CampaignOrder The campaign order submitted for fulfilment.
userErrors - [UserError!]! A list of user errors.
Example
{
  "campaignOrder": CampaignOrder,
  "userErrors": [UserError]
}
Payloads

CampaignOrderRetryPaymentPayload

Description

Autogenerated return type of CampaignOrderRetryPayment.

Fields
Field Name Description
campaignOrder - CampaignOrder The campaign order submitted for payment.
userErrors - [UserError!]! A list of user errors.
Example
{
  "campaignOrder": CampaignOrder,
  "userErrors": [UserError]
}
Payloads

ChannelConfigSetPayload

Description

Autogenerated return type of ChannelConfigSet.

Fields
Field Name Description
channel - Channel The channel whose config was set.
userErrors - [UserError!]! A list of user errors.
Example
{
  "channel": Channel,
  "userErrors": [UserError]
}
Payloads

ChannelCreatePayload

Description

Autogenerated return type of ChannelCreate.

Fields
Field Name Description
channel - Channel The newly created channel.
userErrors - [UserError!]! A list of user errors.
Example
{
  "channel": Channel,
  "userErrors": [UserError]
}
Payloads

ChannelUpdatePayload

Description

Autogenerated return type of ChannelUpdate.

Fields
Field Name Description
channel - Channel The updated channel.
userErrors - [UserError!]! The list of errors that occurred from executing the mutation.
Example
{
  "channel": Channel,
  "userErrors": [UserError]
}
Payloads

ChargeCapturePayload

Description

Autogenerated return type of ChargeCapture.

Fields
Field Name Description
charge - Charge The newly created charge.
userErrors - [UserError!]! A list of user errors.
Example
{
  "charge": Charge,
  "userErrors": [UserError]
}
Payloads

ChargeRecordPayload

Description

Autogenerated return type of ChargeRecord.

Fields
Field Name Description
charge - Charge The newly created charge.
userErrors - [UserError!]! A list of user errors.
Example
{
  "charge": Charge,
  "userErrors": [UserError]
}
Payloads

CrowdfundingCampaignAddProductVariantsPayload

Description

Autogenerated return type of CrowdfundingCampaignAddProductVariants.

Fields
Field Name Description
crowdfundingCampaign - CrowdfundingCampaign The newly updated crowdfunding campaign.
userErrors - [UserError!]! A list of user errors.
Example
{
  "crowdfundingCampaign": CrowdfundingCampaign,
  "userErrors": [UserError]
}
Payloads

CrowdfundingCampaignAddProductsPayload

Description

Autogenerated return type of CrowdfundingCampaignAddProducts.

Fields
Field Name Description
crowdfundingCampaign - CrowdfundingCampaign The newly updated crowdfunding campaign.
userErrors - [UserError!]! A list of user errors.
Example
{
  "crowdfundingCampaign": CrowdfundingCampaign,
  "userErrors": [UserError]
}
Payloads

CrowdfundingCampaignApplyBulkInventoryPayload

Description

Autogenerated return type of CrowdfundingCampaignApplyBulkInventory.

Fields
Field Name Description
crowdfundingCampaign - CrowdfundingCampaign The crowdfunding campaign for which inventory should be applied.
userErrors - [UserError!]! A list of user errors.
Example
{
  "crowdfundingCampaign": CrowdfundingCampaign,
  "userErrors": [UserError]
}
Payloads

CrowdfundingCampaignApplyInventoryPayload

Description

Autogenerated return type of CrowdfundingCampaignApplyInventory.

Fields
Field Name Description
crowdfundingCampaign - CrowdfundingCampaign The crowdfunding campaign for which inventory has been applied.
userErrors - [UserError!]! A list of user errors.
Example
{
  "crowdfundingCampaign": CrowdfundingCampaign,
  "userErrors": [UserError]
}
Payloads

CrowdfundingCampaignArchivePayload

Description

Autogenerated return type of CrowdfundingCampaignArchive.

Fields
Field Name Description
crowdfundingCampaign - CrowdfundingCampaign The archived crowdfunding campaign.
userErrors - [UserError!]! A list of user errors.
Example
{
  "crowdfundingCampaign": CrowdfundingCampaign,
  "userErrors": [UserError]
}
Payloads

CrowdfundingCampaignCancelPayload

Description

Autogenerated return type of CrowdfundingCampaignCancel.

Fields
Field Name Description
crowdfundingCampaign - CrowdfundingCampaign The Canceled crowdfunding campaign.
userErrors - [UserError!]! A list of user errors.
Example
{
  "crowdfundingCampaign": CrowdfundingCampaign,
  "userErrors": [UserError]
}
Payloads

CrowdfundingCampaignCreatePayload

Description

Autogenerated return type of CrowdfundingCampaignCreate.

Fields
Field Name Description
crowdfundingCampaign - CrowdfundingCampaign The newly created crowdfunding campaign.
userErrors - [UserError!]! A list of user errors.
Example
{
  "crowdfundingCampaign": CrowdfundingCampaign,
  "userErrors": [UserError]
}
Payloads

CrowdfundingCampaignDeletePayload

Description

Autogenerated return type of CrowdfundingCampaignDelete.

Fields
Field Name Description
deletedCrowdfundingCampaignId - GlobalID The ID of the deleted crowdfunding campaign.
userErrors - [UserError!]! A list of user errors.
Example
{
  "deletedCrowdfundingCampaignId": GlobalID,
  "userErrors": [UserError]
}
Payloads

CrowdfundingCampaignEndPayload

Description

Autogenerated return type of CrowdfundingCampaignEnd.

Fields
Field Name Description
crowdfundingCampaign - CrowdfundingCampaign The ended crowdfunding campaign.
userErrors - [UserError!]! A list of user errors.
Example
{
  "crowdfundingCampaign": CrowdfundingCampaign,
  "userErrors": [UserError]
}
Payloads

CrowdfundingCampaignFulfilPayload

Description

Autogenerated return type of CrowdfundingCampaignFulfil.

Fields
Field Name Description
crowdfundingCampaign - CrowdfundingCampaign The fulfilling crowdfunding campaign.
userErrors - [UserError!]! A list of user errors.
Example
{
  "crowdfundingCampaign": CrowdfundingCampaign,
  "userErrors": [UserError]
}
Payloads

CrowdfundingCampaignLaunchPayload

Description

Autogenerated return type of CrowdfundingCampaignLaunch.

Fields
Field Name Description
crowdfundingCampaign - CrowdfundingCampaign The launched crowdfunding campaign.
userErrors - [UserError!]! A list of user errors.
Example
{
  "crowdfundingCampaign": CrowdfundingCampaign,
  "userErrors": [UserError]
}
Payloads

CrowdfundingCampaignRemoveProductVariantsPayload

Description

Autogenerated return type of CrowdfundingCampaignRemoveProductVariants.

Fields
Field Name Description
crowdfundingCampaign - CrowdfundingCampaign The updated crowdfunding campaign.
userErrors - [UserError!]! A list of user errors.
Example
{
  "crowdfundingCampaign": CrowdfundingCampaign,
  "userErrors": [UserError]
}
Payloads

CrowdfundingCampaignRemoveProductsPayload

Description

Autogenerated return type of CrowdfundingCampaignRemoveProducts.

Fields
Field Name Description
crowdfundingCampaign - CrowdfundingCampaign The updated crowdfunding campaign.
userErrors - [UserError!]! A list of user errors.
Example
{
  "crowdfundingCampaign": CrowdfundingCampaign,
  "userErrors": [UserError]
}
Payloads

CrowdfundingCampaignUnarchivePayload

Description

Autogenerated return type of CrowdfundingCampaignUnarchive.

Fields
Field Name Description
crowdfundingCampaign - CrowdfundingCampaign The unarchived crowdfunding campaign.
userErrors - [UserError!]! A list of user errors.
Example
{
  "crowdfundingCampaign": CrowdfundingCampaign,
  "userErrors": [UserError]
}
Payloads

CrowdfundingCampaignUpdatePayload

Description

Autogenerated return type of CrowdfundingCampaignUpdate.

Fields
Field Name Description
crowdfundingCampaign - CrowdfundingCampaign The newly updated crowdfunding campaign.
userErrors - [UserError!]! A list of user errors.
Example
{
  "crowdfundingCampaign": CrowdfundingCampaign,
  "userErrors": [UserError]
}
Payloads

CustomerCreatePayload

Description

Autogenerated return type of CustomerCreate.

Fields
Field Name Description
customer - Customer
userErrors - [UserError!]!
Example
{
  "customer": Customer,
  "userErrors": [UserError]
}
Payloads

CustomerUpdatePayload

Description

Autogenerated return type of CustomerUpdate.

Fields
Field Name Description
customer - Customer
userErrors - [UserError!]!
Example
{
  "customer": Customer,
  "userErrors": [UserError]
}
Payloads

CustomerUpsertPayload

Description

Autogenerated return type of CustomerUpsert.

Fields
Field Name Description
customer - Customer
userErrors - [UserError!]!
Example
{
  "customer": Customer,
  "userErrors": [UserError]
}
Payloads

DeliveryProfileCreatePayload

Description

Autogenerated return type of DeliveryProfileCreate.

Fields
Field Name Description
deliveryProfile - DeliveryProfile
userErrors - [UserError!]!
Example
{
  "deliveryProfile": DeliveryProfile,
  "userErrors": [UserError]
}
Payloads

DeliveryProfileDeletePayload

Description

Autogenerated return type of DeliveryProfileDelete.

Fields
Field Name Description
deletedDeliveryProfileId - GlobalID
userErrors - [UserError!]!
Example
{
  "deletedDeliveryProfileId": GlobalID,
  "userErrors": [UserError]
}
Payloads

DeliveryProfileUpdatePayload

Description

Autogenerated return type of DeliveryProfileUpdate.

Fields
Field Name Description
deliveryProfile - DeliveryProfile
userErrors - [UserError!]!
Example
{
  "deliveryProfile": DeliveryProfile,
  "userErrors": [UserError]
}
Payloads

ExternalTokenCreatePayload

Description

Autogenerated return type of ExternalTokenCreate.

Fields
Field Name Description
externalToken - ExternalToken The newly added token.
userErrors - [UserError!]! A list of user errors.
Example
{
  "externalToken": ExternalToken,
  "userErrors": [UserError]
}
Payloads

ExternalTokenRevokePayload

Description

Autogenerated return type of ExternalTokenRevoke.

Fields
Field Name Description
externalToken - ExternalToken The revoked token.
userErrors - [UserError!]! A list of user errors.
Example
{
  "externalToken": ExternalToken,
  "userErrors": [UserError]
}
Payloads

NotificationScheduleCreatePayload

Description

Autogenerated return type of NotificationScheduleCreate.

Fields
Field Name Description
notificationSchedule - NotificationSchedule The newly created notification schedule.
userErrors - [UserError!]! A list of user errors.
Example
{
  "notificationSchedule": NotificationSchedule,
  "userErrors": [UserError]
}
Payloads

NotificationScheduleDeletePayload

Description

Autogenerated return type of NotificationScheduleDelete.

Fields
Field Name Description
deletedNotificationScheduleId - GlobalID The ID of the deleted notification schedule.
userErrors - [UserError!]! A list of user errors.
Example
{
  "deletedNotificationScheduleId": GlobalID,
  "userErrors": [UserError]
}
Payloads

NotificationScheduleUpdatePayload

Description

Autogenerated return type of NotificationScheduleUpdate.

Fields
Field Name Description
notificationSchedule - NotificationSchedule The updated notification schedule.
userErrors - [UserError!]! A list of user errors.
Example
{
  "notificationSchedule": NotificationSchedule,
  "userErrors": [UserError]
}
Payloads

OrderCreatePayload

Description

Autogenerated return type of OrderCreate.

Fields
Field Name Description
order - Order The newly created order.
userErrors - [UserError!]! A list of user errors.
Example
{
  "order": Order,
  "userErrors": [UserError]
}
Payloads

OrderUpdatePayload

Description

Autogenerated return type of OrderUpdate.

Fields
Field Name Description
order - Order The updated order.
userErrors - [UserError!]! A list of user errors.
Example
{
  "order": Order,
  "userErrors": [UserError]
}
Payloads

OrderUpsertPayload

Description

Autogenerated return type of OrderUpsert.

Fields
Field Name Description
order - Order The newly upserted order.
userErrors - [UserError!]! A list of user errors.
Example
{
  "order": Order,
  "userErrors": [UserError]
}
Payloads

OrganisationCreatePayload

Description

Autogenerated return type of OrganisationCreate.

Fields
Field Name Description
organisation - Organisation The newly created organisation.
userErrors - [UserError!]! A list of user errors.
Example
{
  "organisation": Organisation,
  "userErrors": [UserError]
}
Payloads

OrganisationUpdatePayload

Description

Autogenerated return type of OrganisationUpdate.

Fields
Field Name Description
organisation - Organisation The newly updated organisation.
userErrors - [UserError!]! A list of user errors.
Example
{
  "organisation": Organisation,
  "userErrors": [UserError]
}
Payloads

PaymentIntentAdjustmentCreatePayload

Description

Autogenerated return type of PaymentIntentAdjustmentCreate.

Fields
Field Name Description
paymentIntentAdjustment - PaymentIntentAdjustment The newly created payment intent adjustment.
userErrors - [UserError!]! A list of user errors.
Example
{
  "paymentIntentAdjustment": PaymentIntentAdjustment,
  "userErrors": [UserError]
}
Payloads

PaymentIntentCancelPayload

Description

Autogenerated return type of PaymentIntentCancel.

Fields
Field Name Description
paymentIntent - PaymentIntent The payment intent.
userErrors - [UserError!]! A list of user errors.
Example
{
  "paymentIntent": PaymentIntent,
  "userErrors": [UserError]
}
Payloads

PaymentIntentCreatePayload

Description

Autogenerated return type of PaymentIntentCreate.

Fields
Field Name Description
paymentIntent - PaymentIntent The newly created payment intent.
userErrors - [UserError!]! A list of user errors.
Example
{
  "paymentIntent": PaymentIntent,
  "userErrors": [UserError]
}
Payloads

PaymentIntentFinalisePayload

Description

Autogenerated return type of PaymentIntentFinalise.

Fields
Field Name Description
paymentIntent - PaymentIntent The finalised payment intent.
userErrors - [UserError!]! A list of user errors.
Example
{
  "paymentIntent": PaymentIntent,
  "userErrors": [UserError]
}
Payloads

PaymentIntentUpdatePayload

Description

Autogenerated return type of PaymentIntentUpdate.

Fields
Field Name Description
paymentIntent - PaymentIntent The updated payment intent.
userErrors - [UserError!]! A list of user errors.
Example
{
  "paymentIntent": PaymentIntent,
  "userErrors": [UserError]
}
Payloads

PaymentMethodCancelPayload

Description

Autogenerated return type of PaymentMethodCancel.

Fields
Field Name Description
paymentMethod - PaymentMethod The payment method.
userErrors - [UserError!]! A list of user errors.
Example
{
  "paymentMethod": PaymentMethod,
  "userErrors": [UserError]
}
Payloads

PaymentMethodCreatePayload

Description

Autogenerated return type of PaymentMethodCreate.

Fields
Field Name Description
paymentMethod - PaymentMethod The newly created payment method.
userErrors - [UserError!]! A list of user errors.
Example
{
  "paymentMethod": PaymentMethod,
  "userErrors": [UserError]
}
Payloads

PaymentMethodSendUpdateEmailPayload

Description

Autogenerated return type of PaymentMethodSendUpdateEmail.

Fields
Field Name Description
userErrors - [UserError!]! A list of user errors.
Example
{"userErrors": [UserError]}
Payloads

PaymentMethodUpdatePayload

Description

Autogenerated return type of PaymentMethodUpdate.

Fields
Field Name Description
paymentMethod - PaymentMethod The updated payment method.
userErrors - [UserError!]! A list of user errors.
Example
{
  "paymentMethod": PaymentMethod,
  "userErrors": [UserError]
}
Payloads

PresaleCampaignAddProductVariantsPayload

Description

Autogenerated return type of PresaleCampaignAddProductVariants.

Fields
Field Name Description
presaleCampaign - PresaleCampaign The newly updated presale campaign.
userErrors - [UserError!]! A list of user errors.
Example
{
  "presaleCampaign": PresaleCampaign,
  "userErrors": [UserError]
}
Payloads

PresaleCampaignAddProductsPayload

Description

Autogenerated return type of PresaleCampaignAddProducts.

Fields
Field Name Description
presaleCampaign - PresaleCampaign The newly updated presale campaign.
userErrors - [UserError!]! A list of user errors.
Example
{
  "presaleCampaign": PresaleCampaign,
  "userErrors": [UserError]
}
Payloads

PresaleCampaignApplyBulkInventoryPayload

Description

Autogenerated return type of PresaleCampaignApplyBulkInventory.

Fields
Field Name Description
presaleCampaign - PresaleCampaign The presale campaign for which inventory should be applied.
userErrors - [UserError!]! A list of user errors.
Example
{
  "presaleCampaign": PresaleCampaign,
  "userErrors": [UserError]
}
Payloads

PresaleCampaignApplyInventoryPayload

Description

Autogenerated return type of PresaleCampaignApplyInventory.

Fields
Field Name Description
presaleCampaign - PresaleCampaign The presale campaign for which inventory has been applied.
userErrors - [UserError!]! A list of user errors.
Example
{
  "presaleCampaign": PresaleCampaign,
  "userErrors": [UserError]
}
Payloads

PresaleCampaignArchivePayload

Description

Autogenerated return type of PresaleCampaignArchive.

Fields
Field Name Description
presaleCampaign - PresaleCampaign The archived presale campaign.
userErrors - [UserError!]! A list of user errors.
Example
{
  "presaleCampaign": PresaleCampaign,
  "userErrors": [UserError]
}
Payloads

PresaleCampaignCancelPayload

Description

Autogenerated return type of PresaleCampaignCancel.

Fields
Field Name Description
presaleCampaign - PresaleCampaign The cancelled presale campaign.
userErrors - [UserError!]! A list of user errors.
Example
{
  "presaleCampaign": PresaleCampaign,
  "userErrors": [UserError]
}
Payloads

PresaleCampaignCreatePayload

Description

Autogenerated return type of PresaleCampaignCreate.

Fields
Field Name Description
presaleCampaign - PresaleCampaign The newly created presale campaign.
userErrors - [UserError!]! A list of user errors.
Example
{
  "presaleCampaign": PresaleCampaign,
  "userErrors": [UserError]
}
Payloads

PresaleCampaignDeletePayload

Description

Autogenerated return type of PresaleCampaignDelete.

Fields
Field Name Description
deletedPresaleCampaignId - GlobalID The ID of the deleted presale campaign.
userErrors - [UserError!]! A list of user errors.
Example
{
  "deletedPresaleCampaignId": GlobalID,
  "userErrors": [UserError]
}
Payloads

PresaleCampaignEndPayload

Description

Autogenerated return type of PresaleCampaignEnd.

Fields
Field Name Description
presaleCampaign - PresaleCampaign The ended presale campaign.
userErrors - [UserError!]! A list of user errors.
Example
{
  "presaleCampaign": PresaleCampaign,
  "userErrors": [UserError]
}
Payloads

PresaleCampaignFulfilPayload

Description

Autogenerated return type of PresaleCampaignFulfil.

Fields
Field Name Description
presaleCampaign - PresaleCampaign The fulfilling presale campaign.
userErrors - [UserError!]! A list of user errors.
Example
{
  "presaleCampaign": PresaleCampaign,
  "userErrors": [UserError]
}
Payloads

PresaleCampaignLaunchPayload

Description

Autogenerated return type of PresaleCampaignLaunch.

Fields
Field Name Description
presaleCampaign - PresaleCampaign The launched presale campaign.
userErrors - [UserError!]! A list of user errors.
Example
{
  "presaleCampaign": PresaleCampaign,
  "userErrors": [UserError]
}
Payloads

PresaleCampaignRemoveProductVariantsPayload

Description

Autogenerated return type of PresaleCampaignRemoveProductVariants.

Fields
Field Name Description
presaleCampaign - PresaleCampaign The updated presale campaign.
userErrors - [UserError!]! A list of user errors.
Example
{
  "presaleCampaign": PresaleCampaign,
  "userErrors": [UserError]
}
Payloads

PresaleCampaignRemoveProductsPayload

Description

Autogenerated return type of PresaleCampaignRemoveProducts.

Fields
Field Name Description
presaleCampaign - PresaleCampaign The updated presale campaign.
userErrors - [UserError!]! A list of user errors.
Example
{
  "presaleCampaign": PresaleCampaign,
  "userErrors": [UserError]
}
Payloads

PresaleCampaignUnarchivePayload

Description

Autogenerated return type of PresaleCampaignUnarchive.

Fields
Field Name Description
presaleCampaign - PresaleCampaign The unarchived presale campaign.
userErrors - [UserError!]! A list of user errors.
Example
{
  "presaleCampaign": PresaleCampaign,
  "userErrors": [UserError]
}
Payloads

PresaleCampaignUpdatePayload

Description

Autogenerated return type of PresaleCampaignUpdate.

Fields
Field Name Description
presaleCampaign - PresaleCampaign The newly updated presale campaign.
userErrors - [UserError!]! A list of user errors.
Example
{
  "presaleCampaign": PresaleCampaign,
  "userErrors": [UserError]
}
Payloads

ProductCollectionCreatePayload

Description

Autogenerated return type of ProductCollectionCreate.

Fields
Field Name Description
productCollection - ProductCollection The newly created product collection.
userErrors - [UserError!]! A list of user errors.
Example
{
  "productCollection": ProductCollection,
  "userErrors": [UserError]
}
Payloads

ProductCollectionDeletePayload

Description

Autogenerated return type of ProductCollectionDelete.

Fields
Field Name Description
deletedProductCollectionId - GlobalID The ID of the deleted product collection.
userErrors - [UserError!]! A list of user errors.
Example
{
  "deletedProductCollectionId": GlobalID,
  "userErrors": [UserError]
}
Payloads

ProductCollectionUpdatePayload

Description

Autogenerated return type of ProductCollectionUpdate.

Fields
Field Name Description
productCollection - ProductCollection The updated product collection.
userErrors - [UserError!]! A list of user errors.
Example
{
  "productCollection": ProductCollection,
  "userErrors": [UserError]
}
Payloads

ProductCollectionUpsertPayload

Description

Autogenerated return type of ProductCollectionUpsert.

Fields
Field Name Description
productCollection - ProductCollection The upserted product collection.
userErrors - [UserError!]! A list of user errors.
Example
{
  "productCollection": ProductCollection,
  "userErrors": [UserError]
}
Payloads

ProductCreatePayload

Description

Autogenerated return type of ProductCreate.

Fields
Field Name Description
product - Product The newly created product.
userErrors - [UserError!]! A list of user errors.
Example
{
  "product": Product,
  "userErrors": [UserError]
}
Payloads

ProductDeletePayload

Description

Autogenerated return type of ProductDelete.

Fields
Field Name Description
deletedProductId - GlobalID The ID of the deleted product.
userErrors - [UserError!]! A list of user errors.
Example
{
  "deletedProductId": GlobalID,
  "userErrors": [UserError]
}
Payloads

ProductUpdatePayload

Description

Autogenerated return type of ProductUpdate.

Fields
Field Name Description
product - Product The updated product.
userErrors - [UserError!]! A list of user errors.
Example
{
  "product": Product,
  "userErrors": [UserError]
}
Payloads

ProductUpsertPayload

Description

Autogenerated return type of ProductUpsert.

Fields
Field Name Description
product - Product The newly upserted product.
userErrors - [UserError!]! A list of user errors.
Example
{
  "product": Product,
  "userErrors": [UserError]
}
Payloads

ProductVariantCreatePayload

Description

Autogenerated return type of ProductVariantCreate.

Fields
Field Name Description
productVariant - ProductVariant The newly created product variant.
userErrors - [UserError!]! A list of user errors.
Example
{
  "productVariant": ProductVariant,
  "userErrors": [UserError]
}
Payloads

ProductVariantDeletePayload

Description

Autogenerated return type of ProductVariantDelete.

Fields
Field Name Description
deletedProductVariantId - GlobalID The ID of the deleted product variant.
userErrors - [UserError!]! A list of user errors.
Example
{
  "deletedProductVariantId": GlobalID,
  "userErrors": [UserError]
}
Payloads

ProductVariantUpdatePayload

Description

Autogenerated return type of ProductVariantUpdate.

Fields
Field Name Description
productVariant - ProductVariant The updated product variant.
userErrors - [UserError!]! A list of user errors.
Example
{
  "productVariant": ProductVariant,
  "userErrors": [UserError]
}
Payloads

RefundProcessPayload

Description

Autogenerated return type of RefundProcess.

Fields
Field Name Description
refund - Refund The newly created refund.
userErrors - [UserError!]! A list of user errors.
Example
{
  "refund": Refund,
  "userErrors": [UserError]
}
Payloads

RefundRecordPayload

Description

Autogenerated return type of RefundRecord.

Fields
Field Name Description
refund - Refund The newly created refund.
userErrors - [UserError!]! A list of user errors.
Example
{
  "refund": Refund,
  "userErrors": [UserError]
}
Payloads

ShopifyCredentialsCreatePayload

Description

Autogenerated return type of ShopifyCredentialsCreate.

Fields
Field Name Description
shopifyCredentials - ShopifyCredentials The newly stored shopify credentials.
userErrors - [UserError!]! A list of user errors.
Example
{
  "shopifyCredentials": ShopifyCredentials,
  "userErrors": [UserError]
}
Payloads

SubscriptionCancelPayload

Description

Autogenerated return type of SubscriptionCancel.

Fields
Field Name Description
subscription - Subscription
userErrors - [UserError!]!
Example
{
  "subscription": Subscription,
  "userErrors": [UserError]
}
Payloads

SubscriptionLineAddPayload

Description

Autogenerated return type of SubscriptionLineAdd.

Fields
Field Name Description
addedLine - SubscriptionLine
subscription - Subscription
userErrors - [UserError!]! A list of user errors.
Example
{
  "addedLine": SubscriptionLine,
  "subscription": Subscription,
  "userErrors": [UserError]
}
Payloads

SubscriptionLineRemovePayload

Description

Autogenerated return type of SubscriptionLineRemove.

Fields
Field Name Description
removedLine - SubscriptionLine
subscription - Subscription
userErrors - [UserError!]! A list of user errors.
Example
{
  "removedLine": SubscriptionLine,
  "subscription": Subscription,
  "userErrors": [UserError]
}
Payloads

SubscriptionLineSetQuantityPayload

Description

Autogenerated return type of SubscriptionLineSetQuantity.

Fields
Field Name Description
subscription - Subscription
updatedLine - SubscriptionLine
userErrors - [UserError!]! A list of user errors.
Example
{
  "subscription": Subscription,
  "updatedLine": SubscriptionLine,
  "userErrors": [UserError]
}
Payloads

SubscriptionOrderLineAddPayload

Description

Autogenerated return type of SubscriptionOrderLineAdd.

Fields
Field Name Description
addedLine - SubscriptionOrderLine
subscriptionOrder - SubscriptionOrder
userErrors - [UserError!]! A list of user errors.
Example
{
  "addedLine": SubscriptionOrderLine,
  "subscriptionOrder": SubscriptionOrder,
  "userErrors": [UserError]
}
Payloads

SubscriptionOrderLineRemovePayload

Description

Autogenerated return type of SubscriptionOrderLineRemove.

Fields
Field Name Description
removedLine - SubscriptionOrderLine
subscriptionOrder - SubscriptionOrder
userErrors - [UserError!]! A list of user errors.
Example
{
  "removedLine": SubscriptionOrderLine,
  "subscriptionOrder": SubscriptionOrder,
  "userErrors": [UserError]
}
Payloads

SubscriptionOrderLineSetQuantityPayload

Description

Autogenerated return type of SubscriptionOrderLineSetQuantity.

Fields
Field Name Description
subscriptionOrder - SubscriptionOrder
updatedLine - SubscriptionOrderLine
userErrors - [UserError!]! A list of user errors.
Example
{
  "subscriptionOrder": SubscriptionOrder,
  "updatedLine": SubscriptionOrderLine,
  "userErrors": [UserError]
}
Payloads

SubscriptionOrderProcessPayload

Description

Autogenerated return type of SubscriptionOrderProcess.

Fields
Field Name Description
subscriptionOrder - SubscriptionOrder The processed subscription order.
userErrors - [UserError!]! A list of user errors.
Example
{
  "subscriptionOrder": SubscriptionOrder,
  "userErrors": [UserError]
}
Payloads

SubscriptionOrderSetDeliveryDatePayload

Description

Autogenerated return type of SubscriptionOrderSetDeliveryDate.

Fields
Field Name Description
subscriptionOrder - SubscriptionOrder The updated subscription order.
userErrors - [UserError!]! A list of user errors.
Example
{
  "subscriptionOrder": SubscriptionOrder,
  "userErrors": [UserError]
}
Payloads

SubscriptionOrderSkipPayload

Description

Autogenerated return type of SubscriptionOrderSkip.

Fields
Field Name Description
skippedSubscriptionOrders - [SubscriptionOrder!] The skipped subscription orders.
subscriptionOrder - SubscriptionOrder The origin subscription order.
userErrors - [UserError!]! A list of user errors.
Example
{
  "skippedSubscriptionOrders": [SubscriptionOrder],
  "subscriptionOrder": SubscriptionOrder,
  "userErrors": [UserError]
}
Payloads

SubscriptionOrderUnskipPayload

Description

Autogenerated return type of SubscriptionOrderUnskip.

Fields
Field Name Description
subscriptionOrder - SubscriptionOrder The unskipped subscription order.
userErrors - [UserError!]! A list of user errors.
Example
{
  "subscriptionOrder": SubscriptionOrder,
  "userErrors": [UserError]
}
Payloads

SubscriptionOrderUpdatePayload

Description

Autogenerated return type of SubscriptionOrderUpdate.

Fields
Field Name Description
subscriptionOrder - SubscriptionOrder The updated subscription order.
userErrors - [UserError!]! A list of user errors.
Example
{
  "subscriptionOrder": SubscriptionOrder,
  "userErrors": [UserError]
}
Payloads

SubscriptionPausePayload

Description

Autogenerated return type of SubscriptionPause.

Fields
Field Name Description
subscription - Subscription
userErrors - [UserError!]!
Example
{
  "subscription": Subscription,
  "userErrors": [UserError]
}
Payloads

SubscriptionPlanDeletePayload

Description

Autogenerated return type of SubscriptionPlanDelete.

Fields
Field Name Description
deletedSubscriptionPlanId - GlobalID The ID of the deleted subscription plan.
userErrors - [UserError!]! A list of user errors.
Example
{
  "deletedSubscriptionPlanId": GlobalID,
  "userErrors": [UserError]
}
Payloads

SubscriptionPlanGroupCreatePayload

Description

Autogenerated return type of SubscriptionPlanGroupCreate.

Fields
Field Name Description
subscriptionPlanGroup - SubscriptionPlanGroup The newly created subscription plan group.
userErrors - [UserError!]! A list of user errors.
Example
{
  "subscriptionPlanGroup": SubscriptionPlanGroup,
  "userErrors": [UserError]
}
Payloads

SubscriptionRestorePayload

Description

Autogenerated return type of SubscriptionRestore.

Fields
Field Name Description
subscription - Subscription
userErrors - [UserError!]!
Example
{
  "subscription": Subscription,
  "userErrors": [UserError]
}
Payloads

SubscriptionResumePayload

Description

Autogenerated return type of SubscriptionResume.

Fields
Field Name Description
subscription - Subscription
userErrors - [UserError!]!
Example
{
  "subscription": Subscription,
  "userErrors": [UserError]
}
Payloads

SubscriptionSetSchedulePayload

Description

Autogenerated return type of SubscriptionSetSchedule.

Fields
Field Name Description
subscription - Subscription The updated subscription.
userErrors - [UserError!]! A list of user errors.
Example
{
  "subscription": Subscription,
  "userErrors": [UserError]
}
Payloads

SubscriptionUpdatePayload

Description

Autogenerated return type of SubscriptionUpdate.

Fields
Field Name Description
subscription - Subscription The updated subscription.
userErrors - [UserError!]! A list of user errors.
Example
{
  "subscription": Subscription,
  "userErrors": [UserError]
}
Payloads

WebhookCreatePayload

Description

Autogenerated return type of WebhookCreate.

Fields
Field Name Description
userErrors - [UserError!]! A list of user errors.
webhook - Webhook The newly created webhook subscription.
Example
{
  "userErrors": [UserError],
  "webhook": Webhook
}
Payloads

WebhookDeletePayload

Description

Autogenerated return type of WebhookDelete.

Fields
Field Name Description
deletedWebhookId - GlobalID The webhooks's ID.
userErrors - [UserError!]! A list of user errors.
Example
{
  "deletedWebhookId": GlobalID,
  "userErrors": [UserError]
}
Payloads

WebhookUpdatePayload

Description

Autogenerated return type of WebhookUpdate.

Fields
Field Name Description
userErrors - [UserError!]! A list of user errors.
webhook - Webhook The newly updated webhook.
Example
{
  "userErrors": [UserError],
  "webhook": Webhook
}

Scalar

Boolean

Description

The Boolean scalar type represents true or false.

Scalar

Count

Description

A postive integer, or zero

Example
Count
Scalar

Email

Example
Email
Scalar

Float

Description

The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.

Example
123.45
Scalar

GlobalID

Description

A global Submarine ID.

Example
GlobalID
Scalar

ID

Description

The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.

Example
4
Scalar

ISO8601DateTime

Description

An ISO 8601-encoded datetime

Example
ISO8601DateTime
Scalar

Int

Description

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

Example
987
Scalar

JSON

Description

Represents untyped JSON

Example
{}
Scalar

Metadata

Description

A collection of key/value pairs.

Example
Metadata
Scalar

MetadataInput

Description

A collection of key/value pairs.

Example
MetadataInput
Scalar

NonZeroCount

Description

A postive integer

Example
NonZeroCount
Scalar

Percentage

Description

A percentage value

Example
Percentage
Scalar

PhoneNumber

Example
"+17895551234"
Scalar

PositiveInteger

Description

A postive integer

Example
PositiveInteger
Scalar

ProvinceCode

Example
ProvinceCode
Scalar

RedactedString

Description

redacted string

Example
RedactedString
Scalar

SharedGlobalID

Description

A shared global Submarine ID.

Example
SharedGlobalID
Scalar

String

Description

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Example
"xyz789"
Scalar

TimeOfDay

Description

Time of day in 24 hour format

Example
TimeOfDay
Scalar

Timestamp

Description

An ISO 8601-encoded datetime

Example
1592577642
Scalar

Timezone

Description

An IANA timezone identifier

Example
Timezone
Scalar

Url

Description

A valid URL, transported as a string

Example
Url

Union

Campaign

Description

A generic campaign.

Types
Union Types

CrowdfundingCampaign

PresaleCampaign
Example
CrowdfundingCampaign
Union

CampaignItemResource

Description

A generic campaign item resource.

Types
Union Types

Product

ProductVariant
Example
Product
Union

CrowdfundingGoal

Description

A generic crowdfunding campaign goal.

Types
Union Types

TotalUnitsCrowdfundingGoal

TotalValueCrowdfundingGoal
Example
TotalUnitsCrowdfundingGoal
Union

PaymentSource

Description

A generic payment source.

Types
Union Types

Card

PaypalBillingAgreement
Example
Card
Union

SubscriptionDeliveryMethod

Types
Union Types

SubscriptionDeliveryMethodShipping
Example
SubscriptionDeliveryMethodShipping
Union

SubscriptionProductGroupItemResource

Types
Union Types

Product

ProductVariant
Example
Product
Union

SubscriptionProductGroupItemSourceResource

Types
Union Types

Product

ProductCollection

ProductVariant
Example
Product
Documentation by Anvil SpectaQL