Revision as of 16:31, 27 September 2013

PUT /orders/{orderId}/account/attributes

Set the list of attributes for an account in a given order.

Request

PUT /orders/{orderId}/account/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:

partner_account_id - unique account identifier in the partner system. The value should be unique within the franchise.

attributeValue - string

The value of the attribute max 200 characters. Should adhere to the rules for the attribute specified by the name.

The value of the "partner_account_id" attribute is max 100 characters

Response

Status Code

204 No Content 

The account 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.

409 Conflict 

An attribute value, supposed to be unique, is already in use.

502 Bad Gateway 

A critical (unknown) error occurred.

Response Body

None.

See also

• Orders API
• Common Features