google_api_content v0.9.0 API Reference

Modules

API calls for all endpoints tagged Accounts.

API calls for all endpoints tagged Accountstatuses.

API calls for all endpoints tagged Accounttax.

API calls for all endpoints tagged Datafeeds.

API calls for all endpoints tagged Datafeedstatuses.

API calls for all endpoints tagged Inventory.

API calls for all endpoints tagged Liasettings.

API calls for all endpoints tagged Orderinvoices.

API calls for all endpoints tagged Orderpayments.

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.

Helper functions for deserializing responses into models.

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

Attributes

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

Attributes

  • adwordsId (String.t): Customer ID of the AdWords account. Defaults to: null.
  • status (String.t): 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. Defaults to: null.

Attributes

  • address (AccountAddress): The address of the business. Defaults to: null.
  • customerService (AccountCustomerService): The customer service information of the business. Defaults to: null.
  • phoneNumber (String.t): The phone number of the business. Defaults to: null.

Attributes

  • email (String.t): Customer service email. Defaults to: null.
  • phoneNumber (String.t): Customer service phone number. Defaults to: null.
  • url (String.t): Customer service URL. Defaults to: null.

Attributes

  • gmbEmail (String.t): 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. Defaults to: null.
  • status (String.t): Status of the link between this Merchant Center account and the GMB account. Defaults to: null.

Attributes

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

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

Attributes

  • country (String.t): Country for which this issue is reported. Defaults to: null.
  • destination (String.t): The destination the issue applies to. Defaults to: null.
  • detail (String.t): Additional details about the issue. Defaults to: null.
  • documentation (String.t): The URL of a web page to help resolving this issue. Defaults to: null.
  • id (String.t): Issue identifier. Defaults to: null.
  • severity (String.t): Severity of the issue. Defaults to: null.
  • title (String.t): Short description of the issue. Defaults to: null.

Attributes

  • country (String.t): Defaults to: null.
  • destination (String.t): Defaults to: null.
  • detail (String.t): Defaults to: null.
  • displayedValue (String.t): Defaults to: null.
  • exampleItems ([AccountStatusExampleItem]): Defaults to: null.
  • id (String.t): Defaults to: null.
  • lastChecked (String.t): Defaults to: null.
  • location (String.t): Defaults to: null.
  • numItems (integer()): Defaults to: null.
  • severity (String.t): Defaults to: null.
  • submittedValue (String.t): Defaults to: null.

Attributes

  • itemId (String.t): Defaults to: null.
  • link (String.t): Defaults to: null.
  • submittedValue (String.t): Defaults to: null.
  • title (String.t): Defaults to: null.
  • valueOnLandingPage (String.t): Defaults to: null.

Attributes

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

Attributes

  • channel (String.t): The channel the data applies to. Defaults to: null.
  • country (String.t): The country the data applies to. Defaults to: null.
  • destination (String.t): The destination the data applies to. Defaults to: null.
  • itemLevelIssues ([AccountStatusItemLevelIssue]): List of item-level issues. Defaults to: null.
  • statistics (AccountStatusStatistics): Aggregated product statistics. Defaults to: null.

Attributes

  • active (String.t): Number of active offers. Defaults to: null.
  • disapproved (String.t): Number of disapproved offers. Defaults to: null.
  • expiring (String.t): Number of expiring offers. Defaults to: null.
  • pending (String.t): Number of pending offers. Defaults to: null.

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 (boolean()): Whether user is an admin. Defaults to: null.
  • emailAddress (String.t): User's email address. Defaults to: null.
  • orderManager (boolean()): Whether user is an order manager. Defaults to: null.
  • paymentsAnalyst (boolean()): Whether user can access payment statements. Defaults to: null.
  • paymentsManager (boolean()): Whether user can manage payment settings. Defaults to: null.

Attributes

  • channelId (String.t): Channel ID. Defaults to: null.
  • status (String.t): 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. Defaults to: null.

Attributes

  • accountIdentifiers ([AccountIdentifier]): 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. Defaults to: null.
  • kind (String.t): Identifies what kind of resource this is. Value: the fixed string "content#accountsAuthInfoResponse". Defaults to: null.

Attributes

  • kind (String.t): Identifies what kind of resource this is. Value: the fixed string "content#accountsClaimWebsiteResponse". Defaults to: null.

Attributes

  • entries ([AccountsCustomBatchRequestEntry]): The request entries to be processed in the batch. Defaults to: null.

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

Attributes

  • action (String.t): Action to perform for this link. The "request" action is only available to select merchants. Defaults to: null.
  • linkType (String.t): Type of the link between the two accounts. Defaults to: null.
  • linkedAccountId (String.t): The ID of the linked account. Defaults to: null.

Attributes

  • entries ([AccountsCustomBatchResponseEntry]): The result of the execution of the batch requests. Defaults to: null.
  • kind (String.t): Identifies what kind of resource this is. Value: the fixed string "content#accountsCustomBatchResponse". Defaults to: null.

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

Attributes

  • action (String.t): Action to perform for this link. The "request" action is only available to select merchants. Defaults to: null.
  • linkType (String.t): Type of the link between the two accounts. Defaults to: null.
  • linkedAccountId (String.t): The ID of the linked account. Defaults to: null.

Attributes

  • kind (String.t): Identifies what kind of resource this is. Value: the fixed string "content#accountsLinkResponse". Defaults to: null.

Attributes

  • kind (String.t): Identifies what kind of resource this is. Value: the fixed string "content#accountsListResponse". Defaults to: null.
  • nextPageToken (String.t): The token for the retrieval of the next page of accounts. Defaults to: null.
  • resources ([Account]): Defaults to: null.

Attributes

  • entries ([AccountstatusesCustomBatchRequestEntry]): The request entries to be processed in the batch. Defaults to: null.

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

Attributes

  • entries ([AccountstatusesCustomBatchResponseEntry]): The result of the execution of the batch requests. Defaults to: null.
  • kind (String.t): Identifies what kind of resource this is. Value: the fixed string "content#accountstatusesCustomBatchResponse". Defaults to: null.

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

Attributes

  • kind (String.t): Identifies what kind of resource this is. Value: the fixed string "content#accountstatusesListResponse". Defaults to: null.
  • nextPageToken (String.t): The token for the retrieval of the next page of account statuses. Defaults to: null.
  • resources ([AccountStatus]): Defaults to: null.

Attributes

  • entries ([AccounttaxCustomBatchRequestEntry]): The request entries to be processed in the batch. Defaults to: null.

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

Attributes

  • entries ([AccounttaxCustomBatchResponseEntry]): The result of the execution of the batch requests. Defaults to: null.
  • kind (String.t): Identifies what kind of resource this is. Value: the fixed string "content#accounttaxCustomBatchResponse". Defaults to: null.

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

Attributes

  • kind (String.t): Identifies what kind of resource this is. Value: the fixed string "content#accounttaxListResponse". Defaults to: null.
  • nextPageToken (String.t): The token for the retrieval of the next page of account tax settings. Defaults to: null.
  • resources ([AccountTax]): Defaults to: null.

Attributes

  • pretax (Price): [required] Value before taxes. Defaults to: null.
  • tax (Price): [required] Tax value. Defaults to: null.

Attributes

  • carrierName (String.t): Carrier service, such as "UPS" or "Fedex". The list of supported carriers can be retrieved via the getSupportedCarriers method. Required. Defaults to: null.
  • carrierService (String.t): Carrier service, such as "ground" or "2 days". The list of supported services for a carrier can be retrieved via the getSupportedCarriers method. Required. Defaults to: null.
  • flatAdjustment (Price): 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. Defaults to: null.
  • name (String.t): Name of the carrier rate. Must be unique per rate group. Required. Defaults to: null.
  • originPostalCode (String.t): Shipping origin for this carrier rate. Required. Defaults to: null.
  • percentageAdjustment (String.t): 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. Defaults to: null.

Attributes

  • country (String.t): The CLDR country code of the carrier (e.g., "US"). Always present. Defaults to: null.
  • name (String.t): The name of the carrier (e.g., "UPS"). Always present. Defaults to: null.
  • services ([String.t]): A list of supported services (e.g., "ground") for that carrier. Contains at least one service. Defaults to: null.

Attributes

  • name (String.t): The name of the attribute. Underscores will be replaced by spaces upon insertion. Defaults to: null.
  • type (String.t): The type of the attribute. Defaults to: null.
  • unit (String.t): Free-form unit of the attribute. Unit can only be used for values of type int, float, or price. Defaults to: null.
  • value (String.t): The value of the attribute. Defaults to: null.

Attributes

  • attributes ([CustomAttribute]): The sub-attributes. Defaults to: null.
  • name (String.t): The name of the group. Underscores will be replaced by spaces upon insertion. Defaults to: null.

Attributes

  • description (String.t): Defaults to: null.
  • reasonCode (String.t): Defaults to: null.

Attributes

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

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 (String.t): 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. Defaults to: null.
  • fileEncoding (String.t): Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected. Defaults to: null.
  • quotingMode (String.t): Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds. Defaults to: null.

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 (String.t): The country where the items in the feed will be included in the search index, represented as a CLDR territory code. Defaults to: null.
  • excludedDestinations ([String.t]): The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center). Defaults to: null.
  • includedDestinations ([String.t]): 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 the excluded_destination field. Defaults to: null.
  • language (String.t): The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for targets[].country. Defaults to: null.

Attributes

  • entries ([DatafeedsCustomBatchRequestEntry]): The request entries to be processed in the batch. Defaults to: null.

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

Attributes

  • entries ([DatafeedsCustomBatchResponseEntry]): The result of the execution of the batch requests. Defaults to: null.
  • kind (String.t): Identifies what kind of resource this is. Value: the fixed string "content#datafeedsCustomBatchResponse". Defaults to: null.

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

