Inherits from NSObject
Conforms to PicoBindable
Declared in Trading_AbstractRequestType.h
Trading_AbstractRequestType.m

Overview

Base type definition of the request payload, which can carry any type of payload
content plus optional versioning information and detail level requirements. All
concrete request types (e.g., AddItemRequestType) are derived from the abstract
request type. The naming convention we use for the concrete type names is the name
of the service (the verb or call name) followed by “RequestType”:
VerbNameRequestType

@ingroup EBayAPIInterface

Tasks

  •   requesterCredentials

    (public property)

    property
  •   detailLevel

    Detail levels are instructions that define standard subsets of
    data to return for particular data components (e.g., each
    Item, Transaction, or User) within the response payload.
    For example, a particular detail level might cause the
    response to include buyer-related data in every result
    (e.g., for every Item), but no seller-related data.
    Specifying a detail level is like using a
    predefined attribute list in the SELECT clause of an SQL query.
    Use the DetailLevel element to specify the required detail level
    that the client application needs pertaining to the data components
    that are applicable to the request.



    The DetailLevelCodeType defines the
    global list of available detail levels for all request types.
    Most request types support certain detail
    levels or none at all. If you pass a detail level that exists
    in the schema but that isn’t valid for a particular request,
    eBay ignores it processes the request without it.
    For each request type, see the detail level tables in the
    Input/Output Reference to determine which detail levels are
    applicable and which elements are returned for each applicable
    detail level. (Some detail level tables are still in the
    eBay Web Services guide. They will be moved to the
    Input/Output Reference in a future release.)


    Note that DetailLevel is required input for
    GetMyMessages.



    With GetSellerList and other calls that retrieve large data sets,
    please avoid using ReturnAll when possible. For example, if you use
    GetSellerList, use a GranularityLevel or use the
    GetSellerEvents call instead. If you do use ReturnAll with
    GetSellerList, use a small EntriesPerPage value and a short
    EndTimeFrom/EndTimeTo range for better performance.

    property
  •   errorLanguage

    Use ErrorLanguage to return error strings for the call in a different language
    from the language commonly associated with the site that the requesting user
    is registered with. Specify the standard RFC 3066 language identification tag
    (e.g., en_US).


    ID— country

    —– —–

    de_AT Austria

    de_CH Switzerland

    de_DE Germany

    en_AU Australia

    en_CA Canada

    en_GB United Kingdom

    en_SG Singapore

    en_US United States

    es_ES Spain

    fr_BE Belgium (French)

    fr_CA Canada (French)

    fr_FR France

    it_IT Italy

    nl_BE Belgium (Dutch)

    nl_NL Netherlands

    zh_CN China

    en_IN India

    en_IE Ireland

    zh_HK Hong Kong

    property
  •   messageID

    Most Trading API calls support a MessageID element in the request
    and a CorrelationID element in the response. If you pass in a
    MessageID in a request, the same value will be returned in the
    CorrelationID field in the response. Pairing these values can
    help you track and confirm that a response is returned for every request and to
    match specific responses to specific requests.
    If you do not pass a MessageID value in the request,
    CorrelationID is not returned.



    Note:
    GetCategories is designed to retrieve very large sets of metadata
    that change once a day or less often. To improve performance, these calls return
    cached responses when you request all available data (with no filters). When this
    occurs, the MessageID and CorrelationID fields
    aren’t applicable. However, if you specify an input filter to reduce the amount of
    data returned, the calls retrieve the latest data (not cached). When this occurs,
    MessageID and CorrelationID are applicable.

    property
  •   version

    The version number of the API code that you are
    programming against (e.g., 549).
    The version you specify for a call has these basic effects:

    - It indicates the version of the code lists and other
    data that eBay should use to process your request.

    - It indicates the schema version you are using.

    You need to use a version that is greater than or equal to the
    lowest supported version.



    For the SOAP API: If you are using the SOAP API,
    this field is required. Specify the version of the WSDL your
    application is using.



    For the XML API: If you are using the XML API,
    this field has no effect. Instead, specify the version in the
    X-EBAY-API-COMPATIBILITY-LEVEL HTTP header.
    (If you specify Version in the body of an XML API request and it
    is different from the value in the HTTP header, eBay returns an
    informational warning that the value in the HTTP header was used
    instead.)

    property
  •   endUserIP

    The public IP address of the machine from which the request is sent.
    Your application captures that IP address and includes it in
    a call request. eBay evaluates requests for safety (also see
    the BotBlock container
    in the request and response of this call).

    property
  •   errorHandling

    Error tolerance level for the call. This is a preference
    that specifies how eBay should handle requests that contain
    invalid data or that could partially fail. This gives you some control
    over whether eBay returns warnings or blocking errors
    and how eBay processes the invalid data.



    This field is only applicable to AddItem and related calls,
    and only when the listing includes ProductListingDetails.

    property
  •   invocationID

    A unique identifer for a particular call. If the same InvocationID is passed
    in after it has been passed in once on a call that succeeded for a particular
    application and user, then an error will be returned. The identifier can
    only contain digits from 0-9 and letters from A-F. The
    identifier must be 32 characters long. For example,
    1FB02B2-9D27-3acb-ABA2-9D539C374228.

    property
  •   outputSelector

    You can use the OutputSelector field to restrict the data returned by this call.
    When you make a call such as GetItem that retrieves data from eBay,
    the OutputSelector field is useful for restricting the data returned.
    This field makes the call response easier to use, especially when a large payload
    would be returned. If you use the OutputSelector field, the output data
    will include only the fields you specified in the request.
    For example, if you are using GetItem and you want the item data
    in the response to be restricted to the ViewItemURL
    (the URL where a user can view the listing) and BuyItNowPrice, then
    within the GetItem request, specify those output fields.
    To use this field, see the information at the following link.

    property
  •   warningLevel

    Controls whether or not to return warnings when the application passes
    unrecognized or deprecated elements in a request.



    An unrecognized element is one that is not defined in any supported
    version of the schema. Schema element names are case-sensitive,
    so using WarningLevel can also help you remove any potential hidden
    bugs within your application due to incorrect case or spelling in
    field names before you put your application into the
    Production environment.



    WarningLevel only validates elements; it doesn’t validate
    XML attributes. It also doesn’t control warnings related to
    user-entered strings or numbers, or warnings for
    logical errors.



    We recommend that you only use this during development and debugging.
    Do not use this in requests in your production code.

    property
  •   botBlock

    Container for a token and for user input.

    property
  •   any

    (public property)

    property

