Loading...

Knowledge Base
Home 
 
/
 Get the Details of a Google Workspace Order Using the API
Categories: Google Workspace API

Get the Details of a Google Workspace Order Using the API

When you want to retrieve the details of an existing Google Workspace order using the API. This article explains the required authentication parameters, order ID input, used account count option, Google Workspace order information, account details, order status information, and order response details.

Get Details

Description

Gets the details of an existing Google Workspace Order.

Parameters

NameData TypeRequired / OptionalDescription
auth-useridIntegerRequiredAuthentication Parameter
api-keyStringRequiredAuthentication Parameter
order-idIntegerRequiredThe Order Id for which the details to be fetched.
options=used_account_count-OptionalGet the number of used accounts.

HTTP Method

GET

Example Test URL Request

India

https://test.httpapi.com/api/gapps/in/details.json?auth-userid=0&api-key=key&order-id=0

South East Asia & Egypt

https://test.httpapi.com/api/gapps/se/details.json?auth-userid=0&api-key=key&order-id=0

Rest of the World

https://test.httpapi.com/api/gapps/gbl/details.json?auth-userid=0&api-key=key&order-id=0

Response

Returns a hash map containing details of the Google Workspace Order as below:

  • Order Id (entityid)

  • Order Description (description)

  • Domain Name (domainname)

  • Current Order Status under the System (currentstatus) - value will be InActive, Active, Suspended, Pending Delete Restorable, Deleted or Archived

  • Product Category (productcategory)

  • Product Key (productkey)

  • Order Creation Date (creationtime)

  • Expiry Date (endtime)

  • Whether Order belongs to a Customer directly under the Reseller (isImmediateReseller)

  • Reseller Chain by Reseller Id (parentkey)

  • Customer Id Associated with the Order (customerid)

  • Number of Email Accounts (emailaccounts)

  • Whether Order Suspended due to Expiry (isOrderSuspendedUponExpiry)

  • Whether Order Suspended by Parent Reseller (orderSuspendedByParent)

  • Whether Auto-Renewal is enabled (recurring)

  • Whether Order Deletion is Allowed (allowdeletion)

  • Number of Accounts Created or Used for the order. (used_account_count)