com.ebay.sdk.call.PlaceOfferCall Maven / Gradle / Ivy
/*
Copyright (c) 2013 eBay, Inc.
This program is licensed under the terms of the eBay Common Development and
Distribution License (CDDL) Version 1.0 (the "License") and any subsequent version
thereof released by eBay. The then-current version of the License can be found
at http://www.opensource.org/licenses/cddl1.php and in the eBaySDKLicense file that
is under the eBay SDK ../docs directory.
*/
package com.ebay.sdk.call;
import java.lang.Boolean;
import java.lang.String;
import com.ebay.sdk.*;
import com.ebay.soap.eBLBaseComponents.*;
/**
* Wrapper class of the PlaceOffer call of eBay SOAP API.
*
* Title: SOAP API wrapper library.
* Description: Contains wrapper classes for eBay SOAP APIs.
* Copyright: Copyright (c) 2009
* Company: eBay Inc.
*
Input property: Offer - This container is used to specifies the type of offer being made for the listing specified in the ItemID field. The Offer.Action is used to set the action that is being taken on the listing.
*
Input property: ItemID - Unique identifier that identifies the listing for which the action is being submitted.
*
* For a multiple-variation listing, you must also identify the specific variation within that listing using the VariationSpecifics container.
*
Input property: BlockOnWarning - If a warning message is generated when the call is made, this BlockOnWarning will block the bid/buy action if set to true. If BlockOnWarning
* is false or omitted, the bid/buy action is allowed, regardless of whether or not a warning message occurs.
*
*
Input property: AffiliateTrackingDetails - Container for affiliate-related tags, which enable the tracking of user
* activity. If you include the AffiliateTrackingDetails container in your PlaceOffer call, then
* it is possible to receive affiliate commissions based on calls made by your
* application. (See the eBay Partner Network
* for information about commissions.) Please note that affiliate tracking is not
* available in the Sandbox environment, and that affiliate tracking is not
* available when you make a Best Offer.
*
Input property: VariationSpecifics - This container is used to identify a specific variation within a multiple-variation listing identified by the ItemID value. This container is required when attempting to perform an action on a multiple-variation listing.
*
Output property: ReturnedSellingStatus - This container indicates the current bidding/purchase state of the order line item regarding the offer extended using PlaceOffer. The fields that are returned under this container will depend on the attempted action and the results of that action.
*
Output property: ReturnedTransactionID - Unique identifier for an eBay order line item. The
* TransactionID field is only returned if the Offer.Action field was set
* to Purchase in the input and the purchase was successful. A Purchase
* action in PlaceOffer can be used for a fixed-price listing, or for an
* auction listing where the Buy It Now option is available.
*
Output property: ReturnedBestOffer - Container consisting of the status for a Best Offer. This container is
* only returned if applicable based on the listing and the value set for
* Offer.Action field in the request.
*
Output property: ReturnedOrderLineItemID - OrderLineItemID is a unique identifier for an eBay order line item and
* is based upon the concatenation of ItemID and TransactionID, with a
* hyphen in between these two IDs. The OrderLineItemID field is only
* returned if the Offer.Action field is set to Purchase in the input and
* the purchase is successful. A Purchase action in PlaceOffer can be used
* for a fixed-price listing, or for an auction listing where the Buy It
* Now option is available.
*
*
* @author Ron Murphy
* @version 1.0
*/
public class PlaceOfferCall extends com.ebay.sdk.ApiCall
{
private OfferType offer = null;
private String itemID = null;
private Boolean blockOnWarning = null;
private AffiliateTrackingDetailsType affiliateTrackingDetails = null;
private NameValueListArrayType variationSpecifics = null;
private SellingStatusType returnedSellingStatus=null;
private String returnedTransactionID=null;
private BestOfferType returnedBestOffer=null;
private String returnedOrderLineItemID=null;
/**
* Constructor.
*/
public PlaceOfferCall() {
}
/**
* Constructor.
* @param apiContext The ApiContext object to be used to make the call.
*/
public PlaceOfferCall(ApiContext apiContext) {
super(apiContext);
}
/**
* Enables the authenticated user to to make a bid on an auction item, propose a Best Offer, or purchase a fixed-price/Buy It Now item. Note that this call cannot be used to purchase items that require immediate payment.
*
*
* @throws ApiException
* @throws SdkException
* @throws Exception
* @return The SellingStatusType object.
*/
public SellingStatusType placeOffer()
throws com.ebay.sdk.ApiException, com.ebay.sdk.SdkException, java.lang.Exception
{
PlaceOfferRequestType req;
req = new PlaceOfferRequestType();
if (this.offer != null)
req.setOffer(this.offer);
if (this.itemID != null)
req.setItemID(this.itemID);
if (this.blockOnWarning != null)
req.setBlockOnWarning(this.blockOnWarning);
if (this.affiliateTrackingDetails != null)
req.setAffiliateTrackingDetails(this.affiliateTrackingDetails);
if (this.variationSpecifics != null)
req.setVariationSpecifics(this.variationSpecifics);
PlaceOfferResponseType resp = (PlaceOfferResponseType) execute(req);
this.returnedSellingStatus = resp.getSellingStatus();
this.returnedTransactionID = resp.getTransactionID();
this.returnedBestOffer = resp.getBestOffer();
this.returnedOrderLineItemID = resp.getOrderLineItemID();
return this.getReturnedSellingStatus();
}
/**
* Gets the PlaceOfferRequestType.affiliateTrackingDetails.
* @return AffiliateTrackingDetailsType
*/
public AffiliateTrackingDetailsType getAffiliateTrackingDetails()
{
return this.affiliateTrackingDetails;
}
/**
* Sets the PlaceOfferRequestType.affiliateTrackingDetails.
* @param affiliateTrackingDetails AffiliateTrackingDetailsType
*/
public void setAffiliateTrackingDetails(AffiliateTrackingDetailsType affiliateTrackingDetails)
{
this.affiliateTrackingDetails = affiliateTrackingDetails;
}
/**
* Gets the PlaceOfferRequestType.blockOnWarning.
* @return Boolean
*/
public Boolean getBlockOnWarning()
{
return this.blockOnWarning;
}
/**
* Sets the PlaceOfferRequestType.blockOnWarning.
* @param blockOnWarning Boolean
*/
public void setBlockOnWarning(Boolean blockOnWarning)
{
this.blockOnWarning = blockOnWarning;
}
/**
* Gets the PlaceOfferRequestType.itemID.
* @return String
*/
public String getItemID()
{
return this.itemID;
}
/**
* Sets the PlaceOfferRequestType.itemID.
* @param itemID String
*/
public void setItemID(String itemID)
{
this.itemID = itemID;
}
/**
* Gets the PlaceOfferRequestType.offer.
* @return OfferType
*/
public OfferType getOffer()
{
return this.offer;
}
/**
* Sets the PlaceOfferRequestType.offer.
* @param offer OfferType
*/
public void setOffer(OfferType offer)
{
this.offer = offer;
}
/**
* Gets the PlaceOfferRequestType.variationSpecifics.
* @return NameValueListArrayType
*/
public NameValueListArrayType getVariationSpecifics()
{
return this.variationSpecifics;
}
/**
* Sets the PlaceOfferRequestType.variationSpecifics.
* @param variationSpecifics NameValueListArrayType
*/
public void setVariationSpecifics(NameValueListArrayType variationSpecifics)
{
this.variationSpecifics = variationSpecifics;
}
/**
* Valid after executing the API.
* Gets the returned PlaceOfferResponseType.returnedBestOffer.
*
* @return BestOfferType
*/
public BestOfferType getReturnedBestOffer()
{
return this.returnedBestOffer;
}
/**
* Valid after executing the API.
* Gets the returned PlaceOfferResponseType.returnedOrderLineItemID.
*
* @return String
*/
public String getReturnedOrderLineItemID()
{
return this.returnedOrderLineItemID;
}
/**
* Valid after executing the API.
* Gets the returned PlaceOfferResponseType.returnedSellingStatus.
*
* @return SellingStatusType
*/
public SellingStatusType getReturnedSellingStatus()
{
return this.returnedSellingStatus;
}
/**
* Valid after executing the API.
* Gets the returned PlaceOfferResponseType.returnedTransactionID.
*
* @return String
*/
public String getReturnedTransactionID()
{
return this.returnedTransactionID;
}
}