XaitCPQ API

PUT pricebook/{id}

Sets a category.

Request Information

URI

https://ofd-api.blueprintcpq.net/pricebook/{id}

URI Parameters

NameDescriptionTypeAdditional information
id

The identifier.

 globally unique identifier

Required

Body Parameters

Price Book options.

UpdateProductCategory
NameDescriptionTypeAdditional information
Name

string

None.
Code

string

None.
Colour

string

None.
Graphic

globally unique identifier

None.
Note

globally unique identifier

None.
Parent

globally unique identifier

None.

Request Formats

application/json, text/json

Sample: 
{
  "Name": "sample string 1",
  "Code": "sample string 2",
  "Colour": "sample string 3",
  "Graphic": "5cba32a3-e395-4b44-9c17-48871baa96bf",
  "Note": "8bafd5c1-8b32-4d76-a3a6-8ab9a6d030e9",
  "Parent": "c5d5f4bb-e860-44ac-b023-7b2a217ea2d6"
}

text/html

Sample: 
{"Name":"sample string 1","Code":"sample string 2","Colour":"sample string 3","Graphic":"5cba32a3-e395-4b44-9c17-48871baa96bf","Note":"8bafd5c1-8b32-4d76-a3a6-8ab9a6d030e9","Parent":"c5d5f4bb-e860-44ac-b023-7b2a217ea2d6"}

application/xml, text/xml

Sample: 
<UpdateProductCategory xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Shared.Models.ConfigurationModels">
  <Code>sample string 2</Code>
  <Colour>sample string 3</Colour>
  <Graphic>5cba32a3-e395-4b44-9c17-48871baa96bf</Graphic>
  <Name>sample string 1</Name>
  <Note>8bafd5c1-8b32-4d76-a3a6-8ab9a6d030e9</Note>
  <Parent>c5d5f4bb-e860-44ac-b023-7b2a217ea2d6</Parent>
</UpdateProductCategory>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

True if it succeeds, false if it fails.

boolean

Response Formats

application/json, text/json, text/html

Sample: 
true

application/xml, text/xml

Sample: 
<boolean xmlns="http://schemas.microsoft.com/2003/10/Serialization/">true</boolean>