Latest revision as of 10:52, 20 August 2015

[edit] Ordering API

The ordering API supports the operations of creating, building and placing orders. The orders are the main method of creating new accounts and adding and managing the products for an account.

download this selection of articles as a PDF book

[edit] Orders

Order management resources.

• POST /orders - Creates a new order
• GET /orders/{orderId} - Returns order details
• DELETE /orders/{orderId} - Deletes an order
• POST /orders/{orderId}/action - Performs an action on an order

[edit] Order Shorthand

An URL shortcut allowing the user to access the currently open order without specifying the order ID.

• Order Shorthand

[edit] Order Attributes

Custom attributes for an Order.

• PUT /orders/{orderId}/attributes - Sets order attributes
• GET /orders/{orderId}/attributes - Returns order attributes

[edit] Account

Customer information in a given order. Only one account is allowed per order.

• PUT /orders/{orderId}/account - Add account to the order
• GET /orders/{orderId}/account - Returns the account details

[edit] Account Attributes

Custom attributes for an Account in a given Order.

• PUT /orders/{orderId}/account/attributes - Sets account attributes
• GET /orders/{orderId}/account/attributes - Returns account attributes
• DELETE /orders/{orderId}/account/attributes - Deletes all account attributes

[edit] Account Contact Info

Various types of Contact Info set for an Account in a given Order.

• PUT /orders/{orderId}/account/contactInfo/{contactType} - Set contact details
• GET /orders/{orderId}/account/contactInfo{contactType} - Returns contact details
• GET /orders/{orderId}/account/contactInfo - Returns all account contacts
• DELETE /orders/{orderId}/account/contactInfo/{contactType} - Deletes specific contact

[edit] Account Payment Information

Payment method information for an Account in a given Order. An account cannot have multiple payment methods.

• PUT /orders/{orderId}/account/paymentInfo - Sets the payment method for an account
• GET /orders/{orderId}/account/paymentInfo - Returns the payment method for an account

[edit] Account User

User information for an Account in a given Order.

• PUT /orders/{orderId}/account/user - Sets the account user credentials
• GET /orders/{orderId}/account/user - Returns information about account user credentials

[edit] Products

Products included in the order.

• POST /orders/{orderId}/account/products - Adds product to the account
• GET /orders/{orderId}/account/products - Gets all products
• GET /orders/{orderId}/account/products/{productId} - Gets the product details
• PUT /orders/{orderId}/account/products/{productId} - Updates product details
• DELETE /orders/{orderId}/account/products/{productId} - Removes product from the order

[edit] Services

Services included in the products.

• POST /orders/{orderId}/account/products/{productId}/services - Adds service to a product
• GET /orders/{orderId}/account/products/{productId}/services - Gets all services for a product
• GET /orders/{orderId}/account/products/{productId}/services/{serviceId} - Gets service details
• PUT /orders/{orderId}/account/products/{productId}/services/{serviceId} - Updates service details
• DELETE /orders/{orderId}/account/products/{productId}/services/{serviceId} - Removes service from a product

[edit] Service Attributes

Attributed for the included services.

• PUT /orders/{orderId}/account/products/{productId}/services/{serviceId}/attributes - Adds service attributes
• GET /orders/{orderId}/account/products/{productId}/services/{serviceId}/attributes - Gets service attributes
• OPTIONS /orders/{orderId}/account/products/{productId}/services/{serviceId}/attributes - Returns information about supported attributes
• Service Attributes Structure - Structure of attributes set supported by Hostway API

[edit] Service Notes

Notes for services.

• POST /orders/{orderId}/account/products/{productId}/services/{serviceId}/notes - Adds a service note
• PUT /orders/{orderId}/account/products/{productId}/services/{serviceId}/notes - Updates the service notes
• GET /orders/{orderId}/account/products/{productId}/services/{serviceId}/notes - Gets all the service notes
• DELETE /orders/{orderId}/account/products/{productId}/services/{serviceId}/notes - Deletes the service notes
• OPTIONS /orders/{orderId}/account/products/{productId}/services/{serviceId}/notes - Returns information about supported attributes

[edit] Promotion Codes

Describes handling of promotion codes.

[edit] Product Promotion Codes

• PUT /orders/{orderId}/account/products/{productId}/promotion - Add or update promotion code for a product.
• DELETE /orders/{orderId}/account/products/{productId}/promotion - Removes the promotion code for a product.

[edit] Service Promotion Codes

• PUT /orders/{orderId}/account/products/{productId}/services/{serviceId}/promotion - Add or update promotion code for a service.
• DELETE /orders/{orderId}/account/products/{productId}/services/{serviceId}/promotion - Removes the promotion code for a service.

[edit] Custom Discounts

Custom discounts at the order, product and service levels. Managing discounts requires elevated permissions.

[edit] Order Discounts

• PUT /orders/{orderId}/discounts - Adds order discounts
• GET /orders/{orderId}/discounts - Returns all order discounts
• DELETE /orders/{orderId}/discounts - Removes all order discounts

[edit] Product Discounts

• PUT /orders/{orderId}/account/products/{productId}/discounts - Adds product discounts
• GET /orders/{orderId}/account/products/{productId}/discounts - Returns all product discounts
• DELETE /orders/{orderId}/account/products/{productId}/discounts - Removes all product discounts

[edit] Service Discounts

• PUT /orders/{orderId}/account/products/{productId}/services/{serviceId}/discounts - Adds service discounts
• GET /orders/{orderId}/account/products/{productId}/services/{serviceId}/discounts - Returns all service discounts
• DELETE /orders/{orderId}/account/products/{productId}/services/{serviceId}/discounts - Removes all service discounts

[edit] Order Quote

Quote information for a given order.

• GET /orders/{orderId}/quote - Returns quote for the products and services in the order

[edit] See also

• Common Features

[edit] Order Flow Examples

[edit] Order Account Associations

• Order Products Account - Example order flow with adding initially products and than account
• Order Products Account Modify - Example order flow with adding initially products than account and modify it later

[edit] Email Products

• Order Email Domain - Example order flow for purchasing an email domain
• Order Domain Alias - Example order flow for purchasing an email domain alias

[edit] Microsoft Exchange Products

• Order Exchange domain - Example order flow for purchasing exchange domain
• Order Free Exchange Mailbox
• Order Paid Exchange Mailbox
• Ordering Other Exchange Products - Example order flow that applies to Exchange email encryption, archiving, mailing list and blackberry products

[edit] Cloud Products

• Order Cloud Drive - Example order flow for purchasing a Cloud Drive
• Order Cloud Backup - Example order flow for purchasing a Cloud Backup

[edit] WebsPlanet Products

• WebsPlanet - Example order flow for purchasing a WebsPlanet

[edit] VPS Virtuozzo Products

• VpsVirtuozzo - Example order flow for purchasing VPS Virtuozzo products and services

[edit] Domain Registration Products

• Order Domain - Example order flow for purchasing a domain
• Order Domain Shortcut - Example order flow for purchasing a domain by using the domain shortcut