Documentation for PUT api/order/Order/{orderID}/OrderDetail/MiscField

PUT api/order/Order/{orderID}/OrderDetail/MiscField

Update misc field values for the order lines of a given order. Only input misc fields to update. All fields are not required.

Request Information

URI Parameters

Name	Description	Type	Additional information
orderID	Order # of the order to update.	integer	Required

Body Parameters

Payload

Collection of OrderDetailMiscFieldsViewModel

Name	Description	Type	Additional information
OrderDetailID	Identifier of the order line.	integer	None.
MiscFields	For any customizations, this holds the extra fields associated to customizations.	Dictionary of string [key] and Object [value]	None.

Request Formats

application/xml, text/xml

Sample:

<ListOfOrderDetailMiscFieldsViewModel>
  <OrderDetailMiscFieldsViewModel>
    <OrderDetailID>1</OrderDetailID>
    <MiscFields>
      <KeyValuePairOfStringObject>
        <Key>sample string 1</Key>
        <Value />
      </KeyValuePairOfStringObject>
      <KeyValuePairOfStringObject>
        <Key>sample string 3</Key>
        <Value />
      </KeyValuePairOfStringObject>
    </MiscFields>
  </OrderDetailMiscFieldsViewModel>
  <OrderDetailMiscFieldsViewModel>
    <OrderDetailID>1</OrderDetailID>
    <MiscFields>
      <KeyValuePairOfStringObject>
        <Key>sample string 1</Key>
        <Value />
      </KeyValuePairOfStringObject>
      <KeyValuePairOfStringObject>
        <Key>sample string 3</Key>
        <Value />
      </KeyValuePairOfStringObject>
    </MiscFields>
  </OrderDetailMiscFieldsViewModel>
</ListOfOrderDetailMiscFieldsViewModel>

application/json, text/json

Sample:

[
  {
    "OrderDetailID": 1,
    "MiscFields": {
      "sample string 1": {},
      "sample string 3": {}
    }
  },
  {
    "OrderDetailID": 1,
    "MiscFields": {
      "sample string 1": {},
      "sample string 3": {}
    }
  }
]

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'FormUrlEncodedFormatter' to write type 'IEnumerable`1'.

Response Information

Resource Description

ApiResultOfIDictionaryOfStringAndObject

Name	Type	Additional information
Result	Dictionary of string [key] and Object [value]	None.
IsSuccessful	boolean	None.
MessageTranslationKey	string	None.
Message	string	None.
Messages	Collection of ApiResultMessage	None.

Response Formats

application/xml, text/xml, application/json, text/json

Sample:

Sample not available.