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

                            customers/info

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


                            Customers Info Data

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

                            Response

                            Example JSON returned
                            {
                              "code": "200",
                              "data": {
                                "1": [
                                  {
                                    "id": "1",
                                    "display_id": "1000",
                                    "first_name": "Leon",
                                    "last_name": "DeCappuccino",
                                    "email": "silicet@gmail.com",
                                    "phone": "310-999-9999",
                                    "fax": "619-555-1123",
                                    "status": "1",
                                    "status": "1",
                                    "default_order_notes": "Please use customer UPS account 12345.", 
                                    "default_payment_notes": "",
                                    "company": [
                                      {
                                        "id": "6",
                                        "name": "Leon's Clock Company"
                                      }
                                    ],
                                    "customer_type": [
                                      {
                                        "id": "2",
                                        "name": "Wholesaler"
                                      }
                                    ],
                                    "attributes": ""
                                  }
                                ],
                                "2": [
                                  {
                                    "id": "2",
                                    "display_id": "1001",
                                    "first_name": "Jon",
                                    "last_name": "Smith",
                                    "email": "jon232@gmail.com",
                                    "phone": "858-888-9999",
                                    "fax": "858-777-8888",
                                    "status": "1",
                                    "default_order_notes": "", 
                                    "default_payment_notes": "",
                                    "company": [
                                      {
                                        "id": "3",
                                        "name": "XYZ Company, Inc."
                                      }
                                    ],
                                    "customer_type": [
                                      {
                                        "id": "1",
                                        "name": "Customer"
                                      }
                                    ],
                                    "attributes": [
                                      {
                                        "id": "17",
                                        "name": "NM Code",
                                        "display_name": "NM Code",
                                        "slug": "attr_nm_code",
                                        "value": "ABC"
                                      },
                                      {
                                        "id": "18",
                                        "name": "PQ Code",
                                        "display_name": "PQ Code",
                                        "slug": "attr_pq_code_1",
                                        "value": "MNO"
                                      }
                                    ]
                                  }
                                ]
                              }
                            }
                            

                            Start your free, no-risk trial today.