SEO.JSONLD.OrderItem (SEO v0.3.0-rc.0)

View Source

An order item is a line of an order. It includes the quantity and shipping details of a bought offer.

Helper for building a Schema.org OrderItem JSON-LD structure.

Summary

Types

attrs()
t()

A JSON-LD map ready to be nested or rendered. String-keyed, always includes "@type" set to "OrderItem", plus any camelCased field keys the caller provided (see build/1). "@context" is added at render time by SEO.JSONLD.meta/1 on the top-level node only.

Functions

build(attrs)

Build a OrderItem JSON-LD map.

Types

attrs()

@type attrs() ::
  %{
    optional(:order_delivery) => SEO.JSONLD.ParcelDelivery.t() | map(),
    optional(:order_item_number) => String.t(),
    optional(:order_item_status) =>
      :order_cancelled
      | :order_delivered
      | :order_in_transit
      | :order_payment_due
      | :order_pickup_available
      | :order_problem
      | :order_processing
      | :order_returned,
    optional(:order_quantity) =>
      SEO.JSONLD.QuantitativeValue.t() | map() | number(),
    optional(:ordered_item) =>
      SEO.JSONLD.Product.t() | map() | SEO.JSONLD.Service.t() | t(),
    optional(:additional_type) => String.t() | URI.t(),
    optional(:alternate_name) => String.t(),
    optional(:description) => SEO.JSONLD.TextObject.t() | map() | String.t(),
    optional(:disambiguating_description) => String.t(),
    optional(:identifier) =>
      String.t() | URI.t() | SEO.JSONLD.PropertyValue.t() | map(),
    optional(:image) =>
      URI.t() | String.t() | SEO.JSONLD.ImageObject.t() | map(),
    optional(:main_entity_of_page) =>
      SEO.JSONLD.CreativeWork.t() | map() | URI.t() | String.t(),
    optional(:name) => String.t(),
    optional(:owner) =>
      SEO.JSONLD.Organization.t() | map() | SEO.JSONLD.Person.t(),
    optional(:potential_action) => SEO.JSONLD.Action.t() | map(),
    optional(:same_as) => URI.t() | String.t(),
    optional(:subject_of) =>
      SEO.JSONLD.Event.t() | map() | SEO.JSONLD.CreativeWork.t(),
    optional(:url) => URI.t() | String.t()
  }
  | [
      order_delivery: SEO.JSONLD.ParcelDelivery.t() | map(),
      order_item_number: String.t(),
      order_item_status:
        :order_cancelled
        | :order_delivered
        | :order_in_transit
        | :order_payment_due
        | :order_pickup_available
        | :order_problem
        | :order_processing
        | :order_returned,
      order_quantity: SEO.JSONLD.QuantitativeValue.t() | map() | number(),
      ordered_item:
        SEO.JSONLD.Product.t() | map() | SEO.JSONLD.Service.t() | t(),
      additional_type: String.t() | URI.t(),
      alternate_name: String.t(),
      description: SEO.JSONLD.TextObject.t() | map() | String.t(),
      disambiguating_description: String.t(),
      identifier: String.t() | URI.t() | SEO.JSONLD.PropertyValue.t() | map(),
      image: URI.t() | String.t() | SEO.JSONLD.ImageObject.t() | map(),
      main_entity_of_page:
        SEO.JSONLD.CreativeWork.t() | map() | URI.t() | String.t(),
      name: String.t(),
      owner: SEO.JSONLD.Organization.t() | map() | SEO.JSONLD.Person.t(),
      potential_action: SEO.JSONLD.Action.t() | map(),
      same_as: URI.t() | String.t(),
      subject_of: SEO.JSONLD.Event.t() | map() | SEO.JSONLD.CreativeWork.t(),
      url: URI.t() | String.t()
    ]

t()

@type t() :: %{required(String.t()) => term()}

A JSON-LD map ready to be nested or rendered. String-keyed, always includes "@type" set to "OrderItem", plus any camelCased field keys the caller provided (see build/1). "@context" is added at render time by SEO.JSONLD.meta/1 on the top-level node only.

Functions

build(attrs)

@spec build(attrs()) :: t()

Build a OrderItem JSON-LD map.

Fields

  • :order_delivery - The delivery of the parcel related to this order or order item.
  • :order_item_number - The identifier of the order item.
  • :order_item_status - The current status of the order item. One of: :order_cancelled, :order_delivered, :order_in_transit, :order_payment_due, :order_pickup_available, :order_problem, :order_processing, :order_returned.
  • :order_quantity - The number of the item ordered. If the property is not set, assume the quantity is one.
  • :ordered_item - The item ordered.

Inherited properties

Additional properties are available through the inheritance chain. See each ancestor's docs for its properties: