Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Create a product parameter.
Get a list of parameters for a product.
The following diagram shows the possible states a parameter may have in the Marketplace Platform and the transition between these states:
Idle
The parameter has been created as part of the product definition.
It can be used to collect data as part of the order, fulfillment, or configuration phases.
Deleted
The parameter no longer exists.
It's no longer part of the product definition and can't be used to collect data as part of the order, fulfillment, or configuration phases.
Update a product parameter definition.
Get a product parameter definition.
id
string
Platform generated ID.
Example: "PRD-1234-1234-1234"
href
string
Resource reference.
Example: "/v1/products/PRD-1234-1234-1234"
scope
string
Describes in which context parameter will be used.
Example: "Agreement"
phase
string
Described in which process it will be used.
Example: "Order"
type
string
Indicates which UI component will be used to capture information.
Example: "Email"
options
One of:
AddressOptions
CheckboxOptions
SingleLineTextOptions
MultiLineTextOptions
ChoiceOptions
AddressOptions
ContactOptions
SubdomainOptions
HeadingOptions
DropDownOptions
EmailOptions
DataObjectOptions
DateOptions
Are specific to a selected type and allow customization of UI component.
Example:
{
"label": "Client address",
"hintText": "please add your email",
"placeholderText": "someone@org.com",
"defaultValue": "none"
}constraints
ConstraintsObject
Used to specify characteristics of entire parameter, though it can have an impact of the validation of values too (i.e. turning on “Optional” will override any mandatory field within the UI components associated to the selected type.
group
Groups allow logical grouping of parameters, used by purchase wizard and represented as wizard step.
externalId
string
Used for programmatic processing, for example as a variable name within embedding templates or within a “connector” process.
Example: "EXT-1234-1234"
{
"scope": "Agreement",
"phase": "Order",
"description": "Agreement identifier of the reseller",
"externalId": "RES-233-33-xx3",
"displayOrder": 100,
"constraints": {
"hidden": true,
"readonly": true,
"optional": false
},
"type": "SingleLineText",
"options": {
"name": "Aggreement Id",
"placeholderText": "AGR-xxx-xxx-xxx",
"hintText": "Add agreement id",
"minChar": 15,
"maxChar": 15,
"defaultValue": null
},
"group": { "id": PGR-7373-6782" }
}Delete a product parameter definition.
/v1/catalog/products/{productId}/parameters
Agreement, Item, Request, SubscriptionConfiguration, Order, FulfillmentSingleLineText, MultiLineText, Address, Contact, Checkbox, Choice, Subdomain, Heading, DropDown, Email, DataObject, Datecurl -L \
--request POST \
--url '/v1/catalog/products/{productId}/parameters' \
--header 'Content-Type: application/json' \
--data '{"name":"text","description":"text","displayOrder":1,"constraints":{},"group":{},"scope":"Agreement","phase":"Configuration","type":"SingleLineText","options":{"defaultValue":"None"}}'{
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T09:00:11.361Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"description": "text",
"group": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T09:00:11.361Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"label": "text",
"description": "text",
"displayOrder": 1,
"default": true,
"parameterCount": 1,
"product": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T09:00:11.361Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-02-22T09:00:11.361Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"published": {
"at": "2025-02-22T09:00:11.361Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"pending": {
"at": "2025-02-22T09:00:11.361Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"unpublished": {
"at": "2025-02-22T09:00:11.361Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
}
},
"$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-02-22T09:00:11.361Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"externalIds": {
"pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
},
"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": "hello@example.com",
"website": "text",
"description": "text",
"name": "text",
"groups": [
{
"id": "text",
"audit": "[Circular Reference]",
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"description": "text",
"account": "[Circular Reference]",
"logo": "text",
"isDefault": true,
"modules": "[Circular Reference]",
"users": "[Circular Reference]",
"buyers": "[Circular Reference]"
}
]
},
"settings": {
"productOrdering": true,
"productRequests": {
"enabled": true,
"name": "text",
"label": "text"
},
"itemSelection": true,
"orderQueueChanges": true,
"preValidation": {
"purchaseOrderDraft": true,
"purchaseOrderQuerying": true,
"changeOrderDraft": true,
"terminationOrder": true,
"productRequest": true
},
"splitBilling": {
"enabled": true,
"type": "text"
}
},
"statistics": {
"itemCount": 1,
"ordersPlacedCount": 1,
"agreementCount": 1,
"subscriptionCount": 1,
"requestCount": 1
}
}
},
"externalId": "text",
"displayOrder": 1,
"constraints": {
"hidden": true,
"readonly": true,
"optional": true,
"required": true
},
"product": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T09:00:11.361Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-02-22T09:00:11.361Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"published": {
"at": "2025-02-22T09:00:11.361Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"pending": {
"at": "2025-02-22T09:00:11.361Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"unpublished": {
"at": "2025-02-22T09:00:11.361Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
}
},
"$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-02-22T09:00:11.361Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"externalIds": {
"pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
},
"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": "hello@example.com",
"website": "text",
"description": "text",
"name": "text",
"groups": [
{
"id": "text",
"audit": "[Circular Reference]",
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"description": "text",
"account": "[Circular Reference]",
"logo": "text",
"isDefault": true,
"modules": "[Circular Reference]",
"users": "[Circular Reference]",
"buyers": "[Circular Reference]"
}
]
},
"settings": {
"productOrdering": true,
"productRequests": {
"enabled": true,
"name": "text",
"label": "text"
},
"itemSelection": true,
"orderQueueChanges": true,
"preValidation": {
"purchaseOrderDraft": true,
"purchaseOrderQuerying": true,
"changeOrderDraft": true,
"terminationOrder": true,
"productRequest": true
},
"splitBilling": {
"enabled": true,
"type": "text"
}
},
"statistics": {
"itemCount": 1,
"ordersPlacedCount": 1,
"agreementCount": 1,
"subscriptionCount": 1,
"requestCount": 1
}
},
"status": "text",
"scope": "Agreement",
"phase": "Configuration",
"type": "SingleLineText",
"options": {
"hintText": "text",
"defaultValue": "None"
}
}Created
/v1/catalog/products/{productId}/parameters
curl -L \
--url '/v1/catalog/products/{productId}/parameters'{
"$meta": {
"pagination": {
"offset": 1,
"limit": 1,
"total": 1
},
"omitted": [
"text"
]
},
"data": [
{
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T09:00:11.361Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"description": "text",
"group": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T09:00:11.361Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"label": "text",
"description": "text",
"displayOrder": 1,
"default": true,
"parameterCount": 1,
"product": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T09:00:11.361Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-02-22T09:00:11.361Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"published": {
"at": "2025-02-22T09:00:11.361Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"pending": {
"at": "2025-02-22T09:00:11.361Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"unpublished": {
"at": "2025-02-22T09:00:11.361Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
}
},
"$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-02-22T09:00:11.361Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"externalIds": {
"pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
},
"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": "hello@example.com",
"website": "text",
"description": "text",
"name": "text",
"groups": [
{
"id": "text",
"audit": "[Circular Reference]",
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"description": "text",
"account": "[Circular Reference]",
"logo": "text",
"isDefault": true,
"modules": "[Circular Reference]",
"users": "[Circular Reference]",
"buyers": "[Circular Reference]"
}
]
},
"settings": {
"productOrdering": true,
"productRequests": {
"enabled": true,
"name": "text",
"label": "text"
},
"itemSelection": true,
"orderQueueChanges": true,
"preValidation": {
"purchaseOrderDraft": true,
"purchaseOrderQuerying": true,
"changeOrderDraft": true,
"terminationOrder": true,
"productRequest": true
},
"splitBilling": {
"enabled": true,
"type": "text"
}
},
"statistics": {
"itemCount": 1,
"ordersPlacedCount": 1,
"agreementCount": 1,
"subscriptionCount": 1,
"requestCount": 1
}
}
},
"externalId": "text",
"displayOrder": 1,
"constraints": {
"hidden": true,
"readonly": true,
"optional": true,
"required": true
},
"product": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T09:00:11.361Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-02-22T09:00:11.361Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"published": {
"at": "2025-02-22T09:00:11.361Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"pending": {
"at": "2025-02-22T09:00:11.361Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"unpublished": {
"at": "2025-02-22T09:00:11.361Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
}
},
"$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-02-22T09:00:11.361Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"externalIds": {
"pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
},
"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": "hello@example.com",
"website": "text",
"description": "text",
"name": "text",
"groups": [
{
"id": "text",
"audit": "[Circular Reference]",
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"description": "text",
"account": "[Circular Reference]",
"logo": "text",
"isDefault": true,
"modules": "[Circular Reference]",
"users": "[Circular Reference]",
"buyers": "[Circular Reference]"
}
]
},
"settings": {
"productOrdering": true,
"productRequests": {
"enabled": true,
"name": "text",
"label": "text"
},
"itemSelection": true,
"orderQueueChanges": true,
"preValidation": {
"purchaseOrderDraft": true,
"purchaseOrderQuerying": true,
"changeOrderDraft": true,
"terminationOrder": true,
"productRequest": true
},
"splitBilling": {
"enabled": true,
"type": "text"
}
},
"statistics": {
"itemCount": 1,
"ordersPlacedCount": 1,
"agreementCount": 1,
"subscriptionCount": 1,
"requestCount": 1
}
},
"status": "text",
"scope": "Agreement",
"phase": "Configuration",
"type": "SingleLineText",
"options": {
"hintText": "text",
"defaultValue": "None"
}
}
]
}OK
/v1/catalog/products/{productId}/parameters/{id}
curl -L \
--request PUT \
--url '/v1/catalog/products/{productId}/parameters/{id}' \
--header 'Content-Type: application/json' \
--data '{"group":{},"options":{"defaultValue":"None"},"constraints":{}}'{
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T09:00:11.361Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"description": "text",
"group": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T09:00:11.361Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"label": "text",
"description": "text",
"displayOrder": 1,
"default": true,
"parameterCount": 1,
"product": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T09:00:11.361Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-02-22T09:00:11.361Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"published": {
"at": "2025-02-22T09:00:11.361Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"pending": {
"at": "2025-02-22T09:00:11.361Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"unpublished": {
"at": "2025-02-22T09:00:11.361Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
}
},
"$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-02-22T09:00:11.361Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"externalIds": {
"pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
},
"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": "hello@example.com",
"website": "text",
"description": "text",
"name": "text",
"groups": [
{
"id": "text",
"audit": "[Circular Reference]",
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"description": "text",
"account": "[Circular Reference]",
"logo": "text",
"isDefault": true,
"modules": "[Circular Reference]",
"users": "[Circular Reference]",
"buyers": "[Circular Reference]"
}
]
},
"settings": {
"productOrdering": true,
"productRequests": {
"enabled": true,
"name": "text",
"label": "text"
},
"itemSelection": true,
"orderQueueChanges": true,
"preValidation": {
"purchaseOrderDraft": true,
"purchaseOrderQuerying": true,
"changeOrderDraft": true,
"terminationOrder": true,
"productRequest": true
},
"splitBilling": {
"enabled": true,
"type": "text"
}
},
"statistics": {
"itemCount": 1,
"ordersPlacedCount": 1,
"agreementCount": 1,
"subscriptionCount": 1,
"requestCount": 1
}
}
},
"externalId": "text",
"displayOrder": 1,
"constraints": {
"hidden": true,
"readonly": true,
"optional": true,
"required": true
},
"product": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T09:00:11.361Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-02-22T09:00:11.361Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"published": {
"at": "2025-02-22T09:00:11.361Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"pending": {
"at": "2025-02-22T09:00:11.361Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"unpublished": {
"at": "2025-02-22T09:00:11.361Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
}
},
"$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-02-22T09:00:11.361Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"externalIds": {
"pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
},
"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": "hello@example.com",
"website": "text",
"description": "text",
"name": "text",
"groups": [
{
"id": "text",
"audit": "[Circular Reference]",
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"description": "text",
"account": "[Circular Reference]",
"logo": "text",
"isDefault": true,
"modules": "[Circular Reference]",
"users": "[Circular Reference]",
"buyers": "[Circular Reference]"
}
]
},
"settings": {
"productOrdering": true,
"productRequests": {
"enabled": true,
"name": "text",
"label": "text"
},
"itemSelection": true,
"orderQueueChanges": true,
"preValidation": {
"purchaseOrderDraft": true,
"purchaseOrderQuerying": true,
"changeOrderDraft": true,
"terminationOrder": true,
"productRequest": true
},
"splitBilling": {
"enabled": true,
"type": "text"
}
},
"statistics": {
"itemCount": 1,
"ordersPlacedCount": 1,
"agreementCount": 1,
"subscriptionCount": 1,
"requestCount": 1
}
},
"status": "text",
"scope": "Agreement",
"phase": "Configuration",
"type": "SingleLineText",
"options": {
"hintText": "text",
"defaultValue": "None"
}
}OK
/v1/catalog/products/{productId}/parameters/{id}
curl -L \
--url '/v1/catalog/products/{productId}/parameters/{id}'{
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T09:00:11.361Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"description": "text",
"group": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T09:00:11.361Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"label": "text",
"description": "text",
"displayOrder": 1,
"default": true,
"parameterCount": 1,
"product": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T09:00:11.361Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-02-22T09:00:11.361Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"published": {
"at": "2025-02-22T09:00:11.361Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"pending": {
"at": "2025-02-22T09:00:11.361Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"unpublished": {
"at": "2025-02-22T09:00:11.361Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
}
},
"$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-02-22T09:00:11.361Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"externalIds": {
"pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
},
"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": "hello@example.com",
"website": "text",
"description": "text",
"name": "text",
"groups": [
{
"id": "text",
"audit": "[Circular Reference]",
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"description": "text",
"account": "[Circular Reference]",
"logo": "text",
"isDefault": true,
"modules": "[Circular Reference]",
"users": "[Circular Reference]",
"buyers": "[Circular Reference]"
}
]
},
"settings": {
"productOrdering": true,
"productRequests": {
"enabled": true,
"name": "text",
"label": "text"
},
"itemSelection": true,
"orderQueueChanges": true,
"preValidation": {
"purchaseOrderDraft": true,
"purchaseOrderQuerying": true,
"changeOrderDraft": true,
"terminationOrder": true,
"productRequest": true
},
"splitBilling": {
"enabled": true,
"type": "text"
}
},
"statistics": {
"itemCount": 1,
"ordersPlacedCount": 1,
"agreementCount": 1,
"subscriptionCount": 1,
"requestCount": 1
}
}
},
"externalId": "text",
"displayOrder": 1,
"constraints": {
"hidden": true,
"readonly": true,
"optional": true,
"required": true
},
"product": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T09:00:11.361Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-02-22T09:00:11.361Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"published": {
"at": "2025-02-22T09:00:11.361Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"pending": {
"at": "2025-02-22T09:00:11.361Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"unpublished": {
"at": "2025-02-22T09:00:11.361Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
}
},
"$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-02-22T09:00:11.361Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-02-22T09:00:11.361Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"externalIds": {
"pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
},
"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": "hello@example.com",
"website": "text",
"description": "text",
"name": "text",
"groups": [
{
"id": "text",
"audit": "[Circular Reference]",
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"description": "text",
"account": "[Circular Reference]",
"logo": "text",
"isDefault": true,
"modules": "[Circular Reference]",
"users": "[Circular Reference]",
"buyers": "[Circular Reference]"
}
]
},
"settings": {
"productOrdering": true,
"productRequests": {
"enabled": true,
"name": "text",
"label": "text"
},
"itemSelection": true,
"orderQueueChanges": true,
"preValidation": {
"purchaseOrderDraft": true,
"purchaseOrderQuerying": true,
"changeOrderDraft": true,
"terminationOrder": true,
"productRequest": true
},
"splitBilling": {
"enabled": true,
"type": "text"
}
},
"statistics": {
"itemCount": 1,
"ordersPlacedCount": 1,
"agreementCount": 1,
"subscriptionCount": 1,
"requestCount": 1
}
},
"status": "text",
"scope": "Agreement",
"phase": "Configuration",
"type": "SingleLineText",
"options": {
"hintText": "text",
"defaultValue": "None"
}
}OK
/v1/catalog/products/{productId}/parameters/{id}
curl -L \
--request DELETE \
--url '/v1/catalog/products/{productId}/parameters/{id}'No body
No Content