Skio API Reference

Empower your store with an open API that can easily integrate subscription data into your tech stack (analytics, marketing tools, etc). To use this API, go to your dashboard and click the API button on the left navigation bar. Generate an API token after setting a name and use this token in the request header "authorization" (case sensitive).

For example:

headers: {

"Content-Type": "application/graphql"

"authorization": "API <token>"

}

Contact

Skio Engineering

help@skio.com

Terms of Service

https://skio.com/terms/

API Endpoints
https://graphql.skio.com/v1/graphql

Queries

DiscountByPk

Description

fetch data from the table: "Discount" using primary key columns

Response

Returns a Discount

Arguments
Name Description
id - uuid!

Example

Query
query DiscountByPk($id: uuid!) {
  DiscountByPk(id: $id) {
    CancelFlowSession {
      ...CancelFlowSessionFragment
    }
    Group {
      ...GroupFragment
    }
    GroupPlan {
      ...GroupPlanFragment
    }
    OrderLineItem {
      ...OrderLineItemFragment
    }
    ShippingLine {
      ...ShippingLineFragment
    }
    Subscription {
      ...SubscriptionFragment
    }
    SubscriptionLine {
      ...SubscriptionLineFragment
    }
    cancelFlowSessionId
    createdAt
    fixedValue
    groupId
    groupPlanId
    id
    maxTimesUsed
    orderLineItemId
    percentage
    platformId
    redeemCode
    shippingLineId
    subscriptionId
    subscriptionLineId
    timesUsed
    type
    updatedAt
  }
}
Variables
{"id": uuid}
Response
{
  "data": {
    "DiscountByPk": {
      "CancelFlowSession": CancelFlowSession,
      "Group": Group,
      "GroupPlan": GroupPlan,
      "OrderLineItem": OrderLineItem,
      "ShippingLine": ShippingLine,
      "Subscription": Subscription,
      "SubscriptionLine": SubscriptionLine,
      "cancelFlowSessionId": uuid,
      "createdAt": timestamptz,
      "fixedValue": numeric,
      "groupId": uuid,
      "groupPlanId": uuid,
      "id": uuid,
      "maxTimesUsed": 123,
      "orderLineItemId": uuid,
      "percentage": numeric,
      "platformId": "abc123",
      "redeemCode": "xyz789",
      "shippingLineId": uuid,
      "subscriptionId": uuid,
      "subscriptionLineId": uuid,
      "timesUsed": 123,
      "type": "abc123",
      "updatedAt": timestamptz
    }
  }
}

Mutations

applyDiscountCode

Description

Apply a discount code on a subscription

Response

Returns an ApplyDiscountCodeOutput

Example

Query
mutation applyDiscountCode {
  applyDiscountCode {
    message
    ok
  }
}
Response
{
  "data": {
    "applyDiscountCode": {
      "message": "xyz789",
      "ok": true
    }
  }
}

updateNextBillingDate

Description

Change next billing date of a subscription. Date format should be an ISO string (YYYY-MM-DD), e.g 2022-01-01T17:44:49.406+00:00

Response

Returns an UpdateNextBillingDateOutput

Example

Query
mutation updateNextBillingDate {
  updateNextBillingDate {
    message
    ok
  }
}
Response
{
  "data": {
    "updateNextBillingDate": {
      "message": "abc123",
      "ok": true
    }
  }
}

Types

Address

Description

first/last nullable for billing fields

Fields
Field Name Description
PaymentMethod - PaymentMethod An object relationship
StorefrontUser - StorefrontUser! An object relationship
Subscriptions - [Subscription!]! An array relationship
address1 - String
address2 - String
city - String
company - String
country - String
createdAt - timestamptz!
doorCode - String
firstName - String
id - uuid!
lastName - String
phoneNumber - String
platformId - String
province - String
storefrontUserId - uuid!
updatedAt - timestamptz!
zip - String
Example
{
  "PaymentMethod": PaymentMethod,
  "StorefrontUser": StorefrontUser,
  "Subscriptions": [Subscription],
  "address1": "xyz789",
  "address2": "abc123",
  "city": "abc123",
  "company": "xyz789",
  "country": "xyz789",
  "createdAt": timestamptz,
  "doorCode": "abc123",
  "firstName": "xyz789",
  "id": uuid,
  "lastName": "abc123",
  "phoneNumber": "abc123",
  "platformId": "xyz789",
  "province": "abc123",
  "storefrontUserId": uuid,
  "updatedAt": timestamptz,
  "zip": "xyz789"
}

