API Reference google_api_content v0.52.0

Modules

API client metadata for GoogleApi.Content.V2.

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"). This value cannot be set for a sub-account of an MCA. All MCA sub-accounts inherit the country of their parent MCA.
  • 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. Acceptable values are: - "active" - "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. Acceptable values are: - "active" - "pending"

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.
  • destination (type: String.t, default: nil) - The destination the issue applies to. If this field is empty then the issue applies to all available destinations.
  • detail (type: String.t, default: nil) - Additional details about the issue.
  • documentation (type: String.t, default: nil) - The URL of a web page to help resolving this issue.
  • id (type: String.t, default: nil) - Issue identifier.
  • severity (type: String.t, default: nil) - Severity of the issue. Acceptable values are: - "critical" - "error" - "suggestion"
  • title (type: String.t, default: nil) - Short description of the issue.

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: - "critical" - "error" - "suggestion"
  • submittedValue (type: String.t, default: nil) -

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. Acceptable values are: - "local" - "online"
  • country (type: String.t, default: nil) - The country the data applies to.
  • destination (type: String.t, default: nil) - The destination the data applies to.
  • itemLevelIssues (type: list(GoogleApi.Content.V2.Model.AccountStatusItemLevelIssue.t), default: nil) - List of item-level issues.
  • statistics (type: GoogleApi.Content.V2.Model.AccountStatusStatistics.t, default: nil) - Aggregated product statistics.

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. - For an individual account: only the merchant ID is defined - For an aggregator: only the aggregator ID is defined - For a subaccount of an MCA: both the merchant ID and the aggregator ID are defined.
  • kind (type: String.t, default: nil) - Identifies what kind of resource this is. Value: the fixed string "content#accountsAuthInfoResponse".

Attributes

  • kind (type: String.t, default: nil) - 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. Acceptable values are: - "approve" - "remove" - "request"
  • linkType (type: String.t, default: nil) - Type of the link between the two accounts. Acceptable values are: - "channelPartner" - "eCommercePlatform"
  • linkedAccountId (type: String.t, default: nil) - The ID of the linked account.

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: nil) - 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. Acceptable values are: - "approve" - "remove" - "request"
  • linkType (type: String.t, default: nil) - Type of the link between the two accounts. Acceptable values are: - "channelPartner" - "eCommercePlatform"
  • linkedAccountId (type: String.t, default: nil) - The ID of the linked account.

Attributes

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

Attributes

  • kind (type: String.t, default: nil) - 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: nil) - 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: nil) - 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: nil) - 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: nil) - 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.
  • type (type: String.t, default: nil) - The type of the attribute. Acceptable values are: - "boolean" - "datetimerange" - "float" - "group" - "int" - "price" - "text" - "time" - "url"
  • unit (type: String.t, default: nil) - Free-form unit of the attribute. Unit can only be used for values of type int, float, or price.
  • value (type: String.t, default: nil) - The value of the attribute.

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. Acceptable values are: - "betterPriceFound" - "changedMind" - "damagedOrDefectiveItem" - "didNotMatchDescription" - "doesNotFit" - "expiredItem" - "incorrectItemReceived" - "noLongerNeeded" - "notSpecified" - "orderedWrongItem" - "other" - "qualityNotExpected" - "receivedTooLate" - "undeliverable"

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. Acceptable values are: - "pipe" - "tab" - "tilde"
  • fileEncoding (type: String.t, default: nil) - Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected. Acceptable values are: - "latin-1" - "utf-16be" - "utf-16le" - "utf-8" - "windows-1252"
  • quotingMode (type: String.t, default: nil) - Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds. Acceptable values are: - "normal character" - "value quoting"

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.
  • excludedDestinations (type: list(String.t), default: nil) - The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center).
  • includedDestinations (type: list(String.t), default: nil) - The list of destinations to include for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in excludedDestinations. List of supported destinations (if available to the account): - DisplayAds - Shopping - ShoppingActions - SurfacesAcrossGoogle
  • language (type: String.t, default: nil) - The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for targets[].country.

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: nil) - 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: nil) - Identifies what kind of resource this is. Value: the fixed string "content#datafeedsFetchNowResponse".

Attributes

  • kind (type: String.t, default: nil) - 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: nil) - 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: nil) - 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 Merchant Center 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. Acceptable values are: - "Christmas" - "Easter" - "Father's Day" - "Halloween" - "Independence Day (USA)" - "Mother's Day" - "Thanksgiving" - "Valentine's Day"

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.

Attributes

  • availability (type: String.t, default: nil) - The availability of the product. Acceptable values are: - "in stock" - "out of stock" - "preorder"
  • customLabel0 (type: String.t, default: nil) - Custom label 0 for custom grouping of items in a Shopping campaign. Only supported for online products.
  • customLabel1 (type: String.t, default: nil) - Custom label 1 for custom grouping of items in a Shopping campaign. Only supported for online products.
  • customLabel2 (type: String.t, default: nil) - Custom label 2 for custom grouping of items in a Shopping campaign. Only supported for online products.
  • customLabel3 (type: String.t, default: nil) - Custom label 3 for custom grouping of items in a Shopping campaign. Only supported for online products.
  • customLabel4 (type: String.t, default: nil) - Custom label 3 for custom grouping of items in a Shopping campaign. Only supported for online products.
  • installment (type: GoogleApi.Content.V2.Model.Installment.t, default: nil) - Number and amount of installments to pay for an item. Brazil only.
  • instoreProductLocation (type: String.t, default: nil) - The instore product location. Supported only for local products.
  • kind (type: String.t, default: nil) - Identifies what kind of resource this is. Value: the fixed string "content#inventory"
  • loyaltyPoints (type: GoogleApi.Content.V2.Model.LoyaltyPoints.t, default: nil) - Loyalty points that users receive after purchasing the item. Japan only.
  • pickup (type: GoogleApi.Content.V2.Model.InventoryPickup.t, default: nil) - Store pickup information. Only supported for local inventory. Not setting pickup means "don't update" while setting it to the empty value ({} in JSON) means "delete". Otherwise, pickupMethod and pickupSla must be set together, unless pickupMethod is "not supported".
  • price (type: GoogleApi.Content.V2.Model.Price.t, default: nil) - The price of the product.
  • quantity (type: integer(), default: nil) - The quantity of the product. Must be equal to or greater than zero. Supported only for local products.
  • salePrice (type: GoogleApi.Content.V2.Model.Price.t, default: nil) - The sale price of the product. Mandatory if sale_price_effective_date is defined.
  • salePriceEffectiveDate (type: String.t, default: nil) - A date range represented by a pair of ISO 8601 dates separated by a space, comma, or slash. Both dates might be specified as 'null' if undecided.
  • sellOnGoogleQuantity (type: integer(), default: nil) - The quantity of the product that is available for selling on Google. Supported only for online products.

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: nil) - 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. Acceptable values are: - "buy" - "not supported" - "reserve" - "ship to store"
  • pickupSla (type: String.t, default: nil) - The expected date that an order will be ready for pickup, relative to when the order is placed. Only supported for local inventory. Must be submitted together with pickupMethod. Acceptable values are: - "five day" - "four day" - "multi day" - "multi week" - "next day" - "same day" - "seven day" - "six day" - "three day" - "two day"

Attributes

  • availability (type: String.t, default: nil) - The availability of the product. Acceptable values are: - "in stock" - "out of stock" - "preorder"
  • customLabel0 (type: String.t, default: nil) - Custom label 0 for custom grouping of items in a Shopping campaign. Only supported for online products.
  • customLabel1 (type: String.t, default: nil) - Custom label 1 for custom grouping of items in a Shopping campaign. Only supported for online products.
  • customLabel2 (type: String.t, default: nil) - Custom label 2 for custom grouping of items in a Shopping campaign. Only supported for online products.
  • customLabel3 (type: String.t, default: nil) - Custom label 3 for custom grouping of items in a Shopping campaign. Only supported for online products.
  • customLabel4 (type: String.t, default: nil) - Custom label 3 for custom grouping of items in a Shopping campaign. Only supported for online products.
  • installment (type: GoogleApi.Content.V2.Model.Installment.t, default: nil) - Number and amount of installments to pay for an item. Brazil only.
  • instoreProductLocation (type: String.t, default: nil) - The instore product location. Supported only for local products.
  • loyaltyPoints (type: GoogleApi.Content.V2.Model.LoyaltyPoints.t, default: nil) - Loyalty points that users receive after purchasing the item. Japan only.
  • pickup (type: GoogleApi.Content.V2.Model.InventoryPickup.t, default: nil) - Store pickup information. Only supported for local inventory. Not setting pickup means "don't update" while setting it to the empty value ({} in JSON) means "delete". Otherwise, pickupMethod and pickupSla must be set together, unless pickupMethod is "not supported".
  • price (type: GoogleApi.Content.V2.Model.Price.t, default: nil) - The price of the product.
  • quantity (type: integer(), default: nil) - The quantity of the product. Must be equal to or greater than zero. Supported only for local products.
  • salePrice (type: GoogleApi.Content.V2.Model.Price.t, default: nil) - The sale price of the product. Mandatory if sale_price_effective_date is defined.
  • salePriceEffectiveDate (type: String.t, default: nil) - A date range represented by a pair of ISO 8601 dates separated by a space, comma, or slash. Both dates might be specified as 'null' if undecided.
  • sellOnGoogleQuantity (type: integer(), default: nil) - The quantity of the product that is available for selling on Google. Supported only for online products.

Attributes

  • kind (type: String.t, default: nil) - 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. Acceptable values are: - "shipping"

Attributes

  • status (type: String.t, default: nil) - The status of the verification process for the About page. Acceptable values are: - "active" - "inactive" - "pending"
  • url (type: String.t, default: nil) - The URL 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.
  • inventoryVerificationContactName (type: String.t, default: nil) - The name of the contact for the inventory verification process.
  • inventoryVerificationContactStatus (type: String.t, default: nil) - The status of the verification contact. Acceptable values are: - "active" - "inactive" - "pending"
  • status (type: String.t, default: nil) - The status of the inventory verification process. Acceptable values are: - "active" - "inactive" - "pending"

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. Acceptable values are: - "active" - "inactive" - "pending"

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 LIA settings.
  • batchId (type: integer(), default: nil) - An entry ID, unique within the batch request.
  • contactEmail (type: String.t, default: nil) - Inventory validation contact email. Required only for SetInventoryValidationContact.
  • contactName (type: String.t, default: nil) - Inventory validation contact name. Required only for SetInventoryValidationContact.
  • country (type: String.t, default: nil) - The country code. Required only for RequestInventoryVerification.
  • gmbEmail (type: String.t, default: nil) - The GMB account. Required only for RequestGmbAccess.
  • liaSettings (type: GoogleApi.Content.V2.Model.LiaSettings.t, default: nil) - The account Lia settings to update. Only defined if the method is update.
  • merchantId (type: String.t, default: nil) - The ID of the managing account.
  • method (type: String.t, default: nil) - The method of the batch entry. Acceptable values are: - "get" - "getAccessibleGmbAccounts" - "requestGmbAccess" - "requestInventoryVerification" - "setInventoryVerificationContact" - "update"
  • posDataProviderId (type: String.t, default: nil) - The ID of POS data provider. Required only for SetPosProvider.
  • posExternalAccountId (type: String.t, default: nil) - The account ID by which this merchant is known to the POS provider.

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: nil) - 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 list of accessible GMB accounts.
  • kind (type: String.t, default: nil) - 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 Merchant Center 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: nil) - Identifies what kind of resource this is. Value: the fixed string "content#liasettingsGetAccessibleGmbAccountsResponse".

Attributes

  • kind (type: String.t, default: nil) - 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: nil) - 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: nil) - Identifies what kind of resource this is. Value: the fixed string "content#liasettingsRequestGmbAccessResponse".

Attributes

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

Attributes

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

Attributes

  • kind (type: String.t, default: nil) - 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. Acceptable values are: - "canceled" - "new" - "received" - "refunded" - "rejected"

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.

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. Acceptable values are: - "customer" - "googleBot" - "googleCustomerService" - "googlePayments" - "googleSabre" - "merchant"
  • creationDate (type: String.t, default: nil) - Date on which the cancellation has been created, in ISO 8601 format.
  • quantity (type: integer(), default: nil) - The quantity that was canceled.
  • reason (type: String.t, default: nil) - The reason for the cancellation. Orders that are canceled with a noInventory reason will lead to the removal of the product from Buy on Google until you make an update to that product. This will not affect your Shopping ads. Acceptable values are: - "autoPostInternal" - "autoPostInvalidBillingAddress" - "autoPostNoInventory" - "autoPostPriceError" - "autoPostUndeliverableShippingAddress" - "couponAbuse" - "customerCanceled" - "customerInitiatedCancel" - "customerSupportRequested" - "failToPushOrderGoogleError" - "failToPushOrderMerchantError" - "failToPushOrderMerchantFulfillmentError" - "failToPushOrderToMerchant" - "failToPushOrderToMerchantOutOfStock" - "invalidCoupon" - "malformedShippingAddress" - "merchantDidNotShipOnTime" - "noInventory" - "orderTimeout" - "other" - "paymentAbuse" - "paymentDeclined" - "priceError" - "returnRefundAbuse" - "shippingPriceError" - "taxError" - "undeliverableShippingAddress" - "unsupportedPoBoxAddress"
  • reasonText (type: String.t, default: nil) - The explanation of the reason.

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) - Email address for the merchant to send value-added tax or invoice documentation of the order. Only the last document sent is made available to the customer. For more information, see About automated VAT invoicing for Buy on Google.
  • 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. Acceptable values are: - "denied" - "granted"
  • lastUpdatedTimestamp (type: String.t, default: nil) - Timestamp when last time marketing preference was updated. Could be empty, if user wasn't offered a selection yet.
  • marketingEmailAddress (type: String.t, default: nil) - Email address that can be used for marketing purposes. The field may be empty even if explicitMarketingPreference is 'granted'. This happens when retrieving an old order from the customer who deleted their account.

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) -
  • effectiveDates (type: String.t, default: nil) - The date and time frame when the promotion is active and ready for validation review. Note that the promotion live time may be delayed for a few hours due to the validation review. Start date and end date are separated by a forward slash (/). The start date is specified by the format (YYYY-MM-DD), followed by the letter ?T?, the time of the day when the sale starts (in Greenwich Mean Time, GMT), followed by an expression of the time zone for the sale. The end date is in the same format.
  • genericRedemptionCode (type: String.t, default: nil) - Optional. The text code that corresponds to the promotion when applied on the retailer?s website.
  • id (type: String.t, default: nil) - The unique ID of the promotion.
  • longTitle (type: String.t, default: nil) - The full title of the promotion.
  • productApplicability (type: String.t, default: nil) - Whether the promotion is applicable to all products or only specific products. Acceptable values are: - "allProducts" - "specificProducts"
  • redemptionChannel (type: String.t, default: nil) - Indicates that the promotion is valid online. Acceptable values are: - "online"

