Shipment
shipping.v1.Shipment
A parcel moving through a carrier network.
Fields
Section titled “Fields”Field presence and validation are separate properties. Implicit scalar defaults are normally omitted in ProtoJSON.
Application identifier. This field deliberately uses a custom JSON name.
| Property | Value |
|---|---|
| Protobuf name | id |
| JSON name | shipmentId |
| Field number | 1 |
| Protobuf type | string |
| JSON representation | String |
| Presence | Implicit; default and absent are not distinguished |
status
Section titled “status”Current carrier lifecycle status.
| Property | Value |
|---|---|
| Protobuf name | status |
| JSON name | status |
| Field number | 2 |
| Protobuf type | ShipmentStatus |
| JSON representation | Enum name (string) |
| Presence | Implicit; default and absent are not distinguished |
weight_mg
Section titled “weight_mg”Parcel mass, in milligrams. ProtoJSON encodes this 64-bit value as a string.
| Property | Value |
|---|---|
| Protobuf name | weight_mg |
| JSON name | weightMg |
| Field number | 3 |
| Protobuf type | uint64 |
| JSON representation | Decimal string |
| Presence | Implicit; default and absent are not distinguished |
created_at
Section titled “created_at”When the shipment was created.
| Property | Value |
|---|---|
| Protobuf name | created_at |
| JSON name | createdAt |
| Field number | 4 |
| Protobuf type | Timestamp |
| JSON representation | RFC 3339 string |
| Presence | Explicit; absent is distinct from the default |
metadata
Section titled “metadata”User-provided metadata. Values can contain text such as {priority} or <fragile>.
| Property | Value |
|---|---|
| Protobuf name | metadata |
| JSON name | metadata |
| Field number | 5 |
| Protobuf type | map of string to string |
| JSON representation | Object with string keys and string values |
| Presence | Collection; empty and absent are not distinguished |
events
Section titled “events”Carrier event history.
| Property | Value |
|---|---|
| Protobuf name | events |
| JSON name | events |
| Field number | 6 |
| Protobuf type | repeated ShipmentEvent |
| JSON representation | Array of object values |
| Presence | Collection; empty and absent are not distinguished |
proof_of_delivery
Section titled “proof_of_delivery”Optional binary proof of delivery. Encoded as base64 in JSON.
| Property | Value |
|---|---|
| Protobuf name | proof_of_delivery |
| JSON name | proofOfDelivery |
| Field number | 7 |
| Protobuf type | bytes |
| JSON representation | Base64 string |
| Presence | Implicit; default and absent are not distinguished |
street_address
Section titled “street_address”Street address for doorstep delivery.
| Property | Value |
|---|---|
| Protobuf name | street_address |
| JSON name | streetAddress |
| Field number | 8 |
| Protobuf type | string |
| JSON representation | String |
| Presence | Explicit; member of oneof destination |
pickup_point
Section titled “pickup_point”Carrier pickup point identifier.
| Property | Value |
|---|---|
| Protobuf name | pickup_point |
| JSON name | pickupPoint |
| Field number | 9 |
| Protobuf type | string |
| JSON representation | String |
| Presence | Explicit; member of oneof destination |
estimated_transit
Section titled “estimated_transit”Carrier’s estimated travel time.
| Property | Value |
|---|---|
| Protobuf name | estimated_transit |
| JSON name | estimatedTransit |
| Field number | 10 |
| Protobuf type | Duration |
| JSON representation | Duration string |
| Presence | Explicit; absent is distinct from the default |
related
Section titled “related”An optional related shipment. This is a recursive reference.
| Property | Value |
|---|---|
| Protobuf name | related |
| JSON name | related |
| Field number | 11 |
| Protobuf type | Shipment |
| JSON representation | Object |
| Presence | Explicit; absent is distinct from the default |
legacy_status
Section titled “legacy_status”Deprecated.
Historical display text. Use status instead.
| Property | Value |
|---|---|
| Protobuf name | legacy_status |
| JSON name | legacyStatus |
| Field number | 12 |
| Protobuf type | string |
| JSON representation | String |
| Presence | Implicit; default and absent are not distinguished |
delivery_address
Section titled “delivery_address”Destination information defined in an imported file.
| Property | Value |
|---|---|
| Protobuf name | delivery_address |
| JSON name | deliveryAddress |
| Field number | 13 |
| Protobuf type | PostalAddress |
| JSON representation | Object |
| Presence | Explicit; absent is distinct from the default |
carrier_quotes
Section titled “carrier_quotes”Quotes indexed by carrier; a map whose values are imported message types.
| Property | Value |
|---|---|
| Protobuf name | carrier_quotes |
| JSON name | carrierQuotes |
| Field number | 14 |
| Protobuf type | map of string to CurrencyAmount |
| JSON representation | Object with string keys and object values |
| Presence | Collection; empty and absent are not distinguished |
insurance
Section titled “insurance”A nested message with its own nested enum.
| Property | Value |
|---|---|
| Protobuf name | insurance |
| JSON name | insurance |
| Field number | 15 |
| Protobuf type | Insurance |
| JSON representation | Object |
| Presence | Explicit; absent is distinct from the default |
carrier_details
Section titled “carrier_details”Carrier-specific typed details. JSON uses an @type URL.
| Property | Value |
|---|---|
| Protobuf name | carrier_details |
| JSON name | carrierDetails |
| Field number | 16 |
| Protobuf type | Any |
| JSON representation | Object with @type |
| Presence | Explicit; absent is distinct from the default |
properties
Section titled “properties”Arbitrary JSON-compatible application properties.
| Property | Value |
|---|---|
| Protobuf name | properties |
| JSON name | properties |
| Field number | 17 |
| Protobuf type | Struct |
| JSON representation | JSON object |
| Presence | Explicit; absent is distinct from the default |
Source: fixture-v1 · Generator: Wirelit 0.1.0