OrderCustomFieldList_Load

---

Description

This function allows you to load a list of all custom order fields and the module being used (orderworkflow, customfields, etc).

Request Body Parameters

This function has no input parameters.

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

Example Request

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

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 Merchant",
                "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 Merchant",
                "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 Merchant",
                "api_ver": "9.12",
                "version": "9.1200",
                "module": "modules/util/orderworkflow.mvc",
                "refcount": 1,
                "active": true
            }
        }
    ]
}