Create Part

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

Creates a new Part

Request

application/json

Body

descriptionstring
manufacturer_part_numberstring
The part number from this Part's manufacturer.
Possible values: <= 255 characters
measurement_unit_idId (integer)
Possible values: >= 1
measurement_unit_namestring
The name of the measurement unit. If the measurement unit does not exist, it will be ignored.
numberstringrequired
The part number to be used for this Part within Fleetio. Must be unique. Does not have to be the same as the manufacturer's part number.
Possible values: <= 255 characters
part_category_idId (integer)
Possible values: >= 1
part_category_namestring
The name of the part category. If the part category does not exist, it will be created.
Possible values: <= 255 characters
part_manufacturer_idId (integer)
Possible values: >= 1
part_manufacturer_namestring
The name of the part manufacturer. If the part manufacturer does not exist, it will be created.
Possible values: <= 255 characters
unit_costnumber
The cost per unit of this Part, which will be interpreted as dollars, or dollars and cents. May be sent as a string, integer, or float. Value may be up to two decimal places.
upcstring
The Universal Product Code for this Part. Must be unique.
Possible values: <= 255 characters
tire_config_attributes object
:::info tire_config_attributes are available to accounts on Premium plans :::
Parts that have a Part Category where tire_category is true can have a TireConfg which are tire-specific Part attributes.
aspect_ratiofloat
Aspect ratio of tire.
rim_diameterfloat
Rim diameter of tire.
load_indexfloat
Load index of tire.
metric_typestring
Metric type of tire.
Possible values: [EU, P, HL, T, LT, C, ST]
widthfloat
Width of tire.
constructionstring
Construction type of tire.
Possible values: [B, R, D]
speed_ratingstring
Speed rating of tire.
Possible values: [A1, A2, A3, A4, A5, A6, A7, A8, B, C, D, E, F, G, H, J, K, L, M, N, P, Q, R, S, T, U, V, W, Y]
factory_tread_depthfloat
factory_tread_depth support is currently in private beta.
Tread depth of tire in /32" when new, as specified by the manufacturer.
minimum_tread_depthfloat
minimum_tread_depth support is currently in private beta.
The legal minimum tread depth, in /32".
life_expectancyinteger
life_expectancy support is currently in private beta.
The Life Expectancy or “Warranty” of a tire is the expected meter range, usually measured in miles, of a given tire as specified by the manufacturer.
custom_fieldsobjectnullable
*Full details on working with Custom Fields here.
documents_attributes object[]
An array of one or more document objects to add to the record. Follow our Attaching Documents and Images guide to upload to our third party storage provider in order to obtain file_url.
Array [
namestring
The name to give the file which will be shown in the UI.
Possible values: <= 255 characters
file_urlstring
The URL obtained from our storage provider that points to the file.
Possible values: <= 255 characters
file_mime_typestring
The MIME type of the file. For example, application/pdf.
Possible values: <= 255 characters
file_namestring
The name of the file.
Possible values: <= 255 characters
file_sizeinteger
The size of the file in bytes.
]
images_attributes object[]
An array of one or more image objects to add to the record. Follow our Attaching Documents and Images guide to upload to our third party storage provider in order to obtain file_url.
Array [
namestring
The name to give the image which will be shown in the UI.
Possible values: <= 255 characters
file_urlstring
The URL obtained from our storage provider that points to the image.
Possible values: <= 255 characters
file_mime_typestring
The MIME type of the image. For example, image/png.
Possible values: <= 255 characters
file_namestring
The name of the image.
Possible values: <= 255 characters
file_sizeinteger
The size of the image file in bytes.
]

Responses

201

OK

Response Headers

application/json

Schema

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

account_idId (integer)required

Possible values: >= 1

descriptionstringnullablerequired

A description of this Part.

manufacturer_part_numberstringnullablerequired

The part number from this Part's manufaturer.

measurement_unit_idNullableId (integer)nullablerequired

Possible values: >= 1

numberstringrequired

A unique number for this Part. Does not have to be the same as the manufacturer's number.

part_category_idNullableId (integer)nullablerequired

Possible values: >= 1

part_manufacturer_idNullableId (integer)nullablerequired

Possible values: >= 1

upcstringnullablerequired

The Universal Product Code for this Part.

custom_fieldsobjectnullablerequired

*Full details on working with Custom Fields here.

unit_cost_centsintegernullable

The unit cost for this Part in cents.

average_unit_cost_centsintegernullable

The average unit cost for this Part in cents.

images_countintegerrequired

The number of images attached to this Part.

documents_countintegerrequired

The number of documents attached to this Part.

comments_countintegerrequired

The number of Comments attached to this Part.

archived_atdate-timenullablerequired

The date and time at which this Part was archived.

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

measurement_unit objectnullable

idId (integer)

Possible values: >= 1

namestringnullable

descriptionstringnullable

symbolstringnullable

has_active_inventory_setsboolean

Indicates whether this Part has any active Inventory Sets.

Example (auto)

{
  "id": 0,
  "created_at": "2023-03-14T13:46:27-06:00",
  "updated_at": "2023-03-14T13:46:27-06:00",
  "account_id": 0,
  "description": "string",
  "manufacturer_part_number": "string",
  "measurement_unit_id": 0,
  "number": "string",
  "part_category_id": 0,
  "part_manufacturer_id": 0,
  "upc": "string",
  "custom_fields": {},
  "unit_cost_cents": 0,
  "average_unit_cost_cents": 0,
  "images_count": 0,
  "documents_count": 0,
  "comments_count": 0,
  "archived_at": "2023-03-14T13:46:27-06:00",
  "measurement_unit": {
    "id": 0,
    "name": "string",
    "description": "string",
    "symbol": "string"
  },
  "has_active_inventory_sets": true
}

401

Request could not be authenticated

application/json

Schema

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.

Example (auto)

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

403

Insufficient permission to perform this operation

application/json

Schema

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.

Example (auto)

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

422

Unprocessable Entity

application/json

Schema

Schema

errors object
property name* string[]
Array [
string
]

Example (auto)

{
  "errors": {}
}

Example

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

500

Something unexpected happened

application/json

Schema

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.

Example (auto)

{
  "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
• ruby
• python
• csharp
• go
• java
• nodejs
• php

• CURL

Request Collapse all

Base URL

https://secure.fleetio.com/api

Auth

apiKey

accountToken

Body

{
  "description": "string",
  "manufacturer_part_number": "string",
  "measurement_unit_id": 0,
  "measurement_unit_name": "string",
  "number": "string",
  "part_category_id": 0,
  "part_category_name": "string",
  "part_manufacturer_id": 0,
  "part_manufacturer_name": "string",
  "unit_cost": 0,
  "upc": "string",
  "tire_config_attributes": {
    "aspect_ratio": 0,
    "rim_diameter": 0,
    "load_index": 0,
    "metric_type": "EU",
    "width": 0,
    "construction": "B",
    "speed_rating": "A1",
    "factory_tread_depth": 0,
    "minimum_tread_depth": 0,
    "life_expectancy": 0
  },
  "custom_fields": {},
  "documents_attributes": [
    {
      "name": "string",
      "file_url": "string",
      "file_mime_type": "string",
      "file_name": "string",
      "file_size": 0
    }
  ],
  "images_attributes": [
    {
      "name": "string",
      "file_url": "string",
      "file_mime_type": "string",
      "file_name": "string",
      "file_size": 0
    }
  ]
}

ResponseClear

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