api
products

Changed on

Update a Product

put/api/products/{id}

Request

  • Base URL: https://vivenu.com
  • URL: https://vivenu.com/api/products/{id}
  • Auth: one of:
    • HTTP bearer
    • API key in header Authorization

Path parameters

idstring required

The ID of the product to update

Request body

namestring required

The name of the product

descriptionstring nullable

The description of the product

imagestring nullable

The image of the product

type'voucher' | 'product' | 'donation' | 'membership' | 'addOn' required

The type of the product

categoryIdsstring[]

An array of categories to which the product belongs

activeboolean

Whether the product is active and can be distributed

metaobject

Custom key-value data. Metadata is useful for storing additional, structured information on an object.

isFulfillableboolean

Whether the product can be delivered

localizationobject

Localization of the product for multiple languages

Response

OK

_idstring required

The ID of the product

namestring required

The name of the product

activeboolean

Whether the product is active and can be distributed

isFulfillableboolean

Whether the product can be delivered

type'voucher' | 'product' | 'donation' | 'membership' | 'addOn' required

The type of the product

imagestring nullable

The image of the product

descriptionstring nullable

The description of the product

categoryIdsstring[]

An array of categories to which the product belongs

sellerIdstring required

The ID of the seller of the product

metaobject

Custom key-value data. Metadata is useful for storing additional, structured information on an object.

localizationobject

Localization of the product for multiple languages

createdAtstring date-time

An ISO timestamp indicating when the product was created

updatedAtstring date-time

An ISO timestamp indicating when the product was updated

archivedAtstring date-time

An ISO timestamp indicating when the product was archived

Changes

  • fa692dee8efbRevision changes
    • warning

      added the new product_variant_removal_not_allowed enum value to the response property for the response status

  • d81077450532Revision changes
    • info

      added the media type application/json for the response with the status

    • info

      added the optional property to the response with the status