AllegroApi\BadgeCampaignsApi

All URIs are relative to https://api.allegro.pl.

Method	HTTP request	Description
badgeApplicationsGetAll()	GET /sale/badge-applications	Get a list of badge applications
badgeApplicationsGetOne()	GET /sale/badge-applications/{applicationId}	Get a badge application details
badgeCampaignsGetAll()	GET /sale/badge-campaigns	Get a list of available badge campaigns
badgeOperationsGetOne()	GET /sale/badge-operations/{operationId}	Get badge operation details
getBadges()	GET /sale/badges	Get a list of badges
patchBadge()	PATCH /sale/badges/offers/{offerId}/campaigns/{campaignId}	Update campaign badge for the given offer
postBadges()	POST /sale/badges	Apply for badge in selected offer

`badgeApplicationsGetAll()`

badgeApplicationsGetAll($campaign_id, $offer_id, $offset, $limit): \AllegroApi\Model\BadgeApplications

Get a list of badge applications

Use this resource to get a list of badge applications. Read more: <a href="../../tutorials/jak-przypisac-oferte-kampanii-GRaj0q6Gwuy#pobierz-swoje-zgloszenia" target="_blank">PL / <a href="../../tutorials/how-to-submit-offers-to-campaigns-AgGjd6EmyH4#retrieve-all-campaign-applications" target="_blank">EN.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: bearer-token-for-user
$config = AllegroApi\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new AllegroApi\Api\BadgeCampaignsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$campaign_id = 'campaign_id_example'; // string | Campaign ID.
$offer_id = 'offer_id_example'; // string | Offer ID.
$offset = 56; // int | Offset.
$limit = 50; // int | The maximum number of applications returned in the response.

