createOrganizationRequest
post
/ccstore/v1/organizationRequests
Creates organization request. This operation is used to create organization request in Oracle Commerce Cloud for a customer.
Request
Supported Media Types
- application/json
Nested Schema : organizationRequest
Type:
Show Source
object-
approverComments(optional):
string
Org request approver comments
-
createdTime(optional):
string(date-time)
The date the account request was created
-
id(optional):
string
Id of Organization Request
-
name(optional):
string
Organization request name given by the requester
-
organization(optional):
object organization
Organization
-
profile(optional):
object profile
Profile
- relatedOrganizationName(optional): string
-
requesterComments(optional):
string
Requester comments given at time of creating request
-
siteId(optional):
string
Site id captured during request creation
-
status(optional):
string
Status of Organization Request
Nested Schema : organization
Type:
objectOrganization
Show Source
-
customerType(optional):
string
Customer Type for Organization
-
dunsNumber(optional):
string
dunsNumber of organization
-
id(optional):
string
Repository Id of the Organization
-
name(optional):
string
The name for Organization
-
secondaryAddresses(optional):
array secondaryAddresses
Address associated with an Organization request, this is the address provided by the requestor at the time of request creation. This property will be removed from the webhook request payload if the size exceeds the sub entity truncation size value configured for this webhook
-
secondaryAddressesIsTruncated(optional):
boolean
This property will be added to the webhook payload only if the corresponding secondaryAddresses property is truncated. The value for this field will be true always if present
-
taxReferenceNumber(optional):
string
taxReferenceNumberof organization
-
type(optional):
string
Type of Organization
-
uniqueId(optional):
string
Unique Id of the Organization
-
vatReferenceNumber(optional):
string
Vat reference number for the organization
Nested Schema : profile
Type:
objectProfile
Show Source
-
customerContactId(optional):
string
The external customer contact id.
-
email(optional):
string
emailid of profile
-
firstName(optional):
string
first name of the profile
-
id(optional):
string
Repository Id of the profile
-
lastName(optional):
string
Last name of the profile
Nested Schema : secondaryAddresses
Type:
arrayAddress associated with an Organization request, this is the address provided by the requestor at the time of request creation. This property will be removed from the webhook request payload if the size exceeds the sub entity truncation size value configured for this webhook
Show Source
Nested Schema : items
Type:
Show Source
object-
address(optional):
object address
Address created for the Organization.
-
addressType(optional):
string
Address type represents nick name of account if present else repository ID of address item.
Nested Schema : address
Type:
objectAddress created for the Organization.
Show Source
-
address1(optional):
string
The address1 of the secondary address
-
address2(optional):
string
The address2 of the secondary address
-
city(optional):
string
The city of the secondary address
-
companyName(optional):
string
Company name of the secondary address
-
country(optional):
string
The country of the address
-
phoneNumber(optional):
string
Phone Number of the address
-
postalCode(optional):
string
Postal Code of the address
-
repositoryId(optional):
string
repository Id of the address
-
state(optional):
string
The State of the address
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : createOrganizationRequest_response
Type:
Show Source
object-
id(optional):
string
Id of Organization 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.
Example Response (application/json)
{
"links":[
{
"rel":"self",
"href":"http://localhost:8080/ccstoreui/v1/organizationRequests"
}
],
"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|
|------------------|------------------|
|101013|Registration request cannot be processed because the ability to submit registration requests for business accounts is disabled.|
|101015|There was a problem creating your account. Please try again.|
|00004|Data value too long.|
|101001|Invalid Input for organization request.|
|180104|Invalid address type ID {0}|
|
Root Schema : errorModel
Type:
Show Source
object-
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
Nested Schema : errors
Type:
arrayAn optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object-
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