picked 0.0.101 → 0.0.102-next.2

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

@@ -6,25 +6,30 @@ 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.
+See [Management API schema](/reference/management-api/schema) for every domain, the endpoint and authentication.
 
 ## Queries
 
 ### `shopifyProduct`
 
+Reads a Shopify product. Always returns null.
+
 ```graphql
 shopifyProduct(input: ShopifyProductInput!): ShopifyProduct @auth @deprecated(reason: "Picked no longer reads Shopify products. Always returns null; will be removed.")
 ```
 
 ### `shopifyProducts`
 
+Lists Shopify products. Always returns an empty page.
+
 ```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.
+Lists an organisation's Shopify webhooks.
+Scope: `ORGANIZATION_INTEGRATIONS_READ`.
 
 ```graphql
 shopifyWebhooks(input: ShopifyWebhooksInput!): [ShopifyWebhook!]! @auth
@@ -32,7 +37,8 @@ shopifyWebhooks(input: ShopifyWebhooksInput!): [ShopifyWebhook!]! @auth
 
 ### `shopifyMetafieldConfigs`
 
-List Shopify metafield configs for a project. Requires authentication.
+Lists a project's Shopify metafield configs.
+Scope: `ORGANIZATION_INTEGRATIONS_READ`.
 
 ```graphql
 shopifyMetafieldConfigs(input: ShopifyMetafieldConfigsInput!): [ShopifyMetafieldConfig!]! @auth
@@ -40,12 +46,18 @@ shopifyMetafieldConfigs(input: ShopifyMetafieldConfigsInput!): [ShopifyMetafield
 
 ### `organizationShopifyWebhooks`
 
+Lists an organisation's Shopify webhooks.
+Scope: `ORGANIZATION_INTEGRATIONS_READ`.
+
 ```graphql
 organizationShopifyWebhooks(input: OrganizationShopifyWebhooksInput!): [ShopifyWebhook!]! @auth @deprecated(reason: "Use `shopifyWebhooks` instead")
 ```
 
 ### `projectShopifyMetafieldConfigs`
 
+Lists a project's Shopify metafield configs.
+Scope: `ORGANIZATION_INTEGRATIONS_READ`.
+
 ```graphql
 projectShopifyMetafieldConfigs(input: ProjectMetafieldConfigsInput!): [ShopifyMetafieldConfig!]! @auth @deprecated(reason: "Use `shopifyMetafieldConfigs` instead")
 ```
@@ -54,7 +66,9 @@ projectShopifyMetafieldConfigs(input: ProjectMetafieldConfigsInput!): [ShopifyMe
 
 ### `shopifyWebhookCreate`
 
-Create a new Shopify webhook. Requires authentication.
+Creates a Shopify webhook for a project and generates its HMAC secret. The result is the only
+place the secret appears.
+Scope: `ORGANIZATION_INTEGRATIONS_CREATE` and `ORGANIZATION_INTEGRATIONS_READ`.
 
 ```graphql
 shopifyWebhookCreate(input: ShopifyWebhookCreateInput!): ShopifyWebhookCreatePayload! @auth
@@ -62,7 +76,8 @@ shopifyWebhookCreate(input: ShopifyWebhookCreateInput!): ShopifyWebhookCreatePay
 
 ### `shopifyWebhookUpdate`
 
-Update a Shopify webhook. Requires authentication.
+Updates a Shopify webhook.
+Scope: `ORGANIZATION_INTEGRATIONS_UPDATE`.
 
 ```graphql
 shopifyWebhookUpdate(input: ShopifyWebhookUpdateInput!): Boolean! @auth
@@ -70,7 +85,8 @@ shopifyWebhookUpdate(input: ShopifyWebhookUpdateInput!): Boolean! @auth
 
 ### `shopifyWebhookDelete`
 
-Delete a Shopify webhook. Requires authentication.
+Deletes a Shopify webhook.
+Scope: `ORGANIZATION_INTEGRATIONS_DELETE`.
 
 ```graphql
 shopifyWebhookDelete(input: ShopifyWebhookDeleteInput!): Boolean! @auth
@@ -78,7 +94,9 @@ shopifyWebhookDelete(input: ShopifyWebhookDeleteInput!): Boolean! @auth
 
 ### `shopifyProductContentUpdate`
 
-Update Shopify product content. Requires authentication.
+Updates the content at `key` of a Shopify product, stored in its app metafield `content.<key>`.
+Keeps up to nine earlier values. The shop must belong to the calling API key's organisation.
+Scope: `ORGANIZATION_INTEGRATIONS_UPDATE`.
 
 ```graphql
 shopifyProductContentUpdate(input: ShopifyProductContentUpdateInput!): Boolean! @auth
@@ -86,7 +104,9 @@ shopifyProductContentUpdate(input: ShopifyProductContentUpdateInput!): Boolean!
 
 ### `shopifyCollectionContentUpdate`
 
-Update Shopify collection content. Requires authentication.
+Updates the content at `key` of a Shopify collection, stored in its app metafield `content.<key>`.
+Keeps up to nine earlier values. The shop must belong to the calling API key's organisation.
+Scope: `ORGANIZATION_INTEGRATIONS_UPDATE`.
 
 ```graphql
 shopifyCollectionContentUpdate(input: ShopifyCollectionContentUpdateInput!): Boolean! @auth
