Schemas / Commerce

rig.commerce.order_line

v1.0.0 · stable maturity: draft 4 fields 3 required

Fields

FieldTypeMeaning
order entity required The rig.commerce.order
product entity required The rig.commerce.product
quantity float required Count ordered
offer entity optional Optional. The rig.commerce.offer this line took

One line of an order. Format when present.

order, product, and quantity are required.

The line price is rig.commerce.price on this entity. Do not copy sku off the offer. A second line is another entity.

JSON Schema

Resolves at https://rig.works/schemas/rig.commerce.order_line.schema.json — raw file.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://rig.works/schemas/rig.commerce.order_line.schema.json",
  "title": "rig.commerce.order_line",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "order": {
      "$ref": "./_defs.schema.json#/$defs/entity"
    },
    "product": {
      "$ref": "./_defs.schema.json#/$defs/entity"
    },
    "quantity": {
      "$ref": "./_defs.schema.json#/$defs/float"
    },
    "offer": {
      "$ref": "./_defs.schema.json#/$defs/entity"
    }
  },
  "required": [
    "order",
    "product",
    "quantity"
  ],
  "description": "One line of an order. Price composes rig.commerce.price. Do not copy sku off the offer.",
  "x-rig-maturity": "draft"
}

Seen in

record-shop.json