getServices
get
/ccstore/v1/services
Gets a list of services associated with a user.
Request
Supported Media Types
- application/json
Query Parameters
-
limit(optional): integer
The actual paging size used by the server.
-
offset(optional): integer
The offset used in the current page.
Header Parameters
-
X-CCAsset-Language(optional): string
The asset language of the request
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : getServices_response
Type:
Show Source
object
-
count(optional):
integer
The number of resource instances returned in the current range.
-
hasMore(optional):
boolean
Returns true if more resources are available on the server than the subset returned in current page.
-
items(optional):
array items
The array of service objects.
-
limit(optional):
integer
The paging size used by the server.
-
offset(optional):
integer
The offset used in the current page.
Nested Schema : items
Type:
Show Source
object
-
activationDate(optional):
string
Date on which the service contract starts.
-
assetId(optional):
string
Id of asset.
-
attributes(optional):
string
A collection (JSON) of key/value pair attributes that define the configuration of this asset/component.
-
currency(optional):
object currency
The currency code.
-
dateAdded(optional):
string
System field indicating the date on which the Resource was created.
-
dateModified(optional):
string
System field indicating the date on which the Resource was last modified.
-
deactivationDate(optional):
string
Date on which the service contract ends.
-
discountAmount(optional):
object discountAmount
The discount amount.
-
discountPercent(optional):
integer
The percent of discount received.
-
displayName(optional):
string
The public, non-unique key for the product instance. For example, phone number or serial number.
-
parentAsset(optional):
object parentAsset
Parent asset information.
-
parentDisplay(optional):
string
The public, non-unique key for the parent product instance. For example, phone number or serial number.
-
price(optional):
object price
The price.
-
quantity(optional):
integer
The quantity of the asset.
-
recurringCharge(optional):
object recurringCharge
The recurring charge.
-
recurringChargeDuration(optional):
string
The payment terms. For example, Net 30.
-
recurringChargeFrequency(optional):
string
The period for the fixed recurring charge. For example, Per Month.
-
resumeDate(optional):
string
Date on which the service contract resumes.
-
rootAsset(optional):
object rootAsset
Root asset information.
-
rootDisplay(optional):
string
The public, non-unique key for the root product instance. For example, phone number or serial number.
-
serviceAccountId(optional):
string
The customer that owns the product.
-
serviceId(optional):
string
An invariant key that uniquely identifies the asset / component for the lifetime of the asset. It will be unique across all asset repositories.
-
skuId(optional):
string
The SKU Id.
-
status(optional):
object status
The status information.
-
suspendDate(optional):
string
Date on which the service suspends.
-
transactionDate(optional):
string
ISO formatted Date on which the service action should be triggered.
-
usageNetAmount(optional):
object usageNetAmount
The usage information.
-
usageUnitOfMeasure(optional):
string
The unit of measure for the usage charges. For example, Per Copy or Per Minute.
Nested Schema : currency
Type:
object
The currency code.
Show Source
-
currencyCode(optional):
string
Unique currency code for the currency.
Nested Schema : discountAmount
Type:
object
The discount amount.
Show Source
-
currency(optional):
string
Currency code for the discount amount.
-
value(optional):
number
Amount value for the discount amount.
Nested Schema : parentAsset
Type:
object
Parent asset information.
Show Source
-
assetId(optional):
string
Id of asset.
-
serviceId(optional):
string
An invariant key that uniquely identifies the asset / component for the lifetime of the asset. It will be unique across all asset repositories.
Nested Schema : price
Type:
object
The price.
Show Source
-
currency(optional):
string
Currency code for the price.
-
value(optional):
number
Amount value for the price.
Nested Schema : recurringCharge
Type:
object
The recurring charge.
Show Source
-
currency(optional):
string
Currency code for the recurring amount.
-
value(optional):
number
Amount value for the recurring amount.
Nested Schema : rootAsset
Type:
object
Root asset information.
Show Source
-
assetId(optional):
string
Id of asset.
-
serviceId(optional):
string
An invariant key that uniquely identifies the asset / component for the lifetime of the asset. It will be unique across all asset repositories.
Nested Schema : status
Type:
object
The status information.
Show Source
-
displayValue(optional):
string
Translated display value of the fixed list of value for status.
-
id(optional):
string
Id of the fixed list of value for status.
-
lookupCode(optional):
string
Language independent code of the fixed list of value for status.
Nested Schema : usageNetAmount
Type:
object
The usage information.
Show Source
-
currency(optional):
string
Currency code for the usage net amount.
-
value(optional):
number
Amount value for the usage net amount.
Example Response (application/json)
{
"offset":0,
"count":3,
"hasMore":false,
"limit":12,
"items":[
{
"rootDisplay":null,
"deactivationDate":null,
"rootAsset":{
"assetId":null,
"serviceId":null
},
"displayName":"Service 1",
"discountAmount":{
"currency":null,
"value":null
},
"recurringChargeFrequency":null,
"dateAdded":"2017-06-14T17:59:16.718Z",
"assetId":"36489417",
"price":{
"currency":"USD",
"value":10
},
"currency":{
"currencyCode":"USD"
},
"usageNetAmount":{
"currency":null,
"value":null
},
"serviceId":"serv1",
"skuId":"part1",
"serviceAccountId":"vision",
"quantity":1,
"recurringChargeDuration":null,
"discountPercent":null,
"dateModified":"2017-06-14T17:59:16.718Z",
"transactionDate":"2018-06-27T12:59:59Z",
"usageUnitOfMeasure":null,
"suspendDate":null,
"parentDisplay":null,
"attributes":null,
"activationDate":null,
"parentAsset":{
"assetId":null,
"serviceId":null
},
"resumeDate":null,
"recurringCharge":{
"currency":null,
"value":null
},
"status":{
"displayValue":null,
"lookupCode":null,
"id":null
}
},
{
"rootDisplay":null,
"deactivationDate":null,
"rootAsset":{
"assetId":null,
"serviceId":null
},
"displayName":"Service 2",
"discountAmount":{
"currency":null,
"value":null
},
"recurringChargeFrequency":null,
"dateAdded":"2017-06-14T18:00:41.539Z",
"assetId":36489422,
"price":{
"currency":"USD",
"value":10
},
"currency":{
"currencyCode":"USD"
},
"usageNetAmount":{
"currency":null,
"value":null
},
"serviceId":"serv2",
"skuId":"part2",
"serviceAccountId":"vision",
"quantity":1,
"recurringChargeDuration":null,
"discountPercent":null,
"dateModified":"2017-06-14T18:00:41.539Z",
"transactionDate":"2018-06-27T12:59:59Z",
"usageUnitOfMeasure":null,
"suspendDate":null,
"parentDisplay":"Service 1",
"attributes":null,
"activationDate":null,
"parentAsset":{
"assetId":36489417,
"serviceId":"serv1"
},
"resumeDate":null,
"recurringCharge":{
"currency":null,
"value":null
},
"status":{
"displayValue":null,
"lookupCode":null,
"id":null
}
},
{
"rootDisplay":null,
"deactivationDate":null,
"rootAsset":{
"assetId":null,
"serviceId":null
},
"displayName":"Service 3",
"discountAmount":{
"currency":null,
"value":null
},
"recurringChargeFrequency":null,
"dateAdded":"2017-06-14T18:00:58.163Z",
"assetId":36489424,
"price":{
"currency":"USD",
"value":30
},
"currency":{
"currencyCode":"USD"
},
"usageNetAmount":{
"currency":null,
"value":null
},
"serviceId":"serv3",
"skuId":"part3",
"serviceAccountId":"vision",
"quantity":1,
"recurringChargeDuration":null,
"discountPercent":null,
"dateModified":"2017-06-14T18:00:58.163Z",
"transactionDate":"2018-06-27T12:59:59Z",
"usageUnitOfMeasure":null,
"suspendDate":null,
"parentDisplay":null,
"attributes":null,
"activationDate":null,
"parentAsset":{
"assetId":null,
"serviceId":null
},
"resumeDate":null,
"recurringCharge":{
"currency":null,
"value":null
},
"status":{
"displayValue":null,
"lookupCode":null,
"id":null
}
}
]
}
Default Response
The error response.
The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:
|Error Code|Description|
|------------------|------------------|
|551000|Could not get customers profile.|
|551001|Customer has no service account.|
|551002|Error retrieving customers service account.|
|551003|Error retrieving account assets.|
|551004|Error validating contact account ids in Order.
|551005|Invalid account asset id.
|551006|Account asset authorization error.
|551007|Owner of the account asset could not be determined.
|551008|Error submitting action request.
|551009|Invalid transactionDate.
Root Schema : errorModel
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
errors(optional):
array errors
An optional list of errors if multiple errors were encountered
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code
-
type(optional):
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code