@@ -94,7 +114,8 @@ shopifyCollectionContentUpdate(input: ShopifyCollectionContentUpdateInput!): Boo
 
 ### `shopifyMetafieldConfigCreate`
 
-Create a Shopify metafield config. Requires authentication.
+Creates a Shopify metafield config for a project.
+Scope: `ORGANIZATION_INTEGRATIONS_CREATE`.
 
 ```graphql
 shopifyMetafieldConfigCreate(input: ShopifyMetafieldConfigCreateInput!): ShopifyMetafieldConfig! @auth
@@ -102,7 +123,8 @@ shopifyMetafieldConfigCreate(input: ShopifyMetafieldConfigCreateInput!): Shopify
 
 ### `shopifyMetafieldConfigUpdate`
 
-Update a Shopify metafield config. Requires authentication.
+Updates a Shopify metafield config.
+Scope: `ORGANIZATION_INTEGRATIONS_UPDATE`.
 
 ```graphql
 shopifyMetafieldConfigUpdate(input: ShopifyMetafieldConfigUpdateInput!): Boolean! @auth
@@ -110,7 +132,8 @@ shopifyMetafieldConfigUpdate(input: ShopifyMetafieldConfigUpdateInput!): Boolean
 
 ### `shopifyMetafieldConfigDelete`
 
-Delete a Shopify metafield config. Requires authentication.
+Deletes a Shopify metafield config.
+Scope: `ORGANIZATION_INTEGRATIONS_DELETE`.
 
 ```graphql
 shopifyMetafieldConfigDelete(input: ShopifyMetafieldConfigDeleteInput!): Boolean! @auth
@@ -118,48 +141,75 @@ shopifyMetafieldConfigDelete(input: ShopifyMetafieldConfigDeleteInput!): Boolean
 
 ### `createShopifyWebhook`
 
+Creates a Shopify webhook for a project and generates its HMAC secret. The result is the only
+place the secret appears.
+Scope: `ORGANIZATION_INTEGRATIONS_CREATE` and `ORGANIZATION_INTEGRATIONS_READ`.
+
 ```graphql
 createShopifyWebhook(input: CreateShopifyWebhookInput!): CreateShopifyWebhookResponse! @auth @deprecated(reason: "Use `shopifyWebhookCreate` instead")
 ```
 
 ### `updateShopifyWebhook`
 
+Updates a Shopify webhook.
+Scope: `ORGANIZATION_INTEGRATIONS_UPDATE`.
+
 ```graphql
 updateShopifyWebhook(input: UpdateShopifyWebhookInput!): Boolean! @auth @deprecated(reason: "Use `shopifyWebhookUpdate` instead")
 ```
 
 ### `deleteShopifyWebhook`
 
+Deletes a Shopify webhook.
+Scope: `ORGANIZATION_INTEGRATIONS_DELETE`.
+
 ```graphql
 deleteShopifyWebhook(input: DeleteShopifyWebhookInput!): Boolean! @auth @deprecated(reason: "Use `shopifyWebhookDelete` instead")
 ```
 
 ### `updateShopifyProductContent`
 
+Updates the content at `key` of a Shopify product, stored in its app metafield `content.<key>`.
+Keeps up to nine earlier values. The shop must belong to the calling API key's organisation.
+Scope: `ORGANIZATION_INTEGRATIONS_UPDATE`.
+
 ```graphql
 updateShopifyProductContent(input: UpdateShopifyProductContentInput!): Boolean! @auth @deprecated(reason: "Use `shopifyProductContentUpdate` instead")
 ```
 
 ### `updateShopifyCollectionContent`
 
+Updates the content at `key` of a Shopify collection, stored in its app metafield `content.<key>`.
+Keeps up to nine earlier values. The shop must belong to the calling API key's organisation.
+Scope: `ORGANIZATION_INTEGRATIONS_UPDATE`.
+
 ```graphql
 updateShopifyCollectionContent(input: UpdateShopifyCollectionContentInput!): Boolean! @auth @deprecated(reason: "Use `shopifyCollectionContentUpdate` instead")
 ```
 
 ### `createShopifyMetafieldConfig`
 
+Creates a Shopify metafield config for a project.
+Scope: `ORGANIZATION_INTEGRATIONS_CREATE`.
+
 ```graphql
 createShopifyMetafieldConfig(input: CreateShopifyMetafieldConfigInput!): ShopifyMetafieldConfig! @auth @deprecated(reason: "Use `shopifyMetafieldConfigCreate` instead")
 ```
 
 ### `updateShopifyMetafieldConfig`
 
+Updates a Shopify metafield config.
+Scope: `ORGANIZATION_INTEGRATIONS_UPDATE`.
+
 ```graphql
 updateShopifyMetafieldConfig(input: UpdateShopifyMetafieldConfigInput!): Boolean! @auth @deprecated(reason: "Use `shopifyMetafieldConfigUpdate` instead")
 ```
 
 ### `deleteShopifyMetafieldConfig`
 
+Deletes a Shopify metafield config.
+Scope: `ORGANIZATION_INTEGRATIONS_DELETE`.
+
 ```graphql
 deleteShopifyMetafieldConfig(input: DeleteShopifyMetafieldConfigInput!): Boolean! @auth @deprecated(reason: "Use `shopifyMetafieldConfigDelete` instead")
 ```
@@ -169,17 +219,17 @@ deleteShopifyMetafieldConfig(input: DeleteShopifyMetafieldConfigInput!): Boolean
 ### `ShopifyProductOption`
 
 ```graphql
