OrderStatus

Breadcrumb: Thing > Intangible > Enumeration > StatusEnumeration > OrderStatus

Enumerated status values for Order.

Parent types

StatusEnumeration

Properties

No properties are defined directly on OrderStatus.

Inherited properties

Property	Expected type	Inherited from	Description
additionalType	Text, URL	Thing	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. Typically the value is a URI-identified RDF class, and in this case corresponds to the use of rdf:type in RDF. Text values can be used sparingly, for cases where useful information can be added without their being an appropriate schema to reference. In the case of text values, the class label should follow the schema.org style guide.
alternateName	Text	Thing	An alias for the item.
description	Text, TextObject	Thing	A description of the item.
disambiguatingDescription	Text	Thing	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.
identifier	PropertyValue, Text, URL	Thing	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	ImageObject, URL	Thing	An image of the item. This can be a URL or a fully described ImageObject.
mainEntityOfPage	CreativeWork, URL	Thing	Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See background notes for details.
name	Text	Thing	The name of the item.
owner	Organization, Person	Thing	A person or organization who owns this Thing.
potentialAction	Action	Thing	Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
sameAs	URL	Thing	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.
subjectOf	CreativeWork, Event	Thing	A CreativeWork or Event about this Thing.
supersededBy	Class, Enumeration, Property	Enumeration	Relates a term (i.e. a property, class or enumeration) to one that supersedes it.
url	URL	Thing	URL of the item.

Enumeration values

• OrderCancelled OrderStatus representing cancellation of an order.
• OrderDelivered OrderStatus representing successful delivery of an order.
• OrderInTransit OrderStatus representing that an order is in transit.
• OrderPaymentDue OrderStatus representing that payment is due on an order.
• OrderPickupAvailable OrderStatus representing availability of an order for pickup.
• OrderProblem OrderStatus representing that there is a problem with the order.
• OrderProcessing OrderStatus representing that an order is being processed.
• OrderReturned OrderStatus representing that an order has been returned.

Example

{
  "@context": "https://schema.org",
  "@type": "OrderStatus",
  "name": "Example Name",
  "description": "A short description.",
  "url": "/example"
}