Create a Part

post

/rest/v16/partSetups

Use this endpoint to create a new CPQ part.

Request

Supported Media Types
Body ()
Root Schema : Part Setup Create Request Definitions
Type: object
Title: Part Setup Create Request Definitions
Show Source
Nested Schema : Product type
Type: object
Title: Product type
Show Source
  • Title: Display Value
    Translated display name of the type for which fixed list of values can be defined.
  • Title: Id
    Primary Key of the fixed list of value resource.
  • Title: Lookup Code
    Language independent code of the fixed list of value.
Nested Schema : Part Availability
Type: object
Title: Part Availability
Show Source
  • Title: Display Value
    Translated display name of the type for which fixed list of values can be defined.
  • Title: Id
    Primary Key of the fixed list of value resource.
  • Title: Lookup Code
    Language independent code of the fixed list of value.
Nested Schema : Price Period
Type: object
Title: Price Period
Show Source
  • Title: Display Value
    Translated display name of the type for which fixed list of values can be defined.
  • Title: Id
    Primary Key of the fixed list of value resource.
  • Title: Lookup Code
    Language independent code of the fixed list of value.
Nested Schema : Price Type
Type: object
Title: Price Type
Show Source
  • Title: Display Value
    Translated display name of the type for which fixed list of values can be defined.
  • Title: Id
    Primary Key of the fixed list of value resource.
  • Title: Lookup Code
    Language independent code of the fixed list of value.
Nested Schema : Direct Buy
Type: object
Title: Direct Buy
Determines how the part must be purchased.
Show Source
  • Title: Display Value
    Translated display name of the type for which fixed list of values can be defined.
  • Title: Id
    Primary Key of the fixed list of value resource.
  • Title: Lookup Code
    Language independent code of the fixed list of value.
Nested Schema : Part Extended Descriptions
Type: object
Title: Part Extended Descriptions
Show Source
Nested Schema : Part Prices
Type: object
Title: Part Prices
Show Source
Nested Schema : Part Translations
Type: object
Title: Part Translations
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : Part Extended Descriptions
Type: object
Title: Part Extended Descriptions
Show Source
Nested Schema : Part Extended Description Translations
Type: object
Title: Part Extended Description Translations
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : Part Extended Description Translations
Type: object
Title: Part Extended Description Translations
Show Source
Nested Schema : Language
Type: object
Title: Language
The defined language of the rows translated columns.
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : Part Prices Setup Create Request Definitions
Type: object
Title: Part Prices Setup Create Request Definitions
Show Source
Nested Schema : Price
Type: object
Title: Price
Price of the part.
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : Part Translation Setup Create Request Definitions
Type: object
Title: Part Translation Setup Create Request Definitions
Show Source
Nested Schema : Language
Type: object
Title: Language
The defined language of the rows translated columns.
Show Source
Back to Top

Response

Supported Media Types

Default Response

Body ()
Root Schema : Part Setup Instance Definitions
Type: object
Title: Part Setup Instance Definitions
Show Source
Nested Schema : Product type
Type: object
Title: Product type
Show Source
  • Title: Display Value
    Translated display name of the type for which fixed list of values can be defined.
  • Title: Id
    Primary Key of the fixed list of value resource.
  • Title: Lookup Code
    Language independent code of the fixed list of value.
Nested Schema : Part Availability
Type: object
Title: Part Availability
Show Source
  • Title: Display Value
    Translated display name of the type for which fixed list of values can be defined.
  • Title: Id
    Primary Key of the fixed list of value resource.
  • Title: Lookup Code
    Language independent code of the fixed list of value.
Nested Schema : Price Period
Type: object
Title: Price Period
Show Source
  • Title: Display Value
    Translated display name of the type for which fixed list of values can be defined.
  • Title: Id
    Primary Key of the fixed list of value resource.
  • Title: Lookup Code
    Language independent code of the fixed list of value.
Nested Schema : Price Type
Type: object
Title: Price Type
Show Source
  • Title: Display Value
    Translated display name of the type for which fixed list of values can be defined.
  • Title: Id
    Primary Key of the fixed list of value resource.
  • Title: Lookup Code
    Language independent code of the fixed list of value.
Nested Schema : Direct Buy
Type: object
Title: Direct Buy
Determines how the part must be purchased.
Show Source
  • Title: Display Value
    Translated display name of the type for which fixed list of values can be defined.
  • Title: Id
    Primary Key of the fixed list of value resource.
  • Title: Lookup Code
    Language independent code of the fixed list of value.
