Skip to main content

Get a Modifier

GET 

/pcm/pricebooks/:pricebookID/modifiers/:modifierID

Retrieves the specified price book modifier from the specified price book.

Request

Path Parameters

    pricebookID stringrequired

    Unique identifier of a Price Book

    modifierID stringrequired

    Unique identifier of a Price Book Modifier

Responses

The price modifier.

Schema
    data objectrequired

    A price modifier with the following attributes.

    type stringrequired

    Possible values: [price-modifier]

    Default value: price-modifier

    pricebook_external_ref stringnullable

    The unique attribute associated with the price book. This can be an external reference from a separate company system, for example. The maximum length is 2048 characters.

    attributes objectrequired
    external_ref stringnullable

    A unique identifier associated with the price modifier. This can be an external reference from a separate company system, for example. The maximum length is 2048 characters.

    currencies objectrequired

    A collection of one or more currencies objects that consists of the three-letter ISO code of the currencies associated with this price and the amount. This is the product's price.

    property name* amount

    The three-letter ISO code for the currency associated with this price.

    amount int64nullable

    The price in the lowest denomination for the specified currency. This is a product's list price.

    includes_tax boolean

    Whether this price includes tax.

    tiers object

    The price tier that an item is eligible for based on the quantity purchased. You cannot have conflicting tiers within the same currencies block.

    property name* tier-price

    The name of the tier, for example, Pencils.

    minimum_quantity int64nullable

    The minimum quantity of 1 or more defined for the specified price. If a minimum quantity is not specified, an error is returned.

    amount int64nullable

    The price for each quantity.

    name stringrequired

    A name for the modifier. You must give the price modifier a unique name. Price modifier names are case-sensitive.

    modifier_type stringrequired

    Possible values: [price_equals, price_increment, price_decrement]

    There are three modifier types.

    • price_increment - Increases the price of a product.
    • price_decrement - Decreases the price of a product.
    • price_equals - Sets the price of a product to the amount you specify.
    created_at date-time

    The date and time when the price book was created.

    updated_at date-time

    The date and time when the price book was last updated.

    id stringrequired

    A unique identifier for the price modifier.

    meta object
    owner stringnullable

    The product owner, either organization or store.

    links object

    Links are used to allow you to move between requests.

    self urinullable

    Single entities use a self parameter with a link to that specific resource.

Loading...