Schemas / Commerce
rig.commerce.shipment_line
v1.0.0 · stable maturity: draft 4 fields 3 required
Fields
| Field | Type | Meaning | |
|---|---|---|---|
shipment |
entity | required | The rig.commerce.shipment |
product |
entity | required | The rig.commerce.product |
quantity |
float | required | Count in this box |
orderLine |
entity | optional | Optional. The rig.commerce.order_line this ships |
One line of a shipment. Format when present.
shipment, product, and quantity are required. A second line is another entity.
JSON Schema
Resolves at https://rig.works/schemas/rig.commerce.shipment_line.schema.json —
raw file.
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://rig.works/schemas/rig.commerce.shipment_line.schema.json",
"title": "rig.commerce.shipment_line",
"type": "object",
"additionalProperties": false,
"properties": {
"shipment": {
"$ref": "./_defs.schema.json#/$defs/entity"
},
"product": {
"$ref": "./_defs.schema.json#/$defs/entity"
},
"quantity": {
"$ref": "./_defs.schema.json#/$defs/float"
},
"orderLine": {
"$ref": "./_defs.schema.json#/$defs/entity"
}
},
"required": [
"shipment",
"product",
"quantity"
],
"description": "One line of a shipment. Members point at the box.",
"x-rig-maturity": "draft"
}