REST API for Oracle Commerce Cloud 21B

createMultipleProfileRequests

post

/ccstore/v1/profileRequests/createMultiple

Creates multiple profile requests. This operation is used to create multiple profile requests at a time in Oracle Commerce Cloud for a customer.

Request

Supported Media Types

application/json

Root Schema : createMultipleProfileRequests_request

Type: object

Show Source

profile: object profile

Profile
requestedOrganizations(optional): array requestedOrganizations

Requested Organizations
requesterComments(optional): string

Requester comments given at time of creating request

{
    "properties":{
        "requestedOrganizations":{
            "description":"Requested Organizations",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "name":{
                        "description":"The name for Organization",
                        "type":"string"
                    },
                    "id":{
                        "description":"ID of an Organization",
                        "type":"string"
                    }
                }
            }
        },
        "profile":{
            "description":"Profile",
            "type":"object",
            "properties":{
                "firstName":{
                    "description":"First name of the profile",
                    "type":"string"
                },
                "lastName":{
                    "description":"Last name of the profile",
                    "type":"string"
                },
                "customerContactId":{
                    "description":"The external customer contact id.",
                    "type":"string"
                },
                "receiveEmail":{
                    "description":"Receive email newsletters",
                    "type":"string"
                },
                "email":{
                    "description":"email id of profile",
                    "type":"string"
                }
            },
            "required":[
                "email",
                "firstName",
                "lastName"
            ]
        },
        "requesterComments":{
            "description":"Requester comments given at time of creating request",
            "type":"string"
        }
    },
    "required":[
        "profile"
    ],
    "example":{
        "requestedOrganizations":[
            {
                "name":"Oracle"
            },
            {
                "id":"or-100001"
            }
        ],
        "profile":{
            "firstName":"First name",
            "lastName":"last name",
            "customerContactId":"CRMID_1",
            "email":"user@temp.com"
        },
        "requesterComments":"Some comments"
    }
}

Example:

{
    "requestedOrganizations":[
        {
            "name":"Oracle"
        },
        {
            "id":"or-100001"
        }
    ],
    "profile":{
        "firstName":"First name",
        "lastName":"last name",
        "customerContactId":"CRMID_1",
        "email":"user@temp.com"
    },
    "requesterComments":"Some comments"
}

Nested Schema : profile

Type: object

Profile

Show Source

customerContactId(optional): string

The external customer contact id.
email: string

email id of profile
firstName: string

First name of the profile
lastName: string

Last name of the profile
receiveEmail(optional): string

Receive email newsletters

{
    "description":"Profile",
    "type":"object",
    "properties":{
        "firstName":{
            "description":"First name of the profile",
            "type":"string"
        },
        "lastName":{
            "description":"Last name of the profile",
            "type":"string"
        },
        "customerContactId":{
            "description":"The external customer contact id.",
            "type":"string"
        },
        "receiveEmail":{
            "description":"Receive email newsletters",
            "type":"string"
        },
        "email":{
            "description":"email id of profile",
            "type":"string"
        }
    },
    "required":[
        "email",
        "firstName",
        "lastName"
    ]
}

Nested Schema : requestedOrganizations

Type: array

Requested Organizations

Show Source

Array of: object items

{
    "description":"Requested Organizations",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "name":{
                "description":"The name for Organization",
                "type":"string"
            },
            "id":{
                "description":"ID of an Organization",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

id(optional): string

ID of an Organization
name(optional): string

The name for Organization

{
    "type":"object",
    "properties":{
        "name":{
            "description":"The name for Organization",
            "type":"string"
        },
        "id":{
            "description":"ID of an Organization",
            "type":"string"
        }
    }
}

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Root Schema : createMultipleProfileRequests_response

Type: object

Show Source

id(optional): array id

Ids of Profile Request

{
    "properties":{
        "id":{
            "description":"Ids of Profile Request",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "id":{
                        "description":"Id of Profile Request",
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : id

Type: array

Ids of Profile Request

Show Source

Array of: object items

{
    "description":"Ids of Profile Request",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "id":{
                "description":"Id of Profile Request",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

id(optional): string

Id of Profile Request

{
    "type":"object",
    "properties":{
        "id":{
            "description":"Id of Profile Request",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:8080/ccstoreui/v1/profileRequests/createMultiple"
        }
    ],
    "id":[
        "100002",
        "100003"
    ]
}

Default Response

The error response. The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud: |Error Code|Description| |------------------|------------------| |101015|An existing B2C shopper cannot submit a registration request.| |00004|Data value too long.| |101001|Invalid Input for registration request.|

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