Package com.softlayer.api.service.billing.order

Interface Quote.Service

All Superinterfaces:
Maskable, ResultLimitable, Service
All Known Subinterfaces:
Cart.Service
Enclosing class:
Quote
@ApiService("SoftLayer_Billing_Order_Quote")
public static interface Quote.Service
extends Service
The SoftLayer_Billing_Order_Quote service controls the quoted orders that are created whenever a SoftLayer customer's places a purchase. Quotes exist in several states. The ones of concern are:
*'''PENDING''': Quotes which have not been paid yet. Quotes pending approval from a Softlayer customer.


Once an order is placed from a quote it moves from PENDING to EXPIRED state 2 days after its creation and it is removed from the system after 5 days unless otherwise the SoftLayer customer saved the quote.

Quotes could are created with contact information duplicated from the [[SoftLayer_Account (type)|SoftLayer_Account data type]] or by manual entry. We do this in order to maintain a history of an account's contact information as quotes are generated.

Query the [[SoftLayer_Account]] service to get a list of quotes for your account.
See Also:
SoftLayer_Billing_Order_Quote

  • Method Details

    • asAsync

      Quote.ServiceAsync asAsync()
      Description copied from interface: Service
      Get an async version of this service
      Specified by:
      asAsync in interface Service

    • withNewMask

      Quote.Mask withNewMask()
      Description copied from interface: Maskable
      Overwrite the existing mask on this service with a new one and return it
      Specified by:
      withNewMask in interface Maskable

    • withMask

      Quote.Mask withMask()
      Description copied from interface: Maskable
      Use the existing mask on this service or create it if not present
      Specified by:
      withMask in interface Maskable

    • setMask

      void setMask​(Quote.Mask mask)

    • claim

      @ApiMethod Quote claim​(String quoteKey, Long quoteId)
      This method is used to transfer an anonymous quote to the active user and associated account. An anonymous quote is one that was created by a user without being authenticated. If a quote was created anonymously and then the customer attempts to access that anonymous quote via the API (which requires authentication), the customer will be unable to retrieve the quote due to the security restrictions in place. By providing the ability for a customer to claim a quote, s/he will be able to pull the anonymous quote onto his/her account and successfully view the quote.

      To claim a quote, both the quote id and the quote key (the 32-character random string) must be provided.
      See Also:
      SoftLayer_Billing_Order_Quote::claim

    • deleteQuote

      @ApiMethod(instanceRequired=true) Quote deleteQuote()
      Account master users and sub-users in the SoftLayer customer portal can delete the quote of an order.
      See Also:
      SoftLayer_Billing_Order_Quote::deleteQuote

    • getObject

      @ApiMethod(instanceRequired=true) Quote getObject()
      getObject retrieves the SoftLayer_Billing_Order_Quote object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Billing_Order_Quote service. You can only retrieve quotes that are assigned to your portal user's account.
      See Also:
      SoftLayer_Billing_Order_Quote::getObject

    • getPdf

      @ApiMethod(instanceRequired=true) byte[] getPdf()
      Retrieve a PDF record of a SoftLayer quoted order. SoftLayer keeps PDF records of all quoted orders for customer retrieval from the portal and API. You must have a PDF reader installed in order to view these quoted order files.
      See Also:
      SoftLayer_Billing_Order_Quote::getPdf

    • getQuoteByQuoteKey

      @ApiMethod Quote getQuoteByQuoteKey​(String quoteKey)
      This method will return a [[SoftLayer_Billing_Order_Quote]] that is identified by the quote key specified. If you do not have access to the quote or it does not exist, an exception will be thrown indicating so.
      See Also:
      SoftLayer_Billing_Order_Quote::getQuoteByQuoteKey

    • getRecalculatedOrderContainer

      @ApiMethod(instanceRequired=true) Order getRecalculatedOrderContainer​(Order userOrderData, Boolean orderBeingPlacedFlag)
      Generate an [[SoftLayer_Container_Product_Order|order container]] from the previously-created quote. This will take into account promotions, reseller status, estimated taxes and all other standard order verification processes.
      See Also:
      SoftLayer_Billing_Order_Quote::getRecalculatedOrderContainer

    • placeOrder

      @ApiMethod(instanceRequired=true) Receipt placeOrder​(Order orderData)
      Use this method for placing server orders and additional services orders. The same applies for this as with verifyOrder. Send in the SoftLayer_Container_Product_Order_Hardware_Server for server orders. In addition to verifying the order, placeOrder() also makes an initial authorization on the SoftLayer_Account tied to this order, if a credit card is on file. If the account tied to this order is a paypal customer, an URL will also be returned to the customer. After placing the order, you must go to this URL to finish the authorization process. This tells paypal that you indeed want to place the order. After going to this URL, it will direct you back to a SoftLayer webpage that tells us you have finished the process. After this, it will go to sales for final approval.
      See Also:
      SoftLayer_Billing_Order_Quote::placeOrder

    • placeQuote

      @ApiMethod(instanceRequired=true) Order placeQuote​(Order orderData)
      Use this method for placing server quotes and additional services quotes. The same applies for this as with verifyOrder. Send in the SoftLayer_Container_Product_Order_Hardware_Server for server quotes. In addition to verifying the quote, placeQuote() also makes an initial authorization on the SoftLayer_Account tied to this order, if a credit card is on file. If the account tied to this order is a paypal customer, an URL will also be returned to the customer. After placing the order, you must go to this URL to finish the authorization process. This tells paypal that you indeed want to place the order. After going to this URL, it will direct you back to a SoftLayer webpage that tells us you have finished the process.
      See Also:
      SoftLayer_Billing_Order_Quote::placeQuote

    • saveQuote

      @ApiMethod(instanceRequired=true) Quote saveQuote()
      Account master users and sub-users in the SoftLayer customer portal can save the quote of an order to avoid its deletion after 5 days or its expiration after 2 days.
      See Also:
      SoftLayer_Billing_Order_Quote::saveQuote

    • verifyOrder

      @ApiMethod(instanceRequired=true) Order verifyOrder​(Order orderData)
      Use this method for placing server orders and additional services orders. The same applies for this as with verifyOrder. Send in the SoftLayer_Container_Product_Order_Hardware_Server for server orders. In addition to verifying the order, placeOrder() also makes an initial authorization on the SoftLayer_Account tied to this order, if a credit card is on file. If the account tied to this order is a paypal customer, an URL will also be returned to the customer. After placing the order, you must go to this URL to finish the authorization process. This tells paypal that you indeed want to place the order. After going to this URL, it will direct you back to a SoftLayer webpage that tells us you have finished the process. After this, it will go to sales for final approval.
      See Also:
      SoftLayer_Billing_Order_Quote::verifyOrder

    • withdrawGdprAcceptance

      @ApiMethod(instanceRequired=true) Void withdrawGdprAcceptance()
      Withdraws the users acceptance of the GDPR terms.
      See Also:
      SoftLayer_Billing_Order_Quote::withdrawGdprAcceptance

    • getAccount

      @ApiMethod(instanceRequired=true) Account getAccount()
      A quote's corresponding account.
      See Also:
      SoftLayer_Billing_Order_Quote::getAccount

    • getDoNotContactFlag

      @ApiMethod(instanceRequired=true) Boolean getDoNotContactFlag()
      Indicates whether the owner of the quote chosen to no longer be contacted.
      See Also:
      SoftLayer_Billing_Order_Quote::getDoNotContactFlag

    • getOrder

      @ApiMethod(instanceRequired=true) Order getOrder()
      This order contains the records for which products were selected for this quote.
      See Also:
      SoftLayer_Billing_Order_Quote::getOrder

    • getOrdersFromQuote

      @ApiMethod(instanceRequired=true) List<Order> getOrdersFromQuote()
      These are all the orders that were created from this quote.
      See Also:
      SoftLayer_Billing_Order_Quote::getOrdersFromQuote