Sign in
latestOpenAPI 3.0.02026-08-2217901.1 MB

ef9153fcac7c

Parts

List parts

Endpoint used to list part resources

get/parts

Query parameters

cursorstring

Last pagination reference

limitinteger

max number of Parts returned

partNumberstring[]

Will only show parts that have a vendor with this part number associated to them.

updatedAt[gte]string date-time

Return records whose updatedAt is at or after this ISO 8601 date-time (UTC).

Example:2024-01-01T00:00:00.000Z
updatedAt[lte]string date-time

Return records whose updatedAt is at or before this ISO 8601 date-time (UTC).

Example:2024-12-31T23:59:59.999Z
createdAt[gte]string date-time

Return records whose createdAt is at or after this ISO 8601 date-time (UTC).

Example:2024-01-01T00:00:00.000Z
createdAt[lte]string date-time

Return records whose createdAt is at or before this ISO 8601 date-time (UTC).

Example:2024-12-31T23:59:59.999Z
customFieldNamestring[]

Filter parts by custom field value. Your query parameter should be your custom field name. (ie: To filter by a custom field named "Industry" with the value "Construction", you would do this "/parts?Industry=Construction"). <br><br>Adding multiple instance of the same custom field act as an <code>OR</code> and adding a different custom field act as an <code>AND</code>. (ie: To filter by a custom field named <code>Industry</code> with the value <code>Construction</code> OR <code>Transportation</code> AND the custom field <code>Manufacturer</code> with the value <code>ACME</code>, you would do this <code>/parts?Industry=Construction&Industry=Transportation&Manufacturer=ACME</code>). <br><br>If your custom field label is the same as a reserved query parameter such as <code>limit</code>, <code>sort</code>, <code>expand</code>, etc, you can add <code>__c</code> to your custom field filtering (ie: To filter by a custom field named <code>limit</code> with the value <code>ten</code>, you would do this <code>/parts?limit__c=ten</code>). <br><br>Note that your custom field needs to be created beforehand. Only number and single line text custom field types are supported.

sort'id' | 'createdAt' | 'updatedAt' | '-id' | '-createdAt' | '-updatedAt'

Attribute on which to sort the list. (for descending order, prefix attribute with '-').

expandstring[]

To expand multiple fields: expand=extra_fields&expand=vendors

Headers

x-organization-idinteger

Required if using a multi organizations token

x-organization-idsstring

Required if using a multi organizations token and doing an operation on resources from multiple organizations. This is mutually exclusive with the x-organization-id header (use one or the other).

Response

Successfully fetched Parts list

nextCursorstring nullable required

The cursor to retrieve the next page of Parts.

nextPageUrlstring nullable required

Path with query parameters that can be used to retrieve the next page of Parts.

Example response

{
  "parts": [
    {
      "id": 123456,
      "name": "Locknut - 1/8",
      "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
        }
      ],
      "area": "tool room",
      "unitCost": 120,
      "availableQuantity": 10,
      "minimumQuantity": 5,
      "orderedQuantity": 15,
      "reservedQuantity": 3,
      "createdAt": "2022-01-01T00:00:00.000Z",
      "updatedAt": "2022-01-01T00:00:00.000Z",
      "inStockQuantity": 10,
      "committedQuantities": {
        "kitted": 5,
        "reserved": 3,
        "staged": 2
      },
      "assignedQuantity": 10,
      "maximumQuantity": 100,
      "externalId": "ext-part-001",
      "organizationId": 1,
      "extraFields": {
        "Part Number": "000000000"
      },
      "vendors": [
        {
          "partNumber": "XC230"
        }
      ],
      "assetIds": [
        12,
        4561
      ]
    }
  ]
}