Overview

The inventory/transfer/location-license-plate endpoint is for whole-unit moves. It transfers either the entire contents of a location or one specific LP (license plate) from that location to a new destination.

To move a specific quantity of one product, use API Guide: Transfer Product instead.

When to use it

An automated system relocates full pallets (LPs) and needs Logiwa IO to follow.
You empty a staging location into storage in one call.
You consolidate everything in a location onto a single LP.

Endpoint details

URL:v3.1/inventory/transfer/location-license-plateMethod:POST

Request body parameters

Every request needs a source location. Add a source LP to move only that LP. If you don't give an LP, everything in the source location moves.

Parameter	Type	Required	Description
`clientIdentifier`	String	Yes	The unique identifier for the client account.
`sourceWarehouseIdentifier`	String	Yes	The warehouse where the transfer happens.
`sourceWarehouseLocationIdentifier` or `sourceWarehouseLocationCode`	String	Yes	The location inventory moves from.
`sourceLicensePlateIdentifier` or `sourceLicensePlateNumber`	String	No	Optional. Move only this LP from the source location. If omitted, the whole location's contents move.
`targetWarehouseLocationIdentifier` or `targetWarehouseLocationCode`	String	Yes	The destination location.
`targetLicensePlateIdentifier` or `targetLicensePlateNumber`	String	No	Optional. The destination LP, when consolidating into an LP. The LP must already exist; a new LP number isn't created

Alternative human-readable identifiers

Parameter	Description
`clientDisplayName`	Display name of the client.
`sourceWarehouseCode`	Code of the source warehouse.
`sourceWarehouseLocationCode`	Code of the source location.
`sourceLicensePlateNumber`	Number of the source LP.
`targetWarehouseLocationCode`	Code of the target location.
`targetLicensePlateNumber`	Number of the target LP.

What moves where

The endpoint follows the same rules as Transfer LP and Transfer Location on the web app:

Source	Target	Result
LP	Location	The LP moves with everything on it
LP	Parent LP	The LP is placed on the parent LP
LP	Another LP	Only the contents move; the source LP is left empty
Parent LP	Location	The parent LP moves with all its child LPs
Parent LP	Another parent LP or an LP	Only the contents move; the source parent LP is left empty
Location (no LP given)	Location or LP	Everything in the location moves

Auto Remove LP After Transfer

Locations can have the Auto Remove LP After Transfer setting (also available as IsAutoRemoveLpAfterTransfer on the Open API location endpoints). This endpoint applies it only when you move an LP into a location:

Source	Target	Setting on target location	Result
LP	Location	On	Stock is stored at the location without the LP
LP	Location	Off	Stock stays on the LP (standard)
LP	LP	Any	Setting ignored; stock stays on an LP
Location (no LP given)	Location	Any	Setting ignored; LPs move as they are
Location	LP	Any	Setting ignored
Parent LP	Location or LP	Any	Setting ignored; the parent LP and its child LPs are kept

The source LP isn't deleted. If all its stock moved, it stays in the system with a quantity of 0 and can be reused.

Example: PICK-A-01 has Auto Remove LP After Transfer turned on. You send sourceLicensePlateNumber: "LPN-0012345" from RECEIVING-DOCK-1 to PICK-A-01. The 24 units arrive at PICK-A-01 as loose stock, and LPN-0012345 remains with quantity 0.

See Auto Remove LP After Transfer for how to turn the setting on.

Example requests

1. Move an entire location's contents to a new location

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

2. Move a specific LP from a location

Finds LP LPN-0012345 in RECEIVING-DOCK-1 and moves the whole LP to RACK-A-01-B.

{
  "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 LP

Takes everything in STAGING-01 and places it on LP LPN-FOR-ORDER-9876 at PACK-STATION-5.

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

Responses

Success: HTTP 200 OK:

{ "value" : true }

Failure:400 Bad Request with a validation error. Example when neither targetWarehouseLocationIdentifier nor targetWarehouseLocationCode is sent:

{
  "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: summary that validation failed.
data: the list of field errors.
property: the request field that failed.
errorMessage: a key describing the rule that was broken.

Common questions

Can I convert cases to units with this endpoint? No. Pack type conversion isn't available for whole-LP or whole-location moves. Use API Guide: Transfer Product with breakHigherPackTypeToUom.

Does Auto Remove LP After Transfer apply when I move a whole location? No. It only applies when you send a source LP and the target is a location.

What happens to the LP record after Auto Remove LP? It stays in the system with quantity 0. It isn't deleted.

API Guide: Transfer Location or License Plate