Getting Started
Lists REST Implementations starter guide.
Introduction
Swym REST APIs can be utilized to implement anonymous or guest sessions, as well as authenticated lists, in native or headless implementations. These endpoints can be integrated into mobile apps, embedded devices, third-party software, and more to provide functionalities of the Swym platform.
We also integrate natively with many headless ecommerce platforms, such as Tapcart and Plobal apps, which you may leverage without much friction.
Preconditions
- Swym apps installed on your store's, Shopify's, or BigCommerce's backend.
- Inventory, product updates, and other hooks are managed by the e-commerce provider ("Shopify" or Bigcommerce).
The REST Lists API is available only on our Premium plans or above. Check out our Pricing & Plans page for more information.
Setup pre-requisites
| Key | Comments |
|---|---|
{{Swym API endpoint}} | {{Swym API Endpoint}}/storeadmin/v3/user/generate-regid |
PID | unique token for the merchant or your username for making the API calls. |
Swym API Key | API key to access Swym storefront APIs available dashboard or your password for making the API calls. |
You can navigate to Swym Admin Settings page and check with your API credentials such as API {{Swym API endpoint}} and PID.
You need to contact support by reaching out to us at [email protected] to generate your unique API key per store.
Tools Required to Setup and Test.
- Understanding of GET and POST requests.
- Curl or Postman to test the APIs.
- knowledge of Headless development.
Updated over 1 year ago