Skip to main content

Function: updateProduct()

updateProduct(client, props): Promise<{ id: number; code: string; name: string; description: string; projectId: number; projectName: string; orgId: number; orgName: string; createdAt: string; updatedAt: string; referenceImages?: object[]; firstReferenceImageOid?: string | null; }>

Updates a product.

Parameters​

client​

ApiClient

The API client instance

props​

The request properties

params​

{ orgName: string; projectName: string; productCode: string; } = updateProductParamsSchema

Path parameters (orgName, projectName, productCode)

params.orgName​

string = orgNameSchema

params.projectName​

string = projectNameSchema

params.productCode​

string = productCodeSchema

body​

{ code?: string; name?: string; description?: string; } = updateProductBodySchema

Body with fields to update

body.code?​

string = ...

body.name?​

string = ...

body.description?​

string = ...

Returns​

Promise<{ id: number; code: string; name: string; description: string; projectId: number; projectName: string; orgId: number; orgName: string; createdAt: string; updatedAt: string; referenceImages?: object[]; firstReferenceImageOid?: string | null; }>

Promise resolving to the updated product

Operation Id​

update-product