curl --request POST \
--url https://business.papp.sa/api/v1/orders/earning/store-rating \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"phone_number": "512345678",
"review_reference": "STORE-REVIEW-2026-0001",
"rating": 5,
"comment": "Great experience, fast delivery.",
"metadata": {
"channel": "web",
"branch_code": "RUH-01"
}
}
'import requests
url = "https://business.papp.sa/api/v1/orders/earning/store-rating"
payload = {
"phone_number": "512345678",
"review_reference": "STORE-REVIEW-2026-0001",
"rating": 5,
"comment": "Great experience, fast delivery.",
"metadata": {
"channel": "web",
"branch_code": "RUH-01"
}
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
phone_number: '512345678',
review_reference: 'STORE-REVIEW-2026-0001',
rating: 5,
comment: 'Great experience, fast delivery.',
metadata: {channel: 'web', branch_code: 'RUH-01'}
})
};
fetch('https://business.papp.sa/api/v1/orders/earning/store-rating', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://business.papp.sa/api/v1/orders/earning/store-rating",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'phone_number' => '512345678',
'review_reference' => 'STORE-REVIEW-2026-0001',
'rating' => 5,
'comment' => 'Great experience, fast delivery.',
'metadata' => [
'channel' => 'web',
'branch_code' => 'RUH-01'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://business.papp.sa/api/v1/orders/earning/store-rating"
payload := strings.NewReader("{\n \"phone_number\": \"512345678\",\n \"review_reference\": \"STORE-REVIEW-2026-0001\",\n \"rating\": 5,\n \"comment\": \"Great experience, fast delivery.\",\n \"metadata\": {\n \"channel\": \"web\",\n \"branch_code\": \"RUH-01\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://business.papp.sa/api/v1/orders/earning/store-rating")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"phone_number\": \"512345678\",\n \"review_reference\": \"STORE-REVIEW-2026-0001\",\n \"rating\": 5,\n \"comment\": \"Great experience, fast delivery.\",\n \"metadata\": {\n \"channel\": \"web\",\n \"branch_code\": \"RUH-01\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://business.papp.sa/api/v1/orders/earning/store-rating")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"phone_number\": \"512345678\",\n \"review_reference\": \"STORE-REVIEW-2026-0001\",\n \"rating\": 5,\n \"comment\": \"Great experience, fast delivery.\",\n \"metadata\": {\n \"channel\": \"web\",\n \"branch_code\": \"RUH-01\"\n }\n}"
response = http.request(request)
puts response.read_body{
"status": true,
"message": "",
"appended_data": {},
"data": {
"id": 42,
"uuid": "550e8400-e29b-41d4-a716-446655440000",
"reference_number": "REF-2024-001234",
"order_status": "approved",
"status_label": "خرج للتوصيل",
"custom_status": {
"ar": "خرج للتوصيل",
"en": "Out for delivery"
},
"order_number": "ORD-2024-001234",
"type": 1,
"total_price": 150.5,
"total_points": 1505,
"metadata": {
"source": "mobile_app"
},
"date": "2024-12-23T00:00:00.000Z",
"time": "10:00:00",
"since": "2 hours ago",
"settlement_status": "settled",
"status": 1,
"created_at": "2024-12-23T10:00:00.000Z",
"updated_at": "2024-12-23T15:30:00.000Z",
"items": [
{
"product_name": "Cappuccino",
"product_price": 18.5,
"quantity": 2
}
]
}
}{
"status": false,
"message": "Invalid or inactive API key",
"appended_data": {}
}{
"status": false,
"message": "Invalid or inactive API key",
"appended_data": {}
}{
"status": false,
"message": "The given data was invalid.",
"appended_data": {},
"errors": {
"total_price": [
"The total price field is required."
],
"products.0.quantity": [
"The quantity must be at least 1."
]
}
}{
"status": false,
"message": "Invalid or inactive API key",
"appended_data": {}
}Create a store-rating earning order
Awards points to a customer for submitting a rating of the merchant’s store. The points amount is configured by the merchant in the Points dashboard — the request body does not carry the points value. The request is serialized inside a distributed lock scoped to the authenticated merchant, and review_reference is used as the merchant-side idempotency key.
curl --request POST \
--url https://business.papp.sa/api/v1/orders/earning/store-rating \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"phone_number": "512345678",
"review_reference": "STORE-REVIEW-2026-0001",
"rating": 5,
"comment": "Great experience, fast delivery.",
"metadata": {
"channel": "web",
"branch_code": "RUH-01"
}
}
'import requests
url = "https://business.papp.sa/api/v1/orders/earning/store-rating"
payload = {
"phone_number": "512345678",
"review_reference": "STORE-REVIEW-2026-0001",
"rating": 5,
"comment": "Great experience, fast delivery.",
"metadata": {
"channel": "web",
"branch_code": "RUH-01"
}
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
phone_number: '512345678',
review_reference: 'STORE-REVIEW-2026-0001',
rating: 5,
comment: 'Great experience, fast delivery.',
metadata: {channel: 'web', branch_code: 'RUH-01'}
})
};
fetch('https://business.papp.sa/api/v1/orders/earning/store-rating', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://business.papp.sa/api/v1/orders/earning/store-rating",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'phone_number' => '512345678',
'review_reference' => 'STORE-REVIEW-2026-0001',
'rating' => 5,
'comment' => 'Great experience, fast delivery.',
'metadata' => [
'channel' => 'web',
'branch_code' => 'RUH-01'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://business.papp.sa/api/v1/orders/earning/store-rating"
payload := strings.NewReader("{\n \"phone_number\": \"512345678\",\n \"review_reference\": \"STORE-REVIEW-2026-0001\",\n \"rating\": 5,\n \"comment\": \"Great experience, fast delivery.\",\n \"metadata\": {\n \"channel\": \"web\",\n \"branch_code\": \"RUH-01\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://business.papp.sa/api/v1/orders/earning/store-rating")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"phone_number\": \"512345678\",\n \"review_reference\": \"STORE-REVIEW-2026-0001\",\n \"rating\": 5,\n \"comment\": \"Great experience, fast delivery.\",\n \"metadata\": {\n \"channel\": \"web\",\n \"branch_code\": \"RUH-01\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://business.papp.sa/api/v1/orders/earning/store-rating")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"phone_number\": \"512345678\",\n \"review_reference\": \"STORE-REVIEW-2026-0001\",\n \"rating\": 5,\n \"comment\": \"Great experience, fast delivery.\",\n \"metadata\": {\n \"channel\": \"web\",\n \"branch_code\": \"RUH-01\"\n }\n}"
response = http.request(request)
puts response.read_body{
"status": true,
"message": "",
"appended_data": {},
"data": {
"id": 42,
"uuid": "550e8400-e29b-41d4-a716-446655440000",
"reference_number": "REF-2024-001234",
"order_status": "approved",
"status_label": "خرج للتوصيل",
"custom_status": {
"ar": "خرج للتوصيل",
"en": "Out for delivery"
},
"order_number": "ORD-2024-001234",
"type": 1,
"total_price": 150.5,
"total_points": 1505,
"metadata": {
"source": "mobile_app"
},
"date": "2024-12-23T00:00:00.000Z",
"time": "10:00:00",
"since": "2 hours ago",
"settlement_status": "settled",
"status": 1,
"created_at": "2024-12-23T10:00:00.000Z",
"updated_at": "2024-12-23T15:30:00.000Z",
"items": [
{
"product_name": "Cappuccino",
"product_price": 18.5,
"quantity": 2
}
]
}
}{
"status": false,
"message": "Invalid or inactive API key",
"appended_data": {}
}{
"status": false,
"message": "Invalid or inactive API key",
"appended_data": {}
}{
"status": false,
"message": "The given data was invalid.",
"appended_data": {},
"errors": {
"total_price": [
"The total price field is required."
],
"products.0.quantity": [
"The quantity must be at least 1."
]
}
}{
"status": false,
"message": "Invalid or inactive API key",
"appended_data": {}
}Authorizations
Body
Customer phone number. Accepted formats: +966XXXXXXXXX, 00966XXXXXXXXX, 966XXXXXXXXX, 0XXXXXXXXX, or bare 5XXXXXXXX. Normalised server-side to 5\d{8}.
"512345678"
Merchant-side unique identifier for this rating. Used as the idempotency key — sending the same value twice for the same merchant is rejected as a duplicate.
"STORE-REVIEW-2026-0001"
Star value submitted by the customer. Stored for audit only; does not change the points awarded.
1 <= x <= 55
Free-text review body. Stored for audit only.
"Great experience, fast delivery."
Optional metadata stored on the earning order.
{ "channel": "web", "branch_code": "RUH-01" }
Response
Points awarded successfully. When the customer's account is not yet activated, a pending_client_activation payload is returned instead of a full order resource.