Anchor

Description

storefront user select/insert/update kinda funny. select is for seeing all anchor types (I think?!) and insert/update for modifying date

Fields
Field Name Description
Policy - Policy! An object relationship
createdAt - timestamptz!
cutoffDay - Int
day - Int!
id - uuid!
month - Int
policyId - uuid!
type - String!
updatedAt - timestamptz!
Example
{
  "Policy": Policy,
  "createdAt": timestamptz,
  "cutoffDay": 987,
  "day": 987,
  "id": uuid,
  "month": 987,
  "policyId": uuid,
  "type": "xyz789",
  "updatedAt": timestamptz
}

ApplyDiscountCodeOutput

Fields
Field Name Description
message - String!
ok - Boolean!
Example
{"message": "abc123", "ok": true}

AuditLog

Description

columns and relationships of "AuditLog"

Fields
Field Name Description
StorefrontUser - StorefrontUser An object relationship
Subscription - Subscription An object relationship
createdAt - timestamptz!
eventData - jsonb!
eventType - String!
id - uuid!
storefrontUserId - uuid
subscriptionId - uuid
updatedAt - timestamptz!
Example
{
  "StorefrontUser": StorefrontUser,
  "Subscription": Subscription,
  "createdAt": timestamptz,
  "eventData": jsonb,
  "eventType": "abc123",
  "id": uuid,
  "storefrontUserId": uuid,
  "subscriptionId": uuid,
  "updatedAt": timestamptz
}

Boolean

Example
true

CancelFlowReason

Description

columns and relationships of "CancelFlowReason"

Fields
Field Name Description
CancelFlowSession - CancelFlowSession An object relationship
cancelFlowId - uuid!
cancelFlowSessionId - uuid
createdAt - timestamptz!
id - uuid!
order - numeric!
otherReasonBody - String
reason - String!
rebuttal - String
updatedAt - timestamptz!
Example
{
  "CancelFlowSession": CancelFlowSession,
  "cancelFlowId": uuid,
  "cancelFlowSessionId": uuid,
  "createdAt": timestamptz,
  "id": uuid,
  "order": numeric,
  "otherReasonBody": "abc123",
  "reason": "xyz789",
  "rebuttal": "xyz789",
  "updatedAt": timestamptz
}

CancelFlowSession

Description

columns and relationships of "CancelFlowSession"

Fields
Field Name Description
CancelFlowReason - CancelFlowReason An object relationship
Discounts - [Discount!]! An array relationship
Subscription - Subscription! An object relationship
cancelFlowId - uuid!
createdAt - timestamptz!
id - uuid!
status - String
subscriptionId - uuid!
updatedAt - timestamptz!
Example
{
  "CancelFlowReason": CancelFlowReason,
  "Discounts": [Discount],
  "Subscription": Subscription,
  "cancelFlowId": uuid,
  "createdAt": timestamptz,
  "id": uuid,
  "status": "xyz789",
  "subscriptionId": uuid,
  "updatedAt": timestamptz
}

Discount

Description

We stick the objects on here since we want to be able to point multiple discounts at them.

Fields
Field Name Description
CancelFlowSession - CancelFlowSession An object relationship
Group - Group An object relationship
GroupPlan - GroupPlan An object relationship
OrderLineItem - OrderLineItem An object relationship
ShippingLine - ShippingLine An object relationship
Subscription - Subscription An object relationship
SubscriptionLine - SubscriptionLine An object relationship
cancelFlowSessionId - uuid
createdAt - timestamptz!
fixedValue - numeric
groupId - uuid
groupPlanId - uuid
id - uuid!
maxTimesUsed - Int
orderLineItemId - uuid
percentage - numeric
platformId - String
redeemCode - String
shippingLineId - uuid
subscriptionId - uuid
subscriptionLineId - uuid
timesUsed - Int
type - String
updatedAt - timestamptz!
Example
{
  "CancelFlowSession": CancelFlowSession,
  "Group": Group,
  "GroupPlan": GroupPlan,
  "OrderLineItem": OrderLineItem,
  "ShippingLine": ShippingLine,
  "Subscription": Subscription,
  "SubscriptionLine": SubscriptionLine,
  "cancelFlowSessionId": uuid,
  "createdAt": timestamptz,
  "fixedValue": numeric,
  "groupId": uuid,
  "groupPlanId": uuid,
  "id": uuid,
  "maxTimesUsed": 987,
  "orderLineItemId": uuid,
  "percentage": numeric,
  "platformId": "abc123",
  "redeemCode": "abc123",
  "shippingLineId": uuid,
  "subscriptionId": uuid,
  "subscriptionLineId": uuid,
  "timesUsed": 123,
  "type": "abc123",
  "updatedAt": timestamptz
}

