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

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


                            Orders ID Data

                            Gets Orders ID info.
                            Filters
                            Filter the Orders Display IDs into a list.
                            Parameter Type Rules Example
                            display_id int / array one id or multiple Lead Commerce order display ids
                            1 or array(3,8,9,45)
                            alternative_id int / array one id or multiple Lead Commerce order alternative ids
                            1 or array(3,8,9,45)

                            Request

                            Example cURL sent
                            curl -X POST 'https://{yourdomain}/api/v2/orders/id.json' 
                            -H '{yourkey}' 
                            -F 'alternative_id[0]=4005' 
                            -F 'alternative_id[1]=4004'
                            

                            Response

                            Example JSON returned
                            {
                              "code": "200",
                              "data": {
                                "6": "4005",
                                "5": "4004"
                              }
                            }
                            

                            Start your free, no-risk trial today.