v1

latestOpenAPI 3.0.32026-07-13149852.3 MB

item

Item - Get

Retrieve a paginated list of items with optional filtering.

get/item/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 items matching the query

_idstring required

Unique item identifier

namestring

Item name

skustring

Stock keeping unit

imagestring

Image URL

upcstring

Universal product code

barcodesstring[]

Additional barcodes

tagsstring[]

Array of tag IDs assigned to this item (ObjectId strings referencing the tag collection)

lengthnumber

Package length

widthnumber

Package width

heightnumber

Package height

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

Weight unit

dimensions_unit'in' | 'cm'

Dimensions unit

weightnumber

Package weight

notesstring

Item notes

fulfillment_skustring

SKU used for fulfillment

unitstring

Unit of measure

costnumber

Item cost

wholesalenumber

Wholesale price

retailnumber

Retail price

activeboolean

Whether the item is active

alias_locationsobject

Warehouse location assignments (keyed by warehouse ID)

Example response

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