» Expands

GET products/category/{categoryId}/promotiontype/{promotionTypeId}?expand=addons

attributes

This will retrieve the related list of attributes.

GET products/category/{categoryId}/promotiontype/{promotionTypeId}?expand=attributes

categories

This will retrieve the related list of categories.

GET products/category/{categoryId}/promotiontype/{promotionTypeId}?expand=categories

crossSells

This will retrieve the related list of cross sells.

GET products/category/{categoryId}/promotiontype/{promotionTypeId}?expand=crosssells

frequentlyboughttogether

This will retrieve the list of products that are frequently bought together.

GET products/category/{categoryId}/promotiontype/{promotionTypeId}?expand=frequentlyboughttogether

highlights

This will retrieve the related list of highlights.

GET products/category/{categoryId}/promotiontype/{promotionTypeId}?expand=highlights

images

This will retrieve the related list of images.

GET products/category/{categoryId}/promotiontype/{promotionTypeId}?expand=images

manufacturer

This will retrieve the related manufacturer.

GET products/category/{categoryId}/promotiontype/{promotionTypeId}?expand=manufacturer

productType

This will retrieve the related product type.

GET products/category/{categoryId}/promotiontype/{promotionTypeId}?expand=producttype

promotions

This will retrieve the related list of promotions.

GET products/category/{categoryId}/promotiontype/{promotionTypeId}?expand=promotions

reviews

This will retrieve the related list of reviews.

GET products/category/{categoryId}/promotiontype/{promotionTypeId}?expand=reviews

skus

This will retrieve the related list of SKUs.

GET products/category/{categoryId}/promotiontype/{promotionTypeId}?expand=skus

tiers

This will retrieve the related tiers.

GET products/category/{categoryId}/promotiontype/{promotionTypeId}?expand=tiers

youMayAlsoLike

This will retrieve the list of products that you may also like.

GET products/category/{categoryId}/promotiontype/{promotionTypeId}?expand=youmayalsolike

» Filters

Name

Description

Usage

accountId

This will filter the request by account ID.

GET products/category/{categoryId}/promotiontype/{promotionTypeId}?filter=accountid~{operator}~{value}

externalId

This will filter the request by external ID.

GET products/category/{categoryId}/promotiontype/{promotionTypeId}?filter=externalid~{operator}~{value}

isActive

This will filter the request by the is active flag.

GET products/category/{categoryId}/promotiontype/{promotionTypeId}?filter=isactive~{operator}~{value}

isFeatured

This will filter the request by the is featured flag.

GET products/category/{categoryId}/promotiontype/{promotionTypeId}?filter=isfeatured~{operator}~{value}

isNew

This will filter the request by the is new flag.

GET products/category/{categoryId}/promotiontype/{promotionTypeId}?filter=isnew~{operator}~{value}

manufacturerId

This will filter the request by manufacturer ID.

GET products/category/{categoryId}/promotiontype/{promotionTypeId}?filter=manufacturerid~{operator}~{value}

name

This will filter the request by name.

GET products/category/{categoryId}/promotiontype/{promotionTypeId}?filter=name~{operator}~{value}

number

This will filter the request by number.

GET products/category/{categoryId}/promotiontype/{promotionTypeId}?filter=number~{operator}~{value}

portalId

This will filter the request by portal ID.

GET products/category/{categoryId}/promotiontype/{promotionTypeId}?filter=portalid~{operator}~{value}

productTypeId

This will filter the request by product type ID.

GET products/category/{categoryId}/promotiontype/{promotionTypeId}?filter=producttypeid~{operator}~{value}

retailPrice

This will filter the request by retail price.

GET products/category/{categoryId}/promotiontype/{promotionTypeId}?filter=retailprice~{operator}~{value}

salePrice

This will filter the request by sale price.

GET products/category/{categoryId}/promotiontype/{promotionTypeId}?filter=saleprice~{operator}~{value}

shippingRuleTypeId

This will filter the request by shipping rule type ID.

GET products/category/{categoryId}/promotiontype/{promotionTypeId}?filter=shippingruletypeid~{operator}~{value}

supplierId

This will filter the request by supplier ID.

GET products/category/{categoryId}/promotiontype/{promotionTypeId}?filter=supplierid~{operator}~{value}

taxClassId

This will filter the request by tax class ID.

GET products/category/{categoryId}/promotiontype/{promotionTypeId}?filter=taxclassid~{operator}~{value}

wholesalePrice

This will filter the request by wholesale price.

GET products/category/{categoryId}/promotiontype/{promotionTypeId}?filter=wholesaleprice~{operator}~{value}

» Sorting

Name

Description

Usage

displayOrder

This will sort the response by display order.

GET products/category/{categoryId}/promotiontype/{promotionTypeId}?sort=displayorder

name

This will sort the response by name.

GET products/category/{categoryId}/promotiontype/{promotionTypeId}?sort=name

number

This will sort the response by number.

GET products/category/{categoryId}/promotiontype/{promotionTypeId}?sort=number

productId

This will sort the response by product ID.

GET products/category/{categoryId}/promotiontype/{promotionTypeId}?sort=productid

retailPrice

This will sort the response by retail price.

GET products/category/{categoryId}/promotiontype/{promotionTypeId}?sort=retailprice

salePrice

This will sort the response by sale price.

GET products/category/{categoryId}/promotiontype/{promotionTypeId}?sort=saleprice

wholesalePrice

This will sort the response by wholesale price.

GET products/category/{categoryId}/promotiontype/{promotionTypeId}?sort=wholesaleprice

» Paging

Name

Description

Usage

index

The index to retrieve when requesting paged results.

GET products/category/{categoryId}/promotiontype/{promotionTypeId}?page=index~{value}

size

The size of the page when retrieving paged results.

GET products/category/{categoryId}/promotiontype/{promotionTypeId}?page=size~{value}

Response Information

» Response Body Formats

If this endpoint supports expands, they will be included in the sample response body below. However, please note that expands are NOT included in the response body by default. Expands are only included in the response body if they came through as part of the request.