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

                            warehouses/info

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


                            Warehouses Info Data

                            Gets Warehouses INFO. Using this API one can retrieve detailed information on the Warehouses which have been input into Lead Commerce based on Lead Commerce Warehouse IDs. The specific data points include ID, name, status and address and attribute data blocks. The ID is the primary key identifier for Warehouses in Lead Commerce, the name is the Warehouse name, the status is the status of the Warehouse and the address is the address of the Warehouse.
                            Filters
                            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
                            id int / array one id or multiple Lead Commerce warehouse ids
                            1 or array(3,8,9,45)

                            Response

                            Example JSON returned
                            {
                              "code": "200",
                              "data": {
                                "1": [
                                  {
                                    "id": "1",
                                    "name": "La Mesa",
                                    "status": "1",
                                    "address": [
                                      {
                                        "id": "1",
                                        "name": "Bob Smith",
                                        "address_1": "842 Main St",
                                        "address_2": "Ste 35",
                                        "city": "San Diego",
                                        "postal_code": "92110",
                                        "phone": "2069238660",
                                        "subregion": "California",
                                        "region": "United States"
                                      }
                                    ],
                                    "attributes": [
                                      {
                                        "id": "6",
                                        "name": "PQ Code",
                                        "display_name": "PQ Code",
                                        "slug": "attr_pq_code",
                                        "value": "LMZ"
                                      }
                                    ]
                                  }
                                ],
                                "2": [
                                  {
                                    "id": "2",
                                    "name": "Dan's Warehouse 1",
                                    "status": "1",
                                    "address": [
                                      {
                                        "id": "2",
                                        "name": "Dan",
                                        "address_1": "102 Main St",
                                        "address_2": "Ste 4543",
                                        "city": "San Diego",
                                        "postal_code": "92110",
                                        "phone": "619-222-3344",
                                        "subregion": "California",
                                        "region": "United States"
                                      }
                                    ],
                                    "attributes": ""
                                  }
                                ]
                              }
                            }
                            

                            Start your free, no-risk trial today.