Element Logic API
DirectPutaway
Endpoint for direct putaway tasks
ProductPlace
Place a product directly into a location.
Request
POST /api/directputaway
Parameters
Name | Type | Value | Notes |
---|---|---|---|
*putaway |
Responses
Status Code | Description | Samples |
---|---|---|
200 | Product placed successfully |
|
400 | The location is not found |
GoodsReceivals
Endpoint for goods receival
CompleteGoodsReceival
Complete or delete putaway tasks for a purchase line ID.
If task has not reached line status PutInBox (5) it will be deleted. If it has reached line status PutInBox (5) or a higher status number, it will be set to Completed (17)
Request
PUT /api/goodsreceivals/{id}/lines/{lineId}
Parameters
Name | Type | Value | Notes |
---|---|---|---|
*id | string | Purchase order ID |
|
*lineId | integer | Purchase line ID. The purchase line to complete. |
Responses
Status Code | Description | Samples |
---|---|---|
200 | Putaway tasks are completed |
|
400 | Arguments not valid |
|
404 | No putaway order lines found for the given purchase ID |
DeleteGoodsReceival
Delete a goods receival order line
Request
DELETE /api/goodsreceivals/{id}/lines/{lineId}
Parameters
Name | Type | Value | Notes |
---|---|---|---|
*id | string | Purchase order ID |
|
*lineId | integer | Purchase line ID. The purchase line to delete. |
Responses
Status Code | Description | Samples |
---|---|---|
200 | Purchase order line deleted successfully |
|
400 | Arguments not valid |
|
403 | Forbidden |
|
404 | Purchase order line not found |
GoodsReceivalsImport
Endpoint for importing goodsreceival with transformation support.
ImportGoodsReceival
Imports one goodsreceival list into the system.
Request
POST /api/goodsreceivals/import
Responses
Status Code | Description | Samples |
---|---|---|
200 | OK |
|
202 | Goods receival import is started. |
|
400 | BadRequest. Either there was no goodsreceival lines present in the request or the lines could not be parsed. |
IntegrationStatus
Endpoint for looking up status of integration transactions.
GetIntegrationTransaction
Get integration transaction by id.
Request
GET /api/integrationstatus/{id}
Parameters
Name | Type | Value | Notes |
---|---|---|---|
*id | integer | The integration transaction id. |
Responses
Status Code | Description | Samples |
---|---|---|
200 | Ok. The integration transaction is returned. |
InventoryCountImport
Endpoint for importing inventory count with transformation support.
ImportInventoryCount
Imports inventory count list into the system.
Request
POST /api/inventorycounts/import
Responses
Status Code | Description | Samples |
---|---|---|
200 | OK |
|
202 | Inventory count import is started. |
|
400 | BadRequest. Either there was no inventory count lines present in the request or the lines could not be parsed. |
InventoryItems
Endpoint for inventory items
Lock
Request
POST /api/inventoryitems/Lock
Parameters
Name | Type | Value | Notes |
---|---|---|---|
*lockProductsForPicking |
Responses
Status Code | Description | Samples |
---|---|---|
200 | OK |
|
207 | One or more request failed. Check response for details |
|
400 | Locking of all the products failed |
UnLock
Request
POST /api/inventoryitems/UnLock
Parameters
Name | Type | Value | Notes |
---|---|---|---|
*unLockProductsForPicking |
Responses
Status Code | Description | Samples |
---|---|---|
200 | OK |
|
207 | One or more request failed. Check response for details |
|
400 | Unlocking of all the products failed |
RemoveStockItemReservationKey
Request
POST /api/inventoryitems/RemoveStockItemReservationKey
Parameters
Name | Type | Value | Notes |
---|---|---|---|
*removeStockItemReservationKey |
Responses
Status Code | Description | Samples |
---|---|---|
200 | The operation is succeeded |
|
400 | No Stock Items found |
PickListLines
Endpoint for picklist lines
DeletePicklistLine
Deletes one picklist line.
Id is the same as the ExtPicklistId from the import and lineId is the same as ExtOrderLineId from the import.
Request
DELETE /api/picklists/{id}/lines/{lineId}
Parameters
Name | Type | Value | Notes |
---|---|---|---|
*id | string | Picklist ID |
|
*lineId | integer | Picklist line ID. The picklist line to delete. |
Responses
Status Code | Description | Samples |
---|---|---|
200 | OK |
|
403 | Forbidden. The requested picklist line could not be deleted since the picklist is in the process of being picked |
|
404 | NotFound. The requested picklist line could not be found |
PickLists
Endpoint for picklists
DeletePicklist
Deletes one picklist.
Picklist ID is the same as the ExtPicklistId which was supplied in the import.
Request
DELETE /api/picklists/{id}
Parameters
Name | Type | Value | Notes |
---|---|---|---|
*id | string | Picklist ID. The id of the picklist to delete. |
Responses
Status Code | Description | Samples |
---|---|---|
200 | OK |
|
403 | Forbidden. The requested picklist could not be deleted since the picklist is in the process of being picked |
|
404 | NotFound. The requested picklist could not be found |
PicklistsImport
Endpoint for importing picklist with transformation support.
ImportPicklist
Imports one picklist into the system.
Request
POST /api/picklists/import
Responses
Status Code | Description | Samples |
---|---|---|
200 | OK |
|
202 | Picklist import is started. |
|
400 | BadRequest. Either there was no picklist lines present in the request or the lines could not be parsed. |
Pickwaves
Endpoint for pickwaves
GetPickwaves
Returns all pickwaves
Request
GET /api/pickwaves
Responses
Status Code | Description | Samples |
---|---|---|
200 | Ok. All the configured pickwaves is returned. |
GetPickwave
Returns one pickwave
Request
GET /api/pickwaves/{pickwaveId}
Parameters
Name | Type | Value | Notes |
---|---|---|---|
*pickwaveId | string | The pickwave id |
Responses
Status Code | Description | Samples |
---|---|---|
200 | Ok. The requested pickwave is returned. |
|
400 | BadRequest. The parameter could not be parsed. |
|
404 | NotFound. The requested pickwave was not found. |
ProductsImport
Endpoint for importing products with transformation support.
ProductImport
Imports product list into the system.
Request
POST /api/products/import
Responses
Status Code | Description | Samples |
---|---|---|
200 | OK |
|
202 | Product import is started. |
|
400 | BadRequest. Either there was no product lines present in the request or the lines could not be parsed. |
Root
| Improve this Doc View SourceRoot_Get
Request
GET /api
Responses
Status Code | Description | Samples |
---|---|---|
200 | OK |