Class: Google::Apis::ContentV2_1::OrdersUpdateShipmentRequest

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/content_v2_1/classes.rb,
lib/google/apis/content_v2_1/representations.rb,
lib/google/apis/content_v2_1/representations.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ OrdersUpdateShipmentRequest

Returns a new instance of OrdersUpdateShipmentRequest.



9125
9126
9127
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 9125

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#carrier ⇒ String

The carrier handling the shipment. Not updated if missing. See shipments[]. carrier in the Orders resource representation for a list of acceptable values. Corresponds to the JSON property carrier

Returns:

  • (String) 


9072
9073
9074
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 9072

def carrier
  @carrier
end

#delivery_date ⇒ String

Date on which the shipment has been delivered, in ISO 8601 format. Optional and can be provided only if status is delivered. Corresponds to the JSON property deliveryDate

Returns:

  • (String) 


9078
9079
9080
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 9078

def delivery_date
  @delivery_date
end

#last_pickup_date ⇒ String

Date after which the pickup will expire, in ISO 8601 format. Required only when order is buy-online-pickup-in-store(BOPIS) and status is ready for pickup. Corresponds to the JSON property lastPickupDate

Returns:

  • (String) 


9085
9086
9087
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 9085

def last_pickup_date
  @last_pickup_date
end

#operation_id ⇒ String

The ID of the operation. Unique across all operations for a given order. Corresponds to the JSON property operationId

Returns:

  • (String) 


9090
9091
9092
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 9090

def operation_id
  @operation_id
end

#ready_pickup_date ⇒ String

Date on which the shipment has been ready for pickup, in ISO 8601 format. Optional and can be provided only if status is ready for pickup. Corresponds to the JSON property readyPickupDate

Returns:

  • (String) 


9096
9097
9098
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 9096

def ready_pickup_date
  @ready_pickup_date
end

#scheduled_delivery_details ⇒ Google::Apis::ContentV2_1::OrdersCustomBatchRequestEntryUpdateShipmentScheduledDeliveryDetails

ScheduledDeliveryDetails used to update the scheduled delivery order. Corresponds to the JSON property scheduledDeliveryDetails

Returns:



9101
9102
9103
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 9101

def scheduled_delivery_details
  @scheduled_delivery_details
end

#shipment_id ⇒ String

The ID of the shipment. Corresponds to the JSON property shipmentId

Returns:

  • (String) 


9106
9107
9108
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 9106

def shipment_id
  @shipment_id
end

#status ⇒ String

New status for the shipment. Not updated if missing. Acceptable values are: - " delivered" - "undeliverable" - "readyForPickup" Corresponds to the JSON property status

Returns:

  • (String) 


9112
9113
9114
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 9112

def status
  @status
end

#tracking_id ⇒ String

The tracking ID for the shipment. Not updated if missing. Corresponds to the JSON property trackingId

Returns:

  • (String) 


9117
9118
9119
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 9117

def tracking_id
  @tracking_id
end

#undelivered_date ⇒ String

Date on which the shipment has been undeliverable, in ISO 8601 format. Optional and can be provided only if status is undeliverable. Corresponds to the JSON property undeliveredDate

Returns:

  • (String) 


9123
9124
9125
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 9123

def undelivered_date
  @undelivered_date
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



9130
9131
9132
9133
9134
9135
9136
9137
9138
9139
9140
9141
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 9130

def update!(**args)
  @carrier = args[:carrier] if args.key?(:carrier)
  @delivery_date = args[:delivery_date] if args.key?(:delivery_date)
  @last_pickup_date = args[:last_pickup_date] if args.key?(:last_pickup_date)
  @operation_id = args[:operation_id] if args.key?(:operation_id)
  @ready_pickup_date = args[:ready_pickup_date] if args.key?(:ready_pickup_date)
  @scheduled_delivery_details = args[:scheduled_delivery_details] if args.key?(:scheduled_delivery_details)
  @shipment_id = args[:shipment_id] if args.key?(:shipment_id)
  @status = args[:status] if args.key?(:status)
  @tracking_id = args[:tracking_id] if args.key?(:tracking_id)
  @undelivered_date = args[:undelivered_date] if args.key?(:undelivered_date)
end