Transfer Order

Transfer orders are used to move available inventory from one location to another. The transfer order can be based on a transfer request that has been previously created or be created from scratch. After the items are sent, the receiving store has to confirm the receipt of the items. The flow of the transfer order is as following:

The transfer order is created, either from scratch or from an incoming transfer request, and items are added to it.
The items are sent: at this point the inventory has been moved out from the sending store and is marked as in transit
When the receiving location gets the goods they mark it as received and the in transit inventory is moved to the receiving location.

The inventory/transfer-order endpoint in LS One API allows management of transfer orders and also posting and receiving existing orders.

Actions

GET	Get transfer order
GET	Get all transfer orders
POST	Search transfer orders
POST	Create a new transfer order
PUT	Update an existing transfer order
DELETE	Delete a transfer order
GET	Get transfer order line
GET	Get lines for specific transfer order
POST	Search transfer order lines for a transfer order
POST	Create a new transfer order line
PUT	Update an existing transfer order line
DELETE	Delete a transfer order line
POST	Post order
POST	Receive order

Properties

TransferOrder

Field	Data type	Validation	Description
id	string	-	Unique identifier of the transfer order
description	string	Required	Description of the transfer order
nventoryTransferRequestId	string	-	Unique identifier of the inventory transfer request
createdFromTransferRequest	boolean	-	Transfer order was created from a transfer request
sendingStoreId	string	Required	Identifier of the store to which the transfer order is assigned
sendingStoreName	string	-	Store name of the sending transfer order
receivingStoreId	string	Required	Receiving store id of the transfer order
receivingStoreName	string	-	Receiving store name of the transfer order
creationDate	datetime	-	Date when transfer order is created
receivingDate	datetime	-	Date when transfer order is received
sentDate	datetime	-	Date when transfer order is sent
expectedDelivery	datetime	Required	Date when transfer order is expected to be delivered
received	boolean	-	The receiving store has received the transfer and confirmed it
sent	boolean	-	Transfer order is sent
fetchedByReceivingStore	boolean	-	Transfer order is fetched by the receiving store
rejected	boolean	-	Transfer has been rejected by the receiving store
createdBy	string	-	Store name that has created the transfer order
createdByHeadOffice	boolean	-	The identifier of the store that created the order. This is an empty string if created by Head office
createdFromOmni	bool	-	Transfer order was created from the mobile inventory app
templateID	string	-	Unique identifier of the template used to create transfer order
processingStatus	int	-	Current processing status of the transfer order: 0 - none 1 - compressing 2 - posting 3 - other

TransferOrderLine

Field	Data type	Validation	Description
id	guid	-	Unique identifier of the transfer order line
inventoryTransferId	string	Required	Identifier of the template used to create the transfer order
itemId	string	-	Identifier id of the item that the transfer order line is for
itemName	string	-	Name of the item that the transfer order line is for
inventoryTransferRequestLineID	string	-	Unique identifier of the transfer request line
variantName	string	-	Variant name of the item that the transfer order line is for
unitId	string	Required	Identifier id of the unit for the transfer order line.
unitName	string	-	To what unit name this transfer order line belongs to
sent	boolean	-	True if the transfer order is sent
quantitySent	decimal	Required	Item quantity sent on the transfer order
unitPrice	decimal	Required	The item unit price
quantityReceived	decimal	-	Quantity of the items received on the transfer order
quantityRequested	decimal	-	Quantity of the items requested on the transfer order
barcode	string	-	Barcode of the item
costPrice	string	-	Last purchase price of the item from the sending store
pictureID	string	-	An image associated with this transfer order line
omniLineID	string	-	Identifier of the line that was assigned to it by the inventory app
omniTransactionID	string	-	Identifier of the transaction in the inventory app that this line was created on

Examples

Get transfer order

Returns details of a single transfer order .

GET /api/inventory/transfer-order/{id}

Permissions

TransferOrder:Read

For more information on authenticating to LS One APIs, see Authentication.