Attributes

  • discount (type: GoogleApi.Content.V2.Model.Price.t, default: nil) - The discount in the order price when the promotion is applied.
  • offerIds (type: list(String.t), default: nil) - The OfferId(s) that were purchased in this order and map to this specific benefit of the promotion.
  • subType (type: String.t, default: nil) - Further describes the benefit of the promotion. Note that we will expand on this enumeration as we support new promotion sub-types. Acceptable values are: - "buyMGetMoneyOff" - "buyMGetNMoneyOff" - "buyMGetNPercentOff" - "buyMGetPercentOff" - "freeGift" - "freeGiftWithItemId" - "freeGiftWithValue" - "freeOvernightShipping" - "freeShipping" - "freeTwoDayShipping" - "moneyOff" - "percentageOff" - "rewardPoints" - "salePrice"
  • taxImpact (type: GoogleApi.Content.V2.Model.Price.t, default: nil) - The impact on tax when the promotion is applied.
  • type (type: String.t, default: nil) - Describes whether the promotion applies to products (e.g. 20% off) or to shipping (e.g. Free Shipping). Acceptable values are: - "product" - "shipping"

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.
  • channel (type: String.t, default: nil) - The item's channel (online or local). Acceptable values are: - "local" - "online"
  • condition (type: String.t, default: nil) - Condition or state of the item. Acceptable values are: - "new" - "refurbished" - "used"
  • contentLanguage (type: String.t, default: nil) - The two-letter ISO 639-1 language code for the item.
  • fees (type: list(GoogleApi.Content.V2.Model.OrderLineItemProductFee.t), default: nil) - Associated fees at order creation time.
  • gtin (type: String.t, default: nil) - Global Trade Item Number (GTIN) of the item.
  • id (type: String.t, default: nil) - The REST ID of the product.
  • imageLink (type: String.t, default: nil) - URL of an image of the item.
  • itemGroupId (type: String.t, default: nil) - Shared identifier for all variants of the same product.
  • mpn (type: String.t, default: nil) - Manufacturer Part Number (MPN) of the item.
  • offerId (type: String.t, default: nil) - An identifier of the item.
  • price (type: GoogleApi.Content.V2.Model.Price.t, default: nil) - Price of the item.
  • shownImage (type: String.t, default: nil) - URL to the cached image shown to the user when order was placed.
  • targetCountry (type: String.t, default: nil) - The CLDR territory // code of the target country of the product.
  • title (type: String.t, default: nil) - The title of the product.
  • variantAttributes (type: list(GoogleApi.Content.V2.Model.OrderLineItemProductVariantAttribute.t), default: nil) - Variant attributes for the item. These are dimensions of the product, such as color, gender, material, pattern, and size. You can find a comprehensive list of variant attributes here.

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. Acceptable values are: - "delivery" - "pickup"

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. Acceptable values are: - "AMEX" - "DISCOVER" - "JCB" - "MASTERCARD" - "UNIONPAY" - "VISA" - "``"

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. Acceptable values are: - "customer" - "googleBot" - "googleCustomerService" - "googlePayments" - "googleSabre" - "merchant"
  • amount (type: GoogleApi.Content.V2.Model.Price.t, default: nil) - The amount that is refunded.
  • creationDate (type: String.t, default: nil) - Date on which the item has been created, in ISO 8601 format.
  • reason (type: String.t, default: nil) - The reason for the refund. Acceptable values are: - "adjustment" - "autoPostInternal" - "autoPostInvalidBillingAddress" - "autoPostNoInventory" - "autoPostPriceError" - "autoPostUndeliverableShippingAddress" - "couponAbuse" - "courtesyAdjustment" - "customerCanceled" - "customerDiscretionaryReturn" - "customerInitiatedMerchantCancel" - "customerSupportRequested" - "deliveredLateByCarrier" - "deliveredTooLate" - "expiredItem" - "failToPushOrderGoogleError" - "failToPushOrderMerchantError" - "failToPushOrderMerchantFulfillmentError" - "failToPushOrderToMerchant" - "failToPushOrderToMerchantOutOfStock" - "feeAdjustment" - "invalidCoupon" - "lateShipmentCredit" - "malformedShippingAddress" - "merchantDidNotShipOnTime" - "noInventory" - "orderTimeout" - "other" - "paymentAbuse" - "paymentDeclined" - "priceAdjustment" - "priceError" - "productArrivedDamaged" - "productNotAsDescribed" - "promoReallocation" - "qualityNotAsExpected" - "returnRefundAbuse" - "shippingCostAdjustment" - "shippingPriceError" - "taxAdjustment" - "taxError" - "undeliverableShippingAddress" - "unsupportedPoBoxAddress" - "wrongProductShipped"
  • reasonText (type: String.t, default: nil) - The explanation of the reason.

Order disbursement. All methods require the payment analyst role.

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. Acceptable values are: - "customer" - "googleBot" - "googleCustomerService" - "googlePayments" - "googleSabre" - "merchant"
  • creationDate (type: String.t, default: nil) - Date on which the item has been created, in ISO 8601 format.
  • quantity (type: integer(), default: nil) - Quantity that is returned.
  • reason (type: String.t, default: nil) - The reason for the return. Acceptable values are: - "customerDiscretionaryReturn" - "customerInitiatedMerchantCancel" - "deliveredTooLate" - "expiredItem" - "invalidCoupon" - "malformedShippingAddress" - "other" - "productArrivedDamaged" - "productNotAsDescribed" - "qualityNotAsExpected" - "undeliverableShippingAddress" - "unsupportedPoBoxAddress" - "wrongProductShipped"
  • reasonText (type: String.t, default: nil) - The explanation of the reason.

Attributes

  • carrier (type: String.t, default: nil) - The carrier handling the shipment. For supported carriers, Google includes the carrier name and tracking URL in emails to customers. For select supported carriers, Google also automatically updates the shipment status based on the provided shipment ID. Note: You can also use unsupported carriers, but emails to customers will not include the carrier name or tracking URL, and there will be no automatic order status updates. Supported carriers for US are: - "ups" (United Parcel Service) automatic status updates - "usps" (United States Postal Service) automatic status updates - "fedex" (FedEx) automatic status updates - "dhl" (DHL eCommerce) automatic status updates (US only) - "ontrac" (OnTrac) automatic status updates - "dhl express" (DHL Express) - "deliv" (Deliv) - "dynamex" (TForce) - "lasership" (LaserShip) - "mpx" (Military Parcel Xpress) - "uds" (United Delivery Service) - "efw" (Estes Forwarding Worldwide) - "jd logistics" (JD Logistics) - "yunexpress" (YunExpress) - "china post" (China Post) - "china ems" (China Post Express Mail Service) - "singapore post" (Singapore Post) - "pos malaysia" (Pos Malaysia) - "postnl" (PostNL) - "ptt" (PTT Turkish Post) - "eub" (ePacket) - "chukou1" (Chukou1 Logistics) - "bestex" (Best Express) - "canada post" (Canada Post) - "purolator" (Purolator) - "canpar" (Canpar) - "india post" (India Post) - "blue dart" (Blue Dart) - "delhivery" (Delhivery) - "dtdc" (DTDC) - "tpc india" (TPC India) Supported carriers for FR are: - "la poste" (La Poste) automatic status updates - "colissimo" (Colissimo by La Poste) automatic status updates - "ups" (United Parcel Service) automatic status updates - "chronopost" (Chronopost by La Poste) - "gls" (General Logistics Systems France) - "dpd" (DPD Group by GeoPost) - "bpost" (Belgian Post Group) - "colis prive" (Colis Privé) - "boxtal" (Boxtal) - "geodis" (GEODIS) - "tnt" (TNT) - "db schenker" (DB Schenker) - "aramex" (Aramex)
  • creationDate (type: String.t, default: nil) - Date on which the shipment has been created, in ISO 8601 format.
  • deliveryDate (type: String.t, default: nil) - Date on which the shipment has been delivered, in ISO 8601 format. Present only if status is delivered
  • id (type: String.t, default: nil) - The ID of the shipment.
  • lineItems (type: list(GoogleApi.Content.V2.Model.OrderShipmentLineItemShipment.t), default: nil) - The line items that are shipped.
  • scheduledDeliveryDetails (type: GoogleApi.Content.V2.Model.OrderShipmentScheduledDeliveryDetails.t, default: nil) - Delivery details of the shipment if scheduling is needed.
  • status (type: String.t, default: nil) - The status of the shipment. Acceptable values are: - "delivered" - "readyForPickup" - "shipped" - "undeliverable"
  • trackingId (type: String.t, default: nil) - The tracking ID for 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

  • carrierPhoneNumber (type: String.t, default: nil) - The phone number of the carrier fulfilling the delivery. The phone number is formatted as the international notation in ITU-T Recommendation E.123 (e.g., "+41 44 668 1800").
  • scheduledDate (type: String.t, default: nil) - The date a shipment is scheduled for delivery, in ISO 8601 format.

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. Acceptable values are: - "duplicate" - "executed"
  • kind (type: String.t, default: nil) - Identifies what kind of resource this is. Value: the fixed string "content#orderinvoicesCreateChargeInvoiceResponse".

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. Acceptable values are: - "duplicate" - "executed"
  • kind (type: String.t, default: nil) - Identifies what kind of resource this is. Value: the fixed string "content#orderinvoicesCreateRefundInvoiceResponse".

Attributes

  • description (type: String.t, default: nil) - Optional description of the refund reason.
  • reason (type: String.t, default: nil) - [required] Reason for the refund. Acceptable values are: - "adjustment" - "autoPostInternal" - "autoPostInvalidBillingAddress" - "autoPostNoInventory" - "autoPostPriceError" - "autoPostUndeliverableShippingAddress" - "couponAbuse" - "courtesyAdjustment" - "customerCanceled" - "customerDiscretionaryReturn" - "customerInitiatedMerchantCancel" - "customerSupportRequested" - "deliveredLateByCarrier" - "deliveredTooLate" - "expiredItem" - "failToPushOrderGoogleError" - "failToPushOrderMerchantError" - "failToPushOrderMerchantFulfillmentError" - "failToPushOrderToMerchant" - "failToPushOrderToMerchantOutOfStock" - "feeAdjustment" - "invalidCoupon" - "lateShipmentCredit" - "malformedShippingAddress" - "merchantDidNotShipOnTime" - "noInventory" - "orderTimeout" - "other" - "paymentAbuse" - "paymentDeclined" - "priceAdjustment" - "priceError" - "productArrivedDamaged" - "productNotAsDescribed" - "promoReallocation" - "qualityNotAsExpected" - "returnRefundAbuse" - "shippingCostAdjustment" - "shippingPriceError" - "taxAdjustment" - "taxError" - "undeliverableShippingAddress" - "unsupportedPoBoxAddress" - "wrongProductShipped"

Attributes

  • description (type: String.t, default: nil) - Optional description of the return reason.
  • reason (type: String.t, default: nil) - [required] Reason for the return. Acceptable values are: - "customerDiscretionaryReturn" - "customerInitiatedMerchantCancel" - "deliveredTooLate" - "expiredItem" - "invalidCoupon" - "malformedShippingAddress" - "other" - "productArrivedDamaged" - "productNotAsDescribed" - "qualityNotAsExpected" - "undeliverableShippingAddress" - "unsupportedPoBoxAddress" - "wrongProductShipped"

Attributes

  • disbursements (type: list(GoogleApi.Content.V2.Model.OrderReportDisbursement.t), default: nil) - The list of disbursements.
  • kind (type: String.t, default: nil) - 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: nil) - 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: nil) - 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. Acceptable values are: - "duplicate" - "executed"
  • kind (type: String.t, default: nil) - Identifies what kind of resource this is. Value: the fixed string "content#ordersAcknowledgeResponse".

Attributes

  • kind (type: String.t, default: nil) - 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.
  • amountPretax (type: GoogleApi.Content.V2.Model.Price.t, default: nil) - Amount to refund for the cancelation. Optional. If not set, Google will calculate the default based on the price and tax of the items involved. The amount must not be larger than the net amount left on the order.
  • amountTax (type: GoogleApi.Content.V2.Model.Price.t, default: nil) - Tax amount that corresponds to cancellation amount in amountPretax. Optional, but if filled, then amountPretax must be set. Calculated automatically if not provided.
  • lineItemId (type: String.t, default: nil) - The ID of the line item to cancel. 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 cancel. This is the REST ID used in the products service. Either lineItemId or productId is required.
  • quantity (type: integer(), default: nil) - The quantity to cancel.
  • reason (type: String.t, default: nil) - The reason for the cancellation. Acceptable values are: - "customerInitiatedCancel" - "invalidCoupon" - "malformedShippingAddress" - "noInventory" - "other" - "priceError" - "shippingPriceError" - "taxError" - "undeliverableShippingAddress" - "unsupportedPoBoxAddress"
  • reasonText (type: String.t, default: nil) - The explanation of the reason.

Attributes

  • executionStatus (type: String.t, default: nil) - The status of the execution. Acceptable values are: - "duplicate" - "executed"
  • kind (type: String.t, default: nil) - Identifies what kind of resource this is. Value: the fixed string "content#ordersCancelLineItemResponse".

Attributes

  • operationId (type: String.t, default: nil) - The ID of the operation. Unique across all operations for a given order.
  • reason (type: String.t, default: nil) - The reason for the cancellation. Acceptable values are: - "customerInitiatedCancel" - "invalidCoupon" - "malformedShippingAddress" - "noInventory" - "other" - "priceError" - "shippingPriceError" - "taxError" - "undeliverableShippingAddress" - "unsupportedPoBoxAddress"
  • reasonText (type: String.t, default: nil) - The explanation of the reason.

Attributes

  • executionStatus (type: String.t, default: nil) - The status of the execution. Acceptable values are: - "duplicate" - "executed"
  • kind (type: String.t, default: nil) - Identifies what kind of resource this is. Value: the fixed string "content#ordersCancelResponse".

Attributes

  • reason (type: String.t, default: nil) - The reason for the cancellation. Acceptable values are: - "changedMind" - "orderedWrongItem" - "other"

Attributes

  • kind (type: String.t, default: nil) - 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. Acceptable values are: - "US" - "FR" Defaults to US.
  • templateName (type: String.t, default: nil) - The test order template to use. Specify as an alternative to testOrder as a shortcut for retrieving a template and then creating an order using that template. Acceptable values are: - "template1" - "template1a" - "template1b" - "template2" - "template3"
  • testOrder (type: GoogleApi.Content.V2.Model.TestOrder.t, default: nil) - The test order to create.

