Jump to

• Request
• Response

createProfileRequest

post

/ccstore/v1/profileRequests

Creates profile request. This operation is used to create profile request in Oracle Commerce Cloud for a customer.

Request

Supported Media Types

• application/json

Body ()

Root Schema : createProfileRequest_request

Type: object

Show Source

• profileRequest(optional): object profileRequest

{
    "properties":{
        "profileRequest":{
            "properties":{
                "lastModifiedTime":{
                    "format":"date-time",
                    "description":"The date profile request was modified",
                    "type":"string"
                },
                "requestedOrganizationName":{
                    "description":"Requested Organization name given by the requester",
                    "type":"string"
                },
                "profile":{
                    "description":"Profile",
                    "type":"object",
                    "properties":{
                        "numberOfVisits":{
                            "description":"Number of visits related to profile",
                            "type":"integer"
                        },
                        "lastName":{
                            "description":"Last name of the profile",
                            "type":"string"
                        },
                        "firstName":{
                            "description":"first name of the profile",
                            "type":"string"
                        },
                        "GDPRProfileP13nConsentDate":{
                            "description":"The date on which GDPR personalization consent is granted for the profile.",
                            "type":"string"
                        },
                        "customerContactId":{
                            "description":"The external customer contact id.",
                            "type":"string"
                        },
                        "GDPRProfileP13nConsentGranted":{
                            "description":"This is GDPR profile personalization consent flag. can be true or false.",
                            "type":"boolean"
                        },
                        "profileType":{
                            "description":"Type of profile. It can be 'b2c_user', 'b2b_user' or 'b2b_user_pending'",
                            "type":"string"
                        },
                        "id":{
                            "description":"Repository Id of the profile",
                            "type":"string"
                        },
                        "receiveEmailDate":{
                            "description":"The date on which email marketing consent is granted for the profile.",
                            "type":"string"
                        },
                        "email":{
                            "description":"Email id of the profile",
                            "type":"string"
                        }
                    }
                },
                "organization":{
                    "description":"Organization",
                    "properties":{
                        "id":{
                            "description":"Repository Id of the Organization",
                            "type":"string"
                        }
                    }
                },
                "requestedOrganizationId":{
                    "description":"Requested Organization ID given by requester",
                    "type":"string"
                },
                "createdTime":{
                    "format":"date-time",
                    "description":"The date profile request was created",
                    "type":"string"
                },
                "siteId":{
                    "description":"Site captured during request creation",
                    "type":"string"
                },
                "id":{
                    "description":"Id of Profile Request",
                    "type":"string"
                },
                "requesterComments":{
                    "description":"Requester comments given at time of creating request",
                    "type":"string"
                },
                "status":{
                    "description":"Status of Profile Request",
                    "type":"string"
                }
            }
        }
    }
}

Nested Schema : profileRequest

Type: object

Show Source

• createdTime(optional): string(date-time)
  The date profile request was created
• id(optional): string
  Id of Profile Request
• lastModifiedTime(optional): string(date-time)
  The date profile request was modified
• organization(optional): object organization
  Organization
• profile(optional): object profile
  Profile
• requestedOrganizationId(optional): string
  Requested Organization ID given by requester
• requestedOrganizationName(optional): string
  Requested Organization name given by the requester
• requesterComments(optional): string
  Requester comments given at time of creating request
• siteId(optional): string
  Site captured during request creation
• status(optional): string
  Status of Profile Request

