Mail Order Management APIs

Get All Mail Orders

API to fetch list of all Mail Orders on Titan Mail Cloud Infra for a given customerId or titanCustomerId. Recommended to use titanCustomerId as it uniquely identifies a customer.

NOTE for partners using Titan's cPanel/plesk plugins:

  • If Titan finds multiple customers with same customerId on different cPanel/plesk hosts:
    • The API fails with an InternalServerError as a unique customer is not found
    • If you instead want Titan to collate mail orders for given customerId across all your hosts and return in response, do let Titan know
      • the behaviour can be enabled at Titan's end via a config change
      • once the behaviour is enabled, instead of a failure you will see collated orders
    • For an order, you can differentiate customers details using customerEmailAddress and serverHostName params.
  • customerId, in case of cPanel/plesk, is the username on those servers
  • do make sure of adding any extra filtering required at your end, on host or customer email, before showing list to customers
get/partner/listMailOrders

Request

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

Query parameters

customerIdstring
Example:abc12345

The customer ID stored on your end for each customer This is used to identify all the orders linked to a particular customer. Either customerId or titanCustomerId must be provided.

titanCustomerIdnumber
Example:123

The customer ID stored on Titan's end. Either customerId or titanCustomerId must be provided.

Response

OK

Example response

{
  "orders": [
    {
      "titanOrderId": 1,
      "domainName": "abc.com",
      "orderId": "12431",
      "planType": "pro",
      "noOfAccounts": 10,
      "numberOfAccounts": 10,
      "noOfBillableAccounts": 10,
      "noOfActiveAccounts": 6,
      "noOfProvisionedAccounts": 8,
      "expiryDate": "2020-01-31",
      "status": "active",
      "customerEmailAddress": "titanuser@titan.mail",
      "serverHostName": "cpanel102.titan.co",
      "source": "hosting"
    }
  ]
}

Changes

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