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 (this API key is invalid):

headers: {

"Content-Type": "application/graphql"

"authorization": "API 8f7135ea-f48d-43ee-a6a9-0d97f376dfa9"

}

Contact

Skio Engineering
help@skio.com

Terms of Service: https://skio.com/terms/

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

Queries

AddressByPk

fetch data from the table: "Address" using primary key columns
Returns an Address

Name Description
id - uuid!

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": "abc123",
      "address2": "xyz789",
      "city": "abc123",
      "company": "abc123",
      "country": "xyz789",
      "createdAt": timestamptz,
      "doorCode": "xyz789",
      "firstName": "abc123",
      "id": uuid,
      "lastName": "xyz789",
      "phoneNumber": "abc123",
      "platformId": "xyz789",
      "province": "xyz789",
      "storefrontUserId": uuid,
      "updatedAt": timestamptz,
      "zip": "xyz789"
    }
  }
}

Addresses

fetch data from the table: "Address"
Returns [Address!]!

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": [Address_select_column],
  "limit": 987,
  "offset": 123,
  "order_by": [Address_order_by],
  "where": Address_bool_exp
}
Response
{
  "data": {
    "Addresses": [
      {
        "PaymentMethod": PaymentMethod,
        "StorefrontUser": StorefrontUser,
        "Subscriptions": [Subscription],
        "address1": "abc123",
        "address2": "xyz789",
        "city": "abc123",
        "company": "abc123",
        "country": "xyz789",
        "createdAt": timestamptz,
        "doorCode": "xyz789",
        "firstName": "abc123",
        "id": uuid,
        "lastName": "xyz789",
        "phoneNumber": "abc123",
        "platformId": "xyz789",
        "province": "xyz789",
        "storefrontUserId": uuid,
        "updatedAt": timestamptz,
        "zip": "abc123"
      }
    ]
  }
}

AnchorByPk

fetch data from the table: "Anchor" using primary key columns
Returns an Anchor

Name Description
id - uuid!

Example

Query
query AnchorByPk($id: uuid!) {
  AnchorByPk(id: $id) {
    Policy {
      ...PolicyFragment
    }
    createdAt
    cutoffDay
    day
    id
    month
    policyId
    type
    updatedAt
  }
}
Variables
{"id": uuid}
Response
{
  "data": {
    "AnchorByPk": {
      "Policy": Policy,
      "createdAt": timestamptz,
      "cutoffDay": 987,
      "day": 123,
      "id": uuid,
      "month": 123,
      "policyId": uuid,
      "type": "xyz789",
      "updatedAt": timestamptz
    }
  }
}

Anchors

An array relationship
Returns [Anchor!]!

