1. Products
Returning.AI
  • Getting Started
  • Authentication
    • Secure Auth
      GET
    • register
      POST
    • verify email
      POST
    • login
      POST
    • Secure Auth
      GET
  • Users
    • Get Users with Filters
      POST
    • Create New User
      POST
    • Get User Data Copy
      POST
    • Manage User Account
      POST
    • Get User Gamification Stats
      POST
    • Get all mini game logs by user email
      POST
    • Get user's current Mini Games and Streak stats
      POST
    • Upload User Avatar
      POST
  • Roles & Permissions
    • role list of server
      GET
    • create new role
      POST
    • update role
      PUT
    • delete role
      DELETE
    • get role list of user on a server
      GET
    • add role to a user on a server
      POST
    • remove role from a user on a server
      POST
  • Servers
    • create new server
    • get my servers
    • update server
  • Channels
  • Messaging
    • Get Messages
    • Send Message
    • Reply Message
    • React Message
    • Upload Image
  • User Data
    • Get Specific User Field
    • Update Custom User Field
    • Delete Custom User Field
    • Get all user field histories in a community
    • Get user field histories for a specific field
    • Get user field histories for a specific user
    • Get user field histories of specific user field and user
    • Create user field history for specific user
  • Gamification
    • get badges list
    • create new badge
    • update badge
    • delete badge
    • remove badge from user
    • award badge to user
    • Get Tier Info
    • Get User Gamification History
    • Get User Gamification Logs
  • Streaks & Mini Games
    • Get Streak Logs
    • Edit wheel information for each user
    • Edit wheel information for each user
  • Rewards & Redemptions
    • Update redemption transaction status
    • Get all redemption transactions by user email
    • Get All Redemption Statuses
    • Get Redemption Status by ID
    • Get all redemption transactions by Community
    • Create Redemption Status
    • Get redemption transaction status history
  • Chart Analysis
    • Create Analysis
    • Get Analysis
    • Update Analysis
    • Delete Analysis
    • List Analyses
    • Append Drawings
  • Bulk Operations
    • Bulk Import
    • Get All Bulk Update
    • Check Bulk Update Status
    • Check Bulk Update Details
    • Bulk Update Copy
    • Premium Currency Bulk Update
  • Application API
    • Community Users
      • Get community users
      • Get user
  • Integration API
  • Channels
    • Iframe
    • channel list of server
    • get channels list
    • create new channel
    • update channel
    • delete channel
    • Get Channels List
  • Events
    • Outgoing webhooks
      • Encryption
      • User Joins Server
      • User Visits server
      • New Message Posted Anywhere
      • New Message Posted To channel
      • Purchased Store Item
    • Incoming webhooks
      • API Keys & Encryption
      • Send message into channels
      • Update Custom User Fields
      • Update In-game currency
  • Widgets
    • Authenticated Widgets
    • Public widgets
  • Features
  • Community Analytics
    • Get Loyalty Overview
  • Partner API
    • Leaderboards
      • List leaderboards with pagination
      • Create a new leaderboard
      • Get a single leaderboard by ID
      • Update an existing leaderboard
      • Delete a leaderboard
    • Purchase History
      • Update purchase history redemption instructions
    • Personalization Service
      • Appearance
        • Theme Color Form Update
        • Server Bot
        • Meta
        • Name & Uri
    • Store
      • Get store configuration
      • Update store configuration
    • Categories
      • List store categories
      • Create store category
      • Update store category
      • Delete store category
      • Get store category by ID
    • Products
      • List store products
        GET
      • Create store product
        POST
      • Update store product
        PUT
      • Delete store product
        DELETE
      • Get store product by ID
        GET
  • Community
  • Schemas
    • Sample Schemas
    • Schemas
    • Outgoing webhooks
    • Analysis
    • Pet
    • ValidationError
    • Purchased store item
    • UpdateAnalysisRequest
    • Category
    • NotFoundError
    • New message posted to channel
    • AppendDrawingsRequest
    • Tag
    • InternalServerError
    • User visits server
    • CreateAnalysisResponse
    • NotImplementedError
    • User join server
    • GetAnalysisResponse
    • CreateUserFieldHistoryResponse
    • ErrorResponse
    • UpdateAnalysisResponse
    • CreateUserFieldHistorySuccessResponse
    • AppendDrawingsResponse
    • UserFieldHistoryItem
    • AnalysisMetadata
    • GetUserFieldHistoriesResponse
    • Expiry
    • UserFieldHistoriesValidationError
    • Levels
    • UserFieldHistoriesMetaWithValidation
    • LevelEntry
    • UserFieldHistoriesMetaWithPagination
    • Drawing
    • GetUserFieldHistoriesSuccessResponse
    • HorizontalLineDrawing
    • CreateUserFieldResponse
    • LineDrawing
    • CreateUserFieldSuccessResponse
    • RectangleDrawing
    • DeleteUserFieldResponse
    • ParallelDrawing
    • DeleteUserFieldSuccessResponse
    • FibonacciRetracementDrawing
    • UserFieldCreator
    • Coordinate
    • GetUserFieldResponse
    • DrawingStyle
    • GetUserFieldSuccessResponse
    • AnalysisDetail
    • ValidationErrorItem
    • AnalysisSummary
    • GetUserFieldsMetaResponse
    • CreateAnalysisRequest
    • CreatorInfo
    • ListAnalysesResponse
    • UserFieldResponse
    • GetUserFieldsSuccessResponse
    • UpdateUserFieldResponse
    • UpdateUserFieldPayload
    • UpdateUserFieldSuccessResponse
    • MetaResponse
    • GetUserResponse
    • GetUserSuccessResponse
  1. Products

