Orders-orderId-attributes:PUT
From Hostway API Documentation
Revision as of 12:01, 31 January 2014 by Mike.robski (Talk | contribs)
PUT /orders/{orderId}/attributes
Set the list of attributes for an order.
Contents |
Request
PUT /orders/{orderId}/attributes
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
[
{
"name": "{attributeName}",
"value": "{attributeValue}"
},
{
"name": "{attributeName}",
"value": "{attributeValue}"
}
]
Parameters
- attributeName - string
- The unique name of the attribute. The list of supported attribute names is specific to the franchise. The common attributes include:
- AffiliateId - identifies an affiliate.
- attributeValue - string
- The value of the attribute max 200 characters. Should adhere to the rules for the attribute specified by the name.
Response
Status Code
- 204 No Content
- The order attributes were successfully set.
- 400 Bad Request
- The request body format is invalid, the attribute name is not supported by the franchise, the attribute value is invalid (e.g: too long, contains invalid characters, etc).
- 404 Not Found
- The specified order does not exist.
- 502 Bad Gateway
- A critical (unknown) error occurred.
Response Body
None.
See also
