Requests

The Request object contains the following properties:

Field	Type	Description
id	string	Primary identifier for the request. Example: REQ-1671-0642
href	string	Relative reference to the object in the API. Example: /v1/commerce/requests/REQ-1671-0642
status	string	The status of the request. Example: Querying
client	account	A reference to the client account object. Example: { "id": "ACC-1234-4444", "name": "stark industries" }
vendor	account	A reference to the vendor account object. Example: { "id": "ACC-1234-1111", "name": "Microsoft" }
requester	user	The client account user who created the request. Example: { "id": "USR-1234-4444", "name": "John Smith" }
assignee	user	The vendor account user responsible for processing the request. Example: { "id": "USR-1234-1111", "name": "Santa Claus" }
product	product	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" }
externalIds	object	A set of external ID identifiers. Example: { "client": "12345678", "operations": "07bf766b-c767-4293-9ab3", "vendor": "ABC-2023-C07-dbeee0b302c0" }
parameters.order	orderParameter	The values of the ordering parameters associated with the request. Example: [ { "id": "PRM-1234-1234-1234-1234", "name": "Tennant Id", "externalId": "tenant_id", "constraints": { ... }, "value": "69b73824-ce76-4866-ad47-b615ae9d8998", } ]
error	errorObject	Error reported by validation procedure. Example: { "id": "E001234", "message": "Agreement provisioning failed due to unavailability of the item" }
audit	audit	A reference to the Audit object. Possible values: Created, Updated, Activated, Terminated . Example: { "created": { "at": "...", "by": { } }, "updated": { "at": "...", "by": { } } }

Example

SHORT FORM

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

FULL EXAMPLE

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