Name Description
distinct_on - [Anchor_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 - [Anchor_order_by!] sort the rows by one or more columns
where - Anchor_bool_exp filter the rows returned

Example

Query
query Anchors($distinct_on: [Anchor_select_column!], $limit: Int, $offset: Int, $order_by: [Anchor_order_by!], $where: Anchor_bool_exp) {
  Anchors(distinct_on: $distinct_on, limit: $limit, offset: $offset, order_by: $order_by, where: $where) {
    Policy {
      ...PolicyFragment
    }
    createdAt
    cutoffDay
    day
    id
    month
    policyId
    type
    updatedAt
  }
}
Variables
{
  "distinct_on": [Anchor_select_column],
  "limit": 123,
  "offset": 123,
  "order_by": [Anchor_order_by],
  "where": Anchor_bool_exp
}
Response
{
  "data": {
    "Anchors": [
      {
        "Policy": Policy,
        "createdAt": timestamptz,
        "cutoffDay": 987,
        "day": 987,
        "id": uuid,
        "month": 987,
        "policyId": uuid,
        "type": "xyz789",
        "updatedAt": timestamptz
      }
    ]
  }
}

AuditLog

fetch data from the table: "AuditLog"
Returns [AuditLog!]!

Name Description
distinct_on - [AuditLog_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 - [AuditLog_order_by!] sort the rows by one or more columns
where - AuditLog_bool_exp filter the rows returned

Example

Query
query AuditLog($distinct_on: [AuditLog_select_column!], $limit: Int, $offset: Int, $order_by: [AuditLog_order_by!], $where: AuditLog_bool_exp) {
  AuditLog(distinct_on: $distinct_on, limit: $limit, offset: $offset, order_by: $order_by, where: $where) {
    StorefrontUser {
      ...StorefrontUserFragment
    }
    Subscription {
      ...SubscriptionFragment
    }
    createdAt
    eventData
    eventType
    id
    storefrontUserId
    subscriptionId
    updatedAt
  }
}
Variables
{
  "distinct_on": [AuditLog_select_column],
  "limit": 987,
  "offset": 123,
  "order_by": [AuditLog_order_by],
  "where": AuditLog_bool_exp
}
Response
{
  "data": {
    "AuditLog": [
      {
        "StorefrontUser": StorefrontUser,
        "Subscription": Subscription,
        "createdAt": timestamptz,
        "eventData": jsonb,
        "eventType": "abc123",
        "id": uuid,
        "storefrontUserId": uuid,
        "subscriptionId": uuid,
        "updatedAt": timestamptz
      }
    ]
  }
}

AuditLog_by_pk

fetch data from the table: "AuditLog" using primary key columns
Returns an AuditLog

Name Description
id - uuid!

Example

Query
query AuditLog_by_pk($id: uuid!) {
  AuditLog_by_pk(id: $id) {
    StorefrontUser {
      ...StorefrontUserFragment
    }
    Subscription {
      ...SubscriptionFragment
    }
    createdAt
    eventData
    eventType
    id
    storefrontUserId
    subscriptionId
    updatedAt
  }
}
Variables
{"id": uuid}
Response
{
  "data": {
    "AuditLog_by_pk": {
      "StorefrontUser": StorefrontUser,
      "Subscription": Subscription,
      "createdAt": timestamptz,
      "eventData": jsonb,
      "eventType": "xyz789",
      "id": uuid,
      "storefrontUserId": uuid,
      "subscriptionId": uuid,
      "updatedAt": timestamptz
    }
  }
}

BillingAttempts

fetch data from the table: "BillingAttempt"
Returns [BillingAttempt!]!

Name Description
distinct_on - [BillingAttempt_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 - [BillingAttempt_order_by!] sort the rows by one or more columns
where - BillingAttempt_bool_exp filter the rows returned

Example

Query
query BillingAttempts($distinct_on: [BillingAttempt_select_column!], $limit: Int, $offset: Int, $order_by: [BillingAttempt_order_by!], $where: BillingAttempt_bool_exp) {
  BillingAttempts(distinct_on: $distinct_on, limit: $limit, offset: $offset, order_by: $order_by, where: $where) {
    Order {
      ...OrderFragment
    }
    Subscription {
      ...SubscriptionFragment
    }
    billingAttemptedAt
    createdAt
    errorCode
    errorMessage
    id
    orderId
    orderPlatformId
    platformId
    subscriptionBillingDate
    subscriptionId
    updatedAt
  }
}
Variables
{
  "distinct_on": [BillingAttempt_select_column],
  "limit": 987,
  "offset": 987,
  "order_by": [BillingAttempt_order_by],
  "where": BillingAttempt_bool_exp
}
Response
{
  "data": {
    "BillingAttempts": [
      {
        "Order": Order,
        "Subscription": Subscription,
        "billingAttemptedAt": timestamptz,
        "createdAt": timestamptz,
        "errorCode": "abc123",
        "errorMessage": "abc123",
        "id": uuid,
        "orderId": uuid,
        "orderPlatformId": "abc123",
        "platformId": "xyz789",
        "subscriptionBillingDate": timestamptz,
        "subscriptionId": uuid,
        "updatedAt": timestamptz
      }
    ]
  }
}

BillingAttemptsByPk

fetch data from the table: "BillingAttempt" using primary key columns
Returns a BillingAttempt

Name Description
id - uuid!

Example

Query
query BillingAttemptsByPk($id: uuid!) {
  BillingAttemptsByPk(id: $id) {
    Order {
      ...OrderFragment
    }
    Subscription {
      ...SubscriptionFragment
    }
    billingAttemptedAt
    createdAt
    errorCode
    errorMessage
    id
    orderId
    orderPlatformId
    platformId
    subscriptionBillingDate
    subscriptionId
    updatedAt
  }
}
Variables
{"id": uuid}
Response
{
  "data": {
    "BillingAttemptsByPk": {
      "Order": Order,
      "Subscription": Subscription,
      "billingAttemptedAt": timestamptz,
      "createdAt": timestamptz,
      "errorCode": "abc123",
      "errorMessage": "abc123",
      "id": uuid,
      "orderId": uuid,
      "orderPlatformId": "xyz789",
      "platformId": "abc123",
      "subscriptionBillingDate": timestamptz,
      "subscriptionId": uuid,
      "updatedAt": timestamptz
    }
  }
}

CancelFlowReasonByPk

fetch data from the table: "CancelFlowReason" using primary key columns
Returns a CancelFlowReason

Name Description
id - uuid!

Example

Query
query CancelFlowReasonByPk($id: uuid!) {
  CancelFlowReasonByPk(id: $id) {
    CancelFlowSession {
      ...CancelFlowSessionFragment
    }
    cancelFlowId
    cancelFlowSessionId
    createdAt
    id
    order
    otherReasonBody
    reason
    rebuttal
    updatedAt
  }
}
Variables
{"id": uuid}
Response
{
  "data": {
    "CancelFlowReasonByPk": {
      "CancelFlowSession": CancelFlowSession,
      "cancelFlowId": uuid,
      "cancelFlowSessionId": uuid,
      "createdAt": timestamptz,
      "id": uuid,
      "order": numeric,
      "otherReasonBody": "abc123",
      "reason": "xyz789",
      "rebuttal": "abc123",
      "updatedAt": timestamptz
    }
  }
}

CancelFlowReasons

fetch data from the table: "CancelFlowReason"
Returns [CancelFlowReason!]!

Name Description
distinct_on - [CancelFlowReason_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 - [CancelFlowReason_order_by!] sort the rows by one or more columns
where - CancelFlowReason_bool_exp filter the rows returned

Example

Query
query CancelFlowReasons($distinct_on: [CancelFlowReason_select_column!], $limit: Int, $offset: Int, $order_by: [CancelFlowReason_order_by!], $where: CancelFlowReason_bool_exp) {
  CancelFlowReasons(distinct_on: $distinct_on, limit: $limit, offset: $offset, order_by: $order_by, where: $where) {
    CancelFlowSession {
      ...CancelFlowSessionFragment
    }
    cancelFlowId
    cancelFlowSessionId
    createdAt
    id
    order
    otherReasonBody
    reason
    rebuttal
    updatedAt
  }
}
Variables
{
  "distinct_on": [CancelFlowReason_select_column],
  "limit": 987,
  "offset": 123,
  "order_by": [CancelFlowReason_order_by],
  "where": CancelFlowReason_bool_exp
}
Response
{
  "data": {
    "CancelFlowReasons": [
      {
        "CancelFlowSession": CancelFlowSession,
        "cancelFlowId": uuid,
        "cancelFlowSessionId": uuid,
        "createdAt": timestamptz,
        "id": uuid,
        "order": numeric,
        "otherReasonBody": "xyz789",
        "reason": "abc123",
        "rebuttal": "abc123",
        "updatedAt": timestamptz
      }
    ]
  }
}

CancelFlowSessionByPk

fetch data from the table: "CancelFlowSession" using primary key columns
Returns a CancelFlowSession

Name Description
id - uuid!

Example

Query
query CancelFlowSessionByPk($id: uuid!) {
  CancelFlowSessionByPk(id: $id) {
    CancelFlowReason {
      ...CancelFlowReasonFragment
    }
    Discounts {
      ...DiscountFragment
    }
    Subscription {
      ...SubscriptionFragment
    }
    cancelFlowId
    createdAt
    id
    status
    subscriptionId
    updatedAt
  }
}
Variables
{"id": uuid}
Response
{
  "data": {
    "CancelFlowSessionByPk": {
      "CancelFlowReason": CancelFlowReason,
      "Discounts": [Discount],
      "Subscription": Subscription,
      "cancelFlowId": uuid,
      "createdAt": timestamptz,
      "id": uuid,
      "status": "xyz789",
      "subscriptionId": uuid,
      "updatedAt": timestamptz
    }
  }
}

CancelFlowSessions

An array relationship
Returns [CancelFlowSession!]!

Name Description
distinct_on - [CancelFlowSession_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 - [CancelFlowSession_order_by!] sort the rows by one or more columns
where - CancelFlowSession_bool_exp filter the rows returned

Example

Query
query CancelFlowSessions($distinct_on: [CancelFlowSession_select_column!], $limit: Int, $offset: Int, $order_by: [CancelFlowSession_order_by!], $where: CancelFlowSession_bool_exp) {
  CancelFlowSessions(distinct_on: $distinct_on, limit: $limit, offset: $offset, order_by: $order_by, where: $where) {
    CancelFlowReason {
      ...CancelFlowReasonFragment
    }
    Discounts {
      ...DiscountFragment
    }
    Subscription {
      ...SubscriptionFragment
    }
    cancelFlowId
    createdAt
    id
    status
    subscriptionId
    updatedAt
  }
}
Variables
{
  "distinct_on": [CancelFlowSession_select_column],
  "limit": 123,
  "offset": 987,
  "order_by": [CancelFlowSession_order_by],
  "where": CancelFlowSession_bool_exp
}
Response
{
  "data": {
    "CancelFlowSessions": [
      {
        "CancelFlowReason": CancelFlowReason,
        "Discounts": [Discount],
        "Subscription": Subscription,
        "cancelFlowId": uuid,
        "createdAt": timestamptz,
        "id": uuid,
        "status": "xyz789",
        "subscriptionId": uuid,
        "updatedAt": timestamptz
      }
    ]
  }
}

DiscountByPk

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

Name Description
id - uuid!

Example

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

Discounts

An array relationship
Returns [Discount!]!

Name Description
distinct_on - [Discount_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 - [Discount_order_by!] sort the rows by one or more columns
where - Discount_bool_exp filter the rows returned

Example

Query
query Discounts($distinct_on: [Discount_select_column!], $limit: Int, $offset: Int, $order_by: [Discount_order_by!], $where: Discount_bool_exp) {
  Discounts(distinct_on: $distinct_on, limit: $limit, offset: $offset, order_by: $order_by, where: $where) {
    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
{
  "distinct_on": [Discount_select_column],
  "limit": 123,
  "offset": 987,
  "order_by": [Discount_order_by],
  "where": Discount_bool_exp
}
Response
{
  "data": {
    "Discounts": [
      {
        "CancelFlowSession": CancelFlowSession,
        "Group": Group,
        "GroupPlan": GroupPlan,
        "OrderLineItem": OrderLineItem,
        "ShippingLine": ShippingLine,
        "Subscription": Subscription,
        "SubscriptionLine": SubscriptionLine,
        "cancelFlowSessionId": uuid,
        "createdAt": timestamptz,
        "fixedValue": numeric,
        "groupId": uuid,
        "groupPlanId": uuid,
        "id": uuid,
        "maxTimesUsed": 987,
        "orderLineItemId": uuid,
        "percentage": numeric,
        "platformId": "abc123",
        "redeemCode": "abc123",
        "shippingLineId": uuid,
        "subscriptionId": uuid,
        "subscriptionLineId": uuid,
        "timesUsed": 123,
        "type": "xyz789",
        "updatedAt": timestamptz
      }
    ]
  }
}

GroupByPk

fetch data from the table: "Group" using primary key columns
Returns a Group

Name Description
id - uuid!

Example

Query
query GroupByPk($id: uuid!) {
  GroupByPk(id: $id) {
    DiscountsPerUser {
      ...DiscountFragment
    }
    GroupSet {
      ...GroupSetFragment
    }
    OrderLineItemsIfFirstOrder {
      ...OrderLineItemFragment
    }
    SubscriptionLines {
      ...SubscriptionLineFragment
    }
    createdAt
    groupSetId
    id
    maxUsers
    minUsers
    updatedAt
  }
}
Variables
{"id": uuid}
Response
{
  "data": {
    "GroupByPk": {
      "DiscountsPerUser": [Discount],
      "GroupSet": GroupSet,
      "OrderLineItemsIfFirstOrder": [OrderLineItem],
      "SubscriptionLines": [SubscriptionLine],
      "createdAt": timestamptz,
      "groupSetId": uuid,
      "id": uuid,
      "maxUsers": 987,
      "minUsers": 123,
      "updatedAt": timestamptz
    }
  }
}

GroupPlanByPk

fetch data from the table: "GroupPlan" using primary key columns
Returns a GroupPlan

Name Description
id - uuid!

Example

Query
query GroupPlanByPk($id: uuid!) {
  GroupPlanByPk(id: $id) {
    DiscountsPerUser {
      ...DiscountFragment
    }
    GroupSet {
      ...GroupSetFragment
    }
    SellingPlan {
      ...SellingPlanFragment
    }
    createdAt
    groupSetId
    id
    maxUsers
    minUsers
    sellingPlanId
    updatedAt
  }
}
Variables
{"id": uuid}
Response
{
  "data": {
    "GroupPlanByPk": {
      "DiscountsPerUser": [Discount],
      "GroupSet": GroupSet,
      "SellingPlan": SellingPlan,
      "createdAt": timestamptz,
      "groupSetId": uuid,
      "id": uuid,
      "maxUsers": 123,
      "minUsers": 987,
      "sellingPlanId": uuid,
      "updatedAt": timestamptz
    }
  }
}

GroupPlans

An array relationship
Returns [GroupPlan!]!

Name Description
distinct_on - [GroupPlan_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 - [GroupPlan_order_by!] sort the rows by one or more columns
where - GroupPlan_bool_exp filter the rows returned

Example

Query
query GroupPlans($distinct_on: [GroupPlan_select_column!], $limit: Int, $offset: Int, $order_by: [GroupPlan_order_by!], $where: GroupPlan_bool_exp) {
  GroupPlans(distinct_on: $distinct_on, limit: $limit, offset: $offset, order_by: $order_by, where: $where) {
    DiscountsPerUser {
      ...DiscountFragment
    }
    GroupSet {
      ...GroupSetFragment
    }
    SellingPlan {
      ...SellingPlanFragment
    }
    createdAt
    groupSetId
    id
    maxUsers
    minUsers
    sellingPlanId
    updatedAt
  }
}
Variables
{
  "distinct_on": [GroupPlan_select_column],
  "limit": 987,
  "offset": 987,
  "order_by": [GroupPlan_order_by],
  "where": GroupPlan_bool_exp
}
Response
{
  "data": {
    "GroupPlans": [
      {
        "DiscountsPerUser": [Discount],
        "GroupSet": GroupSet,
        "SellingPlan": SellingPlan,
        "createdAt": timestamptz,
        "groupSetId": uuid,
        "id": uuid,
        "maxUsers": 987,
        "minUsers": 987,
        "sellingPlanId": uuid,
        "updatedAt": timestamptz
      }
    ]
  }
}

Groups

An array relationship
Returns [Group!]!

Name Description
distinct_on - [Group_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 - [Group_order_by!] sort the rows by one or more columns
where - Group_bool_exp filter the rows returned

Example

Query
query Groups($distinct_on: [Group_select_column!], $limit: Int, $offset: Int, $order_by: [Group_order_by!], $where: Group_bool_exp) {
  Groups(distinct_on: $distinct_on, limit: $limit, offset: $offset, order_by: $order_by, where: $where) {
    DiscountsPerUser {
      ...DiscountFragment
    }
    GroupSet {
      ...GroupSetFragment
    }
    OrderLineItemsIfFirstOrder {
      ...OrderLineItemFragment
    }
    SubscriptionLines {
      ...SubscriptionLineFragment
    }
    createdAt
    groupSetId
    id
    maxUsers
    minUsers
    updatedAt
  }
}
Variables
{
  "distinct_on": [Group_select_column],
  "limit": 123,
  "offset": 123,
  "order_by": [Group_order_by],
  "where": Group_bool_exp
}
Response
{
  "data": {
    "Groups": [
      {
        "DiscountsPerUser": [Discount],
        "GroupSet": GroupSet,
        "OrderLineItemsIfFirstOrder": [OrderLineItem],
        "SubscriptionLines": [SubscriptionLine],
        "createdAt": timestamptz,
        "groupSetId": uuid,
        "id": uuid,
        "maxUsers": 987,
        "minUsers": 987,
        "updatedAt": timestamptz
      }
    ]
  }
}

GroupSet

fetch data from the table: "GroupSet"
Returns [GroupSet!]!

Name Description
distinct_on - [GroupSet_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 - [GroupSet_order_by!] sort the rows by one or more columns
where - GroupSet_bool_exp filter the rows returned

Example

Query
query GroupSet($distinct_on: [GroupSet_select_column!], $limit: Int, $offset: Int, $order_by: [GroupSet_order_by!], $where: GroupSet_bool_exp) {
  GroupSet(distinct_on: $distinct_on, limit: $limit, offset: $offset, order_by: $order_by, where: $where) {
    GroupPlans {
      ...GroupPlanFragment
    }
    Groups {
      ...GroupFragment
    }
    Site {
      ...SiteFragment
    }
    createdAt
    id
    name
    siteId
    updatedAt
  }
}
Variables
{
  "distinct_on": [GroupSet_select_column],
  "limit": 123,
  "offset": 123,
  "order_by": [GroupSet_order_by],
  "where": GroupSet_bool_exp
}
Response
{
  "data": {
    "GroupSet": [
      {
        "GroupPlans": [GroupPlan],
        "Groups": [Group],
        "Site": Site,
        "createdAt": timestamptz,
        "id": uuid,
        "name": "abc123",
        "siteId": uuid,
        "updatedAt": timestamptz
      }
    ]
  }
}

GroupSet_by_pk

fetch data from the table: "GroupSet" using primary key columns
Returns a GroupSet

Name Description
id - uuid!

Example

Query
query GroupSet_by_pk($id: uuid!) {
  GroupSet_by_pk(id: $id) {
    GroupPlans {
      ...GroupPlanFragment
    }
    Groups {
      ...GroupFragment
    }
    Site {
      ...SiteFragment
    }
    createdAt
    id
    name
    siteId
    updatedAt
  }
}
Variables
{"id": uuid}
Response
{
  "data": {
    "GroupSet_by_pk": {
      "GroupPlans": [GroupPlan],
      "Groups": [Group],
      "Site": Site,
      "createdAt": timestamptz,
      "id": uuid,
      "name": "abc123",
      "siteId": uuid,
      "updatedAt": timestamptz
    }
  }
}

HolidayByPk

fetch data from the table: "Holiday" using primary key columns
Returns a Holiday

Name Description
id - uuid!

Example

Query
query HolidayByPk($id: uuid!) {
  HolidayByPk(id: $id) {
    Site {
      ...SiteFragment
    }
    id
  }
}
Variables
{"id": uuid}
Response
{
  "data": {
    "HolidayByPk": {
      "Site": Site,
      "id": uuid
    }
  }
}

Holidays

An array relationship
Returns [Holiday!]!

Name Description
distinct_on - [Holiday_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 - [Holiday_order_by!] sort the rows by one or more columns
where - Holiday_bool_exp filter the rows returned

Example

Query
query Holidays($distinct_on: [Holiday_select_column!], $limit: Int, $offset: Int, $order_by: [Holiday_order_by!], $where: Holiday_bool_exp) {
  Holidays(distinct_on: $distinct_on, limit: $limit, offset: $offset, order_by: $order_by, where: $where) {
    Site {
      ...SiteFragment
    }
    id
  }
}
Variables
{
  "distinct_on": [Holiday_select_column],
  "limit": 987,
  "offset": 123,
  "order_by": [Holiday_order_by],
  "where": Holiday_bool_exp
}
Response
{
  "data": {
    "Holidays": [
      {"Site": Site, "id": uuid}
    ]
  }
}

NotificationByPk

fetch data from the table: "Notification" using primary key columns
Returns a Notification

Name Description
id - uuid!

Example

Query
query NotificationByPk($id: uuid!) {
  NotificationByPk(id: $id) {
    NotificationLogs {
      ...NotificationLogFragment
    }
    Site {
      ...SiteFragment
    }
    id
  }
}
Variables
{"id": uuid}
Response
{
  "data": {
    "NotificationByPk": {
      "NotificationLogs": [NotificationLog],
      "Site": Site,
      "id": uuid
    }
  }
}

NotificationLogByPk

fetch data from the table: "NotificationLog" using primary key columns
Returns a NotificationLog

Name Description
id - uuid!

Example

Query
query NotificationLogByPk($id: uuid!) {
  NotificationLogByPk(id: $id) {
    Notification {
      ...NotificationFragment
    }
    Subscription {
      ...SubscriptionFragment
    }
    body
    createdAt
    email
    id
    notificationId
    phoneNumber
    subject
    subscriptionId
    updatedAt
  }
}
Variables
{"id": uuid}
Response
{
  "data": {
    "NotificationLogByPk": {
      "Notification": Notification,
      "Subscription": Subscription,
      "body": "abc123",
      "createdAt": timestamptz,
      "email": "xyz789",
      "id": uuid,
      "notificationId": uuid,
      "phoneNumber": "abc123",
      "subject": "xyz789",
      "subscriptionId": uuid,
      "updatedAt": timestamptz
    }
  }
}

NotificationLogs

An array relationship
Returns [NotificationLog!]!

Name Description
distinct_on - [NotificationLog_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 - [NotificationLog_order_by!] sort the rows by one or more columns
where - NotificationLog_bool_exp filter the rows returned

Example

Query
query NotificationLogs($distinct_on: [NotificationLog_select_column!], $limit: Int, $offset: Int, $order_by: [NotificationLog_order_by!], $where: NotificationLog_bool_exp) {
  NotificationLogs(distinct_on: $distinct_on, limit: $limit, offset: $offset, order_by: $order_by, where: $where) {
    Notification {
      ...NotificationFragment
    }
    Subscription {
      ...SubscriptionFragment
    }
    body
    createdAt
    email
    id
    notificationId
    phoneNumber
    subject
    subscriptionId
    updatedAt
  }
}
Variables
{
  "distinct_on": [NotificationLog_select_column],
  "limit": 123,
  "offset": 987,
  "order_by": [NotificationLog_order_by],
  "where": NotificationLog_bool_exp
}
Response
{
  "data": {
    "NotificationLogs": [
      {
        "Notification": Notification,
        "Subscription": Subscription,
        "body": "xyz789",
        "createdAt": timestamptz,
        "email": "xyz789",
        "id": uuid,
        "notificationId": uuid,
        "phoneNumber": "abc123",
        "subject": "abc123",
        "subscriptionId": uuid,
        "updatedAt": timestamptz
      }
    ]
  }
}

Notifications

An array relationship
Returns [Notification!]!

Name Description
distinct_on - [Notification_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 - [Notification_order_by!] sort the rows by one or more columns
where - Notification_bool_exp filter the rows returned

Example

Query
query Notifications($distinct_on: [Notification_select_column!], $limit: Int, $offset: Int, $order_by: [Notification_order_by!], $where: Notification_bool_exp) {
  Notifications(distinct_on: $distinct_on, limit: $limit, offset: $offset, order_by: $order_by, where: $where) {
    NotificationLogs {
      ...NotificationLogFragment
    }
    Site {
      ...SiteFragment
    }
    id
  }
}
Variables
{
  "distinct_on": [Notification_select_column],
  "limit": 987,
  "offset": 123,
  "order_by": [Notification_order_by],
  "where": Notification_bool_exp
}
Response
{
  "data": {
    "Notifications": [
      {
        "NotificationLogs": [NotificationLog],
        "Site": Site,
        "id": uuid
      }
    ]
  }
}

OrderByPk

fetch data from the table: "Order" using primary key columns
Returns an Order

Name Description
id - uuid!

Example

Query
query OrderByPk($id: uuid!) {
  OrderByPk(id: $id) {
    OrderLineItems {
      ...OrderLineItemFragment
    }
    PrepaidSubscription {
      ...SubscriptionFragment
    }
    ShippingLines {
      ...ShippingLineFragment
    }
    StorefrontUser {
      ...StorefrontUserFragment
    }
    cancelledAt
    createdAt
    deletedAt
    deliveredAt
    id
    note
    platformId
    platformNumber
    storefrontUserId
    updatedAt
  }
}
Variables
{"id": uuid}
Response
{
  "data": {
    "OrderByPk": {
      "OrderLineItems": [OrderLineItem],
      "PrepaidSubscription": Subscription,
      "ShippingLines": [ShippingLine],
      "StorefrontUser": StorefrontUser,
      "cancelledAt": timestamptz,
      "createdAt": timestamptz,
      "deletedAt": timestamptz,
      "deliveredAt": timestamptz,
      "id": uuid,
      "note": "abc123",
      "platformId": "abc123",
      "platformNumber": "abc123",
      "storefrontUserId": uuid,
      "updatedAt": timestamp
    }
  }
}

OrderLineItemByPk

fetch data from the table: "OrderLineItem" using primary key columns
Returns an OrderLineItem

Name Description
id - uuid!

Example

Query
query OrderLineItemByPk($id: uuid!) {
  OrderLineItemByPk(id: $id) {
    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
{"id": uuid}
Response
{
  "data": {
    "OrderLineItemByPk": {
      "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": "xyz789",
      "priceWithoutDiscount": numeric,
      "productVariantId": uuid,
      "quantity": 123,
      "subscriptionLineId": uuid,
      "updatedAt": timestamptz
    }
  }
}

OrderLineItems

An array relationship
Returns [OrderLineItem!]!

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": [OrderLineItem_select_column],
  "limit": 123,
  "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": 123,
        "subscriptionLineId": uuid,
        "updatedAt": timestamptz
      }
    ]
  }
}

Orders

An array relationship
Returns [Order!]!

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
    createdAt
    deletedAt
    deliveredAt
    id
    note
    platformId
    platformNumber
    storefrontUserId
    updatedAt
  }
}
Variables
{
  "distinct_on": [Order_select_column],
  "limit": 123,
  "offset": 123,
  "order_by": [Order_order_by],
  "where": Order_bool_exp
}
Response
{
  "data": {
    "Orders": [
      {
        "OrderLineItems": [OrderLineItem],
        "PrepaidSubscription": Subscription,
        "ShippingLines": [ShippingLine],
        "StorefrontUser": StorefrontUser,
        "cancelledAt": timestamptz,
        "createdAt": timestamptz,
        "deletedAt": timestamptz,
        "deliveredAt": timestamptz,
        "id": uuid,
        "note": "abc123",
        "platformId": "xyz789",
        "platformNumber": "abc123",
        "storefrontUserId": uuid,
        "updatedAt": timestamp
      }
    ]
  }
}

PaymentMethodByPk

fetch data from the table: "PaymentMethod" using primary key columns
Returns a PaymentMethod

Name Description
id - uuid!

Example

Query
query PaymentMethodByPk($id: uuid!) {
  PaymentMethodByPk(id: $id) {
    BillingAddress {
      ...AddressFragment
    }
    StorefrontUser {
      ...StorefrontUserFragment
    }
    Subscriptions {
      ...SubscriptionFragment
    }
    id
  }
}
Variables
{"id": uuid}
Response
{
  "data": {
    "PaymentMethodByPk": {
      "BillingAddress": Address,
      "StorefrontUser": StorefrontUser,
      "Subscriptions": [Subscription],
      "id": uuid
    }
  }
}

PaymentMethods

An array relationship
Returns [PaymentMethod!]!

Name Description
distinct_on - [PaymentMethod_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 - [PaymentMethod_order_by!] sort the rows by one or more columns
where - PaymentMethod_bool_exp filter the rows returned

Example

Query
query PaymentMethods($distinct_on: [PaymentMethod_select_column!], $limit: Int, $offset: Int, $order_by: [PaymentMethod_order_by!], $where: PaymentMethod_bool_exp) {
  PaymentMethods(distinct_on: $distinct_on, limit: $limit, offset: $offset, order_by: $order_by, where: $where) {
    BillingAddress {
      ...AddressFragment
    }
    StorefrontUser {
      ...StorefrontUserFragment
    }
    Subscriptions {
      ...SubscriptionFragment
    }
    id
  }
}
Variables
{
  "distinct_on": [PaymentMethod_select_column],
  "limit": 987,
  "offset": 123,
  "order_by": [PaymentMethod_order_by],
  "where": PaymentMethod_bool_exp
}
Response
{
  "data": {
    "PaymentMethods": [
      {
        "BillingAddress": Address,
        "StorefrontUser": StorefrontUser,
        "Subscriptions": [Subscription],
        "id": uuid
      }
    ]
  }
}

Policies

fetch data from the table: "Policy"
Returns [Policy!]!

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
    maxCycles
    minCycles
    updatedAt
  }
}
Variables
{
  "distinct_on": [Policy_select_column],
  "limit": 987,
  "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,
        "maxCycles": 987,
        "minCycles": 123,
        "updatedAt": timestamptz
      }
    ]
  }
}

PolicyByPk

fetch data from the table: "Policy" using primary key columns
Returns a Policy

Name Description
id - uuid!

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
    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": "xyz789",
      "intervalCount": 987,
      "maxCycles": 987,
      "minCycles": 123,
      "updatedAt": timestamptz
    }
  }
}

PricingPolicies

An array relationship
Returns [PricingPolicy!]!

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
    }
    createdAt
    fixedPrice
    id
    percentageOff
    sellingPlanId
    sellingPlanPricingPolicyAdjustmentType
    updatedAt
  }
}
Variables
{
  "distinct_on": [PricingPolicy_select_column],
  "limit": 123,
  "offset": 123,
  "order_by": [PricingPolicy_order_by],
  "where": PricingPolicy_bool_exp
}
Response
{
  "data": {
    "PricingPolicies": [
      {
        "SellingPlan": SellingPlan,
        "createdAt": timestamptz,
        "fixedPrice": numeric,
        "id": uuid,
        "percentageOff": numeric,
        "sellingPlanId": uuid,
        "sellingPlanPricingPolicyAdjustmentType": "abc123",
        "updatedAt": timestamptz
      }
    ]
  }
}

