Skip to content

KitDefinitions

Operations related to kit definitions, the recipes kitting requests assemble

Operations

List kit definitions

Request

Returns the kit definitions of the merchant's kit SKUs, whichever way they were created, oldest first. A kit definition is the recipe of a kit: the kit SKU it produces, the component SKUs and how many units of each go into one kit, and the assembly instructions, photos and video for the warehouse. Pass its id as kit_definition_id to POST /kitting_requests to have the kit assembled.

See the Pagination section in the API overview above for details on how pagination works.

Security
BearerAuth
Query
limitinteger, [ 1 .. 100 ]

Number of items to return per page (for pagination)

Default:20
created_at[gt]string, (date-time)

Filter results created after this date (ISO 8601 format)

created_at[lt]string, (date-time)

Filter results created before this date (ISO 8601 format)

created_at[gte]string, (date-time)

Filter results created on or after this date (ISO 8601 format)

created_at[lte]string, (date-time)

Filter results created on or before this date (ISO 8601 format)

curl -i -X GET \
  'https://hive-merchant-api.redocly.app/_mock/merchant-api-v2/mapi_v2_oas31/kit_definitions?limit=20&created_at%5Bgt%5D=2019-08-24T14%3A15%3A22Z&created_at%5Blt%5D=2019-08-24T14%3A15%3A22Z&created_at%5Bgte%5D=2019-08-24T14%3A15%3A22Z&created_at%5Blte%5D=2019-08-24T14%3A15%3A22Z' \
  -H 'Authorization: Bearer <YOUR_token_HERE>'

Responses

A list of kit definitions

Bodyapplication/json
dataArray of objects(KitDefinition)
paginationobject(Pagination)
Response
{
  "data": [
    { … }
  ],
  "pagination": {
    "first_page_url": "https://app.hive.app/merchant_api/v2/collection_of_items?limit=20",
    "limit": 20,
    "next_page_url": "https://app.hive.app/merchant_api/v2/collection_of_items?limit=20&page=eyJpZCI6MTIzNDU2fQ"
  }
}