### Address_max_order_by Example

Source: https://code.skio.com/index

An example showing how to specify ordering for the maximum values of Address table columns.

```json
{
  "address1": "asc",
  "address2": "asc",
  "city": "asc",
  "company": "asc",
  "country": "asc",
  "createdAt": "asc",
  "doorCode": "asc",
  "firstName": "asc",
  "id": "asc",
  "lastName": "asc",
  "phoneNumber": "asc",
  "platformId": "asc",
  "province": "asc",
  "storefrontUserId": "asc",
  "updatedAt": "asc",
  "zip": "asc"
}
```

--------------------------------

### timestamp Example

Source: https://code.skio.com/index

A placeholder example for the 'timestamp' data type.

```plaintext
timestamp
```

--------------------------------

### Site Set Input Example (JSON)

Source: https://code.skio.com/index

An example of the input type for updating data within the 'Site' table. This specific example shows how to set the 'useFlycodeDunning' field.

```json
{"useFlycodeDunning": false}
```

--------------------------------

### String Example (String)

Source: https://code.skio.com/index

A simple example of a string literal, representing typical text data that might be stored or processed.

```string
"abc123"
```

--------------------------------

### Address_aggregate_order_by Example

Source: https://code.skio.com/index

An example demonstrating how to order aggregate values for the Address table, specifying order for count, max, and min fields.

```json
{
  "count": "asc",
  "max": Address_max_order_by,
  "min": Address_min_order_by
}
```

--------------------------------

### Site Order By Example (JSON)

Source: https://code.skio.com/index

An example illustrating the structure for ordering data retrieved from the 'Site' table. It includes ordering options for aggregate fields and scalar values.

```json
{
  "CreditRewards_aggregate": CreditRewards_aggregate_order_by,
  "Holidays_aggregate": Holiday_aggregate_order_by,
  "Notifications_aggregate": Notification_aggregate_order_by,
  "Products_aggregate": Product_aggregate_order_by,
  "SkioSmsMessagingHistory_aggregate": SkioSmsMessagingHistory_aggregate_order_by,
  "StorefrontUsers_aggregate": StorefrontUser_aggregate_order_by,
  "Tags_aggregate": Tag_aggregate_order_by,
  "Theme": Theme_order_by,
  "Theme2": Theme2_order_by,
  "currencyCode": "asc",
  "ianaTimezone": "asc",
  "id": "asc",
  "qaAuthSettings": "asc"
}
```

--------------------------------

### pauseSubscriptionInput Example

Source: https://code.skio.com/index

Example of the input structure for the pauseSubscription mutation. It requires a subscription ID and an optional skip option.

```json
{
  "skipOption": SkipOption,
  "subscriptionId": "xyz789"
}
```

--------------------------------

### uuid Example

Source: https://code.skio.com/index

A placeholder example for the 'uuid' data type.

```plaintext
uuid
```

--------------------------------

### User Order By Example

Source: https://code.skio.com/index

An example of User_order_by, used for specifying the order of User records when querying. It allows ordering by ID or aggregated StorefrontUser data.

```json
{
  "StorefrontUsers_aggregate": StorefrontUser_aggregate_order_by,
  "id": "asc"
}
```

--------------------------------

### PricingPolicy Average Order By Example

Source: https://code.skio.com/index

An example demonstrating how to specify ascending order for average calculations on specific numeric fields within the PricingPolicy table.

```json
{"afterCycle": "asc", "fixedPrice": "asc", "percentageOff": "asc"}
```

--------------------------------

### ProductVariant Ordering (JSON Example)

Source: https://code.skio.com/index

Example demonstrating the structure for ordering ProductVariant data. It includes options for ordering by aggregated related data or by individual columns in ascending or descending order.

```json
{
  "DynamicBox_SelectableProductVariants_aggregate": DynamicBox_SelectableProductVariant_aggregate_order_by,
  "OrderLineItems_aggregate": OrderLineItem_aggregate_order_by,
  "Product": Product_order_by,
  "ProductVariantsCreditRedemptionConfigs_aggregate": ProductVariantsCreditRedemptionConfigs_aggregate_order_by,
  "SellingPlanGroupResources_aggregate": SellingPlanGroupResource_aggregate_order_by,
  "SubscriptionLines_aggregate": SubscriptionLine_aggregate_order_by,
  "compareAtPrice": "order_by",
  "createdAt": "order_by",
  "deletedAt": "order_by",
  "id": "order_by",
  "image": "order_by",
  "marketPrices": "order_by",
  "outOfStockAt": "order_by",
  "platformId": "order_by",
  "price": "order_by",
  "productId": "order_by",
  "sku": "order_by",
  "title": "order_by",
  "updatedAt": "order_by"
}
```

--------------------------------

### StorefrontUser min order by Example (JSON)

Source: https://code.skio.com/index

Example of how to define a minimum order by clause for StorefrontUser, specifying ascending order for several fields. This is useful for basic sorting requirements.

```json
{
  "createdAt": "asc",
  "email": "asc",
  "emailLower": "asc",
  "firstName": "asc",
  "id": "asc",
  "lastName": "asc",
  "phoneNumber": "asc",
  "platformId": "asc",
  "qaToken": "asc",
  "redactedAt": "asc",
  "removedAt": "asc",
  "siteId": "asc",
  "updatedAt": "asc"
}
```

--------------------------------

### StorefrontUser select column Example (String)

Source: https://code.skio.com/index

Example demonstrating how to specify a single column to select from the StorefrontUser table. This is useful when you only need a specific piece of information, such as the creation timestamp.

```string
"createdAt"
```

--------------------------------

### SurpriseDelightSessions_select_column Example

Source: https://code.skio.com/index

Provides an example of selecting specific columns from the 'SurpriseDelightSessions' table. This is used to define which fields should be returned in a query.

