Documentation

Introduction

Quick Start

Usage Guidelines

Authentication

Versioning

Pagination

Filters

Webhooks

Attachments

Attachments are files, notes, and URLs associated with various parent objects.

The following objects support child attachments:

Build
Contact
Customer
EngineeringChangeRequest
EngineeringChangeOrder
Equipment
LogBookEntry (API not available)
Manufacturer
ManufacturerFamily (API not available)
Part
PartRevision
Purchase (API not available)
QuoteRequest (API not available)
Vault (API not available)
Vendor

Endpoints

   GET /v2/{api_token}/attachments/{id}   GET /v2/{api_token}/attachments/{id}/download_uri   GET /v2/{api_token}/attachments

Show

BOM Items

The Subpart object is used to link an assembly to its children. Note that both the assembly and children are Part objects. The assembly is referred to as the parent and the parts on the BOM are referred to as the children. The Subpart object itself captures the instance information such as quantity, reference designator, and comment fields.

BOM Items may only be managed (created, updated, or deleted) on draft assembly revisions. Once a revision has been released, these actions are prohibited. To make changes to a BOM, you will need to create a new draft revision.

For more information, visit the following documentation references:

Endpoints

  POST /v2/{api_token}/subpart   PUT /v2/{api_token}/subpart/{id}DELETE /v2/{api_token}/subpart/{id}

Show

Builds

A build coordinates the conversion of individual component inventory into completed assemblies. The Build object represents a build throughout the build stages: planning, allocation, reservation, and finalization.

Related Documentation - Build Information

Endpoints

   GET /v2/{api_token}/builds  POST /v2/{api_token}/builds

Show

Parts

The most connected entity in Aligni, the Part object is the central item of any BOM.

The Part object may only be managed (created, updated, or deleted) on draft revisions. Once a part revision has been released, these actions are prohibited. To make changes to a part, you will need to create a new draft revision.

Related Documentation - Part Information

Endpoints

  POST /v2/{api_token}/part   GET /v2/{api_token}/part/{id}   PUT /v2/{api_token}/part/{id}DELETE /v2/{api_token}/part/{id}   GET /v2/{api_token}/part   GET /v2/{api_token}/part/{id}/inventory_units PATCH /v2/{api_token}/part/{id}/consume_inventory

Show

Part Revisions

The PartRevision object captures a record of changes parts and assemblies will undergo over their lifecycle. Managing a revision (created, updated, or deleted) may only happen in draft state. Once a revision has been released, these actions are prohibited. In order to make changes to a part, you will need to create a new draft revision.

Related Documentation - Revision Information

Endpoints

  POST /v2/{api_token}/parts/{part_id}/revisions   GET /v2/{api_token}/parts/{part_id}/revisions/{id}DELETE /v2/{api_token}/parts/{part_id}/revisions/{id}  POST /v2/{api_token}/parts/{part_id}/revisions/{id}/release   GET /v2/{api_token}/parts/{part_id}/revisions   GET /v2/{api_token}/parts/{part_id}/revisions/{id}/part_ancestors

Show

Quotes

The Quote object captures the information associated with a vendor quote (also known as an “offer” in some systems). Account holders may create free quotes (unattached to a vendor RFQ). Both RFQ quotes and free quotes are represented by this object.

Endpoints

  POST /v2/{api_token}/quoteDELETE /v2/{api_token}/quote/{id}

Show

Vendor Partnumbers

Vendor partnumbers (VPN) allow you to associate one item in your item master with multiple vendor partnumbers. The VPN are shown to the user during quoting and purchasing activities or other interactions with vendors to help match your item master with theirs for clarity.

Endpoints

  POST /v2/{api_token}/vendor_partnumberDELETE /v2/{api_token}/vendor_partnumber/{id}

Show

Inventory location

An inventory location (also known as a warehouse) is a physical location where item inventory is stored. Certain functionality is limited to the scope of one location.

Endpoints

  POST /v2/{api_token}/inventory_location   GET /v2/{api_token}/inventory_location/{id}   PUT /v2/{api_token}/inventory_location/{id}DELETE /v2/{api_token}/inventory_location/{id}   GET /v2/{api_token}/inventory_location

Show

Inventory sublocation

Inventory Locations are the physical places where your inventory will exist. Each inventory location is further organized with sublocations. Sublocations are just subdivisions of an inventory storage location.

Endpoints

  POST /v2/{api_token}/inventory_sublocation   GET /v2/{api_token}/inventory_sublocation/{id}   PUT /v2/{api_token}/inventory_sublocation/{id}DELETE /v2/{api_token}/inventory_sublocation/{id}

Show

Inventory unit

