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.submarineplatform.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
    environment
    exchangeRates {
      ...ExchangeRateFragment
    }
    externalId
    id
    identifier
    internal
    name
    organisation {
      ...OrganisationFragment
    }
    presentmentCurrencies
    priority
    sharedSecret
    shippableCountries
    shopCurrency
    status
    timezone
    updatedAt
  }
}

Variables

{"id": SharedGlobalID}

Response

{
  "data": {
    "channel": {
      "channelType": "SHOPIFY",
      "config": PlatformConfig,
      "createdAt": 1592577642,
      "environment": "DEVELOPMENT",
      "exchangeRates": [ExchangeRate],
      "externalId": "xyz789",
      "id": GlobalID,
      "identifier": "xyz789",
      "internal": true,
      "name": "xyz789",
      "organisation": Organisation,
      "presentmentCurrencies": ["AED"],
      "priority": "DEFAULT",
      "sharedSecret": "xyz789",
      "shippableCountries": ["AC"],
      "shopCurrency": "AED",
      "status": "ACTIVE",
      "timezone": Timezone,
      "updatedAt": 1592577642
    }
  }
}

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": "xyz789",
  "before": "abc123",
  "first": 123,
  "last": 123
}

Response

{
  "data": {
    "channels": {
      "edges": [ChannelEdge],
      "nodes": [Channel],
      "pageInfo": PageInfo
    }
  }
}

Objects

Channel

Description

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

Fields

Field Name	Description
`channelType` - `ChannelType!`	Translation missing: en.graphql.objects.channel.fields.channel_type
`config` - `PlatformConfig!`	Translation missing: en.graphql.objects.channel.fields.config
`createdAt` - `Timestamp!`	Translation missing: en.graphql.objects.channel.fields.created_at
`environment` - `ChannelEnvironment!`	Translation missing: en.graphql.objects.channel.fields.environment
`exchangeRates` - `[ExchangeRate!]!`	Translation missing: en.graphql.objects.channel.fields.exchange_rates
`externalId` - `String!`	Translation missing: en.graphql.objects.channel.fields.external_id
`id` - `GlobalID!`	The channel's ID.
`identifier` - `String!`	Translation missing: en.graphql.objects.channel.fields.identifier
`internal` - `Boolean!`	Translation missing: en.graphql.objects.channel.fields.internal
`name` - `String!`	Translation missing: en.graphql.objects.channel.fields.name
`organisation` - `Organisation!`	Translation missing: en.graphql.objects.channel.fields.organisation
`presentmentCurrencies` - `[CurrencyCode!]!`	Translation missing: en.graphql.objects.channel.fields.presentment_currencies
`priority` - `ChannelPriority!`	Translation missing: en.graphql.objects.channel.fields.priority
`sharedSecret` - `String!`	Translation missing: en.graphql.objects.channel.fields.shared_secret
`shippableCountries` - `[CountryCode!]!`	Translation missing: en.graphql.objects.channel.fields.shippable_countries
`shopCurrency` - `CurrencyCode!`	Translation missing: en.graphql.objects.channel.fields.shop_currency
`status` - `ChannelStatus!`	Translation missing: en.graphql.objects.channel.fields.status
`timezone` - `Timezone!`	Translation missing: en.graphql.objects.channel.fields.timezone
`updatedAt` - `Timestamp!`	Translation missing: en.graphql.objects.channel.fields.updated_at

Example

{
  "channelType": "SHOPIFY",
  "config": PlatformConfig,
  "createdAt": 1592577642,
  "environment": "DEVELOPMENT",
  "exchangeRates": [ExchangeRate],
  "externalId": "abc123",
  "id": GlobalID,
  "identifier": "xyz789",
  "internal": false,
  "name": "xyz789",
  "organisation": Organisation,
  "presentmentCurrencies": ["AED"],
  "priority": "DEFAULT",
  "sharedSecret": "abc123",
  "shippableCountries": ["AC"],
  "shopCurrency": "AED",
  "status": "ACTIVE",
  "timezone": Timezone,
  "updatedAt": 1592577642
}

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 {
      ...PostalAddressFragment
    }
    channels {
      ...ChannelFragment
    }
    createdAt
    email
    id
    name
    status
    updatedAt
  }
}

Variables

{"id": GlobalID}

Response

{
  "data": {
    "organisation": {
      "address": PostalAddress,
      "channels": [Channel],
      "createdAt": 1592577642,
      "email": "xyz789",
      "id": GlobalID,
      "name": "abc123",
      "status": "ACTIVE",
      "updatedAt": 1592577642
    }
  }
}

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": "abc123",
  "before": "xyz789",
  "first": 987,
  "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!`

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

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

Fields

Field Name	Description
`address` - `PostalAddress`	Translation missing: en.graphql.objects.organisation.fields.address
`channels` - `[Channel!]!`	Translation missing: en.graphql.objects.organisation.fields.channels
`createdAt` - `Timestamp!`	Translation missing: en.graphql.objects.organisation.fields.created_at
`email` - `String!`	Translation missing: en.graphql.objects.organisation.fields.email
`id` - `GlobalID!`	Translation missing: en.graphql.objects.organisation.fields.id
`name` - `String!`	Translation missing: en.graphql.objects.organisation.fields.name
`status` - `OrganisationStatus!`	Translation missing: en.graphql.objects.organisation.fields.status
`updatedAt` - `Timestamp!`	Translation missing: en.graphql.objects.organisation.fields.updated_at

Example

{
  "address": PostalAddress,
  "channels": [Channel],
  "createdAt": 1592577642,
  "email": "abc123",
  "id": GlobalID,
  "name": "abc123",
  "status": "ACTIVE",
  "updatedAt": 1592577642
}

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": "4",
      "id": GlobalID,
      "imageUrl": "abc123",
      "productVariants": [ProductVariant],
      "productVariantsCount": Count,
      "status": "PUBLISHED",
      "title": "xyz789"
    }
  }
}

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": "xyz789",
  "before": "abc123",
  "first": 987,
  "last": 123
}

Response

{
  "data": {
    "products": {
      "edges": [ProductEdge],
      "nodes": [Product],
      "pageInfo": PageInfo,
      "totalCount": 123
    }
  }
}

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

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

Fields

Field Name	Description
`externalId` - `ID!`	Translation missing: en.graphql.objects.product.fields.external_id
`id` - `GlobalID!`	Translation missing: en.graphql.objects.product.fields.id
`imageUrl` - `String`	Translation missing: en.graphql.objects.product.fields.image_url
`productVariants` - `[ProductVariant!]!`	Translation missing: en.graphql.objects.product.fields.product_variants
`productVariantsCount` - `Count!`	Translation missing: en.graphql.objects.product.fields.product_variants_count
`status` - `ProductStatus!`	Translation missing: en.graphql.objects.product.fields.status
`title` - `String!`	Translation missing: en.graphql.objects.product.fields.title

Example

{
  "externalId": "4",
  "id": GlobalID,
  "imageUrl": "abc123",
  "productVariants": [ProductVariant],
  "productVariantsCount": Count,
  "status": "PUBLISHED",
  "title": "xyz789"
}

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": 4,
      "id": GlobalID,
      "imageUrl": "abc123",
      "price": Money,
      "product": Product,
      "shippable": true,
      "sku": "abc123",
      "status": "PUBLISHED",
      "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": "xyz789",
  "before": "abc123",
  "first": 123,
  "last": 123
}

Response

{
  "data": {
    "productVariants": {
      "edges": [ProductVariantEdge],
      "nodes": [ProductVariant],
      "pageInfo": PageInfo,
      "totalCount": 987
    }
  }
}

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

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

Fields

Field Name	Description
`externalId` - `ID!`	Translation missing: en.graphql.objects.product_variant.fields.external_id
`id` - `GlobalID!`	Translation missing: en.graphql.objects.product_variant.fields.id
`imageUrl` - `String`	Translation missing: en.graphql.objects.product_variant.fields.image_url
`price` - `Money!`	Translation missing: en.graphql.objects.product_variant.fields.price
`product` - `Product!`	Translation missing: en.graphql.objects.product_variant.fields.product
`shippable` - `Boolean!`	Translation missing: en.graphql.objects.product_variant.fields.shippable
`sku` - `String`	Translation missing: en.graphql.objects.product_variant.fields.sku
`status` - `ProductVariantStatus!`	Translation missing: en.graphql.objects.product_variant.fields.status
`taxable` - `Boolean!`	Translation missing: en.graphql.objects.product_variant.fields.taxable
`title` - `String!`	Translation missing: en.graphql.objects.product_variant.fields.title
`weightGrams` - `Int`	Translation missing: en.graphql.objects.product_variant.fields.weight_grams

Example

{
  "externalId": 4,
  "id": GlobalID,
  "imageUrl": "abc123",
  "price": Money,
  "product": Product,
  "shippable": false,
  "sku": "xyz789",
  "status": "PUBLISHED",
  "taxable": false,
  "title": "xyz789",
  "weightGrams": 123
}

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": "xyz789",
  "before": "abc123",
  "first": 123,
  "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": 123,
      "campaign": CrowdfundingCampaign,
      "campaignInventoryItem": CampaignInventoryItem,
      "campaignItem": CampaignItem,
      "campaignOrderGroup": CampaignOrderGroup,
      "cancelReason": "xyz789",
      "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": 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": "abc123",
      "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": 987,
  "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": "xyz789",
  "sortDirection": "ASC",
  "sortKey": "CREATED_AT",
  "status": ["ALLOCATED"]
}

Response

{
  "data": {
    "searchCampaignOrders": {
      "queryArguments": "xyz789",
      "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": 987,
  "campaign": CrowdfundingCampaign,
  "campaignInventoryItem": CampaignInventoryItem,
  "campaignItem": CampaignItem,
  "campaignOrderGroup": CampaignOrderGroup,
  "cancelReason": "abc123",
  "cancelledBy": "CUSTOMER",
  "customer": Customer,
  "financials": CampaignOrderFinancials,
  "fulfilmentStatus": "ALLOCATED",
  "id": GlobalID,
  "identifier": "abc123",
  "milestones": CampaignOrderMilestones,
  "originalQuantity": 123,
  "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": "xyz789",
      "financials": CampaignOrderGroupFinancials,
      "id": GlobalID,
      "identifier": "abc123",
      "lineItemsCount": 123,
      "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": "abc123",
  "before": "abc123",
  "first": 987,
  "last": 987
}

Response

{
  "data": {
    "campaignOrderGroups": {
      "edges": [CampaignOrderGroupEdge],
      "nodes": [CampaignOrderGroup],
      "pageInfo": PageInfo,
      "totalCount": 123
    }
  }
}

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": "xyz789",
  "financials": CampaignOrderGroupFinancials,
  "id": GlobalID,
  "identifier": "xyz789",
  "lineItemsCount": 123,
  "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": 987,
      "archivedAt": ISO8601DateTime,
      "campaignEndTotalUnits": 987,
      "campaignEndTotalValue": Money,
      "campaignInventoryItems": [CampaignInventoryItem],
      "campaignItemType": "PRODUCT",
      "campaignItems": [CampaignItem],
      "campaignOrders": CampaignOrderConnection,
      "campaignOrdersCount": 987,
      "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": 987,
      "id": GlobalID,
      "identifier": "xyz789",
      "inventoryApplications": [InventoryApplication],
      "launchAt": ISO8601DateTime,
      "launchedAt": ISO8601DateTime,
      "limit": 987,
      "name": "abc123",
      "productVariants": [ProductVariant],
      "products": [Product],
      "reference": "abc123",
      "reservedItemsCount": 123,
      "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": "xyz789",
  "first": 123,
  "last": 123
}

Response

{
  "data": {
    "crowdfundingCampaigns": {
      "edges": [CrowdfundingCampaignEdge],
      "nodes": [CrowdfundingCampaign],
      "pageInfo": PageInfo,
      "totalCount": 987
    }
  }
}

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": true,
  "isArchived": false,
  "productIds": [SharedGlobalID],
  "productVariantIds": [SharedGlobalID],
  "query": "xyz789",
  "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": 987,
  "archivedAt": ISO8601DateTime,
  "campaignEndTotalUnits": 987,
  "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": "abc123",
  "dueAt": ISO8601DateTime,
  "endAt": ISO8601DateTime,
  "endedAt": ISO8601DateTime,
  "fulfilAt": ISO8601DateTime,
  "fulfillingAt": ISO8601DateTime,
  "goal": TotalUnitsCrowdfundingGoal,
  "goalProgress": 987.65,
  "goalStatus": "FAILED",
  "gracePeriodHours": 987,
  "id": GlobalID,
  "identifier": "abc123",
  "inventoryApplications": [InventoryApplication],
  "launchAt": ISO8601DateTime,
  "launchedAt": ISO8601DateTime,
  "limit": 123,
  "name": "xyz789",
  "productVariants": [ProductVariant],
  "products": [Product],
  "reference": "xyz789",
  "reservedItemsCount": 123,
  "sequentialId": 987,
  "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
}

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": 987,
      "allocationStatus": "ALLOCATED",
      "appliedInventoryCount": 123,
      "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": 123,
      "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": 987,
  "last": 987
}

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": false,
  "isArchived": false,
  "productIds": [SharedGlobalID],
  "productVariantIds": [SharedGlobalID],
  "query": "xyz789",
  "sortDirection": "ASC",
  "sortKey": "COMPLETED_AT",
  "status": ["CANCELLED"]
}

Response

{
  "data": {
    "searchPresaleCampaigns": {
      "queryArguments": "abc123",
      "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": 123,
  "id": GlobalID,
  "identifier": "abc123",
  "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": 987,
  "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
}

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
    }
    deliveryBehaviourType
    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,
      "deliveryBehaviourType": "FIXED",
      "frequency": SubscriptionFrequency,
      "id": GlobalID,
      "inventoryBehaviour": SubscriptionInventoryBehaviour,
      "name": "abc123",
      "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
    }
    deliveryBehaviourType
    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,
      "deliveryBehaviourType": "FIXED",
      "externalId": "abc123",
      "id": GlobalID,
      "identifier": "xyz789",
      "inventoryBehaviour": SubscriptionInventoryBehaviour,
      "name": "abc123",
      "pricingBehaviour": SubscriptionPricingBehaviour,
      "productGroup": SubscriptionProductGroup,
      "reference": "abc123",
      "status": "ACTIVE",
      "subscriptionPlans": [SubscriptionPlan],
      "subscriptionPlansCount": Count,
      "subscriptionsCount": Count,
      "timezone": "abc123",
      "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": "abc123",
  "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": "xyz789",
  "first": 123,
  "last": 987
}

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!`

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
`deliveryBehaviourType` - `SubscriptionDeliveryBehaviourType!`	Translation missing: en.graphql.objects.subscription_plan.fields.delivery_behaviour_type
`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,
  "deliveryBehaviourType": "FIXED",
  "frequency": SubscriptionFrequency,
  "id": GlobalID,
  "inventoryBehaviour": SubscriptionInventoryBehaviour,
  "name": "abc123",
  "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
`deliveryBehaviourType` - `SubscriptionDeliveryBehaviourType!`	Translation missing: en.graphql.objects.subscription_plan_group.fields.delivery_behaviour_type
`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,
  "deliveryBehaviourType": "FIXED",
  "externalId": "abc123",
  "id": GlobalID,
  "identifier": "xyz789",
  "inventoryBehaviour": SubscriptionInventoryBehaviour,
  "name": "abc123",
  "pricingBehaviour": SubscriptionPricingBehaviour,
  "productGroup": SubscriptionProductGroup,
  "reference": "xyz789",
  "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!]`
`flagged` - `Boolean`
`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!],
  $flagged: Boolean,
  $paymentStatus: [SubscriptionOrderPaymentStatus!],
  $query: String,
  $sortDirection: SortDirection,
  $sortKey: SubscriptionOrderSortKey,
  $status: [SubscriptionOrderStatus!],
  $subscriptionId: GlobalID,
  $subscriptionPlanId: GlobalID
) {
  searchSubscriptionOrders(
    customerIds: $customerIds,
    flagged: $flagged,
    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],
  "flagged": false,
  "paymentStatus": ["FAILED"],
  "query": "xyz789",
  "sortDirection": "ASC",
  "sortKey": "BILL_AT",
  "status": ["CANCELLED"],
  "subscriptionId": GlobalID,
  "subscriptionPlanId": GlobalID
}

Response

{
  "data": {
    "searchSubscriptionOrders": {
      "queryArguments": "xyz789",
      "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": "abc123",
  "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.
`healthStatus` - `[SubscriptionHealthStatus!]`
`pendingCancellation` - `Boolean`
`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!],
  $healthStatus: [SubscriptionHealthStatus!],
  $pendingCancellation: Boolean,
  $query: String,
  $sortDirection: SortDirection,
  $sortKey: SubscriptionSortKey,
  $status: [SubscriptionStatus!],
  $subscriptionPlanGroupId: GlobalID,
  $subscriptionPlanId: GlobalID
) {
  searchSubscriptions(
    customerIds: $customerIds,
    healthStatus: $healthStatus,
    pendingCancellation: $pendingCancellation,
    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],
  "healthStatus": ["AT_RISK"],
  "pendingCancellation": false,
  "query": "xyz789",
  "sortDirection": "ASC",
  "sortKey": "CREATED_AT",
  "status": ["ACTIVE"],
  "subscriptionPlanGroupId": GlobalID,
  "subscriptionPlanId": GlobalID
}

Response

{
  "data": {
    "searchSubscriptions": {
      "queryArguments": "xyz789",
      "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
    }
    backlogSize {
      ...SubscriptionBacklogSizeFragment
    }
    billingBehaviour {
      ...SubscriptionBillingBehaviourFragment
    }
    cancelAt
    cancelEvent {
      ...SubscriptionEventFragment
    }
    cancelledAt
    channel {
      ...ChannelFragment
    }
    createdAt
    currency
    customAttributes {
      ...CustomAttributeFragment
    }
    customer {
      ...CustomerFragment
    }
    deliveryBehaviour {
      ...SubscriptionDeliveryBehaviourFragment
    }
    deliveryMethod {
      ... on SubscriptionDeliveryMethodShipping {
        ...SubscriptionDeliveryMethodShippingFragment
      }
    }
    events {
      ...SubscriptionEventConnectionFragment
    }
    exchangeRate
    externalId
    healthBreakdown {
      ...SubscriptionHealthCheckFragment
    }
    healthLastCheckedAt
    healthStatus
    id
    identifier
    inventoryBehaviour {
      ...SubscriptionInventoryBehaviourFragment
    }
    lastProcessedOrder {
      ...SubscriptionOrderFragment
    }
    lines {
      ...SubscriptionLineFragment
    }
    modelId
    multiCurrency
    nextBillingAt
    nextDeliveryAt
    nextScheduledOrder {
      ...SubscriptionOrderFragment
    }
    notes
    order {
      ...OrderFragment
    }
    pauseEvent {
      ...SubscriptionEventFragment
    }
    paymentMethod {
      ...PaymentMethodFragment
    }
    pendingCancellation
    presentmentCurrency
    pricingBehaviour {
      ...SubscriptionPricingBehaviourFragment
    }
    processedSubscriptionOrdersCount
    restoreEvent {
      ...SubscriptionEventFragment
    }
    resumeEvent {
      ...SubscriptionEventFragment
    }
    revertScheduledCancellationEvent {
      ...SubscriptionEventFragment
    }
    scheduleCancellationEvent {
      ...SubscriptionEventFragment
    }
    shopCurrency
    source {
      ...SubscriptionSourceFragment
    }
    status
    subscriptionAnchor {
      ...SubscriptionAnchorFragment
    }
    subscriptionDiscounts {
      ...SubscriptionDiscountFragment
    }
    subscriptionGroup {
      ...SubscriptionGroupFragment
    }
    subscriptionOrders {
      ...SubscriptionOrderConnectionFragment
    }
    subscriptionPlan {
      ...SubscriptionPlanFragment
    }
    updatedAt
  }
}

Variables

{"id": GlobalID}

Response

{
  "data": {
    "subscription": {
      "availableSubscriptionPlans": [SubscriptionPlan],
      "backlogSize": SubscriptionBacklogSize,
      "billingBehaviour": SubscriptionBillingBehaviour,
      "cancelAt": 1592577642,
      "cancelEvent": SubscriptionEvent,
      "cancelledAt": 1592577642,
      "channel": Channel,
      "createdAt": 1592577642,
      "currency": "AED",
      "customAttributes": [CustomAttribute],
      "customer": Customer,
      "deliveryBehaviour": SubscriptionDeliveryBehaviour,
      "deliveryMethod": SubscriptionDeliveryMethodShipping,
      "events": SubscriptionEventConnection,
      "exchangeRate": 987.65,
      "externalId": "xyz789",
      "healthBreakdown": [SubscriptionHealthCheck],
      "healthLastCheckedAt": 1592577642,
      "healthStatus": "AT_RISK",
      "id": GlobalID,
      "identifier": "xyz789",
      "inventoryBehaviour": SubscriptionInventoryBehaviour,
      "lastProcessedOrder": SubscriptionOrder,
      "lines": [SubscriptionLine],
      "modelId": "xyz789",
      "multiCurrency": true,
      "nextBillingAt": 1592577642,
      "nextDeliveryAt": 1592577642,
      "nextScheduledOrder": SubscriptionOrder,
      "notes": "abc123",
      "order": Order,
      "pauseEvent": SubscriptionEvent,
      "paymentMethod": PaymentMethod,
      "pendingCancellation": true,
      "presentmentCurrency": "AED",
      "pricingBehaviour": SubscriptionPricingBehaviour,
      "processedSubscriptionOrdersCount": Count,
      "restoreEvent": SubscriptionEvent,
      "resumeEvent": SubscriptionEvent,
      "revertScheduledCancellationEvent": SubscriptionEvent,
      "scheduleCancellationEvent": SubscriptionEvent,
      "shopCurrency": "AED",
      "source": SubscriptionSource,
      "status": "ACTIVE",
      "subscriptionAnchor": SubscriptionAnchor,
      "subscriptionDiscounts": [SubscriptionDiscount],
      "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": "xyz789",
      "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": "abc123",
  "before": "abc123",
  "first": 987,
  "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
  ) {
    assignedShippingOption {
      ...SubscriptionDeliveryShippingOptionFragment
    }
    billingBehaviour {
      ...SubscriptionBillingBehaviourFragment
    }
    buildStatus
    cancelledAt
    createdAt
    customAttributes {
      ...CustomAttributeFragment
    }
    customer {
      ...CustomerFragment
    }
    customised
    cycleEndAt
    cycleIndex
    cycleStartAt
    deliveryBehaviour {
      ...SubscriptionDeliveryBehaviourFragment
    }
    deliveryMethod {
      ... on SubscriptionDeliveryMethodShipping {
        ...SubscriptionDeliveryMethodShippingFragment
      }
    }
    events {
      ...SubscriptionEventConnectionFragment
    }
    expectedBillingAt
    expectedDeliveryAt
    externalCycleIndex
    failedBuildCount
    failedPaymentCaptureCount
    financials {
      ...SubscriptionOrderFinancialsFragment
    }
    financialsSet {
      ...SubscriptionOrderFinancialsSetFragment
    }
    flagged
    flaggedAt
    flaggedDescription
    flaggedReason
    id
    identifier
    lastBuildErrors
    lastPaymentMethodUpdateEvent {
      ...SubscriptionEventFragment
    }
    leadingScheduledOrdersCount
    lines {
      ...SubscriptionOrderLineFragment
    }
    multiCurrency
    nextSubscriptionOrder {
      ...SubscriptionOrderFragment
    }
    notes
    order {
      ...OrderFragment
    }
    paused
    paymentIntent {
      ...PaymentIntentFragment
    }
    paymentMethod {
      ...PaymentMethodFragment
    }
    paymentStatus
    presentmentCurrency
    previousSubscriptionOrder {
      ...SubscriptionOrderFragment
    }
    priceStatus
    processedAt
    retryPaymentAt
    shopCurrency
    skipped
    skippedAt
    skippedByPlatform
    skippedReason
    status
    subscription {
      ...SubscriptionFragment
    }
    subscriptionDiscounts {
      ...SubscriptionDiscountFragment
    }
    trailingProcessedOrdersCount
    unflaggedAt
    updatedAt
  }
}

Variables

{
  "id": GlobalID,
  "selector": SubscriptionOrderSelectorInput
}

Response

{
  "data": {
    "subscriptionOrder": {
      "assignedShippingOption": SubscriptionDeliveryShippingOption,
      "billingBehaviour": SubscriptionBillingBehaviour,
      "buildStatus": "BUILDING",
      "cancelledAt": 1592577642,
      "createdAt": 1592577642,
      "customAttributes": [CustomAttribute],
      "customer": Customer,
      "customised": false,
      "cycleEndAt": 1592577642,
      "cycleIndex": Count,
      "cycleStartAt": 1592577642,
      "deliveryBehaviour": SubscriptionDeliveryBehaviour,
      "deliveryMethod": SubscriptionDeliveryMethodShipping,
      "events": SubscriptionEventConnection,
      "expectedBillingAt": 1592577642,
      "expectedDeliveryAt": 1592577642,
      "externalCycleIndex": Count,
      "failedBuildCount": Count,
      "failedPaymentCaptureCount": Count,
      "financials": SubscriptionOrderFinancials,
      "financialsSet": SubscriptionOrderFinancialsSet,
      "flagged": false,
      "flaggedAt": 1592577642,
      "flaggedDescription": "abc123",
      "flaggedReason": "BUILD_FAILED",
      "id": GlobalID,
      "identifier": "xyz789",
      "lastBuildErrors": ["xyz789"],
      "lastPaymentMethodUpdateEvent": SubscriptionEvent,
      "leadingScheduledOrdersCount": Count,
      "lines": [SubscriptionOrderLine],
      "multiCurrency": true,
      "nextSubscriptionOrder": SubscriptionOrder,
      "notes": "xyz789",
      "order": Order,
      "paused": false,
      "paymentIntent": PaymentIntent,
      "paymentMethod": PaymentMethod,
      "paymentStatus": "FAILED",
      "presentmentCurrency": "AED",
      "previousSubscriptionOrder": SubscriptionOrder,
      "priceStatus": "CALCULATED",
      "processedAt": 1592577642,
      "retryPaymentAt": 1592577642,
      "shopCurrency": "AED",
      "skipped": false,
      "skippedAt": 1592577642,
      "skippedByPlatform": true,
      "skippedReason": "xyz789",
      "status": "CANCELLED",
      "subscription": Subscription,
      "subscriptionDiscounts": [SubscriptionDiscount],
      "trailingProcessedOrdersCount": Count,
      "unflaggedAt": 1592577642,
      "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": "xyz789",
  "before": "abc123",
  "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": "abc123",
  "before": "xyz789",
  "first": 987,
  "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
    }
    upcomingDeliverySlots {
      ...DeliverySlotFragment
    }
    userErrors {
      ...UserErrorFragment
    }
  }
}

Variables

{"input": SubscriptionResumeInput}

Response

{
  "data": {
    "subscriptionResume": {
      "subscription": Subscription,
      "upcomingDeliverySlots": [DeliverySlot],
      "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
    }
    upcomingDeliverySlots {
      ...DeliverySlotFragment
    }
    userErrors {
      ...UserErrorFragment
    }
  }
}

Variables

{"input": SubscriptionSetScheduleInput}

Response

{
  "data": {
    "subscriptionSetSchedule": {
      "subscription": Subscription,
      "upcomingDeliverySlots": [DeliverySlot],
      "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": "abc123",
  "subscriptions": [Subscription],
  "updatedAt": 1592577642
}

Objects

SubscriptionOrder

Description

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

Fields

Field Name	Description
`assignedShippingOption` - `SubscriptionDeliveryShippingOption`	Translation missing: en.graphql.objects.subscription_order.fields.assigned_shipping_option
`billingBehaviour` - `SubscriptionBillingBehaviour!`	Translation missing: en.graphql.objects.subscription_order.fields.billing_behaviour
`buildStatus` - `SubscriptionOrderBuildStatus!`	Translation missing: en.graphql.objects.subscription_order.fields.build_status
`cancelledAt` - `Timestamp`	Translation missing: en.graphql.objects.subscription_order.fields.cancelled_at
`createdAt` - `Timestamp!`	Translation missing: en.graphql.objects.subscription_order.fields.created_at
`customAttributes` - `[CustomAttribute!]!`	Translation missing: en.graphql.objects.subscription_order.fields.custom_attributes
`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
`events` - `SubscriptionEventConnection!`	Translation missing: en.graphql.objects.subscription_order.fields.events
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.
`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
`externalCycleIndex` - `Count`	Translation missing: en.graphql.objects.subscription_order.fields.external_cycle_index
`failedBuildCount` - `Count!`	Translation missing: en.graphql.objects.subscription_order.fields.failed_build_count
`failedPaymentCaptureCount` - `Count!`	Translation missing: en.graphql.objects.subscription_order.fields.failed_payment_capture_count
`financials` - `SubscriptionOrderFinancials`
`financialsSet` - `SubscriptionOrderFinancialsSet!`	Translation missing: en.graphql.objects.subscription_order.fields.financials_set
`flagged` - `Boolean!`	Translation missing: en.graphql.objects.subscription_order.fields.flagged
`flaggedAt` - `Timestamp`	Translation missing: en.graphql.objects.subscription_order.fields.flagged_at
`flaggedDescription` - `String`	Translation missing: en.graphql.objects.subscription_order.fields.flagged_description
`flaggedReason` - `SubscriptionOrderFlaggedReason`	Translation missing: en.graphql.objects.subscription_order.fields.flagged_reason
`id` - `GlobalID!`	Translation missing: en.graphql.objects.subscription_order.fields.id
`identifier` - `String!`	Translation missing: en.graphql.objects.subscription_order.fields.identifier
`lastBuildErrors` - `[String!]!`	Translation missing: en.graphql.objects.subscription_order.fields.last_build_errors
`lastPaymentMethodUpdateEvent` - `SubscriptionEvent`	Translation missing: en.graphql.objects.subscription_order.fields.last_payment_method_update_event
`leadingScheduledOrdersCount` - `Count!`	Translation missing: en.graphql.objects.subscription_order.fields.leading_scheduled_orders_count
`lines` - `[SubscriptionOrderLine!]`
`multiCurrency` - `Boolean!`	Translation missing: en.graphql.objects.subscription_order.fields.multi_currency
`nextSubscriptionOrder` - `SubscriptionOrder`	Translation missing: en.graphql.objects.subscription_order.fields.next_subscription_order
`notes` - `String`	Translation missing: en.graphql.objects.subscription_order.fields.notes
`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
`presentmentCurrency` - `CurrencyCode!`	Translation missing: en.graphql.objects.subscription_order.fields.presentment_currency
`previousSubscriptionOrder` - `SubscriptionOrder`	Translation missing: en.graphql.objects.subscription_order.fields.previous_subscription_order
`priceStatus` - `SubscriptionOrderPriceStatus!`	Translation missing: en.graphql.objects.subscription_order.fields.price_status
`processedAt` - `Timestamp`	Translation missing: en.graphql.objects.subscription_order.fields.processed_at
`retryPaymentAt` - `Timestamp`	Translation missing: en.graphql.objects.subscription_order.fields.retry_payment_at
`shopCurrency` - `CurrencyCode!`	Translation missing: en.graphql.objects.subscription_order.fields.shop_currency
`skipped` - `Boolean!`	Translation missing: en.graphql.objects.subscription_order.fields.skipped
`skippedAt` - `Timestamp`	Translation missing: en.graphql.objects.subscription_order.fields.skipped_at
`skippedByPlatform` - `Boolean!`	Translation missing: en.graphql.objects.subscription_order.fields.skipped_by_platform
`skippedReason` - `String`	Translation missing: en.graphql.objects.subscription_order.fields.skipped_reason
`status` - `SubscriptionOrderStatus!`	Translation missing: en.graphql.objects.subscription_order.fields.status
`subscription` - `Subscription!`	Translation missing: en.graphql.objects.subscription_order.fields.subscription
`subscriptionDiscounts` - `[SubscriptionDiscount!]!`	Translation missing: en.graphql.objects.subscription_order.fields.subscription_discounts
`trailingProcessedOrdersCount` - `Count!`	Translation missing: en.graphql.objects.subscription_order.fields.trailing_processed_orders_count
`unflaggedAt` - `Timestamp`	Translation missing: en.graphql.objects.subscription_order.fields.unflagged_at
`updatedAt` - `Timestamp!`	Translation missing: en.graphql.objects.subscription_order.fields.updated_at

Example

{
  "assignedShippingOption": SubscriptionDeliveryShippingOption,
  "billingBehaviour": SubscriptionBillingBehaviour,
  "buildStatus": "BUILDING",
  "cancelledAt": 1592577642,
  "createdAt": 1592577642,
  "customAttributes": [CustomAttribute],
  "customer": Customer,
  "customised": true,
  "cycleEndAt": 1592577642,
  "cycleIndex": Count,
  "cycleStartAt": 1592577642,
  "deliveryBehaviour": SubscriptionDeliveryBehaviour,
  "deliveryMethod": SubscriptionDeliveryMethodShipping,
  "events": SubscriptionEventConnection,
  "expectedBillingAt": 1592577642,
  "expectedDeliveryAt": 1592577642,
  "externalCycleIndex": Count,
  "failedBuildCount": Count,
  "failedPaymentCaptureCount": Count,
  "financials": SubscriptionOrderFinancials,
  "financialsSet": SubscriptionOrderFinancialsSet,
  "flagged": true,
  "flaggedAt": 1592577642,
  "flaggedDescription": "xyz789",
  "flaggedReason": "BUILD_FAILED",
  "id": GlobalID,
  "identifier": "abc123",
  "lastBuildErrors": ["xyz789"],
  "lastPaymentMethodUpdateEvent": SubscriptionEvent,
  "leadingScheduledOrdersCount": Count,
  "lines": [SubscriptionOrderLine],
  "multiCurrency": true,
  "nextSubscriptionOrder": SubscriptionOrder,
  "notes": "xyz789",
  "order": Order,
  "paused": false,
  "paymentIntent": PaymentIntent,
  "paymentMethod": PaymentMethod,
  "paymentStatus": "FAILED",
  "presentmentCurrency": "AED",
  "previousSubscriptionOrder": SubscriptionOrder,
  "priceStatus": "CALCULATED",
  "processedAt": 1592577642,
  "retryPaymentAt": 1592577642,
  "shopCurrency": "AED",
  "skipped": false,
  "skippedAt": 1592577642,
  "skippedByPlatform": true,
  "skippedReason": "abc123",
  "status": "CANCELLED",
  "subscription": Subscription,
  "subscriptionDiscounts": [SubscriptionDiscount],
  "trailingProcessedOrdersCount": Count,
  "unflaggedAt": 1592577642,
  "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
    exchangeRate
    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",
      "exchangeRate": 987.65,
      "externalId": "abc123",
      "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": "abc123",
  "before": "xyz789",
  "first": 123,
  "last": 987
}

Response

{
  "data": {
    "charges": {
      "edges": [ChargeEdge],
      "nodes": [Charge],
      "pageInfo": PageInfo,
      "totalCount": 987
    }
  }
}

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.
`exchangeRate` - `Float`	The exchange rate between the presentment currency and the shop's currency.
`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",
  "exchangeRate": 987.65,
  "externalId": "xyz789",
  "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
    }
    exchangeRate
    finalisedAt
    flexible
    id
    metadata
    paymentMethod {
      ...PaymentMethodFragment
    }
    refunds {
      ...RefundFragment
    }
    settlementAmount {
      ...MoneyFragment
    }
    status
    updatedAt
  }
}

