1. Orders
Cold Mail Reseller
  • Cold Mail Reseller API Documentation
  • Users
    • Retrieve all users
      GET
    • Get User Details
      GET
    • Create User
      POST
    • Update User Details
      PUT
    • Delete User
      DELETE
  • Geo
    • Get Countries List
      GET
    • Get States of a Country
      GET
  • Domains
    • Renewal
      • Domain Renewal Overview
      • Get domain renewal pricing
      • Renew domain
      • Enable or disable domain auto-renew
    • Get Domains For User
      GET
    • Suggest Available Domains
      POST
    • Get Single Available Domain
      POST
    • Check If Google Workspace Exists
      POST
    • Add domain forwarding
      POST
    • Add email forwarding
      POST
    • Add Google Client ID to Domain
      POST
    • Remove domains
      DELETE
  • Dns
    • Get dns records for a domain
      GET
    • Adds dns record
      POST
    • Update dns records
      PUT
    • Delete dns records
      DELETE
  • Orders
    • Get Order Details
      GET
    • Get Order Status
      GET
    • Creates order json
      POST
    • Order mailboxes (json)
      POST
    • Process the Order
      POST
    • Create Order
      POST
    • Add mailboxes to a subscription
      POST
  • Mailboxes
    • Get mailboxes for user
    • Get mailbox details by id
    • Get Mailbox Admin Details
    • Update mailbox details
    • Remove mailbox
  • Subscriptions
    • Get All Subscriptions
    • Renew Subscriptions
    • Toggle Auto renewal
    • Cancel Subscription
  • Webhooks
    • Overview
    • Events
      • Domain Events
      • Subscription Events
      • Mailbox Events
      • Prewarmup Events
  • Export
    • Re-export a mailbox (Oauth)
  • Pre-warmup
    • Get all pre warmed up mailboxes
    • Order pre-warmedup mailboxes
  • Get Wallet Details
    GET
  • Send error
    POST
  1. Orders

Get Order Status

GET
/orders/status
Retrieves the order status along with the associated domain and mailboxes statuses.

Query Parameters#

NameTypeRequiredDescription
orderIdstringYesUnique identifier of the order

Order Status Values#

The API returns one of the following status values:
StatusDescription
SUCCESSThe order has been successfully placed
ACTIVEThe order has been successfully placed, and the domain or mailbox is active
INACTIVEThe order has been successfully placed, but the domain or mailbox is inactive
PENDINGThe order is currently being processed
FAILEDThe order processing has failed

Request

Authorization
API Key
Add parameter in header
cmr-x-api-key
Example:
cmr-x-api-key: ********************
or
Query Params

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://customers.coldmailreseller.com/api/v1/integration/orders/status?orderId=AJW25QHTD34CKFMRNKT25C0SPHXY' \
--header 'cmr-x-api-key: <api-key>'

Responses

🟢200Success
application/json
Body

Example
{
    "status": 200,
    "message": "Order status fetched successfully",
    "data": {
        "orders": {
            "domains": [
                {
                    "domain": "theshopyticsapp.com",
                    "domainStatus": "ACTIVE"
                },
                {
                    "domain": "myshopyticsapp.com",
                    "domainStatus": "ACTIVE"
                },
                {
                    "domain": "shopyticsapp.com",
                    "domainStatus": "ACTIVE"
                },
                {
                    "domain": "joinshopyticsapp.com",
                    "domainStatus": "ACTIVE"
                },
                {
                    "domain": "shopyticsappspot.com",
                    "domainStatus": "FAILED"
                },
                {
                    "domain": "shopyticsapptech.com",
                    "domainStatus": "ACTIVE"
                }
            ],
            "mailboxes": {
                "shopyticsapp.com": [
                    {
                        "username": "alex.albon",
                        "mailboxStatus": "ACTIVE"
                    },
                    {
                        "username": "albon",
                        "mailboxStatus": "ACTIVE"
                    },
                    {
                        "username": "alex",
                        "mailboxStatus": "ACTIVE"
                    },
                    {
                        "username": "amelia.williamson",
                        "mailboxStatus": "ACTIVE"
                    },
                    {
                        "username": "williamson.amelia",
                        "mailboxStatus": "ACTIVE"
                    }
                ],
                "joinshopyticsapp.com": [
                    {
                        "username": "alex.albon",
                        "mailboxStatus": "ACTIVE"
                    },
                    {
                        "username": "albon",
                        "mailboxStatus": "ACTIVE"
                    },
                    {
                        "username": "alex",
                        "mailboxStatus": "ACTIVE"
                    },
                    {
                        "username": "amelia.williamson",
                        "mailboxStatus": "ACTIVE"
                    },
                    {
                        "username": "williamson.amelia",
                        "mailboxStatus": "ACTIVE"
                    }
                ],
                "shopyticsapptech.com": [
                    {
                        "username": "alex.albon",
                        "mailboxStatus": "ACTIVE"
                    },
                    {
                        "username": "albon",
                        "mailboxStatus": "ACTIVE"
                    },
                    {
                        "username": "alex",
                        "mailboxStatus": "ACTIVE"
                    },
                    {
                        "username": "amelia.williamson",
                        "mailboxStatus": "ACTIVE"
                    },
                    {
                        "username": "williamson.amelia",
                        "mailboxStatus": "ACTIVE"
                    }
                ],
                "myshopyticsapp.com": [
                    {
                        "username": "alex.albon",
                        "mailboxStatus": "ACTIVE"
                    },
                    {
                        "username": "albon",
                        "mailboxStatus": "ACTIVE"
                    },
                    {
                        "username": "alex",
                        "mailboxStatus": "ACTIVE"
                    },
                    {
                        "username": "amelia.williamson",
                        "mailboxStatus": "ACTIVE"
                    },
                    {
                        "username": "williamson.amelia",
                        "mailboxStatus": "ACTIVE"
                    }
                ],
                "theshopyticsapp.com": [
                    {
                        "username": "alex.albon",
                        "mailboxStatus": "ACTIVE"
                    },
                    {
                        "username": "albon",
                        "mailboxStatus": "ACTIVE"
                    },
                    {
                        "username": "alex",
                        "mailboxStatus": "ACTIVE"
                    },
                    {
                        "username": "amelia.williamson",
                        "mailboxStatus": "ACTIVE"
                    },
                    {
                        "username": "williamson.amelia",
                        "mailboxStatus": "ACTIVE"
                    }
                ],
                "shopyticsappspot.com": [
                    {
                        "username": "alex.albon",
                        "mailboxStatus": "FAILED"
                    },
                    {
                        "username": "albon",
                        "mailboxStatus": "FAILED"
                    },
                    {
                        "username": "alex",
                        "mailboxStatus": "FAILED"
                    },
                    {
                        "username": "amelia.williamson",
                        "mailboxStatus": "FAILED"
                    },
                    {
                        "username": "williamson.amelia",
                        "mailboxStatus": "FAILED"
                    }
                ]
            }
        }
    }
}
🟠404Not Found
🟠422Unprocessable Entity
Modified at 2025-12-17 10:11:26
Previous
Get Order Details
Next
Creates order json
Built with