Alumio entity schemas

Index

Interfaces

Type aliases

Boolean

Boolean: boolean

Boolean: True or False.

see: https://schemas.alumio.com/Boolean.jsd

Date

Date: string

A date value in ISO 8601 date format.

see: https://schemas.alumio.com/Date.jsd

DateTime

DateTime: string

A combination of date and time of day in the form [-]CCYY-MM-DDThh:mm:ss[Z|(+|-)hh:mm] (see Chapter 5.4 of ISO 8601).

see: https://schemas.alumio.com/DateTime.jsd

Integer

Integer: number

Data type: Integer.

see: https://schemas.alumio.com/Integer.jsd

Number

Number: number

Data type: Number.

see: https://schemas.alumio.com/Number.jsd

Text

Text: string

Data type: Text.

see: https://schemas.alumio.com/Text.jsd

URL

URL: string

Data type: URL.

see: https://schemas.alumio.com/URL.jsd

acceptedOffer_type

acceptedOffer_type: Offer | Offer[]

The offer(s) -- e.g., product, quantity and price combinations -- included in the order.

(Non-Normative): Property of:

Order

see: https://schemas.alumio.com/acceptedOffer.prop.jsd

additionalProperty_type

additionalProperty_type: PropertyValue | PropertyValue[]

A property-value pair representing an additional characteristics of the entity, e.g. a product feature or another characteristic for which there is no matching property in schema.org.

(Non-Normative): Property of:

see: https://schemas.alumio.com/additionalProperty.prop.jsd

additionalType_type

additionalType_type: URL | URL[]

An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in.

(Non-Normative): Property of:

Thing

see: https://schemas.alumio.com/additionalType.prop.jsd

addressCountry_type

addressCountry_type: Text

The country, as two-letter ISO 3166-1 alpha-2 country code. For example, NL.

(Non-Normative): Property of:

PostalAddress

see: https://schemas.alumio.com/addressCountry.prop.jsd

addressLocality_type

addressLocality_type: Text

The locality in which the street address is, and which is in the region. For example, Mountain View.

(Non-Normative): Property of:

PostalAddress

see: https://schemas.alumio.com/addressLocality.prop.jsd

addressRegion_type

addressRegion_type: Text

The country, ISO 3166-2 country state code. For example, NL-GR.

(Non-Normative): Property of:

PostalAddress

see: https://schemas.alumio.com/addressRegion.prop.jsd

address_type

address_type: PostalAddress | PostalAddress[]

Physical address of the item.

Extends identifier

(Non-Normative): Property of:

see: https://schemas.alumio.com/address.prop.jsd

aggregateRating_type

aggregateRating_type: Text

The overall rating, based on a collection of reviews or ratings, of the item.

(Non-Normative): Property of:

Product

see: https://schemas.alumio.com/aggregateRating.prop.jsd

availabilityEnds_type

availabilityEnds_type: DateTime

The end of the availability of the product or service included in the offer.

(Non-Normative): Property of:

Offer

see: https://schemas.alumio.com/availabilityEnds.prop.jsd

availabilityStarts_type

availabilityStarts_type: DateTime

The beginning of the availability of the product or service included in the offer.

(Non-Normative): Property of:

Offer

see: https://schemas.alumio.com/availabilityStarts.prop.jsd

availability_type

availability_type: Text

The availability of this item—for example In stock, Out of stock, Pre-order, etc.

(Non-Normative): Property of:

Offer

see: https://schemas.alumio.com/availability.prop.jsd

availableAtOrFrom_type

availableAtOrFrom_type: Text | Text[]

The place(s) from which the offer can be obtained (e.g. store locations).

(Non-Normative): Property of:

Offer

see: https://schemas.alumio.com/availableAtOrFrom.prop.jsd

award_type

award_type: Text | Text[]

An award won by or for this item.

(Non-Normative): Property of:

Product

see: https://schemas.alumio.com/award.prop.jsd

billingAddress_type

billingAddress_type: PostalAddress

The billing address for the order.

(Non-Normative): Property of:

Order

see: https://schemas.alumio.com/billingAddress.prop.jsd

