Jump to

• Request
• Response
• Examples

Get a Part

get

/rest/v16/partSetups/{id}

Use this endpoint to retrieve the specified CPQ part.

Request

Supported Media Types

• application/json

Path Parameters

• id(required): integer
  The unique identifier for the part.

Query Parameters

• expand: string
  Allows expansion of relationships.

Back to Top

Response

Supported Media Types

• application/json

Default Response

Body ()

Root Schema : Part Setup Instance Definitions

Type: object

Title: Part Setup Instance Definitions

Show Source

• _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 Added

  System field indicating the date on which the Resource was created.
• dateModified: string
  Title: Date Modified

  System field indicating the date on which the Resource was last modified.
• defaultUOMCode: string
  Title: Default UOM Code

  Default Unit of Measure.
• description: string
  Title: Description

  Description of the part.
• directBuy: object Direct Buy
  Title: Direct Buy

  Determines how the part must be purchased.
• eligibleForService: string
  Title: Eligible for Service

  Enable this option when integrating with a service request application.
• eligibleToSell: string
  Title: Eligible to Sell

  Check this if the part should be visible to a sales person (If the part is sellable or not).
• enableSelfService: string
  Title: Enable Customer Self-Service

  When integrating with any customer self service application- enable this option to identify parts as self-service eligible.
• externalKey1: string
  Title: External Key 1

  References for parts coming in from external third party system.
• externalKey2: string
  Title: External Key 2

  References for parts coming in from external third party system.
• id: integer
  Title: Id

  The unique identifier for the part.
• leadTime: integer
  Title: Lead Time

  Time taken in days for the part to be shipped.
• numberOfPricePeriods: integer
  Title: Number of Price Periods

  Default number of price periods for a part.
• partDisplayNumber: string
  Title: Part Display Number

  Part Number for display purpose.
• partnerOrganizationId: string
  Title: Partner Organization Id

  The integrated partner organization id.
• partnerPartId: string
  Title: Partner Part Id

  The integrated partner part id.
• partnerStandardPriceBookEntryId: string
  Title: Partner Standard Pricebook Entry Id

  The integrated partner id for the standard pricebook.
• partNumber: string
  Title: Part Number

  Part Number used to identify a part.
• partNumberLower: string
  Title: Part Number Lower

  Used to store part number in lower case.
• pricePeriod: string
  Title: Price Period

  Default price period for the part.
• priceType: string
  Title: Price Type

  Default price type applicable to the part- e.g. One-Time, Recurring or Usage-based.
• salesProductType: string
  Title: Sales Product Type

  Categorize the product by selecting a product type.
• units: string
  Title: Units

  Units for the part.

