app.shipments
TableRow level security on
Shipments to and from a project's sites.
Primary key: id
| Column | Type | Nullable | Description |
|---|---|---|---|
| id | uuid | No | Primary key, UUID v7. |
| org_id | uuid | No | Owning org, derived from app.projects on insert; never accepted from the caller and never changed.References app.organizations.id |
| project_id | uuid | No | Project.References app.projects.id |
| direction | app.shipment_direction | No | Inbound or Outbound. |
| carrier_counterparty_id | uuid | Yes | Carrier.References app.counterparties.id |
| freight_type_enum_id | text | Yes | Freight type: a row of the canon Freight Type enumeration.References xpms.std_enumeration.record_id |
| tracking_identifier | text | Yes | Carrier tracking number. |
| ships_at | timestamp with time zone | Yes | When it ships. |
| arrives_at | timestamp with time zone | Yes | When it is due to arrive. |
| deleted_at | timestamp with time zone | Yes | Soft delete time. A row with deleted_at set is ignored by every access helper. |
| created_at | timestamp with time zone | No | When the row was inserted. Set by the database. |
| created_by | uuid | Yes | Person who inserted the row, or null for a platform process. Set by the database.References app.people.id |
| updated_at | timestamp with time zone | No | When the row last changed. Set by the database. |
| updated_by | uuid | Yes | Person who last changed the row, or null for a platform process. Set by the database.References app.people.id |
| shipment_number | bigint | No | Number within the project from the record sequence. The display key is {project_key}-{shipment_number}, read through app.shipment_display_key. |
| urid | text | Yes | URID category the shipment serves (dimension 2), for example 5000.52.01.References xpms.dim_category.cat_urid |
| description | text | Yes | What the shipment carries, in a sentence. |
| origin | text | Yes | Where the freight ships from, as a locality (Orlando, FL). |
| sender_counterparty_id | uuid | Yes | Vendor sending the freight; the carrier is carrier_counterparty_id.References app.counterparties.id |
| pallet_count | integer | Yes | Number of pallets. |
| piece_count | integer | Yes | Number of pieces. |
| length_ft | numeric(8,2) | Yes | Length of the load in feet. |
| width_ft | numeric(8,2) | Yes | Width of the load in feet. |
| height_ft | numeric(8,2) | Yes | Height of the load in feet. |
| weight_lb | numeric(10,2) | Yes | Weight of the load in pounds. |
| trailer_license | text | Yes | License plate of the trailer, issued by a motor vehicle authority. |
| seal_identifier | text | Yes | Number of the seal applied to the trailer. |
| bill_of_lading_identifier | text | Yes | Bill of lading number issued by the carrier. |