Typescript SDK Type Docs
    Preparing search index...

    Interface PriceImport

    Represents the data used to import an Embedded Price . Once imported, this data is persisted as a Price in a Product Variant.

    interface PriceImport {
        channel?: ChannelKeyReference;
        country?: string;
        custom?: Custom;
        customerGroup?: CustomerGroupKeyReference;
        discounted?: DiscountedPrice;
        key: string;
        product: ProductKeyReference;
        productVariant: ProductVariantKeyReference;
        staged?: boolean;
        tiers?: PriceTier[];
        validFrom?: string;
        validUntil?: string;
        value: TypedMoney;
    }

    Hierarchy (View Summary)

    Index

    Properties

    channel? country? custom? customerGroup? discounted? key product productVariant staged? tiers? validFrom? validUntil? value

    Properties

    channel?: ChannelKeyReference

    Maps to Price.channel. If the referenced Channel does not exist, the state of the ImportOperation will be set to unresolved until the referenced Channel is created.

    country?: string

    Maps to Price.county.

    custom?: Custom

    Maps to Price.custom.

    customerGroup?: CustomerGroupKeyReference

    Maps to Price.customerGroup. If the referenced CustomerGroup does not exist, the state of the ImportOperation will be set to unresolved until the referenced CustomerGroup is created.

    discounted?: DiscountedPrice

    Sets a discounted price from an external service.

    key: string

    User-defined unique identifier for the Embedded Price. If a Price with this key exists on the specified productVariant, it is updated with the imported data.

    product: ProductKeyReference

    The Product which contains the productVariant. If the referenced Product does not exist, the state of the ImportOperation will be set to unresolved until the referenced Product is created.

    productVariant: ProductVariantKeyReference

    The ProductVariant which contains this Embedded Price. If the referenced ProductVariant does not exist, the state of the ImportOperation will be set to unresolved until the referenced ProductVariant is created.

    staged?: boolean
    tiers?: PriceTier[]

    The tiered prices for this price.

    validFrom?: string

    Maps to Price.validFrom.

    validUntil?: string

    Maps to Price.validUntil.

    value: TypedMoney

    Maps to Price.value.

    Settings

    Member Visibility

    On This Page

    Properties