Updates an existing product with the provided information.

PATCH 
/api/company/:company_id/product/:product_id

Update a product by ID

Request

Path Parameters

company_id uuidrequired

The id of the company

product_id uuidrequired

The id of the product

application/json

Body

required

name stringrequired

The name of the product.

description stringrequired

The description of the product. Can be null.

Responses

200

Detailed information about the product

application/json

Schema

Schema

id uuidrequired

The unique identifier of the product.

name stringrequired

The name of the product.

company_id uuidrequired

The unique identifier of the company.

description stringrequired

The description of the product. Can be null.

images object[]required
An array of image URLs associated with the product.
Array [
id uuidrequired
The unique identifier of the product image.
company_id uuidrequired
The unique identifier of the company.
url urlrequired
The URL of the product image.
]

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "string",
  "company_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "description": "string",
  "images": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "company_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "url": "string"
    }
  ]
}

404

Company / Product not found

default

Unexpected error

application/json

Schema

Schema

code int32required

The error code

message stringrequired

A human-readable error message

Example (from schema)

{
  "code": 0,
  "message": "string"
}

Loading...