Skip to content

Latest commit

 

History

History
131 lines (88 loc) · 4.13 KB

AuctionsAndBiddingApi.md

File metadata and controls

131 lines (88 loc) · 4.13 KB
Raw

OpenAPI\AllegroSdk\AuctionsAndBiddingApi

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

Method HTTP request Description
getBid() GET /bidding/offers/{offerId}/bid Get current user's bid information
placeBid() PUT /bidding/offers/{offerId}/bid Place a bid in an auction

getBid()

getBid($offer_id): \OpenAPI\AllegroSdk\Model\MyBidResponse

Get current user's bid information

Get current user's bid information. Read more: <a href="../../news/nowe-zasoby-zloz-oferte-kupna-w-licytacji-q018m02vDT1" target="_blank">PL / <a href="../../news/new-resources-place-a-bid-in-an-auction-rjWwEj1e7sG" target="_blank">EN.

Example

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


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


$apiInstance = new OpenAPI\AllegroSdk\Api\AuctionsAndBiddingApi(
    // 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 | The offer ID.

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

Parameters

Name Type Description Notes
offer_id string The offer ID.

Return type

\OpenAPI\AllegroSdk\Model\MyBidResponse

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]

placeBid()

placeBid($offer_id, $bid_request): \OpenAPI\AllegroSdk\Model\MyBidResponse

Place a bid in an auction

Place a bid in an auction. Read more: <a href="../../news/nowe-zasoby-zloz-oferte-kupna-w-licytacji-q018m02vDT1" target="_blank">PL / <a href="../../news/new-resources-place-a-bid-in-an-auction-rjWwEj1e7sG" target="_blank">EN.

Example

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


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


$apiInstance = new OpenAPI\AllegroSdk\Api\AuctionsAndBiddingApi(
    // 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 | The offer ID.
$bid_request = new \OpenAPI\AllegroSdk\Model\BidRequest(); // \OpenAPI\AllegroSdk\Model\BidRequest

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

Parameters

Name Type Description Notes
offer_id string The offer ID.
bid_request \OpenAPI\AllegroSdk\Model\BidRequest [optional]

Return type

\OpenAPI\AllegroSdk\Model\MyBidResponse

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]