Try Unleashed Now Sandbox

    Serial Numbers

    • The SerialNumbers resource allows you to manage serial numbers on sales orders and sales shipments.
    • An individual serial number details can be viewed by appending its identifier (a GUID formatted as XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX) to the URI. For example: /SerialNumbers/7033d0cb-999d-4ea9-b5f4-23481006f5f0.
    • The pageNumber parameter can be used to view the requested page with 200 records displayed. For example: /SerialNumbers/1.
    • The Page parameter can be used to view the requested page with 200 records displayed. For example: /SerialNumbers/Page/3.

    The full range of URIs and HTTP Verbs supported are:

    Operation HTTP Action
    List all serial numbers. GET /SerialNumbers
    View the serial number with the specified Guid. GET /SerialNumbers/{Guid}
    View the serial numbers for a specific page. GET /SerialNumbers/{pageNumber}
    GET /SerialNumbers/Page/{pageNumber}

    GET SerialNumbers

    The following filters can be used with the GET SerialNumbers endpoint by adding the filter and value to the URI.

    For example: /SerialNumbers?pageSize=100

    Filter Description
    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.
    WarehouseCode Returns serial numbers attached to the warehouse.
    startDate Returns serial numbers created after a specified date.
    endDate Returns serial numbers created before a specified date.
    modifiedSince Returns serial numbers created or edited after a specified date. For example: modifiedSince=2016-07-01, modifiedSince=2016-07-01T19:54:18.060.
    serialNumber Returns a list of serial numbers containing this string.
    available If set to false, returns all serial numbers. Default value is true and returns only the available serial numbers.

    Available Fields for SerialNumbers:

    Field Type Length
    Guid Guid  
    SerialNumber String 50
    ProductCode String 100
    WarehouseCode String 15
    Status String 20
    LastModifiedBy String 50
    LastModifiedOn Date  
    CreatedBy String 50
    CreatedOn Date  

    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.