Jump to

• Request
• Response

Approve profile request

post

/ccagent/v1/profileRequests/{id}/approve

endpoint. This operation is used to approve profile request in Oracle Commerce Cloud.

Request

Supported Media Types

• application/json

Path Parameters

• id: string
  The ID of the Profile request.

Header Parameters

• X-CCAgentContext: string
  The Agent Context is a JSON object with shopperProfileId as a property.
• X-CCOrganization: string
  The organization Id associated with the shopper profile

Body ()

Root Schema : approveProfileRequest_request

Type: object

Show Source

• approvedSource(optional): string
  Approver source of channel during approval of request. This is optional. If value not sent via payload, system auto populates this property value with Delegated Administrator.
• approverComments: string
  Approver comments during approval of request, these are optional.

{
    "properties":{
        "approverComments":{
            "description":"Approver comments during approval of request, these are optional.",
            "type":"string"
        },
        "approvedSource":{
            "description":"Approver source of channel during approval of request. This is optional. If value not sent via payload, system auto populates this property value with Delegated Administrator.",
            "type":"string"
        }
    },
    "required":[
        "approverComments"
    ],
    "example":{
        "approverComments":"This request is approved",
        "approvedSource":"Delegated Administrator"
    }
}

Example:

{
    "approverComments":"This request is approved",
    "approvedSource":"Delegated Administrator"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : approveProfileRequest_response

Type: object

Show Source

• status(optional): string
  Status of Profile Request

{
    "properties":{
        "status":{
            "description":"Status of Profile Request",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "id":"100001",
    "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| |------------------|------------------| |102000|Invalid Profile Request ID.| |10001|Organization ID is required.| |101008|This operation is not allowed as registration request is already in approved/rejected state.| |100091|Agent does not have permission to perform this action.| |89101|If the shopperProfile passed in the AgentContext header is not an administrator for the account

Body ()

Root Schema : errorModel

Type: object

Show Source

• 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

{
    "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(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

{
    "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