Promotions
/
List promotions

Mirakl Marketplace APIs (latest-release)

Languages
Servers
URL to be replaced by your Mirakl instance URL
https://your-instance.mirakl.net/

Stores

Operations

Platform Settings

Operations

Invoicing and Accounting

Operations

Products

Operations

Messages

Operations

Offers

Operations

Orders

Operations

Incidents

Operations

Picklists

Operations

Promotions

Operations

List promotions

Request

Query
idsstring

A comma separated list of identifiers for a promotion

typesstring

A comma separated list of types for a promotion [AMOUNT_OFF|FREE_ITEMS|PERCENTAGE_OFF]

statesstring

A comma separated list of states for a promotion [PENDING|ACTIVE|EXPIRED|PENDING_APPROVAL|REJECTED|ALL]

Default "ACTIVE"
ending_afterstring(date-time)

Returns promotions which ended or will end after this date

starting_beforestring(date-time)

Returns promotions which started or will start before this date

date_created_fromstring(date-time)

Filter promotion creation date lower limit

date_created_tostring(date-time)

Filter promotion creation date upper limit

last_request_datestring(date-time)

Last request date and time. We recommend using the differential mode along with the states parameter.

localestring

The locale to filter the medias and the public descriptions with. If not specified, medias and public descriptions of all locales are returned.If specified, only the media and the public description matching the locale will be returned, or, if not exist, the one matching the platform default locale.

trigger_offer_idsstring

Promotion-triggering offer ids, separated by commas

reward_offer_idsstring

Promotion reward offer ids, separated by commas

channel_codesstring

Channel codes on which promotions apply, separated by commas

shop_idinteger(int64)

Use this parameter when your user has access to several shops. If not specified, the shop_id from your default shop will be used.

maxinteger(int32)

Maximum number of items returned per page

offsetinteger(int32)

Index of the first item (among all the results) in the returned page

sortstring

How the results should be sorted

orderstring

Sort direction

curl -i -X GET \
  'https://your-instance.mirakl.net/api/promotions?channel_codes=string&date_created_from=2019-08-24T14%3A15%3A22Z&date_created_to=2019-08-24T14%3A15%3A22Z&ending_after=2019-08-24T14%3A15%3A22Z&ids=string&last_request_date=2019-08-24T14%3A15%3A22Z&locale=string&max=0&offset=0&order=string&reward_offer_ids=string&shop_id=0&sort=string&starting_before=2019-08-24T14%3A15%3A22Z&states=ACTIVE&trigger_offer_ids=string&types=string'

Responses

OK

Bodyapplication/json
promotionsArray of objects(PR01_Response_200_Promotions)

List of promotions

total_countinteger(int32)
Response
application/json
{
  "promotions": [
    { … }
  ],
  "total_count": 0
}

Returns

Operations

Multiple shipments

Operations