Group

Description

columns and relationships of "Group"

Fields
Field Name Description
DiscountsPerUser - [Discount!]! An array relationship
GroupSet - GroupSet An object relationship
OrderLineItemsIfFirstOrder - [OrderLineItem!]! An array relationship
SubscriptionLines - [SubscriptionLine!]! An array relationship
createdAt - timestamptz!
groupSetId - uuid
id - uuid!
maxUsers - Int!
minUsers - Int!
updatedAt - timestamptz!
Example
{
  "DiscountsPerUser": [Discount],
  "GroupSet": GroupSet,
  "OrderLineItemsIfFirstOrder": [OrderLineItem],
  "SubscriptionLines": [SubscriptionLine],
  "createdAt": timestamptz,
  "groupSetId": uuid,
  "id": uuid,
  "maxUsers": 123,
  "minUsers": 123,
  "updatedAt": timestamptz
}

GroupPlan

Description

columns and relationships of "GroupPlan"

Fields
Field Name Description
DiscountsPerUser - [Discount!]! An array relationship
GroupSet - GroupSet An object relationship
SellingPlan - SellingPlan! An object relationship
createdAt - timestamptz!
groupSetId - uuid
id - uuid!
maxUsers - Int!
minUsers - Int!
sellingPlanId - uuid!
updatedAt - timestamptz!
Example
{
  "DiscountsPerUser": [Discount],
  "GroupSet": GroupSet,
  "SellingPlan": SellingPlan,
  "createdAt": timestamptz,
  "groupSetId": uuid,
  "id": uuid,
  "maxUsers": 987,
  "minUsers": 987,
  "sellingPlanId": uuid,
  "updatedAt": timestamptz
}

GroupSet

Description

columns and relationships of "GroupSet"

Fields
Field Name Description
GroupPlans - [GroupPlan!]! An array relationship
Groups - [Group!]! An array relationship
Site - Site! An object relationship
createdAt - timestamptz!
id - uuid!
name - String!
siteId - uuid!
updatedAt - timestamptz!
Example
{
  "GroupPlans": [GroupPlan],
  "Groups": [Group],
  "Site": Site,
  "createdAt": timestamptz,
  "id": uuid,
  "name": "xyz789",
  "siteId": uuid,
  "updatedAt": timestamptz
}

Holiday

Description

columns and relationships of "Holiday"

Fields
Field Name Description
Site - Site! An object relationship
id - uuid!
Example
{"Site": Site, "id": uuid}

Int

Example
123

Notification

Description

columns and relationships of "Notification"

Fields
Field Name Description
NotificationLogs - [NotificationLog!]! An array relationship
Site - Site! An object relationship
id - uuid!
Example
{
  "NotificationLogs": [NotificationLog],
  "Site": Site,
  "id": uuid
}

NotificationLog

Description

columns and relationships of "NotificationLog"

Fields
Field Name Description
Notification - Notification! An object relationship
Subscription - Subscription An object relationship
body - String
createdAt - timestamptz!
email - String
id - uuid!
notificationId - uuid!
phoneNumber - String
subject - String
subscriptionId - uuid
updatedAt - timestamptz!
Example
{
  "Notification": Notification,
  "Subscription": Subscription,
  "body": "abc123",
  "createdAt": timestamptz,
  "email": "xyz789",
  "id": uuid,
  "notificationId": uuid,
  "phoneNumber": "xyz789",
  "subject": "xyz789",
  "subscriptionId": uuid,
  "updatedAt": timestamptz
}

