البناء على Sellix.

واحد JSON API. نفس السطح الذي تستخدمه لوحة القيادة. اصنع رمزًا مميزًا لحامل النطاق، واختر نقطة نهاية أدناه، واضغط على الزر "جربه".

api.sellix.gg/v1 الإصدار 1 مستقر JSON · UTF-8 OpenAPI 3.1
المصادقة

الرموز المميزة لحاملها، محددة لكل مفتاح.

صك مفتاحًا ضمن المطورين -> API مفاتيح . اختر القدرات عند الإنشاء - على سبيل المثال، مفتاح للقراءة فقط للتحليلات، ومفتاح للكتابة فقط للتنفيذ. قم بالإلغاء على الفور دون لمس الآخرين.

مفتاح مباشر
sk_…

دفعات حقيقية. محافظ حقيقية. تسوية حقيقية.

أخطاء

RFC 7807. دائمًا JSON.

يُرجع كل غير 2xx نصًا منظمًا - لا يعرض HTML مطلقًا. فرع على سبيكة type.

400 idempotency_key_required A write request is missing a valid `Idempotency-Key`.
401 unauthenticated Missing or invalid bearer token.
403 forbidden_scope Key is valid but lacks the ability for this endpoint.
404 not_found The resource doesn't exist or isn't yours.
405 method_not_allowed The route does not support this HTTP method.
409 idempotency_conflict The idempotency key was reused with different request data.
422 unprocessable Validation failed. `details.errors` contains field errors.
429 rate_limited You're going too fast. `Retry-After` is set.
500 server_error Our side broke. Includes a `trace_id` for support.
502 provider_error An upstream payout, refund, or mail provider rejected the request.
حدود المعدل والعجز

الافتراضات المعقولة، المنصوص عليها في الحجر.

حدود المعدل

120 req/min للكتابة و 600 req/min للقراءة. يتم كبح الدفقات المستمرة باستخدام Retry-After.

Idempotency

Every POST, PATCH, and DELETE operation requires an Idempotency-Key header (8-255 characters). Repeating the same request returns the stored response; reusing a key with different data returns 409.

Products

GET
/v1/products
List products
Returns a paginated list of your products, newest first.
Parameters
  • limit optional integer query
    How many items to return per page. values:1 – 100 default:25
  • cursor optional string query
    Opaque pagination cursor from a previous response.
  • status optional enum query
    Filter by lifecycle status. values:active | hidden | archived | draft
  • type optional enum query
    Filter by product kind. values:license_key | account | file_download | service | dynamic | physical
Example response 200 
{
    "object": "list",
    "has_more": false,
    "next_cursor": null,
    "data": [
        {
            "id": "prod_01J2PVQR41",
            "name": "Account Pool",
            "type": "account",
            "price_cents": 12900,
            "currency": "USD",
            "stock": 47,
            "status": "active"
        },
        {
            "id": "prod_01J2PVQS6X",
            "name": "VIP Discord Role",
            "type": "service",
            "price_cents": 999,
            "currency": "USD",
            "stock": null,
            "status": "active"
        }
    ]
}
Try it - runs in your browser against a sandbox mock.
POST
/v1/products
Create a product
Publishes a new product on the active shop.
Parameters
  • name required string body
    Display name shown on the storefront.
  • type required enum body
    Decides which delivery strategy fires on payment. values:license_key | account | file_download | service | dynamic | physical
  • price_cents required integer body
    Price in the smallest unit of `currency`. values:≥ 0
  • currency required string body
    Three-letter fiat currency code; must match the active shop. values:ISO-4217 - e.g. USD, EUR, GBP
  • description optional string body
    Markdown-flavoured description body.
  • stock optional integer body
    `null` = unlimited / pool-driven. values:≥ 0 or null
Request body · editable
Example response 201 
{
    "id": "prod_01J2PVQR41",
    "name": "Adobe Creative Cloud Key",
    "slug": "adobe-creative-cloud-key",
    "type": "license_key",
    "price_cents": 12900,
    "currency": "USD",
    "stock": null,
    "status": "active",
    "created_at": "2026-05-26T07:18:03Z"
}
Try it - runs in your browser against a sandbox mock.
GET
/v1/products/{id}
Fetch a product
Returns a single product by id, including its stock count.
Parameters
  • id required string path
    The product identifier. values:prod_…
Example response 200 
{
    "id": "prod_01J2PVQR41",
    "name": "Adobe Creative Cloud Key",
    "slug": "adobe-creative-cloud-key",
    "type": "license_key",
    "price_cents": 12900,
    "currency": "USD",
    "stock": null,
    "status": "active",
    "created_at": "2026-05-26T07:18:03Z"
}
Try it - runs in your browser against a sandbox mock.
PATCH
/v1/products/{id}
Update a product
Patch any subset of editable fields. Sends back the full updated object.
Parameters
  • id required string path
    The product identifier.
  • name optional string body
    New display name.
  • price_cents optional integer body
    New price in smallest currency unit. values:≥ 0
  • status optional enum body
    Lifecycle status. values:active | hidden | archived | draft
  • description optional string body
    Markdown body.
