get_order_info
Queries all the information on an order ID, but does not return sensitive
information such as username, password, and Authcode.
Request parameters
Standard request parameters
- action = get_order_info
- object = domain
Request attributes
Parameters within the attributes associative array are described below:
| Parameter | Obligation | Definition/Value |
|---|---|---|
| order_id | Required | The ID of the order to query. |
Response parameters
Standard response parameters
- action = reply
- object = domain
- is_success = Boolean indicating success or failure of the request.
- response_code = Response code indicating outcome of the request.
- response_text = Message describing the outcome of the request.
Request attributes
If the request is successful, the attributes associative array may include the following:
| Parameter | Obligation | Definition/Value |
|---|---|---|
| field_hash | Always returned | An associative array listing the domain order parameters, for more information, see the field_hash table. |
Response parameters within the field_hash associative array may include the following:
| Parameter | Obligation | Definition/Value |
|---|---|---|
| domain | Always returned | The domain being queried. |
| reg_type | Always returned | Type of order, for example, new, premium, renewal, sunrise, transfer, or whois_privacy. |
| affiliate_id | Always returned | The associated affiliate ID. |
| cost | Always returned | The transaction cost. |
| encoding type | Always returned | The three-character tag that represents the language encoding type for the domain. See AppendixB: Encoding Types for IDNs. |
| f_auto_renew | Always returned | Flag (Y or N) indicating whether domain is set to automatically renew. |
| f_lock_domain | Always returned | Indicates whether the domain is locked. 0—Domain is not locked 1—Domain is locked |
| flag_saved_ns_fields | Always returned | Indicates whether the nameserver fields that were used were those submitted in the transaction request or the default nameserver information. |
| flag_saved_tech_fields | Always returned | Indicates whether the technical contact fields that were used were those submitted in the transaction request or the default reseller account technical contact information. |
| forwarding_email | Always returned | The domain's e-mail address that is used for forwarding purposes. |
| fqdn1/2/3/4/5/6 | Always returned | Nameservers submitted with the registration. |
| id | Always returned | The ID number of the order. |
| master_order_id | Always returned | The order ID for a group of domains that are linked. |
| notes | Always returned | An associative array listing note contents, parameters in the associative array are: timestamp—Date and time the note was recorded, in the format: DD-MMM-YYYY hh:mm:ss note—Contents of the note |
| order_date | Always returned | Date the order was created. |
| owner* admin* billing* tech* | Always returned | The contact information for owner, admin, billing, and tech contacts for the order. May include first_name, last_name, org_name, address1, address2, address3, city, state, postal_code, country, phone, fax, and email. |
| period | Always returned | The length of the registration period in years. |
| processed_date | Always returned | Date the order was processed. |
| reg_domain | Always returned | An existing, active domain name in OpenSRS, owned by the registrant that was used to link the newly registered or transferred domain to the profile of the existing domain. |
| status | Always returned | Current status of the order. Values may be declined, pending, deleted, completed, cancelled, or waiting_ca_owner_approval. |
| comments | Always returned | Comments submitted in the original transaction. |
| tld_data | Returned for specific TLDs | An associative array containing registrant information. For more information, see “tld_data”. |
| completed_date | Returned for transfer orders | Date when the transfer was completed |
| expiry_year | Returned for transfer orders | Domain's current expiry year. |
| owner_confirm_time | Returned for transfer orders | Date when the owner responded to the transfer request |
| owner_request_time | Returned for transfer orders | Date when the email to confirm that transfer was sent. |
| registry_request_time | Returned for transfer orders | The time when the transfer request was sent to the registry. |
| request_address | Returned for transfer orders | The email address to which the transfer approval email was sent. |
| transfer_notes | Returned for transfer orders | An associative array listing note contents, parameters in the associative array are: timestamp—Date and time the note was recorded, in the format: DD-MMM-YYYY hh:mm:ss note—Contents of the note |
| transfer_status | Returned for transfer orders | The current status of the transfer. |
| application_id | Returned for sunrise or landrush orders | The ID number of the application. |
| application_status | Returned for sunrise or landrush orders | The status of the application. |
Exampes
.COM domain registration order
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">get_order_info</item>
<item key="object">domain</item>
<item key="attributes">
<dt_assoc>
<item key="order_id">3515690</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">DOMAIN</item>
<item key="is_success">1</item>
<item key="response_code">200</item>
<item key="response_text">Command completed
successfully</item>
<item key="attributes">
<dt_assoc>
<item key="field_hash">
<dt_assoc>
<item key="owner_first_name">Owen</item>
<item key="owner_last_name">Ottway</item>
<item key="owner_org_name">Example Inc.</item>
<item key="owner_address1">32 Oak St.</item>
<item key="owner_address2">Suite 500</item>
<item key="owner_address3" />
<item key="owner_city">Santa Clara</item>
<item key="owner_state">CA</item>
<item key="owner_country">US</item>
<item key="owner_postal_code">90210</item>
<item key="owner_phone">+1.4165550123x1902</item>
<item key="owner_fax">+1.4165550124</item>
<item key="owner_email">[email protected]</item>
<item key="admin_first_name">Adler</item>
<item key="admin_last_name">Adams</item>
<item key="admin_org_name">Example Inc.</item>
<item key="admin_address1">32 Oak St.</item>
<item key="admin_address2">Suite 100</item>
<item key="admin_address3" />
<item key="admin_city">Santa Clara</item>
<item key="admin_state">CA</item>
<item key="admin_country">US</item>
<item key="admin_postal_code">90210</item>
<item key="admin_phone">+1.4165550123x1812</item>
<item key="admin_fax" />
<item key="admin_email">[email protected]</item>
<item key="billing_first_name">Bill</item>
<item key="billing_last_name">Burton</item>
<item key="billing_org_name">Example Inc.</item>
<item key="billing_address1">32 Oak St.</item>
<item key="billing_address2">Suite 200</item>
<item key="billing_address3" />
<item key="billing_city">Santa Clara</item>
<item key="billing_state">CA</item>
<item key="billing_country">US</item>
<item key="billing_postal_code">90210</item>
<item key="billing_phone">+1.4165550123x1248</item>
<item key="billing_fax" />
<item key="billing_email">[email protected]</item>
<item key="tech_first_name">Ted</item>
<item key="tech_last_name">Tucker</item>
<item key="tech_org_name">Example Inc.</item>
<item key="tech_address1">32 Oak St.</item>
<item key="tech_address2">Suite 100</item>
<item key="tech_address3" />
<item key="tech_city">Santa Clara</item>
<item key="tech_state">CA</item>
<item key="tech_country">US</item>
<item key="tech_postal_code">90210</item>
<item key="tech_phone">+1.4165550123x1243</item>
<item key="tech_fax">+1.4165550127</item>
<item key="tech_email">[email protected]</item>
<item key="comments" />
<item key="reg_domain">december-2-
2002.com</item>
<item key="domain">example.com</item>
<item key="transfer_notes">
<dt_array>
<item key="0">
<dt_assoc>
<item key="timestamp">05-OCT-2007
17:07:42</item>
<item key="note">Transfer Request
message sent to [email protected]</item>
</dt_assoc>
</item>
</dt_array>
</item>
<item key="affiliate_id" />
<item key="order_date">1083590189</item>
<item key="status">completed</item>
<item key="f_lock_domain">0</item>
<item key="forwarding_email" />
<item key="flag_saved_ns_fields">1</item>
<item key="processed_date" />
<item key="id">3515690</item>
<item key="encoding_type">undef</item>
<item key="flag_saved_tech_fields">1</item>
<item key="completed_date">1083590192</item>
<item key="f_auto_renew">Y</item>
<item key="fqdn1">ns1.systemdns.com</item>
<item key="fqdn2">ns2.systemdns.com</item>
<item key="fqdn3" />
<item key="fqdn4" />
<item key="fqdn5" />
<item key="fqdn6" />
<item key="reg_type">new</item>
<item key="notes">
<dt_array>
<item key="0">
<dt_assoc>
<item key="note">RSP Note: testing
first note</item>
<item key="timestamp">27-OCT-2007
11:15:03</item>
</dt_assoc>
</item>
<item key="1">
<dt_assoc>
<item key="note">RSP Note: testing
second note</item>
<item key="timestamp">27-OCT-2007
11:15:05</item>
</dt_assoc>
</item>
<item key="2">
<dt_assoc>
<item key="note">RSP Note: testing
third note</item>
<item key="timestamp">27-OCT-2007
11:15:07</item>
</dt_assoc>
</item>
</dt_array>
</item>
<item key="master_order_id">0</item>
<item key="period">1</item>
<item key="cost">15</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
.DK domain registration order
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="action">get_order_info</item>
<item key="object">domain</item>
<item key="attributes">
<dt_assoc>
<item key="order_id">607642</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="object">DOMAIN</item>
<item key="is_success">1</item>
<item key="response_text">Command completed successfully</item>
<item key="attributes">
<dt_assoc>
<item key="field_hash">
<dt_assoc>
<item key="owner_last_name">Jensen</item>
<item key="owner_org_name">Example Co.</item>
<item key="owner_address2" />
<item key="owner_address3" />
<item key="owner_city">Copenhagen V</item>
<item key="owner_state" />
<item key="owner_postal_code">1610</item>
<item key="owner_phone">+1.33257400</item>
<item key="owner_fax">+1.33257410</item>
<item key="owner_email">[email protected]</item>
<item key="admin_org_name">Example Co.</item>
<item key="admin_first_name">Katrin</item>
<item key="admin_last_name">Jensen</item>
<item key="admin_address1">Gammel Kongevej 1</item>
<item key="admin_address2" />
<item key="admin_address3" />
<item key="admin_city">Copenhagen V</item>
<item key="admin_state" />
<item key="admin_country">DK</item>
<item key="admin_postal_code">1610</item>
<item key="admin_phone">+1.33257400</item>
<item key="admin_fax">+1.33257410</item>
<item key="admin_email">[email protected]</item>
<item key="billing_org_name">Example Co.</item>
<item key="billing_first_name">Sarah</item>
<item key="billing_last_name">Jensen</item>
<item key="billing_address1">Gammel Kongevej 1</item>
<item key="billing_address2" />
<item key="billing_address3" />
<item key="billing_city">Copenhagen V</item>
<item key="billing_state" />
<item key="billing_postal_code">1610</item>
<item key="billing_country">DK</item>
<item key="billing_phone">+1.33257400</item>
<item key="billing_fax">+1.33257410</item>
<item key="billing_email">[email protected]</item>
<item key="tech_org_name">Example Co.</item>
<item key="tech_first_name">Eric</item>
<item key="tech_last_name">Jensen</item>
<item key="tech_address1">Gammel Kongevej 1</item>
<item key="tech_address2" />
<item key="tech_address3" />
<item key="tech_city">Copenhagen V</item>
<item key="tech_state" />
<item key="tech_postal_code">1610</item>
<item key="tech_country">DK</item>
<item key="tech_phone">+1.33257400</item>
<item key="tech_fax">+1.33257410</item>
<item key="tech_email">[email protected]</item>
<item key="affiliate_id">affiliatetest1</item>
<item key="domain">qatest1380643516039.dk</item>
<item key="tld_data">
<dt_assoc>
<item key="registrant_extra_info">
<dt_assoc>
<item key="registrant_type">organization</item>
<item key="registrant_vat_id">123456789</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
<item key="flag_saved_tech_fields">1</item>
<item key="completed_date">1380643717</item>
<item key="notes">
<dt_array></dt_array>
</item>
<item key="reg_domain" />
<item key="comments" />
<item key="id">607642</item>
<item key="cost">15</item>
<item key="flag_saved_ns_fields">1</item>
<item key="master_order_id">0</item>
<item key="order_date">1380643519</item>
<item key="f_auto_renew">Y</item>
<item key="forwarding_email" />
<item key="status">completed</item>
<item key="fqdn1">ns1.systemdns.com</item>
<item key="fqdn2">ns2.systemdns.com</item>
<item key="fqdn3" />
<item key="fqdn4" />
<item key="fqdn5" />
<item key="fqdn6" />
<item key="reg_type">new</item>
<item key="f_lock_domain">0</item>
<item key="period">1</item>
<item key="encoding_type" />
<item key="processed_date" />
</dt_assoc>
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
.FR domain registration order
<?xml version='1.0' encoding='UTF-8'?>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">get_order_info</item>
<item key="object">domain</item>
<item key="attributes">
<dt_assoc>
<item key="order_id">457700</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">DOMAIN</item>
<item key="response_code">200</item>
<item key="is_success">1</item>
<item key="response_text">Command completed successfully</item>
<item key="attributes">
<dt_assoc>
<item key="field_hash">
<dt_assoc>
<item key="domain">example.fr</item>
<item key="owner_org_name">Example GmbH</item>
<item key="owner_first_name">Astrid</item>
<item key="owner_last_name">Bauer</item>
<item key="owner_address1">Klostergasse 10</item>
<item key="owner_address2" />
<item key="owner_address3" />
<item key="owner_city">Innsbruck</item>
<item key="owner_state">Tirol</item>
<item key="owner_postal_code">6020</item>
<item key="owner_country">AT</item>
<item key="owner_phone">+43 512 5333 10</item>
<item key="owner_fax">+43 512 5333 11</item>
<item key="owner_email">[email protected]</item>
<item key="admin_first_name">Franz</item>
<item key="admin_last_name">Bauer</item>
<item key="admin_org_name">Example GmbH</item>
<item key="admin_address1">Klostergasse 10</item>
<item key="admin_address2" />
<item key="admin_address3" />
<item key="admin_city">Innsbruck</item>
<item key="admin_state">Tirol</item>
<item key="admin_postal_code">6020</item>
<item key="admin_country">AT</item>
<item key="admin_phone">+1.4165350125</item>
<item key="admin_fax">+1.4165350124</item>
<item key="admin_email">[email protected]</item>
<item key="billing_first_name" />
<item key="billing_last_name" />
<item key="billing_org_name" />
<item key="billing_address1" />
<item key="billing_address2" />
<item key="billing_address3" />
<item key="billing_city" />
<item key="billing_state" />
<item key="billing_postal_code" />
<item key="billing_country" />
<item key="billing_phone" />
<item key="billing_fax" />
<item key="billing_email" />
<item key="tech_first_name">Jorg</item>
<item key="tech_last_name">Bauer</item>
<item key="tech_org_name">Example GmbH</item>
<item key="tech_address1">Klostergasse 10</item>
<item key="tech_address2" />
<item key="tech_address3" />
<item key="tech_city">Innsbruck</item>
<item key="tech_state">Tirol</item>
<item key="tech_country">AT</item>
<item key="tech_postal_code">6020</item>
<item key="tech_phone">+1.4165350125</item>
<item key="tech_fax">+1.4165350124</item>
<item key="tech_email">[email protected]</item>
<item key="processed_date" />
<item key="fqdn1">ns1.systemdns.com</item>
<item key="fqdn2">ns2.systemdns.com</item>
<item key="fqdn3" />
<item key="fqdn4" />
<item key="fqdn5" />
<item key="fqdn6" />
<item key="period">1</item>
<item key="encoding_type" />
<item key="affiliate_id" />
<item key="tld_data">
<dt_assoc>
<item key="registrant_extra_info">
<dt_assoc>
<item key="registrant_type">individual</item>
<item key="date_of_birth">1989-03-03</item>
<item key="country_of_birth">FR</item>
<item key="postal_code_of_birth">75008</item>
<item key="place_of_birth">Paris</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
<item key="flag_saved_tech_fields">1</item>
<item key="completed_date">1329504888</item>
<item key="notes">
<dt_array></dt_array>
</item>
<item key="reg_domain" />
<item key="comments" />
<item key="id">457700</item>
<item key="cost">15</item>
<item key="flag_saved_ns_fields">1</item>
<item key="master_order_id">0</item>
<item key="order_date">1329504872</item>
<item key="f_auto_renew">Y</item>
<item key="forwarding_email" />
<item key="status">completed</item>
<item key="reg_type">new</item>
<item key="f_lock_domain">0</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
.XXX domain registration order
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">get_order_info</item>
<item key="object">domain</item>
<item key="attributes">
<dt_assoc>
<item key="order_id">457626</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">DOMAIN</item>
<item key="response_code">200</item>
<item key="is_success">1</item>
<item key="response_text">Command completed successfully</item>
<item key="attributes">
<dt_assoc>
<item key="field_hash">
<dt_assoc>
<item key="owner_org_name">Example Inc.</item>
<item key="owner_first_name">Owen</item>
<item key="owner_last_name">Ottway</item>
<item key="owner_address1">32 Oak St.</item>
<item key="owner_address2">Suite 500</item>
<item key="owner_address3" />
<item key="owner_city">Santa Clara</item>
<item key="owner_state">CA</item>
<item key="owner_postal_code">90210</item>
<item key="owner_country">US</item>
<item key="owner_email">[email protected]</item>
<item key="owner_phone">+1.4165550123x1902</item>
<item key="owner_fax">+1.4165350124</item>
<item key="admin_org_name">Example Inc.</item>
<item key="admin_first_name">Adler</item>
<item key="admin_last_name">Adams</item>
<item key="admin_address1">32 Oak St.</item>
<item key="admin_address2">Suite 100</item>
<item key="admin_address3" />
<item key="admin_city">Santa Clara</item>
<item key="admin_state">CA</item>
<item key="admin_postal_code">90210</item>
<item key="admin_country">US</item>
<item key="admin_phone">+1.4165550123x1812</item>
<item key="admin_fax">+1.4165350124</item>
<item key="admin_email">[email protected]</item>
<item key="billing_first_name">Bill</item>
<item key="billing_last_name">Burton</item>
<item key="billing_org_name">Example Inc.</item>
<item key="billing_address1">32 Oak St.</item>
<item key="billing_address2">Suite 200</item>
<item key="billing_address3" />
<item key="billing_city">Santa Clara</item>
<item key="billing_state">CA</item>
<item key="billing_country">US</item>
<item key="billing_postal_code">90210</item>
<item key="billing_email">[email protected]</item>
<item key="billing_phone">+1.4165550123x1248</item>
<item key="billing_fax">+1.4165350124</item>
<item key="tech_first_name">Ted</item>
<item key="tech_last_name">Tech Lastname</item>
<item key="tech_org_name">Tucker</item>
<item key="tech_address1">32 Oak St.</item>
<item key="tech_address2">Suite 100</item>
<item key="tech_address3" />
<item key="tech_city">Santa Clara</item>
<item key="tech_state">CA</item>
<item key="tech_postal_code">90210</item>
<item key="tech_email">[email protected]</item>
<item key="tech_phone">+1.4165550123x1243</item>
<item key="tech_fax">+1.4165350124</item>
<item key="processed_date" />
<item key="fqdn2">ns2.systemdns.com</item>
<item key="period">1</item>
<item key="application_id">D10215-XXX</item>
<item key="ipr_entitlement">OWNER</item>
<item key="affiliate_id" />
<item key="fqdn4" />
<item key="ipr_type">AD</item>
<item key="domain">example.xxx</item>
<item key="flag_saved_tech_fields">1</item>
<item key="completed_date" />
<item key="tld_data">
<dt_assoc>
<item key="ipr_data">
<dt_assoc>
<item key="ipr_name">Owen Ottway</item>
<item key="ipr_email">[email protected]</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
<item key="notes">
<dt_array>
<item key="0">
<dt_assoc>
<item key="timestamp">15-FEB-2012
18:08:50</item>
<item key="note">Domain lock enabled</item>
</dt_assoc>
</item>
</dt_array>
</item>
<item key="reg_domain" />
<item key="fqdn3" />
<item key="fqdn5" />
<item key="comments" />
<item key="id">315169</item>
<item key="ipr_registration_date">2011-01-01</item>
<item key="cost">85</item>
<item key="flag_saved_ns_fields">1</item>
<item key="application_status">processed</item>
<item key="master_order_id">0</item>
<item key="order_date">1314713193</item>
<item key="f_auto_renew">Y</item>
<item key="forwarding_email" />
<item key="status">completed</item>
<item key="fqdn6" />
<item key="reg_type">sunrise</item>
<item key="fqdn1">ns1.systemdns.com</item>
<item key="tech_country">CA</item>
<item key="f_lock_domain">1</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Updated almost 2 years ago