v1

latestOpenAPI 3.1.02026-08-0420819698.7 KB
Routes
Parts
Purchasables

Get Purchasables

This endpoint makes an HTTP GET request to retrieve a part's purchasable data. The response of this request is documented as a JSON schema.

Return data description

PropertyDescription
partIDThe ID of the part the purchasable belongs to.
nameThe name of the purchasable.
sizeThe size of the purchasable.
orderUnitCodeThe unit that describes how this purchasable is ordered. E.g. "by the box", or "by the foot".
sizeUnitCodeThe unit that qualifies the size value. E.g. this tells you whether this purchasable is 10 liters, or cans, or feet, etc.
get/v2/parts/{partID}/purchasables

Query parameters

pageinteger

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

limitinteger

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

nameStartsWithstring

Filter purchasables that have a name which starts with this string.

Response

Get Purchasables

purchasableIDinteger
partIDinteger
namestring
sizeinteger
orderUnitCodestring
sizeUnitCodestring