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

Overview

A seller can use this call to update the payment details, the shipping details,
and the status of an order.

@ingroup EBayAPIInterface

Tasks

  •   itemID

    Unique identifier for an eBay item listing. A listing can have multiple
    order line items (transactions), but only one ItemID. An ItemID can be
    paired up with a corresponding TransactionID and used as an input filter
    for ReviseCheckoutStatus.



    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
    should be used. If OrderID or OrderLineItemID are specified, the
    ItemID/TransactionID pair is ignored if present in the same request.




    It is also possible to identify a single line item order with a
    ItemID/BuyerID combination, but this is not the most ideal
    approach since an error is returned if there are multiple
    order line items for that combination.

         property
  •   transactionID

    Unique identifier for an eBay order line item (transaction). An order
    line item is created once there is a commitment from a buyer to purchase
    an item. Since an auction listing can only have one order line item
    during the duration of the listing, the TransactionID for
    auction listings is always 0. Along with its corresponding ItemID, a
    TransactionID is used and referenced during an order checkout flow and
    after checkout has been completed. The ItemID/TransactionID pair can be
    used as an input filter for ReviseCheckoutStatus.



    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.

         property
  •   orderID

    A unique identifier that identifies a single line item or multiple line
    item (Combined Payment) 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 a Combined Payment order, the OrderID value is created by eBay
    when the buyer or seller (sharing multiple, common order line items)
    combines multiple order line items into a Combined Payment order through
    the eBay site. A Combined Payment order can also be created by the
    seller through the AddOrder call. The OrderID can be used as an input
    filter for ReviseCheckoutStatus.



    OrderID overrides an OrderLineItemID or ItemID/TransactionID pair if
    these fields are also specified in the same request.

         property
  •   amountPaid

    The total amount paid by the buyer. For a motor vehicle purchased on eBay Motors,
    AmountPaid is the total amount paid by the buyer for the deposit.
    AmountPaid is optional if CheckoutStatus is Incomplete and required if it
    is Complete.

         property
  •   paymentMethodUsed

    Payment method used by the buyer. This field is required if
    CheckoutStatus     is Complete and the payment method is a trusted
    payment method other than PayPal. See eBay's
    Accepted Payments Policy.
    If the payment method is PayPal, this field should not be used since only PayPal can set this field's
    value to “PayPal”. ReviseCheckoutStatus cannot be used for a non-trusted
    payment method.




    Note:
    Required or allowed payment methods vary by site and category. Refer to

    Payment Method Differences (PaymentMethod)     in the eBay
    Trading API Guide for information to help you determine which payment
    methods you are required or allowed to specify.

         property
  •   checkoutStatus

    The current checkout status of the order. Often, the seller or
    application will mark this value as Complete if payment has been made. The CheckoutStatus
    value cannot be updated by DE and AT sellers who are subject to the new payment
    process, and an attempt to do so in a ReviseCheckoutStatus call
    will result in a call error.

         property
  •   shippingService

    The shipping service selected by the buyer from among the shipping services
    offered by the seller (such as UPS Ground). For a list of valid values, call
    GeteBayDetails with DetailName set to ShippingServiceDetails. The
    ShippingServiceDetails.ValidForSellingFlow flag must also be present.
    Otherwise, that particular shipping service option is no longer valid and
    cannot be offered to buyers through a listing.




    Note: ReviseCheckoutStatus is not available for the Global Shipping program; specifying InternationalPriorityShipping as a value for this field will produce an error.

         property
  •   shippingIncludedInTax

    An indicator of whether shipping costs were included in the
    taxable amount. .

         property
  •   checkoutMethod

    This field is no longer supported and will be ignored if included in the
    request.

         property
  •   insuranceType

    Enumeration value that indicates whether shipping insurance was offered to and
    selected by the buyer.

         property
  •   paymentStatus

    Marks the order as paid or awaiting payment in My eBay. If you specify
    Paid, My eBay displays an icon for each item in the order to indicate
    that the order status is Paid. If you specify Pending, this indicates
    that the order is awaiting payment. (Some applications may use Pending
    when the buyer has paid but the funds have not yet been sent to the
    seller’s financial institution.)




    ReviseCheckoutStatus cannot be used to update payment and checkout
    status for a non-trusted payment method. See eBay’s
    Accepted Payments Policy     for more information on trusted
    payment methods. If the payment method is PayPal, this field should not
    be used since PayPal automatically set this field’s value to “Paid” upon
    receiving the buyer’s payment.




    The PaymentStatus value cannot be updated by DE and AT sellers
    who are subject to the new eBay payment process, and an attempt to do so in a
    ReviseCheckoutStatus call will result in a call error.




    Note:
    The introduction of the new eBay payment process for the entire German and
    Austrian eBay marketplace has been delayed until further notice.

         property
  •   adjustmentAmount

    Discount or charge agreed to by the buyer and seller. A positive value
    indicates that the amount is an extra charge being paid to the seller by
    the buyer. A negative value indicates that the amount is a discount given
    to the buyer by the seller.

         property
  •   shippingAddress

    For internal use.

         property
  •   buyerID

    eBay user ID for the order’s buyer. A single line item order can
    actually be identified by a BuyerID/ItemID pair, but this approach is
    not recommended since an error is returned if there are multiple
    order line items for that combination. BuyerID is ignored if any other valid
    filter or filter combination is used in the same request.

         property
  •   shippingInsuranceCost

    The amount of money paid for shipping insurance.

         property
  •   salesTax

    The sales tax amount for the order. This field should be used if sales tax
    was applied to the order.

         property
  •   shippingCost

    The amount of money paid for shipping.

         property
  •   encryptedID

    Not supported.

         property
  •   externalTransaction

    Container consisting of a unique identifier and timestamp for the electronic
    payment of an order. An ExternalTransactionID is not exposed
    to a new DE or AT seller who is subject to the new eBay payment process.




    Note:
    The introduction of the new eBay payment process for the entire German and
    Austrian eBay marketplace has been delayed until further notice.

         property
  •   multipleSellerPaymentID

    Not supported.

         property
  •   codCost

    Italy site (site ID 101) only.
    Enables you to specify the cash-on-delivery (COD) cost, for COD shipping.

         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 to revise the
    checkout status of the order.



    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 should be
    used. If OrderLineItemID is specified, the ItemID/TransactionID pair are
    ignored if present in the same request.

         property