```json
"created_at"
```

--------------------------------

### timestamptz Example

Source: https://code.skio.com/index

A placeholder example for the 'timestamptz' data type (timestamp with timezone).

```plaintext
timestamptz
```

--------------------------------

### PricingPolicy Order By Example (Nested)

Source: https://code.skio.com/index

An example of ordering PricingPolicy data, including nested relationships like SellingPlan. This demonstrates how to apply ordering to related objects.

```json
{
  "SellingPlan": SellingPlan_order_by,
  "afterCycle": "asc",
  "createdAt": "asc",
  "fixedPrice": "asc",
  "id": "asc",
  "percentageOff": "asc",
  "sellingPlanId": "asc",
  "sellingPlanPricingPolicyAdjustmentType": "asc",
  "updatedAt": "asc"
}
```

--------------------------------

### StorefrontUser order by Example (JSON)

Source: https://code.skio.com/index

Example illustrating the full range of ordering options for StorefrontUser data. This includes sorting by direct fields and aggregate fields from related tables. It demonstrates how to specify sort direction ('asc' or 'desc').

```json
{
  "AuditLogs_aggregate": AuditLog_aggregate_order_by,
  "BackupPaymentMethod": PaymentMethod_order_by,
  "Orders_aggregate": Order_aggregate_order_by,
  "PaymentMethods_aggregate": PaymentMethod_aggregate_order_by,
  "RewardCreditHistories_aggregate": RewardCreditHistory_aggregate_order_by,
  "ShippingAddresses_aggregate": Address_aggregate_order_by,
  "Site": Site_order_by,
  "SkioSmsMessagingHistory_aggregate": SkioSmsMessagingHistory_aggregate_order_by,
  "StorefrontUserTiers_aggregate": StorefrontUserTier_aggregate_order_by,
  "Subscriptions_aggregate": Subscription_aggregate_order_by,
  "Tags_aggregate": TagRelationship_aggregate_order_by,
  "User": User_order_by,
  "createdAt": "asc",
  "email": "asc",
  "emailLower": "asc",
  "firstName": "asc",
  "id": "asc",
  "lastName": "asc",
  "phoneNumber": "asc",
  "platformId": "asc",
  "qaToken": "asc",
  "redactedAt": "asc",
  "removedAt": "asc",
  "shopifyTags": "asc",
  "siteId": "asc",
  "smsTransactionalOptIn": "asc",
  "tempSmsTransactionalOptIn": "asc",
  "updatedAt": "asc"
}
```

--------------------------------

### DynamicBox_SelectableProductVariant_aggregate_order_by Example

Source: https://code.skio.com/index

This example demonstrates how to order aggregate values for the DynamicBox_SelectableProductVariant table. It specifies the sorting direction for count, max, and min aggregate functions.

```json
{
  "count": "asc",
  "max": DynamicBox_SelectableProductVariant_max_order_by,
  "min": DynamicBox_SelectableProductVariant_min_order_by
}

```

--------------------------------

### SubscriptionLine Max Order By Example

Source: https://code.skio.com/index

Provides an example of how to order SubscriptionLine data by the maximum values of its columns. It lists various columns and their corresponding 'asc' (ascending) order.

```json
{
  "createdAt": "asc",
  "groupId": "asc",
  "id": "asc",
  "ordersRemaining": "asc",
  "platformId": "asc",
  "prepaidSubscriptionId": "asc",
  "priceWithoutDiscount": "asc",
  "productVariantId": "asc",
  "quantity": "asc",
  "reChargeId": "asc",
  "removedAt": "asc",
  "sellingPlanId": "asc",
  "subscriptionId": "asc",
  "titleOverride": "asc",
  "updatedAt": "asc"
}
```

--------------------------------

### SkioSmsMessagingHistory Aggregate Order By Example (JSON)

Source: https://code.skio.com/index

An example of how to specify ordering for aggregate values of the 'SkioSmsMessagingHistory' table. It allows ordering by count, maximum, and minimum aggregate values.

```json
{
  "count": "asc",
  "max": SkioSmsMessagingHistory_max_order_by,
  "min": SkioSmsMessagingHistory_min_order_by
}
```

--------------------------------

### User Type Example

Source: https://code.skio.com/index

An example of the User type, which includes an ID and an array of associated StorefrontUsers. This type is used to represent user data.

```json
{
  "StorefrontUsers": [StorefrontUser],
  "id": uuid
}
```

--------------------------------

### ProductVariantsCreditRedemptionConfigs Aggregate Order By Example

Source: https://code.skio.com/index

An example JSON object demonstrating how to structure an order by clause for aggregate functions on the ProductVariantsCreditRedemptionConfigs table. This includes fields for average, count, max, min, standard deviation, and variance.

```json
{
  "avg": ProductVariantsCreditRedemptionConfigs_avg_order_by,
  "count": "asc",
  "max": ProductVariantsCreditRedemptionConfigs_max_order_by,
  "min": ProductVariantsCreditRedemptionConfigs_min_order_by,
  "stddev": ProductVariantsCreditRedemptionConfigs_stddev_order_by,
  "stddev_pop": ProductVariantsCreditRedemptionConfigs_stddev_pop_order_by,
  "stddev_samp": ProductVariantsCreditRedemptionConfigs_stddev_samp_order_by,
  "sum": ProductVariantsCreditRedemptionConfigs_sum_order_by,
  "var_pop": ProductVariantsCreditRedemptionConfigs_var_pop_order_by,
  "var_samp": ProductVariantsCreditRedemptionConfigs_var_samp_order_by,
  "variance": ProductVariantsCreditRedemptionConfigs_variance_order_by
}
```

--------------------------------

### PricingPolicy Max Order By Example

Source: https://code.skio.com/index

