Routes
Parts
Vendor Associations

Get Part Vendor Associations

Changed on

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

PropertyDescription
relationIDThe unique ID of this vendor-part association.
partIDThe ID of the associated part.
vendorIDThe ID of the associated vendor.
vendorPartNumberThe vendor's part number for this part, if provided.
partPriceThe vendor's price for this part, if provided.
createdAtUnix timestamp of when this association was created.
updatedAtUnix timestamp of when this association was last updated.
partNameThe name of the associated part.
numberThe part's internal part number.
locationIDThe ID of the location this part belongs to.
vendorNameThe name of the associated vendor.
get/v2/parts/vendors/associations

Request

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. Maximum allowed value is 1000. 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

Changes

    • warning

      for the query request parameter limit, the max was set to 1000.00

    • warning

      for the query request parameter limit, the min was set to 1.00

    • info

      added the non-success response with the status