Back to Top

Examples

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

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

Create a Part

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
}

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": "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/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": "2023-03-06T21:50:29.000Z",
  "partnerStandardPriceBookEntryId": null,
  "_part_custom_field9": "subscription",
  "id": 38851673,
  "_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-06T21:50:29.000Z",
  "partnerOrganizationId": null,
  "partDisplayNumber": "BMTN",
  "pricePeriod": null,
  "partNumberLower": "basic maintenance plan",
  "partNumber": "Basic Maintenance Plan",
  "externalKey1": null,
  "externalKey2": null,
  "links": [{
      "rel": "self",
      "href": "https://sitename.oracle.com/rest/v16/partSetups/38851673"
    }, {
      "kind": "",
      "rel": "child",
      "name": "extendedDescriptions",
      "href": "https://sitename.oracle.com/rest/v16/partSetups/38851673/extendedDescriptions"
    }, {
      "kind": "",
      "rel": "child",
      "name": "prices",
      "href": "https://sitename.oracle.com/rest/v16/partSetups/38851673/prices"
    }, {
      "kind": "",
      "rel": "child",
      "name": "translations",
      "href": "https://sitename.oracle.com/rest/v16/partSetups/38851673/translations"
    }
  ]
}

Create Part with Prices and Translations

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 prventifs.",
        "language": {
          "languageNumber": 1,
          "languageCode": "fr"
        },
        "units": null
      }, {
        "description": "Die Basiswartung umfasst Mehrpunktinspektionen und vorbeugende Pflege.",
        "language": {
          "languageNumber": 0,
          "languageCode": "de"
        },
        "units": null
      }
    ]
  }
}

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": "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/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": "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/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-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/v16/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/v16/languages"
            }, {
              "rel": "canonical",
              "href": "https://sitename.oracle.com/rest/v16/languages/36329903"
            }
          ]
        },
        "id": 38851710,
        "units": null,
        "dateAdded": "2023-03-06T22:32:25.000Z",
        "links": [{
            "rel": "self",
            "href": "https://sitename.oracle.com/rest/v16/partSetups/38851705/translations/38851710"
          }, {
            "rel": "parent",
            "href": "https://sitename.oracle.com/rest/v16/partSetups/38851705"
          }
        ]
      }, {
        "description": "La maintenance de base couvre les inspections multipoints et les soins prventifs.",
        "dateModified": "2023-03-06T22:32:25.000Z",
        "language": {
          "languageNumber": 1,
          "languageCode": "fr",
          "id": 36329904,
          "links": [{
              "rel": "domain",
              "href": "https://sitename.oracle.com/rest/v16/languages"
            }, {
              "rel": "canonical",
              "href": "https://sitename.oracle.com/rest/v16/languages/36329904"
            }
          ]
        },
        "id": 38851709,
        "units": null,
        "dateAdded": "2023-03-06T22:32:25.000Z",
        "links": [{
            "rel": "self",
            "href": "https://sitename.oracle.com/rest/v16/partSetups/38851705/translations/38851709"
          }, {
            "rel": "parent",
            "href": "https://sitename.oracle.com/rest/v16/partSetups/38851705"
          }
        ]
      }
    ]
  },
  "prices": {
    "hasMore": false,
    "links": [{
        "rel": "self",
        "href": "https://sitename.oracle.com/rest/v16/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/v16/partSetups/38851705/prices/38851706"
          }, {
            "rel": "parent",
            "href": "https://sitename.oracle.com/rest/v16/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/v16/partSetups/38851705/prices/38851707"
          }, {
            "rel": "parent",
            "href": "https://sitename.oracle.com/rest/v16/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/v16/partSetups/38851705/prices/38851708"
          }, {
            "rel": "parent",
            "href": "https://sitename.oracle.com/rest/v16/partSetups/38851705"
          }
        ]
      }
    ]
  },
  "links": [{
      "rel": "self",
      "href": "https://sitename.oracle.com/rest/v16/partSetups/38851705"
    }, {
      "kind": "",
      "rel": "child",
      "name": "extendedDescriptions",
      "href": "https://sitename.oracle.com/rest/v16/partSetups/38851705/extendedDescriptions"
    }
  ]
}
Back to Top