An example showing how to define ordering for maximum values across various columns in the PricingPolicy table. All specified fields are set to ascending order.

```json
{
  "afterCycle": "asc",
  "createdAt": "asc",
  "fixedPrice": "asc",
  "id": "asc",
  "percentageOff": "asc",
  "sellingPlanId": "asc",
  "sellingPlanPricingPolicyAdjustmentType": "asc",
  "updatedAt": "asc"
}
```

--------------------------------

### SubscriptionLine Order By Detailed Example

Source: https://code.skio.com/index

This example illustrates a more comprehensive ordering structure for SubscriptionLine data, incorporating nested orderings for aggregate fields like Discounts_aggregate and OrderLineItems_aggregate, as well as direct fields.

```json
{
  "Discounts_aggregate": Discount_aggregate_order_by,
  "OrderLineItems_aggregate": OrderLineItem_aggregate_order_by,
  "OriginalSellingPlan": SellingPlan_order_by,
  "PrepaidSubscription": Subscription_order_by,
  "ProductVariant": ProductVariant_order_by,
  "Subscription": Subscription_order_by,
  "createdAt": "asc",
  "customAttributes": "asc",
  "groupId": "asc",
  "id": "asc",
  "isPrepaid": "asc",
  "ordersRemaining": "asc",
  "platformId": "asc",
  "prepaidSubscriptionId": "asc",
  "priceWithoutDiscount": "asc",
  "productVariantId": "asc",
  "quantity": "asc",
  "reChargeId": "asc",
  "removedAt": "asc",
  "sellingPlanId": "asc",
  "subscriptionId": "asc",
  "taxable": "asc",
  "titleOverride": "asc",
  "updatedAt": "asc"
}
```

--------------------------------

### Create Subscription Type Enum Example

Source: https://code.skio.com/index

This is an example of a subscription type, represented as a string. The possible values are 'PREPAID' and 'SUBSCRIBE_AND_SAVE'.

```text
"PREPAID"
```

--------------------------------

### CancelFlowReason Ordering Example

Source: https://code.skio.com/index

This example shows how to specify ordering for data retrieved from the 'CancelFlowReason' table. It includes ordering options for all fields, including the related 'CancelFlowSession' object.

```json
{
  "CancelFlowSession": CancelFlowSession_order_by,
  "cancelFlowId": "asc",
  "cancelFlowSessionId": "asc",
  "createdAt": "asc",
  "id": "asc",
  "order": "asc",
  "otherReasonBody": "asc",
  "reason": "asc",
  "rebuttal": "asc",
  "updatedAt": "asc"
}
```

--------------------------------

### unpauseSubscriptionInput Example

Source: https://code.skio.com/index

Example of the input structure for the unpauseSubscription mutation. It requires a subscription ID and an optional boolean to indicate if the pause was temporary.

```json
{
  "isTemporaryPause": false,
  "subscriptionId": "abc123"
}
```

--------------------------------

### SubscriptionLine StdDev Order By Example

Source: https://code.skio.com/index

This example shows how to order SubscriptionLine data based on the standard deviation of specific numeric columns, such as ordersRemaining, priceWithoutDiscount, and quantity.

```json
{"ordersRemaining": "asc", "priceWithoutDiscount": "asc", "quantity": "asc"}
```

--------------------------------

### GraphQL: Discount Aggregate Ordering Example

Source: https://code.skio.com/index

This example illustrates how to order query results based on aggregate functions applied to the 'Discount' table in GraphQL. It includes ordering options for count, average, maximum, minimum, and variance calculations.

```json
{
  "avg": Discount_avg_order_by,
  "count": "asc",
  "max": Discount_max_order_by,
  "min": Discount_min_order_by,
  "stddev": Discount_stddev_order_by,
  "stddev_pop": Discount_stddev_pop_order_by,
  "stddev_samp": Discount_stddev_samp_order_by,
  "sum": Discount_sum_order_by,
  "var_pop": Discount_var_pop_order_by,
  "var_samp": Discount_var_samp_order_by,
  "variance": Discount_variance_order_by
}
```

--------------------------------

### DynamicBox_SelectableProductVariant_max_order_by Example

Source: https://code.skio.com/index

This example illustrates the structure for ordering by the maximum values of columns in the DynamicBox_SelectableProductVariant table. It specifies the 'asc' (ascending) order for deletedAt, dynamicBoxId, and productVariantId.

```json
{"deletedAt": "asc", "dynamicBoxId": "asc", "productVariantId": "asc"}

```

--------------------------------

### ProductVariant Max Order By (JSON Example)

Source: https://code.skio.com/index

Example of ordering results based on the maximum values of ProductVariant columns. This structure allows specifying ascending or descending order for each comparable column.

```json
{
  "compareAtPrice": "asc",
  "createdAt": "asc",
  "deletedAt": "asc",
  "id": "asc",
  "image": "asc",
  "outOfStockAt": "asc",
  "platformId": "asc",
  "price": "asc",
  "productId": "asc",
  "sku": "asc",
  "title": "asc",
  "updatedAt": "asc"
}
```

--------------------------------

### GET /ProductByPk

Source: https://code.skio.com/index

Fetches a specific product by its primary key.

