Jump to

• Request
• Response

getAdminConfiguration

get

/ccadmin/v1/merchant/adminConfiguration

Get Admin Configuration. Get the admin configurations from server.

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : getAdminConfiguration_response

Type: object

Show Source

• allowedOriginMethods(optional): object allowedOriginMethods
  Additional Properties Allowed: additionalProperties

  Map of hostname (key) and the allowed http methods (values) for that host.
• sessionTimeout(optional): integer
  Tells how long the before the session times out in the admin application in minutes (3-120).
• sortByPriceEnabled(optional): boolean
  Flag to signify whether sorting by price is enabled in this environment.
• sortByPriceProductLimit(optional): integer
  Maximum number of total products for which the sort by price feature should be available.
• supportVersion1Catalogs(optional): boolean
  If true then legacy (version 1) catalogs are supported in the system.

{
    "properties":{
        "sortByPriceEnabled":{
            "description":"Flag to signify whether sorting by price is enabled in this environment.",
            "type":"boolean"
        },
        "supportVersion1Catalogs":{
            "description":"If true then legacy (version 1) catalogs are supported in the system.",
            "type":"boolean"
        },
        "allowedOriginMethods":{
            "description":"Map of hostname (key) and the allowed http methods (values) for that host.",
            "additionalProperties":{
                "type":"string"
            },
            "type":"object"
        },
        "sessionTimeout":{
            "description":"Tells how long the before the session times out in the admin application in minutes (3-120).",
            "type":"integer"
        },
        "sortByPriceProductLimit":{
            "description":"Maximum number of total products for which the sort by price feature should be available.",
            "type":"integer"
        }
    }
}

Nested Schema : allowedOriginMethods

Type: object

Additional Properties Allowed

Show Source

• string

{
    "description":"Map of hostname (key) and the allowed http methods (values) for that host.",
    "additionalProperties":{
        "type":"string"
    },
    "type":"object"
}

Map of hostname (key) and the allowed http methods (values) for that host.

Example Response (application/json)

{
    "sortByPriceEnabled":true,
    "supportVersion1Catalogs":false,
    "allowedOriginMethods":{
        "https://somemoresecurehost":"GET",
        "https://someHost:9080":"GET,PUT,DELETE,POST,OPTIONS"
    },
    "sessionTimeout":15,
    "sortByPriceProductLimit":20000
}

Default Response

The error response

Body ()

Root Schema : errorModel

Type: object

Show Source

• 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

{
    "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(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

{
    "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"
        }
    }
}

Back to Top