picked 0.0.101-next.2 → 0.0.101

package/docs/reference/management-api/schema/shopify.md

@@ -0,0 +1,795 @@
+---
+type: reference
+layout: docs
+generated: true
+---
+
+# Shopify schema
+
+The operations and types that `shopify.graphql` adds to the Management API. See [Management API schema](/reference/management-api/schema) for every domain, the endpoint and authentication.
+
+## Queries
+
+### `shopifyProduct`
+
+```graphql
+shopifyProduct(input: ShopifyProductInput!): ShopifyProduct @auth @deprecated(reason: "Picked no longer reads Shopify products. Always returns null; will be removed.")
+```
+
+### `shopifyProducts`
+
+```graphql
+shopifyProducts(input: ShopifyProductsInput!): ShopifyProductsResponse! @auth @deprecated(reason: "Picked no longer reads Shopify products. Always returns an empty page; will be removed.")
+```
+
+### `shopifyWebhooks`
+
+List Shopify webhooks for an organisation. Requires authentication.
+
+```graphql
+shopifyWebhooks(input: ShopifyWebhooksInput!): [ShopifyWebhook!]! @auth
+```
+
+### `shopifyMetafieldConfigs`
+
+List Shopify metafield configs for a project. Requires authentication.
+
+```graphql
+shopifyMetafieldConfigs(input: ShopifyMetafieldConfigsInput!): [ShopifyMetafieldConfig!]! @auth
+```
+
+### `organizationShopifyWebhooks`
+
+```graphql
+organizationShopifyWebhooks(input: OrganizationShopifyWebhooksInput!): [ShopifyWebhook!]! @auth @deprecated(reason: "Use `shopifyWebhooks` instead")
+```
+
+### `projectShopifyMetafieldConfigs`
+
+```graphql
+projectShopifyMetafieldConfigs(input: ProjectMetafieldConfigsInput!): [ShopifyMetafieldConfig!]! @auth @deprecated(reason: "Use `shopifyMetafieldConfigs` instead")
+```
+
+## Mutations
+
+### `shopifyWebhookCreate`
+
+Create a new Shopify webhook. Requires authentication.
+
+```graphql
+shopifyWebhookCreate(input: ShopifyWebhookCreateInput!): ShopifyWebhookCreatePayload! @auth
+```
+
+### `shopifyWebhookUpdate`
+
+Update a Shopify webhook. Requires authentication.
+
+```graphql
+shopifyWebhookUpdate(input: ShopifyWebhookUpdateInput!): Boolean! @auth
+```
+
+### `shopifyWebhookDelete`
+
+Delete a Shopify webhook. Requires authentication.
+
+```graphql
+shopifyWebhookDelete(input: ShopifyWebhookDeleteInput!): Boolean! @auth
+```
+
+### `shopifyProductContentUpdate`
+
+Update Shopify product content. Requires authentication.
+
+```graphql
+shopifyProductContentUpdate(input: ShopifyProductContentUpdateInput!): Boolean! @auth
+```
+
+### `shopifyCollectionContentUpdate`
+
+Update Shopify collection content. Requires authentication.
+
+```graphql
+shopifyCollectionContentUpdate(input: ShopifyCollectionContentUpdateInput!): Boolean! @auth
+```
+
+### `shopifyMetafieldConfigCreate`
+
+Create a Shopify metafield config. Requires authentication.
+
+```graphql
+shopifyMetafieldConfigCreate(input: ShopifyMetafieldConfigCreateInput!): ShopifyMetafieldConfig! @auth
+```
+
+### `shopifyMetafieldConfigUpdate`
+
+Update a Shopify metafield config. Requires authentication.
+
+```graphql
+shopifyMetafieldConfigUpdate(input: ShopifyMetafieldConfigUpdateInput!): Boolean! @auth
+```
+
+### `shopifyMetafieldConfigDelete`
+
+Delete a Shopify metafield config. Requires authentication.
+
+```graphql
+shopifyMetafieldConfigDelete(input: ShopifyMetafieldConfigDeleteInput!): Boolean! @auth
+```
+
+### `createShopifyWebhook`
+
+```graphql
+createShopifyWebhook(input: CreateShopifyWebhookInput!): CreateShopifyWebhookResponse! @auth @deprecated(reason: "Use `shopifyWebhookCreate` instead")
+```
+
+### `updateShopifyWebhook`
+
+```graphql
+updateShopifyWebhook(input: UpdateShopifyWebhookInput!): Boolean! @auth @deprecated(reason: "Use `shopifyWebhookUpdate` instead")
+```
+
+### `deleteShopifyWebhook`
+
+```graphql
+deleteShopifyWebhook(input: DeleteShopifyWebhookInput!): Boolean! @auth @deprecated(reason: "Use `shopifyWebhookDelete` instead")
+```
+
+### `updateShopifyProductContent`
+
+```graphql
+updateShopifyProductContent(input: UpdateShopifyProductContentInput!): Boolean! @auth @deprecated(reason: "Use `shopifyProductContentUpdate` instead")
+```
+
+### `updateShopifyCollectionContent`
+
+```graphql
+updateShopifyCollectionContent(input: UpdateShopifyCollectionContentInput!): Boolean! @auth @deprecated(reason: "Use `shopifyCollectionContentUpdate` instead")
+```
+
+### `createShopifyMetafieldConfig`
+
+```graphql
+createShopifyMetafieldConfig(input: CreateShopifyMetafieldConfigInput!): ShopifyMetafieldConfig! @auth @deprecated(reason: "Use `shopifyMetafieldConfigCreate` instead")
+```
+
+### `updateShopifyMetafieldConfig`
+
+```graphql
+updateShopifyMetafieldConfig(input: UpdateShopifyMetafieldConfigInput!): Boolean! @auth @deprecated(reason: "Use `shopifyMetafieldConfigUpdate` instead")
+```
+
+### `deleteShopifyMetafieldConfig`
+
+```graphql
+deleteShopifyMetafieldConfig(input: DeleteShopifyMetafieldConfigInput!): Boolean! @auth @deprecated(reason: "Use `shopifyMetafieldConfigDelete` instead")
+```
+
+## Types
+
+### `ShopifyProductOption`
+
+```graphql
+"""A Shopify product option (e.g. `Color`, `Size`)."""
+type ShopifyProductOption {
+  """Unique identifier for the option."""
+  id: ID
+  """ID of the product this option belongs to."""
+  productId: ID
+  """Display name of the option (e.g. `Color`, `Size`)."""
+  name: String
+  """Position of the option in the product's option list."""
+  position: Int
+  """Available values for this option (e.g. `["Red", "Blue"]`)."""
+  values: [String!]
+}
+```
+
+### `ShopifyImage`
+
+```graphql
+"""A Shopify product image."""
+type ShopifyImage {
+  """Unique identifier for the image."""
+  id: ID
+  """ID of the product this image belongs to."""
+  productId: ID
+  """Position of the image in the product's image list."""
+  position: Int
+  """When this image was created (ISO 8601 string)."""
+  createdAt: String
+  """When this image was last updated (ISO 8601 string)."""
+  updatedAt: String
+  """Width of the image in pixels."""
+  width: Int
+  """Height of the image in pixels."""
+  height: Int
+  """Source URL of the image."""
+  src: String
+  """Base64-encoded image attachment (only set on upload paths)."""
+  attachment: String
+  """Filename of the image."""
+  filename: String
+  """Alt text for the image."""
+  alt: String
+  """IDs of variants associated with this image."""
+  variantIds: [ID!]
+  """Admin GraphQL API ID."""
+  adminGraphqlApiId: String
+}
+```
+
+### `ShopifyVariant`
+
+```graphql
+"""A Shopify product variant."""
+type ShopifyVariant {
+  """Unique identifier for the variant."""
+  id: ID
+  """ID of the product this variant belongs to."""
+  productId: ID
+  """
+  Display title of the variant (typically a composition of option values, e.g. `Red / Small`).
+  """
+  title: String
+  """Stock keeping unit."""
+  sku: String
+  """Position of the variant in the product's variant list."""
+  position: Int
+  """Weight in grams."""
+  grams: Int
+  """Inventory policy (`deny` or `continue`)."""
+  inventoryPolicy: String
+  """Price of the variant (formatted string in the shop's currency)."""
+  price: String
+  """Compare-at price for showing discounts."""
+  compareAtPrice: String
+  """Fulfillment service handling this variant."""
+  fulfillmentService: String
+  """Inventory management service."""
+  inventoryManagement: String
+  """ID of the inventory item."""
+  inventoryItemId: ID
+  """Value of the first product option."""
+  option1: String
+  """Value of the second product option."""
+  option2: String
+  """Value of the third product option."""
+  option3: String
+  """When this variant was created (ISO 8601 string)."""
+  createdAt: String
+  """When this variant was last updated (ISO 8601 string)."""
+  updatedAt: String
+  """Whether this variant is taxable."""
+  taxable: Boolean
+  """Tax code for this variant."""
+  taxCode: String
+  """Barcode of the variant."""
+  barcode: String
+  """ID of the associated image."""
+  imageId: ID
+  """Current inventory quantity."""
+  inventoryQuantity: Int
+  """Weight of the variant (in `weightUnit`)."""
+  weight: String
+  """Unit of weight measurement."""
+  weightUnit: String
+  """Previous inventory quantity before the last update."""
+  oldInventoryQuantity: Int
+  """Whether this variant requires shipping."""
+  requireShipping: Boolean
+  """Admin GraphQL API ID."""
+  adminGraphqlApiId: String
+}
+```
+
+### `ShopifyMetafield`
+
+```graphql
+"""
+A Shopify metafield — arbitrary structured data attached to a product, variant, or other resource.
+"""
+type ShopifyMetafield {
+  """Unique identifier for the metafield."""
+  id: ID
+  """Namespace of the metafield (e.g. `custom`, `seo`)."""
+  namespace: String
+  """Key of the metafield (unique within the namespace)."""
+  key: String
+  """Value of the metafield (encoded per `type`)."""
+  value: String
+  """
+  Type of the metafield value (e.g. `single_line_text_field`, `number_integer`).
+  """
+  type: String
+  """Description of the metafield."""
+  description: String
+  """ID of the resource that owns this metafield."""
+  ownerId: ID
+  """
+  Type of the resource that owns this metafield (e.g. `Product`, `Variant`).
+  """
+  ownerResource: String
+  """When this metafield was created (ISO 8601 string)."""
+  createdAt: String
+  """When this metafield was last updated (ISO 8601 string)."""
+  updatedAt: String
+  """Admin GraphQL API ID."""
+  adminGraphqlApiId: String
+}
+```
+
+### `ShopifyProduct`
+
+```graphql
+"""A Shopify product."""
+type ShopifyProduct {
+  """Unique identifier for the product."""
+  id: ID
+  """Title of the product."""
+  title: String
+  """HTML description of the product."""
+  bodyHtml: String
+  """Vendor of the product."""
+  vendor: String
+  """Product type (free-form taxonomy field)."""
+  productType: String
+  """URL-friendly handle for the product."""
+  handle: String
+  """When this product was created (ISO 8601 string)."""
+  createdAt: String
+  """When this product was last updated (ISO 8601 string)."""
+  updatedAt: String
+  """When this product was published (ISO 8601 string)."""
+  publishedAt: String
+  """Scope of publication (`web`, `global`)."""
+  publishedScope: String
+  """Comma-separated tags for the product."""
+  tags: String
+  """Current status of the product (`active`, `draft`, `archived`)."""
+  status: String
+  """Available options for this product."""
+  options: [ShopifyProductOption!]
+  """Variants of this product."""
+  variants: [ShopifyVariant!]
+  """Primary image of the product."""
+  image: ShopifyImage
+  """All images of the product."""
+  images: [ShopifyImage!]
+  """Theme template suffix."""
+  templateSuffix: String
+  """Global title meta tag."""
+  metafieldsGlobalTitleTag: String
+  """Global description meta tag."""
+  metafieldsGlobalDescriptionTag: String
+  """Metafields attached to this product."""
+  metafields: [ShopifyMetafield!]
+  """Admin GraphQL API ID."""
+  adminGraphqlApiId: String
+}
+```
+
+### `ShopifyProductsResponse`
+
+```graphql
+"""Paginated response for `shopifyProducts`."""
+type ShopifyProductsResponse {
+  """List of products."""
+  products: [ShopifyProduct!]!
+  """Total number of products."""
+  totalCount: Int!
+  """Current page number (1-indexed)."""
+  currentPage: Int!
+  """Total number of pages."""
+  totalPages: Int!
+  """Whether there is a next page."""
+  hasNextPage: Boolean!
+  """Whether there is a previous page."""
+  hasPreviousPage: Boolean!
+}
+```
+
+### `ShopifyProductInput`
+
+```graphql
+"""Input for `shopifyProduct`. Provide either `productId` or `handle`."""
+input ShopifyProductInput {
+  """Shop identifier (the `*.myshopify.com` subdomain)."""
+  shopId: String!
+  """Product ID to look up."""
+  productId: String
+  """Product handle to look up (URL-friendly slug)."""
+  handle: String
+}
+```
+
+### `ShopifyProductsInput`
+
+```graphql
+"""Input for `shopifyProducts`."""
+input ShopifyProductsInput {
+  """Shop identifier."""
+  shopId: String!
+  """Maximum number of products to return per page."""
+  limit: Int
+  """Page number to return (1-indexed)."""
+  page: Int
+}
+```
+
+### `ShopifyWebhook`
+
+```graphql
+"""
+Shopify webhook configuration — a Picked-managed webhook receiver that
+forwards events to the configured `endpointUrl`. The Picked HMAC secret
+returned by `shopifyWebhookCreate` is the only place it is exposed; show
+once and discard.
+"""
+type ShopifyWebhook {
+  """Unique identifier for the webhook."""
+  id: ID!
+  """ID of the organisation this webhook belongs to."""
+  organizationId: ID!
+  """ID of the project this webhook belongs to."""
+  projectId: ID!
+  """ID of the API key used for authentication."""
+  apiKeyId: ID!
+  """Display name of the webhook."""
+  name: String!
+  """Description of the webhook's purpose."""
+  description: String
+  """URL that will receive webhook events."""
+  endpointUrl: String!
+  """Whether the webhook is currently active."""
+  isActive: Boolean!
+  """Request timeout in milliseconds."""
+  timeoutMs: Int!
+  """Number of retry attempts on failure."""
+  retryCount: Int!
+  """Name of the associated API key (denormalised for display)."""
+  apiKeyName: String
+  """Prefix of the associated API key (denormalised for display)."""
+  apiKeyPrefix: String
+  """When this webhook was created (ISO 8601 string)."""
+  createdAt: String!
+  """When this webhook was last updated (ISO 8601 string)."""
+  updatedAt: String!
+}
+```
+
+### `ShopifyWebhookCreatePayload`
+
+```graphql
+"""
+Payload returned by `shopifyWebhookCreate`. WARNING: `webhookSecret` is shown only once — store it now.
+"""
+type ShopifyWebhookCreatePayload {
+  """The created webhook."""
+  webhook: ShopifyWebhook!
+  """
+  Webhook HMAC secret for verifying payloads. Shown once — store securely.
+  """
+  webhookSecret: String!
+}
+```
+
+### `ShopifyWebhooksInput`
+
+```graphql
+"""Input for listing Shopify webhooks."""
+input ShopifyWebhooksInput {
+  """ID of the organisation to list webhooks for."""
+  organizationId: ID!
+}
+```
+
+### `ShopifyWebhookCreateInput`
+
+```graphql
+"""Input for `shopifyWebhookCreate`."""
+input ShopifyWebhookCreateInput {
+  """ID of the organisation."""
+  organizationId: ID!
+  """ID of the project."""
+  projectId: ID!
+  """ID of the API key for webhook authentication."""
+  apiKeyId: ID!
+  """Display name for the webhook."""
+  name: String!
+  """Description of the webhook's purpose."""
+  description: String
+  """URL that will receive webhook events."""
+  endpointUrl: String!
+  """
+  Request timeout in milliseconds. Server picks a sensible default if omitted.
+  """
+  timeoutMs: Int
+  """
+  Number of retry attempts on failure. Server picks a sensible default if omitted.
+  """
+  retryCount: Int
+}
+```
+
+### `ShopifyWebhookUpdateInput`
+
+```graphql
+"""Input for `shopifyWebhookUpdate`. Omit a field to leave it unchanged."""
+input ShopifyWebhookUpdateInput {
+  """ID of the webhook to update."""
+  webhookId: ID!
+  """ID of the organisation the webhook belongs to."""
+  organizationId: ID!
+  """New display name."""
+  name: String
+  """New description."""
+  description: String
+  """New endpoint URL."""
+  endpointUrl: String
+  """Whether the webhook should be active."""
+  isActive: Boolean
+  """New API key ID for authentication."""
+  apiKeyId: ID
+  """New timeout in milliseconds."""
+  timeoutMs: Int
+  """New retry count."""
+  retryCount: Int
+}
+```
+
+### `ShopifyWebhookDeleteInput`
+
+```graphql
+"""Input for `shopifyWebhookDelete`."""
+input ShopifyWebhookDeleteInput {
+  """ID of the webhook to delete."""
+  webhookId: ID!
+  """ID of the organisation the webhook belongs to."""
+  organizationId: ID!
+}
+```
+
+### `CreateShopifyWebhookResponse`
+
+```graphql
+"""Deprecated — use `ShopifyWebhookCreatePayload`."""
+type CreateShopifyWebhookResponse {
+  """The created webhook."""
+  webhook: ShopifyWebhook!
+  """Webhook HMAC secret. Shown once."""
+  webhookSecret: String!
+}
+```
+
+### `CreateShopifyWebhookInput`
+
+```graphql
+"""Deprecated — use `ShopifyWebhookCreateInput`."""
+input CreateShopifyWebhookInput {
+  organizationId: ID!
+  projectId: ID!
+  apiKeyId: ID!
+  name: String!
+  description: String
+  endpointUrl: String!
+  timeoutMs: Int
+  retryCount: Int
+}
+```
+
+### `UpdateShopifyWebhookInput`
+
+```graphql
+"""Deprecated — use `ShopifyWebhookUpdateInput`."""
+input UpdateShopifyWebhookInput {
+  webhookId: ID!
+  organizationId: ID!
+  name: String
+  description: String
+  endpointUrl: String
+  isActive: Boolean
+  apiKeyId: ID
+  timeoutMs: Int
+  retryCount: Int
+}
+```
+
+### `DeleteShopifyWebhookInput`
+
+```graphql
+"""Deprecated — use `ShopifyWebhookDeleteInput`."""
+input DeleteShopifyWebhookInput {
+  webhookId: ID!
+  organizationId: ID!
+}
+```
+
+### `OrganizationShopifyWebhooksInput`
+
+```graphql
+"""Deprecated — use `ShopifyWebhooksInput`."""
+input OrganizationShopifyWebhooksInput {
+  organizationId: ID!
+}
+```
+
+### `ShopifyMetafieldConfig`
+
+```graphql
+"""
+Shopify metafield-sync configuration for a project: which metafield
+namespaces / keys to pull from Shopify and how many
+metafields to ingest per resource.
+"""
+type ShopifyMetafieldConfig {
+  """Unique identifier for the config."""
+  id: ID!
+  """ID of the project this config belongs to."""
+  projectId: String!
+  """Metafield namespace to sync (e.g. `custom`)."""
+  namespace: String!
+  """Maximum number of metafields to sync per resource."""
+  maxMetafields: Int!
+  """
+  Specific metafield keys to sync. Null means sync all keys in the namespace.
+  """
+  keys: [String!]
+  """When this config was created (ISO 8601 string)."""
+  createdAt: String!
+  """When this config was last updated (ISO 8601 string)."""
+  updatedAt: String!
+}
+```
+
+### `ShopifyMetafieldConfigsInput`
+
+```graphql
+"""Input for listing Shopify metafield configs."""
+input ShopifyMetafieldConfigsInput {
+  """ID of the project to list configs for."""
+  projectId: ID!
+}
+```
+
+### `ShopifyMetafieldConfigCreateInput`
+
+```graphql
+"""Input for `shopifyMetafieldConfigCreate`."""
+input ShopifyMetafieldConfigCreateInput {
+  """ID of the project."""
+  projectId: ID!
+  """Metafield namespace to sync."""
+  namespace: String!
+  """Maximum number of metafields to sync."""
+  maxMetafields: Int!
+  """Specific metafield keys to sync. Null means sync all keys."""
+  keys: [String!]
+}
+```
+
+### `ShopifyMetafieldConfigUpdateInput`
+
+```graphql
+"""
+Input for `shopifyMetafieldConfigUpdate`. Omit a field to leave it unchanged.
+"""
+input ShopifyMetafieldConfigUpdateInput {
+  """ID of the config to update."""
+  id: ID!
+  """New maximum number of metafields."""
+  maxMetafields: Int
+  """New list of metafield keys."""
+  keys: [String!]
+}
+```
+
+### `ShopifyMetafieldConfigDeleteInput`
+
+```graphql
+"""Input for `shopifyMetafieldConfigDelete`."""
+input ShopifyMetafieldConfigDeleteInput {
+  """ID of the config to delete."""
+  id: ID!
+}
+```
+
+### `ProjectMetafieldConfigsInput`
+
+```graphql
+"""Deprecated — use `ShopifyMetafieldConfigsInput`."""
+input ProjectMetafieldConfigsInput {
+  projectId: ID!
+}
+```
+
+### `CreateShopifyMetafieldConfigInput`
+
+```graphql
+"""Deprecated — use `ShopifyMetafieldConfigCreateInput`."""
+input CreateShopifyMetafieldConfigInput {
+  projectId: ID!
+  namespace: String!
+  maxMetafields: Int!
+  keys: [String!]
+}
+```
+
+### `UpdateShopifyMetafieldConfigInput`
+
+```graphql
+"""Deprecated — use `ShopifyMetafieldConfigUpdateInput`."""
+input UpdateShopifyMetafieldConfigInput {
+  id: ID!
+  maxMetafields: Int
+  keys: [String!]
+}
+```
+
+### `DeleteShopifyMetafieldConfigInput`
+
+```graphql
+"""Deprecated — use `ShopifyMetafieldConfigDeleteInput`."""
+input DeleteShopifyMetafieldConfigInput {
+  id: ID!
+}
+```
+
+### `ShopifyProductContentUpdateInput`
+
+```graphql
+"""
+Input for `shopifyProductContentUpdate` — patch a Picked-managed content key for a Shopify product.
+"""
+input ShopifyProductContentUpdateInput {
+  """Shop identifier."""
+  shopId: String!
+  """Product ID to update content for."""
+  productId: String!
+  """Content key."""
+  key: String!
+  """Content data."""
+  content: JSON!
+}
+```
+
+### `ShopifyCollectionContentUpdateInput`
+
+```graphql
+"""
+Input for `shopifyCollectionContentUpdate` — patch a Picked-managed content key for a Shopify collection.
+"""
+input ShopifyCollectionContentUpdateInput {
+  """Shop identifier."""
+  shopId: String!
+  """Collection ID to update content for."""
+  collectionId: String!
+  """Content key."""
+  key: String!
+  """Content data."""
+  content: JSON!
+}
+```
+
+### `UpdateShopifyProductContentInput`
+
+```graphql
+"""Deprecated — use `ShopifyProductContentUpdateInput`."""
+input UpdateShopifyProductContentInput {
+  shopId: String!
+  productId: String!
+  key: String!
+  content: JSON!
+}
+```
+
+### `UpdateShopifyCollectionContentInput`
+
+```graphql
+"""Deprecated — use `ShopifyCollectionContentUpdateInput`."""
+input UpdateShopifyCollectionContentInput {
+  shopId: String!
+  collectionId: String!
+  key: String!
+  content: JSON!
+}
+```