Order

Description

UNIQUE FIELDS WILL NOT WORK WELL WITH DELETEDAT

Fields
Field Name Description
OrderLineItems - [OrderLineItem!]! An array relationship
PrepaidSubscription - Subscription An object relationship
ShippingLines - [ShippingLine!]! An array relationship
StorefrontUser - StorefrontUser! An object relationship
cancelledAt - timestamptz
createdAt - timestamptz!
deletedAt - timestamptz
deliveredAt - timestamptz
id - uuid!
note - String
platformId - String
platformNumber - String!
storefrontUserId - uuid!
updatedAt - timestamp!
Example
{
  "OrderLineItems": [OrderLineItem],
  "PrepaidSubscription": Subscription,
  "ShippingLines": [ShippingLine],
  "StorefrontUser": StorefrontUser,
  "cancelledAt": timestamptz,
  "createdAt": timestamptz,
  "deletedAt": timestamptz,
  "deliveredAt": timestamptz,
  "id": uuid,
  "note": "xyz789",
  "platformId": "abc123",
  "platformNumber": "abc123",
  "storefrontUserId": uuid,
  "updatedAt": timestamp
}

OrderLineItem

Description

groupId is only defined on initial order

Fields
Field Name Description
Discounts - [Discount!]! An array relationship
GroupIfInitialOrder - Group An object relationship
Order - Order! An object relationship
ProductVariant - ProductVariant! An object relationship
SubscriptionLine - SubscriptionLine An object relationship
TaxLines - [TaxLine!]! An array relationship
attributionGroupId - uuid
createdAt - timestamptz!
customAttributes - jsonb
groupId - uuid
id - uuid!
orderId - uuid!
platformId - String
priceWithoutDiscount - numeric!
productVariantId - uuid!
quantity - Int!
subscriptionLineId - uuid
updatedAt - timestamptz!
Example
{
  "Discounts": [Discount],
  "GroupIfInitialOrder": Group,
  "Order": Order,
  "ProductVariant": ProductVariant,
  "SubscriptionLine": SubscriptionLine,
  "TaxLines": [TaxLine],
  "attributionGroupId": uuid,
  "createdAt": timestamptz,
  "customAttributes": jsonb,
  "groupId": uuid,
  "id": uuid,
  "orderId": uuid,
  "platformId": "abc123",
  "priceWithoutDiscount": numeric,
  "productVariantId": uuid,
  "quantity": 123,
  "subscriptionLineId": uuid,
  "updatedAt": timestamptz
}

PaymentMethod

Description

columns and relationships of "PaymentMethod"

Fields
Field Name Description
BillingAddress - Address An object relationship
StorefrontUser - StorefrontUser! An object relationship
Subscriptions - [Subscription!]! An array relationship
id - uuid!
Example
{
  "BillingAddress": Address,
  "StorefrontUser": StorefrontUser,
  "Subscriptions": [Subscription],
  "id": uuid
}

Policy

Description

No check on insert so be careful adding new fields

Fields
Field Name Description
Anchors - [Anchor!]! An array relationship
SellingPlansByBillingPolicy - [SellingPlan!]! An array relationship
SellingPlansByDeliveryPolicy - [SellingPlan!]! An array relationship
SellingPlansByPrepaidDeliveryPolicy - [SellingPlan!]! An array relationship
SubscriptionsByBillingPolicy - [Subscription!]! An array relationship
SubscriptionsByDeliveryPolicy - [Subscription!]! An array relationship
SubscriptionsByPrepaidDeliveryPolicy - [Subscription!]! An array relationship
createdAt - timestamptz!
id - uuid!
interval - String!
intervalCount - Int!
maxCycles - Int
minCycles - Int
updatedAt - timestamptz!
Example
{
  "Anchors": [Anchor],
  "SellingPlansByBillingPolicy": [SellingPlan],
  "SellingPlansByDeliveryPolicy": [SellingPlan],
  "SellingPlansByPrepaidDeliveryPolicy": [SellingPlan],
  "SubscriptionsByBillingPolicy": [Subscription],
  "SubscriptionsByDeliveryPolicy": [Subscription],
  "SubscriptionsByPrepaidDeliveryPolicy": [Subscription],
  "createdAt": timestamptz,
  "id": uuid,
  "interval": "abc123",
  "intervalCount": 123,
  "maxCycles": 987,
  "minCycles": 987,
  "updatedAt": timestamptz
}

