Sign in

v1

latestOpenAPI 3.0.32026-07-13149852.3 MB
kit

Kit - Get

Retrieve a paginated list of kits with optional filtering.

get/kit/get

Query parameters

selectorobject required

Query selector object for filtering results

limitnumber

Max results to return

Example:50
skipnumber

Number of results to skip

sortobject

Sort fields object, e.g. { "name": 1 }

fieldsobject

Projection fields object, e.g. { "name": 1 }

Response

Array of kits

_idstring required

Unique kit identifier

namestring required

Kit name

activeboolean

Whether the kit is active

listing_skustring

Listing SKU

fulfillment_skustring

Fulfillment SKU

tagsstring[]

Array of tag IDs (ObjectId strings referencing the tag collection)

barcodesstring[]

Additional barcodes

costnumber nullable

Kit cost

retailnumber nullable

Retail price

wholesalenumber nullable

Wholesale price

salenumber nullable

Sale price

imagestring nullable

Kit image URL

imagesstring[]

Additional image URLs

descriptionstring nullable

Kit description

notesstring nullable

Kit notes

weightnumber nullable

Kit weight

weight_unit'oz' | 'lb' | 'g' | 'kg' nullable

Weight unit

lag_timenumber nullable

Lag time in days

calc_costnumber

Calculated cost from component items

calc_retailnumber

Calculated retail from component items

Example response

[
  {
    "_id": "507f1f77bcf86cd799439011",
    "tags": [
      "507f1f77bcf86cd799439011",
      "507f1f77bcf86cd799439012"
    ],
    "listings": [
      {
        "store_id": "507f1f77bcf86cd799439011"
      }
    ]
  }
]