Skip to main content

Function: getProduct()

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

Gets product details by org, project, and product code.

Parameters​

client​

ApiClient

The API client instance

props​

The request properties

params​

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

Path parameters (orgName, projectName, productCode)

params.orgName​

string = orgNameSchema

params.projectName​

string = projectNameSchema

params.productCode​

string = productCodeSchema

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 product

Operation Id​

get-product