API Reference / Predefined Item Groups
/predefined_item_groups Get the list of predefined item groups (for the logged API user's account)
Returns the account's predefined item groups. A group bundles predefined items under one name, and its cost and price are the sums of its members. Pass include_items to embed the items themselves.
Maintained by the OnePageCRM engineering team
Responses
200 OK
statusintegerint32Response code
messagestringResponse message
timestampintegerunix-timestampResponse time
dataobjectobject fields →
predefined_item_groupsarray<object>array item fields →
predefined_item_groupobjectA grouping of predefined/deal items. Useful if items can be sold as part of a package or compliment one another
object fields →
idstringbson-idID of the predefined item group
namestringName of the predefined item group
positionintegerint32Position of the group in the list of predefined item groups
countintegerint32Number of predefined items in the predefined item group
item_idsarray<string>List of IDs of the predefined/deal items in the predefined item group
Standard error responses: 400 · 401 · 403 · 404 · 409 · 500 — shared across the API. See Errors.