PricingPolicyByPk

fetch data from the table: "PricingPolicy" using primary key columns
Returns a PricingPolicy

Name Description
id - uuid!

Example

Query
query PricingPolicyByPk($id: uuid!) {
  PricingPolicyByPk(id: $id) {
    SellingPlan {
      ...SellingPlanFragment
    }
    createdAt
    fixedPrice
    id
    percentageOff
    sellingPlanId
    sellingPlanPricingPolicyAdjustmentType
    updatedAt
  }
}
Variables
{"id": uuid}
Response
{
  "data": {
    "PricingPolicyByPk": {
      "SellingPlan": SellingPlan,
      "createdAt": timestamptz,
      "fixedPrice": numeric,
      "id": uuid,
      "percentageOff": numeric,
      "sellingPlanId": uuid,
      "sellingPlanPricingPolicyAdjustmentType": "abc123",
      "updatedAt": timestamptz
    }
  }
}

ProductByPk

fetch data from the table: "Product" using primary key columns
Returns a Product

Name Description
id - uuid!

Example

Query
query ProductByPk($id: uuid!) {
  ProductByPk(id: $id) {
    ProductVariants {
      ...ProductVariantFragment
    }
    Site {
      ...SiteFragment
    }
    createdAt
    deletedAt
    id
    imageSrc
    metafields
    platformId
    siteId
    slug
    smsOrder
    status
    title
    updatedAt
  }
}
Variables
{"id": uuid}
Response
{
  "data": {
    "ProductByPk": {
      "ProductVariants": [ProductVariant],
      "Site": Site,
      "createdAt": timestamptz,
      "deletedAt": timestamptz,
      "id": uuid,
      "imageSrc": "abc123",
      "metafields": jsonb,
      "platformId": "xyz789",
      "siteId": uuid,
      "slug": "abc123",
      "smsOrder": 987,
      "status": "abc123",
      "title": "xyz789",
      "updatedAt": timestamptz
    }
  }
}

Products

An array relationship
Returns [Product!]!

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) {
    ProductVariants {
      ...ProductVariantFragment
    }
    Site {
      ...SiteFragment
    }
    createdAt
    deletedAt
    id
    imageSrc
    metafields
    platformId
    siteId
    slug
    smsOrder
    status
    title
    updatedAt
  }
}
Variables
{
  "distinct_on": [Product_select_column],
  "limit": 123,
  "offset": 987,
  "order_by": [Product_order_by],
  "where": Product_bool_exp
}
Response
{
  "data": {
    "Products": [
      {
        "ProductVariants": [ProductVariant],
        "Site": Site,
        "createdAt": timestamptz,
        "deletedAt": timestamptz,
        "id": uuid,
        "imageSrc": "abc123",
        "metafields": jsonb,
        "platformId": "xyz789",
        "siteId": uuid,
        "slug": "xyz789",
        "smsOrder": 987,
        "status": "xyz789",
        "title": "xyz789",
        "updatedAt": timestamptz
      }
    ]
  }
}

ProductVariantByPk

fetch data from the table: "ProductVariant" using primary key columns
Returns a ProductVariant

Name Description
id - uuid!

Example

Query
query ProductVariantByPk($id: uuid!) {
  ProductVariantByPk(id: $id) {
    OrderLineItems {
      ...OrderLineItemFragment
    }
    Product {
      ...ProductFragment
    }
    SellingPlanGroupResources {
      ...SellingPlanGroupResourceFragment
    }
    SubscriptionLines {
      ...SubscriptionLineFragment
    }
    createdAt
    deletedAt
    id
    image
    platformId
    price
    productId
    sku
    title
    updatedAt
  }
}
Variables
{"id": uuid}
Response
{
  "data": {
    "ProductVariantByPk": {
      "OrderLineItems": [OrderLineItem],
      "Product": Product,
      "SellingPlanGroupResources": [
        SellingPlanGroupResource
      ],
      "SubscriptionLines": [SubscriptionLine],
      "createdAt": timestamptz,
      "deletedAt": timestamptz,
      "id": uuid,
      "image": "abc123",
      "platformId": "xyz789",
      "price": numeric,
      "productId": uuid,
      "sku": "abc123",
      "title": "xyz789",
      "updatedAt": timestamptz
    }
  }
}

ProductVariants

An array relationship
Returns [ProductVariant!]!

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) {
    OrderLineItems {
      ...OrderLineItemFragment
    }
    Product {
      ...ProductFragment
    }
    SellingPlanGroupResources {
      ...SellingPlanGroupResourceFragment
    }
    SubscriptionLines {
      ...SubscriptionLineFragment
    }
    createdAt
    deletedAt
    id
    image
    platformId
    price
    productId
    sku
    title
    updatedAt
  }
}
Variables
{
  "distinct_on": [ProductVariant_select_column],
  "limit": 123,
  "offset": 987,
  "order_by": [ProductVariant_order_by],
  "where": ProductVariant_bool_exp
}
Response
{
  "data": {
    "ProductVariants": [
      {
        "OrderLineItems": [OrderLineItem],
        "Product": Product,
        "SellingPlanGroupResources": [
          SellingPlanGroupResource
        ],
        "SubscriptionLines": [SubscriptionLine],
        "createdAt": timestamptz,
        "deletedAt": timestamptz,
        "id": uuid,
        "image": "xyz789",
        "platformId": "abc123",
        "price": numeric,
        "productId": uuid,
        "sku": "abc123",
        "title": "abc123",
        "updatedAt": timestamptz
      }
    ]
  }
}

SellingPlanByPk

fetch data from the table: "SellingPlan" using primary key columns
Returns a SellingPlan

Name Description
id - uuid!

Example

Query
query SellingPlanByPk($id: uuid!) {
  SellingPlanByPk(id: $id) {
    BillingPolicy {
      ...PolicyFragment
    }
    DeliveryPolicy {
      ...PolicyFragment
    }
    GroupPlans {
      ...GroupPlanFragment
    }
    PrepaidDeliveryPolicy {
      ...PolicyFragment
    }
    PricingPolicies {
      ...PricingPolicyFragment
    }
    SellingPlanGroup {
      ...SellingPlanGroupFragment
    }
    SubscriptionLines {
      ...SubscriptionLineFragment
    }
    billingPolicyId
    createdAt
    deliveryPolicyId
    id
    name
    option
    platformId
    position
    prepaidDeliveryPolicyId
    productVariantIdToSwapToAfterFirstOrder
    sellingPlanGroupId
    updatedAt
  }
}
Variables
{"id": uuid}
Response
{
  "data": {
    "SellingPlanByPk": {
      "BillingPolicy": Policy,
      "DeliveryPolicy": Policy,
      "GroupPlans": [GroupPlan],
      "PrepaidDeliveryPolicy": Policy,
      "PricingPolicies": [PricingPolicy],
      "SellingPlanGroup": SellingPlanGroup,
      "SubscriptionLines": [SubscriptionLine],
      "billingPolicyId": uuid,
      "createdAt": timestamptz,
      "deliveryPolicyId": uuid,
      "id": uuid,
      "name": "abc123",
      "option": "xyz789",
      "platformId": "abc123",
      "position": 987,
      "prepaidDeliveryPolicyId": uuid,
      "productVariantIdToSwapToAfterFirstOrder": "xyz789",
      "sellingPlanGroupId": uuid,
      "updatedAt": timestamptz
    }
  }
}

SellingPlanGroupByPk

fetch data from the table: "SellingPlanGroup" using primary key columns
Returns a SellingPlanGroup

Name Description
id - uuid!

Example

Query
query SellingPlanGroupByPk($id: uuid!) {
  SellingPlanGroupByPk(id: $id) {
    SellingPlanGroupResources {
      ...SellingPlanGroupResourceFragment
    }
    SellingPlans {
      ...SellingPlanFragment
    }
    byGroup
    createdAt
    customName
    id
    name
    platformId
    updatedAt
  }
}
Variables
{"id": uuid}
Response
{
  "data": {
    "SellingPlanGroupByPk": {
      "SellingPlanGroupResources": [
        SellingPlanGroupResource
      ],
      "SellingPlans": [SellingPlan],
      "byGroup": false,
      "createdAt": timestamptz,
      "customName": "abc123",
      "id": uuid,
      "name": "abc123",
      "platformId": "abc123",
      "updatedAt": timestamptz
    }
  }
}

SellingPlanGroupResource

fetch data from the table: "SellingPlanGroupResource" using primary key columns
Returns a SellingPlanGroupResource

Name Description
id - uuid!

Example

Query
query SellingPlanGroupResource($id: uuid!) {
  SellingPlanGroupResource(id: $id) {
    ProductVariant {
      ...ProductVariantFragment
    }
    SellingPlanGroup {
      ...SellingPlanGroupFragment
    }
    createdAt
    id
    productVariantId
    sellingPlanGroupId
    updatedAt
  }
}
Variables
{"id": uuid}
Response
{
  "data": {
    "SellingPlanGroupResource": {
      "ProductVariant": ProductVariant,
      "SellingPlanGroup": SellingPlanGroup,
      "createdAt": timestamptz,
      "id": uuid,
      "productVariantId": uuid,
      "sellingPlanGroupId": uuid,
      "updatedAt": timestamptz
    }
  }
}

SellingPlanGroupResources

An array relationship
Returns [SellingPlanGroupResource!]!

