Retail v2 API - Class AddFulfillmentPlacesRequest (2.4.0) 

public sealed class AddFulfillmentPlacesRequest : IMessage<AddFulfillmentPlacesRequest>, IEquatable<AddFulfillmentPlacesRequest>, IDeepCloneable<AddFulfillmentPlacesRequest>, IBufferMessage, IMessage

Reference documentation and code samples for the Retail v2 API class AddFulfillmentPlacesRequest.

Request message for [ProductService.AddFulfillmentPlaces][google.cloud.retail.v2.ProductService.AddFulfillmentPlaces] method.

Inheritance

Object > AddFulfillmentPlacesRequest

Namespace

Google.Cloud.Retail.V2

Assembly

Google.Cloud.Retail.V2.dll

Constructors

AddFulfillmentPlacesRequest()

public AddFulfillmentPlacesRequest()

AddFulfillmentPlacesRequest(AddFulfillmentPlacesRequest)

public AddFulfillmentPlacesRequest(AddFulfillmentPlacesRequest other)
Parameter
NameDescription
otherAddFulfillmentPlacesRequest

Properties

AddTime

public Timestamp AddTime { get; set; }

The time when the fulfillment updates are issued, used to prevent out-of-order updates on fulfillment information. If not provided, the internal system time will be used.

Property Value
TypeDescription
Timestamp

AllowMissing

public bool AllowMissing { get; set; }

If set to true, and the [Product][google.cloud.retail.v2.Product] is not found, the fulfillment information will still be processed and retained for at most 1 day and processed once the [Product][google.cloud.retail.v2.Product] is created. If set to false, a NOT_FOUND error is returned if the [Product][google.cloud.retail.v2.Product] is not found.

Property Value
TypeDescription
Boolean

PlaceIds

public RepeatedField<string> PlaceIds { get; }

Required. The IDs for this [type][google.cloud.retail.v2.AddFulfillmentPlacesRequest.type], such as the store IDs for "pickup-in-store" or the region IDs for "same-day-delivery" to be added for this [type][google.cloud.retail.v2.AddFulfillmentPlacesRequest.type]. Duplicate IDs will be automatically ignored.

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

If the total number of place IDs exceeds 2000 for this [type][google.cloud.retail.v2.AddFulfillmentPlacesRequest.type] after adding, then the update will be rejected.

Property Value
TypeDescription
RepeatedField<String>

Product

public string Product { get; set; }

Required. Full resource name of [Product][google.cloud.retail.v2.Product], such as projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id.

If the caller does not have permission to access the [Product][google.cloud.retail.v2.Product], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

Property Value
TypeDescription
String

ProductAsProductName

public ProductName ProductAsProductName { get; set; }

ProductName-typed view over the Product resource name property.

Property Value
TypeDescription
ProductName

Type

public string Type { get; set; }

Required. The fulfillment type, including commonly used types (such as pickup in store and same day delivery), and custom types.

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.

This field directly corresponds to [Product.fulfillment_info.type][google.cloud.retail.v2.FulfillmentInfo.type].

Property Value
TypeDescription
String