Create Smart Bundle

Create a new bundle.

Creates a new smart bundle. Smart bundles allow you to define product groupings with configurable slots and slot connections that automatically find complementary products.

Requires authentication.

Request

POST /smart-bundle

Headers

HeaderValue
AuthorizationBearer <token>
Content-Typeapplication/json

Request Body

FieldTypeRequiredDescription
titleobjectYesMultilingual bundle title. Keys are language codes (e.g. {"en": "Complete Outfit", "de": "Komplettes Outfit"}).
internal_titlestringYesInternal display name used in admin lists and searches.
urlobjectNoMultilingual URL for the bundle. Keys are language codes.
slotsarrayNoArray of slot definitions. Each slot specifies the product selection criteria for one position in the bundle.
slot_connectionsarrayNoArray of slot connection rules. Defines how products in different slots are related (e.g. matching color or size).

Example Request

{
  "title": {
    "en": "Complete Outfit",
    "de": "Komplettes Outfit"
  },
  "internal_title": "Complete Outfit Bundle",
  "slots": [
    {
      "title": {"en": "Main product"},
      "datatype": "product"
    },
    {
      "title": {"en": "Matching accessory"},
      "datatype": "product"
    }
  ]
}

Response

Returns the created smart bundle object including its generated ID.

Body Params
string

The id of an existing bundle

title
object

The bundle title. Note: You can store multi-language titles for the bundle by indexing the title with the language code. (see example below)

string

The internal title that used for displaying lists / searching in lists

url
object

The bundle id.

slots
array of objects

The bundle url. Note: You can store multi-language urls for the bundle by indexing the url with the language code. (see example below)

slots
slot_connections
array of objects

Information about connections between slots. Each connection contains information about 2 slots (id of the slot and the field name of the product that will be used to compare), the comparison that will be used to compare 2 product's values and the type of 2 products' values (see example below)

slot_connections
Headers
string
required

Makaira Instance ID

Response
200

OK

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here!