Trading_IssueRefundRequestType Class Reference
Inherits from | Trading_AbstractRequestType : NSObject |
Declared in | Trading_IssueRefundRequestType.h Trading_IssueRefundRequestType.m |
Overview
Half.com only. Issues a refund for a specific
Half.com order line item. This can only be called by a seller. Sellers do not
have the ability to issue a general refund (a refund not tied to an order line
item) to a buyer.
@ingroup EBayAPIInterface
Tasks
-
itemID
Unique identifier for the Half.com item listing. Unless an
property
OrderLineItemID is specified in the IssueRefund request, the ItemID is
required along with the corresponding TransactionID to identify the
order line item that will be refunded. You can use GetSellerPayments to
retrieve the ItemID and/or TransactionID associated with the order line
item. -
transactionID
Unique identifier for a Half.com order line item (transaction). An order
property
line item is created once there is a commitment from a buyer to purchase
an item. Along with its corresponding ItemID, a TransactionID is used to
identify the order line item that will be refunded. Unless an
OrderLineItemID is specified in the IssueRefund request, the
TransactionID is required along with the corresponding ItemID. You can
use GetSellerPayments to retrieve the ItemID and/or TransactionID
associated with the order line item. -
refundReason
Explanation of the reason that the refund is being issued.
property -
refundType
Explanation of the costs that the refund amount covers.
property -
refundAmount
The amount the seller wants to refund to the buyer, in US Dollars (USD).
property
Must be greater than 0.00. Half.com allows a maximum of the original item
sale price (order line item price plus original shipping reimbursement) plus
return shipping costs (the amount the buyer paid to return the item).
Typically, the return shipping cost is based on the current cost of
shipping the individual item (not the discounted cost calculated during
the original checkout for a Combined Payment order). You can also issue a
partial refund for the amount you want the buyer to receive. If
RefundType=Full or RefundType=FullPlusShipping and you do not pass
RefundAmount in the request, Half.com will calculate the refund amount for
you. If you pass RefundAmount in the request, the amount you specify will
override Half.com’s calculated value. Required if RefundType=
CustomOrPartial. -
refundMessage
Note to the buyer. Cannot include HTML.
property -
orderLineItemID
A unique identifier for an eBay order line item. This field is created
property
as soon as there is a commitment to buy from the seller, and its value
is based upon the concatenation of ItemID and TransactionID, with a
hyphen in between these two IDs. The OrderLineItemID value is used to
identify the order line item that will be refunded. Unless an
ItemID/TransactionID pair is specified in the IssueRefund request, the
OrderLineItemID is required. You can use GetSellerPayments to retrieve
the OrderLineItemID associated with the order line item.
Properties
itemID
Unique identifier for the Half.com item listing. Unless an
OrderLineItemID is specified in the IssueRefund request, the ItemID is
required along with the corresponding TransactionID to identify the
order line item that will be refunded. You can use GetSellerPayments to
retrieve the ItemID and/or TransactionID associated with the order line
item.
@property (nonatomic, retain) NSString *itemID
Discussion
Unique identifier for the Half.com item listing. Unless an
OrderLineItemID is specified in the IssueRefund request, the ItemID is
required along with the corresponding TransactionID to identify the
order line item that will be refunded. You can use GetSellerPayments to
retrieve the ItemID and/or TransactionID associated with the order line
item.
type : NSString, wrapper for primitive string
Declared In
Trading_IssueRefundRequestType.h
orderLineItemID
A unique identifier for an eBay order line item. This field is created
as soon as there is a commitment to buy from the seller, and its value
is based upon the concatenation of ItemID and TransactionID, with a
hyphen in between these two IDs. The OrderLineItemID value is used to
identify the order line item that will be refunded. Unless an
ItemID/TransactionID pair is specified in the IssueRefund request, the
OrderLineItemID is required. You can use GetSellerPayments to retrieve
the OrderLineItemID associated with the order line item.
@property (nonatomic, retain) NSString *orderLineItemID
Discussion
A unique identifier for an eBay order line item. This field is created
as soon as there is a commitment to buy from the seller, and its value
is based upon the concatenation of ItemID and TransactionID, with a
hyphen in between these two IDs. The OrderLineItemID value is used to
identify the order line item that will be refunded. Unless an
ItemID/TransactionID pair is specified in the IssueRefund request, the
OrderLineItemID is required. You can use GetSellerPayments to retrieve
the OrderLineItemID associated with the order line item.
type : NSString, wrapper for primitive string
Declared In
Trading_IssueRefundRequestType.h
refundAmount
The amount the seller wants to refund to the buyer, in US Dollars (USD).
Must be greater than 0.00. Half.com allows a maximum of the original item
sale price (order line item price plus original shipping reimbursement) plus
return shipping costs (the amount the buyer paid to return the item).
Typically, the return shipping cost is based on the current cost of
shipping the individual item (not the discounted cost calculated during
the original checkout for a Combined Payment order). You can also issue a
partial refund for the amount you want the buyer to receive. If
RefundType=Full or RefundType=FullPlusShipping and you do not pass
RefundAmount in the request, Half.com will calculate the refund amount for
you. If you pass RefundAmount in the request, the amount you specify will
override Half.com’s calculated value. Required if RefundType=
CustomOrPartial.
@property (nonatomic, retain) Trading_AmountType *refundAmount
Discussion
The amount the seller wants to refund to the buyer, in US Dollars (USD).
Must be greater than 0.00. Half.com allows a maximum of the original item
sale price (order line item price plus original shipping reimbursement) plus
return shipping costs (the amount the buyer paid to return the item).
Typically, the return shipping cost is based on the current cost of
shipping the individual item (not the discounted cost calculated during
the original checkout for a Combined Payment order). You can also issue a
partial refund for the amount you want the buyer to receive. If
RefundType=Full or RefundType=FullPlusShipping and you do not pass
RefundAmount in the request, Half.com will calculate the refund amount for
you. If you pass RefundAmount in the request, the amount you specify will
override Half.com’s calculated value. Required if RefundType=
CustomOrPartial.
type : class Trading_AmountType
Declared In
Trading_IssueRefundRequestType.h
refundMessage
Note to the buyer. Cannot include HTML.
@property (nonatomic, retain) NSString *refundMessage
Discussion
Note to the buyer. Cannot include HTML.
type : NSString, wrapper for primitive string
Declared In
Trading_IssueRefundRequestType.h
refundReason
Explanation of the reason that the refund is being issued.
@property (nonatomic, retain) NSString *refundReason
Discussion
Explanation of the reason that the refund is being issued.
type: string constant in Trading_RefundReasonCodeType.h
Declared In
Trading_IssueRefundRequestType.h
refundType
Explanation of the costs that the refund amount covers.
@property (nonatomic, retain) NSString *refundType
Discussion
Explanation of the costs that the refund amount covers.
type: string constant in Trading_RefundTypeCodeType.h
Declared In
Trading_IssueRefundRequestType.h
transactionID
Unique identifier for a Half.com order line item (transaction). An order
line item is created once there is a commitment from a buyer to purchase
an item. Along with its corresponding ItemID, a TransactionID is used to
identify the order line item that will be refunded. Unless an
OrderLineItemID is specified in the IssueRefund request, the
TransactionID is required along with the corresponding ItemID. You can
use GetSellerPayments to retrieve the ItemID and/or TransactionID
associated with the order line item.
@property (nonatomic, retain) NSString *transactionID
Discussion
Unique identifier for a Half.com order line item (transaction). An order
line item is created once there is a commitment from a buyer to purchase
an item. Along with its corresponding ItemID, a TransactionID is used to
identify the order line item that will be refunded. Unless an
OrderLineItemID is specified in the IssueRefund request, the
TransactionID is required along with the corresponding ItemID. You can
use GetSellerPayments to retrieve the ItemID and/or TransactionID
associated with the order line item.
type : NSString, wrapper for primitive string
Declared In
Trading_IssueRefundRequestType.h