create campaigns

Creates a new campaign.

Options:

Create a new source and offer code
Creating a new source code
Assign existing offer codes to new source code
Assign existing offer codes to existing source code

For offer assignments please don't fill in offer related fields!

Path mapping(intern): /net/dsb/avs3/MasterData/createCampaigns-1.0.0
SAP REST: /CREATE_CAMPAIGN

URL

POST: /rest/{client}/campaigns?sp={sp}&so={so}&check={check}

Parameter	Description
client	client id
sp	service provider. (mandatory if the user account can use different service provider values)
so	sales organization. (mandatory if the user account is only allowed to use some sales orgas of the client)
check	true / false

Request Body

Examples

1. Create a new source and offer code with random names

{
    "sourceCode": "",
    "sourceCodeVariant": "",
    "sourceCodeDesc": "Test",
    "validFromDate": "2017-01-01",
    "validToDate": "9999-12-31",
    "salesChannel": "",
    "mediaGroup": "",
    "mediaCode1": "C",
    "mediaCode2": "2",
    "mediaCode3": "E",
    "glAccount": "110009",
    "offerCode": "",
    "publication": "00002800",
    "edition": "00002800",
    "offerDesc": "13 issues",
    "offerType": "RN",
    "marketingText": "Marketing text",
    "priceUplType": "",
    "priceUplMethod": "ALL",
    "term": "13",
    "freeCycle": "",
    "shopId": "000",
    "rejectionRule": 0,
    "bundleKey": "",
    "freeIssues": "",
    "freeIssuesHandling": "",
    "paymDueImmediately": false,   
    "shopCampaign": "",
    "giftSet": "STANDARD",
    "gifts": [
        "Gift1",
        "Gift2",
        "Gift3"
    ],
    "prices": [
        {
            "priceListType": "01",
            "postageKey": "DM",
            "price": 220,
            "currencyKey": "",
            "contPhase": ""
        }
    ]
}

2. Create an new step up offer code and assign it to an existing source code

    {
    "sourceCode": "Test123",
    "offerCode": "",
    "publication": "00002800",
    "offerDesc": "Offer description",
    "offerType": "DD",
    "marketingText": "Marketing text",
    "priceUplType": "",
    "priceUplMethod": "ALLC",
    "glAccount": "110009",
    "term": "",
    "freeCycle": "",
    "rejectionRule": 0,
    "freeIssues": "",
    "freeIssuesHandling": "",
    "paymDueImmediately": false,
    "shopCampaign": "",
    "contPaymSetup": [
        {
            "contPhase": "1",
            "contPaymTerm": "M1",
            "contNoClaims": 3
        },
        {
            "contPhase": "2",
            "contPaymTerm": "M2",
            "contNoClaims": 10
        },
        {
            "contPhase": "3",
            "contPaymTerm": "M3",
            "contNoClaims": 9999
        }
    ],
    "giftSet": "STANDARD",
    "gifts": [
        "Gift1",
        "Gift2",
        "Gift3"
    ],
    "PRICES": [
        {
            "contPhase": "1"
            "priceListType": "01",
            "postageKey": "DM",
            "price": 1,
            "currencyKey": "GBP"
        },
        {
            "contPhase": "2"
            "priceListType": "01",
            "postageKey": "DM",
            "price": 20,
            "currencyKey": "GBP"
        },
        {
            "contPhase": "3"
            "priceListType": "01",
            "postageKey": "DM",
            "price": 50,
            "currencyKey": "GBP"
        }
    ]
}

3. Create a bundle new step up campaign

{
    "sourceCode": "Test123",
    "offerCode": "",
    "publication": "00002800",
    "offerDesc": "Offer description",
    "offerType": "BD",
    "marketingText": "MarketingText",
    "priceUplType": "",
    "priceUplMethod": "ALLC",
    "mediaCode1": "C",
    "mediaCode2": "2",
    "mediaCode3": "E",
    "glAccount": "110009",
    "term": "",
    "freeCycle": "",
    "rejectionRule": 0,
    "bundleKey": "BU_KEY",
    "freeIssues": "",
    "freeIssuesHandling": "",
    "contPaymSetup": [
        {
            "contPhase": "1",
            "contPaymTerm": "M1",
            "contNoClaims": 3
        },
        {
            "contPhase": "2",
            "contPaymTerm": "M2",
            "contNoClaims": 10
        },
        {
            "contPhase": "3",
            "contPaymTerm": "M3",
            "contNoClaims": 9999
        }
    ],
    "giftSet": "STANDARD",
        "gifts": [
        "Gift1",
        "Gift2",
        "Gift3"
    ],
    "PRICES": [
        {
            "contPhase": "1"
            "priceListType": "01",
            "postageKey": "DM",
            "price": 1,
            "currencyKey": "GBP"
        },
        {
            "contPhase": "2"
            "priceListType": "01",
            "postageKey": "DM",
            "price": 10,
            "currencyKey": "GBP"
        },
        {
            "contPhase": "3"
            "priceListType": "01",
            "postageKey": "DM",
            "price": 30,
            "currencyKey": "GBP"
        }   
        }
    ]
}

4. Assign existing offer codes to existing source code

{
    "sourceCode": "0002",
    "assignOffers": [
        "1124R",
        "1124W"
    ]
}

5. Assign existing offer codes to new source code

{
    "sourceCode": "",
    "sourceCodeVariant": "",
    "sourceCodeDesc": "Description",
    "sourceCodeDescLong": "SC description",
    "validFromDate": "2017-01-01",
    "validToDate": "9999-12-31",
    "salesChannel": "MA",
    "mediaGroup": "",
    "mediaCode1": "C",
    "mediaCode2": "2",
    "mediaCode3": "E",
    "glAccount": "110009",
    "assignOffers": [
        "1124R",
        "1124W"
    ]
}