PricingPolicy

Description

columns and relationships of "PricingPolicy"

Fields
Field Name Description
SellingPlan - SellingPlan! An object relationship
createdAt - timestamptz!
fixedPrice - numeric
id - uuid!
percentageOff - numeric
sellingPlanId - uuid!
sellingPlanPricingPolicyAdjustmentType - String
updatedAt - timestamptz!
Example
{
  "SellingPlan": SellingPlan,
  "createdAt": timestamptz,
  "fixedPrice": numeric,
  "id": uuid,
  "percentageOff": numeric,
  "sellingPlanId": uuid,
  "sellingPlanPricingPolicyAdjustmentType": "abc123",
  "updatedAt": timestamptz
}

Product

Description

UNIQUE FIELDS WILL NOT WORK WELL WITH DELETEDAT

Fields
Field Name Description
ProductVariants - [ProductVariant!]! An array relationship
Site - Site! An object relationship
createdAt - timestamptz!
deletedAt - timestamptz
id - uuid!
imageSrc - String
metafields - jsonb
platformId - String!
siteId - uuid!
slug - String!
smsOrder - Int
status - String
title - String!
updatedAt - timestamptz!
Example
{
  "ProductVariants": [ProductVariant],
  "Site": Site,
  "createdAt": timestamptz,
  "deletedAt": timestamptz,
  "id": uuid,
  "imageSrc": "xyz789",
  "metafields": jsonb,
  "platformId": "xyz789",
  "siteId": uuid,
  "slug": "abc123",
  "smsOrder": 123,
  "status": "abc123",
  "title": "abc123",
  "updatedAt": timestamptz
}

ProductVariant

Description

columns and relationships of "ProductVariant"

Fields
Field Name Description
OrderLineItems - [OrderLineItem!]! An array relationship
Product - Product! An object relationship
SellingPlanGroupResources - [SellingPlanGroupResource!]! An array relationship
SubscriptionLines - [SubscriptionLine!]! An array relationship
createdAt - timestamptz!
deletedAt - timestamptz
id - uuid!
image - String
platformId - String!
price - numeric!
productId - uuid!
sku - String
title - String!
updatedAt - timestamptz!
Example
{
  "OrderLineItems": [OrderLineItem],
  "Product": Product,
  "SellingPlanGroupResources": [SellingPlanGroupResource],
  "SubscriptionLines": [SubscriptionLine],
  "createdAt": timestamptz,
  "deletedAt": timestamptz,
  "id": uuid,
  "image": "abc123",
  "platformId": "xyz789",
  "price": numeric,
  "productId": uuid,
  "sku": "xyz789",
  "title": "xyz789",
  "updatedAt": timestamptz
}

SellingPlan

Description

columns and relationships of "SellingPlan"

Fields
Field Name Description
BillingPolicy - Policy! An object relationship
DeliveryPolicy - Policy! An object relationship
GroupPlans - [GroupPlan!]! An array relationship
PrepaidDeliveryPolicy - Policy An object relationship
PricingPolicies - [PricingPolicy!]! An array relationship
SellingPlanGroup - SellingPlanGroup! An object relationship
SkuSwaps - [SkuSwap!]! An array relationship
SubscriptionLines - [SubscriptionLine!]! An array relationship
billingPolicyId - uuid!
createdAt - timestamptz!
deliveryPolicyId - uuid!
id - uuid!
name - String!
option - String!
platformId - String!
position - Int!
prepaidDeliveryPolicyId - uuid
productVariantIdToSwapToAfterFirstOrder - String
sellingPlanGroupId - uuid!
updatedAt - timestamptz!
Example
{
  "BillingPolicy": Policy,
  "DeliveryPolicy": Policy,
  "GroupPlans": [GroupPlan],
  "PrepaidDeliveryPolicy": Policy,
  "PricingPolicies": [PricingPolicy],
  "SellingPlanGroup": SellingPlanGroup,
  "SkuSwaps": [SkuSwap],
  "SubscriptionLines": [SubscriptionLine],
  "billingPolicyId": uuid,
  "createdAt": timestamptz,
  "deliveryPolicyId": uuid,
  "id": uuid,
  "name": "abc123",
  "option": "xyz789",
  "platformId": "abc123",
  "position": 987,
  "prepaidDeliveryPolicyId": uuid,
  "productVariantIdToSwapToAfterFirstOrder": "abc123",
  "sellingPlanGroupId": uuid,
  "updatedAt": timestamptz
}

