View Source GoogleApi.Content.V21.Model.OrderTrackingSignalShippingInfo (google_api_content v0.67.1)

The shipping information for the order.

Attributes

  • actualDeliveryTime (type: GoogleApi.Content.V21.Model.DateTime.t, default: nil) - The time when the shipment was actually delivered. Include the year and timezone string, if available. This field is required, if one of the following fields is absent: tracking_id or carrier_name.
  • carrierName (type: String.t, default: nil) - The name of the shipping carrier for the delivery. This field is required if one of the following fields is absent: earliest_delivery_promise_time, latest_delivery_promise_time, and actual_delivery_time.
  • carrierServiceName (type: String.t, default: nil) - The service type for fulfillment, e.g., GROUND, FIRST_CLASS, etc.
  • earliestDeliveryPromiseTime (type: GoogleApi.Content.V21.Model.DateTime.t, default: nil) - The earliest delivery promised time. Include the year and timezone string, if available. This field is required, if one of the following fields is absent: tracking_id or carrier_name.
  • latestDeliveryPromiseTime (type: GoogleApi.Content.V21.Model.DateTime.t, default: nil) - The latest delivery promised time. Include the year and timezone string, if available. This field is required, if one of the following fields is absent: tracking_id or carrier_name.
  • originPostalCode (type: String.t, default: nil) - The origin postal code, as a continuous string without spaces or dashes, e.g. "95016". This field will be anonymized in returned OrderTrackingSignal creation response.
  • originRegionCode (type: String.t, default: nil) - The [CLDR territory code] (http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) for the shipping origin.
  • shipmentId (type: String.t, default: nil) - Required. The shipment ID. This field will be hashed in returned OrderTrackingSignal creation response.
  • shippedTime (type: GoogleApi.Content.V21.Model.DateTime.t, default: nil) - The time when the shipment was shipped. Include the year and timezone string, if available.
  • shippingStatus (type: String.t, default: nil) - The status of the shipment.
  • trackingId (type: String.t, default: nil) - The tracking ID of the shipment. This field is required if one of the following fields is absent: earliest_delivery_promise_time, latest_delivery_promise_time, and actual_delivery_time.

Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Types

@type t() :: %GoogleApi.Content.V21.Model.OrderTrackingSignalShippingInfo{
  actualDeliveryTime: GoogleApi.Content.V21.Model.DateTime.t() | nil,
  carrierName: String.t() | nil,
  carrierServiceName: String.t() | nil,
  earliestDeliveryPromiseTime: GoogleApi.Content.V21.Model.DateTime.t() | nil,
  latestDeliveryPromiseTime: GoogleApi.Content.V21.Model.DateTime.t() | nil,
  originPostalCode: String.t() | nil,
  originRegionCode: String.t() | nil,
  shipmentId: String.t() | nil,
  shippedTime: GoogleApi.Content.V21.Model.DateTime.t() | nil,
  shippingStatus: String.t() | nil,
  trackingId: String.t() | nil
}

Functions

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.