eBay Trading APIVersion 1055

URLTypeCodeType ( token )

This enumerated type consists of the different eBay URLs that can be returned under the URLDetails containers of a GeteBayDetails response.

Type that uses URLTypeCodeType:

Call that uses one or more values of URLTypeCodeType:

Enumeration Values

Value Description
AppealProductUrl 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.
CreateProductUrl 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.
CustomCode Reserved for future use.
eBayStoreURL 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.
LargeLogoURL This value indicates that the URL in the corresponding URL field is the full URL to the large version of the eBay Marketplace logo.
ManageProductUrl 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 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/status/1234567?id_token=Oauth_token, where '1234567' 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. As of April 2018, 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 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.
MediumLogoURL This value indicates that the URL in the corresponding URL field is the full URL to the medium version of the eBay Marketplace logo.
MyeBayBiddingURL This value indicates that the URL in the corresponding URL field is the URL for the user's My eBay Bids/Offer page.
MyeBayNotWonURL 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.
MyeBayURL This value indicates that the URL in the corresponding URL field is the URL for the My eBay home page.
MyeBayWatchingURL This value indicates that the URL in the corresponding URL field is the URL to the user's My eBay Watch List page.
MyeBayWonURL 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.
SmallLogoURL This value indicates that the URL in the corresponding URL field is the full URL to the small version of the eBay Marketplace logo.
ViewItemURL 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.
ViewUserURL 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.
  * See the Enumeration Index to see exact use of each enumeration value in the API.