Request

curl -X 'GET' \
'https://lsoneapi.lsretail.com/api/inventory/transfer-order/000000002' \
-H 'accept: text/plain' \
-H 'Authorization: Bearer {authentication_token}'

Parameter	Data type	Validation	Description
id	string	Required	Unique identtfier of the transfer order

Response

{
    "id": "000000002",
    "inventoryTransferRequestId": "",
    "createdFromTransferRequest": false,
    "description": "Banana TO",
    "sendingStoreId": "S0001",
    "sendingStoreName": "Aurora Supermarket",
    "receivingStoreId": "S0005",
    "receivingStoreName": "Aurora Restaurant",
    "creationDate": "2021-11-14T17:40:42.61",
    "receivingDate": "1900-01-01T00:00:00",
    "sentDate": "1900-01-01T00:00:00",
    "received": false,
    "sent": false,
    "fetchedByReceivingStore": false,
    "rejected": false,
    "createdBy": "",
    "createdByHeadOffice": true,
    "expectedDelivery": "2021-11-16T17:40:37.727",
    "createdFromOmni": false,
    "templateID": "",
    "processingStatus": 0
}

Status codes

Code	Text	Description
200	Success	Success
401	Unauthorized	LS One API client did not provide a valid authentication token or it does not have permissions to read transfer order(s)
404	Not Found	The requested transfer order was not found

Get all transfer orders

Returns an object that contains a list of transfer orders and the total number of records that can be used for pagination.

GET /api/inventory/transfer-order?page={page_number}&pageSize={page_size}

Permissions

TransferOrder:Read

For more information on authenticating to LS One APIs, see Authentication.

Request

curl -X 'GET' \
  'https://lsoneapi.lsretail.com/api/inventory/transfer-order?page=1&pageSize=100' \
  -H 'accept: text/plain' \
 -H 'Authorization: Bearer {authentication_token}'

Parameter	Data type	Validation	Description
page	int	-	The page number. Default value = 1.
pageSize	int	-	The page size. Default value = 100.

Response

				
{
"items": [
	{
		"id": "000000002",
		"inventoryTransferRequestId": "",
		"createdFromTransferRequest": false,
		"description": "Banana TO",
		"sendingStoreId": "S0001",
		"sendingStoreName": "Aurora Supermarket",
		"receivingStoreId": "S0005",
		"receivingStoreName": "Aurora Restaurant",
		"creationDate": "2021-11-14T17:40:42.61",
		"receivingDate": "1900-01-01T00:00:00",
		"sentDate": "1900-01-01T00:00:00",
		"received": false,
		"sent": false,
		"fetchedByReceivingStore": false,
		"rejected": false,
		"createdBy": "",
		"createdByHeadOffice": true,
		"expectedDelivery": "2021-11-16T17:40:37.727",
		"createdFromOmni": false,
		"templateID": "",
		"processingStatus": 0
	},
	{
		"id": "000000006",
		"inventoryTransferRequestId": "",
		"createdFromTransferRequest": false,
		"description": "test",
		"sendingStoreId": "S0002",
		"sendingStoreName": "Aurora Gas Station",
		"receivingStoreId": "S0003",
		"receivingStoreName": "Aurora Fashion Store North",
		"creationDate": "2021-11-14T19:44:19.423",
		"receivingDate": "1900-01-01T00:00:00",
		"sentDate": "1900-01-01T00:00:00",
		"received": false,
		"sent": false,
		"fetchedByReceivingStore": false,
		"rejected": false,
		"createdBy": "",
		"createdByHeadOffice": true,
		"expectedDelivery": "2021-11-16T19:44:16.673",
		"createdFromOmni": false,
		"templateID": "",
		"processingStatus": 0
	},
	...
],
"totalCount": 10
}

Status codes

Code	Text	Description
200	Success	Success
401	Unauthorized	LS One API client did not provide a valid authentication token or it does not have permissions to read transfer order(s)
404	Not Found	No transfer orders found