```APIDOC
## GET /ProductByPk

### Description
Fetches a specific product by its unique ID.

### Method
GET

### Endpoint
/ProductByPk

### Query Parameters
- **id** (uuid!) - Required - The unique identifier of the product.

### Request Example
```graphql
query ProductByPk($id: uuid!) {
  ProductByPk(id: $id) {
    DynamicBox {
      ...DynamicBoxFragment
    }
    ProductVariants {
      ...ProductVariantFragment
    }
    Site {
      ...SiteFragment
    }
    Tags {
      ...TagRelationshipFragment
    }
    canUpsell
    createdAt
    deletedAt
    description
    hideOn1TimeUpsells
    id
    imageSrc
    images
    limitOneTimeUpsellQuantity
    metafields
    oneTimeUpsellPercentageOff
    platformId
    shopifyTags
    siteId
    slug
    smsOrder
    status
    title
    updatedAt
  }
}
```

### Variables Example
```json
{
  "id": "a1b2c3d4-e5f6-7890-1234-567890abcdef"
}
```

### Response
#### Success Response (200)
- **data** (object)
  - **ProductByPk** (object) - The product details.
    - **DynamicBox** (object)
    - **ProductVariants** (array of objects)
    - **Site** (object)
    - **Tags** (array of objects)
    - **canUpsell** (boolean)
    - **createdAt** (timestamptz)
    - **deletedAt** (timestamptz)
    - **description** (string)
    - **hideOn1TimeUpsells** (boolean)
    - **id** (uuid)
    - **imageSrc** (string)
    - **images** (jsonb)
    - **limitOneTimeUpsellQuantity** (boolean)
    - **metafields** (jsonb)
    - **oneTimeUpsellPercentageOff** (numeric)
    - **platformId** (string)
    - **shopifyTags** (jsonb)
    - **siteId** (uuid)
    - **slug** (string)
    - **smsOrder** (integer)
    - **status** (string)
    - **title** (string)
    - **updatedAt** (timestamptz)

#### Response Example
```json
{
  "data": {
    "ProductByPk": {
      "DynamicBox": { ... },
      "ProductVariants": [ { ... } ],
      "Site": { ... },
      "Tags": [ { ... } ],
      "canUpsell": true,
      "createdAt": "2023-10-27T10:00:00Z",
      "deletedAt": null,
      "description": "A sample product description.",
      "hideOn1TimeUpsells": false,
      "id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
      "imageSrc": "http://example.com/image.jpg",
      "images": ["url1", "url2"],
      "limitOneTimeUpsellQuantity": false,
      "metafields": {"key": "value"},
      "oneTimeUpsellPercentageOff": 5.0,
      "platformId": "shopify-123",
      "shopifyTags": ["tag1", "tag2"],
      "siteId": "c3d4e5f6-a7b8-9012-3456-7890abcdef01",
      "slug": "sample-product",
      "smsOrder": 1,
      "status": "active",
      "title": "Sample Product",
      "updatedAt": "2023-10-27T10:00:00Z"
    }
  }
}
```
```

--------------------------------

### PaymentMethod Structure Example

Source: https://code.skio.com/index

This example shows the structure of a PaymentMethod object, detailing its various fields and their types. It includes information about billing address, user details, subscription status, brand, expiration, and more.

```json
{
  "BillingAddress": Address,
  "StorefrontUser": StorefrontUser,
  "Subscriptions": [Subscription],
  "billingAddressId": uuid,
  "brand": "xyz789",
  "createdAt": timestamptz,
  "expiryMonth": numeric,
  "expiryYear": numeric,
  "id": uuid,
  "inactive": true,
  "instrumentType": "xyz789",
  "lastDigits": numeric,
  "paypalAccountEmail": "xyz789",
  "platformId": "abc123",
  "revokedAt": timestamptz,
  "skioRevoke": true,
  "storefrontUserId": uuid,
  "updatedAt": timestamptz
}
```

--------------------------------

### Example SellingPlan Boolean Expression

Source: https://code.skio.com/index

This example shows the structure of a boolean expression for filtering 'SellingPlan' data. It includes various comparison operators and logical combinators like '_and', '_not', and '_or'.

```json
{
  "SellingPlan": SellingPlan_bool_exp,
  "_and": [SkuSwap_bool_exp],
  "_not": SkuSwap_bool_exp,
  "_or": [SkuSwap_bool_exp],
  "afterOrderNumber": Int_comparison_exp,
  "createdAt": timestamptz_comparison_exp,
  "id": uuid_comparison_exp,
  "newPrice": numeric_comparison_exp,
  "overrideDaysToNextBilling": Int_comparison_exp,
  "productVariantFromPlatformId": String_comparison_exp,
  "productVariantPlatformId": String_comparison_exp,
  "removedAt": timestamp_comparison_exp,
  "sellingPlanId": uuid_comparison_exp,
  "siteId": uuid_comparison_exp,
  "sku": String_comparison_exp,
  "updatedAt": timestamptz_comparison_exp
}
```

--------------------------------

### GraphQL: Discount Object Structure Example

Source: https://code.skio.com/index

This is a comprehensive example of the 'Discount' object structure in GraphQL, detailing its fields and their respective types. It includes relationships to other objects like 'CancelFlowSession' and 'OrderLineItem', as well as various scalar fields representing discount properties.

```json
{
  "CancelFlowSession": CancelFlowSession,
  "OrderLineItem": OrderLineItem,
  "ShippingLine": ShippingLine,
  "Subscription": Subscription,
  "SubscriptionLine": SubscriptionLine,
  "allocationPresentmentAmount": numeric,
  "allocationPresentmentCurrencyCode": "xyz789",
  "appliesOnEachItem": false,
  "cancelFlowSessionId": uuid,
  "createdAt": timestamptz,
  "fixedValue": numeric,
  "id": uuid,
  "maxTimesUsed": 987,
  "orderLineItemId": uuid,
  "percentage": numeric,
  "platformId": "xyz789",
  "redeemCode": "abc123",
  "shippingLineId": uuid,
  "subscriptionId": uuid,
  "subscriptionLineId": uuid,
  "timesUsed": 987,
  "title": "xyz789",
  "type": "abc123",
  "updatedAt": timestamptz
}
```

--------------------------------

### DynamicBox_SelectableProductVariant Data Structure Example

Source: https://code.skio.com/index

