updateOrganizationRequests
put
/ccapp/v1/organizationRequests/{id}
Update Organization request. This operation is used to update an Organization request in Oracle Commerce Cloud for a customer.
Request
Supported Media Types
- application/json
Path Parameters
-
id: string
The ID of the Organization request to be updated.
Query Parameters
-
expand(optional): string
Expand query param : currently used to expand profile, organization and orgAddress Info.(Allowed Values: profile - profile static data, profileAll - profile static & dynamic data, organization - organization static data, organizationAll - organization static & dynamic data, requestAll - organizationRequest static & dynamic data, organizationAddresses).
Root Schema : updateOrganizationRequests_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
-
status(optional):
string
status of the org request (review, moreInfoNeeded) are values.
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",
"status":"review"
}
Nested Schema : organization
Type:
object
Organization
Show Source
-
customerType(optional):
string
Customer Type for an Organization. Accepts one of these values [Standard, Preferred, Enterprise, OEM, Distributor, Supplier]
-
dunsNumber(optional):
string
DUNS Number for Organization. Should be 9 digit number
-
externalOrganizationId(optional):
string
External organization id
-
id(optional):
string
Repository Id of the Organization
-
name:
string
The name for Organization
-
secondaryAddresses(optional):
array secondaryAddresses
List of all the addresses associated with an 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]
-
uniqueId(optional):
string
Unique Id of an Organization
-
vatReferenceNumber(optional):
string
Vat reference number of an Organization
Nested Schema : profile
Type:
object
Profile
Show Source
-
customerContactId(optional):
string
The external customer contact id.
-
email:
string
email id of profile
-
firstName(optional):
string
First name of the profile
-
lastName(optional):
string
Last name of the profile
Nested Schema : secondaryAddresses
Type:
array
List of all the addresses associated with an Organization.
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:
object
Address 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
-
repositoryId(optional):
string
repository Id of the address
-
state(optional):
string
The State of the address
-
types(optional):
array types
The types tagged to 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 : updateOrganizationRequests_response
Type:
Show Source
object
-
approverComments(optional):
string
Org request approver comments
-
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 captured during request creation
-
status(optional):
string
Status of Organization Request
Nested Schema : organization
Type:
object
Organization
Show Source
-
id(optional):
string
Repository Id of the Organization
Nested Schema : profile
Type:
object
Profile
Show Source
-
id(optional):
string
Repository Id of the profile
Example Response (application/json)
{
"approverComments":"none",
"relatedOrganizationName":null,
"profile":{
"id":"100001"
},
"organization":{
"id":"150002"
},
"name":"My account",
"siteId":"siteUS",
"id":"100001",
"requesterComments":"None",
"status":"review"
}
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|
|------------------|------------------|
|101000|Invalid Organization Request ID.|
|101001|Invalid Input for organization request.|
|00004|Data value too long.|
|101008|This operation is not allowed as registration request is already in approved/rejected state.|
|101007|Invalid status for organization request. Allowed status are [review, moreInfoNeeded]|
|100023|Invalid DUNS number|
|100012|If the Organization name is empty or null|
|100014|If the organization name passed is duplicate|
|100018|If there was any internal error while updating the Organization|
|101014|Cannot update the status of this registration request to any value except "Rejected", because the requester's profile no longer exists|
|101017|This operation is not allowed as requester's profile no longer exists.|
|180120|Invalid address type value|
|100204|Id is required for types
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:
array
An 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