Variant price campaign

General

Variant price campaign is a reduction within a campaign for a certain product variant.
You can overwrite generic price campaign with variant specific values.

If you want to reduce a product (all of its variants) by the same amount, you can use the Create or update product reductions method.

Admin API

Learn how to create, update and delete product and variant reductions.

Create or update variant reductions

This method is used to create or update product variant campaign reductions.

JavaScriptPHPcURLJava

Copy

await adminApi.apis.Campaigns.updateOrCreateVariantReductions({shopKey: shopKey, campaignId: campaignId}, {requestBody: reductions});

Examples

Create variant reductions

JavaScriptPHPcURLJava

Copy

let reductions = [
    {
        productVariantId: 1,
        reduction: 10
    },
    {
        productVariantReferenceKey: "my-reference-key",
        reduction: 20
    }
]

await adminApi.apis.Campaigns.updateOrCreateVariantReductions({shopKey: "ms", campaignId: 1}, {requestBody: reductions});

Create or update product reductions

Learn how to create product-specific price discounts.

When running a product-specific price campaign, all product variants will inherit the defined reduction.

This method is used to create or update product campaign reductions. Internally reductions are applied on variant level, this method is a shortcut to provide reductions for a product by setting the same reduction to all variants.

JavaScriptPHPcURLJava

Copy

await client.apis.Campaigns.updateOrCreateProductReductions({shopKey: shopKey, campaignId: campaignId}, {requestBody: reductions});

Examples

Create product reductions

JavaScriptPHPcURLJava

Copy

let reductions = [
    {
        productId: 1,
        reduction: 10
    },
    {
        productReferenceKey: "my-reference-key",
        reduction: 20
    }
]

await adminApi.apis.Campaigns.updateOrCreateProductReductions({shopKey: "ms", campaignId: 1}, {requestBody: reductions});

Get a collection of reductions

When requesting multiple reductions, you can paginate results and apply other parameters to narrow down your query.

This method can be used to get a collection of existing reductions. It is possible to refine the search by applying filters in the options.

As all reductions are stored internally on variant level, this method will return a collection of product variant campaign reductions.

Options

The operation can be used with optional parameters - called options:

If you do not provide filters, this method will return all product variant campaign reductions belonging to a specific campaign. You have the option to refine the results by applying filters for specific variants and/or products by using their respective IDs or reference keys.

Parameter

Examples

Get a Reduction Collection

JavaScriptPHPcURLJava

Copy

let response = await adminApi.apis.Campaigns.getCampaignReductions({shopKey: "ms", campaignId: 1});
let reductions = response.body.entities;

reductions.forEach(
    reduction => console.log(reduction.productVariantReferenceKey + ": " + reduction.reduction)
);

Read with Options

Get a reduction collection by filters:

JavaScriptPHPcURLJava

Copy

let options = {
    "shopKey": "ms",
    "campaignId": 1,
    "filters[variantId]": 1,
    "filters[variantReferenceKey]": "myVariantReferenceKey",
    "filters[productId]": 3,
    "filters[productReferenceKey]": "myProductReferenceKey"
};

let response = await adminApi.apis.Campaigns.getCampaignReductions(options);
let reductions = response.body.entities;

reductions.forEach(
    reduction => console.log(reduction.productVariantReferenceKey + ": " + reduction.reduction)
);

Delete campaign reductions

Delete any given price campaigns by using its ID.

You can choose to remove specific products or variants from a campaign with their reference key or ID.

This method can be used to delete existing campaign reductions. You can either call the method without any filters resulting in deletion of all reductions assigned to the provided campaign. If you only want to delete reductions for specific products or variants you can use several filter options.

JavaScriptPHPcURLJava

Copy

await adminApi.apis.Campaigns.deleteCampaignReductions({shopKey: shopKey, campaignId: campaignId});

Options

The operation can be used with optional parameters - called options:

Examples

Delete All Reductions

JavaScriptPHPcURLJava

Copy

await adminApi.apis.Campaigns.deleteCampaignReductions({shopKey: "ms", campaignId: 1});

Delete with Options

Delete specific reductions:

JavaScriptPHPcURLJava

Copy

let options = {
    "shopKey": "ms",
    "campaignId": 1,
    "filters[variantId]": 1,
    "filters[variantReferenceKey]": "myVariantReferenceKey",
    "filters[productId]": 3,
    "filters[productReferenceKey]": "myProductReferenceKey"
};

await adminApi.apis.Campaigns.deleteCampaignReductions(options);