chore: update docs/dyn , add static discovery files to discovery_cache/documents (#1111)
This PR was generated using Autosynth. :rainbow:
Synth log will be available here:
https://source.cloud.google.com/results/invocations/78f53313-0c78-4a29-8841-f031665a4c6a/targets
- [ ] To automatically regenerate this PR, check this box.
Source-Link: https://github.com/googleapis/synthtool/commit/c2de32114ec484aa708d32012d1fa8d75232daf5
diff --git a/googleapiclient/discovery_cache/documents/content.v2.json b/googleapiclient/discovery_cache/documents/content.v2.json
new file mode 100644
index 0000000..eeaf8d3
--- /dev/null
+++ b/googleapiclient/discovery_cache/documents/content.v2.json
@@ -0,0 +1,10278 @@
+{
+ "ownerDomain": "google.com",
+ "schemas": {
+ "LiaInventorySettings": {
+ "type": "object",
+ "id": "LiaInventorySettings",
+ "properties": {
+ "inventoryVerificationContactStatus": {
+ "description": "The status of the verification contact. Acceptable values are: - \"`active`\" - \"`inactive`\" - \"`pending`\" ",
+ "type": "string"
+ },
+ "inventoryVerificationContactEmail": {
+ "type": "string",
+ "description": "The email of the contact for the inventory verification process."
+ },
+ "inventoryVerificationContactName": {
+ "type": "string",
+ "description": "The name of the contact for the inventory verification process."
+ },
+ "status": {
+ "type": "string",
+ "description": "The status of the inventory verification process. Acceptable values are: - \"`active`\" - \"`inactive`\" - \"`pending`\" "
+ }
+ }
+ },
+ "MerchantOrderReturn": {
+ "id": "MerchantOrderReturn",
+ "type": "object",
+ "properties": {
+ "orderReturnId": {
+ "type": "string",
+ "description": "Order return ID generated by Google."
+ },
+ "returnItems": {
+ "type": "array",
+ "items": {
+ "$ref": "MerchantOrderReturnItem"
+ },
+ "description": "Items of the return."
+ },
+ "creationDate": {
+ "type": "string",
+ "description": "The date of creation of the return, in ISO 8601 format."
+ },
+ "merchantOrderId": {
+ "description": "Merchant defined order ID.",
+ "type": "string"
+ },
+ "returnShipments": {
+ "type": "array",
+ "items": {
+ "$ref": "ReturnShipment"
+ },
+ "description": "Shipments of the return."
+ },
+ "orderId": {
+ "description": "Google order ID.",
+ "type": "string"
+ }
+ },
+ "description": "Order return. Production access (all methods) requires the order manager role. Sandbox access does not."
+ },
+ "MerchantOrderReturnItem": {
+ "id": "MerchantOrderReturnItem",
+ "properties": {
+ "merchantReturnReason": {
+ "$ref": "RefundReason",
+ "description": "The reason that merchant chooses to accept a return item."
+ },
+ "product": {
+ "description": "Product data from the time of the order placement.",
+ "$ref": "OrderLineItemProduct"
+ },
+ "customerReturnReason": {
+ "$ref": "CustomerReturnReason",
+ "description": "The reason that the customer chooses to return an item."
+ },
+ "returnShipmentIds": {
+ "description": "IDs of the return shipments that this return item belongs to.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "state": {
+ "description": "State of the item. Acceptable values are: - \"`canceled`\" - \"`new`\" - \"`received`\" - \"`refunded`\" - \"`rejected`\" ",
+ "type": "string"
+ },
+ "itemId": {
+ "description": "Product level item ID. If the returned items are of the same product, they will have the same ID.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AccountCustomerService": {
+ "type": "object",
+ "properties": {
+ "phoneNumber": {
+ "description": "Customer service phone number.",
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "description": "Customer service URL."
+ },
+ "email": {
+ "description": "Customer service email.",
+ "type": "string"
+ }
+ },
+ "id": "AccountCustomerService"
+ },
+ "Weight": {
+ "id": "Weight",
+ "type": "object",
+ "properties": {
+ "unit": {
+ "type": "string",
+ "description": "Required. The weight unit. Acceptable values are: - \"`kg`\" - \"`lb`\" "
+ },
+ "value": {
+ "type": "string",
+ "description": "Required. The weight represented as a number."
+ }
+ }
+ },
+ "DatafeedsCustomBatchResponseEntry": {
+ "type": "object",
+ "id": "DatafeedsCustomBatchResponseEntry",
+ "properties": {
+ "errors": {
+ "$ref": "Errors",
+ "description": "A list of errors defined if and only if the request failed."
+ },
+ "datafeed": {
+ "$ref": "Datafeed",
+ "description": "The requested data feed. Defined if and only if the request was successful."
+ },
+ "batchId": {
+ "format": "uint32",
+ "description": "The ID of the request entry this entry responds to.",
+ "type": "integer"
+ }
+ },
+ "description": "A batch entry encoding a single non-batch datafeeds response."
+ },
+ "ProductAmount": {
+ "type": "object",
+ "properties": {
+ "remittedTaxAmount": {
+ "description": "Remitted tax value.",
+ "$ref": "Price"
+ },
+ "priceAmount": {
+ "$ref": "Price",
+ "description": "The pre-tax or post-tax price depending on the location of the order."
+ },
+ "taxAmount": {
+ "$ref": "Price",
+ "description": "Tax value."
+ }
+ },
+ "id": "ProductAmount"
+ },
+ "OrdersCustomBatchRequestEntryShipLineItemsShipmentInfo": {
+ "id": "OrdersCustomBatchRequestEntryShipLineItemsShipmentInfo",
+ "properties": {
+ "trackingId": {
+ "description": "The tracking ID for the shipment.",
+ "type": "string"
+ },
+ "carrier": {
+ "type": "string",
+ "description": "The carrier handling the shipment. See `shipments[].carrier` in the Orders resource representation for a list of acceptable values."
+ },
+ "shipmentId": {
+ "description": "Required. The ID of the shipment. This is assigned by the merchant and is unique to each shipment.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ProductStatus": {
+ "type": "object",
+ "id": "ProductStatus",
+ "properties": {
+ "link": {
+ "description": "The link to the product.",
+ "type": "string"
+ },
+ "creationDate": {
+ "type": "string",
+ "description": "Date on which the item has been created, in ISO 8601 format."
+ },
+ "lastUpdateDate": {
+ "description": "Date on which the item has been last updated, in ISO 8601 format.",
+ "type": "string"
+ },
+ "destinationStatuses": {
+ "description": "The intended destinations for the product.",
+ "items": {
+ "$ref": "ProductStatusDestinationStatus"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#productStatus`\"",
+ "type": "string"
+ },
+ "googleExpirationDate": {
+ "type": "string",
+ "description": "Date on which the item expires in Google Shopping, in ISO 8601 format."
+ },
+ "title": {
+ "description": "The title of the product.",
+ "type": "string"
+ },
+ "product": {
+ "$ref": "Product",
+ "description": "Product data after applying all the join inputs."
+ },
+ "dataQualityIssues": {
+ "description": "DEPRECATED - never populated",
+ "type": "array",
+ "items": {
+ "$ref": "ProductStatusDataQualityIssue"
+ }
+ },
+ "itemLevelIssues": {
+ "items": {
+ "$ref": "ProductStatusItemLevelIssue"
+ },
+ "type": "array",
+ "description": "A list of all issues associated with the product."
+ },
+ "productId": {
+ "type": "string",
+ "description": "The ID of the product for which status is reported."
+ }
+ },
+ "description": "The status of a product, i.e., information about a product computed asynchronously."
+ },
+ "OrdersCustomBatchRequestEntrySetLineItemMetadata": {
+ "properties": {
+ "productId": {
+ "type": "string",
+ "description": "The ID of the product to set metadata. This is the REST ID used in the products service. Either lineItemId or productId is required."
+ },
+ "annotations": {
+ "items": {
+ "$ref": "OrderMerchantProvidedAnnotation"
+ },
+ "type": "array"
+ },
+ "lineItemId": {
+ "description": "The ID of the line item to set metadata. Either lineItemId or productId is required.",
+ "type": "string"
+ }
+ },
+ "type": "object",
+ "id": "OrdersCustomBatchRequestEntrySetLineItemMetadata"
+ },
+ "OrdersUpdateMerchantOrderIdResponse": {
+ "type": "object",
+ "properties": {
+ "executionStatus": {
+ "description": "The status of the execution. Acceptable values are: - \"`duplicate`\" - \"`executed`\" ",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersUpdateMerchantOrderIdResponse\".",
+ "type": "string"
+ }
+ },
+ "id": "OrdersUpdateMerchantOrderIdResponse"
+ },
+ "AccountsClaimWebsiteResponse": {
+ "type": "object",
+ "id": "AccountsClaimWebsiteResponse",
+ "properties": {
+ "kind": {
+ "type": "string",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#accountsClaimWebsiteResponse\"."
+ }
+ }
+ },
+ "OrderLineItemReturnInfo": {
+ "id": "OrderLineItemReturnInfo",
+ "properties": {
+ "daysToReturn": {
+ "description": "Required. How many days later the item can be returned.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "isReturnable": {
+ "type": "boolean",
+ "description": "Required. Whether the item is returnable."
+ },
+ "policyUrl": {
+ "description": "Required. URL of the item return policy.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ProductShippingWeight": {
+ "id": "ProductShippingWeight",
+ "properties": {
+ "value": {
+ "type": "number",
+ "description": "The weight of the product used to calculate the shipping cost of the item.",
+ "format": "double"
+ },
+ "unit": {
+ "description": "The unit of value.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CustomerReturnReason": {
+ "type": "object",
+ "id": "CustomerReturnReason",
+ "properties": {
+ "reasonCode": {
+ "description": "Code of the return reason. Acceptable values are: - \"`betterPriceFound`\" - \"`changedMind`\" - \"`damagedOrDefectiveItem`\" - \"`didNotMatchDescription`\" - \"`doesNotFit`\" - \"`expiredItem`\" - \"`incorrectItemReceived`\" - \"`noLongerNeeded`\" - \"`notSpecified`\" - \"`orderedWrongItem`\" - \"`other`\" - \"`qualityNotExpected`\" - \"`receivedTooLate`\" - \"`undeliverable`\" ",
+ "type": "string"
+ },
+ "description": {
+ "description": "Description of the reason.",
+ "type": "string"
+ }
+ }
+ },
+ "OrdersUpdateLineItemShippingDetailsRequest": {
+ "properties": {
+ "shipByDate": {
+ "type": "string",
+ "description": "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."
+ },
+ "operationId": {
+ "type": "string",
+ "description": "The ID of the operation. Unique across all operations for a given order."
+ },
+ "productId": {
+ "type": "string",
+ "description": "The ID of the product to set metadata. This is the REST ID used in the products service. Either lineItemId or productId is required."
+ },
+ "deliverByDate": {
+ "description": "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.",
+ "type": "string"
+ },
+ "lineItemId": {
+ "description": "The ID of the line item to set metadata. Either lineItemId or productId is required.",
+ "type": "string"
+ }
+ },
+ "type": "object",
+ "id": "OrdersUpdateLineItemShippingDetailsRequest"
+ },
+ "ShipmentInvoiceLineItemInvoice": {
+ "type": "object",
+ "id": "ShipmentInvoiceLineItemInvoice",
+ "properties": {
+ "lineItemId": {
+ "description": "ID of the line item. Either lineItemId or productId must be set.",
+ "type": "string"
+ },
+ "productId": {
+ "description": "ID of the product. This is the REST ID used in the products service. Either lineItemId or productId must be set.",
+ "type": "string"
+ },
+ "shipmentUnitIds": {
+ "description": "[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).",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "unitInvoice": {
+ "description": "[required] Invoice details for a single unit.",
+ "$ref": "UnitInvoice"
+ }
+ }
+ },
+ "Errors": {
+ "description": "A list of errors returned by a failed batch entry.",
+ "properties": {
+ "message": {
+ "type": "string",
+ "description": "The message of the first error in `errors`."
+ },
+ "code": {
+ "format": "uint32",
+ "type": "integer",
+ "description": "The HTTP status of the first error in `errors`."
+ },
+ "errors": {
+ "items": {
+ "$ref": "Error"
+ },
+ "type": "array",
+ "description": "A list of errors."
+ }
+ },
+ "id": "Errors",
+ "type": "object"
+ },
+ "DatafeedstatusesCustomBatchRequestEntry": {
+ "description": "A batch entry encoding a single non-batch datafeedstatuses request.",
+ "id": "DatafeedstatusesCustomBatchRequestEntry",
+ "type": "object",
+ "properties": {
+ "language": {
+ "description": "The language for which to get the datafeed status. If this parameter is provided then country must also be provided. Note that for multi-target datafeeds this parameter is required.",
+ "type": "string"
+ },
+ "merchantId": {
+ "type": "string",
+ "format": "uint64",
+ "description": "The ID of the managing account."
+ },
+ "method": {
+ "type": "string",
+ "description": "The method of the batch entry. Acceptable values are: - \"`get`\" "
+ },
+ "country": {
+ "type": "string",
+ "description": "The country for which to get the datafeed status. If this parameter is provided then language must also be provided. Note that for multi-target datafeeds this parameter is required."
+ },
+ "batchId": {
+ "format": "uint32",
+ "type": "integer",
+ "description": "An entry ID, unique within the batch request."
+ },
+ "datafeedId": {
+ "description": "The ID of the data feed to get.",
+ "type": "string",
+ "format": "uint64"
+ }
+ }
+ },
+ "LiasettingsRequestInventoryVerificationResponse": {
+ "type": "object",
+ "id": "LiasettingsRequestInventoryVerificationResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#liasettingsRequestInventoryVerificationResponse\".",
+ "type": "string"
+ }
+ }
+ },
+ "ProductsCustomBatchRequestEntry": {
+ "id": "ProductsCustomBatchRequestEntry",
+ "type": "object",
+ "properties": {
+ "merchantId": {
+ "description": "The ID of the managing account.",
+ "type": "string",
+ "format": "uint64"
+ },
+ "method": {
+ "description": "The method of the batch entry. Acceptable values are: - \"`delete`\" - \"`get`\" - \"`insert`\" ",
+ "type": "string"
+ },
+ "batchId": {
+ "format": "uint32",
+ "type": "integer",
+ "description": "An entry ID, unique within the batch request."
+ },
+ "productId": {
+ "type": "string",
+ "description": "The ID of the product to get or delete. Only defined if the method is `get` or `delete`."
+ },
+ "product": {
+ "description": "The product to insert. Only required if the method is `insert`.",
+ "$ref": "Product"
+ }
+ },
+ "description": "A batch entry encoding a single non-batch products request."
+ },
+ "DatafeedStatusError": {
+ "type": "object",
+ "description": "An error occurring in the feed, like \"invalid price\".",
+ "properties": {
+ "message": {
+ "description": "The error message, e.g., \"Invalid price\".",
+ "type": "string"
+ },
+ "code": {
+ "description": "The code of the error, e.g., \"validation/invalid_value\".",
+ "type": "string"
+ },
+ "count": {
+ "type": "string",
+ "description": "The number of occurrences of the error in the feed.",
+ "format": "uint64"
+ },
+ "examples": {
+ "description": "A list of example occurrences of the error, grouped by product.",
+ "items": {
+ "$ref": "DatafeedStatusExample"
+ },
+ "type": "array"
+ }
+ },
+ "id": "DatafeedStatusError"
+ },
+ "OrderreturnsListResponse": {
+ "properties": {
+ "resources": {
+ "items": {
+ "$ref": "MerchantOrderReturn"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "type": "string",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#orderreturnsListResponse\"."
+ },
+ "nextPageToken": {
+ "type": "string",
+ "description": "The token for the retrieval of the next page of returns."
+ }
+ },
+ "type": "object",
+ "id": "OrderreturnsListResponse"
+ },
+ "AccountStatusAccountLevelIssue": {
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "Issue identifier."
+ },
+ "detail": {
+ "type": "string",
+ "description": "Additional details about the issue."
+ },
+ "severity": {
+ "type": "string",
+ "description": "Severity of the issue. Acceptable values are: - \"`critical`\" - \"`error`\" - \"`suggestion`\" "
+ },
+ "documentation": {
+ "type": "string",
+ "description": "The URL of a web page to help resolving this issue."
+ },
+ "destination": {
+ "type": "string",
+ "description": "The destination the issue applies to. If this field is empty then the issue applies to all available destinations."
+ },
+ "title": {
+ "type": "string",
+ "description": "Short description of the issue."
+ },
+ "country": {
+ "type": "string",
+ "description": "Country for which this issue is reported."
+ }
+ },
+ "id": "AccountStatusAccountLevelIssue",
+ "type": "object"
+ },
+ "CarrierRate": {
+ "properties": {
+ "flatAdjustment": {
+ "$ref": "Price",
+ "description": "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."
+ },
+ "carrierName": {
+ "description": "Carrier service, such as `\"UPS\"` or `\"Fedex\"`. The list of supported carriers can be retrieved via the `getSupportedCarriers` method. Required.",
+ "type": "string"
+ },
+ "carrierService": {
+ "description": "Carrier service, such as `\"ground\"` or `\"2 days\"`. The list of supported services for a carrier can be retrieved via the `getSupportedCarriers` method. Required.",
+ "type": "string"
+ },
+ "percentageAdjustment": {
+ "type": "string",
+ "description": "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."
+ },
+ "name": {
+ "type": "string",
+ "description": "Name of the carrier rate. Must be unique per rate group. Required."
+ },
+ "originPostalCode": {
+ "type": "string",
+ "description": "Shipping origin for this carrier rate. Required."
+ }
+ },
+ "id": "CarrierRate",
+ "type": "object"
+ },
+ "AccountIdentifier": {
+ "id": "AccountIdentifier",
+ "properties": {
+ "aggregatorId": {
+ "format": "uint64",
+ "type": "string",
+ "description": "The aggregator ID, set for aggregators and subaccounts (in that case, it represents the aggregator of the subaccount)."
+ },
+ "merchantId": {
+ "format": "uint64",
+ "type": "string",
+ "description": "The merchant account ID, set for individual accounts and subaccounts."
+ }
+ },
+ "type": "object"
+ },
+ "LiasettingsCustomBatchResponse": {
+ "id": "LiasettingsCustomBatchResponse",
+ "type": "object",
+ "properties": {
+ "entries": {
+ "description": "The result of the execution of the batch requests.",
+ "type": "array",
+ "items": {
+ "$ref": "LiasettingsCustomBatchResponseEntry"
+ }
+ },
+ "kind": {
+ "type": "string",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#liasettingsCustomBatchResponse\"."
+ }
+ }
+ },
+ "InventoryCustomBatchRequestEntry": {
+ "id": "InventoryCustomBatchRequestEntry",
+ "properties": {
+ "inventory": {
+ "description": "Price and availability of the product.",
+ "$ref": "Inventory"
+ },
+ "batchId": {
+ "format": "uint32",
+ "type": "integer",
+ "description": "An entry ID, unique within the batch request."
+ },
+ "productId": {
+ "description": "The ID of the product for which to update price and availability.",
+ "type": "string"
+ },
+ "storeCode": {
+ "type": "string",
+ "description": "The code of the store for which to update price and availability. Use `online` to update price and availability of an online product."
+ },
+ "merchantId": {
+ "format": "uint64",
+ "type": "string",
+ "description": "The ID of the managing account."
+ }
+ },
+ "description": "A batch entry encoding a single non-batch inventory request.",
+ "type": "object"
+ },
+ "PostalCodeGroup": {
+ "properties": {
+ "country": {
+ "type": "string",
+ "description": "The CLDR territory code of the country the postal code group applies to. Required."
+ },
+ "postalCodeRanges": {
+ "type": "array",
+ "description": "A range of postal codes. Required.",
+ "items": {
+ "$ref": "PostalCodeRange"
+ }
+ },
+ "name": {
+ "description": "The name of the postal code group, referred to in headers. Required.",
+ "type": "string"
+ }
+ },
+ "id": "PostalCodeGroup",
+ "type": "object"
+ },
+ "MinimumOrderValueTableStoreCodeSetWithMov": {
+ "properties": {
+ "value": {
+ "$ref": "Price",
+ "description": "The minimum order value for the given stores."
+ },
+ "storeCodes": {
+ "description": "A list of unique store codes or empty for the catch all.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "type": "object",
+ "description": "A list of store code sets sharing the same minimum order value. At least two sets are required and the last one must be empty, which signifies 'MOV for all other stores'. Each store code can only appear once across all the sets. All prices within a service must have the same currency.",
+ "id": "MinimumOrderValueTableStoreCodeSetWithMov"
+ },
+ "InventorySetRequest": {
+ "id": "InventorySetRequest",
+ "type": "object",
+ "properties": {
+ "loyaltyPoints": {
+ "$ref": "LoyaltyPoints",
+ "description": "Loyalty points that users receive after purchasing the item. Japan only."
+ },
+ "salePrice": {
+ "description": "The sale price of the product. Mandatory if `sale_price_effective_date` is defined.",
+ "$ref": "Price"
+ },
+ "customLabel3": {
+ "description": "Custom label 3 for custom grouping of items in a Shopping campaign. Only supported for online products.",
+ "type": "string"
+ },
+ "availability": {
+ "description": "The availability of the product. Acceptable values are: - \"`in stock`\" - \"`out of stock`\" - \"`preorder`\" ",
+ "type": "string"
+ },
+ "price": {
+ "$ref": "Price",
+ "description": "The price of the product."
+ },
+ "customLabel0": {
+ "type": "string",
+ "description": "Custom label 0 for custom grouping of items in a Shopping campaign. Only supported for online products."
+ },
+ "customLabel1": {
+ "type": "string",
+ "description": "Custom label 1 for custom grouping of items in a Shopping campaign. Only supported for online products."
+ },
+ "customLabel4": {
+ "type": "string",
+ "description": "Custom label 3 for custom grouping of items in a Shopping campaign. Only supported for online products."
+ },
+ "quantity": {
+ "format": "uint32",
+ "type": "integer",
+ "description": "The quantity of the product. Must be equal to or greater than zero. Supported only for local products."
+ },
+ "customLabel2": {
+ "description": "Custom label 2 for custom grouping of items in a Shopping campaign. Only supported for online products.",
+ "type": "string"
+ },
+ "instoreProductLocation": {
+ "description": "The instore product location. Supported only for local products.",
+ "type": "string"
+ },
+ "sellOnGoogleQuantity": {
+ "type": "integer",
+ "description": "The quantity of the product that is available for selling on Google. Supported only for online products.",
+ "format": "uint32"
+ },
+ "installment": {
+ "$ref": "Installment",
+ "description": "Number and amount of installments to pay for an item. Brazil only."
+ },
+ "pickup": {
+ "description": "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\".",
+ "$ref": "InventoryPickup"
+ },
+ "salePriceEffectiveDate": {
+ "description": "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.",
+ "type": "string"
+ }
+ }
+ },
+ "TestOrderCustomerMarketingRightsInfo": {
+ "type": "object",
+ "id": "TestOrderCustomerMarketingRightsInfo",
+ "properties": {
+ "explicitMarketingPreference": {
+ "description": "Last know user use selection regards marketing preferences. In certain cases selection might not be known, so this field would be empty. Acceptable values are: - \"`denied`\" - \"`granted`\" ",
+ "type": "string"
+ },
+ "lastUpdatedTimestamp": {
+ "type": "string",
+ "description": "Timestamp when last time marketing preference was updated. Could be empty, if user wasn't offered a selection yet."
+ }
+ }
+ },
+ "OrdersCustomBatchRequestEntryRefund": {
+ "type": "object",
+ "properties": {
+ "amountTax": {
+ "description": "Tax amount that corresponds to refund amount in amountPretax. Optional, but if filled, amountPretax must be set. Calculated automatically if not provided.",
+ "$ref": "Price"
+ },
+ "amountPretax": {
+ "description": "The amount that is refunded. Either amount or amountPretax should be filled.",
+ "$ref": "Price"
+ },
+ "amount": {
+ "description": "Deprecated. Please use amountPretax and amountTax instead.",
+ "$ref": "Price"
+ },
+ "reasonText": {
+ "description": "The explanation of the reason.",
+ "type": "string"
+ },
+ "reason": {
+ "type": "string",
+ "description": "The reason for the refund. Acceptable values are: - \"`adjustment`\" - \"`courtesyAdjustment`\" - \"`customerCanceled`\" - \"`customerDiscretionaryReturn`\" - \"`deliveredLateByCarrier`\" - \"`feeAdjustment`\" - \"`lateShipmentCredit`\" - \"`noInventory`\" - \"`other`\" - \"`priceError`\" - \"`productArrivedDamaged`\" - \"`productNotAsDescribed`\" - \"`shippingCostAdjustment`\" - \"`taxAdjustment`\" - \"`undeliverableShippingAddress`\" - \"`wrongProductShipped`\" "
+ }
+ },
+ "id": "OrdersCustomBatchRequestEntryRefund"
+ },
+ "OrderPickupDetails": {
+ "type": "object",
+ "id": "OrderPickupDetails",
+ "properties": {
+ "locationId": {
+ "type": "string",
+ "description": "ID of the pickup location."
+ },
+ "collectors": {
+ "description": "Collectors authorized to pick up shipment from the pickup location.",
+ "items": {
+ "$ref": "OrderPickupDetailsCollector"
+ },
+ "type": "array"
+ },
+ "address": {
+ "description": "Address of the pickup location where the shipment should be sent. Note that `recipientName` in the address is the name of the business at the pickup location.",
+ "$ref": "OrderAddress"
+ }
+ }
+ },
+ "OrderShipmentScheduledDeliveryDetails": {
+ "type": "object",
+ "id": "OrderShipmentScheduledDeliveryDetails",
+ "properties": {
+ "carrierPhoneNumber": {
+ "description": "The phone number of the carrier fulfilling the delivery. The phone number is formatted as the international notation in ITU-T Recommendation E.123 (e.g., \"+41 44 668 1800\").",
+ "type": "string"
+ },
+ "scheduledDate": {
+ "description": "The date a shipment is scheduled for delivery, in ISO 8601 format.",
+ "type": "string"
+ }
+ }
+ },
+ "TransitTableTransitTimeRow": {
+ "properties": {
+ "values": {
+ "type": "array",
+ "items": {
+ "$ref": "TransitTableTransitTimeRowTransitTimeValue"
+ }
+ }
+ },
+ "type": "object",
+ "id": "TransitTableTransitTimeRow"
+ },
+ "AccountStatusDataQualityIssue": {
+ "properties": {
+ "country": {
+ "type": "string"
+ },
+ "id": {
+ "type": "string"
+ },
+ "submittedValue": {
+ "type": "string"
+ },
+ "numItems": {
+ "type": "integer",
+ "format": "uint32"
+ },
+ "detail": {
+ "type": "string"
+ },
+ "lastChecked": {
+ "type": "string"
+ },
+ "destination": {
+ "type": "string"
+ },
+ "exampleItems": {
+ "items": {
+ "$ref": "AccountStatusExampleItem"
+ },
+ "type": "array"
+ },
+ "location": {
+ "type": "string"
+ },
+ "displayedValue": {
+ "type": "string"
+ },
+ "severity": {
+ "description": " Acceptable values are: - \"`critical`\" - \"`error`\" - \"`suggestion`\" ",
+ "type": "string"
+ }
+ },
+ "type": "object",
+ "id": "AccountStatusDataQualityIssue"
+ },
+ "OrderLegacyPromotionBenefit": {
+ "properties": {
+ "type": {
+ "type": "string",
+ "description": "Describes whether the promotion applies to products (e.g. 20% off) or to shipping (e.g. Free Shipping). Acceptable values are: - \"`product`\" - \"`shipping`\" "
+ },
+ "taxImpact": {
+ "$ref": "Price",
+ "description": "The impact on tax when the promotion is applied."
+ },
+ "discount": {
+ "$ref": "Price",
+ "description": "The discount in the order price when the promotion is applied."
+ },
+ "subType": {
+ "type": "string",
+ "description": "Further describes the benefit of the promotion. Note that we will expand on this enumeration as we support new promotion sub-types. Acceptable values are: - \"`buyMGetMoneyOff`\" - \"`buyMGetNMoneyOff`\" - \"`buyMGetNPercentOff`\" - \"`buyMGetPercentOff`\" - \"`freeGift`\" - \"`freeGiftWithItemId`\" - \"`freeGiftWithValue`\" - \"`freeOvernightShipping`\" - \"`freeShipping`\" - \"`freeTwoDayShipping`\" - \"`moneyOff`\" - \"`percentageOff`\" - \"`rewardPoints`\" - \"`salePrice`\" "
+ },
+ "offerIds": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "The OfferId(s) that were purchased in this order and map to this specific benefit of the promotion."
+ }
+ },
+ "id": "OrderLegacyPromotionBenefit",
+ "type": "object"
+ },
+ "OrderLineItemShippingDetailsMethod": {
+ "id": "OrderLineItemShippingDetailsMethod",
+ "type": "object",
+ "properties": {
+ "minDaysInTransit": {
+ "format": "uint32",
+ "description": "Required. Minimum transit time.",
+ "type": "integer"
+ },
+ "maxDaysInTransit": {
+ "description": "Required. Maximum transit time.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "methodName": {
+ "description": "Required. The name of the shipping method.",
+ "type": "string"
+ },
+ "carrier": {
+ "description": "The carrier for the shipping. Optional. See `shipments[].carrier` for a list of acceptable values.",
+ "type": "string"
+ }
+ }
+ },
+ "ProductsCustomBatchResponse": {
+ "properties": {
+ "kind": {
+ "type": "string",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#productsCustomBatchResponse\"."
+ },
+ "entries": {
+ "type": "array",
+ "description": "The result of the execution of the batch requests.",
+ "items": {
+ "$ref": "ProductsCustomBatchResponseEntry"
+ }
+ }
+ },
+ "id": "ProductsCustomBatchResponse",
+ "type": "object"
+ },
+ "PosCustomBatchResponseEntry": {
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#posCustomBatchResponseEntry`\"",
+ "type": "string"
+ },
+ "sale": {
+ "description": "The updated sale information.",
+ "$ref": "PosSale"
+ },
+ "batchId": {
+ "description": "The ID of the request entry to which this entry responds.",
+ "type": "integer",
+ "format": "uint32"
+ },
+ "store": {
+ "$ref": "PosStore",
+ "description": "The retrieved or updated store information."
+ },
+ "errors": {
+ "description": "A list of errors defined if, and only if, the request failed.",
+ "$ref": "Errors"
+ },
+ "inventory": {
+ "description": "The updated inventory information.",
+ "$ref": "PosInventory"
+ }
+ },
+ "type": "object",
+ "id": "PosCustomBatchResponseEntry"
+ },
+ "OrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceReturnOption": {
+ "properties": {
+ "reason": {
+ "type": "string",
+ "description": "[required] Reason for the return. Acceptable values are: - \"`customerDiscretionaryReturn`\" - \"`customerInitiatedMerchantCancel`\" - \"`deliveredTooLate`\" - \"`expiredItem`\" - \"`invalidCoupon`\" - \"`malformedShippingAddress`\" - \"`other`\" - \"`productArrivedDamaged`\" - \"`productNotAsDescribed`\" - \"`qualityNotAsExpected`\" - \"`undeliverableShippingAddress`\" - \"`unsupportedPoBoxAddress`\" - \"`wrongProductShipped`\" "
+ },
+ "description": {
+ "description": "Optional description of the return reason.",
+ "type": "string"
+ }
+ },
+ "id": "OrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceReturnOption",
+ "type": "object"
+ },
+ "OrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceRefundOption": {
+ "id": "OrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceRefundOption",
+ "type": "object",
+ "properties": {
+ "description": {
+ "type": "string",
+ "description": "Optional description of the refund reason."
+ },
+ "reason": {
+ "type": "string",
+ "description": "[required] Reason for the refund. Acceptable values are: - \"`adjustment`\" - \"`autoPostInternal`\" - \"`autoPostInvalidBillingAddress`\" - \"`autoPostNoInventory`\" - \"`autoPostPriceError`\" - \"`autoPostUndeliverableShippingAddress`\" - \"`couponAbuse`\" - \"`courtesyAdjustment`\" - \"`customerCanceled`\" - \"`customerDiscretionaryReturn`\" - \"`customerInitiatedMerchantCancel`\" - \"`customerSupportRequested`\" - \"`deliveredLateByCarrier`\" - \"`deliveredTooLate`\" - \"`expiredItem`\" - \"`failToPushOrderGoogleError`\" - \"`failToPushOrderMerchantError`\" - \"`failToPushOrderMerchantFulfillmentError`\" - \"`failToPushOrderToMerchant`\" - \"`failToPushOrderToMerchantOutOfStock`\" - \"`feeAdjustment`\" - \"`invalidCoupon`\" - \"`lateShipmentCredit`\" - \"`malformedShippingAddress`\" - \"`merchantDidNotShipOnTime`\" - \"`noInventory`\" - \"`orderTimeout`\" - \"`other`\" - \"`paymentAbuse`\" - \"`paymentDeclined`\" - \"`priceAdjustment`\" - \"`priceError`\" - \"`productArrivedDamaged`\" - \"`productNotAsDescribed`\" - \"`promoReallocation`\" - \"`qualityNotAsExpected`\" - \"`returnRefundAbuse`\" - \"`shippingCostAdjustment`\" - \"`shippingPriceError`\" - \"`taxAdjustment`\" - \"`taxError`\" - \"`undeliverableShippingAddress`\" - \"`unsupportedPoBoxAddress`\" - \"`wrongProductShipped`\" "
+ }
+ }
+ },
+ "OrdersShipLineItemsResponse": {
+ "id": "OrdersShipLineItemsResponse",
+ "properties": {
+ "executionStatus": {
+ "type": "string",
+ "description": "The status of the execution. Acceptable values are: - \"`duplicate`\" - \"`executed`\" "
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersShipLineItemsResponse\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ShippingsettingsGetSupportedPickupServicesResponse": {
+ "properties": {
+ "pickupServices": {
+ "items": {
+ "$ref": "PickupServicesPickupService"
+ },
+ "type": "array",
+ "description": "A list of supported pickup services. May be empty."
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#shippingsettingsGetSupportedPickupServicesResponse\".",
+ "type": "string"
+ }
+ },
+ "type": "object",
+ "id": "ShippingsettingsGetSupportedPickupServicesResponse"
+ },
+ "OrderCustomer": {
+ "type": "object",
+ "id": "OrderCustomer",
+ "properties": {
+ "email": {
+ "description": "Deprecated.",
+ "type": "string"
+ },
+ "invoiceReceivingEmail": {
+ "type": "string",
+ "description": "Email address for the merchant to send value-added tax or invoice documentation of the order. Only the last document sent is made available to the customer. For more information, see About automated VAT invoicing for Buy on Google."
+ },
+ "explicitMarketingPreference": {
+ "description": "Deprecated. Please use marketingRightsInfo instead.",
+ "type": "boolean"
+ },
+ "fullName": {
+ "type": "string",
+ "description": "Full name of the customer."
+ },
+ "marketingRightsInfo": {
+ "description": "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.",
+ "$ref": "OrderCustomerMarketingRightsInfo"
+ }
+ }
+ },
+ "OrdersReturnRefundLineItemResponse": {
+ "properties": {
+ "executionStatus": {
+ "type": "string",
+ "description": "The status of the execution. Acceptable values are: - \"`duplicate`\" - \"`executed`\" "
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersReturnRefundLineItemResponse\".",
+ "type": "string"
+ }
+ },
+ "id": "OrdersReturnRefundLineItemResponse",
+ "type": "object"
+ },
+ "LiaSettings": {
+ "type": "object",
+ "id": "LiaSettings",
+ "properties": {
+ "accountId": {
+ "format": "uint64",
+ "type": "string",
+ "description": "The ID of the account to which these LIA settings belong. Ignored upon update, always present in get request responses."
+ },
+ "countrySettings": {
+ "type": "array",
+ "items": {
+ "$ref": "LiaCountrySettings"
+ },
+ "description": "The LIA settings for each country."
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#liaSettings`\"",
+ "type": "string"
+ }
+ },
+ "description": "Local Inventory ads (LIA) settings. All methods except listposdataproviders require the admin role."
+ },
+ "PosSale": {
+ "description": "The change of the available quantity of an item at the given store.",
+ "type": "object",
+ "properties": {
+ "gtin": {
+ "description": "Global Trade Item Number.",
+ "type": "string"
+ },
+ "itemId": {
+ "description": "Required. A unique identifier for the item.",
+ "type": "string"
+ },
+ "contentLanguage": {
+ "type": "string",
+ "description": "Required. The two-letter ISO 639-1 language code for the item."
+ },
+ "kind": {
+ "type": "string",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#posSale`\""
+ },
+ "timestamp": {
+ "description": "Required. The inventory timestamp, in ISO 8601 format.",
+ "type": "string"
+ },
+ "targetCountry": {
+ "type": "string",
+ "description": "Required. The CLDR territory code for the item."
+ },
+ "storeCode": {
+ "description": "Required. The identifier of the merchant's store. Either a `storeCode` inserted via the API or the code of the store in Google My Business.",
+ "type": "string"
+ },
+ "quantity": {
+ "format": "int64",
+ "type": "string",
+ "description": "Required. The relative change of the available quantity. Negative for items returned."
+ },
+ "saleId": {
+ "description": "A unique ID to group items from the same sale event.",
+ "type": "string"
+ },
+ "price": {
+ "$ref": "Price",
+ "description": "Required. The price of the item."
+ }
+ },
+ "id": "PosSale"
+ },
+ "Promotion": {
+ "type": "object",
+ "properties": {
+ "promotionId": {
+ "description": "[required] ID of the promotion.",
+ "type": "string"
+ },
+ "promotionAmount": {
+ "$ref": "Amount",
+ "description": "[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."
+ }
+ },
+ "id": "Promotion"
+ },
+ "OrdersAdvanceTestOrderResponse": {
+ "id": "OrdersAdvanceTestOrderResponse",
+ "type": "object",
+ "properties": {
+ "kind": {
+ "type": "string",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersAdvanceTestOrderResponse\"."
+ }
+ }
+ },
+ "Installment": {
+ "properties": {
+ "amount": {
+ "description": "The amount the buyer has to pay per month.",
+ "$ref": "Price"
+ },
+ "months": {
+ "type": "string",
+ "format": "int64",
+ "description": "The number of installments the buyer has to pay."
+ }
+ },
+ "type": "object",
+ "id": "Installment"
+ },
+ "OrderinvoicesCreateChargeInvoiceResponse": {
+ "type": "object",
+ "properties": {
+ "kind": {
+ "type": "string",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#orderinvoicesCreateChargeInvoiceResponse\"."
+ },
+ "executionStatus": {
+ "type": "string",
+ "description": "The status of the execution. Acceptable values are: - \"`duplicate`\" - \"`executed`\" "
+ }
+ },
+ "id": "OrderinvoicesCreateChargeInvoiceResponse"
+ },
+ "ProductTax": {
+ "type": "object",
+ "id": "ProductTax",
+ "properties": {
+ "postalCode": {
+ "type": "string",
+ "description": "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*."
+ },
+ "region": {
+ "type": "string",
+ "description": "The geographic region to which the tax rate applies."
+ },
+ "locationId": {
+ "description": "The numeric ID of a location that the tax rate applies to as defined in the AdWords API.",
+ "type": "string",
+ "format": "int64"
+ },
+ "taxShip": {
+ "type": "boolean",
+ "description": "Should be set to true if tax is charged on shipping."
+ },
+ "country": {
+ "description": "The country within which the item is taxed, specified as a CLDR territory code.",
+ "type": "string"
+ },
+ "rate": {
+ "description": "The percentage of tax rate that applies to the item price.",
+ "format": "double",
+ "type": "number"
+ }
+ }
+ },
+ "ShippingsettingsCustomBatchResponse": {
+ "properties": {
+ "entries": {
+ "description": "The result of the execution of the batch requests.",
+ "type": "array",
+ "items": {
+ "$ref": "ShippingsettingsCustomBatchResponseEntry"
+ }
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#shippingsettingsCustomBatchResponse\".",
+ "type": "string"
+ }
+ },
+ "id": "ShippingsettingsCustomBatchResponse",
+ "type": "object"
+ },
+ "AccountTax": {
+ "properties": {
+ "kind": {
+ "type": "string",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#accountTax\"."
+ },
+ "rules": {
+ "type": "array",
+ "description": "Tax rules. Updating the tax rules will enable US taxes (not reversible). Defining no rules is equivalent to not charging tax at all.",
+ "items": {
+ "$ref": "AccountTaxTaxRule"
+ }
+ },
+ "accountId": {
+ "type": "string",
+ "format": "uint64",
+ "description": "Required. The ID of the account to which these account tax settings belong."
+ }
+ },
+ "type": "object",
+ "description": "The tax settings of a merchant account. All methods require the admin role.",
+ "id": "AccountTax"
+ },
+ "LiasettingsListPosDataProvidersResponse": {
+ "properties": {
+ "posDataProviders": {
+ "items": {
+ "$ref": "PosDataProviders"
+ },
+ "type": "array",
+ "description": "The list of POS data providers for each eligible country"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#liasettingsListPosDataProvidersResponse\".",
+ "type": "string"
+ }
+ },
+ "type": "object",
+ "id": "LiasettingsListPosDataProvidersResponse"
+ },
+ "TestOrderLineItem": {
+ "properties": {
+ "shippingDetails": {
+ "$ref": "OrderLineItemShippingDetails",
+ "description": "Required. Details of the requested shipping for the line item."
+ },
+ "quantityOrdered": {
+ "description": "Required. Number of items ordered.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "returnInfo": {
+ "$ref": "OrderLineItemReturnInfo",
+ "description": "Required. Details of the return policy for the line item."
+ },
+ "product": {
+ "description": "Required. Product data from the time of the order placement.",
+ "$ref": "TestOrderLineItemProduct"
+ },
+ "unitTax": {
+ "description": "Deprecated. Ignored if provided.",
+ "$ref": "Price"
+ }
+ },
+ "id": "TestOrderLineItem",
+ "type": "object"
+ },
+ "ProductStatusItemLevelIssue": {
+ "type": "object",
+ "properties": {
+ "code": {
+ "type": "string",
+ "description": "The error code of the issue."
+ },
+ "description": {
+ "type": "string",
+ "description": "A short issue description in English."
+ },
+ "destination": {
+ "description": "The destination the issue applies to.",
+ "type": "string"
+ },
+ "documentation": {
+ "type": "string",
+ "description": "The URL of a web page to help with resolving this issue."
+ },
+ "attributeName": {
+ "type": "string",
+ "description": "The attribute's name, if the issue is caused by a single attribute."
+ },
+ "servability": {
+ "type": "string",
+ "description": "How this issue affects serving of the offer."
+ },
+ "detail": {
+ "type": "string",
+ "description": "A detailed issue description in English."
+ },
+ "resolution": {
+ "description": "Whether the issue can be resolved by the merchant.",
+ "type": "string"
+ }
+ },
+ "id": "ProductStatusItemLevelIssue"
+ },
+ "OrderReportDisbursement": {
+ "properties": {
+ "disbursementCreationDate": {
+ "type": "string",
+ "description": "The disbursement date, in ISO 8601 format."
+ },
+ "disbursementAmount": {
+ "$ref": "Price",
+ "description": "The disbursement amount."
+ },
+ "merchantId": {
+ "type": "string",
+ "format": "uint64",
+ "description": "The ID of the managing account."
+ },
+ "disbursementId": {
+ "description": "The ID of the disbursement.",
+ "type": "string"
+ },
+ "disbursementDate": {
+ "description": "The date the disbursement was initiated, in ISO 8601 format.",
+ "type": "string"
+ }
+ },
+ "id": "OrderReportDisbursement",
+ "type": "object",
+ "description": "Order disbursement. All methods require the payment analyst role."
+ },
+ "OrderShipmentLineItemShipment": {
+ "type": "object",
+ "properties": {
+ "productId": {
+ "type": "string",
+ "description": "The ID of the product to ship. This is the REST ID used in the products service. Either lineItemId or productId is required."
+ },
+ "quantity": {
+ "description": "The quantity that is shipped.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "lineItemId": {
+ "type": "string",
+ "description": "The ID of the line item that is shipped. This value is assigned by Google when an order is created. Either lineItemId or productId is required."
+ }
+ },
+ "id": "OrderShipmentLineItemShipment"
+ },
+ "OrdersShipLineItemsRequest": {
+ "id": "OrdersShipLineItemsRequest",
+ "properties": {
+ "trackingId": {
+ "description": "Deprecated. Please use shipmentInfo instead. The tracking ID for the shipment.",
+ "type": "string"
+ },
+ "carrier": {
+ "type": "string",
+ "description": "Deprecated. Please use shipmentInfo instead. The carrier handling the shipment. See `shipments[].carrier` in the Orders resource representation for a list of acceptable values."
+ },
+ "shipmentId": {
+ "description": "Deprecated. Please use shipmentInfo instead. The ID of the shipment.",
+ "type": "string"
+ },
+ "lineItems": {
+ "type": "array",
+ "description": "Line items to ship.",
+ "items": {
+ "$ref": "OrderShipmentLineItemShipment"
+ }
+ },
+ "shipmentGroupId": {
+ "type": "string",
+ "description": "ID of the shipment group. Required for orders that use the orderinvoices service."
+ },
+ "shipmentInfos": {
+ "items": {
+ "$ref": "OrdersCustomBatchRequestEntryShipLineItemsShipmentInfo"
+ },
+ "type": "array",
+ "description": "Shipment information. This field is repeated because a single line item can be shipped in several packages (and have several tracking IDs)."
+ },
+ "operationId": {
+ "type": "string",
+ "description": "The ID of the operation. Unique across all operations for a given order."
+ }
+ },
+ "type": "object"
+ },
+ "LiaPosDataProvider": {
+ "type": "object",
+ "id": "LiaPosDataProvider",
+ "properties": {
+ "posExternalAccountId": {
+ "type": "string",
+ "description": "The account ID by which this merchant is known to the POS data provider."
+ },
+ "posDataProviderId": {
+ "format": "uint64",
+ "type": "string",
+ "description": "The ID of the POS data provider."
+ }
+ }
+ },
+ "DatafeedsCustomBatchRequest": {
+ "properties": {
+ "entries": {
+ "description": "The request entries to be processed in the batch.",
+ "type": "array",
+ "items": {
+ "$ref": "DatafeedsCustomBatchRequestEntry"
+ }
+ }
+ },
+ "id": "DatafeedsCustomBatchRequest",
+ "type": "object"
+ },
+ "CutoffTime": {
+ "type": "object",
+ "id": "CutoffTime",
+ "properties": {
+ "minute": {
+ "type": "integer",
+ "format": "uint32",
+ "description": "Minute of the cutoff time until which an order has to be placed to be processed in the same day. Required."
+ },
+ "hour": {
+ "description": "Hour of the cutoff time until which an order has to be placed to be processed in the same day. Required.",
+ "type": "integer",
+ "format": "uint32"
+ },
+ "timezone": {
+ "description": "Timezone identifier for the cutoff time. A list of identifiers can be found in the AdWords API documentation. E.g. \"Europe/Zurich\". Required.",
+ "type": "string"
+ }
+ }
+ },
+ "MinimumOrderValueTable": {
+ "id": "MinimumOrderValueTable",
+ "properties": {
+ "storeCodeSetWithMovs": {
+ "type": "array",
+ "items": {
+ "$ref": "MinimumOrderValueTableStoreCodeSetWithMov"
+ }
+ }
+ },
+ "type": "object"
+ },
+ "OrdersCustomBatchRequestEntryCreateTestReturnReturnItem": {
+ "type": "object",
+ "id": "OrdersCustomBatchRequestEntryCreateTestReturnReturnItem",
+ "properties": {
+ "lineItemId": {
+ "description": "The ID of the line item to return.",
+ "type": "string"
+ },
+ "quantity": {
+ "format": "uint32",
+ "type": "integer",
+ "description": "Quantity that is returned."
+ }
+ }
+ },
+ "ShippingSettings": {
+ "description": "The merchant account's shipping settings. All methods except getsupportedcarriers and getsupportedholidays require the admin role.",
+ "type": "object",
+ "id": "ShippingSettings",
+ "properties": {
+ "services": {
+ "items": {
+ "$ref": "Service"
+ },
+ "description": "The target account's list of services. Optional.",
+ "type": "array"
+ },
+ "postalCodeGroups": {
+ "description": "A list of postal code groups that can be referred to in `services`. Optional.",
+ "type": "array",
+ "items": {
+ "$ref": "PostalCodeGroup"
+ }
+ },
+ "accountId": {
+ "description": "The ID of the account to which these account shipping settings belong. Ignored upon update, always present in get request responses.",
+ "type": "string",
+ "format": "uint64"
+ }
+ }
+ },
+ "OrderLineItemProductVariantAttribute": {
+ "id": "OrderLineItemProductVariantAttribute",
+ "properties": {
+ "value": {
+ "type": "string",
+ "description": "The value for the dimension."
+ },
+ "dimension": {
+ "type": "string",
+ "description": "The dimension of the variant."
+ }
+ },
+ "type": "object"
+ },
+ "PosCustomBatchRequest": {
+ "properties": {
+ "entries": {
+ "type": "array",
+ "items": {
+ "$ref": "PosCustomBatchRequestEntry"
+ },
+ "description": "The request entries to be processed in the batch."
+ }
+ },
+ "type": "object",
+ "id": "PosCustomBatchRequest"
+ },
+ "OrdersReturnLineItemResponse": {
+ "properties": {
+ "kind": {
+ "type": "string",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersReturnLineItemResponse\"."
+ },
+ "executionStatus": {
+ "description": "The status of the execution. Acceptable values are: - \"`duplicate`\" - \"`executed`\" ",
+ "type": "string"
+ }
+ },
+ "type": "object",
+ "id": "OrdersReturnLineItemResponse"
+ },
+ "UnitInvoiceTaxLine": {
+ "type": "object",
+ "properties": {
+ "taxName": {
+ "type": "string",
+ "description": "Optional name of the tax type. This should only be provided if `taxType` is `otherFeeTax`."
+ },
+ "taxAmount": {
+ "description": "[required] Tax amount for the tax type.",
+ "$ref": "Price"
+ },
+ "taxType": {
+ "type": "string",
+ "description": "[required] Type of the tax. Acceptable values are: - \"`otherFee`\" - \"`otherFeeTax`\" - \"`sales`\" "
+ }
+ },
+ "id": "UnitInvoiceTaxLine"
+ },
+ "OrdersCustomBatchRequestEntryUpdateLineItemShippingDetails": {
+ "properties": {
+ "productId": {
+ "type": "string",
+ "description": "The ID of the product to set metadata. This is the REST ID used in the products service. Either lineItemId or productId is required."
+ },
+ "lineItemId": {
+ "type": "string",
+ "description": "The ID of the line item to set metadata. Either lineItemId or productId is required."
+ },
+ "deliverByDate": {
+ "type": "string",
+ "description": "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."
+ },
+ "shipByDate": {
+ "type": "string",
+ "description": "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."
+ }
+ },
+ "type": "object",
+ "id": "OrdersCustomBatchRequestEntryUpdateLineItemShippingDetails"
+ },
+ "OrderinvoicesCreateRefundInvoiceResponse": {
+ "id": "OrderinvoicesCreateRefundInvoiceResponse",
+ "properties": {
+ "executionStatus": {
+ "type": "string",
+ "description": "The status of the execution. Acceptable values are: - \"`duplicate`\" - \"`executed`\" "
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#orderinvoicesCreateRefundInvoiceResponse\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "InventoryCustomBatchResponseEntry": {
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#inventoryCustomBatchResponseEntry`\"",
+ "type": "string"
+ },
+ "errors": {
+ "$ref": "Errors",
+ "description": "A list of errors defined if and only if the request failed."
+ },
+ "batchId": {
+ "format": "uint32",
+ "type": "integer",
+ "description": "The ID of the request entry this entry responds to."
+ }
+ },
+ "type": "object",
+ "description": "A batch entry encoding a single non-batch inventory response.",
+ "id": "InventoryCustomBatchResponseEntry"
+ },
+ "OrdersCancelLineItemResponse": {
+ "properties": {
+ "kind": {
+ "type": "string",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersCancelLineItemResponse\"."
+ },
+ "executionStatus": {
+ "description": "The status of the execution. Acceptable values are: - \"`duplicate`\" - \"`executed`\" ",
+ "type": "string"
+ }
+ },
+ "type": "object",
+ "id": "OrdersCancelLineItemResponse"
+ },
+ "AccountsListResponse": {
+ "id": "AccountsListResponse",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "type": "string",
+ "description": "The token for the retrieval of the next page of accounts."
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#accountsListResponse\".",
+ "type": "string"
+ },
+ "resources": {
+ "type": "array",
+ "items": {
+ "$ref": "Account"
+ }
+ }
+ }
+ },
+ "ProductstatusesListResponse": {
+ "properties": {
+ "resources": {
+ "type": "array",
+ "items": {
+ "$ref": "ProductStatus"
+ }
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#productstatusesListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "The token for the retrieval of the next page of products statuses.",
+ "type": "string"
+ }
+ },
+ "type": "object",
+ "id": "ProductstatusesListResponse"
+ },
+ "AccountsCustomBatchRequestEntryLinkRequest": {
+ "properties": {
+ "linkType": {
+ "type": "string",
+ "description": "Type of the link between the two accounts. Acceptable values are: - \"`channelPartner`\" - \"`eCommercePlatform`\" "
+ },
+ "linkedAccountId": {
+ "type": "string",
+ "description": "The ID of the linked account."
+ },
+ "action": {
+ "type": "string",
+ "description": "Action to perform for this link. The `\"request\"` action is only available to select merchants. Acceptable values are: - \"`approve`\" - \"`remove`\" - \"`request`\" "
+ }
+ },
+ "type": "object",
+ "id": "AccountsCustomBatchRequestEntryLinkRequest"
+ },
+ "OrdersCancelRequest": {
+ "type": "object",
+ "properties": {
+ "reason": {
+ "description": "The reason for the cancellation. Acceptable values are: - \"`customerInitiatedCancel`\" - \"`invalidCoupon`\" - \"`malformedShippingAddress`\" - \"`noInventory`\" - \"`other`\" - \"`priceError`\" - \"`shippingPriceError`\" - \"`taxError`\" - \"`undeliverableShippingAddress`\" - \"`unsupportedPoBoxAddress`\" ",
+ "type": "string"
+ },
+ "operationId": {
+ "description": "The ID of the operation. Unique across all operations for a given order.",
+ "type": "string"
+ },
+ "reasonText": {
+ "type": "string",
+ "description": "The explanation of the reason."
+ }
+ },
+ "id": "OrdersCancelRequest"
+ },
+ "OrdersRejectReturnLineItemRequest": {
+ "type": "object",
+ "properties": {
+ "lineItemId": {
+ "type": "string",
+ "description": "The ID of the line item to return. Either lineItemId or productId is required."
+ },
+ "operationId": {
+ "description": "The ID of the operation. Unique across all operations for a given order.",
+ "type": "string"
+ },
+ "reason": {
+ "description": "The reason for the return. Acceptable values are: - \"`damagedOrUsed`\" - \"`missingComponent`\" - \"`notEligible`\" - \"`other`\" - \"`outOfReturnWindow`\" ",
+ "type": "string"
+ },
+ "quantity": {
+ "type": "integer",
+ "format": "uint32",
+ "description": "The quantity to return and refund."
+ },
+ "reasonText": {
+ "type": "string",
+ "description": "The explanation of the reason."
+ },
+ "productId": {
+ "type": "string",
+ "description": "The ID of the product to return. This is the REST ID used in the products service. Either lineItemId or productId is required."
+ }
+ },
+ "id": "OrdersRejectReturnLineItemRequest"
+ },
+ "OrdersCustomBatchResponse": {
+ "id": "OrdersCustomBatchResponse",
+ "properties": {
+ "entries": {
+ "items": {
+ "$ref": "OrdersCustomBatchResponseEntry"
+ },
+ "description": "The result of the execution of the batch requests.",
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersCustomBatchResponse\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "PosInventory": {
+ "description": "The absolute quantity of an item available at the given store.",
+ "id": "PosInventory",
+ "type": "object",
+ "properties": {
+ "itemId": {
+ "type": "string",
+ "description": "Required. A unique identifier for the item."
+ },
+ "targetCountry": {
+ "description": "Required. The CLDR territory code for the item.",
+ "type": "string"
+ },
+ "storeCode": {
+ "description": "Required. The identifier of the merchant's store. Either a `storeCode` inserted via the API or the code of the store in Google My Business.",
+ "type": "string"
+ },
+ "quantity": {
+ "description": "Required. The available quantity of the item.",
+ "type": "string",
+ "format": "int64"
+ },
+ "timestamp": {
+ "type": "string",
+ "description": "Required. The inventory timestamp, in ISO 8601 format."
+ },
+ "gtin": {
+ "description": "Global Trade Item Number.",
+ "type": "string"
+ },
+ "contentLanguage": {
+ "type": "string",
+ "description": "Required. The two-letter ISO 639-1 language code for the item."
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#posInventory`\"",
+ "type": "string"
+ },
+ "price": {
+ "$ref": "Price",
+ "description": "Required. The current price of the item."
+ }
+ }
+ },
+ "OrdersUpdateShipmentResponse": {
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersUpdateShipmentResponse\".",
+ "type": "string"
+ },
+ "executionStatus": {
+ "description": "The status of the execution. Acceptable values are: - \"`duplicate`\" - \"`executed`\" ",
+ "type": "string"
+ }
+ },
+ "id": "OrdersUpdateShipmentResponse",
+ "type": "object"
+ },
+ "OrdersSetLineItemMetadataResponse": {
+ "type": "object",
+ "properties": {
+ "executionStatus": {
+ "description": "The status of the execution. Acceptable values are: - \"`duplicate`\" - \"`executed`\" ",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersSetLineItemMetadataResponse\".",
+ "type": "string"
+ }
+ },
+ "id": "OrdersSetLineItemMetadataResponse"
+ },
+ "OrdersCancelLineItemRequest": {
+ "type": "object",
+ "properties": {
+ "operationId": {
+ "type": "string",
+ "description": "The ID of the operation. Unique across all operations for a given order."
+ },
+ "productId": {
+ "description": "The ID of the product to cancel. This is the REST ID used in the products service. Either lineItemId or productId is required.",
+ "type": "string"
+ },
+ "amountTax": {
+ "$ref": "Price",
+ "description": "Tax amount that corresponds to cancellation amount in amountPretax. Optional, but if filled, then amountPretax must be set. Calculated automatically if not provided."
+ },
+ "reasonText": {
+ "description": "The explanation of the reason.",
+ "type": "string"
+ },
+ "amount": {
+ "$ref": "Price",
+ "description": "Deprecated. Please use amountPretax and amountTax instead."
+ },
+ "lineItemId": {
+ "description": "The ID of the line item to cancel. Either lineItemId or productId is required.",
+ "type": "string"
+ },
+ "amountPretax": {
+ "description": "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.",
+ "$ref": "Price"
+ },
+ "quantity": {
+ "type": "integer",
+ "format": "uint32",
+ "description": "The quantity to cancel."
+ },
+ "reason": {
+ "description": "The reason for the cancellation. Acceptable values are: - \"`customerInitiatedCancel`\" - \"`invalidCoupon`\" - \"`malformedShippingAddress`\" - \"`noInventory`\" - \"`other`\" - \"`priceError`\" - \"`shippingPriceError`\" - \"`taxError`\" - \"`undeliverableShippingAddress`\" - \"`unsupportedPoBoxAddress`\" ",
+ "type": "string"
+ }
+ },
+ "id": "OrdersCancelLineItemRequest"
+ },
+ "UnitInvoice": {
+ "type": "object",
+ "properties": {
+ "additionalCharges": {
+ "items": {
+ "$ref": "UnitInvoiceAdditionalCharge"
+ },
+ "description": "Additional charges for a unit, e.g. shipping costs.",
+ "type": "array"
+ },
+ "promotions": {
+ "items": {
+ "$ref": "Promotion"
+ },
+ "type": "array",
+ "description": "Deprecated."
+ },
+ "unitPriceTaxes": {
+ "type": "array",
+ "items": {
+ "$ref": "UnitInvoiceTaxLine"
+ },
+ "description": "Tax amounts to apply to the unit price."
+ },
+ "unitPricePretax": {
+ "description": "[required] Price of the unit, before applying taxes.",
+ "$ref": "Price"
+ }
+ },
+ "id": "UnitInvoice"
+ },
+ "AccountStatusStatistics": {
+ "properties": {
+ "active": {
+ "format": "int64",
+ "type": "string",
+ "description": "Number of active offers."
+ },
+ "disapproved": {
+ "type": "string",
+ "description": "Number of disapproved offers.",
+ "format": "int64"
+ },
+ "expiring": {
+ "description": "Number of expiring offers.",
+ "type": "string",
+ "format": "int64"
+ },
+ "pending": {
+ "type": "string",
+ "description": "Number of pending offers.",
+ "format": "int64"
+ }
+ },
+ "type": "object",
+ "id": "AccountStatusStatistics"
+ },
+ "ProductsCustomBatchRequest": {
+ "properties": {
+ "entries": {
+ "items": {
+ "$ref": "ProductsCustomBatchRequestEntry"
+ },
+ "description": "The request entries to be processed in the batch.",
+ "type": "array"
+ }
+ },
+ "id": "ProductsCustomBatchRequest",
+ "type": "object"
+ },
+ "OrdersCreateTestReturnRequest": {
+ "id": "OrdersCreateTestReturnRequest",
+ "properties": {
+ "items": {
+ "description": "Returned items.",
+ "type": "array",
+ "items": {
+ "$ref": "OrdersCustomBatchRequestEntryCreateTestReturnReturnItem"
+ }
+ }
+ },
+ "type": "object"
+ },
+ "OrdersInStoreRefundLineItemRequest": {
+ "id": "OrdersInStoreRefundLineItemRequest",
+ "properties": {
+ "amountTax": {
+ "description": "Tax amount that correspond to refund amount in amountPretax. Required.",
+ "$ref": "Price"
+ },
+ "lineItemId": {
+ "type": "string",
+ "description": "The ID of the line item to return. Either lineItemId or productId is required."
+ },
+ "amountPretax": {
+ "$ref": "Price",
+ "description": "The amount that is refunded. Required."
+ },
+ "operationId": {
+ "type": "string",
+ "description": "The ID of the operation. Unique across all operations for a given order."
+ },
+ "quantity": {
+ "description": "The quantity to return and refund.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "productId": {
+ "type": "string",
+ "description": "The ID of the product to return. This is the REST ID used in the products service. Either lineItemId or productId is required."
+ },
+ "reasonText": {
+ "type": "string",
+ "description": "The explanation of the reason."
+ },
+ "reason": {
+ "description": "The reason for the return. Acceptable values are: - \"`customerDiscretionaryReturn`\" - \"`customerInitiatedMerchantCancel`\" - \"`deliveredTooLate`\" - \"`expiredItem`\" - \"`invalidCoupon`\" - \"`malformedShippingAddress`\" - \"`other`\" - \"`productArrivedDamaged`\" - \"`productNotAsDescribed`\" - \"`qualityNotAsExpected`\" - \"`undeliverableShippingAddress`\" - \"`unsupportedPoBoxAddress`\" - \"`wrongProductShipped`\" ",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DatafeedStatus": {
+ "type": "object",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#datafeedStatus`\"",
+ "type": "string"
+ },
+ "itemsValid": {
+ "description": "The number of items in the feed that were valid.",
+ "type": "string",
+ "format": "uint64"
+ },
+ "warnings": {
+ "type": "array",
+ "description": "The list of errors occurring in the feed.",
+ "items": {
+ "$ref": "DatafeedStatusError"
+ }
+ },
+ "itemsTotal": {
+ "type": "string",
+ "description": "The number of items in the feed that were processed.",
+ "format": "uint64"
+ },
+ "processingStatus": {
+ "type": "string",
+ "description": "The processing status of the feed. Acceptable values are: - \"`\"`failure`\": The feed could not be processed or all items had errors.`\" - \"`in progress`\": The feed is being processed. - \"`none`\": The feed has not yet been processed. For example, a feed that has never been uploaded will have this processing status. - \"`success`\": The feed was processed successfully, though some items might have had errors. "
+ },
+ "lastUploadDate": {
+ "description": "The last date at which the feed was uploaded.",
+ "type": "string"
+ },
+ "datafeedId": {
+ "type": "string",
+ "format": "uint64",
+ "description": "The ID of the feed for which the status is reported."
+ },
+ "errors": {
+ "description": "The list of errors occurring in the feed.",
+ "items": {
+ "$ref": "DatafeedStatusError"
+ },
+ "type": "array"
+ },
+ "country": {
+ "description": "The country for which the status is reported, represented as a CLDR territory code.",
+ "type": "string"
+ },
+ "language": {
+ "description": "The two-letter ISO 639-1 language for which the status is reported.",
+ "type": "string"
+ }
+ },
+ "id": "DatafeedStatus",
+ "description": "The status of a datafeed, i.e., the result of the last retrieval of the datafeed computed asynchronously when the feed processing is finished."
+ },
+ "Datafeed": {
+ "type": "object",
+ "id": "Datafeed",
+ "properties": {
+ "targets": {
+ "items": {
+ "$ref": "DatafeedTarget"
+ },
+ "description": "The targets this feed should apply to (country, language, destinations).",
+ "type": "array"
+ },
+ "name": {
+ "type": "string",
+ "description": "Required for insert. A descriptive name of the data feed."
+ },
+ "contentLanguage": {
+ "description": "[DEPRECATED] Please use targets[].language instead. The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for `targetCountry`.",
+ "type": "string"
+ },
+ "fileName": {
+ "description": "Required. The filename of the feed. All feeds must have a unique file name.",
+ "type": "string"
+ },
+ "intendedDestinations": {
+ "type": "array",
+ "description": "[DEPRECATED] Please use targets[].includedDestinations instead. The list of intended destinations (corresponds to checked check boxes in Merchant Center).",
+ "items": {
+ "type": "string"
+ }
+ },
+ "targetCountry": {
+ "type": "string",
+ "description": "[DEPRECATED] Please use targets[].country instead. The country where the items in the feed will be included in the search index, represented as a CLDR territory code."
+ },
+ "kind": {
+ "type": "string",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#datafeed`\""
+ },
+ "id": {
+ "description": "Required for update. The ID of the data feed.",
+ "format": "int64",
+ "type": "string"
+ },
+ "contentType": {
+ "type": "string",
+ "description": "Required. The type of data feed. For product inventory feeds, only feeds for local stores, not online stores, are supported. Acceptable values are: - \"`local products`\" - \"`product inventory`\" - \"`products`\" "
+ },
+ "attributeLanguage": {
+ "description": "The two-letter ISO 639-1 language in which the attributes are defined in the data feed.",
+ "type": "string"
+ },
+ "fetchSchedule": {
+ "description": "Fetch schedule for the feed file.",
+ "$ref": "DatafeedFetchSchedule"
+ },
+ "format": {
+ "$ref": "DatafeedFormat",
+ "description": "Format of the feed file."
+ }
+ },
+ "description": "Datafeed configuration data."
+ },
+ "OrderShipment": {
+ "properties": {
+ "creationDate": {
+ "description": "Date on which the shipment has been created, in ISO 8601 format.",
+ "type": "string"
+ },
+ "lineItems": {
+ "description": "The line items that are shipped.",
+ "items": {
+ "$ref": "OrderShipmentLineItemShipment"
+ },
+ "type": "array"
+ },
+ "carrier": {
+ "type": "string",
+ "description": "The carrier handling the shipment. For supported carriers, Google includes the carrier name and tracking URL in emails to customers. For select supported carriers, Google also automatically updates the shipment status based on the provided shipment ID. *Note:* You can also use unsupported carriers, but emails to customers will not include the carrier name or tracking URL, and there will be no automatic order status updates. Supported carriers for US are: - \"`ups`\" (United Parcel Service) *automatic status updates* - \"`usps`\" (United States Postal Service) *automatic status updates* - \"`fedex`\" (FedEx) *automatic status updates * - \"`dhl`\" (DHL eCommerce) *automatic status updates* (US only) - \"`ontrac`\" (OnTrac) *automatic status updates * - \"`dhl express`\" (DHL Express) - \"`deliv`\" (Deliv) - \"`dynamex`\" (TForce) - \"`lasership`\" (LaserShip) - \"`mpx`\" (Military Parcel Xpress) - \"`uds`\" (United Delivery Service) - \"`efw`\" (Estes Forwarding Worldwide) - \"`jd logistics`\" (JD Logistics) - \"`yunexpress`\" (YunExpress) - \"`china post`\" (China Post) - \"`china ems`\" (China Post Express Mail Service) - \"`singapore post`\" (Singapore Post) - \"`pos malaysia`\" (Pos Malaysia) - \"`postnl`\" (PostNL) - \"`ptt`\" (PTT Turkish Post) - \"`eub`\" (ePacket) - \"`chukou1`\" (Chukou1 Logistics) - \"`bestex`\" (Best Express) - \"`canada post`\" (Canada Post) - \"`purolator`\" (Purolator) - \"`canpar`\" (Canpar) - \"`india post`\" (India Post) - \"`blue dart`\" (Blue Dart) - \"`delhivery`\" (Delhivery) - \"`dtdc`\" (DTDC) - \"`tpc india`\" (TPC India) Supported carriers for FR are: - \"`la poste`\" (La Poste) *automatic status updates * - \"`colissimo`\" (Colissimo by La Poste) *automatic status updates* - \"`ups`\" (United Parcel Service) *automatic status updates * - \"`chronopost`\" (Chronopost by La Poste) - \"`gls`\" (General Logistics Systems France) - \"`dpd`\" (DPD Group by GeoPost) - \"`bpost`\" (Belgian Post Group) - \"`colis prive`\" (Colis Privé) - \"`boxtal`\" (Boxtal) - \"`geodis`\" (GEODIS) - \"`tnt`\" (TNT) - \"`db schenker`\" (DB Schenker) - \"`aramex`\" (Aramex) "
+ },
+ "status": {
+ "description": "The status of the shipment. Acceptable values are: - \"`delivered`\" - \"`readyForPickup`\" - \"`shipped`\" - \"`undeliverable`\" ",
+ "type": "string"
+ },
+ "id": {
+ "type": "string",
+ "description": "The ID of the shipment."
+ },
+ "deliveryDate": {
+ "type": "string",
+ "description": "Date on which the shipment has been delivered, in ISO 8601 format. Present only if `status` is `delivered`"
+ },
+ "scheduledDeliveryDetails": {
+ "description": "Delivery details of the shipment if scheduling is needed.",
+ "$ref": "OrderShipmentScheduledDeliveryDetails"
+ },
+ "trackingId": {
+ "type": "string",
+ "description": "The tracking ID for the shipment."
+ }
+ },
+ "id": "OrderShipment",
+ "type": "object"
+ },
+ "DatafeedsCustomBatchRequestEntry": {
+ "id": "DatafeedsCustomBatchRequestEntry",
+ "description": "A batch entry encoding a single non-batch datafeeds request.",
+ "properties": {
+ "datafeed": {
+ "$ref": "Datafeed",
+ "description": "The data feed to insert."
+ },
+ "datafeedId": {
+ "type": "string",
+ "format": "uint64",
+ "description": "The ID of the data feed to get, delete or fetch."
+ },
+ "batchId": {
+ "type": "integer",
+ "description": "An entry ID, unique within the batch request.",
+ "format": "uint32"
+ },
+ "merchantId": {
+ "type": "string",
+ "format": "uint64",
+ "description": "The ID of the managing account."
+ },
+ "method": {
+ "type": "string",
+ "description": "The method of the batch entry. Acceptable values are: - \"`delete`\" - \"`fetchNow`\" - \"`get`\" - \"`insert`\" - \"`update`\" "
+ }
+ },
+ "type": "object"
+ },
+ "UnitInvoiceAdditionalCharge": {
+ "id": "UnitInvoiceAdditionalCharge",
+ "properties": {
+ "type": {
+ "description": "[required] Type of the additional charge. Acceptable values are: - \"`shipping`\" ",
+ "type": "string"
+ },
+ "additionalChargePromotions": {
+ "description": "Deprecated.",
+ "items": {
+ "$ref": "Promotion"
+ },
+ "type": "array"
+ },
+ "additionalChargeAmount": {
+ "$ref": "Amount",
+ "description": "[required] Amount of the additional charge."
+ }
+ },
+ "type": "object"
+ },
+ "ProductShipping": {
+ "type": "object",
+ "properties": {
+ "price": {
+ "$ref": "Price",
+ "description": "Fixed shipping price, represented as a number."
+ },
+ "region": {
+ "description": "The geographic region to which a shipping rate applies.",
+ "type": "string"
+ },
+ "country": {
+ "type": "string",
+ "description": "The CLDR territory code of the country to which an item will ship."
+ },
+ "postalCode": {
+ "description": "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.",
+ "type": "string"
+ },
+ "locationGroupName": {
+ "description": "The location where the shipping is applicable, represented by a location group name.",
+ "type": "string"
+ },
+ "locationId": {
+ "format": "int64",
+ "description": "The numeric ID of a location that the shipping rate applies to as defined in the AdWords API.",
+ "type": "string"
+ },
+ "service": {
+ "description": "A free-form description of the service class or delivery speed.",
+ "type": "string"
+ }
+ },
+ "id": "ProductShipping"
+ },
+ "Error": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string",
+ "description": "A description of the error."
+ },
+ "reason": {
+ "type": "string",
+ "description": "The error code."
+ },
+ "domain": {
+ "description": "The domain of the error.",
+ "type": "string"
+ }
+ },
+ "description": "An error returned by the API.",
+ "id": "Error"
+ },
+ "DatafeedsFetchNowResponse": {
+ "type": "object",
+ "id": "DatafeedsFetchNowResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#datafeedsFetchNowResponse\".",
+ "type": "string"
+ }
+ }
+ },
+ "AccountStatusProducts": {
+ "type": "object",
+ "id": "AccountStatusProducts",
+ "properties": {
+ "destination": {
+ "description": "The destination the data applies to.",
+ "type": "string"
+ },
+ "itemLevelIssues": {
+ "type": "array",
+ "items": {
+ "$ref": "AccountStatusItemLevelIssue"
+ },
+ "description": "List of item-level issues."
+ },
+ "statistics": {
+ "description": "Aggregated product statistics.",
+ "$ref": "AccountStatusStatistics"
+ },
+ "channel": {
+ "type": "string",
+ "description": "The channel the data applies to. Acceptable values are: - \"`local`\" - \"`online`\" "
+ },
+ "country": {
+ "description": "The country the data applies to.",
+ "type": "string"
+ }
+ }
+ },
+ "ShippingsettingsCustomBatchResponseEntry": {
+ "type": "object",
+ "properties": {
+ "batchId": {
+ "type": "integer",
+ "description": "The ID of the request entry to which this entry responds.",
+ "format": "uint32"
+ },
+ "kind": {
+ "type": "string",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#shippingsettingsCustomBatchResponseEntry`\""
+ },
+ "shippingSettings": {
+ "$ref": "ShippingSettings",
+ "description": "The retrieved or updated account shipping settings."
+ },
+ "errors": {
+ "$ref": "Errors",
+ "description": "A list of errors defined if, and only if, the request failed."
+ }
+ },
+ "id": "ShippingsettingsCustomBatchResponseEntry",
+ "description": "A batch entry encoding a single non-batch shipping settings response."
+ },
+ "HolidayCutoff": {
+ "type": "object",
+ "id": "HolidayCutoff",
+ "properties": {
+ "holidayId": {
+ "description": "Unique identifier for the holiday. Required.",
+ "type": "string"
+ },
+ "visibleFromDate": {
+ "description": "Date on which the deadline will become visible to consumers in ISO 8601 format. E.g. \"2016-10-31\" for 31st October 2016. Required.",
+ "type": "string"
+ },
+ "deadlineTimezone": {
+ "type": "string",
+ "description": "Timezone identifier for the deadline hour. A list of identifiers can be found in the AdWords API documentation. E.g. \"Europe/Zurich\". Required."
+ },
+ "deadlineDate": {
+ "description": "Date of the order deadline, in ISO 8601 format. E.g. \"2016-11-29\" for 29th November 2016. Required.",
+ "type": "string"
+ },
+ "deadlineHour": {
+ "type": "integer",
+ "format": "uint32",
+ "description": "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."
+ }
+ }
+ },
+ "LoyaltyPoints": {
+ "properties": {
+ "pointsValue": {
+ "type": "string",
+ "format": "int64",
+ "description": "The retailer's loyalty points in absolute value."
+ },
+ "name": {
+ "description": "Name of loyalty points program. It is recommended to limit the name to 12 full-width characters or 24 Roman characters.",
+ "type": "string"
+ },
+ "ratio": {
+ "description": "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.",
+ "type": "number",
+ "format": "double"
+ }
+ },
+ "type": "object",
+ "id": "LoyaltyPoints"
+ },
+ "AccountstatusesCustomBatchResponse": {
+ "type": "object",
+ "id": "AccountstatusesCustomBatchResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#accountstatusesCustomBatchResponse\".",
+ "type": "string"
+ },
+ "entries": {
+ "description": "The result of the execution of the batch requests.",
+ "type": "array",
+ "items": {
+ "$ref": "AccountstatusesCustomBatchResponseEntry"
+ }
+ }
+ }
+ },
+ "OrdersUpdateShipmentRequest": {
+ "properties": {
+ "trackingId": {
+ "description": "The tracking ID for the shipment. Not updated if missing.",
+ "type": "string"
+ },
+ "deliveryDate": {
+ "type": "string",
+ "description": "Date on which the shipment has been delivered, in ISO 8601 format. Optional and can be provided only if `status` is `delivered`."
+ },
+ "shipmentId": {
+ "type": "string",
+ "description": "The ID of the shipment."
+ },
+ "operationId": {
+ "type": "string",
+ "description": "The ID of the operation. Unique across all operations for a given order."
+ },
+ "carrier": {
+ "type": "string",
+ "description": "The carrier handling the shipment. Not updated if missing. See `shipments[].carrier` in the Orders resource representation for a list of acceptable values."
+ },
+ "status": {
+ "type": "string",
+ "description": "New status for the shipment. Not updated if missing. Acceptable values are: - \"`delivered`\" - \"`undeliverable`\" - \"`readyForPickup`\" "
+ }
+ },
+ "type": "object",
+ "id": "OrdersUpdateShipmentRequest"
+ },
+ "CustomAttribute": {
+ "id": "CustomAttribute",
+ "properties": {
+ "type": {
+ "type": "string",
+ "description": "The type of the attribute. Acceptable values are: - \"`boolean`\" - \"`datetimerange`\" - \"`float`\" - \"`group`\" - \"`int`\" - \"`price`\" - \"`text`\" - \"`time`\" - \"`url`\" "
+ },
+ "value": {
+ "type": "string",
+ "description": "The value of the attribute."
+ },
+ "name": {
+ "type": "string",
+ "description": "The name of the attribute. Underscores will be replaced by spaces upon insertion."
+ },
+ "unit": {
+ "type": "string",
+ "description": "Free-form unit of the attribute. Unit can only be used for values of type int, float, or price."
+ }
+ },
+ "type": "object"
+ },
+ "InvoiceSummary": {
+ "type": "object",
+ "properties": {
+ "promotionSummaries": {
+ "type": "array",
+ "description": "Deprecated.",
+ "items": {
+ "$ref": "Promotion"
+ }
+ },
+ "googleBalance": {
+ "$ref": "Amount",
+ "description": "Deprecated."
+ },
+ "merchantBalance": {
+ "$ref": "Amount",
+ "description": "Deprecated."
+ },
+ "customerBalance": {
+ "$ref": "Amount",
+ "description": "Deprecated."
+ },
+ "productTotal": {
+ "description": "[required] Total price for the product.",
+ "$ref": "Amount"
+ },
+ "additionalChargeSummaries": {
+ "items": {
+ "$ref": "InvoiceSummaryAdditionalChargeSummary"
+ },
+ "description": "Summary of the total amounts of the additional charges.",
+ "type": "array"
+ }
+ },
+ "id": "InvoiceSummary"
+ },
+ "AccountsCustomBatchRequestEntry": {
+ "description": "A batch entry encoding a single non-batch accounts request.",
+ "type": "object",
+ "properties": {
+ "force": {
+ "type": "boolean",
+ "description": "Whether the account should be deleted if the account has offers. Only applicable if the method is `delete`."
+ },
+ "merchantId": {
+ "format": "uint64",
+ "type": "string",
+ "description": "The ID of the managing account."
+ },
+ "account": {
+ "description": "The account to create or update. Only defined if the method is `insert` or `update`.",
+ "$ref": "Account"
+ },
+ "accountId": {
+ "description": "The ID of the targeted account. Only defined if the method is not `insert`.",
+ "format": "uint64",
+ "type": "string"
+ },
+ "method": {
+ "type": "string",
+ "description": "The method of the batch entry. Acceptable values are: - \"`claimWebsite`\" - \"`delete`\" - \"`get`\" - \"`insert`\" - \"`link`\" - \"`update`\" "
+ },
+ "overwrite": {
+ "type": "boolean",
+ "description": "Only applicable if the method is `claimwebsite`. Indicates whether or not to take the claim from another account in case there is a conflict."
+ },
+ "linkRequest": {
+ "description": "Details about the `link` request.",
+ "$ref": "AccountsCustomBatchRequestEntryLinkRequest"
+ },
+ "batchId": {
+ "type": "integer",
+ "description": "An entry ID, unique within the batch request.",
+ "format": "uint32"
+ },
+ "labelIds": {
+ "items": {
+ "format": "uint64",
+ "type": "string"
+ },
+ "type": "array",
+ "description": "Label IDs for the 'updatelabels' request."
+ }
+ },
+ "id": "AccountsCustomBatchRequestEntry"
+ },
+ "PosDataProvidersPosDataProvider": {
+ "properties": {
+ "displayName": {
+ "type": "string",
+ "description": "The display name of Pos data Provider."
+ },
+ "fullName": {
+ "description": "The full name of this POS data Provider.",
+ "type": "string"
+ },
+ "providerId": {
+ "type": "string",
+ "description": "The ID of the account.",
+ "format": "uint64"
+ }
+ },
+ "type": "object",
+ "id": "PosDataProvidersPosDataProvider"
+ },
+ "LiasettingsRequestGmbAccessResponse": {
+ "properties": {
+ "kind": {
+ "type": "string",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#liasettingsRequestGmbAccessResponse\"."
+ }
+ },
+ "type": "object",
+ "id": "LiasettingsRequestGmbAccessResponse"
+ },
+ "AccountYouTubeChannelLink": {
+ "type": "object",
+ "properties": {
+ "channelId": {
+ "type": "string",
+ "description": "Channel ID."
+ },
+ "status": {
+ "type": "string",
+ "description": "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."
+ }
+ },
+ "id": "AccountYouTubeChannelLink"
+ },
+ "OrdersUpdateLineItemShippingDetailsResponse": {
+ "id": "OrdersUpdateLineItemShippingDetailsResponse",
+ "properties": {
+ "executionStatus": {
+ "type": "string",
+ "description": "The status of the execution. Acceptable values are: - \"`duplicate`\" - \"`executed`\" "
+ },
+ "kind": {
+ "type": "string",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersUpdateLineItemShippingDetailsResponse\"."
+ }
+ },
+ "type": "object"
+ },
+ "OrdersCustomBatchRequestEntryUpdateShipment": {
+ "id": "OrdersCustomBatchRequestEntryUpdateShipment",
+ "type": "object",
+ "properties": {
+ "carrier": {
+ "description": "The carrier handling the shipment. Not updated if missing. See `shipments[].carrier` in the Orders resource representation for a list of acceptable values.",
+ "type": "string"
+ },
+ "status": {
+ "type": "string",
+ "description": "New status for the shipment. Not updated if missing. Acceptable values are: - \"`delivered`\" - \"`undeliverable`\" - \"`readyForPickup`\" "
+ },
+ "shipmentId": {
+ "description": "The ID of the shipment.",
+ "type": "string"
+ },
+ "deliveryDate": {
+ "type": "string",
+ "description": "Date on which the shipment has been delivered, in ISO 8601 format. Optional and can be provided only if `status` is `delivered`."
+ },
+ "trackingId": {
+ "type": "string",
+ "description": "The tracking ID for the shipment. Not updated if missing."
+ }
+ }
+ },
+ "AccountstatusesListResponse": {
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#accountstatusesListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "type": "string",
+ "description": "The token for the retrieval of the next page of account statuses."
+ },
+ "resources": {
+ "items": {
+ "$ref": "AccountStatus"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object",
+ "id": "AccountstatusesListResponse"
+ },
+ "InventoryPickup": {
+ "id": "InventoryPickup",
+ "properties": {
+ "pickupMethod": {
+ "description": "Whether store pickup is available for this offer and whether the pickup option should be shown as buy, reserve, or not supported. Only supported for local inventory. Unless the value is \"not supported\", must be submitted together with `pickupSla`. Acceptable values are: - \"`buy`\" - \"`not supported`\" - \"`reserve`\" - \"`ship to store`\" ",
+ "type": "string"
+ },
+ "pickupSla": {
+ "description": "The expected date that an order will be ready for pickup, relative to when the order is placed. Only supported for local inventory. Must be submitted together with `pickupMethod`. Acceptable values are: - \"`five day`\" - \"`four day`\" - \"`multi day`\" - \"`multi week`\" - \"`next day`\" - \"`same day`\" - \"`seven day`\" - \"`six day`\" - \"`three day`\" - \"`two day`\" ",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "PosCustomBatchResponse": {
+ "properties": {
+ "entries": {
+ "type": "array",
+ "description": "The result of the execution of the batch requests.",
+ "items": {
+ "$ref": "PosCustomBatchResponseEntry"
+ }
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#posCustomBatchResponse\".",
+ "type": "string"
+ }
+ },
+ "type": "object",
+ "id": "PosCustomBatchResponse"
+ },
+ "DeliveryTime": {
+ "type": "object",
+ "id": "DeliveryTime",
+ "properties": {
+ "minHandlingTimeInDays": {
+ "description": "Minimum number of business days spent before an order is shipped. 0 means same day shipped, 1 means next day shipped.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "cutoffTime": {
+ "description": "Business days cutoff time definition. If not configured the cutoff time will be defaulted to 8AM PST.",
+ "$ref": "CutoffTime"
+ },
+ "transitTimeTable": {
+ "description": "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.",
+ "$ref": "TransitTable"
+ },
+ "maxHandlingTimeInDays": {
+ "type": "integer",
+ "format": "uint32",
+ "description": "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`."
+ },
+ "minTransitTimeInDays": {
+ "format": "uint32",
+ "type": "integer",
+ "description": "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."
+ },
+ "holidayCutoffs": {
+ "type": "array",
+ "items": {
+ "$ref": "HolidayCutoff"
+ },
+ "description": "Holiday cutoff definitions. If configured, they specify order cutoff times for holiday-specific shipping."
+ },
+ "handlingBusinessDayConfig": {
+ "description": "The business days during which orders can be handled. If not provided, Monday to Friday business days will be assumed.",
+ "$ref": "BusinessDayConfig"
+ },
+ "transitBusinessDayConfig": {
+ "description": "The business days during which orders can be in-transit. If not provided, Monday to Friday business days will be assumed.",
+ "$ref": "BusinessDayConfig"
+ },
+ "maxTransitTimeInDays": {
+ "type": "integer",
+ "format": "uint32",
+ "description": "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`."
+ }
+ }
+ },
+ "AccountsCustomBatchRequest": {
+ "id": "AccountsCustomBatchRequest",
+ "type": "object",
+ "properties": {
+ "entries": {
+ "description": "The request entries to be processed in the batch.",
+ "type": "array",
+ "items": {
+ "$ref": "AccountsCustomBatchRequestEntry"
+ }
+ }
+ }
+ },
+ "OrdersGetTestOrderTemplateResponse": {
+ "id": "OrdersGetTestOrderTemplateResponse",
+ "type": "object",
+ "properties": {
+ "template": {
+ "$ref": "TestOrder",
+ "description": "The requested test order template."
+ },
+ "kind": {
+ "type": "string",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersGetTestOrderTemplateResponse\"."
+ }
+ }
+ },
+ "InventoryCustomBatchResponse": {
+ "properties": {
+ "entries": {
+ "items": {
+ "$ref": "InventoryCustomBatchResponseEntry"
+ },
+ "description": "The result of the execution of the batch requests.",
+ "type": "array"
+ },
+ "kind": {
+ "type": "string",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#inventoryCustomBatchResponse\"."
+ }
+ },
+ "type": "object",
+ "id": "InventoryCustomBatchResponse"
+ },
+ "CarriersCarrier": {
+ "id": "CarriersCarrier",
+ "properties": {
+ "name": {
+ "description": "The name of the carrier (e.g., `\"UPS\"`). Always present.",
+ "type": "string"
+ },
+ "country": {
+ "type": "string",
+ "description": "The CLDR country code of the carrier (e.g., \"US\"). Always present."
+ },
+ "services": {
+ "items": {
+ "type": "string"
+ },
+ "description": "A list of supported services (e.g., `\"ground\"`) for that carrier. Contains at least one service.",
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "ProductstatusesCustomBatchRequest": {
+ "properties": {
+ "entries": {
+ "items": {
+ "$ref": "ProductstatusesCustomBatchRequestEntry"
+ },
+ "description": "The request entries to be processed in the batch.",
+ "type": "array"
+ }
+ },
+ "id": "ProductstatusesCustomBatchRequest",
+ "type": "object"
+ },
+ "DatafeedTarget": {
+ "type": "object",
+ "properties": {
+ "country": {
+ "type": "string",
+ "description": "The country where the items in the feed will be included in the search index, represented as a CLDR territory code."
+ },
+ "excludedDestinations": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center)."
+ },
+ "includedDestinations": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "The list of destinations to include for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in `excludedDestinations`. List of supported destinations (if available to the account): - DisplayAds - Shopping - ShoppingActions - SurfacesAcrossGoogle "
+ },
+ "language": {
+ "type": "string",
+ "description": "The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for `targets[].country`."
+ }
+ },
+ "id": "DatafeedTarget"
+ },
+ "OrdersCustomBatchRequestEntryReturnLineItem": {
+ "properties": {
+ "productId": {
+ "description": "The ID of the product to return. This is the REST ID used in the products service. Either lineItemId or productId is required.",
+ "type": "string"
+ },
+ "reasonText": {
+ "description": "The explanation of the reason.",
+ "type": "string"
+ },
+ "quantity": {
+ "format": "uint32",
+ "description": "The quantity to return.",
+ "type": "integer"
+ },
+ "reason": {
+ "description": "The reason for the return. Acceptable values are: - \"`customerDiscretionaryReturn`\" - \"`customerInitiatedMerchantCancel`\" - \"`deliveredTooLate`\" - \"`expiredItem`\" - \"`invalidCoupon`\" - \"`malformedShippingAddress`\" - \"`other`\" - \"`productArrivedDamaged`\" - \"`productNotAsDescribed`\" - \"`qualityNotAsExpected`\" - \"`undeliverableShippingAddress`\" - \"`unsupportedPoBoxAddress`\" - \"`wrongProductShipped`\" ",
+ "type": "string"
+ },
+ "lineItemId": {
+ "type": "string",
+ "description": "The ID of the line item to return. Either lineItemId or productId is required."
+ }
+ },
+ "id": "OrdersCustomBatchRequestEntryReturnLineItem",
+ "type": "object"
+ },
+ "ProductstatusesCustomBatchResponse": {
+ "id": "ProductstatusesCustomBatchResponse",
+ "properties": {
+ "kind": {
+ "type": "string",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#productstatusesCustomBatchResponse\"."
+ },
+ "entries": {
+ "description": "The result of the execution of the batch requests.",
+ "items": {
+ "$ref": "ProductstatusesCustomBatchResponseEntry"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "OrderPaymentMethod": {
+ "type": "object",
+ "id": "OrderPaymentMethod",
+ "properties": {
+ "type": {
+ "description": "The type of instrument. Acceptable values are: - \"`AMEX`\" - \"`DISCOVER`\" - \"`JCB`\" - \"`MASTERCARD`\" - \"`UNIONPAY`\" - \"`VISA`\" - \"``\" ",
+ "type": "string"
+ },
+ "expirationMonth": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The card expiration month (January = 1, February = 2 etc.)."
+ },
+ "lastFourDigits": {
+ "description": "The last four digits of the card number.",
+ "type": "string"
+ },
+ "expirationYear": {
+ "format": "int32",
+ "type": "integer",
+ "description": "The card expiration year (4-digit, e.g. 2015)."
+ },
+ "phoneNumber": {
+ "description": "The billing phone number.",
+ "type": "string"
+ },
+ "billingAddress": {
+ "$ref": "OrderAddress",
+ "description": "The billing address."
+ }
+ }
+ },
+ "PosInventoryRequest": {
+ "properties": {
+ "storeCode": {
+ "type": "string",
+ "description": "Required. The identifier of the merchant's store. Either a `storeCode` inserted via the API or the code of the store in Google My Business."
+ },
+ "targetCountry": {
+ "type": "string",
+ "description": "Required. The CLDR territory code for the item."
+ },
+ "gtin": {
+ "type": "string",
+ "description": "Global Trade Item Number."
+ },
+ "price": {
+ "$ref": "Price",
+ "description": "Required. The current price of the item."
+ },
+ "itemId": {
+ "type": "string",
+ "description": "Required. A unique identifier for the item."
+ },
+ "contentLanguage": {
+ "type": "string",
+ "description": "Required. The two-letter ISO 639-1 language code for the item."
+ },
+ "timestamp": {
+ "type": "string",
+ "description": "Required. The inventory timestamp, in ISO 8601 format."
+ },
+ "quantity": {
+ "type": "string",
+ "format": "int64",
+ "description": "Required. The available quantity of the item."
+ }
+ },
+ "type": "object",
+ "id": "PosInventoryRequest"
+ },
+ "OrderMerchantProvidedAnnotation": {
+ "id": "OrderMerchantProvidedAnnotation",
+ "properties": {
+ "value": {
+ "description": "Value for additional merchant provided (as key-value pairs) annotation about the line item.",
+ "type": "string"
+ },
+ "key": {
+ "type": "string",
+ "description": "Key for additional merchant provided (as key-value pairs) annotation about the line item."
+ }
+ },
+ "type": "object"
+ },
+ "OrdersCancelResponse": {
+ "id": "OrdersCancelResponse",
+ "type": "object",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersCancelResponse\".",
+ "type": "string"
+ },
+ "executionStatus": {
+ "description": "The status of the execution. Acceptable values are: - \"`duplicate`\" - \"`executed`\" ",
+ "type": "string"
+ }
+ }
+ },
+ "AccountUser": {
+ "id": "AccountUser",
+ "type": "object",
+ "properties": {
+ "paymentsManager": {
+ "description": "Whether user can manage payment settings.",
+ "type": "boolean"
+ },
+ "emailAddress": {
+ "description": "User's email address.",
+ "type": "string"
+ },
+ "admin": {
+ "type": "boolean",
+ "description": "Whether user is an admin."
+ },
+ "orderManager": {
+ "type": "boolean",
+ "description": "Whether user is an order manager."
+ },
+ "paymentsAnalyst": {
+ "type": "boolean",
+ "description": "Whether user can access payment statements."
+ }
+ }
+ },
+ "DatafeedstatusesCustomBatchRequest": {
+ "properties": {
+ "entries": {
+ "description": "The request entries to be processed in the batch.",
+ "items": {
+ "$ref": "DatafeedstatusesCustomBatchRequestEntry"
+ },
+ "type": "array"
+ }
+ },
+ "id": "DatafeedstatusesCustomBatchRequest",
+ "type": "object"
+ },
+ "AccounttaxCustomBatchRequestEntry": {
+ "type": "object",
+ "id": "AccounttaxCustomBatchRequestEntry",
+ "description": "A batch entry encoding a single non-batch accounttax request.",
+ "properties": {
+ "accountId": {
+ "type": "string",
+ "description": "The ID of the account for which to get/update account tax settings.",
+ "format": "uint64"
+ },
+ "batchId": {
+ "format": "uint32",
+ "description": "An entry ID, unique within the batch request.",
+ "type": "integer"
+ },
+ "merchantId": {
+ "type": "string",
+ "description": "The ID of the managing account.",
+ "format": "uint64"
+ },
+ "accountTax": {
+ "description": "The account tax settings to update. Only defined if the method is `update`.",
+ "$ref": "AccountTax"
+ },
+ "method": {
+ "type": "string",
+ "description": "The method of the batch entry. Acceptable values are: - \"`get`\" - \"`update`\" "
+ }
+ }
+ },
+ "OrdersCreateTestReturnResponse": {
+ "type": "object",
+ "properties": {
+ "returnId": {
+ "type": "string",
+ "description": "The ID of the newly created test order return."
+ },
+ "kind": {
+ "type": "string",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersCreateTestReturnResponse\"."
+ }
+ },
+ "id": "OrdersCreateTestReturnResponse"
+ },
+ "InvoiceSummaryAdditionalChargeSummary": {
+ "properties": {
+ "totalAmount": {
+ "description": "[required] Total additional charge for this type.",
+ "$ref": "Amount"
+ },
+ "type": {
+ "description": "[required] Type of the additional charge. Acceptable values are: - \"`shipping`\" ",
+ "type": "string"
+ }
+ },
+ "type": "object",
+ "id": "InvoiceSummaryAdditionalChargeSummary"
+ },
+ "OrdersGetByMerchantOrderIdResponse": {
+ "id": "OrdersGetByMerchantOrderIdResponse",
+ "properties": {
+ "order": {
+ "$ref": "Order",
+ "description": "The requested order."
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersGetByMerchantOrderIdResponse\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Inventory": {
+ "id": "Inventory",
+ "properties": {
+ "customLabel1": {
+ "type": "string",
+ "description": "Custom label 1 for custom grouping of items in a Shopping campaign. Only supported for online products."
+ },
+ "customLabel0": {
+ "description": "Custom label 0 for custom grouping of items in a Shopping campaign. Only supported for online products.",
+ "type": "string"
+ },
+ "pickup": {
+ "description": "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\".",
+ "$ref": "InventoryPickup"
+ },
+ "customLabel3": {
+ "type": "string",
+ "description": "Custom label 3 for custom grouping of items in a Shopping campaign. Only supported for online products."
+ },
+ "customLabel4": {
+ "type": "string",
+ "description": "Custom label 3 for custom grouping of items in a Shopping campaign. Only supported for online products."
+ },
+ "loyaltyPoints": {
+ "$ref": "LoyaltyPoints",
+ "description": "Loyalty points that users receive after purchasing the item. Japan only."
+ },
+ "price": {
+ "description": "The price of the product.",
+ "$ref": "Price"
+ },
+ "quantity": {
+ "type": "integer",
+ "description": "The quantity of the product. Must be equal to or greater than zero. Supported only for local products.",
+ "format": "uint32"
+ },
+ "salePriceEffectiveDate": {
+ "description": "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.",
+ "type": "string"
+ },
+ "salePrice": {
+ "$ref": "Price",
+ "description": "The sale price of the product. Mandatory if `sale_price_effective_date` is defined."
+ },
+ "customLabel2": {
+ "description": "Custom label 2 for custom grouping of items in a Shopping campaign. Only supported for online products.",
+ "type": "string"
+ },
+ "availability": {
+ "type": "string",
+ "description": "The availability of the product. Acceptable values are: - \"`in stock`\" - \"`out of stock`\" - \"`preorder`\" "
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#inventory`\"",
+ "type": "string"
+ },
+ "installment": {
+ "$ref": "Installment",
+ "description": "Number and amount of installments to pay for an item. Brazil only."
+ },
+ "sellOnGoogleQuantity": {
+ "type": "integer",
+ "format": "uint32",
+ "description": "The quantity of the product that is available for selling on Google. Supported only for online products."
+ },
+ "instoreProductLocation": {
+ "description": "The instore product location. Supported only for local products.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "OrdersRejectReturnLineItemResponse": {
+ "id": "OrdersRejectReturnLineItemResponse",
+ "type": "object",
+ "properties": {
+ "executionStatus": {
+ "type": "string",
+ "description": "The status of the execution. Acceptable values are: - \"`duplicate`\" - \"`executed`\" "
+ },
+ "kind": {
+ "type": "string",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersRejectReturnLineItemResponse\"."
+ }
+ }
+ },
+ "OrdersCustomBatchRequestEntry": {
+ "id": "OrdersCustomBatchRequestEntry",
+ "properties": {
+ "orderId": {
+ "type": "string",
+ "description": "The ID of the order. Required for all methods beside `getByMerchantOrderId`."
+ },
+ "updateShipment": {
+ "$ref": "OrdersCustomBatchRequestEntryUpdateShipment",
+ "description": "Required for `updateShipment` method."
+ },
+ "returnLineItem": {
+ "description": "Required for `returnLineItem` method.",
+ "$ref": "OrdersCustomBatchRequestEntryReturnLineItem"
+ },
+ "method": {
+ "type": "string",
+ "description": "The method of the batch entry. Acceptable values are: - \"`acknowledge`\" - \"`cancel`\" - \"`cancelLineItem`\" - \"`get`\" - \"`getByMerchantOrderId`\" - \"`inStoreRefundLineItem`\" - \"`refund`\" - \"`rejectReturnLineItem`\" - \"`returnLineItem`\" - \"`returnRefundLineItem`\" - \"`setLineItemMetadata`\" - \"`shipLineItems`\" - \"`updateLineItemShippingDetails`\" - \"`updateMerchantOrderId`\" - \"`updateShipment`\" "
+ },
+ "operationId": {
+ "type": "string",
+ "description": "The ID of the operation. Unique across all operations for a given order. Required for all methods beside `get` and `getByMerchantOrderId`."
+ },
+ "cancelLineItem": {
+ "description": "Required for `cancelLineItem` method.",
+ "$ref": "OrdersCustomBatchRequestEntryCancelLineItem"
+ },
+ "merchantOrderId": {
+ "description": "The merchant order ID. Required for `updateMerchantOrderId` and `getByMerchantOrderId` methods.",
+ "type": "string"
+ },
+ "cancel": {
+ "$ref": "OrdersCustomBatchRequestEntryCancel",
+ "description": "Required for `cancel` method."
+ },
+ "refund": {
+ "$ref": "OrdersCustomBatchRequestEntryRefund",
+ "description": "Required for `refund` method."
+ },
+ "inStoreRefundLineItem": {
+ "description": "Required for `inStoreReturnLineItem` method.",
+ "$ref": "OrdersCustomBatchRequestEntryInStoreRefundLineItem"
+ },
+ "returnRefundLineItem": {
+ "description": "Required for `returnRefundLineItem` method.",
+ "$ref": "OrdersCustomBatchRequestEntryReturnRefundLineItem"
+ },
+ "shipLineItems": {
+ "$ref": "OrdersCustomBatchRequestEntryShipLineItems",
+ "description": "Required for `shipLineItems` method."
+ },
+ "merchantId": {
+ "description": "The ID of the managing account.",
+ "type": "string",
+ "format": "uint64"
+ },
+ "updateLineItemShippingDetails": {
+ "description": "Required for `updateLineItemShippingDate` method.",
+ "$ref": "OrdersCustomBatchRequestEntryUpdateLineItemShippingDetails"
+ },
+ "rejectReturnLineItem": {
+ "description": "Required for `rejectReturnLineItem` method.",
+ "$ref": "OrdersCustomBatchRequestEntryRejectReturnLineItem"
+ },
+ "setLineItemMetadata": {
+ "$ref": "OrdersCustomBatchRequestEntrySetLineItemMetadata",
+ "description": "Required for `setLineItemMetadata` method."
+ },
+ "batchId": {
+ "format": "uint32",
+ "description": "An entry ID, unique within the batch request.",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "LiasettingsCustomBatchRequestEntry": {
+ "type": "object",
+ "properties": {
+ "contactEmail": {
+ "description": "Inventory validation contact email. Required only for SetInventoryValidationContact.",
+ "type": "string"
+ },
+ "gmbEmail": {
+ "description": "The GMB account. Required only for RequestGmbAccess.",
+ "type": "string"
+ },
+ "accountId": {
+ "format": "uint64",
+ "type": "string",
+ "description": "The ID of the account for which to get/update account LIA settings."
+ },
+ "posExternalAccountId": {
+ "description": "The account ID by which this merchant is known to the POS provider.",
+ "type": "string"
+ },
+ "contactName": {
+ "type": "string",
+ "description": "Inventory validation contact name. Required only for SetInventoryValidationContact."
+ },
+ "method": {
+ "description": "The method of the batch entry. Acceptable values are: - \"`get`\" - \"`getAccessibleGmbAccounts`\" - \"`requestGmbAccess`\" - \"`requestInventoryVerification`\" - \"`setInventoryVerificationContact`\" - \"`update`\" ",
+ "type": "string"
+ },
+ "liaSettings": {
+ "description": "The account Lia settings to update. Only defined if the method is `update`.",
+ "$ref": "LiaSettings"
+ },
+ "merchantId": {
+ "description": "The ID of the managing account.",
+ "format": "uint64",
+ "type": "string"
+ },
+ "batchId": {
+ "type": "integer",
+ "format": "uint32",
+ "description": "An entry ID, unique within the batch request."
+ },
+ "posDataProviderId": {
+ "type": "string",
+ "format": "uint64",
+ "description": "The ID of POS data provider. Required only for SetPosProvider."
+ },
+ "country": {
+ "description": "The country code. Required only for RequestInventoryVerification.",
+ "type": "string"
+ }
+ },
+ "id": "LiasettingsCustomBatchRequestEntry"
+ },
+ "AccountStatusExampleItem": {
+ "id": "AccountStatusExampleItem",
+ "properties": {
+ "title": {
+ "type": "string"
+ },
+ "itemId": {
+ "type": "string"
+ },
+ "submittedValue": {
+ "type": "string"
+ },
+ "valueOnLandingPage": {
+ "type": "string"
+ },
+ "link": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "OrdersRefundRequest": {
+ "type": "object",
+ "id": "OrdersRefundRequest",
+ "properties": {
+ "amount": {
+ "$ref": "Price",
+ "description": "Deprecated. Please use amountPretax and amountTax instead."
+ },
+ "operationId": {
+ "description": "The ID of the operation. Unique across all operations for a given order.",
+ "type": "string"
+ },
+ "amountPretax": {
+ "$ref": "Price",
+ "description": "The amount that is refunded. Either amount or amountPretax should be filled."
+ },
+ "reasonText": {
+ "type": "string",
+ "description": "The explanation of the reason."
+ },
+ "reason": {
+ "type": "string",
+ "description": "The reason for the refund. Acceptable values are: - \"`adjustment`\" - \"`courtesyAdjustment`\" - \"`customerCanceled`\" - \"`customerDiscretionaryReturn`\" - \"`deliveredLateByCarrier`\" - \"`feeAdjustment`\" - \"`lateShipmentCredit`\" - \"`noInventory`\" - \"`other`\" - \"`priceError`\" - \"`productArrivedDamaged`\" - \"`productNotAsDescribed`\" - \"`shippingCostAdjustment`\" - \"`taxAdjustment`\" - \"`undeliverableShippingAddress`\" - \"`wrongProductShipped`\" "
+ },
+ "amountTax": {
+ "$ref": "Price",
+ "description": "Tax amount that corresponds to refund amount in amountPretax. Optional, but if filled, amountPretax must be set. Calculated automatically if not provided."
+ }
+ }
+ },
+ "OrdersReturnRefundLineItemRequest": {
+ "properties": {
+ "lineItemId": {
+ "description": "The ID of the line item to return. Either lineItemId or productId is required.",
+ "type": "string"
+ },
+ "reasonText": {
+ "type": "string",
+ "description": "The explanation of the reason."
+ },
+ "quantity": {
+ "type": "integer",
+ "description": "The quantity to return and refund.",
+ "format": "uint32"
+ },
+ "productId": {
+ "description": "The ID of the product to return. This is the REST ID used in the products service. Either lineItemId or productId is required.",
+ "type": "string"
+ },
+ "reason": {
+ "type": "string",
+ "description": "The reason for the return. Acceptable values are: - \"`customerDiscretionaryReturn`\" - \"`customerInitiatedMerchantCancel`\" - \"`deliveredTooLate`\" - \"`expiredItem`\" - \"`invalidCoupon`\" - \"`malformedShippingAddress`\" - \"`other`\" - \"`productArrivedDamaged`\" - \"`productNotAsDescribed`\" - \"`qualityNotAsExpected`\" - \"`undeliverableShippingAddress`\" - \"`unsupportedPoBoxAddress`\" - \"`wrongProductShipped`\" "
+ },
+ "amountTax": {
+ "$ref": "Price",
+ "description": "Tax amount that corresponds to refund amount in amountPretax. Optional, but if filled, then amountPretax must be set. Calculated automatically if not provided."
+ },
+ "amountPretax": {
+ "$ref": "Price",
+ "description": "The amount that is refunded. If omitted, refundless return is assumed (same as calling returnLineItem method)."
+ },
+ "operationId": {
+ "type": "string",
+ "description": "The ID of the operation. Unique across all operations for a given order."
+ }
+ },
+ "type": "object",
+ "id": "OrdersReturnRefundLineItemRequest"
+ },
+ "AccountsAuthInfoResponse": {
+ "type": "object",
+ "id": "AccountsAuthInfoResponse",
+ "properties": {
+ "accountIdentifiers": {
+ "type": "array",
+ "description": "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. ",
+ "items": {
+ "$ref": "AccountIdentifier"
+ }
+ },
+ "kind": {
+ "type": "string",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#accountsAuthInfoResponse\"."
+ }
+ }
+ },
+ "AccountstatusesCustomBatchResponseEntry": {
+ "properties": {
+ "errors": {
+ "description": "A list of errors defined if and only if the request failed.",
+ "$ref": "Errors"
+ },
+ "batchId": {
+ "type": "integer",
+ "description": "The ID of the request entry this entry responds to.",
+ "format": "uint32"
+ },
+ "accountStatus": {
+ "description": "The requested account status. Defined if and only if the request was successful.",
+ "$ref": "AccountStatus"
+ }
+ },
+ "type": "object",
+ "id": "AccountstatusesCustomBatchResponseEntry",
+ "description": "A batch entry encoding a single non-batch accountstatuses response."
+ },
+ "ProductShippingDimension": {
+ "properties": {
+ "unit": {
+ "type": "string",
+ "description": "The unit of value."
+ },
+ "value": {
+ "format": "double",
+ "description": "The dimension of the product used to calculate the shipping cost of the item.",
+ "type": "number"
+ }
+ },
+ "type": "object",
+ "id": "ProductShippingDimension"
+ },
+ "ProductstatusesCustomBatchRequestEntry": {
+ "type": "object",
+ "id": "ProductstatusesCustomBatchRequestEntry",
+ "description": "A batch entry encoding a single non-batch productstatuses request.",
+ "properties": {
+ "batchId": {
+ "description": "An entry ID, unique within the batch request.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "includeAttributes": {
+ "type": "boolean"
+ },
+ "destinations": {
+ "items": {
+ "type": "string"
+ },
+ "description": "If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination.",
+ "type": "array"
+ },
+ "merchantId": {
+ "description": "The ID of the managing account.",
+ "type": "string",
+ "format": "uint64"
+ },
+ "productId": {
+ "description": "The ID of the product whose status to get.",
+ "type": "string"
+ },
+ "method": {
+ "description": "The method of the batch entry. Acceptable values are: - \"`get`\" ",
+ "type": "string"
+ }
+ }
+ },
+ "DatafeedStatusExample": {
+ "id": "DatafeedStatusExample",
+ "properties": {
+ "lineNumber": {
+ "format": "uint64",
+ "type": "string",
+ "description": "Line number in the data feed where the example is found."
+ },
+ "value": {
+ "description": "The problematic value.",
+ "type": "string"
+ },
+ "itemId": {
+ "type": "string",
+ "description": "The ID of the example item."
+ }
+ },
+ "type": "object",
+ "description": "An example occurrence for a particular error."
+ },
+ "OrderPickupDetailsCollector": {
+ "id": "OrderPickupDetailsCollector",
+ "properties": {
+ "phoneNumber": {
+ "description": "Phone number of the person picking up the shipment.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of the person picking up the shipment.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "OrderreportsListTransactionsResponse": {
+ "type": "object",
+ "properties": {
+ "kind": {
+ "type": "string",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#orderreportsListTransactionsResponse\"."
+ },
+ "nextPageToken": {
+ "type": "string",
+ "description": "The token for the retrieval of the next page of transactions."
+ },
+ "transactions": {
+ "description": "The list of transactions.",
+ "type": "array",
+ "items": {
+ "$ref": "OrderReportTransaction"
+ }
+ }
+ },
+ "id": "OrderreportsListTransactionsResponse"
+ },
+ "AccountsCustomBatchResponse": {
+ "properties": {
+ "entries": {
+ "items": {
+ "$ref": "AccountsCustomBatchResponseEntry"
+ },
+ "description": "The result of the execution of the batch requests.",
+ "type": "array"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#accountsCustomBatchResponse\".",
+ "type": "string"
+ }
+ },
+ "type": "object",
+ "id": "AccountsCustomBatchResponse"
+ },
+ "OrderCustomerMarketingRightsInfo": {
+ "type": "object",
+ "properties": {
+ "marketingEmailAddress": {
+ "type": "string",
+ "description": "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."
+ },
+ "explicitMarketingPreference": {
+ "description": "Last known customer selection regarding marketing preferences. In certain cases this selection might not be known, so this field would be empty. If a customer selected `granted` in their most recent order, they can be subscribed to marketing emails. Customers who have chosen `denied` must not be subscribed, or must be unsubscribed if already opted-in. Acceptable values are: - \"`denied`\" - \"`granted`\" ",
+ "type": "string"
+ },
+ "lastUpdatedTimestamp": {
+ "description": "Timestamp when last time marketing preference was updated. Could be empty, if user wasn't offered a selection yet.",
+ "type": "string"
+ }
+ },
+ "id": "OrderCustomerMarketingRightsInfo"
+ },
+ "OrdersAcknowledgeRequest": {
+ "properties": {
+ "operationId": {
+ "type": "string",
+ "description": "The ID of the operation. Unique across all operations for a given order."
+ }
+ },
+ "type": "object",
+ "id": "OrdersAcknowledgeRequest"
+ },
+ "HolidaysHoliday": {
+ "id": "HolidaysHoliday",
+ "properties": {
+ "deliveryGuaranteeDate": {
+ "description": "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.",
+ "type": "string"
+ },
+ "countryCode": {
+ "type": "string",
+ "description": "The CLDR territory code of the country in which the holiday is available. E.g. \"US\", \"DE\", \"GB\". A holiday cutoff can only be configured in a shipping settings service with matching delivery country. Always present."
+ },
+ "date": {
+ "type": "string",
+ "description": "Date of the holiday, in ISO 8601 format. E.g. \"2016-12-25\" for Christmas 2016. Always present."
+ },
+ "id": {
+ "description": "Unique identifier for the holiday to be used when configuring holiday cutoffs. Always present.",
+ "type": "string"
+ },
+ "deliveryGuaranteeHour": {
+ "format": "uint64",
+ "type": "string",
+ "description": "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."
+ },
+ "type": {
+ "description": "The holiday type. Always present. Acceptable values are: - \"`Christmas`\" - \"`Easter`\" - \"`Father's Day`\" - \"`Halloween`\" - \"`Independence Day (USA)`\" - \"`Mother's Day`\" - \"`Thanksgiving`\" - \"`Valentine's Day`\" ",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ShippingsettingsCustomBatchRequestEntry": {
+ "description": "A batch entry encoding a single non-batch shippingsettings request.",
+ "type": "object",
+ "id": "ShippingsettingsCustomBatchRequestEntry",
+ "properties": {
+ "method": {
+ "type": "string",
+ "description": "The method of the batch entry. Acceptable values are: - \"`get`\" - \"`update`\" "
+ },
+ "merchantId": {
+ "description": "The ID of the managing account.",
+ "type": "string",
+ "format": "uint64"
+ },
+ "accountId": {
+ "format": "uint64",
+ "description": "The ID of the account for which to get/update account shipping settings.",
+ "type": "string"
+ },
+ "batchId": {
+ "format": "uint32",
+ "type": "integer",
+ "description": "An entry ID, unique within the batch request."
+ },
+ "shippingSettings": {
+ "description": "The account shipping settings to update. Only defined if the method is `update`.",
+ "$ref": "ShippingSettings"
+ }
+ }
+ },
+ "AccountGoogleMyBusinessLink": {
+ "id": "AccountGoogleMyBusinessLink",
+ "properties": {
+ "gmbEmail": {
+ "type": "string",
+ "description": "The GMB email address of which a specific account within a GMB account. A sample account within a GMB account could be a business account with set of locations, managed under the GMB account."
+ },
+ "status": {
+ "type": "string",
+ "description": "Status of the link between this Merchant Center account and the GMB account. Acceptable values are: - \"`active`\" - \"`pending`\" "
+ }
+ },
+ "type": "object"
+ },
+ "OrdersInStoreRefundLineItemResponse": {
+ "id": "OrdersInStoreRefundLineItemResponse",
+ "type": "object",
+ "properties": {
+ "kind": {
+ "type": "string",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersInStoreRefundLineItemResponse\"."
+ },
+ "executionStatus": {
+ "type": "string",
+ "description": "The status of the execution. Acceptable values are: - \"`duplicate`\" - \"`executed`\" "
+ }
+ }
+ },
+ "LiasettingsCustomBatchResponseEntry": {
+ "id": "LiasettingsCustomBatchResponseEntry",
+ "type": "object",
+ "properties": {
+ "posDataProviders": {
+ "type": "array",
+ "description": "The list of POS data providers.",
+ "items": {
+ "$ref": "PosDataProviders"
+ }
+ },
+ "errors": {
+ "description": "A list of errors defined if, and only if, the request failed.",
+ "$ref": "Errors"
+ },
+ "liaSettings": {
+ "$ref": "LiaSettings",
+ "description": "The retrieved or updated Lia settings."
+ },
+ "kind": {
+ "type": "string",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#liasettingsCustomBatchResponseEntry`\""
+ },
+ "gmbAccounts": {
+ "$ref": "GmbAccounts",
+ "description": "The the list of accessible GMB accounts."
+ },
+ "batchId": {
+ "description": "The ID of the request entry to which this entry responds.",
+ "type": "integer",
+ "format": "uint32"
+ }
+ }
+ },
+ "Headers": {
+ "id": "Headers",
+ "type": "object",
+ "description": "A non-empty list of row or column headers for a table. Exactly one of `prices`, `weights`, `numItems`, `postalCodeGroupNames`, or `location` must be set.",
+ "properties": {
+ "weights": {
+ "description": "A list of inclusive order weight upper bounds. The last weight's value can be `\"infinity\"`. For example `[{\"value\": \"10\", \"unit\": \"kg\"}, {\"value\": \"50\", \"unit\": \"kg\"}, {\"value\": \"infinity\", \"unit\": \"kg\"}]` represents the headers \"\u003c= 10kg\", \"\u003c= 50kg\", and \"\u003e 50kg\". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.",
+ "type": "array",
+ "items": {
+ "$ref": "Weight"
+ }
+ },
+ "prices": {
+ "items": {
+ "$ref": "Price"
+ },
+ "description": "A list of inclusive order price upper bounds. The last price's value can be `\"infinity\"`. For example `[{\"value\": \"10\", \"currency\": \"USD\"}, {\"value\": \"500\", \"currency\": \"USD\"}, {\"value\": \"infinity\", \"currency\": \"USD\"}]` represents the headers \"\u003c= $10\", \"\u003c= $500\", and \"\u003e $500\". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.",
+ "type": "array"
+ },
+ "postalCodeGroupNames": {
+ "description": "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. Must be non-empty. Can only be set if all other fields are not set.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "locations": {
+ "items": {
+ "$ref": "LocationIdSet"
+ },
+ "description": "A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.",
+ "type": "array"
+ },
+ "numberOfItems": {
+ "items": {
+ "type": "string"
+ },
+ "description": "A list of inclusive number of items upper bounds. The last value can be `\"infinity\"`. For example `[\"10\", \"50\", \"infinity\"]` represents the headers \"\u003c= 10 items\", \"\u003c= 50 items\", and \"\u003e 50 items\". Must be non-empty. Can only be set if all other fields are not set.",
+ "type": "array"
+ }
+ }
+ },
+ "OrdersCancelTestOrderByCustomerResponse": {
+ "id": "OrdersCancelTestOrderByCustomerResponse",
+ "type": "object",
+ "properties": {
+ "kind": {
+ "type": "string",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersCancelTestOrderByCustomerResponse\"."
+ }
+ }
+ },
+ "Row": {
+ "type": "object",
+ "id": "Row",
+ "properties": {
+ "cells": {
+ "items": {
+ "$ref": "Value"
+ },
+ "type": "array",
+ "description": "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."
+ }
+ }
+ },
+ "TransitTable": {
+ "type": "object",
+ "properties": {
+ "transitTimeLabels": {
+ "description": "A list of transit time labels. The last value can be `\"all other labels\"`. Example: `[\"food\", \"electronics\", \"all other labels\"]`.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "postalCodeGroupNames": {
+ "type": "array",
+ "description": "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.",
+ "items": {
+ "type": "string"
+ }
+ },
+ "rows": {
+ "items": {
+ "$ref": "TransitTableTransitTimeRow"
+ },
+ "type": "array"
+ }
+ },
+ "id": "TransitTable"
+ },
+ "Account": {
+ "id": "Account",
+ "description": "Account data. After the creation of a new account it may take a few minutes before it is fully operational. The methods delete, insert, and update require the admin role.",
+ "properties": {
+ "reviewsUrl": {
+ "type": "string",
+ "description": "[DEPRECATED] This field is never returned and will be ignored if provided."
+ },
+ "websiteUrl": {
+ "type": "string",
+ "description": "The merchant's website."
+ },
+ "adwordsLinks": {
+ "type": "array",
+ "items": {
+ "$ref": "AccountAdwordsLink"
+ },
+ "description": "List of linked AdWords accounts that are active or pending approval. To create a new link request, add a new link with status `active` to the list. It will remain in a `pending` state until approved or rejected either in the AdWords interface or through the AdWords API. To delete an active link, or to cancel a link request, remove it from the list."
+ },
+ "users": {
+ "items": {
+ "$ref": "AccountUser"
+ },
+ "description": "Users with access to the account. Every account (except for subaccounts) must have at least one admin user.",
+ "type": "array"
+ },
+ "sellerId": {
+ "type": "string",
+ "description": "Client-specific, locally-unique, internal ID for the child account."
+ },
+ "id": {
+ "format": "uint64",
+ "description": "Required for update. Merchant Center account ID.",
+ "type": "string"
+ },
+ "businessInformation": {
+ "description": "The business information of the account.",
+ "$ref": "AccountBusinessInformation"
+ },
+ "youtubeChannelLinks": {
+ "description": "List of linked YouTube channels that are active or pending approval. To create a new link request, add a new link with status `active` to the list. It will remain in a `pending` state until approved or rejected in the YT Creator Studio interface. To delete an active link, or to cancel a link request, remove it from the list.",
+ "type": "array",
+ "items": {
+ "$ref": "AccountYouTubeChannelLink"
+ }
+ },
+ "kind": {
+ "type": "string",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#account`\""
+ },
+ "adultContent": {
+ "description": "Indicates whether the merchant sells adult content.",
+ "type": "boolean"
+ },
+ "name": {
+ "type": "string",
+ "description": "Required. Display name for the account."
+ },
+ "googleMyBusinessLink": {
+ "description": "The GMB account which is linked or in the process of being linked with the Merchant Center account.",
+ "$ref": "AccountGoogleMyBusinessLink"
+ }
+ },
+ "type": "object"
+ },
+ "OrdersRefundResponse": {
+ "properties": {
+ "executionStatus": {
+ "type": "string",
+ "description": "The status of the execution. Acceptable values are: - \"`duplicate`\" - \"`executed`\" "
+ },
+ "kind": {
+ "type": "string",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersRefundResponse\"."
+ }
+ },
+ "id": "OrdersRefundResponse",
+ "type": "object"
+ },
+ "PosInventoryResponse": {
+ "type": "object",
+ "id": "PosInventoryResponse",
+ "properties": {
+ "quantity": {
+ "format": "int64",
+ "type": "string",
+ "description": "Required. The available quantity of the item."
+ },
+ "contentLanguage": {
+ "type": "string",
+ "description": "Required. The two-letter ISO 639-1 language code for the item."
+ },
+ "itemId": {
+ "description": "Required. A unique identifier for the item.",
+ "type": "string"
+ },
+ "gtin": {
+ "description": "Global Trade Item Number.",
+ "type": "string"
+ },
+ "targetCountry": {
+ "type": "string",
+ "description": "Required. The CLDR territory code for the item."
+ },
+ "kind": {
+ "type": "string",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#posInventoryResponse\"."
+ },
+ "timestamp": {
+ "description": "Required. The inventory timestamp, in ISO 8601 format.",
+ "type": "string"
+ },
+ "price": {
+ "description": "Required. The current price of the item.",
+ "$ref": "Price"
+ },
+ "storeCode": {
+ "description": "Required. The identifier of the merchant's store. Either a `storeCode` inserted via the API or the code of the store in Google My Business.",
+ "type": "string"
+ }
+ }
+ },
+ "ProductsCustomBatchResponseEntry": {
+ "type": "object",
+ "id": "ProductsCustomBatchResponseEntry",
+ "properties": {
+ "kind": {
+ "type": "string",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#productsCustomBatchResponseEntry`\""
+ },
+ "errors": {
+ "$ref": "Errors",
+ "description": "A list of errors defined if and only if the request failed."
+ },
+ "product": {
+ "description": "The inserted product. Only defined if the method is `insert` and if the request was successful.",
+ "$ref": "Product"
+ },
+ "batchId": {
+ "format": "uint32",
+ "type": "integer",
+ "description": "The ID of the request entry this entry responds to."
+ }
+ },
+ "description": "A batch entry encoding a single non-batch products response."
+ },
+ "InventoryCustomBatchRequest": {
+ "properties": {
+ "entries": {
+ "items": {
+ "$ref": "InventoryCustomBatchRequestEntry"
+ },
+ "type": "array",
+ "description": "The request entries to be processed in the batch."
+ }
+ },
+ "type": "object",
+ "id": "InventoryCustomBatchRequest"
+ },
+ "AccountstatusesCustomBatchRequestEntry": {
+ "type": "object",
+ "id": "AccountstatusesCustomBatchRequestEntry",
+ "description": "A batch entry encoding a single non-batch accountstatuses request.",
+ "properties": {
+ "batchId": {
+ "format": "uint32",
+ "type": "integer",
+ "description": "An entry ID, unique within the batch request."
+ },
+ "merchantId": {
+ "format": "uint64",
+ "type": "string",
+ "description": "The ID of the managing account."
+ },
+ "destinations": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array",
+ "description": "If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination."
+ },
+ "method": {
+ "description": "The method of the batch entry. Acceptable values are: - \"`get`\" ",
+ "type": "string"
+ },
+ "accountId": {
+ "format": "uint64",
+ "type": "string",
+ "description": "The ID of the (sub-)account whose status to get."
+ }
+ }
+ },
+ "ShipmentTrackingInfo": {
+ "id": "ShipmentTrackingInfo",
+ "type": "object",
+ "properties": {
+ "carrier": {
+ "type": "string",
+ "description": "The shipping carrier that handles the package. Acceptable values are: - \"`boxtal`\" - \"`bpost`\" - \"`chronopost`\" - \"`colisPrive`\" - \"`colissimo`\" - \"`cxt`\" - \"`deliv`\" - \"`dhl`\" - \"`dpd`\" - \"`dynamex`\" - \"`eCourier`\" - \"`easypost`\" - \"`efw`\" - \"`fedex`\" - \"`fedexSmartpost`\" - \"`geodis`\" - \"`gls`\" - \"`googleCourier`\" - \"`gsx`\" - \"`jdLogistics`\" - \"`laPoste`\" - \"`lasership`\" - \"`manual`\" - \"`mpx`\" - \"`onTrac`\" - \"`other`\" - \"`tnt`\" - \"`uds`\" - \"`ups`\" - \"`usps`\" "
+ },
+ "trackingNumber": {
+ "type": "string",
+ "description": "The tracking number for the package."
+ }
+ }
+ },
+ "AccountAddress": {
+ "properties": {
+ "country": {
+ "type": "string",
+ "description": "CLDR country code (e.g. \"US\"). This value cannot be set for a sub-account of an MCA. All MCA sub-accounts inherit the country of their parent MCA."
+ },
+ "locality": {
+ "type": "string",
+ "description": "City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs)."
+ },
+ "streetAddress": {
+ "type": "string",
+ "description": "Street-level part of the address."
+ },
+ "postalCode": {
+ "type": "string",
+ "description": "Postal code or ZIP (e.g. \"94043\")."
+ },
+ "region": {
+ "description": "Top-level administrative subdivision of the country. For example, a state like California (\"CA\") or a province like Quebec (\"QC\").",
+ "type": "string"
+ }
+ },
+ "type": "object",
+ "id": "AccountAddress"
+ },
+ "RateGroup": {
+ "type": "object",
+ "id": "RateGroup",
+ "properties": {
+ "singleValue": {
+ "$ref": "Value",
+ "description": "The value of the rate group (e.g. flat rate $10). Can only be set if `mainTable` and `subtables` are not set."
+ },
+ "subtables": {
+ "items": {
+ "$ref": "Table"
+ },
+ "type": "array",
+ "description": "A list of subtables referred to by `mainTable`. Can only be set if `mainTable` is set."
+ },
+ "mainTable": {
+ "$ref": "Table",
+ "description": "A table defining the rate group, when `singleValue` is not expressive enough. Can only be set if `singleValue` is not set."
+ },
+ "carrierRates": {
+ "description": "A list of carrier rates that can be referred to by `mainTable` or `singleValue`.",
+ "items": {
+ "$ref": "CarrierRate"
+ },
+ "type": "array"
+ },
+ "applicableShippingLabels": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "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."
+ },
+ "name": {
+ "description": "Name of the rate group. Optional. If set has to be unique within shipping service.",
+ "type": "string"
+ }
+ }
+ },
+ "AccountTaxTaxRule": {
+ "description": "Tax calculation rule to apply in a state or province (USA only).",
+ "properties": {
+ "useGlobalRate": {
+ "type": "boolean",
+ "description": "Whether the tax rate is taken from a global tax table or specified explicitly."
+ },
+ "shippingTaxed": {
+ "type": "boolean",
+ "description": "If true, shipping charges are also taxed."
+ },
+ "ratePercent": {
+ "type": "string",
+ "description": "Explicit tax rate in percent, represented as a floating point number without the percentage character. Must not be negative."
+ },
+ "country": {
+ "description": "Country code in which tax is applicable.",
+ "type": "string"
+ },
+ "locationId": {
+ "type": "string",
+ "format": "uint64",
+ "description": "Required. State (or province) is which the tax is applicable, described by its location ID (also called criteria ID)."
+ }
+ },
+ "id": "AccountTaxTaxRule",
+ "type": "object"
+ },
+ "AccountsCustomBatchResponseEntry": {
+ "type": "object",
+ "description": "A batch entry encoding a single non-batch accounts response.",
+ "properties": {
+ "batchId": {
+ "description": "The ID of the request entry this entry responds to.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "linkStatus": {
+ "description": "Deprecated. This field is never set. Acceptable values are: - \"`active`\" - \"`inactive`\" - \"`pending`\" ",
+ "type": "string"
+ },
+ "errors": {
+ "description": "A list of errors defined if and only if the request failed.",
+ "$ref": "Errors"
+ },
+ "kind": {
+ "type": "string",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#accountsCustomBatchResponseEntry`\""
+ },
+ "account": {
+ "$ref": "Account",
+ "description": "The retrieved, created, or updated account. Not defined if the method was `delete`, `claimwebsite` or `link`."
+ }
+ },
+ "id": "AccountsCustomBatchResponseEntry"
+ },
+ "CustomGroup": {
+ "id": "CustomGroup",
+ "type": "object",
+ "properties": {
+ "attributes": {
+ "items": {
+ "$ref": "CustomAttribute"
+ },
+ "type": "array",
+ "description": "The sub-attributes."
+ },
+ "name": {
+ "type": "string",
+ "description": "The name of the group. Underscores will be replaced by spaces upon insertion."
+ }
+ }
+ },
+ "OrdersListResponse": {
+ "type": "object",
+ "properties": {
+ "resources": {
+ "items": {
+ "$ref": "Order"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "type": "string",
+ "description": "The token for the retrieval of the next page of orders."
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersListResponse\".",
+ "type": "string"
+ }
+ },
+ "id": "OrdersListResponse"
+ },
+ "GmbAccounts": {
+ "id": "GmbAccounts",
+ "type": "object",
+ "properties": {
+ "accountId": {
+ "format": "uint64",
+ "type": "string",
+ "description": "The ID of the Merchant Center account."
+ },
+ "gmbAccounts": {
+ "description": "A list of GMB accounts which are available to the merchant.",
+ "items": {
+ "$ref": "GmbAccountsGmbAccount"
+ },
+ "type": "array"
+ }
+ }
+ },
+ "OrdersCreateTestOrderRequest": {
+ "properties": {
+ "testOrder": {
+ "description": "The test order to create.",
+ "$ref": "TestOrder"
+ },
+ "templateName": {
+ "description": "The test order template to use. Specify as an alternative to `testOrder` as a shortcut for retrieving a template and then creating an order using that template. Acceptable values are: - \"`template1`\" - \"`template1a`\" - \"`template1b`\" - \"`template2`\" - \"`template3`\" ",
+ "type": "string"
+ },
+ "country": {
+ "type": "string",
+ "description": "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`."
+ }
+ },
+ "type": "object",
+ "id": "OrdersCreateTestOrderRequest"
+ },
+ "OrderDeliveryDetails": {
+ "id": "OrderDeliveryDetails",
+ "type": "object",
+ "properties": {
+ "phoneNumber": {
+ "description": "The phone number of the person receiving the delivery.",
+ "type": "string"
+ },
+ "address": {
+ "$ref": "OrderAddress",
+ "description": "The delivery address"
+ }
+ }
+ },
+ "AccounttaxCustomBatchResponseEntry": {
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#accounttaxCustomBatchResponseEntry`\"",
+ "type": "string"
+ },
+ "errors": {
+ "$ref": "Errors",
+ "description": "A list of errors defined if and only if the request failed."
+ },
+ "accountTax": {
+ "description": "The retrieved or updated account tax settings.",
+ "$ref": "AccountTax"
+ },
+ "batchId": {
+ "format": "uint32",
+ "description": "The ID of the request entry this entry responds to.",
+ "type": "integer"
+ }
+ },
+ "type": "object",
+ "description": "A batch entry encoding a single non-batch accounttax response.",
+ "id": "AccounttaxCustomBatchResponseEntry"
+ },
+ "OrderinvoicesCreateRefundInvoiceRequest": {
+ "id": "OrderinvoicesCreateRefundInvoiceRequest",
+ "type": "object",
+ "properties": {
+ "shipmentInvoices": {
+ "items": {
+ "$ref": "ShipmentInvoice"
+ },
+ "description": "Invoice details for different shipment groups.",
+ "type": "array"
+ },
+ "returnOption": {
+ "$ref": "OrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceReturnOption",
+ "description": "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."
+ },
+ "invoiceId": {
+ "type": "string",
+ "description": "[required] The ID of the invoice."
+ },
+ "refundOnlyOption": {
+ "description": "Option to create a refund-only invoice. Exactly one of `refundOnlyOption` or `returnOption` must be provided.",
+ "$ref": "OrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceRefundOption"
+ },
+ "operationId": {
+ "description": "[required] The ID of the operation, unique across all operations for a given order.",
+ "type": "string"
+ }
+ }
+ },
+ "OrdersUpdateMerchantOrderIdRequest": {
+ "type": "object",
+ "properties": {
+ "operationId": {
+ "type": "string",
+ "description": "The ID of the operation. Unique across all operations for a given order."
+ },
+ "merchantOrderId": {
+ "type": "string",
+ "description": "The merchant order id to be assigned to the order. Must be unique per merchant."
+ }
+ },
+ "id": "OrdersUpdateMerchantOrderIdRequest"
+ },
+ "Value": {
+ "type": "object",
+ "description": "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.",
+ "id": "Value",
+ "properties": {
+ "subtableName": {
+ "type": "string",
+ "description": "The name of a subtable. Can only be set in table cells (i.e., not for single values), and only if all other fields are not set."
+ },
+ "pricePercentage": {
+ "description": "A percentage of the price represented as a number in decimal notation (e.g., `\"5.4\"`). Can only be set if all other fields are not set.",
+ "type": "string"
+ },
+ "noShipping": {
+ "description": "If true, then the product can't ship. Must be true when set, can only be set if all other fields are not set.",
+ "type": "boolean"
+ },
+ "carrierRateName": {
+ "description": "The name of a carrier rate referring to a carrier rate defined in the same rate group. Can only be set if all other fields are not set.",
+ "type": "string"
+ },
+ "flatRate": {
+ "$ref": "Price",
+ "description": "A flat rate. Can only be set if all other fields are not set."
+ }
+ }
+ },
+ "OrderLineItemProduct": {
+ "id": "OrderLineItemProduct",
+ "properties": {
+ "channel": {
+ "type": "string",
+ "description": "The item's channel (online or local). Acceptable values are: - \"`local`\" - \"`online`\" "
+ },
+ "variantAttributes": {
+ "type": "array",
+ "description": "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.",
+ "items": {
+ "$ref": "OrderLineItemProductVariantAttribute"
+ }
+ },
+ "contentLanguage": {
+ "description": "The two-letter ISO 639-1 language code for the item.",
+ "type": "string"
+ },
+ "gtin": {
+ "description": "Global Trade Item Number (GTIN) of the item.",
+ "type": "string"
+ },
+ "condition": {
+ "description": "Condition or state of the item. Acceptable values are: - \"`new`\" - \"`refurbished`\" - \"`used`\" ",
+ "type": "string"
+ },
+ "targetCountry": {
+ "type": "string",
+ "description": "The CLDR territory // code of the target country of the product."
+ },
+ "itemGroupId": {
+ "type": "string",
+ "description": "Shared identifier for all variants of the same product."
+ },
+ "imageLink": {
+ "type": "string",
+ "description": "URL of an image of the item."
+ },
+ "brand": {
+ "description": "Brand of the item.",
+ "type": "string"
+ },
+ "title": {
+ "type": "string",
+ "description": "The title of the product."
+ },
+ "fees": {
+ "items": {
+ "$ref": "OrderLineItemProductFee"
+ },
+ "type": "array",
+ "description": "Associated fees at order creation time."
+ },
+ "id": {
+ "type": "string",
+ "description": "The REST ID of the product."
+ },
+ "mpn": {
+ "type": "string",
+ "description": "Manufacturer Part Number (MPN) of the item."
+ },
+ "shownImage": {
+ "description": "URL to the cached image shown to the user when order was placed.",
+ "type": "string"
+ },
+ "offerId": {
+ "description": "An identifier of the item.",
+ "type": "string"
+ },
+ "price": {
+ "$ref": "Price",
+ "description": "Price of the item."
+ }
+ },
+ "type": "object"
+ },
+ "LiasettingsCustomBatchRequest": {
+ "id": "LiasettingsCustomBatchRequest",
+ "type": "object",
+ "properties": {
+ "entries": {
+ "items": {
+ "$ref": "LiasettingsCustomBatchRequestEntry"
+ },
+ "description": "The request entries to be processed in the batch.",
+ "type": "array"
+ }
+ }
+ },
+ "Price": {
+ "type": "object",
+ "id": "Price",
+ "properties": {
+ "currency": {
+ "type": "string",
+ "description": "The currency of the price."
+ },
+ "value": {
+ "description": "The price represented as a number.",
+ "type": "string"
+ }
+ }
+ },
+ "PosSaleRequest": {
+ "type": "object",
+ "id": "PosSaleRequest",
+ "properties": {
+ "contentLanguage": {
+ "type": "string",
+ "description": "Required. The two-letter ISO 639-1 language code for the item."
+ },
+ "quantity": {
+ "format": "int64",
+ "type": "string",
+ "description": "Required. The relative change of the available quantity. Negative for items returned."
+ },
+ "gtin": {
+ "type": "string",
+ "description": "Global Trade Item Number."
+ },
+ "itemId": {
+ "type": "string",
+ "description": "Required. A unique identifier for the item."
+ },
+ "timestamp": {
+ "description": "Required. The inventory timestamp, in ISO 8601 format.",
+ "type": "string"
+ },
+ "targetCountry": {
+ "type": "string",
+ "description": "Required. The CLDR territory code for the item."
+ },
+ "storeCode": {
+ "description": "Required. The identifier of the merchant's store. Either a `storeCode` inserted via the API or the code of the store in Google My Business.",
+ "type": "string"
+ },
+ "price": {
+ "$ref": "Price",
+ "description": "Required. The price of the item."
+ },
+ "saleId": {
+ "description": "A unique ID to group items from the same sale event.",
+ "type": "string"
+ }
+ }
+ },
+ "DatafeedstatusesCustomBatchResponseEntry": {
+ "id": "DatafeedstatusesCustomBatchResponseEntry",
+ "properties": {
+ "datafeedStatus": {
+ "description": "The requested data feed status. Defined if and only if the request was successful.",
+ "$ref": "DatafeedStatus"
+ },
+ "errors": {
+ "description": "A list of errors defined if and only if the request failed.",
+ "$ref": "Errors"
+ },
+ "batchId": {
+ "format": "uint32",
+ "description": "The ID of the request entry this entry responds to.",
+ "type": "integer"
+ }
+ },
+ "type": "object",
+ "description": "A batch entry encoding a single non-batch datafeedstatuses response."
+ },
+ "OrdersCustomBatchRequestEntryReturnRefundLineItem": {
+ "type": "object",
+ "id": "OrdersCustomBatchRequestEntryReturnRefundLineItem",
+ "properties": {
+ "lineItemId": {
+ "description": "The ID of the line item to return. Either lineItemId or productId is required.",
+ "type": "string"
+ },
+ "productId": {
+ "description": "The ID of the product to return. This is the REST ID used in the products service. Either lineItemId or productId is required.",
+ "type": "string"
+ },
+ "amountTax": {
+ "description": "Tax amount that corresponds to refund amount in amountPretax. Optional, but if filled, then amountPretax must be set. Calculated automatically if not provided.",
+ "$ref": "Price"
+ },
+ "amountPretax": {
+ "description": "The amount that is refunded. If omitted, refundless return is assumed (same as calling returnLineItem method).",
+ "$ref": "Price"
+ },
+ "reasonText": {
+ "description": "The explanation of the reason.",
+ "type": "string"
+ },
+ "reason": {
+ "description": "The reason for the return. Acceptable values are: - \"`customerDiscretionaryReturn`\" - \"`customerInitiatedMerchantCancel`\" - \"`deliveredTooLate`\" - \"`expiredItem`\" - \"`invalidCoupon`\" - \"`malformedShippingAddress`\" - \"`other`\" - \"`productArrivedDamaged`\" - \"`productNotAsDescribed`\" - \"`qualityNotAsExpected`\" - \"`undeliverableShippingAddress`\" - \"`unsupportedPoBoxAddress`\" - \"`wrongProductShipped`\" ",
+ "type": "string"
+ },
+ "quantity": {
+ "type": "integer",
+ "description": "The quantity to return and refund.",
+ "format": "uint32"
+ }
+ }
+ },
+ "LiasettingsListResponse": {
+ "type": "object",
+ "properties": {
+ "resources": {
+ "type": "array",
+ "items": {
+ "$ref": "LiaSettings"
+ }
+ },
+ "nextPageToken": {
+ "description": "The token for the retrieval of the next page of LIA settings.",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#liasettingsListResponse\".",
+ "type": "string"
+ }
+ },
+ "id": "LiasettingsListResponse"
+ },
+ "LiasettingsGetAccessibleGmbAccountsResponse": {
+ "id": "LiasettingsGetAccessibleGmbAccountsResponse",
+ "properties": {
+ "accountId": {
+ "format": "uint64",
+ "type": "string",
+ "description": "The ID of the Merchant Center account."
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#liasettingsGetAccessibleGmbAccountsResponse\".",
+ "type": "string"
+ },
+ "gmbAccounts": {
+ "items": {
+ "$ref": "GmbAccountsGmbAccount"
+ },
+ "description": "A list of GMB accounts which are available to the merchant.",
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "OrdersCustomBatchRequestEntryInStoreRefundLineItem": {
+ "properties": {
+ "amountTax": {
+ "description": "Tax amount that correspond to refund amount in amountPretax. Required.",
+ "$ref": "Price"
+ },
+ "quantity": {
+ "format": "uint32",
+ "type": "integer",
+ "description": "The quantity to return and refund."
+ },
+ "amountPretax": {
+ "$ref": "Price",
+ "description": "The amount that is refunded. Required."
+ },
+ "lineItemId": {
+ "description": "The ID of the line item to return. Either lineItemId or productId is required.",
+ "type": "string"
+ },
+ "reasonText": {
+ "type": "string",
+ "description": "The explanation of the reason."
+ },
+ "reason": {
+ "description": "The reason for the return. Acceptable values are: - \"`customerDiscretionaryReturn`\" - \"`customerInitiatedMerchantCancel`\" - \"`deliveredTooLate`\" - \"`expiredItem`\" - \"`invalidCoupon`\" - \"`malformedShippingAddress`\" - \"`other`\" - \"`productArrivedDamaged`\" - \"`productNotAsDescribed`\" - \"`qualityNotAsExpected`\" - \"`undeliverableShippingAddress`\" - \"`unsupportedPoBoxAddress`\" - \"`wrongProductShipped`\" ",
+ "type": "string"
+ },
+ "productId": {
+ "type": "string",
+ "description": "The ID of the product to return. This is the REST ID used in the products service. Either lineItemId or productId is required."
+ }
+ },
+ "id": "OrdersCustomBatchRequestEntryInStoreRefundLineItem",
+ "type": "object"
+ },
+ "Amount": {
+ "properties": {
+ "pretax": {
+ "description": "[required] Value before taxes.",
+ "$ref": "Price"
+ },
+ "tax": {
+ "description": "[required] Tax value.",
+ "$ref": "Price"
+ }
+ },
+ "type": "object",
+ "id": "Amount"
+ },
+ "ShippingsettingsCustomBatchRequest": {
+ "id": "ShippingsettingsCustomBatchRequest",
+ "properties": {
+ "entries": {
+ "description": "The request entries to be processed in the batch.",
+ "type": "array",
+ "items": {
+ "$ref": "ShippingsettingsCustomBatchRequestEntry"
+ }
+ }
+ },
+ "type": "object"
+ },
+ "LiasettingsSetPosDataProviderResponse": {
+ "type": "object",
+ "properties": {
+ "kind": {
+ "type": "string",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#liasettingsSetPosDataProviderResponse\"."
+ }
+ },
+ "id": "LiasettingsSetPosDataProviderResponse"
+ },
+ "AccounttaxCustomBatchResponse": {
+ "type": "object",
+ "properties": {
+ "entries": {
+ "items": {
+ "$ref": "AccounttaxCustomBatchResponseEntry"
+ },
+ "description": "The result of the execution of the batch requests.",
+ "type": "array"
+ },
+ "kind": {
+ "type": "string",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#accounttaxCustomBatchResponse\"."
+ }
+ },
+ "id": "AccounttaxCustomBatchResponse"
+ },
+ "ProductStatusDataQualityIssue": {
+ "type": "object",
+ "properties": {
+ "valueProvided": {
+ "type": "string"
+ },
+ "destination": {
+ "type": "string"
+ },
+ "location": {
+ "type": "string"
+ },
+ "valueOnLandingPage": {
+ "type": "string"
+ },
+ "fetchStatus": {
+ "type": "string"
+ },
+ "timestamp": {
+ "type": "string"
+ },
+ "id": {
+ "type": "string"
+ },
+ "detail": {
+ "type": "string"
+ },
+ "severity": {
+ "type": "string"
+ }
+ },
+ "id": "ProductStatusDataQualityIssue"
+ },
+ "TestOrderLineItemProduct": {
+ "id": "TestOrderLineItemProduct",
+ "properties": {
+ "variantAttributes": {
+ "description": "Variant attributes for the item. Optional.",
+ "type": "array",
+ "items": {
+ "$ref": "OrderLineItemProductVariantAttribute"
+ }
+ },
+ "itemGroupId": {
+ "description": "Shared identifier for all variants of the same product. Optional.",
+ "type": "string"
+ },
+ "mpn": {
+ "description": "Manufacturer Part Number (MPN) of the item. Optional.",
+ "type": "string"
+ },
+ "fees": {
+ "description": "Fees for the item. Optional.",
+ "type": "array",
+ "items": {
+ "$ref": "OrderLineItemProductFee"
+ }
+ },
+ "condition": {
+ "type": "string",
+ "description": "Required. Condition or state of the item. Acceptable values are: - \"`new`\" "
+ },
+ "price": {
+ "description": "Required. The price for the product. Tax is automatically calculated for orders where marketplace facilitator tax laws are applicable. Otherwise, tax settings from Merchant Center are applied.",
+ "$ref": "Price"
+ },
+ "targetCountry": {
+ "description": "Required. The CLDR territory // code of the target country of the product.",
+ "type": "string"
+ },
+ "imageLink": {
+ "description": "Required. URL of an image of the item.",
+ "type": "string"
+ },
+ "contentLanguage": {
+ "description": "Required. The two-letter ISO 639-1 language code for the item. Acceptable values are: - \"`en`\" - \"`fr`\" ",
+ "type": "string"
+ },
+ "title": {
+ "description": "Required. The title of the product.",
+ "type": "string"
+ },
+ "gtin": {
+ "description": "Global Trade Item Number (GTIN) of the item. Optional.",
+ "type": "string"
+ },
+ "brand": {
+ "type": "string",
+ "description": "Required. Brand of the item."
+ },
+ "channel": {
+ "type": "string",
+ "description": "Deprecated. Acceptable values are: - \"`online`\" "
+ },
+ "offerId": {
+ "description": "Required. An identifier of the item.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "LocationIdSet": {
+ "type": "object",
+ "id": "LocationIdSet",
+ "properties": {
+ "locationIds": {
+ "description": "A non-empty list of location IDs. They must all be of the same location type (e.g., state).",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ }
+ },
+ "PickupServicesPickupService": {
+ "properties": {
+ "carrierName": {
+ "type": "string",
+ "description": "The name of the carrier (e.g., `\"UPS\"`). Always present."
+ },
+ "country": {
+ "description": "The CLDR country code of the carrier (e.g., \"US\"). Always present.",
+ "type": "string"
+ },
+ "serviceName": {
+ "type": "string",
+ "description": "The name of the pickup service (e.g., `\"Access point\"`). Always present."
+ }
+ },
+ "type": "object",
+ "id": "PickupServicesPickupService"
+ },
+ "AccountstatusesCustomBatchRequest": {
+ "type": "object",
+ "id": "AccountstatusesCustomBatchRequest",
+ "properties": {
+ "entries": {
+ "description": "The request entries to be processed in the batch.",
+ "type": "array",
+ "items": {
+ "$ref": "AccountstatusesCustomBatchRequestEntry"
+ }
+ }
+ }
+ },
+ "AccounttaxCustomBatchRequest": {
+ "type": "object",
+ "id": "AccounttaxCustomBatchRequest",
+ "properties": {
+ "entries": {
+ "items": {
+ "$ref": "AccounttaxCustomBatchRequestEntry"
+ },
+ "description": "The request entries to be processed in the batch.",
+ "type": "array"
+ }
+ }
+ },
+ "TestOrderCustomer": {
+ "type": "object",
+ "id": "TestOrderCustomer",
+ "properties": {
+ "email": {
+ "type": "string",
+ "description": "Required. Email address of the customer. Acceptable values are: - \"`pog.dwight.schrute@gmail.com`\" - \"`pog.jim.halpert@gmail.com`\" - \"`penpog.pam.beesly@gmail.comding`\" "
+ },
+ "explicitMarketingPreference": {
+ "type": "boolean",
+ "description": "Deprecated. Please use marketingRightsInfo instead."
+ },
+ "fullName": {
+ "description": "Full name of the customer.",
+ "type": "string"
+ },
+ "marketingRightsInfo": {
+ "$ref": "TestOrderCustomerMarketingRightsInfo",
+ "description": "Customer's marketing preferences."
+ }
+ }
+ },
+ "AccountsLinkRequest": {
+ "properties": {
+ "linkedAccountId": {
+ "type": "string",
+ "description": "The ID of the linked account."
+ },
+ "linkType": {
+ "type": "string",
+ "description": "Type of the link between the two accounts. Acceptable values are: - \"`channelPartner`\" - \"`eCommercePlatform`\" "
+ },
+ "action": {
+ "type": "string",
+ "description": "Action to perform for this link. The `\"request\"` action is only available to select merchants. Acceptable values are: - \"`approve`\" - \"`remove`\" - \"`request`\" "
+ }
+ },
+ "type": "object",
+ "id": "AccountsLinkRequest"
+ },
+ "ReturnShipment": {
+ "properties": {
+ "returnMethodType": {
+ "type": "string",
+ "description": "Type of the return method. Acceptable values are: - \"`byMail`\" - \"`contactCustomerSupport`\" - \"`returnless`\" "
+ },
+ "state": {
+ "description": "State of the shipment. Acceptable values are: - \"`completed`\" - \"`new`\" - \"`shipped`\" - \"`undeliverable`\" - \"`pending`\" ",
+ "type": "string"
+ },
+ "shippingDate": {
+ "type": "string",
+ "description": "The date of shipping of the shipment, in ISO 8601 format."
+ },
+ "shipmentId": {
+ "description": "Shipment ID generated by Google.",
+ "type": "string"
+ },
+ "creationDate": {
+ "type": "string",
+ "description": "The date of creation of the shipment, in ISO 8601 format."
+ },
+ "deliveryDate": {
+ "type": "string",
+ "description": "The date of delivery of the shipment, in ISO 8601 format."
+ },
+ "shipmentTrackingInfos": {
+ "description": "Tracking information of the shipment. One return shipment might be handled by several shipping carriers sequentially.",
+ "items": {
+ "$ref": "ShipmentTrackingInfo"
+ },
+ "type": "array"
+ }
+ },
+ "id": "ReturnShipment",
+ "type": "object"
+ },
+ "OrderinvoicesCreateChargeInvoiceRequest": {
+ "type": "object",
+ "properties": {
+ "invoiceSummary": {
+ "$ref": "InvoiceSummary",
+ "description": "[required] Invoice summary."
+ },
+ "shipmentGroupId": {
+ "type": "string",
+ "description": "[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."
+ },
+ "invoiceId": {
+ "type": "string",
+ "description": "[required] The ID of the invoice."
+ },
+ "lineItemInvoices": {
+ "description": "[required] Invoice details per line item.",
+ "items": {
+ "$ref": "ShipmentInvoiceLineItemInvoice"
+ },
+ "type": "array"
+ },
+ "operationId": {
+ "description": "[required] The ID of the operation, unique across all operations for a given order.",
+ "type": "string"
+ }
+ },
+ "id": "OrderinvoicesCreateChargeInvoiceRequest"
+ },
+ "DatafeedsCustomBatchResponse": {
+ "type": "object",
+ "id": "DatafeedsCustomBatchResponse",
+ "properties": {
+ "entries": {
+ "items": {
+ "$ref": "DatafeedsCustomBatchResponseEntry"
+ },
+ "type": "array",
+ "description": "The result of the execution of the batch requests."
+ },
+ "kind": {
+ "type": "string",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#datafeedsCustomBatchResponse\"."
+ }
+ }
+ },
+ "DatafeedFormat": {
+ "type": "object",
+ "id": "DatafeedFormat",
+ "properties": {
+ "columnDelimiter": {
+ "type": "string",
+ "description": "Delimiter for the separation of values in a delimiter-separated values feed. If not specified, the delimiter will be auto-detected. Ignored for non-DSV data feeds. Acceptable values are: - \"`pipe`\" - \"`tab`\" - \"`tilde`\" "
+ },
+ "fileEncoding": {
+ "description": "Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected. Acceptable values are: - \"`latin-1`\" - \"`utf-16be`\" - \"`utf-16le`\" - \"`utf-8`\" - \"`windows-1252`\" ",
+ "type": "string"
+ },
+ "quotingMode": {
+ "type": "string",
+ "description": "Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds. Acceptable values are: - \"`normal character`\" - \"`value quoting`\" "
+ }
+ }
+ },
+ "PickupCarrierService": {
+ "properties": {
+ "serviceName": {
+ "type": "string",
+ "description": "The name of the pickup service (e.g., `\"Access point\"`). Required."
+ },
+ "carrierName": {
+ "description": "The name of the pickup carrier (e.g., `\"UPS\"`). Required.",
+ "type": "string"
+ }
+ },
+ "id": "PickupCarrierService",
+ "type": "object"
+ },
+ "OrdersCustomBatchRequestEntryCancelLineItem": {
+ "id": "OrdersCustomBatchRequestEntryCancelLineItem",
+ "properties": {
+ "reasonText": {
+ "description": "The explanation of the reason.",
+ "type": "string"
+ },
+ "lineItemId": {
+ "type": "string",
+ "description": "The ID of the line item to cancel. Either lineItemId or productId is required."
+ },
+ "reason": {
+ "description": "The reason for the cancellation. Acceptable values are: - \"`customerInitiatedCancel`\" - \"`invalidCoupon`\" - \"`malformedShippingAddress`\" - \"`noInventory`\" - \"`other`\" - \"`priceError`\" - \"`shippingPriceError`\" - \"`taxError`\" - \"`undeliverableShippingAddress`\" - \"`unsupportedPoBoxAddress`\" ",
+ "type": "string"
+ },
+ "amountPretax": {
+ "$ref": "Price",
+ "description": "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."
+ },
+ "quantity": {
+ "description": "The quantity to cancel.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "amount": {
+ "description": "Deprecated. Please use amountPretax and amountTax instead.",
+ "$ref": "Price"
+ },
+ "productId": {
+ "description": "The ID of the product to cancel. This is the REST ID used in the products service. Either lineItemId or productId is required.",
+ "type": "string"
+ },
+ "amountTax": {
+ "$ref": "Price",
+ "description": "Tax amount that corresponds to cancellation amount in amountPretax. Optional, but if filled, then amountPretax must be set. Calculated automatically if not provided."
+ }
+ },
+ "type": "object"
+ },
+ "OrderLegacyPromotion": {
+ "id": "OrderLegacyPromotion",
+ "properties": {
+ "longTitle": {
+ "description": "The full title of the promotion.",
+ "type": "string"
+ },
+ "benefits": {
+ "items": {
+ "$ref": "OrderLegacyPromotionBenefit"
+ },
+ "type": "array"
+ },
+ "id": {
+ "type": "string",
+ "description": "The unique ID of the promotion."
+ },
+ "redemptionChannel": {
+ "type": "string",
+ "description": "Indicates that the promotion is valid online. Acceptable values are: - \"`online`\" "
+ },
+ "genericRedemptionCode": {
+ "description": "Optional. The text code that corresponds to the promotion when applied on the retailer?s website.",
+ "type": "string"
+ },
+ "productApplicability": {
+ "type": "string",
+ "description": "Whether the promotion is applicable to all products or only specific products. Acceptable values are: - \"`allProducts`\" - \"`specificProducts`\" "
+ },
+ "effectiveDates": {
+ "description": "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.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "PosCustomBatchRequestEntry": {
+ "properties": {
+ "inventory": {
+ "description": "The inventory to submit. This should be set only if the method is `inventory`.",
+ "$ref": "PosInventory"
+ },
+ "store": {
+ "$ref": "PosStore",
+ "description": "The store information to submit. This should be set only if the method is `insert`."
+ },
+ "method": {
+ "type": "string",
+ "description": "The method of the batch entry. Acceptable values are: - \"`delete`\" - \"`get`\" - \"`insert`\" - \"`inventory`\" - \"`sale`\" "
+ },
+ "batchId": {
+ "description": "An entry ID, unique within the batch request.",
+ "type": "integer",
+ "format": "uint32"
+ },
+ "merchantId": {
+ "description": "The ID of the POS data provider.",
+ "format": "uint64",
+ "type": "string"
+ },
+ "sale": {
+ "description": "The sale information to submit. This should be set only if the method is `sale`.",
+ "$ref": "PosSale"
+ },
+ "storeCode": {
+ "type": "string",
+ "description": "The store code. This should be set only if the method is `delete` or `get`."
+ },
+ "targetMerchantId": {
+ "type": "string",
+ "description": "The ID of the account for which to get/submit data.",
+ "format": "uint64"
+ }
+ },
+ "type": "object",
+ "id": "PosCustomBatchRequestEntry"
+ },
+ "OrderReturn": {
+ "type": "object",
+ "properties": {
+ "actor": {
+ "type": "string",
+ "description": "The actor that created the refund. Acceptable values are: - \"`customer`\" - \"`googleBot`\" - \"`googleCustomerService`\" - \"`googlePayments`\" - \"`googleSabre`\" - \"`merchant`\" "
+ },
+ "creationDate": {
+ "description": "Date on which the item has been created, in ISO 8601 format.",
+ "type": "string"
+ },
+ "quantity": {
+ "format": "uint32",
+ "type": "integer",
+ "description": "Quantity that is returned."
+ },
+ "reason": {
+ "type": "string",
+ "description": "The reason for the return. Acceptable values are: - \"`customerDiscretionaryReturn`\" - \"`customerInitiatedMerchantCancel`\" - \"`deliveredTooLate`\" - \"`expiredItem`\" - \"`invalidCoupon`\" - \"`malformedShippingAddress`\" - \"`other`\" - \"`productArrivedDamaged`\" - \"`productNotAsDescribed`\" - \"`qualityNotAsExpected`\" - \"`undeliverableShippingAddress`\" - \"`unsupportedPoBoxAddress`\" - \"`wrongProductShipped`\" "
+ },
+ "reasonText": {
+ "type": "string",
+ "description": "The explanation of the reason."
+ }
+ },
+ "id": "OrderReturn"
+ },
+ "AccounttaxListResponse": {
+ "properties": {
+ "nextPageToken": {
+ "type": "string",
+ "description": "The token for the retrieval of the next page of account tax settings."
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#accounttaxListResponse\".",
+ "type": "string"
+ },
+ "resources": {
+ "type": "array",
+ "items": {
+ "$ref": "AccountTax"
+ }
+ }
+ },
+ "type": "object",
+ "id": "AccounttaxListResponse"
+ },
+ "OrdersCustomBatchRequestEntryCancel": {
+ "properties": {
+ "reason": {
+ "description": "The reason for the cancellation. Acceptable values are: - \"`customerInitiatedCancel`\" - \"`invalidCoupon`\" - \"`malformedShippingAddress`\" - \"`noInventory`\" - \"`other`\" - \"`priceError`\" - \"`shippingPriceError`\" - \"`taxError`\" - \"`undeliverableShippingAddress`\" - \"`unsupportedPoBoxAddress`\" ",
+ "type": "string"
+ },
+ "reasonText": {
+ "type": "string",
+ "description": "The explanation of the reason."
+ }
+ },
+ "id": "OrdersCustomBatchRequestEntryCancel",
+ "type": "object"
+ },
+ "ShippingsettingsGetSupportedHolidaysResponse": {
+ "type": "object",
+ "id": "ShippingsettingsGetSupportedHolidaysResponse",
+ "properties": {
+ "holidays": {
+ "type": "array",
+ "items": {
+ "$ref": "HolidaysHoliday"
+ },
+ "description": "A list of holidays applicable for delivery guarantees. May be empty."
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#shippingsettingsGetSupportedHolidaysResponse\".",
+ "type": "string"
+ }
+ }
+ },
+ "DatafeedFetchSchedule": {
+ "type": "object",
+ "description": "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.",
+ "properties": {
+ "username": {
+ "type": "string",
+ "description": "An optional user name for fetch_url."
+ },
+ "weekday": {
+ "description": "The day of the week the feed file should be fetched. Acceptable values are: - \"`monday`\" - \"`tuesday`\" - \"`wednesday`\" - \"`thursday`\" - \"`friday`\" - \"`saturday`\" - \"`sunday`\" ",
+ "type": "string"
+ },
+ "dayOfMonth": {
+ "description": "The day of the month the feed file should be fetched (1-31).",
+ "type": "integer",
+ "format": "uint32"
+ },
+ "fetchUrl": {
+ "description": "The URL where the feed file can be fetched. Google Merchant Center will support automatic scheduled uploads using the HTTP, HTTPS, FTP, or SFTP protocols, so the value will need to be a valid link using one of those four protocols.",
+ "type": "string"
+ },
+ "paused": {
+ "type": "boolean",
+ "description": "Whether the scheduled fetch is paused or not."
+ },
+ "timeZone": {
+ "type": "string",
+ "description": "Time zone used for schedule. UTC by default. E.g., \"America/Los_Angeles\"."
+ },
+ "password": {
+ "type": "string",
+ "description": "An optional password for fetch_url."
+ },
+ "hour": {
+ "type": "integer",
+ "description": "The hour of the day the feed file should be fetched (0-23).",
+ "format": "uint32"
+ },
+ "minuteOfHour": {
+ "type": "integer",
+ "format": "uint32",
+ "description": "The minute of the hour the feed file should be fetched (0-59). Read-only."
+ }
+ },
+ "id": "DatafeedFetchSchedule"
+ },
+ "OrderLineItemProductFee": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Name of the fee.",
+ "type": "string"
+ },
+ "amount": {
+ "description": "Amount of the fee.",
+ "$ref": "Price"
+ }
+ },
+ "id": "OrderLineItemProductFee"
+ },
+ "InventorySetResponse": {
+ "id": "InventorySetResponse",
+ "properties": {
+ "kind": {
+ "type": "string",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#inventorySetResponse\"."
+ }
+ },
+ "type": "object"
+ },
+ "Product": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "The REST ID of the product. Content API methods that operate on products take this as their `productId` parameter. The REST ID for a product is of the form channel:contentLanguage: targetCountry: offerId.",
+ "type": "string"
+ },
+ "promotionIds": {
+ "description": "The unique ID of a promotion.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "warnings": {
+ "type": "array",
+ "items": {
+ "$ref": "Error"
+ },
+ "description": "Read-only warnings."
+ },
+ "aspects": {
+ "type": "array",
+ "description": "Deprecated. Do not use.",
+ "items": {
+ "$ref": "ProductAspect"
+ }
+ },
+ "displayAdsId": {
+ "description": "An identifier for an item for dynamic remarketing campaigns.",
+ "type": "string"
+ },
+ "title": {
+ "description": "Title of the item.",
+ "type": "string"
+ },
+ "customLabel4": {
+ "type": "string",
+ "description": "Custom label 4 for custom grouping of items in a Shopping campaign."
+ },
+ "minEnergyEfficiencyClass": {
+ "description": "The energy efficiency class as defined in EU directive 2010/30/EU. Acceptable values are: - \"`A`\" - \"`A+`\" - \"`A++`\" - \"`A+++`\" - \"`B`\" - \"`C`\" - \"`D`\" - \"`E`\" - \"`F`\" - \"`G`\" ",
+ "type": "string"
+ },
+ "maxHandlingTime": {
+ "format": "int64",
+ "type": "string",
+ "description": "Maximal product handling time (in business days)."
+ },
+ "costOfGoodsSold": {
+ "$ref": "Price",
+ "description": "Cost of goods sold. Used for gross profit reporting."
+ },
+ "sizeType": {
+ "description": "The cut of the item. Recommended for apparel items. Acceptable values are: - \"`big and tall`\" - \"`maternity`\" - \"`oversize`\" - \"`petite`\" - \"`plus`\" - \"`regular`\" ",
+ "type": "string"
+ },
+ "gender": {
+ "description": "Target gender of the item. Acceptable values are: - \"`female`\" - \"`male`\" - \"`unisex`\" ",
+ "type": "string"
+ },
+ "maxEnergyEfficiencyClass": {
+ "type": "string",
+ "description": "The energy efficiency class as defined in EU directive 2010/30/EU. Acceptable values are: - \"`A`\" - \"`A+`\" - \"`A++`\" - \"`A+++`\" - \"`B`\" - \"`C`\" - \"`D`\" - \"`E`\" - \"`F`\" - \"`G`\" "
+ },
+ "energyEfficiencyClass": {
+ "description": "The energy efficiency class as defined in EU directive 2010/30/EU. Acceptable values are: - \"`A`\" - \"`A+`\" - \"`A++`\" - \"`A+++`\" - \"`B`\" - \"`C`\" - \"`D`\" - \"`E`\" - \"`F`\" - \"`G`\" ",
+ "type": "string"
+ },
+ "material": {
+ "description": "The material of which the item is made.",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#product`\"",
+ "type": "string"
+ },
+ "shippingWidth": {
+ "$ref": "ProductShippingDimension",
+ "description": "Width of the item for shipping."
+ },
+ "sizes": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array",
+ "description": "Size of the item. Only one value is allowed. For variants with different sizes, insert a separate product for each size with the same `itemGroupId` value (see size definition)."
+ },
+ "customGroups": {
+ "items": {
+ "$ref": "CustomGroup"
+ },
+ "description": "A list of custom (merchant-provided) custom attribute groups.",
+ "type": "array"
+ },
+ "source": {
+ "description": "The source of the offer, i.e., how the offer was created. Acceptable values are: - \"`api`\" - \"`crawl`\" - \"`feed`\" ",
+ "type": "string"
+ },
+ "installment": {
+ "description": "Number and amount of installments to pay for an item.",
+ "$ref": "Installment"
+ },
+ "condition": {
+ "description": "Condition or state of the item. Acceptable values are: - \"`local`\" - \"`online`\" ",
+ "type": "string"
+ },
+ "shippingHeight": {
+ "$ref": "ProductShippingDimension",
+ "description": "Height of the item for shipping."
+ },
+ "displayAdsLink": {
+ "description": "URL directly to your item's landing page for dynamic remarketing campaigns.",
+ "type": "string"
+ },
+ "displayAdsValue": {
+ "description": "Offer margin for dynamic remarketing campaigns.",
+ "format": "double",
+ "type": "number"
+ },
+ "contentLanguage": {
+ "type": "string",
+ "description": "Required. The two-letter ISO 639-1 language code for the item."
+ },
+ "taxes": {
+ "items": {
+ "$ref": "ProductTax"
+ },
+ "type": "array",
+ "description": "Tax information."
+ },
+ "displayAdsTitle": {
+ "description": "Title of an item for dynamic remarketing campaigns.",
+ "type": "string"
+ },
+ "expirationDate": {
+ "type": "string",
+ "description": "Date on which the item should expire, as specified upon insertion, in ISO 8601 format. The actual expiration date in Google Shopping is exposed in `productstatuses` as `googleExpirationDate` and might be earlier if `expirationDate` is too far in the future."
+ },
+ "customLabel2": {
+ "type": "string",
+ "description": "Custom label 2 for custom grouping of items in a Shopping campaign."
+ },
+ "minHandlingTime": {
+ "description": "Minimal product handling time (in business days).",
+ "format": "int64",
+ "type": "string"
+ },
+ "sellOnGoogleQuantity": {
+ "format": "int64",
+ "description": "The quantity of the product that is available for selling on Google. Supported only for online products.",
+ "type": "string"
+ },
+ "adwordsLabels": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array",
+ "description": "Similar to adwords_grouping, but only works on CPC."
+ },
+ "mobileLink": {
+ "type": "string",
+ "description": "URL for the mobile-optimized version of your item's landing page."
+ },
+ "customAttributes": {
+ "items": {
+ "$ref": "CustomAttribute"
+ },
+ "type": "array",
+ "description": "A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the feed specification in its generic form (e.g., `{ \"name\": \"size type\", \"value\": \"regular\" }`). This is useful for submitting attributes not explicitly exposed by the API, such as additional attributes used for Buy on Google (formerly known as Shopping Actions)."
+ },
+ "unitPricingBaseMeasure": {
+ "description": "The preference of the denominator of the unit price.",
+ "$ref": "ProductUnitPricingBaseMeasure"
+ },
+ "customLabel3": {
+ "description": "Custom label 3 for custom grouping of items in a Shopping campaign.",
+ "type": "string"
+ },
+ "availabilityDate": {
+ "type": "string",
+ "description": "The day a pre-ordered product becomes available for delivery, in ISO 8601 format."
+ },
+ "shipping": {
+ "items": {
+ "$ref": "ProductShipping"
+ },
+ "description": "Shipping rules.",
+ "type": "array"
+ },
+ "isBundle": {
+ "type": "boolean",
+ "description": "Whether the item is a merchant-defined bundle. A bundle is a custom grouping of different products sold by a merchant for a single price."
+ },
+ "salePriceEffectiveDate": {
+ "type": "string",
+ "description": "Date range during which the item is on sale (see products data specification )."
+ },
+ "itemGroupId": {
+ "type": "string",
+ "description": "Shared identifier for all variants of the same product."
+ },
+ "brand": {
+ "description": "Brand of the item.",
+ "type": "string"
+ },
+ "customLabel1": {
+ "description": "Custom label 1 for custom grouping of items in a Shopping campaign.",
+ "type": "string"
+ },
+ "imageLink": {
+ "description": "URL of an image of the item.",
+ "type": "string"
+ },
+ "color": {
+ "description": "Color of the item.",
+ "type": "string"
+ },
+ "validatedDestinations": {
+ "items": {
+ "type": "string"
+ },
+ "description": "Deprecated. The read-only list of intended destinations which passed validation.",
+ "type": "array"
+ },
+ "pattern": {
+ "type": "string",
+ "description": "The item's pattern (e.g. polka dots)."
+ },
+ "productType": {
+ "type": "string",
+ "description": "Your category of the item (formatted as in products data specification)."
+ },
+ "description": {
+ "description": "Description of the item.",
+ "type": "string"
+ },
+ "additionalImageLinks": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array",
+ "description": "Additional URLs of images of the item."
+ },
+ "googleProductCategory": {
+ "description": "Google's category of the item (see Google product taxonomy).",
+ "type": "string"
+ },
+ "offerId": {
+ "description": "Required. A unique identifier for the item. Leading and trailing whitespaces are stripped and multiple whitespaces are replaced by a single whitespace upon submission. Only valid unicode characters are accepted. See the products feed specification for details. *Note:* Content API methods that operate on products take the REST ID of the product, *not* this identifier.",
+ "type": "string"
+ },
+ "multipack": {
+ "description": "The number of identical products in a merchant-defined multipack.",
+ "type": "string",
+ "format": "int64"
+ },
+ "adult": {
+ "type": "boolean",
+ "description": "Should be set to true if the item is targeted towards adults."
+ },
+ "shippingWeight": {
+ "$ref": "ProductShippingWeight",
+ "description": "Weight of the item for shipping."
+ },
+ "link": {
+ "type": "string",
+ "description": "URL directly linking to your item's page on your website."
+ },
+ "gtin": {
+ "description": "Global Trade Item Number (GTIN) of the item.",
+ "type": "string"
+ },
+ "channel": {
+ "type": "string",
+ "description": "Required. The item's channel (online or local). Acceptable values are: - \"`local`\" - \"`online`\" "
+ },
+ "canonicalLink": {
+ "description": "URL for the canonical version of your item's landing page.",
+ "type": "string"
+ },
+ "unitPricingMeasure": {
+ "$ref": "ProductUnitPricingMeasure",
+ "description": "The measure and dimension of an item."
+ },
+ "displayAdsSimilarIds": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "Advertiser-specified recommendations."
+ },
+ "availability": {
+ "description": "Availability status of the item. Acceptable values are: - \"`in stock`\" - \"`out of stock`\" - \"`preorder`\" ",
+ "type": "string"
+ },
+ "salePrice": {
+ "$ref": "Price",
+ "description": "Advertised sale price of the item."
+ },
+ "loyaltyPoints": {
+ "description": "Loyalty points that users receive after purchasing the item. Japan only.",
+ "$ref": "LoyaltyPoints"
+ },
+ "ageGroup": {
+ "type": "string",
+ "description": "Target age group of the item. Acceptable values are: - \"`adult`\" - \"`infant`\" - \"`kids`\" - \"`newborn`\" - \"`toddler`\" - \"`youngAdult`\" "
+ },
+ "shippingLength": {
+ "$ref": "ProductShippingDimension",
+ "description": "Length of the item for shipping."
+ },
+ "additionalProductTypes": {
+ "description": "Additional categories of the item (formatted as in products data specification).",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "identifierExists": {
+ "description": "False when the item does not have unique product identifiers appropriate to its category, such as GTIN, MPN, and brand. Required according to the Unique Product Identifier Rules for all target countries except for Canada.",
+ "type": "boolean"
+ },
+ "onlineOnly": {
+ "type": "boolean",
+ "description": "Deprecated."
+ },
+ "adwordsRedirect": {
+ "type": "string",
+ "description": "Allows advertisers to override the item URL when the product is shown within the context of Product Ads."
+ },
+ "price": {
+ "$ref": "Price",
+ "description": "Price of the item."
+ },
+ "customLabel0": {
+ "description": "Custom label 0 for custom grouping of items in a Shopping campaign.",
+ "type": "string"
+ },
+ "targetCountry": {
+ "type": "string",
+ "description": "Required. The CLDR territory code for the item."
+ },
+ "mpn": {
+ "description": "Manufacturer Part Number (MPN) of the item.",
+ "type": "string"
+ },
+ "sizeSystem": {
+ "type": "string",
+ "description": "System in which the size is specified. Recommended for apparel items. Acceptable values are: - \"`AU`\" - \"`BR`\" - \"`CN`\" - \"`DE`\" - \"`EU`\" - \"`FR`\" - \"`IT`\" - \"`JP`\" - \"`MEX`\" - \"`UK`\" - \"`US`\" "
+ },
+ "destinations": {
+ "type": "array",
+ "items": {
+ "$ref": "ProductDestination"
+ },
+ "description": "Specifies the intended destinations for the product."
+ },
+ "shippingLabel": {
+ "description": "The shipping label of the product, used to group product in account-level shipping rules.",
+ "type": "string"
+ },
+ "adwordsGrouping": {
+ "type": "string",
+ "description": "Used to group items in an arbitrary way. Only for CPA%, discouraged otherwise."
+ }
+ },
+ "id": "Product",
+ "description": " Required product attributes are primarily defined by the products data specification. See the Products Data Specification Help Center article for information. Some attributes are country-specific, so make sure you select the appropriate country in the drop-down selector at the top of the page. Product data. After inserting, updating, or deleting a product, it may take several minutes before changes take effect."
+ },
+ "DatafeedstatusesListResponse": {
+ "id": "DatafeedstatusesListResponse",
+ "type": "object",
+ "properties": {
+ "resources": {
+ "type": "array",
+ "items": {
+ "$ref": "DatafeedStatus"
+ }
+ },
+ "nextPageToken": {
+ "description": "The token for the retrieval of the next page of datafeed statuses.",
+ "type": "string"
+ },
+ "kind": {
+ "type": "string",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#datafeedstatusesListResponse\"."
+ }
+ }
+ },
+ "OrdersCustomBatchResponseEntry": {
+ "id": "OrdersCustomBatchResponseEntry",
+ "type": "object",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#ordersCustomBatchResponseEntry`\"",
+ "type": "string"
+ },
+ "batchId": {
+ "type": "integer",
+ "format": "uint32",
+ "description": "The ID of the request entry this entry responds to."
+ },
+ "errors": {
+ "description": "A list of errors defined if and only if the request failed.",
+ "$ref": "Errors"
+ },
+ "order": {
+ "description": "The retrieved order. Only defined if the method is `get` and if the request was successful.",
+ "$ref": "Order"
+ },
+ "executionStatus": {
+ "description": "The status of the execution. Only defined if 1. the request was successful; and 2. the method is not `get`, `getByMerchantOrderId`, or one of the test methods. Acceptable values are: - \"`duplicate`\" - \"`executed`\" ",
+ "type": "string"
+ }
+ }
+ },
+ "PosDataProviders": {
+ "id": "PosDataProviders",
+ "properties": {
+ "posDataProviders": {
+ "type": "array",
+ "description": "A list of POS data providers.",
+ "items": {
+ "$ref": "PosDataProvidersPosDataProvider"
+ }
+ },
+ "country": {
+ "type": "string",
+ "description": "Country code."
+ }
+ },
+ "type": "object"
+ },
+ "OrderAddress": {
+ "type": "object",
+ "id": "OrderAddress",
+ "properties": {
+ "fullAddress": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array",
+ "description": "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 "
+ },
+ "streetAddress": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array",
+ "description": "Street-level part of the address."
+ },
+ "postalCode": {
+ "description": "Postal Code or ZIP (e.g. \"94043\").",
+ "type": "string"
+ },
+ "country": {
+ "type": "string",
+ "description": "CLDR country code (e.g. \"US\")."
+ },
+ "region": {
+ "type": "string",
+ "description": "Top-level administrative subdivision of the country. For example, a state like California (\"CA\") or a province like Quebec (\"QC\")."
+ },
+ "recipientName": {
+ "type": "string",
+ "description": "Name of the recipient."
+ },
+ "locality": {
+ "type": "string",
+ "description": "City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs)."
+ },
+ "isPostOfficeBox": {
+ "type": "boolean",
+ "description": "Whether the address is a post office box."
+ }
+ }
+ },
+ "PosStore": {
+ "description": "Store resource.",
+ "id": "PosStore",
+ "type": "object",
+ "properties": {
+ "kind": {
+ "type": "string",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#posStore`\""
+ },
+ "storeCode": {
+ "description": "Required. A store identifier that is unique for the given merchant.",
+ "type": "string"
+ },
+ "storeAddress": {
+ "description": "Required. The street address of the store.",
+ "type": "string"
+ }
+ }
+ },
+ "OrderCancellation": {
+ "type": "object",
+ "id": "OrderCancellation",
+ "properties": {
+ "quantity": {
+ "format": "uint32",
+ "description": "The quantity that was canceled.",
+ "type": "integer"
+ },
+ "reasonText": {
+ "type": "string",
+ "description": "The explanation of the reason."
+ },
+ "actor": {
+ "type": "string",
+ "description": "The actor that created the cancellation. Acceptable values are: - \"`customer`\" - \"`googleBot`\" - \"`googleCustomerService`\" - \"`googlePayments`\" - \"`googleSabre`\" - \"`merchant`\" "
+ },
+ "creationDate": {
+ "description": "Date on which the cancellation has been created, in ISO 8601 format.",
+ "type": "string"
+ },
+ "reason": {
+ "description": "The reason for the cancellation. Orders that are canceled with a noInventory reason will lead to the removal of the product from Buy on Google until you make an update to that product. This will not affect your Shopping ads. Acceptable values are: - \"`autoPostInternal`\" - \"`autoPostInvalidBillingAddress`\" - \"`autoPostNoInventory`\" - \"`autoPostPriceError`\" - \"`autoPostUndeliverableShippingAddress`\" - \"`couponAbuse`\" - \"`customerCanceled`\" - \"`customerInitiatedCancel`\" - \"`customerSupportRequested`\" - \"`failToPushOrderGoogleError`\" - \"`failToPushOrderMerchantError`\" - \"`failToPushOrderMerchantFulfillmentError`\" - \"`failToPushOrderToMerchant`\" - \"`failToPushOrderToMerchantOutOfStock`\" - \"`invalidCoupon`\" - \"`malformedShippingAddress`\" - \"`merchantDidNotShipOnTime`\" - \"`noInventory`\" - \"`orderTimeout`\" - \"`other`\" - \"`paymentAbuse`\" - \"`paymentDeclined`\" - \"`priceError`\" - \"`returnRefundAbuse`\" - \"`shippingPriceError`\" - \"`taxError`\" - \"`undeliverableShippingAddress`\" - \"`unsupportedPoBoxAddress`\" ",
+ "type": "string"
+ }
+ }
+ },
+ "AccountStatus": {
+ "properties": {
+ "dataQualityIssues": {
+ "type": "array",
+ "description": "DEPRECATED - never populated.",
+ "items": {
+ "$ref": "AccountStatusDataQualityIssue"
+ }
+ },
+ "accountId": {
+ "type": "string",
+ "description": "The ID of the account for which the status is reported."
+ },
+ "kind": {
+ "type": "string",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#accountStatus`\""
+ },
+ "products": {
+ "type": "array",
+ "description": "List of product-related data by channel, destination, and country. Data in this field may be delayed by up to 30 minutes.",
+ "items": {
+ "$ref": "AccountStatusProducts"
+ }
+ },
+ "accountLevelIssues": {
+ "items": {
+ "$ref": "AccountStatusAccountLevelIssue"
+ },
+ "type": "array",
+ "description": "A list of account level issues."
+ },
+ "websiteClaimed": {
+ "description": "Whether the account's website is claimed or not.",
+ "type": "boolean"
+ }
+ },
+ "description": "The status of an account, i.e., information about its products, which is computed offline and not returned immediately at insertion time.",
+ "type": "object",
+ "id": "AccountStatus"
+ },
+ "DatafeedstatusesCustomBatchResponse": {
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#datafeedstatusesCustomBatchResponse\".",
+ "type": "string"
+ },
+ "entries": {
+ "items": {
+ "$ref": "DatafeedstatusesCustomBatchResponseEntry"
+ },
+ "description": "The result of the execution of the batch requests.",
+ "type": "array"
+ }
+ },
+ "id": "DatafeedstatusesCustomBatchResponse",
+ "type": "object"
+ },
+ "ShipmentInvoice": {
+ "id": "ShipmentInvoice",
+ "properties": {
+ "invoiceSummary": {
+ "$ref": "InvoiceSummary",
+ "description": "[required] Invoice summary."
+ },
+ "lineItemInvoices": {
+ "description": "[required] Invoice details per line item.",
+ "type": "array",
+ "items": {
+ "$ref": "ShipmentInvoiceLineItemInvoice"
+ }
+ },
+ "shipmentGroupId": {
+ "description": "[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.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "RefundReason": {
+ "properties": {
+ "reasonCode": {
+ "description": "Code of the refund reason. Acceptable values are: - \"`adjustment`\" - \"`autoPostInternal`\" - \"`autoPostInvalidBillingAddress`\" - \"`autoPostNoInventory`\" - \"`autoPostPriceError`\" - \"`autoPostUndeliverableShippingAddress`\" - \"`couponAbuse`\" - \"`courtesyAdjustment`\" - \"`customerCanceled`\" - \"`customerDiscretionaryReturn`\" - \"`customerInitiatedMerchantCancel`\" - \"`customerSupportRequested`\" - \"`deliveredLateByCarrier`\" - \"`deliveredTooLate`\" - \"`expiredItem`\" - \"`failToPushOrderGoogleError`\" - \"`failToPushOrderMerchantError`\" - \"`failToPushOrderMerchantFulfillmentError`\" - \"`failToPushOrderToMerchant`\" - \"`failToPushOrderToMerchantOutOfStock`\" - \"`feeAdjustment`\" - \"`invalidCoupon`\" - \"`lateShipmentCredit`\" - \"`malformedShippingAddress`\" - \"`merchantDidNotShipOnTime`\" - \"`noInventory`\" - \"`orderTimeout`\" - \"`other`\" - \"`paymentAbuse`\" - \"`paymentDeclined`\" - \"`priceAdjustment`\" - \"`priceError`\" - \"`productArrivedDamaged`\" - \"`productNotAsDescribed`\" - \"`promoReallocation`\" - \"`qualityNotAsExpected`\" - \"`returnRefundAbuse`\" - \"`shippingCostAdjustment`\" - \"`shippingPriceError`\" - \"`taxAdjustment`\" - \"`taxError`\" - \"`undeliverableShippingAddress`\" - \"`unsupportedPoBoxAddress`\" - \"`wrongProductShipped`\" ",
+ "type": "string"
+ },
+ "description": {
+ "type": "string",
+ "description": "Description of the reason."
+ }
+ },
+ "id": "RefundReason",
+ "type": "object"
+ },
+ "OrderReportTransaction": {
+ "type": "object",
+ "id": "OrderReportTransaction",
+ "properties": {
+ "productAmount": {
+ "$ref": "Amount",
+ "description": "Total amount for the items."
+ },
+ "disbursementDate": {
+ "type": "string",
+ "description": "The date the disbursement was initiated, in ISO 8601 format."
+ },
+ "merchantId": {
+ "type": "string",
+ "format": "uint64",
+ "description": "The ID of the managing account."
+ },
+ "disbursementCreationDate": {
+ "description": "The date the disbursement was created, in ISO 8601 format.",
+ "type": "string"
+ },
+ "disbursementId": {
+ "description": "The ID of the disbursement.",
+ "type": "string"
+ },
+ "productAmountWithRemittedTax": {
+ "$ref": "ProductAmount",
+ "description": "Total amount with remitted tax for the items."
+ },
+ "transactionDate": {
+ "type": "string",
+ "description": "The date of the transaction, in ISO 8601 format."
+ },
+ "disbursementAmount": {
+ "description": "The disbursement amount.",
+ "$ref": "Price"
+ },
+ "merchantOrderId": {
+ "type": "string",
+ "description": "Merchant-provided ID of the order."
+ },
+ "orderId": {
+ "type": "string",
+ "description": "The ID of the order."
+ }
+ }
+ },
+ "LiaOnDisplayToOrderSettings": {
+ "type": "object",
+ "properties": {
+ "shippingCostPolicyUrl": {
+ "description": "Shipping cost and policy URL.",
+ "type": "string"
+ },
+ "status": {
+ "type": "string",
+ "description": "The status of the ?On display to order? feature. Acceptable values are: - \"`active`\" - \"`inactive`\" - \"`pending`\" "
+ }
+ },
+ "id": "LiaOnDisplayToOrderSettings"
+ },
+ "OrderLineItem": {
+ "id": "OrderLineItem",
+ "type": "object",
+ "properties": {
+ "quantityOrdered": {
+ "format": "uint32",
+ "description": "Number of items ordered.",
+ "type": "integer"
+ },
+ "quantityReturned": {
+ "format": "uint32",
+ "type": "integer",
+ "description": "Number of items returned."
+ },
+ "quantityReadyForPickup": {
+ "format": "uint32",
+ "description": "Number of items ready for pickup.",
+ "type": "integer"
+ },
+ "quantityShipped": {
+ "type": "integer",
+ "format": "uint32",
+ "description": "Number of items shipped."
+ },
+ "returns": {
+ "description": "Returns of the line item.",
+ "type": "array",
+ "items": {
+ "$ref": "OrderReturn"
+ }
+ },
+ "product": {
+ "description": "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.",
+ "$ref": "OrderLineItemProduct"
+ },
+ "quantityPending": {
+ "format": "uint32",
+ "type": "integer",
+ "description": "Number of items pending."
+ },
+ "shippingDetails": {
+ "description": "Details of the requested shipping for the line item.",
+ "$ref": "OrderLineItemShippingDetails"
+ },
+ "price": {
+ "$ref": "Price",
+ "description": "Total price for the line item. For example, if two items for $10 are purchased, the total price will be $20."
+ },
+ "quantityCanceled": {
+ "description": "Number of items canceled.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "annotations": {
+ "items": {
+ "$ref": "OrderMerchantProvidedAnnotation"
+ },
+ "type": "array",
+ "description": "Annotations that are attached to the line item."
+ },
+ "cancellations": {
+ "description": "Cancellations of the line item.",
+ "type": "array",
+ "items": {
+ "$ref": "OrderCancellation"
+ }
+ },
+ "tax": {
+ "$ref": "Price",
+ "description": "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."
+ },
+ "id": {
+ "description": "The ID of the line item.",
+ "type": "string"
+ },
+ "quantityDelivered": {
+ "type": "integer",
+ "format": "uint32",
+ "description": "Number of items delivered."
+ },
+ "returnInfo": {
+ "description": "Details of the return policy for the line item.",
+ "$ref": "OrderLineItemReturnInfo"
+ }
+ }
+ },
+ "TransitTableTransitTimeRowTransitTimeValue": {
+ "properties": {
+ "maxTransitTimeInDays": {
+ "format": "uint32",
+ "type": "integer",
+ "description": "Must be greater than or equal to `minTransitTimeInDays`."
+ },
+ "minTransitTimeInDays": {
+ "format": "uint32",
+ "type": "integer",
+ "description": "Transit time range (min-max) in business days. 0 means same day delivery, 1 means next day delivery."
+ }
+ },
+ "type": "object",
+ "id": "TransitTableTransitTimeRowTransitTimeValue"
+ },
+ "Table": {
+ "id": "Table",
+ "type": "object",
+ "properties": {
+ "rows": {
+ "description": "The list of rows that constitute the table. Must have the same length as `rowHeaders`. Required.",
+ "type": "array",
+ "items": {
+ "$ref": "Row"
+ }
+ },
+ "rowHeaders": {
+ "description": "Headers of the table's rows. Required.",
+ "$ref": "Headers"
+ },
+ "columnHeaders": {
+ "description": "Headers of the table's columns. Optional: if not set then the table has only one dimension.",
+ "$ref": "Headers"
+ },
+ "name": {
+ "description": "Name of the table. Required for subtables, ignored for the main table.",
+ "type": "string"
+ }
+ }
+ },
+ "Service": {
+ "id": "Service",
+ "type": "object",
+ "properties": {
+ "rateGroups": {
+ "items": {
+ "$ref": "RateGroup"
+ },
+ "description": "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.",
+ "type": "array"
+ },
+ "pickupService": {
+ "$ref": "PickupCarrierService",
+ "description": "The carrier-service pair delivering items to collection points. The list of supported pickup services can be retrieved via the `getSupportedPickupServices` method. Required if and only if the service delivery type is `pickup`."
+ },
+ "active": {
+ "description": "A boolean exposing the active status of the shipping service. Required.",
+ "type": "boolean"
+ },
+ "minimumOrderValue": {
+ "description": "Minimum order value for this service. If set, indicates that customers will have to spend at least this amount. All prices within a service must have the same currency. Cannot be set together with minimum_order_value_table.",
+ "$ref": "Price"
+ },
+ "shipmentType": {
+ "type": "string",
+ "description": "Type of locations this service ships orders to. Acceptable values are: - \"`delivery`\" - \"`pickup`\" "
+ },
+ "name": {
+ "description": "Free-form name of the service. Must be unique within target account. Required.",
+ "type": "string"
+ },
+ "deliveryTime": {
+ "$ref": "DeliveryTime",
+ "description": "Time spent in various aspects from order to the delivery of the product. Required."
+ },
+ "currency": {
+ "type": "string",
+ "description": "The CLDR code of the currency to which this service applies. Must match that of the prices in rate groups."
+ },
+ "eligibility": {
+ "description": "Eligibility for this service. Acceptable values are: - \"`All scenarios`\" - \"`All scenarios except Shopping Actions`\" - \"`Shopping Actions`\" ",
+ "type": "string"
+ },
+ "minimumOrderValueTable": {
+ "description": "Table of per store minimum order values for the pickup fulfillment type. Cannot be set together with minimum_order_value.",
+ "$ref": "MinimumOrderValueTable"
+ },
+ "deliveryCountry": {
+ "type": "string",
+ "description": "The CLDR territory code of the country to which the service applies. Required."
+ }
+ }
+ },
+ "BusinessDayConfig": {
+ "type": "object",
+ "id": "BusinessDayConfig",
+ "properties": {
+ "businessDays": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array",
+ "description": "Regular business days. May not be empty."
+ }
+ }
+ },
+ "OrdersCustomBatchRequestEntryShipLineItems": {
+ "id": "OrdersCustomBatchRequestEntryShipLineItems",
+ "properties": {
+ "lineItems": {
+ "items": {
+ "$ref": "OrderShipmentLineItemShipment"
+ },
+ "description": "Line items to ship.",
+ "type": "array"
+ },
+ "shipmentGroupId": {
+ "type": "string",
+ "description": "ID of the shipment group. Required for orders that use the orderinvoices service."
+ },
+ "carrier": {
+ "type": "string",
+ "description": "Deprecated. Please use shipmentInfo instead. The carrier handling the shipment. See `shipments[].carrier` in the Orders resource representation for a list of acceptable values."
+ },
+ "trackingId": {
+ "description": "Deprecated. Please use shipmentInfo instead. The tracking ID for the shipment.",
+ "type": "string"
+ },
+ "shipmentInfos": {
+ "description": "Shipment information. This field is repeated because a single line item can be shipped in several packages (and have several tracking IDs).",
+ "items": {
+ "$ref": "OrdersCustomBatchRequestEntryShipLineItemsShipmentInfo"
+ },
+ "type": "array"
+ },
+ "shipmentId": {
+ "type": "string",
+ "description": "Deprecated. Please use shipmentInfo instead. The ID of the shipment."
+ }
+ },
+ "type": "object"
+ },
+ "OrdersReturnLineItemRequest": {
+ "type": "object",
+ "properties": {
+ "quantity": {
+ "type": "integer",
+ "format": "uint32",
+ "description": "The quantity to return."
+ },
+ "lineItemId": {
+ "description": "The ID of the line item to return. Either lineItemId or productId is required.",
+ "type": "string"
+ },
+ "productId": {
+ "type": "string",
+ "description": "The ID of the product to return. This is the REST ID used in the products service. Either lineItemId or productId is required."
+ },
+ "reasonText": {
+ "type": "string",
+ "description": "The explanation of the reason."
+ },
+ "operationId": {
+ "type": "string",
+ "description": "The ID of the operation. Unique across all operations for a given order."
+ },
+ "reason": {
+ "type": "string",
+ "description": "The reason for the return. Acceptable values are: - \"`customerDiscretionaryReturn`\" - \"`customerInitiatedMerchantCancel`\" - \"`deliveredTooLate`\" - \"`expiredItem`\" - \"`invalidCoupon`\" - \"`malformedShippingAddress`\" - \"`other`\" - \"`productArrivedDamaged`\" - \"`productNotAsDescribed`\" - \"`qualityNotAsExpected`\" - \"`undeliverableShippingAddress`\" - \"`unsupportedPoBoxAddress`\" - \"`wrongProductShipped`\" "
+ }
+ },
+ "id": "OrdersReturnLineItemRequest"
+ },
+ "OrdersCancelTestOrderByCustomerRequest": {
+ "id": "OrdersCancelTestOrderByCustomerRequest",
+ "type": "object",
+ "properties": {
+ "reason": {
+ "type": "string",
+ "description": "The reason for the cancellation. Acceptable values are: - \"`changedMind`\" - \"`orderedWrongItem`\" - \"`other`\" "
+ }
+ }
+ },
+ "ProductStatusDestinationStatus": {
+ "type": "object",
+ "id": "ProductStatusDestinationStatus",
+ "properties": {
+ "intention": {
+ "description": "Provided for backward compatibility only. Always set to \"required\". Acceptable values are: - \"`default`\" - \"`excluded`\" - \"`optional`\" - \"`required`\" ",
+ "type": "string"
+ },
+ "approvalPending": {
+ "description": "Whether the approval status might change due to further processing.",
+ "type": "boolean"
+ },
+ "approvalStatus": {
+ "type": "string",
+ "description": "The destination's approval status. Acceptable values are: - \"`approved`\" - \"`disapproved`\" "
+ },
+ "destination": {
+ "description": "The name of the destination",
+ "type": "string"
+ }
+ }
+ },
+ "OrdersCreateTestOrderResponse": {
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersCreateTestOrderResponse\".",
+ "type": "string"
+ },
+ "orderId": {
+ "type": "string",
+ "description": "The ID of the newly created test order."
+ }
+ },
+ "id": "OrdersCreateTestOrderResponse",
+ "type": "object"
+ },
+ "OrderreportsListDisbursementsResponse": {
+ "properties": {
+ "nextPageToken": {
+ "description": "The token for the retrieval of the next page of disbursements.",
+ "type": "string"
+ },
+ "disbursements": {
+ "type": "array",
+ "description": "The list of disbursements.",
+ "items": {
+ "$ref": "OrderReportDisbursement"
+ }
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#orderreportsListDisbursementsResponse\".",
+ "type": "string"
+ }
+ },
+ "type": "object",
+ "id": "OrderreportsListDisbursementsResponse"
+ },
+ "OrderRefund": {
+ "properties": {
+ "actor": {
+ "description": "The actor that created the refund. Acceptable values are: - \"`customer`\" - \"`googleBot`\" - \"`googleCustomerService`\" - \"`googlePayments`\" - \"`googleSabre`\" - \"`merchant`\" ",
+ "type": "string"
+ },
+ "creationDate": {
+ "description": "Date on which the item has been created, in ISO 8601 format.",
+ "type": "string"
+ },
+ "reasonText": {
+ "type": "string",
+ "description": "The explanation of the reason."
+ },
+ "amount": {
+ "description": "The amount that is refunded.",
+ "$ref": "Price"
+ },
+ "reason": {
+ "description": "The reason for the refund. Acceptable values are: - \"`adjustment`\" - \"`autoPostInternal`\" - \"`autoPostInvalidBillingAddress`\" - \"`autoPostNoInventory`\" - \"`autoPostPriceError`\" - \"`autoPostUndeliverableShippingAddress`\" - \"`couponAbuse`\" - \"`courtesyAdjustment`\" - \"`customerCanceled`\" - \"`customerDiscretionaryReturn`\" - \"`customerInitiatedMerchantCancel`\" - \"`customerSupportRequested`\" - \"`deliveredLateByCarrier`\" - \"`deliveredTooLate`\" - \"`expiredItem`\" - \"`failToPushOrderGoogleError`\" - \"`failToPushOrderMerchantError`\" - \"`failToPushOrderMerchantFulfillmentError`\" - \"`failToPushOrderToMerchant`\" - \"`failToPushOrderToMerchantOutOfStock`\" - \"`feeAdjustment`\" - \"`invalidCoupon`\" - \"`lateShipmentCredit`\" - \"`malformedShippingAddress`\" - \"`merchantDidNotShipOnTime`\" - \"`noInventory`\" - \"`orderTimeout`\" - \"`other`\" - \"`paymentAbuse`\" - \"`paymentDeclined`\" - \"`priceAdjustment`\" - \"`priceError`\" - \"`productArrivedDamaged`\" - \"`productNotAsDescribed`\" - \"`promoReallocation`\" - \"`qualityNotAsExpected`\" - \"`returnRefundAbuse`\" - \"`shippingCostAdjustment`\" - \"`shippingPriceError`\" - \"`taxAdjustment`\" - \"`taxError`\" - \"`undeliverableShippingAddress`\" - \"`unsupportedPoBoxAddress`\" - \"`wrongProductShipped`\" ",
+ "type": "string"
+ }
+ },
+ "type": "object",
+ "id": "OrderRefund"
+ },
+ "OrdersAcknowledgeResponse": {
+ "id": "OrdersAcknowledgeResponse",
+ "properties": {
+ "executionStatus": {
+ "type": "string",
+ "description": "The status of the execution. Acceptable values are: - \"`duplicate`\" - \"`executed`\" "
+ },
+ "kind": {
+ "type": "string",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersAcknowledgeResponse\"."
+ }
+ },
+ "type": "object"
+ },
+ "GmbAccountsGmbAccount": {
+ "properties": {
+ "listingCount": {
+ "type": "string",
+ "format": "uint64",
+ "description": "Number of listings under this account."
+ },
+ "type": {
+ "type": "string",
+ "description": "The type of the GMB account (User or Business)."
+ },
+ "email": {
+ "type": "string",
+ "description": "The email which identifies the GMB account."
+ },
+ "name": {
+ "description": "The name of the GMB account.",
+ "type": "string"
+ }
+ },
+ "id": "GmbAccountsGmbAccount",
+ "type": "object"
+ },
+ "AccountBusinessInformation": {
+ "properties": {
+ "address": {
+ "description": "The address of the business.",
+ "$ref": "AccountAddress"
+ },
+ "phoneNumber": {
+ "description": "The phone number of the business.",
+ "type": "string"
+ },
+ "customerService": {
+ "description": "The customer service information of the business.",
+ "$ref": "AccountCustomerService"
+ }
+ },
+ "type": "object",
+ "id": "AccountBusinessInformation"
+ },
+ "OrderLineItemShippingDetails": {
+ "properties": {
+ "shipByDate": {
+ "description": "Required. The ship by date, in ISO 8601 format.",
+ "type": "string"
+ },
+ "method": {
+ "$ref": "OrderLineItemShippingDetailsMethod",
+ "description": "Required. Details of the shipping method."
+ },
+ "type": {
+ "type": "string",
+ "description": "Type of shipment. Indicates whether `deliveryDetails` or `pickupDetails` is applicable for this shipment. Acceptable values are: - \"`delivery`\" - \"`pickup`\" "
+ },
+ "deliverByDate": {
+ "description": "Required. The delivery by date, in ISO 8601 format.",
+ "type": "string"
+ }
+ },
+ "type": "object",
+ "id": "OrderLineItemShippingDetails"
+ },
+ "ProductDestination": {
+ "properties": {
+ "destinationName": {
+ "type": "string",
+ "description": "The name of the destination."
+ },
+ "intention": {
+ "description": "Whether the destination is required, excluded or should be validated. Acceptable values are: - \"`default`\" - \"`excluded`\" - \"`optional`\" - \"`required`\" ",
+ "type": "string"
+ }
+ },
+ "type": "object",
+ "id": "ProductDestination"
+ },
+ "ProductstatusesCustomBatchResponseEntry": {
+ "description": "A batch entry encoding a single non-batch productstatuses response.",
+ "type": "object",
+ "properties": {
+ "errors": {
+ "$ref": "Errors",
+ "description": "A list of errors, if the request failed."
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#productstatusesCustomBatchResponseEntry`\"",
+ "type": "string"
+ },
+ "batchId": {
+ "description": "The ID of the request entry this entry responds to.",
+ "type": "integer",
+ "format": "uint32"
+ },
+ "productStatus": {
+ "$ref": "ProductStatus",
+ "description": "The requested product status. Only defined if the request was successful."
+ }
+ },
+ "id": "ProductstatusesCustomBatchResponseEntry"
+ },
+ "LiaAboutPageSettings": {
+ "properties": {
+ "status": {
+ "type": "string",
+ "description": "The status of the verification process for the About page. Acceptable values are: - \"`active`\" - \"`inactive`\" - \"`pending`\" "
+ },
+ "url": {
+ "description": "The URL for the About page.",
+ "type": "string"
+ }
+ },
+ "type": "object",
+ "id": "LiaAboutPageSettings"
+ },
+ "OrdersSetLineItemMetadataRequest": {
+ "id": "OrdersSetLineItemMetadataRequest",
+ "properties": {
+ "operationId": {
+ "description": "The ID of the operation. Unique across all operations for a given order.",
+ "type": "string"
+ },
+ "productId": {
+ "description": "The ID of the product to set metadata. This is the REST ID used in the products service. Either lineItemId or productId is required.",
+ "type": "string"
+ },
+ "annotations": {
+ "type": "array",
+ "items": {
+ "$ref": "OrderMerchantProvidedAnnotation"
+ }
+ },
+ "lineItemId": {
+ "description": "The ID of the line item to set metadata. Either lineItemId or productId is required.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "LiasettingsSetInventoryVerificationContactResponse": {
+ "properties": {
+ "kind": {
+ "type": "string",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#liasettingsSetInventoryVerificationContactResponse\"."
+ }
+ },
+ "id": "LiasettingsSetInventoryVerificationContactResponse",
+ "type": "object"
+ },
+ "TestOrder": {
+ "properties": {
+ "promotions": {
+ "items": {
+ "$ref": "OrderLegacyPromotion"
+ },
+ "description": "Deprecated. Ignored if provided.",
+ "type": "array"
+ },
+ "enableOrderinvoices": {
+ "type": "boolean",
+ "description": "Whether the orderinvoices service should support this order."
+ },
+ "predefinedPickupDetails": {
+ "type": "string",
+ "description": "Identifier of one of the predefined pickup details. Required for orders containing line items with shipping type `pickup`. Acceptable values are: - \"`dwight`\" - \"`jim`\" - \"`pam`\" "
+ },
+ "customer": {
+ "description": "Required. The details of the customer who placed the order.",
+ "$ref": "TestOrderCustomer"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#testOrder`\"",
+ "type": "string"
+ },
+ "lineItems": {
+ "items": {
+ "$ref": "TestOrderLineItem"
+ },
+ "description": "Required. Line items that are ordered. At least one line item must be provided.",
+ "type": "array"
+ },
+ "predefinedDeliveryAddress": {
+ "type": "string",
+ "description": "Required. Identifier of one of the predefined delivery addresses for the delivery. Acceptable values are: - \"`dwight`\" - \"`jim`\" - \"`pam`\" "
+ },
+ "shippingCostTax": {
+ "$ref": "Price",
+ "description": "Deprecated. Ignored if provided."
+ },
+ "notificationMode": {
+ "type": "string",
+ "description": "Restricted. Do not use."
+ },
+ "shippingCost": {
+ "description": "Required. The price of shipping for all items. Shipping tax is automatically calculated for orders where marketplace facilitator tax laws are applicable. Otherwise, tax settings from Merchant Center are applied. Note that shipping is not taxed in certain states.",
+ "$ref": "Price"
+ },
+ "paymentMethod": {
+ "$ref": "TestOrderPaymentMethod",
+ "description": "The details of the payment method."
+ },
+ "shippingOption": {
+ "description": "Required. The requested shipping option. Acceptable values are: - \"`economy`\" - \"`expedited`\" - \"`oneDay`\" - \"`sameDay`\" - \"`standard`\" - \"`twoDay`\" ",
+ "type": "string"
+ }
+ },
+ "id": "TestOrder",
+ "type": "object"
+ },
+ "OrdersCustomBatchRequest": {
+ "type": "object",
+ "id": "OrdersCustomBatchRequest",
+ "properties": {
+ "entries": {
+ "items": {
+ "$ref": "OrdersCustomBatchRequestEntry"
+ },
+ "description": "The request entries to be processed in the batch.",
+ "type": "array"
+ }
+ }
+ },
+ "LiaCountrySettings": {
+ "type": "object",
+ "id": "LiaCountrySettings",
+ "properties": {
+ "country": {
+ "description": "Required. CLDR country code (e.g. \"US\").",
+ "type": "string"
+ },
+ "about": {
+ "description": "The settings for the About page.",
+ "$ref": "LiaAboutPageSettings"
+ },
+ "storePickupActive": {
+ "type": "boolean",
+ "description": "The status of the \"Store pickup\" feature."
+ },
+ "hostedLocalStorefrontActive": {
+ "description": "The status of the \"Merchant hosted local storefront\" feature.",
+ "type": "boolean"
+ },
+ "posDataProvider": {
+ "description": "The POS data provider linked with this country.",
+ "$ref": "LiaPosDataProvider"
+ },
+ "onDisplayToOrder": {
+ "$ref": "LiaOnDisplayToOrderSettings",
+ "description": "LIA \"On Display To Order\" settings."
+ },
+ "inventory": {
+ "$ref": "LiaInventorySettings",
+ "description": "LIA inventory verification settings."
+ }
+ }
+ },
+ "ProductsListResponse": {
+ "id": "ProductsListResponse",
+ "properties": {
+ "kind": {
+ "type": "string",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#productsListResponse\"."
+ },
+ "resources": {
+ "items": {
+ "$ref": "Product"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "The token for the retrieval of the next page of products.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "PostalCodeRange": {
+ "type": "object",
+ "id": "PostalCodeRange",
+ "properties": {
+ "postalCodeRangeBegin": {
+ "description": "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.",
+ "type": "string"
+ },
+ "postalCodeRangeEnd": {
+ "type": "string",
+ "description": "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`."
+ }
+ }
+ },
+ "Order": {
+ "type": "object",
+ "description": "Order. Production access (all methods) requires the order manager role. Sandbox access does not.",
+ "properties": {
+ "refunds": {
+ "description": "Refunds for the order.",
+ "items": {
+ "$ref": "OrderRefund"
+ },
+ "type": "array"
+ },
+ "placedDate": {
+ "type": "string",
+ "description": "The date when the order was placed, in ISO 8601 format."
+ },
+ "paymentStatus": {
+ "description": "The status of the payment. Acceptable values are: - \"`paymentCaptured`\" - \"`paymentRejected`\" - \"`paymentSecured`\" - \"`pendingAuthorization`\" ",
+ "type": "string"
+ },
+ "acknowledged": {
+ "description": "Whether the order was acknowledged.",
+ "type": "boolean"
+ },
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#order`\"",
+ "type": "string"
+ },
+ "promotions": {
+ "description": "The details of the merchant provided promotions applied to the order. To determine which promotions apply to which products, check the `Promotions[].Benefits[].OfferIds` field against the `LineItems[].Product.OfferId` field for each promotion. If a promotion is applied to more than 1 `offerId`, divide the discount value by the number of affected offers to determine how much discount to apply to each `offerId`. Examples: 1. To calculate the line item level discount for a single specific item: For each promotion, subtract the `Promotions[].Benefits[].Discount.value` amount from the `LineItems[].Price.value`. 2. To calculate the line item level discount for multiple quantity of a specific item: For each promotion, divide the `Promotions[].Benefits[].Discount.value` by the quantity of products and substract it from `LineItems[].Product.Price.value` for each quantity item. Only 1 promotion can be applied to an offerId in a given order. To refund an item which had a promotion applied to it, make sure to refund the amount after first subtracting the promotion discount from the item price. More details about the program are here.",
+ "items": {
+ "$ref": "OrderLegacyPromotion"
+ },
+ "type": "array"
+ },
+ "pickupDetails": {
+ "description": "Pickup details for shipments of type `pickup`.",
+ "$ref": "OrderPickupDetails"
+ },
+ "paymentMethod": {
+ "description": "The details of the payment method.",
+ "$ref": "OrderPaymentMethod"
+ },
+ "status": {
+ "type": "string",
+ "description": "The status of the order. Acceptable values are: - \"`canceled`\" - \"`delivered`\" - \"`inProgress`\" - \"`partiallyDelivered`\" - \"`partiallyReturned`\" - \"`partiallyShipped`\" - \"`pendingShipment`\" - \"`returned`\" - \"`shipped`\" "
+ },
+ "merchantId": {
+ "type": "string",
+ "format": "uint64"
+ },
+ "customer": {
+ "$ref": "OrderCustomer",
+ "description": "The details of the customer who placed the order."
+ },
+ "id": {
+ "description": "The REST ID of the order. Globally unique.",
+ "type": "string"
+ },
+ "lineItems": {
+ "type": "array",
+ "description": "Line items that are ordered.",
+ "items": {
+ "$ref": "OrderLineItem"
+ }
+ },
+ "deliveryDetails": {
+ "$ref": "OrderDeliveryDetails",
+ "description": "Delivery details for shipments of type `delivery`."
+ },
+ "netAmount": {
+ "description": "The net amount for the order. For example, if an order was originally for a grand total of $100 and a refund was issued for $20, the net amount will be $80.",
+ "$ref": "Price"
+ },
+ "shippingOption": {
+ "type": "string",
+ "description": "Deprecated. Shipping details are provided with line items instead. Acceptable values are: - \"`economy`\" - \"`expedited`\" - \"`oneDay`\" - \"`sameDay`\" - \"`standard`\" - \"`twoDay`\" "
+ },
+ "taxCollector": {
+ "type": "string",
+ "description": "The party responsible for collecting and remitting taxes. Acceptable values are: - \"`marketplaceFacilitator`\" - \"`merchant`\" "
+ },
+ "shipments": {
+ "items": {
+ "$ref": "OrderShipment"
+ },
+ "type": "array",
+ "description": "Shipments of the order."
+ },
+ "shippingCostTax": {
+ "description": "The tax for the total shipping cost.",
+ "$ref": "Price"
+ },
+ "merchantOrderId": {
+ "type": "string",
+ "description": "Merchant-provided ID of the order."
+ },
+ "channelType": {
+ "type": "string",
+ "description": "Deprecated. Acceptable values are: - \"`googleExpress`\" - \"`purchasesOnGoogle`\" "
+ },
+ "shippingCost": {
+ "$ref": "Price",
+ "description": "The total cost of shipping for all items."
+ }
+ },
+ "id": "Order"
+ },
+ "ProductUnitPricingBaseMeasure": {
+ "properties": {
+ "value": {
+ "type": "string",
+ "format": "int64",
+ "description": "The denominator of the unit price."
+ },
+ "unit": {
+ "description": "The unit of the denominator.",
+ "type": "string"
+ }
+ },
+ "type": "object",
+ "id": "ProductUnitPricingBaseMeasure"
+ },
+ "ShippingsettingsGetSupportedCarriersResponse": {
+ "type": "object",
+ "id": "ShippingsettingsGetSupportedCarriersResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#shippingsettingsGetSupportedCarriersResponse\".",
+ "type": "string"
+ },
+ "carriers": {
+ "type": "array",
+ "items": {
+ "$ref": "CarriersCarrier"
+ },
+ "description": "A list of supported carriers. May be empty."
+ }
+ }
+ },
+ "ProductUnitPricingMeasure": {
+ "type": "object",
+ "id": "ProductUnitPricingMeasure",
+ "properties": {
+ "unit": {
+ "description": "The unit of the measure.",
+ "type": "string"
+ },
+ "value": {
+ "description": "The measure of an item.",
+ "type": "number",
+ "format": "double"
+ }
+ }
+ },
+ "DatafeedsListResponse": {
+ "properties": {
+ "kind": {
+ "type": "string",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#datafeedsListResponse\"."
+ },
+ "nextPageToken": {
+ "description": "The token for the retrieval of the next page of datafeeds.",
+ "type": "string"
+ },
+ "resources": {
+ "type": "array",
+ "items": {
+ "$ref": "Datafeed"
+ }
+ }
+ },
+ "type": "object",
+ "id": "DatafeedsListResponse"
+ },
+ "ShippingsettingsListResponse": {
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#shippingsettingsListResponse\".",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "type": "string",
+ "description": "The token for the retrieval of the next page of shipping settings."
+ },
+ "resources": {
+ "items": {
+ "$ref": "ShippingSettings"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object",
+ "id": "ShippingsettingsListResponse"
+ },
+ "AccountAdwordsLink": {
+ "id": "AccountAdwordsLink",
+ "properties": {
+ "adwordsId": {
+ "type": "string",
+ "format": "uint64",
+ "description": "Customer ID of the AdWords account."
+ },
+ "status": {
+ "type": "string",
+ "description": "Status of the link between this Merchant Center account and the AdWords account. Upon retrieval, it represents the actual status of the link and can be either `active` if it was approved in Google AdWords or `pending` if it's pending approval. Upon insertion, it represents the *intended* status of the link. Re-uploading a link with status `active` when it's still pending or with status `pending` when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status `inactive` is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending. Acceptable values are: - \"`active`\" - \"`pending`\" "
+ }
+ },
+ "type": "object"
+ },
+ "PosListResponse": {
+ "type": "object",
+ "id": "PosListResponse",
+ "properties": {
+ "kind": {
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#posListResponse\".",
+ "type": "string"
+ },
+ "resources": {
+ "type": "array",
+ "items": {
+ "$ref": "PosStore"
+ }
+ }
+ }
+ },
+ "ProductAspect": {
+ "id": "ProductAspect",
+ "properties": {
+ "intention": {
+ "description": "Deprecated.",
+ "type": "string"
+ },
+ "aspectName": {
+ "description": "Deprecated.",
+ "type": "string"
+ },
+ "destinationName": {
+ "type": "string",
+ "description": "Deprecated."
+ }
+ },
+ "type": "object"
+ },
+ "AccountsLinkResponse": {
+ "properties": {
+ "kind": {
+ "type": "string",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#accountsLinkResponse\"."
+ }
+ },
+ "id": "AccountsLinkResponse",
+ "type": "object"
+ },
+ "TestOrderPaymentMethod": {
+ "properties": {
+ "expirationYear": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The card expiration year (4-digit, e.g. 2015)."
+ },
+ "lastFourDigits": {
+ "type": "string",
+ "description": "The last four digits of the card number."
+ },
+ "predefinedBillingAddress": {
+ "type": "string",
+ "description": "The billing address. Acceptable values are: - \"`dwight`\" - \"`jim`\" - \"`pam`\" "
+ },
+ "type": {
+ "type": "string",
+ "description": "The type of instrument. Note that real orders might have different values than the four values accepted by `createTestOrder`. Acceptable values are: - \"`AMEX`\" - \"`DISCOVER`\" - \"`MASTERCARD`\" - \"`VISA`\" "
+ },
+ "expirationMonth": {
+ "format": "int32",
+ "type": "integer",
+ "description": "The card expiration month (January = 1, February = 2 etc.)."
+ }
+ },
+ "type": "object",
+ "id": "TestOrderPaymentMethod"
+ },
+ "OrdersCustomBatchRequestEntryRejectReturnLineItem": {
+ "properties": {
+ "quantity": {
+ "type": "integer",
+ "format": "uint32",
+ "description": "The quantity to return and refund."
+ },
+ "reason": {
+ "type": "string",
+ "description": "The reason for the return. Acceptable values are: - \"`damagedOrUsed`\" - \"`missingComponent`\" - \"`notEligible`\" - \"`other`\" - \"`outOfReturnWindow`\" "
+ },
+ "reasonText": {
+ "type": "string",
+ "description": "The explanation of the reason."
+ },
+ "lineItemId": {
+ "type": "string",
+ "description": "The ID of the line item to return. Either lineItemId or productId is required."
+ },
+ "productId": {
+ "type": "string",
+ "description": "The ID of the product to return. This is the REST ID used in the products service. Either lineItemId or productId is required."
+ }
+ },
+ "type": "object",
+ "id": "OrdersCustomBatchRequestEntryRejectReturnLineItem"
+ },
+ "PosSaleResponse": {
+ "id": "PosSaleResponse",
+ "properties": {
+ "storeCode": {
+ "type": "string",
+ "description": "Required. The identifier of the merchant's store. Either a `storeCode` inserted via the API or the code of the store in Google My Business."
+ },
+ "kind": {
+ "type": "string",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"content#posSaleResponse\"."
+ },
+ "quantity": {
+ "format": "int64",
+ "description": "Required. The relative change of the available quantity. Negative for items returned.",
+ "type": "string"
+ },
+ "targetCountry": {
+ "type": "string",
+ "description": "Required. The CLDR territory code for the item."
+ },
+ "itemId": {
+ "description": "Required. A unique identifier for the item.",
+ "type": "string"
+ },
+ "price": {
+ "description": "Required. The price of the item.",
+ "$ref": "Price"
+ },
+ "timestamp": {
+ "type": "string",
+ "description": "Required. The inventory timestamp, in ISO 8601 format."
+ },
+ "gtin": {
+ "description": "Global Trade Item Number.",
+ "type": "string"
+ },
+ "saleId": {
+ "type": "string",
+ "description": "A unique ID to group items from the same sale event."
+ },
+ "contentLanguage": {
+ "type": "string",
+ "description": "Required. The two-letter ISO 639-1 language code for the item."
+ }
+ },
+ "type": "object"
+ },
+ "AccountStatusItemLevelIssue": {
+ "properties": {
+ "attributeName": {
+ "description": "The attribute's name, if the issue is caused by a single attribute.",
+ "type": "string"
+ },
+ "numItems": {
+ "type": "string",
+ "description": "Number of items with this issue.",
+ "format": "int64"
+ },
+ "description": {
+ "description": "A short issue description in English.",
+ "type": "string"
+ },
+ "detail": {
+ "description": "A detailed issue description in English.",
+ "type": "string"
+ },
+ "code": {
+ "type": "string",
+ "description": "The error code of the issue."
+ },
+ "documentation": {
+ "description": "The URL of a web page to help with resolving this issue.",
+ "type": "string"
+ },
+ "servability": {
+ "description": "How this issue affects serving of the offer.",
+ "type": "string"
+ },
+ "resolution": {
+ "description": "Whether the issue can be resolved by the merchant.",
+ "type": "string"
+ }
+ },
+ "type": "object",
+ "id": "AccountStatusItemLevelIssue"
+ }
+ },
+ "id": "content:v2",
+ "title": "Content API for Shopping",
+ "icons": {
+ "x32": "http://www.google.com/images/icons/product/search-32.gif",
+ "x16": "http://www.google.com/images/icons/product/search-16.gif"
+ },
+ "description": "Manage your product listings and accounts for Google Shopping",
+ "resources": {
+ "accounts": {
+ "methods": {
+ "update": {
+ "request": {
+ "$ref": "Account"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ],
+ "httpMethod": "PUT",
+ "parameters": {
+ "accountId": {
+ "type": "string",
+ "format": "uint64",
+ "required": true,
+ "location": "path",
+ "description": "The ID of the account."
+ },
+ "merchantId": {
+ "type": "string",
+ "required": true,
+ "description": "The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.",
+ "format": "uint64",
+ "location": "path"
+ },
+ "dryRun": {
+ "description": "Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).",
+ "location": "query",
+ "type": "boolean"
+ }
+ },
+ "description": "Updates a Merchant Center account. Any fields that are not provided are deleted from the resource.",
+ "flatPath": "content/v2/{merchantId}/accounts/{accountId}",
+ "id": "content.accounts.update",
+ "path": "content/v2/{merchantId}/accounts/{accountId}",
+ "parameterOrder": [
+ "merchantId",
+ "accountId"
+ ],
+ "response": {
+ "$ref": "Account"
+ }
+ },
+ "get": {
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ],
+ "parameters": {
+ "merchantId": {
+ "description": "The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.",
+ "location": "path",
+ "format": "uint64",
+ "required": true,
+ "type": "string"
+ },
+ "accountId": {
+ "required": true,
+ "location": "path",
+ "type": "string",
+ "format": "uint64",
+ "description": "The ID of the account."
+ }
+ },
+ "httpMethod": "GET",
+ "path": "content/v2/{merchantId}/accounts/{accountId}",
+ "description": "Retrieves a Merchant Center account.",
+ "id": "content.accounts.get",
+ "parameterOrder": [
+ "merchantId",
+ "accountId"
+ ],
+ "response": {
+ "$ref": "Account"
+ },
+ "flatPath": "content/v2/{merchantId}/accounts/{accountId}"
+ },
+ "list": {
+ "flatPath": "content/v2/{merchantId}/accounts",
+ "id": "content.accounts.list",
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ],
+ "response": {
+ "$ref": "AccountsListResponse"
+ },
+ "path": "content/v2/{merchantId}/accounts",
+ "description": "Lists the sub-accounts in your Merchant Center account.",
+ "parameterOrder": [
+ "merchantId"
+ ],
+ "parameters": {
+ "merchantId": {
+ "description": "The ID of the managing account. This must be a multi-client account.",
+ "location": "path",
+ "required": true,
+ "type": "string",
+ "format": "uint64"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "The token returned by the previous request.",
+ "type": "string"
+ },
+ "maxResults": {
+ "location": "query",
+ "description": "The maximum number of accounts to return in the response, used for paging.",
+ "format": "uint32",
+ "type": "integer"
+ }
+ }
+ },
+ "delete": {
+ "description": "Deletes a Merchant Center sub-account.",
+ "parameterOrder": [
+ "merchantId",
+ "accountId"
+ ],
+ "parameters": {
+ "accountId": {
+ "type": "string",
+ "location": "path",
+ "description": "The ID of the account.",
+ "required": true,
+ "format": "uint64"
+ },
+ "dryRun": {
+ "type": "boolean",
+ "description": "Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).",
+ "location": "query"
+ },
+ "force": {
+ "default": "false",
+ "description": "Flag to delete sub-accounts with products. The default value is false.",
+ "type": "boolean",
+ "location": "query"
+ },
+ "merchantId": {
+ "description": "The ID of the managing account. This must be a multi-client account, and accountId must be the ID of a sub-account of this account.",
+ "format": "uint64",
+ "required": true,
+ "location": "path",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ],
+ "flatPath": "content/v2/{merchantId}/accounts/{accountId}",
+ "id": "content.accounts.delete",
+ "httpMethod": "DELETE",
+ "path": "content/v2/{merchantId}/accounts/{accountId}"
+ },
+ "insert": {
+ "response": {
+ "$ref": "Account"
+ },
+ "parameters": {
+ "dryRun": {
+ "description": "Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).",
+ "location": "query",
+ "type": "boolean"
+ },
+ "merchantId": {
+ "format": "uint64",
+ "required": true,
+ "description": "The ID of the managing account. This must be a multi-client account.",
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "path": "content/v2/{merchantId}/accounts",
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ],
+ "parameterOrder": [
+ "merchantId"
+ ],
+ "httpMethod": "POST",
+ "flatPath": "content/v2/{merchantId}/accounts",
+ "id": "content.accounts.insert",
+ "description": "Creates a Merchant Center sub-account.",
+ "request": {
+ "$ref": "Account"
+ }
+ },
+ "claimwebsite": {
+ "path": "content/v2/{merchantId}/accounts/{accountId}/claimwebsite",
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ],
+ "id": "content.accounts.claimwebsite",
+ "parameters": {
+ "overwrite": {
+ "location": "query",
+ "description": "Only available to selected merchants. When set to `True`, this flag removes any existing claim on the requested website by another account and replaces it with a claim from this account.",
+ "type": "boolean"
+ },
+ "accountId": {
+ "location": "path",
+ "description": "The ID of the account whose website is claimed.",
+ "format": "uint64",
+ "required": true,
+ "type": "string"
+ },
+ "merchantId": {
+ "format": "uint64",
+ "required": true,
+ "type": "string",
+ "description": "The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.",
+ "location": "path"
+ }
+ },
+ "flatPath": "content/v2/{merchantId}/accounts/{accountId}/claimwebsite",
+ "response": {
+ "$ref": "AccountsClaimWebsiteResponse"
+ },
+ "parameterOrder": [
+ "merchantId",
+ "accountId"
+ ],
+ "description": "Claims the website of a Merchant Center sub-account.",
+ "httpMethod": "POST"
+ },
+ "link": {
+ "path": "content/v2/{merchantId}/accounts/{accountId}/link",
+ "response": {
+ "$ref": "AccountsLinkResponse"
+ },
+ "parameterOrder": [
+ "merchantId",
+ "accountId"
+ ],
+ "flatPath": "content/v2/{merchantId}/accounts/{accountId}/link",
+ "parameters": {
+ "accountId": {
+ "type": "string",
+ "required": true,
+ "description": "The ID of the account that should be linked.",
+ "location": "path",
+ "format": "uint64"
+ },
+ "merchantId": {
+ "type": "string",
+ "format": "uint64",
+ "location": "path",
+ "description": "The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.",
+ "required": true
+ }
+ },
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ],
+ "description": "Performs an action on a link between two Merchant Center accounts, namely accountId and linkedAccountId.",
+ "request": {
+ "$ref": "AccountsLinkRequest"
+ },
+ "id": "content.accounts.link"
+ },
+ "authinfo": {
+ "parameterOrder": [],
+ "description": "Returns information about the authenticated user.",
+ "path": "content/v2/accounts/authinfo",
+ "flatPath": "content/v2/accounts/authinfo",
+ "response": {
+ "$ref": "AccountsAuthInfoResponse"
+ },
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ],
+ "httpMethod": "GET",
+ "id": "content.accounts.authinfo"
+ },
+ "custombatch": {
+ "flatPath": "content/v2/accounts/batch",
+ "request": {
+ "$ref": "AccountsCustomBatchRequest"
+ },
+ "parameters": {
+ "dryRun": {
+ "description": "Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).",
+ "location": "query",
+ "type": "boolean"
+ }
+ },
+ "httpMethod": "POST",
+ "path": "content/v2/accounts/batch",
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ],
+ "id": "content.accounts.custombatch",
+ "description": "Retrieves, inserts, updates, and deletes multiple Merchant Center (sub-)accounts in a single request.",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "AccountsCustomBatchResponse"
+ }
+ }
+ }
+ },
+ "datafeeds": {
+ "methods": {
+ "delete": {
+ "parameterOrder": [
+ "merchantId",
+ "datafeedId"
+ ],
+ "path": "content/v2/{merchantId}/datafeeds/{datafeedId}",
+ "id": "content.datafeeds.delete",
+ "description": "Deletes a datafeed configuration from your Merchant Center account.",
+ "flatPath": "content/v2/{merchantId}/datafeeds/{datafeedId}",
+ "parameters": {
+ "datafeedId": {
+ "description": "The ID of the datafeed.",
+ "required": true,
+ "format": "uint64",
+ "type": "string",
+ "location": "path"
+ },
+ "merchantId": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "The ID of the account that manages the datafeed. This account cannot be a multi-client account.",
+ "format": "uint64"
+ },
+ "dryRun": {
+ "type": "boolean",
+ "description": "Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).",
+ "location": "query"
+ }
+ },
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "list": {
+ "id": "content.datafeeds.list",
+ "parameterOrder": [
+ "merchantId"
+ ],
+ "parameters": {
+ "maxResults": {
+ "location": "query",
+ "description": "The maximum number of products to return in the response, used for paging.",
+ "type": "integer",
+ "format": "uint32"
+ },
+ "pageToken": {
+ "type": "string",
+ "description": "The token returned by the previous request.",
+ "location": "query"
+ },
+ "merchantId": {
+ "format": "uint64",
+ "description": "The ID of the account that manages the datafeeds. This account cannot be a multi-client account.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "DatafeedsListResponse"
+ },
+ "flatPath": "content/v2/{merchantId}/datafeeds",
+ "description": "Lists the configurations for datafeeds in your Merchant Center account.",
+ "path": "content/v2/{merchantId}/datafeeds",
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "fetchnow": {
+ "description": "Invokes a fetch for the datafeed in your Merchant Center account. If you need to call this method more than once per day, we recommend you use the Products service to update your product data.",
+ "parameterOrder": [
+ "merchantId",
+ "datafeedId"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ],
+ "parameters": {
+ "merchantId": {
+ "description": "The ID of the account that manages the datafeed. This account cannot be a multi-client account.",
+ "format": "uint64",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "dryRun": {
+ "type": "boolean",
+ "description": "Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).",
+ "location": "query"
+ },
+ "datafeedId": {
+ "description": "The ID of the datafeed to be fetched.",
+ "location": "path",
+ "type": "string",
+ "required": true,
+ "format": "uint64"
+ }
+ },
+ "id": "content.datafeeds.fetchnow",
+ "flatPath": "content/v2/{merchantId}/datafeeds/{datafeedId}/fetchNow",
+ "path": "content/v2/{merchantId}/datafeeds/{datafeedId}/fetchNow",
+ "httpMethod": "POST",
+ "response": {
+ "$ref": "DatafeedsFetchNowResponse"
+ }
+ },
+ "get": {
+ "description": "Retrieves a datafeed configuration from your Merchant Center account.",
+ "path": "content/v2/{merchantId}/datafeeds/{datafeedId}",
+ "parameterOrder": [
+ "merchantId",
+ "datafeedId"
+ ],
+ "parameters": {
+ "datafeedId": {
+ "location": "path",
+ "required": true,
+ "format": "uint64",
+ "description": "The ID of the datafeed.",
+ "type": "string"
+ },
+ "merchantId": {
+ "description": "The ID of the account that manages the datafeed. This account cannot be a multi-client account.",
+ "required": true,
+ "location": "path",
+ "type": "string",
+ "format": "uint64"
+ }
+ },
+ "flatPath": "content/v2/{merchantId}/datafeeds/{datafeedId}",
+ "response": {
+ "$ref": "Datafeed"
+ },
+ "httpMethod": "GET",
+ "id": "content.datafeeds.get",
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "custombatch": {
+ "parameterOrder": [],
+ "flatPath": "content/v2/datafeeds/batch",
+ "description": "Deletes, fetches, gets, inserts and updates multiple datafeeds in a single request.",
+ "path": "content/v2/datafeeds/batch",
+ "response": {
+ "$ref": "DatafeedsCustomBatchResponse"
+ },
+ "httpMethod": "POST",
+ "parameters": {
+ "dryRun": {
+ "type": "boolean",
+ "description": "Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ],
+ "id": "content.datafeeds.custombatch",
+ "request": {
+ "$ref": "DatafeedsCustomBatchRequest"
+ }
+ },
+ "insert": {
+ "parameterOrder": [
+ "merchantId"
+ ],
+ "id": "content.datafeeds.insert",
+ "flatPath": "content/v2/{merchantId}/datafeeds",
+ "description": "Registers a datafeed configuration with your Merchant Center account.",
+ "request": {
+ "$ref": "Datafeed"
+ },
+ "httpMethod": "POST",
+ "parameters": {
+ "dryRun": {
+ "type": "boolean",
+ "location": "query",
+ "description": "Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any)."
+ },
+ "merchantId": {
+ "location": "path",
+ "format": "uint64",
+ "required": true,
+ "description": "The ID of the account that manages the datafeed. This account cannot be a multi-client account.",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ],
+ "path": "content/v2/{merchantId}/datafeeds",
+ "response": {
+ "$ref": "Datafeed"
+ }
+ },
+ "update": {
+ "httpMethod": "PUT",
+ "parameters": {
+ "datafeedId": {
+ "location": "path",
+ "type": "string",
+ "required": true,
+ "format": "uint64",
+ "description": "The ID of the datafeed."
+ },
+ "merchantId": {
+ "type": "string",
+ "location": "path",
+ "format": "uint64",
+ "required": true,
+ "description": "The ID of the account that manages the datafeed. This account cannot be a multi-client account."
+ },
+ "dryRun": {
+ "description": "Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).",
+ "location": "query",
+ "type": "boolean"
+ }
+ },
+ "id": "content.datafeeds.update",
+ "description": "Updates a datafeed configuration of your Merchant Center account. Any fields that are not provided are deleted from the resource.",
+ "flatPath": "content/v2/{merchantId}/datafeeds/{datafeedId}",
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ],
+ "path": "content/v2/{merchantId}/datafeeds/{datafeedId}",
+ "request": {
+ "$ref": "Datafeed"
+ },
+ "response": {
+ "$ref": "Datafeed"
+ },
+ "parameterOrder": [
+ "merchantId",
+ "datafeedId"
+ ]
+ }
+ }
+ },
+ "productstatuses": {
+ "methods": {
+ "custombatch": {
+ "flatPath": "content/v2/productstatuses/batch",
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "ProductstatusesCustomBatchResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ],
+ "parameters": {
+ "includeAttributes": {
+ "type": "boolean",
+ "location": "query",
+ "description": "Flag to include full product data in the results of this request. The default value is false."
+ }
+ },
+ "request": {
+ "$ref": "ProductstatusesCustomBatchRequest"
+ },
+ "id": "content.productstatuses.custombatch",
+ "description": "Gets the statuses of multiple products in a single request.",
+ "path": "content/v2/productstatuses/batch"
+ },
+ "get": {
+ "httpMethod": "GET",
+ "id": "content.productstatuses.get",
+ "parameters": {
+ "destinations": {
+ "repeated": true,
+ "description": "If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination.",
+ "location": "query",
+ "type": "string"
+ },
+ "merchantId": {
+ "format": "uint64",
+ "description": "The ID of the account that contains the product. This account cannot be a multi-client account.",
+ "location": "path",
+ "type": "string",
+ "required": true
+ },
+ "productId": {
+ "type": "string",
+ "location": "path",
+ "description": "The REST ID of the product.",
+ "required": true
+ },
+ "includeAttributes": {
+ "location": "query",
+ "description": "Flag to include full product data in the result of this get request. The default value is false.",
+ "type": "boolean"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ],
+ "parameterOrder": [
+ "merchantId",
+ "productId"
+ ],
+ "description": "Gets the status of a product from your Merchant Center account.",
+ "path": "content/v2/{merchantId}/productstatuses/{productId}",
+ "response": {
+ "$ref": "ProductStatus"
+ },
+ "flatPath": "content/v2/{merchantId}/productstatuses/{productId}"
+ },
+ "list": {
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ],
+ "path": "content/v2/{merchantId}/productstatuses",
+ "response": {
+ "$ref": "ProductstatusesListResponse"
+ },
+ "description": "Lists the statuses of the products in your Merchant Center account.",
+ "id": "content.productstatuses.list",
+ "parameters": {
+ "maxResults": {
+ "location": "query",
+ "type": "integer",
+ "description": "The maximum number of product statuses to return in the response, used for paging.",
+ "format": "uint32"
+ },
+ "pageToken": {
+ "description": "The token returned by the previous request.",
+ "type": "string",
+ "location": "query"
+ },
+ "merchantId": {
+ "location": "path",
+ "required": true,
+ "format": "uint64",
+ "type": "string",
+ "description": "The ID of the account that contains the products. This account cannot be a multi-client account."
+ },
+ "includeAttributes": {
+ "location": "query",
+ "type": "boolean",
+ "description": "Flag to include full product data in the results of the list request. The default value is false."
+ },
+ "includeInvalidInsertedItems": {
+ "type": "boolean",
+ "description": "Flag to include the invalid inserted items in the result of the list request. By default the invalid items are not shown (the default value is false).",
+ "location": "query"
+ },
+ "destinations": {
+ "description": "If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination.",
+ "type": "string",
+ "repeated": true,
+ "location": "query"
+ }
+ },
+ "parameterOrder": [
+ "merchantId"
+ ],
+ "flatPath": "content/v2/{merchantId}/productstatuses"
+ }
+ }
+ },
+ "inventory": {
+ "methods": {
+ "set": {
+ "flatPath": "content/v2/{merchantId}/inventory/{storeCode}/products/{productId}",
+ "parameters": {
+ "dryRun": {
+ "type": "boolean",
+ "location": "query",
+ "description": "Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any)."
+ },
+ "productId": {
+ "required": true,
+ "location": "path",
+ "type": "string",
+ "description": "The REST ID of the product for which to update price and availability."
+ },
+ "merchantId": {
+ "type": "string",
+ "description": "The ID of the account that contains the product. This account cannot be a multi-client account.",
+ "required": true,
+ "location": "path",
+ "format": "uint64"
+ },
+ "storeCode": {
+ "location": "path",
+ "type": "string",
+ "required": true,
+ "description": "The code of the store for which to update price and availability. Use `online` to update price and availability of an online product."
+ }
+ },
+ "path": "content/v2/{merchantId}/inventory/{storeCode}/products/{productId}",
+ "httpMethod": "POST",
+ "id": "content.inventory.set",
+ "description": "Updates price and availability of a product in your Merchant Center account.",
+ "request": {
+ "$ref": "InventorySetRequest"
+ },
+ "response": {
+ "$ref": "InventorySetResponse"
+ },
+ "parameterOrder": [
+ "merchantId",
+ "storeCode",
+ "productId"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "custombatch": {
+ "request": {
+ "$ref": "InventoryCustomBatchRequest"
+ },
+ "flatPath": "content/v2/inventory/batch",
+ "path": "content/v2/inventory/batch",
+ "response": {
+ "$ref": "InventoryCustomBatchResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ],
+ "id": "content.inventory.custombatch",
+ "parameterOrder": [],
+ "description": "Updates price and availability for multiple products or stores in a single request. This operation does not update the expiration date of the products.",
+ "parameters": {
+ "dryRun": {
+ "type": "boolean",
+ "location": "query",
+ "description": "Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any)."
+ }
+ },
+ "httpMethod": "POST"
+ }
+ }
+ },
+ "pos": {
+ "methods": {
+ "delete": {
+ "parameterOrder": [
+ "merchantId",
+ "targetMerchantId",
+ "storeCode"
+ ],
+ "description": "Deletes a store for the given merchant.",
+ "parameters": {
+ "storeCode": {
+ "location": "path",
+ "description": "A store code that is unique per merchant.",
+ "required": true,
+ "type": "string"
+ },
+ "dryRun": {
+ "type": "boolean",
+ "location": "query",
+ "description": "Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any)."
+ },
+ "merchantId": {
+ "required": true,
+ "type": "string",
+ "description": "The ID of the POS or inventory data provider.",
+ "location": "path",
+ "format": "uint64"
+ },
+ "targetMerchantId": {
+ "required": true,
+ "format": "uint64",
+ "location": "path",
+ "type": "string",
+ "description": "The ID of the target merchant."
+ }
+ },
+ "path": "content/v2/{merchantId}/pos/{targetMerchantId}/store/{storeCode}",
+ "id": "content.pos.delete",
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ],
+ "httpMethod": "DELETE",
+ "flatPath": "content/v2/{merchantId}/pos/{targetMerchantId}/store/{storeCode}"
+ },
+ "get": {
+ "httpMethod": "GET",
+ "path": "content/v2/{merchantId}/pos/{targetMerchantId}/store/{storeCode}",
+ "flatPath": "content/v2/{merchantId}/pos/{targetMerchantId}/store/{storeCode}",
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ],
+ "id": "content.pos.get",
+ "parameterOrder": [
+ "merchantId",
+ "targetMerchantId",
+ "storeCode"
+ ],
+ "parameters": {
+ "targetMerchantId": {
+ "location": "path",
+ "description": "The ID of the target merchant.",
+ "type": "string",
+ "format": "uint64",
+ "required": true
+ },
+ "merchantId": {
+ "format": "uint64",
+ "location": "path",
+ "type": "string",
+ "description": "The ID of the POS or inventory data provider.",
+ "required": true
+ },
+ "storeCode": {
+ "required": true,
+ "type": "string",
+ "description": "A store code that is unique per merchant.",
+ "location": "path"
+ }
+ },
+ "response": {
+ "$ref": "PosStore"
+ },
+ "description": "Retrieves information about the given store."
+ },
+ "custombatch": {
+ "description": "Batches multiple POS-related calls in a single request.",
+ "id": "content.pos.custombatch",
+ "httpMethod": "POST",
+ "request": {
+ "$ref": "PosCustomBatchRequest"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ],
+ "parameterOrder": [],
+ "parameters": {
+ "dryRun": {
+ "description": "Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).",
+ "location": "query",
+ "type": "boolean"
+ }
+ },
+ "response": {
+ "$ref": "PosCustomBatchResponse"
+ },
+ "flatPath": "content/v2/pos/batch",
+ "path": "content/v2/pos/batch"
+ },
+ "sale": {
+ "response": {
+ "$ref": "PosSaleResponse"
+ },
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ],
+ "description": "Submit a sale event for the given merchant.",
+ "parameterOrder": [
+ "merchantId",
+ "targetMerchantId"
+ ],
+ "path": "content/v2/{merchantId}/pos/{targetMerchantId}/sale",
+ "request": {
+ "$ref": "PosSaleRequest"
+ },
+ "id": "content.pos.sale",
+ "flatPath": "content/v2/{merchantId}/pos/{targetMerchantId}/sale",
+ "parameters": {
+ "targetMerchantId": {
+ "location": "path",
+ "format": "uint64",
+ "required": true,
+ "type": "string",
+ "description": "The ID of the target merchant."
+ },
+ "merchantId": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "format": "uint64",
+ "description": "The ID of the POS or inventory data provider."
+ },
+ "dryRun": {
+ "description": "Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).",
+ "type": "boolean",
+ "location": "query"
+ }
+ }
+ },
+ "list": {
+ "httpMethod": "GET",
+ "path": "content/v2/{merchantId}/pos/{targetMerchantId}/store",
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ],
+ "id": "content.pos.list",
+ "parameters": {
+ "targetMerchantId": {
+ "format": "uint64",
+ "description": "The ID of the target merchant.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "merchantId": {
+ "description": "The ID of the POS or inventory data provider.",
+ "required": true,
+ "format": "uint64",
+ "location": "path",
+ "type": "string"
+ }
+ },
+ "description": "Lists the stores of the target merchant.",
+ "response": {
+ "$ref": "PosListResponse"
+ },
+ "flatPath": "content/v2/{merchantId}/pos/{targetMerchantId}/store",
+ "parameterOrder": [
+ "merchantId",
+ "targetMerchantId"
+ ]
+ },
+ "insert": {
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ],
+ "parameters": {
+ "targetMerchantId": {
+ "format": "uint64",
+ "location": "path",
+ "type": "string",
+ "required": true,
+ "description": "The ID of the target merchant."
+ },
+ "merchantId": {
+ "required": true,
+ "location": "path",
+ "format": "uint64",
+ "description": "The ID of the POS or inventory data provider.",
+ "type": "string"
+ },
+ "dryRun": {
+ "type": "boolean",
+ "description": "Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).",
+ "location": "query"
+ }
+ },
+ "flatPath": "content/v2/{merchantId}/pos/{targetMerchantId}/store",
+ "parameterOrder": [
+ "merchantId",
+ "targetMerchantId"
+ ],
+ "httpMethod": "POST",
+ "path": "content/v2/{merchantId}/pos/{targetMerchantId}/store",
+ "response": {
+ "$ref": "PosStore"
+ },
+ "request": {
+ "$ref": "PosStore"
+ },
+ "description": "Creates a store for the given merchant.",
+ "id": "content.pos.insert"
+ },
+ "inventory": {
+ "response": {
+ "$ref": "PosInventoryResponse"
+ },
+ "flatPath": "content/v2/{merchantId}/pos/{targetMerchantId}/inventory",
+ "parameterOrder": [
+ "merchantId",
+ "targetMerchantId"
+ ],
+ "description": "Submit inventory for the given merchant.",
+ "request": {
+ "$ref": "PosInventoryRequest"
+ },
+ "id": "content.pos.inventory",
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ],
+ "parameters": {
+ "dryRun": {
+ "description": "Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).",
+ "location": "query",
+ "type": "boolean"
+ },
+ "merchantId": {
+ "location": "path",
+ "type": "string",
+ "description": "The ID of the POS or inventory data provider.",
+ "format": "uint64",
+ "required": true
+ },
+ "targetMerchantId": {
+ "format": "uint64",
+ "description": "The ID of the target merchant.",
+ "required": true,
+ "location": "path",
+ "type": "string"
+ }
+ },
+ "path": "content/v2/{merchantId}/pos/{targetMerchantId}/inventory"
+ }
+ }
+ },
+ "orderinvoices": {
+ "methods": {
+ "createrefundinvoice": {
+ "response": {
+ "$ref": "OrderinvoicesCreateRefundInvoiceResponse"
+ },
+ "flatPath": "content/v2/{merchantId}/orderinvoices/{orderId}/createRefundInvoice",
+ "id": "content.orderinvoices.createrefundinvoice",
+ "parameters": {
+ "orderId": {
+ "location": "path",
+ "description": "The ID of the order.",
+ "required": true,
+ "type": "string"
+ },
+ "merchantId": {
+ "description": "The ID of the account that manages the order. This cannot be a multi-client account.",
+ "type": "string",
+ "format": "uint64",
+ "location": "path",
+ "required": true
+ }
+ },
+ "httpMethod": "POST",
+ "request": {
+ "$ref": "OrderinvoicesCreateRefundInvoiceRequest"
+ },
+ "parameterOrder": [
+ "merchantId",
+ "orderId"
+ ],
+ "description": "Creates a refund invoice for one or more shipment groups, and triggers a refund for orderinvoice enabled orders. This can only be used for line items that have previously been charged using `createChargeInvoice`. All amounts (except for the summary) are incremental with respect to the previous invoice.",
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ],
+ "path": "content/v2/{merchantId}/orderinvoices/{orderId}/createRefundInvoice"
+ },
+ "createchargeinvoice": {
+ "request": {
+ "$ref": "OrderinvoicesCreateChargeInvoiceRequest"
+ },
+ "id": "content.orderinvoices.createchargeinvoice",
+ "flatPath": "content/v2/{merchantId}/orderinvoices/{orderId}/createChargeInvoice",
+ "path": "content/v2/{merchantId}/orderinvoices/{orderId}/createChargeInvoice",
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ],
+ "response": {
+ "$ref": "OrderinvoicesCreateChargeInvoiceResponse"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "merchantId",
+ "orderId"
+ ],
+ "description": "Creates a charge invoice for a shipment group, and triggers a charge capture for orderinvoice enabled orders.",
+ "parameters": {
+ "merchantId": {
+ "description": "The ID of the account that manages the order. This cannot be a multi-client account.",
+ "required": true,
+ "location": "path",
+ "type": "string",
+ "format": "uint64"
+ },
+ "orderId": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "The ID of the order."
+ }
+ }
+ }
+ }
+ },
+ "orders": {
+ "methods": {
+ "cancel": {
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ],
+ "request": {
+ "$ref": "OrdersCancelRequest"
+ },
+ "parameterOrder": [
+ "merchantId",
+ "orderId"
+ ],
+ "id": "content.orders.cancel",
+ "flatPath": "content/v2/{merchantId}/orders/{orderId}/cancel",
+ "description": "Cancels all line items in an order, making a full refund.",
+ "path": "content/v2/{merchantId}/orders/{orderId}/cancel",
+ "response": {
+ "$ref": "OrdersCancelResponse"
+ },
+ "httpMethod": "POST",
+ "parameters": {
+ "orderId": {
+ "required": true,
+ "location": "path",
+ "description": "The ID of the order to cancel.",
+ "type": "string"
+ },
+ "merchantId": {
+ "required": true,
+ "location": "path",
+ "description": "The ID of the account that manages the order. This cannot be a multi-client account.",
+ "format": "uint64",
+ "type": "string"
+ }
+ }
+ },
+ "returnrefundlineitem": {
+ "path": "content/v2/{merchantId}/orders/{orderId}/returnRefundLineItem",
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ],
+ "flatPath": "content/v2/{merchantId}/orders/{orderId}/returnRefundLineItem",
+ "parameterOrder": [
+ "merchantId",
+ "orderId"
+ ],
+ "request": {
+ "$ref": "OrdersReturnRefundLineItemRequest"
+ },
+ "id": "content.orders.returnrefundlineitem",
+ "httpMethod": "POST",
+ "parameters": {
+ "orderId": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "The ID of the order."
+ },
+ "merchantId": {
+ "description": "The ID of the account that manages the order. This cannot be a multi-client account.",
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "format": "uint64"
+ }
+ },
+ "response": {
+ "$ref": "OrdersReturnRefundLineItemResponse"
+ },
+ "description": "Returns and refunds a line item. Note that this method can only be called on fully shipped orders. Please also note that the Orderreturns API is the preferred way to handle returns after you receive a return from a customer. You can use Orderreturns.list or Orderreturns.get to search for the return, and then use Orderreturns.processreturn to issue the refund. If the return cannot be found, then we recommend using this API to issue a refund."
+ },
+ "gettestordertemplate": {
+ "flatPath": "content/v2/{merchantId}/testordertemplates/{templateName}",
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ],
+ "httpMethod": "GET",
+ "description": "Sandbox only. Retrieves an order template that can be used to quickly create a new order in sandbox.",
+ "response": {
+ "$ref": "OrdersGetTestOrderTemplateResponse"
+ },
+ "parameterOrder": [
+ "merchantId",
+ "templateName"
+ ],
+ "path": "content/v2/{merchantId}/testordertemplates/{templateName}",
+ "id": "content.orders.gettestordertemplate",
+ "parameters": {
+ "country": {
+ "description": "The country of the template to retrieve. Defaults to `US`.",
+ "location": "query",
+ "type": "string"
+ },
+ "templateName": {
+ "location": "path",
+ "enum": [
+ "TEMPLATE1",
+ "TEMPLATE2",
+ "TEMPLATE1A",
+ "TEMPLATE1B",
+ "TEMPLATE3"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "type": "string",
+ "required": true,
+ "description": "The name of the template to retrieve."
+ },
+ "merchantId": {
+ "description": "The ID of the account that should manage the order. This cannot be a multi-client account.",
+ "format": "uint64",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ }
+ },
+ "refund": {
+ "parameters": {
+ "merchantId": {
+ "format": "uint64",
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "The ID of the account that manages the order. This cannot be a multi-client account."
+ },
+ "orderId": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "The ID of the order to refund."
+ }
+ },
+ "id": "content.orders.refund",
+ "response": {
+ "$ref": "OrdersRefundResponse"
+ },
+ "request": {
+ "$ref": "OrdersRefundRequest"
+ },
+ "flatPath": "content/v2/{merchantId}/orders/{orderId}/refund",
+ "description": "Deprecated, please use returnRefundLineItem instead.",
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ],
+ "parameterOrder": [
+ "merchantId",
+ "orderId"
+ ],
+ "httpMethod": "POST",
+ "path": "content/v2/{merchantId}/orders/{orderId}/refund"
+ },
+ "rejectreturnlineitem": {
+ "path": "content/v2/{merchantId}/orders/{orderId}/rejectReturnLineItem",
+ "id": "content.orders.rejectreturnlineitem",
+ "response": {
+ "$ref": "OrdersRejectReturnLineItemResponse"
+ },
+ "flatPath": "content/v2/{merchantId}/orders/{orderId}/rejectReturnLineItem",
+ "parameterOrder": [
+ "merchantId",
+ "orderId"
+ ],
+ "request": {
+ "$ref": "OrdersRejectReturnLineItemRequest"
+ },
+ "parameters": {
+ "merchantId": {
+ "description": "The ID of the account that manages the order. This cannot be a multi-client account.",
+ "format": "uint64",
+ "type": "string",
+ "location": "path",
+ "required": true
+ },
+ "orderId": {
+ "required": true,
+ "description": "The ID of the order.",
+ "location": "path",
+ "type": "string"
+ }
+ },
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ],
+ "description": "Rejects return on an line item."
+ },
+ "instorerefundlineitem": {
+ "parameterOrder": [
+ "merchantId",
+ "orderId"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ],
+ "httpMethod": "POST",
+ "flatPath": "content/v2/{merchantId}/orders/{orderId}/inStoreRefundLineItem",
+ "request": {
+ "$ref": "OrdersInStoreRefundLineItemRequest"
+ },
+ "id": "content.orders.instorerefundlineitem",
+ "parameters": {
+ "orderId": {
+ "location": "path",
+ "type": "string",
+ "required": true,
+ "description": "The ID of the order."
+ },
+ "merchantId": {
+ "format": "uint64",
+ "location": "path",
+ "type": "string",
+ "description": "The ID of the account that manages the order. This cannot be a multi-client account.",
+ "required": true
+ }
+ },
+ "description": "Deprecated. Notifies that item return and refund was handled directly by merchant outside of Google payments processing (e.g. cash refund done in store). Note: We recommend calling the returnrefundlineitem method to refund in-store returns. We will issue the refund directly to the customer. This helps to prevent possible differences arising between merchant and Google transaction records. We also recommend having the point of sale system communicate with Google to ensure that customers do not receive a double refund by first refunding via Google then via an in-store return.",
+ "response": {
+ "$ref": "OrdersInStoreRefundLineItemResponse"
+ },
+ "path": "content/v2/{merchantId}/orders/{orderId}/inStoreRefundLineItem"
+ },
+ "canceltestorderbycustomer": {
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ],
+ "response": {
+ "$ref": "OrdersCancelTestOrderByCustomerResponse"
+ },
+ "parameterOrder": [
+ "merchantId",
+ "orderId"
+ ],
+ "id": "content.orders.canceltestorderbycustomer",
+ "description": "Sandbox only. Cancels a test order for customer-initiated cancellation.",
+ "flatPath": "content/v2/{merchantId}/testorders/{orderId}/cancelByCustomer",
+ "parameters": {
+ "orderId": {
+ "description": "The ID of the test order to cancel.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "merchantId": {
+ "required": true,
+ "description": "The ID of the account that manages the order. This cannot be a multi-client account.",
+ "format": "uint64",
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "path": "content/v2/{merchantId}/testorders/{orderId}/cancelByCustomer",
+ "request": {
+ "$ref": "OrdersCancelTestOrderByCustomerRequest"
+ }
+ },
+ "shiplineitems": {
+ "path": "content/v2/{merchantId}/orders/{orderId}/shipLineItems",
+ "description": "Marks line item(s) as shipped.",
+ "parameters": {
+ "merchantId": {
+ "required": true,
+ "format": "uint64",
+ "type": "string",
+ "location": "path",
+ "description": "The ID of the account that manages the order. This cannot be a multi-client account."
+ },
+ "orderId": {
+ "location": "path",
+ "type": "string",
+ "required": true,
+ "description": "The ID of the order."
+ }
+ },
+ "id": "content.orders.shiplineitems",
+ "httpMethod": "POST",
+ "request": {
+ "$ref": "OrdersShipLineItemsRequest"
+ },
+ "response": {
+ "$ref": "OrdersShipLineItemsResponse"
+ },
+ "flatPath": "content/v2/{merchantId}/orders/{orderId}/shipLineItems",
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ],
+ "parameterOrder": [
+ "merchantId",
+ "orderId"
+ ]
+ },
+ "updatemerchantorderid": {
+ "httpMethod": "POST",
+ "id": "content.orders.updatemerchantorderid",
+ "path": "content/v2/{merchantId}/orders/{orderId}/updateMerchantOrderId",
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ],
+ "parameters": {
+ "orderId": {
+ "location": "path",
+ "description": "The ID of the order.",
+ "type": "string",
+ "required": true
+ },
+ "merchantId": {
+ "location": "path",
+ "type": "string",
+ "required": true,
+ "format": "uint64",
+ "description": "The ID of the account that manages the order. This cannot be a multi-client account."
+ }
+ },
+ "parameterOrder": [
+ "merchantId",
+ "orderId"
+ ],
+ "description": "Updates the merchant order ID for a given order.",
+ "response": {
+ "$ref": "OrdersUpdateMerchantOrderIdResponse"
+ },
+ "request": {
+ "$ref": "OrdersUpdateMerchantOrderIdRequest"
+ },
+ "flatPath": "content/v2/{merchantId}/orders/{orderId}/updateMerchantOrderId"
+ },
+ "createtestorder": {
+ "description": "Sandbox only. Creates a test order.",
+ "httpMethod": "POST",
+ "id": "content.orders.createtestorder",
+ "parameters": {
+ "merchantId": {
+ "description": "The ID of the account that should manage the order. This cannot be a multi-client account.",
+ "type": "string",
+ "location": "path",
+ "required": true,
+ "format": "uint64"
+ }
+ },
+ "flatPath": "content/v2/{merchantId}/testorders",
+ "path": "content/v2/{merchantId}/testorders",
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ],
+ "request": {
+ "$ref": "OrdersCreateTestOrderRequest"
+ },
+ "response": {
+ "$ref": "OrdersCreateTestOrderResponse"
+ },
+ "parameterOrder": [
+ "merchantId"
+ ]
+ },
+ "acknowledge": {
+ "flatPath": "content/v2/{merchantId}/orders/{orderId}/acknowledge",
+ "description": "Marks an order as acknowledged.",
+ "httpMethod": "POST",
+ "parameters": {
+ "merchantId": {
+ "location": "path",
+ "type": "string",
+ "required": true,
+ "description": "The ID of the account that manages the order. This cannot be a multi-client account.",
+ "format": "uint64"
+ },
+ "orderId": {
+ "required": true,
+ "location": "path",
+ "type": "string",
+ "description": "The ID of the order."
+ }
+ },
+ "id": "content.orders.acknowledge",
+ "request": {
+ "$ref": "OrdersAcknowledgeRequest"
+ },
+ "response": {
+ "$ref": "OrdersAcknowledgeResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ],
+ "parameterOrder": [
+ "merchantId",
+ "orderId"
+ ],
+ "path": "content/v2/{merchantId}/orders/{orderId}/acknowledge"
+ },
+ "updatelineitemshippingdetails": {
+ "description": "Updates ship by and delivery by dates for a line item.",
+ "id": "content.orders.updatelineitemshippingdetails",
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ],
+ "request": {
+ "$ref": "OrdersUpdateLineItemShippingDetailsRequest"
+ },
+ "path": "content/v2/{merchantId}/orders/{orderId}/updateLineItemShippingDetails",
+ "flatPath": "content/v2/{merchantId}/orders/{orderId}/updateLineItemShippingDetails",
+ "parameters": {
+ "merchantId": {
+ "format": "uint64",
+ "required": true,
+ "type": "string",
+ "description": "The ID of the account that manages the order. This cannot be a multi-client account.",
+ "location": "path"
+ },
+ "orderId": {
+ "location": "path",
+ "type": "string",
+ "description": "The ID of the order.",
+ "required": true
+ }
+ },
+ "parameterOrder": [
+ "merchantId",
+ "orderId"
+ ],
+ "httpMethod": "POST",
+ "response": {
+ "$ref": "OrdersUpdateLineItemShippingDetailsResponse"
+ }
+ },
+ "returnlineitem": {
+ "parameters": {
+ "orderId": {
+ "location": "path",
+ "required": true,
+ "description": "The ID of the order.",
+ "type": "string"
+ },
+ "merchantId": {
+ "format": "uint64",
+ "type": "string",
+ "location": "path",
+ "description": "The ID of the account that manages the order. This cannot be a multi-client account.",
+ "required": true
+ }
+ },
+ "response": {
+ "$ref": "OrdersReturnLineItemResponse"
+ },
+ "path": "content/v2/{merchantId}/orders/{orderId}/returnLineItem",
+ "description": "Returns a line item.",
+ "request": {
+ "$ref": "OrdersReturnLineItemRequest"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ],
+ "parameterOrder": [
+ "merchantId",
+ "orderId"
+ ],
+ "flatPath": "content/v2/{merchantId}/orders/{orderId}/returnLineItem",
+ "id": "content.orders.returnlineitem",
+ "httpMethod": "POST"
+ },
+ "custombatch": {
+ "parameterOrder": [],
+ "request": {
+ "$ref": "OrdersCustomBatchRequest"
+ },
+ "httpMethod": "POST",
+ "response": {
+ "$ref": "OrdersCustomBatchResponse"
+ },
+ "path": "content/v2/orders/batch",
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ],
+ "description": "Retrieves or modifies multiple orders in a single request.",
+ "parameters": {},
+ "id": "content.orders.custombatch",
+ "flatPath": "content/v2/orders/batch"
+ },
+ "get": {
+ "parameters": {
+ "merchantId": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "format": "uint64",
+ "description": "The ID of the account that manages the order. This cannot be a multi-client account."
+ },
+ "orderId": {
+ "description": "The ID of the order.",
+ "location": "path",
+ "type": "string",
+ "required": true
+ }
+ },
+ "httpMethod": "GET",
+ "id": "content.orders.get",
+ "flatPath": "content/v2/{merchantId}/orders/{orderId}",
+ "parameterOrder": [
+ "merchantId",
+ "orderId"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ],
+ "response": {
+ "$ref": "Order"
+ },
+ "description": "Retrieves an order from your Merchant Center account.",
+ "path": "content/v2/{merchantId}/orders/{orderId}"
+ },
+ "getbymerchantorderid": {
+ "id": "content.orders.getbymerchantorderid",
+ "httpMethod": "GET",
+ "parameters": {
+ "merchantId": {
+ "required": true,
+ "location": "path",
+ "format": "uint64",
+ "description": "The ID of the account that manages the order. This cannot be a multi-client account.",
+ "type": "string"
+ },
+ "merchantOrderId": {
+ "location": "path",
+ "required": true,
+ "description": "The merchant order ID to be looked for.",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ],
+ "path": "content/v2/{merchantId}/ordersbymerchantid/{merchantOrderId}",
+ "flatPath": "content/v2/{merchantId}/ordersbymerchantid/{merchantOrderId}",
+ "response": {
+ "$ref": "OrdersGetByMerchantOrderIdResponse"
+ },
+ "description": "Retrieves an order using merchant order ID.",
+ "parameterOrder": [
+ "merchantId",
+ "merchantOrderId"
+ ]
+ },
+ "list": {
+ "flatPath": "content/v2/{merchantId}/orders",
+ "response": {
+ "$ref": "OrdersListResponse"
+ },
+ "path": "content/v2/{merchantId}/orders",
+ "description": "Lists the orders in your Merchant Center account.",
+ "id": "content.orders.list",
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ],
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "merchantId"
+ ],
+ "parameters": {
+ "placedDateEnd": {
+ "location": "query",
+ "description": "Obtains orders placed before this date (exclusively), in ISO 8601 format.",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "The token returned by the previous request.",
+ "location": "query",
+ "type": "string"
+ },
+ "statuses": {
+ "type": "string",
+ "enum": [
+ "ACTIVE",
+ "COMPLETED",
+ "CANCELED",
+ "IN_PROGRESS",
+ "PENDING_SHIPMENT",
+ "PARTIALLY_SHIPPED",
+ "SHIPPED",
+ "PARTIALLY_DELIVERED",
+ "DELIVERED",
+ "PARTIALLY_RETURNED",
+ "RETURNED"
+ ],
+ "description": "Obtains orders that match any of the specified statuses. Please note that `active` is a shortcut for `pendingShipment` and `partiallyShipped`, and `completed` is a shortcut for `shipped`, `partiallyDelivered`, `delivered`, `partiallyReturned`, `returned`, and `canceled`.",
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "location": "query",
+ "repeated": true
+ },
+ "merchantId": {
+ "format": "uint64",
+ "type": "string",
+ "description": "The ID of the account that manages the order. This cannot be a multi-client account.",
+ "location": "path",
+ "required": true
+ },
+ "placedDateStart": {
+ "type": "string",
+ "location": "query",
+ "description": "Obtains orders placed after this date (inclusively), in ISO 8601 format."
+ },
+ "orderBy": {
+ "type": "string",
+ "description": "Order results by placement date in descending or ascending order. Acceptable values are: - placedDateAsc - placedDateDesc ",
+ "location": "query"
+ },
+ "acknowledged": {
+ "type": "boolean",
+ "description": "Obtains orders that match the acknowledgement status. When set to true, obtains orders that have been acknowledged. When false, obtains orders that have not been acknowledged. We recommend using this filter set to `false`, in conjunction with the `acknowledge` call, such that only un-acknowledged orders are returned. ",
+ "location": "query"
+ },
+ "maxResults": {
+ "location": "query",
+ "description": "The maximum number of orders to return in the response, used for paging. The default value is 25 orders per page, and the maximum allowed value is 250 orders per page.",
+ "type": "integer",
+ "format": "uint32"
+ }
+ }
+ },
+ "cancellineitem": {
+ "description": "Cancels a line item, making a full refund.",
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ],
+ "parameterOrder": [
+ "merchantId",
+ "orderId"
+ ],
+ "flatPath": "content/v2/{merchantId}/orders/{orderId}/cancelLineItem",
+ "id": "content.orders.cancellineitem",
+ "httpMethod": "POST",
+ "request": {
+ "$ref": "OrdersCancelLineItemRequest"
+ },
+ "response": {
+ "$ref": "OrdersCancelLineItemResponse"
+ },
+ "parameters": {
+ "merchantId": {
+ "required": true,
+ "type": "string",
+ "format": "uint64",
+ "location": "path",
+ "description": "The ID of the account that manages the order. This cannot be a multi-client account."
+ },
+ "orderId": {
+ "location": "path",
+ "type": "string",
+ "description": "The ID of the order.",
+ "required": true
+ }
+ },
+ "path": "content/v2/{merchantId}/orders/{orderId}/cancelLineItem"
+ },
+ "updateshipment": {
+ "parameters": {
+ "merchantId": {
+ "type": "string",
+ "required": true,
+ "format": "uint64",
+ "description": "The ID of the account that manages the order. This cannot be a multi-client account.",
+ "location": "path"
+ },
+ "orderId": {
+ "required": true,
+ "location": "path",
+ "type": "string",
+ "description": "The ID of the order."
+ }
+ },
+ "request": {
+ "$ref": "OrdersUpdateShipmentRequest"
+ },
+ "response": {
+ "$ref": "OrdersUpdateShipmentResponse"
+ },
+ "flatPath": "content/v2/{merchantId}/orders/{orderId}/updateShipment",
+ "parameterOrder": [
+ "merchantId",
+ "orderId"
+ ],
+ "httpMethod": "POST",
+ "id": "content.orders.updateshipment",
+ "path": "content/v2/{merchantId}/orders/{orderId}/updateShipment",
+ "description": "Updates a shipment's status, carrier, and/or tracking ID.",
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "setlineitemmetadata": {
+ "parameters": {
+ "merchantId": {
+ "description": "The ID of the account that manages the order. This cannot be a multi-client account.",
+ "location": "path",
+ "required": true,
+ "type": "string",
+ "format": "uint64"
+ },
+ "orderId": {
+ "description": "The ID of the order.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "merchantId",
+ "orderId"
+ ],
+ "response": {
+ "$ref": "OrdersSetLineItemMetadataResponse"
+ },
+ "id": "content.orders.setlineitemmetadata",
+ "request": {
+ "$ref": "OrdersSetLineItemMetadataRequest"
+ },
+ "flatPath": "content/v2/{merchantId}/orders/{orderId}/setLineItemMetadata",
+ "path": "content/v2/{merchantId}/orders/{orderId}/setLineItemMetadata",
+ "description": "Sets (or overrides if it already exists) merchant provided annotations in the form of key-value pairs. A common use case would be to supply us with additional structured information about a line item that cannot be provided via other methods. Submitted key-value pairs can be retrieved as part of the orders resource.",
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "advancetestorder": {
+ "parameters": {
+ "merchantId": {
+ "required": true,
+ "location": "path",
+ "format": "uint64",
+ "type": "string",
+ "description": "The ID of the account that manages the order. This cannot be a multi-client account."
+ },
+ "orderId": {
+ "required": true,
+ "type": "string",
+ "description": "The ID of the test order to modify.",
+ "location": "path"
+ }
+ },
+ "httpMethod": "POST",
+ "description": "Sandbox only. Moves a test order from state \"`inProgress`\" to state \"`pendingShipment`\".",
+ "parameterOrder": [
+ "merchantId",
+ "orderId"
+ ],
+ "id": "content.orders.advancetestorder",
+ "flatPath": "content/v2/{merchantId}/testorders/{orderId}/advance",
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ],
+ "response": {
+ "$ref": "OrdersAdvanceTestOrderResponse"
+ },
+ "path": "content/v2/{merchantId}/testorders/{orderId}/advance"
+ },
+ "createtestreturn": {
+ "httpMethod": "POST",
+ "request": {
+ "$ref": "OrdersCreateTestReturnRequest"
+ },
+ "id": "content.orders.createtestreturn",
+ "parameters": {
+ "orderId": {
+ "type": "string",
+ "description": "The ID of the order.",
+ "required": true,
+ "location": "path"
+ },
+ "merchantId": {
+ "description": "The ID of the account that manages the order. This cannot be a multi-client account.",
+ "location": "path",
+ "format": "uint64",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "response": {
+ "$ref": "OrdersCreateTestReturnResponse"
+ },
+ "parameterOrder": [
+ "merchantId",
+ "orderId"
+ ],
+ "description": "Sandbox only. Creates a test return.",
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ],
+ "flatPath": "content/v2/{merchantId}/orders/{orderId}/testreturn",
+ "path": "content/v2/{merchantId}/orders/{orderId}/testreturn"
+ }
+ }
+ },
+ "products": {
+ "methods": {
+ "delete": {
+ "httpMethod": "DELETE",
+ "flatPath": "content/v2/{merchantId}/products/{productId}",
+ "description": "Deletes a product from your Merchant Center account.",
+ "path": "content/v2/{merchantId}/products/{productId}",
+ "id": "content.products.delete",
+ "parameterOrder": [
+ "merchantId",
+ "productId"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ],
+ "parameters": {
+ "dryRun": {
+ "location": "query",
+ "type": "boolean",
+ "description": "Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any)."
+ },
+ "productId": {
+ "description": "The REST ID of the product.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "merchantId": {
+ "required": true,
+ "description": "The ID of the account that contains the product. This account cannot be a multi-client account.",
+ "location": "path",
+ "format": "uint64",
+ "type": "string"
+ }
+ }
+ },
+ "insert": {
+ "path": "content/v2/{merchantId}/products",
+ "description": "Uploads a product to your Merchant Center account. If an item with the same channel, contentLanguage, offerId, and targetCountry already exists, this method updates that entry.",
+ "flatPath": "content/v2/{merchantId}/products",
+ "response": {
+ "$ref": "Product"
+ },
+ "httpMethod": "POST",
+ "id": "content.products.insert",
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ],
+ "request": {
+ "$ref": "Product"
+ },
+ "parameterOrder": [
+ "merchantId"
+ ],
+ "parameters": {
+ "merchantId": {
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string",
+ "description": "The ID of the account that contains the product. This account cannot be a multi-client account."
+ },
+ "dryRun": {
+ "location": "query",
+ "type": "boolean",
+ "description": "Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any)."
+ }
+ }
+ },
+ "get": {
+ "description": "Retrieves a product from your Merchant Center account.",
+ "id": "content.products.get",
+ "path": "content/v2/{merchantId}/products/{productId}",
+ "flatPath": "content/v2/{merchantId}/products/{productId}",
+ "response": {
+ "$ref": "Product"
+ },
+ "parameterOrder": [
+ "merchantId",
+ "productId"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ],
+ "parameters": {
+ "productId": {
+ "type": "string",
+ "location": "path",
+ "description": "The REST ID of the product.",
+ "required": true
+ },
+ "merchantId": {
+ "required": true,
+ "description": "The ID of the account that contains the product. This account cannot be a multi-client account.",
+ "type": "string",
+ "location": "path",
+ "format": "uint64"
+ }
+ },
+ "httpMethod": "GET"
+ },
+ "custombatch": {
+ "httpMethod": "POST",
+ "response": {
+ "$ref": "ProductsCustomBatchResponse"
+ },
+ "parameters": {
+ "dryRun": {
+ "description": "Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).",
+ "type": "boolean",
+ "location": "query"
+ }
+ },
+ "request": {
+ "$ref": "ProductsCustomBatchRequest"
+ },
+ "description": "Retrieves, inserts, and deletes multiple products in a single request.",
+ "flatPath": "content/v2/products/batch",
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ],
+ "id": "content.products.custombatch",
+ "parameterOrder": [],
+ "path": "content/v2/products/batch"
+ },
+ "list": {
+ "description": "Lists the products in your Merchant Center account. The response might contain fewer items than specified by maxResults. Rely on nextPageToken to determine if there are more items to be requested.",
+ "parameters": {
+ "includeInvalidInsertedItems": {
+ "location": "query",
+ "type": "boolean",
+ "description": "Flag to include the invalid inserted items in the result of the list request. By default the invalid items are not shown (the default value is false)."
+ },
+ "maxResults": {
+ "type": "integer",
+ "location": "query",
+ "description": "The maximum number of products to return in the response, used for paging.",
+ "format": "uint32"
+ },
+ "merchantId": {
+ "required": true,
+ "location": "path",
+ "description": "The ID of the account that contains the products. This account cannot be a multi-client account.",
+ "type": "string",
+ "format": "uint64"
+ },
+ "pageToken": {
+ "type": "string",
+ "location": "query",
+ "description": "The token returned by the previous request."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ],
+ "parameterOrder": [
+ "merchantId"
+ ],
+ "path": "content/v2/{merchantId}/products",
+ "id": "content.products.list",
+ "response": {
+ "$ref": "ProductsListResponse"
+ },
+ "httpMethod": "GET",
+ "flatPath": "content/v2/{merchantId}/products"
+ }
+ }
+ },
+ "shippingsettings": {
+ "methods": {
+ "getsupportedcarriers": {
+ "flatPath": "content/v2/{merchantId}/supportedCarriers",
+ "description": "Retrieves supported carriers and carrier services for an account.",
+ "id": "content.shippingsettings.getsupportedcarriers",
+ "parameterOrder": [
+ "merchantId"
+ ],
+ "response": {
+ "$ref": "ShippingsettingsGetSupportedCarriersResponse"
+ },
+ "httpMethod": "GET",
+ "parameters": {
+ "merchantId": {
+ "location": "path",
+ "description": "The ID of the account for which to retrieve the supported carriers.",
+ "required": true,
+ "format": "uint64",
+ "type": "string"
+ }
+ },
+ "path": "content/v2/{merchantId}/supportedCarriers",
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "update": {
+ "parameterOrder": [
+ "merchantId",
+ "accountId"
+ ],
+ "path": "content/v2/{merchantId}/shippingsettings/{accountId}",
+ "description": "Updates the shipping settings of the account. Any fields that are not provided are deleted from the resource.",
+ "response": {
+ "$ref": "ShippingSettings"
+ },
+ "httpMethod": "PUT",
+ "request": {
+ "$ref": "ShippingSettings"
+ },
+ "flatPath": "content/v2/{merchantId}/shippingsettings/{accountId}",
+ "id": "content.shippingsettings.update",
+ "parameters": {
+ "dryRun": {
+ "description": "Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).",
+ "type": "boolean",
+ "location": "query"
+ },
+ "merchantId": {
+ "required": true,
+ "location": "path",
+ "type": "string",
+ "format": "uint64",
+ "description": "The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account."
+ },
+ "accountId": {
+ "format": "uint64",
+ "required": true,
+ "description": "The ID of the account for which to get/update shipping settings.",
+ "location": "path",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "getsupportedholidays": {
+ "path": "content/v2/{merchantId}/supportedHolidays",
+ "httpMethod": "GET",
+ "parameters": {
+ "merchantId": {
+ "format": "uint64",
+ "type": "string",
+ "description": "The ID of the account for which to retrieve the supported holidays.",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "id": "content.shippingsettings.getsupportedholidays",
+ "description": "Retrieves supported holidays for an account.",
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ],
+ "response": {
+ "$ref": "ShippingsettingsGetSupportedHolidaysResponse"
+ },
+ "parameterOrder": [
+ "merchantId"
+ ],
+ "flatPath": "content/v2/{merchantId}/supportedHolidays"
+ },
+ "getsupportedpickupservices": {
+ "parameters": {
+ "merchantId": {
+ "type": "string",
+ "required": true,
+ "description": "The ID of the account for which to retrieve the supported pickup services.",
+ "location": "path",
+ "format": "uint64"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ],
+ "description": "Retrieves supported pickup services for an account.",
+ "parameterOrder": [
+ "merchantId"
+ ],
+ "response": {
+ "$ref": "ShippingsettingsGetSupportedPickupServicesResponse"
+ },
+ "path": "content/v2/{merchantId}/supportedPickupServices",
+ "id": "content.shippingsettings.getsupportedpickupservices",
+ "httpMethod": "GET",
+ "flatPath": "content/v2/{merchantId}/supportedPickupServices"
+ },
+ "get": {
+ "id": "content.shippingsettings.get",
+ "parameterOrder": [
+ "merchantId",
+ "accountId"
+ ],
+ "path": "content/v2/{merchantId}/shippingsettings/{accountId}",
+ "httpMethod": "GET",
+ "description": "Retrieves the shipping settings of the account.",
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ],
+ "flatPath": "content/v2/{merchantId}/shippingsettings/{accountId}",
+ "response": {
+ "$ref": "ShippingSettings"
+ },
+ "parameters": {
+ "accountId": {
+ "description": "The ID of the account for which to get/update shipping settings.",
+ "type": "string",
+ "format": "uint64",
+ "required": true,
+ "location": "path"
+ },
+ "merchantId": {
+ "description": "The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.",
+ "location": "path",
+ "type": "string",
+ "required": true,
+ "format": "uint64"
+ }
+ }
+ },
+ "list": {
+ "response": {
+ "$ref": "ShippingsettingsListResponse"
+ },
+ "httpMethod": "GET",
+ "id": "content.shippingsettings.list",
+ "parameterOrder": [
+ "merchantId"
+ ],
+ "path": "content/v2/{merchantId}/shippingsettings",
+ "description": "Lists the shipping settings of the sub-accounts in your Merchant Center account.",
+ "flatPath": "content/v2/{merchantId}/shippingsettings",
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ],
+ "parameters": {
+ "maxResults": {
+ "location": "query",
+ "type": "integer",
+ "format": "uint32",
+ "description": "The maximum number of shipping settings to return in the response, used for paging."
+ },
+ "merchantId": {
+ "description": "The ID of the managing account. This must be a multi-client account.",
+ "format": "uint64",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "pageToken": {
+ "type": "string",
+ "location": "query",
+ "description": "The token returned by the previous request."
+ }
+ }
+ },
+ "custombatch": {
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "path": "content/v2/shippingsettings/batch",
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ],
+ "response": {
+ "$ref": "ShippingsettingsCustomBatchResponse"
+ },
+ "request": {
+ "$ref": "ShippingsettingsCustomBatchRequest"
+ },
+ "flatPath": "content/v2/shippingsettings/batch",
+ "id": "content.shippingsettings.custombatch",
+ "description": "Retrieves and updates the shipping settings of multiple accounts in a single request.",
+ "parameters": {
+ "dryRun": {
+ "description": "Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).",
+ "location": "query",
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "liasettings": {
+ "methods": {
+ "setposdataprovider": {
+ "parameterOrder": [
+ "merchantId",
+ "accountId",
+ "country"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ],
+ "description": "Sets the POS data provider for the specified country.",
+ "flatPath": "content/v2/{merchantId}/liasettings/{accountId}/setposdataprovider",
+ "id": "content.liasettings.setposdataprovider",
+ "response": {
+ "$ref": "LiasettingsSetPosDataProviderResponse"
+ },
+ "path": "content/v2/{merchantId}/liasettings/{accountId}/setposdataprovider",
+ "parameters": {
+ "posExternalAccountId": {
+ "type": "string",
+ "location": "query",
+ "description": "The account ID by which this merchant is known to the POS data provider."
+ },
+ "posDataProviderId": {
+ "format": "uint64",
+ "description": "The ID of POS data provider.",
+ "location": "query",
+ "type": "string"
+ },
+ "merchantId": {
+ "format": "uint64",
+ "type": "string",
+ "required": true,
+ "description": "The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.",
+ "location": "path"
+ },
+ "accountId": {
+ "location": "path",
+ "type": "string",
+ "description": "The ID of the account for which to retrieve accessible Google My Business accounts.",
+ "required": true,
+ "format": "uint64"
+ },
+ "country": {
+ "type": "string",
+ "description": "The country for which the POS data provider is selected.",
+ "required": true,
+ "location": "query"
+ }
+ }
+ },
+ "custombatch": {
+ "description": "Retrieves and/or updates the LIA settings of multiple accounts in a single request.",
+ "httpMethod": "POST",
+ "id": "content.liasettings.custombatch",
+ "request": {
+ "$ref": "LiasettingsCustomBatchRequest"
+ },
+ "flatPath": "content/v2/liasettings/batch",
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ],
+ "parameters": {
+ "dryRun": {
+ "type": "boolean",
+ "description": "Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).",
+ "location": "query"
+ }
+ },
+ "response": {
+ "$ref": "LiasettingsCustomBatchResponse"
+ },
+ "path": "content/v2/liasettings/batch",
+ "parameterOrder": []
+ },
+ "get": {
+ "httpMethod": "GET",
+ "id": "content.liasettings.get",
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ],
+ "parameters": {
+ "merchantId": {
+ "description": "The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "accountId": {
+ "type": "string",
+ "required": true,
+ "format": "uint64",
+ "location": "path",
+ "description": "The ID of the account for which to get or update LIA settings."
+ }
+ },
+ "path": "content/v2/{merchantId}/liasettings/{accountId}",
+ "flatPath": "content/v2/{merchantId}/liasettings/{accountId}",
+ "description": "Retrieves the LIA settings of the account.",
+ "response": {
+ "$ref": "LiaSettings"
+ },
+ "parameterOrder": [
+ "merchantId",
+ "accountId"
+ ]
+ },
+ "setinventoryverificationcontact": {
+ "flatPath": "content/v2/{merchantId}/liasettings/{accountId}/setinventoryverificationcontact",
+ "httpMethod": "POST",
+ "description": "Sets the inventory verification contract for the specified country.",
+ "id": "content.liasettings.setinventoryverificationcontact",
+ "response": {
+ "$ref": "LiasettingsSetInventoryVerificationContactResponse"
+ },
+ "path": "content/v2/{merchantId}/liasettings/{accountId}/setinventoryverificationcontact",
+ "parameters": {
+ "contactName": {
+ "type": "string",
+ "description": "The name of the inventory verification contact.",
+ "required": true,
+ "location": "query"
+ },
+ "contactEmail": {
+ "required": true,
+ "description": "The email of the inventory verification contact.",
+ "location": "query",
+ "type": "string"
+ },
+ "country": {
+ "location": "query",
+ "description": "The country for which inventory verification is requested.",
+ "type": "string",
+ "required": true
+ },
+ "accountId": {
+ "description": "The ID of the account that manages the order. This cannot be a multi-client account.",
+ "type": "string",
+ "required": true,
+ "format": "uint64",
+ "location": "path"
+ },
+ "merchantId": {
+ "required": true,
+ "description": "The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.",
+ "location": "path",
+ "type": "string",
+ "format": "uint64"
+ },
+ "language": {
+ "type": "string",
+ "required": true,
+ "description": "The language for which inventory verification is requested.",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ],
+ "parameterOrder": [
+ "merchantId",
+ "accountId",
+ "country",
+ "language",
+ "contactName",
+ "contactEmail"
+ ]
+ },
+ "requestgmbaccess": {
+ "flatPath": "content/v2/{merchantId}/liasettings/{accountId}/requestgmbaccess",
+ "id": "content.liasettings.requestgmbaccess",
+ "description": "Requests access to a specified Google My Business account.",
+ "parameterOrder": [
+ "merchantId",
+ "accountId",
+ "gmbEmail"
+ ],
+ "path": "content/v2/{merchantId}/liasettings/{accountId}/requestgmbaccess",
+ "parameters": {
+ "merchantId": {
+ "location": "path",
+ "type": "string",
+ "format": "uint64",
+ "description": "The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.",
+ "required": true
+ },
+ "accountId": {
+ "required": true,
+ "format": "uint64",
+ "location": "path",
+ "description": "The ID of the account for which GMB access is requested.",
+ "type": "string"
+ },
+ "gmbEmail": {
+ "location": "query",
+ "description": "The email of the Google My Business account.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ],
+ "response": {
+ "$ref": "LiasettingsRequestGmbAccessResponse"
+ },
+ "httpMethod": "POST"
+ },
+ "update": {
+ "request": {
+ "$ref": "LiaSettings"
+ },
+ "httpMethod": "PUT",
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ],
+ "parameterOrder": [
+ "merchantId",
+ "accountId"
+ ],
+ "id": "content.liasettings.update",
+ "parameters": {
+ "dryRun": {
+ "location": "query",
+ "description": "Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).",
+ "type": "boolean"
+ },
+ "merchantId": {
+ "description": "The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.",
+ "location": "path",
+ "format": "uint64",
+ "type": "string",
+ "required": true
+ },
+ "accountId": {
+ "location": "path",
+ "format": "uint64",
+ "type": "string",
+ "description": "The ID of the account for which to get or update LIA settings.",
+ "required": true
+ }
+ },
+ "path": "content/v2/{merchantId}/liasettings/{accountId}",
+ "flatPath": "content/v2/{merchantId}/liasettings/{accountId}",
+ "response": {
+ "$ref": "LiaSettings"
+ },
+ "description": "Updates the LIA settings of the account. Any fields that are not provided are deleted from the resource."
+ },
+ "requestinventoryverification": {
+ "description": "Requests inventory validation for the specified country.",
+ "path": "content/v2/{merchantId}/liasettings/{accountId}/requestinventoryverification/{country}",
+ "flatPath": "content/v2/{merchantId}/liasettings/{accountId}/requestinventoryverification/{country}",
+ "response": {
+ "$ref": "LiasettingsRequestInventoryVerificationResponse"
+ },
+ "id": "content.liasettings.requestinventoryverification",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "merchantId",
+ "accountId",
+ "country"
+ ],
+ "parameters": {
+ "accountId": {
+ "type": "string",
+ "location": "path",
+ "required": true,
+ "format": "uint64",
+ "description": "The ID of the account that manages the order. This cannot be a multi-client account."
+ },
+ "merchantId": {
+ "location": "path",
+ "format": "uint64",
+ "type": "string",
+ "description": "The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.",
+ "required": true
+ },
+ "country": {
+ "required": true,
+ "location": "path",
+ "type": "string",
+ "description": "The country for which inventory validation is requested."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "list": {
+ "description": "Lists the LIA settings of the sub-accounts in your Merchant Center account.",
+ "flatPath": "content/v2/{merchantId}/liasettings",
+ "httpMethod": "GET",
+ "id": "content.liasettings.list",
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ],
+ "response": {
+ "$ref": "LiasettingsListResponse"
+ },
+ "parameterOrder": [
+ "merchantId"
+ ],
+ "path": "content/v2/{merchantId}/liasettings",
+ "parameters": {
+ "pageToken": {
+ "description": "The token returned by the previous request.",
+ "type": "string",
+ "location": "query"
+ },
+ "merchantId": {
+ "description": "The ID of the managing account. This must be a multi-client account.",
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "format": "uint64"
+ },
+ "maxResults": {
+ "format": "uint32",
+ "type": "integer",
+ "description": "The maximum number of LIA settings to return in the response, used for paging.",
+ "location": "query"
+ }
+ }
+ },
+ "getaccessiblegmbaccounts": {
+ "path": "content/v2/{merchantId}/liasettings/{accountId}/accessiblegmbaccounts",
+ "response": {
+ "$ref": "LiasettingsGetAccessibleGmbAccountsResponse"
+ },
+ "httpMethod": "GET",
+ "parameters": {
+ "accountId": {
+ "location": "path",
+ "description": "The ID of the account for which to retrieve accessible Google My Business accounts.",
+ "format": "uint64",
+ "type": "string",
+ "required": true
+ },
+ "merchantId": {
+ "type": "string",
+ "format": "uint64",
+ "location": "path",
+ "required": true,
+ "description": "The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account."
+ }
+ },
+ "flatPath": "content/v2/{merchantId}/liasettings/{accountId}/accessiblegmbaccounts",
+ "parameterOrder": [
+ "merchantId",
+ "accountId"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ],
+ "description": "Retrieves the list of accessible Google My Business accounts.",
+ "id": "content.liasettings.getaccessiblegmbaccounts"
+ },
+ "listposdataproviders": {
+ "response": {
+ "$ref": "LiasettingsListPosDataProvidersResponse"
+ },
+ "parameterOrder": [],
+ "id": "content.liasettings.listposdataproviders",
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ],
+ "httpMethod": "GET",
+ "path": "content/v2/liasettings/posdataproviders",
+ "flatPath": "content/v2/liasettings/posdataproviders",
+ "description": "Retrieves the list of POS data providers that have active settings for the all eiligible countries.",
+ "parameters": {}
+ }
+ }
+ },
+ "orderreports": {
+ "methods": {
+ "listdisbursements": {
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ],
+ "id": "content.orderreports.listdisbursements",
+ "flatPath": "content/v2/{merchantId}/orderreports/disbursements",
+ "response": {
+ "$ref": "OrderreportsListDisbursementsResponse"
+ },
+ "description": "Retrieves a report for disbursements from your Merchant Center account.",
+ "parameterOrder": [
+ "merchantId"
+ ],
+ "parameters": {
+ "disbursementEndDate": {
+ "type": "string",
+ "description": "The last date which disbursements occurred. In ISO 8601 format. Default: current date.",
+ "location": "query"
+ },
+ "disbursementStartDate": {
+ "type": "string",
+ "location": "query",
+ "description": "The first date which disbursements occurred. In ISO 8601 format."
+ },
+ "maxResults": {
+ "description": "The maximum number of disbursements to return in the response, used for paging.",
+ "type": "integer",
+ "location": "query",
+ "format": "uint32"
+ },
+ "merchantId": {
+ "required": true,
+ "description": "The ID of the account that manages the order. This cannot be a multi-client account.",
+ "type": "string",
+ "format": "uint64",
+ "location": "path"
+ },
+ "pageToken": {
+ "location": "query",
+ "type": "string",
+ "description": "The token returned by the previous request."
+ }
+ },
+ "path": "content/v2/{merchantId}/orderreports/disbursements"
+ },
+ "listtransactions": {
+ "parameterOrder": [
+ "merchantId",
+ "disbursementId"
+ ],
+ "response": {
+ "$ref": "OrderreportsListTransactionsResponse"
+ },
+ "parameters": {
+ "disbursementId": {
+ "required": true,
+ "description": "The Google-provided ID of the disbursement (found in Wallet).",
+ "type": "string",
+ "location": "path"
+ },
+ "maxResults": {
+ "description": "The maximum number of disbursements to return in the response, used for paging.",
+ "type": "integer",
+ "location": "query",
+ "format": "uint32"
+ },
+ "transactionEndDate": {
+ "description": "The last date in which transaction occurred. In ISO 8601 format. Default: current date.",
+ "type": "string",
+ "location": "query"
+ },
+ "merchantId": {
+ "format": "uint64",
+ "required": true,
+ "description": "The ID of the account that manages the order. This cannot be a multi-client account.",
+ "type": "string",
+ "location": "path"
+ },
+ "transactionStartDate": {
+ "type": "string",
+ "location": "query",
+ "description": "The first date in which transaction occurred. In ISO 8601 format."
+ },
+ "pageToken": {
+ "description": "The token returned by the previous request.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "id": "content.orderreports.listtransactions",
+ "flatPath": "content/v2/{merchantId}/orderreports/disbursements/{disbursementId}/transactions",
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ],
+ "path": "content/v2/{merchantId}/orderreports/disbursements/{disbursementId}/transactions",
+ "httpMethod": "GET",
+ "description": "Retrieves a list of transactions for a disbursement from your Merchant Center account."
+ }
+ }
+ },
+ "accounttax": {
+ "methods": {
+ "get": {
+ "path": "content/v2/{merchantId}/accounttax/{accountId}",
+ "flatPath": "content/v2/{merchantId}/accounttax/{accountId}",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "AccountTax"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ],
+ "id": "content.accounttax.get",
+ "description": "Retrieves the tax settings of the account.",
+ "parameterOrder": [
+ "merchantId",
+ "accountId"
+ ],
+ "parameters": {
+ "merchantId": {
+ "location": "path",
+ "required": true,
+ "type": "string",
+ "description": "The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.",
+ "format": "uint64"
+ },
+ "accountId": {
+ "format": "uint64",
+ "description": "The ID of the account for which to get/update account tax settings.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ }
+ },
+ "list": {
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ],
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "AccounttaxListResponse"
+ },
+ "parameters": {
+ "pageToken": {
+ "type": "string",
+ "description": "The token returned by the previous request.",
+ "location": "query"
+ },
+ "merchantId": {
+ "type": "string",
+ "format": "uint64",
+ "required": true,
+ "description": "The ID of the managing account. This must be a multi-client account.",
+ "location": "path"
+ },
+ "maxResults": {
+ "location": "query",
+ "type": "integer",
+ "description": "The maximum number of tax settings to return in the response, used for paging.",
+ "format": "uint32"
+ }
+ },
+ "flatPath": "content/v2/{merchantId}/accounttax",
+ "id": "content.accounttax.list",
+ "path": "content/v2/{merchantId}/accounttax",
+ "description": "Lists the tax settings of the sub-accounts in your Merchant Center account.",
+ "parameterOrder": [
+ "merchantId"
+ ]
+ },
+ "update": {
+ "path": "content/v2/{merchantId}/accounttax/{accountId}",
+ "response": {
+ "$ref": "AccountTax"
+ },
+ "flatPath": "content/v2/{merchantId}/accounttax/{accountId}",
+ "description": "Updates the tax settings of the account. Any fields that are not provided are deleted from the resource.",
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ],
+ "parameterOrder": [
+ "merchantId",
+ "accountId"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "The ID of the account for which to get/update account tax settings.",
+ "location": "path",
+ "required": true,
+ "format": "uint64",
+ "type": "string"
+ },
+ "dryRun": {
+ "description": "Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).",
+ "type": "boolean",
+ "location": "query"
+ },
+ "merchantId": {
+ "format": "uint64",
+ "type": "string",
+ "location": "path",
+ "description": "The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.",
+ "required": true
+ }
+ },
+ "request": {
+ "$ref": "AccountTax"
+ },
+ "httpMethod": "PUT",
+ "id": "content.accounttax.update"
+ },
+ "custombatch": {
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ],
+ "flatPath": "content/v2/accounttax/batch",
+ "description": "Retrieves and updates tax settings of multiple accounts in a single request.",
+ "response": {
+ "$ref": "AccounttaxCustomBatchResponse"
+ },
+ "id": "content.accounttax.custombatch",
+ "parameters": {
+ "dryRun": {
+ "description": "Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).",
+ "location": "query",
+ "type": "boolean"
+ }
+ },
+ "parameterOrder": [],
+ "path": "content/v2/accounttax/batch",
+ "request": {
+ "$ref": "AccounttaxCustomBatchRequest"
+ }
+ }
+ }
+ },
+ "orderreturns": {
+ "methods": {
+ "list": {
+ "httpMethod": "GET",
+ "id": "content.orderreturns.list",
+ "response": {
+ "$ref": "OrderreturnsListResponse"
+ },
+ "flatPath": "content/v2/{merchantId}/orderreturns",
+ "parameterOrder": [
+ "merchantId"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ],
+ "path": "content/v2/{merchantId}/orderreturns",
+ "description": "Lists order returns in your Merchant Center account.",
+ "parameters": {
+ "createdStartDate": {
+ "type": "string",
+ "description": "Obtains order returns created after this date (inclusively), in ISO 8601 format.",
+ "location": "query"
+ },
+ "merchantId": {
+ "location": "path",
+ "format": "uint64",
+ "description": "The ID of the account that manages the order. This cannot be a multi-client account.",
+ "type": "string",
+ "required": true
+ },
+ "maxResults": {
+ "location": "query",
+ "type": "integer",
+ "description": "The maximum number of order returns to return in the response, used for paging. The default value is 25 returns per page, and the maximum allowed value is 250 returns per page.",
+ "format": "uint32"
+ },
+ "orderBy": {
+ "enum": [
+ "RETURN_CREATION_TIME_DESC",
+ "RETURN_CREATION_TIME_ASC"
+ ],
+ "type": "string",
+ "description": "Return the results in the specified order.",
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query"
+ },
+ "createdEndDate": {
+ "type": "string",
+ "location": "query",
+ "description": "Obtains order returns created before this date (inclusively), in ISO 8601 format."
+ },
+ "pageToken": {
+ "type": "string",
+ "location": "query",
+ "description": "The token returned by the previous request."
+ }
+ }
+ },
+ "get": {
+ "id": "content.orderreturns.get",
+ "parameters": {
+ "merchantId": {
+ "required": true,
+ "type": "string",
+ "format": "uint64",
+ "location": "path",
+ "description": "The ID of the account that manages the order. This cannot be a multi-client account."
+ },
+ "returnId": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "Merchant order return ID generated by Google."
+ }
+ },
+ "response": {
+ "$ref": "MerchantOrderReturn"
+ },
+ "parameterOrder": [
+ "merchantId",
+ "returnId"
+ ],
+ "httpMethod": "GET",
+ "flatPath": "content/v2/{merchantId}/orderreturns/{returnId}",
+ "path": "content/v2/{merchantId}/orderreturns/{returnId}",
+ "description": "Retrieves an order return from your Merchant Center account.",
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ }
+ }
+ },
+ "accountstatuses": {
+ "methods": {
+ "get": {
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ],
+ "description": "Retrieves the status of a Merchant Center account. No itemLevelIssues are returned for multi-client accounts.",
+ "parameterOrder": [
+ "merchantId",
+ "accountId"
+ ],
+ "httpMethod": "GET",
+ "flatPath": "content/v2/{merchantId}/accountstatuses/{accountId}",
+ "id": "content.accountstatuses.get",
+ "response": {
+ "$ref": "AccountStatus"
+ },
+ "parameters": {
+ "merchantId": {
+ "location": "path",
+ "type": "string",
+ "description": "The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.",
+ "format": "uint64",
+ "required": true
+ },
+ "accountId": {
+ "format": "uint64",
+ "type": "string",
+ "location": "path",
+ "description": "The ID of the account.",
+ "required": true
+ },
+ "destinations": {
+ "description": "If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination.",
+ "type": "string",
+ "repeated": true,
+ "location": "query"
+ }
+ },
+ "path": "content/v2/{merchantId}/accountstatuses/{accountId}"
+ },
+ "list": {
+ "id": "content.accountstatuses.list",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "AccountstatusesListResponse"
+ },
+ "flatPath": "content/v2/{merchantId}/accountstatuses",
+ "parameters": {
+ "destinations": {
+ "location": "query",
+ "type": "string",
+ "description": "If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination.",
+ "repeated": true
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "The token returned by the previous request.",
+ "type": "string"
+ },
+ "maxResults": {
+ "type": "integer",
+ "description": "The maximum number of account statuses to return in the response, used for paging.",
+ "location": "query",
+ "format": "uint32"
+ },
+ "merchantId": {
+ "format": "uint64",
+ "description": "The ID of the managing account. This must be a multi-client account.",
+ "required": true,
+ "location": "path",
+ "type": "string"
+ }
+ },
+ "description": "Lists the statuses of the sub-accounts in your Merchant Center account.",
+ "path": "content/v2/{merchantId}/accountstatuses",
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ],
+ "parameterOrder": [
+ "merchantId"
+ ]
+ },
+ "custombatch": {
+ "description": "Retrieves multiple Merchant Center account statuses in a single request.",
+ "parameterOrder": [],
+ "path": "content/v2/accountstatuses/batch",
+ "httpMethod": "POST",
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ],
+ "response": {
+ "$ref": "AccountstatusesCustomBatchResponse"
+ },
+ "id": "content.accountstatuses.custombatch",
+ "flatPath": "content/v2/accountstatuses/batch",
+ "request": {
+ "$ref": "AccountstatusesCustomBatchRequest"
+ }
+ }
+ }
+ },
+ "datafeedstatuses": {
+ "methods": {
+ "get": {
+ "description": "Retrieves the status of a datafeed from your Merchant Center account.",
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ],
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "DatafeedStatus"
+ },
+ "id": "content.datafeedstatuses.get",
+ "flatPath": "content/v2/{merchantId}/datafeedstatuses/{datafeedId}",
+ "path": "content/v2/{merchantId}/datafeedstatuses/{datafeedId}",
+ "parameters": {
+ "merchantId": {
+ "type": "string",
+ "format": "uint64",
+ "required": true,
+ "location": "path",
+ "description": "The ID of the account that manages the datafeed. This account cannot be a multi-client account."
+ },
+ "datafeedId": {
+ "required": true,
+ "format": "uint64",
+ "type": "string",
+ "description": "The ID of the datafeed.",
+ "location": "path"
+ },
+ "language": {
+ "type": "string",
+ "location": "query",
+ "description": "The language for which to get the datafeed status. If this parameter is provided then country must also be provided. Note that this parameter is required for feeds targeting multiple countries and languages, since a feed may have a different status for each target."
+ },
+ "country": {
+ "location": "query",
+ "description": "The country for which to get the datafeed status. If this parameter is provided then language must also be provided. Note that this parameter is required for feeds targeting multiple countries and languages, since a feed may have a different status for each target.",
+ "type": "string"
+ }
+ },
+ "parameterOrder": [
+ "merchantId",
+ "datafeedId"
+ ]
+ },
+ "list": {
+ "parameters": {
+ "pageToken": {
+ "description": "The token returned by the previous request.",
+ "location": "query",
+ "type": "string"
+ },
+ "merchantId": {
+ "type": "string",
+ "description": "The ID of the account that manages the datafeeds. This account cannot be a multi-client account.",
+ "required": true,
+ "format": "uint64",
+ "location": "path"
+ },
+ "maxResults": {
+ "type": "integer",
+ "format": "uint32",
+ "description": "The maximum number of products to return in the response, used for paging.",
+ "location": "query"
+ }
+ },
+ "httpMethod": "GET",
+ "id": "content.datafeedstatuses.list",
+ "description": "Lists the statuses of the datafeeds in your Merchant Center account.",
+ "flatPath": "content/v2/{merchantId}/datafeedstatuses",
+ "parameterOrder": [
+ "merchantId"
+ ],
+ "path": "content/v2/{merchantId}/datafeedstatuses",
+ "response": {
+ "$ref": "DatafeedstatusesListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ]
+ },
+ "custombatch": {
+ "response": {
+ "$ref": "DatafeedstatusesCustomBatchResponse"
+ },
+ "parameterOrder": [],
+ "id": "content.datafeedstatuses.custombatch",
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/content"
+ ],
+ "path": "content/v2/datafeedstatuses/batch",
+ "parameters": {},
+ "description": "Gets multiple Merchant Center datafeed statuses in a single request.",
+ "request": {
+ "$ref": "DatafeedstatusesCustomBatchRequest"
+ },
+ "flatPath": "content/v2/datafeedstatuses/batch"
+ }
+ }
+ }
+ },
+ "parameters": {
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "location": "query",
+ "type": "string"
+ },
+ "oauth_token": {
+ "type": "string",
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user."
+ },
+ "$.xgafv": {
+ "description": "V1 error format.",
+ "type": "string",
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ]
+ },
+ "alt": {
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "description": "Data format for response.",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "default": "json",
+ "location": "query",
+ "type": "string"
+ },
+ "access_token": {
+ "location": "query",
+ "description": "OAuth access token.",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "location": "query",
+ "default": "true",
+ "type": "boolean",
+ "description": "Returns response with indentations and line breaks."
+ },
+ "callback": {
+ "type": "string",
+ "description": "JSONP",
+ "location": "query"
+ },
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "location": "query",
+ "type": "string"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "quotaUser": {
+ "type": "string",
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters."
+ }
+ },
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/content": {
+ "description": "Manage your product listings and accounts for Google Shopping"
+ }
+ }
+ }
+ },
+ "servicePath": "",
+ "basePath": "",
+ "baseUrl": "https://shoppingcontent.googleapis.com/",
+ "mtlsRootUrl": "https://shoppingcontent.mtls.googleapis.com/",
+ "name": "content",
+ "revision": "20201113",
+ "batchPath": "batch",
+ "protocol": "rest",
+ "kind": "discovery#restDescription",
+ "fullyEncodeReservedExpansion": true,
+ "discoveryVersion": "v1",
+ "ownerName": "Google",
+ "version": "v2",
+ "canonicalName": "Shopping Content",
+ "rootUrl": "https://shoppingcontent.googleapis.com/",
+ "documentationLink": "https://developers.google.com/shopping-content/v2/"
+}