list_products
Fetch and filter product data from ShipStation API by SKU, name, category, or status. Control pagination, sorting, and include inactive products for streamlined inventory management.
Input Schema
Name | Required | Description | Default |
---|---|---|---|
name | No | Filter by product name | |
page | No | Page number | |
pageSize | No | Number of products per page (max 500) | |
productCategoryId | No | Filter by product category ID | |
showInactive | No | Include inactive products | |
sku | No | Filter by SKU | |
sortBy | No | Sort products by a specific field | |
sortDir | No | Sort direction |
Input Schema (JSON Schema)
{
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"name": {
"description": "Filter by product name",
"type": "string"
},
"page": {
"description": "Page number",
"type": "number"
},
"pageSize": {
"description": "Number of products per page (max 500)",
"type": "number"
},
"productCategoryId": {
"description": "Filter by product category ID",
"type": "number"
},
"showInactive": {
"description": "Include inactive products",
"type": "boolean"
},
"sku": {
"description": "Filter by SKU",
"type": "string"
},
"sortBy": {
"description": "Sort products by a specific field",
"type": "string"
},
"sortDir": {
"description": "Sort direction",
"enum": [
"ASC",
"DESC"
],
"type": "string"
}
},
"type": "object"
}