Skip to main content

Create Vendor

Creates a new Vendor

Request Body

  • name string required

    Possible values: <= 255 characters

    The name of the Vendor. Must be unique.

  • city string

    Possible values: <= 255 characters

    The city of the Vendor.

  • contact_email string

    Possible values: <= 255 characters

    The email address of the contact person for the Vendor.

  • contact_name string

    Possible values: <= 255 characters

    The name of the contact person for the Vendor.

  • contact_phone string

    Possible values: <= 255 characters

    The phone number of the contact person for the Vendor.

  • country string

    Possible values: <= 255 characters

    The country of the Vendor.

  • external_id string

    Possible values: <= 255 characters

    An external ID for the Vendor. Must be unique.

  • phone string

    Possible values: <= 255 characters

    The phone number of the Vendor.

  • postal_code string

    Possible values: <= 255 characters

    The postal code or ZIP code of the Vendor.

  • region string

    Possible values: <= 255 characters

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

  • street_address string

    Possible values: <= 255 characters

    The street address of the Vendor.

  • street_address_line_2 string

    Possible values: <= 255 characters

    The second line of the street address of the Vendor.

  • website string

    Possible values: <= 255 characters

    The website of the Vendor.

  • fuel boolean

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

  • service boolean

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

  • parts boolean

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

  • vehicle boolean

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

  • custom_fields object

    *Full details on working with Custom Fields here.

Responses

OK

Response Headers

    Schema

    • id integer

      Possible values: >= 1

    • created_at date-time

      The date and time at which this record was created.

    • updated_at date-time

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

    • name string

      The name of the Vendor.

    • phone string

      The phone number of the Vendor.

    • street_address string

      The street address of the Vendor.

    • street_address_line_2 string

      The second line of the street address of the Vendor.

    • city string

      The city of the Vendor.

    • region string

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

    • postal_code string

      The postal code or ZIP code of the Vendor.

    • country string

      The country of the Vendor.

    • website string

      The website of the Vendor.

    • notes string

      Additional notes about the Vendor.

    • fuel boolean

      Indicates whether the Vendor provides fuel.

    • service boolean

      Indicates whether the Vendor provides service.

    • parts boolean

      Indicates whether the Vendor provides parts.

    • vehicle boolean

      Indicates whether the Vendor provides vehicles.

    • contact_name string

      The name of the contact person for the Vendor.

    • contact_email string

      The email address of the contact person for the Vendor.

    • contact_phone string

      The phone number of the contact person for the Vendor.

    • latitude float

      The latitude of the Vendor's location.

    • longitude float

      The longitude of the Vendor's location.

    • external_id string

      The external identifier of the Vendor.

    • archived_at string

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

    • labels object[]
    • id integer

      Possible values: >= 1

    • name string
    • custom_fields object

      *Full details on working with Custom Fields here.

    Loading...