productPublish
mutation
deprecated

Choose a version:

Requires write_publications access scope. Also: The user must have a permission to publish a product.

Publishes a product. Products that are sold exclusively on subscription (requiresSellingPlan: true) can only be published on online stores. Use publishablePublish instead.

Anchor to section titled 'Arguments'

Arguments

Anchor to input input ProductPublishInput! required: Specifies the product to publish and the channels to publish it to.

Was this section helpful?

Anchor to section titled 'ProductPublishPayload returns'

ProductPublishPayload returns

Anchor to ProductPublishPayload.product product Product: The product that has been published.
Anchor to ProductPublishPayload.productPublications productPublications [ProductPublication!] deprecated: The channels where the product is published. Use Product.publications instead.
Anchor to ProductPublishPayload.shop shop Shop! non-null: The user's shop.
Anchor to ProductPublishPayload.userErrors userErrors [UserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Code examples for MUTATION: productPublish

Query Reference for MUTATION: productPublish

"mutation productPublish($input: ProductPublishInput!) {\n  productPublish(input: $input) {\n    product {\n      # Product fields\n    }\n    productPublications {\n      # ProductPublication fields\n    }\n    shop {\n      # Shop fields\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"

Input Reference for MUTATION: productPublish

"{\n  \"input\": {\n    \"id\": \"gid://shopify/<objectName>/10079785100\",\n    \"productPublications\": [\n      {\n        \"channelHandle\": \"<your-channelHandle>\",\n        \"channelId\": \"gid://shopify/<objectName>/10079785100\",\n        \"publicationId\": \"gid://shopify/<objectName>/10079785100\",\n        \"publishDate\": \"2019-09-07T15:50:00Z\"\n      }\n    ]\n  }\n}"

Schema Reference for MUTATION: productPublish

"input ProductPublishInput {\n  id: ID!\n  productPublications: [ProductPublicationInput!]!\n}\n\ninput ProductPublicationInput {\n  channelHandle: String\n  channelId: ID\n  publicationId: ID\n  publishDate: DateTime\n}\n"

Display Examples for MUTATION: productPublish

[]

productPublishmutationdeprecated

Arguments

ProductPublishPayload returns

productPublish
mutation
deprecated