Changes since
the last release

com.ebay.sdk.call
Class CompleteSaleCall

java.lang.Object
  extended by com.ebay.sdk.ApiCall
      extended by com.ebay.sdk.call.CompleteSaleCall

public class CompleteSaleCall
extends ApiCall

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.


Input property: ItemID - Unique identifier for an eBay item listing. An ItemID can be paired up with a corresponding TransactionID and used in the CompleteSale request to identify a single line item order.

Unless an OrderLineItemID is used to identify a single line item order, or the OrderID is used to identify a single or multiple line item (Combined Payment) order, the ItemID/TransactionID pair must be specified. For a multiple line item (Combined Payment) order, OrderID must be used. If OrderID or OrderLineItemID are specified, the ItemID/TransactionID pair is ignored if present in the same request.
Input property: TransactionID - Unique identifier for an eBay order line item (transaction). The TransactionID can be paired up with the corresponding ItemID and used in the CompleteSale request to identify a single line item order.

Unless an OrderLineItemID is used to identify a single line item order, or the OrderID is used to identify a single or multiple line item (Combined Payment) order, the ItemID/TransactionID pair must be specified. For a multiple line item (Combined Payment) order, OrderID must be used. If OrderID or OrderLineItemID are specified, the ItemID/TransactionID pair is ignored if present in the same request.
Input property: 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).

To determine if Feedback has already been left for an order line item, you can call GetFeedback, passing in the OrderLineItemID value in the call request.
Input property: Shipped - The seller includes and sets this field to true if the order has been shipped. If the call is successful, the order line item(s) are marked as Shipped in My eBay.

If the seller includes and sets this field to false, the order line item(s) are marked (or remain) as Not Shipped in My eBay.

If this field is not included, the shipped status of the order line item(s) remain unchanged in My eBay.

If shipment tracking information is provided through the Shipment container in the same request, the Shipped status is set to True automatically and the Shipped field is not required.
Input property: 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 My eBay.

If the seller includes and sets this field to false, the order line item(s) are marked (or remain) as Not Paid in My eBay.

If this field is not included, the paid status of the order line item(s) remain unchanged in My eBay.
Input property: 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 API support for Half.com listings is being deprecated, this field is no longer applicable.
Input property: 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 item as shipped and the Shipped field is not required.

If you supply ShipmentTrackingNumber, you must also supply ShippingCarrierUsed; otherwise you will get an error.

To modify the shipping tracking number and/or carrier, supply the new number in ShipmentTrackingNumber or supply the value for ShippingCarrierUsed, or both. The old number and carrier are deleted and the new ones are added.

To simply delete the current tracking details altogether, supply empty Shipment tags.

Note: Top-Rated sellers must have a record of uploading shipment tracking information (through site or through API) for at least 90 percent of their order line items (purchased by U.S. buyers) to keep their status as Top-Rated sellers. For more information on the requirements to becoming a Top-Rated Seller, see the Becoming a Top-Rated Seller and qualifying for Top-Rated Plus customer support page.

Input property: OrderID - A unique identifier that identifies a single line item or multiple line item order.

For a single line item order, the OrderID value is identical to the OrderLineItemID value that is generated upon creation of the order line item. For multiple line item orders, the OrderID value is created by eBay when the buyer is purchasing multiple order line items from the same seller at the same time. For multiple line item orders not going through the eBay Cart flow, a Combined Invoice order can be created by the seller through the AddOrder call. The OrderID can be used in the CompleteSale request to identify a single or multiple line item order.

OrderID overrides an OrderLineItemID or ItemID/TransactionID pair if these fields are also specified in the same request.
Input property: OrderLineItemID - 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. For a single line item order, the OrderLineItemID value can be passed into the OrderID field in the CompleteSale request.

Unless an ItemID/TransactionID pair is used to identify a single line item order, or the OrderID is used to identify a single or multiple line item (Combined Payment) order, the OrderLineItemID must be specified. For a multiple line item (Combined Payment) order, OrderID must be used. If OrderLineItemID is specified, the ItemID/TransactionID pair are ignored if present in the same request.