Variables

{"id": GlobalID}

Response

{
  "data": {
    "paymentIntent": {
      "adjustments": [PaymentIntentAdjustment],
      "amount": Money,
      "amountPaid": Money,
      "amountRefunded": Money,
      "balanceOwing": Money,
      "charges": [Charge],
      "createdAt": ISO8601DateTime,
      "customer": Customer,
      "exchangeRate": 123.45,
      "finalisedAt": ISO8601DateTime,
      "flexible": true,
      "id": GlobalID,
      "metadata": Metadata,
      "paymentMethod": PaymentMethod,
      "refunds": [Refund],
      "settlementAmount": Money,
      "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": "abc123",
  "first": 987,
  "last": 987
}

Response

{
  "data": {
    "paymentIntents": {
      "edges": [PaymentIntentEdge],
      "nodes": [PaymentIntent],
      "pageInfo": PageInfo,
      "totalCount": 123
    }
  }
}

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.
Arguments `id` - `GlobalID` The charge's ID.
`createdAt` - `ISO8601DateTime!`	PaymentIntent creation time
`customer` - `Customer!`	The customer
`exchangeRate` - `Float`	The exchange rate between the payment intent currency and the settlement currency.
`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.
`settlementAmount` - `Money`
`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,
  "exchangeRate": 987.65,
  "finalisedAt": ISO8601DateTime,
  "flexible": false,
  "id": GlobalID,
  "metadata": Metadata,
  "paymentMethod": PaymentMethod,
  "refunds": [Refund],
  "settlementAmount": Money,
  "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
    }
    revokedAt
    revokedReason
    status
    updatedAt
  }
}

Variables

{"id": GlobalID}

Response

{
  "data": {
    "paymentMethod": {
      "activePaymentInstrument": PaymentInstrument,
      "channel": Channel,
      "createdAt": ISO8601DateTime,
      "customer": Customer,
      "externalId": "xyz789",
      "futureUsage": "ONE_OFF",
      "id": GlobalID,
      "metadata": Metadata,
      "paymentInstruments": [PaymentInstrument],
      "paymentIntents": PaymentIntentConnection,
      "revokedAt": ISO8601DateTime,
      "revokedReason": "xyz789",
      "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": "abc123",
  "before": "abc123",
  "customerId": GlobalID,
  "first": 123,
  "futureUsage": ["ONE_OFF"],
  "last": 987,
  "paymentInstrumentType": ["AFTERPAY"],
  "status": ["ACTIVE"]
}

Response

{
  "data": {
    "paymentMethods": {
      "edges": [PaymentMethodEdge],
      "nodes": [PaymentMethod],
      "pageInfo": PageInfo,
      "totalCount": 987
    }
  }
}

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.
`revokedAt` - `ISO8601DateTime`
`revokedReason` - `String`
`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,
  "revokedAt": ISO8601DateTime,
  "revokedReason": "abc123",
  "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
    exchangeRate
    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",
      "exchangeRate": 123.45,
      "externalId": "abc123",
      "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": 123,
  "last": 123
}

Response

{
  "data": {
    "refunds": {
      "edges": [RefundEdge],
      "nodes": [Refund],
      "pageInfo": PageInfo,
      "totalCount": 987
    }
  }
}

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.
`exchangeRate` - `Float`	The exchange rate between the presentment currency and the shop's currency.
`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",
  "exchangeRate": 987.65,
  "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": "abc123",
  "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": "abc123",
  "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": 987
}

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": "xyz789",
  "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": 987
}

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": "xyz789",
  "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

DiscountAgreementConnection

Description

The connection type for DiscountAgreement.

Fields

Field Name	Description
`edges` - `[DiscountAgreementEdge]`	A list of edges.
`nodes` - `[DiscountAgreement]`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`	The total number of items in the collection

Example

{
  "edges": [DiscountAgreementEdge],
  "nodes": [DiscountAgreement],
  "pageInfo": PageInfo,
  "totalCount": 987
}

Connections

DiscountAgreementEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination.
`node` - `DiscountAgreement`	The item at the end of the edge.

Example

{
  "cursor": "abc123",
  "node": DiscountAgreement
}

Connections

DiscountApplicationConnection

Description

The connection type for DiscountApplication.

Fields

Field Name	Description
`edges` - `[DiscountApplicationEdge]`	A list of edges.
`nodes` - `[DiscountApplication]`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`	The total number of items in the collection

Example

{
  "edges": [DiscountApplicationEdge],
  "nodes": [DiscountApplication],
  "pageInfo": PageInfo,
  "totalCount": 987
}

Connections

DiscountApplicationEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination.
`node` - `DiscountApplication`	The item at the end of the edge.

Example

{
  "cursor": "xyz789",
  "node": DiscountApplication
}

Connections

DiscountCodeConnection

Description

The connection type for DiscountCode.

Fields

Field Name	Description
`edges` - `[DiscountCodeEdge]`	A list of edges.
`nodes` - `[DiscountCode]`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`	The total number of items in the collection

Example

{
  "edges": [DiscountCodeEdge],
  "nodes": [DiscountCode],
  "pageInfo": PageInfo,
  "totalCount": 987
}

Connections

DiscountCodeEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination.
`node` - `DiscountCode`	The item at the end of the edge.

Example

{
  "cursor": "abc123",
  "node": DiscountCode
}

Connections

DiscountConnection

Description

The connection type for Discount.

Fields

Field Name	Description
`edges` - `[DiscountEdge]`	A list of edges.
`nodes` - `[Discount]`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`	The total number of items in the collection

Example

{
  "edges": [DiscountEdge],
  "nodes": [Discount],
  "pageInfo": PageInfo,
  "totalCount": 123
}

Connections

DiscountEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination.
`node` - `Discount`	The item at the end of the edge.

Example

{
  "cursor": "xyz789",
  "node": Discount
}

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": "abc123",
  "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": "xyz789",
  "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": "abc123",
  "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": "abc123",
  "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": "abc123",
  "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": "xyz789",
  "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!`	The total number of items in the collection.

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!`	The total number of items in the collection.

Example

{
  "edges": [ProductEdge],
  "nodes": [Product],
  "pageInfo": PageInfo,
  "totalCount": 123
}

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": "xyz789",
  "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!`	The total number of items in the collection.

Example

{
  "edges": [ProductVariantEdge],
  "nodes": [ProductVariant],
  "pageInfo": PageInfo,
  "totalCount": 987
}

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": "abc123",
  "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": "abc123",
  "node": Subscription
}

Connections

SubscriptionEventConnection

Description

The connection type for SubscriptionEvent.

Fields

Field Name	Description
`edges` - `[SubscriptionEventEdge]`	A list of edges.
`nodes` - `[SubscriptionEvent]`	A list of nodes.
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`totalCount` - `Int!`	The total number of items in the collection.

Example

{
  "edges": [SubscriptionEventEdge],
  "nodes": [SubscriptionEvent],
  "pageInfo": PageInfo,
  "totalCount": 123
}

Connections

SubscriptionEventEdge

Description

An edge in a connection.

Fields

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination.
`node` - `SubscriptionEvent`	The item at the end of the edge.

Example

{
  "cursor": "abc123",
  "node": SubscriptionEvent
}

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": 123
}

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": 987
}

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": "abc123",
  "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": 123
}

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": "xyz789",
  "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

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

Values

Enum Value	Description
`FIRST_CAMPAIGN`	Translation missing: en.graphql.enums.campaign_payment_terms_alignment.values.first_campaign
`LAST_CAMPAIGN`	Translation missing: en.graphql.enums.campaign_payment_terms_alignment.values.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

ChannelEnvironment

Description

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

Values

Enum Value	Description
`DEVELOPMENT`	Translation missing: en.graphql.enums.channel_environment.values.development
`INTERNAL`	Translation missing: en.graphql.enums.channel_environment.values.internal
`PRODUCTION`	Translation missing: en.graphql.enums.channel_environment.values.production

Example

"DEVELOPMENT"

Enums

ChannelPriority

Description

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

Values

Enum Value	Description
`DEFAULT`	Translation missing: en.graphql.enums.channel_priority.values.default
`SEGREGATED`	Translation missing: en.graphql.enums.channel_priority.values.segregated
`VIP`	Translation missing: en.graphql.enums.channel_priority.values.vip

Example

"DEFAULT"

Enums

ChannelStatus

Description

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

Values

Enum Value	Description
`ACTIVE`	Translation missing: en.graphql.enums.channel_status.values.active
`INACTIVE`	Translation missing: en.graphql.enums.channel_status.values.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

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

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

Currency

Description

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

Values

Enum Value	Description
`COMMON`	Translation missing: en.graphql.enums.currency_type.values.common
`PRESENTMENT`	Translation missing: en.graphql.enums.currency_type.values.presentment
`SHOP`	Translation missing: en.graphql.enums.currency_type.values.shop

Example

"COMMON"

Enums

CurrencyCode

Description

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

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

DiscountAgreementStatus

Description

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

Values

Enum Value	Description
`INVALID`	Translation missing: en.graphql.enums.discount_agreement_status.values.invalid
`VALID`	Translation missing: en.graphql.enums.discount_agreement_status.values.valid

Example

"INVALID"

Enums

DiscountApplicationStatus

Description

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

Values

Enum Value	Description
`ACTIVE`	Translation missing: en.graphql.enums.discount_application_status.values.active
`INACTIVE`	Translation missing: en.graphql.enums.discount_application_status.values.inactive
`INVALID`	Translation missing: en.graphql.enums.discount_application_status.values.invalid
`REJECTED`	Translation missing: en.graphql.enums.discount_application_status.values.rejected

Example

"ACTIVE"

Enums

DiscountCategory

Description

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

Values

Enum Value	Description
`APP`	Translation missing: en.graphql.enums.discount_category.values.app
`BASIC`	Translation missing: en.graphql.enums.discount_category.values.basic
`BUY_X_GET_Y`	Translation missing: en.graphql.enums.discount_category.values.buy_x_get_y
`SHIPPING`	Translation missing: en.graphql.enums.discount_category.values.shipping
`SUBMARINE`	Translation missing: en.graphql.enums.discount_category.values.submarine

Example

"APP"

Enums

DiscountClass

Description

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

Values

Enum Value	Description
`ORDER`	Translation missing: en.graphql.enums.discount_class.values.order
`PRODUCT`	Translation missing: en.graphql.enums.discount_class.values.product
`SHIPPING`	Translation missing: en.graphql.enums.discount_class.values.shipping
`UNKNOWN`	Translation missing: en.graphql.enums.discount_class.values.unknown

Example

"ORDER"

Enums

DiscountCodeStatus

Description

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

Values

Enum Value	Description
`ACTIVE`	Translation missing: en.graphql.enums.discount_code_status.values.active
`DELETED`	Translation missing: en.graphql.enums.discount_code_status.values.deleted

Example

"ACTIVE"

Enums

DiscountStatus

Description

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

Values

Enum Value	Description
`ACTIVE`	Translation missing: en.graphql.enums.discount_status.values.active
`DELETED`	Translation missing: en.graphql.enums.discount_status.values.deleted
`EXPIRED`	Translation missing: en.graphql.enums.discount_status.values.expired
`SCHEDULED`	Translation missing: en.graphql.enums.discount_status.values.scheduled

Example

"ACTIVE"

Enums

DiscountType

Description

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

Values

Enum Value	Description
`AUTOMATIC`	Translation missing: en.graphql.enums.discount_type.values.automatic
`CODE`	Translation missing: en.graphql.enums.discount_type.values.code
`MANUAL`	Translation missing: en.graphql.enums.discount_type.values.manual
`SCHEDULED`	Translation missing: en.graphql.enums.discount_type.values.scheduled
`SCRIPT`	Translation missing: en.graphql.enums.discount_type.values.script

Example

"AUTOMATIC"

Enums

DiscountValidationError

Description

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

Values

Enum Value	Description
`DISCOUNT_DELETED`	Translation missing: en.graphql.enums.discount_validation_error.values.discount_deleted
`EXPIRED`	Translation missing: en.graphql.enums.discount_validation_error.values.expired
`INCOMPATIBLE_DISCOUNT_CLASS`	Translation missing: en.graphql.enums.discount_validation_error.values.incompatible_discount_class
`INVALID`	Translation missing: en.graphql.enums.discount_validation_error.values.invalid
`PURCHASE_NOT_IN_RANGE`	Translation missing: en.graphql.enums.discount_validation_error.values.purchase_not_in_range
`QUANTITY_NOT_IN_RANGE`	Translation missing: en.graphql.enums.discount_validation_error.values.quantity_not_in_range
`RECURRING_USAGE_LIMIT_REACHED`	Translation missing: en.graphql.enums.discount_validation_error.values.recurring_usage_limit_reached
`SCHEDULED`	Translation missing: en.graphql.enums.discount_validation_error.values.scheduled
`TOTAL_USAGE_LIMIT_REACHED`	Translation missing: en.graphql.enums.discount_validation_error.values.total_usage_limit_reached
`UNSUPPORTED`	Translation missing: en.graphql.enums.discount_validation_error.values.unsupported

Example

"DISCOUNT_DELETED"

Enums

DiscountValueType

Description

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

Values

Enum Value	Description
`FIXED_AMOUNT`	Translation missing: en.graphql.enums.discount_value_type.values.fixed_amount
`PERCENTAGE`	Translation missing: en.graphql.enums.discount_value_type.values.percentage
`UNKNOWN`	Translation missing: en.graphql.enums.discount_value_type.values.unknown

Example

"FIXED_AMOUNT"

Enums

EventDiffAction

Description

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

Values

Enum Value	Description
`ADDITION`	Translation missing: en.graphql.enums.event_diff_action.values.addition
`CHANGE`	Translation missing: en.graphql.enums.event_diff_action.values.change
`DELETION`	Translation missing: en.graphql.enums.event_diff_action.values.deletion

Example

"ADDITION"

Enums

EventMilestone

Description

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

Values

Enum Value	Description
`ADD_LINE`	Translation missing: en.graphql.enums.event_milestone.values.add_line
`FAILED`	Translation missing: en.graphql.enums.event_milestone.values.failed
`REMOVE_LINE`	Translation missing: en.graphql.enums.event_milestone.values.remove_line
`SET_LINE_QUANTITY`	Translation missing: en.graphql.enums.event_milestone.values.set_line_quantity
`STARTED`	Translation missing: en.graphql.enums.event_milestone.values.started
`SUCCEEDED`	Translation missing: en.graphql.enums.event_milestone.values.succeeded

Example

"ADD_LINE"

Enums

EventStatus

Description

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

Values

Enum Value	Description
`FAILED`	Translation missing: en.graphql.enums.event_status.values.failed
`PENDING`	Translation missing: en.graphql.enums.event_status.values.pending
`SUCCEEDED`	Translation missing: en.graphql.enums.event_status.values.succeeded

Example

"FAILED"

Enums

ExportDeliveryMechanism

Description

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

Values

Enum Value	Description
`EMAIL`	Translation missing: en.graphql.enums.export_delivery_mechanism.values.email
`INLINE`	Translation missing: en.graphql.enums.export_delivery_mechanism.values.inline

Example

"EMAIL"

Enums

ExportResource

Description

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

Values

Enum Value	Description
`SUBSCRIPTION`	Translation missing: en.graphql.enums.export_resource_type.values.subscription
`SUBSCRIPTION_ORDER`	Translation missing: en.graphql.enums.export_resource_type.values.subscription_order

Example

"SUBSCRIPTION"

Enums

ExportStatus

Description

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

Values

Enum Value	Description
`CREATED`	Translation missing: en.graphql.enums.export_status.values.created
`PENDING`	Translation missing: en.graphql.enums.export_status.values.pending

Example

"CREATED"

Enums

MoneyRoundingMode

Description

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

Values

Enum Value	Description
`ROUND_CEILING`	Translation missing: en.graphql.enums.money_rounding_mode.values.round_ceiling
`ROUND_DOWN`	Translation missing: en.graphql.enums.money_rounding_mode.values.round_down
`ROUND_FLOOR`	Translation missing: en.graphql.enums.money_rounding_mode.values.round_floor
`ROUND_HALF_DOWN`	Translation missing: en.graphql.enums.money_rounding_mode.values.round_half_down
`ROUND_HALF_EVEN`	Translation missing: en.graphql.enums.money_rounding_mode.values.round_half_even
`ROUND_HALF_UP`	Translation missing: en.graphql.enums.money_rounding_mode.values.round_half_up
`ROUND_UP`	Translation missing: en.graphql.enums.money_rounding_mode.values.round_up

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

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

Values

Enum Value	Description
`CROWDFUND_END_AT`	Translation missing: en.graphql.enums.notification_schedule_trigger.values.crowdfund_end_at
`PRESALE_DUE_AT`	Translation missing: en.graphql.enums.notification_schedule_trigger.values.presale_due_at
`SUBSCRIPTION_ORDER_BILLING_AT`	Translation missing: en.graphql.enums.notification_schedule_trigger.values.subscription_order_billing_at
`UPCOMING_CARD_EXPIRY`	Translation missing: en.graphql.enums.notification_schedule_trigger.values.upcoming_card_expiry

Example

"CROWDFUND_END_AT"

Enums

OrganisationStatus

Description

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

Values

Enum Value	Description
`ACTIVE`	Translation missing: en.graphql.enums.organisation_status.values.active
`INACTIVE`	Translation missing: en.graphql.enums.organisation_status.values.inactive

Example

"ACTIVE"

Enums

PaymentInstrumentType

Description

The types of payment instrument supported by Submarine.

Values

Enum Value	Description
`AFTERPAY`	Afterpay
`AIRWALLEX`	Airwallex
`CARD`	Card
`KLARNA`	Klarna
`PAYPAL_BILLING_AGREEMENT`	Paypal billing agreement
`PAYPAL_WALLET`	Paypal wallet
`UNKNOWN`

Example

"AFTERPAY"

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
`REVOKED`	Payment method revoked

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

Description

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

Values

Enum Value	Description
`ON_FULFILMENT`	Translation missing: en.graphql.enums.presale_inventory_policy.values.on_fulfilment
`ON_SALE`	Translation missing: en.graphql.enums.presale_inventory_policy.values.on_sale

Example

"ON_FULFILMENT"

Enums

PriceCalculationStatus

Description

The status of a price calculation.

Values

Enum Value	Description
`CALCULATED`	Price calculation is calculated
`CALCULATING`	Price calculation is calculating
`FAILED`	Price calculation is failed
`PENDING`	Price calculation is pending

Example

"CALCULATED"

Enums

PriceEnginePolicy

Description

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

Values

Enum Value	Description
`ALWAYS`	Translation missing: en.graphql.enums.price_engine_policy.values.always
`ON_DEMAND`	Translation missing: en.graphql.enums.price_engine_policy.values.on_demand

Example

"ALWAYS"

Enums

PriceEngineProvider

Description

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

Values

Enum Value	Description
`SHOPIFY`	Translation missing: en.graphql.enums.price_engine_provider.values.shopify

Example

"SHOPIFY"

Enums

PriceEngineType

Description

The possible price engine types.

Values

Enum Value	Description
`SHOPIFY`	The price engine type is Shopify.

Example

"SHOPIFY"

Enums

PriceSetResourceType

Description

The possible price set's resource types.

Values

Enum Value	Description
`CAMPAIGN_ORDER`	The resource is a campaign order
`CAMPAIGN_ORDER_GROUP`	The resource is a campaign order group
`SUBSCRIPTION_ORDER`	The resource is a subscription order
`SUBSCRIPTION_ORDER_LINE`	The resource is a subscription order line

Example

"CAMPAIGN_ORDER"

Enums

ProductCollectionItemStatus

Description

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

Values

Enum Value	Description
`ACTIVE`	Translation missing: en.graphql.enums.product_collection_item_status.values.active
`PENDING`	Translation missing: en.graphql.enums.product_collection_item_status.values.pending

Example

"ACTIVE"

Enums

ProductCollectionStatus

Description

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

Values

Enum Value	Description
`PUBLISHED`	Translation missing: en.graphql.enums.product_collection_status.values.published
`UNPUBLISHED`	Translation missing: en.graphql.enums.product_collection_status.values.unpublished

Example

"PUBLISHED"

Enums

ProductStatus

Description

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

Values

Enum Value	Description
`PUBLISHED`	Translation missing: en.graphql.enums.product_status.values.published
`UNPUBLISHED`	Translation missing: en.graphql.enums.product_status.values.unpublished

Example

"PUBLISHED"

Enums

ProductVariantStatus

Description

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

Values

Enum Value	Description
`PUBLISHED`	Translation missing: en.graphql.enums.product_variant_status.values.published
`UNPUBLISHED`	Translation missing: en.graphql.enums.product_variant_status.values.unpublished

Example