birthDate_type

birthDate_type: Date

Date of birth.

(Non-Normative): Property of:

Person

see: https://schemas.alumio.com/birthDate.prop.jsd

brand_type

brand_type: Text | Text[]

The brand(s) associated with a product or service, or the brand(s) maintained by an organization or business person.

(Non-Normative): Property of:

Product

see: https://schemas.alumio.com/brand.prop.jsd

broker_type

broker_type: Organization | Person

An entity that arranges for an exchange between a buyer and a seller. In most cases a broker never acquires or releases ownership of a product or service involved in an exchange. If it is not clear whether an entity is a broker, seller, or buyer, the latter two terms are preferred. Supersedes bookingAgent.

(Non-Normative): Property of:

Order

see: https://schemas.alumio.com/broker.prop.jsd

category_type

category_type: ItemList | ItemList[]

A category for the item.

(Non-Normative): Property of:

Product

see: https://schemas.alumio.com/category.prop.jsd

color_type

color_type: Text | Text[]

The color of the product.

(Non-Normative): Property of:

Product

see: https://schemas.alumio.com/color.prop.jsd

confirmationNumber_type

confirmationNumber_type: Text

A number that confirms the given order or payment has been received.

(Non-Normative): Property of:

Order

see: https://schemas.alumio.com/confirmationNumber.prop.jsd

contactPerson_type

contactPerson_type: Person | Person[]

The person who can be contacted of an address.

Extends identifier

(Non-Normative): Property of:

ContactPoint

see: https://schemas.alumio.com/contactPerson.prop.jsd

contactPoint_type

contactPoint_type: ContactPoint | ContactPoint[]

A contact point for a person or organization.

Extends identifier

(Non-Normative): Property of:

Organization

see: https://schemas.alumio.com/contactPoint.prop.jsd

contactType_type

contactType_type: Text | Text[]

A person or organization can have different contact points, for different purposes. For example, a sales contact point, a PR contact point and so on. This property is used to specify the kind of contact point.

(Non-Normative): Property of:

ContactPoint

see: https://schemas.alumio.com/contactType.prop.jsd

countryOfOrigin_type

countryOfOrigin_type: Text

The country of origin.

(Non-Normative): Property of:

Product

see: https://schemas.alumio.com/countryOfOrigin.prop.jsd

customerGroup_type

customerGroup_type: Text | StructuredValue | (Text | StructuredValue)[]

The group which a Customer belongs.

(Non-Normative): Property of:

Customer

see: https://schemas.alumio.com/customerGroup.prop.jsd

customer_type

customer_type: Customer

Party placing the order or paying the invoice.

(Non-Normative): Property of:

Order

see: https://schemas.alumio.com/customer.prop.jsd

deliveryAddress_type

deliveryAddress_type: PostalAddress

The delivery address for the order.

(Non-Normative): Property of:

ParcelDelivery

see: https://schemas.alumio.com/deliveryAddress.prop.jsd

deliveryPrice_type

deliveryPrice_type: Number | Text

The costs of of the delivery.

(Non-Normative): Property of:

ParcelDelivery

see: https://schemas.alumio.com/deliveryPrice.prop.jsd

deliveryStatus_type

deliveryStatus_type: Text

The delivery status.

(Non-Normative): Property of:

ParcelDelivery

see: https://schemas.alumio.com/deliveryStatus.prop.jsd

deliveryTax_type

deliveryTax_type: Number | Text

The tax costs of of the delivery.

(Non-Normative): Property of:

ParcelDelivery

see: https://schemas.alumio.com/deliveryTax.prop.jsd

department_type

department_type: Text | Text[]

A specific department in the organization.

Extends identifier

(Non-Normative): Property of:

Organization

see: https://schemas.alumio.com/department.prop.jsd

depth_type

depth_type: QuantitativeValue

The depth of the item.

(Non-Normative): Property of:

Product

see: https://schemas.alumio.com/depth.prop.jsd

description_type

description_type: Text | Text[]

A description of the item.

(Non-Normative): Property of:

Thing

see: https://schemas.alumio.com/description.prop.jsd

discountCode_type