Properties

any

(public property)

@property (nonatomic, retain) NSMutableArray *any

Discussion

(public property)

entry type : PicoAnyElement, wrapper for primitive anyelement

Declared In

Trading_AbstractRequestType.h

botBlock

Container for a token and for user input.

@property (nonatomic, retain) Trading_BotBlockRequestType *botBlock

Discussion

Container for a token and for user input.

type : class Trading_BotBlockRequestType

Declared In

Trading_AbstractRequestType.h

detailLevel

Detail levels are instructions that define standard subsets of
data to return for particular data components (e.g., each
Item, Transaction, or User) within the response payload.
For example, a particular detail level might cause the
response to include buyer-related data in every result
(e.g., for every Item), but no seller-related data.
Specifying a detail level is like using a
predefined attribute list in the SELECT clause of an SQL query.
Use the DetailLevel element to specify the required detail level
that the client application needs pertaining to the data components
that are applicable to the request.



The DetailLevelCodeType defines the
global list of available detail levels for all request types.
Most request types support certain detail
levels or none at all. If you pass a detail level that exists
in the schema but that isn’t valid for a particular request,
eBay ignores it processes the request without it.
For each request type, see the detail level tables in the
Input/Output Reference to determine which detail levels are
applicable and which elements are returned for each applicable
detail level. (Some detail level tables are still in the
eBay Web Services guide. They will be moved to the
Input/Output Reference in a future release.)


