You can use Syncee with a custom-built website, your own application, or an ecommerce platform beyond our existing integrations through the Syncee API.
This allows your developer to connect your store to Syncee, access product data, submit customer orders, and receive updates about products, payments, and shipping.
API access is currently available on request only. You need an active Syncee subscription, and our team must enable the feature for your account before you can get started.
What can I do with the Syncee API?
With a custom integration, you can:
Access product data: Retrieve product titles, descriptions, images, variants, prices, stock levels, and other details for products added to your Syncee catalogs.
Manage catalogs: Create catalogs and add or remove products through the API.
Submit customer orders: Send orders from your website or application to Syncee.
Track order progress: Retrieve payment status, fulfillment details, and shipment tracking information.
Receive updates: Use webhooks to notify your system when products change or are removed, orders are paid, or shipments are fulfilled.
Your developer will need to implement how your website or application uses this data and handles these updates.
What do I need to get started?
You will need:
An active Syncee subscription that includes API access.
API access enabled by the Syncee team.
A developer or technical knowledge to build the integration.
Your subscription’s product and API usage limits apply to your custom integration.
How can I request access?
Email support@syncee.co and let us know that you would like to use the Syncee API.
Please include:
Your store’s website address.
The platform or technology you use.
The email address associated with your Syncee account.
Our team will review your request and help you get access enabled.
Access is not enabled automatically when you subscribe. Please contact us before starting your integration.
How does the setup work?
Once our team has enabled access:
Generate your API token. In your Syncee account, open Settings > Developer for your Custom store (API) and generate a token. Copy it immediately, as it is only displayed once.
Connect your system. Your developer can use the token to authenticate requests and check the connection.
Select and organize products. Find the products you want to sell in Syncee and collect them in your Import List, or manage catalogs and add Syncee product IDs through the API.
Build your product integration. Retrieve the product data and implement how products appear and update in your store.
Set up orders and notifications. Submit customer orders to Syncee and configure webhooks to receive product and order updates.
Some suppliers require approval before you can access their products. Supplier access requests and private catalog activation must be handled on syncee.com.
How are orders paid and fulfilled?
The API lets you submit orders and check their progress. Payments are managed through your Syncee account.
You can pay for orders manually on syncee.com, or enable automatic payment to automate this step without having to pay for each order manually.
For setup instructions, see our guide: https://help.syncee.com/en/articles/18331173-how-to-set-up-automatic-order-payments-on-syncee-com
Once payment is confirmed, the order is forwarded to the supplier for fulfillment. Your integration can then retrieve fulfillment and tracking details through the API.
Where can my developer find the documentation?
The documentation includes setup instructions, authentication, available endpoints, webhooks, usage limits, and troubleshooting:
Keep your API token private and use it only on your server. It should never be included in publicly accessible website code or a mobile application.
If you have questions about access or getting started, contact us at support@syncee.co.