discountCode_type: Text

Code used to redeem a discount.

(Non-Normative): Property of:

Order

see: https://schemas.alumio.com/discountCode.prop.jsd

discountCurrency_type

discountCurrency_type: Text

The currency of the discount.

(Non-Normative): Property of:

Order

see: https://schemas.alumio.com/discountCurrency.prop.jsd

discount_type

discount_type: Number | Text

Any discount applied (to an Order).

(Non-Normative): Property of:

Order

see: https://schemas.alumio.com/discount.prop.jsd

email_type

email_type: Text | Text[]

Email address.

(Non-Normative): Property of:

see: https://schemas.alumio.com/email.prop.jsd

expectedArrivalFrom_type

expectedArrivalFrom_type: DateTime

The earliest date the package may arrive.

(Non-Normative): Property of:

ParcelDelivery

see: https://schemas.alumio.com/expectedArrivalFrom.prop.jsd

expectedArrivalUntil_type

expectedArrivalUntil_type: DateTime

The latest date the package may arrive.

(Non-Normative): Property of:

ParcelDelivery

see: https://schemas.alumio.com/expectedArrivalUntil.prop.jsd

familyName_type

familyName_type: Text

Family name. In the U.S., the last name of a Person.

(Non-Normative): Property of:

Person

see: https://schemas.alumio.com/familyName.prop.jsd

faxNumber_type

faxNumber_type: Text | Text[]

The fax number.

(Non-Normative): Property of:

see: https://schemas.alumio.com/faxNumber.prop.jsd

gender_type

gender_type: Text

Gender of something, typically a Person, but possibly also fictional characters, animals, etc. It can be Male/Female/Unknown/Not Specified.

(Non-Normative): Property of:

Person

see: https://schemas.alumio.com/gender.prop.jsd

givenName_type

givenName_type: Text

Given name. In the U.S., the first name of a Person.

(Non-Normative): Property of:

Person

see: https://schemas.alumio.com/givenName.prop.jsd

gtin12_type

gtin12_type: Text | Text[]

The GTIN-12 code of the product.

(Non-Normative): Property of:

Product

see: https://schemas.alumio.com/gtin12.prop.jsd

gtin13_type

gtin13_type: Text | Text[]

The GTIN-13 code of the product.

(Non-Normative): Property of:

Product

see: https://schemas.alumio.com/gtin13.prop.jsd

gtin14_type

gtin14_type: Text | Text[]

The GTIN-14 code of the product.

(Non-Normative): Property of:

Product

see: https://schemas.alumio.com/gtin14.prop.jsd

gtin8_type

gtin8_type: Text | Text[]

The GTIN-8 code of the product.

(Non-Normative): Property of:

Product

see: https://schemas.alumio.com/gtin8.prop.jsd

gtin_type

gtin_type: Text | Text[]

A global trade number.

(Non-Normative): Property of:

Product

see: https://schemas.alumio.com/gtin.prop.jsd

hasDeliveryMethod_type

hasDeliveryMethod_type: Text

Method used for delivery or shipping.

(Non-Normative): Property of:

ParcelDelivery

see: https://schemas.alumio.com/hasDeliveryMethod.prop.jsd

height_type

height_type: QuantitativeValue

The height of the item.

(Non-Normative): Property of:

see: https://schemas.alumio.com/height.prop.jsd

honorificPrefix_type

honorificPrefix_type: Text

An honorific prefix preceding a Person's name such as Dr/Mrs/Mr.

(Non-Normative): Property of:

Person

see: https://schemas.alumio.com/honorificPrefix.prop.jsd

identifier_type

identifier_type: PropertyValue | Text | URL

The identifier property represents any kind of identifier for any kind of Thing, such as ISBNs, GTIN codes, UUIDs etc.

(Non-Normative): Known subproperties:

(Non-Normative): Property of:

Thing

see: https://schemas.alumio.com/identifier.prop.jsd

image_type

image_type: URL | URL[]

An image of the item. This can be a URL or a fully described ImageObject.

(Non-Normative): Property of:

Thing

see: https://schemas.alumio.com/image.prop.jsd