Note that DetailLevel is required input for
GetMyMessages.



With GetSellerList and other calls that retrieve large data sets,
please avoid using ReturnAll when possible. For example, if you use
GetSellerList, use a GranularityLevel or use the
GetSellerEvents call instead. If you do use ReturnAll with
GetSellerList, use a small EntriesPerPage value and a short
EndTimeFrom/EndTimeTo range for better performance.

@property (nonatomic, retain) NSMutableArray *detailLevel

Discussion

Detail levels are instructions that define standard subsets of
data to return for particular data components (e.g., each
Item, Transaction, or User) within the response payload.
For example, a particular detail level might cause the
response to include buyer-related data in every result
(e.g., for every Item), but no seller-related data.
Specifying a detail level is like using a
predefined attribute list in the SELECT clause of an SQL query.
Use the DetailLevel element to specify the required detail level
that the client application needs pertaining to the data components
that are applicable to the request.



The DetailLevelCodeType defines the
global list of available detail levels for all request types.
Most request types support certain detail
levels or none at all. If you pass a detail level that exists
in the schema but that isn’t valid for a particular request,
eBay ignores it processes the request without it.
For each request type, see the detail level tables in the
Input/Output Reference to determine which detail levels are
applicable and which elements are returned for each applicable
detail level. (Some detail level tables are still in the
eBay Web Services guide. They will be moved to the
Input/Output Reference in a future release.)


Note that DetailLevel is required input for
GetMyMessages.



With GetSellerList and other calls that retrieve large data sets,
please avoid using ReturnAll when possible. For example, if you use
GetSellerList, use a GranularityLevel or use the
GetSellerEvents call instead. If you do use ReturnAll with
GetSellerList, use a small EntriesPerPage value and a short
EndTimeFrom/EndTimeTo range for better performance.

entry type : string constant in Trading_DetailLevelCodeType.h

Declared In

Trading_AbstractRequestType.h

endUserIP

The public IP address of the machine from which the request is sent.
Your application captures that IP address and includes it in
a call request. eBay evaluates requests for safety (also see
the BotBlock container
in the request and response of this call).

@property (nonatomic, retain) NSString *endUserIP

Discussion

The public IP address of the machine from which the request is sent.
Your application captures that IP address and includes it in
a call request. eBay evaluates requests for safety (also see
the BotBlock container
in the request and response of this call).

type : NSString, wrapper for primitive string

Declared In

Trading_AbstractRequestType.h

errorHandling

Error tolerance level for the call. This is a preference
that specifies how eBay should handle requests that contain
invalid data or that could partially fail. This gives you some control
over whether eBay returns warnings or blocking errors
and how eBay processes the invalid data.



This field is only applicable to AddItem and related calls,
and only when the listing includes ProductListingDetails.

@property (nonatomic, retain) NSString *errorHandling

Discussion

Error tolerance level for the call. This is a preference
that specifies how eBay should handle requests that contain
invalid data or that could partially fail. This gives you some control
over whether eBay returns warnings or blocking errors
and how eBay processes the invalid data.



This field is only applicable to AddItem and related calls,
and only when the listing includes ProductListingDetails.

type: string constant in Trading_ErrorHandlingCodeType.h

Declared In

Trading_AbstractRequestType.h

errorLanguage

Use ErrorLanguage to return error strings for the call in a different language
from the language commonly associated with the site that the requesting user
is registered with. Specify the standard RFC 3066 language identification tag
(e.g., en_US).


ID— country

—– —–

de_AT Austria

de_CH Switzerland

de_DE Germany

en_AU Australia

en_CA Canada

en_GB United Kingdom

en_SG Singapore

en_US United States

es_ES Spain

fr_BE Belgium (French)

fr_CA Canada (French)

fr_FR France