Request body · editable
Example response 200 
{
    "id": "prod_01J2PVQR41",
    "price_cents": 9900,
    "status": "active",
    "updated_at": "2026-05-26T07:32:18Z"
}
Try it - runs in your browser against a sandbox mock.
DELETE
/v1/products/{id}
Archive a product
Marks the product archived. Existing orders keep working.
Parameters
  • id required string path
    The product identifier. values:prod_…
Example response 200 
{
    "id": "prod_01J2PVQR41",
    "deleted": true,
    "archived_at": "2026-05-26T07:36:51Z"
}
Try it - runs in your browser against a sandbox mock.
POST
/v1/products/{id}/keys
Bulk-import credentials
Adds opaque values to an account product's credential pool. Up to 5,000 per call.
Parameters
  • id required string path
    Account product id.
  • keys required array<string> body
    List of opaque key strings to add to the pool. values:1 – 5,000
Request body · editable
Example response 201 
{
    "imported": 3,
    "duplicates": 0,
    "stock_after": 50
}
Try it - runs in your browser against a sandbox mock.

Orders

GET
/v1/orders
List orders
Returns a paginated list of orders for the active shop.
Parameters
  • limit optional integer query
    Items per page. values:1 - 100 default:25
  • cursor optional string query
    Opaque cursor returned as `next_cursor` by the previous page.
  • status optional enum query
    Filter by order status. values:pending | awaiting_payment | paid | delivering | completed | failed | expired | cancelled | refunded
  • from optional string query
    Created at or after this date. values:ISO-8601 date
  • to optional string query
    Created at or before this date. values:ISO-8601 date
Example response 200 
{
    "object": "list",
    "has_more": false,
    "next_cursor": null,
    "data": [
        {
            "object": "order",
            "uuid": "7a2327ba-8655-45b4-a768-13e2112b2556",
            "status": "paid",
            "customer_email": "[email protected]",
            "total_cents": 4900,
            "currency": "USD",
            "created_at": "2026-05-26T07:12:02Z",
            "paid_at": "2026-05-26T07:14:22Z",
            "email": "[email protected]",
            "total": 4900
        }
    ]
}
Try it - runs in your browser against a sandbox mock.
GET
/v1/orders/{uuid}
Fetch an order
Returns one order and its line items.
Parameters
  • uuid required string path
    The order identifier. values:UUID
Example response 200 
{
    "object": "order",
    "uuid": "7a2327ba-8655-45b4-a768-13e2112b2556",
    "status": "paid",
    "customer_email": "[email protected]",
    "total_cents": 4900,
    "currency": "USD",
    "created_at": "2026-05-26T07:12:02Z",
    "paid_at": "2026-05-26T07:14:22Z",
    "email": "[email protected]",
    "total": 4900,
    "items": [
        {
            "product_id": 42,
            "product_name": "Adobe Creative Cloud Key",
            "quantity": 1,
            "unit_price_cents": 4900,
            "subtotal_cents": 4900,
            "subtotal": 4900
        }
    ]
}
Try it - runs in your browser against a sandbox mock.
POST
/v1/orders/{uuid}/refund
Refund an order
Refunds the full captured amount through the original payment provider.
Parameters
  • uuid required string path
    The order identifier.
  • amount_cents optional integer body
    Optional guard value. Partial refunds are not supported. values:= order total
  • reason optional enum body
    For your accounting + the buyer receipt. values:requested_by_buyer | duplicate | fraud | other
  • note optional string body
    Internal note attached to the refund record.
Request body · editable
Example response 200 
{
    "object": "refund",
    "id": "rf_7a2327ba-8655-45b4-a768-13e2112b2556",
    "order_id": "7a2327ba-8655-45b4-a768-13e2112b2556",
    "status": "submitted",
    "amount_cents": 4900,
    "currency": "USD",
    "reason": "requested_by_buyer",
    "created_at": "2026-05-26T07:22:51Z"
}
Try it - runs in your browser against a sandbox mock.
POST
/v1/orders/{uuid}/resend
Re-send delivery email
Re-fires the delivery email for a paid order (license key, file links, etc.).
Parameters
  • uuid required string path
    The order identifier. values:UUID
Request body · editable
Example response 200 
{
    "sent_at": "2026-05-26T07:41:09Z",
    "recipient": "[email protected]",
    "message_type": "delivery"
}
Try it - runs in your browser against a sandbox mock.

