Build Version:
GET products/catalog/{catalogIds}
Gets a list of products for a specific catalog.
Request Information
» Parameters
| Name | Description | Additional information |
|---|---|---|
| catalogIds | No documentation available. |
Define this parameter in the request URI. |
» Expands
| Name | Description | Usage |
|---|---|---|
| addOns | This will retrieve the related list of addons. | GET products/catalog/{catalogIds}?expand=addons |
| attributes | This will retrieve the related list of attributes. | GET products/catalog/{catalogIds}?expand=attributes |
| categories | This will retrieve the related list of categories. | GET products/catalog/{catalogIds}?expand=categories |
| crossSells | This will retrieve the related list of cross sells. | GET products/catalog/{catalogIds}?expand=crosssells |
| frequentlyboughttogether | This will retrieve the list of products that are frequently bought together. | GET products/catalog/{catalogIds}?expand=frequentlyboughttogether |
| highlights | This will retrieve the related list of highlights. | GET products/catalog/{catalogIds}?expand=highlights |
| images | This will retrieve the related list of images. | GET products/catalog/{catalogIds}?expand=images |
| manufacturer | This will retrieve the related manufacturer. | GET products/catalog/{catalogIds}?expand=manufacturer |
| productType | This will retrieve the related product type. | GET products/catalog/{catalogIds}?expand=producttype |
| promotions | This will retrieve the related list of promotions. | GET products/catalog/{catalogIds}?expand=promotions |
| reviews | This will retrieve the related list of reviews. | GET products/catalog/{catalogIds}?expand=reviews |
| skus | This will retrieve the related list of SKUs. | GET products/catalog/{catalogIds}?expand=skus |
| tiers | This will retrieve the related tiers. | GET products/catalog/{catalogIds}?expand=tiers |
| youMayAlsoLike | This will retrieve the list of products that you may also like. | GET products/catalog/{catalogIds}?expand=youmayalsolike |
» Filters
| Name | Description | Usage |
|---|---|---|
| accountId | This will filter the request by account ID. | GET products/catalog/{catalogIds}?filter=accountid~{operator}~{value} |
| externalId | This will filter the request by external ID. | GET products/catalog/{catalogIds}?filter=externalid~{operator}~{value} |
| isActive | This will filter the request by the is active flag. | GET products/catalog/{catalogIds}?filter=isactive~{operator}~{value} |
| isFeatured | This will filter the request by the is featured flag. | GET products/catalog/{catalogIds}?filter=isfeatured~{operator}~{value} |
| isNew | This will filter the request by the is new flag. | GET products/catalog/{catalogIds}?filter=isnew~{operator}~{value} |
| manufacturerId | This will filter the request by manufacturer ID. | GET products/catalog/{catalogIds}?filter=manufacturerid~{operator}~{value} |
| name | This will filter the request by name. | GET products/catalog/{catalogIds}?filter=name~{operator}~{value} |
| number | This will filter the request by number. | GET products/catalog/{catalogIds}?filter=number~{operator}~{value} |
| portalId | This will filter the request by portal ID. | GET products/catalog/{catalogIds}?filter=portalid~{operator}~{value} |
| productTypeId | This will filter the request by product type ID. | GET products/catalog/{catalogIds}?filter=producttypeid~{operator}~{value} |
| retailPrice | This will filter the request by retail price. | GET products/catalog/{catalogIds}?filter=retailprice~{operator}~{value} |
| salePrice | This will filter the request by sale price. | GET products/catalog/{catalogIds}?filter=saleprice~{operator}~{value} |
| shippingRuleTypeId | This will filter the request by shipping rule type ID. | GET products/catalog/{catalogIds}?filter=shippingruletypeid~{operator}~{value} |
| supplierId | This will filter the request by supplier ID. | GET products/catalog/{catalogIds}?filter=supplierid~{operator}~{value} |
| taxClassId | This will filter the request by tax class ID. | GET products/catalog/{catalogIds}?filter=taxclassid~{operator}~{value} |
| wholesalePrice | This will filter the request by wholesale price. | GET products/catalog/{catalogIds}?filter=wholesaleprice~{operator}~{value} |
» Sorting
| Name | Description | Usage |
|---|---|---|
| displayOrder | This will sort the response by display order. | GET products/catalog/{catalogIds}?sort=displayorder |
| name | This will sort the response by name. | GET products/catalog/{catalogIds}?sort=name |
| number | This will sort the response by number. | GET products/catalog/{catalogIds}?sort=number |
| productId | This will sort the response by product ID. | GET products/catalog/{catalogIds}?sort=productid |
| retailPrice | This will sort the response by retail price. | GET products/catalog/{catalogIds}?sort=retailprice |
| salePrice | This will sort the response by sale price. | GET products/catalog/{catalogIds}?sort=saleprice |
| wholesalePrice | This will sort the response by wholesale price. | GET products/catalog/{catalogIds}?sort=wholesaleprice |
» Paging
| Name | Description | Usage |
|---|---|---|
| index | The index to retrieve when requesting paged results. | GET products/catalog/{catalogIds}?page=index~{value} |
| size | The size of the page when retrieving paged results. | GET products/catalog/{catalogIds}?page=size~{value} |