it_IT Italy

nl_BE Belgium (Dutch)

nl_NL Netherlands

zh_CN China

en_IN India

en_IE Ireland

zh_HK Hong Kong

@property (nonatomic, retain) NSString *errorLanguage

Discussion

Use ErrorLanguage to return error strings for the call in a different language
from the language commonly associated with the site that the requesting user
is registered with. Specify the standard RFC 3066 language identification tag
(e.g., en_US).


ID— country

—– —–

de_AT Austria

de_CH Switzerland

de_DE Germany

en_AU Australia

en_CA Canada

en_GB United Kingdom

en_SG Singapore

en_US United States

es_ES Spain

fr_BE Belgium (French)

fr_CA Canada (French)

fr_FR France

it_IT Italy

nl_BE Belgium (Dutch)

nl_NL Netherlands

zh_CN China

en_IN India

en_IE Ireland

zh_HK Hong Kong

type : NSString, wrapper for primitive string

Declared In

Trading_AbstractRequestType.h

invocationID

A unique identifer for a particular call. If the same InvocationID is passed
in after it has been passed in once on a call that succeeded for a particular
application and user, then an error will be returned. The identifier can
only contain digits from 0-9 and letters from A-F. The
identifier must be 32 characters long. For example,
1FB02B2-9D27-3acb-ABA2-9D539C374228.

@property (nonatomic, retain) NSString *invocationID

Discussion

A unique identifer for a particular call. If the same InvocationID is passed
in after it has been passed in once on a call that succeeded for a particular
application and user, then an error will be returned. The identifier can
only contain digits from 0-9 and letters from A-F. The
identifier must be 32 characters long. For example,
1FB02B2-9D27-3acb-ABA2-9D539C374228.

type : NSString, wrapper for primitive string

Declared In

Trading_AbstractRequestType.h

messageID

Most Trading API calls support a MessageID element in the request
and a CorrelationID element in the response. If you pass in a
MessageID in a request, the same value will be returned in the
CorrelationID field in the response. Pairing these values can
help you track and confirm that a response is returned for every request and to
match specific responses to specific requests.
If you do not pass a MessageID value in the request,
CorrelationID is not returned.



Note:
GetCategories is designed to retrieve very large sets of metadata
that change once a day or less often. To improve performance, these calls return
cached responses when you request all available data (with no filters). When this
occurs, the MessageID and CorrelationID fields
aren’t applicable. However, if you specify an input filter to reduce the amount of
data returned, the calls retrieve the latest data (not cached). When this occurs,
MessageID and CorrelationID are applicable.

@property (nonatomic, retain) NSString *messageID

Discussion

Most Trading API calls support a MessageID element in the request
and a CorrelationID element in the response. If you pass in a
MessageID in a request, the same value will be returned in the
CorrelationID field in the response. Pairing these values can
help you track and confirm that a response is returned for every request and to
match specific responses to specific requests.
If you do not pass a MessageID value in the request,
CorrelationID is not returned.



Note:
GetCategories is designed to retrieve very large sets of metadata
that change once a day or less often. To improve performance, these calls return
cached responses when you request all available data (with no filters). When this
occurs, the MessageID and CorrelationID fields
aren’t applicable. However, if you specify an input filter to reduce the amount of
data returned, the calls retrieve the latest data (not cached). When this occurs,
MessageID and CorrelationID are applicable.

type : NSString, wrapper for primitive string

Declared In

Trading_AbstractRequestType.h

outputSelector

You can use the OutputSelector field to restrict the data returned by this call.
When you make a call such as GetItem that retrieves data from eBay,
the OutputSelector field is useful for restricting the data returned.
This field makes the call response easier to use, especially when a large payload
would be returned. If you use the OutputSelector field, the output data
will include only the fields you specified in the request.
For example, if you are using GetItem and you want the item data
in the response to be restricted to the ViewItemURL
(the URL where a user can view the listing) and BuyItNowPrice, then
within the GetItem request, specify those output fields.
To use this field, see the information at the following link.

