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

                            products

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


                            List Products

                            Gets the filtered list of Products.
                            Filters
                            Filter the products into a list. Product Attributes are available as a filter.
                            Parameter Type Rules Example
                            status int 0,1 or 2
                            1
                            display_id int 1000
                            price_max float Maximum price range 100
                            price_min float Minimum price range 20
                            product_type int Type of product 4
                            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

                            Response

                            Example product JSON returned
                            {
                              "code": "200",
                              "data": [
                                {
                                  "id": "14",
                                  "display_id": "20013",
                                  "name": "Updated Graphic T-Shirt",
                                  "cost": "19.95",
                                  "price": "34.95",
                                  "status": "1"
                                },
                                {
                                  "id": "2",
                                  "display_id": "20001",
                                  "name": "Fleece Curved Pocket Hoodie",
                                  "cost": "6.95",
                                  "price": "32.99",
                                  "status": "1"
                                }
                              ]
                            }
                            

                            Start your free, no-risk trial today.