API Guide: Transfer Location or License Plate

Overview

This article describes how to use the inventory/transfer/location-license-plate API endpoint. This endpoint is designed for bulk inventory moves. It allows you to transfer either the entire contents of a location or a specific LPN from within that location to a new destination.

This is different from the transfer/product API, which moves a specific quantity of a single product.

Endpoint Details

URL: v3.1/inventory/transfer/location-license-plate

Method: POST

Request Body Parameters

In each request, you must specify a sourceWarehouseLocation. You can optionally provide a sourceLicensePlate to move only that specific LPN from the source location. If no LPN is specified, the entire location's contents will be transferred.

Parameter	Type	Required	Description
`clientIdentifier`	String	Yes	The unique identifier for the client account.
`sourceWarehouseIdentifier`	String	Yes	The identifier of the warehouse where the transfer occurs.
`sourceWarehouseLocationIdentifier` or `sourceWarehouseLocationCode`	String	Yes	The source location from which inventory will be moved.
`sourceLicensePlateIdentifier` or `sourceLicensePlateNumber`	String	No	Optional. Specify an LPN to move only that LPN from the source location. If omitted, all contents of the source location will be moved.
`targetWarehouseLocationIdentifier` or `targetWarehouseLocationCode`	String	Yes	The destination location where the inventory will be moved.
`targetLicensePlateIdentifier` or `targetLicensePlateNumber`	String	No	Optional. The destination LPN. Use this if you are consolidating inventory into a new or existing LPN.

Alternative Human-Readable Identifiers

For convenience, you can use human-readable codes or numbers instead of the system's GUID Identifier for most fields.

Parameter	Type	Description
`clientDisplayName`	String	The display name of the client.
`sourceWarehouseCode`	String	The code for the source warehouse.
`sourceWarehouseLocationCode`	String	The code for the source location.
`sourceLicensePlateNumber`	String	The number of the source LPN.
`targetWarehouseLocationCode`	String	The code for the target location.
`targetLicensePlateNumber`	String	The number of the target LPN.

Example Requests

1. Move an Entire Location's Contents to a New Location

This example moves all inventory from the STAGING-01 location to the BULK-STORAGE-A location.

{
  "clientIdentifier": "69205154-6C72-440C-ACC1-8F207CC3092D",
  "sourceWarehouseCode": "WH1",
  "sourceWarehouseLocationCode": "STAGING-01",
  "targetWarehouseLocationCode": "BULK-STORAGE-A"
}

2. Move a Specific LPN from a Location

This example finds LPN LPN-0012345 within the RECEIVING-DOCK-1 location and moves the entire LPN to the RACK-A-01-B location.

{
  "clientIdentifier": "69205154-6C72-440C-ACC1-8F207CC3092D",
  "sourceWarehouseCode": "WH1",
  "sourceWarehouseLocationCode": "RECEIVING-DOCK-1",
  "sourceLicensePlateNumber": "LPN-0012345",
  "targetWarehouseLocationCode": "RACK-A-01-B"
}

3. Move an Entire Location's Contents into an LPN

This example takes all items from the STAGING-01 location and "packs" them into a new LPN, LPN-FOR-ORDER-9876, at the PACK-STATION-5 location.

{
  "clientIdentifier": "69205154-6C72-440C-ACC1-8F207CC3092D",
  "sourceWarehouseCode": "WH1",
  "sourceWarehouseLocationCode": "STAGING-01",
  "targetWarehouseLocationCode": "PACK-STATION-5",
  "targetLicensePlateNumber": "LPN-FOR-ORDER-9876"
}

4. Unpack (Decant) an LPN into a Location

This example takes all the inventory inside LPN LPN-0012345 and moves it to location PICK-BIN-07 as loose inventory, leaving the source LPN empty.

{
  "clientIdentifier": "69205154-6C72-440C-ACC1-8F207CC3092D",
  "sourceWarehouseCode": "WH1",
  "sourceWarehouseLocationCode": "STAGING-02",
  "sourceLicensePlateNumber": "LPN-0012345",
  "targetWarehouseLocationCode": "PICK-BIN-07"
}

Success Response

A successful request will return an HTTP status code 200 OK and a confirmation value.

{ "value" : true }

Failed Response

If the request fails due to missing or invalid data, the API will return a 400 Bad Request status and a detailed validation error.

Example Validation Error

This error occurs when a user provides neither the targetWarehouseLocationIdentifier nor the targetWarehouseLocationCode.

{
  "message" : "One or more validation errors occurred.",
  "data" : [ {
    "property" : "TargetWarehouseLocationIdentifier",
    "errorMessage" : "Logiwa.Wms.Error.Validation.Inventory.Transfer.TargetWarehouseLocationIdentifier.CannotBeEmpty.WhenTargetWarehouseLocationCodeIsEmpty"
  } ],
  "code" : "validation",
  "status" : 2
}

message: A general summary that a validation error occurred.
data: An array containing the specific field errors.
property: The parameter in your request body that failed validation.
errorMessage: A detailed error key that explains the exact rule that was violated.

Transfer from Inventory by Location

Batch Picking & Sorting Process

API Guide: Complete a Picking Task by Using API

API Guide: Complete a Sorting Task by Using API

API Guide: Transfer Product