Update a Part
put
/rest/v16/partSetups/{id}
Use this endpoint to update the specified CPQ part. Note: Any property not specified in the request payload will be implicitly set to blank when making PUT calls. Therefore, all required and numeric Part Custom Fields must be included in the request payload.
Request
Supported Media Types
- application/json
Path Parameters
-
id(required): integer
The unique identifier for the part.
Root Schema : Part Setup Create Request Definitions
Type:
objectTitle:
Show Source
Part Setup Create Request Definitions-
_part_custom_field1:
string
Title:
Product Group -
_part_custom_field10:
object Product type
Title:
Product type -
_part_custom_field2:
object Part Availability
Title:
Part Availability -
_part_custom_field3:
string
Title:
Max discount % -
_part_custom_field4:
object Price Period
Title:
Price Period -
_part_custom_field5:
number
Title:
Cost -
_part_custom_field8:
object Price Type
Title:
Price Type -
_part_custom_field9:
string
Title:
product -
dateAdded:
string
Title:
Date AddedSystem field indicating the date on which the Resource was created. -
dateModified:
string
Title:
Date ModifiedSystem field indicating the date on which the Resource was last modified. -
defaultUOMCode:
string
Title:
Default UOM CodeDefault Unit of Measure. -
description:
string
Title:
DescriptionDescription of the part. -
directBuy:
object Direct Buy
Title:
Direct BuyDetermines how the part must be purchased. -
eligibleForService:
string
Title:
Eligible for ServiceEnable this option when integrating with a service request application. -
eligibleToSell:
string
Title:
Eligible to SellCheck this if the part should be visible to a sales person (If the part is sellable or not). -
enableSelfService:
string
Title:
Enable Customer Self-ServiceWhen integrating with any customer self service application- enable this option to identify parts as self-service eligible. -
extendedDescriptions:
object Part Extended Descriptions
Title:
Part Extended Descriptions -
externalKey1:
string
Title:
External Key 1References for parts coming in from external third party system. -
externalKey2:
string
Title:
External Key 2References for parts coming in from external third party system. -
leadTime:
integer
Title:
Lead TimeTime taken in days for the part to be shipped. -
numberOfPricePeriods:
integer
Title:
Number of Price PeriodsDefault number of price periods for a part. -
partDisplayNumber:
string
Title:
Part Display NumberPart Number for display purpose. -
partnerOrganizationId:
string
Title:
Partner Organization IdThe integrated partner organization id. -
partnerPartId:
string
Title:
Partner Part IdThe integrated partner part id. -
partnerStandardPriceBookEntryId:
string
Title:
Partner Standard Pricebook Entry IdThe integrated partner id for the standard pricebook. -
partNumber:
string
Title:
Part NumberPart Number used to identify a part. -
pricePeriod:
string
Title:
Price PeriodDefault price period for the part. -
prices:
object Part Prices
Title:
Part Prices -
priceType:
string
Title:
Price TypeDefault price type applicable to the part- e.g. One-Time, Recurring or Usage-based. -
salesProductType:
string
Title:
Sales Product TypeCategorize the product by selecting a product type. -
translations:
object Part Translations
Title:
Part Translations -
units:
string
Title:
UnitsUnits for the part.
Nested Schema : Product type
Type:
objectTitle:
Show Source
Product type-
displayValue:
string
Title:
Display ValueTranslated display name of the type for which fixed list of values can be defined. -
id:
integer
Title:
IdPrimary Key of the fixed list of value resource. -
lookupCode:
string
Title:
Lookup CodeLanguage independent code of the fixed list of value.
Nested Schema : Part Availability
Type:
objectTitle:
Show Source
Part Availability-
displayValue:
string
Title:
Display ValueTranslated display name of the type for which fixed list of values can be defined. -
id:
integer
Title:
IdPrimary Key of the fixed list of value resource. -
lookupCode:
string
Title:
Lookup CodeLanguage independent code of the fixed list of value.
Nested Schema : Price Period
Type:
objectTitle:
Show Source
Price Period-
displayValue:
string
Title:
Display ValueTranslated display name of the type for which fixed list of values can be defined. -
id:
integer
Title:
IdPrimary Key of the fixed list of value resource. -
lookupCode:
string
Title:
Lookup CodeLanguage independent code of the fixed list of value.
Nested Schema : Price Type
Type:
objectTitle:
Show Source
Price Type-
displayValue:
string
Title:
Display ValueTranslated display name of the type for which fixed list of values can be defined. -
id:
integer
Title:
IdPrimary Key of the fixed list of value resource. -
lookupCode:
string
Title:
Lookup CodeLanguage independent code of the fixed list of value.
Nested Schema : Direct Buy
Type:
objectTitle:
Direct BuyDetermines how the part must be purchased.
Show Source
-
displayValue:
string
Title:
Display ValueTranslated display name of the type for which fixed list of values can be defined. -
id:
integer
Title:
IdPrimary Key of the fixed list of value resource. -
lookupCode:
string
Title:
Lookup CodeLanguage independent code of the fixed list of value.
Nested Schema : Part Extended Descriptions
Type:
objectTitle:
Show Source
Part Extended DescriptionsNested Schema : items
Type:
Show Source
array-
Array of:
object Part Extended Descriptions
Title:
Part Extended Descriptions
Nested Schema : Part Extended Descriptions
Type:
objectTitle:
Show Source
Part Extended Descriptions-
dateAdded:
string
Title:
Date AddedSystem field indicating the date on which the Resource was created. -
dateModified:
string
Title:
Date ModifiedSystem field indicating the date on which the Resource was last modified. -
id:
integer
Title:
IdIdentifier for the resource -
partExtendedDescription1:
string
Title:
Extended Description 1Part extended description 1 -
partExtendedDescription2:
string
Title:
Extended Description 2Part extended description 2 -
translations:
object Part Extended Description Translations
Title:
Part Extended Description Translations
Nested Schema : Part Extended Description Translations
Type:
objectTitle:
Show Source
Part Extended Description TranslationsNested Schema : items
Type:
Show Source
array-
Array of:
object Part Extended Description Translations
Title:
Part Extended Description Translations
Nested Schema : Part Extended Description Translations
Type:
objectTitle:
Show Source
Part Extended Description Translations-
dateAdded:
string
Title:
Date AddedSystem field indicating the date on which the Resource was created. -
dateModified:
string
Title:
Date ModifiedSystem field indicating the date on which the Resource was last modified. -
id:
integer
Title:
IdIdentifier for the resource -
language:
object Language
Title:
LanguageThe defined language of the rows translated columns. -
partExtendedDescription1:
string
Title:
Extended Description 1Part extended description 1 -
partExtendedDescription2:
string
Title:
Extended Description 2Part extended description 2
Nested Schema : Language
Type:
objectTitle:
LanguageThe defined language of the rows translated columns.
Show Source
-
id:
integer
Title:
IdPrimary Key of the language resource. -
languageCode:
string
Title:
Language CodeUnique language code -
languageNumber:
integer
Title:
Language NumberUnique language number.
Nested Schema : items
Type:
Show Source
array-
Array of:
object Part Prices Setup Create Request Definitions
Title:
Part Prices Setup Create Request Definitions
Nested Schema : Part Prices Setup Create Request Definitions
Type:
objectTitle:
Show Source
Part Prices Setup Create Request Definitions-
dateAdded:
string
Title:
Date AddedSystem field indicating the date on which the Resource was created. -
dateModified:
string
Title:
Date ModifiedSystem field indicating the date on which the Resource was last modified. -
id:
integer
Title:
IdPrimary Key of the Resource -
price:
object Price
Title:
PricePrice of the part.
Nested Schema : Price
Type:
objectTitle:
PricePrice of the part.
Show Source
-
currency:
string
Title:
currency -
value:
number
Title:
value
Nested Schema : items
Type:
Show Source
array-
Array of:
object Part Translation Setup Create Request Definitions
Title:
Part Translation Setup Create Request Definitions
Nested Schema : Part Translation Setup Create Request Definitions
Type:
objectTitle:
Show Source
Part Translation Setup Create Request Definitions-
dateAdded:
string
Title:
Date AddedSystem field indicating the date on which the Resource was created. -
dateModified:
string
Title:
Date ModifiedSystem field indicating the date on which the Resource was last modified. -
description:
string
Title:
Translated descriptionTranslated description of the part. -
id:
integer
Title:
IdIdentifier for the resource -
language:
object Language
Title:
LanguageThe defined language of the rows translated columns. -
units:
string
Title:
Translated UnitsTranslated units of the part
Nested Schema : Language
Type:
objectTitle:
LanguageThe defined language of the rows translated columns.
Show Source
-
id:
integer
Title:
IdPrimary Key of the language resource. -
languageCode:
string
Title:
Language CodeUnique language code -
languageNumber:
integer
Title:
Language NumberUnique language number.
Response
Supported Media Types
- application/json
Default Response
Examples
The following example shows how to update the specified CPQ part by submitting a PUT request to the REST resource using cURL. For more information about cURL, see Use cURL.
curl - X PUT - i - H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQg" - H "Content-type: application/json" https://sitename.oracle.com/rest/v16/partSetups/38644116
Request Body
{
"eligibleForService": "N",
"directBuy": {
"lookupCode": "1",
"displayValue": "Direct Buy"
},
"description": "The premium Maintenance covers multi-point inspections, as well as preventive care and replacement of normal wear and tear items that require periodic attention.",
"enableSelfService": "N",
"leadTime": -1,
"_part_custom_field10": {
"lookupCode": "External",
"displayValue": "External"
},
"eligibleToSell": "N",
"_part_custom_field9": "subscription",
"_part_custom_field4": {
"lookupCode": "Per Month",
"displayValue": "Per Month"
},
"_part_custom_field1": "Service",
"_part_custom_field2": {
"lookupCode": "Available",
"displayValue": "Available"
},
"_part_custom_field8": {
"lookupCode": "Recurring",
"displayValue": "Recurring"
},
"_part_custom_field5": 0.0,
"numberOfPricePeriods": 0,
"partnerOrganizationId": null,
"partDisplayNumber": "MTN2",
"partNumber": "Premium Maintenance Plan"
}