REST API for Oracle Commerce Cloud December 2017

getServices

get

/ccstore/v1/services

Gets a list of services associated with a user.

Request

Supported Media Types

application/json

Query Parameters

limit: Type: integer

The actual paging size used by the server.
offset: Type: integer

The offset used in the current page.

Header Parameters

X-CCAsset-Language: Type: string

The asset language of the request

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : getServices_response

Properties

count: Type: integer

The number of resource instances returned in the current range.
hasMore: Type: boolean

Returns true if more resources are available on the server than the subset returned in current page.
items: Type: array items

Additional Properties Allowed:

The array of service objects.
limit: Type: integer

The paging size used by the server.
offset: Type: integer

The offset used in the current page.

Nested Schema : items

Type: array

The array of service objects.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

activationDate: Type: string

Date on which the service contract starts.
assetId: Type: string

Id of asset.
attributes: Type: string

A collection (JSON) of key/value pair attributes that define the configuration of this asset/component.
currency: Type: object currency

Additional Properties Allowed:

The currency code.
dateAdded: Type: string

System field indicating the date on which the Resource was created.
dateModified: Type: string

System field indicating the date on which the Resource was last modified.
deactivationDate: Type: string

Date on which the service contract ends.
discountAmount: Type: object discountAmount

Additional Properties Allowed:

The discount amount.
discountPercent: Type: integer

The percent of discount received.
displayName: Type: string

The public, non-unique key for the product instance. For example, phone number or serial number.
parentAsset: Type: object parentAsset

Additional Properties Allowed:

Parent asset information.
parentDisplay: Type: string

The public, non-unique key for the parent product instance. For example, phone number or serial number.
price: Type: object price

Additional Properties Allowed:

The price.
quantity: Type: integer

The quantity of the asset.
recurringCharge: Type: object recurringCharge

Additional Properties Allowed:

The recurring charge.
recurringChargeDuration: Type: string

The payment terms. For example, Net 30.
recurringChargeFrequency: Type: string

The period for the fixed recurring charge. For example, Per Month.
resumeDate: Type: string

Date on which the service contract resumes.
rootAsset: Type: object rootAsset

Additional Properties Allowed:

Root asset information.
rootDisplay: Type: string

The public, non-unique key for the root product instance. For example, phone number or serial number.
serviceAccountId: Type: string

The customer that owns the product.
serviceId: Type: 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: Type: string

The SKU Id.
status: Type: object status

Additional Properties Allowed:

The status information.
suspendDate: Type: string

Date on which the service suspends.
usageNetAmount: Type: object usageNetAmount

Additional Properties Allowed:

The usage information.
usageUnitOfMeasure: Type: string

The unit of measure for the usage charges. For example, Per Copy or Per Minute.

Nested Schema : currency

Type: object

The currency code.

Properties

currencyCode: Type: string

Unique currency code for the currency.

Nested Schema : discountAmount

Type: object

The discount amount.

Properties

currency: Type: string

Currency code for the discount amount.
value: Type: number

Amount value for the discount amount.

Nested Schema : parentAsset

Type: object

Parent asset information.

Properties

assetId: Type: string

Id of asset.
serviceId: Type: 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.

Properties

currency: Type: string

Currency code for the price.
value: Type: number

Amount value for the price.

Nested Schema : recurringCharge

Type: object

The recurring charge.

Properties

currency: Type: string

Currency code for the recurring amount.
value: Type: number

Amount value for the recurring amount.

Nested Schema : rootAsset

Type: object

Root asset information.

Properties

assetId: Type: string

Id of asset.
serviceId: Type: 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.

Properties

displayValue: Type: string

Translated display value of the fixed list of value for status.
id: Type: string

Id of the fixed list of value for status.
lookupCode: Type: string

Language independent code of the fixed list of value for status.

Nested Schema : usageNetAmount

Type: object

The usage information.

Properties

currency: Type: string

Currency code for the usage net amount.
value: Type: number

Amount value for the usage net amount.

Example 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",
            "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",
            "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",
            "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.

Body

Root Schema : errorModel

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
errors: Type: array errors

Additional Properties Allowed:

An optional list of errors if multiple errors were encountered
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code
type: Type: string

The URI to the HTTP state code definition

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code

Examples

Sample Response Payload returned by endpoint:

{
  "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",
      "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",
      "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",
      "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
      }
    }
  ]
}