"PUBLISHED"

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
`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

ResourceType

Description

The possible resource types.

Values

Enum Value	Description
`CAMPAIGN_ORDER_GROUP`	The resource is a campaign order group
`SUBSCRIPTION_ORDER`	The resource is a subscription order

Example

"CAMPAIGN_ORDER_GROUP"

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

SourceType

Description

The possible source types.

Values

Enum Value	Description
`CALCULATED_DRAFT_ORDER`
`GENERATED_ORDER`
`GENERATED_ORDER_MONGREL`
`ORDER`
`SUBSCRIPTION_ORDER_MONGREL`

Example

"CALCULATED_DRAFT_ORDER"

Enums

SubscriptionAnchorType

Description

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

Values

Enum Value	Description
`FLEXIBLE`	Translation missing: en.graphql.enums.subscription_anchor_type.values.flexible
`MONTHDAY`	Translation missing: en.graphql.enums.subscription_anchor_type.values.monthday
`WEEKDAY`	Translation missing: en.graphql.enums.subscription_anchor_type.values.weekday
`YEARDAY`	Translation missing: en.graphql.enums.subscription_anchor_type.values.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

Description

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

Values

Enum Value	Description
`CUSTOM`	Translation missing: en.graphql.enums.subscription_base_price_policy.values.custom
`FIXED`	Translation missing: en.graphql.enums.subscription_base_price_policy.values.fixed
`ON_BILLING_ATTEMPT`	Translation missing: en.graphql.enums.subscription_base_price_policy.values.on_billing_attempt
`ON_SUBSCRIPTION_CREATE`	Translation missing: en.graphql.enums.subscription_base_price_policy.values.on_subscription_create

Example

"CUSTOM"

Enums

SubscriptionDeliveryBehaviourType

Description

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

Values

Enum Value	Description
`FIXED`	Translation missing: en.graphql.enums.subscription_delivery_behaviour_type.values.fixed
`FLEXIBLE`	Translation missing: en.graphql.enums.subscription_delivery_behaviour_type.values.flexible

Example

"FIXED"

Enums

SubscriptionDeliveryMethodType

Description

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

Values

Enum Value	Description
`DIGITAL`	Translation missing: en.graphql.enums.subscription_delivery_method_type.values.digital
`LOCAL`	Translation missing: en.graphql.enums.subscription_delivery_method_type.values.local
`PICKUP`	Translation missing: en.graphql.enums.subscription_delivery_method_type.values.pickup
`SHIPPING`	Translation missing: en.graphql.enums.subscription_delivery_method_type.values.shipping
`UNKNOWN`	Translation missing: en.graphql.enums.subscription_delivery_method_type.values.unknown

Example

"DIGITAL"

Enums

SubscriptionDeliveryPreAnchorBehaviourType

Description

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

Values

Enum Value	Description
`ASAP`	Translation missing: en.graphql.enums.subscription_delivery_pre_anchor_behaviour_type.values.asap
`NEXT`	Translation missing: en.graphql.enums.subscription_delivery_pre_anchor_behaviour_type.values.next

Example

"ASAP"

Enums

SubscriptionDiscountStatus

Description

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

Values

Enum Value	Description
`ACTIVE`	Translation missing: en.graphql.enums.subscription_discount_status.values.active
`INACTIVE`	Translation missing: en.graphql.enums.subscription_discount_status.values.inactive
`INVALID`	Translation missing: en.graphql.enums.subscription_discount_status.values.invalid
`PENDING`	Translation missing: en.graphql.enums.subscription_discount_status.values.pending
`REJECTED`	Translation missing: en.graphql.enums.subscription_discount_status.values.rejected

Example

"ACTIVE"

Enums

SubscriptionEngine

Description

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

Values

Enum Value	Description
`NOOP`	Translation missing: en.graphql.enums.subscription_engine.values.noop
`SHOPIFY`	Translation missing: en.graphql.enums.subscription_engine.values.shopify
`SUBMARINE`	Translation missing: en.graphql.enums.subscription_engine.values.submarine

Example

"NOOP"

Enums

SubscriptionEventAction

Description

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

Values

Enum Value	Description
`ACTIVATE`	Translation missing: en.graphql.enums.subscription_event_action.values.activate
`APPLY`	Translation missing: en.graphql.enums.subscription_event_action.values.apply
`APPLY_DISCOUNT`	Translation missing: en.graphql.enums.subscription_event_action.values.apply_discount
`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
`DIAGNOSE`	Translation missing: en.graphql.enums.subscription_event_action.values.diagnose
`FLAG`	Translation missing: en.graphql.enums.subscription_event_action.values.flag
`PAUSE`	Translation missing: en.graphql.enums.subscription_event_action.values.pause
`PROCESS`	Translation missing: en.graphql.enums.subscription_event_action.values.process
`REMOVE`	Translation missing: en.graphql.enums.subscription_event_action.values.remove
`REMOVE_DISCOUNT`	Translation missing: en.graphql.enums.subscription_event_action.values.remove_discount
`RESCHEDULE`	Translation missing: en.graphql.enums.subscription_event_action.values.reschedule
`RESTORE`	Translation missing: en.graphql.enums.subscription_event_action.values.restore
`RESUME`	Translation missing: en.graphql.enums.subscription_event_action.values.resume
`REVERT_SCHEDULED_CANCELLATION`	Translation missing: en.graphql.enums.subscription_event_action.values.revert_scheduled_cancellation
`SCHEDULE_CANCELLATION`	Translation missing: en.graphql.enums.subscription_event_action.values.schedule_cancellation
`SET_SCHEDULE`	Translation missing: en.graphql.enums.subscription_event_action.values.set_schedule
`SKIP`	Translation missing: en.graphql.enums.subscription_event_action.values.skip
`UNFLAG`	Translation missing: en.graphql.enums.subscription_event_action.values.unflag
`UNSKIP`	Translation missing: en.graphql.enums.subscription_event_action.values.unskip
`UPDATE`	Translation missing: en.graphql.enums.subscription_event_action.values.update
`VALIDATE`	Translation missing: en.graphql.enums.subscription_event_action.values.validate

Example

"ACTIVATE"

Enums

SubscriptionHealthStatus

Description

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

Values

Enum Value	Description
`AT_RISK`	Translation missing: en.graphql.enums.subscription_health_status.values.at_risk
`BROKEN`	Translation missing: en.graphql.enums.subscription_health_status.values.broken
`HEALTHY`	Translation missing: en.graphql.enums.subscription_health_status.values.healthy
`RECOVERED`	Translation missing: en.graphql.enums.subscription_health_status.values.recovered
`UNHEALTHY`	Translation missing: en.graphql.enums.subscription_health_status.values.unhealthy
`UNKNOWN`	Translation missing: en.graphql.enums.subscription_health_status.values.unknown

Example

"AT_RISK"

Enums

SubscriptionHealthTest

Description

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

Values

Enum Value	Description
`LIMITED_SCHEDULED_ORDERS`	Translation missing: en.graphql.enums.subscription_health_test.values.limited_scheduled_orders
`MULTIPLE_ORDERS_DUE`	Translation missing: en.graphql.enums.subscription_health_test.values.multiple_orders_due
`NO_SCHEDULED_ORDERS`	Translation missing: en.graphql.enums.subscription_health_test.values.no_scheduled_orders
`ONLY_FLAGGED_ORDERS_DUE`	Translation missing: en.graphql.enums.subscription_health_test.values.only_flagged_orders_due
`PROCESSED_FLAGGED_ORDERS`	Translation missing: en.graphql.enums.subscription_health_test.values.processed_flagged_orders

Example

"LIMITED_SCHEDULED_ORDERS"

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

Description

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

Values

Enum Value	Description
`NONE`	Translation missing: en.graphql.enums.subscription_inventory_decrement_policy.values.none
`ON_ORDER_CREATION`	Translation missing: en.graphql.enums.subscription_inventory_decrement_policy.values.on_order_creation
`ON_ORDER_FULFILMENT`	Translation missing: en.graphql.enums.subscription_inventory_decrement_policy.values.on_order_fulfilment

Example

"NONE"

Enums

SubscriptionInventoryOutOfStockPolicy

Description

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

Values

Enum Value	Description
`PAUSE_SUBSCRIPTION`	Translation missing: en.graphql.enums.subscription_inventory_out_of_stock_policy.values.pause_subscription
`REPLACE_ITEM`	Translation missing: en.graphql.enums.subscription_inventory_out_of_stock_policy.values.replace_item
`SKIP_ITEM`	Translation missing: en.graphql.enums.subscription_inventory_out_of_stock_policy.values.skip_item
`SKIP_ORDER`	Translation missing: en.graphql.enums.subscription_inventory_out_of_stock_policy.values.skip_order

Example

"PAUSE_SUBSCRIPTION"

Enums

SubscriptionLineItemDataLine

Description

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

Values

Enum Value	Description
`ONE_OFF`	Translation missing: en.graphql.enums.subscription_line_item_data_line_type.values.one_off
`RECURRING`	Translation missing: en.graphql.enums.subscription_line_item_data_line_type.values.recurring

Example

"ONE_OFF"

Enums

SubscriptionLineStatus

Description

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

Values

Enum Value	Description
`ACTIVE`	Translation missing: en.graphql.enums.subscription_line_status.values.active
`DELETED`	Translation missing: en.graphql.enums.subscription_line_status.values.deleted
`INACTIVE`	Translation missing: en.graphql.enums.subscription_line_status.values.inactive

Example

"ACTIVE"

Enums

SubscriptionOffsetInterval

Description

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

Values

Enum Value	Description
`DAY`	Translation missing: en.graphql.enums.subscription_offset_interval.values.day
`HOUR`	Translation missing: en.graphql.enums.subscription_offset_interval.values.hour

Example

"DAY"

Enums

SubscriptionOffsetType

Description

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

Values

Enum Value	Description
`BUSINESS`	Translation missing: en.graphql.enums.subscription_offset_type.values.business
`CALENDAR`	Translation missing: en.graphql.enums.subscription_offset_type.values.calendar

Example

"BUSINESS"

Enums

SubscriptionOrderBuildStatus

Description

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

Values

Enum Value	Description
`BUILDING`	Translation missing: en.graphql.enums.subscription_order_build_status.values.building
`FAILED`	Translation missing: en.graphql.enums.subscription_order_build_status.values.failed
`PENDING`	Translation missing: en.graphql.enums.subscription_order_build_status.values.pending
`SUCCEEDED`	Translation missing: en.graphql.enums.subscription_order_build_status.values.succeeded
`THROTTLED`	Translation missing: en.graphql.enums.subscription_order_build_status.values.throttled

Example

"BUILDING"

Enums

SubscriptionOrderFlaggedReason

Description

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

Values

Enum Value	Description
`BUILD_FAILED`	Translation missing: en.graphql.enums.subscription_order_flagged_reason.values.build_failed
`SCHEDULE_FAILED`	Translation missing: en.graphql.enums.subscription_order_flagged_reason.values.schedule_failed
`UPDATE_FAILED`	Translation missing: en.graphql.enums.subscription_order_flagged_reason.values.update_failed

Example

"BUILD_FAILED"

Enums

SubscriptionOrderLineStatus

Description

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

Values

Enum Value	Description
`ACTIVE`	Translation missing: en.graphql.enums.subscription_order_line_status.values.active
`DELETED`	Translation missing: en.graphql.enums.subscription_order_line_status.values.deleted
`INACTIVE`	Translation missing: en.graphql.enums.subscription_order_line_status.values.inactive

Example

"ACTIVE"

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

SubscriptionOrderPriceStatus

Description

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

Values

Enum Value	Description
`CALCULATED`	Translation missing: en.graphql.enums.subscription_order_price_status.values.calculated
`CALCULATING`	Translation missing: en.graphql.enums.subscription_order_price_status.values.calculating
`FAILED`	Translation missing: en.graphql.enums.subscription_order_price_status.values.failed
`PENDING`	Translation missing: en.graphql.enums.subscription_order_price_status.values.pending

Example

"CALCULATED"

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.
`FLAGGED_AT`
`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

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
`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
`INACTIVE`	Translation missing: en.graphql.enums.subscription_plan_status.values.inactive

Example

"ACTIVE"

Enums

SubscriptionPriceDiscountType

Description

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

Values

Enum Value	Description
`FIXED_AMOUNT`	Translation missing: en.graphql.enums.subscription_price_discount_type.values.fixed_amount
`PERCENTAGE`	Translation missing: en.graphql.enums.subscription_price_discount_type.values.percentage

Example

"FIXED_AMOUNT"

Enums

SubscriptionPriceDiscountValueCapType

Description

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

Values

Enum Value	Description
`INDIVIDUAL_ITEM`	Translation missing: en.graphql.enums.subscription_price_discount_value_cap_type.values.individual_item
`SUBSCRIPTION_ORDER`	Translation missing: en.graphql.enums.subscription_price_discount_value_cap_type.values.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
`MONTH`	Translation missing: en.graphql.enums.subscription_retry_interval.values.month
`WEEK`	Translation missing: en.graphql.enums.subscription_retry_interval.values.week
`YEAR`	Translation missing: en.graphql.enums.subscription_retry_interval.values.year

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

SubscriptionSourceType

Description

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

Values

Enum Value	Description
`API`	Translation missing: en.graphql.enums.subscription_source_type.values.api
`IMPORT`	Translation missing: en.graphql.enums.subscription_source_type.values.import
`ORDER`	Translation missing: en.graphql.enums.subscription_source_type.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
`PENDING`	Translation missing: en.graphql.enums.subscription_status.values.pending
`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

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

Values

Enum Value	Description
`BEFORE`	Translation missing: en.graphql.enums.time_offset_direction.values.before

Example

"BEFORE"

Enums

TimeOffsetUnit

Description

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

Values

Enum Value	Description
`DAYS`	Translation missing: en.graphql.enums.time_offset_unit.values.days
`HOURS`	Translation missing: en.graphql.enums.time_offset_unit.values.hours
`MINUTES`	Translation missing: en.graphql.enums.time_offset_unit.values.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
`CORE`	Translation missing: en.graphql.enums.token_target.values.core
`PAYMENTS`	payments
`PRICING`	pricing
`SUBSCRIPTIONS`	Translation missing: en.graphql.enums.token_target.values.subscriptions

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`
`EXPORT_GENERATED_ASYNC`
`PAYMENT_FAILED`
`PAYMENT_METHOD_EXPIRING`
`PRESALE_CAMPAIGN_COMPLETED`
`PRESALE_CAMPAIGN_ENDED`
`PRESALE_CAMPAIGN_LAUNCHED`
`REFUND_SUCCEEDED`
`SUBSCRIPTION_CREATED`
`SUBSCRIPTION_ORDER_FLAGGED`
`SUBSCRIPTION_ORDER_UPCOMING`
`SUBSCRIPTION_ORDER_UPDATED`
`SUBSCRIPTION_UPDATED`

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": "xyz789",
  "country": CountryInput,
  "firstName": "xyz789",
  "lastName": "abc123",
  "phone": "xyz789",
  "postcode": "abc123",
  "province": ProvinceInput,
  "street1": "abc123",
  "street2": "abc123"
}

Input Objects

BackoffPolicyInput

Description

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

Fields

Input Field	Description
`maxAttempts` - `NonZeroCount!`	Translation missing: en.graphql.inputs.backoff_policy_input.arguments.max_attempts
`multiplier` - `NonZeroCount!`	Translation missing: en.graphql.inputs.backoff_policy_input.arguments.multiplier
`thresholdSecs` - `[NonZeroCount!]!`	Translation missing: en.graphql.inputs.backoff_policy_input.arguments.threshold_secs

Example

{
  "maxAttempts": NonZeroCount,
  "multiplier": NonZeroCount,
  "thresholdSecs": [NonZeroCount]
}

Input Objects

CampaignDataInput

Description

Campaign data.

Fields

Input Field	Description
`deposit` - `CampaignDepositInput`
`id` - `ID!`	The campaign's ID.
`type` - `CampaignType!`	The campaign's type.

Example

{
  "deposit": CampaignDepositInput,
  "id": 4,
  "type": "CROWDFUNDING"
}

Input Objects

CampaignDepositInput

Description

Input for configuring a campaign deposit.

Fields

Input Field	Description
`type` - `CampaignDepositType!`	Translation missing: en.graphql.inputs.campaign_deposit_input.arguments.type
`value` - `Float!`	Translation missing: en.graphql.inputs.campaign_deposit_input.arguments.value

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": 123.45,
  "externalLineItemId": "abc123",
  "id": GlobalID,
  "paymentMethodId": GlobalID,
  "productId": GlobalID,
  "productVariantId": GlobalID,
  "quantity": 123
}

Input Objects

CampaignOrderDataInput

Description

Specifies the input fields required for campaign order data.

Fields

Input Field	Description
`campaign` - `CampaignDataInput!`	The campaign order's campaign.
`cancelled` - `Boolean!`	Indicates if the campaign order is cancelled.
`id` - `ID!`	ID of the campaign order.
`lineItem` - `LineItemDataInput!`	The campaign order's line item.

Example

{
  "campaign": CampaignDataInput,
  "cancelled": false,
  "id": "4",
  "lineItem": LineItemDataInput
}

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": 123}

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": "abc123",
  "id": GlobalID,
  "identifier": "xyz789",
  "paymentMethodId": GlobalID
}

Input Objects

CampaignOrderGroupDataInput

Fields

Input Field	Description
`campaignOrders` - `[CampaignOrderDataInput!]!`	The products which are included in the campaign
`cancelled` - `Boolean!`	Indicates if the resource is cancelled.
`customerId` - `ID!`	The customer who owns this group
`externalId` - `String!`	The campaign order group's external ID.

Example

{
  "campaignOrders": [CampaignOrderDataInput],
  "cancelled": true,
  "customerId": "4",
  "externalId": "abc123"
}

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": "abc123",
  "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": 123}

Input Objects

ChannelConfigSetInput

Description

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

Fields

Input Field	Description
`config` - `PlatformConfigSetInput!`	Translation missing: en.graphql.inputs.channel_config_set_input.arguments.config
`id` - `GlobalID!`	Translation missing: en.graphql.inputs.channel_config_set_input.arguments.id

Example

{
  "config": PlatformConfigSetInput,
  "id": GlobalID
}

Input Objects

ChannelCreateInput

Description

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

Fields

Input Field	Description
`channelType` - `ChannelType!`	Translation missing: en.graphql.inputs.channel_create_input.arguments.channel_type
`environment` - `ChannelEnvironment`	Translation missing: en.graphql.inputs.channel_create_input.arguments.environment
`externalId` - `ID!`	Translation missing: en.graphql.inputs.channel_create_input.arguments.external_id
`id` - `GlobalID`	Translation missing: en.graphql.inputs.channel_create_input.arguments.id
`identifier` - `String!`	Translation missing: en.graphql.inputs.channel_create_input.arguments.identifier
`name` - `String!`	Translation missing: en.graphql.inputs.channel_create_input.arguments.name
`organisationId` - `GlobalID!`	Translation missing: en.graphql.inputs.channel_create_input.arguments.organisation_id
`presentmentCurrencies` - `[CurrencyCode!]!`	Translation missing: en.graphql.inputs.channel_create_input.arguments.presentment_currencies
`priority` - `ChannelPriority`	Translation missing: en.graphql.inputs.channel_create_input.arguments.priority
`shopCurrency` - `CurrencyCode!`	Translation missing: en.graphql.inputs.channel_create_input.arguments.shop_currency
`status` - `ChannelStatus`	Translation missing: en.graphql.inputs.channel_create_input.arguments.status
`timezone` - `Timezone!`	Translation missing: en.graphql.inputs.channel_create_input.arguments.timezone

Example

{
  "channelType": "SHOPIFY",
  "environment": "DEVELOPMENT",
  "externalId": "4",
  "id": GlobalID,
  "identifier": "abc123",
  "name": "abc123",
  "organisationId": GlobalID,
  "presentmentCurrencies": ["AED"],
  "priority": "DEFAULT",
  "shopCurrency": "AED",
  "status": "ACTIVE",
  "timezone": Timezone
}

Input Objects

ChannelUpdateInput

Description

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

Fields

Input Field	Description
`channelType` - `ChannelType`	Translation missing: en.graphql.inputs.channel_update_input.arguments.channel_type
`environment` - `ChannelEnvironment`	Translation missing: en.graphql.inputs.channel_update_input.arguments.environment
`externalId` - `ID`	Translation missing: en.graphql.inputs.channel_update_input.arguments.external_id
`id` - `GlobalID!`	Translation missing: en.graphql.inputs.channel_update_input.arguments.id
`identifier` - `String`	Translation missing: en.graphql.inputs.channel_update_input.arguments.identifier
`name` - `String`	Translation missing: en.graphql.inputs.channel_update_input.arguments.name
`presentmentCurrencies` - `[CurrencyCode!]`	Translation missing: en.graphql.inputs.channel_update_input.arguments.presentment_currencies
`priority` - `ChannelPriority`	Translation missing: en.graphql.inputs.channel_update_input.arguments.priority
`shopCurrency` - `CurrencyCode`	Translation missing: en.graphql.inputs.channel_update_input.arguments.shop_currency
`status` - `ChannelStatus`	Translation missing: en.graphql.inputs.channel_update_input.arguments.status
`timezone` - `Timezone`	Translation missing: en.graphql.inputs.channel_update_input.arguments.timezone

Example

{
  "channelType": "SHOPIFY",
  "environment": "DEVELOPMENT",
  "externalId": 4,
  "id": GlobalID,
  "identifier": "abc123",
  "name": "xyz789",
  "presentmentCurrencies": ["AED"],
  "priority": "DEFAULT",
  "shopCurrency": "AED",
  "status": "ACTIVE",
  "timezone": Timezone
}

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": "xyz789",
  "externalId": "abc123",
  "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": 987,
  "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": "xyz789"
}

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": 123,
  "goalTotalValue": MoneyInput,
  "goalType": "TOTAL_UNITS"
}

Input Objects

CustomAttributeInput

Description

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

Fields

Input Field	Description
`name` - `String!`	Translation missing: en.graphql.inputs.custom_attribute_input.arguments.name
`value` - `String!`	Translation missing: en.graphql.inputs.custom_attribute_input.arguments.value

Example

{
  "name": "xyz789",
  "value": "abc123"
}

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": false
}

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": "xyz789",
  "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

DiscountCreateManualInput

Description

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

Fields

Input Field	Description
`combinesWithOrderDiscounts` - `Boolean`	Translation missing: en.graphql.inputs.discount_create_manual_input.arguments.combines_with_order_discounts
`combinesWithProductDiscounts` - `Boolean`	Translation missing: en.graphql.inputs.discount_create_manual_input.arguments.combines_with_product_discounts
`combinesWithShippingDiscounts` - `Boolean`	Translation missing: en.graphql.inputs.discount_create_manual_input.arguments.combines_with_shipping_discounts
`currency` - `CurrencyCode!`	Translation missing: en.graphql.inputs.discount_create_manual_input.arguments.currency
`discountClass` - `DiscountClass!`	Translation missing: en.graphql.inputs.discount_create_manual_input.arguments.discount_class
`eligibleCustomerIds` - `[GlobalID!]`	Translation missing: en.graphql.inputs.discount_create_manual_input.arguments.eligible_customer_ids
`maximumRecurringCycles` - `Int`	Translation missing: en.graphql.inputs.discount_create_manual_input.arguments.maximum_recurring_cycles
`recurring` - `Boolean!`	Translation missing: en.graphql.inputs.discount_create_manual_input.arguments.recurring
`title` - `String!`	Translation missing: en.graphql.inputs.discount_create_manual_input.arguments.title
`value` - `DiscountValueInput!`	Translation missing: en.graphql.inputs.discount_create_manual_input.arguments.value

Example

{
  "combinesWithOrderDiscounts": true,
  "combinesWithProductDiscounts": false,
  "combinesWithShippingDiscounts": true,
  "currency": "AED",
  "discountClass": "ORDER",
  "eligibleCustomerIds": [GlobalID],
  "maximumRecurringCycles": 123,
  "recurring": true,
  "title": "xyz789",
  "value": DiscountValueInput
}

Input Objects

DiscountValidateInput

Description

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

Fields

Input Field	Description
`context` - `DiscountValidationContextInput`	Translation missing: en.graphql.inputs.discount_validate_input.arguments.context
`discountAgreementId` - `GlobalID`	Translation missing: en.graphql.inputs.discount_validate_input.arguments.discount_agreement_id
`discountId` - `GlobalID`	Translation missing: en.graphql.inputs.discount_validate_input.arguments.discount_id
`discountTitle` - `String`	Translation missing: en.graphql.inputs.discount_validate_input.arguments.discount_title
`manual` - `DiscountCreateManualInput`	Translation missing: en.graphql.inputs.discount_validate_input.arguments.manual
`redeemCode` - `String`	Translation missing: en.graphql.inputs.discount_validate_input.arguments.redeem_code

Example

{
  "context": DiscountValidationContextInput,
  "discountAgreementId": GlobalID,
  "discountId": GlobalID,
  "discountTitle": "xyz789",
  "manual": DiscountCreateManualInput,
  "redeemCode": "abc123"
}

Input Objects

DiscountValidationContextInput

Description

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

Fields

Input Field	Description
`customerId` - `GlobalID`	Translation missing: en.graphql.inputs.discount_validation_context_input.arguments.customer_id
`productIds` - `[GlobalID!]`	Translation missing: en.graphql.inputs.discount_validation_context_input.arguments.product_ids
`productVariantIds` - `[GlobalID!]`	Translation missing: en.graphql.inputs.discount_validation_context_input.arguments.product_variant_ids
`recur` - `Boolean`	Translation missing: en.graphql.inputs.discount_validation_context_input.arguments.recur
`totalPrice` - `MoneyInput`	Translation missing: en.graphql.inputs.discount_validation_context_input.arguments.total_price
`virginApplication` - `Boolean`	Translation missing: en.graphql.inputs.discount_validation_context_input.arguments.virgin_application

Example

{
  "customerId": GlobalID,
  "productIds": [GlobalID],
  "productVariantIds": [GlobalID],
  "recur": true,
  "totalPrice": MoneyInput,
  "virginApplication": true
}

Input Objects

DiscountValueInput

Description

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

Fields

Input Field	Description
`amount` - `MoneyInput`	Translation missing: en.graphql.inputs.discount_value_input.arguments.amount
`percentage` - `Int`	Translation missing: en.graphql.inputs.discount_value_input.arguments.percentage
`type` - `DiscountValueType!`	Translation missing: en.graphql.inputs.discount_value_input.arguments.type

Example

{
  "amount": MoneyInput,
  "percentage": 123,
  "type": "FIXED_AMOUNT"
}

Input Objects

ErrorLogEntryInput

Description

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

Fields

Input Field	Description
`changeset` - `Int`	Translation missing: en.graphql.inputs.error_log_entry_input.arguments.changeset
`code` - `DiscountValidationError!`	Translation missing: en.graphql.inputs.error_log_entry_input.arguments.code
`messages` - `[String!]!`	Translation missing: en.graphql.inputs.error_log_entry_input.arguments.messages
`timestamp` - `ISO8601DateTime`	Translation missing: en.graphql.inputs.error_log_entry_input.arguments.timestamp

Example

{
  "changeset": 123,
  "code": "DISCOUNT_DELETED",
  "messages": ["xyz789"],
  "timestamp": ISO8601DateTime
}

Input Objects

ExchangeRatesSyncInput

Description

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

Fields

Input Field	Description
`channelId` - `GlobalID!`	Translation missing: en.graphql.inputs.exchange_rates_sync_input.arguments.channel_id

Example

{"channelId": GlobalID}

Input Objects

ExportCreateInput

Description

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

Fields

Input Field	Description
`deliveryMechanism` - `ExportDeliveryMechanism!`	Translation missing: en.graphql.inputs.export_create_input.arguments.delivery_mechanism
`recipientEmail` - `String`	Translation missing: en.graphql.inputs.export_create_input.arguments.recipient_email
`resourceType` - `ExportResource!`	Translation missing: en.graphql.inputs.export_create_input.arguments.resource_type
`subscriptionExportFilters` - `SubscriptionExportFilters`	Translation missing: en.graphql.inputs.export_create_input.arguments.subscription_export_filters
`subscriptionOrderExportFilters` - `SubscriptionOrderExportFilters`	Translation missing: en.graphql.inputs.export_create_input.arguments.subscription_order_export_filters

Example

{
  "deliveryMechanism": "EMAIL",
  "recipientEmail": "xyz789",
  "resourceType": "SUBSCRIPTION",
  "subscriptionExportFilters": SubscriptionExportFilters,
  "subscriptionOrderExportFilters": SubscriptionOrderExportFilters
}

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

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

Fields

Input Field	Description
`externalId` - `String!`	Translation missing: en.graphql.inputs.line_item_create_input.arguments.external_id
`orderId` - `GlobalID`	Translation missing: en.graphql.inputs.line_item_create_input.arguments.order_id
`productVariantId` - `GlobalID!`	Translation missing: en.graphql.inputs.line_item_create_input.arguments.product_variant_id

Example

{
  "externalId": "abc123",
  "orderId": GlobalID,
  "productVariantId": GlobalID
}

Input Objects

LineItemDataInput

Description

Line item data.

Fields

Input Field	Description
`externalId` - `ID!`	The line item's external ID.
`productId` - `ID!`	The line item's product ID.
`productVariantId` - `ID!`	The line item's product variant ID.
`quantity` - `Int!`	The line item's quantity.

Example

{
  "externalId": "4",
  "productId": "4",
  "productVariantId": 4,
  "quantity": 987
}

Input Objects

LineItemUpsertInput

Description

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

Fields

Input Field	Description
`externalId` - `String`	Translation missing: en.graphql.inputs.line_item_upsert_input.arguments.external_id
`id` - `GlobalID`	Translation missing: en.graphql.inputs.line_item_upsert_input.arguments.id
`orderId` - `GlobalID`	Translation missing: en.graphql.inputs.line_item_upsert_input.arguments.order_id
`productVariantId` - `GlobalID`	Translation missing: en.graphql.inputs.line_item_upsert_input.arguments.product_variant_id

Example

