Collection of campaign products

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

Get information about all available campaign products.

Query Params

count

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.

offset

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.

sort_field

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.

sort_direction

string

Direction of sorting the response list.

name

string

Search record by name or a part of the name.

code

string

Code of the product.

display_in

string

Place to display campaign product.

type_id

array of strings

Type of the customer for a campaign product.

type_id

store_id

string

Parameter filters all campaign products from store by store ID.

value_type_id

integer

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

is_valid

boolean

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

valid_from

string

Date and time from when is record already valid. (YYYY-MM-DD HH:MM:SS)

valid_to

string

Date and time to when is record still valid. (YYYY-MM-DD HH:MM:SS)

campaign_id

string

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

Headers

Accept-Language

string

Defaults to cs, en-gb;q=0.8

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

Responses

Response body

object

data

object

campaign_products

array of objects

List of the campaign products.

campaign_products

object

campaign_product_id

string

The unique ID of the campaign product.

product_id

string

required

The unique ID of the product.

currency_id

string

required

The unique ID of the currency.

campaign_id

string

required

The unique ID of the campaign.

value

float

required

Value of the product.

value_type_id

integer

required

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

1 2

valid_from

string

required

Validity of the campaign product from the date. (YYYY-MM-DD HH:MM:SS)

valid_to

string

required

Validity of the campaign product to the date. (YYYY-MM-DD HH:MM:SS)

display_in

array of strings

List of possible display places.

display_in

type_id

string

required

Type of a campaign product.

presentation_data

object

required

Campaign presentation data structure.

last_change

string

Date and time of the last change. (YYYY-MM-DD HH:MM:SS)

state

integer

State of the card.
Possible values are: 0 - blocked / 1 - active

1

total_items

integer

The number of all found campaign products.

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.

Language

Credentials

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://sandbox.crmcarecloud.com/webservice/rest-api/enterprise-interface/v1.0/campaign-products?count=100&offset=0' \
3
     --header 'Accept-Language: cs, en-gb;q=0.8' \
4
     --header 'accept: application/json'


xxxxxxxxxx
30
}
1
{
2
  "data": {
3
    "campaign_products": [
4
      {
5
        "campaign_product_id": "8bed991c68a470e7aaeffbf048",
6
        "product_id": "8ad4ff4db9d628f2c8cb6181a4",
7
        "currency_id": "8bed991c68a470e7aaeffbf048",
8
        "campaign_id": "8ad8b2b701199684f1222961d6",
9
        "value": 50,
10
        "value_type_id": 1,
11
        "valid_from": "2021-04-16 00:00:00",
12
        "valid_to": "2021-05-16 23:59:59",
13
        "display_in": [
14
          "mapi"
15
        ],
16
        "type_id": "86e05affc7a7abefcd513ab400",
17
        "presentation_data": {
18
          "name": "T-shirt 10% off",
19
          "subtitle": "Discount only in following week",
20
          "note": "This offer is limited",
21
          "description": null,
22
          "image_url": "https://developers.crmcarecloud.com/img/customer_enterprise.png"
23
        },
24
        "last_change": "2021-04-16 19:02:22",
25
        "state": 1

200OK

400Bad input parameter. Error message specifies the detail.

401The client has invalid credentials or auth token.

403The client does not exist or the client tried to access non authorized property/resource.

404The resource was not found.

405The resource does not support the specified HTTP method.

500Server is not working as expected.