Skip to main content
Version: v1

Kit

A Kit (or product bundle) is a product that groups other products together as components. It allows merchants to sell combinations of products as a single unit.

This is a read-only resource. Kits are managed through the store's admin panel.

Only products with a single variant can be added as components of a Kit.

Pricing

The Kit's price is calculated by summing the list prices of all its component products. If a discount percentage is defined, it is applied over that total.

Stock

The Kit's stock is determined by the minimum available stock across all its component products, considering the quantity each component requires. If any component cannot fulfill the required quantity or runs out of stock, the Kit's stock becomes 0. If kit_stock is null, it means the Kit has unlimited stock (same behavior as variants with null stock).

For example, a Kit that requires 2 units of Product A and 1 unit of Product B:

ComponentRequiredAvailable stockCan build
Product A2105 kits
Product B133 kits

Kit stock = 3 (limited by Product B).

If Product B's stock drops to 0:

ComponentRequiredAvailable stockCan build
Product A2105 kits
Product B100 kits

Kit stock = 0 (Product B cannot fulfill the required quantity).

Properties

PropertyExplanation
idThe unique numeric identifier for the Kit. This is the same as the Product ID
nameList of the names of the Kit, in every language supported by the store
descriptionList of the descriptions of the Kit, as HTML, in every language supported by the store
handleList of the url-friendly strings generated from the Kit's names, in every language supported by the store
skuThe Kit's SKU (Stock Keeping Unit)
barcodeThe Kit's barcode (EAN, UPC, ISBN, etc.)
mpnThe Kit's Manufacturer Part Number
genderTarget gender for the Kit. Possible values: male, female, unisex or null
age_groupTarget age group for the Kit. Possible values: adult, kids or null
invalid_atDate when the Kit becomes invalid in ISO 8601 format, or null
brandThe Kit's brand
publishedtrue if the Kit is published in the store. false otherwise
free_shippingtrue if the Kit is eligible for free shipping. false otherwise
canonical_urlThe canonical URL of the Kit in the store
video_urlString with a valid URL format. Only admits https links
seo_titleList of the SEO friendly titles for the Kit, in every language supported by the store. Up to 70 characters
seo_descriptionList of the SEO friendly descriptions for the Kit, in every language supported by the store. Up to 320 characters
imagesList of Product Image objects representing the Kit's images
categoriesList of Category IDs representing the Kit's categories
tagsString with all the Kit's tags, separated by commas
discount_percentDiscount percentage applied to the Kit, or null if no discount is defined
componentsList of component objects representing the products included in the Kit. See Components below
kit_stockThe calculated stock of the Kit based on its components' availability, or null
created_atDate when the Kit was created in ISO 8601 format
updated_atDate when the Kit was last updated in ISO 8601 format

Components

Each element in the components array has the following properties:

  • kit config: defined when the Kit is created.
  • product data: read from the component product at query time.
PropertySourceExplanation
product_idkit configThe unique numeric identifier of the component Product
quantitykit configQuantity of this component included in the Kit
positionkit configDisplay position of the component within the Kit (0-indexed)
free_shippingproduct datatrue if the component product is configured as free shipping. false otherwise
is_deletedproduct datatrue if the component product has been deleted. false otherwise
nameproduct dataList of the names of the component product, in every language supported by the store (includes default key)
image_urlproduct dataURL of the component product's main image, or null if it has no image
priceproduct dataThe component product's price
promotional_priceproduct dataThe component product's promotional price, or null if not on promotion
stockproduct dataThe component product's available stock, or null

Endpoints

GET /kits/{id}

Receive a single Kit with its components.

GET /kits/332538459

HTTP/1.1 200 OK

{
"id": 332538459,
"name": {
"es": "Kit Proteínas",
"pt": "Kit Proteínas"
},
"description": {
"es": "<p>Combo de proteínas ideal para tu rutina.</p>",
"pt": "<p>Combo de proteínas ideal para sua rotina.</p>"
},
"handle": {
"es": "kit-proteinas",
"pt": "kit-proteinas"
},
"sku": "KIT-PROT-001",
"barcode": null,
"mpn": null,
"gender": null,
"age_group": "adult",
"invalid_at": null,
"published": true,
"free_shipping": false,
"canonical_url": "https://mystore.mitiendanube.com/productos/kit-proteinas/",
"video_url": null,
"seo_title": {
"es": "Kit Proteínas - MyBrand"
},
"seo_description": {
"es": "Combo de proteínas ideal para tu rutina."
},
"brand": "MyBrand",
"created_at": "2026-03-27T12:22:59+0000",
"updated_at": "2026-04-10T08:15:30+0000",
"tags": "kit,proteinas,combo",
"images": [
{
"id": 1152273818,
"product_id": 332538459,
"src": "https://d2r9epyceweg5n.cloudfront.net/stores/001/234/products/kit-proteinas.jpg",
"position": 1
}
],
"categories": [
4567
],
"discount_percent": 10,
"components": [
{
"product_id": 332537485,
"quantity": 1,
"position": 0,
"free_shipping": false,
"is_deleted": false,
"name": {
"es": "Whey Protein 1kg",
"pt": "Whey Protein 1kg",
"en": "Whey Protein 1kg",
"default": "Whey Protein 1kg"
},
"image_url": "https://d2r9epyceweg5n.cloudfront.net/stores/001/234/products/whey-protein.jpg",
"price": 150,
"promotional_price": null,
"stock": 20
},
{
"product_id": 332537490,
"quantity": 2,
"position": 1,
"free_shipping": false,
"is_deleted": false,
"name": {
"es": "Barrita Proteica",
"pt": "Barra Proteica",
"en": "Protein Bar",
"default": "Barrita Proteica"
},
"image_url": "https://d2r9epyceweg5n.cloudfront.net/stores/001/234/products/barrita-proteica.jpg",
"price": 50,
"promotional_price": null,
"stock": 8
}
],
"kit_stock": 4
}