Vendors

Vendors represent external service providers, carriers, or partners that can support fulfillment. Use vendors to model third-party capacity, contact details, and service relationships.

The Vendor object

A vendor represents a third-party company or provider that can be assigned to FleetOps resources and facilitator workflows.

Attributes

idstringoptional

Public vendor identifier.

internal_idstringoptional

Optional internal identifier.

business_idstringoptional

Business identifier associated with the vendor.

namestringoptional

Vendor display name.

emailstringoptional

Vendor email address.

phonestringoptional

Vendor phone number.

logo_urlstringoptional

Vendor logo URL.

photo_urlstringoptional

Vendor photo URL.

placeobjectoptional

Primary vendor place, when loaded.

placesarray of objectsoptional

Places associated with the vendor, when loaded.

personnelsarray of objectsoptional

Personnel contacts associated with the vendor, when loaded.

countrystringoptional

Vendor country code.

typestringoptional

Vendor type.

metaobjectoptional

Additional vendor metadata.

statusstringoptional

Vendor lifecycle status.

slugstringoptional

URL-friendly vendor slug.

website_urlstringoptional

Vendor website URL.

updated_attimestampoptional

Timestamp when the vendor was last updated.

created_attimestampoptional

Timestamp when the vendor was created.

The Vendor object

{
  "id": "vendor_8Qw2YxM3Nf",
  "internal_id": "VEND-1001",
  "business_id": null,
  "name": "ABC Corporation",
  "email": "abc@example.com",
  "phone": "1234567890",
  "logo_url": null,
  "photo_url": null,
  "place": null,
  "places": [],
  "personnels": [],
  "country": null,
  "type": "Supplier",
  "meta": {},
  "status": "active",
  "slug": "abc-corporation",
  "website_url": null,
  "updated_at": "2026-05-07T08:30:00.000000Z",
  "created_at": "2026-05-07T08:30:00.000000Z"
}

POST/v1/vendors

Create a Vendor

Creates a vendor for the current company. Vendors can be assigned to orders, vehicles, drivers, places, and facilitator workflows.

Body parameters

namestringrequired

Vendor display name.

typestringrequired

Vendor type.

emailstringoptional

Vendor email address.

phonestringoptional

Vendor phone number.

addressstringoptional

Place ID to use as the vendor's primary address.

metaobjectoptional

Additional vendor metadata.

POST/v1/vendors

curl -X POST https://api.fleetbase.io/v1/vendors \
  -H "Authorization: Bearer flb_live_…" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
  "name": "ABC Corporation",
  "type": "Supplier",
  "email": "abc@example.com",
  "phone": "1234567890"
}'

200 OK

{
  "id": "<string>",
  "internal_id": "<string>",
  "name": "<string>",
  "email": "<string>",
  "phone_number": "<string>",
  "phone_country_code": "<string>",
  "address": "<string>",
  "type": "<string>",
  "slug": "<string>",
  "updated_at": "<string>",
  "created_at": "<string>"
}

GET/v1/vendors/:id

Retrieve a Vendor

This endpoint allows you to retrieve a vendor object to view it's details.

GET/v1/vendors/:id

curl https://api.fleetbase.io/v1/vendors/:id \
  -H "Authorization: Bearer flb_live_…" \
  -H "Accept: application/json"

200 OK

{
  "id": "<string>",
  "internal_id": "<string>",
  "name": "<string>",
  "email": "<string>",
  "phone_number": "<string>",
  "phone_country_code": "<string>",
  "address": "<string>",
  "type": "<string>",
  "slug": "<string>",
  "updated_at": "<string>",
  "created_at": "<string>"
}

PUT/v1/vendors/:id

Update a Vendor

Updates a vendor's profile, primary address, type, contact fields, or metadata.

Body parameters

namestringoptional

Vendor display name.

typestringoptional

Vendor type.

emailstringoptional

Vendor email address.

phonestringoptional

Vendor phone number.

addressstringoptional

Place ID to use as the vendor's primary address.

metaobjectoptional

Additional vendor metadata.

PUT/v1/vendors/:id

curl -X PUT https://api.fleetbase.io/v1/vendors/:id \
  -H "Authorization: Bearer flb_live_…" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "name": "ABC Corporation",
    "type": "Supplier",
    "email": "abc@example.com",
    "phone": "1234567890"
}'

200 OK

{
  "id": "<string>",
  "name": "<string>",
  "internal_id": "<string>",
  "email": "<string>",
  "phone_number": "<string>",
  "phone_country_code": "<string>",
  "address": "<string>",
  "type": "<string>",
  "slug": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>"
}

GET/v1/vendors

Query Vendors

Returns vendors for the current company. Use search, pagination, and sort parameters to narrow the result set.

Query parameters

idstringoptional

Vendor ID filter used by this request example.

querystringoptional

Search term matched against vendor fields.

limitintegeroptional

Maximum number of vendors to return.

offsetintegeroptional

Number of vendors to skip before returning results.

sortstringoptional

Sort expression for the vendor query.

GET/v1/vendors

curl https://api.fleetbase.io/v1/vendors?id={{vendor_id}} \
  -H "Authorization: Bearer flb_live_…" \
  -H "Accept: application/json"

200 OK

{
  "id": "<string>",
  "internal_id": "<string>",
  "name": "<string>",
  "email": "<string>",
  "phone_number": "<string>",
  "phone_country_code": "<string>",
  "address": "<string>",
  "type": "<string>",
  "slug": "<string>",
  "updated_at": "<string>",
  "created_at": "<string>"
}

DELETE/v1/vendors/:id

Delete a Vendor

Use this endpoint to delete a vendor.

DELETE/v1/vendors/:id

curl -X DELETE https://api.fleetbase.io/v1/vendors/:id \
  -H "Authorization: Bearer flb_live_…" \
  -H "Accept: application/json"

200 OK

{
  "id": "<string>",
  "internal_id": "<string>",
  "name": "<string>",
  "email": "<string>",
  "phone_number": "<string>",
  "phone_country_code": "<string>",
  "address": "<string>",
  "type": "<string>",
  "slug": "<string>",
  "updated_at": "<string>",
  "created_at": "<string>"
}