API Reference

Get all campaign products

get
https://{project_url}/webservice/rest-api/{api_interface}/{version}/campaign-products

Get a list of all campaign products. A campaign product defines a discount promotion on a specific product, with configurable pricing (percentage discount or final price), a validity period, and optional restrictions by store or display channel. Use filters such as campaign_id, is_valid, and display_in to narrow results. See Campaign products for details.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
≥ 1
Defaults to 100

The number of records to return in API response.

⚠️ We recommended adjust the batch size based on processing time. Depending on the response time of the request. Default value of 100 records is used if count parameter is not set.

integer
≥ 0
Defaults to 0

The number of records from a collection to skip. Default value of 0 is used when parameter offset is not set.

string

Name of the sorting parameter. You can sort by any of the first level parameters from the resource response. Response is sorted by the specified field.

string
enum

Direction of sorting the response list.

Allowed:
string

Search record by name or a part of the name.

string

Code of the product.

string
enum

Place to display campaign product.

Allowed:
type_id
array of strings

Type of the customer for a campaign product. The list of values is available at GET /customer-types.

type_id
string

Parameter filters all campaign products from store by store ID.

integer
enum

Type of value (1 - percentage discount value, 2 - final price).

Allowed:
boolean
enum

in validity range - true / before or after validity range - false / no value - all

Allowed:
string

Start of the validity period for filtering. Accepts the format YYYY-MM-DD HH:MM:SS or ISO-8601 format (YYYY-MM-DDTHH:MM:SS). All times are in the local timezone.

string

End of the validity period for filtering. Accepts the format YYYY-MM-DD HH:MM:SS or ISO-8601 format (YYYY-MM-DDTHH:MM:SS). All times are in the local timezone.

string

The unique ID of the campaign in CareCloud. The list of campaigns is available in GET /campaigns.

boolean
enum

If true, the property record structure will be included in the response. Possible values: true - property records structure will be included / false or not set - property records structure won't be included, and parameter will return null value

Allowed:
Headers
string
Defaults to cs, en-gb;q=0.8

The unique ID of the language code by ISO 639-1.

Responses

429

Too many requests - more than the resource limit.

503

Temporary state when the service is temporarily unavailable, overloaded or there is a maintenance window.

Updated 12 days ago

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 12 days ago