Properties

adjustmentAmount

Discount or charge agreed to by the buyer and seller. A positive value
indicates that the amount is an extra charge being paid to the seller by
the buyer. A negative value indicates that the amount is a discount given
to the buyer by the seller.

@property (nonatomic, retain) Trading_AmountType *adjustmentAmount

Discussion

Discount or charge agreed to by the buyer and seller. A positive value
indicates that the amount is an extra charge being paid to the seller by
the buyer. A negative value indicates that the amount is a discount given
to the buyer by the seller.

type : class Trading_AmountType

Declared In

Trading_ReviseCheckoutStatusRequestType.h

amountPaid

The total amount paid by the buyer. For a motor vehicle purchased on eBay Motors,
AmountPaid is the total amount paid by the buyer for the deposit.
AmountPaid is optional if CheckoutStatus is Incomplete and required if it
is Complete.

@property (nonatomic, retain) Trading_AmountType *amountPaid

Discussion

The total amount paid by the buyer. For a motor vehicle purchased on eBay Motors,
AmountPaid is the total amount paid by the buyer for the deposit.
AmountPaid is optional if CheckoutStatus is Incomplete and required if it
is Complete.

type : class Trading_AmountType

Declared In

Trading_ReviseCheckoutStatusRequestType.h

buyerID

eBay user ID for the order’s buyer. A single line item order can
actually be identified by a BuyerID/ItemID pair, but this approach is
not recommended since an error is returned if there are multiple
order line items for that combination. BuyerID is ignored if any other valid
filter or filter combination is used in the same request.

@property (nonatomic, retain) NSString *buyerID

Discussion

eBay user ID for the order’s buyer. A single line item order can
actually be identified by a BuyerID/ItemID pair, but this approach is
not recommended since an error is returned if there are multiple
order line items for that combination. BuyerID is ignored if any other valid
filter or filter combination is used in the same request.

type : NSString, wrapper for primitive string