This JSON object illustrates the structure of a DynamicBox_SelectableProductVariant, showing key-value pairs for related entities and identifiers. It serves as a foundational example for data representation.

```json
{
  "DynamicBox": DynamicBox,
  "SelectableProductVariant": ProductVariant,
  "deletedAt": timestamp,
  "dynamicBoxId": uuid,
  "productVariantId": uuid
}

```

--------------------------------

### Policy Data Structure Example

Source: https://code.skio.com/index

This snippet shows an example of the 'Policy' data structure, including its fields and their expected data types. It serves as a reference for how policy data is represented.

```json
{
  "Anchors": [Anchor],
  "SellingPlansByBillingPolicy": [SellingPlan],
  "SellingPlansByDeliveryPolicy": [SellingPlan],
  "SellingPlansByPrepaidDeliveryPolicy": [SellingPlan],
  "SubscriptionsByBillingPolicy": [Subscription],
  "SubscriptionsByDeliveryPolicy": [Subscription],
  "SubscriptionsByPrepaidDeliveryPolicy": [Subscription],
  "createdAt": timestamptz,
  "id": uuid,
  "interval": "xyz789",
  "intervalCount": 123,
  "isMaxCycleV2": true,
  "maxCycles": 987,
  "minCycles": 123,
  "updatedAt": timestamptz
}
```

--------------------------------

### Add Product Variant to Selling Plan Group Input Example

Source: https://code.skio.com/index

An example JSON object for the input required to add a product variant to a selling plan group. It requires productVariantId and sellingPlanGroupId.

```json
{
  "productVariantId": uuid,
  "sellingPlanGroupId": uuid
}
```

--------------------------------

### Theme Object Structure Example

Source: https://code.skio.com/index

This example shows the structure of a 'Theme' object, including its relationships to a 'Site' object and its unique identifier. It's a basic representation often used in data models or API responses.

```json
{"Site": Site, "id": uuid}
```

--------------------------------

### Site Object Structure Example (JSON)

Source: https://code.skio.com/index

This JSON example illustrates the structure of a 'Site' object, including its relationships to other entities and its own fields like currencyCode and id. It's used for representing site-specific data.

```json
{
  "CreditRewards": [CreditRewards],
  "Holidays": [Holiday],
  "Notifications": [Notification],
  "Products": [Product],
  "SkioSmsMessagingHistory": [SkioSmsMessagingHistory],
  "StorefrontUsers": [StorefrontUser],
  "Tags": [Tag],
  "Theme": Theme,
  "Theme2": Theme2,
  "currencyCode": "abc123",
  "ianaTimezone": "abc123",
  "id": uuid,
  "qaAuthSettings": jsonb
}
```

--------------------------------

### Notification Max Order By Example (JSON)

Source: https://code.skio.com/index

This JSON provides an example of an order-by clause for the max() aggregate on the 'Notification' table. It specifically shows how to order by the 'id' field in ascending order.

```json
{"id": "asc"}
```

--------------------------------

### PaymentMethod Aggregate Order By Example

Source: https://code.skio.com/index

This example demonstrates how to define the order of results when aggregating data from the 'PaymentMethod' table. It includes various aggregate functions like avg, count, max, min, stddev, and sum.

```json
{
  "avg": PaymentMethod_avg_order_by,
  "count": "asc",
  "max": PaymentMethod_max_order_by,
  "min": PaymentMethod_min_order_by,
  "stddev": PaymentMethod_stddev_order_by,
  "stddev_pop": PaymentMethod_stddev_pop_order_by,
  "stddev_samp": PaymentMethod_stddev_samp_order_by,
  "sum": PaymentMethod_sum_order_by,
  "var_pop": PaymentMethod_var_pop_order_by,
  "var_samp": PaymentMethod_var_samp_order_by,
  "variance": PaymentMethod_variance_order_by
}
```

--------------------------------

### SwapSubscriptionProductVariantsInput Example

Source: https://code.skio.com/index

Illustrates the structure of the input object for the SwapSubscriptionProductVariants mutation. It includes details for changing product variants and pricing options for a subscription.

```json
{
  "newCustomPrice": "abc123",
  "newProductVariantId": "xyz789",
  "oldProductVariantId": "abc123",
  "pricingOption": "CUSTOM",
  "subscriptionId": "abc123"
}
```

--------------------------------

### Enum Value Example

Source: https://code.skio.com/index

Example of an enum value used for sorting, specifying order and null handling. It accepts predefined string values like 'asc' or 'desc'.

```plaintext
"asc"
```

--------------------------------

### PaymentMethod Average Order By Example

Source: https://code.skio.com/index

This example shows how to specify the ordering for average calculations on columns within the 'PaymentMethod' table. It allows for ascending or descending order based on specific fields like expiryMonth, expiryYear, and lastDigits.

```json
{"expiryMonth": "asc", "expiryYear": "asc", "lastDigits": "asc"}
```

--------------------------------

### TaxLine Aggregate Order By Example

Source: https://code.skio.com/index

This example illustrates how to specify ordering for aggregate values of the TaxLine table. It includes options for ordering by average, count, max, min, and various standard deviation and variance calculations.

```json
{
  "avg": TaxLine_avg_order_by,
  "count": "asc",
  "max": TaxLine_max_order_by,
  "min": TaxLine_min_order_by,
  "stddev": TaxLine_stddev_order_by,
  "stddev_pop": TaxLine_stddev_pop_order_by,
  "stddev_samp": TaxLine_stddev_samp_order_by,
  "sum": TaxLine_sum_order_by,
  "var_pop": TaxLine_var_pop_order_by,
  "var_samp": TaxLine_var_samp_order_by,
  "variance": TaxLine_variance_order_by
}
```

--------------------------------

### AddSubscriptionLineOutput Example

