Gets a campaign by ID.

Gets a campaign by ID.

Path Parameters
id uuid — REQUIRED The campaign ID.

Responses
200 The requested campaign. Schema — OPTIONAL Resource object — OPTIONAL CampaignNumber int32 — OPTIONAL Status string — OPTIONAL RoundingMethod string — OPTIONAL ContractVersion string — OPTIONAL CampaignId uuid — OPTIONAL Campaign ID. CampaignBaseType int32 — OPTIONAL Possible values: [0, 1, 2, 3] Campaign base type. Allowed values are code, cart, and product. 0 = NOT_SET 1 = cart 2 = code 3 = product Title object[] — OPTIONAL Localized titles. Language string — OPTIONAL The language of the localized item. Value string — OPTIONAL The value of the localized item. Description string — OPTIONAL Description. MarketId string — OPTIONAL Market ID. CampaignTypeId int32 — OPTIONAL Campaign type ID. Fetch available campaign types from the campaign/types endpoint. BuyQuantity int32 — OPTIONAL Buy quantity. Amounts object — OPTIONAL Amounts. Key is ISO Currency code. Used by campaign types with an amount discount. PayForQuantity int32 — OPTIONAL Pay for quantity. Priority int32 — OPTIONAL Priority. StopCombining boolean — OPTIONAL Indicates whether to stop combining. ValidFrom date-time — OPTIONAL Valid from date. ValidTo date-time — OPTIONAL Valid to date. PromoCode string — OPTIONAL Promo code. HideTitle boolean — OPTIONAL Indicates whether to hide the title. CantCombineWithCartCampaign boolean — OPTIONAL Indicates whether the campaign cannot be combined with cart campaigns. PercentageValue double — OPTIONAL Percentage value. ExcludeProductsOnSale boolean — OPTIONAL Indicates whether to exclude products on sale. SaleTypesToEnforce int32 — OPTIONAL Possible values: [0, 1, 2, 3] Sale types to enforce. Possible values are campaign, sale, and all. 0 = NOT_SET 1 = campaign 2 = sale 3 = all MinimumPurchaseAmounts object — OPTIONAL Minimum purchase amounts. MinimumQuantity int32 — OPTIONAL Minimum quantity. OncePerCustomer boolean — OPTIONAL Indicates whether the campaign is limited to once per customer. UseSalePrice boolean — OPTIONAL Indicates whether to use the sale price when calculating campaign price. FreeShipping boolean — OPTIONAL Indicates whether free shipping is included. UsageLimit int32 — OPTIONAL Usage limit. Prices object — OPTIONAL Prices. Can be used with percentage campaign type. LandingPage object — OPTIONAL Represents a campaign landing page. Title object[] — OPTIONAL Localized titles for the landing page. Language string — OPTIONAL The language of the localized item. Value string — OPTIONAL The value of the localized item. Url object[] — OPTIONAL Localized URLs for the landing page. These can not be set directly, but are generated from the title. Values string[] — OPTIONAL Additional values for the extended localized item. Language string — OPTIONAL The language of the localized item. Value string — OPTIONAL The value of the localized item. Description object[] — OPTIONAL Localized descriptions for the landing page. Language string — OPTIONAL The language of the localized item. Value string — OPTIONAL The value of the localized item. Meta object — OPTIONAL Represents the meta information for a campaign landing page. Title object[] — OPTIONAL Localized titles for the meta information. Language string — OPTIONAL The language of the localized item. Value string — OPTIONAL The value of the localized item. Keywords object[] — OPTIONAL Localized keywords for the meta information. Language string — OPTIONAL The language of the localized item. Value string — OPTIONAL The value of the localized item. Description object[] — OPTIONAL Localized descriptions for the meta information. Language string — OPTIONAL The language of the localized item. Value string — OPTIONAL The value of the localized item. SelectedUsers string[] — OPTIONAL Selected users, usually an array of email addresses. SelectedGroups string[] — OPTIONAL Selected groups, usually an array of customer group IDs. Enabled boolean — OPTIONAL Indicates whether the campaign is enabled. ProductSelection object — OPTIONAL Represents the product selection criteria. Include object — OPTIONAL Represents the data for product selection criteria. Condition int32 — OPTIONAL Possible values: [0, 1] Condition for combining criteria. 0 = and. Logical AND condition. 1 = or. Logical OR condition. Categories object[] — OPTIONAL List of category selections. Id int32 — OPTIONAL Item ID. Name string — OPTIONAL Item name. Brands object[] — OPTIONAL List of brand selections. Id int32 — OPTIONAL Item ID. Name string — OPTIONAL Item name. Products int32[] — OPTIONAL List of product IDs. Price object[] — OPTIONAL List of price selections. Condition int32 — OPTIONAL Possible values: [0, 1, 2] Condition for the price selection. 0 = lt. Less than condition. 1 = gt. Greater than condition. 2 = eq. Equal to condition. Prices object — OPTIONAL Dictionary of prices. Currency ISO code is used for the key. Exclude object — OPTIONAL Represents the data for product selection criteria. Condition int32 — OPTIONAL Possible values: [0, 1] Condition for combining criteria. 0 = and. Logical AND condition. 1 = or. Logical OR condition. Categories object[] — OPTIONAL List of category selections. Id int32 — OPTIONAL Item ID. Name string — OPTIONAL Item name. Brands object[] — OPTIONAL List of brand selections. Id int32 — OPTIONAL Item ID. Name string — OPTIONAL Item name. Products int32[] — OPTIONAL List of product IDs. Price object[] — OPTIONAL List of price selections. Condition int32 — OPTIONAL Possible values: [0, 1, 2] Condition for the price selection. 0 = lt. Less than condition. 1 = gt. Greater than condition. 2 = eq. Equal to condition. Prices object — OPTIONAL Dictionary of prices. Currency ISO code is used for the key. Group string — OPTIONAL Group. Use it to group similar campaigns. PriceOutput int32 — OPTIONAL Possible values: [0, 1] Price output type. 0 = Campaign 1 = Sale Message string — OPTIONAL A status message for the action taken. Details string[] — OPTIONAL Any validation messages for the data on the current action.
400 Bad request. Schema — OPTIONAL Message string — OPTIONAL A status message for the action taken. Details string[] — OPTIONAL Any validation messages for the data on the current action.
404 Not found. Schema — OPTIONAL Message string — OPTIONAL A status message for the action taken. Details string[] — OPTIONAL Any validation messages for the data on the current action.