SYSSwitchToEShop

Syntax

typedef struct SysEShopArgsIn
{
    SysStandardArgsIn   stdIn;

    const char *        cp_Query;
    u32                 querySize;
} SysEShopArgsIn;

s32     SYSSwitchToEShop( const SysEShopArgsIn * cp_Args );

Parameters

cp_Args Set a string that follows the query format to cp_Query.

Return Values

0 Successfully jumped to Nintendo eShop.
Nonzero Nonzero values require error-handling as an unrecoverable error.

Description

Launches Nintendo eShop and displays the specified page. After this function is called, the current process moves to the background.

To use this feature in development environments, Wii U Menu Changer must be installed.

It is necessary to set the application TIN correctly with the Application Configuration Tool. Apply on OMAS to have a TIN issued.

Specify a string that follows the query format below for the page to be displayed. However, to jump to the details page for the title that was launched, specify NULL for cp_Query and 0 for querySize.

IMPORTANT:
You may not jump to a Nintendo eShop page for a different application by default. If you require this option, contact your local Nintendo Developer Support Group and provide the name of your title and the titles that you want to jump to, so that we may configure the servers appropriately.

Query Format

When specifying the jump destination page, set a string that follows the query format to cp_Query. cp_Query can take a maximum of 900 characters.

The specified string must be in the URL query format. This format is given below.

NOTE:
Punctuation marks such as {, }, [, ], and | in the query text are not included in the actual query.
version={VERSION}&scene={SCENE}[SCENE_OPTIONS]&src_title_id={SRC_TITLE_ID}

If the query is invalid, such as when the specified title has not been registered in Nintendo eShop, the Nintendo eShop top page is shown automatically. An error or other notification is not given to either the user or the calling application when this happens.

VERSION Specify the version contained in the reference. If this version is used as the reference, specify 1.1.1. You do not need to specify a version if it is different for each page. In addition, none of the features require a particular version to work.
SCENE Specifies the type of page to display when Nintendo eShop starts. The following types of pages are currently available.
  • top
    The top page of Nintendo eShop.
  • detail
    The details page for the software.
  • aocs
    The add-on content list page.
  • aoc
    The details page for add-on content.
  • tickets
    The subscription and consumable service ticket list page.
  • redeem
    The ticket redemption page.
SCENE_OPTIONS The values to set depend on the value of SCENE. Check the settings for each page type described later.
Note:
Not necessary if the SCENE value is top
SRC_TITLE_ID Specifies the title ID of the application from which Nintendo eShop launches. Do not pass a value such as 0x for the title ID, and use uppercase for alphabetic letters.

When Displaying the Details Page of a Different Title

Set SCENE to detail. Set SCENE_OPTIONS to either of the following values.

Example: Query string for launching Nintendo eShop from an application (0x000500001ABCDE00) and displaying the software details page for another application (0x0005000015678900).

version=1.1.1&scene=detail&dst_title_id=0f005000015678900&src_title_id=000500001ABCDE00

When Displaying the Add-On Content List Page

Set SCENE to aocs. Set SCENE_OPTIONS to the following values.

Example: Query string for launching Nintendo eShop from an application (0x000500001FFFFF00) and displaying the list of add-on content for an application, filtered on "あああ" with the newest displayed first.

version=1.1.1&scene=aocs&search_word=%E3%81%82%E3%81%82%E3%81%82&sort=new&dst_title_id=000500001FFFFF00&src_title_id=000500001FFFFF00

When Displaying the Details Page for Add-On Content

Set SCENE to aoc. Set SCENE_OPTIONS to the following values.

Example: Query string for launching Nintendo eShop from an application (0x000500001FFFFF00) and displaying the details page for an add-on content item (WUPMABCD00000003).

version=1.1.1&scene=aoc&dst_title_id=000500001FFFFF00&dst_item_code=WUPMABCD00000003

When Displaying the Subscription and Consumable Service Ticket List Page

Set SCENE to tickets. Set SCENE_OPTIONS to the following values.

Example: Query string for launching Nintendo eShop from an application (0x000500001FFFFF00) and displaying a list of subscription and consumable service tickets.

version=1.1.1&scene=tickets&dst_title_id=000500001FFFFF00&src_title_id=000500001FFFFF00

When Transitioning to the Redemption Sequence

Set SCENE to redeem. Set SCENE_OPTIONS to the following values.

Example: Query string for navigating to Nintendo eShop from an application (0x000500001ABCDE00) and displaying the redeem page prepopulated with a software download code (A02XDNF938QRMR38).

version=1.1.1&scene=redeem&card_number=A02XDNF938QRMR38&src_title_id=000500001ABCDE00

Do Not Call From

Background Do not call this function from the background.
Multiple threads This function is not thread-safe.

Revision History

2014-01-14 Noted that prior notice and server configuration are required when you want to jump to a different application. Added description of version to specify. Changed version to 1.1.1. Removed note indicating that the card number must be obtained before jumping to the redeem page. Changed description of setting the card number when navigating to the redeem sequence. Added note on jumping to the details page for add-on content.
2013-07-29 Changed version to 1.0.2.
2013-03-14 Added page types.
2013-03-01 Initial version.


CONFIDENTIAL