SellingPlanGroup

Description

columns and relationships of "SellingPlanGroup"

Fields
Field Name Description
SellingPlanGroupResources - [SellingPlanGroupResource!]! An array relationship
SellingPlans - [SellingPlan!]! An array relationship
byGroup - Boolean
createdAt - timestamptz!
customName - String
id - uuid!
name - String!
platformId - String!
updatedAt - timestamptz!
Example
{
  "SellingPlanGroupResources": [SellingPlanGroupResource],
  "SellingPlans": [SellingPlan],
  "byGroup": false,
  "createdAt": timestamptz,
  "customName": "xyz789",
  "id": uuid,
  "name": "xyz789",
  "platformId": "xyz789",
  "updatedAt": timestamptz
}

SellingPlanGroupResource

Description

columns and relationships of "SellingPlanGroupResource"

Fields
Field Name Description
ProductVariant - ProductVariant! An object relationship
SellingPlanGroup - SellingPlanGroup! An object relationship
createdAt - timestamptz!
id - uuid!
productVariantId - uuid!
sellingPlanGroupId - uuid!
updatedAt - timestamptz!
Example
{
  "ProductVariant": ProductVariant,
  "SellingPlanGroup": SellingPlanGroup,
  "createdAt": timestamptz,
  "id": uuid,
  "productVariantId": uuid,
  "sellingPlanGroupId": uuid,
  "updatedAt": timestamptz
}

ShippingLine

Description

columns and relationships of "ShippingLine"

Fields
Field Name Description
Discounts - [Discount!]! An array relationship
Order - Order! An object relationship
TaxLines - [TaxLine!]! An array relationship
createdAt - timestamptz!
id - uuid!
orderId - uuid!
platformId - String!
priceWithoutDiscount - numeric!
title - String!
updatedAt - timestamptz!
Example
{
  "Discounts": [Discount],
  "Order": Order,
  "TaxLines": [TaxLine],
  "createdAt": timestamptz,
  "id": uuid,
  "orderId": uuid,
  "platformId": "abc123",
  "priceWithoutDiscount": numeric,
  "title": "abc123",
  "updatedAt": timestamptz
}

Site

Description

Needs to be public for unauth to login.

Fields
Field Name Description
Holidays - [Holiday!]! An array relationship
Notifications - [Notification!]! An array relationship
Products - [Product!]! An array relationship
StorefrontUsers - [StorefrontUser!]! An array relationship
Theme - Theme An object relationship
Theme2 - Theme2 An object relationship
id - uuid!
Example
{
  "Holidays": [Holiday],
  "Notifications": [Notification],
  "Products": [Product],
  "StorefrontUsers": [StorefrontUser],
  "Theme": Theme,
  "Theme2": Theme2,
  "id": uuid
}

SkuSwap

Description

columns and relationships of "SkuSwap"

Fields
Field Name Description
SellingPlan - SellingPlan! An object relationship
afterOrderNumber - Int!
createdAt - timestamptz!
id - uuid!
newPrice - numeric
overrideDaysToNextBilling - Int
productVariantFromPlatformId - String
productVariantPlatformId - String
sellingPlanId - uuid!
siteId - uuid!
sku - String
updatedAt - timestamptz!
Example
{
  "SellingPlan": SellingPlan,
  "afterOrderNumber": 123,
  "createdAt": timestamptz,
  "id": uuid,
  "newPrice": numeric,
  "overrideDaysToNextBilling": 987,
  "productVariantFromPlatformId": "abc123",
  "productVariantPlatformId": "xyz789",
  "sellingPlanId": uuid,
  "siteId": uuid,
  "sku": "xyz789",
  "updatedAt": timestamptz
}

StorefrontUser

Description

columns and relationships of "StorefrontUser"

