v1

latestOpenAPI 3.0.12026-07-2412502.6 MB

Campaigns

Get a campaign

Get campaign details for a specific campaign ID.

get/campaigns/{campaign_id}

Query parameters

with'offers' | 'shipping_profiles' | 'primary_campaign_category' | 'secondary_campaign_category'

Expand on the information returned by including 'with' in the query parameters. For multiple attributes, separate with a comma (example : with=offers,shipping_profiles)

Response

campaign_idinteger

campaign_namestring

payment_type_id1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13

1 - Credit Card
2 - Check
3 - Google Pay
4 - Apple Pay
5 - Cash
6 - Paypal
7 - Alternative Payments Sofort
8 - Alternative Payments POLi
9 - Alternative Payments SEPA
10 - ACH
11 - Afterpay
12 - Klarna
13 - SEPA

campaign_activeboolean

campaign_prepaidboolean

campaign_payment_method_requiredboolean

campaign_group_transactionsboolean

campaign_global_jsstring nullable

campaign_global_seo_titlestring nullable

campaign_global_seo_keywordsstring nullable

campaign_global_seo_descriptionstring nullable

date_createdstring date-time

created_byinteger

date_modifiedstring date-time

modified_byinteger

campaign_notesstring nullable

Example response

{
  "date_created": "2023-04-01 00:00:00",
  "date_modified": "2023-04-01 00:00:00"
}