Adam
/
Mango.Nop.Plugins
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Clarify Shipping schema docs, make truck fields nullable 

Updated SCHEMA.md to clarify field purposes for Shipping and ShippingDocument entities, emphasizing progressive assignment and nullable status for carrier/truck fields. Changed CargoPartnerId, CargoTrailerId, and CargoTruckId types to nullable (int?). Added git show command for SCHEMA.md in settings.local.json and fixed a missing comma. No structural schema changes.
This commit is contained in:
Loretta 2026-05-31 14:52:34 +02:00
parent 2442094a08
commit 727b237253
1 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
Nop.Plugin.Misc.AIPlugin/docs/SCHEMA.md
View File

@ -572,23 +572,23 @@
Shipping: "Shipping record with documents and measurement tracking" Shipping: "Shipping record with documents and measurement tracking"
table-name: "fbShipping" table-name: "fbShipping"
purpose: "Represents a physical inbound delivery event (truck arrival) at the warehouse, tracking the vehicle and the overall measurement status of the shipment" purpose: "Inbound delivery event (truck arrival) at the warehouse. Created early and filled progressively — carrier, truck and trailer are assigned later."
CargoCompany: string CargoCompany: string
CargoPartner: CargoPartner CargoPartner: CargoPartner
purpose: "The transport company (carrier) that hauled this delivery — distinct from the goods supplier, which is reached via ShippingDocument.Partner." purpose: "Carrier (transport company); assigned later, null until known. Supplier is separate — see ShippingDocument.Partner."
foreign-key: "CargoPartnerId" foreign-key: "CargoPartnerId"
navigation: "many-to-one" navigation: "many-to-one"
CargoPartnerId: int CargoPartnerId: int?
CargoTrailer: CargoTruck CargoTrailer: CargoTruck
purpose: "The trailer — the SAME CargoTruck table as CargoTruck, but the row with IsTrailer=true (CargoTrailerId → CargoTruck.Id)." purpose: "Trailer (CargoTruck table, IsTrailer=true); optional, assigned later — null if none or not yet known."
foreign-key: "CargoTrailerId" foreign-key: "CargoTrailerId"
navigation: "many-to-one" navigation: "many-to-one"
CargoTrailerId: int CargoTrailerId: int?
CargoTruck: CargoTruck CargoTruck: CargoTruck
purpose: "The tractor/truck unit — a CargoTruck row with IsTrailer=false." purpose: "Tractor unit (CargoTruck, IsTrailer=false) from the carrier's fleet; assigned later, null until known."
foreign-key: "CargoTruckId" foreign-key: "CargoTruckId"
navigation: "many-to-one" navigation: "many-to-one"
CargoTruckId: int CargoTruckId: int?
Comment: string Comment: string
Created: DateTime Created: DateTime
IsAllMeasured: bool IsAllMeasured: bool
@ -607,7 +607,7 @@
ShippingDocument: "Shipping document with partner, items and files" ShippingDocument: "Shipping document with partner, items and files"
table-name: "fbShippingDocument" table-name: "fbShippingDocument"
purpose: "A digital representation of a supplier's delivery note or invoice associated with the shipment, used for reconciling paper-based data with measured reality" purpose: "Supplier's delivery note or invoice for the shipment; reconciles paper data with measured reality. Populated progressively — much entered at order time, the rest as it becomes known."
Comment: string Comment: string
Country: string Country: string
Created: DateTime Created: DateTime
@ -854,4 +854,4 @@
Id: int Id: int
purpose: "Primary key / unique identification" purpose: "Primary key / unique identification"
primary-key: true primary-key: true
} }