Skip to main content

Function: createProduct()

createProduct(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; }>

Creates a new product in a project.

Parameters​

client​

ApiClient

The API client instance

props​

The request properties

params​

{ orgName: string; projectName: string; } = createProductParamsSchema

Path parameters (orgName, projectName)

params.orgName​

string = orgNameSchema

params.projectName​

string = projectNameSchema

body​

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

Request body with product details

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 created product

Operation Id​

create-product