Name Description
distinct_on - [SellingPlanGroupResource_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 - [SellingPlanGroupResource_order_by!] sort the rows by one or more columns
where - SellingPlanGroupResource_bool_exp filter the rows returned

Example

Query
query SellingPlanGroupResources($distinct_on: [SellingPlanGroupResource_select_column!], $limit: Int, $offset: Int, $order_by: [SellingPlanGroupResource_order_by!], $where: SellingPlanGroupResource_bool_exp) {
  SellingPlanGroupResources(distinct_on: $distinct_on, limit: $limit, offset: $offset, order_by: $order_by, where: $where) {
    ProductVariant {
      ...ProductVariantFragment
    }
    SellingPlanGroup {
      ...SellingPlanGroupFragment
    }
    createdAt
    id
    productVariantId
    sellingPlanGroupId
    updatedAt
  }
}
Variables
{
  "distinct_on": [SellingPlanGroupResource_select_column],
  "limit": 123,
  "offset": 123,
  "order_by": [SellingPlanGroupResource_order_by],
  "where": SellingPlanGroupResource_bool_exp
}
Response
{
  "data": {
    "SellingPlanGroupResources": [
      {
        "ProductVariant": ProductVariant,
        "SellingPlanGroup": SellingPlanGroup,
        "createdAt": timestamptz,
        "id": uuid,
        "productVariantId": uuid,
        "sellingPlanGroupId": uuid,
        "updatedAt": timestamptz
      }
    ]
  }
}

SellingPlanGroups

fetch data from the table: "SellingPlanGroup"
Returns [SellingPlanGroup!]!

Name Description
distinct_on - [SellingPlanGroup_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 - [SellingPlanGroup_order_by!] sort the rows by one or more columns
where - SellingPlanGroup_bool_exp filter the rows returned

Example

Query
query SellingPlanGroups($distinct_on: [SellingPlanGroup_select_column!], $limit: Int, $offset: Int, $order_by: [SellingPlanGroup_order_by!], $where: SellingPlanGroup_bool_exp) {
  SellingPlanGroups(distinct_on: $distinct_on, limit: $limit, offset: $offset, order_by: $order_by, where: $where) {
    SellingPlanGroupResources {
      ...SellingPlanGroupResourceFragment
    }
    SellingPlans {
      ...SellingPlanFragment
    }
    byGroup
    createdAt
    customName
    id
    name
    platformId
    updatedAt
  }
}
Variables
{
  "distinct_on": [SellingPlanGroup_select_column],
  "limit": 987,
  "offset": 123,
  "order_by": [SellingPlanGroup_order_by],
  "where": SellingPlanGroup_bool_exp
}
Response
{
  "data": {
    "SellingPlanGroups": [
      {
        "SellingPlanGroupResources": [
          SellingPlanGroupResource
        ],
        "SellingPlans": [SellingPlan],
        "byGroup": true,
        "createdAt": timestamptz,
        "customName": "xyz789",
        "id": uuid,
        "name": "abc123",
        "platformId": "abc123",
        "updatedAt": timestamptz
      }
    ]
  }
}

SellingPlans

An array relationship
Returns [SellingPlan!]!

Name Description
distinct_on - [SellingPlan_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 - [SellingPlan_order_by!] sort the rows by one or more columns
where - SellingPlan_bool_exp filter the rows returned

Example

Query
query SellingPlans($distinct_on: [SellingPlan_select_column!], $limit: Int, $offset: Int, $order_by: [SellingPlan_order_by!], $where: SellingPlan_bool_exp) {
  SellingPlans(distinct_on: $distinct_on, limit: $limit, offset: $offset, order_by: $order_by, where: $where) {
    BillingPolicy {
      ...PolicyFragment
    }
    DeliveryPolicy {
      ...PolicyFragment
    }
    GroupPlans {
      ...GroupPlanFragment
    }
    PrepaidDeliveryPolicy {
      ...PolicyFragment
    }
    PricingPolicies {
      ...PricingPolicyFragment
    }
    SellingPlanGroup {
      ...SellingPlanGroupFragment
    }
    SubscriptionLines {
      ...SubscriptionLineFragment
    }
    billingPolicyId
    createdAt
    deliveryPolicyId
    id
    name
    option
    platformId
    position
    prepaidDeliveryPolicyId
    productVariantIdToSwapToAfterFirstOrder
    sellingPlanGroupId
    updatedAt
  }
}
Variables
{
  "distinct_on": [SellingPlan_select_column],
  "limit": 123,
  "offset": 987,
  "order_by": [SellingPlan_order_by],
  "where": SellingPlan_bool_exp
}
Response
{
  "data": {
    "SellingPlans": [
      {
        "BillingPolicy": Policy,
        "DeliveryPolicy": Policy,
        "GroupPlans": [GroupPlan],
        "PrepaidDeliveryPolicy": Policy,
        "PricingPolicies": [PricingPolicy],
        "SellingPlanGroup": SellingPlanGroup,
        "SubscriptionLines": [SubscriptionLine],
        "billingPolicyId": uuid,
        "createdAt": timestamptz,
        "deliveryPolicyId": uuid,
        "id": uuid,
        "name": "abc123",
        "option": "abc123",
        "platformId": "abc123",
        "position": 123,
        "prepaidDeliveryPolicyId": uuid,
        "productVariantIdToSwapToAfterFirstOrder": "abc123",
        "sellingPlanGroupId": uuid,
        "updatedAt": timestamptz
      }
    ]
  }
}

ShippingLineByPk

fetch data from the table: "ShippingLine" using primary key columns
Returns a ShippingLine

Name Description
id - uuid!

Example

Query
query ShippingLineByPk($id: uuid!) {
  ShippingLineByPk(id: $id) {
    Discounts {
      ...DiscountFragment
    }
    Order {
      ...OrderFragment
    }
    TaxLines {
      ...TaxLineFragment
    }
    createdAt
    id
    orderId
    platformId
    priceWithoutDiscount
    title
    updatedAt
  }
}
Variables
{"id": uuid}
Response
{
  "data": {
    "ShippingLineByPk": {
      "Discounts": [Discount],
      "Order": Order,
      "TaxLines": [TaxLine],
      "createdAt": timestamptz,
      "id": uuid,
      "orderId": uuid,
      "platformId": "abc123",
      "priceWithoutDiscount": numeric,
      "title": "abc123",
      "updatedAt": timestamptz
    }
  }
}

ShippingLines

An array relationship
Returns [ShippingLine!]!

Name Description
distinct_on - [ShippingLine_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 - [ShippingLine_order_by!] sort the rows by one or more columns
where - ShippingLine_bool_exp filter the rows returned

Example

Query
query ShippingLines($distinct_on: [ShippingLine_select_column!], $limit: Int, $offset: Int, $order_by: [ShippingLine_order_by!], $where: ShippingLine_bool_exp) {
  ShippingLines(distinct_on: $distinct_on, limit: $limit, offset: $offset, order_by: $order_by, where: $where) {
    Discounts {
      ...DiscountFragment
    }
    Order {
      ...OrderFragment
    }
    TaxLines {
      ...TaxLineFragment
    }
    createdAt
    id
    orderId
    platformId
    priceWithoutDiscount
    title
    updatedAt
  }
}
Variables
{
  "distinct_on": [ShippingLine_select_column],
  "limit": 987,
  "offset": 987,
  "order_by": [ShippingLine_order_by],
  "where": ShippingLine_bool_exp
}
Response
{
  "data": {
    "ShippingLines": [
      {
        "Discounts": [Discount],
        "Order": Order,
        "TaxLines": [TaxLine],
        "createdAt": timestamptz,
        "id": uuid,
        "orderId": uuid,
        "platformId": "abc123",
        "priceWithoutDiscount": numeric,
        "title": "xyz789",
        "updatedAt": timestamptz
      }
    ]
  }
}

SiteByPk

fetch data from the table: "Site" using primary key columns
Returns a Site

Name Description
id - uuid!

Example

Query
query SiteByPk($id: uuid!) {
  SiteByPk(id: $id) {
    Holidays {
      ...HolidayFragment
    }
    Notifications {
      ...NotificationFragment
    }
    Products {
      ...ProductFragment
    }
    StorefrontUsers {
      ...StorefrontUserFragment
    }
    Theme {
      ...ThemeFragment
    }
    Theme2 {
      ...Theme2Fragment
    }
    id
  }
}
Variables
{"id": uuid}
Response
{
  "data": {
    "SiteByPk": {
      "Holidays": [Holiday],
      "Notifications": [Notification],
      "Products": [Product],
      "StorefrontUsers": [StorefrontUser],
      "Theme": Theme,
      "Theme2": Theme2,
      "id": uuid
    }
  }
}

Sites

fetch data from the table: "Site"
Returns [Site!]!

Name Description
distinct_on - [Site_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 - [Site_order_by!] sort the rows by one or more columns
where - Site_bool_exp filter the rows returned

Example

Query
query Sites($distinct_on: [Site_select_column!], $limit: Int, $offset: Int, $order_by: [Site_order_by!], $where: Site_bool_exp) {
  Sites(distinct_on: $distinct_on, limit: $limit, offset: $offset, order_by: $order_by, where: $where) {
    Holidays {
      ...HolidayFragment
    }
    Notifications {
      ...NotificationFragment
    }
    Products {
      ...ProductFragment
    }
    StorefrontUsers {
      ...StorefrontUserFragment
    }
    Theme {
      ...ThemeFragment
    }
    Theme2 {
      ...Theme2Fragment
    }
    id
  }
}
Variables
{
  "distinct_on": [Site_select_column],
  "limit": 987,
  "offset": 987,
  "order_by": [Site_order_by],
  "where": Site_bool_exp
}
Response
{
  "data": {
    "Sites": [
      {
        "Holidays": [Holiday],
        "Notifications": [Notification],
        "Products": [Product],
        "StorefrontUsers": [StorefrontUser],
        "Theme": Theme,
        "Theme2": Theme2,
        "id": uuid
      }
    ]
  }
}

SkuSwapByPk

fetch data from the table: "SkuSwap" using primary key columns
Returns a SkuSwap

Name Description
id - uuid!

Example

Query
query SkuSwapByPk($id: uuid!) {
  SkuSwapByPk(id: $id) {
    SellingPlan {
      ...SellingPlanFragment
    }
    afterOrderNumber
    createdAt
    id
    newPrice
    overrideDaysToNextBilling
    productVariantFromPlatformId
    productVariantPlatformId
    sellingPlanId
    siteId
    sku
    updatedAt
  }
}
Variables
{"id": uuid}
Response
{
  "data": {
    "SkuSwapByPk": {
      "SellingPlan": SellingPlan,
      "afterOrderNumber": 123,
      "createdAt": timestamptz,
      "id": uuid,
      "newPrice": numeric,
      "overrideDaysToNextBilling": 123,
      "productVariantFromPlatformId": "xyz789",
      "productVariantPlatformId": "xyz789",
      "sellingPlanId": uuid,
      "siteId": uuid,
      "sku": "abc123",
      "updatedAt": timestamptz
    }
  }
}

SkuSwaps

fetch data from the table: "SkuSwap"
Returns [SkuSwap!]!

Name Description
distinct_on - [SkuSwap_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 - [SkuSwap_order_by!] sort the rows by one or more columns
where - SkuSwap_bool_exp filter the rows returned

Example

Query
query SkuSwaps($distinct_on: [SkuSwap_select_column!], $limit: Int, $offset: Int, $order_by: [SkuSwap_order_by!], $where: SkuSwap_bool_exp) {
  SkuSwaps(distinct_on: $distinct_on, limit: $limit, offset: $offset, order_by: $order_by, where: $where) {
    SellingPlan {
      ...SellingPlanFragment
    }
    afterOrderNumber
    createdAt
    id
    newPrice
    overrideDaysToNextBilling
    productVariantFromPlatformId
    productVariantPlatformId
    sellingPlanId
    siteId
    sku
    updatedAt
  }
}
Variables
{
  "distinct_on": [SkuSwap_select_column],
  "limit": 123,
  "offset": 987,
  "order_by": [SkuSwap_order_by],
  "where": SkuSwap_bool_exp
}
Response
{
  "data": {
    "SkuSwaps": [
      {
        "SellingPlan": SellingPlan,
        "afterOrderNumber": 987,
        "createdAt": timestamptz,
        "id": uuid,
        "newPrice": numeric,
        "overrideDaysToNextBilling": 987,
        "productVariantFromPlatformId": "xyz789",
        "productVariantPlatformId": "xyz789",
        "sellingPlanId": uuid,
        "siteId": uuid,
        "sku": "xyz789",
        "updatedAt": timestamptz
      }
    ]
  }
}

StorefrontUserByPk

fetch data from the table: "StorefrontUser" using primary key columns
Returns a StorefrontUser

Name Description
id - uuid!

Example

Query
query StorefrontUserByPk($id: uuid!) {
  StorefrontUserByPk(id: $id) {
    Orders {
      ...OrderFragment
    }
    PaymentMethods {
      ...PaymentMethodFragment
    }
    ShippingAddresses {
      ...AddressFragment
    }
    Site {
      ...SiteFragment
    }
    Subscriptions {
      ...SubscriptionFragment
    }
    User {
      ...UserFragment
    }
    createdAt
    email
    firstName
    id
    lastName
    phoneNumber
    platformId
    siteId
    updatedAt
  }
}
Variables
{"id": uuid}
Response
{
  "data": {
    "StorefrontUserByPk": {
      "Orders": [Order],
      "PaymentMethods": [PaymentMethod],
      "ShippingAddresses": [Address],
      "Site": Site,
      "Subscriptions": [Subscription],
      "User": User,
      "createdAt": timestamptz,
      "email": "xyz789",
      "firstName": "xyz789",
      "id": uuid,
      "lastName": "abc123",
      "phoneNumber": "xyz789",
      "platformId": "xyz789",
      "siteId": uuid,
      "updatedAt": timestamptz
    }
  }
}

StorefrontUsers

An array relationship
Returns [StorefrontUser!]!

Name Description
distinct_on - [StorefrontUser_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 - [StorefrontUser_order_by!] sort the rows by one or more columns
where - StorefrontUser_bool_exp filter the rows returned

Example

Query
query StorefrontUsers($distinct_on: [StorefrontUser_select_column!], $limit: Int, $offset: Int, $order_by: [StorefrontUser_order_by!], $where: StorefrontUser_bool_exp) {
  StorefrontUsers(distinct_on: $distinct_on, limit: $limit, offset: $offset, order_by: $order_by, where: $where) {
    Orders {
      ...OrderFragment
    }
    PaymentMethods {
      ...PaymentMethodFragment
    }
    ShippingAddresses {
      ...AddressFragment
    }
    Site {
      ...SiteFragment
    }
    Subscriptions {
      ...SubscriptionFragment
    }
    User {
      ...UserFragment
    }
    createdAt
    email
    firstName
    id
    lastName
    phoneNumber
    platformId
    siteId
    updatedAt
  }
}
Variables
{
  "distinct_on": [StorefrontUser_select_column],
  "limit": 123,
  "offset": 987,
  "order_by": [StorefrontUser_order_by],
  "where": StorefrontUser_bool_exp
}
Response
{
  "data": {
    "StorefrontUsers": [
      {
        "Orders": [Order],
        "PaymentMethods": [PaymentMethod],
        "ShippingAddresses": [Address],
        "Site": Site,
        "Subscriptions": [Subscription],
        "User": User,
        "createdAt": timestamptz,
        "email": "xyz789",
        "firstName": "xyz789",
        "id": uuid,
        "lastName": "abc123",
        "phoneNumber": "abc123",
        "platformId": "abc123",
        "siteId": uuid,
        "updatedAt": timestamptz
      }
    ]
  }
}

SubscriptionByPk

fetch data from the table: "Subscription" using primary key columns
Returns a Subscription

Name Description
id - uuid!

Example

Query
query SubscriptionByPk($id: uuid!) {
  SubscriptionByPk(id: $id) {
    AuditLogs {
      ...AuditLogFragment
    }
    BillingPolicy {
      ...PolicyFragment
    }
    CancelFlowSessions {
      ...CancelFlowSessionFragment
    }
    DeliveryPolicy {
      ...PolicyFragment
    }
    Discounts {
      ...DiscountFragment
    }
    FulfillmentOrders {
      ...OrderFragment
    }
    NotificationLogs {
      ...NotificationLogFragment
    }
    PaymentMethod {
      ...PaymentMethodFragment
    }
    PrepaidDeliveryPolicy {
      ...PolicyFragment
    }
    PrepaidSubscriptionLines {
      ...SubscriptionLineFragment
    }
    ShippingAddress {
      ...AddressFragment
    }
    StorefrontUser {
      ...StorefrontUserFragment
    }
    SubscriptionLines {
      ...SubscriptionLineFragment
    }
    billingPolicyId
    cancelledAt
    createdAt
    currencyCode
    customAttributes
    cyclesCompleted
    deliveryPolicyId
    deliveryPrice
    id
    lastBillingAttemptAt
    nextBillingDate
    platformId
    prepaidDeliveryPolicyId
    prepaidProductPricesPerDelivery
    shippingAddressId
    status
    statusContext
    storefrontUserId
    updatedAt
  }
}
Variables
{"id": uuid}
Response
{
  "data": {
    "SubscriptionByPk": {
      "AuditLogs": [AuditLog],
      "BillingPolicy": Policy,
      "CancelFlowSessions": [CancelFlowSession],
      "DeliveryPolicy": Policy,
      "Discounts": [Discount],
      "FulfillmentOrders": [Order],
      "NotificationLogs": [NotificationLog],
      "PaymentMethod": PaymentMethod,
      "PrepaidDeliveryPolicy": Policy,
      "PrepaidSubscriptionLines": [SubscriptionLine],
      "ShippingAddress": Address,
      "StorefrontUser": StorefrontUser,
      "SubscriptionLines": [SubscriptionLine],
      "billingPolicyId": uuid,
      "cancelledAt": timestamptz,
      "createdAt": timestamptz,
      "currencyCode": "xyz789",
      "customAttributes": jsonb,
      "cyclesCompleted": 123,
      "deliveryPolicyId": uuid,
      "deliveryPrice": numeric,
      "id": uuid,
      "lastBillingAttemptAt": timestamptz,
      "nextBillingDate": timestamptz,
      "platformId": "xyz789",
      "prepaidDeliveryPolicyId": uuid,
      "prepaidProductPricesPerDelivery": jsonb,
      "shippingAddressId": uuid,
      "status": "abc123",
      "statusContext": "xyz789",
      "storefrontUserId": uuid,
      "updatedAt": timestamptz
    }
  }
}

SubscriptionLineByPk

fetch data from the table: "SubscriptionLine" using primary key columns
Returns a SubscriptionLine

Name Description
id - uuid!

Example

Query
query SubscriptionLineByPk($id: uuid!) {
  SubscriptionLineByPk(id: $id) {
    Discounts {
      ...DiscountFragment
    }
    Group {
      ...GroupFragment
    }
    OrderLineItems {
      ...OrderLineItemFragment
    }
    OriginalSellingPlan {
      ...SellingPlanFragment
    }
    PrepaidSubscription {
      ...SubscriptionFragment
    }
    ProductVariant {
      ...ProductVariantFragment
    }
    Subscription {
      ...SubscriptionFragment
    }
    createdAt
    customAttributes
    groupId
    id
    ordersRemaining
    platformId
    priceWithoutDiscount
    productVariantId
    quantity
    removedAt
    sellingPlanId
    subscriptionId
    taxable
    updatedAt
  }
}
Variables
{"id": uuid}
Response
{
  "data": {
    "SubscriptionLineByPk": {
      "Discounts": [Discount],
      "Group": Group,
      "OrderLineItems": [OrderLineItem],
      "OriginalSellingPlan": SellingPlan,
      "PrepaidSubscription": Subscription,
      "ProductVariant": ProductVariant,
      "Subscription": Subscription,
      "createdAt": timestamptz,
      "customAttributes": jsonb,
      "groupId": uuid,
      "id": uuid,
      "ordersRemaining": 987,
      "platformId": "xyz789",
      "priceWithoutDiscount": numeric,
      "productVariantId": uuid,
      "quantity": 123,
      "removedAt": timestamptz,
      "sellingPlanId": uuid,
      "subscriptionId": uuid,
      "taxable": false,
      "updatedAt": timestamptz
    }
  }
}

SubscriptionLines

An array relationship
Returns [SubscriptionLine!]!

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
    priceWithoutDiscount
    productVariantId
    quantity
    removedAt
    sellingPlanId
    subscriptionId
    taxable
    updatedAt
  }
}
Variables
{
  "distinct_on": [SubscriptionLine_select_column],
  "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": 123,
        "platformId": "abc123",
        "priceWithoutDiscount": numeric,
        "productVariantId": uuid,
        "quantity": 123,
        "removedAt": timestamptz,
        "sellingPlanId": uuid,
        "subscriptionId": uuid,
        "taxable": true,
        "updatedAt": timestamptz
      }
    ]
  }
}

Subscriptions

An array relationship
Returns [Subscription!]!

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
    }
    DeliveryPolicy {
      ...PolicyFragment
    }
    Discounts {
      ...DiscountFragment
    }
    FulfillmentOrders {
      ...OrderFragment
    }
    NotificationLogs {
      ...NotificationLogFragment
    }
    PaymentMethod {
      ...PaymentMethodFragment
    }
    PrepaidDeliveryPolicy {
      ...PolicyFragment
    }
    PrepaidSubscriptionLines {
      ...SubscriptionLineFragment
    }
    ShippingAddress {
      ...AddressFragment
    }
    StorefrontUser {
      ...StorefrontUserFragment
    }
    SubscriptionLines {
      ...SubscriptionLineFragment
    }
    billingPolicyId
    cancelledAt
    createdAt
    currencyCode
    customAttributes
    cyclesCompleted
    deliveryPolicyId
    deliveryPrice
    id
    lastBillingAttemptAt
    nextBillingDate
    platformId
    prepaidDeliveryPolicyId
    prepaidProductPricesPerDelivery
    shippingAddressId
    status
    statusContext
    storefrontUserId
    updatedAt
  }
}
Variables
{
  "distinct_on": [Subscription_select_column],
  "limit": 123,
  "offset": 123,
  "order_by": [Subscription_order_by],
  "where": Subscription_bool_exp
}
Response
{
  "data": {
    "Subscriptions": [
      {
        "AuditLogs": [AuditLog],
        "BillingPolicy": Policy,
        "CancelFlowSessions": [CancelFlowSession],
        "DeliveryPolicy": Policy,
        "Discounts": [Discount],
        "FulfillmentOrders": [Order],
        "NotificationLogs": [NotificationLog],
        "PaymentMethod": PaymentMethod,
        "PrepaidDeliveryPolicy": Policy,
        "PrepaidSubscriptionLines": [SubscriptionLine],
        "ShippingAddress": Address,
        "StorefrontUser": StorefrontUser,
        "SubscriptionLines": [SubscriptionLine],
        "billingPolicyId": uuid,
        "cancelledAt": timestamptz,
        "createdAt": timestamptz,
        "currencyCode": "abc123",
        "customAttributes": jsonb,
        "cyclesCompleted": 123,
        "deliveryPolicyId": uuid,
        "deliveryPrice": numeric,
        "id": uuid,
        "lastBillingAttemptAt": timestamptz,
        "nextBillingDate": timestamptz,
        "platformId": "abc123",
        "prepaidDeliveryPolicyId": uuid,
        "prepaidProductPricesPerDelivery": jsonb,
        "shippingAddressId": uuid,
        "status": "abc123",
        "statusContext": "xyz789",
        "storefrontUserId": uuid,
        "updatedAt": timestamptz
      }
    ]
  }
}

