Order Object

Order Object represents 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.

Modeled based on https://schema.org/Order We welcome your feedback. Please use the Improvement Requests form.

Attributes:

Name
Type
Description

id

String

The Object ID

at_context

String

Stand-In for JSON-LD @context - your UI is expected to change it to valid JSON-LD @context filed name. Value is set to "https://schema.org"

at_type

String

Stand-In for JSON-LD @type - your UI is expected to change it to valid JSON-LD @type filed name. Value is set to "Order"

identifier

String

The identifier property represents any kind of identifier for any kind of Product

image

String

An image of the item. This can be a URL

name

Object name

description

Object description

url

String

URL of the Order

acceptedOffer

Array of String

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

billingAddress

The billing address for the order.

broker

String

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

confirmationNumber

String

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

customer

String

URL to the party placing the order or paying the invoice.

discount

Number

Any discount applied (to an Order).

discountCode

String

Code used to redeem a discount.

discountCurrency

String

The currency of the discount. Use standard formats: ISO 4217 currency format,

isGift

Boolean

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

orderDate

DateTime

Date order was placed. String in ISO 8601 date format.

orderNumber

String

The identifier of the transaction.

orderStatus

String

The current status of the order. Use https://schema.org/OrderStatus

orderItem

Array of String

The item(s) ordered. URLs

partOfInvoice

String

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

paymentDueDate

DateTime

The date that payment is due. String in ISO 8601 date format.

paymentMethod

String

The name of the credit card or other method of payment for the order. Use https://schema.org/PaymentMethod if all possible.

paymentMethodId

String

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

paymentUrl

String

The URL for sending a payment.

seller

String

An entity which offers (sells / leases / lends / loans) the services / goods.

tags

Array of Tag

Array of Tag

meta

Object Meta

Meta object

Last updated

Was this helpful?