Class: Google::Apis::ContentV2_1::OrderShipment

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Google::Apis::Core::JsonObjectSupport

#to_json

Methods included from Google::Apis::Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ OrderShipment

Returns a new instance of OrderShipment



4678
4679
4680
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 4678

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

Instance Attribute Details

#carrier ⇒ String

The carrier handling the shipment. Acceptable values for US are:

  • "gsx"
  • "ups"
  • "usps"
  • "fedex"
  • "dhl"
  • "ecourier"
  • "cxt"
  • "google"
  • "ontrac"
  • "emsy"
  • "ont"
  • "deliv"
  • "dynamex"
  • "lasership"
  • "mpx"
  • "uds"
  • "efw" Acceptable values for FR are:
  • "colissimo"
  • "chronopost"
  • "gls"
  • "dpd"
  • "bpost"
  • "colis prive"
  • "boxtal"
  • "geodis" Corresponds to the JSON property carrier

Returns:

  • (String) 


4640
4641
4642
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 4640

def carrier
  @carrier
end

#creation_date ⇒ String

Date on which the shipment has been created, in ISO 8601 format. Corresponds to the JSON property creationDate

Returns:

  • (String) 


4645
4646
4647
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 4645

def creation_date
  @creation_date
end

#delivery_date ⇒ String

Date on which the shipment has been delivered, in ISO 8601 format. Present only if status is delivered Corresponds to the JSON property deliveryDate

Returns:

  • (String) 


4651
4652
4653
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 4651

def delivery_date
  @delivery_date
end

#id ⇒ String

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

Returns:

  • (String) 


4656
4657
4658
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 4656

def id
  @id
end

#line_items ⇒ Array<Google::Apis::ContentV2_1::OrderShipmentLineItemShipment>

The line items that are shipped. Corresponds to the JSON property lineItems

Returns:



4661
4662
4663
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 4661

def line_items
  @line_items
end

#shipment_group_id ⇒ String

The shipment group ID of the shipment. This is set in shiplineitems request. Corresponds to the JSON property shipmentGroupId

Returns:

  • (String) 


4666
4667
4668
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 4666

def shipment_group_id
  @shipment_group_id
end

#status ⇒ String

The status of the shipment. Corresponds to the JSON property status

Returns:

  • (String) 


4671
4672
4673
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 4671

def status
  @status
end

#tracking_id ⇒ String

The tracking ID for the shipment. Corresponds to the JSON property trackingId

Returns:

  • (String) 


4676
4677
4678
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 4676

def tracking_id
  @tracking_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 4683

def update!(**args)
  @carrier = args[:carrier] if args.key?(:carrier)
  @creation_date = args[:creation_date] if args.key?(:creation_date)
  @delivery_date = args[:delivery_date] if args.key?(:delivery_date)
  @id = args[:id] if args.key?(:id)
  @line_items = args[:line_items] if args.key?(:line_items)
  @shipment_group_id = args[:shipment_group_id] if args.key?(:shipment_group_id)
  @status = args[:status] if args.key?(:status)
  @tracking_id = args[:tracking_id] if args.key?(:tracking_id)
end