order¶

Semantics¶

Identifies a single purchase order.

An order has no identifier property: the target of its self link is its identity. Keep that URI to come back to the order later. It is the same URI as the Location returned when the order was placed, and the one other resources link to with this relation, such as the items collection of the order.

An order moves through the states placed, confirmed, cancelled and delivered. Which transitions are available depends on the state the order is in now, and is advertised on the order itself rather than described here.

On the order form, this relation has a second meaning: it identifies the affordance for submitting the form to place a new order. See orders-form.

Affordances¶

Request the order as HAL-FORMS to also receive templates for the transitions that are legal in its current state. A transition missing from the representation is not available, so a client does not need to know the rules that decide it.

Related link rels¶

• items — the line items of the order.
• customer — the customer who placed the order.
• cancel — cancels the order, offered only while that is possible.
• orders — the collection the order belongs to.
• orders-form — the form whose order affordance places a new order.