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


                            Type List
                            List Warehouses
                            URL http://{domain}/api/v2/warehouses.json
                            Accepts Filters Yes
                            Output Attributes

                            List Warehouses

                            Gets the filtered LIST of Warehouses. Using this API one can retrieve limited data on the Warehouses which have been input into Lead Commerce. This LIST contains the fields ID, name and status for each Warehouse. The ID is the primary key identifier for Warehouses in Lead Commerce, the name is the Warehouse name and the status is the status of the Warehouse.
                            Filter the Warehouses into a LIST. Warehouse Attributes are available as a filter. Attributes are user defined customizable fields which use graphical control elements such as Text Box, Checkbox and Dropdown Menu.
                            Parameter Type Rules Example
                            status int 0,1 or 2
                            display_id int 1000
                            name string Warehouse Name ABC Warehouse
                            modify_start date
                            modify_end date
                            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


                            Example JSON returned
                              "code": "200",
                              "data": [
                                  "id": "4",
                                  "name": "Joe's Warehouse 2",
                                  "status": "1"
                                  "id": "3",
                                  "name": "Joe's Warehouse 1",
                                  "status": "1"
                                  "id": "2",
                                  "name": "Bob's Warehouse 1",
                                  "status": "1"
                                  "id": "1",
                                  "name": "El Cajon",
                                  "status": "1"

                            Start your free, no-risk trial today.