try {
    $result = $apiInstance->badgeApplicationsGetAll($campaign_id, $offer_id, $offset, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BadgeCampaignsApi->badgeApplicationsGetAll: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
campaign_id	string	Campaign ID.	[optional]
offer_id	string	Offer ID.	[optional]
offset	int	Offset.	[optional]
limit	int	The maximum number of applications returned in the response.	[optional] [default to 50]

Return type

\AllegroApi\Model\BadgeApplications

Authorization

bearer-token-for-user

HTTP request headers

Content-Type: Not defined
Accept: application/vnd.allegro.public.v1+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`badgeApplicationsGetOne()`

badgeApplicationsGetOne($application_id): \AllegroApi\Model\BadgeApplication

Get a badge application details

Use this resource to get a badge application details. Read more: <a href="../../tutorials/jak-przypisac-oferte-kampanii-GRaj0q6Gwuy#pobierz-dane-zgloszenie" target="_blank">PL / <a href="../../tutorials/how-to-submit-offers-to-campaigns-AgGjd6EmyH4#retrieve-campaign-application" target="_blank">EN.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: bearer-token-for-user
$config = AllegroApi\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new AllegroApi\Api\BadgeCampaignsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$application_id = 'application_id_example'; // string | Badge application ID.

try {
    $result = $apiInstance->badgeApplicationsGetOne($application_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BadgeCampaignsApi->badgeApplicationsGetOne: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
application_id	string	Badge application ID.

Return type

\AllegroApi\Model\BadgeApplication

Authorization

bearer-token-for-user

HTTP request headers

Content-Type: Not defined
Accept: application/vnd.allegro.public.v1+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`badgeCampaignsGetAll()`

badgeCampaignsGetAll(): \AllegroApi\Model\GetBadgeCampaignsList

Get a list of available badge campaigns

Badge campaigns are another way to promote your offers. You can apply for a badge, which - depending on a type - will be displayed on your offer page of on the list of offers. First - use this resource to get a list of all available badge campaigns at the moment, then use POST /sale/badges to apply for badge. Read more: <a href="../../tutorials/jak-przypisac-oferte-kampanii-GRaj0q6Gwuy#lista-dostepnych-kampanii" target="_blank">PL / <a href="../../tutorials/how-to-submit-offers-to-campaigns-AgGjd6EmyH4#list-of-available-campaigns" target="_blank">EN.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: bearer-token-for-user
$config = AllegroApi\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new AllegroApi\Api\BadgeCampaignsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);

try {
    $result = $apiInstance->badgeCampaignsGetAll();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BadgeCampaignsApi->badgeCampaignsGetAll: ', $e->getMessage(), PHP_EOL;
}

Parameters

This endpoint does not need any parameter.

Return type

\AllegroApi\Model\GetBadgeCampaignsList

Authorization

bearer-token-for-user

HTTP request headers

Content-Type: Not defined
Accept: application/vnd.allegro.public.v1+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`badgeOperationsGetOne()`

badgeOperationsGetOne($operation_id): \AllegroApi\Model\BadgeOperation

Get badge operation details

Use this resource to get badge operation details. Read more: <a href="../../tutorials/jak-przypisac-oferte-kampanii-GRaj0q6Gwuy#zmiana-ceny-i-zakonczenie-oznaczenia" target="_blank">PL / <a href="../../tutorials/how-to-submit-offers-to-campaigns-AgGjd6EmyH4#change-price-and-finish-badge" target="_blank">EN.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: bearer-token-for-user
$config = AllegroApi\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new AllegroApi\Api\BadgeCampaignsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$operation_id = 'operation_id_example'; // string | Badge operation ID.

try {
    $result = $apiInstance->badgeOperationsGetOne($operation_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BadgeCampaignsApi->badgeOperationsGetOne: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
operation_id	string	Badge operation ID.

Return type

\AllegroApi\Model\BadgeOperation

Authorization

bearer-token-for-user

HTTP request headers

Content-Type: Not defined
Accept: application/vnd.allegro.public.v1+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`getBadges()`

getBadges($offer_id, $offset, $limit): \AllegroApi\Model\BadgesList

Get a list of badges

Use this resource to get a list of badges in authorized seller's offers. Read more: <a href="../../tutorials/jak-przypisac-oferte-kampanii-GRaj0q6Gwuy#kampanie-przypisane-do-ofert" target="_blank">PL / <a href="../../tutorials/how-to-submit-offers-to-campaigns-AgGjd6EmyH4#check-badges-assigned-to-offers" target="_blank">EN.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: bearer-token-for-user
$config = AllegroApi\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new AllegroApi\Api\BadgeCampaignsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$offer_id = 'offer_id_example'; // string | Offer ID.
$offset = 56; // int | Offset.
$limit = 50; // int | The maximum number of badges returned in the response.

try {
    $result = $apiInstance->getBadges($offer_id, $offset, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BadgeCampaignsApi->getBadges: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
offer_id	string	Offer ID.	[optional]
offset	int	Offset.	[optional]
limit	int	The maximum number of badges returned in the response.	[optional] [default to 50]

Return type

\AllegroApi\Model\BadgesList

Authorization

bearer-token-for-user

HTTP request headers

Content-Type: Not defined
Accept: application/vnd.allegro.public.v1+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`patchBadge()`

patchBadge($offer_id, $campaign_id, $badge_patch_request): \AllegroApi\Model\InlineResponse202

Update campaign badge for the given offer

This resource allows you to update a campaign badge for the given offer. You can use Location provided in header of the response to track your update status. Update offer price in a campaign or finish marking an offer in a campaign. Read more: <a href="../../tutorials/jak-przypisac-oferte-kampanii-GRaj0q6Gwuy#zmiana-ceny-i-zakonczenie-oznaczenia" target="_blank">PL / <a href="../../tutorials/how-to-submit-offers-to-campaigns-AgGjd6EmyH4#change-price-and-finish-badge" target="_blank">EN.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: bearer-token-for-user
$config = AllegroApi\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new AllegroApi\Api\BadgeCampaignsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$offer_id = 'offer_id_example'; // string | Offer ID.
$campaign_id = 'campaign_id_example'; // string | Campaign ID.
$badge_patch_request = {"prices":{"bargain":{"value":{"amount":"9.99","currency":"PLN"}}}}; // \AllegroApi\Model\BadgePatchRequest

try {
    $result = $apiInstance->patchBadge($offer_id, $campaign_id, $badge_patch_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BadgeCampaignsApi->patchBadge: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
offer_id	string	Offer ID.
campaign_id	string	Campaign ID.
badge_patch_request	\AllegroApi\Model\BadgePatchRequest		[optional]

Return type

\AllegroApi\Model\InlineResponse202

Authorization

bearer-token-for-user

HTTP request headers

Content-Type: application/vnd.allegro.public.v1+json
Accept: application/vnd.allegro.public.v1+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`postBadges()`

postBadges($badge_application_request): \AllegroApi\Model\BadgeApplication

Apply for badge in selected offer

This resource allows you to apply for a badge. Most badges involve additional fee charged. Your badge application will be verified and you will be notified about the verification status via e-mail. You can use Location provided in header of the response to track your application status. Application will be removed after 30 days when status of the application was changed form PROCESSED or DECLINED. Fees will be charged in accordance with Annex No. 1 to the <a href="https://allegro.pl/regulaminy/regulamin-strefy-okazji-9dGVAPB69In\" target="_blank">Daily deals zone terms and conditions. By using this resource you agree to the <a href="https://allegro.pl/regulaminy/regulamin-strefy-okazji-9dGVAPB69In\" target="_blank">Daily deals zone terms and conditions or <a href="https://allegro.pl/regulaminy/regulamin-programu-bonusowego-prowizja-nawet-0-5-0KPkAE7wkcv\" target="_blank">Commission discount terms and conditions. Read more: <a href="../../tutorials/jak-przypisac-oferte-kampanii-GRaj0q6Gwuy#zglos-oferte-do-kampanii" target="_blank">PL / <a href="../../tutorials/how-to-submit-offers-to-campaigns-AgGjd6EmyH4#submit-offer-to-a-campaign" target="_blank">EN.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: bearer-token-for-user
$config = AllegroApi\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new AllegroApi\Api\BadgeCampaignsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$badge_application_request = {"campaign":{"id":"BARGAIN"},"offer":{"id":"12345678"},"prices":{"market":{"amount":"19.99","currency":"PLN"},"bargain":{"amount":"9.99","currency":"PLN"}}}; // \AllegroApi\Model\BadgeApplicationRequest

try {
    $result = $apiInstance->postBadges($badge_application_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BadgeCampaignsApi->postBadges: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
badge_application_request	\AllegroApi\Model\BadgeApplicationRequest		[optional]

Return type

\AllegroApi\Model\BadgeApplication

Authorization

bearer-token-for-user

HTTP request headers

Content-Type: application/vnd.allegro.public.v1+json
Accept: application/vnd.allegro.public.v1+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

BadgeCampaignsApi.md

Latest commit

History

BadgeCampaignsApi.md

File metadata and controls

AllegroApi\BadgeCampaignsApi

badgeApplicationsGetAll()

Example

Parameters

Return type

Authorization

HTTP request headers

badgeApplicationsGetOne()

Example

Parameters

Return type

Authorization

HTTP request headers

badgeCampaignsGetAll()

Example

Parameters

Return type

Authorization

HTTP request headers

badgeOperationsGetOne()

Example

Parameters

Return type

Authorization

HTTP request headers

getBadges()

Example

Parameters

Return type

Authorization

HTTP request headers

patchBadge()

Example

Parameters

Return type

Authorization

HTTP request headers

postBadges()

Example

Parameters

Return type

Authorization

HTTP request headers

`badgeApplicationsGetAll()`

`badgeApplicationsGetOne()`

`badgeCampaignsGetAll()`

`badgeOperationsGetOne()`

`getBadges()`

`patchBadge()`

`postBadges()`