Skip to content

Build with Etchify.

AI Integration and direct REST API on every plan, trial included. OpenAPI spec, MCP endpoint, 36 tools: 15 read, 21 write. Real-time order push via Shopify's native orders/create webhook.

Endpoints

All endpoints are scoped to a single shop via the API key.

OpenAPI specification

Import this URL into ChatGPT Custom GPT Actions or generate a typed client.

https://api.etchify.app/api/openapi.json
Open →

MCP endpoint

Use this URL for Claude.ai custom connectors and Claude Desktop / Claude Code mcpServers config.

https://api.etchify.app/mcp

Authentication

Every request needs a header.

X-API-Key: sk_etch_...
  • ✓Rotate or revoke any time from Settings → AI Integration in your Etchify Admin.
  • ✓Each key is scoped to one shop. Keys never leave your Shopify Admin until you copy them — they're shown only once at generation.

Rate limits

Starter60 req/minPlenty for human-driven AI conversations
Pro60 req/minPlenty for human-driven AI conversations
Business600 req/minBuilt for scripted bulk operations
14-Day Trial600 req/minBusiness-equivalent during trial

Error codes

Standard HTTP. Body is always JSON: { error, message, request_id }.

401Missing or malformed X-API-Key header
403API key valid but not authorized for this endpoint
404Resource not found in this shop
409Conflict — resource already exists (POST mutations only)
429Rate limit exceeded — see Retry-After header
500Server error — request_id is logged, email help@etchify.app

MCP / REST tool inventory

36 tools: 15 read, 21 write. The table lists the 15 read tools. Same tools whether you call them via OpenAPI, MCP-HTTP, MCP-stdio or REST direct.

ToolPurpose
list-productsList all configured products in your shop
get-product-configDetailed config for one product (materials, modes, dimensions)
browse-templatesFilter templates by product, category or shape
list-materialsLibrary of all materials configured for the shop
list-shapesLibrary of all custom shapes
list-all-templatesFlat list of every template across all products
health-checkService health and uptime status
get-api-specReturns the OpenAPI spec inline
get-setup-guideWalkthrough of remaining setup steps
diagnose-setupDetects misconfigurations across products, materials, shapes
shop-infoShop name, plan, install date, locale, currency
list-ordersThe shop's orders, newest first — status, product, design preview, production file ready
get-orderOne order in detail
get-shop-statsUsage numbers of your customers
show-imageShows a design or product image in the chat

Try these prompts

Ask your ChatGPT or Claude bridge for Etchify data — copy a line, paste it into your AI frontend, done. 36 tools: 15 read, 21 write live under the hood.

Analytics & insights

Read tools
Which materials sell best this month?
Which template do customers convert with most often?
What is my Etchify revenue share this quarter?
On which material do most customers design?

Inspect the library

Read tools
List every material in the wood category.
Which products use the shape 'Coaster Round'?
What are the production settings for material 'Oak 6mm'?
Which templates have not been used in the last 30 days?

Setup & debugging

Diagnose + write tools
My customer can't add the design to cart — what could be going wrong?
Walk me through enabling PDF/X-1a export for my print shop.
Switch this product's production method to printing.
Spot misconfigured API keys in my setup.

Requires AI Integration enabled. Your AI changes the setup directly — products already on sale wait for your approval.

Integration Cookbook

Three recipes for owners who wire Etchify into their own workflows — bulk-fetch via curl, real-time push via Shopify's native orders/create webhook, n8n HTTP node config. Every snippet runs against the REST API (every plan).

Bulk-fetch designed orders (curl)

Pull all designed orders for a date range into your ERP. Drops table imports and CSV workflows without extra tooling.

# Fetch designed orders since yesterday
curl -X GET 'https://api.etchify.app/api/v1/orders?since=2026-05-03T00:00:00Z&status=designed' \
  -H 'X-API-Key: shop_etchify_xxxxxxxxxxxxxxxxxxxxxxxx' \
  -H 'Accept: application/json'
# Fetch designed orders since yesterday curl -X GET 'https://api.etchify.app/api/v1/orders?since=2026-05-03T00:00:00Z&status=designed' \ -H 'X-API-Key: shop_etchify_xxxxxxxxxxxxxxxxxxxxxxxx' \ -H 'Accept: application/json'

Real-time push via Shopify orders/create

Orders reach Etchify through Shopify's own order webhooks — there is no separate Etchify webhook to verify. For your ERP, an email service or a Slack bridge, subscribe Shopify's orders/create webhook; it carries the Etchify cart properties of each order.

n8n HTTP Request node

Drop-in JSON for an n8n workflow. Fetches new designed orders hourly with auth header. Combine with schedule trigger and Notion / Airtable output.

// n8n HTTP Request node config (manual export to JSON)
{
  "method": "GET",
  "url": "https://api.etchify.app/api/v1/orders",
  "authentication": "genericCredentialType",
  "genericAuthType": "httpHeaderAuth",
  "sendQuery": true,
  "queryParameters": {
    "parameters": [
      { "name": "since", "value": "{{$now.minus({hours:1}).toISO()}}" },
      { "name": "status", "value": "designed" }
    ]
  },
  "options": { "response": { "response": { "responseFormat": "json" } } }
}
// n8n HTTP Request node config (manual export to JSON) { "method": "GET", "url": "https://api.etchify.app/api/v1/orders", "authentication": "genericCredentialType", "genericAuthType": "httpHeaderAuth", "sendQuery": true, "queryParameters": { "parameters": [ { "name": "since", "value": "{{$now.minus({hours:1}).toISO()}}" }, { "name": "status", "value": "designed" } ] }, "options": { "response": { "response": { "responseFormat": "json" } } } }

Snippets are starter templates — swap in your own API keys, secrets and endpoints. Real-time push uses Shopify's orders/create webhook (free in every Shopify plan), which carries every Etchify cart-property (_design_id, _design_url, _preview_url, dimensions as “Dimensions”; the material is in the variant) — no Etchify-side configuration needed.

Live: AI Write Tools + Direct REST

Real-time push (Shopify-native)

Subscribe Shopify's orders/create webhook to your endpoint — every Etchify cart-property (_design_id, _design_url, _preview_url, dimensions as “Dimensions”; the material is in the variant) ships automatically. HMAC verification via Shopify's standard signature. Free in every Shopify plan.

AI Write Tools

21 write tools for AI agents on every plan: enable-product, create-shape, set-brand-colors, upload-shop-logo, create-template, set-production-method and more. Your AI changes the setup directly — products already on sale wait for your approval.

API Changelog

Breaking changes and new endpoints are tracked in the changelog.

View changelog →

Need help?

Email help@etchify.app — Pro and Business plans get priority routing.