{
  "externalId": "abc123",
  "id": GlobalID,
  "orderId": GlobalID,
  "productVariantId": GlobalID
}

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": "xyz789",
  "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

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

Fields

Input Field	Description
`schedule` - `[TimeOffsetInput!]!`	Translation missing: en.graphql.inputs.notification_schedule_template_input.arguments.schedule
`trigger` - `NotificationScheduleTrigger!`	Translation missing: en.graphql.inputs.notification_schedule_template_input.arguments.trigger

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

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

Fields

Input Field	Description
`emailCustomerWhenCampaignDueDateIsUpdated` - `Boolean`	Translation missing: en.graphql.inputs.notifications_config_set_input.arguments.email_customer_when_campaign_due_date_is_updated
`emailCustomerWhenCampaignIsOrdered` - `Boolean`	Translation missing: en.graphql.inputs.notifications_config_set_input.arguments.email_customer_when_campaign_is_ordered
`emailMerchantOnWebhookFailure` - `Boolean`	Translation missing: en.graphql.inputs.notifications_config_set_input.arguments.email_merchant_on_webhook_failure
`emailMerchantWhenCampaignOrderCannotBeFulfilled` - `Boolean`	Translation missing: en.graphql.inputs.notifications_config_set_input.arguments.email_merchant_when_campaign_order_cannot_be_fulfilled
`notificationSchedules` - `[NotificationScheduleTemplateInput!]`	Translation missing: en.graphql.inputs.notifications_config_set_input.arguments.notification_schedules

Example

{
  "emailCustomerWhenCampaignDueDateIsUpdated": true,
  "emailCustomerWhenCampaignIsOrdered": false,
  "emailMerchantOnWebhookFailure": true,
  "emailMerchantWhenCampaignOrderCannotBeFulfilled": false,
  "notificationSchedules": [
    NotificationScheduleTemplateInput
  ]
}

Input Objects

OrderCreateInput

Description

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

Fields

Input Field	Description
`externalId` - `String!`	Translation missing: en.graphql.inputs.order_create_input.arguments.external_id
`id` - `GlobalID`	Translation missing: en.graphql.inputs.order_create_input.arguments.id
`lineItems` - `[LineItemCreateInput!]!`	Translation missing: en.graphql.inputs.order_create_input.arguments.line_items
`name` - `String!`	Translation missing: en.graphql.inputs.order_create_input.arguments.name

Example

{
  "externalId": "abc123",
  "id": GlobalID,
  "lineItems": [LineItemCreateInput],
  "name": "xyz789"
}

Input Objects

OrderUpdateInput

Description

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

Fields

Input Field	Description
`externalId` - `String`	Translation missing: en.graphql.inputs.order_update_input.arguments.external_id
`id` - `GlobalID!`	Translation missing: en.graphql.inputs.order_update_input.arguments.id
`lineItems` - `[LineItemUpsertInput!]`	Translation missing: en.graphql.inputs.order_update_input.arguments.line_items
`name` - `String`	Translation missing: en.graphql.inputs.order_update_input.arguments.name

Example

{
  "externalId": "xyz789",
  "id": GlobalID,
  "lineItems": [LineItemUpsertInput],
  "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

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

Fields

Input Field	Description
`address` - `PostalAddressUpdateInput`	Translation missing: en.graphql.inputs.organisation_create_input.arguments.address
`email` - `String!`	Translation missing: en.graphql.inputs.organisation_create_input.arguments.email
`id` - `GlobalID`	Translation missing: en.graphql.inputs.organisation_create_input.arguments.id
`name` - `String!`	Translation missing: en.graphql.inputs.organisation_create_input.arguments.name

Example

{
  "address": PostalAddressUpdateInput,
  "email": "xyz789",
  "id": GlobalID,
  "name": "xyz789"
}

Input Objects

OrganisationUpdateInput

Description

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

Fields

Input Field	Description
`address` - `PostalAddressUpdateInput`	Translation missing: en.graphql.inputs.organisation_update_input.arguments.address
`email` - `String`	Translation missing: en.graphql.inputs.organisation_update_input.arguments.email
`id` - `GlobalID!`	Translation missing: en.graphql.inputs.organisation_update_input.arguments.id
`name` - `String`	Translation missing: en.graphql.inputs.organisation_update_input.arguments.name
`status` - `OrganisationStatus`	Translation missing: en.graphql.inputs.organisation_update_input.arguments.status

Example

{
  "address": PostalAddressUpdateInput,
  "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": "abc123",
  "manuallyCapturable": true,
  "paymentProcessor": "SHOPIFY",
  "paypalBillingAgreement": PaypalBillingAgreementCreateInput,
  "type": "AFTERPAY"
}

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": "AFTERPAY"
}

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.
`id` - `GlobalID`
`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": true,
  "id": GlobalID,
  "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

PaymentMethodRevokeInput

Fields

Input Field	Description
`id` - `GlobalID!`
`revokedAt` - `ISO8601DateTime`
`revokedReason` - `String`

Example

{
  "id": GlobalID,
  "revokedAt": ISO8601DateTime,
  "revokedReason": "xyz789"
}

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": "abc123",
  "accountName": "xyz789",
  "externalId": "abc123"
}

Input Objects

PlatformConfigSetInput

Description

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

Fields

Input Field	Description
`notifications` - `NotificationsConfigSetInput`	Translation missing: en.graphql.inputs.platform_config_set_input.arguments.notifications
`presales` - `PresalesConfigSetInput`	Translation missing: en.graphql.inputs.platform_config_set_input.arguments.presales
`pricing` - `PricingConfigSetInput`	Translation missing: en.graphql.inputs.platform_config_set_input.arguments.pricing
`subscriptions` - `SubscriptionsConfigSetInput`	Translation missing: en.graphql.inputs.platform_config_set_input.arguments.subscriptions

Example

{
  "notifications": NotificationsConfigSetInput,
  "presales": PresalesConfigSetInput,
  "pricing": PricingConfigSetInput,
  "subscriptions": SubscriptionsConfigSetInput
}

Input Objects

PostalAddressUpdateInput

Description

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

Fields

Input Field	Description
`city` - `String`	Translation missing: en.graphql.inputs.postal_address_update_input.arguments.city
`company` - `String`	Translation missing: en.graphql.inputs.postal_address_update_input.arguments.company
`country` - `CountryInput`	Translation missing: en.graphql.inputs.postal_address_update_input.arguments.country
`firstName` - `String`	Translation missing: en.graphql.inputs.postal_address_update_input.arguments.first_name
`lastName` - `String`	Translation missing: en.graphql.inputs.postal_address_update_input.arguments.last_name
`phone` - `PhoneNumber`	Translation missing: en.graphql.inputs.postal_address_update_input.arguments.phone
`postcode` - `Postcode`	Translation missing: en.graphql.inputs.postal_address_update_input.arguments.postcode
`province` - `ProvinceInput`	Translation missing: en.graphql.inputs.postal_address_update_input.arguments.province
`street1` - `String`	Translation missing: en.graphql.inputs.postal_address_update_input.arguments.street1
`street2` - `String`	Translation missing: en.graphql.inputs.postal_address_update_input.arguments.street2

Example

{
  "city": "xyz789",
  "company": "xyz789",
  "country": CountryInput,
  "firstName": "xyz789",
  "lastName": "xyz789",
  "phone": "+17895551234",
  "postcode": Postcode,
  "province": ProvinceInput,
  "street1": "abc123",
  "street2": "abc123"
}

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": "xyz789",
  "endAt": ISO8601DateTime,
  "fulfilAt": ISO8601DateTime,
  "gracePeriodHours": 987,
  "launchAt": ISO8601DateTime,
  "limit": 123,
  "name": "xyz789",
  "productIds": [SharedGlobalID],
  "productVariantIds": [SharedGlobalID],
  "reference": "abc123"
}

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": "abc123",
  "endAt": ISO8601DateTime,
  "fulfilAt": ISO8601DateTime,
  "gracePeriodHours": 123,
  "id": GlobalID,
  "launchAt": ISO8601DateTime,
  "limit": 987,
  "name": "abc123",
  "productIds": [SharedGlobalID],
  "productVariantIds": [SharedGlobalID],
  "reference": "abc123"
}

Input Objects

PresalesConfigSetInput

Description

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

Fields

Input Field	Description
`allowDepositUpdatesOnLaunchedPresales` - `Boolean`	Translation missing: en.graphql.inputs.presales_config_set_input.arguments.allow_deposit_updates_on_launched_presales
`campaignPaymentTermsAlignment` - `CampaignPaymentTermsAlignment`	Translation missing: en.graphql.inputs.presales_config_set_input.arguments.campaign_payment_terms_alignment
`defaultCurrency` - `CurrencyCode`	Translation missing: en.graphql.inputs.presales_config_set_input.arguments.default_currency
`defaultPresaleDeposit` - `CampaignDepositInput`	Translation missing: en.graphql.inputs.presales_config_set_input.arguments.default_presale_deposit
`defaultPresaleInventoryPolicy` - `PresaleInventoryPolicy`	Translation missing: en.graphql.inputs.presales_config_set_input.arguments.default_presale_inventory_policy
`metafieldUpdateInterval` - `Count`	Translation missing: en.graphql.inputs.presales_config_set_input.arguments.metafield_update_interval
`refundPresalesDepositsOnCancellation` - `Boolean`	Translation missing: en.graphql.inputs.presales_config_set_input.arguments.refund_presales_deposits_on_cancellation
`templateForCrowdfundSellingPlanDescription` - `String`	Translation missing: en.graphql.inputs.presales_config_set_input.arguments.template_for_crowdfund_selling_plan_description
`templateForCrowdfundSellingPlanName` - `String`	Translation missing: en.graphql.inputs.presales_config_set_input.arguments.template_for_crowdfund_selling_plan_name
`templateForPresaleSellingPlanDescription` - `String`	Translation missing: en.graphql.inputs.presales_config_set_input.arguments.template_for_presale_selling_plan_description
`templateForPresaleSellingPlanName` - `String`	Translation missing: en.graphql.inputs.presales_config_set_input.arguments.template_for_presale_selling_plan_name

Example

{
  "allowDepositUpdatesOnLaunchedPresales": true,
  "campaignPaymentTermsAlignment": "FIRST_CAMPAIGN",
  "defaultCurrency": "AED",
  "defaultPresaleDeposit": CampaignDepositInput,
  "defaultPresaleInventoryPolicy": "ON_FULFILMENT",
  "metafieldUpdateInterval": Count,
  "refundPresalesDepositsOnCancellation": true,
  "templateForCrowdfundSellingPlanDescription": "abc123",
  "templateForCrowdfundSellingPlanName": "xyz789",
  "templateForPresaleSellingPlanDescription": "xyz789",
  "templateForPresaleSellingPlanName": "xyz789"
}

Input Objects

PriceCalculationDiscountAgreementInput

Description

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

Fields

Input Field	Description
`discountApplication` - `PriceCalculationDiscountApplicationInput`	Translation missing: en.graphql.inputs.price_calculation_discount_agreement_input.arguments.discount_application
`id` - `String!`	Translation missing: en.graphql.inputs.price_calculation_discount_agreement_input.arguments.id
`projectedUsageIndex` - `Int`	Translation missing: en.graphql.inputs.price_calculation_discount_agreement_input.arguments.projected_usage_index

Example

{
  "discountApplication": PriceCalculationDiscountApplicationInput,
  "id": "abc123",
  "projectedUsageIndex": 987
}

Input Objects

PriceCalculationDiscountApplicationInput

Description

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

Fields

Input Field	Description
`errors` - `[ErrorLogEntryInput!]`	Translation missing: en.graphql.inputs.price_calculation_discount_application_input.arguments.errors
`exchangeRate` - `Float`	Translation missing: en.graphql.inputs.price_calculation_discount_application_input.arguments.exchange_rate
`id` - `String`	Translation missing: en.graphql.inputs.price_calculation_discount_application_input.arguments.id
`status` - `DiscountApplicationStatus`	Translation missing: en.graphql.inputs.price_calculation_discount_application_input.arguments.status

Example

{
  "errors": [ErrorLogEntryInput],
  "exchangeRate": 123.45,
  "id": "xyz789",
  "status": "ACTIVE"
}

Input Objects

PriceCalculationPerformInput

Description

Specifies the input fields required to perform a price calculation.

Fields

Input Field	Description
`enginePolicy` - `PriceEnginePolicy`	The engine policy to perform the price calculation
`engineType` - `PriceEngineType`	The engine type to perform the price calculation
`forceRebuild` - `Boolean`
`resource` - `ResourceInput!`	The price calculation's resource.

Example

{
  "enginePolicy": "ALWAYS",
  "engineType": "SHOPIFY",
  "forceRebuild": false,
  "resource": ResourceInput
}

Input Objects

PriceEngineCreateInput

Description

Specifies the input fields required to create a price engine.

Fields

Input Field	Description
`config` - `ShopifyPriceEngineConfigInput!`	The price engine's config.
`engineType` - `PriceEngineType!`	The price engine's type.

Example

{
  "config": ShopifyPriceEngineConfigInput,
  "engineType": "SHOPIFY"
}

Input Objects

PriceEngineUpdateInput

Description

Specifies the input fields required to update a price engine.

Fields

Input Field	Description
`config` - `ShopifyPriceEngineConfigInput`	The price engine's config.
`id` - `GlobalID!`	The price engine's ID.

Example

{
  "config": ShopifyPriceEngineConfigInput,
  "id": GlobalID
}

Input Objects

PriceSourceRegisterInput

Description

Specifies the input fields required to register a price source.

Fields

Input Field	Description
`engineType` - `PriceEngineType`	The price source's engine type.
`resource` - `ResourceInput!`	The price source's resource.
`source` - `SourceInput!`	The price source's source.

Example

{
  "engineType": "SHOPIFY",
  "resource": ResourceInput,
  "source": SourceInput
}

Input Objects

PriceTableCalculateInput

Description

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

Fields

Input Field	Description
`country` - `CountryCode!`	Translation missing: en.graphql.inputs.price_table_calculate_input.arguments.country
`productVariantIds` - `[SharedGlobalID!]!`	Translation missing: en.graphql.inputs.price_table_calculate_input.arguments.product_variant_ids

Example

{"country": "AC", "productVariantIds": [SharedGlobalID]}

Input Objects

PricingConfigSetInput

Description

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

Fields

Input Field	Description
`defaultPriceEngine` - `PriceEngineProvider`	Translation missing: en.graphql.inputs.pricing_config_set_input.arguments.default_price_engine
`defaultPriceEnginePolicy` - `PriceEnginePolicy`	Translation missing: en.graphql.inputs.pricing_config_set_input.arguments.default_price_engine_policy
`moneyRoundingMode` - `MoneyRoundingMode`	Translation missing: en.graphql.inputs.pricing_config_set_input.arguments.money_rounding_mode
`shippingTaxable` - `Boolean`	Translation missing: en.graphql.inputs.pricing_config_set_input.arguments.shipping_taxable
`taxBehaviour` - `TaxBehaviour`	Translation missing: en.graphql.inputs.pricing_config_set_input.arguments.tax_behaviour

Example

{
  "defaultPriceEngine": "SHOPIFY",
  "defaultPriceEnginePolicy": "ALWAYS",
  "moneyRoundingMode": "ROUND_CEILING",
  "shippingTaxable": true,
  "taxBehaviour": "EXCLUSIVE"
}

Input Objects

ProductCollectionCreateInput

Description

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

Fields

Input Field	Description
`externalId` - `ID!`	Translation missing: en.graphql.inputs.product_collection_create_input.arguments.external_id
`id` - `GlobalID`	Translation missing: en.graphql.inputs.product_collection_create_input.arguments.id
`imageUrl` - `String`	Translation missing: en.graphql.inputs.product_collection_create_input.arguments.image_url
`productsCount` - `Count`	Translation missing: en.graphql.inputs.product_collection_create_input.arguments.products_count
`status` - `ProductCollectionStatus`	Translation missing: en.graphql.inputs.product_collection_create_input.arguments.status
`title` - `String!`	Translation missing: en.graphql.inputs.product_collection_create_input.arguments.title

Example

{
  "externalId": 4,
  "id": GlobalID,
  "imageUrl": "abc123",
  "productsCount": Count,
  "status": "PUBLISHED",
  "title": "xyz789"
}

Input Objects

ProductCollectionDeleteInput

Description

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

Fields

Input Field	Description
`id` - `GlobalID!`	Translation missing: en.graphql.inputs.product_collection_delete_input.arguments.id

Example

{"id": GlobalID}

Input Objects

ProductCollectionUpdateInput

Description

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

Fields

Input Field	Description
`externalId` - `ID`	Translation missing: en.graphql.inputs.product_collection_update_input.arguments.external_id
`id` - `GlobalID!`	Translation missing: en.graphql.inputs.product_collection_update_input.arguments.id
`imageUrl` - `String`	Translation missing: en.graphql.inputs.product_collection_update_input.arguments.image_url
`productsCount` - `Count`	Translation missing: en.graphql.inputs.product_collection_update_input.arguments.products_count
`title` - `String`	Translation missing: en.graphql.inputs.product_collection_update_input.arguments.title

Example

{
  "externalId": 4,
  "id": GlobalID,
  "imageUrl": "abc123",
  "productsCount": Count,
  "title": "abc123"
}

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": "abc123",
  "imageUrl": "xyz789",
  "productVariants": [ProductVariantCreateInput],
  "status": "PUBLISHED",
  "title": "xyz789"
}

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": "abc123",
  "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": "xyz789",
  "productVariants": [ProductVariantUpsertInput],
  "status": "PUBLISHED",
  "title": "xyz789"
}

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": "abc123",
  "productId": GlobalID,
  "shippable": true,
  "sku": "abc123",
  "status": "PUBLISHED",
  "taxable": true,
  "title": "abc123",
  "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": "abc123",
  "shippable": false,
  "sku": "xyz789",
  "taxable": true,
  "title": "xyz789",
  "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": "xyz789",
  "price": MoneyInput,
  "shippable": false,
  "sku": "abc123",
  "status": "PUBLISHED",
  "taxable": false,
  "title": "abc123",
  "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": "abc123",
  "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

ResourceInput

Description

Specifies the input fields required to create a pricing resource.

Fields

Input Field	Description
`campaignOrderGroup` - `CampaignOrderGroupDataInput`
`id` - `ID!`	The resource's ID
`subscriptionOrder` - `SubscriptionOrderDataInput`
`type` - `ResourceType!`	The resource's type

Example

{
  "campaignOrderGroup": CampaignOrderGroupDataInput,
  "id": "4",
  "subscriptionOrder": SubscriptionOrderDataInput,
  "type": "CAMPAIGN_ORDER_GROUP"
}

Input Objects

ShippingRatesAvailableDataInput

Description

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

Fields

Input Field	Description
`address` - `AddressInput!`	Translation missing: en.graphql.inputs.shipping_rates_available_data_input.arguments.address
`lineItems` - `[ShippingRatesLineItemDataInput!]!`	Translation missing: en.graphql.inputs.shipping_rates_available_data_input.arguments.line_items

Example

{
  "address": AddressInput,
  "lineItems": [ShippingRatesLineItemDataInput]
}

Input Objects

ShippingRatesAvailableInput

Fields

Input Field	Description
`data` - `ShippingRatesAvailableDataInput!`
`id` - `ID!`	The resource's ID
`type` - `ResourceType!`	The resource's type

Example

{
  "data": ShippingRatesAvailableDataInput,
  "id": "4",
  "type": "CAMPAIGN_ORDER_GROUP"
}

Input Objects

ShippingRatesLineItemDataInput

Description

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

Fields

Input Field	Description
`productVariantId` - `String!`	Translation missing: en.graphql.inputs.shipping_rates_line_item_data_input.arguments.product_variant_id
`quantity` - `Int!`	Translation missing: en.graphql.inputs.shipping_rates_line_item_data_input.arguments.quantity

Example

{
  "productVariantId": "abc123",
  "quantity": 123
}

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": "xyz789"
}

Input Objects

ShopifyPriceEngineConfigInput

Description

Specifies the input fields required to create a price engine config for Shopify.

Fields

Input Field	Description
`apiTokens` - `[String!]!`	The config's API tokens.
`storeName` - `String!`	The config's store name.

Example

{
  "apiTokens": ["abc123"],
  "storeName": "abc123"
}

Input Objects

SourceAddressDataInput

Description

Address input data.

Fields

Input Field	Description
`address1` - `String`	The address's first line
`address2` - `String`	The address's second line
`city` - `String`	The city
`country` - `String`
`countryCode` - `CountryCode!`	The country code as enum
`firstName` - `String`
`lastName` - `String`
`phone` - `String`
`province` - `String`	The province name
`provinceCode` - `String`	The province code
`zip` - `String`	The zip code

Example

{
  "address1": "xyz789",
  "address2": "xyz789",
  "city": "abc123",
  "country": "xyz789",
  "countryCode": "AC",
  "firstName": "xyz789",
  "lastName": "xyz789",
  "phone": "abc123",
  "province": "xyz789",
  "provinceCode": "xyz789",
  "zip": "xyz789"
}

Input Objects

SourceCustomerDataInput

Description

Customer input data.

Fields

Input Field	Description
`id` - `ID!`	The customer's ID
`taxExempt` - `Boolean!`	The customer's tax exemption

Example

{"id": 4, "taxExempt": false}

Input Objects

SourceDataInput

Description

Specifies the input fields required to create a pricing source data.

Fields

Input Field	Description
`billingAddress` - `SourceAddressDataInput!`	The pricing source's billing address
`currency` - `CurrencyCode!`	The pricing source's currency
`customAttributes` - `JSON`	The custom attributes
`customer` - `SourceCustomerDataInput!`	The pricing source's customer
`discountApplications` - `[SourceDiscountApplicationDataInput!]!`	The pricing source's discount applications
`lineItems` - `[SourceLineItemDataInput!]!`	The pricing source's line items
`shippingAddress` - `SourceAddressDataInput`	The pricing source's shipping address
`shippingLines` - `[SourceShippingLineDataInput!]!`	The pricing source's shipping lines
`taxLines` - `[SourceTaxRateDataInput!]!`	The pricing source's tax lines
`taxesIncluded` - `Boolean!`	The pricing source's tax inclusion

Example

{
  "billingAddress": SourceAddressDataInput,
  "currency": "AED",
  "customAttributes": {},
  "customer": SourceCustomerDataInput,
  "discountApplications": [
    SourceDiscountApplicationDataInput
  ],
  "lineItems": [SourceLineItemDataInput],
  "shippingAddress": SourceAddressDataInput,
  "shippingLines": [SourceShippingLineDataInput],
  "taxLines": [SourceTaxRateDataInput],
  "taxesIncluded": false
}

Input Objects

SourceDiscountAllocationDataInput

Description

Discount allocation input data.

Fields

Input Field	Description
`amount` - `MoneyDollars!`	The discount allocation's amount as dollars
`discountApplicationIndex` - `Int!`	The discount application index

Example

{"amount": MoneyDollars, "discountApplicationIndex": 987}

Input Objects

SourceDiscountApplicationDataInput

Description

Discount application input data.

Fields

Input Field	Description
`code` - `String`	The discount application's code
`title` - `String`	The discount application's title
`type` - `String!`	The discount application's type

Example

{
  "code": "xyz789",
  "title": "xyz789",
  "type": "xyz789"
}

Input Objects

SourceInput

Description

Specifies the input fields required to create a pricing source.

Fields

Input Field	Description
`data` - `SourceDataInput!`	The source's data
`id` - `ID!`	The source's ID
`type` - `SourceType!`	The source's type

Example

{
  "data": SourceDataInput,
  "id": "4",
  "type": "CALCULATED_DRAFT_ORDER"
}

Input Objects

SourceLineItemDataInput

Description

Line item input data.

Fields

Input Field	Description
`customAttributes` - `JSON`	The custom attributes
`discountAllocations` - `[SourceDiscountAllocationDataInput!]!`	The line item's discount allocation
`id` - `ID!`	The line item's ID
`price` - `MoneyDollars!`	The line item's price as dollars
`productId` - `ID`	The line item's product ID
`quantity` - `Int!`	The line item's quantity
`requiresShipping` - `Boolean!`	The line item's shipping requirement
`taxLines` - `[SourceTaxLineDataInput!]!`	The line item's tax lines
`taxable` - `Boolean!`	The line item's taxation
`variantId` - `ID`	The line item's variant ID

Example

{
  "customAttributes": {},
  "discountAllocations": [
    SourceDiscountAllocationDataInput
  ],
  "id": "4",
  "price": MoneyDollars,
  "productId": "4",
  "quantity": 987,
  "requiresShipping": false,
  "taxLines": [SourceTaxLineDataInput],
  "taxable": false,
  "variantId": "4"
}

Input Objects

SourceShippingLineDataInput

Description

Shipping line input data.

Fields

Input Field	Description
`code` - `String!`	The shipping line's code
`discountAllocations` - `[SourceDiscountAllocationDataInput!]!`	The shipping line's discount allocations
`price` - `MoneyDollars!`	The shipping line's price as dollars
`source` - `String`	The shipping line's source
`taxLines` - `[SourceTaxLineDataInput!]!`	The shipping line's tax lines
`title` - `String!`	The shipping line's title

Example

{
  "code": "xyz789",
  "discountAllocations": [
    SourceDiscountAllocationDataInput
  ],
  "price": MoneyDollars,
  "source": "xyz789",
  "taxLines": [SourceTaxLineDataInput],
  "title": "xyz789"
}

Input Objects

SourceTaxLineDataInput

Description

Tax line input data.

Fields

Input Field	Description
`price` - `MoneyDollars!`	The tax line's price as dollars
`rate` - `Percentage!`	The tax rate as percentage
`title` - `String!`	The tax line's title

Example

{
  "price": MoneyDollars,
  "rate": Percentage,
  "title": "xyz789"
}

Input Objects

SourceTaxRateDataInput

Description

Tax rate input data.

Fields

Input Field	Description
`rate` - `Percentage!`	The tax rate as percentage
`title` - `String!`	The tax rate's title

Example

{
  "rate": Percentage,
  "title": "xyz789"
}

Input Objects

SubscriptionAnchorCreateInput

Description

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

Fields

Input Field	Description
`day` - `Day`	Translation missing: en.graphql.inputs.subscription_anchor_create_input.arguments.day
`description` - `String`	Translation missing: en.graphql.inputs.subscription_anchor_create_input.arguments.description
`externalId` - `String`	Translation missing: en.graphql.inputs.subscription_anchor_create_input.arguments.external_id
`id` - `GlobalID`	Translation missing: en.graphql.inputs.subscription_anchor_create_input.arguments.id
`month` - `Month`	Translation missing: en.graphql.inputs.subscription_anchor_create_input.arguments.month
`name` - `String`	Translation missing: en.graphql.inputs.subscription_anchor_create_input.arguments.name
`time` - `TimeOfDay`	Translation missing: en.graphql.inputs.subscription_anchor_create_input.arguments.time
`type` - `SubscriptionAnchorType!`	Translation missing: en.graphql.inputs.subscription_anchor_create_input.arguments.type

Example

{
  "day": Day,
  "description": "abc123",
  "externalId": "abc123",
  "id": GlobalID,
  "month": Month,
  "name": "xyz789",
  "time": TimeOfDay,
  "type": "FLEXIBLE"
}

Input Objects

SubscriptionBacklogSizeInput

Description

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

Fields

Input Field	Description
`interval` - `SubscriptionBacklogInterval!`	Translation missing: en.graphql.inputs.subscription_backlog_size_input.arguments.interval
`intervalCount` - `Int!`	Translation missing: en.graphql.inputs.subscription_backlog_size_input.arguments.interval_count

Example

{"interval": "CYCLE", "intervalCount": 987}

Input Objects

SubscriptionBillingBehaviourInput

Description

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

Fields

Input Field	Description
`billingOffset` - `SubscriptionOffsetInput!`	Translation missing: en.graphql.inputs.subscription_billing_behaviour_input.arguments.billing_offset
`processingOffset` - `SubscriptionOffsetInput!`	Translation missing: en.graphql.inputs.subscription_billing_behaviour_input.arguments.processing_offset

Example

{
  "billingOffset": SubscriptionOffsetInput,
  "processingOffset": SubscriptionOffsetInput
}

Input Objects

SubscriptionCancelInput

Description

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

Fields

Input Field	Description
`cancelAt` - `Timestamp`	Translation missing: en.graphql.inputs.subscription_cancel_input.arguments.cancel_at
`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

{
  "cancelAt": 1592577642,
  "description": "xyz789",
  "id": GlobalID
}

Input Objects

SubscriptionDataInput

Description

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

Fields

Input Field	Description
`externalId` - `String!`	Translation missing: en.graphql.inputs.subscription_data_input.arguments.external_id
`generatedOrdersCount` - `Int`	Translation missing: en.graphql.inputs.subscription_data_input.arguments.generated_orders_count
`id` - `String!`	Translation missing: en.graphql.inputs.subscription_data_input.arguments.id