Attributes

  • kind (type: String.t, default: nil) - 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: nil) - 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.
  • cancel (type: GoogleApi.Content.V2.Model.OrdersCustomBatchRequestEntryCancel.t, default: nil) - Required for cancel method.
  • cancelLineItem (type: GoogleApi.Content.V2.Model.OrdersCustomBatchRequestEntryCancelLineItem.t, default: nil) - Required for cancelLineItem method.
  • inStoreRefundLineItem (type: GoogleApi.Content.V2.Model.OrdersCustomBatchRequestEntryInStoreRefundLineItem.t, default: nil) - Required for inStoreReturnLineItem method.
  • merchantId (type: String.t, default: nil) - The ID of the managing account.
  • merchantOrderId (type: String.t, default: nil) - The merchant order ID. Required for updateMerchantOrderId and getByMerchantOrderId methods.
  • method (type: String.t, default: nil) - The method of the batch entry. Acceptable values are: - "acknowledge" - "cancel" - "cancelLineItem" - "get" - "getByMerchantOrderId" - "inStoreRefundLineItem" - "refund" - "rejectReturnLineItem" - "returnLineItem" - "returnRefundLineItem" - "setLineItemMetadata" - "shipLineItems" - "updateLineItemShippingDetails" - "updateMerchantOrderId" - "updateShipment"
  • operationId (type: String.t, default: nil) - The ID of the operation. Unique across all operations for a given order. Required for all methods beside get and getByMerchantOrderId.
  • orderId (type: String.t, default: nil) - The ID of the order. Required for all methods beside getByMerchantOrderId.
  • refund (type: GoogleApi.Content.V2.Model.OrdersCustomBatchRequestEntryRefund.t, default: nil) - Required for refund method.
  • rejectReturnLineItem (type: GoogleApi.Content.V2.Model.OrdersCustomBatchRequestEntryRejectReturnLineItem.t, default: nil) - Required for rejectReturnLineItem method.
  • returnLineItem (type: GoogleApi.Content.V2.Model.OrdersCustomBatchRequestEntryReturnLineItem.t, default: nil) - Required for returnLineItem method.
  • returnRefundLineItem (type: GoogleApi.Content.V2.Model.OrdersCustomBatchRequestEntryReturnRefundLineItem.t, default: nil) - Required for returnRefundLineItem method.
  • setLineItemMetadata (type: GoogleApi.Content.V2.Model.OrdersCustomBatchRequestEntrySetLineItemMetadata.t, default: nil) - Required for setLineItemMetadata method.
  • shipLineItems (type: GoogleApi.Content.V2.Model.OrdersCustomBatchRequestEntryShipLineItems.t, default: nil) - Required for shipLineItems method.
  • updateLineItemShippingDetails (type: GoogleApi.Content.V2.Model.OrdersCustomBatchRequestEntryUpdateLineItemShippingDetails.t, default: nil) - Required for updateLineItemShippingDate method.
  • updateShipment (type: GoogleApi.Content.V2.Model.OrdersCustomBatchRequestEntryUpdateShipment.t, default: nil) - Required for updateShipment method.

Attributes

  • reason (type: String.t, default: nil) - The reason for the cancellation. Acceptable values are: - "customerInitiatedCancel" - "invalidCoupon" - "malformedShippingAddress" - "noInventory" - "other" - "priceError" - "shippingPriceError" - "taxError" - "undeliverableShippingAddress" - "unsupportedPoBoxAddress"
  • reasonText (type: String.t, default: nil) - The explanation of the reason.

Attributes

  • amount (type: GoogleApi.Content.V2.Model.Price.t, default: nil) - Deprecated. Please use amountPretax and amountTax instead.
  • amountPretax (type: GoogleApi.Content.V2.Model.Price.t, default: nil) - Amount to refund for the cancelation. Optional. If not set, Google will calculate the default based on the price and tax of the items involved. The amount must not be larger than the net amount left on the order.
  • amountTax (type: GoogleApi.Content.V2.Model.Price.t, default: nil) - Tax amount that corresponds to cancellation amount in amountPretax. Optional, but if filled, then amountPretax must be set. Calculated automatically if not provided.
  • lineItemId (type: String.t, default: nil) - The ID of the line item to cancel. Either lineItemId or productId is required.
  • productId (type: String.t, default: nil) - The ID of the product to cancel. This is the REST ID used in the products service. Either lineItemId or productId is required.
  • quantity (type: integer(), default: nil) - The quantity to cancel.
  • reason (type: String.t, default: nil) - The reason for the cancellation. Acceptable values are: - "customerInitiatedCancel" - "invalidCoupon" - "malformedShippingAddress" - "noInventory" - "other" - "priceError" - "shippingPriceError" - "taxError" - "undeliverableShippingAddress" - "unsupportedPoBoxAddress"
  • reasonText (type: String.t, default: nil) - The explanation of the reason.

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.
  • amountTax (type: GoogleApi.Content.V2.Model.Price.t, default: nil) - Tax amount that correspond to refund amount in amountPretax. Required.
  • lineItemId (type: String.t, default: nil) - The ID of the line item to return. Either lineItemId or productId is required.
  • productId (type: String.t, default: nil) - The ID of the product to return. This is the REST ID used in the products service. Either lineItemId or productId is required.
  • quantity (type: integer(), default: nil) - The quantity to return and refund.
  • reason (type: String.t, default: nil) - The reason for the return. Acceptable values are: - "customerDiscretionaryReturn" - "customerInitiatedMerchantCancel" - "deliveredTooLate" - "expiredItem" - "invalidCoupon" - "malformedShippingAddress" - "other" - "productArrivedDamaged" - "productNotAsDescribed" - "qualityNotAsExpected" - "undeliverableShippingAddress" - "unsupportedPoBoxAddress" - "wrongProductShipped"
  • reasonText (type: String.t, default: nil) - The explanation of the reason.

Attributes

  • amount (type: GoogleApi.Content.V2.Model.Price.t, default: nil) - Deprecated. Please use amountPretax and amountTax instead.
  • amountPretax (type: GoogleApi.Content.V2.Model.Price.t, default: nil) - The amount that is refunded. Either amount or amountPretax should be filled.
  • amountTax (type: GoogleApi.Content.V2.Model.Price.t, default: nil) - Tax amount that corresponds to refund amount in amountPretax. Optional, but if filled, amountPretax must be set. Calculated automatically if not provided.
  • reason (type: String.t, default: nil) - The reason for the refund. Acceptable values are: - "adjustment" - "courtesyAdjustment" - "customerCanceled" - "customerDiscretionaryReturn" - "deliveredLateByCarrier" - "feeAdjustment" - "lateShipmentCredit" - "noInventory" - "other" - "priceError" - "productArrivedDamaged" - "productNotAsDescribed" - "shippingCostAdjustment" - "taxAdjustment" - "undeliverableShippingAddress" - "wrongProductShipped"
  • reasonText (type: String.t, default: nil) - The explanation of the reason.

Attributes

  • lineItemId (type: String.t, default: nil) - The ID of the line item to return. Either lineItemId or productId is required.
  • productId (type: String.t, default: nil) - The ID of the product to return. This is the REST ID used in the products service. Either lineItemId or productId is required.
  • quantity (type: integer(), default: nil) - The quantity to return and refund.
  • reason (type: String.t, default: nil) - The reason for the return. Acceptable values are: - "damagedOrUsed" - "missingComponent" - "notEligible" - "other" - "outOfReturnWindow"
  • reasonText (type: String.t, default: nil) - The explanation of the reason.

Attributes

  • lineItemId (type: String.t, default: nil) - The ID of the line item to return. Either lineItemId or productId is required.
  • productId (type: String.t, default: nil) - The ID of the product to return. This is the REST ID used in the products service. Either lineItemId or productId is required.
  • quantity (type: integer(), default: nil) - The quantity to return.
  • reason (type: String.t, default: nil) - The reason for the return. Acceptable values are: - "customerDiscretionaryReturn" - "customerInitiatedMerchantCancel" - "deliveredTooLate" - "expiredItem" - "invalidCoupon" - "malformedShippingAddress" - "other" - "productArrivedDamaged" - "productNotAsDescribed" - "qualityNotAsExpected" - "undeliverableShippingAddress" - "unsupportedPoBoxAddress" - "wrongProductShipped"
  • reasonText (type: String.t, default: nil) - The explanation of the reason.

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).
  • amountTax (type: GoogleApi.Content.V2.Model.Price.t, default: nil) - Tax amount that corresponds to refund amount in amountPretax. Optional, but if filled, then amountPretax must be set. Calculated automatically if not provided.
  • lineItemId (type: String.t, default: nil) - The ID of the line item to return. Either lineItemId or productId is required.
  • productId (type: String.t, default: nil) - The ID of the product to return. This is the REST ID used in the products service. Either lineItemId or productId is required.
  • quantity (type: integer(), default: nil) - The quantity to return and refund.
  • reason (type: String.t, default: nil) - The reason for the return. Acceptable values are: - "customerDiscretionaryReturn" - "customerInitiatedMerchantCancel" - "deliveredTooLate" - "expiredItem" - "invalidCoupon" - "malformedShippingAddress" - "other" - "productArrivedDamaged" - "productNotAsDescribed" - "qualityNotAsExpected" - "undeliverableShippingAddress" - "unsupportedPoBoxAddress" - "wrongProductShipped"
  • reasonText (type: String.t, default: nil) - The explanation of the reason.

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. Provided date should be within 1 year timeframe and can not be a date in the past.
  • 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.
  • shipByDate (type: String.t, default: nil) - Updated ship by date, in ISO 8601 format. If not specified only deliver by date is updated. Provided date should be within 1 year timeframe and can not be a date in the past.

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.
  • deliveryDate (type: String.t, default: nil) - Date on which the shipment has been delivered, in ISO 8601 format. Optional and can be provided only if status is delivered.
  • shipmentId (type: String.t, default: nil) - The ID of the shipment.
  • status (type: String.t, default: nil) - New status for the shipment. Not updated if missing. Acceptable values are: - "delivered" - "undeliverable" - "readyForPickup"
  • trackingId (type: String.t, default: nil) - The tracking ID for the shipment. Not updated if missing.

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: nil) - 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.
  • errors (type: GoogleApi.Content.V2.Model.Errors.t, default: nil) - A list of errors defined if and only if the request failed.
  • executionStatus (type: String.t, default: nil) - The status of the execution. Only defined if 1. the request was successful; and 2. the method is not get, getByMerchantOrderId, or one of the test methods. Acceptable values are: - "duplicate" - "executed"
  • kind (type: String.t, default: nil) - Identifies what kind of resource this is. Value: the fixed string "content#ordersCustomBatchResponseEntry"
  • order (type: GoogleApi.Content.V2.Model.Order.t, default: nil) - The retrieved order. Only defined if the method is get and if the request was successful.

Attributes

  • kind (type: String.t, default: nil) - 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: nil) - 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.
  • amountTax (type: GoogleApi.Content.V2.Model.Price.t, default: nil) - Tax amount that correspond to refund amount in amountPretax. Required.
  • lineItemId (type: String.t, default: nil) - The ID of the line item to return. 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 return. This is the REST ID used in the products service. Either lineItemId or productId is required.
  • quantity (type: integer(), default: nil) - The quantity to return and refund.
  • reason (type: String.t, default: nil) - The reason for the return. Acceptable values are: - "customerDiscretionaryReturn" - "customerInitiatedMerchantCancel" - "deliveredTooLate" - "expiredItem" - "invalidCoupon" - "malformedShippingAddress" - "other" - "productArrivedDamaged" - "productNotAsDescribed" - "qualityNotAsExpected" - "undeliverableShippingAddress" - "unsupportedPoBoxAddress" - "wrongProductShipped"
  • reasonText (type: String.t, default: nil) - The explanation of the reason.

Attributes

  • executionStatus (type: String.t, default: nil) - The status of the execution. Acceptable values are: - "duplicate" - "executed"
  • kind (type: String.t, default: nil) - Identifies what kind of resource this is. Value: the fixed string "content#ordersInStoreRefundLineItemResponse".

Attributes

  • kind (type: String.t, default: nil) - 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.
  • amountPretax (type: GoogleApi.Content.V2.Model.Price.t, default: nil) - The amount that is refunded. Either amount or amountPretax should be filled.
  • amountTax (type: GoogleApi.Content.V2.Model.Price.t, default: nil) - Tax amount that corresponds to refund amount in amountPretax. Optional, but if filled, amountPretax must be set. Calculated automatically if not provided.
  • operationId (type: String.t, default: nil) - The ID of the operation. Unique across all operations for a given order.
  • reason (type: String.t, default: nil) - The reason for the refund. Acceptable values are: - "adjustment" - "courtesyAdjustment" - "customerCanceled" - "customerDiscretionaryReturn" - "deliveredLateByCarrier" - "feeAdjustment" - "lateShipmentCredit" - "noInventory" - "other" - "priceError" - "productArrivedDamaged" - "productNotAsDescribed" - "shippingCostAdjustment" - "taxAdjustment" - "undeliverableShippingAddress" - "wrongProductShipped"
  • reasonText (type: String.t, default: nil) - The explanation of the reason.

Attributes

  • executionStatus (type: String.t, default: nil) - The status of the execution. Acceptable values are: - "duplicate" - "executed"
  • kind (type: String.t, default: nil) - Identifies what kind of resource this is. Value: the fixed string "content#ordersRefundResponse".

Attributes

  • lineItemId (type: String.t, default: nil) - The ID of the line item to return. 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 return. This is the REST ID used in the products service. Either lineItemId or productId is required.
  • quantity (type: integer(), default: nil) - The quantity to return and refund.
  • reason (type: String.t, default: nil) - The reason for the return. Acceptable values are: - "damagedOrUsed" - "missingComponent" - "notEligible" - "other" - "outOfReturnWindow"
  • reasonText (type: String.t, default: nil) - The explanation of the reason.

Attributes

  • executionStatus (type: String.t, default: nil) - The status of the execution. Acceptable values are: - "duplicate" - "executed"
  • kind (type: String.t, default: nil) - Identifies what kind of resource this is. Value: the fixed string "content#ordersRejectReturnLineItemResponse".

Attributes

  • lineItemId (type: String.t, default: nil) - The ID of the line item to return. 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 return. This is the REST ID used in the products service. Either lineItemId or productId is required.
  • quantity (type: integer(), default: nil) - The quantity to return.
  • reason (type: String.t, default: nil) - The reason for the return. Acceptable values are: - "customerDiscretionaryReturn" - "customerInitiatedMerchantCancel" - "deliveredTooLate" - "expiredItem" - "invalidCoupon" - "malformedShippingAddress" - "other" - "productArrivedDamaged" - "productNotAsDescribed" - "qualityNotAsExpected" - "undeliverableShippingAddress" - "unsupportedPoBoxAddress" - "wrongProductShipped"
  • reasonText (type: String.t, default: nil) - The explanation of the reason.

Attributes

  • executionStatus (type: String.t, default: nil) - The status of the execution. Acceptable values are: - "duplicate" - "executed"
  • kind (type: String.t, default: nil) - Identifies what kind of resource this is. Value: the fixed string "content#ordersReturnLineItemResponse".

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).
  • amountTax (type: GoogleApi.Content.V2.Model.Price.t, default: nil) - Tax amount that corresponds to refund amount in amountPretax. Optional, but if filled, then amountPretax must be set. Calculated automatically if not provided.
  • lineItemId (type: String.t, default: nil) - The ID of the line item to return. 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 return. This is the REST ID used in the products service. Either lineItemId or productId is required.
  • quantity (type: integer(), default: nil) - The quantity to return and refund. Quantity is required.
  • reason (type: String.t, default: nil) - The reason for the return. Acceptable values are: - "customerDiscretionaryReturn" - "customerInitiatedMerchantCancel" - "deliveredTooLate" - "expiredItem" - "invalidCoupon" - "malformedShippingAddress" - "other" - "productArrivedDamaged" - "productNotAsDescribed" - "qualityNotAsExpected" - "undeliverableShippingAddress" - "unsupportedPoBoxAddress" - "wrongProductShipped"
  • reasonText (type: String.t, default: nil) - The explanation of the reason.

Attributes

  • executionStatus (type: String.t, default: nil) - The status of the execution. Acceptable values are: - "duplicate" - "executed"
  • kind (type: String.t, default: nil) - Identifies what kind of resource this is. Value: the fixed string "content#ordersReturnRefundLineItemResponse".

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. Acceptable values are: - "duplicate" - "executed"
  • kind (type: String.t, default: nil) - Identifies what kind of resource this is. Value: the fixed string "content#ordersSetLineItemMetadataResponse".

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. Acceptable values are: - "duplicate" - "executed"
  • kind (type: String.t, default: nil) - Identifies what kind of resource this is. Value: the fixed string "content#ordersShipLineItemsResponse".