Declared In

Trading_ReviseCheckoutStatusRequestType.h

checkoutMethod

This field is no longer supported and will be ignored if included in the
request.

@property (nonatomic, retain) NSString *checkoutMethod

Discussion

This field is no longer supported and will be ignored if included in the
request.

type: string constant in Trading_CheckoutMethodCodeType.h

Declared In

Trading_ReviseCheckoutStatusRequestType.h

checkoutStatus

The current checkout status of the order. Often, the seller or
application will mark this value as Complete if payment has been made. The CheckoutStatus
value cannot be updated by DE and AT sellers who are subject to the new payment
process, and an attempt to do so in a ReviseCheckoutStatus call
will result in a call error.

@property (nonatomic, retain) NSString *checkoutStatus

Discussion

The current checkout status of the order. Often, the seller or
application will mark this value as Complete if payment has been made. The CheckoutStatus
value cannot be updated by DE and AT sellers who are subject to the new payment
process, and an attempt to do so in a ReviseCheckoutStatus call
will result in a call error.

type: string constant in Trading_CompleteStatusCodeType.h

Declared In

Trading_ReviseCheckoutStatusRequestType.h

codCost

Italy site (site ID 101) only.
Enables you to specify the cash-on-delivery (COD) cost, for COD shipping.

@property (nonatomic, retain) Trading_AmountType *codCost

Discussion

Italy site (site ID 101) only.
Enables you to specify the cash-on-delivery (COD) cost, for COD shipping.

type : class Trading_AmountType

Declared In

Trading_ReviseCheckoutStatusRequestType.h

encryptedID

Not supported.

@property (nonatomic, retain) NSString *encryptedID

Discussion

Not supported.

type : NSString, wrapper for primitive string

Declared In

Trading_ReviseCheckoutStatusRequestType.h

externalTransaction

Container consisting of a unique identifier and timestamp for the electronic
payment of an order. An ExternalTransactionID is not exposed
to a new DE or AT seller who is subject to the new eBay payment process.




Note:
The introduction of the new eBay payment process for the entire German and
Austrian eBay marketplace has been delayed until further notice.

@property (nonatomic, retain) Trading_ExternalTransactionType *externalTransaction

Discussion

Container consisting of a unique identifier and timestamp for the electronic
payment of an order. An ExternalTransactionID is not exposed
to a new DE or AT seller who is subject to the new eBay payment process.




Note:
The introduction of the new eBay payment process for the entire German and
Austrian eBay marketplace has been delayed until further notice.

type : class Trading_ExternalTransactionType

Declared In

Trading_ReviseCheckoutStatusRequestType.h

insuranceType

Enumeration value that indicates whether shipping insurance was offered to and
selected by the buyer.

@property (nonatomic, retain) NSString *insuranceType

Discussion

Enumeration value that indicates whether shipping insurance was offered to and
selected by the buyer.

type: string constant in Trading_InsuranceSelectedCodeType.h

Declared In

Trading_ReviseCheckoutStatusRequestType.h

itemID

Unique identifier for an eBay item listing. A listing can have multiple
order line items (transactions), but only one ItemID. An ItemID can be
paired up with a corresponding TransactionID and used as an input filter
for ReviseCheckoutStatus.



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
should be used. If OrderID or OrderLineItemID are specified, the
ItemID/TransactionID pair is ignored if present in the same request.




It is also possible to identify a single line item order with a
ItemID/BuyerID combination, but this is not the most ideal
approach since an error is returned if there are multiple
order line items for that combination.

@property (nonatomic, retain) NSString *itemID

Discussion

Unique identifier for an eBay item listing. A listing can have multiple
order line items (transactions), but only one ItemID. An ItemID can be
paired up with a corresponding TransactionID and used as an input filter
for ReviseCheckoutStatus.



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
should be used. If OrderID or OrderLineItemID are specified, the
ItemID/TransactionID pair is ignored if present in the same request.




It is also possible to identify a single line item order with a
ItemID/BuyerID combination, but this is not the most ideal
approach since an error is returned if there are multiple
order line items for that combination.

type : NSString, wrapper for primitive string

Declared In

Trading_ReviseCheckoutStatusRequestType.h

