Trading_SendInvoiceRequestType Class Reference
Inherits from | Trading_AbstractRequestType : NSObject |
Declared in | Trading_SendInvoiceRequestType.h Trading_SendInvoiceRequestType.m |
Overview
Enables a seller to send an order invoice to a buyer. Where applicable, updates to shipping, payment methods, and sales tax made in this request are applied to the specified order as a whole and to the individual order line items whose data are stored in individual Transaction objects.
@ingroup EBayAPIInterface
Tasks
-
itemID
Unique identifier for an eBay item listing. Unless OrderID or
property
OrderLineItemID is provided in the request, the ItemID (or SKU) is
required and must be paired with the corresponding TransactionID to
identify a single line item order. For a multiple line item (Combined
Payment) order, OrderID should be used. -
transactionID
Unique identifier for an eBay order line item (transaction). An order
property
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. Unless OrderID or OrderLineItemID is
provided in the request, the TransactionID is required and must be
paired with the corresponding ItemID to identify a single line item
order. For a multiple line item (Combined Payment) order, OrderID should
be used. -
orderID
A unique identifier that identifies a single line item or multiple line
property
item (Combined Payment) orders.
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. A
Combined Payment order can also be created by the seller through the
AddOrder call.
Unless the ItemID (or SKU) and corresponding TransactionID, or the
OrderLineItemID is provided in the request to identify a single line
item order, the OrderID must be specified. If OrderID is specified,
OrderLineItemID, ItemID, TransactionID, and SKU are ignored if present
in the same request. -
internationalShippingServiceOptions
If the buyer has an International shipping address, use this container
property
to offer up to three International shipping services. If International
shipping services are offered, (domestic) ShippingServiceOptions should
not be included in the request.
Note:
Beginning with Version 719, the number of domestic and international
shipping services that a seller may offer the buyer is increasing. The
number of domestic shipping services that may be offered is increasing from
3 to 4, and the number of international shipping service options is
increasing from 3 to 5.
-
shippingServiceOptions
If the buyer has a domestic shipping address, use this container
property
to offer up to three domestic shipping services. If domestic
shipping services are offered, InternationalShippingServiceOptions should
not be included in the request.
Note:
Beginning with Version 719, the number of domestic and international
shipping services that a seller may offer the buyer is increasing. The
number of domestic shipping services that may be offered is increasing from
3 to 4, and the number of international shipping service options is
increasing from 3 to 5.
-
salesTax
Container consisting of sales tax details. The amount of sales tax to
property
add to the price of an order is dependent on the sales tax rate in the
buyer’s state and whether sales tax is being applied to the cost of the
order only or the cost of the order plus shipping. -
insuranceOption
Specifies whether an insurance fee is required. An InsuranceOption value of
property
IncludedInShippingHandling cannot be used if the item will use calculated
shipping. Some shipping carriers automatically include shipping insurance
for qualifying items. -
insuranceFee
Insurance cost, as set by seller, if ShippingType = 1.
property
Specify if InsuranceOption is optional or required. Must
be greater than zero value if a value of Optional or Required is passed in
InsuranceOption. Value specified should be the total cost of insuring the
item. -
paymentMethods
This optional field allows a US or German seller to add specific payment
property
methods that were not in the original item listing. The only valid values
for this field are ‘PayPal’ for a US listing, or
‘MoneyXferAcceptedInCheckout’ (CIP+) for a DE listing. -
payPalEmailAddress
If the PaymentMethods field is used and set to PayPal, the seller
property
provides his/her PayPal email address in this field. -
checkoutInstructions
This field allows the seller to provide a message or instructions
property
regarding checkout/payment or the return policy. -
emailCopyToSeller
Flag indicating whether or not the seller wishes to receive an email copy of
property
the invoice sent to the buyer. -
codCost
Italy site (site ID 101) only.
property
Enables you to specify the cash-on-delivery (COD) cost for COD shipping. -
sku
The seller’s unique identifier for an item that is being tracked by this
property
SKU. If OrderID or OrderLineItemID are not provided, both SKU (or
ItemID) and corresponding TransactionID must be provided to uniquely
identify a single line item order. For a multiple line item (Combined
Payment) order, OrderID must be used.
This field can only be used if the Item.InventoryTrackingMethod field
(set with the AddFixedPriceItem or RelistFixedPriceItem calls) is set to
SKU. -
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.
Unless the ItemID (or SKU) and corresponding TransactionID 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,
ItemID, TransactionID, and SKU are ignored if present in the same
request.
Properties
checkoutInstructions
This field allows the seller to provide a message or instructions
regarding checkout/payment or the return policy.
@property (nonatomic, retain) NSString *checkoutInstructions
Discussion
This field allows the seller to provide a message or instructions
regarding checkout/payment or the return policy.
type : NSString, wrapper for primitive string
Declared In
Trading_SendInvoiceRequestType.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_SendInvoiceRequestType.h
emailCopyToSeller
Flag indicating whether or not the seller wishes to receive an email copy of
the invoice sent to the buyer.
@property (nonatomic, retain) NSNumber *emailCopyToSeller
Discussion
Flag indicating whether or not the seller wishes to receive an email copy of
the invoice sent to the buyer.
type : NSNumber, wrapper for primitive bool
Declared In
Trading_SendInvoiceRequestType.h
insuranceFee
Insurance cost, as set by seller, if ShippingType = 1.
Specify if InsuranceOption is optional or required. Must
be greater than zero value if a value of Optional or Required is passed in
InsuranceOption. Value specified should be the total cost of insuring the
item.
@property (nonatomic, retain) Trading_AmountType *insuranceFee
Discussion
Insurance cost, as set by seller, if ShippingType = 1.
Specify if InsuranceOption is optional or required. Must
be greater than zero value if a value of Optional or Required is passed in
InsuranceOption. Value specified should be the total cost of insuring the
item.
type : class Trading_AmountType
Declared In
Trading_SendInvoiceRequestType.h
insuranceOption
Specifies whether an insurance fee is required. An InsuranceOption value of
IncludedInShippingHandling cannot be used if the item will use calculated
shipping. Some shipping carriers automatically include shipping insurance
for qualifying items.
@property (nonatomic, retain) NSString *insuranceOption
Discussion
Specifies whether an insurance fee is required. An InsuranceOption value of
IncludedInShippingHandling cannot be used if the item will use calculated
shipping. Some shipping carriers automatically include shipping insurance
for qualifying items.
type: string constant in Trading_InsuranceOptionCodeType.h
Declared In
Trading_SendInvoiceRequestType.h
internationalShippingServiceOptions
If the buyer has an International shipping address, use this container
to offer up to three International shipping services. If International
shipping services are offered, (domestic) ShippingServiceOptions should
not be included in the request.
Note:
Beginning with Version 719, the number of domestic and international
shipping services that a seller may offer the buyer is increasing. The
number of domestic shipping services that may be offered is increasing from
3 to 4, and the number of international shipping service options is
increasing from 3 to 5.
@property (nonatomic, retain) NSMutableArray *internationalShippingServiceOptions
Discussion
If the buyer has an International shipping address, use this container
to offer up to three International shipping services. If International
shipping services are offered, (domestic) ShippingServiceOptions should
not be included in the request.
Note:
Beginning with Version 719, the number of domestic and international
shipping services that a seller may offer the buyer is increasing. The
number of domestic shipping services that may be offered is increasing from
3 to 4, and the number of international shipping service options is
increasing from 3 to 5.
entry type : class Trading_InternationalShippingServiceOptionsType
Declared In
Trading_SendInvoiceRequestType.h
itemID
Unique identifier for an eBay item listing. Unless OrderID or
OrderLineItemID is provided in the request, the ItemID (or SKU) is
required and must be paired with the corresponding TransactionID to
identify a single line item order. For a multiple line item (Combined
Payment) order, OrderID should be used.
@property (nonatomic, retain) NSString *itemID
Discussion
Unique identifier for an eBay item listing. Unless OrderID or
OrderLineItemID is provided in the request, the ItemID (or SKU) is
required and must be paired with the corresponding TransactionID to
identify a single line item order. For a multiple line item (Combined
Payment) order, OrderID should be used.
type : NSString, wrapper for primitive string
Declared In
Trading_SendInvoiceRequestType.h
orderID
A unique identifier that identifies a single line item or multiple line
item (Combined Payment) orders.
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. A
Combined Payment order can also be created by the seller through the
AddOrder call.
Unless the ItemID (or SKU) and corresponding TransactionID, or the
OrderLineItemID is provided in the request to identify a single line
item order, the OrderID must be specified. If OrderID is specified,
OrderLineItemID, ItemID, TransactionID, and SKU are ignored if present
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) orders.
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. A
Combined Payment order can also be created by the seller through the
AddOrder call.
Unless the ItemID (or SKU) and corresponding TransactionID, or the
OrderLineItemID is provided in the request to identify a single line
item order, the OrderID must be specified. If OrderID is specified,
OrderLineItemID, ItemID, TransactionID, and SKU are ignored if present
in the same request.
type : NSString, wrapper for primitive string
Declared In
Trading_SendInvoiceRequestType.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.
Unless the ItemID (or SKU) and corresponding TransactionID 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,
ItemID, TransactionID, and SKU are ignored if present in the same
request.
@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.
Unless the ItemID (or SKU) and corresponding TransactionID 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,
ItemID, TransactionID, and SKU are ignored if present in the same
request.
type : NSString, wrapper for primitive string
Declared In
Trading_SendInvoiceRequestType.h
payPalEmailAddress
If the PaymentMethods field is used and set to PayPal, the seller
provides his/her PayPal email address in this field.
@property (nonatomic, retain) NSString *payPalEmailAddress
Discussion
If the PaymentMethods field is used and set to PayPal, the seller
provides his/her PayPal email address in this field.
type : NSString, wrapper for primitive string
Declared In
Trading_SendInvoiceRequestType.h
paymentMethods
This optional field allows a US or German seller to add specific payment
methods that were not in the original item listing. The only valid values
for this field are ‘PayPal’ for a US listing, or
‘MoneyXferAcceptedInCheckout’ (CIP+) for a DE listing.
@property (nonatomic, retain) NSMutableArray *paymentMethods
Discussion
This optional field allows a US or German seller to add specific payment
methods that were not in the original item listing. The only valid values
for this field are ‘PayPal’ for a US listing, or
‘MoneyXferAcceptedInCheckout’ (CIP+) for a DE listing.
entry type : string constant in Trading_BuyerPaymentMethodCodeType.h
Declared In
Trading_SendInvoiceRequestType.h
salesTax
Container consisting of sales tax details. The amount of sales tax to
add to the price of an order is dependent on the sales tax rate in the
buyer’s state and whether sales tax is being applied to the cost of the
order only or the cost of the order plus shipping.
@property (nonatomic, retain) Trading_SalesTaxType *salesTax
Discussion
Container consisting of sales tax details. The amount of sales tax to
add to the price of an order is dependent on the sales tax rate in the
buyer’s state and whether sales tax is being applied to the cost of the
order only or the cost of the order plus shipping.
type : class Trading_SalesTaxType
Declared In
Trading_SendInvoiceRequestType.h
shippingServiceOptions
If the buyer has a domestic shipping address, use this container
to offer up to three domestic shipping services. If domestic
shipping services are offered, InternationalShippingServiceOptions should
not be included in the request.
Note:
Beginning with Version 719, the number of domestic and international
shipping services that a seller may offer the buyer is increasing. The
number of domestic shipping services that may be offered is increasing from
3 to 4, and the number of international shipping service options is
increasing from 3 to 5.
@property (nonatomic, retain) NSMutableArray *shippingServiceOptions
Discussion
If the buyer has a domestic shipping address, use this container
to offer up to three domestic shipping services. If domestic
shipping services are offered, InternationalShippingServiceOptions should
not be included in the request.
Note:
Beginning with Version 719, the number of domestic and international
shipping services that a seller may offer the buyer is increasing. The
number of domestic shipping services that may be offered is increasing from
3 to 4, and the number of international shipping service options is
increasing from 3 to 5.
entry type : class Trading_ShippingServiceOptionsType
Declared In
Trading_SendInvoiceRequestType.h
sku
The seller’s unique identifier for an item that is being tracked by this
SKU. If OrderID or OrderLineItemID are not provided, both SKU (or
ItemID) and corresponding TransactionID must be provided to uniquely
identify a single line item order. For a multiple line item (Combined
Payment) order, OrderID must be used.
This field can only be used if the Item.InventoryTrackingMethod field
(set with the AddFixedPriceItem or RelistFixedPriceItem calls) is set to
SKU.
@property (nonatomic, retain) NSString *sku
Discussion
The seller’s unique identifier for an item that is being tracked by this
SKU. If OrderID or OrderLineItemID are not provided, both SKU (or
ItemID) and corresponding TransactionID must be provided to uniquely
identify a single line item order. For a multiple line item (Combined
Payment) order, OrderID must be used.
This field can only be used if the Item.InventoryTrackingMethod field
(set with the AddFixedPriceItem or RelistFixedPriceItem calls) is set to
SKU.
type : NSString, wrapper for primitive string
Declared In
Trading_SendInvoiceRequestType.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. Unless OrderID or OrderLineItemID is
provided in the request, the TransactionID is required and must be
paired with the corresponding ItemID to identify a single line item
order. For a multiple line item (Combined Payment) order, OrderID should
be used.
@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. Unless OrderID or OrderLineItemID is
provided in the request, the TransactionID is required and must be
paired with the corresponding ItemID to identify a single line item
order. For a multiple line item (Combined Payment) order, OrderID should
be used.
type : NSString, wrapper for primitive string
Declared In
Trading_SendInvoiceRequestType.h