مرجع API v1
مرجع مقروء فقط مشتق من OpenAPI 3.1، يضم 11 عملية مسجلة.
استخدم رموزاً محلية أو اختبارية فقط. لا ينفذ هذا المرجع الطلبات، ولا يعني تسجيل العملية أنها مفعلة في إصدارك الحالي.
/api/v1/catalog/productsعرض منتجات الكتالوج
النطاق:
catalog:readالمصادقة: bearerAuthالمعاملات
[
{
"$ref": "#/components/parameters/Limit"
},
{
"$ref": "#/components/parameters/Before"
}
]الطلبات والاستجابات
{
"requestBody": null,
"responses": {
"200": {
"description": "Product page",
"headers": {
"RateLimit-Limit": {
"$ref": "#/components/headers/RateLimitLimit"
},
"RateLimit-Remaining": {
"$ref": "#/components/headers/RateLimitRemaining"
},
"RateLimit-Reset": {
"$ref": "#/components/headers/RateLimitReset"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProductPage"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"404": {
"$ref": "#/components/responses/FeatureUnavailable"
},
"429": {
"$ref": "#/components/responses/RateLimited"
},
"500": {
"$ref": "#/components/responses/ServerError"
},
"503": {
"$ref": "#/components/responses/RateLimitUnavailable"
}
}
}أمثلة آمنة
curl
curl --request GET 'https://example.com/api/v1/catalog/products' \ --header 'Authorization: Bearer <ACCESS_TOKEN>'
javascript
fetch('https://example.com/api/v1/catalog/products', {
method: 'GET',
headers: {
Authorization: 'Bearer <ACCESS_TOKEN>'
}
});python
requests.request(
'GET',
'https://example.com/api/v1/catalog/products',
headers={'Authorization': 'Bearer <ACCESS_TOKEN>'}
)/api/v1/ordersعرض الطلبات
النطاق:
orders:readالمصادقة: bearerAuthالمعاملات
[
{
"$ref": "#/components/parameters/Limit"
},
{
"$ref": "#/components/parameters/Before"
}
]الطلبات والاستجابات
{
"requestBody": null,
"responses": {
"200": {
"description": "Order page",
"headers": {
"RateLimit-Limit": {
"$ref": "#/components/headers/RateLimitLimit"
},
"RateLimit-Remaining": {
"$ref": "#/components/headers/RateLimitRemaining"
},
"RateLimit-Reset": {
"$ref": "#/components/headers/RateLimitReset"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderPage"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"404": {
"$ref": "#/components/responses/FeatureUnavailable"
},
"429": {
"$ref": "#/components/responses/RateLimited"
},
"500": {
"$ref": "#/components/responses/ServerError"
},
"503": {
"$ref": "#/components/responses/RateLimitUnavailable"
}
}
}أمثلة آمنة
curl
curl --request GET 'https://example.com/api/v1/orders' \ --header 'Authorization: Bearer <ACCESS_TOKEN>'
javascript
fetch('https://example.com/api/v1/orders', {
method: 'GET',
headers: {
Authorization: 'Bearer <ACCESS_TOKEN>'
}
});python
requests.request(
'GET',
'https://example.com/api/v1/orders',
headers={'Authorization': 'Bearer <ACCESS_TOKEN>'}
)/api/v1/webhooksعرض اشتراكات Webhook
النطاق:
webhooks:manageالمصادقة: bearerAuthالمعاملات
[]
الطلبات والاستجابات
{
"requestBody": null,
"responses": {
"200": {
"description": "Webhook subscriptions",
"headers": {
"RateLimit-Limit": {
"$ref": "#/components/headers/RateLimitLimit"
},
"RateLimit-Remaining": {
"$ref": "#/components/headers/RateLimitRemaining"
},
"RateLimit-Reset": {
"$ref": "#/components/headers/RateLimitReset"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WebhookList"
}
}
}
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"404": {
"$ref": "#/components/responses/FeatureUnavailable"
},
"429": {
"$ref": "#/components/responses/RateLimited"
},
"500": {
"$ref": "#/components/responses/ServerError"
},
"503": {
"$ref": "#/components/responses/RateLimitUnavailable"
}
}
}أمثلة آمنة
curl
curl --request GET 'https://example.com/api/v1/webhooks' \ --header 'Authorization: Bearer <ACCESS_TOKEN>'
javascript
fetch('https://example.com/api/v1/webhooks', {
method: 'GET',
headers: {
Authorization: 'Bearer <ACCESS_TOKEN>'
}
});python
requests.request(
'GET',
'https://example.com/api/v1/webhooks',
headers={'Authorization': 'Bearer <ACCESS_TOKEN>'}
)/api/v1/webhooksإنشاء اشتراك Webhook
النطاق:
webhooks:manageالمصادقة: bearerAuthالمعاملات
[]
الطلبات والاستجابات
{
"requestBody": {
"required": true,
"content": {
"application/json": {
"example": {
"event_type": "orders.created",
"endpoint_url": "https://webhooks.example.test/events"
},
"schema": {
"type": "object",
"required": [
"event_type",
"endpoint_url"
],
"properties": {
"event_type": {
"type": "string",
"example": "orders.created"
},
"endpoint_url": {
"type": "string",
"format": "uri",
"pattern": "^(?![\\s\\S]*\\s)https://[A-Za-z0-9.-]+(?::[0-9]{1,5})?(?:/[^#]*)?$",
"maxLength": 2048,
"description": "HTTPS subscription endpoint; fragments, credentials, whitespace, and non-HTTPS schemes are rejected."
}
}
}
}
}
},
"responses": {
"201": {
"description": "Created or reactivated subscription. The signing secret is returned once in this response.",
"headers": {
"RateLimit-Limit": {
"$ref": "#/components/headers/RateLimitLimit"
},
"RateLimit-Remaining": {
"$ref": "#/components/headers/RateLimitRemaining"
},
"RateLimit-Reset": {
"$ref": "#/components/headers/RateLimitReset"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WebhookCreateResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/FeatureUnavailable"
},
"413": {
"$ref": "#/components/responses/PayloadTooLarge"
},
"429": {
"$ref": "#/components/responses/RateLimited"
},
"500": {
"$ref": "#/components/responses/ServerError"
},
"503": {
"$ref": "#/components/responses/RateLimitUnavailable"
}
}
}أمثلة آمنة
curl
curl --request POST 'https://example.com/api/v1/webhooks' \
--header 'Authorization: Bearer <ACCESS_TOKEN>'
--header 'Content-Type: application/json'
--data '{"event_type":"orders.created","endpoint_url":"https://webhooks.example.test/events"}'javascript
fetch('https://example.com/api/v1/webhooks', {
method: 'POST',
headers: {
Authorization: 'Bearer <ACCESS_TOKEN>',
'Content-Type': 'application/json'
},
body: JSON.stringify({"event_type":"orders.created","endpoint_url":"https://webhooks.example.test/events"})
});python
requests.request(
'POST',
'https://example.com/api/v1/webhooks',
headers={'Authorization': 'Bearer <ACCESS_TOKEN>', 'Content-Type': 'application/json'},
json={"event_type":"orders.created","endpoint_url":"https://webhooks.example.test/events"}
)/api/v1/webhooks/{id}تعطيل اشتراك Webhook
النطاق:
webhooks:manageالمصادقة: bearerAuthالمعاملات
[
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]الطلبات والاستجابات
{
"requestBody": null,
"responses": {
"200": {
"description": "Subscription disabled",
"headers": {
"RateLimit-Limit": {
"$ref": "#/components/headers/RateLimitLimit"
},
"RateLimit-Remaining": {
"$ref": "#/components/headers/RateLimitRemaining"
},
"RateLimit-Reset": {
"$ref": "#/components/headers/RateLimitReset"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WebhookDisableResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"429": {
"$ref": "#/components/responses/RateLimited"
},
"500": {
"$ref": "#/components/responses/ServerError"
},
"503": {
"$ref": "#/components/responses/RateLimitUnavailable"
}
}
}أمثلة آمنة
curl
curl --request DELETE 'https://example.com/api/v1/webhooks/{id}' \
--header 'Authorization: Bearer <ACCESS_TOKEN>'javascript
fetch('https://example.com/api/v1/webhooks/{id}', {
method: 'DELETE',
headers: {
Authorization: 'Bearer <ACCESS_TOKEN>'
}
});python
requests.request(
'DELETE',
'https://example.com/api/v1/webhooks/{id}',
headers={'Authorization': 'Bearer <ACCESS_TOKEN>'}
)/api/v1/customersعرض بيانات التواصل للعملاء
النطاق:
customers:readالمصادقة: bearerAuthالمعاملات
[
{
"$ref": "#/components/parameters/ReadLimit"
},
{
"$ref": "#/components/parameters/ReadBefore"
},
{
"$ref": "#/components/parameters/ReadBeforeId"
}
]الطلبات والاستجابات
{
"requestBody": null,
"responses": {
"200": {
"description": "A tenant-isolated page with the exact documented fields.",
"headers": {
"RateLimit-Limit": {
"$ref": "#/components/headers/RateLimitLimit"
},
"RateLimit-Remaining": {
"$ref": "#/components/headers/RateLimitRemaining"
},
"RateLimit-Reset": {
"$ref": "#/components/headers/RateLimitReset"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerPage"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/FeatureUnavailable"
},
"429": {
"$ref": "#/components/responses/RateLimited"
},
"500": {
"$ref": "#/components/responses/ServerError"
},
"503": {
"$ref": "#/components/responses/RateLimitUnavailable"
}
}
}أمثلة آمنة
curl
curl --request GET 'https://example.com/api/v1/customers' \ --header 'Authorization: Bearer <ACCESS_TOKEN>'
javascript
fetch('https://example.com/api/v1/customers', {
method: 'GET',
headers: {
Authorization: 'Bearer <ACCESS_TOKEN>'
}
});python
requests.request(
'GET',
'https://example.com/api/v1/customers',
headers={'Authorization': 'Bearer <ACCESS_TOKEN>'}
)/api/v1/discountsعرض الخصومات النشطة
النطاق:
discounts:readالمصادقة: bearerAuthالمعاملات
[
{
"$ref": "#/components/parameters/ReadLimit"
},
{
"$ref": "#/components/parameters/ReadBefore"
},
{
"$ref": "#/components/parameters/ReadBeforeId"
}
]الطلبات والاستجابات
{
"requestBody": null,
"responses": {
"200": {
"description": "A tenant-isolated page with the exact documented fields.",
"headers": {
"RateLimit-Limit": {
"$ref": "#/components/headers/RateLimitLimit"
},
"RateLimit-Remaining": {
"$ref": "#/components/headers/RateLimitRemaining"
},
"RateLimit-Reset": {
"$ref": "#/components/headers/RateLimitReset"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActiveDiscountPage"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/FeatureUnavailable"
},
"429": {
"$ref": "#/components/responses/RateLimited"
},
"500": {
"$ref": "#/components/responses/ServerError"
},
"503": {
"$ref": "#/components/responses/RateLimitUnavailable"
}
}
}أمثلة آمنة
curl
curl --request GET 'https://example.com/api/v1/discounts' \ --header 'Authorization: Bearer <ACCESS_TOKEN>'
javascript
fetch('https://example.com/api/v1/discounts', {
method: 'GET',
headers: {
Authorization: 'Bearer <ACCESS_TOKEN>'
}
});python
requests.request(
'GET',
'https://example.com/api/v1/discounts',
headers={'Authorization': 'Bearer <ACCESS_TOKEN>'}
)/api/v1/inventory/locationsعرض مواقع المخزون
النطاق:
inventory:readالمصادقة: bearerAuthالمعاملات
[
{
"$ref": "#/components/parameters/ReadLimit"
},
{
"$ref": "#/components/parameters/ReadBefore"
},
{
"$ref": "#/components/parameters/ReadBeforeId"
}
]الطلبات والاستجابات
{
"requestBody": null,
"responses": {
"200": {
"description": "A tenant-isolated page with the exact documented fields.",
"headers": {
"RateLimit-Limit": {
"$ref": "#/components/headers/RateLimitLimit"
},
"RateLimit-Remaining": {
"$ref": "#/components/headers/RateLimitRemaining"
},
"RateLimit-Reset": {
"$ref": "#/components/headers/RateLimitReset"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InventoryLocationPage"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/FeatureUnavailable"
},
"429": {
"$ref": "#/components/responses/RateLimited"
},
"500": {
"$ref": "#/components/responses/ServerError"
},
"503": {
"$ref": "#/components/responses/RateLimitUnavailable"
}
}
}أمثلة آمنة
curl
curl --request GET 'https://example.com/api/v1/inventory/locations' \ --header 'Authorization: Bearer <ACCESS_TOKEN>'
javascript
fetch('https://example.com/api/v1/inventory/locations', {
method: 'GET',
headers: {
Authorization: 'Bearer <ACCESS_TOKEN>'
}
});python
requests.request(
'GET',
'https://example.com/api/v1/inventory/locations',
headers={'Authorization': 'Bearer <ACCESS_TOKEN>'}
)/api/v1/inventory/levelsعرض كميات المخزون
النطاق:
inventory:readالمصادقة: bearerAuthالمعاملات
[
{
"$ref": "#/components/parameters/ReadLimit"
},
{
"$ref": "#/components/parameters/ReadBefore"
},
{
"$ref": "#/components/parameters/ReadBeforeId"
}
]الطلبات والاستجابات
{
"requestBody": null,
"responses": {
"200": {
"description": "A tenant-isolated page with the exact documented fields.",
"headers": {
"RateLimit-Limit": {
"$ref": "#/components/headers/RateLimitLimit"
},
"RateLimit-Remaining": {
"$ref": "#/components/headers/RateLimitRemaining"
},
"RateLimit-Reset": {
"$ref": "#/components/headers/RateLimitReset"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InventoryLevelPage"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/FeatureUnavailable"
},
"429": {
"$ref": "#/components/responses/RateLimited"
},
"500": {
"$ref": "#/components/responses/ServerError"
},
"503": {
"$ref": "#/components/responses/RateLimitUnavailable"
}
}
}أمثلة آمنة
curl
curl --request GET 'https://example.com/api/v1/inventory/levels' \ --header 'Authorization: Bearer <ACCESS_TOKEN>'
javascript
fetch('https://example.com/api/v1/inventory/levels', {
method: 'GET',
headers: {
Authorization: 'Bearer <ACCESS_TOKEN>'
}
});python
requests.request(
'GET',
'https://example.com/api/v1/inventory/levels',
headers={'Authorization': 'Bearer <ACCESS_TOKEN>'}
)/api/v1/inventory/movementsعرض حركات المخزون
النطاق:
inventory:readالمصادقة: bearerAuthالمعاملات
[
{
"$ref": "#/components/parameters/ReadLimit"
},
{
"$ref": "#/components/parameters/ReadBefore"
},
{
"$ref": "#/components/parameters/ReadBeforeId"
}
]الطلبات والاستجابات
{
"requestBody": null,
"responses": {
"200": {
"description": "A tenant-isolated page with the exact documented fields.",
"headers": {
"RateLimit-Limit": {
"$ref": "#/components/headers/RateLimitLimit"
},
"RateLimit-Remaining": {
"$ref": "#/components/headers/RateLimitRemaining"
},
"RateLimit-Reset": {
"$ref": "#/components/headers/RateLimitReset"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InventoryMovementPage"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/FeatureUnavailable"
},
"429": {
"$ref": "#/components/responses/RateLimited"
},
"500": {
"$ref": "#/components/responses/ServerError"
},
"503": {
"$ref": "#/components/responses/RateLimitUnavailable"
}
}
}أمثلة آمنة
curl
curl --request GET 'https://example.com/api/v1/inventory/movements' \ --header 'Authorization: Bearer <ACCESS_TOKEN>'
javascript
fetch('https://example.com/api/v1/inventory/movements', {
method: 'GET',
headers: {
Authorization: 'Bearer <ACCESS_TOKEN>'
}
});python
requests.request(
'GET',
'https://example.com/api/v1/inventory/movements',
headers={'Authorization': 'Bearer <ACCESS_TOKEN>'}
)/api/v1/storeعرض بيانات المتجر العامة
النطاق:
store:readالمصادقة: bearerAuthالمعاملات
[
{
"$ref": "#/components/parameters/ReadLimit"
},
{
"$ref": "#/components/parameters/ReadBefore"
},
{
"$ref": "#/components/parameters/ReadBeforeId"
}
]الطلبات والاستجابات
{
"requestBody": null,
"responses": {
"200": {
"description": "A tenant-isolated page with the exact documented fields.",
"headers": {
"RateLimit-Limit": {
"$ref": "#/components/headers/RateLimitLimit"
},
"RateLimit-Remaining": {
"$ref": "#/components/headers/RateLimitRemaining"
},
"RateLimit-Reset": {
"$ref": "#/components/headers/RateLimitReset"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StoreIdentityPage"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/FeatureUnavailable"
},
"429": {
"$ref": "#/components/responses/RateLimited"
},
"500": {
"$ref": "#/components/responses/ServerError"
},
"503": {
"$ref": "#/components/responses/RateLimitUnavailable"
}
}
}أمثلة آمنة
curl
curl --request GET 'https://example.com/api/v1/store' \ --header 'Authorization: Bearer <ACCESS_TOKEN>'
javascript
fetch('https://example.com/api/v1/store', {
method: 'GET',
headers: {
Authorization: 'Bearer <ACCESS_TOKEN>'
}
});python
requests.request(
'GET',
'https://example.com/api/v1/store',
headers={'Authorization': 'Bearer <ACCESS_TOKEN>'}
)