Skip to main content

productV1

@bosonprotocol/metadata / Exports / productV1

Namespace: productV1

Table of contents​

Type Aliases​

Variables​

Functions​

Type Aliases​

ProductBase​

Ƭ ProductBase: Object

Type declaration​

NameType
descriptionstring
identification_productId?string
identification_productIdType?string
identification_sKU?string
packaging_dimensions_height?string
packaging_dimensions_length?string
packaging_dimensions_unit?string
packaging_dimensions_width?string
packaging_packageQuantity?string
packaging_weight_unit?string
packaging_weight_value?string
productionInformation_brandNamestring
productionInformation_manufacturer?string
productionInformation_manufacturerPartNumber?string
productionInformation_materials?string[]
productionInformation_modelNumber?string
titlestring
visuals_images{ tag?: string ; url: string }[]
visuals_videos?{ tag?: string ; url: string }[]

Defined in​

product-v1/index.ts:10


ProductV1Metadata​

Ƭ ProductV1Metadata: Object

Type declaration​

NameType
animationUrl?string
attributes{ display_type?: string ; trait_type: string ; value: string }[]
condition?string
descriptionstring
exchangePolicyExchangePolicy
externalUrlstring
imagestring
licenseUrlstring
namestring
productProductBase & ProductDetails & { uuid: string ; version: number }
productOverrides?Partial<ProductBase>
schemaUrlstring
sellerSellerMetadata
shippingShippingMetadata
type"PRODUCT_V1"
uuidstring
variations?Variation[]

Defined in​

product-v1/index.ts:89


ProductV1Variant​

Ƭ ProductV1Variant: Variation[]

Defined in​

product-v1/index.ts:117

Variables​

productV1MetadataSchema​

• Const productV1MetadataSchema: SchemaOf<ProductV1Metadata>

Defined in​

product-v1/index.ts:5

Functions​

buildUuid​

▸ buildUuid(): string

Returns​

string

Defined in​

product-v1/index.ts:208


createVariantProductMetadata​

▸ createVariantProductMetadata(productMetadata, variants): ProductV1Metadata[]

Parameters​

NameType
productMetadataProductV1Metadata
variants{ productOverrides?: Partial<ProductBase> ; productVariant: ProductV1Variant }[]

Returns​

ProductV1Metadata[]

Defined in​

product-v1/index.ts:119