Create product bundle

POST

api

{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>",
              "value": "<string>"
            }
          ],
          "name": [
            {
              "id": "<string>",
              "locale": "<string>",
              "value": "<string>"
            }
          ]
        },
        "updated_at": "<string>",
        "values": {}
      }
    ],
    "compliant": {
      "info": [
        "<string>"
      ],
      "level": "none"
    },
    "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>"
  },
  "success": true,
  "details": [
    "<string>"
  ]
}

{
  "success": true,
  "details": [
    "<string>"
  ],
  "message": "<string>"
}

{
  "success": true,
  "details": [
    "<string>"
  ],
  "message": "<string>"
}

{
  "success": true,
  "details": [
    "<string>"
  ],
  "message": "<string>"
}

Authorizations

Authorization

string

header

required

Management API token, sent as Authorization: Bearer <token>.

Path Parameters

app_slug

string

required

App slug

team_slug

string

required

Team slug

product_bundle_group_id

string

required

Product bundle group UUID

Body

application/json

Product bundle configuration

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

discounts

object[]

Show child attributes

status

enum<string>

Status of the bundle

Available options:

active,

draft,

inactive

Response

Product bundle created successfully

data

object

required

Show child attributes

success

boolean

required

details

string[]

Additional contextual information about the response. Used to provide supplementary details beyond the main data payload, such as validation warnings or processing notes

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>",
              "value": "<string>"
            }
          ],
          "name": [
            {
              "id": "<string>",
              "locale": "<string>",
              "value": "<string>"
            }
          ]
        },
        "updated_at": "<string>",
        "values": {}
      }
    ],
    "compliant": {
      "info": [
        "<string>"
      ],
      "level": "none"
    },
    "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>"
  },
  "success": true,
  "details": [
    "<string>"
  ]
}

{
  "success": true,
  "details": [
    "<string>"
  ],
  "message": "<string>"
}

{
  "success": true,
  "details": [
    "<string>"
  ],
  "message": "<string>"
}

{
  "success": true,
  "details": [
    "<string>"
  ],
  "message": "<string>"
}

Management API

Shopper API

Customers API

Digital Assets Management API

Authorizations

Path Parameters

Body

Response