ServerBISSubscriptionCreateQueryResourceObject

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ServerBISSubscriptionCreateQueryResourceObject",
  "title": "ServerBISSubscriptionCreateQueryResourceObject",
  "type": "object",
  "properties": {
    "type": {
      "$ref": "#/components/schemas/BackInStockSubscriptionEnum"
    },
    "attributes": {
      "type": "object",
      "properties": {
        "channels": {
          "description": "The channel(s) through which the profile would like to receive the back in stock notification. This can be leveraged within a back in stock flow to notify the subscriber through their preferred channel(s).",
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "EMAIL",
              "PUSH",
              "SMS",
              "WHATSAPP"
            ],
            "description": "The different channel types that a profile could subscribe to BIS notifications for"
          },
          "example": [
            "EMAIL",
            "SMS"
          ]
        },
        "profile": {
          "type": "object",
          "example": {
            "data": {
              "type": "profile",
              "attributes": {
                "id": "01GDDKASAP8TKDDA2GRZDSVP4H",
                "email": "[email protected]",
                "phone_number": "+15005550006",
                "external_id": "63f64a2b-c6bf-40c7-b81f-bed08162edbe"
              }
            }
          },
          "nullable": true,
          "properties": {
            "data": {
              "$ref": "#/components/schemas/ProfileIdentifierDTOResourceObject"
            }
          },
          "required": [
            "data"
          ]
        }
      },
      "required": [
        "channels"
      ]
    },
    "relationships": {
      "type": "object",
      "properties": {
        "variant": {
          "type": "object",
          "properties": {
            "data": {
              "type": "object",
              "properties": {
                "type": {
                  "$ref": "#/components/schemas/CatalogVariantEnum"
                },
                "id": {
                  "description": "The catalog variant ID for which the profile is subscribing to back in stock notifications. This ID is made up of the integration type, catalog ID, and and the external ID of the variant like so: `integrationType:::catalogId:::externalId`. If the integration you are using is not set up for multi-catalog storage, the 'catalogId' will be `$default`. For Shopify `$shopify:::$default:::33001893429341`",
                  "type": "string",
                  "example": "$custom:::$default:::SAMPLE-DATA-ITEM-1-VARIANT-MEDIUM"
                }
              },
              "required": [
                "type",
                "id"
              ]
            }
          }
        }
      },
      "required": [
        "variant"
      ]
    }
  },
  "required": [
    "type",
    "attributes",
    "relationships"
  ]
}