REST API for Oracle Commerce Cloud December 2017

saveAgentConfiguration

put

/ccadmin/v1/merchant/agentConfiguration

Save Agent Configuration. Saves the agent configurations and gets back the saved data.

Request

Supported Media Types

application/json

Body Parameter

Root Schema : saveAgentConfiguration_request

Example


{
    "delegatedAdminAllowedThroughAgent":true,
    "orderApprovalsAllowedThroughAgent":true
}

Properties

delegatedAdminAllowedThroughAgent: Type: boolean

Tells whether delegated administration feature needs to be enabled in agent application.
orderApprovalsAllowedThroughAgent: Type: boolean

Tells whether order approvals feature needs to enabled in agent application.

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : saveAgentConfiguration_response

Properties

delegatedAdminAllowedThroughAgent: Type: boolean

Tells whether delegated administration feature is enabled in agent application.
orderApprovalsAllowedThroughAgent: Type: boolean

Tells whether order approvals feature is enabled in agent application.

Example application/json


{
    "delegatedAdminAllowedThroughAgent":true,
    "orderApprovalsAllowedThroughAgent":true
}

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| |------------------|------------------| |96009|A problem occurred when saving the data.| |160022|Invalid input value(s) supplied. Value must be (true/false).|

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 Request:

{
  "delegatedAdminAllowedThroughAgent": true,
  "orderApprovalsAllowedThroughAgent": true
}

Sample Response Payload returned by endpoint:

{
  "delegatedAdminAllowedThroughAgent": true,
  "orderApprovalsAllowedThroughAgent": true
}