Trading_SetUserNotesRequestType Class Reference
Inherits from | Trading_AbstractRequestType : NSObject |
Declared in | Trading_SetUserNotesRequestType.h Trading_SetUserNotesRequestType.m |
Overview
Enables users to add, replace, and delete My eBay notes for
items that are being tracked in the My eBay All Selling and
All Buying areas.
@ingroup EBayAPIInterface
Tasks
-
itemID
ID of the item to which the My eBay note will be
property
attached. Notes can only be added to items that are
currently being tracked in My eBay. -
action
The seller must include this field and set it to ‘AddOrUpdate’ to add a new
property
user note or update an existing user note, or set it to ‘Delete’ to delete a
an existing user note. -
noteText
Text of the note. Maximum 250 characters. Required only
property
if the Action is AddOrUpdate. This note text will
completely replace any existing My eBay note for the
specified item. -
transactionID
Unique identifier for the order line item (transaction) to which the My
property
eBay note will be attached. Notes can only be added to order line items
that are currently being tracked in My eBay. Buyers can
view user notes made on order line items in the
PrivateNotes field of the WonList container in GetMyeBayBuying, and
sellers can view user notes made on order line items in
the PrivateNotes field of the SoldList and DeletedFromSoldList
containers in GetMyeBaySellinging. -
variationSpecifics
Container consisting of name-value pairs that identify (match) one
property
variation within a fixed-price, multi-variation listing. The specified
name-value pair(s) must exist in the listing specified by either the
ItemID or SKU values specified in the request. If a specific order line
item is targeted in the request with an
ItemID/TransactionID pair or an OrderLineItemID value, any specified
VariationSpecifics container is ignored by the call. -
sku
SKU value of the item variation to which the My eBay note will be
property
attached. Notes can only be added to items that are currently being
tracked in My eBay. A SKU (stock keeping unit) value is defined by and
used by the seller to identify a variation within a fixed-price, multi-
variation listing. The SKU value is assigned to a variation of an item
through the Variations.Variation.SKU element.
This field can only be used if the Item.InventoryTrackingMethod field
(set with the AddFixedPriceItem or RelistFixedPriceItem calls) is set to
SKU.
If a specific order line item is targeted in the request
with an ItemID/TransactionID pair or an OrderLineItemID value, any
specified SKU is ignored by the call. -
orderLineItemID
A unique identifier for an eBay order line item. This field is created as
property
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. OrderLineItemID can be used in the input instead of
an ItemID/TransactionID pair to identify an order line item.
Notes can only be added to order line items that are currently being
tracked in My eBay. Buyers can view user notes made on order line items in
the PrivateNotes field of the WonList container in GetMyeBayBuying, and
sellers can view user notes made on order line items in the PrivateNotes
field of the SoldList and DeletedFromSoldList containers in
GetMyeBaySellinging.
Properties
action
The seller must include this field and set it to ‘AddOrUpdate’ to add a new
user note or update an existing user note, or set it to ‘Delete’ to delete a
an existing user note.
@property (nonatomic, retain) NSString *action
Discussion
The seller must include this field and set it to ‘AddOrUpdate’ to add a new
user note or update an existing user note, or set it to ‘Delete’ to delete a
an existing user note.
type: string constant in Trading_SetUserNotesActionCodeType.h
Declared In
Trading_SetUserNotesRequestType.h
itemID
ID of the item to which the My eBay note will be
attached. Notes can only be added to items that are
currently being tracked in My eBay.
@property (nonatomic, retain) NSString *itemID
Discussion
ID of the item to which the My eBay note will be
attached. Notes can only be added to items that are
currently being tracked in My eBay.
type : NSString, wrapper for primitive string
Declared In
Trading_SetUserNotesRequestType.h
noteText
Text of the note. Maximum 250 characters. Required only
if the Action is AddOrUpdate. This note text will
completely replace any existing My eBay note for the
specified item.
@property (nonatomic, retain) NSString *noteText
Discussion
Text of the note. Maximum 250 characters. Required only
if the Action is AddOrUpdate. This note text will
completely replace any existing My eBay note for the
specified item.
type : NSString, wrapper for primitive string
Declared In
Trading_SetUserNotesRequestType.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. OrderLineItemID can be used in the input instead of
an ItemID/TransactionID pair to identify an order line item.
Notes can only be added to order line items that are currently being
tracked in My eBay. Buyers can view user notes made on order line items in
the PrivateNotes field of the WonList container in GetMyeBayBuying, and
sellers can view user notes made on order line items in the PrivateNotes
field of the SoldList and DeletedFromSoldList containers in
GetMyeBaySellinging.
@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. OrderLineItemID can be used in the input instead of
an ItemID/TransactionID pair to identify an order line item.
Notes can only be added to order line items that are currently being
tracked in My eBay. Buyers can view user notes made on order line items in
the PrivateNotes field of the WonList container in GetMyeBayBuying, and
sellers can view user notes made on order line items in the PrivateNotes
field of the SoldList and DeletedFromSoldList containers in
GetMyeBaySellinging.
type : NSString, wrapper for primitive string
Declared In
Trading_SetUserNotesRequestType.h
sku
SKU value of the item variation to which the My eBay note will be
attached. Notes can only be added to items that are currently being
tracked in My eBay. A SKU (stock keeping unit) value is defined by and
used by the seller to identify a variation within a fixed-price, multi-
variation listing. The SKU value is assigned to a variation of an item
through the Variations.Variation.SKU element.
This field can only be used if the Item.InventoryTrackingMethod field
(set with the AddFixedPriceItem or RelistFixedPriceItem calls) is set to
SKU.
If a specific order line item is targeted in the request
with an ItemID/TransactionID pair or an OrderLineItemID value, any
specified SKU is ignored by the call.
@property (nonatomic, retain) NSString *sku
Discussion
SKU value of the item variation to which the My eBay note will be
attached. Notes can only be added to items that are currently being
tracked in My eBay. A SKU (stock keeping unit) value is defined by and
used by the seller to identify a variation within a fixed-price, multi-
variation listing. The SKU value is assigned to a variation of an item
through the Variations.Variation.SKU element.
This field can only be used if the Item.InventoryTrackingMethod field
(set with the AddFixedPriceItem or RelistFixedPriceItem calls) is set to
SKU.
If a specific order line item is targeted in the request
with an ItemID/TransactionID pair or an OrderLineItemID value, any
specified SKU is ignored by the call.
type : NSString, wrapper for primitive string
Declared In
Trading_SetUserNotesRequestType.h
transactionID
Unique identifier for the order line item (transaction) to which the My
eBay note will be attached. Notes can only be added to order line items
that are currently being tracked in My eBay. Buyers can
view user notes made on order line items in the
PrivateNotes field of the WonList container in GetMyeBayBuying, and
sellers can view user notes made on order line items in
the PrivateNotes field of the SoldList and DeletedFromSoldList
containers in GetMyeBaySellinging.
@property (nonatomic, retain) NSString *transactionID
Discussion
Unique identifier for the order line item (transaction) to which the My
eBay note will be attached. Notes can only be added to order line items
that are currently being tracked in My eBay. Buyers can
view user notes made on order line items in the
PrivateNotes field of the WonList container in GetMyeBayBuying, and
sellers can view user notes made on order line items in
the PrivateNotes field of the SoldList and DeletedFromSoldList
containers in GetMyeBaySellinging.
type : NSString, wrapper for primitive string
Declared In
Trading_SetUserNotesRequestType.h
variationSpecifics
Container consisting of name-value pairs that identify (match) one
variation within a fixed-price, multi-variation listing. The specified
name-value pair(s) must exist in the listing specified by either the
ItemID or SKU values specified in the request. If a specific order line
item is targeted in the request with an
ItemID/TransactionID pair or an OrderLineItemID value, any specified
VariationSpecifics container is ignored by the call.
@property (nonatomic, retain) Trading_NameValueListArrayType *variationSpecifics
Discussion
Container consisting of name-value pairs that identify (match) one
variation within a fixed-price, multi-variation listing. The specified
name-value pair(s) must exist in the listing specified by either the
ItemID or SKU values specified in the request. If a specific order line
item is targeted in the request with an
ItemID/TransactionID pair or an OrderLineItemID value, any specified
VariationSpecifics container is ignored by the call.
type : class Trading_NameValueListArrayType
Declared In
Trading_SetUserNotesRequestType.h