Attributes

  • deliverByDate (type: String.t, default: nil) - Updated delivery by date, in ISO 8601 format. If not specified only ship by date is updated. Provided date should be within 1 year timeframe and can not be a date in the past.
  • 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.
  • shipByDate (type: String.t, default: nil) - Updated ship by date, in ISO 8601 format. If not specified only deliver by date is updated. Provided date should be within 1 year timeframe and can not be a date in the past.

Attributes

  • executionStatus (type: String.t, default: nil) - The status of the execution. Acceptable values are: - "duplicate" - "executed"
  • kind (type: String.t, default: nil) - Identifies what kind of resource this is. Value: the fixed string "content#ordersUpdateLineItemShippingDetailsResponse".

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. Acceptable values are: - "duplicate" - "executed"
  • kind (type: String.t, default: nil) - Identifies what kind of resource this is. Value: the fixed string "content#ordersUpdateMerchantOrderIdResponse".

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.
  • deliveryDate (type: String.t, default: nil) - Date on which the shipment has been delivered, in ISO 8601 format. Optional and can be provided only if status is delivered.
  • operationId (type: String.t, default: nil) - The ID of the operation. Unique across all operations for a given order.
  • shipmentId (type: String.t, default: nil) - The ID of the shipment.
  • status (type: String.t, default: nil) - New status for the shipment. Not updated if missing. Acceptable values are: - "delivered" - "undeliverable" - "readyForPickup"
  • trackingId (type: String.t, default: nil) - The tracking ID for the shipment. Not updated if missing.

Attributes

  • executionStatus (type: String.t, default: nil) - The status of the execution. Acceptable values are: - "duplicate" - "executed"
  • kind (type: String.t, default: nil) - Identifies what kind of resource this is. Value: the fixed string "content#ordersUpdateShipmentResponse".

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.
  • inventory (type: GoogleApi.Content.V2.Model.PosInventory.t, default: nil) - The inventory to submit. This should be set only if the method is inventory.
  • merchantId (type: String.t, default: nil) - The ID of the POS data provider.
  • method (type: String.t, default: nil) - The method of the batch entry. Acceptable values are: - "delete" - "get" - "insert" - "inventory" - "sale"
  • sale (type: GoogleApi.Content.V2.Model.PosSale.t, default: nil) - The sale information to submit. This should be set only if the method is sale.
  • store (type: GoogleApi.Content.V2.Model.PosStore.t, default: nil) - The store information to submit. This should be set only if the method is insert.
  • storeCode (type: String.t, default: nil) - The store code. This should be set only if the method is delete or get.
  • targetMerchantId (type: String.t, default: nil) - The ID of the account for which to get/submit data.

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: nil) - 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: nil) - 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: nil) - 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: nil) - 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: nil) - 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. Some attributes are country-specific, so make sure you select the appropriate country in the drop-down selector at the top of the page. Product data. After inserting, updating, or deleting a product, it may take several minutes before changes take effect.

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. Acceptable values are: - "default" - "excluded" - "optional" - "required"

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.
  • approvalStatus (type: String.t, default: nil) - The destination's approval status. Acceptable values are: - "approved" - "disapproved"
  • destination (type: String.t, default: nil) - The name of the destination
  • intention (type: String.t, default: nil) - Provided for backward compatibility only. Always set to "required". Acceptable values are: - "default" - "excluded" - "optional" - "required"

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) - Should be 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: nil) - 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: nil) - 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: nil) - 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: nil) - 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. Acceptable values are: - "adjustment" - "autoPostInternal" - "autoPostInvalidBillingAddress" - "autoPostNoInventory" - "autoPostPriceError" - "autoPostUndeliverableShippingAddress" - "couponAbuse" - "courtesyAdjustment" - "customerCanceled" - "customerDiscretionaryReturn" - "customerInitiatedMerchantCancel" - "customerSupportRequested" - "deliveredLateByCarrier" - "deliveredTooLate" - "expiredItem" - "failToPushOrderGoogleError" - "failToPushOrderMerchantError" - "failToPushOrderMerchantFulfillmentError" - "failToPushOrderToMerchant" - "failToPushOrderToMerchantOutOfStock" - "feeAdjustment" - "invalidCoupon" - "lateShipmentCredit" - "malformedShippingAddress" - "merchantDidNotShipOnTime" - "noInventory" - "orderTimeout" - "other" - "paymentAbuse" - "paymentDeclined" - "priceAdjustment" - "priceError" - "productArrivedDamaged" - "productNotAsDescribed" - "promoReallocation" - "qualityNotAsExpected" - "returnRefundAbuse" - "shippingCostAdjustment" - "shippingPriceError" - "taxAdjustment" - "taxError" - "undeliverableShippingAddress" - "unsupportedPoBoxAddress" - "wrongProductShipped"

Attributes

  • creationDate (type: String.t, default: nil) - The date of creation of the shipment, in ISO 8601 format.
  • deliveryDate (type: String.t, default: nil) - The date of delivery of the shipment, in ISO 8601 format.
  • returnMethodType (type: String.t, default: nil) - Type of the return method. Acceptable values are: - "byMail" - "contactCustomerSupport" - "returnless"
  • shipmentId (type: String.t, default: nil) - Shipment ID generated by Google.
  • shipmentTrackingInfos (type: list(GoogleApi.Content.V2.Model.ShipmentTrackingInfo.t), default: nil) - Tracking information of the shipment. One return shipment might be handled by several shipping carriers sequentially.
  • shippingDate (type: String.t, default: nil) - The date of shipping of the shipment, in ISO 8601 format.
  • state (type: String.t, default: nil) - State of the shipment. Acceptable values are: - "completed" - "new" - "shipped" - "undeliverable" - "pending"

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.
  • currency (type: String.t, default: nil) - The CLDR code of the currency to which this service applies. Must match that of the prices in rate groups.
  • deliveryCountry (type: String.t, default: nil) - The CLDR territory code of the country to which the service applies. Required.
  • deliveryTime (type: GoogleApi.Content.V2.Model.DeliveryTime.t, default: nil) - Time spent in various aspects from order to the delivery of the product. Required.
  • eligibility (type: String.t, default: nil) - Eligibility for this service. Acceptable values are: - "All scenarios" - "All scenarios except Shopping Actions" - "Shopping Actions"
  • minimumOrderValue (type: GoogleApi.Content.V2.Model.Price.t, default: nil) - Minimum order value for this service. If set, indicates that customers will have to spend at least this amount. All prices within a service must have the same currency. Cannot be set together with minimum_order_value_table.
  • minimumOrderValueTable (type: GoogleApi.Content.V2.Model.MinimumOrderValueTable.t, default: nil) - Table of per store minimum order values for the pickup fulfillment type. Cannot be set together with minimum_order_value.
  • name (type: String.t, default: nil) - Free-form name of the service. Must be unique within target account. Required.
  • pickupService (type: GoogleApi.Content.V2.Model.PickupCarrierService.t, default: nil) - The carrier-service pair delivering items to collection points. The list of supported pickup services can be retrieved via the getSupportedPickupServices method. Required if and only if the service delivery type is pickup.
  • rateGroups (type: list(GoogleApi.Content.V2.Model.RateGroup.t), default: nil) - Shipping rate group definitions. Only the last one is allowed to have an empty applicableShippingLabels, which means "everything else". The other applicableShippingLabels must not overlap.
  • shipmentType (type: String.t, default: nil) - Type of locations this service ships orders to. Acceptable values are: - "delivery" - "pickup"

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. Acceptable values are: - "boxtal" - "bpost" - "chronopost" - "colisPrive" - "colissimo" - "cxt" - "deliv" - "dhl" - "dpd" - "dynamex" - "eCourier" - "easypost" - "efw" - "fedex" - "fedexSmartpost" - "geodis" - "gls" - "googleCourier" - "gsx" - "jdLogistics" - "laPoste" - "lasership" - "manual" - "mpx" - "onTrac" - "other" - "tnt" - "uds" - "ups" - "usps"
  • trackingNumber (type: String.t, default: nil) - The tracking number for 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: nil) - 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: nil) - 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: nil) - Identifies what kind of resource this is. Value: the fixed string "content#shippingsettingsGetSupportedHolidaysResponse".

Attributes

  • kind (type: String.t, default: nil) - 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: nil) - 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.
  • enableOrderinvoices (type: boolean(), default: nil) - Whether the orderinvoices service should support this order.
  • kind (type: String.t, default: nil) - Identifies what kind of resource this is. Value: the fixed string "content#testOrder"
  • lineItems (type: list(GoogleApi.Content.V2.Model.TestOrderLineItem.t), default: nil) - Required. Line items that are ordered. At least one line item must be provided.
  • notificationMode (type: String.t, default: nil) - Restricted. Do not use.
  • paymentMethod (type: GoogleApi.Content.V2.Model.TestOrderPaymentMethod.t, default: nil) - The details of the payment method.
  • predefinedDeliveryAddress (type: String.t, default: nil) - Required. Identifier of one of the predefined delivery addresses for the delivery. Acceptable values are: - "dwight" - "jim" - "pam"
  • predefinedPickupDetails (type: String.t, default: nil) - Identifier of one of the predefined pickup details. Required for orders containing line items with shipping type pickup. Acceptable values are: - "dwight" - "jim" - "pam"
  • promotions (type: list(GoogleApi.Content.V2.Model.OrderLegacyPromotion.t), default: nil) - Deprecated. Ignored if provided.
  • shippingCost (type: GoogleApi.Content.V2.Model.Price.t, default: nil) - Required. The price of shipping for all items. Shipping tax is automatically calculated for orders where marketplace facilitator tax laws are applicable. Otherwise, tax settings from Merchant Center are applied. Note that shipping is not taxed in certain states.
  • shippingCostTax (type: GoogleApi.Content.V2.Model.Price.t, default: nil) - Deprecated. Ignored if provided.
  • shippingOption (type: String.t, default: nil) - Required. The requested shipping option. Acceptable values are: - "economy" - "expedited" - "oneDay" - "sameDay" - "standard" - "twoDay"

Attributes

  • email (type: String.t, default: nil) - Required. Email address of the customer. Acceptable values are: - "pog.dwight.schrute@gmail.com" - "pog.jim.halpert@gmail.com" - "penpog.pam.beesly@gmail.comding"
  • explicitMarketingPreference (type: boolean(), default: nil) - Deprecated. Please use marketingRightsInfo instead.
  • fullName (type: String.t, default: nil) - Full name of the customer.
  • marketingRightsInfo (type: GoogleApi.Content.V2.Model.TestOrderCustomerMarketingRightsInfo.t, default: nil) - Customer's marketing preferences.

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. Acceptable values are: - "denied" - "granted"
  • lastUpdatedTimestamp (type: String.t, default: nil) - Timestamp when last time marketing preference was updated. Could be empty, if user wasn't offered a selection yet.

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.
  • channel (type: String.t, default: nil) - Deprecated. Acceptable values are: - "online"
  • condition (type: String.t, default: nil) - Required. Condition or state of the item. Acceptable values are: - "new"
  • contentLanguage (type: String.t, default: nil) - Required. The two-letter ISO 639-1 language code for the item. Acceptable values are: - "en" - "fr"
  • fees (type: list(GoogleApi.Content.V2.Model.OrderLineItemProductFee.t), default: nil) - Fees for the item. Optional.
  • gtin (type: String.t, default: nil) - Global Trade Item Number (GTIN) of the item. Optional.
  • imageLink (type: String.t, default: nil) - Required. URL of an image of the item.
  • itemGroupId (type: String.t, default: nil) - Shared identifier for all variants of the same product. Optional.
  • mpn (type: String.t, default: nil) - Manufacturer Part Number (MPN) of the item. Optional.
  • offerId (type: String.t, default: nil) - Required. An identifier of the item.
  • price (type: GoogleApi.Content.V2.Model.Price.t, default: nil) - Required. The price for the product. Tax is automatically calculated for orders where marketplace facilitator tax laws are applicable. Otherwise, tax settings from Merchant Center are applied.
  • targetCountry (type: String.t, default: nil) - Required. The CLDR territory // code of the target country of the product.
  • title (type: String.t, default: nil) - Required. The title of the product.
  • variantAttributes (type: list(GoogleApi.Content.V2.Model.OrderLineItemProductVariantAttribute.t), default: nil) - Variant attributes for the item. Optional.

Attributes

  • 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.
  • predefinedBillingAddress (type: String.t, default: nil) - The billing address. Acceptable values are: - "dwight" - "jim" - "pam"
  • type (type: String.t, default: nil) - The type of instrument. Note that real orders might have different values than the four values accepted by createTestOrder. Acceptable values are: - "AMEX" - "DISCOVER" - "MASTERCARD" - "VISA"

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. Acceptable values are: - "shipping"

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. Acceptable values are: - "otherFee" - "otherFeeTax" - "sales"

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. Acceptable values are: - "kg" - "lb"
  • value (type: String.t, default: nil) - Required. The weight represented as a number.

API client metadata for GoogleApi.Content.V21.

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

API calls for all endpoints tagged Collections.

API calls for all endpoints tagged Collectionstatuses.

API calls for all endpoints tagged Csses.

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

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

API calls for all endpoints tagged Reports.

API calls for all endpoints tagged Repricingrules.

API calls for all endpoints tagged Returnaddress.

API calls for all endpoints tagged Returnpolicy.

API calls for all endpoints tagged Returnpolicyonline.

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"). This value cannot be set for a sub-account of an MCA. All MCA sub-accounts inherit the country of their parent MCA.
  • 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. Acceptable values are: - "active" - "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.

Credentials allowing Google to call a partner's API on behalf of a merchant.

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

  • gmbAccountId (type: String.t, default: nil) - The ID of the GMB account. If this is provided, then gmbEmail is ignored. The value of this field should match the accountId used by the GMB API.
  • 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. Acceptable values are: - "active" - "pending"

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.

Label assigned by CSS domain or CSS group to one of its sub-accounts.

The return carrier information. This service is designed for merchants enrolled in the Buy on Google program.

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.
  • destination (type: String.t, default: nil) - The destination the issue applies to. If this field is empty then the issue applies to all available destinations.
  • detail (type: String.t, default: nil) - Additional details about the issue.
  • documentation (type: String.t, default: nil) - The URL of a web page to help resolving this issue.
  • id (type: String.t, default: nil) - Issue identifier.
  • severity (type: String.t, default: nil) - Severity of the issue. Acceptable values are: - "critical" - "error" - "suggestion"
  • title (type: String.t, default: nil) - Short description of the issue.

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. Acceptable values are: - "local" - "online"
  • country (type: String.t, default: nil) - The country the data applies to.
  • destination (type: String.t, default: nil) - The destination the data applies to.
  • itemLevelIssues (type: list(GoogleApi.Content.V21.Model.AccountStatusItemLevelIssue.t), default: nil) - List of item-level issues.
  • statistics (type: GoogleApi.Content.V21.Model.AccountStatusStatistics.t, default: nil) - Aggregated product statistics.

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. - For an individual account: only the merchant ID is defined - For an aggregator: only the aggregator ID is defined - For a subaccount of an MCA: both the merchant ID and the aggregator ID are defined.
  • kind (type: String.t, default: nil) - Identifies what kind of resource this is. Value: the fixed string "content#accountsAuthInfoResponse".

