Class OrderShipment
Implements
Inherited Members
Namespace: Google.Apis.ShoppingContent.v2_1.Data
Assembly: Google.Apis.ShoppingContent.v2_1.dll
Syntax
public class OrderShipment : IDirectResponseSchema
Properties
Carrier
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
won't 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) - "lso
" (Lone Star Overnight) - "tww
" (Team Worldwide) - "deliver-it
" (Deliver-IT) - "cdl last mile
" (CDL Last Mile) 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)
Declaration
[JsonProperty("carrier")]
public virtual string Carrier { get; set; }
Property Value
Type | Description |
---|---|
string |
CreationDate
Date on which the shipment has been created, in ISO 8601 format.
Declaration
[JsonProperty("creationDate")]
public virtual string CreationDate { get; set; }
Property Value
Type | Description |
---|---|
string |
DeliveryDate
Date on which the shipment has been delivered, in ISO 8601 format. Present only if status
is delivered
Declaration
[JsonProperty("deliveryDate")]
public virtual string DeliveryDate { get; set; }
Property Value
Type | Description |
---|---|
string |
ETag
The ETag of the item.
Declaration
public virtual string ETag { get; set; }
Property Value
Type | Description |
---|---|
string |
Id
The ID of the shipment.
Declaration
[JsonProperty("id")]
public virtual string Id { get; set; }
Property Value
Type | Description |
---|---|
string |
LineItems
The line items that are shipped.
Declaration
[JsonProperty("lineItems")]
public virtual IList<OrderShipmentLineItemShipment> LineItems { get; set; }
Property Value
Type | Description |
---|---|
IList<OrderShipmentLineItemShipment> |
ScheduledDeliveryDetails
Delivery details of the shipment if scheduling is needed.
Declaration
[JsonProperty("scheduledDeliveryDetails")]
public virtual OrderShipmentScheduledDeliveryDetails ScheduledDeliveryDetails { get; set; }
Property Value
Type | Description |
---|---|
OrderShipmentScheduledDeliveryDetails |
ShipmentGroupId
The shipment group ID of the shipment. This is set in shiplineitems request.
Declaration
[JsonProperty("shipmentGroupId")]
public virtual string ShipmentGroupId { get; set; }
Property Value
Type | Description |
---|---|
string |
Status
The status of the shipment. Acceptable values are: - "delivered
" - "readyForPickup
" - "shipped
" -
"undeliverable
"
Declaration
[JsonProperty("status")]
public virtual string Status { get; set; }
Property Value
Type | Description |
---|---|
string |
TrackingId
The tracking ID for the shipment.
Declaration
[JsonProperty("trackingId")]
public virtual string TrackingId { get; set; }
Property Value
Type | Description |
---|---|
string |