Skip to main content
Activate or deactivate a product. Active products are purchasable; inactive products are hidden from checkout.
POST /v1/actions/onetime-product/update-status
Authentication: API Key

Request Body

FieldTypeRequiredDescription
idstringYesProduct ID (Short ID format PROD_xxx)
statusstringYesactive or inactive

Example Request

import { ProductVersionStatus } from "@waffo/pancake-ts";

const { product } = await client.onetimeProducts.updateStatus({
  id: "PROD_3kF9mNpQrStUvWxYz1A2bC",
  status: ProductVersionStatus.Inactive,
});

Success Response (200)

{
  "data": {
    "id": "PROD_3kF9mNpQrStUvWxYz1A2bC",
    "storeId": "STO_2aUyqjCzEIiEcYMKj7TZtw",
    "prodVersionId": null,
    "testVersionId": "PROD_7dG4hJkLmNpQrStUvWxYz1",
    "prodStatus": "inactive",
    "testStatus": "inactive",
    "createdAt": "2026-01-15T10:30:00.000Z",
    "updatedAt": "2026-01-15T13:00:00.000Z",
    "version": {
      "id": "PROD_7dG4hJkLmNpQrStUvWxYz1",
      "productId": "PROD_3kF9mNpQrStUvWxYz1A2bC",
      "versionNumber": 1,
      "name": "Premium Template Pack",
      "description": "50 premium design templates for your next project.",
      "prices": {
        "USD": { "amount": 4900, "taxIncluded": false, "taxCategory": "digital_goods" },
        "EUR": { "amount": 4500, "taxIncluded": true, "taxCategory": "digital_goods" }
      },
      "media": [
        { "type": "image", "url": "https://example.com/templates-preview.png", "alt": "Template preview" }
      ],
      "successUrl": "https://example.com/thank-you",
      "metadata": { "category": "design", "fileCount": "50" },
      "createdAt": "2026-01-15T10:30:00.000Z"
    }
  }
}

Response Fields

Same as Create Product response.
Setting a product to inactive hides it from checkout but does not affect existing orders. Customers who already purchased the product retain access.

Error Responses

StatusErrorDescription
400Missing required field: idid not provided
400Invalid status valuestatus is not active or inactive
400No version in current environmentProduct has no version in the current environment (test/prod)
404Product not foundProduct does not exist or is not accessible