Source: https://code.skio.com/index

An example of the AddSubscriptionLineOutput type, indicating a boolean success status.

```json
{
  "ok": false
}
```

--------------------------------

### SwapSubscriptionProductVariantsOutput Example

Source: https://code.skio.com/index

Shows the structure of the output object for the SwapSubscriptionProductVariants mutation, indicating the success or failure of the operation.

```json
{"ok": false}
```

--------------------------------

### Theme Order By Example

Source: https://code.skio.com/index

Defines ordering options for selecting data from the 'Theme' table. It allows sorting by 'Site' or 'id'.

```json
{"Site": Site_order_by, "id": "asc"}
```

--------------------------------

### SellingPlanGroup Order By Example

Source: https://code.skio.com/index

This snippet shows the available ordering options when selecting data from the 'SellingPlanGroup' table. It includes sorting by aggregate relations and individual fields like 'byGroup', 'createdAt', 'customName', 'id', 'name', 'platformId', and 'updatedAt'. Dependencies include 'SellingPlanGroupResource_aggregate_order_by' and 'SellingPlan_aggregate_order_by' types.

```json
{
  "SellingPlanGroupResources_aggregate": SellingPlanGroupResource_aggregate_order_by,
  "SellingPlans_aggregate": SellingPlan_aggregate_order_by,
  "byGroup": order_by,
  "createdAt": order_by,
  "customName": order_by,
  "id": order_by,
  "name": order_by,
  "platformId": order_by,
  "updatedAt": order_by
}
```

--------------------------------

### Theme Configuration JSON Example

Source: https://code.skio.com/index

This snippet demonstrates a typical JSON structure for theme configuration, including colors, dimensions, and boolean flags. It is useful for understanding the expected format of theme settings.

```json
{
  "Site": Site,
  "accentColor": "xyz789",
  "accentTextColor": "abc123",
  "badgeBGColor": "xyz789",
  "badgeTextColor": "abc123",
  "buttonBGColor": "xyz789",
  "buttonBorderRadius": numeric,
  "buttonTextColor": "abc123",
  "cardBorderRadius": numeric,
  "cardBorderWidth": numeric,
  "carouselSlideSeconds": 123,
  "disableHalfSkip": false,
  "expandAllButtons": false,
  "headingColor": "xyz789",
  "headingWeight": "xyz789",
  "hideQuantityEditing": true,
  "id": uuid,
  "isPreview": true,
  "loyaltyGradientEndColor": "xyz789",
  "loyaltyGradientStartColor": "abc123",
  "loyaltyIconBgColor": "abc123",
  "loyaltyIconColor": "xyz789",
  "neverHideOTUCards": true,
  "noSecondaryButtons": false,
  "primaryColor": "abc123",
  "qaPrimaryAccentColor": "abc123",
  "qaSecondaryAccentColor": "abc123",
  "radioBorderRadius": numeric,
  "showTaxAndDuties": false,
  "siteId": uuid,
  "tagBGColor": "abc123",
  "tagBorderRadius": numeric,
  "tagTextColor": "abc123",
  "textAnchorColor": "abc123",
  "textApplyDiscountCode": "xyz789",
  "textCancelNow": "abc123",
  "textColor": "xyz789",
  "textEditFrequency": "abc123",
  "textOrderNow": "abc123",
  "textWeight": "xyz789",
  "updated_at": timestamptz
}
```

--------------------------------

### User Boolean Expression Example

Source: https://code.skio.com/index

An example of User_bool_exp, used for filtering User records. It supports logical AND, OR, NOT operations, and filtering by ID or associated StorefrontUsers.

```json
{
  "StorefrontUsers": StorefrontUser_bool_exp,
  "_and": [User_bool_exp],
  "_not": User_bool_exp,
  "_or": [User_bool_exp],
  "id": uuid_comparison_exp
}
```

--------------------------------

### PricingPolicy Type Definition and Example

Source: https://code.skio.com/index

Defines the structure of the PricingPolicy type, including its fields and their data types. It also provides an example of how this type might be represented.

```json
{
  "SellingPlan": SellingPlan,
  "afterCycle": 123,
  "createdAt": timestamptz,
  "fixedPrice": numeric,
  "id": uuid,
  "percentageOff": numeric,
  "sellingPlanId": uuid,
  "sellingPlanPricingPolicyAdjustmentType": "xyz789",
  "updatedAt": timestamptz
}
```

--------------------------------

### Float Data Type Example

Source: https://code.skio.com/index

A simple example representing a floating-point number. This is a basic data type used for numerical values that may have decimal components.

```number
123.45

```

--------------------------------

### Tier Level Configuration Example

Source: https://code.skio.com/index

Represents the configuration for a tier level, including its eligibility and rewards. It contains fields like description, enabled status, name, and tier group ID.

```json
{
  "ProductVariantsCreditRedemptionConfigs": [
    ProductVariantsCreditRedemptionConfigs
  ],
  "description": "abc123",
  "enabled": true,
  "name": "xyz789",
  "removedAt": timestamptz,
  "tierGroupId": uuid
}
```

--------------------------------

### SwapPricingOptionType Enum Example

Source: https://code.skio.com/index

Demonstrates the possible values for the SwapPricingOptionType enumeration, used to specify pricing strategies for subscription product variants.

```json
"CUSTOM"
```

--------------------------------

### CancelFlowV2Session Example Object

Source: https://code.skio.com/index

An example JSON object representing a CancelFlowV2Session, illustrating the structure and potential data types for each field. This can be used for testing or data instantiation.

