Shipsidekick LogoShipsidekick Docs

List products

Retrieve a list of products with pagination and filtering options

GET
/products

Query Parameters

limitinteger

Maximum number of items to return

Default: 10Minimum: 1Maximum: 100
pageinteger

Page number for pagination

Default: 1Minimum: 1
searchstring

Search term to filter products

cursorstring

Cursor for pagination

sortBystring

Field to sort by

sortOrderstring

Order to sort by

Default: "desc"Value in: "asc" | "desc"
includeArchivedboolean

Whether to include archived products

Default: false
curl -X GET "https://www.shipsidekick.com/api/v1/products?limit=10&page=1&search=string&cursor=string&sortBy=string&sortOrder=asc"

Successful operation

{
  "$ref": "#/components/examples/ProductListExample/value"
}