products
List products
Obtains a list of products that match the specified criteria
get/products
Query parameters
skustring
Returns products that match the specified SKU
namestring
Returns products that match the specified product name
productCategoryIdinteger
Returns products that match the specified productCategoryId
productTypeIdinteger
Returns products that match the specified productTypeId
tagIdinteger
Returns products that match the specified tagId
startDatestring date-time
Returns products created after the specified date
endDatestring date-time
Returns products created before the specified date
showInactiveboolean
Specifies whether to include inactive products
sortBy'SKU' | 'ModifyDate' | 'CreateDate'
Sorts the order of the response
sortDir'ASC' | 'DESC'
Sort direction
pageinteger
Page number
pageSizeinteger
Number of results per page. Maximum 500.
Response
List of products retrieved successfully
Example response
{
"products": [
{
"productId": 123456789,
"sku": "BEAU-000",
"name": "Beautiful",
"active": true
}
]
}