الطلبات / API v1

قائمة الطلبات

GET/api/partner/v1/orders

Orders belonging to the authenticated partner and key environment.

المصادقة

Authorization: Bearer <PARTNER_API_KEY>

المفاتيح والبيئات وسياسة IP

معاملات الاستعلام

pageintegerاختياري: default: 1 · min: 1
sizeintegerاختياري: default: 20 · min: 1 · max: 100
searchstringاختياري: max length: 100

الاستجابة

Orders belonging to the authenticated partner and key environment.

Cache-Control no-store

dataobjectمطلوب

عرض الحقول

itemsarrayمطلوب

عرض الحقول

orderIdstringمطلوب

uuid

partnerReferencestringمطلوب

statusstringمطلوب

"PROCESSING" · "COMPLETED" · "FAILED"

totalMinorintegerمطلوب

int64 · min: 1 · max: 9007199254740991

currencystringمطلوب

"SAR"

skustringمطلوب

productNameArstringمطلوب

productNameEnstringمطلوب

chargedPriceMinorintegerمطلوب

int64 · min: 1 · max: 9007199254740991

chargedCurrencystringمطلوب

"SAR"

faceValuestring | nullمطلوب

Frozen original provider denomination when supplied, not the charged SAR price. SKU-only OneCard orders may return null.

faceValueCurrencystring | nullمطلوب

Paired with faceValue; both fields are null when denomination metadata is unavailable.

min length: 3 · max length: 3

supportReferencestring | nullمطلوب

pollAfterSecondsinteger | nullمطلوب

Always non-null while status is PROCESSING, including manual review.

min: 1

createdAtstringمطلوب

date-time

updatedAtstringمطلوب

date-time

completedAtstring | nullمطلوب

date-time

paginationobjectمطلوب

عرض الحقول

pageintegerمطلوب
sizeintegerمطلوب
totalintegerمطلوب: int64
totalPagesintegerمطلوب

requestIdstringمطلوب

errorobject | nullمطلوب

null

تحتاج مساعدة في التكامل؟تواصل مع فريق قيفتو