Search transfer orders

Returns an object that contains a subset of searched transfer orders and the total number of records that can be used for pagination.

POST /api/inventory/transfer-order/search?page={page_number}&pageSize={page_size}

Transfer orders can be searched using a filter object that has the following properties:

Filter properties

Field	Data type	Validation	Description
descriptionOrID	string	-	Search items by description or id
storeID	string	-	Search items by store id
descriptionOrIDBeginsWith	boolean	-	Search items that begins with the given id or description
sendingStoreID	string	-	Search by sending store id
receivingStoreID	string	-	Search by receiving store id
FromDate	DateTime	-	Search items starting from date
ToDate	DateTime	-	Search items to date
sortBy	int	-	Sort result items by criteria: 0 - Id 1 - CreatedDate 2 - ReceivedDate 3 - SentDate 4 - SendingStore 5 - ReceivingStore 6 - Received 7 - Sent 8 - Fetched 9 - InventoryTransferCreated 10 - Description 11 - SentQuantity 12 - ReceivedQuantity 13 - ItemLines 14 - ExpectedDelivery
transferFilterType	int	-	Search by type value: 0 - Outgoing 1 - Incoming 2 - SendingAndReceiving 3 - Finished
sortDescending	boolean	-	If true will sort items descending
barcodeBeginsWith	boolean	-	Search items that begins with the given barcode value
barcode	string	-	Search items by barcode value
sent	boolean	-	Search the items that are sent or not
sentTo	DateTime	-	Search the items that are sent until the given date
sentFrom	DateTime	-	Search the items that are sent starting the given date
expectedTo	DateTime	-	Search the items that are expected until the given date
expectedFrom	DateTime	-	Search the items that are expected starting the given date
sentQuantityFrom	decimal	-	Search the items by sent quantity from
receivedQuantityTo	decimal	-	Search the items by received quantity to
receivedQuantityFrom	decimal	-	Search the items by received quantity from
requestedQuantityTo	decimal	-	Search the items by requested quantity to
requestedQuantityFrom	decimal	-	Search the items by requested quantity from

Permissions

TransferOrder:Read

For more information on authenticating to LS One APIs, see Authentication.

Request

curl -X 'POST' \
	'https://lsoneapi.lsretail.com/api/inventory/transfer-orders/search?page=1&pageSize=50' \
	-H 'accept: text/plain' \
	-H 'Authorization: Bearer {authorization_token}' \
	-H 'Content-Type: application/json' \
	-d '{
		"descriptionOrID": "Aurora"
	}'

Parameter	Data type	Validation	Description
page	int	-	The page number. Default value = 1.
pageSize	int	-	The page size. Default value = 100.

Response


{
"items": [
	{
		"id": "000000002",
		"inventoryTransferRequestId": "",
		"createdFromTransferRequest": false,
		"description": "Banana TO",
		"sendingStoreId": "S0001",
		"sendingStoreName": "Aurora Supermarket",
		"receivingStoreId": "S0005",
		"receivingStoreName": "Aurora Restaurant",
		"creationDate": "2021-11-14T17:40:42.61",
		"receivingDate": "1900-01-01T00:00:00",
		"sentDate": "1900-01-01T00:00:00",
		"received": false,
		"sent": false,
		"fetchedByReceivingStore": false,
		"rejected": false,
		"createdBy": "",
		"createdByHeadOffice": true,
		"expectedDelivery": "2021-11-16T17:40:37.727",
		"createdFromOmni": false,
		"templateID": "",
		"processingStatus": 0
	},
	{
		"id": "000000006",
		"inventoryTransferRequestId": "",
		"createdFromTransferRequest": false,
		"description": "test",
		"sendingStoreId": "S0002",
		"sendingStoreName": "Aurora Gas Station",
		"receivingStoreId": "S0003",
		"receivingStoreName": "Aurora Fashion Store North",
		"creationDate": "2021-11-14T19:44:19.423",
		"receivingDate": "1900-01-01T00:00:00",
		"sentDate": "1900-01-01T00:00:00",
		"received": false,
		"sent": false,
		"fetchedByReceivingStore": false,
		"rejected": false,
		"createdBy": "",
		"createdByHeadOffice": true,
		"expectedDelivery": "2021-11-16T19:44:16.673",
		"createdFromOmni": false,
		"templateID": "",
		"processingStatus": 0
	},
	...
],
"totalCount": 10
}

