Transfer Request

With a transfer request one location can request inventory from another location. The flow of the transfer request is as following:

  1. The transfer request is created and items are added to it.

  2. The location receiveing the request reviews the request and creates a transfer order for the items to be sent. After this the process continues with the transfer order.

The inventory/transfer-request endpoint in LS One API allows management of the transfer orders as well as sending a transfer request to a different store.

Actions

GET 

 Get transfer request

GET 

 Get all transfer requests

POST 

 Search transfer requests

POST 

 Create a new transfer request

PUT 

 Update an existing transfer request

DELETE 

 Delete a transfer request
GET  Get transfer request line

GET 

 Get all lines for specific transfer request

POST 

 Search lines for transfer request

POST 

 Create a new transfer request line

PUT 

 Update an existing transfer request line

DELETE 

 Delete a transfer request line

POST 

 Send request

POST 

 Create transfer order

Properties

TransferRequest

Field Data type Validation Description
id string

-

 Unique identifier of the transfer request
description string

Required

Description of the transfer request
sendingStoreId string

Required

Identifier of the store to which the transfer request is assigned
sendingStoreName string

-

 Store name of the sending transfer request
receivingStoreId string

Required

Receiving store id of the transfer request
receivingStoreName string

-

 Receiving store name of the transfer request
creationDate datetime

-

 Date when transfer request is created
sentDate datetime

-

 Date when transfer request is sent
sent boolean

-

 Transfer request is sent
fetchedByReceivingStore boolean

-

 Transfer request is fetched by the receiving store
inventoryTransferOrderCreated boolean

-

 Transfer order is created
createdBy string

-

 Store name that has created the transfer request
expectedDelivery datetime

Required

Date when transfer request is expected to be delivered
rejected boolean

-

 Transfer has been rejected by the receiving store
createdByHeadOffice boolean

-

Identifier of the store that created the request

This is an empty string if created by Head office
createdFromOmni bool

-

 transfer request was created from the mobile inventory app
templateID string

-

 Identifier of the template used to create transfer request

TransferRequestLine

Field Data type Validation Description
id guid

-

 Unique identifier of the transfer request line
inventoryTransferRequestId string

Required

Identifier of the template used to create the transfer request
itemId string

-

 Identifier id of the item that the transfer request line is for
itemName string

-

 Name of the item that the transfer request line is for
variantName string

-

 Variant name of the item that the transfer request line is for
unitId string

Required

Identifier id of the unit for the transfer request line.
unitName string

-

 To what unit name this transfer request line belongs to
sent boolean

-

 Transfer request is sent
quantityRequested decimal

-

 Quantity of the items requested on the transfer request
barcode string

-

 Barcode of the item

Examples

Get transfer request

Returns details of a single transfer request .

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

Permissions

  • TransferRequest:Read

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

Request

curl -X 'GET' \
'https://lsoneapi.lsretail.com/api/inventory/transfer-request/000000001' \
-H 'accept: text/plain' \
-H 'Authorization: Bearer {authentication_token}'
Parameter Data type Validation Description
id string

Required

Id of the transfer request

Response

{
	"id": "000000001",
	"description": "Soda request",
	"sendingStoreId": "S0005",
	"sendingStoreName": "Aurora Restaurant",
	"receivingStoreId": "S0001",
	"receivingStoreName": "Aurora Supermarket",
	"creationDate": "2021-11-14T17:38:45.593",
	"sentDate": "2021-11-14T17:38:45.593",
	"sent": false,
	"fetchedByReceivingStore": false,
	"inventoryTransferOrderCreated": false,
	"createdBy": "",
	"expectedDelivery": "2021-11-16T17:38:38.56",
	"rejected": false,
	"createdFromOmni": false,
	"templateID": "",
	"createdByHeadOffice": true
}

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 request(s)
404 Not Found The requested transfer request was not found

Get all transfer requests

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

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

Permissions

  • TransferRequest:Read

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

Request

