Class OrderTrackingSignal
Represents a merchant trade from which signals are extracted, e.g. shipping.
Implements
Inherited Members
Namespace: Google.Apis.ShoppingContent.v2_1.Data
Assembly: Google.Apis.ShoppingContent.v2_1.dll
Syntax
public class OrderTrackingSignal : IDirectResponseSchema
Properties
CustomerShippingFee
The shipping fee of the order; this value should be set to zero in the case of free shipping.
Declaration
[JsonProperty("customerShippingFee")]
public virtual PriceAmount CustomerShippingFee { get; set; }
Property Value
Type | Description |
---|---|
PriceAmount |
DeliveryPostalCode
Required. The delivery postal code, as a continuous string without spaces or dashes, e.g. "95016". This field will be anonymized in returned OrderTrackingSignal creation response.
Declaration
[JsonProperty("deliveryPostalCode")]
public virtual string DeliveryPostalCode { get; set; }
Property Value
Type | Description |
---|---|
string |
DeliveryRegionCode
Required. The [CLDR territory code] (http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) for the shipping destination.
Declaration
[JsonProperty("deliveryRegionCode")]
public virtual string DeliveryRegionCode { 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 |
LineItems
Information about line items in the order.
Declaration
[JsonProperty("lineItems")]
public virtual IList<OrderTrackingSignalLineItemDetails> LineItems { get; set; }
Property Value
Type | Description |
---|---|
IList<OrderTrackingSignalLineItemDetails> |
MerchantId
The Google merchant ID of this order tracking signal. This value is optional. If left unset, the caller's merchant ID is used. You must request access in order to provide data on behalf of another merchant. For more information, see Submitting Order Tracking Signals.
Declaration
[JsonProperty("merchantId")]
public virtual long? MerchantId { get; set; }
Property Value
Type | Description |
---|---|
long? |
OrderCreatedTime
Required. The time when the order was created on the merchant side. Include the year and timezone string, if available.
Declaration
[JsonProperty("orderCreatedTime")]
public virtual DateTime OrderCreatedTime { get; set; }
Property Value
Type | Description |
---|---|
DateTime |
OrderId
Required. The ID of the order on the merchant side. This field will be hashed in returned OrderTrackingSignal creation response.
Declaration
[JsonProperty("orderId")]
public virtual string OrderId { get; set; }
Property Value
Type | Description |
---|---|
string |
OrderTrackingSignalId
Output only. The ID that uniquely identifies this order tracking signal.
Declaration
[JsonProperty("orderTrackingSignalId")]
public virtual long? OrderTrackingSignalId { get; set; }
Property Value
Type | Description |
---|---|
long? |
ShipmentLineItemMapping
The mapping of the line items to the shipment information.
Declaration
[JsonProperty("shipmentLineItemMapping")]
public virtual IList<OrderTrackingSignalShipmentLineItemMapping> ShipmentLineItemMapping { get; set; }
Property Value
Type | Description |
---|---|
IList<OrderTrackingSignalShipmentLineItemMapping> |
ShippingInfo
The shipping information for the order.
Declaration
[JsonProperty("shippingInfo")]
public virtual IList<OrderTrackingSignalShippingInfo> ShippingInfo { get; set; }
Property Value
Type | Description |
---|---|
IList<OrderTrackingSignalShippingInfo> |