Skip to main content
PATCH
/
api
/
canary
/
products
/
{id}
Update Product
curl --request PATCH \
  --url http://localhost:3000/api/canary/products/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "metadata": {
    "sku": "PROD-001"
  }
}
'
{
  "statusCode": 400,
  "message": [
    "Invalid input data"
  ],
  "error": "Bad Request"
}

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

The unique identifier of the product

Body

application/json

Product update details

metadata
object
required

Optional custom metadata

Example:
{ "sku": "PROD-001" }
name
string

The name of the product

description
string

A description of the product

amount
number

The price of the product in the smallest currency unit

active
boolean

Whether the product is active

Response

Product updated successfully