Read product

GET

/products/{productID}

Returns one product from the API-key community using the public partner product contract.

The community is resolved from the API key; never send communityID. Product responses expose category as a readable name and hide internal-only fields, voucher codes, and custom redemption options.

Request

Path Params

Query Params

Header Params

Responses

🟢200OK

application/json

Read product success.

Bodyapplication/json

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🔴500Server Error

🔴502Bad Gateway

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://sgtr-integration.returning.ai/apis/products/507f1f77bcf86cd799439031?fields=name%2Cprice%2Ccategory%2Cstocks&lang=th' \
--header 'Authorization: Bearer XXXXXX'

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-06-11 10:14:56

Update products in bulk

Update product and append vouchers