This is a html view of the json schema please take the json schema as reference DOWNLOAD THE JSON SCHEMA

PromotionCampaigns

Type: array

An array of Promotion Campaigns. We only need the list of updated campaign.

 No Additional Items

Each item of this array must be:

root PromotionCampaign

PromotionCampaign

Type: object

Promotion Campaign on qualified products. We expect to have all campaign fields when a campaign is updated. To disable a campaign the endDate can be used, Only one document pdf is supported today to explain the promotion on campaign page

root PromotionCampaign id
Type: string

The unique campaign identifier
Examples:

"campaign1"

"454543"

root PromotionCampaign type
Type: enum (of string) Default: "PRICE_REDUCTION"

The type of the promotion

Must be one of:

  • "BXGY"
  • "FREEBIE"
  • "BUNDLE"
  • "DESTOCKING"
  • "PRICE_REDUCTION"

root PromotionCampaign title

Multilingual Object

Type: object

short description of the campaign
Example:

{
    "fr-FR": "2 Achetés le 3 troisiéme gratuit",
    "en-GB": "2 Purchased the 3rd free"
}

Each additional property must conform to the following schema

root PromotionCampaign title additionalProperties
Type: string

root PromotionCampaign description

Multilingual Object

Type: object

details about the promotion and the qualifier rules
Example:

{
    "fr-FR": "Achetez-en un, obtenez-en un sur tous les produits appartenant à cette campagne",
    "en-GB": "Buy one get one on all products belonging to this campaign"
}

Each additional property must conform to the following schema

root PromotionCampaign description additionalProperties
Type: string

root PromotionCampaign startDate
Type: stringFormat: date-time

date when the campaign start (All date formats follow ISO 8601 standard)
Example:

"2020-10-14T10:22:00.116Z"

root PromotionCampaign endDate
Type: stringFormat: date-time

date when the campaign finish (All date formats follow ISO 8601 standard)
Example:

"2020-10-14T10:22:00.116Z"

root PromotionCampaign productIds
Type: array of string

list of product ids associated to the promotion campaign

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

root PromotionCampaign productIds productIds items
Type: string

ProductId associated to the promotion campaign

Example:

[
    "5226167",
    "9885543",
    "2343343"
]

root PromotionCampaign restrictions
Type: array

Only this list of account Id or/and commercial organisation ids have access to this campaign

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

root PromotionCampaign restrictions Restriction

Restriction

Type: object

root PromotionCampaign restrictions Restriction orgId
Type: string

Needed by OpCo organised with a regional model or commercial organisation.
Examples:

"SIF"

"SNE"

root PromotionCampaign restrictions Restriction accountIds
Type: array

An array of the account ids same as sent in the account feed, theaccountId field. If the orgId is sent then all accounts should be associated to that orgId

 No Additional Items
Example:

[
    "123456",
    "123478_SNE"
]

root PromotionCampaign ranking
Type: integer

The ranking of the promotion campaign, this will be used to sort promotion. Ranking = '1' being the strongest value. If this not present, promotion with nearest endDate will be shown first.

Value must be greater or equal to 1


Examples:

{
    "ranking": 90
}

{
    "ranking": 1
}