Shop Promotions (deprecated)

GET Get multiple promotions by filter criteria

GET /promotions

Operation ID: Get multiple promotions by filter criteria. Tags: promotions. Security: client_id; customers_auth.

Handles get promotion by filter criteria Returns an array of enabled promotions matching specified filter criteria. In the request URL, you must provide a campaign_id parameter, and you can optionally specify a date range by providing start_date and end_date parameters. Both parameters are required to specify a date range: omitting one causes the server to return a MissingParameterException fault. Each request returns only enabled promotions; the server does not consider promotion qualifiers or schedules.

This endpoint may return the following faults:

• 400 - EndDateBeforeStartException - Thrown when the given end date is before the given start date
• 400 - MissingEndDateException - Thrown when a start date, but no end date was given
• 400 - MissingStartDateException - Thrown when an end date but no start date was given

Parameters

• campaign_id (query, string, required) Find the promotions assigned to this campaign (mandatory)
  Minimum length: 1. Maximum length: 256.
• start_date (query, string) The start date of the promotion in ISO8601 date time format: yyyy-MM-dd'T'HH:mmZ
• end_date (query, string) The end date of the promotion in ISO8601 date time format: yyyy-MM-dd'T'HH:mmZ
• currency (query, string) The currency mnemonic specified for price

Responses

• 400 EndDateBeforeStartException - Thrown when the given end date is before the given start date or MissingEndDateException - Thrown when a start date, but no end date was given or MissingStartDateException - Thrown when an end date but no start date was given

  Media type: application/json, text/xml. Schema: fault.

• default

  Media type: application/json, text/xml. Schema: promotion_result.