Logo@Nainhost.Com

Add

Description

Places a G Suite 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 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
invoice-option String Required This parameter will decide how the Customer's Invoice will be handled. Values can be: NoInvoice, PayInvoice, KeepInvoice or OnlyAdd.
transfer-token String Optional The Transfer token for the G Suite order.

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

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

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

Response

Returns a hash map containing the below details:

  • Domain Name (description)

  • Order ID of the G Suite Order (entityid)

  • Action Type (actiontype)

  • Description of the G Suite Order Add Action (actiontypedesc)

  • Action ID of the G Suite Order Add Action (eaqid)

  • G Suite Order Add Action Status (actionstatus)

  • Description of the G Suite Order Add Action Status (actionstatusdesc)

  • Invoice ID of the G Suite 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 G Suite Order (customerid)

Note

invoiceid, sellingcurrencysymbol, sellingamount, unutilisedsellingamount and customerid will not be returned if invoice-option is set to NoInvoice.

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