updatePriceBook

Update name and description for a price book

This page contains

    Authorization Rules

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

    Scopes

    ROLE_CHANNEL_ADMIN

    Arguments

    input UpdatePriceBookInput!

    Attributes to update a price book

    UpdatePriceBookInput fields

    id ID!

    Unique identifier of price book

    name String

    New unique name for price book

    description String

    Description for price book

    modifiedBy String!

    Email id of user modifying the price book

    precedence Long

    Precedence of price book

    effectiveStartDate DateTime

    Date from which price book prices will be applicable. Value is not considered for Draft status

    effectiveEndDate DateTime

    Date after which price book prices will not be applicable. Value is not considered for Draft status

    removeEffectiveEndDate Boolean

    If true, effectiveEndDate field will be set to null for price book

    externalSource PriceBookExternalSource PREVIEW

    External source to which price book prices are associated

    removeExternalSource Boolean PREVIEW

    If true, externalSource field will be set to null for price book

    Return Fields

    priceBook PriceBook

    Updated price book details

    userErrors [UpdatePriceBookError!]

    Error details while updating price book

    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.