Catalog / API v1
List products
/api/partner/v1/productsInvalid or duplicate SKUs are omitted before pagination. Totals count eligible products; an empty catalog returns 200 with an empty list.
Authorization: Bearer <PARTNER_API_KEY>
Query parameters
pageintegeroptionaldefault: 1 · min: 1
sizeintegeroptionaldefault: 20 · min: 1 · max: 100
searchstringoptionalmax length: 100
Response
Current visible, available, allowed partner catalog.
dataobjectrequiredShow fields
itemsarrayrequiredShow fields
skustringrequiredmax length: 100
nameArstringrequirednameEnstringrequiredhowToUseArstringrequiredhowToUseEnstringrequiredimagestring | nullrequiredmerchantobjectrequiredShow fields
idstringrequirednameArstringrequirednameEnstringrequired
categoryobjectrequiredShow fields
idstringrequirednameArstringrequirednameEnstringrequired
faceValuestring | nullrequiredOriginal provider denomination when supplied. SKU-only OneCard products may return null; it is never inferred from the SAR price.
faceValueCurrencystring | nullrequiredPaired with faceValue; both fields are null when denomination metadata is unavailable.
min length: 3 · max length: 3
priceMinorintegerrequiredFinal VAT-inclusive gross SAR unit price, excluding any service fee, from configured partner pricing or, for partners not yet migrated, a legacy override or retail fallback.
int64 · min: 1 · max: 9007199254740991
priceCurrencystringrequired"SAR"
priceSourcestringrequired"PARTNER_PRICE" · "RETAIL_FALLBACK"
redemptionChannelstringrequired"MERCHANT" · "GIFTU_APP"
paginationobjectrequiredShow fields
pageintegerrequiredsizeintegerrequiredtotalintegerrequiredint64
totalPagesintegerrequired
requestIdstringrequirederrorobject | nullrequirednull