Read product
GET
/v1/products/{productID}
What this endpoint does
INFO
Quick start
Authentication and permission
| Send | Permission | Community scope |
|---|---|---|
Authorization: Bearer <apiKey> | store | Community scope is derived from the key; do not send a community identifier. |
Complete examples
{pathParameter} and use the query parameters documented below.Success and readback
meta.code = PRODUCT_RETRIEVED{
"meta": {
"status": "success",
"statusCode": 200,
"code": "PRODUCT_RETRIEVED"
},
"message": "Read product successfully",
"data": {
"_id": "prd_agent_01",
"name": "Agent Test Voucher",
"category": {
"_id": "cat_agent_01",
"name": "Agent Test Rewards",
"displayOrder": 10
},
"price": 100,
"stocks": 2
}
}CHECK
Errors and recovery
meta.code, never message text.| HTTP | Machine code | What the caller should do | Retry? |
|---|---|---|---|
| 400 | VALIDATION_FAILED | Repair the path ID. | No, fix first |
| 401 | AUTH_API_KEY_REQUIRED | Add the Authorization header. | No, fix first |
| 401 | AUTH_API_KEY_INVALID | Replace or rotate the key. | No, fix first |
| 401 | AUTH_API_KEY_VALIDATION_FAILED | Authentication could not be completed. | Yes, with backoff |
| 403 | AUTH_PERMISSION_REQUIRED | Request the store permission; no resource data is returned. | No, fix first |
| 404 | STORE_RESOURCE_NOT_FOUND | Refresh the product list. | After refreshing the ID |
| 500 | INTERNAL_ERROR | Retry with exponential backoff and the same request context, then escalate. | Yes, with backoff |
Retry safety
TIP
Gotchas
Next steps
Request
Path Params
Query Params
Header Params
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://api.returning.ai/v1/products/507f1f77bcf86cd799439031?fields=name%2Cprice%2Ccategory%2Cstocks&lang=th' \
--header 'Authorization: Bearer XXXXXX'Response Response Example
200 - Success Example
{
"meta": {
"status": "success",
"statusCode": 200
},
"message": "Read product success.",
"data": {
"_id": "507f1f77bcf86cd799439031",
"communityID": "6502c9e514a3e564c5c09c0a",
"name": "Premium Voucher",
"description": "<p>Premium access reward.</p>",
"image": "https://example.com/images/premium-voucher.png",
"price": 100,
"category": "Premium Rewards",
"stocks": 2,
"discountPrice": 90,
"isDiscountEnabled": false,
"discountStartDate": null,
"discountEndDate": null,
"userInformation": {
"isEnabled": false,
"shouldCollectName": false,
"shouldCollectPhone": false,
"shouldCollectAddress": false
},
"shouldPrioritiesExpiringVouchers": false,
"shouldDisplayRemainingQuantity": true,
"expiringVoucherHighlight": {
"isEnabled": false,
"duration": 7,
"timeframe": "days"
},
"isArchived": false,
"totalOrders": 0,
"redemptionInstructions": "<p>Show this voucher at checkout.</p>",
"productPermission": [],
"isProductAccessEnabled": false,
"purchaseStatusOverride": {
"isEnabled": false,
"status": null
},
"createdAt": "2026-06-09T00:00:00.000Z",
"updatedAt": "2026-06-09T00:00:00.000Z"
}
}Modified at 2026-08-08 01:52:32