inventoryLevel_type

inventoryLevel_type: QuantitativeValue

The current approximate inventory level for the item or items.

(Non-Normative): Property of:

Offer

see: https://schemas.alumio.com/inventoryLevel.prop.jsd

isGift_type

isGift_type: Text

Was the offer accepted as a gift for someone other than the buyer.

(Non-Normative): Property of:

Order

see: https://schemas.alumio.com/isGift.prop.jsd

isRelatedTo_type

isRelatedTo_type: Product | Product[]

A pointer to another, somehow related product (or multiple products).

(Non-Normative): Property of:

Product

see: https://schemas.alumio.com/isRelatedTo.prop.jsd

isSimilarTo_type

isSimilarTo_type: Product | Product[]

A pointer to another, functionally similar product (or multiple products).

(Non-Normative): Property of:

Product

see: https://schemas.alumio.com/isSimilarTo.prop.jsd

isVariantOf_type

isVariantOf_type: Product | Product[]

Indicates the kind of product that this is a variant of.

(Non-Normative): Property of:

Product

see: https://schemas.alumio.com/isVariantOf.prop.jsd

itemCondition_type

itemCondition_type: Text

The item condition.

(Non-Normative): Property of:

Product

see: https://schemas.alumio.com/itemCondition.prop.jsd

itemListElement_type

For itemListElement values, you can use simple strings (e.g. "Peter", "Paul", "Mary"), existing entities, or use ListItem.

(Non-Normative): Property of:

ItemList

see: https://schemas.alumio.com/itemListElement.prop.jsd

itemShipped_type

itemShipped_type: Product | Product[]

Item(s) being shipped.

(Non-Normative): Property of:

ParcelDelivery

see: https://schemas.alumio.com/itemShipped.prop.jsd

item_type

item_type: Thing

An entity represented by an entry in a list or data feed (e.g. an artist in a list of artists).

(Non-Normative): Property of:

ListItem

see: https://schemas.alumio.com/item.prop.jsd

jobTitle_type

jobTitle_type: Text

The job title of the person (for example, Financial Manager).

(Non-Normative): Property of:

Person

see: https://schemas.alumio.com/jobTitle.prop.jsd

legalName_type

legalName_type: Text

The official name of the organization, e.g. the registered company name.

(Non-Normative): Property of:

Organization

see: https://schemas.alumio.com/legalName.prop.jsd

locale_type

locale_type: Text

Standard country-language codes are comprised of two arguments separated by a underscore, for example: nl_NL, en_US, en_GB, de_DE

(Non-Normative): Property of:

Product

see: https://schemas.alumio.com/locale.prop.jsd

manufacturer_type

manufacturer_type: Text

The manufacturer of the product.

(Non-Normative): Property of:

Product

see: https://schemas.alumio.com/manufacturer.prop.jsd

maxValue_type

maxValue_type: Number

The upper value of some characteristic or property.

(Non-Normative): Property of:

see: https://schemas.alumio.com/maxValue.prop.jsd

memberOf_type

memberOf_type: Organization | Organization[]

An Organization (or ProgramMembership) to which this Person or Organization belongs.

(Non-Normative): Property of:

see: https://schemas.alumio.com/memberOf.prop.jsd

minValue_type

minValue_type: Number

The lower value of some characteristic or property.

(Non-Normative): Property of:

see: https://schemas.alumio.com/minValue.prop.jsd

model_type

model_type: Text

The model of the product.

(Non-Normative): Property of:

Product

see: https://schemas.alumio.com/model.prop.jsd

mpn_type

mpn_type: Text

The Manufacturer Part Number (MPN) of the product, or the product to which the offer refers.

(Non-Normative): Property of:

Product

see: https://schemas.alumio.com/mpn.prop.jsd

name_type

name_type: Text

The name of the item.

(Non-Normative): Property of:

Thing

see: https://schemas.alumio.com/name.prop.jsd

nextItem_type

nextItem_type: ListItem

A link to the ListItem that follows the current one.

(Non-Normative): Property of:

ListItem

see: https://schemas.alumio.com/nextItem.prop.jsd

numberOfItems_type

