Buy Offer API

Bidding

getBidding

This method retrieves the bidding details that are specific to the buyer of the specified auction. This must be an auction where the buyer has already placed a bid. To retrieve the bidding information you use a user access token and pass in the item ID of the auction. You can also retrieve general bidding details about the auction, such as start price, minimum bid price, and the count of unique bidders, using the Browse API getItem method. URLs for this method Production URL: https://api.ebay.com/buy/offer/v1_beta/bidding/ Sandbox URL: https://api.sandbox.ebay.com/buy/offer/v1_beta/bidding/ Restrictions For a list of supported sites and other restrictions, see API Restrictions.


/bidding/{item_id}

Usage and SDK Samples

curl -X GET "https://api.ebay.com/buy/offer/v1_beta/bidding/{item_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BiddingApi;

import java.io.File;
import java.util.*;

public class BiddingApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: Authorization Code
        OAuth Authorization Code = (OAuth) defaultClient.getAuthentication("Authorization Code");
        Authorization Code.setAccessToken("YOUR ACCESS TOKEN");
        
        

        BiddingApi apiInstance = new BiddingApi();
        
        String itemId = ; // String | The eBay RESTful identifier of an item that you want the buyer's bidding information. This ID is returned by the Browse and Feed API methods. RESTful Item ID example: v1|272394640372|0 For more information about item ID for RESTful APIs, see the Legacy API compatibility section of the Buy APIs Overview. Restriction: The buyer must have placed a bid for this item.
        
        String xEBAYCMARKETPLACEID = ; // String | The ID of the eBay marketplace where the buyer is based. Note: This value is case sensitive. For example:   X-EBAY-C-MARKETPLACE-ID = EBAY_US For a list of supported sites see, API Restrictions.
        
        try {
            Bidding result = apiInstance.getBidding(itemId, xEBAYCMARKETPLACEID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BiddingApi#getBidding");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BiddingApi;

public class BiddingApiExample {

    public static void main(String[] args) {
        BiddingApi apiInstance = new BiddingApi();
        
        String itemId = ; // String | The eBay RESTful identifier of an item that you want the buyer's bidding information. This ID is returned by the Browse and Feed API methods. RESTful Item ID example: v1|272394640372|0 For more information about item ID for RESTful APIs, see the Legacy API compatibility section of the Buy APIs Overview. Restriction: The buyer must have placed a bid for this item.
        
        String xEBAYCMARKETPLACEID = ; // String | The ID of the eBay marketplace where the buyer is based. Note: This value is case sensitive. For example:   X-EBAY-C-MARKETPLACE-ID = EBAY_US For a list of supported sites see, API Restrictions.
        
        try {
            Bidding result = apiInstance.getBidding(itemId, xEBAYCMARKETPLACEID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BiddingApi#getBidding");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: Authorization Code)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


String *itemId = ; // The eBay RESTful identifier of an item that you want the buyer's bidding information. This ID is returned by the Browse and Feed API methods. RESTful Item ID example: v1|272394640372|0 For more information about item ID for RESTful APIs, see the Legacy API compatibility section of the Buy APIs Overview. Restriction: The buyer must have placed a bid for this item.
String *xEBAYCMARKETPLACEID = ; // The ID of the eBay marketplace where the buyer is based. Note: This value is case sensitive. For example:   X-EBAY-C-MARKETPLACE-ID = EBAY_US For a list of supported sites see, API Restrictions.


BiddingApi *apiInstance = [[BiddingApi alloc] init];

[apiInstance getBiddingWithCompletionHandler: :itemId
    xEBAYCMARKETPLACEID:xEBAYCMARKETPLACEID
              ^(Bidding output, NSError* error) {

                            if (output) {
                                NSLog(@"%@", output);
                            }

                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var BuyOfferApi = require('buy_offer_api');

var defaultClient = BuyOfferApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: Authorization Code
var Authorization Code = defaultClient.authentications['Authorization Code'];
Authorization Code.accessToken = "YOUR ACCESS TOKEN"



var api = new BuyOfferApi.BiddingApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getBidding(itemId, xEBAYCMARKETPLACEIDcallback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getBiddingExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: Authorization Code
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            

            var apiInstance = new BiddingApi();
            
            
            
            var itemId = new String(); // String | The eBay RESTful identifier of an item that you want the buyer's bidding information. This ID is returned by the Browse and Feed API methods. RESTful Item ID example: v1|272394640372|0 For more information about item ID for RESTful APIs, see the Legacy API compatibility section of the Buy APIs Overview. Restriction: The buyer must have placed a bid for this item.
            
            
            
            
            var xEBAYCMARKETPLACEID = new String(); // String | The ID of the eBay marketplace where the buyer is based. Note: This value is case sensitive. For example:   X-EBAY-C-MARKETPLACE-ID = EBAY_US For a list of supported sites see, API Restrictions.
            
            

            try
            {
                
                Bidding result = apiInstance.getBidding(itemId, xEBAYCMARKETPLACEID);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BiddingApi.getBidding: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: Authorization Code
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$api_instance = new Swagger\Client\Api{{classname}}();
$itemId = ; // String | The eBay RESTful identifier of an item that you want the buyer's bidding information. This ID is returned by the Browse and Feed API methods. RESTful Item ID example: v1|272394640372|0 For more information about item ID for RESTful APIs, see the Legacy API compatibility section of the Buy APIs Overview. Restriction: The buyer must have placed a bid for this item.
$xEBAYCMARKETPLACEID = ; // String | The ID of the eBay marketplace where the buyer is based. Note: This value is case sensitive. For example:   X-EBAY-C-MARKETPLACE-ID = EBAY_US For a list of supported sites see, API Restrictions.


try {
    $result = $api_instance->getBidding($itemId, $xEBAYCMARKETPLACEID);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BiddingApi->getBidding: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BiddingApi;

# Configure OAuth2 access token for authorization: Authorization Code
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';


my $api_instance = WWW::SwaggerClient::BiddingApi->new();
my $itemId = []; # String | The eBay RESTful identifier of an item that you want the buyer's bidding information. This ID is returned by the Browse and Feed API methods. RESTful Item ID example: v1|272394640372|0 For more information about item ID for RESTful APIs, see the Legacy API compatibility section of the Buy APIs Overview. Restriction: The buyer must have placed a bid for this item.
my $xEBAYCMARKETPLACEID = []; # String | The ID of the eBay marketplace where the buyer is based. Note: This value is case sensitive. For example:   X-EBAY-C-MARKETPLACE-ID = EBAY_US For a list of supported sites see, API Restrictions.


eval { 
    my $result = $api_instance->getBidding(itemId => $itemId, xEBAYCMARKETPLACEID => $xEBAYCMARKETPLACEID);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BiddingApi->getBidding: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: Authorization Code
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'


# create an instance of the API class
api_instance = swagger_client.BiddingApi()
itemId =  # String | The eBay RESTful identifier of an item that you want the buyer's bidding information. This ID is returned by the Browse and Feed API methods. RESTful Item ID example: v1|272394640372|0 For more information about item ID for RESTful APIs, see the Legacy API compatibility section of the Buy APIs Overview. Restriction: The buyer must have placed a bid for this item.
xEBAYCMARKETPLACEID =  # String | The ID of the eBay marketplace where the buyer is based. Note: This value is case sensitive. For example:   X-EBAY-C-MARKETPLACE-ID = EBAY_US For a list of supported sites see, API Restrictions.


try: 
    api_response = api_instance.get_bidding(itemId, xEBAYCMARKETPLACEID)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BiddingApi->getBidding: %s\n" % e)

Parameters

Path parameters
Name Description
item_id*
String
The eBay RESTful identifier of an item that you want the buyer's bidding information. This ID is returned by the Browse and Feed API methods. RESTful Item ID example: v1|272394640372|0 For more information about item ID for RESTful APIs, see the Legacy API compatibility section of the Buy APIs Overview. Restriction: The buyer must have placed a bid for this item.
Required
Header parameters
Name Description
X-EBAY-C-MARKETPLACE-ID*
String
The ID of the eBay marketplace where the buyer is based. Note: This value is case sensitive. For example: &nbsp;&nbsp;X-EBAY-C-MARKETPLACE-ID = EBAY_US For a list of supported sites see, API Restrictions.
Required

Responses

Status: 200 - OK

Status: 404 - Not found

Status: 500 - Internal Server Error


placeProxyBid

This method uses a user access token to place a proxy bid for the buyer on a specific auction item. The item must offer AUCTION as one of the buyingOptions. To place a bid, you pass in the item ID of the auction as a URI parameter and the buyer's maximum bid amount (maxAmount ) in the payload. By placing a proxy bid, the buyer is agreeing to purchase the item if they win the auction. After this bid is placed, if someone else outbids the buyer a bid, eBay automatically bids again for the buyer up to the amount of their maximum bid. When the bid exceeds the buyer's maximum bid, eBay will notify them that they have been outbid. To find auctions, you can use the Browse API to search for items and use a filter to return only auction items. For example: /buy/browse/v1/item_summary/search?q=iphone&amp;filter=buyingOptions:{AUCTION} URLs for this method Production URL: https://api.ebay.com/buy/offer/v1_beta/bidding/ Sandbox URL: https://api.sandbox.ebay.com/buy/offer/v1_beta/bidding/ Restrictions For a list of supported sites and other restrictions, see API Restrictions.


/bidding/{item_id}/place_proxy_bid

Usage and SDK Samples

curl -X POST "https://api.ebay.com/buy/offer/v1_beta/bidding/{item_id}/place_proxy_bid"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BiddingApi;

import java.io.File;
import java.util.*;

public class BiddingApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: Authorization Code
        OAuth Authorization Code = (OAuth) defaultClient.getAuthentication("Authorization Code");
        Authorization Code.setAccessToken("YOUR ACCESS TOKEN");
        
        

        BiddingApi apiInstance = new BiddingApi();
        
        String itemId = ; // String | The eBay RESTful identifier of an item you want to bid on. This ID is returned by the Browse and Feed API methods. RESTful Item ID Example: v1|272394640372|0 For more information about item ID for RESTful APIs, see the Legacy API compatibility section of the Buy APIs Overview.
        
        String xEBAYCMARKETPLACEID = ; // String | The ID of the eBay marketplace where the buyer is based. Note: This value is case sensitive. For example:   X-EBAY-C-MARKETPLACE-ID = EBAY_US For a list of supported sites see, API Restrictions.
        
        PlaceProxyBidRequest body = ; // PlaceProxyBidRequest | 
        
        try {
            PlaceProxyBidResponse result = apiInstance.placeProxyBid(itemId, xEBAYCMARKETPLACEID, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BiddingApi#placeProxyBid");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BiddingApi;

public class BiddingApiExample {

    public static void main(String[] args) {
        BiddingApi apiInstance = new BiddingApi();
        
        String itemId = ; // String | The eBay RESTful identifier of an item you want to bid on. This ID is returned by the Browse and Feed API methods. RESTful Item ID Example: v1|272394640372|0 For more information about item ID for RESTful APIs, see the Legacy API compatibility section of the Buy APIs Overview.
        
        String xEBAYCMARKETPLACEID = ; // String | The ID of the eBay marketplace where the buyer is based. Note: This value is case sensitive. For example:   X-EBAY-C-MARKETPLACE-ID = EBAY_US For a list of supported sites see, API Restrictions.
        
        PlaceProxyBidRequest body = ; // PlaceProxyBidRequest | 
        
        try {
            PlaceProxyBidResponse result = apiInstance.placeProxyBid(itemId, xEBAYCMARKETPLACEID, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BiddingApi#placeProxyBid");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: Authorization Code)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


String *itemId = ; // The eBay RESTful identifier of an item you want to bid on. This ID is returned by the Browse and Feed API methods. RESTful Item ID Example: v1|272394640372|0 For more information about item ID for RESTful APIs, see the Legacy API compatibility section of the Buy APIs Overview.
String *xEBAYCMARKETPLACEID = ; // The ID of the eBay marketplace where the buyer is based. Note: This value is case sensitive. For example:   X-EBAY-C-MARKETPLACE-ID = EBAY_US For a list of supported sites see, API Restrictions.
PlaceProxyBidRequest *body = ; //  (optional)


BiddingApi *apiInstance = [[BiddingApi alloc] init];

[apiInstance placeProxyBidWithCompletionHandler: :itemId
    xEBAYCMARKETPLACEID:xEBAYCMARKETPLACEID
    body:body
              ^(PlaceProxyBidResponse output, NSError* error) {

                            if (output) {
                                NSLog(@"%@", output);
                            }

                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var BuyOfferApi = require('buy_offer_api');

var defaultClient = BuyOfferApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: Authorization Code
var Authorization Code = defaultClient.authentications['Authorization Code'];
Authorization Code.accessToken = "YOUR ACCESS TOKEN"



var api = new BuyOfferApi.BiddingApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.placeProxyBid(itemId, xEBAYCMARKETPLACEIDcallback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class placeProxyBidExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: Authorization Code
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            

            var apiInstance = new BiddingApi();
            
            
            
            var itemId = new String(); // String | The eBay RESTful identifier of an item you want to bid on. This ID is returned by the Browse and Feed API methods. RESTful Item ID Example: v1|272394640372|0 For more information about item ID for RESTful APIs, see the Legacy API compatibility section of the Buy APIs Overview.
            
            
            
            
            var xEBAYCMARKETPLACEID = new String(); // String | The ID of the eBay marketplace where the buyer is based. Note: This value is case sensitive. For example:   X-EBAY-C-MARKETPLACE-ID = EBAY_US For a list of supported sites see, API Restrictions.
            
            
            
            
            var body = new PlaceProxyBidRequest(); // PlaceProxyBidRequest |  (optional) 
            
            

            try
            {
                
                PlaceProxyBidResponse result = apiInstance.placeProxyBid(itemId, xEBAYCMARKETPLACEID, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BiddingApi.placeProxyBid: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: Authorization Code
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$api_instance = new Swagger\Client\Api{{classname}}();
$itemId = ; // String | The eBay RESTful identifier of an item you want to bid on. This ID is returned by the Browse and Feed API methods. RESTful Item ID Example: v1|272394640372|0 For more information about item ID for RESTful APIs, see the Legacy API compatibility section of the Buy APIs Overview.
$xEBAYCMARKETPLACEID = ; // String | The ID of the eBay marketplace where the buyer is based. Note: This value is case sensitive. For example:   X-EBAY-C-MARKETPLACE-ID = EBAY_US For a list of supported sites see, API Restrictions.
$body = ; // PlaceProxyBidRequest | 


try {
    $result = $api_instance->placeProxyBid($itemId, $xEBAYCMARKETPLACEID, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BiddingApi->placeProxyBid: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BiddingApi;

# Configure OAuth2 access token for authorization: Authorization Code
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';


my $api_instance = WWW::SwaggerClient::BiddingApi->new();
my $itemId = []; # String | The eBay RESTful identifier of an item you want to bid on. This ID is returned by the Browse and Feed API methods. RESTful Item ID Example: v1|272394640372|0 For more information about item ID for RESTful APIs, see the Legacy API compatibility section of the Buy APIs Overview.
my $xEBAYCMARKETPLACEID = []; # String | The ID of the eBay marketplace where the buyer is based. Note: This value is case sensitive. For example:   X-EBAY-C-MARKETPLACE-ID = EBAY_US For a list of supported sites see, API Restrictions.
my $body = WWW::SwaggerClient::Object::PlaceProxyBidRequest->new(); # PlaceProxyBidRequest | 


eval { 
    my $result = $api_instance->placeProxyBid(itemId => $itemId, xEBAYCMARKETPLACEID => $xEBAYCMARKETPLACEID, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BiddingApi->placeProxyBid: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: Authorization Code
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'


# create an instance of the API class
api_instance = swagger_client.BiddingApi()
itemId =  # String | The eBay RESTful identifier of an item you want to bid on. This ID is returned by the Browse and Feed API methods. RESTful Item ID Example: v1|272394640372|0 For more information about item ID for RESTful APIs, see the Legacy API compatibility section of the Buy APIs Overview.
xEBAYCMARKETPLACEID =  # String | The ID of the eBay marketplace where the buyer is based. Note: This value is case sensitive. For example:   X-EBAY-C-MARKETPLACE-ID = EBAY_US For a list of supported sites see, API Restrictions.
body =  # PlaceProxyBidRequest |  (optional)


try: 
    api_response = api_instance.place_proxy_bid(itemId, xEBAYCMARKETPLACEID, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BiddingApi->placeProxyBid: %s\n" % e)

Parameters

Path parameters
Name Description
item_id*
String
The eBay RESTful identifier of an item you want to bid on. This ID is returned by the Browse and Feed API methods. RESTful Item ID Example: v1|272394640372|0 For more information about item ID for RESTful APIs, see the Legacy API compatibility section of the Buy APIs Overview.
Required
Header parameters
Name Description
X-EBAY-C-MARKETPLACE-ID*
String
The ID of the eBay marketplace where the buyer is based. Note: This value is case sensitive. For example: &nbsp;&nbsp;X-EBAY-C-MARKETPLACE-ID = EBAY_US For a list of supported sites see, API Restrictions.
Required
Body parameters
Name Description
body

Responses

Status: 200 - OK

Status: 400 - Bad request

Status: 404 - Not found

Status: 409 - Conflict

Status: 500 - Internal Server Error