DOCSEARCHbyAlgolia
Submit Docs

Saleor Documentation

website·Indexed 35 days ago

https://docs.saleor.io/

Documentation for Saleor, a composable, extensible, and open-source commerce platform. It includes a comprehensive GraphQL API reference covering apps, users, shipping, taxes, and webhooks, as well as developer guides for app architecture, cloud configuration, setup, and upgrade guides (e.g., upgrading from 3.15 to 3.16).

Tokens
688.9K
Snippets
3K
Records
5.5K
Agent score
70%

What's inside Saleor

  1. Overview of Saleor Search App integration

    The Search App integrates Saleor (version 3.22+) with Algolia. It synchronizes products, categories, and pages to Algolia indices, allowing storefronts to perform searches via the Algolia API. The app handles both initial bulk synchronization and real-time updates via webhooks.

  2. Overview of Instant Checkout with ChatGPT (Beta)

    The Instant Checkout with ChatGPT app exports the Saleor product catalog to the ACP Feed format, allowing compliant platforms like ChatGPT to index and display Saleor products directly within a chat interface. The app is currently in beta and requires Saleor version 3.21 or higher.

  3. Overview of Saleor Transactions

    A transaction in Saleor represents a payment instance associated with an Order or a Checkout. It consists of a sequence of events (defined by TransactionEventTypeEnum) that track the payment process. Transactions store critical payment metadata, including the amount and currency. Transactions attached to a checkout are found via checkout.transactions, and those attached to an order via order.transactions.

  4. Overview of Saleor Apps

    Saleor Apps are technology-agnostic clients used to add new functionalities to Saleor or integrate it with third-party services. They communicate with the Saleor platform via webhooks and APIs. Apps can be installed, managed, and rendered directly within the Saleor Dashboard. For Saleor Cloud users, the Saleor App Store allows for single-click extension additions.

  5. Overview of Gift Cards in Saleor

    Gift cards are digital codes used by customers during checkout to reduce the total order amount. They are currency-based and can be used in any channel that matches the gift card's currency.

    Key Difference from Vouchers: Gift cards are currency-based and usable across channels with the same currency. Vouchers are scoped to specific channels and discount the subtotal, unit price, or shipping.

  6. Overview of Saleor Draft Orders

    Draft Orders allow administrators or systems to create and manage orders on behalf of customers (e.g., phone sales, B2B custom quotes, or item replacements). Once a draft order is 'completed', it transitions into a standard order, triggering inventory allocation, notifications, and the fulfillment pipeline.

  7. Overview of Saleor Plugins

    Plugins allow developers to extend Saleor's Python core by using predefined callbacks that execute custom code in response to specific events. Plugins are executed as a pipeline; each callback receives a previous_value parameter, where the first plugin receives the default value and subsequent plugins receive the return value of the previous one.

    Note: Plugins are being deprecated in favor of Saleor Apps. For new integrations, using apps is recommended.

  8. Overview of the Saleor CMS App

    The CMS App (v2) enables one-direction synchronization of Saleor products from Saleor to supported CMS platforms. It treats the Product Variant as the primary synchronized entity; every item created in the CMS corresponds to a unique product variant.

    Supported Platforms:

    • Contentful
    • Strapi
    • DatoCMS
    • Builder.io
    • Payload

    Key Constraints:

    • Unidirectional: Data only flows from Saleor to the CMS. Changes made in the CMS will not sync back to Saleor.
    • Event-Driven: Synchronization is triggered by the following events: PRODUCT_UPDATED, PRODUCT_VARIANT_CREATED, PRODUCT_VARIANT_UPDATED, and PRODUCT_VARIANT_DELETED.
    • Unique IDs: To prevent duplicate entries, the Variant ID field in the CMS must be configured with a UNIQUE constraint/validation.

  9. Overview of Saleor full-text search capabilities

    Saleor (v3.23+) provides full-text search across key entities, allowing records to be found by matching terms against multiple fields simultaneously. Search is case-insensitive and accent-insensitive (e.g., 'Magnesium' matches 'Magnésium B6').

  10. Overview of Saleor Tax Calculation Methods

    Saleor supports two primary methods for calculating taxes, which can be configured per sales channel and overridden for specific countries:

    • Flat Rates: Simple, static rates manually configured per country. Ideal for stores with straightforward tax requirements or limited operating regions.
    • Dynamic Taxes: Real-time calculations performed by external tax provider apps.

  11. Overview of Saleor Customer Emails app

    The Customer Emails app (available for Saleor version 3.23+) handles the delivery of customer-facing messages by listening for store events and sending them via a configured SMTP server. It is available on Saleor Cloud. For self-hosted instances or versions 3.22 and below, the SMTP app should be used instead. Note that staff-related emails (invites and password resets) are handled by the Admin Emails plugin, not this app. Configuration is managed via Configuration → Customer emails.

  12. Overview of Saleor Payment App workflow

    Payment Apps handle payment processing for specific providers (e.g., Stripe, Adyen). The storefront communicates with Saleor via GraphQL API, and Saleor communicates with the Payment App using synchronous webhooks. Saleor manages transaction statuses and balances based on the app's responses. The checkout process is finalized using the checkoutComplete mutation.