-"""A Shopify product option (e.g. `Color`, `Size`)."""
+"""An option of a Shopify product, such as `Color` or `Size`."""
 type ShopifyProductOption {
-  """Unique identifier for the option."""
+  """The ID of the option."""
   id: ID
-  """ID of the product this option belongs to."""
+  """The ID of the product the option belongs to."""
   productId: ID
-  """Display name of the option (e.g. `Color`, `Size`)."""
+  """The option's name, such as `Color`."""
   name: String
-  """Position of the option in the product's option list."""
+  """The option's position in the product's options."""
   position: Int
-  """Available values for this option (e.g. `["Red", "Blue"]`)."""
+  """The option's values, such as `["Red", "Blue"]`."""
   values: [String!]
 }
 ```
@@ -187,33 +237,33 @@ type ShopifyProductOption {
 ### `ShopifyImage`
 
 ```graphql
-"""A Shopify product image."""
+"""An image of a Shopify product."""
 type ShopifyImage {
-  """Unique identifier for the image."""
+  """The ID of the image."""
   id: ID
-  """ID of the product this image belongs to."""
+  """The ID of the product the image belongs to."""
   productId: ID
-  """Position of the image in the product's image list."""
+  """The image's position in the product's images."""
   position: Int
-  """When this image was created (ISO 8601 string)."""
+  """When the image was created, as an ISO 8601 string."""
   createdAt: String
-  """When this image was last updated (ISO 8601 string)."""
+  """When the image last changed, as an ISO 8601 string."""
   updatedAt: String
-  """Width of the image in pixels."""
+  """The width in pixels."""
   width: Int
-  """Height of the image in pixels."""
+  """The height in pixels."""
   height: Int
-  """Source URL of the image."""
+  """The image URL."""
   src: String
-  """Base64-encoded image attachment (only set on upload paths)."""
+  """The image as Base64. Null except on upload."""
   attachment: String
-  """Filename of the image."""
+  """The file name."""
   filename: String
-  """Alt text for the image."""
+  """The alt text."""
   alt: String
-  """IDs of variants associated with this image."""
+  """The IDs of the variants that show the image."""
   variantIds: [ID!]
-  """Admin GraphQL API ID."""
+  """The image's Shopify Admin GraphQL API ID."""
   adminGraphqlApiId: String
 }
 ```
@@ -221,63 +271,61 @@ type ShopifyImage {
 ### `ShopifyVariant`
 
 ```graphql
