Parts Administration REST APIs

Overview

The Part Setup REST APIs enable administration of CPQ parts using REST API services.

Administration

Get All Parts
Description	Use this endpoint to retrieve a list of all CPQ parts.
URI Endpoint	/rest/v17/partSetups
Endpoint Parameters	None
Endpoint Parameters	(Optional) This endpoint supports the following query specifications: `expand`, `fields`, `limit`, `offset`, `orderby`, `q`, and `totalResults`. For more information, see Manage Collections.
HTTP Method	GET
Request Body Parameters	None
Response Body Parameters	A collection of parts.

URI Endpoint Sample

https://sitename.oracle.com/rest/v17/partSetups?limit=3

Response Body Sample

{ "offset": 0, "limit": 3, "count": 3, "hasMore": true, "links": [{ "rel": "canonical", "href": "https://sitename.oracle.com/rest/v17/partSetups" }, { "rel": "next", "href": "https://sitename.oracle.com/rest/v17/partSetups?limit=3&offset=3" }, { "rel": "self", "href": "https://sitename.oracle.com/rest/v17/partSetups?limit=3&offset=0" } ], "items": [{ "eligibleForService": null, "partnerPartId": null, "directBuy": { "lookupCode": "1", "displayValue": "Direct Buy", "id": 36549639, "links": [{ "rel": "domain", "href": "https://sitename.oracle.com/rest/v17/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22BM_PARTS_DIRECT_BUY%22%7D%7D" }, { "rel": "canonical", "href": "https://sitename.oracle.com/rest/v17/lookupValues/36549639" } ] }, "defaultUOMCode": null, "description": null, "enableSelfService": null, "leadTime": -1, "units": null, "_part_custom_field10": { "lookupCode": "External", "displayValue": "External", "id": 38272229, "links": [{ "rel": "domain", "href": "https://sitename.oracle.com/rest/v17/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22_PART_field10%22%7D%7D" }, { "rel": "canonical", "href": "https://sitename.oracle.com/rest/v17/lookupValues/38272229" } ] }, "eligibleToSell": null, "dateAdded": "2017-10-19T01:28:51.000Z", "partnerStandardPriceBookEntryId": null, "_part_custom_field9": null, "id": 36551467, "_part_custom_field3": null, "_part_custom_field4": null, "_part_custom_field1": null, "_part_custom_field2": null, "_part_custom_field8": null, "_part_custom_field5": 0.0, "salesProductType": null, "priceType": null, "numberOfPricePeriods": 0, "dateModified": "2021-04-19T12:10:26.000Z", "partnerOrganizationId": null, "partDisplayNumber": "Green Server", "pricePeriod": null, "partNumberLower": "gs5004", "partNumber": "GS5004", "externalKey1": null, "externalKey2": null, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/partSetups/36551467" }, { "kind": "", "rel": "child", "name": "extendedDescriptions", "href": "https://sitename.oracle.com/rest/v17/partSetups/36551467/extendedDescriptions" }, { "kind": "", "rel": "child", "name": "prices", "href": "https://sitename.oracle.com/rest/v17/partSetups/36551467/prices" }, { "kind": "", "rel": "child", "name": "translations", "href": "https://sitename.oracle.com/rest/v17/partSetups/36551467/translations" } ] }, { "eligibleForService": null, "partnerPartId": null, "directBuy": { "lookupCode": "1", "displayValue": "Direct Buy", "id": 36549639, "links": [{ "rel": "domain", "href": "https://sitename.oracle.com/rest/v17/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22BM_PARTS_DIRECT_BUY%22%7D%7D" }, { "rel": "canonical", "href": "https://sitename.oracle.com/rest/v17/lookupValues/36549639" } ] }, "defaultUOMCode": null, "description": null, "enableSelfService": null, "leadTime": -1, "units": null, "_part_custom_field10": { "lookupCode": "External", "displayValue": "External", "id": 38272229, "links": [{ "rel": "domain", "href": "https://sitename.oracle.com/rest/v17/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22_PART_field10%22%7D%7D" }, { "rel": "canonical", "href": "https://sitename.oracle.com/rest/v17/lookupValues/38272229" } ] }, "eligibleToSell": null, "dateAdded": "2017-11-13T13:57:14.000Z", "partnerStandardPriceBookEntryId": null, "_part_custom_field9": null, "id": 36594573, "_part_custom_field3": null, "_part_custom_field4": null, "_part_custom_field1": null, "_part_custom_field2": null, "_part_custom_field8": { "lookupCode": "One Time", "displayValue": "One Time", "id": 36657633, "links": [{ "rel": "domain", "href": "https://sitename.oracle.com/rest/v17/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22_PART_field8%22%7D%7D" }, { "rel": "canonical", "href": "https://sitename.oracle.com/rest/v17/lookupValues/36657633" } ] }, "_part_custom_field5": 50.0, "salesProductType": null, "priceType": null, "numberOfPricePeriods": 0, "dateModified": "2021-04-19T12:10:26.000Z", "partnerOrganizationId": null, "partDisplayNumber": "Vario Tablet", "pricePeriod": null, "partNumberLower": "vario tablet custom", "partNumber": "Vario Tablet Custom", "externalKey1": null, "externalKey2": null, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/partSetups/36594573" }, { "kind": "", "rel": "child", "name": "extendedDescriptions", "href": "https://sitename.oracle.com/rest/v17/partSetups/36594573/extendedDescriptions" }, { "kind": "", "rel": "child", "name": "prices", "href": "https://sitename.oracle.com/rest/v17/partSetups/36594573/prices" }, { "kind": "", "rel": "child", "name": "translations", "href": "https://sitename.oracle.com/rest/v17/partSetups/36594573/translations" } ] }, { "eligibleForService": null, "partnerPartId": null, "directBuy": { "lookupCode": "1", "displayValue": "Direct Buy", "id": 36549639, "links": [{ "rel": "domain", "href": "https://sitename.oracle.com/rest/v17/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22BM_PARTS_DIRECT_BUY%22%7D%7D" }, { "rel": "canonical", "href": "https://sitename.oracle.com/rest/v17/lookupValues/36549639" } ] }, "defaultUOMCode": null, "description": "Quad Core 1.9 GHz", "enableSelfService": null, "leadTime": -1, "units": null, "_part_custom_field10": { "lookupCode": "External", "displayValue": "External", "id": 38272229, "links": [{ "rel": "domain", "href": "https://sitename.oracle.com/rest/v17/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22_PART_field10%22%7D%7D" }, { "rel": "canonical", "href": "https://sitename.oracle.com/rest/v17/lookupValues/38272229" } ] }, "eligibleToSell": null, "dateAdded": "2017-11-13T13:57:56.000Z", "partnerStandardPriceBookEntryId": null, "_part_custom_field9": null, "id": 36594576, "_part_custom_field3": null, "_part_custom_field4": null, "_part_custom_field1": null, "_part_custom_field2": null, "_part_custom_field8": { "lookupCode": "One Time", "displayValue": "One Time", "id": 36657633, "links": [{ "rel": "domain", "href": "https://sitename.oracle.com/rest/v17/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22_PART_field8%22%7D%7D" }, { "rel": "canonical", "href": "https://sitename.oracle.com/rest/v17/lookupValues/36657633" } ] }, "_part_custom_field5": 20.0, "salesProductType": null, "priceType": null, "numberOfPricePeriods": 0, "dateModified": "2021-04-19T12:10:26.000Z", "partnerOrganizationId": null, "partDisplayNumber": "Quad Core 1.9 GHz", "pricePeriod": null, "partNumberLower": "cpu-100m-19", "partNumber": "CPU-100M-19", "externalKey1": null, "externalKey2": null, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/partSetups/36594576" }, { "kind": "", "rel": "child", "name": "extendedDescriptions", "href": "https://sitename.oracle.com/rest/v17/partSetups/36594576/extendedDescriptions" }, { "kind": "", "rel": "child", "name": "prices", "href": "https://sitename.oracle.com/rest/v17/partSetups/36594576/prices" }, { "kind": "", "rel": "child", "name": "translations", "href": "https://sitename.oracle.com/rest/v17/partSetups/36594576/translations" } ] } ] }

Get a Part

Get a Part
Description	Use this endpoint to retrieve the specified CPQ part.
URI Endpoint	/rest/v17/partSetups/{id}
Endpoint Parameters	id	The unique identifier for the part.
Endpoint Parameters	(Optional) This endpoint supports the `expand` parameter
HTTP Method	GET
Request Body Parameters	None
Response Body Parameters	Part Custom Fields	Oracle CPQ supports up to 600 part custom fields `_part_custom_field1` through `_part_custom_field600`.
	dateAdded	System field indicating the date on which the part was created.
	dateModified	System field indicating the date on which the part was last modified.
	defaultUOMCode	Default unit of measure.
	description	The description for the part.
	directBuy	Determines how a part must be purchased.
	eligibleForService	Enable this option, when integrating with a service request application.
	eligibleToSell	Enable if the part should be visible to a sales person (If the part is sellable or not).
	enableForService	When integrating with any customer self service application, enable this option to identify parts as self-service eligible.
	externalKey1	External Key 1 references for parts coming in from external third party system.
	externalKey2	External Key 1 references for parts coming in from external third party system.
	id	The primary key for the part.
	leadTime	Time taken in days for the part to be shipped.
	numberofPricePeriods	Default number of price periods for a part.
	partDisplayNumber	Part Number for display purpose.
	partNumber	Part Number used to identify a part.
	partNumberLower	Used to store part number in lower case.
	partnerOrganizationId	The integrated partner organization Id.
	partnerPartId	The integrated partner part Id
	partnerStandardPriceBookEntryId	The integrated partner Id for the standard price book.
	pricePeriod	Default price period for the period.
	priceType	Default price type applicable to the part- e.g. One-Time, Recurring or Usage-based.
	salesProductType	Categorize the product by a product type.
	units	Number of units for the part number.

URI Endpoint Sample

https://sitename.oracle.com/rest/v17/partSetups/38644116

Response Body Sample

Create a Part

Create a Part
Description	Use this endpoint to create a new CPQ part.
URI Endpoint	/rest/v17/partSetups
Endpoint Parameters	None
HTTP Method	POST
Request Body Parameters	Part Custom Fields	Oracle CPQ supports up to 600 part custom fields `_part_custom_field1` through `_part_custom_field600`.
	dateAdded	System field indicating the date on which the part was created.
	dateModified	System field indicating the date on which the part was last modified.
	defaultUOMCode	Default unit of measure.
	description	The description for the part.
	directBuy	Determines how a part must be purchased.
	eligibleForService	Enable this option, when integrating with a service request application.
	eligibleToSell	Enable if the part should be visible to a sales person (If the part is sellable or not).
	enableForService	When integrating with any customer self service application, enable this option to identify parts as self-service eligible.
	externalKey1	External Key 1 references for parts coming in from external third party system.
	externalKey2	External Key 1 references for parts coming in from external third party system.
	leadTime	Time taken in days for the part to be shipped.
	numberofPricePeriods	Default number of price periods for a part.
	partDisplayNumber	Part Number for display purpose.
	partNumber	Part Number used to identify a part.
	partnerOrganizationId	The integrated partner organization Id.
	partnerPartId	The integrated partner part Id
	partnerStandardPriceBookEntryId	The integrated partner Id for the standard price book.
	pricePeriod	Default price period for the period.
	priceType	Default price type applicable to the part- e.g. One-Time, Recurring or Usage-based.
	salesProductType	Categorize the product by a product type.
	units	Number of units for the part number.
Response Body Parameters	JSON data for the newly added part.

URI Endpoint Sample

https://sitename.oracle.com/rest/v17/partSetups

Create a Part Example

Sample Request Body

Sample Response Body

Create a Part with Prices and Translations

Sample Request Body

{ "eligibleForService": "N", "partnerPartId": null, "directBuy": { "lookupCode": "1", "displayValue": "Direct Buy" }, "defaultUOMCode": null, "description": "Basic Maintenance covers multi-point inspections and preventive care.", "enableSelfService": "N", "leadTime": -1, "units": null, "_part_custom_field10": { "lookupCode": "External", "displayValue": "External" }, "eligibleToSell": "N", "partnerStandardPriceBookEntryId": null, "_part_custom_field9": "subscription", "_part_custom_field3": null, "_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, "salesProductType": null, "priceType": null, "numberOfPricePeriods": 0, "partnerOrganizationId": null, "partDisplayNumber": "BMTN", "pricePeriod": null, "partNumber": "Basic Maintenance Plan", "externalKey1": null, "externalKey2": null, "prices": { "items": [{ "price": { "value": 50.0, "currency": "USD" } }, { "price": { "value": 47.0, "currency": "EUR" } }, { "price": { "value": 42.0, "currency": "GBP" } } ] }, "translations": { "items": [{ "description": "La maintenance de base couvre les inspections multipoints et les soins préventifs.", "language": { "languageNumber": 1, "languageCode": "fr" }, "units": null }, { "description": "Die Basiswartung umfasst Mehrpunktinspektionen und vorbeugende Pflege.", "language": { "languageNumber": 0, "languageCode": "de" }, "units": null } ] } }

Sample Response Body

{ "eligibleForService": "N", "partnerPartId": null, "directBuy": { "lookupCode": "1", "displayValue": "Direct Buy", "id": 36549639, "links": [{ "rel": "domain", "href": "https://sitename.oracle.com/rest/v17/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22BM_PARTS_DIRECT_BUY%22%7D%7D" }, { "rel": "canonical", "href": "https://sitename.oracle.com/rest/v17/lookupValues/36549639" } ] }, "defaultUOMCode": null, "description": "Basic Maintenance covers multi-point inspections and preventive care.", "enableSelfService": "N", "leadTime": -1, "units": null, "_part_custom_field10": { "lookupCode": "External", "displayValue": "External", "id": 38272229, "links": [{ "rel": "domain", "href": "https://sitename.oracle.com/rest/v17/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22_PART_field10%22%7D%7D" }, { "rel": "canonical", "href": "https://sitename.oracle.com/rest/v17/lookupValues/38272229" } ] }, "eligibleToSell": "N", "dateAdded": "2023-03-06T22:32:25.000Z", "partnerStandardPriceBookEntryId": null, "_part_custom_field9": "subscription", "id": 38851705, "_part_custom_field3": null, "_part_custom_field4": { "lookupCode": "Per Month", "displayValue": "Per Month", "id": 36657628, "links": [{ "rel": "domain", "href": "https://sitename.oracle.com/rest/v17/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22_PART_field4%22%7D%7D" }, { "rel": "canonical", "href": "https://sitename.oracle.com/rest/v17/lookupValues/36657628" } ] }, "_part_custom_field1": "Service", "_part_custom_field2": { "lookupCode": "Available", "displayValue": "Available", "id": 38547619, "links": [{ "rel": "domain", "href": "https://sitename.oracle.com/rest/v17/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22_PART_field2%22%7D%7D" }, { "rel": "canonical", "href": "https://sitename.oracle.com/rest/v17/lookupValues/38547619" } ] }, "_part_custom_field8": { "lookupCode": "Recurring", "displayValue": "Recurring", "id": 36657634, "links": [{ "rel": "domain", "href": "https://sitename.oracle.com/rest/v17/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22_PART_field8%22%7D%7D" }, { "rel": "canonical", "href": "https://sitename.oracle.com/rest/v17/lookupValues/36657634" } ] }, "_part_custom_field5": 0.0, "salesProductType": null, "priceType": null, "numberOfPricePeriods": 0, "dateModified": "2023-03-06T22:32:25.000Z", "partnerOrganizationId": null, "partDisplayNumber": "BMTN", "pricePeriod": null, "partNumberLower": "basic maintenance plan", "partNumber": "Basic Maintenance Plan", "externalKey1": null, "externalKey2": null, "translations": { "hasMore": false, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/partSetups/38851705/translations" } ], "items": [{ "description": "Die Basiswartung umfasst Mehrpunktinspektionen und vorbeugende Pflege.", "dateModified": "2023-03-06T22:32:25.000Z", "language": { "languageNumber": 0, "languageCode": "de", "id": 36329903, "links": [{ "rel": "domain", "href": "https://sitename.oracle.com/rest/v17/languages" }, { "rel": "canonical", "href": "https://sitename.oracle.com/rest/v17/languages/36329903" } ] }, "id": 38851710, "units": null, "dateAdded": "2023-03-06T22:32:25.000Z", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/partSetups/38851705/translations/38851710" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/partSetups/38851705" } ] }, { "description": "La maintenance de base couvre les inspections multipoints et les soins préventifs.", "dateModified": "2023-03-06T22:32:25.000Z", "language": { "languageNumber": 1, "languageCode": "fr", "id": 36329904, "links": [{ "rel": "domain", "href": "https://sitename.oracle.com/rest/v17/languages" }, { "rel": "canonical", "href": "https://sitename.oracle.com/rest/v17/languages/36329904" } ] }, "id": 38851709, "units": null, "dateAdded": "2023-03-06T22:32:25.000Z", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/partSetups/38851705/translations/38851709" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/partSetups/38851705" } ] } ] }, "prices": { "hasMore": false, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/partSetups/38851705/prices" } ], "items": [{ "price": { "value": 50.0, "currency": "USD" }, "dateModified": "2023-03-06T22:32:25.000Z", "id": 38851706, "dateAdded": "2023-03-06T22:32:25.000Z", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/partSetups/38851705/prices/38851706" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/partSetups/38851705" } ] }, { "price": { "value": 47.0, "currency": "EUR" }, "dateModified": "2023-03-06T22:32:25.000Z", "id": 38851707, "dateAdded": "2023-03-06T22:32:25.000Z", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/partSetups/38851705/prices/38851707" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/partSetups/38851705" } ] }, { "price": { "value": 42.0, "currency": "GBP" }, "dateModified": "2023-03-06T22:32:25.000Z", "id": 38851708, "dateAdded": "2023-03-06T22:32:25.000Z", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/partSetups/38851705/prices/38851708" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/partSetups/38851705" } ] } ] }, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/partSetups/38851705" }, { "kind": "", "rel": "child", "name": "extendedDescriptions", "href": "https://sitename.oracle.com/rest/v17/partSetups/38851705/extendedDescriptions" } ] }

Update a Part

Update a Part
Description	Use this endpoint to update the specified CPQ part. 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.
URI Endpoint	/rest/v17/partSetups/{id}
Endpoint Parameters	id	The unique identifier for the part.
HTTP Method	PUT
Response Body Parameters	Part Custom Fields	Oracle CPQ supports up to 600 part custom fields `_part_custom_field1` through `_part_custom_field600`.
	dateAdded	System field indicating the date on which the part was created.
	dateModified	System field indicating the date on which the part was last modified.
	defaultUOMCode	Default unit of measure.
	description	The description for the part.
	directBuy	Determines how a part must be purchased.
	eligibleForService	Enable this option, when integrating with a service request application.
	eligibleToSell	Enable if the part should be visible to a sales person (If the part is sellable or not).
	enableForService	When integrating with any customer self service application, enable this option to identify parts as self-service eligible.
	externalKey1	External Key 1 references for parts coming in from external third party system.
	externalKey2	External Key 1 references for parts coming in from external third party system.
	leadTime	Time taken in days for the part to be shipped.
	numberofPricePeriods	Default number of price periods for a part.
	partDisplayNumber	Part Number for display purpose.
	partNumber	Part Number used to identify a part.
	partnerOrganizationId	The integrated partner organization Id.
	partnerPartId	The integrated partner part Id
	partnerStandardPriceBookEntryId	The integrated partner Id for the standard price book.
	pricePeriod	Default price period for the period.
	priceType	Default price type applicable to the part- e.g. One-Time, Recurring or Usage-based.
	salesProductType	Categorize the product by a product type.
	units	Number of units for the part number.
Response Body Status	204 No Content

URI Endpoint Sample

https://sitename.oracle.com/rest/v17/partSetups/38644116

Request Body Sample

{ "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" }

Delete a Part

Delete a Part
Description	Use this endpoint to delete the specified CPQ part.
URI Endpoint	/rest/v17/partSetups/{id}
Endpoint Parameters	id	The unique identifier for the part.
HTTP Method	DELETE
Request Body Parameters	None
Response Body Status	204 No Content

URI Endpoint Sample

https://sitename.oracle.com/rest/v17/partSetups/36594583

Update/Insert Parts

Update/Insert Parts
Description	Use this endpoint to update or insert CPQ parts. If an included Part Number already exists, the existing part will be updated based on the request payload. Otherwise, a new Part will be added.
URI Endpoint	/rest/v17/partSetups/actions/upsertParts
Endpoint Parameters	None
HTTP Method	POST
Request Body Parameters	Part Custom Fields	Oracle CPQ supports up to 600 part custom fields `_part_custom_field1` through `_part_custom_field600`.
	dateAdded	System field indicating the date on which the part was created.
	dateModified	System field indicating the date on which the part was last modified.
	defaultUOMCode	Default unit of measure.
	description	The description for the part.
	directBuy	Determines how a part must be purchased.
	eligibleForService	Enable this option, when integrating with a service request application.
	eligibleToSell	Enable if the part should be visible to a sales person (If the part is sellable or not).
	enableForService	When integrating with any customer self service application, enable this option to identify parts as self-service eligible.
	externalKey1	External Key 1 references for parts coming in from external third party system.
	externalKey2	External Key 1 references for parts coming in from external third party system.
	leadTime	Time taken in days for the part to be shipped.
	numberofPricePeriods	Default number of price periods for a part.
	partDisplayNumber	Part Number for display purpose.
	partNumber	Part Number used to identify a part.
	partnerOrganizationId	The integrated partner organization Id.
	partnerPartId	The integrated partner part Id
	partnerStandardPriceBookEntryId	The integrated partner Id for the standard price book.
	pricePeriod	Default price period for the period.
	priceType	Default price type applicable to the part- e.g. One-Time, Recurring or Usage-based.
	salesProductType	Categorize the product by a product type.
	units	Number of units for the part number.
Response Body Parameters	JSON data for the newly added part.

URI Endpoint Sample

https://sitename.oracle.com/rest/v17/partSetups/actions/upsertParts

Request Body Sample

{ "partSetups": { "items": [{ "_part_custom_field14": null, "_part_custom_field15": null, "_part_custom_field16": { "items": [{ "displayValue": "Value 1 Label", "value": "Value 1" }, { "displayValue": "Value 2 Label", "value": "Value 2" } ] }, "enableSelfService": "Y", "_part_custom_field17": null, "_part_custom_field10": "vxvs", "_part_custom_field11": { "lookupCode": "Required value2" }, "_part_custom_field13": null, "_part_custom_field9": { "lookupCode": "Part Fields" }, "_part_custom_field3": null, "_part_custom_field4": null, "_part_custom_field1": null, "_part_custom_field2": null, "_part_custom_field20": null, "_part_custom_field7": 1000, "_part_custom_field8": null, "_part_custom_field5": 0, "salesProductType": null, "_part_custom_field6": 11, "_part_custom_field25": null, "_part_custom_field26": null, "_part_custom_field27": null, "_part_custom_field21": null, "_part_custom_field22": null, "_part_custom_field23": null, "_part_custom_field24": null, "_part_custom_field18": null, "_part_custom_field19": null, "eligibleForService": "Y", "_part_custom_field30": "fdfdx", "directBuy": { "lookupCode": "2" }, "defaultUOMCode": "SUM", "description": "Part with a float part number value", "leadTime": -1, "units": null, "eligibleToSell": "Y", "priceType": null, "numberOfPricePeriods": 0, "partDisplayNumber": "partForResourceTest5558", "pricePeriod": null, "partNumberLower": "partforresourcetest5558", "partNumber": "partForResourceTest5558", "externalKey1": null, "externalKey2": null, "partnerStandardPriceBookEntryId": "asdf", "partnerPartId": "fdasd", "partnerOrganizationId": "burrrr", "prices": { "items": [{ "price": { "value": 1.24, "currency": "USD" } }, { "price": { "value": 1.25, "currency": "EUR" } } ] }, "translations": { "items": [{ "description": "asdf5", "language": { "languageNumber": 0 }, "units": null } ] }, "extendedDescriptions": { "items": [{ "partExtendedDescription1": "Extended description 1 for part5186", "partExtendedDescription2": "Extended description 2 for part5186", "translations": { "items": [{ "partExtendedDescription1": "Extended description 1 for part5186", "language": { "languageNumber": -1, "languageCode": "en" }, "partExtendedDescription2": "Extended description 2 for part5186" } ] } } ] } }, { "description": "updated with that fresh API", "partNumber": "testFromResource2", "prices": { "items": [{ "price": { "value": 1.25, "currency": "USD" } } ] } }, { "_part_custom_field14": null, "_part_custom_field15": null, "_part_custom_field16": { "items": [{ "value": "Value 1" }, { "value": "Value 2" } ] }, "enableSelfService": "Y", "_part_custom_field17": null, "_part_custom_field10": "vxvs", "_part_custom_field11": { "lookupCode": "Required value2" }, "_part_custom_field13": null, "_part_custom_field9": { "lookupCode": "Part Fields" }, "_part_custom_field3": null, "_part_custom_field4": null, "_part_custom_field1": null, "_part_custom_field2": null, "_part_custom_field20": null, "_part_custom_field7": 1000, "_part_custom_field8": null, "_part_custom_field5": { "value": 1.5, "unitVarName": "ft/s2" }, "salesProductType": null, "_part_custom_field6": 9.999, "_part_custom_field25": null, "_part_custom_field26": null, "_part_custom_field27": null, "_part_custom_field21": null, "_part_custom_field22": null, "_part_custom_field23": null, "_part_custom_field24": null, "_part_custom_field18": null, "_part_custom_field19": null, "eligibleForService": "Y", "_part_custom_field30": "fdfdx", "directBuy": { "lookupCode": "2" }, "defaultUOMCode": "SUM", "description": "Part with a float part number value", "leadTime": -1, "units": null, "eligibleToSell": "Y", "priceType": null, "numberOfPricePeriods": 0, "partDisplayNumber": "thisWasUpdatedFromRest", "pricePeriod": null, "partNumber": "upsertedPart", "externalKey1": null, "externalKey2": null, "partnerStandardPriceBookEntryId": "asdf", "partnerPartId": "fdasd", "partnerOrganizationId": "burrrr" } ] } }

Response Body Sample

{ "processedPartSetups": { "items": [{ "_part_custom_field14": null, "_part_custom_field15": null, "_part_custom_field16": { "items": [{ "displayValue": "Value 1 Label", "value": "Value 1" }, { "displayValue": "Value 2 Label", "value": "Value 2" } ] }, "enableSelfService": "Y", "_part_custom_field17": null, "_part_custom_field10": "vxvs", "_part_custom_field11": { "lookupCode": "Required value2", "displayValue": "Required value2", "id": 20963068, "links": [{ "rel": "domain", "href": "http://sitename.oracle.com/rest/v17/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22_PART_field11%22%7D%7D" }, { "rel": "canonical", "href": "http://sitename.oracle.com/rest/v17/lookupValues/20963068" } ] }, "dateAdded": "2023-01-27T19:35:47.000Z", "_part_custom_field13": null, "_part_custom_field9": { "lookupCode": "Part Fields", "displayValue": "Part Fields", "id": 20963084, "links": [{ "rel": "domain", "href": "http://sitename.oracle.com/rest/v17/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22_PART_field9%22%7D%7D" }, { "rel": "canonical", "href": "http://sitename.oracle.com/rest/v17/lookupValues/20963084" } ] }, "id": 3022900770, "_part_custom_field3": null, "_part_custom_field4": null, "_part_custom_field1": null, "_part_custom_field2": null, "_part_custom_field20": null, "_part_custom_field7": 1000, "_part_custom_field8": null, "_part_custom_field5": 0.0, "salesProductType": null, "_part_custom_field6": 11.0, "_part_custom_field25": null, "_part_custom_field26": null, "_part_custom_field27": null, "_part_custom_field21": null, "_part_custom_field22": null, "_part_custom_field23": null, "_part_custom_field24": null, "_part_custom_field18": null, "_part_custom_field19": null, "eligibleForService": "Y", "partnerPartId": null, "_part_custom_field30": "fdfdx", "directBuy": { "lookupCode": "2", "displayValue": "Buy Parent Part", "id": 19880907, "links": [{ "rel": "domain", "href": "http://sitename.oracle.com/rest/v17/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22BM_PARTS_DIRECT_BUY%22%7D%7D" }, { "rel": "canonical", "href": "http://sitename.oracle.com/rest/v17/lookupValues/19880907" } ] }, "_part_custom_field31": null, "defaultUOMCode": "SUM", "description": "Part with a float part number value", "leadTime": -1, "units": null, "eligibleToSell": "Y", "partnerStandardPriceBookEntryId": null, "priceType": null, "numberOfPricePeriods": 0, "dateModified": "2023-01-27T19:35:47.000Z", "partnerOrganizationId": null, "partDisplayNumber": "party1", "pricePeriod": null, "partNumberLower": "party1", "partNumber": "party1", "externalKey1": null, "externalKey2": null, "translations": { "hasMore": false, "links": [{ "rel": "self", "href": "http://sitename.oracle.com/rest/v17/partSetups/3022900770/translations" } ], "items": [{ "description": "asdf4", "dateModified": "2023-01-27T19:35:48.000Z", "language": { "languageNumber": 0, "languageCode": "de", "id": 18325670, "links": [{ "rel": "domain", "href": "http://sitename.oracle.com/rest/v17/languages" }, { "rel": "canonical", "href": "http://sitename.oracle.com/rest/v17/languages/18325670" } ] }, "id": 3022900772, "units": "asdf1", "dateAdded": "2023-01-27T19:35:48.000Z", "links": [{ "rel": "self", "href": "http://sitename.oracle.com/rest/v17/partSetups/3022900770/translations/3022900772" }, { "rel": "parent", "href": "http://sitename.oracle.com/rest/v17/partSetups/3022900770" } ] } ] }, "prices": { "hasMore": false, "links": [{ "rel": "self", "href": "http://sitename.oracle.com/rest/v17/partSetups/3022900770/prices" } ], "items": [{ "price": { "value": 1.24, "currency": "USD" }, "dateModified": "2023-01-27T19:35:48.000Z", "id": 3022900771, "dateAdded": "2023-01-27T19:35:48.000Z", "links": [{ "rel": "self", "href": "http://sitename.oracle.com/rest/v17/partSetups/3022900770/prices/3022900771" }, { "rel": "parent", "href": "http://sitename.oracle.com/rest/v17/partSetups/3022900770" } ] } ] }, "extendedDescriptions": { "hasMore": false, "links": [{ "rel": "self", "href": "http://sitename.oracle.com/rest/v17/partSetups/3022900770/extendedDescriptions" } ], "items": [{ "partExtendedDescription1": "Extended description 1 for part5186", "partExtendedDescription2": "Extended description 2 for part5186", "dateModified": "2023-01-27T19:35:48.000Z", "id": 3022900771, "dateAdded": "2023-01-27T19:35:48.000Z", "translations": { "hasMore": false, "links": [{ "rel": "self", "href": "http://sitename.oracle.com/rest/v17/partSetups/3022900770/extendedDescriptions/3022900771/translations" } ], "items": [{ "partExtendedDescription1": "Extended description 1 for part5186", "language": { "languageNumber": -1, "languageCode": "en", "id": 18325669, "links": [{ "rel": "domain", "href": "http://sitename.oracle.com/rest/v17/languages" }, { "rel": "canonical", "href": "http://sitename.oracle.com/rest/v17/languages/18325669" } ] }, "partExtendedDescription2": "Extended description 2 for part5186", "dateModified": "2023-01-27T19:35:48.000Z", "id": 3022900771, "dateAdded": "2023-01-27T19:35:48.000Z", "links": [{ "rel": "self", "href": "http://sitename.oracle.com/rest/v17/partSetups/3022900770/extendedDescriptions/3022900771/translations/3022900771" } ] } ] }, "links": [{ "rel": "self", "href": "http://sitename.oracle.com/rest/v17/partSetups/3022900770/extendedDescriptions/3022900771" }, { "rel": "parent", "href": "http://sitename.oracle.com/rest/v17/partSetups/3022900770" } ] } ] }, "links": [{ "rel": "self", "href": "http://sitename.oracle.com/rest/v17/partSetups/3022900770" } ] }, { "_part_custom_field14": null, "_part_custom_field15": null, "_part_custom_field16": { "items": [{ "displayValue": "Value 1 Label", "value": "Value 1" }, { "displayValue": "Value 2 Label", "value": "Value 2" } ] }, "enableSelfService": "Y", "_part_custom_field17": null, "_part_custom_field10": "vxvs", "_part_custom_field11": { "lookupCode": "Required value2", "displayValue": "Required value2", "id": 20963068, "links": [{ "rel": "domain", "href": "http://sitename.oracle.com/rest/v17/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22_PART_field11%22%7D%7D" }, { "rel": "canonical", "href": "http://sitename.oracle.com/rest/v17/lookupValues/20963068" } ] }, "dateAdded": "2023-01-27T19:35:47.000Z", "_part_custom_field13": null, "_part_custom_field9": { "lookupCode": "Part Fields", "displayValue": "Part Fields", "id": 20963084, "links": [{ "rel": "domain", "href": "http://sitename.oracle.com/rest/v17/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22_PART_field9%22%7D%7D" }, { "rel": "canonical", "href": "http://sitename.oracle.com/rest/v17/lookupValues/20963084" } ] }, "id": 3022900770, "_part_custom_field3": null, "_part_custom_field4": null, "_part_custom_field1": null, "_part_custom_field2": null, "_part_custom_field20": null, "_part_custom_field7": 1000, "_part_custom_field8": null, "_part_custom_field5": 0.0, "salesProductType": null, "_part_custom_field6": 11.0, "_part_custom_field25": null, "_part_custom_field26": null, "_part_custom_field27": null, "_part_custom_field21": null, "_part_custom_field22": null, "_part_custom_field23": null, "_part_custom_field24": null, "_part_custom_field18": null, "_part_custom_field19": null, "eligibleForService": "Y", "partnerPartId": null, "_part_custom_field30": "fdfdx", "directBuy": { "lookupCode": "2", "displayValue": "Buy Parent Part", "id": 19880907, "links": [{ "rel": "domain", "href": "http://sitename.oracle.com/rest/v17/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22BM_PARTS_DIRECT_BUY%22%7D%7D" }, { "rel": "canonical", "href": "http://sitename.oracle.com/rest/v17/lookupValues/19880907" } ] }, "_part_custom_field31": null, "defaultUOMCode": "SUM", "description": "updated with that fresh API", "leadTime": -1, "units": null, "eligibleToSell": "Y", "partnerStandardPriceBookEntryId": null, "priceType": null, "numberOfPricePeriods": 0, "dateModified": "2023-01-27T19:35:47.000Z", "partnerOrganizationId": null, "partDisplayNumber": "testFromResource2", "pricePeriod": null, "partNumberLower": "testFromresource2", "partNumber": "testFromResource2", "externalKey1": null, "externalKey2": null, "translations": { "hasMore": false, "links": [{ "rel": "self", "href": "http://sitename.oracle.com/rest/v17/partSetups/3022900770/translations" } ], "items": [{ "description": "asdf4", "dateModified": "2023-01-27T19:35:48.000Z", "language": { "languageNumber": 0, "languageCode": "de", "id": 18325670, "links": [{ "rel": "domain", "href": "http://sitename.oracle.com/rest/v17/languages" }, { "rel": "canonical", "href": "http://sitename.oracle.com/rest/v17/languages/18325670" } ] }, "id": 3022900772, "units": "asdf1", "dateAdded": "2023-01-27T19:35:48.000Z", "links": [{ "rel": "self", "href": "http://sitename.oracle.com/rest/v17/partSetups/3022900770/translations/3022900772" }, { "rel": "parent", "href": "http://sitename.oracle.com/rest/v17/partSetups/3022900770" } ] } ] }, "prices": { "hasMore": false, "links": [{ "rel": "self", "href": "http://sitename.oracle.com/rest/v17/partSetups/3022900770/prices" } ], "items": [{ "price": { "value": 1.25, "currency": "USD" }, "dateModified": "2023-01-27T19:35:48.000Z", "id": 3022900771, "dateAdded": "2023-01-27T19:35:48.000Z", "links": [{ "rel": "self", "href": "http://sitename.oracle.com/rest/v17/partSetups/3022900770/prices/3022900771" }, { "rel": "parent", "href": "http://sitename.oracle.com/rest/v17/partSetups/3022900770" } ] } ] }, "links": [{ "rel": "self", "href": "http://sitename.oracle.com/rest/v17/partSetups/3022900770" }, { "kind": "", "rel": "child", "name": "extendedDescriptions", "href": "http://sitename.oracle.com/rest/v17/partSetups/3022900770/extendedDescriptions" } ] }, { "_part_custom_field14": null, "_part_custom_field15": null, "_part_custom_field16": { "items": [{ "displayValue": "Value 1 Label", "value": "Value 1" }, { "displayValue": "Value 2 Label", "value": "Value 2" } ] }, "enableSelfService": "Y", "_part_custom_field17": null, "_part_custom_field10": "vxvs", "_part_custom_field11": { "lookupCode": "Required value2", "displayValue": "Required value2", "id": 20963068, "links": [{ "rel": "domain", "href": "http://sitename.oracle.com/rest/v17/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22_PART_field11%22%7D%7D" }, { "rel": "canonical", "href": "http://sitename.oracle.com/rest/v17/lookupValues/20963068" } ] }, "dateAdded": "2023-01-27T19:35:47.000Z", "_part_custom_field13": null, "_part_custom_field9": { "lookupCode": "Part Fields", "displayValue": "Part Fields", "id": 20963084, "links": [{ "rel": "domain", "href": "http://sitename.oracle.com/rest/v17/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22_PART_field9%22%7D%7D" }, { "rel": "canonical", "href": "http://sitename.oracle.com/rest/v17/lookupValues/20963084" } ] }, "id": 3022900770, "_part_custom_field3": null, "_part_custom_field4": null, "_part_custom_field1": null, "_part_custom_field2": null, "_part_custom_field20": null, "_part_custom_field7": 1000, "_part_custom_field8": null, "_part_custom_field5": 0.0, "salesProductType": null, "_part_custom_field6": 11.0, "_part_custom_field25": null, "_part_custom_field26": null, "_part_custom_field27": null, "_part_custom_field21": null, "_part_custom_field22": null, "_part_custom_field23": null, "_part_custom_field24": null, "_part_custom_field18": null, "_part_custom_field19": null, "eligibleForService": "Y", "partnerPartId": null, "_part_custom_field30": "fdfdx", "directBuy": { "lookupCode": "2", "displayValue": "Buy Parent Part", "id": 19880907, "links": [{ "rel": "domain", "href": "http://sitename.oracle.com/rest/v17/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22BM_PARTS_DIRECT_BUY%22%7D%7D" }, { "rel": "canonical", "href": "http://sitename.oracle.com/rest/v17/lookupValues/19880907" } ] }, "_part_custom_field31": null, "defaultUOMCode": "SUM", "description": "updated with that fresh API", "leadTime": -1, "units": null, "eligibleToSell": "Y", "partnerStandardPriceBookEntryId": null, "priceType": null, "numberOfPricePeriods": 0, "dateModified": "2023-01-27T19:35:47.000Z", "partnerOrganizationId": null, "partDisplayNumber": "thisWasUpdatedFromRest", "pricePeriod": null, "partNumberLower": "upsertedpart", "partNumber": "upsertedPart", "externalKey1": null, "externalKey2": null, "translations": { "hasMore": false, "links": [{ "rel": "self", "href": "http://sitename.oracle.com/rest/v17/partSetups/3022900770/translations" } ], "items": [] }, "prices": { "hasMore": false, "links": [{ "rel": "self", "href": "http://sitename.oracle.com/rest/v17/partSetups/3022900770/prices" } ], "items": [] }, "links": [{ "rel": "self", "href": "http://sitename.oracle.com/rest/v17/partSetups/3022900770" }, { "kind": "", "rel": "child", "name": "extendedDescriptions", "href": "http://sitename.oracle.com/rest/v17/partSetups/3022900770/extendedDescriptions" } ] } ] } }

Get Part Metadata Action

Get Part Metadata Action
Description	Use this endpoint to retrieve return the metadata for CPQ standard and part custom fields.
URI Endpoint	/rest/v17/partSetups/actions/getPartMetadata
Endpoint Parameters	None
HTTP Method	POST
Request Body Parameters	None
Response Body Parameters	standardFields	The standard fields array contains to following data for each field: `fieldName`, `label`, `required`, and `type`.
Response Body Parameters	customFields	The custom fields array contains to following data for each field: `fieldName`, `label`, `required`, `type`, `showOnSearchPage`, `showOnSearchResultsPage`, `showOnBomPage`, and `showOnDetailPage`.

URI Endpoint Sample

https://sitename.oracle.com/rest/v17/partSetups/actions/getPartMetadata

Response Body Sample

{ "partMetadata": { "standardFields": [{ "fieldName": "dateAdded", "label": "Date Added", "required": true, "type": "Date" }, { "fieldName": "dateModified", "label": "Date Modified", "required": false, "type": "Date" }, { "fieldName": "defaultUOMCode", "label": "Default UOM Code", "required": false, "type": "String" }, { "fieldName": "description", "label": "Description", "required": false, "type": "String" }, { "fieldName": "directBuy", "label": "Direct Buy", "required": true, "type": "Single Select Menu" }, { "fieldName": "eligibleForService", "label": "Eligible for Service", "required": false, "type": "String" }, { "fieldName": "eligibleToSell", "label": "Eligible to Sell", "required": false, "type": "String" }, { "fieldName": "enableSelfService", "label": "Enable Customer Self-Service", "required": false, "type": "String" }, { "fieldName": "externalKey1", "label": "External Key 1", "required": false, "type": "String" }, { "fieldName": "externalKey2", "label": "External Key 2", "required": false, "type": "String" }, { "fieldName": "id", "label": "Id", "required": false, "type": "Integer" }, { "fieldName": "leadTime", "label": "Lead Time", "required": false, "type": "Integer" }, { "fieldName": "numberOfPricePeriods", "label": "Number of Price Periods", "required": false, "type": "Integer" }, { "fieldName": "partDisplayNumber", "label": "Part Display Number", "required": false, "type": "String" }, { "fieldName": "partNumber", "label": "Part Number", "required": true, "type": "String" }, { "fieldName": "partNumberLower", "label": "Part Number Lower", "required": false, "type": "String" }, { "fieldName": "partnerOrganizationId", "label": "Partner Organization Id", "required": false, "type": "String" }, { "fieldName": "partnerPartId", "label": "Partner Part Id", "required": false, "type": "String" }, { "fieldName": "partnerStandardPriceBookEntryId", "label": "Partner Standard Pricebook Entry Id", "required": false, "type": "String" }, { "fieldName": "pricePeriod", "label": "Price Period", "required": false, "type": "String" }, { "fieldName": "priceType", "label": "Price Type", "required": false, "type": "String" }, { "fieldName": "salesProductType", "label": "Sales Product Type", "required": false, "type": "String" }, { "fieldName": "units", "label": "Units", "required": false, "type": "String" } ], "customFields": [{ "fieldName": "_part_custom_field1", "label": "Product Group", "required": false, "type": "String", "showOnSearchPage": false, "showOnSearchResultsPage": false, "showOnBomPage": false, "showOnDetailPage": false }, { "fieldName": "_part_custom_field10", "label": "Product type", "required": false, "type": "Single Select Menu", "showOnSearchPage": false, "showOnSearchResultsPage": false, "showOnBomPage": false, "showOnDetailPage": false }, { "fieldName": "_part_custom_field2", "label": "Part Availability", "required": false, "type": "Single Select Menu", "showOnSearchPage": true, "showOnSearchResultsPage": true, "showOnBomPage": false, "showOnDetailPage": false }, { "fieldName": "_part_custom_field3", "label": "Max discount %", "required": false, "type": "String", "showOnSearchPage": false, "showOnSearchResultsPage": false, "showOnBomPage": false, "showOnDetailPage": false }, { "fieldName": "_part_custom_field4", "label": "Price Period", "required": false, "type": "Single Select Menu", "showOnSearchPage": false, "showOnSearchResultsPage": false, "showOnBomPage": false, "showOnDetailPage": true }, { "fieldName": "_part_custom_field5", "label": "Cost", "required": false, "type": "Number", "showOnSearchPage": false, "showOnSearchResultsPage": false, "showOnBomPage": false, "showOnDetailPage": false }, { "fieldName": "_part_custom_field8", "label": "Price Type", "required": false, "type": "Single Select Menu", "showOnSearchPage": false, "showOnSearchResultsPage": false, "showOnBomPage": false, "showOnDetailPage": true }, { "fieldName": "_part_custom_field9", "label": "product", "required": false, "type": "String", "showOnSearchPage": false, "showOnSearchResultsPage": false, "showOnBomPage": false, "showOnDetailPage": false } ] } }

Part Extended Descriptions

Get Part Extended Descriptions

Get Part Extended Descriptions
Description	Use this endpoint to retrieve extended descriptions for the specified CPQ part.
URI Endpoint	/rest/v17/partSetups/{id}/extendedDescriptions
Endpoint Parameters	id	The unique identifier for the part.
HTTP Method	GET
Request Body Parameters	None
Response Body Parameters	dateAdded	System field indicating the date on which the resource was created.
	dateModified	System field indicating the date on which the resource was last modified.
	id	The unique identifier for the part extended descriptions.
	partExtendedDescription1	Part extended description 1.
	partExtendedDescription2	Part extended description 2.

URI Endpoint Sample

http://sitename.oracle.com/rest/v17/partSetups/38644116/extendedDescriptions

Response Body Sample

{ "hasMore": false, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/partSetups/38644116/extendedDescriptions" } ], "items": [{ "partExtendedDescription1": "<h2>Coverage Includes</h2>Premium Maintenance covers routine inspections, preventive care and replacement of normal \"wear and tear\" items that require periodic attention. Your actual plan will be based on your vehicle’s maintenance needs as indicated in your Owner's Scheduled Maintenance Guide:<br /><ul><li>Engine oil and filter changes</li><li>Multi-point inspections</li><li>Tire rotations</li><li>Brake pads and linings</li><li>Shock absorbers/struts</li><li>Spark plugs</li><li>Clutch discs</li><li>Engine belts</li><li>Engine coolant hoses, clamps and o-ring seals</li><li>Wiper blades</li><li>Diesel exhaust fluid fill at the time scheduled maintenance is performed at dealership</li></ul>", "dateModified": "2023-03-02T20:47:12.000Z", "id": 38653270, "partExtendedDescription2": "<h2>Multi-Point Inspection</h2><p>At each service interval, your vehicle undergoes a comprehensive multi-point inspection as indicated in your Owner’s Scheduled Maintenance Guide:</p><h3>Check Following Systems/Components:</h3><ul><li>Operation of horn, interior lights, exterior lamps, turn signals, and hazard and brake lights</li><li>Windshield washer spray, wiper operation and wiper blades</li><li>Windshield for cracks, chips and pitting</li><li>Radiator, heater and air conditioning lines for leaks and damage</li><li>Engine air filter</li><li>Oil and fluid leaks</li><li>Exhaust system (leaks, damage, loose parts)</li><li>Steering and steering linkages</li><li>Shocks/struts and other suspension components for leaks and/or damage</li><li>Accessory drive belt(s)</li><li>Clutch operation (if equipped)</li><li>Tires for wear and proper air pressure</li></ul><h3>Check Fluid Levels and Fill:</h3><ul><li>Transmission (if equipped with a dipstick)</li><li>Brake reservoir</li><li>Power steering</li><li>Coolant recovery reservoir</li><li>Window washer</li><li>Diesel exhaust fluid (if necessary)</li></ul>", "dateAdded": "2021-09-22T09:01:06.000Z", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/partSetups/38644116/extendedDescriptions/38653270" }, { "kind": "", "rel": "child", "name": "translations", "href": "https://sitename.oracle.com/rest/v17/partSetups/38644116/extendedDescriptions/38653270/translations" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/partSetups/38644116" } ] } ] }

Get Part Extended Descriptions Using Extended Descriptions Id

Get Part Extended Descriptions Using Extended Descriptions Id
Description	Use this endpoint to retrieve extended descriptions for the specified CPQ part.
URI Endpoint	/rest/v17/partSetups/{id}/extendedDescriptions/{descriptionsId}
Endpoint Parameters	id	The unique identifier for the part.
	descriptionsId	The extended descriptions Id.
	(Optional) This endpoint supports the following query specifications: `expand`, `fields`, `limit`, `offset`, `orderby`, `q`, and `totalResults`. For more information, see Manage Collections.
HTTP Method	GET
Request Body Parameters	None
Response Body Parameters	dateAdded	System field indicating the date on which the resource was created.
	dateModified	System field indicating the date on which the resource was last modified.
	id	The unique identifier for the part extended descriptions.
	partExtendedDescription1	Part extended description 1.
	partExtendedDescription2	Part extended description 2.

URI Endpoint Sample

https://sitename.oracle.com/rest/v17/partSetups/38644116/extendedDescriptions/38653270

Response Body Sample

{ "partExtendedDescription1": "<h2>Coverage Includes</h2>Premium Maintenance covers routine inspections, preventive care and replacement of normal \"wear and tear\" items that require periodic attention. Your actual plan will be based on your vehicle’s maintenance needs as indicated in your Owner's Scheduled Maintenance Guide:<br /><ul><li>Engine oil and filter changes</li><li>Multi-point inspections</li><li>Tire rotations</li><li>Brake pads and linings</li><li>Shock absorbers/struts</li><li>Spark plugs</li><li>Clutch discs</li><li>Engine belts</li><li>Engine coolant hoses, clamps and o-ring seals</li><li>Wiper blades</li><li>Diesel exhaust fluid fill at the time scheduled maintenance is performed at dealership</li></ul>", "dateModified": "2023-03-02T20:47:12.000Z", "id": 38653270, "partExtendedDescription2": "<h2>Multi-Point Inspection</h2><p>At each service interval, your vehicle undergoes a comprehensive multi-point inspection as indicated in your Owner’s Scheduled Maintenance Guide:</p><h3>Check Following Systems/Components:</h3><ul><li>Operation of horn, interior lights, exterior lamps, turn signals, and hazard and brake lights</li><li>Windshield washer spray, wiper operation and wiper blades</li><li>Windshield for cracks, chips and pitting</li><li>Radiator, heater and air conditioning lines for leaks and damage</li><li>Engine air filter</li><li>Oil and fluid leaks</li><li>Exhaust system (leaks, damage, loose parts)</li><li>Steering and steering linkages</li><li>Shocks/struts and other suspension components for leaks and/or damage</li><li>Accessory drive belt(s)</li><li>Clutch operation (if equipped)</li><li>Tires for wear and proper air pressure</li></ul><h3>Check Fluid Levels and Fill:</h3><ul><li>Transmission (if equipped with a dipstick)</li><li>Brake reservoir</li><li>Power steering</li><li>Coolant recovery reservoir</li><li>Window washer</li><li>Diesel exhaust fluid (if necessary)</li></ul>", "dateAdded": "2021-09-22T09:01:06.000Z", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/partSetups/38644116/extendedDescriptions/38653270" }, { "kind": "", "rel": "child", "name": "translations", "href": "https://sitename.oracle.com/rest/v17/partSetups/38644116/extendedDescriptions/38653270/translations" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/partSetups/38644116" } ] }

Create Part Extended Descriptions

Create Part Extended Descriptions
Description	Use this endpoint to create extended descriptions for CPQ part without an extended descriptions object. Note: If the Extended Descriptions object exists, even though the descriptions are empty, you should use Update Part Extended Descriptions to populate the extended descriptions.
URI Endpoint	/rest/v17/partSetups/{id}/extendedDescriptions
Endpoint Parameters	id	The unique identifier for the part.
HTTP Method	POST
Request Body Parameters	partExtendedDescription1	Part extended description 1.
Request Body Parameters	partExtendedDescription2	Part extended description 2.
Response Body Parameters	dateAdded	System field indicating the date on which the resource was created.
	dateModified	System field indicating the date on which the resource was last modified.
	id	The unique identifier for the part extended descriptions.
	partExtendedDescription1	Part extended description 1.
	partExtendedDescription2	Part extended description 2.

URI Endpoint Sample

https://sitename.oracle.com/rest/v17/partSetups/39644116/extendedDescriptions

Request Body Sample

{ "partExtendedDescription1": "Sample content for extended part description 1", "partExtendedDescription2": "Sample content for extended part description 2" }

Response Body Sample

{ "hasMore": false, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/partSetups/39644116/extendedDescriptions" } ], "items": [{ "partExtendedDescription1": "Sample content for extended part description 1", "dateModified": "2023-03-02T20:47:12.000Z", "id": 39653270, "partExtendedDescription2": "Sample content for extended part description 2", "dateAdded": "2021-09-22T09:01:06.000Z", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/partSetups/39644116/extendedDescriptions/38653270" }, { "kind": "", "rel": "child", "name": "translations", "href": "https://sitename.oracle.com/rest/v17/partSetups/39644116/extendedDescriptions/39653270/translations" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/partSetups/39644116" } ] } ] }

Update Part Extended Descriptions

Update Part Extended Descriptions
Description	Use this endpoint to update extended descriptions for a CPQ part.
URI Endpoint	/rest/v17/partSetups/{id}}/extendedDescriptions/{descriptionsId}
Endpoint Parameters	id	The unique identifier for the part.
Endpoint Parameters	descriptionsId	The extended descriptions Id.
HTTP Method	PUT
Response Body Parameters	partExtendedDescription1	Part extended description 1.
Response Body Parameters	partExtendedDescription2	Part extended description 2.
Response Body Status	204 No Content

URI Endpoint Sample

https://sitename.oracle.com/rest/v17/partSetups/38851705/extendedDescriptions/38851711

Request Body Sample

{ "partExtendedDescription1": "Sample content for extended part description 1", "partExtendedDescription2": "Sample content for extended part description 2" }

Part Prices

Get All Prices for a Part

Get All Prices for a Part
Description	Use this endpoint to retrieve all prices for the specified CPQ part.
URI Endpoint	/rest/v17/partSetups/{id}/prices
Endpoint Parameters	id	The unique identifier for the part.
HTTP Method	GET
Request Body Parameters	None
Response Body Parameters	A collection of prices for a part.

URI Endpoint Sample

https://sitename.oracle.com/rest/v17/partSetups/38644116/prices

Response Body Sample

{ "hasMore": false, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/partSetups/38644116/prices" } ], "items": [{ "price": { "value": 125.0, "currency": "USD" }, "dateModified": "2023-03-07T18:21:22.000Z", "id": 38852302, "dateAdded": "2023-03-07T18:21:22.000Z", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/partSetups/38644116/prices/38852302" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/partSetups/38644116" } ] }, { "price": { "value": 11800.0, "currency": "EUR" }, "dateModified": "2023-03-07T18:21:22.000Z", "id": 38852300, "dateAdded": "2023-03-07T18:21:22.000Z", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/partSetups/38644116/prices/38852300" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/partSetups/38644116" } ] }, { "price": { "value": 105.0, "currency": "GBP" }, "dateModified": "2023-03-07T18:21:22.000Z", "id": 38852301, "dateAdded": "2023-03-07T18:21:22.000Z", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/partSetups/38644116/prices/38852301" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/partSetups/38644116" } ] } ] }

Get a Part Price

Get a Part Price
Description	Use this endpoint to retrieve the specified price for a CPQ part.
URI Endpoint	/rest/v17/partSetups/{id}/prices/{priceId}
Endpoint Parameters	id	The unique identifier for the part.
Endpoint Parameters	priceId	The unique identifier for a part price.
HTTP Method	GET
Request Body Parameters	None
Response Body Parameters	price	Currency attribute that contains a composite JSON object with "value" and "currency" items.
	dateModified	System field indicating the date on which the resource was last modified.
	id	The unique identifier for the part price.
	dateAdded	System field indicating the date on which the resource was added.

URI Endpoint Sample

https://sitename.oracle.com/rest/v17/partSetups/38644116/prices/38852300

Response Body Sample

{ "price": { "value": 11800.0, "currency": "EUR" }, "dateModified": "2023-03-07T18:21:22.000Z", "id": 38852300, "dateAdded": "2023-03-07T18:21:22.000Z", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/partSetups/38644116/prices/38852300" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/partSetups/38644116" } ] }

Create a Part Prices

Create a Part Price
Description	Use this endpoint to create prices for the specified CPQ part.
URI Endpoint	/rest/v17/partSetups/{id}/prices
Endpoint Parameters	id	The unique identifier for the part.
HTTP Method	POST
	None
Request Body Parameters	price	Currency attribute that contains a composite JSON object with "value" and "currency" items.
Response Body Parameters	price	Currency attribute that contains a composite JSON object with "value" and "currency" items.
	dateModified	System field indicating the date on which the resource was last modified.
	id	The unique identifier for the part price.
	dateAdded	System field indicating the date on which the resource was added.

URI Endpoint Sample

https://sitename.oracle.com/rest/v17/partSetups/38644116/prices

Request Body Sample

{ "price": { "value": 50.0, "currency": "USD" } }

Response Body Sample

{ "price": { "value": 50.0, "currency": "USD" }, "dateModified": "2023-03-07T17:44:44.000Z", "id": 38852265, "dateAdded": "2023-03-07T17:44:44.000Z", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/partSetups/38644116/prices/38852265" } ] }

Update a Part Price

Update a Part Price
Description	Use this endpoint to update a price for a CPQ part.
URI Endpoint	/rest/v17/partSetups/{id}}/prices/{priceId}
Endpoint Parameters	id	The unique identifier for the part.
Endpoint Parameters	priceId	The unique identifier for a part price.
HTTP Method	PUT
Response Body Parameters
Response Body Parameters
Response Body Status	204 No Content

URI Endpoint Sample

https://sitename.oracle.com/rest/v17/partSetups/38644116/prices/38852300

Request Body Sample

{ "price": { "value": 118.0, "currency": "EUR" } }

Delete a Part Price

Delete a Part Price
Description	Use this endpoint to delete a price for a CPQ part.
URI Endpoint	/rest/v17/partSetups/{id}}/prices/{priceId}
Endpoint Parameters	id	The unique identifier for the part.
Endpoint Parameters	priceId	The unique identifier for a part price.
HTTP Method	DELETE
Request Body Parameters	None
Response Body Status	204 No Content

URI Endpoint Sample

https://sitename.oracle.com/rest/v17/partSetups/38644116/prices/38852300

Part Translations

Get All Translations for a Part

Get All Translations for a Part
Description	Use this endpoint to retrieve all translations for the specified CPQ part.
URI Endpoint	/rest/v17/partSetups/{id}/translations
Endpoint Parameters	id	The unique identifier for the part.
Endpoint Parameters	(Optional) This endpoint supports the following query specifications: `expand`, `fields`, `limit`, `offset`, `orderby`, `q`, and `totalResults`. For more information, see Manage Collections.
HTTP Method	GET
Request Body Parameters	None
Response Body Parameters	A collection of part translations.

URI Endpoint Sample

https://sitename.oracle.com/rest/v17/partSetups/38644116/translations

Response Body Sample

{ "hasMore": false, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/partSetups/38644116/translations" } ], "items": [{ "description": "L'entretien Premium couvre les inspections multipoints, ainsi que les soins préventifs et le remplacement des éléments normaux d'usure normale qui nécessitent une attention périodique.", "dateModified": "2023-03-02T21:31:55.000Z", "language": { "languageNumber": 1, "languageCode": "fr", "id": 36329904, "links": [{ "rel": "domain", "href": "https://sitename.oracle.com/rest/v17/languages" }, { "rel": "canonical", "href": "https://sitename.oracle.com/rest/v17/languages/36329904" } ] }, "id": 38818015, "units": null, "dateAdded": "2023-03-02T21:31:55.000Z", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/partSetups/38644116/translations/38818015" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/partSetups/38644116" } ] }, { "description": "Die Premium-Wartung umfasst Mehrpunktinspektionen sowie die vorbeugende Pflege und den Austausch normaler Verschleißteile, die regelm&amul;ßig gewartet werden müssen.", "dateModified": "2023-03-02T21:31:55.000Z", "language": { "languageNumber": 0, "languageCode": "de", "id": 36329903, "links": [{ "rel": "domain", "href": "https://sitename.oracle.com/rest/v17/languages" }, { "rel": "canonical", "href": "https://sitename.oracle.com/rest/v17/languages/36329903" } ] }, "id": 38818016, "units": null, "dateAdded": "2023-03-02T21:31:55.000Z", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/partSetups/38644116/translations/38818016" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/partSetups/38644116" } ] } ] }

Get a Part Translation

Get a Part Translation
Description	Use this endpoint to retrieve the specified translation for a CPQ part.
URI Endpoint	/rest/v17/partSetups/{id}/translations/{translationId}
Endpoint Parameters	id	The unique identifier for the part.
Endpoint Parameters	translationId	The unique key identifying the part translation.
HTTP Method	GET
Request Body Parameters	None
Response Body Parameters	dateAdded	System field indicating the date on which the resource was created.
	dateModified	System field indicating the date on which the resource was last modified.
	description	The part description translation.
	id	The unique key identifying the part translation.
	language	The defined language of the rows translated columns.
	units	Translated units of the part

URI Endpoint Sample

https://sitename.oracle.com/rest/v17/partSetups/38644116/translations/38818015

Response Body Sample

{ "description": "L'entretien Premium couvre les inspections multipoints, ainsi que les soins préventifs et le remplacement des éléments normaux d'usure normale qui nécessitent une attention périodique.", "dateModified": "2023-03-02T21:31:55.000Z", "language": { "languageNumber": 1, "languageCode": "fr", "id": 36329904, "links": [{ "rel": "domain", "href": "https://sitename.oracle.com/rest/v17/languages" }, { "rel": "canonical", "href": "https://sitename.oracle.com/rest/v17/languages/36329904" } ] }, "id": 38818015, "units": null, "dateAdded": "2023-03-02T21:31:55.000Z", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/partSetups/38644116/translations/38818015" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/partSetups/38644116" } ] }

Create a Part Translation

Create a Part Translation
Description	Use this endpoint to create translations for the specified CPQ part.
URI Endpoint	/rest/v17/partSetups/{id}/translations
Endpoint Parameters	id	The unique identifier for the part.
HTTP Method	POST
Request Body Parameters	description	The part description translation.
	language	The defined language of the translated parts.
	units	Units of the translated part.
Response Body Parameters	dateAdded	System field indicating the date on which the resource was created.
	dateModified	System field indicating the date on which the resource was last modified.
	description	The part description translation.
	id	The unique key identifying the part translation.
	language	The defined language of the rows translated columns.
	units	Translated units of the part

URI Endpoint Sample

https://sitename.oracle.com/rest/v17/partSetups/38644116/translations

Request Body Sample

Response Body Sample

{ "description": "L'entretien Premium couvre les inspections multipoints, ainsi que les soins préventifs et le remplacement des éléments normaux d'usure normale qui nécessitent une attention périodique.", "dateModified": "2023-03-07T18:45:34.402Z", "language": { "languageNumber": 1, "languageCode": "fr", "id": 36329904, "links": [{ "rel": "domain", "href": "https://sitename.oracle.com/rest/v17/languages" }, { "rel": "canonical", "href": "https://sitename.oracle.com/rest/v17/languages/36329904" } ] }, "id": 38852322, "units": null, "dateAdded": "2023-03-07T18:45:34.402Z", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/partSetups/38644116/translations/38852322" } ] }

Delete a Part Translation

Delete a Part Translation
Description	Use this endpoint to delete the specified translation for a CPQ part.
URI Endpoint	/rest/v17/partSetups/{id}}/translations/{translationId}
Endpoint Parameters	id	The unique identifier for the part.
Endpoint Parameters	translationId	The unique key identifying the part translation.
HTTP Method	DELETE
Request Body Parameters	None
Response Body Status	204 No Content

URI Endpoint Sample

https://sitename.oracle.com/rest/v17/partSetups/38644116/translations/38818015

Get All Part Extended Description Translations

Get All Part Extended Description Translations
Description	Use this endpoint to retrieve translations for CPQ part extended descriptions.
URI Endpoint	/rest/v17/partSetups/{id}/extendedDescriptions/{descriptionsId}/translations
Endpoint Parameters	id	The unique identifier for the part.
	descriptionsId	The extended descriptions Id.
	(Optional) This endpoint supports the following query specifications: `expand`, `fields`, `limit`, `offset`, `orderby`, `q`, and `totalResults`. For more information, see Manage Collections.
HTTP Method	GET
Request Body Parameters	None
Response Body Parameters	A collection of translations for extended descriptions for a part.

URI Endpoint Sample

https://sitename.oracle.com/rest/v17/partSetups/38644116/extendedDescriptions/38653270/translations

Response Body Sample

{ "hasMore": false, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/partSetups/38644116/extendedDescriptions/38653270/translations" } ], "items": [{ "partExtendedDescription1": "<h2>La couverture comprend</h2>\r\nL'entretien Premium de Ford Protect couvre les inspections de routine, les soins préventifs et le remplacement des éléments « d'usure » normaux qui nécessitent une attention périodique. Votre plan réel sera basé sur les besoins d'entretien de votre véhicule, comme indiqué dans le Guide d'entretien périodique du propriétaire :<br />\r\n<ul>\r\n<li>Vidanges de l'huile moteur et du filtre</li>\r\n<li>Inspections multipoints</li>\r\n<li>Permutation des pneus</li>\r\n<li>Plaquettes et garnitures de frein</li>\r\n<li>Amortisseurs/entretoises</li>\r\n<li>Bougies d'allumage</li>\r\n<li>Disques d'embrayage</li>\r\n<li>Courroies moteur</li>\r\n<li>Tuyaux de liquide de refroidissement moteur, colliers et joints toriques</li>\r\n<li>Balais d'essuie-glace</li>\r\n<li>Remplissage du liquide d'échappement diesel au moment où l'entretien programmé est effectué chez le concessionnaire</li>\r\n</ul>", "dateModified": "2023-03-02T21:31:55.000Z", "language": { "languageNumber": 1, "languageCode": "fr", "id": 36329904, "links": [{ "rel": "domain", "href": "https://sitename.oracle.com/rest/v17/languages" }, { "rel": "canonical", "href": "https://sitename.oracle.com/rest/v17/languages/36329904" } ] }, "id": 38818017, "partExtendedDescription2": "<h2>Inspection multipoint</h2> <p>À chaque intervalle d'entretien, votre véhicule subit une inspection multipoint complète, comme indiqué dans le guide d'entretien périodique du propriétaire :</p> <h3>Vérifiez les systèmes/composants suivants : </h3> <ul> <li>Fonctionnement du klaxon, des lumières intérieures, des feux extérieurs, des clignotants et des feux de détresse et de freinage</li> <li>Spray de lave-glace, fonctionnement des essuie-glaces et balais d'essuie-glace</li> <li >Pare-brise pour les fissures, les éclats et les piqûres</li> <li>Radiateur, chauffage et conduites de climatisation pour les fuites et les dommages</li> <li>Filtre à air du moteur</li> <li>Fuites d'huile et de liquide</li ><li>Système d'échappement (fuites, dommages, pièces détachées)</li><li>Direction et tringleries de direction</li><li>Chocs/entretoises et autres composants de suspension pour fuites et/ou dommages</li>< li>Courroie(s) d'entraînement des accessoires</li><li>Fonctionnement de l'embrayage (le cas échéant)</li><li>Pneus pour l'usure et la pression d'air appropriée</li></ul><h3>Vérifiez les niveaux de liquide et Remplir :</h3><ul><li>Transmission (si équipé d'une jauge)</li><li>Réservoir de frein</li><li>Direction assistée g</li><li>Réservoir de récupération du liquide de refroidissement</li><li>Lave-glace</li><li>Liquide d'échappement diesel (si nécessaire)</li></ul>", "dateAdded": "2023-03-02T21:31:55.000Z", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/partSetups/38644116/extendedDescriptions/38653270/translations/38818017" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/partSetups/38644116/extendedDescriptions/38653270" } ] }, { "partExtendedDescription1": "<h2>Deckung beinhaltet</h2>\r\nDie Premium-Wartung von Ford Protect umfasst Routineinspektionen, vorbeugende Pflege und den Austausch normaler Verschleißteile, die regelm&amul;ßig gewartet werden müssen. Ihr tats&amul;chlicher Plan basiert auf den Wartungsanforderungen Ihres Fahrzeugs, wie in Ihrem Handbuch zur planm&amul;ßigen Wartung Ihres Besitzers angegeben:<br />\r\n<ul>\r\n<li>Motoröl- und Filterwechsel</li>\r\n<li>Mehrpunktinspektionen</li>\r\n<li>Reifenwechsel</li>\r\n<li>Bremsbel&amul;ge und Bel&amul;ge</li>\r\n<li>Stoßd&amul;mpfer/Federbeine</li>\r\n<li>Zündkerzen</li>\r\n<li>Kupplungsscheiben</li>\r\n<li>Motorriemen</li>\r\n<li>Motorkühlmittelschl&amul;uche, Schellen und O-Ring-Dichtungen</li>\r\n<li>Wischerbl&amul;tter</li>\r\n<li>Dieselabgasflüssigkeit zum Zeitpunkt der planm&amul;ßigen Wartung beim H&amul;ndler einfüllen</li>\r\n</ul>", "dateModified": "2023-03-02T21:31:55.000Z", "language": { "languageNumber": 0, "languageCode": "de", "id": 36329903, "links": [{ "rel": "domain", "href": "https://sitename.oracle.com/rest/v17/languages" }, { "rel": "canonical", "href": "https://sitename.oracle.com/rest/v17/languages/36329903" } ] }, "id": 38818018, "partExtendedDescription2": "<h2>Mehrpunkt-Inspektion</h2><p>Bei jedem Wartungsintervall wird Ihr Fahrzeug einer umfassenden Mehrpunkt-Inspektion unterzogen, wie in Ihrem Handbuch zur planm&amul;ßigen Wartung Ihres Besitzers angegeben:</p><h3>Überprüfen Sie folgende Systeme/Komponenten: </h3><ul><li>Bedienung von Hupe, Innenleuchten, Außenleuchten, Blinkern sowie Warn- und Bremsleuchten</li><li>Scheibenwaschspray, Wischerbetrieb und Wischerbl&amul;tter</li><li >Windschutzscheibe auf Risse, Absplitterungen und Lochfraß</li><li>Kühler-, Heizungs- und Klimaanlagenleitungen auf Lecks und Besch&amul;digungen</li><li>Motorluftfilter</li><li>Öl- und Flüssigkeitslecks</li ><li>Auspuffanlage (Lecks, Sch&amul;den, lose Teile)</li><li>Lenkung und Lenkgest&amul;nge</li><li>Stoßd&amul;mpfer/Federbeine und andere Aufh&amul;ngungskomponenten auf Undichtigkeiten und/oder Sch&amul;den</li>< li>Zusatzantriebsriemen</li><li>Kupplungsbet&amul;tigung (falls vorhanden)</li><li>Reifen auf Verschleiß und korrekten Luftdruck</li></ul><h3>Flüssigkeitsst&amul;nde prüfen und Füllen:</h3><ul><li>Getriebe (falls mit Ölmessstab ausgestattet)</li><li>Bremsflüssigkeitsbeh&amul;lter</li><li>Servolenkung g</li><li>Kühlmittelrückgewinnungsbeh&amul;lter</li><li>Scheibenwaschanlage</li><li>Dieselabgasflüssigkeit (falls erforderlich)</li></ul>", "dateAdded": "2023-03-02T21:31:55.000Z", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/partSetups/38644116/extendedDescriptions/38653270/translations/38818018" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/partSetups/38644116/extendedDescriptions/38653270" } ] } ] }

Get a Part Extended Description Translation

Get a Part Extended Description Translation
Description	Use this endpoint to retrieve the specified translation for CPQ part extended descriptions.
URI Endpoint	/rest/v17/partSetups/{id}/extendedDescriptions/{descriptionsId}/translations/{translationId}
Endpoint Parameters	id	The unique identifier for the part.
	descriptionsId	The extended descriptions Id.
	translationId	The unique key identifying the part translation.
HTTP Method	GET
Request Body Parameters	None
Response Body Parameters	dateAdded	System field indicating the date on which the resource was created.
	dateModified	System field indicating the date on which the resource was last modified.
	id	The unique identifier for the part extended descriptions.
	language	The defined language of the translated extended descriptions.
	partExtendedDescription1	Part extended description 1 translation.
	partExtendedDescription2	Part extended description 2 translation.

URI Endpoint Sample

https://sitename.oracle.com/rest/v17/partSetups/38644116/extendedDescriptions/38653270/translations/38818017"

Response Body Sample

{ "partExtendedDescription1": "<h2>La couverture comprend</h2>\r\nL'entretien Premium de Ford Protect couvre les inspections de routine, les soins préventifs et le remplacement des éléments « d'usure » normaux qui nécessitent une attention périodique. Votre plan réel sera basé sur les besoins d'entretien de votre véhicule, comme indiqué dans le Guide d'entretien périodique du propriétaire :<br />\r\n<ul>\r\n<li>Vidanges de l'huile moteur et du filtre</li>\r\n<li>Inspections multipoints</li>\r\n<li>Permutation des pneus</li>\r\n<li>Plaquettes et garnitures de frein</li>\r\n<li>Amortisseurs/entretoises</li>\r\n<li>Bougies d'allumage</li>\r\n<li>Disques d'embrayage</li>\r\n<li>Courroies moteur</li>\r\n<li>Tuyaux de liquide de refroidissement moteur, colliers et joints toriques</li>\r\n<li>Balais d'essuie-glace</li>\r\n<li>Remplissage du liquide d'échappement diesel au moment où l'entretien programmé est effectué chez le concessionnaire</li>\r\n</ul>", "dateModified": "2023-03-02T21:31:55.000Z", "language": { "languageNumber": 1, "languageCode": "fr", "id": 36329904, "links": [{ "rel": "domain", "href": "https://sitename.oracle.com/rest/v17/languages" }, { "rel": "canonical", "href": "https://sitename.oracle.com/rest/v17/languages/36329904" } ] }, "id": 38818017, "partExtendedDescription2": "<h2>Inspection multipoint</h2> <p>À chaque intervalle d'entretien, votre véhicule subit une inspection multipoint complète, comme indiqué dans le guide d'entretien périodique du propriétaire :</p> <h3>Vérifiez les systèmes/composants suivants : </h3> <ul> <li>Fonctionnement du klaxon, des lumières intérieures, des feux extérieurs, des clignotants et des feux de détresse et de freinage</li> <li>Spray de lave-glace, fonctionnement des essuie-glaces et balais d'essuie-glace</li> <li >Pare-brise pour les fissures, les éclats et les piqûres</li> <li>Radiateur, chauffage et conduites de climatisation pour les fuites et les dommages</li> <li>Filtre à air du moteur</li> <li>Fuites d'huile et de liquide</li ><li>Système d'échappement (fuites, dommages, pièces détachées)</li><li>Direction et tringleries de direction</li><li>Chocs/entretoises et autres composants de suspension pour fuites et/ou dommages</li>< li>Courroie(s) d'entraînement des accessoires</li><li>Fonctionnement de l'embrayage (le cas échéant)</li><li>Pneus pour l'usure et la pression d'air appropriée</li></ul><h3>Vérifiez les niveaux de liquide et Remplir :</h3><ul><li>Transmission (si équipé d'une jauge)</li><li>Réservoir de frein</li><li>Direction assistée g</li><li>Réservoir de récupération du liquide de refroidissement</li><li>Lave-glace</li><li>Liquide d'échappement diesel (si nécessaire)</li></ul>", "dateAdded": "2023-03-02T21:31:55.000Z", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/partSetups/38644116/extendedDescriptions/38653270/translations/38818017" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/partSetups/38644116/extendedDescriptions/38653270" } ] }

Create Part Extended Description Translations

Create Part Extended Description Translations
Description	Use this endpoint to create translations for CPQ part extended descriptions.
URI Endpoint	/rest/v17/partSetups/{id}/extendedDescriptions{descriptionsId}/translations
Endpoint Parameters	id	The unique identifier for the part.
Endpoint Parameters	descriptionsId	The extended descriptions Id.
HTTP Method	POST
Request Body Parameters	partExtendedDescription1	Part extended description 1 translation.
	partExtendedDescription2	Part extended description 2 translation.
	language	The defined language of the translated parts.
Response Body Parameters	dateAdded	System field indicating the date on which the resource was created.
	dateModified	System field indicating the date on which the resource was last modified.
	id	The unique identifier for the part extended descriptions.
	language	The defined language of the translated extended descriptions.
	partExtendedDescription1	Part extended description 1 translation.
	partExtendedDescription2	Part extended description 2 translation.

URI Endpoint Sample

https://sitename.oracle.com/rest/v17/partSetups/38644116/extendedDescriptions/38653270/translations

Request Body Sample

{ "partExtendedDescription1": "Ejemplo de contenido para la descripción ampliada de la pieza 1", "language": { "languageNumber": 2, "languageCode": "es" }, "partExtendedDescription2": "Ejemplo de contenido para la descripción ampliada de la pieza 2" }

Response Body Sample

{ "partExtendedDescription1": "Ejemplo de contenido para la descripción ampliada de la pieza 1", "dateModified": "2023-03-07T19:16:31.502Z", "language": { "languageNumber": 2, "languageCode": "es", "id": 36329905, "links": [{ "rel": "domain", "href": "https://sitename.oracle.com/rest/v17/languages" }, { "rel": "canonical", "href": "https://sitename.oracle.com/rest/v17/languages/36329905" } ] }, "id": 38852337, "partExtendedDescription2": "Ejemplo de contenido para la descripción ampliada de la pieza 2", "dateAdded": "2023-03-07T19:16:31.502Z", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/partSetups/38644116/extendedDescriptions/38653270/translations/38852337" } ] }

Delete a Part Extended Description Translation

Delete a Part Extended Description Translation
Description	Use this endpoint to delete the specified translation for CPQ part extended descriptions.
URI Endpoint	/rest/v17/partSetups/{id}}/extendedDescriptions/{descriptionsId}/translations/{translationId}
Endpoint Parameters	id	The unique identifier for the part.
	descriptionsId	The extended descriptions Id.
	translationId	The unique key identifying the part translation.
HTTP Method	DELETE
Request Body Parameters	None
Response Body Status	204 No Content

URI Endpoint Sample

https://sitename.oracle.com/rest/v17/partSetups//38644116/extendedDescriptions/38653270/translations/38852337

Notes

For more information on the Interface Catalogs, see the topic Interface Catalog.

Parts Administration REST APIs

Overview

Administration

Update/Insert Parts

Get Part Metadata Action

Part Extended Descriptions

Part Prices

Get All Prices for a Part

Part Translations

Notes

Related Topics