ثبت سفارش
POST
/api/v1/ordersscope: orders:writeاحراز هویت: Bearerlive و testIdempotency-Key
سفارش واقعی روی همان سیستم سفارش Stard. در محیط live مبلغ خودکار از کیف پول API (موجودی TON یا تومانی حساب Stard لینکشده؛ منبع پیشفرض در داشبورد) کسر میشود و سفارش مثل خرید از مینیاپ انجام میشود. در محیط test با موجودی آزمایشی شبیهسازی میشود و هیچ پول یا سفارش واقعی ساخته نمیشود.
درخواست
| نام | محل | نوع | توضیح | |
|---|---|---|---|---|
Authorization | header | string | الزامی | Bearer sk_live_… یا Bearer sk_test_… |
Idempotency-Key | header | string | اختیاری | تا ۶۴ کاراکتر؛ تکرار درخواست با همین کلید همان پاسخ قبلی را برمیگرداند و دوباره کسر نمیکند. همیشه بفرست. |
بدنه (JSON)
| فیلد | نوع | توضیح | |
|---|---|---|---|
type | string | اختیاری | product (پیشفرض) یا stars |
product_id | integer | اختیاری | برای type=product لازم است |
quantity | integer | اختیاری | برای محصول همیشه ۱؛ برای استارز تعداد (حداقل ۵۰) |
recipient | string | اختیاری | یوزرنیم تلگرام گیرنده (مثل @username)؛ برای استارز و گیفت استارزی لازم است |
gift_message | string | اختیاری | پیام روی گیفت استارزی (حداکثر ۲۰۰ کاراکتر) |
pay_currency | string | اختیاری | TON یا IRT؛ اگر نفرستی، منبع پیشفرض کیف پول API در داشبورد (برای حساب تازه TON) |
metadata | object | اختیاری | تا ۲۰ کلید دلخواه (رشته/عدد/بولین) که همراه سفارش برمیگردد؛ مثلاً شماره فاکتور خودت |
نمونه
curl -X POST "https://stard-market.ir/api/v1/orders" \
-H "Authorization: Bearer $STARD_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: order-INV-1042" \
-d '{"type": "product", "product_id": 4518, "metadata": {"invoice": "INV-1042"}}'const res = await fetch("https://stard-market.ir/api/v1/orders", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.STARD_API_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": "order-INV-1042",
},
body: JSON.stringify({
"type": "product",
"product_id": 4518,
"metadata": {
"invoice": "INV-1042"
}
}),
});
const data = await res.json();
if (!res.ok) throw new Error(`${data.error.code}: ${data.error.message}`);
console.log(data);type StardError = { error: { type: string; code: string; message: string; param: string | null; request_id: string } };
const res = await fetch("https://stard-market.ir/api/v1/orders", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.STARD_API_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": "order-INV-1042",
},
body: JSON.stringify({
"type": "product",
"product_id": 4518,
"metadata": {
"invoice": "INV-1042"
}
}),
});
if (!res.ok) {
const { error } = (await res.json()) as StardError;
throw new Error(`${error.code}: ${error.message} (${error.request_id})`);
}
const data: Record<string, unknown> = await res.json();import os
import requests
r = requests.post(
"https://stard-market.ir/api/v1/orders",
headers={
"Authorization": f"Bearer {os.environ['STARD_API_KEY']}",
"Idempotency-Key": "order-INV-1042",
},
json={
"type": "product",
"product_id": 4518,
"metadata": {
"invoice": "INV-1042"
}
},
timeout=20,
)
data = r.json()
if r.status_code >= 400:
raise RuntimeError(f"{data['error']['code']}: {data['error']['message']}")
print(data)<?php
$ch = curl_init("https://stard-market.ir/api/v1/orders");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("STARD_API_KEY"),
"Content-Type: application/json",
"Idempotency-Key: order-INV-1042",
],
CURLOPT_POSTFIELDS => json_encode([
"type" => "product",
"product_id" => 4518,
"metadata" => [
"invoice" => "INV-1042"
]
]),
CURLOPT_TIMEOUT => 20,
]);
$data = json_decode(curl_exec($ch), true);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
if ($status >= 400) {
throw new RuntimeException($data["error"]["code"] . ": " . $data["error"]["message"]);
}
print_r($data);package main
import (
"fmt"
"io"
"net/http"
"os"
"strings"
)
func main() {
body := strings.NewReader(`{"type": "product", "product_id": 4518, "metadata": {"invoice": "INV-1042"}}`)
req, _ := http.NewRequest("POST", "https://stard-market.ir/api/v1/orders", body)
req.Header.Set("Authorization", "Bearer "+os.Getenv("STARD_API_KEY"))
req.Header.Set("Content-Type", "application/json")
req.Header.Set("Idempotency-Key", "order-INV-1042")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
b, _ := io.ReadAll(res.Body)
fmt.Println(res.StatusCode, string(b))
}پاسخ — 201
{
"object": "order",
"id": "ord_test_gGToQWxqOw89ssiL",
"order_id": null,
"environment": "test",
"status": "pending",
"raw_status": "pending",
"title": "پریمیوم ۳ ماهه (test)",
"product_id": 4518,
"product_tag": null,
"type": "product",
"quantity": 1,
"recipient": null,
"amount": {
"amount": 3788624,
"currency": "IRT"
},
"paid": {
"amount": 3788624,
"currency": "IRT"
},
"failure_reason": null,
"metadata": {
"invoice": "INV-1042"
},
"created_at": "2026-10-01T10:31:49Z",
"updated_at": "2026-10-01T10:31:49Z"
}هدرهای پاسخ
x-request-id: req_Ne8SLkkri4MPzWnBQnQs
x-ratelimit-limit: 60
x-ratelimit-remaining: 44
x-ratelimit-reset: 1790850720خطاها
| HTTP | code | کی |
|---|---|---|
400 | parameter_invalid / recipient_invalid / p2p_not_supported / not_fixed_price | بدنه نامعتبر است یا محصول از API قابل خرید نیست |
402 | insufficient_funds | موجودی کیف پول (یا موجودی آزمایشی) کافی نیست |
403 | account_not_linked / insufficient_scope | برای live باید حساب تلگرام Stard وصل باشد؛ یا کلید scope لازم را ندارد |
404 | product_not_found | محصول وجود ندارد یا غیرفعال است |
409 | product_unavailable / idempotency_key_reused / request_in_progress | محصول همین الان ناموجود شد، یا کلید idempotency با بدنهی دیگری استفاده شده |
403 | insufficient_scope | کلید scope orders:write را ندارد |
401 | invalid_api_key / missing_api_key / api_key_revoked / api_key_expired | کلید نیامده، نامعتبر، باطل یا منقضی است |
429 | rate_limit_exceeded | سقف درخواست در دقیقه پر شده؛ بعد از Retry-After ثانیه دوباره بفرست |
محدودیت نرخ
پیشفرض ۶۰ درخواست در دقیقه برای هر کلید (قابل تنظیم در داشبورد)؛ ثبت سفارش جداگانه حداکثر ۲۰ در دقیقه برای هر کلید. وضعیت در هدرهای X-RateLimit-* برمیگردد — جزئیات.
