Inttegro.Prices.EmbeddedProduct (inttegro v0.2.0)

Copy Markdown View Source

Represents Embedded Product data in the Prices API.

Inttegro decodes API responses into this struct. Required fields are always present; optional fields are nil when they do not apply or were not returned. Follow the linked types in t/0 for nested domain values.

Manages reusable catalog prices.

Prices express currency and integer minor-unit amounts and can be attached to products. Use a new price when commercial terms materially change so existing orders retain their original price history.

Summary

Types

t()

The decoded embedded product value.

Functions

Builds a Inttegro.Prices.EmbeddedProduct and raises KeyError when a required field is missing.

Types

t()

@type t() :: %Inttegro.Prices.EmbeddedProduct{
  about: String.t() | nil,
  active: boolean(),
  archived_at: String.t() | nil,
  attributes: [Inttegro.Prices.EmbeddedProductAttributesItem.t()] | nil,
  category: String.t() | nil,
  created_at: String.t(),
  custom_data: %{optional(String.t()) => String.t()} | nil,
  description: String.t() | nil,
  dimensions: %{optional(String.t()) => term()} | nil,
  id: String.t(),
  media: %{optional(String.t()) => term()} | nil,
  name: String.t(),
  published_at: String.t() | nil,
  reference: String.t() | nil,
  shipment: %{optional(String.t()) => term()} | nil,
  tax_code: String.t() | nil,
  type: Inttegro.Products.Type.t(),
  unit_dim: String.t() | nil,
  updated_at: String.t() | nil
}

The decoded embedded product value.

Functions

new!(attrs \\ %{})

@spec new!(map() | keyword()) :: t()

Builds a Inttegro.Prices.EmbeddedProduct and raises KeyError when a required field is missing.