Example

{
  "externalId": "xyz789",
  "generatedOrdersCount": 123,
  "id": "xyz789"
}

Input Objects

SubscriptionDeliveryBehaviourCreateInput

Description

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

Fields

Input Field	Description
`fixed` - `SubscriptionFixedDeliveryBehaviourInput`	Translation missing: en.graphql.inputs.subscription_delivery_behaviour_create_input.arguments.fixed
`type` - `SubscriptionDeliveryBehaviourType!`	Translation missing: en.graphql.inputs.subscription_delivery_behaviour_create_input.arguments.type

Example

{
  "fixed": SubscriptionFixedDeliveryBehaviourInput,
  "type": "FIXED"
}

Input Objects

SubscriptionDeliveryMethodInput

Description

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

Fields

Input Field	Description
`address` - `AddressInput`	Translation missing: en.graphql.inputs.subscription_delivery_method_input.arguments.address
`shippingOption` - `SubscriptionDeliveryShippingOptionInput`	Translation missing: en.graphql.inputs.subscription_delivery_method_input.arguments.shipping_option
`type` - `SubscriptionDeliveryMethodType!`	Translation missing: en.graphql.inputs.subscription_delivery_method_input.arguments.type

Example

{
  "address": AddressInput,
  "shippingOption": SubscriptionDeliveryShippingOptionInput,
  "type": "DIGITAL"
}

Input Objects

SubscriptionDeliveryMethodShippingUpdateInput

Description

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

Fields

Input Field	Description
`address` - `AddressInput`	Translation missing: en.graphql.inputs.subscription_delivery_method_shipping_update_input.arguments.address

Example

{"address": AddressInput}

Input Objects

SubscriptionDeliveryMethodUpdateInput

Description

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

Fields

Input Field	Description
`shipping` - `SubscriptionDeliveryMethodShippingUpdateInput`	Translation missing: en.graphql.inputs.subscription_delivery_method_update_input.arguments.shipping
`type` - `String`	Translation missing: en.graphql.inputs.subscription_delivery_method_update_input.arguments.type. Default = `"unknown"`

Example

{
  "shipping": SubscriptionDeliveryMethodShippingUpdateInput,
  "type": "xyz789"
}

Input Objects

SubscriptionDeliveryShippingOptionInput

Description

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

Fields

Input Field	Description
`code` - `String!`	Translation missing: en.graphql.inputs.subscription_delivery_shipping_option_input.arguments.code
`description` - `String`	Translation missing: en.graphql.inputs.subscription_delivery_shipping_option_input.arguments.description
`handle` - `String`	Translation missing: en.graphql.inputs.subscription_delivery_shipping_option_input.arguments.handle
`source` - `String!`	Translation missing: en.graphql.inputs.subscription_delivery_shipping_option_input.arguments.source
`title` - `String!`	Translation missing: en.graphql.inputs.subscription_delivery_shipping_option_input.arguments.title

Example

{
  "code": "xyz789",
  "description": "abc123",
  "handle": "abc123",
  "source": "abc123",
  "title": "abc123"
}

Input Objects

SubscriptionDiagnoseInput

Description

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

Fields

Input Field	Description
`fix` - `Boolean`	Translation missing: en.graphql.inputs.subscription_diagnose_input.arguments.fix
`force` - `Boolean`	Translation missing: en.graphql.inputs.subscription_diagnose_input.arguments.force
`id` - `GlobalID!`	Translation missing: en.graphql.inputs.subscription_diagnose_input.arguments.id
`lookaheadMins` - `Int`	Translation missing: en.graphql.inputs.subscription_diagnose_input.arguments.lookahead_mins

Example

{
  "fix": false,
  "force": false,
  "id": GlobalID,
  "lookaheadMins": 123
}

Input Objects

SubscriptionDiscountActivateInput

Description

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

Fields

Input Field	Description
`id` - `GlobalID!`	Translation missing: en.graphql.inputs.subscription_discount_activate_input.arguments.id

Example

{"id": GlobalID}

Input Objects

SubscriptionDiscountAmountInput

Description

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

Fields

Input Field	Description
`amount` - `Float`	Translation missing: en.graphql.inputs.subscription_discount_amount_input.arguments.amount

Example

{"amount": 987.65}

Input Objects

SubscriptionDiscountApplyInput

Description

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

Fields

Input Field	Description
`discount` - `SubscriptionDiscountDiscountApplyInput!`	Translation missing: en.graphql.inputs.subscription_discount_apply_input.arguments.discount
`target` - `SubscriptionDiscountTargetInput!`	Translation missing: en.graphql.inputs.subscription_discount_apply_input.arguments.target

Example

{
  "discount": SubscriptionDiscountDiscountApplyInput,
  "target": SubscriptionDiscountTargetInput
}

Input Objects

SubscriptionDiscountCombinesWithInput

Description

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

Fields

Input Field	Description
`orderDiscounts` - `Boolean`	Translation missing: en.graphql.inputs.subscription_discount_combines_with_input.arguments.order_discounts. Default = `false`
`shippingDiscounts` - `Boolean`	Translation missing: en.graphql.inputs.subscription_discount_combines_with_input.arguments.shipping_discounts. Default = `false`

Example

{"orderDiscounts": true, "shippingDiscounts": true}

Input Objects

SubscriptionDiscountCustomerGetsInput

Description

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

Fields

Input Field	Description
`value` - `SubscriptionDiscountCustomerGetsValueInput`	Translation missing: en.graphql.inputs.subscription_discount_customer_gets_input.arguments.value

Example

{"value": SubscriptionDiscountCustomerGetsValueInput}

Input Objects

SubscriptionDiscountCustomerGetsValueInput

Description

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

Fields

Input Field	Description
`discountAmount` - `SubscriptionDiscountAmountInput`	Translation missing: en.graphql.inputs.subscription_discount_customer_gets_value_input.arguments.discount_amount
`percentage` - `Percentage`	Translation missing: en.graphql.inputs.subscription_discount_customer_gets_value_input.arguments.percentage

Example

{
  "discountAmount": SubscriptionDiscountAmountInput,
  "percentage": Percentage
}

Input Objects

SubscriptionDiscountDiscountApplyInput

Description

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

Fields

Input Field	Description
`discountTitle` - `String`	Translation missing: en.graphql.inputs.subscription_discount_discount_apply_input.arguments.discount_title
`manual` - `SubscriptionDiscountManualDiscountApplyInput`	Translation missing: en.graphql.inputs.subscription_discount_discount_apply_input.arguments.manual
`redeemCode` - `String`	Translation missing: en.graphql.inputs.subscription_discount_discount_apply_input.arguments.redeem_code
`subscriptionDiscountId` - `GlobalID`	Translation missing: en.graphql.inputs.subscription_discount_discount_apply_input.arguments.subscription_discount_id

Example

{
  "discountTitle": "xyz789",
  "manual": SubscriptionDiscountManualDiscountApplyInput,
  "redeemCode": "abc123",
  "subscriptionDiscountId": GlobalID
}

Input Objects

SubscriptionDiscountManualDiscountApplyInput

Description

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

Fields

Input Field	Description
`class` - `DiscountClass!`
`combinesWith` - `SubscriptionDiscountCombinesWithInput`	Translation missing: en.graphql.inputs.subscription_discount_manual_discount_apply_input.arguments.combines_with
`customerGets` - `SubscriptionDiscountCustomerGetsInput`	Translation missing: en.graphql.inputs.subscription_discount_manual_discount_apply_input.arguments.customer_gets
`recurringCycleLimit` - `NonZeroCount`	Translation missing: en.graphql.inputs.subscription_discount_manual_discount_apply_input.arguments.recurring_cycle_limit
`title` - `String!`	Translation missing: en.graphql.inputs.subscription_discount_manual_discount_apply_input.arguments.title

Example

{
  "class": "ORDER",
  "combinesWith": SubscriptionDiscountCombinesWithInput,
  "customerGets": SubscriptionDiscountCustomerGetsInput,
  "recurringCycleLimit": NonZeroCount,
  "title": "abc123"
}

Input Objects

SubscriptionDiscountRemoveInput

Description

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

Fields

Input Field	Description
`id` - `GlobalID!`	Translation missing: en.graphql.inputs.subscription_discount_remove_input.arguments.id

Example

{"id": GlobalID}

Input Objects

SubscriptionDiscountTargetInput

Description

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

Fields

Input Field	Description
`subscriptionId` - `GlobalID`	Translation missing: en.graphql.inputs.subscription_discount_target_input.arguments.subscription_id
`subscriptionOrderId` - `GlobalID`	Translation missing: en.graphql.inputs.subscription_discount_target_input.arguments.subscription_order_id

Example

{
  "subscriptionId": GlobalID,
  "subscriptionOrderId": GlobalID
}

Input Objects

SubscriptionDiscountValidateDiscountInput

Description

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

Fields

Input Field	Description
`discountTitle` - `String`	Translation missing: en.graphql.inputs.subscription_discount_validate_discount_input.arguments.discount_title
`redeemCode` - `String`	Translation missing: en.graphql.inputs.subscription_discount_validate_discount_input.arguments.redeem_code
`subscriptionDiscountId` - `GlobalID`	Translation missing: en.graphql.inputs.subscription_discount_validate_discount_input.arguments.subscription_discount_id

Example

{
  "discountTitle": "xyz789",
  "redeemCode": "xyz789",
  "subscriptionDiscountId": GlobalID
}

Input Objects

SubscriptionDiscountValidateInput

Description

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

Fields

Input Field	Description
`discount` - `SubscriptionDiscountValidateDiscountInput!`	Translation missing: en.graphql.inputs.subscription_discount_validate_input.arguments.discount
`target` - `SubscriptionDiscountTargetInput!`	Translation missing: en.graphql.inputs.subscription_discount_validate_input.arguments.target

Example

{
  "discount": SubscriptionDiscountValidateDiscountInput,
  "target": SubscriptionDiscountTargetInput
}

Input Objects

SubscriptionExportFilters

Description

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

Fields

Input Field	Description
`customerIds` - `[GlobalID!]`	Translation missing: en.graphql.inputs.subscription_export_filters.arguments.customer_ids
`pendingCancellation` - `Boolean`	Translation missing: en.graphql.inputs.subscription_export_filters.arguments.pending_cancellation
`query` - `String`	Translation missing: en.graphql.inputs.subscription_export_filters.arguments.query
`sortDirection` - `SortDirection`	Translation missing: en.graphql.inputs.subscription_export_filters.arguments.sort_direction
`sortKey` - `SubscriptionSortKey`	Translation missing: en.graphql.inputs.subscription_export_filters.arguments.sort_key
`status` - `[SubscriptionStatus!]`	Translation missing: en.graphql.inputs.subscription_export_filters.arguments.status
`subscriptionPlanGroupId` - `GlobalID`	Translation missing: en.graphql.inputs.subscription_export_filters.arguments.subscription_plan_group_id
`subscriptionPlanId` - `GlobalID`	Translation missing: en.graphql.inputs.subscription_export_filters.arguments.subscription_plan_id

Example

{
  "customerIds": [GlobalID],
  "pendingCancellation": false,
  "query": "abc123",
  "sortDirection": "ASC",
  "sortKey": "CREATED_AT",
  "status": ["ACTIVE"],
  "subscriptionPlanGroupId": GlobalID,
  "subscriptionPlanId": GlobalID
}

Input Objects

SubscriptionFixedDeliveryBehaviourInput

Description

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

Fields

Input Field	Description
`cutoff` - `SubscriptionOffsetInput!`	Translation missing: en.graphql.inputs.subscription_fixed_delivery_behaviour_input.arguments.cutoff
`preAnchorBehaviour` - `SubscriptionDeliveryPreAnchorBehaviourType!`	Translation missing: en.graphql.inputs.subscription_fixed_delivery_behaviour_input.arguments.pre_anchor_behaviour

Example

{
  "cutoff": SubscriptionOffsetInput,
  "preAnchorBehaviour": "ASAP"
}

Input Objects

SubscriptionFrequencyCreateInput

Description

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

Fields

Input Field	Description
`interval` - `SubscriptionInterval!`	Translation missing: en.graphql.inputs.subscription_frequency_create_input.arguments.interval
`intervalCount` - `NonZeroCount!`	Translation missing: en.graphql.inputs.subscription_frequency_create_input.arguments.interval_count
`maxCycles` - `NonZeroCount`	Translation missing: en.graphql.inputs.subscription_frequency_create_input.arguments.max_cycles
`minCycles` - `NonZeroCount`	Translation missing: en.graphql.inputs.subscription_frequency_create_input.arguments.min_cycles

Example

{
  "interval": "DAY",
  "intervalCount": NonZeroCount,
  "maxCycles": NonZeroCount,
  "minCycles": NonZeroCount
}

Input Objects

SubscriptionInventoryBehaviourInput

Description

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

Fields

Input Field	Description
`inventoryDecrementPolicy` - `SubscriptionInventoryDecrementPolicy!`	Translation missing: en.graphql.inputs.subscription_inventory_behaviour_input.arguments.inventory_decrement_policy
`outOfStockPolicy` - `SubscriptionInventoryOutOfStockPolicy!`	Translation missing: en.graphql.inputs.subscription_inventory_behaviour_input.arguments.out_of_stock_policy

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
`scheduleNextOrderSynchronously` - `Boolean`	Translation missing: en.graphql.inputs.subscription_line_add_input.arguments.schedule_next_order_synchronously. Default = `true`
`subscriptionId` - `GlobalID!`	Translation missing: en.graphql.inputs.subscription_line_add_input.arguments.subscription_id

Example

{
  "productVariantId": SharedGlobalID,
  "quantity": NonZeroCount,
  "scheduleNextOrderSynchronously": false,
  "subscriptionId": GlobalID
}

Input Objects

SubscriptionLineInput

Description

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

Fields

Input Field	Description
`productVariantId` - `SharedGlobalID!`	Translation missing: en.graphql.inputs.subscription_line_input.arguments.product_variant_id
`quantity` - `NonZeroCount!`	Translation missing: en.graphql.inputs.subscription_line_input.arguments.quantity

Example

{
  "productVariantId": SharedGlobalID,
  "quantity": NonZeroCount
}

Input Objects

SubscriptionLineItemDataInput

Description

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

Fields

Input Field	Description
`basePrice` - `MoneyInput`	Translation missing: en.graphql.inputs.subscription_line_item_data_input.arguments.base_price
`externalId` - `String`	Translation missing: en.graphql.inputs.subscription_line_item_data_input.arguments.external_id
`lineType` - `SubscriptionLineItemDataLine`	Translation missing: en.graphql.inputs.subscription_line_item_data_input.arguments.line_type
`parentExternalId` - `String`	Translation missing: en.graphql.inputs.subscription_line_item_data_input.arguments.parent_external_id
`presentmentBasePrice` - `MoneyInput`	Translation missing: en.graphql.inputs.subscription_line_item_data_input.arguments.presentment_base_price
`productId` - `String!`	Translation missing: en.graphql.inputs.subscription_line_item_data_input.arguments.product_id
`productVariantId` - `String!`	Translation missing: en.graphql.inputs.subscription_line_item_data_input.arguments.product_variant_id
`quantity` - `Int!`	Translation missing: en.graphql.inputs.subscription_line_item_data_input.arguments.quantity
`subscriptionOrderLineId` - `String!`	Translation missing: en.graphql.inputs.subscription_line_item_data_input.arguments.subscription_order_line_id

Example

{
  "basePrice": MoneyInput,
  "externalId": "xyz789",
  "lineType": "ONE_OFF",
  "parentExternalId": "xyz789",
  "presentmentBasePrice": MoneyInput,
  "productId": "abc123",
  "productVariantId": "abc123",
  "quantity": 123,
  "subscriptionOrderLineId": "abc123"
}

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

SubscriptionOffsetInput

Fields

Input Field	Description
`interval` - `SubscriptionOffsetInterval!`
`intervalCount` - `Int!`
`type` - `SubscriptionOffsetType!`

Example

{"interval": "DAY", "intervalCount": 123, "type": "BUSINESS"}

Input Objects

SubscriptionOrderDataInput

Description

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

Fields

Input Field	Description
`baseExchangeRate` - `Float`	Translation missing: en.graphql.inputs.subscription_order_data_input.arguments.base_exchange_rate
`currency` - `CurrencyCode!`	Translation missing: en.graphql.inputs.subscription_order_data_input.arguments.currency
`cycleIndex` - `Int!`	Translation missing: en.graphql.inputs.subscription_order_data_input.arguments.cycle_index
`deliveryMethod` - `SubscriptionDeliveryMethodInput`	Translation missing: en.graphql.inputs.subscription_order_data_input.arguments.delivery_method
`discountAgreements` - `[PriceCalculationDiscountAgreementInput!]`	Translation missing: en.graphql.inputs.subscription_order_data_input.arguments.discount_agreements. Default = `[]`
`lineItems` - `[SubscriptionLineItemDataInput!]!`	Translation missing: en.graphql.inputs.subscription_order_data_input.arguments.line_items
`presentmentCurrency` - `CurrencyCode`	Translation missing: en.graphql.inputs.subscription_order_data_input.arguments.presentment_currency
`pricingBehaviour` - `SubscriptionPricingBehaviourInput!`	Translation missing: en.graphql.inputs.subscription_order_data_input.arguments.pricing_behaviour
`shopCurrency` - `CurrencyCode`	Translation missing: en.graphql.inputs.subscription_order_data_input.arguments.shop_currency
`subscription` - `SubscriptionDataInput!`	Translation missing: en.graphql.inputs.subscription_order_data_input.arguments.subscription

Example

{
  "baseExchangeRate": 123.45,
  "currency": "AED",
  "cycleIndex": 987,
  "deliveryMethod": SubscriptionDeliveryMethodInput,
  "discountAgreements": [
    PriceCalculationDiscountAgreementInput
  ],
  "lineItems": [SubscriptionLineItemDataInput],
  "presentmentCurrency": "AED",
  "pricingBehaviour": SubscriptionPricingBehaviourInput,
  "shopCurrency": "AED",
  "subscription": SubscriptionDataInput
}

Input Objects

SubscriptionOrderExportFilters

Description

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

Fields

Input Field	Description
`paymentStatus` - `[SubscriptionOrderPaymentStatus!]`	Translation missing: en.graphql.inputs.subscription_order_export_filters.arguments.payment_status
`query` - `String`	Translation missing: en.graphql.inputs.subscription_order_export_filters.arguments.query
`sortDirection` - `SortDirection`	Translation missing: en.graphql.inputs.subscription_order_export_filters.arguments.sort_direction
`sortKey` - `SubscriptionOrderSortKey`	Translation missing: en.graphql.inputs.subscription_order_export_filters.arguments.sort_key
`status` - `[SubscriptionOrderStatus!]`	Translation missing: en.graphql.inputs.subscription_order_export_filters.arguments.status

Example

{
  "paymentStatus": ["FAILED"],
  "query": "abc123",
  "sortDirection": "ASC",
  "sortKey": "BILL_AT",
  "status": ["CANCELLED"]
}

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
`scheduleSynchronously` - `Boolean`	Translation missing: en.graphql.inputs.subscription_order_line_add_input.arguments.schedule_synchronously. Default = `true`
`subscriptionOrderId` - `GlobalID!`	Translation missing: en.graphql.inputs.subscription_order_line_add_input.arguments.subscription_order_id

Example

{
  "productVariantId": SharedGlobalID,
  "quantity": NonZeroCount,
  "scheduleSynchronously": true,
  "subscriptionOrderId": GlobalID
}

Input Objects

SubscriptionOrderLineInput

Description

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

Fields

Input Field	Description
`productVariantId` - `SharedGlobalID!`	Translation missing: en.graphql.inputs.subscription_order_line_input.arguments.product_variant_id
`quantity` - `NonZeroCount!`	Translation missing: en.graphql.inputs.subscription_order_line_input.arguments.quantity

Example

{
  "productVariantId": SharedGlobalID,
  "quantity": NonZeroCount
}

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
`force` - `Boolean`	Translation missing: en.graphql.inputs.subscription_order_process_input.arguments.force
`id` - `GlobalID!`	Translation missing: en.graphql.inputs.subscription_order_process_input.arguments.id
`unskipBeforeProcessing` - `Boolean`	Translation missing: en.graphql.inputs.subscription_order_process_input.arguments.unskip_before_processing

Example

{
  "force": true,
  "id": GlobalID,
  "unskipBeforeProcessing": false
}

Input Objects

SubscriptionOrderRescheduleInput

Description

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

Fields

Input Field	Description
`forceRebuild` - `Boolean`	Translation missing: en.graphql.inputs.subscription_order_reschedule_input.arguments.force_rebuild
`id` - `GlobalID!`	Translation missing: en.graphql.inputs.subscription_order_reschedule_input.arguments.id

Example

