General FAQ

FAQ Categories

API Invocation

Q: What is the recommended approach for implementing pagination in API calls?

Problem Description:

In some APIs, we support both cursor-based (token) and page-based pagination (page). However, developers sometimes face challenges in fetching metadata efficiently.

Cause:

Page-based pagination is simpler but less efficient for large datasets. Cursor-based pagination (token) offers better performance and accuracy when fetching paginated data, as it directly links to the next dataset batch.

Solution:

• Recommendation: Use cursor-based pagination (token) for API calls. Use page-based pagination only when token-based pagination is unavailable.
• How to Use: Refer to the Cursor Pagination Documentation for implementation details.

Q: What should I do if images are not displaying properly?

Problem Description:

Images are not displaying in certain parts of the site.

Cause:

The issue may occur if the images are not properly configured in the theme settings.

Solution:

1. Navigate to Theme Editor → Global Settings → Media Design.
2. Add or configure the required images as per the settings.

Q: Why does the API allow creating a product even when required fields are passed as empty values?

Problem Description:

Some customers have observed that creating a product succeeds even when required fields are passed as empty. This occurs because some APIs handle default values internally.

Cause:

Certain APIs may have default values for required fields. If a required field is passed as empty, the API initializes it with a predefined default value instead of returning an error.

Solution:

• Check Parameter Requirements: Before making an API call, carefully review the required parameters and their expected values in the API documentation.
• Contact Us for Clarifications: If the behavior of required fields seems unclear or inappropriate for your use case, please contact our support team for further assistance.

Q: How can we ensure a seamless shopping experience for Chinese consumers on our e-commerce website hosted in the US?

Problem Description:

Hosting the server in the US may lead to:

• Accessibility Issues: Restrictions caused by the Great Firewall, making it difficult for Chinese users to access the website.
• Performance Problems: Higher latency and slower loading times due to geographic distance.

Solution:

• Server Migration: Relocate the server to Mainland China to minimize latency and improve accessibility.
• CDN Optimization: Implement a Content Delivery Network optimized for China to enhance website loading speed.

Note on Costs:

These are custom services and will incur additional charges. Please contact support for details on pricing and implementation options.

Authorization

Q: The API request returns a 403 error, indicating a lack of permissions.

Problem Description:

The API request fails with a 403 error due to insufficient permissions for the private app.

Cause:

This issue occurs because the required permissions for the private app have not been granted in the store’s settings.

Solution:

1. Verify Permissions: Ensure that the necessary permissions are configured for the private app:

   • Go to the Store Admin’s Index Page.
   • Navigate to Manage Private App.
   • Update the permission settings for the private app as needed.

2. Current Limitations:

   • Currently, we do not support write shop permissions for private apps.
   • This permission will be enabled in a future update.

App Management

Q: How can I improve my app's rating?

User Interface Optimization:

• Ensure buttons, navigation bars, and forms are user-friendly and functional.
• Provide clear setup instructions and interactive features.
• Add real-time feedback for user actions.

Performance Optimization (Lighthouse Score):

• Focus on metrics like FCP, LCP, and TTI.
• Optimize large files, use lazy loading for images, and improve server response times.

App Usability:

• Ensure your app is bug-free and responsive across devices.

Q: Common Questions about Vulnerability Scans

Q1: When do vulnerability scans usually start?

A: Vulnerability scans are typically initiated after significant system changes or during routine security audits.

Q2: Do single scans provide a report and remediation recommendations?

A: Yes, each scan provides a detailed report and recommended fixes for identified issues.

Q3: How should I handle vulnerabilities I believe are false positives?

A: Low-risk vulnerabilities can be ignored if they don’t impact service. For medium or high-risk items, submit a reevaluation request with evidence.

Q4: How do vulnerability scans work, and are additional resources needed?

A: Scans use automated tools to test for known issues. No extra resources are typically required.

Q5: How should I verify vulnerabilities have been resolved?

A: Re-run the scan after applying fixes to confirm resolution.

Q6: What should I do if creating or restarting a scan task fails?

A: Verify that all required parameters are correct. If issues persist, contact support.

Q7: How long does it take to generate a scan report?

A: The time varies depending on the scan's complexity. Contact support for delays.

Q: Will developers be able to switch stores under their account?

Current Status:

This feature is not currently available.

Future Plans:

Switching between stores under the same account is planned for a future update.

Account Management

Q: How can developers delete their developer account?

Current Status:

At present, we do not offer a feature to delete developer accounts.

Solution:

If you need to delete your developer account, please contact our support team for assistance.

Future Plans:

We are evaluating the feasibility of developing a developer account deletion feature in the future.

Q: Will developers be able to switch stores under their account?

Current Status:

This feature is not currently available.

Future Plans:

The ability for developers to switch between stores under the same account is planned for a future update. Stay tuned for announcements regarding its release.

Webhook

Q: How does Shoplazza handle failed webhook delivery attempts?

Problem Description:

When a webhook delivery fails (i.e., your endpoint responds with a non-2xx HTTP status code), Shoplazza retries delivery multiple times over two days using an exponential backoff strategy.

Solution:

1. Retry Mechanism: Shoplazza attempts to deliver the webhook up to 19 times over two days.
2. Webhook Deletion: If all attempts fail, the webhook is deleted, and you will need to recreate it.

Q: What should I do if webhook events are not received?

Problem Description:

Webhook events may fail to reach your server due to IP restrictions or misconfigured endpoints.

Solution:

1. Whitelist Shoplazza IPs: Allow requests from Shoplazza’s external IPs (e.g., 34.210.253.121).
2. Verify Endpoint Configuration: Ensure your endpoint is set up correctly to handle POST requests.
3. Monitor Logs: Check server logs for errors or blocked requests.

Q: If a merchant uninstalls and reinstalls the WhatsApp & Chat Buttons app within the same billing cycle, do they need to pay again?

Current Behavior:

Yes, merchants will need to pay again because the subscription ends upon uninstallation.

Recommendation:

Consider the impact of uninstalling apps during an active billing cycle. Contact support if this policy raises concerns.

APP Store

Q: If a merchant uninstalls and reinstalls the WhatsApp & Chat Buttons app within the same billing cycle, do they need to pay again?

Current Behavior:

Yes, merchants will need to pay again. When the app is uninstalled, the subscription is terminated, and a new subscription must be initiated upon reinstallation.

Reason:

The subscription relationship ends upon app uninstallation. Therefore, reinstalling the app requires creating a new subscription, even if it occurs within the same billing cycle.

Recommendation:

Merchants should consider the impact of uninstalling apps during an active billing cycle, as reinstallation will trigger a new payment. If this policy raises concerns, feel free to contact support for clarification.

Q: How can we ensure a seamless shopping experience for Chinese consumers on our e-commerce website hosted in the US?

Problem Description:

Hosting the server in the US may lead to:

• Accessibility Issues: Restrictions caused by the Great Firewall, making it difficult for Chinese users to access the website.
• Performance Problems: Higher latency and slower loading times due to geographic distance.

Solution:

• Server Migration: Relocate the server to Mainland China to minimize latency and improve accessibility.
• CDN Optimization: Implement a Content Delivery Network optimized for China to enhance website loading speed.

Note on Costs:

These are custom services and will incur additional charges. Please contact support for details on pricing and implementation options.