This function allows you to update the custom order field values for a specific order.
Description#
This function allows you to update the custom order field values for a specific order.
Request Body Parameters#
| Parameter | Type | Description |
|---|---|---|
Order_ID |
Number | Order number to update |
CustomField_Values |
Object | Object containing individual custom field data. Each child object will be the module code (e.g., customfields, productimagecustomfields) |
customfields: Module Code - Module Code of the custom field module to update. Typically will be “customfields” but other modules support the custom fields feature.field_code1: String - This is the custom field code to update. Its value is the custom field value to update.
Response Parameters#
| Name | Description |
|---|---|
success |
Boolean value for if the request was successful |
processed |
Boolean value if function was processed |
Example Request#
{
"Store_Code": "{{Store_Code}}",
"Miva_Request_Timestamp": "{{$timestamp}}",
"Function": "OrderCustomFields_Update",
"Order_ID": 200107,
"CustomField_Values": {
"customfields": {
"rep": "Hello World"
}
}
}
Example Response#
{
"success": 1
}
Error Responses#
| Error Code | Error Message | Error Description |
|---|---|---|
| MER-JSN-ORD-00025 | Order not found | Order number not found. |
| MER-JSN-00018 | Invalid value for field ‘CustomField_Values:customfields:reps’ | Failed to load custom field ‘reps’. |