Important: only registered resellers can use this functionality.
This page is an extension of the normal "Dedicated Server" API category and describes all the API calls you can make to order a dedicated server.
You will always receive the output as described in the documentation below unless an error ocurred. For more information, see the error handling section.
Prerequisites
We use a few numeric values that have a special meaning. These are described here:
Group Input Types / Item Input Type Override:Used to indicate the selection type of items within a group. Most groups simply have the radio input type where you can only select one item. Others allow for multiple (checkbox) selection. Others have a single item but with a quantity field. Finally there are a few groups that have a default input type of radio, but selecting a certain item then allows you to enter a quantity for that particular item. That item then has an input override value to inform you of this possibility.
const INPUTTYPE_SELECT = 0; const INPUTTYPE_RADIO = 1; const INPUTTYPE_CHECKBOX = 2; const INPUTTYPE_CBQUANTITY = 3; const INPUTTYPE_HDDQUANTITY = 4; const INPUTTYPE_SLOTQUANTITY = 5; const INPUTTYPE_PARTITIONING = 6; const INPUTTYPE_INPUT_QUANTITY = 7; const INPUTTYPE_INPUT_TEXT = 8; const INPUTTYPE_BOGUS = 9; const INPUTTYPE_INPUTFIELD = 10; const INPUTTYPE_TEXTAREA = 11;
Actions
| Parameter | Context | Type | Description |
|---|---|---|---|
| No parameters | |||
| Parameter | Context | Type | Description |
|---|---|---|---|
| groups | array | Collection of groups | groupCode | groups | string | The group's unique code | groupName | groups | string | The group's name | groupDefault | groups | string | The unique item code of the default item of this group | items | groups | array | Collection of items in the group | code | items | string | The unique code of the item | name | items | string | The public name of the item | identifier | items | string | Unique identifier of the item | price | items | float | The price of the item in eurocents | listPrice | items | float | Original price of the item in eurocents | canOrder | items | int | Whether this item can be ordered (0 or 1) | groupCode | items | string | The unique code of the group it belongs to | groupName | items | string | The name of the group it belongs to |
Example
Array
(
[status] => Success
[msg] => OK
[data] => stdClass Object
(
[groups] => Array
(
[0] => Array
(
[groupCode] => 748293DC
[groupName] => Server Type
[groupDefault] => IEDC620C2
[items] => Array
(
[0] => Array
(
[code] => IEDC620C2
[name] => Dell PowerEdge PE860
[identifier] => PE860
[listPrice] => 28
[price] => 30
[canOrder] => 1
[groupCode] => 748293DC
[groupName] => Server Type
)
[1] => Array
(
[code] => I891FC978
[name] => Dell PowerEdge PE1950
[identifier] => PE1950
[listPrice] => 33
[price] => 35
[canOrder] => 1
[groupCode] => 748293DC
[groupName] => Server Type
)
)
)
)
)
)
| Parameter | Context | Type | Description |
|---|---|---|---|
| groupCode | string | The order group code. All group codes can be retrieved using the getOrderGroups command. |
| Parameter | Context | Type | Description |
|---|---|---|---|
| groups | array | Collection of groups | groupCode | groups | string | The group's unique code | groupName | groups | string | The group's name | groupDefault | groups | string | The unique item code of the default item of this group | items | groups | array | Collection of items in the group | code | items | string | The unique code of the item | name | items | string | The public name of the item | identifier | items | string | Unique identifier of the item | price | items | float | The price of the item in eurocents | listPrice | items | float | Original price of the item in eurocents | canOrder | items | int | Whether this item can be ordered (0 or 1) | groupCode | items | string | The unique code of the group it belongs to | groupName | items | string | The name of the group it belongs to |
Example
Array
(
[status] => Success
[msg] => OK
[data] => stdClass Object
(
[groups] => Array
(
[0] => Array
(
[groupCode] => 748293DC
[groupName] => Server Type
[groupDefault] => IEDC620C2
[items] => Array
(
[0] => Array
(
[code] => IEDC620C2
[name] => Dell PowerEdge PE860
[identifier] => PE860
[listPrice] => 28
[price] => 30
[canOrder] => 1
[groupCode] => 748293DC
[groupName] => Server Type
)
[1] => Array
(
[code] => I891FC978
[name] => Dell PowerEdge PE1950
[identifier] => PE1950
[listPrice] => 33
[price] => 35
[canOrder] => 1
[groupCode] => 748293DC
[groupName] => Server Type
)
)
)
)
)
)
| Parameter | Context | Type | Description |
|---|---|---|---|
| No parameters | |||
| Parameter | Context | Type | Description |
|---|---|---|---|
| configs | array | Collection of server pre-configurations | name | configs | string | The name of the configuration | locationId | configs | string | The location id of the item, see getLocations | lastmodified | configs | int | A UNIX timestamp to identify when the config is modified. | tag | configs | int | A unique code to identify the configuration | price | configs | int | The price of the configruation in eurocents | listPrice | configs | int | Original price of the configruation in eurocents | items | configs | array | A list of all items for this configuration | code | items | string | A unique code to identify the item | name | items | string | The name of the item | price | items | int | The price of the item in eurocents | groupType | items | string | A unique name to identify the group | groupName | items | string | The name of the group the item is in |
Example
Array
(
[status] => Success
[msg] => OK
[data] => stdClass Object
(
[configs] => Array
(
[0] => stdClass Object
(
[name] => Example configuration
[locationId] => 18
[lastmodified] => 1417013107
[tag] => 1200
[price] => 1234
[items] => Array
(
[0] => stdClass Object
(
[code] => E800731A
[name] => Example server XL pro 2000
[price] => 1234
[groupType] => CHASSIS
[groupName] => Server Type
)
)
)
)
)
)
| Parameter | Context | Type | Description |
|---|---|---|---|
| tag | int | The configuration tag. All available tags can be retrieved using the getPreConfiguredServers command. |
| Parameter | Context | Type | Description |
|---|---|---|---|
| configDetails | array | Details of a pre-defined server configuration | name | configDetails | string | The name of the configuration | locationId | configDetails | string | The location id of the item, see getLocations | tag | configDetails | int | The tag of the configuration | price | configDetails | int | The price of the configuration, in cents | listPrice | configDetails | int | Original price of the configuration, in cents | items | configDetails | array | Collection of groups and items | code | items | string | The unique code of the default item in this group | name | items | string | The name of the default item in this group | price | items | int | The price of the default item in this group, in eurocents | listPrice | items | int | Original price of the default item in this group, in eurocents | groupCode | items | string | The unique code of the item group | groupType | items | string | The group type | groupInputType | items | string | A number to identify what kind of input type is recommended. | groupName | items | string | The group name | allowEmptySelection | items | int | Whether it is OK to leave this group empty | optionalItems | items | array | A collection of items that can be selected instead of the default item | name | optionalItems | string | Name of the item | code | optionalItems | string | Unique code of the item | shortName | optionalItems | string | Short name of the item (if available) | identifier | optionalItems | string | Plain text identifier of the item | inputTypeOverride | optionalItems | int | If larger than -1, indicates the item's input type (overriding the group's input type) | price | optionalItems | int | The price of the item in eurocents | listPrice | optionalItems | int | Original price of the item in eurocents | setupPrice | optionalItems | int | The setup price of the item in eurocents | displayOrder | optionalItems | int | Display order | groupCode | optionalItems | string | Unique group code | groupName | optionalItems | string | Group name | specifications | optionalItems | array | Optional item specifications. e.g. for a contract period: months, discount_percentage | name | specifications | string | The name of the specification | value | specifications | mixed | The value of the specification | dataType | specifications | string | The intended data type of the value | mandatory | specifications | int | Whether this is a mandatory specification. If it is and the value is empty, it is an error on our end |
Example
Array
(
[status] => Success
[msg] => OK
[data] => stdClass Object
(
[configDetails] => Array
(
[name] => Offer Single Socket Dell R200
[tag] => 1207
[price] => 5500
[items] => Array
(
[0] => Array
(
[code] => IE878731E
[name] => Dell PowerEdge R200
[price] => 1234
[listPrice] => 1234
[setupPrice] => 0
[inputTypeOverride] => -1
[groupCode] => 748293DC
[groupType] => CHASSIS
[groupName] => Server Type
[specifications] => Array
(
[0] => Array
(
[name] => max_ram
[value] => 8
[dataType] => int
[mandatory] => 0
)
[1] => Array
(
[name] => max_cpu
[value] => 1
[dataType] => int
[mandatory] => 0
)
)
)
)
)
)
)
| Parameter | Context | Type | Description |
|---|---|---|---|
| tag | int | The configuration tag. |
| Parameter | Context | Type | Description |
|---|---|---|---|
| groups | array | Collection of groups | code | groups | string | Unique code of the item | name | groups | string | The name of the item | shortName | groups | string | A short name for the item (optional) | type | groups | string | A unique name to identify the group | inputType | groups | int | A number to identify what kind of input type is recommended. | dependencyGroup | groups | int | Give the groupcode if there is a dependency for this group. | items | items | array | A list of the items in the group. | code | items | string | A unique code to identify the item. | name | items | string | The name of the item | shortName | items | string | A short name for the item | identifier | items | string | Plain text identifier of the item | inputTypeOverride | items | int | A number to identify what kind of input type is recommended for this item. See the notes at the top of this page. | price | items | int | The price of the item in eurocents | setupPrice | items | int | The setup cost for the item in eurocents | displayOrder | items | int | The item display order |
Example
Array
(
[status] => Success
[msg] => OK
[data] => stdClass Object
(
[groups] => Array
(
[0] => stdClass Object
(
[code] => 748293DC
[name] => Server Type
[shortName] => Server Type
[type] => CHASSIS
[inputType] => 0
[dependencyGroup] => 487845455
[items] => Array
(
[0] => stdClass Object
(
[code] => F800731A
[name] => Dell PowerEdge R410
[shortName] => dpr410
[identifier] => R410
[inputTypeOverride] => -1
[price] => 25000
[setupPrice] => 1000
[displayOrder] => 100
[specifications] => Array
(
[0] => stdClass Object
(
[name] => max_ram
[value] => 128
[dataType] => int
[mandatory] => 1
)
)
)
)
)
)
)
)
| Parameter | Context | Type | Description |
|---|---|---|---|
| tag | int | The configuration tag. | config | json | The configuration you want to validate. Please refer to the page Ordering a dedicated server for the structure of this object. |
| Parameter | Context | Type | Description |
|---|---|---|---|
| message | string | A simple message about what happend. | config | json | The same configuration that you have submited will be returned. | baseprice | cents | int | The basic price of the config without any user tax / discount / coupons. | price | cents | int | The price that you pay to i3D.net. | setup | cents | int | The price that you pay to i3D.net for the setup. |
Example
Array
(
[status] => Success
[msg] => OK
[data] => stdClass Object
(
[result] => OK
[message] => Your config is valid.
[baseprice] => 35000
[price] => 42000
[setup] => 0
)
)
| Parameter | Context | Type | Description |
|---|---|---|---|
| tag | int | The configuration tag. | config | json | The configuration you want to validate. Please refer to the page Ordering a dedicated server for the structure of this object. |
| Parameter | Context | Type | Description |
|---|---|---|---|
| result | string | "OK" or "error" | message | string | Human readable result message. | invoiceId | string | The ID of the invoice that has been created. | password | string | The generated server password. The user name for *nix installs is always "root". The user name for Windows installs is always "administrator" |
Example
Array
(
[status] => Success
[msg] => OK
[data] => stdClass Object
(
[result] => OK
[message] => Server order created.
[invoiceId] => _INVOICE-ID_
[password] => _PASSWORD_
)
)
| Parameter | Context | Type | Description |
|---|---|---|---|
| invoiceId | int | InvoiceId of the order |
| Parameter | Context | Type | Description |
|---|---|---|---|
| dedicatedServers | array | List of dedicated servers. | dediserverId | dedicatedServers | int | The dedicated server id |
Example
Array
(
[status] => Success
[msg] => OK
[data] => stdClass Object
(
[dedicatedServers] => Array
(
[dediserverId] => _ID_
)
)
)