Retail V2 API - Class Google::Cloud::Retail::V2::FulfillmentInfo (v1.2.0)

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

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

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#place_ids

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

#place_ids=

def place_ids=(value) -> ::Array<::String>
Parameter
  • value (::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.

#type

def type() -> ::String
Returns
  • (::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.

#type=

def type=(value) -> ::String
Parameter
  • value (::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.

Returns
  • (::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.