API Docs for: 1.3.12
Show:

Order Class

Schema.org/Order An order is a confirmation of a transaction (a receipt), which can contain multiple line items, each represented by an Offer that has been accepted by the customer.

Methods

getDescription

() String

Returns the description of the thing

Returns:

String:

description of Thing

getName

() String

Returns the name of the thing

Returns:

String:

name of Thing

setDescription

(
  • description
)

Method to set Thing description

Parameters:

  • description String

    Description to set for its Thing

setName

(
  • name
)

Method to set Thing name

Parameters:

  • name String

    Name to set for this Thing

Properties

acceptedOffer

Offer

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

additionalType

URL

Schema.org/additionalType 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. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.

alternateName

Text

Schema.org/alternateName An alias for the item.

billingAddress

PostalAddress

Schema.org/billingAddress The billing address for the order.

broker

Person

Schema.org/broker 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.

confirmationNumber

Text

Schema.org/confirmationNumber A number that confirms the given order or payment has been received.

customer

Organization

Schema.org/customer Party placing the order or paying the invoice.

description

Text

Schema.org/description A description of the item.

disambiguatingDescription

Text

Schema.org/disambiguatingDescription A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.

discount

Number

Schema.org/discount Any discount applied (to an Order).

discountCode

Text

Schema.org/discountCode Code used to redeem a discount.

discountCurrency

Text

Schema.org/discountCurrency The currency (in 3-letter ISO 4217 format) of the discount.

identifier

Schema, URL | schema,Text | schema,PropertyValue

Schema.org/identifier The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See background notes for more details.

image

Schema, URL | schema,ImageObject

Schema.org/image An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].

isGift

Boolean

Schema.org/isGift Was the offer accepted as a gift for someone other than the buyer.

mainEntityOfPage

Schema, URL | schema,CreativeWork

Schema.org/mainEntityOfPage Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See background notes for details.

merchant

Person

Schema.org/merchant 'merchant' is an out-dated term for 'seller'.

name

Text

Schema.org/name The name of the item.

orderDate

DateTime

Schema.org/orderDate Date order was placed.

orderDelivery

ParcelDelivery

Schema.org/orderDelivery The delivery of the parcel related to this order or order item.

orderedItem

Product

Schema.org/orderedItem The item ordered.

orderNumber

Text

Schema.org/orderNumber The identifier of the transaction.

orderStatus

OrderStatus

Schema.org/orderStatus The current status of the order.

partOfInvoice

Invoice

Schema.org/partOfInvoice The order is being paid as part of the referenced Invoice.

paymentDue

DateTime

Schema.org/paymentDue The date that payment is due.

paymentDueDate

DateTime

Schema.org/paymentDueDate The date that payment is due.

paymentMethod

PaymentMethod

Schema.org/paymentMethod The name of the credit card or other method of payment for the order.

paymentMethodId

Text

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

paymentUrl

URL

Schema.org/paymentUrl The URL for sending a payment.

potentialAction

Action

Schema.org/potentialAction Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.

sameAs

URL

Schema.org/sameAs URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.

seller

Person

Schema.org/seller An entity which offers (sells / leases / lends / loans) the services / goods. A seller may also be a provider.

url

URL

Schema.org/url URL of the item.