REST API for Oracle Commerce Cloud

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

The asset language of the request

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Root Schema : getASASettings_response

Type: object

Show Source

dashboardSettings: object dashboardSettings

ASA Dashboard Settings
isExternalCustomPropertiesDisplayEnabled: boolean

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

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

ASA Settings

{
    "properties":{
        "settings":{
            "description":"ASA Settings",
            "type":"object",
            "properties":{
                "companyLogo":{
                    "description":"Company Logo Image Path and URL",
                    "type":"object",
                    "properties":{
                        "path":{
                            "description":"The relative vfs path of the image.",
                            "type":"string"
                        },
                        "url":{
                            "description":"The url of the image.",
                            "type":"string"
                        }
                    }
                },
                "backgroundImage":{
                    "description":"Background Image Path and URL",
                    "type":"object",
                    "properties":{
                        "path":{
                            "description":"The relative vfs path of the image.",
                            "type":"string"
                        },
                        "url":{
                            "description":"The url of the image.",
                            "type":"string"
                        }
                    }
                }
            }
        },
        "isInternalCustomPropertiesDisplayEnabled":{
            "description":"status of the checkbox, that determines whether to display Internal Custom Properties in ASA application.",
            "type":"boolean"
        },
        "isExternalCustomPropertiesDisplayEnabled":{
            "description":"status of the checkbox, that determines whether to display External Custom Properties in ASA application.",
            "type":"boolean"
        },
        "dashboardSettings":{
            "description":"ASA Dashboard Settings",
            "type":"object",
            "properties":{
                "dashboardPromotionalText":{
                    "description":"the dashboard promotional text depending on the locale.",
                    "type":"string"
                },
                "heroImage":{
                    "description":"Hero Image Path and URL",
                    "type":"object",
                    "properties":{
                        "path":{
                            "description":"The relative vfs path of the image.",
                            "type":"string"
                        },
                        "url":{
                            "description":"The url of the image.",
                            "type":"string"
                        }
                    }
                },
                "collectionForFeaturedProductsId":{
                    "description":"categoryId for collection for featured products.",
                    "type":"string"
                }
            }
        }
    }
}

Nested Schema : dashboardSettings

Type: object

ASA Dashboard Settings

Show Source

collectionForFeaturedProductsId: string

categoryId for collection for featured products.
dashboardPromotionalText: string

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

Hero Image Path and URL

{
    "description":"ASA Dashboard Settings",
    "type":"object",
    "properties":{
        "dashboardPromotionalText":{
            "description":"the dashboard promotional text depending on the locale.",
            "type":"string"
        },
        "heroImage":{
            "description":"Hero Image Path and URL",
            "type":"object",
            "properties":{
                "path":{
                    "description":"The relative vfs path of the image.",
                    "type":"string"
                },
                "url":{
                    "description":"The url of the image.",
                    "type":"string"
                }
            }
        },
        "collectionForFeaturedProductsId":{
            "description":"categoryId for collection for featured products.",
            "type":"string"
        }
    }
}

Nested Schema : settings

Type: object

ASA Settings

Show Source

backgroundImage: object backgroundImage

Background Image Path and URL
companyLogo: object companyLogo

Company Logo Image Path and URL

{
    "description":"ASA Settings",
    "type":"object",
    "properties":{
        "companyLogo":{
            "description":"Company Logo Image Path and URL",
            "type":"object",
            "properties":{
                "path":{
                    "description":"The relative vfs path of the image.",
                    "type":"string"
                },
                "url":{
                    "description":"The url of the image.",
                    "type":"string"
                }
            }
        },
        "backgroundImage":{
            "description":"Background Image Path and URL",
            "type":"object",
            "properties":{
                "path":{
                    "description":"The relative vfs path of the image.",
                    "type":"string"
                },
                "url":{
                    "description":"The url of the image.",
                    "type":"string"
                }
            }
        }
    }
}

Nested Schema : heroImage

Type: object

Hero Image Path and URL

Show Source

path: string

The relative vfs path of the image.
url: string

The url of the image.

{
    "description":"Hero Image Path and URL",
    "type":"object",
    "properties":{
        "path":{
            "description":"The relative vfs path of the image.",
            "type":"string"
        },
        "url":{
            "description":"The url of the image.",
            "type":"string"
        }
    }
}

Nested Schema : backgroundImage

Type: object

Background Image Path and URL

Show Source

path: string

The relative vfs path of the image.
url: string

The url of the image.

{
    "description":"Background Image Path and URL",
    "type":"object",
    "properties":{
        "path":{
            "description":"The relative vfs path of the image.",
            "type":"string"
        },
        "url":{
            "description":"The url of the image.",
            "type":"string"
        }
    }
}

Nested Schema : companyLogo

Type: object

Company Logo Image Path and URL

Show Source

path: string

The relative vfs path of the image.
url: string

The url of the image.

{
    "description":"Company Logo Image Path and URL",
    "type":"object",
    "properties":{
        "path":{
            "description":"The relative vfs path of the image.",
            "type":"string"
        },
        "url":{
            "description":"The url of the image.",
            "type":"string"
        }
    }
}

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

Root Schema : errorModel

Type: object

Show Source

devMessage: string

An optional non-localized message containing technical information for developers
errorCode: string

The numerical code identifying the error
errors: array errors

An optional list of errors if multiple errors were encountered
message: string

The localized message describing the error
moreInfo: string

An optional non-localized message with more information
o:errorPath: string

An optional machine readable description of where the error occurred
status: string

The HTTP status code
type: string

The URI to the HTTP state code definition

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

devMessage: string

An optional non-localized message containing technical information for developers
errorCode: string

The numerical code identifying the error
message: string

The localized message describing the error
moreInfo: string

An optional non-localized message with more information
o:errorPath: string

An optional machine readable description of where the error occurred
status: string

The HTTP status code

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}