|
Type
|
List
|
|
List
|
Vendors
|
|
URL
|
http://{domain}/api/v2/vendors.json
|
|
Accepts Filters
|
Yes
|
Output Attributes
|
No
|
List Vendors
Gets the filtered LIST of Vendors. Using this API one can retrieve limited data on the Vendors which have been input into Lead Commerce. This LIST contains the fields ID, Display ID, name and status for each Vendor. The ID is the primary key identifier for Vendors in Lead Commerce. The Display ID is the visual identifier whose starting number can be set in System Settings, Default Increment. The name is the Vendor name and the status is the status 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 Drop Down Menu.
|
Parameter
|
Type
|
Rules
|
Example
|
|
status
|
int
|
0,1 or 2
|
1
|
|
display_id
|
int
|
|
1000
|
|
name
|
string
|
Vendor Name
|
GX Commmerce
|
|
default_terms
|
int
|
|
3
|
|
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 JSON returned
{
"code": "200",
"data": [
{
"id": "5",
"display_id": "4002",
"name": "AB Vendor",
"status": "1"
},
{
"id": "4",
"display_id": "4001",
"name": "FX Commerce",
"status": "1"
},
{
"id": "3",
"display_id": "4000",
"name": "GX Commerce",
"status": "1"
},
{
"id": "2",
"display_id": "2",
"name": "Lead Commerce",
"status": "1"
},
{
"id": "1",
"display_id": "1",
"name": "My Vendor",
"status": "1"
}
]
}
© 2017 Lead Commerce, LLC · All rights reserved · 
Made with ❤ in the USA.
