Security News
New Proposed CISA Mandate Would Require Critical Infrastructure to Report Ransom Payments Within 24 Hours
CISA has proposed a set of new rules that would require critical infrastructure to report cyber incidents and ransom payments.
@datafire/google_shoppingcontent
Advanced tools
DataFire integration for Content API for Shopping
Weekly downloads
Readme
Client library for Content API for Shopping
npm install --save @datafire/google_shoppingcontent
let google_shoppingcontent = require('@datafire/google_shoppingcontent').create({
access_token: "",
refresh_token: "",
client_id: "",
client_secret: "",
redirect_uri: ""
});
.then(data => {
console.log(data);
});
Manage your product listings and accounts for Google Shopping
Exchange the code passed to your redirect URI for an access_token
google_shoppingcontent.oauthCallback({
"code": ""
}, context)
object
string
object
string
string
string
string
string
Exchange a refresh_token for an access_token
google_shoppingcontent.oauthRefresh(null, context)
This action has no parameters
object
string
string
string
string
string
Returns information about the authenticated user.
google_shoppingcontent.content.accounts.authinfo({}, context)
object
string
(values: 1, 2): V1 error format.string
: OAuth access token.string
(values: json, media, proto): Data format for response.string
: JSONPstring
: Selector specifying which fields to include in a partial response.string
: 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.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: 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.string
: Upload protocol for media (e.g. "raw", "multipart").string
: Legacy upload protocol for media (e.g. "media", "multipart").Retrieves, inserts, updates, and deletes multiple Merchant Center (sub-)accounts in a single request.
google_shoppingcontent.content.accounts.custombatch({}, context)
object
boolean
: 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).string
(values: 1, 2): V1 error format.string
: OAuth access token.string
(values: json, media, proto): Data format for response.string
: JSONPstring
: Selector specifying which fields to include in a partial response.string
: 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.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: 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.string
: Upload protocol for media (e.g. "raw", "multipart").string
: Legacy upload protocol for media (e.g. "media", "multipart").Retrieves multiple Merchant Center account statuses in a single request.
google_shoppingcontent.content.accountstatuses.custombatch({}, context)
object
string
(values: 1, 2): V1 error format.string
: OAuth access token.string
(values: json, media, proto): Data format for response.string
: JSONPstring
: Selector specifying which fields to include in a partial response.string
: 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.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: 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.string
: Upload protocol for media (e.g. "raw", "multipart").string
: Legacy upload protocol for media (e.g. "media", "multipart").Retrieves and updates tax settings of multiple accounts in a single request.
google_shoppingcontent.content.accounttax.custombatch({}, context)
object
boolean
: 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).string
(values: 1, 2): V1 error format.string
: OAuth access token.string
(values: json, media, proto): Data format for response.string
: JSONPstring
: Selector specifying which fields to include in a partial response.string
: 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.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: 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.string
: Upload protocol for media (e.g. "raw", "multipart").string
: Legacy upload protocol for media (e.g. "media", "multipart").Deletes, fetches, gets, inserts and updates multiple datafeeds in a single request.
google_shoppingcontent.content.datafeeds.custombatch({}, context)
object
boolean
: 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).string
(values: 1, 2): V1 error format.string
: OAuth access token.string
(values: json, media, proto): Data format for response.string
: JSONPstring
: Selector specifying which fields to include in a partial response.string
: 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.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: 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.string
: Upload protocol for media (e.g. "raw", "multipart").string
: Legacy upload protocol for media (e.g. "media", "multipart").Gets multiple Merchant Center datafeed statuses in a single request.
google_shoppingcontent.content.datafeedstatuses.custombatch({}, context)
object
string
(values: 1, 2): V1 error format.string
: OAuth access token.string
(values: json, media, proto): Data format for response.string
: JSONPstring
: Selector specifying which fields to include in a partial response.string
: 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.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: 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.string
: Upload protocol for media (e.g. "raw", "multipart").string
: Legacy upload protocol for media (e.g. "media", "multipart").Updates price and availability for multiple products or stores in a single request. This operation does not update the expiration date of the products.
google_shoppingcontent.content.inventory.custombatch({}, context)
object
boolean
: 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).string
(values: 1, 2): V1 error format.string
: OAuth access token.string
(values: json, media, proto): Data format for response.string
: JSONPstring
: Selector specifying which fields to include in a partial response.string
: 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.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: 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.string
: Upload protocol for media (e.g. "raw", "multipart").string
: Legacy upload protocol for media (e.g. "media", "multipart").Retrieves and/or updates the LIA settings of multiple accounts in a single request.
google_shoppingcontent.content.liasettings.custombatch({}, context)
object
boolean
: 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).string
(values: 1, 2): V1 error format.string
: OAuth access token.string
(values: json, media, proto): Data format for response.string
: JSONPstring
: Selector specifying which fields to include in a partial response.string
: 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.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: 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.string
: Upload protocol for media (e.g. "raw", "multipart").string
: Legacy upload protocol for media (e.g. "media", "multipart").Retrieves the list of POS data providers that have active settings for the all eiligible countries.
google_shoppingcontent.content.liasettings.listposdataproviders({}, context)
object
string
(values: 1, 2): V1 error format.string
: OAuth access token.string
(values: json, media, proto): Data format for response.string
: JSONPstring
: Selector specifying which fields to include in a partial response.string
: 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.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: 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.string
: Upload protocol for media (e.g. "raw", "multipart").string
: Legacy upload protocol for media (e.g. "media", "multipart").Retrieves or modifies multiple orders in a single request.
google_shoppingcontent.content.orders.custombatch({}, context)
object
string
(values: 1, 2): V1 error format.string
: OAuth access token.string
(values: json, media, proto): Data format for response.string
: JSONPstring
: Selector specifying which fields to include in a partial response.string
: 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.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: 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.string
: Upload protocol for media (e.g. "raw", "multipart").string
: Legacy upload protocol for media (e.g. "media", "multipart").Batches multiple POS-related calls in a single request.
google_shoppingcontent.content.pos.custombatch({}, context)
object
boolean
: 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).string
(values: 1, 2): V1 error format.string
: OAuth access token.string
(values: json, media, proto): Data format for response.string
: JSONPstring
: Selector specifying which fields to include in a partial response.string
: 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.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: 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.string
: Upload protocol for media (e.g. "raw", "multipart").string
: Legacy upload protocol for media (e.g. "media", "multipart").Retrieves, inserts, and deletes multiple products in a single request.
google_shoppingcontent.content.products.custombatch({}, context)
object
boolean
: 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).string
(values: 1, 2): V1 error format.string
: OAuth access token.string
(values: json, media, proto): Data format for response.string
: JSONPstring
: Selector specifying which fields to include in a partial response.string
: 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.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: 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.string
: Upload protocol for media (e.g. "raw", "multipart").string
: Legacy upload protocol for media (e.g. "media", "multipart").Gets the statuses of multiple products in a single request.
google_shoppingcontent.content.productstatuses.custombatch({}, context)
object
boolean
: Flag to include full product data in the results of this request. The default value is false.string
(values: 1, 2): V1 error format.string
: OAuth access token.string
(values: json, media, proto): Data format for response.string
: JSONPstring
: Selector specifying which fields to include in a partial response.string
: 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.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: 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.string
: Upload protocol for media (e.g. "raw", "multipart").string
: Legacy upload protocol for media (e.g. "media", "multipart").Retrieves and updates the shipping settings of multiple accounts in a single request.
google_shoppingcontent.content.shippingsettings.custombatch({}, context)
object
boolean
: 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).string
(values: 1, 2): V1 error format.string
: OAuth access token.string
(values: json, media, proto): Data format for response.string
: JSONPstring
: Selector specifying which fields to include in a partial response.string
: 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.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: 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.string
: Upload protocol for media (e.g. "raw", "multipart").string
: Legacy upload protocol for media (e.g. "media", "multipart").Lists the sub-accounts in your Merchant Center account.
google_shoppingcontent.content.accounts.list({
"merchantId": ""
}, context)
object
string
: The ID of the managing account. This must be a multi-client account.integer
: The maximum number of accounts to return in the response, used for paging.string
: The token returned by the previous request.string
(values: 1, 2): V1 error format.string
: OAuth access token.string
(values: json, media, proto): Data format for response.string
: JSONPstring
: Selector specifying which fields to include in a partial response.string
: 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.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: 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.string
: Upload protocol for media (e.g. "raw", "multipart").string
: Legacy upload protocol for media (e.g. "media", "multipart").Creates a Merchant Center sub-account.
google_shoppingcontent.content.accounts.insert({
"merchantId": ""
}, context)
object
string
: The ID of the managing account. This must be a multi-client account.boolean
: 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).string
(values: 1, 2): V1 error format.string
: OAuth access token.string
(values: json, media, proto): Data format for response.string
: JSONPstring
: Selector specifying which fields to include in a partial response.string
: 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.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: 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.string
: Upload protocol for media (e.g. "raw", "multipart").string
: Legacy upload protocol for media (e.g. "media", "multipart").Deletes a Merchant Center sub-account.
google_shoppingcontent.content.accounts.delete({
"merchantId": "",
"accountId": ""
}, context)
object
string
: 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.string
: The ID of the account.boolean
: 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).boolean
: Flag to delete sub-accounts with products. The default value is false.string
(values: 1, 2): V1 error format.string
: OAuth access token.string
(values: json, media, proto): Data format for response.string
: JSONPstring
: Selector specifying which fields to include in a partial response.string
: 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.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: 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.string
: Upload protocol for media (e.g. "raw", "multipart").string
: Legacy upload protocol for media (e.g. "media", "multipart").Output schema unknown
Retrieves a Merchant Center account.
google_shoppingcontent.content.accounts.get({
"merchantId": "",
"accountId": ""
}, context)
object
string
: 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.string
: The ID of the account.string
(values: 1, 2): V1 error format.string
: OAuth access token.string
(values: json, media, proto): Data format for response.string
: JSONPstring
: Selector specifying which fields to include in a partial response.string
: 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.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: 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.string
: Upload protocol for media (e.g. "raw", "multipart").string
: Legacy upload protocol for media (e.g. "media", "multipart").Updates a Merchant Center account. Any fields that are not provided are deleted from the resource.
google_shoppingcontent.content.accounts.update({
"merchantId": "",
"accountId": ""
}, context)
object
string
: 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.string
: The ID of the account.boolean
: 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).string
(values: 1, 2): V1 error format.string
: OAuth access token.string
(values: json, media, proto): Data format for response.string
: JSONPstring
: Selector specifying which fields to include in a partial response.string
: 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.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: 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.string
: Upload protocol for media (e.g. "raw", "multipart").string
: Legacy upload protocol for media (e.g. "media", "multipart").Claims the website of a Merchant Center sub-account.
google_shoppingcontent.content.accounts.claimwebsite({
"merchantId": "",
"accountId": ""
}, context)
object
string
: 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.string
: The ID of the account whose website is claimed.boolean
: 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.string
(values: 1, 2): V1 error format.string
: OAuth access token.string
(values: json, media, proto): Data format for response.string
: JSONPstring
: Selector specifying which fields to include in a partial response.string
: 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.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: 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.string
: Upload protocol for media (e.g. "raw", "multipart").string
: Legacy upload protocol for media (e.g. "media", "multipart").Performs an action on a link between two Merchant Center accounts, namely accountId and linkedAccountId.
google_shoppingcontent.content.accounts.link({
"merchantId": "",
"accountId": ""
}, context)
object
string
: 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.string
: The ID of the account that should be linked.string
(values: 1, 2): V1 error format.string
: OAuth access token.string
(values: json, media, proto): Data format for response.string
: JSONPstring
: Selector specifying which fields to include in a partial response.string
: 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.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: 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.string
: Upload protocol for media (e.g. "raw", "multipart").string
: Legacy upload protocol for media (e.g. "media", "multipart").Lists the statuses of the sub-accounts in your Merchant Center account.
google_shoppingcontent.content.accountstatuses.list({
"merchantId": ""
}, context)
object
string
: The ID of the managing account. This must be a multi-client account.array
: If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination.integer
: The maximum number of account statuses to return in the response, used for paging.string
: The token returned by the previous request.string
(values: 1, 2): V1 error format.string
: OAuth access token.string
(values: json, media, proto): Data format for response.string
: JSONPstring
: Selector specifying which fields to include in a partial response.string
: 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.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: 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.string
: Upload protocol for media (e.g. "raw", "multipart").string
: Legacy upload protocol for media (e.g. "media", "multipart").Retrieves the status of a Merchant Center account. No itemLevelIssues are returned for multi-client accounts.
google_shoppingcontent.content.accountstatuses.get({
"merchantId": "",
"accountId": ""
}, context)
object
string
: 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.string
: The ID of the account.array
: If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination.string
(values: 1, 2): V1 error format.string
: OAuth access token.string
(values: json, media, proto): Data format for response.string
: JSONPstring
: Selector specifying which fields to include in a partial response.string
: 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.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: 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.string
: Upload protocol for media (e.g. "raw", "multipart").string
: Legacy upload protocol for media (e.g. "media", "multipart").Lists the tax settings of the sub-accounts in your Merchant Center account.
google_shoppingcontent.content.accounttax.list({
"merchantId": ""
}, context)
object
string
: The ID of the managing account. This must be a multi-client account.integer
: The maximum number of tax settings to return in the response, used for paging.string
: The token returned by the previous request.string
(values: 1, 2): V1 error format.string
: OAuth access token.string
(values: json, media, proto): Data format for response.string
: JSONPstring
: Selector specifying which fields to include in a partial response.string
: 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.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: 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.string
: Upload protocol for media (e.g. "raw", "multipart").string
: Legacy upload protocol for media (e.g. "media", "multipart").Retrieves the tax settings of the account.
google_shoppingcontent.content.accounttax.get({
"merchantId": "",
"accountId": ""
}, context)
object
string
: 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.string
: The ID of the account for which to get/update account tax settings.string
(values: 1, 2): V1 error format.string
: OAuth access token.string
(values: json, media, proto): Data format for response.string
: JSONPstring
: Selector specifying which fields to include in a partial response.string
: 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.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: 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.string
: Upload protocol for media (e.g. "raw", "multipart").string
: Legacy upload protocol for media (e.g. "media", "multipart").Updates the tax settings of the account. Any fields that are not provided are deleted from the resource.
google_shoppingcontent.content.accounttax.update({
"merchantId": "",
"accountId": ""
}, context)
object
string
: 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.string
: The ID of the account for which to get/update account tax settings.boolean
: 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).string
(values: 1, 2): V1 error format.string
: OAuth access token.string
(values: json, media, proto): Data format for response.string
: JSONPstring
: Selector specifying which fields to include in a partial response.string
: 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.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: 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.string
: Upload protocol for media (e.g. "raw", "multipart").string
: Legacy upload protocol for media (e.g. "media", "multipart").Lists the configurations for datafeeds in your Merchant Center account.
google_shoppingcontent.content.datafeeds.list({
"merchantId": ""
}, context)
object
string
: The ID of the account that manages the datafeeds. This account cannot be a multi-client account.integer
: The maximum number of products to return in the response, used for paging.string
: The token returned by the previous request.string
(values: 1, 2): V1 error format.string
: OAuth access token.string
(values: json, media, proto): Data format for response.string
: JSONPstring
: Selector specifying which fields to include in a partial response.string
: 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.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: 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.string
: Upload protocol for media (e.g. "raw", "multipart").string
: Legacy upload protocol for media (e.g. "media", "multipart").Registers a datafeed configuration with your Merchant Center account.
google_shoppingcontent.content.datafeeds.insert({
"merchantId": ""
}, context)
object
string
: The ID of the account that manages the datafeed. This account cannot be a multi-client account.boolean
: 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).string
(values: 1, 2): V1 error format.string
: OAuth access token.string
(values: json, media, proto): Data format for response.string
: JSONPstring
: Selector specifying which fields to include in a partial response.string
: 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.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: 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.string
: Upload protocol for media (e.g. "raw", "multipart").string
: Legacy upload protocol for media (e.g. "media", "multipart").Deletes a datafeed configuration from your Merchant Center account.
google_shoppingcontent.content.datafeeds.delete({
"merchantId": "",
"datafeedId": ""
}, context)
object
string
: The ID of the account that manages the datafeed. This account cannot be a multi-client account.string
: The ID of the datafeed.boolean
: 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).string
(values: 1, 2): V1 error format.string
: OAuth access token.string
(values: json, media, proto): Data format for response.string
: JSONPstring
: Selector specifying which fields to include in a partial response.string
: 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.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: 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.string
: Upload protocol for media (e.g. "raw", "multipart").string
: Legacy upload protocol for media (e.g. "media", "multipart").Output schema unknown
Retrieves a datafeed configuration from your Merchant Center account.
google_shoppingcontent.content.datafeeds.get({
"merchantId": "",
"datafeedId": ""
}, context)
object
string
: The ID of the account that manages the datafeed. This account cannot be a multi-client account.string
: The ID of the datafeed.string
(values: 1, 2): V1 error format.string
: OAuth access token.string
(values: json, media, proto): Data format for response.string
: JSONPstring
: Selector specifying which fields to include in a partial response.string
: 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.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: 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.string
: Upload protocol for media (e.g. "raw", "multipart").string
: Legacy upload protocol for media (e.g. "media", "multipart").Updates a datafeed configuration of your Merchant Center account. Any fields that are not provided are deleted from the resource.
google_shoppingcontent.content.datafeeds.update({
"merchantId": "",
"datafeedId": ""
}, context)
object
string
: The ID of the account that manages the datafeed. This account cannot be a multi-client account.string
: The ID of the datafeed.boolean
: 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).string
(values: 1, 2): V1 error format.string
: OAuth access token.string
(values: json, media, proto): Data format for response.string
: JSONPstring
: Selector specifying which fields to include in a partial response.string
: 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.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: 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.string
: Upload protocol for media (e.g. "raw", "multipart").string
: Legacy upload protocol for media (e.g. "media", "multipart").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.
google_shoppingcontent.content.datafeeds.fetchnow({
"merchantId": "",
"datafeedId": ""
}, context)
object
string
: The ID of the account that manages the datafeed. This account cannot be a multi-client account.string
: The ID of the datafeed to be fetched.boolean
: 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).string
(values: 1, 2): V1 error format.string
: OAuth access token.string
(values: json, media, proto): Data format for response.string
: JSONPstring
: Selector specifying which fields to include in a partial response.string
: 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.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: 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.string
: Upload protocol for media (e.g. "raw", "multipart").string
: Legacy upload protocol for media (e.g. "media", "multipart").Lists the statuses of the datafeeds in your Merchant Center account.
google_shoppingcontent.content.datafeedstatuses.list({
"merchantId": ""
}, context)
object
string
: The ID of the account that manages the datafeeds. This account cannot be a multi-client account.integer
: The maximum number of products to return in the response, used for paging.string
: The token returned by the previous request.string
(values: 1, 2): V1 error format.string
: OAuth access token.string
(values: json, media, proto): Data format for response.string
: JSONPstring
: Selector specifying which fields to include in a partial response.string
: 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.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: 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.string
: Upload protocol for media (e.g. "raw", "multipart").string
: Legacy upload protocol for media (e.g. "media", "multipart").Retrieves the status of a datafeed from your Merchant Center account.
google_shoppingcontent.content.datafeedstatuses.get({
"merchantId": "",
"datafeedId": ""
}, context)
object
string
: The ID of the account that manages the datafeed. This account cannot be a multi-client account.string
: The ID of the datafeed.string
: 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.string
: 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.string
(values: 1, 2): V1 error format.string
: OAuth access token.string
(values: json, media, proto): Data format for response.string
: JSONPstring
: Selector specifying which fields to include in a partial response.string
: 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.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: 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.string
: Upload protocol for media (e.g. "raw", "multipart").string
: Legacy upload protocol for media (e.g. "media", "multipart").Updates price and availability of a product in your Merchant Center account.
google_shoppingcontent.content.inventory.set({
"merchantId": "",
"storeCode": "",
"productId": ""
}, context)
object
string
: The ID of the account that contains the product. This account cannot be a multi-client account.string
: The code of the store for which to update price and availability. Use online
to update price and availability of an online product.string
: The REST ID of the product for which to update price and availability.boolean
: 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).string
(values: 1, 2): V1 error format.string
: OAuth access token.string
(values: json, media, proto): Data format for response.string
: JSONPstring
: Selector specifying which fields to include in a partial response.string
: 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.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: 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.string
: Upload protocol for media (e.g. "raw", "multipart").string
: Legacy upload protocol for media (e.g. "media", "multipart").Lists the LIA settings of the sub-accounts in your Merchant Center account.
google_shoppingcontent.content.liasettings.list({
"merchantId": ""
}, context)
object
string
: The ID of the managing account. This must be a multi-client account.integer
: The maximum number of LIA settings to return in the response, used for paging.string
: The token returned by the previous request.string
(values: 1, 2): V1 error format.string
: OAuth access token.string
(values: json, media, proto): Data format for response.string
: JSONPstring
: Selector specifying which fields to include in a partial response.string
: 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.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: 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.string
: Upload protocol for media (e.g. "raw", "multipart").string
: Legacy upload protocol for media (e.g. "media", "multipart").Retrieves the LIA settings of the account.
google_shoppingcontent.content.liasettings.get({
"merchantId": "",
"accountId": ""
}, context)
object
string
: 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.string
: The ID of the account for which to get or update LIA settings.string
(values: 1, 2): V1 error format.string
: OAuth access token.string
(values: json, media, proto): Data format for response.string
: JSONPstring
: Selector specifying which fields to include in a partial response.string
: 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.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: 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.string
: Upload protocol for media (e.g. "raw", "multipart").string
: Legacy upload protocol for media (e.g. "media", "multipart").Updates the LIA settings of the account. Any fields that are not provided are deleted from the resource.
google_shoppingcontent.content.liasettings.update({
"merchantId": "",
"accountId": ""
}, context)
object
string
: 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.string
: The ID of the account for which to get or update LIA settings.boolean
: 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).string
(values: 1, 2): V1 error format.string
: OAuth access token.string
(values: json, media, proto): Data format for response.string
: JSONPstring
: Selector specifying which fields to include in a partial response.string
: 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.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: 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.string
: Upload protocol for media (e.g. "raw", "multipart").string
: Legacy upload protocol for media (e.g. "media", "multipart").Retrieves the list of accessible Google My Business accounts.
google_shoppingcontent.content.liasettings.getaccessiblegmbaccounts({
"merchantId": "",
"accountId": ""
}, context)
object
string
: 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.string
: The ID of the account for which to retrieve accessible Google My Business accounts.string
(values: 1, 2): V1 error format.string
: OAuth access token.string
(values: json, media, proto): Data format for response.string
: JSONPstring
: Selector specifying which fields to include in a partial response.string
: 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.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: 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.string
: Upload protocol for media (e.g. "raw", "multipart").string
: Legacy upload protocol for media (e.g. "media", "multipart").Requests access to a specified Google My Business account.
google_shoppingcontent.content.liasettings.requestgmbaccess({
"merchantId": "",
"accountId": "",
"gmbEmail": ""
}, context)
object
string
: 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.string
: The ID of the account for which GMB access is requested.string
: The email of the Google My Business account.string
(values: 1, 2): V1 error format.string
: OAuth access token.string
(values: json, media, proto): Data format for response.string
: JSONPstring
: Selector specifying which fields to include in a partial response.string
: 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.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: 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.string
: Upload protocol for media (e.g. "raw", "multipart").string
: Legacy upload protocol for media (e.g. "media", "multipart").Requests inventory validation for the specified country.
google_shoppingcontent.content.liasettings.requestinventoryverification({
"merchantId": "",
"accountId": "",
"country": ""
}, context)
object
string
: 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.string
: The ID of the account that manages the order. This cannot be a multi-client account.string
: The country for which inventory validation is requested.string
(values: 1, 2): V1 error format.string
: OAuth access token.string
(values: json, media, proto): Data format for response.string
: JSONPstring
: Selector specifying which fields to include in a partial response.string
: 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.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: 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.string
: Upload protocol for media (e.g. "raw", "multipart").string
: Legacy upload protocol for media (e.g. "media", "multipart").Sets the inventory verification contract for the specified country.
google_shoppingcontent.content.liasettings.setinventoryverificationcontact({
"merchantId": "",
"accountId": "",
"country": "",
"language": "",
"contactName": "",
"contactEmail": ""
}, context)
object
string
: 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.string
: The ID of the account that manages the order. This cannot be a multi-client account.string
: The country for which inventory verification is requested.string
: The language for which inventory verification is requested.string
: The name of the inventory verification contact.string
: The email of the inventory verification contact.string
(values: 1, 2): V1 error format.string
: OAuth access token.string
(values: json, media, proto): Data format for response.string
: JSONPstring
: Selector specifying which fields to include in a partial response.string
: 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.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: 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.string
: Upload protocol for media (e.g. "raw", "multipart").string
: Legacy upload protocol for media (e.g. "media", "multipart").Sets the POS data provider for the specified country.
google_shoppingcontent.content.liasettings.setposdataprovider({
"merchantId": "",
"accountId": "",
"country": ""
}, context)
object
string
: 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.string
: The ID of the account for which to retrieve accessible Google My Business accounts.string
: The country for which the POS data provider is selected.string
: The ID of POS data provider.string
: The account ID by which this merchant is known to the POS data provider.string
(values: 1, 2): V1 error format.string
: OAuth access token.string
(values: json, media, proto): Data format for response.string
: JSONPstring
: Selector specifying which fields to include in a partial response.string
: 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.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: 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.string
: Upload protocol for media (e.g. "raw", "multipart").string
: Legacy upload protocol for media (e.g. "media", "multipart").Creates a charge invoice for a shipment group, and triggers a charge capture for orderinvoice enabled orders.
google_shoppingcontent.content.orderinvoices.createchargeinvoice({
"merchantId": "",
"orderId": ""
}, context)
object
string
: The ID of the account that manages the order. This cannot be a multi-client account.string
: The ID of the order.string
(values: 1, 2): V1 error format.string
: OAuth access token.string
(values: json, media, proto): Data format for response.string
: JSONPstring
: Selector specifying which fields to include in a partial response.string
: 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.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: 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.string
: Upload protocol for media (e.g. "raw", "multipart").string
: Legacy upload protocol for media (e.g. "media", "multipart").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.
google_shoppingcontent.content.orderinvoices.createrefundinvoice({
"merchantId": "",
"orderId": ""
}, context)
object
string
: The ID of the account that manages the order. This cannot be a multi-client account.string
: The ID of the order.string
(values: 1, 2): V1 error format.string
: OAuth access token.string
(values: json, media, proto): Data format for response.string
: JSONPstring
: Selector specifying which fields to include in a partial response.string
: 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.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: 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.string
: Upload protocol for media (e.g. "raw", "multipart").string
: Legacy upload protocol for media (e.g. "media", "multipart").Retrieves a report for disbursements from your Merchant Center account.
google_shoppingcontent.content.orderreports.listdisbursements({
"merchantId": ""
}, context)
object
string
: The ID of the account that manages the order. This cannot be a multi-client account.string
: The last date which disbursements occurred. In ISO 8601 format. Default: current date.string
: The first date which disbursements occurred. In ISO 8601 format.integer
: The maximum number of disbursements to return in the response, used for paging.string
: The token returned by the previous request.string
(values: 1, 2): V1 error format.string
: OAuth access token.string
(values: json, media, proto): Data format for response.string
: JSONPstring
: Selector specifying which fields to include in a partial response.string
: 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.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: 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.string
: Upload protocol for media (e.g. "raw", "multipart").string
: Legacy upload protocol for media (e.g. "media", "multipart").Retrieves a list of transactions for a disbursement from your Merchant Center account.
google_shoppingcontent.content.orderreports.listtransactions({
"merchantId": "",
"disbursementId": ""
}, context)
object
string
: The ID of the account that manages the order. This cannot be a multi-client account.string
: The Google-provided ID of the disbursement (found in Wallet).integer
: The maximum number of disbursements to return in the response, used for paging.string
: The token returned by the previous request.string
: The last date in which transaction occurred. In ISO 8601 format. Default: current date.string
: The first date in which transaction occurred. In ISO 8601 format.string
(values: 1, 2): V1 error format.string
: OAuth access token.string
(values: json, media, proto): Data format for response.string
: JSONPstring
: Selector specifying which fields to include in a partial response.string
: 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.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: 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.string
: Upload protocol for media (e.g. "raw", "multipart").string
: Legacy upload protocol for media (e.g. "media", "multipart").Lists order returns in your Merchant Center account.
google_shoppingcontent.content.orderreturns.list({
"merchantId": ""
}, context)
object
string
: The ID of the account that manages the order. This cannot be a multi-client account.string
: Obtains order returns created before this date (inclusively), in ISO 8601 format.string
: Obtains order returns created after this date (inclusively), in ISO 8601 format.integer
: 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.string
(values: RETURN_CREATION_TIME_DESC, RETURN_CREATION_TIME_ASC): Return the results in the specified order.string
: The token returned by the previous request.string
(values: 1, 2): V1 error format.string
: OAuth access token.string
(values: json, media, proto): Data format for response.string
: JSONPstring
: Selector specifying which fields to include in a partial response.string
: 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.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: 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.string
: Upload protocol for media (e.g. "raw", "multipart").string
: Legacy upload protocol for media (e.g. "media", "multipart").Retrieves an order return from your Merchant Center account.
google_shoppingcontent.content.orderreturns.get({
"merchantId": "",
"returnId": ""
}, context)
object
string
: The ID of the account that manages the order. This cannot be a multi-client account.string
: Merchant order return ID generated by Google.string
(values: 1, 2): V1 error format.string
: OAuth access token.string
(values: json, media, proto): Data format for response.string
: JSONPstring
: Selector specifying which fields to include in a partial response.string
: 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.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: 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.string
: Upload protocol for media (e.g. "raw", "multipart").string
: Legacy upload protocol for media (e.g. "media", "multipart").Lists the orders in your Merchant Center account.
google_shoppingcontent.content.orders.list({
"merchantId": ""
}, context)
object
string
: The ID of the account that manages the order. This cannot be a multi-client account.boolean
: 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.integer
: 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.string
: Order results by placement date in descending or ascending order. Acceptable values are: - placedDateAsc - placedDateDescstring
: The token returned by the previous request.string
: Obtains orders placed before this date (exclusively), in ISO 8601 format.string
: Obtains orders placed after this date (inclusively), in ISO 8601 format.array
: 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
.string
(values: 1, 2): V1 error format.string
: OAuth access token.string
(values: json, media, proto): Data format for response.string
: JSONPstring
: Selector specifying which fields to include in a partial response.string
: 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.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: 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.string
: Upload protocol for media (e.g. "raw", "multipart").string
: Legacy upload protocol for media (e.g. "media", "multipart").Retrieves an order from your Merchant Center account.
google_shoppingcontent.content.orders.get({
"merchantId": "",
"orderId": ""
}, context)
object
string
: The ID of the account that manages the order. This cannot be a multi-client account.string
: The ID of the order.string
(values: 1, 2): V1 error format.string
: OAuth access token.string
(values: json, media, proto): Data format for response.string
: JSONPstring
: Selector specifying which fields to include in a partial response.string
: 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.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: 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.string
: Upload protocol for media (e.g. "raw", "multipart").string
: Legacy upload protocol for media (e.g. "media", "multipart").Marks an order as acknowledged.
google_shoppingcontent.content.orders.acknowledge({
"merchantId": "",
"orderId": ""
}, context)
object
string
: The ID of the account that manages the order. This cannot be a multi-client account.string
: The ID of the order.string
(values: 1, 2): V1 error format.string
: OAuth access token.string
(values: json, media, proto): Data format for response.string
: JSONPstring
: Selector specifying which fields to include in a partial response.string
: 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.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: 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.string
: Upload protocol for media (e.g. "raw", "multipart").string
: Legacy upload protocol for media (e.g. "media", "multipart").Cancels all line items in an order, making a full refund.
google_shoppingcontent.content.orders.cancel({
"merchantId": "",
"orderId": ""
}, context)
object
string
: The ID of the account that manages the order. This cannot be a multi-client account.string
: The ID of the order to cancel.string
(values: 1, 2): V1 error format.string
: OAuth access token.string
(values: json, media, proto): Data format for response.string
: JSONPstring
: Selector specifying which fields to include in a partial response.string
: 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.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: 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.string
: Upload protocol for media (e.g. "raw", "multipart").string
: Legacy upload protocol for media (e.g. "media", "multipart").Cancels a line item, making a full refund.
google_shoppingcontent.content.orders.cancellineitem({
"merchantId": "",
"orderId": ""
}, context)
object
string
: The ID of the account that manages the order. This cannot be a multi-client account.string
: The ID of the order.string
(values: 1, 2): V1 error format.string
: OAuth access token.string
(values: json, media, proto): Data format for response.string
: JSONPstring
: Selector specifying which fields to include in a partial response.string
: 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.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: 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.string
: Upload protocol for media (e.g. "raw", "multipart").string
: Legacy upload protocol for media (e.g. "media", "multipart").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.
google_shoppingcontent.content.orders.instorerefundlineitem({
"merchantId": "",
"orderId": ""
}, context)
object
string
: The ID of the account that manages the order. This cannot be a multi-client account.string
: The ID of the order.string
(values: 1, 2): V1 error format.string
: OAuth access token.string
(values: json, media, proto): Data format for response.string
: JSONPstring
: Selector specifying which fields to include in a partial response.string
: 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.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: 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.string
: Upload protocol for media (e.g. "raw", "multipart").string
: Legacy upload protocol for media (e.g. "media", "multipart").Deprecated, please use returnRefundLineItem instead.
google_shoppingcontent.content.orders.refund({
"merchantId": "",
"orderId": ""
}, context)
object
string
: The ID of the account that manages the order. This cannot be a multi-client account.string
: The ID of the order to refund.string
(values: 1, 2): V1 error format.string
: OAuth access token.string
(values: json, media, proto): Data format for response.string
: JSONPstring
: Selector specifying which fields to include in a partial response.string
: 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.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: 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.string
: Upload protocol for media (e.g. "raw", "multipart").string
: Legacy upload protocol for media (e.g. "media", "multipart").Rejects return on an line item.
google_shoppingcontent.content.orders.rejectreturnlineitem({
"merchantId": "",
"orderId": ""
}, context)
object
string
: The ID of the account that manages the order. This cannot be a multi-client account.string
: The ID of the order.string
(values: 1, 2): V1 error format.string
: OAuth access token.string
(values: json, media, proto): Data format for response.string
: JSONPstring
: Selector specifying which fields to include in a partial response.string
: 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.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: 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.string
: Upload protocol for media (e.g. "raw", "multipart").string
: Legacy upload protocol for media (e.g. "media", "multipart").Returns a line item.
google_shoppingcontent.content.orders.returnlineitem({
"merchantId": "",
"orderId": ""
}, context)
object
string
: The ID of the account that manages the order. This cannot be a multi-client account.string
: The ID of the order.string
(values: 1, 2): V1 error format.string
: OAuth access token.string
(values: json, media, proto): Data format for response.string
: JSONPstring
: Selector specifying which fields to include in a partial response.string
: 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.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: 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.string
: Upload protocol for media (e.g. "raw", "multipart").string
: Legacy upload protocol for media (e.g. "media", "multipart").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.
google_shoppingcontent.content.orders.returnrefundlineitem({
"merchantId": "",
"orderId": ""
}, context)
object
string
: The ID of the account that manages the order. This cannot be a multi-client account.string
: The ID of the order.string
(values: 1, 2): V1 error format.string
: OAuth access token.string
(values: json, media, proto): Data format for response.string
: JSONPstring
: Selector specifying which fields to include in a partial response.string
: 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.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: 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.string
: Upload protocol for media (e.g. "raw", "multipart").string
: Legacy upload protocol for media (e.g. "media", "multipart").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.
google_shoppingcontent.content.orders.setlineitemmetadata({
"merchantId": "",
"orderId": ""
}, context)
object
string
: The ID of the account that manages the order. This cannot be a multi-client account.string
: The ID of the order.string
(values: 1, 2): V1 error format.string
: OAuth access token.string
(values: json, media, proto): Data format for response.string
: JSONPstring
: Selector specifying which fields to include in a partial response.string
: 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.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: 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.string
: Upload protocol for media (e.g. "raw", "multipart").string
: Legacy upload protocol for media (e.g. "media", "multipart").Marks line item(s) as shipped.
google_shoppingcontent.content.orders.shiplineitems({
"merchantId": "",
"orderId": ""
}, context)
object
string
: The ID of the account that manages the order. This cannot be a multi-client account.string
: The ID of the order.string
(values: 1, 2): V1 error format.string
: OAuth access token.string
(values: json, media, proto): Data format for response.string
: JSONPstring
: Selector specifying which fields to include in a partial response.string
: 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.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: 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.string
: Upload protocol for media (e.g. "raw", "multipart").string
: Legacy upload protocol for media (e.g. "media", "multipart").Sandbox only. Creates a test return.
google_shoppingcontent.content.orders.createtestreturn({
"merchantId": "",
"orderId": ""
}, context)
object
string
: The ID of the account that manages the order. This cannot be a multi-client account.string
: The ID of the order.string
(values: 1, 2): V1 error format.string
: OAuth access token.string
(values: json, media, proto): Data format for response.string
: JSONPstring
: Selector specifying which fields to include in a partial response.string
: 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.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: 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.string
: Upload protocol for media (e.g. "raw", "multipart").string
: Legacy upload protocol for media (e.g. "media", "multipart").Updates ship by and delivery by dates for a line item.
google_shoppingcontent.content.orders.updatelineitemshippingdetails({
"merchantId": "",
"orderId": ""
}, context)
object
string
: The ID of the account that manages the order. This cannot be a multi-client account.string
: The ID of the order.string
(values: 1, 2): V1 error format.string
: OAuth access token.string
(values: json, media, proto): Data format for response.string
: JSONPstring
: Selector specifying which fields to include in a partial response.string
: 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.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: 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.string
: Upload protocol for media (e.g. "raw", "multipart").string
: Legacy upload protocol for media (e.g. "media", "multipart").Updates the merchant order ID for a given order.
google_shoppingcontent.content.orders.updatemerchantorderid({
"merchantId": "",
"orderId": ""
}, context)
object
string
: The ID of the account that manages the order. This cannot be a multi-client account.string
: The ID of the order.string
(values: 1, 2): V1 error format.string
: OAuth access token.string
(values: json, media, proto): Data format for response.string
: JSONPstring
: Selector specifying which fields to include in a partial response.string
: 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.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: 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.string
: Upload protocol for media (e.g. "raw", "multipart").string
: Legacy upload protocol for media (e.g. "media", "multipart").Updates a shipment's status, carrier, and/or tracking ID.
google_shoppingcontent.content.orders.updateshipment({
"merchantId": "",
"orderId": ""
}, context)
object
string
: The ID of the account that manages the order. This cannot be a multi-client account.string
: The ID of the order.string
(values: 1, 2): V1 error format.string
: OAuth access token.string
(values: json, media, proto): Data format for response.string
: JSONPstring
: Selector specifying which fields to include in a partial response.string
: 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.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: 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.string
: Upload protocol for media (e.g. "raw", "multipart").string
: Legacy upload protocol for media (e.g. "media", "multipart").Retrieves an order using merchant order ID.
google_shoppingcontent.content.orders.getbymerchantorderid({
"merchantId": "",
"merchantOrderId": ""
}, context)
object
string
: The ID of the account that manages the order. This cannot be a multi-client account.string
: The merchant order ID to be looked for.string
(values: 1, 2): V1 error format.string
: OAuth access token.string
(values: json, media, proto): Data format for response.string
: JSONPstring
: Selector specifying which fields to include in a partial response.string
: 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.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: 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.string
: Upload protocol for media (e.g. "raw", "multipart").string
: Legacy upload protocol for media (e.g. "media", "multipart").Submit inventory for the given merchant.
google_shoppingcontent.content.pos.inventory({
"merchantId": "",
"targetMerchantId": ""
}, context)
object
string
: The ID of the POS or inventory data provider.string
: The ID of the target merchant.boolean
: 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).string
(values: 1, 2): V1 error format.string
: OAuth access token.string
(values: json, media, proto): Data format for response.string
: JSONPstring
: Selector specifying which fields to include in a partial response.string
: 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.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: 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.string
: Upload protocol for media (e.g. "raw", "multipart").string
: Legacy upload protocol for media (e.g. "media", "multipart").Submit a sale event for the given merchant.
google_shoppingcontent.content.pos.sale({
"merchantId": "",
"targetMerchantId": ""
}, context)
object
string
: The ID of the POS or inventory data provider.string
: The ID of the target merchant.boolean
: 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).string
(values: 1, 2): V1 error format.string
: OAuth access token.string
(values: json, media, proto): Data format for response.string
: JSONPstring
: Selector specifying which fields to include in a partial response.string
: 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.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: 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.string
: Upload protocol for media (e.g. "raw", "multipart").string
: Legacy upload protocol for media (e.g. "media", "multipart").Lists the stores of the target merchant.
google_shoppingcontent.content.pos.list({
"merchantId": "",
"targetMerchantId": ""
}, context)
object
string
: The ID of the POS or inventory data provider.string
: The ID of the target merchant.string
(values: 1, 2): V1 error format.string
: OAuth access token.string
(values: json, media, proto): Data format for response.string
: JSONPstring
: Selector specifying which fields to include in a partial response.string
: 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.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: 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.string
: Upload protocol for media (e.g. "raw", "multipart").string
: Legacy upload protocol for media (e.g. "media", "multipart").Creates a store for the given merchant.
google_shoppingcontent.content.pos.insert({
"merchantId": "",
"targetMerchantId": ""
}, context)
object
string
: The ID of the POS or inventory data provider.string
: The ID of the target merchant.boolean
: 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).string
(values: 1, 2): V1 error format.string
: OAuth access token.string
(values: json, media, proto): Data format for response.string
: JSONPstring
: Selector specifying which fields to include in a partial response.string
: 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.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: 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.string
: Upload protocol for media (e.g. "raw", "multipart").string
: Legacy upload protocol for media (e.g. "media", "multipart").Deletes a store for the given merchant.
google_shoppingcontent.content.pos.delete({
"merchantId": "",
"targetMerchantId": "",
"storeCode": ""
}, context)
object
string
: The ID of the POS or inventory data provider.string
: The ID of the target merchant.string
: A store code that is unique per merchant.boolean
: 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).string
(values: 1, 2): V1 error format.string
: OAuth access token.string
(values: json, media, proto): Data format for response.string
: JSONPstring
: Selector specifying which fields to include in a partial response.string
: 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.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: 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.string
: Upload protocol for media (e.g. "raw", "multipart").string
: Legacy upload protocol for media (e.g. "media", "multipart").Output schema unknown
Retrieves information about the given store.
google_shoppingcontent.content.pos.get({
"merchantId": "",
"targetMerchantId": "",
"storeCode": ""
}, context)
object
string
: The ID of the POS or inventory data provider.string
: The ID of the target merchant.string
: A store code that is unique per merchant.string
(values: 1, 2): V1 error format.string
: OAuth access token.string
(values: json, media, proto): Data format for response.string
: JSONPstring
: Selector specifying which fields to include in a partial response.string
: 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.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: 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.string
: Upload protocol for media (e.g. "raw", "multipart").string
: Legacy upload protocol for media (e.g. "media", "multipart").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.
google_shoppingcontent.content.products.list({
"merchantId": ""
}, context)
object
string
: The ID of the account that contains the products. This account cannot be a multi-client account.boolean
: 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).integer
: The maximum number of products to return in the response, used for paging.string
: The token returned by the previous request.string
(values: 1, 2): V1 error format.string
: OAuth access token.string
(values: json, media, proto): Data format for response.string
: JSONPstring
: Selector specifying which fields to include in a partial response.string
: 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.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: 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.string
: Upload protocol for media (e.g. "raw", "multipart").string
: Legacy upload protocol for media (e.g. "media", "multipart").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.
google_shoppingcontent.content.products.insert({
"merchantId": ""
}, context)
object
string
: The ID of the account that contains the product. This account cannot be a multi-client account.boolean
: 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).string
(values: 1, 2): V1 error format.string
: OAuth access token.string
(values: json, media, proto): Data format for response.string
: JSONPstring
: Selector specifying which fields to include in a partial response.string
: 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.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: 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.string
: Upload protocol for media (e.g. "raw", "multipart").string
: Legacy upload protocol for media (e.g. "media", "multipart").Deletes a product from your Merchant Center account.
google_shoppingcontent.content.products.delete({
"merchantId": "",
"productId": ""
}, context)
object
string
: The ID of the account that contains the product. This account cannot be a multi-client account.string
: The REST ID of the product.boolean
: 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).string
(values: 1, 2): V1 error format.string
: OAuth access token.string
(values: json, media, proto): Data format for response.string
: JSONPstring
: Selector specifying which fields to include in a partial response.string
: 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.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: 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.string
: Upload protocol for media (e.g. "raw", "multipart").string
: Legacy upload protocol for media (e.g. "media", "multipart").Output schema unknown
Retrieves a product from your Merchant Center account.
google_shoppingcontent.content.products.get({
"merchantId": "",
"productId": ""
}, context)
object
string
: The ID of the account that contains the product. This account cannot be a multi-client account.string
: The REST ID of the product.string
(values: 1, 2): V1 error format.string
: OAuth access token.string
(values: json, media, proto): Data format for response.string
: JSONPstring
: Selector specifying which fields to include in a partial response.string
: 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.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: 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.string
: Upload protocol for media (e.g. "raw", "multipart").string
: Legacy upload protocol for media (e.g. "media", "multipart").Lists the statuses of the products in your Merchant Center account.
google_shoppingcontent.content.productstatuses.list({
"merchantId": ""
}, context)
object
string
: The ID of the account that contains the products. This account cannot be a multi-client account.array
: If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination.boolean
: Flag to include full product data in the results of the list request. The default value is false.boolean
: 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).integer
: The maximum number of product statuses to return in the response, used for paging.string
: The token returned by the previous request.string
(values: 1, 2): V1 error format.string
: OAuth access token.string
(values: json, media, proto): Data format for response.string
: JSONPstring
: Selector specifying which fields to include in a partial response.string
: 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.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: 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.string
: Upload protocol for media (e.g. "raw", "multipart").string
: Legacy upload protocol for media (e.g. "media", "multipart").Gets the status of a product from your Merchant Center account.
google_shoppingcontent.content.productstatuses.get({
"merchantId": "",
"productId": ""
}, context)
object
string
: The ID of the account that contains the product. This account cannot be a multi-client account.string
: The REST ID of the product.array
: If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination.boolean
: Flag to include full product data in the result of this get request. The default value is false.string
(values: 1, 2): V1 error format.string
: OAuth access token.string
(values: json, media, proto): Data format for response.string
: JSONPstring
: Selector specifying which fields to include in a partial response.string
: 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.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: 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.string
: Upload protocol for media (e.g. "raw", "multipart").string
: Legacy upload protocol for media (e.g. "media", "multipart").Lists the shipping settings of the sub-accounts in your Merchant Center account.
google_shoppingcontent.content.shippingsettings.list({
"merchantId": ""
}, context)
object
string
: The ID of the managing account. This must be a multi-client account.integer
: The maximum number of shipping settings to return in the response, used for paging.string
: The token returned by the previous request.string
(values: 1, 2): V1 error format.string
: OAuth access token.string
(values: json, media, proto): Data format for response.string
: JSONPstring
: Selector specifying which fields to include in a partial response.string
: 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.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: 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.string
: Upload protocol for media (e.g. "raw", "multipart").string
: Legacy upload protocol for media (e.g. "media", "multipart").Retrieves the shipping settings of the account.
google_shoppingcontent.content.shippingsettings.get({
"merchantId": "",
"accountId": ""
}, context)
object
string
: 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.string
: The ID of the account for which to get/update shipping settings.string
(values: 1, 2): V1 error format.string
: OAuth access token.string
(values: json, media, proto): Data format for response.string
: JSONPstring
: Selector specifying which fields to include in a partial response.string
: 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.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: 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.string
: Upload protocol for media (e.g. "raw", "multipart").string
: Legacy upload protocol for media (e.g. "media", "multipart").Updates the shipping settings of the account. Any fields that are not provided are deleted from the resource.
google_shoppingcontent.content.shippingsettings.update({
"merchantId": "",
"accountId": ""
}, context)
object
string
: 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.string
: The ID of the account for which to get/update shipping settings.boolean
: 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).string
(values: 1, 2): V1 error format.string
: OAuth access token.string
(values: json, media, proto): Data format for response.string
: JSONPstring
: Selector specifying which fields to include in a partial response.string
: 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.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: 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.string
: Upload protocol for media (e.g. "raw", "multipart").string
: Legacy upload protocol for media (e.g. "media", "multipart").Retrieves supported carriers and carrier services for an account.
google_shoppingcontent.content.shippingsettings.getsupportedcarriers({
"merchantId": ""
}, context)
object
string
: The ID of the account for which to retrieve the supported carriers.string
(values: 1, 2): V1 error format.string
: OAuth access token.string
(values: json, media, proto): Data format for response.string
: JSONPstring
: Selector specifying which fields to include in a partial response.string
: 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.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: 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.string
: Upload protocol for media (e.g. "raw", "multipart").string
: Legacy upload protocol for media (e.g. "media", "multipart").Retrieves supported holidays for an account.
google_shoppingcontent.content.shippingsettings.getsupportedholidays({
"merchantId": ""
}, context)
object
string
: The ID of the account for which to retrieve the supported holidays.string
(values: 1, 2): V1 error format.string
: OAuth access token.string
(values: json, media, proto): Data format for response.string
: JSONPstring
: Selector specifying which fields to include in a partial response.string
: 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.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: 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.string
: Upload protocol for media (e.g. "raw", "multipart").string
: Legacy upload protocol for media (e.g. "media", "multipart").Retrieves supported pickup services for an account.
google_shoppingcontent.content.shippingsettings.getsupportedpickupservices({
"merchantId": ""
}, context)
object
string
: The ID of the account for which to retrieve the supported pickup services.string
(values: 1, 2): V1 error format.string
: OAuth access token.string
(values: json, media, proto): Data format for response.string
: JSONPstring
: Selector specifying which fields to include in a partial response.string
: 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.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: 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.string
: Upload protocol for media (e.g. "raw", "multipart").string
: Legacy upload protocol for media (e.g. "media", "multipart").Sandbox only. Creates a test order.
google_shoppingcontent.content.orders.createtestorder({
"merchantId": ""
}, context)
object
string
: The ID of the account that should manage the order. This cannot be a multi-client account.string
(values: 1, 2): V1 error format.string
: OAuth access token.string
(values: json, media, proto): Data format for response.string
: JSONPstring
: Selector specifying which fields to include in a partial response.string
: 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.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: 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.string
: Upload protocol for media (e.g. "raw", "multipart").string
: Legacy upload protocol for media (e.g. "media", "multipart").Sandbox only. Moves a test order from state "inProgress
" to state "pendingShipment
".
google_shoppingcontent.content.orders.advancetestorder({
"merchantId": "",
"orderId": ""
}, context)
object
string
: The ID of the account that manages the order. This cannot be a multi-client account.string
: The ID of the test order to modify.string
(values: 1, 2): V1 error format.string
: OAuth access token.string
(values: json, media, proto): Data format for response.string
: JSONPstring
: Selector specifying which fields to include in a partial response.string
: 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.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: 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.string
: Upload protocol for media (e.g. "raw", "multipart").string
: Legacy upload protocol for media (e.g. "media", "multipart").Sandbox only. Cancels a test order for customer-initiated cancellation.
google_shoppingcontent.content.orders.canceltestorderbycustomer({
"merchantId": "",
"orderId": ""
}, context)
object
string
: The ID of the account that manages the order. This cannot be a multi-client account.string
: The ID of the test order to cancel.string
(values: 1, 2): V1 error format.string
: OAuth access token.string
(values: json, media, proto): Data format for response.string
: JSONPstring
: Selector specifying which fields to include in a partial response.string
: 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.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: 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.string
: Upload protocol for media (e.g. "raw", "multipart").string
: Legacy upload protocol for media (e.g. "media", "multipart").Sandbox only. Retrieves an order template that can be used to quickly create a new order in sandbox.
google_shoppingcontent.content.orders.gettestordertemplate({
"merchantId": "",
"templateName": ""
}, context)
object
string
: The ID of the account that should manage the order. This cannot be a multi-client account.string
(values: TEMPLATE1, TEMPLATE2, TEMPLATE1A, TEMPLATE1B, TEMPLATE3): The name of the template to retrieve.string
: The country of the template to retrieve. Defaults to US
.string
(values: 1, 2): V1 error format.string
: OAuth access token.string
(values: json, media, proto): Data format for response.string
: JSONPstring
: Selector specifying which fields to include in a partial response.string
: 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.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: 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.string
: Upload protocol for media (e.g. "raw", "multipart").string
: Legacy upload protocol for media (e.g. "media", "multipart").object
: 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.
boolean
: Indicates whether the merchant sells adult content.array
: 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.
string
: Required for update. Merchant Center account ID.string
: Identifies what kind of resource this is. Value: the fixed string "content#account
"string
: Required. Display name for the account.string
: [DEPRECATED] This field is never returned and will be ignored if provided.string
: Client-specific, locally-unique, internal ID for the child account.array
: Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
string
: The merchant's website.array
: 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.
object
string
: 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.string
: City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).string
: Postal code or ZIP (e.g. "94043").string
: Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC").string
: Street-level part of the address.object
string
: Customer ID of the AdWords account.string
: 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
"object
string
: The phone number of the business.object
string
: Customer service email.string
: Customer service phone number.string
: Customer service URL.object
string
: 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.string
: Status of the link between this Merchant Center account and the GMB account. Acceptable values are: - "active
" - "pending
"object
string
: The aggregator ID, set for aggregators and subaccounts (in that case, it represents the aggregator of the subaccount).string
: The merchant account ID, set for individual accounts and subaccounts.object
: The status of an account, i.e., information about its products, which is computed offline and not returned immediately at insertion time.
string
: The ID of the account for which the status is reported.array
: A list of account level issues.
array
: DEPRECATED - never populated.
string
: Identifies what kind of resource this is. Value: the fixed string "content#accountStatus
"array
: List of product-related data by channel, destination, and country. Data in this field may be delayed by up to 30 minutes.
boolean
: Whether the account's website is claimed or not.object
string
: Country for which this issue is reported.string
: The destination the issue applies to. If this field is empty then the issue applies to all available destinations.string
: Additional details about the issue.string
: The URL of a web page to help resolving this issue.string
: Issue identifier.string
: Severity of the issue. Acceptable values are: - "critical
" - "error
" - "suggestion
"string
: Short description of the issue.object
string
string
string
string
array
string
string
string
integer
string
: Acceptable values are: - "critical
" - "error
" - "suggestion
"string
object
string
string
string
string
string
object
string
: The attribute's name, if the issue is caused by a single attribute.string
: The error code of the issue.string
: A short issue description in English.string
: A detailed issue description in English.string
: The URL of a web page to help with resolving this issue.string
: Number of items with this issue.string
: Whether the issue can be resolved by the merchant.string
: How this issue affects serving of the offer.object
string
: The channel the data applies to. Acceptable values are: - "local
" - "online
"string
: The country the data applies to.string
: The destination the data applies to.array
: List of item-level issues.
object
string
: Number of active offers.string
: Number of disapproved offers.string
: Number of expiring offers.string
: Number of pending offers.object
: The tax settings of a merchant account. All methods require the admin role.
string
: Required. The ID of the account to which these account tax settings belong.string
: Identifies what kind of resource this is. Value: the fixed string "content#accountTax".array
: Tax rules. Updating the tax rules will enable US taxes (not reversible). Defining no rules is equivalent to not charging tax at all.
object
: Tax calculation rule to apply in a state or province (USA only).
string
: Country code in which tax is applicable.string
: Required. State (or province) is which the tax is applicable, described by its location ID (also called criteria ID).string
: Explicit tax rate in percent, represented as a floating point number without the percentage character. Must not be negative.boolean
: If true, shipping charges are also taxed.boolean
: Whether the tax rate is taken from a global tax table or specified explicitly.object
boolean
: Whether user is an admin.string
: User's email address.boolean
: Whether user is an order manager.boolean
: Whether user can access payment statements.boolean
: Whether user can manage payment settings.object
string
: Channel ID.string
: 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.object
array
: 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.
string
: Identifies what kind of resource this is. Value: the fixed string "content#accountsAuthInfoResponse".object
string
: Identifies what kind of resource this is. Value: the fixed string "content#accountsClaimWebsiteResponse".object
array
: The request entries to be processed in the batch.
object
: A batch entry encoding a single non-batch accounts request.
string
: The ID of the targeted account. Only defined if the method is not insert
.integer
: An entry ID, unique within the batch request.boolean
: Whether the account should be deleted if the account has offers. Only applicable if the method is delete
.array
: Label IDs for the 'updatelabels' request.
string
string
: The ID of the managing account.string
: The method of the batch entry. Acceptable values are: - "claimWebsite
" - "delete
" - "get
" - "insert
" - "link
" - "update
"boolean
: Only applicable if the method is claimwebsite
. Indicates whether or not to take the claim from another account in case there is a conflict.object
string
: Action to perform for this link. The "request"
action is only available to select merchants. Acceptable values are: - "approve
" - "remove
" - "request
"string
: Type of the link between the two accounts. Acceptable values are: - "channelPartner
" - "eCommercePlatform
"string
: The ID of the linked account.object
array
: The result of the execution of the batch requests.
string
: Identifies what kind of resource this is. Value: the fixed string "content#accountsCustomBatchResponse".object
: A batch entry encoding a single non-batch accounts response.
integer
: The ID of the request entry this entry responds to.string
: Identifies what kind of resource this is. Value: the fixed string "content#accountsCustomBatchResponseEntry
"string
: Deprecated. This field is never set. Acceptable values are: - "active
" - "inactive
" - "pending
"object
string
: Action to perform for this link. The "request"
action is only available to select merchants. Acceptable values are: - "approve
" - "remove
" - "request
"string
: Type of the link between the two accounts. Acceptable values are: - "channelPartner
" - "eCommercePlatform
"string
: The ID of the linked account.object
string
: Identifies what kind of resource this is. Value: the fixed string "content#accountsLinkResponse".object
string
: Identifies what kind of resource this is. Value: the fixed string "content#accountsListResponse".string
: The token for the retrieval of the next page of accounts.array
object
array
: The request entries to be processed in the batch.
object
: A batch entry encoding a single non-batch accountstatuses request.
string
: The ID of the (sub-)account whose status to get.integer
: An entry ID, unique within the batch request.array
: If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination.
string
string
: The ID of the managing account.string
: The method of the batch entry. Acceptable values are: - "get
"object
array
: The result of the execution of the batch requests.
string
: Identifies what kind of resource this is. Value: the fixed string "content#accountstatusesCustomBatchResponse".object
: A batch entry encoding a single non-batch accountstatuses response.
integer
: The ID of the request entry this entry responds to.object
string
: Identifies what kind of resource this is. Value: the fixed string "content#accountstatusesListResponse".string
: The token for the retrieval of the next page of account statuses.array
object
array
: The request entries to be processed in the batch.
object
: A batch entry encoding a single non-batch accounttax request.
string
: The ID of the account for which to get/update account tax settings.integer
: An entry ID, unique within the batch request.string
: The ID of the managing account.string
: The method of the batch entry. Acceptable values are: - "get
" - "update
"object
array
: The result of the execution of the batch requests.
string
: Identifies what kind of resource this is. Value: the fixed string "content#accounttaxCustomBatchResponse".object
: A batch entry encoding a single non-batch accounttax response.
integer
: The ID of the request entry this entry responds to.string
: Identifies what kind of resource this is. Value: the fixed string "content#accounttaxCustomBatchResponseEntry
"object
string
: Identifies what kind of resource this is. Value: the fixed string "content#accounttaxListResponse".string
: The token for the retrieval of the next page of account tax settings.array
object
array
: Regular business days. May not be empty.
string
object
string
: Carrier service, such as "UPS"
or "Fedex"
. The list of supported carriers can be retrieved via the getSupportedCarriers
method. Required.string
: Carrier service, such as "ground"
or "2 days"
. The list of supported services for a carrier can be retrieved via the getSupportedCarriers
method. Required.string
: Name of the carrier rate. Must be unique per rate group. Required.string
: Shipping origin for this carrier rate. Required.string
: 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.object
string
: The CLDR country code of the carrier (e.g., "US"). Always present.string
: The name of the carrier (e.g., "UPS"
). Always present.array
: A list of supported services (e.g., "ground"
) for that carrier. Contains at least one service.
string
object
string
: The name of the attribute. Underscores will be replaced by spaces upon insertion.string
: The type of the attribute. Acceptable values are: - "boolean
" - "datetimerange
" - "float
" - "group
" - "int
" - "price
" - "text
" - "time
" - "url
"string
: Free-form unit of the attribute. Unit can only be used for values of type int, float, or price.string
: The value of the attribute.object
array
: The sub-attributes.
string
: The name of the group. Underscores will be replaced by spaces upon insertion.object
string
: Description of the reason.string
: Code of the return reason. Acceptable values are: - "betterPriceFound
" - "changedMind
" - "damagedOrDefectiveItem
" - "didNotMatchDescription
" - "doesNotFit
" - "expiredItem
" - "incorrectItemReceived
" - "noLongerNeeded
" - "notSpecified
" - "orderedWrongItem
" - "other
" - "qualityNotExpected
" - "receivedTooLate
" - "undeliverable
"object
integer
: Hour of the cutoff time until which an order has to be placed to be processed in the same day. Required.integer
: Minute of the cutoff time until which an order has to be placed to be processed in the same day. Required.string
: Timezone identifier for the cutoff time. A list of identifiers can be found in the AdWords API documentation. E.g. "Europe/Zurich". Required.object
: Datafeed configuration data.
string
: The two-letter ISO 639-1 language in which the attributes are defined in the data feed.string
: [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
.string
: 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
"string
: Required. The filename of the feed. All feeds must have a unique file name.string
: Required for update. The ID of the data feed.array
: [DEPRECATED] Please use targets[].includedDestinations instead. The list of intended destinations (corresponds to checked check boxes in Merchant Center).
string
string
: Identifies what kind of resource this is. Value: the fixed string "content#datafeed
"string
: Required for insert. A descriptive name of the data feed.string
: [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.array
: The targets this feed should apply to (country, language, destinations).
object
: 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.
integer
: The day of the month the feed file should be fetched (1-31).string
: 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.integer
: The hour of the day the feed file should be fetched (0-23).integer
: The minute of the hour the feed file should be fetched (0-59). Read-only.string
: An optional password for fetch_url.boolean
: Whether the scheduled fetch is paused or not.string
: Time zone used for schedule. UTC by default. E.g., "America/Los_Angeles".string
: An optional user name for fetch_url.string
: The day of the week the feed file should be fetched. Acceptable values are: - "monday
" - "tuesday
" - "wednesday
" - "thursday
" - "friday
" - "saturday
" - "sunday
"object
string
: 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
"string
: 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
"string
: 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
"object
: The status of a datafeed, i.e., the result of the last retrieval of the datafeed computed asynchronously when the feed processing is finished.
string
: The country for which the status is reported, represented as a CLDR territory code.string
: The ID of the feed for which the status is reported.array
: The list of errors occurring in the feed.
string
: The number of items in the feed that were processed.string
: The number of items in the feed that were valid.string
: Identifies what kind of resource this is. Value: the fixed string "content#datafeedStatus
"string
: The two-letter ISO 639-1 language for which the status is reported.string
: The last date at which the feed was uploaded.string
: 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.array
: The list of errors occurring in the feed.
object
: An error occurring in the feed, like "invalid price".
string
: The code of the error, e.g., "validation/invalid_value".string
: The number of occurrences of the error in the feed.array
: A list of example occurrences of the error, grouped by product.
string
: The error message, e.g., "Invalid price".object
: An example occurrence for a particular error.
string
: The ID of the example item.string
: Line number in the data feed where the example is found.string
: The problematic value.object
string
: The country where the items in the feed will be included in the search index, represented as a CLDR territory code.array
: The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center).
string
array
: 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
string
string
: The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for targets[].country
.object
array
: The request entries to be processed in the batch.
object
: A batch entry encoding a single non-batch datafeeds request.
integer
: An entry ID, unique within the batch request.string
: The ID of the data feed to get, delete or fetch.string
: The ID of the managing account.string
: The method of the batch entry. Acceptable values are: - "delete
" - "fetchNow
" - "get
" - "insert
" - "update
"object
array
: The result of the execution of the batch requests.
string
: Identifies what kind of resource this is. Value: the fixed string "content#datafeedsCustomBatchResponse".object
: A batch entry encoding a single non-batch datafeeds response.
object
string
: Identifies what kind of resource this is. Value: the fixed string "content#datafeedsFetchNowResponse".object
string
: Identifies what kind of resource this is. Value: the fixed string "content#datafeedsListResponse".string
: The token for the retrieval of the next page of datafeeds.array
object
array
: The request entries to be processed in the batch.
object
: A batch entry encoding a single non-batch datafeedstatuses request.
integer
: An entry ID, unique within the batch request.string
: 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.string
: The ID of the data feed to get.string
: 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.string
: The ID of the managing account.string
: The method of the batch entry. Acceptable values are: - "get
"object
array
: The result of the execution of the batch requests.
string
: Identifies what kind of resource this is. Value: the fixed string "content#datafeedstatusesCustomBatchResponse".object
: A batch entry encoding a single non-batch datafeedstatuses response.
integer
: The ID of the request entry this entry responds to.object
string
: Identifies what kind of resource this is. Value: the fixed string "content#datafeedstatusesListResponse".string
: The token for the retrieval of the next page of datafeed statuses.array
object
array
: Holiday cutoff definitions. If configured, they specify order cutoff times for holiday-specific shipping.
integer
: Maximum number of business days spent before an order is shipped. 0 means same day shipped, 1 means next day shipped. Must be greater than or equal to minHandlingTimeInDays
.integer
: Maximum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Must be greater than or equal to minTransitTimeInDays
.integer
: Minimum number of business days spent before an order is shipped. 0 means same day shipped, 1 means next day shipped.integer
: Minimum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Either {min,max}TransitTimeInDays
or transitTimeTable
must be set, but not both.object
: An error returned by the API.
string
: The domain of the error.string
: A description of the error.string
: The error code.object
: A list of errors returned by a failed batch entry.
integer
: The HTTP status of the first error in errors
.array
: A list of errors.
string
: The message of the first error in errors
.object
string
: The ID of the Merchant Center account.array
: A list of GMB accounts which are available to the merchant.
object
string
: The email which identifies the GMB account.string
: Number of listings under this account.string
: The name of the GMB account.string
: The type of the GMB account (User or Business).object
: A non-empty list of row or column headers for a table. Exactly one of prices
, weights
, numItems
, postalCodeGroupNames
, or location
must be set.
array
: A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
array
: A list of inclusive number of items upper bounds. The last value can be "infinity"
. For example ["10", "50", "infinity"]
represents the headers "<= 10 items", "<= 50 items", and "> 50 items". Must be non-empty. Can only be set if all other fields are not set.
string
array
: 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.
string
array
: 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 "<= $10", "<= $500", and "> $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.
array
: 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 "<= 10kg", "<= 50kg", and "> 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.
object
string
: Date of the order deadline, in ISO 8601 format. E.g. "2016-11-29" for 29th November 2016. Required.integer
: Hour of the day on the deadline date until which the order has to be placed to qualify for the delivery guarantee. Possible values are: 0 (midnight), 1, ..., 12 (noon), 13, ..., 23. Required.string
: Timezone identifier for the deadline hour. A list of identifiers can be found in the AdWords API documentation. E.g. "Europe/Zurich". Required.string
: Unique identifier for the holiday. Required.string
: Date on which the deadline will become visible to consumers in ISO 8601 format. E.g. "2016-10-31" for 31st October 2016. Required.object
string
: 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.string
: Date of the holiday, in ISO 8601 format. E.g. "2016-12-25" for Christmas 2016. Always present.string
: 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.string
: 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.string
: Unique identifier for the holiday to be used when configuring holiday cutoffs. Always present.string
: The holiday type. Always present. Acceptable values are: - "Christmas
" - "Easter
" - "Father's Day
" - "Halloween
" - "Independence Day (USA)
" - "Mother's Day
" - "Thanksgiving
" - "Valentine's Day
"object
string
: The number of installments the buyer has to pay.object
string
: The availability of the product. Acceptable values are: - "in stock
" - "out of stock
" - "preorder
"string
: Custom label 0 for custom grouping of items in a Shopping campaign. Only supported for online products.string
: Custom label 1 for custom grouping of items in a Shopping campaign. Only supported for online products.string
: Custom label 2 for custom grouping of items in a Shopping campaign. Only supported for online products.string
: Custom label 3 for custom grouping of items in a Shopping campaign. Only supported for online products.string
: Custom label 3 for custom grouping of items in a Shopping campaign. Only supported for online products.string
: The instore product location. Supported only for local products.string
: Identifies what kind of resource this is. Value: the fixed string "content#inventory
"integer
: The quantity of the product. Must be equal to or greater than zero. Supported only for local products.string
: 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.integer
: The quantity of the product that is available for selling on Google. Supported only for online products.object
array
: The request entries to be processed in the batch.
object
: A batch entry encoding a single non-batch inventory request.
integer
: An entry ID, unique within the batch request.string
: The ID of the managing account.string
: The ID of the product for which to update price and availability.string
: The code of the store for which to update price and availability. Use online
to update price and availability of an online product.object
array
: The result of the execution of the batch requests.
string
: Identifies what kind of resource this is. Value: the fixed string "content#inventoryCustomBatchResponse".object
: A batch entry encoding a single non-batch inventory response.
integer
: The ID of the request entry this entry responds to.string
: Identifies what kind of resource this is. Value: the fixed string "content#inventoryCustomBatchResponseEntry
"object
string
: 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
"string
: 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
"object
string
: The availability of the product. Acceptable values are: - "in stock
" - "out of stock
" - "preorder
"string
: Custom label 0 for custom grouping of items in a Shopping campaign. Only supported for online products.string
: Custom label 1 for custom grouping of items in a Shopping campaign. Only supported for online products.string
: Custom label 2 for custom grouping of items in a Shopping campaign. Only supported for online products.string
: Custom label 3 for custom grouping of items in a Shopping campaign. Only supported for online products.string
: Custom label 3 for custom grouping of items in a Shopping campaign. Only supported for online products.string
: The instore product location. Supported only for local products.integer
: The quantity of the product. Must be equal to or greater than zero. Supported only for local products.string
: 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.integer
: The quantity of the product that is available for selling on Google. Supported only for online products.object
string
: Identifies what kind of resource this is. Value: the fixed string "content#inventorySetResponse".object
object
string
: [required] Type of the additional charge. Acceptable values are: - "shipping
"object
string
: The status of the verification process for the About page. Acceptable values are: - "active
" - "inactive
" - "pending
"string
: The URL for the About page.object
string
: Required. CLDR country code (e.g. "US").boolean
: The status of the "Merchant hosted local storefront" feature.boolean
: The status of the "Store pickup" feature.object
string
: The email of the contact for the inventory verification process.string
: The name of the contact for the inventory verification process.string
: The status of the verification contact. Acceptable values are: - "active
" - "inactive
" - "pending
"string
: The status of the inventory verification process. Acceptable values are: - "active
" - "inactive
" - "pending
"object
string
: Shipping cost and policy URL.string
: The status of the ?On display to order? feature. Acceptable values are: - "active
" - "inactive
" - "pending
"object
string
: The ID of the POS data provider.string
: The account ID by which this merchant is known to the POS data provider.object
: Local Inventory ads (LIA) settings. All methods except listposdataproviders require the admin role.
string
: The ID of the account to which these LIA settings belong. Ignored upon update, always present in get request responses.array
: The LIA settings for each country.
string
: Identifies what kind of resource this is. Value: the fixed string "content#liaSettings
"object
array
: The request entries to be processed in the batch.
object
string
: The ID of the account for which to get/update account LIA settings.integer
: An entry ID, unique within the batch request.string
: Inventory validation contact email. Required only for SetInventoryValidationContact.string
: Inventory validation contact name. Required only for SetInventoryValidationContact.string
: The country code. Required only for RequestInventoryVerification.string
: The GMB account. Required only for RequestGmbAccess.string
: The ID of the managing account.string
: The method of the batch entry. Acceptable values are: - "get
" - "getAccessibleGmbAccounts
" - "requestGmbAccess
" - "requestInventoryVerification
" - "setInventoryVerificationContact
" - "update
"string
: The ID of POS data provider. Required only for SetPosProvider.string
: The account ID by which this merchant is known to the POS provider.object
array
: The result of the execution of the batch requests.
string
: Identifies what kind of resource this is. Value: the fixed string "content#liasettingsCustomBatchResponse".object
integer
: The ID of the request entry to which this entry responds.string
: Identifies what kind of resource this is. Value: the fixed string "content#liasettingsCustomBatchResponseEntry
"array
: The list of POS data providers.
object
string
: The ID of the Merchant Center account.array
: A list of GMB accounts which are available to the merchant.
string
: Identifies what kind of resource this is. Value: the fixed string "content#liasettingsGetAccessibleGmbAccountsResponse".object
string
: Identifies what kind of resource this is. Value: the fixed string "content#liasettingsListPosDataProvidersResponse".array
: The list of POS data providers for each eligible country
object
string
: Identifies what kind of resource this is. Value: the fixed string "content#liasettingsListResponse".string
: The token for the retrieval of the next page of LIA settings.array
object
string
: Identifies what kind of resource this is. Value: the fixed string "content#liasettingsRequestGmbAccessResponse".object
string
: Identifies what kind of resource this is. Value: the fixed string "content#liasettingsRequestInventoryVerificationResponse".object
string
: Identifies what kind of resource this is. Value: the fixed string "content#liasettingsSetInventoryVerificationContactResponse".object
string
: Identifies what kind of resource this is. Value: the fixed string "content#liasettingsSetPosDataProviderResponse".object
array
: A non-empty list of location IDs. They must all be of the same location type (e.g., state).
string
object
string
: Name of loyalty points program. It is recommended to limit the name to 12 full-width characters or 24 Roman characters.string
: The retailer's loyalty points in absolute value.number
: 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.object
: Order return. Production access (all methods) requires the order manager role. Sandbox access does not.
string
: The date of creation of the return, in ISO 8601 format.string
: Merchant defined order ID.string
: Google order ID.string
: Order return ID generated by Google.array
: Items of the return.
array
: Shipments of the return.
object
string
: Product level item ID. If the returned items are of the same product, they will have the same ID.array
: IDs of the return shipments that this return item belongs to.
string
string
: State of the item. Acceptable values are: - "canceled
" - "new
" - "received
" - "refunded
" - "rejected
"object
array
object
: 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.
array
: A list of unique store codes or empty for the catch all.
string
object
: Order. Production access (all methods) requires the order manager role. Sandbox access does not.
boolean
: Whether the order was acknowledged.string
: Deprecated. Acceptable values are: - "googleExpress
" - "purchasesOnGoogle
"string
: The REST ID of the order. Globally unique.string
: Identifies what kind of resource this is. Value: the fixed string "content#order
"array
: Line items that are ordered.
string
string
: Merchant-provided ID of the order.string
: The status of the payment. Acceptable values are: - "paymentCaptured
" - "paymentRejected
" - "paymentSecured
" - "pendingAuthorization
"string
: The date when the order was placed, in ISO 8601 format.array
: 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.
array
: Refunds for the order.
array
: Shipments of the order.
string
: Deprecated. Shipping details are provided with line items instead. Acceptable values are: - "economy
" - "expedited
" - "oneDay
" - "sameDay
" - "standard
" - "twoDay
"string
: The status of the order. Acceptable values are: - "canceled
" - "delivered
" - "inProgress
" - "partiallyDelivered
" - "partiallyReturned
" - "partiallyShipped
" - "pendingShipment
" - "returned
" - "shipped
"string
: The party responsible for collecting and remitting taxes. Acceptable values are: - "marketplaceFacilitator
" - "merchant
"object
string
: CLDR country code (e.g. "US").array
: 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
string
boolean
: Whether the address is a post office box.string
: City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).string
: Postal Code or ZIP (e.g. "94043").string
: Name of the recipient.string
: Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC").array
: Street-level part of the address.
string
object
string
: The actor that created the cancellation. Acceptable values are: - "customer
" - "googleBot
" - "googleCustomerService
" - "googlePayments
" - "googleSabre
" - "merchant
"string
: Date on which the cancellation has been created, in ISO 8601 format.integer
: The quantity that was canceled.string
: 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
"string
: The explanation of the reason.object
string
: Deprecated.boolean
: Deprecated. Please use marketingRightsInfo instead.string
: Full name of the customer.string
: 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.object
string
: 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
"string
: Timestamp when last time marketing preference was updated. Could be empty, if user wasn't offered a selection yet.string
: 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.object
string
: The phone number of the person receiving the delivery.object
array
string
: 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.string
: Optional. The text code that corresponds to the promotion when applied on the retailer?s website.string
: The unique ID of the promotion.string
: The full title of the promotion.string
: Whether the promotion is applicable to all products or only specific products. Acceptable values are: - "allProducts
" - "specificProducts
"string
: Indicates that the promotion is valid online. Acceptable values are: - "online
"object
array
: The OfferId(s) that were purchased in this order and map to this specific benefit of the promotion.
string
string
: 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
"string
: Describes whether the promotion applies to products (e.g. 20% off) or to shipping (e.g. Free Shipping). Acceptable values are: - "product
" - "shipping
"object
array
: Annotations that are attached to the line item.
array
: Cancellations of the line item.
string
: The ID of the line item.integer
: Number of items canceled.integer
: Number of items delivered.integer
: Number of items ordered.integer
: Number of items pending.integer
: Number of items ready for pickup.integer
: Number of items returned.integer
: Number of items shipped.array
: Returns of the line item.
object
string
: Brand of the item.string
: The item's channel (online or local). Acceptable values are: - "local
" - "online
"string
: Condition or state of the item. Acceptable values are: - "new
" - "refurbished
" - "used
"string
: The two-letter ISO 639-1 language code for the item.array
: Associated fees at order creation time.
string
: Global Trade Item Number (GTIN) of the item.string
: The REST ID of the product.string
: URL of an image of the item.string
: Shared identifier for all variants of the same product.string
: Manufacturer Part Number (MPN) of the item.string
: An identifier of the item.string
: URL to the cached image shown to the user when order was placed.string
: The CLDR territory // code of the target country of the product.string
: The title of the product.array
: 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.
object
string
: Name of the fee.object
string
: The dimension of the variant.string
: The value for the dimension.object
integer
: Required. How many days later the item can be returned.boolean
: Required. Whether the item is returnable.string
: Required. URL of the item return policy.object
string
: Required. The delivery by date, in ISO 8601 format.string
: Required. The ship by date, in ISO 8601 format.string
: Type of shipment. Indicates whether deliveryDetails
or pickupDetails
is applicable for this shipment. Acceptable values are: - "delivery
" - "pickup
"object
string
: The carrier for the shipping. Optional. See shipments[].carrier
for a list of acceptable values.integer
: Required. Maximum transit time.string
: Required. The name of the shipping method.integer
: Required. Minimum transit time.object
string
: Key for additional merchant provided (as key-value pairs) annotation about the line item.string
: Value for additional merchant provided (as key-value pairs) annotation about the line item.object
integer
: The card expiration month (January = 1, February = 2 etc.).integer
: The card expiration year (4-digit, e.g. 2015).string
: The last four digits of the card number.string
: The billing phone number.string
: The type of instrument. Acceptable values are: - "AMEX
" - "DISCOVER
" - "JCB
" - "MASTERCARD
" - "UNIONPAY
" - "VISA
" - "``"object
array
: Collectors authorized to pick up shipment from the pickup location.
string
: ID of the pickup location.object
string
: Name of the person picking up the shipment.string
: Phone number of the person picking up the shipment.object
string
: The actor that created the refund. Acceptable values are: - "customer
" - "googleBot
" - "googleCustomerService
" - "googlePayments
" - "googleSabre
" - "merchant
"string
: Date on which the item has been created, in ISO 8601 format.string
: 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
"string
: The explanation of the reason.object
: Order disbursement. All methods require the payment analyst role.
string
: The disbursement date, in ISO 8601 format.string
: The date the disbursement was initiated, in ISO 8601 format.string
: The ID of the disbursement.string
: The ID of the managing account.object
string
: The date the disbursement was created, in ISO 8601 format.string
: The date the disbursement was initiated, in ISO 8601 format.string
: The ID of the disbursement.string
: The ID of the managing account.string
: Merchant-provided ID of the order.string
: The ID of the order.string
: The date of the transaction, in ISO 8601 format.object
string
: The actor that created the refund. Acceptable values are: - "customer
" - "googleBot
" - "googleCustomerService
" - "googlePayments
" - "googleSabre
" - "merchant
"string
: Date on which the item has been created, in ISO 8601 format.integer
: Quantity that is returned.string
: The reason for the return. Acceptable values are: - "customerDiscretionaryReturn
" - "customerInitiatedMerchantCancel
" - "deliveredTooLate
" - "expiredItem
" - "invalidCoupon
" - "malformedShippingAddress
" - "other
" - "productArrivedDamaged
" - "productNotAsDescribed
" - "qualityNotAsExpected
" - "undeliverableShippingAddress
" - "unsupportedPoBoxAddress
" - "wrongProductShipped
"string
: The explanation of the reason.object
string
: 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)string
: Date on which the shipment has been created, in ISO 8601 format.string
: Date on which the shipment has been delivered, in ISO 8601 format. Present only if status
is delivered
string
: The ID of the shipment.array
: The line items that are shipped.
string
: The status of the shipment. Acceptable values are: - "delivered
" - "readyForPickup
" - "shipped
" - "undeliverable
"string
: The tracking ID for the shipment.object
string
: 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.string
: The ID of the product to ship. This is the REST ID used in the products service. Either lineItemId or productId is required.integer
: The quantity that is shipped.object
string
: 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").string
: The date a shipment is scheduled for delivery, in ISO 8601 format.object
string
: [required] The ID of the invoice.array
: [required] Invoice details per line item.
string
: [required] The ID of the operation, unique across all operations for a given order.string
: [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.object
string
: The status of the execution. Acceptable values are: - "duplicate
" - "executed
"string
: Identifies what kind of resource this is. Value: the fixed string "content#orderinvoicesCreateChargeInvoiceResponse".object
string
: [required] The ID of the invoice.string
: [required] The ID of the operation, unique across all operations for a given order.array
: Invoice details for different shipment groups.
object
string
: The status of the execution. Acceptable values are: - "duplicate
" - "executed
"string
: Identifies what kind of resource this is. Value: the fixed string "content#orderinvoicesCreateRefundInvoiceResponse".object
string
: Optional description of the refund reason.string
: [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
"object
string
: Optional description of the return reason.string
: [required] Reason for the return. Acceptable values are: - "customerDiscretionaryReturn
" - "customerInitiatedMerchantCancel
" - "deliveredTooLate
" - "expiredItem
" - "invalidCoupon
" - "malformedShippingAddress
" - "other
" - "productArrivedDamaged
" - "productNotAsDescribed
" - "qualityNotAsExpected
" - "undeliverableShippingAddress
" - "unsupportedPoBoxAddress
" - "wrongProductShipped
"object
array
: The list of disbursements.
string
: Identifies what kind of resource this is. Value: the fixed string "content#orderreportsListDisbursementsResponse".string
: The token for the retrieval of the next page of disbursements.object
string
: Identifies what kind of resource this is. Value: the fixed string "content#orderreportsListTransactionsResponse".string
: The token for the retrieval of the next page of transactions.array
: The list of transactions.
object
string
: Identifies what kind of resource this is. Value: the fixed string "content#orderreturnsListResponse".string
: The token for the retrieval of the next page of returns.array
object
string
: The ID of the operation. Unique across all operations for a given order.object
string
: The status of the execution. Acceptable values are: - "duplicate
" - "executed
"string
: Identifies what kind of resource this is. Value: the fixed string "content#ordersAcknowledgeResponse".object
string
: Identifies what kind of resource this is. Value: the fixed string "content#ordersAdvanceTestOrderResponse".object
string
: The ID of the line item to cancel. Either lineItemId or productId is required.string
: The ID of the operation. Unique across all operations for a given order.string
: The ID of the product to cancel. This is the REST ID used in the products service. Either lineItemId or productId is required.integer
: The quantity to cancel.string
: The reason for the cancellation. Acceptable values are: - "customerInitiatedCancel
" - "invalidCoupon
" - "malformedShippingAddress
" - "noInventory
" - "other
" - "priceError
" - "shippingPriceError
" - "taxError
" - "undeliverableShippingAddress
" - "unsupportedPoBoxAddress
"string
: The explanation of the reason.object
string
: The status of the execution. Acceptable values are: - "duplicate
" - "executed
"string
: Identifies what kind of resource this is. Value: the fixed string "content#ordersCancelLineItemResponse".object
string
: The ID of the operation. Unique across all operations for a given order.string
: The reason for the cancellation. Acceptable values are: - "customerInitiatedCancel
" - "invalidCoupon
" - "malformedShippingAddress
" - "noInventory
" - "other
" - "priceError
" - "shippingPriceError
" - "taxError
" - "undeliverableShippingAddress
" - "unsupportedPoBoxAddress
"string
: The explanation of the reason.object
string
: The status of the execution. Acceptable values are: - "duplicate
" - "executed
"string
: Identifies what kind of resource this is. Value: the fixed string "content#ordersCancelResponse".object
string
: The reason for the cancellation. Acceptable values are: - "changedMind
" - "orderedWrongItem
" - "other
"object
string
: Identifies what kind of resource this is. Value: the fixed string "content#ordersCancelTestOrderByCustomerResponse".object
string
: 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
.string
: 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
"object
string
: Identifies what kind of resource this is. Value: the fixed string "content#ordersCreateTestOrderResponse".string
: The ID of the newly created test order.object
array
: Returned items.
object
string
: Identifies what kind of resource this is. Value: the fixed string "content#ordersCreateTestReturnResponse".string
: The ID of the newly created test order return.object
array
: The request entries to be processed in the batch.
object
integer
: An entry ID, unique within the batch request.string
: The ID of the managing account.string
: The merchant order ID. Required for updateMerchantOrderId
and getByMerchantOrderId
methods.string
: The method of the batch entry. Acceptable values are: - "acknowledge
" - "cancel
" - "cancelLineItem
" - "get
" - "getByMerchantOrderId
" - "inStoreRefundLineItem
" - "refund
" - "rejectReturnLineItem
" - "returnLineItem
" - "returnRefundLineItem
" - "setLineItemMetadata
" - "shipLineItems
" - "updateLineItemShippingDetails
" - "updateMerchantOrderId
" - "updateShipment
"string
: The ID of the operation. Unique across all operations for a given order. Required for all methods beside get
and getByMerchantOrderId
.string
: The ID of the order. Required for all methods beside getByMerchantOrderId
.object
string
: The reason for the cancellation. Acceptable values are: - "customerInitiatedCancel
" - "invalidCoupon
" - "malformedShippingAddress
" - "noInventory
" - "other
" - "priceError
" - "shippingPriceError
" - "taxError
" - "undeliverableShippingAddress
" - "unsupportedPoBoxAddress
"string
: The explanation of the reason.object
string
: The ID of the line item to cancel. Either lineItemId or productId is required.string
: The ID of the product to cancel. This is the REST ID used in the products service. Either lineItemId or productId is required.integer
: The quantity to cancel.string
: The reason for the cancellation. Acceptable values are: - "customerInitiatedCancel
" - "invalidCoupon
" - "malformedShippingAddress
" - "noInventory
" - "other
" - "priceError
" - "shippingPriceError
" - "taxError
" - "undeliverableShippingAddress
" - "unsupportedPoBoxAddress
"string
: The explanation of the reason.object
string
: The ID of the line item to return.integer
: Quantity that is returned.object
string
: The ID of the line item to return. Either lineItemId or productId is required.string
: The ID of the product to return. This is the REST ID used in the products service. Either lineItemId or productId is required.integer
: The quantity to return and refund.string
: The reason for the return. Acceptable values are: - "customerDiscretionaryReturn
" - "customerInitiatedMerchantCancel
" - "deliveredTooLate
" - "expiredItem
" - "invalidCoupon
" - "malformedShippingAddress
" - "other
" - "productArrivedDamaged
" - "productNotAsDescribed
" - "qualityNotAsExpected
" - "undeliverableShippingAddress
" - "unsupportedPoBoxAddress
" - "wrongProductShipped
"string
: The explanation of the reason.object
string
: The reason for the refund. Acceptable values are: - "adjustment
" - "courtesyAdjustment
" - "customerCanceled
" - "customerDiscretionaryReturn
" - "deliveredLateByCarrier
" - "feeAdjustment
" - "lateShipmentCredit
" - "noInventory
" - "other
" - "priceError
" - "productArrivedDamaged
" - "productNotAsDescribed
" - "shippingCostAdjustment
" - "taxAdjustment
" - "undeliverableShippingAddress
" - "wrongProductShipped
"string
: The explanation of the reason.object
string
: The ID of the line item to return. Either lineItemId or productId is required.string
: The ID of the product to return. This is the REST ID used in the products service. Either lineItemId or productId is required.integer
: The quantity to return and refund.string
: The reason for the return. Acceptable values are: - "damagedOrUsed
" - "missingComponent
" - "notEligible
" - "other
" - "outOfReturnWindow
"string
: The explanation of the reason.object
string
: The ID of the line item to return. Either lineItemId or productId is required.string
: The ID of the product to return. This is the REST ID used in the products service. Either lineItemId or productId is required.integer
: The quantity to return.string
: The reason for the return. Acceptable values are: - "customerDiscretionaryReturn
" - "customerInitiatedMerchantCancel
" - "deliveredTooLate
" - "expiredItem
" - "invalidCoupon
" - "malformedShippingAddress
" - "other
" - "productArrivedDamaged
" - "productNotAsDescribed
" - "qualityNotAsExpected
" - "undeliverableShippingAddress
" - "unsupportedPoBoxAddress
" - "wrongProductShipped
"string
: The explanation of the reason.object
string
: The ID of the line item to return. Either lineItemId or productId is required.string
: The ID of the product to return. This is the REST ID used in the products service. Either lineItemId or productId is required.integer
: The quantity to return and refund.string
: The reason for the return. Acceptable values are: - "customerDiscretionaryReturn
" - "customerInitiatedMerchantCancel
" - "deliveredTooLate
" - "expiredItem
" - "invalidCoupon
" - "malformedShippingAddress
" - "other
" - "productArrivedDamaged
" - "productNotAsDescribed
" - "qualityNotAsExpected
" - "undeliverableShippingAddress
" - "unsupportedPoBoxAddress
" - "wrongProductShipped
"string
: The explanation of the reason.object
array
string
: The ID of the line item to set metadata. Either lineItemId or productId is required.string
: The ID of the product to set metadata. This is the REST ID used in the products service. Either lineItemId or productId is required.object
string
: Deprecated. Please use shipmentInfo instead. The carrier handling the shipment. See shipments[].carrier
in the Orders resource representation for a list of acceptable values.array
: Line items to ship.
string
: ID of the shipment group. Required for orders that use the orderinvoices service.string
: Deprecated. Please use shipmentInfo instead. The ID of the shipment.array
: Shipment information. This field is repeated because a single line item can be shipped in several packages (and have several tracking IDs).
string
: Deprecated. Please use shipmentInfo instead. The tracking ID for the shipment.object
string
: The carrier handling the shipment. See shipments[].carrier
in the Orders resource representation for a list of acceptable values.string
: Required. The ID of the shipment. This is assigned by the merchant and is unique to each shipment.string
: The tracking ID for the shipment.object
string
: 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.string
: The ID of the line item to set metadata. Either lineItemId or productId is required.string
: The ID of the product to set metadata. This is the REST ID used in the products service. Either lineItemId or productId is required.string
: 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.object
string
: The carrier handling the shipment. Not updated if missing. See shipments[].carrier
in the Orders resource representation for a list of acceptable values.string
: Date on which the shipment has been delivered, in ISO 8601 format. Optional and can be provided only if status
is delivered
.string
: The ID of the shipment.string
: New status for the shipment. Not updated if missing. Acceptable values are: - "delivered
" - "undeliverable
" - "readyForPickup
"string
: The tracking ID for the shipment. Not updated if missing.object
array
: The result of the execution of the batch requests.
string
: Identifies what kind of resource this is. Value: the fixed string "content#ordersCustomBatchResponse".object
integer
: The ID of the request entry this entry responds to.string
: 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
"string
: Identifies what kind of resource this is. Value: the fixed string "content#ordersCustomBatchResponseEntry
"object
string
: Identifies what kind of resource this is. Value: the fixed string "content#ordersGetByMerchantOrderIdResponse".object
string
: Identifies what kind of resource this is. Value: the fixed string "content#ordersGetTestOrderTemplateResponse".object
string
: The ID of the line item to return. Either lineItemId or productId is required.string
: The ID of the operation. Unique across all operations for a given order.string
: The ID of the product to return. This is the REST ID used in the products service. Either lineItemId or productId is required.integer
: The quantity to return and refund.string
: The reason for the return. Acceptable values are: - "customerDiscretionaryReturn
" - "customerInitiatedMerchantCancel
" - "deliveredTooLate
" - "expiredItem
" - "invalidCoupon
" - "malformedShippingAddress
" - "other
" - "productArrivedDamaged
" - "productNotAsDescribed
" - "qualityNotAsExpected
" - "undeliverableShippingAddress
" - "unsupportedPoBoxAddress
" - "wrongProductShipped
"string
: The explanation of the reason.object
string
: The status of the execution. Acceptable values are: - "duplicate
" - "executed
"string
: Identifies what kind of resource this is. Value: the fixed string "content#ordersInStoreRefundLineItemResponse".object
string
: Identifies what kind of resource this is. Value: the fixed string "content#ordersListResponse".string
: The token for the retrieval of the next page of orders.array
object
string
: The ID of the operation. Unique across all operations for a given order.string
: The reason for the refund. Acceptable values are: - "adjustment
" - "courtesyAdjustment
" - "customerCanceled
" - "customerDiscretionaryReturn
" - "deliveredLateByCarrier
" - "feeAdjustment
" - "lateShipmentCredit
" - "noInventory
" - "other
" - "priceError
" - "productArrivedDamaged
" - "productNotAsDescribed
" - "shippingCostAdjustment
" - "taxAdjustment
" - "undeliverableShippingAddress
" - "wrongProductShipped
"string
: The explanation of the reason.object
string
: The status of the execution. Acceptable values are: - "duplicate
" - "executed
"string
: Identifies what kind of resource this is. Value: the fixed string "content#ordersRefundResponse".object
string
: The ID of the line item to return. Either lineItemId or productId is required.string
: The ID of the operation. Unique across all operations for a given order.string
: The ID of the product to return. This is the REST ID used in the products service. Either lineItemId or productId is required.integer
: The quantity to return and refund.string
: The reason for the return. Acceptable values are: - "damagedOrUsed
" - "missingComponent
" - "notEligible
" - "other
" - "outOfReturnWindow
"string
: The explanation of the reason.object
string
: The status of the execution. Acceptable values are: - "duplicate
" - "executed
"string
: Identifies what kind of resource this is. Value: the fixed string "content#ordersRejectReturnLineItemResponse".object
string
: The ID of the line item to return. Either lineItemId or productId is required.string
: The ID of the operation. Unique across all operations for a given order.string
: The ID of the product to return. This is the REST ID used in the products service. Either lineItemId or productId is required.integer
: The quantity to return.string
: The reason for the return. Acceptable values are: - "customerDiscretionaryReturn
" - "customerInitiatedMerchantCancel
" - "deliveredTooLate
" - "expiredItem
" - "invalidCoupon
" - "malformedShippingAddress
" - "other
" - "productArrivedDamaged
" - "productNotAsDescribed
" - "qualityNotAsExpected
" - "undeliverableShippingAddress
" - "unsupportedPoBoxAddress
" - "wrongProductShipped
"string
: The explanation of the reason.object
string
: The status of the execution. Acceptable values are: - "duplicate
" - "executed
"string
: Identifies what kind of resource this is. Value: the fixed string "content#ordersReturnLineItemResponse".object
string
: The ID of the line item to return. Either lineItemId or productId is required.string
: The ID of the operation. Unique across all operations for a given order.string
: The ID of the product to return. This is the REST ID used in the products service. Either lineItemId or productId is required.integer
: The quantity to return and refund.string
: The reason for the return. Acceptable values are: - "customerDiscretionaryReturn
" - "customerInitiatedMerchantCancel
" - "deliveredTooLate
" - "expiredItem
" - "invalidCoupon
" - "malformedShippingAddress
" - "other
" - "productArrivedDamaged
" - "productNotAsDescribed
" - "qualityNotAsExpected
" - "undeliverableShippingAddress
" - "unsupportedPoBoxAddress
" - "wrongProductShipped
"string
: The explanation of the reason.object
string
: The status of the execution. Acceptable values are: - "duplicate
" - "executed
"string
: Identifies what kind of resource this is. Value: the fixed string "content#ordersReturnRefundLineItemResponse".object
array
string
: The ID of the line item to set metadata. Either lineItemId or productId is required.string
: The ID of the operation. Unique across all operations for a given order.string
: The ID of the product to set metadata. This is the REST ID used in the products service. Either lineItemId or productId is required.object
string
: The status of the execution. Acceptable values are: - "duplicate
" - "executed
"string
: Identifies what kind of resource this is. Value: the fixed string "content#ordersSetLineItemMetadataResponse".object
string
: Deprecated. Please use shipmentInfo instead. The carrier handling the shipment. See shipments[].carrier
in the Orders resource representation for a list of acceptable values.array
: Line items to ship.
string
: The ID of the operation. Unique across all operations for a given order.string
: ID of the shipment group. Required for orders that use the orderinvoices service.string
: Deprecated. Please use shipmentInfo instead. The ID of the shipment.array
: Shipment information. This field is repeated because a single line item can be shipped in several packages (and have several tracking IDs).
string
: Deprecated. Please use shipmentInfo instead. The tracking ID for the shipment.object
string
: The status of the execution. Acceptable values are: - "duplicate
" - "executed
"string
: Identifies what kind of resource this is. Value: the fixed string "content#ordersShipLineItemsResponse".object
string
: 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.string
: The ID of the line item to set metadata. Either lineItemId or productId is required.string
: The ID of the operation. Unique across all operations for a given order.string
: The ID of the product to set metadata. This is the REST ID used in the products service. Either lineItemId or productId is required.string
: 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.object
string
: The status of the execution. Acceptable values are: - "duplicate
" - "executed
"string
: Identifies what kind of resource this is. Value: the fixed string "content#ordersUpdateLineItemShippingDetailsResponse".object
string
: The merchant order id to be assigned to the order. Must be unique per merchant.string
: The ID of the operation. Unique across all operations for a given order.object
string
: The status of the execution. Acceptable values are: - "duplicate
" - "executed
"string
: Identifies what kind of resource this is. Value: the fixed string "content#ordersUpdateMerchantOrderIdResponse".object
string
: The carrier handling the shipment. Not updated if missing. See shipments[].carrier
in the Orders resource representation for a list of acceptable values.string
: Date on which the shipment has been delivered, in ISO 8601 format. Optional and can be provided only if status
is delivered
.string
: The ID of the operation. Unique across all operations for a given order.string
: The ID of the shipment.string
: New status for the shipment. Not updated if missing. Acceptable values are: - "delivered
" - "undeliverable
" - "readyForPickup
"string
: The tracking ID for the shipment. Not updated if missing.object
string
: The status of the execution. Acceptable values are: - "duplicate
" - "executed
"string
: Identifies what kind of resource this is. Value: the fixed string "content#ordersUpdateShipmentResponse".object
string
: The name of the pickup carrier (e.g., "UPS"
). Required.string
: The name of the pickup service (e.g., "Access point"
). Required.object
string
: The name of the carrier (e.g., "UPS"
). Always present.string
: The CLDR country code of the carrier (e.g., "US"). Always present.string
: The name of the pickup service (e.g., "Access point"
). Always present.object
array
: The request entries to be processed in the batch.
object
integer
: An entry ID, unique within the batch request.string
: The ID of the POS data provider.string
: The method of the batch entry. Acceptable values are: - "delete
" - "get
" - "insert
" - "inventory
" - "sale
"string
: The store code. This should be set only if the method is delete
or get
.string
: The ID of the account for which to get/submit data.object
array
: The result of the execution of the batch requests.
string
: Identifies what kind of resource this is. Value: the fixed string "content#posCustomBatchResponse".object
integer
: The ID of the request entry to which this entry responds.string
: Identifies what kind of resource this is. Value: the fixed string "content#posCustomBatchResponseEntry
"object
string
: Country code.array
: A list of POS data providers.
object
string
: The display name of Pos data Provider.string
: The full name of this POS data Provider.string
: The ID of the account.object
: The absolute quantity of an item available at the given store.
string
: Required. The two-letter ISO 639-1 language code for the item.string
: Global Trade Item Number.string
: Required. A unique identifier for the item.string
: Identifies what kind of resource this is. Value: the fixed string "content#posInventory
"string
: Required. The available quantity of the item.string
: 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.string
: Required. The CLDR territory code for the item.string
: Required. The inventory timestamp, in ISO 8601 format.object
string
: Required. The two-letter ISO 639-1 language code for the item.string
: Global Trade Item Number.string
: Required. A unique identifier for the item.string
: Required. The available quantity of the item.string
: 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.string
: Required. The CLDR territory code for the item.string
: Required. The inventory timestamp, in ISO 8601 format.object
string
: Required. The two-letter ISO 639-1 language code for the item.string
: Global Trade Item Number.string
: Required. A unique identifier for the item.string
: Identifies what kind of resource this is. Value: the fixed string "content#posInventoryResponse".string
: Required. The available quantity of the item.string
: 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.string
: Required. The CLDR territory code for the item.string
: Required. The inventory timestamp, in ISO 8601 format.object
string
: Identifies what kind of resource this is. Value: the fixed string "content#posListResponse".array
object
: The change of the available quantity of an item at the given store.
string
: Required. The two-letter ISO 639-1 language code for the item.string
: Global Trade Item Number.string
: Required. A unique identifier for the item.string
: Identifies what kind of resource this is. Value: the fixed string "content#posSale
"string
: Required. The relative change of the available quantity. Negative for items returned.string
: A unique ID to group items from the same sale event.string
: 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.string
: Required. The CLDR territory code for the item.string
: Required. The inventory timestamp, in ISO 8601 format.object
string
: Required. The two-letter ISO 639-1 language code for the item.string
: Global Trade Item Number.string
: Required. A unique identifier for the item.string
: Required. The relative change of the available quantity. Negative for items returned.string
: A unique ID to group items from the same sale event.string
: 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.string
: Required. The CLDR territory code for the item.string
: Required. The inventory timestamp, in ISO 8601 format.object
string
: Required. The two-letter ISO 639-1 language code for the item.string
: Global Trade Item Number.string
: Required. A unique identifier for the item.string
: Identifies what kind of resource this is. Value: the fixed string "content#posSaleResponse".string
: Required. The relative change of the available quantity. Negative for items returned.string
: A unique ID to group items from the same sale event.string
: 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.string
: Required. The CLDR territory code for the item.string
: Required. The inventory timestamp, in ISO 8601 format.object
: Store resource.
string
: Identifies what kind of resource this is. Value: the fixed string "content#posStore
"string
: Required. The street address of the store.string
: Required. A store identifier that is unique for the given merchant.object
string
: The CLDR territory code of the country the postal code group applies to. Required.string
: The name of the postal code group, referred to in headers. Required.array
: A range of postal codes. Required.
object
string
: 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.string
: 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
.object
string
: The currency of the price.string
: The price represented as a number.object
: 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.
array
: Additional URLs of images of the item.
string
array
: Additional categories of the item (formatted as in products data specification).
string
boolean
: Should be set to true if the item is targeted towards adults.string
: Used to group items in an arbitrary way. Only for CPA%, discouraged otherwise.array
: Similar to adwords_grouping, but only works on CPC.
string
string
: Allows advertisers to override the item URL when the product is shown within the context of Product Ads.string
: Target age group of the item. Acceptable values are: - "adult
" - "infant
" - "kids
" - "newborn
" - "toddler
" - "youngAdult
"array
: Deprecated. Do not use.
string
: Availability status of the item. Acceptable values are: - "in stock
" - "out of stock
" - "preorder
"string
: The day a pre-ordered product becomes available for delivery, in ISO 8601 format.string
: Brand of the item.string
: URL for the canonical version of your item's landing page.string
: Required. The item's channel (online or local). Acceptable values are: - "local
" - "online
"string
: Color of the item.string
: Condition or state of the item. Acceptable values are: - "local
" - "online
"string
: Required. The two-letter ISO 639-1 language code for the item.array
: 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).
array
: A list of custom (merchant-provided) custom attribute groups.
string
: Custom label 0 for custom grouping of items in a Shopping campaign.string
: Custom label 1 for custom grouping of items in a Shopping campaign.string
: Custom label 2 for custom grouping of items in a Shopping campaign.string
: Custom label 3 for custom grouping of items in a Shopping campaign.string
: Custom label 4 for custom grouping of items in a Shopping campaign.string
: Description of the item.array
: Specifies the intended destinations for the product.
string
: An identifier for an item for dynamic remarketing campaigns.string
: URL directly to your item's landing page for dynamic remarketing campaigns.array
: Advertiser-specified recommendations.
string
string
: Title of an item for dynamic remarketing campaigns.number
: Offer margin for dynamic remarketing campaigns.string
: 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
"string
: 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.string
: Target gender of the item. Acceptable values are: - "female
" - "male
" - "unisex
"string
: Google's category of the item (see Google product taxonomy).string
: Global Trade Item Number (GTIN) of the item.string
: 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.boolean
: 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.string
: URL of an image of the item.boolean
: 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.string
: Shared identifier for all variants of the same product.string
: Identifies what kind of resource this is. Value: the fixed string "content#product
"string
: URL directly linking to your item's page on your website.string
: The material of which the item is made.string
: 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
"string
: Maximal product handling time (in business days).string
: 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
"string
: Minimal product handling time (in business days).string
: URL for the mobile-optimized version of your item's landing page.string
: Manufacturer Part Number (MPN) of the item.string
: The number of identical products in a merchant-defined multipack.string
: 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.boolean
: Deprecated.string
: The item's pattern (e.g. polka dots).string
: Your category of the item (formatted as in products data specification).array
: The unique ID of a promotion.
string
string
: Date range during which the item is on sale (see products data specification ).string
: The quantity of the product that is available for selling on Google. Supported only for online products.array
: Shipping rules.
string
: The shipping label of the product, used to group product in account-level shipping rules.string
: 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
"string
: The cut of the item. Recommended for apparel items. Acceptable values are: - "big and tall
" - "maternity
" - "oversize
" - "petite
" - "plus
" - "regular
"array
: 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).
string
string
: The source of the offer, i.e., how the offer was created. Acceptable values are: - "api
" - "crawl
" - "feed
"string
: Required. The CLDR territory code for the item.array
: Tax information.
string
: Title of the item.array
: Deprecated. The read-only list of intended destinations which passed validation.
string
array
: Read-only warnings.
object
string
: Deprecated.string
: Deprecated.string
: Deprecated.object
string
: The name of the destination.string
: Whether the destination is required, excluded or should be validated. Acceptable values are: - "default
" - "excluded
" - "optional
" - "required
"object
string
: The CLDR territory code of the country to which an item will ship.string
: The location where the shipping is applicable, represented by a location group name.string
: The numeric ID of a location that the shipping rate applies to as defined in the AdWords API.string
: 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.string
: The geographic region to which a shipping rate applies.string
: A free-form description of the service class or delivery speed.object
string
: The unit of value.number
: The dimension of the product used to calculate the shipping cost of the item.object
string
: The unit of value.number
: The weight of the product used to calculate the shipping cost of the item.object
: The status of a product, i.e., information about a product computed asynchronously.
string
: Date on which the item has been created, in ISO 8601 format.array
: DEPRECATED - never populated
array
: The intended destinations for the product.
string
: Date on which the item expires in Google Shopping, in ISO 8601 format.array
: A list of all issues associated with the product.
string
: Identifies what kind of resource this is. Value: the fixed string "content#productStatus
"string
: Date on which the item has been last updated, in ISO 8601 format.string
: The link to the product.string
: The ID of the product for which status is reported.string
: The title of the product.object
string
string
string
string
string
string
string
string
string
object
boolean
: Whether the approval status might change due to further processing.string
: The destination's approval status. Acceptable values are: - "approved
" - "disapproved
"string
: The name of the destinationstring
: Provided for backward compatibility only. Always set to "required". Acceptable values are: - "default
" - "excluded
" - "optional
" - "required
"object
string
: The attribute's name, if the issue is caused by a single attribute.string
: The error code of the issue.string
: A short issue description in English.string
: The destination the issue applies to.string
: A detailed issue description in English.string
: The URL of a web page to help with resolving this issue.string
: Whether the issue can be resolved by the merchant.string
: How this issue affects serving of the offer.object
string
: The country within which the item is taxed, specified as a CLDR territory code.string
: The numeric ID of a location that the tax rate applies to as defined in the AdWords API.string
: 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*.number
: The percentage of tax rate that applies to the item price.string
: The geographic region to which the tax rate applies.boolean
: Should be set to true if tax is charged on shipping.object
string
: The unit of the denominator.string
: The denominator of the unit price.object
string
: The unit of the measure.number
: The measure of an item.object
array
: The request entries to be processed in the batch.
object
: A batch entry encoding a single non-batch products request.
integer
: An entry ID, unique within the batch request.string
: The ID of the managing account.string
: The method of the batch entry. Acceptable values are: - "delete
" - "get
" - "insert
"string
: The ID of the product to get or delete. Only defined if the method is get
or delete
.object
array
: The result of the execution of the batch requests.
string
: Identifies what kind of resource this is. Value: the fixed string "content#productsCustomBatchResponse".object
: A batch entry encoding a single non-batch products response.
object
string
: Identifies what kind of resource this is. Value: the fixed string "content#productsListResponse".string
: The token for the retrieval of the next page of products.array
object
array
: The request entries to be processed in the batch.
object
: A batch entry encoding a single non-batch productstatuses request.
integer
: An entry ID, unique within the batch request.array
: If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination.
string
boolean
string
: The ID of the managing account.string
: The method of the batch entry. Acceptable values are: - "get
"string
: The ID of the product whose status to get.object
array
: The result of the execution of the batch requests.
string
: Identifies what kind of resource this is. Value: the fixed string "content#productstatusesCustomBatchResponse".object
: A batch entry encoding a single non-batch productstatuses response.
integer
: The ID of the request entry this entry responds to.string
: Identifies what kind of resource this is. Value: the fixed string "content#productstatusesCustomBatchResponseEntry
"object
string
: Identifies what kind of resource this is. Value: the fixed string "content#productstatusesListResponse".string
: The token for the retrieval of the next page of products statuses.array
object
string
: [required] ID of the promotion.object
array
: 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.
string
array
: A list of carrier rates that can be referred to by mainTable
or singleValue
.
string
: Name of the rate group. Optional. If set has to be unique within shipping service.array
: A list of subtables referred to by mainTable
. Can only be set if mainTable
is set.
object
string
: Description of the reason.string
: 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
"object
string
: The date of creation of the shipment, in ISO 8601 format.string
: The date of delivery of the shipment, in ISO 8601 format.string
: Type of the return method. Acceptable values are: - "byMail
" - "contactCustomerSupport
" - "returnless
"string
: Shipment ID generated by Google.array
: Tracking information of the shipment. One return shipment might be handled by several shipping carriers sequentially.
string
: The date of shipping of the shipment, in ISO 8601 format.string
: State of the shipment. Acceptable values are: - "completed
" - "new
" - "shipped
" - "undeliverable
" - "pending
"object
array
: 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.
object
boolean
: A boolean exposing the active status of the shipping service. Required.string
: The CLDR code of the currency to which this service applies. Must match that of the prices in rate groups.string
: The CLDR territory code of the country to which the service applies. Required.string
: Eligibility for this service. Acceptable values are: - "All scenarios
" - "All scenarios except Shopping Actions
" - "Shopping Actions
"string
: Free-form name of the service. Must be unique within target account. Required.array
: 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.
string
: Type of locations this service ships orders to. Acceptable values are: - "delivery
" - "pickup
"object
array
: [required] Invoice details per line item.
string
: [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.object
string
: ID of the line item. Either lineItemId or productId must be set.string
: ID of the product. This is the REST ID used in the products service. Either lineItemId or productId must be set.array
: [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).
string
object
string
: 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
"string
: The tracking number for the package.object
: The merchant account's shipping settings. All methods except getsupportedcarriers and getsupportedholidays require the admin role.
string
: The ID of the account to which these account shipping settings belong. Ignored upon update, always present in get request responses.array
: A list of postal code groups that can be referred to in services
. Optional.
array
: The target account's list of services. Optional.
object
array
: The request entries to be processed in the batch.
object
: A batch entry encoding a single non-batch shippingsettings request.
string
: The ID of the account for which to get/update account shipping settings.integer
: An entry ID, unique within the batch request.string
: The ID of the managing account.string
: The method of the batch entry. Acceptable values are: - "get
" - "update
"object
array
: The result of the execution of the batch requests.
string
: Identifies what kind of resource this is. Value: the fixed string "content#shippingsettingsCustomBatchResponse".object
: A batch entry encoding a single non-batch shipping settings response.
integer
: The ID of the request entry to which this entry responds.string
: Identifies what kind of resource this is. Value: the fixed string "content#shippingsettingsCustomBatchResponseEntry
"object
array
: A list of supported carriers. May be empty.
string
: Identifies what kind of resource this is. Value: the fixed string "content#shippingsettingsGetSupportedCarriersResponse".object
array
: A list of holidays applicable for delivery guarantees. May be empty.
string
: Identifies what kind of resource this is. Value: the fixed string "content#shippingsettingsGetSupportedHolidaysResponse".object
string
: Identifies what kind of resource this is. Value: the fixed string "content#shippingsettingsGetSupportedPickupServicesResponse".array
: A list of supported pickup services. May be empty.
object
string
: Identifies what kind of resource this is. Value: the fixed string "content#shippingsettingsListResponse".string
: The token for the retrieval of the next page of shipping settings.array
object
object
boolean
: Whether the orderinvoices service should support this order.string
: Identifies what kind of resource this is. Value: the fixed string "content#testOrder
"array
: Required. Line items that are ordered. At least one line item must be provided.
string
: Restricted. Do not use.string
: Required. Identifier of one of the predefined delivery addresses for the delivery. Acceptable values are: - "dwight
" - "jim
" - "pam
"string
: Identifier of one of the predefined pickup details. Required for orders containing line items with shipping type pickup
. Acceptable values are: - "dwight
" - "jim
" - "pam
"array
: Deprecated. Ignored if provided.
string
: Required. The requested shipping option. Acceptable values are: - "economy
" - "expedited
" - "oneDay
" - "sameDay
" - "standard
" - "twoDay
"object
string
: Required. Email address of the customer. Acceptable values are: - "pog.dwight.schrute@gmail.com
" - "pog.jim.halpert@gmail.com
" - "penpog.pam.beesly@gmail.comding
"boolean
: Deprecated. Please use marketingRightsInfo instead.string
: Full name of the customer.object
string
: 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
"string
: Timestamp when last time marketing preference was updated. Could be empty, if user wasn't offered a selection yet.object
integer
: Required. Number of items ordered.object
string
: Required. Brand of the item.string
: Deprecated. Acceptable values are: - "online
"string
: Required. Condition or state of the item. Acceptable values are: - "new
"string
: Required. The two-letter ISO 639-1 language code for the item. Acceptable values are: - "en
" - "fr
"array
: Fees for the item. Optional.
string
: Global Trade Item Number (GTIN) of the item. Optional.string
: Required. URL of an image of the item.string
: Shared identifier for all variants of the same product. Optional.string
: Manufacturer Part Number (MPN) of the item. Optional.string
: Required. An identifier of the item.string
: Required. The CLDR territory // code of the target country of the product.string
: Required. The title of the product.array
: Variant attributes for the item. Optional.
object
integer
: The card expiration month (January = 1, February = 2 etc.).integer
: The card expiration year (4-digit, e.g. 2015).string
: The last four digits of the card number.string
: The billing address. Acceptable values are: - "dwight
" - "jim
" - "pam
"string
: 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
"object
array
: 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.
string
array
array
: A list of transit time labels. The last value can be "all other labels"
. Example: ["food", "electronics", "all other labels"]
.
string
object
array
object
integer
: Must be greater than or equal to minTransitTimeInDays
.integer
: Transit time range (min-max) in business days. 0 means same day delivery, 1 means next day delivery.object
array
: Additional charges for a unit, e.g. shipping costs.
array
: Deprecated.
array
: Tax amounts to apply to the unit price.
object
object
string
: Optional name of the tax type. This should only be provided if taxType
is otherFeeTax
.string
: [required] Type of the tax. Acceptable values are: - "otherFee
" - "otherFeeTax
" - "sales
"object
: 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.
string
: 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.boolean
: If true, then the product can't ship. Must be true when set, can only be set if all other fields are not set.string
: 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.string
: 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.object
string
: Required. The weight unit. Acceptable values are: - "kg
" - "lb
"string
: Required. The weight represented as a number.FAQs
DataFire integration for Content API for Shopping
The npm package @datafire/google_shoppingcontent receives a total of 0 weekly downloads. As such, @datafire/google_shoppingcontent popularity was classified as not popular.
We found that @datafire/google_shoppingcontent demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
CISA has proposed a set of new rules that would require critical infrastructure to report cyber incidents and ransom payments.
Security News
Redis is no longer OSS, breaking its explicit commitment to remain under the BSD 3-Clause License forever. This has angered contributors who are now working to fork the software.
Product
Socket AI now enables 'AI detected potential malware' alerts by default, ensuring users benefit from AI-powered state-of-the-art malware detection without needing to opt-in.