Update a sales product
patch
/services/rest/connect/v1.4/salesProducts/{id}
Request
Path Parameters
-
id: integer
The unique identifier of the sales product.
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
-
acceptCount(optional):
integer
Minimum Value:
0
Maximum Value:2147483647
The number of times an offer for the sales product was accepted through offer advisor. -
adminVisibleInterfaces(optional):
object namedIDs-salesProducts-adminVisibleInterfaces
The named ID that can be included in a list.
-
attributes(optional):
object salesProducts-attributes
The information about a product, whether it has a serial number, is disabled, and is of type Sales or Service.
-
createdTime(optional):
string
The date and time when the sales product was created. This attribute is read-only.
-
descriptions(optional):
object salesProducts-descriptions
The language-specific string used for localization. Labels are assembled in a list that is associated with a particular text field.
-
displayOrder(optional):
integer
Minimum Value:
1
Maximum Value:2147483647
The display position of the sales product within the folder list in the product catalog. -
excludeFromOfferAdvisor(optional):
boolean
Indicates whether the product is excluded from the offer advisor. This attribute does not have a default value.
-
folder(optional):
object salesProducts-folder
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.
-
id(optional):
integer
Minimum Value:
1
Maximum Value:9.223372036854776E18
The unique identifier of the sales product. -
lookupName(optional):
string
Maximum Length:
255
The name used to look up the sales product. -
name(optional):
string
Maximum Length:
80
The name of the product in the language of the current interface. This attribute is read-only. -
names(optional):
object salesProducts-names
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.
-
partNumber(optional):
[
"string",
"null"
]
Maximum Length:
40
Pattern:^[^ ^|]*$
The text string which identifies the product. For example, stock keeping unit (SKU) or model number. -
respondCount(optional):
integer
Minimum Value:
0
Maximum Value:2147483647
The number of times the product was offered through the offer advisor. -
schedules(optional):
object salesProducts-schedules
The price schedule for a sales product.
-
serviceProduct(optional):
[
"object",
"null"
]
The hierarchical service product that provides an option to group answers and incidents for better organization and refined searching in the knowledge base. It is the reference to a resource in 'serviceProducts' collection. Only ID or lookupName can be provided to specify the resource.
-
updatedTime(optional):
string
The date and time when the sales product was last updated. This attribute is read-only.
Nested Schema : namedIDs-salesProducts-adminVisibleInterfaces
Type:
object
The named ID that can be included in a list.
Show Source
-
id(optional):
integer
Minimum Value:
1
Maximum Value:9.223372036854776E18
The unique identifier of the object. This is the key for the list entry. -
lookupName(optional):
string
Maximum Length:
255
The name used to look up the object.
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
-
disabled(optional):
boolean
Indicates whether the product is temporarily disabled and will not be displayed. The default value is false.
-
hasSerialNumber(optional):
boolean
Indicates whether the product has a serial number. The default value is false.
-
isSalesProduct(optional):
boolean
Indicates whether the product is a sales product. The default value is true.
-
isServiceProduct(optional):
boolean
Indicates whether the product is a service product. The default value is false.
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
-
labelText(optional):
[
"string",
"null"
]
Maximum Length:
1333
The label text. -
language(optional):
object namedIDs-salesProducts-descriptions-language
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.
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
-
id(optional):
integer
Minimum Value:
1
ID value -
lookupName(optional):
string
Maximum Length:
255
Name used to lookup this object -
parents(optional):
object salesProducts-folder-parents
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.
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
-
labelText(optional):
string
Maximum Length:
80
The language-specific label text. The value cannot be null or empty. -
language(optional):
object namedIDs-salesProducts-names-language
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.
Nested Schema : salesProducts-schedules
Type:
object
The price schedule for a sales product.
Show Source
-
comment(optional):
[
"string",
"null"
]
Maximum Length:
1333
The comments or notes associated with the sales product schedule. -
price(optional):
object salesProducts-schedules-price
The monetary value that consists of currency, exchange rate, and value.
-
schedule(optional):
object namedIDs-salesProducts-schedules-schedule
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.
-
scheduleEndDate(optional):
[
"string",
"null"
]
The date when the schedule ends.
-
scheduleStartDate(optional):
string
The date when the schedule starts. This is part of the key for the list entry.
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
-
id(optional):
integer
Minimum Value:
0
ID value -
lookupName(optional):
string
Maximum Length:
255
Name used to lookup this object
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
-
id(optional):
integer
Minimum Value:
1
ID value. Read-only -
lookupName(optional):
string
Maximum Length:
255
Name used to lookup this object
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
-
id(optional):
integer
Minimum Value:
0
ID value -
lookupName(optional):
string
Maximum Length:
255
Name used to lookup this object
Nested Schema : salesProducts-schedules-price
Type:
object
The monetary value that consists of currency, exchange rate, and value.
Show Source
-
currency(optional):
object namedIDs-salesProducts-schedules-price-currency
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.
-
exchangeRate(optional):
object namedIDs-salesProducts-schedules-price-exchangeRate
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.
-
value(optional):
number
The value of the currency.
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
-
id(optional):
integer
Minimum Value:
0
ID value -
lookupName(optional):
string
Maximum Length:
255
Name used to lookup this object
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
-
id(optional):
integer
Minimum Value:
0
ID value -
lookupName(optional):
string
Maximum Length:
255
Name used to lookup this object
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
-
id(optional):
integer
Minimum Value:
0
ID value -
lookupName(optional):
string
Maximum Length:
255
Name used to lookup this object
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.