Create a bundle chapter
Creates a new chapter under a bundle product.
See the Validation Rules in the Bundle Chapters section — in particular, bundle_product must be a Bundle product, default_product, when given, must be a Miscellaneous product, and attributes should be sent even when empty.
Token credential sent in the Authorization header, in the form: Token <your-token>. Requires a staff (admin) account.
The data used to create a bundle chapter, or to fully update one. On update, bundle_product, attribute_set, attributes, and attributes_kwargs are accepted and validated but have no effect — see the Validation Rules in the Bundle Chapters section.
The chapter's display name.
The chapter's identifier within its bundle product. Must be unique per bundle_product.
The identifier of the parent product. Must reference a product whose product_type is Bundle (2). Only applied at creation — ignored when updating an existing chapter, which cannot be moved to a different bundle product.
The identifier of the miscellaneous product to pre-select for this chapter. Must reference a product whose product_type is Miscellaneous (4). On update, this can be used to set or replace the default product, but not to clear it — sending null has no effect if one is already set.
The identifier of the attribute set that defines this chapter's selectable attributes. Only applied at creation.
The chapter's position among its bundle product's chapters.
0Whether the chapter is active.
trueWhether the customer must make a selection for this chapter.
trueWhether this chapter renders a form requiring additional input, rather than a plain selection.
falseThe bundle chapter was created.
A configurable selection chapter of a bundle product.
The unique identifier of the bundle chapter.
The chapter's display name.
The chapter's identifier within its bundle product. Must be unique per bundle_product.
The identifier of the parent product. Must reference a product whose product_type is Bundle (2). Fixed at creation — a chapter's bundle product cannot be changed afterwards.
The identifier of the miscellaneous product pre-selected for this chapter, when set. Must reference a product whose product_type is Miscellaneous (4). Can be set or replaced through an update, but not cleared back to null once set.
The identifier of the attribute set that defines this chapter's selectable attributes. Can only be set at creation — sending a different value on update has no effect.
The chapter's position among its bundle product's chapters. Chapters are listed ordered by this value by default.
0Whether the chapter is active.
trueWhether the customer must make a selection for this chapter.
trueWhether this chapter renders a form requiring additional input, rather than a plain selection.
falseThe request contains invalid or missing data.
Authentication credentials were not provided or are invalid.
The authenticated user does not have administrator privileges.
POST /api/v1/remote/1/bundle_chapters/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 271
{
"name": "text",
"slug": "text",
"bundle_product": 1,
"default_product": null,
"attribute_set": 1,
"order": 0,
"is_active": true,
"is_required": true,
"is_form_required": false,
"attributes": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"attributes_kwargs": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
}{
"pk": 1,
"name": "text",
"slug": "text",
"bundle_product": 1,
"default_product": null,
"attribute_set": 1,
"order": 0,
"is_active": true,
"is_required": true,
"is_form_required": false,
"attributes": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"attributes_kwargs": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"attr_key": [
{
"pk": 42,
"key": "color",
"name": "Color",
"data_type": "dropdown",
"default_value": null,
"is_required": true,
"is_visible": true,
"is_searchable": true,
"is_filterable": true,
"is_variant": true,
"is_variant_listable": true,
"is_form_required": false,
"is_form_field_required": false
}
]
}Last updated
Was this helpful?

