Preview

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

updateDistributor

Update an existing distributor

This page contains

    Authorization Rules

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

    Scopes

    external.distributors.config.readwrite.instance

    ROLE_SUPERUSER

    Arguments

    input UpdateDistributorInput! PREVIEW

    UpdateDistributorInput fields

    displayName String!

    Display name used to identify the distributor (same value as createDistributor displayName)

    defaultPriceType DistributorDefaultPriceType PREVIEW

    Optional — omit to leave unchanged

    supportedMarkets [DistributorMarket!] PREVIEW

    Optional — omit to leave unchanged

    defaultMarket DistributorMarket PREVIEW

    Optional — omit to leave unchanged; must be in supportedMarkets

    supportedProductTypes [DistributorSupportedProductType!] PREVIEW

    Optional — omit to leave unchanged

    Return Fields

    distributor Distributor PREVIEW

    Updated distributor

    userErrors [UpdateDistributorError!] PREVIEW

    Errors preventing distributor update

    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.