Class: Google::Apis::ContentV2::OrderShipment

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ OrderShipment

Returns a new instance of OrderShipment.



5143
5144
5145
 
# File 'lib/google/apis/content_v2/classes.rb', line 5143

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


5104
5105
5106
 
# File 'lib/google/apis/content_v2/classes.rb', line 5104

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) 


5109
5110
5111
 
# File 'lib/google/apis/content_v2/classes.rb', line 5109

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) 


5115
5116
5117
 
# File 'lib/google/apis/content_v2/classes.rb', line 5115

def delivery_date
  @delivery_date
end

#id ⇒ String

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

Returns:

  • (String) 


5120
5121
5122
 
# File 'lib/google/apis/content_v2/classes.rb', line 5120

def id
  @id
end

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

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

Returns:



5125
5126
5127
 
# File 'lib/google/apis/content_v2/classes.rb', line 5125

def line_items
  @line_items
end

#scheduled_delivery_details ⇒ Google::Apis::ContentV2::OrderShipmentScheduledDeliveryDetails

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

Returns:



5130
5131
5132
 
# File 'lib/google/apis/content_v2/classes.rb', line 5130

def scheduled_delivery_details
  @scheduled_delivery_details
end

#status ⇒ String

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

Returns:

  • (String) 


5136
5137
5138
 
# File 'lib/google/apis/content_v2/classes.rb', line 5136

def status
  @status
end

#tracking_id ⇒ String

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

Returns:

  • (String) 


5141
5142
5143
 
# File 'lib/google/apis/content_v2/classes.rb', line 5141

def tracking_id
  @tracking_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
 
# File 'lib/google/apis/content_v2/classes.rb', line 5148

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