Status codes

Code	Text	Description
200	Success	Success
401	Unauthorized	LS One API client did not provide a valid authentication token or it does not have permissions to read transfer order(s)
404	Not Found	No transfer orders found

Create a new transfer order

Creates a new transfer order .

POST /api/inventory/transfer-order

To create a new transfer order, the following fields are required:

Description
SendingStoreId
ReceivingStoreId
ExpectedDelivery

Permissions

TransferOrder:Write

For more information on authenticating to LS One APIs, see Authentication.

Request

curl -X 'POST' \
  'https://lsoneapi.lsretail.com/api/inventory/transfer-order' \
  -H 'accept: text/plain' \
  -H 'Authorization: Bearer {authorization_token}' \
  -H 'Content-Type: application/json' \
  -d '{
		  "description": "Test Transfer order",
		  "sendingStoreId": "S0001",
		  "receivingStoreId": "S0005",
		  "expectedDelivery": "2021-11-27T18:47:56"
}'

Response

{
	  "id": "0-000000007",
	  "inventoryTransferRequestId": null,
	  "createdFromTransferRequest": true,
	  "description": "Test Transfer order",
	  "sendingStoreId": "S0001",
	  "sendingStoreName": null,
	  "receivingStoreId": "S0005",
	  "receivingStoreName": null,
	  "creationDate": "2021-11-14T20:15:52.0736466+02:00",
	  "receivingDate": "1900-01-01T00:00:00",
	  "sentDate": "1900-01-01T00:00:00",
	  "received": false,
	  "sent": false,
	  "fetchedByReceivingStore": false,
	  "rejected": false,
	  "createdBy": null,
	  "createdByHeadOffice": false,
	  "expectedDelivery": "2021-11-27T18:47:56",
	  "createdFromOmni": false,
	  "templateID": null,
	  "processingStatus": 0
}

Status codes

Code	Text	Description
200	Success	Success
401	Unauthorized	LS One API client did not provide a valid authentication token or it does not have permissions to read transfer order(s)
400	Bad Request	New transfer order could not be created

Update a transfer order

Updates an existing transfer order .

PUT /api/inventory/transfer-order

To update an existing transfer order, the following fields are required:

Id
Description
SendingStoreId
ReceivingStoreId
ExpectedDelivery

Permissions

TransferOrder:Write

For more information on authenticating to LS One APIs, see Authentication.

Request

curl -X 'PUT' \
  'https://lsoneapi.lsretail.com/api/inventory/transfer-order' \
  -H 'accept: text/plain' \
  -H 'Authorization: Bearer {authentication_token}' \
  -H 'Content-Type: application/json' \
  -d '{
	  "id": "0-000000007",
	  "description": "Update transfer from REST",
	  "sendingStoreId": "S0001",
	  "receivingStoreId": "S0005",
	  "expectedDelivery": "2021-11-19T18:47:56"
}'

Response

{
	  "id": "0-000000007",
	  "inventoryTransferRequestId": null,
	  "createdFromTransferRequest": true,
	  "description": "Update transfer from REST",
	  "sendingStoreId": "S0001",
	  "sendingStoreName": null,
	  "receivingStoreId": "S0005",
	  "receivingStoreName": null,
	  "creationDate": "2021-11-14T20:15:52.073",
	  "receivingDate": "1900-01-01T00:00:00",
	  "sentDate": "1900-01-01T00:00:00",
	  "received": false,
	  "sent": false,
	  "fetchedByReceivingStore": false,
	  "rejected": false,
	  "createdBy": null,
	  "createdByHeadOffice": false,
	  "expectedDelivery": "2021-11-19T18:47:56",
	  "createdFromOmni": false,
	  "templateID": null,
	  "processingStatus": 0
}

