> For the complete documentation index, see [llms.txt](https://docs.platform.softwareone.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.platform.softwareone.com/developer-resources/rest-api/commerce-api/requests.md). # Request The Request object contains the following properties:
FieldTypeDescription
idstring(Read-only) The primary identifier for the request.
statusstringThe status of the request.
clientobjectRepresents the client accountobject.
vendorobjectRepresents the vendor account object
requesterobjectThe client account user who created the request.
assigneeobject(Optional) The vendor account user responsible for processing the request.
productobjectRepresents the product object.
externalIdsobject(Optional) A set of externalID identifiers.
parameters.orderobject

(Optional) Values of the orderParameter associated with the request.

Example:

[
  {
    "id": "PRM-1234-1234-1234-1234",
    "name": "Tennant Id",
    "externalId": "tenant_id",
    "constraints": { ... },
    "value": "69b73824-ce76-4866-ad47-b615ae9d8998",
  }
]
errorobject

Error reported by validation procedure.

Example:

{
     "id": "E001234",
     "message": "Agreement provisioning failed due to unavailability of the item"
}
auditobject(Read-only) Represents the audit object.
## Examples {% tabs %} {% tab title="MINIMAL EXAMPLE" %} {% code title="REQUEST OBJECT" overflow="wrap" lineNumbers="true" %} ```json { "id": "REQ-1671-0642", "status": "Querying", "client": { "id": "ACC-1234-4444", "name": "Rolls-Royce" }, "vendor": { "id": "ACC-1234-1111", "name": "Microsoft" }, "requester": { "id": "USR-1234-4444", "name": "John Smith" }, "assignee": { "id": "USR-1234-1111", "name": "Santa Claus" }, "product": { "id": "PRD-1111-1111-1111", "name": "Microsoft Office 365 NCE", "icon": "/static/PRD-1111-1111-1111/logo.png" } } ``` {% endcode %} {% endtab %} {% tab title="COMPLETE EXAMPLE" %} {% code title="REQUEST OBJECT" overflow="wrap" lineNumbers="true" %} ```json { "id": "REQ-1671-0642", "status": "Querying", "client": { "id": "ACC-1234-4444", "name": "Stark-industries" }, "vendor": { "id": "ACC-1234-1111", "name": "Microsoft" }, "requester": { "id": "USR-1234-4444", "name": "John Smith" }, "assignee": { "id": "USR-1234-1111", "name": "Santa Claus" }, "product": { "id": "PRD-1111-1111-1111", "name": "Microsoft Office 365 NCE", "icon": "/static/PRD-1111-1111-1111/logo.png" }, "externalIds": { "client": "12345678", "operations": "07bf766b-c767-4293-9ab3", "vendor": "ABC-2023-C07-dbeee0b302c0" }, "audit": { "created": { "at": "2023-12-14T17:28:57.667Z", "by": { "id": "USR-1234-1234", "name": "John Smith" } }, "updated": { "at": "2023-12-14T17:28:57.667Z", "by": { "id": "USR-1234-1234", "name": "John Smith" } } } } ``` {% endcode %} {% endtab %} {% endtabs %} --- # 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 by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://docs.platform.softwareone.com/developer-resources/rest-api/commerce-api/requests.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. 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.