Orders-orderId-account:PUT
From Hostway API Documentation
Revision as of 18:00, 15 February 2013 by Mike.robski (Talk | contribs)
PUT /orders/{orderId}/account
Assign an Account to an Order.
Contents |
Request
PUT /orders/{orderId}/account
Request Parameters
- orderId - string
- The unique order Id. The URI of the order is returned by the POST /orders call.
URI Parameters
None.
Request Headers
- Content-Type
- Required. Set this header to
application/json; charset=UTF-8
- Cookie
- A cookie named OwnerId to identify the client (for most browser clients, the browser will do this automatically, depending on the browser configuration). The value of the cookie would come from the response to the create order request in the Set-Cookie response header.
Request Body
Request Body for adding a new Account to the Order
{
"currency": "{currency}",
"language": "{language}"
}
Request Body for adding an existing Account to the Order
{
"accountNumber": "{accountNumber}"
}
Request Parameters
- currency - string
- An ISO-4217[1] currency code assigned to the account.
- language - string
- An IETF[2] language tag (ex. en, en-CA, en-US, etc.) specifying account's language.
- accountNumber - string
- The unique account number for an existing account.
Response
Status Code
- 200 OK
- The account was successfully set.
- 204 No Content
- The account was successfully set.
- 400 Bad Request
- The request body format is invalid or the language or currency is not supported by the franchise.
- 409 Conflict
- Attempt to set currency that is different from currencies of the products or that of the existing account.
Response Body
None.
See also
