Update product

Updates an existing product by its ID.

Path Parameters

ParameterTypeRequiredDescription
idintegerYesProduct unique identifier

Body Fields

FieldTypeRequiredDescription
namestringNoProduct name
referencestringNoProduct reference/SKU
descriptionstringNoProduct description
activebooleanNoWhether product is active
archivedbooleanNoWhether product is archived
urlstringNoExternal URL (e.g., supplier link)
tipsstringNoAdditional tips or notes
customFieldsobjectNoCustom field values
unityobjectNoUnit of measure: {"id": <unity_id>}
mediasarrayNoAssociated media files: [{"id": <media_id>}, ...]
pricesarrayNoUpdate existing prices (see below)

Updating Prices

To update existing prices, include the price id with the new price value:

"prices": [
  {"id": 1, "price": 99.99}
]

Note: To add new prices, use the Product Prices endpoints instead.

Response Fields

FieldTypeDescription
idintegerProduct unique identifier
namestringProduct name
referencestringProduct reference/SKU
descriptionstringProduct description
activebooleanWhether product is active
archivedbooleanWhether product is archived
urlstringExternal URL
tipsstringAdditional tips or notes
customFieldsobjectCustom field values
unityobjectUnit of measure
mediasarrayAssociated media files
pricesarrayProduct prices by category
requiredChildRelationsarrayRequired child products
createdAtdatetimeCreation timestamp
updatedAtdatetimeLast update timestamp

Response

  • 200 OK: Product successfully updated
  • 400 Bad Request: Invalid request body or validation error
  • 401 Unauthorized: Invalid or missing API key
  • 404 Not Found: Product not found
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required
Body Params
string
string
string
boolean
boolean
string
string
customFields
object
unity
object
medias
array of objects
medias
prices
array of objects
prices
Responses
200

Resource updated

400

Bad request

401

Unauthorized

404

Resource not found

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here!