Create a purchased product
post
/services/rest/connect/v1.4/purchasedProducts
Request
The information about a purchased product.
Root Schema : purchasedProducts
Type:
object
The information about a purchased product.
Show Source
-
campaign(optional):
[
"object",
"null"
]
The information on email marketing campaigns created in Oracle B2C Service Outreach Cloud Service. It is the reference to a resource in 'campaigns' collection. Only ID or lookupName can be provided to specify the resource.
-
comment(optional):
[
"string",
"null"
]
Maximum Length:
1333
The comments or notes associated with the line item. -
contact(optional):
[
"object",
"null"
]
The customers or end users of Oracle B2C Service site. A contact contains basic information such as a customer's name, email address, and phone number. It also contains information about customer service issues, opportunities, and marketing mailings subscription status. It is the reference to a resource in 'contacts' collection. Only ID or lookupName can be provided to specify the resource.
-
createdTime(optional):
string
The date and time when the purchased product was created. This attribute is read-only.
-
finalizedByAccount(optional):
[
"object",
"null"
]
The account represents a staff member in Oracle B2C Service. Examples of staff members are customer sales representatives, sales agents, site administrators, and so on. It is the reference to a resource in 'accounts' collection. Only ID or lookupName can be provided to specify the resource.
-
id(optional):
integer
Minimum Value:
1
Maximum Value:9.223372036854776E18
The unique identifier of the purchased product. -
licenseEndTime(optional):
[
"string",
"null"
]
The end date of the license.
-
licenseStartTime(optional):
[
"string",
"null"
]
The start date of the license.
-
lookupName(optional):
string
Maximum Length:
255
The name used to look up the purchased product. -
mailing(optional):
object namedIDs-purchasedProducts-mailing
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.
-
opportunity(optional):
[
"object",
"null"
]
The information about a specific sale or a pending deal with a contact or an organization that is tracked and maintained in the Oracle B2C Service knowledge base. It is the reference to a resource in 'opportunities' collection. Only ID or lookupName can be provided to specify the resource.
-
organization(optional):
[
"object",
"null"
]
The company, business unit of a large company, or government agency that has an organization record in the Oracle B2C Service knowledge base. It is the reference to a resource in 'organizations' collection. Only ID or lookupName can be provided to specify the resource.
-
price(optional):
object purchasedProducts-price
The monetary value that consists of currency, exchange rate, and value.
-
purchaseTime(optional):
[
"string",
"null"
]
The date and time of the purchase.
-
salesProduct(optional):
[
"object",
"null"
]
The items or services sold by an organization. Sales products are available to customers through quotes and promotions. It is the reference to a resource in 'salesProducts' collection. Only ID or lookupName can be provided to specify the resource.
-
serialNumber(optional):
[
"string",
"null"
]
Maximum Length:
80
Pattern:^[^ ]*$
The serial number of the purchased product. -
updatedTime(optional):
string
The date and time when the purchased product was last updated. This attribute is read-only.
Nested Schema : namedIDs-purchasedProducts-mailing
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 : purchasedProducts-price
Type:
object
The monetary value that consists of currency, exchange rate, and value.
Show Source
-
currency(optional):
object namedIDs-purchasedProducts-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-purchasedProducts-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-purchasedProducts-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-purchasedProducts-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
Root Schema : purchasedProducts
Type:
object
The information about a purchased product.
Show Source
-
campaign(optional):
[
"object",
"null"
]
The information on email marketing campaigns created in Oracle B2C Service Outreach Cloud Service. It is the reference to a resource in 'campaigns' collection. Only ID or lookupName can be provided to specify the resource.
-
comment(optional):
[
"string",
"null"
]
Maximum Length:
1333
The comments or notes associated with the line item. -
contact(optional):
[
"object",
"null"
]
The customers or end users of Oracle B2C Service site. A contact contains basic information such as a customer's name, email address, and phone number. It also contains information about customer service issues, opportunities, and marketing mailings subscription status. It is the reference to a resource in 'contacts' collection. Only ID or lookupName can be provided to specify the resource.
-
createdTime(optional):
string
The date and time when the purchased product was created. This attribute is read-only.
-
finalizedByAccount(optional):
[
"object",
"null"
]
The account represents a staff member in Oracle B2C Service. Examples of staff members are customer sales representatives, sales agents, site administrators, and so on. It is the reference to a resource in 'accounts' collection. Only ID or lookupName can be provided to specify the resource.
-
id(optional):
integer
Minimum Value:
1
Maximum Value:9.223372036854776E18
The unique identifier of the purchased product. -
licenseEndTime(optional):
[
"string",
"null"
]
The end date of the license.
-
licenseStartTime(optional):
[
"string",
"null"
]
The start date of the license.
-
lookupName(optional):
string
Maximum Length:
255
The name used to look up the purchased product. -
mailing(optional):
object namedIDs-purchasedProducts-mailing
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.
-
opportunity(optional):
[
"object",
"null"
]
The information about a specific sale or a pending deal with a contact or an organization that is tracked and maintained in the Oracle B2C Service knowledge base. It is the reference to a resource in 'opportunities' collection. Only ID or lookupName can be provided to specify the resource.
-
organization(optional):
[
"object",
"null"
]
The company, business unit of a large company, or government agency that has an organization record in the Oracle B2C Service knowledge base. It is the reference to a resource in 'organizations' collection. Only ID or lookupName can be provided to specify the resource.
-
price(optional):
object purchasedProducts-price
The monetary value that consists of currency, exchange rate, and value.
-
purchaseTime(optional):
[
"string",
"null"
]
The date and time of the purchase.
-
salesProduct(optional):
[
"object",
"null"
]
The items or services sold by an organization. Sales products are available to customers through quotes and promotions. It is the reference to a resource in 'salesProducts' collection. Only ID or lookupName can be provided to specify the resource.
-
serialNumber(optional):
[
"string",
"null"
]
Maximum Length:
80
Pattern:^[^ ]*$
The serial number of the purchased product. -
updatedTime(optional):
string
The date and time when the purchased product was last updated. This attribute is read-only.
Nested Schema : namedIDs-purchasedProducts-mailing
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 : purchasedProducts-price
Type:
object
The monetary value that consists of currency, exchange rate, and value.
Show Source
-
currency(optional):
object namedIDs-purchasedProducts-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-purchasedProducts-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-purchasedProducts-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-purchasedProducts-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
Examples
Use POST with the following syntax to create a new purchased product object:
https://your_site_interface/services/rest/connect/version/purchasedProducts
Request URI example
https://mysite.example.com/services/rest/connect/v1.4/purchasedProducts
Request body example
{
"salesProduct":
{
"id": 4
},
"serialNumber": "SN0007",
"price":
{"currency":
{
"id": 1
},
"value": 750
}
}
Response body example
{
"id": 6,
"lookupName": "6",
"campaign": null,
"comment": null,
"contact": null,
"customFields": {
"c": {}
},
"finalizedByAccount": null,
"licenseEndTime": null,
"licenseStartTime": null,
"mailing": null,
"opportunity": null,
"organization": null,
"price": {
"currency": {
"id": 1,
"lookupName": "USD"
},
"exchangeRate": null,
"value": 750
},
"purchaseTime": null,
"salesProduct": {
"links": [
{
"rel": "self",
"href": "https://mysite.example.com/services/rest/connect/v1.4/salesProducts/4"
},
{
"rel": "canonical",
"href": "https://mysite.example.com/services/rest/connect/v1.4/salesProducts/4"
},
{
"rel": "describedby",
"href": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/salesProducts",
"mediaType": "application/schema+json"
}
]
},
"serialNumber": "SN0006",
"links": [
{
"rel": "self",
"href": "https://mysite.example.com/services/rest/connect/v1.4/purchasedProducts/5"
},
{
"rel": "canonical",
"href": "https://mysite.example.com/services/rest/connect/v1.4/purchasedProducts/5"
},
{
"rel": "describedby",
"href": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/purchasedProducts",
"mediaType": "application/schema+json"
}
]
}