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

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
generated/google/apis/content_v2/classes.rb,
generated/google/apis/content_v2/representations.rb,
generated/google/apis/content_v2/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.



5337
5338
5339
 
# File 'generated/google/apis/content_v2/classes.rb', line 5337

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


5304
5305
5306
 
# File 'generated/google/apis/content_v2/classes.rb', line 5304

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) 


5309
5310
5311
 
# File 'generated/google/apis/content_v2/classes.rb', line 5309

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) 


5315
5316
5317
 
# File 'generated/google/apis/content_v2/classes.rb', line 5315

def delivery_date
  @delivery_date
end

#id ⇒ String

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

Returns:

  • (String) 


5320
5321
5322
 
# File 'generated/google/apis/content_v2/classes.rb', line 5320

def id
  @id
end

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

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

Returns:



5325
5326
5327
 
# File 'generated/google/apis/content_v2/classes.rb', line 5325

def line_items
  @line_items
end

#status ⇒ String

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

Returns:

  • (String) 


5330
5331
5332
 
# File 'generated/google/apis/content_v2/classes.rb', line 5330

def status
  @status
end

#tracking_id ⇒ String

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

Returns:

  • (String) 


5335
5336
5337
 
# File 'generated/google/apis/content_v2/classes.rb', line 5335

def tracking_id
  @tracking_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5342
5343
5344
5345
5346
5347
5348
5349
5350
 
# File 'generated/google/apis/content_v2/classes.rb', line 5342

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