Update product and append vouchers

PUT

/products/{productID}

Updates a product in the API-key community with a full product body and optionally appends new voucher codes to the same product.

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.

This is not a partial update: all request body properties are required. Submitted voucher codes are appended as new vouchers for the same product; existing vouchers are not updated, replaced, or deleted. If vouchers is empty, send vouchers: [] and voucherExpireDate: "". Duplicate voucher codes within the same product return 409.

Request

Path Params

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢200OK

application/json

Update product success.

Bodyapplication/json

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🔴500Server Error

🔴502Bad Gateway

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT 'https://adss-integration.returning.ai/apis/products/507f1f77bcf86cd799439031' \
--header 'Authorization: Bearer XXXXXX' \
--header 'Content-Type: application/json' \
--data '{
    "name": "Premium Voucher",
    "description": "<p>Premium access reward.</p>",
    "image": "https://example.com/images/premium-voucher.png",
    "price": 100,
    "categoryName": "Premium Rewards",
    "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,
    "redemptionInstructions": "<p>Show this voucher at checkout.</p>",
    "productPermission": [],
    "isProductAccessEnabled": false,
    "purchaseStatusOverrideName": null,
    "vouchers": [
        "VOUCHER-003",
        "VOUCHER-004"
    ],
    "voucherExpireDate": "2026-12-31T00:00:00.000Z"
}'

Response Example

200 - Success Example

{
    "meta": {
        "status": "success",
        "statusCode": 200
    },
    "message": "Update 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": 4,
        "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

Read product

Delete product