API DOCUMENTATION
    Try Unleashed Now Sandbox

    Warehouse Stock Transfers

    The WarehouseStockTransfers resource allows Warehouse Stock transfers to be listed, created, updated, completed and deleted. An individual Warehouse Stock Transfer details can be viewed by appending its WarehouseTransferNumber to the URI. Warehouse Stock Transfers can be completed, updated and deleted 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 Warehouse Stock Transfers GET /WarehouseStockTransfers
    View a Warehouse Stock Transfer with the specified Guid GET /WarehouseStockTransfers/{transferGuid}
    GET /WarehouseStockTransfers/{transferNumber}
    Create a new Warehouse Stock Transfer POST /WarehouseStockTransfers
    Create a new line to a Warehouse Stock Transfer POST /WarehouseStockTransfers/{transferGuid}/Lines
    Complete an existing Warehouse Stock Transfer POST /WarehouseStockTransfers/{transferGuid}/Complete
    Update an existing Warehouse Stock Transfer and existing lines PUT /WarehouseStockTransfers/{transferGuid}
    Update an existing line of a Warehouse Stock Transfer PUT /WarehouseStockTransfers/{transferGuid}/Lines/{lineGuid}
    Delete a Parked Warehouse Stock Transfer DELETE /WarehouseStockTransfers/{transferGuid}
    Delete existing line of a Warehouse Stock Transfer DELETE /WarehouseStockTransfers/{transferGuid}/Lines/{lineGuid}

    GET Warehouse Stock Transfers

    Available Filters for GET Warehouse Stock Transfers
    Filter Description
    modifiedSince Returns Warehouse Stock Transfers created or modified the specified date.
    pageSize Specifies the page size for pagination. Default page size is 200 Warehouse Stock Transfers.

    Note: Requesting large numbers of stock transfers can be susceptible to poor network performance. Please reduce the page size if you experience delayed requests.
    transferStatus If the filter is not provided, returns all orders including deleted Warehouse Stock Transfers.
    Returns Warehouse Stock Transfers with the specified status. Multiple selection can be specified as comma separated. For example: transferStatus=Parked,Completed.
    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:
    • /WarehouseStockTransfers?pageSize=100 - returns a page
    • /WarehouseStockTransfers?transferStatus=Parked - returns a list of Warehouse Stock Transfers in a Parked status
    Available Fields for GET Warehouse Stock Transfers
    Property Type Length Notes
    Comments String 1024
    CreatedBy String 50
    CreatedOn DateTime
    DeliveryDate DateTime UTC timezone only
    DestinationWarehouse Warehouse
    Guid Guid Unique identifier
    LastModifiedBy String 50
    LastModifiedOn Nullable DateTime
    OrderDate DateTime UTC timezone only
    SourceWarehouse Warehouse
    TransferDetails TransferDetail collection
    TransferOrderNumber String 20
    TransferStatus String 20
    Available Fields for Transfer Details
    Property Type Length Notes
    AvailableQuantity Decimal
    AverageLandedPriceAtTimeOfTransfer Nullable Decimal
    Comments String 1024
    DestinateWarehouseStockOnHandBeforeTransfer Nullable Decimal
    DestinationWarehouseId Integer
    DestinationWarehouseLocationId Nullable Integer
    LineNumber Integer
    Product Product
    ReceiptFIFODate DateTime UTC timezone only
    SourceWarehouseId Integer
    SourceWarehouseStockOnHandBeforeTransfer Nullable Decimal
    TransferOrderId Integer
    TransferQuantity Decimal
    WarehouseLocationId Integer
    WarehouseProductCode String 100
    WarehouseProductId Integer
    Available Fields for Product
    Property Type Length
    Guid Guid
    ProductCode String 100
    Available Fields for Source and Destination Warehouse
    Property Type Length
    AddressLine1 String 500
    AddressLine2 String 500
    City String 500
    ContactName String 50
    Country String 500
    DDINumber String 25
    FaxNumber String 25
    Guid Guid
    IsDefault Boolean true, false
    LastModifiedOn Nullable DateTime
    MobileNumber String 25
    Obsolete Boolean true, false
    PhoneNumber String 25
    PostCode String 500
    Region String 500
    StreetNo String 500
    Suburb String 500
    WarehouseCode String 15
    WarehouseName String 100

    Examples for Response GET /WarehouseStockTransfers

    show xml example
    show json example

    Examples for Response GET /WarehouseStockTransfers/{TransferOrderNumber}

    show xml example
    show json example

    POST / PUT Warehouse Stock Transfer

    Warning: Post / Put does not accept user generated GUID.

    Available Fields for POST / PUT Warehouse Stock Transfers

    Note: If one of the editable fields for PUT is blank, the previous value will be overwritten with the blank value.

    Property Type Length POST PUT
    Comments String 1024 Optional Optional
    DestinationWarehouse Warehouse Required Required
    Guid Guid N/A Required
    SourceWarehouse Warehouse Required Required
    TransferDetails TransferDetail collection Required Required
    Available Fields for Warehouse

    Note: At a minimum, a valid Guid or WarehouseCode is required.

    Property Type Length POST PUT
    Guid Guid Optional Optional
    WarehouseCode String 15 Optional Optional
    Available Fields for Transfer Details
    Property Type Length POST PUT
    Comments String 1024 Optional Optional
    Guid Guid N/A Required
    Product Product Required N/A
    TransferQuantity Decimal Required Required
    Available Fields for Product

    Note: At a minimum, a valid Guid or ProductCode is required.

    Property Type Length POST PUT
    Guid Guid Optional N/A
    ProductCode String 100 Optional N/A

    Examples for Request POST /WarehouseStockTransfers

    show xml example
    show json example

    Examples for Request PUT /WarehouseStockTransfers/{TransferGuid}

    show xml example
    show json example

    POST / PUT Warehouse Stock Transfer Lines

    Available Fields for POST / PUT Warehouse Stock Transfer Lines
    Property Type Length Notes POST PUT
    Comments String 1024 Optional Optional
    Guid Guid N/A Required
    Product Product Required N/A
    TransferQuantity Decimal Must be greater than zero Required Required
    Available Fields for Product

    Note: At a minimum, a valid Guid or ProductCode is required.

    Property Type Length POST PUT
    Guid Guid Optional Optional
    ProductCode String 100 Optional Optional

    Examples for Request POST /WarehouseStockTransfers/{TransferGuid}/Lines

    show xml example
    show json example

    Examples for Request PUT /WarehouseStockTransfers/{TransferGuid}/Lines/{LineGuid}

    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.