REST API for Oracle Commerce Cloud

getSelfServiceConfiguration

get

/ccadmin/v1/merchant/selfServiceConfiguration

Retrieves the self service configuration

Request

There are no request parameters for this operation.

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Root Schema : selfServiceConfiguration_requestResponse

Type: object

Show Source

cancelOrderOnFailure: boolean

Determines if the order should be cancelled on failure, if order submission to CPQ fails to create a transaction
commerceItemToTransactionLineMapping: object commerceItemToTransactionLineMapping

Define mappings between commerceItem-specific dynamic properties and corresponding external integration attributes. This is relevant for instance when integrating with CPQ during order submission or quote requests, where commerceItem-level dynamic attributes may require mapping to transactionLine attributes.
orderSubmitToCPQ: boolean

Determines if order submission to CPQ should be processed natively, without relying on an external system.
orderToTransactionMapping: object orderToTransactionMapping

Define mappings between order-specific dynamic properties and corresponding external integration attributes. This is relevant for instance when integrating with CPQ during order submission or quote requests, where order-level dynamic attributes may require mapping to transaction attributes.
requestQuoteToCPQ: boolean

Determines if the request for quote to CPQ should be processed natively, without relying on an external system.
shippingMethodsMapping: object shippingMethodsMapping

Define mappings between shipping methods and their corresponding external shipping attributes. This is particularly relevant when integrating with CPQ during order submission, where additional mapping may be necessary to align shipping attributes (e.g., modeOfTransport, serviceLevel, carrierName) from the shippingMethod to transactionLine attributes.

{
    "properties":{
        "orderToTransactionMapping":{
            "description":"Define mappings between order-specific dynamic properties and corresponding external integration attributes. This is relevant for instance when integrating with CPQ during order submission or quote requests, where order-level dynamic attributes may require mapping to transaction attributes.",
            "type":"object"
        },
        "requestQuoteToCPQ":{
            "description":"Determines if the request for quote to CPQ should be processed natively, without relying on an external system.",
            "type":"boolean"
        },
        "orderSubmitToCPQ":{
            "description":"Determines if order submission to CPQ should be processed natively, without relying on an external system.",
            "type":"boolean"
        },
        "cancelOrderOnFailure":{
            "description":"Determines if the order should be cancelled on failure, if order submission to CPQ fails to create a transaction",
            "type":"boolean"
        },
        "commerceItemToTransactionLineMapping":{
            "description":"Define mappings between commerceItem-specific dynamic properties and corresponding external integration attributes. This is relevant for instance when integrating with CPQ during order submission or quote requests, where commerceItem-level dynamic attributes may require mapping to transactionLine attributes.",
            "type":"object"
        },
        "shippingMethodsMapping":{
            "description":"Define mappings between shipping methods and their corresponding external shipping attributes. This is particularly relevant when integrating with CPQ during order submission, where additional mapping may be necessary to align shipping attributes (e.g., modeOfTransport, serviceLevel, carrierName) from the shippingMethod to transactionLine attributes.",
            "type":"object"
        }
    },
    "example":{
        "orderToTransactionMapping":{
            "total_amount":"totalOneTimeListAmount_c.value",
            "customer_email":"_customer_c_email"
        },
        "requestQuoteToCPQ":true,
        "orderSubmitToCPQ":true,
        "cancelOrderOnFailure":true,
        "commerceItemToTransactionLineMapping":{
            "part_type":"_part_sales_product_type_c"
        },
        "shippingMethodsMapping":{
            "standardShippingMethod":{
                "_shipping_shippingServiceLevel_l":"Next day air",
                "_shipping_shipCarrierName_l":"airborne",
                "_shipping_shipModeOfTransport_l":"air"
            }
        }
    }
}

Example:

{
    "orderToTransactionMapping":{
        "total_amount":"totalOneTimeListAmount_c.value",
        "customer_email":"_customer_c_email"
    },
    "requestQuoteToCPQ":true,
    "orderSubmitToCPQ":true,
    "cancelOrderOnFailure":true,
    "commerceItemToTransactionLineMapping":{
        "part_type":"_part_sales_product_type_c"
    },
    "shippingMethodsMapping":{
        "standardShippingMethod":{
            "_shipping_shippingServiceLevel_l":"Next day air",
            "_shipping_shipCarrierName_l":"airborne",
            "_shipping_shipModeOfTransport_l":"air"
        }
    }
}

Nested Schema : commerceItemToTransactionLineMapping

Type: object

Define mappings between commerceItem-specific dynamic properties and corresponding external integration attributes. This is relevant for instance when integrating with CPQ during order submission or quote requests, where commerceItem-level dynamic attributes may require mapping to transactionLine attributes.

Nested Schema : orderToTransactionMapping

Type: object

Define mappings between order-specific dynamic properties and corresponding external integration attributes. This is relevant for instance when integrating with CPQ during order submission or quote requests, where order-level dynamic attributes may require mapping to transaction attributes.

Nested Schema : shippingMethodsMapping

Type: object

Define mappings between shipping methods and their corresponding external shipping attributes. This is particularly relevant when integrating with CPQ during order submission, where additional mapping may be necessary to align shipping attributes (e.g., modeOfTransport, serviceLevel, carrierName) from the shippingMethod to transactionLine attributes.

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