{
    "type":"object",
    "properties":{
        "_part_custom_field1":{
            "type":"string",
            "description":"",
            "title":"Product Group"
        },
        "_part_custom_field10":{
            "type":"object",
            "description":"",
            "title":"Product type",
            "properties":{
                "lookupCode":{
                    "type":"string",
                    "description":"Language independent code of the fixed list of value.",
                    "title":"Lookup Code"
                },
                "id":{
                    "type":"integer",
                    "description":"Primary Key of the fixed list of value resource.",
                    "title":"Id"
                },
                "displayValue":{
                    "type":"string",
                    "description":"Translated display name of the type for which fixed list of values can be defined.",
                    "title":"Display Value"
                }
            }
        },
        "_part_custom_field2":{
            "type":"object",
            "description":"",
            "title":"Part Availability",
            "properties":{
                "lookupCode":{
                    "type":"string",
                    "description":"Language independent code of the fixed list of value.",
                    "title":"Lookup Code"
                },
                "id":{
                    "type":"integer",
                    "description":"Primary Key of the fixed list of value resource.",
                    "title":"Id"
                },
                "displayValue":{
                    "type":"string",
                    "description":"Translated display name of the type for which fixed list of values can be defined.",
                    "title":"Display Value"
                }
            }
        },
        "_part_custom_field3":{
            "type":"string",
            "description":"",
            "title":"Max discount %"
        },
        "_part_custom_field4":{
            "type":"object",
            "description":"",
            "title":"Price Period",
            "properties":{
                "lookupCode":{
                    "type":"string",
                    "description":"Language independent code of the fixed list of value.",
                    "title":"Lookup Code"
                },
                "id":{
                    "type":"integer",
                    "description":"Primary Key of the fixed list of value resource.",
                    "title":"Id"
                },
                "displayValue":{
                    "type":"string",
                    "description":"Translated display name of the type for which fixed list of values can be defined.",
                    "title":"Display Value"
                }
            }
        },
        "_part_custom_field5":{
            "type":"number",
            "description":"",
            "title":"Cost"
        },
        "_part_custom_field8":{
            "type":"object",
            "description":"",
            "title":"Price Type",
            "properties":{
                "lookupCode":{
                    "type":"string",
                    "description":"Language independent code of the fixed list of value.",
                    "title":"Lookup Code"
                },
                "id":{
                    "type":"integer",
                    "description":"Primary Key of the fixed list of value resource.",
                    "title":"Id"
                },
                "displayValue":{
                    "type":"string",
                    "description":"Translated display name of the type for which fixed list of values can be defined.",
                    "title":"Display Value"
                }
            }
        },
        "_part_custom_field9":{
            "type":"string",
            "description":"",
            "title":"product"
        },
        "dateAdded":{
            "type":"string",
            "description":"System field indicating the date on which the Resource was created.",
            "title":"Date Added"
        },
        "dateModified":{
            "type":"string",
            "description":"System field indicating the date on which the Resource was last modified.",
            "title":"Date Modified"
        },
        "defaultUOMCode":{
            "type":"string",
            "description":"Default Unit of Measure.",
            "title":"Default UOM Code"
        },
        "description":{
            "type":"string",
            "description":"Description of the part.",
            "title":"Description"
        },
        "directBuy":{
            "type":"object",
            "description":"Determines how the part must be purchased.",
            "title":"Direct Buy",
            "properties":{
                "lookupCode":{
                    "type":"string",
                    "description":"Language independent code of the fixed list of value.",
                    "title":"Lookup Code"
                },
                "id":{
                    "type":"integer",
                    "description":"Primary Key of the fixed list of value resource.",
                    "title":"Id"
                },
                "displayValue":{
                    "type":"string",
                    "description":"Translated display name of the type for which fixed list of values can be defined.",
                    "title":"Display Value"
                }
            }
        },
        "eligibleForService":{
            "type":"string",
            "description":"Enable this option when integrating with a service request application.",
            "title":"Eligible for Service"
        },
        "eligibleToSell":{
            "type":"string",
            "description":"Check this if the part should be visible to a sales person (If the part is sellable or not).",
            "title":"Eligible to Sell"
        },
        "enableSelfService":{
            "type":"string",
            "description":"When integrating with any customer self service application- enable this option to identify parts as self-service eligible.",
            "title":"Enable Customer Self-Service"
        },
        "externalKey1":{
            "type":"string",
            "description":"References for parts coming in from external third party system.",
            "title":"External Key 1"
        },
        "externalKey2":{
            "type":"string",
            "description":"References for parts coming in from external third party system.",
            "title":"External Key 2"
        },
        "id":{
            "type":"integer",
            "description":"The unique identifier for the part.",
            "title":"Id"
        },
        "leadTime":{
            "type":"integer",
            "description":"Time taken in days for the part to be shipped.",
            "title":"Lead Time"
        },
        "numberOfPricePeriods":{
            "type":"integer",
            "description":"Default number of price periods for a part.",
            "title":"Number of Price Periods"
        },
        "partDisplayNumber":{
            "type":"string",
            "description":"Part Number for display purpose.",
            "title":"Part Display Number"
        },
        "partNumber":{
            "type":"string",
            "description":"Part Number used to identify a part.",
            "title":"Part Number"
        },
        "partNumberLower":{
            "type":"string",
            "description":"Used to store part number in lower case.",
            "title":"Part Number Lower"
        },
        "partnerOrganizationId":{
            "type":"string",
            "description":"The integrated partner organization id.",
            "title":"Partner Organization Id"
        },
        "partnerPartId":{
            "type":"string",
            "description":"The integrated partner part id.",
            "title":"Partner Part Id"
        },
        "partnerStandardPriceBookEntryId":{
            "type":"string",
            "description":"The integrated partner id for the standard pricebook.",
            "title":"Partner Standard Pricebook Entry Id"
        },
        "pricePeriod":{
            "type":"string",
            "description":"Default price period for the part.",
            "title":"Price Period"
        },
        "priceType":{
            "type":"string",
            "description":"Default price type applicable to the part- e.g. One-Time, Recurring or Usage-based.",
            "title":"Price Type"
        },
        "salesProductType":{
            "type":"string",
            "description":"Categorize the product by selecting a product type.",
            "title":"Sales Product Type"
        },
        "units":{
            "type":"string",
            "description":"Units for the part.",
            "title":"Units"
        }
    },
    "title":"Part Setup Instance Definitions"
}

