Skip to main content
POST
/
api
/
v1
/
:team_slug
/
:app_slug
/
bundle-groups
/
:bundle_group_id
/
bundles
Error
A valid request URL is required to generate request examples
{
  "data": {
    "attributes": [
      {
        "created_at": "<string>",
        "description": "<string>",
        "filterable": true,
        "id": "<string>",
        "key": "<string>",
        "name": "<string>",
        "template_key": "<string>",
        "template_name": "<string>",
        "translatable": true,
        "translations": {
          "description": [
            {
              "id": "<string>",
              "locale": "<string>",
              "omni_channel_translations": [
                {
                  "id": "<string>",
                  "market_id": "<string>",
                  "store_group_id": "<string>",
                  "value": "<string>"
                }
              ],
              "value": "<string>"
            }
          ],
          "name": [
            {
              "id": "<string>",
              "locale": "<string>",
              "omni_channel_translations": [
                {
                  "id": "<string>",
                  "market_id": "<string>",
                  "store_group_id": "<string>",
                  "value": "<string>"
                }
              ],
              "value": "<string>"
            }
          ]
        },
        "updated_at": "<string>",
        "values": {}
      }
    ],
    "compliant": {
      "info": [
        "<string>"
      ],
      "level": "<unknown>"
    },
    "created_at": "<string>",
    "discount_percentage": 123,
    "discount_type": "<string>",
    "discounts": {},
    "id": "<string>",
    "rules": [
      {
        "bundle_id": "<string>",
        "discount_percentage": 123,
        "discount_type": "<string>",
        "discounts": {},
        "exclude_discounted_price": true,
        "exclude_full_price": true,
        "id": "<string>",
        "items": [
          {
            "description": "<string>",
            "id": "<string>",
            "image_urls": [
              "<string>"
            ],
            "product_name": "<string>",
            "product_number": "<string>",
            "slug": "<string>"
          }
        ],
        "quantity": 123,
        "tag_conditions": {
          "brands": {
            "mode": "include",
            "values": [
              {
                "id": "<string>",
                "name": "<string>"
              }
            ]
          },
          "categories": {
            "mode": "include",
            "values": [
              {
                "id": "<string>",
                "name": "<string>"
              }
            ]
          },
          "collections": {
            "mode": "include",
            "values": [
              {
                "id": "<string>",
                "name": "<string>"
              }
            ]
          },
          "series": {
            "mode": "include",
            "values": [
              {
                "id": "<string>",
                "name": "<string>"
              }
            ]
          },
          "tags": {
            "mode": "include",
            "values": [
              {
                "id": "<string>",
                "name": "<string>"
              }
            ]
          }
        }
      }
    ],
    "status": "<string>",
    "updated_at": "<string>"
  },
  "details": [
    "<string>"
  ],
  "success": true
}

Path Parameters

​
app_slug
string
required

App slug

​
team_slug
string
required

Team slug

​
product_bundle_group_id
string
required

Product bundle group id

Body

application/json

Product bundle data

​
discounts
object[]
required
​
discount_percentage
integer

Used if discount_type is relative. This will apply to all markets it's added to

Required range: 0 <= x <= 100
​
discount_type
enum<string>
Available options:
relative,
fixed
​
status
enum<string>

Status of the bundle

Available options:
active,
draft,
inactive

Response

Product bundle created

​
data
object
​
details
string[]

Other information which can be relative to the response. This field is used to give additional information then the main data we want to return. For instance if a product do not match the publishing rules will the product status be set to Incomplete and this field will include why

​
success
boolean