{
    "properties":{
        "lastModifiedTime":{
            "format":"date-time",
            "description":"The date profile request was modified",
            "type":"string"
        },
        "requestedOrganizationName":{
            "description":"Requested Organization name given by the requester",
            "type":"string"
        },
        "profile":{
            "description":"Profile",
            "type":"object",
            "properties":{
                "numberOfVisits":{
                    "description":"Number of visits related to profile",
                    "type":"integer"
                },
                "lastName":{
                    "description":"Last name of the profile",
                    "type":"string"
                },
                "firstName":{
                    "description":"first name of the profile",
                    "type":"string"
                },
                "GDPRProfileP13nConsentDate":{
                    "description":"The date on which GDPR personalization consent is granted for the profile.",
                    "type":"string"
                },
                "customerContactId":{
                    "description":"The external customer contact id.",
                    "type":"string"
                },
                "GDPRProfileP13nConsentGranted":{
                    "description":"This is GDPR profile personalization consent flag. can be true or false.",
                    "type":"boolean"
                },
                "profileType":{
                    "description":"Type of profile. It can be 'b2c_user', 'b2b_user' or 'b2b_user_pending'",
                    "type":"string"
                },
                "id":{
                    "description":"Repository Id of the profile",
                    "type":"string"
                },
                "receiveEmailDate":{
                    "description":"The date on which email marketing consent is granted for the profile.",
                    "type":"string"
                },
                "email":{
                    "description":"Email id of the profile",
                    "type":"string"
                }
            }
        },
        "organization":{
            "description":"Organization",
            "properties":{
                "id":{
                    "description":"Repository Id of the Organization",
                    "type":"string"
                }
            }
        },
        "requestedOrganizationId":{
            "description":"Requested Organization ID given by requester",
            "type":"string"
        },
        "createdTime":{
            "format":"date-time",
            "description":"The date profile request was created",
            "type":"string"
        },
        "siteId":{
            "description":"Site captured during request creation",
            "type":"string"
        },
        "id":{
            "description":"Id of Profile Request",
            "type":"string"
        },
        "requesterComments":{
            "description":"Requester comments given at time of creating request",
            "type":"string"
        },
        "status":{
            "description":"Status of Profile Request",
            "type":"string"
        }
    }
}

Nested Schema : organization

Type: object

Organization

Show Source

• id(optional): string
  Repository Id of the Organization

{
    "description":"Organization",
    "properties":{
        "id":{
            "description":"Repository Id of the Organization",
            "type":"string"
        }
    }
}

Nested Schema : profile

Type: object

Profile

Show Source

• customerContactId(optional): string
  The external customer contact id.
• email(optional): string
  Email id of the profile
• firstName(optional): string
  first name of the profile
• GDPRProfileP13nConsentDate(optional): string
  The date on which GDPR personalization consent is granted for the profile.
• GDPRProfileP13nConsentGranted(optional): boolean
  This is GDPR profile personalization consent flag. can be true or false.
• id(optional): string
  Repository Id of the profile
• lastName(optional): string
  Last name of the profile
• numberOfVisits(optional): integer
  Number of visits related to profile
• profileType(optional): string
  Type of profile. It can be 'b2c_user', 'b2b_user' or 'b2b_user_pending'
• receiveEmailDate(optional): string
  The date on which email marketing consent is granted for the profile.

{
    "description":"Profile",
    "type":"object",
    "properties":{
        "numberOfVisits":{
            "description":"Number of visits related to profile",
            "type":"integer"
        },
        "lastName":{
            "description":"Last name of the profile",
            "type":"string"
        },
        "firstName":{
            "description":"first name of the profile",
            "type":"string"
        },
        "GDPRProfileP13nConsentDate":{
            "description":"The date on which GDPR personalization consent is granted for the profile.",
            "type":"string"
        },
        "customerContactId":{
            "description":"The external customer contact id.",
            "type":"string"
        },
        "GDPRProfileP13nConsentGranted":{
            "description":"This is GDPR profile personalization consent flag. can be true or false.",
            "type":"boolean"
        },
        "profileType":{
            "description":"Type of profile. It can be 'b2c_user', 'b2b_user' or 'b2b_user_pending'",
            "type":"string"
        },
        "id":{
            "description":"Repository Id of the profile",
            "type":"string"
        },
        "receiveEmailDate":{
            "description":"The date on which email marketing consent is granted for the profile.",
            "type":"string"
        },
        "email":{
            "description":"Email id of the profile",
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : createProfileRequest_response

Type: object

Show Source

• id(optional): string
  Id of Profile Request. This will be removed when enableProfileRegistrationEmailCheck site setting is enabled.
• message(optional): string
  A descriptive message indicating profile creation will be displayed when enableProfileRegistrationEmailCheck site setting is enabled.

{
    "properties":{
        "id":{
            "description":"Id of Profile Request. This will be removed when enableProfileRegistrationEmailCheck site setting is enabled.",
            "type":"string"
        },
        "message":{
            "description":"A descriptive message indicating profile creation will be displayed when enableProfileRegistrationEmailCheck site setting is enabled.",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:8080/ccstoreui/v1/profileRequests"
        }
    ],
    "message":"Once registration has successfully completed, you'll receive account activation details in your registration email's inbox."
}

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.|

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