is.google-api-services-content.v2.1-rev20210325-1.31.0.source-code.content.v2.1.json Maven / Gradle / Ivy
{
"name": "content",
"canonicalName": "Shopping Content",
"icons": {
"x32": "http://www.google.com/images/icons/product/search-32.gif",
"x16": "http://www.google.com/images/icons/product/search-16.gif"
},
"resources": {
"returnpolicy": {
"methods": {
"custombatch": {
"parameterOrder": [],
"response": {
"$ref": "ReturnpolicyCustomBatchResponse"
},
"flatPath": "returnpolicy/batch",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"path": "returnpolicy/batch",
"id": "content.returnpolicy.custombatch",
"request": {
"$ref": "ReturnpolicyCustomBatchRequest"
},
"parameters": {},
"description": "Batches multiple return policy related calls in a single request.",
"httpMethod": "POST"
},
"get": {
"parameterOrder": [
"merchantId",
"returnPolicyId"
],
"scopes": [
"https://www.googleapis.com/auth/content"
],
"httpMethod": "GET",
"flatPath": "{merchantId}/returnpolicy/{returnPolicyId}",
"parameters": {
"merchantId": {
"type": "string",
"required": true,
"format": "uint64",
"description": "The Merchant Center account to get a return policy for.",
"location": "path"
},
"returnPolicyId": {
"location": "path",
"description": "Return policy ID generated by Google.",
"required": true,
"type": "string"
}
},
"description": "Gets a return policy of the Merchant Center account.",
"id": "content.returnpolicy.get",
"response": {
"$ref": "ReturnPolicy"
},
"path": "{merchantId}/returnpolicy/{returnPolicyId}"
},
"delete": {
"scopes": [
"https://www.googleapis.com/auth/content"
],
"path": "{merchantId}/returnpolicy/{returnPolicyId}",
"description": "Deletes a return policy for the given Merchant Center account.",
"id": "content.returnpolicy.delete",
"flatPath": "{merchantId}/returnpolicy/{returnPolicyId}",
"httpMethod": "DELETE",
"parameters": {
"returnPolicyId": {
"required": true,
"description": "Return policy ID generated by Google.",
"type": "string",
"location": "path"
},
"merchantId": {
"location": "path",
"description": "The Merchant Center account from which to delete the given return policy.",
"format": "uint64",
"type": "string",
"required": true
}
},
"parameterOrder": [
"merchantId",
"returnPolicyId"
]
},
"insert": {
"parameters": {
"merchantId": {
"format": "uint64",
"required": true,
"type": "string",
"location": "path",
"description": "The Merchant Center account to insert a return policy for."
}
},
"scopes": [
"https://www.googleapis.com/auth/content"
],
"flatPath": "{merchantId}/returnpolicy",
"request": {
"$ref": "ReturnPolicy"
},
"response": {
"$ref": "ReturnPolicy"
},
"path": "{merchantId}/returnpolicy",
"description": "Inserts a return policy for the Merchant Center account.",
"parameterOrder": [
"merchantId"
],
"httpMethod": "POST",
"id": "content.returnpolicy.insert"
},
"list": {
"parameters": {
"merchantId": {
"type": "string",
"description": "The Merchant Center account to list return policies for.",
"required": true,
"format": "uint64",
"location": "path"
}
},
"path": "{merchantId}/returnpolicy",
"description": "Lists the return policies of the Merchant Center account.",
"parameterOrder": [
"merchantId"
],
"httpMethod": "GET",
"id": "content.returnpolicy.list",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"response": {
"$ref": "ReturnpolicyListResponse"
},
"flatPath": "{merchantId}/returnpolicy"
}
}
},
"datafeeds": {
"methods": {
"list": {
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"parameterOrder": [
"merchantId"
],
"path": "{merchantId}/datafeeds",
"flatPath": "{merchantId}/datafeeds",
"id": "content.datafeeds.list",
"description": "Lists the configurations for datafeeds in your Merchant Center account.",
"parameters": {
"pageToken": {
"location": "query",
"type": "string",
"description": "The token returned by the previous request."
},
"maxResults": {
"format": "uint32",
"description": "The maximum number of products to return in the response, used for paging.",
"location": "query",
"type": "integer"
},
"merchantId": {
"type": "string",
"location": "path",
"required": true,
"format": "uint64",
"description": "The ID of the account that manages the datafeeds. This account cannot be a multi-client account."
}
},
"response": {
"$ref": "DatafeedsListResponse"
}
},
"custombatch": {
"parameterOrder": [],
"request": {
"$ref": "DatafeedsCustomBatchRequest"
},
"parameters": {},
"path": "datafeeds/batch",
"response": {
"$ref": "DatafeedsCustomBatchResponse"
},
"flatPath": "datafeeds/batch",
"httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"description": "Deletes, fetches, gets, inserts and updates multiple datafeeds in a single request.",
"id": "content.datafeeds.custombatch"
},
"insert": {
"response": {
"$ref": "Datafeed"
},
"scopes": [
"https://www.googleapis.com/auth/content"
],
"path": "{merchantId}/datafeeds",
"parameterOrder": [
"merchantId"
],
"request": {
"$ref": "Datafeed"
},
"description": "Registers a datafeed configuration with your Merchant Center account.",
"id": "content.datafeeds.insert",
"flatPath": "{merchantId}/datafeeds",
"httpMethod": "POST",
"parameters": {
"merchantId": {
"format": "uint64",
"type": "string",
"location": "path",
"description": "The ID of the account that manages the datafeed. This account cannot be a multi-client account.",
"required": true
}
}
},
"get": {
"path": "{merchantId}/datafeeds/{datafeedId}",
"response": {
"$ref": "Datafeed"
},
"parameters": {
"datafeedId": {
"type": "string",
"format": "uint64",
"description": "The ID of the datafeed.",
"required": true,
"location": "path"
},
"merchantId": {
"type": "string",
"format": "uint64",
"location": "path",
"description": "The ID of the account that manages the datafeed. This account cannot be a multi-client account.",
"required": true
}
},
"description": "Retrieves a datafeed configuration from your Merchant Center account.",
"httpMethod": "GET",
"id": "content.datafeeds.get",
"parameterOrder": [
"merchantId",
"datafeedId"
],
"scopes": [
"https://www.googleapis.com/auth/content"
],
"flatPath": "{merchantId}/datafeeds/{datafeedId}"
},
"delete": {
"scopes": [
"https://www.googleapis.com/auth/content"
],
"id": "content.datafeeds.delete",
"parameters": {
"datafeedId": {
"type": "string",
"format": "uint64",
"description": "The ID of the datafeed.",
"required": true,
"location": "path"
},
"merchantId": {
"location": "path",
"type": "string",
"description": "The ID of the account that manages the datafeed. This account cannot be a multi-client account.",
"format": "uint64",
"required": true
}
},
"description": "Deletes a datafeed configuration from your Merchant Center account.",
"httpMethod": "DELETE",
"flatPath": "{merchantId}/datafeeds/{datafeedId}",
"parameterOrder": [
"merchantId",
"datafeedId"
],
"path": "{merchantId}/datafeeds/{datafeedId}"
},
"fetchnow": {
"scopes": [
"https://www.googleapis.com/auth/content"
],
"response": {
"$ref": "DatafeedsFetchNowResponse"
},
"path": "{merchantId}/datafeeds/{datafeedId}/fetchNow",
"httpMethod": "POST",
"parameterOrder": [
"merchantId",
"datafeedId"
],
"description": "Invokes a fetch for the datafeed in your Merchant Center account. If you need to call this method more than once per day, we recommend you use the Products service to update your product data.",
"flatPath": "{merchantId}/datafeeds/{datafeedId}/fetchNow",
"id": "content.datafeeds.fetchnow",
"parameters": {
"datafeedId": {
"required": true,
"location": "path",
"format": "uint64",
"type": "string",
"description": "The ID of the datafeed to be fetched."
},
"merchantId": {
"type": "string",
"description": "The ID of the account that manages the datafeed. This account cannot be a multi-client account.",
"format": "uint64",
"required": true,
"location": "path"
}
}
},
"update": {
"description": "Updates a datafeed configuration of your Merchant Center account. Any fields that are not provided are deleted from the resource.",
"request": {
"$ref": "Datafeed"
},
"flatPath": "{merchantId}/datafeeds/{datafeedId}",
"path": "{merchantId}/datafeeds/{datafeedId}",
"httpMethod": "PUT",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"response": {
"$ref": "Datafeed"
},
"id": "content.datafeeds.update",
"parameterOrder": [
"merchantId",
"datafeedId"
],
"parameters": {
"merchantId": {
"required": true,
"description": "The ID of the account that manages the datafeed. This account cannot be a multi-client account.",
"location": "path",
"format": "uint64",
"type": "string"
},
"datafeedId": {
"description": "The ID of the datafeed.",
"location": "path",
"required": true,
"format": "uint64",
"type": "string"
}
}
}
}
},
"settlementtransactions": {
"methods": {
"list": {
"path": "{merchantId}/settlementreports/{settlementId}/transactions",
"parameters": {
"merchantId": {
"location": "path",
"required": true,
"type": "string",
"format": "uint64",
"description": "The Merchant Center account to list transactions for."
},
"pageToken": {
"location": "query",
"description": "The token returned by the previous request.",
"type": "string"
},
"settlementId": {
"description": "The Google-provided ID of the settlement.",
"required": true,
"location": "path",
"type": "string"
},
"transactionIds": {
"location": "query",
"repeated": true,
"type": "string",
"description": "The list of transactions to return. If not set, all transactions will be returned."
},
"maxResults": {
"description": "The maximum number of transactions to return in the response, used for paging. The default value is 200 transactions per page, and the maximum allowed value is 5000 transactions per page.",
"format": "uint32",
"location": "query",
"type": "integer"
}
},
"scopes": [
"https://www.googleapis.com/auth/content"
],
"id": "content.settlementtransactions.list",
"httpMethod": "GET",
"description": "Retrieves a list of transactions for the settlement.",
"flatPath": "{merchantId}/settlementreports/{settlementId}/transactions",
"response": {
"$ref": "SettlementtransactionsListResponse"
},
"parameterOrder": [
"merchantId",
"settlementId"
]
}
}
},
"settlementreports": {
"methods": {
"list": {
"response": {
"$ref": "SettlementreportsListResponse"
},
"path": "{merchantId}/settlementreports",
"parameters": {
"pageToken": {
"description": "The token returned by the previous request.",
"location": "query",
"type": "string"
},
"transferEndDate": {
"location": "query",
"description": "Obtains settlements which have transactions before this date (inclusively), in ISO 8601 format.",
"type": "string"
},
"transferStartDate": {
"type": "string",
"location": "query",
"description": "Obtains settlements which have transactions after this date (inclusively), in ISO 8601 format."
},
"maxResults": {
"format": "uint32",
"location": "query",
"type": "integer",
"description": "The maximum number of settlements to return in the response, used for paging. The default value is 200 returns per page, and the maximum allowed value is 5000 returns per page."
},
"merchantId": {
"type": "string",
"description": "The Merchant Center account to list settlements for.",
"format": "uint64",
"location": "path",
"required": true
}
},
"flatPath": "{merchantId}/settlementreports",
"id": "content.settlementreports.list",
"parameterOrder": [
"merchantId"
],
"scopes": [
"https://www.googleapis.com/auth/content"
],
"description": "Retrieves a list of settlement reports from your Merchant Center account.",
"httpMethod": "GET"
},
"get": {
"id": "content.settlementreports.get",
"httpMethod": "GET",
"flatPath": "{merchantId}/settlementreports/{settlementId}",
"parameters": {
"merchantId": {
"location": "path",
"description": "The Merchant Center account of the settlement report.",
"format": "uint64",
"required": true,
"type": "string"
},
"settlementId": {
"description": "The Google-provided ID of the settlement.",
"required": true,
"type": "string",
"location": "path"
}
},
"path": "{merchantId}/settlementreports/{settlementId}",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"response": {
"$ref": "SettlementReport"
},
"parameterOrder": [
"merchantId",
"settlementId"
],
"description": "Retrieves a settlement report from your Merchant Center account."
}
}
},
"shippingsettings": {
"methods": {
"getsupportedpickupservices": {
"parameterOrder": [
"merchantId"
],
"id": "content.shippingsettings.getsupportedpickupservices",
"httpMethod": "GET",
"response": {
"$ref": "ShippingsettingsGetSupportedPickupServicesResponse"
},
"flatPath": "{merchantId}/supportedPickupServices",
"description": "Retrieves supported pickup services for an account.",
"parameters": {
"merchantId": {
"required": true,
"type": "string",
"description": "The ID of the account for which to retrieve the supported pickup services.",
"location": "path",
"format": "uint64"
}
},
"scopes": [
"https://www.googleapis.com/auth/content"
],
"path": "{merchantId}/supportedPickupServices"
},
"getsupportedholidays": {
"id": "content.shippingsettings.getsupportedholidays",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"description": "Retrieves supported holidays for an account.",
"parameterOrder": [
"merchantId"
],
"httpMethod": "GET",
"response": {
"$ref": "ShippingsettingsGetSupportedHolidaysResponse"
},
"parameters": {
"merchantId": {
"required": true,
"type": "string",
"description": "The ID of the account for which to retrieve the supported holidays.",
"format": "uint64",
"location": "path"
}
},
"path": "{merchantId}/supportedHolidays",
"flatPath": "{merchantId}/supportedHolidays"
},
"update": {
"path": "{merchantId}/shippingsettings/{accountId}",
"flatPath": "{merchantId}/shippingsettings/{accountId}",
"id": "content.shippingsettings.update",
"parameterOrder": [
"merchantId",
"accountId"
],
"httpMethod": "PUT",
"request": {
"$ref": "ShippingSettings"
},
"description": "Updates the shipping settings of the account. Any fields that are not provided are deleted from the resource.",
"parameters": {
"accountId": {
"type": "string",
"location": "path",
"format": "uint64",
"required": true,
"description": "The ID of the account for which to get/update shipping settings."
},
"merchantId": {
"required": true,
"location": "path",
"format": "uint64",
"type": "string",
"description": "The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account."
}
},
"response": {
"$ref": "ShippingSettings"
},
"scopes": [
"https://www.googleapis.com/auth/content"
]
},
"getsupportedcarriers": {
"path": "{merchantId}/supportedCarriers",
"id": "content.shippingsettings.getsupportedcarriers",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"httpMethod": "GET",
"description": "Retrieves supported carriers and carrier services for an account.",
"flatPath": "{merchantId}/supportedCarriers",
"parameters": {
"merchantId": {
"type": "string",
"description": "The ID of the account for which to retrieve the supported carriers.",
"location": "path",
"required": true,
"format": "uint64"
}
},
"parameterOrder": [
"merchantId"
],
"response": {
"$ref": "ShippingsettingsGetSupportedCarriersResponse"
}
},
"get": {
"description": "Retrieves the shipping settings of the account.",
"parameters": {
"accountId": {
"location": "path",
"type": "string",
"format": "uint64",
"description": "The ID of the account for which to get/update shipping settings.",
"required": true
},
"merchantId": {
"type": "string",
"description": "The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.",
"format": "uint64",
"location": "path",
"required": true
}
},
"id": "content.shippingsettings.get",
"parameterOrder": [
"merchantId",
"accountId"
],
"httpMethod": "GET",
"response": {
"$ref": "ShippingSettings"
},
"flatPath": "{merchantId}/shippingsettings/{accountId}",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"path": "{merchantId}/shippingsettings/{accountId}"
},
"custombatch": {
"request": {
"$ref": "ShippingsettingsCustomBatchRequest"
},
"parameterOrder": [],
"path": "shippingsettings/batch",
"response": {
"$ref": "ShippingsettingsCustomBatchResponse"
},
"parameters": {},
"description": "Retrieves and updates the shipping settings of multiple accounts in a single request.",
"flatPath": "shippingsettings/batch",
"httpMethod": "POST",
"id": "content.shippingsettings.custombatch",
"scopes": [
"https://www.googleapis.com/auth/content"
]
},
"list": {
"scopes": [
"https://www.googleapis.com/auth/content"
],
"flatPath": "{merchantId}/shippingsettings",
"path": "{merchantId}/shippingsettings",
"id": "content.shippingsettings.list",
"parameters": {
"pageToken": {
"description": "The token returned by the previous request.",
"type": "string",
"location": "query"
},
"maxResults": {
"description": "The maximum number of shipping settings to return in the response, used for paging.",
"location": "query",
"format": "uint32",
"type": "integer"
},
"merchantId": {
"format": "uint64",
"location": "path",
"type": "string",
"required": true,
"description": "The ID of the managing account. This must be a multi-client account."
}
},
"httpMethod": "GET",
"response": {
"$ref": "ShippingsettingsListResponse"
},
"parameterOrder": [
"merchantId"
],
"description": "Lists the shipping settings of the sub-accounts in your Merchant Center account."
}
}
},
"accountstatuses": {
"methods": {
"list": {
"httpMethod": "GET",
"path": "{merchantId}/accountstatuses",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"id": "content.accountstatuses.list",
"parameters": {
"pageToken": {
"type": "string",
"location": "query",
"description": "The token returned by the previous request."
},
"maxResults": {
"format": "uint32",
"type": "integer",
"location": "query",
"description": "The maximum number of account statuses to return in the response, used for paging."
},
"destinations": {
"repeated": true,
"type": "string",
"location": "query",
"description": "If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination."
},
"merchantId": {
"required": true,
"type": "string",
"format": "uint64",
"location": "path",
"description": "The ID of the managing account. This must be a multi-client account."
}
},
"parameterOrder": [
"merchantId"
],
"description": "Lists the statuses of the sub-accounts in your Merchant Center account.",
"flatPath": "{merchantId}/accountstatuses",
"response": {
"$ref": "AccountstatusesListResponse"
}
},
"custombatch": {
"path": "accountstatuses/batch",
"parameters": {},
"id": "content.accountstatuses.custombatch",
"request": {
"$ref": "AccountstatusesCustomBatchRequest"
},
"response": {
"$ref": "AccountstatusesCustomBatchResponse"
},
"parameterOrder": [],
"description": "Retrieves multiple Merchant Center account statuses in a single request.",
"httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"flatPath": "accountstatuses/batch"
},
"get": {
"parameters": {
"destinations": {
"type": "string",
"repeated": true,
"location": "query",
"description": "If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination."
},
"merchantId": {
"format": "uint64",
"location": "path",
"required": true,
"type": "string",
"description": "The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account."
},
"accountId": {
"type": "string",
"required": true,
"description": "The ID of the account.",
"format": "uint64",
"location": "path"
}
},
"response": {
"$ref": "AccountStatus"
},
"parameterOrder": [
"merchantId",
"accountId"
],
"scopes": [
"https://www.googleapis.com/auth/content"
],
"description": "Retrieves the status of a Merchant Center account. No itemLevelIssues are returned for multi-client accounts.",
"path": "{merchantId}/accountstatuses/{accountId}",
"flatPath": "{merchantId}/accountstatuses/{accountId}",
"httpMethod": "GET",
"id": "content.accountstatuses.get"
}
}
},
"productstatuses": {
"resources": {
"repricingreports": {
"methods": {
"list": {
"id": "content.productstatuses.repricingreports.list",
"path": "{merchantId}/productstatuses/{productId}/repricingreports",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"response": {
"$ref": "ListRepricingProductReportsResponse"
},
"parameterOrder": [
"merchantId",
"productId"
],
"flatPath": "{merchantId}/productstatuses/{productId}/repricingreports",
"httpMethod": "GET",
"description": "Lists the metrics report for a given Repricing product.",
"parameters": {
"startDate": {
"description": "Gets Repricing reports on and after this date in the merchant's timezone, up to one year ago. Do not use a start date later than 7 days ago (default). Format is YYYY-MM-DD.",
"type": "string",
"location": "query"
},
"productId": {
"required": true,
"description": "Required. Id of the Repricing product. Also known as the [REST_ID](https://developers.google.com/shopping-content/reference/rest/v2.1/products#Product.FIELDS.id)",
"location": "path",
"type": "string"
},
"pageSize": {
"format": "int32",
"location": "query",
"type": "integer",
"description": "Maximum number of days of reports to return. There can be more than one rule report returned per day. For example, if 3 rule types got applied to the same product within a 24-hour period, then a page_size of 1 will return 3 rule reports. The page size defaults to 50 and values above 1000 are coerced to 1000. This service may return fewer days of reports than this value, for example, if the time between your start and end date is less than the page size."
},
"merchantId": {
"type": "string",
"description": "Required. Id of the merchant who owns the Repricing rule.",
"location": "path",
"format": "int64",
"required": true
},
"endDate": {
"type": "string",
"description": "Gets Repricing reports on and before this date in the merchant's timezone. You can only retrieve data up to 7 days ago (default) or earlier. Format is YYYY-MM-DD.",
"location": "query"
},
"ruleId": {
"description": "Id of the Repricing rule. If specified, only gets this rule's reports.",
"type": "string",
"location": "query"
},
"pageToken": {
"type": "string",
"location": "query",
"description": "Token (if provided) to retrieve the subsequent page. All other parameters must match the original call that provided the page token."
}
}
}
}
}
},
"methods": {
"custombatch": {
"httpMethod": "POST",
"parameters": {},
"description": "Gets the statuses of multiple products in a single request.",
"id": "content.productstatuses.custombatch",
"parameterOrder": [],
"request": {
"$ref": "ProductstatusesCustomBatchRequest"
},
"response": {
"$ref": "ProductstatusesCustomBatchResponse"
},
"scopes": [
"https://www.googleapis.com/auth/content"
],
"flatPath": "productstatuses/batch",
"path": "productstatuses/batch"
},
"list": {
"description": "Lists the statuses of the products in your Merchant Center account.",
"response": {
"$ref": "ProductstatusesListResponse"
},
"parameterOrder": [
"merchantId"
],
"flatPath": "{merchantId}/productstatuses",
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"parameters": {
"merchantId": {
"description": "The ID of the account that contains the products. This account cannot be a multi-client account.",
"type": "string",
"required": true,
"format": "uint64",
"location": "path"
},
"maxResults": {
"type": "integer",
"description": "The maximum number of product statuses to return in the response, used for paging.",
"location": "query",
"format": "uint32"
},
"pageToken": {
"location": "query",
"description": "The token returned by the previous request.",
"type": "string"
},
"destinations": {
"type": "string",
"description": "If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination.",
"location": "query",
"repeated": true
}
},
"id": "content.productstatuses.list",
"path": "{merchantId}/productstatuses"
},
"get": {
"parameters": {
"destinations": {
"description": "If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination.",
"repeated": true,
"location": "query",
"type": "string"
},
"productId": {
"location": "path",
"required": true,
"description": "The REST ID of the product.",
"type": "string"
},
"merchantId": {
"location": "path",
"required": true,
"format": "uint64",
"type": "string",
"description": "The ID of the account that contains the product. This account cannot be a multi-client account."
}
},
"parameterOrder": [
"merchantId",
"productId"
],
"response": {
"$ref": "ProductStatus"
},
"path": "{merchantId}/productstatuses/{productId}",
"id": "content.productstatuses.get",
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"flatPath": "{merchantId}/productstatuses/{productId}",
"description": "Gets the status of a product from your Merchant Center account."
}
}
},
"repricingrules": {
"methods": {
"create": {
"scopes": [
"https://www.googleapis.com/auth/content"
],
"path": "{merchantId}/repricingrules",
"description": "Creates a repricing rule for your Merchant Center account.",
"response": {
"$ref": "RepricingRule"
},
"httpMethod": "POST",
"request": {
"$ref": "RepricingRule"
},
"flatPath": "{merchantId}/repricingrules",
"parameterOrder": [
"merchantId"
],
"parameters": {
"merchantId": {
"type": "string",
"description": "Required. The id of the merchant who owns the repricing rule.",
"required": true,
"location": "path",
"format": "int64"
},
"ruleId": {
"location": "query",
"description": "Required. The id of the rule to create.",
"type": "string"
}
},
"id": "content.repricingrules.create"
},
"get": {
"parameterOrder": [
"merchantId",
"ruleId"
],
"scopes": [
"https://www.googleapis.com/auth/content"
],
"parameters": {
"merchantId": {
"type": "string",
"description": "Required. The id of the merchant who owns the repricing rule.",
"format": "int64",
"location": "path",
"required": true
},
"ruleId": {
"required": true,
"description": "Required. The id of the rule to retrieve.",
"type": "string",
"location": "path"
}
},
"id": "content.repricingrules.get",
"path": "{merchantId}/repricingrules/{ruleId}",
"description": "Retrieves a repricing rule from your Merchant Center account.",
"flatPath": "{merchantId}/repricingrules/{ruleId}",
"httpMethod": "GET",
"response": {
"$ref": "RepricingRule"
}
},
"list": {
"scopes": [
"https://www.googleapis.com/auth/content"
],
"path": "{merchantId}/repricingrules",
"parameterOrder": [
"merchantId"
],
"flatPath": "{merchantId}/repricingrules",
"response": {
"$ref": "ListRepricingRulesResponse"
},
"id": "content.repricingrules.list",
"parameters": {
"countryCode": {
"description": "[CLDR country code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) (e.g. \"US\"), used as a filter on repricing rules.",
"type": "string",
"location": "query"
},
"merchantId": {
"location": "path",
"description": "Required. The id of the merchant who owns the repricing rule.",
"format": "int64",
"required": true,
"type": "string"
},
"pageToken": {
"type": "string",
"location": "query",
"description": "A page token, received from a previous `ListRepricingRules` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListRepricingRules` must match the call that provided the page token."
},
"pageSize": {
"location": "query",
"type": "integer",
"description": "The maximum number of repricing rules to return. The service may return fewer than this value. If unspecified, at most 50 rules will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.",
"format": "int32"
},
"languageCode": {
"location": "query",
"type": "string",
"description": "The two-letter ISO 639-1 language code associated with the repricing rule, used as a filter."
}
},
"description": "Lists the repricing rules in your Merchant Center account.",
"httpMethod": "GET"
},
"delete": {
"description": "Deletes a repricing rule in your Merchant Center account.",
"id": "content.repricingrules.delete",
"parameterOrder": [
"merchantId",
"ruleId"
],
"httpMethod": "DELETE",
"flatPath": "{merchantId}/repricingrules/{ruleId}",
"path": "{merchantId}/repricingrules/{ruleId}",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"parameters": {
"ruleId": {
"location": "path",
"required": true,
"type": "string",
"description": "Required. The id of the rule to Delete."
},
"merchantId": {
"location": "path",
"type": "string",
"format": "int64",
"required": true,
"description": "Required. The id of the merchant who owns the repricing rule."
}
}
},
"patch": {
"description": "Updates a repricing rule in your Merchant Center account. All mutable fields will be overwritten in each update request. In each update, you must provide all required mutable fields, or an error will be thrown. If you do not provide an optional field in the update request, if that field currently exists, it will be deleted from the rule.",
"response": {
"$ref": "RepricingRule"
},
"flatPath": "{merchantId}/repricingrules/{ruleId}",
"path": "{merchantId}/repricingrules/{ruleId}",
"id": "content.repricingrules.patch",
"parameterOrder": [
"merchantId",
"ruleId"
],
"scopes": [
"https://www.googleapis.com/auth/content"
],
"request": {
"$ref": "RepricingRule"
},
"httpMethod": "PATCH",
"parameters": {
"merchantId": {
"required": true,
"description": "Required. The id of the merchant who owns the repricing rule.",
"location": "path",
"format": "int64",
"type": "string"
},
"ruleId": {
"location": "path",
"required": true,
"description": "Required. The id of the rule to update.",
"type": "string"
}
}
}
},
"resources": {
"repricingreports": {
"methods": {
"list": {
"path": "{merchantId}/repricingrules/{ruleId}/repricingreports",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"response": {
"$ref": "ListRepricingRuleReportsResponse"
},
"flatPath": "{merchantId}/repricingrules/{ruleId}/repricingreports",
"description": "Lists the metrics report for a given Repricing rule.",
"id": "content.repricingrules.repricingreports.list",
"parameters": {
"pageSize": {
"description": "Maximum number of daily reports to return. Each report includes data from a single 24-hour period. The page size defaults to 50 and values above 1000 are coerced to 1000. This service may return fewer days than this value, for example, if the time between your start and end date is less than page size.",
"location": "query",
"type": "integer",
"format": "int32"
},
"startDate": {
"location": "query",
"description": "Gets Repricing reports on and after this date in the merchant's timezone, up to one year ago. Do not use a start date later than 7 days ago (default). Format: YYYY-MM-DD.",
"type": "string"
},
"pageToken": {
"location": "query",
"description": "Token (if provided) to retrieve the subsequent page. All other parameters must match the original call that provided the page token.",
"type": "string"
},
"ruleId": {
"required": true,
"type": "string",
"description": "Required. Id of the Repricing rule.",
"location": "path"
},
"endDate": {
"type": "string",
"location": "query",
"description": "Gets Repricing reports on and before this date in the merchant's timezone. You can only retrieve data up to 7 days ago (default) or earlier. Format: YYYY-MM-DD."
},
"merchantId": {
"required": true,
"description": "Required. Id of the merchant who owns the Repricing rule.",
"format": "int64",
"type": "string",
"location": "path"
}
},
"parameterOrder": [
"merchantId",
"ruleId"
],
"httpMethod": "GET"
}
}
}
}
},
"orderreturns": {
"methods": {
"acknowledge": {
"request": {
"$ref": "OrderreturnsAcknowledgeRequest"
},
"description": "Acks an order return in your Merchant Center account.",
"parameters": {
"returnId": {
"description": "The ID of the return.",
"required": true,
"type": "string",
"location": "path"
},
"merchantId": {
"format": "uint64",
"description": "The ID of the account that manages the order. This cannot be a multi-client account.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "{merchantId}/orderreturns/{returnId}/acknowledge",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"flatPath": "{merchantId}/orderreturns/{returnId}/acknowledge",
"id": "content.orderreturns.acknowledge",
"parameterOrder": [
"merchantId",
"returnId"
],
"httpMethod": "POST",
"response": {
"$ref": "OrderreturnsAcknowledgeResponse"
}
},
"list": {
"httpMethod": "GET",
"flatPath": "{merchantId}/orderreturns",
"parameters": {
"shipmentTypes": {
"repeated": true,
"type": "string",
"location": "query",
"description": "Obtains order returns that match any shipment type provided in this parameter. When this parameter is not provided, order returns are obtained regardless of their shipment types.",
"enum": [
"BY_MAIL",
"RETURNLESS",
"CONTACT_CUSTOMER_SUPPORT"
],
"enumDescriptions": [
"",
"",
""
]
},
"orderBy": {
"enumDescriptions": [
"",
""
],
"enum": [
"RETURN_CREATION_TIME_DESC",
"RETURN_CREATION_TIME_ASC"
],
"type": "string",
"description": "Return the results in the specified order.",
"location": "query"
},
"createdStartDate": {
"description": "Obtains order returns created after this date (inclusively), in ISO 8601 format.",
"type": "string",
"location": "query"
},
"pageToken": {
"type": "string",
"location": "query",
"description": "The token returned by the previous request."
},
"createdEndDate": {
"location": "query",
"description": "Obtains order returns created before this date (inclusively), in ISO 8601 format.",
"type": "string"
},
"shipmentTrackingNumbers": {
"description": "Obtains order returns with the specified tracking numbers. If this parameter is provided, createdStartDate, createdEndDate, shipmentType, shipmentStatus, shipmentState and acknowledged parameters must be not set. Note: if googleOrderId and shipmentTrackingNumber parameters are provided, the obtained results will include all order returns that either match the specified order id or the specified tracking number.",
"location": "query",
"type": "string",
"repeated": true
},
"shipmentStatus": {
"enumDescriptions": [
"",
"",
""
],
"type": "string",
"location": "query",
"description": "Obtains order returns that match any shipment status provided in this parameter. When this parameter is not provided, order returns are obtained regardless of their shipment statuses.",
"enum": [
"NEW",
"IN_PROGRESS",
"PROCESSED"
],
"repeated": true
},
"acknowledged": {
"description": "Obtains order returns that match the acknowledgement status. When set to true, obtains order returns that have been acknowledged. When false, obtains order returns that have not been acknowledged. When not provided, obtains order returns regardless of their acknowledgement status. We recommend using this filter set to `false`, in conjunction with the `acknowledge` call, such that only un-acknowledged order returns are returned. ",
"type": "boolean",
"location": "query"
},
"merchantId": {
"required": true,
"description": "The ID of the account that manages the order. This cannot be a multi-client account.",
"format": "uint64",
"type": "string",
"location": "path"
},
"shipmentStates": {
"description": "Obtains order returns that match any shipment state provided in this parameter. When this parameter is not provided, order returns are obtained regardless of their shipment states.",
"enumDescriptions": [
"",
"",
"",
"",
""
],
"type": "string",
"location": "query",
"repeated": true,
"enum": [
"NEW",
"SHIPPED",
"COMPLETED",
"UNDELIVERABLE",
"PENDING"
]
},
"maxResults": {
"location": "query",
"type": "integer",
"description": "The maximum number of order returns to return in the response, used for paging. The default value is 25 returns per page, and the maximum allowed value is 250 returns per page.",
"format": "uint32"
},
"googleOrderIds": {
"repeated": true,
"type": "string",
"location": "query",
"description": "Obtains order returns with the specified order ids. If this parameter is provided, createdStartDate, createdEndDate, shipmentType, shipmentStatus, shipmentState and acknowledged parameters must be not set. Note: if googleOrderId and shipmentTrackingNumber parameters are provided, the obtained results will include all order returns that either match the specified order id or the specified tracking number."
}
},
"path": "{merchantId}/orderreturns",
"id": "content.orderreturns.list",
"response": {
"$ref": "OrderreturnsListResponse"
},
"scopes": [
"https://www.googleapis.com/auth/content"
],
"parameterOrder": [
"merchantId"
],
"description": "Lists order returns in your Merchant Center account."
},
"get": {
"parameters": {
"returnId": {
"type": "string",
"description": "Merchant order return ID generated by Google.",
"location": "path",
"required": true
},
"merchantId": {
"format": "uint64",
"type": "string",
"location": "path",
"description": "The ID of the account that manages the order. This cannot be a multi-client account.",
"required": true
}
},
"id": "content.orderreturns.get",
"parameterOrder": [
"merchantId",
"returnId"
],
"flatPath": "{merchantId}/orderreturns/{returnId}",
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"description": "Retrieves an order return from your Merchant Center account.",
"path": "{merchantId}/orderreturns/{returnId}",
"response": {
"$ref": "MerchantOrderReturn"
}
},
"process": {
"parameters": {
"merchantId": {
"description": "The ID of the account that manages the order. This cannot be a multi-client account.",
"format": "uint64",
"type": "string",
"location": "path",
"required": true
},
"returnId": {
"description": "The ID of the return.",
"required": true,
"type": "string",
"location": "path"
}
},
"path": "{merchantId}/orderreturns/{returnId}/process",
"flatPath": "{merchantId}/orderreturns/{returnId}/process",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"description": "Processes return in your Merchant Center account.",
"httpMethod": "POST",
"response": {
"$ref": "OrderreturnsProcessResponse"
},
"parameterOrder": [
"merchantId",
"returnId"
],
"id": "content.orderreturns.process",
"request": {
"$ref": "OrderreturnsProcessRequest"
}
},
"createorderreturn": {
"parameterOrder": [
"merchantId"
],
"flatPath": "{merchantId}/orderreturns/createOrderReturn",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"parameters": {
"merchantId": {
"location": "path",
"description": "The ID of the account that manages the order. This cannot be a multi-client account.",
"required": true,
"format": "uint64",
"type": "string"
}
},
"path": "{merchantId}/orderreturns/createOrderReturn",
"request": {
"$ref": "OrderreturnsCreateOrderReturnRequest"
},
"httpMethod": "POST",
"id": "content.orderreturns.createorderreturn",
"response": {
"$ref": "OrderreturnsCreateOrderReturnResponse"
},
"description": "Create return in your Merchant Center account."
}
}
},
"datafeedstatuses": {
"methods": {
"get": {
"parameters": {
"country": {
"description": "The country for which to get the datafeed status. If this parameter is provided then language must also be provided. Note that this parameter is required for feeds targeting multiple countries and languages, since a feed may have a different status for each target.",
"location": "query",
"type": "string"
},
"datafeedId": {
"description": "The ID of the datafeed.",
"location": "path",
"format": "uint64",
"type": "string",
"required": true
},
"merchantId": {
"required": true,
"type": "string",
"description": "The ID of the account that manages the datafeed. This account cannot be a multi-client account.",
"format": "uint64",
"location": "path"
},
"language": {
"type": "string",
"description": "The language for which to get the datafeed status. If this parameter is provided then country must also be provided. Note that this parameter is required for feeds targeting multiple countries and languages, since a feed may have a different status for each target.",
"location": "query"
}
},
"flatPath": "{merchantId}/datafeedstatuses/{datafeedId}",
"id": "content.datafeedstatuses.get",
"httpMethod": "GET",
"path": "{merchantId}/datafeedstatuses/{datafeedId}",
"parameterOrder": [
"merchantId",
"datafeedId"
],
"response": {
"$ref": "DatafeedStatus"
},
"scopes": [
"https://www.googleapis.com/auth/content"
],
"description": "Retrieves the status of a datafeed from your Merchant Center account."
},
"list": {
"parameters": {
"maxResults": {
"location": "query",
"format": "uint32",
"description": "The maximum number of products to return in the response, used for paging.",
"type": "integer"
},
"pageToken": {
"type": "string",
"location": "query",
"description": "The token returned by the previous request."
},
"merchantId": {
"required": true,
"location": "path",
"type": "string",
"description": "The ID of the account that manages the datafeeds. This account cannot be a multi-client account.",
"format": "uint64"
}
},
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"response": {
"$ref": "DatafeedstatusesListResponse"
},
"path": "{merchantId}/datafeedstatuses",
"flatPath": "{merchantId}/datafeedstatuses",
"parameterOrder": [
"merchantId"
],
"id": "content.datafeedstatuses.list",
"description": "Lists the statuses of the datafeeds in your Merchant Center account."
},
"custombatch": {
"parameterOrder": [],
"description": "Gets multiple Merchant Center datafeed statuses in a single request.",
"parameters": {},
"request": {
"$ref": "DatafeedstatusesCustomBatchRequest"
},
"flatPath": "datafeedstatuses/batch",
"httpMethod": "POST",
"id": "content.datafeedstatuses.custombatch",
"response": {
"$ref": "DatafeedstatusesCustomBatchResponse"
},
"scopes": [
"https://www.googleapis.com/auth/content"
],
"path": "datafeedstatuses/batch"
}
}
},
"accounts": {
"methods": {
"link": {
"request": {
"$ref": "AccountsLinkRequest"
},
"parameterOrder": [
"merchantId",
"accountId"
],
"flatPath": "{merchantId}/accounts/{accountId}/link",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"path": "{merchantId}/accounts/{accountId}/link",
"parameters": {
"merchantId": {
"location": "path",
"type": "string",
"description": "The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.",
"required": true,
"format": "uint64"
},
"accountId": {
"location": "path",
"type": "string",
"required": true,
"description": "The ID of the account that should be linked.",
"format": "uint64"
}
},
"httpMethod": "POST",
"description": "Performs an action on a link between two Merchant Center accounts, namely accountId and linkedAccountId.",
"response": {
"$ref": "AccountsLinkResponse"
},
"id": "content.accounts.link"
},
"get": {
"response": {
"$ref": "Account"
},
"parameterOrder": [
"merchantId",
"accountId"
],
"id": "content.accounts.get",
"path": "{merchantId}/accounts/{accountId}",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"flatPath": "{merchantId}/accounts/{accountId}",
"parameters": {
"view": {
"location": "query",
"type": "string",
"enumDescriptions": [
"",
""
],
"description": "Controls which fields will be populated. Acceptable values are: \"merchant\" and \"css\". The default value is \"merchant\".",
"enum": [
"MERCHANT",
"CSS"
]
},
"merchantId": {
"type": "string",
"required": true,
"description": "The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.",
"location": "path",
"format": "uint64"
},
"accountId": {
"format": "uint64",
"description": "The ID of the account.",
"location": "path",
"required": true,
"type": "string"
}
},
"httpMethod": "GET",
"description": "Retrieves a Merchant Center account."
},
"update": {
"path": "{merchantId}/accounts/{accountId}",
"flatPath": "{merchantId}/accounts/{accountId}",
"request": {
"$ref": "Account"
},
"scopes": [
"https://www.googleapis.com/auth/content"
],
"response": {
"$ref": "Account"
},
"parameters": {
"merchantId": {
"description": "The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.",
"type": "string",
"location": "path",
"format": "uint64",
"required": true
},
"accountId": {
"format": "uint64",
"description": "The ID of the account.",
"type": "string",
"required": true,
"location": "path"
}
},
"description": "Updates a Merchant Center account. Any fields that are not provided are deleted from the resource.",
"parameterOrder": [
"merchantId",
"accountId"
],
"id": "content.accounts.update",
"httpMethod": "PUT"
},
"listlinks": {
"id": "content.accounts.listlinks",
"parameterOrder": [
"merchantId",
"accountId"
],
"description": "Returns the list of accounts linked to your Merchant Center account.",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"parameters": {
"merchantId": {
"type": "string",
"description": "The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.",
"location": "path",
"format": "uint64",
"required": true
},
"accountId": {
"type": "string",
"description": "The ID of the account for which to list links.",
"location": "path",
"required": true,
"format": "uint64"
},
"maxResults": {
"type": "integer",
"location": "query",
"description": "The maximum number of links to return in the response, used for pagination.",
"format": "uint32"
},
"pageToken": {
"location": "query",
"type": "string",
"description": "The token returned by the previous request."
}
},
"httpMethod": "GET",
"response": {
"$ref": "AccountsListLinksResponse"
},
"path": "{merchantId}/accounts/{accountId}/listlinks",
"flatPath": "{merchantId}/accounts/{accountId}/listlinks"
},
"authinfo": {
"httpMethod": "GET",
"parameters": {},
"response": {
"$ref": "AccountsAuthInfoResponse"
},
"path": "accounts/authinfo",
"id": "content.accounts.authinfo",
"flatPath": "accounts/authinfo",
"description": "Returns information about the authenticated user.",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"parameterOrder": []
},
"delete": {
"httpMethod": "DELETE",
"parameterOrder": [
"merchantId",
"accountId"
],
"path": "{merchantId}/accounts/{accountId}",
"parameters": {
"merchantId": {
"format": "uint64",
"type": "string",
"required": true,
"description": "The ID of the managing account. This must be a multi-client account, and accountId must be the ID of a sub-account of this account.",
"location": "path"
},
"force": {
"default": "false",
"type": "boolean",
"location": "query",
"description": "Flag to delete sub-accounts with products. The default value is false."
},
"accountId": {
"required": true,
"description": "The ID of the account.",
"format": "uint64",
"type": "string",
"location": "path"
}
},
"description": "Deletes a Merchant Center sub-account.",
"flatPath": "{merchantId}/accounts/{accountId}",
"id": "content.accounts.delete",
"scopes": [
"https://www.googleapis.com/auth/content"
]
},
"list": {
"scopes": [
"https://www.googleapis.com/auth/content"
],
"flatPath": "{merchantId}/accounts",
"id": "content.accounts.list",
"description": "Lists the sub-accounts in your Merchant Center account.",
"parameters": {
"pageToken": {
"type": "string",
"description": "The token returned by the previous request.",
"location": "query"
},
"label": {
"type": "string",
"description": "If view is set to \"css\", only return accounts that are assigned label with given ID.",
"location": "query",
"format": "uint64"
},
"view": {
"enum": [
"MERCHANT",
"CSS"
],
"enumDescriptions": [
"",
""
],
"description": "Controls which fields will be populated. Acceptable values are: \"merchant\" and \"css\". The default value is \"merchant\".",
"location": "query",
"type": "string"
},
"maxResults": {
"description": "The maximum number of accounts to return in the response, used for paging.",
"location": "query",
"format": "uint32",
"type": "integer"
},
"merchantId": {
"type": "string",
"location": "path",
"format": "uint64",
"description": "The ID of the managing account. This must be a multi-client account.",
"required": true
}
},
"path": "{merchantId}/accounts",
"parameterOrder": [
"merchantId"
],
"httpMethod": "GET",
"response": {
"$ref": "AccountsListResponse"
}
},
"insert": {
"httpMethod": "POST",
"request": {
"$ref": "Account"
},
"response": {
"$ref": "Account"
},
"flatPath": "{merchantId}/accounts",
"path": "{merchantId}/accounts",
"description": "Creates a Merchant Center sub-account.",
"parameters": {
"merchantId": {
"description": "The ID of the managing account. This must be a multi-client account.",
"location": "path",
"format": "uint64",
"type": "string",
"required": true
}
},
"id": "content.accounts.insert",
"parameterOrder": [
"merchantId"
],
"scopes": [
"https://www.googleapis.com/auth/content"
]
},
"updatelabels": {
"description": "Updates labels that are assigned to the Merchant Center account by CSS user.",
"request": {
"$ref": "AccountsUpdateLabelsRequest"
},
"parameters": {
"merchantId": {
"description": "The ID of the managing account.",
"location": "path",
"type": "string",
"format": "uint64",
"required": true
},
"accountId": {
"format": "uint64",
"required": true,
"description": "The ID of the account whose labels are updated.",
"type": "string",
"location": "path"
}
},
"flatPath": "{merchantId}/accounts/{accountId}/updatelabels",
"parameterOrder": [
"merchantId",
"accountId"
],
"scopes": [
"https://www.googleapis.com/auth/content"
],
"response": {
"$ref": "AccountsUpdateLabelsResponse"
},
"path": "{merchantId}/accounts/{accountId}/updatelabels",
"id": "content.accounts.updatelabels",
"httpMethod": "POST"
},
"custombatch": {
"parameters": {},
"flatPath": "accounts/batch",
"parameterOrder": [],
"response": {
"$ref": "AccountsCustomBatchResponse"
},
"description": "Retrieves, inserts, updates, and deletes multiple Merchant Center (sub-)accounts in a single request.",
"request": {
"$ref": "AccountsCustomBatchRequest"
},
"id": "content.accounts.custombatch",
"path": "accounts/batch",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"httpMethod": "POST"
},
"claimwebsite": {
"scopes": [
"https://www.googleapis.com/auth/content"
],
"parameters": {
"overwrite": {
"description": "Only available to selected merchants. When set to `True`, this flag removes any existing claim on the requested website by another account and replaces it with a claim from this account.",
"type": "boolean",
"location": "query"
},
"accountId": {
"location": "path",
"required": true,
"type": "string",
"format": "uint64",
"description": "The ID of the account whose website is claimed."
},
"merchantId": {
"description": "The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.",
"location": "path",
"required": true,
"format": "uint64",
"type": "string"
}
},
"response": {
"$ref": "AccountsClaimWebsiteResponse"
},
"parameterOrder": [
"merchantId",
"accountId"
],
"flatPath": "{merchantId}/accounts/{accountId}/claimwebsite",
"description": "Claims the website of a Merchant Center sub-account.",
"id": "content.accounts.claimwebsite",
"path": "{merchantId}/accounts/{accountId}/claimwebsite",
"httpMethod": "POST"
}
},
"resources": {
"returncarrier": {
"methods": {
"patch": {
"parameterOrder": [
"accountId",
"carrierAccountId"
],
"flatPath": "accounts/{accountId}/returncarrier/{carrierAccountId}",
"id": "content.accounts.returncarrier.patch",
"description": "Updates a return carrier in the merchant account.",
"parameters": {
"accountId": {
"type": "string",
"required": true,
"format": "int64",
"location": "path",
"description": "Required. The Merchant Center Account Id under which the Return Carrier is to be linked."
},
"carrierAccountId": {
"description": "Required. The Google-provided unique carrier ID, used to update the resource.",
"format": "int64",
"type": "string",
"required": true,
"location": "path"
}
},
"path": "accounts/{accountId}/returncarrier/{carrierAccountId}",
"httpMethod": "PATCH",
"response": {
"$ref": "AccountReturnCarrier"
},
"scopes": [
"https://www.googleapis.com/auth/content"
],
"request": {
"$ref": "AccountReturnCarrier"
}
},
"delete": {
"parameterOrder": [
"accountId",
"carrierAccountId"
],
"flatPath": "accounts/{accountId}/returncarrier/{carrierAccountId}",
"id": "content.accounts.returncarrier.delete",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"parameters": {
"carrierAccountId": {
"format": "int64",
"type": "string",
"location": "path",
"description": "Required. The Google-provided unique carrier ID, used to update the resource.",
"required": true
},
"accountId": {
"required": true,
"description": "Required. The Merchant Center Account Id under which the Return Carrier is to be linked.",
"format": "int64",
"location": "path",
"type": "string"
}
},
"path": "accounts/{accountId}/returncarrier/{carrierAccountId}",
"description": "Delete a return carrier in the merchant account.",
"httpMethod": "DELETE"
},
"create": {
"description": "Links return carrier to a merchant account.",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"httpMethod": "POST",
"request": {
"$ref": "AccountReturnCarrier"
},
"response": {
"$ref": "AccountReturnCarrier"
},
"parameterOrder": [
"accountId"
],
"id": "content.accounts.returncarrier.create",
"path": "accounts/{accountId}/returncarrier",
"flatPath": "accounts/{accountId}/returncarrier",
"parameters": {
"accountId": {
"type": "string",
"description": "Required. The Merchant Center Account Id under which the Return Carrier is to be linked.",
"format": "int64",
"required": true,
"location": "path"
}
}
},
"list": {
"httpMethod": "GET",
"parameterOrder": [
"accountId"
],
"scopes": [
"https://www.googleapis.com/auth/content"
],
"description": "Lists available return carriers in the merchant account.",
"path": "accounts/{accountId}/returncarrier",
"id": "content.accounts.returncarrier.list",
"flatPath": "accounts/{accountId}/returncarrier",
"parameters": {
"accountId": {
"format": "int64",
"required": true,
"description": "Required. The Merchant Center Account Id under which the Return Carrier is to be linked.",
"location": "path",
"type": "string"
}
},
"response": {
"$ref": "ListAccountReturnCarrierResponse"
}
}
}
},
"labels": {
"methods": {
"patch": {
"flatPath": "accounts/{accountId}/labels/{labelId}",
"parameters": {
"labelId": {
"type": "string",
"location": "path",
"description": "Required. The id of the label to update.",
"format": "int64",
"required": true
},
"accountId": {
"description": "Required. The id of the account this label belongs to.",
"type": "string",
"format": "int64",
"required": true,
"location": "path"
}
},
"path": "accounts/{accountId}/labels/{labelId}",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"httpMethod": "PATCH",
"id": "content.accounts.labels.patch",
"request": {
"$ref": "AccountLabel"
},
"response": {
"$ref": "AccountLabel"
},
"parameterOrder": [
"accountId",
"labelId"
],
"description": "Updates a label."
},
"create": {
"scopes": [
"https://www.googleapis.com/auth/content"
],
"parameterOrder": [
"accountId"
],
"path": "accounts/{accountId}/labels",
"httpMethod": "POST",
"id": "content.accounts.labels.create",
"response": {
"$ref": "AccountLabel"
},
"description": "Creates a new label, not assigned to any account.",
"request": {
"$ref": "AccountLabel"
},
"parameters": {
"accountId": {
"type": "string",
"format": "int64",
"description": "Required. The id of the account this label belongs to.",
"required": true,
"location": "path"
}
},
"flatPath": "accounts/{accountId}/labels"
},
"list": {
"httpMethod": "GET",
"description": "Lists the labels assigned to an account.",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"parameters": {
"pageToken": {
"description": "A page token, received from a previous `ListAccountLabels` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccountLabels` must match the call that provided the page token.",
"type": "string",
"location": "query"
},
"pageSize": {
"type": "integer",
"format": "int32",
"description": "The maximum number of labels to return. The service may return fewer than this value. If unspecified, at most 50 labels will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.",
"location": "query"
},
"accountId": {
"format": "int64",
"type": "string",
"required": true,
"location": "path",
"description": "Required. The account id for whose labels are to be listed."
}
},
"path": "accounts/{accountId}/labels",
"parameterOrder": [
"accountId"
],
"response": {
"$ref": "ListAccountLabelsResponse"
},
"flatPath": "accounts/{accountId}/labels",
"id": "content.accounts.labels.list"
},
"delete": {
"id": "content.accounts.labels.delete",
"path": "accounts/{accountId}/labels/{labelId}",
"parameters": {
"accountId": {
"format": "int64",
"type": "string",
"required": true,
"description": "Required. The id of the account that owns the label.",
"location": "path"
},
"labelId": {
"format": "int64",
"required": true,
"location": "path",
"type": "string",
"description": "Required. The id of the label to delete."
}
},
"scopes": [
"https://www.googleapis.com/auth/content"
],
"flatPath": "accounts/{accountId}/labels/{labelId}",
"parameterOrder": [
"accountId",
"labelId"
],
"description": "Deletes a label and removes it from all accounts to which it was assigned.",
"httpMethod": "DELETE"
}
}
},
"credentials": {
"methods": {
"create": {
"parameters": {
"accountId": {
"required": true,
"type": "string",
"location": "path",
"description": "Required. The merchant id of the account these credentials belong to.",
"format": "int64"
}
},
"response": {
"$ref": "AccountCredentials"
},
"flatPath": "accounts/{accountId}/credentials",
"httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"request": {
"$ref": "AccountCredentials"
},
"id": "content.accounts.credentials.create",
"parameterOrder": [
"accountId"
],
"path": "accounts/{accountId}/credentials",
"description": "Uploads credentials for the Merchant Center account. If credentials already exist for this Merchant Center account and purpose, this method updates them."
}
}
}
}
},
"regions": {
"methods": {
"delete": {
"path": "{merchantId}/regions/{regionId}",
"id": "content.regions.delete",
"parameters": {
"regionId": {
"required": true,
"type": "string",
"description": "Required. The id of the region to delete.",
"location": "path"
},
"merchantId": {
"required": true,
"description": "Required. The id of the merchant for which to delete region definition.",
"location": "path",
"format": "int64",
"type": "string"
}
},
"flatPath": "{merchantId}/regions/{regionId}",
"description": "Deletes a region definition from your Merchant Center account.",
"httpMethod": "DELETE",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"parameterOrder": [
"merchantId",
"regionId"
]
},
"create": {
"id": "content.regions.create",
"path": "{merchantId}/regions",
"parameterOrder": [
"merchantId"
],
"response": {
"$ref": "Region"
},
"httpMethod": "POST",
"description": "Creates a region definition in your Merchant Center account.",
"parameters": {
"merchantId": {
"required": true,
"description": "Required. The id of the merchant for which to create region definition.",
"type": "string",
"format": "int64",
"location": "path"
},
"regionId": {
"location": "query",
"type": "string",
"description": "Required. The id of the region to create."
}
},
"flatPath": "{merchantId}/regions",
"request": {
"$ref": "Region"
},
"scopes": [
"https://www.googleapis.com/auth/content"
]
},
"list": {
"httpMethod": "GET",
"flatPath": "{merchantId}/regions",
"id": "content.regions.list",
"response": {
"$ref": "ListRegionsResponse"
},
"parameters": {
"pageToken": {
"description": "A page token, received from a previous `ListRegions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListRegions` must match the call that provided the page token.",
"type": "string",
"location": "query"
},
"merchantId": {
"format": "int64",
"location": "path",
"type": "string",
"required": true,
"description": "Required. The id of the merchant for which to list region definitions."
},
"pageSize": {
"location": "query",
"type": "integer",
"description": "The maximum number of regions to return. The service may return fewer than this value. If unspecified, at most 50 rules will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.",
"format": "int32"
}
},
"description": "Lists the regions in your Merchant Center account.",
"parameterOrder": [
"merchantId"
],
"path": "{merchantId}/regions",
"scopes": [
"https://www.googleapis.com/auth/content"
]
},
"get": {
"description": "Retrieves a region defined in your Merchant Center account.",
"response": {
"$ref": "Region"
},
"parameterOrder": [
"merchantId",
"regionId"
],
"path": "{merchantId}/regions/{regionId}",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"flatPath": "{merchantId}/regions/{regionId}",
"parameters": {
"regionId": {
"type": "string",
"location": "path",
"description": "Required. The id of the region to retrieve.",
"required": true
},
"merchantId": {
"type": "string",
"format": "int64",
"location": "path",
"required": true,
"description": "Required. The id of the merchant for which to retrieve region definition."
}
},
"id": "content.regions.get",
"httpMethod": "GET"
},
"patch": {
"response": {
"$ref": "Region"
},
"request": {
"$ref": "Region"
},
"parameters": {
"regionId": {
"type": "string",
"required": true,
"description": "Required. The id of the region to update.",
"location": "path"
},
"updateMask": {
"location": "query",
"description": "Optional. The field mask indicating the fields to update.",
"format": "google-fieldmask",
"type": "string"
},
"merchantId": {
"description": "Required. The id of the merchant for which to update region definition.",
"format": "int64",
"type": "string",
"required": true,
"location": "path"
}
},
"id": "content.regions.patch",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"httpMethod": "PATCH",
"flatPath": "{merchantId}/regions/{regionId}",
"description": "Updates a region definition in your Merchant Center account.",
"parameterOrder": [
"merchantId",
"regionId"
],
"path": "{merchantId}/regions/{regionId}"
}
}
},
"orderinvoices": {
"methods": {
"createchargeinvoice": {
"flatPath": "{merchantId}/orderinvoices/{orderId}/createChargeInvoice",
"response": {
"$ref": "OrderinvoicesCreateChargeInvoiceResponse"
},
"path": "{merchantId}/orderinvoices/{orderId}/createChargeInvoice",
"id": "content.orderinvoices.createchargeinvoice",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"request": {
"$ref": "OrderinvoicesCreateChargeInvoiceRequest"
},
"parameters": {
"orderId": {
"type": "string",
"description": "The ID of the order.",
"location": "path",
"required": true
},
"merchantId": {
"required": true,
"description": "The ID of the account that manages the order. This cannot be a multi-client account.",
"format": "uint64",
"type": "string",
"location": "path"
}
},
"description": "Creates a charge invoice for a shipment group, and triggers a charge capture for orderinvoice enabled orders.",
"parameterOrder": [
"merchantId",
"orderId"
],
"httpMethod": "POST"
},
"createrefundinvoice": {
"response": {
"$ref": "OrderinvoicesCreateRefundInvoiceResponse"
},
"id": "content.orderinvoices.createrefundinvoice",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"parameters": {
"orderId": {
"type": "string",
"description": "The ID of the order.",
"required": true,
"location": "path"
},
"merchantId": {
"location": "path",
"required": true,
"description": "The ID of the account that manages the order. This cannot be a multi-client account.",
"format": "uint64",
"type": "string"
}
},
"description": "Creates a refund invoice for one or more shipment groups, and triggers a refund for orderinvoice enabled orders. This can only be used for line items that have previously been charged using `createChargeInvoice`. All amounts (except for the summary) are incremental with respect to the previous invoice.",
"request": {
"$ref": "OrderinvoicesCreateRefundInvoiceRequest"
},
"flatPath": "{merchantId}/orderinvoices/{orderId}/createRefundInvoice",
"httpMethod": "POST",
"path": "{merchantId}/orderinvoices/{orderId}/createRefundInvoice",
"parameterOrder": [
"merchantId",
"orderId"
]
}
}
},
"reports": {
"methods": {
"search": {
"parameterOrder": [
"merchantId"
],
"id": "content.reports.search",
"response": {
"$ref": "SearchResponse"
},
"scopes": [
"https://www.googleapis.com/auth/content"
],
"flatPath": "{merchantId}/reports/search",
"httpMethod": "POST",
"parameters": {
"merchantId": {
"description": "Required. Id of the merchant making the call. Must be a standalone account or an MCA subaccount.",
"location": "path",
"type": "string",
"format": "int64",
"required": true
}
},
"request": {
"$ref": "SearchRequest"
},
"description": "Retrieves merchant performance mertrics matching the search query and optionally segmented by selected dimensions.",
"path": "{merchantId}/reports/search"
}
}
},
"collectionstatuses": {
"methods": {
"get": {
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"parameters": {
"collectionId": {
"description": "Required. The collectionId of the collection. CollectionId is the same as the REST ID of the collection.",
"location": "path",
"required": true,
"type": "string"
},
"merchantId": {
"required": true,
"location": "path",
"type": "string",
"description": "Required. The ID of the account that contains the collection. This account cannot be a multi-client account.",
"format": "int64"
}
},
"response": {
"$ref": "CollectionStatus"
},
"flatPath": "{merchantId}/collectionstatuses/{collectionId}",
"id": "content.collectionstatuses.get",
"path": "{merchantId}/collectionstatuses/{collectionId}",
"description": "Gets the status of a collection from your Merchant Center account.",
"parameterOrder": [
"merchantId",
"collectionId"
]
},
"list": {
"parameterOrder": [
"merchantId"
],
"response": {
"$ref": "ListCollectionStatusesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/content"
],
"flatPath": "{merchantId}/collectionstatuses",
"parameters": {
"pageToken": {
"location": "query",
"type": "string",
"description": "Token (if provided) to retrieve the subsequent page. All other parameters must match the original call that provided the page token."
},
"merchantId": {
"required": true,
"location": "path",
"type": "string",
"description": "Required. The ID of the account that contains the collection. This account cannot be a multi-client account.",
"format": "int64"
},
"pageSize": {
"location": "query",
"description": "The maximum number of collection statuses to return in the response, used for paging. Defaults to 50; values above 1000 will be coerced to 1000.",
"format": "int32",
"type": "integer"
}
},
"description": "Lists the statuses of the collections in your Merchant Center account.",
"httpMethod": "GET",
"id": "content.collectionstatuses.list",
"path": "{merchantId}/collectionstatuses"
}
}
},
"pubsubnotificationsettings": {
"methods": {
"get": {
"description": "Retrieves a Merchant Center account's pubsub notification settings.",
"flatPath": "{merchantId}/pubsubnotificationsettings",
"httpMethod": "GET",
"id": "content.pubsubnotificationsettings.get",
"parameters": {
"merchantId": {
"required": true,
"description": "The ID of the account for which to get pubsub notification settings.",
"format": "uint64",
"location": "path",
"type": "string"
}
},
"path": "{merchantId}/pubsubnotificationsettings",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"response": {
"$ref": "PubsubNotificationSettings"
},
"parameterOrder": [
"merchantId"
]
},
"update": {
"flatPath": "{merchantId}/pubsubnotificationsettings",
"response": {
"$ref": "PubsubNotificationSettings"
},
"id": "content.pubsubnotificationsettings.update",
"path": "{merchantId}/pubsubnotificationsettings",
"description": "Register a Merchant Center account for pubsub notifications. Note that cloud topic name should not be provided as part of the request.",
"parameters": {
"merchantId": {
"location": "path",
"description": "The ID of the account.",
"type": "string",
"required": true,
"format": "uint64"
}
},
"scopes": [
"https://www.googleapis.com/auth/content"
],
"httpMethod": "PUT",
"parameterOrder": [
"merchantId"
],
"request": {
"$ref": "PubsubNotificationSettings"
}
}
}
},
"accounttax": {
"methods": {
"update": {
"request": {
"$ref": "AccountTax"
},
"response": {
"$ref": "AccountTax"
},
"path": "{merchantId}/accounttax/{accountId}",
"parameterOrder": [
"merchantId",
"accountId"
],
"parameters": {
"accountId": {
"format": "uint64",
"description": "The ID of the account for which to get/update account tax settings.",
"location": "path",
"required": true,
"type": "string"
},
"merchantId": {
"description": "The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.",
"format": "uint64",
"type": "string",
"required": true,
"location": "path"
}
},
"id": "content.accounttax.update",
"flatPath": "{merchantId}/accounttax/{accountId}",
"httpMethod": "PUT",
"description": "Updates the tax settings of the account. Any fields that are not provided are deleted from the resource.",
"scopes": [
"https://www.googleapis.com/auth/content"
]
},
"custombatch": {
"path": "accounttax/batch",
"httpMethod": "POST",
"flatPath": "accounttax/batch",
"description": "Retrieves and updates tax settings of multiple accounts in a single request.",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"id": "content.accounttax.custombatch",
"request": {
"$ref": "AccounttaxCustomBatchRequest"
},
"response": {
"$ref": "AccounttaxCustomBatchResponse"
},
"parameters": {},
"parameterOrder": []
},
"get": {
"flatPath": "{merchantId}/accounttax/{accountId}",
"description": "Retrieves the tax settings of the account.",
"response": {
"$ref": "AccountTax"
},
"path": "{merchantId}/accounttax/{accountId}",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"parameterOrder": [
"merchantId",
"accountId"
],
"id": "content.accounttax.get",
"parameters": {
"merchantId": {
"location": "path",
"required": true,
"description": "The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.",
"format": "uint64",
"type": "string"
},
"accountId": {
"format": "uint64",
"description": "The ID of the account for which to get/update account tax settings.",
"required": true,
"type": "string",
"location": "path"
}
},
"httpMethod": "GET"
},
"list": {
"description": "Lists the tax settings of the sub-accounts in your Merchant Center account.",
"parameterOrder": [
"merchantId"
],
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"path": "{merchantId}/accounttax",
"flatPath": "{merchantId}/accounttax",
"parameters": {
"maxResults": {
"description": "The maximum number of tax settings to return in the response, used for paging.",
"type": "integer",
"format": "uint32",
"location": "query"
},
"merchantId": {
"description": "The ID of the managing account. This must be a multi-client account.",
"type": "string",
"required": true,
"location": "path",
"format": "uint64"
},
"pageToken": {
"location": "query",
"description": "The token returned by the previous request.",
"type": "string"
}
},
"response": {
"$ref": "AccounttaxListResponse"
},
"id": "content.accounttax.list"
}
}
},
"buyongoogleprograms": {
"methods": {
"onboard": {
"id": "content.buyongoogleprograms.onboard",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"path": "{merchantId}/buyongoogleprograms/{regionCode}/onboard",
"parameters": {
"merchantId": {
"description": "Required. The ID of the account.",
"type": "string",
"location": "path",
"format": "int64",
"required": true
},
"regionCode": {
"description": "The program region code [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). Currently only US is available.",
"type": "string",
"required": true,
"location": "path"
}
},
"flatPath": "{merchantId}/buyongoogleprograms/{regionCode}/onboard",
"httpMethod": "POST",
"request": {
"$ref": "OnboardBuyOnGoogleProgramRequest"
},
"description": "Onboards BoG in your Merchant Center account. By using this method, you agree to the [Terms of Service](https://merchants.google.com/mc/termsofservice/transactions/US/latest). Calling this method is only possible if the authenticated account is the same as the merchant id in the request. Calling this method multiple times will only accept Terms of Service if the latest version is not currently signed.",
"parameterOrder": [
"merchantId",
"regionCode"
]
},
"get": {
"parameters": {
"regionCode": {
"required": true,
"description": "The Program region code [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). Currently only US is available.",
"location": "path",
"type": "string"
},
"merchantId": {
"location": "path",
"format": "int64",
"description": "Required. The ID of the account.",
"type": "string",
"required": true
}
},
"id": "content.buyongoogleprograms.get",
"description": "Retrieves a status of BoG program for your Merchant Center account.",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"parameterOrder": [
"merchantId",
"regionCode"
],
"flatPath": "{merchantId}/buyongoogleprograms/{regionCode}",
"response": {
"$ref": "BuyOnGoogleProgramStatus"
},
"path": "{merchantId}/buyongoogleprograms/{regionCode}",
"httpMethod": "GET"
}
}
},
"liasettings": {
"methods": {
"listposdataproviders": {
"description": "Retrieves the list of POS data providers that have active settings for the all eiligible countries.",
"id": "content.liasettings.listposdataproviders",
"parameterOrder": [],
"httpMethod": "GET",
"flatPath": "liasettings/posdataproviders",
"parameters": {},
"scopes": [
"https://www.googleapis.com/auth/content"
],
"path": "liasettings/posdataproviders",
"response": {
"$ref": "LiasettingsListPosDataProvidersResponse"
}
},
"get": {
"description": "Retrieves the LIA settings of the account.",
"id": "content.liasettings.get",
"parameterOrder": [
"merchantId",
"accountId"
],
"path": "{merchantId}/liasettings/{accountId}",
"flatPath": "{merchantId}/liasettings/{accountId}",
"httpMethod": "GET",
"parameters": {
"merchantId": {
"required": true,
"type": "string",
"format": "uint64",
"description": "The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.",
"location": "path"
},
"accountId": {
"format": "uint64",
"required": true,
"description": "The ID of the account for which to get or update LIA settings.",
"location": "path",
"type": "string"
}
},
"response": {
"$ref": "LiaSettings"
},
"scopes": [
"https://www.googleapis.com/auth/content"
]
},
"requestinventoryverification": {
"path": "{merchantId}/liasettings/{accountId}/requestinventoryverification/{country}",
"parameterOrder": [
"merchantId",
"accountId",
"country"
],
"scopes": [
"https://www.googleapis.com/auth/content"
],
"response": {
"$ref": "LiasettingsRequestInventoryVerificationResponse"
},
"httpMethod": "POST",
"flatPath": "{merchantId}/liasettings/{accountId}/requestinventoryverification/{country}",
"parameters": {
"merchantId": {
"format": "uint64",
"description": "The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.",
"required": true,
"type": "string",
"location": "path"
},
"country": {
"description": "The country for which inventory validation is requested.",
"location": "path",
"type": "string",
"required": true
},
"accountId": {
"type": "string",
"description": "The ID of the account that manages the order. This cannot be a multi-client account.",
"required": true,
"location": "path",
"format": "uint64"
}
},
"id": "content.liasettings.requestinventoryverification",
"description": "Requests inventory validation for the specified country."
},
"setposdataprovider": {
"response": {
"$ref": "LiasettingsSetPosDataProviderResponse"
},
"parameters": {
"merchantId": {
"required": true,
"type": "string",
"location": "path",
"description": "The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.",
"format": "uint64"
},
"accountId": {
"required": true,
"description": "The ID of the account for which to retrieve accessible Google My Business accounts.",
"format": "uint64",
"type": "string",
"location": "path"
},
"posExternalAccountId": {
"type": "string",
"description": "The account ID by which this merchant is known to the POS data provider.",
"location": "query"
},
"posDataProviderId": {
"format": "uint64",
"location": "query",
"type": "string",
"description": "The ID of POS data provider."
},
"country": {
"description": "The country for which the POS data provider is selected.",
"type": "string",
"location": "query",
"required": true
}
},
"path": "{merchantId}/liasettings/{accountId}/setposdataprovider",
"flatPath": "{merchantId}/liasettings/{accountId}/setposdataprovider",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"parameterOrder": [
"merchantId",
"accountId",
"country"
],
"id": "content.liasettings.setposdataprovider",
"description": "Sets the POS data provider for the specified country.",
"httpMethod": "POST"
},
"setinventoryverificationcontact": {
"flatPath": "{merchantId}/liasettings/{accountId}/setinventoryverificationcontact",
"description": "Sets the inventory verification contract for the specified country.",
"response": {
"$ref": "LiasettingsSetInventoryVerificationContactResponse"
},
"parameterOrder": [
"merchantId",
"accountId",
"country",
"language",
"contactName",
"contactEmail"
],
"path": "{merchantId}/liasettings/{accountId}/setinventoryverificationcontact",
"httpMethod": "POST",
"id": "content.liasettings.setinventoryverificationcontact",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"parameters": {
"merchantId": {
"description": "The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.",
"required": true,
"location": "path",
"type": "string",
"format": "uint64"
},
"accountId": {
"location": "path",
"type": "string",
"description": "The ID of the account that manages the order. This cannot be a multi-client account.",
"required": true,
"format": "uint64"
},
"country": {
"location": "query",
"required": true,
"type": "string",
"description": "The country for which inventory verification is requested."
},
"contactName": {
"type": "string",
"description": "The name of the inventory verification contact.",
"required": true,
"location": "query"
},
"language": {
"description": "The language for which inventory verification is requested.",
"type": "string",
"required": true,
"location": "query"
},
"contactEmail": {
"location": "query",
"required": true,
"type": "string",
"description": "The email of the inventory verification contact."
}
}
},
"getaccessiblegmbaccounts": {
"parameterOrder": [
"merchantId",
"accountId"
],
"flatPath": "{merchantId}/liasettings/{accountId}/accessiblegmbaccounts",
"path": "{merchantId}/liasettings/{accountId}/accessiblegmbaccounts",
"id": "content.liasettings.getaccessiblegmbaccounts",
"description": "Retrieves the list of accessible Google My Business accounts.",
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"parameters": {
"accountId": {
"required": true,
"format": "uint64",
"type": "string",
"location": "path",
"description": "The ID of the account for which to retrieve accessible Google My Business accounts."
},
"merchantId": {
"location": "path",
"description": "The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.",
"format": "uint64",
"required": true,
"type": "string"
}
},
"response": {
"$ref": "LiasettingsGetAccessibleGmbAccountsResponse"
}
},
"list": {
"path": "{merchantId}/liasettings",
"description": "Lists the LIA settings of the sub-accounts in your Merchant Center account.",
"flatPath": "{merchantId}/liasettings",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"parameterOrder": [
"merchantId"
],
"response": {
"$ref": "LiasettingsListResponse"
},
"id": "content.liasettings.list",
"parameters": {
"pageToken": {
"type": "string",
"location": "query",
"description": "The token returned by the previous request."
},
"merchantId": {
"required": true,
"description": "The ID of the managing account. This must be a multi-client account.",
"location": "path",
"type": "string",
"format": "uint64"
},
"maxResults": {
"location": "query",
"type": "integer",
"format": "uint32",
"description": "The maximum number of LIA settings to return in the response, used for paging."
}
},
"httpMethod": "GET"
},
"update": {
"parameterOrder": [
"merchantId",
"accountId"
],
"id": "content.liasettings.update",
"response": {
"$ref": "LiaSettings"
},
"description": "Updates the LIA settings of the account. Any fields that are not provided are deleted from the resource.",
"flatPath": "{merchantId}/liasettings/{accountId}",
"request": {
"$ref": "LiaSettings"
},
"scopes": [
"https://www.googleapis.com/auth/content"
],
"path": "{merchantId}/liasettings/{accountId}",
"httpMethod": "PUT",
"parameters": {
"accountId": {
"type": "string",
"format": "uint64",
"required": true,
"location": "path",
"description": "The ID of the account for which to get or update LIA settings."
},
"merchantId": {
"description": "The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.",
"format": "uint64",
"location": "path",
"type": "string",
"required": true
}
}
},
"custombatch": {
"path": "liasettings/batch",
"httpMethod": "POST",
"parameters": {},
"request": {
"$ref": "LiasettingsCustomBatchRequest"
},
"flatPath": "liasettings/batch",
"description": "Retrieves and/or updates the LIA settings of multiple accounts in a single request.",
"response": {
"$ref": "LiasettingsCustomBatchResponse"
},
"id": "content.liasettings.custombatch",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"parameterOrder": []
},
"requestgmbaccess": {
"flatPath": "{merchantId}/liasettings/{accountId}/requestgmbaccess",
"response": {
"$ref": "LiasettingsRequestGmbAccessResponse"
},
"httpMethod": "POST",
"id": "content.liasettings.requestgmbaccess",
"parameters": {
"gmbEmail": {
"required": true,
"description": "The email of the Google My Business account.",
"type": "string",
"location": "query"
},
"accountId": {
"required": true,
"location": "path",
"description": "The ID of the account for which GMB access is requested.",
"format": "uint64",
"type": "string"
},
"merchantId": {
"location": "path",
"description": "The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.",
"required": true,
"type": "string",
"format": "uint64"
}
},
"path": "{merchantId}/liasettings/{accountId}/requestgmbaccess",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"parameterOrder": [
"merchantId",
"accountId",
"gmbEmail"
],
"description": "Requests access to a specified Google My Business account."
}
}
},
"ordertrackingsignals": {
"methods": {
"create": {
"parameters": {
"merchantId": {
"type": "string",
"description": "The ID of the merchant for which the order signal is created.",
"required": true,
"location": "path",
"format": "int64"
}
},
"flatPath": "{merchantId}/ordertrackingsignals",
"parameterOrder": [
"merchantId"
],
"request": {
"$ref": "OrderTrackingSignal"
},
"response": {
"$ref": "OrderTrackingSignal"
},
"httpMethod": "POST",
"path": "{merchantId}/ordertrackingsignals",
"description": "Creates new order tracking signal.",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"id": "content.ordertrackingsignals.create"
}
}
},
"csses": {
"methods": {
"updatelabels": {
"description": "Updates labels that are assigned to a CSS domain by its CSS group.",
"parameterOrder": [
"cssGroupId",
"cssDomainId"
],
"scopes": [
"https://www.googleapis.com/auth/content"
],
"response": {
"$ref": "Css"
},
"httpMethod": "POST",
"parameters": {
"cssGroupId": {
"type": "string",
"description": "Required. The CSS group ID of the updated CSS domain.",
"required": true,
"format": "int64",
"location": "path"
},
"cssDomainId": {
"required": true,
"description": "Required. The ID of the updated CSS domain.",
"format": "int64",
"location": "path",
"type": "string"
}
},
"flatPath": "{cssGroupId}/csses/{cssDomainId}/updatelabels",
"id": "content.csses.updatelabels",
"request": {
"$ref": "LabelIds"
},
"path": "{cssGroupId}/csses/{cssDomainId}/updatelabels"
},
"get": {
"response": {
"$ref": "Css"
},
"scopes": [
"https://www.googleapis.com/auth/content"
],
"id": "content.csses.get",
"path": "{cssGroupId}/csses/{cssDomainId}",
"parameterOrder": [
"cssGroupId",
"cssDomainId"
],
"parameters": {
"cssGroupId": {
"location": "path",
"description": "Required. The ID of the managing account. If this parameter is not the same as [cssDomainId](#cssDomainId), then this ID must be a CSS group ID and `cssDomainId` must be the ID of a CSS domain affiliated with this group.",
"required": true,
"type": "string",
"format": "int64"
},
"cssDomainId": {
"location": "path",
"type": "string",
"required": true,
"description": "Required. The ID of the CSS domain to return.",
"format": "int64"
}
},
"flatPath": "{cssGroupId}/csses/{cssDomainId}",
"description": "Retrieves a single CSS domain by ID.",
"httpMethod": "GET"
},
"list": {
"parameterOrder": [
"cssGroupId"
],
"description": "Lists CSS domains affiliated with a CSS group.",
"flatPath": "{cssGroupId}/csses",
"path": "{cssGroupId}/csses",
"id": "content.csses.list",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"parameters": {
"pageToken": {
"type": "string",
"description": "A page token, received from a previous `ListCsses` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCsses` must match the call that provided the page token.",
"location": "query"
},
"cssGroupId": {
"description": "Required. The CSS group ID of CSS domains to be listed.",
"type": "string",
"format": "int64",
"required": true,
"location": "path"
},
"pageSize": {
"format": "int32",
"description": "The maximum number of CSS domains to return. The service may return fewer than this value. If unspecified, at most 50 CSS domains will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.",
"location": "query",
"type": "integer"
}
},
"response": {
"$ref": "ListCssesResponse"
},
"httpMethod": "GET"
}
}
},
"pos": {
"methods": {
"get": {
"flatPath": "{merchantId}/pos/{targetMerchantId}/store/{storeCode}",
"parameters": {
"storeCode": {
"description": "A store code that is unique per merchant.",
"required": true,
"type": "string",
"location": "path"
},
"targetMerchantId": {
"location": "path",
"type": "string",
"format": "uint64",
"description": "The ID of the target merchant.",
"required": true
},
"merchantId": {
"type": "string",
"location": "path",
"format": "uint64",
"required": true,
"description": "The ID of the POS or inventory data provider."
}
},
"id": "content.pos.get",
"response": {
"$ref": "PosStore"
},
"parameterOrder": [
"merchantId",
"targetMerchantId",
"storeCode"
],
"path": "{merchantId}/pos/{targetMerchantId}/store/{storeCode}",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"httpMethod": "GET",
"description": "Retrieves information about the given store."
},
"custombatch": {
"httpMethod": "POST",
"description": "Batches multiple POS-related calls in a single request.",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"response": {
"$ref": "PosCustomBatchResponse"
},
"parameters": {},
"parameterOrder": [],
"flatPath": "pos/batch",
"path": "pos/batch",
"id": "content.pos.custombatch",
"request": {
"$ref": "PosCustomBatchRequest"
}
},
"sale": {
"flatPath": "{merchantId}/pos/{targetMerchantId}/sale",
"parameterOrder": [
"merchantId",
"targetMerchantId"
],
"id": "content.pos.sale",
"response": {
"$ref": "PosSaleResponse"
},
"request": {
"$ref": "PosSaleRequest"
},
"scopes": [
"https://www.googleapis.com/auth/content"
],
"httpMethod": "POST",
"parameters": {
"targetMerchantId": {
"type": "string",
"location": "path",
"description": "The ID of the target merchant.",
"format": "uint64",
"required": true
},
"merchantId": {
"type": "string",
"location": "path",
"description": "The ID of the POS or inventory data provider.",
"format": "uint64",
"required": true
}
},
"path": "{merchantId}/pos/{targetMerchantId}/sale",
"description": "Submit a sale event for the given merchant."
},
"delete": {
"parameters": {
"merchantId": {
"type": "string",
"format": "uint64",
"description": "The ID of the POS or inventory data provider.",
"location": "path",
"required": true
},
"targetMerchantId": {
"location": "path",
"description": "The ID of the target merchant.",
"required": true,
"format": "uint64",
"type": "string"
},
"storeCode": {
"required": true,
"description": "A store code that is unique per merchant.",
"location": "path",
"type": "string"
}
},
"path": "{merchantId}/pos/{targetMerchantId}/store/{storeCode}",
"id": "content.pos.delete",
"flatPath": "{merchantId}/pos/{targetMerchantId}/store/{storeCode}",
"parameterOrder": [
"merchantId",
"targetMerchantId",
"storeCode"
],
"scopes": [
"https://www.googleapis.com/auth/content"
],
"description": "Deletes a store for the given merchant.",
"httpMethod": "DELETE"
},
"list": {
"scopes": [
"https://www.googleapis.com/auth/content"
],
"flatPath": "{merchantId}/pos/{targetMerchantId}/store",
"httpMethod": "GET",
"path": "{merchantId}/pos/{targetMerchantId}/store",
"parameterOrder": [
"merchantId",
"targetMerchantId"
],
"response": {
"$ref": "PosListResponse"
},
"id": "content.pos.list",
"description": "Lists the stores of the target merchant.",
"parameters": {
"targetMerchantId": {
"format": "uint64",
"location": "path",
"type": "string",
"required": true,
"description": "The ID of the target merchant."
},
"merchantId": {
"description": "The ID of the POS or inventory data provider.",
"location": "path",
"format": "uint64",
"required": true,
"type": "string"
}
}
},
"insert": {
"flatPath": "{merchantId}/pos/{targetMerchantId}/store",
"id": "content.pos.insert",
"path": "{merchantId}/pos/{targetMerchantId}/store",
"request": {
"$ref": "PosStore"
},
"scopes": [
"https://www.googleapis.com/auth/content"
],
"description": "Creates a store for the given merchant.",
"response": {
"$ref": "PosStore"
},
"parameterOrder": [
"merchantId",
"targetMerchantId"
],
"httpMethod": "POST",
"parameters": {
"targetMerchantId": {
"description": "The ID of the target merchant.",
"required": true,
"type": "string",
"location": "path",
"format": "uint64"
},
"merchantId": {
"location": "path",
"description": "The ID of the POS or inventory data provider.",
"required": true,
"type": "string",
"format": "uint64"
}
}
},
"inventory": {
"path": "{merchantId}/pos/{targetMerchantId}/inventory",
"httpMethod": "POST",
"id": "content.pos.inventory",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"parameterOrder": [
"merchantId",
"targetMerchantId"
],
"response": {
"$ref": "PosInventoryResponse"
},
"parameters": {
"merchantId": {
"required": true,
"description": "The ID of the POS or inventory data provider.",
"location": "path",
"type": "string",
"format": "uint64"
},
"targetMerchantId": {
"format": "uint64",
"description": "The ID of the target merchant.",
"required": true,
"type": "string",
"location": "path"
}
},
"request": {
"$ref": "PosInventoryRequest"
},
"flatPath": "{merchantId}/pos/{targetMerchantId}/inventory",
"description": "Submit inventory for the given merchant."
}
}
},
"returnaddress": {
"methods": {
"insert": {
"description": "Inserts a return address for the Merchant Center account.",
"request": {
"$ref": "ReturnAddress"
},
"parameters": {
"merchantId": {
"format": "uint64",
"location": "path",
"description": "The Merchant Center account to insert a return address for.",
"required": true,
"type": "string"
}
},
"httpMethod": "POST",
"parameterOrder": [
"merchantId"
],
"path": "{merchantId}/returnaddress",
"flatPath": "{merchantId}/returnaddress",
"response": {
"$ref": "ReturnAddress"
},
"scopes": [
"https://www.googleapis.com/auth/content"
],
"id": "content.returnaddress.insert"
},
"delete": {
"flatPath": "{merchantId}/returnaddress/{returnAddressId}",
"path": "{merchantId}/returnaddress/{returnAddressId}",
"description": "Deletes a return address for the given Merchant Center account.",
"httpMethod": "DELETE",
"id": "content.returnaddress.delete",
"parameters": {
"returnAddressId": {
"required": true,
"type": "string",
"description": "Return address ID generated by Google.",
"location": "path"
},
"merchantId": {
"format": "uint64",
"type": "string",
"description": "The Merchant Center account from which to delete the given return address.",
"location": "path",
"required": true
}
},
"scopes": [
"https://www.googleapis.com/auth/content"
],
"parameterOrder": [
"merchantId",
"returnAddressId"
]
},
"list": {
"id": "content.returnaddress.list",
"path": "{merchantId}/returnaddress",
"flatPath": "{merchantId}/returnaddress",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"parameters": {
"country": {
"description": "List only return addresses applicable to the given country of sale. When omitted, all return addresses are listed.",
"type": "string",
"location": "query"
},
"maxResults": {
"format": "uint32",
"location": "query",
"description": "The maximum number of addresses in the response, used for paging.",
"type": "integer"
},
"merchantId": {
"format": "uint64",
"type": "string",
"description": "The Merchant Center account to list return addresses for.",
"location": "path",
"required": true
},
"pageToken": {
"description": "The token returned by the previous request.",
"location": "query",
"type": "string"
}
},
"description": "Lists the return addresses of the Merchant Center account.",
"response": {
"$ref": "ReturnaddressListResponse"
},
"httpMethod": "GET",
"parameterOrder": [
"merchantId"
]
},
"custombatch": {
"parameterOrder": [],
"flatPath": "returnaddress/batch",
"id": "content.returnaddress.custombatch",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"description": "Batches multiple return address related calls in a single request.",
"path": "returnaddress/batch",
"response": {
"$ref": "ReturnaddressCustomBatchResponse"
},
"request": {
"$ref": "ReturnaddressCustomBatchRequest"
},
"httpMethod": "POST",
"parameters": {}
},
"get": {
"flatPath": "{merchantId}/returnaddress/{returnAddressId}",
"parameters": {
"merchantId": {
"format": "uint64",
"location": "path",
"description": "The Merchant Center account to get a return address for.",
"required": true,
"type": "string"
},
"returnAddressId": {
"description": "Return address ID generated by Google.",
"type": "string",
"required": true,
"location": "path"
}
},
"description": "Gets a return address of the Merchant Center account.",
"response": {
"$ref": "ReturnAddress"
},
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"id": "content.returnaddress.get",
"path": "{merchantId}/returnaddress/{returnAddressId}",
"parameterOrder": [
"merchantId",
"returnAddressId"
]
}
}
},
"orderreports": {
"methods": {
"listdisbursements": {
"response": {
"$ref": "OrderreportsListDisbursementsResponse"
},
"path": "{merchantId}/orderreports/disbursements",
"description": "Retrieves a report for disbursements from your Merchant Center account.",
"parameters": {
"pageToken": {
"type": "string",
"location": "query",
"description": "The token returned by the previous request."
},
"maxResults": {
"type": "integer",
"description": "The maximum number of disbursements to return in the response, used for paging.",
"format": "uint32",
"location": "query"
},
"merchantId": {
"type": "string",
"required": true,
"format": "uint64",
"description": "The ID of the account that manages the order. This cannot be a multi-client account.",
"location": "path"
},
"disbursementStartDate": {
"type": "string",
"description": "The first date which disbursements occurred. In ISO 8601 format.",
"location": "query"
},
"disbursementEndDate": {
"location": "query",
"type": "string",
"description": "The last date which disbursements occurred. In ISO 8601 format. Default: current date."
}
},
"scopes": [
"https://www.googleapis.com/auth/content"
],
"httpMethod": "GET",
"flatPath": "{merchantId}/orderreports/disbursements",
"parameterOrder": [
"merchantId"
],
"id": "content.orderreports.listdisbursements"
},
"listtransactions": {
"id": "content.orderreports.listtransactions",
"response": {
"$ref": "OrderreportsListTransactionsResponse"
},
"flatPath": "{merchantId}/orderreports/disbursements/{disbursementId}/transactions",
"parameters": {
"pageToken": {
"description": "The token returned by the previous request.",
"location": "query",
"type": "string"
},
"transactionEndDate": {
"description": "The last date in which transaction occurred. In ISO 8601 format. Default: current date.",
"location": "query",
"type": "string"
},
"transactionStartDate": {
"description": "The first date in which transaction occurred. In ISO 8601 format.",
"location": "query",
"type": "string"
},
"maxResults": {
"location": "query",
"format": "uint32",
"type": "integer",
"description": "The maximum number of disbursements to return in the response, used for paging."
},
"disbursementId": {
"location": "path",
"type": "string",
"required": true,
"description": "The Google-provided ID of the disbursement (found in Wallet)."
},
"merchantId": {
"location": "path",
"type": "string",
"format": "uint64",
"description": "The ID of the account that manages the order. This cannot be a multi-client account.",
"required": true
}
},
"httpMethod": "GET",
"description": "Retrieves a list of transactions for a disbursement from your Merchant Center account.",
"path": "{merchantId}/orderreports/disbursements/{disbursementId}/transactions",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"parameterOrder": [
"merchantId",
"disbursementId"
]
}
}
},
"orders": {
"methods": {
"instorerefundlineitem": {
"request": {
"$ref": "OrdersInStoreRefundLineItemRequest"
},
"id": "content.orders.instorerefundlineitem",
"description": "Deprecated. Notifies that item return and refund was handled directly by merchant outside of Google payments processing (e.g. cash refund done in store). Note: We recommend calling the returnrefundlineitem method to refund in-store returns. We will issue the refund directly to the customer. This helps to prevent possible differences arising between merchant and Google transaction records. We also recommend having the point of sale system communicate with Google to ensure that customers do not receive a double refund by first refunding via Google then via an in-store return.",
"response": {
"$ref": "OrdersInStoreRefundLineItemResponse"
},
"parameterOrder": [
"merchantId",
"orderId"
],
"httpMethod": "POST",
"path": "{merchantId}/orders/{orderId}/inStoreRefundLineItem",
"parameters": {
"orderId": {
"required": true,
"description": "The ID of the order.",
"type": "string",
"location": "path"
},
"merchantId": {
"description": "The ID of the account that manages the order. This cannot be a multi-client account.",
"format": "uint64",
"location": "path",
"type": "string",
"required": true
}
},
"scopes": [
"https://www.googleapis.com/auth/content"
],
"flatPath": "{merchantId}/orders/{orderId}/inStoreRefundLineItem"
},
"createtestreturn": {
"parameters": {
"merchantId": {
"location": "path",
"format": "uint64",
"description": "The ID of the account that manages the order. This cannot be a multi-client account.",
"required": true,
"type": "string"
},
"orderId": {
"description": "The ID of the order.",
"type": "string",
"required": true,
"location": "path"
}
},
"httpMethod": "POST",
"request": {
"$ref": "OrdersCreateTestReturnRequest"
},
"flatPath": "{merchantId}/orders/{orderId}/testreturn",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"parameterOrder": [
"merchantId",
"orderId"
],
"response": {
"$ref": "OrdersCreateTestReturnResponse"
},
"description": "Sandbox only. Creates a test return.",
"id": "content.orders.createtestreturn",
"path": "{merchantId}/orders/{orderId}/testreturn"
},
"advancetestorder": {
"parameterOrder": [
"merchantId",
"orderId"
],
"path": "{merchantId}/testorders/{orderId}/advance",
"parameters": {
"orderId": {
"description": "The ID of the test order to modify.",
"type": "string",
"required": true,
"location": "path"
},
"merchantId": {
"required": true,
"type": "string",
"format": "uint64",
"description": "The ID of the account that manages the order. This cannot be a multi-client account.",
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/content"
],
"flatPath": "{merchantId}/testorders/{orderId}/advance",
"response": {
"$ref": "OrdersAdvanceTestOrderResponse"
},
"id": "content.orders.advancetestorder",
"httpMethod": "POST",
"description": "Sandbox only. Moves a test order from state \"`inProgress`\" to state \"`pendingShipment`\"."
},
"gettestordertemplate": {
"flatPath": "{merchantId}/testordertemplates/{templateName}",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"parameterOrder": [
"merchantId",
"templateName"
],
"response": {
"$ref": "OrdersGetTestOrderTemplateResponse"
},
"parameters": {
"country": {
"type": "string",
"description": "The country of the template to retrieve. Defaults to `US`.",
"location": "query"
},
"templateName": {
"type": "string",
"location": "path",
"enumDescriptions": [
"",
"",
"",
"",
"",
""
],
"enum": [
"TEMPLATE1",
"TEMPLATE2",
"TEMPLATE1A",
"TEMPLATE1B",
"TEMPLATE3",
"TEMPLATE4"
],
"required": true,
"description": "The name of the template to retrieve."
},
"merchantId": {
"type": "string",
"location": "path",
"format": "uint64",
"required": true,
"description": "The ID of the account that should manage the order. This cannot be a multi-client account."
}
},
"path": "{merchantId}/testordertemplates/{templateName}",
"description": "Sandbox only. Retrieves an order template that can be used to quickly create a new order in sandbox.",
"id": "content.orders.gettestordertemplate",
"httpMethod": "GET"
},
"refundorder": {
"parameters": {
"orderId": {
"type": "string",
"required": true,
"location": "path",
"description": "The ID of the order to refund."
},
"merchantId": {
"type": "string",
"location": "path",
"format": "uint64",
"required": true,
"description": "The ID of the account that manages the order. This cannot be a multi-client account."
}
},
"flatPath": "{merchantId}/orders/{orderId}/refundorder",
"id": "content.orders.refundorder",
"description": "Issues a partial or total refund for an order.",
"parameterOrder": [
"merchantId",
"orderId"
],
"scopes": [
"https://www.googleapis.com/auth/content"
],
"request": {
"$ref": "OrdersRefundOrderRequest"
},
"httpMethod": "POST",
"response": {
"$ref": "OrdersRefundOrderResponse"
},
"path": "{merchantId}/orders/{orderId}/refundorder"
},
"returnrefundlineitem": {
"parameterOrder": [
"merchantId",
"orderId"
],
"request": {
"$ref": "OrdersReturnRefundLineItemRequest"
},
"scopes": [
"https://www.googleapis.com/auth/content"
],
"path": "{merchantId}/orders/{orderId}/returnRefundLineItem",
"id": "content.orders.returnrefundlineitem",
"httpMethod": "POST",
"response": {
"$ref": "OrdersReturnRefundLineItemResponse"
},
"parameters": {
"merchantId": {
"location": "path",
"format": "uint64",
"type": "string",
"description": "The ID of the account that manages the order. This cannot be a multi-client account.",
"required": true
},
"orderId": {
"location": "path",
"required": true,
"type": "string",
"description": "The ID of the order."
}
},
"flatPath": "{merchantId}/orders/{orderId}/returnRefundLineItem",
"description": "Returns and refunds a line item. Note that this method can only be called on fully shipped orders. Please also note that the Orderreturns API is the preferred way to handle returns after you receive a return from a customer. You can use Orderreturns.list or Orderreturns.get to search for the return, and then use Orderreturns.processreturn to issue the refund. If the return cannot be found, then we recommend using this API to issue a refund."
},
"updatemerchantorderid": {
"httpMethod": "POST",
"parameterOrder": [
"merchantId",
"orderId"
],
"id": "content.orders.updatemerchantorderid",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"parameters": {
"merchantId": {
"required": true,
"type": "string",
"location": "path",
"format": "uint64",
"description": "The ID of the account that manages the order. This cannot be a multi-client account."
},
"orderId": {
"type": "string",
"location": "path",
"description": "The ID of the order.",
"required": true
}
},
"response": {
"$ref": "OrdersUpdateMerchantOrderIdResponse"
},
"flatPath": "{merchantId}/orders/{orderId}/updateMerchantOrderId",
"path": "{merchantId}/orders/{orderId}/updateMerchantOrderId",
"request": {
"$ref": "OrdersUpdateMerchantOrderIdRequest"
},
"description": "Updates the merchant order ID for a given order."
},
"updatelineitemshippingdetails": {
"parameterOrder": [
"merchantId",
"orderId"
],
"flatPath": "{merchantId}/orders/{orderId}/updateLineItemShippingDetails",
"id": "content.orders.updatelineitemshippingdetails",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"path": "{merchantId}/orders/{orderId}/updateLineItemShippingDetails",
"request": {
"$ref": "OrdersUpdateLineItemShippingDetailsRequest"
},
"parameters": {
"orderId": {
"description": "The ID of the order.",
"required": true,
"type": "string",
"location": "path"
},
"merchantId": {
"format": "uint64",
"location": "path",
"description": "The ID of the account that manages the order. This cannot be a multi-client account.",
"required": true,
"type": "string"
}
},
"httpMethod": "POST",
"description": "Updates ship by and delivery by dates for a line item.",
"response": {
"$ref": "OrdersUpdateLineItemShippingDetailsResponse"
}
},
"acknowledge": {
"flatPath": "{merchantId}/orders/{orderId}/acknowledge",
"id": "content.orders.acknowledge",
"response": {
"$ref": "OrdersAcknowledgeResponse"
},
"httpMethod": "POST",
"description": "Marks an order as acknowledged.",
"path": "{merchantId}/orders/{orderId}/acknowledge",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"parameterOrder": [
"merchantId",
"orderId"
],
"parameters": {
"orderId": {
"location": "path",
"type": "string",
"required": true,
"description": "The ID of the order."
},
"merchantId": {
"description": "The ID of the account that manages the order. This cannot be a multi-client account.",
"type": "string",
"location": "path",
"required": true,
"format": "uint64"
}
},
"request": {
"$ref": "OrdersAcknowledgeRequest"
}
},
"cancel": {
"flatPath": "{merchantId}/orders/{orderId}/cancel",
"path": "{merchantId}/orders/{orderId}/cancel",
"description": "Cancels all line items in an order, making a full refund.",
"parameterOrder": [
"merchantId",
"orderId"
],
"response": {
"$ref": "OrdersCancelResponse"
},
"request": {
"$ref": "OrdersCancelRequest"
},
"parameters": {
"merchantId": {
"location": "path",
"type": "string",
"required": true,
"format": "uint64",
"description": "The ID of the account that manages the order. This cannot be a multi-client account."
},
"orderId": {
"required": true,
"location": "path",
"description": "The ID of the order to cancel.",
"type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/content"
],
"id": "content.orders.cancel",
"httpMethod": "POST"
},
"updateshipment": {
"path": "{merchantId}/orders/{orderId}/updateShipment",
"httpMethod": "POST",
"response": {
"$ref": "OrdersUpdateShipmentResponse"
},
"request": {
"$ref": "OrdersUpdateShipmentRequest"
},
"parameters": {
"merchantId": {
"format": "uint64",
"required": true,
"location": "path",
"description": "The ID of the account that manages the order. This cannot be a multi-client account.",
"type": "string"
},
"orderId": {
"location": "path",
"required": true,
"description": "The ID of the order.",
"type": "string"
}
},
"parameterOrder": [
"merchantId",
"orderId"
],
"description": "Updates a shipment's status, carrier, and/or tracking ID.",
"id": "content.orders.updateshipment",
"flatPath": "{merchantId}/orders/{orderId}/updateShipment",
"scopes": [
"https://www.googleapis.com/auth/content"
]
},
"createtestorder": {
"flatPath": "{merchantId}/testorders",
"request": {
"$ref": "OrdersCreateTestOrderRequest"
},
"httpMethod": "POST",
"description": "Sandbox only. Creates a test order.",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"parameterOrder": [
"merchantId"
],
"id": "content.orders.createtestorder",
"path": "{merchantId}/testorders",
"parameters": {
"merchantId": {
"description": "The ID of the account that should manage the order. This cannot be a multi-client account.",
"required": true,
"location": "path",
"type": "string",
"format": "uint64"
}
},
"response": {
"$ref": "OrdersCreateTestOrderResponse"
}
},
"refunditem": {
"id": "content.orders.refunditem",
"httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"parameterOrder": [
"merchantId",
"orderId"
],
"response": {
"$ref": "OrdersRefundItemResponse"
},
"parameters": {
"merchantId": {
"description": "The ID of the account that manages the order. This cannot be a multi-client account.",
"format": "uint64",
"type": "string",
"location": "path",
"required": true
},
"orderId": {
"description": "The ID of the order to refund.",
"required": true,
"location": "path",
"type": "string"
}
},
"request": {
"$ref": "OrdersRefundItemRequest"
},
"description": "Issues a partial or total refund for items and shipment.",
"flatPath": "{merchantId}/orders/{orderId}/refunditem",
"path": "{merchantId}/orders/{orderId}/refunditem"
},
"get": {
"parameters": {
"merchantId": {
"required": true,
"location": "path",
"description": "The ID of the account that manages the order. This cannot be a multi-client account.",
"format": "uint64",
"type": "string"
},
"orderId": {
"location": "path",
"type": "string",
"description": "The ID of the order.",
"required": true
}
},
"parameterOrder": [
"merchantId",
"orderId"
],
"response": {
"$ref": "Order"
},
"flatPath": "{merchantId}/orders/{orderId}",
"path": "{merchantId}/orders/{orderId}",
"httpMethod": "GET",
"id": "content.orders.get",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"description": "Retrieves an order from your Merchant Center account."
},
"cancellineitem": {
"request": {
"$ref": "OrdersCancelLineItemRequest"
},
"path": "{merchantId}/orders/{orderId}/cancelLineItem",
"id": "content.orders.cancellineitem",
"flatPath": "{merchantId}/orders/{orderId}/cancelLineItem",
"description": "Cancels a line item, making a full refund.",
"parameterOrder": [
"merchantId",
"orderId"
],
"parameters": {
"merchantId": {
"format": "uint64",
"description": "The ID of the account that manages the order. This cannot be a multi-client account.",
"required": true,
"type": "string",
"location": "path"
},
"orderId": {
"type": "string",
"description": "The ID of the order.",
"location": "path",
"required": true
}
},
"response": {
"$ref": "OrdersCancelLineItemResponse"
},
"scopes": [
"https://www.googleapis.com/auth/content"
],
"httpMethod": "POST"
},
"getbymerchantorderid": {
"id": "content.orders.getbymerchantorderid",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"flatPath": "{merchantId}/ordersbymerchantid/{merchantOrderId}",
"parameterOrder": [
"merchantId",
"merchantOrderId"
],
"path": "{merchantId}/ordersbymerchantid/{merchantOrderId}",
"httpMethod": "GET",
"description": "Retrieves an order using merchant order ID.",
"parameters": {
"merchantId": {
"type": "string",
"format": "uint64",
"location": "path",
"description": "The ID of the account that manages the order. This cannot be a multi-client account.",
"required": true
},
"merchantOrderId": {
"description": "The merchant order ID to be looked for.",
"location": "path",
"required": true,
"type": "string"
}
},
"response": {
"$ref": "OrdersGetByMerchantOrderIdResponse"
}
},
"rejectreturnlineitem": {
"scopes": [
"https://www.googleapis.com/auth/content"
],
"httpMethod": "POST",
"parameterOrder": [
"merchantId",
"orderId"
],
"response": {
"$ref": "OrdersRejectReturnLineItemResponse"
},
"path": "{merchantId}/orders/{orderId}/rejectReturnLineItem",
"flatPath": "{merchantId}/orders/{orderId}/rejectReturnLineItem",
"description": "Rejects return on an line item.",
"id": "content.orders.rejectreturnlineitem",
"request": {
"$ref": "OrdersRejectReturnLineItemRequest"
},
"parameters": {
"merchantId": {
"format": "uint64",
"location": "path",
"type": "string",
"required": true,
"description": "The ID of the account that manages the order. This cannot be a multi-client account."
},
"orderId": {
"description": "The ID of the order.",
"type": "string",
"location": "path",
"required": true
}
}
},
"setlineitemmetadata": {
"path": "{merchantId}/orders/{orderId}/setLineItemMetadata",
"id": "content.orders.setlineitemmetadata",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"flatPath": "{merchantId}/orders/{orderId}/setLineItemMetadata",
"description": "Sets (or overrides if it already exists) merchant provided annotations in the form of key-value pairs. A common use case would be to supply us with additional structured information about a line item that cannot be provided via other methods. Submitted key-value pairs can be retrieved as part of the orders resource.",
"response": {
"$ref": "OrdersSetLineItemMetadataResponse"
},
"request": {
"$ref": "OrdersSetLineItemMetadataRequest"
},
"httpMethod": "POST",
"parameterOrder": [
"merchantId",
"orderId"
],
"parameters": {
"orderId": {
"required": true,
"location": "path",
"type": "string",
"description": "The ID of the order."
},
"merchantId": {
"type": "string",
"description": "The ID of the account that manages the order. This cannot be a multi-client account.",
"location": "path",
"format": "uint64",
"required": true
}
}
},
"canceltestorderbycustomer": {
"description": "Sandbox only. Cancels a test order for customer-initiated cancellation.",
"flatPath": "{merchantId}/testorders/{orderId}/cancelByCustomer",
"path": "{merchantId}/testorders/{orderId}/cancelByCustomer",
"httpMethod": "POST",
"response": {
"$ref": "OrdersCancelTestOrderByCustomerResponse"
},
"parameters": {
"orderId": {
"description": "The ID of the test order to cancel.",
"location": "path",
"required": true,
"type": "string"
},
"merchantId": {
"format": "uint64",
"location": "path",
"required": true,
"description": "The ID of the account that manages the order. This cannot be a multi-client account.",
"type": "string"
}
},
"parameterOrder": [
"merchantId",
"orderId"
],
"scopes": [
"https://www.googleapis.com/auth/content"
],
"request": {
"$ref": "OrdersCancelTestOrderByCustomerRequest"
},
"id": "content.orders.canceltestorderbycustomer"
},
"list": {
"response": {
"$ref": "OrdersListResponse"
},
"parameters": {
"placedDateStart": {
"type": "string",
"location": "query",
"description": "Obtains orders placed after this date (inclusively), in ISO 8601 format."
},
"statuses": {
"description": "Obtains orders that match any of the specified statuses. Please note that `active` is a shortcut for `pendingShipment` and `partiallyShipped`, and `completed` is a shortcut for `shipped`, `partiallyDelivered`, `delivered`, `partiallyReturned`, `returned`, and `canceled`.",
"location": "query",
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"repeated": true,
"enum": [
"ACTIVE",
"COMPLETED",
"CANCELED",
"IN_PROGRESS",
"PENDING_SHIPMENT",
"PARTIALLY_SHIPPED",
"SHIPPED",
"PARTIALLY_DELIVERED",
"DELIVERED",
"PARTIALLY_RETURNED",
"RETURNED"
],
"type": "string"
},
"orderBy": {
"description": "Order results by placement date in descending or ascending order. Acceptable values are: - placedDateAsc - placedDateDesc ",
"type": "string",
"location": "query"
},
"acknowledged": {
"location": "query",
"description": "Obtains orders that match the acknowledgement status. When set to true, obtains orders that have been acknowledged. When false, obtains orders that have not been acknowledged. We recommend using this filter set to `false`, in conjunction with the `acknowledge` call, such that only un-acknowledged orders are returned. ",
"type": "boolean"
},
"pageToken": {
"description": "The token returned by the previous request.",
"location": "query",
"type": "string"
},
"placedDateEnd": {
"location": "query",
"description": "Obtains orders placed before this date (exclusively), in ISO 8601 format.",
"type": "string"
},
"maxResults": {
"description": "The maximum number of orders to return in the response, used for paging. The default value is 25 orders per page, and the maximum allowed value is 250 orders per page.",
"location": "query",
"format": "uint32",
"type": "integer"
},
"merchantId": {
"location": "path",
"type": "string",
"description": "The ID of the account that manages the order. This cannot be a multi-client account.",
"format": "uint64",
"required": true
}
},
"id": "content.orders.list",
"parameterOrder": [
"merchantId"
],
"path": "{merchantId}/orders",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"flatPath": "{merchantId}/orders",
"httpMethod": "GET",
"description": "Lists the orders in your Merchant Center account."
},
"shiplineitems": {
"scopes": [
"https://www.googleapis.com/auth/content"
],
"response": {
"$ref": "OrdersShipLineItemsResponse"
},
"flatPath": "{merchantId}/orders/{orderId}/shipLineItems",
"httpMethod": "POST",
"request": {
"$ref": "OrdersShipLineItemsRequest"
},
"path": "{merchantId}/orders/{orderId}/shipLineItems",
"parameters": {
"orderId": {
"description": "The ID of the order.",
"location": "path",
"required": true,
"type": "string"
},
"merchantId": {
"location": "path",
"format": "uint64",
"required": true,
"description": "The ID of the account that manages the order. This cannot be a multi-client account.",
"type": "string"
}
},
"description": "Marks line item(s) as shipped.",
"parameterOrder": [
"merchantId",
"orderId"
],
"id": "content.orders.shiplineitems"
}
}
},
"collections": {
"methods": {
"delete": {
"id": "content.collections.delete",
"parameterOrder": [
"merchantId",
"collectionId"
],
"httpMethod": "DELETE",
"parameters": {
"collectionId": {
"required": true,
"type": "string",
"description": "Required. The collectionId of the collection. CollectionId is the same as the REST ID of the collection.",
"location": "path"
},
"merchantId": {
"description": "Required. The ID of the account that contains the collection. This account cannot be a multi-client account.",
"required": true,
"type": "string",
"location": "path",
"format": "int64"
}
},
"flatPath": "{merchantId}/collections/{collectionId}",
"description": "Deletes a collection from your Merchant Center account.",
"path": "{merchantId}/collections/{collectionId}",
"scopes": [
"https://www.googleapis.com/auth/content"
]
},
"list": {
"id": "content.collections.list",
"path": "{merchantId}/collections",
"parameters": {
"merchantId": {
"type": "string",
"description": "Required. The ID of the account that contains the collection. This account cannot be a multi-client account.",
"required": true,
"location": "path",
"format": "int64"
},
"pageSize": {
"location": "query",
"format": "int32",
"type": "integer",
"description": "The maximum number of collections to return in the response, used for paging. Defaults to 50; values above 1000 will be coerced to 1000."
},
"pageToken": {
"description": "Token (if provided) to retrieve the subsequent page. All other parameters must match the original call that provided the page token.",
"type": "string",
"location": "query"
}
},
"response": {
"$ref": "ListCollectionsResponse"
},
"flatPath": "{merchantId}/collections",
"httpMethod": "GET",
"description": "Lists the collections in your Merchant Center account. The response might contain fewer items than specified by page_size. Rely on next_page_token to determine if there are more items to be requested.",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"parameterOrder": [
"merchantId"
]
},
"get": {
"scopes": [
"https://www.googleapis.com/auth/content"
],
"flatPath": "{merchantId}/collections/{collectionId}",
"id": "content.collections.get",
"parameters": {
"merchantId": {
"required": true,
"description": "Required. The ID of the account that contains the collection. This account cannot be a multi-client account.",
"type": "string",
"location": "path",
"format": "int64"
},
"collectionId": {
"required": true,
"type": "string",
"location": "path",
"description": "Required. The REST ID of the collection."
}
},
"response": {
"$ref": "Collection"
},
"parameterOrder": [
"merchantId",
"collectionId"
],
"httpMethod": "GET",
"path": "{merchantId}/collections/{collectionId}",
"description": "Retrieves a collection from your Merchant Center account."
},
"create": {
"parameters": {
"merchantId": {
"type": "string",
"description": "Required. The ID of the account that contains the collection. This account cannot be a multi-client account.",
"required": true,
"location": "path",
"format": "int64"
}
},
"response": {
"$ref": "Collection"
},
"flatPath": "{merchantId}/collections",
"httpMethod": "POST",
"description": "Uploads a collection to your Merchant Center account. If a collection with the same collectionId already exists, this method updates that entry. In each update, the collection is completely replaced by the fields in the body of the update request.",
"request": {
"$ref": "Collection"
},
"id": "content.collections.create",
"parameterOrder": [
"merchantId"
],
"scopes": [
"https://www.googleapis.com/auth/content"
],
"path": "{merchantId}/collections"
}
}
},
"products": {
"methods": {
"insert": {
"parameterOrder": [
"merchantId"
],
"response": {
"$ref": "Product"
},
"id": "content.products.insert",
"flatPath": "{merchantId}/products",
"parameters": {
"feedId": {
"format": "uint64",
"type": "string",
"location": "query",
"description": "The Content API Supplemental Feed ID."
},
"merchantId": {
"required": true,
"format": "uint64",
"location": "path",
"type": "string",
"description": "The ID of the account that contains the product. This account cannot be a multi-client account."
}
},
"path": "{merchantId}/products",
"httpMethod": "POST",
"description": "Uploads a product to your Merchant Center account. If an item with the same channel, contentLanguage, offerId, and targetCountry already exists, this method updates that entry.",
"request": {
"$ref": "Product"
},
"scopes": [
"https://www.googleapis.com/auth/content"
]
},
"list": {
"path": "{merchantId}/products",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"flatPath": "{merchantId}/products",
"description": "Lists the products in your Merchant Center account. The response might contain fewer items than specified by maxResults. Rely on nextPageToken to determine if there are more items to be requested.",
"id": "content.products.list",
"parameters": {
"merchantId": {
"type": "string",
"description": "The ID of the account that contains the products. This account cannot be a multi-client account.",
"location": "path",
"format": "uint64",
"required": true
},
"maxResults": {
"location": "query",
"description": "The maximum number of products to return in the response, used for paging.",
"format": "uint32",
"type": "integer"
},
"pageToken": {
"location": "query",
"type": "string",
"description": "The token returned by the previous request."
}
},
"parameterOrder": [
"merchantId"
],
"response": {
"$ref": "ProductsListResponse"
},
"httpMethod": "GET"
},
"delete": {
"parameters": {
"productId": {
"location": "path",
"type": "string",
"required": true,
"description": "The REST ID of the product."
},
"merchantId": {
"location": "path",
"required": true,
"type": "string",
"description": "The ID of the account that contains the product. This account cannot be a multi-client account.",
"format": "uint64"
},
"feedId": {
"location": "query",
"type": "string",
"format": "uint64",
"description": "The Content API Supplemental Feed ID."
}
},
"id": "content.products.delete",
"httpMethod": "DELETE",
"flatPath": "{merchantId}/products/{productId}",
"description": "Deletes a product from your Merchant Center account.",
"parameterOrder": [
"merchantId",
"productId"
],
"scopes": [
"https://www.googleapis.com/auth/content"
],
"path": "{merchantId}/products/{productId}"
},
"get": {
"scopes": [
"https://www.googleapis.com/auth/content"
],
"description": "Retrieves a product from your Merchant Center account.",
"parameters": {
"merchantId": {
"required": true,
"format": "uint64",
"location": "path",
"type": "string",
"description": "The ID of the account that contains the product. This account cannot be a multi-client account."
},
"productId": {
"location": "path",
"type": "string",
"required": true,
"description": "The REST ID of the product."
}
},
"parameterOrder": [
"merchantId",
"productId"
],
"flatPath": "{merchantId}/products/{productId}",
"response": {
"$ref": "Product"
},
"id": "content.products.get",
"path": "{merchantId}/products/{productId}",
"httpMethod": "GET"
},
"custombatch": {
"flatPath": "products/batch",
"id": "content.products.custombatch",
"request": {
"$ref": "ProductsCustomBatchRequest"
},
"path": "products/batch",
"httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"parameters": {},
"parameterOrder": [],
"response": {
"$ref": "ProductsCustomBatchResponse"
},
"description": "Retrieves, inserts, and deletes multiple products in a single request."
}
}
},
"regionalinventory": {
"methods": {
"insert": {
"parameterOrder": [
"merchantId",
"productId"
],
"scopes": [
"https://www.googleapis.com/auth/content"
],
"id": "content.regionalinventory.insert",
"flatPath": "{merchantId}/products/{productId}/regionalinventory",
"response": {
"$ref": "RegionalInventory"
},
"httpMethod": "POST",
"parameters": {
"productId": {
"location": "path",
"description": "The REST ID of the product for which to update the regional inventory.",
"type": "string",
"required": true
},
"merchantId": {
"format": "uint64",
"location": "path",
"required": true,
"description": "The ID of the account that contains the product. This account cannot be a multi-client account.",
"type": "string"
}
},
"description": "Update the regional inventory of a product in your Merchant Center account. If a regional inventory with the same region ID already exists, this method updates that entry.",
"path": "{merchantId}/products/{productId}/regionalinventory",
"request": {
"$ref": "RegionalInventory"
}
},
"custombatch": {
"parameterOrder": [],
"scopes": [
"https://www.googleapis.com/auth/content"
],
"httpMethod": "POST",
"description": "Updates regional inventory for multiple products or regions in a single request.",
"request": {
"$ref": "RegionalinventoryCustomBatchRequest"
},
"response": {
"$ref": "RegionalinventoryCustomBatchResponse"
},
"path": "regionalinventory/batch",
"flatPath": "regionalinventory/batch",
"parameters": {},
"id": "content.regionalinventory.custombatch"
}
}
},
"localinventory": {
"methods": {
"custombatch": {
"httpMethod": "POST",
"parameters": {},
"path": "localinventory/batch",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"parameterOrder": [],
"id": "content.localinventory.custombatch",
"description": "Updates local inventory for multiple products or stores in a single request.",
"response": {
"$ref": "LocalinventoryCustomBatchResponse"
},
"request": {
"$ref": "LocalinventoryCustomBatchRequest"
},
"flatPath": "localinventory/batch"
},
"insert": {
"response": {
"$ref": "LocalInventory"
},
"parameters": {
"merchantId": {
"description": "The ID of the account that contains the product. This account cannot be a multi-client account.",
"format": "uint64",
"type": "string",
"location": "path",
"required": true
},
"productId": {
"type": "string",
"required": true,
"description": "The REST ID of the product for which to update local inventory.",
"location": "path"
}
},
"path": "{merchantId}/products/{productId}/localinventory",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"request": {
"$ref": "LocalInventory"
},
"flatPath": "{merchantId}/products/{productId}/localinventory",
"id": "content.localinventory.insert",
"httpMethod": "POST",
"parameterOrder": [
"merchantId",
"productId"
],
"description": "Updates the local inventory of a product in your Merchant Center account."
}
}
},
"returnpolicyonline": {
"methods": {
"list": {
"flatPath": "{merchantId}/returnpolicyonline",
"id": "content.returnpolicyonline.list",
"response": {
"$ref": "ListReturnPolicyOnlineResponse"
},
"description": "Lists all existing return policies.",
"parameters": {
"merchantId": {
"format": "int64",
"type": "string",
"required": true,
"location": "path",
"description": "Required. The id of the merchant for which to retrieve the return policy online object."
}
},
"scopes": [
"https://www.googleapis.com/auth/content"
],
"parameterOrder": [
"merchantId"
],
"httpMethod": "GET",
"path": "{merchantId}/returnpolicyonline"
},
"patch": {
"response": {
"$ref": "ReturnPolicyOnline"
},
"parameters": {
"merchantId": {
"format": "int64",
"required": true,
"type": "string",
"description": "Required. The id of the merchant for which to retrieve the return policy online object.",
"location": "path"
},
"returnPolicyId": {
"type": "string",
"description": "Required. The id of the return policy to update.",
"location": "path",
"required": true
}
},
"description": "Updates an existing return policy.",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"id": "content.returnpolicyonline.patch",
"request": {
"$ref": "ReturnPolicyOnline"
},
"flatPath": "{merchantId}/returnpolicyonline/{returnPolicyId}",
"parameterOrder": [
"merchantId",
"returnPolicyId"
],
"path": "{merchantId}/returnpolicyonline/{returnPolicyId}",
"httpMethod": "PATCH"
},
"delete": {
"parameters": {
"returnPolicyId": {
"description": "Required. The id of the return policy to delete.",
"location": "path",
"required": true,
"type": "string"
},
"merchantId": {
"format": "int64",
"type": "string",
"required": true,
"location": "path",
"description": "Required. The id of the merchant for which to retrieve the return policy online object."
}
},
"description": "Deletes an existing return policy.",
"id": "content.returnpolicyonline.delete",
"httpMethod": "DELETE",
"path": "{merchantId}/returnpolicyonline/{returnPolicyId}",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"parameterOrder": [
"merchantId",
"returnPolicyId"
],
"flatPath": "{merchantId}/returnpolicyonline/{returnPolicyId}"
},
"get": {
"response": {
"$ref": "ReturnPolicyOnline"
},
"flatPath": "{merchantId}/returnpolicyonline/{returnPolicyId}",
"parameterOrder": [
"merchantId",
"returnPolicyId"
],
"httpMethod": "GET",
"description": "Gets an existing return policy.",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"path": "{merchantId}/returnpolicyonline/{returnPolicyId}",
"id": "content.returnpolicyonline.get",
"parameters": {
"merchantId": {
"type": "string",
"format": "int64",
"description": "Required. The id of the merchant for which to retrieve the return policy online object.",
"location": "path",
"required": true
},
"returnPolicyId": {
"location": "path",
"required": true,
"type": "string",
"description": "Required. The id of the return policy to retrieve."
}
}
},
"create": {
"scopes": [
"https://www.googleapis.com/auth/content"
],
"flatPath": "{merchantId}/returnpolicyonline",
"parameters": {
"merchantId": {
"format": "int64",
"type": "string",
"location": "path",
"required": true,
"description": "Required. The id of the merchant for which to retrieve the return policy online object."
}
},
"httpMethod": "POST",
"request": {
"$ref": "ReturnPolicyOnline"
},
"parameterOrder": [
"merchantId"
],
"id": "content.returnpolicyonline.create",
"response": {
"$ref": "ReturnPolicyOnline"
},
"path": "{merchantId}/returnpolicyonline",
"description": "Creates a new return policy."
}
}
}
},
"title": "Content API for Shopping",
"revision": "20210325",
"kind": "discovery#restDescription",
"batchPath": "batch",
"discoveryVersion": "v1",
"description": "Manage your product listings and accounts for Google Shopping",
"basePath": "/content/v2.1/",
"baseUrl": "https://shoppingcontent.googleapis.com/content/v2.1/",
"version": "v2.1",
"schemas": {
"AccountstatusesCustomBatchResponseEntry": {
"description": "A batch entry encoding a single non-batch accountstatuses response.",
"id": "AccountstatusesCustomBatchResponseEntry",
"type": "object",
"properties": {
"accountStatus": {
"description": "The requested account status. Defined if and only if the request was successful.",
"$ref": "AccountStatus"
},
"batchId": {
"type": "integer",
"description": "The ID of the request entry this entry responds to.",
"format": "uint32"
},
"errors": {
"$ref": "Errors",
"description": "A list of errors defined if and only if the request failed."
}
}
},
"TestOrderPickupDetailsPickupPerson": {
"id": "TestOrderPickupDetailsPickupPerson",
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Required. Full name of the pickup person."
},
"phoneNumber": {
"type": "string",
"description": "Required. The phone number of the person picking up the items."
}
}
},
"PosSaleRequest": {
"id": "PosSaleRequest",
"type": "object",
"properties": {
"targetCountry": {
"description": "Required. The CLDR territory code for the item.",
"type": "string"
},
"price": {
"description": "Required. The price of the item.",
"$ref": "Price"
},
"quantity": {
"type": "string",
"format": "int64",
"description": "Required. The relative change of the available quantity. Negative for items returned."
},
"timestamp": {
"type": "string",
"description": "Required. The inventory timestamp, in ISO 8601 format."
},
"itemId": {
"description": "Required. A unique identifier for the item.",
"type": "string"
},
"saleId": {
"type": "string",
"description": "A unique ID to group items from the same sale event."
},
"contentLanguage": {
"description": "Required. The two-letter ISO 639-1 language code for the item.",
"type": "string"
},
"storeCode": {
"description": "Required. The identifier of the merchant's store. Either a `storeCode` inserted via the API or the code of the store in Google My Business.",
"type": "string"
},
"gtin": {
"description": "Global Trade Item Number.",
"type": "string"
}
}
},
"LiasettingsCustomBatchResponseEntry": {
"properties": {
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"`content#liasettingsCustomBatchResponseEntry`\""
},
"liaSettings": {
"description": "The retrieved or updated Lia settings.",
"$ref": "LiaSettings"
},
"posDataProviders": {
"description": "The list of POS data providers.",
"type": "array",
"items": {
"$ref": "PosDataProviders"
}
},
"errors": {
"description": "A list of errors defined if, and only if, the request failed.",
"$ref": "Errors"
},
"gmbAccounts": {
"description": "The list of accessible GMB accounts.",
"$ref": "GmbAccounts"
},
"batchId": {
"description": "The ID of the request entry to which this entry responds.",
"format": "uint32",
"type": "integer"
}
},
"type": "object",
"id": "LiasettingsCustomBatchResponseEntry"
},
"LiaInventorySettings": {
"properties": {
"status": {
"description": "The status of the inventory verification process. Acceptable values are: - \"`active`\" - \"`inactive`\" - \"`pending`\" ",
"type": "string"
},
"inventoryVerificationContactEmail": {
"description": "The email of the contact for the inventory verification process.",
"type": "string"
},
"inventoryVerificationContactName": {
"type": "string",
"description": "The name of the contact for the inventory verification process."
},
"inventoryVerificationContactStatus": {
"type": "string",
"description": "The status of the verification contact. Acceptable values are: - \"`active`\" - \"`inactive`\" - \"`pending`\" "
}
},
"id": "LiaInventorySettings",
"type": "object"
},
"RepricingRuleEligibleOfferMatcherStringMatcher": {
"properties": {
"strAttributes": {
"type": "array",
"description": "String attributes, as long as such attribute of an offer is one of the string attribute values, the offer is considered as passing the matcher. The string matcher checks an offer for inclusivity in the string attributes, not equality. Only literal string matching is supported, no regex.",
"items": {
"type": "string"
}
}
},
"description": "Matcher by string attributes.",
"type": "object",
"id": "RepricingRuleEligibleOfferMatcherStringMatcher"
},
"OrderPickupDetails": {
"type": "object",
"properties": {
"locationId": {
"type": "string",
"description": "ID of the pickup location."
},
"address": {
"description": "Address of the pickup location where the shipment should be sent. Note that `recipientName` in the address is the name of the business at the pickup location.",
"$ref": "OrderAddress"
},
"pickupType": {
"type": "string",
"description": "The pickup type of this order. Acceptable values are: - \"`merchantStore`\" - \"`merchantStoreCurbside`\" - \"`merchantStoreLocker`\" - \"`thirdPartyPickupPoint`\" - \"`thirdPartyLocker`\" "
},
"collectors": {
"description": "Collectors authorized to pick up shipment from the pickup location.",
"items": {
"$ref": "OrderPickupDetailsCollector"
},
"type": "array"
}
},
"id": "OrderPickupDetails"
},
"OrderreportsListTransactionsResponse": {
"type": "object",
"properties": {
"nextPageToken": {
"description": "The token for the retrieval of the next page of transactions.",
"type": "string"
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#orderreportsListTransactionsResponse\"."
},
"transactions": {
"type": "array",
"description": "The list of transactions.",
"items": {
"$ref": "OrderReportTransaction"
}
}
},
"id": "OrderreportsListTransactionsResponse"
},
"RegionPostalCodeArea": {
"type": "object",
"description": "A list of postal codes that defines the region area. Note: All regions defined using postal codes are accessible via the account's `ShippingSettings.postalCodeGroups` resource.",
"id": "RegionPostalCodeArea",
"properties": {
"regionCode": {
"type": "string",
"description": "Required. CLDR territory code or the country the postal code group applies to."
},
"postalCodes": {
"description": "Required. A range of postal codes.",
"type": "array",
"items": {
"$ref": "RegionPostalCodeAreaPostalCodeRange"
}
}
}
},
"AccountsListLinksResponse": {
"type": "object",
"properties": {
"links": {
"description": "The list of available links.",
"items": {
"$ref": "LinkedAccount"
},
"type": "array"
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#accountsListLinksResponse\"."
},
"nextPageToken": {
"description": "The token for the retrieval of the next page of links.",
"type": "string"
}
},
"id": "AccountsListLinksResponse"
},
"LiaPosDataProvider": {
"properties": {
"posDataProviderId": {
"description": "The ID of the POS data provider.",
"format": "uint64",
"type": "string"
},
"posExternalAccountId": {
"type": "string",
"description": "The account ID by which this merchant is known to the POS data provider."
}
},
"type": "object",
"id": "LiaPosDataProvider"
},
"MinimumOrderValueTable": {
"type": "object",
"properties": {
"storeCodeSetWithMovs": {
"type": "array",
"items": {
"$ref": "MinimumOrderValueTableStoreCodeSetWithMov"
}
}
},
"id": "MinimumOrderValueTable"
},
"ListAccountReturnCarrierResponse": {
"id": "ListAccountReturnCarrierResponse",
"description": "Response for listing account return carriers.",
"properties": {
"accountReturnCarriers": {
"items": {
"$ref": "AccountReturnCarrier"
},
"description": "List of all available account return carriers for the merchant.",
"type": "array"
}
},
"type": "object"
},
"DatafeedstatusesCustomBatchRequest": {
"type": "object",
"properties": {
"entries": {
"description": "The request entries to be processed in the batch.",
"items": {
"$ref": "DatafeedstatusesCustomBatchRequestEntry"
},
"type": "array"
}
},
"id": "DatafeedstatusesCustomBatchRequest"
},
"TransitTableTransitTimeRowTransitTimeValue": {
"id": "TransitTableTransitTimeRowTransitTimeValue",
"properties": {
"maxTransitTimeInDays": {
"description": "Must be greater than or equal to `minTransitTimeInDays`.",
"type": "integer",
"format": "uint32"
},
"minTransitTimeInDays": {
"description": "Transit time range (min-max) in business days. 0 means same day delivery, 1 means next day delivery.",
"format": "uint32",
"type": "integer"
}
},
"type": "object"
},
"OrderCustomer": {
"properties": {
"marketingRightsInfo": {
"$ref": "OrderCustomerMarketingRightsInfo",
"description": "Customer's marketing preferences. Contains the marketing opt-in information that is current at the time that the merchant call. User preference selections can change from one order to the next so preferences must be checked with every order."
},
"fullName": {
"type": "string",
"description": "Full name of the customer."
},
"invoiceReceivingEmail": {
"type": "string",
"description": "Email address for the merchant to send value-added tax or invoice documentation of the order. Only the last document sent is made available to the customer. For more information, see About automated VAT invoicing for Buy on Google."
},
"loyaltyInfo": {
"$ref": "OrderCustomerLoyaltyInfo",
"description": "Loyalty program information."
}
},
"type": "object",
"id": "OrderCustomer"
},
"InapplicabilityDetails": {
"type": "object",
"description": "Map of inapplicability details.",
"properties": {
"inapplicableReason": {
"type": "string",
"enum": [
"INAPPLICABLE_REASON_UNSPECIFIED",
"CANNOT_BEAT_BUYBOX_WINNER",
"ALREADY_WINNING_BUYBOX",
"TRIUMPHED_OVER_BY_SAME_TYPE_RULE",
"TRIUMPHED_OVER_BY_OTHER_RULE_ON_OFFER",
"RESTRICTIONS_NOT_MET",
"UNCATEGORIZED"
],
"description": "Reason code this rule was not applicable.",
"enumDescriptions": [
"Default value. Should not be used.",
"The rule set for this product cannot beat the buybox winner.",
"This product can already win the buybox without rule.",
"Another rule of the same type takes precedence over this one.",
"Another rule of a different type takes precedence over this one.",
"The rule restrictions are not met. For example, this may be the case if the calculated rule price is lower than floor price in the restriction.",
"The reason is not categorized to any known reason."
]
},
"inapplicableCount": {
"type": "string",
"description": "Count of this inapplicable reason code.",
"format": "int64"
}
},
"id": "InapplicabilityDetails"
},
"AccountAddress": {
"properties": {
"region": {
"type": "string",
"description": "Top-level administrative subdivision of the country. For example, a state like California (\"CA\") or a province like Quebec (\"QC\")."
},
"postalCode": {
"type": "string",
"description": "Postal code or ZIP (e.g. \"94043\")."
},
"streetAddress": {
"description": "Street-level part of the address.",
"type": "string"
},
"locality": {
"type": "string",
"description": "City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs)."
},
"country": {
"type": "string",
"description": "CLDR country code (e.g. \"US\"). This value cannot be set for a sub-account of an MCA. All MCA sub-accounts inherit the country of their parent MCA."
}
},
"id": "AccountAddress",
"type": "object"
},
"RepricingProductReport": {
"properties": {
"totalGmv": {
"$ref": "PriceAmount",
"description": "Total GMV generated by impacted products while the rule was active on the date of the report. This value includes all orders that were started while the rule was active, even if the rule was no longer active when the order was completed."
},
"applicationCount": {
"type": "string",
"description": "Total count of Repricer applications. This value captures how many times the rule of this type was applied to this product during this reporting period.",
"format": "int64"
},
"inapplicabilityDetails": {
"type": "array",
"description": "List of all reasons the rule did not apply to the product during the specified reporting period.",
"items": {
"$ref": "InapplicabilityDetails"
}
},
"lowWatermark": {
"description": "Minimum displayed price after repriced during this reporting period.",
"$ref": "PriceAmount"
},
"date": {
"description": "Date of the stats in this report. The report starts and ends according to the merchant's timezone.",
"$ref": "Date"
},
"ruleIds": {
"items": {
"type": "string"
},
"type": "array",
"description": "Ids of the Repricing rule for this report."
},
"orderItemCount": {
"format": "int32",
"description": "Total unit count of impacted products ordered while the rule was active on the date of the report. This count includes all orders that were started while the rule was active, even if the rule was no longer active when the order was completed.",
"type": "integer"
},
"buyboxWinningProductStats": {
"description": "Stats specific to buybox winning rules for product report.",
"$ref": "RepricingProductReportBuyboxWinningProductStats"
},
"type": {
"description": "Type of the rule.",
"enum": [
"REPRICING_RULE_TYPE_UNSPECIFIED",
"TYPE_STATS_BASED",
"TYPE_COGS_BASED"
],
"type": "string",
"enumDescriptions": [
"Unused.",
"Statistical measurement based rules among Google SA merchants. If this rule is chosen, repricer will adjust the offer price based on statistical metrics (currently only min is available) among other merchants who sell the same product. Details need to be provdided in the RuleDefinition.",
"Cost of goods sale based rule. Repricer will adjust the offer price based on the offer's sale cost which is provided by the merchant."
]
},
"highWatermark": {
"description": "Maximum displayed price after repriced during this reporting period.",
"$ref": "PriceAmount"
}
},
"id": "RepricingProductReport",
"type": "object",
"description": "Resource that represents a daily Repricing product report. Each report contains stats for a single type of Repricing rule for a single product on a given day. If there are multiple rules of the same type for the product on that day, the report lists all the rules by rule ids, combines the stats, and paginates the results by date. To retrieve the stats of a particular rule, provide the rule_id in the request."
},
"ShippingsettingsCustomBatchRequest": {
"id": "ShippingsettingsCustomBatchRequest",
"properties": {
"entries": {
"description": "The request entries to be processed in the batch.",
"type": "array",
"items": {
"$ref": "ShippingsettingsCustomBatchRequestEntry"
}
}
},
"type": "object"
},
"OrderreturnsCreateOrderReturnResponse": {
"type": "object",
"properties": {
"orderReturn": {
"$ref": "MerchantOrderReturn",
"description": "Created order return."
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#orderreturnsCreateOrderReturnResponse\".",
"type": "string"
},
"executionStatus": {
"type": "string",
"description": "The status of the execution. Acceptable values are: - \"`duplicate`\" - \"`executed`\" "
}
},
"id": "OrderreturnsCreateOrderReturnResponse"
},
"ProductsListResponse": {
"id": "ProductsListResponse",
"type": "object",
"properties": {
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#productsListResponse\".",
"type": "string"
},
"nextPageToken": {
"type": "string",
"description": "The token for the retrieval of the next page of products."
},
"resources": {
"type": "array",
"items": {
"$ref": "Product"
}
}
}
},
"ShippingsettingsCustomBatchResponseEntry": {
"properties": {
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"`content#shippingsettingsCustomBatchResponseEntry`\"",
"type": "string"
},
"shippingSettings": {
"$ref": "ShippingSettings",
"description": "The retrieved or updated account shipping settings."
},
"errors": {
"$ref": "Errors",
"description": "A list of errors defined if, and only if, the request failed."
},
"batchId": {
"type": "integer",
"description": "The ID of the request entry to which this entry responds.",
"format": "uint32"
}
},
"id": "ShippingsettingsCustomBatchResponseEntry",
"description": "A batch entry encoding a single non-batch shipping settings response.",
"type": "object"
},
"OrdersAcknowledgeResponse": {
"type": "object",
"id": "OrdersAcknowledgeResponse",
"properties": {
"executionStatus": {
"type": "string",
"description": "The status of the execution. Acceptable values are: - \"`duplicate`\" - \"`executed`\" "
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersAcknowledgeResponse\"."
}
}
},
"PosStore": {
"id": "PosStore",
"description": "Store resource.",
"type": "object",
"properties": {
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"`content#posStore`\"",
"type": "string"
},
"storeCode": {
"type": "string",
"description": "Required. A store identifier that is unique for the given merchant."
},
"storeAddress": {
"description": "Required. The street address of the store.",
"type": "string"
}
}
},
"PosInventory": {
"id": "PosInventory",
"description": "The absolute quantity of an item available at the given store.",
"properties": {
"targetCountry": {
"description": "Required. The CLDR territory code for the item.",
"type": "string"
},
"contentLanguage": {
"description": "Required. The two-letter ISO 639-1 language code for the item.",
"type": "string"
},
"quantity": {
"format": "int64",
"description": "Required. The available quantity of the item.",
"type": "string"
},
"itemId": {
"description": "Required. A unique identifier for the item.",
"type": "string"
},
"timestamp": {
"description": "Required. The inventory timestamp, in ISO 8601 format.",
"type": "string"
},
"gtin": {
"description": "Global Trade Item Number.",
"type": "string"
},
"storeCode": {
"description": "Required. The identifier of the merchant's store. Either a `storeCode` inserted via the API or the code of the store in Google My Business.",
"type": "string"
},
"price": {
"$ref": "Price",
"description": "Required. The current price of the item."
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"`content#posInventory`\"",
"type": "string"
}
},
"type": "object"
},
"DatafeedFetchSchedule": {
"type": "object",
"description": "The required fields vary based on the frequency of fetching. For a monthly fetch schedule, day_of_month and hour are required. For a weekly fetch schedule, weekday and hour are required. For a daily fetch schedule, only hour is required.",
"properties": {
"fetchUrl": {
"description": "The URL where the feed file can be fetched. Google Merchant Center will support automatic scheduled uploads using the HTTP, HTTPS, FTP, or SFTP protocols, so the value will need to be a valid link using one of those four protocols.",
"type": "string"
},
"timeZone": {
"description": "Time zone used for schedule. UTC by default. E.g., \"America/Los_Angeles\".",
"type": "string"
},
"dayOfMonth": {
"description": "The day of the month the feed file should be fetched (1-31).",
"type": "integer",
"format": "uint32"
},
"username": {
"type": "string",
"description": "An optional user name for fetch_url."
},
"password": {
"type": "string",
"description": "An optional password for fetch_url."
},
"weekday": {
"description": "The day of the week the feed file should be fetched. Acceptable values are: - \"`monday`\" - \"`tuesday`\" - \"`wednesday`\" - \"`thursday`\" - \"`friday`\" - \"`saturday`\" - \"`sunday`\" ",
"type": "string"
},
"minuteOfHour": {
"type": "integer",
"description": "The minute of the hour the feed file should be fetched (0-59). Read-only.",
"format": "uint32"
},
"hour": {
"format": "uint32",
"type": "integer",
"description": "The hour of the day the feed file should be fetched (0-23)."
},
"paused": {
"description": "Whether the scheduled fetch is paused or not.",
"type": "boolean"
}
},
"id": "DatafeedFetchSchedule"
},
"SettlementtransactionsListResponse": {
"type": "object",
"id": "SettlementtransactionsListResponse",
"properties": {
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#settlementtransactionsListResponse\".",
"type": "string"
},
"resources": {
"items": {
"$ref": "SettlementTransaction"
},
"type": "array"
},
"nextPageToken": {
"description": "The token for the retrieval of the next page of returns.",
"type": "string"
}
}
},
"LiasettingsCustomBatchRequestEntry": {
"id": "LiasettingsCustomBatchRequestEntry",
"type": "object",
"properties": {
"accountId": {
"format": "uint64",
"type": "string",
"description": "The ID of the account for which to get/update account LIA settings."
},
"posExternalAccountId": {
"type": "string",
"description": "The account ID by which this merchant is known to the POS provider."
},
"merchantId": {
"description": "The ID of the managing account.",
"type": "string",
"format": "uint64"
},
"contactEmail": {
"type": "string",
"description": "Inventory validation contact email. Required only for SetInventoryValidationContact."
},
"contactName": {
"type": "string",
"description": "Inventory validation contact name. Required only for SetInventoryValidationContact."
},
"country": {
"type": "string",
"description": "The country code. Required only for RequestInventoryVerification."
},
"batchId": {
"format": "uint32",
"type": "integer",
"description": "An entry ID, unique within the batch request."
},
"gmbEmail": {
"description": "The GMB account. Required only for RequestGmbAccess.",
"type": "string"
},
"method": {
"description": "The method of the batch entry. Acceptable values are: - \"`get`\" - \"`getAccessibleGmbAccounts`\" - \"`requestGmbAccess`\" - \"`requestInventoryVerification`\" - \"`setInventoryVerificationContact`\" - \"`update`\" ",
"type": "string"
},
"liaSettings": {
"$ref": "LiaSettings",
"description": "The account Lia settings to update. Only defined if the method is `update`."
},
"posDataProviderId": {
"type": "string",
"description": "The ID of POS data provider. Required only for SetPosProvider.",
"format": "uint64"
}
}
},
"ReturnPolicySeasonalOverride": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Required. The name of the seasonal override as shown in Merchant Center."
},
"policy": {
"$ref": "ReturnPolicyPolicy",
"description": "Required. The policy which is in effect during that time."
},
"endDate": {
"description": "Required. Last day on which the override applies. In ISO 8601 format.",
"type": "string"
},
"startDate": {
"type": "string",
"description": "Required. First day on which the override applies. In ISO 8601 format."
}
},
"id": "ReturnPolicySeasonalOverride"
},
"UnitInvoice": {
"id": "UnitInvoice",
"properties": {
"unitPrice": {
"$ref": "Price",
"description": "[required] Pre-tax or post-tax price of the unit depending on the locality of the order."
},
"unitPriceTaxes": {
"items": {
"$ref": "UnitInvoiceTaxLine"
},
"description": "Tax amounts to apply to the unit price.",
"type": "array"
},
"additionalCharges": {
"items": {
"$ref": "UnitInvoiceAdditionalCharge"
},
"description": "Additional charges for a unit, e.g. shipping costs.",
"type": "array"
}
},
"type": "object"
},
"OrderReturn": {
"type": "object",
"properties": {
"creationDate": {
"description": "Date on which the item has been created, in ISO 8601 format.",
"type": "string"
},
"quantity": {
"type": "integer",
"description": "Quantity that is returned.",
"format": "uint32"
},
"actor": {
"type": "string",
"description": "The actor that created the refund. Acceptable values are: - \"`customer`\" - \"`googleBot`\" - \"`googleCustomerService`\" - \"`googlePayments`\" - \"`googleSabre`\" - \"`merchant`\" "
},
"reason": {
"description": "The reason for the return. Acceptable values are: - \"`customerDiscretionaryReturn`\" - \"`customerInitiatedMerchantCancel`\" - \"`deliveredTooLate`\" - \"`expiredItem`\" - \"`invalidCoupon`\" - \"`malformedShippingAddress`\" - \"`other`\" - \"`productArrivedDamaged`\" - \"`productNotAsDescribed`\" - \"`qualityNotAsExpected`\" - \"`undeliverableShippingAddress`\" - \"`unsupportedPoBoxAddress`\" - \"`wrongProductShipped`\" ",
"type": "string"
},
"reasonText": {
"type": "string",
"description": "The explanation of the reason."
}
},
"id": "OrderReturn"
},
"RepricingRuleEligibleOfferMatcher": {
"properties": {
"matcherOption": {
"enum": [
"MATCHER_OPTION_UNSPECIFIED",
"MATCHER_OPTION_CUSTOM_FILTER",
"MATCHER_OPTION_USE_FEED_ATTRIBUTE",
"MATCHER_OPTION_ALL_PRODUCTS"
],
"enumDescriptions": [
"Unused.",
"Use custom filters.",
"Use repricing_rule_id feed attribute on the product resource to specify offer-rule mapping.",
"Matching all products."
],
"type": "string",
"description": "Determines whether to use the custom matchers or the product feed attribute \"repricing_rule_id\" to specify offer-rule mapping."
},
"offerIdMatcher": {
"$ref": "RepricingRuleEligibleOfferMatcherStringMatcher",
"description": "Filter by the offer id."
},
"skipWhenOnPromotion": {
"description": "When true, the rule won't be applied to offers with active promotions.",
"type": "boolean"
},
"itemGroupIdMatcher": {
"$ref": "RepricingRuleEligibleOfferMatcherStringMatcher",
"description": "Filter by the item group id."
},
"brandMatcher": {
"description": "Filter by the brand.",
"$ref": "RepricingRuleEligibleOfferMatcherStringMatcher"
}
},
"id": "RepricingRuleEligibleOfferMatcher",
"description": "Matcher that specifies eligible offers. When the USE_FEED_ATTRIBUTE option is selected, only the repricing_rule_id attribute on the product feed is used to specify offer-rule mapping. When the CUSTOM_FILTER option is selected, only the *_matcher fields are used to filter the offers for offer-rule mapping. If the CUSTOM_FILTER option is selected, an offer needs to satisfy each custom filter matcher to be eligible for a rule. Size limit: the sum of the number of entries in all the matchers should not exceed 20. For example, there can be 15 product ids and 5 brands, but not 10 product ids and 11 brands.",
"type": "object"
},
"Headers": {
"type": "object",
"description": "A non-empty list of row or column headers for a table. Exactly one of `prices`, `weights`, `numItems`, `postalCodeGroupNames`, or `location` must be set.",
"properties": {
"numberOfItems": {
"type": "array",
"description": "A list of inclusive number of items upper bounds. The last value can be `\"infinity\"`. For example `[\"10\", \"50\", \"infinity\"]` represents the headers \"\u003c= 10 items\", \"\u003c= 50 items\", and \"\u003e 50 items\". Must be non-empty. Can only be set if all other fields are not set.",
"items": {
"type": "string"
}
},
"weights": {
"description": "A list of inclusive order weight upper bounds. The last weight's value can be `\"infinity\"`. For example `[{\"value\": \"10\", \"unit\": \"kg\"}, {\"value\": \"50\", \"unit\": \"kg\"}, {\"value\": \"infinity\", \"unit\": \"kg\"}]` represents the headers \"\u003c= 10kg\", \"\u003c= 50kg\", and \"\u003e 50kg\". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.",
"type": "array",
"items": {
"$ref": "Weight"
}
},
"prices": {
"description": "A list of inclusive order price upper bounds. The last price's value can be `\"infinity\"`. For example `[{\"value\": \"10\", \"currency\": \"USD\"}, {\"value\": \"500\", \"currency\": \"USD\"}, {\"value\": \"infinity\", \"currency\": \"USD\"}]` represents the headers \"\u003c= $10\", \"\u003c= $500\", and \"\u003e $500\". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.",
"items": {
"$ref": "Price"
},
"type": "array"
},
"postalCodeGroupNames": {
"items": {
"type": "string"
},
"description": "A list of postal group names. The last value can be `\"all other locations\"`. Example: `[\"zone 1\", \"zone 2\", \"all other locations\"]`. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.",
"type": "array"
},
"locations": {
"description": "A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.",
"type": "array",
"items": {
"$ref": "LocationIdSet"
}
}
},
"id": "Headers"
},
"Account": {
"id": "Account",
"type": "object",
"properties": {
"businessInformation": {
"$ref": "AccountBusinessInformation",
"description": "The business information of the account."
},
"labelIds": {
"type": "array",
"description": "Manually created label IDs that are assigned to the account by CSS.",
"items": {
"format": "uint64",
"type": "string"
}
},
"youtubeChannelLinks": {
"description": "Linked YouTube channels that are active or pending approval. To create a new link request, add a new link with status `active` to the list. It will remain in a `pending` state until approved or rejected in the YT Creator Studio interface. To delete an active link, or to cancel a link request, remove it from the list.",
"type": "array",
"items": {
"$ref": "AccountYouTubeChannelLink"
}
},
"users": {
"type": "array",
"items": {
"$ref": "AccountUser"
},
"description": "Users with access to the account. Every account (except for subaccounts) must have at least one admin user."
},
"adultContent": {
"description": "Indicates whether the merchant sells adult content.",
"type": "boolean"
},
"googleMyBusinessLink": {
"description": "The GMB account which is linked or in the process of being linked with the Merchant Center account.",
"$ref": "AccountGoogleMyBusinessLink"
},
"id": {
"description": "Required for update. Merchant Center account ID.",
"format": "uint64",
"type": "string"
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"`content#account`\"",
"type": "string"
},
"cssId": {
"format": "uint64",
"description": "ID of CSS the account belongs to.",
"type": "string"
},
"websiteUrl": {
"description": "The merchant's website.",
"type": "string"
},
"automaticLabelIds": {
"description": "Automatically created label IDs that are assigned to the account by CSS Center.",
"type": "array",
"items": {
"type": "string",
"format": "uint64"
}
},
"sellerId": {
"description": "Client-specific, locally-unique, internal ID for the child account.",
"type": "string"
},
"name": {
"type": "string",
"description": "Required. Display name for the account."
},
"adsLinks": {
"description": "Linked Ads 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 Ads interface or through the AdWords API. To delete an active link, or to cancel a link request, remove it from the list.",
"items": {
"$ref": "AccountAdsLink"
},
"type": "array"
}
},
"description": "Account data. After the creation of a new account it may take a few minutes before it is fully operational. The methods delete, insert, and update require the admin role."
},
"AccountstatusesListResponse": {
"type": "object",
"id": "AccountstatusesListResponse",
"properties": {
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#accountstatusesListResponse\"."
},
"resources": {
"items": {
"$ref": "AccountStatus"
},
"type": "array"
},
"nextPageToken": {
"type": "string",
"description": "The token for the retrieval of the next page of account statuses."
}
}
},
"RepricingRuleEffectiveTimeFixedTimePeriod": {
"type": "object",
"id": "RepricingRuleEffectiveTimeFixedTimePeriod",
"description": "Definition of a fixed time period.",
"properties": {
"endTime": {
"format": "google-datetime",
"description": "The end time (exclusive) of the period. It can only be hour granularity.",
"type": "string"
},
"startTime": {
"type": "string",
"description": "The start time (inclusive) of the period. It can only be hour granularity.",
"format": "google-datetime"
}
}
},
"CollectionFeaturedProduct": {
"type": "object",
"description": "The message for FeaturedProduct. [FeaturedProduct](https://support.google.com/merchants/answer/9703736)",
"properties": {
"offerId": {
"description": "The unique identifier for the product item.",
"type": "string"
},
"y": {
"type": "number",
"description": "Required. Y-coordinate of the product callout on the Shoppable Image.",
"format": "float"
},
"x": {
"type": "number",
"format": "float",
"description": "Required. X-coordinate of the product callout on the Shoppable Image."
}
},
"id": "CollectionFeaturedProduct"
},
"OrdersListResponse": {
"id": "OrdersListResponse",
"properties": {
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersListResponse\".",
"type": "string"
},
"resources": {
"items": {
"$ref": "Order"
},
"type": "array"
},
"nextPageToken": {
"description": "The token for the retrieval of the next page of orders.",
"type": "string"
}
},
"type": "object"
},
"DatafeedFormat": {
"properties": {
"columnDelimiter": {
"description": "Delimiter for the separation of values in a delimiter-separated values feed. If not specified, the delimiter will be auto-detected. Ignored for non-DSV data feeds. Acceptable values are: - \"`pipe`\" - \"`tab`\" - \"`tilde`\" ",
"type": "string"
},
"fileEncoding": {
"description": "Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected. Acceptable values are: - \"`latin-1`\" - \"`utf-16be`\" - \"`utf-16le`\" - \"`utf-8`\" - \"`windows-1252`\" ",
"type": "string"
},
"quotingMode": {
"description": "Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds. Acceptable values are: - \"`normal character`\" - \"`value quoting`\" ",
"type": "string"
}
},
"type": "object",
"id": "DatafeedFormat"
},
"DatafeedsCustomBatchResponseEntry": {
"properties": {
"batchId": {
"type": "integer",
"format": "uint32",
"description": "The ID of the request entry this entry responds to."
},
"datafeed": {
"description": "The requested data feed. Defined if and only if the request was successful.",
"$ref": "Datafeed"
},
"errors": {
"$ref": "Errors",
"description": "A list of errors defined if and only if the request failed."
}
},
"id": "DatafeedsCustomBatchResponseEntry",
"type": "object",
"description": "A batch entry encoding a single non-batch datafeeds response."
},
"OrderreturnsPartialRefund": {
"type": "object",
"id": "OrderreturnsPartialRefund",
"properties": {
"priceAmount": {
"description": "The pre-tax or post-tax amount to be refunded, depending on the location of the order.",
"$ref": "Price"
},
"taxAmount": {
"description": "Tax amount to be refunded. Note: This has different meaning depending on the location of the order.",
"$ref": "Price"
}
}
},
"OrdersCancelResponse": {
"id": "OrdersCancelResponse",
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersCancelResponse\"."
},
"executionStatus": {
"type": "string",
"description": "The status of the execution. Acceptable values are: - \"`duplicate`\" - \"`executed`\" "
}
}
},
"PosSale": {
"type": "object",
"properties": {
"storeCode": {
"type": "string",
"description": "Required. The identifier of the merchant's store. Either a `storeCode` inserted via the API or the code of the store in Google My Business."
},
"contentLanguage": {
"type": "string",
"description": "Required. The two-letter ISO 639-1 language code for the item."
},
"quantity": {
"format": "int64",
"description": "Required. The relative change of the available quantity. Negative for items returned.",
"type": "string"
},
"timestamp": {
"description": "Required. The inventory timestamp, in ISO 8601 format.",
"type": "string"
},
"saleId": {
"type": "string",
"description": "A unique ID to group items from the same sale event."
},
"targetCountry": {
"description": "Required. The CLDR territory code for the item.",
"type": "string"
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"`content#posSale`\"",
"type": "string"
},
"itemId": {
"description": "Required. A unique identifier for the item.",
"type": "string"
},
"price": {
"description": "Required. The price of the item.",
"$ref": "Price"
},
"gtin": {
"description": "Global Trade Item Number.",
"type": "string"
}
},
"description": "The change of the available quantity of an item at the given store.",
"id": "PosSale"
},
"ProductSubscriptionCost": {
"id": "ProductSubscriptionCost",
"type": "object",
"properties": {
"period": {
"description": "The type of subscription period.",
"type": "string"
},
"amount": {
"description": "The amount the buyer has to pay per subscription period.",
"$ref": "Price"
},
"periodLength": {
"type": "string",
"description": "The number of subscription periods the buyer has to pay.",
"format": "int64"
}
}
},
"OrderRefund": {
"id": "OrderRefund",
"type": "object",
"properties": {
"amount": {
"$ref": "Price",
"description": "The amount that is refunded."
},
"actor": {
"description": "The actor that created the refund. Acceptable values are: - \"`customer`\" - \"`googleBot`\" - \"`googleCustomerService`\" - \"`googlePayments`\" - \"`googleSabre`\" - \"`merchant`\" ",
"type": "string"
},
"creationDate": {
"description": "Date on which the item has been created, in ISO 8601 format.",
"type": "string"
},
"reason": {
"type": "string",
"description": "The reason for the refund. Acceptable values are: - \"`adjustment`\" - \"`autoPostInternal`\" - \"`autoPostInvalidBillingAddress`\" - \"`autoPostNoInventory`\" - \"`autoPostPriceError`\" - \"`autoPostUndeliverableShippingAddress`\" - \"`couponAbuse`\" - \"`courtesyAdjustment`\" - \"`customerCanceled`\" - \"`customerDiscretionaryReturn`\" - \"`customerInitiatedMerchantCancel`\" - \"`customerSupportRequested`\" - \"`deliveredLateByCarrier`\" - \"`deliveredTooLate`\" - \"`expiredItem`\" - \"`failToPushOrderGoogleError`\" - \"`failToPushOrderMerchantError`\" - \"`failToPushOrderMerchantFulfillmentError`\" - \"`failToPushOrderToMerchant`\" - \"`failToPushOrderToMerchantOutOfStock`\" - \"`feeAdjustment`\" - \"`invalidCoupon`\" - \"`lateShipmentCredit`\" - \"`malformedShippingAddress`\" - \"`merchantDidNotShipOnTime`\" - \"`noInventory`\" - \"`orderTimeout`\" - \"`other`\" - \"`paymentAbuse`\" - \"`paymentDeclined`\" - \"`priceAdjustment`\" - \"`priceError`\" - \"`productArrivedDamaged`\" - \"`productNotAsDescribed`\" - \"`promoReallocation`\" - \"`qualityNotAsExpected`\" - \"`returnRefundAbuse`\" - \"`shippingCostAdjustment`\" - \"`shippingPriceError`\" - \"`taxAdjustment`\" - \"`taxError`\" - \"`undeliverableShippingAddress`\" - \"`unsupportedPoBoxAddress`\" - \"`wrongProductShipped`\" "
},
"reasonText": {
"type": "string",
"description": "The explanation of the reason."
}
}
},
"ShipmentInvoiceLineItemInvoice": {
"properties": {
"shipmentUnitIds": {
"description": "[required] The shipment unit ID is assigned by the merchant and defines individual quantities within a line item. The same ID can be assigned to units that are the same while units that differ must be assigned a different ID (for example: free or promotional units).",
"items": {
"type": "string"
},
"type": "array"
},
"productId": {
"type": "string",
"description": "ID of the product. This is the REST ID used in the products service. Either lineItemId or productId must be set."
},
"unitInvoice": {
"$ref": "UnitInvoice",
"description": "[required] Invoice details for a single unit."
},
"lineItemId": {
"description": "ID of the line item. Either lineItemId or productId must be set.",
"type": "string"
}
},
"id": "ShipmentInvoiceLineItemInvoice",
"type": "object"
},
"AccountStatusItemLevelIssue": {
"properties": {
"description": {
"type": "string",
"description": "A short issue description in English."
},
"detail": {
"description": "A detailed issue description in English.",
"type": "string"
},
"numItems": {
"type": "string",
"format": "int64",
"description": "Number of items with this issue."
},
"documentation": {
"type": "string",
"description": "The URL of a web page to help with resolving this issue."
},
"servability": {
"description": "How this issue affects serving of the offer.",
"type": "string"
},
"code": {
"description": "The error code of the issue.",
"type": "string"
},
"attributeName": {
"type": "string",
"description": "The attribute's name, if the issue is caused by a single attribute."
},
"resolution": {
"type": "string",
"description": "Whether the issue can be resolved by the merchant."
}
},
"id": "AccountStatusItemLevelIssue",
"type": "object"
},
"ListRepricingRulesResponse": {
"type": "object",
"description": "Response message for the `ListRepricingRules` method.",
"properties": {
"nextPageToken": {
"description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.",
"type": "string"
},
"repricingRules": {
"type": "array",
"description": "The rules from the specified merchant.",
"items": {
"$ref": "RepricingRule"
}
}
},
"id": "ListRepricingRulesResponse"
},
"OrdersAcknowledgeRequest": {
"properties": {
"operationId": {
"description": "The ID of the operation. Unique across all operations for a given order.",
"type": "string"
}
},
"id": "OrdersAcknowledgeRequest",
"type": "object"
},
"AccountsCustomBatchRequestEntry": {
"properties": {
"labelIds": {
"description": "Label IDs for the 'updatelabels' request.",
"type": "array",
"items": {
"type": "string",
"format": "uint64"
}
},
"force": {
"description": "Whether the account should be deleted if the account has offers. Only applicable if the method is `delete`.",
"type": "boolean"
},
"batchId": {
"type": "integer",
"format": "uint32",
"description": "An entry ID, unique within the batch request."
},
"linkRequest": {
"description": "Details about the `link` request.",
"$ref": "AccountsCustomBatchRequestEntryLinkRequest"
},
"method": {
"type": "string",
"description": "The method of the batch entry. Acceptable values are: - \"`claimWebsite`\" - \"`delete`\" - \"`get`\" - \"`insert`\" - \"`link`\" - \"`update`\" "
},
"view": {
"type": "string",
"description": "Controls which fields are visible. Only applicable if the method is 'get'."
},
"account": {
"description": "The account to create or update. Only defined if the method is `insert` or `update`.",
"$ref": "Account"
},
"merchantId": {
"description": "The ID of the managing account.",
"type": "string",
"format": "uint64"
},
"overwrite": {
"description": "Only applicable if the method is `claimwebsite`. Indicates whether or not to take the claim from another account in case there is a conflict.",
"type": "boolean"
},
"accountId": {
"description": "The ID of the targeted account. Only defined if the method is not `insert`.",
"type": "string",
"format": "uint64"
}
},
"description": "A batch entry encoding a single non-batch accounts request.",
"id": "AccountsCustomBatchRequestEntry",
"type": "object"
},
"DatafeedStatusError": {
"properties": {
"code": {
"type": "string",
"description": "The code of the error, e.g., \"validation/invalid_value\"."
},
"examples": {
"description": "A list of example occurrences of the error, grouped by product.",
"type": "array",
"items": {
"$ref": "DatafeedStatusExample"
}
},
"count": {
"format": "uint64",
"description": "The number of occurrences of the error in the feed.",
"type": "string"
},
"message": {
"description": "The error message, e.g., \"Invalid price\".",
"type": "string"
}
},
"type": "object",
"id": "DatafeedStatusError",
"description": "An error occurring in the feed, like \"invalid price\"."
},
"ReturnpolicyCustomBatchRequest": {
"properties": {
"entries": {
"description": "The request entries to be processed in the batch.",
"items": {
"$ref": "ReturnpolicyCustomBatchRequestEntry"
},
"type": "array"
}
},
"type": "object",
"id": "ReturnpolicyCustomBatchRequest"
},
"OrderCustomerLoyaltyInfo": {
"properties": {
"name": {
"type": "string",
"description": "Name of card/membership holder, this field will be populated when"
},
"loyaltyNumber": {
"type": "string",
"description": "The loyalty card/membership number."
}
},
"id": "OrderCustomerLoyaltyInfo",
"type": "object"
},
"AccountStatusStatistics": {
"type": "object",
"id": "AccountStatusStatistics",
"properties": {
"pending": {
"description": "Number of pending offers.",
"format": "int64",
"type": "string"
},
"expiring": {
"type": "string",
"description": "Number of expiring offers.",
"format": "int64"
},
"active": {
"format": "int64",
"description": "Number of active offers.",
"type": "string"
},
"disapproved": {
"format": "int64",
"type": "string",
"description": "Number of disapproved offers."
}
}
},
"OrderreturnsProcessResponse": {
"id": "OrderreturnsProcessResponse",
"properties": {
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#orderreturnsProcessResponse\".",
"type": "string"
},
"executionStatus": {
"description": "The status of the execution. Acceptable values are: - \"`duplicate`\" - \"`executed`\" ",
"type": "string"
}
},
"type": "object"
},
"OrderTrackingSignalShippingInfo": {
"description": "The shipping information for the order.",
"properties": {
"originPostalCode": {
"description": "The origin postal code, as a continuous string without spaces or dashes, e.g. \"95016\".",
"type": "string"
},
"originRegionCode": {
"type": "string",
"description": "The [CLDR territory code] (http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) for the shipping origin."
},
"earliestDeliveryPromiseTime": {
"description": "The earliest delivery promised time. Include the year and timezone string, if available. This field is required, if one of the following fields is absent: tracking_id or carrier_name.",
"$ref": "DateTime"
},
"actualDeliveryTime": {
"$ref": "DateTime",
"description": "The time when the shipment was actually delivered. Include the year and timezone string, if available. This field is required, if one of the following fields is absent: tracking_id or carrier_name."
},
"shippingStatus": {
"type": "string",
"enumDescriptions": [
"The shipping status is not known to merchant.",
"All items are shipped.",
"The shipment is already delivered."
],
"enum": [
"SHIPPING_STATE_UNSPECIFIED",
"SHIPPED",
"DELIVERED"
],
"description": "The status of the shipment."
},
"carrierName": {
"description": "The name of the shipping carrier for the delivery. This field is required if one of the following fields is absent: earliest_delivery_promise_time, latest_delivery_promise_time, and actual_delivery_time.",
"type": "string"
},
"trackingId": {
"type": "string",
"description": "The tracking ID of the shipment. This field is required if one of the following fields is absent: earliest_delivery_promise_time, latest_delivery_promise_time, and actual_delivery_time."
},
"carrierServiceName": {
"type": "string",
"description": "The service type for fulfillment, e.g., GROUND, FIRST_CLASS, etc."
},
"shippedTime": {
"$ref": "DateTime",
"description": "The time when the shipment was shipped. Include the year and timezone string, if available."
},
"latestDeliveryPromiseTime": {
"description": "The latest delivery promised time. Include the year and timezone string, if available. This field is required, if one of the following fields is absent: tracking_id or carrier_name.",
"$ref": "DateTime"
},
"shipmentId": {
"type": "string",
"description": "Required. The shipment ID."
}
},
"type": "object",
"id": "OrderTrackingSignalShippingInfo"
},
"GmbAccounts": {
"id": "GmbAccounts",
"properties": {
"gmbAccounts": {
"description": "A list of GMB accounts which are available to the merchant.",
"type": "array",
"items": {
"$ref": "GmbAccountsGmbAccount"
}
},
"accountId": {
"format": "uint64",
"description": "The ID of the Merchant Center account.",
"type": "string"
}
},
"type": "object"
},
"Amount": {
"id": "Amount",
"properties": {
"priceAmount": {
"description": "[required] The pre-tax or post-tax price depending on the location of the order.",
"$ref": "Price"
},
"taxAmount": {
"$ref": "Price",
"description": "[required] Tax value."
}
},
"type": "object"
},
"RepricingRuleRestriction": {
"properties": {
"floor": {
"description": "The inclusive floor lower bound. The repricing rule only applies when new price \u003e= floor.",
"$ref": "RepricingRuleRestrictionBoundary"
},
"useAutoPricingMinPrice": {
"type": "boolean",
"description": "If true, use the AUTO_PRICING_MIN_PRICE offer attribute as the lower bound of the rule. If use_auto_pricing_min_price is true, then only offers with `AUTO_PRICING_MIN_PRICE` existing on the offer will get Repricer treatment, even if a floor value is set on the rule. Also, if use_auto_pricing_min_price is true, the floor restriction will be ignored."
}
},
"id": "RepricingRuleRestriction",
"type": "object",
"description": "Definition of a rule restriction. At least one of the following needs to be true: (1) use_auto_pricing_min_price is true (2) floor.price_delta exists (3) floor.percentage_delta exists If floor.price_delta and floor.percentage_delta are both set on a rule, the highest value will be chosen by the Repricer. In other words, for a product with a price of $50, if the `floor.percentage_delta` is \"-10\" and the floor.price_delta is \"-12\", the offer price will only be lowered $5 (10% lower than the original offer price)."
},
"PosDataProvidersPosDataProvider": {
"type": "object",
"id": "PosDataProvidersPosDataProvider",
"properties": {
"fullName": {
"type": "string",
"description": "The full name of this POS data Provider."
},
"providerId": {
"format": "uint64",
"type": "string",
"description": "The ID of the account."
},
"displayName": {
"description": "The display name of Pos data Provider.",
"type": "string"
}
}
},
"OrderreturnsLineItem": {
"properties": {
"quantity": {
"format": "uint32",
"type": "integer",
"description": "The quantity of this line item."
},
"lineItemId": {
"description": "The ID of the line item. This value is assigned by Google when an order is created.",
"type": "string"
}
},
"type": "object",
"id": "OrderreturnsLineItem"
},
"RepricingProductReportBuyboxWinningProductStats": {
"type": "object",
"properties": {
"buyboxWinsCount": {
"description": "Number of times this product won the buybox with these rules during this time period.",
"format": "int32",
"type": "integer"
}
},
"description": "Stats specific to buybox winning rules for product report.",
"id": "RepricingProductReportBuyboxWinningProductStats"
},
"AccountUser": {
"properties": {
"admin": {
"type": "boolean",
"description": "Whether user is an admin."
},
"orderManager": {
"type": "boolean",
"description": "Whether user is an order manager."
},
"paymentsAnalyst": {
"description": "Whether user can access payment statements.",
"type": "boolean"
},
"emailAddress": {
"description": "User's email address.",
"type": "string"
},
"paymentsManager": {
"type": "boolean",
"description": "Whether user can manage payment settings."
}
},
"type": "object",
"id": "AccountUser"
},
"ReturnpolicyCustomBatchResponse": {
"id": "ReturnpolicyCustomBatchResponse",
"type": "object",
"properties": {
"entries": {
"type": "array",
"items": {
"$ref": "ReturnpolicyCustomBatchResponseEntry"
},
"description": "The result of the execution of the batch requests."
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#returnpolicyCustomBatchResponse\".",
"type": "string"
}
}
},
"OrderLineItemShippingDetails": {
"id": "OrderLineItemShippingDetails",
"type": "object",
"properties": {
"method": {
"description": "Required. Details of the shipping method.",
"$ref": "OrderLineItemShippingDetailsMethod"
},
"pickupPromiseInMinutes": {
"format": "uint32",
"description": "The promised time in minutes in which the order will be ready for pickup. This only applies to buy-online-pickup-in-store same-day order.",
"type": "integer"
},
"deliverByDate": {
"type": "string",
"description": "Required. The delivery by date, in ISO 8601 format."
},
"type": {
"type": "string",
"description": "Type of shipment. Indicates whether `deliveryDetails` or `pickupDetails` is applicable for this shipment. Acceptable values are: - \"`delivery`\" - \"`pickup`\" "
},
"shipByDate": {
"description": "Required. The ship by date, in ISO 8601 format.",
"type": "string"
}
}
},
"ShippingsettingsGetSupportedHolidaysResponse": {
"properties": {
"holidays": {
"description": "A list of holidays applicable for delivery guarantees. May be empty.",
"type": "array",
"items": {
"$ref": "HolidaysHoliday"
}
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#shippingsettingsGetSupportedHolidaysResponse\".",
"type": "string"
}
},
"id": "ShippingsettingsGetSupportedHolidaysResponse",
"type": "object"
},
"ReturnPolicyOnlineRestockingFee": {
"description": "The restocking fee. This can either be a fixed fee or a micro percent.",
"type": "object",
"properties": {
"fixedFee": {
"description": "Fixed restocking fee.",
"$ref": "PriceAmount"
},
"microPercent": {
"type": "integer",
"description": "Percent of total price in micros. 15,000,000 means 15% of the total price would be charged.",
"format": "int32"
}
},
"id": "ReturnPolicyOnlineRestockingFee"
},
"SearchResponse": {
"id": "SearchResponse",
"type": "object",
"properties": {
"nextPageToken": {
"type": "string",
"description": "Token which can be sent as `page_token` to retrieve the next page. If omitted, there are no subsequent pages."
},
"results": {
"description": "Rows that matched the search query.",
"type": "array",
"items": {
"$ref": "ReportRow"
}
}
},
"description": "Response message for the ReportService.Search method."
},
"DatafeedstatusesCustomBatchResponse": {
"type": "object",
"id": "DatafeedstatusesCustomBatchResponse",
"properties": {
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#datafeedstatusesCustomBatchResponse\".",
"type": "string"
},
"entries": {
"description": "The result of the execution of the batch requests.",
"items": {
"$ref": "DatafeedstatusesCustomBatchResponseEntry"
},
"type": "array"
}
}
},
"RegionGeoTargetArea": {
"description": "A list of geotargets that defines the region area.",
"properties": {
"geotargetCriteriaIds": {
"type": "array",
"description": "Required. A non-empty list of [location IDs](https://developers.google.com/adwords/api/docs/appendix/geotargeting). They must all be of the same location type (e.g., state).",
"items": {
"format": "int64",
"type": "string"
}
}
},
"id": "RegionGeoTargetArea",
"type": "object"
},
"OrdersInStoreRefundLineItemRequest": {
"id": "OrdersInStoreRefundLineItemRequest",
"properties": {
"taxAmount": {
"$ref": "Price",
"description": "The amount of tax to be refunded. Required."
},
"reason": {
"description": "The reason for the return. Acceptable values are: - \"`customerDiscretionaryReturn`\" - \"`customerInitiatedMerchantCancel`\" - \"`deliveredTooLate`\" - \"`expiredItem`\" - \"`invalidCoupon`\" - \"`malformedShippingAddress`\" - \"`other`\" - \"`productArrivedDamaged`\" - \"`productNotAsDescribed`\" - \"`qualityNotAsExpected`\" - \"`undeliverableShippingAddress`\" - \"`unsupportedPoBoxAddress`\" - \"`wrongProductShipped`\" ",
"type": "string"
},
"reasonText": {
"description": "The explanation of the reason.",
"type": "string"
},
"productId": {
"description": "The ID of the product to return. This is the REST ID used in the products service. Either lineItemId or productId is required.",
"type": "string"
},
"priceAmount": {
"description": "The amount to be refunded. This may be pre-tax or post-tax depending on the location of the order. Required.",
"$ref": "Price"
},
"lineItemId": {
"type": "string",
"description": "The ID of the line item to return. Either lineItemId or productId is required."
},
"quantity": {
"type": "integer",
"description": "The quantity to return and refund.",
"format": "uint32"
},
"operationId": {
"description": "The ID of the operation. Unique across all operations for a given order.",
"type": "string"
}
},
"type": "object"
},
"DatafeedsCustomBatchRequest": {
"properties": {
"entries": {
"items": {
"$ref": "DatafeedsCustomBatchRequestEntry"
},
"description": "The request entries to be processed in the batch.",
"type": "array"
}
},
"type": "object",
"id": "DatafeedsCustomBatchRequest"
},
"OrdersGetTestOrderTemplateResponse": {
"id": "OrdersGetTestOrderTemplateResponse",
"properties": {
"template": {
"description": "The requested test order template.",
"$ref": "TestOrder"
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersGetTestOrderTemplateResponse\"."
}
},
"type": "object"
},
"AccountstatusesCustomBatchResponse": {
"type": "object",
"id": "AccountstatusesCustomBatchResponse",
"properties": {
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#accountstatusesCustomBatchResponse\"."
},
"entries": {
"type": "array",
"description": "The result of the execution of the batch requests.",
"items": {
"$ref": "AccountstatusesCustomBatchResponseEntry"
}
}
}
},
"OrderLineItemProductVariantAttribute": {
"properties": {
"value": {
"description": "The value for the dimension.",
"type": "string"
},
"dimension": {
"description": "The dimension of the variant.",
"type": "string"
}
},
"type": "object",
"id": "OrderLineItemProductVariantAttribute"
},
"Collection": {
"id": "Collection",
"type": "object",
"description": "The collection message.",
"properties": {
"link": {
"type": "string",
"description": "A collection’s landing page. URL directly linking to your collection's page on your website. [link attribute](https://support.google.com/merchants/answer/9673983)"
},
"customLabel1": {
"type": "string",
"description": "Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns."
},
"customLabel2": {
"description": "Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns.",
"type": "string"
},
"headline": {
"description": "Your collection's name. [headline attribute](https://support.google.com/merchants/answer/9673580)",
"type": "array",
"items": {
"type": "string"
}
},
"customLabel4": {
"description": "Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns.",
"type": "string"
},
"mobileLink": {
"type": "string",
"description": "A collection’s mobile-optimized landing page when you have a different URL for mobile and desktop traffic. [mobile_link attribute](https://support.google.com/merchants/answer/9646123)"
},
"productCountry": {
"type": "string",
"description": "[product_country attribute](https://support.google.com/merchants/answer/9674155)"
},
"language": {
"type": "string",
"description": "The language of a collection and the language of any featured products linked to the collection. [language attribute](https://support.google.com/merchants/answer/9673781)"
},
"customLabel3": {
"description": "Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns.",
"type": "string"
},
"featuredProduct": {
"description": "This identifies one or more products associated with the collection. Used as a lookup to the corresponding product ID in your product feeds. Provide a maximum of 100 featuredProduct (for collections). Provide up to 10 featuredProduct (for Shoppable Images only) with ID and X and Y coordinates. [featured_product attribute](https://support.google.com/merchants/answer/9703736)",
"items": {
"$ref": "CollectionFeaturedProduct"
},
"type": "array"
},
"customLabel0": {
"type": "string",
"description": "Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns. [Custom label](https://support.google.com/merchants/answer/9674217)"
},
"id": {
"type": "string",
"description": "Required. The REST ID of the collection. Content API methods that operate on collections take this as their collectionId parameter. The REST ID for a collection is of the form collectionId. [id attribute](https://support.google.com/merchants/answer/9649290)"
},
"imageLink": {
"items": {
"type": "string"
},
"type": "array",
"description": "The URL of a collection’s image. [image_link attribute](https://support.google.com/merchants/answer/9703236)"
}
}
},
"Product": {
"properties": {
"sizeType": {
"type": "string",
"description": "The cut of the item. Recommended for apparel items."
},
"adult": {
"description": "Should be set to true if the item is targeted towards adults.",
"type": "boolean"
},
"customLabel1": {
"description": "Custom label 1 for custom grouping of items in a Shopping campaign.",
"type": "string"
},
"shippingWidth": {
"description": "Width of the item for shipping.",
"$ref": "ProductShippingDimension"
},
"salePrice": {
"description": "Advertised sale price of the item.",
"$ref": "Price"
},
"gtin": {
"type": "string",
"description": "Global Trade Item Number (GTIN) of the item."
},
"adsLabels": {
"description": "Similar to ads_grouping, but only works on CPC.",
"type": "array",
"items": {
"type": "string"
}
},
"taxes": {
"type": "array",
"items": {
"$ref": "ProductTax"
},
"description": "Tax information."
},
"itemGroupId": {
"description": "Shared identifier for all variants of the same product.",
"type": "string"
},
"id": {
"type": "string",
"description": "The REST ID of the product. Content API methods that operate on products take this as their `productId` parameter. The REST ID for a product is of the form channel:contentLanguage: targetCountry: offerId."
},
"shipping": {
"items": {
"$ref": "ProductShipping"
},
"description": "Shipping rules.",
"type": "array"
},
"customAttributes": {
"items": {
"$ref": "CustomAttribute"
},
"description": "A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the feed specification in its generic form (e.g., `{ \"name\": \"size type\", \"value\": \"regular\" }`). This is useful for submitting attributes not explicitly exposed by the API, such as additional attributes used for Buy on Google (formerly known as Shopping Actions).",
"type": "array"
},
"gender": {
"type": "string",
"description": "Target gender of the item."
},
"displayAdsValue": {
"type": "number",
"description": "Offer margin for dynamic remarketing campaigns.",
"format": "double"
},
"pattern": {
"type": "string",
"description": "The item's pattern (e.g. polka dots)."
},
"ageGroup": {
"description": "Target age group of the item.",
"type": "string"
},
"isBundle": {
"type": "boolean",
"description": "Whether the item is a merchant-defined bundle. A bundle is a custom grouping of different products sold by a merchant for a single price."
},
"offerId": {
"description": "Required. A unique identifier for the item. Leading and trailing whitespaces are stripped and multiple whitespaces are replaced by a single whitespace upon submission. Only valid unicode characters are accepted. See the products feed specification for details. *Note:* Content API methods that operate on products take the REST ID of the product, *not* this identifier.",
"type": "string"
},
"sizeSystem": {
"type": "string",
"description": "System in which the size is specified. Recommended for apparel items."
},
"mobileLink": {
"type": "string",
"description": "URL for the mobile-optimized version of your item's landing page."
},
"additionalImageLinks": {
"type": "array",
"items": {
"type": "string"
},
"description": "Additional URLs of images of the item."
},
"targetCountry": {
"type": "string",
"description": "Required. The CLDR territory code for the item."
},
"mpn": {
"type": "string",
"description": "Manufacturer Part Number (MPN) of the item."
},
"subscriptionCost": {
"$ref": "ProductSubscriptionCost",
"description": "Number of periods (months or years) and amount of payment per period for an item with an associated subscription contract."
},
"sellOnGoogleQuantity": {
"type": "string",
"description": "The quantity of the product that is available for selling on Google. Supported only for online products.",
"format": "int64"
},
"shippingLabel": {
"type": "string",
"description": "The shipping label of the product, used to group product in account-level shipping rules."
},
"availability": {
"description": "Availability status of the item.",
"type": "string"
},
"customLabel3": {
"description": "Custom label 3 for custom grouping of items in a Shopping campaign.",
"type": "string"
},
"loyaltyPoints": {
"$ref": "LoyaltyPoints",
"description": "Loyalty points that users receive after purchasing the item. Japan only."
},
"availabilityDate": {
"type": "string",
"description": "The day a pre-ordered product becomes available for delivery, in ISO 8601 format."
},
"channel": {
"description": "Required. The item's channel (online or local). Acceptable values are: - \"`local`\" - \"`online`\" ",
"type": "string"
},
"promotionIds": {
"description": "The unique ID of a promotion.",
"type": "array",
"items": {
"type": "string"
}
},
"brand": {
"type": "string",
"description": "Brand of the item."
},
"adsGrouping": {
"description": "Used to group items in an arbitrary way. Only for CPA%, discouraged otherwise.",
"type": "string"
},
"includedDestinations": {
"type": "array",
"description": "The list of destinations to include for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in `excludedDestinations`.",
"items": {
"type": "string"
}
},
"customLabel2": {
"type": "string",
"description": "Custom label 2 for custom grouping of items in a Shopping campaign."
},
"additionalSizeType": {
"description": "Additional cut of the item. Used together with size_type to represent combined size types for apparel items.",
"type": "string"
},
"identifierExists": {
"type": "boolean",
"description": "False when the item does not have unique product identifiers appropriate to its category, such as GTIN, MPN, and brand. Required according to the Unique Product Identifier Rules for all target countries except for Canada."
},
"sizes": {
"type": "array",
"items": {
"type": "string"
},
"description": "Size of the item. Only one value is allowed. For variants with different sizes, insert a separate product for each size with the same `itemGroupId` value (see size definition)."
},
"shippingHeight": {
"$ref": "ProductShippingDimension",
"description": "Height of the item for shipping."
},
"displayAdsLink": {
"description": "URL directly to your item's landing page for dynamic remarketing campaigns.",
"type": "string"
},
"unitPricingBaseMeasure": {
"description": "The preference of the denominator of the unit price.",
"$ref": "ProductUnitPricingBaseMeasure"
},
"displayAdsSimilarIds": {
"items": {
"type": "string"
},
"type": "array",
"description": "Advertiser-specified recommendations."
},
"imageLink": {
"description": "URL of an image of the item.",
"type": "string"
},
"shoppingAdsExcludedCountries": {
"items": {
"type": "string"
},
"description": "List of country codes (ISO 3166-1 alpha-2) to exclude the offer from Shopping Ads destination. Countries from this list are removed from countries configured in MC feed settings.",
"type": "array"
},
"multipack": {
"description": "The number of identical products in a merchant-defined multipack.",
"type": "string",
"format": "int64"
},
"link": {
"description": "URL directly linking to your item's page on your website.",
"type": "string"
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"`content#product`\""
},
"adsRedirect": {
"type": "string",
"description": "Allows advertisers to override the item URL when the product is shown within the context of Product Ads."
},
"costOfGoodsSold": {
"description": "Cost of goods sold. Used for gross profit reporting.",
"$ref": "Price"
},
"expirationDate": {
"type": "string",
"description": "Date on which the item should expire, as specified upon insertion, in ISO 8601 format. The actual expiration date in Google Shopping is exposed in `productstatuses` as `googleExpirationDate` and might be earlier if `expirationDate` is too far in the future."
},
"shippingWeight": {
"description": "Weight of the item for shipping.",
"$ref": "ProductShippingWeight"
},
"minEnergyEfficiencyClass": {
"type": "string",
"description": "The energy efficiency class as defined in EU directive 2010/30/EU."
},
"taxCategory": {
"description": "The tax category of the product, used to configure detailed tax nexus in account-level tax settings.",
"type": "string"
},
"color": {
"type": "string",
"description": "Color of the item."
},
"transitTimeLabel": {
"description": "The transit time label of the product, used to group product in account-level transit time tables.",
"type": "string"
},
"source": {
"type": "string",
"description": "The source of the offer, i.e., how the offer was created. Acceptable values are: - \"`api`\" - \"`crawl`\" - \"`feed`\" "
},
"salePriceEffectiveDate": {
"type": "string",
"description": "Date range during which the item is on sale (see products data specification )."
},
"price": {
"description": "Price of the item.",
"$ref": "Price"
},
"installment": {
"$ref": "Installment",
"description": "Number and amount of installments to pay for an item."
},
"customLabel0": {
"description": "Custom label 0 for custom grouping of items in a Shopping campaign.",
"type": "string"
},
"minHandlingTime": {
"description": "Minimal product handling time (in business days).",
"format": "int64",
"type": "string"
},
"condition": {
"description": "Condition or state of the item.",
"type": "string"
},
"maxHandlingTime": {
"format": "int64",
"description": "Maximal product handling time (in business days).",
"type": "string"
},
"maxEnergyEfficiencyClass": {
"type": "string",
"description": "The energy efficiency class as defined in EU directive 2010/30/EU."
},
"productDetails": {
"items": {
"$ref": "ProductProductDetail"
},
"description": "Technical specification or additional product details.",
"type": "array"
},
"description": {
"description": "Description of the item.",
"type": "string"
},
"displayAdsId": {
"description": "An identifier for an item for dynamic remarketing campaigns.",
"type": "string"
},
"material": {
"description": "The material of which the item is made.",
"type": "string"
},
"unitPricingMeasure": {
"$ref": "ProductUnitPricingMeasure",
"description": "The measure and dimension of an item."
},
"productTypes": {
"type": "array",
"description": "Categories of the item (formatted as in products data specification).",
"items": {
"type": "string"
}
},
"productHighlights": {
"type": "array",
"description": "Bullet points describing the most relevant highlights of a product.",
"items": {
"type": "string"
}
},
"customLabel4": {
"description": "Custom label 4 for custom grouping of items in a Shopping campaign.",
"type": "string"
},
"shippingLength": {
"description": "Length of the item for shipping.",
"$ref": "ProductShippingDimension"
},
"title": {
"type": "string",
"description": "Title of the item."
},
"contentLanguage": {
"type": "string",
"description": "Required. The two-letter ISO 639-1 language code for the item."
},
"excludedDestinations": {
"items": {
"type": "string"
},
"description": "The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center).",
"type": "array"
},
"googleProductCategory": {
"type": "string",
"description": "Google's category of the item (see [Google product taxonomy](https://support.google.com/merchants/answer/1705911)). When querying products, this field will contain the user provided value. There is currently no way to get back the auto assigned google product categories through the API."
},
"displayAdsTitle": {
"description": "Title of an item for dynamic remarketing campaigns.",
"type": "string"
},
"energyEfficiencyClass": {
"description": "The energy efficiency class as defined in EU directive 2010/30/EU.",
"type": "string"
},
"canonicalLink": {
"type": "string",
"description": "URL for the canonical version of your item's landing page."
}
},
"description": " Required product attributes are primarily defined by the products data specification. See the Products Data Specification Help Center article for information. Some attributes are country-specific, so make sure you select the appropriate country in the drop-down selector at the top of the page. Product data. After inserting, updating, or deleting a product, it may take several minutes before changes take effect.",
"type": "object",
"id": "Product"
},
"ProductstatusesCustomBatchResponseEntry": {
"properties": {
"errors": {
"description": "A list of errors, if the request failed.",
"$ref": "Errors"
},
"productStatus": {
"$ref": "ProductStatus",
"description": "The requested product status. Only defined if the request was successful."
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"`content#productstatusesCustomBatchResponseEntry`\""
},
"batchId": {
"format": "uint32",
"type": "integer",
"description": "The ID of the request entry this entry responds to."
}
},
"type": "object",
"id": "ProductstatusesCustomBatchResponseEntry",
"description": "A batch entry encoding a single non-batch productstatuses response."
},
"ReturnPolicyOnlineReturnShippingFee": {
"properties": {
"type": {
"enumDescriptions": [
"Default value. This value is unused.",
"The return shipping fee is a fixed value.",
"Customer will pay the actual return shipping fee."
],
"description": "Type of return shipping fee.",
"type": "string",
"enum": [
"TYPE_UNSPECIFIED",
"FIXED",
"CUSTOMER_PAYING_ACTUAL_FEE"
]
},
"fixedFee": {
"description": "Fixed return shipping fee amount. This value is only applicable when type is FIXED. We will treat the return shipping fee as free if type is FIXED and this value is not set.",
"$ref": "PriceAmount"
}
},
"description": "The return shipping fee. This can either be a fixed fee or a boolean to indicate that the customer pays the actual shipping cost.",
"id": "ReturnPolicyOnlineReturnShippingFee",
"type": "object"
},
"RegionalinventoryCustomBatchRequestEntry": {
"id": "RegionalinventoryCustomBatchRequestEntry",
"type": "object",
"description": "A batch entry encoding a single non-batch regional inventory request.",
"properties": {
"batchId": {
"description": "An entry ID, unique within the batch request.",
"format": "uint32",
"type": "integer"
},
"method": {
"description": "Method of the batch request entry. Acceptable values are: - \"`insert`\" ",
"type": "string"
},
"merchantId": {
"format": "uint64",
"type": "string",
"description": "The ID of the managing account."
},
"regionalInventory": {
"$ref": "RegionalInventory",
"description": "Price and availability of the product."
},
"productId": {
"description": "The ID of the product for which to update price and availability.",
"type": "string"
}
}
},
"ReturnPolicyOnlinePolicy": {
"id": "ReturnPolicyOnlinePolicy",
"properties": {
"type": {
"description": "Policy type.",
"enumDescriptions": [
"Default value. This value is unused.",
"Number of days after a return is delivered.",
"No returns.",
"Life time returns."
],
"enum": [
"TYPE_UNSPECIFIED",
"NUMBER_OF_DAYS_AFTER_DELIVERY",
"NO_RETURNS",
"LIFETIME_RETURNS"
],
"type": "string"
},
"days": {
"format": "int64",
"description": "The number of days items can be returned after delivery, where one day is defined to be 24 hours after the delivery timestamp. Required for `numberOfDaysAfterDelivery` returns.",
"type": "string"
}
},
"type": "object",
"description": "The available policies."
},
"OrdersCancelTestOrderByCustomerRequest": {
"type": "object",
"id": "OrdersCancelTestOrderByCustomerRequest",
"properties": {
"reason": {
"type": "string",
"description": "The reason for the cancellation. Acceptable values are: - \"`changedMind`\" - \"`orderedWrongItem`\" - \"`other`\" "
}
}
},
"ReturnPolicyOnline": {
"properties": {
"returnMethods": {
"items": {
"enum": [
"RETURN_METHOD_UNSPECIFIED",
"BY_MAIL",
"IN_STORE",
"AT_A_KIOSK"
],
"type": "string",
"enumDescriptions": [
"Default value. This value is unused.",
"By mail.",
"In store.",
"At a kiosk."
]
},
"type": "array",
"description": "The return methods of how customers can return an item. This value is required to not be empty unless the type of return policy is noReturns."
},
"label": {
"description": "The unique user-defined label of the return policy. The same label cannot be used in different return policies for the same country. Policies with the label 'default' will apply to all products, unless a product specifies a return_policy_label attribute.",
"type": "string"
},
"name": {
"description": "The name of the policy as shown in Merchant Center.",
"type": "string"
},
"countries": {
"type": "array",
"description": "The countries of sale where the return policy is applicable. The values must be a valid 2 letter ISO 3166 code, e.g. \"US\".",
"items": {
"type": "string"
}
},
"returnPolicyUri": {
"description": "The return policy uri. This can used by Google to do a sanity check for the policy.",
"type": "string"
},
"returnReasonCategoryInfo": {
"items": {
"$ref": "ReturnPolicyOnlineReturnReasonCategoryInfo"
},
"type": "array",
"description": "The return reason category information. This required to not be empty unless the type of return policy is noReturns."
},
"returnPolicyId": {
"readOnly": true,
"description": "Output only. Return policy ID generated by Google.",
"type": "string"
},
"policy": {
"$ref": "ReturnPolicyOnlinePolicy",
"description": "The return policy."
},
"itemConditions": {
"type": "array",
"description": "The item conditions that are accepted for returns. This is required to not be empty unless the type of return policy is noReturns.",
"items": {
"enum": [
"ITEM_CONDITION_UNSPECIFIED",
"NEW",
"USED"
],
"type": "string",
"enumDescriptions": [
"Default value. This value is unused.",
"New.",
"Used."
]
}
},
"restockingFee": {
"description": "The restocking fee that applies to all return reason categories. This would be treated as a free restocking fee if the value is not set.",
"$ref": "ReturnPolicyOnlineRestockingFee"
}
},
"type": "object",
"description": "Return policy online object. This is currently used to represent return policies for ads and free listings programs.",
"id": "ReturnPolicyOnline"
},
"OrderPickupDetailsCollector": {
"id": "OrderPickupDetailsCollector",
"properties": {
"name": {
"type": "string",
"description": "Name of the person picking up the shipment."
},
"phoneNumber": {
"type": "string",
"description": "Phone number of the person picking up the shipment."
}
},
"type": "object"
},
"DatafeedstatusesListResponse": {
"id": "DatafeedstatusesListResponse",
"properties": {
"resources": {
"items": {
"$ref": "DatafeedStatus"
},
"type": "array"
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#datafeedstatusesListResponse\"."
},
"nextPageToken": {
"type": "string",
"description": "The token for the retrieval of the next page of datafeed statuses."
}
},
"type": "object"
},
"ProductstatusesCustomBatchResponse": {
"type": "object",
"id": "ProductstatusesCustomBatchResponse",
"properties": {
"entries": {
"description": "The result of the execution of the batch requests.",
"items": {
"$ref": "ProductstatusesCustomBatchResponseEntry"
},
"type": "array"
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#productstatusesCustomBatchResponse\".",
"type": "string"
}
}
},
"Region": {
"description": "Represents a geographic region that you can use as a target with both the `RegionalInventory` and `ShippingSettings` services. You can define regions as collections of either postal codes or, in some countries, using predefined geotargets.",
"type": "object",
"id": "Region",
"properties": {
"regionalInventoryEligible": {
"readOnly": true,
"type": "boolean",
"description": "Output only. Indicates if the region is eligible to use in the Regional Inventory configuration."
},
"shippingEligible": {
"type": "boolean",
"description": "Output only. Indicates if the region is eligible to use in the Shipping Services configuration.",
"readOnly": true
},
"regionId": {
"type": "string",
"readOnly": true,
"description": "Output only. Immutable. The ID uniquely identifying each region."
},
"displayName": {
"type": "string",
"description": "The display name of the region."
},
"geotargetArea": {
"description": "A list of geotargets that defines the region area.",
"$ref": "RegionGeoTargetArea"
},
"merchantId": {
"readOnly": true,
"description": "Output only. Immutable. Merchant that owns the region.",
"type": "string",
"format": "int64"
},
"postalCodeArea": {
"description": "A list of postal codes that defines the region area.",
"$ref": "RegionPostalCodeArea"
}
}
},
"ReturnaddressCustomBatchRequest": {
"type": "object",
"properties": {
"entries": {
"type": "array",
"description": "The request entries to be processed in the batch.",
"items": {
"$ref": "ReturnaddressCustomBatchRequestEntry"
}
}
},
"id": "ReturnaddressCustomBatchRequest"
},
"LiasettingsCustomBatchRequest": {
"type": "object",
"properties": {
"entries": {
"description": "The request entries to be processed in the batch.",
"items": {
"$ref": "LiasettingsCustomBatchRequestEntry"
},
"type": "array"
}
},
"id": "LiasettingsCustomBatchRequest"
},
"UnitInvoiceAdditionalCharge": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "[required] Type of the additional charge. Acceptable values are: - \"`shipping`\" "
},
"additionalChargeAmount": {
"$ref": "Amount",
"description": "[required] Amount of the additional charge."
}
},
"id": "UnitInvoiceAdditionalCharge"
},
"GmbAccountsGmbAccount": {
"id": "GmbAccountsGmbAccount",
"type": "object",
"properties": {
"listingCount": {
"type": "string",
"description": "Number of listings under this account.",
"format": "uint64"
},
"name": {
"type": "string",
"description": "The name of the GMB account."
},
"email": {
"type": "string",
"description": "The email which identifies the GMB account."
},
"type": {
"type": "string",
"description": "The type of the GMB account (User or Business)."
}
}
},
"AccountStatus": {
"properties": {
"products": {
"items": {
"$ref": "AccountStatusProducts"
},
"type": "array",
"description": "List of product-related data by channel, destination, and country. Data in this field may be delayed by up to 30 minutes."
},
"accountId": {
"description": "The ID of the account for which the status is reported.",
"type": "string"
},
"accountLevelIssues": {
"type": "array",
"items": {
"$ref": "AccountStatusAccountLevelIssue"
},
"description": "A list of account level issues."
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"`content#accountStatus`\"",
"type": "string"
},
"websiteClaimed": {
"description": "Whether the account's website is claimed or not.",
"type": "boolean"
}
},
"description": "The status of an account, i.e., information about its products, which is computed offline and not returned immediately at insertion time.",
"type": "object",
"id": "AccountStatus"
},
"InvoiceSummaryAdditionalChargeSummary": {
"type": "object",
"properties": {
"totalAmount": {
"description": "[required] Total additional charge for this type.",
"$ref": "Amount"
},
"type": {
"type": "string",
"description": "[required] Type of the additional charge. Acceptable values are: - \"`shipping`\" "
}
},
"id": "InvoiceSummaryAdditionalChargeSummary"
},
"OrderShipmentLineItemShipment": {
"type": "object",
"id": "OrderShipmentLineItemShipment",
"properties": {
"quantity": {
"description": "The quantity that is shipped.",
"format": "uint32",
"type": "integer"
},
"lineItemId": {
"type": "string",
"description": "The ID of the line item that is shipped. This value is assigned by Google when an order is created. Either lineItemId or productId is required."
},
"productId": {
"description": "The ID of the product to ship. This is the REST ID used in the products service. Either lineItemId or productId is required.",
"type": "string"
}
}
},
"PosInventoryRequest": {
"properties": {
"quantity": {
"description": "Required. The available quantity of the item.",
"format": "int64",
"type": "string"
},
"contentLanguage": {
"type": "string",
"description": "Required. The two-letter ISO 639-1 language code for the item."
},
"price": {
"description": "Required. The current price of the item.",
"$ref": "Price"
},
"gtin": {
"type": "string",
"description": "Global Trade Item Number."
},
"itemId": {
"description": "Required. A unique identifier for the item.",
"type": "string"
},
"targetCountry": {
"description": "Required. The CLDR territory code for the item.",
"type": "string"
},
"storeCode": {
"type": "string",
"description": "Required. The identifier of the merchant's store. Either a `storeCode` inserted via the API or the code of the store in Google My Business."
},
"timestamp": {
"type": "string",
"description": "Required. The inventory timestamp, in ISO 8601 format."
}
},
"type": "object",
"id": "PosInventoryRequest"
},
"CustomAttribute": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "The value of the attribute."
},
"name": {
"type": "string",
"description": "The name of the attribute. Underscores will be replaced by spaces upon insertion."
},
"groupValues": {
"description": "Subattributes within this attribute group. Exactly one of value or groupValues must be provided.",
"items": {
"$ref": "CustomAttribute"
},
"type": "array"
}
},
"id": "CustomAttribute"
},
"BusinessDayConfig": {
"id": "BusinessDayConfig",
"properties": {
"businessDays": {
"items": {
"type": "string"
},
"description": "Regular business days. May not be empty.",
"type": "array"
}
},
"type": "object"
},
"LiasettingsSetPosDataProviderResponse": {
"type": "object",
"id": "LiasettingsSetPosDataProviderResponse",
"properties": {
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#liasettingsSetPosDataProviderResponse\".",
"type": "string"
}
}
},
"OrderDeliveryDetails": {
"properties": {
"phoneNumber": {
"type": "string",
"description": "The phone number of the person receiving the delivery."
},
"address": {
"description": "The delivery address",
"$ref": "OrderAddress"
}
},
"id": "OrderDeliveryDetails",
"type": "object"
},
"OrderLineItemProduct": {
"type": "object",
"id": "OrderLineItemProduct",
"properties": {
"shownImage": {
"description": "URL to the cached image shown to the user when order was placed.",
"type": "string"
},
"condition": {
"type": "string",
"description": "Condition or state of the item. Acceptable values are: - \"`new`\" - \"`refurbished`\" - \"`used`\" "
},
"mpn": {
"type": "string",
"description": "Manufacturer Part Number (MPN) of the item."
},
"price": {
"$ref": "Price",
"description": "Price of the item."
},
"title": {
"description": "The title of the product.",
"type": "string"
},
"id": {
"description": "The REST ID of the product.",
"type": "string"
},
"gtin": {
"type": "string",
"description": "Global Trade Item Number (GTIN) of the item."
},
"brand": {
"type": "string",
"description": "Brand of the item."
},
"offerId": {
"type": "string",
"description": "An identifier of the item."
},
"itemGroupId": {
"description": "Shared identifier for all variants of the same product.",
"type": "string"
},
"targetCountry": {
"type": "string",
"description": "The CLDR territory // code of the target country of the product."
},
"contentLanguage": {
"type": "string",
"description": "The two-letter ISO 639-1 language code for the item."
},
"fees": {
"description": "Associated fees at order creation time.",
"items": {
"$ref": "OrderLineItemProductFee"
},
"type": "array"
},
"variantAttributes": {
"type": "array",
"description": "Variant attributes for the item. These are dimensions of the product, such as color, gender, material, pattern, and size. You can find a comprehensive list of variant attributes here.",
"items": {
"$ref": "OrderLineItemProductVariantAttribute"
}
},
"imageLink": {
"description": "URL of an image of the item.",
"type": "string"
}
}
},
"TestOrderLineItem": {
"properties": {
"product": {
"$ref": "TestOrderLineItemProduct",
"description": "Required. Product data from the time of the order placement."
},
"quantityOrdered": {
"description": "Required. Number of items ordered.",
"format": "uint32",
"type": "integer"
},
"returnInfo": {
"description": "Required. Details of the return policy for the line item.",
"$ref": "OrderLineItemReturnInfo"
},
"shippingDetails": {
"$ref": "OrderLineItemShippingDetails",
"description": "Required. Details of the requested shipping for the line item."
}
},
"id": "TestOrderLineItem",
"type": "object"
},
"ProductAmount": {
"id": "ProductAmount",
"properties": {
"taxAmount": {
"$ref": "Price",
"description": "Tax value."
},
"priceAmount": {
"$ref": "Price",
"description": "The pre-tax or post-tax price depending on the location of the order."
},
"remittedTaxAmount": {
"$ref": "Price",
"description": "Remitted tax value."
}
},
"type": "object"
},
"AccountsUpdateLabelsRequest": {
"id": "AccountsUpdateLabelsRequest",
"type": "object",
"properties": {
"labelIds": {
"description": "The IDs of labels that should be assigned to the account.",
"items": {
"type": "string",
"format": "uint64"
},
"type": "array"
}
}
},
"ProductsCustomBatchRequest": {
"properties": {
"entries": {
"description": "The request entries to be processed in the batch.",
"items": {
"$ref": "ProductsCustomBatchRequestEntry"
},
"type": "array"
}
},
"type": "object",
"id": "ProductsCustomBatchRequest"
},
"PosInventoryResponse": {
"properties": {
"price": {
"$ref": "Price",
"description": "Required. The current price of the item."
},
"timestamp": {
"type": "string",
"description": "Required. The inventory timestamp, in ISO 8601 format."
},
"itemId": {
"type": "string",
"description": "Required. A unique identifier for the item."
},
"gtin": {
"type": "string",
"description": "Global Trade Item Number."
},
"storeCode": {
"type": "string",
"description": "Required. The identifier of the merchant's store. Either a `storeCode` inserted via the API or the code of the store in Google My Business."
},
"contentLanguage": {
"description": "Required. The two-letter ISO 639-1 language code for the item.",
"type": "string"
},
"quantity": {
"type": "string",
"format": "int64",
"description": "Required. The available quantity of the item."
},
"targetCountry": {
"type": "string",
"description": "Required. The CLDR territory code for the item."
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#posInventoryResponse\"."
}
},
"type": "object",
"id": "PosInventoryResponse"
},
"OrdersRejectReturnLineItemRequest": {
"type": "object",
"id": "OrdersRejectReturnLineItemRequest",
"properties": {
"operationId": {
"description": "The ID of the operation. Unique across all operations for a given order.",
"type": "string"
},
"quantity": {
"type": "integer",
"description": "The quantity to return and refund.",
"format": "uint32"
},
"lineItemId": {
"type": "string",
"description": "The ID of the line item to return. Either lineItemId or productId is required."
},
"reasonText": {
"type": "string",
"description": "The explanation of the reason."
},
"productId": {
"description": "The ID of the product to return. This is the REST ID used in the products service. Either lineItemId or productId is required.",
"type": "string"
},
"reason": {
"type": "string",
"description": "The reason for the return. Acceptable values are: - \"`damagedOrUsed`\" - \"`missingComponent`\" - \"`notEligible`\" - \"`other`\" - \"`outOfReturnWindow`\" "
}
}
},
"AccountCustomerService": {
"type": "object",
"id": "AccountCustomerService",
"properties": {
"phoneNumber": {
"description": "Customer service phone number.",
"type": "string"
},
"url": {
"description": "Customer service URL.",
"type": "string"
},
"email": {
"type": "string",
"description": "Customer service email."
}
}
},
"CustomerReturnReason": {
"properties": {
"reasonCode": {
"type": "string",
"description": "Code of the return reason. Acceptable values are: - \"`betterPriceFound`\" - \"`changedMind`\" - \"`damagedOrDefectiveItem`\" - \"`didNotMatchDescription`\" - \"`doesNotFit`\" - \"`expiredItem`\" - \"`incorrectItemReceived`\" - \"`noLongerNeeded`\" - \"`notSpecified`\" - \"`orderedWrongItem`\" - \"`other`\" - \"`qualityNotExpected`\" - \"`receivedTooLate`\" - \"`undeliverable`\" "
},
"description": {
"type": "string",
"description": "Description of the reason."
}
},
"id": "CustomerReturnReason",
"type": "object"
},
"OrdersSetLineItemMetadataRequest": {
"properties": {
"lineItemId": {
"description": "The ID of the line item to set metadata. Either lineItemId or productId is required.",
"type": "string"
},
"annotations": {
"items": {
"$ref": "OrderMerchantProvidedAnnotation"
},
"type": "array"
},
"productId": {
"description": "The ID of the product to set metadata. This is the REST ID used in the products service. Either lineItemId or productId is required.",
"type": "string"
},
"operationId": {
"type": "string",
"description": "The ID of the operation. Unique across all operations for a given order."
}
},
"type": "object",
"id": "OrdersSetLineItemMetadataRequest"
},
"AccounttaxListResponse": {
"properties": {
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#accounttaxListResponse\"."
},
"resources": {
"items": {
"$ref": "AccountTax"
},
"type": "array"
},
"nextPageToken": {
"type": "string",
"description": "The token for the retrieval of the next page of account tax settings."
}
},
"id": "AccounttaxListResponse",
"type": "object"
},
"OrdersUpdateShipmentResponse": {
"type": "object",
"properties": {
"executionStatus": {
"type": "string",
"description": "The status of the execution. Acceptable values are: - \"`duplicate`\" - \"`executed`\" "
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersUpdateShipmentResponse\"."
}
},
"id": "OrdersUpdateShipmentResponse"
},
"PubsubNotificationSettings": {
"properties": {
"registeredEvents": {
"items": {
"type": "string"
},
"type": "array",
"description": "List of event types. Acceptable values are: - \"`orderPendingShipment`\" "
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"`content#pubsubNotificationSettings`\"",
"type": "string"
},
"cloudTopicName": {
"description": "Cloud pub/sub topic to which notifications are sent (read-only).",
"type": "string"
}
},
"description": "Settings for Pub/Sub notifications, all methods require that the caller is a direct user of the merchant center account.",
"id": "PubsubNotificationSettings",
"type": "object"
},
"DatafeedsCustomBatchRequestEntry": {
"type": "object",
"properties": {
"batchId": {
"type": "integer",
"format": "uint32",
"description": "An entry ID, unique within the batch request."
},
"datafeed": {
"$ref": "Datafeed",
"description": "The data feed to insert."
},
"merchantId": {
"type": "string",
"description": "The ID of the managing account.",
"format": "uint64"
},
"datafeedId": {
"type": "string",
"description": "The ID of the data feed to get, delete or fetch.",
"format": "uint64"
},
"method": {
"description": "The method of the batch entry. Acceptable values are: - \"`delete`\" - \"`fetchNow`\" - \"`get`\" - \"`insert`\" - \"`update`\" ",
"type": "string"
}
},
"description": "A batch entry encoding a single non-batch datafeeds request.",
"id": "DatafeedsCustomBatchRequestEntry"
},
"OrdersRefundOrderRequest": {
"properties": {
"reason": {
"description": "The reason for the refund. Acceptable values are: - \"`courtesyAdjustment`\" - \"`other`\" ",
"type": "string"
},
"amount": {
"description": "The amount that is refunded. If this is not the first refund for the order, this should be the newly refunded amount.",
"$ref": "MonetaryAmount"
},
"operationId": {
"description": "The ID of the operation. Unique across all operations for a given order.",
"type": "string"
},
"reasonText": {
"description": "The explanation of the reason.",
"type": "string"
},
"fullRefund": {
"type": "boolean",
"description": "If true, the full order will be refunded, including shipping. If this is true, amount should not be provided and will be ignored."
}
},
"id": "OrdersRefundOrderRequest",
"type": "object"
},
"Datafeed": {
"type": "object",
"properties": {
"attributeLanguage": {
"description": "The two-letter ISO 639-1 language in which the attributes are defined in the data feed.",
"type": "string"
},
"fileName": {
"type": "string",
"description": "Required. The filename of the feed. All feeds must have a unique file name."
},
"contentType": {
"description": "Required. The type of data feed. For product inventory feeds, only feeds for local stores, not online stores, are supported. Acceptable values are: - \"`local products`\" - \"`product inventory`\" - \"`products`\" ",
"type": "string"
},
"name": {
"type": "string",
"description": "Required for insert. A descriptive name of the data feed."
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"`content#datafeed`\""
},
"format": {
"$ref": "DatafeedFormat",
"description": "Format of the feed file."
},
"id": {
"type": "string",
"description": "Required for update. The ID of the data feed.",
"format": "int64"
},
"targets": {
"description": "The targets this feed should apply to (country, language, destinations).",
"type": "array",
"items": {
"$ref": "DatafeedTarget"
}
},
"fetchSchedule": {
"description": "Fetch schedule for the feed file.",
"$ref": "DatafeedFetchSchedule"
}
},
"description": "Datafeed configuration data.",
"id": "Datafeed"
},
"Segments": {
"description": "Dimensions according to which metrics are segmented in the response. Values of product dimensions, e.g., offer id, reflect the state of a product at the time of the corresponding event, e.g., impression or order. Segment fields cannot be selected in queries without also selecting at least one metric field. Values are only set for dimensions requested explicitly in the request's search query.",
"properties": {
"date": {
"$ref": "Date",
"description": "Date in the merchant timezone to which metrics apply."
},
"program": {
"enum": [
"PROGRAM_UNSPECIFIED",
"SHOPPING_ADS",
"FREE_PRODUCT_LISTING",
"FREE_LOCAL_PRODUCT_LISTING",
"BUY_ON_GOOGLE_LISTING"
],
"enumDescriptions": [
"Not specified.",
"Shopping Ads.",
"Free Product Listing.",
"Free Local Product Listing.",
"Buy on Google Listing."
],
"type": "string",
"description": "Program to which metrics apply, e.g., Free Product Listing."
},
"offerId": {
"type": "string",
"description": "Merchant-provided id of the product."
}
},
"type": "object",
"id": "Segments"
},
"RepricingRule": {
"properties": {
"countryCode": {
"description": "Required. Immutable. [CLDR country code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) (e.g. \"US\").",
"type": "string"
},
"eligibleOfferMatcher": {
"$ref": "RepricingRuleEligibleOfferMatcher",
"description": "Required. Match criteria for the eligible offers."
},
"merchantId": {
"type": "string",
"format": "int64",
"description": "Output only. Immutable. Merchant that owns the repricing rule.",
"readOnly": true
},
"paused": {
"type": "boolean",
"description": "Represents whether a rule is paused. A paused rule will behave like a non-paused rule within CRUD operations, with the major difference that a paused rule will not be evaluated and will have no effect on offers."
},
"cogsBasedRule": {
"description": "The rule definition for TYPE_COGS_BASED. Required when the rule type is TYPE_COGS_BASED.",
"$ref": "RepricingRuleCostOfGoodsSaleRule"
},
"type": {
"enum": [
"REPRICING_RULE_TYPE_UNSPECIFIED",
"TYPE_STATS_BASED",
"TYPE_COGS_BASED"
],
"enumDescriptions": [
"Unused.",
"Statistical measurement based rules among Google SA merchants. If this rule is chosen, repricer will adjust the offer price based on statistical metrics (currently only min is available) among other merchants who sell the same product. Details need to be provdided in the RuleDefinition.",
"Cost of goods sale based rule. Repricer will adjust the offer price based on the offer's sale cost which is provided by the merchant."
],
"type": "string",
"description": "Required. Immutable. The type of the rule."
},
"effectiveTimePeriod": {
"$ref": "RepricingRuleEffectiveTime",
"description": "Required. Time period when the rule should take effect."
},
"languageCode": {
"type": "string",
"description": "Required. Immutable. The two-letter ISO 639-1 language code associated with the repricing rule."
},
"restriction": {
"$ref": "RepricingRuleRestriction",
"description": "Required. Restriction of the rule appliance."
},
"statsBasedRule": {
"$ref": "RepricingRuleStatsBasedRule",
"description": "The rule definition for TYPE_STATS_BASED. Required when the rule type is TYPE_STATS_BASED."
},
"ruleId": {
"description": "Output only. Immutable. The ID to uniquely identify each repricing rule.",
"readOnly": true,
"type": "string"
},
"title": {
"description": "The title for the rule.",
"type": "string"
}
},
"type": "object",
"description": "Represents a repricing rule. A repricing rule is used by shopping serving to adjust transactable offer prices if conditions are met. Next ID: 24",
"id": "RepricingRule"
},
"ReturnShipment": {
"type": "object",
"id": "ReturnShipment",
"properties": {
"returnMethodType": {
"description": "Type of the return method. Acceptable values are: - \"`byMail`\" - \"`contactCustomerSupport`\" - \"`returnless`\" - \"`inStore`\" ",
"type": "string"
},
"shipmentTrackingInfos": {
"items": {
"$ref": "ShipmentTrackingInfo"
},
"description": "Tracking information of the shipment. One return shipment might be handled by several shipping carriers sequentially.",
"type": "array"
},
"creationDate": {
"type": "string",
"description": "The date of creation of the shipment, in ISO 8601 format."
},
"state": {
"type": "string",
"description": "State of the shipment. Acceptable values are: - \"`completed`\" - \"`new`\" - \"`shipped`\" - \"`undeliverable`\" - \"`pending`\" "
},
"shipmentId": {
"description": "Shipment ID generated by Google.",
"type": "string"
},
"shippingDate": {
"description": "The date of shipping of the shipment, in ISO 8601 format.",
"type": "string"
},
"deliveryDate": {
"type": "string",
"description": "The date of delivery of the shipment, in ISO 8601 format."
}
}
},
"PosListResponse": {
"type": "object",
"properties": {
"resources": {
"type": "array",
"items": {
"$ref": "PosStore"
}
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#posListResponse\".",
"type": "string"
}
},
"id": "PosListResponse"
},
"InvoiceSummary": {
"properties": {
"additionalChargeSummaries": {
"items": {
"$ref": "InvoiceSummaryAdditionalChargeSummary"
},
"description": "Summary of the total amounts of the additional charges.",
"type": "array"
},
"productTotal": {
"description": "[required] Total price for the product.",
"$ref": "Amount"
}
},
"id": "InvoiceSummary",
"type": "object"
},
"LoyaltyPoints": {
"id": "LoyaltyPoints",
"type": "object",
"properties": {
"ratio": {
"description": "The ratio of a point when converted to currency. Google assumes currency based on Merchant Center settings. If ratio is left out, it defaults to 1.0.",
"format": "double",
"type": "number"
},
"name": {
"description": "Name of loyalty points program. It is recommended to limit the name to 12 full-width characters or 24 Roman characters.",
"type": "string"
},
"pointsValue": {
"format": "int64",
"type": "string",
"description": "The retailer's loyalty points in absolute value."
}
}
},
"DatafeedstatusesCustomBatchRequestEntry": {
"id": "DatafeedstatusesCustomBatchRequestEntry",
"description": "A batch entry encoding a single non-batch datafeedstatuses request.",
"type": "object",
"properties": {
"country": {
"type": "string",
"description": "The country for which to get the datafeed status. If this parameter is provided then language must also be provided. Note that for multi-target datafeeds this parameter is required."
},
"datafeedId": {
"type": "string",
"format": "uint64",
"description": "The ID of the data feed to get."
},
"method": {
"description": "The method of the batch entry. Acceptable values are: - \"`get`\" ",
"type": "string"
},
"language": {
"type": "string",
"description": "The language for which to get the datafeed status. If this parameter is provided then country must also be provided. Note that for multi-target datafeeds this parameter is required."
},
"batchId": {
"format": "uint32",
"description": "An entry ID, unique within the batch request.",
"type": "integer"
},
"merchantId": {
"type": "string",
"description": "The ID of the managing account.",
"format": "uint64"
}
}
},
"TransitTableTransitTimeRow": {
"type": "object",
"properties": {
"values": {
"type": "array",
"items": {
"$ref": "TransitTableTransitTimeRowTransitTimeValue"
}
}
},
"id": "TransitTableTransitTimeRow"
},
"ProductTax": {
"properties": {
"country": {
"description": "The country within which the item is taxed, specified as a CLDR territory code.",
"type": "string"
},
"rate": {
"type": "number",
"format": "double",
"description": "The percentage of tax rate that applies to the item price."
},
"region": {
"type": "string",
"description": "The geographic region to which the tax rate applies."
},
"taxShip": {
"description": "Should be set to true if tax is charged on shipping.",
"type": "boolean"
},
"locationId": {
"type": "string",
"description": "The numeric ID of a location that the tax rate applies to as defined in the AdWords API.",
"format": "int64"
},
"postalCode": {
"type": "string",
"description": "The postal code range that the tax rate applies to, represented by a ZIP code, a ZIP code prefix using * wildcard, a range between two ZIP codes or two ZIP code prefixes of equal length. Examples: 94114, 94*, 94002-95460, 94*-95*."
}
},
"type": "object",
"id": "ProductTax"
},
"OrdersCancelLineItemRequest": {
"properties": {
"quantity": {
"format": "uint32",
"description": "The quantity to cancel.",
"type": "integer"
},
"lineItemId": {
"type": "string",
"description": "The ID of the line item to cancel. Either lineItemId or productId is required."
},
"operationId": {
"type": "string",
"description": "The ID of the operation. Unique across all operations for a given order."
},
"reasonText": {
"description": "The explanation of the reason.",
"type": "string"
},
"reason": {
"description": "The reason for the cancellation. Acceptable values are: - \"`customerInitiatedCancel`\" - \"`invalidCoupon`\" - \"`malformedShippingAddress`\" - \"`noInventory`\" - \"`other`\" - \"`priceError`\" - \"`shippingPriceError`\" - \"`taxError`\" - \"`undeliverableShippingAddress`\" - \"`unsupportedPoBoxAddress`\" ",
"type": "string"
},
"productId": {
"type": "string",
"description": "The ID of the product to cancel. This is the REST ID used in the products service. Either lineItemId or productId is required."
}
},
"type": "object",
"id": "OrdersCancelLineItemRequest"
},
"LiasettingsRequestGmbAccessResponse": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#liasettingsRequestGmbAccessResponse\"."
}
},
"id": "LiasettingsRequestGmbAccessResponse"
},
"RegionalinventoryCustomBatchRequest": {
"type": "object",
"id": "RegionalinventoryCustomBatchRequest",
"properties": {
"entries": {
"items": {
"$ref": "RegionalinventoryCustomBatchRequestEntry"
},
"type": "array",
"description": "The request entries to be processed in the batch."
}
}
},
"AccountstatusesCustomBatchRequest": {
"type": "object",
"properties": {
"entries": {
"items": {
"$ref": "AccountstatusesCustomBatchRequestEntry"
},
"type": "array",
"description": "The request entries to be processed in the batch."
}
},
"id": "AccountstatusesCustomBatchRequest"
},
"ListRepricingProductReportsResponse": {
"type": "object",
"id": "ListRepricingProductReportsResponse",
"description": "Response message for the ListRepricingProductReports method.",
"properties": {
"nextPageToken": {
"type": "string",
"description": "A token for retrieving the next page. Its absence means there is no subsequent page."
},
"repricingProductReports": {
"type": "array",
"items": {
"$ref": "RepricingProductReport"
},
"description": "Periodic reports for the given Repricing product."
}
}
},
"UnitInvoiceTaxLine": {
"id": "UnitInvoiceTaxLine",
"properties": {
"taxType": {
"description": "[required] Type of the tax. Acceptable values are: - \"`otherFee`\" - \"`otherFeeTax`\" - \"`sales`\" ",
"type": "string"
},
"taxName": {
"type": "string",
"description": "Optional name of the tax type. This should only be provided if `taxType` is `otherFeeTax`."
},
"taxAmount": {
"$ref": "Price",
"description": "[required] Tax amount for the tax type."
}
},
"type": "object"
},
"OrdersUpdateMerchantOrderIdRequest": {
"properties": {
"operationId": {
"description": "The ID of the operation. Unique across all operations for a given order.",
"type": "string"
},
"merchantOrderId": {
"type": "string",
"description": "The merchant order id to be assigned to the order. Must be unique per merchant."
}
},
"id": "OrdersUpdateMerchantOrderIdRequest",
"type": "object"
},
"AccountsListResponse": {
"type": "object",
"id": "AccountsListResponse",
"properties": {
"nextPageToken": {
"description": "The token for the retrieval of the next page of accounts.",
"type": "string"
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#accountsListResponse\".",
"type": "string"
},
"resources": {
"type": "array",
"items": {
"$ref": "Account"
}
}
}
},
"ProductsCustomBatchResponse": {
"properties": {
"entries": {
"type": "array",
"items": {
"$ref": "ProductsCustomBatchResponseEntry"
},
"description": "The result of the execution of the batch requests."
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#productsCustomBatchResponse\".",
"type": "string"
}
},
"type": "object",
"id": "ProductsCustomBatchResponse"
},
"ListRepricingRuleReportsResponse": {
"properties": {
"repricingRuleReports": {
"type": "array",
"items": {
"$ref": "RepricingRuleReport"
},
"description": "Daily reports for the given Repricing rule."
},
"nextPageToken": {
"type": "string",
"description": "A token for retrieving the next page. Its absence means there is no subsequent page."
}
},
"type": "object",
"id": "ListRepricingRuleReportsResponse",
"description": "Response message for the ListRepricingRuleReports method."
},
"SettlementTransactionAmountCommission": {
"type": "object",
"properties": {
"rate": {
"description": "Rate of the commission in percentage.",
"type": "string"
},
"category": {
"type": "string",
"description": "The category of the commission. Acceptable values are: - \"`animalsAndPetSupplies`\" - \"`dogCatFoodAndCatLitter`\" - \"`apparelAndAccessories`\" - \"`shoesHandbagsAndSunglasses`\" - \"`costumesAndAccessories`\" - \"`jewelry`\" - \"`watches`\" - \"`hobbiesArtsAndCrafts`\" - \"`homeAndGarden`\" - \"`entertainmentCollectibles`\" - \"`collectibleCoins`\" - \"`sportsCollectibles`\" - \"`sportingGoods`\" - \"`toysAndGames`\" - \"`musicalInstruments`\" - \"`giftCards`\" - \"`babyAndToddler`\" - \"`babyFoodWipesAndDiapers`\" - \"`businessAndIndustrial`\" - \"`camerasOpticsAndPhotography`\" - \"`consumerElectronics`\" - \"`electronicsAccessories`\" - \"`personalComputers`\" - \"`videoGameConsoles`\" - \"`foodAndGrocery`\" - \"`beverages`\" - \"`tobaccoProducts`\" - \"`furniture`\" - \"`hardware`\" - \"`buildingMaterials`\" - \"`tools`\" - \"`healthAndPersonalCare`\" - \"`beauty`\" - \"`householdSupplies`\" - \"`kitchenAndDining`\" - \"`majorAppliances`\" - \"`luggageAndBags`\" - \"`media`\" - \"`officeSupplies`\" - \"`softwareAndVideoGames`\" - \"`vehiclePartsAndAccessories`\" - \"`vehicleTiresAndWheels`\" - \"`vehicles`\" - \"`everythingElse`\" "
}
},
"id": "SettlementTransactionAmountCommission"
},
"LiasettingsGetAccessibleGmbAccountsResponse": {
"id": "LiasettingsGetAccessibleGmbAccountsResponse",
"type": "object",
"properties": {
"gmbAccounts": {
"type": "array",
"items": {
"$ref": "GmbAccountsGmbAccount"
},
"description": "A list of GMB accounts which are available to the merchant."
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#liasettingsGetAccessibleGmbAccountsResponse\".",
"type": "string"
},
"accountId": {
"format": "uint64",
"type": "string",
"description": "The ID of the Merchant Center account."
}
}
},
"PosCustomBatchRequestEntry": {
"type": "object",
"properties": {
"inventory": {
"$ref": "PosInventory",
"description": "The inventory to submit. This should be set only if the method is `inventory`."
},
"merchantId": {
"format": "uint64",
"description": "The ID of the POS data provider.",
"type": "string"
},
"batchId": {
"description": "An entry ID, unique within the batch request.",
"format": "uint32",
"type": "integer"
},
"storeCode": {
"type": "string",
"description": "The store code. This should be set only if the method is `delete` or `get`."
},
"targetMerchantId": {
"description": "The ID of the account for which to get/submit data.",
"type": "string",
"format": "uint64"
},
"sale": {
"description": "The sale information to submit. This should be set only if the method is `sale`.",
"$ref": "PosSale"
},
"store": {
"$ref": "PosStore",
"description": "The store information to submit. This should be set only if the method is `insert`."
},
"method": {
"type": "string",
"description": "The method of the batch entry. Acceptable values are: - \"`delete`\" - \"`get`\" - \"`insert`\" - \"`inventory`\" - \"`sale`\" "
}
},
"id": "PosCustomBatchRequestEntry"
},
"OrderShipmentScheduledDeliveryDetails": {
"id": "OrderShipmentScheduledDeliveryDetails",
"properties": {
"scheduledDate": {
"description": "The date a shipment is scheduled for delivery, in ISO 8601 format.",
"type": "string"
},
"carrierPhoneNumber": {
"description": "The phone number of the carrier fulfilling the delivery. The phone number is formatted as the international notation in ITU-T Recommendation E.123 (e.g., \"+41 44 668 1800\").",
"type": "string"
}
},
"type": "object"
},
"OrdersUpdateLineItemShippingDetailsResponse": {
"type": "object",
"properties": {
"executionStatus": {
"type": "string",
"description": "The status of the execution. Acceptable values are: - \"`duplicate`\" - \"`executed`\" "
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersUpdateLineItemShippingDetailsResponse\"."
}
},
"id": "OrdersUpdateLineItemShippingDetailsResponse"
},
"OrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceReturnOption": {
"id": "OrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceReturnOption",
"properties": {
"reason": {
"type": "string",
"description": "[required] Reason for the return. Acceptable values are: - \"`customerDiscretionaryReturn`\" - \"`customerInitiatedMerchantCancel`\" - \"`deliveredTooLate`\" - \"`expiredItem`\" - \"`invalidCoupon`\" - \"`malformedShippingAddress`\" - \"`other`\" - \"`productArrivedDamaged`\" - \"`productNotAsDescribed`\" - \"`qualityNotAsExpected`\" - \"`undeliverableShippingAddress`\" - \"`unsupportedPoBoxAddress`\" - \"`wrongProductShipped`\" "
},
"description": {
"type": "string",
"description": "Optional description of the return reason."
}
},
"type": "object"
},
"DateTime": {
"properties": {
"hours": {
"type": "integer",
"format": "int32",
"description": "Required. Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value \"24:00:00\" for scenarios like business closing time."
},
"day": {
"description": "Required. Day of month. Must be from 1 to 31 and valid for the year and month.",
"type": "integer",
"format": "int32"
},
"minutes": {
"format": "int32",
"description": "Required. Minutes of hour of day. Must be from 0 to 59.",
"type": "integer"
},
"utcOffset": {
"type": "string",
"format": "google-duration",
"description": "UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }."
},
"month": {
"description": "Required. Month of year. Must be from 1 to 12.",
"type": "integer",
"format": "int32"
},
"timeZone": {
"description": "Time zone.",
"$ref": "TimeZone"
},
"seconds": {
"description": "Required. Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.",
"format": "int32",
"type": "integer"
},
"nanos": {
"description": "Required. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.",
"format": "int32",
"type": "integer"
},
"year": {
"description": "Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.",
"format": "int32",
"type": "integer"
}
},
"description": "Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few possible ways: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. * When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year is 0, the DateTime is considered not to have a specific year. month and day must have valid, non-zero values. This type may also be used to represent a physical time if all the date and time fields are set and either case of the `time_offset` oneof is set. Consider using `Timestamp` message for physical time instead. If your use case also would like to store the user's timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application's limitations.",
"type": "object",
"id": "DateTime"
},
"DatafeedTarget": {
"type": "object",
"properties": {
"includedDestinations": {
"type": "array",
"items": {
"type": "string"
},
"description": "The list of destinations to include for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in `excludedDestinations`. List of supported destinations (if available to the account): - DisplayAds - Shopping - ShoppingActions - SurfacesAcrossGoogle "
},
"excludedDestinations": {
"description": "The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center).",
"type": "array",
"items": {
"type": "string"
}
},
"language": {
"description": "The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for `targets[].country`.",
"type": "string"
},
"country": {
"type": "string",
"description": "The country where the items in the feed will be included in the search index, represented as a CLDR territory code."
}
},
"id": "DatafeedTarget"
},
"OrderinvoicesCreateRefundInvoiceRequest": {
"type": "object",
"properties": {
"refundOnlyOption": {
"description": "Option to create a refund-only invoice. Exactly one of `refundOnlyOption` or `returnOption` must be provided.",
"$ref": "OrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceRefundOption"
},
"invoiceId": {
"type": "string",
"description": "[required] The ID of the invoice."
},
"shipmentInvoices": {
"items": {
"$ref": "ShipmentInvoice"
},
"description": "Invoice details for different shipment groups.",
"type": "array"
},
"operationId": {
"type": "string",
"description": "[required] The ID of the operation, unique across all operations for a given order."
},
"returnOption": {
"description": "Option to create an invoice for a refund and mark all items within the invoice as returned. Exactly one of `refundOnlyOption` or `returnOption` must be provided.",
"$ref": "OrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceReturnOption"
}
},
"id": "OrderinvoicesCreateRefundInvoiceRequest"
},
"ProductProductDetail": {
"properties": {
"sectionName": {
"description": "The section header used to group a set of product details.",
"type": "string"
},
"attributeValue": {
"description": "The value of the product detail.",
"type": "string"
},
"attributeName": {
"type": "string",
"description": "The name of the product detail."
}
},
"id": "ProductProductDetail",
"type": "object"
},
"CutoffTime": {
"type": "object",
"properties": {
"minute": {
"type": "integer",
"format": "uint32",
"description": "Minute of the cutoff time until which an order has to be placed to be processed in the same day. Required."
},
"hour": {
"description": "Hour of the cutoff time until which an order has to be placed to be processed in the same day. Required.",
"type": "integer",
"format": "uint32"
},
"timezone": {
"description": "Timezone identifier for the cutoff time. A list of identifiers can be found in the AdWords API documentation. E.g. \"Europe/Zurich\". Required.",
"type": "string"
}
},
"id": "CutoffTime"
},
"OrderLineItemShippingDetailsMethod": {
"id": "OrderLineItemShippingDetailsMethod",
"type": "object",
"properties": {
"minDaysInTransit": {
"description": "Required. Minimum transit time.",
"format": "uint32",
"type": "integer"
},
"methodName": {
"type": "string",
"description": "Required. The name of the shipping method."
},
"carrier": {
"type": "string",
"description": "The carrier for the shipping. Optional. See `shipments[].carrier` for a list of acceptable values."
},
"maxDaysInTransit": {
"description": "Required. Maximum transit time.",
"type": "integer",
"format": "uint32"
}
}
},
"AccounttaxCustomBatchRequest": {
"type": "object",
"id": "AccounttaxCustomBatchRequest",
"properties": {
"entries": {
"items": {
"$ref": "AccounttaxCustomBatchRequestEntry"
},
"description": "The request entries to be processed in the batch.",
"type": "array"
}
}
},
"AccountReturnCarrier": {
"description": " The return carrier information. This service is designed for merchants enrolled in the Buy on Google program. ",
"type": "object",
"properties": {
"carrierCode": {
"enumDescriptions": [
"Carrier not specified",
"FedEx carrier",
"UPS carrier"
],
"description": "The carrier code enum. Accepts the values FEDEX or UPS.",
"type": "string",
"enum": [
"CARRIER_CODE_UNSPECIFIED",
"FEDEX",
"UPS"
]
},
"carrierAccountId": {
"description": "Output only. Immutable. The Google-provided unique carrier ID, used to update the resource.",
"readOnly": true,
"format": "int64",
"type": "string"
},
"carrierAccountNumber": {
"description": "Number of the carrier account.",
"type": "string"
},
"carrierAccountName": {
"description": "Name of the carrier account.",
"type": "string"
}
},
"id": "AccountReturnCarrier"
},
"AccountsLinkRequest": {
"id": "AccountsLinkRequest",
"properties": {
"linkedAccountId": {
"type": "string",
"description": "The ID of the linked account."
},
"action": {
"description": "Action to perform for this link. The `\"request\"` action is only available to select merchants. Acceptable values are: - \"`approve`\" - \"`remove`\" - \"`request`\" ",
"type": "string"
},
"services": {
"description": " Acceptable values are: - \"`shoppingAdsProductManagement`\" - \"`shoppingActionsProductManagement`\" - \"`shoppingActionsOrderManagement`\" ",
"items": {
"type": "string"
},
"type": "array"
},
"linkType": {
"type": "string",
"description": "Type of the link between the two accounts. Acceptable values are: - \"`channelPartner`\" - \"`eCommercePlatform`\" "
}
},
"type": "object"
},
"AccountstatusesCustomBatchRequestEntry": {
"properties": {
"method": {
"type": "string",
"description": "The method of the batch entry. Acceptable values are: - \"`get`\" "
},
"batchId": {
"description": "An entry ID, unique within the batch request.",
"type": "integer",
"format": "uint32"
},
"accountId": {
"description": "The ID of the (sub-)account whose status to get.",
"format": "uint64",
"type": "string"
},
"merchantId": {
"description": "The ID of the managing account.",
"type": "string",
"format": "uint64"
},
"destinations": {
"type": "array",
"description": "If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination.",
"items": {
"type": "string"
}
}
},
"id": "AccountstatusesCustomBatchRequestEntry",
"type": "object",
"description": "A batch entry encoding a single non-batch accountstatuses request."
},
"AccountsUpdateLabelsResponse": {
"properties": {
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#accountsUpdateLabelsResponse\"."
}
},
"type": "object",
"id": "AccountsUpdateLabelsResponse"
},
"OrdersRefundItemRequest": {
"id": "OrdersRefundItemRequest",
"type": "object",
"properties": {
"shipping": {
"description": "The refund on shipping. Optional, but either Item or Shipping must be provided in the request.",
"$ref": "OrdersCustomBatchRequestEntryRefundItemShipping"
},
"operationId": {
"description": "The ID of the operation. Unique across all operations for a given order.",
"type": "string"
},
"items": {
"items": {
"$ref": "OrdersCustomBatchRequestEntryRefundItemItem"
},
"type": "array",
"description": "The items that are refunded. Either Item or Shipping must be provided in the request."
},
"reason": {
"description": "The reason for the refund. Acceptable values are: - \"`shippingCostAdjustment`\" - \"`priceAdjustment`\" - \"`taxAdjustment`\" - \"`feeAdjustment`\" - \"`courtesyAdjustment`\" - \"`adjustment`\" - \"`customerCancelled`\" - \"`noInventory`\" - \"`productNotAsDescribed`\" - \"`undeliverableShippingAddress`\" - \"`wrongProductShipped`\" - \"`lateShipmentCredit`\" - \"`deliveredLateByCarrier`\" - \"`productArrivedDamaged`\" ",
"type": "string"
},
"reasonText": {
"description": "The explanation of the reason.",
"type": "string"
}
}
},
"OrderinvoicesCreateChargeInvoiceRequest": {
"properties": {
"invoiceSummary": {
"$ref": "InvoiceSummary",
"description": "[required] Invoice summary."
},
"lineItemInvoices": {
"type": "array",
"description": "[required] Invoice details per line item.",
"items": {
"$ref": "ShipmentInvoiceLineItemInvoice"
}
},
"invoiceId": {
"type": "string",
"description": "[required] The ID of the invoice."
},
"operationId": {
"type": "string",
"description": "[required] The ID of the operation, unique across all operations for a given order."
},
"shipmentGroupId": {
"description": "[required] ID of the shipment group. It is assigned by the merchant in the `shipLineItems` method and is used to group multiple line items that have the same kind of shipping charges.",
"type": "string"
}
},
"id": "OrderinvoicesCreateChargeInvoiceRequest",
"type": "object"
},
"ListCssesResponse": {
"properties": {
"csses": {
"items": {
"$ref": "Css"
},
"description": "The CSS domains affiliated with the specified CSS group.",
"type": "array"
},
"nextPageToken": {
"type": "string",
"description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages."
}
},
"type": "object",
"description": "The response message for the `ListCsses` method",
"id": "ListCssesResponse"
},
"ReturnaddressCustomBatchRequestEntry": {
"properties": {
"returnAddress": {
"$ref": "ReturnAddress",
"description": "The return address to submit. This should be set only if the method is `insert`."
},
"batchId": {
"description": "An entry ID, unique within the batch request.",
"format": "uint32",
"type": "integer"
},
"returnAddressId": {
"description": "The return address ID. This should be set only if the method is `delete` or `get`.",
"type": "string"
},
"merchantId": {
"type": "string",
"description": "The Merchant Center account ID.",
"format": "uint64"
},
"method": {
"description": "Method of the batch request entry. Acceptable values are: - \"`delete`\" - \"`get`\" - \"`insert`\" ",
"type": "string"
}
},
"type": "object",
"id": "ReturnaddressCustomBatchRequestEntry"
},
"PosCustomBatchResponse": {
"id": "PosCustomBatchResponse",
"type": "object",
"properties": {
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#posCustomBatchResponse\".",
"type": "string"
},
"entries": {
"type": "array",
"description": "The result of the execution of the batch requests.",
"items": {
"$ref": "PosCustomBatchResponseEntry"
}
}
}
},
"SettlementReport": {
"id": "SettlementReport",
"properties": {
"startDate": {
"description": "The start date on which all transactions are included in the report, in ISO 8601 format.",
"type": "string"
},
"transferIds": {
"items": {
"type": "string"
},
"description": "The list of bank identifiers used for the transfer. e.g. Trace ID for Federal Automated Clearing House (ACH). This may also be known as the Wire ID.",
"type": "array"
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"`content#settlementReport`\""
},
"transferDate": {
"description": "Date on which transfer for this payment was initiated by Google, in ISO 8601 format.",
"type": "string"
},
"transferAmount": {
"$ref": "Price",
"description": "The money due to the merchant."
},
"previousBalance": {
"$ref": "Price",
"description": "The residual amount from the previous invoice. This is set only if the previous invoices are not paid because of negative balance."
},
"endDate": {
"type": "string",
"description": "The end date on which all transactions are included in the report, in ISO 8601 format."
},
"settlementId": {
"type": "string",
"description": "The ID of the settlement report."
}
},
"type": "object",
"description": " Settlement reports detail order-level and item-level credits and debits between you and Google."
},
"CollectionStatusDestinationStatus": {
"properties": {
"destination": {
"description": "The name of the destination",
"type": "string"
},
"status": {
"description": "The status for the specified destination.",
"type": "string"
}
},
"id": "CollectionStatusDestinationStatus",
"type": "object",
"description": "Destination status message."
},
"ReturnaddressCustomBatchResponse": {
"id": "ReturnaddressCustomBatchResponse",
"properties": {
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#returnaddressCustomBatchResponse\"."
},
"entries": {
"type": "array",
"description": "The result of the execution of the batch requests.",
"items": {
"$ref": "ReturnaddressCustomBatchResponseEntry"
}
}
},
"type": "object"
},
"LinkService": {
"type": "object",
"properties": {
"status": {
"description": "Status of the link Acceptable values are: - \"`active`\" - \"`inactive`\" - \"`pending`\" ",
"type": "string"
},
"service": {
"type": "string",
"description": "Service provided to or by the linked account. Acceptable values are: - \"`shoppingActionsOrderManagement`\" - \"`shoppingActionsProductManagement`\" - \"`shoppingAdsProductManagement`\" "
}
},
"id": "LinkService"
},
"ProductShipping": {
"type": "object",
"id": "ProductShipping",
"properties": {
"country": {
"description": "The CLDR territory code of the country to which an item will ship.",
"type": "string"
},
"postalCode": {
"description": "The postal code range that the shipping rate applies to, represented by a postal code, a postal code prefix followed by a * wildcard, a range between two postal codes or two postal code prefixes of equal length.",
"type": "string"
},
"locationGroupName": {
"description": "The location where the shipping is applicable, represented by a location group name.",
"type": "string"
},
"region": {
"type": "string",
"description": "The geographic region to which a shipping rate applies."
},
"price": {
"description": "Fixed shipping price, represented as a number.",
"$ref": "Price"
},
"service": {
"type": "string",
"description": "A free-form description of the service class or delivery speed."
},
"locationId": {
"format": "int64",
"type": "string",
"description": "The numeric ID of a location that the shipping rate applies to as defined in the AdWords API."
}
}
},
"OrdersCustomBatchRequestEntryRefundItemItem": {
"id": "OrdersCustomBatchRequestEntryRefundItemItem",
"type": "object",
"properties": {
"quantity": {
"format": "int32",
"type": "integer",
"description": "The number of products that are refunded."
},
"fullRefund": {
"type": "boolean",
"description": "If true, the full item will be refunded. If this is true, amount should not be provided and will be ignored."
},
"amount": {
"description": "The total amount that is refunded. (e.g. refunding $5 each for 2 products should be done by setting quantity to 2 and amount to 10$) In case of multiple refunds, this should be the amount you currently want to refund to the customer.",
"$ref": "MonetaryAmount"
},
"lineItemId": {
"description": "The ID of the line item. Either lineItemId or productId is required.",
"type": "string"
},
"productId": {
"type": "string",
"description": "The ID of the product. This is the REST ID used in the products service. Either lineItemId or productId is required."
}
}
},
"AccountTaxTaxRule": {
"id": "AccountTaxTaxRule",
"description": "Tax calculation rule to apply in a state or province (USA only).",
"properties": {
"ratePercent": {
"type": "string",
"description": "Explicit tax rate in percent, represented as a floating point number without the percentage character. Must not be negative."
},
"country": {
"type": "string",
"description": "Country code in which tax is applicable."
},
"useGlobalRate": {
"description": "Whether the tax rate is taken from a global tax table or specified explicitly.",
"type": "boolean"
},
"locationId": {
"type": "string",
"description": "Required. State (or province) is which the tax is applicable, described by its location ID (also called criteria ID).",
"format": "uint64"
},
"shippingTaxed": {
"type": "boolean",
"description": "If true, shipping charges are also taxed."
}
},
"type": "object"
},
"PosSaleResponse": {
"type": "object",
"properties": {
"gtin": {
"description": "Global Trade Item Number.",
"type": "string"
},
"targetCountry": {
"type": "string",
"description": "Required. The CLDR territory code for the item."
},
"storeCode": {
"type": "string",
"description": "Required. The identifier of the merchant's store. Either a `storeCode` inserted via the API or the code of the store in Google My Business."
},
"price": {
"description": "Required. The price of the item.",
"$ref": "Price"
},
"timestamp": {
"type": "string",
"description": "Required. The inventory timestamp, in ISO 8601 format."
},
"contentLanguage": {
"type": "string",
"description": "Required. The two-letter ISO 639-1 language code for the item."
},
"itemId": {
"description": "Required. A unique identifier for the item.",
"type": "string"
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#posSaleResponse\"."
},
"quantity": {
"format": "int64",
"description": "Required. The relative change of the available quantity. Negative for items returned.",
"type": "string"
},
"saleId": {
"description": "A unique ID to group items from the same sale event.",
"type": "string"
}
},
"id": "PosSaleResponse"
},
"OrdersGetByMerchantOrderIdResponse": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersGetByMerchantOrderIdResponse\"."
},
"order": {
"description": "The requested order.",
"$ref": "Order"
}
},
"id": "OrdersGetByMerchantOrderIdResponse"
},
"MinimumOrderValueTableStoreCodeSetWithMov": {
"properties": {
"storeCodes": {
"items": {
"type": "string"
},
"description": "A list of unique store codes or empty for the catch all.",
"type": "array"
},
"value": {
"$ref": "Price",
"description": "The minimum order value for the given stores."
}
},
"type": "object",
"id": "MinimumOrderValueTableStoreCodeSetWithMov",
"description": "A list of store code sets sharing the same minimum order value. At least two sets are required and the last one must be empty, which signifies 'MOV for all other stores'. Each store code can only appear once across all the sets. All prices within a service must have the same currency."
},
"ShippingsettingsCustomBatchRequestEntry": {
"type": "object",
"id": "ShippingsettingsCustomBatchRequestEntry",
"description": "A batch entry encoding a single non-batch shippingsettings request.",
"properties": {
"method": {
"type": "string",
"description": "The method of the batch entry. Acceptable values are: - \"`get`\" - \"`update`\" "
},
"merchantId": {
"description": "The ID of the managing account.",
"format": "uint64",
"type": "string"
},
"shippingSettings": {
"$ref": "ShippingSettings",
"description": "The account shipping settings to update. Only defined if the method is `update`."
},
"accountId": {
"description": "The ID of the account for which to get/update account shipping settings.",
"format": "uint64",
"type": "string"
},
"batchId": {
"type": "integer",
"description": "An entry ID, unique within the batch request.",
"format": "uint32"
}
}
},
"OrdersReturnRefundLineItemResponse": {
"properties": {
"executionStatus": {
"type": "string",
"description": "The status of the execution. Acceptable values are: - \"`duplicate`\" - \"`executed`\" "
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersReturnRefundLineItemResponse\".",
"type": "string"
}
},
"type": "object",
"id": "OrdersReturnRefundLineItemResponse"
},
"OrderreturnsReturnItem": {
"type": "object",
"id": "OrderreturnsReturnItem",
"properties": {
"reject": {
"$ref": "OrderreturnsRejectOperation",
"description": "Rejects the item."
},
"refund": {
"$ref": "OrderreturnsRefundOperation",
"description": "Refunds the item."
},
"returnItemId": {
"type": "string",
"description": "Unit level ID for the return item. Different units of the same product will have different IDs."
}
}
},
"ProductStatus": {
"properties": {
"lastUpdateDate": {
"type": "string",
"description": "Date on which the item has been last updated, in ISO 8601 format."
},
"creationDate": {
"type": "string",
"description": "Date on which the item has been created, in ISO 8601 format."
},
"itemLevelIssues": {
"type": "array",
"items": {
"$ref": "ProductStatusItemLevelIssue"
},
"description": "A list of all issues associated with the product."
},
"destinationStatuses": {
"type": "array",
"description": "The intended destinations for the product.",
"items": {
"$ref": "ProductStatusDestinationStatus"
}
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"`content#productStatus`\""
},
"title": {
"description": "The title of the product.",
"type": "string"
},
"googleExpirationDate": {
"type": "string",
"description": "Date on which the item expires in Google Shopping, in ISO 8601 format."
},
"productId": {
"description": "The ID of the product for which status is reported.",
"type": "string"
},
"link": {
"type": "string",
"description": "The link to the product."
}
},
"type": "object",
"id": "ProductStatus",
"description": "The status of a product, i.e., information about a product computed asynchronously."
},
"ListCollectionStatusesResponse": {
"description": "Response message for the ListCollectionStatuses method.",
"id": "ListCollectionStatusesResponse",
"type": "object",
"properties": {
"resources": {
"items": {
"$ref": "CollectionStatus"
},
"description": "The collectionstatuses listed.",
"type": "array"
},
"nextPageToken": {
"description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.",
"type": "string"
}
}
},
"SearchRequest": {
"description": "Request message for the ReportService.Search method.",
"properties": {
"pageSize": {
"description": "Number of ReportRows to retrieve in a single page. Defaults to the maximum of 1000. Values above 1000 are coerced to 1000.",
"format": "int32",
"type": "integer"
},
"pageToken": {
"description": "Token of the page to retrieve. If not specified, the first page of results is returned. In order to request the next page of results, the value obtained from `next_page_token` in the previous response should be used.",
"type": "string"
},
"query": {
"description": "Required. Query that defines performance metrics to retrieve and dimensions according to which the metrics are to be segmented. ",
"type": "string"
}
},
"id": "SearchRequest",
"type": "object"
},
"AccountsCustomBatchRequestEntryLinkRequest": {
"type": "object",
"properties": {
"linkedAccountId": {
"type": "string",
"description": "The ID of the linked account."
},
"linkType": {
"description": "Type of the link between the two accounts. Acceptable values are: - \"`channelPartner`\" - \"`eCommercePlatform`\" ",
"type": "string"
},
"action": {
"type": "string",
"description": "Action to perform for this link. The `\"request\"` action is only available to select merchants. Acceptable values are: - \"`approve`\" - \"`remove`\" - \"`request`\" "
},
"services": {
"description": "Provided services. Acceptable values are: - \"`shoppingAdsProductManagement`\" - \"`shoppingActionsProductManagement`\" - \"`shoppingActionsOrderManagement`\" ",
"type": "array",
"items": {
"type": "string"
}
}
},
"id": "AccountsCustomBatchRequestEntryLinkRequest"
},
"OrderLineItemAdjustment": {
"properties": {
"type": {
"description": "Type of this adjustment. Acceptable values are: - \"`promotion`\" ",
"type": "string"
},
"priceAdjustment": {
"$ref": "Price",
"description": "Adjustment for total price of the line item."
},
"taxAdjustment": {
"description": "Adjustment for total tax of the line item.",
"$ref": "Price"
}
},
"type": "object",
"id": "OrderLineItemAdjustment"
},
"OrdersShipLineItemsResponse": {
"id": "OrdersShipLineItemsResponse",
"properties": {
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersShipLineItemsResponse\"."
},
"executionStatus": {
"type": "string",
"description": "The status of the execution. Acceptable values are: - \"`duplicate`\" - \"`executed`\" "
}
},
"type": "object"
},
"OrderreturnsRejectOperation": {
"id": "OrderreturnsRejectOperation",
"type": "object",
"properties": {
"reasonText": {
"description": "The explanation of the reason.",
"type": "string"
},
"reason": {
"description": "The reason for the return.",
"type": "string"
}
}
},
"TransitTable": {
"id": "TransitTable",
"properties": {
"postalCodeGroupNames": {
"description": "A list of postal group names. The last value can be `\"all other locations\"`. Example: `[\"zone 1\", \"zone 2\", \"all other locations\"]`. The referred postal code groups must match the delivery country of the service.",
"type": "array",
"items": {
"type": "string"
}
},
"transitTimeLabels": {
"items": {
"type": "string"
},
"description": "A list of transit time labels. The last value can be `\"all other labels\"`. Example: `[\"food\", \"electronics\", \"all other labels\"]`.",
"type": "array"
},
"rows": {
"items": {
"$ref": "TransitTableTransitTimeRow"
},
"type": "array"
}
},
"type": "object"
},
"OrdersUpdateLineItemShippingDetailsRequest": {
"id": "OrdersUpdateLineItemShippingDetailsRequest",
"type": "object",
"properties": {
"productId": {
"description": "The ID of the product to set metadata. This is the REST ID used in the products service. Either lineItemId or productId is required.",
"type": "string"
},
"operationId": {
"description": "The ID of the operation. Unique across all operations for a given order.",
"type": "string"
},
"shipByDate": {
"type": "string",
"description": "Updated ship by date, in ISO 8601 format. If not specified only deliver by date is updated. Provided date should be within 1 year timeframe and can not be a date in the past."
},
"deliverByDate": {
"type": "string",
"description": "Updated delivery by date, in ISO 8601 format. If not specified only ship by date is updated. Provided date should be within 1 year timeframe and can not be a date in the past."
},
"lineItemId": {
"type": "string",
"description": "The ID of the line item to set metadata. Either lineItemId or productId is required."
}
}
},
"AccountsLinkResponse": {
"properties": {
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#accountsLinkResponse\".",
"type": "string"
}
},
"type": "object",
"id": "AccountsLinkResponse"
},
"DatafeedsListResponse": {
"properties": {
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#datafeedsListResponse\".",
"type": "string"
},
"nextPageToken": {
"description": "The token for the retrieval of the next page of datafeeds.",
"type": "string"
},
"resources": {
"type": "array",
"items": {
"$ref": "Datafeed"
}
}
},
"id": "DatafeedsListResponse",
"type": "object"
},
"Price": {
"properties": {
"currency": {
"type": "string",
"description": "The currency of the price."
},
"value": {
"type": "string",
"description": "The price represented as a number."
}
},
"id": "Price",
"type": "object"
},
"HolidaysHoliday": {
"type": "object",
"properties": {
"deliveryGuaranteeDate": {
"description": "Date on which the order has to arrive at the customer's, in ISO 8601 format. E.g. \"2016-12-24\" for 24th December 2016. Always present.",
"type": "string"
},
"deliveryGuaranteeHour": {
"format": "uint64",
"type": "string",
"description": "Hour of the day in the delivery location's timezone on the guaranteed delivery date by which the order has to arrive at the customer's. Possible values are: 0 (midnight), 1, ..., 12 (noon), 13, ..., 23. Always present."
},
"type": {
"type": "string",
"description": "The holiday type. Always present. Acceptable values are: - \"`Christmas`\" - \"`Easter`\" - \"`Father's Day`\" - \"`Halloween`\" - \"`Independence Day (USA)`\" - \"`Mother's Day`\" - \"`Thanksgiving`\" - \"`Valentine's Day`\" "
},
"countryCode": {
"type": "string",
"description": "The CLDR territory code of the country in which the holiday is available. E.g. \"US\", \"DE\", \"GB\". A holiday cutoff can only be configured in a shipping settings service with matching delivery country. Always present."
},
"id": {
"description": "Unique identifier for the holiday to be used when configuring holiday cutoffs. Always present.",
"type": "string"
},
"date": {
"description": "Date of the holiday, in ISO 8601 format. E.g. \"2016-12-25\" for Christmas 2016. Always present.",
"type": "string"
}
},
"id": "HolidaysHoliday"
},
"SettlementTransaction": {
"type": "object",
"id": "SettlementTransaction",
"properties": {
"amount": {
"description": "The amount for the transaction.",
"$ref": "SettlementTransactionAmount"
},
"identifiers": {
"description": "Identifiers of the transaction.",
"$ref": "SettlementTransactionIdentifiers"
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"`content#settlementTransaction`\"",
"type": "string"
},
"transaction": {
"description": "Details of the transaction.",
"$ref": "SettlementTransactionTransaction"
}
},
"description": "Settlement transactions give a detailed breakdown of the settlement report."
},
"Errors": {
"type": "object",
"id": "Errors",
"description": "A list of errors returned by a failed batch entry.",
"properties": {
"message": {
"description": "The message of the first error in `errors`.",
"type": "string"
},
"errors": {
"description": "A list of errors.",
"type": "array",
"items": {
"$ref": "Error"
}
},
"code": {
"type": "integer",
"format": "uint32",
"description": "The HTTP status of the first error in `errors`."
}
}
},
"Installment": {
"type": "object",
"properties": {
"amount": {
"$ref": "Price",
"description": "The amount the buyer has to pay per month."
},
"months": {
"format": "int64",
"description": "The number of installments the buyer has to pay.",
"type": "string"
}
},
"id": "Installment"
},
"OrdersUpdateShipmentRequest": {
"id": "OrdersUpdateShipmentRequest",
"properties": {
"carrier": {
"type": "string",
"description": "The carrier handling the shipment. Not updated if missing. See `shipments[].carrier` in the Orders resource representation for a list of acceptable values."
},
"trackingId": {
"type": "string",
"description": "The tracking ID for the shipment. Not updated if missing."
},
"undeliveredDate": {
"type": "string",
"description": "Date on which the shipment has been undeliverable, in ISO 8601 format. Optional and can be provided only if `status` is `undeliverable`."
},
"status": {
"type": "string",
"description": "New status for the shipment. Not updated if missing. Acceptable values are: - \"`delivered`\" - \"`undeliverable`\" - \"`readyForPickup`\" "
},
"lastPickupDate": {
"description": "Date after which the pickup will expire, in ISO 8601 format. Required only when order is buy-online-pickup-in-store(BOPIS) and `status` is `ready for pickup`.",
"type": "string"
},
"readyPickupDate": {
"type": "string",
"description": "Date on which the shipment has been ready for pickup, in ISO 8601 format. Optional and can be provided only if `status` is `ready for pickup`."
},
"shipmentId": {
"description": "The ID of the shipment.",
"type": "string"
},
"deliveryDate": {
"type": "string",
"description": "Date on which the shipment has been delivered, in ISO 8601 format. Optional and can be provided only if `status` is `delivered`."
},
"scheduledDeliveryDetails": {
"$ref": "OrdersCustomBatchRequestEntryUpdateShipmentScheduledDeliveryDetails",
"description": "Delivery details of the shipment if scheduling is needed."
},
"operationId": {
"description": "The ID of the operation. Unique across all operations for a given order.",
"type": "string"
}
},
"type": "object"
},
"LocalinventoryCustomBatchRequest": {
"properties": {
"entries": {
"type": "array",
"description": "The request entries to be processed in the batch.",
"items": {
"$ref": "LocalinventoryCustomBatchRequestEntry"
}
}
},
"id": "LocalinventoryCustomBatchRequest",
"type": "object"
},
"ReturnPolicy": {
"id": "ReturnPolicy",
"type": "object",
"properties": {
"label": {
"description": "Required. The user-defined label of the return policy. For the default policy, use the label \"default\".",
"type": "string"
},
"returnShippingFee": {
"description": "The return shipping fee that will apply to non free return reasons.",
"$ref": "Price"
},
"policy": {
"description": "Required. The policy.",
"$ref": "ReturnPolicyPolicy"
},
"returnPolicyId": {
"description": "Return policy ID generated by Google.",
"type": "string"
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"`content#returnPolicy`\"",
"type": "string"
},
"seasonalOverrides": {
"items": {
"$ref": "ReturnPolicySeasonalOverride"
},
"description": "An optional list of seasonal overrides.",
"type": "array"
},
"nonFreeReturnReasons": {
"description": "Return reasons that will incur return fees.",
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"type": "string",
"description": "Required. The name of the policy as shown in Merchant Center."
},
"country": {
"description": "Required. The country of sale where the return policy is applicable.",
"type": "string"
}
},
"description": "Return policy resource."
},
"SettlementTransactionIdentifiers": {
"type": "object",
"id": "SettlementTransactionIdentifiers",
"properties": {
"settlementEntryId": {
"description": "The unique ID of the settlement transaction entry.",
"type": "string"
},
"orderItemId": {
"description": "The identifier of the item.",
"type": "string"
},
"transactionId": {
"description": "The Google transaction ID.",
"type": "string"
},
"adjustmentId": {
"description": "The identifier of the adjustments, if it is available.",
"type": "string"
},
"merchantOrderId": {
"type": "string",
"description": "The merchant provided order ID."
},
"shipmentIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "The shipment ids for the item."
}
}
},
"AccountYouTubeChannelLink": {
"properties": {
"status": {
"description": "Status of the link between this Merchant Center account and the YouTube channel. Upon retrieval, it represents the actual status of the link and can be either `active` if it was approved in YT Creator Studio or `pending` if it's pending approval. Upon insertion, it represents the *intended* status of the link. Re-uploading a link with status `active` when it's still pending or with status `pending` when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status `inactive` is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending.",
"type": "string"
},
"channelId": {
"type": "string",
"description": "Channel ID."
}
},
"type": "object",
"id": "AccountYouTubeChannelLink"
},
"DatafeedsFetchNowResponse": {
"properties": {
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#datafeedsFetchNowResponse\".",
"type": "string"
}
},
"id": "DatafeedsFetchNowResponse",
"type": "object"
},
"MerchantRejectionReason": {
"id": "MerchantRejectionReason",
"properties": {
"description": {
"type": "string",
"description": "Description of the reason."
},
"reasonCode": {
"type": "string",
"description": "Code of the rejection reason."
}
},
"type": "object"
},
"AccountBusinessInformation": {
"id": "AccountBusinessInformation",
"type": "object",
"properties": {
"phoneNumber": {
"description": "The phone number of the business.",
"type": "string"
},
"address": {
"description": "The address of the business.",
"$ref": "AccountAddress"
},
"customerService": {
"description": "The customer service information of the business.",
"$ref": "AccountCustomerService"
}
}
},
"TestOrderPickupDetails": {
"properties": {
"pickupLocationType": {
"description": "Pickup location type. Acceptable values are: - \"`locker`\" - \"`store`\" - \"`curbside`\" ",
"type": "string"
},
"pickupLocationAddress": {
"description": "Required. Pickup location address.",
"$ref": "TestOrderAddress"
},
"pickupPersons": {
"items": {
"$ref": "TestOrderPickupDetailsPickupPerson"
},
"type": "array",
"description": "Required. all pickup persons set by users."
},
"locationCode": {
"description": "Required. Code of the location defined by provider or merchant.",
"type": "string"
}
},
"id": "TestOrderPickupDetails",
"type": "object"
},
"OrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceRefundOption": {
"type": "object",
"id": "OrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceRefundOption",
"properties": {
"reason": {
"type": "string",
"description": "[required] Reason for the refund. Acceptable values are: - \"`adjustment`\" - \"`autoPostInternal`\" - \"`autoPostInvalidBillingAddress`\" - \"`autoPostNoInventory`\" - \"`autoPostPriceError`\" - \"`autoPostUndeliverableShippingAddress`\" - \"`couponAbuse`\" - \"`courtesyAdjustment`\" - \"`customerCanceled`\" - \"`customerDiscretionaryReturn`\" - \"`customerInitiatedMerchantCancel`\" - \"`customerSupportRequested`\" - \"`deliveredLateByCarrier`\" - \"`deliveredTooLate`\" - \"`expiredItem`\" - \"`failToPushOrderGoogleError`\" - \"`failToPushOrderMerchantError`\" - \"`failToPushOrderMerchantFulfillmentError`\" - \"`failToPushOrderToMerchant`\" - \"`failToPushOrderToMerchantOutOfStock`\" - \"`feeAdjustment`\" - \"`invalidCoupon`\" - \"`lateShipmentCredit`\" - \"`malformedShippingAddress`\" - \"`merchantDidNotShipOnTime`\" - \"`noInventory`\" - \"`orderTimeout`\" - \"`other`\" - \"`paymentAbuse`\" - \"`paymentDeclined`\" - \"`priceAdjustment`\" - \"`priceError`\" - \"`productArrivedDamaged`\" - \"`productNotAsDescribed`\" - \"`promoReallocation`\" - \"`qualityNotAsExpected`\" - \"`returnRefundAbuse`\" - \"`shippingCostAdjustment`\" - \"`shippingPriceError`\" - \"`taxAdjustment`\" - \"`taxError`\" - \"`undeliverableShippingAddress`\" - \"`unsupportedPoBoxAddress`\" - \"`wrongProductShipped`\" "
},
"description": {
"type": "string",
"description": "Optional description of the refund reason."
}
}
},
"PostalCodeRange": {
"type": "object",
"properties": {
"postalCodeRangeBegin": {
"description": "A postal code or a pattern of the form `prefix*` denoting the inclusive lower bound of the range defining the area. Examples values: `\"94108\"`, `\"9410*\"`, `\"9*\"`. Required.",
"type": "string"
},
"postalCodeRangeEnd": {
"type": "string",
"description": "A postal code or a pattern of the form `prefix*` denoting the inclusive upper bound of the range defining the area. It must have the same length as `postalCodeRangeBegin`: if `postalCodeRangeBegin` is a postal code then `postalCodeRangeEnd` must be a postal code too; if `postalCodeRangeBegin` is a pattern then `postalCodeRangeEnd` must be a pattern with the same prefix length. Optional: if not set, then the area is defined as being all the postal codes matching `postalCodeRangeBegin`."
}
},
"id": "PostalCodeRange"
},
"AccountLabel": {
"description": "Label assigned by CSS domain or CSS group to one of its sub-accounts.",
"id": "AccountLabel",
"type": "object",
"properties": {
"labelType": {
"readOnly": true,
"enumDescriptions": [
"Unknown label type.",
"Indicates that the label was created manually.",
"Indicates that the label was created automatically by CSS Center."
],
"description": "Output only. The type of this label.",
"enum": [
"LABEL_TYPE_UNSPECIFIED",
"MANUAL",
"AUTOMATIC"
],
"type": "string"
},
"name": {
"description": "The display name of this label.",
"type": "string"
},
"labelId": {
"description": "Output only. The ID of the label.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"accountId": {
"format": "int64",
"type": "string",
"description": "Immutable. The ID of account this label belongs to."
},
"description": {
"description": "The description of this label.",
"type": "string"
}
}
},
"LiasettingsRequestInventoryVerificationResponse": {
"properties": {
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#liasettingsRequestInventoryVerificationResponse\"."
}
},
"id": "LiasettingsRequestInventoryVerificationResponse",
"type": "object"
},
"Error": {
"description": "An error returned by the API.",
"type": "object",
"properties": {
"domain": {
"description": "The domain of the error.",
"type": "string"
},
"message": {
"type": "string",
"description": "A description of the error."
},
"reason": {
"description": "The error code.",
"type": "string"
}
},
"id": "Error"
},
"OrderLineItemReturnInfo": {
"type": "object",
"id": "OrderLineItemReturnInfo",
"properties": {
"daysToReturn": {
"description": "Required. How many days later the item can be returned.",
"format": "int32",
"type": "integer"
},
"isReturnable": {
"description": "Required. Whether the item is returnable.",
"type": "boolean"
},
"policyUrl": {
"description": "Required. URL of the item return policy.",
"type": "string"
}
}
},
"OrdersUpdateMerchantOrderIdResponse": {
"properties": {
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersUpdateMerchantOrderIdResponse\".",
"type": "string"
},
"executionStatus": {
"description": "The status of the execution. Acceptable values are: - \"`duplicate`\" - \"`executed`\" ",
"type": "string"
}
},
"type": "object",
"id": "OrdersUpdateMerchantOrderIdResponse"
},
"Table": {
"properties": {
"columnHeaders": {
"description": "Headers of the table's columns. Optional: if not set then the table has only one dimension.",
"$ref": "Headers"
},
"rows": {
"description": "The list of rows that constitute the table. Must have the same length as `rowHeaders`. Required.",
"items": {
"$ref": "Row"
},
"type": "array"
},
"name": {
"type": "string",
"description": "Name of the table. Required for subtables, ignored for the main table."
},
"rowHeaders": {
"$ref": "Headers",
"description": "Headers of the table's rows. Required."
}
},
"type": "object",
"id": "Table"
},
"OrderreturnsCreateOrderReturnRequest": {
"id": "OrderreturnsCreateOrderReturnRequest",
"properties": {
"lineItems": {
"items": {
"$ref": "OrderreturnsLineItem"
},
"type": "array",
"description": "The list of line items to return."
},
"operationId": {
"description": "The ID of the operation. Unique across all operations for a given order.",
"type": "string"
},
"orderId": {
"type": "string",
"description": "The ID of the order."
},
"returnMethodType": {
"description": "The way of the package being returned.",
"type": "string"
}
},
"type": "object"
},
"CarrierRate": {
"id": "CarrierRate",
"properties": {
"carrierName": {
"type": "string",
"description": "Carrier service, such as `\"UPS\"` or `\"Fedex\"`. The list of supported carriers can be retrieved via the `getSupportedCarriers` method. Required."
},
"originPostalCode": {
"type": "string",
"description": "Shipping origin for this carrier rate. Required."
},
"flatAdjustment": {
"description": "Additive shipping rate modifier. Can be negative. For example `{ \"value\": \"1\", \"currency\" : \"USD\" }` adds $1 to the rate, `{ \"value\": \"-3\", \"currency\" : \"USD\" }` removes $3 from the rate. Optional.",
"$ref": "Price"
},
"carrierService": {
"type": "string",
"description": "Carrier service, such as `\"ground\"` or `\"2 days\"`. The list of supported services for a carrier can be retrieved via the `getSupportedCarriers` method. Required."
},
"name": {
"type": "string",
"description": "Name of the carrier rate. Must be unique per rate group. Required."
},
"percentageAdjustment": {
"description": "Multiplicative shipping rate modifier as a number in decimal notation. Can be negative. For example `\"5.4\"` increases the rate by 5.4%, `\"-3\"` decreases the rate by 3%. Optional.",
"type": "string"
}
},
"type": "object"
},
"OrderTrackingSignalLineItemDetails": {
"type": "object",
"properties": {
"productId": {
"type": "string",
"description": "Required. The Content API REST ID of the product, in the form channel:contentLanguage:targetCountry:offerId."
},
"lineItemId": {
"type": "string",
"description": "Required. The ID for this line item."
},
"mpn": {
"description": "The manufacturer part number.",
"type": "string"
},
"gtin": {
"type": "string",
"description": "The Global Trade Item Number."
},
"quantity": {
"type": "string",
"description": "Required. The quantity of the line item in the order.",
"format": "int64"
}
},
"id": "OrderTrackingSignalLineItemDetails",
"description": "The line items of the order."
},
"OrderreportsListDisbursementsResponse": {
"properties": {
"disbursements": {
"items": {
"$ref": "OrderReportDisbursement"
},
"description": "The list of disbursements.",
"type": "array"
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#orderreportsListDisbursementsResponse\".",
"type": "string"
},
"nextPageToken": {
"type": "string",
"description": "The token for the retrieval of the next page of disbursements."
}
},
"type": "object",
"id": "OrderreportsListDisbursementsResponse"
},
"OrdersCustomBatchRequestEntryCreateTestReturnReturnItem": {
"type": "object",
"properties": {
"quantity": {
"type": "integer",
"format": "uint32",
"description": "Quantity that is returned."
},
"lineItemId": {
"description": "The ID of the line item to return.",
"type": "string"
}
},
"id": "OrdersCustomBatchRequestEntryCreateTestReturnReturnItem"
},
"DeliveryTime": {
"type": "object",
"id": "DeliveryTime",
"properties": {
"handlingBusinessDayConfig": {
"$ref": "BusinessDayConfig",
"description": "The business days during which orders can be handled. If not provided, Monday to Friday business days will be assumed."
},
"minHandlingTimeInDays": {
"format": "uint32",
"type": "integer",
"description": "Minimum number of business days spent before an order is shipped. 0 means same day shipped, 1 means next day shipped."
},
"holidayCutoffs": {
"items": {
"$ref": "HolidayCutoff"
},
"type": "array",
"description": "Holiday cutoff definitions. If configured, they specify order cutoff times for holiday-specific shipping."
},
"transitTimeTable": {
"$ref": "TransitTable",
"description": "Transit time table, number of business days spent in transit based on row and column dimensions. Either `{min,max}TransitTimeInDays` or `transitTimeTable` can be set, but not both."
},
"minTransitTimeInDays": {
"format": "uint32",
"type": "integer",
"description": "Minimum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Either `{min,max}TransitTimeInDays` or `transitTimeTable` must be set, but not both."
},
"maxTransitTimeInDays": {
"format": "uint32",
"description": "Maximum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Must be greater than or equal to `minTransitTimeInDays`.",
"type": "integer"
},
"maxHandlingTimeInDays": {
"format": "uint32",
"type": "integer",
"description": "Maximum number of business days spent before an order is shipped. 0 means same day shipped, 1 means next day shipped. Must be greater than or equal to `minHandlingTimeInDays`."
},
"transitBusinessDayConfig": {
"$ref": "BusinessDayConfig",
"description": "The business days during which orders can be in-transit. If not provided, Monday to Friday business days will be assumed."
},
"cutoffTime": {
"description": "Business days cutoff time definition. If not configured the cutoff time will be defaulted to 8AM PST.",
"$ref": "CutoffTime"
}
}
},
"PosCustomBatchRequest": {
"id": "PosCustomBatchRequest",
"properties": {
"entries": {
"type": "array",
"description": "The request entries to be processed in the batch.",
"items": {
"$ref": "PosCustomBatchRequestEntry"
}
}
},
"type": "object"
},
"AccounttaxCustomBatchRequestEntry": {
"properties": {
"batchId": {
"format": "uint32",
"type": "integer",
"description": "An entry ID, unique within the batch request."
},
"accountId": {
"format": "uint64",
"description": "The ID of the account for which to get/update account tax settings.",
"type": "string"
},
"merchantId": {
"format": "uint64",
"type": "string",
"description": "The ID of the managing account."
},
"accountTax": {
"$ref": "AccountTax",
"description": "The account tax settings to update. Only defined if the method is `update`."
},
"method": {
"type": "string",
"description": "The method of the batch entry. Acceptable values are: - \"`get`\" - \"`update`\" "
}
},
"description": "A batch entry encoding a single non-batch accounttax request.",
"id": "AccounttaxCustomBatchRequestEntry",
"type": "object"
},
"ProductUnitPricingMeasure": {
"id": "ProductUnitPricingMeasure",
"properties": {
"value": {
"description": "The measure of an item.",
"type": "number",
"format": "double"
},
"unit": {
"description": "The unit of the measure.",
"type": "string"
}
},
"type": "object"
},
"OrderinvoicesCreateRefundInvoiceResponse": {
"properties": {
"executionStatus": {
"type": "string",
"description": "The status of the execution. Acceptable values are: - \"`duplicate`\" - \"`executed`\" "
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#orderinvoicesCreateRefundInvoiceResponse\"."
}
},
"type": "object",
"id": "OrderinvoicesCreateRefundInvoiceResponse"
},
"OrderReportTransaction": {
"properties": {
"disbursementDate": {
"description": "The date the disbursement was initiated, in ISO 8601 format.",
"type": "string"
},
"orderId": {
"type": "string",
"description": "The ID of the order."
},
"disbursementAmount": {
"description": "The disbursement amount.",
"$ref": "Price"
},
"disbursementCreationDate": {
"description": "The date the disbursement was created, in ISO 8601 format.",
"type": "string"
},
"merchantId": {
"type": "string",
"description": "The ID of the managing account.",
"format": "uint64"
},
"transactionDate": {
"type": "string",
"description": "The date of the transaction, in ISO 8601 format."
},
"disbursementId": {
"type": "string",
"description": "The ID of the disbursement."
},
"productAmount": {
"$ref": "ProductAmount",
"description": "Total amount for the items."
},
"merchantOrderId": {
"description": "Merchant-provided ID of the order.",
"type": "string"
}
},
"type": "object",
"id": "OrderReportTransaction"
},
"LinkedAccount": {
"properties": {
"linkedAccountId": {
"type": "string",
"description": "The ID of the linked account."
},
"services": {
"items": {
"$ref": "LinkService"
},
"type": "array",
"description": "List of provided services."
}
},
"id": "LinkedAccount",
"type": "object"
},
"ShipmentTrackingInfo": {
"id": "ShipmentTrackingInfo",
"properties": {
"carrier": {
"type": "string",
"description": "The shipping carrier that handles the package. Acceptable values are: - \"`boxtal`\" - \"`bpost`\" - \"`chronopost`\" - \"`colisPrive`\" - \"`colissimo`\" - \"`cxt`\" - \"`deliv`\" - \"`dhl`\" - \"`dpd`\" - \"`dynamex`\" - \"`eCourier`\" - \"`easypost`\" - \"`efw`\" - \"`fedex`\" - \"`fedexSmartpost`\" - \"`geodis`\" - \"`gls`\" - \"`googleCourier`\" - \"`gsx`\" - \"`jdLogistics`\" - \"`laPoste`\" - \"`lasership`\" - \"`manual`\" - \"`mpx`\" - \"`onTrac`\" - \"`other`\" - \"`tnt`\" - \"`uds`\" - \"`ups`\" - \"`usps`\" "
},
"trackingNumber": {
"type": "string",
"description": "The tracking number for the package."
}
},
"type": "object"
},
"OrderReportDisbursement": {
"id": "OrderReportDisbursement",
"properties": {
"disbursementAmount": {
"$ref": "Price",
"description": "The disbursement amount."
},
"disbursementId": {
"type": "string",
"description": "The ID of the disbursement."
},
"disbursementDate": {
"type": "string",
"description": "The date the disbursement was initiated, in ISO 8601 format."
},
"disbursementCreationDate": {
"type": "string",
"description": "The disbursement date, in ISO 8601 format."
},
"merchantId": {
"format": "uint64",
"type": "string",
"description": "The ID of the managing account."
}
},
"type": "object",
"description": "Order disbursement. All methods require the payment analyst role."
},
"OrderOrderAnnotation": {
"properties": {
"key": {
"description": "Key for additional google provided (as key-value pairs) annotation.",
"type": "string"
},
"value": {
"description": "Value for additional google provided (as key-value pairs) annotation.",
"type": "string"
}
},
"id": "OrderOrderAnnotation",
"type": "object"
},
"AccountsCustomBatchResponse": {
"properties": {
"entries": {
"items": {
"$ref": "AccountsCustomBatchResponseEntry"
},
"description": "The result of the execution of the batch requests.",
"type": "array"
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#accountsCustomBatchResponse\".",
"type": "string"
}
},
"id": "AccountsCustomBatchResponse",
"type": "object"
},
"OrdersRejectReturnLineItemResponse": {
"id": "OrdersRejectReturnLineItemResponse",
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersRejectReturnLineItemResponse\"."
},
"executionStatus": {
"type": "string",
"description": "The status of the execution. Acceptable values are: - \"`duplicate`\" - \"`executed`\" "
}
}
},
"AccountAdsLink": {
"properties": {
"adsId": {
"format": "uint64",
"description": "Customer ID of the Ads account.",
"type": "string"
},
"status": {
"type": "string",
"description": "Status of the link between this Merchant Center account and the Ads account. Upon retrieval, it represents the actual status of the link and can be either `active` if it was approved in Google Ads or `pending` if it's pending approval. Upon insertion, it represents the *intended* status of the link. Re-uploading a link with status `active` when it's still pending or with status `pending` when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status `inactive` is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending. Acceptable values are: - \"`active`\" - \"`pending`\" "
}
},
"id": "AccountAdsLink",
"type": "object"
},
"OrderreturnsProcessRequest": {
"id": "OrderreturnsProcessRequest",
"type": "object",
"properties": {
"fullChargeReturnShippingCost": {
"description": "Option to charge the customer return shipping cost.",
"type": "boolean"
},
"operationId": {
"description": "[required] The ID of the operation, unique across all operations for a given order return.",
"type": "string"
},
"returnItems": {
"items": {
"$ref": "OrderreturnsReturnItem"
},
"description": "The list of items to return.",
"type": "array"
},
"refundShippingFee": {
"$ref": "OrderreturnsRefundOperation",
"description": "Refunds for original shipping fee."
}
}
},
"CollectionStatus": {
"type": "object",
"properties": {
"lastUpdateDate": {
"description": "Date on which the collection has been last updated in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format: Date, time, and offset, e.g. \"2020-01-02T09:00:00+01:00\" or \"2020-01-02T09:00:00Z\"",
"type": "string"
},
"destinationStatuses": {
"type": "array",
"items": {
"$ref": "CollectionStatusDestinationStatus"
},
"description": "The intended destinations for the collection."
},
"creationDate": {
"type": "string",
"description": "Date on which the collection has been created in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format: Date, time, and offset, e.g. \"2020-01-02T09:00:00+01:00\" or \"2020-01-02T09:00:00Z\""
},
"collectionLevelIssuses": {
"items": {
"$ref": "CollectionStatusItemLevelIssue"
},
"type": "array",
"description": "A list of all issues associated with the collection."
},
"id": {
"description": "Required. The ID of the collection for which status is reported.",
"type": "string"
}
},
"description": "The collectionstatus message.",
"id": "CollectionStatus"
},
"OrderreturnsAcknowledgeRequest": {
"type": "object",
"properties": {
"operationId": {
"description": "[required] The ID of the operation, unique across all operations for a given order return.",
"type": "string"
}
},
"id": "OrderreturnsAcknowledgeRequest"
},
"PosCustomBatchResponseEntry": {
"properties": {
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"`content#posCustomBatchResponseEntry`\"",
"type": "string"
},
"sale": {
"description": "The updated sale information.",
"$ref": "PosSale"
},
"batchId": {
"format": "uint32",
"type": "integer",
"description": "The ID of the request entry to which this entry responds."
},
"inventory": {
"description": "The updated inventory information.",
"$ref": "PosInventory"
},
"errors": {
"$ref": "Errors",
"description": "A list of errors defined if, and only if, the request failed."
},
"store": {
"description": "The retrieved or updated store information.",
"$ref": "PosStore"
}
},
"id": "PosCustomBatchResponseEntry",
"type": "object"
},
"ReturnAddress": {
"description": "Return address resource.",
"properties": {
"label": {
"type": "string",
"description": "Required. The user-defined label of the return address. For the default address, use the label \"default\"."
},
"country": {
"description": "Required. The country of sale where the return address is applicable.",
"type": "string"
},
"address": {
"$ref": "ReturnAddressAddress",
"description": "Required. The address."
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"`content#returnAddress`\""
},
"returnAddressId": {
"type": "string",
"description": "Return address ID generated by Google."
},
"phoneNumber": {
"type": "string",
"description": "Required. The merchant's contact phone number regarding the return."
}
},
"type": "object",
"id": "ReturnAddress"
},
"OrdersInStoreRefundLineItemResponse": {
"properties": {
"executionStatus": {
"type": "string",
"description": "The status of the execution. Acceptable values are: - \"`duplicate`\" - \"`executed`\" "
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersInStoreRefundLineItemResponse\"."
}
},
"type": "object",
"id": "OrdersInStoreRefundLineItemResponse"
},
"RegionalInventory": {
"id": "RegionalInventory",
"description": "Regional inventory resource. contains the regional name and all attributes which are overridden for the specified region.",
"properties": {
"regionId": {
"description": "The ID uniquely identifying each region.",
"type": "string"
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#regionalInventory\"."
},
"customAttributes": {
"description": "A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the feed specification in its generic form.",
"type": "array",
"items": {
"$ref": "CustomAttribute"
}
},
"price": {
"$ref": "Price",
"description": "The price of the product."
},
"availability": {
"type": "string",
"description": "The availability of the product."
},
"salePriceEffectiveDate": {
"description": "A date range represented by a pair of ISO 8601 dates separated by a space, comma, or slash. Both dates might be specified as 'null' if undecided.",
"type": "string"
},
"salePrice": {
"$ref": "Price",
"description": "The sale price of the product. Mandatory if `sale_price_effective_date` is defined."
}
},
"type": "object"
},
"OrderMerchantProvidedAnnotation": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "Value for additional merchant provided (as key-value pairs) annotation about the line item."
},
"key": {
"description": "Key for additional merchant provided (as key-value pairs) annotation about the line item.",
"type": "string"
}
},
"id": "OrderMerchantProvidedAnnotation"
},
"OrdersReturnRefundLineItemRequest": {
"id": "OrdersReturnRefundLineItemRequest",
"type": "object",
"properties": {
"productId": {
"description": "The ID of the product to return. This is the REST ID used in the products service. Either lineItemId or productId is required.",
"type": "string"
},
"lineItemId": {
"description": "The ID of the line item to return. Either lineItemId or productId is required.",
"type": "string"
},
"reason": {
"type": "string",
"description": "The reason for the return. Acceptable values are: - \"`customerDiscretionaryReturn`\" - \"`customerInitiatedMerchantCancel`\" - \"`deliveredTooLate`\" - \"`expiredItem`\" - \"`invalidCoupon`\" - \"`malformedShippingAddress`\" - \"`other`\" - \"`productArrivedDamaged`\" - \"`productNotAsDescribed`\" - \"`qualityNotAsExpected`\" - \"`undeliverableShippingAddress`\" - \"`unsupportedPoBoxAddress`\" - \"`wrongProductShipped`\" "
},
"taxAmount": {
"$ref": "Price",
"description": "The amount of tax to be refunded. Optional, but if filled, then priceAmount must be set. Calculated automatically if not provided."
},
"reasonText": {
"description": "The explanation of the reason.",
"type": "string"
},
"quantity": {
"format": "uint32",
"description": "The quantity to return and refund. Quantity is required.",
"type": "integer"
},
"operationId": {
"type": "string",
"description": "The ID of the operation. Unique across all operations for a given order."
},
"priceAmount": {
"description": "The amount to be refunded. This may be pre-tax or post-tax depending on the location of the order. If omitted, refundless return is assumed.",
"$ref": "Price"
}
}
},
"OrdersCancelLineItemResponse": {
"type": "object",
"id": "OrdersCancelLineItemResponse",
"properties": {
"executionStatus": {
"description": "The status of the execution. Acceptable values are: - \"`duplicate`\" - \"`executed`\" ",
"type": "string"
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersCancelLineItemResponse\"."
}
}
},
"ReturnpolicyCustomBatchRequestEntry": {
"type": "object",
"properties": {
"returnPolicy": {
"$ref": "ReturnPolicy",
"description": "The return policy to submit. This should be set only if the method is `insert`."
},
"batchId": {
"format": "uint32",
"type": "integer",
"description": "An entry ID, unique within the batch request."
},
"method": {
"description": "Method of the batch request entry. Acceptable values are: - \"`delete`\" - \"`get`\" - \"`insert`\" ",
"type": "string"
},
"merchantId": {
"type": "string",
"description": "The Merchant Center account ID.",
"format": "uint64"
},
"returnPolicyId": {
"description": "The return policy ID. This should be set only if the method is `delete` or `get`.",
"type": "string"
}
},
"id": "ReturnpolicyCustomBatchRequestEntry"
},
"OrdersCustomBatchRequestEntryUpdateShipmentScheduledDeliveryDetails": {
"properties": {
"scheduledDate": {
"description": "The date a shipment is scheduled for delivery, in ISO 8601 format.",
"type": "string"
},
"carrierPhoneNumber": {
"type": "string",
"description": "The phone number of the carrier fulfilling the delivery. The phone number should be formatted as the international notation in"
}
},
"type": "object",
"description": "ScheduledDeliveryDetails used to update the scheduled delivery order.",
"id": "OrdersCustomBatchRequestEntryUpdateShipmentScheduledDeliveryDetails"
},
"OrdersCreateTestReturnRequest": {
"type": "object",
"id": "OrdersCreateTestReturnRequest",
"properties": {
"items": {
"description": "Returned items.",
"type": "array",
"items": {
"$ref": "OrdersCustomBatchRequestEntryCreateTestReturnReturnItem"
}
}
}
},
"ListCollectionsResponse": {
"description": "Response message for the ListCollections method.",
"id": "ListCollectionsResponse",
"properties": {
"resources": {
"items": {
"$ref": "Collection"
},
"type": "array",
"description": "The collections listed."
},
"nextPageToken": {
"description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.",
"type": "string"
}
},
"type": "object"
},
"PostalCodeGroup": {
"id": "PostalCodeGroup",
"properties": {
"postalCodeRanges": {
"type": "array",
"description": "A range of postal codes. Required.",
"items": {
"$ref": "PostalCodeRange"
}
},
"country": {
"type": "string",
"description": "The CLDR territory code of the country the postal code group applies to. Required."
},
"name": {
"description": "The name of the postal code group, referred to in headers. Required.",
"type": "string"
}
},
"type": "object"
},
"LiasettingsCustomBatchResponse": {
"id": "LiasettingsCustomBatchResponse",
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#liasettingsCustomBatchResponse\"."
},
"entries": {
"items": {
"$ref": "LiasettingsCustomBatchResponseEntry"
},
"type": "array",
"description": "The result of the execution of the batch requests."
}
}
},
"OrdersCancelRequest": {
"properties": {
"operationId": {
"description": "The ID of the operation. Unique across all operations for a given order.",
"type": "string"
},
"reasonText": {
"type": "string",
"description": "The explanation of the reason."
},
"reason": {
"description": "The reason for the cancellation. Acceptable values are: - \"`customerInitiatedCancel`\" - \"`invalidCoupon`\" - \"`malformedShippingAddress`\" - \"`noInventory`\" - \"`other`\" - \"`priceError`\" - \"`shippingPriceError`\" - \"`taxError`\" - \"`undeliverableShippingAddress`\" - \"`unsupportedPoBoxAddress`\" ",
"type": "string"
}
},
"type": "object",
"id": "OrdersCancelRequest"
},
"OrdersCustomBatchRequestEntryRefundItemShipping": {
"properties": {
"amount": {
"$ref": "Price",
"description": "The amount that is refunded. If this is not the first refund for the shipment, this should be the newly refunded amount."
},
"fullRefund": {
"description": "If set to true, all shipping costs for the order will be refunded. If this is true, amount should not be provided and will be ignored. If set to false, submit the amount of the partial shipping refund, excluding the shipping tax. The shipping tax is calculated and handled on Google's side.",
"type": "boolean"
}
},
"id": "OrdersCustomBatchRequestEntryRefundItemShipping",
"type": "object"
},
"LiaOnDisplayToOrderSettings": {
"id": "LiaOnDisplayToOrderSettings",
"type": "object",
"properties": {
"shippingCostPolicyUrl": {
"description": "Shipping cost and policy URL.",
"type": "string"
},
"status": {
"type": "string",
"description": "The status of the ?On display to order? feature. Acceptable values are: - \"`active`\" - \"`inactive`\" - \"`pending`\" "
}
}
},
"ReturnPolicyOnlineReturnReasonCategoryInfo": {
"id": "ReturnPolicyOnlineReturnReasonCategoryInfo",
"type": "object",
"properties": {
"returnShippingFee": {
"description": "The corresponding return shipping fee. This is only applicable when returnLabelSource is not the customer's responsibility.",
"$ref": "ReturnPolicyOnlineReturnShippingFee"
},
"returnLabelSource": {
"description": "The corresponding return label source.",
"enum": [
"RETURN_LABEL_SOURCE_UNSPECIFIED",
"DOWNLOAD_AND_PRINT",
"IN_THE_BOX",
"CUSTOMER_RESPONSIBILITY"
],
"type": "string",
"enumDescriptions": [
"Default value. This value is unused.",
"Download and print the label.",
"Label in the box.",
"Customers' responsibility to get the label."
]
},
"returnReasonCategory": {
"description": "The return reason category.",
"enumDescriptions": [
"Default value. This value is unused.",
"Buyer remorse.",
"Item defect."
],
"type": "string",
"enum": [
"RETURN_REASON_CATEGORY_UNSPECIFIED",
"BUYER_REMORSE",
"ITEM_DEFECT"
]
}
},
"description": "The return reason category info wrapper."
},
"PosDataProviders": {
"type": "object",
"properties": {
"country": {
"type": "string",
"description": "Country code."
},
"posDataProviders": {
"type": "array",
"items": {
"$ref": "PosDataProvidersPosDataProvider"
},
"description": "A list of POS data providers."
}
},
"id": "PosDataProviders"
},
"ReturnaddressCustomBatchResponseEntry": {
"id": "ReturnaddressCustomBatchResponseEntry",
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"`content#returnaddressCustomBatchResponseEntry`\""
},
"errors": {
"$ref": "Errors",
"description": "A list of errors defined if, and only if, the request failed."
},
"returnAddress": {
"$ref": "ReturnAddress",
"description": "The retrieved return address."
},
"batchId": {
"description": "The ID of the request entry to which this entry responds.",
"type": "integer",
"format": "uint32"
}
}
},
"ProductstatusesCustomBatchRequest": {
"properties": {
"entries": {
"items": {
"$ref": "ProductstatusesCustomBatchRequestEntry"
},
"type": "array",
"description": "The request entries to be processed in the batch."
}
},
"id": "ProductstatusesCustomBatchRequest",
"type": "object"
},
"BuyOnGoogleProgramStatus": {
"description": "Response message for the GetProgramStatus method.",
"id": "BuyOnGoogleProgramStatus",
"type": "object",
"properties": {
"participationStage": {
"type": "string",
"enumDescriptions": [
"Default value when participation stage is not set.",
"Merchant is not eligible for onboarding to a given program in a specific region code.",
"Merchant is eligible for onboarding to a given program in a specific region code.",
"Merchant is onboarding to a given program in a specific region code.",
"Merchant's program participation is active for a specific region code.",
"Participation has been paused."
],
"enum": [
"PROGRAM_PARTICIPATION_STAGE_UNSPECIFIED",
"NOT_ELIGIBLE",
"ELIGIBLE",
"ONBOARDING",
"ACTIVE",
"PAUSED"
],
"description": "The current participation stage for the program."
},
"customerServiceVerifiedEmail": {
"type": "string",
"description": "The customer service verified email."
},
"customerServicePendingEmail": {
"description": "The customer service pending email.",
"type": "string"
}
}
},
"OrderPromotionItem": {
"properties": {
"offerId": {
"description": "Required. Offer ID of a product. Only for `orders.createtestorder`.",
"type": "string"
},
"lineItemId": {
"type": "string",
"description": "The line item ID of a product. Do not provide for `orders.createtestorder`."
},
"quantity": {
"type": "integer",
"description": "The quantity of the associated product. Do not provide for `orders.createtestorder`.",
"format": "int32"
},
"productId": {
"type": "string",
"description": "`orders.createtestorder`."
}
},
"id": "OrderPromotionItem",
"type": "object"
},
"ShippingsettingsCustomBatchResponse": {
"properties": {
"entries": {
"items": {
"$ref": "ShippingsettingsCustomBatchResponseEntry"
},
"description": "The result of the execution of the batch requests.",
"type": "array"
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#shippingsettingsCustomBatchResponse\".",
"type": "string"
}
},
"type": "object",
"id": "ShippingsettingsCustomBatchResponse"
},
"LocalinventoryCustomBatchResponseEntry": {
"type": "object",
"description": "Batch entry encoding a single local inventory update response.",
"id": "LocalinventoryCustomBatchResponseEntry",
"properties": {
"batchId": {
"format": "uint32",
"description": "The ID of the request entry this entry responds to.",
"type": "integer"
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"`content#localinventoryCustomBatchResponseEntry`\"",
"type": "string"
},
"errors": {
"$ref": "Errors",
"description": "A list of errors defined if and only if the request failed."
}
}
},
"OrdersCreateTestOrderResponse": {
"id": "OrdersCreateTestOrderResponse",
"properties": {
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersCreateTestOrderResponse\"."
},
"orderId": {
"type": "string",
"description": "The ID of the newly created test order."
}
},
"type": "object"
},
"MerchantOrderReturn": {
"description": "Order return. Production access (all methods) requires the order manager role. Sandbox access does not.",
"properties": {
"merchantOrderId": {
"type": "string",
"description": "Merchant defined order ID."
},
"returnPricingInfo": {
"description": "Information about shipping costs.",
"$ref": "ReturnPricingInfo"
},
"orderReturnId": {
"type": "string",
"description": "Order return ID generated by Google."
},
"creationDate": {
"type": "string",
"description": "The date of creation of the return, in ISO 8601 format."
},
"returnItems": {
"type": "array",
"items": {
"$ref": "MerchantOrderReturnItem"
},
"description": "Items of the return."
},
"returnShipments": {
"type": "array",
"description": "Shipments of the return.",
"items": {
"$ref": "ReturnShipment"
}
},
"orderId": {
"description": "Google order ID.",
"type": "string"
}
},
"type": "object",
"id": "MerchantOrderReturn"
},
"ReportRow": {
"id": "ReportRow",
"description": "Result row returned from the search query.",
"properties": {
"metrics": {
"$ref": "Metrics",
"description": "Metrics requested by the merchant in the query. Metric values are only set for metrics requested explicitly in the query."
},
"segments": {
"description": "Segmentation dimensions requested by the merchant in the query. Dimension values are only set for dimensions requested explicitly in the query.",
"$ref": "Segments"
}
},
"type": "object"
},
"AccounttaxCustomBatchResponseEntry": {
"properties": {
"batchId": {
"format": "uint32",
"description": "The ID of the request entry this entry responds to.",
"type": "integer"
},
"accountTax": {
"description": "The retrieved or updated account tax settings.",
"$ref": "AccountTax"
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"`content#accounttaxCustomBatchResponseEntry`\"",
"type": "string"
},
"errors": {
"$ref": "Errors",
"description": "A list of errors defined if and only if the request failed."
}
},
"id": "AccounttaxCustomBatchResponseEntry",
"description": "A batch entry encoding a single non-batch accounttax response.",
"type": "object"
},
"ProductStatusItemLevelIssue": {
"properties": {
"description": {
"description": "A short issue description in English.",
"type": "string"
},
"applicableCountries": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of country codes (ISO 3166-1 alpha-2) where issue applies to the offer."
},
"resolution": {
"description": "Whether the issue can be resolved by the merchant.",
"type": "string"
},
"servability": {
"type": "string",
"description": "How this issue affects serving of the offer."
},
"attributeName": {
"description": "The attribute's name, if the issue is caused by a single attribute.",
"type": "string"
},
"documentation": {
"description": "The URL of a web page to help with resolving this issue.",
"type": "string"
},
"destination": {
"type": "string",
"description": "The destination the issue applies to."
},
"code": {
"type": "string",
"description": "The error code of the issue."
},
"detail": {
"type": "string",
"description": "A detailed issue description in English."
}
},
"id": "ProductStatusItemLevelIssue",
"type": "object"
},
"AccountStatusProducts": {
"type": "object",
"properties": {
"channel": {
"type": "string",
"description": "The channel the data applies to. Acceptable values are: - \"`local`\" - \"`online`\" "
},
"statistics": {
"$ref": "AccountStatusStatistics",
"description": "Aggregated product statistics."
},
"country": {
"type": "string",
"description": "The country the data applies to."
},
"destination": {
"type": "string",
"description": "The destination the data applies to."
},
"itemLevelIssues": {
"type": "array",
"description": "List of item-level issues.",
"items": {
"$ref": "AccountStatusItemLevelIssue"
}
}
},
"id": "AccountStatusProducts"
},
"RepricingRuleReport": {
"type": "object",
"id": "RepricingRuleReport",
"properties": {
"date": {
"description": "Date of the stats in this report. The report starts and ends according to the merchant's timezone.",
"$ref": "Date"
},
"buyboxWinningRuleStats": {
"description": "Stats specific to buybox winning rules for rule report.",
"$ref": "RepricingRuleReportBuyboxWinningRuleStats"
},
"ruleId": {
"type": "string",
"description": "Id of the Repricing rule for this report."
},
"orderItemCount": {
"description": "Total unit count of impacted products ordered while the rule was active on the date of the report. This count includes all orders that were started while the rule was active, even if the rule was no longer active when the order was completed.",
"format": "int32",
"type": "integer"
},
"totalGmv": {
"description": "Total GMV generated by impacted products while the rule was active on the date of the report. This value includes all orders that were started while the rule was active, even if the rule was no longer active when the order was completed.",
"$ref": "PriceAmount"
},
"impactedProducts": {
"items": {
"type": "string"
},
"type": "array",
"description": "List of product ids that are impacted by this rule during this reporting period. Out of stock products and products not searched for by customers are examples of non-impacted products."
},
"inapplicabilityDetails": {
"items": {
"$ref": "InapplicabilityDetails"
},
"type": "array",
"description": "List of all reasons the rule did not apply to the inapplicable products during the specified reporting period."
},
"inapplicableProducts": {
"items": {
"type": "string"
},
"description": "List of product ids that are inapplicable to this rule during this reporting period. To get the inapplicable reason for a specific product, see RepricingProductReport.",
"type": "array"
},
"type": {
"description": "Type of the rule.",
"enum": [
"REPRICING_RULE_TYPE_UNSPECIFIED",
"TYPE_STATS_BASED",
"TYPE_COGS_BASED"
],
"type": "string",
"enumDescriptions": [
"Unused.",
"Statistical measurement based rules among Google SA merchants. If this rule is chosen, repricer will adjust the offer price based on statistical metrics (currently only min is available) among other merchants who sell the same product. Details need to be provdided in the RuleDefinition.",
"Cost of goods sale based rule. Repricer will adjust the offer price based on the offer's sale cost which is provided by the merchant."
]
}
},
"description": "Resource that represents a daily Repricing rule report. Next ID: 11"
},
"ReturnaddressListResponse": {
"properties": {
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#returnaddressListResponse\".",
"type": "string"
},
"nextPageToken": {
"description": "The token for the retrieval of the next page of addresses.",
"type": "string"
},
"resources": {
"items": {
"$ref": "ReturnAddress"
},
"type": "array"
}
},
"type": "object",
"id": "ReturnaddressListResponse"
},
"LiasettingsListPosDataProvidersResponse": {
"type": "object",
"id": "LiasettingsListPosDataProvidersResponse",
"properties": {
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#liasettingsListPosDataProvidersResponse\".",
"type": "string"
},
"posDataProviders": {
"type": "array",
"items": {
"$ref": "PosDataProviders"
},
"description": "The list of POS data providers for each eligible country"
}
}
},
"LocalinventoryCustomBatchResponse": {
"type": "object",
"id": "LocalinventoryCustomBatchResponse",
"properties": {
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#localinventoryCustomBatchResponse\"."
},
"entries": {
"description": "The result of the execution of the batch requests.",
"type": "array",
"items": {
"$ref": "LocalinventoryCustomBatchResponseEntry"
}
}
}
},
"TimeZone": {
"type": "object",
"description": "Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones).",
"id": "TimeZone",
"properties": {
"version": {
"type": "string",
"description": "Optional. IANA Time Zone Database version number, e.g. \"2019a\"."
},
"id": {
"type": "string",
"description": "IANA Time Zone Database time zone, e.g. \"America/New_York\"."
}
}
},
"Weight": {
"type": "object",
"id": "Weight",
"properties": {
"unit": {
"description": "Required. The weight unit. Acceptable values are: - \"`kg`\" - \"`lb`\" ",
"type": "string"
},
"value": {
"type": "string",
"description": "Required. The weight represented as a number."
}
}
},
"Metrics": {
"description": "Performance metrics. Values are only set for metrics requested explicitly in the request's search query.",
"id": "Metrics",
"type": "object",
"properties": {
"clicks": {
"type": "string",
"description": "Number of clicks.",
"format": "int64"
},
"ctr": {
"format": "double",
"description": "Number of clicks merchant's products receive (clicks) divided by the number of times the products are shown (impressions).",
"type": "number"
},
"impressions": {
"description": "Number of times merchant's products are shown.",
"format": "int64",
"type": "string"
}
}
},
"LiaSettings": {
"properties": {
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"`content#liaSettings`\""
},
"accountId": {
"format": "uint64",
"description": "The ID of the account to which these LIA settings belong. Ignored upon update, always present in get request responses.",
"type": "string"
},
"countrySettings": {
"description": "The LIA settings for each country.",
"items": {
"$ref": "LiaCountrySettings"
},
"type": "array"
}
},
"description": "Local Inventory ads (LIA) settings. All methods except listposdataproviders require the admin role.",
"id": "LiaSettings",
"type": "object"
},
"ReturnpolicyCustomBatchResponseEntry": {
"id": "ReturnpolicyCustomBatchResponseEntry",
"properties": {
"batchId": {
"type": "integer",
"format": "uint32",
"description": "The ID of the request entry to which this entry responds."
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"`content#returnpolicyCustomBatchResponseEntry`\""
},
"returnPolicy": {
"$ref": "ReturnPolicy",
"description": "The retrieved return policy."
},
"errors": {
"description": "A list of errors defined if, and only if, the request failed.",
"$ref": "Errors"
}
},
"type": "object"
},
"LocalinventoryCustomBatchRequestEntry": {
"type": "object",
"description": "Batch entry encoding a single local inventory update request.",
"properties": {
"productId": {
"type": "string",
"description": "The ID of the product for which to update local inventory."
},
"localInventory": {
"$ref": "LocalInventory",
"description": "Local inventory of the product."
},
"batchId": {
"type": "integer",
"format": "uint32",
"description": "An entry ID, unique within the batch request."
},
"merchantId": {
"description": "The ID of the managing account.",
"format": "uint64",
"type": "string"
},
"method": {
"description": "Method of the batch request entry. Acceptable values are: - \"`insert`\" ",
"type": "string"
}
},
"id": "LocalinventoryCustomBatchRequestEntry"
},
"RepricingRuleStatsBasedRule": {
"type": "object",
"description": "Definition of stats based rule.",
"id": "RepricingRuleStatsBasedRule",
"properties": {
"percentageDelta": {
"type": "integer",
"description": "The percent change against the price target. Valid from 0 to 100 inclusively.",
"format": "int32"
},
"priceDelta": {
"description": "The price delta against the above price target. A positive value means the price should be adjusted to be above statistical measure, and a negative value means below. Currency code must not be included.",
"type": "string"
}
}
},
"Date": {
"type": "object",
"properties": {
"day": {
"type": "integer",
"format": "int32",
"description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant."
},
"year": {
"type": "integer",
"description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.",
"format": "int32"
},
"month": {
"type": "integer",
"format": "int32",
"description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day."
}
},
"id": "Date",
"description": "Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`."
},
"RepricingRuleCostOfGoodsSaleRule": {
"properties": {
"priceDelta": {
"description": "The price delta against the COGS. E.g. 2 means $2 more of the COGS.",
"type": "string"
},
"percentageDelta": {
"description": "The percent change against the COGS. Ex: 20 would mean to set the adjusted price 1.2X of the COGS data.",
"type": "integer",
"format": "int32"
}
},
"type": "object",
"id": "RepricingRuleCostOfGoodsSaleRule",
"description": "A repricing rule that changes the sale price based on cost of goods sale."
},
"OrderinvoicesCreateChargeInvoiceResponse": {
"type": "object",
"id": "OrderinvoicesCreateChargeInvoiceResponse",
"properties": {
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#orderinvoicesCreateChargeInvoiceResponse\".",
"type": "string"
},
"executionStatus": {
"type": "string",
"description": "The status of the execution. Acceptable values are: - \"`duplicate`\" - \"`executed`\" "
}
}
},
"OrdersCancelTestOrderByCustomerResponse": {
"id": "OrdersCancelTestOrderByCustomerResponse",
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersCancelTestOrderByCustomerResponse\"."
}
}
},
"OrderreturnsListResponse": {
"properties": {
"nextPageToken": {
"description": "The token for the retrieval of the next page of returns.",
"type": "string"
},
"resources": {
"type": "array",
"items": {
"$ref": "MerchantOrderReturn"
}
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#orderreturnsListResponse\"."
}
},
"type": "object",
"id": "OrderreturnsListResponse"
},
"RegionPostalCodeAreaPostalCodeRange": {
"type": "object",
"properties": {
"begin": {
"type": "string",
"description": "Required. 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*\"."
},
"end": {
"description": "Optional. A postal code or a pattern of the form prefix* denoting the inclusive upper bound of the range defining the area. It must have the same length as postalCodeRangeBegin: if postalCodeRangeBegin is a postal code then postalCodeRangeEnd must be a postal code too; if postalCodeRangeBegin is a pattern then postalCodeRangeEnd must be a pattern with the same prefix length. Optional: if not set, then the area is defined as being all the postal codes matching postalCodeRangeBegin.",
"type": "string"
}
},
"description": "A range of postal codes that defines the region area.",
"id": "RegionPostalCodeAreaPostalCodeRange"
},
"RegionalinventoryCustomBatchResponseEntry": {
"type": "object",
"properties": {
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#regionalinventoryCustomBatchResponseEntry\".",
"type": "string"
},
"errors": {
"description": "A list of errors defined if and only if the request failed.",
"$ref": "Errors"
},
"batchId": {
"type": "integer",
"description": "The ID of the request entry this entry responds to.",
"format": "uint32"
},
"regionalInventory": {
"$ref": "RegionalInventory",
"description": "Price and availability of the product."
}
},
"description": "A batch entry encoding a single non-batch regional inventory response.",
"id": "RegionalinventoryCustomBatchResponseEntry"
},
"AccountsAuthInfoResponse": {
"properties": {
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#accountsAuthInfoResponse\".",
"type": "string"
},
"accountIdentifiers": {
"type": "array",
"description": "The account identifiers corresponding to the authenticated user. - For an individual account: only the merchant ID is defined - For an aggregator: only the aggregator ID is defined - For a subaccount of an MCA: both the merchant ID and the aggregator ID are defined. ",
"items": {
"$ref": "AccountIdentifier"
}
}
},
"id": "AccountsAuthInfoResponse",
"type": "object"
},
"PickupCarrierService": {
"id": "PickupCarrierService",
"properties": {
"carrierName": {
"type": "string",
"description": "The name of the pickup carrier (e.g., `\"UPS\"`). Required."
},
"serviceName": {
"description": "The name of the pickup service (e.g., `\"Access point\"`). Required.",
"type": "string"
}
},
"type": "object"
},
"ProductStatusDestinationStatus": {
"type": "object",
"properties": {
"disapprovedCountries": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of country codes (ISO 3166-1 alpha-2) where the offer is disapproved."
},
"status": {
"description": "Destination approval status in `targetCountry` of the offer.",
"type": "string"
},
"destination": {
"type": "string",
"description": "The name of the destination"
},
"approvedCountries": {
"items": {
"type": "string"
},
"type": "array",
"description": "List of country codes (ISO 3166-1 alpha-2) where the offer is approved."
},
"pendingCountries": {
"type": "array",
"description": "List of country codes (ISO 3166-1 alpha-2) where the offer is pending approval.",
"items": {
"type": "string"
}
}
},
"id": "ProductStatusDestinationStatus"
},
"MonetaryAmount": {
"properties": {
"priceAmount": {
"description": "The pre-tax or post-tax price depends on the location of the order. - For countries (e.g. US) where price attribute excludes tax, this field corresponds to the pre-tax value. - For coutries (e.g. France) where price attribute includes tax, this field corresponds to the post-tax value .",
"$ref": "Price"
},
"taxAmount": {
"description": "Tax value, present only for countries where price attribute excludes tax (e.g. US). No tax is referenced as 0 value with the corresponding `currency`.",
"$ref": "Price"
}
},
"type": "object",
"id": "MonetaryAmount"
},
"ProductsCustomBatchRequestEntry": {
"id": "ProductsCustomBatchRequestEntry",
"type": "object",
"properties": {
"batchId": {
"description": "An entry ID, unique within the batch request.",
"type": "integer",
"format": "uint32"
},
"feedId": {
"format": "uint64",
"type": "string",
"description": "The Content API feed id."
},
"product": {
"$ref": "Product",
"description": "The product to insert. Only required if the method is `insert`."
},
"productId": {
"type": "string",
"description": "The ID of the product to get or delete. Only defined if the method is `get` or `delete`."
},
"method": {
"description": "The method of the batch entry. Acceptable values are: - \"`delete`\" - \"`get`\" - \"`insert`\" ",
"type": "string"
},
"merchantId": {
"format": "uint64",
"description": "The ID of the managing account.",
"type": "string"
}
},
"description": "A batch entry encoding a single non-batch products request."
},
"ProductstatusesCustomBatchRequestEntry": {
"properties": {
"batchId": {
"type": "integer",
"format": "uint32",
"description": "An entry ID, unique within the batch request."
},
"productId": {
"description": "The ID of the product whose status to get.",
"type": "string"
},
"method": {
"type": "string",
"description": "The method of the batch entry. Acceptable values are: - \"`get`\" "
},
"includeAttributes": {
"type": "boolean"
},
"merchantId": {
"description": "The ID of the managing account.",
"type": "string",
"format": "uint64"
},
"destinations": {
"type": "array",
"description": "If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination.",
"items": {
"type": "string"
}
}
},
"id": "ProductstatusesCustomBatchRequestEntry",
"type": "object",
"description": "A batch entry encoding a single non-batch productstatuses request."
},
"ListAccountLabelsResponse": {
"properties": {
"accountLabels": {
"items": {
"$ref": "AccountLabel"
},
"type": "array",
"description": "The labels from the specified account."
},
"nextPageToken": {
"type": "string",
"description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages."
}
},
"type": "object",
"id": "ListAccountLabelsResponse",
"description": "Response message for the `ListAccountLabels` method."
},
"AccountsCustomBatchResponseEntry": {
"properties": {
"errors": {
"$ref": "Errors",
"description": "A list of errors defined if and only if the request failed."
},
"batchId": {
"description": "The ID of the request entry this entry responds to.",
"type": "integer",
"format": "uint32"
},
"account": {
"$ref": "Account",
"description": "The retrieved, created, or updated account. Not defined if the method was `delete`, `claimwebsite` or `link`."
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"`content#accountsCustomBatchResponseEntry`\""
}
},
"type": "object",
"description": "A batch entry encoding a single non-batch accounts response.",
"id": "AccountsCustomBatchResponseEntry"
},
"DatafeedStatusExample": {
"id": "DatafeedStatusExample",
"description": "An example occurrence for a particular error.",
"properties": {
"value": {
"type": "string",
"description": "The problematic value."
},
"itemId": {
"description": "The ID of the example item.",
"type": "string"
},
"lineNumber": {
"description": "Line number in the data feed where the example is found.",
"format": "uint64",
"type": "string"
}
},
"type": "object"
},
"LiasettingsSetInventoryVerificationContactResponse": {
"properties": {
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#liasettingsSetInventoryVerificationContactResponse\".",
"type": "string"
}
},
"type": "object",
"id": "LiasettingsSetInventoryVerificationContactResponse"
},
"Value": {
"type": "object",
"id": "Value",
"properties": {
"flatRate": {
"$ref": "Price",
"description": "A flat rate. Can only be set if all other fields are not set."
},
"noShipping": {
"description": "If true, then the product can't ship. Must be true when set, can only be set if all other fields are not set.",
"type": "boolean"
},
"carrierRateName": {
"type": "string",
"description": "The name of a carrier rate referring to a carrier rate defined in the same rate group. Can only be set if all other fields are not set."
},
"subtableName": {
"description": "The name of a subtable. Can only be set in table cells (i.e., not for single values), and only if all other fields are not set.",
"type": "string"
},
"pricePercentage": {
"type": "string",
"description": "A percentage of the price represented as a number in decimal notation (e.g., `\"5.4\"`). Can only be set if all other fields are not set."
}
},
"description": "The single value of a rate group or the value of a rate group table's cell. Exactly one of `noShipping`, `flatRate`, `pricePercentage`, `carrierRateName`, `subtableName` must be set."
},
"TestOrderDeliveryDetails": {
"type": "object",
"properties": {
"address": {
"description": "The delivery address",
"$ref": "TestOrderAddress"
},
"isScheduledDelivery": {
"type": "boolean",
"description": "Whether the order is scheduled delivery order."
},
"phoneNumber": {
"description": "The phone number of the person receiving the delivery.",
"type": "string"
}
},
"id": "TestOrderDeliveryDetails"
},
"Row": {
"properties": {
"cells": {
"type": "array",
"items": {
"$ref": "Value"
},
"description": "The list of cells that constitute the row. Must have the same length as `columnHeaders` for two-dimensional tables, a length of 1 for one-dimensional tables. Required."
}
},
"id": "Row",
"type": "object"
},
"RepricingRuleRestrictionBoundary": {
"type": "object",
"properties": {
"priceDelta": {
"type": "string",
"description": "The price micros relative to the offer selling price. This field is signed. It must be negative in floor. For example, if an offer is selling at $10 and this field is -$2 in floor, the repricing rule only applies if the calculated new price is \u003e= $8."
},
"percentageDelta": {
"type": "integer",
"format": "int32",
"description": "The percentage delta relative to the offer selling price. This field is signed. It must be negative in floor. When it is used in floor, it should be \u003e -100. For example, if an offer is selling at $10 and this field is -30 in floor, the repricing rule only applies if the calculated new price is \u003e= $7."
}
},
"description": "Definition of a boundary.",
"id": "RepricingRuleRestrictionBoundary"
},
"AccountsClaimWebsiteResponse": {
"properties": {
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#accountsClaimWebsiteResponse\"."
}
},
"type": "object",
"id": "AccountsClaimWebsiteResponse"
},
"Css": {
"properties": {
"homepageUri": {
"readOnly": true,
"description": "Output only. Immutable. The CSS domain's homepage.",
"type": "string"
},
"cssGroupId": {
"description": "Output only. Immutable. The ID of the CSS group this CSS domain is affiliated with. Only populated for CSS group users.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"labelIds": {
"description": "A list of label IDs that are assigned to this CSS domain by its CSS group. Only populated for CSS group users.",
"type": "array",
"items": {
"type": "string",
"format": "int64"
}
},
"displayName": {
"readOnly": true,
"description": "Output only. Immutable. The CSS domain's display name, used when space is constrained.",
"type": "string"
},
"cssDomainId": {
"format": "int64",
"readOnly": true,
"type": "string",
"description": "Output only. Immutable. The CSS domain ID."
},
"fullName": {
"description": "Output only. Immutable. The CSS domain's full name.",
"readOnly": true,
"type": "string"
}
},
"description": "Information about CSS domain.",
"type": "object",
"id": "Css"
},
"LiaAboutPageSettings": {
"id": "LiaAboutPageSettings",
"properties": {
"status": {
"description": "The status of the verification process for the About page. Acceptable values are: - \"`active`\" - \"`inactive`\" - \"`pending`\" ",
"type": "string"
},
"url": {
"description": "The URL for the About page.",
"type": "string"
}
},
"type": "object"
},
"AccountCredentials": {
"description": "Credentials allowing Google to call a partner's API on behalf of a merchant.",
"id": "AccountCredentials",
"type": "object",
"properties": {
"purpose": {
"type": "string",
"enum": [
"ACCOUNT_CREDENTIALS_PURPOSE_UNSPECIFIED",
"SHOPIFY_ORDER_MANAGEMENT"
],
"enumDescriptions": [
"Unknown purpose.",
"The credentials allow Google to manage Shopify orders on behalf of the merchant."
],
"description": "Indicates to Google how Google should use these OAuth tokens."
},
"expiresIn": {
"description": "The amount of time, in seconds, after which the access token is no longer valid.",
"type": "string",
"format": "int64"
},
"accessToken": {
"type": "string",
"description": "An OAuth access token."
}
}
},
"ListRegionsResponse": {
"properties": {
"regions": {
"items": {
"$ref": "Region"
},
"description": "The regions from the specified merchant.",
"type": "array"
},
"nextPageToken": {
"type": "string",
"description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages."
}
},
"type": "object",
"description": "Response message for the `ListRegions` method.",
"id": "ListRegionsResponse"
},
"ShipmentInvoice": {
"properties": {
"invoiceSummary": {
"description": "[required] Invoice summary.",
"$ref": "InvoiceSummary"
},
"lineItemInvoices": {
"description": "[required] Invoice details per line item.",
"items": {
"$ref": "ShipmentInvoiceLineItemInvoice"
},
"type": "array"
},
"shipmentGroupId": {
"description": "[required] ID of the shipment group. It is assigned by the merchant in the `shipLineItems` method and is used to group multiple line items that have the same kind of shipping charges.",
"type": "string"
}
},
"type": "object",
"id": "ShipmentInvoice"
},
"RefundReason": {
"properties": {
"reasonCode": {
"description": "Code of the refund reason. Acceptable values are: - \"`adjustment`\" - \"`autoPostInternal`\" - \"`autoPostInvalidBillingAddress`\" - \"`autoPostNoInventory`\" - \"`autoPostPriceError`\" - \"`autoPostUndeliverableShippingAddress`\" - \"`couponAbuse`\" - \"`courtesyAdjustment`\" - \"`customerCanceled`\" - \"`customerDiscretionaryReturn`\" - \"`customerInitiatedMerchantCancel`\" - \"`customerSupportRequested`\" - \"`deliveredLateByCarrier`\" - \"`deliveredTooLate`\" - \"`expiredItem`\" - \"`failToPushOrderGoogleError`\" - \"`failToPushOrderMerchantError`\" - \"`failToPushOrderMerchantFulfillmentError`\" - \"`failToPushOrderToMerchant`\" - \"`failToPushOrderToMerchantOutOfStock`\" - \"`feeAdjustment`\" - \"`invalidCoupon`\" - \"`lateShipmentCredit`\" - \"`malformedShippingAddress`\" - \"`merchantDidNotShipOnTime`\" - \"`noInventory`\" - \"`orderTimeout`\" - \"`other`\" - \"`paymentAbuse`\" - \"`paymentDeclined`\" - \"`priceAdjustment`\" - \"`priceError`\" - \"`productArrivedDamaged`\" - \"`productNotAsDescribed`\" - \"`promoReallocation`\" - \"`qualityNotAsExpected`\" - \"`returnRefundAbuse`\" - \"`shippingCostAdjustment`\" - \"`shippingPriceError`\" - \"`taxAdjustment`\" - \"`taxError`\" - \"`undeliverableShippingAddress`\" - \"`unsupportedPoBoxAddress`\" - \"`wrongProductShipped`\" ",
"type": "string"
},
"description": {
"description": "Description of the reason.",
"type": "string"
}
},
"id": "RefundReason",
"type": "object"
},
"ListReturnPolicyOnlineResponse": {
"properties": {
"returnPolicies": {
"type": "array",
"description": "The retrieved return policies.",
"items": {
"$ref": "ReturnPolicyOnline"
}
}
},
"type": "object",
"description": "Response message for the `ListReturnPolicyOnline` method.",
"id": "ListReturnPolicyOnlineResponse"
},
"ShippingsettingsGetSupportedPickupServicesResponse": {
"properties": {
"pickupServices": {
"items": {
"$ref": "PickupServicesPickupService"
},
"type": "array",
"description": "A list of supported pickup services. May be empty."
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#shippingsettingsGetSupportedPickupServicesResponse\".",
"type": "string"
}
},
"id": "ShippingsettingsGetSupportedPickupServicesResponse",
"type": "object"
},
"OrdersRefundItemResponse": {
"type": "object",
"properties": {
"executionStatus": {
"description": "The status of the execution. Acceptable values are: - \"`duplicate`\" - \"`executed`\" ",
"type": "string"
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersRefundItemResponse\".",
"type": "string"
}
},
"id": "OrdersRefundItemResponse"
},
"AccountIdentifier": {
"type": "object",
"properties": {
"aggregatorId": {
"format": "uint64",
"description": "The aggregator ID, set for aggregators and subaccounts (in that case, it represents the aggregator of the subaccount).",
"type": "string"
},
"merchantId": {
"description": "The merchant account ID, set for individual accounts and subaccounts.",
"type": "string",
"format": "uint64"
}
},
"id": "AccountIdentifier"
},
"TestOrderAddress": {
"type": "object",
"properties": {
"fullAddress": {
"items": {
"type": "string"
},
"description": "Strings representing the lines of the printed label for mailing the order, for example: John Smith 1600 Amphitheatre Parkway Mountain View, CA, 94043 United States ",
"type": "array"
},
"streetAddress": {
"type": "array",
"items": {
"type": "string"
},
"description": "Street-level part of the address."
},
"recipientName": {
"description": "Name of the recipient.",
"type": "string"
},
"region": {
"type": "string",
"description": "Top-level administrative subdivision of the country. For example, a state like California (\"CA\") or a province like Quebec (\"QC\")."
},
"isPostOfficeBox": {
"description": "Whether the address is a post office box.",
"type": "boolean"
},
"locality": {
"type": "string",
"description": "City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs)."
},
"country": {
"type": "string",
"description": "CLDR country code (e.g. \"US\")."
},
"postalCode": {
"type": "string",
"description": "Postal Code or ZIP (e.g. \"94043\")."
}
},
"id": "TestOrderAddress"
},
"CollectionStatusItemLevelIssue": {
"type": "object",
"description": "Issue associated with the collection.",
"properties": {
"destination": {
"description": "The destination the issue applies to.",
"type": "string"
},
"resolution": {
"description": "Whether the issue can be resolved by the merchant.",
"type": "string"
},
"servability": {
"type": "string",
"description": "How this issue affects the serving of the collection."
},
"description": {
"description": "A short issue description in English.",
"type": "string"
},
"attributeName": {
"description": "The attribute's name, if the issue is caused by a single attribute.",
"type": "string"
},
"detail": {
"description": "A detailed issue description in English.",
"type": "string"
},
"code": {
"type": "string",
"description": "The error code of the issue."
},
"documentation": {
"type": "string",
"description": "The URL of a web page to help with resolving this issue."
}
},
"id": "CollectionStatusItemLevelIssue"
},
"OrderShipment": {
"properties": {
"scheduledDeliveryDetails": {
"description": "Delivery details of the shipment if scheduling is needed.",
"$ref": "OrderShipmentScheduledDeliveryDetails"
},
"shipmentGroupId": {
"description": "The shipment group ID of the shipment. This is set in shiplineitems request.",
"type": "string"
},
"creationDate": {
"type": "string",
"description": "Date on which the shipment has been created, in ISO 8601 format."
},
"deliveryDate": {
"type": "string",
"description": "Date on which the shipment has been delivered, in ISO 8601 format. Present only if `status` is `delivered`"
},
"status": {
"description": "The status of the shipment. Acceptable values are: - \"`delivered`\" - \"`readyForPickup`\" - \"`shipped`\" - \"`undeliverable`\" ",
"type": "string"
},
"carrier": {
"description": "The carrier handling the shipment. For supported carriers, Google includes the carrier name and tracking URL in emails to customers. For select supported carriers, Google also automatically updates the shipment status based on the provided shipment ID. *Note:* You can also use unsupported carriers, but emails to customers will not include the carrier name or tracking URL, and there will be no automatic order status updates. Supported carriers for US are: - \"`ups`\" (United Parcel Service) *automatic status updates* - \"`usps`\" (United States Postal Service) *automatic status updates* - \"`fedex`\" (FedEx) *automatic status updates * - \"`dhl`\" (DHL eCommerce) *automatic status updates* (US only) - \"`ontrac`\" (OnTrac) *automatic status updates * - \"`dhl express`\" (DHL Express) - \"`deliv`\" (Deliv) - \"`dynamex`\" (TForce) - \"`lasership`\" (LaserShip) - \"`mpx`\" (Military Parcel Xpress) - \"`uds`\" (United Delivery Service) - \"`efw`\" (Estes Forwarding Worldwide) - \"`jd logistics`\" (JD Logistics) - \"`yunexpress`\" (YunExpress) - \"`china post`\" (China Post) - \"`china ems`\" (China Post Express Mail Service) - \"`singapore post`\" (Singapore Post) - \"`pos malaysia`\" (Pos Malaysia) - \"`postnl`\" (PostNL) - \"`ptt`\" (PTT Turkish Post) - \"`eub`\" (ePacket) - \"`chukou1`\" (Chukou1 Logistics) - \"`bestex`\" (Best Express) - \"`canada post`\" (Canada Post) - \"`purolator`\" (Purolator) - \"`canpar`\" (Canpar) - \"`india post`\" (India Post) - \"`blue dart`\" (Blue Dart) - \"`delhivery`\" (Delhivery) - \"`dtdc`\" (DTDC) - \"`tpc india`\" (TPC India) Supported carriers for FR are: - \"`la poste`\" (La Poste) *automatic status updates * - \"`colissimo`\" (Colissimo by La Poste) *automatic status updates* - \"`ups`\" (United Parcel Service) *automatic status updates * - \"`chronopost`\" (Chronopost by La Poste) - \"`gls`\" (General Logistics Systems France) - \"`dpd`\" (DPD Group by GeoPost) - \"`bpost`\" (Belgian Post Group) - \"`colis prive`\" (Colis Privé) - \"`boxtal`\" (Boxtal) - \"`geodis`\" (GEODIS) - \"`tnt`\" (TNT) - \"`db schenker`\" (DB Schenker) - \"`aramex`\" (Aramex) ",
"type": "string"
},
"trackingId": {
"type": "string",
"description": "The tracking ID for the shipment."
},
"id": {
"type": "string",
"description": "The ID of the shipment."
},
"lineItems": {
"items": {
"$ref": "OrderShipmentLineItemShipment"
},
"type": "array",
"description": "The line items that are shipped."
}
},
"id": "OrderShipment",
"type": "object"
},
"ProductsCustomBatchResponseEntry": {
"properties": {
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"`content#productsCustomBatchResponseEntry`\"",
"type": "string"
},
"batchId": {
"format": "uint32",
"description": "The ID of the request entry this entry responds to.",
"type": "integer"
},
"errors": {
"$ref": "Errors",
"description": "A list of errors defined if and only if the request failed."
},
"product": {
"description": "The inserted product. Only defined if the method is `insert` and if the request was successful.",
"$ref": "Product"
}
},
"type": "object",
"description": "A batch entry encoding a single non-batch products response.",
"id": "ProductsCustomBatchResponseEntry"
},
"OrdersCreateTestOrderRequest": {
"id": "OrdersCreateTestOrderRequest",
"type": "object",
"properties": {
"country": {
"description": "The CLDR territory code of the country of the test order to create. Affects the currency and addresses of orders created via `template_name`, or the addresses of orders created via `test_order`. Acceptable values are: - \"`US`\" - \"`FR`\" Defaults to `US`.",
"type": "string"
},
"templateName": {
"description": "The test order template to use. Specify as an alternative to `testOrder` as a shortcut for retrieving a template and then creating an order using that template. Acceptable values are: - \"`template1`\" - \"`template1a`\" - \"`template1b`\" - \"`template2`\" - \"`template3`\" ",
"type": "string"
},
"testOrder": {
"$ref": "TestOrder",
"description": "The test order to create."
}
}
},
"OrdersAdvanceTestOrderResponse": {
"id": "OrdersAdvanceTestOrderResponse",
"properties": {
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersAdvanceTestOrderResponse\"."
}
},
"type": "object"
},
"OrderPromotion": {
"id": "OrderPromotion",
"type": "object",
"properties": {
"shortTitle": {
"type": "string",
"description": "A short title of the promotion to be shown on the checkout page. Do not provide for `orders.createtestorder`."
},
"appliedItems": {
"items": {
"$ref": "OrderPromotionItem"
},
"type": "array",
"description": "Items that this promotion have been applied to. Do not provide for `orders.createtestorder`. This field will be empty for shipping promotions because shipping is not tied to any specific item."
},
"title": {
"type": "string",
"description": "Required. The title of the promotion."
},
"funder": {
"type": "string",
"description": "Required. The party funding the promotion. Only `merchant` is supported for `orders.createtestorder`. Acceptable values are: - \"`google`\" - \"`merchant`\" "
},
"priceValue": {
"description": "Estimated discount applied to price. Amount is pre-tax or post-tax depending on location of order.",
"$ref": "Price"
},
"startTime": {
"type": "string",
"description": "Promotion start time in ISO 8601 format. Date, time, and offset required, e.g., \"2020-01-02T09:00:00+01:00\" or \"2020-01-02T09:00:00Z\"."
},
"subtype": {
"type": "string",
"description": "Required. The category of the promotion. Only `moneyOff` is supported for `orders.createtestorder`. Acceptable values are: - \"`buyMGetMoneyOff`\" - \"`buyMGetNMoneyOff`\" - \"`buyMGetNPercentOff`\" - \"`buyMGetPercentOff`\" - \"`freeGift`\" - \"`freeGiftWithItemId`\" - \"`freeGiftWithValue`\" - \"`freeShippingOvernight`\" - \"`freeShippingStandard`\" - \"`freeShippingTwoDay`\" - \"`moneyOff`\" - \"`percentOff`\" - \"`rewardPoints`\" - \"`salePrice`\" "
},
"type": {
"description": "Required. The scope of the promotion. Only `product` is supported for `orders.createtestorder`. Acceptable values are: - \"`product`\" - \"`shipping`\" ",
"type": "string"
},
"endTime": {
"description": "Promotion end time in ISO 8601 format. Date, time, and offset required, e.g., \"2020-01-02T09:00:00+01:00\" or \"2020-01-02T09:00:00Z\".",
"type": "string"
},
"applicableItems": {
"type": "array",
"items": {
"$ref": "OrderPromotionItem"
},
"description": "Items that this promotion may be applied to. If empty, there are no restrictions on applicable items and quantity. This field will also be empty for shipping promotions because shipping is not tied to any specific item."
},
"taxValue": {
"$ref": "Price",
"description": "Estimated discount applied to tax (if allowed by law). Do not provide for `orders.createtestorder`."
},
"merchantPromotionId": {
"type": "string",
"description": "Required. This field is used to identify promotions within merchants' own systems."
}
}
},
"ReturnPolicyPolicy": {
"type": "object",
"id": "ReturnPolicyPolicy",
"properties": {
"lastReturnDate": {
"description": "Required. Last day for returning the items. In ISO 8601 format. When specifying the return window like this, set the policy type to \"lastReturnDate\". Use this for seasonal overrides only.",
"type": "string"
},
"type": {
"type": "string",
"description": "Policy type. Use \"lastReturnDate\" for seasonal overrides only. Note that for most items a minimum of 30 days is required for returns. Exceptions may be made for electronics or non-returnable items such as food, perishables, and living things. A policy of less than 30 days can only be applied to those items. Acceptable values are: - \"`lastReturnDate`\" - \"`lifetimeReturns`\" - \"`noReturns`\" - \"`numberOfDaysAfterDelivery`\" "
},
"numberOfDays": {
"type": "string",
"format": "int64",
"description": "The number of days items can be returned after delivery, where one day is defined to be 24 hours after the delivery timestamp. When specifying the return window like this, set the policy type to \"numberOfDaysAfterDelivery\". Acceptable values are 30, 45, 60, 90, 100, 180, 270 and 365 for the default policy. Additional policies further allow 14, 15, 21 and 28 days, but note that for most items a minimum of 30 days is required for returns. Exceptions may be made for electronics. A policy of less than 30 days can only be applied to those items."
}
}
},
"ProductstatusesListResponse": {
"properties": {
"resources": {
"type": "array",
"items": {
"$ref": "ProductStatus"
}
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#productstatusesListResponse\".",
"type": "string"
},
"nextPageToken": {
"description": "The token for the retrieval of the next page of products statuses.",
"type": "string"
}
},
"type": "object",
"id": "ProductstatusesListResponse"
},
"DatafeedstatusesCustomBatchResponseEntry": {
"description": "A batch entry encoding a single non-batch datafeedstatuses response.",
"properties": {
"datafeedStatus": {
"$ref": "DatafeedStatus",
"description": "The requested data feed status. Defined if and only if the request was successful."
},
"batchId": {
"description": "The ID of the request entry this entry responds to.",
"type": "integer",
"format": "uint32"
},
"errors": {
"$ref": "Errors",
"description": "A list of errors defined if and only if the request failed."
}
},
"id": "DatafeedstatusesCustomBatchResponseEntry",
"type": "object"
},
"OrdersRefundOrderResponse": {
"properties": {
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersRefundOrderResponse\".",
"type": "string"
},
"executionStatus": {
"type": "string",
"description": "The status of the execution. Acceptable values are: - \"`duplicate`\" - \"`executed`\" "
}
},
"id": "OrdersRefundOrderResponse",
"type": "object"
},
"PriceAmount": {
"id": "PriceAmount",
"properties": {
"currency": {
"type": "string",
"description": "The currency of the price."
},
"value": {
"description": "The price represented as a number.",
"type": "string"
}
},
"type": "object",
"description": "The price represented as a number and currency."
},
"ProductShippingDimension": {
"type": "object",
"id": "ProductShippingDimension",
"properties": {
"unit": {
"type": "string",
"description": "The unit of value."
},
"value": {
"format": "double",
"description": "The dimension of the product used to calculate the shipping cost of the item.",
"type": "number"
}
}
},
"TestOrderLineItemProduct": {
"type": "object",
"properties": {
"itemGroupId": {
"description": "Shared identifier for all variants of the same product. Optional.",
"type": "string"
},
"brand": {
"description": "Required. Brand of the item.",
"type": "string"
},
"fees": {
"description": "Fees for the item. Optional.",
"items": {
"$ref": "OrderLineItemProductFee"
},
"type": "array"
},
"contentLanguage": {
"description": "Required. The two-letter ISO 639-1 language code for the item. Acceptable values are: - \"`en`\" - \"`fr`\" ",
"type": "string"
},
"offerId": {
"description": "Required. An identifier of the item.",
"type": "string"
},
"mpn": {
"description": "Manufacturer Part Number (MPN) of the item. Optional.",
"type": "string"
},
"imageLink": {
"description": "Required. URL of an image of the item.",
"type": "string"
},
"targetCountry": {
"description": "Required. The CLDR territory // code of the target country of the product.",
"type": "string"
},
"condition": {
"description": "Required. Condition or state of the item. Acceptable values are: - \"`new`\" ",
"type": "string"
},
"price": {
"$ref": "Price",
"description": "Required. The price for the product. Tax is automatically calculated for orders where marketplace facilitator tax laws are applicable. Otherwise, tax settings from Merchant Center are applied."
},
"title": {
"type": "string",
"description": "Required. The title of the product."
},
"gtin": {
"type": "string",
"description": "Global Trade Item Number (GTIN) of the item. Optional."
},
"variantAttributes": {
"description": "Variant attributes for the item. Optional.",
"items": {
"$ref": "OrderLineItemProductVariantAttribute"
},
"type": "array"
}
},
"id": "TestOrderLineItemProduct"
},
"OrderTrackingSignal": {
"type": "object",
"properties": {
"orderTrackingSignalId": {
"type": "string",
"readOnly": true,
"format": "int64",
"description": "Output only. The ID that uniquely identifies this order tracking signal."
},
"orderCreatedTime": {
"description": "Required. The time when the order was created on the merchant side. Include the year and timezone string, if available.",
"$ref": "DateTime"
},
"customerShippingFee": {
"$ref": "PriceAmount",
"description": "The shipping fee of the order; this value should be set to zero in the case of free shipping."
},
"lineItems": {
"description": "Information about line items in the order.",
"type": "array",
"items": {
"$ref": "OrderTrackingSignalLineItemDetails"
}
},
"deliveryPostalCode": {
"description": "Required. The delivery postal code, as a continuous string without spaces or dashes, e.g. \"95016\".",
"type": "string"
},
"merchantId": {
"type": "string",
"description": "The Google merchant ID of this order tracking signal. This value is optional. If left unset, the caller's merchant ID is used. You must request access in order to provide data on behalf of another merchant. For more information, see [Submitting Order Tracking Signals](/shopping-content/guides/order-tracking-signals).",
"format": "int64"
},
"shipmentLineItemMapping": {
"items": {
"$ref": "OrderTrackingSignalShipmentLineItemMapping"
},
"description": "The mapping of the line items to the shipment information.",
"type": "array"
},
"deliveryRegionCode": {
"description": "Required. The [CLDR territory code] (http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) for the shipping destination.",
"type": "string"
},
"orderId": {
"description": "Required. The ID of the order on the merchant side.",
"type": "string"
},
"shippingInfo": {
"items": {
"$ref": "OrderTrackingSignalShippingInfo"
},
"description": "The shipping information for the order.",
"type": "array"
}
},
"description": "Represents a merchant trade from which signals are extracted, e.g. shipping.",
"id": "OrderTrackingSignal"
},
"SettlementTransactionTransaction": {
"type": "object",
"id": "SettlementTransactionTransaction",
"properties": {
"type": {
"type": "string",
"description": "The type of the transaction that occurred. Acceptable values are: - \"`order`\" - \"`reversal`\" - \"`orderRefund`\" - \"`reversalRefund`\" - \"`issueRelatedRefundAndReplacement`\" - \"`returnLabelShippingFeeTransaction`\" - \"`reversalIssueRelatedRefundAndReplacement`\" - \"`reversalReturnLabelShippingFeeTransaction`\" - \"`lumpSumCorrectionTransaction`\" "
},
"postDate": {
"type": "string",
"description": "The time on which the event occurred in ISO 8601 format."
}
}
},
"DatafeedsCustomBatchResponse": {
"properties": {
"entries": {
"items": {
"$ref": "DatafeedsCustomBatchResponseEntry"
},
"description": "The result of the execution of the batch requests.",
"type": "array"
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#datafeedsCustomBatchResponse\"."
}
},
"id": "DatafeedsCustomBatchResponse",
"type": "object"
},
"ProductUnitPricingBaseMeasure": {
"id": "ProductUnitPricingBaseMeasure",
"properties": {
"unit": {
"type": "string",
"description": "The unit of the denominator."
},
"value": {
"description": "The denominator of the unit price.",
"type": "string",
"format": "int64"
}
},
"type": "object"
},
"TestOrder": {
"type": "object",
"id": "TestOrder",
"properties": {
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"`content#testOrder`\""
},
"pickupDetails": {
"description": "Overrides the predefined pickup details if provided.",
"$ref": "TestOrderPickupDetails"
},
"shippingOption": {
"type": "string",
"description": "Required. The requested shipping option. Acceptable values are: - \"`economy`\" - \"`expedited`\" - \"`oneDay`\" - \"`sameDay`\" - \"`standard`\" - \"`twoDay`\" "
},
"predefinedDeliveryAddress": {
"type": "string",
"description": "Required. Identifier of one of the predefined delivery addresses for the delivery. Acceptable values are: - \"`dwight`\" - \"`jim`\" - \"`pam`\" "
},
"lineItems": {
"items": {
"$ref": "TestOrderLineItem"
},
"description": "Required. Line items that are ordered. At least one line item must be provided.",
"type": "array"
},
"promotions": {
"items": {
"$ref": "OrderPromotion"
},
"description": "Promotions associated with the order.",
"type": "array"
},
"deliveryDetails": {
"$ref": "TestOrderDeliveryDetails",
"description": "Overrides the predefined delivery details if provided."
},
"shippingCost": {
"description": "Required. The price of shipping for all items. Shipping tax is automatically calculated for orders where marketplace facilitator tax laws are applicable. Otherwise, tax settings from Merchant Center are applied. Note that shipping is not taxed in certain states.",
"$ref": "Price"
},
"notificationMode": {
"type": "string",
"description": "Restricted. Do not use."
},
"predefinedBillingAddress": {
"description": "Required. The billing address. Acceptable values are: - \"`dwight`\" - \"`jim`\" - \"`pam`\" ",
"type": "string"
},
"predefinedPickupDetails": {
"description": "Identifier of one of the predefined pickup details. Required for orders containing line items with shipping type `pickup`. Acceptable values are: - \"`dwight`\" - \"`jim`\" - \"`pam`\" ",
"type": "string"
},
"enableOrderinvoices": {
"type": "boolean",
"description": "Whether the orderinvoices service should support this order."
},
"predefinedEmail": {
"type": "string",
"description": "Required. Email address of the customer. Acceptable values are: - \"`[email protected]`\" - \"`[email protected]`\" - \"`[email protected]`\" "
}
}
},
"LiasettingsListResponse": {
"properties": {
"resources": {
"type": "array",
"items": {
"$ref": "LiaSettings"
}
},
"nextPageToken": {
"description": "The token for the retrieval of the next page of LIA settings.",
"type": "string"
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#liasettingsListResponse\".",
"type": "string"
}
},
"id": "LiasettingsListResponse",
"type": "object"
},
"LocationIdSet": {
"properties": {
"locationIds": {
"description": "A non-empty list of location IDs. They must all be of the same location type (e.g., state).",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object",
"id": "LocationIdSet"
},
"AccountStatusAccountLevelIssue": {
"type": "object",
"properties": {
"destination": {
"type": "string",
"description": "The destination the issue applies to. If this field is empty then the issue applies to all available destinations."
},
"id": {
"type": "string",
"description": "Issue identifier."
},
"severity": {
"type": "string",
"description": "Severity of the issue. Acceptable values are: - \"`critical`\" - \"`error`\" - \"`suggestion`\" "
},
"title": {
"type": "string",
"description": "Short description of the issue."
},
"detail": {
"type": "string",
"description": "Additional details about the issue."
},
"country": {
"type": "string",
"description": "Country for which this issue is reported."
},
"documentation": {
"description": "The URL of a web page to help resolving this issue.",
"type": "string"
}
},
"id": "AccountStatusAccountLevelIssue"
},
"RateGroup": {
"id": "RateGroup",
"type": "object",
"properties": {
"applicableShippingLabels": {
"description": "A list of shipping labels defining the products to which this rate group applies to. This is a disjunction: only one of the labels has to match for the rate group to apply. May only be empty for the last rate group of a service. Required.",
"type": "array",
"items": {
"type": "string"
}
},
"mainTable": {
"description": "A table defining the rate group, when `singleValue` is not expressive enough. Can only be set if `singleValue` is not set.",
"$ref": "Table"
},
"carrierRates": {
"type": "array",
"items": {
"$ref": "CarrierRate"
},
"description": "A list of carrier rates that can be referred to by `mainTable` or `singleValue`."
},
"singleValue": {
"$ref": "Value",
"description": "The value of the rate group (e.g. flat rate $10). Can only be set if `mainTable` and `subtables` are not set."
},
"name": {
"type": "string",
"description": "Name of the rate group. Optional. If set has to be unique within shipping service."
},
"subtables": {
"type": "array",
"items": {
"$ref": "Table"
},
"description": "A list of subtables referred to by `mainTable`. Can only be set if `mainTable` is set."
}
}
},
"ReturnPricingInfo": {
"properties": {
"chargeReturnShippingFee": {
"type": "boolean",
"description": "Default option for whether merchant should charge the customer for return shipping costs, based on customer selected return reason and merchant's return policy for the items being returned."
},
"refundableShippingAmount": {
"$ref": "MonetaryAmount",
"description": "Maximum amount that can be refunded for the original shipping fee."
},
"maxReturnShippingFee": {
"$ref": "MonetaryAmount",
"description": "Maximum return shipping costs that may be charged to the customer depending on merchant's assessment of the return reason and the merchant's return policy for the items being returned."
},
"totalRefundedAmount": {
"$ref": "MonetaryAmount",
"description": "Total amount already refunded by the merchant. It includes all types of refunds (items, shipping, etc.) Not provided if no refund has been applied yet."
},
"refundableItemsTotalAmount": {
"$ref": "MonetaryAmount",
"description": "Total amount that can be refunded for the items in this return. It represents the total amount received by the merchant for the items, after applying merchant coupons."
}
},
"id": "ReturnPricingInfo",
"type": "object"
},
"DatafeedStatus": {
"description": "The status of a datafeed, i.e., the result of the last retrieval of the datafeed computed asynchronously when the feed processing is finished.",
"id": "DatafeedStatus",
"properties": {
"processingStatus": {
"description": "The processing status of the feed. Acceptable values are: - \"`\"`failure`\": The feed could not be processed or all items had errors.`\" - \"`in progress`\": The feed is being processed. - \"`none`\": The feed has not yet been processed. For example, a feed that has never been uploaded will have this processing status. - \"`success`\": The feed was processed successfully, though some items might have had errors. ",
"type": "string"
},
"language": {
"type": "string",
"description": "The two-letter ISO 639-1 language for which the status is reported."
},
"lastUploadDate": {
"description": "The last date at which the feed was uploaded.",
"type": "string"
},
"itemsTotal": {
"type": "string",
"format": "uint64",
"description": "The number of items in the feed that were processed."
},
"errors": {
"items": {
"$ref": "DatafeedStatusError"
},
"type": "array",
"description": "The list of errors occurring in the feed."
},
"country": {
"type": "string",
"description": "The country for which the status is reported, represented as a CLDR territory code."
},
"itemsValid": {
"description": "The number of items in the feed that were valid.",
"type": "string",
"format": "uint64"
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"`content#datafeedStatus`\"",
"type": "string"
},
"datafeedId": {
"description": "The ID of the feed for which the status is reported.",
"format": "uint64",
"type": "string"
},
"warnings": {
"description": "The list of errors occurring in the feed.",
"type": "array",
"items": {
"$ref": "DatafeedStatusError"
}
}
},
"type": "object"
},
"OrderTrackingSignalShipmentLineItemMapping": {
"type": "object",
"description": "Represents how many items are in the shipment for the given shipment_id and line_item_id.",
"id": "OrderTrackingSignalShipmentLineItemMapping",
"properties": {
"quantity": {
"description": "Required. The line item quantity in the shipment.",
"format": "int64",
"type": "string"
},
"lineItemId": {
"description": "Required. The line item ID.",
"type": "string"
},
"shipmentId": {
"type": "string",
"description": "Required. The shipment ID."
}
}
},
"OrdersSetLineItemMetadataResponse": {
"id": "OrdersSetLineItemMetadataResponse",
"properties": {
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersSetLineItemMetadataResponse\".",
"type": "string"
},
"executionStatus": {
"type": "string",
"description": "The status of the execution. Acceptable values are: - \"`duplicate`\" - \"`executed`\" "
}
},
"type": "object"
},
"OrderAddress": {
"id": "OrderAddress",
"properties": {
"postalCode": {
"description": "Postal Code or ZIP (e.g. \"94043\").",
"type": "string"
},
"streetAddress": {
"description": "Street-level part of the address.",
"items": {
"type": "string"
},
"type": "array"
},
"country": {
"type": "string",
"description": "CLDR country code (e.g. \"US\")."
},
"recipientName": {
"description": "Name of the recipient.",
"type": "string"
},
"fullAddress": {
"items": {
"type": "string"
},
"type": "array",
"description": "Strings representing the lines of the printed label for mailing the order, for example: John Smith 1600 Amphitheatre Parkway Mountain View, CA, 94043 United States "
},
"region": {
"description": "Top-level administrative subdivision of the country. For example, a state like California (\"CA\") or a province like Quebec (\"QC\").",
"type": "string"
},
"locality": {
"description": "City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).",
"type": "string"
},
"isPostOfficeBox": {
"description": "Whether the address is a post office box.",
"type": "boolean"
}
},
"type": "object"
},
"AccountTax": {
"properties": {
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#accountTax\"."
},
"accountId": {
"format": "uint64",
"type": "string",
"description": "Required. The ID of the account to which these account tax settings belong."
},
"rules": {
"items": {
"$ref": "AccountTaxTaxRule"
},
"type": "array",
"description": "Tax rules. Updating the tax rules will enable US taxes (not reversible). Defining no rules is equivalent to not charging tax at all."
}
},
"type": "object",
"id": "AccountTax",
"description": "The tax settings of a merchant account. All methods require the admin role."
},
"SettlementTransactionAmount": {
"type": "object",
"properties": {
"commission": {
"$ref": "SettlementTransactionAmountCommission"
},
"type": {
"description": "The type of the amount. Acceptable values are: - \"`itemPrice`\" - \"`orderPrice`\" - \"`refund`\" - \"`earlyRefund`\" - \"`courtesyRefund`\" - \"`returnRefund`\" - \"`returnLabelShippingFeeAmount`\" - \"`lumpSumCorrectionAmount`\" ",
"type": "string"
},
"description": {
"type": "string",
"description": "The description of the event. Acceptable values are: - \"`taxWithhold`\" - \"`principal`\" - \"`principalAdjustment`\" - \"`shippingFee`\" - \"`merchantRemittedSalesTax`\" - \"`googleRemittedSalesTax`\" - \"`merchantCoupon`\" - \"`merchantCouponTax`\" - \"`merchantRemittedDisposalTax`\" - \"`googleRemittedDisposalTax`\" - \"`merchantRemittedRedemptionFee`\" - \"`googleRemittedRedemptionFee`\" - \"`eeeEcoFee`\" - \"`furnitureEcoFee`\" - \"`copyPrivateFee`\" - \"`eeeEcoFeeCommission`\" - \"`furnitureEcoFeeCommission`\" - \"`copyPrivateFeeCommission`\" - \"`principalRefund`\" - \"`principalRefundTax`\" - \"`itemCommission`\" - \"`adjustmentCommission`\" - \"`shippingFeeCommission`\" - \"`commissionRefund`\" - \"`damaged`\" - \"`damagedOrDefectiveItem`\" - \"`expiredItem`\" - \"`faultyItem`\" - \"`incorrectItemReceived`\" - \"`itemMissing`\" - \"`qualityNotExpected`\" - \"`receivedTooLate`\" - \"`storePackageMissing`\" - \"`transitPackageMissing`\" - \"`unsuccessfulDeliveryUndeliverable`\" - \"`wrongChargeInStore`\" - \"`wrongItem`\" - \"`returns`\" - \"`undeliverable`\" - \"`issueRelatedRefundAndReplacementAmountDescription`\" - \"`refundFromMerchant`\" - \"`returnLabelShippingFee`\" - \"`lumpSumCorrection`\" - \"`pspFee`\" "
},
"transactionAmount": {
"$ref": "Price",
"description": "The amount that contributes to the line item price."
}
},
"id": "SettlementTransactionAmount"
},
"CarriersCarrier": {
"properties": {
"name": {
"description": "The name of the carrier (e.g., `\"UPS\"`). Always present.",
"type": "string"
},
"services": {
"items": {
"type": "string"
},
"description": "A list of supported services (e.g., `\"ground\"`) for that carrier. Contains at least one service.",
"type": "array"
},
"country": {
"description": "The CLDR country code of the carrier (e.g., \"US\"). Always present.",
"type": "string"
}
},
"type": "object",
"id": "CarriersCarrier"
},
"AccountGoogleMyBusinessLink": {
"type": "object",
"id": "AccountGoogleMyBusinessLink",
"properties": {
"status": {
"type": "string",
"description": "Status of the link between this Merchant Center account and the GMB account. Acceptable values are: - \"`active`\" - \"`pending`\" "
},
"gmbAccountId": {
"description": "The ID of the GMB account. If this is provided, then `gmbEmail` is ignored. The value of this field should match the `accountId` used by the GMB API.",
"type": "string"
},
"gmbEmail": {
"description": "The GMB email address of which a specific account within a GMB account. A sample account within a GMB account could be a business account with set of locations, managed under the GMB account.",
"type": "string"
}
}
},
"LocalInventory": {
"type": "object",
"id": "LocalInventory",
"properties": {
"price": {
"$ref": "Price",
"description": "Price of the product."
},
"availability": {
"description": "Availability of the product. For accepted attribute values, see the local product inventory feed specification.",
"type": "string"
},
"quantity": {
"description": "Quantity of the product. Must be nonnegative.",
"format": "uint32",
"type": "integer"
},
"salePrice": {
"description": "Sale price of the product. Mandatory if `sale_price_effective_date` is defined.",
"$ref": "Price"
},
"instoreProductLocation": {
"description": "In-store product location.",
"type": "string"
},
"pickupSla": {
"description": "Expected date that an order will be ready for pickup relative to the order date. Must be submitted together with `pickupMethod`. For accepted attribute values, see the local product inventory feed specification.",
"type": "string"
},
"pickupMethod": {
"type": "string",
"description": "Supported pickup method for this offer. Unless the value is \"not supported\", this field must be submitted together with `pickupSla`. For accepted attribute values, see the local product inventory feed // specification."
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"`content#localInventory`\"",
"type": "string"
},
"storeCode": {
"description": "Required. Store code of this local inventory resource.",
"type": "string"
},
"salePriceEffectiveDate": {
"description": "A date range represented by a pair of ISO 8601 dates separated by a space, comma, or slash. Both dates may be specified as 'null' if undecided.",
"type": "string"
}
},
"description": "Local inventory resource. For accepted attribute values, see the local product inventory feed specification."
},
"AccounttaxCustomBatchResponse": {
"id": "AccounttaxCustomBatchResponse",
"properties": {
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#accounttaxCustomBatchResponse\".",
"type": "string"
},
"entries": {
"items": {
"$ref": "AccounttaxCustomBatchResponseEntry"
},
"description": "The result of the execution of the batch requests.",
"type": "array"
}
},
"type": "object"
},
"ReturnpolicyListResponse": {
"properties": {
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#returnpolicyListResponse\"."
},
"resources": {
"items": {
"$ref": "ReturnPolicy"
},
"type": "array"
}
},
"id": "ReturnpolicyListResponse",
"type": "object"
},
"OrderLineItemProductFee": {
"type": "object",
"properties": {
"name": {
"description": "Name of the fee.",
"type": "string"
},
"amount": {
"description": "Amount of the fee.",
"$ref": "Price"
}
},
"id": "OrderLineItemProductFee"
},
"Service": {
"properties": {
"currency": {
"type": "string",
"description": "The CLDR code of the currency to which this service applies. Must match that of the prices in rate groups."
},
"deliveryCountry": {
"type": "string",
"description": "The CLDR territory code of the country to which the service applies. Required."
},
"name": {
"description": "Free-form name of the service. Must be unique within target account. Required.",
"type": "string"
},
"active": {
"description": "A boolean exposing the active status of the shipping service. Required.",
"type": "boolean"
},
"shipmentType": {
"type": "string",
"description": "Type of locations this service ships orders to. Acceptable values are: - \"`delivery`\" - \"`pickup`\" "
},
"deliveryTime": {
"description": "Time spent in various aspects from order to the delivery of the product. Required.",
"$ref": "DeliveryTime"
},
"eligibility": {
"description": "Eligibility for this service. Acceptable values are: - \"`All scenarios`\" - \"`All scenarios except Shopping Actions`\" - \"`Shopping Actions`\" ",
"type": "string"
},
"minimumOrderValueTable": {
"$ref": "MinimumOrderValueTable",
"description": "Table of per store minimum order values for the pickup fulfillment type. Cannot be set together with minimum_order_value."
},
"pickupService": {
"$ref": "PickupCarrierService",
"description": "The carrier-service pair delivering items to collection points. The list of supported pickup services can be retrieved via the `getSupportedPickupServices` method. Required if and only if the service delivery type is `pickup`."
},
"rateGroups": {
"type": "array",
"items": {
"$ref": "RateGroup"
},
"description": "Shipping rate group definitions. Only the last one is allowed to have an empty `applicableShippingLabels`, which means \"everything else\". The other `applicableShippingLabels` must not overlap."
},
"minimumOrderValue": {
"description": "Minimum order value for this service. If set, indicates that customers will have to spend at least this amount. All prices within a service must have the same currency. Cannot be set together with minimum_order_value_table.",
"$ref": "Price"
}
},
"type": "object",
"id": "Service"
},
"SettlementreportsListResponse": {
"type": "object",
"properties": {
"resources": {
"type": "array",
"items": {
"$ref": "SettlementReport"
}
},
"nextPageToken": {
"description": "The token for the retrieval of the next page of returns.",
"type": "string"
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#settlementreportsListResponse\"."
}
},
"id": "SettlementreportsListResponse"
},
"MerchantOrderReturnItem": {
"type": "object",
"id": "MerchantOrderReturnItem",
"properties": {
"customerReturnReason": {
"$ref": "CustomerReturnReason",
"description": "The reason that the customer chooses to return an item."
},
"refundableAmount": {
"description": "Maximum amount that can be refunded for this return item.",
"$ref": "MonetaryAmount"
},
"product": {
"description": "Product data from the time of the order placement.",
"$ref": "OrderLineItemProduct"
},
"merchantRejectionReason": {
"$ref": "MerchantRejectionReason",
"description": "The reason that the merchant chose to reject an item return."
},
"returnShipmentIds": {
"items": {
"type": "string"
},
"type": "array",
"description": "IDs of the return shipments that this return item belongs to."
},
"returnItemId": {
"description": "Unit level ID for the return item. Different units of the same product will have different IDs.",
"type": "string"
},
"merchantReturnReason": {
"$ref": "RefundReason",
"description": "The reason that merchant chooses to accept a return item."
},
"shipmentGroupId": {
"description": "ID of the original shipment group. Provided for shipments with invoice support.",
"type": "string"
},
"itemId": {
"type": "string",
"description": "Product level item ID. If the returned items are of the same product, they will have the same ID."
},
"state": {
"type": "string",
"description": "State of the item. Acceptable values are: - \"`canceled`\" - \"`new`\" - \"`received`\" - \"`refunded`\" - \"`rejected`\" "
},
"shipmentUnitId": {
"type": "string",
"description": "ID of the shipment unit assigned by the merchant. Provided for shipments with invoice support."
}
}
},
"RepricingRuleReportBuyboxWinningRuleStats": {
"description": "Stats specific to buybox winning rules for rule report.",
"id": "RepricingRuleReportBuyboxWinningRuleStats",
"properties": {
"buyboxWonProductCount": {
"format": "int32",
"description": "Number of unique products that won the buybox with this rule during this period of time.",
"type": "integer"
}
},
"type": "object"
},
"ProductShippingWeight": {
"properties": {
"value": {
"format": "double",
"description": "The weight of the product used to calculate the shipping cost of the item.",
"type": "number"
},
"unit": {
"type": "string",
"description": "The unit of value."
}
},
"id": "ProductShippingWeight",
"type": "object"
},
"RepricingRuleEffectiveTime": {
"type": "object",
"id": "RepricingRuleEffectiveTime",
"properties": {
"fixedTimePeriods": {
"items": {
"$ref": "RepricingRuleEffectiveTimeFixedTimePeriod"
},
"type": "array",
"description": "A list of fixed time periods combined with OR. The maximum number of entries is limited to 5."
}
}
},
"ShippingsettingsGetSupportedCarriersResponse": {
"properties": {
"carriers": {
"type": "array",
"description": "A list of supported carriers. May be empty.",
"items": {
"$ref": "CarriersCarrier"
}
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#shippingsettingsGetSupportedCarriersResponse\"."
}
},
"type": "object",
"id": "ShippingsettingsGetSupportedCarriersResponse"
},
"ShippingsettingsListResponse": {
"id": "ShippingsettingsListResponse",
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#shippingsettingsListResponse\"."
},
"nextPageToken": {
"type": "string",
"description": "The token for the retrieval of the next page of shipping settings."
},
"resources": {
"type": "array",
"items": {
"$ref": "ShippingSettings"
}
}
}
},
"OrdersCustomBatchRequestEntryShipLineItemsShipmentInfo": {
"properties": {
"trackingId": {
"type": "string",
"description": "The tracking ID for the shipment."
},
"shipmentId": {
"type": "string",
"description": "Required. The ID of the shipment. This is assigned by the merchant and is unique to each shipment."
},
"carrier": {
"description": "The carrier handling the shipment. See `shipments[].carrier` in the Orders resource representation for a list of acceptable values.",
"type": "string"
}
},
"type": "object",
"id": "OrdersCustomBatchRequestEntryShipLineItemsShipmentInfo"
},
"PickupServicesPickupService": {
"type": "object",
"id": "PickupServicesPickupService",
"properties": {
"carrierName": {
"type": "string",
"description": "The name of the carrier (e.g., `\"UPS\"`). Always present."
},
"serviceName": {
"type": "string",
"description": "The name of the pickup service (e.g., `\"Access point\"`). Always present."
},
"country": {
"type": "string",
"description": "The CLDR country code of the carrier (e.g., \"US\"). Always present."
}
}
},
"RegionalinventoryCustomBatchResponse": {
"id": "RegionalinventoryCustomBatchResponse",
"properties": {
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#regionalinventoryCustomBatchResponse\"."
},
"entries": {
"description": "The result of the execution of the batch requests.",
"type": "array",
"items": {
"$ref": "RegionalinventoryCustomBatchResponseEntry"
}
}
},
"type": "object"
},
"OrderCustomerMarketingRightsInfo": {
"id": "OrderCustomerMarketingRightsInfo",
"properties": {
"marketingEmailAddress": {
"type": "string",
"description": "Email address that can be used for marketing purposes. The field may be empty even if `explicitMarketingPreference` is 'granted'. This happens when retrieving an old order from the customer who deleted their account."
},
"lastUpdatedTimestamp": {
"type": "string",
"description": "Timestamp when last time marketing preference was updated. Could be empty, if user wasn't offered a selection yet."
},
"explicitMarketingPreference": {
"type": "string",
"description": "Last known customer selection regarding marketing preferences. In certain cases this selection might not be known, so this field would be empty. If a customer selected `granted` in their most recent order, they can be subscribed to marketing emails. Customers who have chosen `denied` must not be subscribed, or must be unsubscribed if already opted-in. Acceptable values are: - \"`denied`\" - \"`granted`\" "
}
},
"type": "object"
},
"LiaCountrySettings": {
"id": "LiaCountrySettings",
"properties": {
"storePickupActive": {
"description": "The status of the \"Store pickup\" feature.",
"type": "boolean"
},
"posDataProvider": {
"description": "The POS data provider linked with this country.",
"$ref": "LiaPosDataProvider"
},
"hostedLocalStorefrontActive": {
"type": "boolean",
"description": "The status of the \"Merchant hosted local storefront\" feature."
},
"onDisplayToOrder": {
"$ref": "LiaOnDisplayToOrderSettings",
"description": "LIA \"On Display To Order\" settings."
},
"inventory": {
"$ref": "LiaInventorySettings",
"description": "LIA inventory verification settings."
},
"about": {
"description": "The settings for the About page.",
"$ref": "LiaAboutPageSettings"
},
"country": {
"description": "Required. CLDR country code (e.g. \"US\").",
"type": "string"
}
},
"type": "object"
},
"OrderreturnsRefundOperation": {
"properties": {
"returnRefundReason": {
"type": "string",
"description": "Code of the refund reason."
},
"partialRefund": {
"$ref": "OrderreturnsPartialRefund",
"description": "If this is set, the item will be partially refunded. Merchant can choose this refund option to specify the customized amount that to be refunded to the customer."
},
"fullRefund": {
"type": "boolean",
"description": "If true, the item will be fully refunded. Allowed only when payment_type is FOP. Merchant can choose this refund option to indicate the full remaining amount of corresponding object to be refunded to the customer via FOP."
},
"reasonText": {
"type": "string",
"description": "The explanation of the reason."
},
"paymentType": {
"type": "string",
"description": "The payment way of issuing refund. Default value is ORIGINAL_FOP if not set."
}
},
"type": "object",
"id": "OrderreturnsRefundOperation"
},
"OrdersCreateTestReturnResponse": {
"type": "object",
"properties": {
"returnId": {
"description": "The ID of the newly created test order return.",
"type": "string"
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersCreateTestReturnResponse\"."
}
},
"id": "OrdersCreateTestReturnResponse"
},
"LabelIds": {
"properties": {
"labelIds": {
"description": "The list of label IDs.",
"type": "array",
"items": {
"type": "string",
"format": "int64"
}
}
},
"id": "LabelIds",
"type": "object",
"description": "The IDs of labels that should be assigned to the CSS domain."
},
"ShippingSettings": {
"id": "ShippingSettings",
"properties": {
"services": {
"description": "The target account's list of services. Optional.",
"type": "array",
"items": {
"$ref": "Service"
}
},
"accountId": {
"format": "uint64",
"type": "string",
"description": "The ID of the account to which these account shipping settings belong. Ignored upon update, always present in get request responses."
},
"postalCodeGroups": {
"description": "A list of postal code groups that can be referred to in `services`. Optional.",
"items": {
"$ref": "PostalCodeGroup"
},
"type": "array"
}
},
"description": "The merchant account's shipping settings. All methods except getsupportedcarriers and getsupportedholidays require the admin role.",
"type": "object"
},
"ReturnAddressAddress": {
"id": "ReturnAddressAddress",
"type": "object",
"properties": {
"streetAddress": {
"items": {
"type": "string"
},
"type": "array",
"description": "Street-level part of the address. May be up to two lines, each line specified as an array element."
},
"locality": {
"type": "string",
"description": "City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs)."
},
"postalCode": {
"type": "string",
"description": "Postal code or ZIP (e.g. \"94043\")."
},
"region": {
"description": "Top-level administrative subdivision of the country. For example, a state like California (\"CA\") or a province like Quebec (\"QC\").",
"type": "string"
},
"recipientName": {
"type": "string",
"description": "Name of the recipient to address returns to."
},
"country": {
"description": "CLDR country code (e.g. \"US\").",
"type": "string"
}
}
},
"Order": {
"id": "Order",
"properties": {
"promotions": {
"type": "array",
"description": "Promotions associated with the order. To determine which promotions apply to which products, check the `Promotions[].appliedItems[].lineItemId` field against the `LineItems[].id` 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 price paid by the customer for a single line item including the discount: For each promotion, subtract the `LineItems[].adjustments[].priceAdjustment.value` amount from the `LineItems[].Price.value`. 2. To calculate price paid by the customer for a single line item including the discount in case of multiple quantity: For each promotion, divide the `LineItems[].adjustments[].priceAdjustment.value` by the quantity of products then subtract the resulting value from the `LineItems[].Product.Price.value` for each quantity item. Only 1 promotion can be applied to an offerId in a given order. To refund an item which had a promotion applied to it, make sure to refund the amount after first subtracting the promotion discount from the item price. More details about the program are here.",
"items": {
"$ref": "OrderPromotion"
}
},
"netTaxAmount": {
"$ref": "Price",
"description": "The net amount for the order (tax part). Note that in certain cases due to taxable base adjustment `netTaxAmount` might not match to a sum of tax field across all lineItems and refunds."
},
"merchantOrderId": {
"type": "string",
"description": "Merchant-provided ID of the order."
},
"status": {
"type": "string",
"description": "The status of the order. Acceptable values are: - \"`canceled`\" - \"`delivered`\" - \"`inProgress`\" - \"`partiallyDelivered`\" - \"`partiallyReturned`\" - \"`partiallyShipped`\" - \"`pendingShipment`\" - \"`returned`\" - \"`shipped`\" "
},
"shipments": {
"description": "Shipments of the order.",
"type": "array",
"items": {
"$ref": "OrderShipment"
}
},
"shippingCost": {
"$ref": "Price",
"description": "The total cost of shipping for all items."
},
"id": {
"type": "string",
"description": "The REST ID of the order. Globally unique."
},
"customer": {
"$ref": "OrderCustomer",
"description": "The details of the customer who placed the order."
},
"taxCollector": {
"description": "The party responsible for collecting and remitting taxes. Acceptable values are: - \"`marketplaceFacilitator`\" - \"`merchant`\" ",
"type": "string"
},
"deliveryDetails": {
"description": "Delivery details for shipments of type `delivery`.",
"$ref": "OrderDeliveryDetails"
},
"lineItems": {
"type": "array",
"description": "Line items that are ordered.",
"items": {
"$ref": "OrderLineItem"
}
},
"merchantId": {
"format": "uint64",
"type": "string"
},
"annotations": {
"items": {
"$ref": "OrderOrderAnnotation"
},
"description": "List of key-value pairs that are attached to a given order.",
"type": "array"
},
"netPriceAmount": {
"$ref": "Price",
"description": "The net amount for the order (price part). For example, if an order was originally for $100 and a refund was issued for $20, the net amount will be $80."
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"`content#order`\"",
"type": "string"
},
"refunds": {
"items": {
"$ref": "OrderRefund"
},
"type": "array",
"description": "Refunds for the order."
},
"paymentStatus": {
"description": "The status of the payment. Acceptable values are: - \"`paymentCaptured`\" - \"`paymentRejected`\" - \"`paymentSecured`\" - \"`pendingAuthorization`\" ",
"type": "string"
},
"placedDate": {
"type": "string",
"description": "The date when the order was placed, in ISO 8601 format."
},
"billingAddress": {
"$ref": "OrderAddress",
"description": "The billing address."
},
"acknowledged": {
"description": "Whether the order was acknowledged.",
"type": "boolean"
},
"pickupDetails": {
"description": "Pickup details for shipments of type `pickup`.",
"$ref": "OrderPickupDetails"
},
"shippingCostTax": {
"description": "The tax for the total shipping cost.",
"$ref": "Price"
}
},
"type": "object",
"description": "Order. Production access (all methods) requires the order manager role. Sandbox access does not."
},
"OrdersShipLineItemsRequest": {
"type": "object",
"properties": {
"operationId": {
"description": "The ID of the operation. Unique across all operations for a given order.",
"type": "string"
},
"shipmentGroupId": {
"type": "string",
"description": "ID of the shipment group. Required for orders that use the orderinvoices service."
},
"lineItems": {
"description": "Line items to ship.",
"items": {
"$ref": "OrderShipmentLineItemShipment"
},
"type": "array"
},
"shipmentInfos": {
"type": "array",
"items": {
"$ref": "OrdersCustomBatchRequestEntryShipLineItemsShipmentInfo"
},
"description": "Shipment information. This field is repeated because a single line item can be shipped in several packages (and have several tracking IDs)."
}
},
"id": "OrdersShipLineItemsRequest"
},
"OrderCancellation": {
"type": "object",
"properties": {
"reasonText": {
"type": "string",
"description": "The explanation of the reason."
},
"quantity": {
"type": "integer",
"description": "The quantity that was canceled.",
"format": "uint32"
},
"actor": {
"type": "string",
"description": "The actor that created the cancellation. Acceptable values are: - \"`customer`\" - \"`googleBot`\" - \"`googleCustomerService`\" - \"`googlePayments`\" - \"`googleSabre`\" - \"`merchant`\" "
},
"reason": {
"description": "The reason for the cancellation. Orders that are canceled with a noInventory reason will lead to the removal of the product from Buy on Google until you make an update to that product. This will not affect your Shopping ads. Acceptable values are: - \"`autoPostInternal`\" - \"`autoPostInvalidBillingAddress`\" - \"`autoPostNoInventory`\" - \"`autoPostPriceError`\" - \"`autoPostUndeliverableShippingAddress`\" - \"`couponAbuse`\" - \"`customerCanceled`\" - \"`customerInitiatedCancel`\" - \"`customerSupportRequested`\" - \"`failToPushOrderGoogleError`\" - \"`failToPushOrderMerchantError`\" - \"`failToPushOrderMerchantFulfillmentError`\" - \"`failToPushOrderToMerchant`\" - \"`failToPushOrderToMerchantOutOfStock`\" - \"`invalidCoupon`\" - \"`malformedShippingAddress`\" - \"`merchantDidNotShipOnTime`\" - \"`noInventory`\" - \"`orderTimeout`\" - \"`other`\" - \"`paymentAbuse`\" - \"`paymentDeclined`\" - \"`priceError`\" - \"`returnRefundAbuse`\" - \"`shippingPriceError`\" - \"`taxError`\" - \"`undeliverableShippingAddress`\" - \"`unsupportedPoBoxAddress`\" ",
"type": "string"
},
"creationDate": {
"type": "string",
"description": "Date on which the cancellation has been created, in ISO 8601 format."
}
},
"id": "OrderCancellation"
},
"AccountsCustomBatchRequest": {
"id": "AccountsCustomBatchRequest",
"type": "object",
"properties": {
"entries": {
"description": "The request entries to be processed in the batch.",
"type": "array",
"items": {
"$ref": "AccountsCustomBatchRequestEntry"
}
}
}
},
"OnboardBuyOnGoogleProgramRequest": {
"type": "object",
"properties": {
"customerServiceEmail": {
"type": "string",
"description": "The customer service email."
}
},
"id": "OnboardBuyOnGoogleProgramRequest",
"description": "Request message for the OnboardProgram method."
},
"HolidayCutoff": {
"type": "object",
"properties": {
"holidayId": {
"type": "string",
"description": "Unique identifier for the holiday. Required."
},
"deadlineHour": {
"type": "integer",
"format": "uint32",
"description": "Hour of the day on the deadline date until which the order has to be placed to qualify for the delivery guarantee. Possible values are: 0 (midnight), 1, ..., 12 (noon), 13, ..., 23. Required."
},
"deadlineDate": {
"type": "string",
"description": "Date of the order deadline, in ISO 8601 format. E.g. \"2016-11-29\" for 29th November 2016. Required."
},
"visibleFromDate": {
"type": "string",
"description": "Date on which the deadline will become visible to consumers in ISO 8601 format. E.g. \"2016-10-31\" for 31st October 2016. Required."
},
"deadlineTimezone": {
"description": "Timezone identifier for the deadline hour. A list of identifiers can be found in the AdWords API documentation. E.g. \"Europe/Zurich\". Required.",
"type": "string"
}
},
"id": "HolidayCutoff"
},
"OrderLineItem": {
"type": "object",
"properties": {
"id": {
"description": "The ID of the line item.",
"type": "string"
},
"product": {
"$ref": "OrderLineItemProduct",
"description": "Product data as seen by customer from the time of the order placement. Note that certain attributes values (e.g. title or gtin) might be reformatted and no longer match values submitted via product feed."
},
"cancellations": {
"description": "Cancellations of the line item.",
"type": "array",
"items": {
"$ref": "OrderCancellation"
}
},
"quantityOrdered": {
"type": "integer",
"format": "uint32",
"description": "Number of items ordered."
},
"returnInfo": {
"$ref": "OrderLineItemReturnInfo",
"description": "Details of the return policy for the line item."
},
"returns": {
"items": {
"$ref": "OrderReturn"
},
"type": "array",
"description": "Returns of the line item."
},
"price": {
"$ref": "Price",
"description": "Total price for the line item. For example, if two items for $10 are purchased, the total price will be $20."
},
"shippingDetails": {
"description": "Details of the requested shipping for the line item.",
"$ref": "OrderLineItemShippingDetails"
},
"quantityUndeliverable": {
"type": "integer",
"format": "uint32",
"description": "Number of items undeliverable."
},
"quantityReadyForPickup": {
"type": "integer",
"description": "Number of items ready for pickup.",
"format": "uint32"
},
"quantityCanceled": {
"description": "Number of items canceled.",
"format": "uint32",
"type": "integer"
},
"annotations": {
"description": "Annotations that are attached to the line item.",
"items": {
"$ref": "OrderMerchantProvidedAnnotation"
},
"type": "array"
},
"quantityDelivered": {
"type": "integer",
"format": "uint32",
"description": "Number of items delivered."
},
"quantityPending": {
"description": "Number of items pending.",
"type": "integer",
"format": "uint32"
},
"quantityReturned": {
"format": "uint32",
"description": "Number of items returned.",
"type": "integer"
},
"adjustments": {
"items": {
"$ref": "OrderLineItemAdjustment"
},
"type": "array",
"description": "Price and tax adjustments applied on the line item."
},
"quantityShipped": {
"format": "uint32",
"description": "Number of items shipped.",
"type": "integer"
},
"tax": {
"description": "Total tax amount for the line item. For example, if two items are purchased, and each have a cost tax of $2, the total tax amount will be $4.",
"$ref": "Price"
}
},
"id": "OrderLineItem"
},
"OrderreturnsAcknowledgeResponse": {
"id": "OrderreturnsAcknowledgeResponse",
"properties": {
"executionStatus": {
"type": "string",
"description": "The status of the execution. Acceptable values are: - \"`duplicate`\" - \"`executed`\" "
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#orderreturnsAcknowledgeResponse\".",
"type": "string"
}
},
"type": "object"
}
},
"rootUrl": "https://shoppingcontent.googleapis.com/",
"servicePath": "content/v2.1/",
"id": "content:v2.1",
"mtlsRootUrl": "https://shoppingcontent.mtls.googleapis.com/",
"documentationLink": "https://developers.google.com/shopping-content/v2/",
"ownerDomain": "google.com",
"protocol": "rest",
"parameters": {
"alt": {
"type": "string",
"location": "query",
"description": "Data format for response.",
"enum": [
"json",
"media",
"proto"
],
"default": "json",
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
]
},
"access_token": {
"description": "OAuth access token.",
"location": "query",
"type": "string"
},
"upload_protocol": {
"location": "query",
"type": "string",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\")."
},
"fields": {
"location": "query",
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"uploadType": {
"type": "string",
"location": "query",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")."
},
"prettyPrint": {
"type": "boolean",
"location": "query",
"description": "Returns response with indentations and line breaks.",
"default": "true"
},
"oauth_token": {
"location": "query",
"description": "OAuth 2.0 token for the current user.",
"type": "string"
},
"callback": {
"location": "query",
"description": "JSONP",
"type": "string"
},
"key": {
"location": "query",
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"type": "string"
},
"$.xgafv": {
"type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"enum": [
"1",
"2"
],
"description": "V1 error format.",
"location": "query"
},
"quotaUser": {
"location": "query",
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"type": "string"
}
},
"fullyEncodeReservedExpansion": true,
"ownerName": "Google",
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/content": {
"description": "Manage your product listings and accounts for Google Shopping"
}
}
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy