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.



8569
8570
8571
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 8569

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) 


8516
8517
8518
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 8516

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) 


8522
8523
8524
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 8522

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) 


8529
8530
8531
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 8529

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) 


8534
8535
8536
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 8534

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) 


8540
8541
8542
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 8540

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:



8545
8546
8547
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 8545

def scheduled_delivery_details
  @scheduled_delivery_details
end

#shipment_id ⇒ String

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

Returns:

  • (String) 


8550
8551
8552
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 8550

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) 


8556
8557
8558
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 8556

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) 


8561
8562
8563
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 8561

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) 


8567
8568
8569
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 8567

def undelivered_date
  @undelivered_date
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
8585
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 8574

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