Get store product by ID

GET
/products/{productID}
Returns one active store product from the API-key's community by product ID, with optional partner-safe field projection and translation language.
Use this when a partner integration needs product detail for a storefront product page, reward detail view, or redemption flow.
Authentication:
Bearer API key in Authorization header
API key must have the store permission
Community is resolved from the API key token — do not pass communityID
Returns 401 if the key is missing, invalid, or expired
Returns 403 if the key does not include the store permission
Rate limits:
Standard API rate limits apply
Constraints:
productID must be a valid product identifier accepted by the source store service
fields is a comma-separated projection using partner-safe selectable product fields; productPermission and __v are not public fields
lang selects translated product fields when localized content is configured
Invalid IDs or unsupported projection fields return 400
Missing products return 404 when the source service reports not found
Upstream store-service failures return 502
Example — read:
{ "path": "/products/507f1f77bcf86cd799439031", "query": "?fields=name,price,type&lang=th" }
Related endpoints:
GET /stores — read store configuration
GET /categories — list store categories
GET /categories/{categoryID} — read a single store category
GET /products — list active store products

Request

Path Params

Query Params

Header Params

Responses

🟢200OK
application/json
Store product returned successfully
Body

🟠400Bad Request
🟠401Unauthorized
🟠403Forbidden
🟠404Record Not Found
🔴500Server Error
🔴502Bad Gateway
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.returning.ai/v1/products/507f1f77bcf86cd799439031?fields=name,price,type&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>Redeem for premium access.</p>",
        "image": "https://example.com/product.png",
        "price": 100,
        "type": "voucher",
        "categoryID": "650906d314a3e564c56f3450",
        "stocks": 45,
        "discountPrice": 90,
        "isDiscountEnabled": false,
        "discountStartDate": "2026-04-28T00:00:00.000Z",
        "discountEndDate": "2026-05-28T00:00:00.000Z",
        "userInformation": {
            "isEnabled": false
        },
        "shouldPrioritiesExpiringVouchers": false,
        "shouldDisplayRemainingQuantity": true,
        "expiringVoucherHighlight": {
            "isEnabled": false
        },
        "isArchived": false,
        "totalOrders": 12,
        "displayOrder": 0,
        "redemptionInstructions": "<p>Show this voucher at checkout.</p>",
        "i18n": {
            "nameTranslations": []
        },
        "customOptions": {
            "isEnabled": false
        },
        "isProductAccessEnabled": false,
        "purchaseStatusOverride": {
            "isEnabled": false,
            "statusID": null
        },
        "createdAt": "2026-04-28T00:00:00.000Z",
        "updatedAt": "2026-04-28T00:00:00.000Z"
    }
}
Modified at 2026-04-28 10:42:39
Previous
Delete store product
Next
Pet
Built with