numberOfItems_type: Integer

The number of items in an ItemList. Note that some descriptions might not fully describe all items in a list (e.g., multi-page pagination); in such cases, the numberOfItems would be for the entire list.

(Non-Normative): Property of:

ItemList

see: https://schemas.alumio.com/numberOfItems.prop.jsd

offers_type

offers_type: Offer | Offer[]

An offer to provide this item—for example, an offer to sell a product, rent the DVD of a movie, perform a service, or give away tickets to an event.

(Non-Normative): Property of:

Product

see: https://schemas.alumio.com/offers.prop.jsd

orderDate_type

orderDate_type: DateTime

Date order was placed.

(Non-Normative): Property of:

Order

see: https://schemas.alumio.com/orderDate.prop.jsd

orderDelivery_type

orderDelivery_type: ParcelDelivery | ParcelDelivery[]

The delivery of the parcel related to this order or order item.

(Non-Normative): Property of:

see: https://schemas.alumio.com/orderDelivery.prop.jsd

orderItemNumber_type

orderItemNumber_type: Text

The identifier of the order item.

(Non-Normative): Property of:

OrderItem

see: https://schemas.alumio.com/orderItemNumber.prop.jsd

orderItemStatus_type

orderItemStatus_type: Text

The current status of the order item.

(Non-Normative): Property of:

OrderItem

see: https://schemas.alumio.com/orderItemStatus.prop.jsd

orderNumber_type

orderNumber_type: Text

The identifier of the transaction.

(Non-Normative): Property of:

Order

see: https://schemas.alumio.com/orderNumber.prop.jsd

orderQuantity_type

orderQuantity_type: Number

The number of items ordered.

(Non-Normative): Property of:

OrderItem

see: https://schemas.alumio.com/orderQuantity.prop.jsd

orderStatus_type

orderStatus_type: Text

The current status of the order.

(Non-Normative): Property of:

Order

see: https://schemas.alumio.com/orderStatus.prop.jsd

orderedItem_type

orderedItem_type: OrderItem | OrderItem[]

The item ordered.

(Non-Normative): Property of:

see: https://schemas.alumio.com/orderedItem.prop.jsd

originAddress_type

originAddress_type: PostalAddress

Shipper's address.

(Non-Normative): Property of:

ParcelDelivery

see: https://schemas.alumio.com/originAddress.prop.jsd

partOfInvoice_type

partOfInvoice_type: Invoice | Invoice[]

The order is being paid as part of the referenced Invoice.

(Non-Normative): Property of:

Order

see: https://schemas.alumio.com/partOfInvoice.prop.jsd

partOfOrder_type

partOfOrder_type: Order

The overall order the items in this delivery were included in.

(Non-Normative): Property of:

ParcelDelivery

see: https://schemas.alumio.com/partOfOrder.prop.jsd

paymentDueDate_type

paymentDueDate_type: DateTime

The date that payment is due. Supersedes paymentDue.

(Non-Normative): Property of:

Order

see: https://schemas.alumio.com/paymentDueDate.prop.jsd

paymentMethodId_type

paymentMethodId_type: Text

An identifier for the method of payment used (e.g. the last 4 digits of the credit card).

(Non-Normative): Property of:

Order

see: https://schemas.alumio.com/paymentMethodId.prop.jsd

paymentMethod_type

paymentMethod_type: Text

The name of the credit card or other method of payment for the order.

(Non-Normative): Property of:

Order

see: https://schemas.alumio.com/paymentMethod.prop.jsd

paymentUrl_type

paymentUrl_type: URL

The URL for sending a payment.

(Non-Normative): Property of:

Order

see: https://schemas.alumio.com/paymentUrl.prop.jsd

position_type

position_type: Integer | Text

The position of an item in a series or sequence of items.

(Non-Normative): Property of:

ListItem

see: https://schemas.alumio.com/position.prop.jsd

postalCode_type

postalCode_type: Text

The postal code. For example, 94043.

(Non-Normative): Property of:

PostalAddress

see: https://schemas.alumio.com/postalCode.prop.jsd

previousItem_type

previousItem_type: ListItem

