Shipment — data reference
All 45 fields BSuit stores for Shipment (Sales), with the record types they refer to.
On this page
#About Shipment
Shipment is a record type in the Sales area of BSuit. This page lists everything BSuit stores for each shipment — 45 fields. It is maintained on the “Shipments” page.
| Screen | Module |
|---|---|
| Shipments | Sales |
#Fields
Every field stored for a shipment. “Stored as” is the technical field name, useful when talking to support or building reports. 7 fields are references to other record types.
| Field | Stored as | Type | Required | Max length | Refers to |
|---|---|---|---|---|---|
| Company Id | CompanyId | Text | No | — | Company |
| Shipment Number | ShipmentNumber | Text | No | — | — |
| Sales Order Id | SalesOrderId | Text | No | — | SalesOrder |
| Delivery Note Id | DeliveryNoteId | Text | No | — | DeliveryNote |
| Shipping Label Id | ShippingLabelId | Text | No | — | ShippingLabel |
| Shipping Carrier Id | ShippingCarrierId | Text | No | — | ShippingCarrier |
| Delivery Method | DeliveryMethod | Text | No | — | — |
| Status | Status | Text | No | — | — |
| Tracking Number | TrackingNumber | Text | No | — | — |
| Expected Delivery At | ExpectedDeliveryAt | Date and time | No | — | — |
| Dispatched At | DispatchedAt | Date and time | No | — | — |
| Delivered At | DeliveredAt | Date and time | No | — | — |
| Returned At | ReturnedAt | Date and time | No | — | — |
| Pack Status | PackStatus | Text | No | — | — |
| Packed At | PackedAt | Date and time | No | — | — |
| Packed By User Id | PackedByUserId | Text | No | — | — |
| Handed Over At | HandedOverAt | Date and time | No | — | — |
| Driver Profile Id | DriverProfileId | Text | No | — | — |
| Vehicle Id | VehicleId | Text | No | — | Vehicle |
| Trip Id | TripId | Text | No | — | Trip |
| Stop Sequence | StopSequence | Whole number | No | — | — |
| Failed Attempt Count | FailedAttemptCount | Whole number | No | — | — |
| Last Failure Reason | LastFailureReason | Text | No | — | — |
| Rescheduled For | RescheduledFor | Date and time | No | — | — |
| Arrived At | ArrivedAt | Date and time | No | — | — |
| Pod Photo Url | PodPhotoUrl | Text | No | — | — |
| Pod Signature Name | PodSignatureName | Text | No | — | — |
| Received By Name | ReceivedByName | Text | No | — | — |
| Pod Captured At | PodCapturedAt | Date and time | No | — | — |
| Delivery Otp Hash | DeliveryOtpHash | Text | No | — | — |
| Delivery Otp Salt | DeliveryOtpSalt | Text | No | — | — |
| Delivery Otp Attempts | DeliveryOtpAttempts | Whole number | No | — | — |
| Destination Summary | DestinationSummary | Text | No | — | — |
| Recipient Name | RecipientName | Text | No | — | — |
| Recipient Phone | RecipientPhone | Text | No | — | — |
| Delivery Address | DeliveryAddress | Text | No | — | — |
| Internal Notes | InternalNotes | Text | No | — | — |
| Delay Notified At | DelayNotifiedAt | Date and time | No | — | — |
| Version | Version | Whole number | No | — | — |
| Packages | Packages | Text | No | — | — |
| Items | Items | Text | No | — | — |
| Id | Id | Text | No | — | — |
| Created At | CreatedAt | Date and time | No | — | — |
| Updated At | UpdatedAt | Date and time | No | — | — |
| Is Deleted | IsDeleted | Yes / No | No | — | — |
#Who can do this
Super Admin and other superuser accounts can always see and do everything, regardless of this list. For everyone else, these are the standard roles that have been granted a permission here in this system’s current setup — an organisation can add, remove or customise roles and their permissions, so treat this as an example, not a guarantee.
| Role | Create | View | add_event | dispatch | handoff | issue_otp | override | settings |
|---|---|---|---|---|---|---|---|---|
| Shipping Admin | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes |
| Warehouse Clerk | Yes | Yes | — | Yes | Yes | Yes | — | — |
| Warehouse Manager | Yes | Yes | — | Yes | Yes | Yes | — | — |
#Where Shipment is referenced
Other record types point to this one, so changing or removing a record here can affect them:
| Record type | Field |
|---|---|
| DeliveryNote | Shipment Id |
| ShipmentEvent | Shipment Id |
| ShipmentHandoff | Shipment Id |
| ShipmentItem | Shipment Id |
| ShipmentNotificationLog | Shipment Id |
| ShipmentPackage | Shipment Id |
| ShippingLabel | Shipment Id |
#About this guide
Generated from BSuit’s data model on the date shown under “Seen on a running system”. Field names, types and lengths come from the model itself. References are inferred from field names (a field called “Ledger Id” is treated as pointing to Ledger); the model does not declare relationships, so an inferred link can occasionally be wrong or missing.
About this guide
- Status
- Partially reviewed
- Application
- BSuit ERP
- Audience
- Administrators, analysts and support staff
- Owner
- BSuit documentation team
- Reviewer
- Not yet reviewed
- Last verified
- Never
- Checked against
- Generated from source revision a36c7a086 on 2026-10-02
- Seen on a running system
- Not yet
- Help version
- 2026.0.0-preview
- Guide ID
erp:data/sales.shipment