REST API for Oracle Commerce Cloud December 2017

getASASettings

get

/ccadmin/v1/merchant/assistedSellingSettings

Get ASASettings. Returns all Assisted Selling Settings. Optionally takes the x-ccasset-language header to get translated content in another language.

Request

Supported Media Types

application/json

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

Properties

dashboardSettings: Type: object dashboardSettings

Additional Properties Allowed:

ASA Dashboard Settings
isExternalCustomPropertiesDisplayEnabled: Type: boolean

status of the checkbox, that determins whether to display External Custom Properties in ASA application.
isInternalCustomPropertiesDisplayEnabled: Type: boolean

status of the checkbox, that determines whether to display Internal Custom Properties in ASA application.
settings: Type: object settings

Additional Properties Allowed:

ASA Settings

Nested Schema : dashboardSettings

Type: object

ASA Dashboard Settings

Properties

collectionForFeaturedProductsId: Type: string

categoryId for collection for featured products.
dashboardPromotionalText: Type: string

the dashboard promotional text depending on the locale.
heroImage: Type: object heroImage

Additional Properties Allowed:

Hero Image Path and URL

Nested Schema : settings

Type: object

ASA Settings

Properties

backgroundImage: Type: object backgroundImage

Additional Properties Allowed:

Background Image Path and URL
companyLogo: Type: object companyLogo

Additional Properties Allowed:

Company Logo Image Path and URL

Nested Schema : heroImage

Type: object

Hero Image Path and URL

Properties

path: Type: string

The relative vfs path of the image.
url: Type: string

The url of the image.

Nested Schema : backgroundImage

Type: object

Background Image Path and URL

Properties

path: Type: string

The relative vfs path of the image.
url: Type: string

The url of the image.

Nested Schema : companyLogo

Type: object

Company Logo Image Path and URL

Properties

path: Type: string

The relative vfs path of the image.
url: Type: string

The url of the image.

Example application/json


{
    "settings":{
        "companyLogo":{
            "path":"/general/companyLogo.jpg",
            "url":"http://localhost:9080/file/general/companyLogo.jpg"
        },
        "backgroundImage":{
            "path":"/general/backgroundImage.jpg",
            "url":"http://localhost:9080/file/general/backgroundImage.jpg"
        },
        "isInternalCustomPropertiesDisplayEnabled":false,
        "isExternalCustomPropertiesDisplayEnabled":true
    },
    "dashboardSettings":{
        "dashboardPromotionalText":"Sample promo Text",
        "heroImage":{
            "path":"/general/heroImage.jpg",
            "url":"http://localhost:9080/file/general/heroImage.jpg"
        },
        "collectionForFeaturedProductsId":"cat80051"
    }
}

Default Response

The error response

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:

{
  "settings": {
    "companyLogo": {
      "path": "/general/companyLogo.jpg",
      "url": "http://localhost:9080/file/general/companyLogo.jpg"
    },
    "backgroundImage": {
      "path": "/general/backgroundImage.jpg",
      "url": "http://localhost:9080/file/general/backgroundImage.jpg"
    },
    "isInternalCustomPropertiesDisplayEnabled": false,
    "isExternalCustomPropertiesDisplayEnabled": true
  },
  "dashboardSettings": {
    "dashboardPromotionalText": "Sample promo Text",
    "heroImage": {
      "path": "/general/heroImage.jpg",
      "url": "http://localhost:9080/file/general/heroImage.jpg"
    },
    "collectionForFeaturedProductsId": "cat80051"
  }
}