Create Product Parameter
Create a product parameter.
POST/v1/catalog/products/{productId}/parameters
Path parameters
productId*string
Body
scope*enum
AgreementItemRequestSubscription
phase*enum
ConfigurationOrderFulfillment
name*string
description*string
externalIdnullable string
displayOrder*integer (int32)
constraints*ParameterConstraintsInput (object)
type*enum
SingleLineTextMultiLineTextAddressContactCheckboxChoiceSubdomainHeadingDropDownEmailDataObjectDate
optionsobject
groupRequestObjectLink (object)
Response
Created
Body
idstring
auditQueryModelAudit (object)
$metaQueryModelMetadata (object)
hrefstring
namestring
descriptionstring
groupParameterGroupQueryModel (object)
scopeenum
AgreementItemRequestSubscription
phaseenum
ConfigurationOrderFulfillment
externalIdnullable string
displayOrderinteger (int32)
constraintsConstraints (object)
productProductQueryModel (object)
optionsobject
typeenum
SingleLineTextMultiLineTextAddressContactCheckboxChoiceSubdomainHeadingDropDownEmailDataObjectDate
statusstring
Request
const response = await fetch('/v1/catalog/products/{productId}/parameters', {
method: 'POST',
headers: {
"Content-Type": "application/json"
},
body: JSON.stringify({
"constraints": {},
"description": "text",
"displayOrder": 0,
"name": "text",
"phase": "Configuration",
"scope": "Agreement",
"type": "SingleLineText"
}),
});
const data = await response.json();Response
{
"id": "text",
"audit": {
"created": {
"at": "2025-01-23T21:03:56.038Z",
"by": {
"id": "text",
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-01-23T21:03:56.038Z",
"by": {
"id": "text",
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"description": "text",
"group": {
"id": "text",
"audit": {
"created": {
"at": "2025-01-23T21:03:56.038Z",
"by": {
"id": "text",
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-01-23T21:03:56.038Z",
"by": {
"id": "text",
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"label": "text",
"description": "text",
"displayOrder": 0,
"default": false,
"parameterCount": 0,
"product": {
"id": "text",
"audit": {
"created": {
"at": "2025-01-23T21:03:56.038Z",
"by": {
"id": "text",
"audit": {},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-01-23T21:03:56.038Z",
"by": {
"id": "text",
"audit": {},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"published": {
"at": "2025-01-23T21:03:56.038Z",
"by": {
"id": "text",
"audit": {},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"pending": {
"at": "2025-01-23T21:03:56.038Z",
"by": {
"id": "text",
"audit": {},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"unpublished": {
"at": "2025-01-23T21:03:56.038Z",
"by": {
"id": "text",
"audit": {},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"shortDescription": "text",
"longDescription": "text",
"externalIds": {
"operations": "text"
},
"website": "text",
"icon": "text",
"status": "text",
"vendor": {
"id": "text",
"audit": {
"created": {
"at": "2025-01-23T21:03:56.038Z",
"by": {
"id": "text",
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-01-23T21:03:56.038Z",
"by": {
"id": "text",
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"externalId": "text",
"externalName": "text",
"type": "Client",
"status": "Active",
"serviceLevel": "Express",
"address": {
"addressLine1": "text",
"addressLine2": "text",
"postCode": "text",
"city": "text",
"state": "text",
"country": "text"
},
"icon": "text",
"technicalSupportEmail": "name@gmail.com",
"website": "text",
"description": "text",
"name": "text",
"groups": [
{
"id": "text",
"audit": {
"created": {
"at": "2025-01-23T21:03:56.038Z",
"by": {
"id": "text",
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-01-23T21:03:56.038Z",
"by": {
"id": "text",
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"description": "text",
"modules": [
{
"id": "text",
"audit": {
"created": {
"at": "2025-01-23T21:03:56.038Z",
"by": {
"id": "text",
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-01-23T21:03:56.038Z",
"by": {
"id": "text",
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"description": "text",
"name": "text",
"accountTypes": [
"text"
],
"filters": {
"group.buyers": [
"text"
]
},
"settings": {
"sharedAccount": false,
"configurable": false,
"default": false,
"paid": false,
"type": [
"text"
]
}
}
],
"logo": "text",
"isDefault": false,
"users": [
{
"id": "text",
"audit": {
"created": {
"at": "2025-01-23T21:03:56.038Z",
"by": {
"id": "text",
"audit": {},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-01-23T21:03:56.038Z",
"by": {
"id": "text",
"audit": {},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"invitationAcceptedAt": "2025-01-23T21:03:56.038Z"
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"email": "text",
"status": "text",
"phone": {
"prefix": "text",
"number": "text"
},
"firstName": "text",
"lastName": "text",
"icon": "text",
"lastLoginAt": "2025-01-23T21:03:56.038Z",
"settings": {
"cultureCode": "text",
"languageCode": "text"
},
"name": "text",
"accounts": []
}
],
"buyers": [
{
"id": "text",
"audit": {
"created": {
"at": "2025-01-23T21:03:56.038Z",
"by": {
"id": "text",
"audit": {},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-01-23T21:03:56.038Z",
"by": {
"id": "text",
"audit": {},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"activated": {
"at": "2025-01-23T21:03:56.038Z",
"by": {
"id": "text",
"audit": {},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"unassigned": {
"at": "2025-01-23T21:03:56.038Z",
"by": {
"id": "text",
"audit": {},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"contact": {
"name": "text",
"firstName": "text",
"lastName": "text",
"email": "name@gmail.com",
"phone": {
"prefix": "text",
"number": "text"
},
"user": {
"id": "text",
"audit": {
"created": {
"at": "2025-01-23T21:03:56.038Z",
"by": {
"id": "text",
"audit": {},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-01-23T21:03:56.038Z",
"by": {
"id": "text",
"audit": {},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"invitationAcceptedAt": "2025-01-23T21:03:56.038Z"
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"email": "text",
"status": "text",
"phone": {
"prefix": "text",
"number": "text"
},
"firstName": "text",
"lastName": "text",
"icon": "text",
"lastLoginAt": "2025-01-23T21:03:56.038Z",
"settings": {
"cultureCode": "text",
"languageCode": "text"
},
"name": "text",
"accounts": []
},
"type": "text"
},
"externalIds": {
"erpCompanyContact": "text",
"erpCustomer": "text",
"accountExternalId": "text"
},
"status": "Active",
"icon": "text",
"address": {
"addressLine1": "text",
"addressLine2": "text",
"postCode": "text",
"city": "text",
"state": "text",
"country": "text"
},
"taxId": "text",
"name": "text",
"errors": [
{
"id": "text",
"message": "text"
}
],
"sellers": [
{
"id": "text",
"audit": {
"created": {
"at": "2025-01-23T21:03:56.038Z",
"by": {
"id": "text",
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-01-23T21:03:56.038Z",
"by": {
"id": "text",
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"externalId": "text",
"status": "Active",
"icon": "text",
"currencies": [
"text"
],
"address": {
"addressLine1": "text",
"addressLine2": "text",
"postCode": "text",
"city": "text",
"state": "text",
"country": "text"
},
"name": "text"
}
]
}
]
}
]
},
"settings": {
"productOrdering": false,
"productRequests": {
"enabled": false,
"name": "text",
"label": "text"
},
"itemSelection": false,
"orderQueueChanges": false,
"preValidation": {
"purchaseOrderDraft": false,
"purchaseOrderQuerying": false,
"changeOrderDraft": false,
"terminationOrder": false,
"productRequest": false
},
"splitBilling": {
"enabled": false,
"type": "text"
}
},
"statistics": {
"itemCount": 0,
"ordersPlacedCount": 0,
"agreementCount": 0,
"subscriptionCount": 0,
"requestCount": 0
}
}
},
"scope": "Agreement",
"phase": "Configuration",
"externalId": "text",
"displayOrder": 0,
"constraints": {
"hidden": false,
"readonly": false,
"optional": false,
"required": false
},
"product": {
"id": "text",
"audit": {
"created": {
"at": "2025-01-23T21:03:56.038Z",
"by": {
"id": "text",
"audit": {},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-01-23T21:03:56.038Z",
"by": {
"id": "text",
"audit": {},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"published": {
"at": "2025-01-23T21:03:56.038Z",
"by": {
"id": "text",
"audit": {},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"pending": {
"at": "2025-01-23T21:03:56.038Z",
"by": {
"id": "text",
"audit": {},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"unpublished": {
"at": "2025-01-23T21:03:56.038Z",
"by": {
"id": "text",
"audit": {},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"shortDescription": "text",
"longDescription": "text",
"externalIds": {
"operations": "text"
},
"website": "text",
"icon": "text",
"status": "text",
"vendor": {
"id": "text",
"audit": {
"created": {
"at": "2025-01-23T21:03:56.038Z",
"by": {
"id": "text",
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-01-23T21:03:56.038Z",
"by": {
"id": "text",
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"externalId": "text",
"externalName": "text",
"type": "Client",
"status": "Active",
"serviceLevel": "Express",
"address": {
"addressLine1": "text",
"addressLine2": "text",
"postCode": "text",
"city": "text",
"state": "text",
"country": "text"
},
"icon": "text",
"technicalSupportEmail": "name@gmail.com",
"website": "text",
"description": "text",
"name": "text",
"groups": [
{
"id": "text",
"audit": {
"created": {
"at": "2025-01-23T21:03:56.038Z",
"by": {
"id": "text",
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-01-23T21:03:56.038Z",
"by": {
"id": "text",
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"description": "text",
"modules": [
{
"id": "text",
"audit": {
"created": {
"at": "2025-01-23T21:03:56.038Z",
"by": {
"id": "text",
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-01-23T21:03:56.038Z",
"by": {
"id": "text",
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"description": "text",
"name": "text",
"accountTypes": [
"text"
],
"filters": {
"group.buyers": [
"text"
]
},
"settings": {
"sharedAccount": false,
"configurable": false,
"default": false,
"paid": false,
"type": [
"text"
]
}
}
],
"logo": "text",
"isDefault": false,
"users": [
{
"id": "text",
"audit": {
"created": {
"at": "2025-01-23T21:03:56.038Z",
"by": {
"id": "text",
"audit": {},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-01-23T21:03:56.038Z",
"by": {
"id": "text",
"audit": {},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"invitationAcceptedAt": "2025-01-23T21:03:56.038Z"
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"email": "text",
"status": "text",
"phone": {
"prefix": "text",
"number": "text"
},
"firstName": "text",
"lastName": "text",
"icon": "text",
"lastLoginAt": "2025-01-23T21:03:56.038Z",
"settings": {
"cultureCode": "text",
"languageCode": "text"
},
"name": "text",
"accounts": []
}
],
"buyers": [
{
"id": "text",
"audit": {
"created": {
"at": "2025-01-23T21:03:56.038Z",
"by": {
"id": "text",
"audit": {},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-01-23T21:03:56.038Z",
"by": {
"id": "text",
"audit": {},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"activated": {
"at": "2025-01-23T21:03:56.038Z",
"by": {
"id": "text",
"audit": {},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"unassigned": {
"at": "2025-01-23T21:03:56.038Z",
"by": {
"id": "text",
"audit": {},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"contact": {
"name": "text",
"firstName": "text",
"lastName": "text",
"email": "name@gmail.com",
"phone": {
"prefix": "text",
"number": "text"
},
"user": {
"id": "text",
"audit": {
"created": {
"at": "2025-01-23T21:03:56.038Z",
"by": {
"id": "text",
"audit": {},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-01-23T21:03:56.038Z",
"by": {
"id": "text",
"audit": {},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"invitationAcceptedAt": "2025-01-23T21:03:56.038Z"
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"email": "text",
"status": "text",
"phone": {
"prefix": "text",
"number": "text"
},
"firstName": "text",
"lastName": "text",
"icon": "text",
"lastLoginAt": "2025-01-23T21:03:56.038Z",
"settings": {
"cultureCode": "text",
"languageCode": "text"
},
"name": "text",
"accounts": []
},
"type": "text"
},
"externalIds": {
"erpCompanyContact": "text",
"erpCustomer": "text",
"accountExternalId": "text"
},
"status": "Active",
"icon": "text",
"address": {
"addressLine1": "text",
"addressLine2": "text",
"postCode": "text",
"city": "text",
"state": "text",
"country": "text"
},
"taxId": "text",
"name": "text",
"errors": [
{
"id": "text",
"message": "text"
}
],
"sellers": [
{
"id": "text",
"audit": {
"created": {
"at": "2025-01-23T21:03:56.038Z",
"by": {
"id": "text",
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-01-23T21:03:56.038Z",
"by": {
"id": "text",
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"externalId": "text",
"status": "Active",
"icon": "text",
"currencies": [
"text"
],
"address": {
"addressLine1": "text",
"addressLine2": "text",
"postCode": "text",
"city": "text",
"state": "text",
"country": "text"
},
"name": "text"
}
]
}
]
}
]
},
"settings": {
"productOrdering": false,
"productRequests": {
"enabled": false,
"name": "text",
"label": "text"
},
"itemSelection": false,
"orderQueueChanges": false,
"preValidation": {
"purchaseOrderDraft": false,
"purchaseOrderQuerying": false,
"changeOrderDraft": false,
"terminationOrder": false,
"productRequest": false
},
"splitBilling": {
"enabled": false,
"type": "text"
}
},
"statistics": {
"itemCount": 0,
"ordersPlacedCount": 0,
"agreementCount": 0,
"subscriptionCount": 0,
"requestCount": 0
}
},
"options": {
"hintText": "text",
"defaultValue": "None"
},
"type": "SingleLineText",
"status": "text"
}Last updated