curl -X 'GET' \
  'https://lsoneapi.lsretail.com/api/inventory/transfer-request?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": "000000001",
		"description": "Soda request",
		"sendingStoreId": "S0005",
		"sendingStoreName": "Aurora Restaurant",
		"receivingStoreId": "S0001",
		"receivingStoreName": "Aurora Supermarket",
		"creationDate": "2021-11-14T17:38:45.593",
		"sentDate": "2021-11-14T17:38:45.593",
		"sent": false,
		"fetchedByReceivingStore": false,
		"inventoryTransferOrderCreated": false,
		"createdBy": "",
		"expectedDelivery": "2021-11-16T17:38:38.56",
		"rejected": false,
		"createdFromOmni": false,
		"templateID": "",
		"createdByHeadOffice": true
	},
	{
		"id": "000000009",
		"description": "Banana request",
		"sendingStoreId": "S0005",
		"sendingStoreName": "Aurora Restaurant",
		"receivingStoreId": "S0001",
		"receivingStoreName": "Aurora Supermarket",
		"creationDate": "2021-11-14T22:45:43.257",
		"sentDate": "2021-11-14T22:45:43.257",
		"sent": false,
		"fetchedByReceivingStore": false,
		"inventoryTransferOrderCreated": false,
		"createdBy": "",
		"expectedDelivery": "2021-11-16T22:45:39.677",
		"rejected": false,
		"createdFromOmni": false,
		"templateID": "",
		"createdByHeadOffice": true
	},
	...
	],
"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 request(s)
404 Not Found No transfer requests found

Search transfer requests

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

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

Transfer requests can be searchedusing 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 - 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

  • TransferRequest:Read

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

Request

curl -X 'POST' \
	'https://lsoneapi.lsretail.com/api/inventory/transfer-requests/search?page=1&pageSize=100' \
	-H 'accept: text/plain' \
	-H 'Authorization: Bearer {authorization_token}' \
	-H 'Content-Type: application/json' \
	-d '{
		"descriptionOrID": "request",
	}'
Parameter Data type Validation Description
page int

-

 The page number. Default value = 1.
pageSize int

-

 The page size. Default value = 100.

Response

