Changes since
the last release

com.ebay.soap.eBLBaseComponents
Enum URLTypeCodeType

java.lang.Object
  extended by java.lang.Enum<URLTypeCodeType>
      extended by com.ebay.soap.eBLBaseComponents.URLTypeCodeType
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<URLTypeCodeType>

public enum URLTypeCodeType
extends java.lang.Enum<URLTypeCodeType>

Java class for URLTypeCodeType.

The following schema fragment specifies the expected content contained within this class.

 <simpleType name="URLTypeCodeType">
   <restriction base="{http://www.w3.org/2001/XMLSchema}token">
     <enumeration value="ViewItemURL"/>
     <enumeration value="ViewUserURL"/>
     <enumeration value="MyeBayURL"/>
     <enumeration value="MyeBayBiddingURL"/>
     <enumeration value="MyeBayNotWonURL"/>
     <enumeration value="MyeBayWonURL"/>
     <enumeration value="MyeBayWatchingURL"/>
     <enumeration value="eBayStoreURL"/>
     <enumeration value="SmallLogoURL"/>
     <enumeration value="MediumLogoURL"/>
     <enumeration value="LargeLogoURL"/>
     <enumeration value="CreateProductUrl"/>
     <enumeration value="AppealProductUrl"/>
     <enumeration value="ManageProductUrl"/>
     <enumeration value="CustomCode"/>
   </restriction>
 </simpleType>
 
Note: Per JAXB standards, underscores are added to separate words in enumerations (e.g., PayPal becomes PAY_PAL).


Enum Constant Summary
APPEAL_PRODUCT_URL
          This value indicates that the URL in the corresponding URL field is the base URL that a seller needs to enter the UI flow to make a request that an existing eBay Catalog product be revised.
CREATE_PRODUCT_URL
          This value indicates that the URL in the corresponding URL field is the base URL that a seller needs to enter the UI flow to make a request that a missing product be added to the eBay Catalog.
CUSTOM_CODE
          Reserved for future use.
E_BAY_STORE_URL
          This value indicates that the URL in the corresponding URL field is the base URL to the user's eBay Store page.
LARGE_LOGO_URL
          This value indicates that the URL in the corresponding URL field is the full URL to the large version of the eBay Marketplace logo.
MANAGE_PRODUCT_URL
          This value indicates that the URL in the corresponding URL field is the base URL that a seller needs to enter the UI flow to get the status of a catalog change request (request for a new catalog product or request to revise an existing product).
MEDIUM_LOGO_URL
          This value indicates that the URL in the corresponding URL field is the full URL to the medium version of the eBay Marketplace logo.
MYE_BAY_BIDDING_URL
          This value indicates that the URL in the corresponding URL field is the URL for the user's My eBay Bids/Offer page.
MYE_BAY_NOT_WON_URL
          This value indicates that the URL in the corresponding URL field is the URL to the 'Didn't Win' section on the user's My eBay Bids/Offer page.
MYE_BAY_URL
          This value indicates that the URL in the corresponding URL field is the URL for the My eBay home page.
MYE_BAY_WATCHING_URL
          This value indicates that the URL in the corresponding URL field is the URL to the user's My eBay Watch List page.
MYE_BAY_WON_URL
          This value indicates that the URL in the corresponding URL field is the URL to the 'Bidding' section on the user's My eBay Bids/Offer page.
SMALL_LOGO_URL
          This value indicates that the URL in the corresponding URL field is the full URL to the small version of the eBay Marketplace logo.
VIEW_ITEM_URL
          This value indicates that the URL in the corresponding URL field is the base URL for the View Item page.
VIEW_USER_URL
          This value indicates that the URL in the corresponding URL field is the base URL for the eBay User page.
 
Method Summary
static URLTypeCodeType fromValue(java.lang.String v)
           
 java.lang.String value()
           