Attributes

  • kind (String.t): Identifies what kind of resource this is. Value: the fixed string "content#datafeedsFetchNowResponse". Defaults to: null.

Attributes

  • kind (String.t): Identifies what kind of resource this is. Value: the fixed string "content#datafeedsListResponse". Defaults to: null.
  • nextPageToken (String.t): The token for the retrieval of the next page of datafeeds. Defaults to: null.
  • resources ([Datafeed]): Defaults to: null.

Attributes

  • entries ([DatafeedstatusesCustomBatchRequestEntry]): The request entries to be processed in the batch. Defaults to: null.

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

Attributes

  • entries ([DatafeedstatusesCustomBatchResponseEntry]): The result of the execution of the batch requests. Defaults to: null.
  • kind (String.t): Identifies what kind of resource this is. Value: the fixed string "content#datafeedstatusesCustomBatchResponse". Defaults to: null.

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

Attributes

  • kind (String.t): Identifies what kind of resource this is. Value: the fixed string "content#datafeedstatusesListResponse". Defaults to: null.
  • nextPageToken (String.t): The token for the retrieval of the next page of datafeed statuses. Defaults to: null.
  • resources ([DatafeedStatus]): Defaults to: null.

Attributes

  • cutoffTime (CutoffTime): Business days cutoff time definition. If not configured the cutoff time will be defaulted to 8AM PST. Defaults to: null.
  • holidayCutoffs ([HolidayCutoff]): Holiday cutoff definitions. If configured, they specify order cutoff times for holiday-specific shipping. Defaults to: null.
  • maxHandlingTimeInDays (integer()): 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. Defaults to: null.
  • maxTransitTimeInDays (integer()): 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. Defaults to: null.
  • minHandlingTimeInDays (integer()): Minimum number of business days spent before an order is shipped. 0 means same day shipped, 1 means next day shipped. Defaults to: null.
  • minTransitTimeInDays (integer()): 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. Defaults to: null.
  • transitTimeTable (TransitTable): 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. Defaults to: null.

An error returned by the API.

A list of errors returned by a failed batch entry.

Attributes

  • accountId (String.t): The ID of the account. Defaults to: null.
  • gmbAccounts ([GmbAccountsGmbAccount]): A list of GMB accounts which are available to the merchant. Defaults to: null.

Attributes

  • email (String.t): The email which identifies the GMB account. Defaults to: null.
  • listingCount (String.t): Number of listings under this account. Defaults to: null.
  • name (String.t): The name of the GMB account. Defaults to: null.
  • type (String.t): The type of the GMB account (User or Business). Defaults to: null.

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 (String.t): Date of the order deadline, in ISO 8601 format. E.g. "2016-11-29" for 29th November 2016. Required. Defaults to: null.
  • deadlineHour (integer()): 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. Defaults to: null.
  • deadlineTimezone (String.t): Timezone identifier for the deadline hour. A list of identifiers can be found in the AdWords API documentation. E.g. "Europe/Zurich". Required. Defaults to: null.
  • holidayId (String.t): Unique identifier for the holiday. Required. Defaults to: null.
  • visibleFromDate (String.t): Date on which the deadline will become visible to consumers in ISO 8601 format. E.g. "2016-10-31" for 31st October 2016. Required. Defaults to: null.

Attributes

  • countryCode (String.t): 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. Defaults to: null.
  • date (String.t): Date of the holiday, in ISO 8601 format. E.g. "2016-12-25" for Christmas 2016. Always present. Defaults to: null.
  • deliveryGuaranteeDate (String.t): 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. Defaults to: null.
  • deliveryGuaranteeHour (String.t): 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. Defaults to: null.
  • id (String.t): Unique identifier for the holiday to be used when configuring holiday cutoffs. Always present. Defaults to: null.
  • type (String.t): The holiday type. Always present. Defaults to: null.

Attributes

  • amount (Price): The amount the buyer has to pay per month. Defaults to: null.
  • months (String.t): The number of installments the buyer has to pay. Defaults to: null.

Attributes

  • availability (String.t): The availability of the product. Defaults to: null.
  • customLabel0 (String.t): Custom label 0 for custom grouping of items in a Shopping campaign. Only supported for online products. Defaults to: null.
  • customLabel1 (String.t): Custom label 1 for custom grouping of items in a Shopping campaign. Only supported for online products. Defaults to: null.
  • customLabel2 (String.t): Custom label 2 for custom grouping of items in a Shopping campaign. Only supported for online products. Defaults to: null.
  • customLabel3 (String.t): Custom label 3 for custom grouping of items in a Shopping campaign. Only supported for online products. Defaults to: null.
  • customLabel4 (String.t): Custom label 3 for custom grouping of items in a Shopping campaign. Only supported for online products. Defaults to: null.
  • installment (Installment): Number and amount of installments to pay for an item. Brazil only. Defaults to: null.
  • instoreProductLocation (String.t): The instore product location. Supported only for local products. Defaults to: null.
  • kind (String.t): Identifies what kind of resource this is. Value: the fixed string "content#inventory". Defaults to: null.
  • loyaltyPoints (LoyaltyPoints): Loyalty points that users receive after purchasing the item. Japan only. Defaults to: null.
  • pickup (InventoryPickup): 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". Defaults to: null.
  • price (Price): The price of the product. Defaults to: null.
  • quantity (integer()): The quantity of the product. Must be equal to or greater than zero. Supported only for local products. Defaults to: null.
  • salePrice (Price): The sale price of the product. Mandatory if sale_price_effective_date is defined. Defaults to: null.
  • salePriceEffectiveDate (String.t): 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. Defaults to: null.
  • sellOnGoogleQuantity (integer()): The quantity of the product that is available for selling on Google. Supported only for online products. Defaults to: null.

Attributes

  • entries ([InventoryCustomBatchRequestEntry]): The request entries to be processed in the batch. Defaults to: null.

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

Attributes

  • entries ([InventoryCustomBatchResponseEntry]): The result of the execution of the batch requests. Defaults to: null.
  • kind (String.t): Identifies what kind of resource this is. Value: the fixed string "content#inventoryCustomBatchResponse". Defaults to: null.

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

Attributes

  • pickupMethod (String.t): 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. Defaults to: null.
  • pickupSla (String.t): 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. Defaults to: null.

Attributes

  • availability (String.t): The availability of the product. Defaults to: null.
  • customLabel0 (String.t): Custom label 0 for custom grouping of items in a Shopping campaign. Only supported for online products. Defaults to: null.
  • customLabel1 (String.t): Custom label 1 for custom grouping of items in a Shopping campaign. Only supported for online products. Defaults to: null.
  • customLabel2 (String.t): Custom label 2 for custom grouping of items in a Shopping campaign. Only supported for online products. Defaults to: null.
  • customLabel3 (String.t): Custom label 3 for custom grouping of items in a Shopping campaign. Only supported for online products. Defaults to: null.
  • customLabel4 (String.t): Custom label 3 for custom grouping of items in a Shopping campaign. Only supported for online products. Defaults to: null.
  • installment (Installment): Number and amount of installments to pay for an item. Brazil only. Defaults to: null.
  • instoreProductLocation (String.t): The instore product location. Supported only for local products. Defaults to: null.
  • loyaltyPoints (LoyaltyPoints): Loyalty points that users receive after purchasing the item. Japan only. Defaults to: null.
  • pickup (InventoryPickup): 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". Defaults to: null.
  • price (Price): The price of the product. Defaults to: null.
  • quantity (integer()): The quantity of the product. Must be equal to or greater than zero. Supported only for local products. Defaults to: null.
  • salePrice (Price): The sale price of the product. Mandatory if sale_price_effective_date is defined. Defaults to: null.
  • salePriceEffectiveDate (String.t): 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. Defaults to: null.
  • sellOnGoogleQuantity (integer()): The quantity of the product that is available for selling on Google. Supported only for online products. Defaults to: null.

Attributes

  • kind (String.t): Identifies what kind of resource this is. Value: the fixed string "content#inventorySetResponse". Defaults to: null.

Attributes

  • additionalChargeSummaries ([InvoiceSummaryAdditionalChargeSummary]): Summary of the total amounts of the additional charges. Defaults to: null.
  • customerBalance (Amount): Deprecated. Defaults to: null.
  • googleBalance (Amount): Deprecated. Defaults to: null.
  • merchantBalance (Amount): Deprecated. Defaults to: null.
  • productTotal (Amount): [required] Total price for the product. Defaults to: null.
  • promotionSummaries ([Promotion]): Deprecated. Defaults to: null.

Attributes

  • totalAmount (Amount): [required] Total additional charge for this type. Defaults to: null.
  • type (String.t): [required] Type of the additional charge. Defaults to: null.

Attributes

  • status (String.t): The status of the verification process for the About page. Defaults to: null.
  • url (String.t): The URL for the About page. Defaults to: null.

Attributes

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

Attributes

  • inventoryVerificationContactEmail (String.t): The email of the contact for the inventory verification process. Defaults to: null.
  • inventoryVerificationContactName (String.t): The name of the contact for the inventory verification process. Defaults to: null.
  • inventoryVerificationContactStatus (String.t): The status of the verification contact. Defaults to: null.
  • status (String.t): The status of the inventory verification process. Defaults to: null.

Attributes

  • shippingCostPolicyUrl (String.t): Shipping cost and policy URL. Defaults to: null.
  • status (String.t): The status of the ?On display to order? feature. Defaults to: null.

Attributes

  • posDataProviderId (String.t): The ID of the POS data provider. Defaults to: null.
  • posExternalAccountId (String.t): The account ID by which this merchant is known to the POS data provider. Defaults to: null.

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

