@datafire/google_content
Advanced tools
Manages product items, inventory, and Merchant Center accounts for Google Shopping.
{
"type": "object",
"properties": {
"code": {
"title": "code",
"type": "string"
}
},
"required": [
"code"
]
}
{
"properties": {
"access_token": {
"type": "string"
},
"refresh_token": {
"type": "string"
},
"token_type": {
"type": "string"
},
"scope": {
"type": "string"
},
"expiration": {
"type": "string"
}
}
}
{}
{
"properties": {
"access_token": {
"type": "string"
},
"refresh_token": {
"type": "string"
},
"token_type": {
"type": "string"
},
"scope": {
"type": "string"
},
"expiration": {
"type": "string"
}
}
}
Returns information about the authenticated user.
{
"type": [
"object",
"null"
],
"properties": {
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"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."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"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. Overrides userIp if both are provided."
},
"userIp": {
"type": "string",
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits."
}
},
"additionalProperties": false
}
{
"$ref": "#/definitions/AccountsAuthInfoResponse"
}
Retrieves, inserts, updates, and deletes multiple Merchant Center (sub-)accounts in a single request.
{
"type": [
"object",
"null"
],
"properties": {
"dryRun": {
"type": "boolean",
"description": "Flag to run the request in dry-run mode."
},
"body": {
"$ref": "#/definitions/AccountsCustomBatchRequest"
},
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"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."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"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. Overrides userIp if both are provided."
},
"userIp": {
"type": "string",
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits."
}
},
"additionalProperties": false
}
{
"$ref": "#/definitions/AccountsCustomBatchResponse"
}
{
"type": [
"object",
"null"
],
"properties": {
"body": {
"$ref": "#/definitions/AccountstatusesCustomBatchRequest"
},
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"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."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"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. Overrides userIp if both are provided."
},
"userIp": {
"type": "string",
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits."
}
},
"additionalProperties": false
}
{
"$ref": "#/definitions/AccountstatusesCustomBatchResponse"
}
Retrieves and updates tax settings of multiple accounts in a single request.
{
"type": [
"object",
"null"
],
"properties": {
"dryRun": {
"type": "boolean",
"description": "Flag to run the request in dry-run mode."
},
"body": {
"$ref": "#/definitions/AccounttaxCustomBatchRequest"
},
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"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."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"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. Overrides userIp if both are provided."
},
"userIp": {
"type": "string",
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits."
}
},
"additionalProperties": false
}
{
"$ref": "#/definitions/AccounttaxCustomBatchResponse"
}
{
"type": [
"object",
"null"
],
"properties": {
"dryRun": {
"type": "boolean",
"description": "Flag to run the request in dry-run mode."
},
"body": {
"$ref": "#/definitions/DatafeedsCustomBatchRequest"
},
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"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."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"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. Overrides userIp if both are provided."
},
"userIp": {
"type": "string",
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits."
}
},
"additionalProperties": false
}
{
"$ref": "#/definitions/DatafeedsCustomBatchResponse"
}
{
"type": [
"object",
"null"
],
"properties": {
"body": {
"$ref": "#/definitions/DatafeedstatusesCustomBatchRequest"
},
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"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."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"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. Overrides userIp if both are provided."
},
"userIp": {
"type": "string",
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits."
}
},
"additionalProperties": false
}
{
"$ref": "#/definitions/DatafeedstatusesCustomBatchResponse"
}
Updates price and availability for multiple products or stores in a single request. This operation does not update the expiration date of the products. This method can only be called for non-multi-client accounts.
{
"type": [
"object",
"null"
],
"properties": {
"dryRun": {
"type": "boolean",
"description": "Flag to run the request in dry-run mode."
},
"body": {
"$ref": "#/definitions/InventoryCustomBatchRequest"
},
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"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."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"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. Overrides userIp if both are provided."
},
"userIp": {
"type": "string",
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits."
}
},
"additionalProperties": false
}
{
"$ref": "#/definitions/InventoryCustomBatchResponse"
}
Retrieves or modifies multiple orders in a single request. This method can only be called for non-multi-client accounts.
{
"type": [
"object",
"null"
],
"properties": {
"body": {
"$ref": "#/definitions/OrdersCustomBatchRequest"
},
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"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."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"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. Overrides userIp if both are provided."
},
"userIp": {
"type": "string",
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits."
}
},
"additionalProperties": false
}
{
"$ref": "#/definitions/OrdersCustomBatchResponse"
}
Retrieves, inserts, and deletes multiple products in a single request. This method can only be called for non-multi-client accounts.
{
"type": [
"object",
"null"
],
"properties": {
"dryRun": {
"type": "boolean",
"description": "Flag to run the request in dry-run mode."
},
"body": {
"$ref": "#/definitions/ProductsCustomBatchRequest"
},
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"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."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"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. Overrides userIp if both are provided."
},
"userIp": {
"type": "string",
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits."
}
},
"additionalProperties": false
}
{
"$ref": "#/definitions/ProductsCustomBatchResponse"
}
Gets the statuses of multiple products in a single request. This method can only be called for non-multi-client accounts.
{
"type": [
"object",
"null"
],
"properties": {
"body": {
"$ref": "#/definitions/ProductstatusesCustomBatchRequest"
},
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"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."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"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. Overrides userIp if both are provided."
},
"userIp": {
"type": "string",
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits."
}
},
"additionalProperties": false
}
{
"$ref": "#/definitions/ProductstatusesCustomBatchResponse"
}
Retrieves and updates the shipping settings of multiple accounts in a single request.
{
"type": [
"object",
"null"
],
"properties": {
"dryRun": {
"type": "boolean",
"description": "Flag to run the request in dry-run mode."
},
"body": {
"$ref": "#/definitions/ShippingsettingsCustomBatchRequest"
},
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"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."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"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. Overrides userIp if both are provided."
},
"userIp": {
"type": "string",
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits."
}
},
"additionalProperties": false
}
{
"$ref": "#/definitions/ShippingsettingsCustomBatchResponse"
}
Lists the sub-accounts in your Merchant Center account. This method can only be called for multi-client accounts.
{
"type": "object",
"properties": {
"merchantId": {
"type": "string",
"description": "The ID of the managing account."
},
"maxResults": {
"type": "integer",
"description": "The maximum number of accounts to return in the response, used for paging."
},
"pageToken": {
"type": "string",
"description": "The token returned by the previous request."
},
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"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."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"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. Overrides userIp if both are provided."
},
"userIp": {
"type": "string",
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits."
}
},
"additionalProperties": false,
"required": [
"merchantId"
]
}
{
"$ref": "#/definitions/AccountsListResponse"
}
Creates a Merchant Center sub-account. This method can only be called for multi-client accounts.
{
"type": "object",
"properties": {
"merchantId": {
"type": "string",
"description": "The ID of the managing account."
},
"dryRun": {
"type": "boolean",
"description": "Flag to run the request in dry-run mode."
},
"body": {
"$ref": "#/definitions/Account"
},
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"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."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"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. Overrides userIp if both are provided."
},
"userIp": {
"type": "string",
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits."
}
},
"additionalProperties": false,
"required": [
"merchantId"
]
}
{
"$ref": "#/definitions/Account"
}
Deletes a Merchant Center sub-account. This method can only be called for multi-client accounts.
{
"type": "object",
"properties": {
"merchantId": {
"type": "string",
"description": "The ID of the managing account."
},
"accountId": {
"type": "string",
"description": "The ID of the account."
},
"dryRun": {
"type": "boolean",
"description": "Flag to run the request in dry-run mode."
},
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"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."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"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. Overrides userIp if both are provided."
},
"userIp": {
"type": "string",
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits."
}
},
"additionalProperties": false,
"required": [
"merchantId",
"accountId"
]
}
{}
Retrieves a Merchant Center account. This method can only be called for accounts to which the managing account has access: either the managing account itself or sub-accounts if the managing account is a multi-client account.
{
"type": "object",
"properties": {
"merchantId": {
"type": "string",
"description": "The ID of the managing account."
},
"accountId": {
"type": "string",
"description": "The ID of the account."
},
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"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."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"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. Overrides userIp if both are provided."
},
"userIp": {
"type": "string",
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits."
}
},
"additionalProperties": false,
"required": [
"merchantId",
"accountId"
]
}
{
"$ref": "#/definitions/Account"
}
Updates a Merchant Center account. This method can only be called for accounts to which the managing account has access: either the managing account itself or sub-accounts if the managing account is a multi-client account. This method supports patch semantics.
{
"type": "object",
"properties": {
"merchantId": {
"type": "string",
"description": "The ID of the managing account."
},
"accountId": {
"type": "string",
"description": "The ID of the account."
},
"dryRun": {
"type": "boolean",
"description": "Flag to run the request in dry-run mode."
},
"body": {
"$ref": "#/definitions/Account"
},
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"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."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"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. Overrides userIp if both are provided."
},
"userIp": {
"type": "string",
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits."
}
},
"additionalProperties": false,
"required": [
"merchantId",
"accountId"
]
}
{
"$ref": "#/definitions/Account"
}
Updates a Merchant Center account. This method can only be called for accounts to which the managing account has access: either the managing account itself or sub-accounts if the managing account is a multi-client account.
{
"type": "object",
"properties": {
"merchantId": {
"type": "string",
"description": "The ID of the managing account."
},
"accountId": {
"type": "string",
"description": "The ID of the account."
},
"dryRun": {
"type": "boolean",
"description": "Flag to run the request in dry-run mode."
},
"body": {
"$ref": "#/definitions/Account"
},
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"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."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"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. Overrides userIp if both are provided."
},
"userIp": {
"type": "string",
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits."
}
},
"additionalProperties": false,
"required": [
"merchantId",
"accountId"
]
}
{
"$ref": "#/definitions/Account"
}
Lists the statuses of the sub-accounts in your Merchant Center account. This method can only be called for multi-client accounts.
{
"type": "object",
"properties": {
"merchantId": {
"type": "string",
"description": "The ID of the managing account."
},
"maxResults": {
"type": "integer",
"description": "The maximum number of account statuses to return in the response, used for paging."
},
"pageToken": {
"type": "string",
"description": "The token returned by the previous request."
},
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"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."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"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. Overrides userIp if both are provided."
},
"userIp": {
"type": "string",
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits."
}
},
"additionalProperties": false,
"required": [
"merchantId"
]
}
{
"$ref": "#/definitions/AccountstatusesListResponse"
}
Retrieves the status of a Merchant Center account. This method can only be called for accounts to which the managing account has access: either the managing account itself or sub-accounts if the managing account is a multi-client account.
{
"type": "object",
"properties": {
"merchantId": {
"type": "string",
"description": "The ID of the managing account."
},
"accountId": {
"type": "string",
"description": "The ID of the account."
},
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"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."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"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. Overrides userIp if both are provided."
},
"userIp": {
"type": "string",
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits."
}
},
"additionalProperties": false,
"required": [
"merchantId",
"accountId"
]
}
{
"$ref": "#/definitions/AccountStatus"
}
Lists the tax settings of the sub-accounts in your Merchant Center account. This method can only be called for multi-client accounts.
{
"type": "object",
"properties": {
"merchantId": {
"type": "string",
"description": "The ID of the managing account."
},
"maxResults": {
"type": "integer",
"description": "The maximum number of tax settings to return in the response, used for paging."
},
"pageToken": {
"type": "string",
"description": "The token returned by the previous request."
},
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"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."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"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. Overrides userIp if both are provided."
},
"userIp": {
"type": "string",
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits."
}
},
"additionalProperties": false,
"required": [
"merchantId"
]
}
{
"$ref": "#/definitions/AccounttaxListResponse"
}
Retrieves the tax settings of the account. This method can only be called for accounts to which the managing account has access: either the managing account itself or sub-accounts if the managing account is a multi-client account.
{
"type": "object",
"properties": {
"merchantId": {
"type": "string",
"description": "The ID of the managing account."
},
"accountId": {
"type": "string",
"description": "The ID of the account for which to get/update account tax settings."
},
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"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."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"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. Overrides userIp if both are provided."
},
"userIp": {
"type": "string",
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits."
}
},
"additionalProperties": false,
"required": [
"merchantId",
"accountId"
]
}
{
"$ref": "#/definitions/AccountTax"
}
Updates the tax settings of the account. This method can only be called for accounts to which the managing account has access: either the managing account itself or sub-accounts if the managing account is a multi-client account. This method supports patch semantics.
{
"type": "object",
"properties": {
"merchantId": {
"type": "string",
"description": "The ID of the managing account."
},
"accountId": {
"type": "string",
"description": "The ID of the account for which to get/update account tax settings."
},
"dryRun": {
"type": "boolean",
"description": "Flag to run the request in dry-run mode."
},
"body": {
"$ref": "#/definitions/AccountTax"
},
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"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."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"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. Overrides userIp if both are provided."
},
"userIp": {
"type": "string",
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits."
}
},
"additionalProperties": false,
"required": [
"merchantId",
"accountId"
]
}
{
"$ref": "#/definitions/AccountTax"
}
Updates the tax settings of the account. This method can only be called for accounts to which the managing account has access: either the managing account itself or sub-accounts if the managing account is a multi-client account.
{
"type": "object",
"properties": {
"merchantId": {
"type": "string",
"description": "The ID of the managing account."
},
"accountId": {
"type": "string",
"description": "The ID of the account for which to get/update account tax settings."
},
"dryRun": {
"type": "boolean",
"description": "Flag to run the request in dry-run mode."
},
"body": {
"$ref": "#/definitions/AccountTax"
},
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"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."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"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. Overrides userIp if both are provided."
},
"userIp": {
"type": "string",
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits."
}
},
"additionalProperties": false,
"required": [
"merchantId",
"accountId"
]
}
{
"$ref": "#/definitions/AccountTax"
}
Lists the datafeeds in your Merchant Center account. This method can only be called for non-multi-client accounts.
{
"type": "object",
"properties": {
"merchantId": {
"type": "string",
"description": "The ID of the managing account."
},
"maxResults": {
"type": "integer",
"description": "The maximum number of products to return in the response, used for paging."
},
"pageToken": {
"type": "string",
"description": "The token returned by the previous request."
},
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"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."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"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. Overrides userIp if both are provided."
},
"userIp": {
"type": "string",
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits."
}
},
"additionalProperties": false,
"required": [
"merchantId"
]
}
{
"$ref": "#/definitions/DatafeedsListResponse"
}
Registers a datafeed with your Merchant Center account. This method can only be called for non-multi-client accounts.
{
"type": "object",
"properties": {
"merchantId": {
"type": "string"
},
"dryRun": {
"type": "boolean",
"description": "Flag to run the request in dry-run mode."
},
"body": {
"$ref": "#/definitions/Datafeed"
},
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"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."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"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. Overrides userIp if both are provided."
},
"userIp": {
"type": "string",
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits."
}
},
"additionalProperties": false,
"required": [
"merchantId"
]
}
{
"$ref": "#/definitions/Datafeed"
}
Deletes a datafeed from your Merchant Center account. This method can only be called for non-multi-client accounts.
{
"type": "object",
"properties": {
"merchantId": {
"type": "string"
},
"datafeedId": {
"type": "string"
},
"dryRun": {
"type": "boolean",
"description": "Flag to run the request in dry-run mode."
},
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"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."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"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. Overrides userIp if both are provided."
},
"userIp": {
"type": "string",
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits."
}
},
"additionalProperties": false,
"required": [
"merchantId",
"datafeedId"
]
}
{}
Retrieves a datafeed from your Merchant Center account. This method can only be called for non-multi-client accounts.
{
"type": "object",
"properties": {
"merchantId": {
"type": "string"
},
"datafeedId": {
"type": "string"
},
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"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."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"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. Overrides userIp if both are provided."
},
"userIp": {
"type": "string",
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits."
}
},
"additionalProperties": false,
"required": [
"merchantId",
"datafeedId"
]
}
{
"$ref": "#/definitions/Datafeed"
}
Updates a datafeed of your Merchant Center account. This method can only be called for non-multi-client accounts. This method supports patch semantics.
{
"type": "object",
"properties": {
"merchantId": {
"type": "string"
},
"datafeedId": {
"type": "string"
},
"dryRun": {
"type": "boolean",
"description": "Flag to run the request in dry-run mode."
},
"body": {
"$ref": "#/definitions/Datafeed"
},
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"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."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"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. Overrides userIp if both are provided."
},
"userIp": {
"type": "string",
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits."
}
},
"additionalProperties": false,
"required": [
"merchantId",
"datafeedId"
]
}
{
"$ref": "#/definitions/Datafeed"
}
Updates a datafeed of your Merchant Center account. This method can only be called for non-multi-client accounts.
{
"type": "object",
"properties": {
"merchantId": {
"type": "string"
},
"datafeedId": {
"type": "string"
},
"dryRun": {
"type": "boolean",
"description": "Flag to run the request in dry-run mode."
},
"body": {
"$ref": "#/definitions/Datafeed"
},
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"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."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"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. Overrides userIp if both are provided."
},
"userIp": {
"type": "string",
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits."
}
},
"additionalProperties": false,
"required": [
"merchantId",
"datafeedId"
]
}
{
"$ref": "#/definitions/Datafeed"
}
Lists the statuses of the datafeeds in your Merchant Center account. This method can only be called for non-multi-client accounts.
{
"type": "object",
"properties": {
"merchantId": {
"type": "string",
"description": "The ID of the managing account."
},
"maxResults": {
"type": "integer",
"description": "The maximum number of products to return in the response, used for paging."
},
"pageToken": {
"type": "string",
"description": "The token returned by the previous request."
},
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"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."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"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. Overrides userIp if both are provided."
},
"userIp": {
"type": "string",
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits."
}
},
"additionalProperties": false,
"required": [
"merchantId"
]
}
{
"$ref": "#/definitions/DatafeedstatusesListResponse"
}
Retrieves the status of a datafeed from your Merchant Center account. This method can only be called for non-multi-client accounts.
{
"type": "object",
"properties": {
"merchantId": {
"type": "string"
},
"datafeedId": {
"type": "string"
},
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"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."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"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. Overrides userIp if both are provided."
},
"userIp": {
"type": "string",
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits."
}
},
"additionalProperties": false,
"required": [
"merchantId",
"datafeedId"
]
}
{
"$ref": "#/definitions/DatafeedStatus"
}
Updates price and availability of a product in your Merchant Center account. This operation does not update the expiration date of the product. This method can only be called for non-multi-client accounts.
{
"type": "object",
"properties": {
"merchantId": {
"type": "string",
"description": "The ID of the managing account."
},
"storeCode": {
"type": "string",
"description": "The code of the store for which to update price and availability. Use online to update price and availability of an online product."
},
"productId": {
"type": "string",
"description": "The ID of the product for which to update price and availability."
},
"dryRun": {
"type": "boolean",
"description": "Flag to run the request in dry-run mode."
},
"body": {
"$ref": "#/definitions/InventorySetRequest"
},
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"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."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"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. Overrides userIp if both are provided."
},
"userIp": {
"type": "string",
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits."
}
},
"additionalProperties": false,
"required": [
"merchantId",
"storeCode",
"productId"
]
}
{
"$ref": "#/definitions/InventorySetResponse"
}
Lists the orders in your Merchant Center account. This method can only be called for non-multi-client accounts.
{
"type": "object",
"properties": {
"merchantId": {
"type": "string",
"description": "The ID of the managing account."
},
"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.\nWe recommend using this filter set to false, in conjunction with the acknowledge call, such that only un-acknowledged orders are returned."
},
"maxResults": {
"type": "integer",
"description": "The maximum number of orders to return in the response, used for paging. The default value is 25 orders per page, and the maximum allowed value is 250 orders per page.\nKnown issue: All List calls will return all Orders without limit regardless of the value of this field."
},
"orderBy": {
"type": "string",
"description": "The ordering of the returned list. The only supported value are placedDate desc and placedDate asc for now, which returns orders sorted by placement date. \"placedDate desc\" stands for listing orders by placement date, from oldest to most recent. \"placedDate asc\" stands for listing orders by placement date, from most recent to oldest. In future releases we'll support other sorting criteria.",
"enum": [
"placedDate asc",
"placedDate desc"
]
},
"pageToken": {
"type": "string",
"description": "The token returned by the previous request."
},
"placedDateEnd": {
"type": "string",
"description": "Obtains orders placed before this date (exclusively), in ISO 8601 format."
},
"placedDateStart": {
"type": "string",
"description": "Obtains orders placed after this date (inclusively), in ISO 8601 format."
},
"statuses": {
"type": "array",
"description": "Obtains orders that match any of the specified statuses. Multiple values can be specified with comma separation. Additionally, please note that active is a shortcut for pendingShipment and partiallyShipped, and completed is a shortcut for shipped , partiallyDelivered, delivered, partiallyReturned, returned, and canceled."
},
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"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."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"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. Overrides userIp if both are provided."
},
"userIp": {
"type": "string",
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits."
}
},
"additionalProperties": false,
"required": [
"merchantId"
]
}
{
"$ref": "#/definitions/OrdersListResponse"
}
Retrieves an order from your Merchant Center account. This method can only be called for non-multi-client accounts.
{
"type": "object",
"properties": {
"merchantId": {
"type": "string",
"description": "The ID of the managing account."
},
"orderId": {
"type": "string",
"description": "The ID of the order."
},
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"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."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"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. Overrides userIp if both are provided."
},
"userIp": {
"type": "string",
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits."
}
},
"additionalProperties": false,
"required": [
"merchantId",
"orderId"
]
}
{
"$ref": "#/definitions/Order"
}
Marks an order as acknowledged. This method can only be called for non-multi-client accounts.
{
"type": "object",
"properties": {
"merchantId": {
"type": "string",
"description": "The ID of the managing account."
},
"orderId": {
"type": "string",
"description": "The ID of the order."
},
"body": {
"$ref": "#/definitions/OrdersAcknowledgeRequest"
},
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"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."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"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. Overrides userIp if both are provided."
},
"userIp": {
"type": "string",
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits."
}
},
"additionalProperties": false,
"required": [
"merchantId",
"orderId"
]
}
{
"$ref": "#/definitions/OrdersAcknowledgeResponse"
}
Cancels all line items in an order, making a full refund. This method can only be called for non-multi-client accounts.
{
"type": "object",
"properties": {
"merchantId": {
"type": "string",
"description": "The ID of the managing account."
},
"orderId": {
"type": "string",
"description": "The ID of the order to cancel."
},
"body": {
"$ref": "#/definitions/OrdersCancelRequest"
},
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"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."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"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. Overrides userIp if both are provided."
},
"userIp": {
"type": "string",
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits."
}
},
"additionalProperties": false,
"required": [
"merchantId",
"orderId"
]
}
{
"$ref": "#/definitions/OrdersCancelResponse"
}
Cancels a line item, making a full refund. This method can only be called for non-multi-client accounts.
{
"type": "object",
"properties": {
"merchantId": {
"type": "string",
"description": "The ID of the managing account."
},
"orderId": {
"type": "string",
"description": "The ID of the order."
},
"body": {
"$ref": "#/definitions/OrdersCancelLineItemRequest"
},
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"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."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"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. Overrides userIp if both are provided."
},
"userIp": {
"type": "string",
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits."
}
},
"additionalProperties": false,
"required": [
"merchantId",
"orderId"
]
}
{
"$ref": "#/definitions/OrdersCancelLineItemResponse"
}
Refund a portion of the order, up to the full amount paid. This method can only be called for non-multi-client accounts.
{
"type": "object",
"properties": {
"merchantId": {
"type": "string",
"description": "The ID of the managing account."
},
"orderId": {
"type": "string",
"description": "The ID of the order to refund."
},
"body": {
"$ref": "#/definitions/OrdersRefundRequest"
},
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"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."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"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. Overrides userIp if both are provided."
},
"userIp": {
"type": "string",
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits."
}
},
"additionalProperties": false,
"required": [
"merchantId",
"orderId"
]
}
{
"$ref": "#/definitions/OrdersRefundResponse"
}
Returns a line item. This method can only be called for non-multi-client accounts.
{
"type": "object",
"properties": {
"merchantId": {
"type": "string",
"description": "The ID of the managing account."
},
"orderId": {
"type": "string",
"description": "The ID of the order."
},
"body": {
"$ref": "#/definitions/OrdersReturnLineItemRequest"
},
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"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."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"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. Overrides userIp if both are provided."
},
"userIp": {
"type": "string",
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits."
}
},
"additionalProperties": false,
"required": [
"merchantId",
"orderId"
]
}
{
"$ref": "#/definitions/OrdersReturnLineItemResponse"
}
Marks line item(s) as shipped. This method can only be called for non-multi-client accounts.
{
"type": "object",
"properties": {
"merchantId": {
"type": "string",
"description": "The ID of the managing account."
},
"orderId": {
"type": "string",
"description": "The ID of the order."
},
"body": {
"$ref": "#/definitions/OrdersShipLineItemsRequest"
},
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"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."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"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. Overrides userIp if both are provided."
},
"userIp": {
"type": "string",
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits."
}
},
"additionalProperties": false,
"required": [
"merchantId",
"orderId"
]
}
{
"$ref": "#/definitions/OrdersShipLineItemsResponse"
}
Updates the merchant order ID for a given order. This method can only be called for non-multi-client accounts.
{
"type": "object",
"properties": {
"merchantId": {
"type": "string",
"description": "The ID of the managing account."
},
"orderId": {
"type": "string",
"description": "The ID of the order."
},
"body": {
"$ref": "#/definitions/OrdersUpdateMerchantOrderIdRequest"
},
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"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."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"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. Overrides userIp if both are provided."
},
"userIp": {
"type": "string",
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits."
}
},
"additionalProperties": false,
"required": [
"merchantId",
"orderId"
]
}
{
"$ref": "#/definitions/OrdersUpdateMerchantOrderIdResponse"
}
Updates a shipment's status, carrier, and/or tracking ID. This method can only be called for non-multi-client accounts.
{
"type": "object",
"properties": {
"merchantId": {
"type": "string",
"description": "The ID of the managing account."
},
"orderId": {
"type": "string",
"description": "The ID of the order."
},
"body": {
"$ref": "#/definitions/OrdersUpdateShipmentRequest"
},
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"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."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"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. Overrides userIp if both are provided."
},
"userIp": {
"type": "string",
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits."
}
},
"additionalProperties": false,
"required": [
"merchantId",
"orderId"
]
}
{
"$ref": "#/definitions/OrdersUpdateShipmentResponse"
}
Retrieves an order using merchant order id. This method can only be called for non-multi-client accounts.
{
"type": "object",
"properties": {
"merchantId": {
"type": "string",
"description": "The ID of the managing account."
},
"merchantOrderId": {
"type": "string",
"description": "The merchant order id to be looked for."
},
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"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."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"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. Overrides userIp if both are provided."
},
"userIp": {
"type": "string",
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits."
}
},
"additionalProperties": false,
"required": [
"merchantId",
"merchantOrderId"
]
}
{
"$ref": "#/definitions/OrdersGetByMerchantOrderIdResponse"
}
Lists the products in your Merchant Center account. This method can only be called for non-multi-client accounts.
{
"type": "object",
"properties": {
"merchantId": {
"type": "string",
"description": "The ID of the managing account."
},
"includeInvalidInsertedItems": {
"type": "boolean",
"description": "Flag to include the invalid inserted items in the result of the list request. By default the invalid items are not shown (the default value is false)."
},
"maxResults": {
"type": "integer",
"description": "The maximum number of products to return in the response, used for paging."
},
"pageToken": {
"type": "string",
"description": "The token returned by the previous request."
},
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"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."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"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. Overrides userIp if both are provided."
},
"userIp": {
"type": "string",
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits."
}
},
"additionalProperties": false,
"required": [
"merchantId"
]
}
{
"$ref": "#/definitions/ProductsListResponse"
}
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. This method can only be called for non-multi-client accounts.
{
"type": "object",
"properties": {
"merchantId": {
"type": "string",
"description": "The ID of the managing account."
},
"dryRun": {
"type": "boolean",
"description": "Flag to run the request in dry-run mode."
},
"body": {
"$ref": "#/definitions/Product"
},
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"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."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"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. Overrides userIp if both are provided."
},
"userIp": {
"type": "string",
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits."
}
},
"additionalProperties": false,
"required": [
"merchantId"
]
}
{
"$ref": "#/definitions/Product"
}
Deletes a product from your Merchant Center account. This method can only be called for non-multi-client accounts.
{
"type": "object",
"properties": {
"merchantId": {
"type": "string",
"description": "The ID of the managing account."
},
"productId": {
"type": "string",
"description": "The ID of the product."
},
"dryRun": {
"type": "boolean",
"description": "Flag to run the request in dry-run mode."
},
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"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."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"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. Overrides userIp if both are provided."
},
"userIp": {
"type": "string",
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits."
}
},
"additionalProperties": false,
"required": [
"merchantId",
"productId"
]
}
{}
Retrieves a product from your Merchant Center account. This method can only be called for non-multi-client accounts.
{
"type": "object",
"properties": {
"merchantId": {
"type": "string",
"description": "The ID of the managing account."
},
"productId": {
"type": "string",
"description": "The ID of the product."
},
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"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."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"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. Overrides userIp if both are provided."
},
"userIp": {
"type": "string",
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits."
}
},
"additionalProperties": false,
"required": [
"merchantId",
"productId"
]
}
{
"$ref": "#/definitions/Product"
}
Lists the statuses of the products in your Merchant Center account. This method can only be called for non-multi-client accounts.
{
"type": "object",
"properties": {
"merchantId": {
"type": "string",
"description": "The ID of the managing account."
},
"includeInvalidInsertedItems": {
"type": "boolean",
"description": "Flag to include the invalid inserted items in the result of the list request. By default the invalid items are not shown (the default value is false)."
},
"maxResults": {
"type": "integer",
"description": "The maximum number of product statuses to return in the response, used for paging."
},
"pageToken": {
"type": "string",
"description": "The token returned by the previous request."
},
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"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."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"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. Overrides userIp if both are provided."
},
"userIp": {
"type": "string",
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits."
}
},
"additionalProperties": false,
"required": [
"merchantId"
]
}
{
"$ref": "#/definitions/ProductstatusesListResponse"
}
Gets the status of a product from your Merchant Center account. This method can only be called for non-multi-client accounts.
{
"type": "object",
"properties": {
"merchantId": {
"type": "string",
"description": "The ID of the managing account."
},
"productId": {
"type": "string",
"description": "The ID of the product."
},
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"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."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"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. Overrides userIp if both are provided."
},
"userIp": {
"type": "string",
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits."
}
},
"additionalProperties": false,
"required": [
"merchantId",
"productId"
]
}
{
"$ref": "#/definitions/ProductStatus"
}
Lists the shipping settings of the sub-accounts in your Merchant Center account. This method can only be called for multi-client accounts.
{
"type": "object",
"properties": {
"merchantId": {
"type": "string",
"description": "The ID of the managing account."
},
"maxResults": {
"type": "integer",
"description": "The maximum number of shipping settings to return in the response, used for paging."
},
"pageToken": {
"type": "string",
"description": "The token returned by the previous request."
},
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"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."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"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. Overrides userIp if both are provided."
},
"userIp": {
"type": "string",
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits."
}
},
"additionalProperties": false,
"required": [
"merchantId"
]
}
{
"$ref": "#/definitions/ShippingsettingsListResponse"
}
Retrieves the shipping settings of the account. This method can only be called for accounts to which the managing account has access: either the managing account itself or sub-accounts if the managing account is a multi-client account.
{
"type": "object",
"properties": {
"merchantId": {
"type": "string",
"description": "The ID of the managing account."
},
"accountId": {
"type": "string",
"description": "The ID of the account for which to get/update shipping settings."
},
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"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."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"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. Overrides userIp if both are provided."
},
"userIp": {
"type": "string",
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits."
}
},
"additionalProperties": false,
"required": [
"merchantId",
"accountId"
]
}
{
"$ref": "#/definitions/ShippingSettings"
}
Updates the shipping settings of the account. This method can only be called for accounts to which the managing account has access: either the managing account itself or sub-accounts if the managing account is a multi-client account. This method supports patch semantics.
{
"type": "object",
"properties": {
"merchantId": {
"type": "string",
"description": "The ID of the managing account."
},
"accountId": {
"type": "string",
"description": "The ID of the account for which to get/update shipping settings."
},
"dryRun": {
"type": "boolean",
"description": "Flag to run the request in dry-run mode."
},
"body": {
"$ref": "#/definitions/ShippingSettings"
},
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"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."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"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. Overrides userIp if both are provided."
},
"userIp": {
"type": "string",
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits."
}
},
"additionalProperties": false,
"required": [
"merchantId",
"accountId"
]
}
{
"$ref": "#/definitions/ShippingSettings"
}
Updates the shipping settings of the account. This method can only be called for accounts to which the managing account has access: either the managing account itself or sub-accounts if the managing account is a multi-client account.
{
"type": "object",
"properties": {
"merchantId": {
"type": "string",
"description": "The ID of the managing account."
},
"accountId": {
"type": "string",
"description": "The ID of the account for which to get/update shipping settings."
},
"dryRun": {
"type": "boolean",
"description": "Flag to run the request in dry-run mode."
},
"body": {
"$ref": "#/definitions/ShippingSettings"
},
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"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."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"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. Overrides userIp if both are provided."
},
"userIp": {
"type": "string",
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits."
}
},
"additionalProperties": false,
"required": [
"merchantId",
"accountId"
]
}
{
"$ref": "#/definitions/ShippingSettings"
}
Retrieves supported carriers and carrier services for an account.
{
"type": "object",
"properties": {
"merchantId": {
"type": "string",
"description": "The ID of the account for which to retrieve the supported carriers."
},
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"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."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"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. Overrides userIp if both are provided."
},
"userIp": {
"type": "string",
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits."
}
},
"additionalProperties": false,
"required": [
"merchantId"
]
}
{
"$ref": "#/definitions/ShippingsettingsGetSupportedCarriersResponse"
}
Sandbox only. Creates a test order. This method can only be called for non-multi-client accounts.
{
"type": "object",
"properties": {
"merchantId": {
"type": "string",
"description": "The ID of the managing account."
},
"body": {
"$ref": "#/definitions/OrdersCreateTestOrderRequest"
},
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"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."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"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. Overrides userIp if both are provided."
},
"userIp": {
"type": "string",
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits."
}
},
"additionalProperties": false,
"required": [
"merchantId"
]
}
{
"$ref": "#/definitions/OrdersCreateTestOrderResponse"
}
Sandbox only. Moves a test order from state "inProgress" to state "pendingShipment". This method can only be called for non-multi-client accounts.
{
"type": "object",
"properties": {
"merchantId": {
"type": "string",
"description": "The ID of the managing account."
},
"orderId": {
"type": "string",
"description": "The ID of the test order to modify."
},
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"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."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"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. Overrides userIp if both are provided."
},
"userIp": {
"type": "string",
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits."
}
},
"additionalProperties": false,
"required": [
"merchantId",
"orderId"
]
}
{
"$ref": "#/definitions/OrdersAdvanceTestOrderResponse"
}
Sandbox only. Retrieves an order template that can be used to quickly create a new order in sandbox. This method can only be called for non-multi-client accounts.
{
"type": "object",
"properties": {
"merchantId": {
"type": "string",
"description": "The ID of the managing account."
},
"templateName": {
"type": "string",
"description": "The name of the template to retrieve.",
"enum": [
"template1",
"template1a",
"template1b",
"template2"
]
},
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"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."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"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. Overrides userIp if both are provided."
},
"userIp": {
"type": "string",
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits."
}
},
"additionalProperties": false,
"required": [
"merchantId",
"templateName"
]
}
{
"$ref": "#/definitions/OrdersGetTestOrderTemplateResponse"
}
FAQs
DataFire integration for Content API for Shopping
The npm package @datafire/google_content receives a total of 0 weekly downloads. As such, @datafire/google_content popularity was classified as not popular.
We found that @datafire/google_content demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
In this segment of the Risky Business podcast, Feross Aboukhadijeh and Patrick Gray discuss the challenges of tracking malware discovered in open source softare.
Research
Security News
A threat actor's playbook for exploiting the npm ecosystem was exposed on the dark web, detailing how to build a blockchain-powered botnet.
Security News
NVD’s backlog surpasses 20,000 CVEs as analysis slows and NIST announces new system updates to address ongoing delays.