Get Promotion Product

get

https://s3partnerapi-staging.solutran.com/2.2/promotions/{promotionid}/products

Retrieves a collection of products associated with a specific promotion.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

promotionid

int64

required

The promotion identifier.

Query Params

promotionid

int64

The promotion identifier to filter products by associated promotion.

int64

The unique product identifier.

Name

string

The product name to filter by.

Department

string

The department classification to filter products.

Brand

string

The brand name to filter products.

Upc

string

The Universal Product Code (UPC) to filter products.

UpcWithDigit

string

The Universal Product Code (UPC) with check digit to filter products.

ClientAccountId

string

The client-specific account identifier to filter products by account access.

ProgramId

string

The program identifier.

DefaultSort

string

The default sorting criteria for product searches, ordered by product identifier.

IncludeInternalBenefits

boolean

Indicates whether internal benefits should be included in the search results.

SearchCriteria

string

Generates a query string representation of the search criteria.
Only includes parameters that have non-null, non-empty values.

PartnerId

string

Optional partner identifier for the request context.

Include

string

A comma-separated list of related resources to include in the response. Not used for balance inquiry endpoint.

Allowed values for this resource: promotions. Multiple values can be comma-separated.

Path

string

The API endpoint path for the current request.
Used internally for request tracking and logging purposes.

TotalCount

int32

The total number of records available for the search criteria.
May be hidden from serialization based on HideTotals setting.

Size

int32

The actual number of records returned in the current response.

Offset

int32

The starting position (zero-based) for the current page of results.

Limit

int32

The maximum number of records to return per page.
Default value is 100 records.

Sort

string

The sorting criteria for the current request.
Used internally for query processing and not included in JSON serialization.

MoreExist

boolean

Indicates whether more results exist beyond the current page.
Automatically calculated based on TotalCount, Limit, and Offset unless explicitly overridden.

HideTotals

boolean

Controls whether total count information should be hidden from the response.
Used internally for performance optimization when total counts are expensive to calculate.

SummaryData

string

Additional summary data that can be included with the response.
Used for aggregated information or custom metadata specific to the search results.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200OK

400Bad Request