Attributes

  • entries ([LiasettingsCustomBatchRequestEntry]): The request entries to be processed in the batch. Defaults to: null.

Attributes

  • accountId (String.t): The ID of the account for which to get/update account shipping settings. Defaults to: null.
  • batchId (integer()): An entry ID, unique within the batch request. Defaults to: null.
  • contactEmail (String.t): Inventory validation contact email. Required only for SetInventoryValidationContact. Defaults to: null.
  • contactName (String.t): Inventory validation contact name. Required only for SetInventoryValidationContact. Defaults to: null.
  • country (String.t): The country code. Required only for RequestInventoryVerification. Defaults to: null.
  • gmbEmail (String.t): The GMB account. Required only for RequestGmbAccess. Defaults to: null.
  • liaSettings (LiaSettings): The account Lia settings to update. Only defined if the method is update. Defaults to: null.
  • merchantId (String.t): The ID of the managing account. Defaults to: null.
  • method (String.t): Defaults to: null.
  • posDataProviderId (String.t): The ID of POS data provider. Required only for SetPosProvider. Defaults to: null.
  • posExternalAccountId (String.t): The account ID by which this merchant is known to the POS provider. Defaults to: null.

Attributes

  • entries ([LiasettingsCustomBatchResponseEntry]): The result of the execution of the batch requests. Defaults to: null.
  • kind (String.t): Identifies what kind of resource this is. Value: the fixed string "content#liasettingsCustomBatchResponse". Defaults to: null.

Attributes

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

Attributes

  • accountId (String.t): The ID of the account. Defaults to: null.
  • gmbAccounts ([GmbAccountsGmbAccount]): A list of GMB accounts which are available to the merchant. Defaults to: null.
  • kind (String.t): Identifies what kind of resource this is. Value: the fixed string "content#liasettingsGetAccessibleGmbAccountsResponse". Defaults to: null.

Attributes

  • kind (String.t): Identifies what kind of resource this is. Value: the fixed string "content#liasettingsListPosDataProvidersResponse". Defaults to: null.
  • posDataProviders ([PosDataProviders]): The list of POS data providers for each eligible country Defaults to: null.

Attributes

  • kind (String.t): Identifies what kind of resource this is. Value: the fixed string "content#liasettingsListResponse". Defaults to: null.
  • nextPageToken (String.t): The token for the retrieval of the next page of LIA settings. Defaults to: null.
  • resources ([LiaSettings]): Defaults to: null.

Attributes

  • kind (String.t): Identifies what kind of resource this is. Value: the fixed string "content#liasettingsRequestGmbAccessResponse". Defaults to: null.

Attributes

  • kind (String.t): Identifies what kind of resource this is. Value: the fixed string "content#liasettingsRequestInventoryVerificationResponse". Defaults to: null.

Attributes

  • kind (String.t): Identifies what kind of resource this is. Value: the fixed string "content#liasettingsSetInventoryVerificationContactResponse". Defaults to: null.

Attributes

  • kind (String.t): Identifies what kind of resource this is. Value: the fixed string "content#liasettingsSetPosDataProviderResponse". Defaults to: null.

Attributes

  • locationIds ([String.t]): A non-empty list of location IDs. They must all be of the same location type (e.g., state). Defaults to: null.

Attributes

  • name (String.t): Name of loyalty points program. It is recommended to limit the name to 12 full-width characters or 24 Roman characters. Defaults to: null.
  • pointsValue (String.t): The retailer's loyalty points in absolute value. Defaults to: null.
  • ratio (float()): 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. Defaults to: null.

Attributes

  • creationDate (String.t): Defaults to: null.
  • merchantOrderId (String.t): Defaults to: null.
  • orderId (String.t): Defaults to: null.
  • orderReturnId (String.t): Defaults to: null.
  • returnItems ([MerchantOrderReturnItem]): Defaults to: null.
  • returnShipments ([ReturnShipment]): Defaults to: null.

Attributes

  • customerReturnReason (CustomerReturnReason): Defaults to: null.
  • itemId (String.t): Defaults to: null.
  • merchantReturnReason (RefundReason): Defaults to: null.
  • product (OrderLineItemProduct): Defaults to: null.
  • returnShipmentIds ([String.t]): Defaults to: null.
  • state (String.t): Defaults to: null.

Order. All methods require the order manager role.

Attributes

  • country (String.t): CLDR country code (e.g. "US"). Defaults to: null.
  • fullAddress ([String.t]): 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 Defaults to: null.
  • isPostOfficeBox (boolean()): Whether the address is a post office box. Defaults to: null.
  • locality (String.t): City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs). Defaults to: null.
  • postalCode (String.t): Postal Code or ZIP (e.g. "94043"). Defaults to: null.
  • recipientName (String.t): Name of the recipient. Defaults to: null.
  • region (String.t): Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC"). Defaults to: null.
  • streetAddress ([String.t]): Street-level part of the address. Defaults to: null.

Attributes

  • actor (String.t): The actor that created the cancellation. Defaults to: null.
  • creationDate (String.t): Date on which the cancellation has been created, in ISO 8601 format. Defaults to: null.
  • quantity (integer()): The quantity that was canceled. Defaults to: null.
  • reason (String.t): The reason for the cancellation. Orders that are cancelled with a noInventory reason will lead to the removal of the product from Shopping Actions until you make an update to that product. This will not affect your Shopping ads. Defaults to: null.
  • reasonText (String.t): The explanation of the reason. Defaults to: null.

Attributes

  • email (String.t): Deprecated. Defaults to: null.
  • explicitMarketingPreference (boolean()): Deprecated. Please use marketingRightsInfo instead. Defaults to: null.
  • fullName (String.t): Full name of the customer. Defaults to: null.
  • marketingRightsInfo (OrderCustomerMarketingRightsInfo): 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. Defaults to: null.

Attributes

  • explicitMarketingPreference (String.t): 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. Defaults to: null.
  • lastUpdatedTimestamp (String.t): Timestamp when last time marketing preference was updated. Could be empty, if user wasn't offered a selection yet. Defaults to: null.
  • marketingEmailAddress (String.t): 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. Defaults to: null.

Attributes

  • address (OrderAddress): The delivery address Defaults to: null.
  • phoneNumber (String.t): The phone number of the person receiving the delivery. Defaults to: null.

Attributes

  • benefits ([OrderLegacyPromotionBenefit]): Defaults to: null.
  • effectiveDates (String.t): 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. Defaults to: null.
  • genericRedemptionCode (String.t): Optional. The text code that corresponds to the promotion when applied on the retailer?s website. Defaults to: null.
  • id (String.t): The unique ID of the promotion. Defaults to: null.
  • longTitle (String.t): The full title of the promotion. Defaults to: null.
  • productApplicability (String.t): Whether the promotion is applicable to all products or only specific products. Defaults to: null.
  • redemptionChannel (String.t): Indicates that the promotion is valid online. Defaults to: null.

Attributes

  • discount (Price): The discount in the order price when the promotion is applied. Defaults to: null.
  • offerIds ([String.t]): The OfferId(s) that were purchased in this order and map to this specific benefit of the promotion. Defaults to: null.
  • subType (String.t): Further describes the benefit of the promotion. Note that we will expand on this enumeration as we support new promotion sub-types. Defaults to: null.
  • taxImpact (Price): The impact on tax when the promotion is applied. Defaults to: null.
  • type (String.t): Describes whether the promotion applies to products (e.g. 20% off) or to shipping (e.g. Free Shipping). Defaults to: null.

Attributes

  • annotations ([OrderMerchantProvidedAnnotation]): Annotations that are attached to the line item. Defaults to: null.
  • cancellations ([OrderCancellation]): Cancellations of the line item. Defaults to: null.
  • id (String.t): The ID of the line item. Defaults to: null.
  • price (Price): Total price for the line item. For example, if two items for $10 are purchased, the total price will be $20. Defaults to: null.
  • product (OrderLineItemProduct): 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. Defaults to: null.
  • quantityCanceled (integer()): Number of items canceled. Defaults to: null.
  • quantityDelivered (integer()): Number of items delivered. Defaults to: null.
  • quantityOrdered (integer()): Number of items ordered. Defaults to: null.
  • quantityPending (integer()): Number of items pending. Defaults to: null.
  • quantityReturned (integer()): Number of items returned. Defaults to: null.
  • quantityShipped (integer()): Number of items shipped. Defaults to: null.
  • returnInfo (OrderLineItemReturnInfo): Details of the return policy for the line item. Defaults to: null.
  • returns ([OrderReturn]): Returns of the line item. Defaults to: null.
  • shippingDetails (OrderLineItemShippingDetails): Details of the requested shipping for the line item. Defaults to: null.
  • tax (Price): 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. Defaults to: null.

Attributes

  • brand (String.t): Brand of the item. Defaults to: null.
  • channel (String.t): The item's channel (online or local). Defaults to: null.
  • condition (String.t): Condition or state of the item. Defaults to: null.
  • contentLanguage (String.t): The two-letter ISO 639-1 language code for the item. Defaults to: null.
  • fees ([OrderLineItemProductFee]): Associated fees at order creation time. Defaults to: null.
  • gtin (String.t): Global Trade Item Number (GTIN) of the item. Defaults to: null.
  • id (String.t): The REST ID of the product. Defaults to: null.
  • imageLink (String.t): URL of an image of the item. Defaults to: null.
  • itemGroupId (String.t): Shared identifier for all variants of the same product. Defaults to: null.
  • mpn (String.t): Manufacturer Part Number (MPN) of the item. Defaults to: null.
  • offerId (String.t): An identifier of the item. Defaults to: null.
  • price (Price): Price of the item. Defaults to: null.
  • shownImage (String.t): URL to the cached image shown to the user when order was placed. Defaults to: null.
  • targetCountry (String.t): The CLDR territory code of the target country of the product. Defaults to: null.
  • title (String.t): The title of the product. Defaults to: null.
  • variantAttributes ([OrderLineItemProductVariantAttribute]): 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. Defaults to: null.

