Get Promotion

get

https://s3partnerapi-staging.solutran.com/2.2/promotions

Retrieves a collection of promotions on the specified search and metadata parameters.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

int64

The unique promotion identifier to filter by.

Type

string

The promotion type to filter by (e.g., discount, rebate).

Status

string

The promotion status to filter by. Can include multiple comma-separated values.
Supports ACTIVE and INACTIVE statuses.

ProgramId

string

The program identifier to filter promotions by associated program.

Name

string

The promotion name to filter by.

RewardType

string

The reward type classification to filter promotions.

ProductId

int64

The product identifier to filter promotions by associated product.

DefaultSort

string

The default sorting criteria for promotion searches, ordered by promotion identifier in descending order.

SearchCriteria

string

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

IncludeActiveStatus

boolean

Indicates whether active status promotions are included in the search results.
Set internally based on Status property via SetStatus method.

IncludeExpiredStatus

boolean

Indicates whether expired/inactive status promotions are included in the search results.
Set internally based on Status property via SetStatus method.

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.

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