Update an instance of salesProducts

patch

/services/rest/connect/latest/salesProducts/{id}

Request

Path Parameters
Body ()
Product available to customers and organizations through quotes or offer advisor
Root Schema : salesProducts
Type: object
Product available to customers and organizations through quotes or offer advisor
Show Source
Nested Schema : namedIDs-salesProducts-adminVisibleInterfaces
Type: object
Named ID that can be included in a list
Show Source
  • Minimum Value: 1
    Maximum Value: 9.223372036854776E18
    ID value. This is the key for the list entry.
  • Maximum Length: 255
    Name used to lookup this object
Nested Schema : salesProducts-attributes
Type: object
Attribute options for the product object.
Show Source
Nested Schema : salesProducts-descriptions
Type: object
String that is language-specific, allowing localization. Labels will be assembled in a list that is associated with one particular text field.
Show Source
Nested Schema : salesProducts-folder
Type: object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
Nested Schema : salesProducts-names
Type: object
Strings that are language-specific, allowing localization of fields. Like the Label class, but the label text cannot be empty or null. Labels will be assembled in a list that is associated with one particular text field
Show Source
Nested Schema : salesProducts-schedules
Type: object
A price schedule for a sales product
Show Source
Nested Schema : serviceProducts
Type: object
Hierarchical service product
Show Source
Nested Schema : namedIDs-salesProducts-descriptions-language
Type: object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
Nested Schema : salesProducts-folder-parents
Type: object
NamedID in which the ID is read-only. Used for hierarchies, where caller can specify the parents by name, but cannot specify the parent IDs.
Show Source
Nested Schema : namedIDs-salesProducts-names-language
Type: object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
Nested Schema : salesProducts-schedules-price
Type: object
Monetary value that consists of currency, exchange rate, and value.
Show Source
Nested Schema : namedIDs-salesProducts-schedules-schedule
Type: object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
Nested Schema : namedIDs-salesProducts-schedules-price-currency
Type: object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
Nested Schema : namedIDs-salesProducts-schedules-price-exchangeRate
Type: object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
Nested Schema : namedIDs-serviceProducts-adminVisibleInterfaces
Type: object
Named ID that can be included in a list
Show Source
  • Minimum Value: 1
    Maximum Value: 9.223372036854776E18
    ID value. This is the key for the list entry.
  • Maximum Length: 255
    Name used to lookup this object
Nested Schema : serviceProducts-descriptions
Type: object
String that is language-specific, allowing localization. Labels will be assembled in a list that is associated with one particular text field.
Show Source
Nested Schema : namedIDs-serviceProducts-endUserVisibleInterfaces
Type: object
Named ID that can be included in a list
Show Source
  • Minimum Value: 1
    Maximum Value: 9.223372036854776E18
    ID value. This is the key for the list entry.
  • Maximum Length: 255
    Name used to lookup this object
Nested Schema : serviceProducts-names
Type: object
Strings that are language-specific, allowing localization of fields. Like the Label class, but the label text cannot be empty or null. Labels will be assembled in a list that is associated with one particular text field
Show Source
Nested Schema : serviceCategories
Type: object
Hierarchical service category
Show Source
Nested Schema : namedIDs-serviceCategories-adminVisibleInterfaces
Type: object
Named ID that can be included in a list
Show Source
  • Minimum Value: 1
    Maximum Value: 9.223372036854776E18
    ID value. This is the key for the list entry.
  • Maximum Length: 255
    Name used to lookup this object
Nested Schema : serviceCategories-descriptions
Type: object
String that is language-specific, allowing localization. Labels will be assembled in a list that is associated with one particular text field.
Show Source
Nested Schema : namedIDs-serviceCategories-endUserVisibleInterfaces
Type: object
Named ID that can be included in a list
Show Source
  • Minimum Value: 1
    Maximum Value: 9.223372036854776E18
    ID value. This is the key for the list entry.
  • Maximum Length: 255
    Name used to lookup this object
Nested Schema : serviceCategories-names
Type: object
Strings that are language-specific, allowing localization of fields. Like the Label class, but the label text cannot be empty or null. Labels will be assembled in a list that is associated with one particular text field
Show Source
Nested Schema : namedIDs-serviceCategories-descriptions-language
Type: object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
Nested Schema : namedIDs-serviceCategories-names-language
Type: object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
Nested Schema : namedIDs-serviceProducts-descriptions-language
Type: object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
Nested Schema : serviceDispositions
Type: object
Hierarchical service disposition
Show Source
Nested Schema : namedIDs-serviceDispositions-adminVisibleInterfaces
Type: object
Named ID that can be included in a list
Show Source
  • Minimum Value: 1
    Maximum Value: 9.223372036854776E18
    ID value. This is the key for the list entry.
  • Maximum Length: 255
    Name used to lookup this object
Nested Schema : serviceDispositions-descriptions
Type: object
String that is language-specific, allowing localization. Labels will be assembled in a list that is associated with one particular text field.
Show Source
Nested Schema : serviceDispositions-names
Type: object
Strings that are language-specific, allowing localization of fields. Like the Label class, but the label text cannot be empty or null. Labels will be assembled in a list that is associated with one particular text field
Show Source
Nested Schema : namedIDs-serviceDispositions-descriptions-language
Type: object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
Nested Schema : namedIDs-serviceDispositions-names-language
Type: object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
Nested Schema : namedIDs-serviceProducts-names-language
Type: object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source

Response

Default Response

Examples

Use the PATCH operation with the following syntax to partially update a sales product object:

https://your_site_interface/services/rest/connect/version/salesProducts/product_id

Include the data to be updated in the request body. Only the fields present in the request JSON data are updated. All other fields remain the same.

Request URI example

https://mysite.example.com/services/rest/connect/v1.4/salesProducts/1

Request body example

{
"names": [
    {
    "labelText": "Monde",
    "language":
        {
        "id":8
        }
    }
    ]
}

Response example

The status 200 OK is returned. Then retrieving the data for sales product 1 in language 8:

https://mysite.example.com/services/rest/connect/v1.4/salesProducts/1/names/8

returns the following:

{
  "labelText": "Monde",
  "language": {
    "id": 8,
    "lookupName": "fr_CA"
  },
  "links": [
    {
      "rel": "self",
      "href": "https://mysite.example.com/services/rest/connect/v1.4/salesProducts/1/names/8"
    },
    {
      "rel": "canonical",
      "href": "https://mysite.example.com/services/rest/connect/v1.4/salesProducts/1/names/8"
    },
    {
      "rel": "describedby",
      "href": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/salesProducts/names",
      "mediaType": "application/schema+json"
    }
  ]
}

Note:

The name of the Mundo phone has been changed to Monde in Francophone Canada.