1. REST API for Oracle Commerce Cloud 22A
  2. Tasks
  3. Admin
  4. Organization Request

updateOrganizationRequests

put

/ccadmin/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
Path Parameters
  • The ID of the Organization request to be updated.
Query Parameters
  • 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).
Body ()
Root Schema : updateOrganizationRequests_request
Type: object
Show Source
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
Nested Schema : profile
Type: object
Profile
Show Source
Nested Schema : secondaryAddresses
Type: array
List of all the addresses associated with an Organization.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : address
Type: object
Address created for the Organization.
Show Source
Nested Schema : types
Type: array
The types tagged to the address
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : updateOrganizationRequests_response
Type: object
Show Source
Nested Schema : organization
Type: object
Organization
Show Source
Nested Schema : profile
Type: object
Profile
Show Source
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
Body ()
Root Schema : errorModel
Type: object
Show Source
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top