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

Constructor Details

#initialize(**args) ⇒ OrderShipment

Returns a new instance of OrderShipment.



5792
5793
5794
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 5792

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) 


5748
5749
5750
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 5748

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) 


5753
5754
5755
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 5753

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) 


5759
5760
5761
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 5759

def delivery_date
  @delivery_date
end

#id ⇒ String

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

Returns:

  • (String) 


5764
5765
5766
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 5764

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:



5769
5770
5771
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 5769

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:



5774
5775
5776
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 5774

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) 


5779
5780
5781
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 5779

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) 


5785
5786
5787
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 5785

def status
  @status
end

#tracking_id ⇒ String

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

Returns:

  • (String) 


5790
5791
5792
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 5790

def tracking_id
  @tracking_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5797
5798
5799
5800
5801
5802
5803
5804
5805
5806
5807
 
# File 'generated/google/apis/content_v2_1/classes.rb', line 5797

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