Order endpoint

This topic provides a quick reference for the method signatures of order API methods.

Location: http://smile.example.com:port/stage/smile/ws/v2/order

WSDL: http://smile.example.com:port/stage/smile/ws/v2/order?wsdl

Table 1. Order API methods
Method	Method signature	Purpose
approveOrder()	`void approveOrder( string orderNumber)`	Approves an order and progresses it to the next stage in the order process.
addOrderToGroup()	`OrderGroup addOrderToGroup( string orderGroupId, Order order)`	Adds the order specified to the order group.
cancelOrder()	`void cancelOrder( string orderNumber)`	Cancels the given order and removes it from the group.
cancelOrderGroup()	`void cancelOrderGroup( string orderGroupNumber)`	Cancels all orders in an order group.
createOrderGroup()	`OrderGroup createOrderGroup( Order initialOrder)`	Creates a new order group with the initial order provided.
echo()	`string echo(string value)`	Returns any value passed to the method.
getAvailableOrderForms()	`OrderFormList getAvailableOrderForms()`	Returns order form information for each package an application is authorised to order.
getOrder()	`OrderDetails getOrder( string orderNumber)`	Searches by order number for an order and returns order information.
getOrderForm()	`OrderForm getOrderForm( int packageId)`	Returns order form information for a specific package.
getOrderGroup()	`OrderGroup getOrderGroup( string orderGroupId)`	Returns the order group.
getOrderGroupQuote()	`ItemisedTransactionDetail getOrderGroupQuote( string orderGroupId)`	Retuers the quote of the given order group.
orderAccount()	`OrderDetails orderAccount( Order order)`	Orders a package that contains an account and may contain one or more subscriptions.
orderSubscription()	`OrderDetails orderSubscription( string usn, Order order)`	Orders a package that contains only subscriptions.
placeOrderGroup()	`OrderPlacementResponse placeOrderGroup( string orderGroupId, PaymentRequest paymentDetails)`	Submits all the orders in the order group, and may pay the initial invoice.
reserveUsns()	`UsnList reserveUsns( int sid, int count)`	Reserves subscription USNs that can be used for ordering later.
updateOrder()	`void updateOrder( string orderNumber, Order order)`	Updates order information.