Create a Shopee App on Shopee Open Platform Console

This guide shows you how to create a Shopee App on Shopee Open Platform Console: register a Shopee Developer Account, create the app and prepare the credentials to connect your Shopee store to HexaSync Automation Engine. After you create the Shopee Connector on HexaSync, you can use this connection for integration purposes such as ERP, Customer Service or Accounting, depending on what your business needs.

Already have a Shopee Developer Account? If the account is approved and can create an App, you can skip Part 1 and start from Part 2.

Before you start

• A Shopee store and an account that fits the type of Shopee Developer Account you register.
• A Shopee Seller Center account that can manage the store.
• An email address, your business details and your business registration certificate.
• The intended purpose of the integration, so you can choose the right App Category.

Part 1: Register a Shopee Developer Account

Step 1: Create an account

1. Go to Shopee Open Platform.
2. Select Log In, then select Sign up.
3. Fill in the registration details as requested.
4. Complete the email verification and set up the account.

Step 2: Choose the Developer Account type

• If you are a seller who builds your own integration system, or you hire a third party to connect Shopee to your internal systems, choose Shopee Seller if you meet the registration requirements.

Important: You cannot change the Developer Account type after you Submit the application. Check your choice carefully before you send it.

Step 3: Submit the registration

1. Provide the seller and business details.
2. Complete the Shopee Seller account verification.
3. Provide the business registration certificate.
4. Submit the application and follow its review status.

Note: The Developer Account review takes about 3 to 7 business days.

Part 2: Create and configure a Shopee App on Shopee Open Platform Console

Step 1: Open the app list

1. Go to Shopee Open Platform Console.
2. Open App Management.
3. Select App List.
4. Select Add New App.

Step 2: Enter the Shopee App details

1. Fill in the details as shown in the table below.

2. Check the details, then select Submit.

Note about API Permissions: The App Category affects which API modules are granted. Decide what your integration needs before you create the App. Additional permissions beyond the current scope need approval from Shopee.

Step 3: Configure the Test Redirect URL Domain

1. Open the Shopee App you just created and select Edit.
2. Scroll to the Authorization Information section on the edit page.
3. Find the Test Redirect URL Domain field.
4. Enter exactly the address below and save the configuration.

https://app.hexasync.com/

Important: Keep the / at the end of the URL. You can edit the App while it is under review, but editing may affect the review time.

Step 4: Prepare the Sandbox credentials

• After you create the App, you have a Test Partner ID, Test Partner Key and Test Push Partner Key.
• While you wait for the App to be reviewed, you can test in the Sandbox environment to see whether the App details need any changes.

Note: Do not use the Test credentials for Production.

Step 5: Run Go-Live

1. Open the Shopee App on the Console and select Go-Live.
2. Follow the processing status from Shopee.

Note: As a reference, the Shopee App review takes about 2 to 5 business days.

Step 6: Check the Online status

• When the Shopee App has the Online status, the app is ready to use in the Production environment.

Step 7: Configure the Live Redirect URL Domain

1. Open the Shopee App and select Edit.
2. Scroll to the Authorization Information section.
3. Find the Live Redirect URL Domain field.
4. Enter exactly the address below and save the configuration.

https://app.hexasync.com/

Note: The Test Redirect URL Domain and the Live Redirect URL Domain both use exactly this address, including the / at the end.

Part 3: Prepare the HexaSync connection details

Step 1: Identify the connection environment

Note: Sandbox is for testing only. Production requires the Shopee App to have the Online status (Step 6 in Part 2).

Step 2: Get the Partner ID and Partner Key

1. Open App Management and select App List.
2. Open the Shopee App you want to connect.
3. Copy the Partner ID and Partner Key for the environment you chose.

Step 3: Get the Push Partner Key

1. Open App Management.
2. Select Push Mechanism, then select Set Push.
3. Get the Push Partner Key of the environment you want to connect.

Note:

• The Push Partner Key is required when you set up the Shopee Connector on HexaSync.
• Sandbox uses the Test Push Partner Key, and Production uses the Live Push Partner Key.
• Do not share the Partner Key or Push Partner Key publicly.

Part 4: Check the details before you move to HexaSync

• The Shopee App is created and has the Online status if you use Production.
• You have the Partner ID and Partner Key for the connection environment.
• You have the Push Partner Key for the connection environment.
• You configured the matching Redirect URL Domain (Test or Live).
• The App has the API permissions that fit your integration needs.

After you complete the preparation steps above, continue with Get started with Shopee on HexaSync.

Part 5: Frequently asked questions

If I already have a Shopee Developer Account, do I need to register again?

No, if the account is approved and can create a Shopee App. You can start from Part 2.

Which App Category should I choose?

Choose by the purpose of your integration, such as ERP, Customer Service or Accounting. The App Category affects which API modules are granted.

Can I use Sandbox before the App is Online?

Yes. After you create the App, you can test on Sandbox with the Test credentials. Production requires the Shopee App to have the Online status.

What if I need more API permissions?

Additional permissions beyond the current scope need approval from Shopee.

Can I use the Test Partner Key for Production?

No. Each environment must use its own connection details. See the table in Part 3, Step 1.