Jump to

• Request
• Response

getOrganizationRequests

get

/ccapp/v1/organizationRequests/{id}

Get Organization Request. This operation is used to get the Organization request information of a customer from Oracle Commerce Cloud.

Request

Supported Media Types

• application/json

Path Parameters

• id(required): string
  The ID of the requested Organization Request

Query Parameters

• expand: 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).

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : getOrganizationRequests_response

Type: object

Show Source

• approverComments: string
  Org request approver comments
• id: string
  Id of Organization Request
• name: string
  Organization request name given by the requester
• organization: object organization
  Organization
• parentOrgName: boolean
  parent organization name given by the requester
• profile: object profile
  Profile
• requesterComments: string
  Requester comments given at time of creating request
• requesterOrganization: string
  Requester organization name.
• siteId: string
  Site captured during request creation
• status: string
  Status of Organization Request

{
    "properties":{
        "approverComments":{
            "description":"Org request approver comments",
            "type":"string"
        },
        "requesterOrganization":{
            "description":"Requester organization name.",
            "type":"string"
        },
        "organization":{
            "description":"Organization",
            "type":"object",
            "properties":{
                "customerType":{
                    "description":"Customer Type for Organization",
                    "type":"string"
                },
                "taxReferenceNumber":{
                    "description":"taxReferenceNumberof organization",
                    "type":"string"
                },
                "name":{
                    "description":"The name for Organization",
                    "type":"string"
                },
                "description":{
                    "description":"Description for organization",
                    "type":"string"
                },
                "id":{
                    "description":"Repository Id of the Organization",
                    "type":"string"
                },
                "externalOrganizationId":{
                    "description":"External organization id",
                    "type":"string"
                },
                "type":{
                    "description":"Type of Organization",
                    "type":"string"
                },
                "vatReferenceNumber":{
                    "description":"Vat reference number for the organization",
                    "type":"string"
                },
                "dunsNumber":{
                    "description":"dunsNumber of organization",
                    "type":"string"
                },
                "uniqueId":{
                    "description":"Unique Id of the Organization",
                    "type":"string"
                }
            }
        },
        "profile":{
            "description":"Profile",
            "type":"object",
            "properties":{
                "lastName":{
                    "description":"Last name of the profile",
                    "type":"string"
                },
                "firstName":{
                    "description":"first name of the profile",
                    "type":"string"
                },
                "customerContactId":{
                    "description":"The external customer contact id.",
                    "type":"string"
                },
                "id":{
                    "description":"Repository Id of the profile",
                    "type":"string"
                },
                "email":{
                    "description":"emailid of profile",
                    "type":"string"
                }
            }
        },
        "name":{
            "description":"Organization request name given by the requester",
            "type":"string"
        },
        "siteId":{
            "description":"Site captured during request creation",
            "type":"string"
        },
        "id":{
            "description":"Id of Organization Request",
            "type":"string"
        },
        "requesterComments":{
            "description":"Requester comments given at time of creating request",
            "type":"string"
        },
        "parentOrgName":{
            "description":"parent organization name given by the requester",
            "type":"boolean"
        },
        "status":{
            "description":"Status of Organization Request",
            "type":"string"
        }
    }
}

Nested Schema : organization

Type: object

Organization

Show Source

• customerType: string
  Customer Type for Organization
• description: string
  Description for organization
• dunsNumber: string
  dunsNumber of organization
• externalOrganizationId: string
  External organization id
• id: string
  Repository Id of the Organization
• name: string
  The name for Organization
• taxReferenceNumber: string
  taxReferenceNumberof organization
• type: string
  Type of Organization
• uniqueId: string
  Unique Id of the Organization
• vatReferenceNumber: string
  Vat reference number for the organization

{
    "description":"Organization",
    "type":"object",
    "properties":{
        "customerType":{
            "description":"Customer Type for Organization",
            "type":"string"
        },
        "taxReferenceNumber":{
            "description":"taxReferenceNumberof organization",
            "type":"string"
        },
        "name":{
            "description":"The name for Organization",
            "type":"string"
        },
        "description":{
            "description":"Description for organization",
            "type":"string"
        },
        "id":{
            "description":"Repository Id of the Organization",
            "type":"string"
        },
        "externalOrganizationId":{
            "description":"External organization id",
            "type":"string"
        },
        "type":{
            "description":"Type of Organization",
            "type":"string"
        },
        "vatReferenceNumber":{
            "description":"Vat reference number for the organization",
            "type":"string"
        },
        "dunsNumber":{
            "description":"dunsNumber of organization",
            "type":"string"
        },
        "uniqueId":{
            "description":"Unique Id of the Organization",
            "type":"string"
        }
    }
}

Nested Schema : profile

Type: object

Profile

Show Source

• customerContactId: string
  The external customer contact id.
• email: string
  emailid of profile
• firstName: string
  first name of the profile
• id: string
  Repository Id of the profile
• lastName: string
  Last name of the profile

{
    "description":"Profile",
    "type":"object",
    "properties":{
        "lastName":{
            "description":"Last name of the profile",
            "type":"string"
        },
        "firstName":{
            "description":"first name of the profile",
            "type":"string"
        },
        "customerContactId":{
            "description":"The external customer contact id.",
            "type":"string"
        },
        "id":{
            "description":"Repository Id of the profile",
            "type":"string"
        },
        "email":{
            "description":"emailid of profile",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "approverComments":"Request is approved",
    "relatedOrganizationName":null,
    "profile":{
        "id":"100001"
    },
    "organization":{
        "id":"150002"
    },
    "name":"My account",
    "siteId":"siteUS",
    "id":100001,
    "requesterComments":"None",
    "status":"approved"
}

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|If there was no organization request found with the given id|

Body ()

Root Schema : errorModel

Type: object

Show Source

• devMessage: string
  An optional non-localized message containing technical information for developers
• errorCode: string
  The numerical code identifying the error
• errors: array errors
  An optional list of errors if multiple errors were encountered
• message: string
  The localized message describing the error
• moreInfo: string
  An optional non-localized message with more information
• o:errorPath: string
  An optional machine readable description of where the error occurred
• status: string
  The HTTP status code
• type: 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: string
  An optional non-localized message containing technical information for developers
• errorCode: string
  The numerical code identifying the error
• message: string
  The localized message describing the error
• moreInfo: string
  An optional non-localized message with more information
• o:errorPath: string
  An optional machine readable description of where the error occurred
• status: 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