XaitCPQ API

PUT product/{id}/properties

Sets the order of all product properties.

Request Information

URI

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

URI Parameters

NameDescriptionTypeAdditional information
id

The product identifier.

 globally unique identifier

Required

Body Parameters

The property order update.

Collection of OrderUpdate
NameDescriptionTypeAdditional information
Id

globally unique identifier

None.
Index

integer

None.

Request Formats

application/json, text/json

Sample: 
[
  {
    "Id": "4d79e8dd-1ecc-4871-87c2-67efd9e7ea6d",
    "Index": 2
  },
  {
    "Id": "4d79e8dd-1ecc-4871-87c2-67efd9e7ea6d",
    "Index": 2
  }
]

text/html

Sample: 
[{"Id":"4d79e8dd-1ecc-4871-87c2-67efd9e7ea6d","Index":2},{"Id":"4d79e8dd-1ecc-4871-87c2-67efd9e7ea6d","Index":2}]

application/xml, text/xml

Sample: 
<ArrayOfOrderUpdate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Shared.Models.DataModels">
  <OrderUpdate>
    <Id>4d79e8dd-1ecc-4871-87c2-67efd9e7ea6d</Id>
    <Index>2</Index>
  </OrderUpdate>
  <OrderUpdate>
    <Id>4d79e8dd-1ecc-4871-87c2-67efd9e7ea6d</Id>
    <Index>2</Index>
  </OrderUpdate>
</ArrayOfOrderUpdate>

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>