|
Changes since the last release |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ebay.sdk.ApiCall
com.ebay.sdk.call.CompleteSaleCall
public class CompleteSaleCall
Wrapper class of the CompleteSale 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.
ItemID
- Unique identifier for an eBay listing. An ItemID value can be paired up with a corresponding TransactionID value in a CompleteSale request to identify a single order line item. Alternatively, the OrderLineItemID value for the order line item can be used.
TransactionID
- Unique identifier for a sales transaction. A TransactionID identifier is created once there is a commitment to buy (bidder wins the auction, buyer clicks buy button, or buyer purchases item through PlaceOffer call). The
TransactionID can be paired up with the corresponding ItemID value in a CompleteSale request to identify a single order line item. Alternatively, the OrderLineItemID value for the order line item can be used.
FeedbackInfo
- This container is used by the seller to leave feedback for the buyer for the order line item identified in the call request. The seller must include and specify all fields of this type, including the buyer's eBay User ID, the Feedback rating (a seller can only leave a buyer a 'Positive' rating), and a comment, which helps justify the Feedback rating. The eBay User ID must match the buyer who bought the order line item, or an error will occur. An error will also occur if Feedback has already been left for the buyer (either through API or the Web flow).
Shipped
- The seller includes and sets this field to true if the order or order line item has been shipped. If the call is successful, the order line item(s) are marked as Shipped in My eBay.
true
automatically, and the Shipped field is not necessary.
Paid
- The seller includes and sets this field to true if the order has been
paid for by the buyer. If the call is successful, the order line item(s)
are marked as 'Paid' in eBay's system.
false
, the order line item(s) are marked (or remain) as 'Not Paid' in eBay's system.
ListingType
- Note: DO NOT USE THIS FIELD. Previously, this field's only purpose was to classify the order to be updated as a Half.com order. However, since the Half.com site has been shut down, this field is no longer applicable.
Shipment
- Container consisting of shipment tracking information, shipped time, and an optional text field to provide additional details to the buyer. Setting the tracking number and shipping carrier automatically marks the order line item as shipped and the Shipped field is not necessary.
OrderID
- A unique identifier for an eBay order. An OrderID value should only be used in a CompleteSale call for a single line item order. For a multiple line item order, the OrderLineItemID or ItemID/TransactionID pair must be used to identify an order line item within the order.
1113
. During the transition period and even after, the new and old OrderID formats will still be supported/accepted in all Trading API call request payloads. After the transition period (which will be announced), only the new OrderID format will be returned in all Trading API call response payloads, regardless of the Trading WSDL version used or specified compatibility level.
OrderLineItemID
- A unique identifier for an eBay order line item. OrderLineItemID values are returned (at the order line item level) in Trading API's order management calls. This identifier is created once there is a commitment to buy (bidder wins the auction, buyer clicks buy button, or buyer purchases item through PlaceOffer call). An OrderLineItemID value can be used in a CompleteSale request to identify a line item within an order. Alternatively, an ItemID/TransactionID pair can also be used to identify a line item.
Field Summary |
---|
Fields inherited from class com.ebay.sdk.ApiCall |
---|
apiException, sendReqListeners |
Constructor Summary | |
---|---|
CompleteSaleCall()
Constructor. |
|
CompleteSaleCall(ApiContext apiContext)
Constructor. |
Method Summary | |
---|---|
void |
completeSale()
Enables a seller to perform various tasks with a single or multiple line item order. |
FeedbackInfoType |
getFeedbackInfo()
Gets the CompleteSaleRequestType.feedbackInfo. |
java.lang.String |
getItemID()
Gets the CompleteSaleRequestType.itemID. |
ListingTypeCodeType |
getListingType()
Gets the CompleteSaleRequestType.listingType. |
java.lang.String |
getOrderID()
Gets the CompleteSaleRequestType.orderID. |
java.lang.String |
getOrderLineItemID()
Gets the CompleteSaleRequestType.orderLineItemID. |
java.lang.Boolean |
getPaid()
Gets the CompleteSaleRequestType.paid. |
ShipmentType |
getShipment()
Gets the CompleteSaleRequestType.shipment. |
java.lang.Boolean |
getShipped()
Gets the CompleteSaleRequestType.shipped. |
java.lang.String |
getTransactionID()
Gets the CompleteSaleRequestType.transactionID. |
void |
setFeedbackInfo(FeedbackInfoType feedbackInfo)
Sets the CompleteSaleRequestType.feedbackInfo. |
void |
setItemID(java.lang.String itemID)
Sets the CompleteSaleRequestType.itemID. |
void |
setListingType(ListingTypeCodeType listingType)
Sets the CompleteSaleRequestType.listingType. |
void |
setOrderID(java.lang.String orderID)
Sets the CompleteSaleRequestType.orderID. |
void |
setOrderLineItemID(java.lang.String orderLineItemID)
Sets the CompleteSaleRequestType.orderLineItemID. |
void |
setPaid(java.lang.Boolean paid)
Sets the CompleteSaleRequestType.paid. |
void |
setShipment(ShipmentType shipment)
Sets the CompleteSaleRequestType.shipment. |
void |
setShipped(java.lang.Boolean shipped)
Sets the CompleteSaleRequestType.shipped. |
void |
setTransactionID(java.lang.String transactionID)
Sets the CompleteSaleRequestType.transactionID. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public CompleteSaleCall()
public CompleteSaleCall(ApiContext apiContext)
apiContext
- The ApiContext object to be used to make the call.Method Detail |
---|
public void completeSale() throws ApiException, SdkException, java.lang.Exception
ApiException
SdkException
java.lang.Exception
public FeedbackInfoType getFeedbackInfo()
public void setFeedbackInfo(FeedbackInfoType feedbackInfo)
feedbackInfo
- FeedbackInfoTypepublic java.lang.String getItemID()
public void setItemID(java.lang.String itemID)
itemID
- Stringpublic ListingTypeCodeType getListingType()
public void setListingType(ListingTypeCodeType listingType)
listingType
- ListingTypeCodeTypepublic java.lang.String getOrderID()
public void setOrderID(java.lang.String orderID)
orderID
- Stringpublic java.lang.String getOrderLineItemID()
public void setOrderLineItemID(java.lang.String orderLineItemID)
orderLineItemID
- Stringpublic java.lang.Boolean getPaid()
public void setPaid(java.lang.Boolean paid)
paid
- Booleanpublic ShipmentType getShipment()
public void setShipment(ShipmentType shipment)
shipment
- ShipmentTypepublic java.lang.Boolean getShipped()
public void setShipped(java.lang.Boolean shipped)
shipped
- Booleanpublic java.lang.String getTransactionID()
public void setTransactionID(java.lang.String transactionID)
transactionID
- String
|
Changes since the last release |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
The information contained in this document is proprietary and confidential.
Use of this information and the eBay API requires a Non-Disclosure Agreement (NDA) between the user and eBay Inc.
For information regarding a qualifying NDA, contact Developer Relations:
developer-relations@ebay.com
© 2004-2009 eBay Inc. All rights reserved.