-"""A Shopify product variant."""
+"""A variant of a Shopify product."""
 type ShopifyVariant {
-  """Unique identifier for the variant."""
+  """The ID of the variant."""
   id: ID
-  """ID of the product this variant belongs to."""
+  """The ID of the product the variant belongs to."""
   productId: ID
-  """
-  Display title of the variant (typically a composition of option values, e.g. `Red / Small`).
-  """
+  """The variant's title, usually its option values, such as `Red / Small`."""
   title: String
-  """Stock keeping unit."""
+  """The stock keeping unit."""
   sku: String
-  """Position of the variant in the product's variant list."""
+  """The variant's position in the product's variants."""
   position: Int
-  """Weight in grams."""
+  """The weight in grams."""
   grams: Int
-  """Inventory policy (`deny` or `continue`)."""
+  """What happens when the variant is out of stock: `deny` or `continue`."""
   inventoryPolicy: String
-  """Price of the variant (formatted string in the shop's currency)."""
+  """The price, in the shop's currency."""
   price: String
-  """Compare-at price for showing discounts."""
+  """The compare-at price."""
   compareAtPrice: String
-  """Fulfillment service handling this variant."""
+  """The fulfilment service."""
   fulfillmentService: String
-  """Inventory management service."""
+  """The inventory management service."""
   inventoryManagement: String
-  """ID of the inventory item."""
+  """The ID of the inventory item."""
   inventoryItemId: ID
-  """Value of the first product option."""
+  """The value of the first option."""
   option1: String
-  """Value of the second product option."""
+  """The value of the second option."""
   option2: String
-  """Value of the third product option."""
+  """The value of the third option."""
   option3: String
-  """When this variant was created (ISO 8601 string)."""
+  """When the variant was created, as an ISO 8601 string."""
   createdAt: String
-  """When this variant was last updated (ISO 8601 string)."""
+  """When the variant last changed, as an ISO 8601 string."""
   updatedAt: String
-  """Whether this variant is taxable."""
+  """Whether the variant is taxable."""
   taxable: Boolean
-  """Tax code for this variant."""
+  """The tax code."""
   taxCode: String
-  """Barcode of the variant."""
+  """The barcode."""
   barcode: String
-  """ID of the associated image."""
+  """The ID of the variant's image."""
   imageId: ID
-  """Current inventory quantity."""
+  """The inventory quantity."""
   inventoryQuantity: Int
-  """Weight of the variant (in `weightUnit`)."""
+  """The weight, in `weightUnit`."""
   weight: String
-  """Unit of weight measurement."""
+  """The unit of `weight`."""
   weightUnit: String
-  """Previous inventory quantity before the last update."""
+  """The inventory quantity before the last change."""
   oldInventoryQuantity: Int
-  """Whether this variant requires shipping."""
+  """Whether the variant needs shipping."""
   requireShipping: Boolean
-  """Admin GraphQL API ID."""
+  """The variant's Shopify Admin GraphQL API ID."""
   adminGraphqlApiId: String
 }
 ```
@@ -286,34 +334,30 @@ type ShopifyVariant {
 
 ```graphql
 """
-A Shopify metafield — arbitrary structured data attached to a product, variant, or other resource.
+A Shopify metafield: structured data attached to a product, variant or other resource.
 """
 type ShopifyMetafield {
-  """Unique identifier for the metafield."""
+  """The ID of the metafield."""
   id: ID
-  """Namespace of the metafield (e.g. `custom`, `seo`)."""
+  """The metafield's namespace, such as `custom`."""
   namespace: String
-  """Key of the metafield (unique within the namespace)."""
+  """The metafield's key, unique within its namespace."""
   key: String
-  """Value of the metafield (encoded per `type`)."""
+  """The value, encoded as `type` defines."""
   value: String
-  """
-  Type of the metafield value (e.g. `single_line_text_field`, `number_integer`).
-  """
+  """The value type, such as `single_line_text_field`."""
   type: String
-  """Description of the metafield."""
+  """The metafield's description."""
   description: String
-  """ID of the resource that owns this metafield."""
+  """The ID of the resource the metafield belongs to."""
   ownerId: ID
-  """
-  Type of the resource that owns this metafield (e.g. `Product`, `Variant`).
-  """
+  """The type of the resource the metafield belongs to, such as `Product`."""
   ownerResource: String
-  """When this metafield was created (ISO 8601 string)."""
+  """When the metafield was created, as an ISO 8601 string."""
   createdAt: String
-  """When this metafield was last updated (ISO 8601 string)."""
+  """When the metafield last changed, as an ISO 8601 string."""
   updatedAt: String
-  """Admin GraphQL API ID."""
+  """The metafield's Shopify Admin GraphQL API ID."""
   adminGraphqlApiId: String
 }
 ```
@@ -323,47 +367,47 @@ type ShopifyMetafield {
 ```graphql
 """A Shopify product."""
 type ShopifyProduct {
-  """Unique identifier for the product."""
+  """The ID of the product."""
   id: ID
-  """Title of the product."""
+  """The product's title."""
   title: String
-  """HTML description of the product."""
+  """The product's description, as HTML."""
   bodyHtml: String
-  """Vendor of the product."""
+  """The vendor."""
   vendor: String
-  """Product type (free-form taxonomy field)."""
+  """The product type."""
   productType: String
-  """URL-friendly handle for the product."""
+  """The product's handle in URLs."""
   handle: String
-  """When this product was created (ISO 8601 string)."""
+  """When the product was created, as an ISO 8601 string."""
   createdAt: String
-  """When this product was last updated (ISO 8601 string)."""
+  """When the product last changed, as an ISO 8601 string."""
   updatedAt: String
-  """When this product was published (ISO 8601 string)."""
+  """When the product was published, as an ISO 8601 string."""
   publishedAt: String
-  """Scope of publication (`web`, `global`)."""
+  """Where the product is published: `web` or `global`."""
   publishedScope: String
-  """Comma-separated tags for the product."""
+  """The product's tags, comma-separated."""
   tags: String
-  """Current status of the product (`active`, `draft`, `archived`)."""
+  """The product's status: `active`, `draft` or `archived`."""
   status: String
-  """Available options for this product."""
+  """The product's options."""
   options: [ShopifyProductOption!]
-  """Variants of this product."""
+  """The product's variants."""
   variants: [ShopifyVariant!]
-  """Primary image of the product."""
+  """The product's main image."""
   image: ShopifyImage
-  """All images of the product."""
+  """The product's images."""
   images: [ShopifyImage!]
-  """Theme template suffix."""
+  """The suffix of the product's theme template."""
   templateSuffix: String
-  """Global title meta tag."""
+  """The title meta tag."""
   metafieldsGlobalTitleTag: String
-  """Global description meta tag."""
+  """The description meta tag."""
   metafieldsGlobalDescriptionTag: String
-  """Metafields attached to this product."""
+  """The product's metafields."""
   metafields: [ShopifyMetafield!]
-  """Admin GraphQL API ID."""
+  """The product's Shopify Admin GraphQL API ID."""
   adminGraphqlApiId: String
 }
 ```
@@ -371,19 +415,19 @@ type ShopifyProduct {
 ### `ShopifyProductsResponse`
 
 ```graphql
-"""Paginated response for `shopifyProducts`."""
+"""A page of Shopify products."""
 type ShopifyProductsResponse {
-  """List of products."""
+  """The products in the page."""
   products: [ShopifyProduct!]!
-  """Total number of products."""
+  """The number of products in all pages."""
   totalCount: Int!
-  """Current page number (1-indexed)."""
+  """The page number, from 1."""
   currentPage: Int!
-  """Total number of pages."""
+  """The number of pages."""
   totalPages: Int!
-  """Whether there is a next page."""
+  """Whether a later page exists."""
   hasNextPage: Boolean!
-  """Whether there is a previous page."""
+  """Whether an earlier page exists."""
   hasPreviousPage: Boolean!
 }
 ```
@@ -391,13 +435,13 @@ type ShopifyProductsResponse {
 ### `ShopifyProductInput`
 
 ```graphql
