REST API for Oracle Commerce Cloud December 2017

modifyService

post

/ccstore/v1/services/{id}/modify

Modify a service associated with a user.

Request

Supported Media Types

application/json

Path Parameters

id: Type: string

Required: true

ID of an asset.

Header Parameters

X-CCAsset-Language: Type: string

The asset language of the request

Body Parameter

Root Schema : action_request

Properties

transactionDate: Type: string

The date and time on which the service request was made.

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : modifyService_response

Properties

bomKey: Type: string

The instance id used by the configurator.
configContextKey: Type: string

Context key passed to configurator session to retrieve bom instance being calculated by ABO process.
configuratorUrl: Type: string

URL to launch configurator with.
model: Type: string

Model variable name for the model to launch configurator ui.
productLine: Type: string

Product line variable name for the model to launch configurator ui.
segment: Type: string

Segment variable name for the model to launch configurator ui.

Example application/json


{
    "productLine":"laptop",
    "configContextKey":"string",
    "configuratorUrl":"www.example.com",
    "bomKey":"string",
    "segment":"computer",
    "model":"laptopModel"
}

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:

{
  "productLine": "laptop",
  "configContextKey": "string",
  "configuratorUrl": "www.example.com",
  "bomKey": "string",
  "segment": "computer",
  "model": "laptopModel"
}