Getting Started

Environments & Base URLs

Staging and production hosts, auth headers, and base routes.

For e-commerce stores that integrate with Sendy to sync orders, catalog, inventory, and real-time chat.

Environments

Environment	API Base URL
Production	`https://api.sendyiq.com`
Staging	`https://stagging-api.sendyiq.com`

Authentication

All integration endpoints require an API key issued from the Sendy dashboard.

X-API-Key: <keyId>.<secret>
Content-Type: application/json   (required for request bodies)

Base Route

/api/v1/store/integrations/*

Available Scopes

Scope	Access
`orders:read`	Read orders
`orders:write`	Create / update / cancel orders
`catalog:read`	Read products and inventory
`catalog:write`	Push catalog and stock updates
`messaging:read`	Read chat conversations
`messaging:write`	Send messages, create conversations

Key Endpoints

Method	Path	Scope	Notes
`GET`	`/api/v1/store/integrations/orders`	`orders:read`	List orders
`POST`	`/api/v1/store/integrations/orders`	`orders:write`	Create single order
`POST`	`/api/v1/store/integrations/orders/bulk`	`orders:write`	Create multiple orders
`PUT`	`/api/v1/store/integrations/orders/{id}`	`orders:write`	Update order
`DELETE`	`/api/v1/store/integrations/orders/{id}`	`orders:write`	Cancel order
`POST`	`/api/v1/store/integrations/orders/send-otp`	`orders:write`	Send OTP to customer phone
`POST`	`/api/v1/store/integrations/orders/storefront`	`orders:write`	OTP-verified storefront order
`GET`	`/api/v1/store/integrations/catalog`	`catalog:read`	Read catalog / products
`POST`	`/api/v1/store/integrations/catalog`	`catalog:write`	Push catalog update
`GET`	`/api/v1/store/integrations/chat/conversations`	`messaging:read`	List chat conversations
`POST`	`/api/v1/store/integrations/chat/hub-token`	`messaging:read`	Exchange API key for a short-lived WebSocket token

Real-time (WebSocket / SignalR)

Connect to the chat hub using the short-lived token returned by POST /chat/hub-token. The raw API key must never appear in a URL or WebSocket frame.

Environment	WebSocket URL
Production	`wss://api.sendyiq.com/hubs/store-conversations`
Staging	`wss://stagging-api.sendyiq.com/hubs/store-conversations`

After connecting, call JoinStore(token) to subscribe to the store's conversation stream.

Contract Notes

payment_method is required on every order create request — omitting it returns 400.
Address linkage is required on create / bulk order flows:
- addressProvinceCode — from GET /api/v1/public/provinces
- addressAreaId — from GET /api/v1/public/provinces/{code}/areas
fulfillmentType must be from_to or warehouse.
Duplicate SKUs in items on the same order are rejected with 400.

MCP / AI Agent

Sendy exposes a Streamable-HTTP MCP server for AI-agent integrations. Auth is OAuth 2.0 PKCE bearer (not API key).

Environment	MCP Endpoint
Production	`https://api.sendyiq.com/api/v1/store/mcp`
Staging	`https://stagging-api.sendyiq.com/api/v1/store/mcp`

Full setup guide: ../03-integrations/store-mcp-server.md

Detailed Specs

Overview & auth: ../03-integrations/store-api-key.md
Endpoint tables: ../03-integrations/specs/store/endpoints.md
Auth & scopes matrix: ../03-integrations/specs/store/auth-and-scopes.md
Integration flows: ../03-integrations/specs/store/flow.md
OpenAPI definition: ../03-integrations/specs/store/api-design.json

PreviousGetting Started Next Store Frontend (JWT)

Source: DOCS/07-external-connectors/store.md