@property (nonatomic, retain) NSMutableArray *outputSelector

Discussion

You can use the OutputSelector field to restrict the data returned by this call.
When you make a call such as GetItem that retrieves data from eBay,
the OutputSelector field is useful for restricting the data returned.
This field makes the call response easier to use, especially when a large payload
would be returned. If you use the OutputSelector field, the output data
will include only the fields you specified in the request.
For example, if you are using GetItem and you want the item data
in the response to be restricted to the ViewItemURL
(the URL where a user can view the listing) and BuyItNowPrice, then
within the GetItem request, specify those output fields.
To use this field, see the information at the following link.

entry type : NSString, wrapper for primitive string

Declared In

Trading_AbstractRequestType.h

requesterCredentials

(public property)

@property (nonatomic, retain) Trading_CustomSecurityHeaderType *requesterCredentials

Discussion

(public property)

type : class Trading_CustomSecurityHeaderType

Declared In

Trading_AbstractRequestType.h

version

The version number of the API code that you are
programming against (e.g., 549).
The version you specify for a call has these basic effects:

- It indicates the version of the code lists and other
data that eBay should use to process your request.

- It indicates the schema version you are using.

You need to use a version that is greater than or equal to the
lowest supported version.



For the SOAP API: If you are using the SOAP API,
this field is required. Specify the version of the WSDL your
application is using.



For the XML API: If you are using the XML API,
this field has no effect. Instead, specify the version in the
X-EBAY-API-COMPATIBILITY-LEVEL HTTP header.
(If you specify Version in the body of an XML API request and it
is different from the value in the HTTP header, eBay returns an
informational warning that the value in the HTTP header was used
instead.)

@property (nonatomic, retain) NSString *version

Discussion

The version number of the API code that you are
programming against (e.g., 549).
The version you specify for a call has these basic effects:

- It indicates the version of the code lists and other
data that eBay should use to process your request.

- It indicates the schema version you are using.

You need to use a version that is greater than or equal to the
lowest supported version.



For the SOAP API: If you are using the SOAP API,
this field is required. Specify the version of the WSDL your
application is using.



For the XML API: If you are using the XML API,
this field has no effect. Instead, specify the version in the
X-EBAY-API-COMPATIBILITY-LEVEL HTTP header.
(If you specify Version in the body of an XML API request and it
is different from the value in the HTTP header, eBay returns an
informational warning that the value in the HTTP header was used
instead.)

type : NSString, wrapper for primitive string

Declared In

Trading_AbstractRequestType.h

warningLevel

Controls whether or not to return warnings when the application passes
unrecognized or deprecated elements in a request.



An unrecognized element is one that is not defined in any supported
version of the schema. Schema element names are case-sensitive,
so using WarningLevel can also help you remove any potential hidden
bugs within your application due to incorrect case or spelling in
field names before you put your application into the
Production environment.



WarningLevel only validates elements; it doesn’t validate
XML attributes. It also doesn’t control warnings related to
user-entered strings or numbers, or warnings for
logical errors.



We recommend that you only use this during development and debugging.
Do not use this in requests in your production code.

@property (nonatomic, retain) NSString *warningLevel

Discussion

Controls whether or not to return warnings when the application passes
unrecognized or deprecated elements in a request.



An unrecognized element is one that is not defined in any supported
version of the schema. Schema element names are case-sensitive,
so using WarningLevel can also help you remove any potential hidden
bugs within your application due to incorrect case or spelling in
field names before you put your application into the
Production environment.



WarningLevel only validates elements; it doesn’t validate
XML attributes. It also doesn’t control warnings related to
user-entered strings or numbers, or warnings for
logical errors.



We recommend that you only use this during development and debugging.
Do not use this in requests in your production code.

type: string constant in Trading_WarningLevelCodeType.h

Declared In

Trading_AbstractRequestType.h