How to submitted offers to campaigns

Use this resource to retrieve a list of available campaigns.

Sample request:

curl -X GET \
‘https://api.allegro.pl/sale/badge-campaigns’ \
  -H 'Authorization: Bearer {token}' \
  -H 'Content-Type: application/vnd.allegro.beta.v1+json '

Sample response:

{
 "badgeCampaigns": [
   {
     "id": "BARGAIN",               -- campaign ID
     "name": "Strefa okazji",       -- campaign name
     "type": "DISCOUNT",            -- campaign type; three types are supported 
                                    STANDARD – adding a badge (e.g. Hit or New) 
                                    displayed on the list of offers
                                    DISCOUNT – we will change the offer price, 
                                    and display on the list of offers crossed 
                                    out market price you provided in the application 
                                    SOURCING – we will change the price, but 
                                    no badge will be added; however, 
                                    you will be entitled to bonuses arising 
                                    out of terms and conditions of 
                                    the given campaign, e.g. lower success fee.
     "eligibility": {               -- is the campaign available for the given user
       "eligible": true,
       "refusalReasons": []         -- campaign requirements the user does not meet 
     },
     "application": {               -- period for submitting offers
       "type": "ALWAYS",            -- duration time; 5 values are supported, i.e. 
                                    ALWAYS, SINCE (as of particular day), 
                                    UNTIL (period), WITHIN (until a particular day), 
                                    NEVER
       "from": null,
       "to": null
     },
     "publication": {               -- badge duration time  
       "type": "ALWAYS",            -- duration time; 5 values are supported, i.e. 
                                    ALWAYS, SINCE (as of particular day), 
                                    UNTIL (period), WITHIN (until a particular day), 
                                    NEVER
       "from": null,
       "to": null
     },
     "visibility": {                -- time during which the campaign is displayed by 
                                    campaign management tools (it is not equal to 
                                    the display time of campaign badge). 
                                    These ranges help verify how long information 
                                    about a particular campaign will 
                                    be available on the platform.
       "type": "ALWAYS",            -- duration time; 5 values are supported, i.e. 
                                    ALWAYS, SINCE (as of particular day), 
                                    UNTIL (period), WITHIN (until a particular day), 
                                    NEVER
       "from": null,
       "to": null
     }
   },
…
   ]
}

This way, you will submit your offer to a particular campaign.

Applications that do not meet campaign requirements will be rejected.

Sample request:

curl -X POST \
‘https://api.allegro.pl/sale/badges’ \
-H 'Authorization: Bearer {token}' \
-H 'Content-Type: application/vnd.allegro.beta.v1+json' \
-d '{
    "campaign": {
        "id": "BARGAIN"             -- required; ID of a campaign you want to 
                                    assign to the offer – according to 
                                    GET /sale/badge-campaigns
    },
    "offer": {
        "id": "6206378062"          -- required; ID of an offer you want 
                                    to add to the campaign
    },
    "prices": {                     -- required in the case of DISCOUNT and
                                    SOURCING campaigns; information about 
                                    a price to be displayed, and the market price
        "market": {                 -- required in the case of DISCOUNT campaign; 
                                    product’s market price that will be crossed 
                                    out on the list of offers
            "amount": "200.00",
            "currency": "PLN"
        },
        "bargain": {                -- required in the case of DISCOUNT and 
                                    SOURCING campaigns; promotional price
            "amount": "180.00",
            "currency": "PLN"
        }
    },
    "purchaseConstraints": {        -- optional - constraints on purchases 
                                    of this offer while it participates
                                    in the campaign
        "limit": {
            "perUser": {
                "maxItems": "1"     -- limit of items of the offer that 
                                    one user can buy, while offer participates
                                    in the campaign
            }
        }
    }
}'

Sample response:

{
 "id": "8a457b8f-627d-43cf-8806-f06f8d13c306",  -- ID of the offer application
 "createdAt": "2019-06-26T10:22:35.225Z",       -- application creation data
 "updatedAt": "2019-06-26T10:22:35.225Z",       -- recent application update
 "campaign": {
   "id": "BARGAIN"                              -- campaign ID
 },
 "offer": {
   "id": "6206378062"                           -- ID of the offer you want to assign 
                                                to the campaign
 },
 "prices": {                                    -- information about a price to be displayed, 
                                                and the market price
   "bargain": {                                 -- offer’s promotional price
     "amount": "180.00",
     "currency": "PLN"
   },
   "market": {                                  -- product’s market price that 
                                                will be crossed out on the list of offers
     "amount": "200.00",
     "currency": "PLN"
   }
 },
 "purchaseConstraints": {                       -- optional - constraints on purchases 
                                                of this offer while it participates
                                                in the campaign
   "limit": {
     "perUser": {
       "maxItems": "1"                          -- limit of items of the offer that 
                                                one user can buy, while offer participates
                                                in the campaign
     }
   }
 },
 "process": {
   "status": "REQUESTED",                       -- application status; three values are supported: 
                                                REQUESTED (application is waiting for processing),  
                                                PROCESSED (application has been processed, 
                                                but the badge may not be displayed yet). 
                                                As of that moment, you can check if 
                                                the badge is assigned to the offer by calling
                                                GET sale/badges), 
                                                DECLINED (application was rejected)
   "rejectionReasons": []                           -- reason for rejecting the application
 }}

