Campaign
Campaigns are groups of products that may be given new prices when purchased through the campaign. For a campaign to be applied to a purchase, it’s campaignId needs to be part of the purchase URL. Campaigns may have limitations on their availability in time (start and stop dates), count (ie how many times it has been used), voucher (requires a valid voucher code to use) or address (the user must supply a physical address in order to use it).
Although campaigns are intended for temporary special offers, they may also be used as permanent way of getting lists of products. For this use case one has to be aware that the newPrice of campaign products does not update automatically if the product price is updated.
campaignId ✓ | integer (as string)The campaign's unique ID. Needs to be part of any purchase URL that should have the campaign applied |
|---|---|
clientId ✓ | stringID of the client that owns this campaign |
title ✓ | stringCampaign title |
description ✓ | stringAdditional campaign description |
metaData | stringNot used by Schibsted account, for client-specific meta-data |
startDate ✓ | datetimeWhen the campaign starts/becomes active |
stopDate ✓ | datetimeWhen the campaign stops/ceases to be active |
additionalReceiptInfo | stringAdditional text to include in purchase receipts for this campaign |
requireAddress ✓ | string, "1" (true) or "0" (false)If |
requireVoucher ✓ | string, "1" (true) or "0" (false)If |
status ✓ | Campaign status |
limit ✓ | integer (as string)Maximum number of purchases allowed for this campaign |
count ✓ | integer (as string)The number of purchases made on this campaign so far |
updated ✓ | datetimeWhen the campaign was last updated |
created ✓ | datetimeWhen the campaign was created |
products | list of Campaign productsThe campaign's products |
The check mark ✓ indicates that the field always contains a valid non-empty value.
Campaign status
An enum, with the following possible values:
| New |
|---|---|
| Active |
Comments/feedback
Do you have questions, or just want to contribute some newly gained insight? Want to share an example? Please leave a comment. Our team reads and responds to every question. Additionally, your experience can help others using Schibsted account, and it can help us continuously improve our documentation.