v1

latestOpenAPI 3.1.02026-08-0420819698.7 KB
Routes
Parts
Vendor Associations

Get Part Vendor Associations

Returns a paginated list of vendor-part associations for the customer.

Note: this endpoint supports both cursor-based and page-based pagination. Please refer to the Pagination section for more information.

Return data description

Property: relationID, Description: The unique ID of this vendor-part association. Property: partID, Description: The ID of the associated part. Property: vendorID, Description: The ID of the associated vendor. Property: vendorPartNumber, Description: The vendor's part number for this part, if provided. Property: partPrice, Description: The vendor's price for this part, if provided. Property: createdAt, Description: Unix timestamp of when this association was created. Property: updatedAt, Description: Unix timestamp of when this association was last updated. Property: partName, Description: The name of the associated part. Property: number, Description: The part's internal part number. Property: locationID, Description: The ID of the location this part belongs to. Property: vendorName, Description: The name of the associated vendor.

get/v2/parts/vendors/associations

Query parameters

partsstring

This parameter is used to only get associations for specific parts. This parameter accepts a comma delimited list of part IDs.

vendorsstring

This parameter is used to only get associations for specific vendors. This parameter accepts a comma delimited list of vendor IDs.

vendorPartNumberstring

This parameter is used to search for associations by vendor part number. This parameter expects a string with the wildcard % for partial matching.

vendorNamestring

This parameter is used to search for associations by vendor name. This parameter expects a string with the wildcard % for partial matching.

startinteger

This parameter is used to only get associations that were last updated after the unix timestamp passed into the start parameter.

endinteger

This parameter is used to only get associations that were last updated before the unix timestamp passed into the end parameter.

cursorinteger

This parameter is a cursor that selects what relationID you want to start receiving results at. This will return results with a relationID greater than the value of cursor.

limitinteger

This parameter is a result limiter. The default is set to return no more than 100 results at one time. Supports up to 1000 results.

orderBystring

This parameter is used to order results. Accepted values: relationID, -relationID, createdAt, -createdAt, updatedAt, -updatedAt, partName, -partName, vendorName, -vendorName. Prefix with - for descending order.

pageinteger

This parameter is used to paginate results based on the limit. Refer to Pagination section for more information.

Response

Get Part Vendor Associations

relationIDinteger
partIDinteger
vendorIDinteger
vendorPartNumberstring
partPricenumber
createdAtinteger
updatedAtinteger
partNamestring
numberstring
locationIDinteger
vendorNamestring