NAME

SemanticWeb::Schema::Order - An order is a confirmation of a transaction (a receipt)

VERSION

version v23.0.0

DESCRIPTION

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.

ATTRIBUTES

accepted_offer

acceptedOffer

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

A accepted_offer should be one of the following types:

InstanceOf['SemanticWeb::Schema::Offer']

_has_accepted_offer

A predicate for the "accepted_offer" attribute.

billing_address

billingAddress

The billing address for the order.

A billing_address should be one of the following types:

InstanceOf['SemanticWeb::Schema::PostalAddress']

_has_billing_address

A predicate for the "billing_address" attribute.

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.

A broker should be one of the following types:

InstanceOf['SemanticWeb::Schema::Organization']
InstanceOf['SemanticWeb::Schema::Person']

_has_broker

A predicate for the "broker" attribute.

confirmation_number

confirmationNumber

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

A confirmation_number should be one of the following types:

Str

_has_confirmation_number

A predicate for the "confirmation_number" attribute.

customer

Party placing the order or paying the invoice.

A customer should be one of the following types:

InstanceOf['SemanticWeb::Schema::Organization']
InstanceOf['SemanticWeb::Schema::Person']

_has_customer

A predicate for the "customer" attribute.

discount

Any discount applied (to an Order).

A discount should be one of the following types:

Num
Str

_has_discount

A predicate for the "discount" attribute.

discount_code

discountCode

Code used to redeem a discount.

A discount_code should be one of the following types:

Str

_has_discount_code

A predicate for the "discount_code" attribute.

discount_currency

discountCurrency

The currency of the discount. Use standard formats: [ISO 4217 currency format](http://en.wikipedia.org/wiki/ISO_4217), e.g. "USD"; [Ticker symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for cryptocurrencies, e.g. "BTC"; well known names for [Local Exchange Trading Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) (LETS) and other currency types, e.g. "Ithaca HOUR".

A discount_currency should be one of the following types:

Str

_has_discount_currency

A predicate for the "discount_currency" attribute.

is_gift

isGift

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

A is_gift should be one of the following types:

Bool

_has_is_gift

A predicate for the "is_gift" attribute.

merchant

'merchant' is an out-dated term for 'seller'.

A merchant should be one of the following types:

InstanceOf['SemanticWeb::Schema::Organization']
InstanceOf['SemanticWeb::Schema::Person']

_has_merchant

A predicate for the "merchant" attribute.

order_date

orderDate

Date order was placed.

A order_date should be one of the following types:

Str

_has_order_date

A predicate for the "order_date" attribute.

order_delivery

orderDelivery

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

A order_delivery should be one of the following types:

InstanceOf['SemanticWeb::Schema::ParcelDelivery']

_has_order_delivery

A predicate for the "order_delivery" attribute.

order_number

orderNumber

The identifier of the transaction.

A order_number should be one of the following types:

Str

_has_order_number

A predicate for the "order_number" attribute.

order_status

orderStatus

The current status of the order.

A order_status should be one of the following types:

InstanceOf['SemanticWeb::Schema::OrderStatus']

_has_order_status

A predicate for the "order_status" attribute.

ordered_item

orderedItem

The item ordered.

A ordered_item should be one of the following types:

InstanceOf['SemanticWeb::Schema::OrderItem']
InstanceOf['SemanticWeb::Schema::Product']
InstanceOf['SemanticWeb::Schema::Service']

_has_ordered_item

A predicate for the "ordered_item" attribute.

part_of_invoice

partOfInvoice

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

A part_of_invoice should be one of the following types:

InstanceOf['SemanticWeb::Schema::Invoice']

_has_part_of_invoice

A predicate for the "part_of_invoice" attribute.

payment_due

paymentDue

The date that payment is due.

A payment_due should be one of the following types:

Str

_has_payment_due

A predicate for the "payment_due" attribute.

payment_due_date

paymentDueDate

The date that payment is due.

A payment_due_date should be one of the following types:

Str

_has_payment_due_date

A predicate for the "payment_due_date" attribute.

payment_method

paymentMethod

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

A payment_method should be one of the following types:

InstanceOf['SemanticWeb::Schema::PaymentMethod']

_has_payment_method

A predicate for the "payment_method" attribute.

payment_method_id

paymentMethodId

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

A payment_method_id should be one of the following types:

Str

_has_payment_method_id

A predicate for the "payment_method_id" attribute.

payment_url

paymentUrl

The URL for sending a payment.

A payment_url should be one of the following types:

Str

_has_payment_url

A predicate for the "payment_url" attribute.

seller

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

A seller should be one of the following types:

InstanceOf['SemanticWeb::Schema::Organization']
InstanceOf['SemanticWeb::Schema::Person']

_has_seller

A predicate for the "seller" attribute.

SEE ALSO

SemanticWeb::Schema::Intangible

SOURCE

The development version is on github at https://github.com/robrwo/SemanticWeb-Schema and may be cloned from git://github.com/robrwo/SemanticWeb-Schema.git

BUGS

Please report any bugs or feature requests on the bugtracker website https://github.com/robrwo/SemanticWeb-Schema/issues

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.

AUTHOR

Robert Rothenberg <rrwo@cpan.org>

COPYRIGHT AND LICENSE

This software is Copyright (c) 2018-2023 by Robert Rothenberg.

This is free software, licensed under:

The Artistic License 2.0 (GPL Compatible)