Preview

retireProduct is in Preview status and is subject to change without notice. For more information about Preview status, see the GraphQL API policy.

retireProduct

Retire a product by unlisting, unpublishing, or deleting it — cascade applies all required preceding steps

This page contains

    Authorization Rules

    This request requires authorization with at least one of the following scopes:

    Scopes

    ROLE_CHANNEL_ADMIN

    Arguments

    input RetireProductInput! PREVIEW

    RetireProductInput fields

    productId ID!
    action ProductRetirementAction! PREVIEW

    Return Fields

    productRetirementProcess ProductRetirementProcess PREVIEW
    userErrors [RetireProductUserError!]! PREVIEW

    Interactive example

    This is an example mutation query. Use the embedded interactive tool below to edit the query.

    Hint: use Ctrl + Space for autocompleting fields.