-"""Input for `shopifyProduct`. Provide either `productId` or `handle`."""
+"""The input of `shopifyProduct`. Set `productId` or `handle`."""
 input ShopifyProductInput {
-  """Shop identifier (the `*.myshopify.com` subdomain)."""
+  """The shop's `myshopify.com` domain."""
   shopId: String!
-  """Product ID to look up."""
+  """The ID of the product."""
   productId: String
-  """Product handle to look up (URL-friendly slug)."""
+  """The product's handle."""
   handle: String
 }
 ```
@@ -405,13 +449,13 @@ input ShopifyProductInput {
 ### `ShopifyProductsInput`
 
 ```graphql
-"""Input for `shopifyProducts`."""
+"""The input of `shopifyProducts`."""
 input ShopifyProductsInput {
-  """Shop identifier."""
+  """The shop's `myshopify.com` domain."""
   shopId: String!
-  """Maximum number of products to return per page."""
+  """The number of products in a page."""
   limit: Int
-  """Page number to return (1-indexed)."""
+  """The page number, from 1."""
   page: Int
 }
 ```
@@ -420,39 +464,37 @@ input ShopifyProductsInput {
 
 ```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.
+A webhook endpoint configured for a project's Shopify integration, with the API key and delivery
+settings it uses.
 """
 type ShopifyWebhook {
-  """Unique identifier for the webhook."""
+  """The ID of the webhook."""
   id: ID!
-  """ID of the organisation this webhook belongs to."""
+  """The ID of the organisation the webhook belongs to."""
   organizationId: ID!
-  """ID of the project this webhook belongs to."""
+  """The ID of the project the webhook belongs to."""
   projectId: ID!
-  """ID of the API key used for authentication."""
+  """The ID of the API key the webhook uses."""
   apiKeyId: ID!
-  """Display name of the webhook."""
+  """The webhook's name."""
   name: String!
-  """Description of the webhook's purpose."""
+  """The webhook's description. Null when it has none."""
   description: String
-  """URL that will receive webhook events."""
+  """The URL that receives the webhook's requests."""
   endpointUrl: String!
-  """Whether the webhook is currently active."""
+  """Whether the webhook is active."""
   isActive: Boolean!
-  """Request timeout in milliseconds."""
+  """The request timeout in milliseconds."""
   timeoutMs: Int!
-  """Number of retry attempts on failure."""
+  """The number of retries after a failed request."""
   retryCount: Int!
-  """Name of the associated API key (denormalised for display)."""
+  """The name of the API key. Null when the key is deleted."""
   apiKeyName: String
-  """Prefix of the associated API key (denormalised for display)."""
+  """The prefix of the API key. Null when the key is deleted."""
   apiKeyPrefix: String
-  """When this webhook was created (ISO 8601 string)."""
+  """When the webhook was created, as an ISO 8601 string."""
   createdAt: String!
-  """When this webhook was last updated (ISO 8601 string)."""
+  """When the webhook last changed, as an ISO 8601 string."""
   updatedAt: String!
 }
 ```
@@ -461,13 +503,13 @@ type ShopifyWebhook {
 
 ```graphql
 """
-Payload returned by `shopifyWebhookCreate`. WARNING: `webhookSecret` is shown only once — store it now.
+The result of `shopifyWebhookCreate`. `webhookSecret` is returned only here, once.
 """
 type ShopifyWebhookCreatePayload {
   """The created webhook."""
   webhook: ShopifyWebhook!
   """
-  Webhook HMAC secret for verifying payloads. Shown once — store securely.
+  The HMAC secret for verifying the webhook's payloads. Returned only once.
   """
   webhookSecret: String!
 }
