Update a sales product

patch

/services/rest/connect/v1.4/salesProducts/{id}

Request

Path Parameters
Body ()
The items or services sold by an organization. Sales products are available to customers through quotes and promotions.
Root Schema : salesProducts
Type: object
The items or services sold by an organization. Sales products are available to customers through quotes and promotions.
Show Source
Nested Schema : namedIDs-salesProducts-adminVisibleInterfaces
Type: object
The named ID that can be included in a list.
Show Source
Nested Schema : salesProducts-attributes
Type: object
The information about a product, whether it has a serial number, is disabled, and is of type Sales or Service.
Show Source
Nested Schema : salesProducts-descriptions
Type: object
The language-specific string used for localization. Labels are assembled in a list that is associated with a 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
The language-specific strings used for localization of fields. The label text cannot be empty or null. The labels are assembled in a list associated with a particular text field.
Show Source
Nested Schema : salesProducts-schedules
Type: object
The price schedule for a sales 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
The 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
Back to Top

Response

Default Response

Back to Top

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.
Back to Top