Attributes

  • kind (type: String.t, default: nil) - 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. Acceptable values are: - "approve" - "remove" - "request"
  • linkType (type: String.t, default: nil) - Type of the link between the two accounts. Acceptable values are: - "channelPartner" - "eCommercePlatform"
  • linkedAccountId (type: String.t, default: nil) - The ID of the linked account.
  • services (type: list(String.t), default: nil) - Provided services. Acceptable values are: - "shoppingAdsProductManagement" - "shoppingActionsProductManagement" - "shoppingActionsOrderManagement"

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: nil) - 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. Acceptable values are: - "approve" - "remove" - "request"
  • linkType (type: String.t, default: nil) - Type of the link between the two accounts. Acceptable values are: - "channelPartner" - "eCommercePlatform"
  • linkedAccountId (type: String.t, default: nil) - The ID of the linked account.
  • services (type: list(String.t), default: nil) - Acceptable values are: - "shoppingAdsProductManagement" - "shoppingAdsOther" - "shoppingActionsProductManagement" - "shoppingActionsOrderManagement" - "shoppingActionsOther"

Attributes

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

Attributes

  • kind (type: String.t, default: nil) - 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: nil) - 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

  • labelIds (type: list(String.t), default: nil) - The IDs of labels that should be assigned to the account.

Attributes

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

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: nil) - 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: nil) - 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: nil) - 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: nil) - 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.

Response message for the GetProgramStatus method.

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.

The collection message.

The collectionstatus message.

Issue associated with the collection.

Information about CSS domain.

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. Acceptable values are: - "betterPriceFound" - "changedMind" - "damagedOrDefectiveItem" - "didNotMatchDescription" - "doesNotFit" - "expiredItem" - "incorrectItemReceived" - "noLongerNeeded" - "notSpecified" - "orderedWrongItem" - "other" - "qualityNotExpected" - "receivedTooLate" - "undeliverable"

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. Acceptable values are: - "pipe" - "tab" - "tilde"
  • fileEncoding (type: String.t, default: nil) - Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected. Acceptable values are: - "latin-1" - "utf-16be" - "utf-16le" - "utf-8" - "windows-1252"
  • quotingMode (type: String.t, default: nil) - Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds. Acceptable values are: - "normal character" - "value quoting"

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.
  • excludedDestinations (type: list(String.t), default: nil) - The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center).
  • includedDestinations (type: list(String.t), default: nil) - The list of destinations to include for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in excludedDestinations. List of supported destinations (if available to the account): - DisplayAds - Shopping - ShoppingActions - SurfacesAcrossGoogle
  • language (type: String.t, default: nil) - The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for targets[].country.

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: nil) - 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: nil) - Identifies what kind of resource this is. Value: the fixed string "content#datafeedsFetchNowResponse".

Attributes

  • kind (type: String.t, default: nil) - 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: nil) - 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: nil) - 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) -

Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: A full date, with non-zero year, month, and day values A month and day value, with a zero year, such as an anniversary A year on its own, with zero month and day values A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and google.protobuf.Timestamp.

Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few possible ways: When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year is 0, the DateTime is considered not to have a specific year. month and day must have valid, non-zero values. This type may also be used to represent a physical time if all the date and time fields are set and either case of the time_offset oneof is set. Consider using Timestamp message for physical time instead. If your use case also would like to store the user's timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application's limitations.

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 Merchant Center 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. Acceptable values are: - "Christmas" - "Easter" - "Father's Day" - "Halloween" - "Independence Day (USA)" - "Mother's Day" - "Thanksgiving" - "Valentine's Day"

Map of inapplicability details.

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. Acceptable values are: - "shipping"

The IDs of labels that should be assigned to the CSS domain.

Attributes

  • status (type: String.t, default: nil) - The status of the verification process for the About page. Acceptable values are: - "active" - "inactive" - "pending"
  • url (type: String.t, default: nil) - The URL 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.
  • inventoryVerificationContactName (type: String.t, default: nil) - The name of the contact for the inventory verification process.
  • inventoryVerificationContactStatus (type: String.t, default: nil) - The status of the verification contact. Acceptable values are: - "active" - "inactive" - "pending"
  • status (type: String.t, default: nil) - The status of the inventory verification process. Acceptable values are: - "active" - "inactive" - "pending"

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. Acceptable values are: - "active" - "inactive" - "pending"

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 LIA settings.
  • batchId (type: integer(), default: nil) - An entry ID, unique within the batch request.
  • contactEmail (type: String.t, default: nil) - Inventory validation contact email. Required only for SetInventoryValidationContact.
  • contactName (type: String.t, default: nil) - Inventory validation contact name. Required only for SetInventoryValidationContact.
  • country (type: String.t, default: nil) - The country code. Required only for RequestInventoryVerification.
  • gmbEmail (type: String.t, default: nil) - The GMB account. Required only for RequestGmbAccess.
  • liaSettings (type: GoogleApi.Content.V21.Model.LiaSettings.t, default: nil) - The account Lia settings to update. Only defined if the method is update.
  • merchantId (type: String.t, default: nil) - The ID of the managing account.
  • method (type: String.t, default: nil) - The method of the batch entry. Acceptable values are: - "get" - "getAccessibleGmbAccounts" - "requestGmbAccess" - "requestInventoryVerification" - "setInventoryVerificationContact" - "update"
  • posDataProviderId (type: String.t, default: nil) - The ID of POS data provider. Required only for SetPosProvider.
  • posExternalAccountId (type: String.t, default: nil) - The account ID by which this merchant is known to the POS provider.

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: nil) - 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 list of accessible GMB accounts.
  • kind (type: String.t, default: nil) - 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 Merchant Center 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: nil) - Identifies what kind of resource this is. Value: the fixed string "content#liasettingsGetAccessibleGmbAccountsResponse".

Attributes

  • kind (type: String.t, default: nil) - 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: nil) - 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: nil) - Identifies what kind of resource this is. Value: the fixed string "content#liasettingsRequestGmbAccessResponse".

Attributes

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

Attributes

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

Attributes

  • kind (type: String.t, default: nil) - 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. Acceptable values are: - "shoppingActionsOrderManagement" - "shoppingActionsProductManagement" - "shoppingAdsProductManagement"
  • status (type: String.t, default: nil) - Status of the link Acceptable values are: - "active" - "inactive" - "pending"

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.

Response message for the ListAccountLabels method.

Response for listing account return carriers.

Response message for the ListCollectionStatuses method.

Response message for the ListCollections method.

The response message for the ListCsses method

Response message for the ListRegions method.

Response message for the ListRepricingProductReports method.

Response message for the ListRepricingRuleReports method.

Response message for the ListRepricingRules method.

Response message for the ListReturnPolicyOnline method.

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: nil) - 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.
  • merchantRejectionReason (type: GoogleApi.Content.V21.Model.MerchantRejectionReason.t, default: nil) - The reason that the merchant chose to reject an item return.
  • 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.
  • refundableAmount (type: GoogleApi.Content.V21.Model.MonetaryAmount.t, default: nil) - Maximum amount that can be refunded for this return item.
  • returnItemId (type: String.t, default: nil) - Unit level ID for the return item. Different units of the same product will have different IDs.
  • returnShipmentIds (type: list(String.t), default: nil) - IDs of the return shipments that this return item belongs to.
  • shipmentGroupId (type: String.t, default: nil) - ID of the original shipment group. Provided for shipments with invoice support.
  • shipmentUnitId (type: String.t, default: nil) - ID of the shipment unit assigned by the merchant. Provided for shipments with invoice support.
  • state (type: String.t, default: nil) - State of the item. Acceptable values are: - "canceled" - "new" - "received" - "refunded" - "rejected"

Attributes

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

Performance metrics. Values are only set for metrics requested explicitly in the request's search query.

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.

Attributes

  • priceAmount (type: GoogleApi.Content.V21.Model.Price.t, default: nil) - The pre-tax or post-tax price depends on the location of the order. - For countries (e.g. US) where price attribute excludes tax, this field corresponds to the pre-tax value. - For coutries (e.g. France) where price attribute includes tax, this field corresponds to the post-tax value .
  • taxAmount (type: GoogleApi.Content.V21.Model.Price.t, default: nil) - Tax value, present only for countries where price attribute excludes tax (e.g. US). No tax is referenced as 0 value with the corresponding currency.

Request message for the OnboardProgram method.

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

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. Acceptable values are: - "customer" - "googleBot" - "googleCustomerService" - "googlePayments" - "googleSabre" - "merchant"
  • creationDate (type: String.t, default: nil) - Date on which the cancellation has been created, in ISO 8601 format.
  • quantity (type: integer(), default: nil) - The quantity that was canceled.
  • reason (type: String.t, default: nil) - The reason for the cancellation. Orders that are canceled with a noInventory reason will lead to the removal of the product from Buy on Google until you make an update to that product. This will not affect your Shopping ads. Acceptable values are: - "autoPostInternal" - "autoPostInvalidBillingAddress" - "autoPostNoInventory" - "autoPostPriceError" - "autoPostUndeliverableShippingAddress" - "couponAbuse" - "customerCanceled" - "customerInitiatedCancel" - "customerSupportRequested" - "failToPushOrderGoogleError" - "failToPushOrderMerchantError" - "failToPushOrderMerchantFulfillmentError" - "failToPushOrderToMerchant" - "failToPushOrderToMerchantOutOfStock" - "invalidCoupon" - "malformedShippingAddress" - "merchantDidNotShipOnTime" - "noInventory" - "orderTimeout" - "other" - "paymentAbuse" - "paymentDeclined" - "priceError" - "returnRefundAbuse" - "shippingPriceError" - "taxError" - "undeliverableShippingAddress" - "unsupportedPoBoxAddress"
  • reasonText (type: String.t, default: nil) - The explanation of the reason.

Attributes

  • fullName (type: String.t, default: nil) - Full name of the customer.
  • invoiceReceivingEmail (type: String.t, default: nil) - Email address for the merchant to send value-added tax or invoice documentation of the order. Only the last document sent is made available to the customer. For more information, see About automated VAT invoicing for Buy on Google.
  • 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. Acceptable values are: - "denied" - "granted"
  • lastUpdatedTimestamp (type: String.t, default: nil) - Timestamp when last time marketing preference was updated. Could be empty, if user wasn't offered a selection yet.
  • marketingEmailAddress (type: String.t, default: nil) - Email address that can be used for marketing purposes. The field may be empty even if explicitMarketingPreference is 'granted'. This happens when retrieving an old order from the customer who deleted their account.

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. Acceptable values are: - "promotion"

Attributes

  • brand (type: String.t, default: nil) - Brand of the item.
  • condition (type: String.t, default: nil) - Condition or state of the item. Acceptable values are: - "new" - "refurbished" - "used"
  • contentLanguage (type: String.t, default: nil) - The two-letter ISO 639-1 language code for the item.
  • fees (type: list(GoogleApi.Content.V21.Model.OrderLineItemProductFee.t), default: nil) - Associated fees at order creation time.
  • gtin (type: String.t, default: nil) - Global Trade Item Number (GTIN) of the item.
  • id (type: String.t, default: nil) - The REST ID of the product.
  • imageLink (type: String.t, default: nil) - URL of an image of the item.
  • itemGroupId (type: String.t, default: nil) - Shared identifier for all variants of the same product.
  • mpn (type: String.t, default: nil) - Manufacturer Part Number (MPN) of the item.
  • offerId (type: String.t, default: nil) - An identifier of the item.
  • price (type: GoogleApi.Content.V21.Model.Price.t, default: nil) - Price of the item.
  • shownImage (type: String.t, default: nil) - URL to the cached image shown to the user when order was placed.
  • targetCountry (type: String.t, default: nil) - The CLDR territory // code of the target country of the product.
  • title (type: String.t, default: nil) - The title of the product.
  • variantAttributes (type: list(GoogleApi.Content.V21.Model.OrderLineItemProductVariantAttribute.t), default: nil) - Variant attributes for the item. These are dimensions of the product, such as color, gender, material, pattern, and size. You can find a comprehensive list of variant attributes here.

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.
  • pickupPromiseInMinutes (type: integer(), default: nil) - The promised time in minutes in which the order will be ready for pickup. This only applies to buy-online-pickup-in-store same-day order.
  • 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. Acceptable values are: - "delivery" - "pickup"

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

  • key (type: String.t, default: nil) - Key for additional google provided (as key-value pairs) annotation.
  • value (type: String.t, default: nil) - Value for additional google provided (as key-value pairs) annotation.

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.
  • pickupType (type: String.t, default: nil) - The pickup type of this order. Acceptable values are: - "merchantStore" - "merchantStoreCurbside" - "merchantStoreLocker" - "thirdPartyPickupPoint" - "thirdPartyLocker"

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 that this promotion may be applied to. If empty, there are no restrictions on applicable items and quantity. This field will also be empty for shipping promotions because shipping is not tied to any specific item.
  • appliedItems (type: list(GoogleApi.Content.V21.Model.OrderPromotionItem.t), default: nil) - Items that this promotion have been applied to. Do not provide for orders.createtestorder. This field will be empty for shipping promotions because shipping is not tied to any specific item.
  • endTime (type: String.t, default: nil) - Promotion end time in ISO 8601 format. Date, time, and offset required, e.g., "2020-01-02T09:00:00+01:00" or "2020-01-02T09:00:00Z".
  • funder (type: String.t, default: nil) - Required. The party funding the promotion. Only merchant is supported for orders.createtestorder. Acceptable values are: - "google" - "merchant"
  • merchantPromotionId (type: String.t, default: nil) - Required. This field is used to identify promotions within merchants' own systems.
  • priceValue (type: GoogleApi.Content.V21.Model.Price.t, default: nil) - Estimated discount applied to price. Amount is pre-tax or post-tax depending on location of order.
  • shortTitle (type: String.t, default: nil) - A short title of the promotion to be shown on the checkout page. Do not provide for orders.createtestorder.
  • startTime (type: String.t, default: nil) - Promotion start time in ISO 8601 format. Date, time, and offset required, e.g., "2020-01-02T09:00:00+01:00" or "2020-01-02T09:00:00Z".
  • subtype (type: String.t, default: nil) - Required. The category of the promotion. Only moneyOff is supported for orders.createtestorder. Acceptable values are: - "buyMGetMoneyOff" - "buyMGetNMoneyOff" - "buyMGetNPercentOff" - "buyMGetPercentOff" - "freeGift" - "freeGiftWithItemId" - "freeGiftWithValue" - "freeShippingOvernight" - "freeShippingStandard" - "freeShippingTwoDay" - "moneyOff" - "percentOff" - "rewardPoints" - "salePrice"
  • taxValue (type: GoogleApi.Content.V21.Model.Price.t, default: nil) - Estimated discount applied to tax (if allowed by law). Do not provide for orders.createtestorder.
  • title (type: String.t, default: nil) - Required. The title of the promotion.
  • type (type: String.t, default: nil) - Required. The scope of the promotion. Only product is supported for orders.createtestorder. Acceptable values are: - "product" - "shipping"

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. Acceptable values are: - "customer" - "googleBot" - "googleCustomerService" - "googlePayments" - "googleSabre" - "merchant"
  • amount (type: GoogleApi.Content.V21.Model.Price.t, default: nil) - The amount that is refunded.
  • creationDate (type: String.t, default: nil) - Date on which the item has been created, in ISO 8601 format.
  • reason (type: String.t, default: nil) - The reason for the refund. Acceptable values are: - "adjustment" - "autoPostInternal" - "autoPostInvalidBillingAddress" - "autoPostNoInventory" - "autoPostPriceError" - "autoPostUndeliverableShippingAddress" - "couponAbuse" - "courtesyAdjustment" - "customerCanceled" - "customerDiscretionaryReturn" - "customerInitiatedMerchantCancel" - "customerSupportRequested" - "deliveredLateByCarrier" - "deliveredTooLate" - "expiredItem" - "failToPushOrderGoogleError" - "failToPushOrderMerchantError" - "failToPushOrderMerchantFulfillmentError" - "failToPushOrderToMerchant" - "failToPushOrderToMerchantOutOfStock" - "feeAdjustment" - "invalidCoupon" - "lateShipmentCredit" - "malformedShippingAddress" - "merchantDidNotShipOnTime" - "noInventory" - "orderTimeout" - "other" - "paymentAbuse" - "paymentDeclined" - "priceAdjustment" - "priceError" - "productArrivedDamaged" - "productNotAsDescribed" - "promoReallocation" - "qualityNotAsExpected" - "returnRefundAbuse" - "shippingCostAdjustment" - "shippingPriceError" - "taxAdjustment" - "taxError" - "undeliverableShippingAddress" - "unsupportedPoBoxAddress" - "wrongProductShipped"
  • reasonText (type: String.t, default: nil) - The explanation of the reason.