Invoices

GET
/v1/invoices
List invoices
Compatibility alias for the paginated orders collection. It returns the same order objects.
Parameters
  • limit optional integer query
    Items per page. values:1 - 100 default:25
  • cursor optional string query
    Opaque cursor returned as `next_cursor` by the previous page.
  • status optional enum query
    Filter by order status. values:pending | awaiting_payment | paid | delivering | completed | failed | expired | cancelled | refunded
  • from optional string query
    Created at or after this date. values:ISO-8601 date
  • to optional string query
    Created at or before this date. values:ISO-8601 date
Example response 200 
{
    "object": "list",
    "has_more": false,
    "next_cursor": null,
    "data": [
        {
            "object": "order",
            "uuid": "7a2327ba-8655-45b4-a768-13e2112b2556",
            "status": "paid",
            "customer_email": "[email protected]",
            "total_cents": 4900,
            "currency": "USD",
            "created_at": "2026-05-26T07:12:02Z",
            "paid_at": "2026-05-26T07:14:22Z",
            "email": "[email protected]",
            "total": 4900
        }
    ]
}
Try it - runs in your browser against a sandbox mock.
GET
/v1/invoices/{uuid}
Fetch an invoice
Compatibility alias for fetching the underlying order by UUID.
Parameters
  • uuid required string path
    The order identifier. values:UUID
Example response 200 
{
    "object": "order",
    "uuid": "7a2327ba-8655-45b4-a768-13e2112b2556",
    "status": "paid",
    "customer_email": "[email protected]",
    "total_cents": 4900,
    "currency": "USD",
    "created_at": "2026-05-26T07:12:02Z",
    "paid_at": "2026-05-26T07:14:22Z",
    "email": "[email protected]",
    "total": 4900,
    "items": [
        {
            "product_id": 42,
            "product_name": "Adobe Creative Cloud Key",
            "quantity": 1,
            "unit_price_cents": 4900,
            "subtotal_cents": 4900,
            "subtotal": 4900
        }
    ]
}
Try it - runs in your browser against a sandbox mock.

Customers

GET
/v1/customers
List customers
Returns a paginated list of unique customer emails for the active shop.
Parameters
  • limit optional integer query
    Items per page. values:1 – 100 default:25
  • cursor optional string query
    Opaque pagination cursor.
Example response 200 
{
    "object": "list",
    "has_more": false,
    "data": [
        {
            "id": "cus_01J2PR9M5C",
            "email": "[email protected]",
            "orders_count": 8,
            "lifetime_cents": 103200
        },
        {
            "id": "cus_01J2PRA1FE",
            "email": "[email protected]",
            "orders_count": 3,
            "lifetime_cents": 149700
        }
    ]
}
Try it - runs in your browser against a sandbox mock.
GET
/v1/customers/{id}
Fetch a customer
Returns one customer with their order history and lifetime metrics.
Parameters
  • id required string path
    Customer identifier. values:cus_…
Example response 200 
{
    "id": "cus_01J2PR9M5C",
    "email": "[email protected]",
    "orders_count": 8,
    "lifetime_cents": 103200,
    "first_seen_at": "2026-04-12T09:21:55Z",
    "last_seen_at": "2026-05-26T07:14:22Z",
    "orders": [
        {
            "id": "7a2327ba-8655-45b4-a768-13e2112b2556",
            "total_cents": 4900,
            "paid_at": "2026-05-26T07:14:22Z"
        },
        {
            "id": "ba28c1ca-1696-4bb3-8d84-0cb849c83639",
            "total_cents": 12900,
            "paid_at": "2026-05-19T22:01:08Z"
        }
    ]
}
Try it - runs in your browser against a sandbox mock.

Payouts

GET
/v1/payouts
List payouts
Returns a paginated list of payouts triggered from this tenant.
Parameters
  • limit optional integer query
    Items per page. values:1 – 100 default:25
  • status optional enum query
    Filter by payout status. values:processing | pending | broadcast | confirmed | failed | cancelled
Example response 200 
{
    "object": "list",
    "has_more": false,
    "data": [
        {
            "id": "po_01J2PVZ8KK",
            "status": "confirmed",
            "chain": "tron",
            "asset": "USDT",
            "amount": "250",
            "tx_hash": "0xfa3b\u2026",
            "confirmed_at": "2026-05-26T08:01:11Z"
        }
    ]
}
Try it - runs in your browser against a sandbox mock.
POST
/v1/payouts
Trigger a payout
Submits a payout from your connected BlockPN wallet to the destination address.
Parameters
  • chain required enum body
    Network to broadcast on. values:tron | base | ethereum | bitcoin | solana | polygon | bsc
  • asset required string body
    Asset symbol on that chain. values:USDT | USDC | BTC | ETH | SOL | …
  • amount required decimal string body
    Amount in asset units. Strings preserve crypto precision. values:> 0, max 18 decimals
  • destination_address required string body
    On-chain address to send to.
  • memo optional string body
    Optional memo/tag for chains that need one.
