Management API
Order
List Orders
5min
show all orders the requesting manager has access permissions to url /api/v1/orders/ method get query parameters ordering order by which attribute to order the list by default ordering is ascending, can be made descending by prefixing the attribute name with example order by=created at example order by= created at pagination default pagination is 20 results per page limit number of results to return per page example limit=20 offset the initial index from which to return the results example offset=21 filtering the results can be filtered by various attributes on order or related to the order if available, additional suffixes can be appended to attributes which further define the filter startswith string value is a starting substring of the attribute icontains string value is a substring of the attribute (case insensitive) possible filters store id icontains customer email customer email startswith customer email icontains company customer id customer email customer company name customer company name icontains customer reference icontains customer name icontains customer label in customer account customer account name customer account name icontains customer account code customer account code icontains customer account description customer account description icontains customer account phone customer account phone icontains customer account address customer account address icontains customer account email customer account email icontains customer account reference customer account reference icontains customer account not metadata success response code 200 ok content examples { "count" 5, "next" null, "previous" null, "results" \[ { "id" 1593781720493279, "customer" { "id" 620, "total orders" 14, "total licenses" 45, "labels" \[ { "id" 3, "label id" 8, "label" "customer", "color" "#ff9f43" }, { "id" 53, "label id" 34, "label" "loyal", "color" "#3a0cd4" } ], "email" "tc\@tc com", "first name" "", "last name" "", "company name" "", "phone" "", "reference" "", "address" "", "postcode" "", "city" "", "country" "", "state" "", "clabels all" "customerloyal", "cognito user pool id" "", "metadata" {}, "company" 277, "license user" null, "clabels" \[ 8, 34 ] }, "customer account" null, "has active licenses" false, "created at" "2020 07 03t13 08 40z", "updated at" "2020 07 03t13 08 40z", "store id" "d2d2dce02c844d4492c9d48758aa143a", "type" "normal", "customer email" null, "is test" false, "customer reference" null, "is trial" false, "download id" null, "language" null, "campaign params" null, "customer first name" null, "customer last name" null, "customer company" null, "customer phone" null, "metadata" {}, "company" 277 }, ] }