API Reference / Predefined Item Groups

GET /predefined_item_groups/{predefined_item_group_id}

Get a specific predefined item group

Returns one predefined item group with the items it bundles. Its cost and price are the totals of its member items, and subcount is the number of item IDs the group holds.

Path parameters

Name Type Description
predefined_item_group_id req string Predefined Item Group ID

Responses

200 OK
  • statusintegerint32

    Response code

  • messagestring

    Response message

  • timestampintegerunix-timestamp

    Response time

  • dataobject
    object fields →
    • predefined_item_groupobject

      A grouping of predefined/deal items. Useful if items can be sold as part of a package or compliment one another

      object fields →
      • idstringbson-id

        ID of the predefined item group

      • namestring

        Name of the predefined item group

      • positionintegerint32

        Position of the group in the list of predefined item groups

      • countintegerint32

        Number 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.

Related guides