Create Item
post
/v1/catalog/items
Body
productobject
namestring
descriptionstring
externalIdsobjectrequired
groupobjectrequired
unitobjectrequired
termsobjectrequired
quantityNotApplicableboolean
parametersobject[] | nullable
Responses
application/json
application/json
application/json
cURL
JavaScript
Python
HTTP
curl -L \
--request POST \
--url '/v1/catalog/items' \
--header 'Content-Type: application/json' \
--data '{"product":{},"externalIds":{},"group":{},"unit":{},"terms":{"period":"1m","commitment":"1m"},"parameters":[{}]}'201
400
403
500
{
"id": "text",
"audit": {
"created": {
"at": "2025-02-21T18:07:54.147Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-21T18:07:54.147Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-21T18:07:54.147Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-02-21T18:07:54.147Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-21T18:07:54.147Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-21T18:07:54.147Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"published": {
"at": "2025-02-21T18:07:54.147Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-21T18:07:54.147Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-21T18:07:54.147Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"unpublished": {
"at": "2025-02-21T18:07:54.147Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-21T18:07:54.147Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-21T18:07:54.147Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"description": "text",
"externalIds": {
"vendor": "text",
"operations": "text"
},
"group": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-21T18:07:54.147Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-21T18:07:54.147Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"label": "text",
"description": "text",
"displayOrder": 1,
"default": true,
"multiple": true,
"required": true,
"itemCount": 1,
"product": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-21T18:07:54.147Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-21T18:07:54.147Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-21T18:07:54.147Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-02-21T18:07:54.147Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-21T18:07:54.147Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-21T18:07:54.147Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"published": {
"at": "2025-02-21T18:07:54.147Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-21T18:07:54.147Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-21T18:07:54.147Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"pending": {
"at": "2025-02-21T18:07:54.147Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-21T18:07:54.147Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-21T18:07:54.147Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"unpublished": {
"at": "2025-02-21T18:07:54.147Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-21T18:07:54.147Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-21T18:07:54.147Z",
"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-21T18:07:54.147Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-21T18:07:54.147Z",
"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
}
}
},
"unit": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-21T18:07:54.147Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-21T18:07:54.147Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"description": "text",
"name": "text",
"statistics": {
"itemCount": 1
}
},
"terms": {
"period": "1m",
"commitment": "1m"
},
"quantityNotApplicable": true,
"status": "text",
"product": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-21T18:07:54.147Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-21T18:07:54.147Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-21T18:07:54.147Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-02-21T18:07:54.147Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-21T18:07:54.147Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-21T18:07:54.147Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"published": {
"at": "2025-02-21T18:07:54.147Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-21T18:07:54.147Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-21T18:07:54.147Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"pending": {
"at": "2025-02-21T18:07:54.147Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-21T18:07:54.147Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-21T18:07:54.147Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"unpublished": {
"at": "2025-02-21T18:07:54.147Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-21T18:07:54.147Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-21T18:07:54.147Z",
"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-21T18:07:54.147Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-21T18:07:54.147Z",
"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
}
},
"parameters": [
{
"value": null,
"id": "text",
"externalId": "text",
"type": "text",
"name": "text",
"displayValue": "text"
}
]
}Created
Last updated
Was this helpful?