Order disbursement. All methods require the payment analyst role.

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. Acceptable values are: - "customer" - "googleBot" - "googleCustomerService" - "googlePayments" - "googleSabre" - "merchant"
  • creationDate (type: String.t, default: nil) - Date on which the item has been created, in ISO 8601 format.
  • quantity (type: integer(), default: nil) - Quantity that is returned.
  • reason (type: String.t, default: nil) - The reason for the return. Acceptable values are: - "customerDiscretionaryReturn" - "customerInitiatedMerchantCancel" - "deliveredTooLate" - "expiredItem" - "invalidCoupon" - "malformedShippingAddress" - "other" - "productArrivedDamaged" - "productNotAsDescribed" - "qualityNotAsExpected" - "undeliverableShippingAddress" - "unsupportedPoBoxAddress" - "wrongProductShipped"
  • reasonText (type: String.t, default: nil) - The explanation of the reason.

Attributes

  • carrier (type: String.t, default: nil) - The carrier handling the shipment. For supported carriers, Google includes the carrier name and tracking URL in emails to customers. For select supported carriers, Google also automatically updates the shipment status based on the provided shipment ID. Note: You can also use unsupported carriers, but emails to customers will not include the carrier name or tracking URL, and there will be no automatic order status updates. Supported carriers for US are: - "ups" (United Parcel Service) automatic status updates - "usps" (United States Postal Service) automatic status updates - "fedex" (FedEx) automatic status updates - "dhl" (DHL eCommerce) automatic status updates (US only) - "ontrac" (OnTrac) automatic status updates - "dhl express" (DHL Express) - "deliv" (Deliv) - "dynamex" (TForce) - "lasership" (LaserShip) - "mpx" (Military Parcel Xpress) - "uds" (United Delivery Service) - "efw" (Estes Forwarding Worldwide) - "jd logistics" (JD Logistics) - "yunexpress" (YunExpress) - "china post" (China Post) - "china ems" (China Post Express Mail Service) - "singapore post" (Singapore Post) - "pos malaysia" (Pos Malaysia) - "postnl" (PostNL) - "ptt" (PTT Turkish Post) - "eub" (ePacket) - "chukou1" (Chukou1 Logistics) - "bestex" (Best Express) - "canada post" (Canada Post) - "purolator" (Purolator) - "canpar" (Canpar) - "india post" (India Post) - "blue dart" (Blue Dart) - "delhivery" (Delhivery) - "dtdc" (DTDC) - "tpc india" (TPC India) Supported carriers for FR are: - "la poste" (La Poste) automatic status updates - "colissimo" (Colissimo by La Poste) automatic status updates - "ups" (United Parcel Service) automatic status updates - "chronopost" (Chronopost by La Poste) - "gls" (General Logistics Systems France) - "dpd" (DPD Group by GeoPost) - "bpost" (Belgian Post Group) - "colis prive" (Colis Privé) - "boxtal" (Boxtal) - "geodis" (GEODIS) - "tnt" (TNT) - "db schenker" (DB Schenker) - "aramex" (Aramex)
  • creationDate (type: String.t, default: nil) - Date on which the shipment has been created, in ISO 8601 format.
  • deliveryDate (type: String.t, default: nil) - Date on which the shipment has been delivered, in ISO 8601 format. Present only if status is delivered
  • id (type: String.t, default: nil) - The ID of the shipment.
  • lineItems (type: list(GoogleApi.Content.V21.Model.OrderShipmentLineItemShipment.t), default: nil) - The line items that are shipped.
  • scheduledDeliveryDetails (type: GoogleApi.Content.V21.Model.OrderShipmentScheduledDeliveryDetails.t, default: nil) - Delivery details of the shipment if scheduling is needed.
  • shipmentGroupId (type: String.t, default: nil) - The shipment group ID of the shipment. This is set in shiplineitems request.
  • status (type: String.t, default: nil) - The status of the shipment. Acceptable values are: - "delivered" - "readyForPickup" - "shipped" - "undeliverable"
  • trackingId (type: String.t, default: nil) - The tracking ID for 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

  • carrierPhoneNumber (type: String.t, default: nil) - The phone number of the carrier fulfilling the delivery. The phone number is formatted as the international notation in ITU-T Recommendation E.123 (e.g., "+41 44 668 1800").
  • scheduledDate (type: String.t, default: nil) - The date a shipment is scheduled for delivery, in ISO 8601 format.

Represents a merchant trade from which signals are extracted, e.g. shipping.

Represents how many items are in the shipment for the given shipment_id and line_item_id.

The shipping information for the order.

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. Acceptable values are: - "duplicate" - "executed"
  • kind (type: String.t, default: nil) - Identifies what kind of resource this is. Value: the fixed string "content#orderinvoicesCreateChargeInvoiceResponse".

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. Acceptable values are: - "duplicate" - "executed"
  • kind (type: String.t, default: nil) - Identifies what kind of resource this is. Value: the fixed string "content#orderinvoicesCreateRefundInvoiceResponse".

Attributes

  • description (type: String.t, default: nil) - Optional description of the refund reason.
  • reason (type: String.t, default: nil) - [required] Reason for the refund. Acceptable values are: - "adjustment" - "autoPostInternal" - "autoPostInvalidBillingAddress" - "autoPostNoInventory" - "autoPostPriceError" - "autoPostUndeliverableShippingAddress" - "couponAbuse" - "courtesyAdjustment" - "customerCanceled" - "customerDiscretionaryReturn" - "customerInitiatedMerchantCancel" - "customerSupportRequested" - "deliveredLateByCarrier" - "deliveredTooLate" - "expiredItem" - "failToPushOrderGoogleError" - "failToPushOrderMerchantError" - "failToPushOrderMerchantFulfillmentError" - "failToPushOrderToMerchant" - "failToPushOrderToMerchantOutOfStock" - "feeAdjustment" - "invalidCoupon" - "lateShipmentCredit" - "malformedShippingAddress" - "merchantDidNotShipOnTime" - "noInventory" - "orderTimeout" - "other" - "paymentAbuse" - "paymentDeclined" - "priceAdjustment" - "priceError" - "productArrivedDamaged" - "productNotAsDescribed" - "promoReallocation" - "qualityNotAsExpected" - "returnRefundAbuse" - "shippingCostAdjustment" - "shippingPriceError" - "taxAdjustment" - "taxError" - "undeliverableShippingAddress" - "unsupportedPoBoxAddress" - "wrongProductShipped"

Attributes

  • description (type: String.t, default: nil) - Optional description of the return reason.
  • reason (type: String.t, default: nil) - [required] Reason for the return. Acceptable values are: - "customerDiscretionaryReturn" - "customerInitiatedMerchantCancel" - "deliveredTooLate" - "expiredItem" - "invalidCoupon" - "malformedShippingAddress" - "other" - "productArrivedDamaged" - "productNotAsDescribed" - "qualityNotAsExpected" - "undeliverableShippingAddress" - "unsupportedPoBoxAddress" - "wrongProductShipped"

Attributes

  • disbursements (type: list(GoogleApi.Content.V21.Model.OrderReportDisbursement.t), default: nil) - The list of disbursements.
  • kind (type: String.t, default: nil) - 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: nil) - 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

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

Attributes

  • executionStatus (type: String.t, default: nil) - The status of the execution. Acceptable values are: - "duplicate" - "executed"
  • kind (type: String.t, default: nil) - Identifies what kind of resource this is. Value: the fixed string "content#orderreturnsAcknowledgeResponse".

Attributes

  • lineItems (type: list(GoogleApi.Content.V21.Model.OrderreturnsLineItem.t), default: nil) - The list of line items to return.
  • operationId (type: String.t, default: nil) - The ID of the operation. Unique across all operations for a given order.
  • orderId (type: String.t, default: nil) - The ID of the order.
  • returnMethodType (type: String.t, default: nil) - The way of the package being returned.

Attributes

  • executionStatus (type: String.t, default: nil) - The status of the execution. Acceptable values are: - "duplicate" - "executed"
  • kind (type: String.t, default: nil) - Identifies what kind of resource this is. Value: the fixed string "content#orderreturnsCreateOrderReturnResponse".
  • orderReturn (type: GoogleApi.Content.V21.Model.MerchantOrderReturn.t, default: nil) - Created order return.

Attributes

  • lineItemId (type: String.t, default: nil) - The ID of the line item. This value is assigned by Google when an order is created.
  • quantity (type: integer(), default: nil) - The quantity of this line item.

Attributes

  • kind (type: String.t, default: nil) - 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

  • priceAmount (type: GoogleApi.Content.V21.Model.Price.t, default: nil) - The pre-tax or post-tax amount to be refunded, depending on the location of the order.
  • taxAmount (type: GoogleApi.Content.V21.Model.Price.t, default: nil) - Tax amount to be refunded. Note: This has different meaning depending on the location of the order.

Attributes

  • fullChargeReturnShippingCost (type: boolean(), default: nil) - Option to charge the customer return shipping cost.
  • operationId (type: String.t, default: nil) - [required] The ID of the operation, unique across all operations for a given order return.
  • refundShippingFee (type: GoogleApi.Content.V21.Model.OrderreturnsRefundOperation.t, default: nil) - Refunds for original shipping fee.
  • returnItems (type: list(GoogleApi.Content.V21.Model.OrderreturnsReturnItem.t), default: nil) - The list of items to return.

Attributes

  • executionStatus (type: String.t, default: nil) - The status of the execution. Acceptable values are: - "duplicate" - "executed"
  • kind (type: String.t, default: nil) - Identifies what kind of resource this is. Value: the fixed string "content#orderreturnsProcessResponse".

Attributes

  • fullRefund (type: boolean(), default: nil) - If true, the item will be fully refunded. Allowed only when payment_type is FOP. Merchant can choose this refund option to indicate the full remaining amount of corresponding object to be refunded to the customer via FOP.
  • partialRefund (type: GoogleApi.Content.V21.Model.OrderreturnsPartialRefund.t, default: nil) - If this is set, the item will be partially refunded. Merchant can choose this refund option to specify the customized amount that to be refunded to the customer.
  • paymentType (type: String.t, default: nil) - The payment way of issuing refund. Default value is ORIGINAL_FOP if not set.
  • reasonText (type: String.t, default: nil) - The explanation of the reason.
  • returnRefundReason (type: String.t, default: nil) - Code of the refund reason.

Attributes

  • reason (type: String.t, default: nil) - The reason for the return.
  • reasonText (type: String.t, default: nil) - The explanation of the reason.

Attributes

  • refund (type: GoogleApi.Content.V21.Model.OrderreturnsRefundOperation.t, default: nil) - Refunds the item.
  • reject (type: GoogleApi.Content.V21.Model.OrderreturnsRejectOperation.t, default: nil) - Rejects the item.
  • returnItemId (type: String.t, default: nil) - Unit level ID for the return item. Different units of the same product will have different IDs.

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. Acceptable values are: - "duplicate" - "executed"
  • kind (type: String.t, default: nil) - Identifies what kind of resource this is. Value: the fixed string "content#ordersAcknowledgeResponse".

Attributes

  • kind (type: String.t, default: nil) - 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.
  • 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 cancel. This is the REST ID used in the products service. Either lineItemId or productId is required.
  • quantity (type: integer(), default: nil) - The quantity to cancel.
  • reason (type: String.t, default: nil) - The reason for the cancellation. Acceptable values are: - "customerInitiatedCancel" - "invalidCoupon" - "malformedShippingAddress" - "noInventory" - "other" - "priceError" - "shippingPriceError" - "taxError" - "undeliverableShippingAddress" - "unsupportedPoBoxAddress"
  • reasonText (type: String.t, default: nil) - The explanation of the reason.

Attributes

  • executionStatus (type: String.t, default: nil) - The status of the execution. Acceptable values are: - "duplicate" - "executed"
  • kind (type: String.t, default: nil) - Identifies what kind of resource this is. Value: the fixed string "content#ordersCancelLineItemResponse".

Attributes

  • operationId (type: String.t, default: nil) - The ID of the operation. Unique across all operations for a given order.
  • reason (type: String.t, default: nil) - The reason for the cancellation. Acceptable values are: - "customerInitiatedCancel" - "invalidCoupon" - "malformedShippingAddress" - "noInventory" - "other" - "priceError" - "shippingPriceError" - "taxError" - "undeliverableShippingAddress" - "unsupportedPoBoxAddress"
  • reasonText (type: String.t, default: nil) - The explanation of the reason.

Attributes

  • executionStatus (type: String.t, default: nil) - The status of the execution. Acceptable values are: - "duplicate" - "executed"
  • kind (type: String.t, default: nil) - Identifies what kind of resource this is. Value: the fixed string "content#ordersCancelResponse".

Attributes

  • reason (type: String.t, default: nil) - The reason for the cancellation. Acceptable values are: - "changedMind" - "orderedWrongItem" - "other"

Attributes

  • kind (type: String.t, default: nil) - 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. Acceptable values are: - "US" - "FR" Defaults to US.
  • templateName (type: String.t, default: nil) - The test order template to use. Specify as an alternative to testOrder as a shortcut for retrieving a template and then creating an order using that template. Acceptable values are: - "template1" - "template1a" - "template1b" - "template2" - "template3"
  • testOrder (type: GoogleApi.Content.V21.Model.TestOrder.t, default: nil) - The test order to create.

Attributes

  • kind (type: String.t, default: nil) - 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: nil) - 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

  • amount (type: GoogleApi.Content.V21.Model.MonetaryAmount.t, default: nil) - The total amount that is refunded. (e.g. refunding $5 each for 2 products should be done by setting quantity to 2 and amount to 10$) In case of multiple refunds, this should be the amount you currently want to refund to the customer.
  • fullRefund (type: boolean(), default: nil) - If true, the full item will be refunded. If this is true, amount should not be provided and will be ignored.
  • lineItemId (type: String.t, default: nil) - The ID of the line item. Either lineItemId or productId is required.
  • productId (type: String.t, default: nil) - The ID of the product. This is the REST ID used in the products service. Either lineItemId or productId is required.
  • quantity (type: integer(), default: nil) - The number of products that are refunded.

