productVariantBackInStockSubscribe

Mutationin Back in stock

Ask to be mailed once when a sold-out variant is back in stock. Only a variant that is sold out is remembered; the answer is the same either way.

Arguments

Argument	Type	Description
sku	String!
email	EmailAddress!

Returns

ProductVariantBackInStockSubscribeResponse!

Field	Type	Description
success	Boolean!	True for every well-formed request, so the answer tells nothing about the address or the variant.
productErrors	[ProductVariantBackInStockSubscribeError!]	Error details if the request was malformed

Example

Query

mutation ProductVariantBackInStockSubscribe(
  $sku: String!
  $email: EmailAddress!
) {
  productVariantBackInStockSubscribe(sku: $sku, email: $email) {
    success
    productErrors {
      __typename
      ... on ValidationError {
        message
      }
    }
  }
}

Variables

{
  "sku": "SKU-1",
  "email": "jane@example.com"
}

Response

{
  "data": {
    "productVariantBackInStockSubscribe": {
      "success": true,
      "productErrors": [
        {
          "__typename": "ValidationError",
          "message": "Example"
        }
      ]
    }
  }
}

The query selects the return type's fields two levels deep; pick the ones you need. The response shows its shape with placeholder values.

Served by

@evolve-framework/commercetools

Resolved

Used by

The storefront packages that send it, in these GraphQL documents:

• @evolve-storefront/feature-product: ProductVariantBackInStockSubscribe