```json
{
  "CancelFlowSession": CancelFlowSession,
  "Site": Site,
  "Subscription": Subscription,
  "action": "abc123",
  "actions": jsonb,
  "actionsV2": jsonb,
  "actionsV2MultiStep": jsonb,
  "cancelFlowId": uuid,
  "conditions": jsonb,
  "conditionsV2": jsonb,
  "created_at": timestamptz,
  "id": uuid,
  "isMultipleActions": true,
  "isOtherReason": true,
  "isSplashScreen": false,
  "reason": "abc123",
  "reasonPath": jsonb,
  "rebuttal": "xyz789",
  "rebuttalOptions": jsonb,
  "shownActions": jsonb,
  "shownReasons": jsonb,
  "shownRebuttals": jsonb,
  "siteId": uuid,
  "status": "abc123",
  "subscriptionId": uuid,
  "updated_at": timestamptz
}
```

--------------------------------

### CancelFlowV2Reason Schema Example

Source: https://code.skio.com/index

An example structure for the CancelFlowV2Reason type, detailing fields like cancelFlowId, reason, and timestamps. This schema is used for explanations of cancellation reasons.

```json
{
  "CancelFlowV2Rebuttals": [CancelFlowV2Rebuttal],
  "cancelFlowId": uuid,
  "childrenReasonIds": jsonb,
  "created_at": timestamptz,
  "enableCustomerInput": false,
  "enabled": false,
  "id": uuid,
  "isMultipleActions": false,
  "parentReasonId": uuid,
  "reason": "xyz789",
  "removed_at": timestamptz,
  "updated_at": timestamptz
}
```

--------------------------------

### JSONB Comparison Expression Example

Source: https://code.skio.com/index

An example of jsonb_comparison_exp, used for comparing JSONB columns. It supports various operators like equality, containment, key checking, and casting.

```json
{
  "_cast": jsonb_cast_exp,
  "_contained_in": jsonb,
  "_contains": jsonb,
  "_eq": jsonb,
  "_gt": jsonb,
  "_gte": jsonb,
  "_has_key": "xyz789",
  "_has_keys_all": ["xyz789"],
  "_has_keys_any": ["abc123"],
  "_in": [jsonb],
  "_is_null": false,
  "_lt": jsonb,
  "_lte": jsonb,
  "_neq": jsonb,
  "_nin": [jsonb]
}
```

--------------------------------

### POST /graphql - shipNow

Source: https://code.skio.com/index

Creates a subscription order immediately.

```APIDOC
## POST /graphql - shipNow

### Description
Creates a subscription order immediately.

### Method
POST

### Endpoint
/graphql

### Parameters
#### Query Parameters
None

#### Request Body
- **query** (String!) - The GraphQL mutation query.
- **variables** (JSON) - The variables for the mutation.

### Request Example
```json
{
  "query": "mutation shipNow($input: ShipNowInput!) { shipNow(input: $input) { message ok } }",
  "variables": {
    "input": {}
  }
}
```

### Response
#### Success Response (200)
- **data** (Object) - The result of the mutation.
  - **shipNow** (Object)
    - **message** (String) - A message indicating the result of the operation.
    - **ok** (Boolean) - Indicates if the operation was successful.

#### Response Example
```json
{
  "data": {
    "shipNow": {
      "message": "abc123",
      "ok": true
    }
  }
}
```
```

--------------------------------

### Site Boolean Expression Example (JSON)

Source: https://code.skio.com/index

An example of a boolean expression used for filtering rows from the 'Site' table. It demonstrates the use of logical AND, NOT, OR, and specific field comparisons.

```json
{
  "CreditRewards": CreditRewards_bool_exp,
  "Holidays": Holiday_bool_exp,
  "Notifications": Notification_bool_exp,
  "Products": Product_bool_exp,
  "SkioSmsMessagingHistory": SkioSmsMessagingHistory_bool_exp,
  "StorefrontUsers": StorefrontUser_bool_exp,
  "Tags": Tag_bool_exp,
  "Theme": Theme_bool_exp,
  "Theme2": Theme2_bool_exp,
  "_and": [Site_bool_exp],
  "_not": Site_bool_exp,
  "_or": [Site_bool_exp],
  "currencyCode": String_comparison_exp,
  "ianaTimezone": String_comparison_exp,
  "id": uuid_comparison_exp,
  "qaAuthSettings": jsonb_comparison_exp
}
```

--------------------------------

### CancelFlowV2Session_bool_exp Filter Example

Source: https://code.skio.com/index

An example of a boolean expression used to filter rows from the CancelFlowV2Session table. This structure allows for complex filtering logic combining multiple conditions.

```json
{
  "CancelFlowSession": CancelFlowSession_bool_exp,
  "Site": Site_bool_exp,
  "Subscription": Subscription_bool_exp,
  "_and": [CancelFlowV2Session_bool_exp],
  "_not": CancelFlowV2Session_bool_exp,
  "_or": [CancelFlowV2Session_bool_exp],
  "action": String_comparison_exp,
  "actions": jsonb_comparison_exp,
  "actionsV2": jsonb_comparison_exp,
  "actionsV2MultiStep": jsonb_comparison_exp,
  "cancelFlowId": uuid_comparison_exp,
  "conditions": jsonb_comparison_exp,
  "conditionsV2": jsonb_comparison_exp,
  "created_at": timestamptz_comparison_exp,
  "id": uuid_comparison_exp,
  "isMultipleActions": Boolean_comparison_exp,
  "isOtherReason": Boolean_comparison_exp,
  "isSplashScreen": Boolean_comparison_exp,
  "reason": String_comparison_exp,
  "reasonPath": jsonb_comparison_exp,
  "rebuttal": String_comparison_exp,
  "rebuttalOptions": jsonb_comparison_exp,
  "shownActions": jsonb_comparison_exp,
  "shownReasons": jsonb_comparison_exp,
  "shownRebuttals": jsonb_comparison_exp,
  "siteId": uuid_comparison_exp,
  "status": String_comparison_exp,
  "subscriptionId": uuid_comparison_exp,
  "updated_at": timestamptz_comparison_exp
}
```