Status codes

Code	Text	Description
200	Success	Success
401	Unauthorized	LS One API client did not provide a valid authentication token or it does not have permissions to write transfer order(s)
400	Bad Request	Transfer order could not be updated
404	Not Found	Transfer order to be updated was not found

Delete a transfer order

Delete an existing transfer order .

DELETE /api/inventory/transfer-order/{id}

Permissions

TransferOrder:Write

For more information on authenticating to LS One APIs, see Authentication.

Request

curl -X 'DELETE' \
  'https://lsoneapi.lsretail.com/api/inventory/transfer-order/0-00000007' \
  -H 'accept: text/plain' \
  -H 'Authorization: Bearer {authentication_token}'

Parameter	Data type	Validation	Description
id	string	Required	Unique identifier of the transfer order

Response

{
	0
}

Response codes

Code	Description
0	Success
1	Not found
2	Sent
3	Fetched by receiving store
4	Received
5	Error deleting transfer

Status codes

Code	Text	Description
200	Success	Success
401	Unauthorized	LS One API client did not provide a valid authentication token or it does not have permissions to read transfer order(s)
404	Not Found	The requested transfer order was not found

Get transfer order line

Returns details of a single transfer order line.

GET /api/inventory/transfer-order/line/{lineNum}

Permissions

TransferOrder:Read

For more information on authenticating to LS One APIs, see Authentication.

Request

curl -X 'GET' \
'https://lsoneapi.lsretail.com/api/inventory/transfer-order/line/4dbc67a7-15ea-4682-bfe7-10fcd7499eb7' \
-H 'accept: text/plain' \
-H 'Authorization: Bearer {authentication_token}'

Parameter	Data type	Validation	Description
transferOrderId	string	Required	Unique identifier of the transfer order
lineNumber	string	Required	Line number of the transfer order line

Response

{
	"id": "4dbc67a7-15ea-4682-bfe7-10fcd7499eb7",
	"inventoryTransferId": "000000002",
	"itemId": "20030",
	"itemName": "Apple, Golden Delicious",
	"inventoryTransferRequestLineID": null,
	"variantName": "",
	"unitId": "KG",
	"unitName": "Kilos",
	"sent": false,
	"quantitySent": 15.000000,
	"quantityReceived": 0.000000,
	"quantityRequested": 0.000000,
	"barcode": null,
	"pictureID": "",
	"omniLineID": "",
	"omniTransactionID": "",
	"costPrice": 0.000000000000
}

Status codes

Code	Text	Description
200	Success	Success
401	Unauthorized	LS One API client did not provide a valid authentication token or it does not have permissions to read transfer order line(s)
404	Not Found	The requested transfer order line was not found

Get lines for specific transfer order

Returns an object that contains a list of transfer order lines and the total number of records that can be used for pagination.

GET /api/inventory/transfer-order/{transferOrderId}/line?page={page_number}&pageSize={page_size}

Permissions

TransferOrder:Read

For more information on authenticating to LS One APIs, see Authentication.

Request

curl -X 'GET' \
  'https://lsoneapi.lsretail.com/api/inventory/transfer-order/000000002/line?page=1&pageSize=100' \
  -H 'accept: text/plain' \
 -H 'Authorization: Bearer {authentication_token}'

Parameter	Data type	Validation	Description
transferOrderId	string	Required	The id of the transfer order
page	int	-	The page number. Default value = 1.
pageSize	int	-	The page size. Default value = 100.

Response

