Back to Synctryx

API Documentation

Public reference for the Synctryx data API

The examples below use placeholder credentials. To get your own live x-api-key and x-api-secret, ask an admin to issue one from Admin → API Key Management — then view them in Settings → API Access.

API Reference

The Synctryx public API lets you pull your platform data into external tools, spreadsheets, or automations. Authenticate with an API key + secret issued from the Admin panel (Admin → API Key Management).

Endpoint
https://synctryx.net/apps/6a47fc10a8c521976ecd3fd3/functions/apiGateway

Method

POST (GET also works)

Auth headers

x-api-key, x-api-secret

Content-Type

application/json
Access model

Your key is user-scoped — it only ever returns your own data, tied to the key's owner email. Admin-only resources are rejected.

Request parameters
FieldDescription
resourceWhich dataset to fetch (see the tables below).
limitMax records to return. Default 100, capped at 500.
user_emailAdmin keys only — scope a call to a specific seller's data. User keys are always auto-scoped to the key owner.
Your available resources
resource: "orders"

Your eBay sales — order number, product, amount, profit, fulfillment status, tracking.

Returns
order_number, product_name, amount, profit, status, tracking_number, aliexpress_order_id, fulfillment_status
Example request
curl -X POST https://synctryx.net/apps/6a47fc10a8c521976ecd3fd3/functions/apiGateway \
  -H "x-api-key: YOUR_API_KEY" \
  -H "x-api-secret: YOUR_API_SECRET" \
  -H "Content-Type: application/json" \
  -d '{"resource": "orders"}'

Response shape

{
  "success": true,
  "resource": "orders",
  "scope": "user",
  "access_level": "user",
  "data": [ ... ]
}