@@ -476,9 +518,9 @@ type ShopifyWebhookCreatePayload {
 ### `ShopifyWebhooksInput`
 
 ```graphql
-"""Input for listing Shopify webhooks."""
+"""The input of `shopifyWebhooks`."""
 input ShopifyWebhooksInput {
-  """ID of the organisation to list webhooks for."""
+  """The ID of the organisation."""
   organizationId: ID!
 }
 ```
@@ -486,26 +528,28 @@ input ShopifyWebhooksInput {
 ### `ShopifyWebhookCreateInput`
 
 ```graphql
-"""Input for `shopifyWebhookCreate`."""
+"""The input of `shopifyWebhookCreate`."""
 input ShopifyWebhookCreateInput {
-  """ID of the organisation."""
+  """The ID of the project's organisation."""
   organizationId: ID!
-  """ID of the project."""
+  """The ID of the project."""
   projectId: ID!
-  """ID of the API key for webhook authentication."""
+  """The ID of an API key of the organisation for the webhook to use."""
   apiKeyId: ID!
-  """Display name for the webhook."""
+  """The webhook's name. Not blank."""
   name: String!
-  """Description of the webhook's purpose."""
+  """The webhook's description."""
   description: String
-  """URL that will receive webhook events."""
+  """
+  The URL that receives the webhook's requests. Starts with `http://` or `https://`.
+  """
   endpointUrl: String!
   """
-  Request timeout in milliseconds. Server picks a sensible default if omitted.
+  The request timeout in milliseconds, from 1000 to 60000. Defaults to 30000.
   """
   timeoutMs: Int
   """
-  Number of retry attempts on failure. Server picks a sensible default if omitted.
+  The number of retries after a failed request, from 0 to 10. Defaults to 3.
   """
   retryCount: Int
 }
@@ -514,25 +558,29 @@ input ShopifyWebhookCreateInput {
 ### `ShopifyWebhookUpdateInput`
 
 ```graphql
-"""Input for `shopifyWebhookUpdate`. Omit a field to leave it unchanged."""
+"""The input of `shopifyWebhookUpdate`. Omit a field to keep its value."""
 input ShopifyWebhookUpdateInput {
-  """ID of the webhook to update."""
+  """The ID of the webhook."""
   webhookId: ID!
-  """ID of the organisation the webhook belongs to."""
+  """
+  The ID of the webhook's organisation. Not read: the webhook's own organisation applies.
+  """
   organizationId: ID!
-  """New display name."""
+  """The webhook's name."""
   name: String
-  """New description."""
+  """The webhook's description."""
   description: String
-  """New endpoint URL."""
+  """
+  The URL that receives the webhook's requests. Starts with `http://` or `https://`.
+  """
   endpointUrl: String
-  """Whether the webhook should be active."""
+  """Whether the webhook is active."""
   isActive: Boolean
-  """New API key ID for authentication."""
+  """The ID of an API key of the organisation for the webhook to use."""
   apiKeyId: ID
-  """New timeout in milliseconds."""
+  """The request timeout in milliseconds, from 1000 to 60000."""
   timeoutMs: Int
-  """New retry count."""
+  """The number of retries after a failed request, from 0 to 10."""
   retryCount: Int
 }
 ```
@@ -540,11 +588,13 @@ input ShopifyWebhookUpdateInput {
 ### `ShopifyWebhookDeleteInput`
 
 ```graphql
-"""Input for `shopifyWebhookDelete`."""
+"""The input of `shopifyWebhookDelete`."""
 input ShopifyWebhookDeleteInput {
-  """ID of the webhook to delete."""
+  """The ID of the webhook."""
   webhookId: ID!
-  """ID of the organisation the webhook belongs to."""
+  """
+  The ID of the webhook's organisation. Not read: the webhook's own organisation applies.
+  """
   organizationId: ID!
 }
 ```
@@ -552,11 +602,15 @@ input ShopifyWebhookDeleteInput {
 ### `CreateShopifyWebhookResponse`
 
 ```graphql
-"""Deprecated — use `ShopifyWebhookCreatePayload`."""
+"""
+The result of `createShopifyWebhook`. Superseded by `ShopifyWebhookCreatePayload`.
+"""
 type CreateShopifyWebhookResponse {
   """The created webhook."""
   webhook: ShopifyWebhook!
-  """Webhook HMAC secret. Shown once."""
+  """
+  The HMAC secret for verifying the webhook's payloads. Returned only once.
+  """
   webhookSecret: String!
 }
 ```
@@ -564,15 +618,31 @@ type CreateShopifyWebhookResponse {
 ### `CreateShopifyWebhookInput`
 
 ```graphql
-"""Deprecated — use `ShopifyWebhookCreateInput`."""
+"""
+The input of `createShopifyWebhook`. Superseded by `ShopifyWebhookCreateInput`.
+"""
 input CreateShopifyWebhookInput {
+  """The ID of the project's organisation."""
   organizationId: ID!
+  """The ID of the project."""
   projectId: ID!
+  """The ID of an API key of the organisation for the webhook to use."""
   apiKeyId: ID!
+  """The webhook's name. Not blank."""
   name: String!
+  """The webhook's description."""
   description: String
+  """
+  The URL that receives the webhook's requests. Starts with `http://` or `https://`.
+  """
   endpointUrl: String!
+  """
+  The request timeout in milliseconds, from 1000 to 60000. Defaults to 30000.
+  """
   timeoutMs: Int
+  """
+  The number of retries after a failed request, from 0 to 10. Defaults to 3.
+  """
   retryCount: Int
 }
 ```
@@ -580,16 +650,32 @@ input CreateShopifyWebhookInput {
 ### `UpdateShopifyWebhookInput`
 
 ```graphql
-"""Deprecated — use `ShopifyWebhookUpdateInput`."""
+"""
+The input of `updateShopifyWebhook`. Superseded by `ShopifyWebhookUpdateInput`. Omit a field to
+keep its value.
+"""
 input UpdateShopifyWebhookInput {
+  """The ID of the webhook."""
   webhookId: ID!
+  """
+  The ID of the webhook's organisation. Not read: the webhook's own organisation applies.
+  """
   organizationId: ID!
+  """The webhook's name."""
   name: String
+  """The webhook's description."""
   description: String
+  """
+  The URL that receives the webhook's requests. Starts with `http://` or `https://`.
+  """
   endpointUrl: String
+  """Whether the webhook is active."""
   isActive: Boolean
+  """The ID of an API key of the organisation for the webhook to use."""
   apiKeyId: ID
+  """The request timeout in milliseconds, from 1000 to 60000."""
   timeoutMs: Int
+  """The number of retries after a failed request, from 0 to 10."""
   retryCount: Int
 }
 ```
@@ -597,9 +683,15 @@ input UpdateShopifyWebhookInput {
 ### `DeleteShopifyWebhookInput`
 
 ```graphql
-"""Deprecated — use `ShopifyWebhookDeleteInput`."""
+"""
+The input of `deleteShopifyWebhook`. Superseded by `ShopifyWebhookDeleteInput`.
+"""
 input DeleteShopifyWebhookInput {
+  """The ID of the webhook."""
   webhookId: ID!
+  """
+  The ID of the webhook's organisation. Not read: the webhook's own organisation applies.
+  """
   organizationId: ID!
 }
 ```
@@ -607,8 +699,11 @@ input DeleteShopifyWebhookInput {
 ### `OrganizationShopifyWebhooksInput`
 
 ```graphql
-"""Deprecated — use `ShopifyWebhooksInput`."""
+"""
+The input of `organizationShopifyWebhooks`. Superseded by `ShopifyWebhooksInput`.
+"""
 input OrganizationShopifyWebhooksInput {
+  """The ID of the organisation."""
   organizationId: ID!
 }
 ```
@@ -617,26 +712,24 @@ input OrganizationShopifyWebhooksInput {
 
 ```graphql
 """
-Shopify metafield-sync configuration for a project: which metafield
-namespaces / keys to pull from Shopify and how many
-metafields to ingest per resource.
+A project's setting for syncing the Shopify metafields of one namespace.
 """
 type ShopifyMetafieldConfig {
-  """Unique identifier for the config."""
+  """The ID of the config."""
   id: ID!
-  """ID of the project this config belongs to."""
+  """The ID of the project the config belongs to."""
   projectId: String!
-  """Metafield namespace to sync (e.g. `custom`)."""
+  """The metafield namespace, such as `custom`."""
   namespace: String!
-  """Maximum number of metafields to sync per resource."""
+  """The most metafields to sync for each resource."""
   maxMetafields: Int!
   """
-  Specific metafield keys to sync. Null means sync all keys in the namespace.
+  The metafield keys to sync. Null when every key in the namespace syncs.
   """
   keys: [String!]
-  """When this config was created (ISO 8601 string)."""
+  """When the config was created, as an ISO 8601 string."""
   createdAt: String!
-  """When this config was last updated (ISO 8601 string)."""
+  """When the config last changed, as an ISO 8601 string."""
   updatedAt: String!
 }
 ```
@@ -644,9 +737,9 @@ type ShopifyMetafieldConfig {
 ### `ShopifyMetafieldConfigsInput`
 
 ```graphql
-"""Input for listing Shopify metafield configs."""
+"""The input of `shopifyMetafieldConfigs`."""
 input ShopifyMetafieldConfigsInput {
-  """ID of the project to list configs for."""
+  """The ID of the project."""
   projectId: ID!
 }
 ```
@@ -654,15 +747,17 @@ input ShopifyMetafieldConfigsInput {
 ### `ShopifyMetafieldConfigCreateInput`
 
 ```graphql
-"""Input for `shopifyMetafieldConfigCreate`."""
+"""The input of `shopifyMetafieldConfigCreate`."""
 input ShopifyMetafieldConfigCreateInput {
-  """ID of the project."""
+  """The ID of the project."""
   projectId: ID!
-  """Metafield namespace to sync."""
+  """The metafield namespace: letters, digits, `_`, `-` and `$`."""
   namespace: String!
-  """Maximum number of metafields to sync."""
+  """The most metafields to sync for each resource, from 1 to 100."""
   maxMetafields: Int!
-  """Specific metafield keys to sync. Null means sync all keys."""
+  """
+  The metafield keys to sync. At least one when set. Omit to sync every key.
+  """
   keys: [String!]
 }
 ```
@@ -671,14 +766,15 @@ input ShopifyMetafieldConfigCreateInput {
 
 ```graphql
 """
-Input for `shopifyMetafieldConfigUpdate`. Omit a field to leave it unchanged.
+The input of `shopifyMetafieldConfigUpdate`. Omit a field to keep its value. Set at least one of
+`maxMetafields` and `keys`.
 """
 input ShopifyMetafieldConfigUpdateInput {
-  """ID of the config to update."""
+  """The ID of the config."""
   id: ID!
-  """New maximum number of metafields."""
+  """The most metafields to sync for each resource, from 1 to 100."""
   maxMetafields: Int
-  """New list of metafield keys."""
+  """The metafield keys to sync. An empty list syncs every key."""
   keys: [String!]
 }
 ```
@@ -686,9 +782,9 @@ input ShopifyMetafieldConfigUpdateInput {
 ### `ShopifyMetafieldConfigDeleteInput`
 
 ```graphql
-"""Input for `shopifyMetafieldConfigDelete`."""
+"""The input of `shopifyMetafieldConfigDelete`."""
 input ShopifyMetafieldConfigDeleteInput {
-  """ID of the config to delete."""
+  """The ID of the config."""
   id: ID!
 }
 ```
@@ -696,8 +792,11 @@ input ShopifyMetafieldConfigDeleteInput {
 ### `ProjectMetafieldConfigsInput`
 
 ```graphql
-"""Deprecated — use `ShopifyMetafieldConfigsInput`."""
+"""
+The input of `projectShopifyMetafieldConfigs`. Superseded by `ShopifyMetafieldConfigsInput`.
+"""
 input ProjectMetafieldConfigsInput {
+  """The ID of the project."""
   projectId: ID!
 }
 ```
@@ -705,11 +804,19 @@ input ProjectMetafieldConfigsInput {
 ### `CreateShopifyMetafieldConfigInput`
 
 ```graphql
-"""Deprecated — use `ShopifyMetafieldConfigCreateInput`."""
+"""
+The input of `createShopifyMetafieldConfig`. Superseded by `ShopifyMetafieldConfigCreateInput`.
+"""
 input CreateShopifyMetafieldConfigInput {
+  """The ID of the project."""
   projectId: ID!
+  """The metafield namespace: letters, digits, `_`, `-` and `$`."""
   namespace: String!
+  """The most metafields to sync for each resource, from 1 to 100."""
   maxMetafields: Int!
+  """
+  The metafield keys to sync. At least one when set. Omit to sync every key.
+  """
   keys: [String!]
 }
 ```
@@ -717,10 +824,16 @@ input CreateShopifyMetafieldConfigInput {
 ### `UpdateShopifyMetafieldConfigInput`
 
 ```graphql
-"""Deprecated — use `ShopifyMetafieldConfigUpdateInput`."""
+"""
+The input of `updateShopifyMetafieldConfig`. Superseded by `ShopifyMetafieldConfigUpdateInput`.
+Omit a field to keep its value. Set at least one of `maxMetafields` and `keys`.
+"""
 input UpdateShopifyMetafieldConfigInput {
+  """The ID of the config."""
   id: ID!
+  """The most metafields to sync for each resource, from 1 to 100."""
   maxMetafields: Int
+  """The metafield keys to sync. An empty list syncs every key."""
   keys: [String!]
 }
 ```
@@ -728,8 +841,11 @@ input UpdateShopifyMetafieldConfigInput {
 ### `DeleteShopifyMetafieldConfigInput`
 
 ```graphql
-"""Deprecated — use `ShopifyMetafieldConfigDeleteInput`."""
+"""
+The input of `deleteShopifyMetafieldConfig`. Superseded by `ShopifyMetafieldConfigDeleteInput`.
+"""
 input DeleteShopifyMetafieldConfigInput {
+  """The ID of the config."""
   id: ID!
 }
 ```
@@ -737,17 +853,15 @@ input DeleteShopifyMetafieldConfigInput {
 ### `ShopifyProductContentUpdateInput`
 
 ```graphql
-"""
-Input for `shopifyProductContentUpdate` — patch a Picked-managed content key for a Shopify product.
-"""
+"""The input of `shopifyProductContentUpdate`. Every field is required."""
 input ShopifyProductContentUpdateInput {
-  """Shop identifier."""
+  """The shop's `myshopify.com` domain."""
   shopId: String!
-  """Product ID to update content for."""
+  """The ID of the product, numeric or as a Shopify GID."""
   productId: String!
-  """Content key."""
+  """The content key."""
   key: String!
-  """Content data."""
+  """The content to store at `key`."""
   content: JSON!
 }
 ```
@@ -756,16 +870,16 @@ input ShopifyProductContentUpdateInput {
 
 ```graphql
 """
-Input for `shopifyCollectionContentUpdate` — patch a Picked-managed content key for a Shopify collection.
+The input of `shopifyCollectionContentUpdate`. Every field is required.
 """
 input ShopifyCollectionContentUpdateInput {
-  """Shop identifier."""
+  """The shop's `myshopify.com` domain."""
   shopId: String!
-  """Collection ID to update content for."""
+  """The ID of the collection, numeric or as a Shopify GID."""
   collectionId: String!
-  """Content key."""
+  """The content key."""
   key: String!
-  """Content data."""
+  """The content to store at `key`."""
   content: JSON!
 }
 ```
@@ -773,11 +887,17 @@ input ShopifyCollectionContentUpdateInput {
 ### `UpdateShopifyProductContentInput`
 
 ```graphql
-"""Deprecated — use `ShopifyProductContentUpdateInput`."""
+"""
+The input of `updateShopifyProductContent`. Superseded by `ShopifyProductContentUpdateInput`.
+"""
 input UpdateShopifyProductContentInput {
+  """The shop's `myshopify.com` domain."""
   shopId: String!
+  """The ID of the product, numeric or as a Shopify GID."""
   productId: String!
+  """The content key."""
   key: String!
+  """The content to store at `key`."""
   content: JSON!
 }
 ```
@@ -785,11 +905,18 @@ input UpdateShopifyProductContentInput {
 ### `UpdateShopifyCollectionContentInput`
 
 ```graphql
-"""Deprecated — use `ShopifyCollectionContentUpdateInput`."""
+"""
+The input of `updateShopifyCollectionContent`. Superseded by
+`ShopifyCollectionContentUpdateInput`.
+"""
 input UpdateShopifyCollectionContentInput {
+  """The shop's `myshopify.com` domain."""
   shopId: String!
+  """The ID of the collection, numeric or as a Shopify GID."""
   collectionId: String!
+  """The content key."""
   key: String!
+  """The content to store at `key`."""
   content: JSON!
 }
 ```