Traide Documentation

website·Indexed 30 days ago

https://guide.thetraide.com/

Developer and user guides for the Traide marketplace platform. Includes documentation on the GraphQL API, webhook integration (supporting HTTP(S), Google Cloud Pub/Sub, and AWS SQS), payment flows via Stripe, tax engine integrations with Avalara AvaTax and Stripe Tax, and SendGrid email template management.

Tokens
510.3K
Snippets
2.1K
Records
6K
Agent score
52%

What's inside Traide

  1. Overview of Custom Fields in Marketplace Entities

    Custom fields allow you to add extra structured data to specific marketplace objects. Data validation is based on the input type assigned to the attribute. Custom fields can be applied to the following objects:

    • User (includes Customers and StaffMembers)
    • Product
    • Variant
    • Category
    • Collection

    Custom fields can be managed via repeatable templates (which apply to every instance of an object model) or by directly assigning attributes to individual instances (if the marketplace configuration allows).

  2. Overview of Shopify and Traide data synchronization

    The Shopify integration allows for the following data flows and management capabilities:

    • Product Listing: Import Shopify products directly into the marketplace.
    • Pricing: Optional price synchronization to keep Shopify and Traide prices aligned, or maintain separate pricing strategies.
    • Inventory: Shopify acts as the source of truth for inventory and product information.
    • Order Management: Sellers can use Shopify as their primary Order Management System (OMS). Order cancellations and fulfillments in Shopify are synchronized back to Traide.
    • Taxonomy: Product templates and attributes are created automatically from Shopify data, which may not be standardized across different sellers.
  3. Overview of AI agent integration for Traide storefronts

    AI shopping agents discover and purchase from Traide marketplaces via endpoints hosted by Traide. While Traide manages the UCP business profile, checkout/order endpoints, and sitemaps, the merchant is responsible for the storefront's product pages, structured data, and robots.txt. The tenant agent host follows the pattern https://<your-slug>.agents.thetraide.com.
  4. Overview of Traide Custom Fields

    Custom fields in Traide allow marketplace operators to capture validated data beyond the standard fields and product attributes available in an instance. Unlike metadata, custom fields enforce data entry based on the attribute's specific input type. Custom fields can be applied to the following objects: Products, Variants, Categories, Collections, and Users (including both staff members and customers).
  5. Overview of Draft Orders

    Draft orders allow marketplace operators to create orders on the backend without requiring the buyer to perform a checkout on the storefront. This is useful for phone orders or custom quotes. Key characteristics include:

    • Ability to override shipping costs and product prices.
    • Potential to update inventory levels (marking products as allocated) based on marketplace stock allocation settings.
    • Requirement for a registered customer account (guest checkout is not supported for draft orders).
  6. Overview of marketplace refund capabilities

    Marketplace operators can issue partial or full refunds to a buyer's original payment method. Refunds can be scoped to the entire marketplace order, specific seller orders, or individual line items.

    Key constraints:

    • Permissions: Staff must have the Manage refunds permission assigned to their permission group.
    • Payment Methods: All refunds for a single order must use the same payment method.
    • Consistency: Once a refund method (Order line or Manual) is used for an order, subsequent refunds for that same order must use the same method; mixing methods is not allowed.
    • Currency: Refunded amounts are returned in the original transaction currency.
  7. Overview of Traide Marketplace Platform capabilities

    Traide is an end-to-end marketplace platform designed to simplify the launch and management of marketplaces. It provides a comprehensive suite of integrated systems, including an e-commerce platform, vendor management, order management, inventory and warehouse management, product information management (PIM), and marketing/analytics tools. The platform is manageable via an intuitive administration dashboard and an API for custom connections and integrations.
  8. Overview of Stripe Tax integration in Traide

    Stripe Tax is a tax engine integrated into Traide that automatically calculates tax rates at checkout and records tax transactions against orders. It specifically handles the complexity of marketplace taxes where a single basket may contain multiple sellers with different tax footings. Key capabilities include:

    • Checkout: Live rate calculations for line totals, basket subtotals, and order totals.
    • Per-seller shipping tax: Apportions marketplace-level and seller-level shipping across sellers and taxes them based on each seller's specific footing.
    • Order Transactions: Records real Stripe tax transactions for accurate reporting.
    • Refunds and Declined Fulfillments: Automatically reverses corresponding taxes when a line is refunded or a fulfillment is declined.
  9. Overview of Staff Member Management in Traide

    The Traide dashboard allows marketplace administrators to invite and manage an unlimited number of staff members to help operate the marketplace. Additionally, sellers within the marketplace have the ability to invite their own staff members to manage daily activities associated with their specific seller accounts.
  10. Overview of the Traide Stripe payment flow

    The standard Stripe payment process in Traide follows these sequential steps:

    1. Initiate Payment: Traide requests a Stripe payment intent for the order total using the getClientSecret query.
    2. Generate Form: The returned payment intent secret key is used to render the secure Stripe payment form on the client side.
    3. Capture Method: The buyer enters payment details (e.g., credit card) and confirms the transaction.
    4. Finalize Order: Once confirmed on the client, the backend sequence is:
      • Stripe attaches the payment method to the payment intent.
      • Traide creates a payment record using the checkoutPaymentCreate mutation and the payment intent token.
      • Traide completes the checkout and creates the order using the checkoutComplete mutation.
    5. Processing: The payment is authorized or captured based on the configured Stripe payment capture mode.
  11. Overview of Shipping Rate Types

    Shipping rates define the costs to ship orders from a specific shipping zone based on order size. There are two primary calculation methods:

    1. Price-based: Calculates costs based on product prices. The total used (seller order total vs. marketplace order total) depends on the 'Shipping options calculated by' setting in the fulfillment model.
    2. Weight-based: Calculates costs based on the total weight of the products in the order.
  12. Overview of the Traide Headless Storefront

    The headless storefront is a modular web template designed for multi-vendor e-commerce platforms. Built with Next.js and React, it is pre-integrated with Traide's API to handle core commerce functions including product browsing, account management, and checkout. It serves as a customizable starting point that developers can tailor to specific brand identities and business workflows.