{"forceRebuild": false, "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

SubscriptionOrderUnflagInput

Description

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

Fields

Input Field	Description
`id` - `GlobalID!`	Translation missing: en.graphql.inputs.subscription_order_unflag_input.arguments.id

Example

{"id": GlobalID}

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
`customAttributes` - `[CustomAttributeInput!]`	Translation missing: en.graphql.inputs.subscription_order_update_input.arguments.custom_attributes
`deliveryMethod` - `SubscriptionDeliveryMethodUpdateInput`	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
`lines` - `[SubscriptionOrderLineInput!]`	Translation missing: en.graphql.inputs.subscription_order_update_input.arguments.lines
`notes` - `String`	Translation missing: en.graphql.inputs.subscription_order_update_input.arguments.notes
`paymentMethodId` - `GlobalID`	Translation missing: en.graphql.inputs.subscription_order_update_input.arguments.payment_method_id

Example

{
  "customAttributes": [CustomAttributeInput],
  "deliveryMethod": SubscriptionDeliveryMethodUpdateInput,
  "id": GlobalID,
  "lines": [SubscriptionOrderLineInput],
  "notes": "abc123",
  "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

Description

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

Fields

Input Field	Description
`anchorNameTemplate` - `String`	Translation missing: en.graphql.inputs.subscription_plan_create_input.arguments.anchor_name_template
`anchors` - `[SubscriptionAnchorCreateInput!]`	Translation missing: en.graphql.inputs.subscription_plan_create_input.arguments.anchors
`frequency` - `SubscriptionFrequencyCreateInput!`	Translation missing: en.graphql.inputs.subscription_plan_create_input.arguments.frequency
`name` - `String!`	Translation missing: en.graphql.inputs.subscription_plan_create_input.arguments.name

Example

{
  "anchorNameTemplate": "abc123",
  "anchors": [SubscriptionAnchorCreateInput],
  "frequency": SubscriptionFrequencyCreateInput,
  "name": "xyz789"
}

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

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

Fields

Input Field	Description
`billingBehaviour` - `SubscriptionBillingBehaviourInput!`	Translation missing: en.graphql.inputs.subscription_plan_group_create_input.arguments.billing_behaviour
`deliveryBehaviour` - `SubscriptionDeliveryBehaviourCreateInput`	Translation missing: en.graphql.inputs.subscription_plan_group_create_input.arguments.delivery_behaviour
`deliveryBehaviourType` - `SubscriptionDeliveryBehaviourType!`	Translation missing: en.graphql.inputs.subscription_plan_group_create_input.arguments.delivery_behaviour_type
`id` - `GlobalID`	Translation missing: en.graphql.inputs.subscription_plan_group_create_input.arguments.id
`inventoryBehaviour` - `SubscriptionInventoryBehaviourInput!`	Translation missing: en.graphql.inputs.subscription_plan_group_create_input.arguments.inventory_behaviour
`name` - `String!`	Translation missing: en.graphql.inputs.subscription_plan_group_create_input.arguments.name
`pricingBehaviour` - `SubscriptionPricingBehaviourInput!`	Translation missing: en.graphql.inputs.subscription_plan_group_create_input.arguments.pricing_behaviour
`productGroup` - `SubscriptionProductGroupInput!`	Translation missing: en.graphql.inputs.subscription_plan_group_create_input.arguments.product_group
`reference` - `String!`	Translation missing: en.graphql.inputs.subscription_plan_group_create_input.arguments.reference
`subscriptionPlans` - `[SubscriptionPlanCreateInput!]!`	Translation missing: en.graphql.inputs.subscription_plan_group_create_input.arguments.subscription_plans
`timezone` - `Timezone`	Translation missing: en.graphql.inputs.subscription_plan_group_create_input.arguments.timezone

Example

{
  "billingBehaviour": SubscriptionBillingBehaviourInput,
  "deliveryBehaviour": SubscriptionDeliveryBehaviourCreateInput,
  "deliveryBehaviourType": "FIXED",
  "id": GlobalID,
  "inventoryBehaviour": SubscriptionInventoryBehaviourInput,
  "name": "abc123",
  "pricingBehaviour": SubscriptionPricingBehaviourInput,
  "productGroup": SubscriptionProductGroupInput,
  "reference": "xyz789",
  "subscriptionPlans": [SubscriptionPlanCreateInput],
  "timezone": Timezone
}

Input Objects

SubscriptionPlanGroupUpdateInput

Description

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

Fields

Input Field	Description
`billingBehaviour` - `SubscriptionBillingBehaviourInput`	Translation missing: en.graphql.inputs.subscription_plan_group_update_input.arguments.billing_behaviour
`id` - `GlobalID!`	Translation missing: en.graphql.inputs.subscription_plan_group_update_input.arguments.id
`inventoryBehaviour` - `SubscriptionInventoryBehaviourInput`	Translation missing: en.graphql.inputs.subscription_plan_group_update_input.arguments.inventory_behaviour
`name` - `String`	Translation missing: en.graphql.inputs.subscription_plan_group_update_input.arguments.name
`pricingBehaviour` - `SubscriptionPricingBehaviourInput`	Translation missing: en.graphql.inputs.subscription_plan_group_update_input.arguments.pricing_behaviour
`productGroup` - `SubscriptionProductGroupInput`	Translation missing: en.graphql.inputs.subscription_plan_group_update_input.arguments.product_group
`reference` - `String`	Translation missing: en.graphql.inputs.subscription_plan_group_update_input.arguments.reference
`subscriptionPlansToCreate` - `[SubscriptionPlanCreateInput!]`	Translation missing: en.graphql.inputs.subscription_plan_group_update_input.arguments.subscription_plans_to_create
`subscriptionPlansToDelete` - `[GlobalID!]`	Translation missing: en.graphql.inputs.subscription_plan_group_update_input.arguments.subscription_plans_to_delete
`subscriptionPlansToUpdate` - `[SubscriptionPlanUpdateInput!]`	Translation missing: en.graphql.inputs.subscription_plan_group_update_input.arguments.subscription_plans_to_update

Example

{
  "billingBehaviour": SubscriptionBillingBehaviourInput,
  "id": GlobalID,
  "inventoryBehaviour": SubscriptionInventoryBehaviourInput,
  "name": "abc123",
  "pricingBehaviour": SubscriptionPricingBehaviourInput,
  "productGroup": SubscriptionProductGroupInput,
  "reference": "xyz789",
  "subscriptionPlansToCreate": [
    SubscriptionPlanCreateInput
  ],
  "subscriptionPlansToDelete": [GlobalID],
  "subscriptionPlansToUpdate": [
    SubscriptionPlanUpdateInput
  ]
}

Input Objects

SubscriptionPlanUpdateInput

Description

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

Fields

Input Field	Description
`id` - `GlobalID`	Translation missing: en.graphql.inputs.subscription_plan_update_input.arguments.id
`name` - `String`	Translation missing: en.graphql.inputs.subscription_plan_update_input.arguments.name
`status` - `SubscriptionPlanStatus`	Translation missing: en.graphql.inputs.subscription_plan_update_input.arguments.status

Example

{
  "id": GlobalID,
  "name": "abc123",
  "status": "ACTIVE"
}

Input Objects

SubscriptionPriceDiscountCapInput

Fields

Input Field	Description
`cap` - `MoneyInput!`
`type` - `SubscriptionPriceDiscountValueCapType!`

Example

{"cap": MoneyInput, "type": "INDIVIDUAL_ITEM"}

Input Objects

SubscriptionPriceDiscountInput

Fields

Input Field	Description
`fromCycle` - `Count`
`value` - `SubscriptionPriceDiscountValueInput!`
`valueCap` - `SubscriptionPriceDiscountCapInput`

Example

{
  "fromCycle": Count,
  "value": SubscriptionPriceDiscountValueInput,
  "valueCap": SubscriptionPriceDiscountCapInput
}

Input Objects

SubscriptionPriceDiscountValueInput

Fields

Input Field	Description
`fixedAmount` - `MoneyInput`
`percentage` - `Percentage`
`type` - `SubscriptionPriceDiscountType!`

Example

{
  "fixedAmount": MoneyInput,
  "percentage": Percentage,
  "type": "FIXED_AMOUNT"
}

Input Objects

SubscriptionPricingBehaviourInput

Description

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

Fields

Input Field	Description
`basePrice` - `MoneyInput`	Translation missing: en.graphql.inputs.subscription_pricing_behaviour_input.arguments.base_price
`basePricePolicy` - `SubscriptionBasePricePolicy!`	Translation missing: en.graphql.inputs.subscription_pricing_behaviour_input.arguments.base_price_policy
`discounts` - `[SubscriptionPriceDiscountInput!]`	Translation missing: en.graphql.inputs.subscription_pricing_behaviour_input.arguments.discounts. Default = `[]`

Example

{
  "basePrice": MoneyInput,
  "basePricePolicy": "CUSTOM",
  "discounts": [SubscriptionPriceDiscountInput]
}

Input Objects

SubscriptionProductGroupInput

Description

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

Fields

Input Field	Description
`itemSources` - `[SubscriptionProductGroupItemSourceInput!]!`	Translation missing: en.graphql.inputs.subscription_product_group_input.arguments.item_sources

Example

{"itemSources": [SubscriptionProductGroupItemSourceInput]}

Input Objects

SubscriptionProductGroupItemSourceInput

Description

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

Fields

Input Field	Description
`productCollectionId` - `SharedGlobalID`	Translation missing: en.graphql.inputs.subscription_product_group_item_source_input.arguments.product_collection_id
`productId` - `SharedGlobalID`	Translation missing: en.graphql.inputs.subscription_product_group_item_source_input.arguments.product_id
`productVariantId` - `SharedGlobalID`	Translation missing: en.graphql.inputs.subscription_product_group_item_source_input.arguments.product_variant_id

Example

{
  "productCollectionId": SharedGlobalID,
  "productId": SharedGlobalID,
  "productVariantId": SharedGlobalID
}

Input Objects

SubscriptionRescheduleInput

Description

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

Fields

Input Field	Description
`forceRebuild` - `Boolean`	Translation missing: en.graphql.inputs.subscription_reschedule_input.arguments.force_rebuild
`id` - `GlobalID!`	Translation missing: en.graphql.inputs.subscription_reschedule_input.arguments.id

Example

{"forceRebuild": true, "id": GlobalID}

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
`nextDeliveryAt` - `Timestamp!`	Translation missing: en.graphql.inputs.subscription_restore_input.arguments.next_delivery_at

Example

{
  "description": "abc123",
  "id": GlobalID,
  "nextDeliveryAt": 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
`nextDeliveryAt` - `Timestamp!`	Translation missing: en.graphql.inputs.subscription_resume_input.arguments.next_delivery_at

Example

{
  "description": "abc123",
  "id": GlobalID,
  "nextDeliveryAt": 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

SubscriptionRevertScheduledCancellationInput

Description

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

Fields

Input Field	Description
`description` - `String`	Translation missing: en.graphql.inputs.subscription_revert_scheduled_cancellation_input.arguments.description
`id` - `GlobalID!`	Translation missing: en.graphql.inputs.subscription_revert_scheduled_cancellation_input.arguments.id

Example

{
  "description": "xyz789",
  "id": GlobalID
}

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
`customAttributes` - `[CustomAttributeInput!]`	Translation missing: en.graphql.inputs.subscription_update_input.arguments.custom_attributes
`deliveryMethod` - `SubscriptionDeliveryMethodUpdateInput`	Translation missing: en.graphql.inputs.subscription_update_input.arguments.delivery_method
`id` - `GlobalID!`	Translation missing: en.graphql.inputs.subscription_update_input.arguments.id
`lines` - `[SubscriptionLineInput!]`	Translation missing: en.graphql.inputs.subscription_update_input.arguments.lines
`notes` - `String`	Translation missing: en.graphql.inputs.subscription_update_input.arguments.notes
`overwriteChildCustomAttributes` - `Boolean`	Translation missing: en.graphql.inputs.subscription_update_input.arguments.overwrite_child_custom_attributes
`paymentMethodId` - `GlobalID`	Translation missing: en.graphql.inputs.subscription_update_input.arguments.payment_method_id

Example

{
  "customAttributes": [CustomAttributeInput],
  "deliveryMethod": SubscriptionDeliveryMethodUpdateInput,
  "id": GlobalID,
  "lines": [SubscriptionLineInput],
  "notes": "abc123",
  "overwriteChildCustomAttributes": true,
  "paymentMethodId": GlobalID
}

Input Objects

SubscriptionsConfigSetInput

Description

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

Fields

Input Field	Description
`autoCorrectSubscriptionOrderBacklog` - `Boolean`	Translation missing: en.graphql.inputs.subscriptions_config_set_input.arguments.auto_correct_subscription_order_backlog
`calculatePricesBeforeProcessing` - `Boolean`	Translation missing: en.graphql.inputs.subscriptions_config_set_input.arguments.calculate_prices_before_processing
`defaultPaymentRetryPolicy` - `SubscriptionRetryPolicyInput`	Translation missing: en.graphql.inputs.subscriptions_config_set_input.arguments.default_payment_retry_policy
`defaultSubscriptionBacklogSize` - `SubscriptionBacklogSizeInput`	Translation missing: en.graphql.inputs.subscriptions_config_set_input.arguments.default_subscription_backlog_size
`flaggedOrderProcessingThresholdMins` - `Count`	Translation missing: en.graphql.inputs.subscriptions_config_set_input.arguments.flagged_order_processing_threshold_mins
`permittedFrequencyIntervals` - `[SubscriptionInterval!]`	Translation missing: en.graphql.inputs.subscriptions_config_set_input.arguments.permitted_frequency_intervals
`permittedRetryIntervals` - `[SubscriptionRetryInterval!]`	Translation missing: en.graphql.inputs.subscriptions_config_set_input.arguments.permitted_retry_intervals
`processSubscriptionOrders` - `Boolean`	Translation missing: en.graphql.inputs.subscriptions_config_set_input.arguments.process_subscription_orders
`processingWindowMins` - `Count`	Translation missing: en.graphql.inputs.subscriptions_config_set_input.arguments.processing_window_mins
`requireShippingAddressPhoneNumber` - `Boolean`	Translation missing: en.graphql.inputs.subscriptions_config_set_input.arguments.require_shipping_address_phone_number
`subscriptionEngine` - `SubscriptionEngine`	Translation missing: en.graphql.inputs.subscriptions_config_set_input.arguments.subscription_engine
`throttledRequestRetryPolicy` - `BackoffPolicyInput`	Translation missing: en.graphql.inputs.subscriptions_config_set_input.arguments.throttled_request_retry_policy

Example

{
  "autoCorrectSubscriptionOrderBacklog": true,
  "calculatePricesBeforeProcessing": false,
  "defaultPaymentRetryPolicy": SubscriptionRetryPolicyInput,
  "defaultSubscriptionBacklogSize": SubscriptionBacklogSizeInput,
  "flaggedOrderProcessingThresholdMins": Count,
  "permittedFrequencyIntervals": ["DAY"],
  "permittedRetryIntervals": ["DAY"],
  "processSubscriptionOrders": false,
  "processingWindowMins": Count,
  "requireShippingAddressPhoneNumber": false,
  "subscriptionEngine": "NOOP",
  "throttledRequestRetryPolicy": BackoffPolicyInput
}

Input Objects

TimeOffsetInput

Description

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

Fields

Input Field	Description
`direction` - `TimeOffsetDirection!`	Translation missing: en.graphql.inputs.time_offset_input.arguments.direction
`magnitude` - `Int!`	Translation missing: en.graphql.inputs.time_offset_input.arguments.magnitude
`unit` - `TimeOffsetUnit!`	Translation missing: en.graphql.inputs.time_offset_input.arguments.unit

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": "xyz789",
  "postcode": "xyz789",
  "province": Province,
  "street1": "abc123",
  "street2": "xyz789"
}

Objects

Afterpay

Fields

Field Name	Description
`accountEmail` - `String`	The account email.

Example

{"accountEmail": "xyz789"}

Objects

Airwallex

Fields

Field Name	Description
`accountEmail` - `String`	The account email.

Example

{"accountEmail": "abc123"}

Objects

BackoffPolicy

Description

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

Fields

Field Name	Description
`maxAttempts` - `NonZeroCount!`	Translation missing: en.graphql.objects.backoff_policy.fields.max_attempts
`multiplier` - `NonZeroCount!`	Translation missing: en.graphql.objects.backoff_policy.fields.multiplier
`thresholdSecs` - `[NonZeroCount!]!`	Translation missing: en.graphql.objects.backoff_policy.fields.threshold_secs

Example

{
  "maxAttempts": NonZeroCount,
  "multiplier": NonZeroCount,
  "thresholdSecs": [NonZeroCount]
}

Objects

CalculatedPrice

Fields

Field Name	Description
`amount` - `Money!`
`diff` - `Money!`

Example

{"amount": Money, "diff": Money}

Objects

CampaignData

Description

Campaign data.

Fields

Field Name	Description
`deposit` - `CampaignDeposit!`
`id` - `ID!`	The campaign's ID.
`type` - `CampaignType!`	The campaign's type.

Example

{
  "deposit": CampaignDeposit,
  "id": 4,
  "type": "CROWDFUNDING"
}

Objects

CampaignDeposit

Description

A campaign deposit.

Fields

Field Name	Description
`type` - `CampaignDepositType`	Translation missing: en.graphql.objects.campaign_deposit.fields.type
`value` - `Float`	Translation missing: en.graphql.objects.campaign_deposit.fields.value

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": 987,
  "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": 123,
  "appliedCount": 987,
  "campaignInventoryItems": [CampaignInventoryItem],
  "id": GlobalID,
  "reservedCount": 123,
  "resource": Product
}

Objects

CampaignOrderData

Description

Campaign order data.

Fields

Field Name	Description
`campaign` - `CampaignData!`	The campaign order's campaign.
`cancelled` - `Boolean!`	Indicates if the campaign order is cancelled.
`id` - `ID!`	ID of the campaign order.
`lineItem` - `LineItemData!`	The campaign order's line item.

Example

{
  "campaign": CampaignData,
  "cancelled": false,
  "id": "4",
  "lineItem": LineItemData
}

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

CampaignOrderGroupData

Fields

Field Name	Description
`campaignOrders` - `[CampaignOrderData!]!`	The products which are included in the campaign
`cancelled` - `Boolean!`	Indicates if the resource is cancelled.
`customerId` - `ID!`	The customer who owns this group
`externalId` - `String!`	The campaign order group's external ID.

Example

{
  "campaignOrders": [CampaignOrderData],
  "cancelled": false,
  "customerId": 4,
  "externalId": "abc123"
}

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": true,
  "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": 987}

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": "xyz789",
  "code": "AC",
  "emojiFlag": "abc123",
  "internationalPhoneCode": 987,
  "name": "abc123",
  "postcodeLabel": "abc123",
  "presentProvinces": true,
  "presentableProvinces": [Province],
  "provinceLabel": "abc123",
  "provinces": [Province]
}

Objects

CustomAttribute

Description

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

Fields

Field Name	Description
`customised` - `Boolean!`	Translation missing: en.graphql.objects.custom_attribute.fields.customised
`name` - `String!`	Translation missing: en.graphql.objects.custom_attribute.fields.name
`ownedBySubmarine` - `Boolean!`	Translation missing: en.graphql.objects.custom_attribute.fields.owned_by_submarine
`value` - `String!`	Translation missing: en.graphql.objects.custom_attribute.fields.value

Example

{
  "customised": false,
  "name": "xyz789",
  "ownedBySubmarine": true,
  "value": "xyz789"
}

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.
`activeSubscriptionsCount` - `Count!`	Translation missing: en.graphql.objects.customer.fields.active_subscriptions_count
`subscriptionsCount` - `Count!`	Translation missing: en.graphql.objects.customer.fields.subscriptions_count

Example

{
  "channel": Channel,
  "email": Email,
  "externalId": 4,
  "firstName": "abc123",
  "id": GlobalID,
  "lastName": "xyz789",
  "phone": "+17895551234",
  "status": "ACTIVE",
  "taxable": true,
  "verifiedEmail": true,
  "notifications": NotificationConnection,
  "campaignOrdersCount": 123,
  "activeSubscriptionsCount": Count,
  "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": "abc123",
  "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

Discount

Description

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

Fields

Field Name	Description
`category` - `DiscountCategory!`	Translation missing: en.graphql.objects.discount.fields.category
`class` - `DiscountClass!`
`discountAgreements` - `DiscountAgreementConnection!`	Translation missing: en.graphql.objects.discount.fields.discount_agreements
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.
`discountCodes` - `DiscountCodeConnection!`	Translation missing: en.graphql.objects.discount.fields.discount_codes
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.
`externalId` - `String`	Translation missing: en.graphql.objects.discount.fields.external_id
`id` - `GlobalID!`	Translation missing: en.graphql.objects.discount.fields.id
`status` - `DiscountStatus!`	Translation missing: en.graphql.objects.discount.fields.status
`title` - `String!`	Translation missing: en.graphql.objects.discount.fields.title
`type` - `DiscountType!`	Translation missing: en.graphql.objects.discount.fields.type
`value` - `DiscountValue!`	Translation missing: en.graphql.objects.discount.fields.value

Example

{
  "category": "APP",
  "class": "ORDER",
  "discountAgreements": DiscountAgreementConnection,
  "discountCodes": DiscountCodeConnection,
  "externalId": "abc123",
  "id": GlobalID,
  "status": "ACTIVE",
  "title": "abc123",
  "type": "AUTOMATIC",
  "value": DiscountValue
}

Objects

DiscountAgreement

Description

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

Fields

Field Name	Description
`context` - `DiscountAgreementContext!`
`discount` - `Discount!`	Translation missing: en.graphql.objects.discount_agreement.fields.discount
`discountApplications` - `DiscountApplicationConnection!`	Translation missing: en.graphql.objects.discount_agreement.fields.discount_applications
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.
`discountCode` - `DiscountCode`	Translation missing: en.graphql.objects.discount_agreement.fields.discount_code
`errorLog` - `[ErrorLogEntry!]!`
`id` - `GlobalID!`	Translation missing: en.graphql.objects.discount_agreement.fields.id
`status` - `DiscountAgreementStatus!`
`validated` - `Boolean!`	Translation missing: en.graphql.objects.discount_agreement.fields.validated

Example

{
  "context": DiscountAgreementContext,
  "discount": Discount,
  "discountApplications": DiscountApplicationConnection,
  "discountCode": DiscountCode,
  "errorLog": [ErrorLogEntry],
  "id": GlobalID,
  "status": "INVALID",
  "validated": false
}

Objects

DiscountAgreementContext

Description

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

Fields

Field Name	Description
`customerId` - `GlobalID`	Translation missing: en.graphql.objects.discount_agreement_context.fields.customer_id
`productIds` - `[GlobalID!]!`	Translation missing: en.graphql.objects.discount_agreement_context.fields.product_ids
`productVariantIds` - `[GlobalID!]!`	Translation missing: en.graphql.objects.discount_agreement_context.fields.product_variant_ids
`recur` - `Boolean!`	Translation missing: en.graphql.objects.discount_agreement_context.fields.recur
`totalPrice` - `Money`	Translation missing: en.graphql.objects.discount_agreement_context.fields.total_price
`virginApplication` - `Boolean`	Translation missing: en.graphql.objects.discount_agreement_context.fields.virgin_application

Example

{
  "customerId": GlobalID,
  "productIds": [GlobalID],
  "productVariantIds": [GlobalID],
  "recur": false,
  "totalPrice": Money,
  "virginApplication": false
}

Objects

DiscountApplication

Description

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

Fields

Field Name	Description
`errors` - `[ErrorLogEntry!]`
`id` - `GlobalID!`	Translation missing: en.graphql.objects.discount_application.fields.id
`status` - `DiscountApplicationStatus!`	Translation missing: en.graphql.objects.discount_application.fields.status

Example

{
  "errors": [ErrorLogEntry],
  "id": GlobalID,
  "status": "ACTIVE"
}

Objects

DiscountCode

Description

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

Fields

Field Name	Description
`code` - `String!`	Translation missing: en.graphql.objects.discount_code.fields.code
`discount` - `Discount!`	Translation missing: en.graphql.objects.discount_code.fields.discount
`externalId` - `String!`	Translation missing: en.graphql.objects.discount_code.fields.external_id
`id` - `GlobalID!`	Translation missing: en.graphql.objects.discount_code.fields.id
`status` - `DiscountCodeStatus!`	Translation missing: en.graphql.objects.discount_code.fields.status

Example

{
  "code": "xyz789",
  "discount": Discount,
  "externalId": "xyz789",
  "id": GlobalID,
  "status": "ACTIVE"
}

Objects

DiscountFinancials

Fields

Field Name	Description
`breakdown` - `[DiscountLine!]!`
`total` - `Money!`

Example

{
  "breakdown": [DiscountLine],
  "total": Money
}

Objects

DiscountFinancialsSet

Description

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

Fields

Field Name	Description
`breakdown` - `[DiscountLineSet!]!`	Translation missing: en.graphql.objects.discount_financials_set.fields.breakdown
`total` - `MoneySet!`	Translation missing: en.graphql.objects.discount_financials_set.fields.total

Example

{
  "breakdown": [DiscountLineSet],
  "total": MoneySet
}

Objects

DiscountLine

Fields

Field Name	Description
`discountClass` - `DiscountClass!`
`price` - `Money!`
`title` - `String`
`type` - `DiscountType`

Example

{
  "discountClass": "ORDER",
  "price": Money,
  "title": "abc123",
  "type": "AUTOMATIC"
}

Objects

DiscountLineSet

Description

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

Fields

Field Name	Description
`discountClass` - `DiscountClass!`	Translation missing: en.graphql.objects.discount_line_set.fields.discount_class
`discountId` - `GlobalID!`	Translation missing: en.graphql.objects.discount_line_set.fields.discount_id
`price` - `MoneySet!`	Translation missing: en.graphql.objects.discount_line_set.fields.price
`title` - `String!`	Translation missing: en.graphql.objects.discount_line_set.fields.title
`type` - `DiscountType!`	Translation missing: en.graphql.objects.discount_line_set.fields.type
`value` - `DiscountValue!`	Translation missing: en.graphql.objects.discount_line_set.fields.value

Example

{
  "discountClass": "ORDER",
  "discountId": GlobalID,
  "price": MoneySet,
  "title": "abc123",
  "type": "AUTOMATIC",
  "value": DiscountValue
}

Objects

DiscountValue

Description

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

Fields

Field Name	Description
`amount` - `Money`	Translation missing: en.graphql.objects.discount_value.fields.amount
`percentage` - `Int`	Translation missing: en.graphql.objects.discount_value.fields.percentage
`type` - `DiscountValueType!`	Translation missing: en.graphql.objects.discount_value.fields.type

Example

{
  "amount": Money,
  "percentage": 123,
  "type": "FIXED_AMOUNT"
}

Objects

ErrorLogEntry

Description

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

Fields

Field Name	Description
`changeset` - `Int!`	Translation missing: en.graphql.objects.error_log_entry.fields.changeset
`code` - `DiscountValidationError!`	Translation missing: en.graphql.objects.error_log_entry.fields.code
`messages` - `[String!]!`	Translation missing: en.graphql.objects.error_log_entry.fields.messages
`timestamp` - `String!`	Translation missing: en.graphql.objects.error_log_entry.fields.timestamp

Example

{
  "changeset": 987,
  "code": "DISCOUNT_DELETED",
  "messages": ["abc123"],
  "timestamp": "xyz789"
}

Objects

EventDiff

Description

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

Fields

Field Name	Description
`action` - `EventDiffAction!`	Translation missing: en.graphql.objects.event_diff.fields.action
`after` - `EventDiffValue!`	Translation missing: en.graphql.objects.event_diff.fields.after
`before` - `EventDiffValue!`	Translation missing: en.graphql.objects.event_diff.fields.before
`path` - `String!`	Translation missing: en.graphql.objects.event_diff.fields.path

Example

{
  "action": "ADDITION",
  "after": EventDiffValue,
  "before": EventDiffValue,
  "path": "xyz789"
}

Objects

ExchangeRate

Description

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

Fields

Field Name	Description
`createdAt` - `Timestamp!`	Translation missing: en.graphql.objects.exchange_rate.fields.created_at
`id` - `GlobalID!`	Translation missing: en.graphql.objects.exchange_rate.fields.id
`presentmentCurrency` - `CurrencyCode!`	Translation missing: en.graphql.objects.exchange_rate.fields.presentment_currency
`rate` - `Float!`	Translation missing: en.graphql.objects.exchange_rate.fields.rate
`shopCurrency` - `CurrencyCode!`	Translation missing: en.graphql.objects.exchange_rate.fields.shop_currency
`updatedAt` - `Timestamp!`	Translation missing: en.graphql.objects.exchange_rate.fields.updated_at

Example

{
  "createdAt": 1592577642,
  "id": GlobalID,
  "presentmentCurrency": "AED",
  "rate": 123.45,
  "shopCurrency": "AED",
  "updatedAt": 1592577642
}

Objects

Export

Description

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

Fields

Field Name	Description
`downloadUrl` - `String`	Translation missing: en.graphql.objects.export.fields.download_url
`recipientEmail` - `String`	Translation missing: en.graphql.objects.export.fields.recipient_email
`resourceType` - `ExportResource!`	Translation missing: en.graphql.objects.export.fields.resource_type
`status` - `ExportStatus!`	Translation missing: en.graphql.objects.export.fields.status

Example

{
  "downloadUrl": "abc123",
  "recipientEmail": "xyz789",
  "resourceType": "SUBSCRIPTION",
  "status": "CREATED"
}

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": false,
  "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": 123,
  "quantityReceived": 123,
  "sequentialId": 123
}

Objects

Klarna

Fields

Field Name	Description
`accountEmail` - `String`	The account email.

Example

{"accountEmail": "abc123"}

Objects

LineItem

Description

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

Fields

Field Name	Description
`createdAt` - `Timestamp!`	Translation missing: en.graphql.objects.line_item.fields.created_at
`externalId` - `String!`	Translation missing: en.graphql.objects.line_item.fields.external_id
`id` - `GlobalID!`	Translation missing: en.graphql.objects.line_item.fields.id
`order` - `Order!`	Translation missing: en.graphql.objects.line_item.fields.order
`product` - `Product!`	Translation missing: en.graphql.objects.line_item.fields.product
`productVariant` - `ProductVariant!`	Translation missing: en.graphql.objects.line_item.fields.product_variant
`updatedAt` - `Timestamp!`	Translation missing: en.graphql.objects.line_item.fields.updated_at

Example

{
  "createdAt": 1592577642,
  "externalId": "abc123",
  "id": GlobalID,
  "order": Order,
  "product": Product,
  "productVariant": ProductVariant,
  "updatedAt": 1592577642
}

Objects

LineItemData

Description

Line item data.

Fields

Field Name	Description
`externalId` - `ID!`	The line item's external ID.
`productId` - `ID!`	The line item's product ID.
`productVariantId` - `ID!`	The line item's product variant ID.
`quantity` - `Int!`	The line item's quantity.

Example

{
  "externalId": "4",
  "productId": "4",
  "productVariantId": 4,
  "quantity": 123
}

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

MoneySet

Description

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

Fields

Field Name	Description
`exchangeRate` - `Float!`	Translation missing: en.graphql.objects.money_set.fields.exchange_rate
`presentment` - `Money!`	Translation missing: en.graphql.objects.money_set.fields.presentment
`shop` - `Money!`	Translation missing: en.graphql.objects.money_set.fields.shop

Example

{
  "exchangeRate": 987.65,
  "presentment": Money,
  "shop": Money
}

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": "abc123",
  "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

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

Fields

Field Name	Description
`schedule` - `[TimeOffset!]!`	Translation missing: en.graphql.objects.notification_schedule_template.fields.schedule
`trigger` - `NotificationScheduleTrigger!`	Translation missing: en.graphql.objects.notification_schedule_template.fields.trigger

Example

{"schedule": [TimeOffset], "trigger": "CROWDFUND_END_AT"}

Objects

NotificationsConfig

Description

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

Fields

Field Name	Description
`emailCustomerWhenCampaignDueDateIsUpdated` - `Boolean!`	Translation missing: en.graphql.objects.notifications_config.fields.email_customer_when_campaign_due_date_is_updated
`emailCustomerWhenCampaignIsOrdered` - `Boolean!`	Translation missing: en.graphql.objects.notifications_config.fields.email_customer_when_campaign_is_ordered
`emailMerchantOnWebhookFailure` - `Boolean!`	Translation missing: en.graphql.objects.notifications_config.fields.email_merchant_on_webhook_failure
`emailMerchantWhenCampaignOrderCannotBeFulfilled` - `Boolean!`	Translation missing: en.graphql.objects.notifications_config.fields.email_merchant_when_campaign_order_cannot_be_fulfilled
`notificationSchedules` - `[NotificationScheduleTemplate!]!`	Translation missing: en.graphql.objects.notifications_config.fields.notification_schedules

Example

{
  "emailCustomerWhenCampaignDueDateIsUpdated": true,
  "emailCustomerWhenCampaignIsOrdered": true,
  "emailMerchantOnWebhookFailure": true,
  "emailMerchantWhenCampaignOrderCannotBeFulfilled": false,
  "notificationSchedules": [NotificationScheduleTemplate]
}

Objects

Order

Description

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

Fields

Field Name	Description
`channel` - `Channel!`	Translation missing: en.graphql.objects.order.fields.channel
`createdAt` - `Timestamp!`	Translation missing: en.graphql.objects.order.fields.created_at
`externalId` - `String!`	Translation missing: en.graphql.objects.order.fields.external_id
`id` - `GlobalID!`	Translation missing: en.graphql.objects.order.fields.id
`lineItems` - `[LineItem!]!`	Translation missing: en.graphql.objects.order.fields.line_items
`name` - `String!`	Translation missing: en.graphql.objects.order.fields.name
`organisation` - `Organisation!`	Translation missing: en.graphql.objects.order.fields.organisation
`updatedAt` - `Timestamp!`	Translation missing: en.graphql.objects.order.fields.updated_at
`subscriptions` - `[Subscription!]!`

Example

{
  "channel": Channel,
  "createdAt": 1592577642,
  "externalId": "abc123",
  "id": GlobalID,
  "lineItems": [LineItem],
  "name": "xyz789",
  "organisation": Organisation,
  "updatedAt": 1592577642,
  "subscriptions": [Subscription]
}

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": "xyz789",
  "hasNextPage": true,
  "hasPreviousPage": false,
  "startCursor": "xyz789"
}

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": true,
  "createdAt": ISO8601DateTime,
  "description": "xyz789",
  "externalId": "abc123",
  "externalReference": "xyz789",
  "id": GlobalID,
  "manuallyCapturable": false,
  "metadata": Metadata,
  "paymentInstrumentType": "AFTERPAY",
  "paymentMethod": PaymentMethod,
  "paymentProcessor": PaymentProcessor,
  "paymentSource": Afterpay,
  "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
