Method: orders.batchget
Stay organized with collections
Save and categorize content based on your preferences.
orders.get order details for a list of orders.
HTTP request
GET https://androidpublisher.googleapis.com/androidpublisher/v3/applications/{packageName}/orders:batchGet
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
packageName |
string
Required. The package name of the application for which this subscription or in-app item was purchased (for example, 'com.some.thing').
|
Query parameters
| Parameters |
orderIds[] |
string
Required. The list of order IDs to retrieve order details for. There must be between 1 and 1000 (inclusive) order IDs per request. If any order ID is not found or does not match the provided package, the entire request will fail with an error. The order IDs must be distinct.
|
Request body
The request body must be empty.
Response body
Response for the orders.batchGet API.
If successful, the response body contains data with the following structure:
| JSON representation |
{
"orders": [
{
object (Order)
}
]
} |
| Fields |
orders[] |
object (Order)
Details for the requested order IDs.
|
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/androidpublisher
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-05-20 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-05-20 UTC."],[],[],null,["# Method: orders.batchget\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.BatchGetOrdersResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\norders.get order details for a list of orders.\n\n### HTTP request\n\n`GET https://androidpublisher.googleapis.com/androidpublisher/v3/applications/{packageName}/orders:batchGet`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|---------------|--------------------------------------------------------------------------------------------------------------------------------------------------|\n| `packageName` | `string` Required. The package name of the application for which this subscription or in-app item was purchased (for example, 'com.some.thing'). |\n\n### Query parameters\n\n| Parameters ||\n|--------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `orderIds[]` | `string` Required. The list of order IDs to retrieve order details for. There must be between 1 and 1000 (inclusive) order IDs per request. If any order ID is not found or does not match the provided package, the entire request will fail with an error. The order IDs must be distinct. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nResponse for the orders.batchGet API.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|----------------------------------------------------------------------------------------|\n| ``` { \"orders\": [ { object (/android-publisher/api-ref/rest/v3/orders#Order) } ] } ``` |\n\n| Fields ||\n|------------|------------------------------------------------------------------------------------------------------------|\n| `orders[]` | `object (`[Order](/android-publisher/api-ref/rest/v3/orders#Order)`)` Details for the requested order IDs. |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/androidpublisher`"]]