google_api_content v0.29.1 API Reference

Modules

API calls for all endpoints tagged Accounts.

API calls for all endpoints tagged Accountstatuses.

API calls for all endpoints tagged Accounttax.

API calls for all endpoints tagged Datafeeds.

API calls for all endpoints tagged Datafeedstatuses.

API calls for all endpoints tagged Inventory.

API calls for all endpoints tagged Liasettings.

API calls for all endpoints tagged Orderinvoices.

API calls for all endpoints tagged Orderreports.

API calls for all endpoints tagged Orderreturns.

API calls for all endpoints tagged Orders.

API calls for all endpoints tagged Pos.

API calls for all endpoints tagged Products.

API calls for all endpoints tagged Productstatuses.

API calls for all endpoints tagged Shippingsettings.

Handle Tesla connections for GoogleApi.Content.V2.

Account data. After the creation of a new account it may take a few minutes before it is fully operational. The methods delete, insert, and update require the admin role.

Attributes

  • country (type: String.t, default: nil) - CLDR country code (e.g. "US").
  • locality (type: String.t, default: nil) - City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
  • postalCode (type: String.t, default: nil) - Postal code or ZIP (e.g. "94043").
  • region (type: String.t, default: nil) - Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC").
  • streetAddress (type: String.t, default: nil) - Street-level part of the address.

Attributes

  • adwordsId (type: String.t, default: nil) - Customer ID of the AdWords account.
  • status (type: String.t, default: nil) - Status of the link between this Merchant Center account and the AdWords account. Upon retrieval, it represents the actual status of the link and can be either active if it was approved in Google AdWords or pending if it's pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status active when it's still pending or with status pending when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status inactive is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending.

Attributes

  • address (type: GoogleApi.Content.V2.Model.AccountAddress.t, default: nil) - The address of the business.
  • customerService (type: GoogleApi.Content.V2.Model.AccountCustomerService.t, default: nil) - The customer service information of the business.
  • phoneNumber (type: String.t, default: nil) - The phone number of the business.

Attributes

  • email (type: String.t, default: nil) - Customer service email.
  • phoneNumber (type: String.t, default: nil) - Customer service phone number.
  • url (type: String.t, default: nil) - Customer service URL.

Attributes

  • gmbEmail (type: String.t, default: nil) - The GMB email address of which a specific account within a GMB account. A sample account within a GMB account could be a business account with set of locations, managed under the GMB account.
  • status (type: String.t, default: nil) - Status of the link between this Merchant Center account and the GMB account.

Attributes

  • aggregatorId (type: String.t, default: nil) - The aggregator ID, set for aggregators and subaccounts (in that case, it represents the aggregator of the subaccount).
  • merchantId (type: String.t, default: nil) - The merchant account ID, set for individual accounts and subaccounts.

The status of an account, i.e., information about its products, which is computed offline and not returned immediately at insertion time.

Attributes

  • country (type: String.t, default: nil) - Country for which this issue is reported.

Attributes

  • country (type: String.t, default: nil) -
  • destination (type: String.t, default: nil) -
  • detail (type: String.t, default: nil) -
  • displayedValue (type: String.t, default: nil) -
  • exampleItems (type: list(GoogleApi.Content.V2.Model.AccountStatusExampleItem.t), default: nil) -
  • id (type: String.t, default: nil) -
  • lastChecked (type: String.t, default: nil) -
  • location (type: String.t, default: nil) -
  • numItems (type: integer(), default: nil) -
  • severity (type: String.t, default: nil) - Acceptable values are:

Attributes

  • itemId (type: String.t, default: nil) -
  • link (type: String.t, default: nil) -
  • submittedValue (type: String.t, default: nil) -
  • title (type: String.t, default: nil) -
  • valueOnLandingPage (type: String.t, default: nil) -

Attributes

  • attributeName (type: String.t, default: nil) - The attribute's name, if the issue is caused by a single attribute.
  • code (type: String.t, default: nil) - The error code of the issue.
  • description (type: String.t, default: nil) - A short issue description in English.
  • detail (type: String.t, default: nil) - A detailed issue description in English.
  • documentation (type: String.t, default: nil) - The URL of a web page to help with resolving this issue.
  • numItems (type: String.t, default: nil) - Number of items with this issue.
  • resolution (type: String.t, default: nil) - Whether the issue can be resolved by the merchant.
  • servability (type: String.t, default: nil) - How this issue affects serving of the offer.

Attributes

  • channel (type: String.t, default: nil) - The channel the data applies to.

Attributes

  • active (type: String.t, default: nil) - Number of active offers.
  • disapproved (type: String.t, default: nil) - Number of disapproved offers.
  • expiring (type: String.t, default: nil) - Number of expiring offers.
  • pending (type: String.t, default: nil) - Number of pending offers.

The tax settings of a merchant account. All methods require the admin role.

Tax calculation rule to apply in a state or province (USA only).

Attributes

  • admin (type: boolean(), default: nil) - Whether user is an admin.
  • emailAddress (type: String.t, default: nil) - User's email address.
  • orderManager (type: boolean(), default: nil) - Whether user is an order manager.
  • paymentsAnalyst (type: boolean(), default: nil) - Whether user can access payment statements.
  • paymentsManager (type: boolean(), default: nil) - Whether user can manage payment settings.

Attributes

  • channelId (type: String.t, default: nil) - Channel ID.
  • status (type: String.t, default: nil) - Status of the link between this Merchant Center account and the YouTube channel. Upon retrieval, it represents the actual status of the link and can be either active if it was approved in YT Creator Studio or pending if it's pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status active when it's still pending or with status pending when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status inactive is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending.

Attributes

  • accountIdentifiers (type: list(GoogleApi.Content.V2.Model.AccountIdentifier.t), default: nil) - The account identifiers corresponding to the authenticated user.

