Class: Google::Shopping::Merchant::OrderTracking::V1beta::OrderTrackingSignal::ShippingInfo

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/shopping/merchant/ordertracking/v1beta/order_tracking_signals.rb

Overview

The shipping information for the order.

Defined Under Namespace

Modules: ShippingState

Instance Attribute Summary collapse

Instance Attribute Details

#actual_delivery_time ⇒ ::Google::Type::DateTime

Returns Optional. 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.

Returns:

  • (::Google::Type::DateTime) —

    Optional. 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.



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'proto_docs/google/shopping/merchant/ordertracking/v1beta/order_tracking_signals.rb', line 145

class ShippingInfo
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The current status of the shipments.
  module ShippingState
    # The shipping status is not known to business.
    SHIPPING_STATE_UNSPECIFIED = 0

    # All items are shipped.
    SHIPPED = 1

    # The shipment is already delivered.
    DELIVERED = 2
  end
end

#carrier ⇒ ::String

Returns Optional. 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.

Returns:

  • (::String) —

    Optional. 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.



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'proto_docs/google/shopping/merchant/ordertracking/v1beta/order_tracking_signals.rb', line 145

class ShippingInfo
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The current status of the shipments.
  module ShippingState
    # The shipping status is not known to business.
    SHIPPING_STATE_UNSPECIFIED = 0

    # All items are shipped.
    SHIPPED = 1

    # The shipment is already delivered.
    DELIVERED = 2
  end
end

#carrier_service ⇒ ::String

Returns Optional. The service type for fulfillment, such as GROUND, FIRST_CLASS, etc.

Returns:

  • (::String) —

    Optional. The service type for fulfillment, such as GROUND, FIRST_CLASS, etc.



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'proto_docs/google/shopping/merchant/ordertracking/v1beta/order_tracking_signals.rb', line 145

class ShippingInfo
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The current status of the shipments.
  module ShippingState
    # The shipping status is not known to business.
    SHIPPING_STATE_UNSPECIFIED = 0

    # All items are shipped.
    SHIPPED = 1

    # The shipment is already delivered.
    DELIVERED = 2
  end
end

#earliest_delivery_promise_time ⇒ ::Google::Type::DateTime

Returns Optional. 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.

Returns:

  • (::Google::Type::DateTime) —

    Optional. 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.



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'proto_docs/google/shopping/merchant/ordertracking/v1beta/order_tracking_signals.rb', line 145

class ShippingInfo
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The current status of the shipments.
  module ShippingState
    # The shipping status is not known to business.
    SHIPPING_STATE_UNSPECIFIED = 0

    # All items are shipped.
    SHIPPED = 1

    # The shipment is already delivered.
    DELIVERED = 2
  end
end

#latest_delivery_promise_time ⇒ ::Google::Type::DateTime

Returns Optional. 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.

Returns:

  • (::Google::Type::DateTime) —

    Optional. 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.



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'proto_docs/google/shopping/merchant/ordertracking/v1beta/order_tracking_signals.rb', line 145

class ShippingInfo
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The current status of the shipments.
  module ShippingState
    # The shipping status is not known to business.
    SHIPPING_STATE_UNSPECIFIED = 0

    # All items are shipped.
    SHIPPED = 1

    # The shipment is already delivered.
    DELIVERED = 2
  end
end

#origin_postal_code ⇒ ::String

Returns Required. The origin postal code, as a continuous string without spaces or dashes, for example "95016". This field will be anonymized in returned OrderTrackingSignal creation response.

Returns:

  • (::String) —

    Required. The origin postal code, as a continuous string without spaces or dashes, for example "95016". This field will be anonymized in returned OrderTrackingSignal creation response.



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'proto_docs/google/shopping/merchant/ordertracking/v1beta/order_tracking_signals.rb', line 145

class ShippingInfo
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The current status of the shipments.
  module ShippingState
    # The shipping status is not known to business.
    SHIPPING_STATE_UNSPECIFIED = 0

    # All items are shipped.
    SHIPPED = 1

    # The shipment is already delivered.
    DELIVERED = 2
  end
end

#origin_region_code ⇒ ::String

Returns Required. The CLDR territory code for the shipping origin.

Returns:



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'proto_docs/google/shopping/merchant/ordertracking/v1beta/order_tracking_signals.rb', line 145

class ShippingInfo
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The current status of the shipments.
  module ShippingState
    # The shipping status is not known to business.
    SHIPPING_STATE_UNSPECIFIED = 0

    # All items are shipped.
    SHIPPED = 1

    # The shipment is already delivered.
    DELIVERED = 2
  end
end

#shipment_id ⇒ ::String

Returns Required. The shipment ID. This field will be hashed in returned OrderTrackingSignal creation response.

Returns:

  • (::String) —

    Required. The shipment ID. This field will be hashed in returned OrderTrackingSignal creation response.



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'proto_docs/google/shopping/merchant/ordertracking/v1beta/order_tracking_signals.rb', line 145

class ShippingInfo
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The current status of the shipments.
  module ShippingState
    # The shipping status is not known to business.
    SHIPPING_STATE_UNSPECIFIED = 0

    # All items are shipped.
    SHIPPED = 1

    # The shipment is already delivered.
    DELIVERED = 2
  end
end

#shipped_time ⇒ ::Google::Type::DateTime

Returns Optional. The time when the shipment was shipped. Include the year and timezone string, if available.

Returns:

  • (::Google::Type::DateTime) —

    Optional. The time when the shipment was shipped. Include the year and timezone string, if available.



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'proto_docs/google/shopping/merchant/ordertracking/v1beta/order_tracking_signals.rb', line 145

class ShippingInfo
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The current status of the shipments.
  module ShippingState
    # The shipping status is not known to business.
    SHIPPING_STATE_UNSPECIFIED = 0

    # All items are shipped.
    SHIPPED = 1

    # The shipment is already delivered.
    DELIVERED = 2
  end
end

#shipping_status ⇒ ::Google::Shopping::Merchant::OrderTracking::V1beta::OrderTrackingSignal::ShippingInfo::ShippingState

Returns Required. The status of the shipment.

Returns:



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'proto_docs/google/shopping/merchant/ordertracking/v1beta/order_tracking_signals.rb', line 145

class ShippingInfo
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The current status of the shipments.
  module ShippingState
    # The shipping status is not known to business.
    SHIPPING_STATE_UNSPECIFIED = 0

    # All items are shipped.
    SHIPPED = 1

    # The shipment is already delivered.
    DELIVERED = 2
  end
end

#tracking_id ⇒ ::String

Returns Optional. 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.

Returns:

  • (::String) —

    Optional. 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.



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'proto_docs/google/shopping/merchant/ordertracking/v1beta/order_tracking_signals.rb', line 145

class ShippingInfo
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The current status of the shipments.
  module ShippingState
    # The shipping status is not known to business.
    SHIPPING_STATE_UNSPECIFIED = 0

    # All items are shipped.
    SHIPPED = 1

    # The shipment is already delivered.
    DELIVERED = 2
  end
end