Detail of a specific campaign product

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

Get information about all details of a specific campaign product.

Responses

Response body

object

data

object

Campaign product structure.

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

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/campaign_product_id \
3
     --header 'Accept-Language: cs, en-gb;q=0.8' \
4
     --header 'accept: application/json'


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

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.