Google Cloud Retail V2 Client - Class FulfillmentInfo (2.1.2)

Reference documentation and code samples for the Google Cloud Retail V2 Client class FulfillmentInfo.

Fulfillment information, such as the store IDs for in-store pickup or region IDs for different shipping methods.

Generated from protobuf message google.cloud.retail.v2.FulfillmentInfo

Namespace

Google \ Cloud \ Retail \ V2

Methods

__construct

Constructor.

Parameters
Name Description
data array

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

The fulfillment type, including commonly used types (such as pickup in store and same day delivery), and custom types. Customers have to map custom types to their display names before rendering UI. Supported values: * * "pickup-in-store" * * "ship-to-store" * * "same-day-delivery" * * "next-day-delivery" * * "custom-type-1" * * "custom-type-2" * * "custom-type-3" * * "custom-type-4" * * "custom-type-5" If this field is set to an invalid value other than these, an INVALID_ARGUMENT error is returned.
↳ place_ids array

The IDs for this type, such as the store IDs for FulfillmentInfo.type.pickup-in-store or the region IDs for FulfillmentInfo.type.same-day-delivery. A maximum of 3000 values are allowed. Each value must be a string with a length limit of 30 characters, matching the pattern [a-zA-Z0-9_-]+, such as "store1" or "REGION-2". Otherwise, an INVALID_ARGUMENT error is returned.

getType

The fulfillment type, including commonly used types (such as pickup in store and same day delivery), and custom types. Customers have to map custom types to their display names before rendering UI.

Supported values:

  • "pickup-in-store"
  • "ship-to-store"
  • "same-day-delivery"
  • "next-day-delivery"
  • "custom-type-1"
  • "custom-type-2"
  • "custom-type-3"
  • "custom-type-4"
  • "custom-type-5" If this field is set to an invalid value other than these, an INVALID_ARGUMENT error is returned.
Returns
Type Description
string

setType

The fulfillment type, including commonly used types (such as pickup in store and same day delivery), and custom types. Customers have to map custom types to their display names before rendering UI.

Supported values:

  • "pickup-in-store"
  • "ship-to-store"
  • "same-day-delivery"
  • "next-day-delivery"
  • "custom-type-1"
  • "custom-type-2"
  • "custom-type-3"
  • "custom-type-4"
  • "custom-type-5" If this field is set to an invalid value other than these, an INVALID_ARGUMENT error is returned.
Parameter
Name Description
var string
Returns
Type Description
$this

getPlaceIds

The IDs for this type, such as the store IDs for FulfillmentInfo.type.pickup-in-store or the region IDs for FulfillmentInfo.type.same-day-delivery.

A maximum of 3000 values are allowed. Each value must be a string with a length limit of 30 characters, matching the pattern [a-zA-Z0-9_-]+, such as "store1" or "REGION-2". Otherwise, an INVALID_ARGUMENT error is returned.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setPlaceIds

The IDs for this type, such as the store IDs for FulfillmentInfo.type.pickup-in-store or the region IDs for FulfillmentInfo.type.same-day-delivery.

A maximum of 3000 values are allowed. Each value must be a string with a length limit of 30 characters, matching the pattern [a-zA-Z0-9_-]+, such as "store1" or "REGION-2". Otherwise, an INVALID_ARGUMENT error is returned.

Parameter
Name Description
var string[]
Returns
Type Description
$this