Inherits from Trading_AbstractRequestType : NSObject
Declared in Trading_CompleteSaleRequestType.h
Trading_CompleteSaleRequestType.m

Overview

Enables a seller to do various tasks after the creation of a single line item or
multiple line item order. Typically, this call is used after the
buyer has paid for the order, 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.

@ingroup EBayAPIInterface

Tasks

  •   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
    order, the ItemID/TransactionID pair must be
    specified. For a multiple line item order, OrderID
    must be used. If OrderID or OrderLineItemID are specified, the
    ItemID/TransactionID pair is ignored if present in the same request.

         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
    order, the ItemID/TransactionID pair must be
    specified. For a multiple line item order, OrderID
    must be used. If OrderID or OrderLineItemID are specified, the
    ItemID/TransactionID pair is ignored if present in the same request.

         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.

         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 for an order line item through
    the Shipment container in the same request, the order line item is marked as
    shipped automatically and the Shipped field is not
    required.



    For orders going through the new payment process, DE and AT sellers mark an
    order as shipped to expedite the seller payout process.

         property
  •   paid

    The seller includes and sets this field to true if the buyer has paid for
    the order. 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.



    If an order is going through the new eBay payment process, DE and AT sellers
    cannot use this field to mark the order as paid, as this can only be
    done by eBay.

         property
  •   listingType

    This field is required if CompleteSale is being used for a Half.com
    order. The value should be set to Half, which is the only applicable
    ListingType value for this call.

         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 changes to eBay’s Top-rated seller program, see the
    2012 Fall Seller Update page.


         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 Payment 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.

         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 order, the OrderLineItemID must be specified.
    For a multiple line item order, OrderID must be
    used. If OrderLineItemID is specified, the ItemID/TransactionID pair are
    ignored if present in the same request.

         property

Properties

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.

@property (nonatomic, retain) Trading_FeedbackInfoType *feedbackInfo

Discussion

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.

type : class Trading_FeedbackInfoType

Declared In

Trading_CompleteSaleRequestType.h

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
order, the ItemID/TransactionID pair must be
specified. For a multiple line item order, OrderID
must be used. If OrderID or OrderLineItemID are specified, the
ItemID/TransactionID pair is ignored if present in the same request.

@property (nonatomic, retain) NSString *itemID

Discussion

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
order, the ItemID/TransactionID pair must be
specified. For a multiple line item order, OrderID
must be used. If OrderID or OrderLineItemID are specified, the
ItemID/TransactionID pair is ignored if present in the same request.

type : NSString, wrapper for primitive string

Declared In

Trading_CompleteSaleRequestType.h

listingType

This field is required if CompleteSale is being used for a Half.com
order. The value should be set to Half, which is the only applicable
ListingType value for this call.

@property (nonatomic, retain) NSString *listingType

Discussion

This field is required if CompleteSale is being used for a Half.com
order. The value should be set to Half, which is the only applicable
ListingType value for this call.

type: string constant in Trading_ListingTypeCodeType.h

Declared In

Trading_CompleteSaleRequestType.h

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 Payment 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.

@property (nonatomic, retain) NSString *orderID

Discussion

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 Payment 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.

type : NSString, wrapper for primitive string

Declared In

Trading_CompleteSaleRequestType.h

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 order, the OrderLineItemID must be specified.
For a multiple line item order, OrderID must be
used. If OrderLineItemID is specified, the ItemID/TransactionID pair are
ignored if present in the same request.

@property (nonatomic, retain) NSString *orderLineItemID

Discussion

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 order, the OrderLineItemID must be specified.
For a multiple line item order, OrderID must be
used. If OrderLineItemID is specified, the ItemID/TransactionID pair are
ignored if present in the same request.

type : NSString, wrapper for primitive string

Declared In

Trading_CompleteSaleRequestType.h

paid

The seller includes and sets this field to true if the buyer has paid for
the order. 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.



If an order is going through the new eBay payment process, DE and AT sellers
cannot use this field to mark the order as paid, as this can only be
done by eBay.

@property (nonatomic, retain) NSNumber *paid

Discussion

The seller includes and sets this field to true if the buyer has paid for
the order. 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.



If an order is going through the new eBay payment process, DE and AT sellers
cannot use this field to mark the order as paid, as this can only be
done by eBay.

type : NSNumber, wrapper for primitive bool

Declared In

Trading_CompleteSaleRequestType.h

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 changes to eBay’s Top-rated seller program, see the
2012 Fall Seller Update page.


@property (nonatomic, retain) Trading_ShipmentType *shipment

Discussion

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 changes to eBay’s Top-rated seller program, see the
2012 Fall Seller Update page.


type : class Trading_ShipmentType

Declared In

Trading_CompleteSaleRequestType.h

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 for an order line item through
the Shipment container in the same request, the order line item is marked as
shipped automatically and the Shipped field is not
required.



For orders going through the new payment process, DE and AT sellers mark an
order as shipped to expedite the seller payout process.

@property (nonatomic, retain) NSNumber *shipped

Discussion

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 for an order line item through
the Shipment container in the same request, the order line item is marked as
shipped automatically and the Shipped field is not
required.



For orders going through the new payment process, DE and AT sellers mark an
order as shipped to expedite the seller payout process.

type : NSNumber, wrapper for primitive bool

Declared In

Trading_CompleteSaleRequestType.h

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
order, the ItemID/TransactionID pair must be
specified. For a multiple line item order, OrderID
must be used. If OrderID or OrderLineItemID are specified, the
ItemID/TransactionID pair is ignored if present in the same request.

@property (nonatomic, retain) NSString *transactionID

Discussion

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
order, the ItemID/TransactionID pair must be
specified. For a multiple line item order, OrderID
must be used. If OrderID or OrderLineItemID are specified, the
ItemID/TransactionID pair is ignored if present in the same request.

type : NSString, wrapper for primitive string

Declared In

Trading_CompleteSaleRequestType.h