Attributes

  • amount (Price): Amount of the fee. Defaults to: null.
  • name (String.t): Name of the fee. Defaults to: null.

Attributes

  • dimension (String.t): The dimension of the variant. Defaults to: null.
  • value (String.t): The value for the dimension. Defaults to: null.

Attributes

  • daysToReturn (integer()): How many days later the item can be returned. Defaults to: null.
  • isReturnable (boolean()): Whether the item is returnable. Defaults to: null.
  • policyUrl (String.t): URL of the item return policy. Defaults to: null.

Attributes

  • deliverByDate (String.t): The delivery by date, in ISO 8601 format. Defaults to: null.
  • method (OrderLineItemShippingDetailsMethod): Details of the shipping method. Defaults to: null.
  • shipByDate (String.t): The ship by date, in ISO 8601 format. Defaults to: null.

Attributes

  • carrier (String.t): The carrier for the shipping. Optional. See shipments[].carrier for a list of acceptable values. Defaults to: null.
  • maxDaysInTransit (integer()): Maximum transit time. Defaults to: null.
  • methodName (String.t): The name of the shipping method. Defaults to: null.
  • minDaysInTransit (integer()): Minimum transit time. Defaults to: null.

Attributes

  • key (String.t): Key for additional merchant provided (as key-value pairs) annotation about the line item. Defaults to: null.
  • value (String.t): Value for additional merchant provided (as key-value pairs) annotation about the line item. Defaults to: null.

Attributes

  • billingAddress (OrderAddress): The billing address. Defaults to: null.
  • expirationMonth (integer()): The card expiration month (January = 1, February = 2 etc.). Defaults to: null.
  • expirationYear (integer()): The card expiration year (4-digit, e.g. 2015). Defaults to: null.
  • lastFourDigits (String.t): The last four digits of the card number. Defaults to: null.
  • phoneNumber (String.t): The billing phone number. Defaults to: null.
  • type (String.t): The type of instrument. Acceptable values are: - "AMEX" - "DISCOVER" - "JCB" - "MASTERCARD" - "UNIONPAY" - "VISA" - "" Defaults to: null.

Attributes

  • benefits ([OrderPromotionBenefit]): Defaults to: null.
  • effectiveDates (String.t): 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. Defaults to: null.
  • genericRedemptionCode (String.t): Optional. The text code that corresponds to the promotion when applied on the retailer?s website. Defaults to: null.
  • id (String.t): The unique ID of the promotion. Defaults to: null.
  • longTitle (String.t): The full title of the promotion. Defaults to: null.
  • productApplicability (String.t): Whether the promotion is applicable to all products or only specific products. Defaults to: null.
  • redemptionChannel (String.t): Indicates that the promotion is valid online. Defaults to: null.

Attributes

  • discount (Price): The discount in the order price when the promotion is applied. Defaults to: null.
  • offerIds ([String.t]): The OfferId(s) that were purchased in this order and map to this specific benefit of the promotion. Defaults to: null.
  • subType (String.t): Further describes the benefit of the promotion. Note that we will expand on this enumeration as we support new promotion sub-types. Defaults to: null.
  • taxImpact (Price): The impact on tax when the promotion is applied. Defaults to: null.
  • type (String.t): Describes whether the promotion applies to products (e.g. 20% off) or to shipping (e.g. Free Shipping). Defaults to: null.

Attributes

  • actor (String.t): The actor that created the refund. Defaults to: null.
  • amount (Price): The amount that is refunded. Defaults to: null.
  • creationDate (String.t): Date on which the item has been created, in ISO 8601 format. Defaults to: null.
  • reason (String.t): The reason for the refund. Defaults to: null.
  • reasonText (String.t): The explanation of the reason. Defaults to: null.

Order disbursement. All methods require the payment analyst role.

Attributes

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

Attributes

  • actor (String.t): The actor that created the refund. Defaults to: null.
  • creationDate (String.t): Date on which the item has been created, in ISO 8601 format. Defaults to: null.
  • quantity (integer()): Quantity that is returned. Defaults to: null.
  • reason (String.t): The reason for the return. Defaults to: null.
  • reasonText (String.t): The explanation of the reason. Defaults to: null.

Attributes

  • carrier (String.t): The carrier handling the shipment. Acceptable values for US are: - "gsx" - "ups" - "usps" - "fedex" - "dhl" - "ecourier" - "cxt" - "google" - "ontrac" - "emsy" - "ont" - "deliv" - "dynamex" - "lasership" - "mpx" - "uds" - "efw" Acceptable values for FR are: - "colissimo" - "chronopost" - "gls" - "dpd" - "bpost" Defaults to: null.
  • creationDate (String.t): Date on which the shipment has been created, in ISO 8601 format. Defaults to: null.
  • deliveryDate (String.t): Date on which the shipment has been delivered, in ISO 8601 format. Present only if status is delivered Defaults to: null.
  • id (String.t): The ID of the shipment. Defaults to: null.
  • lineItems ([OrderShipmentLineItemShipment]): The line items that are shipped. Defaults to: null.
  • status (String.t): The status of the shipment. Defaults to: null.
  • trackingId (String.t): The tracking ID for the shipment. Defaults to: null.

Attributes

  • lineItemId (String.t): The ID of the line item that is shipped. Either lineItemId or productId is required. Defaults to: null.
  • productId (String.t): The ID of the product to ship. This is the REST ID used in the products service. Either lineItemId or productId is required. Defaults to: null.
  • quantity (integer()): The quantity that is shipped. Defaults to: null.

