API DOCUMENTATION
    Try Unleashed Now Sandbox

    Serial Numbers

    The SerialNumbers resource allows serial numbers to be listed. An individual serial number’s details can be viewed by appending its identifier (a GUID formatted as XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX) to the URI.

    The full range of URIs and HTTP Verbs supported are:

    Operation HTTP Action
    List a page of Serial Numbers GET /SerialNumbers
    View a Serial Number with the specified Guid GET /SerialNumbers/{serialNumberGuid}

    GET SerialNumbers

    Available Filters for GET Serial Numbers
    Filter Description
    available If set to false, returns all serial numbers. Default value is true and returns only the available serial numbers.
    endDate Returns serial numbers created before a specified date.
    modifiedSince Returns serial numbers created or edited after a specified date.
    pageSize Specifies the page size for pagination. Default page size is 200 serial numbers.

    Note: Requesting large numbers of serial numbers can be susceptible to poor network performance. Please reduce the page size if you experience delayed requests.
    productCode Returns serial numbers attached to the product code.
    serialNumber Returns a list of serial numbers containing this string.
    startDate Returns serial numbers created after a specified date.
    warehouseCode Returns serial numbers attached to the warehouse.
    Note: Date filters should be provided in the ISO format YYYY-MM-DD.

    Filters are used by adding the filter and value to the URI:
    • /SerialNumbers?startDate=2012-01-01
    Available Fields for GET Serial Numbers
    Field Type Length
    CreatedBy String 50
    CreatedOn Date
    Guid Guid
    LastModifiedBy String 50
    LastModifiedOn Date
    ProductCode String 100
    SerialNumber (XML) / Identifier (JSON) String 50
    Status String 20
    WarehouseCode String 15

    Examples for Response GET /SerialNumbers

    show xml example
    show json example

    Use the API Sandbox to see how the object is rendered in JSON or XML.

    Note: An Unleashed account is required before you can use the API Sandbox.

    Trial accounts are also allowed to connect to the API.
    You can register a new account here: Register.