eBay Trading API Call Reference Version 643 Support     Knowledge Base     Forums     All Tutorials     All Code Samples Trading API Guide Call Reference Making an API Call Tutorials Release Notes

List of All Calls Field Index Enumeration Index Type Index Deprecated Objects Errors by Number Input Output Detail Controls Samples Change History Top Errors for CompleteSale

A seller can use this call to complete various end-of-sale tasks after an item transaction (or multiple-item order) has been created. After a seller has processed a transaction, they can use this call to leave feedback for the buyer, change the paid status of the item, or set the item's shipment tracking information.

Before you can call CompleteSale, an item that you created as a buyer must have gone through a sale (thus creating a transaction). Use GetItemTransactions or GetSellerTransactions to retrieve a list of the transactions that have been completed.

This call can be executed at any time after a transaction has been created. However, only the seller who listed the item can update the item data with CompleteSale. In addition, the seller should wait until the sale is complete before modifying item data with this call.

You can use this call with Half.com orders, except when using OrderID.

Testing CompleteSale

To test CompleteSale in the Sandbox, you must have at least two test users: one to act in the capacity of an item seller and the other as a buyer. To fully test leaving feedback from a seller's perspective, use a multi-item listing with a minimum of two winning bidders (this requires multiple buyers).

For competitive-bid item listings, a buyer must have placed a bid on the item and the listing must have ended with a purchase. Use AddItem in the Sandbox to list an item, then use a separate user to place bids on the item. The seller can end the listing early using EndItem. If you set EndingReason to SellToHighBidder, the call does not cancel existing bids and the listing ends as a successfully concluded auction. One transaction is created for each winning bidder, and the seller can leave feedback for each.

For fixed-price listings, the transaction needed for feedback is created shortly after the buyer purchases the item(s) from the listing. One transaction is created for each purchase, even if purchases are made by the same buyer.

You can verify the feedback you left using GetFeedback to retrieve the feedback data for the targeted user. The feedback retrieved should contain the same scores and comments as those that you left with CompleteSale.

Back to top

The box below lists all fields that could be included in the call request. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).

See also Samples.

See also the Deprecated Objects link above. Fields presented in this color are deprecated, and fields presented in this color are (or soon will be) non-operational.

The XML prototype does not include requester credentials. This is a documentation limitation only (see Standard Requester Credentials for Making Calls).

<?xml version="1.0" encoding="utf-8"?>
<CompleteSaleRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Standard Input Fields -->
  <ErrorHandling> ErrorHandlingCodeType </ErrorHandling>
  <ErrorLanguage> string </ErrorLanguage>
  <MessageID> string </MessageID>
  <Version> string </Version>
  <WarningLevel> WarningLevelCodeType </WarningLevel>
  <!-- Call-specific Input Fields -->
  <FeedbackInfo> FeedbackInfoType 
    <CommentText> string </CommentText>
    <CommentType> CommentTypeCodeType </CommentType>
    <TargetUser> UserIDType (string) </TargetUser>
  </FeedbackInfo>
  <ItemID> ItemIDType (string) </ItemID>
  <ListingType> ListingTypeCodeType </ListingType>
  <OrderID> string </OrderID>
  <Paid> boolean </Paid>
  <Shipment> ShipmentType 
    <Notes> string </Notes>
    <ShipmentTrackingDetails> ShipmentTrackingDetailsType 
      <ShipmentTrackingNumber> string </ShipmentTrackingNumber>
      <ShippingCarrierUsed> string </ShippingCarrierUsed>
    </ShipmentTrackingDetails>
    <!-- ... more ShipmentTrackingDetails nodes here ... -->
    <ShippedTime> dateTime </ShippedTime>
  </Shipment>
  <Shipped> boolean </Shipped>
  <TransactionID> string </TransactionID>
</CompleteSaleRequest>

Back to top

The box below lists all fields that might be returned in the response. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).

See also Samples.

See also the Deprecated Objects link above. Fields presented in this color are deprecated, and fields presented in this color are not returned (or soon will not be returned) or are not operational (or soon will be non-operational).

The XML prototype does not include requester credentials. This is a documentation limitation only (see Standard Requester Credentials for Making Calls).

<?xml version="1.0" encoding="utf-8"?>
<CompleteSaleResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Standard Output Fields -->
  <Ack> AckCodeType </Ack>
  <Build> string </Build>
  <CorrelationID> string </CorrelationID>
  <Errors> ErrorType 
    <ErrorClassification> ErrorClassificationCodeType </ErrorClassification>
    <ErrorCode> token </ErrorCode>
    <ErrorParameters ParamID="string"> ErrorParameterType 
      <Value> string </Value>
    </ErrorParameters>
    <!-- ... more ErrorParameters nodes here ... -->
    <LongMessage> string </LongMessage>
    <SeverityCode> SeverityCodeType </SeverityCode>
    <ShortMessage> string </ShortMessage>
  </Errors>
  <!-- ... more Errors nodes here ... -->
  <HardExpirationWarning> string </HardExpirationWarning>
  <Timestamp> dateTime </Timestamp>
  <Version> string </Version>
</CompleteSaleResponse>

Back to top

This call does not support varying Detail Levels. You do not need to pass DetailLevel in the request.

Back to top

An inline sample will be added in a future release. Please refer to the Samples section of the eBay Web Services Guide chapter for CompleteSale.

Back to top

This document was generated with a customized version of the apireferencedocs tool.

© 2005–2009 eBay, Inc. All rights reserved. This documentation and the API may only be used in accordance with the eBay Developers Program and API License Agreement.