Jump to

• Request
• Response

Update Selfservice Settings

put

/ccadmin/v1/merchant/selfServiceSettings

Update Selfservice Settings meta data

Request

Supported Media Types

• application/json

Header Parameters

• x-ccsite: string
  The site id corresponding to which self service settings should be updated.

Body ()

Root Schema : updateSelfserviceSettings_Request

Type: object

Show Source

• copyOrderTimeout: integer
  Specifies the time in hours after which UI will show CopyOrder button.
• quotes: object quotes
  Contains quotes settings meta data

{
    "properties":{
        "copyOrderTimeout":{
            "description":"Specifies the time in hours after which UI will show CopyOrder button.",
            "type":"integer"
        },
        "quotes":{
            "description":"Contains quotes settings meta data",
            "type":"object",
            "properties":{
                "refreshQuoteSettings":{
                    "description":"refresh values from CPQ server",
                    "type":"boolean"
                },
                "thresholdSizeForGenerateProposalAsync":{
                    "description":"Minimum number of transactionLines for a quote, to call generate proposal in async manner",
                    "type":"string"
                }
            }
        }
    },
    "example":{
        "copyOrderTimeout":10,
        "quotes":{
            "refreshQuoteSettings":true,
            "thresholdSizeForGenerateProposalAsync":"10"
        }
    }
}

Example:

{
    "copyOrderTimeout":10,
    "quotes":{
        "refreshQuoteSettings":true,
        "thresholdSizeForGenerateProposalAsync":"10"
    }
}

Nested Schema : quotes

Type: object

Contains quotes settings meta data

Show Source

• refreshQuoteSettings: boolean
  refresh values from CPQ server
• thresholdSizeForGenerateProposalAsync: string
  Minimum number of transactionLines for a quote, to call generate proposal in async manner

{
    "description":"Contains quotes settings meta data",
    "type":"object",
    "properties":{
        "refreshQuoteSettings":{
            "description":"refresh values from CPQ server",
            "type":"boolean"
        },
        "thresholdSizeForGenerateProposalAsync":{
            "description":"Minimum number of transactionLines for a quote, to call generate proposal in async manner",
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following response is returned when call succeeds.

Body ()

Root Schema : getSelfServiceSettings_Response

Type: object

Show Source

• copyOrderTimeout: integer
  Specifies the time in hours after which UI will show CopyOrder button.
• quotes: object quotes
  Contains quotes settings meta data

{
    "properties":{
        "copyOrderTimeout":{
            "description":"Specifies the time in hours after which UI will show CopyOrder button.",
            "type":"integer"
        },
        "quotes":{
            "description":"Contains quotes settings meta data",
            "type":"object",
            "properties":{
                "thresholdSizeForGenerateProposalAsync":{
                    "description":"Minimum number of transactionLines for a quote, to call generate proposal in async manner",
                    "type":"string"
                },
                "maxNumberOfApprovers":{
                    "description":"Maximum number of approvers that can be added for approval of a quote",
                    "type":"string"
                }
            }
        }
    }
}

Nested Schema : quotes

Type: object

Contains quotes settings meta data

Show Source

• maxNumberOfApprovers: string
  Maximum number of approvers that can be added for approval of a quote
• thresholdSizeForGenerateProposalAsync: string
  Minimum number of transactionLines for a quote, to call generate proposal in async manner

{
    "description":"Contains quotes settings meta data",
    "type":"object",
    "properties":{
        "thresholdSizeForGenerateProposalAsync":{
            "description":"Minimum number of transactionLines for a quote, to call generate proposal in async manner",
            "type":"string"
        },
        "maxNumberOfApprovers":{
            "description":"Maximum number of approvers that can be added for approval of a quote",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "copyOrderTimeout":10,
    "quotes":{
        "thresholdSizeForGenerateProposalAsync":"10",
        "maxNumberOfApprovers":"1"
    }
}

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