Skip to main content
PATCH
/
products
/
{id_or_slug}
Typescript (SDK)
import { Crevio } from "@crevio/sdk";

const crevio = new Crevio({
  apiKey: process.env["CREVIO_API_KEY"] ?? "",
});

async function run() {
  const result = await crevio.products.update({
    idOrSlug: "<value>",
    productRequest: {},
  });

  console.log(result);
}

run();
{
  "id": "<string>",
  "object": "<string>",
  "name": "<string>",
  "slug": "<string>",
  "status": "draft",
  "description": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "body_html": "<string>",
  "button_cta": "<string>",
  "url": "<string>",
  "available_from": "2023-11-07T05:31:56Z",
  "available_until": "2023-11-07T05:31:56Z",
  "published_at": "2023-11-07T05:31:56Z",
  "reviews_count": 123,
  "average_rating": 123,
  "media_gallery": [
    {
      "id": "<string>",
      "type": "<string>",
      "url": "<string>"
    }
  ],
  "price_variants": [
    {
      "id": "<string>",
      "object": "<string>",
      "name": "<string>",
      "amount": 123,
      "amount_type": "free",
      "billing_type": "subscription",
      "recurring_interval": "day",
      "interval_count": 123,
      "installment_count": 123,
      "setup_fee_amount": 123,
      "trial_period_days": 123,
      "revoke_after_days": 123,
      "quantity_available": 123,
      "archived": true,
      "position": 123,
      "hidden": true,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "currency": "<string>",
      "discounted_from_amount": 123,
      "minimum_amount": 123,
      "maximum_amount": 123,
      "preset_amount": 123,
      "waitlist": true,
      "purchase_url": "<string>",
      "product": "<string>",
      "benefits": [
        "<string>"
      ]
    }
  ],
  "seo": "<string>",
  "reviews": [
    {
      "id": "<string>",
      "object": "<string>",
      "rating": 123,
      "customer_name": "<string>",
      "content": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "customer_image_url": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

API key in the format: Bearer {api_token}

Path Parameters

id_or_slug
string
required

The resource prefix ID (e.g., "prod_abc123") or slug (e.g., "my-product")

Body

application/json
name
string
status
enum<string>
Available options:
draft,
active,
archived
description
string
body_html
string
slug
string
button_cta
string | null
available_from
string<date-time> | null
available_until
string<date-time> | null
tax_code
string | null

Response

Product updated

id
string
required
object
string
required
name
string
required
slug
string
required
status
enum<string>
required
Available options:
draft,
active,
archived
description
string
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
body_html
string
required
button_cta
string | null
required
url
string
required
available_from
string<date-time> | null
required
available_until
string<date-time> | null
required
published_at
string<date-time> | null
required
reviews_count
integer
required
average_rating
number | null
required
price_variants
object[]
required
seo

ID by default, full object when expanded

reviews
object[]