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/info

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


                            Orders Info Data

                            Gets Orders info.
                            Filters
                            Filter the Orders into a list.
                            Parameter Type Rules Example
                            id int / array one id or multiple Lead Commerce order ids
                            1 or array(3,8,9,45)
                            Status of Orders

                            See Record Status section Order Status for status outputs.


                            Response

                            Example JSON returned
                            {
                              "code": "200",
                              "data": {
                                "2": [
                                  {
                                    "id": "2",
                                    "display_id": "10001",
                                    "alternative_id": "",
                                    "shipping": "10.00",
                                    "shipping_account": "",
                                    "total": "75.98",
                                    "paid": "121.96",
                                    "subtotal": "65.98",
                                    "tax": "0.00",
                                    "line_item_total": "111.96",
                                    "items_shipped": "",
                                    "total_items": "4.0000",
                                    "placed": "1442596400",
                                    "notes": "",
                                    "status": "12",
                                    "sale_channel": [
                                      {
                                        "id": "1",
                                        "name": "Basic Order"
                                      }
                                    ],
                                    "shipping_provider": [
                                      {
                                        "id": "5",
                                        "name": "Shipping"
                                      }
                                    ],
                                    "customer": [
                                      {
                                        "id": "1",
                                        "display_id": "1000",
                                        "first_name": "Arto",
                                        "last_name": "Sego",
                                        "email": "silicet@yahoo.com",
                                        "phone": "619-222-3333",
                                        "fax": "619-222-3334"
                                      }
                                    ],
                                    "company": [
                                      {
                                        "id": "1",
                                        "name": "Arts Bakery"
                                      }
                                    ],
                                    "returns": {
                                      "pending_items": "1",
                                      "received_items": "2"
                                    },
                                    "attributes": ""
                                  }
                                ],
                                "3": [
                                  {
                                    "id": "3",
                                    "display_id": "10002",
                                    "alternative_id": "",
                                    "shipping": "10.00",
                                    "shipping_account": "",
                                    "total": "10.00",
                                    "paid": "200.93",
                                    "subtotal": "0.00",
                                    "tax": "0.00",
                                    "line_item_total": "190.93",
                                    "items_shipped": "",
                                    "total_items": "7.0000",
                                    "placed": "1442604077",
                                    "notes": "",
                                    "status": "10",
                                    "sale_channel": [
                                      {
                                        "id": "1",
                                        "name": "Basic Order"
                                      }
                                    ],
                                    "shipping_provider": [
                                      {
                                        "id": "5",
                                        "name": "Shipping"
                                      }
                                    ],
                                    "customer": [
                                      {
                                        "id": "1",
                                        "display_id": "1000",
                                        "first_name": "Arto",
                                        "last_name": "Sego",
                                        "email": "silicet@yahoo.com",
                                        "phone": "619-222-3333",
                                        "fax": "619-222-3334"
                                      }
                                    ],
                                    "company": [
                                      {
                                        "id": "1",
                                        "name": "Arts Bakery"
                                      }
                                    ],
                                    "returns": {
                                      "pending_items": "",
                                      "received_items": "7"
                                    },
                                    "attributes": ""
                                  }
                                ]
                              }
                            }
                            

                            Start your free, no-risk trial today.