Created by potrace 1.16, written by Peter Selinger 2001-2019

Miva Developer Docs

OrderCustomFieldList_Load

Previous Next

Retrieves every custom order field and the module that provides it (orderworkflow, customfields, etc).

Retrieves every custom order field and the module that provides it (orderworkflow, customfields, etc). Use it to find field codes before you read or update custom field values on an order.

Before you begin#

Example requests#

List custom order fields#

Returns every custom order field in the store.

{
    "Store_Code": "{{Store_Code}}",
    "Miva_Request_Timestamp": "{{$timestamp}}",
    "Function": "OrderCustomFieldList_Load"
}

Request parameters#

This function has no input parameters.

Example response#

{
    "success": 1,
    "data": [
        {
            "code": "ip_address",
            "name": "IP Adddress",
            "type": "text",
            "searchable": true,
            "sortable": true,
            "module": {
                "id": 88,
                "code": "customfields",
                "name": "Custom Fields",
                "provider": "Miva",
                "api_ver": "9.08",
                "version": "9.1200",
                "module": "modules/util/customfld.mvc",
                "refcount": 1,
                "active": true
            }
        },
        {
            "code": "new_and_Updated",
            "name": "New & Updated Orders",
            "type": "checkbox",
            "searchable": true,
            "sortable": true,
            "module": {
                "id": 234,
                "code": "orderworkflow",
                "name": "Order Workflow",
                "provider": "Miva",
                "api_ver": "9.12",
                "version": "9.1200",
                "module": "modules/util/orderworkflow.mvc",
                "refcount": 1,
                "active": true
            }
        },
        {
            "code": "successfully_retrieved_orders",
            "name": "Successfully Retrieved Orders",
            "type": "checkbox",
            "searchable": true,
            "sortable": true,
            "module": {
                "id": 234,
                "code": "orderworkflow",
                "name": "Order Workflow",
                "provider": "Miva",
                "api_ver": "9.12",
                "version": "9.1200",
                "module": "modules/util/orderworkflow.mvc",
                "refcount": 1,
                "active": true
            }
        }
    ]
}

Response parameters#

Parameter Type Description
code String custom order field code
name String Custom Order Field Name
type String Custom Order Field Type
searchable Boolean Whether Custom field is searchable
sortable Boolean Sortable Flag
module Object Module

module object#

Parameter Type Description
id Number Module Id
code String Module Code
name String Module Name
provider String Module Developer
api_ver String Module API Version
version String Module Version
module String Module Path
refcount Number Reference Count
active Boolean Active
Function Use it to
OrderCustomFields_Update Update an order’s custom field values
OrderList_Load_Query Read custom field values with the CustomField_Values on-demand column
QueueOrderList_Load_Query Pull orders from a queue

Try in Postman#

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

OrderCoupon_Update_Assigned OrderCustomFields_Update