Orders-orderId-discounts:PUT - Revision history

Mike.robski: 1 revision: Release 99

2014-10-14T15:07:00Z

1 revision: Release 99

Pa.dinh at 09:46, 1 October 2014

2014-10-01T09:46:55Z

Mike.robski: 1 revision: Release 98

2014-09-15T13:51:33Z

1 revision: Release 98

Pa.dinh: /* Status Code */

2014-09-10T15:49:02Z

Status Code

Show changes

Mike.robski: 1 revision: Release 85

2013-09-27T21:31:47Z

1 revision: Release 85

Stanimir.dimitrov: /* Parameters */

2013-09-26T12:06:12Z

Parameters

New page

= PUT /orders/''{orderId}''/discounts =
Set discounts for the entire Order. Discounts that are applied to an entire order will be applied to all of the product and services within the order.
'''Note: This will replace any existing discounts that were configured at the order level.'''
__TOC__

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

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

=== URI Parameters ===
None.

=== Request Headers ===
; Content-Type
: Required. Set this header to <code>application/json; charset=UTF-8</code>

{{Cookie-OwnerId}}

=== Request Body ===
<nowiki>
{
"discounts": [
{
"priceName": "recurring",
"recurrences": -1,
"type": "amount",
"value": "1.00"
}
]
}
</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.
:: Validation: Should match the fee types configured in the back-end.
:: Note: Only "recurring" is currently supported

:; 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.
:: Validation: Should be either a positive integer or -1.
:: Note: Value must be -1 if the priceName is "recurring".

:; 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
::: '''percent''': Discount will be treated as a percentage
:: Validation: Should be set to either '''amount''' or '''percent'''.

:; value - ''string''
:: The discount amount. The value will be interpreted based on the specified discount type.
:: Validation: Should be a positive number.

== Response ==

=== Status Code ===
;200 OK
: The discount was successfully set.

;400 BadRequest
: The request body contains invalid parameters

;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.

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

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

@@ Line 80: / Line 80: @@
 | Price type should be '''reccuring'''.
 |-
-| Code: invalid_discount_amount, {value} discount amount is invalid
+| {value} discount amount is invalid
 | Discount amount should be a positive number.
 |-
-| Code: unsupported_discount_type, {type} discount type is unsupported
+| {type} discount type is unsupported
 | Type should be set to either '''amount''' or '''percent'''.
 |-
@@ Line 150: / Line 150: @@
    "computeFault": {
      "guid": "c3563e61-a297-4dbe-b072-24aace7b5e44",
-     "message": "<class 'order_builder.bl.validation.ValidationError.ValidationError'>: Code: invalid_discount_amount, -5.00 discount amount is invalid",
+     "message": "-5.00 discount amount is invalid",
      "code": 400,
      "details": ""
@@ Line 181: / Line 181: @@
    "computeFault": {
      "guid": "1a94f744-5b33-4d54-ab28-77b875934829",
-     "message": "<class 'order_builder.bl.validation.ValidationError.ValidationError'>: Code: unsupported_discount_type, amounts discount type is unsupported",
+     "message": "amounts discount type is unsupported",
      "code": 400,
      "details": ""