static URLTypeCodeType valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static URLTypeCodeType[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

VIEW_ITEM_URL

public static final URLTypeCodeType VIEW_ITEM_URL
This value indicates that the URL in the corresponding URL field is the base URL for the View Item page. The user will just input the Item ID for a listing at the end of the URL to retrieve the View Item page for that listing.


VIEW_USER_URL

public static final URLTypeCodeType VIEW_USER_URL
This value indicates that the URL in the corresponding URL field is the base URL for the eBay User page. The user will just input the user ID for an eBay user at the end of the URL to retrieve the eBay User page.


MYE_BAY_URL

public static final URLTypeCodeType MYE_BAY_URL
This value indicates that the URL in the corresponding URL field is the URL for the My eBay home page.


MYE_BAY_BIDDING_URL

public static final URLTypeCodeType MYE_BAY_BIDDING_URL
This value indicates that the URL in the corresponding URL field is the URL for the user's My eBay Bids/Offer page.


MYE_BAY_NOT_WON_URL

public static final URLTypeCodeType MYE_BAY_NOT_WON_URL
This value indicates that the URL in the corresponding URL field is the URL to the 'Didn't Win' section on the user's My eBay Bids/Offer page.


MYE_BAY_WON_URL

public static final URLTypeCodeType MYE_BAY_WON_URL
This value indicates that the URL in the corresponding URL field is the URL to the 'Bidding' section on the user's My eBay Bids/Offer page.


MYE_BAY_WATCHING_URL

public static final URLTypeCodeType MYE_BAY_WATCHING_URL
This value indicates that the URL in the corresponding URL field is the URL to the user's My eBay Watch List page.


E_BAY_STORE_URL

public static final URLTypeCodeType E_BAY_STORE_URL
This value indicates that the URL in the corresponding URL field is the base URL to the user's eBay Store page. The seller will just add a forward slash (/) and their eBay Store name to get to their eBay Store home page.


SMALL_LOGO_URL

public static final URLTypeCodeType SMALL_LOGO_URL
This value indicates that the URL in the corresponding URL field is the full URL to the small version of the eBay Marketplace logo.


MEDIUM_LOGO_URL

public static final URLTypeCodeType MEDIUM_LOGO_URL
This value indicates that the URL in the corresponding URL field is the full URL to the medium version of the eBay Marketplace logo.


LARGE_LOGO_URL

public static final URLTypeCodeType LARGE_LOGO_URL
This value indicates that the URL in the corresponding URL field is the full URL to the large version of the eBay Marketplace logo.


CREATE_PRODUCT_URL

public static final URLTypeCodeType CREATE_PRODUCT_URL
This value indicates that the URL in the corresponding URL field is the base URL that a seller needs to enter the UI flow to make a request that a missing product be added to the eBay Catalog.

The seller will also have to use a valid OAuth token, and will pass in this OAuth token through an id_token query parameter. So, for the US site (the base URL will vary by site), the HTTPS Sandbox endpoint might look like the following:

https://www.sandbox.ebay.com/slr/prd?id_token=Oauth_token

Different base URLs will be returned depending on whether you call GeteBayDetails in Sandbox or Production environment. As of April 2018, this URL and the create catalog product flow is only available in the Sandbox environment. This URL and the create catalog product flow will become available in the Production environment in August 2018 with the launch of Product-Based Shopping Experience Phase 2. See the Product-Based Shopping Experience landing page for more information.

For more information on getting OAuth access tokens, see our OAuth access tokens help topic.


APPEAL_PRODUCT_URL

public static final URLTypeCodeType APPEAL_PRODUCT_URL
This value indicates that the URL in the corresponding URL field is the base URL that a seller needs to enter the UI flow to make a request that an existing eBay Catalog product be revised. The seller will have to append the ePID value of the catalog product to the end of the URL.

The seller will also have to use a valid OAuth token, and will pass in this OAuth token through an id_token query parameter. So, for the US site (the base URL will vary by site), the HTTPS Sandbox endpoint might look like the following:

https://www.sandbox.ebay.com/slr/prd/149167716?id_token=Oauth_token, where '149167716' is the ePID of the catalog product.

Different base URLs will be returned depending on whether you call GeteBayDetails in Sandbox or Production environment. As of April 2018, this URL and the appeal catalog product flow is only available in the Sandbox environment. This URL and the create catalog product flow will become available in the Production environment in August 2018 with the launch of Product-Based Shopping Experience Phase 2. See the Product-Based Shopping Experience landing page for more information.

For more information on getting OAuth access tokens, see our OAuth access tokens help topic.


MANAGE_PRODUCT_URL

public static final URLTypeCodeType MANAGE_PRODUCT_URL
This value indicates that the URL in the corresponding URL field is the base URL that a seller needs to enter the UI flow to get the status of a catalog change request (request for a new catalog product or request to revise an existing product). The seller will have to append the identifier of the catalog change request to the end of the URL.

The seller will also have to use a valid token, and will pass in this token through an id_token query parameter. The authentication tokens are not yet available, but eBay will be sharing detailed instructions on how to authenticate and invoke these pages soon.

For the US site (the base URL will vary by site), the HTTPS Sandbox endpoint might look like the following:

https://www.sandbox.ebay.com/slr/prd/status/5ac3cf22ca4c591b0c324749?id_token=token_value, where '5ac3cf22ca4c591b0c324749' is the identifier of the catalog change request.

Different base URLs will be returned depending on whether you call GeteBayDetails in Sandbox or Production environment. Currently, this URL and the manage catalog change request flow is only available in the Sandbox environment. This URL and the create catalog product flow will become available in the Production environment in August 2018 with the launch of Phase 2 of the Product-Based Shopping Experience. See the Product-Based Shopping Experience landing page for more information.


CUSTOM_CODE

public static final URLTypeCodeType CUSTOM_CODE
Reserved for future use.

Method Detail

values

public static URLTypeCodeType[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (URLTypeCodeType c : URLTypeCodeType.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static URLTypeCodeType valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
java.lang.NullPointerException - if the argument is null

value

public java.lang.String value()

fromValue

public static URLTypeCodeType fromValue(java.lang.String v)

Changes since
the last release

The information contained in this document is proprietary and confidential. Use of this information and the eBay API requires a Non-Disclosure Agreement (NDA) between the user and eBay Inc. For information regarding a qualifying NDA, contact Developer Relations: developer-relations@ebay.com
© 2004-2009 eBay Inc. All rights reserved.