Sign in
latestOpenAPI 3.0.02026-08-2217901.1 MB

ef9153fcac7c

Parts

Create new part

post/parts

Query parameters

skipWebhookboolean

Set skipWebhook=true, skipWebhook=1 or skipWebhook=yes to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks

Headers

x-organization-idinteger

Required if using a multi organizations token

Request body

namestring required
descriptionstring nullable
areastring nullable

Area of the part. Deprecated: Use new field inside locations. Will cause error if both fields are sent.

unitCostinteger nullable

Cost in cents. For example, for $1.20, put 120.

availableQuantityinteger

Total quantity currently in stock. Deprecated: Use new field inside locations. Will cause error if both fields are sent.

minimumQuantityinteger

Total minimum quantity before you should restock. Deprecated: Use new field inside locations. Will cause error if both fields are sent.

barcodestring nullable

String encoded barcode

locationIdinteger nullable

ID of the location where the part is located. Deprecated: Use new field inside locations. Will cause error if both fields are sent.

partTypesstring[]

List of part types

assetIdsinteger[]

List of asset IDs

teamIdsinteger[]

List of team IDs in charge of the part

extraFieldsobject

Custom Fields on the entity. The object keys are the exact Custom Field labels, including spaces or special characters. (ie: "Part Number")

externalIdstring nullable

External ID for this part, unique per organization.

assignedQuantityinteger

Total quantity currently assigned to work orders across all stages.

vendorIdsinteger[]

List of vendor IDs. Deprecated: Use the vendorId field inside vendors.

Example request

{
  "name": "Locknut - 1/8",
  "area": "tool room",
  "unitCost": 120,
  "availableQuantity": 10,
  "minimumQuantity": 5,
  "barcode": "bWFpbnRhaW54Cg==",
  "locationId": 852,
  "locations": [
    {
      "locationId": 852,
      "availableQuantity": 10,
      "minimumQuantity": 5,
      "maximumQuantity": 100,
      "area": "tool room"
    }
  ],
  "assetIds": [
    12,
    4561
  ],
  "teamIds": [
    1,
    4
  ],
  "extraFields": {
    "Part Number": "000000000"
  },
  "vendors": [
    {
      "partNumber": "XC230"
    }
  ],
  "externalId": "ext-part-001",
  "committedQuantities": {
    "kitted": 5,
    "reserved": 3,
    "staged": 2
  },
  "assignedQuantity": 10,
  "vendorIds": [
    23,
    56
  ]
}

Response

Successfully created part

idinteger required

Global ID of the part

Example response

{
  "id": 123456
}