REST API for Oracle Commerce Cloud December 2017

updateASASettings

put

/ccadmin/v1/merchant/assistedSellingSettings

Update ASASettings. Updates Assisted Selling Settings. **Requires the x-ccasset-language header so translated content can be set for a specific language.**

Request

Supported Media Types

application/json

Header Parameters

X-CCAsset-Language: Type: string

Required: true

The asset language of the request

Body Parameter

Root Schema : updateASASettings_request

Example


{
    "backgroundImagePath":"/general/sample_background.jpg",
    "dashboardPromotionalText":"ASA Promo Text",
    "isInternalCustomPropertiesDisplayEnabled":true,
    "isExternalCustomPropertiesDisplayEnabled":false,
    "companyLogoPath":"/general/sample_logo.jpg",
    "collectionForFeaturedProductsId":"cat40015",
    "heroImagePath":"/general/sample_hero.jpg"
}

Properties

backgroundImagePath: Type: string

the relative path of the background image.
collectionForFeaturedProductsId: Type: string

categoryId of the parent category of featured products.
companyLogoPath: Type: string

the relative path of the company logo image.
dashboardPromotionalText: Type: string

the dashboard promotional text depending on the locale.
heroImagePath: Type: string

the relative path of the hero image.
isExternalCustomPropertiesDisplayEnabled: Type: boolean

Indicates if all the External properties needs to be displayed in ASA application.
isInternalCustomPropertiesDisplayEnabled: Type: boolean

Indicates if all the Internal properties needs to be displayed in ASA application.

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : updateASASettings_response

Properties

dashboardSettings: Type: object dashboardSettings

Additional Properties Allowed:

ASA Dashboard Settings
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
isExternalCustomPropertiesDisplayEnabled: Type: boolean

Indicates if the External properties needs to be displayed in ASA application.
isInternalCustomPropertiesDisplayEnabled: Type: boolean

Indicates if the Internal properties needs to be displayed in ASA application.

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":true,
    "isInternalProfilePropertiesDisplayEnabled":true,
    "isExternalCustomPropertiesDisplayEnabled":false,
    "dashboardSettings":{
        "dashboardPromotionalText":"Sample promo Text",
        "heroImage":{
            "path":"/general/heroImage.jpg",
            "url":"http://localhost:9080/file/general/heroImage.jpg"
        },
        "collectionForFeaturedProductsId":"cat80051"
    },
    "isExternalProfilePropertiesDisplayEnabled":false
}

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

{
  "backgroundImagePath": "/general/sample_background.jpg",
  "dashboardPromotionalText": "ASA Promo Text",
  "isInternalCustomPropertiesDisplayEnabled": true,
  "isExternalCustomPropertiesDisplayEnabled": false,
  "companyLogoPath": "/general/sample_logo.jpg",
  "collectionForFeaturedProductsId": "cat40015",
  "heroImagePath": "/general/sample_hero.jpg"
}

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": true,
  "isInternalProfilePropertiesDisplayEnabled": true,
  "isExternalCustomPropertiesDisplayEnabled": false,
  "dashboardSettings": {
    "dashboardPromotionalText": "Sample promo Text",
    "heroImage": {
      "path": "/general/heroImage.jpg",
      "url": "http://localhost:9080/file/general/heroImage.jpg"
    },
    "collectionForFeaturedProductsId": "cat80051"
  },
  "isExternalProfilePropertiesDisplayEnabled": false
}