Orders-orderId-quote:GET - Revision history

Corinne.chui: 1 revision

2016-05-30T19:36:48Z

1 revision

Viktor.penkov: /* Get Quote with child products */

2015-11-13T13:37:15Z

Get Quote with child products

Show changes

Mike.robski: 1 revision: Release 98

2014-09-15T13:51:32Z

1 revision: Release 98

Pa.dinh at 10:00, 15 September 2014

2014-09-15T10:00:20Z

Mike.robski: 1 revision: Release 90

2014-01-31T18:01:55Z

1 revision: Release 90

Dragomir.penev at 18:00, 14 November 2013

2013-11-14T18:00:00Z

Mike.robski: 1 revision

2013-02-17T06:58:59Z

1 revision

Mike.robski at 23:05, 15 February 2013

2013-02-15T23:05:30Z

New page

= GET /orders/''{orderId}''/quote =
Get quote for a given order.
__TOC__

== Request ==
<code>GET /orders/''{orderId}''/quote</code>

==== Request Parameters ====
{{UriParameter-OrderId}}

=== URI Parameters ===
None.

=== Request Headers ===
{{Cookie-OwnerId}}

== Response ==

=== Status Code ===
;200 OK
: The operation was successfully completed.

;404 Not Found
: The order does not exist.

=== Response Body ===
<nowiki>
{
"quote": {
"Hash": "42fc1e100808efc62dadf8ad027d424dff30d6f1",
"Currency": "USD",
"Products": [
{
"Services": [],
"PlanNumber": "00000139b5dd73be7f14d3f8000a88fa0fa65d70",
"Fees": [
{
"ProrationAllowed": "0",
"StartDate": "2012-09-11",
"NumCharged": "0",
"EndDate": "2012-09-11",
"Description": "Setup fee ",
"BaseAmount": "100.00",
"UnitAmount": "100.00",
"Prorated": "0",
"MonthlyCycle": "1",
"Currency": "USD",
"Amount": "100.00",
"NumCharges": "1",
"ProratedUnitAmount": "100.00",
"Type": "setup_fee",
"Quantity": "1"
},
{
"ProrationAllowed": "1",
"StartDate": "2012-09-11",
"NumCharged": "0",
"EndDate": "2012-10-10",
"Description": "Recurring fee",
"BaseAmount": "239.00",
"UnitAmount": "239.00",
"Prorated": "0",
"MonthlyCycle": "1",
"Currency": "USD",
"Amount": "239.00",
"NumCharges": "-1",
"ProratedUnitAmount": "239.00",
"Type": "recurring",
"Quantity": "1"
}
]
}
],
"Total": "339.00",
"SubTotal": "339.00",
"OneTimeFeeAmount": "100.00",
"TaxTotal": "0"
},
"links": [
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/orders/{orderId}/quote/", "rel": "self"}
]
}
</nowiki>

==== Parameters ====
; quote - ''dictionary''
: Quote's ordered items info

:; Hash - ''string''
:: Hash string of this particular order.

:; Currency - ''string''
:: The currency for this particular order. Must be a ISO-4217 currency code. ex. USD, CAD, etc.

:; Products - ''list''
:: List of plan products

::; Services - ''list''
::: List of product services

::; PlanNumber - ''string''
::: Plan number identifier

::; Fees - ''list''
::: List of product fees

:::; ProrationAllowed - ''integer''
:::: Number indicating whether fee proration is allowed

:::; StartDate - ''date''
:::: Start date of the fee

:::; NumCharged - ''integer''
:::: Number how many times this fee is charged

:::; EndDate - ''date''
:::: End date the fee is applied

:::; Description - ''string''
:::: Description info for this fee

:::; BaseAmount - ''decimal''
:::: Base amount for this fee

:::; UnitAmount - ''decimal''
:::: Unit amount for this fee

:::; Prorated - ''integer''
:::: Integer indicating whether this fee is prorated

:::; MonthlyCycle - ''integer''
:::: Billing cycle in months for this fee

:::; Currency - ''string''
:::: The currency for this particular fee. Must be a ISO-4217 currency code. ex. USD, CAD, etc.

:::; Amount - ''decimal''
:::: The actual fee amount

:::; NumCharges - ''integer''
:::: Number of charges for this fee

:::; ProratedUnitAmount - ''decimal''
:::: The prorated unit amount

:::; Type - ''string''
:::: The type of this fee

:::; Quantity - ''integer''
:::: The quantity for this fee

:; Total - ''decimal''
:: Total sum for this quote

:; SubTotal - ''decimal''
:: Subtotal sum for this quote

:; OneTimeFeeAmount - ''decimal''
:: One time payable fee amount

:; TaxTotal - ''decimal''
:: Tax total value

; links - ''list''
: [[Hypermedia]] for this resource. Links to self.

== See also ==
* [[Orders|Orders API]]
* [[Common Features]]

{{disqus}}
[[Category:Hostway API]]
[[Category:Ordering API]]

@@ Line 16: / Line 16: @@
 == Response ==
 === Status Code ===
-;200 OK
+{| class='wikitable'
-: The operation was successfully completed.
+|-
+! Status Code
-;404 Not Found
+! Error Message
-: The order does not exist.
+! Description
 === Response Body ===
@@ Line 173: / Line 193: @@
 ; links - ''list''
 : [[Hypermedia]] for this resource. Links to self.
 == See also ==

@@ Line 34: / Line 34: @@
      "Services": [],
      "PlanNumber": "00000139b5dd73be7f14d3f8000a88fa0fa65d70",
      "Fees": [
+      {
@@ Line 67: / Line 69: @@
        "ProratedUnitAmount": "239.00",
        "Type": "recurring",
-       "Quantity": "1"
+       "Quantity": "1",
+      }
+     ]
@@ Line 101: / Line 103: @@
 ::; PlanNumber - ''string''
 ::: Plan number identifier
 ::; Fees - ''list''