Create Vendor

POST https://secure.fleetio.com/api/v1/vendors

Creates a new Vendor

Request

application/json

Body

namestringrequired

The name of the Vendor. Must be unique.

Possible values: <= 255 characters

citystring

The city of the Vendor.

Possible values: <= 255 characters

contact_emailstring

The email address of the contact person for the Vendor.

Possible values: <= 255 characters

contact_namestring

The name of the contact person for the Vendor.

Possible values: <= 255 characters

contact_phonestring

The phone number of the contact person for the Vendor.

Possible values: <= 255 characters

countrystring

The country of the Vendor.

Possible values: <= 255 characters

external_idstring

An external ID for the Vendor. Must be unique.

Possible values: <= 255 characters

phonestring

The phone number of the Vendor.

Possible values: <= 255 characters

postal_codestring

The postal code or ZIP code of the Vendor.

Possible values: <= 255 characters

regionstring

The region, state, province, or territory of the Vendor.

Possible values: <= 255 characters

street_addressstring

The street address of the Vendor.

Possible values: <= 255 characters

street_address_line_2string

The second line of the street address of the Vendor.

Possible values: <= 255 characters

websitestring

The website of the Vendor.

Possible values: <= 255 characters

fuelboolean

Indicates whether the Vendor provides fuel. Will be able to be listed on Fuel Entries.

serviceboolean

Indicates whether the Vendor provides service. This Vendor will be able to be listed on Service Entries and Work Orders.

partsboolean

Indicates whether the Vendor provides parts. This Vendor will be able to be listed on Parts and Purchase Orders.

vehicleboolean

Indicates whether the Vendor provides vehicles. This Vendor will be able to be listed on Acquisitions and Vehicles.

custom_fieldsobjectnullable

*Full details on working with Custom Fields here.

Responses

Response Headers

application/json

Schema
Example (auto)

Schema

idId (integer)required

Possible values: >= 1

created_atdate-time

The date and time at which this record was created.

Example: 2023-03-14T13:46:27-06:00

updated_atdate-time

The date and time at which this record was most recently updated.

Example: 2023-03-14T13:46:27-06:00

namestringrequired

The name of the Vendor.

phonestringnullablerequired

The phone number of the Vendor.

street_addressstringnullablerequired

The street address of the Vendor.

street_address_line_2stringnullablerequired

The second line of the street address of the Vendor.

citystringnullablerequired

The city of the Vendor.

regionstringnullablerequired

The region, state, province, or territory of the Vendor.

postal_codestringnullablerequired

The postal code or ZIP code of the Vendor.

countrystringnullablerequired

The country of the Vendor.

websitestringnullablerequired

The website of the Vendor.

notesstringnullablerequired

Additional notes about the Vendor.

fuelbooleannullablerequired

Indicates whether the Vendor provides fuel.

servicebooleannullablerequired

Indicates whether the Vendor provides service.

partsbooleannullablerequired

Indicates whether the Vendor provides parts.

vehiclebooleannullablerequired

Indicates whether the Vendor provides vehicles.

contact_namestringnullablerequired

The name of the contact person for the Vendor.

contact_emailstringnullablerequired

The email address of the contact person for the Vendor.

contact_phonestringnullablerequired

The phone number of the contact person for the Vendor.

latitudefloatnullablerequired

The latitude of the Vendor's location.

longitudefloatnullablerequired

The longitude of the Vendor's location.

external_idstringnullablerequired

The external identifier of the Vendor.

archived_atstringnullablerequired

The date and time when the Vendor was archived, if applicable.

labels object[]required

custom_fieldsobjectnullablerequired

*Full details on working with Custom Fields here.

{
  "id": 0,
  "created_at": "2023-03-14T13:46:27-06:00",
  "updated_at": "2023-03-14T13:46:27-06:00",
  "name": "string",
  "phone": "string",
  "street_address": "string",
  "street_address_line_2": "string",
  "city": "string",
  "region": "string",
  "postal_code": "string",
  "country": "string",
  "website": "string",
  "notes": "string",
  "fuel": true,
  "service": true,
  "parts": true,
  "vehicle": true,
  "contact_name": "string",
  "contact_email": "string",
  "contact_phone": "string",
  "latitude": 0,
  "longitude": 0,
  "external_id": "string",
  "archived_at": "string",
  "labels": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "custom_fields": {}
}

Request could not be authenticated

application/json

Schema
Example (auto)

Schema

statusintegerrequired

Possible values: >= 400 and <= 599

titlestringrequired

A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

detailstring

A human-readable explanation specific to this occurrence of the problem.

instancestring

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}

Insufficient permission to perform this operation

application/json

Schema
Example (auto)

Schema

statusintegerrequired

Possible values: >= 400 and <= 599

titlestringrequired

A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

detailstring

A human-readable explanation specific to this occurrence of the problem.

instancestring

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}

Unprocessable Entity

application/json

Schema
Example (auto)
Example

Schema

errors object

{
  "errors": {}
}

{
  "errors": {
    "field1": [
      "error1",
      "error2"
    ],
    "field2": [
      "error3"
    ]
  }
}

Something unexpected happened

application/json

Schema
Example (auto)

Schema

statusintegerrequired

Possible values: >= 400 and <= 599

titlestringrequired

A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

detailstring

A human-readable explanation specific to this occurrence of the problem.

instancestring

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}

Authorization: Authorization

name: Authorizationtype: apiKeyin: headerdescription: Prefix the value with "Token", for example: "Token 76cbe06c49a64".
You can generate a new API key [here](https://secure.fleetio.com/api_keys).

name: Account-Tokentype: apiKeyin: headerdescription: You can find your Account-Token [here](https://secure.fleetio.com/api_keys)

CURL

curl -L 'https://secure.fleetio.com/api/v1/vendors' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: <Authorization>' \
-H 'Account-Token: <Authorization>' \
-d '{
  "name": "string",
  "city": "string",
  "contact_email": "string",
  "contact_name": "string",
  "contact_phone": "string",
  "country": "string",
  "external_id": "string",
  "phone": "string",
  "postal_code": "string",
  "region": "string",
  "street_address": "string",
  "street_address_line_2": "string",
  "website": "string",
  "fuel": true,
  "service": true,
  "parts": true,
  "vehicle": true,
  "custom_fields": {}
}'

ResponseClear

Click the Send API Request button above and see the response here!

Create Vendor

https://secure.fleetio.com/api/v1/vendors

Request​

Body

Responses​

Authorization: Authorization

Request

Responses