Fields
Field Name Description
Orders - [Order!]! An array relationship
PaymentMethods - [PaymentMethod!]! An array relationship
ShippingAddresses - [Address!]! An array relationship
Site - Site! An object relationship
Subscriptions - [Subscription!]! An array relationship
User - User An object relationship
createdAt - timestamptz!
email - String
firstName - String
id - uuid!
lastName - String
phoneNumber - String
platformId - String
siteId - uuid!
updatedAt - timestamptz!
Example
{
  "Orders": [Order],
  "PaymentMethods": [PaymentMethod],
  "ShippingAddresses": [Address],
  "Site": Site,
  "Subscriptions": [Subscription],
  "User": User,
  "createdAt": timestamptz,
  "email": "abc123",
  "firstName": "abc123",
  "id": uuid,
  "lastName": "xyz789",
  "phoneNumber": "abc123",
  "platformId": "xyz789",
  "siteId": uuid,
  "updatedAt": timestamptz
}

String

Example
"abc123"

Subscription

Description

statusContext: oneOf("CHURNED", "PERMANENTLY_CANCELLED")

Fields
Field Name Description
AuditLogs - [AuditLog!]! An array relationship
BillingPolicy - Policy! An object relationship
CancelFlowSessions - [CancelFlowSession!]! An array relationship
DeliveryPolicy - Policy! An object relationship
Discounts - [Discount!]! An array relationship
FulfillmentOrders - [Order!]! An array relationship
NotificationLogs - [NotificationLog!]! An array relationship
PaymentMethod - PaymentMethod! An object relationship
PrepaidDeliveryPolicy - Policy An object relationship
PrepaidSubscriptionLines - [SubscriptionLine!]! An array relationship
ShippingAddress - Address An object relationship
StorefrontUser - StorefrontUser! An object relationship
SubscriptionLines - [SubscriptionLine!]! An array relationship
billingPolicyId - uuid!
cancelledAt - timestamptz
createdAt - timestamptz!
currencyCode - String!
customAttributes - jsonb
cyclesCompleted - Int
deliveryPolicyId - uuid!
deliveryPrice - numeric!
deliveryPriceOverride - Int
id - uuid!
lastBillingAttemptAt - timestamptz
metadata - jsonb
nextBillingDate - timestamptz
platformId - String!
prepaidDeliveryPolicyId - uuid
prepaidProductPricesPerDelivery - jsonb
shippingAddressId - uuid
status - String!
statusContext - String
storefrontUserId - uuid!
updatedAt - timestamptz!
Example
{
  "AuditLogs": [AuditLog],
  "BillingPolicy": Policy,
  "CancelFlowSessions": [CancelFlowSession],
  "DeliveryPolicy": Policy,
  "Discounts": [Discount],
  "FulfillmentOrders": [Order],
  "NotificationLogs": [NotificationLog],
  "PaymentMethod": PaymentMethod,
  "PrepaidDeliveryPolicy": Policy,
  "PrepaidSubscriptionLines": [SubscriptionLine],
  "ShippingAddress": Address,
  "StorefrontUser": StorefrontUser,
  "SubscriptionLines": [SubscriptionLine],
  "billingPolicyId": uuid,
  "cancelledAt": timestamptz,
  "createdAt": timestamptz,
  "currencyCode": "xyz789",
  "customAttributes": jsonb,
  "cyclesCompleted": 123,
  "deliveryPolicyId": uuid,
  "deliveryPrice": numeric,
  "deliveryPriceOverride": 123,
  "id": uuid,
  "lastBillingAttemptAt": timestamptz,
  "metadata": jsonb,
  "nextBillingDate": timestamptz,
  "platformId": "xyz789",
  "prepaidDeliveryPolicyId": uuid,
  "prepaidProductPricesPerDelivery": jsonb,
  "shippingAddressId": uuid,
  "status": "xyz789",
  "statusContext": "xyz789",
  "storefrontUserId": uuid,
  "updatedAt": timestamptz
}

SubscriptionLine

Description

columns and relationships of "SubscriptionLine"

