Request

Response

    Retrieve the inventory of a Product
    GET

    products/{productId}/inventory

    Retrieves the inventory by Product, plus a list of quantities of the Product by lot. The lot filter is optional and it does not affect the total quantity returned for the Product.

    Resource Information

    Method and URI
    GET
    https://api.aps.autodesk.com/fusion-operations/v2/products/{productId}/inventory
    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.

    Response

    HTTP Status Code Summary

    200
    OK
    Success
    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
    oneOf
    one of
    0
    object
    Simple aggregate inventory. Returned when groupBy is not specified.
    quantity
    int
    1
    object
    Paginated grouped inventory. Returned when groupBy is specified.
    results
    array: object
    Grouped inventory entries for the selected grouping dimensions.
    quantity
    int
    Quantity available for this grouped entry.
    groupBy
    object
    Contains the dimensions for this inventory grouping. Which properties are present depends on the groupBy parameter.
    lot
    id
    int
    Unique identifier of the lot.
    code
    string
    Max length: 255
    expirationDate
    string
    Expiration date of the lot (e.g. 2025-06-21)
    supplierLot
    string
    Max length: 255
    anyOf
    0
    1
    warehouseLocation
    id
    int
    Unique identifier of the warehouse location.
    code
    string
    Max length: 255
    name
    string
    Max length: 255
    warehouse
    id
    int
    Unique identifier of the warehouse.
    code
    string
    Max length: 255
    name
    string
    Max length: 255
    site
    Site associated with the Inventory Movement.
    id
    int
    Unique identifier of the referenced entity.
    code
    string
    Code of the referenced entity.

    Max length: 255

    anyOf
    Site associated with the Inventory Movement.
    0
    1
    anyOf
    0
    1
    anyOf
    0
    1
    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

    Success

    Request

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

    Response

    {
      "quantity": 148
    }