"description":"Selector specifying which fields to include in a partial response.",
"location":"query"
},
"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.",
"location":"query"
},
"oauth_token":{
"type":"string",
"description":"OAuth 2.0 token for the current user.",
"location":"query"
},
"prettyPrint":{
"type":"boolean",
"description":"Returns response with indentations and line breaks.",
"default":"true",
"location":"query"
},
"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.",
"location":"query"
},
"userIp":{
"type":"string",
"description":"IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
"location":"query"
}
},
"auth":{
"oauth2":{
"scopes":{
"https://www.googleapis.com/auth/content":{
"description":"Manage your product listings and accounts for Google Shopping"
}
}
}
},
"schemas":{
"Error":{
"id":"Error",
"type":"object",
"description":"An error returned by the API.",
"properties":{
"domain":{
"type":"string",
"description":"The domain of the error."
},
"message":{
"type":"string",
"description":"A description of the error."
},
"reason":{
"type":"string",
"description":"The error code."
}
}
},
"Errors":{
"id":"Errors",
"type":"object",
"description":"A list of errors returned by a failed batch entry.",
"properties":{
"code":{
"type":"integer",
"description":"The HTTP status of the first error in errors.",
"format":"uint32"
},
"errors":{
"type":"array",
"description":"A list of errors.",
"items":{
"$ref":"Error"
}
},
"message":{
"type":"string",
"description":"The message of the first error in errors."
}
}
},
"Order":{
"id":"Order",
"type":"object",
"properties":{
"acknowledged":{
"type":"boolean",
"description":"Whether the order was acknowledged."
},
"channelType":{
"type":"string",
"description":"The channel type of the order: \"purchaseOnGoogle\" or \"googleExpress\"."
},
"customer":{
"$ref":"OrderCustomer",
"description":"The details of the customer who placed the order."
},
"deliveryDetails":{
"$ref":"OrderDeliveryDetails",
"description":"The details for the delivery."
},
"id":{
"type":"string",
"description":"The REST id of the order. Globally unique."
},
"kind":{
"type":"string",
"description":"Identifies what kind of resource this is. Value: the fixed string \"content#order\".",
"default":"content#order"
},
"lineItems":{
"type":"array",
"description":"Line items that are ordered.",
"items":{
"$ref":"OrderLineItem"
}
},
"merchantId":{
"type":"string",
"format":"uint64"
},
"merchantOrderId":{
"type":"string",
"description":"Merchant-provided id of the order."
},
"netAmount":{
"$ref":"Price",
"description":"The net amount for the order. For example, if an order was originally for a grand total of $100 and a refund was issued for $20, the net amount will be $80."
},
"paymentMethod":{
"$ref":"OrderPaymentMethod",
"description":"The details of the payment method."
},
"paymentStatus":{
"type":"string",
"description":"The status of the payment."
},
"placedDate":{
"type":"string",
"description":"The date when the order was placed, in ISO 8601 format."
},
"promotions":{
"type":"array",
"description":"The details of the merchant provided promotions applied to the order. More details about the program are here.",
"items":{
"$ref":"OrderPromotion"
}
},
"refunds":{
"type":"array",
"description":"Refunds for the order.",
"items":{
"$ref":"OrderRefund"
}
},
"shipments":{
"type":"array",
"description":"Shipments of the order.",
"items":{
"$ref":"OrderShipment"
}
},
"shippingCost":{
"$ref":"Price",
"description":"The total cost of shipping for all items."
},
"shippingCostTax":{
"$ref":"Price",
"description":"The tax for the total shipping cost."
},
"shippingOption":{
"type":"string",
"description":"The requested shipping option."
},
"status":{
"type":"string",
"description":"The status of the order."
}
}
},
"OrderAddress":{
"id":"OrderAddress",
"type":"object",
"properties":{
"country":{
"type":"string",
"description":"CLDR country code (e.g. \"US\")."
},
"fullAddress":{
"type":"array",
"description":"Strings representing the lines of the printed label for mailing the order, for example:\nJohn Smith\n1600 Amphitheatre Parkway\nMountain View, CA, 94043\nUnited States",
"items":{
"type":"string"
}
},
"isPostOfficeBox":{
"type":"boolean",
"description":"Whether the address is a post office box."
},
"locality":{
"type":"string",
"description":"City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs)."
},
"postalCode":{
"type":"string",
"description":"Postal Code or ZIP (e.g. \"94043\")."
},
"recipientName":{
"type":"string",
"description":"Name of the recipient."
},
"region":{
"type":"string",
"description":"Top-level administrative subdivision of the country (e.g. \"CA\")."
},
"streetAddress":{
"type":"array",
"description":"Street-level part of the address.",
"items":{
"type":"string"
}
}
}
},
"OrderCancellation":{
"id":"OrderCancellation",
"type":"object",
"properties":{
"actor":{
"type":"string",
"description":"The actor that created the cancellation."
},
"creationDate":{
"type":"string",
"description":"Date on which the cancellation has been created, in ISO 8601 format."
},
"quantity":{
"type":"integer",
"description":"The quantity that was canceled.",
"format":"uint32"
},
"reason":{
"type":"string",
"description":"The reason for the cancellation. Orders that are cancelled with a noInventory reason will lead to the removal of the product from POG until you make an update to that product. This will not affect your Shopping ads."
},
"reasonText":{
"type":"string",
"description":"The explanation of the reason."
}
}
},
"OrderCustomer":{
"id":"OrderCustomer",
"type":"object",
"properties":{
"email":{
"type":"string",
"description":"Email address of the customer."
},
"explicitMarketingPreference":{
"type":"boolean",
"description":"If set, this indicates the user explicitly chose to opt in or out of providing marketing rights to the merchant. If unset, this indicates the user has already made this choice in a previous purchase, and was thus not shown the marketing right opt in/out checkbox during the checkout flow."
},
"fullName":{
"type":"string",
"description":"Full name of the customer."
}
}
},
"OrderDeliveryDetails":{
"id":"OrderDeliveryDetails",
"type":"object",
"properties":{
"address":{
"$ref":"OrderAddress",
"description":"The delivery address"
},
"phoneNumber":{
"type":"string",
"description":"The phone number of the person receiving the delivery."
"description":"Total price for the line item. For example, if two items for $10 are purchased, the total price will be $20."
},
"product":{
"$ref":"OrderLineItemProduct",
"description":"Product data from the time of the order placement."
},
"quantityCanceled":{
"type":"integer",
"description":"Number of items canceled.",
"format":"uint32"
},
"quantityDelivered":{
"type":"integer",
"description":"Number of items delivered.",
"format":"uint32"
},
"quantityOrdered":{
"type":"integer",
"description":"Number of items ordered.",
"format":"uint32"
},
"quantityPending":{
"type":"integer",
"description":"Number of items pending.",
"format":"uint32"
},
"quantityReturned":{
"type":"integer",
"description":"Number of items returned.",
"format":"uint32"
},
"quantityShipped":{
"type":"integer",
"description":"Number of items shipped.",
"format":"uint32"
},
"returnInfo":{
"$ref":"OrderLineItemReturnInfo",
"description":"Details of the return policy for the line item."
},
"returns":{
"type":"array",
"description":"Returns of the line item.",
"items":{
"$ref":"OrderReturn"
}
},
"shippingDetails":{
"$ref":"OrderLineItemShippingDetails",
"description":"Details of the requested shipping for the line item."
},
"tax":{
"$ref":"Price",
"description":"Total tax amount for the line item. For example, if two items are purchased, and each have a cost tax of $2, the total tax amount will be $4."
}
}
},
"OrderLineItemProduct":{
"id":"OrderLineItemProduct",
"type":"object",
"properties":{
"brand":{
"type":"string",
"description":"Brand of the item."
},
"channel":{
"type":"string",
"description":"The item's channel (online or local)."
},
"condition":{
"type":"string",
"description":"Condition or state of the item."
},
"contentLanguage":{
"type":"string",
"description":"The two-letter ISO 639-1 language code for the item."
},
"gtin":{
"type":"string",
"description":"Global Trade Item Number (GTIN) of the item."
},
"id":{
"type":"string",
"description":"The REST id of the product."
},
"imageLink":{
"type":"string",
"description":"URL of an image of the item."
},
"itemGroupId":{
"type":"string",
"description":"Shared identifier for all variants of the same product."
},
"mpn":{
"type":"string",
"description":"Manufacturer Part Number (MPN) of the item."
},
"offerId":{
"type":"string",
"description":"An identifier of the item."
},
"price":{
"$ref":"Price",
"description":"Price of the item."
},
"shownImage":{
"type":"string",
"description":"URL to the cached image shown to the user when order was placed."
},
"targetCountry":{
"type":"string",
"description":"The CLDR territory code of the target country of the product."
},
"title":{
"type":"string",
"description":"The title of the product."
},
"variantAttributes":{
"type":"array",
"description":"Variant attributes for the item. These are dimensions of the product, such as color, gender, material, pattern, and size. You can find a comprehensive list of variant attributes here.",
"items":{
"$ref":"OrderLineItemProductVariantAttribute"
}
}
}
},
"OrderLineItemProductVariantAttribute":{
"id":"OrderLineItemProductVariantAttribute",
"type":"object",
"properties":{
"dimension":{
"type":"string",
"description":"The dimension of the variant."
},
"value":{
"type":"string",
"description":"The value for the dimension."
}
}
},
"OrderLineItemReturnInfo":{
"id":"OrderLineItemReturnInfo",
"type":"object",
"properties":{
"daysToReturn":{
"type":"integer",
"description":"How many days later the item can be returned.",
"format":"int32",
"annotations":{
"required":[
"content.orders.createtestorder"
]
}
},
"isReturnable":{
"type":"boolean",
"description":"Whether the item is returnable.",
"annotations":{
"required":[
"content.orders.createtestorder"
]
}
},
"policyUrl":{
"type":"string",
"description":"URL of the item return policy.",
"annotations":{
"required":[
"content.orders.createtestorder"
]
}
}
}
},
"OrderLineItemShippingDetails":{
"id":"OrderLineItemShippingDetails",
"type":"object",
"properties":{
"deliverByDate":{
"type":"string",
"description":"The delivery by date, in ISO 8601 format.",
"annotations":{
"required":[
"content.orders.createtestorder"
]
}
},
"method":{
"$ref":"OrderLineItemShippingDetailsMethod",
"description":"Details of the shipping method.",
"annotations":{
"required":[
"content.orders.createtestorder"
]
}
},
"shipByDate":{
"type":"string",
"description":"The ship by date, in ISO 8601 format.",
"description":"The date and time frame when the promotion is active and ready for validation review. Note that the promotion live time may be delayed for a few hours due to the validation review.\nStart date and end date are separated by a forward slash (/). The start date is specified by the format (YYYY-MM-DD), followed by the letter ?T?, the time of the day when the sale starts (in Greenwich Mean Time, GMT), followed by an expression of the time zone for the sale. The end date is in the same format."
},
"genericRedemptionCode":{
"type":"string",
"description":"Optional. The text code that corresponds to the promotion when applied on the retailer?s website."
},
"id":{
"type":"string",
"description":"The unique ID of the promotion."
},
"longTitle":{
"type":"string",
"description":"The full title of the promotion."
},
"productApplicability":{
"type":"string",
"description":"Whether the promotion is applicable to all products or only specific products."
},
"redemptionChannel":{
"type":"string",
"description":"Indicates that the promotion is valid online."
}
}
},
"OrderPromotionBenefit":{
"id":"OrderPromotionBenefit",
"type":"object",
"properties":{
"discount":{
"$ref":"Price",
"description":"The discount in the order price when the promotion is applied."
},
"offerIds":{
"type":"array",
"description":"The OfferId(s) that were purchased in this order and map to this specific benefit of the promotion.",
"items":{
"type":"string"
}
},
"subType":{
"type":"string",
"description":"Further describes the benefit of the promotion. Note that we will expand on this enumeration as we support new promotion sub-types."
},
"taxImpact":{
"$ref":"Price",
"description":"The impact on tax when the promotion is applied."
},
"type":{
"type":"string",
"description":"Describes whether the promotion applies to products (e.g. 20% off) or to shipping (e.g. Free Shipping)."
}
}
},
"OrderRefund":{
"id":"OrderRefund",
"type":"object",
"properties":{
"actor":{
"type":"string",
"description":"The actor that created the refund."
},
"amount":{
"$ref":"Price",
"description":"The amount that is refunded."
},
"creationDate":{
"type":"string",
"description":"Date on which the item has been created, in ISO 8601 format."
},
"reason":{
"type":"string",
"description":"The reason for the refund."
},
"reasonText":{
"type":"string",
"description":"The explanation of the reason."
}
}
},
"OrderReturn":{
"id":"OrderReturn",
"type":"object",
"properties":{
"actor":{
"type":"string",
"description":"The actor that created the refund."
},
"creationDate":{
"type":"string",
"description":"Date on which the item has been created, in ISO 8601 format."
"description":"Amount to refund for the cancelation. Optional. If not set, Google will calculate the default based on the price and tax of the items involved. The amount must not be larger than the net amount left on the order."
"description":"Amount to refund for the cancelation. Optional. If not set, Google will calculate the default based on the price and tax of the items involved. The amount must not be larger than the net amount left on the order."
},
"amountTax":{
"$ref":"Price",
"description":"Tax amount that correspond to cancellation amount in amountPretax."
"description":"Identifies what kind of resource this is. Value: the fixed string \"content#ordersCancelLineItemResponse\".",
"default":"content#ordersCancelLineItemResponse"
}
}
},
"OrdersCancelRequest":{
"id":"OrdersCancelRequest",
"type":"object",
"properties":{
"operationId":{
"type":"string",
"description":"The ID of the operation. Unique across all operations for a given order."
},
"reason":{
"type":"string",
"description":"The reason for the cancellation."
},
"reasonText":{
"type":"string",
"description":"The explanation of the reason."
}
}
},
"OrdersCancelResponse":{
"id":"OrdersCancelResponse",
"type":"object",
"properties":{
"executionStatus":{
"type":"string",
"description":"The status of the execution."
},
"kind":{
"type":"string",
"description":"Identifies what kind of resource this is. Value: the fixed string \"content#ordersCancelResponse\".",
"default":"content#ordersCancelResponse"
}
}
},
"OrdersCreateTestOrderRequest":{
"id":"OrdersCreateTestOrderRequest",
"type":"object",
"properties":{
"templateName":{
"type":"string",
"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."
},
"testOrder":{
"$ref":"TestOrder",
"description":"The test order to create."
}
}
},
"OrdersCreateTestOrderResponse":{
"id":"OrdersCreateTestOrderResponse",
"type":"object",
"properties":{
"kind":{
"type":"string",
"description":"Identifies what kind of resource this is. Value: the fixed string \"content#ordersCreateTestOrderResponse\".",
"default":"content#ordersCreateTestOrderResponse"
},
"orderId":{
"type":"string",
"description":"The ID of the newly created test order."
}
}
},
"OrdersCustomBatchRequest":{
"id":"OrdersCustomBatchRequest",
"type":"object",
"properties":{
"entries":{
"type":"array",
"description":"The request entries to be processed in the batch.",
"items":{
"$ref":"OrdersCustomBatchRequestEntry"
}
}
}
},
"OrdersCustomBatchRequestEntry":{
"id":"OrdersCustomBatchRequestEntry",
"type":"object",
"properties":{
"batchId":{
"type":"integer",
"description":"An entry ID, unique within the batch request.",
"description":"Amount to refund for the cancelation. Optional. If not set, Google will calculate the default based on the price and tax of the items involved. The amount must not be larger than the net amount left on the order."
"description":"Amount to refund for the cancelation. Optional. If not set, Google will calculate the default based on the price and tax of the items involved. The amount must not be larger than the net amount left on the order."
},
"amountTax":{
"$ref":"Price",
"description":"Tax amount that correspond to cancellation amount in amountPretax."
"description":"Deprecated. Please use shipmentInfo instead. The carrier handling the shipment. See shipments[].carrier in the Orders resource representation for a list of acceptable values."
"description":"Deprecated. Please use shipmentInfo instead. The ID of the shipment."
},
"shipmentInfos":{
"type":"array",
"description":"Shipment information. This field is repeated because a single line item can be shipped in several packages (and have several tracking IDs).",
"description":"The carrier handling the shipment. Not updated if missing. See shipments[].carrier in the Orders resource representation for a list of acceptable values."
"description":"Deprecated. Please use shipmentInfo instead. The carrier handling the shipment. See shipments[].carrier in the Orders resource representation for a list of acceptable values."
"description":"Deprecated. Please use shipmentInfo instead. The ID of the shipment."
},
"shipmentInfos":{
"type":"array",
"description":"Shipment information. This field is repeated because a single line item can be shipped in several packages (and have several tracking IDs).",
"description":"The carrier handling the shipment. Not updated if missing. See shipments[].carrier in the Orders resource representation for a list of acceptable values."
"description":"The details of the payment method."
},
"predefinedDeliveryAddress":{
"type":"string",
"description":"Identifier of one of the predefined delivery addresses for the delivery.",
"annotations":{
"required":[
"content.orders.createtestorder"
]
}
},
"promotions":{
"type":"array",
"description":"The details of the merchant provided promotions applied to the order. More details about the program are here.",
"items":{
"$ref":"OrderPromotion"
}
},
"shippingCost":{
"$ref":"Price",
"description":"The total cost of shipping for all items.",
"annotations":{
"required":[
"content.orders.createtestorder"
]
}
},
"shippingCostTax":{
"$ref":"Price",
"description":"The tax for the total shipping cost.",
"annotations":{
"required":[
"content.orders.createtestorder"
]
}
},
"shippingOption":{
"type":"string",
"description":"The requested shipping option.",
"annotations":{
"required":[
"content.orders.createtestorder"
]
}
}
}
},
"TestOrderCustomer":{
"id":"TestOrderCustomer",
"type":"object",
"properties":{
"email":{
"type":"string",
"description":"Email address of the customer.",
"annotations":{
"required":[
"content.orders.createtestorder"
]
}
},
"explicitMarketingPreference":{
"type":"boolean",
"description":"If set, this indicates the user explicitly chose to opt in or out of providing marketing rights to the merchant. If unset, this indicates the user has already made this choice in a previous purchase, and was thus not shown the marketing right opt in/out checkbox during the checkout flow. Optional."
},
"fullName":{
"type":"string",
"description":"Full name of the customer."
}
}
},
"TestOrderLineItem":{
"id":"TestOrderLineItem",
"type":"object",
"properties":{
"product":{
"$ref":"TestOrderLineItemProduct",
"description":"Product data from the time of the order placement."
},
"quantityOrdered":{
"type":"integer",
"description":"Number of items ordered.",
"format":"uint32",
"annotations":{
"required":[
"content.orders.createtestorder"
]
}
},
"returnInfo":{
"$ref":"OrderLineItemReturnInfo",
"description":"Details of the return policy for the line item.",
"annotations":{
"required":[
"content.orders.createtestorder"
]
}
},
"shippingDetails":{
"$ref":"OrderLineItemShippingDetails",
"description":"Details of the requested shipping for the line item.",
"annotations":{
"required":[
"content.orders.createtestorder"
]
}
},
"unitTax":{
"$ref":"Price",
"description":"Unit tax for the line item.",
"annotations":{
"required":[
"content.orders.createtestorder"
]
}
}
}
},
"TestOrderLineItemProduct":{
"id":"TestOrderLineItemProduct",
"type":"object",
"properties":{
"brand":{
"type":"string",
"description":"Brand of the item.",
"annotations":{
"required":[
"content.orders.createtestorder"
]
}
},
"channel":{
"type":"string",
"description":"The item's channel.",
"annotations":{
"required":[
"content.orders.createtestorder"
]
}
},
"condition":{
"type":"string",
"description":"Condition or state of the item.",
"annotations":{
"required":[
"content.orders.createtestorder"
]
}
},
"contentLanguage":{
"type":"string",
"description":"The two-letter ISO 639-1 language code for the item.",
"annotations":{
"required":[
"content.orders.createtestorder"
]
}
},
"gtin":{
"type":"string",
"description":"Global Trade Item Number (GTIN) of the item. Optional."
},
"imageLink":{
"type":"string",
"description":"URL of an image of the item.",
"annotations":{
"required":[
"content.orders.createtestorder"
]
}
},
"itemGroupId":{
"type":"string",
"description":"Shared identifier for all variants of the same product. Optional."
},
"mpn":{
"type":"string",
"description":"Manufacturer Part Number (MPN) of the item. Optional."
},
"offerId":{
"type":"string",
"description":"An identifier of the item.",
"annotations":{
"required":[
"content.orders.createtestorder"
]
}
},
"price":{
"$ref":"Price",
"description":"The price for the product.",
"annotations":{
"required":[
"content.orders.createtestorder"
]
}
},
"targetCountry":{
"type":"string",
"description":"The CLDR territory code of the target country of the product.",
"annotations":{
"required":[
"content.orders.createtestorder"
]
}
},
"title":{
"type":"string",
"description":"The title of the product.",
"annotations":{
"required":[
"content.orders.createtestorder"
]
}
},
"variantAttributes":{
"type":"array",
"description":"Variant attributes for the item. Optional.",
"description":"Obtains orders that match the acknowledgement status. When set to true, obtains orders that have been acknowledged. When false, obtains orders that have not been acknowledged.\nWe recommend using this filter set to false, in conjunction with the acknowledge call, such that only un-acknowledged orders are returned.",
"location":"query"
},
"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.",
"description":"The ordering of the returned list. The only supported value are placedDate desc and placedDate asc for now, which returns orders sorted by placement date. \"placedDate desc\" stands for listing orders by placement date, from oldest to most recent. \"placedDate asc\" stands for listing orders by placement date, from most recent to oldest. In future releases we'll support other sorting criteria.",
"enum":[
"placedDate asc",
"placedDate desc"
],
"enumDescriptions":[
"",
""
],
"location":"query"
},
"pageToken":{
"type":"string",
"description":"The token returned by the previous request.",
"location":"query"
},
"placedDateEnd":{
"type":"string",
"description":"Obtains orders placed before this date (exclusively), in ISO 8601 format.",
"location":"query"
},
"placedDateStart":{
"type":"string",
"description":"Obtains orders placed after this date (inclusively), in ISO 8601 format.",
"location":"query"
},
"statuses":{
"type":"string",
"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.",
