Orders-orderId-discounts:GET - Revision history

Mike.robski: 1 revision: Release 98

2014-09-15T13:51:33Z

1 revision: Release 98

Pa.dinh: /* Status Code */

2014-09-10T15:50:03Z

Status Code

Mike.robski: 1 revision: Release 85

2013-09-27T21:31:47Z

1 revision: Release 85

Mike.robski at 17:50, 20 May 2013

2013-05-20T17:50:08Z

New page

= GET /orders/{orderId}/discounts =
Get discounts that were added at the Order level. Discounts that are applied to an entire order will be applied to all of the product and services within the order.
__TOC__

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

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

=== URI Parameters ===
None.

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

== Response ==

=== Status Code ===
;200 OK
: The request was executed successfully.

;401 Unauthorized
: The request was not properly authorized.

;403 Forbidden
: The client does not have sufficient privileges.

;404 Not Found
: Returned if the order could not be found.

=== Response Body ===
<nowiki>
{
"discounts": [
{
"priceName": "recurring",
"recurrences": -1,
"type": "amount",
"value": "1.00"
}
],
"links": [
{
"href": "</nowiki>{{APIBaseURL}}<nowiki>/orders/{orderId}/account/user/",
"rel": "self"
}
]
}
</nowiki>

==== Parameters ====
; discounts - ''list''
: A list of discounts. Each discount contains the following:

:; priceName - ''string''
:: The type of price to which the discount will be applied.

:; recurrences - ''integer''
:: The number of times that the discount will be applied. A value of "-1" means the discount will be applied every time the fee is charged.

:; type - ''string''
:: Specifies the discount type which determines the method used to calculate the amount that is discounted. Possible values are:
::: '''amount''': Discount will be treated as an exact amount.

:; value - ''string''
:: The discount amount. The value will be interpreted based on the specified discount type.

; 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 request was executed successfully.
+|-
+! Status Code
-;401 Unauthorized
+! Error Message
-: The request was not properly authorized.
+! Description
+|-
-;403 Forbidden
+| 200 OK
-: The client does not have sufficient privileges.
+| align="center" | -
+| The request was executed successfully.
-;404 Not Found
+|-
-: Returned if the order could not be found.
+| 401 Unauthorized
 === Response Body ===
@@ Line 69: / Line 83: @@
 ; links - ''list''
 : [[Hypermedia]] for this resource. Links to self.
 == See also ==