DOCSEARCHbyAlgolia
Submit Docs

ShopSynch API Documentation

website·Indexed 30 days ago

https://docs.shopsynch.com

API reference for managing e-commerce operations, including product SKUs, variant groups, inventory tracking, warehouse management, order processing, payment verification, promotional codes, and media uploads.

Tokens
40.9K
Snippets
215
Records
275
Agent score
50%

What's inside ShopSynch

  1. Overview of ShopSynch MCP Connector

    ShopSynch provides a public Model Context Protocol (MCP) server that allows AI assistants, agent builders, and developer tools to securely interact with a merchant's store. This connection enables AI tools to perform tasks such as retrieving store insights, managing product workflows, providing order support, checking inventory, and generating operational reports based on the user's permissions.

  2. Overview of ShopSynch API capabilities

    ShopSynch is a RESTful API designed to provide a scalable e-commerce backend. It eliminates the need for custom backend setup by providing built-in functionality for:

    • Cart & Checkout: Secure cart management and checkout flows.
    • User Authentication: Secure access using JWT-based authentication.
    • Order Management: Tracking customer orders and fulfillment.
    • Promotions: Support for promo codes and discounts.
    • Payment Integration: Integration with gateways such as Stripe and Paystack.
    • Multi-tenancy: A merchant-based system where each business operates in an isolated environment for security and performance.
    • User Types: Support for both authenticated users and guest checkouts with session tracking.

  3. Overview of the Product Review API

    The Product Review API allows developers to manage product reviews by providing endpoints to add, fetch, hide, and delete reviews for products. The API is designed to maintain data consistency and requires user authentication for its operations.

  4. Overview of Media Management API capabilities

    The Media Management API provides endpoints to upload and manage images for products, categories, and other platform features. It supports both single image uploads and batch uploads (multiple images in one request) using standard multipart/form-data encoding. All uploaded media is securely stored and associated with the merchant account.

  5. Overview of Product Categorization via Category API

    The Category API allows developers to categorize products within the system. Users can either select from a set of pre-defined system categories or create custom merchant categories using the available API endpoints.

  6. Overview of Promo Ads functionality

    Promo ads allow store owners or administrators to insert advertisements across their website, including the homepage hero section or any other specific page. This feature is designed to increase user engagement by placing promotions in high-visibility areas of the storefront.

  7. Overview of the Addresses API

    The Addresses API allows for the management of saved addresses associated with a user. These addresses are utilized for order deliveries, billing, and other location-based functionalities. The API supports the following operations: creating new addresses, updating existing ones, deleting addresses, and designating a specific address as the default.

  8. Overview of ShopSynch OAuth for Connected Apps

    OAuth for Connected Apps allows third-party applications, AI agents, and MCP clients to connect to a merchant's ShopSynch store without requiring the merchant's API key or password. The flow requires merchant approval and uses PKCE (Proof Key for Code Exchange) for security since ShopSynch does not issue client secrets.

  9. Overview of the Order API

    The Order API provides a set of endpoints designed for managing orders placed by customers. This includes capabilities to retrieve general order lists, filter orders by authenticated customers, and access specific order items and detailed order data.

  10. Understand Inventory tracking in Product V2

    The Inventory system serves as the single source of truth for stock availability in Product V2. Inventory is required for all Product V2 workflows. When a V2 product is created, the system automatically generates inventory records in the default warehouse, eliminating the need for manual API calls during standard product creation.

    Inventory mapping depends on the product type:

    • SIMPLE / DIGITAL products: One inventory record per warehouse, linked at the product level.
    • VARIABLE products: One inventory record per SKU per warehouse.
    • BUNDLE products: No inventory records are created; stock is tracked at the component level.

  11. Choose between Products API V1 and V2

    The Products API is available in two versions. The V2 API is the recommended version for all new integrations as it offers a more flexible architecture. The V1 API is currently in maintenance mode and is considered legacy.

  12. Manage delivery zones and fees with the Delivery Zone API

    The Delivery Zone API provides endpoints to manage delivery zones, fees, and estimated delivery times for different geographical areas, such as states and local areas. This ensures customers are charged the correct delivery fee based on their specific location.