Retrieve Products
GET
products
Retrieves a paginated list of all Products, optionally filtered and sorted. When additional results are available, the pagination object in the response payload provides a “nextUrl” that links to the next page of results.
Resource Information
| Method and URI | GET https://api.aps.autodesk.com/fusion-operations/v2/products |
| Authentication Context | No security required |
| Required OAuth Scopes | data:read data:write |
| Data Format | JSON |
Request
Headers
| Authorization* string | JWT Access Token |
* Required
Request
Query String Parameters
| filter[id] int | Filter Products matching the specified id. |
| filter[code] string | Filter Products matching the specified code. Pass the value as URL‑encoded. |
| filter[productFamily.id] int | Filter Products by Product Family providing family’s id. |
| filter[productFamily.code] string | Filter Products by Product Family code. Pass the value as URL‑encoded. |
| filter[disabled] boolean | Filter Products by status. If true, returns only disabled Products; if false or omitted, returns only enabled Products. |
| limit int | Maximum number of results returned. Defaults to 25. |
| offset int | Page offset. Default value is 0. |
| sort string | Comma separated fields to sort items by. Fields: id, code. Default: “id desc”. |
Response
HTTP Status Code Summary
| 200 OK | A list of Products. |
| 400 Bad Request | Bad request due to invalid data. |
| 401 Unauthorized | The access token is invalid. It may have either expired or may not be a three-legged access token. Please verify the token and retry the request. |
| 403 Forbidden | The request was successfully validated but lacked required permission. Please verify your token permissions and retry the request. |
| 429 Too Many Requests | Rate limit exceeded; wait some time before retrying. |
| 500 Internal Server Error | An unknown server-side error occurred. Please try again later. If the problem persists, please contact support. |
Response
Header (429)
| Retry-After integer | The number of seconds to wait before retrying the request. |
Response
Body Structure (200)
Expand all
| results array: object | List of Products |
| id int | Unique identifier of the product. |
| code string | Unique product code used to identify the Product.
Max length: 255 |
| name string | Product display name.
Max length: 255 |
| observations string | Short observation text for the Product.
Max length: 255 |
| unitCost number | Cost per unit of the Product. |
| unitPrice number | Sale price per unit of the Product. |
| families array: object | Product Families associated with this Product. |
| id int | Unique identifier of the referenced entity. |
| code string | Code of the referenced entity.
Max length: 255 |
| name string | Name of the referenced entity.
Max length: 255 |
| anyOf | |
| 0 | |
| 1 | |
| section string | |
| specsSheetImages array: object | References to Product specification sheet images. |
| id int | Unique identifier of the referenced entity. |
| name string | Name of the referenced entity.
Max length: 255 |
| anyOf | |
| 0 | |
| 1 | |
| operations array: object | Operations linked to this Product. |
| id int | Unique identifier of the referenced entity. |
| code string | Code of the referenced entity.
Max length: 255 |
| name string | Name of the referenced entity.
Max length: 255 |
| anyOf | |
| 0 | |
| 1 | |
| variableParameters array: object | Variable parameters available for this Product. |
| id int | Unique identifier of the variable parameter. |
| name string | |
| type object | Possible values: NUMERIC, TEXT, SINGLE_SELECT, SIGNATURE, IMAGE |
| notes string | Long-form notes for this Product.
Max length: 5000 |
| boxQuantity int | Quantity of units per box. |
| materialReceivingCheckList | |
| id int | Unique identifier of the referenced entity. |
| code string | Code of the referenced entity.
Max length: 255 |
| name string | Name of the referenced entity.
Max length: 255 |
| anyOf | |
| 0 | |
| 1 | |
| standardUnitOfMeasurement | |
| id int | Unique identifier of the referenced entity. |
| code string | Code of the referenced entity.
Max length: 255 |
| name string | Name of the referenced entity.
Max length: 255 |
| anyOf | |
| 0 | |
| 1 | |
| purchaseOrderUnitOfMeasurement | |
| id int | Unique identifier of the referenced entity. |
| code string | Code of the referenced entity.
Max length: 255 |
| name string | Name of the referenced entity.
Max length: 255 |
| anyOf | |
| 0 | |
| 1 | |
| unitOfMeasurementGroup | |
| id int | Unique identifier of the referenced entity. |
| code string | Code of the referenced entity.
Max length: 255 |
| name string | Name of the referenced entity.
Max length: 255 |
| anyOf | |
| 0 | |
| 1 | |
| weight number | Weight value for one unit of this Product. |
| weightUnitOfMeasurement | |
| id int | Unique identifier of the referenced entity. |
| code string | Code of the referenced entity.
Max length: 255 |
| name string | Name of the referenced entity.
Max length: 255 |
| anyOf | |
| 0 | |
| 1 | |
| disabled boolean | Indicates whether the Product is disabled. |
| color string | Hexadecimal(e.g. |
| suppliers array: object | Supplier mappings for this Product. |
| supplier | |
| id int | Unique identifier of the referenced entity. |
| code string | Code of the referenced entity.
Max length: 255 |
| name string | Name of the referenced entity.
Max length: 255 |
| anyOf | |
| 0 | |
| 1 | |
| supplierProductCode string | Supplier-specific code for this Product.
Max length: 255 |
| minimumInventory number | Minimum preferred inventory level. |
| maximumInventory number | Maximum preferred inventory level. |
| minimumQuantityToReorder number | Inventory threshold that triggers reorder planning. |
| quantityMultiple number | Reorder quantity multiple to respect when replenishing stock. |
| scrapAllowance number | Percentage value between 0 and 100 |
| shelfLife int | Lead time in days |
| leadTime int | Lead time in days |
| parameters array: object | Additional name/value attributes for this Product. |
| name string | Parameter name. |
| value string | Parameter value. |
| serializable boolean | Only available when the setting serialization is enabled in the system settings. |
| automaticSerialNumber boolean | To activate automatic serial number generation a pattern must be defined in the system settings. |
| pagination object | |
| limit int | Maximum number of results returned in this page. |
| offset int | Number of results skipped before this page. |
| nextUrl string | URL for the next page of results. Null when there are no additional pages. |
Example
A list of Products.
Request
curl -v 'https://developer.api.autodesk.com/fusion-operations/v2/products' \
-H 'Authorization: '
Response
{
"results": [
{
"id": 45,
"code": "MySuperProd",
"name": "MySuperProduct",
"observations": "2025 version",
"unitCost": 45.4,
"unitPrice": 50.6,
"families": [
{
"id": 12,
"code": "Products 2025",
"name": "Products for year 2025"
}
],
"operations": [
{
"id": 2,
"code": "Setup",
"name": "Setup"
},
{
"id": 3,
"code": "Mounting",
"name": "Mounting"
}
],
"variableParameters": [
{
"id": 26,
"name": "Size",
"type": "NUMERIC"
}
],
"notes": "Notes limit is 5000 characters",
"boxQuantity": 4,
"materialReceivingCheckList": {
"id": 268,
"code": "SupplierCode"
},
"standardUnitOfMeasurement": {
"id": 3,
"code": "Each",
"name": "Each"
},
"purchaseOrderUnitOfMeasurement": {
"id": 3,
"code": "Each",
"name": "Each"
},
"unitOfMeasurementGroup": {
"id": 1,
"code": "Default UoM Group"
},
"weight": 6.3,
"weightUnitOfMeasurement": {
"id": 2,
"code": "Kg",
"name": "Kilogram"
},
"disabled": false,
"color": "#FFFFFF",
"suppliers": [
{
"id": 15,
"code": "Supplier QWERTY"
}
],
"minimumInventory": 0,
"maximumInventory": 50000,
"minimumQuantityToReorder": 50,
"quantityMultiple": 1,
"scrapAllowance": 10,
"shelfLife": 5,
"leadTime": 7,
"parameters": [
{
"name": "Voltage",
"value": "220V"
}
],
"serializable": false,
"automaticSerialNumber": false
},
{
"id": 50,
"code": "MySuperProd3",
"name": "MySuperProduct3",
"observations": "2025 version",
"unitCost": 45.4,
"unitPrice": 50.6,
"families": [
{
"id": 12,
"code": "Products 2025",
"name": "Products for year 2025"
}
],
"operations": [
{
"id": 2,
"code": "Setup",
"name": "Setup"
},
{
"id": 3,
"code": "Mounting",
"name": "Mounting"
}
],
"variableParameters": [
{
"id": 26,
"name": "Size",
"type": "NUMERIC"
}
],
"notes": "Notes limit is 5000 characters",
"boxQuantity": 4,
"materialReceivingCheckList": {
"id": 268,
"code": "SupplierCode"
},
"standardUnitOfMeasurement": {
"id": 3,
"code": "Each",
"name": "Each"
},
"purchaseOrderUnitOfMeasurement": {
"id": 3,
"code": "Each",
"name": "Each"
},
"unitOfMeasurementGroup": {
"id": 1,
"code": "Default UoM Group"
},
"weight": 6.3,
"weightUnitOfMeasurement": {
"id": 2,
"code": "Kg",
"name": "Kilogram"
},
"disabled": false,
"color": "#FFFFFF",
"suppliers": [
{
"id": 15,
"code": "Supplier QWERTY"
}
],
"minimumInventory": 0,
"maximumInventory": 50000,
"minimumQuantityToReorder": 50,
"quantityMultiple": 1,
"scrapAllowance": 10,
"shelfLife": 5,
"leadTime": 7,
"parameters": [
{
"name": "Voltage",
"value": "220V"
}
],
"serializable": false,
"automaticSerialNumber": false
}
],
"pagination": {
"limit": 20,
"offset": 0,
"nextUrl": null
}
}
Show More