latestOpenAPI 3.0.02026-08-2217901.1 MB

ef9153fcac7c

Parts

Get part

get/parts/{id}

Path parameters

idinteger required

ID of the part

Response

Successfully retrieved part's information

Example response

{
  "part": {
    "id": 123456,
    "name": "Locknut - 1/8",
    "area": "tool room",
    "unitCost": 120,
    "availableQuantity": 10,
    "inStockQuantity": 10,
    "minimumQuantity": 5,
    "barcode": "bWFpbnRhaW54Cg==",
    "locationId": 852,
    "locations": [
      {
        "locationId": 852,
        "availableQuantity": 10,
        "minimumQuantity": 5,
        "maximumQuantity": 100,
        "area": "tool room",
        "reservedQuantity": 10,
        "committedQuantities": {
          "kitted": 5,
          "reserved": 3,
          "staged": 2
        },
        "assignedQuantity": 5
      }
    ],
    "assetIds": [
      12,
      4561
    ],
    "teamIds": [
      1,
      4
    ],
    "extraFields": {
      "Part Number": "000000000"
    },
    "vendors": [
      {
        "partNumber": "XC230"
      }
    ],
    "externalId": "ext-part-001",
    "orderedQuantity": 15,
    "reservedQuantity": 3,
    "committedQuantities": {
      "kitted": 5,
      "reserved": 3,
      "staged": 2
    },
    "assignedQuantity": 10,
    "maximumQuantity": 100,
    "vendorIds": [
      23,
      56
    ],
    "thumbnail": {
      "id": 12345,
      "mimeType": "image/png",
      "fileName": "image.png",
      "url": "http://example.com/image.png",
      "createdAt": "2022-01-01T00:00:00.000Z",
      "width": 220,
      "height": 100
    },
    "attachments": [
      {
        "id": 12345,
        "mimeType": "image/png",
        "fileName": "image.png",
        "url": "http://example.com/image.png",
        "createdAt": "2022-01-01T00:00:00.000Z",
        "width": 220,
        "height": 100
      }
    ],
    "createdAt": "2022-01-01T00:00:00.000Z",
    "updatedAt": "2022-01-01T00:00:00.000Z",
    "deletedAt": "2022-01-01T00:00:00.000Z"
  }
}