Method: accounts.lfpInventories.insert

Inserts a LfpInventory resource for the given target merchant account. If the resource already exists, it will be replaced. The inventory automatically expires after 30 days.

HTTP request

POST https://merchantapi.googleapis.com/lfp/v1beta/{parent=accounts/*}/lfpInventories:insert

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The LFP provider account. Format: accounts/{account}

Request body

The request body contains an instance of LfpInventory.

Response body

Local Inventory for the merchant.

If successful, the response body contains data with the following structure:

JSON representation
{
  "name": string,
  "targetAccount": string,
  "storeCode": string,
  "offerId": string,
  "regionCode": string,
  "contentLanguage": string,
  "price": {
    object (Price)
  },
  "availability": string,
  "collectionTime": string,
  "gtin": string,
  "quantity": string,
  "pickupMethod": string,
  "pickupSla": string,
  "feedLabel": string
}
Fields
name

string

Output only. Identifier. The name for the LfpInventory resource. Format: accounts/{account}/lfpInventories/{target_merchant}~{storeCode}~{offer}

targetAccount

string (int64 format)

Required. The Merchant Center ID of the merchant to submit the inventory for.

storeCode

string

Required. The identifier of the merchant's store. Either the store code inserted through InsertLfpStore or the store code in the Business Profile.

offerId

string

Required. Immutable. A unique identifier for the product. If both inventories and sales are submitted for a merchant, this id should match for the same product.

Note: if the merchant sells the same product new and used, they should have different IDs.

regionCode

string

Required. The CLDR territory code for the country where the product is sold.

contentLanguage

string

Required. The two-letter ISO 639-1 language code for the item.

price

object (Price)

Optional. The current price of the product.

availability

string

Required. Availability of the product at this store. For accepted attribute values, see the local product inventory data specification

collectionTime

string (Timestamp format)

Optional. The time when the inventory is collected. If not set, it will be set to the time when the inventory is submitted.

gtin

string

Optional. The Global Trade Item Number of the product.

quantity

string (int64 format)

Optional. Quantity of the product available at this store. Must be greater than or equal to zero.

pickupMethod

string

Optional. Supported pickup method for this offer. Unless the value is "not supported", this field must be submitted together with pickupSla. For accepted attribute values, see the local product inventory data specification.

pickupSla

string

Optional. Expected date that an order will be ready for pickup relative to the order date. Must be submitted together with pickupMethod. For accepted attribute values, see the local product inventory data specification.

feedLabel

string

Optional. The feed label for the product. If this is not set, it will default to regionCode.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/content

For more information, see the OAuth 2.0 Overview.