{
"items": [
	{
		"id": "4dbc67a7-15ea-4682-bfe7-10fcd7499eb7",
		"inventoryTransferId": "000000002",
		"itemId": "20030",
		"itemName": "Apple, Golden Delicious",
		"inventoryTransferRequestLineID": null,
		"variantName": "",
		"unitId": "KG",
		"unitName": "Kilos",
		"sent": false,
		"quantitySent": 15.000000,
		"quantityReceived": 0.000000,
		"quantityRequested": 0.000000,
		"barcode": null,
		"pictureID": "",
		"omniLineID": "",
		"omniTransactionID": "",
		"costPrice": 0.000000000000
	},
	{
		"id": "930ec8fd-f36c-4cee-85b2-83bc14235acf",
		"inventoryTransferId": "000000002",
		"itemId": "38001",
		"itemName": "Aspirin",
		"inventoryTransferRequestLineID": null,
		"variantName": "",
		"unitId": "PCS",
		"unitName": "Pieces",
		"sent": false,
		"quantitySent": 55.000000,
		"quantityReceived": 0.000000,
		"quantityRequested": 0.000000,
		"barcode": null,
		"pictureID": "",
		"omniLineID": "",
		"omniTransactionID": "",
		"costPrice": 0.000000000000
	},
	...
	],
"totalCount": 10
}

Status codes

Code	Text	Description
200	Success	Success
401	Unauthorized	LS One API client did not provide a valid authentication token or it does not have permissions to read transfer order lines(s)
404	Not Found	No transfer order lines found

Search transfer order lines for a transfer order

Returns an object that contains a subset of searched transfer order lines and the total number of records that can be used for pagination.

POST /api/inventory/transfer-order/{transferOrderId}/search?page={page_number}&pageSize={page_size}

Transfer order lines can be searched using a filter object that has the following properties:

Filter properties

Field	Data type	Validation	Description
descriptionOrID	string	-	Search items by description or id
storeID	string	-	Search items by store id
descriptionOrIDBeginsWith	boolean	-	Search items that begins with the given id or description
sendingStoreID	string	-	Search by sending store id
receivingStoreID	string	-	Search by receiving store id
FromDate	DateTime	-	Search items starting from date
ToDate	DateTime	-	Search items to date
sortBy	int	-	Sort result items by criteria: 0 - Id 1 - CreatedDate 2 - ReceivedDate 3 - SentDate 4 - SendingStore 5 - ReceivingStore 6 - Received 7 - Sent 8 - Fetched 9 - InventoryTransferCreated 10 - Description 11 - SentQuantity 12 - ReceivedQuantity 13 - ItemLines 14 - ExpectedDelivery
transferFilterType	int	-	Search by type value: 0 - Outgoing 1 - Incoming 2 - SendingAndReceiving 3 - Finished
sortDescending	boolean	-	If true will sort items descending
barcodeBeginsWith	boolean	-	Search items that begins with the given barcode value
barcode	string	-	Search items by barcode value
sent	boolean	-	Search the items that are sent or not
sentTo	DateTime	-	Search the items that are sent until the given date
sentFrom	DateTime	-	Search the items that are sent starting the given date
expectedTo	DateTime	-	Search the items that are expected until the given date
expectedFrom	DateTime	-	Search the items that are expected starting the given date
sentQuantityFrom	decimal	-	Search the items by sent quantity from
receivedQuantityTo	decimal	-	Search the items by received quantity to
receivedQuantityFrom	decimal	-	Search the items by received quantity from
requestedQuantityTo	decimal	-	Search the items by requested quantity to
requestedQuantityFrom	decimal	-	Search the items by requested quantity from

Permissions

TransferOrder:Read

For more information on authenticating to LS One APIs, see Authentication.

Request

curl -X 'POST' \
	'https://lsoneapi.lsretail.com/api/inventory/transfer-order/00000001/search?page=1&pageSize=100' \
	-H 'accept: text/plain' \
	-H 'Authorization: Bearer {authorization_token}' \
	-H 'Content-Type: application/json' \
	-d '{
		"descriptionOrID": "Apple"
	}'

Parameter	Data type	Validation	Description
transferOrderId	string	Required	The id of the transfer order
page	int	-	The page number. Default value = 1.
pageSize	int	-	The page size. Default value = 100.

