"description":"Selector specifying which fields to include in a partial response.",
"location":"query",
"type":"string"
},
"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"
},
"oauth_token":{
"description":"OAuth 2.0 token for the current user.",
"location":"query",
"type":"string"
},
"prettyPrint":{
"default":"true",
"description":"Returns response with indentations and line breaks.",
"location":"query",
"type":"boolean"
},
"quotaUser":{
"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.",
"location":"query",
"type":"string"
},
"userIp":{
"description":"Deprecated. Please use quotaUser instead.",
"location":"query",
"type":"string"
}
},
"protocol":"rest",
"resources":{
"accounts":{
"methods":{
"authinfo":{
"description":"Returns information about the authenticated user.",
"httpMethod":"GET",
"id":"content.accounts.authinfo",
"path":"accounts/authinfo",
"response":{
"$ref":"AccountsAuthInfoResponse"
},
"scopes":[
"https://www.googleapis.com/auth/content"
]
},
"claimwebsite":{
"description":"Claims the website of a Merchant Center sub-account.",
"httpMethod":"POST",
"id":"content.accounts.claimwebsite",
"parameterOrder":[
"merchantId",
"accountId"
],
"parameters":{
"accountId":{
"description":"The ID of the account whose website is claimed.",
"format":"uint64",
"location":"path",
"required":true,
"type":"string"
},
"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"
},
"overwrite":{
"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.",
"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).",
"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).",
"description":"Flag to delete sub-accounts with products. The default value is false.",
"location":"query",
"type":"boolean"
},
"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",
"location":"path",
"required":true,
"type":"string"
}
},
"path":"{merchantId}/accounts/{accountId}",
"scopes":[
"https://www.googleapis.com/auth/content"
]
},
"get":{
"description":"Retrieves a Merchant Center account.",
"httpMethod":"GET",
"id":"content.accounts.get",
"parameterOrder":[
"merchantId",
"accountId"
],
"parameters":{
"accountId":{
"description":"The ID of the account.",
"format":"uint64",
"location":"path",
"required":true,
"type":"string"
},
"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"
}
},
"path":"{merchantId}/accounts/{accountId}",
"response":{
"$ref":"Account"
},
"scopes":[
"https://www.googleapis.com/auth/content"
]
},
"insert":{
"description":"Creates a Merchant Center sub-account.",
"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).",
"description":"Performs an action on a link between a Merchant Center account and another account.",
"httpMethod":"POST",
"id":"content.accounts.link",
"parameterOrder":[
"merchantId",
"accountId"
],
"parameters":{
"accountId":{
"description":"The ID of the account that should be linked.",
"format":"uint64",
"location":"path",
"required":true,
"type":"string"
},
"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.",
"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).",
"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"
}
},
"path":"{merchantId}/accounts/{accountId}",
"request":{
"$ref":"Account"
},
"response":{
"$ref":"Account"
},
"scopes":[
"https://www.googleapis.com/auth/content"
]
},
"update":{
"description":"Updates a Merchant Center account.",
"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).",
"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.",
"description":"If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination.",
"location":"query",
"repeated":true,
"type":"string"
},
"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.",
"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).",
"description":"Retrieves the tax settings of the account.",
"httpMethod":"GET",
"id":"content.accounttax.get",
"parameterOrder":[
"merchantId",
"accountId"
],
"parameters":{
"accountId":{
"description":"The ID of the account for which to get/update account tax settings.",
"format":"uint64",
"location":"path",
"required":true,
"type":"string"
},
"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"
}
},
"path":"{merchantId}/accounttax/{accountId}",
"response":{
"$ref":"AccountTax"
},
"scopes":[
"https://www.googleapis.com/auth/content"
]
},
"list":{
"description":"Lists the tax settings of the sub-accounts in your Merchant Center account.",
"httpMethod":"GET",
"id":"content.accounttax.list",
"parameterOrder":[
"merchantId"
],
"parameters":{
"maxResults":{
"description":"The maximum number of tax settings to return in the response, used for paging.",
"format":"uint32",
"location":"query",
"type":"integer"
},
"merchantId":{
"description":"The ID of the managing account. This must be a multi-client account.",
"format":"uint64",
"location":"path",
"required":true,
"type":"string"
},
"pageToken":{
"description":"The token returned by the previous request.",
"location":"query",
"type":"string"
}
},
"path":"{merchantId}/accounttax",
"response":{
"$ref":"AccounttaxListResponse"
},
"scopes":[
"https://www.googleapis.com/auth/content"
]
},
"patch":{
"description":"Updates the tax settings of the account. This method supports patch semantics.",
"httpMethod":"PATCH",
"id":"content.accounttax.patch",
"parameterOrder":[
"merchantId",
"accountId"
],
"parameters":{
"accountId":{
"description":"The ID of the account for which to get/update account tax settings.",
"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).",
"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"
}
},
"path":"{merchantId}/accounttax/{accountId}",
"request":{
"$ref":"AccountTax"
},
"response":{
"$ref":"AccountTax"
},
"scopes":[
"https://www.googleapis.com/auth/content"
]
},
"update":{
"description":"Updates the tax settings of the account.",
"httpMethod":"PUT",
"id":"content.accounttax.update",
"parameterOrder":[
"merchantId",
"accountId"
],
"parameters":{
"accountId":{
"description":"The ID of the account for which to get/update account tax settings.",
"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).",
"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.",
"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).",
"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).",
"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).",
"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).",
"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).",
"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).",
"description":"The ID of the account that manages the datafeed. This account cannot be a multi-client account.",
"format":"uint64",
"location":"path",
"required":true,
"type":"string"
}
},
"path":"{merchantId}/datafeeds/{datafeedId}",
"request":{
"$ref":"Datafeed"
},
"response":{
"$ref":"Datafeed"
},
"scopes":[
"https://www.googleapis.com/auth/content"
]
}
}
},
"datafeedstatuses":{
"methods":{
"custombatch":{
"httpMethod":"POST",
"id":"content.datafeedstatuses.custombatch",
"path":"datafeedstatuses/batch",
"request":{
"$ref":"DatafeedstatusesCustomBatchRequest"
},
"response":{
"$ref":"DatafeedstatusesCustomBatchResponse"
},
"scopes":[
"https://www.googleapis.com/auth/content"
]
},
"get":{
"description":"Retrieves the status of a datafeed from your Merchant Center account.",
"httpMethod":"GET",
"id":"content.datafeedstatuses.get",
"parameterOrder":[
"merchantId",
"datafeedId"
],
"parameters":{
"country":{
"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.",
"location":"query",
"type":"string"
},
"datafeedId":{
"description":"The ID of the datafeed.",
"format":"uint64",
"location":"path",
"required":true,
"type":"string"
},
"language":{
"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.",
"location":"query",
"type":"string"
},
"merchantId":{
"description":"The ID of the account that manages the datafeed. This account cannot be a multi-client account.",
"description":"Lists the statuses of the datafeeds in your Merchant Center account.",
"httpMethod":"GET",
"id":"content.datafeedstatuses.list",
"parameterOrder":[
"merchantId"
],
"parameters":{
"maxResults":{
"description":"The maximum number of products to return in the response, used for paging.",
"format":"uint32",
"location":"query",
"type":"integer"
},
"merchantId":{
"description":"The ID of the account that manages the datafeeds. This account cannot be a multi-client account.",
"format":"uint64",
"location":"path",
"required":true,
"type":"string"
},
"pageToken":{
"description":"The token returned by the previous request.",
"location":"query",
"type":"string"
}
},
"path":"{merchantId}/datafeedstatuses",
"response":{
"$ref":"DatafeedstatusesListResponse"
},
"scopes":[
"https://www.googleapis.com/auth/content"
]
}
}
},
"inventory":{
"methods":{
"custombatch":{
"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.",
"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).",
"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).",
"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).",
"description":"Retrieves the LIA settings of the account.",
"httpMethod":"GET",
"id":"content.liasettings.get",
"parameterOrder":[
"merchantId",
"accountId"
],
"parameters":{
"accountId":{
"description":"The ID of the account for which to get or update LIA settings.",
"format":"uint64",
"location":"path",
"required":true,
"type":"string"
},
"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"
}
},
"path":"{merchantId}/liasettings/{accountId}",
"response":{
"$ref":"LiaSettings"
},
"scopes":[
"https://www.googleapis.com/auth/content"
]
},
"getaccessiblegmbaccounts":{
"description":"Retrieves the list of accessible Google My Business accounts.",
"description":"The ID of the account for which to retrieve accessible Google My Business accounts.",
"format":"uint64",
"location":"path",
"required":true,
"type":"string"
},
"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.",
"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).",
"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"
}
},
"path":"{merchantId}/liasettings/{accountId}",
"request":{
"$ref":"LiaSettings"
},
"response":{
"$ref":"LiaSettings"
},
"scopes":[
"https://www.googleapis.com/auth/content"
]
},
"requestgmbaccess":{
"description":"Requests access to a specified Google My Business account.",
"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.",
"description":"The ID of the account that manages the order. This cannot be a multi-client account.",
"format":"uint64",
"location":"path",
"required":true,
"type":"string"
},
"country":{
"description":"The country for which inventory validation is requested.",
"location":"path",
"required":true,
"type":"string"
},
"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.",
"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.",
"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"
},
"posDataProviderId":{
"description":"The ID of POS data provider.",
"format":"uint64",
"location":"query",
"type":"string"
},
"posExternalAccountId":{
"description":"The account ID by which this merchant is known to the POS data provider.",
"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).",
"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"
}
},
"path":"{merchantId}/liasettings/{accountId}",
"request":{
"$ref":"LiaSettings"
},
"response":{
"$ref":"LiaSettings"
},
"scopes":[
"https://www.googleapis.com/auth/content"
]
}
}
},
"orderinvoices":{
"methods":{
"createchargeinvoice":{
"description":"Creates a charge invoice for a shipment group, and triggers a charge capture for non-facilitated payment orders.",
"httpMethod":"POST",
"id":"content.orderinvoices.createchargeinvoice",
"parameterOrder":[
"merchantId",
"orderId"
],
"parameters":{
"merchantId":{
"description":"The ID of the account that manages the order. This cannot be a multi-client account.",
"description":"Creates a refund invoice for one or more shipment groups, and triggers a refund for non-facilitated payment 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.",
"description":"Retrieves an order return from your Merchant Center account.",
"httpMethod":"GET",
"id":"content.orderreturns.get",
"parameterOrder":[
"merchantId",
"returnId"
],
"parameters":{
"merchantId":{
"description":"The ID of the account that manages the order. This cannot be a multi-client account.",
"format":"uint64",
"location":"path",
"required":true,
"type":"string"
},
"returnId":{
"description":"Merchant order return ID generated by Google.",
"location":"path",
"required":true,
"type":"string"
}
},
"path":"{merchantId}/orderreturns/{returnId}",
"response":{
"$ref":"MerchantOrderReturn"
},
"scopes":[
"https://www.googleapis.com/auth/content"
]
},
"list":{
"description":"Lists order returns in your Merchant Center account.",
"httpMethod":"GET",
"id":"content.orderreturns.list",
"parameterOrder":[
"merchantId"
],
"parameters":{
"createdEndDate":{
"description":"Obtains order returns created before this date (inclusively), in ISO 8601 format.",
"location":"query",
"type":"string"
},
"createdStartDate":{
"description":"Obtains order returns created after this date (inclusively), in ISO 8601 format.",
"location":"query",
"type":"string"
},
"maxResults":{
"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",
"location":"query",
"type":"integer"
},
"merchantId":{
"description":"The ID of the account that manages the order. This cannot be a multi-client account.",
"format":"uint64",
"location":"path",
"required":true,
"type":"string"
},
"orderBy":{
"description":"Return the results in the specified order.",
"enum":[
"returnCreationTimeAsc",
"returnCreationTimeDesc"
],
"enumDescriptions":[
"",
""
],
"location":"query",
"type":"string"
},
"pageToken":{
"description":"The token returned by the previous request.",
"description":"Notifies that item return and refund was handled directly by merchant outside of Google payments processing (e.g. cash refund done in store).",
"description":"Lists the orders in your Merchant Center account.",
"httpMethod":"GET",
"id":"content.orders.list",
"parameterOrder":[
"merchantId"
],
"parameters":{
"acknowledged":{
"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.\nWe recommend using this filter set to false, in conjunction with the acknowledge call, such that only un-acknowledged orders are returned.",
"location":"query",
"type":"boolean"
},
"maxResults":{
"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.\nKnown issue: All List calls will return all Orders without limit regardless of the value of this field.",
"format":"uint32",
"location":"query",
"type":"integer"
},
"merchantId":{
"description":"The ID of the account that manages the order. This cannot be a multi-client account.",
"format":"uint64",
"location":"path",
"required":true,
"type":"string"
},
"orderBy":{
"description":"The ordering of the returned list. The only supported value are placedDate desc and placedDate asc for now, which returns orders sorted by placement date. \"placedDate desc\" stands for listing orders by placement date, from oldest to most recent. \"placedDate asc\" stands for listing orders by placement date, from most recent to oldest. In future releases we'll support other sorting criteria.",
"enum":[
"placedDate asc",
"placedDate desc"
],
"enumDescriptions":[
"",
""
],
"location":"query",
"type":"string"
},
"pageToken":{
"description":"The token returned by the previous request.",
"location":"query",
"type":"string"
},
"placedDateEnd":{
"description":"Obtains orders placed before this date (exclusively), in ISO 8601 format.",
"location":"query",
"type":"string"
},
"placedDateStart":{
"description":"Obtains orders placed after this date (inclusively), in ISO 8601 format.",
"location":"query",
"type":"string"
},
"statuses":{
"description":"Obtains orders that match any of the specified statuses. Multiple values can be specified with comma separation. Additionally, please note that active is a shortcut for pendingShipment and partiallyShipped, and completed is a shortcut for shipped , partiallyDelivered, delivered, partiallyReturned, returned, and canceled.",
"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.",
"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).",
"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).",
"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).",
"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).",
"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).",
"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).",
"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).",
"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.",
"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).",
"description":"The ID of the account that contains the product. This account cannot be a multi-client account.",
"format":"uint64",
"location":"path",
"required":true,
"type":"string"
}
},
"path":"{merchantId}/products",
"request":{
"$ref":"Product"
},
"response":{
"$ref":"Product"
},
"scopes":[
"https://www.googleapis.com/auth/content"
]
},
"list":{
"description":"Lists the products in your Merchant Center account.",
"httpMethod":"GET",
"id":"content.products.list",
"parameterOrder":[
"merchantId"
],
"parameters":{
"includeInvalidInsertedItems":{
"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",
"type":"boolean"
},
"maxResults":{
"description":"The maximum number of products to return in the response, used for paging.",
"format":"uint32",
"location":"query",
"type":"integer"
},
"merchantId":{
"description":"The ID of the account that contains the products. This account cannot be a multi-client account.",
"format":"uint64",
"location":"path",
"required":true,
"type":"string"
},
"pageToken":{
"description":"The token returned by the previous request.",
"location":"query",
"type":"string"
}
},
"path":"{merchantId}/products",
"response":{
"$ref":"ProductsListResponse"
},
"scopes":[
"https://www.googleapis.com/auth/content"
]
}
}
},
"productstatuses":{
"methods":{
"custombatch":{
"description":"Gets the statuses of multiple products in a single request.",
"httpMethod":"POST",
"id":"content.productstatuses.custombatch",
"parameters":{
"includeAttributes":{
"description":"Flag to include full product data in the results of this request. The default value is false.",
"location":"query",
"type":"boolean"
}
},
"path":"productstatuses/batch",
"request":{
"$ref":"ProductstatusesCustomBatchRequest"
},
"response":{
"$ref":"ProductstatusesCustomBatchResponse"
},
"scopes":[
"https://www.googleapis.com/auth/content"
]
},
"get":{
"description":"Gets the status of a product from your Merchant Center account.",
"httpMethod":"GET",
"id":"content.productstatuses.get",
"parameterOrder":[
"merchantId",
"productId"
],
"parameters":{
"destinations":{
"description":"If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination.",
"location":"query",
"repeated":true,
"type":"string"
},
"includeAttributes":{
"description":"Flag to include full product data in the result of this get request. The default value is false.",
"location":"query",
"type":"boolean"
},
"merchantId":{
"description":"The ID of the account that contains the product. This account cannot be a multi-client account.",
"description":"Lists the statuses of the products in your Merchant Center account.",
"httpMethod":"GET",
"id":"content.productstatuses.list",
"parameterOrder":[
"merchantId"
],
"parameters":{
"destinations":{
"description":"If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination.",
"location":"query",
"repeated":true,
"type":"string"
},
"includeAttributes":{
"description":"Flag to include full product data in the results of the list request. The default value is false.",
"location":"query",
"type":"boolean"
},
"includeInvalidInsertedItems":{
"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",
"type":"boolean"
},
"maxResults":{
"description":"The maximum number of product statuses to return in the response, used for paging.",
"format":"uint32",
"location":"query",
"type":"integer"
},
"merchantId":{
"description":"The ID of the account that contains the products. This account cannot be a multi-client account.",
"format":"uint64",
"location":"path",
"required":true,
"type":"string"
},
"pageToken":{
"description":"The token returned by the previous request.",
"location":"query",
"type":"string"
}
},
"path":"{merchantId}/productstatuses",
"response":{
"$ref":"ProductstatusesListResponse"
},
"scopes":[
"https://www.googleapis.com/auth/content"
]
}
}
},
"shippingsettings":{
"methods":{
"custombatch":{
"description":"Retrieves and updates the shipping settings of multiple accounts in a single request.",
"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).",
"description":"Retrieves the shipping settings of the account.",
"httpMethod":"GET",
"id":"content.shippingsettings.get",
"parameterOrder":[
"merchantId",
"accountId"
],
"parameters":{
"accountId":{
"description":"The ID of the account for which to get/update shipping settings.",
"format":"uint64",
"location":"path",
"required":true,
"type":"string"
},
"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.",
"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).",
"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.",
"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).",
"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.",
"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, patch, and update require the admin role.",
"description":"Indicates whether the merchant sells adult content.",
"type":"boolean"
},
"adwordsLinks":{
"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.",
"description":"Identifies what kind of resource this is. Value: the fixed string \"content#account\".",
"type":"string"
},
"name":{
"annotations":{
"required":[
"content.accounts.insert",
"content.accounts.update"
]
},
"description":"Display name for the account.",
"type":"string"
},
"reviewsUrl":{
"description":"[DEPRECATED] This field is never returned and will be ignored if provided.",
"type":"string"
},
"sellerId":{
"description":"Client-specific, locally-unique, internal ID for the child account.",
"type":"string"
},
"users":{
"description":"Users with access to the account. Every account (except for subaccounts) must have at least one admin user.",
"items":{
"$ref":"AccountUser"
},
"type":"array"
},
"websiteUrl":{
"description":"The merchant's website.",
"type":"string"
},
"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.",
"description":"City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).",
"type":"string"
},
"postalCode":{
"description":"Postal code or ZIP (e.g. \"94043\").",
"type":"string"
},
"region":{
"description":"Top-level administrative subdivision of the country. For example, a state like California (\"CA\") or a province like Quebec (\"QC\").",
"type":"string"
},
"streetAddress":{
"description":"Street-level part of the address.",
"description":"Customer ID of the AdWords account.",
"format":"uint64",
"type":"string"
},
"status":{
"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.",
"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.",
"type":"string"
},
"status":{
"description":"Status of the link between this Merchant Center account and the GMB account.",
"type":"string"
}
},
"type":"object"
},
"AccountIdentifier":{
"id":"AccountIdentifier",
"properties":{
"aggregatorId":{
"description":"The aggregator ID, set for aggregators and subaccounts (in that case, it represents the aggregator of the subaccount).",
"format":"uint64",
"type":"string"
},
"merchantId":{
"description":"The merchant account ID, set for individual accounts and subaccounts.",
"format":"uint64",
"type":"string"
}
},
"type":"object"
},
"AccountStatus":{
"description":"The status of an account, i.e., information about its products, which is computed offline and not returned immediately at insertion time.",
"id":"AccountStatus",
"properties":{
"accountId":{
"description":"The ID of the account for which the status is reported.",
"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.",
"type":"string"
}
},
"type":"object"
},
"AccountsAuthInfoResponse":{
"id":"AccountsAuthInfoResponse",
"properties":{
"accountIdentifiers":{
"description":"The account identifiers corresponding to the authenticated user.\n- For an individual account: only the merchant ID is defined\n- For an aggregator: only the aggregator ID is defined\n- For a subaccount of an MCA: both the merchant ID and the aggregator ID are defined.",
"items":{
"$ref":"AccountIdentifier"
},
"type":"array"
},
"kind":{
"default":"content#accountsAuthInfoResponse",
"description":"Identifies what kind of resource this is. Value: the fixed string \"content#accountsAuthInfoResponse\".",
"type":"string"
}
},
"type":"object"
},
"AccountsClaimWebsiteResponse":{
"id":"AccountsClaimWebsiteResponse",
"properties":{
"kind":{
"default":"content#accountsClaimWebsiteResponse",
"description":"Identifies what kind of resource this is. Value: the fixed string \"content#accountsClaimWebsiteResponse\".",
"type":"string"
}
},
"type":"object"
},
"AccountsCustomBatchRequest":{
"id":"AccountsCustomBatchRequest",
"properties":{
"entries":{
"description":"The request entries to be processed in the batch.",
"items":{
"$ref":"AccountsCustomBatchRequestEntry"
},
"type":"array"
}
},
"type":"object"
},
"AccountsCustomBatchRequestEntry":{
"description":"A batch entry encoding a single non-batch accounts request.",
"id":"AccountsCustomBatchRequestEntry",
"properties":{
"account":{
"$ref":"Account",
"description":"The account to create or update. Only defined if the method is insert or update."
"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.",
"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"
},
"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."
},
"name":{
"description":"Name of the carrier rate. Must be unique per rate group. Required.",
"type":"string"
},
"originPostalCode":{
"description":"Shipping origin for this carrier rate. Required.",
"type":"string"
},
"percentageAdjustment":{
"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.",
"type":"string"
}
},
"type":"object"
},
"CarriersCarrier":{
"id":"CarriersCarrier",
"properties":{
"country":{
"description":"The CLDR country code of the carrier (e.g., \"US\"). Always present.",
"type":"string"
},
"name":{
"description":"The name of the carrier (e.g., \"UPS\"). Always present.",
"type":"string"
},
"services":{
"description":"A list of supported services (e.g., \"ground\") for that carrier. Contains at least one service.",
"description":"Hour of the cutoff time until which an order has to be placed to be processed in the same day. Required.",
"format":"uint32",
"type":"integer"
},
"minute":{
"description":"Minute of the cutoff time until which an order has to be placed to be processed in the same day. Required.",
"format":"uint32",
"type":"integer"
},
"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"
}
},
"type":"object"
},
"Datafeed":{
"description":"Datafeed configuration data.",
"id":"Datafeed",
"properties":{
"attributeLanguage":{
"description":"The two-letter ISO 639-1 language in which the attributes are defined in the data feed.",
"type":"string"
},
"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"
},
"contentType":{
"annotations":{
"required":[
"content.datafeeds.insert",
"content.datafeeds.update"
]
},
"description":"The type of data feed. For product inventory feeds, only feeds for local stores, not online stores, are supported.",
"type":"string"
},
"fetchSchedule":{
"$ref":"DatafeedFetchSchedule",
"description":"Fetch schedule for the feed file."
},
"fileName":{
"annotations":{
"required":[
"content.datafeeds.insert",
"content.datafeeds.update"
]
},
"description":"The filename of the feed. All feeds must have a unique file name.",
"type":"string"
},
"format":{
"$ref":"DatafeedFormat",
"description":"Format of the feed file."
},
"id":{
"annotations":{
"required":[
"content.datafeeds.update"
]
},
"description":"The ID of the data feed.",
"format":"int64",
"type":"string"
},
"intendedDestinations":{
"description":"[DEPRECATED] Please use targets[].includedDestinations instead. The list of intended destinations (corresponds to checked check boxes in Merchant Center).",
"items":{
"type":"string"
},
"type":"array"
},
"kind":{
"default":"content#datafeed",
"description":"Identifies what kind of resource this is. Value: the fixed string \"content#datafeed\".",
"type":"string"
},
"name":{
"annotations":{
"required":[
"content.datafeeds.insert"
]
},
"description":"A descriptive name of the data feed.",
"type":"string"
},
"targetCountry":{
"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.",
"type":"string"
},
"targets":{
"description":"The targets this feed should apply to (country, language, destinations).",
"items":{
"$ref":"DatafeedTarget"
},
"type":"array"
}
},
"type":"object"
},
"DatafeedFetchSchedule":{
"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.",
"id":"DatafeedFetchSchedule",
"properties":{
"dayOfMonth":{
"description":"The day of the month the feed file should be fetched (1-31).",
"format":"uint32",
"type":"integer"
},
"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"
},
"hour":{
"description":"The hour of the day the feed file should be fetched (0-23).",
"format":"uint32",
"type":"integer"
},
"minuteOfHour":{
"description":"The minute of the hour the feed file should be fetched (0-59). Read-only.",
"format":"uint32",
"type":"integer"
},
"password":{
"description":"An optional password for fetch_url.",
"type":"string"
},
"paused":{
"description":"Whether the scheduled fetch is paused or not.",
"type":"boolean"
},
"timeZone":{
"description":"Time zone used for schedule. UTC by default. E.g., \"America/Los_Angeles\".",
"type":"string"
},
"username":{
"description":"An optional user name for fetch_url.",
"type":"string"
},
"weekday":{
"description":"The day of the week the feed file should be fetched.",
"type":"string"
}
},
"type":"object"
},
"DatafeedFormat":{
"id":"DatafeedFormat",
"properties":{
"columnDelimiter":{
"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.",
"type":"string"
},
"fileEncoding":{
"description":"Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected.",
"type":"string"
},
"quotingMode":{
"description":"Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds.",
"type":"string"
}
},
"type":"object"
},
"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.",
"id":"DatafeedStatus",
"properties":{
"country":{
"description":"The country for which the status is reported, represented as a CLDR territory code.",
"type":"string"
},
"datafeedId":{
"description":"The ID of the feed for which the status is reported.",
"format":"uint64",
"type":"string"
},
"errors":{
"description":"The list of errors occurring in the feed.",
"items":{
"$ref":"DatafeedStatusError"
},
"type":"array"
},
"itemsTotal":{
"description":"The number of items in the feed that were processed.",
"format":"uint64",
"type":"string"
},
"itemsValid":{
"description":"The number of items in the feed that were valid.",
"format":"uint64",
"type":"string"
},
"kind":{
"default":"content#datafeedStatus",
"description":"Identifies what kind of resource this is. Value: the fixed string \"content#datafeedStatus\".",
"type":"string"
},
"language":{
"description":"The two-letter ISO 639-1 language for which the status is reported.",
"type":"string"
},
"lastUploadDate":{
"description":"The last date at which the feed was uploaded.",
"type":"string"
},
"processingStatus":{
"description":"The processing status of the feed.",
"type":"string"
},
"warnings":{
"description":"The list of errors occurring in the feed.",
"items":{
"$ref":"DatafeedStatusError"
},
"type":"array"
}
},
"type":"object"
},
"DatafeedStatusError":{
"description":"An error occurring in the feed, like \"invalid price\".",
"id":"DatafeedStatusError",
"properties":{
"code":{
"description":"The code of the error, e.g., \"validation/invalid_value\".",
"type":"string"
},
"count":{
"description":"The number of occurrences of the error in the feed.",
"format":"uint64",
"type":"string"
},
"examples":{
"description":"A list of example occurrences of the error, grouped by product.",
"description":"An example occurrence for a particular error.",
"id":"DatafeedStatusExample",
"properties":{
"itemId":{
"description":"The ID of the example item.",
"type":"string"
},
"lineNumber":{
"description":"Line number in the data feed where the example is found.",
"format":"uint64",
"type":"string"
},
"value":{
"description":"The problematic value.",
"type":"string"
}
},
"type":"object"
},
"DatafeedTarget":{
"id":"DatafeedTarget",
"properties":{
"country":{
"description":"The country where the items in the feed will be included in the search index, represented as a CLDR territory code.",
"type":"string"
},
"excludedDestinations":{
"description":"The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center).",
"items":{
"type":"string"
},
"type":"array"
},
"includedDestinations":{
"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 the excluded_destination field.",
"items":{
"type":"string"
},
"type":"array"
},
"language":{
"description":"The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for targets[].country.",
"type":"string"
}
},
"type":"object"
},
"DatafeedsCustomBatchRequest":{
"id":"DatafeedsCustomBatchRequest",
"properties":{
"entries":{
"description":"The request entries to be processed in the batch.",
"items":{
"$ref":"DatafeedsCustomBatchRequestEntry"
},
"type":"array"
}
},
"type":"object"
},
"DatafeedsCustomBatchRequestEntry":{
"description":"A batch entry encoding a single non-batch datafeeds request.",
"id":"DatafeedsCustomBatchRequestEntry",
"properties":{
"batchId":{
"description":"An entry ID, unique within the batch request.",
"format":"uint32",
"type":"integer"
},
"datafeed":{
"$ref":"Datafeed",
"description":"The data feed to insert."
},
"datafeedId":{
"description":"The ID of the data feed to get, delete or fetch.",
"format":"uint64",
"type":"string"
},
"merchantId":{
"description":"The ID of the managing account.",
"format":"uint64",
"type":"string"
},
"method":{
"type":"string"
}
},
"type":"object"
},
"DatafeedsCustomBatchResponse":{
"id":"DatafeedsCustomBatchResponse",
"properties":{
"entries":{
"description":"The result of the execution of the batch requests.",
"items":{
"$ref":"DatafeedsCustomBatchResponseEntry"
},
"type":"array"
},
"kind":{
"default":"content#datafeedsCustomBatchResponse",
"description":"Identifies what kind of resource this is. Value: the fixed string \"content#datafeedsCustomBatchResponse\".",
"type":"string"
}
},
"type":"object"
},
"DatafeedsCustomBatchResponseEntry":{
"description":"A batch entry encoding a single non-batch datafeeds response.",
"id":"DatafeedsCustomBatchResponseEntry",
"properties":{
"batchId":{
"description":"The ID of the request entry this entry responds to.",
"format":"uint32",
"type":"integer"
},
"datafeed":{
"$ref":"Datafeed",
"description":"The requested data feed. Defined if and only if the request was successful."
},
"errors":{
"$ref":"Errors",
"description":"A list of errors defined if and only if the request failed."
}
},
"type":"object"
},
"DatafeedsFetchNowResponse":{
"id":"DatafeedsFetchNowResponse",
"properties":{
"kind":{
"default":"content#datafeedsFetchNowResponse",
"description":"Identifies what kind of resource this is. Value: the fixed string \"content#datafeedsFetchNowResponse\".",
"type":"string"
}
},
"type":"object"
},
"DatafeedsListResponse":{
"id":"DatafeedsListResponse",
"properties":{
"kind":{
"default":"content#datafeedsListResponse",
"description":"Identifies what kind of resource this is. Value: the fixed string \"content#datafeedsListResponse\".",
"type":"string"
},
"nextPageToken":{
"description":"The token for the retrieval of the next page of datafeeds.",
"type":"string"
},
"resources":{
"items":{
"$ref":"Datafeed"
},
"type":"array"
}
},
"type":"object"
},
"DatafeedstatusesCustomBatchRequest":{
"id":"DatafeedstatusesCustomBatchRequest",
"properties":{
"entries":{
"description":"The request entries to be processed in the batch.",
"items":{
"$ref":"DatafeedstatusesCustomBatchRequestEntry"
},
"type":"array"
}
},
"type":"object"
},
"DatafeedstatusesCustomBatchRequestEntry":{
"description":"A batch entry encoding a single non-batch datafeedstatuses request.",
"id":"DatafeedstatusesCustomBatchRequestEntry",
"properties":{
"batchId":{
"description":"An entry ID, unique within the batch request.",
"format":"uint32",
"type":"integer"
},
"country":{
"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.",
"type":"string"
},
"datafeedId":{
"description":"The ID of the data feed to get.",
"format":"uint64",
"type":"string"
},
"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":{
"description":"The ID of the managing account.",
"format":"uint64",
"type":"string"
},
"method":{
"type":"string"
}
},
"type":"object"
},
"DatafeedstatusesCustomBatchResponse":{
"id":"DatafeedstatusesCustomBatchResponse",
"properties":{
"entries":{
"description":"The result of the execution of the batch requests.",
"description":"Identifies what kind of resource this is. Value: the fixed string \"content#datafeedstatusesCustomBatchResponse\".",
"type":"string"
}
},
"type":"object"
},
"DatafeedstatusesCustomBatchResponseEntry":{
"description":"A batch entry encoding a single non-batch datafeedstatuses response.",
"id":"DatafeedstatusesCustomBatchResponseEntry",
"properties":{
"batchId":{
"description":"The ID of the request entry this entry responds to.",
"format":"uint32",
"type":"integer"
},
"datafeedStatus":{
"$ref":"DatafeedStatus",
"description":"The requested data feed status. Defined if and only if the request was successful."
},
"errors":{
"$ref":"Errors",
"description":"A list of errors defined if and only if the request failed."
}
},
"type":"object"
},
"DatafeedstatusesListResponse":{
"id":"DatafeedstatusesListResponse",
"properties":{
"kind":{
"default":"content#datafeedstatusesListResponse",
"description":"Identifies what kind of resource this is. Value: the fixed string \"content#datafeedstatusesListResponse\".",
"type":"string"
},
"nextPageToken":{
"description":"The token for the retrieval of the next page of datafeed statuses.",
"type":"string"
},
"resources":{
"items":{
"$ref":"DatafeedStatus"
},
"type":"array"
}
},
"type":"object"
},
"DeliveryTime":{
"id":"DeliveryTime",
"properties":{
"cutoffTime":{
"$ref":"CutoffTime",
"description":"Business days cutoff time definition. If not configured the cutoff time will be defaulted to 8AM PST."
},
"holidayCutoffs":{
"description":"Holiday cutoff definitions. If configured, they specify order cutoff times for holiday-specific shipping.",
"items":{
"$ref":"HolidayCutoff"
},
"type":"array"
},
"maxHandlingTimeInDays":{
"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.",
"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.",
"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.",
"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."
"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.",
"description":"A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.",
"items":{
"$ref":"LocationIdSet"
},
"type":"array"
},
"numberOfItems":{
"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\", \" 50 items\". Must be non-empty. Can only be set if all other fields are not set.",
"items":{
"type":"string"
},
"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.",
"items":{
"type":"string"
},
"type":"array"
},
"prices":{
"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\", \" $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.",
"items":{
"$ref":"Price"
},
"type":"array"
},
"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\", \" 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.",
"items":{
"$ref":"Weight"
},
"type":"array"
}
},
"type":"object"
},
"HolidayCutoff":{
"id":"HolidayCutoff",
"properties":{
"deadlineDate":{
"description":"Date of the order deadline, in ISO 8601 format. E.g. \"2016-11-29\" for 29th November 2016. Required.",
"type":"string"
},
"deadlineHour":{
"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.",
"format":"uint32",
"type":"integer"
},
"deadlineTimezone":{
"description":"Timezone identifier for the deadline hour. A list of identifiers can be found in the AdWords API documentation. E.g. \"Europe/Zurich\". Required.",
"type":"string"
},
"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"
}
},
"type":"object"
},
"HolidaysHoliday":{
"id":"HolidaysHoliday",
"properties":{
"countryCode":{
"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.",
"type":"string"
},
"date":{
"description":"Date of the holiday, in ISO 8601 format. E.g. \"2016-12-25\" for Christmas 2016. Always present.",
"type":"string"
},
"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"
},
"deliveryGuaranteeHour":{
"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.",
"format":"uint64",
"type":"string"
},
"id":{
"description":"Unique identifier for the holiday to be used when configuring holiday cutoffs. Always present.",
"description":"Identifies what kind of resource this is. Value: the fixed string \"content#inventory\".",
"type":"string"
},
"loyaltyPoints":{
"$ref":"LoyaltyPoints",
"description":"Loyalty points that users receive after purchasing the item. Japan only."
},
"pickup":{
"$ref":"InventoryPickup",
"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\"."
},
"price":{
"$ref":"Price",
"description":"The price of the product."
},
"quantity":{
"description":"The quantity of the product. Must be equal to or greater than zero. Supported only for local products.",
"format":"uint32",
"type":"integer"
},
"salePrice":{
"$ref":"Price",
"description":"The sale price of the product. Mandatory if sale_price_effective_date is defined."
},
"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.",
"description":"Identifies what kind of resource this is. Value: the fixed string \"content#inventoryCustomBatchResponseEntry\".",
"type":"string"
}
},
"type":"object"
},
"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.",
"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.",
"description":"Loyalty points that users receive after purchasing the item. Japan only."
},
"pickup":{
"$ref":"InventoryPickup",
"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\"."
},
"price":{
"$ref":"Price",
"description":"The price of the product."
},
"quantity":{
"description":"The quantity of the product. Must be equal to or greater than zero. Supported only for local products.",
"format":"uint32",
"type":"integer"
},
"salePrice":{
"$ref":"Price",
"description":"The sale price of the product. Mandatory if sale_price_effective_date is defined."
},
"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.",
"description":"Identifies what kind of resource this is. Value: the fixed string \"content#liasettingsSetPosDataProviderResponse\".",
"type":"string"
}
},
"type":"object"
},
"LocationIdSet":{
"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"
}
},
"type":"object"
},
"LoyaltyPoints":{
"id":"LoyaltyPoints",
"properties":{
"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"
},
"pointsValue":{
"description":"The retailer's loyalty points in absolute value.",
"format":"int64",
"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.",
"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."
},
"paymentMethod":{
"$ref":"OrderPaymentMethod",
"description":"The details of the payment method."
},
"paymentStatus":{
"description":"The status of the payment.",
"type":"string"
},
"placedDate":{
"description":"The date when the order was placed, in ISO 8601 format.",
"type":"string"
},
"promotions":{
"description":"The details of the merchant provided promotions applied to the order. More details about the program are here.",
"description":"Strings representing the lines of the printed label for mailing the order, for example:\nJohn Smith\n1600 Amphitheatre Parkway\nMountain View, CA, 94043\nUnited States",
"items":{
"type":"string"
},
"type":"array"
},
"isPostOfficeBox":{
"description":"Whether the address is a post office box.",
"type":"boolean"
},
"locality":{
"description":"City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).",
"type":"string"
},
"postalCode":{
"description":"Postal Code or ZIP (e.g. \"94043\").",
"description":"Top-level administrative subdivision of the country. For example, a state like California (\"CA\") or a province like Quebec (\"QC\").",
"description":"Street-level part of the address.",
"items":{
"type":"string"
},
"type":"array"
}
},
"type":"object"
},
"OrderCancellation":{
"id":"OrderCancellation",
"properties":{
"actor":{
"description":"The actor that created the cancellation.",
"type":"string"
},
"creationDate":{
"description":"Date on which the cancellation has been created, in ISO 8601 format.",
"type":"string"
},
"quantity":{
"description":"The quantity that was canceled.",
"format":"uint32",
"type":"integer"
},
"reason":{
"description":"The reason for the cancellation. Orders that are cancelled with a noInventory reason will lead to the removal of the product from Shopping Actions until you make an update to that product. This will not affect your Shopping ads.",
"description":"Deprecated. Please use marketingRightsInfo instead.",
"type":"boolean"
},
"fullName":{
"description":"Full name of the customer.",
"type":"string"
},
"marketingRightsInfo":{
"$ref":"OrderCustomerMarketingRightsInfo",
"description":"Customer's marketing preferences."
}
},
"type":"object"
},
"OrderCustomerMarketingRightsInfo":{
"id":"OrderCustomerMarketingRightsInfo",
"properties":{
"explicitMarketingPreference":{
"description":"Last known user selection regarding marketing preferences. In certain cases this selection might not be known, so this field would be empty.",
"type":"string"
},
"lastUpdatedTimestamp":{
"description":"Timestamp when last time marketing preference was updated. Could be empty, if user wasn't offered a selection yet.",
"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.",
"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.\nStart 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"
},
"genericRedemptionCode":{
"description":"Optional. The text code that corresponds to the promotion when applied on the retailer?s website.",
"type":"string"
},
"id":{
"description":"The unique ID of the promotion.",
"type":"string"
},
"longTitle":{
"description":"The full title of the promotion.",
"type":"string"
},
"productApplicability":{
"description":"Whether the promotion is applicable to all products or only specific products.",
"type":"string"
},
"redemptionChannel":{
"description":"Indicates that the promotion is valid online.",
"type":"string"
}
},
"type":"object"
},
"OrderLegacyPromotionBenefit":{
"id":"OrderLegacyPromotionBenefit",
"properties":{
"discount":{
"$ref":"Price",
"description":"The discount in the order price when the promotion is applied."
},
"offerIds":{
"description":"The OfferId(s) that were purchased in this order and map to this specific benefit of the promotion.",
"items":{
"type":"string"
},
"type":"array"
},
"subType":{
"description":"Further describes the benefit of the promotion. Note that we will expand on this enumeration as we support new promotion sub-types.",
"type":"string"
},
"taxImpact":{
"$ref":"Price",
"description":"The impact on tax when the promotion is applied."
},
"type":{
"description":"Describes whether the promotion applies to products (e.g. 20% off) or to shipping (e.g. Free Shipping).",
"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."
"description":"Details of the return policy for the line item."
},
"returns":{
"description":"Returns of the line item.",
"items":{
"$ref":"OrderReturn"
},
"type":"array"
},
"shippingDetails":{
"$ref":"OrderLineItemShippingDetails",
"description":"Details of the requested shipping for the line item."
},
"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."
}
},
"type":"object"
},
"OrderLineItemProduct":{
"id":"OrderLineItemProduct",
"properties":{
"brand":{
"description":"Brand of the item.",
"type":"string"
},
"channel":{
"description":"The item's channel (online or local).",
"type":"string"
},
"condition":{
"description":"Condition or state of the item.",
"type":"string"
},
"contentLanguage":{
"description":"The two-letter ISO 639-1 language code for the item.",
"description":"Shared identifier for all variants of the same product.",
"type":"string"
},
"mpn":{
"description":"Manufacturer Part Number (MPN) of the item.",
"type":"string"
},
"offerId":{
"description":"An identifier of the item.",
"type":"string"
},
"price":{
"$ref":"Price",
"description":"Price of the item."
},
"shownImage":{
"description":"URL to the cached image shown to the user when order was placed.",
"type":"string"
},
"targetCountry":{
"description":"The CLDR territory code of the target country of the product.",
"type":"string"
},
"title":{
"description":"The title of the product.",
"type":"string"
},
"variantAttributes":{
"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.",
"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."
"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."
"description":"Tax amount that corresponds to cancellation amount in amountPretax. Optional, but if filled, then amountPretax must be set. Calculated automatically if not provided."
"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.\n\nAcceptable values are: \n- \"US\" \n- \"FR\" Defaults to US.",
"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.",
"description":"The ID of the operation. Unique across all operations for a given order. Required for all methods beside get and getByMerchantOrderId.",
"type":"string"
},
"orderId":{
"description":"The ID of the order. Required for all methods beside getByMerchantOrderId.",
"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."
"description":"Tax amount that corresponds to cancellation amount in amountPretax. Optional, but if filled, then amountPretax must be set. Calculated automatically if not provided."
"description":"Tax amount that corresponds to refund amount in amountPretax. Optional, but if filled, amountPretax must be set. Calculated automatically if not provided."
"description":"Tax amount that corresponds to refund amount in amountPretax. Optional, but if filled, then amountPretax must be set. Calculated automatically if not provided."
"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.",
"type":"string"
},
"lineItems":{
"description":"Line items to ship.",
"items":{
"$ref":"OrderShipmentLineItemShipment"
},
"type":"array"
},
"shipmentGroupId":{
"description":"ID of the shipment group. Required for orders that use the orderinvoices service.",
"type":"string"
},
"shipmentId":{
"description":"Deprecated. Please use shipmentInfo instead. The ID of 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).",
"description":"The carrier handling the shipment. Not updated if missing. See shipments[].carrier in the Orders resource representation for a list of acceptable values.",
"description":"The status of the execution. Only defined if \n- the request was successful; and \n- the method is not get, getByMerchantOrderId, or one of the test methods.",
"description":"Tax amount that corresponds to refund amount in amountPretax. Optional, but if filled, amountPretax must be set. Calculated automatically if not provided."
"description":"Tax amount that corresponds to refund amount in amountPretax. Optional, but if filled, then amountPretax must be set. Calculated automatically if not provided."
"description":"Identifies what kind of resource this is. Value: the fixed string \"content#ordersSetLineItemMetadataResponse\".",
"type":"string"
}
},
"type":"object"
},
"OrdersShipLineItemsRequest":{
"id":"OrdersShipLineItemsRequest",
"properties":{
"carrier":{
"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.",
"type":"string"
},
"lineItems":{
"description":"Line items to ship.",
"items":{
"$ref":"OrderShipmentLineItemShipment"
},
"type":"array"
},
"operationId":{
"description":"The ID of the operation. Unique across all operations for a given order.",
"type":"string"
},
"shipmentGroupId":{
"description":"ID of the shipment group. Required for orders that use the orderinvoices service.",
"type":"string"
},
"shipmentId":{
"description":"Deprecated. Please use shipmentInfo instead. The ID of 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).",
"description":"Identifies what kind of resource this is. Value: the fixed string \"content#ordersUpdateMerchantOrderIdResponse\".",
"type":"string"
}
},
"type":"object"
},
"OrdersUpdateShipmentRequest":{
"id":"OrdersUpdateShipmentRequest",
"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.",
"description":"A unique ID to group items from the same sale event.",
"type":"string"
},
"storeCode":{
"annotations":{
"required":[
"content.pos.sale"
]
},
"description":"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"
},
"targetCountry":{
"annotations":{
"required":[
"content.pos.sale"
]
},
"description":"The CLDR territory code for the item.",
"type":"string"
},
"timestamp":{
"annotations":{
"required":[
"content.pos.sale"
]
},
"description":"The inventory timestamp, in ISO 8601 format.",
"type":"string"
}
},
"type":"object"
},
"PosStore":{
"description":"Store resource.",
"id":"PosStore",
"properties":{
"kind":{
"default":"content#posStore",
"description":"Identifies what kind of resource this is. Value: the fixed string \"content#posStore\".",
"type":"string"
},
"storeAddress":{
"annotations":{
"required":[
"content.pos.insert"
]
},
"description":"The street address of the store.",
"type":"string"
},
"storeCode":{
"annotations":{
"required":[
"content.pos.insert"
]
},
"description":"A store identifier that is unique for the given merchant.",
"type":"string"
}
},
"type":"object"
},
"PostalCodeGroup":{
"id":"PostalCodeGroup",
"properties":{
"country":{
"description":"The CLDR territory code of the country the postal code group applies to. Required.",
"type":"string"
},
"name":{
"description":"The name of the postal code group, referred to in headers. Required.",
"type":"string"
},
"postalCodeRanges":{
"description":"A range of postal codes. Required.",
"items":{
"$ref":"PostalCodeRange"
},
"type":"array"
}
},
"type":"object"
},
"PostalCodeRange":{
"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":{
"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.",
"type":"string"
}
},
"type":"object"
},
"Price":{
"id":"Price",
"properties":{
"currency":{
"description":"The currency of the price.",
"type":"string"
},
"value":{
"description":"The price represented as a number.",
"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\", \"type\": \"text\", \"value\": \"regular\" }). This is useful for submitting attributes not explicitly exposed by the API.",
"description":"Title of an item for dynamic remarketing campaigns.",
"type":"string"
},
"displayAdsValue":{
"description":"Offer margin for dynamic remarketing campaigns.",
"format":"double",
"type":"number"
},
"energyEfficiencyClass":{
"description":"The energy efficiency class as defined in EU directive 2010/30/EU.",
"type":"string"
},
"expirationDate":{
"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.",
"type":"string"
},
"gender":{
"description":"Target gender of the item.",
"type":"string"
},
"googleProductCategory":{
"description":"Google's category of the item (see Google product taxonomy).",
"type":"string"
},
"gtin":{
"description":"Global Trade Item Number (GTIN) of the item.",
"description":"The REST ID of the product. Content API methods that operate on products take this as their productId parameter.\nThe REST ID for a product is of the form channel:contentLanguage:targetCountry:offerId.",
"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"
},
"imageLink":{
"description":"URL of an image of the item.",
"type":"string"
},
"installment":{
"$ref":"Installment",
"description":"Number and amount of installments to pay for an item. Brazil only."
},
"isBundle":{
"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.",
"type":"boolean"
},
"itemGroupId":{
"description":"Shared identifier for all variants of the same product.",
"type":"string"
},
"kind":{
"default":"content#product",
"description":"Identifies what kind of resource this is. Value: the fixed string \"content#product\".",
"type":"string"
},
"link":{
"description":"URL directly linking to your item's page on your website.",
"type":"string"
},
"loyaltyPoints":{
"$ref":"LoyaltyPoints",
"description":"Loyalty points that users receive after purchasing the item. Japan only."
},
"material":{
"description":"The material of which the item is made.",
"description":"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.\nNote: Content API methods that operate on products take the REST ID of the product, not this identifier.",
"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"
},
"price":{
"$ref":"Price",
"description":"Fixed shipping price, represented as a number."
},
"region":{
"description":"The geographic region to which a shipping rate applies.",
"type":"string"
},
"service":{
"description":"A free-form description of the service class or delivery speed.",
"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*.",
"type":"string"
},
"rate":{
"description":"The percentage of tax rate that applies to the item price.",
"format":"double",
"type":"number"
},
"region":{
"description":"The geographic region to which the tax rate applies.",
"type":"string"
},
"taxShip":{
"description":"Set to true if tax is charged on shipping.",
"type":"boolean"
}
},
"type":"object"
},
"ProductUnitPricingBaseMeasure":{
"id":"ProductUnitPricingBaseMeasure",
"properties":{
"unit":{
"description":"The unit of the denominator.",
"type":"string"
},
"value":{
"description":"The denominator of the unit price.",
"format":"int64",
"type":"string"
}
},
"type":"object"
},
"ProductUnitPricingMeasure":{
"id":"ProductUnitPricingMeasure",
"properties":{
"unit":{
"description":"The unit of the measure.",
"type":"string"
},
"value":{
"description":"The measure of an item.",
"format":"double",
"type":"number"
}
},
"type":"object"
},
"ProductsCustomBatchRequest":{
"id":"ProductsCustomBatchRequest",
"properties":{
"entries":{
"description":"The request entries to be processed in the batch.",
"items":{
"$ref":"ProductsCustomBatchRequestEntry"
},
"type":"array"
}
},
"type":"object"
},
"ProductsCustomBatchRequestEntry":{
"description":"A batch entry encoding a single non-batch products request.",
"id":"ProductsCustomBatchRequestEntry",
"properties":{
"batchId":{
"description":"An entry ID, unique within the batch request.",
"format":"uint32",
"type":"integer"
},
"merchantId":{
"description":"The ID of the managing account.",
"format":"uint64",
"type":"string"
},
"method":{
"type":"string"
},
"product":{
"$ref":"Product",
"description":"The product to insert. Only required if the method is insert."
},
"productId":{
"description":"The ID of the product to get or delete. Only defined if the method is get or delete.",
"type":"string"
}
},
"type":"object"
},
"ProductsCustomBatchResponse":{
"id":"ProductsCustomBatchResponse",
"properties":{
"entries":{
"description":"The result of the execution of the batch requests.",
"items":{
"$ref":"ProductsCustomBatchResponseEntry"
},
"type":"array"
},
"kind":{
"default":"content#productsCustomBatchResponse",
"description":"Identifies what kind of resource this is. Value: the fixed string \"content#productsCustomBatchResponse\".",
"type":"string"
}
},
"type":"object"
},
"ProductsCustomBatchResponseEntry":{
"description":"A batch entry encoding a single non-batch products response.",
"id":"ProductsCustomBatchResponseEntry",
"properties":{
"batchId":{
"description":"The ID of the request entry this entry responds to.",
"format":"uint32",
"type":"integer"
},
"errors":{
"$ref":"Errors",
"description":"A list of errors defined if and only if the request failed."
"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."
"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.",
"items":{
"type":"string"
},
"type":"array"
},
"carrierRates":{
"description":"A list of carrier rates that can be referred to by mainTable or singleValue.",
"items":{
"$ref":"CarrierRate"
},
"type":"array"
},
"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."
},
"name":{
"description":"Name of the rate group. Optional. If set has to be unique within shipping service.",
"type":"string"
},
"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":{
"description":"A list of subtables referred to by mainTable. Can only be set if mainTable is set.",
"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.",
"items":{
"$ref":"Value"
},
"type":"array"
}
},
"type":"object"
},
"Service":{
"id":"Service",
"properties":{
"active":{
"description":"A boolean exposing the active status of the shipping service. Required.",
"type":"boolean"
},
"currency":{
"description":"The CLDR code of the currency to which this service applies. Must match that of the prices in rate groups.",
"type":"string"
},
"deliveryCountry":{
"description":"The CLDR territory code of the country to which the service applies. Required.",
"type":"string"
},
"deliveryTime":{
"$ref":"DeliveryTime",
"description":"Time spent in various aspects from order to the delivery of the product. Required."
},
"eligibility":{
"description":"Eligibility for this service.",
"type":"string"
},
"minimumOrderValue":{
"$ref":"Price",
"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."
},
"name":{
"description":"Free-form name of the service. Must be unique within target account. Required.",
"type":"string"
},
"rateGroups":{
"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.",
"description":"The price of shipping for all items. Shipping tax is automatically calculated for MFL orders. For non-MFL orders, tax settings from Merchant Center are applied. Note that shipping is not taxed in certain states."
"description":"Deprecated. Please use marketingRightsInfo instead.",
"type":"boolean"
},
"fullName":{
"description":"Full name of the customer.",
"type":"string"
},
"marketingRightsInfo":{
"$ref":"TestOrderCustomerMarketingRightsInfo",
"description":"Customer's marketing preferences."
}
},
"type":"object"
},
"TestOrderCustomerMarketingRightsInfo":{
"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.",
"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"
}
},
"type":"object"
},
"TestOrderLineItem":{
"id":"TestOrderLineItem",
"properties":{
"product":{
"$ref":"TestOrderLineItemProduct",
"description":"Product data from the time of the order placement."
},
"quantityOrdered":{
"annotations":{
"required":[
"content.orders.createtestorder"
]
},
"description":"Number of items ordered.",
"format":"uint32",
"type":"integer"
},
"returnInfo":{
"$ref":"OrderLineItemReturnInfo",
"annotations":{
"required":[
"content.orders.createtestorder"
]
},
"description":"Details of the return policy for the line item."
},
"shippingDetails":{
"$ref":"OrderLineItemShippingDetails",
"annotations":{
"required":[
"content.orders.createtestorder"
]
},
"description":"Details of the requested shipping for the line item."
"description":"The price for the product. Tax is automatically calculated for MFL orders. For non-MFL orders, tax settings from Merchant Center are applied."
"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"
},
"type":"array"
},
"rows":{
"items":{
"$ref":"TransitTableTransitTimeRow"
},
"type":"array"
},
"transitTimeLabels":{
"description":"A list of transit time labels. The last value can be \"all other labels\". Example: [\"food\", \"electronics\", \"all other labels\"].",
"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":{
"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."
},
"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"
},
"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"
},
"subtableName":{
"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.",
"type":"string"
}
},
"type":"object"
},
"Weight":{
"id":"Weight",
"properties":{
"unit":{
"description":"The weight unit.",
"type":"string"
},
"value":{
"description":"The weight represented as a number.",