TaxLineByPk

fetch data from the table: "TaxLine" using primary key columns
Returns a TaxLine

Name Description
id - uuid!

Example

Query
query TaxLineByPk($id: uuid!) {
  TaxLineByPk(id: $id) {
    OrderLineItem {
      ...OrderLineItemFragment
    }
    ShippingLine {
      ...ShippingLineFragment
    }
    createdAt
    id
    orderLineItemId
    price
    rate
    shippingLineId
    title
    updatedAt
  }
}
Variables
{"id": uuid}
Response
{
  "data": {
    "TaxLineByPk": {
      "OrderLineItem": OrderLineItem,
      "ShippingLine": ShippingLine,
      "createdAt": timestamptz,
      "id": uuid,
      "orderLineItemId": uuid,
      "price": numeric,
      "rate": numeric,
      "shippingLineId": uuid,
      "title": "abc123",
      "updatedAt": timestamptz
    }
  }
}

TaxLines

An array relationship
Returns [TaxLine!]!

Name Description
distinct_on - [TaxLine_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 - [TaxLine_order_by!] sort the rows by one or more columns
where - TaxLine_bool_exp filter the rows returned

Example

Query
query TaxLines($distinct_on: [TaxLine_select_column!], $limit: Int, $offset: Int, $order_by: [TaxLine_order_by!], $where: TaxLine_bool_exp) {
  TaxLines(distinct_on: $distinct_on, limit: $limit, offset: $offset, order_by: $order_by, where: $where) {
    OrderLineItem {
      ...OrderLineItemFragment
    }
    ShippingLine {
      ...ShippingLineFragment
    }
    createdAt
    id
    orderLineItemId
    price
    rate
    shippingLineId
    title
    updatedAt
  }
}
Variables
{
  "distinct_on": [TaxLine_select_column],
  "limit": 987,
  "offset": 123,
  "order_by": [TaxLine_order_by],
  "where": TaxLine_bool_exp
}
Response
{
  "data": {
    "TaxLines": [
      {
        "OrderLineItem": OrderLineItem,
        "ShippingLine": ShippingLine,
        "createdAt": timestamptz,
        "id": uuid,
        "orderLineItemId": uuid,
        "price": numeric,
        "rate": numeric,
        "shippingLineId": uuid,
        "title": "abc123",
        "updatedAt": timestamptz
      }
    ]
  }
}

Theme2

fetch data from the table: "Theme2"
Returns [Theme2!]!

Name Description
distinct_on - [Theme2_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 - [Theme2_order_by!] sort the rows by one or more columns
where - Theme2_bool_exp filter the rows returned

Example

Query
query Theme2($distinct_on: [Theme2_select_column!], $limit: Int, $offset: Int, $order_by: [Theme2_order_by!], $where: Theme2_bool_exp) {
  Theme2(distinct_on: $distinct_on, limit: $limit, offset: $offset, order_by: $order_by, where: $where) {
    Site {
      ...SiteFragment
    }
    badgeBGColor
    badgeTextColor
    buttonBGColor
    buttonBorderRadius
    buttonTextColor
    cardBorderRadius
    cardBorderWidth
    id
    siteId
    tagBGColor
    tagBorderRadius
    tagTextColor
    textAnchorColor
    updated_at
  }
}
Variables
{
  "distinct_on": [Theme2_select_column],
  "limit": 123,
  "offset": 123,
  "order_by": [Theme2_order_by],
  "where": Theme2_bool_exp
}
Response
{
  "data": {
    "Theme2": [
      {
        "Site": Site,
        "badgeBGColor": "xyz789",
        "badgeTextColor": "xyz789",
        "buttonBGColor": "abc123",
        "buttonBorderRadius": numeric,
        "buttonTextColor": "abc123",
        "cardBorderRadius": numeric,
        "cardBorderWidth": numeric,
        "id": uuid,
        "siteId": uuid,
        "tagBGColor": "xyz789",
        "tagBorderRadius": numeric,
        "tagTextColor": "xyz789",
        "textAnchorColor": "xyz789",
        "updated_at": timestamptz
      }
    ]
  }
}

Theme2_by_pk

fetch data from the table: "Theme2" using primary key columns
Returns a Theme2

Name Description
id - uuid!

Example

Query
query Theme2_by_pk($id: uuid!) {
  Theme2_by_pk(id: $id) {
    Site {
      ...SiteFragment
    }
    badgeBGColor
    badgeTextColor
    buttonBGColor
    buttonBorderRadius
    buttonTextColor
    cardBorderRadius
    cardBorderWidth
    id
    siteId
    tagBGColor
    tagBorderRadius
    tagTextColor
    textAnchorColor
    updated_at
  }
}
Variables
{"id": uuid}
Response
{
  "data": {
    "Theme2_by_pk": {
      "Site": Site,
      "badgeBGColor": "abc123",
      "badgeTextColor": "xyz789",
      "buttonBGColor": "xyz789",
      "buttonBorderRadius": numeric,
      "buttonTextColor": "abc123",
      "cardBorderRadius": numeric,
      "cardBorderWidth": numeric,
      "id": uuid,
      "siteId": uuid,
      "tagBGColor": "xyz789",
      "tagBorderRadius": numeric,
      "tagTextColor": "xyz789",
      "textAnchorColor": "abc123",
      "updated_at": timestamptz
    }
  }
}

ThemeByPk

fetch data from the table: "Theme" using primary key columns
Returns a Theme

Name Description
id - uuid!

Example

Query
query ThemeByPk($id: uuid!) {
  ThemeByPk(id: $id) {
    Site {
      ...SiteFragment
    }
    id
  }
}
Variables
{"id": uuid}
Response
{
  "data": {
    "ThemeByPk": {
      "Site": Site,
      "id": uuid
    }
  }
}

Themes

fetch data from the table: "Theme"
Returns [Theme!]!

Name Description
distinct_on - [Theme_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 - [Theme_order_by!] sort the rows by one or more columns
where - Theme_bool_exp filter the rows returned

Example

Query
query Themes($distinct_on: [Theme_select_column!], $limit: Int, $offset: Int, $order_by: [Theme_order_by!], $where: Theme_bool_exp) {
  Themes(distinct_on: $distinct_on, limit: $limit, offset: $offset, order_by: $order_by, where: $where) {
    Site {
      ...SiteFragment
    }
    id
  }
}
Variables
{
  "distinct_on": [Theme_select_column],
  "limit": 123,
  "offset": 987,
  "order_by": [Theme_order_by],
  "where": Theme_bool_exp
}
Response
{
  "data": {
    "Themes": [
      {"Site": Site, "id": uuid}
    ]
  }
}

UserByPk

fetch data from the table: "User" using primary key columns
Returns a User

Name Description
id - uuid!

Example

Query
query UserByPk($id: uuid!) {
  UserByPk(id: $id) {
    StorefrontUsers {
      ...StorefrontUserFragment
    }
    id
  }
}
Variables
{"id": uuid}
Response
{
  "data": {
    "UserByPk": {
      "StorefrontUsers": [StorefrontUser],
      "id": uuid
    }
  }
}

Users

fetch data from the table: "User"
Returns [User!]!

Name Description
distinct_on - [User_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 - [User_order_by!] sort the rows by one or more columns
where - User_bool_exp filter the rows returned

Example

Query
query Users($distinct_on: [User_select_column!], $limit: Int, $offset: Int, $order_by: [User_order_by!], $where: User_bool_exp) {
  Users(distinct_on: $distinct_on, limit: $limit, offset: $offset, order_by: $order_by, where: $where) {
    StorefrontUsers {
      ...StorefrontUserFragment
    }
    id
  }
}
Variables
{
  "distinct_on": [User_select_column],
  "limit": 123,
  "offset": 123,
  "order_by": [User_order_by],
  "where": User_bool_exp
}
Response
{
  "data": {
    "Users": [
      {
        "StorefrontUsers": [StorefrontUser],
        "id": uuid
      }
    ]
  }
}

Mutations

mutation root

applyDiscountCode

Apply a discount code on a subscription
Returns an ApplyDiscountCodeOutput

Name Description
input - ApplyDiscountCodeInput!

Example

Query
mutation applyDiscountCode($input: ApplyDiscountCodeInput!) {
  applyDiscountCode(input: $input) {
    message
    ok
  }
}
Variables
{"input": ApplyDiscountCodeInput}
Response
{"data": {"applyDiscountCode": {"message": "abc123", "ok": true}}}

updateNextBillingDate

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
Returns an UpdateNextBillingDateOutput

Name Description
input - UpdateNextBillingDateInput!

Example

Query
mutation updateNextBillingDate($input: UpdateNextBillingDateInput!) {
  updateNextBillingDate(input: $input) {
    message
    ok
  }
}
Variables
{"input": UpdateNextBillingDateInput}
Response
{"data": {"updateNextBillingDate": {"message": "xyz789", "ok": false}}}

Types

Address

first/last nullable for billing fields

Field Name Description
PaymentMethod - PaymentMethod An object relationship
StorefrontUser - StorefrontUser! An object relationship
Subscriptions - [Subscription!]! An array relationship

Arguments

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

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": "xyz789",
  "company": "xyz789",
  "country": "xyz789",
  "createdAt": timestamptz,
  "doorCode": "abc123",
  "firstName": "xyz789",
  "id": uuid,
  "lastName": "xyz789",
  "phoneNumber": "abc123",
  "platformId": "abc123",
  "province": "xyz789",
  "storefrontUserId": uuid,
  "updatedAt": timestamptz,
  "zip": "abc123"
}

Address_aggregate_order_by

order by aggregate values of table "Address"

Input Field Description
count - order_by
max - Address_max_order_by
min - Address_min_order_by
Example
{
  "count": order_by,
  "max": Address_max_order_by,
  "min": Address_min_order_by
}

Address_bool_exp

Boolean expression to filter rows from the table "Address". All fields are combined with a logical 'AND'.

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

order by max() on columns of table "Address"

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

Address_min_order_by

order by min() on columns of table "Address"

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

Address_order_by

Ordering options when selecting data from "Address".

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

Address_select_column

select columns of table "Address"

Enum Value Description

address1

column name

address2

column name

city

column name

company

column name

country

column name

createdAt

column name

doorCode

column name

firstName

column name

id

column name

lastName

column name

phoneNumber

column name

platformId

column name

province

column name

storefrontUserId

column name

updatedAt

column name

zip

column name

Anchor

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

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

Anchor_aggregate_order_by

order by aggregate values of table "Anchor"

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

Anchor_avg_order_by

order by avg() on columns of table "Anchor"

Input Field Description
cutoffDay - order_by
day - order_by
month - order_by
Example
{
  "cutoffDay": order_by,
  "day": order_by,
  "month": order_by
}

Anchor_bool_exp

Boolean expression to filter rows from the table "Anchor". All fields are combined with a logical 'AND'.

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
month - Int_comparison_exp
policyId - uuid_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,
  "month": Int_comparison_exp,
  "policyId": uuid_comparison_exp,
  "type": String_comparison_exp,
  "updatedAt": timestamptz_comparison_exp
}

Anchor_max_order_by

order by max() on columns of table "Anchor"

Input Field Description
createdAt - order_by
cutoffDay - order_by
day - order_by
id - order_by
month - order_by
policyId - order_by
type - order_by
updatedAt - order_by
Example
{
  "createdAt": order_by,
  "cutoffDay": order_by,
  "day": order_by,
  "id": order_by,
  "month": order_by,
  "policyId": order_by,
  "type": order_by,
  "updatedAt": order_by
}

Anchor_min_order_by

order by min() on columns of table "Anchor"

Input Field Description
createdAt - order_by
cutoffDay - order_by
day - order_by
id - order_by
month - order_by
policyId - order_by
type - order_by
updatedAt - order_by
Example
{
  "createdAt": order_by,
  "cutoffDay": order_by,
  "day": order_by,
  "id": order_by,
  "month": order_by,
  "policyId": order_by,
  "type": order_by,
  "updatedAt": order_by
}

Anchor_order_by

Ordering options when selecting data from "Anchor".

Input Field Description
Policy - Policy_order_by
createdAt - order_by
cutoffDay - order_by
day - order_by
id - order_by
month - order_by
policyId - order_by
type - order_by
updatedAt - order_by
Example
{
  "Policy": Policy_order_by,
  "createdAt": order_by,
  "cutoffDay": order_by,
  "day": order_by,
  "id": order_by,
  "month": order_by,
  "policyId": order_by,
  "type": order_by,
  "updatedAt": order_by
}

Anchor_select_column

select columns of table "Anchor"

Enum Value Description

createdAt

column name

cutoffDay

column name

day

column name

id

column name

month

column name

policyId

column name

type

column name

updatedAt

column name

Anchor_stddev_order_by

order by stddev() on columns of table "Anchor"

Input Field Description
cutoffDay - order_by
day - order_by
month - order_by
Example
{
  "cutoffDay": order_by,
  "day": order_by,
  "month": order_by
}

Anchor_stddev_pop_order_by

order by stddev_pop() on columns of table "Anchor"

Input Field Description
cutoffDay - order_by
day - order_by
month - order_by
Example
{
  "cutoffDay": order_by,
  "day": order_by,
  "month": order_by
}

Anchor_stddev_samp_order_by

order by stddev_samp() on columns of table "Anchor"

Input Field Description
cutoffDay - order_by
day - order_by
month - order_by
Example
{
  "cutoffDay": order_by,
  "day": order_by,
  "month": order_by
}

Anchor_sum_order_by

order by sum() on columns of table "Anchor"

Input Field Description
cutoffDay - order_by
day - order_by
month - order_by
Example
{
  "cutoffDay": order_by,
  "day": order_by,
  "month": order_by
}

Anchor_var_pop_order_by

order by var_pop() on columns of table "Anchor"

Input Field Description
cutoffDay - order_by
day - order_by
month - order_by
Example
{
  "cutoffDay": order_by,
  "day": order_by,
  "month": order_by
}

Anchor_var_samp_order_by

order by var_samp() on columns of table "Anchor"

Input Field Description
cutoffDay - order_by
day - order_by
month - order_by
Example
{
  "cutoffDay": order_by,
  "day": order_by,
  "month": order_by
}

Anchor_variance_order_by

order by variance() on columns of table "Anchor"

Input Field Description
cutoffDay - order_by
day - order_by
month - order_by
Example
{
  "cutoffDay": order_by,
  "day": order_by,
  "month": order_by
}

ApplyDiscountCodeInput

Input Field Description
code - String!
subscriptionId - uuid!
Example
{"code": "xyz789", "subscriptionId": uuid}

ApplyDiscountCodeOutput

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

AuditLog

columns and relationships of "AuditLog"

Field Name Description
StorefrontUser - StorefrontUser An object relationship
Subscription - Subscription An object relationship
createdAt - timestamptz!
eventData - jsonb!

Arguments

path - String

JSON select path

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

order by aggregate values of table "AuditLog"

Input Field Description
count - order_by
max - AuditLog_max_order_by
min - AuditLog_min_order_by
Example
{
  "count": order_by,
  "max": AuditLog_max_order_by,
  "min": AuditLog_min_order_by
}

AuditLog_bool_exp

Boolean expression to filter rows from the table "AuditLog". All fields are combined with a logical 'AND'.

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

order by max() on columns of table "AuditLog"

Input Field Description
createdAt - order_by
eventType - order_by
id - order_by
storefrontUserId - order_by
subscriptionId - order_by
updatedAt - order_by
Example
{
  "createdAt": order_by,
  "eventType": order_by,
  "id": order_by,
  "storefrontUserId": order_by,
  "subscriptionId": order_by,
  "updatedAt": order_by
}

AuditLog_min_order_by

order by min() on columns of table "AuditLog"

Input Field Description
createdAt - order_by
eventType - order_by
id - order_by
storefrontUserId - order_by
subscriptionId - order_by
updatedAt - order_by
Example
{
  "createdAt": order_by,
  "eventType": order_by,
  "id": order_by,
  "storefrontUserId": order_by,
  "subscriptionId": order_by,
  "updatedAt": order_by
}

AuditLog_order_by

Ordering options when selecting data from "AuditLog".

Input Field Description
StorefrontUser - StorefrontUser_order_by
Subscription - Subscription_order_by
createdAt - order_by
eventData - order_by
eventType - order_by
id - order_by
storefrontUserId - order_by
subscriptionId - order_by
updatedAt - order_by
Example
{
  "StorefrontUser": StorefrontUser_order_by,
  "Subscription": Subscription_order_by,
  "createdAt": order_by,
  "eventData": order_by,
  "eventType": order_by,
  "id": order_by,
  "storefrontUserId": order_by,
  "subscriptionId": order_by,
  "updatedAt": order_by
}

AuditLog_select_column

select columns of table "AuditLog"

Enum Value Description

createdAt

column name

eventData

column name

eventType

column name

id

column name

storefrontUserId

column name

subscriptionId

column name

updatedAt

column name

BillingAttempt

columns and relationships of "BillingAttempt"

Field Name Description
Order - Order An object relationship
Subscription - Subscription! An object relationship
billingAttemptedAt - timestamptz!
createdAt - timestamptz!
errorCode - String
errorMessage - String
id - uuid!
orderId - uuid
orderPlatformId - String
platformId - String!
subscriptionBillingDate - timestamptz
subscriptionId - uuid!
updatedAt - timestamptz!
Example
{
  "Order": Order,
  "Subscription": Subscription,
  "billingAttemptedAt": timestamptz,
  "createdAt": timestamptz,
  "errorCode": "abc123",
  "errorMessage": "abc123",
  "id": uuid,
  "orderId": uuid,
  "orderPlatformId": "abc123",
  "platformId": "xyz789",
  "subscriptionBillingDate": timestamptz,
  "subscriptionId": uuid,
  "updatedAt": timestamptz
}

BillingAttempt_bool_exp

Boolean expression to filter rows from the table "BillingAttempt". All fields are combined with a logical 'AND'.

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
}

BillingAttempt_order_by

Ordering options when selecting data from "BillingAttempt".

Input Field Description
Order - Order_order_by
Subscription - Subscription_order_by
billingAttemptedAt - order_by
createdAt - order_by
errorCode - order_by
errorMessage - order_by
id - order_by
orderId - order_by
orderPlatformId - order_by
platformId - order_by
subscriptionBillingDate - order_by
subscriptionId - order_by
updatedAt - order_by
Example
{
  "Order": Order_order_by,
  "Subscription": Subscription_order_by,
  "billingAttemptedAt": order_by,
  "createdAt": order_by,
  "errorCode": order_by,
  "errorMessage": order_by,
  "id": order_by,
  "orderId": order_by,
  "orderPlatformId": order_by,
  "platformId": order_by,
  "subscriptionBillingDate": order_by,
  "subscriptionId": order_by,
  "updatedAt": order_by
}

BillingAttempt_select_column

select columns of table "BillingAttempt"

Enum Value Description

billingAttemptedAt

column name

createdAt

column name

errorCode

column name

errorMessage

column name

id

column name

orderId

column name

orderPlatformId

column name

platformId

column name

subscriptionBillingDate

column name

subscriptionId

column name

updatedAt

column name

Boolean

Example
true

Boolean_comparison_exp

Boolean expression to compare columns of type "Boolean". All fields are combined with logical 'AND'.

Input Field Description
_eq - Boolean
_gt - Boolean
_gte - Boolean
_in - [Boolean!]
_is_null - Boolean
_lt - Boolean
_lte - Boolean
_neq - Boolean
_nin - [Boolean!]
Example
{
  "_eq": true,
  "_gt": true,
  "_gte": true,
  "_in": [false],
  "_is_null": true,
  "_lt": false,
  "_lte": true,
  "_neq": true,
  "_nin": [false]
}

CancelFlowReason

columns and relationships of "CancelFlowReason"

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

Boolean expression to filter rows from the table "CancelFlowReason". All fields are combined with a logical 'AND'.

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

Ordering options when selecting data from "CancelFlowReason".

Input Field Description
CancelFlowSession - CancelFlowSession_order_by
cancelFlowId - order_by
cancelFlowSessionId - order_by
createdAt - order_by
id - order_by
order - order_by
otherReasonBody - order_by
reason - order_by
rebuttal - order_by
updatedAt - order_by
Example
{
  "CancelFlowSession": CancelFlowSession_order_by,
  "cancelFlowId": order_by,
  "cancelFlowSessionId": order_by,
  "createdAt": order_by,
  "id": order_by,
  "order": order_by,
  "otherReasonBody": order_by,
  "reason": order_by,
  "rebuttal": order_by,
  "updatedAt": order_by
}

CancelFlowReason_select_column

select columns of table "CancelFlowReason"

Enum Value Description

cancelFlowId

column name

cancelFlowSessionId

column name

createdAt

column name

id

column name

order

column name

otherReasonBody

column name

reason

column name

rebuttal

column name

updatedAt

column name

CancelFlowSession

columns and relationships of "CancelFlowSession"

Field Name Description
CancelFlowReason - CancelFlowReason An object relationship
Discounts - [Discount!]! An array relationship

Arguments

distinct_on - [Discount_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 - [Discount_order_by!]

sort the rows by one or more columns

where - Discount_bool_exp

filter the rows returned

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

CancelFlowSession_aggregate_order_by

order by aggregate values of table "CancelFlowSession"

Input Field Description
count - order_by
max - CancelFlowSession_max_order_by
min - CancelFlowSession_min_order_by
Example
{
  "count": order_by,
  "max": CancelFlowSession_max_order_by,
  "min": CancelFlowSession_min_order_by
}

CancelFlowSession_bool_exp

Boolean expression to filter rows from the table "CancelFlowSession". All fields are combined with a logical 'AND'.

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

order by max() on columns of table "CancelFlowSession"

Input Field Description
cancelFlowId - order_by
createdAt - order_by
id - order_by
status - order_by
subscriptionId - order_by
updatedAt - order_by
Example
{
  "cancelFlowId": order_by,
  "createdAt": order_by,
  "id": order_by,
  "status": order_by,
  "subscriptionId": order_by,
  "updatedAt": order_by
}

CancelFlowSession_min_order_by

order by min() on columns of table "CancelFlowSession"

Input Field Description
cancelFlowId - order_by
createdAt - order_by
id - order_by
status - order_by
subscriptionId - order_by
updatedAt - order_by
Example
{
  "cancelFlowId": order_by,
  "createdAt": order_by,
  "id": order_by,
  "status": order_by,
  "subscriptionId": order_by,
  "updatedAt": order_by
}

CancelFlowSession_order_by

Ordering options when selecting data from "CancelFlowSession".

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": order_by,
  "createdAt": order_by,
  "id": order_by,
  "status": order_by,
  "subscriptionId": order_by,
  "updatedAt": order_by
}

CancelFlowSession_select_column

select columns of table "CancelFlowSession"

Enum Value Description

cancelFlowId

column name

createdAt

column name

id

column name

status

column name

subscriptionId

column name

updatedAt

column name

Discount

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

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

Discount_aggregate_order_by

order by aggregate values of table "Discount"

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

Discount_avg_order_by

order by avg() on columns of table "Discount"

Input Field Description
fixedValue - order_by
maxTimesUsed - order_by
percentage - order_by
timesUsed - order_by
Example
{
  "fixedValue": order_by,
  "maxTimesUsed": order_by,
  "percentage": order_by,
  "timesUsed": order_by
}

Discount_bool_exp

Boolean expression to filter rows from the table "Discount". All fields are combined with a logical 'AND'.

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

order by max() on columns of table "Discount"

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

Discount_min_order_by

order by min() on columns of table "Discount"

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

Discount_order_by

Ordering options when selecting data from "Discount".

Input Field Description
CancelFlowSession - CancelFlowSession_order_by
Group - Group_order_by
GroupPlan - GroupPlan_order_by
OrderLineItem - OrderLineItem_order_by
ShippingLine - ShippingLine_order_by
Subscription - Subscription_order_by
SubscriptionLine - SubscriptionLine_order_by
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
{
  "CancelFlowSession": CancelFlowSession_order_by,
  "Group": Group_order_by,
  "GroupPlan": GroupPlan_order_by,
  "OrderLineItem": OrderLineItem_order_by,
  "ShippingLine": ShippingLine_order_by,
  "Subscription": Subscription_order_by,
  "SubscriptionLine": SubscriptionLine_order_by,
  "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
}

Discount_select_column

select columns of table "Discount"

Enum Value Description

cancelFlowSessionId

column name

createdAt

column name

fixedValue

column name

groupId

column name

groupPlanId

column name

id

column name

maxTimesUsed

column name

orderLineItemId

column name

percentage

column name

platformId

column name

redeemCode

column name

shippingLineId

column name

subscriptionId

column name

subscriptionLineId

column name

timesUsed

column name

type

column name

updatedAt

column name

Discount_stddev_order_by

order by stddev() on columns of table "Discount"

Input Field Description
fixedValue - order_by
maxTimesUsed - order_by
percentage - order_by
timesUsed - order_by
Example
{
  "fixedValue": order_by,
  "maxTimesUsed": order_by,
  "percentage": order_by,
  "timesUsed": order_by
}

Discount_stddev_pop_order_by

order by stddev_pop() on columns of table "Discount"

Input Field Description
fixedValue - order_by
maxTimesUsed - order_by
percentage - order_by
timesUsed - order_by
Example
{
  "fixedValue": order_by,
  "maxTimesUsed": order_by,
  "percentage": order_by,
  "timesUsed": order_by
}

Discount_stddev_samp_order_by

order by stddev_samp() on columns of table "Discount"

Input Field Description
fixedValue - order_by
maxTimesUsed - order_by
percentage - order_by
timesUsed - order_by
Example
{
  "fixedValue": order_by,
  "maxTimesUsed": order_by,
  "percentage": order_by,
  "timesUsed": order_by
}

Discount_sum_order_by

order by sum() on columns of table "Discount"

Input Field Description
fixedValue - order_by
maxTimesUsed - order_by
percentage - order_by
timesUsed - order_by
Example
{
  "fixedValue": order_by,
  "maxTimesUsed": order_by,
  "percentage": order_by,
  "timesUsed": order_by
}

Discount_var_pop_order_by

order by var_pop() on columns of table "Discount"

Input Field Description
fixedValue - order_by
maxTimesUsed - order_by
percentage - order_by
timesUsed - order_by
Example
{
  "fixedValue": order_by,
  "maxTimesUsed": order_by,
  "percentage": order_by,
  "timesUsed": order_by
}

Discount_var_samp_order_by

order by var_samp() on columns of table "Discount"

Input Field Description
fixedValue - order_by
maxTimesUsed - order_by
percentage - order_by
timesUsed - order_by
Example
{
  "fixedValue": order_by,
  "maxTimesUsed": order_by,
  "percentage": order_by,
  "timesUsed": order_by
}

Discount_variance_order_by

order by variance() on columns of table "Discount"

Input Field Description
fixedValue - order_by
maxTimesUsed - order_by
percentage - order_by
timesUsed - order_by
Example
{
  "fixedValue": order_by,
  "maxTimesUsed": order_by,
  "percentage": order_by,
  "timesUsed": order_by
}

Group

columns and relationships of "Group"

Field Name Description
DiscountsPerUser - [Discount!]! An array relationship

Arguments

distinct_on - [Discount_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 - [Discount_order_by!]

sort the rows by one or more columns

where - Discount_bool_exp

filter the rows returned

GroupSet - GroupSet An object relationship
OrderLineItemsIfFirstOrder - [OrderLineItem!]! An array relationship

Arguments

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

SubscriptionLines - [SubscriptionLine!]! An array relationship

Arguments

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

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": 987,
  "minUsers": 123,
  "updatedAt": timestamptz
}

GroupPlan

columns and relationships of "GroupPlan"

Field Name Description
DiscountsPerUser - [Discount!]! An array relationship

Arguments

distinct_on - [Discount_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 - [Discount_order_by!]

sort the rows by one or more columns

where - Discount_bool_exp

filter the rows returned

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": 123,
  "sellingPlanId": uuid,
  "updatedAt": timestamptz
}

GroupPlan_aggregate_order_by

order by aggregate values of table "GroupPlan"

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

GroupPlan_avg_order_by

order by avg() on columns of table "GroupPlan"

Input Field Description
maxUsers - order_by
minUsers - order_by
Example
{
  "maxUsers": order_by,
  "minUsers": order_by
}

GroupPlan_bool_exp

Boolean expression to filter rows from the table "GroupPlan". All fields are combined with a logical 'AND'.

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

order by max() on columns of table "GroupPlan"

Input Field Description
createdAt - order_by
groupSetId - order_by
id - order_by
maxUsers - order_by
minUsers - order_by
sellingPlanId - order_by
updatedAt - order_by
Example
{
  "createdAt": order_by,
  "groupSetId": order_by,
  "id": order_by,
  "maxUsers": order_by,
  "minUsers": order_by,
  "sellingPlanId": order_by,
  "updatedAt": order_by
}

GroupPlan_min_order_by

order by min() on columns of table "GroupPlan"

Input Field Description
createdAt - order_by
groupSetId - order_by
id - order_by
maxUsers - order_by
minUsers - order_by
sellingPlanId - order_by
updatedAt - order_by
Example
{
  "createdAt": order_by,
  "groupSetId": order_by,
  "id": order_by,
  "maxUsers": order_by,
  "minUsers": order_by,
  "sellingPlanId": order_by,
  "updatedAt": order_by
}

GroupPlan_order_by

Ordering options when selecting data from "GroupPlan".

Input Field Description
DiscountsPerUser_aggregate - Discount_aggregate_order_by
GroupSet - GroupSet_order_by
SellingPlan - SellingPlan_order_by
createdAt - order_by
groupSetId - order_by
id - order_by
maxUsers - order_by
minUsers - order_by
sellingPlanId - order_by
updatedAt - order_by
Example
{
  "DiscountsPerUser_aggregate": Discount_aggregate_order_by,
  "GroupSet": GroupSet_order_by,
  "SellingPlan": SellingPlan_order_by,
  "createdAt": order_by,
  "groupSetId": order_by,
  "id": order_by,
  "maxUsers": order_by,
  "minUsers": order_by,
  "sellingPlanId": order_by,
  "updatedAt": order_by
}

GroupPlan_select_column

select columns of table "GroupPlan"

Enum Value Description

createdAt

column name

groupSetId

column name

id

column name

maxUsers

column name

minUsers

column name

sellingPlanId

column name

updatedAt

column name

GroupPlan_stddev_order_by

order by stddev() on columns of table "GroupPlan"

Input Field Description
maxUsers - order_by
minUsers - order_by
Example
{
  "maxUsers": order_by,
  "minUsers": order_by
}

GroupPlan_stddev_pop_order_by

order by stddev_pop() on columns of table "GroupPlan"

Input Field Description
maxUsers - order_by
minUsers - order_by
Example
{
  "maxUsers": order_by,
  "minUsers": order_by
}

GroupPlan_stddev_samp_order_by

order by stddev_samp() on columns of table "GroupPlan"

Input Field Description
maxUsers - order_by
minUsers - order_by
Example
{
  "maxUsers": order_by,
  "minUsers": order_by
}

GroupPlan_sum_order_by

order by sum() on columns of table "GroupPlan"

Input Field Description
maxUsers - order_by
minUsers - order_by
Example
{
  "maxUsers": order_by,
  "minUsers": order_by
}

GroupPlan_var_pop_order_by

order by var_pop() on columns of table "GroupPlan"

Input Field Description
maxUsers - order_by
minUsers - order_by
Example
{
  "maxUsers": order_by,
  "minUsers": order_by
}

GroupPlan_var_samp_order_by

order by var_samp() on columns of table "GroupPlan"

Input Field Description
maxUsers - order_by
minUsers - order_by
Example
{
  "maxUsers": order_by,
  "minUsers": order_by
}

GroupPlan_variance_order_by

order by variance() on columns of table "GroupPlan"

Input Field Description
maxUsers - order_by
minUsers - order_by
Example
{
  "maxUsers": order_by,
  "minUsers": order_by
}

GroupSet

columns and relationships of "GroupSet"

Field Name Description
GroupPlans - [GroupPlan!]! An array relationship

Arguments

distinct_on - [GroupPlan_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 - [GroupPlan_order_by!]

sort the rows by one or more columns

where - GroupPlan_bool_exp

filter the rows returned

Groups - [Group!]! An array relationship

Arguments

distinct_on - [Group_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 - [Group_order_by!]

sort the rows by one or more columns

where - Group_bool_exp

filter the rows returned

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

GroupSet_bool_exp

Boolean expression to filter rows from the table "GroupSet". All fields are combined with a logical 'AND'.

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

Ordering options when selecting data from "GroupSet".

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": order_by,
  "id": order_by,
  "name": order_by,
  "siteId": order_by,
  "updatedAt": order_by
}

GroupSet_select_column

select columns of table "GroupSet"

Enum Value Description

createdAt

column name

id

column name

name

column name

siteId

column name

updatedAt

column name

Group_aggregate_order_by

order by aggregate values of table "Group"

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

Group_avg_order_by

order by avg() on columns of table "Group"

Input Field Description
maxUsers - order_by
minUsers - order_by
Example
{
  "maxUsers": order_by,
  "minUsers": order_by
}

Group_bool_exp

Boolean expression to filter rows from the table "Group". All fields are combined with a logical 'AND'.

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

order by max() on columns of table "Group"

Input Field Description
createdAt - order_by
groupSetId - order_by
id - order_by
maxUsers - order_by
minUsers - order_by
updatedAt - order_by
Example
{
  "createdAt": order_by,
  "groupSetId": order_by,
  "id": order_by,
  "maxUsers": order_by,
  "minUsers": order_by,
  "updatedAt": order_by
}

Group_min_order_by

order by min() on columns of table "Group"

Input Field Description
createdAt - order_by
groupSetId - order_by
id - order_by
maxUsers - order_by
minUsers - order_by
updatedAt - order_by
Example
{
  "createdAt": order_by,
  "groupSetId": order_by,
  "id": order_by,
  "maxUsers": order_by,
  "minUsers": order_by,
  "updatedAt": order_by
}

Group_order_by

Ordering options when selecting data from "Group".

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": order_by,
  "groupSetId": order_by,
  "id": order_by,
  "maxUsers": order_by,
  "minUsers": order_by,
  "updatedAt": order_by
}

Group_select_column

select columns of table "Group"

Enum Value Description

createdAt

column name

groupSetId

column name

id

column name

maxUsers

column name

minUsers

column name

updatedAt

column name

Group_stddev_order_by

order by stddev() on columns of table "Group"

Input Field Description
maxUsers - order_by
minUsers - order_by
Example
{
  "maxUsers": order_by,
  "minUsers": order_by
}

Group_stddev_pop_order_by

order by stddev_pop() on columns of table "Group"

Input Field Description
maxUsers - order_by
minUsers - order_by
Example
{
  "maxUsers": order_by,
  "minUsers": order_by
}

Group_stddev_samp_order_by

order by stddev_samp() on columns of table "Group"

Input Field Description
maxUsers - order_by
minUsers - order_by
Example
{
  "maxUsers": order_by,
  "minUsers": order_by
}

Group_sum_order_by

order by sum() on columns of table "Group"

Input Field Description
maxUsers - order_by
minUsers - order_by
Example
{
  "maxUsers": order_by,
  "minUsers": order_by
}

Group_var_pop_order_by

order by var_pop() on columns of table "Group"

Input Field Description
maxUsers - order_by
minUsers - order_by
Example
{
  "maxUsers": order_by,
  "minUsers": order_by
}

Group_var_samp_order_by

order by var_samp() on columns of table "Group"

Input Field Description
maxUsers - order_by
minUsers - order_by
Example
{
  "maxUsers": order_by,
  "minUsers": order_by
}

Group_variance_order_by

order by variance() on columns of table "Group"

Input Field Description
maxUsers - order_by
minUsers - order_by
Example
{
  "maxUsers": order_by,
  "minUsers": order_by
}

Holiday

columns and relationships of "Holiday"

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

Holiday_aggregate_order_by

order by aggregate values of table "Holiday"

Input Field Description
count - order_by
max - Holiday_max_order_by
min - Holiday_min_order_by
Example
{
  "count": order_by,
  "max": Holiday_max_order_by,
  "min": Holiday_min_order_by
}

Holiday_bool_exp

Boolean expression to filter rows from the table "Holiday". All fields are combined with a logical 'AND'.

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

order by max() on columns of table "Holiday"

Input Field Description
id - order_by
Example
{"id": order_by}

Holiday_min_order_by

order by min() on columns of table "Holiday"

Input Field Description
id - order_by
Example
{"id": order_by}

Holiday_order_by

Ordering options when selecting data from "Holiday".

Input Field Description
Site - Site_order_by
id - order_by
Example
{
  "Site": Site_order_by,
  "id": order_by
}

Holiday_select_column

select columns of table "Holiday"

Enum Value Description

id

column name

Int

Example
987

Int_comparison_exp

Boolean expression to compare columns of type "Int". All fields are combined with logical 'AND'.

Input Field Description
_eq - Int
_gt - Int
_gte - Int
_in - [Int!]
_is_null - Boolean
_lt - Int
_lte - Int
_neq - Int
_nin - [Int!]
Example
{
  "_eq": 123,
  "_gt": 123,
  "_gte": 987,
  "_in": [987],
  "_is_null": true,
  "_lt": 123,
  "_lte": 123,
  "_neq": 123,
  "_nin": [987]
}

Notification

columns and relationships of "Notification"

Field Name Description
NotificationLogs - [NotificationLog!]! An array relationship

Arguments

distinct_on - [NotificationLog_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 - [NotificationLog_order_by!]

sort the rows by one or more columns

where - NotificationLog_bool_exp

filter the rows returned

Site - Site! An object relationship
id - uuid!
Example
{
  "NotificationLogs": [NotificationLog],
  "Site": Site,
  "id": uuid
}

NotificationLog

columns and relationships of "NotificationLog"

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": "xyz789",
  "createdAt": timestamptz,
  "email": "xyz789",
  "id": uuid,
  "notificationId": uuid,
  "phoneNumber": "abc123",
  "subject": "xyz789",
  "subscriptionId": uuid,
  "updatedAt": timestamptz
}

NotificationLog_aggregate_order_by

order by aggregate values of table "NotificationLog"

Input Field Description
count - order_by
max - NotificationLog_max_order_by
min - NotificationLog_min_order_by
Example
{
  "count": order_by,
  "max": NotificationLog_max_order_by,
  "min": NotificationLog_min_order_by
}

NotificationLog_bool_exp

Boolean expression to filter rows from the table "NotificationLog". All fields are combined with a logical 'AND'.

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

order by max() on columns of table "NotificationLog"

Input Field Description
body - order_by
createdAt - order_by
email - order_by
id - order_by
notificationId - order_by
phoneNumber - order_by
subject - order_by
subscriptionId - order_by
updatedAt - order_by
Example
{
  "body": order_by,
  "createdAt": order_by,
  "email": order_by,
  "id": order_by,
  "notificationId": order_by,
  "phoneNumber": order_by,
  "subject": order_by,
  "subscriptionId": order_by,
  "updatedAt": order_by
}

NotificationLog_min_order_by

order by min() on columns of table "NotificationLog"

Input Field Description
body - order_by
createdAt - order_by
email - order_by
id - order_by
notificationId - order_by
phoneNumber - order_by
subject - order_by
subscriptionId - order_by
updatedAt - order_by
Example
{
  "body": order_by,
  "createdAt": order_by,
  "email": order_by,
  "id": order_by,
  "notificationId": order_by,
  "phoneNumber": order_by,
  "subject": order_by,
  "subscriptionId": order_by,
  "updatedAt": order_by
}

NotificationLog_order_by

Ordering options when selecting data from "NotificationLog".

Input Field Description
Notification - Notification_order_by
Subscription - Subscription_order_by
body - order_by
createdAt - order_by
email - order_by
id - order_by
notificationId - order_by
phoneNumber - order_by
subject - order_by
subscriptionId - order_by
updatedAt - order_by
Example
{
  "Notification": Notification_order_by,
  "Subscription": Subscription_order_by,
  "body": order_by,
  "createdAt": order_by,
  "email": order_by,
  "id": order_by,
  "notificationId": order_by,
  "phoneNumber": order_by,
  "subject": order_by,
  "subscriptionId": order_by,
  "updatedAt": order_by
}

NotificationLog_select_column

select columns of table "NotificationLog"

Enum Value Description

body

column name

createdAt

column name

email

column name

id

column name

notificationId

column name

phoneNumber

column name

subject

column name

subscriptionId

column name

updatedAt

column name

Notification_aggregate_order_by

order by aggregate values of table "Notification"

Input Field Description
count - order_by
max - Notification_max_order_by
min - Notification_min_order_by
Example
{
  "count": order_by,
  "max": Notification_max_order_by,
  "min": Notification_min_order_by
}

Notification_bool_exp

Boolean expression to filter rows from the table "Notification". All fields are combined with a logical 'AND'.

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

order by max() on columns of table "Notification"

Input Field Description
id - order_by
Example
{"id": order_by}

Notification_min_order_by

order by min() on columns of table "Notification"

Input Field Description
id - order_by
Example
{"id": order_by}

Notification_order_by

Ordering options when selecting data from "Notification".

Input Field Description
NotificationLogs_aggregate - NotificationLog_aggregate_order_by
Site - Site_order_by
id - order_by
Example
{
  "NotificationLogs_aggregate": NotificationLog_aggregate_order_by,
  "Site": Site_order_by,
  "id": order_by
}

Notification_select_column

select columns of table "Notification"

Enum Value Description

id

column name

Order

UNIQUE FIELDS WILL NOT WORK WELL WITH DELETEDAT

Field Name Description
OrderLineItems - [OrderLineItem!]! An array relationship

Arguments

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

PrepaidSubscription - Subscription An object relationship
ShippingLines - [ShippingLine!]! An array relationship

Arguments

distinct_on - [ShippingLine_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 - [ShippingLine_order_by!]

sort the rows by one or more columns

where - ShippingLine_bool_exp

filter the rows returned

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

OrderLineItem

groupId is only defined on initial order

Field Name Description
Discounts - [Discount!]! An array relationship

Arguments

distinct_on - [Discount_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 - [Discount_order_by!]

sort the rows by one or more columns

where - Discount_bool_exp

filter the rows returned

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

Arguments

distinct_on - [TaxLine_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 - [TaxLine_order_by!]

sort the rows by one or more columns

where - TaxLine_bool_exp

filter the rows returned

attributionGroupId - uuid
createdAt - timestamptz!
customAttributes - jsonb

Arguments

path - String

JSON select path

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

Example
{
  "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
}

OrderLineItem_avg_order_by

order by avg() on columns of table "OrderLineItem"

Input Field Description
priceWithoutDiscount - order_by
quantity - order_by
Example
{
  "priceWithoutDiscount": order_by,
  "quantity": order_by
}

OrderLineItem_bool_exp

Boolean expression to filter rows from the table "OrderLineItem". All fields are combined with a logical 'AND'.

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

order by max() on columns of table "OrderLineItem"

Input Field Description
attributionGroupId - order_by
createdAt - 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
{
  "attributionGroupId": order_by,
  "createdAt": 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
}

OrderLineItem_min_order_by

order by min() on columns of table "OrderLineItem"

Input Field Description
attributionGroupId - order_by
createdAt - 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
{
  "attributionGroupId": order_by,
  "createdAt": 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
}

OrderLineItem_order_by

Ordering options when selecting data from "OrderLineItem".

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

OrderLineItem_select_column

select columns of table "OrderLineItem"

Enum Value Description

attributionGroupId

column name

createdAt

column name

customAttributes

column name

groupId

column name

id

column name

orderId

column name

platformId

column name

priceWithoutDiscount

column name

productVariantId

column name

quantity

column name

subscriptionLineId

column name

updatedAt

column name

OrderLineItem_stddev_order_by

order by stddev() on columns of table "OrderLineItem"

Input Field Description
priceWithoutDiscount - order_by
quantity - order_by
Example
{
  "priceWithoutDiscount": order_by,
  "quantity": order_by
}

OrderLineItem_stddev_pop_order_by

order by stddev_pop() on columns of table "OrderLineItem"

Input Field Description
priceWithoutDiscount - order_by
quantity - order_by
Example
{
  "priceWithoutDiscount": order_by,
  "quantity": order_by
}

OrderLineItem_stddev_samp_order_by

order by stddev_samp() on columns of table "OrderLineItem"

Input Field Description
priceWithoutDiscount - order_by
quantity - order_by
Example
{
  "priceWithoutDiscount": order_by,
  "quantity": order_by
}

OrderLineItem_sum_order_by

order by sum() on columns of table "OrderLineItem"

Input Field Description
priceWithoutDiscount - order_by
quantity - order_by
Example
{
  "priceWithoutDiscount": order_by,
  "quantity": order_by
}

OrderLineItem_var_pop_order_by

order by var_pop() on columns of table "OrderLineItem"

Input Field Description
priceWithoutDiscount - order_by
quantity - order_by
Example
{
  "priceWithoutDiscount": order_by,
  "quantity": order_by
}

OrderLineItem_var_samp_order_by

order by var_samp() on columns of table "OrderLineItem"

Input Field Description
priceWithoutDiscount - order_by
quantity - order_by
Example
{
  "priceWithoutDiscount": order_by,
  "quantity": order_by
}

OrderLineItem_variance_order_by

order by variance() on columns of table "OrderLineItem"

Input Field Description
priceWithoutDiscount - order_by
quantity - order_by
Example
{
  "priceWithoutDiscount": order_by,
  "quantity": order_by
}

Order_aggregate_order_by

order by aggregate values of table "Order"

Input Field Description
count - order_by
max - Order_max_order_by
min - Order_min_order_by
Example
{
  "count": order_by,
  "max": Order_max_order_by,
  "min": Order_min_order_by
}

Order_bool_exp

Boolean expression to filter rows from the table "Order". All fields are combined with a logical 'AND'.

Input Field Description
OrderLineItems - OrderLineItem_bool_exp
PrepaidSubscription - Subscription_bool_exp
ShippingLines - ShippingLine_bool_exp
StorefrontUser - StorefrontUser_bool_exp
_and - [Order_bool_exp!]
_not - Order_bool_exp
_or - [Order_bool_exp!]
cancelledAt - timestamptz_comparison_exp
createdAt - timestamptz_comparison_exp
deletedAt - timestamptz_comparison_exp
deliveredAt - timestamptz_comparison_exp
id - uuid_comparison_exp
note - String_comparison_exp
platformId - String_comparison_exp
platformNumber - String_comparison_exp
storefrontUserId - uuid_comparison_exp
updatedAt - timestamp_comparison_exp
Example
{
  "OrderLineItems": OrderLineItem_bool_exp,
  "PrepaidSubscription": Subscription_bool_exp,
  "ShippingLines": ShippingLine_bool_exp,
  "StorefrontUser": StorefrontUser_bool_exp,
  "_and": [Order_bool_exp],
  "_not": Order_bool_exp,
  "_or": [Order_bool_exp],
  "cancelledAt": timestamptz_comparison_exp,
  "createdAt": timestamptz_comparison_exp,
  "deletedAt": timestamptz_comparison_exp,
  "deliveredAt": timestamptz_comparison_exp,
  "id": uuid_comparison_exp,
  "note": String_comparison_exp,
  "platformId": String_comparison_exp,
  "platformNumber": String_comparison_exp,
  "storefrontUserId": uuid_comparison_exp,
  "updatedAt": timestamp_comparison_exp
}

Order_max_order_by

order by max() on columns of table "Order"

Input Field Description
cancelledAt - order_by
createdAt - order_by
deletedAt - order_by
deliveredAt - order_by
id - order_by
note - order_by
platformId - order_by
platformNumber - order_by
storefrontUserId - order_by
updatedAt - order_by
Example
{
  "cancelledAt": order_by,
  "createdAt": order_by,
  "deletedAt": order_by,
  "deliveredAt": order_by,
  "id": order_by,
  "note": order_by,
  "platformId": order_by,
  "platformNumber": order_by,
  "storefrontUserId": order_by,
  "updatedAt": order_by
}

Order_min_order_by

order by min() on columns of table "Order"

Input Field Description
cancelledAt - order_by
createdAt - order_by
deletedAt - order_by
deliveredAt - order_by
id - order_by
note - order_by
platformId - order_by
platformNumber - order_by
storefrontUserId - order_by
updatedAt - order_by
Example
{
  "cancelledAt": order_by,
  "createdAt": order_by,
  "deletedAt": order_by,
  "deliveredAt": order_by,
  "id": order_by,
  "note": order_by,
  "platformId": order_by,
  "platformNumber": order_by,
  "storefrontUserId": order_by,
  "updatedAt": order_by
}

Order_order_by

Ordering options when selecting data from "Order".

Input Field Description
OrderLineItems_aggregate - OrderLineItem_aggregate_order_by
PrepaidSubscription - Subscription_order_by
ShippingLines_aggregate - ShippingLine_aggregate_order_by
StorefrontUser - StorefrontUser_order_by
cancelledAt - order_by
createdAt - order_by
deletedAt - order_by
deliveredAt - order_by
id - order_by
note - order_by
platformId - order_by
platformNumber - order_by
storefrontUserId - order_by
updatedAt - order_by
Example
{
  "OrderLineItems_aggregate": OrderLineItem_aggregate_order_by,
  "PrepaidSubscription": Subscription_order_by,
  "ShippingLines_aggregate": ShippingLine_aggregate_order_by,
  "StorefrontUser": StorefrontUser_order_by,
  "cancelledAt": order_by,
  "createdAt": order_by,
  "deletedAt": order_by,
  "deliveredAt": order_by,
  "id": order_by,
  "note": order_by,
  "platformId": order_by,
  "platformNumber": order_by,
  "storefrontUserId": order_by,
  "updatedAt": order_by
}

Order_select_column

select columns of table "Order"

Enum Value Description

cancelledAt

column name

createdAt

column name

deletedAt

column name

deliveredAt

column name

id

column name

note

column name

platformId

column name

platformNumber

column name

storefrontUserId

column name

updatedAt

column name

PaymentMethod

columns and relationships of "PaymentMethod"

Field Name Description
BillingAddress - Address An object relationship
StorefrontUser - StorefrontUser! An object relationship
Subscriptions - [Subscription!]! An array relationship

Arguments

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

id - uuid!
Example
{
  "BillingAddress": Address,
  "StorefrontUser": StorefrontUser,
  "Subscriptions": [Subscription],
  "id": uuid
}

PaymentMethod_aggregate_order_by

order by aggregate values of table "PaymentMethod"

Input Field Description
count - order_by
max - PaymentMethod_max_order_by
min - PaymentMethod_min_order_by
Example
{
  "count": order_by,
  "max": PaymentMethod_max_order_by,
  "min": PaymentMethod_min_order_by
}

PaymentMethod_bool_exp

Boolean expression to filter rows from the table "PaymentMethod". All fields are combined with a logical 'AND'.

Input Field Description
BillingAddress - Address_bool_exp
StorefrontUser - StorefrontUser_bool_exp
Subscriptions - Subscription_bool_exp
_and - [PaymentMethod_bool_exp!]
_not - PaymentMethod_bool_exp