multipleSellerPaymentID

Not supported.

@property (nonatomic, retain) NSString *multipleSellerPaymentID

Discussion

Not supported.

type : NSString, wrapper for primitive string

Declared In

Trading_ReviseCheckoutStatusRequestType.h

orderID

A unique identifier that identifies a single line item or multiple line
item (Combined Payment) 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 a Combined Payment order, the OrderID value is created by eBay
when the buyer or seller (sharing multiple, common order line items)
combines multiple order line items into a Combined Payment order through
the eBay site. A Combined Payment order can also be created by the
seller through the AddOrder call. The OrderID can be used as an input
filter for ReviseCheckoutStatus.



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 (Combined Payment) 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 a Combined Payment order, the OrderID value is created by eBay
when the buyer or seller (sharing multiple, common order line items)
combines multiple order line items into a Combined Payment order through
the eBay site. A Combined Payment order can also be created by the
seller through the AddOrder call. The OrderID can be used as an input
filter for ReviseCheckoutStatus.



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_ReviseCheckoutStatusRequestType.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 to revise the
checkout status of the order.



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 should 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 to revise the
checkout status of the order.



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 should 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_ReviseCheckoutStatusRequestType.h

paymentMethodUsed

Payment method used by the buyer. This field is required if
CheckoutStatus is Complete and the payment method is a trusted
payment method other than PayPal. See eBay's
Accepted Payments Policy.
If the payment method is PayPal, this field should not be used since only PayPal can set this field's
value to “PayPal”. ReviseCheckoutStatus cannot be used for a non-trusted
payment method.




Note:
Required or allowed payment methods vary by site and category. Refer to

Payment Method Differences (PaymentMethod) in the eBay
Trading API Guide for information to help you determine which payment
methods you are required or allowed to specify.

@property (nonatomic, retain) NSString *paymentMethodUsed

Discussion

Payment method used by the buyer. This field is required if
CheckoutStatus is Complete and the payment method is a trusted
payment method other than PayPal. See eBay's
Accepted Payments Policy.
If the payment method is PayPal, this field should not be used since only PayPal can set this field's
value to “PayPal”. ReviseCheckoutStatus cannot be used for a non-trusted
payment method.




Note:
Required or allowed payment methods vary by site and category. Refer to

Payment Method Differences (PaymentMethod) in the eBay
Trading API Guide for information to help you determine which payment
methods you are required or allowed to specify.

type: string constant in Trading_BuyerPaymentMethodCodeType.h

Declared In

Trading_ReviseCheckoutStatusRequestType.h

paymentStatus

Marks the order as paid or awaiting payment in My eBay. If you specify
Paid, My eBay displays an icon for each item in the order to indicate
that the order status is Paid. If you specify Pending, this indicates
that the order is awaiting payment. (Some applications may use Pending
when the buyer has paid but the funds have not yet been sent to the
seller’s financial institution.)




ReviseCheckoutStatus cannot be used to update payment and checkout
status for a non-trusted payment method. See eBay’s
Accepted Payments Policy for more information on trusted
payment methods. If the payment method is PayPal, this field should not
be used since PayPal automatically set this field’s value to “Paid” upon
receiving the buyer’s payment.




The PaymentStatus value cannot be updated by DE and AT sellers
who are subject to the new eBay payment process, and an attempt to do so in a
ReviseCheckoutStatus call will result in a call error.




Note:
The introduction of the new eBay payment process for the entire German and
Austrian eBay marketplace has been delayed until further notice.

@property (nonatomic, retain) NSString *paymentStatus

Discussion

Marks the order as paid or awaiting payment in My eBay. If you specify
Paid, My eBay displays an icon for each item in the order to indicate
that the order status is Paid. If you specify Pending, this indicates
that the order is awaiting payment. (Some applications may use Pending
when the buyer has paid but the funds have not yet been sent to the
seller’s financial institution.)




ReviseCheckoutStatus cannot be used to update payment and checkout
status for a non-trusted payment method. See eBay’s
Accepted Payments Policy for more information on trusted
payment methods. If the payment method is PayPal, this field should not
be used since PayPal automatically set this field’s value to “Paid” upon
receiving the buyer’s payment.