Attributes

  • kind (type: String.t, default: content#accountsClaimWebsiteResponse) - Identifies what kind of resource this is. Value: the fixed string "content#accountsClaimWebsiteResponse".

Attributes

  • entries (type: list(GoogleApi.Content.V2.Model.AccountsCustomBatchRequestEntry.t), default: nil) - The request entries to be processed in the batch.

A batch entry encoding a single non-batch accounts request.

Attributes

  • action (type: String.t, default: nil) - Action to perform for this link. The "request" action is only available to select merchants.

Attributes

  • entries (type: list(GoogleApi.Content.V2.Model.AccountsCustomBatchResponseEntry.t), default: nil) - The result of the execution of the batch requests.
  • kind (type: String.t, default: content#accountsCustomBatchResponse) - Identifies what kind of resource this is. Value: the fixed string "content#accountsCustomBatchResponse".

A batch entry encoding a single non-batch accounts response.

Attributes

  • action (type: String.t, default: nil) - Action to perform for this link. The "request" action is only available to select merchants.

Attributes

  • kind (type: String.t, default: content#accountsLinkResponse) - Identifies what kind of resource this is. Value: the fixed string "content#accountsLinkResponse".

Attributes

  • kind (type: String.t, default: content#accountsListResponse) - Identifies what kind of resource this is. Value: the fixed string "content#accountsListResponse".
  • nextPageToken (type: String.t, default: nil) - The token for the retrieval of the next page of accounts.
  • resources (type: list(GoogleApi.Content.V2.Model.Account.t), default: nil) -

Attributes

  • entries (type: list(GoogleApi.Content.V2.Model.AccountstatusesCustomBatchRequestEntry.t), default: nil) - The request entries to be processed in the batch.

A batch entry encoding a single non-batch accountstatuses request.

Attributes

  • entries (type: list(GoogleApi.Content.V2.Model.AccountstatusesCustomBatchResponseEntry.t), default: nil) - The result of the execution of the batch requests.
  • kind (type: String.t, default: content#accountstatusesCustomBatchResponse) - Identifies what kind of resource this is. Value: the fixed string "content#accountstatusesCustomBatchResponse".

A batch entry encoding a single non-batch accountstatuses response.

Attributes

  • kind (type: String.t, default: content#accountstatusesListResponse) - Identifies what kind of resource this is. Value: the fixed string "content#accountstatusesListResponse".
  • nextPageToken (type: String.t, default: nil) - The token for the retrieval of the next page of account statuses.
  • resources (type: list(GoogleApi.Content.V2.Model.AccountStatus.t), default: nil) -

Attributes

  • entries (type: list(GoogleApi.Content.V2.Model.AccounttaxCustomBatchRequestEntry.t), default: nil) - The request entries to be processed in the batch.

A batch entry encoding a single non-batch accounttax request.

Attributes

  • entries (type: list(GoogleApi.Content.V2.Model.AccounttaxCustomBatchResponseEntry.t), default: nil) - The result of the execution of the batch requests.
  • kind (type: String.t, default: content#accounttaxCustomBatchResponse) - Identifies what kind of resource this is. Value: the fixed string "content#accounttaxCustomBatchResponse".

A batch entry encoding a single non-batch accounttax response.

Attributes

  • kind (type: String.t, default: content#accounttaxListResponse) - Identifies what kind of resource this is. Value: the fixed string "content#accounttaxListResponse".
  • nextPageToken (type: String.t, default: nil) - The token for the retrieval of the next page of account tax settings.
  • resources (type: list(GoogleApi.Content.V2.Model.AccountTax.t), default: nil) -

Attributes

  • pretax (type: GoogleApi.Content.V2.Model.Price.t, default: nil) - [required] Value before taxes.
  • tax (type: GoogleApi.Content.V2.Model.Price.t, default: nil) - [required] Tax value.

Attributes

  • businessDays (type: list(String.t), default: nil) - Regular business days. May not be empty.

Attributes

  • carrierName (type: String.t, default: nil) - Carrier service, such as "UPS" or "Fedex". The list of supported carriers can be retrieved via the getSupportedCarriers method. Required.
  • carrierService (type: String.t, default: nil) - Carrier service, such as "ground" or "2 days". The list of supported services for a carrier can be retrieved via the getSupportedCarriers method. Required.
  • flatAdjustment (type: GoogleApi.Content.V2.Model.Price.t, default: nil) - Additive shipping rate modifier. Can be negative. For example { "value": "1", "currency" : "USD" } adds $1 to the rate, { "value": "-3", "currency" : "USD" } removes $3 from the rate. Optional.
  • name (type: String.t, default: nil) - Name of the carrier rate. Must be unique per rate group. Required.
  • originPostalCode (type: String.t, default: nil) - Shipping origin for this carrier rate. Required.
  • percentageAdjustment (type: String.t, default: nil) - Multiplicative shipping rate modifier as a number in decimal notation. Can be negative. For example "5.4" increases the rate by 5.4%, "-3" decreases the rate by 3%. Optional.

Attributes

  • country (type: String.t, default: nil) - The CLDR country code of the carrier (e.g., "US"). Always present.
  • name (type: String.t, default: nil) - The name of the carrier (e.g., "UPS"). Always present.
  • services (type: list(String.t), default: nil) - A list of supported services (e.g., "ground") for that carrier. Contains at least one service.

Attributes

  • name (type: String.t, default: nil) - The name of the attribute. Underscores will be replaced by spaces upon insertion.

Attributes

  • attributes (type: list(GoogleApi.Content.V2.Model.CustomAttribute.t), default: nil) - The sub-attributes.
  • name (type: String.t, default: nil) - The name of the group. Underscores will be replaced by spaces upon insertion.

Attributes

  • description (type: String.t, default: nil) - Description of the reason.
  • reasonCode (type: String.t, default: nil) - Code of the return reason.

Attributes

  • hour (type: integer(), default: nil) - Hour of the cutoff time until which an order has to be placed to be processed in the same day. Required.
  • minute (type: integer(), default: nil) - Minute of the cutoff time until which an order has to be placed to be processed in the same day. Required.
  • timezone (type: String.t, default: nil) - Timezone identifier for the cutoff time. A list of identifiers can be found in the AdWords API documentation. E.g. "Europe/Zurich". Required.

Datafeed configuration data.

The required fields vary based on the frequency of fetching. For a monthly fetch schedule, day_of_month and hour are required. For a weekly fetch schedule, weekday and hour are required. For a daily fetch schedule, only hour is required.

Attributes

  • columnDelimiter (type: String.t, default: nil) - Delimiter for the separation of values in a delimiter-separated values feed. If not specified, the delimiter will be auto-detected. Ignored for non-DSV data feeds.

The status of a datafeed, i.e., the result of the last retrieval of the datafeed computed asynchronously when the feed processing is finished.

An error occurring in the feed, like "invalid price".

An example occurrence for a particular error.

Attributes

  • country (type: String.t, default: nil) - The country where the items in the feed will be included in the search index, represented as a CLDR territory code.

Attributes

  • entries (type: list(GoogleApi.Content.V2.Model.DatafeedsCustomBatchRequestEntry.t), default: nil) - The request entries to be processed in the batch.

A batch entry encoding a single non-batch datafeeds request.

Attributes

  • entries (type: list(GoogleApi.Content.V2.Model.DatafeedsCustomBatchResponseEntry.t), default: nil) - The result of the execution of the batch requests.
  • kind (type: String.t, default: content#datafeedsCustomBatchResponse) - Identifies what kind of resource this is. Value: the fixed string "content#datafeedsCustomBatchResponse".

A batch entry encoding a single non-batch datafeeds response.

Attributes

  • kind (type: String.t, default: content#datafeedsFetchNowResponse) - Identifies what kind of resource this is. Value: the fixed string "content#datafeedsFetchNowResponse".

Attributes

  • kind (type: String.t, default: content#datafeedsListResponse) - Identifies what kind of resource this is. Value: the fixed string "content#datafeedsListResponse".
  • nextPageToken (type: String.t, default: nil) - The token for the retrieval of the next page of datafeeds.
  • resources (type: list(GoogleApi.Content.V2.Model.Datafeed.t), default: nil) -

Attributes

  • entries (type: list(GoogleApi.Content.V2.Model.DatafeedstatusesCustomBatchRequestEntry.t), default: nil) - The request entries to be processed in the batch.

A batch entry encoding a single non-batch datafeedstatuses request.

Attributes

  • entries (type: list(GoogleApi.Content.V2.Model.DatafeedstatusesCustomBatchResponseEntry.t), default: nil) - The result of the execution of the batch requests.
  • kind (type: String.t, default: content#datafeedstatusesCustomBatchResponse) - Identifies what kind of resource this is. Value: the fixed string "content#datafeedstatusesCustomBatchResponse".

A batch entry encoding a single non-batch datafeedstatuses response.

Attributes

  • kind (type: String.t, default: content#datafeedstatusesListResponse) - Identifies what kind of resource this is. Value: the fixed string "content#datafeedstatusesListResponse".
  • nextPageToken (type: String.t, default: nil) - The token for the retrieval of the next page of datafeed statuses.
  • resources (type: list(GoogleApi.Content.V2.Model.DatafeedStatus.t), default: nil) -

Attributes

  • cutoffTime (type: GoogleApi.Content.V2.Model.CutoffTime.t, default: nil) - Business days cutoff time definition. If not configured the cutoff time will be defaulted to 8AM PST.
  • handlingBusinessDayConfig (type: GoogleApi.Content.V2.Model.BusinessDayConfig.t, default: nil) - The business days during which orders can be handled. If not provided, Monday to Friday business days will be assumed.
  • holidayCutoffs (type: list(GoogleApi.Content.V2.Model.HolidayCutoff.t), default: nil) - Holiday cutoff definitions. If configured, they specify order cutoff times for holiday-specific shipping.
  • maxHandlingTimeInDays (type: integer(), default: nil) - Maximum number of business days spent before an order is shipped. 0 means same day shipped, 1 means next day shipped. Must be greater than or equal to minHandlingTimeInDays.
  • maxTransitTimeInDays (type: integer(), default: nil) - Maximum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Must be greater than or equal to minTransitTimeInDays.
  • minHandlingTimeInDays (type: integer(), default: nil) - Minimum number of business days spent before an order is shipped. 0 means same day shipped, 1 means next day shipped.
  • minTransitTimeInDays (type: integer(), default: nil) - Minimum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Either {min,max}TransitTimeInDays or transitTimeTable must be set, but not both.
  • transitBusinessDayConfig (type: GoogleApi.Content.V2.Model.BusinessDayConfig.t, default: nil) - The business days during which orders can be in-transit. If not provided, Monday to Friday business days will be assumed.
  • transitTimeTable (type: GoogleApi.Content.V2.Model.TransitTable.t, default: nil) - Transit time table, number of business days spent in transit based on row and column dimensions. Either {min,max}TransitTimeInDays or transitTimeTable can be set, but not both.

An error returned by the API.

A list of errors returned by a failed batch entry.

Attributes

  • accountId (type: String.t, default: nil) - The ID of the account.
  • gmbAccounts (type: list(GoogleApi.Content.V2.Model.GmbAccountsGmbAccount.t), default: nil) - A list of GMB accounts which are available to the merchant.

Attributes

  • email (type: String.t, default: nil) - The email which identifies the GMB account.
  • listingCount (type: String.t, default: nil) - Number of listings under this account.
  • name (type: String.t, default: nil) - The name of the GMB account.
  • type (type: String.t, default: nil) - The type of the GMB account (User or Business).

A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or location must be set.

Attributes

  • deadlineDate (type: String.t, default: nil) - Date of the order deadline, in ISO 8601 format. E.g. "2016-11-29" for 29th November 2016. Required.
  • deadlineHour (type: integer(), default: nil) - Hour of the day on the deadline date until which the order has to be placed to qualify for the delivery guarantee. Possible values are: 0 (midnight), 1, ..., 12 (noon), 13, ..., 23. Required.
  • deadlineTimezone (type: String.t, default: nil) - Timezone identifier for the deadline hour. A list of identifiers can be found in the AdWords API documentation. E.g. "Europe/Zurich". Required.
  • holidayId (type: String.t, default: nil) - Unique identifier for the holiday. Required.
  • visibleFromDate (type: String.t, default: nil) - Date on which the deadline will become visible to consumers in ISO 8601 format. E.g. "2016-10-31" for 31st October 2016. Required.

Attributes

  • countryCode (type: String.t, default: nil) - The CLDR territory code of the country in which the holiday is available. E.g. "US", "DE", "GB". A holiday cutoff can only be configured in a shipping settings service with matching delivery country. Always present.
  • date (type: String.t, default: nil) - Date of the holiday, in ISO 8601 format. E.g. "2016-12-25" for Christmas 2016. Always present.
  • deliveryGuaranteeDate (type: String.t, default: nil) - Date on which the order has to arrive at the customer's, in ISO 8601 format. E.g. "2016-12-24" for 24th December 2016. Always present.
  • deliveryGuaranteeHour (type: String.t, default: nil) - Hour of the day in the delivery location's timezone on the guaranteed delivery date by which the order has to arrive at the customer's. Possible values are: 0 (midnight), 1, ..., 12 (noon), 13, ..., 23. Always present.
  • id (type: String.t, default: nil) - Unique identifier for the holiday to be used when configuring holiday cutoffs. Always present.
  • type (type: String.t, default: nil) - The holiday type. Always present.

Attributes

  • amount (type: GoogleApi.Content.V2.Model.Price.t, default: nil) - The amount the buyer has to pay per month.
  • months (type: String.t, default: nil) - The number of installments the buyer has to pay.

(== resource_for v2.inventory ==)

Attributes

  • entries (type: list(GoogleApi.Content.V2.Model.InventoryCustomBatchRequestEntry.t), default: nil) - The request entries to be processed in the batch.

A batch entry encoding a single non-batch inventory request.

Attributes

  • entries (type: list(GoogleApi.Content.V2.Model.InventoryCustomBatchResponseEntry.t), default: nil) - The result of the execution of the batch requests.
  • kind (type: String.t, default: content#inventoryCustomBatchResponse) - Identifies what kind of resource this is. Value: the fixed string "content#inventoryCustomBatchResponse".

A batch entry encoding a single non-batch inventory response.

Attributes

  • pickupMethod (type: String.t, default: nil) - Whether store pickup is available for this offer and whether the pickup option should be shown as buy, reserve, or not supported. Only supported for local inventory. Unless the value is "not supported", must be submitted together with pickupSla.

Attributes

  • availability (type: String.t, default: nil) - The availability of the product.

Attributes

  • kind (type: String.t, default: content#inventorySetResponse) - Identifies what kind of resource this is. Value: the fixed string "content#inventorySetResponse".

Attributes

  • additionalChargeSummaries (type: list(GoogleApi.Content.V2.Model.InvoiceSummaryAdditionalChargeSummary.t), default: nil) - Summary of the total amounts of the additional charges.
  • customerBalance (type: GoogleApi.Content.V2.Model.Amount.t, default: nil) - Deprecated.
  • googleBalance (type: GoogleApi.Content.V2.Model.Amount.t, default: nil) - Deprecated.
  • merchantBalance (type: GoogleApi.Content.V2.Model.Amount.t, default: nil) - Deprecated.
  • productTotal (type: GoogleApi.Content.V2.Model.Amount.t, default: nil) - [required] Total price for the product.
  • promotionSummaries (type: list(GoogleApi.Content.V2.Model.Promotion.t), default: nil) - Deprecated.

Attributes

  • totalAmount (type: GoogleApi.Content.V2.Model.Amount.t, default: nil) - [required] Total additional charge for this type.
  • type (type: String.t, default: nil) - [required] Type of the additional charge.

Attributes

  • status (type: String.t, default: nil) - The status of the verification process for the About page.

Attributes

  • about (type: GoogleApi.Content.V2.Model.LiaAboutPageSettings.t, default: nil) - The settings for the About page.
  • country (type: String.t, default: nil) - Required. CLDR country code (e.g. "US").
  • hostedLocalStorefrontActive (type: boolean(), default: nil) - The status of the "Merchant hosted local storefront" feature.
  • inventory (type: GoogleApi.Content.V2.Model.LiaInventorySettings.t, default: nil) - LIA inventory verification settings.
  • onDisplayToOrder (type: GoogleApi.Content.V2.Model.LiaOnDisplayToOrderSettings.t, default: nil) - LIA "On Display To Order" settings.
  • posDataProvider (type: GoogleApi.Content.V2.Model.LiaPosDataProvider.t, default: nil) - The POS data provider linked with this country.
  • storePickupActive (type: boolean(), default: nil) - The status of the "Store pickup" feature.

Attributes

  • inventoryVerificationContactEmail (type: String.t, default: nil) - The email of the contact for the inventory verification process.

Attributes

  • shippingCostPolicyUrl (type: String.t, default: nil) - Shipping cost and policy URL.
  • status (type: String.t, default: nil) - The status of the ?On display to order? feature.

Attributes

  • posDataProviderId (type: String.t, default: nil) - The ID of the POS data provider.
  • posExternalAccountId (type: String.t, default: nil) - The account ID by which this merchant is known to the POS data provider.

Local Inventory ads (LIA) settings. All methods except listposdataproviders require the admin role.

Attributes

  • entries (type: list(GoogleApi.Content.V2.Model.LiasettingsCustomBatchRequestEntry.t), default: nil) - The request entries to be processed in the batch.

Attributes

  • accountId (type: String.t, default: nil) - The ID of the account for which to get/update account shipping settings.

Attributes

  • entries (type: list(GoogleApi.Content.V2.Model.LiasettingsCustomBatchResponseEntry.t), default: nil) - The result of the execution of the batch requests.
  • kind (type: String.t, default: content#liasettingsCustomBatchResponse) - Identifies what kind of resource this is. Value: the fixed string "content#liasettingsCustomBatchResponse".

Attributes

  • batchId (type: integer(), default: nil) - The ID of the request entry to which this entry responds.
  • errors (type: GoogleApi.Content.V2.Model.Errors.t, default: nil) - A list of errors defined if, and only if, the request failed.
  • gmbAccounts (type: GoogleApi.Content.V2.Model.GmbAccounts.t, default: nil) - The the list of accessible GMB accounts.
  • kind (type: String.t, default: content#liasettingsCustomBatchResponseEntry) - Identifies what kind of resource this is. Value: the fixed string "content#liasettingsCustomBatchResponseEntry"
  • liaSettings (type: GoogleApi.Content.V2.Model.LiaSettings.t, default: nil) - The retrieved or updated Lia settings.
  • posDataProviders (type: list(GoogleApi.Content.V2.Model.PosDataProviders.t), default: nil) - The list of POS data providers.

Attributes

  • accountId (type: String.t, default: nil) - The ID of the account.
  • gmbAccounts (type: list(GoogleApi.Content.V2.Model.GmbAccountsGmbAccount.t), default: nil) - A list of GMB accounts which are available to the merchant.
  • kind (type: String.t, default: content#liasettingsGetAccessibleGmbAccountsResponse) - Identifies what kind of resource this is. Value: the fixed string "content#liasettingsGetAccessibleGmbAccountsResponse".

Attributes

  • kind (type: String.t, default: content#liasettingsListPosDataProvidersResponse) - Identifies what kind of resource this is. Value: the fixed string "content#liasettingsListPosDataProvidersResponse".
  • posDataProviders (type: list(GoogleApi.Content.V2.Model.PosDataProviders.t), default: nil) - The list of POS data providers for each eligible country

Attributes

  • kind (type: String.t, default: content#liasettingsListResponse) - Identifies what kind of resource this is. Value: the fixed string "content#liasettingsListResponse".
  • nextPageToken (type: String.t, default: nil) - The token for the retrieval of the next page of LIA settings.
  • resources (type: list(GoogleApi.Content.V2.Model.LiaSettings.t), default: nil) -

Attributes

  • kind (type: String.t, default: content#liasettingsRequestGmbAccessResponse) - Identifies what kind of resource this is. Value: the fixed string "content#liasettingsRequestGmbAccessResponse".

Attributes

  • kind (type: String.t, default: content#liasettingsRequestInventoryVerificationResponse) - Identifies what kind of resource this is. Value: the fixed string "content#liasettingsRequestInventoryVerificationResponse".

Attributes

  • kind (type: String.t, default: content#liasettingsSetInventoryVerificationContactResponse) - Identifies what kind of resource this is. Value: the fixed string "content#liasettingsSetInventoryVerificationContactResponse".

Attributes

  • kind (type: String.t, default: content#liasettingsSetPosDataProviderResponse) - Identifies what kind of resource this is. Value: the fixed string "content#liasettingsSetPosDataProviderResponse".

Attributes

  • locationIds (type: list(String.t), default: nil) - A non-empty list of location IDs. They must all be of the same location type (e.g., state).

Attributes

  • name (type: String.t, default: nil) - Name of loyalty points program. It is recommended to limit the name to 12 full-width characters or 24 Roman characters.
  • pointsValue (type: String.t, default: nil) - The retailer's loyalty points in absolute value.
  • ratio (type: float(), default: nil) - The ratio of a point when converted to currency. Google assumes currency based on Merchant Center settings. If ratio is left out, it defaults to 1.0.

Order return. Production access (all methods) requires the order manager role. Sandbox access does not.

Attributes

  • customerReturnReason (type: GoogleApi.Content.V2.Model.CustomerReturnReason.t, default: nil) - The reason that the customer chooses to return an item.
  • itemId (type: String.t, default: nil) - Product level item ID. If the returned items are of the same product, they will have the same ID.
  • merchantReturnReason (type: GoogleApi.Content.V2.Model.RefundReason.t, default: nil) - The reason that merchant chooses to accept a return item.
  • product (type: GoogleApi.Content.V2.Model.OrderLineItemProduct.t, default: nil) - Product data from the time of the order placement.
  • returnShipmentIds (type: list(String.t), default: nil) - IDs of the return shipments that this return item belongs to.
  • state (type: String.t, default: nil) - State of the item.

Attributes

  • storeCodeSetWithMovs (type: list(GoogleApi.Content.V2.Model.MinimumOrderValueTableStoreCodeSetWithMov.t), default: nil) -

A list of store code sets sharing the same minimum order value. At least two sets are required and the last one must be empty, which signifies 'MOV for all other stores'. Each store code can only appear once across all the sets. All prices within a service must have the same currency.

Order. Production access (all methods) requires the order manager role. Sandbox access does not. (== resource_for v2.orders ==) (== resource_for v2.1.orders ==)

Attributes

  • country (type: String.t, default: nil) - CLDR country code (e.g. "US").
  • fullAddress (type: list(String.t), default: nil) - Strings representing the lines of the printed label for mailing the order, for example: John Smith 1600 Amphitheatre Parkway Mountain View, CA, 94043 United States
  • isPostOfficeBox (type: boolean(), default: nil) - Whether the address is a post office box.
  • locality (type: String.t, default: nil) - City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
  • postalCode (type: String.t, default: nil) - Postal Code or ZIP (e.g. "94043").
  • recipientName (type: String.t, default: nil) - Name of the recipient.
  • region (type: String.t, default: nil) - Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC").
  • streetAddress (type: list(String.t), default: nil) - Street-level part of the address.

Attributes

  • actor (type: String.t, default: nil) - The actor that created the cancellation.

Attributes

  • email (type: String.t, default: nil) - Deprecated.
  • explicitMarketingPreference (type: boolean(), default: nil) - Deprecated. Please use marketingRightsInfo instead.
  • fullName (type: String.t, default: nil) - Full name of the customer.
  • invoiceReceivingEmail (type: String.t, default: nil) -
  • marketingRightsInfo (type: GoogleApi.Content.V2.Model.OrderCustomerMarketingRightsInfo.t, default: nil) - Customer's marketing preferences. Contains the marketing opt-in information that is current at the time that the merchant call. User preference selections can change from one order to the next so preferences must be checked with every order.

Attributes

  • explicitMarketingPreference (type: String.t, default: nil) - Last known customer selection regarding marketing preferences. In certain cases this selection might not be known, so this field would be empty. If a customer selected granted in their most recent order, they can be subscribed to marketing emails. Customers who have chosen denied must not be subscribed, or must be unsubscribed if already opted-in.

Attributes

  • address (type: GoogleApi.Content.V2.Model.OrderAddress.t, default: nil) - The delivery address
  • phoneNumber (type: String.t, default: nil) - The phone number of the person receiving the delivery.

Attributes

  • benefits (type: list(GoogleApi.Content.V2.Model.OrderLegacyPromotionBenefit.t), default: nil) -

Attributes

  • discount (type: GoogleApi.Content.V2.Model.Price.t, default: nil) - The discount in the order price when the promotion is applied.

Attributes

  • annotations (type: list(GoogleApi.Content.V2.Model.OrderMerchantProvidedAnnotation.t), default: nil) - Annotations that are attached to the line item.
  • cancellations (type: list(GoogleApi.Content.V2.Model.OrderCancellation.t), default: nil) - Cancellations of the line item.
  • id (type: String.t, default: nil) - The ID of the line item.
  • price (type: GoogleApi.Content.V2.Model.Price.t, default: nil) - Total price for the line item. For example, if two items for $10 are purchased, the total price will be $20.
  • product (type: GoogleApi.Content.V2.Model.OrderLineItemProduct.t, default: nil) - Product data as seen by customer from the time of the order placement. Note that certain attributes values (e.g. title or gtin) might be reformatted and no longer match values submitted via product feed.
  • quantityCanceled (type: integer(), default: nil) - Number of items canceled.
  • quantityDelivered (type: integer(), default: nil) - Number of items delivered.
  • quantityOrdered (type: integer(), default: nil) - Number of items ordered.
  • quantityPending (type: integer(), default: nil) - Number of items pending.
  • quantityReadyForPickup (type: integer(), default: nil) - Number of items ready for pickup.
  • quantityReturned (type: integer(), default: nil) - Number of items returned.
  • quantityShipped (type: integer(), default: nil) - Number of items shipped.
  • returnInfo (type: GoogleApi.Content.V2.Model.OrderLineItemReturnInfo.t, default: nil) - Details of the return policy for the line item.
  • returns (type: list(GoogleApi.Content.V2.Model.OrderReturn.t), default: nil) - Returns of the line item.
  • shippingDetails (type: GoogleApi.Content.V2.Model.OrderLineItemShippingDetails.t, default: nil) - Details of the requested shipping for the line item.
  • tax (type: GoogleApi.Content.V2.Model.Price.t, default: nil) - Total tax amount for the line item. For example, if two items are purchased, and each have a cost tax of $2, the total tax amount will be $4.

Attributes

  • brand (type: String.t, default: nil) - Brand of the item.

Attributes

  • amount (type: GoogleApi.Content.V2.Model.Price.t, default: nil) - Amount of the fee.
  • name (type: String.t, default: nil) - Name of the fee.

Attributes

  • dimension (type: String.t, default: nil) - The dimension of the variant.
  • value (type: String.t, default: nil) - The value for the dimension.

Attributes

  • daysToReturn (type: integer(), default: nil) - Required. How many days later the item can be returned.
  • isReturnable (type: boolean(), default: nil) - Required. Whether the item is returnable.
  • policyUrl (type: String.t, default: nil) - Required. URL of the item return policy.

Attributes

  • deliverByDate (type: String.t, default: nil) - Required. The delivery by date, in ISO 8601 format.
  • method (type: GoogleApi.Content.V2.Model.OrderLineItemShippingDetailsMethod.t, default: nil) - Required. Details of the shipping method.
  • shipByDate (type: String.t, default: nil) - Required. The ship by date, in ISO 8601 format.
  • type (type: String.t, default: nil) - Type of shipment. Indicates whether deliveryDetails or pickupDetails is applicable for this shipment.

Attributes

  • carrier (type: String.t, default: nil) - The carrier for the shipping. Optional. See shipments[].carrier for a list of acceptable values.
  • maxDaysInTransit (type: integer(), default: nil) - Required. Maximum transit time.
  • methodName (type: String.t, default: nil) - Required. The name of the shipping method.
  • minDaysInTransit (type: integer(), default: nil) - Required. Minimum transit time.

Attributes

  • key (type: String.t, default: nil) - Key for additional merchant provided (as key-value pairs) annotation about the line item.
  • value (type: String.t, default: nil) - Value for additional merchant provided (as key-value pairs) annotation about the line item.

Attributes

  • billingAddress (type: GoogleApi.Content.V2.Model.OrderAddress.t, default: nil) - The billing address.
  • expirationMonth (type: integer(), default: nil) - The card expiration month (January = 1, February = 2 etc.).
  • expirationYear (type: integer(), default: nil) - The card expiration year (4-digit, e.g. 2015).
  • lastFourDigits (type: String.t, default: nil) - The last four digits of the card number.
  • phoneNumber (type: String.t, default: nil) - The billing phone number.
  • type (type: String.t, default: nil) - The type of instrument.

Attributes

  • address (type: GoogleApi.Content.V2.Model.OrderAddress.t, default: nil) - Address of the pickup location where the shipment should be sent. Note that recipientName in the address is the name of the business at the pickup location.
  • collectors (type: list(GoogleApi.Content.V2.Model.OrderPickupDetailsCollector.t), default: nil) - Collectors authorized to pick up shipment from the pickup location.
  • locationId (type: String.t, default: nil) - ID of the pickup location.

Attributes

  • name (type: String.t, default: nil) - Name of the person picking up the shipment.
  • phoneNumber (type: String.t, default: nil) - Phone number of the person picking up the shipment.

Attributes

  • actor (type: String.t, default: nil) - The actor that created the refund.

Order disbursement. All methods require the payment analyst role. (== resource_for v2.orderreports ==) (== resource_for v2.1.orderreports ==)

Attributes

  • disbursementAmount (type: GoogleApi.Content.V2.Model.Price.t, default: nil) - The disbursement amount.
  • disbursementCreationDate (type: String.t, default: nil) - The date the disbursement was created, in ISO 8601 format.
  • disbursementDate (type: String.t, default: nil) - The date the disbursement was initiated, in ISO 8601 format.
  • disbursementId (type: String.t, default: nil) - The ID of the disbursement.
  • merchantId (type: String.t, default: nil) - The ID of the managing account.
  • merchantOrderId (type: String.t, default: nil) - Merchant-provided ID of the order.
  • orderId (type: String.t, default: nil) - The ID of the order.
  • productAmount (type: GoogleApi.Content.V2.Model.Amount.t, default: nil) - Total amount for the items.
  • productAmountWithRemittedTax (type: GoogleApi.Content.V2.Model.ProductAmount.t, default: nil) - Total amount with remitted tax for the items.
  • transactionDate (type: String.t, default: nil) - The date of the transaction, in ISO 8601 format.

Attributes

  • actor (type: String.t, default: nil) - The actor that created the refund.

Attributes

  • carrier (type: String.t, default: nil) - The carrier handling the shipment.

Attributes

  • lineItemId (type: String.t, default: nil) - The ID of the line item that is shipped. This value is assigned by Google when an order is created. Either lineItemId or productId is required.
  • productId (type: String.t, default: nil) - The ID of the product to ship. This is the REST ID used in the products service. Either lineItemId or productId is required.
  • quantity (type: integer(), default: nil) - The quantity that is shipped.

Attributes

  • invoiceId (type: String.t, default: nil) - [required] The ID of the invoice.
  • invoiceSummary (type: GoogleApi.Content.V2.Model.InvoiceSummary.t, default: nil) - [required] Invoice summary.
  • lineItemInvoices (type: list(GoogleApi.Content.V2.Model.ShipmentInvoiceLineItemInvoice.t), default: nil) - [required] Invoice details per line item.
  • operationId (type: String.t, default: nil) - [required] The ID of the operation, unique across all operations for a given order.
  • shipmentGroupId (type: String.t, default: nil) - [required] ID of the shipment group. It is assigned by the merchant in the shipLineItems method and is used to group multiple line items that have the same kind of shipping charges.

Attributes

  • executionStatus (type: String.t, default: nil) - The status of the execution.

Attributes

  • invoiceId (type: String.t, default: nil) - [required] The ID of the invoice.
  • operationId (type: String.t, default: nil) - [required] The ID of the operation, unique across all operations for a given order.
  • refundOnlyOption (type: GoogleApi.Content.V2.Model.OrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceRefundOption.t, default: nil) - Option to create a refund-only invoice. Exactly one of refundOnlyOption or returnOption must be provided.
  • returnOption (type: GoogleApi.Content.V2.Model.OrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceReturnOption.t, default: nil) - Option to create an invoice for a refund and mark all items within the invoice as returned. Exactly one of refundOnlyOption or returnOption must be provided.
  • shipmentInvoices (type: list(GoogleApi.Content.V2.Model.ShipmentInvoice.t), default: nil) - Invoice details for different shipment groups.

Attributes

  • executionStatus (type: String.t, default: nil) - The status of the execution.

Attributes

  • description (type: String.t, default: nil) - Optional description of the refund reason.
  • reason (type: String.t, default: nil) - [required] Reason for the refund.

Attributes

  • description (type: String.t, default: nil) - Optional description of the return reason.
  • reason (type: String.t, default: nil) - [required] Reason for the return.

Attributes

  • disbursements (type: list(GoogleApi.Content.V2.Model.OrderReportDisbursement.t), default: nil) - The list of disbursements.
  • kind (type: String.t, default: content#orderreportsListDisbursementsResponse) - Identifies what kind of resource this is. Value: the fixed string "content#orderreportsListDisbursementsResponse".
  • nextPageToken (type: String.t, default: nil) - The token for the retrieval of the next page of disbursements.

Attributes

  • kind (type: String.t, default: content#orderreportsListTransactionsResponse) - Identifies what kind of resource this is. Value: the fixed string "content#orderreportsListTransactionsResponse".
  • nextPageToken (type: String.t, default: nil) - The token for the retrieval of the next page of transactions.
  • transactions (type: list(GoogleApi.Content.V2.Model.OrderReportTransaction.t), default: nil) - The list of transactions.

Attributes

  • kind (type: String.t, default: content#orderreturnsListResponse) - Identifies what kind of resource this is. Value: the fixed string "content#orderreturnsListResponse".
  • nextPageToken (type: String.t, default: nil) - The token for the retrieval of the next page of returns.
  • resources (type: list(GoogleApi.Content.V2.Model.MerchantOrderReturn.t), default: nil) -

Attributes

  • operationId (type: String.t, default: nil) - The ID of the operation. Unique across all operations for a given order.

Attributes

  • executionStatus (type: String.t, default: nil) - The status of the execution.

Attributes

  • kind (type: String.t, default: content#ordersAdvanceTestOrderResponse) - Identifies what kind of resource this is. Value: the fixed string "content#ordersAdvanceTestOrderResponse".

Attributes

  • amount (type: GoogleApi.Content.V2.Model.Price.t, default: nil) - Deprecated. Please use amountPretax and amountTax instead.

Attributes

  • executionStatus (type: String.t, default: nil) - The status of the execution.

Attributes

  • operationId (type: String.t, default: nil) - The ID of the operation. Unique across all operations for a given order.

Attributes

  • executionStatus (type: String.t, default: nil) - The status of the execution.

Attributes

  • reason (type: String.t, default: nil) - The reason for the cancellation.

Attributes

  • kind (type: String.t, default: content#ordersCancelTestOrderByCustomerResponse) - Identifies what kind of resource this is. Value: the fixed string "content#ordersCancelTestOrderByCustomerResponse".

Attributes

  • country (type: String.t, default: nil) - The CLDR territory code of the country of the test order to create. Affects the currency and addresses of orders created via template_name, or the addresses of orders created via test_order.

Attributes

  • kind (type: String.t, default: content#ordersCreateTestOrderResponse) - Identifies what kind of resource this is. Value: the fixed string "content#ordersCreateTestOrderResponse".
  • orderId (type: String.t, default: nil) - The ID of the newly created test order.

Attributes

  • items (type: list(GoogleApi.Content.V2.Model.OrdersCustomBatchRequestEntryCreateTestReturnReturnItem.t), default: nil) - Returned items.

Attributes

  • kind (type: String.t, default: content#ordersCreateTestReturnResponse) - Identifies what kind of resource this is. Value: the fixed string "content#ordersCreateTestReturnResponse".
  • returnId (type: String.t, default: nil) - The ID of the newly created test order return.

Attributes

  • entries (type: list(GoogleApi.Content.V2.Model.OrdersCustomBatchRequestEntry.t), default: nil) - The request entries to be processed in the batch.

Attributes

  • batchId (type: integer(), default: nil) - An entry ID, unique within the batch request.

Attributes

  • reason (type: String.t, default: nil) - The reason for the cancellation.

Attributes

  • amount (type: GoogleApi.Content.V2.Model.Price.t, default: nil) - Deprecated. Please use amountPretax and amountTax instead.

Attributes

  • lineItemId (type: String.t, default: nil) - The ID of the line item to return.
  • quantity (type: integer(), default: nil) - Quantity that is returned.

Attributes

  • amountPretax (type: GoogleApi.Content.V2.Model.Price.t, default: nil) - The amount that is refunded. Required.

Attributes

  • amount (type: GoogleApi.Content.V2.Model.Price.t, default: nil) - Deprecated. Please use amountPretax and amountTax instead.

Attributes

  • lineItemId (type: String.t, default: nil) - The ID of the line item to return. Either lineItemId or productId is required.

Attributes

  • lineItemId (type: String.t, default: nil) - The ID of the line item to return. Either lineItemId or productId is required.

Attributes

  • amountPretax (type: GoogleApi.Content.V2.Model.Price.t, default: nil) - The amount that is refunded. If omitted, refundless return is assumed (same as calling returnLineItem method).

Attributes

  • annotations (type: list(GoogleApi.Content.V2.Model.OrderMerchantProvidedAnnotation.t), default: nil) -
  • lineItemId (type: String.t, default: nil) - The ID of the line item to set metadata. Either lineItemId or productId is required.
  • productId (type: String.t, default: nil) - The ID of the product to set metadata. This is the REST ID used in the products service. Either lineItemId or productId is required.

Attributes

  • carrier (type: String.t, default: nil) - Deprecated. Please use shipmentInfo instead. The carrier handling the shipment. See shipments[].carrier in the Orders resource representation for a list of acceptable values.
  • lineItems (type: list(GoogleApi.Content.V2.Model.OrderShipmentLineItemShipment.t), default: nil) - Line items to ship.
  • shipmentGroupId (type: String.t, default: nil) - ID of the shipment group. Required for orders that use the orderinvoices service.
  • shipmentId (type: String.t, default: nil) - Deprecated. Please use shipmentInfo instead. The ID of the shipment.
  • shipmentInfos (type: list(GoogleApi.Content.V2.Model.OrdersCustomBatchRequestEntryShipLineItemsShipmentInfo.t), default: nil) - Shipment information. This field is repeated because a single line item can be shipped in several packages (and have several tracking IDs).
  • trackingId (type: String.t, default: nil) - Deprecated. Please use shipmentInfo instead. The tracking ID for the shipment.

Attributes

  • carrier (type: String.t, default: nil) - The carrier handling the shipment. See shipments[].carrier in the Orders resource representation for a list of acceptable values.
  • shipmentId (type: String.t, default: nil) - Required. The ID of the shipment. This is assigned by the merchant and is unique to each shipment.
  • trackingId (type: String.t, default: nil) - The tracking ID for the shipment.

Attributes

  • deliverByDate (type: String.t, default: nil) - Updated delivery by date, in ISO 8601 format. If not specified only ship by date is updated.

Attributes

  • carrier (type: String.t, default: nil) - The carrier handling the shipment. Not updated if missing. See shipments[].carrier in the Orders resource representation for a list of acceptable values.

Attributes

  • entries (type: list(GoogleApi.Content.V2.Model.OrdersCustomBatchResponseEntry.t), default: nil) - The result of the execution of the batch requests.
  • kind (type: String.t, default: content#ordersCustomBatchResponse) - Identifies what kind of resource this is. Value: the fixed string "content#ordersCustomBatchResponse".

Attributes

  • batchId (type: integer(), default: nil) - The ID of the request entry this entry responds to.

Attributes

  • kind (type: String.t, default: content#ordersGetByMerchantOrderIdResponse) - Identifies what kind of resource this is. Value: the fixed string "content#ordersGetByMerchantOrderIdResponse".
  • order (type: GoogleApi.Content.V2.Model.Order.t, default: nil) - The requested order.

Attributes

  • kind (type: String.t, default: content#ordersGetTestOrderTemplateResponse) - Identifies what kind of resource this is. Value: the fixed string "content#ordersGetTestOrderTemplateResponse".
  • template (type: GoogleApi.Content.V2.Model.TestOrder.t, default: nil) - The requested test order template.

Attributes

  • amountPretax (type: GoogleApi.Content.V2.Model.Price.t, default: nil) - The amount that is refunded. Required.

Attributes

  • executionStatus (type: String.t, default: nil) - The status of the execution.

Attributes

  • kind (type: String.t, default: content#ordersListResponse) - Identifies what kind of resource this is. Value: the fixed string "content#ordersListResponse".
  • nextPageToken (type: String.t, default: nil) - The token for the retrieval of the next page of orders.
  • resources (type: list(GoogleApi.Content.V2.Model.Order.t), default: nil) -

Attributes

  • amount (type: GoogleApi.Content.V2.Model.Price.t, default: nil) - Deprecated. Please use amountPretax and amountTax instead.

Attributes

  • executionStatus (type: String.t, default: nil) - The status of the execution.

Attributes

  • lineItemId (type: String.t, default: nil) - The ID of the line item to return. Either lineItemId or productId is required.

Attributes

  • executionStatus (type: String.t, default: nil) - The status of the execution.

Attributes

  • lineItemId (type: String.t, default: nil) - The ID of the line item to return. Either lineItemId or productId is required.

Attributes

  • executionStatus (type: String.t, default: nil) - The status of the execution.

Attributes

  • amountPretax (type: GoogleApi.Content.V2.Model.Price.t, default: nil) - The amount that is refunded. If omitted, refundless return is assumed (same as calling returnLineItem method).

Attributes

  • executionStatus (type: String.t, default: nil) - The status of the execution.

Attributes

  • annotations (type: list(GoogleApi.Content.V2.Model.OrderMerchantProvidedAnnotation.t), default: nil) -
  • lineItemId (type: String.t, default: nil) - The ID of the line item to set metadata. Either lineItemId or productId is required.
  • operationId (type: String.t, default: nil) - The ID of the operation. Unique across all operations for a given order.
  • productId (type: String.t, default: nil) - The ID of the product to set metadata. This is the REST ID used in the products service. Either lineItemId or productId is required.

Attributes

  • executionStatus (type: String.t, default: nil) - The status of the execution.

Attributes

  • carrier (type: String.t, default: nil) - Deprecated. Please use shipmentInfo instead. The carrier handling the shipment. See shipments[].carrier in the Orders resource representation for a list of acceptable values.
  • lineItems (type: list(GoogleApi.Content.V2.Model.OrderShipmentLineItemShipment.t), default: nil) - Line items to ship.
  • operationId (type: String.t, default: nil) - The ID of the operation. Unique across all operations for a given order.
  • shipmentGroupId (type: String.t, default: nil) - ID of the shipment group. Required for orders that use the orderinvoices service.
  • shipmentId (type: String.t, default: nil) - Deprecated. Please use shipmentInfo instead. The ID of the shipment.
  • shipmentInfos (type: list(GoogleApi.Content.V2.Model.OrdersCustomBatchRequestEntryShipLineItemsShipmentInfo.t), default: nil) - Shipment information. This field is repeated because a single line item can be shipped in several packages (and have several tracking IDs).
  • trackingId (type: String.t, default: nil) - Deprecated. Please use shipmentInfo instead. The tracking ID for the shipment.

Attributes

  • executionStatus (type: String.t, default: nil) - The status of the execution.

Attributes

  • deliverByDate (type: String.t, default: nil) - Updated delivery by date, in ISO 8601 format. If not specified only ship by date is updated.

Attributes

  • executionStatus (type: String.t, default: nil) - The status of the execution.

Attributes

  • merchantOrderId (type: String.t, default: nil) - The merchant order id to be assigned to the order. Must be unique per merchant.
  • operationId (type: String.t, default: nil) - The ID of the operation. Unique across all operations for a given order.

Attributes

  • executionStatus (type: String.t, default: nil) - The status of the execution.

Attributes

  • carrier (type: String.t, default: nil) - The carrier handling the shipment. Not updated if missing. See shipments[].carrier in the Orders resource representation for a list of acceptable values.

Attributes

  • executionStatus (type: String.t, default: nil) - The status of the execution.

Attributes

  • carrierName (type: String.t, default: nil) - The name of the pickup carrier (e.g., "UPS"). Required.
  • serviceName (type: String.t, default: nil) - The name of the pickup service (e.g., "Access point"). Required.

Attributes

  • carrierName (type: String.t, default: nil) - The name of the carrier (e.g., "UPS"). Always present.
  • country (type: String.t, default: nil) - The CLDR country code of the carrier (e.g., "US"). Always present.
  • serviceName (type: String.t, default: nil) - The name of the pickup service (e.g., "Access point"). Always present.

Attributes

  • entries (type: list(GoogleApi.Content.V2.Model.PosCustomBatchRequestEntry.t), default: nil) - The request entries to be processed in the batch.

Attributes

  • batchId (type: integer(), default: nil) - An entry ID, unique within the batch request.

Attributes

  • entries (type: list(GoogleApi.Content.V2.Model.PosCustomBatchResponseEntry.t), default: nil) - The result of the execution of the batch requests.
  • kind (type: String.t, default: content#posCustomBatchResponse) - Identifies what kind of resource this is. Value: the fixed string "content#posCustomBatchResponse".

Attributes

  • batchId (type: integer(), default: nil) - The ID of the request entry to which this entry responds.
  • errors (type: GoogleApi.Content.V2.Model.Errors.t, default: nil) - A list of errors defined if, and only if, the request failed.
  • inventory (type: GoogleApi.Content.V2.Model.PosInventory.t, default: nil) - The updated inventory information.
  • kind (type: String.t, default: content#posCustomBatchResponseEntry) - Identifies what kind of resource this is. Value: the fixed string "content#posCustomBatchResponseEntry"
  • sale (type: GoogleApi.Content.V2.Model.PosSale.t, default: nil) - The updated sale information.
  • store (type: GoogleApi.Content.V2.Model.PosStore.t, default: nil) - The retrieved or updated store information.

Attributes

  • country (type: String.t, default: nil) - Country code.
  • posDataProviders (type: list(GoogleApi.Content.V2.Model.PosDataProvidersPosDataProvider.t), default: nil) - A list of POS data providers.

Attributes

  • displayName (type: String.t, default: nil) - The display name of Pos data Provider.
  • fullName (type: String.t, default: nil) - The full name of this POS data Provider.
  • providerId (type: String.t, default: nil) - The ID of the account.

The absolute quantity of an item available at the given store.

Attributes

  • contentLanguage (type: String.t, default: nil) - Required. The two-letter ISO 639-1 language code for the item.
  • gtin (type: String.t, default: nil) - Global Trade Item Number.
  • itemId (type: String.t, default: nil) - Required. A unique identifier for the item.
  • price (type: GoogleApi.Content.V2.Model.Price.t, default: nil) - Required. The current price of the item.
  • quantity (type: String.t, default: nil) - Required. The available quantity of the item.
  • storeCode (type: String.t, default: nil) - Required. The identifier of the merchant's store. Either a storeCode inserted via the API or the code of the store in Google My Business.
  • targetCountry (type: String.t, default: nil) - Required. The CLDR territory code for the item.
  • timestamp (type: String.t, default: nil) - Required. The inventory timestamp, in ISO 8601 format.

Attributes

  • contentLanguage (type: String.t, default: nil) - Required. The two-letter ISO 639-1 language code for the item.
  • gtin (type: String.t, default: nil) - Global Trade Item Number.
  • itemId (type: String.t, default: nil) - Required. A unique identifier for the item.
  • kind (type: String.t, default: content#posInventoryResponse) - Identifies what kind of resource this is. Value: the fixed string "content#posInventoryResponse".
  • price (type: GoogleApi.Content.V2.Model.Price.t, default: nil) - Required. The current price of the item.
  • quantity (type: String.t, default: nil) - Required. The available quantity of the item.
  • storeCode (type: String.t, default: nil) - Required. The identifier of the merchant's store. Either a storeCode inserted via the API or the code of the store in Google My Business.
  • targetCountry (type: String.t, default: nil) - Required. The CLDR territory code for the item.
  • timestamp (type: String.t, default: nil) - Required. The inventory timestamp, in ISO 8601 format.

Attributes

  • kind (type: String.t, default: content#posListResponse) - Identifies what kind of resource this is. Value: the fixed string "content#posListResponse".
  • resources (type: list(GoogleApi.Content.V2.Model.PosStore.t), default: nil) -

The change of the available quantity of an item at the given store.

Attributes

  • contentLanguage (type: String.t, default: nil) - Required. The two-letter ISO 639-1 language code for the item.
  • gtin (type: String.t, default: nil) - Global Trade Item Number.
  • itemId (type: String.t, default: nil) - Required. A unique identifier for the item.
  • price (type: GoogleApi.Content.V2.Model.Price.t, default: nil) - Required. The price of the item.
  • quantity (type: String.t, default: nil) - Required. The relative change of the available quantity. Negative for items returned.
  • saleId (type: String.t, default: nil) - A unique ID to group items from the same sale event.
  • storeCode (type: String.t, default: nil) - Required. The identifier of the merchant's store. Either a storeCode inserted via the API or the code of the store in Google My Business.
  • targetCountry (type: String.t, default: nil) - Required. The CLDR territory code for the item.
  • timestamp (type: String.t, default: nil) - Required. The inventory timestamp, in ISO 8601 format.

Attributes

  • contentLanguage (type: String.t, default: nil) - Required. The two-letter ISO 639-1 language code for the item.
  • gtin (type: String.t, default: nil) - Global Trade Item Number.
  • itemId (type: String.t, default: nil) - Required. A unique identifier for the item.
  • kind (type: String.t, default: content#posSaleResponse) - Identifies what kind of resource this is. Value: the fixed string "content#posSaleResponse".
  • price (type: GoogleApi.Content.V2.Model.Price.t, default: nil) - Required. The price of the item.
  • quantity (type: String.t, default: nil) - Required. The relative change of the available quantity. Negative for items returned.
  • saleId (type: String.t, default: nil) - A unique ID to group items from the same sale event.
  • storeCode (type: String.t, default: nil) - Required. The identifier of the merchant's store. Either a storeCode inserted via the API or the code of the store in Google My Business.
  • targetCountry (type: String.t, default: nil) - Required. The CLDR territory code for the item.
  • timestamp (type: String.t, default: nil) - Required. The inventory timestamp, in ISO 8601 format.

Attributes

  • country (type: String.t, default: nil) - The CLDR territory code of the country the postal code group applies to. Required.
  • name (type: String.t, default: nil) - The name of the postal code group, referred to in headers. Required.
  • postalCodeRanges (type: list(GoogleApi.Content.V2.Model.PostalCodeRange.t), default: nil) - A range of postal codes. Required.

Attributes

  • postalCodeRangeBegin (type: String.t, default: nil) - A postal code or a pattern of the form prefix* denoting the inclusive lower bound of the range defining the area. Examples values: "94108", "9410*", "9*". Required.
  • postalCodeRangeEnd (type: String.t, default: nil) - A postal code or a pattern of the form prefix* denoting the inclusive upper bound of the range defining the area. It must have the same length as postalCodeRangeBegin: if postalCodeRangeBegin is a postal code then postalCodeRangeEnd must be a postal code too; if postalCodeRangeBegin is a pattern then postalCodeRangeEnd must be a pattern with the same prefix length. Optional: if not set, then the area is defined as being all the postal codes matching postalCodeRangeBegin.

Attributes

  • currency (type: String.t, default: nil) - The currency of the price.
  • value (type: String.t, default: nil) - The price represented as a number.

Required product attributes are primarily defined by the products data specification. See the Products Data Specification Help Center article for information.

Attributes

  • priceAmount (type: GoogleApi.Content.V2.Model.Price.t, default: nil) - The pre-tax or post-tax price depending on the location of the order.
  • remittedTaxAmount (type: GoogleApi.Content.V2.Model.Price.t, default: nil) - Remitted tax value.
  • taxAmount (type: GoogleApi.Content.V2.Model.Price.t, default: nil) - Tax value.

Attributes

  • aspectName (type: String.t, default: nil) - Deprecated.
  • destinationName (type: String.t, default: nil) - Deprecated.
  • intention (type: String.t, default: nil) - Deprecated.

Attributes

  • destinationName (type: String.t, default: nil) - The name of the destination.
  • intention (type: String.t, default: nil) - Whether the destination is required, excluded or should be validated.

Attributes

  • country (type: String.t, default: nil) - The CLDR territory code of the country to which an item will ship.
  • locationGroupName (type: String.t, default: nil) - The location where the shipping is applicable, represented by a location group name.
  • locationId (type: String.t, default: nil) - The numeric ID of a location that the shipping rate applies to as defined in the AdWords API.
  • postalCode (type: String.t, default: nil) - The postal code range that the shipping rate applies to, represented by a postal code, a postal code prefix followed by a * wildcard, a range between two postal codes or two postal code prefixes of equal length.
  • price (type: GoogleApi.Content.V2.Model.Price.t, default: nil) - Fixed shipping price, represented as a number.
  • region (type: String.t, default: nil) - The geographic region to which a shipping rate applies.
  • service (type: String.t, default: nil) - A free-form description of the service class or delivery speed.

Attributes

  • unit (type: String.t, default: nil) - The unit of value.
  • value (type: float(), default: nil) - The dimension of the product used to calculate the shipping cost of the item.

Attributes

  • unit (type: String.t, default: nil) - The unit of value.
  • value (type: float(), default: nil) - The weight of the product used to calculate the shipping cost of the item.

The status of a product, i.e., information about a product computed asynchronously.

Attributes

  • destination (type: String.t, default: nil) -
  • detail (type: String.t, default: nil) -
  • fetchStatus (type: String.t, default: nil) -
  • id (type: String.t, default: nil) -
  • location (type: String.t, default: nil) -
  • severity (type: String.t, default: nil) -
  • timestamp (type: String.t, default: nil) -
  • valueOnLandingPage (type: String.t, default: nil) -
  • valueProvided (type: String.t, default: nil) -

Attributes

  • approvalPending (type: boolean(), default: nil) - Whether the approval status might change due to further processing.

Attributes

  • attributeName (type: String.t, default: nil) - The attribute's name, if the issue is caused by a single attribute.
  • code (type: String.t, default: nil) - The error code of the issue.
  • description (type: String.t, default: nil) - A short issue description in English.
  • destination (type: String.t, default: nil) - The destination the issue applies to.
  • detail (type: String.t, default: nil) - A detailed issue description in English.
  • documentation (type: String.t, default: nil) - The URL of a web page to help with resolving this issue.
  • resolution (type: String.t, default: nil) - Whether the issue can be resolved by the merchant.
  • servability (type: String.t, default: nil) - How this issue affects serving of the offer.

Attributes

  • country (type: String.t, default: nil) - The country within which the item is taxed, specified as a CLDR territory code.
  • locationId (type: String.t, default: nil) - The numeric ID of a location that the tax rate applies to as defined in the AdWords API.
  • postalCode (type: String.t, default: nil) - The postal code range that the tax rate applies to, represented by a ZIP code, a ZIP code prefix using wildcard, a range between two ZIP codes or two ZIP code prefixes of equal length. Examples: 94114, 94, 94002-95460, 94-95.
  • rate (type: float(), default: nil) - The percentage of tax rate that applies to the item price.
  • region (type: String.t, default: nil) - The geographic region to which the tax rate applies.
  • taxShip (type: boolean(), default: nil) - Set to true if tax is charged on shipping.

Attributes

  • unit (type: String.t, default: nil) - The unit of the denominator.
  • value (type: String.t, default: nil) - The denominator of the unit price.

Attributes

  • unit (type: String.t, default: nil) - The unit of the measure.
  • value (type: float(), default: nil) - The measure of an item.

Attributes

  • entries (type: list(GoogleApi.Content.V2.Model.ProductsCustomBatchRequestEntry.t), default: nil) - The request entries to be processed in the batch.

A batch entry encoding a single non-batch products request.

Attributes

  • entries (type: list(GoogleApi.Content.V2.Model.ProductsCustomBatchResponseEntry.t), default: nil) - The result of the execution of the batch requests.
  • kind (type: String.t, default: content#productsCustomBatchResponse) - Identifies what kind of resource this is. Value: the fixed string "content#productsCustomBatchResponse".

A batch entry encoding a single non-batch products response.

Attributes

  • kind (type: String.t, default: content#productsListResponse) - Identifies what kind of resource this is. Value: the fixed string "content#productsListResponse".
  • nextPageToken (type: String.t, default: nil) - The token for the retrieval of the next page of products.
  • resources (type: list(GoogleApi.Content.V2.Model.Product.t), default: nil) -

Attributes

  • entries (type: list(GoogleApi.Content.V2.Model.ProductstatusesCustomBatchRequestEntry.t), default: nil) - The request entries to be processed in the batch.

A batch entry encoding a single non-batch productstatuses request.

Attributes

  • entries (type: list(GoogleApi.Content.V2.Model.ProductstatusesCustomBatchResponseEntry.t), default: nil) - The result of the execution of the batch requests.
  • kind (type: String.t, default: content#productstatusesCustomBatchResponse) - Identifies what kind of resource this is. Value: the fixed string "content#productstatusesCustomBatchResponse".

A batch entry encoding a single non-batch productstatuses response.

Attributes

  • kind (type: String.t, default: content#productstatusesListResponse) - Identifies what kind of resource this is. Value: the fixed string "content#productstatusesListResponse".
  • nextPageToken (type: String.t, default: nil) - The token for the retrieval of the next page of products statuses.
  • resources (type: list(GoogleApi.Content.V2.Model.ProductStatus.t), default: nil) -

Attributes

  • promotionAmount (type: GoogleApi.Content.V2.Model.Amount.t, default: nil) - [required] Amount of the promotion. The values here are the promotion applied to the unit price pretax and to the total of the tax amounts.
  • promotionId (type: String.t, default: nil) - [required] ID of the promotion.

Attributes

  • applicableShippingLabels (type: list(String.t), default: nil) - A list of shipping labels defining the products to which this rate group applies to. This is a disjunction: only one of the labels has to match for the rate group to apply. May only be empty for the last rate group of a service. Required.
  • carrierRates (type: list(GoogleApi.Content.V2.Model.CarrierRate.t), default: nil) - A list of carrier rates that can be referred to by mainTable or singleValue.
  • mainTable (type: GoogleApi.Content.V2.Model.Table.t, default: nil) - A table defining the rate group, when singleValue is not expressive enough. Can only be set if singleValue is not set.
  • name (type: String.t, default: nil) - Name of the rate group. Optional. If set has to be unique within shipping service.
  • singleValue (type: GoogleApi.Content.V2.Model.Value.t, default: nil) - The value of the rate group (e.g. flat rate $10). Can only be set if mainTable and subtables are not set.
  • subtables (type: list(GoogleApi.Content.V2.Model.Table.t), default: nil) - A list of subtables referred to by mainTable. Can only be set if mainTable is set.

Attributes

  • description (type: String.t, default: nil) - Description of the reason.
  • reasonCode (type: String.t, default: nil) - Code of the refund reason.

Attributes

  • creationDate (type: String.t, default: nil) - The date of creation of the shipment, in ISO 8601 format.

Attributes

  • cells (type: list(GoogleApi.Content.V2.Model.Value.t), default: nil) - The list of cells that constitute the row. Must have the same length as columnHeaders for two-dimensional tables, a length of 1 for one-dimensional tables. Required.

Attributes

  • active (type: boolean(), default: nil) - A boolean exposing the active status of the shipping service. Required.

Attributes

  • invoiceSummary (type: GoogleApi.Content.V2.Model.InvoiceSummary.t, default: nil) - [required] Invoice summary.
  • lineItemInvoices (type: list(GoogleApi.Content.V2.Model.ShipmentInvoiceLineItemInvoice.t), default: nil) - [required] Invoice details per line item.
  • shipmentGroupId (type: String.t, default: nil) - [required] ID of the shipment group. It is assigned by the merchant in the shipLineItems method and is used to group multiple line items that have the same kind of shipping charges.

Attributes

  • lineItemId (type: String.t, default: nil) - ID of the line item. Either lineItemId or productId must be set.
  • productId (type: String.t, default: nil) - ID of the product. This is the REST ID used in the products service. Either lineItemId or productId must be set.
  • shipmentUnitIds (type: list(String.t), default: nil) - [required] The shipment unit ID is assigned by the merchant and defines individual quantities within a line item. The same ID can be assigned to units that are the same while units that differ must be assigned a different ID (for example: free or promotional units).
  • unitInvoice (type: GoogleApi.Content.V2.Model.UnitInvoice.t, default: nil) - [required] Invoice details for a single unit.

Attributes

  • carrier (type: String.t, default: nil) - The shipping carrier that handles the package.

The merchant account's shipping settings. All methods except getsupportedcarriers and getsupportedholidays require the admin role.

Attributes

  • entries (type: list(GoogleApi.Content.V2.Model.ShippingsettingsCustomBatchRequestEntry.t), default: nil) - The request entries to be processed in the batch.

A batch entry encoding a single non-batch shippingsettings request.

Attributes

  • entries (type: list(GoogleApi.Content.V2.Model.ShippingsettingsCustomBatchResponseEntry.t), default: nil) - The result of the execution of the batch requests.
  • kind (type: String.t, default: content#shippingsettingsCustomBatchResponse) - Identifies what kind of resource this is. Value: the fixed string "content#shippingsettingsCustomBatchResponse".

A batch entry encoding a single non-batch shipping settings response.

Attributes

  • carriers (type: list(GoogleApi.Content.V2.Model.CarriersCarrier.t), default: nil) - A list of supported carriers. May be empty.
  • kind (type: String.t, default: content#shippingsettingsGetSupportedCarriersResponse) - Identifies what kind of resource this is. Value: the fixed string "content#shippingsettingsGetSupportedCarriersResponse".

Attributes

  • holidays (type: list(GoogleApi.Content.V2.Model.HolidaysHoliday.t), default: nil) - A list of holidays applicable for delivery guarantees. May be empty.
  • kind (type: String.t, default: content#shippingsettingsGetSupportedHolidaysResponse) - Identifies what kind of resource this is. Value: the fixed string "content#shippingsettingsGetSupportedHolidaysResponse".

Attributes

  • kind (type: String.t, default: content#shippingsettingsGetSupportedPickupServicesResponse) - Identifies what kind of resource this is. Value: the fixed string "content#shippingsettingsGetSupportedPickupServicesResponse".
  • pickupServices (type: list(GoogleApi.Content.V2.Model.PickupServicesPickupService.t), default: nil) - A list of supported pickup services. May be empty.

Attributes

  • kind (type: String.t, default: content#shippingsettingsListResponse) - Identifies what kind of resource this is. Value: the fixed string "content#shippingsettingsListResponse".
  • nextPageToken (type: String.t, default: nil) - The token for the retrieval of the next page of shipping settings.
  • resources (type: list(GoogleApi.Content.V2.Model.ShippingSettings.t), default: nil) -

Attributes

  • columnHeaders (type: GoogleApi.Content.V2.Model.Headers.t, default: nil) - Headers of the table's columns. Optional: if not set then the table has only one dimension.
  • name (type: String.t, default: nil) - Name of the table. Required for subtables, ignored for the main table.
  • rowHeaders (type: GoogleApi.Content.V2.Model.Headers.t, default: nil) - Headers of the table's rows. Required.
  • rows (type: list(GoogleApi.Content.V2.Model.Row.t), default: nil) - The list of rows that constitute the table. Must have the same length as rowHeaders. Required.

Attributes

  • customer (type: GoogleApi.Content.V2.Model.TestOrderCustomer.t, default: nil) - Required. The details of the customer who placed the order.

Attributes

  • email (type: String.t, default: nil) - Required. Email address of the customer.

Attributes

  • explicitMarketingPreference (type: String.t, default: nil) - Last know user use selection regards marketing preferences. In certain cases selection might not be known, so this field would be empty.

Attributes

  • product (type: GoogleApi.Content.V2.Model.TestOrderLineItemProduct.t, default: nil) - Required. Product data from the time of the order placement.
  • quantityOrdered (type: integer(), default: nil) - Required. Number of items ordered.
  • returnInfo (type: GoogleApi.Content.V2.Model.OrderLineItemReturnInfo.t, default: nil) - Required. Details of the return policy for the line item.
  • shippingDetails (type: GoogleApi.Content.V2.Model.OrderLineItemShippingDetails.t, default: nil) - Required. Details of the requested shipping for the line item.
  • unitTax (type: GoogleApi.Content.V2.Model.Price.t, default: nil) - Deprecated. Ignored if provided.

Attributes

  • brand (type: String.t, default: nil) - Required. Brand of the item.

Attributes

  • expirationMonth (type: integer(), default: nil) - The card expiration month (January = 1, February = 2 etc.).

Attributes

  • postalCodeGroupNames (type: list(String.t), default: nil) - A list of postal group names. The last value can be "all other locations". Example: ["zone 1", "zone 2", "all other locations"]. The referred postal code groups must match the delivery country of the service.
  • rows (type: list(GoogleApi.Content.V2.Model.TransitTableTransitTimeRow.t), default: nil) -
  • transitTimeLabels (type: list(String.t), default: nil) - A list of transit time labels. The last value can be "all other labels". Example: ["food", "electronics", "all other labels"].

Attributes

  • values (type: list(GoogleApi.Content.V2.Model.TransitTableTransitTimeRowTransitTimeValue.t), default: nil) -

Attributes

  • maxTransitTimeInDays (type: integer(), default: nil) - Must be greater than or equal to minTransitTimeInDays.
  • minTransitTimeInDays (type: integer(), default: nil) - Transit time range (min-max) in business days. 0 means same day delivery, 1 means next day delivery.

Attributes

  • additionalCharges (type: list(GoogleApi.Content.V2.Model.UnitInvoiceAdditionalCharge.t), default: nil) - Additional charges for a unit, e.g. shipping costs.
  • promotions (type: list(GoogleApi.Content.V2.Model.Promotion.t), default: nil) - Deprecated.
  • unitPricePretax (type: GoogleApi.Content.V2.Model.Price.t, default: nil) - [required] Price of the unit, before applying taxes.
  • unitPriceTaxes (type: list(GoogleApi.Content.V2.Model.UnitInvoiceTaxLine.t), default: nil) - Tax amounts to apply to the unit price.

Attributes

  • additionalChargeAmount (type: GoogleApi.Content.V2.Model.Amount.t, default: nil) - [required] Amount of the additional charge.
  • additionalChargePromotions (type: list(GoogleApi.Content.V2.Model.Promotion.t), default: nil) - Deprecated.
  • type (type: String.t, default: nil) - [required] Type of the additional charge.

Attributes

  • taxAmount (type: GoogleApi.Content.V2.Model.Price.t, default: nil) - [required] Tax amount for the tax type.
  • taxName (type: String.t, default: nil) - Optional name of the tax type. This should only be provided if taxType is otherFeeTax.
  • taxType (type: String.t, default: nil) - [required] Type of the tax.

The single value of a rate group or the value of a rate group table's cell. Exactly one of noShipping, flatRate, pricePercentage, carrierRateName, subtableName must be set.

Attributes

  • unit (type: String.t, default: nil) - Required. The weight unit.

API calls for all endpoints tagged Accounts.

API calls for all endpoints tagged Accountstatuses.

API calls for all endpoints tagged Accounttax.

API calls for all endpoints tagged Datafeeds.

API calls for all endpoints tagged Datafeedstatuses.

API calls for all endpoints tagged Liasettings.

API calls for all endpoints tagged Localinventory.

API calls for all endpoints tagged Orderinvoices.

API calls for all endpoints tagged Orderreports.

API calls for all endpoints tagged Orderreturns.

API calls for all endpoints tagged Orders.

API calls for all endpoints tagged Pos.

API calls for all endpoints tagged Products.

API calls for all endpoints tagged Productstatuses.

API calls for all endpoints tagged Pubsubnotificationsettings.

API calls for all endpoints tagged Regionalinventory.

API calls for all endpoints tagged Returnaddress.

API calls for all endpoints tagged Returnpolicy.

API calls for all endpoints tagged Settlementreports.

API calls for all endpoints tagged Settlementtransactions.

API calls for all endpoints tagged Shippingsettings.

Handle Tesla connections for GoogleApi.Content.V21.

Account data. After the creation of a new account it may take a few minutes before it is fully operational. The methods delete, insert, and update require the admin role.

Attributes

  • country (type: String.t, default: nil) - CLDR country code (e.g. "US").
  • locality (type: String.t, default: nil) - City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
  • postalCode (type: String.t, default: nil) - Postal code or ZIP (e.g. "94043").
  • region (type: String.t, default: nil) - Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC").
  • streetAddress (type: String.t, default: nil) - Street-level part of the address.

Attributes

  • adsId (type: String.t, default: nil) - Customer ID of the Ads account.
  • status (type: String.t, default: nil) - Status of the link between this Merchant Center account and the Ads account. Upon retrieval, it represents the actual status of the link and can be either active if it was approved in Google Ads or pending if it's pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status active when it's still pending or with status pending when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status inactive is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending.

Attributes

  • address (type: GoogleApi.Content.V21.Model.AccountAddress.t, default: nil) - The address of the business.
  • customerService (type: GoogleApi.Content.V21.Model.AccountCustomerService.t, default: nil) - The customer service information of the business.
  • phoneNumber (type: String.t, default: nil) - The phone number of the business.

Attributes

  • email (type: String.t, default: nil) - Customer service email.
  • phoneNumber (type: String.t, default: nil) - Customer service phone number.
  • url (type: String.t, default: nil) - Customer service URL.

Attributes

  • gmbEmail (type: String.t, default: nil) - The GMB email address of which a specific account within a GMB account. A sample account within a GMB account could be a business account with set of locations, managed under the GMB account.
  • status (type: String.t, default: nil) - Status of the link between this Merchant Center account and the GMB account.

Attributes

  • aggregatorId (type: String.t, default: nil) - The aggregator ID, set for aggregators and subaccounts (in that case, it represents the aggregator of the subaccount).
  • merchantId (type: String.t, default: nil) - The merchant account ID, set for individual accounts and subaccounts.

The status of an account, i.e., information about its products, which is computed offline and not returned immediately at insertion time.

Attributes

  • country (type: String.t, default: nil) - Country for which this issue is reported.

Attributes

  • attributeName (type: String.t, default: nil) - The attribute's name, if the issue is caused by a single attribute.
  • code (type: String.t, default: nil) - The error code of the issue.
  • description (type: String.t, default: nil) - A short issue description in English.
  • detail (type: String.t, default: nil) - A detailed issue description in English.
  • documentation (type: String.t, default: nil) - The URL of a web page to help with resolving this issue.
  • numItems (type: String.t, default: nil) - Number of items with this issue.
  • resolution (type: String.t, default: nil) - Whether the issue can be resolved by the merchant.
  • servability (type: String.t, default: nil) - How this issue affects serving of the offer.

Attributes

  • channel (type: String.t, default: nil) - The channel the data applies to.

Attributes

  • active (type: String.t, default: nil) - Number of active offers.
  • disapproved (type: String.t, default: nil) - Number of disapproved offers.
  • expiring (type: String.t, default: nil) - Number of expiring offers.
  • pending (type: String.t, default: nil) - Number of pending offers.

The tax settings of a merchant account. All methods require the admin role.

Tax calculation rule to apply in a state or province (USA only).

Attributes

  • admin (type: boolean(), default: nil) - Whether user is an admin.
  • emailAddress (type: String.t, default: nil) - User's email address.
  • orderManager (type: boolean(), default: nil) - Whether user is an order manager.
  • paymentsAnalyst (type: boolean(), default: nil) - Whether user can access payment statements.
  • paymentsManager (type: boolean(), default: nil) - Whether user can manage payment settings.

Attributes

  • channelId (type: String.t, default: nil) - Channel ID.
  • status (type: String.t, default: nil) - Status of the link between this Merchant Center account and the YouTube channel. Upon retrieval, it represents the actual status of the link and can be either active if it was approved in YT Creator Studio or pending if it's pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status active when it's still pending or with status pending when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status inactive is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending.

Attributes

  • accountIdentifiers (type: list(GoogleApi.Content.V21.Model.AccountIdentifier.t), default: nil) - The account identifiers corresponding to the authenticated user.

Attributes

  • kind (type: String.t, default: content#accountsClaimWebsiteResponse) - Identifies what kind of resource this is. Value: the fixed string "content#accountsClaimWebsiteResponse".

Attributes

  • entries (type: list(GoogleApi.Content.V21.Model.AccountsCustomBatchRequestEntry.t), default: nil) - The request entries to be processed in the batch.

A batch entry encoding a single non-batch accounts request.

Attributes

  • action (type: String.t, default: nil) - Action to perform for this link. The "request" action is only available to select merchants.

Attributes

  • entries (type: list(GoogleApi.Content.V21.Model.AccountsCustomBatchResponseEntry.t), default: nil) - The result of the execution of the batch requests.
  • kind (type: String.t, default: content#accountsCustomBatchResponse) - Identifies what kind of resource this is. Value: the fixed string "content#accountsCustomBatchResponse".

A batch entry encoding a single non-batch accounts response.

Attributes

  • action (type: String.t, default: nil) - Action to perform for this link. The "request" action is only available to select merchants.

Attributes

  • kind (type: String.t, default: content#accountsLinkResponse) - Identifies what kind of resource this is. Value: the fixed string "content#accountsLinkResponse".

Attributes

  • kind (type: String.t, default: content#accountsListLinksResponse) - Identifies what kind of resource this is. Value: the fixed string "content#accountsListLinksResponse".
  • links (type: list(GoogleApi.Content.V21.Model.LinkedAccount.t), default: nil) - The list of available links.
  • nextPageToken (type: String.t, default: nil) - The token for the retrieval of the next page of links.

Attributes

  • kind (type: String.t, default: content#accountsListResponse) - Identifies what kind of resource this is. Value: the fixed string "content#accountsListResponse".
  • nextPageToken (type: String.t, default: nil) - The token for the retrieval of the next page of accounts.
  • resources (type: list(GoogleApi.Content.V21.Model.Account.t), default: nil) -

Attributes

  • entries (type: list(GoogleApi.Content.V21.Model.AccountstatusesCustomBatchRequestEntry.t), default: nil) - The request entries to be processed in the batch.

A batch entry encoding a single non-batch accountstatuses request.

Attributes

  • entries (type: list(GoogleApi.Content.V21.Model.AccountstatusesCustomBatchResponseEntry.t), default: nil) - The result of the execution of the batch requests.
  • kind (type: String.t, default: content#accountstatusesCustomBatchResponse) - Identifies what kind of resource this is. Value: the fixed string "content#accountstatusesCustomBatchResponse".

A batch entry encoding a single non-batch accountstatuses response.

Attributes

  • kind (type: String.t, default: content#accountstatusesListResponse) - Identifies what kind of resource this is. Value: the fixed string "content#accountstatusesListResponse".
  • nextPageToken (type: String.t, default: nil) - The token for the retrieval of the next page of account statuses.
  • resources (type: list(GoogleApi.Content.V21.Model.AccountStatus.t), default: nil) -

Attributes

  • entries (type: list(GoogleApi.Content.V21.Model.AccounttaxCustomBatchRequestEntry.t), default: nil) - The request entries to be processed in the batch.

A batch entry encoding a single non-batch accounttax request.

Attributes

  • entries (type: list(GoogleApi.Content.V21.Model.AccounttaxCustomBatchResponseEntry.t), default: nil) - The result of the execution of the batch requests.
  • kind (type: String.t, default: content#accounttaxCustomBatchResponse) - Identifies what kind of resource this is. Value: the fixed string "content#accounttaxCustomBatchResponse".

A batch entry encoding a single non-batch accounttax response.

Attributes

  • kind (type: String.t, default: content#accounttaxListResponse) - Identifies what kind of resource this is. Value: the fixed string "content#accounttaxListResponse".
  • nextPageToken (type: String.t, default: nil) - The token for the retrieval of the next page of account tax settings.
  • resources (type: list(GoogleApi.Content.V21.Model.AccountTax.t), default: nil) -

Attributes

  • priceAmount (type: GoogleApi.Content.V21.Model.Price.t, default: nil) - [required] The pre-tax or post-tax price depending on the location of the order.
  • taxAmount (type: GoogleApi.Content.V21.Model.Price.t, default: nil) - [required] Tax value.

Attributes

  • businessDays (type: list(String.t), default: nil) - Regular business days. May not be empty.

Attributes

  • carrierName (type: String.t, default: nil) - Carrier service, such as "UPS" or "Fedex". The list of supported carriers can be retrieved via the getSupportedCarriers method. Required.
  • carrierService (type: String.t, default: nil) - Carrier service, such as "ground" or "2 days". The list of supported services for a carrier can be retrieved via the getSupportedCarriers method. Required.
  • flatAdjustment (type: GoogleApi.Content.V21.Model.Price.t, default: nil) - Additive shipping rate modifier. Can be negative. For example { "value": "1", "currency" : "USD" } adds $1 to the rate, { "value": "-3", "currency" : "USD" } removes $3 from the rate. Optional.
  • name (type: String.t, default: nil) - Name of the carrier rate. Must be unique per rate group. Required.
  • originPostalCode (type: String.t, default: nil) - Shipping origin for this carrier rate. Required.
  • percentageAdjustment (type: String.t, default: nil) - Multiplicative shipping rate modifier as a number in decimal notation. Can be negative. For example "5.4" increases the rate by 5.4%, "-3" decreases the rate by 3%. Optional.

Attributes

  • country (type: String.t, default: nil) - The CLDR country code of the carrier (e.g., "US"). Always present.
  • name (type: String.t, default: nil) - The name of the carrier (e.g., "UPS"). Always present.
  • services (type: list(String.t), default: nil) - A list of supported services (e.g., "ground") for that carrier. Contains at least one service.

Attributes

  • groupValues (type: list(GoogleApi.Content.V21.Model.CustomAttribute.t), default: nil) - Subattributes within this attribute group. Exactly one of value or groupValues must be provided.
  • name (type: String.t, default: nil) - The name of the attribute. Underscores will be replaced by spaces upon insertion.
  • value (type: String.t, default: nil) - The value of the attribute.

Attributes

  • description (type: String.t, default: nil) - Description of the reason.
  • reasonCode (type: String.t, default: nil) - Code of the return reason.

Attributes

  • hour (type: integer(), default: nil) - Hour of the cutoff time until which an order has to be placed to be processed in the same day. Required.
  • minute (type: integer(), default: nil) - Minute of the cutoff time until which an order has to be placed to be processed in the same day. Required.
  • timezone (type: String.t, default: nil) - Timezone identifier for the cutoff time. A list of identifiers can be found in the AdWords API documentation. E.g. "Europe/Zurich". Required.

Datafeed configuration data.

The required fields vary based on the frequency of fetching. For a monthly fetch schedule, day_of_month and hour are required. For a weekly fetch schedule, weekday and hour are required. For a daily fetch schedule, only hour is required.

Attributes

  • columnDelimiter (type: String.t, default: nil) - Delimiter for the separation of values in a delimiter-separated values feed. If not specified, the delimiter will be auto-detected. Ignored for non-DSV data feeds.

The status of a datafeed, i.e., the result of the last retrieval of the datafeed computed asynchronously when the feed processing is finished.

An error occurring in the feed, like "invalid price".

An example occurrence for a particular error.

Attributes

  • country (type: String.t, default: nil) - The country where the items in the feed will be included in the search index, represented as a CLDR territory code.

Attributes

  • entries (type: list(GoogleApi.Content.V21.Model.DatafeedsCustomBatchRequestEntry.t), default: nil) - The request entries to be processed in the batch.

A batch entry encoding a single non-batch datafeeds request.

Attributes

  • entries (type: list(GoogleApi.Content.V21.Model.DatafeedsCustomBatchResponseEntry.t), default: nil) - The result of the execution of the batch requests.
  • kind (type: String.t, default: content#datafeedsCustomBatchResponse) - Identifies what kind of resource this is. Value: the fixed string "content#datafeedsCustomBatchResponse".

A batch entry encoding a single non-batch datafeeds response.

Attributes

  • kind (type: String.t, default: content#datafeedsFetchNowResponse) - Identifies what kind of resource this is. Value: the fixed string "content#datafeedsFetchNowResponse".

Attributes

  • kind (type: String.t, default: content#datafeedsListResponse) - Identifies what kind of resource this is. Value: the fixed string "content#datafeedsListResponse".
  • nextPageToken (type: String.t, default: nil) - The token for the retrieval of the next page of datafeeds.
  • resources (type: list(GoogleApi.Content.V21.Model.Datafeed.t), default: nil) -

Attributes

  • entries (type: list(GoogleApi.Content.V21.Model.DatafeedstatusesCustomBatchRequestEntry.t), default: nil) - The request entries to be processed in the batch.

A batch entry encoding a single non-batch datafeedstatuses request.

Attributes

  • entries (type: list(GoogleApi.Content.V21.Model.DatafeedstatusesCustomBatchResponseEntry.t), default: nil) - The result of the execution of the batch requests.
  • kind (type: String.t, default: content#datafeedstatusesCustomBatchResponse) - Identifies what kind of resource this is. Value: the fixed string "content#datafeedstatusesCustomBatchResponse".

A batch entry encoding a single non-batch datafeedstatuses response.

Attributes

  • kind (type: String.t, default: content#datafeedstatusesListResponse) - Identifies what kind of resource this is. Value: the fixed string "content#datafeedstatusesListResponse".
  • nextPageToken (type: String.t, default: nil) - The token for the retrieval of the next page of datafeed statuses.
  • resources (type: list(GoogleApi.Content.V21.Model.DatafeedStatus.t), default: nil) -

Attributes

  • cutoffTime (type: GoogleApi.Content.V21.Model.CutoffTime.t, default: nil) - Business days cutoff time definition. If not configured the cutoff time will be defaulted to 8AM PST.
  • handlingBusinessDayConfig (type: GoogleApi.Content.V21.Model.BusinessDayConfig.t, default: nil) - The business days during which orders can be handled. If not provided, Monday to Friday business days will be assumed.
  • holidayCutoffs (type: list(GoogleApi.Content.V21.Model.HolidayCutoff.t), default: nil) - Holiday cutoff definitions. If configured, they specify order cutoff times for holiday-specific shipping.
  • maxHandlingTimeInDays (type: integer(), default: nil) - Maximum number of business days spent before an order is shipped. 0 means same day shipped, 1 means next day shipped. Must be greater than or equal to minHandlingTimeInDays.
  • maxTransitTimeInDays (type: integer(), default: nil) - Maximum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Must be greater than or equal to minTransitTimeInDays.
  • minHandlingTimeInDays (type: integer(), default: nil) - Minimum number of business days spent before an order is shipped. 0 means same day shipped, 1 means next day shipped.
  • minTransitTimeInDays (type: integer(), default: nil) - Minimum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Either {min,max}TransitTimeInDays or transitTimeTable must be set, but not both.
  • transitBusinessDayConfig (type: GoogleApi.Content.V21.Model.BusinessDayConfig.t, default: nil) - The business days during which orders can be in-transit. If not provided, Monday to Friday business days will be assumed.
  • transitTimeTable (type: GoogleApi.Content.V21.Model.TransitTable.t, default: nil) - Transit time table, number of business days spent in transit based on row and column dimensions. Either {min,max}TransitTimeInDays or transitTimeTable can be set, but not both.

An error returned by the API.

A list of errors returned by a failed batch entry.

Attributes

  • accountId (type: String.t, default: nil) - The ID of the account.
  • gmbAccounts (type: list(GoogleApi.Content.V21.Model.GmbAccountsGmbAccount.t), default: nil) - A list of GMB accounts which are available to the merchant.

Attributes

  • email (type: String.t, default: nil) - The email which identifies the GMB account.
  • listingCount (type: String.t, default: nil) - Number of listings under this account.
  • name (type: String.t, default: nil) - The name of the GMB account.
  • type (type: String.t, default: nil) - The type of the GMB account (User or Business).

A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or location must be set.

Attributes

  • deadlineDate (type: String.t, default: nil) - Date of the order deadline, in ISO 8601 format. E.g. "2016-11-29" for 29th November 2016. Required.
  • deadlineHour (type: integer(), default: nil) - Hour of the day on the deadline date until which the order has to be placed to qualify for the delivery guarantee. Possible values are: 0 (midnight), 1, ..., 12 (noon), 13, ..., 23. Required.
  • deadlineTimezone (type: String.t, default: nil) - Timezone identifier for the deadline hour. A list of identifiers can be found in the AdWords API documentation. E.g. "Europe/Zurich". Required.
  • holidayId (type: String.t, default: nil) - Unique identifier for the holiday. Required.
  • visibleFromDate (type: String.t, default: nil) - Date on which the deadline will become visible to consumers in ISO 8601 format. E.g. "2016-10-31" for 31st October 2016. Required.

Attributes

  • countryCode (type: String.t, default: nil) - The CLDR territory code of the country in which the holiday is available. E.g. "US", "DE", "GB". A holiday cutoff can only be configured in a shipping settings service with matching delivery country. Always present.
  • date (type: String.t, default: nil) - Date of the holiday, in ISO 8601 format. E.g. "2016-12-25" for Christmas 2016. Always present.
  • deliveryGuaranteeDate (type: String.t, default: nil) - Date on which the order has to arrive at the customer's, in ISO 8601 format. E.g. "2016-12-24" for 24th December 2016. Always present.
  • deliveryGuaranteeHour (type: String.t, default: nil) - Hour of the day in the delivery location's timezone on the guaranteed delivery date by which the order has to arrive at the customer's. Possible values are: 0 (midnight), 1, ..., 12 (noon), 13, ..., 23. Always present.
  • id (type: String.t, default: nil) - Unique identifier for the holiday to be used when configuring holiday cutoffs. Always present.
  • type (type: String.t, default: nil) - The holiday type. Always present.

Attributes

  • amount (type: GoogleApi.Content.V21.Model.Price.t, default: nil) - The amount the buyer has to pay per month.
  • months (type: String.t, default: nil) - The number of installments the buyer has to pay.

Attributes

  • additionalChargeSummaries (type: list(GoogleApi.Content.V21.Model.InvoiceSummaryAdditionalChargeSummary.t), default: nil) - Summary of the total amounts of the additional charges.
  • productTotal (type: GoogleApi.Content.V21.Model.Amount.t, default: nil) - [required] Total price for the product.

Attributes

  • totalAmount (type: GoogleApi.Content.V21.Model.Amount.t, default: nil) - [required] Total additional charge for this type.
  • type (type: String.t, default: nil) - [required] Type of the additional charge.

Attributes

  • status (type: String.t, default: nil) - The status of the verification process for the About page.

Attributes

  • about (type: GoogleApi.Content.V21.Model.LiaAboutPageSettings.t, default: nil) - The settings for the About page.
  • country (type: String.t, default: nil) - Required. CLDR country code (e.g. "US").
  • hostedLocalStorefrontActive (type: boolean(), default: nil) - The status of the "Merchant hosted local storefront" feature.
  • inventory (type: GoogleApi.Content.V21.Model.LiaInventorySettings.t, default: nil) - LIA inventory verification settings.
  • onDisplayToOrder (type: GoogleApi.Content.V21.Model.LiaOnDisplayToOrderSettings.t, default: nil) - LIA "On Display To Order" settings.
  • posDataProvider (type: GoogleApi.Content.V21.Model.LiaPosDataProvider.t, default: nil) - The POS data provider linked with this country.
  • storePickupActive (type: boolean(), default: nil) - The status of the "Store pickup" feature.

Attributes

  • inventoryVerificationContactEmail (type: String.t, default: nil) - The email of the contact for the inventory verification process.

Attributes

  • shippingCostPolicyUrl (type: String.t, default: nil) - Shipping cost and policy URL.
  • status (type: String.t, default: nil) - The status of the ?On display to order? feature.

Attributes

  • posDataProviderId (type: String.t, default: nil) - The ID of the POS data provider.
  • posExternalAccountId (type: String.t, default: nil) - The account ID by which this merchant is known to the POS data provider.

Local Inventory ads (LIA) settings. All methods except listposdataproviders require the admin role.

Attributes

  • entries (type: list(GoogleApi.Content.V21.Model.LiasettingsCustomBatchRequestEntry.t), default: nil) - The request entries to be processed in the batch.

Attributes

  • accountId (type: String.t, default: nil) - The ID of the account for which to get/update account shipping settings.

Attributes

  • entries (type: list(GoogleApi.Content.V21.Model.LiasettingsCustomBatchResponseEntry.t), default: nil) - The result of the execution of the batch requests.
  • kind (type: String.t, default: content#liasettingsCustomBatchResponse) - Identifies what kind of resource this is. Value: the fixed string "content#liasettingsCustomBatchResponse".

Attributes

  • batchId (type: integer(), default: nil) - The ID of the request entry to which this entry responds.
  • errors (type: GoogleApi.Content.V21.Model.Errors.t, default: nil) - A list of errors defined if, and only if, the request failed.
  • gmbAccounts (type: GoogleApi.Content.V21.Model.GmbAccounts.t, default: nil) - The the list of accessible GMB accounts.
  • kind (type: String.t, default: content#liasettingsCustomBatchResponseEntry) - Identifies what kind of resource this is. Value: the fixed string "content#liasettingsCustomBatchResponseEntry"
  • liaSettings (type: GoogleApi.Content.V21.Model.LiaSettings.t, default: nil) - The retrieved or updated Lia settings.
  • posDataProviders (type: list(GoogleApi.Content.V21.Model.PosDataProviders.t), default: nil) - The list of POS data providers.

Attributes

  • accountId (type: String.t, default: nil) - The ID of the account.
  • gmbAccounts (type: list(GoogleApi.Content.V21.Model.GmbAccountsGmbAccount.t), default: nil) - A list of GMB accounts which are available to the merchant.
  • kind (type: String.t, default: content#liasettingsGetAccessibleGmbAccountsResponse) - Identifies what kind of resource this is. Value: the fixed string "content#liasettingsGetAccessibleGmbAccountsResponse".

Attributes

  • kind (type: String.t, default: content#liasettingsListPosDataProvidersResponse) - Identifies what kind of resource this is. Value: the fixed string "content#liasettingsListPosDataProvidersResponse".
  • posDataProviders (type: list(GoogleApi.Content.V21.Model.PosDataProviders.t), default: nil) - The list of POS data providers for each eligible country

Attributes

  • kind (type: String.t, default: content#liasettingsListResponse) - Identifies what kind of resource this is. Value: the fixed string "content#liasettingsListResponse".
  • nextPageToken (type: String.t, default: nil) - The token for the retrieval of the next page of LIA settings.
  • resources (type: list(GoogleApi.Content.V21.Model.LiaSettings.t), default: nil) -

Attributes

  • kind (type: String.t, default: content#liasettingsRequestGmbAccessResponse) - Identifies what kind of resource this is. Value: the fixed string "content#liasettingsRequestGmbAccessResponse".

Attributes

  • kind (type: String.t, default: content#liasettingsRequestInventoryVerificationResponse) - Identifies what kind of resource this is. Value: the fixed string "content#liasettingsRequestInventoryVerificationResponse".

Attributes

  • kind (type: String.t, default: content#liasettingsSetInventoryVerificationContactResponse) - Identifies what kind of resource this is. Value: the fixed string "content#liasettingsSetInventoryVerificationContactResponse".

Attributes

  • kind (type: String.t, default: content#liasettingsSetPosDataProviderResponse) - Identifies what kind of resource this is. Value: the fixed string "content#liasettingsSetPosDataProviderResponse".

Attributes

  • service (type: String.t, default: nil) - Service provided to or by the linked account.

Attributes

  • linkedAccountId (type: String.t, default: nil) - The ID of the linked account.
  • services (type: list(GoogleApi.Content.V21.Model.LinkService.t), default: nil) - List of provided services.

Local inventory resource. For accepted attribute values, see the local product inventory feed specification.

Attributes

  • entries (type: list(GoogleApi.Content.V21.Model.LocalinventoryCustomBatchRequestEntry.t), default: nil) - The request entries to be processed in the batch.

Batch entry encoding a single local inventory update request.

Attributes

  • entries (type: list(GoogleApi.Content.V21.Model.LocalinventoryCustomBatchResponseEntry.t), default: nil) - The result of the execution of the batch requests.
  • kind (type: String.t, default: content#localinventoryCustomBatchResponse) - Identifies what kind of resource this is. Value: the fixed string "content#localinventoryCustomBatchResponse".

Batch entry encoding a single local inventory update response.

Attributes

  • locationIds (type: list(String.t), default: nil) - A non-empty list of location IDs. They must all be of the same location type (e.g., state).

Attributes

  • name (type: String.t, default: nil) - Name of loyalty points program. It is recommended to limit the name to 12 full-width characters or 24 Roman characters.
  • pointsValue (type: String.t, default: nil) - The retailer's loyalty points in absolute value.
  • ratio (type: float(), default: nil) - The ratio of a point when converted to currency. Google assumes currency based on Merchant Center settings. If ratio is left out, it defaults to 1.0.

Order return. Production access (all methods) requires the order manager role. Sandbox access does not.

Attributes

  • customerReturnReason (type: GoogleApi.Content.V21.Model.CustomerReturnReason.t, default: nil) - The reason that the customer chooses to return an item.
  • itemId (type: String.t, default: nil) - Product level item ID. If the returned items are of the same product, they will have the same ID.
  • merchantReturnReason (type: GoogleApi.Content.V21.Model.RefundReason.t, default: nil) - The reason that merchant chooses to accept a return item.
  • product (type: GoogleApi.Content.V21.Model.OrderLineItemProduct.t, default: nil) - Product data from the time of the order placement.
  • returnShipmentIds (type: list(String.t), default: nil) - IDs of the return shipments that this return item belongs to.
  • state (type: String.t, default: nil) - State of the item.

Attributes

  • storeCodeSetWithMovs (type: list(GoogleApi.Content.V21.Model.MinimumOrderValueTableStoreCodeSetWithMov.t), default: nil) -

A list of store code sets sharing the same minimum order value. At least two sets are required and the last one must be empty, which signifies 'MOV for all other stores'. Each store code can only appear once across all the sets. All prices within a service must have the same currency.

Order. Production access (all methods) requires the order manager role. Sandbox access does not. (== resource_for v2.orders ==) (== resource_for v2.1.orders ==)

Attributes

  • country (type: String.t, default: nil) - CLDR country code (e.g. "US").
  • fullAddress (type: list(String.t), default: nil) - Strings representing the lines of the printed label for mailing the order, for example: John Smith 1600 Amphitheatre Parkway Mountain View, CA, 94043 United States
  • isPostOfficeBox (type: boolean(), default: nil) - Whether the address is a post office box.
  • locality (type: String.t, default: nil) - City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
  • postalCode (type: String.t, default: nil) - Postal Code or ZIP (e.g. "94043").
  • recipientName (type: String.t, default: nil) - Name of the recipient.
  • region (type: String.t, default: nil) - Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC").
  • streetAddress (type: list(String.t), default: nil) - Street-level part of the address.

Attributes

  • actor (type: String.t, default: nil) - The actor that created the cancellation.

Attributes

  • fullName (type: String.t, default: nil) - Full name of the customer.
  • invoiceReceivingEmail (type: String.t, default: nil) -
  • loyaltyInfo (type: GoogleApi.Content.V21.Model.OrderCustomerLoyaltyInfo.t, default: nil) - Loyalty program information.
  • marketingRightsInfo (type: GoogleApi.Content.V21.Model.OrderCustomerMarketingRightsInfo.t, default: nil) - Customer's marketing preferences. Contains the marketing opt-in information that is current at the time that the merchant call. User preference selections can change from one order to the next so preferences must be checked with every order.

Attributes

  • loyaltyNumber (type: String.t, default: nil) - The loyalty card/membership number.
  • name (type: String.t, default: nil) - Name of card/membership holder, this field will be populated when

Attributes

  • explicitMarketingPreference (type: String.t, default: nil) - Last known customer selection regarding marketing preferences. In certain cases this selection might not be known, so this field would be empty. If a customer selected granted in their most recent order, they can be subscribed to marketing emails. Customers who have chosen denied must not be subscribed, or must be unsubscribed if already opted-in.

Attributes

  • address (type: GoogleApi.Content.V21.Model.OrderAddress.t, default: nil) - The delivery address
  • phoneNumber (type: String.t, default: nil) - The phone number of the person receiving the delivery.

Attributes

  • adjustments (type: list(GoogleApi.Content.V21.Model.OrderLineItemAdjustment.t), default: nil) - Price and tax adjustments applied on the line item.
  • annotations (type: list(GoogleApi.Content.V21.Model.OrderMerchantProvidedAnnotation.t), default: nil) - Annotations that are attached to the line item.
  • cancellations (type: list(GoogleApi.Content.V21.Model.OrderCancellation.t), default: nil) - Cancellations of the line item.
  • id (type: String.t, default: nil) - The ID of the line item.
  • price (type: GoogleApi.Content.V21.Model.Price.t, default: nil) - Total price for the line item. For example, if two items for $10 are purchased, the total price will be $20.
  • product (type: GoogleApi.Content.V21.Model.OrderLineItemProduct.t, default: nil) - Product data as seen by customer from the time of the order placement. Note that certain attributes values (e.g. title or gtin) might be reformatted and no longer match values submitted via product feed.
  • quantityCanceled (type: integer(), default: nil) - Number of items canceled.
  • quantityDelivered (type: integer(), default: nil) - Number of items delivered.
  • quantityOrdered (type: integer(), default: nil) - Number of items ordered.
  • quantityPending (type: integer(), default: nil) - Number of items pending.
  • quantityReadyForPickup (type: integer(), default: nil) - Number of items ready for pickup.
  • quantityReturned (type: integer(), default: nil) - Number of items returned.
  • quantityShipped (type: integer(), default: nil) - Number of items shipped.
  • quantityUndeliverable (type: integer(), default: nil) - Number of items undeliverable.
  • returnInfo (type: GoogleApi.Content.V21.Model.OrderLineItemReturnInfo.t, default: nil) - Details of the return policy for the line item.
  • returns (type: list(GoogleApi.Content.V21.Model.OrderReturn.t), default: nil) - Returns of the line item.
  • shippingDetails (type: GoogleApi.Content.V21.Model.OrderLineItemShippingDetails.t, default: nil) - Details of the requested shipping for the line item.
  • tax (type: GoogleApi.Content.V21.Model.Price.t, default: nil) - Total tax amount for the line item. For example, if two items are purchased, and each have a cost tax of $2, the total tax amount will be $4.

Attributes

  • priceAdjustment (type: GoogleApi.Content.V21.Model.Price.t, default: nil) - Adjustment for total price of the line item.
  • taxAdjustment (type: GoogleApi.Content.V21.Model.Price.t, default: nil) - Adjustment for total tax of the line item.
  • type (type: String.t, default: nil) - Type of this adjustment.

Attributes

  • brand (type: String.t, default: nil) - Brand of the item.

Attributes

  • amount (type: GoogleApi.Content.V21.Model.Price.t, default: nil) - Amount of the fee.
  • name (type: String.t, default: nil) - Name of the fee.

Attributes

  • dimension (type: String.t, default: nil) - The dimension of the variant.
  • value (type: String.t, default: nil) - The value for the dimension.

Attributes

  • daysToReturn (type: integer(), default: nil) - Required. How many days later the item can be returned.
  • isReturnable (type: boolean(), default: nil) - Required. Whether the item is returnable.
  • policyUrl (type: String.t, default: nil) - Required. URL of the item return policy.

Attributes

  • deliverByDate (type: String.t, default: nil) - Required. The delivery by date, in ISO 8601 format.
  • method (type: GoogleApi.Content.V21.Model.OrderLineItemShippingDetailsMethod.t, default: nil) - Required. Details of the shipping method.
  • shipByDate (type: String.t, default: nil) - Required. The ship by date, in ISO 8601 format.
  • type (type: String.t, default: nil) - Type of shipment. Indicates whether deliveryDetails or pickupDetails is applicable for this shipment.

Attributes

  • carrier (type: String.t, default: nil) - The carrier for the shipping. Optional. See shipments[].carrier for a list of acceptable values.
  • maxDaysInTransit (type: integer(), default: nil) - Required. Maximum transit time.
  • methodName (type: String.t, default: nil) - Required. The name of the shipping method.
  • minDaysInTransit (type: integer(), default: nil) - Required. Minimum transit time.

Attributes

  • key (type: String.t, default: nil) - Key for additional merchant provided (as key-value pairs) annotation about the line item.
  • value (type: String.t, default: nil) - Value for additional merchant provided (as key-value pairs) annotation about the line item.

Attributes

  • address (type: GoogleApi.Content.V21.Model.OrderAddress.t, default: nil) - Address of the pickup location where the shipment should be sent. Note that recipientName in the address is the name of the business at the pickup location.
  • collectors (type: list(GoogleApi.Content.V21.Model.OrderPickupDetailsCollector.t), default: nil) - Collectors authorized to pick up shipment from the pickup location.
  • locationId (type: String.t, default: nil) - ID of the pickup location.

Attributes

  • name (type: String.t, default: nil) - Name of the person picking up the shipment.
  • phoneNumber (type: String.t, default: nil) - Phone number of the person picking up the shipment.

Attributes

  • applicableItems (type: list(GoogleApi.Content.V21.Model.OrderPromotionItem.t), default: nil) - Items which this promotion may be applied to. If empty, there are no restrictions on applicable items and quantity.

Attributes

  • lineItemId (type: String.t, default: nil) - The line item ID of a product. Do not provide for orders.createtestorder.
  • offerId (type: String.t, default: nil) - Required. Offer ID of a product. Only for orders.createtestorder.
  • productId (type: String.t, default: nil) - orders.createtestorder.
  • quantity (type: integer(), default: nil) - The quantity of the associated product. Do not provide for orders.createtestorder.

Attributes

  • actor (type: String.t, default: nil) - The actor that created the refund.

Order disbursement. All methods require the payment analyst role. (== resource_for v2.orderreports ==) (== resource_for v2.1.orderreports ==)

Attributes

  • disbursementAmount (type: GoogleApi.Content.V21.Model.Price.t, default: nil) - The disbursement amount.
  • disbursementCreationDate (type: String.t, default: nil) - The date the disbursement was created, in ISO 8601 format.
  • disbursementDate (type: String.t, default: nil) - The date the disbursement was initiated, in ISO 8601 format.
  • disbursementId (type: String.t, default: nil) - The ID of the disbursement.
  • merchantId (type: String.t, default: nil) - The ID of the managing account.
  • merchantOrderId (type: String.t, default: nil) - Merchant-provided ID of the order.
  • orderId (type: String.t, default: nil) - The ID of the order.
  • productAmount (type: GoogleApi.Content.V21.Model.ProductAmount.t, default: nil) - Total amount for the items.
  • transactionDate (type: String.t, default: nil) - The date of the transaction, in ISO 8601 format.

Attributes

  • actor (type: String.t, default: nil) - The actor that created the refund.

Attributes

  • carrier (type: String.t, default: nil) - The carrier handling the shipment.

Attributes

  • lineItemId (type: String.t, default: nil) - The ID of the line item that is shipped. This value is assigned by Google when an order is created. Either lineItemId or productId is required.
  • productId (type: String.t, default: nil) - The ID of the product to ship. This is the REST ID used in the products service. Either lineItemId or productId is required.
  • quantity (type: integer(), default: nil) - The quantity that is shipped.

Attributes

  • invoiceId (type: String.t, default: nil) - [required] The ID of the invoice.
  • invoiceSummary (type: GoogleApi.Content.V21.Model.InvoiceSummary.t, default: nil) - [required] Invoice summary.
  • lineItemInvoices (type: list(GoogleApi.Content.V21.Model.ShipmentInvoiceLineItemInvoice.t), default: nil) - [required] Invoice details per line item.
  • operationId (type: String.t, default: nil) - [required] The ID of the operation, unique across all operations for a given order.
  • shipmentGroupId (type: String.t, default: nil) - [required] ID of the shipment group. It is assigned by the merchant in the shipLineItems method and is used to group multiple line items that have the same kind of shipping charges.

Attributes

  • executionStatus (type: String.t, default: nil) - The status of the execution.

Attributes

  • invoiceId (type: String.t, default: nil) - [required] The ID of the invoice.
  • operationId (type: String.t, default: nil) - [required] The ID of the operation, unique across all operations for a given order.
  • refundOnlyOption (type: GoogleApi.Content.V21.Model.OrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceRefundOption.t, default: nil) - Option to create a refund-only invoice. Exactly one of refundOnlyOption or returnOption must be provided.
  • returnOption (type: GoogleApi.Content.V21.Model.OrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceReturnOption.t, default: nil) - Option to create an invoice for a refund and mark all items within the invoice as returned. Exactly one of refundOnlyOption or returnOption must be provided.
  • shipmentInvoices (type: list(GoogleApi.Content.V21.Model.ShipmentInvoice.t), default: nil) - Invoice details for different shipment groups.

Attributes

  • executionStatus (type: String.t, default: nil) - The status of the execution.

Attributes

  • description (type: String.t, default: nil) - Optional description of the refund reason.
  • reason (type: String.t, default: nil) - [required] Reason for the refund.

Attributes

  • description (type: String.t, default: nil) - Optional description of the return reason.
  • reason (type: String.t, default: nil) - [required] Reason for the return.

Attributes

  • disbursements (type: list(GoogleApi.Content.V21.Model.OrderReportDisbursement.t), default: nil) - The list of disbursements.
  • kind (type: String.t, default: content#orderreportsListDisbursementsResponse) - Identifies what kind of resource this is. Value: the fixed string "content#orderreportsListDisbursementsResponse".
  • nextPageToken (type: String.t, default: nil) - The token for the retrieval of the next page of disbursements.

Attributes

  • kind (type: String.t, default: content#orderreportsListTransactionsResponse) - Identifies what kind of resource this is. Value: the fixed string "content#orderreportsListTransactionsResponse".
  • nextPageToken (type: String.t, default: nil) - The token for the retrieval of the next page of transactions.
  • transactions (type: list(GoogleApi.Content.V21.Model.OrderReportTransaction.t), default: nil) - The list of transactions.

Attributes

  • kind (type: String.t, default: content#orderreturnsListResponse) - Identifies what kind of resource this is. Value: the fixed string "content#orderreturnsListResponse".
  • nextPageToken (type: String.t, default: nil) - The token for the retrieval of the next page of returns.
  • resources (type: list(GoogleApi.Content.V21.Model.MerchantOrderReturn.t), default: nil) -

Attributes

  • operationId (type: String.t, default: nil) - The ID of the operation. Unique across all operations for a given order.

Attributes

  • executionStatus (type: String.t, default: nil) - The status of the execution.

Attributes

  • kind (type: String.t, default: content#ordersAdvanceTestOrderResponse) - Identifies what kind of resource this is. Value: the fixed string "content#ordersAdvanceTestOrderResponse".

Attributes

  • lineItemId (type: String.t, default: nil) - The ID of the line item to cancel. Either lineItemId or productId is required.

Attributes

  • executionStatus (type: String.t, default: nil) - The status of the execution.

Attributes

  • operationId (type: String.t, default: nil) - The ID of the operation. Unique across all operations for a given order.

Attributes

  • executionStatus (type: String.t, default: nil) - The status of the execution.

Attributes

  • reason (type: String.t, default: nil) - The reason for the cancellation.

Attributes

  • kind (type: String.t, default: content#ordersCancelTestOrderByCustomerResponse) - Identifies what kind of resource this is. Value: the fixed string "content#ordersCancelTestOrderByCustomerResponse".

Attributes

  • country (type: String.t, default: nil) - The CLDR territory code of the country of the test order to create. Affects the currency and addresses of orders created via template_name, or the addresses of orders created via test_order.

Attributes

  • kind (type: String.t, default: content#ordersCreateTestOrderResponse) - Identifies what kind of resource this is. Value: the fixed string "content#ordersCreateTestOrderResponse".
  • orderId (type: String.t, default: nil) - The ID of the newly created test order.

Attributes

  • items (type: list(GoogleApi.Content.V21.Model.OrdersCustomBatchRequestEntryCreateTestReturnReturnItem.t), default: nil) - Returned items.

Attributes

  • kind (type: String.t, default: content#ordersCreateTestReturnResponse) - Identifies what kind of resource this is. Value: the fixed string "content#ordersCreateTestReturnResponse".
  • returnId (type: String.t, default: nil) - The ID of the newly created test order return.

Attributes

  • lineItemId (type: String.t, default: nil) - The ID of the line item to return.
  • quantity (type: integer(), default: nil) - Quantity that is returned.

Attributes

  • carrier (type: String.t, default: nil) - The carrier handling the shipment. See shipments[].carrier in the Orders resource representation for a list of acceptable values.
  • shipmentId (type: String.t, default: nil) - Required. The ID of the shipment. This is assigned by the merchant and is unique to each shipment.
  • trackingId (type: String.t, default: nil) - The tracking ID for the shipment.

Attributes

  • kind (type: String.t, default: content#ordersGetByMerchantOrderIdResponse) - Identifies what kind of resource this is. Value: the fixed string "content#ordersGetByMerchantOrderIdResponse".
  • order (type: GoogleApi.Content.V21.Model.Order.t, default: nil) - The requested order.

Attributes

  • kind (type: String.t, default: content#ordersGetTestOrderTemplateResponse) - Identifies what kind of resource this is. Value: the fixed string "content#ordersGetTestOrderTemplateResponse".
  • template (type: GoogleApi.Content.V21.Model.TestOrder.t, default: nil) - The requested test order template.

Attributes

  • lineItemId (type: String.t, default: nil) - The ID of the line item to return. Either lineItemId or productId is required.

Attributes

  • executionStatus (type: String.t, default: nil) - The status of the execution.

Attributes

  • kind (type: String.t, default: content#ordersListResponse) - Identifies what kind of resource this is. Value: the fixed string "content#ordersListResponse".
  • nextPageToken (type: String.t, default: nil) - The token for the retrieval of the next page of orders.
  • resources (type: list(GoogleApi.Content.V21.Model.Order.t), default: nil) -

Attributes

  • lineItemId (type: String.t, default: nil) - The ID of the line item to return. Either lineItemId or productId is required.

Attributes

  • executionStatus (type: String.t, default: nil) - The status of the execution.

Attributes

  • lineItemId (type: String.t, default: nil) - The ID of the line item to return. Either lineItemId or productId is required.

Attributes

  • executionStatus (type: String.t, default: nil) - The status of the execution.

Attributes

  • annotations (type: list(GoogleApi.Content.V21.Model.OrderMerchantProvidedAnnotation.t), default: nil) -
  • lineItemId (type: String.t, default: nil) - The ID of the line item to set metadata. Either lineItemId or productId is required.
  • operationId (type: String.t, default: nil) - The ID of the operation. Unique across all operations for a given order.
  • productId (type: String.t, default: nil) - The ID of the product to set metadata. This is the REST ID used in the products service. Either lineItemId or productId is required.

Attributes

  • executionStatus (type: String.t, default: nil) - The status of the execution.

Attributes

  • lineItems (type: list(GoogleApi.Content.V21.Model.OrderShipmentLineItemShipment.t), default: nil) - Line items to ship.
  • operationId (type: String.t, default: nil) - The ID of the operation. Unique across all operations for a given order.
  • shipmentGroupId (type: String.t, default: nil) - ID of the shipment group. Required for orders that use the orderinvoices service.
  • shipmentInfos (type: list(GoogleApi.Content.V21.Model.OrdersCustomBatchRequestEntryShipLineItemsShipmentInfo.t), default: nil) - Shipment information. This field is repeated because a single line item can be shipped in several packages (and have several tracking IDs).

Attributes

  • executionStatus (type: String.t, default: nil) - The status of the execution.

Attributes

  • deliverByDate (type: String.t, default: nil) - Updated delivery by date, in ISO 8601 format. If not specified only ship by date is updated.

Attributes

  • executionStatus (type: String.t, default: nil) - The status of the execution.

Attributes

  • merchantOrderId (type: String.t, default: nil) - The merchant order id to be assigned to the order. Must be unique per merchant.
  • operationId (type: String.t, default: nil) - The ID of the operation. Unique across all operations for a given order.

Attributes

  • executionStatus (type: String.t, default: nil) - The status of the execution.

Attributes

  • carrier (type: String.t, default: nil) - The carrier handling the shipment. Not updated if missing. See shipments[].carrier in the Orders resource representation for a list of acceptable values.

Attributes

  • executionStatus (type: String.t, default: nil) - The status of the execution.

Attributes

  • carrierName (type: String.t, default: nil) - The name of the pickup carrier (e.g., "UPS"). Required.
  • serviceName (type: String.t, default: nil) - The name of the pickup service (e.g., "Access point"). Required.

Attributes

  • carrierName (type: String.t, default: nil) - The name of the carrier (e.g., "UPS"). Always present.
  • country (type: String.t, default: nil) - The CLDR country code of the carrier (e.g., "US"). Always present.
  • serviceName (type: String.t, default: nil) - The name of the pickup service (e.g., "Access point"). Always present.

Attributes

  • entries (type: list(GoogleApi.Content.V21.Model.PosCustomBatchRequestEntry.t), default: nil) - The request entries to be processed in the batch.

Attributes

  • batchId (type: integer(), default: nil) - An entry ID, unique within the batch request.

Attributes

  • entries (type: list(GoogleApi.Content.V21.Model.PosCustomBatchResponseEntry.t), default: nil) - The result of the execution of the batch requests.
  • kind (type: String.t, default: content#posCustomBatchResponse) - Identifies what kind of resource this is. Value: the fixed string "content#posCustomBatchResponse".

Attributes

  • batchId (type: integer(), default: nil) - The ID of the request entry to which this entry responds.
  • errors (type: GoogleApi.Content.V21.Model.Errors.t, default: nil) - A list of errors defined if, and only if, the request failed.
  • inventory (type: GoogleApi.Content.V21.Model.PosInventory.t, default: nil) - The updated inventory information.
  • kind (type: String.t, default: content#posCustomBatchResponseEntry) - Identifies what kind of resource this is. Value: the fixed string "content#posCustomBatchResponseEntry"
  • sale (type: GoogleApi.Content.V21.Model.PosSale.t, default: nil) - The updated sale information.
  • store (type: GoogleApi.Content.V21.Model.PosStore.t, default: nil) - The retrieved or updated store information.

Attributes

  • country (type: String.t, default: nil) - Country code.
  • posDataProviders (type: list(GoogleApi.Content.V21.Model.PosDataProvidersPosDataProvider.t), default: nil) - A list of POS data providers.

Attributes

  • displayName (type: String.t, default: nil) - The display name of Pos data Provider.
  • fullName (type: String.t, default: nil) - The full name of this POS data Provider.
  • providerId (type: String.t, default: nil) - The ID of the account.

The absolute quantity of an item available at the given store.

Attributes

  • contentLanguage (type: String.t, default: nil) - Required. The two-letter ISO 639-1 language code for the item.
  • gtin (type: String.t, default: nil) - Global Trade Item Number.
  • itemId (type: String.t, default: nil) - Required. A unique identifier for the item.
  • price (type: GoogleApi.Content.V21.Model.Price.t, default: nil) - Required. The current price of the item.
  • quantity (type: String.t, default: nil) - Required. The available quantity of the item.
  • storeCode (type: String.t, default: nil) - Required. The identifier of the merchant's store. Either a storeCode inserted via the API or the code of the store in Google My Business.
  • targetCountry (type: String.t, default: nil) - Required. The CLDR territory code for the item.
  • timestamp (type: String.t, default: nil) - Required. The inventory timestamp, in ISO 8601 format.

Attributes

  • contentLanguage (type: String.t, default: nil) - Required. The two-letter ISO 639-1 language code for the item.
  • gtin (type: String.t, default: nil) - Global Trade Item Number.
  • itemId (type: String.t, default: nil) - Required. A unique identifier for the item.
  • kind (type: String.t, default: content#posInventoryResponse) - Identifies what kind of resource this is. Value: the fixed string "content#posInventoryResponse".
  • price (type: GoogleApi.Content.V21.Model.Price.t, default: nil) - Required. The current price of the item.
  • quantity (type: String.t, default: nil) - Required. The available quantity of the item.
  • storeCode (type: String.t, default: nil) - Required. The identifier of the merchant's store. Either a storeCode inserted via the API or the code of the store in Google My Business.
  • targetCountry (type: String.t, default: nil) - Required. The CLDR territory code for the item.
  • timestamp (type: String.t, default: nil) - Required. The inventory timestamp, in ISO 8601 format.

Attributes

  • kind (type: String.t, default: content#posListResponse) - Identifies what kind of resource this is. Value: the fixed string "content#posListResponse".
  • resources (type: list(GoogleApi.Content.V21.Model.PosStore.t), default: nil) -

The change of the available quantity of an item at the given store.

Attributes

  • contentLanguage (type: String.t, default: nil) - Required. The two-letter ISO 639-1 language code for the item.
  • gtin (type: String.t, default: nil) - Global Trade Item Number.
  • itemId (type: String.t, default: nil) - Required. A unique identifier for the item.
  • price (type: GoogleApi.Content.V21.Model.Price.t, default: nil) - Required. The price of the item.
  • quantity (type: String.t, default: nil) - Required. The relative change of the available quantity. Negative for items returned.
  • saleId (type: String.t, default: nil) - A unique ID to group items from the same sale event.
  • storeCode (type: String.t, default: nil) - Required. The identifier of the merchant's store. Either a storeCode inserted via the API or the code of the store in Google My Business.
  • targetCountry (type: String.t, default: nil) - Required. The CLDR territory code for the item.
  • timestamp (type: String.t, default: nil) - Required. The inventory timestamp, in ISO 8601 format.

Attributes

  • contentLanguage (type: String.t, default: nil) - Required. The two-letter ISO 639-1 language code for the item.
  • gtin (type: String.t, default: nil) - Global Trade Item Number.
  • itemId (type: String.t, default: nil) - Required. A unique identifier for the item.
  • kind (type: String.t, default: content#posSaleResponse) - Identifies what kind of resource this is. Value: the fixed string "content#posSaleResponse".
  • price (type: GoogleApi.Content.V21.Model.Price.t, default: nil) - Required. The price of the item.
  • quantity (type: String.t, default: nil) - Required. The relative change of the available quantity. Negative for items returned.
  • saleId (type: String.t, default: nil) - A unique ID to group items from the same sale event.
  • storeCode (type: String.t, default: nil) - Required. The identifier of the merchant's store. Either a storeCode inserted via the API or the code of the store in Google My Business.
  • targetCountry (type: String.t, default: nil) - Required. The CLDR territory code for the item.
  • timestamp (type: String.t, default: nil) - Required. The inventory timestamp, in ISO 8601 format.

Attributes

  • country (type: String.t, default: nil) - The CLDR territory code of the country the postal code group applies to. Required.
  • name (type: String.t, default: nil) - The name of the postal code group, referred to in headers. Required.
  • postalCodeRanges (type: list(GoogleApi.Content.V21.Model.PostalCodeRange.t), default: nil) - A range of postal codes. Required.

Attributes

  • postalCodeRangeBegin (type: String.t, default: nil) - A postal code or a pattern of the form prefix* denoting the inclusive lower bound of the range defining the area. Examples values: "94108", "9410*", "9*". Required.
  • postalCodeRangeEnd (type: String.t, default: nil) - A postal code or a pattern of the form prefix* denoting the inclusive upper bound of the range defining the area. It must have the same length as postalCodeRangeBegin: if postalCodeRangeBegin is a postal code then postalCodeRangeEnd must be a postal code too; if postalCodeRangeBegin is a pattern then postalCodeRangeEnd must be a pattern with the same prefix length. Optional: if not set, then the area is defined as being all the postal codes matching postalCodeRangeBegin.

Attributes

  • currency (type: String.t, default: nil) - The currency of the price.
  • value (type: String.t, default: nil) - The price represented as a number.

Required product attributes are primarily defined by the products data specification. See the Products Data Specification Help Center article for information.

Attributes

  • priceAmount (type: GoogleApi.Content.V21.Model.Price.t, default: nil) - The pre-tax or post-tax price depending on the location of the order.
  • remittedTaxAmount (type: GoogleApi.Content.V21.Model.Price.t, default: nil) - Remitted tax value.
  • taxAmount (type: GoogleApi.Content.V21.Model.Price.t, default: nil) - Tax value.

Attributes

  • country (type: String.t, default: nil) - The CLDR territory code of the country to which an item will ship.
  • locationGroupName (type: String.t, default: nil) - The location where the shipping is applicable, represented by a location group name.
  • locationId (type: String.t, default: nil) - The numeric ID of a location that the shipping rate applies to as defined in the AdWords API.
  • postalCode (type: String.t, default: nil) - The postal code range that the shipping rate applies to, represented by a postal code, a postal code prefix followed by a * wildcard, a range between two postal codes or two postal code prefixes of equal length.
  • price (type: GoogleApi.Content.V21.Model.Price.t, default: nil) - Fixed shipping price, represented as a number.
  • region (type: String.t, default: nil) - The geographic region to which a shipping rate applies.
  • service (type: String.t, default: nil) - A free-form description of the service class or delivery speed.

Attributes

  • unit (type: String.t, default: nil) - The unit of value.
  • value (type: float(), default: nil) - The dimension of the product used to calculate the shipping cost of the item.

Attributes

  • unit (type: String.t, default: nil) - The unit of value.
  • value (type: float(), default: nil) - The weight of the product used to calculate the shipping cost of the item.

The status of a product, i.e., information about a product computed asynchronously.

Attributes

  • destination (type: String.t, default: nil) - The name of the destination
  • status (type: String.t, default: nil) -

Attributes

  • attributeName (type: String.t, default: nil) - The attribute's name, if the issue is caused by a single attribute.
  • code (type: String.t, default: nil) - The error code of the issue.
  • description (type: String.t, default: nil) - A short issue description in English.
  • destination (type: String.t, default: nil) - The destination the issue applies to.
  • detail (type: String.t, default: nil) - A detailed issue description in English.
  • documentation (type: String.t, default: nil) - The URL of a web page to help with resolving this issue.
  • resolution (type: String.t, default: nil) - Whether the issue can be resolved by the merchant.
  • servability (type: String.t, default: nil) - How this issue affects serving of the offer.

Attributes

  • country (type: String.t, default: nil) - The country within which the item is taxed, specified as a CLDR territory code.
  • locationId (type: String.t, default: nil) - The numeric ID of a location that the tax rate applies to as defined in the AdWords API.
  • postalCode (type: String.t, default: nil) - The postal code range that the tax rate applies to, represented by a ZIP code, a ZIP code prefix using wildcard, a range between two ZIP codes or two ZIP code prefixes of equal length. Examples: 94114, 94, 94002-95460, 94-95.
  • rate (type: float(), default: nil) - The percentage of tax rate that applies to the item price.
  • region (type: String.t, default: nil) - The geographic region to which the tax rate applies.
  • taxShip (type: boolean(), default: nil) - Set to true if tax is charged on shipping.

Attributes

  • unit (type: String.t, default: nil) - The unit of the denominator.
  • value (type: String.t, default: nil) - The denominator of the unit price.

Attributes

  • unit (type: String.t, default: nil) - The unit of the measure.
  • value (type: float(), default: nil) - The measure of an item.

Attributes

  • entries (type: list(GoogleApi.Content.V21.Model.ProductsCustomBatchRequestEntry.t), default: nil) - The request entries to be processed in the batch.

A batch entry encoding a single non-batch products request.

Attributes

  • entries (type: list(GoogleApi.Content.V21.Model.ProductsCustomBatchResponseEntry.t), default: nil) - The result of the execution of the batch requests.
  • kind (type: String.t, default: content#productsCustomBatchResponse) - Identifies what kind of resource this is. Value: the fixed string "content#productsCustomBatchResponse".

A batch entry encoding a single non-batch products response.

Attributes

  • kind (type: String.t, default: content#productsListResponse) - Identifies what kind of resource this is. Value: the fixed string "content#productsListResponse".
  • nextPageToken (type: String.t, default: nil) - The token for the retrieval of the next page of products.
  • resources (type: list(GoogleApi.Content.V21.Model.Product.t), default: nil) -

Attributes

  • entries (type: list(GoogleApi.Content.V21.Model.ProductstatusesCustomBatchRequestEntry.t), default: nil) - The request entries to be processed in the batch.

A batch entry encoding a single non-batch productstatuses request.

Attributes

  • entries (type: list(GoogleApi.Content.V21.Model.ProductstatusesCustomBatchResponseEntry.t), default: nil) - The result of the execution of the batch requests.
  • kind (type: String.t, default: content#productstatusesCustomBatchResponse) - Identifies what kind of resource this is. Value: the fixed string "content#productstatusesCustomBatchResponse".

A batch entry encoding a single non-batch productstatuses response.

Attributes

  • kind (type: String.t, default: content#productstatusesListResponse) - Identifies what kind of resource this is. Value: the fixed string "content#productstatusesListResponse".
  • nextPageToken (type: String.t, default: nil) - The token for the retrieval of the next page of products statuses.
  • resources (type: list(GoogleApi.Content.V21.Model.ProductStatus.t), default: nil) -

Settings for Pub/Sub notifications, all methods require that the caller is a direct user of the merchant center account. (== resource_for v2.1.pubsubnotificationsettings ==)

Attributes

  • applicableShippingLabels (type: list(String.t), default: nil) - A list of shipping labels defining the products to which this rate group applies to. This is a disjunction: only one of the labels has to match for the rate group to apply. May only be empty for the last rate group of a service. Required.
  • carrierRates (type: list(GoogleApi.Content.V21.Model.CarrierRate.t), default: nil) - A list of carrier rates that can be referred to by mainTable or singleValue.
  • mainTable (type: GoogleApi.Content.V21.Model.Table.t, default: nil) - A table defining the rate group, when singleValue is not expressive enough. Can only be set if singleValue is not set.
  • name (type: String.t, default: nil) - Name of the rate group. Optional. If set has to be unique within shipping service.
  • singleValue (type: GoogleApi.Content.V21.Model.Value.t, default: nil) - The value of the rate group (e.g. flat rate $10). Can only be set if mainTable and subtables are not set.
  • subtables (type: list(GoogleApi.Content.V21.Model.Table.t), default: nil) - A list of subtables referred to by mainTable. Can only be set if mainTable is set.

Attributes

  • description (type: String.t, default: nil) - Description of the reason.
  • reasonCode (type: String.t, default: nil) - Code of the refund reason.

Regional inventory resource. contains the regional name and all attributes which are overridden for the specified region.

Attributes

  • entries (type: list(GoogleApi.Content.V21.Model.RegionalinventoryCustomBatchRequestEntry.t), default: nil) - The request entries to be processed in the batch.

A batch entry encoding a single non-batch regional inventory request.

Attributes

  • entries (type: list(GoogleApi.Content.V21.Model.RegionalinventoryCustomBatchResponseEntry.t), default: nil) - The result of the execution of the batch requests.
  • kind (type: String.t, default: content#regionalinventoryCustomBatchResponse) - Identifies what kind of resource this is. Value: the fixed string "content#regionalinventoryCustomBatchResponse".

A batch entry encoding a single non-batch regional inventory response.

Attributes

  • country (type: String.t, default: nil) - CLDR country code (e.g. "US").
  • locality (type: String.t, default: nil) - City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
  • postalCode (type: String.t, default: nil) - Postal code or ZIP (e.g. "94043").
  • recipientName (type: String.t, default: nil) - Name of the recipient to address returns to.
  • region (type: String.t, default: nil) - Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC").
  • streetAddress (type: list(String.t), default: nil) - Street-level part of the address. May be up to two lines, each line specified as an array element.

Attributes

  • lastReturnDate (type: String.t, default: nil) - Required. Last day for returning the items. In ISO 8601 format. When specifying the return window like this, set the policy type to "lastReturnDate". Use this for seasonal overrides only.
  • numberOfDays (type: String.t, default: nil) - The number of days items can be returned after delivery, where one day is defined to be 24 hours after the delivery timestamp. When specifying the return window like this, set the policy type to "numberOfDaysAfterDelivery". Acceptable values are 30, 45, 60, 90, 100, 180, 270 and 365 for the default policy. Additional policies further allow 14, 15, 21 and 28 days, but note that for most items a minimum of 30 days is required for returns. Exceptions may be made for electronics. A policy of less than 30 days can only be applied to those items.
  • type (type: String.t, default: nil) - Policy type. Use "lastReturnDate" for seasonal overrides only. Note that for most items a minimum of 30 days is required for returns. Exceptions may be made for electronics or non-returnable items such as food, perishables, and living things. A policy of less than 30 days can only be applied to those items.

Attributes

  • endDate (type: String.t, default: nil) - Required. Last day on which the override applies. In ISO 8601 format.
  • name (type: String.t, default: nil) - Required. The name of the seasonal override as shown in Merchant Center.
  • policy (type: GoogleApi.Content.V21.Model.ReturnPolicyPolicy.t, default: nil) - Required. The policy which is in effect during that time.
  • startDate (type: String.t, default: nil) - Required. First day on which the override applies. In ISO 8601 format.

Attributes

  • creationDate (type: String.t, default: nil) - The date of creation of the shipment, in ISO 8601 format.

Attributes

  • entries (type: list(GoogleApi.Content.V21.Model.ReturnaddressCustomBatchRequestEntry.t), default: nil) - The request entries to be processed in the batch.

Attributes

  • batchId (type: integer(), default: nil) - An entry ID, unique within the batch request.

Attributes

  • entries (type: list(GoogleApi.Content.V21.Model.ReturnaddressCustomBatchResponseEntry.t), default: nil) - The result of the execution of the batch requests.
  • kind (type: String.t, default: content#returnaddressCustomBatchResponse) - Identifies what kind of resource this is. Value: the fixed string "content#returnaddressCustomBatchResponse".

Attributes

  • batchId (type: integer(), default: nil) - The ID of the request entry to which this entry responds.
  • errors (type: GoogleApi.Content.V21.Model.Errors.t, default: nil) - A list of errors defined if, and only if, the request failed.
  • kind (type: String.t, default: content#returnaddressCustomBatchResponseEntry) - Identifies what kind of resource this is. Value: the fixed string "content#returnaddressCustomBatchResponseEntry"
  • returnAddress (type: GoogleApi.Content.V21.Model.ReturnAddress.t, default: nil) - The retrieved return address.

Attributes

  • kind (type: String.t, default: content#returnaddressListResponse) - Identifies what kind of resource this is. Value: the fixed string "content#returnaddressListResponse".
  • nextPageToken (type: String.t, default: nil) - The token for the retrieval of the next page of addresses.
  • resources (type: list(GoogleApi.Content.V21.Model.ReturnAddress.t), default: nil) -

Attributes

  • entries (type: list(GoogleApi.Content.V21.Model.ReturnpolicyCustomBatchRequestEntry.t), default: nil) - The request entries to be processed in the batch.

Attributes

  • batchId (type: integer(), default: nil) - An entry ID, unique within the batch request.

Attributes

  • entries (type: list(GoogleApi.Content.V21.Model.ReturnpolicyCustomBatchResponseEntry.t), default: nil) - The result of the execution of the batch requests.
  • kind (type: String.t, default: content#returnpolicyCustomBatchResponse) - Identifies what kind of resource this is. Value: the fixed string "content#returnpolicyCustomBatchResponse".

Attributes

  • batchId (type: integer(), default: nil) - The ID of the request entry to which this entry responds.
  • errors (type: GoogleApi.Content.V21.Model.Errors.t, default: nil) - A list of errors defined if, and only if, the request failed.
  • kind (type: String.t, default: content#returnpolicyCustomBatchResponseEntry) - Identifies what kind of resource this is. Value: the fixed string "content#returnpolicyCustomBatchResponseEntry"
  • returnPolicy (type: GoogleApi.Content.V21.Model.ReturnPolicy.t, default: nil) - The retrieved return policy.

Attributes

  • kind (type: String.t, default: content#returnpolicyListResponse) - Identifies what kind of resource this is. Value: the fixed string "content#returnpolicyListResponse".
  • resources (type: list(GoogleApi.Content.V21.Model.ReturnPolicy.t), default: nil) -

Attributes

  • cells (type: list(GoogleApi.Content.V21.Model.Value.t), default: nil) - The list of cells that constitute the row. Must have the same length as columnHeaders for two-dimensional tables, a length of 1 for one-dimensional tables. Required.

Attributes

  • active (type: boolean(), default: nil) - A boolean exposing the active status of the shipping service. Required.

Settlement reports detail order-level and item-level credits and debits between you and Google.

Settlement transactions give a detailed breakdown of the settlement report. (== resource_for v2.1.settlementtransactions ==)

Attributes

  • commission (type: GoogleApi.Content.V21.Model.SettlementTransactionAmountCommission.t, default: nil) -

Attributes

  • category (type: String.t, default: nil) - The category of the commission.

Attributes

  • adjustmentId (type: String.t, default: nil) - The identifier of the adjustments, if it is available.
  • merchantOrderId (type: String.t, default: nil) - The merchant provided order ID.
  • settlementEntryId (type: String.t, default: nil) - The unique ID of the settlement transaction entry.
  • shipmentIds (type: list(String.t), default: nil) - The shipment ids for the item.
  • transactionId (type: String.t, default: nil) - The Google transaction ID.

Attributes

  • postDate (type: String.t, default: nil) - The time on which the event occurred in ISO 8601 format.
  • type (type: String.t, default: nil) - The type of the transaction that occurred.

Attributes

  • kind (type: String.t, default: content#settlementreportsListResponse) - Identifies what kind of resource this is. Value: the fixed string "content#settlementreportsListResponse".
  • nextPageToken (type: String.t, default: nil) - The token for the retrieval of the next page of returns.
  • resources (type: list(GoogleApi.Content.V21.Model.SettlementReport.t), default: nil) -

Attributes

  • kind (type: String.t, default: content#settlementtransactionsListResponse) - Identifies what kind of resource this is. Value: the fixed string "content#settlementtransactionsListResponse".
  • nextPageToken (type: String.t, default: nil) - The token for the retrieval of the next page of returns.
  • resources (type: list(GoogleApi.Content.V21.Model.SettlementTransaction.t), default: nil) -

Attributes

  • invoiceSummary (type: GoogleApi.Content.V21.Model.InvoiceSummary.t, default: nil) - [required] Invoice summary.
  • lineItemInvoices (type: list(GoogleApi.Content.V21.Model.ShipmentInvoiceLineItemInvoice.t), default: nil) - [required] Invoice details per line item.
  • shipmentGroupId (type: String.t, default: nil) - [required] ID of the shipment group. It is assigned by the merchant in the shipLineItems method and is used to group multiple line items that have the same kind of shipping charges.

Attributes

  • lineItemId (type: String.t, default: nil) - ID of the line item. Either lineItemId or productId must be set.
  • productId (type: String.t, default: nil) - ID of the product. This is the REST ID used in the products service. Either lineItemId or productId must be set.
  • shipmentUnitIds (type: list(String.t), default: nil) - [required] The shipment unit ID is assigned by the merchant and defines individual quantities within a line item. The same ID can be assigned to units that are the same while units that differ must be assigned a different ID (for example: free or promotional units).
  • unitInvoice (type: GoogleApi.Content.V21.Model.UnitInvoice.t, default: nil) - [required] Invoice details for a single unit.

Attributes

  • carrier (type: String.t, default: nil) - The shipping carrier that handles the package.

The merchant account's shipping settings. All methods except getsupportedcarriers and getsupportedholidays require the admin role.

Attributes

  • entries (type: list(GoogleApi.Content.V21.Model.ShippingsettingsCustomBatchRequestEntry.t), default: nil) - The request entries to be processed in the batch.

A batch entry encoding a single non-batch shippingsettings request.

Attributes

  • entries (type: list(GoogleApi.Content.V21.Model.ShippingsettingsCustomBatchResponseEntry.t), default: nil) - The result of the execution of the batch requests.
  • kind (type: String.t, default: content#shippingsettingsCustomBatchResponse) - Identifies what kind of resource this is. Value: the fixed string "content#shippingsettingsCustomBatchResponse".

A batch entry encoding a single non-batch shipping settings response.

Attributes

  • carriers (type: list(GoogleApi.Content.V21.Model.CarriersCarrier.t), default: nil) - A list of supported carriers. May be empty.
  • kind (type: String.t, default: content#shippingsettingsGetSupportedCarriersResponse) - Identifies what kind of resource this is. Value: the fixed string "content#shippingsettingsGetSupportedCarriersResponse".

Attributes

  • holidays (type: list(GoogleApi.Content.V21.Model.HolidaysHoliday.t), default: nil) - A list of holidays applicable for delivery guarantees. May be empty.
  • kind (type: String.t, default: content#shippingsettingsGetSupportedHolidaysResponse) - Identifies what kind of resource this is. Value: the fixed string "content#shippingsettingsGetSupportedHolidaysResponse".

Attributes

  • kind (type: String.t, default: content#shippingsettingsGetSupportedPickupServicesResponse) - Identifies what kind of resource this is. Value: the fixed string "content#shippingsettingsGetSupportedPickupServicesResponse".
  • pickupServices (type: list(GoogleApi.Content.V21.Model.PickupServicesPickupService.t), default: nil) - A list of supported pickup services. May be empty.

Attributes

  • kind (type: String.t, default: content#shippingsettingsListResponse) - Identifies what kind of resource this is. Value: the fixed string "content#shippingsettingsListResponse".
  • nextPageToken (type: String.t, default: nil) - The token for the retrieval of the next page of shipping settings.
  • resources (type: list(GoogleApi.Content.V21.Model.ShippingSettings.t), default: nil) -

Attributes

  • columnHeaders (type: GoogleApi.Content.V21.Model.Headers.t, default: nil) - Headers of the table's columns. Optional: if not set then the table has only one dimension.
  • name (type: String.t, default: nil) - Name of the table. Required for subtables, ignored for the main table.
  • rowHeaders (type: GoogleApi.Content.V21.Model.Headers.t, default: nil) - Headers of the table's rows. Required.
  • rows (type: list(GoogleApi.Content.V21.Model.Row.t), default: nil) - The list of rows that constitute the table. Must have the same length as rowHeaders. Required.

Attributes

  • enableOrderinvoices (type: boolean(), default: nil) - Whether the orderinvoices service should support this order.

Attributes

  • product (type: GoogleApi.Content.V21.Model.TestOrderLineItemProduct.t, default: nil) - Required. Product data from the time of the order placement.
  • quantityOrdered (type: integer(), default: nil) - Required. Number of items ordered.
  • returnInfo (type: GoogleApi.Content.V21.Model.OrderLineItemReturnInfo.t, default: nil) - Required. Details of the return policy for the line item.
  • shippingDetails (type: GoogleApi.Content.V21.Model.OrderLineItemShippingDetails.t, default: nil) - Required. Details of the requested shipping for the line item.

Attributes

  • brand (type: String.t, default: nil) - Required. Brand of the item.

Attributes

  • postalCodeGroupNames (type: list(String.t), default: nil) - A list of postal group names. The last value can be "all other locations". Example: ["zone 1", "zone 2", "all other locations"]. The referred postal code groups must match the delivery country of the service.
  • rows (type: list(GoogleApi.Content.V21.Model.TransitTableTransitTimeRow.t), default: nil) -
  • transitTimeLabels (type: list(String.t), default: nil) - A list of transit time labels. The last value can be "all other labels". Example: ["food", "electronics", "all other labels"].

Attributes

  • values (type: list(GoogleApi.Content.V21.Model.TransitTableTransitTimeRowTransitTimeValue.t), default: nil) -

Attributes

  • maxTransitTimeInDays (type: integer(), default: nil) - Must be greater than or equal to minTransitTimeInDays.
  • minTransitTimeInDays (type: integer(), default: nil) - Transit time range (min-max) in business days. 0 means same day delivery, 1 means next day delivery.

Attributes

  • additionalCharges (type: list(GoogleApi.Content.V21.Model.UnitInvoiceAdditionalCharge.t), default: nil) - Additional charges for a unit, e.g. shipping costs.
  • unitPrice (type: GoogleApi.Content.V21.Model.Price.t, default: nil) - [required] Pre-tax or post-tax price of the unit depending on the locality of the order.
  • unitPriceTaxes (type: list(GoogleApi.Content.V21.Model.UnitInvoiceTaxLine.t), default: nil) - Tax amounts to apply to the unit price.

Attributes

  • additionalChargeAmount (type: GoogleApi.Content.V21.Model.Amount.t, default: nil) - [required] Amount of the additional charge.
  • type (type: String.t, default: nil) - [required] Type of the additional charge.

Attributes

  • taxAmount (type: GoogleApi.Content.V21.Model.Price.t, default: nil) - [required] Tax amount for the tax type.
  • taxName (type: String.t, default: nil) - Optional name of the tax type. This should only be provided if taxType is otherFeeTax.
  • taxType (type: String.t, default: nil) - [required] Type of the tax.

The single value of a rate group or the value of a rate group table's cell. Exactly one of noShipping, flatRate, pricePercentage, carrierRateName, subtableName must be set.

Attributes

  • unit (type: String.t, default: nil) - Required. The weight unit.