GetShipmentRequest
shipping.v1.GetShipmentRequest
Look up one shipment using its application identifier.
Fields
Section titled “Fields”Field presence and validation are separate properties. Implicit scalar defaults are normally omitted in ProtoJSON.
shipment_id
Section titled “shipment_id”The shipment identifier. Example: shp_123.
| Property | Value |
|---|---|
| Protobuf name | shipment_id |
| JSON name | shipmentId |
| Field number | 1 |
| Protobuf type | string |
| JSON representation | String |
| Presence | Implicit; default and absent are not distinguished |
include_events
Section titled “include_events”Include the event history when explicitly set to true.
| Property | Value |
|---|---|
| Protobuf name | include_events |
| JSON name | includeEvents |
| Field number | 2 |
| Protobuf type | bool |
| JSON representation | Boolean |
| Presence | Explicit; absent is distinct from the default |
read_mask
Section titled “read_mask”Optional projection of response fields. ProtoJSON uses comma-separated camelCase paths.
| Property | Value |
|---|---|
| Protobuf name | read_mask |
| JSON name | readMask |
| Field number | 3 |
| Protobuf type | FieldMask |
| JSON representation | Comma-separated string |
| Presence | Explicit; absent is distinct from the default |
Source: fixture-v1 · Generator: Wirelit 0.1.0