--------------------------------

### Create Subscription

Source: https://code.skio.com/index

Creates a manual subscription through Skio with the given inputs.

```APIDOC
## POST /subscriptions/create

### Description
Creates a manual subscription through Skio with the given inputs.

### Method
POST

### Endpoint
/subscriptions/create

### Parameters
#### Request Body
- **input** (CreateSubscriptionInput!) - 

### Request Example
```graphql
mutation createSubscription($input: CreateSubscriptionInput!) {
  createSubscription(input: $input) {
    id
    platformId
  }
}
```
```json
{
  "input": CreateSubscriptionInput
}
```

### Response
#### Success Response (200)
- **id** (UUID) - The unique identifier for the created subscription.
- **platformId** (String) - The platform-specific identifier for the subscription.

#### Response Example
```json
{
  "data": {
    "createSubscription": {
      "id": "uuid",
      "platformId": "abc123"
    }
  }
}
```
```

--------------------------------

### Ship Now

Source: https://code.skio.com/index

Initiates an immediate shipment for a subscription.

```APIDOC
## ShipNowInput

### Fields
Input Field | Description  
---|---
`caller` - `String` |   
`subscriptionId` - `String!` |   

### Example
```json
{
  "caller": "abc123",
  "subscriptionId": "xyz789"
}

```

## ShipNowOutput

### Fields
Field Name | Description  
---|---
`message` - `String` |   
`ok` - `Boolean!` |   

### Example
```json
{"message": "abc123", "ok": false}

```
```

--------------------------------

### uuid_comparison_exp Example

Source: https://code.skio.com/index

Example of a boolean expression for comparing 'uuid' values. It supports various operators like equality, inequality, greater than, less than, and null checks.

```json
{
  "_eq": uuid,
  "_gt": uuid,
  "_gte": uuid,
  "_in": [uuid],
  "_is_null": true,
  "_lt": uuid,
  "_lte": uuid,
  "_neq": uuid,
  "_nin": [uuid]
}
```

--------------------------------

### timestamptz_comparison_exp Example

Source: https://code.skio.com/index

Example of a boolean expression for comparing 'timestamptz' values. It supports various operators like equality, inequality, greater than, less than, and null checks.

```json
{
  "_eq": timestamptz,
  "_gt": timestamptz,
  "_gte": timestamptz,
  "_in": [timestamptz],
  "_is_null": true,
  "_lt": timestamptz,
  "_lte": timestamptz,
  "_neq": timestamptz,
  "_nin": [timestamptz]
}
```

--------------------------------

### POST /graphql - swapSubscriptionProductVariants

Source: https://code.skio.com/index

Swaps product variants for a subscription.

```APIDOC
## POST /graphql - swapSubscriptionProductVariants

### Description
Swaps product variants for a subscription.

### Method
POST

### Endpoint
/graphql

### Parameters
#### Query Parameters
None

#### Request Body
- **query** (String!) - The GraphQL mutation query.
- **variables** (JSON) - The variables for the mutation.

### Request Example
```json
{
  "query": "mutation swapSubscriptionProductVariants($input: SwapSubscriptionProductVariantsInput!) { swapSubscriptionProductVariants(input: $input) { ok } }",
  "variables": {
    "input": {}
  }
}
```

### Response
#### Success Response (200)
- **data** (Object) - The result of the mutation.
  - **swapSubscriptionProductVariants** (Object)
    - **ok** (Boolean) - Indicates if the operation was successful.

#### Response Example
```json
{
  "data": {
    "swapSubscriptionProductVariants": {
      "ok": false
    }
  }
}
```
```

--------------------------------

### timestamp_comparison_exp Example

Source: https://code.skio.com/index

Example of a boolean expression for comparing 'timestamp' values. It supports various operators like equality, inequality, greater than, less than, and null checks.

```json
{
  "_eq": timestamp,
  "_gt": timestamp,
  "_gte": timestamp,
  "_in": [timestamp],
  "_is_null": true,
  "_lt": timestamp,
  "_lte": timestamp,
  "_neq": timestamp,
  "_nin": [timestamp]
}
```

--------------------------------

### SurpriseDelightSessions_order_by Example

Source: https://code.skio.com/index

Shows the structure for defining ordering preferences when querying the 'SurpriseDelightSessions' table. It includes options for direct column ordering and nested object ordering.

```json
{
  "Subscription": Subscription_order_by,
  "created_at": "asc",
  "group": "asc",
  "id": "asc",
  "ruleId": "asc",
  "subscriptionId": "asc"
}
```

--------------------------------

### Numeric Comparison Expression Example

Source: https://code.skio.com/index

An example of numeric_comparison_exp, used for comparing numeric columns. It supports standard comparison operators like equal, greater than, less than, and inclusion in a list.

```json
{
  "_eq": numeric,
  "_gt": numeric,
  "_gte": numeric,
  "_in": [numeric],
  "_is_null": false,
  "_lt": numeric,
  "_lte": numeric,
  "_neq": numeric,
  "_nin": [numeric]
}
```

--------------------------------

### CancelFlowReason Object Example

Source: https://code.skio.com/index

This example shows the structure of a CancelFlowReason object, including fields for subscription relationships, unique identifiers, timestamps, and reason details. Note that this table is deprecated.

```json
{
  "CancelFlowSession": CancelFlowSession,
  "cancelFlowId": uuid,
  "cancelFlowSessionId": uuid,
  "createdAt": timestamptz,
  "id": uuid,
  "order": numeric,
  "otherReasonBody": "xyz789",
  "reason": "xyz789",
  "rebuttal": "abc123",
  "updatedAt": timestamptz
}
```