`exchangeRate` - `Float`	The exchange rate between the presentment currency and the shop's currency.
`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",
  "exchangeRate": 123.45,
  "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": "xyz789"
}

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": "xyz789",
  "accountName": "xyz789",
  "externalId": "xyz789"
}

Objects

PaypalWallet

Fields

Field Name	Description
`accountEmail` - `String`	The account email.

Example

{"accountEmail": "xyz789"}

Objects

PlatformConfig

Description

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

Fields

Field Name	Description
`notifications` - `NotificationsConfig!`	Translation missing: en.graphql.objects.platform_config.fields.notifications
`presales` - `PresalesConfig!`	Translation missing: en.graphql.objects.platform_config.fields.presales
`pricing` - `PricingConfig!`	Translation missing: en.graphql.objects.platform_config.fields.pricing
`subscriptions` - `SubscriptionsConfig!`	Translation missing: en.graphql.objects.platform_config.fields.subscriptions

Example

{
  "notifications": NotificationsConfig,
  "presales": PresalesConfig,
  "pricing": PricingConfig,
  "subscriptions": SubscriptionsConfig
}

Objects

PostalAddress

Description

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

Fields

Field Name	Description
`city` - `String`	Translation missing: en.graphql.objects.postal_address.fields.city
`company` - `String`	Translation missing: en.graphql.objects.postal_address.fields.company
`country` - `Country!`	Translation missing: en.graphql.objects.postal_address.fields.country
`firstName` - `String`	Translation missing: en.graphql.objects.postal_address.fields.first_name
`lastName` - `String`	Translation missing: en.graphql.objects.postal_address.fields.last_name
`phone` - `PhoneNumber`	Translation missing: en.graphql.objects.postal_address.fields.phone
`postcode` - `Postcode`	Translation missing: en.graphql.objects.postal_address.fields.postcode
`province` - `Province`	Translation missing: en.graphql.objects.postal_address.fields.province
`street1` - `String`	Translation missing: en.graphql.objects.postal_address.fields.street1
`street2` - `String`	Translation missing: en.graphql.objects.postal_address.fields.street2

Example

{
  "city": "abc123",
  "company": "abc123",
  "country": Country,
  "firstName": "xyz789",
  "lastName": "abc123",
  "phone": "+17895551234",
  "postcode": Postcode,
  "province": Province,
  "street1": "xyz789",
  "street2": "abc123"
}

Objects

PresalesConfig

Description

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

Fields

Field Name	Description
`allowDepositUpdatesOnLaunchedPresales` - `Boolean!`	Translation missing: en.graphql.objects.presales_config.fields.allow_deposit_updates_on_launched_presales
`campaignPaymentTermsAlignment` - `CampaignPaymentTermsAlignment!`	Translation missing: en.graphql.objects.presales_config.fields.campaign_payment_terms_alignment
`defaultCurrency` - `CurrencyCode!`	Translation missing: en.graphql.objects.presales_config.fields.default_currency
`defaultPresaleDeposit` - `CampaignDeposit!`	Translation missing: en.graphql.objects.presales_config.fields.default_presale_deposit
`defaultPresaleInventoryPolicy` - `PresaleInventoryPolicy!`	Translation missing: en.graphql.objects.presales_config.fields.default_presale_inventory_policy
`metafieldUpdateInterval` - `Count!`	Translation missing: en.graphql.objects.presales_config.fields.metafield_update_interval
`refundPresalesDepositsOnCancellation` - `Boolean!`	Translation missing: en.graphql.objects.presales_config.fields.refund_presales_deposits_on_cancellation
`templateForCrowdfundSellingPlanDescription` - `String!`	Translation missing: en.graphql.objects.presales_config.fields.template_for_crowdfund_selling_plan_description
`templateForCrowdfundSellingPlanName` - `String!`	Translation missing: en.graphql.objects.presales_config.fields.template_for_crowdfund_selling_plan_name
`templateForPresaleSellingPlanDescription` - `String!`	Translation missing: en.graphql.objects.presales_config.fields.template_for_presale_selling_plan_description
`templateForPresaleSellingPlanName` - `String!`	Translation missing: en.graphql.objects.presales_config.fields.template_for_presale_selling_plan_name

Example

{
  "allowDepositUpdatesOnLaunchedPresales": true,
  "campaignPaymentTermsAlignment": "FIRST_CAMPAIGN",
  "defaultCurrency": "AED",
  "defaultPresaleDeposit": CampaignDeposit,
  "defaultPresaleInventoryPolicy": "ON_FULFILMENT",
  "metafieldUpdateInterval": Count,
  "refundPresalesDepositsOnCancellation": false,
  "templateForCrowdfundSellingPlanDescription": "xyz789",
  "templateForCrowdfundSellingPlanName": "xyz789",
  "templateForPresaleSellingPlanDescription": "xyz789",
  "templateForPresaleSellingPlanName": "abc123"
}

Objects

PriceCalculation

Description

A price calculation.

Fields

Field Name	Description
`discountAgreements` - `[PriceCalculationDiscountAgreement!]!`
`exchangeRate` - `Float!`
`id` - `GlobalID!`
`multiCurrency` - `Boolean!`
`presentmentCurrency` - `CurrencyCode!`
`presentmentPriceSets` - `[PriceSet!]!`
Arguments `resourceType` - `ResourceType`
`priceSets` - `[PriceSet!]!`
Arguments `resourceType` - `ResourceType`
`priceSource` - `PriceSource!`
`resource` - `Resource!`
`sequentialId` - `Int!`
`shopCurrency` - `CurrencyCode!`
`shopPriceSets` - `[PriceSet!]!`
Arguments `resourceType` - `ResourceType`
`status` - `PriceCalculationStatus!`

Example

{
  "discountAgreements": [
    PriceCalculationDiscountAgreement
  ],
  "exchangeRate": 123.45,
  "id": GlobalID,
  "multiCurrency": false,
  "presentmentCurrency": "AED",
  "presentmentPriceSets": [PriceSet],
  "priceSets": [PriceSet],
  "priceSource": PriceSource,
  "resource": Resource,
  "sequentialId": 123,
  "shopCurrency": "AED",
  "shopPriceSets": [PriceSet],
  "status": "CALCULATED"
}

Objects

PriceCalculationDiscount

Description

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

Fields

Field Name	Description
`category` - `DiscountCategory!`	Translation missing: en.graphql.objects.price_calculation_discount.fields.category
`class` - `DiscountClass!`
`id` - `GlobalID!`	Translation missing: en.graphql.objects.price_calculation_discount.fields.id
`title` - `String!`	Translation missing: en.graphql.objects.price_calculation_discount.fields.title
`type` - `DiscountType!`	Translation missing: en.graphql.objects.price_calculation_discount.fields.type
`value` - `DiscountValue!`	Translation missing: en.graphql.objects.price_calculation_discount.fields.value

Example

{
  "category": "APP",
  "class": "ORDER",
  "id": GlobalID,
  "title": "xyz789",
  "type": "AUTOMATIC",
  "value": DiscountValue
}

Objects

PriceCalculationDiscountAgreement

Description

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

Fields

Field Name	Description
`discount` - `PriceCalculationDiscount!`	Translation missing: en.graphql.objects.price_calculation_discount_agreement.fields.discount
`discountApplication` - `DiscountApplication!`	Translation missing: en.graphql.objects.price_calculation_discount_agreement.fields.discount_application
`discountCode` - `PriceCalculationDiscountCode`	Translation missing: en.graphql.objects.price_calculation_discount_agreement.fields.discount_code
`id` - `GlobalID!`	Translation missing: en.graphql.objects.price_calculation_discount_agreement.fields.id

Example

{
  "discount": PriceCalculationDiscount,
  "discountApplication": DiscountApplication,
  "discountCode": PriceCalculationDiscountCode,
  "id": GlobalID
}

Objects

PriceCalculationDiscountCode

Description

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

Fields

Field Name	Description
`code` - `String!`	Translation missing: en.graphql.objects.price_calculation_discount_code.fields.code
`id` - `GlobalID!`	Translation missing: en.graphql.objects.price_calculation_discount_code.fields.id

Example

{
  "code": "xyz789",
  "id": GlobalID
}

Objects

PriceCollection

Fields

Field Name	Description
`discountedUnitPrice` - `CalculatedPrice`
`itemPrice` - `CalculatedPrice`
`linePrice` - `CalculatedPrice`
`subtotal` - `CalculatedPrice`
`totalDeposit` - `CalculatedPrice`
`totalPrice` - `CalculatedPrice`
`unitPrice` - `CalculatedPrice`

Example

{
  "discountedUnitPrice": CalculatedPrice,
  "itemPrice": CalculatedPrice,
  "linePrice": CalculatedPrice,
  "subtotal": CalculatedPrice,
  "totalDeposit": CalculatedPrice,
  "totalPrice": CalculatedPrice,
  "unitPrice": CalculatedPrice
}

Objects

PriceEngine

Description

A price engine.

Fields

Field Name	Description
`engineType` - `PriceEngineType!`	The price engine's type.
`id` - `GlobalID!`	The ID of the price engine
`shopifyEngineConfig` - `ShopifyPriceEngineConfig!`	The price engine's config for Shopify.

Example

{
  "engineType": "SHOPIFY",
  "id": GlobalID,
  "shopifyEngineConfig": ShopifyPriceEngineConfig
}

Objects

PriceSet

Description

A price set.

Fields

Field Name	Description
`currency` - `CurrencyCode!`	The price set's currency
`currencyType` - `Currency!`
`discounts` - `PriceSetDiscounts!`	The price set's discounts
`id` - `GlobalID!`	The price set's ID
`priceCalculation` - `PriceCalculation!`	The price calculation's ID
`prices` - `PriceCollection!`	The price set's prices
`resourceId` - `ID!`	The price set's resource ID
`resourceType` - `PriceSetResourceType!`	The price set's resource type
`shipping` - `PriceSetShipping!`	The price set's shipping
`tax` - `PriceSetTax!`	The price set's tax

Example

{
  "currency": "AED",
  "currencyType": "COMMON",
  "discounts": PriceSetDiscounts,
  "id": GlobalID,
  "priceCalculation": PriceCalculation,
  "prices": PriceCollection,
  "resourceId": 4,
  "resourceType": "CAMPAIGN_ORDER",
  "shipping": PriceSetShipping,
  "tax": PriceSetTax
}

Objects

PriceSetDiscountBreakdown

Description

The price set's discount breakdown

Fields

Field Name	Description
`cents` - `MoneyCents!`
`class` - `DiscountClass!`
`discountId` - `GlobalID`
`title` - `String`
`type` - `DiscountType!`
`value` - `Int!`
`valueType` - `DiscountValueType!`

Example

{
  "cents": MoneyCents,
  "class": "ORDER",
  "discountId": GlobalID,
  "title": "abc123",
  "type": "AUTOMATIC",
  "value": 123,
  "valueType": "FIXED_AMOUNT"
}

Objects

PriceSetDiscounts

Description

The price set's discounts

Fields

Field Name	Description
`breakdown` - `[PriceSetDiscountBreakdown!]!`	The discount's breakdown
`cents` - `MoneyCents!`	The discount's amount as cents
`total` - `Money!`
Arguments `class` - `[DiscountClass!]` `round` - `Boolean`

Example

{
  "breakdown": [PriceSetDiscountBreakdown],
  "cents": MoneyCents,
  "total": Money
}

Objects

PriceSetShipping

Description

The price set's shipping

Fields

Field Name	Description
`breakdown` - `[PriceSetShippingBreakdown!]!`	The shipping breakdown
`cents` - `MoneyCents!`	The shipping amount as cents
`discounts` - `PriceSetDiscounts!`	The shipping discount
`tax` - `PriceSetTax!`	The shipping tax
`total` - `Money!`
Arguments `round` - `Boolean`

Example

{
  "breakdown": [PriceSetShippingBreakdown],
  "cents": MoneyCents,
  "discounts": PriceSetDiscounts,
  "tax": PriceSetTax,
  "total": Money
}

Objects

PriceSetShippingBreakdown

Description

The price set's shipping breakdown

Fields

Field Name	Description
`cents` - `MoneyCents!`	The shipping's amount as cents
`code` - `String!`	The shipping's code
`source` - `String!`	The shipping's source
`title` - `String!`	The shipping's title

Example

{
  "cents": MoneyCents,
  "code": "xyz789",
  "source": "xyz789",
  "title": "abc123"
}

Objects

PriceSetTax

Description

The price set's tax

Fields

Field Name	Description
`behaviour` - `TaxBehaviour!`	The tax's behaviour
`breakdown` - `[PriceSetTaxBreakdown!]!`	The tax's breakdown
`cents` - `MoneyCents!`	The tax's amount as cents
`total` - `Money!`
Arguments `round` - `Boolean`

Example

{
  "behaviour": "EXCLUSIVE",
  "breakdown": [PriceSetTaxBreakdown],
  "cents": MoneyCents,
  "total": Money
}

Objects

PriceSetTaxBreakdown

Description

The price set's tax breakdown

Fields

Field Name	Description
`cents` - `MoneyCents!`	The tax's amount as cents
`rate` - `Percentage!`	The tax rate as a percentage
`title` - `String!`	The tax's title

Example

{
  "cents": MoneyCents,
  "rate": Percentage,
  "title": "xyz789"
}

Objects

PriceSource

Description

A price source.

Fields

Field Name	Description
`engineType` - `PriceEngineType!`	The price source's engine type.
`id` - `GlobalID!`	The price source's ID
`priceCalculations` - `[PriceCalculation!]!`	The price source's price calculations
`resource` - `Resource!`	The price source's resource.
`source` - `Source!`	The price source's source.

Example

{
  "engineType": "SHOPIFY",
  "id": GlobalID,
  "priceCalculations": [PriceCalculation],
  "resource": Resource,
  "source": Source
}

Objects

PriceTable

Description

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

Fields

Field Name	Description
`cachedExchangeRate` - `ExchangeRate`	Translation missing: en.graphql.objects.price_table.fields.cached_exchange_rate
`countryCode` - `CountryCode!`	Translation missing: en.graphql.objects.price_table.fields.country_code
`presentmentCurrency` - `CurrencyCode!`	Translation missing: en.graphql.objects.price_table.fields.presentment_currency
`prices` - `[PriceTableEntry!]!`	Translation missing: en.graphql.objects.price_table.fields.prices
`shopCurrency` - `CurrencyCode!`	Translation missing: en.graphql.objects.price_table.fields.shop_currency

Example

{
  "cachedExchangeRate": ExchangeRate,
  "countryCode": "AC",
  "presentmentCurrency": "AED",
  "prices": [PriceTableEntry],
  "shopCurrency": "AED"
}

Objects

PriceTableEntry

Description

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

Fields

Field Name	Description
`price` - `MoneySet!`	Translation missing: en.graphql.objects.price_table_entry.fields.price
`productVariant` - `ProductVariant!`	Translation missing: en.graphql.objects.price_table_entry.fields.product_variant

Example

{
  "price": MoneySet,
  "productVariant": ProductVariant
}

Objects

PricingConfig

Description

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

Fields

Field Name	Description
`defaultPriceEngine` - `PriceEngineProvider!`	Translation missing: en.graphql.objects.pricing_config.fields.default_price_engine
`defaultPriceEnginePolicy` - `PriceEnginePolicy!`	Translation missing: en.graphql.objects.pricing_config.fields.default_price_engine_policy
`moneyRoundingMode` - `MoneyRoundingMode!`	Translation missing: en.graphql.objects.pricing_config.fields.money_rounding_mode
`shippingTaxable` - `Boolean!`	Translation missing: en.graphql.objects.pricing_config.fields.shipping_taxable
`taxBehaviour` - `TaxBehaviour!`	Translation missing: en.graphql.objects.pricing_config.fields.tax_behaviour

Example

{
  "defaultPriceEngine": "SHOPIFY",
  "defaultPriceEnginePolicy": "ALWAYS",
  "moneyRoundingMode": "ROUND_CEILING",
  "shippingTaxable": false,
  "taxBehaviour": "EXCLUSIVE"
}

Objects

ProductCollection

Description

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

Fields

Field Name	Description
`externalId` - `ID!`	Translation missing: en.graphql.objects.product_collection.fields.external_id
`id` - `GlobalID!`	Translation missing: en.graphql.objects.product_collection.fields.id
`imageUrl` - `String`	Translation missing: en.graphql.objects.product_collection.fields.image_url
`items` - `[ProductCollectionItem!]!`	Translation missing: en.graphql.objects.product_collection.fields.items
`productsCount` - `Count!`	Translation missing: en.graphql.objects.product_collection.fields.products_count
`status` - `ProductCollectionStatus!`	Translation missing: en.graphql.objects.product_collection.fields.status
`title` - `String!`	Translation missing: en.graphql.objects.product_collection.fields.title

Example

{
  "externalId": 4,
  "id": GlobalID,
  "imageUrl": "abc123",
  "items": [ProductCollectionItem],
  "productsCount": Count,
  "status": "PUBLISHED",
  "title": "xyz789"
}

Objects

ProductCollectionItem

Description

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

Fields

Field Name	Description
`externalId` - `ID!`	Translation missing: en.graphql.objects.product_collection_item.fields.external_id
`id` - `GlobalID!`	Translation missing: en.graphql.objects.product_collection_item.fields.id
`product` - `Product!`	Translation missing: en.graphql.objects.product_collection_item.fields.product
`status` - `ProductCollectionItemStatus!`	Translation missing: en.graphql.objects.product_collection_item.fields.status

Example

{
  "externalId": "4",
  "id": GlobalID,
  "product": Product,
  "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": "xyz789",
  "type": "ADMINISTRATION"
}

Objects

Resource

Description

The pricing resource

Fields

Field Name	Description
`data` - `ResourceData`	The resource's data
`id` - `ID!`	The resource's ID
`type` - `ResourceType!`	The resource's type

Example

{
  "data": CampaignOrderGroupData,
  "id": "4",
  "type": "CAMPAIGN_ORDER_GROUP"
}

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

ShippingFinancialsSet

Description

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

Fields

Field Name	Description
`breakdown` - `[ShippingLineSet!]!`	Translation missing: en.graphql.objects.shipping_financials_set.fields.breakdown
`total` - `MoneySet!`	Translation missing: en.graphql.objects.shipping_financials_set.fields.total

Example

{
  "breakdown": [ShippingLineSet],
  "total": MoneySet
}

Objects

ShippingLine

Fields

Field Name	Description
`code` - `String!`
`price` - `Money!`
`source` - `String!`
`title` - `String!`

Example

{
  "code": "xyz789",
  "price": Money,
  "source": "xyz789",
  "title": "xyz789"
}

Objects

ShippingLineSet

Description

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

Fields

Field Name	Description
`code` - `String!`	Translation missing: en.graphql.objects.shipping_line_set.fields.code
`price` - `MoneySet!`	Translation missing: en.graphql.objects.shipping_line_set.fields.price
`source` - `String!`	Translation missing: en.graphql.objects.shipping_line_set.fields.source
`title` - `String!`	Translation missing: en.graphql.objects.shipping_line_set.fields.title

Example

{
  "code": "xyz789",
  "price": MoneySet,
  "source": "xyz789",
  "title": "abc123"
}

Objects

ShippingRate

Description

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

Fields

Field Name	Description
`handle` - `String!`	Translation missing: en.graphql.objects.shipping_rate.fields.handle
`price` - `Money!`	Translation missing: en.graphql.objects.shipping_rate.fields.price
`title` - `String!`	Translation missing: en.graphql.objects.shipping_rate.fields.title

Example

{
  "handle": "xyz789",
  "price": Money,
  "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

ShopifyPriceEngineConfig

Description

The price engine's config for Shopify.

Fields

Field Name	Description
`apiTokens` - `[String!]!`	The API tokens.
`storeName` - `String!`	The store name.

Example

{
  "apiTokens": ["abc123"],
  "storeName": "abc123"
}

Objects

Source

Description

The pricing source

Fields

Field Name	Description
`id` - `ID!`	The source's ID
`parsedData` - `SourceParsedData`	The source's parsed data
`rawData` - `SourceRawData!`	The source's raw data
`type` - `SourceType!`	The source's type

Example

{
  "id": 4,
  "parsedData": SourceParsedData,
  "rawData": SourceRawData,
  "type": "CALCULATED_DRAFT_ORDER"
}

Objects

SourceCustomer

Description

A customer.

Fields

Field Name	Description
`id` - `ID!`
`taxable` - `Boolean!`

Example

{"id": "4", "taxable": true}

Objects

SourceDiscountLine

Description

A discount line.

Fields

Field Name	Description
`amount` - `MoneyDollars!`
`currency` - `CurrencyCode!`
`title` - `String!`
`type` - `DiscountType!`

Example

{
  "amount": MoneyDollars,
  "currency": "AED",
  "title": "xyz789",
  "type": "AUTOMATIC"
}

Objects

SourceLineItem

Description

A line item.

Fields

Field Name	Description
`currency` - `CurrencyCode!`
`discountLines` - `[SourceDiscountLine!]!`
`id` - `ID!`
`itemPrice` - `MoneyDollars!`
`productId` - `ID!`
`productVariantId` - `ID!`
`quantity` - `Int!`
`taxLines` - `[SourceTaxLine!]!`
`taxable` - `Boolean`

Example

{
  "currency": "AED",
  "discountLines": [SourceDiscountLine],
  "id": 4,
  "itemPrice": MoneyDollars,
  "productId": 4,
  "productVariantId": 4,
  "quantity": 123,
  "taxLines": [SourceTaxLine],
  "taxable": true
}

Objects

SourceParsedData

Description

A pricing source's data

Fields

Field Name	Description
`billingAddress` - `Address!`
`currency` - `CurrencyCode!`
`customer` - `SourceCustomer!`
`lineItems` - `[SourceLineItem!]!`
`shippingAddress` - `Address`
`shippingLine` - `SourceShippingLine`
`taxBehaviour` - `TaxBehaviour!`
`taxRates` - `[SourceTaxRate!]!`

Example

{
  "billingAddress": Address,
  "currency": "AED",
  "customer": SourceCustomer,
  "lineItems": [SourceLineItem],
  "shippingAddress": Address,
  "shippingLine": SourceShippingLine,
  "taxBehaviour": "EXCLUSIVE",
  "taxRates": [SourceTaxRate]
}

Objects

SourceRawData

Description

A pricing source's raw data

Fields

Field Name	Description
`billingAddress` - `SourceRawDataAddress!`	The billing address
`currency` - `CurrencyCode!`	The currency
`customAttributes` - `JSON`	The custom attributes
`customer` - `SourceRawDataCustomer!`	The customer
`discountApplications` - `[SourceRawDataDiscountApplication!]!`	The discount applications
`lineItems` - `[SourceRawDataLineItem!]!`	The line items
`shippingAddress` - `SourceRawDataAddress`	The shipping address
`shippingLines` - `[SourceRawDataShippingLine!]!`	The shipping line
`taxLines` - `[SourceTaxRate!]!`	The tax lines
`taxesIncluded` - `Boolean!`	The tax inclusion

Example

{
  "billingAddress": SourceRawDataAddress,
  "currency": "AED",
  "customAttributes": {},
  "customer": SourceRawDataCustomer,
  "discountApplications": [
    SourceRawDataDiscountApplication
  ],
  "lineItems": [SourceRawDataLineItem],
  "shippingAddress": SourceRawDataAddress,
  "shippingLines": [SourceRawDataShippingLine],
  "taxLines": [SourceTaxRate],
  "taxesIncluded": false
}

Objects

SourceRawDataAddress

Description

An address.

Fields

Field Name	Description
`address1` - `String`	The address's first line
`address2` - `String`	The address's second line
`city` - `String`	The city
`country` - `String`
`countryCode` - `CountryCode!`	The country code as enum
`firstName` - `String`
`lastName` - `String`
`phone` - `String`
`province` - `String`	The province name
`provinceCode` - `String`	The province code
`zip` - `String`	The zip code

Example

{
  "address1": "abc123",
  "address2": "xyz789",
  "city": "abc123",
  "country": "abc123",
  "countryCode": "AC",
  "firstName": "xyz789",
  "lastName": "xyz789",
  "phone": "xyz789",
  "province": "xyz789",
  "provinceCode": "abc123",
  "zip": "abc123"
}

Objects

SourceRawDataCustomer

Description

A customer.

Fields

Field Name	Description
`id` - `ID!`	The customer's ID
`taxExempt` - `Boolean!`	The customer's tax exemption

Example

{"id": 4, "taxExempt": true}

Objects

SourceRawDataDiscountAllocation

Description

A discount allocation.

Fields

Field Name	Description
`amount` - `MoneyDollars!`	The discount allocation's amount as dollars
`discountApplicationIndex` - `Int!`	The discount application index

Example

{"amount": MoneyDollars, "discountApplicationIndex": 987}

Objects

SourceRawDataDiscountApplication

Description

A discount application.

Fields

Field Name	Description
`code` - `String`	The discount application's code
`title` - `String`	The discount application's title
`type` - `String!`	The discount application's type

Example

{
  "code": "abc123",
  "title": "xyz789",
  "type": "abc123"
}

Objects

SourceRawDataLineItem

Description

A line item.

Fields

Field Name	Description
`customAttributes` - `JSON`	The custom attributes
`discountAllocations` - `[SourceRawDataDiscountAllocation!]!`	The line item's discount allocations
`id` - `ID!`	The line item's ID
`price` - `MoneyDollars!`	The line item's price as dollars
`productId` - `ID`	The line item's product ID
`quantity` - `Int!`	The line item's quantity
`requiresShipping` - `Boolean!`	The line item's shipping requirement
`taxLines` - `[SourceRawDataTaxLine!]!`	The line item's tax lines
`taxable` - `Boolean!`	The line item's taxation
`variantId` - `ID`	The line item's variant ID

Example

{
  "customAttributes": {},
  "discountAllocations": [
    SourceRawDataDiscountAllocation
  ],
  "id": 4,
  "price": MoneyDollars,
  "productId": 4,
  "quantity": 123,
  "requiresShipping": false,
  "taxLines": [SourceRawDataTaxLine],
  "taxable": false,
  "variantId": 4
}

Objects

SourceRawDataShippingLine

Description

A shipping line.

Fields

Field Name	Description
`code` - `String!`	The shipping line's code
`discountAllocations` - `[SourceRawDataDiscountAllocation!]!`	The shipping line's discount allocations
`price` - `MoneyDollars!`	The shipping line's price as dollars
`source` - `String`	The shipping line's source
`taxLines` - `[SourceRawDataTaxLine!]!`	The shipping line's tax lines
`title` - `String!`	The shipping line's title

Example

{
  "code": "abc123",
  "discountAllocations": [
    SourceRawDataDiscountAllocation
  ],
  "price": MoneyDollars,
  "source": "abc123",
  "taxLines": [SourceRawDataTaxLine],
  "title": "abc123"
}

Objects

SourceRawDataTaxLine

Description

A tax line.

Fields

Field Name	Description
`price` - `MoneyDollars!`	The tax line's price as dollars
`rate` - `Percentage!`	The tax rate as percentage
`title` - `String!`	The tax line's title

Example

{
  "price": MoneyDollars,
  "rate": Percentage,
  "title": "xyz789"
}

Objects

SourceShippingLine

Description

A shipping line.

Fields

Field Name	Description
`code` - `String!`
`currency` - `CurrencyCode!`
`discountLines` - `[SourceDiscountLine!]!`
`itemPrice` - `MoneyDollars!`
`source` - `String!`
`taxBehaviour` - `TaxBehaviour!`
`taxLines` - `[SourceTaxLine!]!`
`title` - `String!`

Example

{
  "code": "abc123",
  "currency": "AED",
  "discountLines": [SourceDiscountLine],
  "itemPrice": MoneyDollars,
  "source": "xyz789",
  "taxBehaviour": "EXCLUSIVE",
  "taxLines": [SourceTaxLine],
  "title": "abc123"
}

Objects

SourceTaxLine

Description

A tax line.

Fields

Field Name	Description
`currency` - `CurrencyCode!`	The tax line's currency
`price` - `MoneyDollars!`	The tax line's price as dollars
`rate` - `Percentage!`	The tax rate as a percentage
`title` - `String!`	The tax line's title

Example

{
  "currency": "AED",
  "price": MoneyDollars,
  "rate": Percentage,
  "title": "xyz789"
}

Objects

SourceTaxRate

Description

A tax rate.

Fields

Field Name	Description
`rate` - `Percentage!`	The tax rate as a percentage
`title` - `String!`	The tax rate's title

Example

{
  "rate": Percentage,
  "title": "xyz789"
}

Objects

SubscriptionAnchor

Description

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

Fields

Field Name	Description
`day` - `Day`	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` - `Month`	Translation missing: en.graphql.objects.subscription_anchor.fields.month
`name` - `String!`	Translation missing: en.graphql.objects.subscription_anchor.fields.name
`position` - `Count!`	Translation missing: en.graphql.objects.subscription_anchor.fields.position
`schedule` - `[DeliverySlot!]!`
Arguments `first` - `NonZeroCount!` `strict` - `Boolean`
`time` - `TimeOfDay`	Translation missing: en.graphql.objects.subscription_anchor.fields.time
`type` - `SubscriptionAnchorType!`	Translation missing: en.graphql.objects.subscription_anchor.fields.type

Example

