Method: orders.batchget

  • The orders.batchGet API retrieves order details for a list of orders.

  • This API uses a GET HTTP request with a specific URL format including the package name.

  • The required path parameter is packageName, specifying the application.

  • The required query parameter is orderIds[], containing a list of 1 to 1000 distinct order IDs.

  • The response body is empty, and upon success, it contains a JSON object with an array of order details.

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