Developer guides

Integration patterns for agents and commerce automation.

FiveX does not currently ship a separate distributable SDK package. These guides help builders combine REST resources, MCP tools and connector-managed channel access without scattering credentials across scripts.

Get started

Open FiveX MCP setup in your AI agent.

Start from the agent you already use. The prompt connects the agent to the FiveX MCP server, asks for your FiveX MCP key at runtime and verifies which FiveX data it can retrieve.

Using another IDE agent such as Cline or Windsurf? Copy this prompt.

Connect this workspace to the FiveX MCP server so I can retrieve my FiveX e-commerce data. MCP server URL: https://fivex.com/mcp/ Before connecting, ask me to paste my FiveX MCP key from https://fivex.com/portal/public/account/mcp. If the setup flow also shows a secret, do not print it, commit it, store it in source code or include it in logs. Treat credentials as private runtime input. Authentication: add the HTTP header "Authorization: Bearer <FIVEX_MCP_KEY>" to every request to the MCP server listed above. Use the key I provide at runtime. Instructions for you as an AI agent: - First check whether you have a command-line tool to add MCP servers, such as "claude mcp add", "codex mcp add", "gemini mcp add" or another MCP client command. - If you have a command-line tool, add the FiveX MCP server using the "http" transport and the server URL above. If the tool supports headers, configure the Authorization bearer header with the key I provide. If it uses OAuth, open the login flow and guide me through it. - If you do not have command-line MCP setup, manually add the server in your MCP or connector settings using the URL above and the header "Authorization: Bearer <FIVEX_MCP_KEY>". - After setup, retrieve the available tools from the FiveX MCP server. - Briefly tell me which FiveX account information, marketplace data, orders, inventory, advertising, product content or analytics you can now retrieve. - Start with read-only requests. Do not make operational changes until I explicitly approve the exact action.

Patterns

Guides backed by the surfaces FiveX ships today.

Use these patterns when a coding agent, backend service or internal tool needs stable access to commerce context.

01

Create a workspace

Create your FiveX account, connect the channels that matter and choose REST, FiveX MCP or connector-managed workflows.

02

Browse connectors

Keep authentication, retries, channel changes and data models in one connector layer.

03

Connect FiveX MCP

Give MCP-compatible AI agents controlled access to supported marketplace, advertising and ecommerce context.

04

Use the REST API

Build application workflows around KPIs, alerts, analytics, warehouse datasets and security governance.

Workflow

A practical automation pattern

Combine connectors, MCP and REST without treating FiveX as a published SDK package.

  1. 1

    Create your workspace and connect the channels required for the workflow.

  2. 2

    Use connectors for authentication and channel coverage.

  3. 3

    Use FiveX MCP for AI-agent access or the REST API for application integrations.

  4. 4

    Keep credentials private and require approval before operational write actions.

Docs

Turn scripts into governed workflows.

Use FiveX as the permissioned layer between your code, AI agents and commerce channels.

Turn scripts into governed workflows.

Use FiveX as the permissioned layer between your code, AI agents and commerce channels.