Skip to content

tys.products.retrieve()

Method@tryyoursize/node

retrieve(idOrSku: string, options?: RequestOptions): Promise<Product>
idOrSkustringRequired

The product's TryYourSize ID or your SKU (URL-encoded for you, so TEE/01 works).

optionsRequestOptionsOptional

Promise<Product>: The product.

idstringRequired
external_idstringRequired

The brand's SKU or style ID (unique per brand).

namestringRequired
categoryGarmentCategoryRequired

The garment type; it sets which POMs are needed.

published_versionintegerOptional

Garment version shoppers are fitted against, if any.

draft_versionintegerOptional

Garment version being edited, if any.

created_atstringRequired
updated_atstringRequired
fit_group_idstringOptional

The fit group whose garment this product uses (absent until grouped).

brand_idstringOptional

The brand the product belongs to; every store of the brand sees it.

home_store_idstringOptional

The store the product was created in.

retired_atstringOptional

Set when the product is retired; shoppers no longer get a size for it.

availablebooleanOptional

Whether the store it was read through offers it (false in the brand list, see stores).

const product = await tys.products.retrieve("TEE-001"); // TryYourSize ID or your SKU

Was this page helpful?