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>"
}
Please refer to Shopify's GraphQL API https://shopify.dev/docs/api/admin-graphql for understanding the Skio objects, as they are 1:1. For example an Order on Skio refers to an Order on Shopify.
Objects can be queried in two ways. One is using an ID (primary key or 'PK') to find an instance for example OrdersByPK
. The other by retrieving a list of matching objects with a filter, for example Orders
using a where
filter.
Terms of Service
API Endpoints
https://graphql.skio.com/v1/graphql
Queries
AddressByPk
Description
fetch data from the table: "Address" using primary key columns
Example
Query
query AddressByPk($id: uuid!) {
AddressByPk(id: $id) {
PaymentMethod {
...PaymentMethodFragment
}
StorefrontUser {
...StorefrontUserFragment
}
Subscriptions {
...SubscriptionFragment
}
address1
address2
city
company
country
createdAt
doorCode
firstName
id
lastName
phoneNumber
platformId
province
storefrontUserId
updatedAt
zip
}
}
Variables
{"id": uuid}
Response
{
"data": {
"AddressByPk": {
"PaymentMethod": PaymentMethod,
"StorefrontUser": StorefrontUser,
"Subscriptions": [Subscription],
"address1": "xyz789",
"address2": "xyz789",
"city": "abc123",
"company": "xyz789",
"country": "abc123",
"createdAt": timestamptz,
"doorCode": "abc123",
"firstName": "xyz789",
"id": uuid,
"lastName": "xyz789",
"phoneNumber": "xyz789",
"platformId": "xyz789",
"province": "abc123",
"storefrontUserId": uuid,
"updatedAt": timestamptz,
"zip": "abc123"
}
}
}
Addresses
Description
fetch data from the table: "Address"
Response
Returns [Address!]!
Arguments
Name | Description |
---|---|
distinct_on - [Address_select_column!]
|
distinct select on columns |
limit - Int
|
limit the number of rows returned |
offset - Int
|
skip the first n rows. Use only with order_by |
order_by - [Address_order_by!]
|
sort the rows by one or more columns |
where - Address_bool_exp
|
filter the rows returned |
Example
Query
query Addresses(
$distinct_on: [Address_select_column!],
$limit: Int,
$offset: Int,
$order_by: [Address_order_by!],
$where: Address_bool_exp
) {
Addresses(
distinct_on: $distinct_on,
limit: $limit,
offset: $offset,
order_by: $order_by,
where: $where
) {
PaymentMethod {
...PaymentMethodFragment
}
StorefrontUser {
...StorefrontUserFragment
}
Subscriptions {
...SubscriptionFragment
}
address1
address2
city
company
country
createdAt
doorCode
firstName
id
lastName
phoneNumber
platformId
province
storefrontUserId
updatedAt
zip
}
}
Variables
{
"distinct_on": ["address1"],
"limit": 123,
"offset": 987,
"order_by": [Address_order_by],
"where": Address_bool_exp
}
Response
{
"data": {
"Addresses": [
{
"PaymentMethod": PaymentMethod,
"StorefrontUser": StorefrontUser,
"Subscriptions": [Subscription],
"address1": "abc123",
"address2": "abc123",
"city": "xyz789",
"company": "xyz789",
"country": "xyz789",
"createdAt": timestamptz,
"doorCode": "abc123",
"firstName": "abc123",
"id": uuid,
"lastName": "xyz789",
"phoneNumber": "xyz789",
"platformId": "abc123",
"province": "abc123",
"storefrontUserId": uuid,
"updatedAt": timestamptz,
"zip": "abc123"
}
]
}
}
DiscountByPk
Description
fetch data from the table: "Discount" using primary key columns
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": 987,
"type": "abc123",
"updatedAt": timestamptz
}
}
}
OrderByPk
Description
fetch data from the table: "Order" using primary key columns
Example
Query
query OrderByPk($id: uuid!) {
OrderByPk(id: $id) {
OrderLineItems {
...OrderLineItemFragment
}
PrepaidSubscription {
...SubscriptionFragment
}
ShippingLines {
...ShippingLineFragment
}
StorefrontUser {
...StorefrontUserFragment
}
cancelledAt
clientIp
createdAt
deletedAt
deliveredAt
id
note
platformId
platformNumber
processedAt
storefrontUserId
updatedAt
}
}
Variables
{"id": uuid}
Response
{
"data": {
"OrderByPk": {
"OrderLineItems": [OrderLineItem],
"PrepaidSubscription": Subscription,
"ShippingLines": [ShippingLine],
"StorefrontUser": StorefrontUser,
"cancelledAt": timestamptz,
"clientIp": "abc123",
"createdAt": timestamptz,
"deletedAt": timestamptz,
"deliveredAt": timestamptz,
"id": uuid,
"note": "xyz789",
"platformId": "xyz789",
"platformNumber": "xyz789",
"processedAt": timestamptz,
"storefrontUserId": uuid,
"updatedAt": timestamp
}
}
}
OrderLineItems
Description
An array relationship
Response
Returns [OrderLineItem!]!
Arguments
Name | Description |
---|---|
distinct_on - [OrderLineItem_select_column!]
|
distinct select on columns |
limit - Int
|
limit the number of rows returned |
offset - Int
|
skip the first n rows. Use only with order_by |
order_by - [OrderLineItem_order_by!]
|
sort the rows by one or more columns |
where - OrderLineItem_bool_exp
|
filter the rows returned |
Example
Query
query OrderLineItems(
$distinct_on: [OrderLineItem_select_column!],
$limit: Int,
$offset: Int,
$order_by: [OrderLineItem_order_by!],
$where: OrderLineItem_bool_exp
) {
OrderLineItems(
distinct_on: $distinct_on,
limit: $limit,
offset: $offset,
order_by: $order_by,
where: $where
) {
Discounts {
...DiscountFragment
}
GroupIfInitialOrder {
...GroupFragment
}
Order {
...OrderFragment
}
ProductVariant {
...ProductVariantFragment
}
SubscriptionLine {
...SubscriptionLineFragment
}
TaxLines {
...TaxLineFragment
}
attributionGroupId
createdAt
customAttributes
groupId
id
orderId
platformId
priceWithoutDiscount
productVariantId
quantity
subscriptionLineId
updatedAt
}
}
Variables
{
"distinct_on": ["attributionGroupId"],
"limit": 987,
"offset": 987,
"order_by": [OrderLineItem_order_by],
"where": OrderLineItem_bool_exp
}
Response
{
"data": {
"OrderLineItems": [
{
"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": 987,
"subscriptionLineId": uuid,
"updatedAt": timestamptz
}
]
}
}
Orders
Description
An array relationship
Response
Returns [Order!]!
Arguments
Name | Description |
---|---|
distinct_on - [Order_select_column!]
|
distinct select on columns |
limit - Int
|
limit the number of rows returned |
offset - Int
|
skip the first n rows. Use only with order_by |
order_by - [Order_order_by!]
|
sort the rows by one or more columns |
where - Order_bool_exp
|
filter the rows returned |
Example
Query
query Orders(
$distinct_on: [Order_select_column!],
$limit: Int,
$offset: Int,
$order_by: [Order_order_by!],
$where: Order_bool_exp
) {
Orders(
distinct_on: $distinct_on,
limit: $limit,
offset: $offset,
order_by: $order_by,
where: $where
) {
OrderLineItems {
...OrderLineItemFragment
}
PrepaidSubscription {
...SubscriptionFragment
}
ShippingLines {
...ShippingLineFragment
}
StorefrontUser {
...StorefrontUserFragment
}
cancelledAt
clientIp
createdAt
deletedAt
deliveredAt
id
note
platformId
platformNumber
processedAt
storefrontUserId
updatedAt
}
}
Variables
{
"distinct_on": ["cancelledAt"],
"limit": 987,
"offset": 123,
"order_by": [Order_order_by],
"where": Order_bool_exp
}
Response
{
"data": {
"Orders": [
{
"OrderLineItems": [OrderLineItem],
"PrepaidSubscription": Subscription,
"ShippingLines": [ShippingLine],
"StorefrontUser": StorefrontUser,
"cancelledAt": timestamptz,
"clientIp": "abc123",
"createdAt": timestamptz,
"deletedAt": timestamptz,
"deliveredAt": timestamptz,
"id": uuid,
"note": "xyz789",
"platformId": "abc123",
"platformNumber": "abc123",
"processedAt": timestamptz,
"storefrontUserId": uuid,
"updatedAt": timestamp
}
]
}
}
Policies
Description
fetch data from the table: "Policy"
Response
Returns [Policy!]!
Arguments
Name | Description |
---|---|
distinct_on - [Policy_select_column!]
|
distinct select on columns |
limit - Int
|
limit the number of rows returned |
offset - Int
|
skip the first n rows. Use only with order_by |
order_by - [Policy_order_by!]
|
sort the rows by one or more columns |
where - Policy_bool_exp
|
filter the rows returned |
Example
Query
query Policies(
$distinct_on: [Policy_select_column!],
$limit: Int,
$offset: Int,
$order_by: [Policy_order_by!],
$where: Policy_bool_exp
) {
Policies(
distinct_on: $distinct_on,
limit: $limit,
offset: $offset,
order_by: $order_by,
where: $where
) {
Anchors {
...AnchorFragment
}
SellingPlansByBillingPolicy {
...SellingPlanFragment
}
SellingPlansByDeliveryPolicy {
...SellingPlanFragment
}
SellingPlansByPrepaidDeliveryPolicy {
...SellingPlanFragment
}
SubscriptionsByBillingPolicy {
...SubscriptionFragment
}
SubscriptionsByDeliveryPolicy {
...SubscriptionFragment
}
SubscriptionsByPrepaidDeliveryPolicy {
...SubscriptionFragment
}
createdAt
id
interval
intervalCount
isMaxCycleV2
maxCycles
minCycles
updatedAt
}
}
Variables
{
"distinct_on": ["createdAt"],
"limit": 123,
"offset": 123,
"order_by": [Policy_order_by],
"where": Policy_bool_exp
}
Response
{
"data": {
"Policies": [
{
"Anchors": [Anchor],
"SellingPlansByBillingPolicy": [SellingPlan],
"SellingPlansByDeliveryPolicy": [SellingPlan],
"SellingPlansByPrepaidDeliveryPolicy": [
SellingPlan
],
"SubscriptionsByBillingPolicy": [Subscription],
"SubscriptionsByDeliveryPolicy": [Subscription],
"SubscriptionsByPrepaidDeliveryPolicy": [
Subscription
],
"createdAt": timestamptz,
"id": uuid,
"interval": "abc123",
"intervalCount": 123,
"isMaxCycleV2": true,
"maxCycles": 123,
"minCycles": 123,
"updatedAt": timestamptz
}
]
}
}
PolicyByPk
Description
fetch data from the table: "Policy" using primary key columns
Example
Query
query PolicyByPk($id: uuid!) {
PolicyByPk(id: $id) {
Anchors {
...AnchorFragment
}
SellingPlansByBillingPolicy {
...SellingPlanFragment
}
SellingPlansByDeliveryPolicy {
...SellingPlanFragment
}
SellingPlansByPrepaidDeliveryPolicy {
...SellingPlanFragment
}
SubscriptionsByBillingPolicy {
...SubscriptionFragment
}
SubscriptionsByDeliveryPolicy {
...SubscriptionFragment
}
SubscriptionsByPrepaidDeliveryPolicy {
...SubscriptionFragment
}
createdAt
id
interval
intervalCount
isMaxCycleV2
maxCycles
minCycles
updatedAt
}
}
Variables
{"id": uuid}
Response
{
"data": {
"PolicyByPk": {
"Anchors": [Anchor],
"SellingPlansByBillingPolicy": [SellingPlan],
"SellingPlansByDeliveryPolicy": [SellingPlan],
"SellingPlansByPrepaidDeliveryPolicy": [
SellingPlan
],
"SubscriptionsByBillingPolicy": [Subscription],
"SubscriptionsByDeliveryPolicy": [Subscription],
"SubscriptionsByPrepaidDeliveryPolicy": [
Subscription
],
"createdAt": timestamptz,
"id": uuid,
"interval": "abc123",
"intervalCount": 123,
"isMaxCycleV2": true,
"maxCycles": 987,
"minCycles": 123,
"updatedAt": timestamptz
}
}
}
PricingPolicies
Description
An array relationship
Response
Returns [PricingPolicy!]!
Arguments
Name | Description |
---|---|
distinct_on - [PricingPolicy_select_column!]
|
distinct select on columns |
limit - Int
|
limit the number of rows returned |
offset - Int
|
skip the first n rows. Use only with order_by |
order_by - [PricingPolicy_order_by!]
|
sort the rows by one or more columns |
where - PricingPolicy_bool_exp
|
filter the rows returned |
Example
Query
query PricingPolicies(
$distinct_on: [PricingPolicy_select_column!],
$limit: Int,
$offset: Int,
$order_by: [PricingPolicy_order_by!],
$where: PricingPolicy_bool_exp
) {
PricingPolicies(
distinct_on: $distinct_on,
limit: $limit,
offset: $offset,
order_by: $order_by,
where: $where
) {
SellingPlan {
...SellingPlanFragment
}
afterCycle
createdAt
fixedPrice
id
percentageOff
sellingPlanId
sellingPlanPricingPolicyAdjustmentType
updatedAt
}
}
Variables
{
"distinct_on": ["afterCycle"],
"limit": 987,
"offset": 987,
"order_by": [PricingPolicy_order_by],
"where": PricingPolicy_bool_exp
}
Response
{
"data": {
"PricingPolicies": [
{
"SellingPlan": SellingPlan,
"afterCycle": 123,
"createdAt": timestamptz,
"fixedPrice": numeric,
"id": uuid,
"percentageOff": numeric,
"sellingPlanId": uuid,
"sellingPlanPricingPolicyAdjustmentType": "abc123",
"updatedAt": timestamptz
}
]
}
}
PricingPolicyByPk
Description
fetch data from the table: "PricingPolicy" using primary key columns
Response
Returns a PricingPolicy
Arguments
Name | Description |
---|---|
id - uuid!
|
Example
Query
query PricingPolicyByPk($id: uuid!) {
PricingPolicyByPk(id: $id) {
SellingPlan {
...SellingPlanFragment
}
afterCycle
createdAt
fixedPrice
id
percentageOff
sellingPlanId
sellingPlanPricingPolicyAdjustmentType
updatedAt
}
}
Variables
{"id": uuid}
Response
{
"data": {
"PricingPolicyByPk": {
"SellingPlan": SellingPlan,
"afterCycle": 987,
"createdAt": timestamptz,
"fixedPrice": numeric,
"id": uuid,
"percentageOff": numeric,
"sellingPlanId": uuid,
"sellingPlanPricingPolicyAdjustmentType": "xyz789",
"updatedAt": timestamptz
}
}
}
ProductByPk
Description
fetch data from the table: "Product" using primary key columns
Example
Query
query ProductByPk($id: uuid!) {
ProductByPk(id: $id) {
DynamicBox {
...DynamicBoxFragment
}
ProductVariants {
...ProductVariantFragment
}
Site {
...SiteFragment
}
createdAt
deletedAt
id
imageSrc
limitOneTimeUpsellQuantity
metafields
platformId
shopifyTags
siteId
slug
smsOrder
status
title
updatedAt
}
}
Variables
{"id": uuid}
Response
{
"data": {
"ProductByPk": {
"DynamicBox": DynamicBox,
"ProductVariants": [ProductVariant],
"Site": Site,
"createdAt": timestamptz,
"deletedAt": timestamptz,
"id": uuid,
"imageSrc": "abc123",
"limitOneTimeUpsellQuantity": true,
"metafields": jsonb,
"platformId": "xyz789",
"shopifyTags": jsonb,
"siteId": uuid,
"slug": "xyz789",
"smsOrder": 123,
"status": "abc123",
"title": "abc123",
"updatedAt": timestamptz
}
}
}
ProductVariantByPk
Description
fetch data from the table: "ProductVariant" using primary key columns
Response
Returns a ProductVariant
Arguments
Name | Description |
---|---|
id - uuid!
|
Example
Query
query ProductVariantByPk($id: uuid!) {
ProductVariantByPk(id: $id) {
DynamicBox_SelectableProductVariants {
...DynamicBox_SelectableProductVariantFragment
}
OrderLineItems {
...OrderLineItemFragment
}
Product {
...ProductFragment
}
SellingPlanGroupResources {
...SellingPlanGroupResourceFragment
}
SubscriptionLines {
...SubscriptionLineFragment
}
createdAt
deletedAt
id
image
marketPrices
outOfStockAt
platformId
price
productId
sku
title
updatedAt
}
}
Variables
{"id": uuid}
Response
{
"data": {
"ProductVariantByPk": {
"DynamicBox_SelectableProductVariants": [
DynamicBox_SelectableProductVariant
],
"OrderLineItems": [OrderLineItem],
"Product": Product,
"SellingPlanGroupResources": [
SellingPlanGroupResource
],
"SubscriptionLines": [SubscriptionLine],
"createdAt": timestamptz,
"deletedAt": timestamptz,
"id": uuid,
"image": "xyz789",
"marketPrices": jsonb,
"outOfStockAt": timestamptz,
"platformId": "xyz789",
"price": numeric,
"productId": uuid,
"sku": "abc123",
"title": "xyz789",
"updatedAt": timestamptz
}
}
}
ProductVariants
Description
An array relationship
Response
Returns [ProductVariant!]!
Arguments
Name | Description |
---|---|
distinct_on - [ProductVariant_select_column!]
|
distinct select on columns |
limit - Int
|
limit the number of rows returned |
offset - Int
|
skip the first n rows. Use only with order_by |
order_by - [ProductVariant_order_by!]
|
sort the rows by one or more columns |
where - ProductVariant_bool_exp
|
filter the rows returned |
Example
Query
query ProductVariants(
$distinct_on: [ProductVariant_select_column!],
$limit: Int,
$offset: Int,
$order_by: [ProductVariant_order_by!],
$where: ProductVariant_bool_exp
) {
ProductVariants(
distinct_on: $distinct_on,
limit: $limit,
offset: $offset,
order_by: $order_by,
where: $where
) {
DynamicBox_SelectableProductVariants {
...DynamicBox_SelectableProductVariantFragment
}
OrderLineItems {
...OrderLineItemFragment
}
Product {
...ProductFragment
}
SellingPlanGroupResources {
...SellingPlanGroupResourceFragment
}
SubscriptionLines {
...SubscriptionLineFragment
}
createdAt
deletedAt
id
image
marketPrices
outOfStockAt
platformId
price
productId
sku
title
updatedAt
}
}
Variables
{
"distinct_on": ["createdAt"],
"limit": 123,
"offset": 987,
"order_by": [ProductVariant_order_by],
"where": ProductVariant_bool_exp
}
Response
{
"data": {
"ProductVariants": [
{
"DynamicBox_SelectableProductVariants": [
DynamicBox_SelectableProductVariant
],
"OrderLineItems": [OrderLineItem],
"Product": Product,
"SellingPlanGroupResources": [
SellingPlanGroupResource
],
"SubscriptionLines": [SubscriptionLine],
"createdAt": timestamptz,
"deletedAt": timestamptz,
"id": uuid,
"image": "xyz789",
"marketPrices": jsonb,
"outOfStockAt": timestamptz,
"platformId": "xyz789",
"price": numeric,
"productId": uuid,
"sku": "abc123",
"title": "abc123",
"updatedAt": timestamptz
}
]
}
}
Products
Description
An array relationship
Response
Returns [Product!]!
Arguments
Name | Description |
---|---|
distinct_on - [Product_select_column!]
|
distinct select on columns |
limit - Int
|
limit the number of rows returned |
offset - Int
|
skip the first n rows. Use only with order_by |
order_by - [Product_order_by!]
|
sort the rows by one or more columns |
where - Product_bool_exp
|
filter the rows returned |
Example
Query
query Products(
$distinct_on: [Product_select_column!],
$limit: Int,
$offset: Int,
$order_by: [Product_order_by!],
$where: Product_bool_exp
) {
Products(
distinct_on: $distinct_on,
limit: $limit,
offset: $offset,
order_by: $order_by,
where: $where
) {
DynamicBox {
...DynamicBoxFragment
}
ProductVariants {
...ProductVariantFragment
}
Site {
...SiteFragment
}
createdAt
deletedAt
id
imageSrc
limitOneTimeUpsellQuantity
metafields
platformId
shopifyTags
siteId
slug
smsOrder
status
title
updatedAt
}
}
Variables
{
"distinct_on": ["createdAt"],
"limit": 123,
"offset": 987,
"order_by": [Product_order_by],
"where": Product_bool_exp
}
Response
{
"data": {
"Products": [
{
"DynamicBox": DynamicBox,
"ProductVariants": [ProductVariant],
"Site": Site,
"createdAt": timestamptz,
"deletedAt": timestamptz,
"id": uuid,
"imageSrc": "abc123",
"limitOneTimeUpsellQuantity": false,
"metafields": jsonb,
"platformId": "xyz789",
"shopifyTags": jsonb,
"siteId": uuid,
"slug": "xyz789",
"smsOrder": 987,
"status": "abc123",
"title": "xyz789",
"updatedAt": timestamptz
}
]
}
}
SiteByPk
Description
fetch data from the table: "Site" using primary key columns
Example
Query
query SiteByPk($id: uuid!) {
SiteByPk(id: $id) {
Holidays {
...HolidayFragment
}
Notifications {
...NotificationFragment
}
Products {
...ProductFragment
}
StorefrontUsers {
...StorefrontUserFragment
}
Theme {
...ThemeFragment
}
Theme2 {
...Theme2Fragment
}
ianaTimezone
id
}
}
Variables
{"id": uuid}
Response
{
"data": {
"SiteByPk": {
"Holidays": [Holiday],
"Notifications": [Notification],
"Products": [Product],
"StorefrontUsers": [StorefrontUser],
"Theme": Theme,
"Theme2": Theme2,
"ianaTimezone": "abc123",
"id": uuid
}
}
}
SubscriptionByPk
Description
fetch data from the table: "Subscription" using primary key columns
Response
Returns a Subscription
Arguments
Name | Description |
---|---|
id - uuid!
|
Example
Query
query SubscriptionByPk($id: uuid!) {
SubscriptionByPk(id: $id) {
AuditLogs {
...AuditLogFragment
}
BillingPolicy {
...PolicyFragment
}
CancelFlowSessions {
...CancelFlowSessionFragment
}
CancelFlowV2Sessions {
...CancelFlowV2SessionFragment
}
DeliveryPolicy {
...PolicyFragment
}
Discounts {
...DiscountFragment
}
FulfillmentOrders {
...OrderFragment
}
NotificationLogs {
...NotificationLogFragment
}
PaymentMethod {
...PaymentMethodFragment
}
PrepaidDeliveryPolicy {
...PolicyFragment
}
PrepaidGiftRecipient {
...StorefrontUserFragment
}
PrepaidSubscriptionLines {
...SubscriptionLineFragment
}
ShippingAddress {
...AddressFragment
}
Site {
...SiteFragment
}
StorefrontUser {
...StorefrontUserFragment
}
SubscriptionLines {
...SubscriptionLineFragment
}
SurpriseDelightSessions {
...SurpriseDelightSessionsFragment
}
billingPolicyId
cancelledAt
createdAt
currencyCode
customAttributes
cyclesCompleted
deliveryPolicyId
deliveryPrice
deliveryPriceOverride
id
lastBillingAttemptAt
metadata
migrationIndex
nextBillingDate
note
originOrder {
...OrderFragment
}
originOrderId
platformId
prepaidDeliveryPolicyId
prepaidProductPricesPerDelivery
shippingAddressId
siteId
status
statusContext
storefrontUserId
updatedAt
}
}
Variables
{"id": uuid}
Response
{
"data": {
"SubscriptionByPk": {
"AuditLogs": [AuditLog],
"BillingPolicy": Policy,
"CancelFlowSessions": [CancelFlowSession],
"CancelFlowV2Sessions": [CancelFlowV2Session],
"DeliveryPolicy": Policy,
"Discounts": [Discount],
"FulfillmentOrders": [Order],
"NotificationLogs": [NotificationLog],
"PaymentMethod": PaymentMethod,
"PrepaidDeliveryPolicy": Policy,
"PrepaidGiftRecipient": StorefrontUser,
"PrepaidSubscriptionLines": [SubscriptionLine],
"ShippingAddress": Address,
"Site": Site,
"StorefrontUser": StorefrontUser,
"SubscriptionLines": [SubscriptionLine],
"SurpriseDelightSessions": [
SurpriseDelightSessions
],
"billingPolicyId": uuid,
"cancelledAt": timestamptz,
"createdAt": timestamptz,
"currencyCode": "abc123",
"customAttributes": jsonb,
"cyclesCompleted": 987,
"deliveryPolicyId": uuid,
"deliveryPrice": numeric,
"deliveryPriceOverride": 123,
"id": uuid,
"lastBillingAttemptAt": timestamptz,
"metadata": jsonb,
"migrationIndex": 987,
"nextBillingDate": timestamptz,
"note": "xyz789",
"originOrder": Order,
"originOrderId": uuid,
"platformId": "xyz789",
"prepaidDeliveryPolicyId": uuid,
"prepaidProductPricesPerDelivery": jsonb,
"shippingAddressId": uuid,
"siteId": uuid,
"status": "abc123",
"statusContext": "abc123",
"storefrontUserId": uuid,
"updatedAt": timestamptz
}
}
}
SubscriptionLines
Description
An array relationship
Response
Returns [SubscriptionLine!]!
Arguments
Name | Description |
---|---|
distinct_on - [SubscriptionLine_select_column!]
|
distinct select on columns |
limit - Int
|
limit the number of rows returned |
offset - Int
|
skip the first n rows. Use only with order_by |
order_by - [SubscriptionLine_order_by!]
|
sort the rows by one or more columns |
where - SubscriptionLine_bool_exp
|
filter the rows returned |
Example
Query
query SubscriptionLines(
$distinct_on: [SubscriptionLine_select_column!],
$limit: Int,
$offset: Int,
$order_by: [SubscriptionLine_order_by!],
$where: SubscriptionLine_bool_exp
) {
SubscriptionLines(
distinct_on: $distinct_on,
limit: $limit,
offset: $offset,
order_by: $order_by,
where: $where
) {
Discounts {
...DiscountFragment
}
Group {
...GroupFragment
}
OrderLineItems {
...OrderLineItemFragment
}
OriginalSellingPlan {
...SellingPlanFragment
}
PrepaidSubscription {
...SubscriptionFragment
}
ProductVariant {
...ProductVariantFragment
}
Subscription {
...SubscriptionFragment
}
createdAt
customAttributes
groupId
id
ordersRemaining
platformId
prepaidSubscriptionId
priceWithoutDiscount
productVariantId
quantity
removedAt
sellingPlanId
subscriptionId
taxable
titleOverride
updatedAt
}
}
Variables
{
"distinct_on": ["createdAt"],
"limit": 987,
"offset": 123,
"order_by": [SubscriptionLine_order_by],
"where": SubscriptionLine_bool_exp
}
Response
{
"data": {
"SubscriptionLines": [
{
"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": "abc123",
"prepaidSubscriptionId": uuid,
"priceWithoutDiscount": numeric,
"productVariantId": uuid,
"quantity": 987,
"removedAt": timestamptz,
"sellingPlanId": uuid,
"subscriptionId": uuid,
"taxable": false,
"titleOverride": "abc123",
"updatedAt": timestamptz
}
]
}
}
Subscriptions
Description
An array relationship
Response
Returns [Subscription!]!
Arguments
Name | Description |
---|---|
distinct_on - [Subscription_select_column!]
|
distinct select on columns |
limit - Int
|
limit the number of rows returned |
offset - Int
|
skip the first n rows. Use only with order_by |
order_by - [Subscription_order_by!]
|
sort the rows by one or more columns |
where - Subscription_bool_exp
|
filter the rows returned |
Example
Query
query Subscriptions(
$distinct_on: [Subscription_select_column!],
$limit: Int,
$offset: Int,
$order_by: [Subscription_order_by!],
$where: Subscription_bool_exp
) {
Subscriptions(
distinct_on: $distinct_on,
limit: $limit,
offset: $offset,
order_by: $order_by,
where: $where
) {
AuditLogs {
...AuditLogFragment
}
BillingPolicy {
...PolicyFragment
}
CancelFlowSessions {
...CancelFlowSessionFragment
}
CancelFlowV2Sessions {
...CancelFlowV2SessionFragment
}
DeliveryPolicy {
...PolicyFragment
}
Discounts {
...DiscountFragment
}
FulfillmentOrders {
...OrderFragment
}
NotificationLogs {
...NotificationLogFragment
}
PaymentMethod {
...PaymentMethodFragment
}
PrepaidDeliveryPolicy {
...PolicyFragment
}
PrepaidGiftRecipient {
...StorefrontUserFragment
}
PrepaidSubscriptionLines {
...SubscriptionLineFragment
}
ShippingAddress {
...AddressFragment
}
Site {
...SiteFragment
}
StorefrontUser {
...StorefrontUserFragment
}
SubscriptionLines {
...SubscriptionLineFragment
}
SurpriseDelightSessions {
...SurpriseDelightSessionsFragment
}
billingPolicyId
cancelledAt
createdAt
currencyCode
customAttributes
cyclesCompleted
deliveryPolicyId
deliveryPrice
deliveryPriceOverride
id
lastBillingAttemptAt
metadata
migrationIndex
nextBillingDate
note
originOrder {
...OrderFragment
}
originOrderId
platformId
prepaidDeliveryPolicyId
prepaidProductPricesPerDelivery
shippingAddressId
siteId
status
statusContext
storefrontUserId
updatedAt
}
}
Variables
{
"distinct_on": ["billingPolicyId"],
"limit": 123,
"offset": 987,
"order_by": [Subscription_order_by],
"where": Subscription_bool_exp
}
Response
{
"data": {
"Subscriptions": [
{
"AuditLogs": [AuditLog],
"BillingPolicy": Policy,
"CancelFlowSessions": [CancelFlowSession],
"CancelFlowV2Sessions": [CancelFlowV2Session],
"DeliveryPolicy": Policy,
"Discounts": [Discount],
"FulfillmentOrders": [Order],
"NotificationLogs": [NotificationLog],
"PaymentMethod": PaymentMethod,
"PrepaidDeliveryPolicy": Policy,
"PrepaidGiftRecipient": StorefrontUser,
"PrepaidSubscriptionLines": [SubscriptionLine],
"ShippingAddress": Address,
"Site": Site,
"StorefrontUser": StorefrontUser,
"SubscriptionLines": [SubscriptionLine],
"SurpriseDelightSessions": [
SurpriseDelightSessions
],
"billingPolicyId": uuid,
"cancelledAt": timestamptz,
"createdAt": timestamptz,
"currencyCode": "abc123",
"customAttributes": jsonb,
"cyclesCompleted": 123,
"deliveryPolicyId": uuid,
"deliveryPrice": numeric,
"deliveryPriceOverride": 987,
"id": uuid,
"lastBillingAttemptAt": timestamptz,
"metadata": jsonb,
"migrationIndex": 987,
"nextBillingDate": timestamptz,
"note": "abc123",
"originOrder": Order,
"originOrderId": uuid,
"platformId": "abc123",
"prepaidDeliveryPolicyId": uuid,
"prepaidProductPricesPerDelivery": jsonb,
"shippingAddressId": uuid,
"siteId": uuid,
"status": "xyz789",
"statusContext": "xyz789",
"storefrontUserId": uuid,
"updatedAt": timestamptz
}
]
}
}
SurpriseDelightSessions
Description
An array relationship
Response
Returns [SurpriseDelightSessions!]!
Arguments
Name | Description |
---|---|
distinct_on - [SurpriseDelightSessions_select_column!]
|
distinct select on columns |
limit - Int
|
limit the number of rows returned |
offset - Int
|
skip the first n rows. Use only with order_by |
order_by - [SurpriseDelightSessions_order_by!]
|
sort the rows by one or more columns |
where - SurpriseDelightSessions_bool_exp
|
filter the rows returned |
Example
Query
query SurpriseDelightSessions(
$distinct_on: [SurpriseDelightSessions_select_column!],
$limit: Int,
$offset: Int,
$order_by: [SurpriseDelightSessions_order_by!],
$where: SurpriseDelightSessions_bool_exp
) {
SurpriseDelightSessions(
distinct_on: $distinct_on,
limit: $limit,
offset: $offset,
order_by: $order_by,
where: $where
) {
Subscription {
...SubscriptionFragment
}
created_at
group
id
ruleId
subscriptionId
}
}
Variables
{
"distinct_on": ["created_at"],
"limit": 987,
"offset": 987,
"order_by": [SurpriseDelightSessions_order_by],
"where": SurpriseDelightSessions_bool_exp
}
Response
{
"data": {
"SurpriseDelightSessions": [
{
"Subscription": Subscription,
"created_at": timestamptz,
"group": "abc123",
"id": uuid,
"ruleId": uuid,
"subscriptionId": uuid
}
]
}
}
Mutations
addSubscriptionLine
Description
Adds a product to a subscription, with the option of adding it as a one time item (only valid for the next order). The price is optional, by default it will use the price from Shopify with the closest matching selling plan discount. This doesn't support prepaid subscriptions.
Response
Returns an AddSubscriptionLineOutput
Arguments
Name | Description |
---|---|
input - AddSubscriptionLineInput!
|
Example
Query
mutation addSubscriptionLine($input: AddSubscriptionLineInput!) {
addSubscriptionLine(input: $input) {
ok
}
}
Variables
{"input": AddSubscriptionLineInput}
Response
{"data": {"addSubscriptionLine": {"ok": true}}}
applyDiscountCode
Description
Apply a discount code on a subscription
Response
Returns an ApplyDiscountCodeOutput
Arguments
Name | Description |
---|---|
input - ApplyDiscountCodeInput!
|
Example
Query
mutation applyDiscountCode($input: ApplyDiscountCodeInput!) {
applyDiscountCode(input: $input) {
message
ok
}
}
Variables
{"input": ApplyDiscountCodeInput}
Response
{
"data": {
"applyDiscountCode": {
"message": "abc123",
"ok": false
}
}
}
cancelSubscription
Description
Cancels a specific subscription and associated SubscriptionContract on Shopify. If the subscription is a prepaid subscription, then first calculate remaining shipments and set maxcycles such that subscription will be killed once remaining shipments are processed.
Response
Returns a CancelSubscriptionOutput
Arguments
Name | Description |
---|---|
input - CancelSubscriptionInput!
|
Example
Query
mutation cancelSubscription($input: CancelSubscriptionInput!) {
cancelSubscription(input: $input) {
ok
}
}
Variables
{"input": CancelSubscriptionInput}
Response
{"data": {"cancelSubscription": {"ok": false}}}
pauseSubscription
Description
Pause a subscription
Response
Returns a pauseSubscriptionOutput
Arguments
Name | Description |
---|---|
input - pauseSubscriptionInput!
|
Example
Query
mutation pauseSubscription($input: pauseSubscriptionInput!) {
pauseSubscription(input: $input) {
message
ok
}
}
Variables
{"input": pauseSubscriptionInput}
Response
{
"data": {
"pauseSubscription": {
"message": "abc123",
"ok": true
}
}
}
shipNow
Description
Creates a subscription order immediately
Response
Returns a ShipNowOutput
Arguments
Name | Description |
---|---|
input - ShipNowInput!
|
Example
Query
mutation shipNow($input: ShipNowInput!) {
shipNow(input: $input) {
message
ok
}
}
Variables
{"input": ShipNowInput}
Response
{
"data": {
"shipNow": {
"message": "xyz789",
"ok": false
}
}
}
subscriptionEditInterval
Response
Returns a SubscriptionEditIntervalOutput
Arguments
Name | Description |
---|---|
input - SubscriptionEditIntervalInput!
|
Example
Query
mutation subscriptionEditInterval($input: SubscriptionEditIntervalInput!) {
subscriptionEditInterval(input: $input) {
subscriptionId
}
}
Variables
{"input": SubscriptionEditIntervalInput}
Response
{
"data": {
"subscriptionEditInterval": {"subscriptionId": uuid}
}
}
swapSubscriptionProductVariants
Description
Swap product variants for a subscription.
Response
Returns a SwapSubscriptionProductVariantsOutput
Arguments
Name | Description |
---|---|
input - SwapSubscriptionProductVariantsInput!
|
Example
Query
mutation swapSubscriptionProductVariants($input: SwapSubscriptionProductVariantsInput!) {
swapSubscriptionProductVariants(input: $input) {
ok
}
}
Variables
{"input": SwapSubscriptionProductVariantsInput}
Response
{"data": {"swapSubscriptionProductVariants": {"ok": true}}}
unpauseSubscription
Description
UnpauseSubscription
Response
Returns an unpauseSubscriptionOutput
Arguments
Name | Description |
---|---|
input - unpauseSubscriptionInput!
|
Example
Query
mutation unpauseSubscription($input: unpauseSubscriptionInput!) {
unpauseSubscription(input: $input) {
message
ok
}
}
Variables
{"input": unpauseSubscriptionInput}
Response
{
"data": {
"unpauseSubscription": {
"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
Arguments
Name | Description |
---|---|
input - UpdateNextBillingDateInput!
|
Example
Query
mutation updateNextBillingDate($input: UpdateNextBillingDateInput!) {
updateNextBillingDate(input: $input) {
message
ok
}
}
Variables
{"input": UpdateNextBillingDateInput}
Response
{
"data": {
"updateNextBillingDate": {
"message": "xyz789",
"ok": true
}
}
}
updateSiteByPk
Description
update single row of the table: "Site"
Response
Returns a Site
Arguments
Name | Description |
---|---|
_set - Site_set_input
|
sets the columns of the filtered rows to the given values |
pk_columns - Site_pk_columns_input!
|
Example
Query
mutation updateSiteByPk(
$_set: Site_set_input,
$pk_columns: Site_pk_columns_input!
) {
updateSiteByPk(
_set: $_set,
pk_columns: $pk_columns
) {
Holidays {
...HolidayFragment
}
Notifications {
...NotificationFragment
}
Products {
...ProductFragment
}
StorefrontUsers {
...StorefrontUserFragment
}
Theme {
...ThemeFragment
}
Theme2 {
...Theme2Fragment
}
ianaTimezone
id
}
}
Variables
{
"_set": Site_set_input,
"pk_columns": Site_pk_columns_input
}
Response
{
"data": {
"updateSiteByPk": {
"Holidays": [Holiday],
"Notifications": [Notification],
"Products": [Product],
"StorefrontUsers": [StorefrontUser],
"Theme": Theme,
"Theme2": Theme2,
"ianaTimezone": "xyz789",
"id": uuid
}
}
}
updateSubscriptionLine
Description
Updates the subscription line (referenced by either a prepaidSubscriptionLineId or a subscriptionLineId) and changes quantity, price, or productVariant. IDs are Skio IDs. Quantity, price, and productVariant are optional, so only provide values for those you want to change.
Response
Returns an UpdateSubscriptionLineOutput
Arguments
Name | Description |
---|---|
input - UpdateSubscriptionLineInput!
|
Example
Query
mutation updateSubscriptionLine($input: UpdateSubscriptionLineInput!) {
updateSubscriptionLine(input: $input) {
ok
}
}
Variables
{"input": UpdateSubscriptionLineInput}
Response
{"data": {"updateSubscriptionLine": {"ok": false}}}
updateSubscriptionNote
Description
updates a subscriptions note
Response
Returns an UpdateSubscriptionNoteOutput
Arguments
Name | Description |
---|---|
input - UpdateSubscriptionNoteInput!
|
Example
Query
mutation updateSubscriptionNote($input: UpdateSubscriptionNoteInput!) {
updateSubscriptionNote(input: $input) {
note
ok
}
}
Variables
{"input": UpdateSubscriptionNoteInput}
Response
{
"data": {
"updateSubscriptionNote": {
"note": "xyz789",
"ok": true
}
}
}
updateSubscriptionShippingAddress
Description
updates a subscriptions shipping address
Response
Returns an UpdateSubscriptionShippingAddressOutput
Arguments
Name | Description |
---|---|
input - UpdateSubscriptionShippingAddressInput!
|
Example
Query
mutation updateSubscriptionShippingAddress($input: UpdateSubscriptionShippingAddressInput!) {
updateSubscriptionShippingAddress(input: $input) {
message
ok
}
}
Variables
{"input": UpdateSubscriptionShippingAddressInput}
Response
{
"data": {
"updateSubscriptionShippingAddress": {
"message": "xyz789",
"ok": false
}
}
}
Types
AddSubscriptionLineInput
AddSubscriptionLineOutput
Fields
Field Name | Description |
---|---|
ok - Boolean!
|
Example
{"ok": true}
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": "abc123",
"address2": "abc123",
"city": "abc123",
"company": "xyz789",
"country": "xyz789",
"createdAt": timestamptz,
"doorCode": "xyz789",
"firstName": "xyz789",
"id": uuid,
"lastName": "xyz789",
"phoneNumber": "xyz789",
"platformId": "abc123",
"province": "abc123",
"storefrontUserId": uuid,
"updatedAt": timestamptz,
"zip": "abc123"
}
Address_aggregate_order_by
Description
order by aggregate values of table "Address"
Fields
Input Field | Description |
---|---|
count - order_by
|
|
max - Address_max_order_by
|
|
min - Address_min_order_by
|
Example
{
"count": "asc",
"max": Address_max_order_by,
"min": Address_min_order_by
}
Address_bool_exp
Description
Boolean expression to filter rows from the table "Address". All fields are combined with a logical 'AND'.
Fields
Input Field | Description |
---|---|
PaymentMethod - PaymentMethod_bool_exp
|
|
StorefrontUser - StorefrontUser_bool_exp
|
|
Subscriptions - Subscription_bool_exp
|
|
_and - [Address_bool_exp!]
|
|
_not - Address_bool_exp
|
|
_or - [Address_bool_exp!]
|
|
address1 - String_comparison_exp
|
|
address2 - String_comparison_exp
|
|
city - String_comparison_exp
|
|
company - String_comparison_exp
|
|
country - String_comparison_exp
|
|
createdAt - timestamptz_comparison_exp
|
|
doorCode - String_comparison_exp
|
|
firstName - String_comparison_exp
|
|
id - uuid_comparison_exp
|
|
lastName - String_comparison_exp
|
|
phoneNumber - String_comparison_exp
|
|
platformId - String_comparison_exp
|
|
province - String_comparison_exp
|
|
storefrontUserId - uuid_comparison_exp
|
|
updatedAt - timestamptz_comparison_exp
|
|
zip - String_comparison_exp
|
Example
{
"PaymentMethod": PaymentMethod_bool_exp,
"StorefrontUser": StorefrontUser_bool_exp,
"Subscriptions": Subscription_bool_exp,
"_and": [Address_bool_exp],
"_not": Address_bool_exp,
"_or": [Address_bool_exp],
"address1": String_comparison_exp,
"address2": String_comparison_exp,
"city": String_comparison_exp,
"company": String_comparison_exp,
"country": String_comparison_exp,
"createdAt": timestamptz_comparison_exp,
"doorCode": String_comparison_exp,
"firstName": String_comparison_exp,
"id": uuid_comparison_exp,
"lastName": String_comparison_exp,
"phoneNumber": String_comparison_exp,
"platformId": String_comparison_exp,
"province": String_comparison_exp,
"storefrontUserId": uuid_comparison_exp,
"updatedAt": timestamptz_comparison_exp,
"zip": String_comparison_exp
}
Address_max_order_by
Description
order by max() on columns of table "Address"
Fields
Input Field | Description |
---|---|
address1 - order_by
|
|
address2 - order_by
|
|
city - order_by
|
|
company - order_by
|
|
country - order_by
|
|
createdAt - order_by
|
|
doorCode - order_by
|
|
firstName - order_by
|
|
id - order_by
|
|
lastName - order_by
|
|
phoneNumber - order_by
|
|
platformId - order_by
|
|
province - order_by
|
|
storefrontUserId - order_by
|
|
updatedAt - order_by
|
|
zip - order_by
|
Example
{
"address1": "asc",
"address2": "asc",
"city": "asc",
"company": "asc",
"country": "asc",
"createdAt": "asc",
"doorCode": "asc",
"firstName": "asc",
"id": "asc",
"lastName": "asc",
"phoneNumber": "asc",
"platformId": "asc",
"province": "asc",
"storefrontUserId": "asc",
"updatedAt": "asc",
"zip": "asc"
}
Address_min_order_by
Description
order by min() on columns of table "Address"
Fields
Input Field | Description |
---|---|
address1 - order_by
|
|
address2 - order_by
|
|
city - order_by
|
|
company - order_by
|
|
country - order_by
|
|
createdAt - order_by
|
|
doorCode - order_by
|
|
firstName - order_by
|
|
id - order_by
|
|
lastName - order_by
|
|
phoneNumber - order_by
|
|
platformId - order_by
|
|
province - order_by
|
|
storefrontUserId - order_by
|
|
updatedAt - order_by
|
|
zip - order_by
|
Example
{
"address1": "asc",
"address2": "asc",
"city": "asc",
"company": "asc",
"country": "asc",
"createdAt": "asc",
"doorCode": "asc",
"firstName": "asc",
"id": "asc",
"lastName": "asc",
"phoneNumber": "asc",
"platformId": "asc",
"province": "asc",
"storefrontUserId": "asc",
"updatedAt": "asc",
"zip": "asc"
}
Address_order_by
Description
Ordering options when selecting data from "Address".
Fields
Input Field | Description |
---|---|
PaymentMethod - PaymentMethod_order_by
|
|
StorefrontUser - StorefrontUser_order_by
|
|
Subscriptions_aggregate - Subscription_aggregate_order_by
|
|
address1 - order_by
|
|
address2 - order_by
|
|
city - order_by
|
|
company - order_by
|
|
country - order_by
|
|
createdAt - order_by
|
|
doorCode - order_by
|
|
firstName - order_by
|
|
id - order_by
|
|
lastName - order_by
|
|
phoneNumber - order_by
|
|
platformId - order_by
|
|
province - order_by
|
|
storefrontUserId - order_by
|
|
updatedAt - order_by
|
|
zip - order_by
|
Example
{
"PaymentMethod": PaymentMethod_order_by,
"StorefrontUser": StorefrontUser_order_by,
"Subscriptions_aggregate": Subscription_aggregate_order_by,
"address1": "asc",
"address2": "asc",
"city": "asc",
"company": "asc",
"country": "asc",
"createdAt": "asc",
"doorCode": "asc",
"firstName": "asc",
"id": "asc",
"lastName": "asc",
"phoneNumber": "asc",
"platformId": "asc",
"province": "asc",
"storefrontUserId": "asc",
"updatedAt": "asc",
"zip": "asc"
}
Address_select_column
Description
select columns of table "Address"
Values
Enum Value | Description |
---|---|
|
column name |
|
column name |
|
column name |
|
column name |
|
column name |
|
column name |
|
column name |
|
column name |
|
column name |
|
column name |
|
column name |
|
column name |
|
column name |
|
column name |
|
column name |
|
column name |
Example
"address1"
Anchor
Description
storefront user select/insert/update kinda funny. select is for seeing all anchor types (I think?!) and insert/update for modifying date
Example
{
"Policy": Policy,
"createdAt": timestamptz,
"cutoffDay": 123,
"day": 123,
"id": uuid,
"missedAnchorAllowance": 987,
"month": 987,
"policyId": uuid,
"strictness": "xyz789",
"type": "xyz789",
"updatedAt": timestamptz
}
Anchor_aggregate_order_by
Description
order by aggregate values of table "Anchor"
Fields
Input Field | Description |
---|---|
avg - Anchor_avg_order_by
|
|
count - order_by
|
|
max - Anchor_max_order_by
|
|
min - Anchor_min_order_by
|
|
stddev - Anchor_stddev_order_by
|
|
stddev_pop - Anchor_stddev_pop_order_by
|
|
stddev_samp - Anchor_stddev_samp_order_by
|
|
sum - Anchor_sum_order_by
|
|
var_pop - Anchor_var_pop_order_by
|
|
var_samp - Anchor_var_samp_order_by
|
|
variance - Anchor_variance_order_by
|
Example
{
"avg": Anchor_avg_order_by,
"count": "asc",
"max": Anchor_max_order_by,
"min": Anchor_min_order_by,
"stddev": Anchor_stddev_order_by,
"stddev_pop": Anchor_stddev_pop_order_by,
"stddev_samp": Anchor_stddev_samp_order_by,
"sum": Anchor_sum_order_by,
"var_pop": Anchor_var_pop_order_by,
"var_samp": Anchor_var_samp_order_by,
"variance": Anchor_variance_order_by
}
Anchor_avg_order_by
Anchor_bool_exp
Description
Boolean expression to filter rows from the table "Anchor". All fields are combined with a logical 'AND'.
Fields
Input Field | Description |
---|---|
Policy - Policy_bool_exp
|
|
_and - [Anchor_bool_exp!]
|
|
_not - Anchor_bool_exp
|
|
_or - [Anchor_bool_exp!]
|
|
createdAt - timestamptz_comparison_exp
|
|
cutoffDay - Int_comparison_exp
|
|
day - Int_comparison_exp
|
|
id - uuid_comparison_exp
|
|
missedAnchorAllowance - Int_comparison_exp
|
|
month - Int_comparison_exp
|
|
policyId - uuid_comparison_exp
|
|
strictness - String_comparison_exp
|
|
type - String_comparison_exp
|
|
updatedAt - timestamptz_comparison_exp
|
Example
{
"Policy": Policy_bool_exp,
"_and": [Anchor_bool_exp],
"_not": Anchor_bool_exp,
"_or": [Anchor_bool_exp],
"createdAt": timestamptz_comparison_exp,
"cutoffDay": Int_comparison_exp,
"day": Int_comparison_exp,
"id": uuid_comparison_exp,
"missedAnchorAllowance": Int_comparison_exp,
"month": Int_comparison_exp,
"policyId": uuid_comparison_exp,
"strictness": String_comparison_exp,
"type": String_comparison_exp,
"updatedAt": timestamptz_comparison_exp
}
Anchor_max_order_by
Description
order by max() on columns of table "Anchor"
Example
{
"createdAt": "asc",
"cutoffDay": "asc",
"day": "asc",
"id": "asc",
"missedAnchorAllowance": "asc",
"month": "asc",
"policyId": "asc",
"strictness": "asc",
"type": "asc",
"updatedAt": "asc"
}
Anchor_min_order_by
Description
order by min() on columns of table "Anchor"
Example
{
"createdAt": "asc",
"cutoffDay": "asc",
"day": "asc",
"id": "asc",
"missedAnchorAllowance": "asc",
"month": "asc",
"policyId": "asc",
"strictness": "asc",
"type": "asc",
"updatedAt": "asc"
}
Anchor_stddev_order_by
Anchor_stddev_pop_order_by
Anchor_stddev_samp_order_by
Anchor_sum_order_by
Anchor_var_pop_order_by
Anchor_var_samp_order_by
Anchor_variance_order_by
ApplyDiscountCodeInput
ApplyDiscountCodeOutput
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
}
AuditLog_aggregate_order_by
Description
order by aggregate values of table "AuditLog"
Fields
Input Field | Description |
---|---|
count - order_by
|
|
max - AuditLog_max_order_by
|
|
min - AuditLog_min_order_by
|
Example
{
"count": "asc",
"max": AuditLog_max_order_by,
"min": AuditLog_min_order_by
}
AuditLog_bool_exp
Description
Boolean expression to filter rows from the table "AuditLog". All fields are combined with a logical 'AND'.
Fields
Input Field | Description |
---|---|
StorefrontUser - StorefrontUser_bool_exp
|
|
Subscription - Subscription_bool_exp
|
|
_and - [AuditLog_bool_exp!]
|
|
_not - AuditLog_bool_exp
|
|
_or - [AuditLog_bool_exp!]
|
|
createdAt - timestamptz_comparison_exp
|
|
eventData - jsonb_comparison_exp
|
|
eventType - String_comparison_exp
|
|
id - uuid_comparison_exp
|
|
storefrontUserId - uuid_comparison_exp
|
|
subscriptionId - uuid_comparison_exp
|
|
updatedAt - timestamptz_comparison_exp
|
Example
{
"StorefrontUser": StorefrontUser_bool_exp,
"Subscription": Subscription_bool_exp,
"_and": [AuditLog_bool_exp],
"_not": AuditLog_bool_exp,
"_or": [AuditLog_bool_exp],
"createdAt": timestamptz_comparison_exp,
"eventData": jsonb_comparison_exp,
"eventType": String_comparison_exp,
"id": uuid_comparison_exp,
"storefrontUserId": uuid_comparison_exp,
"subscriptionId": uuid_comparison_exp,
"updatedAt": timestamptz_comparison_exp
}
AuditLog_max_order_by
Description
order by max() on columns of table "AuditLog"
Example
{
"createdAt": "asc",
"eventType": "asc",
"id": "asc",
"storefrontUserId": "asc",
"subscriptionId": "asc",
"updatedAt": "asc"
}
AuditLog_min_order_by
Description
order by min() on columns of table "AuditLog"
Example
{
"createdAt": "asc",
"eventType": "asc",
"id": "asc",
"storefrontUserId": "asc",
"subscriptionId": "asc",
"updatedAt": "asc"
}
BillingAttempt_bool_exp
Description
Boolean expression to filter rows from the table "BillingAttempt". All fields are combined with a logical 'AND'.
Fields
Input Field | Description |
---|---|
Order - Order_bool_exp
|
|
Subscription - Subscription_bool_exp
|
|
_and - [BillingAttempt_bool_exp!]
|
|
_not - BillingAttempt_bool_exp
|
|
_or - [BillingAttempt_bool_exp!]
|
|
billingAttemptedAt - timestamptz_comparison_exp
|
|
createdAt - timestamptz_comparison_exp
|
|
errorCode - String_comparison_exp
|
|
errorMessage - String_comparison_exp
|
|
id - uuid_comparison_exp
|
|
orderId - uuid_comparison_exp
|
|
orderPlatformId - String_comparison_exp
|
|
platformId - String_comparison_exp
|
|
subscriptionBillingDate - timestamptz_comparison_exp
|
|
subscriptionId - uuid_comparison_exp
|
|
updatedAt - timestamptz_comparison_exp
|
Example
{
"Order": Order_bool_exp,
"Subscription": Subscription_bool_exp,
"_and": [BillingAttempt_bool_exp],
"_not": BillingAttempt_bool_exp,
"_or": [BillingAttempt_bool_exp],
"billingAttemptedAt": timestamptz_comparison_exp,
"createdAt": timestamptz_comparison_exp,
"errorCode": String_comparison_exp,
"errorMessage": String_comparison_exp,
"id": uuid_comparison_exp,
"orderId": uuid_comparison_exp,
"orderPlatformId": String_comparison_exp,
"platformId": String_comparison_exp,
"subscriptionBillingDate": timestamptz_comparison_exp,
"subscriptionId": uuid_comparison_exp,
"updatedAt": timestamptz_comparison_exp
}
Boolean
Boolean_comparison_exp
Description
Boolean expression to compare columns of type "Boolean". All fields are combined with logical 'AND'.
Fields
Input Field | Description |
---|---|
_eq - Boolean
|
|
_gt - Boolean
|
|
_gte - Boolean
|
|
_in - [Boolean!]
|
|
_is_null - Boolean
|
|
_lt - Boolean
|
|
_lte - Boolean
|
|
_neq - Boolean
|
|
_nin - [Boolean!]
|
Example
{
"_eq": false,
"_gt": false,
"_gte": false,
"_in": [true],
"_is_null": true,
"_lt": true,
"_lte": false,
"_neq": false,
"_nin": [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": "xyz789",
"reason": "abc123",
"rebuttal": "abc123",
"updatedAt": timestamptz
}
CancelFlowReason_bool_exp
Description
Boolean expression to filter rows from the table "CancelFlowReason". All fields are combined with a logical 'AND'.
Fields
Input Field | Description |
---|---|
CancelFlowSession - CancelFlowSession_bool_exp
|
|
_and - [CancelFlowReason_bool_exp!]
|
|
_not - CancelFlowReason_bool_exp
|
|
_or - [CancelFlowReason_bool_exp!]
|
|
cancelFlowId - uuid_comparison_exp
|
|
cancelFlowSessionId - uuid_comparison_exp
|
|
createdAt - timestamptz_comparison_exp
|
|
id - uuid_comparison_exp
|
|
order - numeric_comparison_exp
|
|
otherReasonBody - String_comparison_exp
|
|
reason - String_comparison_exp
|
|
rebuttal - String_comparison_exp
|
|
updatedAt - timestamptz_comparison_exp
|
Example
{
"CancelFlowSession": CancelFlowSession_bool_exp,
"_and": [CancelFlowReason_bool_exp],
"_not": CancelFlowReason_bool_exp,
"_or": [CancelFlowReason_bool_exp],
"cancelFlowId": uuid_comparison_exp,
"cancelFlowSessionId": uuid_comparison_exp,
"createdAt": timestamptz_comparison_exp,
"id": uuid_comparison_exp,
"order": numeric_comparison_exp,
"otherReasonBody": String_comparison_exp,
"reason": String_comparison_exp,
"rebuttal": String_comparison_exp,
"updatedAt": timestamptz_comparison_exp
}
CancelFlowReason_order_by
Description
Ordering options when selecting data from "CancelFlowReason".
Example
{
"CancelFlowSession": CancelFlowSession_order_by,
"cancelFlowId": "asc",
"cancelFlowSessionId": "asc",
"createdAt": "asc",
"id": "asc",
"order": "asc",
"otherReasonBody": "asc",
"reason": "asc",
"rebuttal": "asc",
"updatedAt": "asc"
}
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": "abc123",
"subscriptionId": uuid,
"updatedAt": timestamptz
}
CancelFlowSession_aggregate_order_by
Description
order by aggregate values of table "CancelFlowSession"
Fields
Input Field | Description |
---|---|
count - order_by
|
|
max - CancelFlowSession_max_order_by
|
|
min - CancelFlowSession_min_order_by
|
Example
{
"count": "asc",
"max": CancelFlowSession_max_order_by,
"min": CancelFlowSession_min_order_by
}
CancelFlowSession_bool_exp
Description
Boolean expression to filter rows from the table "CancelFlowSession". All fields are combined with a logical 'AND'.
Fields
Input Field | Description |
---|---|
CancelFlowReason - CancelFlowReason_bool_exp
|
|
Discounts - Discount_bool_exp
|
|
Subscription - Subscription_bool_exp
|
|
_and - [CancelFlowSession_bool_exp!]
|
|
_not - CancelFlowSession_bool_exp
|
|
_or - [CancelFlowSession_bool_exp!]
|
|
cancelFlowId - uuid_comparison_exp
|
|
createdAt - timestamptz_comparison_exp
|
|
id - uuid_comparison_exp
|
|
status - String_comparison_exp
|
|
subscriptionId - uuid_comparison_exp
|
|
updatedAt - timestamptz_comparison_exp
|
Example
{
"CancelFlowReason": CancelFlowReason_bool_exp,
"Discounts": Discount_bool_exp,
"Subscription": Subscription_bool_exp,
"_and": [CancelFlowSession_bool_exp],
"_not": CancelFlowSession_bool_exp,
"_or": [CancelFlowSession_bool_exp],
"cancelFlowId": uuid_comparison_exp,
"createdAt": timestamptz_comparison_exp,
"id": uuid_comparison_exp,
"status": String_comparison_exp,
"subscriptionId": uuid_comparison_exp,
"updatedAt": timestamptz_comparison_exp
}
CancelFlowSession_max_order_by
Description
order by max() on columns of table "CancelFlowSession"
Example
{
"cancelFlowId": "asc",
"createdAt": "asc",
"id": "asc",
"status": "asc",
"subscriptionId": "asc",
"updatedAt": "asc"
}
CancelFlowSession_min_order_by
Description
order by min() on columns of table "CancelFlowSession"
Example
{
"cancelFlowId": "asc",
"createdAt": "asc",
"id": "asc",
"status": "asc",
"subscriptionId": "asc",
"updatedAt": "asc"
}
CancelFlowSession_order_by
Description
Ordering options when selecting data from "CancelFlowSession".
Fields
Input Field | Description |
---|---|
CancelFlowReason - CancelFlowReason_order_by
|
|
Discounts_aggregate - Discount_aggregate_order_by
|
|
Subscription - Subscription_order_by
|
|
cancelFlowId - order_by
|
|
createdAt - order_by
|
|
id - order_by
|
|
status - order_by
|
|
subscriptionId - order_by
|
|
updatedAt - order_by
|
Example
{
"CancelFlowReason": CancelFlowReason_order_by,
"Discounts_aggregate": Discount_aggregate_order_by,
"Subscription": Subscription_order_by,
"cancelFlowId": "asc",
"createdAt": "asc",
"id": "asc",
"status": "asc",
"subscriptionId": "asc",
"updatedAt": "asc"
}
CancelFlowV2Reason
Description
columns and relationships of "CancelFlowV2Reason"
Fields
Field Name | Description |
---|---|
CancelFlowV2Rebuttals - [CancelFlowV2Rebuttal!]!
|
An array relationship |
cancelFlowId - uuid!
|
|
created_at - timestamptz!
|
|
enabled - Boolean!
|
|
id - uuid!
|
|
isMultipleActions - Boolean!
|
|
reason - String!
|
|
updated_at - timestamptz!
|
Example
{
"CancelFlowV2Rebuttals": [CancelFlowV2Rebuttal],
"cancelFlowId": uuid,
"created_at": timestamptz,
"enabled": true,
"id": uuid,
"isMultipleActions": false,
"reason": "abc123",
"updated_at": timestamptz
}
CancelFlowV2Reason_bool_exp
Description
Boolean expression to filter rows from the table "CancelFlowV2Reason". All fields are combined with a logical 'AND'.
Fields
Input Field | Description |
---|---|
CancelFlowV2Rebuttals - CancelFlowV2Rebuttal_bool_exp
|
|
_and - [CancelFlowV2Reason_bool_exp!]
|
|
_not - CancelFlowV2Reason_bool_exp
|
|
_or - [CancelFlowV2Reason_bool_exp!]
|
|
cancelFlowId - uuid_comparison_exp
|
|
created_at - timestamptz_comparison_exp
|
|
enabled - Boolean_comparison_exp
|
|
id - uuid_comparison_exp
|
|
isMultipleActions - Boolean_comparison_exp
|
|
reason - String_comparison_exp
|
|
updated_at - timestamptz_comparison_exp
|
Example
{
"CancelFlowV2Rebuttals": CancelFlowV2Rebuttal_bool_exp,
"_and": [CancelFlowV2Reason_bool_exp],
"_not": CancelFlowV2Reason_bool_exp,
"_or": [CancelFlowV2Reason_bool_exp],
"cancelFlowId": uuid_comparison_exp,
"created_at": timestamptz_comparison_exp,
"enabled": Boolean_comparison_exp,
"id": uuid_comparison_exp,
"isMultipleActions": Boolean_comparison_exp,
"reason": String_comparison_exp,
"updated_at": timestamptz_comparison_exp
}
CancelFlowV2Rebuttal
Description
columns and relationships of "CancelFlowV2Rebuttal"
Fields
Field Name | Description |
---|---|
CancelFlowV2Reason - CancelFlowV2Reason!
|
An object relationship |
action - String!
|
|
actions - jsonb
|
|
cancelFlowReasonId - uuid!
|
|
condition - jsonb
|
|
created_at - timestamptz!
|
|
enabled - Boolean!
|
|
id - uuid!
|
|
isRebuttalURL - Boolean!
|
|
options - jsonb
|
|
rebuttal - String!
|
|
rebuttalMediaUrl - String
|
|
updated_at - timestamptz!
|
Example
{
"CancelFlowV2Reason": CancelFlowV2Reason,
"action": "abc123",
"actions": jsonb,
"cancelFlowReasonId": uuid,
"condition": jsonb,
"created_at": timestamptz,
"enabled": true,
"id": uuid,
"isRebuttalURL": true,
"options": jsonb,
"rebuttal": "abc123",
"rebuttalMediaUrl": "xyz789",
"updated_at": timestamptz
}
CancelFlowV2Rebuttal_bool_exp
Description
Boolean expression to filter rows from the table "CancelFlowV2Rebuttal". All fields are combined with a logical 'AND'.
Fields
Input Field | Description |
---|---|
CancelFlowV2Reason - CancelFlowV2Reason_bool_exp
|
|
_and - [CancelFlowV2Rebuttal_bool_exp!]
|
|
_not - CancelFlowV2Rebuttal_bool_exp
|
|
_or - [CancelFlowV2Rebuttal_bool_exp!]
|
|
action - String_comparison_exp
|
|
actions - jsonb_comparison_exp
|
|
cancelFlowReasonId - uuid_comparison_exp
|
|
condition - jsonb_comparison_exp
|
|
created_at - timestamptz_comparison_exp
|
|
enabled - Boolean_comparison_exp
|
|
id - uuid_comparison_exp
|
|
isRebuttalURL - Boolean_comparison_exp
|
|
options - jsonb_comparison_exp
|
|
rebuttal - String_comparison_exp
|
|
rebuttalMediaUrl - String_comparison_exp
|
|
updated_at - timestamptz_comparison_exp
|
Example
{
"CancelFlowV2Reason": CancelFlowV2Reason_bool_exp,
"_and": [CancelFlowV2Rebuttal_bool_exp],
"_not": CancelFlowV2Rebuttal_bool_exp,
"_or": [CancelFlowV2Rebuttal_bool_exp],
"action": String_comparison_exp,
"actions": jsonb_comparison_exp,
"cancelFlowReasonId": uuid_comparison_exp,
"condition": jsonb_comparison_exp,
"created_at": timestamptz_comparison_exp,
"enabled": Boolean_comparison_exp,
"id": uuid_comparison_exp,
"isRebuttalURL": Boolean_comparison_exp,
"options": jsonb_comparison_exp,
"rebuttal": String_comparison_exp,
"rebuttalMediaUrl": String_comparison_exp,
"updated_at": timestamptz_comparison_exp
}
CancelFlowV2Session
Description
columns and relationships of "CancelFlowV2Session"
Fields
Field Name | Description |
---|---|
CancelFlowSession - CancelFlowSession
|
An object relationship |
Site - Site
|
An object relationship |
Subscription - Subscription!
|
An object relationship |
action - String
|
|
actions - jsonb
|
|
cancelFlowId - uuid!
|
|
conditions - jsonb
|
|
created_at - timestamptz!
|
|
id - uuid!
|
|
isMultipleActions - Boolean!
|
|
isOtherReason - Boolean!
|
|
reason - String
|
|
rebuttal - String
|
|
rebuttalOptions - jsonb
|
|
shownActions - jsonb
|
|
shownReasons - jsonb
|
|
shownRebuttals - jsonb
|
|
siteId - uuid
|
|
status - String
|
|
subscriptionId - uuid!
|
|
updated_at - timestamptz!
|
Example
{
"CancelFlowSession": CancelFlowSession,
"Site": Site,
"Subscription": Subscription,
"action": "abc123",
"actions": jsonb,
"cancelFlowId": uuid,
"conditions": jsonb,
"created_at": timestamptz,
"id": uuid,
"isMultipleActions": true,
"isOtherReason": false,
"reason": "abc123",
"rebuttal": "abc123",
"rebuttalOptions": jsonb,
"shownActions": jsonb,
"shownReasons": jsonb,
"shownRebuttals": jsonb,
"siteId": uuid,
"status": "abc123",
"subscriptionId": uuid,
"updated_at": timestamptz
}
CancelFlowV2Session_aggregate_order_by
Description
order by aggregate values of table "CancelFlowV2Session"
Fields
Input Field | Description |
---|---|
count - order_by
|
|
max - CancelFlowV2Session_max_order_by
|
|
min - CancelFlowV2Session_min_order_by
|
Example
{
"count": "asc",
"max": CancelFlowV2Session_max_order_by,
"min": CancelFlowV2Session_min_order_by
}
CancelFlowV2Session_bool_exp
Description
Boolean expression to filter rows from the table "CancelFlowV2Session". All fields are combined with a logical 'AND'.
Fields
Input Field | Description |
---|---|
CancelFlowSession - CancelFlowSession_bool_exp
|
|
Site - Site_bool_exp
|
|
Subscription - Subscription_bool_exp
|
|
_and - [CancelFlowV2Session_bool_exp!]
|
|
_not - CancelFlowV2Session_bool_exp
|
|
_or - [CancelFlowV2Session_bool_exp!]
|
|
action - String_comparison_exp
|
|
actions - jsonb_comparison_exp
|
|
cancelFlowId - uuid_comparison_exp
|
|
conditions - jsonb_comparison_exp
|
|
created_at - timestamptz_comparison_exp
|
|
id - uuid_comparison_exp
|
|
isMultipleActions - Boolean_comparison_exp
|
|
isOtherReason - Boolean_comparison_exp
|
|
reason - String_comparison_exp
|
|
rebuttal - String_comparison_exp
|
|
rebuttalOptions - jsonb_comparison_exp
|
|
shownActions - jsonb_comparison_exp
|
|
shownReasons - jsonb_comparison_exp
|
|
shownRebuttals - jsonb_comparison_exp
|
|
siteId - uuid_comparison_exp
|
|
status - String_comparison_exp
|
|
subscriptionId - uuid_comparison_exp
|
|
updated_at - timestamptz_comparison_exp
|
Example
{
"CancelFlowSession": CancelFlowSession_bool_exp,
"Site": Site_bool_exp,
"Subscription": Subscription_bool_exp,
"_and": [CancelFlowV2Session_bool_exp],
"_not": CancelFlowV2Session_bool_exp,
"_or": [CancelFlowV2Session_bool_exp],
"action": String_comparison_exp,
"actions": jsonb_comparison_exp,
"cancelFlowId": uuid_comparison_exp,
"conditions": jsonb_comparison_exp,
"created_at": timestamptz_comparison_exp,
"id": uuid_comparison_exp,
"isMultipleActions": Boolean_comparison_exp,
"isOtherReason": Boolean_comparison_exp,
"reason": String_comparison_exp,
"rebuttal": String_comparison_exp,
"rebuttalOptions": jsonb_comparison_exp,
"shownActions": jsonb_comparison_exp,
"shownReasons": jsonb_comparison_exp,
"shownRebuttals": jsonb_comparison_exp,
"siteId": uuid_comparison_exp,
"status": String_comparison_exp,
"subscriptionId": uuid_comparison_exp,
"updated_at": timestamptz_comparison_exp
}
CancelFlowV2Session_max_order_by
Description
order by max() on columns of table "CancelFlowV2Session"
Example
{
"action": "asc",
"cancelFlowId": "asc",
"created_at": "asc",
"id": "asc",
"reason": "asc",
"rebuttal": "asc",
"siteId": "asc",
"status": "asc",
"subscriptionId": "asc",
"updated_at": "asc"
}
CancelFlowV2Session_min_order_by
Description
order by min() on columns of table "CancelFlowV2Session"
Example
{
"action": "asc",
"cancelFlowId": "asc",
"created_at": "asc",
"id": "asc",
"reason": "asc",
"rebuttal": "asc",
"siteId": "asc",
"status": "asc",
"subscriptionId": "asc",
"updated_at": "asc"
}
CancelSubscriptionInput
CancelSubscriptionOutput
Fields
Field Name | Description |
---|---|
ok - Boolean!
|
Example
{"ok": false}
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": 123,
"orderLineItemId": uuid,
"percentage": numeric,
"platformId": "abc123",
"redeemCode": "xyz789",
"shippingLineId": uuid,
"subscriptionId": uuid,
"subscriptionLineId": uuid,
"timesUsed": 987,
"type": "xyz789",
"updatedAt": timestamptz
}
Discount_aggregate_order_by
Description
order by aggregate values of table "Discount"
Fields
Input Field | Description |
---|---|
avg - Discount_avg_order_by
|
|
count - order_by
|
|
max - Discount_max_order_by
|
|
min - Discount_min_order_by
|
|
stddev - Discount_stddev_order_by
|
|
stddev_pop - Discount_stddev_pop_order_by
|
|
stddev_samp - Discount_stddev_samp_order_by
|
|
sum - Discount_sum_order_by
|
|
var_pop - Discount_var_pop_order_by
|
|
var_samp - Discount_var_samp_order_by
|
|
variance - Discount_variance_order_by
|
Example
{
"avg": Discount_avg_order_by,
"count": "asc",
"max": Discount_max_order_by,
"min": Discount_min_order_by,
"stddev": Discount_stddev_order_by,
"stddev_pop": Discount_stddev_pop_order_by,
"stddev_samp": Discount_stddev_samp_order_by,
"sum": Discount_sum_order_by,
"var_pop": Discount_var_pop_order_by,
"var_samp": Discount_var_samp_order_by,
"variance": Discount_variance_order_by
}
Discount_avg_order_by
Discount_bool_exp
Description
Boolean expression to filter rows from the table "Discount". All fields are combined with a logical 'AND'.
Fields
Input Field | Description |
---|---|
CancelFlowSession - CancelFlowSession_bool_exp
|
|
Group - Group_bool_exp
|
|
GroupPlan - GroupPlan_bool_exp
|
|
OrderLineItem - OrderLineItem_bool_exp
|
|
ShippingLine - ShippingLine_bool_exp
|
|
Subscription - Subscription_bool_exp
|
|
SubscriptionLine - SubscriptionLine_bool_exp
|
|
_and - [Discount_bool_exp!]
|
|
_not - Discount_bool_exp
|
|
_or - [Discount_bool_exp!]
|
|
cancelFlowSessionId - uuid_comparison_exp
|
|
createdAt - timestamptz_comparison_exp
|
|
fixedValue - numeric_comparison_exp
|
|
groupId - uuid_comparison_exp
|
|
groupPlanId - uuid_comparison_exp
|
|
id - uuid_comparison_exp
|
|
maxTimesUsed - Int_comparison_exp
|
|
orderLineItemId - uuid_comparison_exp
|
|
percentage - numeric_comparison_exp
|
|
platformId - String_comparison_exp
|
|
redeemCode - String_comparison_exp
|
|
shippingLineId - uuid_comparison_exp
|
|
subscriptionId - uuid_comparison_exp
|
|
subscriptionLineId - uuid_comparison_exp
|
|
timesUsed - Int_comparison_exp
|
|
type - String_comparison_exp
|
|
updatedAt - timestamptz_comparison_exp
|
Example
{
"CancelFlowSession": CancelFlowSession_bool_exp,
"Group": Group_bool_exp,
"GroupPlan": GroupPlan_bool_exp,
"OrderLineItem": OrderLineItem_bool_exp,
"ShippingLine": ShippingLine_bool_exp,
"Subscription": Subscription_bool_exp,
"SubscriptionLine": SubscriptionLine_bool_exp,
"_and": [Discount_bool_exp],
"_not": Discount_bool_exp,
"_or": [Discount_bool_exp],
"cancelFlowSessionId": uuid_comparison_exp,
"createdAt": timestamptz_comparison_exp,
"fixedValue": numeric_comparison_exp,
"groupId": uuid_comparison_exp,
"groupPlanId": uuid_comparison_exp,
"id": uuid_comparison_exp,
"maxTimesUsed": Int_comparison_exp,
"orderLineItemId": uuid_comparison_exp,
"percentage": numeric_comparison_exp,
"platformId": String_comparison_exp,
"redeemCode": String_comparison_exp,
"shippingLineId": uuid_comparison_exp,
"subscriptionId": uuid_comparison_exp,
"subscriptionLineId": uuid_comparison_exp,
"timesUsed": Int_comparison_exp,
"type": String_comparison_exp,
"updatedAt": timestamptz_comparison_exp
}
Discount_max_order_by
Description
order by max() on columns of table "Discount"
Fields
Input Field | Description |
---|---|
cancelFlowSessionId - order_by
|
|
createdAt - order_by
|
|
fixedValue - order_by
|
|
groupId - order_by
|
|
groupPlanId - order_by
|
|
id - order_by
|
|
maxTimesUsed - order_by
|
|
orderLineItemId - order_by
|
|
percentage - order_by
|
|
platformId - order_by
|
|
redeemCode - order_by
|
|
shippingLineId - order_by
|
|
subscriptionId - order_by
|
|
subscriptionLineId - order_by
|
|
timesUsed - order_by
|
|
type - order_by
|
|
updatedAt - order_by
|
Example
{
"cancelFlowSessionId": "asc",
"createdAt": "asc",
"fixedValue": "asc",
"groupId": "asc",
"groupPlanId": "asc",
"id": "asc",
"maxTimesUsed": "asc",
"orderLineItemId": "asc",
"percentage": "asc",
"platformId": "asc",
"redeemCode": "asc",
"shippingLineId": "asc",
"subscriptionId": "asc",
"subscriptionLineId": "asc",
"timesUsed": "asc",
"type": "asc",
"updatedAt": "asc"
}
Discount_min_order_by
Description
order by min() on columns of table "Discount"
Fields
Input Field | Description |
---|---|
cancelFlowSessionId - order_by
|
|
createdAt - order_by
|
|
fixedValue - order_by
|
|
groupId - order_by
|
|
groupPlanId - order_by
|
|
id - order_by
|
|
maxTimesUsed - order_by
|
|
orderLineItemId - order_by
|
|
percentage - order_by
|
|
platformId - order_by
|
|
redeemCode - order_by
|
|
shippingLineId - order_by
|
|
subscriptionId - order_by
|
|
subscriptionLineId - order_by
|
|
timesUsed - order_by
|
|
type - order_by
|
|
updatedAt - order_by
|
Example
{
"cancelFlowSessionId": "asc",
"createdAt": "asc",
"fixedValue": "asc",
"groupId": "asc",
"groupPlanId": "asc",
"id": "asc",
"maxTimesUsed": "asc",
"orderLineItemId": "asc",
"percentage": "asc",
"platformId": "asc",
"redeemCode": "asc",
"shippingLineId": "asc",
"subscriptionId": "asc",
"subscriptionLineId": "asc",
"timesUsed": "asc",
"type": "asc",
"updatedAt": "asc"
}
Discount_stddev_order_by
Discount_stddev_pop_order_by
Discount_stddev_samp_order_by
Discount_sum_order_by
Discount_var_pop_order_by
Discount_var_samp_order_by
Discount_variance_order_by
DynamicBox
Description
columns and relationships of "DynamicBox"
Example
{
"DynamicBox_SelectableProductVariants": [
DynamicBox_SelectableProductVariant
],
"Product": Product,
"fixedDiscount": jsonb,
"id": uuid,
"percentDiscount": jsonb,
"sizeInterval": jsonb,
"sizeRange": jsonb
}
DynamicBox_SelectableProductVariant
Description
columns and relationships of "DynamicBox_SelectableProductVariant"
Fields
Field Name | Description |
---|---|
DynamicBox - DynamicBox!
|
An object relationship |
SelectableProductVariant - ProductVariant!
|
An object relationship |
deletedAt - timestamp
|
|
dynamicBoxId - uuid!
|
|
productVariantId - uuid!
|
Example
{
"DynamicBox": DynamicBox,
"SelectableProductVariant": ProductVariant,
"deletedAt": timestamp,
"dynamicBoxId": uuid,
"productVariantId": uuid
}
DynamicBox_SelectableProductVariant_aggregate_order_by
Description
order by aggregate values of table "DynamicBox_SelectableProductVariant"
Fields
Input Field | Description |
---|---|
count - order_by
|
|
max - DynamicBox_SelectableProductVariant_max_order_by
|
|
min - DynamicBox_SelectableProductVariant_min_order_by
|
Example
{
"count": "asc",
"max": DynamicBox_SelectableProductVariant_max_order_by,
"min": DynamicBox_SelectableProductVariant_min_order_by
}
DynamicBox_SelectableProductVariant_bool_exp
Description
Boolean expression to filter rows from the table "DynamicBox_SelectableProductVariant". All fields are combined with a logical 'AND'.
Fields
Input Field | Description |
---|---|
DynamicBox - DynamicBox_bool_exp
|
|
SelectableProductVariant - ProductVariant_bool_exp
|
|
_and - [DynamicBox_SelectableProductVariant_bool_exp!]
|
|
_not - DynamicBox_SelectableProductVariant_bool_exp
|
|
_or - [DynamicBox_SelectableProductVariant_bool_exp!]
|
|
deletedAt - timestamp_comparison_exp
|
|
dynamicBoxId - uuid_comparison_exp
|
|
productVariantId - uuid_comparison_exp
|
Example
{
"DynamicBox": DynamicBox_bool_exp,
"SelectableProductVariant": ProductVariant_bool_exp,
"_and": [DynamicBox_SelectableProductVariant_bool_exp],
"_not": DynamicBox_SelectableProductVariant_bool_exp,
"_or": [DynamicBox_SelectableProductVariant_bool_exp],
"deletedAt": timestamp_comparison_exp,
"dynamicBoxId": uuid_comparison_exp,
"productVariantId": uuid_comparison_exp
}
DynamicBox_SelectableProductVariant_max_order_by
DynamicBox_SelectableProductVariant_min_order_by
DynamicBox_bool_exp
Description
Boolean expression to filter rows from the table "DynamicBox". All fields are combined with a logical 'AND'.
Fields
Input Field | Description |
---|---|
DynamicBox_SelectableProductVariants - DynamicBox_SelectableProductVariant_bool_exp
|
|
Product - Product_bool_exp
|
|
_and - [DynamicBox_bool_exp!]
|
|
_not - DynamicBox_bool_exp
|
|
_or - [DynamicBox_bool_exp!]
|
|
fixedDiscount - jsonb_comparison_exp
|
|
id - uuid_comparison_exp
|
|
percentDiscount - jsonb_comparison_exp
|
|
sizeInterval - jsonb_comparison_exp
|
|
sizeRange - jsonb_comparison_exp
|
Example
{
"DynamicBox_SelectableProductVariants": DynamicBox_SelectableProductVariant_bool_exp,
"Product": Product_bool_exp,
"_and": [DynamicBox_bool_exp],
"_not": DynamicBox_bool_exp,
"_or": [DynamicBox_bool_exp],
"fixedDiscount": jsonb_comparison_exp,
"id": uuid_comparison_exp,
"percentDiscount": jsonb_comparison_exp,
"sizeInterval": jsonb_comparison_exp,
"sizeRange": jsonb_comparison_exp
}
DynamicBox_order_by
Description
Ordering options when selecting data from "DynamicBox".
Fields
Input Field | Description |
---|---|
DynamicBox_SelectableProductVariants_aggregate - DynamicBox_SelectableProductVariant_aggregate_order_by
|
|
Product - Product_order_by
|
|
fixedDiscount - order_by
|
|
id - order_by
|
|
percentDiscount - order_by
|
|
sizeInterval - order_by
|
|
sizeRange - order_by
|
Example
{
"DynamicBox_SelectableProductVariants_aggregate": DynamicBox_SelectableProductVariant_aggregate_order_by,
"Product": Product_order_by,
"fixedDiscount": "asc",
"id": "asc",
"percentDiscount": "asc",
"sizeInterval": "asc",
"sizeRange": "asc"
}
Float
Example
987.65
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": 987,
"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": 123,
"minUsers": 987,
"sellingPlanId": uuid,
"updatedAt": timestamptz
}
GroupPlan_aggregate_order_by
Description
order by aggregate values of table "GroupPlan"
Fields
Input Field | Description |
---|---|
avg - GroupPlan_avg_order_by
|
|
count - order_by
|
|
max - GroupPlan_max_order_by
|
|
min - GroupPlan_min_order_by
|
|
stddev - GroupPlan_stddev_order_by
|
|
stddev_pop - GroupPlan_stddev_pop_order_by
|
|
stddev_samp - GroupPlan_stddev_samp_order_by
|
|
sum - GroupPlan_sum_order_by
|
|
var_pop - GroupPlan_var_pop_order_by
|
|
var_samp - GroupPlan_var_samp_order_by
|
|
variance - GroupPlan_variance_order_by
|
Example
{
"avg": GroupPlan_avg_order_by,
"count": "asc",
"max": GroupPlan_max_order_by,
"min": GroupPlan_min_order_by,
"stddev": GroupPlan_stddev_order_by,
"stddev_pop": GroupPlan_stddev_pop_order_by,
"stddev_samp": GroupPlan_stddev_samp_order_by,
"sum": GroupPlan_sum_order_by,
"var_pop": GroupPlan_var_pop_order_by,
"var_samp": GroupPlan_var_samp_order_by,
"variance": GroupPlan_variance_order_by
}
GroupPlan_avg_order_by
GroupPlan_bool_exp
Description
Boolean expression to filter rows from the table "GroupPlan". All fields are combined with a logical 'AND'.
Fields
Input Field | Description |
---|---|
DiscountsPerUser - Discount_bool_exp
|
|
GroupSet - GroupSet_bool_exp
|
|
SellingPlan - SellingPlan_bool_exp
|
|
_and - [GroupPlan_bool_exp!]
|
|
_not - GroupPlan_bool_exp
|
|
_or - [GroupPlan_bool_exp!]
|
|
createdAt - timestamptz_comparison_exp
|
|
groupSetId - uuid_comparison_exp
|
|
id - uuid_comparison_exp
|
|
maxUsers - Int_comparison_exp
|
|
minUsers - Int_comparison_exp
|
|
sellingPlanId - uuid_comparison_exp
|
|
updatedAt - timestamptz_comparison_exp
|
Example
{
"DiscountsPerUser": Discount_bool_exp,
"GroupSet": GroupSet_bool_exp,
"SellingPlan": SellingPlan_bool_exp,
"_and": [GroupPlan_bool_exp],
"_not": GroupPlan_bool_exp,
"_or": [GroupPlan_bool_exp],
"createdAt": timestamptz_comparison_exp,
"groupSetId": uuid_comparison_exp,
"id": uuid_comparison_exp,
"maxUsers": Int_comparison_exp,
"minUsers": Int_comparison_exp,
"sellingPlanId": uuid_comparison_exp,
"updatedAt": timestamptz_comparison_exp
}
GroupPlan_max_order_by
Description
order by max() on columns of table "GroupPlan"
Example
{
"createdAt": "asc",
"groupSetId": "asc",
"id": "asc",
"maxUsers": "asc",
"minUsers": "asc",
"sellingPlanId": "asc",
"updatedAt": "asc"
}
GroupPlan_min_order_by
Description
order by min() on columns of table "GroupPlan"
Example
{
"createdAt": "asc",
"groupSetId": "asc",
"id": "asc",
"maxUsers": "asc",
"minUsers": "asc",
"sellingPlanId": "asc",
"updatedAt": "asc"
}
GroupPlan_stddev_order_by
GroupPlan_stddev_pop_order_by
GroupPlan_stddev_samp_order_by
GroupPlan_sum_order_by
GroupPlan_var_pop_order_by
GroupPlan_var_samp_order_by
GroupPlan_variance_order_by
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": "abc123",
"siteId": uuid,
"updatedAt": timestamptz
}
GroupSet_bool_exp
Description
Boolean expression to filter rows from the table "GroupSet". All fields are combined with a logical 'AND'.
Fields
Input Field | Description |
---|---|
GroupPlans - GroupPlan_bool_exp
|
|
Groups - Group_bool_exp
|
|
Site - Site_bool_exp
|
|
_and - [GroupSet_bool_exp!]
|
|
_not - GroupSet_bool_exp
|
|
_or - [GroupSet_bool_exp!]
|
|
createdAt - timestamptz_comparison_exp
|
|
id - uuid_comparison_exp
|
|
name - String_comparison_exp
|
|
siteId - uuid_comparison_exp
|
|
updatedAt - timestamptz_comparison_exp
|
Example
{
"GroupPlans": GroupPlan_bool_exp,
"Groups": Group_bool_exp,
"Site": Site_bool_exp,
"_and": [GroupSet_bool_exp],
"_not": GroupSet_bool_exp,
"_or": [GroupSet_bool_exp],
"createdAt": timestamptz_comparison_exp,
"id": uuid_comparison_exp,
"name": String_comparison_exp,
"siteId": uuid_comparison_exp,
"updatedAt": timestamptz_comparison_exp
}
GroupSet_order_by
Description
Ordering options when selecting data from "GroupSet".
Fields
Input Field | Description |
---|---|
GroupPlans_aggregate - GroupPlan_aggregate_order_by
|
|
Groups_aggregate - Group_aggregate_order_by
|
|
Site - Site_order_by
|
|
createdAt - order_by
|
|
id - order_by
|
|
name - order_by
|
|
siteId - order_by
|
|
updatedAt - order_by
|
Example
{
"GroupPlans_aggregate": GroupPlan_aggregate_order_by,
"Groups_aggregate": Group_aggregate_order_by,
"Site": Site_order_by,
"createdAt": "asc",
"id": "asc",
"name": "asc",
"siteId": "asc",
"updatedAt": "asc"
}
Group_aggregate_order_by
Description
order by aggregate values of table "Group"
Fields
Input Field | Description |
---|---|
avg - Group_avg_order_by
|
|
count - order_by
|
|
max - Group_max_order_by
|
|
min - Group_min_order_by
|
|
stddev - Group_stddev_order_by
|
|
stddev_pop - Group_stddev_pop_order_by
|
|
stddev_samp - Group_stddev_samp_order_by
|
|
sum - Group_sum_order_by
|
|
var_pop - Group_var_pop_order_by
|
|
var_samp - Group_var_samp_order_by
|
|
variance - Group_variance_order_by
|
Example
{
"avg": Group_avg_order_by,
"count": "asc",
"max": Group_max_order_by,
"min": Group_min_order_by,
"stddev": Group_stddev_order_by,
"stddev_pop": Group_stddev_pop_order_by,
"stddev_samp": Group_stddev_samp_order_by,
"sum": Group_sum_order_by,
"var_pop": Group_var_pop_order_by,
"var_samp": Group_var_samp_order_by,
"variance": Group_variance_order_by
}
Group_avg_order_by
Group_bool_exp
Description
Boolean expression to filter rows from the table "Group". All fields are combined with a logical 'AND'.
Fields
Input Field | Description |
---|---|
DiscountsPerUser - Discount_bool_exp
|
|
GroupSet - GroupSet_bool_exp
|
|
OrderLineItemsIfFirstOrder - OrderLineItem_bool_exp
|
|
SubscriptionLines - SubscriptionLine_bool_exp
|
|
_and - [Group_bool_exp!]
|
|
_not - Group_bool_exp
|
|
_or - [Group_bool_exp!]
|
|
createdAt - timestamptz_comparison_exp
|
|
groupSetId - uuid_comparison_exp
|
|
id - uuid_comparison_exp
|
|
maxUsers - Int_comparison_exp
|
|
minUsers - Int_comparison_exp
|
|
updatedAt - timestamptz_comparison_exp
|
Example
{
"DiscountsPerUser": Discount_bool_exp,
"GroupSet": GroupSet_bool_exp,
"OrderLineItemsIfFirstOrder": OrderLineItem_bool_exp,
"SubscriptionLines": SubscriptionLine_bool_exp,
"_and": [Group_bool_exp],
"_not": Group_bool_exp,
"_or": [Group_bool_exp],
"createdAt": timestamptz_comparison_exp,
"groupSetId": uuid_comparison_exp,
"id": uuid_comparison_exp,
"maxUsers": Int_comparison_exp,
"minUsers": Int_comparison_exp,
"updatedAt": timestamptz_comparison_exp
}
Group_max_order_by
Description
order by max() on columns of table "Group"
Example
{
"createdAt": "asc",
"groupSetId": "asc",
"id": "asc",
"maxUsers": "asc",
"minUsers": "asc",
"updatedAt": "asc"
}
Group_min_order_by
Description
order by min() on columns of table "Group"
Example
{
"createdAt": "asc",
"groupSetId": "asc",
"id": "asc",
"maxUsers": "asc",
"minUsers": "asc",
"updatedAt": "asc"
}
Group_order_by
Description
Ordering options when selecting data from "Group".
Fields
Input Field | Description |
---|---|
DiscountsPerUser_aggregate - Discount_aggregate_order_by
|
|
GroupSet - GroupSet_order_by
|
|
OrderLineItemsIfFirstOrder_aggregate - OrderLineItem_aggregate_order_by
|
|
SubscriptionLines_aggregate - SubscriptionLine_aggregate_order_by
|
|
createdAt - order_by
|
|
groupSetId - order_by
|
|
id - order_by
|
|
maxUsers - order_by
|
|
minUsers - order_by
|
|
updatedAt - order_by
|
Example
{
"DiscountsPerUser_aggregate": Discount_aggregate_order_by,
"GroupSet": GroupSet_order_by,
"OrderLineItemsIfFirstOrder_aggregate": OrderLineItem_aggregate_order_by,
"SubscriptionLines_aggregate": SubscriptionLine_aggregate_order_by,
"createdAt": "asc",
"groupSetId": "asc",
"id": "asc",
"maxUsers": "asc",
"minUsers": "asc",
"updatedAt": "asc"
}
Group_stddev_order_by
Group_stddev_pop_order_by
Group_stddev_samp_order_by
Group_sum_order_by
Group_var_pop_order_by
Group_var_samp_order_by
Group_variance_order_by
Holiday
Holiday_aggregate_order_by
Description
order by aggregate values of table "Holiday"
Fields
Input Field | Description |
---|---|
count - order_by
|
|
max - Holiday_max_order_by
|
|
min - Holiday_min_order_by
|
Example
{
"count": "asc",
"max": Holiday_max_order_by,
"min": Holiday_min_order_by
}
Holiday_bool_exp
Description
Boolean expression to filter rows from the table "Holiday". All fields are combined with a logical 'AND'.
Fields
Input Field | Description |
---|---|
Site - Site_bool_exp
|
|
_and - [Holiday_bool_exp!]
|
|
_not - Holiday_bool_exp
|
|
_or - [Holiday_bool_exp!]
|
|
id - uuid_comparison_exp
|
Example
{
"Site": Site_bool_exp,
"_and": [Holiday_bool_exp],
"_not": Holiday_bool_exp,
"_or": [Holiday_bool_exp],
"id": uuid_comparison_exp
}
Holiday_max_order_by
Description
order by max() on columns of table "Holiday"
Fields
Input Field | Description |
---|---|
id - order_by
|
Example
{"id": "asc"}
Holiday_min_order_by
Description
order by min() on columns of table "Holiday"
Fields
Input Field | Description |
---|---|
id - order_by
|
Example
{"id": "asc"}
Int
Example
987
Int_comparison_exp
Description
Boolean expression to compare columns of type "Int". All fields are combined with logical 'AND'.
Example
{
"_eq": 123,
"_gt": 123,
"_gte": 987,
"_in": [987],
"_is_null": false,
"_lt": 987,
"_lte": 987,
"_neq": 123,
"_nin": [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": "abc123",
"subscriptionId": uuid,
"updatedAt": timestamptz
}
NotificationLog_aggregate_order_by
Description
order by aggregate values of table "NotificationLog"
Fields
Input Field | Description |
---|---|
count - order_by
|
|
max - NotificationLog_max_order_by
|
|
min - NotificationLog_min_order_by
|
Example
{
"count": "asc",
"max": NotificationLog_max_order_by,
"min": NotificationLog_min_order_by
}
NotificationLog_bool_exp
Description
Boolean expression to filter rows from the table "NotificationLog". All fields are combined with a logical 'AND'.
Fields
Input Field | Description |
---|---|
Notification - Notification_bool_exp
|
|
Subscription - Subscription_bool_exp
|
|
_and - [NotificationLog_bool_exp!]
|
|
_not - NotificationLog_bool_exp
|
|
_or - [NotificationLog_bool_exp!]
|
|
body - String_comparison_exp
|
|
createdAt - timestamptz_comparison_exp
|
|
email - String_comparison_exp
|
|
id - uuid_comparison_exp
|
|
notificationId - uuid_comparison_exp
|
|
phoneNumber - String_comparison_exp
|
|
subject - String_comparison_exp
|
|
subscriptionId - uuid_comparison_exp
|
|
updatedAt - timestamptz_comparison_exp
|
Example
{
"Notification": Notification_bool_exp,
"Subscription": Subscription_bool_exp,
"_and": [NotificationLog_bool_exp],
"_not": NotificationLog_bool_exp,
"_or": [NotificationLog_bool_exp],
"body": String_comparison_exp,
"createdAt": timestamptz_comparison_exp,
"email": String_comparison_exp,
"id": uuid_comparison_exp,
"notificationId": uuid_comparison_exp,
"phoneNumber": String_comparison_exp,
"subject": String_comparison_exp,
"subscriptionId": uuid_comparison_exp,
"updatedAt": timestamptz_comparison_exp
}
NotificationLog_max_order_by
Description
order by max() on columns of table "NotificationLog"
Example
{
"body": "asc",
"createdAt": "asc",
"email": "asc",
"id": "asc",
"notificationId": "asc",
"phoneNumber": "asc",
"subject": "asc",
"subscriptionId": "asc",
"updatedAt": "asc"
}
NotificationLog_min_order_by
Description
order by min() on columns of table "NotificationLog"
Example
{
"body": "asc",
"createdAt": "asc",
"email": "asc",
"id": "asc",
"notificationId": "asc",
"phoneNumber": "asc",
"subject": "asc",
"subscriptionId": "asc",
"updatedAt": "asc"
}
Notification_aggregate_order_by
Description
order by aggregate values of table "Notification"
Fields
Input Field | Description |
---|---|
count - order_by
|
|
max - Notification_max_order_by
|
|
min - Notification_min_order_by
|
Example
{
"count": "asc",
"max": Notification_max_order_by,
"min": Notification_min_order_by
}
Notification_bool_exp
Description
Boolean expression to filter rows from the table "Notification". All fields are combined with a logical 'AND'.
Fields
Input Field | Description |
---|---|
NotificationLogs - NotificationLog_bool_exp
|
|
Site - Site_bool_exp
|
|
_and - [Notification_bool_exp!]
|
|
_not - Notification_bool_exp
|
|
_or - [Notification_bool_exp!]
|
|
id - uuid_comparison_exp
|
Example
{
"NotificationLogs": NotificationLog_bool_exp,
"Site": Site_bool_exp,
"_and": [Notification_bool_exp],
"_not": Notification_bool_exp,
"_or": [Notification_bool_exp],
"id": uuid_comparison_exp
}
Notification_max_order_by
Description
order by max() on columns of table "Notification"
Fields
Input Field | Description |
---|---|
id - order_by
|
Example
{"id": "asc"}
Notification_min_order_by
Description
order by min() on columns of table "Notification"
Fields
Input Field | Description |
---|---|
id - order_by
|
Example
{"id": "asc"}
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
|
|
clientIp - String
|
|
createdAt - timestamptz!
|
|
deletedAt - timestamptz
|
|
deliveredAt - timestamptz
|
|
id - uuid!
|
|
note - String
|
|
platformId - String
|
|
platformNumber - String!
|
|
processedAt - timestamptz
|
|
storefrontUserId - uuid!
|
|
updatedAt - timestamp!
|
Example
{
"OrderLineItems": [OrderLineItem],
"PrepaidSubscription": Subscription,
"ShippingLines": [ShippingLine],
"StorefrontUser": StorefrontUser,
"cancelledAt": timestamptz,
"clientIp": "abc123",
"createdAt": timestamptz,
"deletedAt": timestamptz,
"deliveredAt": timestamptz,
"id": uuid,
"note": "abc123",
"platformId": "xyz789",
"platformNumber": "abc123",
"processedAt": timestamptz,
"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
}
OrderLineItem_aggregate_order_by
Description
order by aggregate values of table "OrderLineItem"
Fields
Input Field | Description |
---|---|
avg - OrderLineItem_avg_order_by
|
|
count - order_by
|
|
max - OrderLineItem_max_order_by
|
|
min - OrderLineItem_min_order_by
|
|
stddev - OrderLineItem_stddev_order_by
|
|
stddev_pop - OrderLineItem_stddev_pop_order_by
|
|
stddev_samp - OrderLineItem_stddev_samp_order_by
|
|
sum - OrderLineItem_sum_order_by
|
|
var_pop - OrderLineItem_var_pop_order_by
|
|
var_samp - OrderLineItem_var_samp_order_by
|
|
variance - OrderLineItem_variance_order_by
|
Example
{
"avg": OrderLineItem_avg_order_by,
"count": "asc",
"max": OrderLineItem_max_order_by,
"min": OrderLineItem_min_order_by,
"stddev": OrderLineItem_stddev_order_by,
"stddev_pop": OrderLineItem_stddev_pop_order_by,
"stddev_samp": OrderLineItem_stddev_samp_order_by,
"sum": OrderLineItem_sum_order_by,
"var_pop": OrderLineItem_var_pop_order_by,
"var_samp": OrderLineItem_var_samp_order_by,
"variance": OrderLineItem_variance_order_by
}
OrderLineItem_avg_order_by
OrderLineItem_bool_exp
Description
Boolean expression to filter rows from the table "OrderLineItem". All fields are combined with a logical 'AND'.
Fields
Input Field | Description |
---|---|
Discounts - Discount_bool_exp
|
|
GroupIfInitialOrder - Group_bool_exp
|
|
Order - Order_bool_exp
|
|
ProductVariant - ProductVariant_bool_exp
|
|
SubscriptionLine - SubscriptionLine_bool_exp
|
|
TaxLines - TaxLine_bool_exp
|
|
_and - [OrderLineItem_bool_exp!]
|
|
_not - OrderLineItem_bool_exp
|
|
_or - [OrderLineItem_bool_exp!]
|
|
attributionGroupId - uuid_comparison_exp
|
|
createdAt - timestamptz_comparison_exp
|
|
customAttributes - jsonb_comparison_exp
|
|
groupId - uuid_comparison_exp
|
|
id - uuid_comparison_exp
|
|
orderId - uuid_comparison_exp
|
|
platformId - String_comparison_exp
|
|
priceWithoutDiscount - numeric_comparison_exp
|
|
productVariantId - uuid_comparison_exp
|
|
quantity - Int_comparison_exp
|
|
subscriptionLineId - uuid_comparison_exp
|
|
updatedAt - timestamptz_comparison_exp
|
Example
{
"Discounts": Discount_bool_exp,
"GroupIfInitialOrder": Group_bool_exp,
"Order": Order_bool_exp,
"ProductVariant": ProductVariant_bool_exp,
"SubscriptionLine": SubscriptionLine_bool_exp,
"TaxLines": TaxLine_bool_exp,
"_and": [OrderLineItem_bool_exp],
"_not": OrderLineItem_bool_exp,
"_or": [OrderLineItem_bool_exp],
"attributionGroupId": uuid_comparison_exp,
"createdAt": timestamptz_comparison_exp,
"customAttributes": jsonb_comparison_exp,
"groupId": uuid_comparison_exp,
"id": uuid_comparison_exp,
"orderId": uuid_comparison_exp,
"platformId": String_comparison_exp,
"priceWithoutDiscount": numeric_comparison_exp,
"productVariantId": uuid_comparison_exp,
"quantity": Int_comparison_exp,
"subscriptionLineId": uuid_comparison_exp,
"updatedAt": timestamptz_comparison_exp
}
OrderLineItem_max_order_by
Description
order by max() on columns of table "OrderLineItem"
Example
{
"attributionGroupId": "asc",
"createdAt": "asc",
"groupId": "asc",
"id": "asc",
"orderId": "asc",
"platformId": "asc",
"priceWithoutDiscount": "asc",
"productVariantId": "asc",
"quantity": "asc",
"subscriptionLineId": "asc",
"updatedAt": "asc"
}
OrderLineItem_min_order_by
Description
order by min() on columns of table "OrderLineItem"
Example
{
"attributionGroupId": "asc",
"createdAt": "asc",
"groupId": "asc",
"id": "asc",
"orderId": "asc",
"platformId": "asc",
"priceWithoutDiscount": "asc",
"productVariantId": "asc",
"quantity": "asc",
"subscriptionLineId": "asc",
"updatedAt": "asc"
}
OrderLineItem_order_by
Description
Ordering options when selecting data from "OrderLineItem".
Fields
Input Field | Description |
---|---|
Discounts_aggregate - Discount_aggregate_order_by
|
|
GroupIfInitialOrder - Group_order_by
|
|
Order - Order_order_by
|
|
ProductVariant - ProductVariant_order_by
|
|
SubscriptionLine - SubscriptionLine_order_by
|
|
TaxLines_aggregate - TaxLine_aggregate_order_by
|
|
attributionGroupId - order_by
|
|
createdAt - order_by
|
|
customAttributes - order_by
|
|
groupId - order_by
|
|
id - order_by
|
|
orderId - order_by
|
|
platformId - order_by
|
|
priceWithoutDiscount - order_by
|
|
productVariantId - order_by
|
|
quantity - order_by
|
|
subscriptionLineId - order_by
|
|
updatedAt - order_by
|
Example
{
"Discounts_aggregate": Discount_aggregate_order_by,
"GroupIfInitialOrder": Group_order_by,
"Order": Order_order_by,
"ProductVariant": ProductVariant_order_by,
"SubscriptionLine": SubscriptionLine_order_by,
"TaxLines_aggregate": TaxLine_aggregate_order_by,
"attributionGroupId": "asc",
"createdAt": "asc",
"customAttributes": "asc",
"groupId": "asc",
"id": "asc",
"orderId": "asc",
"platformId": "asc",
"priceWithoutDiscount": "asc",
"productVariantId": "asc",
"quantity": "asc",
"subscriptionLineId": "asc",
"updatedAt": "asc"
}
OrderLineItem_select_column
Description
select columns of table "OrderLineItem"
Values
Enum Value | Description |
---|---|
|
column name |
|
column name |
|
column name |
|
column name |
|
column name |
|
column name |
|
column name |
|
column name |
|
column name |
|
column name |
|
column name |
|
column name |
Example
"attributionGroupId"