Add

Description

Places an Add/Transfer Google Workspace Order for the specified domain name.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
domain-name String Required The domain name for which the Order is to be placed
months Integer Required The number of months for which the Order is placed
no-of-accounts Integer Required The number of accounts required
customer-id Integer Required The Customer under whom the Order should be added
auto-renew Boolean Optional

Enables / Disables the Auto Renewal setting for the Order

Note

 

Auto-Renewal
invoice-option String Required This parameter will decide how the Customer's Invoice will be handled. Values can be: NoInvoice, PayInvoice, KeepInvoice, or OnlyAdd.
discount-amount Float Optional Discount amount for the order value.
plan-id Integer Optional Pass the correct plan ID based on the output received from the transfer details call. If there is no plan ID specified, the order will be provisioned for the Google Workspace starter
Is-transfer-in Boolean Optional This parameter will decide if this is a new order or a transfer order. The default status is False.
Values: True / False

HTTP Method

POST

Example Test URL Request

India

https://test.httpapi.com/api/gapps/in/add.json?auth-userid=0&api-key=key&domain-name=domain.com&customer-id=0&months=0&no-of-accounts=0&invoice-option=NoInvoice&discount-amount=0.00&is-transfer-in=False

South East Asia & Egypt

https://test.httpapi.com/api/gapps/se/add.json?auth-userid=0&api-key=key&domain-name=domain.com&customer-id=0&months=0&no-of-accounts=0&invoice-option=NoInvoice&discount-amount=0.00&is-transfer-in=False

Rest of the World

https://test.httpapi.com/api/gapps/gbl/add.json?auth-userid=0&api-key=key&domain-name=domain.com&customer-id=0&months=0&no-of-accounts=0&invoice-option=NoInvoice&discount-amount=0.00&is-transfer-in=False

Response

Returns a hash map containing the following details:

  • Domain Name (description)

  • Order ID of the Google Workspace Order (entityid)

  • Action Type (actiontype)

  • Description of the Google Workspace Order Add Action (actiontypedesc)

  • Action ID of the Google Workspace Order Add Action (eaqid)

  • Google Workspace Order Add Action Status (actionstatus)

  • Description of the Google Workspace Order Add Action Status (actionstatusdesc)

  • Invoice ID of the Google Workspace Order Add Invoice (invoiceid)

  • Selling Currency of the Reseller (sellingcurrencysymbol)

  • Transaction Amount in the Selling Currency (sellingamount)

  • Unutilised Transaction Amount in the Selling Currency (unutilisedsellingamount)

  • Customer ID associated with the Google workspace Order (customerid)

  • Discount Amount (discount-amount)

  • Transfer status: (Is_transfer_in)

Note

 

The API will confirm successful actions with a success message. For transfer requests (indicated by 'is_transfer_in=true'), it's important to use the 'Get Details' call to track the real-time progress of your order.

"If the Get Details calls show the status mentioned below, the initial transfer request was made with an incorrect RPI or Plan ID. The RPI/Plan ID is a crucial identifier for processing transfers. You'll need to generate a new transfer authorization, ensuring you use the correct RPI this time or enter the correct plan ID derived from the transfer details call."

  • "actionstatus": "TRANSFERRING_ORDER", "currentstatus": "InActive",
  • invoiceid, sellingcurrencysymbol, sellingamount, unutilisedsellingamount and customerid will not be returned if invoice-option is set to NoInvoice.

Currently we are offering a 40% discount for upto 20 accounts on Google Workspace Plans. This will be applicable to your account invoice.

In case of any errors, a status key with value as ERROR alongwith an error message will be returned.