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
Root Schema : createOrganizationRequest_request
Type:
Show Source
object-
name:
string
Organization request name
-
organization(optional):
object organization
Organization
-
profile(optional):
object profile
Profile
- relatedOrganizationName(optional): string
-
requesterComments(optional):
string
Requester comments given at time of creating request
Example:
{
"relatedOrganizationName":null,
"organization":{
"customerType":"Standard",
"taxReferenceNumber":"TAXUQ12345",
"name":"Oracle",
"description":"Some description",
"externalOrganizationId":"EXT_ORG_1",
"type":"none",
"vatReferenceNumber":"Vat123123",
"dunsNumber":"123456789",
"uniqueId":"TestIDNumber"
},
"profile":{
"firstName":"First name",
"lastName":"last name",
"customerContactId":"CRMID_1",
"email":"user@example.com"
},
"name":"Sample org",
"requesterComments":"Some comments"
}Nested Schema : organization
Type:
objectOrganization
Show Source
-
customerType(optional):
string
Customer Type for an Organization. Accepts one of these values [Standard, Preferred, Enterprise, OEM, Distributor, Supplier]
-
description(optional):
string
Description for Organization
-
dunsNumber(optional):
string
DUNS Number for Organization. Should be 9 digit number
-
externalOrganizationId(optional):
string
External organization id
-
name(optional):
string
The name for Organization
-
secondaryAddresses(optional):
array secondaryAddresses
Addresses for Organization
-
taxReferenceNumber(optional):
string
Tax Reference number for Organization
-
type(optional):
string
Type for Organization. Accepts one of these values [none, company, division, department, group]
-
vatReferenceNumber(optional):
string
Vat reference number of an Organization
Nested Schema : profile
Type:
objectProfile
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
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
-
externalAddressId(optional):
string
External address id
-
phoneNumber(optional):
string
Phone Number of the address
-
postalCode(optional):
string
Postal Code of the address
-
state(optional):
string
The State of the address
-
types(optional):
array types
The types of the address
Nested Schema : items
Type:
Show Source
object-
id(optional):
string
repository Id of the address type
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