Class: Google::Cloud::Retail::V2::FulfillmentInfo

Inherits:

Object

Object
Google::Cloud::Retail::V2::FulfillmentInfo

show all

Extended by:: Protobuf::MessageExts::ClassMethods

Includes:: Protobuf::MessageExts

Defined in:: proto_docs/google/cloud/retail/v2/common.rb

Overview

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

Instance Attribute Summary collapse

#place_ids ⇒ ::Array<::String>
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.
#type ⇒ ::String
The fulfillment type, including commonly used types (such as pickup in store and same day delivery), and custom types.

Instance Attribute Details

#place_ids ⇒ `::Array<::String>`

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:

(::Array<::String>) —
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.

# File 'proto_docs/google/cloud/retail/v2/common.rb', line 555

class FulfillmentInfo
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#type ⇒ `::String`

Returns 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.