Skip to main content
POST
Create a product-rating earning order

Authorizations

x-api-key
string
header
required

Body

application/json
phone_number
string
required

Customer phone number. Accepted formats: +966XXXXXXXXX, 00966XXXXXXXXX, 966XXXXXXXXX, 0XXXXXXXXX, or bare 5XXXXXXXX. Normalised server-side to 5\d{8}.

Example:

"512345678"

review_reference
string
required

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.

Example:

"PRODUCT-REVIEW-2026-0001"

product_id
string
required

Merchant-side product identifier (SKU or internal ID) that the rating belongs to.

Example:

"SKU-CAPPUCCINO-250G"

product_name
string | null

Human-readable product name. Stored for audit.

Example:

"Cappuccino 250g"

rating
integer | null

Star value submitted by the customer. Stored for audit only; does not change the points awarded.

Required range: 1 <= x <= 5
Example:

4

comment
string | null

Free-text review body. Stored for audit only.

Example:

"Good aroma, smooth taste."

metadata
object | null

Optional metadata stored on the earning order.

Example:

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.

status
boolean
required
Example:

true

message
string | null
required
Example:

""

appended_data
object
required
Example:
data
object
required