> For the complete documentation index, see [llms.txt](https://apis.rightrev.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://apis.rightrev.com/rightrev-rest-api/transactions-ingestion/order-ingestion-configuration.md).
# Order Ingestion Configuration
## Get Orders Policy
> This API is used to retrieve all the Order Ingestion Configuration Policy details.
```json
{"openapi":"3.1.0","info":{"title":"RightRev API(s)","version":"1.0.0"},"servers":[{"description":"RightRev APP Server","url":"https://{realm}.{env}.rightrev.cloud/","variables":{"env":{"default":"{env}"},"realm":{"default":"{realm}"}}},{"description":"RightRev Auth Server","url":"https://authn.{env}.rightrev.cloud/auth/realms/{realm}/protocol/openid-connect/","variables":{"env":{"default":"{env}"},"realm":{"default":"{realm}"}}}],"security":[],"paths":{"/apis/policy-sets/v1/policy/orders":{"get":{"description":"This API is used to retrieve all the Order Ingestion Configuration Policy details.\n","responses":{"200":{"description":"Get Order Ingestion Configuration Policy","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"compliance_id":{"type":"string","description":"A system-generated compliance ID to retrieve the Order Ingestion Configuration Policy details."},"compliance_name":{"type":"string","description":"Name of the Policy"},"compliance_spec":{"type":"array","items":{"type":"object","properties":{"columns":{"type":"array","items":{"type":"object","properties":{"can_delete":{"type":"boolean","description":"A boolean field indicating whether the policy can be deleted or not. If set to True, the user is allowed to delete the policy; if False, deletion is not permitted."},"created_at":{"type":"integer","description":"Timestamp of the policy created by the user. This is a unix Epoch timestamp format."},"created_by":{"type":"string","description":"ID of the user who created the policy. Example: username@rightrev.com"},"field_desc":{"type":"string","description":"Description of the field."},"guid":{"type":"string","description":"Globally unique identifier generated by the system."},"is_user_defined":{"type":"boolean","description":"A boolean field indicating whether the policy is defined by the user or not. If set to True, the user is allowed to define the policy; if False, defining the policy is not permitted."},"label_caption":{"type":"string","description":"Cation of the field"},"label_default":{"type":"string","description":"name of the field"},"mandatory":{"type":"boolean","description":"Is this field mandatory or not."},"maps_to":{"type":"string","description":"Mapped to which field in system."},"name":{"type":"string","description":"Name of the field."},"searchable":{"type":"string","description":"Is this field searchable or not"},"type":{"type":"string","description":"Data Type of the field"},"updated_at":{"type":"integer","description":"Timestamp of the policy updated by the user. This is a unix Epoch timestamp format."},"updated_by":{"type":"string","description":"ID of the user who updated the policy. Example: username@rightrev.com"},"usedin_policies":{"type":"boolean","description":"A boolean field indicating whether this field is consumed in policies or not."}},"required":["can_delete","created_at","created_by","field_desc","guid","is_user_defined","label_caption","label_default","mandatory","maps_to","name","searchable","type","updated_at","updated_by","usedin_policies"]},"description":"All available fields in order ingestion policy. "},"description":{"type":"string","description":"Ingestion Template Data"},"name":{"type":"string","description":"Ingestion_Data"}},"required":["columns","description","name"]},"description":"Defines the specific rules and standards where a system must process adhering to the compliant."},"created_by":{"type":"string","description":"ID of the user who created the policy. Example: username@rightrev.com"},"created_on":{"type":"integer","description":"Timestamp of the policy created by the user. This is a unix Epoch timestamp format."},"last_modified_by":{"type":"string","description":"ID of the user last modified by."},"last_modified_on":{"type":"integer","description":"Timestamp of the policy last modified on. This is a unix Epoch timestamp format."},"last_used":{"type":"integer","description":"Timestamp of the policy last used on. This is a unix Epoch timestamp format."},"policy_type":{"type":"string","description":"It should be orders"},"status":{"type":"string","description":"Status of policy."},"unique_key":{"type":"string","description":"It's GUID. Globally unique identifier generated by the system."},"version_id":{"type":"null","description":"Represents the latest version of the policy."}},"required":["compliance_id","compliance_name","compliance_spec","created_by","created_on","last_modified_by","last_modified_on","last_used","policy_type","status","unique_key","version_id"]}}}}}},"tags":["Policy Sets"],"summary":"Get Orders Policy","operationId":"get_orders_policy_apis_policy_sets_v1_policy_orders_get"}}}}
```
## Update Orders Policy
> This API is used to create new fields or update existing fields in the Order Ingestion Configuration Policy.
```json
{"openapi":"3.1.0","info":{"title":"RightRev API(s)","version":"1.0.0"},"servers":[{"description":"RightRev APP Server","url":"https://{realm}.{env}.rightrev.cloud/","variables":{"env":{"default":"{env}"},"realm":{"default":"{realm}"}}},{"description":"RightRev Auth Server","url":"https://authn.{env}.rightrev.cloud/auth/realms/{realm}/protocol/openid-connect/","variables":{"env":{"default":"{env}"},"realm":{"default":"{realm}"}}}],"security":[],"paths":{"/apis/policy-sets/v1/policy/orders/{compliance_id}":{"patch":{"description":"This API is used to create new fields or update existing fields in the Order Ingestion Configuration Policy.\n","parameters":[{"name":"compliance_id","in":"path","required":true,"schema":{"type":"string","title":"Compliance Id"},"description":"Provide compliance id to retrieve an order ingestion policy details pertaining to that compliance id. Example :abc_123\n"}],"responses":{"200":{"description":"Create New or Update orders Policy","content":{"application/json":{"schema":{"type":"object","properties":{"compliance_details":{"type":"array","items":{"type":"object","properties":{"error":{"type":"array","description":"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."},"message":{"type":"string","description":"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."},"unique_key":{"type":"string","description":"Unique identifier generated by the system. Example: xyz_345"}},"required":["error","message","unique_key"]},"description":"Displays the details of specific rules and standards processed by the system."},"compliance_id":{"type":"string","description":"A system-generated compliance ID on creating or updating the policy."},"error":{"type":"array","description":"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."}},"required":["compliance_details","compliance_id","error"]}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"compliance_spec":{"type":"array","items":{"type":"object","properties":{"columns":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the field user want to create or update."},"type":{"type":"string","description":"Data type of the field. For e.g. String, Boolean etc."},"maps_to":{"type":"string","description":"If user want to map this field to seeded field then name of the field, else keep it blank."},"label_caption":{"type":"string","description":"label caption of the field."},"label_default":{"type":"string","description":"Label of the field"},"field_desc":{"type":"string","description":"Description the field"},"searchable":{"type":"boolean","description":"A boolean field indicating this field is searchable or not."},"usedin_policies":{"type":"null","description":"If this field is used in policies or not."},"mandatory":{"type":"boolean","description":"A boolean field indicating this field is mandatory or not."},"can_delete":{"type":"boolean","description":"A boolean field indicating whether the policy can be deleted or not. If set to True, the user is allowed to delete the policy; if False, deletion is not permitted."},"is_user_defined":{"type":"boolean","description":"A boolean field indicating whether the policy is defined by the user or not. If set to True, the user is allowed to define the policy; if False, defining the policy is not permitted."},"guid":{"type":"string","description":"Globally unique identifier generated by the system."}},"required":["can_delete","field_desc","guid","is_user_defined","label_caption","label_default","mandatory","maps_to","name","searchable","type","usedin_policies"]},"description":"Ingestion Template Data"},"name":{"type":"string","description":"Ingestion_Data"},"description":{"type":"string","description":"Ingestion Template Data"}},"required":["columns","description","name"]},"description":"Defines the specific rules and standards where a system must process adhering to the compliant."},"format_type":{"type":"string","description":"Format of the data. For e.g. JSON"},"compliance_name":{"type":"string","description":"Name of the Policy. Policy Orders"},"unique_key":{"type":"string","description":"It's GUID. Globally unique identifier generated by the system."}},"required":["compliance_name","compliance_spec","format_type","unique_key"]}}},"required":true},"tags":["Policy Sets"],"summary":"Update Orders Policy","operationId":"update_orders_policy_apis_policy_sets_v1_policy_orders__compliance_id__patch"}}}}
```
## Delete Orders Policy
> This API is used to delete the fields in the Order Ingestion Configuration Policy.
```json
{"openapi":"3.1.0","info":{"title":"RightRev API(s)","version":"1.0.0"},"servers":[{"description":"RightRev APP Server","url":"https://{realm}.{env}.rightrev.cloud/","variables":{"env":{"default":"{env}"},"realm":{"default":"{realm}"}}},{"description":"RightRev Auth Server","url":"https://authn.{env}.rightrev.cloud/auth/realms/{realm}/protocol/openid-connect/","variables":{"env":{"default":"{env}"},"realm":{"default":"{realm}"}}}],"security":[],"paths":{"/apis/policy-sets/v1/policy/orders/{compliance_id}/{object_unique_value}":{"delete":{"description":"This API is used to delete the fields in the Order Ingestion Configuration Policy.\n","parameters":[{"name":"compliance_id","in":"path","required":true,"schema":{"type":"string","title":"Compliance Id"},"description":"Provide compliance id to delete an order ingestion policy details pertaining to that compliance id. Example :abc_123\n"},{"name":"object_unique_value","in":"path","required":true,"schema":{"type":"string","title":"Object Unique Value"},"description":"It's GUID. Globally unique identifier generated by the system\n"}],"responses":{"200":{"description":"Delete orders Policy","content":{"application/json":{"schema":{"type":"object","properties":{"compliance_details":{"type":"array","description":"Displays the details of specific rules and standards processed by the system."},"compliance_id":{"type":"string","description":" A system-generated compliance ID on deleting the policy"},"error":{"type":"array","description":"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."}},"required":["compliance_details","compliance_id","error"]}}}}},"tags":["Policy Sets"],"summary":"Delete Orders Policy","operationId":"delete_orders_policy_apis_policy_sets_v1_policy_orders__compliance_id___object_unique_value__delete"}}}}
```
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://apis.rightrev.com/rightrev-rest-api/transactions-ingestion/order-ingestion-configuration.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.