OrderFilterStruct.list

Field Type Description
acquire_method [String] Optional. Array of acquire methods. e.g. takeout, delivery or latch
acquire_on String Optional. String enumarion of 'one_year_ago', 'this_year', 'last_month', 'this_month', 'yesterday', 'today', 'tomorrow', 'later'
created_on String Optional. String enumarion of 'one_year_ago', 'this_year', 'last_month', 'this_month', 'yesterday', 'today', 'tomorrow', 'later'
status [String] Optional. Array of statuses. e.g. unread, read, approved, preparing, ready, other
shops [Int] Optional. Array of shop ids
search String Optional. A String value
flags [String] Optional. Array of flags. e.g. has_invoice, has_warranty, has_comments
page Int Optional. An integer value
limit Int Optional. An integer value
sort_by String Optional. String enumarion of 'order_nr', 'name', 'acquire_time'

Examples

Example 1 

{
    "acquire_method": [
        "takeout",
        "delivery",
        "latch"
    ],
    "acquire_on": "one_year_ago",
    "created_on": "one_year_ago",
    "status": [
        "all",
        "unread",
        "read",
        "approved",
        "preparing",
        "ready",
        "other"
    ],
    "shops": [
        11,
        17,
        14
    ],
    "search": "...",
    "flags": [
        "has_invoice",
        "has_warranty",
        "has_comments"
    ],
    "page": 16,
    "limit": 17,
    "sort_by": "order_nr"
}
1.9.0 stable