Update a Price Book by ID

PUT 
/pcm/pricebooks/:pricebookID

Updates the specified price book. Specify whichever attributes you want to change. The values of the other attributes remain the same. If the attributes section is empty, the price book is not updated.

Request

Path Parameters

pricebookID stringrequired

The unique identifier of a price book.

application/json

Body

required

An updated price book with the following attributes.

data objectrequired

Updates the specified price book.

id stringrequired

The unique identifier of a price book.

type stringrequired

Possible values: [pricebook]

Default value: pricebook

Always pricebook.

attributes objectrequired

description stringnullable

A brief description that describes a price book, for example, flash sale pricing or preferred customer pricing.

name stringnullable

Possible values: non-empty

The name of a 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

200

An updated price book with the following attributes.

application/json

Schema

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.

Example (from schema)

{
  "data": {
    "id": "4c45e4ec-26e0-4043-86e4-c15b9cf985a7",
    "type": "pricebook",
    "attributes": {
      "external_ref": "an-external-ref",
      "description": "This is a test price book",
      "name": "Standard Price Book",
      "created_at": "2020-09-22T09:00:00Z",
      "updated_at": "2020-09-22T09:00:00Z"
    },
    "meta": {
      "owner": "store"
    }
  },
  "links": {
    "self": "/pcm/pricebooks/4c45e4ec-26e0-4043-86e4-c15b9cf985a7"
  }
}

default

Unexpected error.

application/json

Schema

Schema

errors object[]
Array [
detail string
status string
title string
]

Example (from schema)

{
  "errors": [
    {
      "detail": "The price book already exists",
      "status": "409",
      "title": "conflict"
    }
  ]
}

Loading...