Jump to

• Request
• Response

getDirectEditConfigurations

get

/ccadmin/v1/merchant/directEdit/

Get all configurations of direct editing.

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

Type: object

Show Source

• configurations: array configurations
  The data for the direct configurations.

{
    "properties":{
        "configurations":{
            "description":"The data for the direct configurations.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "dependsOn":{
                        "description":"List of direct edit dependency configurations",
                        "type":"array",
                        "items":{
                            "type":"string",
                            "properties":{
                                "name":{
                                    "description":"The name of the configuration attribute.",
                                    "type":"string"
                                }
                            }
                        }
                    },
                    "name":{
                        "description":"Tells the name of functionality which can be enabled or disabled.",
                        "type":"string"
                    },
                    "enabled":{
                        "description":"Indicates whether direct edit is enabled or disabled.",
                        "type":"boolean"
                    }
                }
            }
        }
    }
}

Nested Schema : configurations

Type: array

The data for the direct configurations.

Show Source

• Array of: object items

{
    "description":"The data for the direct configurations.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "dependsOn":{
                "description":"List of direct edit dependency configurations",
                "type":"array",
                "items":{
                    "type":"string",
                    "properties":{
                        "name":{
                            "description":"The name of the configuration attribute.",
                            "type":"string"
                        }
                    }
                }
            },
            "name":{
                "description":"Tells the name of functionality which can be enabled or disabled.",
                "type":"string"
            },
            "enabled":{
                "description":"Indicates whether direct edit is enabled or disabled.",
                "type":"boolean"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• dependsOn: array dependsOn
  List of direct edit dependency configurations
• enabled: boolean
  Indicates whether direct edit is enabled or disabled.
• name: string
  Tells the name of functionality which can be enabled or disabled.

{
    "type":"object",
    "properties":{
        "dependsOn":{
            "description":"List of direct edit dependency configurations",
            "type":"array",
            "items":{
                "type":"string",
                "properties":{
                    "name":{
                        "description":"The name of the configuration attribute.",
                        "type":"string"
                    }
                }
            }
        },
        "name":{
            "description":"Tells the name of functionality which can be enabled or disabled.",
            "type":"string"
        },
        "enabled":{
            "description":"Indicates whether direct edit is enabled or disabled.",
            "type":"boolean"
        }
    }
}

Nested Schema : dependsOn

Type: array

List of direct edit dependency configurations

Show Source

• Array of: string

{
    "description":"List of direct edit dependency configurations",
    "type":"array",
    "items":{
        "type":"string",
        "properties":{
            "name":{
                "description":"The name of the configuration attribute.",
                "type":"string"
            }
        }
    }
}

Example Response (application/json)

{
    "configurations":[
        {
            "name":"price",
            "enabled":false
        },
        {
            "dependsOn":[
                "price"
            ],
            "name":"catalog",
            "enabled":false
        }
    ]
}

Default Response

The error response

Body ()

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

Back to Top