blob: e01b6585d750ea291c7ff2dccef8b0dabc57d802 [file] [log] [blame] [edit]
{
"discoveryVersion": "v1",
"description": "Manage your product listings and accounts for Google Shopping",
"baseUrl": "https://shoppingcontent.googleapis.com/",
"ownerName": "Google",
"documentationLink": "https://developers.google.com/shopping-content/v2/",
"resources": {
"orderinvoices": {
"methods": {
"createrefundinvoice": {
"httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"flatPath": "content/v2.1/{merchantId}/orderinvoices/{orderId}/createRefundInvoice",
"id": "content.orderinvoices.createrefundinvoice",
"parameters": {
"merchantId": {
"required": true,
"location": "path",
"type": "string",
"description": "The ID of the account that manages the order. This cannot be a multi-client account.",
"format": "uint64"
},
"orderId": {
"location": "path",
"required": true,
"type": "string",
"description": "The ID of the order."
}
},
"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.",
"parameterOrder": [
"merchantId",
"orderId"
],
"path": "content/v2.1/{merchantId}/orderinvoices/{orderId}/createRefundInvoice",
"response": {
"$ref": "OrderinvoicesCreateRefundInvoiceResponse"
},
"request": {
"$ref": "OrderinvoicesCreateRefundInvoiceRequest"
}
},
"createchargeinvoice": {
"scopes": [
"https://www.googleapis.com/auth/content"
],
"httpMethod": "POST",
"parameters": {
"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
},
"orderId": {
"location": "path",
"description": "The ID of the order.",
"type": "string",
"required": true
}
},
"path": "content/v2.1/{merchantId}/orderinvoices/{orderId}/createChargeInvoice",
"flatPath": "content/v2.1/{merchantId}/orderinvoices/{orderId}/createChargeInvoice",
"parameterOrder": [
"merchantId",
"orderId"
],
"description": "Creates a charge invoice for a shipment group, and triggers a charge capture for orderinvoice enabled orders.",
"request": {
"$ref": "OrderinvoicesCreateChargeInvoiceRequest"
},
"id": "content.orderinvoices.createchargeinvoice",
"response": {
"$ref": "OrderinvoicesCreateChargeInvoiceResponse"
}
}
}
},
"products": {
"methods": {
"insert": {
"response": {
"$ref": "Product"
},
"scopes": [
"https://www.googleapis.com/auth/content"
],
"description": "Uploads a product to your Merchant Center account. If an item with the same channel, contentLanguage, offerId, and targetCountry already exists, this method updates that entry.",
"flatPath": "content/v2.1/{merchantId}/products",
"parameters": {
"feedId": {
"location": "query",
"format": "uint64",
"type": "string",
"description": "The Content API Supplemental Feed ID."
},
"merchantId": {
"type": "string",
"location": "path",
"description": "The ID of the account that contains the product. This account cannot be a multi-client account.",
"required": true,
"format": "uint64"
}
},
"id": "content.products.insert",
"request": {
"$ref": "Product"
},
"httpMethod": "POST",
"parameterOrder": [
"merchantId"
],
"path": "content/v2.1/{merchantId}/products"
},
"get": {
"httpMethod": "GET",
"id": "content.products.get",
"flatPath": "content/v2.1/{merchantId}/products/{productId}",
"parameterOrder": [
"merchantId",
"productId"
],
"response": {
"$ref": "Product"
},
"parameters": {
"merchantId": {
"required": true,
"format": "uint64",
"location": "path",
"description": "The ID of the account that contains the product. This account cannot be a multi-client account.",
"type": "string"
},
"productId": {
"type": "string",
"description": "The REST ID of the product.",
"location": "path",
"required": true
}
},
"description": "Retrieves a product from your Merchant Center account.",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"path": "content/v2.1/{merchantId}/products/{productId}"
},
"list": {
"description": "Lists the products in your Merchant Center account. The response might contain fewer items than specified by maxResults. Rely on nextPageToken to determine if there are more items to be requested.",
"flatPath": "content/v2.1/{merchantId}/products",
"parameters": {
"maxResults": {
"format": "uint32",
"description": "The maximum number of products to return in the response, used for paging.",
"type": "integer",
"location": "query"
},
"pageToken": {
"location": "query",
"description": "The token returned by the previous request.",
"type": "string"
},
"merchantId": {
"description": "The ID of the account that contains the products. This account cannot be a multi-client account.",
"required": true,
"type": "string",
"format": "uint64",
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/content"
],
"id": "content.products.list",
"parameterOrder": [
"merchantId"
],
"path": "content/v2.1/{merchantId}/products",
"response": {
"$ref": "ProductsListResponse"
},
"httpMethod": "GET"
},
"delete": {
"scopes": [
"https://www.googleapis.com/auth/content"
],
"path": "content/v2.1/{merchantId}/products/{productId}",
"parameters": {
"feedId": {
"type": "string",
"description": "The Content API Supplemental Feed ID.",
"location": "query",
"format": "uint64"
},
"productId": {
"required": true,
"type": "string",
"location": "path",
"description": "The REST ID of the product."
},
"merchantId": {
"description": "The ID of the account that contains the product. This account cannot be a multi-client account.",
"type": "string",
"required": true,
"format": "uint64",
"location": "path"
}
},
"flatPath": "content/v2.1/{merchantId}/products/{productId}",
"httpMethod": "DELETE",
"parameterOrder": [
"merchantId",
"productId"
],
"description": "Deletes a product from your Merchant Center account.",
"id": "content.products.delete"
},
"custombatch": {
"flatPath": "content/v2.1/products/batch",
"path": "content/v2.1/products/batch",
"description": "Retrieves, inserts, and deletes multiple products in a single request.",
"parameterOrder": [],
"response": {
"$ref": "ProductsCustomBatchResponse"
},
"request": {
"$ref": "ProductsCustomBatchRequest"
},
"parameters": {},
"scopes": [
"https://www.googleapis.com/auth/content"
],
"id": "content.products.custombatch",
"httpMethod": "POST"
}
}
},
"repricingrules": {
"methods": {
"get": {
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"parameters": {
"ruleId": {
"location": "path",
"required": true,
"type": "string",
"description": "Required. The id of the rule to retrieve."
},
"merchantId": {
"required": true,
"type": "string",
"location": "path",
"description": "Required. The id of the merchant who owns the repricing rule.",
"format": "int64"
}
},
"parameterOrder": [
"merchantId",
"ruleId"
],
"id": "content.repricingrules.get",
"response": {
"$ref": "RepricingRule"
},
"flatPath": "content/v2.1/{merchantId}/repricingrules/{ruleId}",
"path": "content/v2.1/{merchantId}/repricingrules/{ruleId}",
"description": "Retrieves a repricing rule from your Merchant Center account."
},
"delete": {
"parameterOrder": [
"merchantId",
"ruleId"
],
"flatPath": "content/v2.1/{merchantId}/repricingrules/{ruleId}",
"path": "content/v2.1/{merchantId}/repricingrules/{ruleId}",
"description": "Deletes a repricing rule in your Merchant Center account.",
"parameters": {
"merchantId": {
"format": "int64",
"description": "Required. The id of the merchant who owns the repricing rule.",
"type": "string",
"location": "path",
"required": true
},
"ruleId": {
"required": true,
"location": "path",
"type": "string",
"description": "Required. The id of the rule to Delete."
}
},
"httpMethod": "DELETE",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"id": "content.repricingrules.delete"
},
"patch": {
"response": {
"$ref": "RepricingRule"
},
"parameterOrder": [
"merchantId",
"ruleId"
],
"parameters": {
"merchantId": {
"format": "int64",
"description": "Required. The id of the merchant who owns the repricing rule.",
"location": "path",
"required": true,
"type": "string"
},
"ruleId": {
"required": true,
"location": "path",
"description": "Required. The id of the rule to update.",
"type": "string"
}
},
"request": {
"$ref": "RepricingRule"
},
"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.",
"id": "content.repricingrules.patch",
"path": "content/v2.1/{merchantId}/repricingrules/{ruleId}",
"httpMethod": "PATCH",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"flatPath": "content/v2.1/{merchantId}/repricingrules/{ruleId}"
},
"create": {
"response": {
"$ref": "RepricingRule"
},
"parameterOrder": [
"merchantId"
],
"path": "content/v2.1/{merchantId}/repricingrules",
"flatPath": "content/v2.1/{merchantId}/repricingrules",
"id": "content.repricingrules.create",
"request": {
"$ref": "RepricingRule"
},
"scopes": [
"https://www.googleapis.com/auth/content"
],
"httpMethod": "POST",
"description": "Creates a repricing rule for your Merchant Center account.",
"parameters": {
"ruleId": {
"description": "Required. The id of the rule to create.",
"location": "query",
"type": "string"
},
"merchantId": {
"required": true,
"description": "Required. The id of the merchant who owns the repricing rule.",
"location": "path",
"format": "int64",
"type": "string"
}
}
},
"list": {
"flatPath": "content/v2.1/{merchantId}/repricingrules",
"httpMethod": "GET",
"parameters": {
"pageSize": {
"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.",
"type": "integer",
"format": "int32",
"location": "query"
},
"countryCode": {
"location": "query",
"type": "string",
"description": "CLDR country code (e.g. \"US\"), used as a filter on repricing rules."
},
"pageToken": {
"type": "string",
"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.",
"location": "query"
},
"merchantId": {
"location": "path",
"format": "int64",
"required": true,
"description": "Required. The id of the merchant who owns the repricing rule.",
"type": "string"
},
"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.",
"parameterOrder": [
"merchantId"
],
"path": "content/v2.1/{merchantId}/repricingrules",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"id": "content.repricingrules.list",
"response": {
"$ref": "ListRepricingRulesResponse"
}
}
}
},
"orderreports": {
"methods": {
"listdisbursements": {
"parameters": {
"pageToken": {
"type": "string",
"description": "The token returned by the previous request.",
"location": "query"
},
"disbursementEndDate": {
"type": "string",
"location": "query",
"description": "The last date which disbursements occurred. In ISO 8601 format. Default: current date."
},
"maxResults": {
"location": "query",
"type": "integer",
"format": "uint32",
"description": "The maximum number of disbursements to return in the response, used for paging."
},
"merchantId": {
"description": "The ID of the account that manages the order. This cannot be a multi-client account.",
"location": "path",
"required": true,
"format": "uint64",
"type": "string"
},
"disbursementStartDate": {
"description": "The first date which disbursements occurred. In ISO 8601 format.",
"location": "query",
"type": "string"
}
},
"httpMethod": "GET",
"id": "content.orderreports.listdisbursements",
"parameterOrder": [
"merchantId"
],
"scopes": [
"https://www.googleapis.com/auth/content"
],
"description": "Retrieves a report for disbursements from your Merchant Center account.",
"flatPath": "content/v2.1/{merchantId}/orderreports/disbursements",
"response": {
"$ref": "OrderreportsListDisbursementsResponse"
},
"path": "content/v2.1/{merchantId}/orderreports/disbursements"
},
"listtransactions": {
"parameters": {
"transactionStartDate": {
"description": "The first date in which transaction occurred. In ISO 8601 format.",
"type": "string",
"location": "query"
},
"transactionEndDate": {
"location": "query",
"description": "The last date in which transaction occurred. In ISO 8601 format. Default: current date.",
"type": "string"
},
"pageToken": {
"type": "string",
"location": "query",
"description": "The token returned by the previous request."
},
"disbursementId": {
"description": "The Google-provided ID of the disbursement (found in Wallet).",
"location": "path",
"required": true,
"type": "string"
},
"merchantId": {
"description": "The ID of the account that manages the order. This cannot be a multi-client account.",
"required": true,
"type": "string",
"location": "path",
"format": "uint64"
},
"maxResults": {
"description": "The maximum number of disbursements to return in the response, used for paging.",
"type": "integer",
"location": "query",
"format": "uint32"
}
},
"parameterOrder": [
"merchantId",
"disbursementId"
],
"scopes": [
"https://www.googleapis.com/auth/content"
],
"id": "content.orderreports.listtransactions",
"response": {
"$ref": "OrderreportsListTransactionsResponse"
},
"description": "Retrieves a list of transactions for a disbursement from your Merchant Center account.",
"flatPath": "content/v2.1/{merchantId}/orderreports/disbursements/{disbursementId}/transactions",
"httpMethod": "GET",
"path": "content/v2.1/{merchantId}/orderreports/disbursements/{disbursementId}/transactions"
}
}
},
"datafeedstatuses": {
"methods": {
"list": {
"httpMethod": "GET",
"id": "content.datafeedstatuses.list",
"response": {
"$ref": "DatafeedstatusesListResponse"
},
"flatPath": "content/v2.1/{merchantId}/datafeedstatuses",
"parameterOrder": [
"merchantId"
],
"description": "Lists the statuses of the datafeeds in your Merchant Center account.",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"path": "content/v2.1/{merchantId}/datafeedstatuses",
"parameters": {
"pageToken": {
"location": "query",
"type": "string",
"description": "The token returned by the previous request."
},
"maxResults": {
"format": "uint32",
"type": "integer",
"description": "The maximum number of products to return in the response, used for paging.",
"location": "query"
},
"merchantId": {
"description": "The ID of the account that manages the datafeeds. This account cannot be a multi-client account.",
"required": true,
"type": "string",
"location": "path",
"format": "uint64"
}
}
},
"get": {
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"id": "content.datafeedstatuses.get",
"description": "Retrieves the status of a datafeed from your Merchant Center account.",
"parameters": {
"country": {
"location": "query",
"description": "The country for which to get the datafeed status. If this parameter is provided then language must also be provided. Note that this parameter is required for feeds targeting multiple countries and languages, since a feed may have a different status for each target.",
"type": "string"
},
"datafeedId": {
"type": "string",
"description": "The ID of the datafeed.",
"location": "path",
"format": "uint64",
"required": true
},
"language": {
"location": "query",
"description": "The language for which to get the datafeed status. If this parameter is provided then country must also be provided. Note that this parameter is required for feeds targeting multiple countries and languages, since a feed may have a different status for each target.",
"type": "string"
},
"merchantId": {
"format": "uint64",
"description": "The ID of the account that manages the datafeed. This account cannot be a multi-client account.",
"required": true,
"type": "string",
"location": "path"
}
},
"response": {
"$ref": "DatafeedStatus"
},
"path": "content/v2.1/{merchantId}/datafeedstatuses/{datafeedId}",
"flatPath": "content/v2.1/{merchantId}/datafeedstatuses/{datafeedId}",
"parameterOrder": [
"merchantId",
"datafeedId"
]
},
"custombatch": {
"httpMethod": "POST",
"parameterOrder": [],
"path": "content/v2.1/datafeedstatuses/batch",
"id": "content.datafeedstatuses.custombatch",
"parameters": {},
"scopes": [
"https://www.googleapis.com/auth/content"
],
"description": "Gets multiple Merchant Center datafeed statuses in a single request.",
"flatPath": "content/v2.1/datafeedstatuses/batch",
"request": {
"$ref": "DatafeedstatusesCustomBatchRequest"
},
"response": {
"$ref": "DatafeedstatusesCustomBatchResponse"
}
}
}
},
"productstatuses": {
"methods": {
"custombatch": {
"request": {
"$ref": "ProductstatusesCustomBatchRequest"
},
"id": "content.productstatuses.custombatch",
"response": {
"$ref": "ProductstatusesCustomBatchResponse"
},
"parameterOrder": [],
"description": "Gets the statuses of multiple products in a single request.",
"parameters": {},
"path": "content/v2.1/productstatuses/batch",
"flatPath": "content/v2.1/productstatuses/batch",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"httpMethod": "POST"
},
"list": {
"parameters": {
"merchantId": {
"format": "uint64",
"type": "string",
"description": "The ID of the account that contains the products. This account cannot be a multi-client account.",
"required": true,
"location": "path"
},
"pageToken": {
"type": "string",
"description": "The token returned by the previous request.",
"location": "query"
},
"destinations": {
"type": "string",
"location": "query",
"repeated": true,
"description": "If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination."
},
"maxResults": {
"location": "query",
"format": "uint32",
"type": "integer",
"description": "The maximum number of product statuses to return in the response, used for paging."
}
},
"flatPath": "content/v2.1/{merchantId}/productstatuses",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"path": "content/v2.1/{merchantId}/productstatuses",
"description": "Lists the statuses of the products in your Merchant Center account.",
"httpMethod": "GET",
"id": "content.productstatuses.list",
"response": {
"$ref": "ProductstatusesListResponse"
},
"parameterOrder": [
"merchantId"
]
},
"get": {
"httpMethod": "GET",
"parameterOrder": [
"merchantId",
"productId"
],
"description": "Gets the status of a product from your Merchant Center account.",
"parameters": {
"productId": {
"type": "string",
"description": "The REST ID of the product.",
"required": true,
"location": "path"
},
"merchantId": {
"type": "string",
"location": "path",
"format": "uint64",
"description": "The ID of the account that contains the product. This account cannot be a multi-client account.",
"required": true
},
"destinations": {
"type": "string",
"description": "If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination.",
"repeated": true,
"location": "query"
}
},
"id": "content.productstatuses.get",
"flatPath": "content/v2.1/{merchantId}/productstatuses/{productId}",
"response": {
"$ref": "ProductStatus"
},
"path": "content/v2.1/{merchantId}/productstatuses/{productId}",
"scopes": [
"https://www.googleapis.com/auth/content"
]
}
}
},
"orderreturns": {
"methods": {
"createorderreturn": {
"flatPath": "content/v2.1/{merchantId}/orderreturns/createOrderReturn",
"parameters": {
"merchantId": {
"format": "uint64",
"required": true,
"type": "string",
"location": "path",
"description": "The ID of the account that manages the order. This cannot be a multi-client account."
}
},
"description": "Create return in your Merchant Center account.",
"response": {
"$ref": "OrderreturnsCreateOrderReturnResponse"
},
"httpMethod": "POST",
"request": {
"$ref": "OrderreturnsCreateOrderReturnRequest"
},
"parameterOrder": [
"merchantId"
],
"scopes": [
"https://www.googleapis.com/auth/content"
],
"path": "content/v2.1/{merchantId}/orderreturns/createOrderReturn",
"id": "content.orderreturns.createorderreturn"
},
"acknowledge": {
"id": "content.orderreturns.acknowledge",
"parameterOrder": [
"merchantId",
"returnId"
],
"description": "Acks an order return in your Merchant Center account.",
"parameters": {
"merchantId": {
"location": "path",
"required": true,
"format": "uint64",
"description": "The ID of the account that manages the order. This cannot be a multi-client account.",
"type": "string"
},
"returnId": {
"required": true,
"type": "string",
"location": "path",
"description": "The ID of the return."
}
},
"path": "content/v2.1/{merchantId}/orderreturns/{returnId}/acknowledge",
"httpMethod": "POST",
"request": {
"$ref": "OrderreturnsAcknowledgeRequest"
},
"scopes": [
"https://www.googleapis.com/auth/content"
],
"flatPath": "content/v2.1/{merchantId}/orderreturns/{returnId}/acknowledge",
"response": {
"$ref": "OrderreturnsAcknowledgeResponse"
}
},
"process": {
"response": {
"$ref": "OrderreturnsProcessResponse"
},
"httpMethod": "POST",
"request": {
"$ref": "OrderreturnsProcessRequest"
},
"parameters": {
"returnId": {
"type": "string",
"location": "path",
"required": true,
"description": "The ID of the return."
},
"merchantId": {
"format": "uint64",
"required": true,
"type": "string",
"location": "path",
"description": "The ID of the account that manages the order. This cannot be a multi-client account."
}
},
"flatPath": "content/v2.1/{merchantId}/orderreturns/{returnId}/process",
"parameterOrder": [
"merchantId",
"returnId"
],
"path": "content/v2.1/{merchantId}/orderreturns/{returnId}/process",
"id": "content.orderreturns.process",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"description": "Processes return in your Merchant Center account."
},
"list": {
"id": "content.orderreturns.list",
"parameterOrder": [
"merchantId"
],
"scopes": [
"https://www.googleapis.com/auth/content"
],
"path": "content/v2.1/{merchantId}/orderreturns",
"response": {
"$ref": "OrderreturnsListResponse"
},
"description": "Lists order returns in your Merchant Center account.",
"parameters": {
"createdEndDate": {
"location": "query",
"type": "string",
"description": "Obtains order returns created before this date (inclusively), in ISO 8601 format."
},
"shipmentStatus": {
"location": "query",
"repeated": true,
"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"
],
"type": "string",
"enumDescriptions": [
"",
"",
""
]
},
"merchantId": {
"description": "The ID of the account that manages the order. This cannot be a multi-client account.",
"type": "string",
"required": true,
"format": "uint64",
"location": "path"
},
"pageToken": {
"type": "string",
"location": "query",
"description": "The token returned by the previous request."
},
"shipmentTrackingNumbers": {
"repeated": true,
"type": "string",
"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"
},
"acknowledged": {
"location": "query",
"type": "boolean",
"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. "
},
"googleOrderIds": {
"type": "string",
"repeated": true,
"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.",
"location": "query"
},
"shipmentTypes": {
"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.",
"type": "string",
"enumDescriptions": [
"",
"",
""
],
"enum": [
"BY_MAIL",
"RETURNLESS",
"CONTACT_CUSTOMER_SUPPORT"
],
"location": "query",
"repeated": true
},
"orderBy": {
"location": "query",
"description": "Return the results in the specified order.",
"type": "string",
"enumDescriptions": [
"",
""
],
"enum": [
"RETURN_CREATION_TIME_DESC",
"RETURN_CREATION_TIME_ASC"
]
},
"shipmentStates": {
"location": "query",
"type": "string",
"enum": [
"NEW",
"SHIPPED",
"COMPLETED",
"UNDELIVERABLE",
"PENDING"
],
"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.",
"repeated": true,
"enumDescriptions": [
"",
"",
"",
"",
""
]
},
"createdStartDate": {
"description": "Obtains order returns created after this date (inclusively), in ISO 8601 format.",
"type": "string",
"location": "query"
},
"maxResults": {
"type": "integer",
"location": "query",
"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"
}
},
"flatPath": "content/v2.1/{merchantId}/orderreturns",
"httpMethod": "GET"
},
"get": {
"parameterOrder": [
"merchantId",
"returnId"
],
"parameters": {
"merchantId": {
"format": "uint64",
"type": "string",
"description": "The ID of the account that manages the order. This cannot be a multi-client account.",
"required": true,
"location": "path"
},
"returnId": {
"type": "string",
"required": true,
"location": "path",
"description": "Merchant order return ID generated by Google."
}
},
"path": "content/v2.1/{merchantId}/orderreturns/{returnId}",
"description": "Retrieves an order return from your Merchant Center account.",
"httpMethod": "GET",
"flatPath": "content/v2.1/{merchantId}/orderreturns/{returnId}",
"id": "content.orderreturns.get",
"response": {
"$ref": "MerchantOrderReturn"
},
"scopes": [
"https://www.googleapis.com/auth/content"
]
}
}
},
"pubsubnotificationsettings": {
"methods": {
"get": {
"id": "content.pubsubnotificationsettings.get",
"parameterOrder": [
"merchantId"
],
"response": {
"$ref": "PubsubNotificationSettings"
},
"description": "Retrieves a Merchant Center account's pubsub notification settings.",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"parameters": {
"merchantId": {
"location": "path",
"description": "The ID of the account for which to get pubsub notification settings.",
"format": "uint64",
"required": true,
"type": "string"
}
},
"flatPath": "content/v2.1/{merchantId}/pubsubnotificationsettings",
"path": "content/v2.1/{merchantId}/pubsubnotificationsettings",
"httpMethod": "GET"
},
"update": {
"scopes": [
"https://www.googleapis.com/auth/content"
],
"request": {
"$ref": "PubsubNotificationSettings"
},
"flatPath": "content/v2.1/{merchantId}/pubsubnotificationsettings",
"id": "content.pubsubnotificationsettings.update",
"path": "content/v2.1/{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.",
"httpMethod": "PUT",
"response": {
"$ref": "PubsubNotificationSettings"
},
"parameters": {
"merchantId": {
"location": "path",
"description": "The ID of the account.",
"format": "uint64",
"required": true,
"type": "string"
}
},
"parameterOrder": [
"merchantId"
]
}
}
},
"liasettings": {
"methods": {
"getaccessiblegmbaccounts": {
"response": {
"$ref": "LiasettingsGetAccessibleGmbAccountsResponse"
},
"httpMethod": "GET",
"parameters": {
"accountId": {
"location": "path",
"description": "The ID of the account for which to retrieve accessible Google My Business accounts.",
"type": "string",
"required": true,
"format": "uint64"
},
"merchantId": {
"location": "path",
"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"
}
},
"id": "content.liasettings.getaccessiblegmbaccounts",
"parameterOrder": [
"merchantId",
"accountId"
],
"path": "content/v2.1/{merchantId}/liasettings/{accountId}/accessiblegmbaccounts",
"description": "Retrieves the list of accessible Google My Business accounts.",
"flatPath": "content/v2.1/{merchantId}/liasettings/{accountId}/accessiblegmbaccounts",
"scopes": [
"https://www.googleapis.com/auth/content"
]
},
"requestgmbaccess": {
"parameterOrder": [
"merchantId",
"accountId",
"gmbEmail"
],
"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,
"type": "string",
"location": "path",
"format": "uint64"
},
"accountId": {
"required": true,
"description": "The ID of the account for which GMB access is requested.",
"type": "string",
"format": "uint64",
"location": "path"
},
"gmbEmail": {
"type": "string",
"required": true,
"location": "query",
"description": "The email of the Google My Business account."
}
},
"id": "content.liasettings.requestgmbaccess",
"path": "content/v2.1/{merchantId}/liasettings/{accountId}/requestgmbaccess",
"flatPath": "content/v2.1/{merchantId}/liasettings/{accountId}/requestgmbaccess",
"response": {
"$ref": "LiasettingsRequestGmbAccessResponse"
},
"description": "Requests access to a specified Google My Business account.",
"httpMethod": "POST"
},
"requestinventoryverification": {
"httpMethod": "POST",
"response": {
"$ref": "LiasettingsRequestInventoryVerificationResponse"
},
"path": "content/v2.1/{merchantId}/liasettings/{accountId}/requestinventoryverification/{country}",
"parameterOrder": [
"merchantId",
"accountId",
"country"
],
"id": "content.liasettings.requestinventoryverification",
"parameters": {
"merchantId": {
"format": "uint64",
"required": true,
"type": "string",
"description": "The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.",
"location": "path"
},
"country": {
"description": "The country for which inventory validation is requested.",
"type": "string",
"required": true,
"location": "path"
},
"accountId": {
"required": true,
"type": "string",
"location": "path",
"description": "The ID of the account that manages the order. This cannot be a multi-client account.",
"format": "uint64"
}
},
"description": "Requests inventory validation for the specified country.",
"flatPath": "content/v2.1/{merchantId}/liasettings/{accountId}/requestinventoryverification/{country}",
"scopes": [
"https://www.googleapis.com/auth/content"
]
},
"setinventoryverificationcontact": {
"description": "Sets the inventory verification contract for the specified country.",
"parameterOrder": [
"merchantId",
"accountId",
"country",
"language",
"contactName",
"contactEmail"
],
"flatPath": "content/v2.1/{merchantId}/liasettings/{accountId}/setinventoryverificationcontact",
"response": {
"$ref": "LiasettingsSetInventoryVerificationContactResponse"
},
"path": "content/v2.1/{merchantId}/liasettings/{accountId}/setinventoryverificationcontact",
"parameters": {
"country": {
"location": "query",
"required": true,
"type": "string",
"description": "The country for which inventory verification is requested."
},
"language": {
"location": "query",
"type": "string",
"description": "The language for which inventory verification is requested.",
"required": true
},
"contactName": {
"type": "string",
"required": true,
"location": "query",
"description": "The name of the inventory verification contact."
},
"contactEmail": {
"location": "query",
"description": "The email of the inventory verification contact.",
"type": "string",
"required": true
},
"accountId": {
"type": "string",
"required": true,
"description": "The ID of the account that manages the order. This cannot be a multi-client account.",
"location": "path",
"format": "uint64"
},
"merchantId": {
"location": "path",
"type": "string",
"required": true,
"description": "The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.",
"format": "uint64"
}
},
"scopes": [
"https://www.googleapis.com/auth/content"
],
"httpMethod": "POST",
"id": "content.liasettings.setinventoryverificationcontact"
},
"listposdataproviders": {
"httpMethod": "GET",
"response": {
"$ref": "LiasettingsListPosDataProvidersResponse"
},
"parameterOrder": [],
"flatPath": "content/v2.1/liasettings/posdataproviders",
"description": "Retrieves the list of POS data providers that have active settings for the all eiligible countries.",
"path": "content/v2.1/liasettings/posdataproviders",
"parameters": {},
"scopes": [
"https://www.googleapis.com/auth/content"
],
"id": "content.liasettings.listposdataproviders"
},
"custombatch": {
"parameters": {},
"scopes": [
"https://www.googleapis.com/auth/content"
],
"description": "Retrieves and/or updates the LIA settings of multiple accounts in a single request.",
"response": {
"$ref": "LiasettingsCustomBatchResponse"
},
"path": "content/v2.1/liasettings/batch",
"request": {
"$ref": "LiasettingsCustomBatchRequest"
},
"parameterOrder": [],
"flatPath": "content/v2.1/liasettings/batch",
"id": "content.liasettings.custombatch",
"httpMethod": "POST"
},
"update": {
"request": {
"$ref": "LiaSettings"
},
"parameterOrder": [
"merchantId",
"accountId"
],
"scopes": [
"https://www.googleapis.com/auth/content"
],
"path": "content/v2.1/{merchantId}/liasettings/{accountId}",
"id": "content.liasettings.update",
"description": "Updates the LIA settings of the account. Any fields that are not provided are deleted from the resource.",
"response": {
"$ref": "LiaSettings"
},
"flatPath": "content/v2.1/{merchantId}/liasettings/{accountId}",
"httpMethod": "PUT",
"parameters": {
"merchantId": {
"format": "uint64",
"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
},
"accountId": {
"location": "path",
"type": "string",
"required": true,
"format": "uint64",
"description": "The ID of the account for which to get or update LIA settings."
}
}
},
"list": {
"response": {
"$ref": "LiasettingsListResponse"
},
"description": "Lists the LIA settings of the sub-accounts in your Merchant Center account.",
"httpMethod": "GET",
"id": "content.liasettings.list",
"flatPath": "content/v2.1/{merchantId}/liasettings",
"parameterOrder": [
"merchantId"
],
"parameters": {
"merchantId": {
"description": "The ID of the managing account. This must be a multi-client account.",
"location": "path",
"format": "uint64",
"required": true,
"type": "string"
},
"pageToken": {
"description": "The token returned by the previous request.",
"location": "query",
"type": "string"
},
"maxResults": {
"description": "The maximum number of LIA settings to return in the response, used for paging.",
"format": "uint32",
"type": "integer",
"location": "query"
}
},
"path": "content/v2.1/{merchantId}/liasettings",
"scopes": [
"https://www.googleapis.com/auth/content"
]
},
"get": {
"httpMethod": "GET",
"response": {
"$ref": "LiaSettings"
},
"parameterOrder": [
"merchantId",
"accountId"
],
"description": "Retrieves the LIA settings of the account.",
"path": "content/v2.1/{merchantId}/liasettings/{accountId}",
"id": "content.liasettings.get",
"flatPath": "content/v2.1/{merchantId}/liasettings/{accountId}",
"parameters": {
"merchantId": {
"location": "path",
"format": "uint64",
"type": "string",
"description": "The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.",
"required": true
},
"accountId": {
"description": "The ID of the account for which to get or update LIA settings.",
"type": "string",
"required": true,
"format": "uint64",
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/content"
]
},
"setposdataprovider": {
"scopes": [
"https://www.googleapis.com/auth/content"
],
"path": "content/v2.1/{merchantId}/liasettings/{accountId}/setposdataprovider",
"flatPath": "content/v2.1/{merchantId}/liasettings/{accountId}/setposdataprovider",
"id": "content.liasettings.setposdataprovider",
"httpMethod": "POST",
"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",
"required": true,
"format": "uint64"
},
"accountId": {
"location": "path",
"required": true,
"format": "uint64",
"type": "string",
"description": "The ID of the account for which to retrieve accessible Google My Business accounts."
},
"country": {
"type": "string",
"required": true,
"description": "The country for which the POS data provider is selected.",
"location": "query"
},
"posDataProviderId": {
"location": "query",
"type": "string",
"description": "The ID of POS data provider.",
"format": "uint64"
},
"posExternalAccountId": {
"type": "string",
"description": "The account ID by which this merchant is known to the POS data provider.",
"location": "query"
}
},
"parameterOrder": [
"merchantId",
"accountId",
"country"
],
"response": {
"$ref": "LiasettingsSetPosDataProviderResponse"
},
"description": "Sets the POS data provider for the specified country."
}
}
},
"shippingsettings": {
"methods": {
"list": {
"response": {
"$ref": "ShippingsettingsListResponse"
},
"path": "content/v2.1/{merchantId}/shippingsettings",
"flatPath": "content/v2.1/{merchantId}/shippingsettings",
"id": "content.shippingsettings.list",
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"parameters": {
"pageToken": {
"description": "The token returned by the previous request.",
"type": "string",
"location": "query"
},
"merchantId": {
"type": "string",
"location": "path",
"format": "uint64",
"description": "The ID of the managing account. This must be a multi-client account.",
"required": true
},
"maxResults": {
"description": "The maximum number of shipping settings to return in the response, used for paging.",
"format": "uint32",
"type": "integer",
"location": "query"
}
},
"description": "Lists the shipping settings of the sub-accounts in your Merchant Center account.",
"parameterOrder": [
"merchantId"
]
},
"getsupportedholidays": {
"response": {
"$ref": "ShippingsettingsGetSupportedHolidaysResponse"
},
"id": "content.shippingsettings.getsupportedholidays",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"description": "Retrieves supported holidays for an account.",
"path": "content/v2.1/{merchantId}/supportedHolidays",
"parameters": {
"merchantId": {
"description": "The ID of the account for which to retrieve the supported holidays.",
"required": true,
"format": "uint64",
"type": "string",
"location": "path"
}
},
"parameterOrder": [
"merchantId"
],
"httpMethod": "GET",
"flatPath": "content/v2.1/{merchantId}/supportedHolidays"
},
"getsupportedcarriers": {
"parameters": {
"merchantId": {
"description": "The ID of the account for which to retrieve the supported carriers.",
"location": "path",
"required": true,
"format": "uint64",
"type": "string"
}
},
"flatPath": "content/v2.1/{merchantId}/supportedCarriers",
"response": {
"$ref": "ShippingsettingsGetSupportedCarriersResponse"
},
"scopes": [
"https://www.googleapis.com/auth/content"
],
"parameterOrder": [
"merchantId"
],
"description": "Retrieves supported carriers and carrier services for an account.",
"id": "content.shippingsettings.getsupportedcarriers",
"httpMethod": "GET",
"path": "content/v2.1/{merchantId}/supportedCarriers"
},
"update": {
"path": "content/v2.1/{merchantId}/shippingsettings/{accountId}",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"description": "Updates the shipping settings of the account. Any fields that are not provided are deleted from the resource.",
"parameterOrder": [
"merchantId",
"accountId"
],
"id": "content.shippingsettings.update",
"response": {
"$ref": "ShippingSettings"
},
"flatPath": "content/v2.1/{merchantId}/shippingsettings/{accountId}",
"request": {
"$ref": "ShippingSettings"
},
"parameters": {
"merchantId": {
"format": "uint64",
"location": "path",
"description": "The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.",
"type": "string",
"required": true
},
"accountId": {
"location": "path",
"description": "The ID of the account for which to get/update shipping settings.",
"required": true,
"format": "uint64",
"type": "string"
}
},
"httpMethod": "PUT"
},
"getsupportedpickupservices": {
"flatPath": "content/v2.1/{merchantId}/supportedPickupServices",
"response": {
"$ref": "ShippingsettingsGetSupportedPickupServicesResponse"
},
"parameterOrder": [
"merchantId"
],
"scopes": [
"https://www.googleapis.com/auth/content"
],
"id": "content.shippingsettings.getsupportedpickupservices",
"httpMethod": "GET",
"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.",
"format": "uint64",
"location": "path"
}
},
"path": "content/v2.1/{merchantId}/supportedPickupServices"
},
"custombatch": {
"parameters": {},
"parameterOrder": [],
"flatPath": "content/v2.1/shippingsettings/batch",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"id": "content.shippingsettings.custombatch",
"request": {
"$ref": "ShippingsettingsCustomBatchRequest"
},
"path": "content/v2.1/shippingsettings/batch",
"httpMethod": "POST",
"response": {
"$ref": "ShippingsettingsCustomBatchResponse"
},
"description": "Retrieves and updates the shipping settings of multiple accounts in a single request."
},
"get": {
"description": "Retrieves the shipping settings of the account.",
"flatPath": "content/v2.1/{merchantId}/shippingsettings/{accountId}",
"parameters": {
"accountId": {
"location": "path",
"description": "The ID of the account for which to get/update shipping settings.",
"format": "uint64",
"required": true,
"type": "string"
},
"merchantId": {
"required": true,
"format": "uint64",
"location": "path",
"description": "The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.",
"type": "string"
}
},
"path": "content/v2.1/{merchantId}/shippingsettings/{accountId}",
"httpMethod": "GET",
"id": "content.shippingsettings.get",
"response": {
"$ref": "ShippingSettings"
},
"parameterOrder": [
"merchantId",
"accountId"
],
"scopes": [
"https://www.googleapis.com/auth/content"
]
}
}
},
"datafeeds": {
"methods": {
"insert": {
"description": "Registers a datafeed configuration with your Merchant Center account.",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"httpMethod": "POST",
"request": {
"$ref": "Datafeed"
},
"parameterOrder": [
"merchantId"
],
"id": "content.datafeeds.insert",
"parameters": {
"merchantId": {
"description": "The ID of the account that manages the datafeed. This account cannot be a multi-client account.",
"location": "path",
"type": "string",
"required": true,
"format": "uint64"
}
},
"path": "content/v2.1/{merchantId}/datafeeds",
"response": {
"$ref": "Datafeed"
},
"flatPath": "content/v2.1/{merchantId}/datafeeds"
},
"get": {
"description": "Retrieves a datafeed configuration from your Merchant Center account.",
"id": "content.datafeeds.get",
"path": "content/v2.1/{merchantId}/datafeeds/{datafeedId}",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"parameters": {
"datafeedId": {
"type": "string",
"required": true,
"description": "The ID of the datafeed.",
"location": "path",
"format": "uint64"
},
"merchantId": {
"format": "uint64",
"required": true,
"description": "The ID of the account that manages the datafeed. This account cannot be a multi-client account.",
"type": "string",
"location": "path"
}
},
"flatPath": "content/v2.1/{merchantId}/datafeeds/{datafeedId}",
"httpMethod": "GET",
"response": {
"$ref": "Datafeed"
},
"parameterOrder": [
"merchantId",
"datafeedId"
]
},
"delete": {
"parameters": {
"merchantId": {
"description": "The ID of the account that manages the datafeed. This account cannot be a multi-client account.",
"required": true,
"type": "string",
"location": "path",
"format": "uint64"
},
"datafeedId": {
"type": "string",
"format": "uint64",
"required": true,
"location": "path",
"description": "The ID of the datafeed."
}
},
"id": "content.datafeeds.delete",
"flatPath": "content/v2.1/{merchantId}/datafeeds/{datafeedId}",
"httpMethod": "DELETE",
"path": "content/v2.1/{merchantId}/datafeeds/{datafeedId}",
"parameterOrder": [
"merchantId",
"datafeedId"
],
"description": "Deletes a datafeed configuration from your Merchant Center account.",
"scopes": [
"https://www.googleapis.com/auth/content"
]
},
"list": {
"description": "Lists the configurations for datafeeds in your Merchant Center account.",
"response": {
"$ref": "DatafeedsListResponse"
},
"flatPath": "content/v2.1/{merchantId}/datafeeds",
"httpMethod": "GET",
"path": "content/v2.1/{merchantId}/datafeeds",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"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": {
"location": "path",
"type": "string",
"format": "uint64",
"description": "The ID of the account that manages the datafeeds. This account cannot be a multi-client account.",
"required": true
}
},
"parameterOrder": [
"merchantId"
],
"id": "content.datafeeds.list"
},
"fetchnow": {
"response": {
"$ref": "DatafeedsFetchNowResponse"
},
"scopes": [
"https://www.googleapis.com/auth/content"
],
"flatPath": "content/v2.1/{merchantId}/datafeeds/{datafeedId}/fetchNow",
"parameters": {
"datafeedId": {
"description": "The ID of the datafeed to be fetched.",
"format": "uint64",
"location": "path",
"type": "string",
"required": true
},
"merchantId": {
"type": "string",
"required": true,
"format": "uint64",
"location": "path",
"description": "The ID of the account that manages the datafeed. This account cannot be a multi-client account."
}
},
"id": "content.datafeeds.fetchnow",
"description": "Invokes a fetch for the datafeed in your Merchant Center account. If you need to call this method more than once per day, we recommend you use the Products service to update your product data.",
"path": "content/v2.1/{merchantId}/datafeeds/{datafeedId}/fetchNow",
"httpMethod": "POST",
"parameterOrder": [
"merchantId",
"datafeedId"
]
},
"custombatch": {
"response": {
"$ref": "DatafeedsCustomBatchResponse"
},
"parameters": {},
"scopes": [
"https://www.googleapis.com/auth/content"
],
"path": "content/v2.1/datafeeds/batch",
"httpMethod": "POST",
"description": "Deletes, fetches, gets, inserts and updates multiple datafeeds in a single request.",
"parameterOrder": [],
"flatPath": "content/v2.1/datafeeds/batch",
"id": "content.datafeeds.custombatch",
"request": {
"$ref": "DatafeedsCustomBatchRequest"
}
},
"update": {
"httpMethod": "PUT",
"parameterOrder": [
"merchantId",
"datafeedId"
],
"id": "content.datafeeds.update",
"description": "Updates a datafeed configuration of your Merchant Center account. Any fields that are not provided are deleted from the resource.",
"parameters": {
"merchantId": {
"description": "The ID of the account that manages the datafeed. This account cannot be a multi-client account.",
"location": "path",
"required": true,
"format": "uint64",
"type": "string"
},
"datafeedId": {
"location": "path",
"format": "uint64",
"required": true,
"type": "string",
"description": "The ID of the datafeed."
}
},
"request": {
"$ref": "Datafeed"
},
"scopes": [
"https://www.googleapis.com/auth/content"
],
"flatPath": "content/v2.1/{merchantId}/datafeeds/{datafeedId}",
"path": "content/v2.1/{merchantId}/datafeeds/{datafeedId}",
"response": {
"$ref": "Datafeed"
}
}
}
},
"ordertrackingsignals": {
"methods": {
"create": {
"response": {
"$ref": "OrderTrackingSignal"
},
"parameterOrder": [
"merchantId"
],
"parameters": {
"merchantId": {
"location": "path",
"type": "string",
"format": "int64",
"description": "The ID of the merchant for which the order signal is created.",
"required": true
}
},
"id": "content.ordertrackingsignals.create",
"flatPath": "content/v2.1/{merchantId}/ordertrackingsignals",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"httpMethod": "POST",
"request": {
"$ref": "OrderTrackingSignal"
},
"path": "content/v2.1/{merchantId}/ordertrackingsignals",
"description": "Creates new order tracking signal."
}
}
},
"accounttax": {
"methods": {
"update": {
"description": "Updates the tax settings of the account. Any fields that are not provided are deleted from the resource.",
"parameters": {
"accountId": {
"description": "The ID of the account for which to get/update account tax settings.",
"format": "uint64",
"location": "path",
"required": true,
"type": "string"
},
"merchantId": {
"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",
"type": "string",
"required": true
}
},
"path": "content/v2.1/{merchantId}/accounttax/{accountId}",
"response": {
"$ref": "AccountTax"
},
"parameterOrder": [
"merchantId",
"accountId"
],
"flatPath": "content/v2.1/{merchantId}/accounttax/{accountId}",
"httpMethod": "PUT",
"request": {
"$ref": "AccountTax"
},
"id": "content.accounttax.update",
"scopes": [
"https://www.googleapis.com/auth/content"
]
},
"custombatch": {
"httpMethod": "POST",
"response": {
"$ref": "AccounttaxCustomBatchResponse"
},
"id": "content.accounttax.custombatch",
"parameters": {},
"flatPath": "content/v2.1/accounttax/batch",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"path": "content/v2.1/accounttax/batch",
"request": {
"$ref": "AccounttaxCustomBatchRequest"
},
"description": "Retrieves and updates tax settings of multiple accounts in a single request.",
"parameterOrder": []
},
"get": {
"response": {
"$ref": "AccountTax"
},
"description": "Retrieves the tax settings of the account.",
"parameterOrder": [
"merchantId",
"accountId"
],
"path": "content/v2.1/{merchantId}/accounttax/{accountId}",
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"parameters": {
"merchantId": {
"location": "path",
"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."
},
"accountId": {
"required": true,
"type": "string",
"format": "uint64",
"location": "path",
"description": "The ID of the account for which to get/update account tax settings."
}
},
"id": "content.accounttax.get",
"flatPath": "content/v2.1/{merchantId}/accounttax/{accountId}"
},
"list": {
"path": "content/v2.1/{merchantId}/accounttax",
"parameters": {
"pageToken": {
"type": "string",
"description": "The token returned by the previous request.",
"location": "query"
},
"merchantId": {
"description": "The ID of the managing account. This must be a multi-client account.",
"format": "uint64",
"type": "string",
"location": "path",
"required": true
},
"maxResults": {
"location": "query",
"description": "The maximum number of tax settings to return in the response, used for paging.",
"type": "integer",
"format": "uint32"
}
},
"parameterOrder": [
"merchantId"
],
"response": {
"$ref": "AccounttaxListResponse"
},
"scopes": [
"https://www.googleapis.com/auth/content"
],
"id": "content.accounttax.list",
"description": "Lists the tax settings of the sub-accounts in your Merchant Center account.",
"httpMethod": "GET",
"flatPath": "content/v2.1/{merchantId}/accounttax"
}
}
},
"accountstatuses": {
"methods": {
"list": {
"path": "content/v2.1/{merchantId}/accountstatuses",
"parameters": {
"pageToken": {
"description": "The token returned by the previous request.",
"type": "string",
"location": "query"
},
"maxResults": {
"type": "integer",
"location": "query",
"description": "The maximum number of account statuses to return in the response, used for paging.",
"format": "uint32"
},
"merchantId": {
"format": "uint64",
"description": "The ID of the managing account. This must be a multi-client account.",
"type": "string",
"location": "path",
"required": true
},
"destinations": {
"location": "query",
"type": "string",
"repeated": true,
"description": "If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination."
}
},
"description": "Lists the statuses of the sub-accounts in your Merchant Center account.",
"flatPath": "content/v2.1/{merchantId}/accountstatuses",
"parameterOrder": [
"merchantId"
],
"httpMethod": "GET",
"response": {
"$ref": "AccountstatusesListResponse"
},
"scopes": [
"https://www.googleapis.com/auth/content"
],
"id": "content.accountstatuses.list"
},
"get": {
"parameters": {
"accountId": {
"type": "string",
"required": true,
"description": "The ID of the account.",
"format": "uint64",
"location": "path"
},
"merchantId": {
"required": true,
"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.",
"type": "string",
"location": "path"
},
"destinations": {
"location": "query",
"description": "If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination.",
"type": "string",
"repeated": true
}
},
"httpMethod": "GET",
"flatPath": "content/v2.1/{merchantId}/accountstatuses/{accountId}",
"path": "content/v2.1/{merchantId}/accountstatuses/{accountId}",
"description": "Retrieves the status of a Merchant Center account. No itemLevelIssues are returned for multi-client accounts.",
"parameterOrder": [
"merchantId",
"accountId"
],
"response": {
"$ref": "AccountStatus"
},
"scopes": [
"https://www.googleapis.com/auth/content"
],
"id": "content.accountstatuses.get"
},
"custombatch": {
"request": {
"$ref": "AccountstatusesCustomBatchRequest"
},
"id": "content.accountstatuses.custombatch",
"httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"flatPath": "content/v2.1/accountstatuses/batch",
"response": {
"$ref": "AccountstatusesCustomBatchResponse"
},
"parameterOrder": [],
"path": "content/v2.1/accountstatuses/batch",
"parameters": {},
"description": "Retrieves multiple Merchant Center account statuses in a single request."
}
}
},
"settlementtransactions": {
"methods": {
"list": {
"parameters": {
"settlementId": {
"type": "string",
"description": "The Google-provided ID of the settlement.",
"required": true,
"location": "path"
},
"pageToken": {
"location": "query",
"description": "The token returned by the previous request.",
"type": "string"
},
"transactionIds": {
"description": "The list of transactions to return. If not set, all transactions will be returned.",
"repeated": true,
"type": "string",
"location": "query"
},
"merchantId": {
"required": true,
"description": "The Merchant Center account to list transactions for.",
"type": "string",
"location": "path",
"format": "uint64"
},
"maxResults": {
"format": "uint32",
"location": "query",
"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.",
"type": "integer"
}
},
"flatPath": "content/v2.1/{merchantId}/settlementreports/{settlementId}/transactions",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"parameterOrder": [
"merchantId",
"settlementId"
],
"response": {
"$ref": "SettlementtransactionsListResponse"
},
"path": "content/v2.1/{merchantId}/settlementreports/{settlementId}/transactions",
"description": "Retrieves a list of transactions for the settlement.",
"id": "content.settlementtransactions.list",
"httpMethod": "GET"
}
}
},
"settlementreports": {
"methods": {
"list": {
"path": "content/v2.1/{merchantId}/settlementreports",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"id": "content.settlementreports.list",
"flatPath": "content/v2.1/{merchantId}/settlementreports",
"httpMethod": "GET",
"parameterOrder": [
"merchantId"
],
"description": "Retrieves a list of settlement reports from your Merchant Center account.",
"response": {
"$ref": "SettlementreportsListResponse"
},
"parameters": {
"merchantId": {
"location": "path",
"format": "uint64",
"required": true,
"description": "The Merchant Center account to list settlements for.",
"type": "string"
},
"maxResults": {
"type": "integer",
"format": "uint32",
"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.",
"location": "query"
},
"pageToken": {
"description": "The token returned by the previous request.",
"location": "query",
"type": "string"
},
"transferEndDate": {
"type": "string",
"description": "Obtains settlements which have transactions before this date (inclusively), in ISO 8601 format.",
"location": "query"
},
"transferStartDate": {
"type": "string",
"location": "query",
"description": "Obtains settlements which have transactions after this date (inclusively), in ISO 8601 format."
}
}
},
"get": {
"parameters": {
"merchantId": {
"format": "uint64",
"description": "The Merchant Center account of the settlement report.",
"type": "string",
"required": true,
"location": "path"
},
"settlementId": {
"type": "string",
"required": true,
"description": "The Google-provided ID of the settlement.",
"location": "path"
}
},
"description": "Retrieves a settlement report from your Merchant Center account.",
"httpMethod": "GET",
"id": "content.settlementreports.get",
"parameterOrder": [
"merchantId",
"settlementId"
],
"response": {
"$ref": "SettlementReport"
},
"scopes": [
"https://www.googleapis.com/auth/content"
],
"path": "content/v2.1/{merchantId}/settlementreports/{settlementId}",
"flatPath": "content/v2.1/{merchantId}/settlementreports/{settlementId}"
}
}
},
"localinventory": {
"methods": {
"insert": {
"httpMethod": "POST",
"parameters": {
"merchantId": {
"description": "The ID of the account that contains the product. This account cannot be a multi-client account.",
"type": "string",
"location": "path",
"required": true,
"format": "uint64"
},
"productId": {
"location": "path",
"required": true,
"type": "string",
"description": "The REST ID of the product for which to update local inventory."
}
},
"path": "content/v2.1/{merchantId}/products/{productId}/localinventory",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"parameterOrder": [
"merchantId",
"productId"
],
"flatPath": "content/v2.1/{merchantId}/products/{productId}/localinventory",
"request": {
"$ref": "LocalInventory"
},
"response": {
"$ref": "LocalInventory"
},
"description": "Updates the local inventory of a product in your Merchant Center account.",
"id": "content.localinventory.insert"
},
"custombatch": {
"httpMethod": "POST",
"id": "content.localinventory.custombatch",
"request": {
"$ref": "LocalinventoryCustomBatchRequest"
},
"parameters": {},
"flatPath": "content/v2.1/localinventory/batch",
"parameterOrder": [],
"path": "content/v2.1/localinventory/batch",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"response": {
"$ref": "LocalinventoryCustomBatchResponse"
},
"description": "Updates local inventory for multiple products or stores in a single request."
}
}
},
"returnpolicy": {
"methods": {
"delete": {
"path": "content/v2.1/{merchantId}/returnpolicy/{returnPolicyId}",
"parameters": {
"merchantId": {
"location": "path",
"required": true,
"description": "The Merchant Center account from which to delete the given return policy.",
"format": "uint64",
"type": "string"
},
"returnPolicyId": {
"location": "path",
"type": "string",
"required": true,
"description": "Return policy ID generated by Google."
}
},
"id": "content.returnpolicy.delete",
"httpMethod": "DELETE",
"flatPath": "content/v2.1/{merchantId}/returnpolicy/{returnPolicyId}",
"description": "Deletes a return policy for the given Merchant Center account.",
"parameterOrder": [
"merchantId",
"returnPolicyId"
],
"scopes": [
"https://www.googleapis.com/auth/content"
]
},
"custombatch": {
"scopes": [
"https://www.googleapis.com/auth/content"
],
"id": "content.returnpolicy.custombatch",
"description": "Batches multiple return policy related calls in a single request.",
"httpMethod": "POST",
"parameterOrder": [],
"flatPath": "content/v2.1/returnpolicy/batch",
"parameters": {},
"response": {
"$ref": "ReturnpolicyCustomBatchResponse"
},
"request": {
"$ref": "ReturnpolicyCustomBatchRequest"
},
"path": "content/v2.1/returnpolicy/batch"
},
"insert": {
"request": {
"$ref": "ReturnPolicy"
},
"response": {
"$ref": "ReturnPolicy"
},
"scopes": [
"https://www.googleapis.com/auth/content"
],
"httpMethod": "POST",
"parameterOrder": [
"merchantId"
],
"path": "content/v2.1/{merchantId}/returnpolicy",
"description": "Inserts a return policy for the Merchant Center account.",
"flatPath": "content/v2.1/{merchantId}/returnpolicy",
"id": "content.returnpolicy.insert",
"parameters": {
"merchantId": {
"description": "The Merchant Center account to insert a return policy for.",
"format": "uint64",
"required": true,
"location": "path",
"type": "string"
}
}
},
"list": {
"flatPath": "content/v2.1/{merchantId}/returnpolicy",
"response": {
"$ref": "ReturnpolicyListResponse"
},
"parameters": {
"merchantId": {
"format": "uint64",
"type": "string",
"description": "The Merchant Center account to list return policies for.",
"location": "path",
"required": true
}
},
"parameterOrder": [
"merchantId"
],
"id": "content.returnpolicy.list",
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"description": "Lists the return policies of the Merchant Center account.",
"path": "content/v2.1/{merchantId}/returnpolicy"
},
"get": {
"flatPath": "content/v2.1/{merchantId}/returnpolicy/{returnPolicyId}",
"path": "content/v2.1/{merchantId}/returnpolicy/{returnPolicyId}",
"description": "Gets a return policy of the Merchant Center account.",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"id": "content.returnpolicy.get",
"parameters": {
"returnPolicyId": {
"required": true,
"description": "Return policy ID generated by Google.",
"location": "path",
"type": "string"
},
"merchantId": {
"type": "string",
"location": "path",
"format": "uint64",
"description": "The Merchant Center account to get a return policy for.",
"required": true
}
},
"httpMethod": "GET",
"response": {
"$ref": "ReturnPolicy"
},
"parameterOrder": [
"merchantId",
"returnPolicyId"
]
}
}
},
"returnaddress": {
"methods": {
"insert": {
"description": "Inserts a return address for the Merchant Center account.",
"request": {
"$ref": "ReturnAddress"
},
"parameterOrder": [
"merchantId"
],
"id": "content.returnaddress.insert",
"parameters": {
"merchantId": {
"required": true,
"description": "The Merchant Center account to insert a return address for.",
"format": "uint64",
"type": "string",
"location": "path"
}
},
"flatPath": "content/v2.1/{merchantId}/returnaddress",
"httpMethod": "POST",
"path": "content/v2.1/{merchantId}/returnaddress",
"response": {
"$ref": "ReturnAddress"
},
"scopes": [
"https://www.googleapis.com/auth/content"
]
},
"custombatch": {
"httpMethod": "POST",
"parameterOrder": [],
"description": "Batches multiple return address related calls in a single request.",
"flatPath": "content/v2.1/returnaddress/batch",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"response": {
"$ref": "ReturnaddressCustomBatchResponse"
},
"parameters": {},
"request": {
"$ref": "ReturnaddressCustomBatchRequest"
},
"path": "content/v2.1/returnaddress/batch",
"id": "content.returnaddress.custombatch"
},
"delete": {
"parameterOrder": [
"merchantId",
"returnAddressId"
],
"httpMethod": "DELETE",
"path": "content/v2.1/{merchantId}/returnaddress/{returnAddressId}",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"description": "Deletes a return address for the given Merchant Center account.",
"id": "content.returnaddress.delete",
"flatPath": "content/v2.1/{merchantId}/returnaddress/{returnAddressId}",
"parameters": {
"returnAddressId": {
"type": "string",
"required": true,
"location": "path",
"description": "Return address ID generated by Google."
},
"merchantId": {
"description": "The Merchant Center account from which to delete the given return address.",
"required": true,
"location": "path",
"format": "uint64",
"type": "string"
}
}
},
"get": {
"path": "content/v2.1/{merchantId}/returnaddress/{returnAddressId}",
"description": "Gets a return address of the Merchant Center account.",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"flatPath": "content/v2.1/{merchantId}/returnaddress/{returnAddressId}",
"parameterOrder": [
"merchantId",
"returnAddressId"
],
"id": "content.returnaddress.get",
"parameters": {
"returnAddressId": {
"type": "string",
"location": "path",
"description": "Return address ID generated by Google.",
"required": true
},
"merchantId": {
"type": "string",
"location": "path",
"required": true,
"description": "The Merchant Center account to get a return address for.",
"format": "uint64"
}
},
"response": {
"$ref": "ReturnAddress"
},
"httpMethod": "GET"
},
"list": {
"path": "content/v2.1/{merchantId}/returnaddress",
"httpMethod": "GET",
"parameterOrder": [
"merchantId"
],
"scopes": [
"https://www.googleapis.com/auth/content"
],
"description": "Lists the return addresses of the Merchant Center account.",
"response": {
"$ref": "ReturnaddressListResponse"
},
"flatPath": "content/v2.1/{merchantId}/returnaddress",
"id": "content.returnaddress.list",
"parameters": {
"country": {
"type": "string",
"description": "List only return addresses applicable to the given country of sale. When omitted, all return addresses are listed.",
"location": "query"
},
"merchantId": {
"location": "path",
"format": "uint64",
"type": "string",
"required": true,
"description": "The Merchant Center account to list return addresses for."
},
"pageToken": {
"location": "query",
"type": "string",
"description": "The token returned by the previous request."
},
"maxResults": {
"description": "The maximum number of addresses in the response, used for paging.",
"location": "query",
"type": "integer",
"format": "uint32"
}
}
}
}
},
"accounts": {
"methods": {
"updatelabels": {
"request": {
"$ref": "AccountsUpdateLabelsRequest"
},
"response": {
"$ref": "AccountsUpdateLabelsResponse"
},
"path": "content/v2.1/{merchantId}/accounts/{accountId}/updatelabels",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"description": "Updates labels that are assigned to the Merchant Center account by CSS user.",
"flatPath": "content/v2.1/{merchantId}/accounts/{accountId}/updatelabels",
"id": "content.accounts.updatelabels",
"httpMethod": "POST",
"parameterOrder": [
"merchantId",
"accountId"
],
"parameters": {
"accountId": {
"format": "uint64",
"required": true,
"description": "The ID of the account whose labels are updated.",
"type": "string",
"location": "path"
},
"merchantId": {
"description": "The ID of the managing account.",
"type": "string",
"required": true,
"location": "path",
"format": "uint64"
}
}
},
"custombatch": {
"httpMethod": "POST",
"response": {
"$ref": "AccountsCustomBatchResponse"
},
"path": "content/v2.1/accounts/batch",
"flatPath": "content/v2.1/accounts/batch",
"parameters": {},
"request": {
"$ref": "AccountsCustomBatchRequest"
},
"id": "content.accounts.custombatch",
"parameterOrder": [],
"description": "Retrieves, inserts, updates, and deletes multiple Merchant Center (sub-)accounts in a single request.",
"scopes": [
"https://www.googleapis.com/auth/content"
]
},
"link": {
"response": {
"$ref": "AccountsLinkResponse"
},
"scopes": [
"https://www.googleapis.com/auth/content"
],
"flatPath": "content/v2.1/{merchantId}/accounts/{accountId}/link",
"parameters": {
"accountId": {
"required": true,
"location": "path",
"format": "uint64",
"description": "The ID of the account that should be linked.",
"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.",
"required": true,
"location": "path",
"format": "uint64",
"type": "string"
}
},
"httpMethod": "POST",
"id": "content.accounts.link",
"parameterOrder": [
"merchantId",
"accountId"
],
"description": "Performs an action on a link between two Merchant Center accounts, namely accountId and linkedAccountId.",
"path": "content/v2.1/{merchantId}/accounts/{accountId}/link",
"request": {
"$ref": "AccountsLinkRequest"
}
},
"insert": {
"response": {
"$ref": "Account"
},
"scopes": [
"https://www.googleapis.com/auth/content"
],
"path": "content/v2.1/{merchantId}/accounts",
"id": "content.accounts.insert",
"flatPath": "content/v2.1/{merchantId}/accounts",
"parameterOrder": [
"merchantId"
],
"description": "Creates a Merchant Center sub-account.",
"request": {
"$ref": "Account"
},
"parameters": {
"merchantId": {
"type": "string",
"required": true,
"location": "path",
"description": "The ID of the managing account. This must be a multi-client account.",
"format": "uint64"
}
},
"httpMethod": "POST"
},
"update": {
"response": {
"$ref": "Account"
},
"scopes": [
"https://www.googleapis.com/auth/content"
],
"path": "content/v2.1/{merchantId}/accounts/{accountId}",
"parameterOrder": [
"merchantId",
"accountId"
],
"id": "content.accounts.update",
"parameters": {
"merchantId": {
"description": "The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.",
"format": "uint64",
"type": "string",
"required": true,
"location": "path"
},
"accountId": {
"format": "uint64",
"location": "path",
"description": "The ID of the account.",
"type": "string",
"required": true
}
},
"flatPath": "content/v2.1/{merchantId}/accounts/{accountId}",
"httpMethod": "PUT",
"request": {
"$ref": "Account"
},
"description": "Updates a Merchant Center account. Any fields that are not provided are deleted from the resource."
},
"delete": {
"description": "Deletes a Merchant Center sub-account.",
"flatPath": "content/v2.1/{merchantId}/accounts/{accountId}",
"parameters": {
"force": {
"type": "boolean",
"default": "false",
"description": "Flag to delete sub-accounts with products. The default value is false.",
"location": "query"
},
"accountId": {
"location": "path",
"required": true,
"format": "uint64",
"type": "string",
"description": "The ID of the account."
},
"merchantId": {
"location": "path",
"required": true,
"type": "string",
"format": "uint64",
"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."
}
},
"scopes": [
"https://www.googleapis.com/auth/content"
],
"httpMethod": "DELETE",
"id": "content.accounts.delete",
"parameterOrder": [
"merchantId",
"accountId"
],
"path": "content/v2.1/{merchantId}/accounts/{accountId}"
},
"get": {
"flatPath": "content/v2.1/{merchantId}/accounts/{accountId}",
"path": "content/v2.1/{merchantId}/accounts/{accountId}",
"response": {
"$ref": "Account"
},
"description": "Retrieves a Merchant Center account.",
"parameterOrder": [
"merchantId",
"accountId"
],
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"parameters": {
"view": {
"enumDescriptions": [
"",
""
],
"enum": [
"MERCHANT",
"CSS"
],
"location": "query",
"type": "string",
"description": "Controls which fields will be populated. Acceptable values are: \"merchant\" and \"css\". The default value is \"merchant\"."
},
"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,
"location": "path",
"type": "string",
"format": "uint64",
"description": "The ID of the account."
}
},
"id": "content.accounts.get"
},
"list": {
"parameters": {
"pageToken": {
"description": "The token returned by the previous request.",
"location": "query",
"type": "string"
},
"merchantId": {
"format": "uint64",
"required": true,
"location": "path",
"description": "The ID of the managing account. This must be a multi-client account.",
"type": "string"
},
"label": {
"description": "If view is set to \"css\", only return accounts that are assigned label with given ID.",
"location": "query",
"type": "string",
"format": "uint64"
},
"view": {
"location": "query",
"description": "Controls which fields will be populated. Acceptable values are: \"merchant\" and \"css\". The default value is \"merchant\".",
"type": "string",
"enumDescriptions": [
"",
""
],
"enum": [
"MERCHANT",
"CSS"
]
},
"maxResults": {
"type": "integer",
"description": "The maximum number of accounts to return in the response, used for paging.",
"location": "query",
"format": "uint32"
}
},
"scopes": [
"https://www.googleapis.com/auth/content"
],
"path": "content/v2.1/{merchantId}/accounts",
"parameterOrder": [
"merchantId"
],
"response": {
"$ref": "AccountsListResponse"
},
"description": "Lists the sub-accounts in your Merchant Center account.",
"httpMethod": "GET",
"id": "content.accounts.list",
"flatPath": "content/v2.1/{merchantId}/accounts"
},
"claimwebsite": {
"flatPath": "content/v2.1/{merchantId}/accounts/{accountId}/claimwebsite",
"httpMethod": "POST",
"id": "content.accounts.claimwebsite",
"description": "Claims the website of a Merchant Center sub-account.",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"parameters": {
"accountId": {
"type": "string",
"location": "path",
"description": "The ID of the account whose website is claimed.",
"required": true,
"format": "uint64"
},
"merchantId": {
"type": "string",
"format": "uint64",
"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"
},
"overwrite": {
"location": "query",
"description": "Only available to selected merchants. When set to `True`, this flag removes any existing claim on the requested website by another account and replaces it with a claim from this account.",
"type": "boolean"
}
},
"parameterOrder": [
"merchantId",
"accountId"
],
"path": "content/v2.1/{merchantId}/accounts/{accountId}/claimwebsite",
"response": {
"$ref": "AccountsClaimWebsiteResponse"
}
},
"listlinks": {
"description": "Returns the list of accounts linked to your Merchant Center account.",
"response": {
"$ref": "AccountsListLinksResponse"
},
"parameters": {
"maxResults": {
"description": "The maximum number of links to return in the response, used for pagination.",
"format": "uint32",
"type": "integer",
"location": "query"
},
"accountId": {
"format": "uint64",
"description": "The ID of the account for which to list links.",
"type": "string",
"location": "path",
"required": true
},
"merchantId": {
"type": "string",
"format": "uint64",
"description": "The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.",
"required": true,
"location": "path"
},
"pageToken": {
"type": "string",
"description": "The token returned by the previous request.",
"location": "query"
}
},
"id": "content.accounts.listlinks",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"httpMethod": "GET",
"flatPath": "content/v2.1/{merchantId}/accounts/{accountId}/listlinks",
"path": "content/v2.1/{merchantId}/accounts/{accountId}/listlinks",
"parameterOrder": [
"merchantId",
"accountId"
]
},
"authinfo": {
"parameterOrder": [],
"httpMethod": "GET",
"id": "content.accounts.authinfo",
"flatPath": "content/v2.1/accounts/authinfo",
"parameters": {},
"path": "content/v2.1/accounts/authinfo",
"response": {
"$ref": "AccountsAuthInfoResponse"
},
"scopes": [
"https://www.googleapis.com/auth/content"
],
"description": "Returns information about the authenticated user."
}
},
"resources": {
"labels": {
"methods": {
"delete": {
"parameters": {
"accountId": {
"description": "Required. The id of the account that owns the label.",
"location": "path",
"format": "int64",
"required": true,
"type": "string"
},
"labelId": {
"description": "Required. The id of the label to delete.",
"location": "path",
"required": true,
"type": "string",
"format": "int64"
}
},
"id": "content.accounts.labels.delete",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"parameterOrder": [
"accountId",
"labelId"
],
"description": "Deletes a label and removes it from all accounts to which it was assigned.",
"flatPath": "content/v2.1/accounts/{accountId}/labels/{labelId}",
"httpMethod": "DELETE",
"path": "content/v2.1/accounts/{accountId}/labels/{labelId}"
},
"patch": {
"parameters": {
"accountId": {
"format": "int64",
"type": "string",
"description": "Required. The id of the account this label belongs to.",
"required": true,
"location": "path"
},
"labelId": {
"required": true,
"format": "int64",
"location": "path",
"description": "Required. The id of the label to update.",
"type": "string"
}
},
"path": "content/v2.1/accounts/{accountId}/labels/{labelId}",
"description": "Updates a label.",
"flatPath": "content/v2.1/accounts/{accountId}/labels/{labelId}",
"request": {
"$ref": "AccountLabel"
},
"id": "content.accounts.labels.patch",
"httpMethod": "PATCH",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"response": {
"$ref": "AccountLabel"
},
"parameterOrder": [
"accountId",
"labelId"
]
},
"list": {
"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"
},
"accountId": {
"location": "path",
"required": true,
"format": "int64",
"description": "Required. The account id for whose labels are to be listed.",
"type": "string"
},
"pageSize": {
"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.",
"format": "int32",
"type": "integer",
"location": "query"
}
},
"response": {
"$ref": "ListAccountLabelsResponse"
},
"id": "content.accounts.labels.list",
"description": "Lists the labels assigned to an account.",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"httpMethod": "GET",
"path": "content/v2.1/accounts/{accountId}/labels",
"flatPath": "content/v2.1/accounts/{accountId}/labels",
"parameterOrder": [
"accountId"
]
},
"create": {
"flatPath": "content/v2.1/accounts/{accountId}/labels",
"id": "content.accounts.labels.create",
"httpMethod": "POST",
"description": "Creates a new label, not assigned to any account.",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"parameterOrder": [
"accountId"
],
"request": {
"$ref": "AccountLabel"
},
"response": {
"$ref": "AccountLabel"
},
"path": "content/v2.1/accounts/{accountId}/labels",
"parameters": {
"accountId": {
"description": "Required. The id of the account this label belongs to.",
"type": "string",
"location": "path",
"format": "int64",
"required": true
}
}
}
}
}
}
},
"regionalinventory": {
"methods": {
"insert": {
"response": {
"$ref": "RegionalInventory"
},
"parameters": {
"productId": {
"location": "path",
"description": "The REST ID of the product for which to update the regional inventory.",
"type": "string",
"required": true
},
"merchantId": {
"type": "string",
"description": "The ID of the account that contains the product. This account cannot be a multi-client account.",
"format": "uint64",
"required": true,
"location": "path"
}
},
"httpMethod": "POST",
"request": {
"$ref": "RegionalInventory"
},
"flatPath": "content/v2.1/{merchantId}/products/{productId}/regionalinventory",
"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.",
"id": "content.regionalinventory.insert",
"parameterOrder": [
"merchantId",
"productId"
],
"scopes": [
"https://www.googleapis.com/auth/content"
],
"path": "content/v2.1/{merchantId}/products/{productId}/regionalinventory"
},
"custombatch": {
"id": "content.regionalinventory.custombatch",
"response": {
"$ref": "RegionalinventoryCustomBatchResponse"
},
"httpMethod": "POST",
"flatPath": "content/v2.1/regionalinventory/batch",
"parameters": {},
"scopes": [
"https://www.googleapis.com/auth/content"
],
"parameterOrder": [],
"description": "Updates regional inventory for multiple products or regions in a single request.",
"request": {
"$ref": "RegionalinventoryCustomBatchRequest"
},
"path": "content/v2.1/regionalinventory/batch"
}
}
},
"csses": {
"methods": {
"updatelabels": {
"scopes": [
"https://www.googleapis.com/auth/content"
],
"id": "content.csses.updatelabels",
"request": {
"$ref": "LabelIds"
},
"httpMethod": "POST",
"response": {
"$ref": "Css"
},
"description": "Updates labels that are assigned to a CSS domain by its CSS group.",
"parameterOrder": [
"cssGroupId",
"cssDomainId"
],
"parameters": {
"cssGroupId": {
"type": "string",
"format": "int64",
"location": "path",
"required": true,
"description": "Required. The CSS group ID of the updated CSS domain."
},
"cssDomainId": {
"required": true,
"format": "int64",
"description": "Required. The ID of the updated CSS domain.",
"type": "string",
"location": "path"
}
},
"path": "content/v2.1/{cssGroupId}/csses/{cssDomainId}/updatelabels",
"flatPath": "content/v2.1/{cssGroupId}/csses/{cssDomainId}/updatelabels"
},
"list": {
"parameterOrder": [
"cssGroupId"
],
"path": "content/v2.1/{cssGroupId}/csses",
"httpMethod": "GET",
"flatPath": "content/v2.1/{cssGroupId}/csses",
"response": {
"$ref": "ListCssesResponse"
},
"id": "content.csses.list",
"parameters": {
"pageToken": {
"location": "query",
"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.",
"type": "string"
},
"pageSize": {
"type": "integer",
"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",
"format": "int32"
},
"cssGroupId": {
"type": "string",
"required": true,
"location": "path",
"format": "int64",
"description": "Required. The CSS group ID of CSS domains to be listed."
}
},
"scopes": [
"https://www.googleapis.com/auth/content"
],
"description": "Lists CSS domains affiliated with a CSS group."
},
"get": {
"httpMethod": "GET",
"path": "content/v2.1/{cssGroupId}/csses/{cssDomainId}",
"flatPath": "content/v2.1/{cssGroupId}/csses/{cssDomainId}",
"parameterOrder": [
"cssGroupId",
"cssDomainId"
],
"description": "Retrieves a single CSS domain by ID.",
"parameters": {
"cssGroupId": {
"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.",
"type": "string",
"location": "path",
"required": true,
"format": "int64"
},
"cssDomainId": {
"location": "path",
"type": "string",
"format": "int64",
"description": "Required. The ID of the CSS domain to return.",
"required": true
}
},
"id": "content.csses.get",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"response": {
"$ref": "Css"
}
}
}
},
"orders": {
"methods": {
"updatelineitemshippingdetails": {
"id": "content.orders.updatelineitemshippingdetails",
"parameterOrder": [
"merchantId",
"orderId"
],
"request": {
"$ref": "OrdersUpdateLineItemShippingDetailsRequest"
},
"httpMethod": "POST",
"flatPath": "content/v2.1/{merchantId}/orders/{orderId}/updateLineItemShippingDetails",
"path": "content/v2.1/{merchantId}/orders/{orderId}/updateLineItemShippingDetails",
"response": {
"$ref": "OrdersUpdateLineItemShippingDetailsResponse"
},
"description": "Updates ship by and delivery by dates for a line item.",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"parameters": {
"merchantId": {
"type": "string",
"format": "uint64",
"description": "The ID of the account that manages the order. This cannot be a multi-client account.",
"required": true,
"location": "path"
},
"orderId": {
"required": true,
"location": "path",
"type": "string",
"description": "The ID of the order."
}
}
},
"getbymerchantorderid": {
"id": "content.orders.getbymerchantorderid",
"description": "Retrieves an order using merchant order ID.",
"parameterOrder": [
"merchantId",
"merchantOrderId"
],
"response": {
"$ref": "OrdersGetByMerchantOrderIdResponse"
},
"httpMethod": "GET",
"flatPath": "content/v2.1/{merchantId}/ordersbymerchantid/{merchantOrderId}",
"path": "content/v2.1/{merchantId}/ordersbymerchantid/{merchantOrderId}",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"parameters": {
"merchantId": {
"description": "The ID of the account that manages the order. This cannot be a multi-client account.",
"format": "uint64",
"required": true,
"location": "path",
"type": "string"
},
"merchantOrderId": {
"description": "The merchant order ID to be looked for.",
"location": "path",
"type": "string",
"required": true
}
}
},
"refunditem": {
"scopes": [
"https://www.googleapis.com/auth/content"
],
"description": "Issues a partial or total refund for items and shipment.",
"flatPath": "content/v2.1/{merchantId}/orders/{orderId}/refunditem",
"request": {
"$ref": "OrdersRefundItemRequest"
},
"id": "content.orders.refunditem",
"parameterOrder": [
"merchantId",
"orderId"
],
"httpMethod": "POST",
"parameters": {
"orderId": {
"type": "string",
"location": "path",
"description": "The ID of the order to refund.",
"required": true
},
"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"
}
},
"path": "content/v2.1/{merchantId}/orders/{orderId}/refunditem",
"response": {
"$ref": "OrdersRefundItemResponse"
}
},
"updateshipment": {
"path": "content/v2.1/{merchantId}/orders/{orderId}/updateShipment",
"description": "Updates a shipment's status, carrier, and/or tracking ID.",
"flatPath": "content/v2.1/{merchantId}/orders/{orderId}/updateShipment",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"id": "content.orders.updateshipment",
"request": {
"$ref": "OrdersUpdateShipmentRequest"
},
"parameters": {
"merchantId": {
"description": "The ID of the account that manages the order. This cannot be a multi-client account.",
"required": true,
"type": "string",
"format": "uint64",
"location": "path"
},
"orderId": {
"description": "The ID of the order.",
"type": "string",
"location": "path",
"required": true
}
},
"httpMethod": "POST",
"parameterOrder": [
"merchantId",
"orderId"
],
"response": {
"$ref": "OrdersUpdateShipmentResponse"
}
},
"instorerefundlineitem": {
"httpMethod": "POST",
"request": {
"$ref": "OrdersInStoreRefundLineItemRequest"
},
"parameterOrder": [
"merchantId",
"orderId"
],
"scopes": [
"https://www.googleapis.com/auth/content"
],
"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.",
"path": "content/v2.1/{merchantId}/orders/{orderId}/inStoreRefundLineItem",
"parameters": {
"orderId": {
"location": "path",
"required": true,
"type": "string",
"description": "The ID of the order."
},
"merchantId": {
"type": "string",
"location": "path",
"required": true,
"format": "uint64",
"description": "The ID of the account that manages the order. This cannot be a multi-client account."
}
},
"id": "content.orders.instorerefundlineitem",
"response": {
"$ref": "OrdersInStoreRefundLineItemResponse"
},
"flatPath": "content/v2.1/{merchantId}/orders/{orderId}/inStoreRefundLineItem"
},
"get": {
"flatPath": "content/v2.1/{merchantId}/orders/{orderId}",
"parameterOrder": [
"merchantId",
"orderId"
],
"description": "Retrieves an order from your Merchant Center account.",
"parameters": {
"merchantId": {
"required": true,
"type": "string",
"description": "The ID of the account that manages the order. This cannot be a multi-client account.",
"format": "uint64",
"location": "path"
},
"orderId": {
"location": "path",
"type": "string",
"required": true,
"description": "The ID of the order."
}
},
"id": "content.orders.get",
"httpMethod": "GET",
"path": "content/v2.1/{merchantId}/orders/{orderId}",
"response": {
"$ref": "Order"
},
"scopes": [
"https://www.googleapis.com/auth/content"
]
},
"canceltestorderbycustomer": {
"parameterOrder": [
"merchantId",
"orderId"
],
"response": {
"$ref": "OrdersCancelTestOrderByCustomerResponse"
},
"parameters": {
"merchantId": {
"location": "path",
"required": true,
"type": "string",
"description": "The ID of the account that manages the order. This cannot be a multi-client account.",
"format": "uint64"
},
"orderId": {
"location": "path",
"required": true,
"type": "string",
"description": "The ID of the test order to cancel."
}
},
"id": "content.orders.canceltestorderbycustomer",
"flatPath": "content/v2.1/{merchantId}/testorders/{orderId}/cancelByCustomer",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"description": "Sandbox only. Cancels a test order for customer-initiated cancellation.",
"request": {
"$ref": "OrdersCancelTestOrderByCustomerRequest"
},
"httpMethod": "POST",
"path": "content/v2.1/{merchantId}/testorders/{orderId}/cancelByCustomer"
},
"acknowledge": {
"request": {
"$ref": "OrdersAcknowledgeRequest"
},
"parameters": {
"orderId": {
"location": "path",
"required": true,
"type": "string",
"description": "The ID of the order."
},
"merchantId": {
"type": "string",
"format": "uint64",
"required": true,
"description": "The ID of the account that manages the order. This cannot be a multi-client account.",
"location": "path"
}
},
"response": {
"$ref": "OrdersAcknowledgeResponse"
},
"scopes": [
"https://www.googleapis.com/auth/content"
],
"id": "content.orders.acknowledge",
"description": "Marks an order as acknowledged.",
"path": "content/v2.1/{merchantId}/orders/{orderId}/acknowledge",
"httpMethod": "POST",
"parameterOrder": [
"merchantId",
"orderId"
],
"flatPath": "content/v2.1/{merchantId}/orders/{orderId}/acknowledge"
},
"list": {
"httpMethod": "GET",
"response": {
"$ref": "OrdersListResponse"
},
"description": "Lists the orders in your Merchant Center account.",
"id": "content.orders.list",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"flatPath": "content/v2.1/{merchantId}/orders",
"path": "content/v2.1/{merchantId}/orders",
"parameters": {
"orderBy": {
"type": "string",
"location": "query",
"description": "Order results by placement date in descending or ascending order. Acceptable values are: - placedDateAsc - placedDateDesc "
},
"acknowledged": {
"type": "boolean",
"description": "Obtains orders that match the acknowledgement status. When set to true, obtains orders that have been acknowledged. When false, obtains orders that have not been acknowledged. We recommend using this filter set to `false`, in conjunction with the `acknowledge` call, such that only un-acknowledged orders are returned. ",
"location": "query"
},
"statuses": {
"location": "query",
"repeated": true,
"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`.",
"type": "string",
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"enum": [
"ACTIVE",
"COMPLETED",
"CANCELED",
"IN_PROGRESS",
"PENDING_SHIPMENT",
"PARTIALLY_SHIPPED",
"SHIPPED",
"PARTIALLY_DELIVERED",
"DELIVERED",
"PARTIALLY_RETURNED",
"RETURNED"
]
},
"merchantId": {
"type": "string",
"location": "path",
"format": "uint64",
"description": "The ID of the account that manages the order. This cannot be a multi-client account.",
"required": true
},
"placedDateEnd": {
"description": "Obtains orders placed before this date (exclusively), in ISO 8601 format.",
"location": "query",
"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.",
"type": "integer",
"format": "uint32",
"location": "query"
},
"placedDateStart": {
"type": "string",
"description": "Obtains orders placed after this date (inclusively), in ISO 8601 format.",
"location": "query"
},
"pageToken": {
"description": "The token returned by the previous request.",
"type": "string",
"location": "query"
}
},
"parameterOrder": [
"merchantId"
]
},
"gettestordertemplate": {
"flatPath": "content/v2.1/{merchantId}/testordertemplates/{templateName}",
"id": "content.orders.gettestordertemplate",
"parameterOrder": [
"merchantId",
"templateName"
],
"httpMethod": "GET",
"description": "Sandbox only. Retrieves an order template that can be used to quickly create a new order in sandbox.",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"path": "content/v2.1/{merchantId}/testordertemplates/{templateName}",
"response": {
"$ref": "OrdersGetTestOrderTemplateResponse"
},
"parameters": {
"templateName": {
"enumDescriptions": [
"",
"",
"",
"",
"",
""
],
"description": "The name of the template to retrieve.",
"required": true,
"type": "string",
"location": "path",
"enum": [
"TEMPLATE1",
"TEMPLATE2",
"TEMPLATE1A",
"TEMPLATE1B",
"TEMPLATE3",
"TEMPLATE4"
]
},
"country": {
"location": "query",
"description": "The country of the template to retrieve. Defaults to `US`.",
"type": "string"
},
"merchantId": {
"format": "uint64",
"location": "path",
"type": "string",
"description": "The ID of the account that should manage the order. This cannot be a multi-client account.",
"required": true
}
}
},
"cancel": {
"response": {
"$ref": "OrdersCancelResponse"
},
"id": "content.orders.cancel",
"flatPath": "content/v2.1/{merchantId}/orders/{orderId}/cancel",
"request": {
"$ref": "OrdersCancelRequest"
},
"parameterOrder": [
"merchantId",
"orderId"
],
"parameters": {
"merchantId": {
"required": true,
"format": "uint64",
"location": "path",
"type": "string",
"description": "The ID of the account that manages the order. This cannot be a multi-client account."
},
"orderId": {
"location": "path",
"required": true,
"type": "string",
"description": "The ID of the order to cancel."
}
},
"path": "content/v2.1/{merchantId}/orders/{orderId}/cancel",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"description": "Cancels all line items in an order, making a full refund.",
"httpMethod": "POST"
},
"updatemerchantorderid": {
"parameters": {
"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"
},
"orderId": {
"required": true,
"location": "path",
"description": "The ID of the order.",
"type": "string"
}
},
"parameterOrder": [
"merchantId",
"orderId"
],
"flatPath": "content/v2.1/{merchantId}/orders/{orderId}/updateMerchantOrderId",
"id": "content.orders.updatemerchantorderid",
"response": {
"$ref": "OrdersUpdateMerchantOrderIdResponse"
},
"httpMethod": "POST",
"path": "content/v2.1/{merchantId}/orders/{orderId}/updateMerchantOrderId",
"description": "Updates the merchant order ID for a given order.",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"request": {
"$ref": "OrdersUpdateMerchantOrderIdRequest"
}
},
"createtestorder": {
"scopes": [
"https://www.googleapis.com/auth/content"
],
"response": {
"$ref": "OrdersCreateTestOrderResponse"
},
"request": {
"$ref": "OrdersCreateTestOrderRequest"
},
"path": "content/v2.1/{merchantId}/testorders",
"description": "Sandbox only. Creates a test order.",
"parameters": {
"merchantId": {
"location": "path",
"required": true,
"type": "string",
"description": "The ID of the account that should manage the order. This cannot be a multi-client account.",
"format": "uint64"
}
},
"id": "content.orders.createtestorder",
"flatPath": "content/v2.1/{merchantId}/testorders",
"parameterOrder": [
"merchantId"
],
"httpMethod": "POST"
},
"returnrefundlineitem": {
"httpMethod": "POST",
"parameters": {
"orderId": {
"required": true,
"type": "string",
"description": "The ID of the order.",
"location": "path"
},
"merchantId": {
"type": "string",
"description": "The ID of the account that manages the order. This cannot be a multi-client account.",
"location": "path",
"required": true,
"format": "uint64"
}
},
"parameterOrder": [
"merchantId",
"orderId"
],
"path": "content/v2.1/{merchantId}/orders/{orderId}/returnRefundLineItem",
"id": "content.orders.returnrefundlineitem",
"request": {
"$ref": "OrdersReturnRefundLineItemRequest"
},
"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.",
"response": {
"$ref": "OrdersReturnRefundLineItemResponse"
},
"flatPath": "content/v2.1/{merchantId}/orders/{orderId}/returnRefundLineItem",
"scopes": [
"https://www.googleapis.com/auth/content"
]
},
"cancellineitem": {
"parameterOrder": [
"merchantId",
"orderId"
],
"path": "content/v2.1/{merchantId}/orders/{orderId}/cancelLineItem",
"response": {
"$ref": "OrdersCancelLineItemResponse"
},
"flatPath": "content/v2.1/{merchantId}/orders/{orderId}/cancelLineItem",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"request": {
"$ref": "OrdersCancelLineItemRequest"
},
"id": "content.orders.cancellineitem",
"parameters": {
"orderId": {
"required": true,
"description": "The ID of the order.",
"type": "string",
"location": "path"
},
"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."
}
},
"httpMethod": "POST",
"description": "Cancels a line item, making a full refund."
},
"shiplineitems": {
"path": "content/v2.1/{merchantId}/orders/{orderId}/shipLineItems",
"response": {
"$ref": "OrdersShipLineItemsResponse"
},
"id": "content.orders.shiplineitems",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"flatPath": "content/v2.1/{merchantId}/orders/{orderId}/shipLineItems",
"request": {
"$ref": "OrdersShipLineItemsRequest"
},
"parameters": {
"merchantId": {
"description": "The ID of the account that manages the order. This cannot be a multi-client account.",
"type": "string",
"required": true,
"location": "path",
"format": "uint64"
},
"orderId": {
"location": "path",
"required": true,
"type": "string",
"description": "The ID of the order."
}
},
"parameterOrder": [
"merchantId",
"orderId"
],
"description": "Marks line item(s) as shipped.",
"httpMethod": "POST"
},
"advancetestorder": {
"response": {
"$ref": "OrdersAdvanceTestOrderResponse"
},
"scopes": [
"https://www.googleapis.com/auth/content"
],
"description": "Sandbox only. Moves a test order from state \"`inProgress`\" to state \"`pendingShipment`\".",
"path": "content/v2.1/{merchantId}/testorders/{orderId}/advance",
"parameters": {
"merchantId": {
"location": "path",
"required": true,
"type": "string",
"description": "The ID of the account that manages the order. This cannot be a multi-client account.",
"format": "uint64"
},
"orderId": {
"description": "The ID of the test order to modify.",
"type": "string",
"required": true,
"location": "path"
}
},
"flatPath": "content/v2.1/{merchantId}/testorders/{orderId}/advance",
"parameterOrder": [
"merchantId",
"orderId"
],
"httpMethod": "POST",
"id": "content.orders.advancetestorder"
},
"refundorder": {
"parameterOrder": [
"merchantId",
"orderId"
],
"httpMethod": "POST",
"request": {
"$ref": "OrdersRefundOrderRequest"
},
"scopes": [
"https://www.googleapis.com/auth/content"
],
"flatPath": "content/v2.1/{merchantId}/orders/{orderId}/refundorder",
"description": "Issues a partial or total refund for an order.",
"id": "content.orders.refundorder",
"parameters": {
"orderId": {
"description": "The ID of the order to refund.",
"location": "path",
"type": "string",
"required": true
},
"merchantId": {
"type": "string",
"required": true,
"location": "path",
"description": "The ID of the account that manages the order. This cannot be a multi-client account.",
"format": "uint64"
}
},
"path": "content/v2.1/{merchantId}/orders/{orderId}/refundorder",
"response": {
"$ref": "OrdersRefundOrderResponse"
}
},
"createtestreturn": {
"parameterOrder": [
"merchantId",
"orderId"
],
"description": "Sandbox only. Creates a test return.",
"request": {
"$ref": "OrdersCreateTestReturnRequest"
},
"flatPath": "content/v2.1/{merchantId}/orders/{orderId}/testreturn",
"id": "content.orders.createtestreturn",
"httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"parameters": {
"merchantId": {
"required": true,
"type": "string",
"location": "path",
"description": "The ID of the account that manages the order. This cannot be a multi-client account.",
"format": "uint64"
},
"orderId": {
"location": "path",
"description": "The ID of the order.",
"type": "string",
"required": true
}
},
"path": "content/v2.1/{merchantId}/orders/{orderId}/testreturn",
"response": {
"$ref": "OrdersCreateTestReturnResponse"
}
},
"setlineitemmetadata": {
"response": {
"$ref": "OrdersSetLineItemMetadataResponse"
},
"parameterOrder": [
"merchantId",
"orderId"
],
"httpMethod": "POST",
"request": {
"$ref": "OrdersSetLineItemMetadataRequest"
},
"parameters": {
"merchantId": {
"required": true,
"type": "string",
"location": "path",
"description": "The ID of the account that manages the order. This cannot be a multi-client account.",
"format": "uint64"
},
"orderId": {
"description": "The ID of the order.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "content/v2.1/{merchantId}/orders/{orderId}/setLineItemMetadata",
"flatPath": "content/v2.1/{merchantId}/orders/{orderId}/setLineItemMetadata",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"id": "content.orders.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."
},
"rejectreturnlineitem": {
"request": {
"$ref": "OrdersRejectReturnLineItemRequest"
},
"httpMethod": "POST",
"id": "content.orders.rejectreturnlineitem",
"flatPath": "content/v2.1/{merchantId}/orders/{orderId}/rejectReturnLineItem",
"path": "content/v2.1/{merchantId}/orders/{orderId}/rejectReturnLineItem",
"parameterOrder": [
"merchantId",
"orderId"
],
"parameters": {
"orderId": {
"required": true,
"type": "string",
"description": "The ID of the order.",
"location": "path"
},
"merchantId": {
"location": "path",
"description": "The ID of the account that manages the order. This cannot be a multi-client account.",
"format": "uint64",
"type": "string",
"required": true
}
},
"response": {
"$ref": "OrdersRejectReturnLineItemResponse"
},
"scopes": [
"https://www.googleapis.com/auth/content"
],
"description": "Rejects return on an line item."
}
}
},
"regions": {
"methods": {
"create": {
"description": "Creates a region definition in your Merchant Center account.",
"parameterOrder": [
"merchantId"
],
"response": {
"$ref": "Region"
},
"scopes": [
"https://www.googleapis.com/auth/content"
],
"request": {
"$ref": "Region"
},
"httpMethod": "POST",
"parameters": {
"regionId": {
"location": "query",
"type": "string",
"description": "Required. The id of the region to create."
},
"merchantId": {
"format": "int64",
"type": "string",
"description": "Required. The id of the merchant for which to create region definition.",
"location": "path",
"required": true
}
},
"path": "content/v2.1/{merchantId}/regions",
"flatPath": "content/v2.1/{merchantId}/regions",
"id": "content.regions.create"
},
"patch": {
"scopes": [
"https://www.googleapis.com/auth/content"
],
"description": "Updates a region definition in your Merchant Center account.",
"httpMethod": "PATCH",
"parameters": {
"merchantId": {
"required": true,
"location": "path",
"description": "Required. The id of the merchant for which to update region definition.",
"format": "int64",
"type": "string"
},
"regionId": {
"location": "path",
"type": "string",
"description": "Required. The id of the region to update.",
"required": true
},
"updateMask": {
"location": "query",
"type": "string",
"description": "Optional. The field mask indicating the fields to update.",
"format": "google-fieldmask"
}
},
"response": {
"$ref": "Region"
},
"parameterOrder": [
"merchantId",
"regionId"
],
"id": "content.regions.patch",
"path": "content/v2.1/{merchantId}/regions/{regionId}",
"request": {
"$ref": "Region"
},
"flatPath": "content/v2.1/{merchantId}/regions/{regionId}"
},
"get": {
"httpMethod": "GET",
"id": "content.regions.get",
"flatPath": "content/v2.1/{merchantId}/regions/{regionId}",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"description": "Retrieves a region defined in your Merchant Center account.",
"parameterOrder": [
"merchantId",
"regionId"
],
"path": "content/v2.1/{merchantId}/regions/{regionId}",
"response": {
"$ref": "Region"
},
"parameters": {
"regionId": {
"required": true,
"type": "string",
"location": "path",
"description": "Required. The id of the region to retrieve."
},
"merchantId": {
"type": "string",
"location": "path",
"description": "Required. The id of the merchant for which to retrieve region definition.",
"format": "int64",
"required": true
}
}
},
"list": {
"scopes": [
"https://www.googleapis.com/auth/content"
],
"httpMethod": "GET",
"parameters": {
"merchantId": {
"required": true,
"location": "path",
"type": "string",
"description": "Required. The id of the merchant for which to list region definitions.",
"format": "int64"
},
"pageToken": {
"location": "query",
"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"
},
"pageSize": {
"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.",
"type": "integer",
"format": "int32",
"location": "query"
}
},
"response": {
"$ref": "ListRegionsResponse"
},
"id": "content.regions.list",
"parameterOrder": [
"merchantId"
],
"description": "Lists the regions in your Merchant Center account.",
"flatPath": "content/v2.1/{merchantId}/regions",
"path": "content/v2.1/{merchantId}/regions"
},
"delete": {
"description": "Deletes a region definition from your Merchant Center account.",
"flatPath": "content/v2.1/{merchantId}/regions/{regionId}",
"httpMethod": "DELETE",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"parameters": {
"regionId": {
"type": "string",
"required": true,
"location": "path",
"description": "Required. The id of the region to delete."
},
"merchantId": {
"required": true,
"description": "Required. The id of the merchant for which to delete region definition.",
"format": "int64",
"location": "path",
"type": "string"
}
},
"parameterOrder": [
"merchantId",
"regionId"
],
"path": "content/v2.1/{merchantId}/regions/{regionId}",
"id": "content.regions.delete"
}
}
},
"pos": {
"methods": {
"custombatch": {
"scopes": [
"https://www.googleapis.com/auth/content"
],
"request": {
"$ref": "PosCustomBatchRequest"
},
"path": "content/v2.1/pos/batch",
"parameters": {},
"id": "content.pos.custombatch",
"httpMethod": "POST",
"description": "Batches multiple POS-related calls in a single request.",
"flatPath": "content/v2.1/pos/batch",
"parameterOrder": [],
"response": {
"$ref": "PosCustomBatchResponse"
}
},
"delete": {
"parameterOrder": [
"merchantId",
"targetMerchantId",
"storeCode"
],
"id": "content.pos.delete",
"flatPath": "content/v2.1/{merchantId}/pos/{targetMerchantId}/store/{storeCode}",
"httpMethod": "DELETE",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"description": "Deletes a store for the given merchant.",
"path": "content/v2.1/{merchantId}/pos/{targetMerchantId}/store/{storeCode}",
"parameters": {
"storeCode": {
"description": "A store code that is unique per merchant.",
"location": "path",
"required": true,
"type": "string"
},
"targetMerchantId": {
"format": "uint64",
"location": "path",
"type": "string",
"required": true,
"description": "The ID of the target merchant."
},
"merchantId": {
"format": "uint64",
"description": "The ID of the POS or inventory data provider.",
"required": true,
"type": "string",
"location": "path"
}
}
},
"inventory": {
"description": "Submit inventory for the given merchant.",
"httpMethod": "POST",
"parameters": {
"merchantId": {
"format": "uint64",
"type": "string",
"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,
"type": "string",
"format": "uint64"
}
},
"scopes": [
"https://www.googleapis.com/auth/content"
],
"response": {
"$ref": "PosInventoryResponse"
},
"parameterOrder": [
"merchantId",
"targetMerchantId"
],
"path": "content/v2.1/{merchantId}/pos/{targetMerchantId}/inventory",
"request": {
"$ref": "PosInventoryRequest"
},
"id": "content.pos.inventory",
"flatPath": "content/v2.1/{merchantId}/pos/{targetMerchantId}/inventory"
},
"list": {
"scopes": [
"https://www.googleapis.com/auth/content"
],
"flatPath": "content/v2.1/{merchantId}/pos/{targetMerchantId}/store",
"id": "content.pos.list",
"path": "content/v2.1/{merchantId}/pos/{targetMerchantId}/store",
"response": {
"$ref": "PosListResponse"
},
"description": "Lists the stores of the target merchant.",
"httpMethod": "GET",
"parameterOrder": [
"merchantId",
"targetMerchantId"
],
"parameters": {
"targetMerchantId": {
"required": true,
"description": "The ID of the target merchant.",
"type": "string",
"format": "uint64",
"location": "path"
},
"merchantId": {
"location": "path",
"description": "The ID of the POS or inventory data provider.",
"format": "uint64",
"type": "string",
"required": true
}
}
},
"sale": {
"path": "content/v2.1/{merchantId}/pos/{targetMerchantId}/sale",
"httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/content"
],
"parameters": {
"merchantId": {
"location": "path",
"description": "The ID of the POS or inventory data provider.",
"required": true,
"format": "uint64",
"type": "string"
},
"targetMerchantId": {
"description": "The ID of the target merchant.",
"required": true,
"format": "uint64",
"location": "path",
"type": "string"
}
},
"flatPath": "content/v2.1/{merchantId}/pos/{targetMerchantId}/sale",
"description": "Submit a sale event for the given merchant.",
"request": {
"$ref": "PosSaleRequest"
},
"response": {
"$ref": "PosSaleResponse"
},
"id": "content.pos.sale",
"parameterOrder": [
"merchantId",
"targetMerchantId"
]
},
"get": {
"parameterOrder": [
"merchantId",
"targetMerchantId",
"storeCode"
],
"scopes": [
"https://www.googleapis.com/auth/content"
],
"id": "content.pos.get",
"parameters": {
"merchantId": {
"location": "path",
"description": "The ID of the POS or inventory data provider.",
"required": true,
"type": "string",
"format": "uint64"
},
"storeCode": {
"required": true,
"description": "A store code that is unique per merchant.",
"type": "string",
"location": "path"
},
"targetMerchantId": {
"location": "path",
"description": "The ID of the target merchant.",
"type": "string",
"required": true,
"format": "uint64"
}
},
"flatPath": "content/v2.1/{merchantId}/pos/{targetMerchantId}/store/{storeCode}",
"httpMethod": "GET",
"path": "content/v2.1/{merchantId}/pos/{targetMerchantId}/store/{storeCode}",
"description": "Retrieves information about the given store.",
"response": {
"$ref": "PosStore"
}
},
"insert": {
"scopes": [
"https://www.googleapis.com/auth/content"
],
"parameterOrder": [
"merchantId",
"targetMerchantId"
],
"httpMethod": "POST",
"flatPath": "content/v2.1/{merchantId}/pos/{targetMerchantId}/store",
"parameters": {
"targetMerchantId": {
"description": "The ID of the target merchant.",
"format": "uint64",
"location": "path",
"required": true,
"type": "string"
},
"merchantId": {
"description": "The ID of the POS or inventory data provider.",
"type": "string",
"location": "path",
"required": true,
"format": "uint64"
}
},
"request": {
"$ref": "PosStore"
},
"path": "content/v2.1/{merchantId}/pos/{targetMerchantId}/store",
"id": "content.pos.insert",
"response": {
"$ref": "PosStore"
},
"description": "Creates a store for the given merchant."
}
}
}
},
"id": "content:v2.1",
"servicePath": "",
"kind": "discovery#restDescription",
"mtlsRootUrl": "https://shoppingcontent.mtls.googleapis.com/",
"schemas": {
"GmbAccounts": {
"properties": {
"gmbAccounts": {
"description": "A list of GMB accounts which are available to the merchant.",
"items": {
"$ref": "GmbAccountsGmbAccount"
},
"type": "array"
},
"accountId": {
"description": "The ID of the Merchant Center account.",
"type": "string",
"format": "uint64"
}
},
"id": "GmbAccounts",
"type": "object"
},
"Installment": {
"type": "object",
"id": "Installment",
"properties": {
"amount": {
"description": "The amount the buyer has to pay per month.",
"$ref": "Price"
},
"months": {
"type": "string",
"format": "int64",
"description": "The number of installments the buyer has to pay."
}
}
},
"OrdersRejectReturnLineItemResponse": {
"id": "OrdersRejectReturnLineItemResponse",
"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#ordersRejectReturnLineItemResponse\".",
"type": "string"
}
},
"type": "object"
},
"ReturnPolicySeasonalOverride": {
"properties": {
"policy": {
"description": "Required. The policy which is in effect during that time.",
"$ref": "ReturnPolicyPolicy"
},
"endDate": {
"description": "Required. Last day on which the override applies. In ISO 8601 format.",
"type": "string"
},
"startDate": {
"description": "Required. First day on which the override applies. In ISO 8601 format.",
"type": "string"
},
"name": {
"type": "string",
"description": "Required. The name of the seasonal override as shown in Merchant Center."
}
},
"type": "object",
"id": "ReturnPolicySeasonalOverride"
},
"LiasettingsGetAccessibleGmbAccountsResponse": {
"type": "object",
"properties": {
"gmbAccounts": {
"description": "A list of GMB accounts which are available to the merchant.",
"items": {
"$ref": "GmbAccountsGmbAccount"
},
"type": "array"
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#liasettingsGetAccessibleGmbAccountsResponse\"."
},
"accountId": {
"type": "string",
"format": "uint64",
"description": "The ID of the Merchant Center account."
}
},
"id": "LiasettingsGetAccessibleGmbAccountsResponse"
},
"OrderLineItemProductFee": {
"id": "OrderLineItemProductFee",
"type": "object",
"properties": {
"amount": {
"$ref": "Price",
"description": "Amount of the fee."
},
"name": {
"description": "Name of the fee.",
"type": "string"
}
}
},
"RepricingRule": {
"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",
"type": "object",
"id": "RepricingRule",
"properties": {
"countryCode": {
"description": "Required. Immutable. CLDR country code (e.g. \"US\").",
"type": "string"
},
"title": {
"description": "The title for the rule.",
"type": "string"
},
"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."
},
"effectiveTimePeriod": {
"$ref": "RepricingRuleEffectiveTime",
"description": "Required. Time period when the rule should take effect."
},
"merchantId": {
"type": "string",
"readOnly": true,
"description": "Output only. Immutable. Merchant that owns the repricing rule.",
"format": "int64"
},
"languageCode": {
"description": "Required. Immutable. The two-letter ISO 639-1 language code associated with the repricing rule.",
"type": "string"
},
"ruleId": {
"description": "Output only. Immutable. The ID to uniquely identify each repricing rule.",
"readOnly": true,
"type": "string"
},
"type": {
"enum": [
"REPRICING_RULE_TYPE_UNSPECIFIED",
"TYPE_WIN_BUY_BOX"
],
"type": "string",
"description": "Required. Immutable. The type of the rule.",
"enumDescriptions": [
"Unused.",
"Buy Box winning price-based rules. In Buy on Google, the Buy Box refers to the offer for a product shown at the top of the Product Detail Page (PDP) with an \"Add to Cart\" button. If this rule is chosen, your offer price will be lowered within the range you set to help increase the likelihood that you will win the Buy Box. There is no RuleDefinition needed for this type."
]
},
"restriction": {
"description": "Required. Restriction of the rule appliance.",
"$ref": "RepricingRuleRestriction"
},
"eligibleOfferMatcher": {
"$ref": "RepricingRuleEligibleOfferMatcher",
"description": "Required. Match criteria for the eligible offers."
}
}
},
"LiasettingsRequestGmbAccessResponse": {
"type": "object",
"properties": {
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#liasettingsRequestGmbAccessResponse\".",
"type": "string"
}
},
"id": "LiasettingsRequestGmbAccessResponse"
},
"ShippingsettingsGetSupportedCarriersResponse": {
"id": "ShippingsettingsGetSupportedCarriersResponse",
"properties": {
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#shippingsettingsGetSupportedCarriersResponse\".",
"type": "string"
},
"carriers": {
"description": "A list of supported carriers. May be empty.",
"items": {
"$ref": "CarriersCarrier"
},
"type": "array"
}
},
"type": "object"
},
"ProductShippingWeight": {
"id": "ProductShippingWeight",
"properties": {
"unit": {
"type": "string",
"description": "The unit of value."
},
"value": {
"format": "double",
"type": "number",
"description": "The weight of the product used to calculate the shipping cost of the item."
}
},
"type": "object"
},
"PriceAmount": {
"id": "PriceAmount",
"description": "The price represented as a number and currency.",
"properties": {
"currency": {
"type": "string",
"description": "The currency of the price."
},
"value": {
"type": "string",
"description": "The price represented as a number."
}
},
"type": "object"
},
"LocalinventoryCustomBatchResponseEntry": {
"properties": {
"errors": {
"$ref": "Errors",
"description": "A list of errors defined if and only if the request failed."
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"`content#localinventoryCustomBatchResponseEntry`\""
},
"batchId": {
"format": "uint32",
"description": "The ID of the request entry this entry responds to.",
"type": "integer"
}
},
"description": "Batch entry encoding a single local inventory update response.",
"id": "LocalinventoryCustomBatchResponseEntry",
"type": "object"
},
"OrdersUpdateShipmentResponse": {
"id": "OrdersUpdateShipmentResponse",
"properties": {
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersUpdateShipmentResponse\".",
"type": "string"
},
"executionStatus": {
"type": "string",
"description": "The status of the execution. Acceptable values are: - \"`duplicate`\" - \"`executed`\" "
}
},
"type": "object"
},
"OrderReportDisbursement": {
"description": "Order disbursement. All methods require the payment analyst role.",
"properties": {
"disbursementDate": {
"type": "string",
"description": "The date the disbursement was initiated, in ISO 8601 format."
},
"merchantId": {
"format": "uint64",
"description": "The ID of the managing account.",
"type": "string"
},
"disbursementId": {
"type": "string",
"description": "The ID of the disbursement."
},
"disbursementAmount": {
"description": "The disbursement amount.",
"$ref": "Price"
},
"disbursementCreationDate": {
"type": "string",
"description": "The disbursement date, in ISO 8601 format."
}
},
"type": "object",
"id": "OrderReportDisbursement"
},
"LiaAboutPageSettings": {
"type": "object",
"properties": {
"url": {
"description": "The URL for the About page.",
"type": "string"
},
"status": {
"description": "The status of the verification process for the About page. Acceptable values are: - \"`active`\" - \"`inactive`\" - \"`pending`\" ",
"type": "string"
}
},
"id": "LiaAboutPageSettings"
},
"PosCustomBatchResponseEntry": {
"properties": {
"batchId": {
"type": "integer",
"format": "uint32",
"description": "The ID of the request entry to which this entry responds."
},
"errors": {
"$ref": "Errors",
"description": "A list of errors defined if, and only if, the request failed."
},
"sale": {
"description": "The updated sale information.",
"$ref": "PosSale"
},
"inventory": {
"$ref": "PosInventory",
"description": "The updated inventory information."
},
"store": {
"description": "The retrieved or updated store information.",
"$ref": "PosStore"
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"`content#posCustomBatchResponseEntry`\"",
"type": "string"
}
},
"type": "object",
"id": "PosCustomBatchResponseEntry"
},
"OrderinvoicesCreateChargeInvoiceRequest": {
"type": "object",
"properties": {
"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"
},
"invoiceSummary": {
"$ref": "InvoiceSummary",
"description": "[required] Invoice summary."
},
"lineItemInvoices": {
"description": "[required] Invoice details per line item.",
"type": "array",
"items": {
"$ref": "ShipmentInvoiceLineItemInvoice"
}
},
"operationId": {
"description": "[required] The ID of the operation, unique across all operations for a given order.",
"type": "string"
},
"invoiceId": {
"description": "[required] The ID of the invoice.",
"type": "string"
}
},
"id": "OrderinvoicesCreateChargeInvoiceRequest"
},
"CarrierRate": {
"id": "CarrierRate",
"type": "object",
"properties": {
"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"
},
"carrierName": {
"description": "Carrier service, such as `\"UPS\"` or `\"Fedex\"`. The list of supported carriers can be retrieved via the `getSupportedCarriers` method. Required.",
"type": "string"
},
"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"
},
"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."
}
}
},
"MinimumOrderValueTable": {
"id": "MinimumOrderValueTable",
"properties": {
"storeCodeSetWithMovs": {
"type": "array",
"items": {
"$ref": "MinimumOrderValueTableStoreCodeSetWithMov"
}
}
},
"type": "object"
},
"Errors": {
"type": "object",
"description": "A list of errors returned by a failed batch entry.",
"properties": {
"errors": {
"items": {
"$ref": "Error"
},
"description": "A list of errors.",
"type": "array"
},
"code": {
"format": "uint32",
"type": "integer",
"description": "The HTTP status of the first error in `errors`."
},
"message": {
"type": "string",
"description": "The message of the first error in `errors`."
}
},
"id": "Errors"
},
"CustomerReturnReason": {
"properties": {
"description": {
"type": "string",
"description": "Description of the reason."
},
"reasonCode": {
"description": "Code of the return reason. Acceptable values are: - \"`betterPriceFound`\" - \"`changedMind`\" - \"`damagedOrDefectiveItem`\" - \"`didNotMatchDescription`\" - \"`doesNotFit`\" - \"`expiredItem`\" - \"`incorrectItemReceived`\" - \"`noLongerNeeded`\" - \"`notSpecified`\" - \"`orderedWrongItem`\" - \"`other`\" - \"`qualityNotExpected`\" - \"`receivedTooLate`\" - \"`undeliverable`\" ",
"type": "string"
}
},
"type": "object",
"id": "CustomerReturnReason"
},
"AccountsLinkResponse": {
"id": "AccountsLinkResponse",
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#accountsLinkResponse\"."
}
}
},
"PosCustomBatchRequest": {
"properties": {
"entries": {
"description": "The request entries to be processed in the batch.",
"type": "array",
"items": {
"$ref": "PosCustomBatchRequestEntry"
}
}
},
"type": "object",
"id": "PosCustomBatchRequest"
},
"OrdersCreateTestReturnRequest": {
"type": "object",
"properties": {
"items": {
"items": {
"$ref": "OrdersCustomBatchRequestEntryCreateTestReturnReturnItem"
},
"type": "array",
"description": "Returned items."
}
},
"id": "OrdersCreateTestReturnRequest"
},
"LinkedAccount": {
"type": "object",
"id": "LinkedAccount",
"properties": {
"services": {
"type": "array",
"items": {
"$ref": "LinkService"
},
"description": "List of provided services."
},
"linkedAccountId": {
"description": "The ID of the linked account.",
"type": "string"
}
}
},
"OrderreportsListDisbursementsResponse": {
"properties": {
"disbursements": {
"type": "array",
"description": "The list of disbursements.",
"items": {
"$ref": "OrderReportDisbursement"
}
},
"nextPageToken": {
"description": "The token for the retrieval of the next page of disbursements.",
"type": "string"
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#orderreportsListDisbursementsResponse\".",
"type": "string"
}
},
"type": "object",
"id": "OrderreportsListDisbursementsResponse"
},
"DatafeedsCustomBatchRequestEntry": {
"description": "A batch entry encoding a single non-batch datafeeds request.",
"type": "object",
"id": "DatafeedsCustomBatchRequestEntry",
"properties": {
"merchantId": {
"type": "string",
"format": "uint64",
"description": "The ID of the managing account."
},
"datafeed": {
"$ref": "Datafeed",
"description": "The data feed to insert."
},
"method": {
"type": "string",
"description": "The method of the batch entry. Acceptable values are: - \"`delete`\" - \"`fetchNow`\" - \"`get`\" - \"`insert`\" - \"`update`\" "
},
"batchId": {
"format": "uint32",
"type": "integer",
"description": "An entry ID, unique within the batch request."
},
"datafeedId": {
"format": "uint64",
"description": "The ID of the data feed to get, delete or fetch.",
"type": "string"
}
}
},
"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.",
"type": "array",
"items": {
"$ref": "Row"
}
},
"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"
},
"OrdersGetByMerchantOrderIdResponse": {
"properties": {
"order": {
"$ref": "Order",
"description": "The requested order."
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersGetByMerchantOrderIdResponse\"."
}
},
"type": "object",
"id": "OrdersGetByMerchantOrderIdResponse"
},
"LiasettingsCustomBatchRequest": {
"type": "object",
"id": "LiasettingsCustomBatchRequest",
"properties": {
"entries": {
"description": "The request entries to be processed in the batch.",
"type": "array",
"items": {
"$ref": "LiasettingsCustomBatchRequestEntry"
}
}
}
},
"TestOrderLineItemProduct": {
"properties": {
"mpn": {
"description": "Manufacturer Part Number (MPN) of the item. Optional.",
"type": "string"
},
"targetCountry": {
"description": "Required. The CLDR territory // code of the target country of the product.",
"type": "string"
},
"title": {
"type": "string",
"description": "Required. The title of the product."
},
"contentLanguage": {
"type": "string",
"description": "Required. The two-letter ISO 639-1 language code for the item. Acceptable values are: - \"`en`\" - \"`fr`\" "
},
"variantAttributes": {
"type": "array",
"items": {
"$ref": "OrderLineItemProductVariantAttribute"
},
"description": "Variant attributes for the item. Optional."
},
"price": {
"description": "Required. The price for the product. Tax is automatically calculated for orders where marketplace facilitator tax laws are applicable. Otherwise, tax settings from Merchant Center are applied.",
"$ref": "Price"
},
"offerId": {
"description": "Required. An identifier of the item.",
"type": "string"
},
"imageLink": {
"type": "string",
"description": "Required. URL of an image of the item."
},
"itemGroupId": {
"type": "string",
"description": "Shared identifier for all variants of the same product. Optional."
},
"condition": {
"type": "string",
"description": "Required. Condition or state of the item. Acceptable values are: - \"`new`\" "
},
"brand": {
"description": "Required. Brand of the item.",
"type": "string"
},
"gtin": {
"description": "Global Trade Item Number (GTIN) of the item. Optional.",
"type": "string"
},
"fees": {
"description": "Fees for the item. Optional.",
"type": "array",
"items": {
"$ref": "OrderLineItemProductFee"
}
}
},
"type": "object",
"id": "TestOrderLineItemProduct"
},
"LiasettingsSetInventoryVerificationContactResponse": {
"type": "object",
"id": "LiasettingsSetInventoryVerificationContactResponse",
"properties": {
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#liasettingsSetInventoryVerificationContactResponse\"."
}
}
},
"ProductstatusesCustomBatchRequestEntry": {
"properties": {
"batchId": {
"type": "integer",
"description": "An entry ID, unique within the batch request.",
"format": "uint32"
},
"method": {
"description": "The method of the batch entry. Acceptable values are: - \"`get`\" ",
"type": "string"
},
"destinations": {
"items": {
"type": "string"
},
"type": "array",
"description": "If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination."
},
"merchantId": {
"format": "uint64",
"description": "The ID of the managing account.",
"type": "string"
},
"includeAttributes": {
"type": "boolean"
},
"productId": {
"type": "string",
"description": "The ID of the product whose status to get."
}
},
"type": "object",
"description": "A batch entry encoding a single non-batch productstatuses request.",
"id": "ProductstatusesCustomBatchRequestEntry"
},
"ShipmentInvoice": {
"id": "ShipmentInvoice",
"type": "object",
"properties": {
"shipmentGroupId": {
"type": "string",
"description": "[required] ID of the shipment group. It is assigned by the merchant in the `shipLineItems` method and is used to group multiple line items that have the same kind of shipping charges."
},
"lineItemInvoices": {
"description": "[required] Invoice details per line item.",
"type": "array",
"items": {
"$ref": "ShipmentInvoiceLineItemInvoice"
}
},
"invoiceSummary": {
"description": "[required] Invoice summary.",
"$ref": "InvoiceSummary"
}
}
},
"OrdersListResponse": {
"type": "object",
"properties": {
"resources": {
"type": "array",
"items": {
"$ref": "Order"
}
},
"nextPageToken": {
"description": "The token for the retrieval of the next page of orders.",
"type": "string"
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersListResponse\".",
"type": "string"
}
},
"id": "OrdersListResponse"
},
"AccountUser": {
"type": "object",
"id": "AccountUser",
"properties": {
"admin": {
"type": "boolean",
"description": "Whether user is an admin."
},
"orderManager": {
"type": "boolean",
"description": "Whether user is an order manager."
},
"paymentsManager": {
"type": "boolean",
"description": "Whether user can manage payment settings."
},
"emailAddress": {
"type": "string",
"description": "User's email address."
},
"paymentsAnalyst": {
"description": "Whether user can access payment statements.",
"type": "boolean"
}
}
},
"DatafeedsCustomBatchResponse": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#datafeedsCustomBatchResponse\"."
},
"entries": {
"description": "The result of the execution of the batch requests.",
"type": "array",
"items": {
"$ref": "DatafeedsCustomBatchResponseEntry"
}
}
},
"id": "DatafeedsCustomBatchResponse"
},
"OrderreturnsProcessRequest": {
"properties": {
"fullChargeReturnShippingCost": {
"description": "Option to charge the customer return shipping cost.",
"type": "boolean"
},
"refundShippingFee": {
"description": "Refunds for original shipping fee.",
"$ref": "OrderreturnsRefundOperation"
},
"returnItems": {
"items": {
"$ref": "OrderreturnsReturnItem"
},
"description": "The list of items to return.",
"type": "array"
},
"operationId": {
"type": "string",
"description": "[required] The ID of the operation, unique across all operations for a given order return."
}
},
"type": "object",
"id": "OrderreturnsProcessRequest"
},
"ProductAmount": {
"properties": {
"taxAmount": {
"description": "Tax value.",
"$ref": "Price"
},
"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",
"id": "ProductAmount"
},
"ListRegionsResponse": {
"type": "object",
"description": "Response message for the `ListRegions` method.",
"properties": {
"regions": {
"items": {
"$ref": "Region"
},
"type": "array",
"description": "The regions from the specified merchant."
},
"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."
}
},
"id": "ListRegionsResponse"
},
"OrderreturnsCreateOrderReturnRequest": {
"id": "OrderreturnsCreateOrderReturnRequest",
"properties": {
"lineItems": {
"description": "The list of line items to return.",
"type": "array",
"items": {
"$ref": "OrderreturnsLineItem"
}
},
"returnMethodType": {
"type": "string",
"description": "The way of the package being returned."
},
"orderId": {
"type": "string",
"description": "The ID of the order."
},
"operationId": {
"type": "string",
"description": "The ID of the operation. Unique across all operations for a given order."
}
},
"type": "object"
},
"OrderReportTransaction": {
"properties": {
"productAmount": {
"description": "Total amount for the items.",
"$ref": "ProductAmount"
},
"disbursementDate": {
"description": "The date the disbursement was initiated, in ISO 8601 format.",
"type": "string"
},
"disbursementCreationDate": {
"description": "The date the disbursement was created, in ISO 8601 format.",
"type": "string"
},
"disbursementId": {
"type": "string",
"description": "The ID of the disbursement."
},
"merchantOrderId": {
"type": "string",
"description": "Merchant-provided ID of the order."
},
"orderId": {
"description": "The ID of the order.",
"type": "string"
},
"transactionDate": {
"description": "The date of the transaction, in ISO 8601 format.",
"type": "string"
},
"disbursementAmount": {
"$ref": "Price",
"description": "The disbursement amount."
},
"merchantId": {
"format": "uint64",
"type": "string",
"description": "The ID of the managing account."
}
},
"type": "object",
"id": "OrderReportTransaction"
},
"AccountsUpdateLabelsRequest": {
"properties": {
"labelIds": {
"items": {
"format": "uint64",
"type": "string"
},
"description": "The IDs of labels that should be assigned to the account.",
"type": "array"
}
},
"type": "object",
"id": "AccountsUpdateLabelsRequest"
},
"OrdersInStoreRefundLineItemResponse": {
"properties": {
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersInStoreRefundLineItemResponse\".",
"type": "string"
},
"executionStatus": {
"description": "The status of the execution. Acceptable values are: - \"`duplicate`\" - \"`executed`\" ",
"type": "string"
}
},
"id": "OrdersInStoreRefundLineItemResponse",
"type": "object"
},
"OrdersCreateTestReturnResponse": {
"properties": {
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersCreateTestReturnResponse\".",
"type": "string"
},
"returnId": {
"description": "The ID of the newly created test order return.",
"type": "string"
}
},
"id": "OrdersCreateTestReturnResponse",
"type": "object"
},
"UnitInvoiceTaxLine": {
"id": "UnitInvoiceTaxLine",
"properties": {
"taxType": {
"type": "string",
"description": "[required] Type of the tax. Acceptable values are: - \"`otherFee`\" - \"`otherFeeTax`\" - \"`sales`\" "
},
"taxName": {
"description": "Optional name of the tax type. This should only be provided if `taxType` is `otherFeeTax`.",
"type": "string"
},
"taxAmount": {
"$ref": "Price",
"description": "[required] Tax amount for the tax type."
}
},
"type": "object"
},
"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"
}
},
"id": "ProductstatusesListResponse",
"type": "object"
},
"PosDataProvidersPosDataProvider": {
"properties": {
"fullName": {
"description": "The full name of this POS data Provider.",
"type": "string"
},
"providerId": {
"format": "uint64",
"description": "The ID of the account.",
"type": "string"
},
"displayName": {
"type": "string",
"description": "The display name of Pos data Provider."
}
},
"id": "PosDataProvidersPosDataProvider",
"type": "object"
},
"RepricingRuleEligibleOfferMatcherStringMatcher": {
"description": "Matcher by string attributes.",
"id": "RepricingRuleEligibleOfferMatcherStringMatcher",
"type": "object",
"properties": {
"strAttributes": {
"type": "array",
"items": {
"type": "string"
},
"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."
}
}
},
"AccounttaxCustomBatchResponse": {
"properties": {
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#accounttaxCustomBatchResponse\"."
},
"entries": {
"items": {
"$ref": "AccounttaxCustomBatchResponseEntry"
},
"description": "The result of the execution of the batch requests.",
"type": "array"
}
},
"type": "object",
"id": "AccounttaxCustomBatchResponse"
},
"OrdersCustomBatchRequestEntryShipLineItemsShipmentInfo": {
"properties": {
"carrier": {
"type": "string",
"description": "The carrier handling the shipment. See `shipments[].carrier` in the Orders resource representation for a list of acceptable values."
},
"shipmentId": {
"type": "string",
"description": "Required. The ID of the shipment. This is assigned by the merchant and is unique to each shipment."
},
"trackingId": {
"type": "string",
"description": "The tracking ID for the shipment."
}
},
"type": "object",
"id": "OrdersCustomBatchRequestEntryShipLineItemsShipmentInfo"
},
"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."
},
"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": {
"description": "New status for the shipment. Not updated if missing. Acceptable values are: - \"`delivered`\" - \"`undeliverable`\" - \"`readyForPickup`\" ",
"type": "string"
},
"operationId": {
"description": "The ID of the operation. Unique across all operations for a given order.",
"type": "string"
},
"shipmentId": {
"type": "string",
"description": "The ID of the shipment."
},
"trackingId": {
"description": "The tracking ID for the shipment. Not updated if missing.",
"type": "string"
},
"readyPickupDate": {
"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`.",
"type": "string"
},
"deliveryDate": {
"description": "Date on which the shipment has been delivered, in ISO 8601 format. Optional and can be provided only if `status` is `delivered`.",
"type": "string"
},
"lastPickupDate": {
"type": "string",
"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`."
}
},
"id": "OrdersUpdateShipmentRequest",
"type": "object"
},
"RegionalinventoryCustomBatchResponse": {
"type": "object",
"id": "RegionalinventoryCustomBatchResponse",
"properties": {
"entries": {
"description": "The result of the execution of the batch requests.",
"items": {
"$ref": "RegionalinventoryCustomBatchResponseEntry"
},
"type": "array"
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#regionalinventoryCustomBatchResponse\".",
"type": "string"
}
}
},
"DatafeedFormat": {
"id": "DatafeedFormat",
"properties": {
"fileEncoding": {
"type": "string",
"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`\" "
},
"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"
},
"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"
},
"ShippingSettings": {
"description": "The merchant account's shipping settings. All methods except getsupportedcarriers and getsupportedholidays require the admin role.",
"type": "object",
"properties": {
"accountId": {
"format": "uint64",
"description": "The ID of the account to which these account shipping settings belong. Ignored upon update, always present in get request responses.",
"type": "string"
},
"services": {
"items": {
"$ref": "Service"
},
"description": "The target account's list of services. Optional.",
"type": "array"
},
"postalCodeGroups": {
"items": {
"$ref": "PostalCodeGroup"
},
"type": "array",
"description": "A list of postal code groups that can be referred to in `services`. Optional."
}
},
"id": "ShippingSettings"
},
"LiasettingsListPosDataProvidersResponse": {
"properties": {
"posDataProviders": {
"type": "array",
"items": {
"$ref": "PosDataProviders"
},
"description": "The list of POS data providers for each eligible country"
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#liasettingsListPosDataProvidersResponse\"."
}
},
"id": "LiasettingsListPosDataProvidersResponse",
"type": "object"
},
"AccounttaxCustomBatchRequestEntry": {
"properties": {
"batchId": {
"description": "An entry ID, unique within the batch request.",
"type": "integer",
"format": "uint32"
},
"accountTax": {
"description": "The account tax settings to update. Only defined if the method is `update`.",
"$ref": "AccountTax"
},
"merchantId": {
"type": "string",
"description": "The ID of the managing account.",
"format": "uint64"
},
"method": {
"description": "The method of the batch entry. Acceptable values are: - \"`get`\" - \"`update`\" ",
"type": "string"
},
"accountId": {
"format": "uint64",
"description": "The ID of the account for which to get/update account tax settings.",
"type": "string"
}
},
"description": "A batch entry encoding a single non-batch accounttax request.",
"id": "AccounttaxCustomBatchRequestEntry",
"type": "object"
},
"AccounttaxListResponse": {
"type": "object",
"properties": {
"resources": {
"items": {
"$ref": "AccountTax"
},
"type": "array"
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#accounttaxListResponse\".",
"type": "string"
},
"nextPageToken": {
"type": "string",
"description": "The token for the retrieval of the next page of account tax settings."
}
},
"id": "AccounttaxListResponse"
},
"OrderLineItemProduct": {
"type": "object",
"id": "OrderLineItemProduct",
"properties": {
"mpn": {
"description": "Manufacturer Part Number (MPN) of the item.",
"type": "string"
},
"imageLink": {
"description": "URL of an image of the item.",
"type": "string"
},
"fees": {
"items": {
"$ref": "OrderLineItemProductFee"
},
"description": "Associated fees at order creation time.",
"type": "array"
},
"contentLanguage": {
"description": "The two-letter ISO 639-1 language code for the item.",
"type": "string"
},
"variantAttributes": {
"type": "array",
"items": {
"$ref": "OrderLineItemProductVariantAttribute"
},
"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."
},
"price": {
"$ref": "Price",
"description": "Price of the item."
},
"title": {
"description": "The title of the product.",
"type": "string"
},
"offerId": {
"description": "An identifier of the item.",
"type": "string"
},
"targetCountry": {
"type": "string",
"description": "The CLDR territory // code of the target country of the product."
},
"itemGroupId": {
"description": "Shared identifier for all variants of the same product.",
"type": "string"
},
"gtin": {
"type": "string",
"description": "Global Trade Item Number (GTIN) of the item."
},
"condition": {
"type": "string",
"description": "Condition or state of the item. Acceptable values are: - \"`new`\" - \"`refurbished`\" - \"`used`\" "
},
"brand": {
"description": "Brand of the item.",
"type": "string"
},
"id": {
"type": "string",
"description": "The REST ID of the product."
},
"shownImage": {
"description": "URL to the cached image shown to the user when order was placed.",
"type": "string"
}
}
},
"CutoffTime": {
"id": "CutoffTime",
"type": "object",
"properties": {
"hour": {
"type": "integer",
"format": "uint32",
"description": "Hour of the cutoff time until which an order has to be placed to be processed in the same day. Required."
},
"minute": {
"description": "Minute 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"
}
}
},
"ProductstatusesCustomBatchResponseEntry": {
"description": "A batch entry encoding a single non-batch productstatuses response.",
"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#productstatusesCustomBatchResponseEntry`\"",
"type": "string"
},
"productStatus": {
"description": "The requested product status. Only defined if the request was successful.",
"$ref": "ProductStatus"
},
"errors": {
"description": "A list of errors, if the request failed.",
"$ref": "Errors"
}
},
"id": "ProductstatusesCustomBatchResponseEntry",
"type": "object"
},
"DatafeedsCustomBatchRequest": {
"id": "DatafeedsCustomBatchRequest",
"type": "object",
"properties": {
"entries": {
"description": "The request entries to be processed in the batch.",
"items": {
"$ref": "DatafeedsCustomBatchRequestEntry"
},
"type": "array"
}
}
},
"OrdersSetLineItemMetadataRequest": {
"properties": {
"lineItemId": {
"description": "The ID of the line item to set metadata. Either lineItemId or productId is required.",
"type": "string"
},
"productId": {
"type": "string",
"description": "The ID of the product to set metadata. This is the REST ID used in the products service. Either lineItemId or productId is required."
},
"annotations": {
"type": "array",
"items": {
"$ref": "OrderMerchantProvidedAnnotation"
}
},
"operationId": {
"description": "The ID of the operation. Unique across all operations for a given order.",
"type": "string"
}
},
"id": "OrdersSetLineItemMetadataRequest",
"type": "object"
},
"OrdersShipLineItemsRequest": {
"properties": {
"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)."
},
"lineItems": {
"items": {
"$ref": "OrderShipmentLineItemShipment"
},
"description": "Line items to ship.",
"type": "array"
},
"shipmentGroupId": {
"description": "ID of the shipment group. Required for orders that use the orderinvoices service.",
"type": "string"
},
"operationId": {
"description": "The ID of the operation. Unique across all operations for a given order.",
"type": "string"
}
},
"type": "object",
"id": "OrdersShipLineItemsRequest"
},
"OrdersShipLineItemsResponse": {
"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#ordersShipLineItemsResponse\"."
}
},
"id": "OrdersShipLineItemsResponse",
"type": "object"
},
"Row": {
"type": "object",
"properties": {
"cells": {
"type": "array",
"description": "The list of cells that constitute the row. Must have the same length as `columnHeaders` for two-dimensional tables, a length of 1 for one-dimensional tables. Required.",
"items": {
"$ref": "Value"
}
}
},
"id": "Row"
},
"ReturnaddressListResponse": {
"properties": {
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#returnaddressListResponse\"."
},
"nextPageToken": {
"description": "The token for the retrieval of the next page of addresses.",
"type": "string"
},
"resources": {
"type": "array",
"items": {
"$ref": "ReturnAddress"
}
}
},
"id": "ReturnaddressListResponse",
"type": "object"
},
"ShipmentTrackingInfo": {
"properties": {
"trackingNumber": {
"description": "The tracking number for the package.",
"type": "string"
},
"carrier": {
"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`\" ",
"type": "string"
}
},
"type": "object",
"id": "ShipmentTrackingInfo"
},
"LocalInventory": {
"properties": {
"availability": {
"type": "string",
"description": "Availability of the product. For accepted attribute values, see the local product inventory feed specification."
},
"instoreProductLocation": {
"type": "string",
"description": "In-store product location."
},
"storeCode": {
"type": "string",
"description": "Required. Store code of this local inventory resource."
},
"quantity": {
"description": "Quantity of the product. Must be nonnegative.",
"type": "integer",
"format": "uint32"
},
"pickupMethod": {
"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.",
"type": "string"
},
"pickupSla": {
"type": "string",
"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."
},
"salePriceEffectiveDate": {
"type": "string",
"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."
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"`content#localInventory`\"",
"type": "string"
},
"price": {
"description": "Price of the product.",
"$ref": "Price"
},
"salePrice": {
"$ref": "Price",
"description": "Sale price of the product. Mandatory if `sale_price_effective_date` is defined."
}
},
"type": "object",
"description": "Local inventory resource. For accepted attribute values, see the local product inventory feed specification.",
"id": "LocalInventory"
},
"PosSale": {
"properties": {
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"`content#posSale`\""
},
"targetCountry": {
"description": "Required. The CLDR territory code for the item.",
"type": "string"
},
"quantity": {
"format": "int64",
"type": "string",
"description": "Required. The relative change of the available quantity. Negative for items returned."
},
"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."
},
"itemId": {
"description": "Required. A unique identifier for the item.",
"type": "string"
},
"contentLanguage": {
"description": "Required. The two-letter ISO 639-1 language code for the item.",
"type": "string"
},
"gtin": {
"description": "Global Trade Item Number.",
"type": "string"
},
"saleId": {
"type": "string",
"description": "A unique ID to group items from the same sale event."
},
"timestamp": {
"description": "Required. The inventory timestamp, in ISO 8601 format.",
"type": "string"
},
"price": {
"description": "Required. The price of the item.",
"$ref": "Price"
}
},
"description": "The change of the available quantity of an item at the given store.",
"type": "object",
"id": "PosSale"
},
"Datafeed": {
"description": "Datafeed configuration data.",
"properties": {
"targets": {
"items": {
"$ref": "DatafeedTarget"
},
"type": "array",
"description": "The targets this feed should apply to (country, language, destinations)."
},
"format": {
"description": "Format of the feed file.",
"$ref": "DatafeedFormat"
},
"fileName": {
"description": "Required. The filename of the feed. All feeds must have a unique file name.",
"type": "string"
},
"id": {
"type": "string",
"description": "Required for update. The ID of the data feed.",
"format": "int64"
},
"contentType": {
"type": "string",
"description": "Required. The type of data feed. For product inventory feeds, only feeds for local stores, not online stores, are supported. Acceptable values are: - \"`local products`\" - \"`product inventory`\" - \"`products`\" "
},
"fetchSchedule": {
"description": "Fetch schedule for the feed file.",
"$ref": "DatafeedFetchSchedule"
},
"name": {
"description": "Required for insert. A descriptive name of the data feed.",
"type": "string"
},
"attributeLanguage": {
"type": "string",
"description": "The two-letter ISO 639-1 language in which the attributes are defined in the data feed."
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"`content#datafeed`\""
}
},
"type": "object",
"id": "Datafeed"
},
"OrderLineItem": {
"properties": {
"id": {
"type": "string",
"description": "The ID of the line item."
},
"cancellations": {
"type": "array",
"items": {
"$ref": "OrderCancellation"
},
"description": "Cancellations of the line item."
},
"quantityCanceled": {
"type": "integer",
"description": "Number of items canceled.",
"format": "uint32"
},
"quantityReadyForPickup": {
"type": "integer",
"description": "Number of items ready for pickup.",
"format": "uint32"
},
"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."
},
"quantityPending": {
"format": "uint32",
"description": "Number of items pending.",
"type": "integer"
},
"quantityUndeliverable": {
"format": "uint32",
"description": "Number of items undeliverable.",
"type": "integer"
},
"adjustments": {
"items": {
"$ref": "OrderLineItemAdjustment"
},
"type": "array",
"description": "Price and tax adjustments applied on the line item."
},
"returnInfo": {
"$ref": "OrderLineItemReturnInfo",
"description": "Details of the return policy for the line item."
},
"returns": {
"description": "Returns of the line item.",
"type": "array",
"items": {
"$ref": "OrderReturn"
}
},
"price": {
"description": "Total price for the line item. For example, if two items for $10 are purchased, the total price will be $20.",
"$ref": "Price"
},
"quantityDelivered": {
"format": "uint32",
"type": "integer",
"description": "Number of items delivered."
},
"quantityOrdered": {
"format": "uint32",
"description": "Number of items ordered.",
"type": "integer"
},
"tax": {
"$ref": "Price",
"description": "Total tax amount for the line item. For example, if two items are purchased, and each have a cost tax of $2, the total tax amount will be $4."
},
"annotations": {
"description": "Annotations that are attached to the line item.",
"items": {
"$ref": "OrderMerchantProvidedAnnotation"
},
"type": "array"
},
"quantityReturned": {
"type": "integer",
"description": "Number of items returned.",
"format": "uint32"
},
"quantityShipped": {
"format": "uint32",
"type": "integer",
"description": "Number of items shipped."
},
"shippingDetails": {
"description": "Details of the requested shipping for the line item.",
"$ref": "OrderLineItemShippingDetails"
}
},
"type": "object",
"id": "OrderLineItem"
},
"OrderCustomerLoyaltyInfo": {
"id": "OrderCustomerLoyaltyInfo",
"type": "object",
"properties": {
"loyaltyNumber": {
"type": "string",
"description": "The loyalty card/membership number."
},
"name": {
"description": "Name of card/membership holder, this field will be populated when",
"type": "string"
}
}
},
"OrdersCancelRequest": {
"properties": {
"reasonText": {
"type": "string",
"description": "The explanation of the reason."
},
"operationId": {
"type": "string",
"description": "The ID of the operation. Unique across all operations for a given order."
},
"reason": {
"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"
},
"AccountBusinessInformation": {
"properties": {
"phoneNumber": {
"type": "string",
"description": "The phone number of the business."
},
"customerService": {
"$ref": "AccountCustomerService",
"description": "The customer service information of the business."
},
"address": {
"$ref": "AccountAddress",
"description": "The address of the business."
}
},
"type": "object",
"id": "AccountBusinessInformation"
},
"PosInventory": {
"type": "object",
"description": "The absolute quantity of an item available at the given store.",
"properties": {
"itemId": {
"description": "Required. A unique identifier for the item.",
"type": "string"
},
"contentLanguage": {
"type": "string",
"description": "Required. The two-letter ISO 639-1 language code for the item."
},
"storeCode": {
"type": "string",
"description": "Required. The identifier of the merchant's store. Either a `storeCode` inserted via the API or the code of the store in Google My Business."
},
"targetCountry": {
"description": "Required. The CLDR territory code for the item.",
"type": "string"
},
"gtin": {
"description": "Global Trade Item Number.",
"type": "string"
},
"quantity": {
"format": "int64",
"type": "string",
"description": "Required. The available quantity of the item."
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"`content#posInventory`\""
},
"timestamp": {
"description": "Required. The inventory timestamp, in ISO 8601 format.",
"type": "string"
},
"price": {
"description": "Required. The current price of the item.",
"$ref": "Price"
}
},
"id": "PosInventory"
},
"RepricingRuleEffectiveTimeFixedTimePeriod": {
"properties": {
"startTime": {
"description": "The start time (inclusive) of the period. It can only be hour granularity.",
"format": "google-datetime",
"type": "string"
},
"endTime": {
"description": "The end time (exclusive) of the period. It can only be hour granularity.",
"type": "string",
"format": "google-datetime"
}
},
"id": "RepricingRuleEffectiveTimeFixedTimePeriod",
"description": "Definition of a fixed time period.",
"type": "object"
},
"ShippingsettingsCustomBatchResponseEntry": {
"id": "ShippingsettingsCustomBatchResponseEntry",
"type": "object",
"description": "A batch entry encoding a single non-batch shipping settings response.",
"properties": {
"errors": {
"description": "A list of errors defined if, and only if, the request failed.",
"$ref": "Errors"
},
"shippingSettings": {
"$ref": "ShippingSettings",
"description": "The retrieved or updated account shipping settings."
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"`content#shippingsettingsCustomBatchResponseEntry`\""
},
"batchId": {
"type": "integer",
"description": "The ID of the request entry to which this entry responds.",
"format": "uint32"
}
}
},
"OrderreturnsReturnItem": {
"id": "OrderreturnsReturnItem",
"type": "object",
"properties": {
"returnItemId": {
"type": "string",
"description": "Unit level ID for the return item. Different units of the same product will have different IDs."
},
"reject": {
"description": "Rejects the item.",
"$ref": "OrderreturnsRejectOperation"
},
"refund": {
"description": "Refunds the item.",
"$ref": "OrderreturnsRefundOperation"
}
}
},
"PosCustomBatchResponse": {
"id": "PosCustomBatchResponse",
"properties": {
"entries": {
"items": {
"$ref": "PosCustomBatchResponseEntry"
},
"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#posCustomBatchResponse\".",
"type": "string"
}
},
"type": "object"
},
"OrderreportsListTransactionsResponse": {
"type": "object",
"properties": {
"nextPageToken": {
"description": "The token for the retrieval of the next page of transactions.",
"type": "string"
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#orderreportsListTransactionsResponse\".",
"type": "string"
},
"transactions": {
"type": "array",
"items": {
"$ref": "OrderReportTransaction"
},
"description": "The list of transactions."
}
},
"id": "OrderreportsListTransactionsResponse"
},
"OrderinvoicesCreateRefundInvoiceRequest": {
"id": "OrderinvoicesCreateRefundInvoiceRequest",
"type": "object",
"properties": {
"operationId": {
"description": "[required] The ID of the operation, unique across all operations for a given order.",
"type": "string"
},
"returnOption": {
"$ref": "OrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceReturnOption",
"description": "Option to create an invoice for a refund and mark all items within the invoice as returned. Exactly one of `refundOnlyOption` or `returnOption` must be provided."
},
"shipmentInvoices": {
"items": {
"$ref": "ShipmentInvoice"
},
"description": "Invoice details for different shipment groups.",
"type": "array"
},
"refundOnlyOption": {
"$ref": "OrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceRefundOption",
"description": "Option to create a refund-only invoice. Exactly one of `refundOnlyOption` or `returnOption` must be provided."
},
"invoiceId": {
"description": "[required] The ID of the invoice.",
"type": "string"
}
}
},
"OrdersReturnRefundLineItemRequest": {
"id": "OrdersReturnRefundLineItemRequest",
"properties": {
"operationId": {
"type": "string",
"description": "The ID of the operation. Unique across all operations for a given order."
},
"quantity": {
"format": "uint32",
"type": "integer",
"description": "The quantity to return and refund."
},
"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": {
"type": "string",
"description": "The ID of the line item to return. Either lineItemId or productId is required."
},
"taxAmount": {
"description": "The amount of tax to be refunded. Optional, but if filled, then priceAmount must be set. Calculated automatically if not provided.",
"$ref": "Price"
},
"reason": {
"type": "string",
"description": "The reason for the return. Acceptable values are: - \"`customerDiscretionaryReturn`\" - \"`customerInitiatedMerchantCancel`\" - \"`deliveredTooLate`\" - \"`expiredItem`\" - \"`invalidCoupon`\" - \"`malformedShippingAddress`\" - \"`other`\" - \"`productArrivedDamaged`\" - \"`productNotAsDescribed`\" - \"`qualityNotAsExpected`\" - \"`undeliverableShippingAddress`\" - \"`unsupportedPoBoxAddress`\" - \"`wrongProductShipped`\" "
},
"reasonText": {
"description": "The explanation of the reason.",
"type": "string"
},
"priceAmount": {
"$ref": "Price",
"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."
}
},
"type": "object"
},
"RepricingRuleRestrictionBoundary": {
"type": "object",
"properties": {
"percentageDelta": {
"type": "integer",
"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.",
"format": "int32"
},
"priceDelta": {
"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.",
"type": "string"
}
},
"id": "RepricingRuleRestrictionBoundary",
"description": "Definition of a boundary."
},
"DatafeedstatusesCustomBatchResponse": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#datafeedstatusesCustomBatchResponse\"."
},
"entries": {
"items": {
"$ref": "DatafeedstatusesCustomBatchResponseEntry"
},
"type": "array",
"description": "The result of the execution of the batch requests."
}
},
"id": "DatafeedstatusesCustomBatchResponse"
},
"AccountstatusesCustomBatchResponseEntry": {
"properties": {
"errors": {
"$ref": "Errors",
"description": "A list of errors defined if and only if the request failed."
},
"batchId": {
"format": "uint32",
"type": "integer",
"description": "The ID of the request entry this entry responds to."
},
"accountStatus": {
"$ref": "AccountStatus",
"description": "The requested account status. Defined if and only if the request was successful."
}
},
"type": "object",
"id": "AccountstatusesCustomBatchResponseEntry",
"description": "A batch entry encoding a single non-batch accountstatuses response."
},
"SettlementReport": {
"type": "object",
"description": " Settlement reports detail order-level and item-level credits and debits between you and Google.",
"id": "SettlementReport",
"properties": {
"settlementId": {
"description": "The ID of the settlement report.",
"type": "string"
},
"endDate": {
"type": "string",
"description": "The end date on which all transactions are included in the report, in ISO 8601 format."
},
"transferIds": {
"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.",
"items": {
"type": "string"
},
"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"
},
"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."
},
"startDate": {
"description": "The start date on which all transactions are included in the report, in ISO 8601 format.",
"type": "string"
},
"transferAmount": {
"description": "The money due to the merchant.",
"$ref": "Price"
}
}
},
"OrderReturn": {
"type": "object",
"id": "OrderReturn",
"properties": {
"quantity": {
"description": "Quantity that is returned.",
"format": "uint32",
"type": "integer"
},
"reason": {
"description": "The reason for the return. Acceptable values are: - \"`customerDiscretionaryReturn`\" - \"`customerInitiatedMerchantCancel`\" - \"`deliveredTooLate`\" - \"`expiredItem`\" - \"`invalidCoupon`\" - \"`malformedShippingAddress`\" - \"`other`\" - \"`productArrivedDamaged`\" - \"`productNotAsDescribed`\" - \"`qualityNotAsExpected`\" - \"`undeliverableShippingAddress`\" - \"`unsupportedPoBoxAddress`\" - \"`wrongProductShipped`\" ",
"type": "string"
},
"actor": {
"type": "string",
"description": "The actor that created the refund. Acceptable values are: - \"`customer`\" - \"`googleBot`\" - \"`googleCustomerService`\" - \"`googlePayments`\" - \"`googleSabre`\" - \"`merchant`\" "
},
"creationDate": {
"type": "string",
"description": "Date on which the item has been created, in ISO 8601 format."
},
"reasonText": {
"description": "The explanation of the reason.",
"type": "string"
}
}
},
"DatafeedStatus": {
"type": "object",
"id": "DatafeedStatus",
"description": "The status of a datafeed, i.e., the result of the last retrieval of the datafeed computed asynchronously when the feed processing is finished.",
"properties": {
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"`content#datafeedStatus`\""
},
"datafeedId": {
"description": "The ID of the feed for which the status is reported.",
"format": "uint64",
"type": "string"
},
"processingStatus": {
"type": "string",
"description": "The processing status of the feed. Acceptable values are: - \"`\"`failure`\": The feed could not be processed or all items had errors.`\" - \"`in progress`\": The feed is being processed. - \"`none`\": The feed has not yet been processed. For example, a feed that has never been uploaded will have this processing status. - \"`success`\": The feed was processed successfully, though some items might have had errors. "
},
"country": {
"description": "The country for which the status is reported, represented as a CLDR territory code.",
"type": "string"
},
"errors": {
"type": "array",
"description": "The list of errors occurring in the feed.",
"items": {
"$ref": "DatafeedStatusError"
}
},
"itemsValid": {
"type": "string",
"format": "uint64",
"description": "The number of items in the feed that were valid."
},
"itemsTotal": {
"description": "The number of items in the feed that were processed.",
"type": "string",
"format": "uint64"
},
"language": {
"type": "string",
"description": "The two-letter ISO 639-1 language for which the status is reported."
},
"lastUploadDate": {
"type": "string",
"description": "The last date at which the feed was uploaded."
},
"warnings": {
"items": {
"$ref": "DatafeedStatusError"
},
"type": "array",
"description": "The list of errors occurring in the feed."
}
}
},
"AccountLabel": {
"description": "Label assigned by CSS domain or CSS group to one of its sub-accounts.",
"type": "object",
"id": "AccountLabel",
"properties": {
"accountId": {
"readOnly": true,
"format": "int64",
"description": "Output only. Immutable. The ID of account this label belongs to.",
"type": "string"
},
"description": {
"description": "Description for this label.",
"type": "string"
},
"name": {
"description": "The display name of this label.",
"type": "string"
},
"labelId": {
"format": "int64",
"type": "string",
"readOnly": true,
"description": "Output only. Immutable. The ID of the label."
}
}
},
"OrdersUpdateMerchantOrderIdRequest": {
"properties": {
"operationId": {
"type": "string",
"description": "The ID of the operation. Unique across all operations for a given order."
},
"merchantOrderId": {
"type": "string",
"description": "The merchant order id to be assigned to the order. Must be unique per merchant."
}
},
"id": "OrdersUpdateMerchantOrderIdRequest",
"type": "object"
},
"PickupCarrierService": {
"id": "PickupCarrierService",
"properties": {
"carrierName": {
"description": "The name of the pickup carrier (e.g., `\"UPS\"`). Required.",
"type": "string"
},
"serviceName": {
"type": "string",
"description": "The name of the pickup service (e.g., `\"Access point\"`). Required."
}
},
"type": "object"
},
"ProductUnitPricingBaseMeasure": {
"properties": {
"unit": {
"type": "string",
"description": "The unit of the denominator."
},
"value": {
"description": "The denominator of the unit price.",
"format": "int64",
"type": "string"
}
},
"id": "ProductUnitPricingBaseMeasure",
"type": "object"
},
"AccountsCustomBatchRequestEntry": {
"type": "object",
"description": "A batch entry encoding a single non-batch accounts request.",
"properties": {
"batchId": {
"description": "An entry ID, unique within the batch request.",
"type": "integer",
"format": "uint32"
},
"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"
},
"merchantId": {
"description": "The ID of the managing account.",
"type": "string",
"format": "uint64"
},
"force": {
"type": "boolean",
"description": "Whether the account should be deleted if the account has offers. Only applicable if the method is `delete`."
},
"accountId": {
"description": "The ID of the targeted account. Only defined if the method is not `insert`.",
"format": "uint64",
"type": "string"
},
"view": {
"description": "Controls which fields are visible. Only applicable if the method is 'get'.",
"type": "string"
},
"method": {
"description": "The method of the batch entry. Acceptable values are: - \"`claimWebsite`\" - \"`delete`\" - \"`get`\" - \"`insert`\" - \"`link`\" - \"`update`\" ",
"type": "string"
},
"labelIds": {
"description": "Label IDs for the 'updatelabels' request.",
"type": "array",
"items": {
"format": "uint64",
"type": "string"
}
},
"linkRequest": {
"$ref": "AccountsCustomBatchRequestEntryLinkRequest",
"description": "Details about the `link` request."
},
"account": {
"$ref": "Account",
"description": "The account to create or update. Only defined if the method is `insert` or `update`."
}
},
"id": "AccountsCustomBatchRequestEntry"
},
"OrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceRefundOption": {
"id": "OrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceRefundOption",
"type": "object",
"properties": {
"reason": {
"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`\" ",
"type": "string"
},
"description": {
"type": "string",
"description": "Optional description of the refund reason."
}
}
},
"LiaInventorySettings": {
"type": "object",
"id": "LiaInventorySettings",
"properties": {
"status": {
"type": "string",
"description": "The status of the inventory verification process. Acceptable values are: - \"`active`\" - \"`inactive`\" - \"`pending`\" "
},
"inventoryVerificationContactStatus": {
"type": "string",
"description": "The status of the verification contact. Acceptable values are: - \"`active`\" - \"`inactive`\" - \"`pending`\" "
},
"inventoryVerificationContactName": {
"description": "The name of the contact for the inventory verification process.",
"type": "string"
},
"inventoryVerificationContactEmail": {
"description": "The email of the contact for the inventory verification process.",
"type": "string"
}
}
},
"MonetaryAmount": {
"properties": {
"taxAmount": {
"$ref": "Price",
"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`."
},
"priceAmount": {
"$ref": "Price",
"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 ."
}
},
"type": "object",
"id": "MonetaryAmount"
},
"OrderShipment": {
"properties": {
"creationDate": {
"type": "string",
"description": "Date on which the shipment has been created, in ISO 8601 format."
},
"carrier": {
"type": "string",
"description": "The carrier handling the shipment. For supported carriers, Google includes the carrier name and tracking URL in emails to customers. For select supported carriers, Google also automatically updates the shipment status based on the provided shipment ID. *Note:* You can also use unsupported carriers, but emails to customers will not include the carrier name or tracking URL, and there will be no automatic order status updates. Supported carriers for US are: - \"`ups`\" (United Parcel Service) *automatic status updates* - \"`usps`\" (United States Postal Service) *automatic status updates* - \"`fedex`\" (FedEx) *automatic status updates * - \"`dhl`\" (DHL eCommerce) *automatic status updates* (US only) - \"`ontrac`\" (OnTrac) *automatic status updates * - \"`dhl express`\" (DHL Express) - \"`deliv`\" (Deliv) - \"`dynamex`\" (TForce) - \"`lasership`\" (LaserShip) - \"`mpx`\" (Military Parcel Xpress) - \"`uds`\" (United Delivery Service) - \"`efw`\" (Estes Forwarding Worldwide) - \"`jd logistics`\" (JD Logistics) - \"`yunexpress`\" (YunExpress) - \"`china post`\" (China Post) - \"`china ems`\" (China Post Express Mail Service) - \"`singapore post`\" (Singapore Post) - \"`pos malaysia`\" (Pos Malaysia) - \"`postnl`\" (PostNL) - \"`ptt`\" (PTT Turkish Post) - \"`eub`\" (ePacket) - \"`chukou1`\" (Chukou1 Logistics) - \"`bestex`\" (Best Express) - \"`canada post`\" (Canada Post) - \"`purolator`\" (Purolator) - \"`canpar`\" (Canpar) - \"`india post`\" (India Post) - \"`blue dart`\" (Blue Dart) - \"`delhivery`\" (Delhivery) - \"`dtdc`\" (DTDC) - \"`tpc india`\" (TPC India) Supported carriers for FR are: - \"`la poste`\" (La Poste) *automatic status updates * - \"`colissimo`\" (Colissimo by La Poste) *automatic status updates* - \"`ups`\" (United Parcel Service) *automatic status updates * - \"`chronopost`\" (Chronopost by La Poste) - \"`gls`\" (General Logistics Systems France) - \"`dpd`\" (DPD Group by GeoPost) - \"`bpost`\" (Belgian Post Group) - \"`colis prive`\" (Colis Privé) - \"`boxtal`\" (Boxtal) - \"`geodis`\" (GEODIS) - \"`tnt`\" (TNT) - \"`db schenker`\" (DB Schenker) - \"`aramex`\" (Aramex) "
},
"scheduledDeliveryDetails": {
"$ref": "OrderShipmentScheduledDeliveryDetails",
"description": "Delivery details of the shipment if scheduling is needed."
},
"deliveryDate": {
"type": "string",
"description": "Date on which the shipment has been delivered, in ISO 8601 format. Present only if `status` is `delivered`"
},
"id": {
"type": "string",
"description": "The ID of the shipment."
},
"trackingId": {
"type": "string",
"description": "The tracking ID for the shipment."
},
"shipmentGroupId": {
"description": "The shipment group ID of the shipment. This is set in shiplineitems request.",
"type": "string"
},
"lineItems": {
"description": "The line items that are shipped.",
"items": {
"$ref": "OrderShipmentLineItemShipment"
},
"type": "array"
},
"status": {
"description": "The status of the shipment. Acceptable values are: - \"`delivered`\" - \"`readyForPickup`\" - \"`shipped`\" - \"`undeliverable`\" ",
"type": "string"
}
},
"type": "object",
"id": "OrderShipment"
},
"SettlementTransactionAmount": {
"properties": {
"transactionAmount": {
"$ref": "Price",
"description": "The amount that contributes to the line item price."
},
"description": {
"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`\" - \"`refundFromMerchant`\" - \"`returnLabelShippingFee`\" ",
"type": "string"
},
"commission": {
"$ref": "SettlementTransactionAmountCommission"
},
"type": {
"type": "string",
"description": "The type of the amount. Acceptable values are: - \"`itemPrice`\" - \"`orderPrice`\" - \"`refund`\" - \"`earlyRefund`\" - \"`courtesyRefund`\" - \"`returnRefund`\" - \"`returnLabelShippingFeeAmount`\" "
}
},
"type": "object",
"id": "SettlementTransactionAmount"
},
"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",
"properties": {
"matcherOption": {
"type": "string",
"enumDescriptions": [
"Unused.",
"Use custom filters.",
"Use repricing_rule_id feed attribute on the product resource to specify offer-rule mapping.",
"Matching all products."
],
"description": "Determines whether to use the custom matchers or the product feed attribute \"repricing_rule_id\" to specify offer-rule mapping.",
"enum": [
"MATCHER_OPTION_UNSPECIFIED",
"MATCHER_OPTION_CUSTOM_FILTER",
"MATCHER_OPTION_USE_FEED_ATTRIBUTE",
"MATCHER_OPTION_ALL_PRODUCTS"
]
},
"offerIdMatcher": {
"$ref": "RepricingRuleEligibleOfferMatcherStringMatcher",
"description": "Filter by the offer id."
},
"itemGroupIdMatcher": {
"description": "Filter by the item group id.",
"$ref": "RepricingRuleEligibleOfferMatcherStringMatcher"
},
"brandMatcher": {
"description": "Filter by the brand.",
"$ref": "RepricingRuleEligibleOfferMatcherStringMatcher"
}
},
"id": "RepricingRuleEligibleOfferMatcher"
},
"ShippingsettingsCustomBatchResponse": {
"id": "ShippingsettingsCustomBatchResponse",
"type": "object",
"properties": {
"entries": {
"description": "The result of the execution of the batch requests.",
"items": {
"$ref": "ShippingsettingsCustomBatchResponseEntry"
},
"type": "array"
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#shippingsettingsCustomBatchResponse\".",
"type": "string"
}
}
},
"OrderLineItemReturnInfo": {
"id": "OrderLineItemReturnInfo",
"type": "object",
"properties": {
"policyUrl": {
"type": "string",
"description": "Required. URL of the item return policy."
},
"isReturnable": {
"type": "boolean",
"description": "Required. Whether the item is returnable."
},
"daysToReturn": {
"description": "Required. How many days later the item can be returned.",
"type": "integer",
"format": "int32"
}
}
},
"ProductSubscriptionCost": {
"type": "object",
"properties": {
"periodLength": {
"format": "int64",
"type": "string",
"description": "The number of subscription periods the buyer has to pay."
},
"period": {
"type": "string",
"description": "The type of subscription period."
},
"amount": {
"$ref": "Price",
"description": "The amount the buyer has to pay per subscription period."
}
},
"id": "ProductSubscriptionCost"
},
"DatafeedstatusesListResponse": {
"id": "DatafeedstatusesListResponse",
"properties": {
"resources": {
"type": "array",
"items": {
"$ref": "DatafeedStatus"
}
},
"nextPageToken": {
"description": "The token for the retrieval of the next page of datafeed statuses.",
"type": "string"
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#datafeedstatusesListResponse\"."
}
},
"type": "object"
},
"ShipmentInvoiceLineItemInvoice": {
"type": "object",
"properties": {
"lineItemId": {
"type": "string",
"description": "ID of the line item. Either lineItemId or productId must be set."
},
"shipmentUnitIds": {
"items": {
"type": "string"
},
"description": "[required] The shipment unit ID is assigned by the merchant and defines individual quantities within a line item. The same ID can be assigned to units that are the same while units that differ must be assigned a different ID (for example: free or promotional units).",
"type": "array"
},
"unitInvoice": {
"description": "[required] Invoice details for a single unit.",
"$ref": "UnitInvoice"
},
"productId": {
"description": "ID of the product. This is the REST ID used in the products service. Either lineItemId or productId must be set.",
"type": "string"
}
},
"id": "ShipmentInvoiceLineItemInvoice"
},
"PosInventoryResponse": {
"type": "object",
"properties": {
"price": {
"$ref": "Price",
"description": "Required. The current price of the item."
},
"gtin": {
"description": "Global Trade Item Number.",
"type": "string"
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#posInventoryResponse\".",
"type": "string"
},
"contentLanguage": {
"description": "Required. The two-letter ISO 639-1 language code for the item.",
"type": "string"
},
"timestamp": {
"description": "Required. The inventory timestamp, in ISO 8601 format.",
"type": "string"
},
"itemId": {
"type": "string",
"description": "Required. A unique identifier for the item."
},
"storeCode": {
"description": "Required. The identifier of the merchant's store. Either a `storeCode` inserted via the API or the code of the store in Google My Business.",
"type": "string"
},
"quantity": {
"type": "string",
"format": "int64",
"description": "Required. The available quantity of the item."
},
"targetCountry": {
"description": "Required. The CLDR territory code for the item.",
"type": "string"
}
},
"id": "PosInventoryResponse"
},
"ShippingsettingsCustomBatchRequestEntry": {
"id": "ShippingsettingsCustomBatchRequestEntry",
"description": "A batch entry encoding a single non-batch shippingsettings request.",
"type": "object",
"properties": {
"accountId": {
"type": "string",
"format": "uint64",
"description": "The ID of the account for which to get/update account shipping settings."
},
"batchId": {
"type": "integer",
"description": "An entry ID, unique within the batch request.",
"format": "uint32"
},
"shippingSettings": {
"description": "The account shipping settings to update. Only defined if the method is `update`.",
"$ref": "ShippingSettings"
},
"merchantId": {
"format": "uint64",
"type": "string",
"description": "The ID of the managing account."
},
"method": {
"type": "string",
"description": "The method of the batch entry. Acceptable values are: - \"`get`\" - \"`update`\" "
}
}
},
"Account": {
"description": "Account data. After the creation of a new account it may take a few minutes before it is fully operational. The methods delete, insert, and update require the admin role.",
"type": "object",
"id": "Account",
"properties": {
"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."
},
"labelIds": {
"type": "array",
"items": {
"type": "string",
"format": "uint64"
},
"description": "List of label IDs that are assigned to the account by CSS."
},
"businessInformation": {
"$ref": "AccountBusinessInformation",
"description": "The business information of the account."
},
"id": {
"type": "string",
"format": "uint64",
"description": "Required for update. Merchant Center account ID."
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"`content#account`\"",
"type": "string"
},
"googleMyBusinessLink": {
"description": "The GMB account which is linked or in the process of being linked with the Merchant Center account.",
"$ref": "AccountGoogleMyBusinessLink"
},
"adultContent": {
"type": "boolean",
"description": "Indicates whether the merchant sells adult content."
},
"youtubeChannelLinks": {
"description": "List of linked YouTube channels that are active or pending approval. To create a new link request, add a new link with status `active` to the list. It will remain in a `pending` state until approved or rejected in the YT Creator Studio interface. To delete an active link, or to cancel a link request, remove it from the list.",
"items": {
"$ref": "AccountYouTubeChannelLink"
},
"type": "array"
},
"adsLinks": {
"items": {
"$ref": "AccountAdsLink"
},
"description": "List of 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.",
"type": "array"
},
"sellerId": {
"description": "Client-specific, locally-unique, internal ID for the child account.",
"type": "string"
},
"websiteUrl": {
"type": "string",
"description": "The merchant's website."
},
"cssId": {
"description": "ID of CSS the account belongs to.",
"format": "uint64",
"type": "string"
},
"name": {
"description": "Required. Display name for the account.",
"type": "string"
}
}
},
"OrderLineItemShippingDetailsMethod": {
"id": "OrderLineItemShippingDetailsMethod",
"type": "object",
"properties": {
"methodName": {
"description": "Required. The name of the shipping method.",
"type": "string"
},
"carrier": {
"description": "The carrier for the shipping. Optional. See `shipments[].carrier` for a list of acceptable values.",
"type": "string"
},
"maxDaysInTransit": {
"type": "integer",
"format": "uint32",
"description": "Required. Maximum transit time."
},
"minDaysInTransit": {
"format": "uint32",
"description": "Required. Minimum transit time.",
"type": "integer"
}
}
},
"ProductsCustomBatchResponseEntry": {
"description": "A batch entry encoding a single non-batch products response.",
"type": "object",
"id": "ProductsCustomBatchResponseEntry",
"properties": {
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"`content#productsCustomBatchResponseEntry`\""
},
"product": {
"description": "The inserted product. Only defined if the method is `insert` and if the request was successful.",
"$ref": "Product"
},
"errors": {
"description": "A list of errors defined if and only if the request failed.",
"$ref": "Errors"
},
"batchId": {
"description": "The ID of the request entry this entry responds to.",
"type": "integer",
"format": "uint32"
}
}
},
"LiaPosDataProvider": {
"properties": {
"posExternalAccountId": {
"description": "The account ID by which this merchant is known to the POS data provider.",
"type": "string"
},
"posDataProviderId": {
"description": "The ID of the POS data provider.",
"type": "string",
"format": "uint64"
}
},
"type": "object",
"id": "LiaPosDataProvider"
},
"SettlementreportsListResponse": {
"properties": {
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#settlementreportsListResponse\"."
},
"nextPageToken": {
"type": "string",
"description": "The token for the retrieval of the next page of returns."
},
"resources": {
"type": "array",
"items": {
"$ref": "SettlementReport"
}
}
},
"id": "SettlementreportsListResponse",
"type": "object"
},
"DatafeedStatusExample": {
"type": "object",
"id": "DatafeedStatusExample",
"properties": {
"lineNumber": {
"format": "uint64",
"description": "Line number in the data feed where the example is found.",
"type": "string"
},
"itemId": {
"description": "The ID of the example item.",
"type": "string"
},
"value": {
"description": "The problematic value.",
"type": "string"
}
},
"description": "An example occurrence for a particular error."
},
"LiasettingsCustomBatchResponseEntry": {
"properties": {
"liaSettings": {
"description": "The retrieved or updated Lia settings.",
"$ref": "LiaSettings"
},
"batchId": {
"format": "uint32",
"description": "The ID of the request entry to which this entry responds.",
"type": "integer"
},
"gmbAccounts": {
"description": "The the list of accessible GMB accounts.",
"$ref": "GmbAccounts"
},
"errors": {
"$ref": "Errors",
"description": "A list of errors defined if, and only if, the request failed."
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"`content#liasettingsCustomBatchResponseEntry`\"",
"type": "string"
},
"posDataProviders": {
"items": {
"$ref": "PosDataProviders"
},
"type": "array",
"description": "The list of POS data providers."
}
},
"type": "object",
"id": "LiasettingsCustomBatchResponseEntry"
},
"TestOrderPickupDetails": {
"type": "object",
"id": "TestOrderPickupDetails",
"properties": {
"pickupPersons": {
"description": "Required. all pickup persons set by users.",
"items": {
"$ref": "TestOrderPickupDetailsPickupPerson"
},
"type": "array"
},
"locationCode": {
"description": "Required. Code of the location defined by provider or merchant.",
"type": "string"
},
"pickupLocationAddress": {
"description": "Required. Pickup location address.",
"$ref": "TestOrderAddress"
},
"pickupLocationType": {
"description": "Pickup location type. Acceptable values are: - \"`locker`\" - \"`store`\" - \"`curbside`\" ",
"type": "string"
}
}
},
"Headers": {
"type": "object",
"properties": {
"numberOfItems": {
"description": "A list of inclusive number of items upper bounds. The last value can be `\"infinity\"`. For example `[\"10\", \"50\", \"infinity\"]` represents the headers \"\u003c= 10 items\", \"\u003c= 50 items\", and \"\u003e 50 items\". Must be non-empty. Can only be set if all other fields are not set.",
"type": "array",
"items": {
"type": "string"
}
},
"locations": {
"items": {
"$ref": "LocationIdSet"
},
"description": "A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.",
"type": "array"
},
"postalCodeGroupNames": {
"type": "array",
"description": "A list of postal group names. The last value can be `\"all other locations\"`. Example: `[\"zone 1\", \"zone 2\", \"all other locations\"]`. The referred postal code groups must match the delivery country of the service. 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"
}
},
"id": "Headers",
"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."
},
"LabelIds": {
"type": "object",
"id": "LabelIds",
"properties": {
"labelIds": {
"items": {
"type": "string",
"format": "int64"
},
"description": "The list of label IDs.",
"type": "array"
}
},
"description": "The IDs of labels that should be assigned to the CSS domain."
},
"Css": {
"type": "object",
"properties": {
"homepageUri": {
"type": "string",
"description": "Output only. Immutable. The CSS domain's homepage.",
"readOnly": true
},
"labelIds": {
"items": {
"format": "int64",
"type": "string"
},
"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"
},
"cssGroupId": {
"type": "string",
"description": "Output only. Immutable. The ID of the CSS group this CSS domain is affiliated with. Only populated for CSS group users.",
"readOnly": true,
"format": "int64"
},
"displayName": {
"type": "string",
"readOnly": true,
"description": "Output only. Immutable. The CSS domain's display name, used when space is constrained."
},
"fullName": {
"readOnly": true,
"type": "string",
"description": "Output only. Immutable. The CSS domain's full name."
},
"cssDomainId": {
"type": "string",
"description": "Output only. Immutable. The CSS domain ID.",
"readOnly": true,
"format": "int64"
}
},
"description": "Information about CSS domain.",
"id": "Css"
},
"AccountStatus": {
"type": "object",
"id": "AccountStatus",
"properties": {
"accountId": {
"description": "The ID of the account for which the status is reported.",
"type": "string"
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"`content#accountStatus`\"",
"type": "string"
},
"accountLevelIssues": {
"type": "array",
"items": {
"$ref": "AccountStatusAccountLevelIssue"
},
"description": "A list of account level issues."
},
"websiteClaimed": {
"type": "boolean",
"description": "Whether the account's website is claimed or not."
},
"products": {
"type": "array",
"description": "List of product-related data by channel, destination, and country. Data in this field may be delayed by up to 30 minutes.",
"items": {
"$ref": "AccountStatusProducts"
}
}
},
"description": "The status of an account, i.e., information about its products, which is computed offline and not returned immediately at insertion time."
},
"Service": {
"type": "object",
"id": "Service",
"properties": {
"minimumOrderValue": {
"$ref": "Price",
"description": "Minimum order value for this service. If set, indicates that customers will have to spend at least this amount. All prices within a service must have the same currency. Cannot be set together with minimum_order_value_table."
},
"eligibility": {
"description": "Eligibility for this service. Acceptable values are: - \"`All scenarios`\" - \"`All scenarios except Shopping Actions`\" - \"`Shopping Actions`\" ",
"type": "string"
},
"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",
"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.",
"items": {
"$ref": "RateGroup"
}
},
"minimumOrderValueTable": {
"$ref": "MinimumOrderValueTable",
"description": "Table of per store minimum order values for the pickup fulfillment type. Cannot be set together with minimum_order_value."
},
"deliveryCountry": {
"description": "The CLDR territory code of the country to which the service applies. Required.",
"type": "string"
},
"currency": {
"type": "string",
"description": "The CLDR code of the currency to which this service applies. Must match that of the prices in rate groups."
},
"name": {
"type": "string",
"description": "Free-form name of the service. Must be unique within target account. Required."
},
"shipmentType": {
"type": "string",
"description": "Type of locations this service ships orders to. Acceptable values are: - \"`delivery`\" - \"`pickup`\" "
},
"deliveryTime": {
"$ref": "DeliveryTime",
"description": "Time spent in various aspects from order to the delivery of the product. Required."
},
"active": {
"type": "boolean",
"description": "A boolean exposing the active status of the shipping service. Required."
}
}
},
"ShippingsettingsCustomBatchRequest": {
"id": "ShippingsettingsCustomBatchRequest",
"properties": {
"entries": {
"items": {
"$ref": "ShippingsettingsCustomBatchRequestEntry"
},
"type": "array",
"description": "The request entries to be processed in the batch."
}
},
"type": "object"
},
"ReturnpolicyCustomBatchResponseEntry": {
"id": "ReturnpolicyCustomBatchResponseEntry",
"type": "object",
"properties": {
"returnPolicy": {
"description": "The retrieved return policy.",
"$ref": "ReturnPolicy"
},
"errors": {
"description": "A list of errors defined if, and only if, the request failed.",
"$ref": "Errors"
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"`content#returnpolicyCustomBatchResponseEntry`\"",
"type": "string"
},
"batchId": {
"format": "uint32",
"description": "The ID of the request entry to which this entry responds.",
"type": "integer"
}
}
},
"AccountstatusesListResponse": {
"type": "object",
"id": "AccountstatusesListResponse",
"properties": {
"nextPageToken": {
"description": "The token for the retrieval of the next page of account statuses.",
"type": "string"
},
"resources": {
"type": "array",
"items": {
"$ref": "AccountStatus"
}
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#accountstatusesListResponse\"."
}
}
},
"DatafeedstatusesCustomBatchRequestEntry": {
"description": "A batch entry encoding a single non-batch datafeedstatuses request.",
"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."
},
"batchId": {
"type": "integer",
"format": "uint32",
"description": "An entry ID, unique within the batch request."
},
"datafeedId": {
"format": "uint64",
"type": "string",
"description": "The ID of the data feed to get."
},
"merchantId": {
"description": "The ID of the managing account.",
"format": "uint64",
"type": "string"
},
"method": {
"type": "string",
"description": "The method of the batch entry. Acceptable values are: - \"`get`\" "
},
"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."
}
},
"type": "object",
"id": "DatafeedstatusesCustomBatchRequestEntry"
},
"ListCssesResponse": {
"description": "The response message for the `ListCsses` method",
"type": "object",
"properties": {
"csses": {
"description": "The CSS domains affiliated with the specified CSS group.",
"items": {
"$ref": "Css"
},
"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"
}
},
"id": "ListCssesResponse"
},
"AccountTax": {
"type": "object",
"properties": {
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#accountTax\".",
"type": "string"
},
"rules": {
"type": "array",
"description": "Tax rules. Updating the tax rules will enable US taxes (not reversible). Defining no rules is equivalent to not charging tax at all.",
"items": {
"$ref": "AccountTaxTaxRule"
}
},
"accountId": {
"format": "uint64",
"type": "string",
"description": "Required. The ID of the account to which these account tax settings belong."
}
},
"description": "The tax settings of a merchant account. All methods require the admin role.",
"id": "AccountTax"
},
"OrderreturnsAcknowledgeRequest": {
"id": "OrderreturnsAcknowledgeRequest",
"properties": {
"operationId": {
"description": "[required] The ID of the operation, unique across all operations for a given order return.",
"type": "string"
}
},
"type": "object"
},
"SettlementTransactionAmountCommission": {
"properties": {
"category": {
"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`\" ",
"type": "string"
},
"rate": {
"description": "Rate of the commission in percentage.",
"type": "string"
}
},
"type": "object",
"id": "SettlementTransactionAmountCommission"
},
"DatafeedstatusesCustomBatchResponseEntry": {
"description": "A batch entry encoding a single non-batch datafeedstatuses response.",
"id": "DatafeedstatusesCustomBatchResponseEntry",
"type": "object",
"properties": {
"batchId": {
"format": "uint32",
"description": "The ID of the request entry this entry responds to.",
"type": "integer"
},
"datafeedStatus": {
"$ref": "DatafeedStatus",
"description": "The requested data feed status. Defined if and only if the request was successful."
},
"errors": {
"description": "A list of errors defined if and only if the request failed.",
"$ref": "Errors"
}
}
},
"HolidaysHoliday": {
"type": "object",
"properties": {
"deliveryGuaranteeDate": {
"type": "string",
"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."
},
"countryCode": {
"description": "The CLDR territory code of the country in which the holiday is available. E.g. \"US\", \"DE\", \"GB\". A holiday cutoff can only be configured in a shipping settings service with matching delivery country. Always present.",
"type": "string"
},
"date": {
"description": "Date of the holiday, in ISO 8601 format. E.g. \"2016-12-25\" for Christmas 2016. Always present.",
"type": "string"
},
"type": {
"description": "The holiday type. Always present. Acceptable values are: - \"`Christmas`\" - \"`Easter`\" - \"`Father's Day`\" - \"`Halloween`\" - \"`Independence Day (USA)`\" - \"`Mother's Day`\" - \"`Thanksgiving`\" - \"`Valentine's Day`\" ",
"type": "string"
},
"id": {
"type": "string",
"description": "Unique identifier for the holiday to be used when configuring holiday cutoffs. Always present."
},
"deliveryGuaranteeHour": {
"description": "Hour of the day in the delivery location's timezone on the guaranteed delivery date by which the order has to arrive at the customer's. Possible values are: 0 (midnight), 1, ..., 12 (noon), 13, ..., 23. Always present.",
"type": "string",
"format": "uint64"
}
},
"id": "HolidaysHoliday"
},
"DatafeedstatusesCustomBatchRequest": {
"properties": {
"entries": {
"type": "array",
"items": {
"$ref": "DatafeedstatusesCustomBatchRequestEntry"
},
"description": "The request entries to be processed in the batch."
}
},
"id": "DatafeedstatusesCustomBatchRequest",
"type": "object"
},
"OrderLineItemAdjustment": {
"properties": {
"taxAdjustment": {
"description": "Adjustment for total tax of the line item.",
"$ref": "Price"
},
"type": {
"description": "Type of this adjustment. Acceptable values are: - \"`promotion`\" ",
"type": "string"
},
"priceAdjustment": {
"description": "Adjustment for total price of the line item.",
"$ref": "Price"
}
},
"id": "OrderLineItemAdjustment",
"type": "object"
},
"AccountStatusAccountLevelIssue": {
"properties": {
"documentation": {
"description": "The URL of a web page to help resolving this issue.",
"type": "string"
},
"country": {
"type": "string",
"description": "Country for which this issue is reported."
},
"detail": {
"description": "Additional details about the issue.",
"type": "string"
},
"title": {
"description": "Short description of the issue.",
"type": "string"
},
"id": {
"type": "string",
"description": "Issue identifier."
},
"destination": {
"type": "string",
"description": "The destination the issue applies to. If this field is empty then the issue applies to all available destinations."
},
"severity": {
"description": "Severity of the issue. Acceptable values are: - \"`critical`\" - \"`error`\" - \"`suggestion`\" ",
"type": "string"
}
},
"type": "object",
"id": "AccountStatusAccountLevelIssue"
},
"ShippingsettingsListResponse": {
"type": "object",
"id": "ShippingsettingsListResponse",
"properties": {
"nextPageToken": {
"description": "The token for the retrieval of the next page of shipping settings.",
"type": "string"
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#shippingsettingsListResponse\"."
},
"resources": {
"items": {
"$ref": "ShippingSettings"
},
"type": "array"
}
}
},
"RegionPostalCodeArea": {
"properties": {
"regionCode": {
"type": "string",
"description": "Required. CLDR territory code or the country the postal code group applies to."
},
"postalCodes": {
"type": "array",
"description": "Required. A range of postal codes.",
"items": {
"$ref": "RegionPostalCodeAreaPostalCodeRange"
}
}
},
"type": "object",
"id": "RegionPostalCodeArea",
"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."
},
"Product": {
"type": "object",
"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.",
"properties": {
"pattern": {
"description": "The item's pattern (e.g. polka dots).",
"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."
},
"brand": {
"type": "string",
"description": "Brand of the item."
},
"salePriceEffectiveDate": {
"type": "string",
"description": "Date range during which the item is on sale (see products data specification )."
},
"availability": {
"type": "string",
"description": "Availability status of the item."
},
"maxHandlingTime": {
"description": "Maximal product handling time (in business days).",
"format": "int64",
"type": "string"
},
"shippingWidth": {
"$ref": "ProductShippingDimension",
"description": "Width of the item for shipping."
},
"identifierExists": {
"description": "False when the item does not have unique product identifiers appropriate to its category, such as GTIN, MPN, and brand. Required according to the Unique Product Identifier Rules for all target countries except for Canada.",
"type": "boolean"
},
"displayAdsTitle": {
"type": "string",
"description": "Title of an item for dynamic remarketing campaigns."
},
"shipping": {
"description": "Shipping rules.",
"type": "array",
"items": {
"$ref": "ProductShipping"
}
},
"taxCategory": {
"description": "The tax category of the product, used to configure detailed tax nexus in account-level tax settings.",
"type": "string"
},
"shoppingAdsExcludedCountries": {
"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.",
"items": {
"type": "string"
},
"type": "array"
},
"adsLabels": {
"items": {
"type": "string"
},
"description": "Similar to ads_grouping, but only works on CPC.",
"type": "array"
},
"targetCountry": {
"type": "string",
"description": "Required. The CLDR territory code for the item."
},
"expirationDate": {
"description": "Date on which the item should expire, as specified upon insertion, in ISO 8601 format. The actual expiration date in Google Shopping is exposed in `productstatuses` as `googleExpirationDate` and might be earlier if `expirationDate` is too far in the future.",
"type": "string"
},
"customLabel3": {
"description": "Custom label 3 for custom grouping of items in a Shopping campaign.",
"type": "string"
},
"unitPricingMeasure": {
"$ref": "ProductUnitPricingMeasure",
"description": "The measure and dimension of an item."
},
"taxes": {
"type": "array",
"description": "Tax information.",
"items": {
"$ref": "ProductTax"
}
},
"color": {
"type": "string",
"description": "Color of the item."
},
"customLabel4": {
"type": "string",
"description": "Custom label 4 for custom grouping of items in a Shopping campaign."
},
"minEnergyEfficiencyClass": {
"description": "The energy efficiency class as defined in EU directive 2010/30/EU.",
"type": "string"
},
"contentLanguage": {
"type": "string",
"description": "Required. The two-letter ISO 639-1 language code for the item."
},
"condition": {
"description": "Condition or state of the item.",
"type": "string"
},
"gender": {
"type": "string",
"description": "Target gender of the item."
},
"mpn": {
"description": "Manufacturer Part Number (MPN) of the item.",
"type": "string"
},
"shippingHeight": {
"description": "Height of the item for shipping.",
"$ref": "ProductShippingDimension"
},
"itemGroupId": {
"description": "Shared identifier for all variants of the same product.",
"type": "string"
},
"costOfGoodsSold": {
"description": "Cost of goods sold. Used for gross profit reporting.",
"$ref": "Price"
},
"productTypes": {
"items": {
"type": "string"
},
"description": "Categories of the item (formatted as in products data specification).",
"type": "array"
},
"imageLink": {
"type": "string",
"description": "URL of an image of the item."
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"`content#product`\"",
"type": "string"
},
"source": {
"description": "The source of the offer, i.e., how the offer was created. Acceptable values are: - \"`api`\" - \"`crawl`\" - \"`feed`\" ",
"type": "string"
},
"transitTimeLabel": {
"description": "The transit time label of the product, used to group product in account-level transit time tables.",
"type": "string"
},
"includedDestinations": {
"description": "The list of destinations to include for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in `excludedDestinations`.",
"items": {
"type": "string"
},
"type": "array"
},
"mobileLink": {
"description": "URL for the mobile-optimized version of your item's landing page.",
"type": "string"
},
"shippingLabel": {
"type": "string",
"description": "The shipping label of the product, used to group product in account-level shipping rules."
},
"sizes": {
"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).",
"type": "array"
},
"adsGrouping": {
"description": "Used to group items in an arbitrary way. Only for CPA%, discouraged otherwise.",
"type": "string"
},
"maxEnergyEfficiencyClass": {
"type": "string",
"description": "The energy efficiency class as defined in EU directive 2010/30/EU."
},
"material": {
"description": "The material of which the item is made.",
"type": "string"
},
"customLabel0": {
"type": "string",
"description": "Custom label 0 for custom grouping of items in a Shopping campaign."
},
"channel": {
"type": "string",
"description": "Required. The item's channel (online or local). Acceptable values are: - \"`local`\" - \"`online`\" "
},
"link": {
"type": "string",
"description": "URL directly linking to your item's page on your website."
},
"installment": {
"$ref": "Installment",
"description": "Number and amount of installments to pay for an item."
},
"displayAdsSimilarIds": {
"items": {
"type": "string"
},
"type": "array",
"description": "Advertiser-specified recommendations."
},
"adult": {
"description": "Should be set to true if the item is targeted towards adults.",
"type": "boolean"
},
"displayAdsValue": {
"description": "Offer margin for dynamic remarketing campaigns.",
"type": "number",
"format": "double"
},
"additionalImageLinks": {
"items": {
"type": "string"
},
"description": "Additional URLs of images of the item.",
"type": "array"
},
"googleProductCategory": {
"description": "Google's category of the item (see Google product taxonomy).",
"type": "string"
},
"canonicalLink": {
"type": "string",
"description": "URL for the canonical version of your item's landing page."
},
"sellOnGoogleQuantity": {
"description": "The quantity of the product that is available for selling on Google. Supported only for online products.",
"format": "int64",
"type": "string"
},
"availabilityDate": {
"type": "string",
"description": "The day a pre-ordered product becomes available for delivery, in ISO 8601 format."
},
"adsRedirect": {
"type": "string",
"description": "Allows advertisers to override the item URL when the product is shown within the context of Product Ads."
},
"promotionIds": {
"description": "The unique ID of a promotion.",
"items": {
"type": "string"
},
"type": "array"
},
"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"
},
"loyaltyPoints": {
"$ref": "LoyaltyPoints",
"description": "Loyalty points that users receive after purchasing the item. Japan only."
},
"shippingWeight": {
"$ref": "ProductShippingWeight",
"description": "Weight of the item for shipping."
},
"customAttributes": {
"type": "array",
"description": "A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the feed specification in its generic form (e.g., `{ \"name\": \"size type\", \"value\": \"regular\" }`). This is useful for submitting attributes not explicitly exposed by the API, such as additional attributes used for Buy on Google (formerly known as Shopping Actions).",
"items": {
"$ref": "CustomAttribute"
}
},
"customLabel1": {
"type": "string",
"description": "Custom label 1 for custom grouping of items in a Shopping campaign."
},
"price": {
"$ref": "Price",
"description": "Price of the item."
},
"displayAdsLink": {
"type": "string",
"description": "URL directly to your item's landing page for dynamic remarketing campaigns."
},
"salePrice": {
"$ref": "Price",
"description": "Advertised sale price of the item."
},
"customLabel2": {
"description": "Custom label 2 for custom grouping of items in a Shopping campaign.",
"type": "string"
},
"ageGroup": {
"description": "Target age group of the item.",
"type": "string"
},
"isBundle": {
"description": "Whether the item is a merchant-defined bundle. A bundle is a custom grouping of different products sold by a merchant for a single price.",
"type": "boolean"
},
"displayAdsId": {
"description": "An identifier for an item for dynamic remarketing campaigns.",
"type": "string"
},
"sizeSystem": {
"type": "string",
"description": "System in which the size is specified. Recommended for apparel items."
},
"multipack": {
"type": "string",
"description": "The number of identical products in a merchant-defined multipack.",
"format": "int64"
},
"description": {
"type": "string",
"description": "Description of the item."
},
"subscriptionCost": {
"description": "Number of periods (months or years) and amount of payment per period for an item with an associated subscription contract.",
"$ref": "ProductSubscriptionCost"
},
"shippingLength": {
"description": "Length of the item for shipping.",
"$ref": "ProductShippingDimension"
},
"productDetails": {
"items": {
"$ref": "ProductProductDetail"
},
"description": "Technical specification or additional product details.",
"type": "array"
},
"minHandlingTime": {
"format": "int64",
"description": "Minimal product handling time (in business days).",
"type": "string"
},
"excludedDestinations": {
"description": "The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center).",
"items": {
"type": "string"
},
"type": "array"
},
"energyEfficiencyClass": {
"type": "string",
"description": "The energy efficiency class as defined in EU directive 2010/30/EU."
},
"unitPricingBaseMeasure": {
"description": "The preference of the denominator of the unit price.",
"$ref": "ProductUnitPricingBaseMeasure"
},
"productHighlights": {
"type": "array",
"items": {
"type": "string"
},
"description": "Bullet points describing the most relevant highlights of a product."
},
"title": {
"description": "Title of the item.",
"type": "string"
},
"gtin": {
"description": "Global Trade Item Number (GTIN) of the item.",
"type": "string"
},
"sizeType": {
"type": "string",
"description": "The cut of the item. Recommended for apparel items."
}
},
"id": "Product"
},
"OrdersRefundItemRequest": {
"type": "object",
"properties": {
"reasonText": {
"description": "The explanation of the reason.",
"type": "string"
},
"operationId": {
"type": "string",
"description": "The ID of the operation. Unique across all operations for a given order."
},
"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"
},
"shipping": {
"description": "The refund on shipping. Optional, but either Item or Shipping must be provided in the request.",
"$ref": "OrdersCustomBatchRequestEntryRefundItemShipping"
},
"items": {
"items": {
"$ref": "OrdersCustomBatchRequestEntryRefundItemItem"
},
"type": "array",
"description": "The items that are refunded. Either Item or Shipping must be provided in the request."
}
},
"id": "OrdersRefundItemRequest"
},
"OrderShipmentScheduledDeliveryDetails": {
"id": "OrderShipmentScheduledDeliveryDetails",
"properties": {
"carrierPhoneNumber": {
"type": "string",
"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\")."
},
"scheduledDate": {
"description": "The date a shipment is scheduled for delivery, in ISO 8601 format.",
"type": "string"
}
},
"type": "object"
},
"ProductShippingDimension": {
"type": "object",
"properties": {
"value": {
"description": "The dimension of the product used to calculate the shipping cost of the item.",
"format": "double",
"type": "number"
},
"unit": {
"description": "The unit of value.",
"type": "string"
}
},
"id": "ProductShippingDimension"
},
"OrdersCancelResponse": {
"type": "object",
"id": "OrdersCancelResponse",
"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#ordersCancelResponse\"."
}
}
},
"TransitTableTransitTimeRow": {
"type": "object",
"id": "TransitTableTransitTimeRow",
"properties": {
"values": {
"type": "array",
"items": {
"$ref": "TransitTableTransitTimeRowTransitTimeValue"
}
}
}
},
"ListRepricingRulesResponse": {
"type": "object",
"id": "ListRepricingRulesResponse",
"properties": {
"repricingRules": {
"items": {
"$ref": "RepricingRule"
},
"type": "array",
"description": "The rules from the specified merchant."
},
"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."
}
},
"description": "Response message for the `ListRepricingRules` method."
},
"OrderreturnsListResponse": {
"properties": {
"nextPageToken": {
"type": "string",
"description": "The token for the retrieval of the next page of returns."
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#orderreturnsListResponse\".",
"type": "string"
},
"resources": {
"type": "array",
"items": {
"$ref": "MerchantOrderReturn"
}
}
},
"type": "object",
"id": "OrderreturnsListResponse"
},
"ReturnPricingInfo": {
"type": "object",
"id": "ReturnPricingInfo",
"properties": {
"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."
},
"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."
},
"totalRefundedAmount": {
"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.",
"$ref": "MonetaryAmount"
},
"maxReturnShippingFee": {
"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.",
"$ref": "MonetaryAmount"
},
"refundableShippingAmount": {
"$ref": "MonetaryAmount",
"description": "Maximum amount that can be refunded for the original shipping fee."
}
}
},
"Order": {
"type": "object",
"description": "Order. Production access (all methods) requires the order manager role. Sandbox access does not.",
"properties": {
"shippingCost": {
"description": "The total cost of shipping for all items.",
"$ref": "Price"
},
"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."
},
"shipments": {
"type": "array",
"items": {
"$ref": "OrderShipment"
},
"description": "Shipments of the order."
},
"netTaxAmount": {
"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.",
"$ref": "Price"
},
"placedDate": {
"description": "The date when the order was placed, in ISO 8601 format.",
"type": "string"
},
"merchantOrderId": {
"description": "Merchant-provided ID of the order.",
"type": "string"
},
"billingAddress": {
"$ref": "OrderAddress",
"description": "The billing address."
},
"shippingCostTax": {
"description": "The tax for the total shipping cost.",
"$ref": "Price"
},
"refunds": {
"description": "Refunds for the order.",
"items": {
"$ref": "OrderRefund"
},
"type": "array"
},
"lineItems": {
"description": "Line items that are ordered.",
"items": {
"$ref": "OrderLineItem"
},
"type": "array"
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"`content#order`\"",
"type": "string"
},
"annotations": {
"type": "array",
"description": "List of key-value pairs that are attached to a given order.",
"items": {
"$ref": "OrderOrderAnnotation"
}
},
"acknowledged": {
"description": "Whether the order was acknowledged.",
"type": "boolean"
},
"taxCollector": {
"type": "string",
"description": "The party responsible for collecting and remitting taxes. Acceptable values are: - \"`marketplaceFacilitator`\" - \"`merchant`\" "
},
"promotions": {
"items": {
"$ref": "OrderPromotion"
},
"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."
},
"pickupDetails": {
"$ref": "OrderPickupDetails",
"description": "Pickup details for shipments of type `pickup`."
},
"status": {
"description": "The status of the order. Acceptable values are: - \"`canceled`\" - \"`delivered`\" - \"`inProgress`\" - \"`partiallyDelivered`\" - \"`partiallyReturned`\" - \"`partiallyShipped`\" - \"`pendingShipment`\" - \"`returned`\" - \"`shipped`\" ",
"type": "string"
},
"merchantId": {
"type": "string",
"format": "uint64"
},
"deliveryDetails": {
"$ref": "OrderDeliveryDetails",
"description": "Delivery details for shipments of type `delivery`."
},
"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."
},
"paymentStatus": {
"description": "The status of the payment. Acceptable values are: - \"`paymentCaptured`\" - \"`paymentRejected`\" - \"`paymentSecured`\" - \"`pendingAuthorization`\" ",
"type": "string"
}
},
"id": "Order"
},
"AccountAddress": {
"id": "AccountAddress",
"properties": {
"country": {
"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.",
"type": "string"
},
"locality": {
"description": "City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).",
"type": "string"
},
"streetAddress": {
"description": "Street-level part of the address.",
"type": "string"
},
"postalCode": {
"description": "Postal code or ZIP (e.g. \"94043\").",
"type": "string"
},
"region": {
"description": "Top-level administrative subdivision of the country. For example, a state like California (\"CA\") or a province like Quebec (\"QC\").",
"type": "string"
}
},
"type": "object"
},
"OrdersRefundOrderResponse": {
"type": "object",
"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"
},
"LiaOnDisplayToOrderSettings": {
"type": "object",
"id": "LiaOnDisplayToOrderSettings",
"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`\" "
}
}
},
"OrderreturnsPartialRefund": {
"id": "OrderreturnsPartialRefund",
"type": "object",
"properties": {
"taxAmount": {
"$ref": "Price",
"description": "Tax amount to be refunded. Note: This has different meaning depending on the location of the order."
},
"priceAmount": {
"description": "The pre-tax or post-tax amount to be refunded, depending on the location of the order.",
"$ref": "Price"
}
}
},
"ReturnaddressCustomBatchRequestEntry": {
"type": "object",
"id": "ReturnaddressCustomBatchRequestEntry",
"properties": {
"method": {
"type": "string",
"description": "Method of the batch request entry. Acceptable values are: - \"`delete`\" - \"`get`\" - \"`insert`\" "
},
"returnAddressId": {
"description": "The return address ID. This should be set only if the method is `delete` or `get`.",
"type": "string"
},
"merchantId": {
"description": "The Merchant Center account ID.",
"type": "string",
"format": "uint64"
},
"returnAddress": {
"description": "The return address to submit. This should be set only if the method is `insert`.",
"$ref": "ReturnAddress"
},
"batchId": {
"format": "uint32",
"type": "integer",
"description": "An entry ID, unique within the batch request."
}
}
},
"AccountsLinkRequest": {
"type": "object",
"id": "AccountsLinkRequest",
"properties": {
"services": {
"items": {
"type": "string"
},
"type": "array",
"description": "List of provided services."
},
"linkedAccountId": {
"description": "The ID of the linked account.",
"type": "string"
},
"linkType": {
"description": "Type of the link between the two accounts. Acceptable values are: - \"`channelPartner`\" - \"`eCommercePlatform`\" ",
"type": "string"
},
"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"
}
}
},
"AccountsCustomBatchResponseEntry": {
"description": "A batch entry encoding a single non-batch accounts response.",
"type": "object",
"id": "AccountsCustomBatchResponseEntry",
"properties": {
"errors": {
"$ref": "Errors",
"description": "A list of errors defined if and only if the request failed."
},
"account": {
"description": "The retrieved, created, or updated account. Not defined if the method was `delete`, `claimwebsite` or `link`.",
"$ref": "Account"
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"`content#accountsCustomBatchResponseEntry`\""
},
"batchId": {
"type": "integer",
"description": "The ID of the request entry this entry responds to.",
"format": "uint32"
}
}
},
"LoyaltyPoints": {
"id": "LoyaltyPoints",
"properties": {
"pointsValue": {
"description": "The retailer's loyalty points in absolute value.",
"format": "int64",
"type": "string"
},
"ratio": {
"description": "The ratio of a point when converted to currency. Google assumes currency based on Merchant Center settings. If ratio is left out, it defaults to 1.0.",
"type": "number",
"format": "double"
},
"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"
}
},
"type": "object"
},
"RefundReason": {
"type": "object",
"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"
},
"LiasettingsCustomBatchRequestEntry": {
"id": "LiasettingsCustomBatchRequestEntry",
"type": "object",
"properties": {
"merchantId": {
"description": "The ID of the managing account.",
"format": "uint64",
"type": "string"
},
"gmbEmail": {
"description": "The GMB account. Required only for RequestGmbAccess.",
"type": "string"
},
"posExternalAccountId": {
"type": "string",
"description": "The account ID by which this merchant is known to the POS provider."
},
"country": {
"type": "string",
"description": "The country code. Required only for RequestInventoryVerification."
},
"batchId": {
"format": "uint32",
"description": "An entry ID, unique within the batch request.",
"type": "integer"
},
"liaSettings": {
"$ref": "LiaSettings",
"description": "The account Lia settings to update. Only defined if the method is `update`."
},
"accountId": {
"type": "string",
"description": "The ID of the account for which to get/update account LIA settings.",
"format": "uint64"
},
"contactName": {
"type": "string",
"description": "Inventory validation contact name. Required only for SetInventoryValidationContact."
},
"method": {
"description": "The method of the batch entry. Acceptable values are: - \"`get`\" - \"`getAccessibleGmbAccounts`\" - \"`requestGmbAccess`\" - \"`requestInventoryVerification`\" - \"`setInventoryVerificationContact`\" - \"`update`\" ",
"type": "string"
},
"posDataProviderId": {
"type": "string",
"format": "uint64",
"description": "The ID of POS data provider. Required only for SetPosProvider."
},
"contactEmail": {
"description": "Inventory validation contact email. Required only for SetInventoryValidationContact.",
"type": "string"
}
}
},
"ProductTax": {
"id": "ProductTax",
"type": "object",
"properties": {
"country": {
"type": "string",
"description": "The country within which the item is taxed, specified as a CLDR territory code."
},
"postalCode": {
"description": "The postal code range that the tax rate applies to, represented by a ZIP code, a ZIP code prefix using * wildcard, a range between two ZIP codes or two ZIP code prefixes of equal length. Examples: 94114, 94*, 94002-95460, 94*-95*.",
"type": "string"
},
"locationId": {
"description": "The numeric ID of a location that the tax rate applies to as defined in the AdWords API.",
"type": "string",
"format": "int64"
},
"taxShip": {
"description": "Should be set to true if tax is charged on shipping.",
"type": "boolean"
},
"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."
}
}
},
"Value": {
"properties": {
"carrierRateName": {
"description": "The name of a carrier rate referring to a carrier rate defined in the same rate group. Can only be set if all other fields are not set.",
"type": "string"
},
"pricePercentage": {
"description": "A percentage of the price represented as a number in decimal notation (e.g., `\"5.4\"`). Can only be set if all other fields are not set.",
"type": "string"
},
"subtableName": {
"description": "The name of a subtable. Can only be set in table cells (i.e., not for single values), and only if all other fields are not set.",
"type": "string"
},
"flatRate": {
"$ref": "Price",
"description": "A flat rate. Can only be set if all other fields are not set."
},
"noShipping": {
"type": "boolean",
"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."
}
},
"id": "Value",
"type": "object",
"description": "The single value of a rate group or the value of a rate group table's cell. Exactly one of `noShipping`, `flatRate`, `pricePercentage`, `carrierRateName`, `subtableName` must be set."
},
"SettlementTransactionIdentifiers": {
"id": "SettlementTransactionIdentifiers",
"type": "object",
"properties": {
"shipmentIds": {
"description": "The shipment ids for the item.",
"items": {
"type": "string"
},
"type": "array"
},
"merchantOrderId": {
"type": "string",
"description": "The merchant provided order ID."
},
"transactionId": {
"type": "string",
"description": "The Google transaction ID."
},
"orderItemId": {
"description": "The identifier of the item.",
"type": "string"
},
"settlementEntryId": {
"type": "string",
"description": "The unique ID of the settlement transaction entry."
},
"adjustmentId": {
"type": "string",
"description": "The identifier of the adjustments, if it is available."
}
}
},
"AccountTaxTaxRule": {
"id": "AccountTaxTaxRule",
"description": "Tax calculation rule to apply in a state or province (USA only).",
"type": "object",
"properties": {
"locationId": {
"format": "uint64",
"type": "string",
"description": "Required. State (or province) is which the tax is applicable, described by its location ID (also called criteria ID)."
},
"useGlobalRate": {
"description": "Whether the tax rate is taken from a global tax table or specified explicitly.",
"type": "boolean"
},
"country": {
"type": "string",
"description": "Country code in which tax is applicable."
},
"shippingTaxed": {
"description": "If true, shipping charges are also taxed.",
"type": "boolean"
},
"ratePercent": {
"description": "Explicit tax rate in percent, represented as a floating point number without the percentage character. Must not be negative.",
"type": "string"
}
}
},
"PostalCodeRange": {
"properties": {
"postalCodeRangeBegin": {
"type": "string",
"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."
},
"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`."
}
},
"type": "object",
"id": "PostalCodeRange"
},
"LiaCountrySettings": {
"properties": {
"hostedLocalStorefrontActive": {
"type": "boolean",
"description": "The status of the \"Merchant hosted local storefront\" feature."
},
"onDisplayToOrder": {
"$ref": "LiaOnDisplayToOrderSettings",
"description": "LIA \"On Display To Order\" settings."
},
"posDataProvider": {
"$ref": "LiaPosDataProvider",
"description": "The POS data provider linked with this country."
},
"storePickupActive": {
"description": "The status of the \"Store pickup\" feature.",
"type": "boolean"
},
"inventory": {
"$ref": "LiaInventorySettings",
"description": "LIA inventory verification settings."
},
"country": {
"description": "Required. CLDR country code (e.g. \"US\").",
"type": "string"
},
"about": {
"description": "The settings for the About page.",
"$ref": "LiaAboutPageSettings"
}
},
"id": "LiaCountrySettings",
"type": "object"
},
"PosListResponse": {
"id": "PosListResponse",
"properties": {
"resources": {
"type": "array",
"items": {
"$ref": "PosStore"
}
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#posListResponse\"."
}
},
"type": "object"
},
"OrderTrackingSignalLineItemDetails": {
"description": "The line items of the order.",
"properties": {
"lineItemId": {
"description": "Required. The ID for this line item.",
"type": "string"
},
"quantity": {
"format": "int64",
"description": "Required. The quantity of the line item in the order.",
"type": "string"
},
"productId": {
"description": "Required. The Content API REST ID of the product, in the form channel:contentLanguage:targetCountry:offerId.",
"type": "string"
},
"mpn": {
"type": "string",
"description": "The manufacturer part number."
},
"gtin": {
"description": "The Global Trade Item Number.",
"type": "string"
}
},
"type": "object",
"id": "OrderTrackingSignalLineItemDetails"
},
"Amount": {
"type": "object",
"properties": {
"priceAmount": {
"description": "[required] The pre-tax or post-tax price depending on the location of the order.",
"$ref": "Price"
},
"taxAmount": {
"description": "[required] Tax value.",
"$ref": "Price"
}
},
"id": "Amount"
},
"LiaSettings": {
"description": "Local Inventory ads (LIA) settings. All methods except listposdataproviders require the admin role.",
"type": "object",
"properties": {
"countrySettings": {
"items": {
"$ref": "LiaCountrySettings"
},
"description": "The LIA settings for each country.",
"type": "array"
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"`content#liaSettings`\""
},
"accountId": {
"type": "string",
"description": "The ID of the account to which these LIA settings belong. Ignored upon update, always present in get request responses.",
"format": "uint64"
}
},
"id": "LiaSettings"
},
"MerchantOrderReturn": {
"properties": {
"merchantOrderId": {
"description": "Merchant defined order ID.",
"type": "string"
},
"returnItems": {
"items": {
"$ref": "MerchantOrderReturnItem"
},
"description": "Items of the return.",
"type": "array"
},
"returnPricingInfo": {
"description": "Information about shipping costs.",
"$ref": "ReturnPricingInfo"
},
"returnShipments": {
"items": {
"$ref": "ReturnShipment"
},
"type": "array",
"description": "Shipments of the return."
},
"orderReturnId": {
"description": "Order return ID generated by Google.",
"type": "string"
},
"orderId": {
"type": "string",
"description": "Google order ID."
},
"creationDate": {
"type": "string",
"description": "The date of creation of the return, in ISO 8601 format."
}
},
"description": "Order return. Production access (all methods) requires the order manager role. Sandbox access does not.",
"type": "object",
"id": "MerchantOrderReturn"
},
"RateGroup": {
"type": "object",
"properties": {
"subtables": {
"type": "array",
"items": {
"$ref": "Table"
},
"description": "A list of subtables referred to by `mainTable`. Can only be set if `mainTable` is set."
},
"name": {
"type": "string",
"description": "Name of the rate group. Optional. If set has to be unique within shipping service."
},
"carrierRates": {
"items": {
"$ref": "CarrierRate"
},
"type": "array",
"description": "A list of carrier rates that can be referred to by `mainTable` or `singleValue`."
},
"mainTable": {
"$ref": "Table",
"description": "A table defining the rate group, when `singleValue` is not expressive enough. Can only be set if `singleValue` is not set."
},
"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"
}
},
"singleValue": {
"description": "The value of the rate group (e.g. flat rate $10). Can only be set if `mainTable` and `subtables` are not set.",
"$ref": "Value"
}
},
"id": "RateGroup"
},
"RegionalInventory": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#regionalInventory\"."
},
"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": {
"description": "The sale price of the product. Mandatory if `sale_price_effective_date` is defined.",
"$ref": "Price"
},
"regionId": {
"type": "string",
"description": "The ID uniquely identifying each region."
},
"customAttributes": {
"type": "array",
"description": "A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the feed specification in its generic form.",
"items": {
"$ref": "CustomAttribute"
}
},
"price": {
"$ref": "Price",
"description": "The price of the product."
},
"availability": {
"type": "string",
"description": "The availability of the product."
}
},
"id": "RegionalInventory",
"description": "Regional inventory resource. contains the regional name and all attributes which are overridden for the specified region."
},
"LiasettingsRequestInventoryVerificationResponse": {
"id": "LiasettingsRequestInventoryVerificationResponse",
"properties": {
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#liasettingsRequestInventoryVerificationResponse\"."
}
},
"type": "object"
},
"PosSaleRequest": {
"id": "PosSaleRequest",
"properties": {
"timestamp": {
"description": "Required. The inventory timestamp, in ISO 8601 format.",
"type": "string"
},
"targetCountry": {
"type": "string",
"description": "Required. The CLDR territory code for the item."
},
"gtin": {
"type": "string",
"description": "Global Trade Item Number."
},
"quantity": {
"format": "int64",
"description": "Required. The relative change of the available quantity. Negative for items returned.",
"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."
},
"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"
},
"saleId": {
"type": "string",
"description": "A unique ID to group items from the same sale event."
},
"price": {
"description": "Required. The price of the item.",
"$ref": "Price"
}
},
"type": "object"
},
"MerchantRejectionReason": {
"type": "object",
"properties": {
"description": {
"type": "string",
"description": "Description of the reason."
},
"reasonCode": {
"type": "string",
"description": "Code of the rejection reason."
}
},
"id": "MerchantRejectionReason"
},
"AccountsCustomBatchResponse": {
"type": "object",
"id": "AccountsCustomBatchResponse",
"properties": {
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#accountsCustomBatchResponse\"."
},
"entries": {
"items": {
"$ref": "AccountsCustomBatchResponseEntry"
},
"description": "The result of the execution of the batch requests.",
"type": "array"
}
}
},
"ProductStatusItemLevelIssue": {
"properties": {
"resolution": {
"type": "string",
"description": "Whether the issue can be resolved by the merchant."
},
"servability": {
"type": "string",
"description": "How this issue affects serving of the offer."
},
"destination": {
"type": "string",
"description": "The destination the issue applies to."
},
"description": {
"type": "string",
"description": "A short issue description in English."
},
"code": {
"type": "string",
"description": "The error code of the issue."
},
"applicableCountries": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of country codes (ISO 3166-1 alpha-2) where issue applies to the offer."
},
"documentation": {
"description": "The URL of a web page to help with resolving this issue.",
"type": "string"
},
"attributeName": {
"description": "The attribute's name, if the issue is caused by a single attribute.",
"type": "string"
},
"detail": {
"type": "string",
"description": "A detailed issue description in English."
}
},
"type": "object",
"id": "ProductStatusItemLevelIssue"
},
"ProductstatusesCustomBatchRequest": {
"type": "object",
"properties": {
"entries": {
"type": "array",
"description": "The request entries to be processed in the batch.",
"items": {
"$ref": "ProductstatusesCustomBatchRequestEntry"
}
}
},
"id": "ProductstatusesCustomBatchRequest"
},
"SettlementTransaction": {
"properties": {
"identifiers": {
"description": "Identifiers of the transaction.",
"$ref": "SettlementTransactionIdentifiers"
},
"amount": {
"$ref": "SettlementTransactionAmount",
"description": "The amount for the transaction."
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"`content#settlementTransaction`\""
},
"transaction": {
"description": "Details of the transaction.",
"$ref": "SettlementTransactionTransaction"
}
},
"id": "SettlementTransaction",
"description": "Settlement transactions give a detailed breakdown of the settlement report.",
"type": "object"
},
"OrdersRefundOrderRequest": {
"id": "OrdersRefundOrderRequest",
"type": "object",
"properties": {
"reason": {
"type": "string",
"description": "The reason for the refund. Acceptable values are: - \"`courtesyAdjustment`\" - \"`other`\" "
},
"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."
},
"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"
},
"amount": {
"$ref": "MonetaryAmount",
"description": "The amount that is refunded. If this is not the first refund for the order, this should be the newly refunded amount."
}
}
},
"AccountStatusProducts": {
"id": "AccountStatusProducts",
"type": "object",
"properties": {
"channel": {
"description": "The channel the data applies to. Acceptable values are: - \"`local`\" - \"`online`\" ",
"type": "string"
},
"itemLevelIssues": {
"description": "List of item-level issues.",
"type": "array",
"items": {
"$ref": "AccountStatusItemLevelIssue"
}
},
"destination": {
"type": "string",
"description": "The destination the data applies to."
},
"statistics": {
"$ref": "AccountStatusStatistics",
"description": "Aggregated product statistics."
},
"country": {
"description": "The country the data applies to.",
"type": "string"
}
}
},
"DatafeedTarget": {
"type": "object",
"properties": {
"country": {
"type": "string",
"description": "The country where the items in the feed will be included in the search index, represented as a CLDR territory code."
},
"language": {
"type": "string",
"description": "The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for `targets[].country`."
},
"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`. List of supported destinations (if available to the account): - DisplayAds - Shopping - ShoppingActions - SurfacesAcrossGoogle ",
"items": {
"type": "string"
}
},
"excludedDestinations": {
"description": "The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center).",
"items": {
"type": "string"
},
"type": "array"
}
},
"id": "DatafeedTarget"
},
"OrderCustomer": {
"type": "object",
"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": {
"description": "Full name of the customer.",
"type": "string"
},
"invoiceReceivingEmail": {
"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.",
"type": "string"
},
"loyaltyInfo": {
"description": "Loyalty program information.",
"$ref": "OrderCustomerLoyaltyInfo"
}
},
"id": "OrderCustomer"
},
"OrderShipmentLineItemShipment": {
"id": "OrderShipmentLineItemShipment",
"type": "object",
"properties": {
"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"
},
"quantity": {
"description": "The quantity that is shipped.",
"format": "uint32",
"type": "integer"
},
"lineItemId": {
"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.",
"type": "string"
}
}
},
"ReturnShipment": {
"id": "ReturnShipment",
"type": "object",
"properties": {
"creationDate": {
"type": "string",
"description": "The date of creation of the shipment, in ISO 8601 format."
},
"shippingDate": {
"type": "string",
"description": "The date of shipping of the shipment, in ISO 8601 format."
},
"state": {
"description": "State of the shipment. Acceptable values are: - \"`completed`\" - \"`new`\" - \"`shipped`\" - \"`undeliverable`\" - \"`pending`\" ",
"type": "string"
},
"returnMethodType": {
"type": "string",
"description": "Type of the return method. Acceptable values are: - \"`byMail`\" - \"`contactCustomerSupport`\" - \"`returnless`\" "
},
"shipmentId": {
"type": "string",
"description": "Shipment ID generated by Google."
},
"deliveryDate": {
"description": "The date of delivery of the shipment, in ISO 8601 format.",
"type": "string"
},
"shipmentTrackingInfos": {
"items": {
"$ref": "ShipmentTrackingInfo"
},
"type": "array",
"description": "Tracking information of the shipment. One return shipment might be handled by several shipping carriers sequentially."
}
}
},
"TestOrderPickupDetailsPickupPerson": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Required. Full name of the pickup person."
},
"phoneNumber": {
"description": "Required. The phone number of the person picking up the items.",
"type": "string"
}
},
"id": "TestOrderPickupDetailsPickupPerson"
},
"PosStore": {
"description": "Store resource.",
"id": "PosStore",
"properties": {
"storeAddress": {
"description": "Required. The street address of the store.",
"type": "string"
},
"storeCode": {
"type": "string",
"description": "Required. A store identifier that is unique for the given merchant."
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"`content#posStore`\""
}
},
"type": "object"
},
"RepricingRuleEffectiveTime": {
"id": "RepricingRuleEffectiveTime",
"properties": {
"fixedTimePeriods": {
"description": "A list of fixed time periods combined with OR. The maximum number of entries is limited to 5.",
"type": "array",
"items": {
"$ref": "RepricingRuleEffectiveTimeFixedTimePeriod"
}
}
},
"type": "object"
},
"OrderPickupDetailsCollector": {
"id": "OrderPickupDetailsCollector",
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the person picking up the shipment."
},
"phoneNumber": {
"description": "Phone number of the person picking up the shipment.",
"type": "string"
}
}
},
"UnitInvoiceAdditionalCharge": {
"type": "object",
"id": "UnitInvoiceAdditionalCharge",
"properties": {
"type": {
"description": "[required] Type of the additional charge. Acceptable values are: - \"`shipping`\" ",
"type": "string"
},
"additionalChargeAmount": {
"$ref": "Amount",
"description": "[required] Amount of the additional charge."
}
}
},
"RepricingRuleRestriction": {
"id": "RepricingRuleRestriction",
"properties": {
"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."
},
"floor": {
"description": "The inclusive floor lower bound. The repricing rule only applies when new price \u003e= floor.",
"$ref": "RepricingRuleRestrictionBoundary"
}
},
"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).",
"type": "object"
},
"DatafeedStatusError": {
"properties": {
"code": {
"description": "The code of the error, e.g., \"validation/invalid_value\".",
"type": "string"
},
"examples": {
"items": {
"$ref": "DatafeedStatusExample"
},
"description": "A list of example occurrences of the error, grouped by product.",
"type": "array"
},
"message": {
"description": "The error message, e.g., \"Invalid price\".",
"type": "string"
},
"count": {
"description": "The number of occurrences of the error in the feed.",
"type": "string",
"format": "uint64"
}
},
"id": "DatafeedStatusError",
"description": "An error occurring in the feed, like \"invalid price\".",
"type": "object"
},
"OrdersCreateTestOrderRequest": {
"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"
},
"testOrder": {
"$ref": "TestOrder",
"description": "The test order to create."
},
"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"
}
},
"id": "OrdersCreateTestOrderRequest",
"type": "object"
},
"OrdersAcknowledgeResponse": {
"id": "OrdersAcknowledgeResponse",
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersAcknowledgeResponse\"."
},
"executionStatus": {
"description": "The status of the execution. Acceptable values are: - \"`duplicate`\" - \"`executed`\" ",
"type": "string"
}
}
},
"OrdersUpdateMerchantOrderIdResponse": {
"type": "object",
"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#ordersUpdateMerchantOrderIdResponse\".",
"type": "string"
}
},
"id": "OrdersUpdateMerchantOrderIdResponse"
},
"AccountstatusesCustomBatchResponse": {
"properties": {
"entries": {
"items": {
"$ref": "AccountstatusesCustomBatchResponseEntry"
},
"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#accountstatusesCustomBatchResponse\".",
"type": "string"
}
},
"type": "object",
"id": "AccountstatusesCustomBatchResponse"
},
"PosDataProviders": {
"type": "object",
"id": "PosDataProviders",
"properties": {
"country": {
"type": "string",
"description": "Country code."
},
"posDataProviders": {
"type": "array",
"description": "A list of POS data providers.",
"items": {
"$ref": "PosDataProvidersPosDataProvider"
}
}
}
},
"OrderCustomerMarketingRightsInfo": {
"type": "object",
"properties": {
"marketingEmailAddress": {
"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.",
"type": "string"
},
"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`\" "
},
"lastUpdatedTimestamp": {
"type": "string",
"description": "Timestamp when last time marketing preference was updated. Could be empty, if user wasn't offered a selection yet."
}
},
"id": "OrderCustomerMarketingRightsInfo"
},
"DatafeedsFetchNowResponse": {
"type": "object",
"properties": {
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#datafeedsFetchNowResponse\".",
"type": "string"
}
},
"id": "DatafeedsFetchNowResponse"
},
"OrdersCancelTestOrderByCustomerRequest": {
"type": "object",
"id": "OrdersCancelTestOrderByCustomerRequest",
"properties": {
"reason": {
"type": "string",
"description": "The reason for the cancellation. Acceptable values are: - \"`changedMind`\" - \"`orderedWrongItem`\" - \"`other`\" "
}
}
},
"Price": {
"type": "object",
"properties": {
"currency": {
"type": "string",
"description": "The currency of the price."
},
"value": {
"type": "string",
"description": "The price represented as a number."
}
},
"id": "Price"
},
"ReturnpolicyCustomBatchResponse": {
"id": "ReturnpolicyCustomBatchResponse",
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#returnpolicyCustomBatchResponse\"."
},
"entries": {
"type": "array",
"description": "The result of the execution of the batch requests.",
"items": {
"$ref": "ReturnpolicyCustomBatchResponseEntry"
}
}
}
},
"AccountStatusItemLevelIssue": {
"type": "object",
"properties": {
"resolution": {
"description": "Whether the issue can be resolved by the merchant.",
"type": "string"
},
"numItems": {
"type": "string",
"format": "int64",
"description": "Number of items with this issue."
},
"servability": {
"type": "string",
"description": "How this issue affects serving of the offer."
},
"detail": {
"description": "A detailed issue description in English.",
"type": "string"
},
"description": {
"description": "A short issue description in English.",
"type": "string"
},
"code": {
"description": "The error code of the issue.",
"type": "string"
},
"documentation": {
"type": "string",
"description": "The URL of a web page to help with resolving this issue."
},
"attributeName": {
"type": "string",
"description": "The attribute's name, if the issue is caused by a single attribute."
}
},
"id": "AccountStatusItemLevelIssue"
},
"PickupServicesPickupService": {
"id": "PickupServicesPickupService",
"properties": {
"country": {
"type": "string",
"description": "The CLDR country code of the carrier (e.g., \"US\"). Always present."
},
"carrierName": {
"description": "The name of the carrier (e.g., `\"UPS\"`). Always present.",
"type": "string"
},
"serviceName": {
"description": "The name of the pickup service (e.g., `\"Access point\"`). Always present.",
"type": "string"
}
},
"type": "object"
},
"AccounttaxCustomBatchResponseEntry": {
"id": "AccounttaxCustomBatchResponseEntry",
"properties": {
"errors": {
"description": "A list of errors defined if and only if the request failed.",
"$ref": "Errors"
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"`content#accounttaxCustomBatchResponseEntry`\""
},
"accountTax": {
"$ref": "AccountTax",
"description": "The retrieved or updated account tax settings."
},
"batchId": {
"type": "integer",
"format": "uint32",
"description": "The ID of the request entry this entry responds to."
}
},
"type": "object",
"description": "A batch entry encoding a single non-batch accounttax response."
},
"ReturnaddressCustomBatchResponse": {
"id": "ReturnaddressCustomBatchResponse",
"type": "object",
"properties": {
"entries": {
"description": "The result of the execution of the batch requests.",
"type": "array",
"items": {
"$ref": "ReturnaddressCustomBatchResponseEntry"
}
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#returnaddressCustomBatchResponse\"."
}
}
},
"OrdersInStoreRefundLineItemRequest": {
"id": "OrdersInStoreRefundLineItemRequest",
"properties": {
"operationId": {
"description": "The ID of the operation. Unique across all operations for a given order.",
"type": "string"
},
"lineItemId": {
"type": "string",
"description": "The ID of the line item to return. Either lineItemId or productId is required."
},
"quantity": {
"type": "integer",
"format": "uint32",
"description": "The quantity to return and refund."
},
"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"
},
"reasonText": {
"type": "string",
"description": "The explanation of the reason."
},
"taxAmount": {
"description": "The amount of tax to be refunded. Required.",
"$ref": "Price"
},
"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`\" "
},
"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"
}
},
"type": "object"
},
"OrderPromotionItem": {
"properties": {
"quantity": {
"format": "int32",
"type": "integer",
"description": "The quantity of the associated product. Do not provide for `orders.createtestorder`."
},
"lineItemId": {
"type": "string",
"description": "The line item ID of a product. Do not provide for `orders.createtestorder`."
},
"productId": {
"description": "`orders.createtestorder`.",
"type": "string"
},
"offerId": {
"description": "Required. Offer ID of a product. Only for `orders.createtestorder`.",
"type": "string"
}
},
"type": "object",
"id": "OrderPromotionItem"
},
"TransitTableTransitTimeRowTransitTimeValue": {
"id": "TransitTableTransitTimeRowTransitTimeValue",
"properties": {
"minTransitTimeInDays": {
"type": "integer",
"description": "Transit time range (min-max) in business days. 0 means same day delivery, 1 means next day delivery.",
"format": "uint32"
},
"maxTransitTimeInDays": {
"type": "integer",
"format": "uint32",
"description": "Must be greater than or equal to `minTransitTimeInDays`."
}
},
"type": "object"
},
"ShippingsettingsGetSupportedHolidaysResponse": {
"type": "object",
"id": "ShippingsettingsGetSupportedHolidaysResponse",
"properties": {
"holidays": {
"items": {
"$ref": "HolidaysHoliday"
},
"description": "A list of holidays applicable for delivery guarantees. May be empty.",
"type": "array"
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#shippingsettingsGetSupportedHolidaysResponse\"."
}
}
},
"OrdersCustomBatchRequestEntryRefundItemItem": {
"properties": {
"quantity": {
"format": "int32",
"description": "The number of products that are refunded.",
"type": "integer"
},
"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"
},
"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."
},
"lineItemId": {
"type": "string",
"description": "The ID of the line item. Either lineItemId or productId is required."
}
},
"id": "OrdersCustomBatchRequestEntryRefundItemItem",
"type": "object"
},
"ReturnPolicy": {
"type": "object",
"description": "Return policy resource.",
"id": "ReturnPolicy",
"properties": {
"nonFreeReturnReasons": {
"description": "Return reasons that will incur return fees.",
"type": "array",
"items": {
"type": "string"
}
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"`content#returnPolicy`\""
},
"seasonalOverrides": {
"description": "An optional list of seasonal overrides.",
"items": {
"$ref": "ReturnPolicySeasonalOverride"
},
"type": "array"
},
"policy": {
"description": "Required. The policy.",
"$ref": "ReturnPolicyPolicy"
},
"label": {
"description": "Required. The user-defined label of the return policy. For the default policy, use the label \"default\".",
"type": "string"
},
"name": {
"description": "Required. The name of the policy as shown in Merchant Center.",
"type": "string"
},
"returnPolicyId": {
"type": "string",
"description": "Return policy ID generated by Google."
},
"country": {
"type": "string",
"description": "Required. The country of sale where the return policy is applicable."
}
}
},
"ReturnPolicyPolicy": {
"id": "ReturnPolicyPolicy",
"properties": {
"type": {
"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`\" ",
"type": "string"
},
"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"
},
"numberOfDays": {
"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.",
"type": "string",
"format": "int64"
}
},
"type": "object"
},
"OrderinvoicesCreateChargeInvoiceResponse": {
"id": "OrderinvoicesCreateChargeInvoiceResponse",
"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#orderinvoicesCreateChargeInvoiceResponse\"."
}
}
},
"LiasettingsSetPosDataProviderResponse": {
"properties": {
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#liasettingsSetPosDataProviderResponse\".",
"type": "string"
}
},
"type": "object",
"id": "LiasettingsSetPosDataProviderResponse"
},
"OrderTrackingSignal": {
"properties": {
"merchantId": {
"format": "int64",
"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).",
"type": "string"
},
"deliveryPostalCode": {
"description": "Required. The delivery postal code, as a continuous string without spaces or dashes, e.g. \"95016\".",
"type": "string"
},
"orderCreatedTime": {
"$ref": "DateTime",
"description": "Required. The time when the order was created on the merchant side. Include the year and timezone string, if available."
},
"orderId": {
"description": "Required. The ID of the order on the merchant side.",
"type": "string"
},
"shippingInfo": {
"items": {
"$ref": "OrderTrackingSignalShippingInfo"
},
"type": "array",
"description": "The shipping information for the order."
},
"orderTrackingSignalId": {
"format": "int64",
"type": "string",
"readOnly": true,
"description": "Output only. The ID that uniquely identifies this order tracking signal."
},
"lineItems": {
"type": "array",
"description": "Information about line items in the order.",
"items": {
"$ref": "OrderTrackingSignalLineItemDetails"
}
},
"shipmentLineItemMapping": {
"type": "array",
"items": {
"$ref": "OrderTrackingSignalShipmentLineItemMapping"
},
"description": "The mapping of the line items to the shipment information."
},
"customerShippingFee": {
"description": "The shipping fee of the order; this value should be set to zero in the case of free shipping.",
"$ref": "PriceAmount"
},
"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"
}
},
"type": "object",
"id": "OrderTrackingSignal",
"description": "Represents a merchant trade from which signals are extracted, e.g. shipping."
},
"OrderLineItemProductVariantAttribute": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "The value for the dimension."
},
"dimension": {
"description": "The dimension of the variant.",
"type": "string"
}
},
"id": "OrderLineItemProductVariantAttribute"
},
"OrderinvoicesCreateRefundInvoiceResponse": {
"type": "object",
"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#orderinvoicesCreateRefundInvoiceResponse\"."
}
},
"id": "OrderinvoicesCreateRefundInvoiceResponse"
},
"OrderMerchantProvidedAnnotation": {
"properties": {
"value": {
"description": "Value for additional merchant provided (as key-value pairs) annotation about the line item.",
"type": "string"
},
"key": {
"description": "Key for additional merchant provided (as key-value pairs) annotation about the line item.",
"type": "string"
}
},
"type": "object",
"id": "OrderMerchantProvidedAnnotation"
},
"AccountGoogleMyBusinessLink": {
"id": "AccountGoogleMyBusinessLink",
"properties": {
"status": {
"description": "Status of the link between this Merchant Center account and the GMB account. Acceptable values are: - \"`active`\" - \"`pending`\" ",
"type": "string"
},
"gmbEmail": {
"type": "string",
"description": "The GMB email address of which a specific account within a GMB account. A sample account within a GMB account could be a business account with set of locations, managed under the GMB account."
},
"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"
}
},
"type": "object"
},
"ReturnpolicyCustomBatchRequest": {
"id": "ReturnpolicyCustomBatchRequest",
"type": "object",
"properties": {
"entries": {
"type": "array",
"description": "The request entries to be processed in the batch.",
"items": {
"$ref": "ReturnpolicyCustomBatchRequestEntry"
}
}
}
},
"RegionGeoTargetArea": {
"id": "RegionGeoTargetArea",
"description": "A list of geotargets that defines the region area.",
"properties": {
"geotargetCriteriaIds": {
"items": {
"format": "int64",
"type": "string"
},
"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)."
}
},
"type": "object"
},
"OrdersCustomBatchRequestEntryCreateTestReturnReturnItem": {
"properties": {
"lineItemId": {
"type": "string",
"description": "The ID of the line item to return."
},
"quantity": {
"description": "Quantity that is returned.",
"format": "uint32",
"type": "integer"
}
},
"type": "object",
"id": "OrdersCustomBatchRequestEntryCreateTestReturnReturnItem"
},
"InvoiceSummaryAdditionalChargeSummary": {
"type": "object",
"id": "InvoiceSummaryAdditionalChargeSummary",
"properties": {
"totalAmount": {
"$ref": "Amount",
"description": "[required] Total additional charge for this type."
},
"type": {
"type": "string",
"description": "[required] Type of the additional charge. Acceptable values are: - \"`shipping`\" "
}
}
},
"ProductsListResponse": {
"properties": {
"nextPageToken": {
"type": "string",
"description": "The token for the retrieval of the next page of products."
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#productsListResponse\".",
"type": "string"
},
"resources": {
"type": "array",
"items": {
"$ref": "Product"
}
}
},
"type": "object",
"id": "ProductsListResponse"
},
"OrdersCustomBatchRequestEntryRefundItemShipping": {
"type": "object",
"properties": {
"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.",
"type": "boolean"
},
"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."
}
},
"id": "OrdersCustomBatchRequestEntryRefundItemShipping"
},
"OrderLineItemShippingDetails": {
"type": "object",
"id": "OrderLineItemShippingDetails",
"properties": {
"method": {
"$ref": "OrderLineItemShippingDetailsMethod",
"description": "Required. Details of the shipping method."
},
"shipByDate": {
"type": "string",
"description": "Required. The ship by date, in ISO 8601 format."
},
"type": {
"description": "Type of shipment. Indicates whether `deliveryDetails` or `pickupDetails` is applicable for this shipment. Acceptable values are: - \"`delivery`\" - \"`pickup`\" ",
"type": "string"
},
"deliverByDate": {
"description": "Required. The delivery by date, in ISO 8601 format.",
"type": "string"
},
"pickupPromiseInMinutes": {
"type": "integer",
"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.",
"format": "uint32"
}
}
},
"OrdersCancelTestOrderByCustomerResponse": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersCancelTestOrderByCustomerResponse\"."
}
},
"id": "OrdersCancelTestOrderByCustomerResponse"
},
"OrderRefund": {
"id": "OrderRefund",
"type": "object",
"properties": {
"reasonText": {
"type": "string",
"description": "The explanation of the reason."
},
"creationDate": {
"type": "string",
"description": "Date on which the item has been created, in ISO 8601 format."
},
"actor": {
"type": "string",
"description": "The actor that created the refund. Acceptable values are: - \"`customer`\" - \"`googleBot`\" - \"`googleCustomerService`\" - \"`googlePayments`\" - \"`googleSabre`\" - \"`merchant`\" "
},
"amount": {
"$ref": "Price",
"description": "The amount that is refunded."
},
"reason": {
"description": "The reason for the refund. Acceptable values are: - \"`adjustment`\" - \"`autoPostInternal`\" - \"`autoPostInvalidBillingAddress`\" - \"`autoPostNoInventory`\" - \"`autoPostPriceError`\" - \"`autoPostUndeliverableShippingAddress`\" - \"`couponAbuse`\" - \"`courtesyAdjustment`\" - \"`customerCanceled`\" - \"`customerDiscretionaryReturn`\" - \"`customerInitiatedMerchantCancel`\" - \"`customerSupportRequested`\" - \"`deliveredLateByCarrier`\" - \"`deliveredTooLate`\" - \"`expiredItem`\" - \"`failToPushOrderGoogleError`\" - \"`failToPushOrderMerchantError`\" - \"`failToPushOrderMerchantFulfillmentError`\" - \"`failToPushOrderToMerchant`\" - \"`failToPushOrderToMerchantOutOfStock`\" - \"`feeAdjustment`\" - \"`invalidCoupon`\" - \"`lateShipmentCredit`\" - \"`malformedShippingAddress`\" - \"`merchantDidNotShipOnTime`\" - \"`noInventory`\" - \"`orderTimeout`\" - \"`other`\" - \"`paymentAbuse`\" - \"`paymentDeclined`\" - \"`priceAdjustment`\" - \"`priceError`\" - \"`productArrivedDamaged`\" - \"`productNotAsDescribed`\" - \"`promoReallocation`\" - \"`qualityNotAsExpected`\" - \"`returnRefundAbuse`\" - \"`shippingCostAdjustment`\" - \"`shippingPriceError`\" - \"`taxAdjustment`\" - \"`taxError`\" - \"`undeliverableShippingAddress`\" - \"`unsupportedPoBoxAddress`\" - \"`wrongProductShipped`\" ",
"type": "string"
}
}
},
"Error": {
"id": "Error",
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "A description of the error."
},
"domain": {
"description": "The domain of the error.",
"type": "string"
},
"reason": {
"type": "string",
"description": "The error code."
}
},
"description": "An error returned by the API."
},
"PostalCodeGroup": {
"properties": {
"country": {
"description": "The CLDR territory code of the country the postal code group applies to. Required.",
"type": "string"
},
"name": {
"type": "string",
"description": "The name of the postal code group, referred to in headers. Required."
},
"postalCodeRanges": {
"type": "array",
"items": {
"$ref": "PostalCodeRange"
},
"description": "A range of postal codes. Required."
}
},
"id": "PostalCodeGroup",
"type": "object"
},
"OrdersGetTestOrderTemplateResponse": {
"type": "object",
"id": "OrdersGetTestOrderTemplateResponse",
"properties": {
"template": {
"$ref": "TestOrder",
"description": "The requested test order template."
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersGetTestOrderTemplateResponse\".",
"type": "string"
}
}
},
"ReturnAddress": {
"type": "object",
"properties": {
"phoneNumber": {
"description": "Required. The merchant's contact phone number regarding the return.",
"type": "string"
},
"label": {
"type": "string",
"description": "Required. The user-defined label of the return address. For the default address, use the label \"default\"."
},
"address": {
"description": "Required. The address.",
"$ref": "ReturnAddressAddress"
},
"returnAddressId": {
"description": "Return address ID generated by Google.",
"type": "string"
},
"country": {
"type": "string",
"description": "Required. The country of sale where the return address is applicable."
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"`content#returnAddress`\"",
"type": "string"
}
},
"description": "Return address resource.",
"id": "ReturnAddress"
},
"LinkService": {
"id": "LinkService",
"type": "object",
"properties": {
"service": {
"type": "string",
"description": "Service provided to or by the linked account. Acceptable values are: - \"`shoppingActionsOrderManagement`\" - \"`shoppingActionsProductManagement`\" - \"`shoppingAdsProductManagement`\" "
},
"status": {
"description": "Status of the link Acceptable values are: - \"`active`\" - \"`inactive`\" - \"`pending`\" ",
"type": "string"
}
}
},
"OrdersCancelLineItemResponse": {
"id": "OrdersCancelLineItemResponse",
"properties": {
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersCancelLineItemResponse\".",
"type": "string"
},
"executionStatus": {
"description": "The status of the execution. Acceptable values are: - \"`duplicate`\" - \"`executed`\" ",
"type": "string"
}
},
"type": "object"
},
"LocalinventoryCustomBatchRequestEntry": {
"description": "Batch entry encoding a single local inventory update request.",
"id": "LocalinventoryCustomBatchRequestEntry",
"properties": {
"merchantId": {
"type": "string",
"description": "The ID of the managing account.",
"format": "uint64"
},
"method": {
"description": "Method of the batch request entry. Acceptable values are: - \"`insert`\" ",
"type": "string"
},
"localInventory": {
"description": "Local inventory of the product.",
"$ref": "LocalInventory"
},
"productId": {
"type": "string",
"description": "The ID of the product for which to update local inventory."
},
"batchId": {
"format": "uint32",
"description": "An entry ID, unique within the batch request.",
"type": "integer"
}
},
"type": "object"
},
"AccountsClaimWebsiteResponse": {
"id": "AccountsClaimWebsiteResponse",
"properties": {
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#accountsClaimWebsiteResponse\".",
"type": "string"
}
},
"type": "object"
},
"LiasettingsListResponse": {
"type": "object",
"properties": {
"nextPageToken": {
"description": "The token for the retrieval of the next page of LIA settings.",
"type": "string"
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#liasettingsListResponse\"."
},
"resources": {
"type": "array",
"items": {
"$ref": "LiaSettings"
}
}
},
"id": "LiasettingsListResponse"
},
"OrderreturnsCreateOrderReturnResponse": {
"properties": {
"orderReturn": {
"$ref": "MerchantOrderReturn",
"description": "Created order return."
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#orderreturnsCreateOrderReturnResponse\"."
},
"executionStatus": {
"type": "string",
"description": "The status of the execution. Acceptable values are: - \"`duplicate`\" - \"`executed`\" "
}
},
"type": "object",
"id": "OrderreturnsCreateOrderReturnResponse"
},
"ReturnpolicyCustomBatchRequestEntry": {
"properties": {
"returnPolicyId": {
"type": "string",
"description": "The return policy ID. This should be set only if the method is `delete` or `get`."
},
"method": {
"type": "string",
"description": "Method of the batch request entry. Acceptable values are: - \"`delete`\" - \"`get`\" - \"`insert`\" "
},
"returnPolicy": {
"$ref": "ReturnPolicy",
"description": "The return policy to submit. This should be set only if the method is `insert`."
},
"batchId": {
"type": "integer",
"format": "uint32",
"description": "An entry ID, unique within the batch request."
},
"merchantId": {
"description": "The Merchant Center account ID.",
"type": "string",
"format": "uint64"
}
},
"type": "object",
"id": "ReturnpolicyCustomBatchRequestEntry"
},
"ProductProductDetail": {
"id": "ProductProductDetail",
"properties": {
"attributeValue": {
"type": "string",
"description": "The value of the product detail."
},
"sectionName": {
"type": "string",
"description": "The section header used to group a set of product details."
},
"attributeName": {
"type": "string",
"description": "The name of the product detail."
}
},
"type": "object"
},
"OrderreturnsAcknowledgeResponse": {
"properties": {
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#orderreturnsAcknowledgeResponse\".",
"type": "string"
},
"executionStatus": {
"type": "string",
"description": "The status of the execution. Acceptable values are: - \"`duplicate`\" - \"`executed`\" "
}
},
"type": "object",
"id": "OrderreturnsAcknowledgeResponse"
},
"AccountsUpdateLabelsResponse": {
"id": "AccountsUpdateLabelsResponse",
"properties": {
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#accountsUpdateLabelsResponse\".",
"type": "string"
}
},
"type": "object"
},
"InvoiceSummary": {
"properties": {
"productTotal": {
"$ref": "Amount",
"description": "[required] Total price for the product."
},
"additionalChargeSummaries": {
"items": {
"$ref": "InvoiceSummaryAdditionalChargeSummary"
},
"type": "array",
"description": "Summary of the total amounts of the additional charges."
}
},
"type": "object",
"id": "InvoiceSummary"
},
"RegionalinventoryCustomBatchRequest": {
"type": "object",
"properties": {
"entries": {
"type": "array",
"description": "The request entries to be processed in the batch.",
"items": {
"$ref": "RegionalinventoryCustomBatchRequestEntry"
}
}
},
"id": "RegionalinventoryCustomBatchRequest"
},
"Weight": {
"properties": {
"value": {
"description": "Required. The weight represented as a number.",
"type": "string"
},
"unit": {
"type": "string",
"description": "Required. The weight unit. Acceptable values are: - \"`kg`\" - \"`lb`\" "
}
},
"type": "object",
"id": "Weight"
},
"HolidayCutoff": {
"type": "object",
"id": "HolidayCutoff",
"properties": {
"deadlineHour": {
"description": "Hour of the day on the deadline date until which the order has to be placed to qualify for the delivery guarantee. Possible values are: 0 (midnight), 1, ..., 12 (noon), 13, ..., 23. Required.",
"format": "uint32",
"type": "integer"
},
"deadlineTimezone": {
"description": "Timezone identifier for the deadline hour. A list of identifiers can be found in the AdWords API documentation. E.g. \"Europe/Zurich\". Required.",
"type": "string"
},
"deadlineDate": {
"description": "Date of the order deadline, in ISO 8601 format. E.g. \"2016-11-29\" for 29th November 2016. Required.",
"type": "string"
},
"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."
},
"holidayId": {
"description": "Unique identifier for the holiday. Required.",
"type": "string"
}
}
},
"ProductsCustomBatchRequest": {
"properties": {
"entries": {
"items": {
"$ref": "ProductsCustomBatchRequestEntry"
},
"type": "array",
"description": "The request entries to be processed in the batch."
}
},
"type": "object",
"id": "ProductsCustomBatchRequest"
},
"OrdersRefundItemResponse": {
"id": "OrdersRefundItemResponse",
"properties": {
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersRefundItemResponse\"."
},
"executionStatus": {
"type": "string",
"description": "The status of the execution. Acceptable values are: - \"`duplicate`\" - \"`executed`\" "
}
},
"type": "object"
},
"ProductstatusesCustomBatchResponse": {
"id": "ProductstatusesCustomBatchResponse",
"properties": {
"entries": {
"items": {
"$ref": "ProductstatusesCustomBatchResponseEntry"
},
"type": "array",
"description": "The result of the execution of the batch requests."
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#productstatusesCustomBatchResponse\"."
}
},
"type": "object"
},
"OrdersCancelLineItemRequest": {
"type": "object",
"id": "OrdersCancelLineItemRequest",
"properties": {
"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."
},
"operationId": {
"type": "string",
"description": "The ID of the operation. Unique across all operations for a given order."
},
"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."
},
"reason": {
"type": "string",
"description": "The reason for the cancellation. Acceptable values are: - \"`customerInitiatedCancel`\" - \"`invalidCoupon`\" - \"`malformedShippingAddress`\" - \"`noInventory`\" - \"`other`\" - \"`priceError`\" - \"`shippingPriceError`\" - \"`taxError`\" - \"`undeliverableShippingAddress`\" - \"`unsupportedPoBoxAddress`\" "
},
"reasonText": {
"type": "string",
"description": "The explanation of the reason."
}
}
},
"ProductStatusDestinationStatus": {
"type": "object",
"properties": {
"pendingCountries": {
"description": "List of country codes (ISO 3166-1 alpha-2) where the offer is pending approval.",
"items": {
"type": "string"
},
"type": "array"
},
"approvedCountries": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of country codes (ISO 3166-1 alpha-2) where the offer is approved."
},
"disapprovedCountries": {
"items": {
"type": "string"
},
"description": "List of country codes (ISO 3166-1 alpha-2) where the offer is disapproved.",
"type": "array"
},
"status": {
"description": "Destination approval status in `targetCountry` of the offer.",
"type": "string"
},
"destination": {
"description": "The name of the destination",
"type": "string"
}
},
"id": "ProductStatusDestinationStatus"
},
"LocalinventoryCustomBatchRequest": {
"id": "LocalinventoryCustomBatchRequest",
"type": "object",
"properties": {
"entries": {
"description": "The request entries to be processed in the batch.",
"items": {
"$ref": "LocalinventoryCustomBatchRequestEntry"
},
"type": "array"
}
}
},
"OrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceReturnOption": {
"id": "OrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceReturnOption",
"properties": {
"description": {
"type": "string",
"description": "Optional description of the return reason."
},
"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`\" "
}
},
"type": "object"
},
"OrdersUpdateLineItemShippingDetailsResponse": {
"type": "object",
"id": "OrdersUpdateLineItemShippingDetailsResponse",
"properties": {
"executionStatus": {
"type": "string",
"description": "The status of the execution. Acceptable values are: - \"`duplicate`\" - \"`executed`\" "
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersUpdateLineItemShippingDetailsResponse\"."
}
}
},
"MerchantOrderReturnItem": {
"type": "object",
"properties": {
"shipmentUnitId": {
"description": "ID of the shipment unit assigned by the merchant. Provided for shipments with invoice support.",
"type": "string"
},
"returnShipmentIds": {
"description": "IDs of the return shipments that this return item belongs to.",
"items": {
"type": "string"
},
"type": "array"
},
"merchantReturnReason": {
"$ref": "RefundReason",
"description": "The reason that merchant chooses to accept a return item."
},
"product": {
"description": "Product data from the time of the order placement.",
"$ref": "OrderLineItemProduct"
},
"shipmentGroupId": {
"description": "ID of the original shipment group. Provided for shipments with invoice support.",
"type": "string"
},
"itemId": {
"description": "Product level item ID. If the returned items are of the same product, they will have the same ID.",
"type": "string"
},
"customerReturnReason": {
"$ref": "CustomerReturnReason",
"description": "The reason that the customer chooses to return an item."
},
"state": {
"type": "string",
"description": "State of the item. Acceptable values are: - \"`canceled`\" - \"`new`\" - \"`received`\" - \"`refunded`\" - \"`rejected`\" "
},
"refundableAmount": {
"description": "Maximum amount that can be refunded for this return item.",
"$ref": "MonetaryAmount"
},
"merchantRejectionReason": {
"description": "The reason that the merchant chose to reject an item return.",
"$ref": "MerchantRejectionReason"
},
"returnItemId": {
"type": "string",
"description": "Unit level ID for the return item. Different units of the same product will have different IDs."
}
},
"id": "MerchantOrderReturnItem"
},
"AccountsAuthInfoResponse": {
"properties": {
"accountIdentifiers": {
"items": {
"$ref": "AccountIdentifier"
},
"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. ",
"type": "array"
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#accountsAuthInfoResponse\".",
"type": "string"
}
},
"type": "object",
"id": "AccountsAuthInfoResponse"
},
"ReturnAddressAddress": {
"type": "object",
"id": "ReturnAddressAddress",
"properties": {
"recipientName": {
"description": "Name of the recipient to address returns to.",
"type": "string"
},
"country": {
"type": "string",
"description": "CLDR country code (e.g. \"US\")."
},
"region": {
"type": "string",
"description": "Top-level administrative subdivision of the country. For example, a state like California (\"CA\") or a province like Quebec (\"QC\")."
},
"streetAddress": {
"type": "array",
"description": "Street-level part of the address. May be up to two lines, each line specified as an array element.",
"items": {
"type": "string"
}
},
"postalCode": {
"type": "string",
"description": "Postal code or ZIP (e.g. \"94043\")."
},
"locality": {
"type": "string",
"description": "City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs)."
}
}
},
"TestOrderDeliveryDetails": {
"id": "TestOrderDeliveryDetails",
"properties": {
"address": {
"$ref": "TestOrderAddress",
"description": "The delivery address"
},
"phoneNumber": {
"description": "The phone number of the person receiving the delivery.",
"type": "string"
}
},
"type": "object"
},
"TransitTable": {
"properties": {
"postalCodeGroupNames": {
"items": {
"type": "string"
},
"type": "array",
"description": "A list of postal group names. The last value can be `\"all other locations\"`. Example: `[\"zone 1\", \"zone 2\", \"all other locations\"]`. The referred postal code groups must match the delivery country of the service."
},
"rows": {
"items": {
"$ref": "TransitTableTransitTimeRow"
},
"type": "array"
},
"transitTimeLabels": {
"description": "A list of transit time labels. The last value can be `\"all other labels\"`. Example: `[\"food\", \"electronics\", \"all other labels\"]`.",
"type": "array",
"items": {
"type": "string"
}
}
},
"type": "object",
"id": "TransitTable"
},
"BusinessDayConfig": {
"type": "object",
"id": "BusinessDayConfig",
"properties": {
"businessDays": {
"description": "Regular business days. May not be empty.",
"items": {
"type": "string"
},
"type": "array"
}
}
},
"ProductsCustomBatchRequestEntry": {
"id": "ProductsCustomBatchRequestEntry",
"type": "object",
"description": "A batch entry encoding a single non-batch products request.",
"properties": {
"productId": {
"description": "The ID of the product to get or delete. Only defined if the method is `get` or `delete`.",
"type": "string"
},
"merchantId": {
"description": "The ID of the managing account.",
"type": "string",
"format": "uint64"
},
"product": {
"$ref": "Product",
"description": "The product to insert. Only required if the method is `insert`."
},
"batchId": {
"type": "integer",
"description": "An entry ID, unique within the batch request.",
"format": "uint32"
},
"method": {
"description": "The method of the batch entry. Acceptable values are: - \"`delete`\" - \"`get`\" - \"`insert`\" ",
"type": "string"
},
"feedId": {
"format": "uint64",
"description": "The Content API feed id.",
"type": "string"
}
}
},
"OrderOrderAnnotation": {
"id": "OrderOrderAnnotation",
"properties": {
"value": {
"type": "string",
"description": "Value for additional google provided (as key-value pairs) annotation."
},
"key": {
"description": "Key for additional google provided (as key-value pairs) annotation.",
"type": "string"
}
},
"type": "object"
},
"SettlementtransactionsListResponse": {
"type": "object",
"id": "SettlementtransactionsListResponse",
"properties": {
"resources": {
"items": {
"$ref": "SettlementTransaction"
},
"type": "array"
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#settlementtransactionsListResponse\".",
"type": "string"
},
"nextPageToken": {
"type": "string",
"description": "The token for the retrieval of the next page of returns."
}
}
},
"GmbAccountsGmbAccount": {
"properties": {
"type": {
"type": "string",
"description": "The type of the GMB account (User or Business)."
},
"listingCount": {
"description": "Number of listings under this account.",
"format": "uint64",
"type": "string"
},
"name": {
"type": "string",
"description": "The name of the GMB account."
},
"email": {
"description": "The email which identifies the GMB account.",
"type": "string"
}
},
"type": "object",
"id": "GmbAccountsGmbAccount"
},
"CarriersCarrier": {
"properties": {
"name": {
"description": "The name of the carrier (e.g., `\"UPS\"`). Always present.",
"type": "string"
},
"services": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of supported services (e.g., `\"ground\"`) for that carrier. Contains at least one service."
},
"country": {
"type": "string",
"description": "The CLDR country code of the carrier (e.g., \"US\"). Always present."
}
},
"type": "object",
"id": "CarriersCarrier"
},
"OrdersReturnRefundLineItemResponse": {
"type": "object",
"id": "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"
}
}
},
"OrderDeliveryDetails": {
"properties": {
"phoneNumber": {
"description": "The phone number of the person receiving the delivery.",
"type": "string"
},
"address": {
"description": "The delivery address",
"$ref": "OrderAddress"
}
},
"type": "object",
"id": "OrderDeliveryDetails"
},
"OrdersRejectReturnLineItemRequest": {
"id": "OrdersRejectReturnLineItemRequest",
"properties": {
"reasonText": {
"description": "The explanation of the reason.",
"type": "string"
},
"quantity": {
"description": "The quantity to return and refund.",
"format": "uint32",
"type": "integer"
},
"operationId": {
"type": "string",
"description": "The ID of the operation. Unique across all operations for a given order."
},
"lineItemId": {
"type": "string",
"description": "The ID of the line item to return. Either lineItemId or productId is required."
},
"reason": {
"type": "string",
"description": "The reason for the return. Acceptable values are: - \"`damagedOrUsed`\" - \"`missingComponent`\" - \"`notEligible`\" - \"`other`\" - \"`outOfReturnWindow`\" "
},
"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"
}
},
"type": "object"
},
"ReturnaddressCustomBatchResponseEntry": {
"type": "object",
"properties": {
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"`content#returnaddressCustomBatchResponseEntry`\"",
"type": "string"
},
"errors": {
"description": "A list of errors defined if, and only if, the request failed.",
"$ref": "Errors"
},
"batchId": {
"format": "uint32",
"description": "The ID of the request entry to which this entry responds.",
"type": "integer"
},
"returnAddress": {
"$ref": "ReturnAddress",
"description": "The retrieved return address."
}
},
"id": "ReturnaddressCustomBatchResponseEntry"
},
"DatafeedsListResponse": {
"id": "DatafeedsListResponse",
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#datafeedsListResponse\"."
},
"nextPageToken": {
"type": "string",
"description": "The token for the retrieval of the next page of datafeeds."
},
"resources": {
"items": {
"$ref": "Datafeed"
},
"type": "array"
}
}
},
"AccountstatusesCustomBatchRequest": {
"properties": {
"entries": {
"type": "array",
"items": {
"$ref": "AccountstatusesCustomBatchRequestEntry"
},
"description": "The request entries to be processed in the batch."
}
},
"type": "object",
"id": "AccountstatusesCustomBatchRequest"
},
"ReturnpolicyListResponse": {
"id": "ReturnpolicyListResponse",
"properties": {
"resources": {
"items": {
"$ref": "ReturnPolicy"
},
"type": "array"
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#returnpolicyListResponse\"."
}
},
"type": "object"
},
"DatafeedsCustomBatchResponseEntry": {
"description": "A batch entry encoding a single non-batch datafeeds response.",
"id": "DatafeedsCustomBatchResponseEntry",
"properties": {
"datafeed": {
"$ref": "Datafeed",
"description": "The requested data feed. Defined if and only if the request was successful."
},
"batchId": {
"description": "The ID of the request entry this entry responds to.",
"format": "uint32",
"type": "integer"
},
"errors": {
"$ref": "Errors",
"description": "A list of errors defined if and only if the request failed."
}
},
"type": "object"
},
"ProductShipping": {
"id": "ProductShipping",
"properties": {
"country": {
"type": "string",
"description": "The CLDR territory code of the country to which an item will ship."
},
"region": {
"description": "The geographic region to which a shipping rate applies.",
"type": "string"
},
"locationId": {
"type": "string",
"description": "The numeric ID of a location that the shipping rate applies to as defined in the AdWords API.",
"format": "int64"
},
"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"
},
"service": {
"type": "string",
"description": "A free-form description of the service class or delivery speed."
},
"price": {
"description": "Fixed shipping price, represented as a number.",
"$ref": "Price"
}
},
"type": "object"
},
"ReturnaddressCustomBatchRequest": {
"id": "ReturnaddressCustomBatchRequest",
"properties": {
"entries": {
"items": {
"$ref": "ReturnaddressCustomBatchRequestEntry"
},
"type": "array",
"description": "The request entries to be processed in the batch."
}
},
"type": "object"
},
"UnitInvoice": {
"properties": {
"unitPrice": {
"$ref": "Price",
"description": "[required] Pre-tax or post-tax price of the unit depending on the locality of the order."
},
"additionalCharges": {
"description": "Additional charges for a unit, e.g. shipping costs.",
"items": {
"$ref": "UnitInvoiceAdditionalCharge"
},
"type": "array"
},
"unitPriceTaxes": {
"items": {
"$ref": "UnitInvoiceTaxLine"
},
"type": "array",
"description": "Tax amounts to apply to the unit price."
}
},
"id": "UnitInvoice",
"type": "object"
},
"PosSaleResponse": {
"type": "object",
"properties": {
"targetCountry": {
"description": "Required. The CLDR territory code for the item.",
"type": "string"
},
"saleId": {
"type": "string",
"description": "A unique ID to group items from the same sale event."
},
"price": {
"$ref": "Price",
"description": "Required. The 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."
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#posSaleResponse\"."
},
"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": {
"type": "string",
"description": "Global Trade Item Number."
},
"contentLanguage": {
"description": "Required. The two-letter ISO 639-1 language code for the item.",
"type": "string"
},
"quantity": {
"format": "int64",
"description": "Required. The relative change of the available quantity. Negative for items returned.",
"type": "string"
}
},
"id": "PosSaleResponse"
},
"ProductStatus": {
"description": "The status of a product, i.e., information about a product computed asynchronously.",
"id": "ProductStatus",
"properties": {
"productId": {
"description": "The ID of the product for which status is reported.",
"type": "string"
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"`content#productStatus`\"",
"type": "string"
},
"destinationStatuses": {
"type": "array",
"items": {
"$ref": "ProductStatusDestinationStatus"
},
"description": "The intended destinations for the product."
},
"creationDate": {
"description": "Date on which the item has been created, in ISO 8601 format.",
"type": "string"
},
"link": {
"description": "The link to the product.",
"type": "string"
},
"googleExpirationDate": {
"description": "Date on which the item expires in Google Shopping, in ISO 8601 format.",
"type": "string"
},
"title": {
"description": "The title of the product.",
"type": "string"
},
"itemLevelIssues": {
"description": "A list of all issues associated with the product.",
"items": {
"$ref": "ProductStatusItemLevelIssue"
},
"type": "array"
},
"lastUpdateDate": {
"type": "string",
"description": "Date on which the item has been last updated, in ISO 8601 format."
}
},
"type": "object"
},
"AccountsListResponse": {
"id": "AccountsListResponse",
"type": "object",
"properties": {
"resources": {
"items": {
"$ref": "Account"
},
"type": "array"
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#accountsListResponse\".",
"type": "string"
},
"nextPageToken": {
"type": "string",
"description": "The token for the retrieval of the next page of accounts."
}
}
},
"OrderreturnsRefundOperation": {
"properties": {
"partialRefund": {
"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.",
"$ref": "OrderreturnsPartialRefund"
},
"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."
},
"returnRefundReason": {
"description": "Code of the refund reason.",
"type": "string"
},
"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."
}
},
"id": "OrderreturnsRefundOperation",
"type": "object"
},
"OrderAddress": {
"id": "OrderAddress",
"type": "object",
"properties": {
"postalCode": {
"type": "string",
"description": "Postal Code or ZIP (e.g. \"94043\")."
},
"streetAddress": {
"type": "array",
"items": {
"type": "string"
},
"description": "Street-level part of the address."
},
"isPostOfficeBox": {
"description": "Whether the address is a post office box.",
"type": "boolean"
},
"recipientName": {
"description": "Name of the recipient.",
"type": "string"
},
"fullAddress": {
"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",
"items": {
"type": "string"
}
},
"locality": {
"description": "City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).",
"type": "string"
},
"country": {
"type": "string",
"description": "CLDR country code (e.g. \"US\")."
},
"region": {
"description": "Top-level administrative subdivision of the country. For example, a state like California (\"CA\") or a province like Quebec (\"QC\").",
"type": "string"
}
}
},
"ShippingsettingsGetSupportedPickupServicesResponse": {
"properties": {
"pickupServices": {
"description": "A list of supported pickup services. May be empty.",
"items": {
"$ref": "PickupServicesPickupService"
},
"type": "array"
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#shippingsettingsGetSupportedPickupServicesResponse\"."
}
},
"id": "ShippingsettingsGetSupportedPickupServicesResponse",
"type": "object"
},
"SettlementTransactionTransaction": {
"type": "object",
"id": "SettlementTransactionTransaction",
"properties": {
"postDate": {
"description": "The time on which the event occurred in ISO 8601 format.",
"type": "string"
},
"type": {
"type": "string",
"description": "The type of the transaction that occurred. Acceptable values are: - \"`order`\" - \"`reversal`\" - \"`orderRefund`\" - \"`reversalRefund`\" - \"`issueRelatedRefundAndReplacement`\" - \"`returnLabelShippingFeeTransaction`\" - \"`reversalIssueRelatedRefundAndReplacement`\" - \"`reversalReturnLabelShippingFeeTransaction`\" "
}
}
},
"ProductsCustomBatchResponse": {
"id": "ProductsCustomBatchResponse",
"properties": {
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#productsCustomBatchResponse\"."
},
"entries": {
"items": {
"$ref": "ProductsCustomBatchResponseEntry"
},
"description": "The result of the execution of the batch requests.",
"type": "array"
}
},
"type": "object"
},
"OrderTrackingSignalShippingInfo": {
"type": "object",
"description": "The shipping information for the order.",
"properties": {
"latestDeliveryPromiseTime": {
"$ref": "DateTime",
"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."
},
"shipmentId": {
"type": "string",
"description": "Required. The shipment ID."
},
"shippingStatus": {
"enum": [
"SHIPPING_STATE_UNSPECIFIED",
"SHIPPED",
"DELIVERED"
],
"enumDescriptions": [
"The shipping status is not known to merchant.",
"All items are shipped.",
"The shipment is already delivered."
],
"type": "string",
"description": "The status of the shipment."
},
"carrierName": {
"type": "string",
"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."
},
"originPostalCode": {
"description": "The origin postal code, as a continuous string without spaces or dashes, e.g. \"95016\".",
"type": "string"
},
"trackingId": {
"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.",
"type": "string"
},
"carrierServiceName": {
"type": "string",
"description": "The service type for fulfillment, e.g., GROUND, FIRST_CLASS, etc."
},
"originRegionCode": {
"type": "string",
"description": "The [CLDR territory code] (http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) for the shipping origin."
},
"actualDeliveryTime": {
"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.",
"$ref": "DateTime"
},
"shippedTime": {
"$ref": "DateTime",
"description": "The time when the shipment was shipped. Include the year and timezone string, if available."
},
"earliestDeliveryPromiseTime": {
"$ref": "DateTime",
"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."
}
},
"id": "OrderTrackingSignalShippingInfo"
},
"MinimumOrderValueTableStoreCodeSetWithMov": {
"type": "object",
"properties": {
"value": {
"description": "The minimum order value for the given stores.",
"$ref": "Price"
},
"storeCodes": {
"description": "A list of unique store codes or empty for the catch all.",
"items": {
"type": "string"
},
"type": "array"
}
},
"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."
},
"AccountYouTubeChannelLink": {
"properties": {
"channelId": {
"description": "Channel ID.",
"type": "string"
},
"status": {
"type": "string",
"description": "Status of the link between this Merchant Center account and the YouTube channel. Upon retrieval, it represents the actual status of the link and can be either `active` if it was approved in YT Creator Studio or `pending` if it's pending approval. Upon insertion, it represents the *intended* status of the link. Re-uploading a link with status `active` when it's still pending or with status `pending` when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status `inactive` is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending."
}
},
"id": "AccountYouTubeChannelLink",
"type": "object"
},
"RegionalinventoryCustomBatchRequestEntry": {
"properties": {
"batchId": {
"type": "integer",
"format": "uint32",
"description": "An entry ID, unique within the batch request."
},
"productId": {
"type": "string",
"description": "The ID of the product for which to update price and availability."
},
"regionalInventory": {
"$ref": "RegionalInventory",
"description": "Price and availability of the product."
},
"merchantId": {
"format": "uint64",
"type": "string",
"description": "The ID of the managing account."
},
"method": {
"description": "Method of the batch request entry. Acceptable values are: - \"`insert`\" ",
"type": "string"
}
},
"type": "object",
"description": "A batch entry encoding a single non-batch regional inventory request.",
"id": "RegionalinventoryCustomBatchRequestEntry"
},
"OrderreturnsLineItem": {
"type": "object",
"id": "OrderreturnsLineItem",
"properties": {
"quantity": {
"description": "The quantity of this line item.",
"type": "integer",
"format": "uint32"
},
"lineItemId": {
"description": "The ID of the line item. This value is assigned by Google when an order is created.",
"type": "string"
}
}
},
"TestOrderAddress": {
"type": "object",
"properties": {
"fullAddress": {
"type": "array",
"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 "
},
"isPostOfficeBox": {
"description": "Whether the address is a post office box.",
"type": "boolean"
},
"streetAddress": {
"description": "Street-level part of the address.",
"items": {
"type": "string"
},
"type": "array"
},
"locality": {
"description": "City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).",
"type": "string"
},
"postalCode": {
"description": "Postal Code or ZIP (e.g. \"94043\").",
"type": "string"
},
"recipientName": {
"type": "string",
"description": "Name of the recipient."
},
"region": {
"description": "Top-level administrative subdivision of the country. For example, a state like California (\"CA\") or a province like Quebec (\"QC\").",
"type": "string"
},
"country": {
"type": "string",
"description": "CLDR country code (e.g. \"US\")."
}
},
"id": "TestOrderAddress"
},
"LiasettingsCustomBatchResponse": {
"type": "object",
"properties": {
"entries": {
"items": {
"$ref": "LiasettingsCustomBatchResponseEntry"
},
"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#liasettingsCustomBatchResponse\".",
"type": "string"
}
},
"id": "LiasettingsCustomBatchResponse"
},
"PosCustomBatchRequestEntry": {
"id": "PosCustomBatchRequestEntry",
"type": "object",
"properties": {
"sale": {
"$ref": "PosSale",
"description": "The sale information to submit. This should be set only if the method is `sale`."
},
"inventory": {
"description": "The inventory to submit. This should be set only if the method is `inventory`.",
"$ref": "PosInventory"
},
"merchantId": {
"description": "The ID of the POS data provider.",
"format": "uint64",
"type": "string"
},
"method": {
"type": "string",
"description": "The method of the batch entry. Acceptable values are: - \"`delete`\" - \"`get`\" - \"`insert`\" - \"`inventory`\" - \"`sale`\" "
},
"store": {
"$ref": "PosStore",
"description": "The store information to submit. This should be set only if the method is `insert`."
},
"targetMerchantId": {
"type": "string",
"description": "The ID of the account for which to get/submit data.",
"format": "uint64"
},
"storeCode": {
"description": "The store code. This should be set only if the method is `delete` or `get`.",
"type": "string"
},
"batchId": {
"format": "uint32",
"type": "integer",
"description": "An entry ID, unique within the batch request."
}
}
},
"RegionPostalCodeAreaPostalCodeRange": {
"description": "A range of postal codes that defines the region area.",
"id": "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"
}
}
},
"DateTime": {
"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.",
"id": "DateTime",
"properties": {
"timeZone": {
"description": "Time zone.",
"$ref": "TimeZone"
},
"minutes": {
"type": "integer",
"format": "int32",
"description": "Required. Minutes of hour of day. Must be from 0 to 59."
},
"nanos": {
"type": "integer",
"format": "int32",
"description": "Required. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999."
},
"year": {
"type": "integer",
"format": "int32",
"description": "Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year."
},
"month": {
"description": "Required. Month of year. Must be from 1 to 12.",
"type": "integer",
"format": "int32"
},
"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"
},
"utcOffset": {
"type": "string",
"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 }.",
"format": "google-duration"
},
"day": {
"format": "int32",
"description": "Required. Day of month. Must be from 1 to 31 and valid for the year and month.",
"type": "integer"
},
"hours": {
"format": "int32",
"type": "integer",
"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."
}
},
"type": "object"
},
"AccountCustomerService": {
"id": "AccountCustomerService",
"type": "object",
"properties": {
"email": {
"description": "Customer service email.",
"type": "string"
},
"url": {
"description": "Customer service URL.",
"type": "string"
},
"phoneNumber": {
"description": "Customer service phone number.",
"type": "string"
}
}
},
"AccountIdentifier": {
"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": {
"format": "uint64",
"type": "string",
"description": "The merchant account ID, set for individual accounts and subaccounts."
}
},
"type": "object",
"id": "AccountIdentifier"
},
"AccountAdsLink": {
"id": "AccountAdsLink",
"properties": {
"adsId": {
"description": "Customer ID of the Ads account.",
"type": "string",
"format": "uint64"
},
"status": {
"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`\" ",
"type": "string"
}
},
"type": "object"
},
"OrderPickupDetails": {
"properties": {
"collectors": {
"items": {
"$ref": "OrderPickupDetailsCollector"
},
"description": "Collectors authorized to pick up shipment from the pickup location.",
"type": "array"
},
"address": {
"$ref": "OrderAddress",
"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."
},
"locationId": {
"description": "ID of the pickup location.",
"type": "string"
},
"pickupType": {
"type": "string",
"description": "The pickup type of this order. Acceptable values are: - \"`merchantStore`\" - \"`merchantStoreCurbside`\" - \"`merchantStoreLocker`\" - \"`thirdPartyPickupPoint`\" - \"`thirdPartyLocker`\" "
}
},
"type": "object",
"id": "OrderPickupDetails"
},
"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"
}
}
}
},
"OrderCancellation": {
"id": "OrderCancellation",
"properties": {
"quantity": {
"type": "integer",
"description": "The quantity that was canceled.",
"format": "uint32"
},
"reasonText": {
"description": "The explanation of the reason.",
"type": "string"
},
"actor": {
"type": "string",
"description": "The actor that created the cancellation. Acceptable values are: - \"`customer`\" - \"`googleBot`\" - \"`googleCustomerService`\" - \"`googlePayments`\" - \"`googleSabre`\" - \"`merchant`\" "
},
"creationDate": {
"description": "Date on which the cancellation has been created, in ISO 8601 format.",
"type": "string"
},
"reason": {
"description": "The reason for the cancellation. Orders that are canceled with a noInventory reason will lead to the removal of the product from Buy on Google until you make an update to that product. This will not affect your Shopping ads. Acceptable values are: - \"`autoPostInternal`\" - \"`autoPostInvalidBillingAddress`\" - \"`autoPostNoInventory`\" - \"`autoPostPriceError`\" - \"`autoPostUndeliverableShippingAddress`\" - \"`couponAbuse`\" - \"`customerCanceled`\" - \"`customerInitiatedCancel`\" - \"`customerSupportRequested`\" - \"`failToPushOrderGoogleError`\" - \"`failToPushOrderMerchantError`\" - \"`failToPushOrderMerchantFulfillmentError`\" - \"`failToPushOrderToMerchant`\" - \"`failToPushOrderToMerchantOutOfStock`\" - \"`invalidCoupon`\" - \"`malformedShippingAddress`\" - \"`merchantDidNotShipOnTime`\" - \"`noInventory`\" - \"`orderTimeout`\" - \"`other`\" - \"`paymentAbuse`\" - \"`paymentDeclined`\" - \"`priceError`\" - \"`returnRefundAbuse`\" - \"`shippingPriceError`\" - \"`taxError`\" - \"`undeliverableShippingAddress`\" - \"`unsupportedPoBoxAddress`\" ",
"type": "string"
}
},
"type": "object"
},
"TestOrder": {
"type": "object",
"id": "TestOrder",
"properties": {
"enableOrderinvoices": {
"description": "Whether the orderinvoices service should support this order.",
"type": "boolean"
},
"deliveryDetails": {
"description": "Overrides the predefined delivery details if provided.",
"$ref": "TestOrderDeliveryDetails"
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"`content#testOrder`\""
},
"shippingOption": {
"type": "string",
"description": "Required. The requested shipping option. Acceptable values are: - \"`economy`\" - \"`expedited`\" - \"`oneDay`\" - \"`sameDay`\" - \"`standard`\" - \"`twoDay`\" "
},
"notificationMode": {
"description": "Restricted. Do not use.",
"type": "string"
},
"predefinedEmail": {
"description": "Required. Email address of the customer. Acceptable values are: - \"`[email protected]`\" - \"`[email protected]`\" - \"`[email protected]`\" ",
"type": "string"
},
"pickupDetails": {
"description": "Overrides the predefined pickup details if provided.",
"$ref": "TestOrderPickupDetails"
},
"promotions": {
"type": "array",
"items": {
"$ref": "OrderPromotion"
},
"description": "Promotions associated with the order."
},
"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"
},
"predefinedBillingAddress": {
"description": "Required. The billing address. Acceptable values are: - \"`dwight`\" - \"`jim`\" - \"`pam`\" ",
"type": "string"
},
"predefinedDeliveryAddress": {
"description": "Required. Identifier of one of the predefined delivery addresses for the delivery. Acceptable values are: - \"`dwight`\" - \"`jim`\" - \"`pam`\" ",
"type": "string"
},
"lineItems": {
"type": "array",
"description": "Required. Line items that are ordered. At least one line item must be provided.",
"items": {
"$ref": "TestOrderLineItem"
}
},
"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"
}
}
},
"OrderPromotion": {
"properties": {
"funder": {
"description": "Required. The party funding the promotion. Only `merchant` is supported for `orders.createtestorder`. Acceptable values are: - \"`google`\" - \"`merchant`\" ",
"type": "string"
},
"applicableItems": {
"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.",
"items": {
"$ref": "OrderPromotionItem"
},
"type": "array"
},
"title": {
"type": "string",
"description": "Required. The title of the promotion."
},
"subtype": {
"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": "string"
},
"endTime": {
"type": "string",
"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\"."
},
"priceValue": {
"description": "Estimated discount applied to price. Amount is pre-tax or post-tax depending on location of order.",
"$ref": "Price"
},
"appliedItems": {
"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.",
"items": {
"$ref": "OrderPromotionItem"
},
"type": "array"
},
"taxValue": {
"description": "Estimated discount applied to tax (if allowed by law). Do not provide for `orders.createtestorder`.",
"$ref": "Price"
},
"merchantPromotionId": {
"type": "string",
"description": "Required. This field is used to identify promotions within merchants' own systems."
},
"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\"."
},
"type": {
"type": "string",
"description": "Required. The scope of the promotion. Only `product` is supported for `orders.createtestorder`. Acceptable values are: - \"`product`\" - \"`shipping`\" "
},
"shortTitle": {
"description": "A short title of the promotion to be shown on the checkout page. Do not provide for `orders.createtestorder`.",
"type": "string"
}
},
"type": "object",
"id": "OrderPromotion"
},
"DatafeedFetchSchedule": {
"properties": {
"username": {
"description": "An optional user name for fetch_url.",
"type": "string"
},
"minuteOfHour": {
"format": "uint32",
"description": "The minute of the hour the feed file should be fetched (0-59). Read-only.",
"type": "integer"
},
"dayOfMonth": {
"type": "integer",
"format": "uint32",
"description": "The day of the month the feed file should be fetched (1-31)."
},
"weekday": {
"type": "string",
"description": "The day of the week the feed file should be fetched. Acceptable values are: - \"`monday`\" - \"`tuesday`\" - \"`wednesday`\" - \"`thursday`\" - \"`friday`\" - \"`saturday`\" - \"`sunday`\" "
},
"password": {
"type": "string",
"description": "An optional password for fetch_url."
},
"paused": {
"type": "boolean",
"description": "Whether the scheduled fetch is paused or not."
},
"fetchUrl": {
"description": "The URL where the feed file can be fetched. Google Merchant Center will support automatic scheduled uploads using the HTTP, HTTPS, FTP, or SFTP protocols, so the value will need to be a valid link using one of those four protocols.",
"type": "string"
},
"hour": {
"type": "integer",
"format": "uint32",
"description": "The hour of the day the feed file should be fetched (0-23)."
},
"timeZone": {
"description": "Time zone used for schedule. UTC by default. E.g., \"America/Los_Angeles\".",
"type": "string"
}
},
"type": "object",
"id": "DatafeedFetchSchedule",
"description": "The required fields vary based on the frequency of fetching. For a monthly fetch schedule, day_of_month and hour are required. For a weekly fetch schedule, weekday and hour are required. For a daily fetch schedule, only hour is required."
},
"AccountstatusesCustomBatchRequestEntry": {
"type": "object",
"properties": {
"method": {
"type": "string",
"description": "The method of the batch entry. Acceptable values are: - \"`get`\" "
},
"batchId": {
"type": "integer",
"description": "An entry ID, unique within the batch request.",
"format": "uint32"
},
"destinations": {
"items": {
"type": "string"
},
"description": "If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination.",
"type": "array"
},
"merchantId": {
"type": "string",
"description": "The ID of the managing account.",
"format": "uint64"
},
"accountId": {
"description": "The ID of the (sub-)account whose status to get.",
"format": "uint64",
"type": "string"
}
},
"id": "AccountstatusesCustomBatchRequestEntry",
"description": "A batch entry encoding a single non-batch accountstatuses request."
},
"AccountsCustomBatchRequestEntryLinkRequest": {
"id": "AccountsCustomBatchRequestEntryLinkRequest",
"properties": {
"linkType": {
"description": "Type of the link between the two accounts. Acceptable values are: - \"`channelPartner`\" - \"`eCommercePlatform`\" ",
"type": "string"
},
"linkedAccountId": {
"type": "string",
"description": "The ID of the linked account."
},
"services": {
"description": "List of provided services.",
"type": "array",
"items": {
"type": "string"
}
},
"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"
}
},
"type": "object"
},
"OrderTrackingSignalShipmentLineItemMapping": {
"properties": {
"shipmentId": {
"type": "string",
"description": "Required. The shipment ID."
},
"quantity": {
"description": "Required. The line item quantity in the shipment.",
"type": "string",
"format": "int64"
},
"lineItemId": {
"description": "Required. The line item ID.",
"type": "string"
}
},
"description": "Represents how many items are in the shipment for the given shipment_id and line_item_id.",
"type": "object",
"id": "OrderTrackingSignalShipmentLineItemMapping"
},
"OrdersSetLineItemMetadataResponse": {
"type": "object",
"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`\" "
}
}
},
"ProductUnitPricingMeasure": {
"type": "object",
"id": "ProductUnitPricingMeasure",
"properties": {
"unit": {
"description": "The unit of the measure.",
"type": "string"
},
"value": {
"type": "number",
"format": "double",
"description": "The measure of an item."
}
}
},
"OrdersAdvanceTestOrderResponse": {
"properties": {
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersAdvanceTestOrderResponse\".",
"type": "string"
}
},
"id": "OrdersAdvanceTestOrderResponse",
"type": "object"
},
"OrderreturnsProcessResponse": {
"properties": {
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#orderreturnsProcessResponse\"."
},
"executionStatus": {
"description": "The status of the execution. Acceptable values are: - \"`duplicate`\" - \"`executed`\" ",
"type": "string"
}
},
"type": "object",
"id": "OrderreturnsProcessResponse"
},
"Region": {
"properties": {
"regionalInventoryEligible": {
"type": "boolean",
"readOnly": true,
"description": "Output only. Indicates if the region is eligible to use in the Regional Inventory configuration."
},
"merchantId": {
"readOnly": true,
"description": "Output only. Immutable. Merchant that owns the region.",
"format": "int64",
"type": "string"
},
"shippingEligible": {
"description": "Output only. Indicates if the region is eligible to use in the Shipping Services configuration.",
"readOnly": true,
"type": "boolean"
},
"postalCodeArea": {
"$ref": "RegionPostalCodeArea",
"description": "A list of postal codes that defines the region area."
},
"displayName": {
"type": "string",
"description": "The display name of the region."
},
"geotargetArea": {
"description": "A list of geotargets that defines the region area.",
"$ref": "RegionGeoTargetArea"
},
"regionId": {
"type": "string",
"readOnly": true,
"description": "Output only. Immutable. The ID uniquely identifying each region."
}
},
"id": "Region",
"type": "object",
"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."
},
"AccountsCustomBatchRequest": {
"type": "object",
"properties": {
"entries": {
"items": {
"$ref": "AccountsCustomBatchRequestEntry"
},
"description": "The request entries to be processed in the batch.",
"type": "array"
}
},
"id": "AccountsCustomBatchRequest"
},
"PosInventoryRequest": {
"type": "object",
"properties": {
"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"
},
"timestamp": {
"type": "string",
"description": "Required. The inventory timestamp, in ISO 8601 format."
},
"targetCountry": {
"description": "Required. The CLDR territory code for the item.",
"type": "string"
},
"price": {
"description": "Required. The current price of the item.",
"$ref": "Price"
},
"gtin": {
"description": "Global Trade Item Number.",
"type": "string"
},
"quantity": {
"type": "string",
"description": "Required. The available quantity of the item.",
"format": "int64"
},
"itemId": {
"description": "Required. A unique identifier for the item.",
"type": "string"
},
"contentLanguage": {
"description": "Required. The two-letter ISO 639-1 language code for the item.",
"type": "string"
}
},
"id": "PosInventoryRequest"
},
"AccountsListLinksResponse": {
"properties": {
"links": {
"type": "array",
"description": "The list of available links.",
"items": {
"$ref": "LinkedAccount"
}
},
"nextPageToken": {
"type": "string",
"description": "The token for the retrieval of the next page of links."
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#accountsListLinksResponse\".",
"type": "string"
}
},
"id": "AccountsListLinksResponse",
"type": "object"
},
"ListAccountLabelsResponse": {
"description": "Response message for the `ListAccountLabels` method.",
"type": "object",
"properties": {
"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."
},
"accountLabels": {
"type": "array",
"description": "The labels from the specified account.",
"items": {
"$ref": "AccountLabel"
}
}
},
"id": "ListAccountLabelsResponse"
},
"AccounttaxCustomBatchRequest": {
"properties": {
"entries": {
"items": {
"$ref": "AccounttaxCustomBatchRequestEntry"
},
"type": "array",
"description": "The request entries to be processed in the batch."
}
},
"type": "object",
"id": "AccounttaxCustomBatchRequest"
},
"LocationIdSet": {
"type": "object",
"id": "LocationIdSet",
"properties": {
"locationIds": {
"type": "array",
"description": "A non-empty list of location IDs. They must all be of the same location type (e.g., state).",
"items": {
"type": "string"
}
}
}
},
"PubsubNotificationSettings": {
"id": "PubsubNotificationSettings",
"description": "Settings for Pub/Sub notifications, all methods require that the caller is a direct user of the merchant center account.",
"type": "object",
"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"
}
}
},
"DeliveryTime": {
"id": "DeliveryTime",
"type": "object",
"properties": {
"handlingBusinessDayConfig": {
"description": "The business days during which orders can be handled. If not provided, Monday to Friday business days will be assumed.",
"$ref": "BusinessDayConfig"
},
"transitBusinessDayConfig": {
"description": "The business days during which orders can be in-transit. If not provided, Monday to Friday business days will be assumed.",
"$ref": "BusinessDayConfig"
},
"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": {
"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.",
"format": "uint32"
},
"maxHandlingTimeInDays": {
"format": "uint32",
"description": "Maximum number of business days spent before an order is shipped. 0 means same day shipped, 1 means next day shipped. Must be greater than or equal to `minHandlingTimeInDays`.",
"type": "integer"
},
"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"
},
"minHandlingTimeInDays": {
"description": "Minimum number of business days spent before an order is shipped. 0 means same day shipped, 1 means next day shipped.",
"format": "uint32",
"type": "integer"
},
"cutoffTime": {
"$ref": "CutoffTime",
"description": "Business days cutoff time definition. If not configured the cutoff time will be defaulted to 8AM PST."
},
"holidayCutoffs": {
"description": "Holiday cutoff definitions. If configured, they specify order cutoff times for holiday-specific shipping.",
"type": "array",
"items": {
"$ref": "HolidayCutoff"
}
}
}
},
"TestOrderLineItem": {
"type": "object",
"id": "TestOrderLineItem",
"properties": {
"quantityOrdered": {
"type": "integer",
"description": "Required. Number of items ordered.",
"format": "uint32"
},
"product": {
"$ref": "TestOrderLineItemProduct",
"description": "Required. Product data from the time of the order placement."
},
"returnInfo": {
"$ref": "OrderLineItemReturnInfo",
"description": "Required. Details of the return policy for the line item."
},
"shippingDetails": {
"description": "Required. Details of the requested shipping for the line item.",
"$ref": "OrderLineItemShippingDetails"
}
}
},
"CustomAttribute": {
"type": "object",
"id": "CustomAttribute",
"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.",
"type": "array",
"items": {
"$ref": "CustomAttribute"
}
}
}
},
"OrdersAcknowledgeRequest": {
"type": "object",
"id": "OrdersAcknowledgeRequest",
"properties": {
"operationId": {
"description": "The ID of the operation. Unique across all operations for a given order.",
"type": "string"
}
}
},
"OrdersUpdateLineItemShippingDetailsRequest": {
"id": "OrdersUpdateLineItemShippingDetailsRequest",
"properties": {
"deliverByDate": {
"description": "Updated delivery by date, in ISO 8601 format. If not specified only ship by date is updated. Provided date should be within 1 year timeframe and can not be a date in the past.",
"type": "string"
},
"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."
},
"shipByDate": {
"description": "Updated ship by date, in ISO 8601 format. If not specified only deliver by date is updated. Provided date should be within 1 year timeframe and can not be a date in the past.",
"type": "string"
},
"lineItemId": {
"type": "string",
"description": "The ID of the line item to set metadata. Either lineItemId or productId is required."
}
},
"type": "object"
},
"OrdersCreateTestOrderResponse": {
"properties": {
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersCreateTestOrderResponse\".",
"type": "string"
},
"orderId": {
"type": "string",
"description": "The ID of the newly created test order."
}
},
"id": "OrdersCreateTestOrderResponse",
"type": "object"
},
"OrderreturnsRejectOperation": {
"type": "object",
"properties": {
"reason": {
"type": "string",
"description": "The reason for the return."
},
"reasonText": {
"description": "The explanation of the reason.",
"type": "string"
}
},
"id": "OrderreturnsRejectOperation"
},
"AccountStatusStatistics": {
"properties": {
"expiring": {
"type": "string",
"format": "int64",
"description": "Number of expiring offers."
},
"disapproved": {
"type": "string",
"format": "int64",
"description": "Number of disapproved offers."
},
"pending": {
"type": "string",
"format": "int64",
"description": "Number of pending offers."
},
"active": {
"format": "int64",
"description": "Number of active offers.",
"type": "string"
}
},
"type": "object",
"id": "AccountStatusStatistics"
},
"TimeZone": {
"type": "object",
"description": "Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones).",
"id": "TimeZone",
"properties": {
"id": {
"description": "IANA Time Zone Database time zone, e.g. \"America/New_York\".",
"type": "string"
},
"version": {
"type": "string",
"description": "Optional. IANA Time Zone Database version number, e.g. \"2019a\"."
}
}
},
"RegionalinventoryCustomBatchResponseEntry": {
"type": "object",
"id": "RegionalinventoryCustomBatchResponseEntry",
"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": {
"format": "uint32",
"description": "The ID of the request entry this entry responds to.",
"type": "integer"
},
"regionalInventory": {
"$ref": "RegionalInventory",
"description": "Price and availability of the product."
}
},
"description": "A batch entry encoding a single non-batch regional inventory response."
}
},
"basePath": "",
"canonicalName": "Shopping Content",
"name": "content",
"ownerDomain": "google.com",
"rootUrl": "https://shoppingcontent.googleapis.com/",
"parameters": {
"callback": {
"location": "query",
"description": "JSONP",
"type": "string"
},
"oauth_token": {
"location": "query",
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"type": "string",
"location": "query"
},
"access_token": {
"type": "string",
"location": "query",
"description": "OAuth access token."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks.",
"default": "true",
"location": "query"
},
"key": {
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"location": "query",
"type": "string"
},
"uploadType": {
"location": "query",
"type": "string",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")."
},
"fields": {
"type": "string",
"location": "query",
"description": "Selector specifying which fields to include in a partial response."
},
"alt": {
"description": "Data format for response.",
"location": "query",
"default": "json",
"type": "string",
"enum": [
"json",
"media",
"proto"
],
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
]
},
"quotaUser": {
"type": "string",
"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.",
"location": "query"
},
"$.xgafv": {
"enum": [
"1",
"2"
],
"type": "string",
"description": "V1 error format.",
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query"
}
},
"fullyEncodeReservedExpansion": true,
"title": "Content API for Shopping",
"protocol": "rest",
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/content": {
"description": "Manage your product listings and accounts for Google Shopping"
}
}
}
},
"batchPath": "batch",
"revision": "20201113",
"version": "v2.1",
"icons": {
"x32": "http://www.google.com/images/icons/product/search-32.gif",
"x16": "http://www.google.com/images/icons/product/search-16.gif"
}
}