Attributes

  • invoiceId (String.t): [required] The ID of the invoice. Defaults to: null.
  • invoiceSummary (InvoiceSummary): [required] Invoice summary. Defaults to: null.
  • lineItemInvoices ([ShipmentInvoiceLineItemInvoice]): [required] Invoice details per line item. Defaults to: null.
  • operationId (String.t): [required] The ID of the operation, unique across all operations for a given order. Defaults to: null.
  • shipmentGroupId (String.t): [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. Defaults to: null.

Attributes

  • executionStatus (String.t): The status of the execution. Defaults to: null.
  • kind (String.t): Identifies what kind of resource this is. Value: the fixed string "content#orderinvoicesCreateChargeInvoiceResponse". Defaults to: null.

Attributes

  • invoiceId (String.t): [required] The ID of the invoice. Defaults to: null.
  • operationId (String.t): [required] The ID of the operation, unique across all operations for a given order. Defaults to: null.
  • refundOnlyOption (OrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceRefundOption): Option to create a refund-only invoice. Exactly one of refundOnlyOption or returnOption must be provided. Defaults to: null.
  • returnOption (OrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceReturnOption): 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. Defaults to: null.
  • shipmentInvoices ([ShipmentInvoice]): Invoice details for different shipment groups. Defaults to: null.

Attributes

  • executionStatus (String.t): The status of the execution. Defaults to: null.
  • kind (String.t): Identifies what kind of resource this is. Value: the fixed string "content#orderinvoicesCreateRefundInvoiceResponse". Defaults to: null.

Attributes

  • description (String.t): Optional description of the refund reason. Defaults to: null.
  • reason (String.t): [required] Reason for the refund. Defaults to: null.

Attributes

  • description (String.t): Optional description of the return reason. Defaults to: null.
  • reason (String.t): [required] Reason for the return. Defaults to: null.

Attributes

  • authAmountPretax (Price): Authorized amount for pre-tax charge on user's credit card. Defaults to: null.
  • authAmountTax (Price): Authorized amount for tax charge on user's credit card. Defaults to: null.

Attributes

  • executionStatus (String.t): The status of the execution. Defaults to: null.
  • kind (String.t): Identifies what kind of resource this is. Value: the fixed string "content#orderpaymentsNotifyAuthApprovedResponse". Defaults to: null.

Attributes

  • declineReason (String.t): Reason why payment authorization was declined. Defaults to: null.

Attributes

  • executionStatus (String.t): The status of the execution. Defaults to: null.
  • kind (String.t): Identifies what kind of resource this is. Value: the fixed string "content#orderpaymentsNotifyAuthDeclinedResponse". Defaults to: null.

Attributes

  • chargeState (String.t): Whether charge was successful. Defaults to: null.
  • invoiceId (String.t): Deprecated. Please use invoiceIds instead. Defaults to: null.
  • invoiceIds ([String.t]): Invoice IDs from the orderinvoices service that correspond to the charge. Defaults to: null.

Attributes

  • executionStatus (String.t): The status of the execution. Defaults to: null.
  • kind (String.t): Identifies what kind of resource this is. Value: the fixed string "content#orderpaymentsNotifyChargeResponse". Defaults to: null.

Attributes

  • invoiceId (String.t): Deprecated. Please use invoiceIds instead. Defaults to: null.
  • invoiceIds ([String.t]): Invoice IDs from the orderinvoices service that correspond to the refund. Defaults to: null.
  • refundState (String.t): Whether refund was successful. Defaults to: null.

Attributes

  • executionStatus (String.t): The status of the execution. Defaults to: null.
  • kind (String.t): Identifies what kind of resource this is. Value: the fixed string "content#orderpaymentsNotifyRefundResponse". Defaults to: null.

Attributes

  • disbursements ([OrderReportDisbursement]): The list of disbursements. Defaults to: null.
  • kind (String.t): Identifies what kind of resource this is. Value: the fixed string "content#orderreportsListDisbursementsResponse". Defaults to: null.
  • nextPageToken (String.t): The token for the retrieval of the next page of disbursements. Defaults to: null.

Attributes

  • kind (String.t): Identifies what kind of resource this is. Value: the fixed string "content#orderreportsListTransactionsResponse". Defaults to: null.
  • nextPageToken (String.t): The token for the retrieval of the next page of transactions. Defaults to: null.
  • transactions ([OrderReportTransaction]): The list of transactions. Defaults to: null.

Attributes

  • kind (String.t): Identifies what kind of resource this is. Value: the fixed string "content#orderreturnsListResponse". Defaults to: null.
  • nextPageToken (String.t): The token for the retrieval of the next page of returns. Defaults to: null.
  • resources ([MerchantOrderReturn]): Defaults to: null.

Attributes

  • operationId (String.t): The ID of the operation. Unique across all operations for a given order. Defaults to: null.

Attributes

  • executionStatus (String.t): The status of the execution. Defaults to: null.
  • kind (String.t): Identifies what kind of resource this is. Value: the fixed string "content#ordersAcknowledgeResponse". Defaults to: null.

Attributes

  • kind (String.t): Identifies what kind of resource this is. Value: the fixed string "content#ordersAdvanceTestOrderResponse". Defaults to: null.

Attributes

  • amount (Price): Deprecated. Please use amountPretax and amountTax instead. Defaults to: null.
  • amountPretax (Price): 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. Defaults to: null.
  • amountTax (Price): Tax amount that corresponds to cancellation amount in amountPretax. Optional, but if filled, then amountPretax must be set. Calculated automatically if not provided. Defaults to: null.
  • lineItemId (String.t): The ID of the line item to cancel. Either lineItemId or productId is required. Defaults to: null.
  • operationId (String.t): The ID of the operation. Unique across all operations for a given order. Defaults to: null.
  • productId (String.t): The ID of the product to cancel. This is the REST ID used in the products service. Either lineItemId or productId is required. Defaults to: null.
  • quantity (integer()): The quantity to cancel. Defaults to: null.
  • reason (String.t): The reason for the cancellation. Defaults to: null.
  • reasonText (String.t): The explanation of the reason. Defaults to: null.

Attributes

  • executionStatus (String.t): The status of the execution. Defaults to: null.
  • kind (String.t): Identifies what kind of resource this is. Value: the fixed string "content#ordersCancelLineItemResponse". Defaults to: null.

Attributes

  • operationId (String.t): The ID of the operation. Unique across all operations for a given order. Defaults to: null.
  • reason (String.t): The reason for the cancellation. Defaults to: null.
  • reasonText (String.t): The explanation of the reason. Defaults to: null.

Attributes

  • executionStatus (String.t): The status of the execution. Defaults to: null.
  • kind (String.t): Identifies what kind of resource this is. Value: the fixed string "content#ordersCancelResponse". Defaults to: null.

Attributes

  • reason (String.t): The reason for the cancellation. Defaults to: null.

Attributes

  • kind (String.t): Identifies what kind of resource this is. Value: the fixed string "content#ordersCancelTestOrderByCustomerResponse". Defaults to: null.

Attributes

  • country (String.t): 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. Defaults to: null.
  • templateName (String.t): 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. Defaults to: null.
  • testOrder (TestOrder): The test order to create. Defaults to: null.

Attributes

  • kind (String.t): Identifies what kind of resource this is. Value: the fixed string "content#ordersCreateTestOrderResponse". Defaults to: null.
  • orderId (String.t): The ID of the newly created test order. Defaults to: null.

Attributes

  • items ([OrdersCustomBatchRequestEntryCreateTestReturnReturnItem]): Returned items. Defaults to: null.

Attributes

  • kind (String.t): Identifies what kind of resource this is. Value: the fixed string "content#ordersCreateTestReturnResponse". Defaults to: null.
  • returnId (String.t): The ID of the newly created test order return. Defaults to: null.

Attributes

  • entries ([OrdersCustomBatchRequestEntry]): The request entries to be processed in the batch. Defaults to: null.

Attributes

  • batchId (integer()): An entry ID, unique within the batch request. Defaults to: null.
  • cancel (OrdersCustomBatchRequestEntryCancel): Required for cancel method. Defaults to: null.
  • cancelLineItem (OrdersCustomBatchRequestEntryCancelLineItem): Required for cancelLineItem method. Defaults to: null.
  • inStoreRefundLineItem (OrdersCustomBatchRequestEntryInStoreRefundLineItem): Required for inStoreReturnLineItem method. Defaults to: null.
  • merchantId (String.t): The ID of the managing account. Defaults to: null.
  • merchantOrderId (String.t): The merchant order ID. Required for updateMerchantOrderId and getByMerchantOrderId methods. Defaults to: null.
  • method (String.t): The method to apply. Defaults to: null.
  • operationId (String.t): The ID of the operation. Unique across all operations for a given order. Required for all methods beside get and getByMerchantOrderId. Defaults to: null.
  • orderId (String.t): The ID of the order. Required for all methods beside getByMerchantOrderId. Defaults to: null.
  • refund (OrdersCustomBatchRequestEntryRefund): Required for refund method. Defaults to: null.
  • rejectReturnLineItem (OrdersCustomBatchRequestEntryRejectReturnLineItem): Required for rejectReturnLineItem method. Defaults to: null.
  • returnLineItem (OrdersCustomBatchRequestEntryReturnLineItem): Required for returnLineItem method. Defaults to: null.
  • returnRefundLineItem (OrdersCustomBatchRequestEntryReturnRefundLineItem): Required for returnRefundLineItem method. Defaults to: null.
  • setLineItemMetadata (OrdersCustomBatchRequestEntrySetLineItemMetadata): Required for setLineItemMetadata method. Defaults to: null.
  • shipLineItems (OrdersCustomBatchRequestEntryShipLineItems): Required for shipLineItems method. Defaults to: null.
  • updateLineItemShippingDetails (OrdersCustomBatchRequestEntryUpdateLineItemShippingDetails): Required for updateLineItemShippingDate method. Defaults to: null.
  • updateShipment (OrdersCustomBatchRequestEntryUpdateShipment): Required for updateShipment method. Defaults to: null.

Attributes

  • reason (String.t): The reason for the cancellation. Defaults to: null.
  • reasonText (String.t): The explanation of the reason. Defaults to: null.

Attributes

  • amount (Price): Deprecated. Please use amountPretax and amountTax instead. Defaults to: null.
  • amountPretax (Price): 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. Defaults to: null.
  • amountTax (Price): Tax amount that corresponds to cancellation amount in amountPretax. Optional, but if filled, then amountPretax must be set. Calculated automatically if not provided. Defaults to: null.
  • lineItemId (String.t): The ID of the line item to cancel. Either lineItemId or productId is required. Defaults to: null.
  • productId (String.t): The ID of the product to cancel. This is the REST ID used in the products service. Either lineItemId or productId is required. Defaults to: null.
  • quantity (integer()): The quantity to cancel. Defaults to: null.
  • reason (String.t): The reason for the cancellation. Defaults to: null.
  • reasonText (String.t): The explanation of the reason. Defaults to: null.

Attributes

  • lineItemId (String.t): The ID of the line item to return. Defaults to: null.
  • quantity (integer()): Quantity that is returned. Defaults to: null.

Attributes

  • amountPretax (Price): The amount that is refunded. Required. Defaults to: null.
  • amountTax (Price): Tax amount that correspond to refund amount in amountPretax. Required. Defaults to: null.
  • lineItemId (String.t): The ID of the line item to return. Either lineItemId or productId is required. Defaults to: null.
  • productId (String.t): The ID of the product to return. This is the REST ID used in the products service. Either lineItemId or productId is required. Defaults to: null.
  • quantity (integer()): The quantity to return and refund. Defaults to: null.
  • reason (String.t): The reason for the return. Defaults to: null.
  • reasonText (String.t): The explanation of the reason. Defaults to: null.

Attributes

  • amount (Price): Deprecated. Please use amountPretax and amountTax instead. Defaults to: null.
  • amountPretax (Price): The amount that is refunded. Either amount or amountPretax should be filled. Defaults to: null.
  • amountTax (Price): Tax amount that corresponds to refund amount in amountPretax. Optional, but if filled, amountPretax must be set. Calculated automatically if not provided. Defaults to: null.
  • reason (String.t): The reason for the refund. Defaults to: null.
  • reasonText (String.t): The explanation of the reason. Defaults to: null.

Attributes

  • lineItemId (String.t): The ID of the line item to return. Either lineItemId or productId is required. Defaults to: null.
  • productId (String.t): The ID of the product to return. This is the REST ID used in the products service. Either lineItemId or productId is required. Defaults to: null.
  • quantity (integer()): The quantity to return and refund. Defaults to: null.
  • reason (String.t): The reason for the return. Defaults to: null.
  • reasonText (String.t): The explanation of the reason. Defaults to: null.

Attributes

  • lineItemId (String.t): The ID of the line item to return. Either lineItemId or productId is required. Defaults to: null.
  • productId (String.t): The ID of the product to return. This is the REST ID used in the products service. Either lineItemId or productId is required. Defaults to: null.
  • quantity (integer()): The quantity to return. Defaults to: null.
  • reason (String.t): The reason for the return. Defaults to: null.
  • reasonText (String.t): The explanation of the reason. Defaults to: null.

Attributes

  • amountPretax (Price): The amount that is refunded. If omitted, refundless return is assumed (same as calling returnLineItem method). Defaults to: null.
  • amountTax (Price): Tax amount that corresponds to refund amount in amountPretax. Optional, but if filled, then amountPretax must be set. Calculated automatically if not provided. Defaults to: null.
  • lineItemId (String.t): The ID of the line item to return. Either lineItemId or productId is required. Defaults to: null.
  • productId (String.t): The ID of the product to return. This is the REST ID used in the products service. Either lineItemId or productId is required. Defaults to: null.
  • quantity (integer()): The quantity to return and refund. Defaults to: null.
  • reason (String.t): The reason for the return. Defaults to: null.
  • reasonText (String.t): The explanation of the reason. Defaults to: null.

Attributes

  • annotations ([OrderMerchantProvidedAnnotation]): Defaults to: null.
  • lineItemId (String.t): The ID of the line item to set metadata. Either lineItemId or productId is required. Defaults to: null.
  • productId (String.t): The ID of the product to set metadata. This is the REST ID used in the products service. Either lineItemId or productId is required. Defaults to: null.

Attributes

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

Attributes

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

Attributes

  • deliverByDate (String.t): 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. Defaults to: null.
  • lineItemId (String.t): The ID of the line item to set metadata. Either lineItemId or productId is required. Defaults to: null.
  • productId (String.t): The ID of the product to set metadata. This is the REST ID used in the products service. Either lineItemId or productId is required. Defaults to: null.
  • shipByDate (String.t): 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. Defaults to: null.

Attributes

  • carrier (String.t): The carrier handling the shipment. Not updated if missing. See shipments[].carrier in the Orders resource representation for a list of acceptable values. Defaults to: null.
  • deliveryDate (String.t): Date on which the shipment has been delivered, in ISO 8601 format. Optional and can be provided only if status is delivered. Defaults to: null.
  • shipmentId (String.t): The ID of the shipment. Defaults to: null.
  • status (String.t): New status for the shipment. Not updated if missing. Defaults to: null.
  • trackingId (String.t): The tracking ID for the shipment. Not updated if missing. Defaults to: null.

Attributes

  • entries ([OrdersCustomBatchResponseEntry]): The result of the execution of the batch requests. Defaults to: null.
  • kind (String.t): Identifies what kind of resource this is. Value: the fixed string "content#ordersCustomBatchResponse". Defaults to: null.

Attributes

  • batchId (integer()): The ID of the request entry this entry responds to. Defaults to: null.
  • errors (Errors): A list of errors defined if and only if the request failed. Defaults to: null.
  • executionStatus (String.t): The status of the execution. Only defined if - the request was successful; and - the method is not get, getByMerchantOrderId, or one of the test methods. Defaults to: null.
  • kind (String.t): Identifies what kind of resource this is. Value: the fixed string "content#ordersCustomBatchResponseEntry". Defaults to: null.
  • order (Order): The retrieved order. Only defined if the method is get and if the request was successful. Defaults to: null.

Attributes

  • kind (String.t): Identifies what kind of resource this is. Value: the fixed string "content#ordersGetByMerchantOrderIdResponse". Defaults to: null.
  • order (Order): The requested order. Defaults to: null.

Attributes

  • kind (String.t): Identifies what kind of resource this is. Value: the fixed string "content#ordersGetTestOrderTemplateResponse". Defaults to: null.
  • template (TestOrder): The requested test order template. Defaults to: null.

Attributes

  • amountPretax (Price): The amount that is refunded. Required. Defaults to: null.
  • amountTax (Price): Tax amount that correspond to refund amount in amountPretax. Required. Defaults to: null.
  • lineItemId (String.t): The ID of the line item to return. Either lineItemId or productId is required. Defaults to: null.
  • operationId (String.t): The ID of the operation. Unique across all operations for a given order. Defaults to: null.
  • productId (String.t): The ID of the product to return. This is the REST ID used in the products service. Either lineItemId or productId is required. Defaults to: null.
  • quantity (integer()): The quantity to return and refund. Defaults to: null.
  • reason (String.t): The reason for the return. Defaults to: null.
  • reasonText (String.t): The explanation of the reason. Defaults to: null.

Attributes

  • executionStatus (String.t): The status of the execution. Defaults to: null.
  • kind (String.t): Identifies what kind of resource this is. Value: the fixed string "content#ordersInStoreRefundLineItemResponse". Defaults to: null.

Attributes

  • kind (String.t): Identifies what kind of resource this is. Value: the fixed string "content#ordersListResponse". Defaults to: null.
  • nextPageToken (String.t): The token for the retrieval of the next page of orders. Defaults to: null.
  • resources ([Order]): Defaults to: null.

Attributes

  • amount (Price): Deprecated. Please use amountPretax and amountTax instead. Defaults to: null.
  • amountPretax (Price): The amount that is refunded. Either amount or amountPretax should be filled. Defaults to: null.
  • amountTax (Price): Tax amount that corresponds to refund amount in amountPretax. Optional, but if filled, amountPretax must be set. Calculated automatically if not provided. Defaults to: null.
  • operationId (String.t): The ID of the operation. Unique across all operations for a given order. Defaults to: null.
  • reason (String.t): The reason for the refund. Defaults to: null.
  • reasonText (String.t): The explanation of the reason. Defaults to: null.

Attributes

  • executionStatus (String.t): The status of the execution. Defaults to: null.
  • kind (String.t): Identifies what kind of resource this is. Value: the fixed string "content#ordersRefundResponse". Defaults to: null.

Attributes

  • lineItemId (String.t): The ID of the line item to return. Either lineItemId or productId is required. Defaults to: null.
  • operationId (String.t): The ID of the operation. Unique across all operations for a given order. Defaults to: null.
  • productId (String.t): The ID of the product to return. This is the REST ID used in the products service. Either lineItemId or productId is required. Defaults to: null.
  • quantity (integer()): The quantity to return and refund. Defaults to: null.
  • reason (String.t): The reason for the return. Defaults to: null.
  • reasonText (String.t): The explanation of the reason. Defaults to: null.

Attributes

  • executionStatus (String.t): The status of the execution. Defaults to: null.
  • kind (String.t): Identifies what kind of resource this is. Value: the fixed string "content#ordersRejectReturnLineItemResponse". Defaults to: null.

Attributes

  • lineItemId (String.t): The ID of the line item to return. Either lineItemId or productId is required. Defaults to: null.
  • operationId (String.t): The ID of the operation. Unique across all operations for a given order. Defaults to: null.
  • productId (String.t): The ID of the product to return. This is the REST ID used in the products service. Either lineItemId or productId is required. Defaults to: null.
  • quantity (integer()): The quantity to return. Defaults to: null.
  • reason (String.t): The reason for the return. Defaults to: null.
  • reasonText (String.t): The explanation of the reason. Defaults to: null.

Attributes

  • executionStatus (String.t): The status of the execution. Defaults to: null.
  • kind (String.t): Identifies what kind of resource this is. Value: the fixed string "content#ordersReturnLineItemResponse". Defaults to: null.

Attributes

  • amountPretax (Price): The amount that is refunded. If omitted, refundless return is assumed (same as calling returnLineItem method). Defaults to: null.
  • amountTax (Price): Tax amount that corresponds to refund amount in amountPretax. Optional, but if filled, then amountPretax must be set. Calculated automatically if not provided. Defaults to: null.
  • lineItemId (String.t): The ID of the line item to return. Either lineItemId or productId is required. Defaults to: null.
  • operationId (String.t): The ID of the operation. Unique across all operations for a given order. Defaults to: null.
  • productId (String.t): The ID of the product to return. This is the REST ID used in the products service. Either lineItemId or productId is required. Defaults to: null.
  • quantity (integer()): The quantity to return and refund. Defaults to: null.
  • reason (String.t): The reason for the return. Defaults to: null.
  • reasonText (String.t): The explanation of the reason. Defaults to: null.

Attributes

  • executionStatus (String.t): The status of the execution. Defaults to: null.
  • kind (String.t): Identifies what kind of resource this is. Value: the fixed string "content#ordersReturnRefundLineItemResponse". Defaults to: null.

Attributes

  • annotations ([OrderMerchantProvidedAnnotation]): Defaults to: null.
  • lineItemId (String.t): The ID of the line item to set metadata. Either lineItemId or productId is required. Defaults to: null.
  • operationId (String.t): The ID of the operation. Unique across all operations for a given order. Defaults to: null.
  • productId (String.t): The ID of the product to set metadata. This is the REST ID used in the products service. Either lineItemId or productId is required. Defaults to: null.

Attributes

  • executionStatus (String.t): The status of the execution. Defaults to: null.
  • kind (String.t): Identifies what kind of resource this is. Value: the fixed string "content#ordersSetLineItemMetadataResponse". Defaults to: null.

Attributes

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

Attributes

  • executionStatus (String.t): The status of the execution. Defaults to: null.
  • kind (String.t): Identifies what kind of resource this is. Value: the fixed string "content#ordersShipLineItemsResponse". Defaults to: null.

Attributes

  • deliverByDate (String.t): 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. Defaults to: null.
  • lineItemId (String.t): The ID of the line item to set metadata. Either lineItemId or productId is required. Defaults to: null.
  • operationId (String.t): The ID of the operation. Unique across all operations for a given order. Defaults to: null.
  • productId (String.t): The ID of the product to set metadata. This is the REST ID used in the products service. Either lineItemId or productId is required. Defaults to: null.
  • shipByDate (String.t): 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. Defaults to: null.

Attributes

  • executionStatus (String.t): The status of the execution. Defaults to: null.
  • kind (String.t): Identifies what kind of resource this is. Value: the fixed string "content#ordersUpdateLineItemShippingDetailsResponse". Defaults to: null.

Attributes

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

Attributes

  • executionStatus (String.t): The status of the execution. Defaults to: null.
  • kind (String.t): Identifies what kind of resource this is. Value: the fixed string "content#ordersUpdateMerchantOrderIdResponse". Defaults to: null.

Attributes

  • carrier (String.t): The carrier handling the shipment. Not updated if missing. See shipments[].carrier in the Orders resource representation for a list of acceptable values. Defaults to: null.
  • deliveryDate (String.t): Date on which the shipment has been delivered, in ISO 8601 format. Optional and can be provided only if status is delivered. Defaults to: null.
  • operationId (String.t): The ID of the operation. Unique across all operations for a given order. Defaults to: null.
  • shipmentId (String.t): The ID of the shipment. Defaults to: null.
  • status (String.t): New status for the shipment. Not updated if missing. Defaults to: null.
  • trackingId (String.t): The tracking ID for the shipment. Not updated if missing. Defaults to: null.

Attributes

  • executionStatus (String.t): The status of the execution. Defaults to: null.
  • kind (String.t): Identifies what kind of resource this is. Value: the fixed string "content#ordersUpdateShipmentResponse". Defaults to: null.

Attributes

  • entries ([PosCustomBatchRequestEntry]): The request entries to be processed in the batch. Defaults to: null.

Attributes

  • batchId (integer()): An entry ID, unique within the batch request. Defaults to: null.
  • inventory (PosInventory): The inventory to submit. Set this only if the method is inventory. Defaults to: null.
  • merchantId (String.t): The ID of the POS data provider. Defaults to: null.
  • method (String.t): Defaults to: null.
  • sale (PosSale): The sale information to submit. Set this only if the method is sale. Defaults to: null.
  • store (PosStore): The store information to submit. Set this only if the method is insert. Defaults to: null.
  • storeCode (String.t): The store code. Set this only if the method is delete or get. Defaults to: null.
  • targetMerchantId (String.t): The ID of the account for which to get/submit data. Defaults to: null.

Attributes

  • entries ([PosCustomBatchResponseEntry]): The result of the execution of the batch requests. Defaults to: null.
  • kind (String.t): Identifies what kind of resource this is. Value: the fixed string "content#posCustomBatchResponse". Defaults to: null.

Attributes

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

Attributes

  • country (String.t): Country code. Defaults to: null.
  • posDataProviders ([PosDataProvidersPosDataProvider]): A list of POS data providers. Defaults to: null.

Attributes

  • displayName (String.t): The display name of Pos data Provider. Defaults to: null.
  • fullName (String.t): The full name of this POS data Provider. Defaults to: null.
  • providerId (String.t): The ID of the account. Defaults to: null.

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

Attributes

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

Attributes

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

Attributes

  • kind (String.t): Identifies what kind of resource this is. Value: the fixed string "content#posListResponse". Defaults to: null.
  • resources ([PosStore]): Defaults to: null.

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

Attributes

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

Attributes

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

Attributes

  • country (String.t): The CLDR territory code of the country the postal code group applies to. Required. Defaults to: null.
  • name (String.t): The name of the postal code group, referred to in headers. Required. Defaults to: null.
  • postalCodeRanges ([PostalCodeRange]): A range of postal codes. Required. Defaults to: null.

Attributes

  • postalCodeRangeBegin (String.t): 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. Defaults to: null.
  • postalCodeRangeEnd (String.t): 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. Defaults to: null.

Attributes

  • currency (String.t): The currency of the price. Defaults to: null.
  • value (String.t): The price represented as a number. Defaults to: null.

Product data. After inserting, updating, or deleting a product, it may take several minutes before changes take effect.

Attributes

  • priceAmount (Price): The pre-tax or post-tax price depending on the location of the order. Defaults to: null.
  • remittedTaxAmount (Price): Remitted tax value. Defaults to: null.
  • taxAmount (Price): Tax value. Defaults to: null.

Attributes

  • aspectName (String.t): The name of the aspect. Defaults to: null.
  • destinationName (String.t): The name of the destination. Leave out to apply to all destinations. Defaults to: null.
  • intention (String.t): Whether the aspect is required, excluded or should be validated. Defaults to: null.

Attributes

  • name (String.t): The name of the attribute. Underscores will be replaced by spaces upon insertion. Defaults to: null.
  • type (String.t): The type of the attribute. Defaults to: null.
  • unit (String.t): Free-form unit of the attribute. Unit can only be used for values of type INT or FLOAT. Defaults to: null.
  • value (String.t): The value of the attribute. Defaults to: null.

Attributes

  • attributes ([ProductCustomAttribute]): The sub-attributes. Defaults to: null.
  • name (String.t): The name of the group. Underscores will be replaced by spaces upon insertion. Defaults to: null.

Attributes

  • destinationName (String.t): The name of the destination. Defaults to: null.
  • intention (String.t): Whether the destination is required, excluded or should be validated. Defaults to: null.

Attributes

  • country (String.t): The CLDR territory code of the country to which an item will ship. Defaults to: null.
  • locationGroupName (String.t): The location where the shipping is applicable, represented by a location group name. Defaults to: null.
  • locationId (String.t): The numeric ID of a location that the shipping rate applies to as defined in the AdWords API. Defaults to: null.
  • postalCode (String.t): 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. Defaults to: null.
  • price (Price): Fixed shipping price, represented as a number. Defaults to: null.
  • region (String.t): The geographic region to which a shipping rate applies. Defaults to: null.
  • service (String.t): A free-form description of the service class or delivery speed. Defaults to: null.

Attributes

  • unit (String.t): The unit of value. Defaults to: null.
  • value (float()): The dimension of the product used to calculate the shipping cost of the item. Defaults to: null.

Attributes

  • unit (String.t): The unit of value. Defaults to: null.
  • value (float()): The weight of the product used to calculate the shipping cost of the item. Defaults to: null.

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

Attributes

  • destination (String.t): Defaults to: null.
  • detail (String.t): Defaults to: null.
  • fetchStatus (String.t): Defaults to: null.
  • id (String.t): Defaults to: null.
  • location (String.t): Defaults to: null.
  • severity (String.t): Defaults to: null.
  • timestamp (String.t): Defaults to: null.
  • valueOnLandingPage (String.t): Defaults to: null.
  • valueProvided (String.t): Defaults to: null.

Attributes

  • approvalPending (boolean()): Whether the approval status might change due to further processing. Defaults to: null.
  • approvalStatus (String.t): The destination's approval status. Defaults to: null.
  • destination (String.t): The name of the destination Defaults to: null.
  • intention (String.t): Provided for backward compatibility only. Always set to "required". Defaults to: null.

Attributes

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

Attributes

  • country (String.t): The country within which the item is taxed, specified as a CLDR territory code. Defaults to: null.
  • locationId (String.t): The numeric ID of a location that the tax rate applies to as defined in the AdWords API. Defaults to: null.
  • postalCode (String.t): 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. Defaults to: null.
  • rate (float()): The percentage of tax rate that applies to the item price. Defaults to: null.
  • region (String.t): The geographic region to which the tax rate applies. Defaults to: null.
  • taxShip (boolean()): Set to true if tax is charged on shipping. Defaults to: null.

Attributes

  • unit (String.t): The unit of the denominator. Defaults to: null.
  • value (String.t): The denominator of the unit price. Defaults to: null.

Attributes

  • unit (String.t): The unit of the measure. Defaults to: null.
  • value (float()): The measure of an item. Defaults to: null.

Attributes

  • entries ([ProductsCustomBatchRequestEntry]): The request entries to be processed in the batch. Defaults to: null.

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

Attributes

  • entries ([ProductsCustomBatchResponseEntry]): The result of the execution of the batch requests. Defaults to: null.
  • kind (String.t): Identifies what kind of resource this is. Value: the fixed string "content#productsCustomBatchResponse". Defaults to: null.

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

Attributes

  • kind (String.t): Identifies what kind of resource this is. Value: the fixed string "content#productsListResponse". Defaults to: null.
  • nextPageToken (String.t): The token for the retrieval of the next page of products. Defaults to: null.
  • resources ([Product]): Defaults to: null.

Attributes

  • entries ([ProductstatusesCustomBatchRequestEntry]): The request entries to be processed in the batch. Defaults to: null.

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

Attributes

  • entries ([ProductstatusesCustomBatchResponseEntry]): The result of the execution of the batch requests. Defaults to: null.
  • kind (String.t): Identifies what kind of resource this is. Value: the fixed string "content#productstatusesCustomBatchResponse". Defaults to: null.

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

Attributes

  • kind (String.t): Identifies what kind of resource this is. Value: the fixed string "content#productstatusesListResponse". Defaults to: null.
  • nextPageToken (String.t): The token for the retrieval of the next page of products statuses. Defaults to: null.
  • resources ([ProductStatus]): Defaults to: null.

Attributes

  • promotionAmount (Amount): [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. Defaults to: null.
  • promotionId (String.t): [required] ID of the promotion. Defaults to: null.

Attributes

  • applicableShippingLabels ([String.t]): 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. Defaults to: null.
  • carrierRates ([CarrierRate]): A list of carrier rates that can be referred to by mainTable or singleValue. Defaults to: null.
  • mainTable (Table): A table defining the rate group, when singleValue is not expressive enough. Can only be set if singleValue is not set. Defaults to: null.
  • name (String.t): Name of the rate group. Optional. If set has to be unique within shipping service. Defaults to: null.
  • singleValue (Value): The value of the rate group (e.g. flat rate $10). Can only be set if mainTable and subtables are not set. Defaults to: null.
  • subtables ([Table]): A list of subtables referred to by mainTable. Can only be set if mainTable is set. Defaults to: null.

Attributes

  • description (String.t): Defaults to: null.
  • reasonCode (String.t): Defaults to: null.

Attributes

  • creationDate (String.t): Defaults to: null.
  • deliveryDate (String.t): Defaults to: null.
  • returnMethodType (String.t): Defaults to: null.
  • shipmentId (String.t): Defaults to: null.
  • shipmentTrackingInfos ([ShipmentTrackingInfo]): Defaults to: null.
  • shippingDate (String.t): Defaults to: null.
  • state (String.t): Defaults to: null.

Attributes

  • cells ([Value]): 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. Defaults to: null.

Attributes

  • active (boolean()): A boolean exposing the active status of the shipping service. Required. Defaults to: null.
  • currency (String.t): The CLDR code of the currency to which this service applies. Must match that of the prices in rate groups. Defaults to: null.
  • deliveryCountry (String.t): The CLDR territory code of the country to which the service applies. Required. Defaults to: null.
  • deliveryTime (DeliveryTime): Time spent in various aspects from order to the delivery of the product. Required. Defaults to: null.
  • eligibility (String.t): Eligibility for this service. Defaults to: null.
  • minimumOrderValue (Price): 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. Defaults to: null.
  • name (String.t): Free-form name of the service. Must be unique within target account. Required. Defaults to: null.
  • rateGroups ([RateGroup]): 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. Defaults to: null.

Attributes

  • invoiceSummary (InvoiceSummary): [required] Invoice summary. Defaults to: null.
  • lineItemInvoices ([ShipmentInvoiceLineItemInvoice]): [required] Invoice details per line item. Defaults to: null.
  • shipmentGroupId (String.t): [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. Defaults to: null.

Attributes

  • lineItemId (String.t): ID of the line item. Either lineItemId or productId must be set. Defaults to: null.
  • productId (String.t): ID of the product. This is the REST ID used in the products service. Either lineItemId or productId must be set. Defaults to: null.
  • shipmentUnitIds ([String.t]): [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). Defaults to: null.
  • unitInvoice (UnitInvoice): [required] Invoice details for a single unit. Defaults to: null.

Attributes

  • carrier (String.t): Defaults to: null.
  • trackingNumber (String.t): Defaults to: null.

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

Attributes

  • entries ([ShippingsettingsCustomBatchRequestEntry]): The request entries to be processed in the batch. Defaults to: null.

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

Attributes

  • entries ([ShippingsettingsCustomBatchResponseEntry]): The result of the execution of the batch requests. Defaults to: null.
  • kind (String.t): Identifies what kind of resource this is. Value: the fixed string "content#shippingsettingsCustomBatchResponse". Defaults to: null.

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

Attributes

  • carriers ([CarriersCarrier]): A list of supported carriers. May be empty. Defaults to: null.
  • kind (String.t): Identifies what kind of resource this is. Value: the fixed string "content#shippingsettingsGetSupportedCarriersResponse". Defaults to: null.

Attributes

  • holidays ([HolidaysHoliday]): A list of holidays applicable for delivery guarantees. May be empty. Defaults to: null.
  • kind (String.t): Identifies what kind of resource this is. Value: the fixed string "content#shippingsettingsGetSupportedHolidaysResponse". Defaults to: null.

Attributes

  • kind (String.t): Identifies what kind of resource this is. Value: the fixed string "content#shippingsettingsListResponse". Defaults to: null.
  • nextPageToken (String.t): The token for the retrieval of the next page of shipping settings. Defaults to: null.
  • resources ([ShippingSettings]): Defaults to: null.

Attributes

  • columnHeaders (Headers): Headers of the table's columns. Optional: if not set then the table has only one dimension. Defaults to: null.
  • name (String.t): Name of the table. Required for subtables, ignored for the main table. Defaults to: null.
  • rowHeaders (Headers): Headers of the table's rows. Required. Defaults to: null.
  • rows ([Row]): The list of rows that constitute the table. Must have the same length as rowHeaders. Required. Defaults to: null.

Attributes

  • customer (TestOrderCustomer): The details of the customer who placed the order. Defaults to: null.
  • enableOrderinvoices (boolean()): Whether the orderinvoices service should support this order. Defaults to: null.
  • kind (String.t): Identifies what kind of resource this is. Value: the fixed string "content#testOrder". Defaults to: null.
  • lineItems ([TestOrderLineItem]): Line items that are ordered. At least one line item must be provided. Defaults to: null.
  • notificationMode (String.t): Determines if test order must be pulled by merchant or pushed to merchant via push integration. Defaults to: null.
  • paymentMethod (TestOrderPaymentMethod): The details of the payment method. Defaults to: null.
  • predefinedDeliveryAddress (String.t): Identifier of one of the predefined delivery addresses for the delivery. Defaults to: null.
  • promotions ([OrderLegacyPromotion]): Deprecated. Ignored if provided. Defaults to: null.
  • shippingCost (Price): The price of shipping for all items. Shipping tax is automatically calculated for MFL orders. For non-MFL orders, tax settings from Merchant Center are applied. Note that shipping is not taxed in certain states. Defaults to: null.
  • shippingCostTax (Price): Deprecated. Ignored if provided. Defaults to: null.
  • shippingOption (String.t): The requested shipping option. Defaults to: null.

Attributes

  • email (String.t): Email address of the customer. Defaults to: null.
  • explicitMarketingPreference (boolean()): Deprecated. Please use marketingRightsInfo instead. Defaults to: null.
  • fullName (String.t): Full name of the customer. Defaults to: null.
  • marketingRightsInfo (TestOrderCustomerMarketingRightsInfo): Customer's marketing preferences. Defaults to: null.

Attributes

  • explicitMarketingPreference (String.t): Last know user use selection regards marketing preferences. In certain cases selection might not be known, so this field would be empty. Defaults to: null.
  • lastUpdatedTimestamp (String.t): Timestamp when last time marketing preference was updated. Could be empty, if user wasn't offered a selection yet. Defaults to: null.

Attributes

  • product (TestOrderLineItemProduct): Product data from the time of the order placement. Defaults to: null.
  • quantityOrdered (integer()): Number of items ordered. Defaults to: null.
  • returnInfo (OrderLineItemReturnInfo): Details of the return policy for the line item. Defaults to: null.
  • shippingDetails (OrderLineItemShippingDetails): Details of the requested shipping for the line item. Defaults to: null.
  • unitTax (Price): Deprecated. Ignored if provided. Defaults to: null.

Attributes

  • brand (String.t): Brand of the item. Defaults to: null.
  • channel (String.t): Deprecated. Defaults to: null.
  • condition (String.t): Condition or state of the item. Defaults to: null.
  • contentLanguage (String.t): The two-letter ISO 639-1 language code for the item. Defaults to: null.
  • fees ([OrderLineItemProductFee]): Fees for the item. Optional. Defaults to: null.
  • gtin (String.t): Global Trade Item Number (GTIN) of the item. Optional. Defaults to: null.
  • imageLink (String.t): URL of an image of the item. Defaults to: null.
  • itemGroupId (String.t): Shared identifier for all variants of the same product. Optional. Defaults to: null.
  • mpn (String.t): Manufacturer Part Number (MPN) of the item. Optional. Defaults to: null.
  • offerId (String.t): An identifier of the item. Defaults to: null.
  • price (Price): The price for the product. Tax is automatically calculated for MFL orders. For non-MFL orders, tax settings from Merchant Center are applied. Defaults to: null.
  • targetCountry (String.t): The CLDR territory code of the target country of the product. Defaults to: null.
  • title (String.t): The title of the product. Defaults to: null.
  • variantAttributes ([OrderLineItemProductVariantAttribute]): Variant attributes for the item. Optional. Defaults to: null.

Attributes

  • expirationMonth (integer()): The card expiration month (January = 1, February = 2 etc.). Defaults to: null.
  • expirationYear (integer()): The card expiration year (4-digit, e.g. 2015). Defaults to: null.
  • lastFourDigits (String.t): The last four digits of the card number. Defaults to: null.
  • predefinedBillingAddress (String.t): The billing address. Defaults to: null.
  • type (String.t): The type of instrument. Note that real orders might have different values than the four values accepted by createTestOrder. Defaults to: null.

Attributes

  • postalCodeGroupNames ([String.t]): 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. Defaults to: null.
  • rows ([TransitTableTransitTimeRow]): Defaults to: null.
  • transitTimeLabels ([String.t]): A list of transit time labels. The last value can be "all other labels". Example: ["food", "electronics", "all other labels"]. Defaults to: null.

Attributes

  • values ([TransitTableTransitTimeRowTransitTimeValue]): Defaults to: null.

Attributes

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

Attributes

  • additionalCharges ([UnitInvoiceAdditionalCharge]): Additional charges for a unit, e.g. shipping costs. Defaults to: null.
  • promotions ([Promotion]): Deprecated. Defaults to: null.
  • unitPricePretax (Price): [required] Price of the unit, before applying taxes. Defaults to: null.
  • unitPriceTaxes ([UnitInvoiceTaxLine]): Tax amounts to apply to the unit price. Defaults to: null.

Attributes

  • additionalChargeAmount (Amount): [required] Amount of the additional charge. Defaults to: null.
  • additionalChargePromotions ([Promotion]): Deprecated. Defaults to: null.
  • type (String.t): [required] Type of the additional charge. Defaults to: null.

Attributes

  • taxAmount (Price): [required] Tax amount for the tax type. Defaults to: null.
  • taxName (String.t): Optional name of the tax type. This should only be provided if taxType is otherFeeTax. Defaults to: null.
  • taxType (String.t): [required] Type of the tax. Defaults to: null.

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 (String.t): The weight unit. Defaults to: null.
  • value (String.t): The weight represented as a number. Defaults to: null.

Helper functions for building Tesla requests.