Order extends Intangible

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.

Tags

see

https://schema.org/Order

Table of Contents

Constants

CONTEXT  = 'https://schema.org'

JSON-LD @context declaration for Schema.org.

JSON_PRIORITY_KEYS  = [\org\schema\constants\Schema::AT_TYPE, \org\schema\constants\Schema::AT_CONTEXT, \org\schema\constants\Schema::_KEY, \org\schema\constants\Schema::_FROM, \org\schema\constants\Schema::_TO, \org\schema\constants\Schema::ID, \org\schema\constants\Schema::NAME, \org\schema\constants\Schema::URL, \org\schema\constants\Schema::CREATED, \org\schema\constants\Schema::MODIFIED]

Defines the priority order of keys when serializing the object to JSON-LD.

Properties

$_from  : string|null

The metadata to indicates the edge 'from' identifier.

$_id  : null|string

The metadata identifier of the item.

$_key  : null|string

The metadata unique key identifier of the thing.

$_rev  : null|string

The metadata revision value of the thing.

$_to  : string|null

The metadata to indicates the edge 'to' identifier.

$acceptedOffer  : array<string|int, mixed>|Offer|null

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

$active  : bool|null

The active flag.

$additionalType  : array<string|int, mixed>|string|null|object

An additionalType for the item.

$alternateName  : string|object|array<string|int, mixed>|null

An alias for the item.

$billingAddress  : PostalAddress|null

The billing address for the order.

$broker  : Organization|Person|null

An entity that arranges for an exchange between a buyer and a seller.

$confirmationNumber  : string|int|null

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

$created  : null|string

Date of creation of the resource.

$customer  : Organization|Person|null

Party placing the order or paying the invoice.

$description  : string|object|array<string|int, mixed>|null

A short description of the item.

$disambiguatingDescription  : string|null

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  : int|float|string|null

Any discount applied (to an Order).

$discountCode  : string|null

Code used to redeem a discount.

$discountCurrency  : string|null

The currency of the discount.

$hasPart  : string|Thing|array<string|int, Thing>|null

Indicates an item that this part of this item.

$id  : null|int|string

The unique identifier of the item.

$identifier  : string|null

The identifier of the item.

$image  : string|ImageObject|array<string|int, ImageObject|string>|null

The image reference of this resource.

$isGift  : bool|null

Indicates whether the offer was accepted as a gift for someone other than the buyer.

$isPartOf  : string|Thing|array<string|int, Thing>|null

Indicates an item that this item is part of.

$license  : string|object|null

A legal document giving official permission to do something with the resource.

$mainEntityOfPage  : string|null

Indicates a page (or other CreativeWork) for which this thing is the main entity being described.

$modified  : null|string

Date on which the resource was changed.

$name  : int|string|null

The name of the item.

$orderDate  : string|int|null

Date order was placed.

$orderDelivery  : null|ParcelDelivery

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

$orderedItem  : array<string|int, mixed>|Product|Service|OrderItem|null

The item ordered.

$orderNumber  : int|string|null

The identifier of the transaction.

$orderStatus  : string|DefinedTerm|OrderStatus|null

The current status of the order.

$owner  : null|string|Thing

The owner of this Thing.

$partOfInvoice  : array<string|int, mixed>|Invoice|null

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

$paymentDueDate  : string|int|null

The date that payment is due.

$paymentMethod  : PaymentMethod|string|null

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

$paymentMethodId  : string|null

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

$paymentUrl  : string|null

The URL for sending a payment.

$potentialAction  : array<string|int, mixed>|Action|null

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

$publisher  : string|array<string|int, string|Person|Organization>|Person|Organization|null

The publisher of the resource.

$sameAs  : string|array<string|int, mixed>|null

URL of a reference Web page that unambiguously indicates the item's identity.

$seller  : Organization|Person|null

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

$subjectOf  : null|string|array<string|int, mixed>|CreativeWork|Event

A CreativeWork or Event about this Thing.

$url  : int|string|null

URL of the item.

$atContext  : string|null

The JSON-LD `@context` value.

$atType  : string|null

The JSON-LD `@type` value.

Methods

__construct()  : mixed

Constructor to hydrate public properties from an array or stdClass.

jsonSerialize()  : array<string|int, mixed>

Serializes the current object into a JSON-LD array.

withAtContext()  : $this

Sets the internal JSON-LD `@context` attribute.

withAtType()  : $this

Sets the internal JSON-LD `@type` attribute.

withJSONLDMeta()  : $this

Initializes both JSON-LD metadata: `@type` and `@context`.

$orderedKeys = self::JSON_PRIORITY_KEYS;