الطلبات / API v1
طلب بالمرجع
/api/partner/v1/orders/by-reference/{partnerReference}The dynamic partnerReference is redacted from server access logs.
Authorization: Bearer <PARTNER_API_KEY>
معاملات المسار
partnerReferencestringمطلوبmin length: 1 · max length: 100
^[A-Za-z0-9._:-]+$
الاستجابة
Owning partner order. Credentials are terminal-only.
Cache-Control no-store
dataobjectمطلوبعرض الحقول
orderobjectمطلوبعرض الحقول
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
howToUseArstringمطلوبhowToUseEnstringمطلوبcredentialsobject | nullمطلوبNull until fulfillment completes; populated credentials match OrderCredentials.
عرض الحقول
serialstring | nullمطلوبpinstring | nullمطلوبusernamestring | nullمطلوب
requestIdstringمطلوبerrorobject | nullمطلوبnull