{
"items":[
	{
		"id": "000000001",
		"description": "Soda request",
		"sendingStoreId": "S0005",
		"sendingStoreName": "Aurora Restaurant",
		"receivingStoreId": "S0001",
		"receivingStoreName": "Aurora Supermarket",
		"creationDate": "2021-11-14T17:38:45.593",
		"sentDate": "2021-11-14T17:38:45.593",
		"sent": false,
		"fetchedByReceivingStore": false,
		"inventoryTransferOrderCreated": false,
		"createdBy": "",
		"expectedDelivery": "2021-11-16T17:38:38.56",
		"rejected": false,
		"createdFromOmni": false,
		"templateID": "",
		"createdByHeadOffice": true
	},
	{
		"id": "000000009",
		"description": "Banana request",
		"sendingStoreId": "S0005",
		"sendingStoreName": "Aurora Restaurant",
		"receivingStoreId": "S0001",
		"receivingStoreName": "Aurora Supermarket",
		"creationDate": "2021-11-14T22:45:43.257",
		"sentDate": "2021-11-14T22:45:43.257",
		"sent": false,
		"fetchedByReceivingStore": false,
		"inventoryTransferOrderCreated": false,
		"createdBy": "",
		"expectedDelivery": "2021-11-16T22:45:39.677",
		"rejected": false,
		"createdFromOmni": false,
		"templateID": "",
		"createdByHeadOffice": true
	},
	...
],
"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 request (s)
404 Not Found No transfer requests found

Create a new transfer request

Creates a new transfer request .

POST /api/inventory/transfer-request

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

  • Description

  • SendingStoreId

  • ReceivingStoreId

  • ExpectedDelivery

Permissions

  • TransferRequest:Write

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

Request

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

Response

{
	  "id": "0-000000010",
	  "description": "Test Transfer request ",
	  "sendingStoreId": "S0001",
	  "sendingStoreName": null,
	  "receivingStoreId": "S0005",
	  "receivingStoreName": null,
	  "creationDate": "2021-11-14T22:46:46.4986871+02:00",
	  "sentDate": "1900-01-01T00:00:00",
	  "sent": false,
	  "fetchedByReceivingStore": false,
	  "inventoryTransferOrderCreated": false,
	  "createdBy": null,
	  "expectedDelivery": "2021-11-27T18:47:56",
	  "rejected": false,
	  "createdFromOmni": false,
	  "templateID": null,
	  "createdByHeadOffice": false
}

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 request(s)
400 Bad Request New transfer request could not be created

Update a transfer request

Updates an existing transfer request .

PUT /api/inventory/transfer-request

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

  • Id

  • Description

  • SendingStoreId

  • ReceivingStoreId

  • ExpectedDelivery

Permissions

  • TransferRequest:Write

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

Request

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

Response

{
	"id": "0-000000010",
	"description": "Update transfer from REST",
	"sendingStoreId": "S0001",
	"sendingStoreName": null,
	"receivingStoreId": "S0005",
	"receivingStoreName": null,
	"creationDate": "2021-11-14T22:46:46.5",
	"sentDate": "1900-01-01T00:00:00",
	"sent": false,
	"fetchedByReceivingStore": false,
	"inventoryTransferOrderCreated": false,
	"createdBy": null,
	"expectedDelivery": "2021-11-19T18:47:56",
	"rejected": false,
	"createdFromOmni": false,
	"templateID": null,
	"createdByHeadOffice": false
}

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 request(s)
400 Bad Request Transfer request could not be updated
404 Not Found Transfer request to be updated was not found

Delete a transfer request

Delete an existing transfer request .

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

Permissions

  • TransferRequest:Write

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

Request

curl -X 'DELETE' \
  'https://lsoneapi.lsretail.com/api/inventory/transfer-request/0-000000010' \
  -H 'accept: text/plain' \
  -H 'Authorization: Bearer {authentication_token}'
Parameter Data type Validation Description
id string

Required

Unique identifier of the transfer request

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 request(s)
404 Not Found The requested transfer request was not found

Get transfer request line

Returns details of a single transfer request line.

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

Permissions

  • TransferRequest:Read

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

Request

curl -X 'GET' \
'https://lsoneapi.lsretail.com/api/inventory/transfer-request/line/0139FB11-1218-41A1-A290-D3A5A9E5A8FA' \
-H 'accept: text/plain' \
-H 'Authorization: Bearer {authentication_token}'
Parameter Data type Validation Description
transferRequestId string

Required

Unique identifier of the transfer request
lineNumber string

Required

Line number of the transfer request line

Response

{
	"id": "0139fb11-1218-41a1-a290-d3a5a9e5a8fa",
	"inventoryTransferRequestId": "000000001",
	"itemId": "20000",
	"itemName": "Apple, Red Delicious",
	"variantName": "",
	"unitId": "KG",
	"unitName": "Kilos",
	"quantityRequested": 11.000000,
	"sent": false,
	"barcode": null
}

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 request line(s)
404 Not Found The requested transfer request line was not found

Get lines for specific transfer request

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

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

Permissions

  • TransferRequest:Read

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

Request

curl -X 'GET' \
  'https://lsoneapi.lsretail.com/api/inventory/transfer-request/000000001/line?page=1&pageSize=100' \
  -H 'accept: text/plain' \
 -H 'Authorization: Bearer {authentication_token}'
Parameter Data type Validation Description
transferRequestId string

Required

The id of the transfer request
page int

-

 The page number. Default value = 1.
pageSize int

-

 The page size. Default value = 100.

Response

{
"items": [
	{
		"id": "0139fb11-1218-41a1-a290-d3a5a9e5a8fa",
		"inventoryTransferRequestId": "000000001",
		"itemId": "20000",
		"itemName": "Apple, Red Delicious",
		"variantName": "",
		"unitId": "KG",
		"unitName": "Kilos",
		"quantityRequested": 11.000000,
		"sent": false,
		"barcode": null
	},
	{
		"id": "78f1abb3-4bd9-4314-b4be-d506b96c4fb1",
		"inventoryTransferRequestId": "000000001",
		"itemId": "20010",
		"itemName": "Apple, Jonagold",
		"variantName": "",
		"unitId": "BOX",
		"unitName": "Box",
		"quantityRequested": 26.000000,
		"sent": false,
		"barcode": null
	},
	...
	],
"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 request lines(s)
404 Not Found No transfer request lines found

Search lines for transfer request

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

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

Transfer request 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 - 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

  • TransferRequest:Read

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

Request

curl -X 'POST' \
		'https://lsoneapi.lsretail.com/api/inventory/transfer-request/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
transferRequestId string

Required

The id of the transfer request
page int

-

 The page number. Default value = 1.
pageSize int

-

 The page size. Default value = 100.

Response


{
"items": [
	{
		"id": "0139fb11-1218-41a1-a290-d3a5a9e5a8fa",
		"inventoryTransferRequestId": "000000001",
		"itemId": "20000",
		"itemName": "Apple, Red Delicious",
		"variantName": "",
		"unitId": "KG",
		"unitName": "Kilos",
		"quantityRequested": 11.000000,
		"sent": false,
		"barcode": null
	},
	{
		"id": "78f1abb3-4bd9-4314-b4be-d506b96c4fb1",
		"inventoryTransferRequestId": "000000001",
		"itemId": "20010",
		"itemName": "Apple, Jonagold",
		"variantName": "",
		"unitId": "BOX",
		"unitName": "Box",
		"quantityRequested": 26.000000,
		"sent": false,
		"barcode": null
	},
	...
],
"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 request lines(s)
404 Not Found No transfer request lines found

Create a new transfer request line

Creates a new transfer request line.

POST /api/inventory/transfer-request/{transferRequestId}/line

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

  • InventoryTransferId

  • ItemId

  • UnitId

  • QuantitySent

Permissions

  • TransferRequest:Write

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

Request

curl -X 'POST' \
  'https://lsoneapi.lsretail.com/api/inventory/transfer-request/00000012/line' \
  -H 'accept: text/plain' \
  -H 'Authorization: Bearer {authorization_token}' \
  -H 'Content-Type: application/json' \
  -d '{
		"inventoryTransferRequestId": "000000001",
		"itemId": "20030",
		"unitId": "KG",
		"quantityRequested": 15.000000
}'
Parameter Data type Validation Description
transferRequestId string

Required

Unique identifier of the transfer request

Response

{
	  "id": "3cce6ec4-57cb-422d-8c30-0464252acbaa",
	  "inventoryTransferRequestId": "000000001",
	  "itemId": "20030",
	  "itemName": null,
	  "variantName": null,
	  "unitId": "KG",
	  "unitName": null,
	  "quantityRequested": 15.000000,
	  "sent": false,
	  "barcode": null
}

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 request line(s)
400 Bad Request New transfer request line could not be created

Update a transfer request line

Updates an existing transfer request line.

PUT /api/inventory/transfer-request/{transferRequestId}/line

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

  • Id

  • InventoryTransferId

  • ItemId

  • UnitId

  • QuantitySent

Permissions

  • TransferRequest:Write

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

Request

curl -X 'PUT' \
  'https://lsoneapi.lsretail.com/api/inventory/transfer-request/000000002/line' \
  -H 'accept: text/plain' \
  -H 'Authorization: Bearer {authentication_token}' \
  -H 'Content-Type: application/json' \
  -d '{
		"id": "3cce6ec4-57cb-422d-8c30-0464252acbaa",
		"inventoryTransferRequestId": "000000001",
		"itemId": "20030",
		"unitId": "KG",
		"quantityRequested": 21
}'
Parameter Data type Validation Description
transferRequestId string

Required

Unique identifier of the transfer request

Response

{
	"id": "3cce6ec4-57cb-422d-8c30-0464252acbaa",
	"inventoryTransferRequestId": "000000001",
	"itemId": "20030",
	"itemName": null,
	"variantName": null,
	"unitId": "KG",
	"unitName": null,
	"quantityRequested": 21,
	"sent": false,
	"barcode": null
}

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 request line(s)
400 Bad Request Transfer request line could not be updated
404 Not Found Transfer request line to be updated was not found

Delete a transfer request line

Delete an existing transfer requestline.

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

Permissions

  • TransferRequest:Write

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

Request

curl -X 'DELETE' \
  'https://lsoneapi.lsretail.com/api/inventory/transfer-request/line/3cce6ec4-57cb-422d-8c30-0464252acbaa' \
  -H 'accept: text/plain' \
  -H 'Authorization: Bearer {authentication_token}'
Parameter Data type Validation Description
id string

Required

Unique identifier of the transfer request

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 request line(s)
404 Not Found The requested transfer request line was not found

Send request

Send a transfer request .

POST /api/inventory/transfer-request/{transferRequestId}/send-request'

Permissions

  • TransferRequest:Write

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

Request

curl -X 'POST' \
  'https://lsoneapi.lsretail.com/api/inventory/transfer-request/000000001/send-request' \
  -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 request 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 request

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 request line(s)
400 Bad Request Transfer request could not be sent

Create transfer order

Create transfer order .

POST /api/inventory/transfer-request/{transferRequestId}/create-transfer-order'

Permissions

  • TransferRequest:Write

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

Request

curl -X 'POST' \
  'https://lsoneapi.lsretail.com/api/inventory/transfer-request/000000001/create-transfer-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 Order not found
2 Template not found
3 Request not found
4 Header information insufficient
5 No lines created
6 Not all lines created
7 Error creating 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 request line(s)
400 Bad Request Transfer order could not be created