Skip to content

Get a kit definition

Request

Returns a specific kit definition.

Security
BearerAuth
Path
idinteger, (int64)required

Kit definition ID

curl -i -X GET \
  'https://hive-merchant-api.redocly.app/_mock/merchant-api-v2/mapi_v2_oas31/kit_definitions/{id}' \
  -H 'Authorization: Bearer <YOUR_token_HERE>'

Responses

A kit definition

Bodyapplication/json
componentsArray of objects(KitDefinitionComponent)read-onlyrequired

The component SKUs one kit is assembled from, in the order of the definition

created_atstring, (date-time)read-onlyrequired

When the kit definition was created

idinteger, (int64)read-onlyrequired

Hive's unique identifier for this kit definition; pass it as kit_definition_id to POST /kitting_requests

instructionsstring or nullread-onlyrequired

Assembly instructions for the warehouse

namestring or nullread-onlyrequired

Name of the kit definition; when none was given, the kit SKU's name followed by a sequence number

photosArray of objects(KitDefinitionPhoto)read-onlyrequired

Photos showing how the kit is assembled

sku_codestring or nullread-onlyrequired

The merchant's SKU identifier of the kit SKU the definition produces

sku_idinteger, (int64)read-onlyrequired

Hive's SKU identifier of the kit SKU the definition produces

updated_atstring, (date-time)read-onlyrequired

When the kit definition was last updated

video_urlstring or nullread-onlyrequired

URL of a video showing how the kit is assembled

Response
{
  "id": 9311,
  "name": "Christmas gift box 0003",
  "sku_id": 586004,
  "sku_code": "GIFTBOX-XMAS",
  "instructions": "Place the tea at the bottom and the mug on top, then close the box with the ribbon.",
  "video_url": "https://videos.example.com/giftbox-assembly",
  "components": [
    { … },
    { … }
  ],
  "photos": [
    { … }
  ],
  "created_at": "2026-09-01T09:12:44.512+02:00",
  "updated_at": "2026-09-01T09:12:44.512+02:00"
}