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: string
The asset language of the request
Root Schema : updateASASettings_request
Type:
Show Source
object
-
backgroundImagePath(optional):
string
the relative path of the background image.
-
collectionForFeaturedProductsId(optional):
string
categoryId of the parent category of featured products.
-
companyLogoPath(optional):
string
the relative path of the company logo image.
-
dashboardPromotionalText(optional):
string
the dashboard promotional text depending on the locale.
-
heroImagePath(optional):
string
the relative path of the hero image.
-
isExternalCustomPropertiesDisplayEnabled(optional):
boolean
Indicates if all the External properties needs to be displayed in ASA application.
-
isInternalCustomPropertiesDisplayEnabled(optional):
boolean
Indicates if all the Internal properties needs to be displayed in ASA application.
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"
}
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : updateASASettings_response
Type:
Show Source
object
-
dashboardSettings(optional):
object dashboardSettings
ASA Dashboard Settings
-
settings(optional):
object settings
ASA Settings
Nested Schema : dashboardSettings
Type:
object
ASA Dashboard Settings
Show Source
-
collectionForFeaturedProductsId(optional):
string
categoryId for collection for featured products.
-
dashboardPromotionalText(optional):
string
the dashboard promotional text depending on the locale.
-
heroImage(optional):
object heroImage
Hero Image Path and URL
Nested Schema : settings
Type:
object
ASA Settings
Show Source
-
backgroundImage(optional):
object backgroundImage
Background Image Path and URL
-
companyLogo(optional):
object companyLogo
Company Logo Image Path and URL
-
isExternalCustomPropertiesDisplayEnabled(optional):
boolean
Indicates if the External properties needs to be displayed in ASA application.
-
isInternalCustomPropertiesDisplayEnabled(optional):
boolean
Indicates if the Internal properties needs to be displayed in ASA application.
Nested Schema : heroImage
Type:
object
Hero Image Path and URL
Show Source
-
path(optional):
string
The relative vfs path of the image.
-
url(optional):
string
The url of the image.
Nested Schema : backgroundImage
Type:
object
Background Image Path and URL
Show Source
-
path(optional):
string
The relative vfs path of the image.
-
url(optional):
string
The url of the image.
Nested Schema : companyLogo
Type:
object
Company Logo Image Path and URL
Show Source
-
path(optional):
string
The relative vfs path of the image.
-
url(optional):
string
The url of the image.
Example Response (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
Root Schema : errorModel
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
errors(optional):
array errors
An optional list of errors if multiple errors were encountered
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code
-
type(optional):
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code