A link to the ListItem that precedes the current one.

(Non-Normative): Property of:

ListItem

see: https://schemas.alumio.com/previousItem.prop.jsd

priceCurrency_type

priceCurrency_type: Text

The currency (in 3-letter ISO 4217 format) of the price or a price component, when attached to PriceSpecification and its subtypes.

(Non-Normative): Property of:

Offer

see: https://schemas.alumio.com/priceCurrency.prop.jsd

price_type

price_type: Number | Text

The offer price of a product, or of a price component when attached to PriceSpecification and its subtypes.

(Non-Normative): Property of:

Offer

see: https://schemas.alumio.com/price.prop.jsd

productID_type

productID_type: Text

The product identifier, such as ISBN.

Extends identifier

(Non-Normative): Property of:

Product

see: https://schemas.alumio.com/productID.prop.jsd

productionDate_type

productionDate_type: Date

The date of production of the item, e.g. vehicle.

(Non-Normative): Property of:

Product

see: https://schemas.alumio.com/productionDate.prop.jsd

provider_type

provider_type: Organization | Person

The service provider, service operator, or service performer; the goods producer.

(Non-Normative): Property of:

ParcelDelivery

see: https://schemas.alumio.com/provider.prop.jsd

purchaseDate_type

purchaseDate_type: Date

The date the item e.g. vehicle was purchased by the current owner.

(Non-Normative): Property of:

Product

see: https://schemas.alumio.com/purchaseDate.prop.jsd

releaseDate_type

releaseDate_type: Date

The release date of a product or product model. This can be used to distinguish the exact variant of a product.

(Non-Normative): Property of:

Product

see: https://schemas.alumio.com/releaseDate.prop.jsd

salesChannel_type

salesChannel_type: Text | StructuredValue | (Text | StructuredValue)[]

The sales channel which a Customer belongs.

(Non-Normative): Property of:

Customer

see: https://schemas.alumio.com/salesChannel.prop.jsd

seller_type

seller_type: Organization | Person

An entity which offers (sells / leases / lends / loans) the services / goods. A seller may also be a provider. Supersedes vendor, merchant.

(Non-Normative): Property of:

Order

see: https://schemas.alumio.com/seller.prop.jsd

sku_type

sku_type: Text

The Stock Keeping Unit (SKU), i.e. a merchant-specific identifier for a product or service, or the product to which the offer refers.

Extends identifier

(Non-Normative): Property of:

see: https://schemas.alumio.com/sku.prop.jsd

streetAddress_type

streetAddress_type: Text | Text[]

The street address. For example, 1600 Amphitheatre Pkwy.

(Non-Normative): Property of:

PostalAddress

see: https://schemas.alumio.com/streetAddress.prop.jsd

tax_type

tax_type: Number | Text

The offer tax of a product, or of a tax component when attached to PriceSpecification and its subtypes.

(Non-Normative): Property of:

Offer

see: https://schemas.alumio.com/tax.prop.jsd

telephone_type

telephone_type: Text | Text[]

The telephone number.

(Non-Normative): Property of:

ContactPoint

see: https://schemas.alumio.com/telephone.prop.jsd

text_type

text_type: Text

The textual content of this CreativeWork.

see: https://schemas.alumio.com/text.prop.jsd

trackingNumber_type

trackingNumber_type: Text

Shipper tracking number.

(Non-Normative): Property of:

ParcelDelivery

see: https://schemas.alumio.com/trackingNumber.prop.jsd

trackingUrl_type

trackingUrl_type: URL

Tracking url for the parcel delivery.

(Non-Normative): Property of:

ParcelDelivery

see: https://schemas.alumio.com/trackingUrl.prop.jsd

translations_type

translations_type: Product | Product[]

List of translated products based on language.

(Non-Normative): Property of:

Product

see: https://schemas.alumio.com/translations.prop.jsd

unitCode_type

unitCode_type: Text | URL

The unit of measurement given using the UN/CEFACT Common Code (3 characters) or a URL. Other codes than the UN/CEFACT Common Code may be used with a prefix followed by a colon.

(Non-Normative): Property of: