OrderCustomFields_Update

Updates the custom order field values for a specific order. Values are grouped by the custom field module that owns them, usually customfields.

Before you begin#

• The API token needs OrderCustomFields_Update, either assigned directly under Functions or through a group. See Create an API token.
• Requests must be signed if the token requires it. See Make a signed request with HMAC.
• You need the order’s Order_ID and the codes of the custom fields. OrderCustomFieldList_Load lists the fields and their modules.

Example requests#

Update a custom field#

Sets the rep field in the customfields module to Hello World on order 200107.

{
    "Store_Code": "{{Store_Code}}",
    "Miva_Request_Timestamp": "{{$timestamp}}",
    "Function": "OrderCustomFields_Update",
    "Order_ID": 200107,
    "CustomField_Values": {
        "customfields": {
            "rep": "Hello World"
        }
    }
}

Request parameters#

• 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.

Example response#

{
    "success": 1
}

Response parameters#

Error responses#

Related functions#

Try in Postman#

In the Miva: JSON API: Authenticated collection, open Orders > OrderCustomFields_Update. See Set Up Postman.