Version:
1.0
Author:
Ron Murphy

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 do various tasks after the creation of a single line item or multiple line item (Combined Payment) order.
 FeedbackInfoType getFeedbackInfo()
          Gets the CompleteSaleRequestType.feedbackInfo.
 String getItemID()
          Gets the CompleteSaleRequestType.itemID.
 ListingTypeCodeType getListingType()
          Gets the CompleteSaleRequestType.listingType.
 String getOrderID()
          Gets the CompleteSaleRequestType.orderID.
 String getOrderLineItemID()
          Gets the CompleteSaleRequestType.orderLineItemID.
 Boolean getPaid()
          Gets the CompleteSaleRequestType.paid.
 ShipmentType getShipment()
          Gets the CompleteSaleRequestType.shipment.
 Boolean getShipped()
          Gets the CompleteSaleRequestType.shipped.
 String getTransactionID()
          Gets the CompleteSaleRequestType.transactionID.
 void setFeedbackInfo(FeedbackInfoType feedbackInfo)
          Sets the CompleteSaleRequestType.feedbackInfo.
 void setItemID(String itemID)
          Sets the CompleteSaleRequestType.itemID.
 void setListingType(ListingTypeCodeType listingType)
          Sets the CompleteSaleRequestType.listingType.
 void setOrderID(String orderID)
          Sets the CompleteSaleRequestType.orderID.
 void setOrderLineItemID(String orderLineItemID)
          Sets the CompleteSaleRequestType.orderLineItemID.
 void setPaid(Boolean paid)
          Sets the CompleteSaleRequestType.paid.
 void setShipment(ShipmentType shipment)
          Sets the CompleteSaleRequestType.shipment.
 void setShipped(Boolean shipped)
          Sets the CompleteSaleRequestType.shipped.
 void setTransactionID(String transactionID)
          Sets the CompleteSaleRequestType.transactionID.
 
Methods inherited from class com.ebay.sdk.ApiCall
addDetailLevel, addSendRequestListener, execute, executeByApiName, getApiContext, getApiException, getBotBlock, getCallRetry, getDetailLevel, getEnableCompression, getEndUserIP, getErrorHandling, getInvocationID, getMessageID, getOutputSelector, getRequestXml, getResponseObject, getResponseXml, getSite, getWarningLevel, hasError, hasWarning, removeSendRequestListener, setApiContext, setBotBlock, setCallRetry, setDetailLevel, setEnableCompression, setEndUserIP, setErrorHandling, setInvocationID, setMessageID, setOutputSelector, setSite, setWarningLevel
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CompleteSaleCall

public CompleteSaleCall()
Constructor.


CompleteSaleCall

public CompleteSaleCall(ApiContext apiContext)
Constructor.

Parameters:
apiContext - The ApiContext object to be used to make the call.
Method Detail

completeSale

public void completeSale()
                  throws ApiException,
                         SdkException,
                         Exception
Enables a seller to do various tasks after the creation of a single line item or multiple line item (Combined Payment) order. Typically, this call is used after the order has been paid by the buyer, but it can be called by the seller beforehand. Typical post- payment tasks available to this call include marking the order as paid, marking the order as shipped, providing shipment tracking details, and leaving feedback for the buyer.

Throws:
ApiException
SdkException
Exception

getFeedbackInfo

public FeedbackInfoType getFeedbackInfo()
Gets the CompleteSaleRequestType.feedbackInfo.

Returns:
FeedbackInfoType

setFeedbackInfo

public void setFeedbackInfo(FeedbackInfoType feedbackInfo)
Sets the CompleteSaleRequestType.feedbackInfo.

Parameters:
feedbackInfo - FeedbackInfoType

getItemID

public String getItemID()
Gets the CompleteSaleRequestType.itemID.

Returns:
String

setItemID

public void setItemID(String itemID)
Sets the CompleteSaleRequestType.itemID.

Parameters:
itemID - String

getListingType

public ListingTypeCodeType getListingType()
Gets the CompleteSaleRequestType.listingType.

Returns:
ListingTypeCodeType

setListingType

public void setListingType(ListingTypeCodeType listingType)
Sets the CompleteSaleRequestType.listingType.

Parameters:
listingType - ListingTypeCodeType

getOrderID

public String getOrderID()
Gets the CompleteSaleRequestType.orderID.

Returns:
String

setOrderID

public void setOrderID(String orderID)
Sets the CompleteSaleRequestType.orderID.

Parameters:
orderID - String

getOrderLineItemID

public String getOrderLineItemID()
Gets the CompleteSaleRequestType.orderLineItemID.

Returns:
String

setOrderLineItemID

public void setOrderLineItemID(String orderLineItemID)
Sets the CompleteSaleRequestType.orderLineItemID.

Parameters:
orderLineItemID - String

getPaid

public Boolean getPaid()
Gets the CompleteSaleRequestType.paid.

Returns:
Boolean

setPaid

public void setPaid(Boolean paid)
Sets the CompleteSaleRequestType.paid.

Parameters:
paid - Boolean

getShipment

public ShipmentType getShipment()
Gets the CompleteSaleRequestType.shipment.

Returns:
ShipmentType

setShipment

public void setShipment(ShipmentType shipment)
Sets the CompleteSaleRequestType.shipment.

Parameters:
shipment - ShipmentType

getShipped

public Boolean getShipped()
Gets the CompleteSaleRequestType.shipped.

Returns:
Boolean

setShipped

public void setShipped(Boolean shipped)
Sets the CompleteSaleRequestType.shipped.

Parameters:
shipped - Boolean

getTransactionID

public String getTransactionID()
Gets the CompleteSaleRequestType.transactionID.

Returns:
String

setTransactionID

public void setTransactionID(String transactionID)
Sets the CompleteSaleRequestType.transactionID.

Parameters:
transactionID - String

Changes since
the last release

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.