Class Product

A product as published to PAPI in one context.

Inheritance

object

Product

Implements

IEquatable<Product>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Activout.Blue5

Assembly: Activout.Blue5.dll

Syntax

public sealed record Product : IEquatable<Product>

Remarks

Properties are init so you can build products yourself in tests.

Properties

Attributes

The product's attribute values, indexed by attribute number.

Declaration

public ProductAttributes Attributes { get; init; }

Property Value

Type	Description
ProductAttributes

Bundles

The products a Bundle consists of.

Declaration

public IReadOnlyList<ProductBundleItem> Bundles { get; init; }

Property Value

Type	Description
IReadOnlyList<ProductBundleItem>

Categories

Ids of the categories the product is assigned to.

Declaration

public IReadOnlyList<string> Categories { get; init; }

Property Value

Type	Description
IReadOnlyList<string>

CreateDate

When the product was created.

Declaration

public DateTimeOffset? CreateDate { get; init; }

Property Value

Type	Description
DateTimeOffset?

Description

Product description, if any.

Declaration

public string? Description { get; init; }

Property Value

Type	Description
string

GroupParentId

Id of the parent product when this belongs to a group.

Declaration

public string? GroupParentId { get; init; }

Property Value

Type	Description
string

Groups

Ids of the group members of this product.

Declaration

public IReadOnlyList<string> Groups { get; init; }

Property Value

Type	Description
IReadOnlyList<string>

Id

PIM-generated identifier.

Declaration

public required string Id { get; init; }

Property Value

Type	Description
string

Labels

Label names.

Declaration

public IReadOnlyList<string> Labels { get; init; }

Property Value

Type	Description
IReadOnlyList<string>

LastUpdate

When the product was last updated.

Declaration

public DateTimeOffset? LastUpdate { get; init; }

Property Value

Type	Description
DateTimeOffset?

Media

Media assets (images, documents, ...) attached to the product, in PAPI order.

Declaration

public IReadOnlyList<MediaAsset> Media { get; init; }

Property Value

Type	Description
IReadOnlyList<MediaAsset>

Metadata

Product metadata entries.

Declaration

public IReadOnlyList<ProductMetadata> Metadata { get; init; }

Property Value

Type	Description
IReadOnlyList<ProductMetadata>

Name

Product name in the current context.

Declaration

public string Name { get; init; }

Property Value

Type	Description
string

Number

Unique business key. Always a string; never treat it as numeric.

Declaration

public required string Number { get; init; }

Property Value

Type	Description
string

RelationSortingOrderSource

Where the order of the related products comes from.

Declaration

public RelationSortingOrderSource RelationSortingOrderSource { get; init; }

Property Value

Type	Description
RelationSortingOrderSource

Relations

Relations to other products.

Declaration

public IReadOnlyList<ProductRelation> Relations { get; init; }

Property Value

Type	Description
IReadOnlyList<ProductRelation>

Type

Product type.

Declaration

public ProductType Type { get; init; }

Property Value

Type	Description
ProductType

VariantParentId

Id of the parent product when this is a variant.

Declaration

public string? VariantParentId { get; init; }

Property Value

Type	Description
string

Variants

Ids of the variants of this product.

Declaration

public IReadOnlyList<string> Variants { get; init; }

Property Value

Type	Description
IReadOnlyList<string>

Implements

IEquatable<T>