API V3 Changelog

Check back here for the latest updates to API v3

API Newsletter

To receive important updates and announcements regarding the API, sign up for our API Newsletter. This is the most effective way to stay informed about the Aligni API and keep your integration working smoothly.

To subscribe to the API Newsletter go to Account Settings > Newsletter Subscription and click the API Updates box.

2026-07-10

  • Fix: bomItemUpdate/bomItemDelete and subpartUpdate/subpartDelete now reject changes to BOM items whose parent part revision is released, failing with an authorization error. Released revisions are immutable; these mutations previously bypassed that rule, which the web UI and create mutations already enforced.

2026-07-09

  • Rename Subpart to BomItem across the API. Add the BomItem type, the PartRevision.bomItems connection, the bomItemCreate/bomItemUpdate/bomItemDelete mutations, and the BomItemInput/BomItemUpdateInput inputs. BomItemInput uses parentPartRevisionId and childPartRevisionId (replacing partRevisionId and subpartPartRevisionId).
  • Deprecate the Subpart type, the PartRevision.subparts connection, and the subpartCreate/subpartUpdate/subpartDelete mutations. They still work but will be removed in a future version after October 20th 2026.; use the BomItem equivalents.
  • Change PartRevision.parentBomItems to return BomItem (was Subpart).

2026-07-07

  • Add parentBomItems connection to PartRevision, listing the BOM line items in which the revision is used as a component (“where used”).
  • Add parentPartRevision field to Subpart, resolving the assembly revision that owns the BOM line item. Together these enable traversal from a part revision up to the assemblies that consume it: partRevision → parentBomItems → parentPartRevision → part.

2026-07-02

  • Fix: paginated connections now return rows in a stable order (by ascending id) so cursor pagination is deterministic. Previously connections without an explicit sort (such as inventoryUnits) had an undefined order, which could duplicate or drop edges and end a traversal early when pages were fetched with a delay between requests while records changed.

2026-07-01

  • Return 403 Forbidden (was 400 Bad Request) when creating, updating, or deleting a subpart on a released part revision. The error message is now “You do not have permission to perform the selected action.” (was “Updates are not allowed on released part revisions.”).

2026-06-06

  • Fix: EngineeringChangeOrder.partRevisions now resolves the related part revisions. The field previously returned the join records and errored when selecting fields such as revisionName.

2026-06-04

  • Attachment.text is now empty for newly created file attachments. File attachments use an internal storage key that is not exposed; read the file name from title. Existing file attachments are unaffected.

2026-05-07

  • Fix: Attachment.position is now nullable. The underlying column is nullable, so the field was incorrectly declared non-null and caused query failures for attachments without a position.

2026-05-06

  • QualityControlRecord.warehouse is now non-null. Quality control records always reference a live warehouse and are destroyed alongside the warehouse.
  • Deprecate QualityControlRecord.denormalizedWarehouse and QualityControlRecord.denormalizedWarehouseZone. Use warehouse and warehouseZone instead. The deprecated fields still resolve to the live records for backward compatibility. Deprecated fields will be removed after October 20th 2026.

2026-04-23

  • Add recordId field to PurchaseOrder.
  • Add account, approvedAt, billToAddress, committedAt, and title fields to PurchaseOrder.
  • PurchaseOrder.activityRecords now returns a more complete set of activity records for the purchase order.
  • Deprecate the purchase field on PurchaseOrder and PurchaseItem. The Purchase type is being removed from the API after October 20th 2026.
  • Fix: partParameterFields query no longer errors for non-option-type fields. options resolves to an empty connection for String, Boolean, Number, and SI Number parameter types.

2026-04-08

  • Add standardCostUpdate mutation to update standard cost attributes on a part.

2026-03-16

  • Add filter support on association fields for:
    • Account (attachments)
    • Build (attachments)
    • EngineeringChangeOrder (participants, affectedParts, reasons, partRevisions)
    • EngineeringChangeRequest (participants, affectedParts, reasons)
    • Part (customParameters, images, partAlternatives)
    • PartRevision (customParameters)
    • PartType (children)
    • QualityControlRecord (derivedQualityControlRecords, ancestors, bins)

2025-10-28

  • Fix: Change Subpart.quantity type to Float (was Integer).

2025-10-19

  • Fix: Rename parttypeId to partTypeId on partUpdate mutation.

2025-10-13

  • Deprecate discussionComments field for several object types.
  • Add category field to ActivityRecord.
  • Include comments in the unified activityRecords field.
  • Implement activityRecord support for:
    • Build
    • Contact
    • Customer
    • Manufacturer
    • Part
    • PartRevision
    • PurchaseOrder
    • Purchase
    • QuoteRequest
    • Unit
    • Vendor