Fields
Field Name Description
Discounts - [Discount!]! An array relationship
Group - Group An object relationship
OrderLineItems - [OrderLineItem!]! An array relationship
OriginalSellingPlan - SellingPlan An object relationship
PrepaidSubscription - Subscription An object relationship
ProductVariant - ProductVariant! An object relationship
Subscription - Subscription An object relationship
createdAt - timestamptz!
customAttributes - jsonb
groupId - uuid only ever null if stale plan and unavailable groupplan
id - uuid!
ordersRemaining - Int
platformId - String
priceWithoutDiscount - numeric!
productVariantId - uuid!
quantity - Int!
removedAt - timestamptz
sellingPlanId - uuid
subscriptionId - uuid
taxable - Boolean!
updatedAt - timestamptz!
Example
{
  "Discounts": [Discount],
  "Group": Group,
  "OrderLineItems": [OrderLineItem],
  "OriginalSellingPlan": SellingPlan,
  "PrepaidSubscription": Subscription,
  "ProductVariant": ProductVariant,
  "Subscription": Subscription,
  "createdAt": timestamptz,
  "customAttributes": jsonb,
  "groupId": uuid,
  "id": uuid,
  "ordersRemaining": 987,
  "platformId": "xyz789",
  "priceWithoutDiscount": numeric,
  "productVariantId": uuid,
  "quantity": 123,
  "removedAt": timestamptz,
  "sellingPlanId": uuid,
  "subscriptionId": uuid,
  "taxable": false,
  "updatedAt": timestamptz
}

TaxLine

Description

columns and relationships of "TaxLine"

Fields
Field Name Description
OrderLineItem - OrderLineItem An object relationship
ShippingLine - ShippingLine An object relationship
createdAt - timestamptz!
id - uuid!
orderLineItemId - uuid
price - numeric!
rate - numeric!
shippingLineId - uuid
title - String!
updatedAt - timestamptz!
Example
{
  "OrderLineItem": OrderLineItem,
  "ShippingLine": ShippingLine,
  "createdAt": timestamptz,
  "id": uuid,
  "orderLineItemId": uuid,
  "price": numeric,
  "rate": numeric,
  "shippingLineId": uuid,
  "title": "abc123",
  "updatedAt": timestamptz
}

Theme

Description

columns and relationships of "Theme"

Fields
Field Name Description
Site - Site! An object relationship
id - uuid!
Example
{"Site": Site, "id": uuid}

Theme2

Description

columns and relationships of "Theme2"

Fields
Field Name Description
Site - Site An object relationship
badgeBGColor - String
badgeTextColor - String
buttonBGColor - String
buttonBorderRadius - numeric
buttonTextColor - String
cardBorderRadius - numeric
cardBorderWidth - numeric
carouselSlideSeconds - Int
id - uuid!
noSecondaryButtons - Boolean
siteId - uuid
tagBGColor - String
tagBorderRadius - numeric
tagTextColor - String
textAnchorColor - String
textApplyDiscountCode - String
textCancelNow - String
textEditFrequency - String
textOrderNow - String
updated_at - timestamptz!
Example
{
  "Site": Site,
  "badgeBGColor": "abc123",
  "badgeTextColor": "abc123",
  "buttonBGColor": "xyz789",
  "buttonBorderRadius": numeric,
  "buttonTextColor": "abc123",
  "cardBorderRadius": numeric,
  "cardBorderWidth": numeric,
  "carouselSlideSeconds": 123,
  "id": uuid,
  "noSecondaryButtons": false,
  "siteId": uuid,
  "tagBGColor": "abc123",
  "tagBorderRadius": numeric,
  "tagTextColor": "xyz789",
  "textAnchorColor": "abc123",
  "textApplyDiscountCode": "abc123",
  "textCancelNow": "xyz789",
  "textEditFrequency": "abc123",
  "textOrderNow": "xyz789",
  "updated_at": timestamptz
}

UpdateNextBillingDateOutput

Fields
Field Name Description
message - String!
ok - Boolean!
Example
{"message": "xyz789", "ok": true}

User

Description

Do not let dashboard users infer storefront <> user <> marketplace links.

Fields
Field Name Description
StorefrontUsers - [StorefrontUser!]! An array relationship
id - uuid!
Example
{
  "StorefrontUsers": [StorefrontUser],
  "id": uuid
}

jsonb

Example
jsonb

numeric

Example
numeric

timestamp

Example
timestamp

timestamptz

Example
timestamptz

uuid

Example
uuid