placeOrder


SoftLayer_Product_Order::placeOrder

Place an order using the [[SoftLayer_Container_Product_Order]] data type.

Overview

Use this method to place bare metal server, virtual server and additional service orders with SoftLayer. Upon success, your credit card or PayPal account will incur charges for the monthly order total (or prorated value if ordered mid billing cycle). If all products on the order are only billed hourly, you will be charged on your billing anniversary date, which occurs monthly on the day you ordered your first service with SoftLayer. For new customers, you are required to provide billing information when you place an order. For existing customers, the credit card on file will be charged. If you’re a PayPal customer, a URL will be returned from the call to [[SoftLayer_Product_Order/placeOrder|placeOrder]] which is to be used to finish the authorization process. This authorization tells PayPal that you indeed want to place an order with SoftLayer. From PayPal’s web site, you will be redirected back to SoftLayer for your order receipt.

When an order is placed, your order will be in a “pending approval” state. When all internal checks pass, your order will be automatically approved. For orders that may need extra attention, a Sales representative will review the order and contact you if necessary. Once the order is approved, your server or service will be provisioned and available to you shortly thereafter. Depending on the type of server or service ordered, provisioning times will vary.

Order Containers

When placing API orders, it’s important to order your server and services on the appropriate [[SoftLayer_Container_Product_Order (type)|order container]]. Failing to provide the correct container may delay your server or service from being provisioned in a timely manner. Some common order containers are included below.

Note: SoftLayer_Container_ProductOrder has been removed from the containers in the table below for readability.

Product Order container Package type
Bare metal server by CPU [[SoftLayer_Container_Product_Order_Hardware_Server (type)|Hardware_Server]] BARE_METAL_CPU
Bare metal server by core [[SoftLayer_Container_Product_Order_Hardware_Server (type)|Hardware_Server]] BARE_METAL_CORE
Virtual server [[SoftLayer_Container_Product_Order_Virtual_Guest (type)|Virtual_Guest]] VIRTUAL_SERVER_INSTANCE
DNS domain registration [[SoftLayer_Container_Product_Order_Dns_Domain_Registration (type)|Dns_Domain_Registration]] ADDITIONAL_SERVICES
Local & dedicated load balancers [[SoftLayer_Container_Product_Order_Network_LoadBalancer (type)|Network_LoadBalancer]] ADDITIONAL_SERVICES_LOAD_BALANCER
Content delivery network [[SoftLayer_Container_Product_Order_Network_ContentDelivery_Account (type)|Network_ContentDelivery_Account]] ADDITIONAL_SERVICES_CDN
Content delivery network Addon [[SoftLayer_Container_Product_Order_Network_ContentDelivery_Account_Addon (type)|Network_ContentDelivery_Account_Addon]] ADDITIONAL_SERVICES_CDN_ADDON
Hardware & software firewalls [[SoftLayer_Container_Product_Order_Network_Protection_Firewall (type)|Network_Protection_Firewall]] ADDITIONAL_SERVICES_FIREWALL
Dedicated firewall [[SoftLayer_Container_Product_Order_Network_Protection_Firewall_Dedicated (type)|Network_Protection_Firewall_Dedicated]] ADDITIONAL_SERVICES_FIREWALL
Object storage [[SoftLayer_Container_Product_Order_Network_Storage_Object (type)|Network_Storage_Object]] ADDITIONAL_SERVICES_OBJECT_STORAGE
Object storage (hub) [[SoftLayer_Container_Product_Order_Network_Storage_Hub (type)|Network_Storage_Hub]] ADDITIONAL_SERVICES_OBJECT_STORAGE
Network attached storage [[SoftLayer_Container_Product_Order_Network_Storage_Nas (type)|Network_Storage_Nas]] ADDITIONAL_SERVICES_NETWORK_ATTACHED_STORAGE
Iscsi storage [[SoftLayer_Container_Product_Order_Network_Storage_Iscsi (type)|Network_Storage_Iscsi]] ADDITIONAL_SERVICES_ISCSI_STORAGE
Evault [[SoftLayer_Container_Product_Order_Network_Storage_Backup_Evault_Vault (type)|Network_Storage_Backup_Evault_Vault]] ADDITIONAL_SERVICES
Evault Plugin [[SoftLayer_Container_Product_Order_Network_Storage_Backup_Evault_Plugin (type)|Network_Storage_Backup_Evault_Plugin]] ADDITIONAL_SERVICES
Application delivery appliance [[SoftLayer_Container_Product_Order_Network_Application_Delivery_Controller (type)|Network_Application_Delivery_Controller]] ADDITIONAL_SERVICES_APPLICATION_DELIVERY_APPLIANCE
Network subnet [[SoftLayer_Container_Product_Order_Network_Subnet (type)|Network_Subnet]] ADDITIONAL_SERVICES
Global IPv4 [[SoftLayer_Container_Product_Order_Network_Subnet (type)|Network_Subnet]] ADDITIONAL_SERVICES_GLOBAL_IP_ADDRESSES
Global IPv6 [[SoftLayer_Container_Product_Order_Network_Subnet (type)|Network_Subnet]] ADDITIONAL_SERVICES_GLOBAL_IP_ADDRESSES
Network VLAN [[SoftLayer_Container_Product_Order_Network_Vlan (type)|Network_Vlan]] ADDITIONAL_SERVICES_NETWORK_VLAN
Portable storage [[SoftLayer_Container_Product_Order_Virtual_Disk_Image (type)|Virtual_Disk_Image]] ADDITIONAL_SERVICES_PORTABLE_STORAGE
SSL certificate [[SoftLayer_Container_Product_Order_Security_Certificate (type)|Security_Certificate]] ADDITIONAL_SERVICES_SSL_CERTIFICATE
External authentication [[SoftLayer_Container_Product_Order_User_Customer_External_Binding (type)|User_Customer_External_Binding]] ADDITIONAL_SERVICES
Dedicated Host [[SoftLayer_Container_Product_Order_Virtual_DedicatedHost (type)|Virtual_DedicatedHosts]] DEDICATED_HOST