The InventoryUnit object represents a single record of inventory stored at a particular inventory location and sublocation.

Quantity Notes

Quantity specified for each inventory unit is always stored in reference to the unit of measure of the parent Part. Quantity properties with the _base suffix represent values in this UoM.

If a “display unit” is specified for the InventoryUnit, then this is the UoM that is shown to the user in inventory listings. This is a convenience measure and conversion is performed at display time.

Quantity properties that do not have the _base suffix are in reference to the “display unit”, if specified, or the Part's UoM otherwise.

Deprecation Notice

Future versions of the API will report quantities in the Part UoM and will handle display unit quantities differently.

Endpoints

  POST /v2/{api_token}/parts/{part_id}/inventory_units   GET /v2/{api_token}/parts/{part_id}/inventory_units/{id}   PUT /v2/{api_token}/parts/{part_id}/inventory_units/{id}   PUT /v2/{api_token}/parts/{part_id}/inventory_units/{id}/adjust_quantity   PUT /v2/{api_token}/parts/{part_id}/inventory_units/{id}/move  POST /v2/{api_token}/parts/{part_id}/inventory_units/{id}/split   GET /v2/{api_token}/inventory_units/search   GET /v2/{api_token}/inventory_units

Show

Contacts

Contacts are specific individuals (people) and can be associated with multiple manufacturers and up to one vendor. When you submit RFQs or purchase orders, you need to submit them to contacts at the corresponding vendor.

Endpoints

  POST /v2/{api_token}/contact   GET /v2/{api_token}/contact/{id}   PUT /v2/{api_token}/contact/{id}DELETE /v2/{api_token}/contact/{id}   GET /v2/{api_token}/contact

Show

Customers

The Customer object is not presently used in conjunction with any other record in Aligni. For now, it is only available for your own record keeping.

Endpoints

  POST /v2/{api_token}/customer   GET /v2/{api_token}/customer/{id}   PUT /v2/{api_token}/customer/{id}DELETE /v2/{api_token}/customer/{id}   GET /v2/{api_token}/customer

Show

Linecard

A Linecard represents a vendor’s list of manufacturers
whose parts they sell. Multiple manufacturers may be on the linecard
for each vendor. There will be a Linecard object representing
each of these instances.

Endpoints

  POST /v2/{api_token}/linecardDELETE /v2/{api_token}/linecard

Show

Manufacturer

The Manufacturer object represents the real world manufacturers that
make the parts in your item master.

Endpoints

  POST /v2/{api_token}/manufacturer   GET /v2/{api_token}/manufacturer/{id}   PUT /v2/{api_token}/manufacturer/{id}DELETE /v2/{api_token}/manufacturer/{id}   GET /v2/{api_token}/manufacturer

Show

Vendor

Vendors are the entities that sell parts to you. A vendor is said to be
a distributor for a manufacturer if it sells its parts. A manufacturer
that they represent is considered to be on the vendor’s linecard.

Endpoints

  POST /v2/{api_token}/vendor   GET /v2/{api_token}/vendor/{id}   PUT /v2/{api_token}/vendor/{id}DELETE /v2/{api_token}/vendor/{id}   GET /v2/{api_token}/vendor

Show

Purchase Orders

TBD: TOC description

Endpoints

   GET /v2/{api_token}/purchase_orders/{id}   GET /v2/{api_token}/purchase_orders

Show

PartType

Part types are the categories of Parts in your item master. They are used to create a taxonomy of items to make it easier for your organization to maintain the item master. You can create as many part types as necessary, but we suggest keeping this to a minimal set to be easier to maintain.

Endpoints

  POST /v2/{api_token}/parttype   GET /v2/{api_token}/parttype/{id}   PUT /v2/{api_token}/parttype/{id}DELETE /v2/{api_token}/parttype/{id}   GET /v2/{api_token}/parttype

Show

Part Parameter Field

TBD: TOC description

Endpoints

   GET /v2/{api_token}/part_parameter_field

Show

Units of Measure

Units of Measure (UoM) are provided by Aligni to declare the standard of measurement for quantities in your item master.

Endpoints

  POST /v2/{api_token}/unit   GET /v2/{api_token}/unit/{id}   PUT /v2/{api_token}/unit/{id}DELETE /v2/{api_token}/unit/{id}   GET /v2/{api_token}/unit

Show

Unit Conversion

In situations where Aligni needs to convert from one unit of measure to another, unit conversions are applied. A unit conversion is a single numerical factor applied to one UoM to translate to another UoM. The reciprocal factor is used to translate in the reverse direction.

Endpoints

  POST /v2/{api_token}/unit_conversionDELETE /v2/{api_token}/unit_conversion/{id}

Show