Interface ProductVariantResponse<CustomFields>

A product variant on the product service

interface ProductVariantResponse {
    customFields: CustomFields;
    description: string;
    id: string;
    price: {
        amount: number;
        currency: string;
        taxIncluded: boolean;
        taxable: boolean;
    };
    sku: string;
    title: string;
}

Type Parameters

  • CustomFields = unknown

Properties

customFields description id price sku title

Properties

customFields

customFields: CustomFields

Custom fields defined for the product variant

description

description: string

The description of the product variant

id

id: string

The unique identifier for the product variant

price

price: {
    amount: number;
    currency: string;
    taxIncluded: boolean;
    taxable: boolean;
}

Price configuration for the product variant

Type declaration

  • amount: number

    The numerical amount for the price

  • currency: string

    The currency for the price (e.g. JPY)

  • taxIncluded: boolean

    Whether this price includes or excludes tax

  • taxable: boolean

    Whether this price is taxable

sku

sku: string

The SKU for the product variant

title

title: string

The name of the product variant

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc