Class CarrierShipping

Carrier-based shipping configuration. Allows for setting shipping speed or shipping cost based on a carrier's provided info.

Inheritance

object

CarrierShipping

Implements

IDirectResponseSchema

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.Merchant.products_v1.Data

Assembly: Google.Apis.Merchant.products_v1.dll

Syntax

public class CarrierShipping : IDirectResponseSchema

Properties

CarrierPrice

Selected carrier to calculate the shipping price from. Select a carrier from the available carriers list, for example AUSTRALIA_POST_REGULAR. Price will be calculated by this selected carrier, the location expressed in originPostalCode, along with the user location to determine the accurate shipping price. Carrier is represented by a carrier service name or a carrier service ID. Cannot be set together with flatPrice.

Declaration

[JsonProperty("carrierPrice")]
public virtual string CarrierPrice { get; set; }

Property Value

Type	Description
string

CarrierPriceFlatAdjustment

A flat adjustment on the carrier price. Can be either positive or negative. Cannot be zero. Requires carrier_price to be present. Cannot be set together with flatPrice and carrierPricePercentageAdjustment.

Declaration

[JsonProperty("carrierPriceFlatAdjustment")]
public virtual Price CarrierPriceFlatAdjustment { get; set; }

Property Value

Type	Description
Price

CarrierPricePercentageAdjustment

A percentual adjustment on the carrier price. Can be either positive or negative. Cannot be zero. Requires carrier_price to be present. Cannot be set together with flatPrice and carrierPriceFlatAdjustment.

Declaration

[JsonProperty("carrierPricePercentageAdjustment")]
public virtual double? CarrierPricePercentageAdjustment { get; set; }

Property Value

Type	Description
double?

CarrierTransitTime

Selected carrier to calculate the shipping speed from. Select a carrier from the available carriers list, for example AUSTRALIA_POST_REGULAR. Speed will be calculated by this selected carrier, the location expressed in originPostalCode, along with the user location to determine the accurate delivery speed. Carrier is represented by a carrier service name or a carrier service ID. Cannot be set together with fixedMaxTransitTime or fixedMinTransitTime.

Declaration

[JsonProperty("carrierTransitTime")]
public virtual string CarrierTransitTime { get; set; }

Property Value

Type	Description
string

Country

The CLDR territory code of the country to which an item will ship.

Declaration

[JsonProperty("country")]
public virtual string Country { 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

FixedMaxTransitTime

Maximum transit time (inclusive) between when the order has shipped and when it is delivered in business days. 0 means that the order is delivered on the same day as it ships. Needs to be provided together with maxHandlingTime. Cannot be set if carrierTransitTime is present.

Declaration

[JsonProperty("fixedMaxTransitTime")]
public virtual long? FixedMaxTransitTime { get; set; }

Property Value

Type	Description
long?

FixedMinTransitTime

Minimum transit time (inclusive) between when the order has shipped and when it is delivered in business days. 0 means that the order is delivered on the same day as it ships. fixedMinTransitTime can only be set if fixedMaxTransitTime is set. Cannot be set if carrierTransitTime is present.

Declaration

[JsonProperty("fixedMinTransitTime")]
public virtual long? FixedMinTransitTime { get; set; }

Property Value

Type	Description
long?

FlatPrice

Fixed shipping price, represented as a number with currency. Cannot be set together with carrierPrice or its adjustments (carrierPriceFlatAdjustment, carrierPricePercentageAdjustment).

Declaration

[JsonProperty("flatPrice")]
public virtual Price FlatPrice { get; set; }

Property Value

Type	Description
Price

MaxHandlingTime

Maximum handling time (inclusive) between when the order is received and shipped in business days. 0 means that the order is shipped on the same day as it is received if it happens before the cut-off time. Both maxHandlingTime and fixedMaxTransitTime or carrierTransitTime are required if providing shipping speeds.

Declaration

[JsonProperty("maxHandlingTime")]
public virtual long? MaxHandlingTime { get; set; }

Property Value

Type	Description
long?

MinHandlingTime

Minimum handling time (inclusive) between when the order is received and shipped in business days. 0 means that the order is shipped on the same day as it is received if it happens before the cut-off time. minHandlingTime can only be set if maxHandlingTime is also set.

Declaration

[JsonProperty("minHandlingTime")]
public virtual long? MinHandlingTime { get; set; }

Property Value

Type	Description
long?

OriginPostalCode

The source location postal code from which this offer ships. Represented only by a full-length postal code.

Declaration

[JsonProperty("originPostalCode")]
public virtual string OriginPostalCode { get; set; }

Property Value

Type	Description
string

PostalCode

The postal code range that the shipping rate applies to, represented by a postal code (eg. 94043), a postal code prefix followed by a * wildcard (eg. 94*), a range between two postal codes (eg. 94043-98033) or two postal code prefixes of equal length (eg. 94*-98*).

Declaration

[JsonProperty("postalCode")]
public virtual string PostalCode { get; set; }

Property Value

Type	Description
string

Region

The geographic region to which a shipping rate applies. See region for more information.

Declaration

[JsonProperty("region")]
public virtual string Region { get; set; }

Property Value

Type	Description
string

Implements

IDirectResponseSchema