6. Create a source code only

{
    "sourceCode": "Test12",
    "sourceCodeVariant": "",
    "sourceCodeDesc": "d",
    "sourceCodeDescLong": "Test Lang",
    "validFromDate": "2017-01-01",
    "validToDate": "9999-12-31",
    "salesChannel": "MA",
    "mediaGroup": "",
    "mediaCode1": "C",
    "mediaCode2": "2",
    "mediaCode3": "E",
    "glAccount": "110009"
}

7. Two options are available for creating an RN offer code
- 7.1. Term of the phase is provided in field “term”

{
    "sourceCode": "TEST",
        "offerCode": "XXXX1",
        "publication": "00000100",
        "offerDesc": "Desc",
        "offerType": "RN",
        "marketingText": "Text",
        "freeIssues": "",
        "term": "M1",
        "freeIssuesHandling": "",
        "prices": [
        {
            "priceListType": "01",
            "postageKey": "DM",
            "price": 1,
            "currencyKey": "GBP",
        }
    ]
}

- 7.2. Term can be provided as a phase within “contPaymSetup”. Therefore RN and DD offers can set up in a similar way.

{
    "sourceCode": "TEST",
        "offerCode": "XXXX2",
        "publication": "00000100",
        "offerDesc": "Desc",
        "offerType": "RN",
        "marketingText": "Text",
        "freeIssues": "",
        "term": "",
        "freeIssuesHandling": "",
        "contPaymSetup": [
            {
                "contPaymTerm": "M1"
            }
        ],
     "prices": [
        {
            "priceListType": "01",
            "postageKey": "DM",
            "price": 22,
            "currencyKey": "GBP",
        }
    ]
}

The Body of the Post Request contains a JSON document with campaign relevant data.

Parameter	Type / Length	Description	Mandatory reuse SC	Mandatory new SC
sourceCode	C/10	Source code (if blank the system will generate the SC name automatically)	X
sourceCodeVariant	C/1	Source code variation
sourceCodeDesc	C/20	Source code description		X
sourceCodeDescLong	C/50	Source code description long
validFromDate	D/8	Source code valid-from		X
validToDate	D/8	Source code valid-to		X
salesChannel	C/2	Sales Channel
salesOrg	C/4	Sales Organization in source code
mediaGroup	C/1	Media group (used for statistic grouping)		X
mediaCode1	C/1	Exceeded logic for creating the media group. Only active on 670.		X
mediaCode2	C/1	Exceeded logic for creating the media group. Only active on 670.		X
mediaCode3	C/1	Exceeded logic for creating the media group. Only active on 670.		X
glAccount	C/10	GL acocunt
offerCode	C/5	Offer code (if blank the system will generate the offer name automatically)
publication	C/8	Publication	X
edition	C/8	Edition
offerDesc	C/100	Offer description	X
offerType	C/2	Offer type of the offer from current cycle (RN, DD, BU, BD)	X
giftSet	C/10	Gift set
marketingText	C/100	Marketingtext of the offer from current cycle
priceUplType	C/1	Price shop upload type ('A' = all prices, ' ' = only specified prices)
priceUplMethod	C/10	Possible payment types (INV, DD, CC, ALL… )
term	C/2	Payment term (Y1, 06 …) only for offer type RN
freeCycle	B	Free cycle (true = free, false = payed cycle)
shopId	C/3	Shop ID
rejectionRule	N/3	Rejection rule Blacksheep detection. Active on 670.
bundleKey	C/10	Bundle Key (necessary to set up Bu and BD campaigns)
freeIssues	C/2	Free issues in terms (e.g. M1 = one month, 01 = 1 issue … )
freeIssuesHandling	C/1	RN/BU: ' ' - Free cycle '1' - Free cycle before payed one '2' - Free cycle after payed one '3' - Free continuous cycle '4' -Free Cycle before payed CC cycle DD/BD: D = free issues before Direct Debit (delayed 1st claim) K = follow-up cycle in
shopCampaign	C/10	Shop campaign used to group articles in the shop (offer Code level)
shopEditionCampaign	C/10	Shop campaign used to group articles in the shop (source Code level) (BETA)
paymDueImmediately	boolean	Payment will be due immediately
giftReleaseAtClaim	N/3	Claim which will trigger the gift release
createDigitalCopy	boolean	Create digital copy of the offer code setup (print - digital relationship needs to be maintained first)
contPaymSetup
contPhase	C/1	1 = first phase, 2 = second phase, 3 = third phase
contPaymTerm	C/2	Payment term (Y1, 06 …)
contNoClaims	N/4	Number of claims (claim last phase = 9999)
gifts
gift	C/18	gift (max 3)
prices
contPhase	C/1	1 = first phase, 2 = second phase, 3 = third phase
priceListType	C/2	Price list type
postageKey	C/2	Postage key (for shipping costs ascertainment)
price	C/11	Price
currencyKey	C/5	Currency
assignOffers
offerCode	C/5	offer codes

Response

The response is a JSON document containing the result.

Element	Description
status	OK or NOTOK
code	internal error code
message	list of messages in case of an error
campaign
sourceCode	Source code
offerCodes	Offer codes which were created / assigned
publication	Publication code
shopArticles	generated shop articles (BETA)

Example:

{
    "status": "NOTOK",
    "code": XXXX,
    "message": "Please enter source description",
    "campaign": {
        "sourceCode": "",
        "offerCodes": [],
        "publication": "",
        "shopArticles" []
    }
}

{

  "status": "OK",
  "code": 0,
  "message": "Test successful",
  "campaign": {
      "sourceCode": "",
      "offerCodes": [
          "1124R",
          "1124W"
      ],
      "publication": "",
      "shopArticles" [897270, 897271]
  }

}