Google Shopping Merchant Order Tracking V1beta Client - Class ShippingInfo (0.1.1)

Reference documentation and code samples for the Google Shopping Merchant Order Tracking V1beta Client class ShippingInfo.

The shipping information for the order.

Generated from protobuf message google.shopping.merchant.ordertracking.v1beta.OrderTrackingSignal.ShippingInfo

Namespace

Google \ Shopping \ Merchant \ OrderTracking \ V1beta \ OrderTrackingSignal

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ shipment_id string

Required. The shipment ID. This field will be hashed in returned OrderTrackingSignal creation response.
↳ tracking_id string

Optional. The tracking ID of the shipment. This field is required if one of the following fields is absent: earliest_delivery_promise_time, latest_delivery_promise_time, and actual_delivery_time.
↳ carrier string

Optional. The name of the shipping carrier for the delivery. This field is required if one of the following fields is absent: earliest_delivery_promise_time, latest_delivery_promise_time, and actual_delivery_time.
↳ carrier_service string

Optional. The service type for fulfillment, such as GROUND, FIRST_CLASS, etc.
↳ shipped_time Google\Type\DateTime

Optional. The time when the shipment was shipped. Include the year and timezone string, if available.
↳ earliest_delivery_promise_time Google\Type\DateTime

Optional. The earliest delivery promised time. Include the year and timezone string, if available. This field is required, if one of the following fields is absent: tracking_id or carrier_name.
↳ latest_delivery_promise_time Google\Type\DateTime

Optional. The latest delivery promised time. Include the year and timezone string, if available. This field is required, if one of the following fields is absent: tracking_id or carrier_name.
↳ actual_delivery_time Google\Type\DateTime

Optional. The time when the shipment was actually delivered. Include the year and timezone string, if available. This field is required, if one of the following fields is absent: tracking_id or carrier_name.
↳ shipping_status int

Required. The status of the shipment.
↳ origin_postal_code string

Required. The origin postal code, as a continuous string without spaces or dashes, for example "95016". This field will be anonymized in returned OrderTrackingSignal creation response.
↳ origin_region_code string

Required. The CLDR territory code for the shipping origin.

getShipmentId

Required. The shipment ID. This field will be hashed in returned OrderTrackingSignal creation response.

Returns
Type Description
string

setShipmentId

Required. The shipment ID. This field will be hashed in returned OrderTrackingSignal creation response.

Parameter
Name Description
var string
Returns
Type Description
$this

getTrackingId

Optional. The tracking ID of the shipment. This field is required if one of the following fields is absent: earliest_delivery_promise_time, latest_delivery_promise_time, and actual_delivery_time.

Returns
Type Description
string

setTrackingId

Optional. The tracking ID of the shipment. This field is required if one of the following fields is absent: earliest_delivery_promise_time, latest_delivery_promise_time, and actual_delivery_time.

Parameter
Name Description
var string
Returns
Type Description
$this

getCarrier

Optional. The name of the shipping carrier for the delivery. This field is required if one of the following fields is absent: earliest_delivery_promise_time, latest_delivery_promise_time, and actual_delivery_time.

Returns
Type Description
string

setCarrier

Optional. The name of the shipping carrier for the delivery. This field is required if one of the following fields is absent: earliest_delivery_promise_time, latest_delivery_promise_time, and actual_delivery_time.

Parameter
Name Description
var string
Returns
Type Description
$this

getCarrierService

Optional. The service type for fulfillment, such as GROUND, FIRST_CLASS, etc.

Returns
Type Description
string

setCarrierService

Optional. The service type for fulfillment, such as GROUND, FIRST_CLASS, etc.

Parameter
Name Description
var string
Returns
Type Description
$this

getShippedTime

Optional. The time when the shipment was shipped.

Include the year and timezone string, if available.

Returns
Type Description
Google\Type\DateTime|null

hasShippedTime

clearShippedTime

setShippedTime

Optional. The time when the shipment was shipped.

Include the year and timezone string, if available.

Parameter
Name Description
var Google\Type\DateTime
Returns
Type Description
$this

getEarliestDeliveryPromiseTime

Optional. The earliest delivery promised time.

Include the year and timezone string, if available. This field is required, if one of the following fields is absent: tracking_id or carrier_name.

Returns
Type Description
Google\Type\DateTime|null

hasEarliestDeliveryPromiseTime

clearEarliestDeliveryPromiseTime

setEarliestDeliveryPromiseTime

Optional. The earliest delivery promised time.

Include the year and timezone string, if available. This field is required, if one of the following fields is absent: tracking_id or carrier_name.

Parameter
Name Description
var Google\Type\DateTime
Returns
Type Description
$this

getLatestDeliveryPromiseTime

Optional. The latest delivery promised time.

Include the year and timezone string, if available. This field is required, if one of the following fields is absent: tracking_id or carrier_name.

Returns
Type Description
Google\Type\DateTime|null

hasLatestDeliveryPromiseTime

clearLatestDeliveryPromiseTime

setLatestDeliveryPromiseTime

Optional. The latest delivery promised time.

Include the year and timezone string, if available. This field is required, if one of the following fields is absent: tracking_id or carrier_name.

Parameter
Name Description
var Google\Type\DateTime
Returns
Type Description
$this

getActualDeliveryTime

Optional. The time when the shipment was actually delivered.

Include the year and timezone string, if available. This field is required, if one of the following fields is absent: tracking_id or carrier_name.

Returns
Type Description
Google\Type\DateTime|null

hasActualDeliveryTime

clearActualDeliveryTime

setActualDeliveryTime

Optional. The time when the shipment was actually delivered.

Include the year and timezone string, if available. This field is required, if one of the following fields is absent: tracking_id or carrier_name.

Parameter
Name Description
var Google\Type\DateTime
Returns
Type Description
$this

getShippingStatus

Required. The status of the shipment.

Returns
Type Description
int

setShippingStatus

Required. The status of the shipment.

Parameter
Name Description
var int
Returns
Type Description
$this

getOriginPostalCode

Required. The origin postal code, as a continuous string without spaces or dashes, for example "95016". This field will be anonymized in returned OrderTrackingSignal creation response.

Returns
Type Description
string

setOriginPostalCode

Required. The origin postal code, as a continuous string without spaces or dashes, for example "95016". This field will be anonymized in returned OrderTrackingSignal creation response.

Parameter
Name Description
var string
Returns
Type Description
$this

getOriginRegionCode

Required. The CLDR territory code for the shipping origin.

Returns
Type Description
string

setOriginRegionCode

Required. The CLDR territory code for the shipping origin.

Parameter
Name Description
var string
Returns
Type Description
$this