{
  "day": Day,
  "description": "xyz789",
  "externalId": "abc123",
  "id": GlobalID,
  "month": Month,
  "name": "abc123",
  "position": Count,
  "schedule": [DeliverySlot],
  "time": TimeOfDay,
  "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

Description

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

Fields

Field Name	Description
`billingOffset` - `SubscriptionOffset!`	Translation missing: en.graphql.objects.subscription_billing_behaviour.fields.billing_offset
`processingOffset` - `SubscriptionOffset!`	Translation missing: en.graphql.objects.subscription_billing_behaviour.fields.processing_offset

Example

{
  "billingOffset": SubscriptionOffset,
  "processingOffset": SubscriptionOffset
}

Objects

SubscriptionData

Fields

Field Name	Description
`externalId` - `String`
`generatedOrdersCount` - `Count`
`id` - `ID`

Example

{
  "externalId": "abc123",
  "generatedOrdersCount": Count,
  "id": 4
}

Objects

SubscriptionDeliveryBehaviour

Description

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

Fields

Field Name	Description
`fixed` - `SubscriptionFixedDeliveryBehaviour`	Translation missing: en.graphql.objects.subscription_delivery_behaviour.fields.fixed
`type` - `SubscriptionDeliveryBehaviourType!`	Translation missing: en.graphql.objects.subscription_delivery_behaviour.fields.type

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
`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": "abc123",
  "description": "abc123",
  "source": "xyz789",
  "title": "abc123"
}

Objects

SubscriptionDiscount

Description

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

Fields

Field Name	Description
`createdAt` - `Timestamp!`	Translation missing: en.graphql.objects.subscription_discount.fields.created_at
`discount` - `Discount!`	Translation missing: en.graphql.objects.subscription_discount.fields.discount
`discountAgreement` - `DiscountAgreement!`	Translation missing: en.graphql.objects.subscription_discount.fields.discount_agreement
`discountApplication` - `DiscountApplication`	Translation missing: en.graphql.objects.subscription_discount.fields.discount_application
`id` - `GlobalID!`	Translation missing: en.graphql.objects.subscription_discount.fields.id
`status` - `SubscriptionDiscountStatus!`	Translation missing: en.graphql.objects.subscription_discount.fields.status
`subscription` - `Subscription`	Translation missing: en.graphql.objects.subscription_discount.fields.subscription
`updatedAt` - `Timestamp!`	Translation missing: en.graphql.objects.subscription_discount.fields.updated_at

Example

{
  "createdAt": 1592577642,
  "discount": Discount,
  "discountAgreement": DiscountAgreement,
  "discountApplication": DiscountApplication,
  "id": GlobalID,
  "status": "ACTIVE",
  "subscription": Subscription,
  "updatedAt": 1592577642
}

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
`charge` - `Charge`	Translation missing: en.graphql.objects.subscription_event.fields.charge
`createdAt` - `Timestamp!`	Translation missing: en.graphql.objects.subscription_event.fields.created_at
`customer` - `Customer`	Translation missing: en.graphql.objects.subscription_event.fields.customer
`description` - `String`	Translation missing: en.graphql.objects.subscription_event.fields.description
`diff` - `[EventDiff!]!`	Translation missing: en.graphql.objects.subscription_event.fields.diff
`id` - `GlobalID!`	Translation missing: en.graphql.objects.subscription_event.fields.id
`milestone` - `EventMilestone`	Translation missing: en.graphql.objects.subscription_event.fields.milestone
`paymentIntent` - `PaymentIntent`	Translation missing: en.graphql.objects.subscription_event.fields.payment_intent
`status` - `EventStatus!`	Translation missing: en.graphql.objects.subscription_event.fields.status
`subscription` - `Subscription`	Translation missing: en.graphql.objects.subscription_event.fields.subscription
`subscriptionDiscount` - `SubscriptionDiscount`	Translation missing: en.graphql.objects.subscription_event.fields.subscription_discount
`subscriptionOrder` - `SubscriptionOrder`	Translation missing: en.graphql.objects.subscription_event.fields.subscription_order

Example

{
  "action": "ACTIVATE",
  "charge": Charge,
  "createdAt": 1592577642,
  "customer": Customer,
  "description": "abc123",
  "diff": [EventDiff],
  "id": GlobalID,
  "milestone": "ADD_LINE",
  "paymentIntent": PaymentIntent,
  "status": "FAILED",
  "subscription": Subscription,
  "subscriptionDiscount": SubscriptionDiscount,
  "subscriptionOrder": SubscriptionOrder
}

Objects

SubscriptionFixedDeliveryBehaviour

Description

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

Fields

Field Name	Description
`cutoff` - `SubscriptionOffset!`	Translation missing: en.graphql.objects.subscription_fixed_delivery_behaviour.fields.cutoff
`preAnchorBehaviour` - `SubscriptionDeliveryPreAnchorBehaviourType!`	Translation missing: en.graphql.objects.subscription_fixed_delivery_behaviour.fields.pre_anchor_behaviour

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": "abc123",
  "interval": "DAY",
  "intervalCount": NonZeroCount,
  "maxCycles": NonZeroCount,
  "minCycles": NonZeroCount
}

Objects

SubscriptionHealthCheck

Description

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

Fields

Field Name	Description
`result` - `SubscriptionHealthStatus!`	Translation missing: en.graphql.objects.subscription_health_check.fields.result
`test` - `SubscriptionHealthTest!`	Translation missing: en.graphql.objects.subscription_health_check.fields.test

Example

{"result": "AT_RISK", "test": "LIMITED_SCHEDULED_ORDERS"}

Objects

SubscriptionInventoryBehaviour

Description

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

Fields

Field Name	Description
`inventoryDecrementPolicy` - `SubscriptionInventoryDecrementPolicy!`	Translation missing: en.graphql.objects.subscription_inventory_behaviour.fields.inventory_decrement_policy
`outOfStockPolicy` - `SubscriptionInventoryOutOfStockPolicy!`	Translation missing: en.graphql.objects.subscription_inventory_behaviour.fields.out_of_stock_policy

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
`basePriceSet` - `MoneySet!`	Translation missing: en.graphql.objects.subscription_line.fields.base_price_set
`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
`status` - `SubscriptionLineStatus!`	Translation missing: en.graphql.objects.subscription_line.fields.status
`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,
  "basePriceSet": MoneySet,
  "createdAt": 1592577642,
  "customised": true,
  "id": GlobalID,
  "product": Product,
  "productVariant": ProductVariant,
  "quantity": Count,
  "status": "ACTIVE",
  "subscription": Subscription,
  "updatedAt": 1592577642
}

Objects

SubscriptionLineItemData

Description

Subscription line item data.

Fields

Field Name	Description
`basePrice` - `Money`
`externalId` - `ID`
`lineType` - `SubscriptionLineItemDataLine`
`parentExternalId` - `ID`
`presentmentBasePrice` - `Money`
`productId` - `ID!`
`productVariantId` - `ID!`
`quantity` - `Int!`
`subscriptionOrderLineId` - `ID!`

Example

{
  "basePrice": Money,
  "externalId": "4",
  "lineType": "ONE_OFF",
  "parentExternalId": "4",
  "presentmentBasePrice": Money,
  "productId": 4,
  "productVariantId": "4",
  "quantity": 123,
  "subscriptionOrderLineId": "4"
}

Objects

SubscriptionOffset

Description

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

Fields

Field Name	Description
`interval` - `SubscriptionOffsetInterval!`	Translation missing: en.graphql.objects.subscription_offset.fields.interval
`intervalCount` - `Count!`	Translation missing: en.graphql.objects.subscription_offset.fields.interval_count
`type` - `SubscriptionOffsetType!`	Translation missing: en.graphql.objects.subscription_offset.fields.type

Example

{
  "interval": "DAY",
  "intervalCount": Count,
  "type": "BUSINESS"
}

Objects

SubscriptionOrderData

Fields

Field Name	Description
`currency` - `CurrencyCode`
`cycleIndex` - `CycleIndex`
`deliveryMethod` - `SubscriptionDeliveryMethod`
`lineItems` - `[SubscriptionLineItemData!]`
`pricingBehaviour` - `SubscriptionPricingBehaviour`
`subscription` - `SubscriptionData`

Example

{
  "currency": "AED",
  "cycleIndex": CycleIndex,
  "deliveryMethod": SubscriptionDeliveryMethodShipping,
  "lineItems": [SubscriptionLineItemData],
  "pricingBehaviour": SubscriptionPricingBehaviour,
  "subscription": SubscriptionData
}

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

SubscriptionOrderFinancialsSet

Description

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

Fields

Field Name	Description
`discounts` - `DiscountFinancialsSet!`	Translation missing: en.graphql.objects.subscription_order_financials_set.fields.discounts
`presentmentCurrency` - `CurrencyCode!`	Translation missing: en.graphql.objects.subscription_order_financials_set.fields.presentment_currency
`shipping` - `ShippingFinancialsSet`	Translation missing: en.graphql.objects.subscription_order_financials_set.fields.shipping
`shopCurrency` - `CurrencyCode!`	Translation missing: en.graphql.objects.subscription_order_financials_set.fields.shop_currency
`subtotal` - `MoneySet!`	Translation missing: en.graphql.objects.subscription_order_financials_set.fields.subtotal
`tax` - `TaxFinancialsSet!`	Translation missing: en.graphql.objects.subscription_order_financials_set.fields.tax
`totalPrice` - `MoneySet!`	Translation missing: en.graphql.objects.subscription_order_financials_set.fields.total_price

Example

{
  "discounts": DiscountFinancialsSet,
  "presentmentCurrency": "AED",
  "shipping": ShippingFinancialsSet,
  "shopCurrency": "AED",
  "subtotal": MoneySet,
  "tax": TaxFinancialsSet,
  "totalPrice": MoneySet
}

Objects

SubscriptionOrderLine

Description

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

Fields

Field Name	Description
`basePriceSet` - `MoneySet!`	Translation missing: en.graphql.objects.subscription_order_line.fields.base_price_set
`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`
`financialsSet` - `SubscriptionOrderLineFinancialsSet!`	Translation missing: en.graphql.objects.subscription_order_line.fields.financials_set
`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
`status` - `SubscriptionOrderLineStatus!`	Translation missing: en.graphql.objects.subscription_order_line.fields.status
`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

{
  "basePriceSet": MoneySet,
  "createdAt": 1592577642,
  "customised": true,
  "financials": SubscriptionOrderLineFinancials,
  "financialsSet": SubscriptionOrderLineFinancialsSet,
  "id": GlobalID,
  "lineItem": LineItem,
  "lineType": "ONE_OFF",
  "product": Product,
  "productVariant": ProductVariant,
  "quantity": Count,
  "status": "ACTIVE",
  "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

SubscriptionOrderLineFinancialsSet

Description

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

Fields

Field Name	Description
`discounts` - `DiscountFinancialsSet!`	Translation missing: en.graphql.objects.subscription_order_line_financials_set.fields.discounts
`linePrice` - `MoneySet!`
Arguments `afterDiscounts` - `Boolean` `afterTax` - `Boolean`
`presentmentCurrency` - `CurrencyCode!`	Translation missing: en.graphql.objects.subscription_order_line_financials_set.fields.presentment_currency
`shipping` - `ShippingFinancialsSet`	Translation missing: en.graphql.objects.subscription_order_line_financials_set.fields.shipping
`shopCurrency` - `CurrencyCode!`	Translation missing: en.graphql.objects.subscription_order_line_financials_set.fields.shop_currency
`tax` - `TaxFinancialsSet!`	Translation missing: en.graphql.objects.subscription_order_line_financials_set.fields.tax
`unitPrice` - `MoneySet!`
Arguments `afterDiscounts` - `Boolean` `afterTax` - `Boolean`

Example

{
  "discounts": DiscountFinancialsSet,
  "linePrice": MoneySet,
  "presentmentCurrency": "AED",
  "shipping": ShippingFinancialsSet,
  "shopCurrency": "AED",
  "tax": TaxFinancialsSet,
  "unitPrice": MoneySet
}

Objects

SubscriptionPriceDiscount

Description

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

Fields

Field Name	Description
`fromCycle` - `Count`	Translation missing: en.graphql.objects.subscription_price_discount.fields.from_cycle
`value` - `SubscriptionPriceDiscountValue`	Translation missing: en.graphql.objects.subscription_price_discount.fields.value
`valueCap` - `SubscriptionPriceDiscountCap`	Translation missing: en.graphql.objects.subscription_price_discount.fields.value_cap

Example

{
  "fromCycle": Count,
  "value": SubscriptionPriceDiscountValue,
  "valueCap": SubscriptionPriceDiscountCap
}

Objects

SubscriptionPriceDiscountCap

Description

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

Fields

Field Name	Description
`cap` - `Money`	Translation missing: en.graphql.objects.subscription_price_discount_cap.fields.cap
`type` - `SubscriptionPriceDiscountValueCapType!`	Translation missing: en.graphql.objects.subscription_price_discount_cap.fields.type

Example

{"cap": Money, "type": "INDIVIDUAL_ITEM"}

Objects

SubscriptionPriceDiscountValue

Description

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

Fields

Field Name	Description
`fixedAmount` - `Money`	Translation missing: en.graphql.objects.subscription_price_discount_value.fields.fixed_amount
`percentage` - `Percentage`	Translation missing: en.graphql.objects.subscription_price_discount_value.fields.percentage
`type` - `SubscriptionPriceDiscountType`	Translation missing: en.graphql.objects.subscription_price_discount_value.fields.type

Example

{
  "fixedAmount": Money,
  "percentage": Percentage,
  "type": "FIXED_AMOUNT"
}

Objects

SubscriptionPricingBehaviour

Description

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

Fields

Field Name	Description
`basePrice` - `Money`	Translation missing: en.graphql.objects.subscription_pricing_behaviour.fields.base_price
`basePricePolicy` - `SubscriptionBasePricePolicy!`	Translation missing: en.graphql.objects.subscription_pricing_behaviour.fields.base_price_policy
`discounts` - `[SubscriptionPriceDiscount!]`	Translation missing: en.graphql.objects.subscription_pricing_behaviour.fields.discounts

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": 987,
  "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": 987, "maxAttempts": 123}

Objects

SubscriptionSource

Description

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

Fields

Field Name	Description
`externalId` - `String`	Translation missing: en.graphql.objects.subscription_source.fields.external_id
`id` - `GlobalID`	Translation missing: en.graphql.objects.subscription_source.fields.id
`type` - `SubscriptionSourceType!`	Translation missing: en.graphql.objects.subscription_source.fields.type

Example

{
  "externalId": "abc123",
  "id": GlobalID,
  "type": "API"
}

Objects

SubscriptionsConfig

Description

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

Fields

Field Name	Description
`autoCorrectSubscriptionOrderBacklog` - `Boolean!`	Translation missing: en.graphql.objects.subscriptions_config.fields.auto_correct_subscription_order_backlog
`calculatePricesBeforeProcessing` - `Boolean!`	Translation missing: en.graphql.objects.subscriptions_config.fields.calculate_prices_before_processing
`defaultPaymentRetryPolicy` - `SubscriptionRetryPolicy!`	Translation missing: en.graphql.objects.subscriptions_config.fields.default_payment_retry_policy
`defaultSubscriptionBacklogSize` - `SubscriptionBacklogSize!`	Translation missing: en.graphql.objects.subscriptions_config.fields.default_subscription_backlog_size
`flaggedOrderProcessingThresholdMins` - `Count!`	Translation missing: en.graphql.objects.subscriptions_config.fields.flagged_order_processing_threshold_mins
`permittedFrequencyIntervals` - `[SubscriptionInterval!]!`	Translation missing: en.graphql.objects.subscriptions_config.fields.permitted_frequency_intervals
`permittedRetryIntervals` - `[SubscriptionRetryInterval!]!`	Translation missing: en.graphql.objects.subscriptions_config.fields.permitted_retry_intervals
`processSubscriptionOrders` - `Boolean!`	Translation missing: en.graphql.objects.subscriptions_config.fields.process_subscription_orders
`processingWindowMins` - `Count!`	Translation missing: en.graphql.objects.subscriptions_config.fields.processing_window_mins
`requireShippingAddressPhoneNumber` - `Boolean!`	Translation missing: en.graphql.objects.subscriptions_config.fields.require_shipping_address_phone_number
`subscriptionEngine` - `SubscriptionEngine!`	Translation missing: en.graphql.objects.subscriptions_config.fields.subscription_engine
`throttledRequestRetryPolicy` - `BackoffPolicy!`	Translation missing: en.graphql.objects.subscriptions_config.fields.throttled_request_retry_policy

Example

{
  "autoCorrectSubscriptionOrderBacklog": false,
  "calculatePricesBeforeProcessing": false,
  "defaultPaymentRetryPolicy": SubscriptionRetryPolicy,
  "defaultSubscriptionBacklogSize": SubscriptionBacklogSize,
  "flaggedOrderProcessingThresholdMins": Count,
  "permittedFrequencyIntervals": ["DAY"],
  "permittedRetryIntervals": ["DAY"],
  "processSubscriptionOrders": true,
  "processingWindowMins": Count,
  "requireShippingAddressPhoneNumber": true,
  "subscriptionEngine": "NOOP",
  "throttledRequestRetryPolicy": BackoffPolicy
}

Objects

TaxFinancials

Fields

Field Name	Description
`behaviour` - `TaxBehaviour!`
`breakdown` - `[TaxLine!]!`
`total` - `Money!`

Example

{
  "behaviour": "EXCLUSIVE",
  "breakdown": [TaxLine],
  "total": Money
}

Objects

TaxFinancialsSet

Description

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

Fields

Field Name	Description
`behaviour` - `TaxBehaviour!`	Translation missing: en.graphql.objects.tax_financials_set.fields.behaviour
`breakdown` - `[TaxLineSet!]!`	Translation missing: en.graphql.objects.tax_financials_set.fields.breakdown
`total` - `MoneySet!`	Translation missing: en.graphql.objects.tax_financials_set.fields.total

Example

{
  "behaviour": "EXCLUSIVE",
  "breakdown": [TaxLineSet],
  "total": MoneySet
}

Objects

TaxLine

Fields

Field Name	Description
`price` - `Money!`
`rate` - `Float!`
`title` - `String!`

Example

{
  "price": Money,
  "rate": 987.65,
  "title": "xyz789"
}

Objects

TaxLineSet

Description

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

Fields

Field Name	Description
`price` - `MoneySet!`	Translation missing: en.graphql.objects.tax_line_set.fields.price
`rate` - `Float!`	Translation missing: en.graphql.objects.tax_line_set.fields.rate
`title` - `String!`	Translation missing: en.graphql.objects.tax_line_set.fields.title

Example

{
  "price": MoneySet,
  "rate": 987.65,
  "title": "abc123"
}

Objects

TimeOffset

Description

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

Fields

Field Name	Description
`direction` - `TimeOffsetDirection!`	Translation missing: en.graphql.objects.time_offset.fields.direction
`magnitude` - `Int!`	Translation missing: en.graphql.objects.time_offset.fields.magnitude
`unit` - `TimeOffsetUnit!`	Translation missing: en.graphql.objects.time_offset.fields.unit

Example

{"direction": "BEFORE", "magnitude": 987, "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": "xyz789"
}

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`
`userErrors` - `[UserError!]!`

Example

{
  "channel": Channel,
  "userErrors": [UserError]
}

Payloads

ChannelCreatePayload

Description

Autogenerated return type of ChannelCreate.

Fields

Field Name	Description
`channel` - `Channel`
`userErrors` - `[UserError!]!`

Example

{
  "channel": Channel,
  "userErrors": [UserError]
}

Payloads

ChannelUpdatePayload

Description

Autogenerated return type of ChannelUpdate.

Fields

Field Name	Description
`channel` - `Channel`
`userErrors` - `[UserError!]!`

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

DiscountValidatePayload

Description

Autogenerated return type of DiscountValidate.

Fields

Field Name	Description
`discountAgreement` - `DiscountAgreement`	The newly created discount agreement
`userErrors` - `[UserError!]!`	A list of user errors.

Example

{
  "discountAgreement": DiscountAgreement,
  "userErrors": [UserError]
}

Payloads

ExchangeRatesSyncPayload

Description

Autogenerated return type of ExchangeRatesSync.

Fields

Field Name	Description
`channel` - `Channel`
`userErrors` - `[UserError!]!`

Example

{
  "channel": Channel,
  "userErrors": [UserError]
}

Payloads

ExportCreatePayload

Description

Autogenerated return type of ExportCreate.

Fields

Field Name	Description
`export` - `Export`
`userErrors` - `[UserError!]!`

Example

{
  "export": Export,
  "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`
`userErrors` - `[UserError!]!`

Example

{
  "order": Order,
  "userErrors": [UserError]
}

Payloads

OrderUpdatePayload

Description

Autogenerated return type of OrderUpdate.

Fields

Field Name	Description
`order` - `Order`
`userErrors` - `[UserError!]!`

Example

{
  "order": Order,
  "userErrors": [UserError]
}

Payloads

OrderUpsertPayload

Description

Autogenerated return type of OrderUpsert.

Fields

Field Name	Description
`order` - `Order`
`userErrors` - `[UserError!]!`

Example

{
  "order": Order,
  "userErrors": [UserError]
}

Payloads

OrganisationCreatePayload

Description

Autogenerated return type of OrganisationCreate.

Fields

Field Name	Description
`organisation` - `Organisation`
`userErrors` - `[UserError!]!`

Example

{
  "organisation": Organisation,
  "userErrors": [UserError]
}

Payloads

OrganisationUpdatePayload

Description

Autogenerated return type of OrganisationUpdate.

Fields

Field Name	Description
`organisation` - `Organisation`
`userErrors` - `[UserError!]!`

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

PaymentMethodRevokePayload

Description

Autogenerated return type of PaymentMethodRevoke.

Fields

Field Name	Description
`paymentMethod` - `PaymentMethod`
`userErrors` - `[UserError!]!`

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

PriceCalculationPerformPayload

Description

Autogenerated return type of PriceCalculationPerform.

Fields

Field Name	Description
`priceCalculation` - `PriceCalculation`	The price calculation.
`userErrors` - `[UserError!]!`	A list of user errors.

Example

{
  "priceCalculation": PriceCalculation,
  "userErrors": [UserError]
}

Payloads

PriceEngineCreatePayload

Description

Autogenerated return type of PriceEngineCreate.

Fields

Field Name	Description
`priceEngine` - `PriceEngine`	The newly created price engine.
`userErrors` - `[UserError!]!`	A list of user errors.

Example

{
  "priceEngine": PriceEngine,
  "userErrors": [UserError]
}

Payloads

PriceEngineUpdatePayload

Description

Autogenerated return type of PriceEngineUpdate.

Fields

Field Name	Description
`priceEngine` - `PriceEngine`	The newly updated price engine.
`userErrors` - `[UserError!]!`	A list of user errors.

Example

{
  "priceEngine": PriceEngine,
  "userErrors": [UserError]
}

Payloads

PriceSourceRegisterPayload

Description

Autogenerated return type of PriceSourceRegister.

Fields

Field Name	Description
`priceSource` - `PriceSource`	The newly registered price source.
`userErrors` - `[UserError!]!`	A list of user errors.

Example

{
  "priceSource": PriceSource,
  "userErrors": [UserError]
}

Payloads

PriceTableCalculatePayload

Description

Autogenerated return type of PriceTableCalculate.

Fields

Field Name	Description
`priceTable` - `PriceTable`
`userErrors` - `[UserError!]!`

Example

{
  "priceTable": PriceTable,
  "userErrors": [UserError]
}

Payloads

ProductCollectionCreatePayload

Description

Autogenerated return type of ProductCollectionCreate.

Fields

Field Name	Description
`productCollection` - `ProductCollection`
`userErrors` - `[UserError!]!`

Example

{
  "productCollection": ProductCollection,
  "userErrors": [UserError]
}

Payloads

ProductCollectionDeletePayload

Description

Autogenerated return type of ProductCollectionDelete.

Fields

Field Name	Description
`deletedProductCollectionId` - `GlobalID`
`userErrors` - `[UserError!]!`

Example

{
  "deletedProductCollectionId": GlobalID,
  "userErrors": [UserError]
}

Payloads

ProductCollectionUpdatePayload

Description

Autogenerated return type of ProductCollectionUpdate.

Fields

Field Name	Description
`productCollection` - `ProductCollection`
`userErrors` - `[UserError!]!`

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

ShippingRatesAvailablePayload

Description

Autogenerated return type of ShippingRatesAvailable.

Fields

Field Name	Description
`shippingRates` - `[ShippingRate!]`
`userErrors` - `[UserError!]!`	A list of user errors.

Example

{
  "shippingRates": [ShippingRate],
  "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

SubscriptionDiagnosePayload

Description

Autogenerated return type of SubscriptionDiagnose.

Fields

Field Name	Description
`subscription` - `Subscription`
`userErrors` - `[UserError!]!`

Example

{
  "subscription": Subscription,
  "userErrors": [UserError]
}

Payloads

SubscriptionDiscountActivatePayload

Description

Autogenerated return type of SubscriptionDiscountActivate.

Fields

Field Name	Description
`subscriptionDiscount` - `SubscriptionDiscount`
`userErrors` - `[UserError!]!`

Example

{
  "subscriptionDiscount": SubscriptionDiscount,
  "userErrors": [UserError]
}

Payloads

SubscriptionDiscountApplyPayload

Description

Autogenerated return type of SubscriptionDiscountApply.

Fields

Field Name	Description
`subscription` - `Subscription`
`subscriptionDiscount` - `SubscriptionDiscount`
`userErrors` - `[UserError!]!`

Example

{
  "subscription": Subscription,
  "subscriptionDiscount": SubscriptionDiscount,
  "userErrors": [UserError]
}

Payloads

SubscriptionDiscountRemovePayload

Description

Autogenerated return type of SubscriptionDiscountRemove.

Fields

Field Name	Description
`subscriptionDiscount` - `SubscriptionDiscount`
`userErrors` - `[UserError!]!`

Example

{
  "subscriptionDiscount": SubscriptionDiscount,
  "userErrors": [UserError]
}

Payloads

SubscriptionDiscountValidatePayload

Description

Autogenerated return type of SubscriptionDiscountValidate.

Fields

Field Name	Description
`subscription` - `Subscription`
`subscriptionDiscount` - `SubscriptionDiscount`
`userErrors` - `[UserError!]!`

Example

{
  "subscription": Subscription,
  "subscriptionDiscount": SubscriptionDiscount,
  "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

SubscriptionOrderReschedulePayload

Description

Autogenerated return type of SubscriptionOrderReschedule.

Fields

Field Name	Description
`subscriptionOrder` - `SubscriptionOrder`
`userErrors` - `[UserError!]!`

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

SubscriptionOrderUnflagPayload

Description

Autogenerated return type of SubscriptionOrderUnflag.

Fields

Field Name	Description
`subscriptionOrder` - `SubscriptionOrder`
`userErrors` - `[UserError!]!`

Example

{
  "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`
`userErrors` - `[UserError!]!`

Example

{
  "subscriptionPlanGroup": SubscriptionPlanGroup,
  "userErrors": [UserError]
}

Payloads

SubscriptionPlanGroupUpdatePayload

Description

Autogenerated return type of SubscriptionPlanGroupUpdate.

Fields

Field Name	Description
`deletedSubscriptionPlanIds` - `[GlobalID!]`
`subscriptionPlanGroup` - `SubscriptionPlanGroup`
`userErrors` - `[UserError!]!`

Example

{
  "deletedSubscriptionPlanIds": [GlobalID],
  "subscriptionPlanGroup": SubscriptionPlanGroup,
  "userErrors": [UserError]
}

Payloads

SubscriptionReschedulePayload

Description

Autogenerated return type of SubscriptionReschedule.

Fields

Field Name	Description
`subscription` - `Subscription`
`userErrors` - `[UserError!]!`

Example

{
  "subscription": Subscription,
  "userErrors": [UserError]
}

Payloads

SubscriptionRestorePayload

Description

Autogenerated return type of SubscriptionRestore.

Fields

Field Name	Description
`subscription` - `Subscription`
`upcomingDeliverySlots` - `[DeliverySlot!]`
`userErrors` - `[UserError!]!`

Example

{
  "subscription": Subscription,
  "upcomingDeliverySlots": [DeliverySlot],
  "userErrors": [UserError]
}

Payloads

SubscriptionResumePayload

Description

Autogenerated return type of SubscriptionResume.

Fields

Field Name	Description
`subscription` - `Subscription`
`upcomingDeliverySlots` - `[DeliverySlot!]`
`userErrors` - `[UserError!]!`

Example

{
  "subscription": Subscription,
  "upcomingDeliverySlots": [DeliverySlot],
  "userErrors": [UserError]
}

Payloads

SubscriptionRevertScheduledCancellationPayload

Description

Autogenerated return type of SubscriptionRevertScheduledCancellation.

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.
`upcomingDeliverySlots` - `[DeliverySlot!]`
`userErrors` - `[UserError!]!`	A list of user errors.

Example

{
  "subscription": Subscription,
  "upcomingDeliverySlots": [DeliverySlot],
  "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.

Example

true

Scalar

Count

Description

A postive integer, or zero.

Example

Count

Scalar

CycleIndex

Example

CycleIndex

Scalar

Day

Description

A postive integer

Example

Day

Scalar

Email

Example

Email

Scalar

EventDiffValue

Example

EventDiffValue

Scalar

Float

Description

The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.

Example

987.65

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

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.

Percentage

Scalar

PhoneNumber

Example

"+17895551234"

Scalar

PositiveInteger

Description

A postive integer

Example

PositiveInteger

Scalar

Postcode

Example

Postcode

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

"abc123"

Scalar

TimeOfDay

Description

Time of day in 24 hour format

Example

TimeOfDay

Scalar

Timestamp

Description

An ISO 8601 timestamp.

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
`Afterpay`
`Airwallex`
`Card`
`Klarna`
`PaypalBillingAgreement`
`PaypalWallet`

Example

Afterpay

Union

ResourceData

Types

Union Types
`CampaignOrderGroupData`
`SubscriptionOrderData`

Example

CampaignOrderGroupData

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