The PaymentStatus value cannot be updated by DE and AT sellers
who are subject to the new eBay payment process, and an attempt to do so in a
ReviseCheckoutStatus call will result in a call error.




Note:
The introduction of the new eBay payment process for the entire German and
Austrian eBay marketplace has been delayed until further notice.

type: string constant in Trading_RCSPaymentStatusCodeType.h

Declared In

Trading_ReviseCheckoutStatusRequestType.h

salesTax

The sales tax amount for the order. This field should be used if sales tax
was applied to the order.

@property (nonatomic, retain) Trading_AmountType *salesTax

Discussion

The sales tax amount for the order. This field should be used if sales tax
was applied to the order.

type : class Trading_AmountType

Declared In

Trading_ReviseCheckoutStatusRequestType.h

shippingAddress

For internal use.

@property (nonatomic, retain) Trading_AddressType *shippingAddress

Discussion

For internal use.

type : class Trading_AddressType

Declared In

Trading_ReviseCheckoutStatusRequestType.h

shippingCost

The amount of money paid for shipping.

@property (nonatomic, retain) Trading_AmountType *shippingCost

Discussion

The amount of money paid for shipping.

type : class Trading_AmountType

Declared In

Trading_ReviseCheckoutStatusRequestType.h

shippingIncludedInTax

An indicator of whether shipping costs were included in the
taxable amount. .

@property (nonatomic, retain) NSNumber *shippingIncludedInTax

Discussion

An indicator of whether shipping costs were included in the
taxable amount. .

type : NSNumber, wrapper for primitive bool

Declared In

Trading_ReviseCheckoutStatusRequestType.h

shippingInsuranceCost

The amount of money paid for shipping insurance.

@property (nonatomic, retain) Trading_AmountType *shippingInsuranceCost

Discussion

The amount of money paid for shipping insurance.

type : class Trading_AmountType

Declared In

Trading_ReviseCheckoutStatusRequestType.h

shippingService

The shipping service selected by the buyer from among the shipping services
offered by the seller (such as UPS Ground). For a list of valid values, call
GeteBayDetails with DetailName set to ShippingServiceDetails. The
ShippingServiceDetails.ValidForSellingFlow flag must also be present.
Otherwise, that particular shipping service option is no longer valid and
cannot be offered to buyers through a listing.




Note: ReviseCheckoutStatus is not available for the Global Shipping program; specifying InternationalPriorityShipping as a value for this field will produce an error.

@property (nonatomic, retain) NSString *shippingService

Discussion

The shipping service selected by the buyer from among the shipping services
offered by the seller (such as UPS Ground). For a list of valid values, call
GeteBayDetails with DetailName set to ShippingServiceDetails. The
ShippingServiceDetails.ValidForSellingFlow flag must also be present.
Otherwise, that particular shipping service option is no longer valid and
cannot be offered to buyers through a listing.




Note: ReviseCheckoutStatus is not available for the Global Shipping program; specifying InternationalPriorityShipping as a value for this field will produce an error.

type : NSString, wrapper for primitive string

Declared In

Trading_ReviseCheckoutStatusRequestType.h

transactionID

Unique identifier for an eBay order line item (transaction). An order
line item is created once there is a commitment from a buyer to purchase
an item. Since an auction listing can only have one order line item
during the duration of the listing, the TransactionID for
auction listings is always 0. Along with its corresponding ItemID, a
TransactionID is used and referenced during an order checkout flow and
after checkout has been completed. The ItemID/TransactionID pair can be
used as an input filter for ReviseCheckoutStatus.



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.

@property (nonatomic, retain) NSString *transactionID

Discussion

Unique identifier for an eBay order line item (transaction). An order
line item is created once there is a commitment from a buyer to purchase
an item. Since an auction listing can only have one order line item
during the duration of the listing, the TransactionID for
auction listings is always 0. Along with its corresponding ItemID, a
TransactionID is used and referenced during an order checkout flow and
after checkout has been completed. The ItemID/TransactionID pair can be
used as an input filter for ReviseCheckoutStatus.



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.

type : NSString, wrapper for primitive string

Declared In

Trading_ReviseCheckoutStatusRequestType.h