Interface PriceImport

The data representation for a price to be imported that is persisted as a Price in the Project.

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

Hierarchy (view full)

Properties

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

Properties

Optional Readonly channel

channel?: ChannelKeyReference

The Reference to the Channel with which the Price is associated. If referenced Channel does not exist, the state of the ImportOperation will be set to unresolved until the necessary Channel is created.

Optional Readonly country

country?: string

Maps to Price.county.

Optional Readonly custom

custom?: Custom

The custom fields for this price.

Optional Readonly customerGroup

customerGroup?: CustomerGroupKeyReference

The Reference to the CustomerGroup with which the Price is associated. If referenced CustomerGroup does not exist, the state of the ImportOperation will be set to unresolved until the necessary CustomerGroup is created.

Optional Readonly discounted

discounted?: DiscountedPrice

Sets a discounted price from an external service.

Readonly key

key: string

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

Readonly product

product: ProductKeyReference

The Product in which the Product Variant containing this Embedded Price is contained. Maps to ProductVariant.product. The Reference to the Product with which the Price is associated. If referenced Product does not exist, the state of the ImportOperation will be set to unresolved until the necessary Product is created.

Readonly productVariant

productVariant: ProductVariantKeyReference

The ProductVariant in which this Embedded Price is contained. The Reference to the ProductVariant with which the Price is associated. If referenced ProductVariant does not exist, the state of the ImportOperation will be set to unresolved until the necessary ProductVariant is created.

Optional Readonly publish

publish?: boolean

Only the Embedded Price updates will be published to staged and current projection.

Deprecated

Optional Readonly staged

staged?: boolean

Optional Readonly tiers

tiers?: PriceTier[]

The tiered prices for this price.

Optional Readonly validFrom

validFrom?: string

Maps to Price.validFrom.

Optional Readonly validUntil

validUntil?: string

Maps to Price.validUntil.

Readonly value

value: TypedMoney

Maps to Price.value.

Settings

Member Visibility

Theme

On This Page

channelcountrycustomcustomerGroupdiscountedkeyproductproductVariantpublishstagedtiersvalidFromvalidUntilvalue