# Request The Request object contains the following properties:
Field NameData TypeDescription
idstring

The primary identifier for the request.

Example: REQ-1671-0642

hrefstring

Relative reference to the object in the API.

Example: /v1/commerce/requests/REQ-1671-0642

statusstring

The status of the request.

Example: Querying

clientobject

A reference to the client accountobject.

Example:

{ 
  "id": "ACC-1234-4444",
  "name": "stark industries"
}
vendorobject

A reference to the vendor account object.

Example:

{ 
  "id": "ACC-1234-1111",
  "name": "Microsoft"
}
requesterobject

The client account user who created the request.

Example:

{ 
  "id": "USR-1234-4444",
  "name": "John Smith"
}
assigneeobject

The vendor account user responsible for processing the request.

Example:

{ 
  "id": "USR-1234-1111",
  "name": "Santa Claus"
}
productobject

A reference to the product object.

Example:

{
  "id": "PRD-1111-1111-1111",
  "name": "Microsoft Office 365 NCE",
  "icon": "/static/PRD-1111-1111-1111/logo.png"
}
externalIdsobject

A set of externalID identifiers.

Example:

{
  "client": "12345678",
  "operations":	"07bf766b-c767-4293-9ab3",
  "vendor": "ABC-2023-C07-dbeee0b302c0"
}
parameters.orderobject

The 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"
}
auditauditA reference to the audit object. Allowed values: created, updated, activated, or terminated .
## Example response {% tabs %} {% tab title="SHORT FORM" %} {% code 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" } } ``` {% endcode %} {% endtab %} {% tab title="FULL EXAMPLE" %} {% code 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: 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: ``` GET https://docs.platform.softwareone.com/developer-resources/rest-api/commerce-api/requests.md?ask= ``` The question should be specific, self-contained, and written in natural language. 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.