Class: Google::Apis::ContentV2::OrderShipment
- Inherits:
-
Object
- Object
- Google::Apis::ContentV2::OrderShipment
- 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
-
#carrier ⇒ String
The carrier handling the shipment.
-
#creation_date ⇒ String
Date on which the shipment has been created, in ISO 8601 format.
-
#delivery_date ⇒ String
Date on which the shipment has been delivered, in ISO 8601 format.
-
#id ⇒ String
The ID of the shipment.
-
#line_items ⇒ Array<Google::Apis::ContentV2::OrderShipmentLineItemShipment>
The line items that are shipped.
-
#status ⇒ String
The status of the shipment.
-
#tracking_id ⇒ String
The tracking ID for the shipment.
Instance Method Summary collapse
-
#initialize(**args) ⇒ OrderShipment
constructor
A new instance of OrderShipment.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Google::Apis::Core::JsonObjectSupport
Methods included from Google::Apis::Core::Hashable
Constructor Details
#initialize(**args) ⇒ OrderShipment
Returns a new instance of OrderShipment.
5334 5335 5336 |
# File 'generated/google/apis/content_v2/classes.rb', line 5334 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)
Corresponds to the JSON property
carrier
5301 5302 5303 |
# File 'generated/google/apis/content_v2/classes.rb', line 5301 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
5306 5307 5308 |
# File 'generated/google/apis/content_v2/classes.rb', line 5306 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
5312 5313 5314 |
# File 'generated/google/apis/content_v2/classes.rb', line 5312 def delivery_date @delivery_date end |
#id ⇒ String
The ID of the shipment.
Corresponds to the JSON property id
5317 5318 5319 |
# File 'generated/google/apis/content_v2/classes.rb', line 5317 def id @id end |
#line_items ⇒ Array<Google::Apis::ContentV2::OrderShipmentLineItemShipment>
The line items that are shipped.
Corresponds to the JSON property lineItems
5322 5323 5324 |
# File 'generated/google/apis/content_v2/classes.rb', line 5322 def line_items @line_items end |
#status ⇒ String
The status of the shipment.
Corresponds to the JSON property status
5327 5328 5329 |
# File 'generated/google/apis/content_v2/classes.rb', line 5327 def status @status end |
#tracking_id ⇒ String
The tracking ID for the shipment.
Corresponds to the JSON property trackingId
5332 5333 5334 |
# File 'generated/google/apis/content_v2/classes.rb', line 5332 def tracking_id @tracking_id end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
5339 5340 5341 5342 5343 5344 5345 5346 5347 |
# File 'generated/google/apis/content_v2/classes.rb', line 5339 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 |