Nested Schema : Product type

Type: object

Title: Product type

Show Source

• displayValue: string
  Title: Display Value

  Translated display name of the type for which fixed list of values can be defined.
• id: integer
  Title: Id

  Primary Key of the fixed list of value resource.
• lookupCode: string
  Title: Lookup Code

  Language independent code of the fixed list of value.

{
    "type":"object",
    "description":"",
    "title":"Product type",
    "properties":{
        "lookupCode":{
            "type":"string",
            "description":"Language independent code of the fixed list of value.",
            "title":"Lookup Code"
        },
        "id":{
            "type":"integer",
            "description":"Primary Key of the fixed list of value resource.",
            "title":"Id"
        },
        "displayValue":{
            "type":"string",
            "description":"Translated display name of the type for which fixed list of values can be defined.",
            "title":"Display Value"
        }
    }
}

Nested Schema : Part Availability

Type: object

Title: Part Availability

Show Source

• displayValue: string
  Title: Display Value

  Translated display name of the type for which fixed list of values can be defined.
• id: integer
  Title: Id

  Primary Key of the fixed list of value resource.
• lookupCode: string
  Title: Lookup Code

  Language independent code of the fixed list of value.

{
    "type":"object",
    "description":"",
    "title":"Part Availability",
    "properties":{
        "lookupCode":{
            "type":"string",
            "description":"Language independent code of the fixed list of value.",
            "title":"Lookup Code"
        },
        "id":{
            "type":"integer",
            "description":"Primary Key of the fixed list of value resource.",
            "title":"Id"
        },
        "displayValue":{
            "type":"string",
            "description":"Translated display name of the type for which fixed list of values can be defined.",
            "title":"Display Value"
        }
    }
}

Nested Schema : Price Period

Type: object

Title: Price Period

Show Source

• displayValue: string
  Title: Display Value

  Translated display name of the type for which fixed list of values can be defined.
• id: integer
  Title: Id

  Primary Key of the fixed list of value resource.
• lookupCode: string
  Title: Lookup Code

  Language independent code of the fixed list of value.

{
    "type":"object",
    "description":"",
    "title":"Price Period",
    "properties":{
        "lookupCode":{
            "type":"string",
            "description":"Language independent code of the fixed list of value.",
            "title":"Lookup Code"
        },
        "id":{
            "type":"integer",
            "description":"Primary Key of the fixed list of value resource.",
            "title":"Id"
        },
        "displayValue":{
            "type":"string",
            "description":"Translated display name of the type for which fixed list of values can be defined.",
            "title":"Display Value"
        }
    }
}

Nested Schema : Price Type

Type: object

Title: Price Type

Show Source

• displayValue: string
  Title: Display Value

  Translated display name of the type for which fixed list of values can be defined.
• id: integer
  Title: Id

  Primary Key of the fixed list of value resource.
• lookupCode: string
  Title: Lookup Code

  Language independent code of the fixed list of value.

{
    "type":"object",
    "description":"",
    "title":"Price Type",
    "properties":{
        "lookupCode":{
            "type":"string",
            "description":"Language independent code of the fixed list of value.",
            "title":"Lookup Code"
        },
        "id":{
            "type":"integer",
            "description":"Primary Key of the fixed list of value resource.",
            "title":"Id"
        },
        "displayValue":{
            "type":"string",
            "description":"Translated display name of the type for which fixed list of values can be defined.",
            "title":"Display Value"
        }
    }
}

Nested Schema : Direct Buy

Type: object

Title: Direct Buy

Determines how the part must be purchased.

