Mail Order Management APIs

Fetch Order Details

API to fetch detailed information about a specific Mail Order on Titan Mail Cloud Infra using the titanOrderId.

This API provides comprehensive details about a mail order including account counts, domain information, and order status.

get/partner/fetchOrderDetails

Request

  • Base URL: https://bll.titan.email
  • URL: https://bll.titan.email/partner/fetchOrderDetails
  • Auth: none declared

Query parameters

titanOrderIdnumber required
Example:123

The Titan order ID for which detailed information is required

Response

OK

titanOrderIdnumber

<span data-no-badge></span>The Titan order ID

domainNamestring

<span data-no-badge></span>The mail order name associated to the Titan order ID

orderIdstring

<span data-no-badge></span>The order ID stored on your end for this mail order, if any. You can use this data to correlate orders at your end and in Titan.

planTypestring

<span data-no-badge></span>The plan type of the mail order

noOfAccountsnumber

<span data-no-badge></span>Maximum number of email accounts permitted to be created within the domain. E.g. The domain might have 3 mailboxes created with a limit of 10 mailboxes. The return value will be 10 in this case

noOfBillableAccountsnumber

<span data-no-badge></span>Number of email accounts provisioned, which are in active/suspended state if domain is on non paid plan. Would be equal to noOfAccounts for paid domains.

noOfActiveAccountsnumber

<span data-no-badge></span>Number of active email accounts

noOfProvisionedAccountsnumber

<span data-no-badge></span>Number of email accounts provisioned, which are in active/suspended state

expiryDatestring

<span data-no-badge></span>In yyyy-MM-dd format. Expiry date set against the domain

statusstring

<span data-no-badge></span>Current status of the order

customerEmailAddressstring

<span data-no-badge></span>Customer email address All communications will be sent here This will also be the primary admin for the domain

serverHostNamestring

hostname of the hosting-server where user's hosting order has been provisioned. only available in case provisioning is via cPanel/plesk plugin

source'domain' | 'standalone' | 'hosting' | 'migrated'

The source from which the order is received - Refers to the kind of package provisioned on the partners end. Source field should be either of these values - domain, standalone, hosting, migrated. It will be validated against these values when the Api call is made

titanCustomerIdnumber

<span data-no-badge></span>Titan's internal customer ID

customerIdstring

<span data-no-badge></span>Partner's customer ID stored on your end for this customer

addonSubscriptionCountersobject

Map of addon type to the configured subscription quota for this order.

Example response

{
  "titanOrderId": 123,
  "domainName": "abc.com",
  "orderId": "12431",
  "planType": "premium",
  "noOfAccounts": 10,
  "noOfBillableAccounts": 10,
  "noOfActiveAccounts": 6,
  "noOfProvisionedAccounts": 8,
  "expiryDate": "2020-01-31",
  "status": "active",
  "customerEmailAddress": "titanuser@titan.mail",
  "serverHostName": "cpanel102.titan.co",
  "source": "hosting",
  "titanCustomerId": 456,
  "customerId": "abc123",
  "addonSubscriptionCounters": {
    "storage_addon": 5
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.