Update

Update

curl --request PATCH \
  --url https://{defaultHost}/v1/products/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "product": {
    "name": "Updated Product"
  }
}
'

{
  "id": "f0d4b2d5-bd41-4fe4-af55-a2e08a8054b3",
  "object": "product",
  "allow_out_of_stock_purchases": false,
  "archived": false,
  "archived_at": null,
  "auto_fulfill_enabled": false,
  "available_stock": 0,
  "average_stars": "0.0",
  "description": null,
  "held_stock": 0,
  "featured": false,
  "licensing_enabled": false,
  "license_activation_limit": null,
  "metadata": {},
  "purchase_limit": null,
  "metrics": {
    "currency": "usd",
    "max_price_amount": 2900,
    "min_price_amount": 2900,
    "prices_count": 1
  },
  "name": "Updated Product",
  "recurring": true,
  "reviews_breakdown": {},
  "reviews_enabled": true,
  "shipping_enabled": false,
  "sku": null,
  "slug": "test-product",
  "solicit_reviews": true,
  "status": "draft",
  "stock": 0,
  "stock_enabled": false,
  "tax_enabled": false,
  "tax_category": "tangible",
  "weight": 0,
  "weight_unit": "lb",
  "commission_structure": null,
  "featured_product_media": null,
  "product_group": null,
  "current_release_download": null,
  "shipping_profile": null,
  "cataloged_at": 1767909738,
  "discarded_at": null,
  "created_at": 1767909738,
  "updated_at": 1767909738
}

PATCH

products

{id}

Update

curl --request PATCH \
  --url https://{defaultHost}/v1/products/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "product": {
    "name": "Updated Product"
  }
}
'

{
  "id": "f0d4b2d5-bd41-4fe4-af55-a2e08a8054b3",
  "object": "product",
  "allow_out_of_stock_purchases": false,
  "archived": false,
  "archived_at": null,
  "auto_fulfill_enabled": false,
  "available_stock": 0,
  "average_stars": "0.0",
  "description": null,
  "held_stock": 0,
  "featured": false,
  "licensing_enabled": false,
  "license_activation_limit": null,
  "metadata": {},
  "purchase_limit": null,
  "metrics": {
    "currency": "usd",
    "max_price_amount": 2900,
    "min_price_amount": 2900,
    "prices_count": 1
  },
  "name": "Updated Product",
  "recurring": true,
  "reviews_breakdown": {},
  "reviews_enabled": true,
  "shipping_enabled": false,
  "sku": null,
  "slug": "test-product",
  "solicit_reviews": true,
  "status": "draft",
  "stock": 0,
  "stock_enabled": false,
  "tax_enabled": false,
  "tax_category": "tangible",
  "weight": 0,
  "weight_unit": "lb",
  "commission_structure": null,
  "featured_product_media": null,
  "product_group": null,
  "current_release_download": null,
  "shipping_profile": null,
  "cataloged_at": 1767909738,
  "discarded_at": null,
  "created_at": 1767909738,
  "updated_at": 1767909738
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

string

required

Body

application/json

product

object

Show child attributes

Response

200 - application/json

Success

string | null

The UUID of the specific object.

object

string

A string describing the object type returned.

allow_out_of_stock_purchases

boolean

Whether or not to allow purchases of this product when stock runs out. If true, the stock levels for this can go below zero.

archived

boolean

Whether or not this product is archived.

auto_fulfill_enabled

boolean

Whether or not this product should be auto fulfilled when it is purchased. This can only be true when shipping_enabled is false.

cataloged_at

integer

The time when the product was added or made available. This value is used for sorting products on shop pages.

description

string | null

The product description, meant to be displayable to the customer.

featured

boolean

Whether or not this product is featured.

licensing_enabled

boolean

Whether or not licensing is enabled for this product.

license_activation_limit

integer | null

The max number of activations allowed per license. If null, then unlimited license activations are allowed. (The activation limit can also be set on Price which will override this value.)

name

string

The product name, meant to be displayable to the customer.

purchase_limit

integer | null

The max number of times the product can be purchased by a customer. If null, then unlimited purchases are allowed.

recurring

boolean

default:false

Whether the product is for a one-time purchase or a recurring (subscription) purchase.

reviews_enabled

boolean

Whether or not reviews are enabled for this product.

shipping_enabled

boolean

If set to true checkouts with this product will require a full shipping address.

sku

string | null

The stock keeping unit for this product. If the Product has variants, each variant has a specific sku.

status

string

The status of this product – one of draft or published.

slug

string

A unique and URL friendly string that represents this product. (This will be auto-generated when a product is created if not explicitly set.)

solicit_reviews

boolean

Whether or not to solicit reviews for this product with automatic emails to customers.

stock_enabled

boolean

Whether or not stock will be tracked for this product.

tax_category

string | null

The tax category/code that matches this product – one of digital, tangible, service, or saas.

tax_enabled

boolean

If set to true this product is considered taxable.

weight

number

The product weight, meant to be displayable to the customer.

weight_unit

string

The weight unit for this product – one of lb, oz, kg, g.

metadata

object

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

archived_at

integer | null

Time at which the object was archived. Measured in seconds since the Unix epoch.

available_stock

integer

The total amount of stock available for purchase. This is the total stock on hand minus held_stock.

average_stars

string

The average stars for this product based on published reviews.

commission_structure

Expandable – The associated commission structure ID.

current_release_download

Expandable – The associated download ID.

held_stock

integer

The total amount of stock being held by unfulfilled line items.

metrics

object

Show child attributes

downloads

Expandable – Property not returned unless expanded.

reviews_breakdown

object

A histogram breakdown of the reviews for this product.

featured_product_media

The featured (first) product media.

Expandable – The associated product media ID.

prices

Expandable – Property not returned unless expanded.

product_collections

Expandable – Property not returned unless expanded.

product_group

Expandable – The associated product group ID.

product_medias

Expandable – Property not returned unless expanded.

shipping_profile

Expandable – The associated shipping profile ID.

stock

integer

The total amount of stock on hand for this variant.

reviews

Expandable – Property not returned unless expanded.

variant_options

Expandable – Property not returned unless expanded.

variants

Expandable – Property not returned unless expanded.

discarded_at

integer | null

Time at which the object was discarded. Measured in seconds since the Unix epoch.

created_at

integer | null

Time at which the object was created. Measured in seconds since the Unix epoch.

updated_at

integer | null

Time at which the object was last updated. Measured in seconds since the Unix epoch.

Delete Duplicate

⌘I

Overview

Core Endpoints

Customers

Products

Orders & Payments

Subscriptions

Shipping & Fulfillment

Tax

Affiliates

Licensing

Public Endpoints

Authorizations

Path Parameters

Body

Response