Create Request
Create a new request.
Query parameters
languagestringOptional
Body
externalIdstring | nullableOptional
namestring · min: 1 · max: 1000Required
statusstring · min: 1Required
fromall ofRequired
requesterall ofOptional
assigneeall ofOptional
toall ofRequired
productall ofOptional
Responses
201
Created
application/json
400
Bad Request
application/json
post
POST /public/v1/commerce/requests HTTP/1.1
Host: api.s1.today
Content-Type: application/json
Accept: */*
Content-Length: 229
{
"externalId": "text",
"name": "text",
"status": "text",
"from": {
"id": "text"
},
"requester": {
"id": "text"
},
"assignee": {
"id": "text"
},
"to": {
"id": "text"
},
"product": {
"id": "text"
},
"parameters": [
{
"parameterDefinitionId": "text",
"value": "text"
}
]
}{
"id": "text",
"audit": {
"created": {
"at": "2025-08-09T14:20:34.513Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-08-09T14:20:34.513Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"externalId": "text",
"name": "text",
"status": "text",
"error": "text",
"from": {
"id": "text",
"icon": "text",
"type": "Client",
"status": "Active",
"name": "text"
},
"requester": {
"id": "text",
"icon": "text",
"name": "text"
},
"assignee": {
"id": "text",
"icon": "text",
"name": "text"
},
"to": {
"id": "text",
"icon": "text",
"type": "Client",
"status": "Active",
"name": "text"
},
"product": {
"id": "text",
"name": "text",
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"icon": "text",
"status": "text"
},
"parameters": [
{
"id": "text",
"audit": {
"created": {
"at": "2025-08-09T14:20:34.513Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-08-09T14:20:34.513Z",
"by": "[Circular Reference]"
}
},
"externalId": "text",
"title": "text",
"description": "text",
"value": "text",
"displayOrder": 1,
"constraints": {
"isReadonly": true,
"isOptional": true
},
"typeOptions": null,
"errorMessage": "text",
"errorCode": "text",
"request": {
"id": "text",
"audit": {
"created": {
"at": "2025-08-09T14:20:34.513Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-08-09T14:20:34.513Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"externalId": "text",
"name": "text",
"status": "text",
"error": "text",
"from": {
"id": "text",
"icon": "text",
"type": "Client",
"status": "Active",
"name": "text"
},
"requester": {
"id": "text",
"icon": "text",
"name": "text"
},
"assignee": {
"id": "text",
"icon": "text",
"name": "text"
},
"to": {
"id": "text",
"icon": "text",
"type": "Client",
"status": "Active",
"name": "text"
},
"product": {
"id": "text",
"name": "text",
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"icon": "text",
"status": "text"
},
"parameters": [
"[Circular Reference]"
],
"messages": [
"[Circular Reference]"
]
}
}
],
"messages": [
{
"id": "text",
"audit": {
"created": {
"at": "2025-08-09T14:20:34.513Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-08-09T14:20:34.513Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"visibility": {
"client": true,
"operations": true,
"vendor": true
},
"account": {
"id": "text",
"icon": "text",
"type": "Client",
"status": "Active",
"name": "text"
},
"type": "text",
"content": "text",
"request": {
"id": "text",
"audit": {
"created": {
"at": "2025-08-09T14:20:34.513Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-08-09T14:20:34.513Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"externalId": "text",
"name": "text",
"status": "text",
"error": "text",
"from": {
"id": "text",
"icon": "text",
"type": "Client",
"status": "Active",
"name": "text"
},
"requester": {
"id": "text",
"icon": "text",
"name": "text"
},
"assignee": {
"id": "text",
"icon": "text",
"name": "text"
},
"to": {
"id": "text",
"icon": "text",
"type": "Client",
"status": "Active",
"name": "text"
},
"product": {
"id": "text",
"name": "text",
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"icon": "text",
"status": "text"
},
"parameters": [
{
"id": "text",
"audit": {
"created": {
"at": "2025-08-09T14:20:34.513Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-08-09T14:20:34.513Z",
"by": "[Circular Reference]"
}
},
"externalId": "text",
"title": "text",
"description": "text",
"value": "text",
"displayOrder": 1,
"constraints": {
"isReadonly": true,
"isOptional": true
},
"typeOptions": null,
"errorMessage": "text",
"errorCode": "text",
"request": {
"id": "text",
"audit": {
"created": {
"at": "2025-08-09T14:20:34.513Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-08-09T14:20:34.513Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"externalId": "text",
"name": "text",
"status": "text",
"error": "text",
"from": {
"id": "text",
"icon": "text",
"type": "Client",
"status": "Active",
"name": "text"
},
"requester": {
"id": "text",
"icon": "text",
"name": "text"
},
"assignee": {
"id": "text",
"icon": "text",
"name": "text"
},
"to": {
"id": "text",
"icon": "text",
"type": "Client",
"status": "Active",
"name": "text"
},
"product": {
"id": "text",
"name": "text",
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"icon": "text",
"status": "text"
},
"parameters": [
"[Circular Reference]"
],
"messages": [
"[Circular Reference]"
]
}
}
],
"messages": [
"[Circular Reference]"
]
}
}
]
}Last updated
Was this helpful?