POST api/campaign/{name}/batch
Apply pricing, cost or discount changes to campaign plus as a batch
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| name |
name of campaign to update |
string |
Required |
Body Parameters
Batch object with settings for change
CampaignBatchApplication| Name | Description | Type | Additional 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. |
| PluG_UIDs |
Product guids to apply changes to. |
Collection of 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": "3ed33370-3c7f-46f3-a32e-d414b777822c",
"pluG_UIDs": [
"53f2fe45-491f-41a5-a26e-49bb3b40e005",
"d6155f8b-40f8-4d38-98ea-bdad540c963b"
]
}
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>
<PluG_UIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>53f2fe45-491f-41a5-a26e-49bb3b40e005</d2p1:guid>
<d2p1:guid>d6155f8b-40f8-4d38-98ea-bdad540c963b</d2p1:guid>
</PluG_UIDs>
<PriceGroupGuid>3ed33370-3c7f-46f3-a32e-d414b777822c</PriceGroupGuid>
</CampaignBatchApplication>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
None.