Show Source

• displayValue: string
  Title: Display Value

  Translated display name of the type for which fixed list of values can be defined.
• id: integer
  Title: Id

  Primary Key of the fixed list of value resource.
• lookupCode: string
  Title: Lookup Code

  Language independent code of the fixed list of value.

{
    "type":"object",
    "description":"Determines how the part must be purchased.",
    "title":"Direct Buy",
    "properties":{
        "lookupCode":{
            "type":"string",
            "description":"Language independent code of the fixed list of value.",
            "title":"Lookup Code"
        },
        "id":{
            "type":"integer",
            "description":"Primary Key of the fixed list of value resource.",
            "title":"Id"
        },
        "displayValue":{
            "type":"string",
            "description":"Translated display name of the type for which fixed list of values can be defined.",
            "title":"Display Value"
        }
    }
}

Back to Top

Examples

The following example shows how to retrieve the specified CPQ part by submitting a GET request to the REST resource using cURL. For more information about cURL, see Use cURL.

curl - X GET - i - H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQg" - H "Content-type: application/json"
https://sitename.oracle.com/rest/v16/partSetups/38644116

Response Body

{
  "eligibleForService": "N",
  "partnerPartId": null,
  "directBuy": {
    "lookupCode": "1",
    "displayValue": "Direct Buy",
    "id": 36549639,
    "links": [{
        "rel": "domain",
        "href": "https://sitename.oracle.com/rest/v16/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/v16/lookupValues/36549639"
      }
    ]
  },
  "defaultUOMCode": null,
  "description": "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,
  "units": null,
  "_part_custom_field10": {
    "lookupCode": "External",
    "displayValue": "External",
    "id": 38272229,
    "links": [{
        "rel": "domain",
        "href": "https://sitename.oracle.com/rest/v16/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/v16/lookupValues/38272229"
      }
    ]
  },
  "eligibleToSell": "N",
  "dateAdded": "2021-09-17T11:45:34.000Z",
  "partnerStandardPriceBookEntryId": null,
  "_part_custom_field9": "subscription",
  "id": 38644116,
  "_part_custom_field3": null,
  "_part_custom_field4": {
    "lookupCode": "Per Month",
    "displayValue": "Per Month",
    "id": 36657628,
    "links": [{
        "rel": "domain",
        "href": "https://sitename.oracle.com/rest/v16/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/v16/lookupValues/36657628"
      }
    ]
  },
  "_part_custom_field1": "Service",
  "_part_custom_field2": {
    "lookupCode": "Available",
    "displayValue": "Available",
    "id": 38547619,
    "links": [{
        "rel": "domain",
        "href": "https://sitename.oracle.com/rest/v16/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/v16/lookupValues/38547619"
      }
    ]
  },
  "_part_custom_field8": {
    "lookupCode": "Recurring",
    "displayValue": "Recurring",
    "id": 36657634,
    "links": [{
        "rel": "domain",
        "href": "https://sitename.oracle.com/rest/v16/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/v16/lookupValues/36657634"
      }
    ]
  },
  "_part_custom_field5": 0.0,
  "salesProductType": null,
  "priceType": null,
  "numberOfPricePeriods": 0,
  "dateModified": "2023-03-02T20:47:12.000Z",
  "partnerOrganizationId": null,
  "partDisplayNumber": "MTN2",
  "pricePeriod": null,
  "partNumberLower": "premium maintenance plan",
  "partNumber": "Premium Maintenance Plan",
  "externalKey1": null,
  "externalKey2": null,
  "links": [{
      "rel": "self",
      "href": "https://sitename.oracle.com/rest/v16/partSetups/38644116"
    }, {
      "kind": "",
      "rel": "child",
      "name": "extendedDescriptions",
      "href": "https://sitename.oracle.com/rest/v16/partSetups/38644116/extendedDescriptions"
    }, {
      "kind": "",
      "rel": "child",
      "name": "prices",
      "href": "https://sitename.oracle.com/rest/v16/partSetups/38644116/prices"
    }, {
      "kind": "",
      "rel": "child",
      "name": "translations",
      "href": "https://sitename.oracle.com/rest/v16/partSetups/38644116/translations"
    }
  ]
}

Back to Top