Request body · editable
Example response 201 
{
    "id": "po_01J2PW01GG",
    "status": "processing",
    "chain": "tron",
    "asset": "USDT",
    "amount": "250",
    "destination_address": "T...",
    "created_at": "2026-05-26T08:03:47Z"
}
Try it - runs in your browser against a sandbox mock.

Webhooks

GET
/v1/webhooks
List endpoints
Returns every webhook endpoint registered for the active shop.
Example response 200 
{
    "object": "list",
    "data": [
        {
            "id": "wh_01J2PTR7QW",
            "url": "https://your.app/sellix/webhook",
            "events": [
                "order.paid",
                "order.refunded"
            ],
            "status": "active"
        }
    ]
}
Try it - runs in your browser against a sandbox mock.
POST
/v1/webhooks
Register an endpoint
Subscribes a URL to one or more event types. Returns the signing secret.
Parameters
  • url required string body
    HTTPS URL we POST to.
  • events required array<string> body
    Events to subscribe to. values:order.paid | order.failed | order.refunded | delivery.completed | delivery.failed
  • description optional string body
    Human-readable note. Shown in the dashboard.
Request body · editable
Example response 201 
{
    "id": "wh_01J2PVT0KZ",
    "url": "https://your.app/sellix/webhook",
    "events": [
        "order.paid",
        "order.refunded"
    ],
    "signing_secret": "whsec_29Ax\u2026",
    "status": "active",
    "created_at": "2026-05-26T08:08:14Z"
}
Try it - runs in your browser against a sandbox mock.
POST
/v1/webhooks/{id}/test
Fire a test event
Sends a synthetic event to the endpoint so you can verify your handler.
Parameters
  • id required string path
    Endpoint identifier.
  • event optional enum body
    Which event type to send. values:order.paid | order.refunded | … default:order.paid
Request body · editable
Example response 202 
{
    "queued": true,
    "event_id": "0dc39b31-3132-41f6-875f-08a5187fbf6b",
    "delivery_id": 184
}
Try it - runs in your browser against a sandbox mock.
DELETE
/v1/webhooks/{id}
Remove an endpoint
Stops further deliveries. In-flight retries are cancelled.
Parameters
  • id required string path
    Endpoint identifier. values:wh_…
Example response 200 
{
    "id": "wh_01J2PVT0KZ",
    "deleted": true
}
Try it - runs in your browser against a sandbox mock.

API keys

GET
/v1/api-keys
List API keys
Returns metadata for every key minted under this tenant. Secret values are never returned twice.
Example response 200 
{
    "object": "list",
    "data": [
        {
            "id": "apik_01J2PR\u2026",
            "name": "Fulfilment worker",
            "abilities": [
                "orders:read",
                "orders:write"
            ],
            "last_used_at": "2026-05-26T08:11:00Z"
        },
        {
            "id": "apik_01J2PS\u2026",
            "name": "Analytics dash",
            "abilities": [
                "orders:read",
                "customers:read"
            ],
            "last_used_at": null
        }
    ]
}
Try it - runs in your browser against a sandbox mock.
POST
/v1/api-keys
Mint a key
Mints a scoped key. The secret value is only returned in this response - store it.
Parameters
  • name required string body
    Human-readable label.
  • abilities required array<string> body
    Permission set this key grants. values:orders:read | orders:write | products:read | products:write | customers:read | payouts:read | payouts:write | webhooks:read | webhooks:write
  • expires_in_days optional integer body
    Lifetime before automatic expiry. values:1 - 90 default:90
Request body · editable
Example response 201 
{
    "id": "apik_01J2PW2F88",
    "name": "Fulfilment worker",
    "abilities": [
        "orders:read",
        "orders:write"
    ],
    "secret": "sk_9kzQ7xV9c4fT2mN8rY1234567890abcdefghijkl",
    "created_at": "2026-05-26T08:15:31Z"
}
Try it - runs in your browser against a sandbox mock.
DELETE
/v1/api-keys/{id}
Revoke a key
Revokes a key instantly. Any in-flight request using it returns 401 from this point on.
Parameters
  • id required string path
    Key identifier. values:apik_…
Example response 200 
{
    "id": "apik_01J2PW2F88",
    "revoked": true
}
Try it - runs in your browser against a sandbox mock.
يستمر في التقدم

المزيد للبناة

Webhooks تم التوقيع، وإعادة التشغيل المحمي، وإعادة المحاولة حتى 2xx. حالة الصحة الحية لكل نظام فرعي Sellix.