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

                            vendors/info

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


                            Vendors Info Data

                            Gets Vendors INFO. Using this API one can retrieve detailed information on the Vendors which have been input into Lead Commerce based on Lead Commerce Vendors IDs. The specific data points include ID, name, status and default terms and attribute data blocks. The ID is the primary key identifier for Vendors in Lead Commerce, the name is the Vendor name, the status is the status of the Vendor and the default terms is the default payment arrangement terms of the Vendor.
                            Filters
                            Filter the Vendors into a list. Vendor 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 vendor ids
                            1 or array(3,8,9,45)

                            Response

                            Example JSON returned
                            {
                              "code": "200",
                              "data": {
                                "1": [
                                  {
                                    "id": "1",
                                    "display_id": "1",
                                    "name": "My Vendor",
                                    "default_terms": [
                                      {
                                        "id": "1",
                                        "name": "COD"
                                      }
                                    ],
                                    "attributes": [
                                      {
                                        "id": "8",
                                        "name": "MR Code",
                                        "display_name": "MR Code",
                                        "slug": "attr_mr_code",
                                        "value": "NMP"
                                      }
                                    ]
                                  }
                                ],
                                "2": [
                                  {
                                    "id": "2",
                                    "display_id": "2",
                                    "name": "Lead Commerce",
                                    "default_terms": [
                                      {
                                        "id": "5",
                                        "name": "Net 15"
                                      }
                                    ],
                                    "attributes": [
                                      {
                                        "id": "8",
                                        "name": "MR Code",
                                        "display_name": "MR Code",
                                        "slug": "attr_mr_code",
                                        "value": "NMP"
                                      }
                                    ]
                                  }
                                ],
                                "3": [
                                  {
                                    "id": "3",
                                    "display_id": "4000",
                                    "name": "GX Commerce",
                                    "default_terms": [
                                      {
                                        "id": "4",
                                        "name": "CIA"
                                      }
                                    ],
                                    "attributes": ""
                                  }
                                ],
                                "4": [
                                  {
                                    "id": "4",
                                    "display_id": "4001",
                                    "name": "FX Commerce",
                                    "default_terms": [
                                      {
                                        "id": "2",
                                        "name": "Check"
                                      }
                                    ],
                                    "attributes": ""
                                  }
                                ]
                              }
                            }
                            

                            Start your free, no-risk trial today.