Class: Google::Apis::ContentV2_1::OrderShipment
- Inherits:
-
Object
- Object
- Google::Apis::ContentV2_1::OrderShipment
- 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
-
#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_1::OrderShipmentLineItemShipment>
The line items that are shipped.
-
#shipment_group_id ⇒ String
The shipment group ID of the shipment.
-
#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.
4821 4822 4823 |
# File 'generated/google/apis/content_v2_1/classes.rb', line 4821 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
4783 4784 4785 |
# File 'generated/google/apis/content_v2_1/classes.rb', line 4783 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
4788 4789 4790 |
# File 'generated/google/apis/content_v2_1/classes.rb', line 4788 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
4794 4795 4796 |
# File 'generated/google/apis/content_v2_1/classes.rb', line 4794 def delivery_date @delivery_date end |
#id ⇒ String
The ID of the shipment.
Corresponds to the JSON property id
4799 4800 4801 |
# File 'generated/google/apis/content_v2_1/classes.rb', line 4799 def id @id end |
#line_items ⇒ Array<Google::Apis::ContentV2_1::OrderShipmentLineItemShipment>
The line items that are shipped.
Corresponds to the JSON property lineItems
4804 4805 4806 |
# File 'generated/google/apis/content_v2_1/classes.rb', line 4804 def line_items @line_items end |
#shipment_group_id ⇒ String
The shipment group ID of the shipment. This is set in shiplineitems request.
Corresponds to the JSON property shipmentGroupId
4809 4810 4811 |
# File 'generated/google/apis/content_v2_1/classes.rb', line 4809 def shipment_group_id @shipment_group_id end |
#status ⇒ String
The status of the shipment.
Corresponds to the JSON property status
4814 4815 4816 |
# File 'generated/google/apis/content_v2_1/classes.rb', line 4814 def status @status end |
#tracking_id ⇒ String
The tracking ID for the shipment.
Corresponds to the JSON property trackingId
4819 4820 4821 |
# File 'generated/google/apis/content_v2_1/classes.rb', line 4819 def tracking_id @tracking_id end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 |
# File 'generated/google/apis/content_v2_1/classes.rb', line 4826 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) @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 |