productVariantBackInStockUnsubscribe

Mutationin Back in stock

Withdraw the signed-in customer's sign-up for a variant, so no restock mail follows. Only the customer's own address is withdrawn; a guest uses the token from the confirmation mail. The answer is the same in every case.

Arguments

Argument	Type	Description
sku	String!
email	EmailAddress!

Returns

ProductVariantBackInStockUnsubscribeResponse!

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

Example

Query

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

Variables

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

Response

{
  "data": {
    "productVariantBackInStockUnsubscribe": {
      "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