Attributes

  • amount (type: GoogleApi.Content.V21.Model.Price.t, default: nil) - The amount that is refunded. If this is not the first refund for the shipment, this should be the newly refunded amount.
  • fullRefund (type: boolean(), default: nil) - If set to true, all shipping costs for the order will be refunded. If this is true, amount should not be provided and will be ignored. If set to false, submit the amount of the partial shipping refund, excluding the shipping tax. The shipping tax is calculated and handled on Google's side.

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.

ScheduledDeliveryDetails used to update the scheduled delivery order.

Attributes

  • kind (type: String.t, default: nil) - 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: nil) - 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.
  • operationId (type: String.t, default: nil) - The ID of the operation. Unique across all operations for a given order.
  • priceAmount (type: GoogleApi.Content.V21.Model.Price.t, default: nil) - The amount to be refunded. This may be pre-tax or post-tax depending on the location of the order. Required.
  • productId (type: String.t, default: nil) - The ID of the product to return. This is the REST ID used in the products service. Either lineItemId or productId is required.
  • quantity (type: integer(), default: nil) - The quantity to return and refund.
  • reason (type: String.t, default: nil) - The reason for the return. Acceptable values are: - "customerDiscretionaryReturn" - "customerInitiatedMerchantCancel" - "deliveredTooLate" - "expiredItem" - "invalidCoupon" - "malformedShippingAddress" - "other" - "productArrivedDamaged" - "productNotAsDescribed" - "qualityNotAsExpected" - "undeliverableShippingAddress" - "unsupportedPoBoxAddress" - "wrongProductShipped"
  • reasonText (type: String.t, default: nil) - The explanation of the reason.
  • taxAmount (type: GoogleApi.Content.V21.Model.Price.t, default: nil) - The amount of tax to be refunded. Required.

Attributes

  • executionStatus (type: String.t, default: nil) - The status of the execution. Acceptable values are: - "duplicate" - "executed"
  • kind (type: String.t, default: nil) - Identifies what kind of resource this is. Value: the fixed string "content#ordersInStoreRefundLineItemResponse".

Attributes

  • kind (type: String.t, default: nil) - 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

  • items (type: list(GoogleApi.Content.V21.Model.OrdersCustomBatchRequestEntryRefundItemItem.t), default: nil) - The items that are refunded. Either Item or Shipping must be provided in the request.
  • operationId (type: String.t, default: nil) - The ID of the operation. Unique across all operations for a given order.
  • reason (type: String.t, default: nil) - The reason for the refund. Acceptable values are: - "shippingCostAdjustment" - "priceAdjustment" - "taxAdjustment" - "feeAdjustment" - "courtesyAdjustment" - "adjustment" - "customerCancelled" - "noInventory" - "productNotAsDescribed" - "undeliverableShippingAddress" - "wrongProductShipped" - "lateShipmentCredit" - "deliveredLateByCarrier" - "productArrivedDamaged"
  • reasonText (type: String.t, default: nil) - The explanation of the reason.
  • shipping (type: GoogleApi.Content.V21.Model.OrdersCustomBatchRequestEntryRefundItemShipping.t, default: nil) - The refund on shipping. Optional, but either Item or Shipping must be provided in the request.

Attributes

  • executionStatus (type: String.t, default: nil) - The status of the execution. Acceptable values are: - "duplicate" - "executed"
  • kind (type: String.t, default: nil) - Identifies what kind of resource this is. Value: the fixed string "content#ordersRefundItemResponse".

Attributes

  • amount (type: GoogleApi.Content.V21.Model.MonetaryAmount.t, default: nil) - The amount that is refunded. If this is not the first refund for the order, this should be the newly refunded amount.
  • fullRefund (type: boolean(), default: nil) - If true, the full order will be refunded, including shipping. If this is true, amount should not be provided and will be ignored.
  • operationId (type: String.t, default: nil) - The ID of the operation. Unique across all operations for a given order.
  • reason (type: String.t, default: nil) - The reason for the refund. Acceptable values are: - "courtesyAdjustment" - "other"
  • reasonText (type: String.t, default: nil) - The explanation of the reason.

Attributes

  • executionStatus (type: String.t, default: nil) - The status of the execution. Acceptable values are: - "duplicate" - "executed"
  • kind (type: String.t, default: nil) - Identifies what kind of resource this is. Value: the fixed string "content#ordersRefundOrderResponse".

Attributes

  • lineItemId (type: String.t, default: nil) - The ID of the line item to return. 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 return. This is the REST ID used in the products service. Either lineItemId or productId is required.
  • quantity (type: integer(), default: nil) - The quantity to return and refund.
  • reason (type: String.t, default: nil) - The reason for the return. Acceptable values are: - "damagedOrUsed" - "missingComponent" - "notEligible" - "other" - "outOfReturnWindow"
  • reasonText (type: String.t, default: nil) - The explanation of the reason.

Attributes

  • executionStatus (type: String.t, default: nil) - The status of the execution. Acceptable values are: - "duplicate" - "executed"
  • kind (type: String.t, default: nil) - Identifies what kind of resource this is. Value: the fixed string "content#ordersRejectReturnLineItemResponse".

Attributes

  • lineItemId (type: String.t, default: nil) - The ID of the line item to return. 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.
  • priceAmount (type: GoogleApi.Content.V21.Model.Price.t, default: nil) - The amount to be refunded. This may be pre-tax or post-tax depending on the location of the order. If omitted, refundless return is assumed.
  • productId (type: String.t, default: nil) - The ID of the product to return. This is the REST ID used in the products service. Either lineItemId or productId is required.
  • quantity (type: integer(), default: nil) - The quantity to return and refund. Quantity is required.
  • reason (type: String.t, default: nil) - The reason for the return. Acceptable values are: - "customerDiscretionaryReturn" - "customerInitiatedMerchantCancel" - "deliveredTooLate" - "expiredItem" - "invalidCoupon" - "malformedShippingAddress" - "other" - "productArrivedDamaged" - "productNotAsDescribed" - "qualityNotAsExpected" - "undeliverableShippingAddress" - "unsupportedPoBoxAddress" - "wrongProductShipped"
  • reasonText (type: String.t, default: nil) - The explanation of the reason.
  • taxAmount (type: GoogleApi.Content.V21.Model.Price.t, default: nil) - The amount of tax to be refunded. Optional, but if filled, then priceAmount must be set. Calculated automatically if not provided.

Attributes

  • executionStatus (type: String.t, default: nil) - The status of the execution. Acceptable values are: - "duplicate" - "executed"
  • kind (type: String.t, default: nil) - Identifies what kind of resource this is. Value: the fixed string "content#ordersReturnRefundLineItemResponse".

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. Acceptable values are: - "duplicate" - "executed"
  • kind (type: String.t, default: nil) - Identifies what kind of resource this is. Value: the fixed string "content#ordersSetLineItemMetadataResponse".

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. Acceptable values are: - "duplicate" - "executed"
  • kind (type: String.t, default: nil) - Identifies what kind of resource this is. Value: the fixed string "content#ordersShipLineItemsResponse".

Attributes

  • deliverByDate (type: String.t, default: nil) - Updated delivery by date, in ISO 8601 format. If not specified only ship by date is updated. Provided date should be within 1 year timeframe and can not be a date in the past.
  • 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.
  • shipByDate (type: String.t, default: nil) - Updated ship by date, in ISO 8601 format. If not specified only deliver by date is updated. Provided date should be within 1 year timeframe and can not be a date in the past.

Attributes

  • executionStatus (type: String.t, default: nil) - The status of the execution. Acceptable values are: - "duplicate" - "executed"
  • kind (type: String.t, default: nil) - Identifies what kind of resource this is. Value: the fixed string "content#ordersUpdateLineItemShippingDetailsResponse".

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. Acceptable values are: - "duplicate" - "executed"
  • kind (type: String.t, default: nil) - Identifies what kind of resource this is. Value: the fixed string "content#ordersUpdateMerchantOrderIdResponse".

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.
  • deliveryDate (type: String.t, default: nil) - Date on which the shipment has been delivered, in ISO 8601 format. Optional and can be provided only if status is delivered.
  • lastPickupDate (type: String.t, default: nil) - Date after which the pickup will expire, in ISO 8601 format. Required only when order is buy-online-pickup-in-store(BOPIS) and status is ready for pickup.
  • operationId (type: String.t, default: nil) - The ID of the operation. Unique across all operations for a given order.
  • readyPickupDate (type: String.t, default: nil) - Date on which the shipment has been ready for pickup, in ISO 8601 format. Optional and can be provided only if status is ready for pickup.
  • scheduledDeliveryDetails (type: GoogleApi.Content.V21.Model.OrdersCustomBatchRequestEntryUpdateShipmentScheduledDeliveryDetails.t, default: nil) - Delivery details of the shipment if scheduling is needed.
  • shipmentId (type: String.t, default: nil) - The ID of the shipment.
  • status (type: String.t, default: nil) - New status for the shipment. Not updated if missing. Acceptable values are: - "delivered" - "undeliverable" - "readyForPickup"
  • trackingId (type: String.t, default: nil) - The tracking ID for the shipment. Not updated if missing.
  • undeliveredDate (type: String.t, default: nil) - Date on which the shipment has been undeliverable, in ISO 8601 format. Optional and can be provided only if status is undeliverable.

Attributes

  • executionStatus (type: String.t, default: nil) - The status of the execution. Acceptable values are: - "duplicate" - "executed"
  • kind (type: String.t, default: nil) - Identifies what kind of resource this is. Value: the fixed string "content#ordersUpdateShipmentResponse".

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.
  • inventory (type: GoogleApi.Content.V21.Model.PosInventory.t, default: nil) - The inventory to submit. This should be set only if the method is inventory.
  • merchantId (type: String.t, default: nil) - The ID of the POS data provider.
  • method (type: String.t, default: nil) - The method of the batch entry. Acceptable values are: - "delete" - "get" - "insert" - "inventory" - "sale"
  • sale (type: GoogleApi.Content.V21.Model.PosSale.t, default: nil) - The sale information to submit. This should be set only if the method is sale.
  • store (type: GoogleApi.Content.V21.Model.PosStore.t, default: nil) - The store information to submit. This should be set only if the method is insert.
  • storeCode (type: String.t, default: nil) - The store code. This should be set only if the method is delete or get.
  • targetMerchantId (type: String.t, default: nil) - The ID of the account for which to get/submit data.

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: nil) - 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: nil) - 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: nil) - 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: nil) - 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: nil) - 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.

The price represented as a number and currency.

Required product attributes are primarily defined by the products data specification. See the Products Data Specification Help Center article for information. Some attributes are country-specific, so make sure you select the appropriate country in the drop-down selector at the top of the page. Product data. After inserting, updating, or deleting a product, it may take several minutes before changes take effect.

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

  • attributeName (type: String.t, default: nil) - The name of the product detail.
  • attributeValue (type: String.t, default: nil) - The value of the product detail.
  • sectionName (type: String.t, default: nil) - The section header used to group a set of product details.

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

  • approvedCountries (type: list(String.t), default: nil) - List of country codes (ISO 3166-1 alpha-2) where the offer is approved.
  • destination (type: String.t, default: nil) - The name of the destination
  • disapprovedCountries (type: list(String.t), default: nil) - List of country codes (ISO 3166-1 alpha-2) where the offer is disapproved.
  • pendingCountries (type: list(String.t), default: nil) - List of country codes (ISO 3166-1 alpha-2) where the offer is pending approval.
  • status (type: String.t, default: nil) - Destination approval status in targetCountry of the offer.

Attributes

  • applicableCountries (type: list(String.t), default: nil) - List of country codes (ISO 3166-1 alpha-2) where issue applies to the offer.
  • 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

  • amount (type: GoogleApi.Content.V21.Model.Price.t, default: nil) - The amount the buyer has to pay per subscription period.
  • period (type: String.t, default: nil) - The type of subscription period.
  • periodLength (type: String.t, default: nil) - The number of subscription periods the buyer has to pay.

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) - Should be 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: nil) - 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: nil) - 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: nil) - 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: nil) - 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.

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. Acceptable values are: - "adjustment" - "autoPostInternal" - "autoPostInvalidBillingAddress" - "autoPostNoInventory" - "autoPostPriceError" - "autoPostUndeliverableShippingAddress" - "couponAbuse" - "courtesyAdjustment" - "customerCanceled" - "customerDiscretionaryReturn" - "customerInitiatedMerchantCancel" - "customerSupportRequested" - "deliveredLateByCarrier" - "deliveredTooLate" - "expiredItem" - "failToPushOrderGoogleError" - "failToPushOrderMerchantError" - "failToPushOrderMerchantFulfillmentError" - "failToPushOrderToMerchant" - "failToPushOrderToMerchantOutOfStock" - "feeAdjustment" - "invalidCoupon" - "lateShipmentCredit" - "malformedShippingAddress" - "merchantDidNotShipOnTime" - "noInventory" - "orderTimeout" - "other" - "paymentAbuse" - "paymentDeclined" - "priceAdjustment" - "priceError" - "productArrivedDamaged" - "productNotAsDescribed" - "promoReallocation" - "qualityNotAsExpected" - "returnRefundAbuse" - "shippingCostAdjustment" - "shippingPriceError" - "taxAdjustment" - "taxError" - "undeliverableShippingAddress" - "unsupportedPoBoxAddress" - "wrongProductShipped"

Represents a geographic region that you can use as a target with both the RegionalInventory and ShippingSettings services. You can define regions as collections of either postal codes or, in some countries, using predefined geotargets.

A list of geotargets that defines the region area.

A list of postal codes that defines the region area. Note: All regions defined using postal codes are accessible via the account's ShippingSettings.postalCodeGroups resource.

A range of postal codes that defines the region area.

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: nil) - Identifies what kind of resource this is. Value: the fixed string "content#regionalinventoryCustomBatchResponse".

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

Result row returned from the search query.

Resource that represents a daily Repricing product report. Each report contains stats for a single type of Repricing rule for a single product on a given day. If there are multiple rules of the same type for the product on that day, the report lists all the rules by rule ids, combines the stats, and paginates the results by date. To retrieve the stats of a particular rule, provide the rule_id in the request.

Stats specific to buybox winning rules for product report.

Represents a repricing rule. A repricing rule is used by shopping serving to adjust transactable offer prices if conditions are met. Next ID: 24

A repricing rule that changes the sale price based on cost of goods sale.

Attributes

  • fixedTimePeriods (type: list(GoogleApi.Content.V21.Model.RepricingRuleEffectiveTimeFixedTimePeriod.t), default: nil) - A list of fixed time periods combined with OR. The maximum number of entries is limited to 5.

Matcher that specifies eligible offers. When the USE_FEED_ATTRIBUTE option is selected, only the repricing_rule_id attribute on the product feed is used to specify offer-rule mapping. When the CUSTOM_FILTER option is selected, only the *_matcher fields are used to filter the offers for offer-rule mapping. If the CUSTOM_FILTER option is selected, an offer needs to satisfy each custom filter matcher to be eligible for a rule. Size limit: the sum of the number of entries in all the matchers should not exceed 20. For example, there can be 15 product ids and 5 brands, but not 10 product ids and 11 brands.

Resource that represents a daily Repricing rule report. Next ID: 11

