Skip to content

Order ​

Breadcrumb: fibo-fnd-arr-doc:LegalDocument > 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.

Parent types ​

fibo-fnd-arr-doc:LegalDocument, Intangible

Properties ​

Properties for Order ​

PropertyExpected typeDefined onDescription
acceptedOfferOfferOrderThe offer(s) -- e.g., product, quantity and price combinations -- included in the order.
billingAddressPostalAddressOrderThe billing address for the order.
brokerOrganization, PersonOrderAn 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.
confirmationNumberTextOrderA number that confirms the given order or payment has been received.
customerOrganization, PersonOrderParty placing the order or paying the invoice.
discountNumber, TextOrderAny discount applied (to an Order).
discountCodeTextOrderCode used to redeem a discount.
discountCurrencyTextOrderThe currency of the discount. Use standard formats: ISO 4217 currency format, e.g. "USD"; Ticker symbol for cryptocurrencies, e.g. "BTC"; well known names for Local Exchange Trading Systems (LETS) and other currency types, e.g. "Ithaca HOUR".
isGiftBooleanOrderIndicates whether the offer was accepted as a gift for someone other than the buyer.
merchantOrganization, PersonOrder'merchant' is an out-dated term for 'seller'.
orderDateDate, DateTimeOrderDate order was placed.
orderDeliveryParcelDeliveryOrderThe delivery of the parcel related to this order or order item.
orderedItemOrderItem, Product, ServiceOrderThe item ordered.
orderNumberTextOrderThe identifier of the transaction.
orderStatusOrderStatusOrderThe current status of the order.
partOfInvoiceInvoiceOrderThe order is being paid as part of the referenced Invoice.
paymentDueDateTimeOrderThe date that payment is due.
paymentDueDateDate, DateTimeOrderThe date that payment is due.
paymentMethodPaymentMethod, TextOrderThe name of the credit card or other method of payment for the order.
paymentMethodIdTextOrderAn identifier for the method of payment used (e.g. the last 4 digits of the credit card).
paymentUrlURLOrderThe URL for sending a payment.
sellerOrganization, PersonOrderAn entity which offers (sells / leases / lends / loans) the services / goods. A seller may also be a provider.

Inherited properties ​

PropertyExpected typeInherited fromDescription
additionalTypeText, URLThingAn 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.
alternateNameTextThingAn alias for the item.
descriptionText, TextObjectThingA description of the item.
disambiguatingDescriptionTextThingA 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.
identifierPropertyValue, Text, URLThingThe 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.
imageImageObject, URLThingAn image of the item. This can be a URL or a fully described ImageObject.
mainEntityOfPageCreativeWork, URLThingIndicates a page (or other CreativeWork) for which this thing is the main entity being described. See background notes for details.
nameTextThingThe name of the item.
ownerOrganization, PersonThingA person or organization who owns this Thing.
potentialActionActionThingIndicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
sameAsURLThingURL 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.
subjectOfCreativeWork, EventThingA CreativeWork or Event about this Thing.
urlURLThingURL of the item.

Example ​

json
{
  "@context": "https://schema.org",
  "@type": "Order",
  "name": "Example Name",
  "description": "A short description.",
  "url": "/example",
  "acceptedOffer": "Example value",
  "billingAddress": "Example value"
}