Authorization
Example:
Authorization | Bearer Paste-Your-API-Key-HereRequest Body
ID of the payment link / product being reviewed. 3–100 characters.
Email of the customer leaving the review. Must be a valid email (5–100 characters) belonging to a
customer who has paid for the product.
Rating value. Integer between 1 and 5.
Optional review message. 1–2000 characters.
Optional list of media attachments (images and/or videos). Maximum 10 entries.
Identifier of the uploaded file to attach.
Media type of the attachment. One of
image or video.Identifier of the underlying file record, when applicable.
Response
Successful ResponseMain Structure (Root)
Status code returned by the API.
Status message that describes the status code.
"success" on success, "failed" when the
request body fails validation.The created review record. When
messages is "failed", this holds the validation detail
instead.data Structure (Object)
Unique review ID.
Rating value submitted by the customer.
Review message submitted by the customer.
Payment link ID associated with the review.
Unique customer identifier associated with the review.
Unique user ID associated with the payment link owner.
Current review status. New reviews are created with status
ACTIVE.Unix timestamp in milliseconds indicating when the review was created.
Unix timestamp in milliseconds indicating when the review was last updated.
Errors
Returned with
messages set to "failed" and data holding the validation detail when the
request body is invalid.Returned with
messages set to "Produk tidak ditemukan" when the product does not exist or is
not owned by the authenticated merchant.Returned with
messages set to "Anda belum pernah membeli produk ini" when the customer has no
paid transaction for the product.Returned with
messages set to "Anda sudah memberikan ulasan untuk produk ini, jika ingin mengedit ulasan, silahkan gunakan fitur edit ulasan" when the customer has already reviewed the
product.Returned with
messages set to "Gagal menambahkan ulasan" or "Terjadi kesalahan saat menambahkan ulasan" when the review cannot be saved.