Items represent individual physical resources that your organization owns or uses, like equipment, props, costumes, tables, or chairs.
ItemSets represent logical groupings of Items that are nearly identical, like a set of body mics or a set of upholstered chairs. An individual Item, like a grand piano, will still be contained within an ItemSet.
Create an ItemSet
Creates an ItemSet and its associated Items based on the provided fields. Items are always created as part of an ItemSet.
Request Body
orgIdstring · uuid · requiredThe id of the
Organizationthat owns thisItemSet.namestring · requiredThe name of the
ItemSet.colorstring · requiredHex color code (without #).
pricesobject · requiredA map of
PriceTierids to prices.itemsobject[] · requiredThe
Itemsto create within thisItemSet.
photoIdstring · uuidThe UUID of an image stored in Cloudflare Images.
detailsstring · htmlSupports basic HTML tags and formatting.
fileIdsstring[]The ids of
Filesattached to thisItemSet.tagIdsstring[]The ids of
Tagsattached to thisItemSet.
Responses
The newly created ItemSet and its Items.
itemSetobjectitemsobjectA map of
Itemids toItems.
Update an ItemSet
Updates the specified ItemSet and its Items by setting the values of the fields passed. Any fields not provided will be left unchanged. By design, you cannot change an ItemSet's id.
You can add new Items to the ItemSet by including them in the createdItems field, update existing Items by including them in the updatedItems field, and remove Items by including their ids in the deletedItemIds field.
path Parameters
itemSetIdstring · uuid · requiredThe id of the
ItemSet.
Request Body
namestringThe name of the
ItemSet.colorstringHex color code (without #).
photoIdstring · uuidThe UUID of an image stored in Cloudflare Images.
pricesobjectA map of
PriceTierids to prices.detailsstring · htmlSupports basic HTML tags and formatting.
fileIdsstring[]The ids of
Filesattached to thisItemSet.tagIdsstring[]The ids of
Tagsattached to thisItemSet.createdItemsobject[]New
Itemsto create within thisItemSet.itemUpdatesobjectA map of
Itemids to update objects for existingItems.deletedItemIdsstring[]The ids of
Itemsto delete from thisItemSet.
Responses
The updated ItemSet and its Items.
itemSetobjectitemsobjectA map of
Itemids toItems.