POST api/campaign/{name}/batch

Apply pricing, cost or discount changes to campaign plus as a batch

Request Information

URI Parameters

NameDescriptionTypeAdditional information
name

name of campaign to update

string

Required

Body Parameters

Batch object with settings for change

CampaignBatchApplication
NameDescriptionTypeAdditional information
CampaignName

Campaign Name of campaign to apply batch change to

string

None.

Changes

List of changes to apply

Collection of CampaignBatchFieldChange

None.

ApplyRoundingRules

Should Rounding Rules be applied to Price/Cost?

boolean

None.

ExcludeAdvertised

Exclude CampaignPlu records that have a PromotionPlacement that is advertised

boolean

None.

MaintainMinimumGP

Apply the minimum GP % to the changed CampaignPLUs

boolean

None.

MinimumGP

Minimum GP % to apply

decimal number

None.

PriceGroupGuid

Price group to apply changes to singularly

globally unique identifier

None.

Request Formats

application/json, text/json

Sample:
{
  "campaignName": "sample string 1",
  "changes": [
    {
      "$id": "2",
      "changeField": 1,
      "changeAction": 2,
      "changeUnit": 3,
      "change": 4.1
    },
    {
      "$ref": "2"
    }
  ],
  "applyRoundingRules": true,
  "excludeAdvertised": true,
  "maintainMinimumGP": true,
  "minimumGP": 5.1,
  "priceGroupGuid": "ea79f061-3a73-4898-b643-3b4d64cfb9e5"
}

application/xml, text/xml

Sample:
<CampaignBatchApplication xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EziManager.Models.EMC.Campaigns">
  <ApplyRoundingRules>true</ApplyRoundingRules>
  <CampaignName>sample string 1</CampaignName>
  <Changes>
    <CampaignBatchFieldChange>
      <Change>4.1</Change>
      <ChangeAction>2</ChangeAction>
      <ChangeField>1</ChangeField>
      <ChangeUnit>3</ChangeUnit>
    </CampaignBatchFieldChange>
    <CampaignBatchFieldChange>
      <Change>4.1</Change>
      <ChangeAction>2</ChangeAction>
      <ChangeField>1</ChangeField>
      <ChangeUnit>3</ChangeUnit>
    </CampaignBatchFieldChange>
  </Changes>
  <ExcludeAdvertised>true</ExcludeAdvertised>
  <MaintainMinimumGP>true</MaintainMinimumGP>
  <MinimumGP>5.1</MinimumGP>
  <PriceGroupGuid>ea79f061-3a73-4898-b643-3b4d64cfb9e5</PriceGroupGuid>
</CampaignBatchApplication>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

None.