Google Shopping Merchant Accounts V1beta Client - Class DeliveryTime (0.3.1)

Reference documentation and code samples for the Google Shopping Merchant Accounts V1beta Client class DeliveryTime.

Time spent in various aspects from order to the delivery of the product.

Generated from protobuf message google.shopping.merchant.accounts.v1beta.DeliveryTime

Namespace

Google \ Shopping \ Merchant \ Accounts \ V1beta

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ min_transit_days int

Minimum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Either min_transit_days, max_transit_days or transit_time_table must be set, but not both.

↳ max_transit_days int

Maximum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Must be greater than or equal to min_transit_days.

↳ cutoff_time CutoffTime

Business days cutoff time definition. If not configured the cutoff time will be defaulted to 8AM PST.

↳ min_handling_days int

Minimum number of business days spent before an order is shipped. 0 means same day shipped, 1 means next day shipped. 'min_handling_days' and 'max_handling_days' should be either set or not set at the same time.

↳ max_handling_days int

Maximum number of business days spent before an order is shipped. 0 means same day shipped, 1 means next day shipped. Must be greater than or equal to min_handling_days. 'min_handling_days' and 'max_handling_days' should be either set or not set at the same time.

↳ transit_time_table TransitTable

Transit time table, number of business days spent in transit based on row and column dimensions. Either min_transit_days, max_transit_days or transit_time_table can be set, but not both.

↳ handling_business_day_config BusinessDayConfig

The business days during which orders can be handled. If not provided, Monday to Friday business days will be assumed.

↳ transit_business_day_config BusinessDayConfig

The business days during which orders can be in-transit. If not provided, Monday to Friday business days will be assumed.

↳ warehouse_based_delivery_times array<WarehouseBasedDeliveryTime>

Optional. Indicates that the delivery time should be calculated per warehouse (shipping origin location) based on the settings of the selected carrier. When set, no other transit time related field in [delivery time][[google.shopping.content.bundles.ShippingSetting.DeliveryTime] should be set.

getMinTransitDays

Minimum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery.

Either min_transit_days, max_transit_days or transit_time_table must be set, but not both.

Returns
Type Description
int

hasMinTransitDays

clearMinTransitDays

setMinTransitDays

Minimum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery.

Either min_transit_days, max_transit_days or transit_time_table must be set, but not both.

Parameter
Name Description
var int
Returns
Type Description
$this

getMaxTransitDays

Maximum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Must be greater than or equal to min_transit_days.

Returns
Type Description
int

hasMaxTransitDays

clearMaxTransitDays

setMaxTransitDays

Maximum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Must be greater than or equal to min_transit_days.

Parameter
Name Description
var int
Returns
Type Description
$this

getCutoffTime

Business days cutoff time definition.

If not configured the cutoff time will be defaulted to 8AM PST.

Returns
Type Description
CutoffTime|null

hasCutoffTime

clearCutoffTime

setCutoffTime

Business days cutoff time definition.

If not configured the cutoff time will be defaulted to 8AM PST.

Parameter
Name Description
var CutoffTime
Returns
Type Description
$this

getMinHandlingDays

Minimum number of business days spent before an order is shipped.

0 means same day shipped, 1 means next day shipped. 'min_handling_days' and 'max_handling_days' should be either set or not set at the same time.

Returns
Type Description
int

hasMinHandlingDays

clearMinHandlingDays

setMinHandlingDays

Minimum number of business days spent before an order is shipped.

0 means same day shipped, 1 means next day shipped. 'min_handling_days' and 'max_handling_days' should be either set or not set at the same time.

Parameter
Name Description
var int
Returns
Type Description
$this

getMaxHandlingDays

Maximum number of business days spent before an order is shipped.

0 means same day shipped, 1 means next day shipped. Must be greater than or equal to min_handling_days. 'min_handling_days' and 'max_handling_days' should be either set or not set at the same time.

Returns
Type Description
int

hasMaxHandlingDays

clearMaxHandlingDays

setMaxHandlingDays

Maximum number of business days spent before an order is shipped.

0 means same day shipped, 1 means next day shipped. Must be greater than or equal to min_handling_days. 'min_handling_days' and 'max_handling_days' should be either set or not set at the same time.

Parameter
Name Description
var int
Returns
Type Description
$this

getTransitTimeTable

Transit time table, number of business days spent in transit based on row and column dimensions. Either min_transit_days, max_transit_days or transit_time_table can be set, but not both.

Returns
Type Description
TransitTable|null

hasTransitTimeTable

clearTransitTimeTable

setTransitTimeTable

Transit time table, number of business days spent in transit based on row and column dimensions. Either min_transit_days, max_transit_days or transit_time_table can be set, but not both.

Parameter
Name Description
var TransitTable
Returns
Type Description
$this

getHandlingBusinessDayConfig

The business days during which orders can be handled.

If not provided, Monday to Friday business days will be assumed.

Returns
Type Description
BusinessDayConfig|null

hasHandlingBusinessDayConfig

clearHandlingBusinessDayConfig

setHandlingBusinessDayConfig

The business days during which orders can be handled.

If not provided, Monday to Friday business days will be assumed.

Parameter
Name Description
var BusinessDayConfig
Returns
Type Description
$this

getTransitBusinessDayConfig

The business days during which orders can be in-transit.

If not provided, Monday to Friday business days will be assumed.

Returns
Type Description
BusinessDayConfig|null

hasTransitBusinessDayConfig

clearTransitBusinessDayConfig

setTransitBusinessDayConfig

The business days during which orders can be in-transit.

If not provided, Monday to Friday business days will be assumed.

Parameter
Name Description
var BusinessDayConfig
Returns
Type Description
$this

getWarehouseBasedDeliveryTimes

Optional. Indicates that the delivery time should be calculated per warehouse (shipping origin location) based on the settings of the selected carrier. When set, no other transit time related field in [delivery time][[google.shopping.content.bundles.ShippingSetting.DeliveryTime] should be set.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setWarehouseBasedDeliveryTimes

Optional. Indicates that the delivery time should be calculated per warehouse (shipping origin location) based on the settings of the selected carrier. When set, no other transit time related field in [delivery time][[google.shopping.content.bundles.ShippingSetting.DeliveryTime] should be set.

Parameter
Name Description
var array<WarehouseBasedDeliveryTime>
Returns
Type Description
$this