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

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) ⇒ OrderShipment

Returns a new instance of OrderShipment.



6520
6521
6522
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 6520

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

Instance Attribute Details

#carrier ⇒ String

The carrier handling the shipment. For supported carriers, Google includes the carrier name and tracking URL in emails to customers. For select supported carriers, Google also automatically updates the shipment status based on the provided shipment ID. Note: You can also use unsupported carriers, but emails to customers will not include the carrier name or tracking URL, and there will be no automatic order status updates. Supported carriers for US are:

  • "ups" (United Parcel Service) automatic status updates - "usps" ( United States Postal Service) automatic status updates - "fedex" (FedEx) * automatic status updates * - "dhl" (DHL eCommerce) automatic status updates (US only) - "ontrac" (OnTrac) automatic status updates * - "dhl express" (DHL Express) - "deliv" (Deliv) - "dynamex" (TForce) - "lasership" ( LaserShip) - "mpx" (Military Parcel Xpress) - "uds" (United Delivery Service) - "efw" (Estes Forwarding Worldwide) - "jd logistics" (JD Logistics) - "yunexpress" (YunExpress) - "china post" (China Post) - " china ems" (China Post Express Mail Service) - "singapore post" (Singapore Post) - "pos malaysia" (Pos Malaysia) - "postnl" (PostNL) - "ptt" (PTT Turkish Post) - "eub" (ePacket) - "chukou1" (Chukou1 Logistics) - "bestex " (Best Express) - "canada post" (Canada Post) - "purolator" (Purolator) - "canpar" (Canpar) - "india post" (India Post) - "blue dart" (Blue Dart) - "delhivery" (Delhivery) - "dtdc" (DTDC) - "tpc india" (TPC India) - " lso" (Lone Star Overnight) - "tww" (Team Worldwide) Supported carriers for FR are: - "la poste" (La Poste) *automatic status updates * - "colissimo" ( Colissimo by La Poste) *automatic status updates - "ups" (United Parcel Service) *automatic status updates * - "chronopost" (Chronopost by La Poste)
  • "gls" (General Logistics Systems France) - "dpd" (DPD Group by GeoPost) - "bpost" (Belgian Post Group) - "colis prive" (Colis PrivĂ©) - "boxtal" ( Boxtal) - "geodis" (GEODIS) - "tnt" (TNT) - "db schenker" (DB Schenker) - "aramex" (Aramex) Corresponds to the JSON property carrier

Returns:

  • (String) 


6476
6477
6478
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 6476

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) 


6481
6482
6483
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 6481

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) 


6487
6488
6489
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 6487

def delivery_date
  @delivery_date
end

#id ⇒ String

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

Returns:

  • (String) 


6492
6493
6494
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 6492

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:



6497
6498
6499
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 6497

def line_items
  @line_items
end

#scheduled_delivery_details ⇒ Google::Apis::ContentV2_1::OrderShipmentScheduledDeliveryDetails

Delivery details of the shipment if scheduling is needed. Corresponds to the JSON property scheduledDeliveryDetails

Returns:



6502
6503
6504
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 6502

def scheduled_delivery_details
  @scheduled_delivery_details
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) 


6507
6508
6509
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 6507

def shipment_group_id
  @shipment_group_id
end

#status ⇒ String

The status of the shipment. Acceptable values are: - "delivered" - " readyForPickup" - "shipped" - "undeliverable" Corresponds to the JSON property status

Returns:

  • (String) 


6513
6514
6515
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 6513

def status
  @status
end

#tracking_id ⇒ String

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

Returns:

  • (String) 


6518
6519
6520
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 6518

def tracking_id
  @tracking_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6525
6526
6527
6528
6529
6530
6531
6532
6533
6534
6535
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 6525

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)
  @scheduled_delivery_details = args[:scheduled_delivery_details] if args.key?(:scheduled_delivery_details)
  @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