Request

Response

    Retrieve Product by id
    GET

    products/{productId}

    Fetches a single Product identified by the specified unique Product id.

    Resource Information

    Method and URI
    GET
    https://api.aps.autodesk.com/fusion-operations/v2/products/{productId}
    Authentication Context
    No security required
    Required OAuth Scopes
    data:read data:write
    Data Format
    JSON

    Request

    Headers

    Authorization*
    string
    JWT Access Token
    * Required

    Request

    URI Parameters

    productId
    int
    The unique identifier of the Product to retrieve.

    Response

    HTTP Status Code Summary

    200
    OK
    The requested Product entity.
    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.
    404
    Not Found
    The resource in the path does not exist.
    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
    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.

    Example

    The requested Product entity.

    Request

    curl -v 'https://developer.api.autodesk.com/fusion-operations/v2/products/:productId' \
      -H 'Authorization: '
    

    Response

    {
      "id": 2,
      "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
    }
    
    Show More