Evyoo POS API v1

Vendors

List vendors

The vendors of the company.

needs vendors:read Catalog and parties

Endpoints#

List: GET/api/v1/vendors   One record: GET/api/v1/vendors/{id}

Example request#

List with a page size and a sort:

bash
curl "https://votre-entreprise.evyooht.com/api/v1/vendors?per_page=5&sort=-name" \
  -H "Authorization: Bearer evy_at_votre_jeton"
powershell
$headers = @{ Authorization = "Bearer evy_at_votre_jeton" }
Invoke-RestMethod -Uri "https://votre-entreprise.evyooht.com/api/v1/vendors?per_page=5&sort=-name" -Headers $headers
javascript
const response = await fetch("https://votre-entreprise.evyooht.com/api/v1/vendors?per_page=5&sort=-name", {
  headers: { Authorization: "Bearer evy_at_votre_jeton" },
});
const data = await response.json();
console.log(data);
php
$ch = curl_init("https://votre-entreprise.evyooht.com/api/v1/vendors?per_page=5&sort=-name");
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ["Authorization: Bearer evy_at_votre_jeton"],
]);
$data = json_decode(curl_exec($ch), true);
curl_close($ch);
print_r($data);
python
import requests

response = requests.get(
    "https://votre-entreprise.evyooht.com/api/v1/vendors",
    params={"per_page": 5, "sort": "-name"},
    headers={"Authorization": "Bearer evy_at_votre_jeton"},
)
print(response.json())

One record by its identifier:

bash
curl "https://votre-entreprise.evyooht.com/api/v1/vendors/12" \
  -H "Authorization: Bearer evy_at_votre_jeton"
powershell
$headers = @{ Authorization = "Bearer evy_at_votre_jeton" }
Invoke-RestMethod -Uri "https://votre-entreprise.evyooht.com/api/v1/vendors/12" -Headers $headers
javascript
const response = await fetch("https://votre-entreprise.evyooht.com/api/v1/vendors/12", {
  headers: { Authorization: "Bearer evy_at_votre_jeton" },
});
const data = await response.json();
console.log(data);
php
$ch = curl_init("https://votre-entreprise.evyooht.com/api/v1/vendors/12");
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ["Authorization: Bearer evy_at_votre_jeton"],
]);
$data = json_decode(curl_exec($ch), true);
curl_close($ch);
print_r($data);
python
import requests

response = requests.get(
    "https://votre-entreprise.evyooht.com/api/v1/vendors/12",
    headers={"Authorization": "Bearer evy_at_votre_jeton"},
)
print(response.json())

Query parameters of the list#

All filters can be combined: they add up (AND). An unknown parameter or an invalid value is refused with a 400 error, never ignored.

ParameterTypeDescription
pageintegerPage number, starting at 1. A page beyond the data is empty, not an error. At most 10000 pages: filter instead of paging deeper. Default: 1.
per_pageintegerResults per page, from 1 to 100. Default: 25.
sortstringSort fields, separated by commas, with - in front for descending order. Up to 3 fields. Sortable fields: id, name, code, updated_at. Default: name. Default: name.
statusstringactive or inactive. Allowed values: active, inactive.
searchstringText contained in the company name, the code, the phone or the e-mail.
updated_sincestringOnly records modified since this date (YYYY-MM-DD) or date and time (YYYY-MM-DDTHH:MM:SS).

Response fields#

The list and the detail route return these fields. A field is null when the value is not recorded. A field marked needs permission is absent (not empty) unless your client holds that permission.

FieldTypeDescription
idintegerUnique identifier. Use it in the detail route.
codestring| nullVendor code.
namestring| nullCompany name.
contact_first_namestring| nullFirst name of the contact person.
contact_last_namestring| nullLast name of the contact person.
other_contactstring| nullOther contact information.
phonestring| nullMain phone number.
phone2string| nullSecond phone number.
emailstring| nullE-mail address.
websitestring| nullWeb site.
addressstring| nullStreet address.
citystring| nullCity.
zipstring| nullPostal code.
countrystring| nullCountry.
currencystring| nullCurrency used with this vendor.
status"active"| "inactive" | nullactive or inactive.
created_atstring(date-time, local) | nullWhen the record was created (local time, no time zone).
updated_atstring(date-time, local) | nullWhen the record was last modified (local time, no time zone). Use it with the updated_since filter to synchronize.

Example response: list#

json
{
  "data": [
    {
      "id": 12,
      "code": "VND-0012",
      "name": "Papeterie Delmas",
      "contact_first_name": "Paul",
      "contact_last_name": "Delmas",
      "other_contact": "",
      "phone": "+509 3700 0000",
      "phone2": "",
      "email": "contact@example.com",
      "website": "https://www.example.com",
      "address": "12 Rue Capois",
      "city": "Port-au-Prince",
      "zip": "HT6110",
      "country": "Haiti",
      "currency": "USD",
      "status": "active",
      "created_at": "2026-03-15T14:30:00",
      "updated_at": "2026-03-15T14:30:00"
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 25,
    "total": 1,
    "total_pages": 1
  }
}

Example response: one record#

json
{
  "data": {
    "id": 12,
    "code": "VND-0012",
    "name": "Papeterie Delmas",
    "contact_first_name": "Paul",
    "contact_last_name": "Delmas",
    "other_contact": "",
    "phone": "+509 3700 0000",
    "phone2": "",
    "email": "contact@example.com",
    "website": "https://www.example.com",
    "address": "12 Rue Capois",
    "city": "Port-au-Prince",
    "zip": "HT6110",
    "country": "Haiti",
    "currency": "USD",
    "status": "active",
    "created_at": "2026-03-15T14:30:00",
    "updated_at": "2026-03-15T14:30:00"
  }
}

Errors#

The error format and the full list of codes are described in Errors.

StatusWhen
400A query parameter is invalid or unknown. Every fault is reported at once in error.details. Nothing is ignored silently.
401The token is missing, malformed, expired or revoked (missing_token or invalid_token). Ask for a new token.
403Your token does not carry the permission this route needs (insufficient_scope), or the request was not made over HTTPS (https_required).
429Too many requests this minute. Wait for the number of seconds in the Retry-After header.