Identify Customer Contract
Establishes the logic and rules used to identify or derive a customer contract from incoming API data. This policy ensures consistent contract grouping
Retrieves Orders Group policy created in the RightRev system.
Get Orders Group Policy
A system-generated compliance ID to retrieve orders group.
Name of the policy fetched by the system.
ID of the user who created the policy.
Timestamp of the policy created by the user. This is a unix Epoch timestamp format.
ID of the user last modified by.
Timestamp of the policy last modified on.
Represents the type of policy.
Represents the status of the policy.
Represents the unique name of the orders group.
Represents the latest version of the policy.
GET /apis/policy-sets/v1/policy/orders-group HTTP/1.1
Host: {realm}.{env}.rightrev.cloud/
Accept: */*
Get Orders Group Policy
[
{
"compliance_id": "a31d6299-6b25-46cf-9d74-104d3af07ea4",
"compliance_name": "Orders-Grouping",
"compliance_spec": [
{
"can_delete": true,
"created_at": 1707378190,
"created_by": "username@rightrev.com",
"groupings": [
{
"fields": [
"customer_name",
"order_number"
]
}
],
"is_user_defined": true,
"name": "orders_grouping_1",
"updated_at": 1759141173,
"updated_by": "username@rightrev.com"
}
],
"created_by": "username@rightrev.com",
"created_on": 1707378190,
"last_modified_by": "username@rightrev.com",
"last_modified_on": 1759141173,
"policy_type": "orders-group",
"status": "Active",
"unique_key": "name",
"version_id": "2229e08c-e8ca-4ab1-a005-4d2a0cdd061a"
}
]Create a new Order Group policy in the RightRev system.
Users must select at least one identifier and maximum of five identifiers to create a order group policy.
JSON format.
Provide compliance name to create an order group policy pertaining to that compliance name.
Name of the order group policy.
Set Orders Group Policy
Provide compliance id to create order group policy pertaining to that compliance id.
Displays information about problems that occurred while handling the request. Commonly used to report validation errors, missing or invalid parameters, or other issues related to API processing.
POST /apis/policy-sets/v1/policy/orders-group HTTP/1.1
Host: {realm}.{env}.rightrev.cloud/
Content-Type: application/json
Accept: */*
Content-Length: 185
{
"compliance_spec": [
{
"name": "orders_grouping_1",
"groupings": [
{
"fields": [
"customer_name",
"order_number"
]
}
]
}
],
"format_type": "json",
"compliance_name": "Orders-Grouping",
"unique_key": "name"
}Set Orders Group Policy
{
"compliance_details": [
{
"error": [],
"message": "created successfully",
"unique_key": "orders_grouping_1"
}
],
"compliance_id": "49807459-e583-4d72-a651-29d1683226a8",
"error": []
}Update the Orders Group policy in the RightRev system.
User has to provide a compliance id to update orders group. This compliance id can be fetched from the response of the Orders Group Policy - GET API.
Format of the payload. For e.g. JSON.
Name of the Policy.
Name of the grouping policy.
Update Orders Group Policy
A system-generated compliance ID to update orders group.
Displays information about problems that occurred while handling the request. Commonly used to report validation errors, missing or invalid parameters, or other issues related to API processing.
PATCH /apis/policy-sets/v1/policy/orders-group/{compliance_id} HTTP/1.1
Host: {realm}.{env}.rightrev.cloud/
Content-Type: application/json
Accept: */*
Content-Length: 169
{
"compliance_spec": [
{
"name": "orders_grouping_1",
"groupings": [
{
"fields": [
"order_number"
]
}
]
}
],
"format_type": "json",
"compliance_name": "Orders-Grouping",
"unique_key": "name"
}Update Orders Group Policy
{
"compliance_details": [
{
"error": [],
"message": "created successfully",
"unique_key": "orders_grouping_1"
}
],
"compliance_id": "0414888d-546c-47a0-9d2f-cb2834b3f05b",
"error": []
}Last updated
Was this helpful?