List vendors

get

https://api.mrpeasy.com/rest/v1/vendors

Vendors are read-only. Only GET method is supported. Other methods are disabled.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

code

string

A unique number to identify the vendor.

title

string

Name of the vendor.

vendor_id

integer

Database ID of the vendor.

phone

string

Phone number from vendor contact data.

skype

string

Teams/Skype ID from vendor contact data.

string

Email address from vendor contact data.

url

string

Website address from vendor contact data.

address

string

Address from vendor contact data.

currency

string

Default currency of the vendor.

lead_time_min

integer

Minimum default lead time of the vendor in days.

lead_time_max

integer

Maximum default lead time of the vendor in days.

on_time_rate_min

number

Minimum on time delivery percentage of the vendor during the selected period.

on_time_rate_max

number

Maximum on time delivery percentage of the vendor during the selected period.

avg_delay_min

number

Minimum average delay of the vendor in days during the selected period.

avg_delay_max

number

Maximum average delay of the vendor in days during the selected period.

total_cost_min

number

Minimum total cost of purchase orders during the selected period.

total_cost_max

number

Maximum total cost of purchase orders during the selected period.

rejected_min

number

Minimum number of rejected items during the selected period.

rejected_max

number

Maximum number of rejected items during the selected period.

rejected_percentage_min

number

Minimum percentage of rejected items during the selected period. Filters response field rejected_rate.

rejected_percentage_max

number

Maximum percentage of rejected items during the selected period. Filters response field rejected_rate.

start

date

Period start in YYYY-MM-DD format. By default the period is the current year.

end

date

Period end in YYYY-MM-DD format. By default the period is the current year.

Headers

Range

string

Pagination range (e.g., items=0-99, items=200-249)

Responses

429

Rate limited - another request is running

Language

Credentials

Basic

base64

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200List of vendors

206Partial content

400Validation failed

401Authentication failed