API DOCUMENTATION
    Try Unleashed Now Sandbox

    Batch Numbers

    The BatchNumbers resource allows you to manage batch numbers on sales orders and sales shipments. An individual batch number 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 Batch Numbers GET /BatchNumbers
    View a Batch Number with the specified Guid GET /BatchNumbers/{batchNumberGuid}

    GET BatchNumbers

    Available Filters for GET BatchNumbers
    Filter Description
    available If set to false, returns all batch numbers. Default value is true and returns only the available batch numbers.
    batchNumber Returns a list of batch numbers containing this string.
    endDate Returns batch numbers created before a specified date.
    expiryFrom Returns batch numbers expired after a specified date.
    expiryTo Returns batch numbers expired before a specified date.
    modifiedSince Returns batch numbers created or edited after a specified date. For example: modifiedSince=2016-07-01, modifiedSince=2016-07-01T19:54:18.060.
    pageSize Specifies the page size for pagination. Default page size is 200 batch numbers.

    Note: Requesting large numbers of batch numbers can be susceptible to poor network performance. Please reduce the page size if you experience delayed requests.
    ProductCode Returns batch numbers attached to the product code.
    startDate Returns batch numbers created after a specified date.
    WarehouseCode Returns batch numbers attached to the warehouse.
    Filters are used by adding the filter and value to the URI:
    • /BatchNumbers?pageSize=100
    Available Fields for GET BatchNumbers
    Property Type Length
    BatchNumber String 50
    CreatedBy String 50
    CreatedOn Date
    ExpiryDate Date
    Guid Guid
    LastModifiedBy String 50
    LastModifiedOn Date
    OriginalQty Decimal
    ProductCode String 100
    Quantity Decimal
    Status String 20
    WarehouseCode String 15

    Examples for Response GET /BatchNumbers

    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.