API Version 2
  • API V2 Overview
  • Category
    • Company
      • Customers
        • Orders
          • Pages
            • Page Templates
              • Products
                • Purchase Orders
                  • SKUs
                    • Support Tickets
                      • Tax Regions
                        • Vendors
                          • Warehouses
                            API Documentation

                            orders

                            Type List
                            List Orders
                            URL http://{domain}/api/v2/orders.json
                            Accepts Filters Yes
                            Output Attributes
                            No


                            List Orders

                            Gets the filtered list of Orders.
                            Filters
                            Filter the Orders into a list. Order Attributes are available as a filter.
                            Parameter Type Rules Example
                            status int 0,1 or 2
                            1
                            display_id int
                            1000
                            alternative_id int
                            999
                            total_max float Maximum total range 1000
                            total_min float Minimum total range 200
                            paid_max float Maximum paid range 1000
                            paid_min float Minimum paid range 200
                            sale_channel int
                            4
                            company int
                            2
                            customer_id int
                            8
                            customer_type int Type of customer
                            4
                            fully_received_start date
                            1431377356
                            fully_received_end date
                            1431377356
                            placed_start date
                            1431377356
                            placed_end date
                            1431377356
                            modify_start date
                            1431377356
                            modify_end date
                            1431377356
                            Pagination
                            Parameters can be added to the CURL call to paginate the List. The maximum limit is 250. By default, this limit is set to 100.
                            Parameter Type Default Example
                            limit int 1 2
                            page int 1 5
                            Status of Orders

                            See Record Status section Order Status for status outputs.


                            Response

                            Example product JSON returned
                            {
                              "code": "200",
                              "data": [
                                {
                                  "id": "11",
                                  "display_id": "4010",
                                  "alternative_id": "",
                                  "total": "16628.00",
                                  "paid": "0.00",
                                  "placed": "1433529999",
                                  "status": "2",
                                  "customer": [
                                    {
                                      "id": "5",
                                      "display_id": "1004",
                                      "first_name": "Bob",
                                      "last_name": "Smith",
                                      "email": "bob232@gmail.com",
                                      "phone": "619-233-3233",
                                      "fax": "619-233-3234"
                                    }
                                  ]
                                },
                                {
                                  "id": "9",
                                  "display_id": "4008",
                                  "alternative_id": "",
                                  "total": "1168.40",
                                  "paid": "0.00",
                                  "placed": "1433523997",
                                  "status": "2",
                                  "customer": [
                                    {
                                      "id": "2",
                                      "display_id": "1001",
                                      "first_name": "Jon",
                                      "last_name": "Smith",
                                      "email": "jon232@gmail.com",
                                      "phone": "858-888-9999",
                                      "fax": "858-777-8888"
                                    }
                                  ]
                                },
                                {
                                  "id": "6",
                                  "display_id": "4005",
                                  "alternative_id": "98",
                                  "total": "1186.30",
                                  "paid": "1186.30",
                                  "placed": "1433287911",
                                  "status": "2",
                                  "customer": [
                                    {
                                      "id": "4",
                                      "display_id": "1003",
                                      "first_name": "Jane",
                                      "last_name": "Doe",
                                      "email": "jane754@gmail.com",
                                      "phone": "619-777-8888",
                                      "fax": "619-888-9999"
                                    }
                                  ]
                                },
                                {
                                  "id": "5",
                                  "display_id": "4004",
                                  "alternative_id": "999",
                                  "total": "1377.52",
                                  "paid": "1377.52",
                                  "placed": "1433286614",
                                  "status": "2",
                                  "customer": [
                                    {
                                      "id": "4",
                                      "display_id": "1003",
                                      "first_name": "Jane",
                                      "last_name": "Doe",
                                      "email": "jane754@gmail.com",
                                      "phone": "619-777-8888",
                                      "fax": "619-888-9999"
                                    }
                                  ]
                                }
                              ]
                            }
                            

                            Start your free, no-risk trial today.