Stats specific to buybox winning rules for rule report.

Definition of a rule restriction. At least one of the following needs to be true: (1) use_auto_pricing_min_price is true (2) floor.price_delta exists (3) floor.percentage_delta exists If floor.price_delta and floor.percentage_delta are both set on a rule, the highest value will be chosen by the Repricer. In other words, for a product with a price of $50, if the floor.percentage_delta is "-10" and the floor.price_delta is "-12", the offer price will only be lowered $5 (10% lower than the original offer price).

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.

Return policy online object. This is currently used to represent return policies for ads and free listings programs.

The restocking fee. This can either be a fixed fee or a micro percent.

The return shipping fee. This can either be a fixed fee or a boolean to indicate that the customer pays the actual shipping cost.

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. Acceptable values are: - "lastReturnDate" - "lifetimeReturns" - "noReturns" - "numberOfDaysAfterDelivery"

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

  • chargeReturnShippingFee (type: boolean(), default: nil) - Default option for whether merchant should charge the customer for return shipping costs, based on customer selected return reason and merchant's return policy for the items being returned.
  • maxReturnShippingFee (type: GoogleApi.Content.V21.Model.MonetaryAmount.t, default: nil) - Maximum return shipping costs that may be charged to the customer depending on merchant's assessment of the return reason and the merchant's return policy for the items being returned.
  • refundableItemsTotalAmount (type: GoogleApi.Content.V21.Model.MonetaryAmount.t, default: nil) - Total amount that can be refunded for the items in this return. It represents the total amount received by the merchant for the items, after applying merchant coupons.
  • refundableShippingAmount (type: GoogleApi.Content.V21.Model.MonetaryAmount.t, default: nil) - Maximum amount that can be refunded for the original shipping fee.
  • totalRefundedAmount (type: GoogleApi.Content.V21.Model.MonetaryAmount.t, default: nil) - Total amount already refunded by the merchant. It includes all types of refunds (items, shipping, etc.) Not provided if no refund has been applied yet.

Attributes

  • creationDate (type: String.t, default: nil) - The date of creation of the shipment, in ISO 8601 format.
  • deliveryDate (type: String.t, default: nil) - The date of delivery of the shipment, in ISO 8601 format.
  • returnMethodType (type: String.t, default: nil) - Type of the return method. Acceptable values are: - "byMail" - "contactCustomerSupport" - "returnless" - "inStore"
  • shipmentId (type: String.t, default: nil) - Shipment ID generated by Google.
  • shipmentTrackingInfos (type: list(GoogleApi.Content.V21.Model.ShipmentTrackingInfo.t), default: nil) - Tracking information of the shipment. One return shipment might be handled by several shipping carriers sequentially.
  • shippingDate (type: String.t, default: nil) - The date of shipping of the shipment, in ISO 8601 format.
  • state (type: String.t, default: nil) - State of the shipment. Acceptable values are: - "completed" - "new" - "shipped" - "undeliverable" - "pending"

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.
  • merchantId (type: String.t, default: nil) - The Merchant Center account ID.
  • method (type: String.t, default: nil) - Method of the batch request entry. Acceptable values are: - "delete" - "get" - "insert"
  • returnAddress (type: GoogleApi.Content.V21.Model.ReturnAddress.t, default: nil) - The return address to submit. This should be set only if the method is insert.
  • returnAddressId (type: String.t, default: nil) - The return address ID. This should be set only if the method is delete or get.

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: nil) - 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: nil) - 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: nil) - 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.
  • merchantId (type: String.t, default: nil) - The Merchant Center account ID.
  • method (type: String.t, default: nil) - Method of the batch request entry. Acceptable values are: - "delete" - "get" - "insert"
  • returnPolicy (type: GoogleApi.Content.V21.Model.ReturnPolicy.t, default: nil) - The return policy to submit. This should be set only if the method is insert.
  • returnPolicyId (type: String.t, default: nil) - The return policy ID. This should be set only if the method is delete or get.

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: nil) - 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: nil) - 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: nil) - 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.

Request message for the ReportService.Search method.

Response message for the ReportService.Search method.

Dimensions according to which metrics are segmented in the response. Values of product dimensions, e.g., offer id, reflect the state of a product at the time of the corresponding event, e.g., impression or order. Segment fields cannot be selected in queries without also selecting at least one metric field. Values are only set for dimensions requested explicitly in the request's search query.

Attributes

  • active (type: boolean(), default: nil) - A boolean exposing the active status of the shipping service. Required.
  • currency (type: String.t, default: nil) - The CLDR code of the currency to which this service applies. Must match that of the prices in rate groups.
  • deliveryCountry (type: String.t, default: nil) - The CLDR territory code of the country to which the service applies. Required.
  • deliveryTime (type: GoogleApi.Content.V21.Model.DeliveryTime.t, default: nil) - Time spent in various aspects from order to the delivery of the product. Required.
  • eligibility (type: String.t, default: nil) - Eligibility for this service. Acceptable values are: - "All scenarios" - "All scenarios except Shopping Actions" - "Shopping Actions"
  • minimumOrderValue (type: GoogleApi.Content.V21.Model.Price.t, default: nil) - Minimum order value for this service. If set, indicates that customers will have to spend at least this amount. All prices within a service must have the same currency. Cannot be set together with minimum_order_value_table.
  • minimumOrderValueTable (type: GoogleApi.Content.V21.Model.MinimumOrderValueTable.t, default: nil) - Table of per store minimum order values for the pickup fulfillment type. Cannot be set together with minimum_order_value.
  • name (type: String.t, default: nil) - Free-form name of the service. Must be unique within target account. Required.
  • pickupService (type: GoogleApi.Content.V21.Model.PickupCarrierService.t, default: nil) - The carrier-service pair delivering items to collection points. The list of supported pickup services can be retrieved via the getSupportedPickupServices method. Required if and only if the service delivery type is pickup.
  • rateGroups (type: list(GoogleApi.Content.V21.Model.RateGroup.t), default: nil) - Shipping rate group definitions. Only the last one is allowed to have an empty applicableShippingLabels, which means "everything else". The other applicableShippingLabels must not overlap.
  • shipmentType (type: String.t, default: nil) - Type of locations this service ships orders to. Acceptable values are: - "delivery" - "pickup"

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.

Attributes

  • commission (type: GoogleApi.Content.V21.Model.SettlementTransactionAmountCommission.t, default: nil) -
  • description (type: String.t, default: nil) - The description of the event. Acceptable values are: - "taxWithhold" - "principal" - "principalAdjustment" - "shippingFee" - "merchantRemittedSalesTax" - "googleRemittedSalesTax" - "merchantCoupon" - "merchantCouponTax" - "merchantRemittedDisposalTax" - "googleRemittedDisposalTax" - "merchantRemittedRedemptionFee" - "googleRemittedRedemptionFee" - "eeeEcoFee" - "furnitureEcoFee" - "copyPrivateFee" - "eeeEcoFeeCommission" - "furnitureEcoFeeCommission" - "copyPrivateFeeCommission" - "principalRefund" - "principalRefundTax" - "itemCommission" - "adjustmentCommission" - "shippingFeeCommission" - "commissionRefund" - "damaged" - "damagedOrDefectiveItem" - "expiredItem" - "faultyItem" - "incorrectItemReceived" - "itemMissing" - "qualityNotExpected" - "receivedTooLate" - "storePackageMissing" - "transitPackageMissing" - "unsuccessfulDeliveryUndeliverable" - "wrongChargeInStore" - "wrongItem" - "returns" - "undeliverable" - "refundFromMerchant" - "returnLabelShippingFee" - "pspFee"
  • transactionAmount (type: GoogleApi.Content.V21.Model.Price.t, default: nil) - The amount that contributes to the line item price.
  • type (type: String.t, default: nil) - The type of the amount. Acceptable values are: - "itemPrice" - "orderPrice" - "refund" - "earlyRefund" - "courtesyRefund" - "returnRefund" - "returnLabelShippingFeeAmount"

Attributes

  • category (type: String.t, default: nil) - The category of the commission. Acceptable values are: - "animalsAndPetSupplies" - "dogCatFoodAndCatLitter" - "apparelAndAccessories" - "shoesHandbagsAndSunglasses" - "costumesAndAccessories" - "jewelry" - "watches" - "hobbiesArtsAndCrafts" - "homeAndGarden" - "entertainmentCollectibles" - "collectibleCoins" - "sportsCollectibles" - "sportingGoods" - "toysAndGames" - "musicalInstruments" - "giftCards" - "babyAndToddler" - "babyFoodWipesAndDiapers" - "businessAndIndustrial" - "camerasOpticsAndPhotography" - "consumerElectronics" - "electronicsAccessories" - "personalComputers" - "videoGameConsoles" - "foodAndGrocery" - "beverages" - "tobaccoProducts" - "furniture" - "hardware" - "buildingMaterials" - "tools" - "healthAndPersonalCare" - "beauty" - "householdSupplies" - "kitchenAndDining" - "majorAppliances" - "luggageAndBags" - "media" - "officeSupplies" - "softwareAndVideoGames" - "vehiclePartsAndAccessories" - "vehicleTiresAndWheels" - "vehicles" - "everythingElse"
  • rate (type: String.t, default: nil) - Rate of the commission in percentage.

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.
  • orderItemId (type: String.t, default: nil) - The identifier of the item.
  • 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. Acceptable values are: - "order" - "reversal" - "orderRefund" - "reversalRefund" - "issueRelatedRefundAndReplacement" - "returnLabelShippingFeeTransaction" - "reversalIssueRelatedRefundAndReplacement" - "reversalReturnLabelShippingFeeTransaction" - "lumpSumCorrectionTransaction"

Attributes

  • kind (type: String.t, default: nil) - 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: nil) - 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. Acceptable values are: - "boxtal" - "bpost" - "chronopost" - "colisPrive" - "colissimo" - "cxt" - "deliv" - "dhl" - "dpd" - "dynamex" - "eCourier" - "easypost" - "efw" - "fedex" - "fedexSmartpost" - "geodis" - "gls" - "googleCourier" - "gsx" - "jdLogistics" - "laPoste" - "lasership" - "manual" - "mpx" - "onTrac" - "other" - "tnt" - "uds" - "ups" - "usps"
  • trackingNumber (type: String.t, default: nil) - The tracking number for 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: nil) - 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: nil) - 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: nil) - Identifies what kind of resource this is. Value: the fixed string "content#shippingsettingsGetSupportedHolidaysResponse".

Attributes

  • kind (type: String.t, default: nil) - 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: nil) - 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

  • deliveryDetails (type: GoogleApi.Content.V21.Model.TestOrderDeliveryDetails.t, default: nil) - Overrides the predefined delivery details if provided.
  • enableOrderinvoices (type: boolean(), default: nil) - Whether the orderinvoices service should support this order.
  • kind (type: String.t, default: nil) - Identifies what kind of resource this is. Value: the fixed string "content#testOrder"
  • lineItems (type: list(GoogleApi.Content.V21.Model.TestOrderLineItem.t), default: nil) - Required. Line items that are ordered. At least one line item must be provided.
  • notificationMode (type: String.t, default: nil) - Restricted. Do not use.
  • pickupDetails (type: GoogleApi.Content.V21.Model.TestOrderPickupDetails.t, default: nil) - Overrides the predefined pickup details if provided.
  • predefinedBillingAddress (type: String.t, default: nil) - Required. The billing address. Acceptable values are: - "dwight" - "jim" - "pam"
  • predefinedDeliveryAddress (type: String.t, default: nil) - Required. Identifier of one of the predefined delivery addresses for the delivery. Acceptable values are: - "dwight" - "jim" - "pam"
  • predefinedEmail (type: String.t, default: nil) - Required. Email address of the customer. Acceptable values are: - "pog.dwight.schrute@gmail.com" - "pog.jim.halpert@gmail.com" - "penpog.pam.beesly@gmail.comding"
  • predefinedPickupDetails (type: String.t, default: nil) - Identifier of one of the predefined pickup details. Required for orders containing line items with shipping type pickup. Acceptable values are: - "dwight" - "jim" - "pam"
  • promotions (type: list(GoogleApi.Content.V21.Model.OrderPromotion.t), default: nil) - Promotions associated with the order.
  • shippingCost (type: GoogleApi.Content.V21.Model.Price.t, default: nil) - Required. The price of shipping for all items. Shipping tax is automatically calculated for orders where marketplace facilitator tax laws are applicable. Otherwise, tax settings from Merchant Center are applied. Note that shipping is not taxed in certain states.
  • shippingOption (type: String.t, default: nil) - Required. The requested shipping option. Acceptable values are: - "economy" - "expedited" - "oneDay" - "sameDay" - "standard" - "twoDay"

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

  • address (type: GoogleApi.Content.V21.Model.TestOrderAddress.t, default: nil) - The delivery address
  • isScheduledDelivery (type: boolean(), default: nil) - Whether the order is scheduled delivery order.
  • phoneNumber (type: String.t, default: nil) - The phone number of the person receiving the delivery.

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.
  • condition (type: String.t, default: nil) - Required. Condition or state of the item. Acceptable values are: - "new"
  • contentLanguage (type: String.t, default: nil) - Required. The two-letter ISO 639-1 language code for the item. Acceptable values are: - "en" - "fr"
  • fees (type: list(GoogleApi.Content.V21.Model.OrderLineItemProductFee.t), default: nil) - Fees for the item. Optional.
  • gtin (type: String.t, default: nil) - Global Trade Item Number (GTIN) of the item. Optional.
  • imageLink (type: String.t, default: nil) - Required. URL of an image of the item.
  • itemGroupId (type: String.t, default: nil) - Shared identifier for all variants of the same product. Optional.
  • mpn (type: String.t, default: nil) - Manufacturer Part Number (MPN) of the item. Optional.
  • offerId (type: String.t, default: nil) - Required. An identifier of the item.
  • price (type: GoogleApi.Content.V21.Model.Price.t, default: nil) - Required. The price for the product. Tax is automatically calculated for orders where marketplace facilitator tax laws are applicable. Otherwise, tax settings from Merchant Center are applied.
  • targetCountry (type: String.t, default: nil) - Required. The CLDR territory // code of the target country of the product.
  • title (type: String.t, default: nil) - Required. The title of the product.
  • variantAttributes (type: list(GoogleApi.Content.V21.Model.OrderLineItemProductVariantAttribute.t), default: nil) - Variant attributes for the item. Optional.

Attributes

  • locationCode (type: String.t, default: nil) - Required. Code of the location defined by provider or merchant.
  • pickupLocationAddress (type: GoogleApi.Content.V21.Model.TestOrderAddress.t, default: nil) - Required. Pickup location address.
  • pickupLocationType (type: String.t, default: nil) - Pickup location type. Acceptable values are: - "locker" - "store" - "curbside"
  • pickupPersons (type: list(GoogleApi.Content.V21.Model.TestOrderPickupDetailsPickupPerson.t), default: nil) - Required. all pickup persons set by users.

Attributes

  • name (type: String.t, default: nil) - Required. Full name of the pickup person.
  • phoneNumber (type: String.t, default: nil) - Required. The phone number of the person picking up the items.

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. Acceptable values are: - "shipping"

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. Acceptable values are: - "otherFee" - "otherFeeTax" - "sales"

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. Acceptable values are: - "kg" - "lb"
  • value (type: String.t, default: nil) - Required. The weight represented as a number.