Server example

This example includes a single bare metal server being ordered with monthly billing.

Warning: the price ids provided below may be outdated or unavailable, so you will need to determine the available prices from the bare metal server [[SoftLayer_Product_Package/getAllObjects|packages]], which have a [[SoftLayer_Product_Package_Type (type)|package type]] of “‘BARE_METAL_CPU”’ or “‘BARE_METAL_CORE”‘. You can get a full list of [[SoftLayer_Product_Package_Type/getAllObjects|package types]] to see other potentially available server packages.

SOAP-ENV:Header ns1:authenticate your username your api key /ns1:authenticate /SOAP-ENV:Header SOAP-ENV:Body ns1:placeOrder example.com server1 138124 142 58 22337 21189 876 57 55 21190 36381 21 22013 906 420 418 342 false /ns1:placeOrder /SOAP-ENV:Body /SOAP-ENV:Envelope

Virtual server example

This example includes 2 identical virtual servers (except for hostname) being ordered for hourly billing. It includes an optional image template id and VLAN data specified on the virtualGuest objects - primaryBackendNetworkComponent and primaryNetworkComponent.

Warning: the price ids provided below may be outdated or unavailable, so you will need to determine the available prices from the virtual server [[SoftLayer_Product_Package/getAllObjects|package]], which has a [[SoftLayer_Product_Package_Type (type)|package type]] of “‘VIRTUAL_SERVER_INSTANCE”‘.

SOAP-ENV:Header ns1:authenticate your username your api key /ns1:authenticate /SOAP-ENV:Header SOAP-ENV:Body ns1:placeOrder 13251 37473 46 2159 55 13754 1641 905 1800 58 21 1645 272 57 418 420 2 true example.com server1 12345 67890 example.com server2 12345 67890 /ns1:placeOrder /SOAP-ENV:Body /SOAP-ENV:Envelope

VLAN example

Warning: the price ids provided below may be outdated or unavailable, so you will need to determine the available prices from the additional services [[SoftLayer_Product_Package/getAllObjects|package]], which has a [[SoftLayer_Product_Package_Type (type)|package type]] of “‘ADDITIONAL_SERVICES”‘. You can get a full list of [[SoftLayer_Product_Package_Type/getAllObjects|package types]] to find other available additional service packages.

SOAP-ENV:Header ns1:authenticate your username your api key /ns1:authenticate /SOAP-ENV:Header SOAP-ENV:Body ns1:placeOrder 154820 0 2021 2018 true /ns1:placeOrder /SOAP-ENV:Body /SOAP-ENV:Envelope

Multiple products example

This example includes a combination of the above examples in a single order. Note that all the configuration options for each individual order container are the same as above, except now we encapsulate each one within the orderContainers property on the base [[SoftLayer_Container_Product_Order (type)|order container]].

Warning: not all products are available to be ordered with other products. For example, since SSL certificates require validation from a 3rd party, the approval process may take days or even weeks, and this would not be acceptable when you need your hourly virtual server right now. To better accommodate customers, we restrict several products to be ordered individually.

SOAP-ENV:Header ns1:authenticate your username your api key /ns1:authenticate /SOAP-ENV:Header SOAP-ENV:Body ns1:placeOrder /ns1:placeOrder /SOAP-ENV:Body /SOAP-ENV:Envelope

Parameters

Name Type Description
orderData SoftLayer_Container_Product_Order Details required to order.
saveAsQuote boolean Set to true if the order data is to be saved as a quote.

Required Headers

  • authenticate

Optional Headers

Return Values

SoftLayer_Container_Product_Order_Receipt

associatedMethods


/reference/services/SoftLayer_Product_Order/placeOrder/