Response

{
"items": [
	{
		"id": "4dbc67a7-15ea-4682-bfe7-10fcd7499eb7",
		"inventoryTransferId": "000000002",
		"itemId": "20030",
		"itemName": "Apple, Golden Delicious",
		"inventoryTransferRequestLineID": null,
		"variantName": "",
		"unitId": "KG",
		"unitName": "Kilos",
		"sent": false,
		"quantitySent": 15.000000,
		"quantityReceived": 0.000000,
		"quantityRequested": 0.000000,
		"barcode": null,
		"pictureID": "",
		"omniLineID": "",
		"omniTransactionID": "",
		"costPrice": 0.000000000000
	},
	{
		"id": "930ec8fd-f36c-4cee-85b2-83bc14235acf",
		"inventoryTransferId": "000000002",
		"itemId": "38001",
		"itemName": "Apple jonagold",
		"inventoryTransferRequestLineID": null,
		"variantName": "",
		"unitId": "PCS",
		"unitName": "Pieces",
		"sent": false,
		"quantitySent": 55.000000,
		"quantityReceived": 0.000000,
		"quantityRequested": 0.000000,
		"barcode": null,
		"pictureID": "",
		"omniLineID": "",
		"omniTransactionID": "",
		"costPrice": 0.000000000000
	},
	...
	],
"totalCount": 10
}

Status codes

Code	Text	Description
200	Success	Success
401	Unauthorized	LS One API client did not provide a valid authentication token or it does not have permissions to read transfer order lines(s)
404	Not Found	No transfer order lines found

Create a new transfer order line

Creates a new transfer order line.

POST /api/inventory/transfer-order/{transferOrderId}/line

To create a new transfer order, the following fields are required:

InventoryTransferId
ItemId
UnitId
QuantitySent

Permissions

TransferOrder:Write

For more information on authenticating to LS One APIs, see Authentication.

Request

curl -X 'POST' \
  'https://lsoneapi.lsretail.com/api/inventory/transfer-order/00000012/line' \
  -H 'accept: text/plain' \
  -H 'Authorization: Bearer {authorization_token}' \
  -H 'Content-Type: application/json' \
  -d '{
		"inventoryTransferId": "000000002",
		"itemId": "20030",
		"unitId": "KG",
		"quantitySent": 15.000000
}'

Parameter	Data type	Validation	Description
transferOrderId	string	Required	Unique identifier of the transfer order

Response

{
		"id": "4dbc67a7-15ea-4682-bfe7-10fcd7499eb7",
		"inventoryTransferId": "000000002",
		"itemId": "20030",
		"itemName": "Apple, Golden Delicious",
		"inventoryTransferRequestLineID": null,
		"variantName": "",
		"unitId": "KG",
		"unitName": "Kilos",
		"sent": false,
		"quantitySent": 15.000000,
		"quantityReceived": 0.000000,
		"quantityRequested": 0.000000,
		"barcode": null,
		"pictureID": "",
		"omniLineID": "",
		"omniTransactionID": "",
		"costPrice": 0.000000000000
}

Status codes

Code	Text	Description
200	Success	Success
401	Unauthorized	LS One API client did not provide a valid authentication token or it does not have permissions to write transfer order line(s)
400	Bad Request	New transfer order line could not be created

Update a transfer order line

Updates an existing transfer order line.

PUT /api/inventory/transfer-order/{transferOrderId}/line

To update an existing transfer order, the following fields are required:

Id
InventoryTransferId
ItemId
UnitId
QuantitySent

Permissions

TransferOrder:Write

For more information on authenticating to LS One APIs, see Authentication.

Request

curl -X 'PUT' \
  'https://lsoneapi.lsretail.com/api/inventory/transfer-order/000000002/line' \
  -H 'accept: text/plain' \
  -H 'Authorization: Bearer {authentication_token}' \
  -H 'Content-Type: application/json' \
  -d '{
		"id": "4dbc67a7-15ea-4682-bfe7-10fcd7499eb7",
		"inventoryTransferId": "000000002",
		"itemId": "20030",
		"unitId": "KG",
		"quantitySent": 35.000000
}'

