Routes
Parts
Purchasables
Get Purchasables
Changed onThis 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
| Property | Description |
|---|---|
| partID | The ID of the part the purchasable belongs to. |
| name | The name of the purchasable. |
| size | The size of the purchasable. |
| orderUnitCode | The unit that describes how this purchasable is ordered. E.g. "by the box", or "by the foot". |
| sizeUnitCode | The 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
Request
- Base URL{{server}}:{{port}}
- AuthHTTP basic
- TypeScriptA function with typed inputs. Its response is checked against the schema.
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. Maximum allowed value is 1000.
nameStartsWithstring
Filter purchasables that have a name which starts with this string.
Response
Get Purchasables
Changes
- warning
for the
queryrequest parameterlimit, the max was set to1000.00 - warning
for the
queryrequest parameterlimit, the min was set to1.00 - info
added the non-success response with the status
- warning