Skip to main content

Replicate a Price Book

POST 

/pcm/pricebooks/:pricebookID/replicate

Using this endpoint, you can replicate an existing price book. This is useful because it enables you to quickly and easily create multiple price books with the same pricing structure. When you replicate an existing price book, you can specify a new name, description, and external reference for the replicated price book. Other attributes stay the same.

Request

Path Parameters

    pricebookID stringrequired

    The unique identifier of a price book.

Body

A replicated price book with the following attributes.

    data objectrequired

    Price book replicate request.

    type stringrequired

    Possible values: [pricebook]

    Default value: pricebook

    attributes objectrequired
    description stringnullable

    A brief description outlining the purpose of a price book, such as flash sale pricing or preferred customer pricing.

    name stringnullable

    Possible values: non-empty

    The name of the price book. Price books must have a unique name.

    external_ref stringnullable

    A unique attribute that you could use to contain information from another company system, for example. The maximum length is 2048 characters.

Responses

A replicated price book with the following attributes.

Schema
    data objectrequired

    A price book with the following attributes.

    id stringrequired

    A unique identifier of a price book.

    type stringrequired

    Possible values: [pricebook]

    Default value: pricebook

    Always pricebook.

    attributes objectrequired
    external_ref stringnullable

    A unique attribute that you could use to contain information from another company system, for example. The maximum length is 2048 characters.

    description stringnullable

    A brief description that outlines the purpose of a price book, for example, flash sale pricing or preferred customer pricing.

    name stringnullablerequired

    The name of a price book. Price books must have a unique name

    created_at date-timerequired

    The date and time when the price book was created.

    updated_at date-timerequired

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

    meta object
    owner stringnullable

    The resource 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...