Parameter	Data type	Validation	Description
transferOrderId	string	Required	Unique identifier of the transfer order

Response

{
	"id": "4dbc67a7-15ea-4682-bfe7-10fcd7499eb7",
	"inventoryTransferId": "000000002",
	"itemId": "20030",
	"itemName": null,
	"inventoryTransferRequestLineID": null,
	"variantName": null,
	"unitId": "KG",
	"unitName": null,
	"sent": false,
	"quantitySent": 35.000000,
	"quantityReceived": 0,
	"quantityRequested": 0,
	"barcode": null,
	"pictureID": null,
	"omniLineID": null,
	"omniTransactionID": null,
	"costPrice": 0
}

Status codes

Code	Text	Description
200	Success	Success
401	Unauthorized	LS One API client did not provide a valid authentication token or it does not have permissions to write transfer order line(s)
400	Bad Request	Transfer order line could not be updated
404	Not Found	Transfer order line to be updated was not found

Delete a transfer order line

Delete an existing transfer orderline.

DELETE /api/inventory/transfer-order/line/{id}

Permissions

TransferOrder:Write

For more information on authenticating to LS One APIs, see Authentication.

Request

curl -X 'DELETE' \
  'https://lsoneapi.lsretail.com/api/inventory/transfer-order/line/4dbc67a7-15ea-4682-bfe7-10fcd7499eb7' \
  -H 'accept: text/plain' \
  -H 'Authorization: Bearer {authentication_token}'

Parameter	Data type	Validation	Description
id	string	Required	Unique identifier of the transfer order line

Response

HTTP/1.1 204 No Content

Status codes

Code	Text	Description
200	Success	Success
401	Unauthorized	LS One API client did not provide a valid authentication token or it does not have permissions to read transfer order line(s)
404	Not Found	The requested transfer order line was not found

Post order

Post a transfer order .

POST /api/inventory/transfer-order/{transferOrderId}/post-order'

Permissions

TransferOrder:Write

For more information on authenticating to LS One APIs, see Authentication.

Request

curl -X 'POST' \
  'https://lsoneapi.lsretail.com/api/inventory/transfer-order/000000002/post-order' \
  -H 'accept: text/plain' \
  -H 'Authorization: Bearer {authorization_token}' \
  -H 'Content-Type: application/json' \
  -d ''

Response

{
	0
}

Response codes

Code	Description
0	Success
1	Not found
2	Transfer already sent
3	Transfer order is rejected
4	No items on transfer
5	Lines have zero sent quantity
6	Fetched by receiving store
7	Unit conversion error
8	Error sending transfer order

Status codes

Code	Text	Description
200	Success	Success
401	Unauthorized	LS One API client did not provide a valid authentication token or it does not have permissions to write transfer order line(s)
400	Bad Request	Transfer order could not be posted

Receive transfer order

Receive transfer order .

POST /api/inventory/transfer-order/{transferOrderId}/receive-order'

Permissions

TransferOrder:Write

For more information on authenticating to LS One APIs, see Authentication.

Request

curl -X 'POST' \
  'https://lsoneapi.lsretail.com/api/inventory/transfer-order/000000002/receive-order' \
  -H 'accept: text/plain' \
  -H 'Authorization: Bearer {authorization_token}' \
  -H 'Content-Type: application/json' \
  -d ''

Response

{
	0
}

Response codes

Code	Description
0	Success
1	Not found
2	Received
3	No items on transfer
4	Unit conversion error
5	Quantities received not accurate
6	SAP quantities received not accurate
7	Error receiving transfer order

Status codes

Code	Text	Description
200	Success	Success
401	Unauthorized	LS One API client did not provide a valid authentication token or it does not have permissions to write transfer order line(s)
400	Bad Request	Receive transfer order could not done