Bundle productsNew

#The bundle product object

Attributes

• idinteger
  Unique numeric identifier for the Bundle Product.
• delivery_cyclesobject
  An object containing the delivery cycle configuration of the Bundle Product.
• is_customizableboolean
  Whether customers can choose the contents of the bundle.
• layout_settingsobject
  An object containing the settings used to display the bundle to customers.
• layout_settings_versionstring
  The version of the format used by layout_settings.
• max_quantity_per_variantinteger · nullable
  The maximum quantity of a single item that can be selected in the bundle.
• price_rulestring · nullable
  How the price of the bundle is determined.
  Possible values

  dynamicfixed
• reset_box_contentsboolean
  Whether the contents of the bundle are reset after each order.
• settingsobject
  An object containing additional settings of the Bundle Product.
  Show child attributesHide child attributes3

  • display_variants_as_separate_products_in_listboolean
    Whether the variants of a product are listed as separate products when choosing the contents of the bundle.
  • dynamic_filter_products_by_discountboolean
    Whether discounts are calculated from the plan of the bundle product instead of from each product in the bundle.
  • show_product_and_variant_name_in_products_listboolean
    Whether both the product name and the variant name are shown when choosing the contents of the bundle.
• titlestring
  The title of the Bundle Product.
• variantsarray of objects
  An array of the variants of the Bundle Product.
  Show child attributesHide child attributes11

  • idinteger
    Unique numeric identifier for the bundle variant.
  • positioninteger
    The position in which the bundle variant is displayed.
  • updated_atdatetime
    The date and time when the bundle variant was last updated.
  • created_atdatetime
    The date and time when the bundle variant was created.
  • enabledboolean
    Whether the bundle variant is enabled.
  • external_variant_idstring
    The id of the variant as it appears in the external e-commerce platform.
  • items_countinteger
    The number of items the bundle variant contains.
  • option_sourcesarray of objects
    An array of the collections from which the contents of the bundle variant can be chosen.
    Show child attributesHide child attributes8

    • idinteger
      Unique numeric identifier for the option source.
    • source_platformstring
      The platform the option source comes from, for example shopify.
    • created_atdatetime
      The date and time when the option source was created.
    • option_source_idstring
      The id of the collection, as it appears in the source platform, that contents can be chosen from.
    • positioninteger
      The position in which the option source is displayed.
    • quantity_maxinteger · nullable
      The maximum number of items that can be chosen from this option source.
    • quantity_mininteger · nullable
      The minimum number of items that must be chosen from this option source.
    • updated_atdatetime
      The date and time when the option source was last updated.
  • rangesarray of objects
    An array of the quantity ranges allowed for the contents of the bundle variant.
    Show child attributesHide child attributes5

    • idinteger
      Unique numeric identifier for the range.
    • created_atdatetime
      The date and time when the range was created.
    • quantity_maxinteger · nullable
      The maximum number of items the bundle variant can contain.
    • quantity_mininteger
      The minimum number of items the bundle variant must contain.
    • updated_atdatetime
      The date and time when the range was last updated.
  • selection_defaultsarray of objects
    An array of the default contents of the bundle variant.
    Show child attributesHide child attributes5

    • idinteger
      Unique numeric identifier for the default selection.
    • created_atdatetime
      The date and time when the default selection was created.
    • external_variant_idstring
      The id of the variant, as it appears in the external e-commerce platform, that is included by default.
    • quantityinteger
      The quantity of the variant that is included by default.
    • updated_atdatetime
      The date and time when the default selection was last updated.
  • titlestring
    The title of the bundle variant.
• updated_atdatetime
  The date and time when the Bundle Product was last updated.
• created_atdatetime
  The date and time when the Bundle Product was created.
• custom_pricesboolean
  Whether the Bundle Product uses custom prices.
• customization_windowinteger · nullable
  The customization window of the Bundle Product, which limits when customers can change its contents. null when there is no limit.
• customization_window_disabled_messagestring · nullable
  The message shown to customers when the contents can no longer be changed.
• default_bundle_variant_idinteger · nullable
  The id of the bundle variant that is used by default.
• delivery_cycles_versionstring
  The version of the format used by delivery_cycles.
• descriptionstring · nullable
  The description of the Bundle Product.
• external_product_idstring
  The id of the product, as it appears in the external e-commerce platform, that is sold as a bundle.

#List bundle products

Query parameters

• limitinteger
  The number of results to return. Defaults to 50; the maximum is 250.
• cursorstring
  The cursor of the page to return, taken from next_cursor or previous_cursor in a previous response. Only limit can be sent together with cursor.
• pageinteger
  The page of results to show. Page-based pagination is deprecated in favor of cursor.
  Only for API tokens that are still allowed to use page-based pagination; other tokens must use cursor.
• sort_bystring
  The order in which the bundle products are returned. Defaults to id-desc.
  Possible values

  id-ascid-descupdated_at-ascupdated_at-desc
• external_product_idsstring
  Filter bundle products by external_product_id. If passing multiple values, must be comma separated.
• created_at_mindatetime
  Return the bundle products created after the given date.
• created_at_maxdatetime
  Return the bundle products created before the given date.
• updated_at_mindatetime
  Return the bundle products updated after the given date.
• updated_at_maxdatetime
  Return the bundle products updated before the given date.
• price_rulesstring
  Filter bundle products by kind. If passing multiple values, must be comma separated. preset returns bundles that are not customizable; fixed and dynamic return customizable bundles with that price_rule.
  Possible values

  presetfixeddynamic
• reset_box_contentsboolean
  Return the bundle products with the given reset_box_contents value.
• publishedboolean
  Return only the bundle products that are published (true) or not published (false).
• search_termstring
  Return the bundle products whose title contains the given text.

#Retrieve a bundle product