Use this resource to retrieve campaign applications and check their status.

Sample request:

curl -X GET \
‘https://api.allegro.pl/sale/badge-applications/8a457b8f-627d-43cf-8806-f06f8d13c306’ \
  -H 'Authorization: Bearer {token}' \
  -H 'Content-Type: application/vnd.allegro.beta.v1+json'

Sample response:

{
 "id": "8a457b8f-627d-43cf-8806-f06f8d13c306",  -- ID of the offer application
 "createdAt": "2019-06-26T10:22:35.225Z",       -- application creation date
 "updatedAt": "2019-06-26T10:22:35.225Z",       -- recent application update
 "campaign": {
   "id": "BARGAIN"                              -- campaign ID
 },
 "offer": {
   "id": "6206378062"                           -- ID of the offer you want to assign 
                                                to the campaign
 },
 "prices": {                                    -- information about a price to be displayed, 
                                                and the market price
   "bargain": {                                 -- offer’s promotional price
     "amount": "180.00",
     "currency": "PLN"
   },
   "market": {                                  -- product’s market price that will be 
                                                crossed out on the list of offers
     "amount": "200.00",
     "currency": "USD"
   }
 "process": {
   "status": "DECLINED",                        -- application status; three values are supported: 
                                                REQUESTED (application is waiting for processing), 
                                                PROCESSED (application has been processed, 
                                                but the badge may not be displayed yet). 
                                                As of that moment, you can check if 
                                                the badge is assigned to the offer by calling
                                                GET sale/badges), 
                                                DECLINED (application is rejected))
   "rejectionReasons": [                            -- information on rejection reasons
     {
       "code": "BB5",                           -- reason for rejecting the application
       "messages": [
         {
           "text": "Currency is not equal to ‘PLN’"
           "link": null
         }
       ]
     }
   ]
 }
}

Use this resource to retrieve all campaign applications.

When submitting the requests, you need to provide one of the parameters:

• campaign.id - campaign ID
• offer.id - offer ID.

To adjust the search list to your needs, use the following parameters:

• limit to define a number of offers on a list (values from 1 to 50)
• offset to define a starting point for retrieving another batch of data (0 by default).

Sample request:

curl -X GET \
‘https://api.allegro.pl/sale/badge-applications?campaign.id=BARGAIN’ \
  -H 'Authorization: Bearer {token}' \
  -H 'Content-Type: application/vnd.allegro.beta.v1+json'

Sample response:

{
 "badgeApplications": [                         -- list of offer application to a particular campaign 
{
 "id": "8a457b8f-627d-43cf-8806-f06f8d13c306",
 "createdAt": "2019-06-26T10:22:35.225Z",
 "updatedAt": "2019-06-26T10:22:35.225Z",
 "campaign": {
   "id": "BARGAIN"
 },
 "offer": {
   "id": "6206378062"
 },
 "prices": {
   "bargain": {
     "amount": "180.00",
     "currency": "PLN"
   },
   "market": {
     "amount": "200.00",
     "currency": "PLN"
   }
 },
 "process": {
   "status": "DECLINED",
   "rejectionReasons": [
     {
       "code": "BA1",
       "messages": [
         {
           "text": "Badge already exists"
         },
         {
           "text": "check terms & conditions",
           "link": "http://allegro.pl/xyz"
         }
       ]
     }
   ]
 }
}
]
}

Use this resource to check badges assigned to offers.

To adjust the search list to your needs, use the following parameters:

• limit to define a number of offers on a list (values from 1 to 50)
• offset to define a starting point for retrieving another batch of data (0 by default).

You can use this resource to check badges assigned to a particular offer, call GET /sale/badges?offer.id={offerId}.

Sample request:

curl -X GET \
‘https://api.allegro.pl/sale/badges’ \
  -H 'Authorization: Bearer {token}' \
  -H 'Content-Type: application/vnd.allegro.beta.v1+json'

Sample response:

 {
   "badges": [
     {
       "offer": {
         "id": "6206378062"
       },
       "campaign": {
         "id": "BARGAIN",
         "name": "Strefa okazji"
       },
       "publication": {
         "type": "ALWAYS"
       },
       "prices": {
         "market": {
           "amount": "19.99",
           "currency": "PLN"
         }
       },
       "process": {
         "status": "ACTIVE",                    -- badge status; supported values: 
                                                IN_VERIFICATION (application is being verified), 
                                                WAITING_FOR_PUBLICATION (badge is being published), 
                                                ACTIVE (badge is active and displayed), 
                                                FINISHED (offer duration expired within campaign; 
                                                the administrator closed the offer within the campaign), 
                                                DECLINED (badge has been rejected 
                                                and will not be published)
         "rejectionReasons": []
       }
     }
   ]
 }

On the test environment we have prepared two specials campaigns to test the process:

• ‘ZNIZKA_AUTOAKCEPTOWALNA’, ‘OZN_TEKST_AUTOAKCEPTOWALNE’ - badge will automatically get status WAITING_FOR_PUBLICATION -badge is being published.
• ‘ZNIZKA_AUTOODRZUCALNA’, ‘OZN_TEKST_AUTOODRZUCALNE’ - badge will automatically get status DECLINED - badge has been rejected and will not be published.

List of reasons for rejecting an application.